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
73 static const struct usb_device_id id_table[] = {
74 { USB_DEVICE(0x4348, 0x5523) },
75 { USB_DEVICE(0x1a86, 0x7523) },
76 { USB_DEVICE(0x1a86, 0x5523) },
79 MODULE_DEVICE_TABLE(usb, id_table);
81 struct ch341_private {
82 spinlock_t lock; /* access lock */
83 unsigned baud_rate; /* set baud rate */
84 u8 line_control; /* set line control value RTS/DTR */
85 u8 line_status; /* active status of modem control inputs */
86 u8 multi_status_change; /* status changed multiple since last call */
89 static int ch341_control_out(struct usb_device *dev, u8 request,
94 dev_dbg(&dev->dev, "ch341_control_out(%02x,%02x,%04x,%04x)\n",
95 USB_DIR_OUT|0x40, (int)request, (int)value, (int)index);
97 r = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), request,
98 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
99 value, index, NULL, 0, DEFAULT_TIMEOUT);
104 static int ch341_control_in(struct usb_device *dev,
105 u8 request, u16 value, u16 index,
106 char *buf, unsigned bufsize)
110 dev_dbg(&dev->dev, "ch341_control_in(%02x,%02x,%04x,%04x,%p,%u)\n",
111 USB_DIR_IN|0x40, (int)request, (int)value, (int)index, buf,
114 r = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), request,
115 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
116 value, index, buf, bufsize, DEFAULT_TIMEOUT);
120 static int ch341_set_baudrate(struct usb_device *dev,
121 struct ch341_private *priv)
125 unsigned long factor;
128 if (!priv->baud_rate)
130 factor = (CH341_BAUDBASE_FACTOR / priv->baud_rate);
131 divisor = CH341_BAUDBASE_DIVMAX;
133 while ((factor > 0xfff0) && divisor) {
141 factor = 0x10000 - factor;
142 a = (factor & 0xff00) | divisor;
145 r = ch341_control_out(dev, 0x9a, 0x1312, a);
147 r = ch341_control_out(dev, 0x9a, 0x0f2c, b);
152 static int ch341_set_handshake(struct usb_device *dev, u8 control)
154 return ch341_control_out(dev, 0xa4, ~control, 0);
157 static int ch341_get_status(struct usb_device *dev, struct ch341_private *priv)
161 const unsigned size = 8;
164 buffer = kmalloc(size, GFP_KERNEL);
168 r = ch341_control_in(dev, 0x95, 0x0706, 0, buffer, size);
172 /* setup the private status if available */
175 spin_lock_irqsave(&priv->lock, flags);
176 priv->line_status = (~(*buffer)) & CH341_BITS_MODEM_STAT;
177 priv->multi_status_change = 0;
178 spin_unlock_irqrestore(&priv->lock, flags);
186 /* -------------------------------------------------------------------------- */
188 static int ch341_configure(struct usb_device *dev, struct ch341_private *priv)
192 const unsigned size = 8;
194 buffer = kmalloc(size, GFP_KERNEL);
198 /* expect two bytes 0x27 0x00 */
199 r = ch341_control_in(dev, 0x5f, 0, 0, buffer, size);
203 r = ch341_control_out(dev, 0xa1, 0, 0);
207 r = ch341_set_baudrate(dev, priv);
211 /* expect two bytes 0x56 0x00 */
212 r = ch341_control_in(dev, 0x95, 0x2518, 0, buffer, size);
216 r = ch341_control_out(dev, 0x9a, 0x2518, 0x0050);
220 /* expect 0xff 0xee */
221 r = ch341_get_status(dev, priv);
225 r = ch341_control_out(dev, 0xa1, 0x501f, 0xd90a);
229 r = ch341_set_baudrate(dev, priv);
233 r = ch341_set_handshake(dev, priv->line_control);
237 /* expect 0x9f 0xee */
238 r = ch341_get_status(dev, priv);
244 static int ch341_port_probe(struct usb_serial_port *port)
246 struct ch341_private *priv;
249 priv = kzalloc(sizeof(struct ch341_private), GFP_KERNEL);
253 spin_lock_init(&priv->lock);
254 priv->baud_rate = DEFAULT_BAUD_RATE;
255 priv->line_control = CH341_BIT_RTS | CH341_BIT_DTR;
257 r = ch341_configure(port->serial->dev, priv);
261 usb_set_serial_port_data(port, priv);
268 static int ch341_port_remove(struct usb_serial_port *port)
270 struct ch341_private *priv;
272 priv = usb_get_serial_port_data(port);
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 /* drop DTR and RTS */
292 spin_lock_irqsave(&priv->lock, flags);
294 priv->line_control |= CH341_BIT_RTS | CH341_BIT_DTR;
296 priv->line_control &= ~(CH341_BIT_RTS | CH341_BIT_DTR);
297 spin_unlock_irqrestore(&priv->lock, flags);
298 ch341_set_handshake(port->serial->dev, priv->line_control);
299 wake_up_interruptible(&port->delta_msr_wait);
302 static void ch341_close(struct usb_serial_port *port)
304 usb_serial_generic_close(port);
305 usb_kill_urb(port->interrupt_in_urb);
309 /* open this device, set default parameters */
310 static int ch341_open(struct tty_struct *tty, struct usb_serial_port *port)
312 struct usb_serial *serial = port->serial;
313 struct ch341_private *priv = usb_get_serial_port_data(port);
316 priv->baud_rate = DEFAULT_BAUD_RATE;
318 r = ch341_configure(serial->dev, priv);
322 r = ch341_set_handshake(serial->dev, priv->line_control);
326 r = ch341_set_baudrate(serial->dev, priv);
330 dev_dbg(&port->dev, "%s - submitting interrupt urb", __func__);
331 r = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
333 dev_err(&port->dev, "%s - failed submitting interrupt urb,"
334 " error %d\n", __func__, r);
339 r = usb_serial_generic_open(tty, port);
344 /* Old_termios contains the original termios settings and
345 * tty->termios contains the new setting to be used.
347 static void ch341_set_termios(struct tty_struct *tty,
348 struct usb_serial_port *port, struct ktermios *old_termios)
350 struct ch341_private *priv = usb_get_serial_port_data(port);
354 baud_rate = tty_get_baud_rate(tty);
356 priv->baud_rate = baud_rate;
359 spin_lock_irqsave(&priv->lock, flags);
360 priv->line_control |= (CH341_BIT_DTR | CH341_BIT_RTS);
361 spin_unlock_irqrestore(&priv->lock, flags);
362 ch341_set_baudrate(port->serial->dev, priv);
364 spin_lock_irqsave(&priv->lock, flags);
365 priv->line_control &= ~(CH341_BIT_DTR | CH341_BIT_RTS);
366 spin_unlock_irqrestore(&priv->lock, flags);
369 ch341_set_handshake(port->serial->dev, priv->line_control);
372 * (cflag & CSIZE) : data bits [5, 8]
373 * (cflag & PARENB) : parity {NONE, EVEN, ODD}
374 * (cflag & CSTOPB) : stop bits [1, 2]
378 static void ch341_break_ctl(struct tty_struct *tty, int break_state)
380 const uint16_t ch341_break_reg =
381 CH341_REG_BREAK1 | ((uint16_t) CH341_REG_BREAK2 << 8);
382 struct usb_serial_port *port = tty->driver_data;
384 uint16_t reg_contents;
387 break_reg = kmalloc(2, GFP_KERNEL);
389 dev_err(&port->dev, "%s - kmalloc failed\n", __func__);
393 r = ch341_control_in(port->serial->dev, CH341_REQ_READ_REG,
394 ch341_break_reg, 0, break_reg, 2);
396 dev_err(&port->dev, "%s - USB control read error (%d)\n",
400 dev_dbg(&port->dev, "%s - initial ch341 break register contents - reg1: %x, reg2: %x\n",
401 __func__, break_reg[0], break_reg[1]);
402 if (break_state != 0) {
403 dev_dbg(&port->dev, "%s - Enter break state requested\n", __func__);
404 break_reg[0] &= ~CH341_NBREAK_BITS_REG1;
405 break_reg[1] &= ~CH341_NBREAK_BITS_REG2;
407 dev_dbg(&port->dev, "%s - Leave break state requested\n", __func__);
408 break_reg[0] |= CH341_NBREAK_BITS_REG1;
409 break_reg[1] |= CH341_NBREAK_BITS_REG2;
411 dev_dbg(&port->dev, "%s - New ch341 break register contents - reg1: %x, reg2: %x\n",
412 __func__, break_reg[0], break_reg[1]);
413 reg_contents = get_unaligned_le16(break_reg);
414 r = ch341_control_out(port->serial->dev, CH341_REQ_WRITE_REG,
415 ch341_break_reg, reg_contents);
417 dev_err(&port->dev, "%s - USB control write error (%d)\n",
423 static int ch341_tiocmset(struct tty_struct *tty,
424 unsigned int set, unsigned int clear)
426 struct usb_serial_port *port = tty->driver_data;
427 struct ch341_private *priv = usb_get_serial_port_data(port);
431 spin_lock_irqsave(&priv->lock, flags);
433 priv->line_control |= CH341_BIT_RTS;
435 priv->line_control |= CH341_BIT_DTR;
436 if (clear & TIOCM_RTS)
437 priv->line_control &= ~CH341_BIT_RTS;
438 if (clear & TIOCM_DTR)
439 priv->line_control &= ~CH341_BIT_DTR;
440 control = priv->line_control;
441 spin_unlock_irqrestore(&priv->lock, flags);
443 return ch341_set_handshake(port->serial->dev, control);
446 static void ch341_read_int_callback(struct urb *urb)
448 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
449 unsigned char *data = urb->transfer_buffer;
450 unsigned int actual_length = urb->actual_length;
453 switch (urb->status) {
460 /* this urb is terminated, clean up */
461 dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n",
462 __func__, urb->status);
465 dev_dbg(&urb->dev->dev, "%s - nonzero urb status received: %d\n",
466 __func__, urb->status);
470 usb_serial_debug_data(&port->dev, __func__,
471 urb->actual_length, urb->transfer_buffer);
473 if (actual_length >= 4) {
474 struct ch341_private *priv = usb_get_serial_port_data(port);
476 u8 prev_line_status = priv->line_status;
478 spin_lock_irqsave(&priv->lock, flags);
479 priv->line_status = (~(data[2])) & CH341_BITS_MODEM_STAT;
480 if ((data[1] & CH341_MULT_STAT))
481 priv->multi_status_change = 1;
482 spin_unlock_irqrestore(&priv->lock, flags);
484 if ((priv->line_status ^ prev_line_status) & CH341_BIT_DCD) {
485 struct tty_struct *tty = tty_port_tty_get(&port->port);
487 usb_serial_handle_dcd_change(port, tty,
488 priv->line_status & CH341_BIT_DCD);
492 wake_up_interruptible(&port->delta_msr_wait);
496 status = usb_submit_urb(urb, GFP_ATOMIC);
498 dev_err(&urb->dev->dev,
499 "%s - usb_submit_urb failed with result %d\n",
503 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
505 struct ch341_private *priv = usb_get_serial_port_data(port);
512 spin_lock_irqsave(&priv->lock, flags);
513 prevstatus = priv->line_status;
514 priv->multi_status_change = 0;
515 spin_unlock_irqrestore(&priv->lock, flags);
517 while (!multi_change) {
518 interruptible_sleep_on(&port->delta_msr_wait);
519 /* see if a signal did it */
520 if (signal_pending(current))
523 if (port->serial->disconnected)
526 spin_lock_irqsave(&priv->lock, flags);
527 status = priv->line_status;
528 multi_change = priv->multi_status_change;
529 spin_unlock_irqrestore(&priv->lock, flags);
531 changed = prevstatus ^ status;
533 if (((arg & TIOCM_RNG) && (changed & CH341_BIT_RI)) ||
534 ((arg & TIOCM_DSR) && (changed & CH341_BIT_DSR)) ||
535 ((arg & TIOCM_CD) && (changed & CH341_BIT_DCD)) ||
536 ((arg & TIOCM_CTS) && (changed & CH341_BIT_CTS))) {
545 static int ch341_ioctl(struct tty_struct *tty,
546 unsigned int cmd, unsigned long arg)
548 struct usb_serial_port *port = tty->driver_data;
550 dev_dbg(&port->dev, "%s (%d) cmd = 0x%04x\n", __func__, port->number, cmd);
554 dev_dbg(&port->dev, "%s (%d) TIOCMIWAIT\n", __func__, port->number);
555 return wait_modem_info(port, arg);
558 dev_dbg(&port->dev, "%s not supported = 0x%04x\n", __func__, cmd);
565 static int ch341_tiocmget(struct tty_struct *tty)
567 struct usb_serial_port *port = tty->driver_data;
568 struct ch341_private *priv = usb_get_serial_port_data(port);
574 spin_lock_irqsave(&priv->lock, flags);
575 mcr = priv->line_control;
576 status = priv->line_status;
577 spin_unlock_irqrestore(&priv->lock, flags);
579 result = ((mcr & CH341_BIT_DTR) ? TIOCM_DTR : 0)
580 | ((mcr & CH341_BIT_RTS) ? TIOCM_RTS : 0)
581 | ((status & CH341_BIT_CTS) ? TIOCM_CTS : 0)
582 | ((status & CH341_BIT_DSR) ? TIOCM_DSR : 0)
583 | ((status & CH341_BIT_RI) ? TIOCM_RI : 0)
584 | ((status & CH341_BIT_DCD) ? TIOCM_CD : 0);
586 dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
591 static int ch341_reset_resume(struct usb_serial *serial)
593 struct ch341_private *priv;
595 priv = usb_get_serial_port_data(serial->port[0]);
597 /* reconfigure ch341 serial port after bus-reset */
598 ch341_configure(serial->dev, priv);
603 static struct usb_serial_driver ch341_device = {
605 .owner = THIS_MODULE,
606 .name = "ch341-uart",
608 .id_table = id_table,
611 .dtr_rts = ch341_dtr_rts,
612 .carrier_raised = ch341_carrier_raised,
613 .close = ch341_close,
614 .ioctl = ch341_ioctl,
615 .set_termios = ch341_set_termios,
616 .break_ctl = ch341_break_ctl,
617 .tiocmget = ch341_tiocmget,
618 .tiocmset = ch341_tiocmset,
619 .read_int_callback = ch341_read_int_callback,
620 .port_probe = ch341_port_probe,
621 .port_remove = ch341_port_remove,
622 .reset_resume = ch341_reset_resume,
625 static struct usb_serial_driver * const serial_drivers[] = {
629 module_usb_serial_driver(serial_drivers, id_table);
631 MODULE_LICENSE("GPL");