2 * Silicon Laboratories CP2101/CP2102 USB to RS232 serial adaptor driver
4 * Copyright (C) 2005 Craig Shelley (craig@microtron.org.uk)
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License version
8 * 2 as published by the Free Software Foundation.
10 * Support to set flow control line levels using TIOCMGET and TIOCMSET
11 * thanks to Karl Hiramoto karl@hiramoto.org. RTSCTS hardware flow
12 * control thanks to Munir Nassar nassarmu@real-time.com
15 * Buffers are not flushed when the port is opened.
16 * Multiple calls to write() may fail with "Resource temporarily unavailable"
20 #include <linux/kernel.h>
21 #include <linux/errno.h>
22 #include <linux/slab.h>
23 #include <linux/tty.h>
24 #include <linux/tty_flip.h>
25 #include <linux/module.h>
26 #include <linux/moduleparam.h>
27 #include <linux/usb.h>
28 #include <asm/uaccess.h>
29 #include <linux/usb/serial.h>
34 #define DRIVER_VERSION "v0.07"
35 #define DRIVER_DESC "Silicon Labs CP2101/CP2102 RS232 serial adaptor driver"
40 static int cp2101_open(struct usb_serial_port*, struct file*);
41 static void cp2101_cleanup(struct usb_serial_port*);
42 static void cp2101_close(struct usb_serial_port*, struct file*);
43 static void cp2101_get_termios(struct usb_serial_port*);
44 static void cp2101_set_termios(struct usb_serial_port*, struct ktermios*);
45 static int cp2101_tiocmget (struct usb_serial_port *, struct file *);
46 static int cp2101_tiocmset (struct usb_serial_port *, struct file *,
47 unsigned int, unsigned int);
48 static void cp2101_break_ctl(struct usb_serial_port*, int);
49 static int cp2101_startup (struct usb_serial *);
50 static void cp2101_shutdown(struct usb_serial*);
55 static struct usb_device_id id_table [] = {
56 { USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
57 { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
58 { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
59 { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
60 { USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
61 { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
62 { USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
63 { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
64 { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
65 { USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
66 { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
67 { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
68 { USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
69 { USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
70 { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
71 { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
72 { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
73 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
74 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
75 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
76 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
77 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
78 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
79 { } /* Terminating Entry */
82 MODULE_DEVICE_TABLE (usb, id_table);
84 static struct usb_driver cp2101_driver = {
86 .probe = usb_serial_probe,
87 .disconnect = usb_serial_disconnect,
92 static struct usb_serial_driver cp2101_device = {
97 .usb_driver = &cp2101_driver,
99 .num_interrupt_in = 0,
104 .close = cp2101_close,
105 .break_ctl = cp2101_break_ctl,
106 .set_termios = cp2101_set_termios,
107 .tiocmget = cp2101_tiocmget,
108 .tiocmset = cp2101_tiocmset,
109 .attach = cp2101_startup,
110 .shutdown = cp2101_shutdown,
113 /* Config request types */
114 #define REQTYPE_HOST_TO_DEVICE 0x41
115 #define REQTYPE_DEVICE_TO_HOST 0xc1
117 /* Config SET requests. To GET, add 1 to the request number */
118 #define CP2101_UART 0x00 /* Enable / Disable */
119 #define CP2101_BAUDRATE 0x01 /* (BAUD_RATE_GEN_FREQ / baudrate) */
120 #define CP2101_BITS 0x03 /* 0x(0)(databits)(parity)(stopbits) */
121 #define CP2101_BREAK 0x05 /* On / Off */
122 #define CP2101_CONTROL 0x07 /* Flow control line states */
123 #define CP2101_MODEMCTL 0x13 /* Modem controls */
124 #define CP2101_CONFIG_6 0x19 /* 6 bytes of config data ??? */
127 #define UART_ENABLE 0x0001
128 #define UART_DISABLE 0x0000
130 /* CP2101_BAUDRATE */
131 #define BAUD_RATE_GEN_FREQ 0x384000
134 #define BITS_DATA_MASK 0X0f00
135 #define BITS_DATA_5 0X0500
136 #define BITS_DATA_6 0X0600
137 #define BITS_DATA_7 0X0700
138 #define BITS_DATA_8 0X0800
139 #define BITS_DATA_9 0X0900
141 #define BITS_PARITY_MASK 0x00f0
142 #define BITS_PARITY_NONE 0x0000
143 #define BITS_PARITY_ODD 0x0010
144 #define BITS_PARITY_EVEN 0x0020
145 #define BITS_PARITY_MARK 0x0030
146 #define BITS_PARITY_SPACE 0x0040
148 #define BITS_STOP_MASK 0x000f
149 #define BITS_STOP_1 0x0000
150 #define BITS_STOP_1_5 0x0001
151 #define BITS_STOP_2 0x0002
154 #define BREAK_ON 0x0000
155 #define BREAK_OFF 0x0001
158 #define CONTROL_DTR 0x0001
159 #define CONTROL_RTS 0x0002
160 #define CONTROL_CTS 0x0010
161 #define CONTROL_DSR 0x0020
162 #define CONTROL_RING 0x0040
163 #define CONTROL_DCD 0x0080
164 #define CONTROL_WRITE_DTR 0x0100
165 #define CONTROL_WRITE_RTS 0x0200
169 * Reads from the CP2101 configuration registers
170 * 'size' is specified in bytes.
171 * 'data' is a pointer to a pre-allocated array of integers large
172 * enough to hold 'size' bytes (with 4 bytes to each integer)
174 static int cp2101_get_config(struct usb_serial_port* port, u8 request,
175 unsigned int *data, int size)
177 struct usb_serial *serial = port->serial;
179 int result, i, length;
181 /* Number of integers required to contain the array */
182 length = (((size - 1) | 3) + 1)/4;
184 buf = kcalloc(length, sizeof(__le32), GFP_KERNEL);
186 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
190 /* For get requests, the request number must be incremented */
193 /* Issue the request, attempting to read 'size' bytes */
194 result = usb_control_msg (serial->dev,usb_rcvctrlpipe (serial->dev, 0),
195 request, REQTYPE_DEVICE_TO_HOST, 0x0000,
198 /* Convert data into an array of integers */
199 for (i=0; i<length; i++)
200 data[i] = le32_to_cpu(buf[i]);
204 if (result != size) {
205 dev_err(&port->dev, "%s - Unable to send config request, "
206 "request=0x%x size=%d result=%d\n",
207 __FUNCTION__, request, size, result);
216 * Writes to the CP2101 configuration registers
217 * Values less than 16 bits wide are sent directly
218 * 'size' is specified in bytes.
220 static int cp2101_set_config(struct usb_serial_port* port, u8 request,
221 unsigned int *data, int size)
223 struct usb_serial *serial = port->serial;
225 int result, i, length;
227 /* Number of integers required to contain the array */
228 length = (((size - 1) | 3) + 1)/4;
230 buf = kmalloc(length * sizeof(__le32), GFP_KERNEL);
232 dev_err(&port->dev, "%s - out of memory.\n",
237 /* Array of integers into bytes */
238 for (i = 0; i < length; i++)
239 buf[i] = cpu_to_le32(data[i]);
242 result = usb_control_msg (serial->dev,
243 usb_sndctrlpipe(serial->dev, 0),
244 request, REQTYPE_HOST_TO_DEVICE, 0x0000,
247 result = usb_control_msg (serial->dev,
248 usb_sndctrlpipe(serial->dev, 0),
249 request, REQTYPE_HOST_TO_DEVICE, data[0],
255 if ((size > 2 && result != size) || result < 0) {
256 dev_err(&port->dev, "%s - Unable to send request, "
257 "request=0x%x size=%d result=%d\n",
258 __FUNCTION__, request, size, result);
262 /* Single data value */
263 result = usb_control_msg (serial->dev,
264 usb_sndctrlpipe(serial->dev, 0),
265 request, REQTYPE_HOST_TO_DEVICE, data[0],
271 * cp2101_set_config_single
272 * Convenience function for calling cp2101_set_config on single data values
273 * without requiring an integer pointer
275 static inline int cp2101_set_config_single(struct usb_serial_port* port,
276 u8 request, unsigned int data)
278 return cp2101_set_config(port, request, &data, 2);
281 static int cp2101_open (struct usb_serial_port *port, struct file *filp)
283 struct usb_serial *serial = port->serial;
286 dbg("%s - port %d", __FUNCTION__, port->number);
288 if (cp2101_set_config_single(port, CP2101_UART, UART_ENABLE)) {
289 dev_err(&port->dev, "%s - Unable to enable UART\n",
294 /* Start reading from the device */
295 usb_fill_bulk_urb (port->read_urb, serial->dev,
296 usb_rcvbulkpipe(serial->dev,
297 port->bulk_in_endpointAddress),
298 port->read_urb->transfer_buffer,
299 port->read_urb->transfer_buffer_length,
300 serial->type->read_bulk_callback,
302 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
304 dev_err(&port->dev, "%s - failed resubmitting read urb, "
305 "error %d\n", __FUNCTION__, result);
309 /* Configure the termios structure */
310 cp2101_get_termios(port);
312 /* Set the DTR and RTS pins low */
313 cp2101_tiocmset(port, NULL, TIOCM_DTR | TIOCM_RTS, 0);
318 static void cp2101_cleanup (struct usb_serial_port *port)
320 struct usb_serial *serial = port->serial;
322 dbg("%s - port %d", __FUNCTION__, port->number);
325 /* shutdown any bulk reads that might be going on */
326 if (serial->num_bulk_out)
327 usb_kill_urb(port->write_urb);
328 if (serial->num_bulk_in)
329 usb_kill_urb(port->read_urb);
333 static void cp2101_close (struct usb_serial_port *port, struct file * filp)
335 dbg("%s - port %d", __FUNCTION__, port->number);
337 /* shutdown our urbs */
338 dbg("%s - shutting down urbs", __FUNCTION__);
339 usb_kill_urb(port->write_urb);
340 usb_kill_urb(port->read_urb);
342 cp2101_set_config_single(port, CP2101_UART, UART_DISABLE);
347 * Reads the baud rate, data bits, parity, stop bits and flow control mode
348 * from the device, corrects any unsupported values, and configures the
349 * termios structure to reflect the state of the device
351 static void cp2101_get_termios (struct usb_serial_port *port)
353 unsigned int cflag, modem_ctl[4];
357 dbg("%s - port %d", __FUNCTION__, port->number);
359 if (!port->tty || !port->tty->termios) {
360 dbg("%s - no tty structures", __FUNCTION__);
363 cflag = port->tty->termios->c_cflag;
365 cp2101_get_config(port, CP2101_BAUDRATE, &baud, 2);
366 /* Convert to baudrate */
368 baud = BAUD_RATE_GEN_FREQ / baud;
370 dbg("%s - baud rate = %d", __FUNCTION__, baud);
374 * The baud rates which are commented out below
375 * appear to be supported by the device
376 * but are non-standard
378 case 600: cflag |= B600; break;
379 case 1200: cflag |= B1200; break;
380 case 1800: cflag |= B1800; break;
381 case 2400: cflag |= B2400; break;
382 case 4800: cflag |= B4800; break;
383 /*case 7200: cflag |= B7200; break;*/
384 case 9600: cflag |= B9600; break;
385 /*case 14400: cflag |= B14400; break;*/
386 case 19200: cflag |= B19200; break;
387 /*case 28800: cflag |= B28800; break;*/
388 case 38400: cflag |= B38400; break;
389 /*case 55854: cflag |= B55054; break;*/
390 case 57600: cflag |= B57600; break;
391 case 115200: cflag |= B115200; break;
392 /*case 127117: cflag |= B127117; break;*/
393 case 230400: cflag |= B230400; break;
394 case 460800: cflag |= B460800; break;
395 case 921600: cflag |= B921600; break;
396 /*case 3686400: cflag |= B3686400; break;*/
398 dbg("%s - Baud rate is not supported, "
399 "using 9600 baud", __FUNCTION__);
401 cp2101_set_config_single(port, CP2101_BAUDRATE,
402 (BAUD_RATE_GEN_FREQ/9600));
406 cp2101_get_config(port, CP2101_BITS, &bits, 2);
408 switch(bits & BITS_DATA_MASK) {
410 dbg("%s - data bits = 5", __FUNCTION__);
414 dbg("%s - data bits = 6", __FUNCTION__);
418 dbg("%s - data bits = 7", __FUNCTION__);
422 dbg("%s - data bits = 8", __FUNCTION__);
426 dbg("%s - data bits = 9 (not supported, "
427 "using 8 data bits)", __FUNCTION__);
429 bits &= ~BITS_DATA_MASK;
431 cp2101_set_config(port, CP2101_BITS, &bits, 2);
434 dbg("%s - Unknown number of data bits, "
435 "using 8", __FUNCTION__);
437 bits &= ~BITS_DATA_MASK;
439 cp2101_set_config(port, CP2101_BITS, &bits, 2);
443 switch(bits & BITS_PARITY_MASK) {
444 case BITS_PARITY_NONE:
445 dbg("%s - parity = NONE", __FUNCTION__);
448 case BITS_PARITY_ODD:
449 dbg("%s - parity = ODD", __FUNCTION__);
450 cflag |= (PARENB|PARODD);
452 case BITS_PARITY_EVEN:
453 dbg("%s - parity = EVEN", __FUNCTION__);
457 case BITS_PARITY_MARK:
458 dbg("%s - parity = MARK (not supported, "
459 "disabling parity)", __FUNCTION__);
461 bits &= ~BITS_PARITY_MASK;
462 cp2101_set_config(port, CP2101_BITS, &bits, 2);
464 case BITS_PARITY_SPACE:
465 dbg("%s - parity = SPACE (not supported, "
466 "disabling parity)", __FUNCTION__);
468 bits &= ~BITS_PARITY_MASK;
469 cp2101_set_config(port, CP2101_BITS, &bits, 2);
472 dbg("%s - Unknown parity mode, "
473 "disabling parity", __FUNCTION__);
475 bits &= ~BITS_PARITY_MASK;
476 cp2101_set_config(port, CP2101_BITS, &bits, 2);
481 switch(bits & BITS_STOP_MASK) {
483 dbg("%s - stop bits = 1", __FUNCTION__);
486 dbg("%s - stop bits = 1.5 (not supported, "
487 "using 1 stop bit)", __FUNCTION__);
488 bits &= ~BITS_STOP_MASK;
489 cp2101_set_config(port, CP2101_BITS, &bits, 2);
492 dbg("%s - stop bits = 2", __FUNCTION__);
496 dbg("%s - Unknown number of stop bits, "
497 "using 1 stop bit", __FUNCTION__);
498 bits &= ~BITS_STOP_MASK;
499 cp2101_set_config(port, CP2101_BITS, &bits, 2);
503 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
504 if (modem_ctl[0] & 0x0008) {
505 dbg("%s - flow control = CRTSCTS", __FUNCTION__);
508 dbg("%s - flow control = NONE", __FUNCTION__);
512 port->tty->termios->c_cflag = cflag;
515 static void cp2101_set_termios (struct usb_serial_port *port,
516 struct ktermios *old_termios)
518 unsigned int cflag, old_cflag=0;
520 unsigned int modem_ctl[4];
522 dbg("%s - port %d", __FUNCTION__, port->number);
524 if ((!port->tty) || (!port->tty->termios)) {
525 dbg("%s - no tty structures", __FUNCTION__);
528 cflag = port->tty->termios->c_cflag;
529 old_cflag = old_termios->c_cflag;
530 baud = tty_get_baud_rate(port->tty);
532 /* If the baud rate is to be updated*/
533 if (baud != tty_termios_baud_rate(old_termios)) {
562 dbg("%s - Setting baud rate to %d baud", __FUNCTION__,
564 if (cp2101_set_config_single(port, CP2101_BAUDRATE,
565 (BAUD_RATE_GEN_FREQ / baud)))
566 dev_err(&port->dev, "Baud rate requested not "
567 "supported by device\n");
571 /* If the number of data bits is to be updated */
572 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
573 cp2101_get_config(port, CP2101_BITS, &bits, 2);
574 bits &= ~BITS_DATA_MASK;
575 switch (cflag & CSIZE) {
578 dbg("%s - data bits = 5", __FUNCTION__);
582 dbg("%s - data bits = 6", __FUNCTION__);
586 dbg("%s - data bits = 7", __FUNCTION__);
590 dbg("%s - data bits = 8", __FUNCTION__);
594 dbg("%s - data bits = 9", __FUNCTION__);
597 dev_err(&port->dev, "cp2101 driver does not "
598 "support the number of bits requested,"
599 " using 8 bit mode\n");
603 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
604 dev_err(&port->dev, "Number of data bits requested "
605 "not supported by device\n");
608 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))) {
609 cp2101_get_config(port, CP2101_BITS, &bits, 2);
610 bits &= ~BITS_PARITY_MASK;
611 if (cflag & PARENB) {
612 if (cflag & PARODD) {
613 bits |= BITS_PARITY_ODD;
614 dbg("%s - parity = ODD", __FUNCTION__);
616 bits |= BITS_PARITY_EVEN;
617 dbg("%s - parity = EVEN", __FUNCTION__);
620 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
621 dev_err(&port->dev, "Parity mode not supported "
625 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
626 cp2101_get_config(port, CP2101_BITS, &bits, 2);
627 bits &= ~BITS_STOP_MASK;
628 if (cflag & CSTOPB) {
630 dbg("%s - stop bits = 2", __FUNCTION__);
633 dbg("%s - stop bits = 1", __FUNCTION__);
635 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
636 dev_err(&port->dev, "Number of stop bits requested "
637 "not supported by device\n");
640 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
641 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
642 dbg("%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
643 __FUNCTION__, modem_ctl[0], modem_ctl[1],
644 modem_ctl[2], modem_ctl[3]);
646 if (cflag & CRTSCTS) {
647 modem_ctl[0] &= ~0x7B;
648 modem_ctl[0] |= 0x09;
650 dbg("%s - flow control = CRTSCTS", __FUNCTION__);
652 modem_ctl[0] &= ~0x7B;
653 modem_ctl[0] |= 0x01;
654 modem_ctl[1] |= 0x40;
655 dbg("%s - flow control = NONE", __FUNCTION__);
658 dbg("%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
659 __FUNCTION__, modem_ctl[0], modem_ctl[1],
660 modem_ctl[2], modem_ctl[3]);
661 cp2101_set_config(port, CP2101_MODEMCTL, modem_ctl, 16);
666 static int cp2101_tiocmset (struct usb_serial_port *port, struct file *file,
667 unsigned int set, unsigned int clear)
671 dbg("%s - port %d", __FUNCTION__, port->number);
673 if (set & TIOCM_RTS) {
674 control |= CONTROL_RTS;
675 control |= CONTROL_WRITE_RTS;
677 if (set & TIOCM_DTR) {
678 control |= CONTROL_DTR;
679 control |= CONTROL_WRITE_DTR;
681 if (clear & TIOCM_RTS) {
682 control &= ~CONTROL_RTS;
683 control |= CONTROL_WRITE_RTS;
685 if (clear & TIOCM_DTR) {
686 control &= ~CONTROL_DTR;
687 control |= CONTROL_WRITE_DTR;
690 dbg("%s - control = 0x%.4x", __FUNCTION__, control);
692 return cp2101_set_config(port, CP2101_CONTROL, &control, 2);
696 static int cp2101_tiocmget (struct usb_serial_port *port, struct file *file)
700 dbg("%s - port %d", __FUNCTION__, port->number);
702 cp2101_get_config(port, CP2101_CONTROL, &control, 1);
704 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
705 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
706 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
707 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
708 |((control & CONTROL_RING)? TIOCM_RI : 0)
709 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
711 dbg("%s - control = 0x%.2x", __FUNCTION__, control);
716 static void cp2101_break_ctl (struct usb_serial_port *port, int break_state)
720 dbg("%s - port %d", __FUNCTION__, port->number);
721 if (break_state == 0)
725 dbg("%s - turning break %s", __FUNCTION__,
726 state==BREAK_OFF ? "off" : "on");
727 cp2101_set_config(port, CP2101_BREAK, &state, 2);
730 static int cp2101_startup (struct usb_serial *serial)
732 /* CP2101 buffers behave strangely unless device is reset */
733 usb_reset_device(serial->dev);
737 static void cp2101_shutdown (struct usb_serial *serial)
741 dbg("%s", __FUNCTION__);
743 /* Stop reads and writes on all ports */
744 for (i=0; i < serial->num_ports; ++i) {
745 cp2101_cleanup(serial->port[i]);
749 static int __init cp2101_init (void)
753 retval = usb_serial_register(&cp2101_device);
755 return retval; /* Failed to register */
757 retval = usb_register(&cp2101_driver);
759 /* Failed to register */
760 usb_serial_deregister(&cp2101_device);
765 info(DRIVER_DESC " " DRIVER_VERSION);
769 static void __exit cp2101_exit (void)
771 usb_deregister (&cp2101_driver);
772 usb_serial_deregister (&cp2101_device);
775 module_init(cp2101_init);
776 module_exit(cp2101_exit);
778 MODULE_DESCRIPTION(DRIVER_DESC);
779 MODULE_VERSION(DRIVER_VERSION);
780 MODULE_LICENSE("GPL");
782 module_param(debug, bool, S_IRUGO | S_IWUSR);
783 MODULE_PARM_DESC(debug, "Enable verbose debugging messages");