2 * Copyright 2007, Frank A Kingswood <frank@kingswood-consulting.co.uk>
3 * Copyright 2007, Werner Cornelius <werner@cornelius-consult.de>
4 * Copyright 2009, Boris Hajduk <boris@hajduk.org>
6 * ch341.c implements a serial port driver for the Winchiphead CH341.
8 * The CH341 device can be used to implement an RS232 asynchronous
9 * serial port, an IEEE-1284 parallel printer port or a memory-like
10 * interface. In all cases the CH341 supports an I2C interface as well.
11 * This driver only supports the asynchronous serial interface.
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License version
15 * 2 as published by the Free Software Foundation.
18 #include <linux/kernel.h>
19 #include <linux/init.h>
20 #include <linux/tty.h>
21 #include <linux/module.h>
22 #include <linux/slab.h>
23 #include <linux/usb.h>
24 #include <linux/usb/serial.h>
25 #include <linux/serial.h>
26 #include <asm/unaligned.h>
28 #define DEFAULT_BAUD_RATE 9600
29 #define DEFAULT_TIMEOUT 1000
31 /* flags for IO-Bits */
32 #define CH341_BIT_RTS (1 << 6)
33 #define CH341_BIT_DTR (1 << 5)
35 /******************************/
36 /* interrupt pipe definitions */
37 /******************************/
38 /* always 4 interrupt bytes */
39 /* first irq byte normally 0x08 */
40 /* second irq byte base 0x7d + below */
41 /* third irq byte base 0x94 + below */
42 /* fourth irq byte normally 0xee */
44 /* second interrupt byte */
45 #define CH341_MULT_STAT 0x04 /* multiple status since last interrupt event */
47 /* status returned in third interrupt answer byte, inverted in data
49 #define CH341_BIT_CTS 0x01
50 #define CH341_BIT_DSR 0x02
51 #define CH341_BIT_RI 0x04
52 #define CH341_BIT_DCD 0x08
53 #define CH341_BITS_MODEM_STAT 0x0f /* all bits */
55 /*******************************/
56 /* baudrate calculation factor */
57 /*******************************/
58 #define CH341_BAUDBASE_FACTOR 1532620800
59 #define CH341_BAUDBASE_DIVMAX 3
61 /* Break support - the information used to implement this was gleaned from
62 * the Net/FreeBSD uchcom.c driver by Takanori Watanabe. Domo arigato.
65 #define CH341_REQ_WRITE_REG 0x9A
66 #define CH341_REQ_READ_REG 0x95
67 #define CH341_REG_BREAK1 0x05
68 #define CH341_REG_BREAK2 0x18
69 #define CH341_NBREAK_BITS_REG1 0x01
70 #define CH341_NBREAK_BITS_REG2 0x40
75 static const struct usb_device_id id_table[] = {
76 { USB_DEVICE(0x4348, 0x5523) },
77 { USB_DEVICE(0x1a86, 0x7523) },
78 { USB_DEVICE(0x1a86, 0x5523) },
81 MODULE_DEVICE_TABLE(usb, id_table);
83 struct ch341_private {
84 spinlock_t lock; /* access lock */
85 unsigned baud_rate; /* set baud rate */
86 u8 line_control; /* set line control value RTS/DTR */
87 u8 line_status; /* active status of modem control inputs */
88 u8 multi_status_change; /* status changed multiple since last call */
91 static int ch341_control_out(struct usb_device *dev, u8 request,
95 dbg("ch341_control_out(%02x,%02x,%04x,%04x)", USB_DIR_OUT|0x40,
96 (int)request, (int)value, (int)index);
98 r = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), request,
99 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
100 value, index, NULL, 0, DEFAULT_TIMEOUT);
105 static int ch341_control_in(struct usb_device *dev,
106 u8 request, u16 value, u16 index,
107 char *buf, unsigned bufsize)
110 dbg("ch341_control_in(%02x,%02x,%04x,%04x,%p,%u)", USB_DIR_IN|0x40,
111 (int)request, (int)value, (int)index, buf, (int)bufsize);
113 r = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), request,
114 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
115 value, index, buf, bufsize, DEFAULT_TIMEOUT);
119 static int ch341_set_baudrate(struct usb_device *dev,
120 struct ch341_private *priv)
124 unsigned long factor;
127 dbg("ch341_set_baudrate(%d)", priv->baud_rate);
129 if (!priv->baud_rate)
131 factor = (CH341_BAUDBASE_FACTOR / priv->baud_rate);
132 divisor = CH341_BAUDBASE_DIVMAX;
134 while ((factor > 0xfff0) && divisor) {
142 factor = 0x10000 - factor;
143 a = (factor & 0xff00) | divisor;
146 r = ch341_control_out(dev, 0x9a, 0x1312, a);
148 r = ch341_control_out(dev, 0x9a, 0x0f2c, b);
153 static int ch341_set_handshake(struct usb_device *dev, u8 control)
155 dbg("ch341_set_handshake(0x%02x)", control);
156 return ch341_control_out(dev, 0xa4, ~control, 0);
159 static int ch341_get_status(struct usb_device *dev, struct ch341_private *priv)
163 const unsigned size = 8;
166 dbg("ch341_get_status()");
168 buffer = kmalloc(size, GFP_KERNEL);
172 r = ch341_control_in(dev, 0x95, 0x0706, 0, buffer, size);
176 /* setup the private status if available */
179 spin_lock_irqsave(&priv->lock, flags);
180 priv->line_status = (~(*buffer)) & CH341_BITS_MODEM_STAT;
181 priv->multi_status_change = 0;
182 spin_unlock_irqrestore(&priv->lock, flags);
190 /* -------------------------------------------------------------------------- */
192 static int ch341_configure(struct usb_device *dev, struct ch341_private *priv)
196 const unsigned size = 8;
198 dbg("ch341_configure()");
200 buffer = kmalloc(size, GFP_KERNEL);
204 /* expect two bytes 0x27 0x00 */
205 r = ch341_control_in(dev, 0x5f, 0, 0, buffer, size);
209 r = ch341_control_out(dev, 0xa1, 0, 0);
213 r = ch341_set_baudrate(dev, priv);
217 /* expect two bytes 0x56 0x00 */
218 r = ch341_control_in(dev, 0x95, 0x2518, 0, buffer, size);
222 r = ch341_control_out(dev, 0x9a, 0x2518, 0x0050);
226 /* expect 0xff 0xee */
227 r = ch341_get_status(dev, priv);
231 r = ch341_control_out(dev, 0xa1, 0x501f, 0xd90a);
235 r = ch341_set_baudrate(dev, priv);
239 r = ch341_set_handshake(dev, priv->line_control);
243 /* expect 0x9f 0xee */
244 r = ch341_get_status(dev, priv);
250 /* allocate private data */
251 static int ch341_attach(struct usb_serial *serial)
253 struct ch341_private *priv;
256 dbg("ch341_attach()");
259 priv = kzalloc(sizeof(struct ch341_private), GFP_KERNEL);
263 spin_lock_init(&priv->lock);
264 priv->baud_rate = DEFAULT_BAUD_RATE;
265 priv->line_control = CH341_BIT_RTS | CH341_BIT_DTR;
267 r = ch341_configure(serial->dev, priv);
271 usb_set_serial_port_data(serial->port[0], priv);
278 static int ch341_carrier_raised(struct usb_serial_port *port)
280 struct ch341_private *priv = usb_get_serial_port_data(port);
281 if (priv->line_status & CH341_BIT_DCD)
286 static void ch341_dtr_rts(struct usb_serial_port *port, int on)
288 struct ch341_private *priv = usb_get_serial_port_data(port);
291 dbg("%s - port %d", __func__, port->number);
292 /* drop DTR and RTS */
293 spin_lock_irqsave(&priv->lock, flags);
295 priv->line_control |= CH341_BIT_RTS | CH341_BIT_DTR;
297 priv->line_control &= ~(CH341_BIT_RTS | CH341_BIT_DTR);
298 spin_unlock_irqrestore(&priv->lock, flags);
299 ch341_set_handshake(port->serial->dev, priv->line_control);
300 wake_up_interruptible(&port->delta_msr_wait);
303 static void ch341_close(struct usb_serial_port *port)
305 dbg("%s - port %d", __func__, port->number);
307 usb_serial_generic_close(port);
308 usb_kill_urb(port->interrupt_in_urb);
312 /* open this device, set default parameters */
313 static int ch341_open(struct tty_struct *tty, struct usb_serial_port *port)
315 struct usb_serial *serial = port->serial;
316 struct ch341_private *priv = usb_get_serial_port_data(serial->port[0]);
321 priv->baud_rate = DEFAULT_BAUD_RATE;
323 r = ch341_configure(serial->dev, priv);
327 r = ch341_set_handshake(serial->dev, priv->line_control);
331 r = ch341_set_baudrate(serial->dev, priv);
335 dbg("%s - submitting interrupt urb", __func__);
336 port->interrupt_in_urb->dev = serial->dev;
337 r = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
339 dev_err(&port->dev, "%s - failed submitting interrupt urb,"
340 " error %d\n", __func__, r);
345 r = usb_serial_generic_open(tty, port);
350 /* Old_termios contains the original termios settings and
351 * tty->termios contains the new setting to be used.
353 static void ch341_set_termios(struct tty_struct *tty,
354 struct usb_serial_port *port, struct ktermios *old_termios)
356 struct ch341_private *priv = usb_get_serial_port_data(port);
360 dbg("ch341_set_termios()");
362 baud_rate = tty_get_baud_rate(tty);
364 priv->baud_rate = baud_rate;
367 spin_lock_irqsave(&priv->lock, flags);
368 priv->line_control |= (CH341_BIT_DTR | CH341_BIT_RTS);
369 spin_unlock_irqrestore(&priv->lock, flags);
370 ch341_set_baudrate(port->serial->dev, priv);
372 spin_lock_irqsave(&priv->lock, flags);
373 priv->line_control &= ~(CH341_BIT_DTR | CH341_BIT_RTS);
374 spin_unlock_irqrestore(&priv->lock, flags);
377 ch341_set_handshake(port->serial->dev, priv->line_control);
380 * (cflag & CSIZE) : data bits [5, 8]
381 * (cflag & PARENB) : parity {NONE, EVEN, ODD}
382 * (cflag & CSTOPB) : stop bits [1, 2]
386 static void ch341_break_ctl(struct tty_struct *tty, int break_state)
388 const uint16_t ch341_break_reg =
389 CH341_REG_BREAK1 | ((uint16_t) CH341_REG_BREAK2 << 8);
390 struct usb_serial_port *port = tty->driver_data;
392 uint16_t reg_contents;
395 dbg("%s()", __func__);
397 break_reg = kmalloc(2, GFP_KERNEL);
399 dev_err(&port->dev, "%s - kmalloc failed\n", __func__);
403 r = ch341_control_in(port->serial->dev, CH341_REQ_READ_REG,
404 ch341_break_reg, 0, break_reg, 2);
406 dev_err(&port->dev, "%s - USB control read error (%d)\n",
410 dbg("%s - initial ch341 break register contents - reg1: %x, reg2: %x",
411 __func__, break_reg[0], break_reg[1]);
412 if (break_state != 0) {
413 dbg("%s - Enter break state requested", __func__);
414 break_reg[0] &= ~CH341_NBREAK_BITS_REG1;
415 break_reg[1] &= ~CH341_NBREAK_BITS_REG2;
417 dbg("%s - Leave break state requested", __func__);
418 break_reg[0] |= CH341_NBREAK_BITS_REG1;
419 break_reg[1] |= CH341_NBREAK_BITS_REG2;
421 dbg("%s - New ch341 break register contents - reg1: %x, reg2: %x",
422 __func__, break_reg[0], break_reg[1]);
423 reg_contents = get_unaligned_le16(break_reg);
424 r = ch341_control_out(port->serial->dev, CH341_REQ_WRITE_REG,
425 ch341_break_reg, reg_contents);
427 dev_err(&port->dev, "%s - USB control write error (%d)\n",
433 static int ch341_tiocmset(struct tty_struct *tty,
434 unsigned int set, unsigned int clear)
436 struct usb_serial_port *port = tty->driver_data;
437 struct ch341_private *priv = usb_get_serial_port_data(port);
441 spin_lock_irqsave(&priv->lock, flags);
443 priv->line_control |= CH341_BIT_RTS;
445 priv->line_control |= CH341_BIT_DTR;
446 if (clear & TIOCM_RTS)
447 priv->line_control &= ~CH341_BIT_RTS;
448 if (clear & TIOCM_DTR)
449 priv->line_control &= ~CH341_BIT_DTR;
450 control = priv->line_control;
451 spin_unlock_irqrestore(&priv->lock, flags);
453 return ch341_set_handshake(port->serial->dev, control);
456 static void ch341_read_int_callback(struct urb *urb)
458 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
459 unsigned char *data = urb->transfer_buffer;
460 unsigned int actual_length = urb->actual_length;
463 dbg("%s (%d)", __func__, port->number);
465 switch (urb->status) {
472 /* this urb is terminated, clean up */
473 dbg("%s - urb shutting down with status: %d", __func__,
477 dbg("%s - nonzero urb status received: %d", __func__,
482 usb_serial_debug_data(debug, &port->dev, __func__,
483 urb->actual_length, urb->transfer_buffer);
485 if (actual_length >= 4) {
486 struct ch341_private *priv = usb_get_serial_port_data(port);
488 u8 prev_line_status = priv->line_status;
490 spin_lock_irqsave(&priv->lock, flags);
491 priv->line_status = (~(data[2])) & CH341_BITS_MODEM_STAT;
492 if ((data[1] & CH341_MULT_STAT))
493 priv->multi_status_change = 1;
494 spin_unlock_irqrestore(&priv->lock, flags);
496 if ((priv->line_status ^ prev_line_status) & CH341_BIT_DCD) {
497 struct tty_struct *tty = tty_port_tty_get(&port->port);
499 usb_serial_handle_dcd_change(port, tty,
500 priv->line_status & CH341_BIT_DCD);
504 wake_up_interruptible(&port->delta_msr_wait);
508 status = usb_submit_urb(urb, GFP_ATOMIC);
510 dev_err(&urb->dev->dev,
511 "%s - usb_submit_urb failed with result %d\n",
515 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
517 struct ch341_private *priv = usb_get_serial_port_data(port);
524 spin_lock_irqsave(&priv->lock, flags);
525 prevstatus = priv->line_status;
526 priv->multi_status_change = 0;
527 spin_unlock_irqrestore(&priv->lock, flags);
529 while (!multi_change) {
530 interruptible_sleep_on(&port->delta_msr_wait);
531 /* see if a signal did it */
532 if (signal_pending(current))
535 if (port->serial->disconnected)
538 spin_lock_irqsave(&priv->lock, flags);
539 status = priv->line_status;
540 multi_change = priv->multi_status_change;
541 spin_unlock_irqrestore(&priv->lock, flags);
543 changed = prevstatus ^ status;
545 if (((arg & TIOCM_RNG) && (changed & CH341_BIT_RI)) ||
546 ((arg & TIOCM_DSR) && (changed & CH341_BIT_DSR)) ||
547 ((arg & TIOCM_CD) && (changed & CH341_BIT_DCD)) ||
548 ((arg & TIOCM_CTS) && (changed & CH341_BIT_CTS))) {
557 static int ch341_ioctl(struct tty_struct *tty,
558 unsigned int cmd, unsigned long arg)
560 struct usb_serial_port *port = tty->driver_data;
561 dbg("%s (%d) cmd = 0x%04x", __func__, port->number, cmd);
565 dbg("%s (%d) TIOCMIWAIT", __func__, port->number);
566 return wait_modem_info(port, arg);
569 dbg("%s not supported = 0x%04x", __func__, cmd);
576 static int ch341_tiocmget(struct tty_struct *tty)
578 struct usb_serial_port *port = tty->driver_data;
579 struct ch341_private *priv = usb_get_serial_port_data(port);
585 dbg("%s (%d)", __func__, port->number);
587 spin_lock_irqsave(&priv->lock, flags);
588 mcr = priv->line_control;
589 status = priv->line_status;
590 spin_unlock_irqrestore(&priv->lock, flags);
592 result = ((mcr & CH341_BIT_DTR) ? TIOCM_DTR : 0)
593 | ((mcr & CH341_BIT_RTS) ? TIOCM_RTS : 0)
594 | ((status & CH341_BIT_CTS) ? TIOCM_CTS : 0)
595 | ((status & CH341_BIT_DSR) ? TIOCM_DSR : 0)
596 | ((status & CH341_BIT_RI) ? TIOCM_RI : 0)
597 | ((status & CH341_BIT_DCD) ? TIOCM_CD : 0);
599 dbg("%s - result = %x", __func__, result);
605 static int ch341_reset_resume(struct usb_interface *intf)
607 struct usb_device *dev = interface_to_usbdev(intf);
608 struct usb_serial *serial = NULL;
609 struct ch341_private *priv;
611 serial = usb_get_intfdata(intf);
612 priv = usb_get_serial_port_data(serial->port[0]);
614 /*reconfigure ch341 serial port after bus-reset*/
615 ch341_configure(dev, priv);
617 usb_serial_resume(intf);
622 static struct usb_driver ch341_driver = {
624 .probe = usb_serial_probe,
625 .disconnect = usb_serial_disconnect,
626 .suspend = usb_serial_suspend,
627 .resume = usb_serial_resume,
628 .reset_resume = ch341_reset_resume,
629 .id_table = id_table,
631 .supports_autosuspend = 1,
634 static struct usb_serial_driver ch341_device = {
636 .owner = THIS_MODULE,
637 .name = "ch341-uart",
639 .id_table = id_table,
640 .usb_driver = &ch341_driver,
643 .dtr_rts = ch341_dtr_rts,
644 .carrier_raised = ch341_carrier_raised,
645 .close = ch341_close,
646 .ioctl = ch341_ioctl,
647 .set_termios = ch341_set_termios,
648 .break_ctl = ch341_break_ctl,
649 .tiocmget = ch341_tiocmget,
650 .tiocmset = ch341_tiocmset,
651 .read_int_callback = ch341_read_int_callback,
652 .attach = ch341_attach,
655 static int __init ch341_init(void)
659 retval = usb_serial_register(&ch341_device);
662 retval = usb_register(&ch341_driver);
664 usb_serial_deregister(&ch341_device);
668 static void __exit ch341_exit(void)
670 usb_deregister(&ch341_driver);
671 usb_serial_deregister(&ch341_device);
674 module_init(ch341_init);
675 module_exit(ch341_exit);
676 MODULE_LICENSE("GPL");
678 module_param(debug, bool, S_IRUGO | S_IWUSR);
679 MODULE_PARM_DESC(debug, "Debug enabled or not");