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