treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / drivers / usb / serial / ch341.c
blobd3f420f3a083570d4d3372514c39430caa9fc8d8
1 // SPDX-License-Identifier: GPL-2.0
2 /*
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
44 from irq */
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 static const struct usb_device_id id_table[] = {
77 { USB_DEVICE(0x4348, 0x5523) },
78 { USB_DEVICE(0x1a86, 0x7523) },
79 { USB_DEVICE(0x1a86, 0x5523) },
80 { },
82 MODULE_DEVICE_TABLE(usb, id_table);
84 struct ch341_private {
85 spinlock_t lock; /* access lock */
86 unsigned baud_rate; /* set baud rate */
87 u8 mcr;
88 u8 msr;
89 u8 lcr;
92 static void ch341_set_termios(struct tty_struct *tty,
93 struct usb_serial_port *port,
94 struct ktermios *old_termios);
96 static int ch341_control_out(struct usb_device *dev, u8 request,
97 u16 value, u16 index)
99 int r;
101 dev_dbg(&dev->dev, "%s - (%02x,%04x,%04x)\n", __func__,
102 request, value, index);
104 r = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), request,
105 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
106 value, index, NULL, 0, DEFAULT_TIMEOUT);
107 if (r < 0)
108 dev_err(&dev->dev, "failed to send control message: %d\n", r);
110 return r;
113 static int ch341_control_in(struct usb_device *dev,
114 u8 request, u16 value, u16 index,
115 char *buf, unsigned bufsize)
117 int r;
119 dev_dbg(&dev->dev, "%s - (%02x,%04x,%04x,%u)\n", __func__,
120 request, value, index, bufsize);
122 r = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), request,
123 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
124 value, index, buf, bufsize, DEFAULT_TIMEOUT);
125 if (r < (int)bufsize) {
126 if (r >= 0) {
127 dev_err(&dev->dev,
128 "short control message received (%d < %u)\n",
129 r, bufsize);
130 r = -EIO;
133 dev_err(&dev->dev, "failed to receive control message: %d\n",
135 return r;
138 return 0;
141 #define CH341_CLKRATE 48000000
142 #define CH341_CLK_DIV(ps, fact) (1 << (12 - 3 * (ps) - (fact)))
143 #define CH341_MIN_RATE(ps) (CH341_CLKRATE / (CH341_CLK_DIV((ps), 1) * 512))
145 static const speed_t ch341_min_rates[] = {
146 CH341_MIN_RATE(0),
147 CH341_MIN_RATE(1),
148 CH341_MIN_RATE(2),
149 CH341_MIN_RATE(3),
153 * The device line speed is given by the following equation:
155 * baudrate = 48000000 / (2^(12 - 3 * ps - fact) * div), where
157 * 0 <= ps <= 3,
158 * 0 <= fact <= 1,
159 * 2 <= div <= 256 if fact = 0, or
160 * 9 <= div <= 256 if fact = 1
162 static int ch341_get_divisor(speed_t speed)
164 unsigned int fact, div, clk_div;
165 int ps;
168 * Clamp to supported range, this makes the (ps < 0) and (div < 2)
169 * sanity checks below redundant.
171 speed = clamp(speed, 46U, 3000000U);
174 * Start with highest possible base clock (fact = 1) that will give a
175 * divisor strictly less than 512.
177 fact = 1;
178 for (ps = 3; ps >= 0; ps--) {
179 if (speed > ch341_min_rates[ps])
180 break;
183 if (ps < 0)
184 return -EINVAL;
186 /* Determine corresponding divisor, rounding down. */
187 clk_div = CH341_CLK_DIV(ps, fact);
188 div = CH341_CLKRATE / (clk_div * speed);
190 /* Halve base clock (fact = 0) if required. */
191 if (div < 9 || div > 255) {
192 div /= 2;
193 clk_div *= 2;
194 fact = 0;
197 if (div < 2)
198 return -EINVAL;
201 * Pick next divisor if resulting rate is closer to the requested one,
202 * scale up to avoid rounding errors on low rates.
204 if (16 * CH341_CLKRATE / (clk_div * div) - 16 * speed >=
205 16 * speed - 16 * CH341_CLKRATE / (clk_div * (div + 1)))
206 div++;
208 return (0x100 - div) << 8 | fact << 2 | ps;
211 static int ch341_set_baudrate_lcr(struct usb_device *dev,
212 struct ch341_private *priv, u8 lcr)
214 int val;
215 int r;
217 if (!priv->baud_rate)
218 return -EINVAL;
220 val = ch341_get_divisor(priv->baud_rate);
221 if (val < 0)
222 return -EINVAL;
225 * CH341A buffers data until a full endpoint-size packet (32 bytes)
226 * has been received unless bit 7 is set.
228 val |= BIT(7);
230 r = ch341_control_out(dev, CH341_REQ_WRITE_REG, 0x1312, val);
231 if (r)
232 return r;
234 r = ch341_control_out(dev, CH341_REQ_WRITE_REG, 0x2518, lcr);
235 if (r)
236 return r;
238 return r;
241 static int ch341_set_handshake(struct usb_device *dev, u8 control)
243 return ch341_control_out(dev, CH341_REQ_MODEM_CTRL, ~control, 0);
246 static int ch341_get_status(struct usb_device *dev, struct ch341_private *priv)
248 const unsigned int size = 2;
249 char *buffer;
250 int r;
251 unsigned long flags;
253 buffer = kmalloc(size, GFP_KERNEL);
254 if (!buffer)
255 return -ENOMEM;
257 r = ch341_control_in(dev, CH341_REQ_READ_REG, 0x0706, 0, buffer, size);
258 if (r < 0)
259 goto out;
261 spin_lock_irqsave(&priv->lock, flags);
262 priv->msr = (~(*buffer)) & CH341_BITS_MODEM_STAT;
263 spin_unlock_irqrestore(&priv->lock, flags);
265 out: kfree(buffer);
266 return r;
269 /* -------------------------------------------------------------------------- */
271 static int ch341_configure(struct usb_device *dev, struct ch341_private *priv)
273 const unsigned int size = 2;
274 char *buffer;
275 int r;
277 buffer = kmalloc(size, GFP_KERNEL);
278 if (!buffer)
279 return -ENOMEM;
281 /* expect two bytes 0x27 0x00 */
282 r = ch341_control_in(dev, CH341_REQ_READ_VERSION, 0, 0, buffer, size);
283 if (r < 0)
284 goto out;
285 dev_dbg(&dev->dev, "Chip version: 0x%02x\n", buffer[0]);
287 r = ch341_control_out(dev, CH341_REQ_SERIAL_INIT, 0, 0);
288 if (r < 0)
289 goto out;
291 r = ch341_set_baudrate_lcr(dev, priv, priv->lcr);
292 if (r < 0)
293 goto out;
295 r = ch341_set_handshake(dev, priv->mcr);
297 out: kfree(buffer);
298 return r;
301 static int ch341_port_probe(struct usb_serial_port *port)
303 struct ch341_private *priv;
304 int r;
306 priv = kzalloc(sizeof(struct ch341_private), GFP_KERNEL);
307 if (!priv)
308 return -ENOMEM;
310 spin_lock_init(&priv->lock);
311 priv->baud_rate = DEFAULT_BAUD_RATE;
313 * Some CH340 devices appear unable to change the initial LCR
314 * settings, so set a sane 8N1 default.
316 priv->lcr = CH341_LCR_ENABLE_RX | CH341_LCR_ENABLE_TX | CH341_LCR_CS8;
318 r = ch341_configure(port->serial->dev, priv);
319 if (r < 0)
320 goto error;
322 usb_set_serial_port_data(port, priv);
323 return 0;
325 error: kfree(priv);
326 return r;
329 static int ch341_port_remove(struct usb_serial_port *port)
331 struct ch341_private *priv;
333 priv = usb_get_serial_port_data(port);
334 kfree(priv);
336 return 0;
339 static int ch341_carrier_raised(struct usb_serial_port *port)
341 struct ch341_private *priv = usb_get_serial_port_data(port);
342 if (priv->msr & CH341_BIT_DCD)
343 return 1;
344 return 0;
347 static void ch341_dtr_rts(struct usb_serial_port *port, int on)
349 struct ch341_private *priv = usb_get_serial_port_data(port);
350 unsigned long flags;
352 /* drop DTR and RTS */
353 spin_lock_irqsave(&priv->lock, flags);
354 if (on)
355 priv->mcr |= CH341_BIT_RTS | CH341_BIT_DTR;
356 else
357 priv->mcr &= ~(CH341_BIT_RTS | CH341_BIT_DTR);
358 spin_unlock_irqrestore(&priv->lock, flags);
359 ch341_set_handshake(port->serial->dev, priv->mcr);
362 static void ch341_close(struct usb_serial_port *port)
364 usb_serial_generic_close(port);
365 usb_kill_urb(port->interrupt_in_urb);
369 /* open this device, set default parameters */
370 static int ch341_open(struct tty_struct *tty, struct usb_serial_port *port)
372 struct ch341_private *priv = usb_get_serial_port_data(port);
373 int r;
375 if (tty)
376 ch341_set_termios(tty, port, NULL);
378 dev_dbg(&port->dev, "%s - submitting interrupt urb\n", __func__);
379 r = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
380 if (r) {
381 dev_err(&port->dev, "%s - failed to submit interrupt urb: %d\n",
382 __func__, r);
383 return r;
386 r = ch341_get_status(port->serial->dev, priv);
387 if (r < 0) {
388 dev_err(&port->dev, "failed to read modem status: %d\n", r);
389 goto err_kill_interrupt_urb;
392 r = usb_serial_generic_open(tty, port);
393 if (r)
394 goto err_kill_interrupt_urb;
396 return 0;
398 err_kill_interrupt_urb:
399 usb_kill_urb(port->interrupt_in_urb);
401 return r;
404 /* Old_termios contains the original termios settings and
405 * tty->termios contains the new setting to be used.
407 static void ch341_set_termios(struct tty_struct *tty,
408 struct usb_serial_port *port, struct ktermios *old_termios)
410 struct ch341_private *priv = usb_get_serial_port_data(port);
411 unsigned baud_rate;
412 unsigned long flags;
413 u8 lcr;
414 int r;
416 /* redundant changes may cause the chip to lose bytes */
417 if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios))
418 return;
420 baud_rate = tty_get_baud_rate(tty);
422 lcr = CH341_LCR_ENABLE_RX | CH341_LCR_ENABLE_TX;
424 switch (C_CSIZE(tty)) {
425 case CS5:
426 lcr |= CH341_LCR_CS5;
427 break;
428 case CS6:
429 lcr |= CH341_LCR_CS6;
430 break;
431 case CS7:
432 lcr |= CH341_LCR_CS7;
433 break;
434 case CS8:
435 lcr |= CH341_LCR_CS8;
436 break;
439 if (C_PARENB(tty)) {
440 lcr |= CH341_LCR_ENABLE_PAR;
441 if (C_PARODD(tty) == 0)
442 lcr |= CH341_LCR_PAR_EVEN;
443 if (C_CMSPAR(tty))
444 lcr |= CH341_LCR_MARK_SPACE;
447 if (C_CSTOPB(tty))
448 lcr |= CH341_LCR_STOP_BITS_2;
450 if (baud_rate) {
451 priv->baud_rate = baud_rate;
453 r = ch341_set_baudrate_lcr(port->serial->dev, priv, lcr);
454 if (r < 0 && old_termios) {
455 priv->baud_rate = tty_termios_baud_rate(old_termios);
456 tty_termios_copy_hw(&tty->termios, old_termios);
457 } else if (r == 0) {
458 priv->lcr = lcr;
462 spin_lock_irqsave(&priv->lock, flags);
463 if (C_BAUD(tty) == B0)
464 priv->mcr &= ~(CH341_BIT_DTR | CH341_BIT_RTS);
465 else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
466 priv->mcr |= (CH341_BIT_DTR | CH341_BIT_RTS);
467 spin_unlock_irqrestore(&priv->lock, flags);
469 ch341_set_handshake(port->serial->dev, priv->mcr);
472 static void ch341_break_ctl(struct tty_struct *tty, int break_state)
474 const uint16_t ch341_break_reg =
475 ((uint16_t) CH341_REG_LCR << 8) | CH341_REG_BREAK;
476 struct usb_serial_port *port = tty->driver_data;
477 int r;
478 uint16_t reg_contents;
479 uint8_t *break_reg;
481 break_reg = kmalloc(2, GFP_KERNEL);
482 if (!break_reg)
483 return;
485 r = ch341_control_in(port->serial->dev, CH341_REQ_READ_REG,
486 ch341_break_reg, 0, break_reg, 2);
487 if (r < 0) {
488 dev_err(&port->dev, "%s - USB control read error (%d)\n",
489 __func__, r);
490 goto out;
492 dev_dbg(&port->dev, "%s - initial ch341 break register contents - reg1: %x, reg2: %x\n",
493 __func__, break_reg[0], break_reg[1]);
494 if (break_state != 0) {
495 dev_dbg(&port->dev, "%s - Enter break state requested\n", __func__);
496 break_reg[0] &= ~CH341_NBREAK_BITS;
497 break_reg[1] &= ~CH341_LCR_ENABLE_TX;
498 } else {
499 dev_dbg(&port->dev, "%s - Leave break state requested\n", __func__);
500 break_reg[0] |= CH341_NBREAK_BITS;
501 break_reg[1] |= CH341_LCR_ENABLE_TX;
503 dev_dbg(&port->dev, "%s - New ch341 break register contents - reg1: %x, reg2: %x\n",
504 __func__, break_reg[0], break_reg[1]);
505 reg_contents = get_unaligned_le16(break_reg);
506 r = ch341_control_out(port->serial->dev, CH341_REQ_WRITE_REG,
507 ch341_break_reg, reg_contents);
508 if (r < 0)
509 dev_err(&port->dev, "%s - USB control write error (%d)\n",
510 __func__, r);
511 out:
512 kfree(break_reg);
515 static int ch341_tiocmset(struct tty_struct *tty,
516 unsigned int set, unsigned int clear)
518 struct usb_serial_port *port = tty->driver_data;
519 struct ch341_private *priv = usb_get_serial_port_data(port);
520 unsigned long flags;
521 u8 control;
523 spin_lock_irqsave(&priv->lock, flags);
524 if (set & TIOCM_RTS)
525 priv->mcr |= CH341_BIT_RTS;
526 if (set & TIOCM_DTR)
527 priv->mcr |= CH341_BIT_DTR;
528 if (clear & TIOCM_RTS)
529 priv->mcr &= ~CH341_BIT_RTS;
530 if (clear & TIOCM_DTR)
531 priv->mcr &= ~CH341_BIT_DTR;
532 control = priv->mcr;
533 spin_unlock_irqrestore(&priv->lock, flags);
535 return ch341_set_handshake(port->serial->dev, control);
538 static void ch341_update_status(struct usb_serial_port *port,
539 unsigned char *data, size_t len)
541 struct ch341_private *priv = usb_get_serial_port_data(port);
542 struct tty_struct *tty;
543 unsigned long flags;
544 u8 status;
545 u8 delta;
547 if (len < 4)
548 return;
550 status = ~data[2] & CH341_BITS_MODEM_STAT;
552 spin_lock_irqsave(&priv->lock, flags);
553 delta = status ^ priv->msr;
554 priv->msr = status;
555 spin_unlock_irqrestore(&priv->lock, flags);
557 if (data[1] & CH341_MULT_STAT)
558 dev_dbg(&port->dev, "%s - multiple status change\n", __func__);
560 if (!delta)
561 return;
563 if (delta & CH341_BIT_CTS)
564 port->icount.cts++;
565 if (delta & CH341_BIT_DSR)
566 port->icount.dsr++;
567 if (delta & CH341_BIT_RI)
568 port->icount.rng++;
569 if (delta & CH341_BIT_DCD) {
570 port->icount.dcd++;
571 tty = tty_port_tty_get(&port->port);
572 if (tty) {
573 usb_serial_handle_dcd_change(port, tty,
574 status & CH341_BIT_DCD);
575 tty_kref_put(tty);
579 wake_up_interruptible(&port->port.delta_msr_wait);
582 static void ch341_read_int_callback(struct urb *urb)
584 struct usb_serial_port *port = urb->context;
585 unsigned char *data = urb->transfer_buffer;
586 unsigned int len = urb->actual_length;
587 int status;
589 switch (urb->status) {
590 case 0:
591 /* success */
592 break;
593 case -ECONNRESET:
594 case -ENOENT:
595 case -ESHUTDOWN:
596 /* this urb is terminated, clean up */
597 dev_dbg(&urb->dev->dev, "%s - urb shutting down: %d\n",
598 __func__, urb->status);
599 return;
600 default:
601 dev_dbg(&urb->dev->dev, "%s - nonzero urb status: %d\n",
602 __func__, urb->status);
603 goto exit;
606 usb_serial_debug_data(&port->dev, __func__, len, data);
607 ch341_update_status(port, data, len);
608 exit:
609 status = usb_submit_urb(urb, GFP_ATOMIC);
610 if (status) {
611 dev_err(&urb->dev->dev, "%s - usb_submit_urb failed: %d\n",
612 __func__, status);
616 static int ch341_tiocmget(struct tty_struct *tty)
618 struct usb_serial_port *port = tty->driver_data;
619 struct ch341_private *priv = usb_get_serial_port_data(port);
620 unsigned long flags;
621 u8 mcr;
622 u8 status;
623 unsigned int result;
625 spin_lock_irqsave(&priv->lock, flags);
626 mcr = priv->mcr;
627 status = priv->msr;
628 spin_unlock_irqrestore(&priv->lock, flags);
630 result = ((mcr & CH341_BIT_DTR) ? TIOCM_DTR : 0)
631 | ((mcr & CH341_BIT_RTS) ? TIOCM_RTS : 0)
632 | ((status & CH341_BIT_CTS) ? TIOCM_CTS : 0)
633 | ((status & CH341_BIT_DSR) ? TIOCM_DSR : 0)
634 | ((status & CH341_BIT_RI) ? TIOCM_RI : 0)
635 | ((status & CH341_BIT_DCD) ? TIOCM_CD : 0);
637 dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
639 return result;
642 static int ch341_reset_resume(struct usb_serial *serial)
644 struct usb_serial_port *port = serial->port[0];
645 struct ch341_private *priv;
646 int ret;
648 priv = usb_get_serial_port_data(port);
649 if (!priv)
650 return 0;
652 /* reconfigure ch341 serial port after bus-reset */
653 ch341_configure(serial->dev, priv);
655 if (tty_port_initialized(&port->port)) {
656 ret = usb_submit_urb(port->interrupt_in_urb, GFP_NOIO);
657 if (ret) {
658 dev_err(&port->dev, "failed to submit interrupt urb: %d\n",
659 ret);
660 return ret;
663 ret = ch341_get_status(port->serial->dev, priv);
664 if (ret < 0) {
665 dev_err(&port->dev, "failed to read modem status: %d\n",
666 ret);
670 return usb_serial_generic_resume(serial);
673 static struct usb_serial_driver ch341_device = {
674 .driver = {
675 .owner = THIS_MODULE,
676 .name = "ch341-uart",
678 .id_table = id_table,
679 .num_ports = 1,
680 .open = ch341_open,
681 .dtr_rts = ch341_dtr_rts,
682 .carrier_raised = ch341_carrier_raised,
683 .close = ch341_close,
684 .set_termios = ch341_set_termios,
685 .break_ctl = ch341_break_ctl,
686 .tiocmget = ch341_tiocmget,
687 .tiocmset = ch341_tiocmset,
688 .tiocmiwait = usb_serial_generic_tiocmiwait,
689 .read_int_callback = ch341_read_int_callback,
690 .port_probe = ch341_port_probe,
691 .port_remove = ch341_port_remove,
692 .reset_resume = ch341_reset_resume,
695 static struct usb_serial_driver * const serial_drivers[] = {
696 &ch341_device, NULL
699 module_usb_serial_driver(serial_drivers, id_table);
701 MODULE_LICENSE("GPL v2");