GNU Linux-libre 4.14.266-gnu1
[releases.git] / drivers / usb / serial / ch341.c
1 /*
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>
5  *
6  * ch341.c implements a serial port driver for the Winchiphead CH341.
7  *
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.
12  *
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.
16  */
17
18 #include <linux/kernel.h>
19 #include <linux/tty.h>
20 #include <linux/module.h>
21 #include <linux/slab.h>
22 #include <linux/usb.h>
23 #include <linux/usb/serial.h>
24 #include <linux/serial.h>
25 #include <asm/unaligned.h>
26
27 #define DEFAULT_BAUD_RATE 9600
28 #define DEFAULT_TIMEOUT   1000
29
30 /* flags for IO-Bits */
31 #define CH341_BIT_RTS (1 << 6)
32 #define CH341_BIT_DTR (1 << 5)
33
34 /******************************/
35 /* interrupt pipe definitions */
36 /******************************/
37 /* always 4 interrupt bytes */
38 /* first irq byte normally 0x08 */
39 /* second irq byte base 0x7d + below */
40 /* third irq byte base 0x94 + below */
41 /* fourth irq byte normally 0xee */
42
43 /* second interrupt byte */
44 #define CH341_MULT_STAT 0x04 /* multiple status since last interrupt event */
45
46 /* status returned in third interrupt answer byte, inverted in data
47    from irq */
48 #define CH341_BIT_CTS 0x01
49 #define CH341_BIT_DSR 0x02
50 #define CH341_BIT_RI  0x04
51 #define CH341_BIT_DCD 0x08
52 #define CH341_BITS_MODEM_STAT 0x0f /* all bits */
53
54 /*******************************/
55 /* baudrate calculation factor */
56 /*******************************/
57 #define CH341_BAUDBASE_FACTOR 1532620800
58 #define CH341_BAUDBASE_DIVMAX 3
59
60 /* Break support - the information used to implement this was gleaned from
61  * the Net/FreeBSD uchcom.c driver by Takanori Watanabe.  Domo arigato.
62  */
63
64 #define CH341_REQ_READ_VERSION 0x5F
65 #define CH341_REQ_WRITE_REG    0x9A
66 #define CH341_REQ_READ_REG     0x95
67 #define CH341_REQ_SERIAL_INIT  0xA1
68 #define CH341_REQ_MODEM_CTRL   0xA4
69
70 #define CH341_REG_BREAK        0x05
71 #define CH341_REG_LCR          0x18
72 #define CH341_NBREAK_BITS      0x01
73
74 #define CH341_LCR_ENABLE_RX    0x80
75 #define CH341_LCR_ENABLE_TX    0x40
76 #define CH341_LCR_MARK_SPACE   0x20
77 #define CH341_LCR_PAR_EVEN     0x10
78 #define CH341_LCR_ENABLE_PAR   0x08
79 #define CH341_LCR_STOP_BITS_2  0x04
80 #define CH341_LCR_CS8          0x03
81 #define CH341_LCR_CS7          0x02
82 #define CH341_LCR_CS6          0x01
83 #define CH341_LCR_CS5          0x00
84
85 static const struct usb_device_id id_table[] = {
86         { USB_DEVICE(0x1a86, 0x5512) },
87         { USB_DEVICE(0x1a86, 0x5523) },
88         { USB_DEVICE(0x1a86, 0x7522) },
89         { USB_DEVICE(0x1a86, 0x7523) },
90         { USB_DEVICE(0x4348, 0x5523) },
91         { USB_DEVICE(0x9986, 0x7523) },
92         { },
93 };
94 MODULE_DEVICE_TABLE(usb, id_table);
95
96 struct ch341_private {
97         spinlock_t lock; /* access lock */
98         unsigned baud_rate; /* set baud rate */
99         u8 mcr;
100         u8 msr;
101         u8 lcr;
102 };
103
104 static void ch341_set_termios(struct tty_struct *tty,
105                               struct usb_serial_port *port,
106                               struct ktermios *old_termios);
107
108 static int ch341_control_out(struct usb_device *dev, u8 request,
109                              u16 value, u16 index)
110 {
111         int r;
112
113         dev_dbg(&dev->dev, "%s - (%02x,%04x,%04x)\n", __func__,
114                 request, value, index);
115
116         r = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), request,
117                             USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
118                             value, index, NULL, 0, DEFAULT_TIMEOUT);
119         if (r < 0)
120                 dev_err(&dev->dev, "failed to send control message: %d\n", r);
121
122         return r;
123 }
124
125 static int ch341_control_in(struct usb_device *dev,
126                             u8 request, u16 value, u16 index,
127                             char *buf, unsigned bufsize)
128 {
129         int r;
130
131         dev_dbg(&dev->dev, "%s - (%02x,%04x,%04x,%u)\n", __func__,
132                 request, value, index, bufsize);
133
134         r = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), request,
135                             USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
136                             value, index, buf, bufsize, DEFAULT_TIMEOUT);
137         if (r < (int)bufsize) {
138                 if (r >= 0) {
139                         dev_err(&dev->dev,
140                                 "short control message received (%d < %u)\n",
141                                 r, bufsize);
142                         r = -EIO;
143                 }
144
145                 dev_err(&dev->dev, "failed to receive control message: %d\n",
146                         r);
147                 return r;
148         }
149
150         return 0;
151 }
152
153 static int ch341_set_baudrate_lcr(struct usb_device *dev,
154                                   struct ch341_private *priv, u8 lcr)
155 {
156         short a;
157         int r;
158         unsigned long factor;
159         short divisor;
160
161         if (!priv->baud_rate)
162                 return -EINVAL;
163         factor = (CH341_BAUDBASE_FACTOR / priv->baud_rate);
164         divisor = CH341_BAUDBASE_DIVMAX;
165
166         while ((factor > 0xfff0) && divisor) {
167                 factor >>= 3;
168                 divisor--;
169         }
170
171         if (factor > 0xfff0)
172                 return -EINVAL;
173
174         factor = 0x10000 - factor;
175         a = (factor & 0xff00) | divisor;
176
177         /*
178          * CH341A buffers data until a full endpoint-size packet (32 bytes)
179          * has been received unless bit 7 is set.
180          */
181         a |= BIT(7);
182
183         r = ch341_control_out(dev, CH341_REQ_WRITE_REG, 0x1312, a);
184         if (r)
185                 return r;
186
187         r = ch341_control_out(dev, CH341_REQ_WRITE_REG, 0x2518, lcr);
188         if (r)
189                 return r;
190
191         return r;
192 }
193
194 static int ch341_set_handshake(struct usb_device *dev, u8 control)
195 {
196         return ch341_control_out(dev, CH341_REQ_MODEM_CTRL, ~control, 0);
197 }
198
199 static int ch341_get_status(struct usb_device *dev, struct ch341_private *priv)
200 {
201         const unsigned int size = 2;
202         char *buffer;
203         int r;
204         unsigned long flags;
205
206         buffer = kmalloc(size, GFP_KERNEL);
207         if (!buffer)
208                 return -ENOMEM;
209
210         r = ch341_control_in(dev, CH341_REQ_READ_REG, 0x0706, 0, buffer, size);
211         if (r < 0)
212                 goto out;
213
214         spin_lock_irqsave(&priv->lock, flags);
215         priv->msr = (~(*buffer)) & CH341_BITS_MODEM_STAT;
216         spin_unlock_irqrestore(&priv->lock, flags);
217
218 out:    kfree(buffer);
219         return r;
220 }
221
222 /* -------------------------------------------------------------------------- */
223
224 static int ch341_configure(struct usb_device *dev, struct ch341_private *priv)
225 {
226         const unsigned int size = 2;
227         char *buffer;
228         int r;
229
230         buffer = kmalloc(size, GFP_KERNEL);
231         if (!buffer)
232                 return -ENOMEM;
233
234         /* expect two bytes 0x27 0x00 */
235         r = ch341_control_in(dev, CH341_REQ_READ_VERSION, 0, 0, buffer, size);
236         if (r < 0)
237                 goto out;
238         dev_dbg(&dev->dev, "Chip version: 0x%02x\n", buffer[0]);
239
240         r = ch341_control_out(dev, CH341_REQ_SERIAL_INIT, 0, 0);
241         if (r < 0)
242                 goto out;
243
244         r = ch341_set_baudrate_lcr(dev, priv, priv->lcr);
245         if (r < 0)
246                 goto out;
247
248         r = ch341_set_handshake(dev, priv->mcr);
249
250 out:    kfree(buffer);
251         return r;
252 }
253
254 static int ch341_port_probe(struct usb_serial_port *port)
255 {
256         struct ch341_private *priv;
257         int r;
258
259         priv = kzalloc(sizeof(struct ch341_private), GFP_KERNEL);
260         if (!priv)
261                 return -ENOMEM;
262
263         spin_lock_init(&priv->lock);
264         priv->baud_rate = DEFAULT_BAUD_RATE;
265         /*
266          * Some CH340 devices appear unable to change the initial LCR
267          * settings, so set a sane 8N1 default.
268          */
269         priv->lcr = CH341_LCR_ENABLE_RX | CH341_LCR_ENABLE_TX | CH341_LCR_CS8;
270
271         r = ch341_configure(port->serial->dev, priv);
272         if (r < 0)
273                 goto error;
274
275         usb_set_serial_port_data(port, priv);
276         return 0;
277
278 error:  kfree(priv);
279         return r;
280 }
281
282 static int ch341_port_remove(struct usb_serial_port *port)
283 {
284         struct ch341_private *priv;
285
286         priv = usb_get_serial_port_data(port);
287         kfree(priv);
288
289         return 0;
290 }
291
292 static int ch341_carrier_raised(struct usb_serial_port *port)
293 {
294         struct ch341_private *priv = usb_get_serial_port_data(port);
295         if (priv->msr & CH341_BIT_DCD)
296                 return 1;
297         return 0;
298 }
299
300 static void ch341_dtr_rts(struct usb_serial_port *port, int on)
301 {
302         struct ch341_private *priv = usb_get_serial_port_data(port);
303         unsigned long flags;
304
305         /* drop DTR and RTS */
306         spin_lock_irqsave(&priv->lock, flags);
307         if (on)
308                 priv->mcr |= CH341_BIT_RTS | CH341_BIT_DTR;
309         else
310                 priv->mcr &= ~(CH341_BIT_RTS | CH341_BIT_DTR);
311         spin_unlock_irqrestore(&priv->lock, flags);
312         ch341_set_handshake(port->serial->dev, priv->mcr);
313 }
314
315 static void ch341_close(struct usb_serial_port *port)
316 {
317         usb_serial_generic_close(port);
318         usb_kill_urb(port->interrupt_in_urb);
319 }
320
321
322 /* open this device, set default parameters */
323 static int ch341_open(struct tty_struct *tty, struct usb_serial_port *port)
324 {
325         struct ch341_private *priv = usb_get_serial_port_data(port);
326         int r;
327
328         if (tty)
329                 ch341_set_termios(tty, port, NULL);
330
331         dev_dbg(&port->dev, "%s - submitting interrupt urb\n", __func__);
332         r = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
333         if (r) {
334                 dev_err(&port->dev, "%s - failed to submit interrupt urb: %d\n",
335                         __func__, r);
336                 return r;
337         }
338
339         r = ch341_get_status(port->serial->dev, priv);
340         if (r < 0) {
341                 dev_err(&port->dev, "failed to read modem status: %d\n", r);
342                 goto err_kill_interrupt_urb;
343         }
344
345         r = usb_serial_generic_open(tty, port);
346         if (r)
347                 goto err_kill_interrupt_urb;
348
349         return 0;
350
351 err_kill_interrupt_urb:
352         usb_kill_urb(port->interrupt_in_urb);
353
354         return r;
355 }
356
357 /* Old_termios contains the original termios settings and
358  * tty->termios contains the new setting to be used.
359  */
360 static void ch341_set_termios(struct tty_struct *tty,
361                 struct usb_serial_port *port, struct ktermios *old_termios)
362 {
363         struct ch341_private *priv = usb_get_serial_port_data(port);
364         unsigned baud_rate;
365         unsigned long flags;
366         u8 lcr;
367         int r;
368
369         /* redundant changes may cause the chip to lose bytes */
370         if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios))
371                 return;
372
373         baud_rate = tty_get_baud_rate(tty);
374
375         lcr = CH341_LCR_ENABLE_RX | CH341_LCR_ENABLE_TX;
376
377         switch (C_CSIZE(tty)) {
378         case CS5:
379                 lcr |= CH341_LCR_CS5;
380                 break;
381         case CS6:
382                 lcr |= CH341_LCR_CS6;
383                 break;
384         case CS7:
385                 lcr |= CH341_LCR_CS7;
386                 break;
387         case CS8:
388                 lcr |= CH341_LCR_CS8;
389                 break;
390         }
391
392         if (C_PARENB(tty)) {
393                 lcr |= CH341_LCR_ENABLE_PAR;
394                 if (C_PARODD(tty) == 0)
395                         lcr |= CH341_LCR_PAR_EVEN;
396                 if (C_CMSPAR(tty))
397                         lcr |= CH341_LCR_MARK_SPACE;
398         }
399
400         if (C_CSTOPB(tty))
401                 lcr |= CH341_LCR_STOP_BITS_2;
402
403         if (baud_rate) {
404                 priv->baud_rate = baud_rate;
405
406                 r = ch341_set_baudrate_lcr(port->serial->dev, priv, lcr);
407                 if (r < 0 && old_termios) {
408                         priv->baud_rate = tty_termios_baud_rate(old_termios);
409                         tty_termios_copy_hw(&tty->termios, old_termios);
410                 } else if (r == 0) {
411                         priv->lcr = lcr;
412                 }
413         }
414
415         spin_lock_irqsave(&priv->lock, flags);
416         if (C_BAUD(tty) == B0)
417                 priv->mcr &= ~(CH341_BIT_DTR | CH341_BIT_RTS);
418         else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
419                 priv->mcr |= (CH341_BIT_DTR | CH341_BIT_RTS);
420         spin_unlock_irqrestore(&priv->lock, flags);
421
422         ch341_set_handshake(port->serial->dev, priv->mcr);
423 }
424
425 static void ch341_break_ctl(struct tty_struct *tty, int break_state)
426 {
427         const uint16_t ch341_break_reg =
428                         ((uint16_t) CH341_REG_LCR << 8) | CH341_REG_BREAK;
429         struct usb_serial_port *port = tty->driver_data;
430         int r;
431         uint16_t reg_contents;
432         uint8_t *break_reg;
433
434         break_reg = kmalloc(2, GFP_KERNEL);
435         if (!break_reg)
436                 return;
437
438         r = ch341_control_in(port->serial->dev, CH341_REQ_READ_REG,
439                         ch341_break_reg, 0, break_reg, 2);
440         if (r < 0) {
441                 dev_err(&port->dev, "%s - USB control read error (%d)\n",
442                                 __func__, r);
443                 goto out;
444         }
445         dev_dbg(&port->dev, "%s - initial ch341 break register contents - reg1: %x, reg2: %x\n",
446                 __func__, break_reg[0], break_reg[1]);
447         if (break_state != 0) {
448                 dev_dbg(&port->dev, "%s - Enter break state requested\n", __func__);
449                 break_reg[0] &= ~CH341_NBREAK_BITS;
450                 break_reg[1] &= ~CH341_LCR_ENABLE_TX;
451         } else {
452                 dev_dbg(&port->dev, "%s - Leave break state requested\n", __func__);
453                 break_reg[0] |= CH341_NBREAK_BITS;
454                 break_reg[1] |= CH341_LCR_ENABLE_TX;
455         }
456         dev_dbg(&port->dev, "%s - New ch341 break register contents - reg1: %x, reg2: %x\n",
457                 __func__, break_reg[0], break_reg[1]);
458         reg_contents = get_unaligned_le16(break_reg);
459         r = ch341_control_out(port->serial->dev, CH341_REQ_WRITE_REG,
460                         ch341_break_reg, reg_contents);
461         if (r < 0)
462                 dev_err(&port->dev, "%s - USB control write error (%d)\n",
463                                 __func__, r);
464 out:
465         kfree(break_reg);
466 }
467
468 static int ch341_tiocmset(struct tty_struct *tty,
469                           unsigned int set, unsigned int clear)
470 {
471         struct usb_serial_port *port = tty->driver_data;
472         struct ch341_private *priv = usb_get_serial_port_data(port);
473         unsigned long flags;
474         u8 control;
475
476         spin_lock_irqsave(&priv->lock, flags);
477         if (set & TIOCM_RTS)
478                 priv->mcr |= CH341_BIT_RTS;
479         if (set & TIOCM_DTR)
480                 priv->mcr |= CH341_BIT_DTR;
481         if (clear & TIOCM_RTS)
482                 priv->mcr &= ~CH341_BIT_RTS;
483         if (clear & TIOCM_DTR)
484                 priv->mcr &= ~CH341_BIT_DTR;
485         control = priv->mcr;
486         spin_unlock_irqrestore(&priv->lock, flags);
487
488         return ch341_set_handshake(port->serial->dev, control);
489 }
490
491 static void ch341_update_status(struct usb_serial_port *port,
492                                         unsigned char *data, size_t len)
493 {
494         struct ch341_private *priv = usb_get_serial_port_data(port);
495         struct tty_struct *tty;
496         unsigned long flags;
497         u8 status;
498         u8 delta;
499
500         if (len < 4)
501                 return;
502
503         status = ~data[2] & CH341_BITS_MODEM_STAT;
504
505         spin_lock_irqsave(&priv->lock, flags);
506         delta = status ^ priv->msr;
507         priv->msr = status;
508         spin_unlock_irqrestore(&priv->lock, flags);
509
510         if (data[1] & CH341_MULT_STAT)
511                 dev_dbg(&port->dev, "%s - multiple status change\n", __func__);
512
513         if (!delta)
514                 return;
515
516         if (delta & CH341_BIT_CTS)
517                 port->icount.cts++;
518         if (delta & CH341_BIT_DSR)
519                 port->icount.dsr++;
520         if (delta & CH341_BIT_RI)
521                 port->icount.rng++;
522         if (delta & CH341_BIT_DCD) {
523                 port->icount.dcd++;
524                 tty = tty_port_tty_get(&port->port);
525                 if (tty) {
526                         usb_serial_handle_dcd_change(port, tty,
527                                                 status & CH341_BIT_DCD);
528                         tty_kref_put(tty);
529                 }
530         }
531
532         wake_up_interruptible(&port->port.delta_msr_wait);
533 }
534
535 static void ch341_read_int_callback(struct urb *urb)
536 {
537         struct usb_serial_port *port = urb->context;
538         unsigned char *data = urb->transfer_buffer;
539         unsigned int len = urb->actual_length;
540         int status;
541
542         switch (urb->status) {
543         case 0:
544                 /* success */
545                 break;
546         case -ECONNRESET:
547         case -ENOENT:
548         case -ESHUTDOWN:
549                 /* this urb is terminated, clean up */
550                 dev_dbg(&urb->dev->dev, "%s - urb shutting down: %d\n",
551                         __func__, urb->status);
552                 return;
553         default:
554                 dev_dbg(&urb->dev->dev, "%s - nonzero urb status: %d\n",
555                         __func__, urb->status);
556                 goto exit;
557         }
558
559         usb_serial_debug_data(&port->dev, __func__, len, data);
560         ch341_update_status(port, data, len);
561 exit:
562         status = usb_submit_urb(urb, GFP_ATOMIC);
563         if (status) {
564                 dev_err(&urb->dev->dev, "%s - usb_submit_urb failed: %d\n",
565                         __func__, status);
566         }
567 }
568
569 static int ch341_tiocmget(struct tty_struct *tty)
570 {
571         struct usb_serial_port *port = tty->driver_data;
572         struct ch341_private *priv = usb_get_serial_port_data(port);
573         unsigned long flags;
574         u8 mcr;
575         u8 status;
576         unsigned int result;
577
578         spin_lock_irqsave(&priv->lock, flags);
579         mcr = priv->mcr;
580         status = priv->msr;
581         spin_unlock_irqrestore(&priv->lock, flags);
582
583         result = ((mcr & CH341_BIT_DTR)         ? TIOCM_DTR : 0)
584                   | ((mcr & CH341_BIT_RTS)      ? TIOCM_RTS : 0)
585                   | ((status & CH341_BIT_CTS)   ? TIOCM_CTS : 0)
586                   | ((status & CH341_BIT_DSR)   ? TIOCM_DSR : 0)
587                   | ((status & CH341_BIT_RI)    ? TIOCM_RI  : 0)
588                   | ((status & CH341_BIT_DCD)   ? TIOCM_CD  : 0);
589
590         dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
591
592         return result;
593 }
594
595 static int ch341_reset_resume(struct usb_serial *serial)
596 {
597         struct usb_serial_port *port = serial->port[0];
598         struct ch341_private *priv;
599         int ret;
600
601         priv = usb_get_serial_port_data(port);
602         if (!priv)
603                 return 0;
604
605         /* reconfigure ch341 serial port after bus-reset */
606         ch341_configure(serial->dev, priv);
607
608         if (tty_port_initialized(&port->port)) {
609                 ret = usb_submit_urb(port->interrupt_in_urb, GFP_NOIO);
610                 if (ret) {
611                         dev_err(&port->dev, "failed to submit interrupt urb: %d\n",
612                                 ret);
613                         return ret;
614                 }
615
616                 ret = ch341_get_status(port->serial->dev, priv);
617                 if (ret < 0) {
618                         dev_err(&port->dev, "failed to read modem status: %d\n",
619                                 ret);
620                 }
621         }
622
623         return usb_serial_generic_resume(serial);
624 }
625
626 static struct usb_serial_driver ch341_device = {
627         .driver = {
628                 .owner  = THIS_MODULE,
629                 .name   = "ch341-uart",
630         },
631         .id_table          = id_table,
632         .num_ports         = 1,
633         .open              = ch341_open,
634         .dtr_rts           = ch341_dtr_rts,
635         .carrier_raised    = ch341_carrier_raised,
636         .close             = ch341_close,
637         .set_termios       = ch341_set_termios,
638         .break_ctl         = ch341_break_ctl,
639         .tiocmget          = ch341_tiocmget,
640         .tiocmset          = ch341_tiocmset,
641         .tiocmiwait        = usb_serial_generic_tiocmiwait,
642         .read_int_callback = ch341_read_int_callback,
643         .port_probe        = ch341_port_probe,
644         .port_remove       = ch341_port_remove,
645         .reset_resume      = ch341_reset_resume,
646 };
647
648 static struct usb_serial_driver * const serial_drivers[] = {
649         &ch341_device, NULL
650 };
651
652 module_usb_serial_driver(serial_drivers, id_table);
653
654 MODULE_LICENSE("GPL");