1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright 2007, Frank A Kingswood <frank@kingswood-consulting.co.uk>
4 * Copyright 2007, Werner Cornelius <werner@cornelius-consult.de>
5 * Copyright 2009, Boris Hajduk <boris@hajduk.org>
7 * ch341.c implements a serial port driver for the Winchiphead CH341.
9 * The CH341 device can be used to implement an RS232 asynchronous
10 * serial port, an IEEE-1284 parallel printer port or a memory-like
11 * interface. In all cases the CH341 supports an I2C interface as well.
12 * This driver only supports the asynchronous serial interface.
15 #include <linux/kernel.h>
16 #include <linux/tty.h>
17 #include <linux/module.h>
18 #include <linux/slab.h>
19 #include <linux/usb.h>
20 #include <linux/usb/serial.h>
21 #include <linux/serial.h>
22 #include <asm/unaligned.h>
24 #define DEFAULT_BAUD_RATE 9600
25 #define DEFAULT_TIMEOUT 1000
27 /* flags for IO-Bits */
28 #define CH341_BIT_RTS (1 << 6)
29 #define CH341_BIT_DTR (1 << 5)
31 /******************************/
32 /* interrupt pipe definitions */
33 /******************************/
34 /* always 4 interrupt bytes */
35 /* first irq byte normally 0x08 */
36 /* second irq byte base 0x7d + below */
37 /* third irq byte base 0x94 + below */
38 /* fourth irq byte normally 0xee */
40 /* second interrupt byte */
41 #define CH341_MULT_STAT 0x04 /* multiple status since last interrupt event */
43 /* status returned in third interrupt answer byte, inverted in data
45 #define CH341_BIT_CTS 0x01
46 #define CH341_BIT_DSR 0x02
47 #define CH341_BIT_RI 0x04
48 #define CH341_BIT_DCD 0x08
49 #define CH341_BITS_MODEM_STAT 0x0f /* all bits */
51 /* Break support - the information used to implement this was gleaned from
52 * the Net/FreeBSD uchcom.c driver by Takanori Watanabe. Domo arigato.
55 #define CH341_REQ_READ_VERSION 0x5F
56 #define CH341_REQ_WRITE_REG 0x9A
57 #define CH341_REQ_READ_REG 0x95
58 #define CH341_REQ_SERIAL_INIT 0xA1
59 #define CH341_REQ_MODEM_CTRL 0xA4
61 #define CH341_REG_BREAK 0x05
62 #define CH341_REG_PRESCALER 0x12
63 #define CH341_REG_DIVISOR 0x13
64 #define CH341_REG_LCR 0x18
65 #define CH341_REG_LCR2 0x25
67 #define CH341_NBREAK_BITS 0x01
69 #define CH341_LCR_ENABLE_RX 0x80
70 #define CH341_LCR_ENABLE_TX 0x40
71 #define CH341_LCR_MARK_SPACE 0x20
72 #define CH341_LCR_PAR_EVEN 0x10
73 #define CH341_LCR_ENABLE_PAR 0x08
74 #define CH341_LCR_STOP_BITS_2 0x04
75 #define CH341_LCR_CS8 0x03
76 #define CH341_LCR_CS7 0x02
77 #define CH341_LCR_CS6 0x01
78 #define CH341_LCR_CS5 0x00
80 #define CH341_QUIRK_LIMITED_PRESCALER BIT(0)
81 #define CH341_QUIRK_SIMULATE_BREAK BIT(1)
83 static const struct usb_device_id id_table[] = {
84 { USB_DEVICE(0x1a86, 0x5512) },
85 { USB_DEVICE(0x1a86, 0x5523) },
86 { USB_DEVICE(0x1a86, 0x7522) },
87 { USB_DEVICE(0x1a86, 0x7523) },
88 { USB_DEVICE(0x2184, 0x0057) },
89 { USB_DEVICE(0x4348, 0x5523) },
90 { USB_DEVICE(0x9986, 0x7523) },
93 MODULE_DEVICE_TABLE(usb, id_table);
95 struct ch341_private {
96 spinlock_t lock; /* access lock */
97 unsigned baud_rate; /* set baud rate */
101 unsigned long quirks;
102 unsigned long break_end;
105 static void ch341_set_termios(struct tty_struct *tty,
106 struct usb_serial_port *port,
107 struct ktermios *old_termios);
109 static int ch341_control_out(struct usb_device *dev, u8 request,
110 u16 value, u16 index)
114 dev_dbg(&dev->dev, "%s - (%02x,%04x,%04x)\n", __func__,
115 request, value, index);
117 r = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), request,
118 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
119 value, index, NULL, 0, DEFAULT_TIMEOUT);
121 dev_err(&dev->dev, "failed to send control message: %d\n", r);
126 static int ch341_control_in(struct usb_device *dev,
127 u8 request, u16 value, u16 index,
128 char *buf, unsigned bufsize)
132 dev_dbg(&dev->dev, "%s - (%02x,%04x,%04x,%u)\n", __func__,
133 request, value, index, bufsize);
135 r = usb_control_msg_recv(dev, 0, request,
136 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
137 value, index, buf, bufsize, DEFAULT_TIMEOUT,
140 dev_err(&dev->dev, "failed to receive control message: %d\n",
148 #define CH341_CLKRATE 48000000
149 #define CH341_CLK_DIV(ps, fact) (1 << (12 - 3 * (ps) - (fact)))
150 #define CH341_MIN_RATE(ps) (CH341_CLKRATE / (CH341_CLK_DIV((ps), 1) * 512))
152 static const speed_t ch341_min_rates[] = {
159 /* Supported range is 46 to 3000000 bps. */
160 #define CH341_MIN_BPS DIV_ROUND_UP(CH341_CLKRATE, CH341_CLK_DIV(0, 0) * 256)
161 #define CH341_MAX_BPS (CH341_CLKRATE / (CH341_CLK_DIV(3, 0) * 2))
164 * The device line speed is given by the following equation:
166 * baudrate = 48000000 / (2^(12 - 3 * ps - fact) * div), where
170 * 2 <= div <= 256 if fact = 0, or
171 * 9 <= div <= 256 if fact = 1
173 static int ch341_get_divisor(struct ch341_private *priv, speed_t speed)
175 unsigned int fact, div, clk_div;
176 bool force_fact0 = false;
180 * Clamp to supported range, this makes the (ps < 0) and (div < 2)
181 * sanity checks below redundant.
183 speed = clamp_val(speed, CH341_MIN_BPS, CH341_MAX_BPS);
186 * Start with highest possible base clock (fact = 1) that will give a
187 * divisor strictly less than 512.
190 for (ps = 3; ps >= 0; ps--) {
191 if (speed > ch341_min_rates[ps])
198 /* Determine corresponding divisor, rounding down. */
199 clk_div = CH341_CLK_DIV(ps, fact);
200 div = CH341_CLKRATE / (clk_div * speed);
202 /* Some devices require a lower base clock if ps < 3. */
203 if (ps < 3 && (priv->quirks & CH341_QUIRK_LIMITED_PRESCALER))
206 /* Halve base clock (fact = 0) if required. */
207 if (div < 9 || div > 255 || force_fact0) {
217 * Pick next divisor if resulting rate is closer to the requested one,
218 * scale up to avoid rounding errors on low rates.
220 if (16 * CH341_CLKRATE / (clk_div * div) - 16 * speed >=
221 16 * speed - 16 * CH341_CLKRATE / (clk_div * (div + 1)))
225 * Prefer lower base clock (fact = 0) if even divisor.
227 * Note that this makes the receiver more tolerant to errors.
229 if (fact == 1 && div % 2 == 0) {
234 return (0x100 - div) << 8 | fact << 2 | ps;
237 static int ch341_set_baudrate_lcr(struct usb_device *dev,
238 struct ch341_private *priv,
239 speed_t baud_rate, u8 lcr)
247 val = ch341_get_divisor(priv, baud_rate);
252 * CH341A buffers data until a full endpoint-size packet (32 bytes)
253 * has been received unless bit 7 is set.
257 r = ch341_control_out(dev, CH341_REQ_WRITE_REG,
258 CH341_REG_DIVISOR << 8 | CH341_REG_PRESCALER,
264 * Chip versions before version 0x30 as read using
265 * CH341_REQ_READ_VERSION used separate registers for line control
266 * (stop bits, parity and word length). Version 0x30 and above use
267 * CH341_REG_LCR only and CH341_REG_LCR2 is always set to zero.
269 r = ch341_control_out(dev, CH341_REQ_WRITE_REG,
270 CH341_REG_LCR2 << 8 | CH341_REG_LCR, lcr);
277 static int ch341_set_handshake(struct usb_device *dev, u8 control)
279 return ch341_control_out(dev, CH341_REQ_MODEM_CTRL, ~control, 0);
282 static int ch341_get_status(struct usb_device *dev, struct ch341_private *priv)
284 const unsigned int size = 2;
289 r = ch341_control_in(dev, CH341_REQ_READ_REG, 0x0706, 0, buffer, size);
293 spin_lock_irqsave(&priv->lock, flags);
294 priv->msr = (~(*buffer)) & CH341_BITS_MODEM_STAT;
295 spin_unlock_irqrestore(&priv->lock, flags);
300 /* -------------------------------------------------------------------------- */
302 static int ch341_configure(struct usb_device *dev, struct ch341_private *priv)
304 const unsigned int size = 2;
308 /* expect two bytes 0x27 0x00 */
309 r = ch341_control_in(dev, CH341_REQ_READ_VERSION, 0, 0, buffer, size);
312 dev_dbg(&dev->dev, "Chip version: 0x%02x\n", buffer[0]);
314 r = ch341_control_out(dev, CH341_REQ_SERIAL_INIT, 0, 0);
318 r = ch341_set_baudrate_lcr(dev, priv, priv->baud_rate, priv->lcr);
322 r = ch341_set_handshake(dev, priv->mcr);
329 static int ch341_detect_quirks(struct usb_serial_port *port)
331 struct ch341_private *priv = usb_get_serial_port_data(port);
332 struct usb_device *udev = port->serial->dev;
333 const unsigned int size = 2;
334 unsigned long quirks = 0;
339 * A subset of CH34x devices does not support all features. The
340 * prescaler is limited and there is no support for sending a RS232
341 * break condition. A read failure when trying to set up the latter is
342 * used to detect these devices.
344 r = usb_control_msg_recv(udev, 0, CH341_REQ_READ_REG,
345 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
346 CH341_REG_BREAK, 0, &buffer, size,
347 DEFAULT_TIMEOUT, GFP_KERNEL);
349 dev_info(&port->dev, "break control not supported, using simulated break\n");
350 quirks = CH341_QUIRK_LIMITED_PRESCALER | CH341_QUIRK_SIMULATE_BREAK;
353 dev_err(&port->dev, "failed to read break control: %d\n", r);
357 dev_dbg(&port->dev, "enabling quirk flags: 0x%02lx\n", quirks);
358 priv->quirks |= quirks;
364 static int ch341_port_probe(struct usb_serial_port *port)
366 struct ch341_private *priv;
369 priv = kzalloc(sizeof(struct ch341_private), GFP_KERNEL);
373 spin_lock_init(&priv->lock);
374 priv->baud_rate = DEFAULT_BAUD_RATE;
376 * Some CH340 devices appear unable to change the initial LCR
377 * settings, so set a sane 8N1 default.
379 priv->lcr = CH341_LCR_ENABLE_RX | CH341_LCR_ENABLE_TX | CH341_LCR_CS8;
381 r = ch341_configure(port->serial->dev, priv);
385 usb_set_serial_port_data(port, priv);
387 r = ch341_detect_quirks(port);
397 static void ch341_port_remove(struct usb_serial_port *port)
399 struct ch341_private *priv;
401 priv = usb_get_serial_port_data(port);
405 static int ch341_carrier_raised(struct usb_serial_port *port)
407 struct ch341_private *priv = usb_get_serial_port_data(port);
408 if (priv->msr & CH341_BIT_DCD)
413 static void ch341_dtr_rts(struct usb_serial_port *port, int on)
415 struct ch341_private *priv = usb_get_serial_port_data(port);
418 /* drop DTR and RTS */
419 spin_lock_irqsave(&priv->lock, flags);
421 priv->mcr |= CH341_BIT_RTS | CH341_BIT_DTR;
423 priv->mcr &= ~(CH341_BIT_RTS | CH341_BIT_DTR);
424 spin_unlock_irqrestore(&priv->lock, flags);
425 ch341_set_handshake(port->serial->dev, priv->mcr);
428 static void ch341_close(struct usb_serial_port *port)
430 usb_serial_generic_close(port);
431 usb_kill_urb(port->interrupt_in_urb);
435 /* open this device, set default parameters */
436 static int ch341_open(struct tty_struct *tty, struct usb_serial_port *port)
438 struct ch341_private *priv = usb_get_serial_port_data(port);
442 ch341_set_termios(tty, port, NULL);
444 dev_dbg(&port->dev, "%s - submitting interrupt urb\n", __func__);
445 r = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
447 dev_err(&port->dev, "%s - failed to submit interrupt urb: %d\n",
452 r = ch341_get_status(port->serial->dev, priv);
454 dev_err(&port->dev, "failed to read modem status: %d\n", r);
455 goto err_kill_interrupt_urb;
458 r = usb_serial_generic_open(tty, port);
460 goto err_kill_interrupt_urb;
464 err_kill_interrupt_urb:
465 usb_kill_urb(port->interrupt_in_urb);
470 /* Old_termios contains the original termios settings and
471 * tty->termios contains the new setting to be used.
473 static void ch341_set_termios(struct tty_struct *tty,
474 struct usb_serial_port *port, struct ktermios *old_termios)
476 struct ch341_private *priv = usb_get_serial_port_data(port);
482 /* redundant changes may cause the chip to lose bytes */
483 if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios))
486 baud_rate = tty_get_baud_rate(tty);
488 lcr = CH341_LCR_ENABLE_RX | CH341_LCR_ENABLE_TX;
490 switch (C_CSIZE(tty)) {
492 lcr |= CH341_LCR_CS5;
495 lcr |= CH341_LCR_CS6;
498 lcr |= CH341_LCR_CS7;
501 lcr |= CH341_LCR_CS8;
506 lcr |= CH341_LCR_ENABLE_PAR;
507 if (C_PARODD(tty) == 0)
508 lcr |= CH341_LCR_PAR_EVEN;
510 lcr |= CH341_LCR_MARK_SPACE;
514 lcr |= CH341_LCR_STOP_BITS_2;
517 priv->baud_rate = baud_rate;
519 r = ch341_set_baudrate_lcr(port->serial->dev, priv,
520 priv->baud_rate, lcr);
521 if (r < 0 && old_termios) {
522 priv->baud_rate = tty_termios_baud_rate(old_termios);
523 tty_termios_copy_hw(&tty->termios, old_termios);
529 spin_lock_irqsave(&priv->lock, flags);
530 if (C_BAUD(tty) == B0)
531 priv->mcr &= ~(CH341_BIT_DTR | CH341_BIT_RTS);
532 else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
533 priv->mcr |= (CH341_BIT_DTR | CH341_BIT_RTS);
534 spin_unlock_irqrestore(&priv->lock, flags);
536 ch341_set_handshake(port->serial->dev, priv->mcr);
540 * A subset of all CH34x devices don't support a real break condition and
541 * reading CH341_REG_BREAK fails (see also ch341_detect_quirks). This function
542 * simulates a break condition by lowering the baud rate to the minimum
543 * supported by the hardware upon enabling the break condition and sending
546 * Incoming data is corrupted while the break condition is being simulated.
548 * Normally the duration of the break condition can be controlled individually
549 * by userspace using TIOCSBRK and TIOCCBRK or by passing an argument to
550 * TCSBRKP. Due to how the simulation is implemented the duration can't be
551 * controlled. The duration is always about (1s / 46bd * 9bit) = 196ms.
553 static void ch341_simulate_break(struct tty_struct *tty, int break_state)
555 struct usb_serial_port *port = tty->driver_data;
556 struct ch341_private *priv = usb_get_serial_port_data(port);
557 unsigned long now, delay;
560 if (break_state != 0) {
561 dev_dbg(&port->dev, "enter break state requested\n");
563 r = ch341_set_baudrate_lcr(port->serial->dev, priv,
565 CH341_LCR_ENABLE_RX | CH341_LCR_ENABLE_TX | CH341_LCR_CS8);
568 "failed to change baud rate to %u: %d\n",
573 r = tty_put_char(tty, '\0');
576 "failed to write NUL byte for simulated break condition: %d\n",
582 * Compute expected transmission duration including safety
583 * margin. The original baud rate is only restored after the
584 * computed point in time.
586 * 11 bits = 1 start, 8 data, 1 stop, 1 margin
588 priv->break_end = jiffies + (11 * HZ / CH341_MIN_BPS);
593 dev_dbg(&port->dev, "leave break state requested\n");
597 if (time_before(now, priv->break_end)) {
598 /* Wait until NUL byte is written */
599 delay = priv->break_end - now;
601 "wait %d ms while transmitting NUL byte at %u baud\n",
602 jiffies_to_msecs(delay), CH341_MIN_BPS);
603 schedule_timeout_interruptible(delay);
607 /* Restore original baud rate */
608 r = ch341_set_baudrate_lcr(port->serial->dev, priv, priv->baud_rate,
612 "restoring original baud rate of %u failed: %d\n",
616 static void ch341_break_ctl(struct tty_struct *tty, int break_state)
618 const uint16_t ch341_break_reg =
619 ((uint16_t) CH341_REG_LCR << 8) | CH341_REG_BREAK;
620 struct usb_serial_port *port = tty->driver_data;
621 struct ch341_private *priv = usb_get_serial_port_data(port);
623 uint16_t reg_contents;
624 uint8_t break_reg[2];
626 if (priv->quirks & CH341_QUIRK_SIMULATE_BREAK) {
627 ch341_simulate_break(tty, break_state);
631 r = ch341_control_in(port->serial->dev, CH341_REQ_READ_REG,
632 ch341_break_reg, 0, break_reg, 2);
634 dev_err(&port->dev, "%s - USB control read error (%d)\n",
638 dev_dbg(&port->dev, "%s - initial ch341 break register contents - reg1: %x, reg2: %x\n",
639 __func__, break_reg[0], break_reg[1]);
640 if (break_state != 0) {
641 dev_dbg(&port->dev, "%s - Enter break state requested\n", __func__);
642 break_reg[0] &= ~CH341_NBREAK_BITS;
643 break_reg[1] &= ~CH341_LCR_ENABLE_TX;
645 dev_dbg(&port->dev, "%s - Leave break state requested\n", __func__);
646 break_reg[0] |= CH341_NBREAK_BITS;
647 break_reg[1] |= CH341_LCR_ENABLE_TX;
649 dev_dbg(&port->dev, "%s - New ch341 break register contents - reg1: %x, reg2: %x\n",
650 __func__, break_reg[0], break_reg[1]);
651 reg_contents = get_unaligned_le16(break_reg);
652 r = ch341_control_out(port->serial->dev, CH341_REQ_WRITE_REG,
653 ch341_break_reg, reg_contents);
655 dev_err(&port->dev, "%s - USB control write error (%d)\n",
659 static int ch341_tiocmset(struct tty_struct *tty,
660 unsigned int set, unsigned int clear)
662 struct usb_serial_port *port = tty->driver_data;
663 struct ch341_private *priv = usb_get_serial_port_data(port);
667 spin_lock_irqsave(&priv->lock, flags);
669 priv->mcr |= CH341_BIT_RTS;
671 priv->mcr |= CH341_BIT_DTR;
672 if (clear & TIOCM_RTS)
673 priv->mcr &= ~CH341_BIT_RTS;
674 if (clear & TIOCM_DTR)
675 priv->mcr &= ~CH341_BIT_DTR;
677 spin_unlock_irqrestore(&priv->lock, flags);
679 return ch341_set_handshake(port->serial->dev, control);
682 static void ch341_update_status(struct usb_serial_port *port,
683 unsigned char *data, size_t len)
685 struct ch341_private *priv = usb_get_serial_port_data(port);
686 struct tty_struct *tty;
694 status = ~data[2] & CH341_BITS_MODEM_STAT;
696 spin_lock_irqsave(&priv->lock, flags);
697 delta = status ^ priv->msr;
699 spin_unlock_irqrestore(&priv->lock, flags);
701 if (data[1] & CH341_MULT_STAT)
702 dev_dbg(&port->dev, "%s - multiple status change\n", __func__);
707 if (delta & CH341_BIT_CTS)
709 if (delta & CH341_BIT_DSR)
711 if (delta & CH341_BIT_RI)
713 if (delta & CH341_BIT_DCD) {
715 tty = tty_port_tty_get(&port->port);
717 usb_serial_handle_dcd_change(port, tty,
718 status & CH341_BIT_DCD);
723 wake_up_interruptible(&port->port.delta_msr_wait);
726 static void ch341_read_int_callback(struct urb *urb)
728 struct usb_serial_port *port = urb->context;
729 unsigned char *data = urb->transfer_buffer;
730 unsigned int len = urb->actual_length;
733 switch (urb->status) {
740 /* this urb is terminated, clean up */
741 dev_dbg(&urb->dev->dev, "%s - urb shutting down: %d\n",
742 __func__, urb->status);
745 dev_dbg(&urb->dev->dev, "%s - nonzero urb status: %d\n",
746 __func__, urb->status);
750 usb_serial_debug_data(&port->dev, __func__, len, data);
751 ch341_update_status(port, data, len);
753 status = usb_submit_urb(urb, GFP_ATOMIC);
755 dev_err(&urb->dev->dev, "%s - usb_submit_urb failed: %d\n",
760 static int ch341_tiocmget(struct tty_struct *tty)
762 struct usb_serial_port *port = tty->driver_data;
763 struct ch341_private *priv = usb_get_serial_port_data(port);
769 spin_lock_irqsave(&priv->lock, flags);
772 spin_unlock_irqrestore(&priv->lock, flags);
774 result = ((mcr & CH341_BIT_DTR) ? TIOCM_DTR : 0)
775 | ((mcr & CH341_BIT_RTS) ? TIOCM_RTS : 0)
776 | ((status & CH341_BIT_CTS) ? TIOCM_CTS : 0)
777 | ((status & CH341_BIT_DSR) ? TIOCM_DSR : 0)
778 | ((status & CH341_BIT_RI) ? TIOCM_RI : 0)
779 | ((status & CH341_BIT_DCD) ? TIOCM_CD : 0);
781 dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
786 static int ch341_reset_resume(struct usb_serial *serial)
788 struct usb_serial_port *port = serial->port[0];
789 struct ch341_private *priv;
792 priv = usb_get_serial_port_data(port);
796 /* reconfigure ch341 serial port after bus-reset */
797 ch341_configure(serial->dev, priv);
799 if (tty_port_initialized(&port->port)) {
800 ret = usb_submit_urb(port->interrupt_in_urb, GFP_NOIO);
802 dev_err(&port->dev, "failed to submit interrupt urb: %d\n",
807 ret = ch341_get_status(port->serial->dev, priv);
809 dev_err(&port->dev, "failed to read modem status: %d\n",
814 return usb_serial_generic_resume(serial);
817 static struct usb_serial_driver ch341_device = {
819 .owner = THIS_MODULE,
820 .name = "ch341-uart",
822 .id_table = id_table,
825 .dtr_rts = ch341_dtr_rts,
826 .carrier_raised = ch341_carrier_raised,
827 .close = ch341_close,
828 .set_termios = ch341_set_termios,
829 .break_ctl = ch341_break_ctl,
830 .tiocmget = ch341_tiocmget,
831 .tiocmset = ch341_tiocmset,
832 .tiocmiwait = usb_serial_generic_tiocmiwait,
833 .read_int_callback = ch341_read_int_callback,
834 .port_probe = ch341_port_probe,
835 .port_remove = ch341_port_remove,
836 .reset_resume = ch341_reset_resume,
839 static struct usb_serial_driver * const serial_drivers[] = {
843 module_usb_serial_driver(serial_drivers, id_table);
845 MODULE_LICENSE("GPL v2");