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_LCR 0x18
63 #define CH341_NBREAK_BITS 0x01
65 #define CH341_LCR_ENABLE_RX 0x80
66 #define CH341_LCR_ENABLE_TX 0x40
67 #define CH341_LCR_MARK_SPACE 0x20
68 #define CH341_LCR_PAR_EVEN 0x10
69 #define CH341_LCR_ENABLE_PAR 0x08
70 #define CH341_LCR_STOP_BITS_2 0x04
71 #define CH341_LCR_CS8 0x03
72 #define CH341_LCR_CS7 0x02
73 #define CH341_LCR_CS6 0x01
74 #define CH341_LCR_CS5 0x00
76 #define CH341_QUIRK_LIMITED_PRESCALER BIT(0)
78 static const struct usb_device_id id_table
[] = {
79 { USB_DEVICE(0x4348, 0x5523) },
80 { USB_DEVICE(0x1a86, 0x7523) },
81 { USB_DEVICE(0x1a86, 0x5523) },
84 MODULE_DEVICE_TABLE(usb
, id_table
);
86 struct ch341_private
{
87 spinlock_t lock
; /* access lock */
88 unsigned baud_rate
; /* set baud rate */
95 static void ch341_set_termios(struct tty_struct
*tty
,
96 struct usb_serial_port
*port
,
97 struct ktermios
*old_termios
);
99 static int ch341_control_out(struct usb_device
*dev
, u8 request
,
100 u16 value
, u16 index
)
104 dev_dbg(&dev
->dev
, "%s - (%02x,%04x,%04x)\n", __func__
,
105 request
, value
, index
);
107 r
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0), request
,
108 USB_TYPE_VENDOR
| USB_RECIP_DEVICE
| USB_DIR_OUT
,
109 value
, index
, NULL
, 0, DEFAULT_TIMEOUT
);
111 dev_err(&dev
->dev
, "failed to send control message: %d\n", r
);
116 static int ch341_control_in(struct usb_device
*dev
,
117 u8 request
, u16 value
, u16 index
,
118 char *buf
, unsigned bufsize
)
122 dev_dbg(&dev
->dev
, "%s - (%02x,%04x,%04x,%u)\n", __func__
,
123 request
, value
, index
, bufsize
);
125 r
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0), request
,
126 USB_TYPE_VENDOR
| USB_RECIP_DEVICE
| USB_DIR_IN
,
127 value
, index
, buf
, bufsize
, DEFAULT_TIMEOUT
);
128 if (r
< (int)bufsize
) {
131 "short control message received (%d < %u)\n",
136 dev_err(&dev
->dev
, "failed to receive control message: %d\n",
144 #define CH341_CLKRATE 48000000
145 #define CH341_CLK_DIV(ps, fact) (1 << (12 - 3 * (ps) - (fact)))
146 #define CH341_MIN_RATE(ps) (CH341_CLKRATE / (CH341_CLK_DIV((ps), 1) * 512))
148 static const speed_t ch341_min_rates
[] = {
156 * The device line speed is given by the following equation:
158 * baudrate = 48000000 / (2^(12 - 3 * ps - fact) * div), where
162 * 2 <= div <= 256 if fact = 0, or
163 * 9 <= div <= 256 if fact = 1
165 static int ch341_get_divisor(struct ch341_private
*priv
)
167 unsigned int fact
, div
, clk_div
;
168 speed_t speed
= priv
->baud_rate
;
169 bool force_fact0
= false;
173 * Clamp to supported range, this makes the (ps < 0) and (div < 2)
174 * sanity checks below redundant.
176 speed
= clamp(speed
, 46U, 3000000U);
179 * Start with highest possible base clock (fact = 1) that will give a
180 * divisor strictly less than 512.
183 for (ps
= 3; ps
>= 0; ps
--) {
184 if (speed
> ch341_min_rates
[ps
])
191 /* Determine corresponding divisor, rounding down. */
192 clk_div
= CH341_CLK_DIV(ps
, fact
);
193 div
= CH341_CLKRATE
/ (clk_div
* speed
);
195 /* Some devices require a lower base clock if ps < 3. */
196 if (ps
< 3 && (priv
->quirks
& CH341_QUIRK_LIMITED_PRESCALER
))
199 /* Halve base clock (fact = 0) if required. */
200 if (div
< 9 || div
> 255 || force_fact0
) {
210 * Pick next divisor if resulting rate is closer to the requested one,
211 * scale up to avoid rounding errors on low rates.
213 if (16 * CH341_CLKRATE
/ (clk_div
* div
) - 16 * speed
>=
214 16 * speed
- 16 * CH341_CLKRATE
/ (clk_div
* (div
+ 1)))
218 * Prefer lower base clock (fact = 0) if even divisor.
220 * Note that this makes the receiver more tolerant to errors.
222 if (fact
== 1 && div
% 2 == 0) {
227 return (0x100 - div
) << 8 | fact
<< 2 | ps
;
230 static int ch341_set_baudrate_lcr(struct usb_device
*dev
,
231 struct ch341_private
*priv
, u8 lcr
)
236 if (!priv
->baud_rate
)
239 val
= ch341_get_divisor(priv
);
244 * CH341A buffers data until a full endpoint-size packet (32 bytes)
245 * has been received unless bit 7 is set.
249 r
= ch341_control_out(dev
, CH341_REQ_WRITE_REG
, 0x1312, val
);
253 r
= ch341_control_out(dev
, CH341_REQ_WRITE_REG
, 0x2518, lcr
);
260 static int ch341_set_handshake(struct usb_device
*dev
, u8 control
)
262 return ch341_control_out(dev
, CH341_REQ_MODEM_CTRL
, ~control
, 0);
265 static int ch341_get_status(struct usb_device
*dev
, struct ch341_private
*priv
)
267 const unsigned int size
= 2;
272 buffer
= kmalloc(size
, GFP_KERNEL
);
276 r
= ch341_control_in(dev
, CH341_REQ_READ_REG
, 0x0706, 0, buffer
, size
);
280 spin_lock_irqsave(&priv
->lock
, flags
);
281 priv
->msr
= (~(*buffer
)) & CH341_BITS_MODEM_STAT
;
282 spin_unlock_irqrestore(&priv
->lock
, flags
);
288 /* -------------------------------------------------------------------------- */
290 static int ch341_configure(struct usb_device
*dev
, struct ch341_private
*priv
)
292 const unsigned int size
= 2;
296 buffer
= kmalloc(size
, GFP_KERNEL
);
300 /* expect two bytes 0x27 0x00 */
301 r
= ch341_control_in(dev
, CH341_REQ_READ_VERSION
, 0, 0, buffer
, size
);
304 dev_dbg(&dev
->dev
, "Chip version: 0x%02x\n", buffer
[0]);
306 r
= ch341_control_out(dev
, CH341_REQ_SERIAL_INIT
, 0, 0);
310 r
= ch341_set_baudrate_lcr(dev
, priv
, priv
->lcr
);
314 r
= ch341_set_handshake(dev
, priv
->mcr
);
320 static int ch341_detect_quirks(struct usb_serial_port
*port
)
322 struct ch341_private
*priv
= usb_get_serial_port_data(port
);
323 struct usb_device
*udev
= port
->serial
->dev
;
324 const unsigned int size
= 2;
325 unsigned long quirks
= 0;
329 buffer
= kmalloc(size
, GFP_KERNEL
);
334 * A subset of CH34x devices does not support all features. The
335 * prescaler is limited and there is no support for sending a RS232
336 * break condition. A read failure when trying to set up the latter is
337 * used to detect these devices.
339 r
= usb_control_msg(udev
, usb_rcvctrlpipe(udev
, 0), CH341_REQ_READ_REG
,
340 USB_TYPE_VENDOR
| USB_RECIP_DEVICE
| USB_DIR_IN
,
341 CH341_REG_BREAK
, 0, buffer
, size
, DEFAULT_TIMEOUT
);
343 dev_dbg(&port
->dev
, "break control not supported\n");
344 quirks
= CH341_QUIRK_LIMITED_PRESCALER
;
352 dev_err(&port
->dev
, "failed to read break control: %d\n", r
);
361 dev_dbg(&port
->dev
, "enabling quirk flags: 0x%02lx\n", quirks
);
362 priv
->quirks
|= quirks
;
368 static int ch341_port_probe(struct usb_serial_port
*port
)
370 struct ch341_private
*priv
;
373 priv
= kzalloc(sizeof(struct ch341_private
), GFP_KERNEL
);
377 spin_lock_init(&priv
->lock
);
378 priv
->baud_rate
= DEFAULT_BAUD_RATE
;
380 * Some CH340 devices appear unable to change the initial LCR
381 * settings, so set a sane 8N1 default.
383 priv
->lcr
= CH341_LCR_ENABLE_RX
| CH341_LCR_ENABLE_TX
| CH341_LCR_CS8
;
385 r
= ch341_configure(port
->serial
->dev
, priv
);
389 usb_set_serial_port_data(port
, priv
);
391 r
= ch341_detect_quirks(port
);
401 static int ch341_port_remove(struct usb_serial_port
*port
)
403 struct ch341_private
*priv
;
405 priv
= usb_get_serial_port_data(port
);
411 static int ch341_carrier_raised(struct usb_serial_port
*port
)
413 struct ch341_private
*priv
= usb_get_serial_port_data(port
);
414 if (priv
->msr
& CH341_BIT_DCD
)
419 static void ch341_dtr_rts(struct usb_serial_port
*port
, int on
)
421 struct ch341_private
*priv
= usb_get_serial_port_data(port
);
424 /* drop DTR and RTS */
425 spin_lock_irqsave(&priv
->lock
, flags
);
427 priv
->mcr
|= CH341_BIT_RTS
| CH341_BIT_DTR
;
429 priv
->mcr
&= ~(CH341_BIT_RTS
| CH341_BIT_DTR
);
430 spin_unlock_irqrestore(&priv
->lock
, flags
);
431 ch341_set_handshake(port
->serial
->dev
, priv
->mcr
);
434 static void ch341_close(struct usb_serial_port
*port
)
436 usb_serial_generic_close(port
);
437 usb_kill_urb(port
->interrupt_in_urb
);
441 /* open this device, set default parameters */
442 static int ch341_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
444 struct ch341_private
*priv
= usb_get_serial_port_data(port
);
448 ch341_set_termios(tty
, port
, NULL
);
450 dev_dbg(&port
->dev
, "%s - submitting interrupt urb\n", __func__
);
451 r
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
453 dev_err(&port
->dev
, "%s - failed to submit interrupt urb: %d\n",
458 r
= ch341_get_status(port
->serial
->dev
, priv
);
460 dev_err(&port
->dev
, "failed to read modem status: %d\n", r
);
461 goto err_kill_interrupt_urb
;
464 r
= usb_serial_generic_open(tty
, port
);
466 goto err_kill_interrupt_urb
;
470 err_kill_interrupt_urb
:
471 usb_kill_urb(port
->interrupt_in_urb
);
476 /* Old_termios contains the original termios settings and
477 * tty->termios contains the new setting to be used.
479 static void ch341_set_termios(struct tty_struct
*tty
,
480 struct usb_serial_port
*port
, struct ktermios
*old_termios
)
482 struct ch341_private
*priv
= usb_get_serial_port_data(port
);
488 /* redundant changes may cause the chip to lose bytes */
489 if (old_termios
&& !tty_termios_hw_change(&tty
->termios
, old_termios
))
492 baud_rate
= tty_get_baud_rate(tty
);
494 lcr
= CH341_LCR_ENABLE_RX
| CH341_LCR_ENABLE_TX
;
496 switch (C_CSIZE(tty
)) {
498 lcr
|= CH341_LCR_CS5
;
501 lcr
|= CH341_LCR_CS6
;
504 lcr
|= CH341_LCR_CS7
;
507 lcr
|= CH341_LCR_CS8
;
512 lcr
|= CH341_LCR_ENABLE_PAR
;
513 if (C_PARODD(tty
) == 0)
514 lcr
|= CH341_LCR_PAR_EVEN
;
516 lcr
|= CH341_LCR_MARK_SPACE
;
520 lcr
|= CH341_LCR_STOP_BITS_2
;
523 priv
->baud_rate
= baud_rate
;
525 r
= ch341_set_baudrate_lcr(port
->serial
->dev
, priv
, lcr
);
526 if (r
< 0 && old_termios
) {
527 priv
->baud_rate
= tty_termios_baud_rate(old_termios
);
528 tty_termios_copy_hw(&tty
->termios
, old_termios
);
534 spin_lock_irqsave(&priv
->lock
, flags
);
535 if (C_BAUD(tty
) == B0
)
536 priv
->mcr
&= ~(CH341_BIT_DTR
| CH341_BIT_RTS
);
537 else if (old_termios
&& (old_termios
->c_cflag
& CBAUD
) == B0
)
538 priv
->mcr
|= (CH341_BIT_DTR
| CH341_BIT_RTS
);
539 spin_unlock_irqrestore(&priv
->lock
, flags
);
541 ch341_set_handshake(port
->serial
->dev
, priv
->mcr
);
544 static void ch341_break_ctl(struct tty_struct
*tty
, int break_state
)
546 const uint16_t ch341_break_reg
=
547 ((uint16_t) CH341_REG_LCR
<< 8) | CH341_REG_BREAK
;
548 struct usb_serial_port
*port
= tty
->driver_data
;
550 uint16_t reg_contents
;
553 break_reg
= kmalloc(2, GFP_KERNEL
);
557 r
= ch341_control_in(port
->serial
->dev
, CH341_REQ_READ_REG
,
558 ch341_break_reg
, 0, break_reg
, 2);
560 dev_err(&port
->dev
, "%s - USB control read error (%d)\n",
564 dev_dbg(&port
->dev
, "%s - initial ch341 break register contents - reg1: %x, reg2: %x\n",
565 __func__
, break_reg
[0], break_reg
[1]);
566 if (break_state
!= 0) {
567 dev_dbg(&port
->dev
, "%s - Enter break state requested\n", __func__
);
568 break_reg
[0] &= ~CH341_NBREAK_BITS
;
569 break_reg
[1] &= ~CH341_LCR_ENABLE_TX
;
571 dev_dbg(&port
->dev
, "%s - Leave break state requested\n", __func__
);
572 break_reg
[0] |= CH341_NBREAK_BITS
;
573 break_reg
[1] |= CH341_LCR_ENABLE_TX
;
575 dev_dbg(&port
->dev
, "%s - New ch341 break register contents - reg1: %x, reg2: %x\n",
576 __func__
, break_reg
[0], break_reg
[1]);
577 reg_contents
= get_unaligned_le16(break_reg
);
578 r
= ch341_control_out(port
->serial
->dev
, CH341_REQ_WRITE_REG
,
579 ch341_break_reg
, reg_contents
);
581 dev_err(&port
->dev
, "%s - USB control write error (%d)\n",
587 static int ch341_tiocmset(struct tty_struct
*tty
,
588 unsigned int set
, unsigned int clear
)
590 struct usb_serial_port
*port
= tty
->driver_data
;
591 struct ch341_private
*priv
= usb_get_serial_port_data(port
);
595 spin_lock_irqsave(&priv
->lock
, flags
);
597 priv
->mcr
|= CH341_BIT_RTS
;
599 priv
->mcr
|= CH341_BIT_DTR
;
600 if (clear
& TIOCM_RTS
)
601 priv
->mcr
&= ~CH341_BIT_RTS
;
602 if (clear
& TIOCM_DTR
)
603 priv
->mcr
&= ~CH341_BIT_DTR
;
605 spin_unlock_irqrestore(&priv
->lock
, flags
);
607 return ch341_set_handshake(port
->serial
->dev
, control
);
610 static void ch341_update_status(struct usb_serial_port
*port
,
611 unsigned char *data
, size_t len
)
613 struct ch341_private
*priv
= usb_get_serial_port_data(port
);
614 struct tty_struct
*tty
;
622 status
= ~data
[2] & CH341_BITS_MODEM_STAT
;
624 spin_lock_irqsave(&priv
->lock
, flags
);
625 delta
= status
^ priv
->msr
;
627 spin_unlock_irqrestore(&priv
->lock
, flags
);
629 if (data
[1] & CH341_MULT_STAT
)
630 dev_dbg(&port
->dev
, "%s - multiple status change\n", __func__
);
635 if (delta
& CH341_BIT_CTS
)
637 if (delta
& CH341_BIT_DSR
)
639 if (delta
& CH341_BIT_RI
)
641 if (delta
& CH341_BIT_DCD
) {
643 tty
= tty_port_tty_get(&port
->port
);
645 usb_serial_handle_dcd_change(port
, tty
,
646 status
& CH341_BIT_DCD
);
651 wake_up_interruptible(&port
->port
.delta_msr_wait
);
654 static void ch341_read_int_callback(struct urb
*urb
)
656 struct usb_serial_port
*port
= urb
->context
;
657 unsigned char *data
= urb
->transfer_buffer
;
658 unsigned int len
= urb
->actual_length
;
661 switch (urb
->status
) {
668 /* this urb is terminated, clean up */
669 dev_dbg(&urb
->dev
->dev
, "%s - urb shutting down: %d\n",
670 __func__
, urb
->status
);
673 dev_dbg(&urb
->dev
->dev
, "%s - nonzero urb status: %d\n",
674 __func__
, urb
->status
);
678 usb_serial_debug_data(&port
->dev
, __func__
, len
, data
);
679 ch341_update_status(port
, data
, len
);
681 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
683 dev_err(&urb
->dev
->dev
, "%s - usb_submit_urb failed: %d\n",
688 static int ch341_tiocmget(struct tty_struct
*tty
)
690 struct usb_serial_port
*port
= tty
->driver_data
;
691 struct ch341_private
*priv
= usb_get_serial_port_data(port
);
697 spin_lock_irqsave(&priv
->lock
, flags
);
700 spin_unlock_irqrestore(&priv
->lock
, flags
);
702 result
= ((mcr
& CH341_BIT_DTR
) ? TIOCM_DTR
: 0)
703 | ((mcr
& CH341_BIT_RTS
) ? TIOCM_RTS
: 0)
704 | ((status
& CH341_BIT_CTS
) ? TIOCM_CTS
: 0)
705 | ((status
& CH341_BIT_DSR
) ? TIOCM_DSR
: 0)
706 | ((status
& CH341_BIT_RI
) ? TIOCM_RI
: 0)
707 | ((status
& CH341_BIT_DCD
) ? TIOCM_CD
: 0);
709 dev_dbg(&port
->dev
, "%s - result = %x\n", __func__
, result
);
714 static int ch341_reset_resume(struct usb_serial
*serial
)
716 struct usb_serial_port
*port
= serial
->port
[0];
717 struct ch341_private
*priv
;
720 priv
= usb_get_serial_port_data(port
);
724 /* reconfigure ch341 serial port after bus-reset */
725 ch341_configure(serial
->dev
, priv
);
727 if (tty_port_initialized(&port
->port
)) {
728 ret
= usb_submit_urb(port
->interrupt_in_urb
, GFP_NOIO
);
730 dev_err(&port
->dev
, "failed to submit interrupt urb: %d\n",
735 ret
= ch341_get_status(port
->serial
->dev
, priv
);
737 dev_err(&port
->dev
, "failed to read modem status: %d\n",
742 return usb_serial_generic_resume(serial
);
745 static struct usb_serial_driver ch341_device
= {
747 .owner
= THIS_MODULE
,
748 .name
= "ch341-uart",
750 .id_table
= id_table
,
753 .dtr_rts
= ch341_dtr_rts
,
754 .carrier_raised
= ch341_carrier_raised
,
755 .close
= ch341_close
,
756 .set_termios
= ch341_set_termios
,
757 .break_ctl
= ch341_break_ctl
,
758 .tiocmget
= ch341_tiocmget
,
759 .tiocmset
= ch341_tiocmset
,
760 .tiocmiwait
= usb_serial_generic_tiocmiwait
,
761 .read_int_callback
= ch341_read_int_callback
,
762 .port_probe
= ch341_port_probe
,
763 .port_remove
= ch341_port_remove
,
764 .reset_resume
= ch341_reset_resume
,
767 static struct usb_serial_driver
* const serial_drivers
[] = {
771 module_usb_serial_driver(serial_drivers
, id_table
);
773 MODULE_LICENSE("GPL v2");