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 /*******************************/
52 /* baudrate calculation factor */
53 /*******************************/
54 #define CH341_BAUDBASE_FACTOR 1532620800
55 #define CH341_BAUDBASE_DIVMAX 3
57 /* Break support - the information used to implement this was gleaned from
58 * the Net/FreeBSD uchcom.c driver by Takanori Watanabe. Domo arigato.
61 #define CH341_REQ_READ_VERSION 0x5F
62 #define CH341_REQ_WRITE_REG 0x9A
63 #define CH341_REQ_READ_REG 0x95
64 #define CH341_REQ_SERIAL_INIT 0xA1
65 #define CH341_REQ_MODEM_CTRL 0xA4
67 #define CH341_REG_BREAK 0x05
68 #define CH341_REG_LCR 0x18
69 #define CH341_NBREAK_BITS 0x01
71 #define CH341_LCR_ENABLE_RX 0x80
72 #define CH341_LCR_ENABLE_TX 0x40
73 #define CH341_LCR_MARK_SPACE 0x20
74 #define CH341_LCR_PAR_EVEN 0x10
75 #define CH341_LCR_ENABLE_PAR 0x08
76 #define CH341_LCR_STOP_BITS_2 0x04
77 #define CH341_LCR_CS8 0x03
78 #define CH341_LCR_CS7 0x02
79 #define CH341_LCR_CS6 0x01
80 #define CH341_LCR_CS5 0x00
82 static const struct usb_device_id id_table
[] = {
83 { USB_DEVICE(0x4348, 0x5523) },
84 { USB_DEVICE(0x1a86, 0x7523) },
85 { USB_DEVICE(0x1a86, 0x5523) },
88 MODULE_DEVICE_TABLE(usb
, id_table
);
90 struct ch341_private
{
91 spinlock_t lock
; /* access lock */
92 unsigned baud_rate
; /* set baud rate */
98 static void ch341_set_termios(struct tty_struct
*tty
,
99 struct usb_serial_port
*port
,
100 struct ktermios
*old_termios
);
102 static int ch341_control_out(struct usb_device
*dev
, u8 request
,
103 u16 value
, u16 index
)
107 dev_dbg(&dev
->dev
, "%s - (%02x,%04x,%04x)\n", __func__
,
108 request
, value
, index
);
110 r
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0), request
,
111 USB_TYPE_VENDOR
| USB_RECIP_DEVICE
| USB_DIR_OUT
,
112 value
, index
, NULL
, 0, DEFAULT_TIMEOUT
);
114 dev_err(&dev
->dev
, "failed to send control message: %d\n", r
);
119 static int ch341_control_in(struct usb_device
*dev
,
120 u8 request
, u16 value
, u16 index
,
121 char *buf
, unsigned bufsize
)
125 dev_dbg(&dev
->dev
, "%s - (%02x,%04x,%04x,%u)\n", __func__
,
126 request
, value
, index
, bufsize
);
128 r
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0), request
,
129 USB_TYPE_VENDOR
| USB_RECIP_DEVICE
| USB_DIR_IN
,
130 value
, index
, buf
, bufsize
, DEFAULT_TIMEOUT
);
134 "short control message received (%d < %u)\n",
139 dev_err(&dev
->dev
, "failed to receive control message: %d\n",
147 static int ch341_set_baudrate_lcr(struct usb_device
*dev
,
148 struct ch341_private
*priv
, u8 lcr
)
152 unsigned long factor
;
155 if (!priv
->baud_rate
)
157 factor
= (CH341_BAUDBASE_FACTOR
/ priv
->baud_rate
);
158 divisor
= CH341_BAUDBASE_DIVMAX
;
160 while ((factor
> 0xfff0) && divisor
) {
168 factor
= 0x10000 - factor
;
169 a
= (factor
& 0xff00) | divisor
;
172 * CH341A buffers data until a full endpoint-size packet (32 bytes)
173 * has been received unless bit 7 is set.
177 r
= ch341_control_out(dev
, CH341_REQ_WRITE_REG
, 0x1312, a
);
181 r
= ch341_control_out(dev
, CH341_REQ_WRITE_REG
, 0x2518, lcr
);
188 static int ch341_set_handshake(struct usb_device
*dev
, u8 control
)
190 return ch341_control_out(dev
, CH341_REQ_MODEM_CTRL
, ~control
, 0);
193 static int ch341_get_status(struct usb_device
*dev
, struct ch341_private
*priv
)
195 const unsigned int size
= 2;
200 buffer
= kmalloc(size
, GFP_KERNEL
);
204 r
= ch341_control_in(dev
, CH341_REQ_READ_REG
, 0x0706, 0, buffer
, size
);
208 spin_lock_irqsave(&priv
->lock
, flags
);
209 priv
->msr
= (~(*buffer
)) & CH341_BITS_MODEM_STAT
;
210 spin_unlock_irqrestore(&priv
->lock
, flags
);
216 /* -------------------------------------------------------------------------- */
218 static int ch341_configure(struct usb_device
*dev
, struct ch341_private
*priv
)
220 const unsigned int size
= 2;
224 buffer
= kmalloc(size
, GFP_KERNEL
);
228 /* expect two bytes 0x27 0x00 */
229 r
= ch341_control_in(dev
, CH341_REQ_READ_VERSION
, 0, 0, buffer
, size
);
232 dev_dbg(&dev
->dev
, "Chip version: 0x%02x\n", buffer
[0]);
234 r
= ch341_control_out(dev
, CH341_REQ_SERIAL_INIT
, 0, 0);
238 r
= ch341_set_baudrate_lcr(dev
, priv
, priv
->lcr
);
242 r
= ch341_set_handshake(dev
, priv
->mcr
);
248 static int ch341_port_probe(struct usb_serial_port
*port
)
250 struct ch341_private
*priv
;
253 priv
= kzalloc(sizeof(struct ch341_private
), GFP_KERNEL
);
257 spin_lock_init(&priv
->lock
);
258 priv
->baud_rate
= DEFAULT_BAUD_RATE
;
260 * Some CH340 devices appear unable to change the initial LCR
261 * settings, so set a sane 8N1 default.
263 priv
->lcr
= CH341_LCR_ENABLE_RX
| CH341_LCR_ENABLE_TX
| CH341_LCR_CS8
;
265 r
= ch341_configure(port
->serial
->dev
, priv
);
269 usb_set_serial_port_data(port
, priv
);
276 static int ch341_port_remove(struct usb_serial_port
*port
)
278 struct ch341_private
*priv
;
280 priv
= usb_get_serial_port_data(port
);
286 static int ch341_carrier_raised(struct usb_serial_port
*port
)
288 struct ch341_private
*priv
= usb_get_serial_port_data(port
);
289 if (priv
->msr
& CH341_BIT_DCD
)
294 static void ch341_dtr_rts(struct usb_serial_port
*port
, int on
)
296 struct ch341_private
*priv
= usb_get_serial_port_data(port
);
299 /* drop DTR and RTS */
300 spin_lock_irqsave(&priv
->lock
, flags
);
302 priv
->mcr
|= CH341_BIT_RTS
| CH341_BIT_DTR
;
304 priv
->mcr
&= ~(CH341_BIT_RTS
| CH341_BIT_DTR
);
305 spin_unlock_irqrestore(&priv
->lock
, flags
);
306 ch341_set_handshake(port
->serial
->dev
, priv
->mcr
);
309 static void ch341_close(struct usb_serial_port
*port
)
311 usb_serial_generic_close(port
);
312 usb_kill_urb(port
->interrupt_in_urb
);
316 /* open this device, set default parameters */
317 static int ch341_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
319 struct ch341_private
*priv
= usb_get_serial_port_data(port
);
323 ch341_set_termios(tty
, port
, NULL
);
325 dev_dbg(&port
->dev
, "%s - submitting interrupt urb\n", __func__
);
326 r
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
328 dev_err(&port
->dev
, "%s - failed to submit interrupt urb: %d\n",
333 r
= ch341_get_status(port
->serial
->dev
, priv
);
335 dev_err(&port
->dev
, "failed to read modem status: %d\n", r
);
336 goto err_kill_interrupt_urb
;
339 r
= usb_serial_generic_open(tty
, port
);
341 goto err_kill_interrupt_urb
;
345 err_kill_interrupt_urb
:
346 usb_kill_urb(port
->interrupt_in_urb
);
351 /* Old_termios contains the original termios settings and
352 * tty->termios contains the new setting to be used.
354 static void ch341_set_termios(struct tty_struct
*tty
,
355 struct usb_serial_port
*port
, struct ktermios
*old_termios
)
357 struct ch341_private
*priv
= usb_get_serial_port_data(port
);
363 /* redundant changes may cause the chip to lose bytes */
364 if (old_termios
&& !tty_termios_hw_change(&tty
->termios
, old_termios
))
367 baud_rate
= tty_get_baud_rate(tty
);
369 lcr
= CH341_LCR_ENABLE_RX
| CH341_LCR_ENABLE_TX
;
371 switch (C_CSIZE(tty
)) {
373 lcr
|= CH341_LCR_CS5
;
376 lcr
|= CH341_LCR_CS6
;
379 lcr
|= CH341_LCR_CS7
;
382 lcr
|= CH341_LCR_CS8
;
387 lcr
|= CH341_LCR_ENABLE_PAR
;
388 if (C_PARODD(tty
) == 0)
389 lcr
|= CH341_LCR_PAR_EVEN
;
391 lcr
|= CH341_LCR_MARK_SPACE
;
395 lcr
|= CH341_LCR_STOP_BITS_2
;
398 priv
->baud_rate
= baud_rate
;
400 r
= ch341_set_baudrate_lcr(port
->serial
->dev
, priv
, lcr
);
401 if (r
< 0 && old_termios
) {
402 priv
->baud_rate
= tty_termios_baud_rate(old_termios
);
403 tty_termios_copy_hw(&tty
->termios
, old_termios
);
409 spin_lock_irqsave(&priv
->lock
, flags
);
410 if (C_BAUD(tty
) == B0
)
411 priv
->mcr
&= ~(CH341_BIT_DTR
| CH341_BIT_RTS
);
412 else if (old_termios
&& (old_termios
->c_cflag
& CBAUD
) == B0
)
413 priv
->mcr
|= (CH341_BIT_DTR
| CH341_BIT_RTS
);
414 spin_unlock_irqrestore(&priv
->lock
, flags
);
416 ch341_set_handshake(port
->serial
->dev
, priv
->mcr
);
419 static void ch341_break_ctl(struct tty_struct
*tty
, int break_state
)
421 const uint16_t ch341_break_reg
=
422 ((uint16_t) CH341_REG_LCR
<< 8) | CH341_REG_BREAK
;
423 struct usb_serial_port
*port
= tty
->driver_data
;
425 uint16_t reg_contents
;
428 break_reg
= kmalloc(2, GFP_KERNEL
);
432 r
= ch341_control_in(port
->serial
->dev
, CH341_REQ_READ_REG
,
433 ch341_break_reg
, 0, break_reg
, 2);
435 dev_err(&port
->dev
, "%s - USB control read error (%d)\n",
439 dev_dbg(&port
->dev
, "%s - initial ch341 break register contents - reg1: %x, reg2: %x\n",
440 __func__
, break_reg
[0], break_reg
[1]);
441 if (break_state
!= 0) {
442 dev_dbg(&port
->dev
, "%s - Enter break state requested\n", __func__
);
443 break_reg
[0] &= ~CH341_NBREAK_BITS
;
444 break_reg
[1] &= ~CH341_LCR_ENABLE_TX
;
446 dev_dbg(&port
->dev
, "%s - Leave break state requested\n", __func__
);
447 break_reg
[0] |= CH341_NBREAK_BITS
;
448 break_reg
[1] |= CH341_LCR_ENABLE_TX
;
450 dev_dbg(&port
->dev
, "%s - New ch341 break register contents - reg1: %x, reg2: %x\n",
451 __func__
, break_reg
[0], break_reg
[1]);
452 reg_contents
= get_unaligned_le16(break_reg
);
453 r
= ch341_control_out(port
->serial
->dev
, CH341_REQ_WRITE_REG
,
454 ch341_break_reg
, reg_contents
);
456 dev_err(&port
->dev
, "%s - USB control write error (%d)\n",
462 static int ch341_tiocmset(struct tty_struct
*tty
,
463 unsigned int set
, unsigned int clear
)
465 struct usb_serial_port
*port
= tty
->driver_data
;
466 struct ch341_private
*priv
= usb_get_serial_port_data(port
);
470 spin_lock_irqsave(&priv
->lock
, flags
);
472 priv
->mcr
|= CH341_BIT_RTS
;
474 priv
->mcr
|= CH341_BIT_DTR
;
475 if (clear
& TIOCM_RTS
)
476 priv
->mcr
&= ~CH341_BIT_RTS
;
477 if (clear
& TIOCM_DTR
)
478 priv
->mcr
&= ~CH341_BIT_DTR
;
480 spin_unlock_irqrestore(&priv
->lock
, flags
);
482 return ch341_set_handshake(port
->serial
->dev
, control
);
485 static void ch341_update_status(struct usb_serial_port
*port
,
486 unsigned char *data
, size_t len
)
488 struct ch341_private
*priv
= usb_get_serial_port_data(port
);
489 struct tty_struct
*tty
;
497 status
= ~data
[2] & CH341_BITS_MODEM_STAT
;
499 spin_lock_irqsave(&priv
->lock
, flags
);
500 delta
= status
^ priv
->msr
;
502 spin_unlock_irqrestore(&priv
->lock
, flags
);
504 if (data
[1] & CH341_MULT_STAT
)
505 dev_dbg(&port
->dev
, "%s - multiple status change\n", __func__
);
510 if (delta
& CH341_BIT_CTS
)
512 if (delta
& CH341_BIT_DSR
)
514 if (delta
& CH341_BIT_RI
)
516 if (delta
& CH341_BIT_DCD
) {
518 tty
= tty_port_tty_get(&port
->port
);
520 usb_serial_handle_dcd_change(port
, tty
,
521 status
& CH341_BIT_DCD
);
526 wake_up_interruptible(&port
->port
.delta_msr_wait
);
529 static void ch341_read_int_callback(struct urb
*urb
)
531 struct usb_serial_port
*port
= urb
->context
;
532 unsigned char *data
= urb
->transfer_buffer
;
533 unsigned int len
= urb
->actual_length
;
536 switch (urb
->status
) {
543 /* this urb is terminated, clean up */
544 dev_dbg(&urb
->dev
->dev
, "%s - urb shutting down: %d\n",
545 __func__
, urb
->status
);
548 dev_dbg(&urb
->dev
->dev
, "%s - nonzero urb status: %d\n",
549 __func__
, urb
->status
);
553 usb_serial_debug_data(&port
->dev
, __func__
, len
, data
);
554 ch341_update_status(port
, data
, len
);
556 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
558 dev_err(&urb
->dev
->dev
, "%s - usb_submit_urb failed: %d\n",
563 static int ch341_tiocmget(struct tty_struct
*tty
)
565 struct usb_serial_port
*port
= tty
->driver_data
;
566 struct ch341_private
*priv
= usb_get_serial_port_data(port
);
572 spin_lock_irqsave(&priv
->lock
, flags
);
575 spin_unlock_irqrestore(&priv
->lock
, flags
);
577 result
= ((mcr
& CH341_BIT_DTR
) ? TIOCM_DTR
: 0)
578 | ((mcr
& CH341_BIT_RTS
) ? TIOCM_RTS
: 0)
579 | ((status
& CH341_BIT_CTS
) ? TIOCM_CTS
: 0)
580 | ((status
& CH341_BIT_DSR
) ? TIOCM_DSR
: 0)
581 | ((status
& CH341_BIT_RI
) ? TIOCM_RI
: 0)
582 | ((status
& CH341_BIT_DCD
) ? TIOCM_CD
: 0);
584 dev_dbg(&port
->dev
, "%s - result = %x\n", __func__
, result
);
589 static int ch341_reset_resume(struct usb_serial
*serial
)
591 struct usb_serial_port
*port
= serial
->port
[0];
592 struct ch341_private
*priv
= usb_get_serial_port_data(port
);
595 /* reconfigure ch341 serial port after bus-reset */
596 ch341_configure(serial
->dev
, priv
);
598 if (tty_port_initialized(&port
->port
)) {
599 ret
= usb_submit_urb(port
->interrupt_in_urb
, GFP_NOIO
);
601 dev_err(&port
->dev
, "failed to submit interrupt urb: %d\n",
606 ret
= ch341_get_status(port
->serial
->dev
, priv
);
608 dev_err(&port
->dev
, "failed to read modem status: %d\n",
613 return usb_serial_generic_resume(serial
);
616 static struct usb_serial_driver ch341_device
= {
618 .owner
= THIS_MODULE
,
619 .name
= "ch341-uart",
621 .id_table
= id_table
,
624 .dtr_rts
= ch341_dtr_rts
,
625 .carrier_raised
= ch341_carrier_raised
,
626 .close
= ch341_close
,
627 .set_termios
= ch341_set_termios
,
628 .break_ctl
= ch341_break_ctl
,
629 .tiocmget
= ch341_tiocmget
,
630 .tiocmset
= ch341_tiocmset
,
631 .tiocmiwait
= usb_serial_generic_tiocmiwait
,
632 .read_int_callback
= ch341_read_int_callback
,
633 .port_probe
= ch341_port_probe
,
634 .port_remove
= ch341_port_remove
,
635 .reset_resume
= ch341_reset_resume
,
638 static struct usb_serial_driver
* const serial_drivers
[] = {
642 module_usb_serial_driver(serial_drivers
, id_table
);
644 MODULE_LICENSE("GPL v2");