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/config.h>
21 #include <linux/kernel.h>
22 #include <linux/errno.h>
23 #include <linux/slab.h>
24 #include <linux/tty.h>
25 #include <linux/tty_flip.h>
26 #include <linux/module.h>
27 #include <linux/moduleparam.h>
28 #include <linux/usb.h>
29 #include <asm/uaccess.h>
30 #include "usb-serial.h"
35 #define DRIVER_VERSION "v0.05"
36 #define DRIVER_DESC "Silicon Labs CP2101/CP2102 RS232 serial adaptor driver"
41 static int cp2101_open(struct usb_serial_port*, struct file*);
42 static void cp2101_cleanup(struct usb_serial_port*);
43 static void cp2101_close(struct usb_serial_port*, struct file*);
44 static void cp2101_get_termios(struct usb_serial_port*);
45 static void cp2101_set_termios(struct usb_serial_port*, struct termios*);
46 static int cp2101_tiocmget (struct usb_serial_port *, struct file *);
47 static int cp2101_tiocmset (struct usb_serial_port *, struct file *,
48 unsigned int, unsigned int);
49 static void cp2101_break_ctl(struct usb_serial_port*, int);
50 static int cp2101_startup (struct usb_serial *);
51 static void cp2101_shutdown(struct usb_serial*);
56 static struct usb_device_id id_table [] = {
57 { USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
58 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
59 { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
60 { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
61 { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
62 { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
63 { } /* Terminating Entry */
66 MODULE_DEVICE_TABLE (usb, id_table);
68 static struct usb_driver cp2101_driver = {
71 .probe = usb_serial_probe,
72 .disconnect = usb_serial_disconnect,
76 static struct usb_serial_driver cp2101_device = {
82 .num_interrupt_in = 0,
87 .close = cp2101_close,
88 .break_ctl = cp2101_break_ctl,
89 .set_termios = cp2101_set_termios,
90 .tiocmget = cp2101_tiocmget,
91 .tiocmset = cp2101_tiocmset,
92 .attach = cp2101_startup,
93 .shutdown = cp2101_shutdown,
96 /* Config request types */
97 #define REQTYPE_HOST_TO_DEVICE 0x41
98 #define REQTYPE_DEVICE_TO_HOST 0xc1
100 /* Config SET requests. To GET, add 1 to the request number */
101 #define CP2101_UART 0x00 /* Enable / Disable */
102 #define CP2101_BAUDRATE 0x01 /* (BAUD_RATE_GEN_FREQ / baudrate) */
103 #define CP2101_BITS 0x03 /* 0x(0)(databits)(parity)(stopbits) */
104 #define CP2101_BREAK 0x05 /* On / Off */
105 #define CP2101_CONTROL 0x07 /* Flow control line states */
106 #define CP2101_MODEMCTL 0x13 /* Modem controls */
107 #define CP2101_CONFIG_6 0x19 /* 6 bytes of config data ??? */
110 #define UART_ENABLE 0x0001
111 #define UART_DISABLE 0x0000
113 /* CP2101_BAUDRATE */
114 #define BAUD_RATE_GEN_FREQ 0x384000
117 #define BITS_DATA_MASK 0X0f00
118 #define BITS_DATA_5 0X0500
119 #define BITS_DATA_6 0X0600
120 #define BITS_DATA_7 0X0700
121 #define BITS_DATA_8 0X0800
122 #define BITS_DATA_9 0X0900
124 #define BITS_PARITY_MASK 0x00f0
125 #define BITS_PARITY_NONE 0x0000
126 #define BITS_PARITY_ODD 0x0010
127 #define BITS_PARITY_EVEN 0x0020
128 #define BITS_PARITY_MARK 0x0030
129 #define BITS_PARITY_SPACE 0x0040
131 #define BITS_STOP_MASK 0x000f
132 #define BITS_STOP_1 0x0000
133 #define BITS_STOP_1_5 0x0001
134 #define BITS_STOP_2 0x0002
137 #define BREAK_ON 0x0000
138 #define BREAK_OFF 0x0001
141 #define CONTROL_DTR 0x0001
142 #define CONTROL_RTS 0x0002
143 #define CONTROL_CTS 0x0010
144 #define CONTROL_DSR 0x0020
145 #define CONTROL_RING 0x0040
146 #define CONTROL_DCD 0x0080
147 #define CONTROL_WRITE_DTR 0x0100
148 #define CONTROL_WRITE_RTS 0x0200
152 * Reads from the CP2101 configuration registers
153 * 'size' is specified in bytes.
154 * 'data' is a pointer to a pre-allocated array of integers large
155 * enough to hold 'size' bytes (with 4 bytes to each integer)
157 static int cp2101_get_config(struct usb_serial_port* port, u8 request,
158 unsigned int *data, int size)
160 struct usb_serial *serial = port->serial;
162 int result, i, length;
164 /* Number of integers required to contain the array */
165 length = (((size - 1) | 3) + 1)/4;
167 buf = kmalloc (length * sizeof(u32), GFP_KERNEL);
168 memset(buf, 0, length * sizeof(u32));
171 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
175 /* For get requests, the request number must be incremented */
178 /* Issue the request, attempting to read 'size' bytes */
179 result = usb_control_msg (serial->dev,usb_rcvctrlpipe (serial->dev, 0),
180 request, REQTYPE_DEVICE_TO_HOST, 0x0000,
183 /* Convert data into an array of integers */
184 for (i=0; i<length; i++)
185 data[i] = le32_to_cpu(buf[i]);
189 if (result != size) {
190 dev_err(&port->dev, "%s - Unable to send config request, "
191 "request=0x%x size=%d result=%d\n",
192 __FUNCTION__, request, size, result);
201 * Writes to the CP2101 configuration registers
202 * Values less than 16 bits wide are sent directly
203 * 'size' is specified in bytes.
205 static int cp2101_set_config(struct usb_serial_port* port, u8 request,
206 unsigned int *data, int size)
208 struct usb_serial *serial = port->serial;
210 int result, i, length;
212 /* Number of integers required to contain the array */
213 length = (((size - 1) | 3) + 1)/4;
215 buf = kmalloc(length * sizeof(u32), GFP_KERNEL);
217 dev_err(&port->dev, "%s - out of memory.\n",
222 /* Array of integers into bytes */
223 for (i = 0; i < length; i++)
224 buf[i] = cpu_to_le32(data[i]);
227 result = usb_control_msg (serial->dev,
228 usb_sndctrlpipe(serial->dev, 0),
229 request, REQTYPE_HOST_TO_DEVICE, 0x0000,
232 result = usb_control_msg (serial->dev,
233 usb_sndctrlpipe(serial->dev, 0),
234 request, REQTYPE_HOST_TO_DEVICE, data[0],
240 if ((size > 2 && result != size) || result < 0) {
241 dev_err(&port->dev, "%s - Unable to send request, "
242 "request=0x%x size=%d result=%d\n",
243 __FUNCTION__, request, size, result);
247 /* Single data value */
248 result = usb_control_msg (serial->dev,
249 usb_sndctrlpipe(serial->dev, 0),
250 request, REQTYPE_HOST_TO_DEVICE, data[0],
256 * cp2101_set_config_single
257 * Convenience function for calling cp2101_set_config on single data values
258 * without requiring an integer pointer
260 static inline int cp2101_set_config_single(struct usb_serial_port* port,
261 u8 request, unsigned int data)
263 return cp2101_set_config(port, request, &data, 2);
266 static int cp2101_open (struct usb_serial_port *port, struct file *filp)
268 struct usb_serial *serial = port->serial;
271 dbg("%s - port %d", __FUNCTION__, port->number);
273 if (cp2101_set_config_single(port, CP2101_UART, UART_ENABLE)) {
274 dev_err(&port->dev, "%s - Unable to enable UART\n",
279 /* Start reading from the device */
280 usb_fill_bulk_urb (port->read_urb, serial->dev,
281 usb_rcvbulkpipe(serial->dev,
282 port->bulk_in_endpointAddress),
283 port->read_urb->transfer_buffer,
284 port->read_urb->transfer_buffer_length,
285 serial->type->read_bulk_callback,
287 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
289 dev_err(&port->dev, "%s - failed resubmitting read urb, "
290 "error %d\n", __FUNCTION__, result);
294 /* Configure the termios structure */
295 cp2101_get_termios(port);
297 /* Set the DTR and RTS pins low */
298 cp2101_tiocmset(port, NULL, TIOCM_DTR | TIOCM_RTS, 0);
303 static void cp2101_cleanup (struct usb_serial_port *port)
305 struct usb_serial *serial = port->serial;
307 dbg("%s - port %d", __FUNCTION__, port->number);
310 /* shutdown any bulk reads that might be going on */
311 if (serial->num_bulk_out)
312 usb_kill_urb(port->write_urb);
313 if (serial->num_bulk_in)
314 usb_kill_urb(port->read_urb);
318 static void cp2101_close (struct usb_serial_port *port, struct file * filp)
320 dbg("%s - port %d", __FUNCTION__, port->number);
322 /* shutdown our urbs */
323 dbg("%s - shutting down urbs", __FUNCTION__);
324 usb_kill_urb(port->write_urb);
325 usb_kill_urb(port->read_urb);
327 cp2101_set_config_single(port, CP2101_UART, UART_DISABLE);
332 * Reads the baud rate, data bits, parity, stop bits and flow control mode
333 * from the device, corrects any unsupported values, and configures the
334 * termios structure to reflect the state of the device
336 static void cp2101_get_termios (struct usb_serial_port *port)
338 unsigned int cflag, modem_ctl[4];
342 dbg("%s - port %d", __FUNCTION__, port->number);
344 if ((!port->tty) || (!port->tty->termios)) {
345 dbg("%s - no tty structures", __FUNCTION__);
348 cflag = port->tty->termios->c_cflag;
350 cp2101_get_config(port, CP2101_BAUDRATE, &baud, 2);
351 /* Convert to baudrate */
353 baud = BAUD_RATE_GEN_FREQ / baud;
355 dbg("%s - baud rate = %d", __FUNCTION__, baud);
359 * The baud rates which are commented out below
360 * appear to be supported by the device
361 * but are non-standard
363 case 600: cflag |= B600; break;
364 case 1200: cflag |= B1200; break;
365 case 1800: cflag |= B1800; break;
366 case 2400: cflag |= B2400; break;
367 case 4800: cflag |= B4800; break;
368 /*case 7200: cflag |= B7200; break;*/
369 case 9600: cflag |= B9600; break;
370 /*case 14400: cflag |= B14400; break;*/
371 case 19200: cflag |= B19200; break;
372 /*case 28800: cflag |= B28800; break;*/
373 case 38400: cflag |= B38400; break;
374 /*case 55854: cflag |= B55054; break;*/
375 case 57600: cflag |= B57600; break;
376 case 115200: cflag |= B115200; break;
377 /*case 127117: cflag |= B127117; break;*/
378 case 230400: cflag |= B230400; break;
379 case 460800: cflag |= B460800; break;
380 case 921600: cflag |= B921600; break;
381 /*case 3686400: cflag |= B3686400; break;*/
383 dbg("%s - Baud rate is not supported, "
384 "using 9600 baud", __FUNCTION__);
386 cp2101_set_config_single(port, CP2101_BAUDRATE,
387 (BAUD_RATE_GEN_FREQ/9600));
391 cp2101_get_config(port, CP2101_BITS, &bits, 2);
393 switch(bits & BITS_DATA_MASK) {
395 dbg("%s - data bits = 5", __FUNCTION__);
399 dbg("%s - data bits = 6", __FUNCTION__);
403 dbg("%s - data bits = 7", __FUNCTION__);
407 dbg("%s - data bits = 8", __FUNCTION__);
411 dbg("%s - data bits = 9 (not supported, "
412 "using 8 data bits)", __FUNCTION__);
414 bits &= ~BITS_DATA_MASK;
416 cp2101_set_config(port, CP2101_BITS, &bits, 2);
419 dbg("%s - Unknown number of data bits, "
420 "using 8", __FUNCTION__);
422 bits &= ~BITS_DATA_MASK;
424 cp2101_set_config(port, CP2101_BITS, &bits, 2);
428 switch(bits & BITS_PARITY_MASK) {
429 case BITS_PARITY_NONE:
430 dbg("%s - parity = NONE", __FUNCTION__);
433 case BITS_PARITY_ODD:
434 dbg("%s - parity = ODD", __FUNCTION__);
435 cflag |= (PARENB|PARODD);
437 case BITS_PARITY_EVEN:
438 dbg("%s - parity = EVEN", __FUNCTION__);
442 case BITS_PARITY_MARK:
443 dbg("%s - parity = MARK (not supported, "
444 "disabling parity)", __FUNCTION__);
446 bits &= ~BITS_PARITY_MASK;
447 cp2101_set_config(port, CP2101_BITS, &bits, 2);
449 case BITS_PARITY_SPACE:
450 dbg("%s - parity = SPACE (not supported, "
451 "disabling parity)", __FUNCTION__);
453 bits &= ~BITS_PARITY_MASK;
454 cp2101_set_config(port, CP2101_BITS, &bits, 2);
457 dbg("%s - Unknown parity mode, "
458 "disabling parity", __FUNCTION__);
460 bits &= ~BITS_PARITY_MASK;
461 cp2101_set_config(port, CP2101_BITS, &bits, 2);
466 switch(bits & BITS_STOP_MASK) {
468 dbg("%s - stop bits = 1", __FUNCTION__);
471 dbg("%s - stop bits = 1.5 (not supported, "
472 "using 1 stop bit)", __FUNCTION__);
473 bits &= ~BITS_STOP_MASK;
474 cp2101_set_config(port, CP2101_BITS, &bits, 2);
477 dbg("%s - stop bits = 2", __FUNCTION__);
481 dbg("%s - Unknown number of stop bits, "
482 "using 1 stop bit", __FUNCTION__);
483 bits &= ~BITS_STOP_MASK;
484 cp2101_set_config(port, CP2101_BITS, &bits, 2);
488 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
489 if (modem_ctl[0] & 0x0008) {
490 dbg("%s - flow control = CRTSCTS", __FUNCTION__);
493 dbg("%s - flow control = NONE", __FUNCTION__);
497 port->tty->termios->c_cflag = cflag;
500 static void cp2101_set_termios (struct usb_serial_port *port,
501 struct termios *old_termios)
503 unsigned int cflag, old_cflag=0;
505 unsigned int modem_ctl[4];
507 dbg("%s - port %d", __FUNCTION__, port->number);
509 if ((!port->tty) || (!port->tty->termios)) {
510 dbg("%s - no tty structures", __FUNCTION__);
513 cflag = port->tty->termios->c_cflag;
515 /* Check that they really want us to change something */
517 if ((cflag == old_termios->c_cflag) &&
518 (RELEVANT_IFLAG(port->tty->termios->c_iflag)
519 == RELEVANT_IFLAG(old_termios->c_iflag))) {
520 dbg("%s - nothing to change...", __FUNCTION__);
524 old_cflag = old_termios->c_cflag;
527 /* If the baud rate is to be updated*/
528 if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
529 switch (cflag & CBAUD) {
531 * The baud rates which are commented out below
532 * appear to be supported by the device
533 * but are non-standard
535 case B0: baud = 0; break;
536 case B600: baud = 600; break;
537 case B1200: baud = 1200; break;
538 case B1800: baud = 1800; break;
539 case B2400: baud = 2400; break;
540 case B4800: baud = 4800; break;
541 /*case B7200: baud = 7200; break;*/
542 case B9600: baud = 9600; break;
543 /*ase B14400: baud = 14400; break;*/
544 case B19200: baud = 19200; break;
545 /*case B28800: baud = 28800; break;*/
546 case B38400: baud = 38400; break;
547 /*case B55854: baud = 55054; break;*/
548 case B57600: baud = 57600; break;
549 case B115200: baud = 115200; break;
550 /*case B127117: baud = 127117; break;*/
551 case B230400: baud = 230400; break;
552 case B460800: baud = 460800; break;
553 case B921600: baud = 921600; break;
554 /*case B3686400: baud = 3686400; break;*/
556 dev_err(&port->dev, "cp2101 driver does not "
557 "support the baudrate requested\n");
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");