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