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 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
64 { } /* Terminating Entry */
67 MODULE_DEVICE_TABLE (usb, id_table);
69 static struct usb_driver cp2101_driver = {
71 .probe = usb_serial_probe,
72 .disconnect = usb_serial_disconnect,
77 static struct usb_serial_driver cp2101_device = {
83 .num_interrupt_in = 0,
88 .close = cp2101_close,
89 .break_ctl = cp2101_break_ctl,
90 .set_termios = cp2101_set_termios,
91 .tiocmget = cp2101_tiocmget,
92 .tiocmset = cp2101_tiocmset,
93 .attach = cp2101_startup,
94 .shutdown = cp2101_shutdown,
97 /* Config request types */
98 #define REQTYPE_HOST_TO_DEVICE 0x41
99 #define REQTYPE_DEVICE_TO_HOST 0xc1
101 /* Config SET requests. To GET, add 1 to the request number */
102 #define CP2101_UART 0x00 /* Enable / Disable */
103 #define CP2101_BAUDRATE 0x01 /* (BAUD_RATE_GEN_FREQ / baudrate) */
104 #define CP2101_BITS 0x03 /* 0x(0)(databits)(parity)(stopbits) */
105 #define CP2101_BREAK 0x05 /* On / Off */
106 #define CP2101_CONTROL 0x07 /* Flow control line states */
107 #define CP2101_MODEMCTL 0x13 /* Modem controls */
108 #define CP2101_CONFIG_6 0x19 /* 6 bytes of config data ??? */
111 #define UART_ENABLE 0x0001
112 #define UART_DISABLE 0x0000
114 /* CP2101_BAUDRATE */
115 #define BAUD_RATE_GEN_FREQ 0x384000
118 #define BITS_DATA_MASK 0X0f00
119 #define BITS_DATA_5 0X0500
120 #define BITS_DATA_6 0X0600
121 #define BITS_DATA_7 0X0700
122 #define BITS_DATA_8 0X0800
123 #define BITS_DATA_9 0X0900
125 #define BITS_PARITY_MASK 0x00f0
126 #define BITS_PARITY_NONE 0x0000
127 #define BITS_PARITY_ODD 0x0010
128 #define BITS_PARITY_EVEN 0x0020
129 #define BITS_PARITY_MARK 0x0030
130 #define BITS_PARITY_SPACE 0x0040
132 #define BITS_STOP_MASK 0x000f
133 #define BITS_STOP_1 0x0000
134 #define BITS_STOP_1_5 0x0001
135 #define BITS_STOP_2 0x0002
138 #define BREAK_ON 0x0000
139 #define BREAK_OFF 0x0001
142 #define CONTROL_DTR 0x0001
143 #define CONTROL_RTS 0x0002
144 #define CONTROL_CTS 0x0010
145 #define CONTROL_DSR 0x0020
146 #define CONTROL_RING 0x0040
147 #define CONTROL_DCD 0x0080
148 #define CONTROL_WRITE_DTR 0x0100
149 #define CONTROL_WRITE_RTS 0x0200
153 * Reads from the CP2101 configuration registers
154 * 'size' is specified in bytes.
155 * 'data' is a pointer to a pre-allocated array of integers large
156 * enough to hold 'size' bytes (with 4 bytes to each integer)
158 static int cp2101_get_config(struct usb_serial_port* port, u8 request,
159 unsigned int *data, int size)
161 struct usb_serial *serial = port->serial;
163 int result, i, length;
165 /* Number of integers required to contain the array */
166 length = (((size - 1) | 3) + 1)/4;
168 buf = kmalloc (length * sizeof(u32), GFP_KERNEL);
169 memset(buf, 0, length * sizeof(u32));
172 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
176 /* For get requests, the request number must be incremented */
179 /* Issue the request, attempting to read 'size' bytes */
180 result = usb_control_msg (serial->dev,usb_rcvctrlpipe (serial->dev, 0),
181 request, REQTYPE_DEVICE_TO_HOST, 0x0000,
184 /* Convert data into an array of integers */
185 for (i=0; i<length; i++)
186 data[i] = le32_to_cpu(buf[i]);
190 if (result != size) {
191 dev_err(&port->dev, "%s - Unable to send config request, "
192 "request=0x%x size=%d result=%d\n",
193 __FUNCTION__, request, size, result);
202 * Writes to the CP2101 configuration registers
203 * Values less than 16 bits wide are sent directly
204 * 'size' is specified in bytes.
206 static int cp2101_set_config(struct usb_serial_port* port, u8 request,
207 unsigned int *data, int size)
209 struct usb_serial *serial = port->serial;
211 int result, i, length;
213 /* Number of integers required to contain the array */
214 length = (((size - 1) | 3) + 1)/4;
216 buf = kmalloc(length * sizeof(u32), GFP_KERNEL);
218 dev_err(&port->dev, "%s - out of memory.\n",
223 /* Array of integers into bytes */
224 for (i = 0; i < length; i++)
225 buf[i] = cpu_to_le32(data[i]);
228 result = usb_control_msg (serial->dev,
229 usb_sndctrlpipe(serial->dev, 0),
230 request, REQTYPE_HOST_TO_DEVICE, 0x0000,
233 result = usb_control_msg (serial->dev,
234 usb_sndctrlpipe(serial->dev, 0),
235 request, REQTYPE_HOST_TO_DEVICE, data[0],
241 if ((size > 2 && result != size) || result < 0) {
242 dev_err(&port->dev, "%s - Unable to send request, "
243 "request=0x%x size=%d result=%d\n",
244 __FUNCTION__, request, size, result);
248 /* Single data value */
249 result = usb_control_msg (serial->dev,
250 usb_sndctrlpipe(serial->dev, 0),
251 request, REQTYPE_HOST_TO_DEVICE, data[0],
257 * cp2101_set_config_single
258 * Convenience function for calling cp2101_set_config on single data values
259 * without requiring an integer pointer
261 static inline int cp2101_set_config_single(struct usb_serial_port* port,
262 u8 request, unsigned int data)
264 return cp2101_set_config(port, request, &data, 2);
267 static int cp2101_open (struct usb_serial_port *port, struct file *filp)
269 struct usb_serial *serial = port->serial;
272 dbg("%s - port %d", __FUNCTION__, port->number);
274 if (cp2101_set_config_single(port, CP2101_UART, UART_ENABLE)) {
275 dev_err(&port->dev, "%s - Unable to enable UART\n",
280 /* Start reading from the device */
281 usb_fill_bulk_urb (port->read_urb, serial->dev,
282 usb_rcvbulkpipe(serial->dev,
283 port->bulk_in_endpointAddress),
284 port->read_urb->transfer_buffer,
285 port->read_urb->transfer_buffer_length,
286 serial->type->read_bulk_callback,
288 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
290 dev_err(&port->dev, "%s - failed resubmitting read urb, "
291 "error %d\n", __FUNCTION__, result);
295 /* Configure the termios structure */
296 cp2101_get_termios(port);
298 /* Set the DTR and RTS pins low */
299 cp2101_tiocmset(port, NULL, TIOCM_DTR | TIOCM_RTS, 0);
304 static void cp2101_cleanup (struct usb_serial_port *port)
306 struct usb_serial *serial = port->serial;
308 dbg("%s - port %d", __FUNCTION__, port->number);
311 /* shutdown any bulk reads that might be going on */
312 if (serial->num_bulk_out)
313 usb_kill_urb(port->write_urb);
314 if (serial->num_bulk_in)
315 usb_kill_urb(port->read_urb);
319 static void cp2101_close (struct usb_serial_port *port, struct file * filp)
321 dbg("%s - port %d", __FUNCTION__, port->number);
323 /* shutdown our urbs */
324 dbg("%s - shutting down urbs", __FUNCTION__);
325 usb_kill_urb(port->write_urb);
326 usb_kill_urb(port->read_urb);
328 cp2101_set_config_single(port, CP2101_UART, UART_DISABLE);
333 * Reads the baud rate, data bits, parity, stop bits and flow control mode
334 * from the device, corrects any unsupported values, and configures the
335 * termios structure to reflect the state of the device
337 static void cp2101_get_termios (struct usb_serial_port *port)
339 unsigned int cflag, modem_ctl[4];
343 dbg("%s - port %d", __FUNCTION__, port->number);
345 if ((!port->tty) || (!port->tty->termios)) {
346 dbg("%s - no tty structures", __FUNCTION__);
349 cflag = port->tty->termios->c_cflag;
351 cp2101_get_config(port, CP2101_BAUDRATE, &baud, 2);
352 /* Convert to baudrate */
354 baud = BAUD_RATE_GEN_FREQ / baud;
356 dbg("%s - baud rate = %d", __FUNCTION__, baud);
360 * The baud rates which are commented out below
361 * appear to be supported by the device
362 * but are non-standard
364 case 600: cflag |= B600; break;
365 case 1200: cflag |= B1200; break;
366 case 1800: cflag |= B1800; break;
367 case 2400: cflag |= B2400; break;
368 case 4800: cflag |= B4800; break;
369 /*case 7200: cflag |= B7200; break;*/
370 case 9600: cflag |= B9600; break;
371 /*case 14400: cflag |= B14400; break;*/
372 case 19200: cflag |= B19200; break;
373 /*case 28800: cflag |= B28800; break;*/
374 case 38400: cflag |= B38400; break;
375 /*case 55854: cflag |= B55054; break;*/
376 case 57600: cflag |= B57600; break;
377 case 115200: cflag |= B115200; break;
378 /*case 127117: cflag |= B127117; break;*/
379 case 230400: cflag |= B230400; break;
380 case 460800: cflag |= B460800; break;
381 case 921600: cflag |= B921600; break;
382 /*case 3686400: cflag |= B3686400; break;*/
384 dbg("%s - Baud rate is not supported, "
385 "using 9600 baud", __FUNCTION__);
387 cp2101_set_config_single(port, CP2101_BAUDRATE,
388 (BAUD_RATE_GEN_FREQ/9600));
392 cp2101_get_config(port, CP2101_BITS, &bits, 2);
394 switch(bits & BITS_DATA_MASK) {
396 dbg("%s - data bits = 5", __FUNCTION__);
400 dbg("%s - data bits = 6", __FUNCTION__);
404 dbg("%s - data bits = 7", __FUNCTION__);
408 dbg("%s - data bits = 8", __FUNCTION__);
412 dbg("%s - data bits = 9 (not supported, "
413 "using 8 data bits)", __FUNCTION__);
415 bits &= ~BITS_DATA_MASK;
417 cp2101_set_config(port, CP2101_BITS, &bits, 2);
420 dbg("%s - Unknown number of data bits, "
421 "using 8", __FUNCTION__);
423 bits &= ~BITS_DATA_MASK;
425 cp2101_set_config(port, CP2101_BITS, &bits, 2);
429 switch(bits & BITS_PARITY_MASK) {
430 case BITS_PARITY_NONE:
431 dbg("%s - parity = NONE", __FUNCTION__);
434 case BITS_PARITY_ODD:
435 dbg("%s - parity = ODD", __FUNCTION__);
436 cflag |= (PARENB|PARODD);
438 case BITS_PARITY_EVEN:
439 dbg("%s - parity = EVEN", __FUNCTION__);
443 case BITS_PARITY_MARK:
444 dbg("%s - parity = MARK (not supported, "
445 "disabling parity)", __FUNCTION__);
447 bits &= ~BITS_PARITY_MASK;
448 cp2101_set_config(port, CP2101_BITS, &bits, 2);
450 case BITS_PARITY_SPACE:
451 dbg("%s - parity = SPACE (not supported, "
452 "disabling parity)", __FUNCTION__);
454 bits &= ~BITS_PARITY_MASK;
455 cp2101_set_config(port, CP2101_BITS, &bits, 2);
458 dbg("%s - Unknown parity mode, "
459 "disabling parity", __FUNCTION__);
461 bits &= ~BITS_PARITY_MASK;
462 cp2101_set_config(port, CP2101_BITS, &bits, 2);
467 switch(bits & BITS_STOP_MASK) {
469 dbg("%s - stop bits = 1", __FUNCTION__);
472 dbg("%s - stop bits = 1.5 (not supported, "
473 "using 1 stop bit)", __FUNCTION__);
474 bits &= ~BITS_STOP_MASK;
475 cp2101_set_config(port, CP2101_BITS, &bits, 2);
478 dbg("%s - stop bits = 2", __FUNCTION__);
482 dbg("%s - Unknown number of stop bits, "
483 "using 1 stop bit", __FUNCTION__);
484 bits &= ~BITS_STOP_MASK;
485 cp2101_set_config(port, CP2101_BITS, &bits, 2);
489 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
490 if (modem_ctl[0] & 0x0008) {
491 dbg("%s - flow control = CRTSCTS", __FUNCTION__);
494 dbg("%s - flow control = NONE", __FUNCTION__);
498 port->tty->termios->c_cflag = cflag;
501 static void cp2101_set_termios (struct usb_serial_port *port,
502 struct termios *old_termios)
504 unsigned int cflag, old_cflag=0;
506 unsigned int modem_ctl[4];
508 dbg("%s - port %d", __FUNCTION__, port->number);
510 if ((!port->tty) || (!port->tty->termios)) {
511 dbg("%s - no tty structures", __FUNCTION__);
514 cflag = port->tty->termios->c_cflag;
516 /* Check that they really want us to change something */
518 if ((cflag == old_termios->c_cflag) &&
519 (RELEVANT_IFLAG(port->tty->termios->c_iflag)
520 == RELEVANT_IFLAG(old_termios->c_iflag))) {
521 dbg("%s - nothing to change...", __FUNCTION__);
525 old_cflag = old_termios->c_cflag;
528 /* If the baud rate is to be updated*/
529 if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
530 switch (cflag & CBAUD) {
532 * The baud rates which are commented out below
533 * appear to be supported by the device
534 * but are non-standard
536 case B0: baud = 0; break;
537 case B600: baud = 600; break;
538 case B1200: baud = 1200; break;
539 case B1800: baud = 1800; break;
540 case B2400: baud = 2400; break;
541 case B4800: baud = 4800; break;
542 /*case B7200: baud = 7200; break;*/
543 case B9600: baud = 9600; break;
544 /*ase B14400: baud = 14400; break;*/
545 case B19200: baud = 19200; break;
546 /*case B28800: baud = 28800; break;*/
547 case B38400: baud = 38400; break;
548 /*case B55854: baud = 55054; break;*/
549 case B57600: baud = 57600; break;
550 case B115200: baud = 115200; break;
551 /*case B127117: baud = 127117; break;*/
552 case B230400: baud = 230400; break;
553 case B460800: baud = 460800; break;
554 case B921600: baud = 921600; break;
555 /*case B3686400: baud = 3686400; break;*/
557 dev_err(&port->dev, "cp2101 driver does not "
558 "support the baudrate requested\n");
563 dbg("%s - Setting baud rate to %d baud", __FUNCTION__,
565 if (cp2101_set_config_single(port, CP2101_BAUDRATE,
566 (BAUD_RATE_GEN_FREQ / baud)))
567 dev_err(&port->dev, "Baud rate requested not "
568 "supported by device\n");
572 /* If the number of data bits is to be updated */
573 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
574 cp2101_get_config(port, CP2101_BITS, &bits, 2);
575 bits &= ~BITS_DATA_MASK;
576 switch (cflag & CSIZE) {
579 dbg("%s - data bits = 5", __FUNCTION__);
583 dbg("%s - data bits = 6", __FUNCTION__);
587 dbg("%s - data bits = 7", __FUNCTION__);
591 dbg("%s - data bits = 8", __FUNCTION__);
595 dbg("%s - data bits = 9", __FUNCTION__);
598 dev_err(&port->dev, "cp2101 driver does not "
599 "support the number of bits requested,"
600 " using 8 bit mode\n");
604 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
605 dev_err(&port->dev, "Number of data bits requested "
606 "not supported by device\n");
609 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))) {
610 cp2101_get_config(port, CP2101_BITS, &bits, 2);
611 bits &= ~BITS_PARITY_MASK;
612 if (cflag & PARENB) {
613 if (cflag & PARODD) {
614 bits |= BITS_PARITY_ODD;
615 dbg("%s - parity = ODD", __FUNCTION__);
617 bits |= BITS_PARITY_EVEN;
618 dbg("%s - parity = EVEN", __FUNCTION__);
621 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
622 dev_err(&port->dev, "Parity mode not supported "
626 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
627 cp2101_get_config(port, CP2101_BITS, &bits, 2);
628 bits &= ~BITS_STOP_MASK;
629 if (cflag & CSTOPB) {
631 dbg("%s - stop bits = 2", __FUNCTION__);
634 dbg("%s - stop bits = 1", __FUNCTION__);
636 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
637 dev_err(&port->dev, "Number of stop bits requested "
638 "not supported by device\n");
641 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
642 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
643 dbg("%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
644 __FUNCTION__, modem_ctl[0], modem_ctl[1],
645 modem_ctl[2], modem_ctl[3]);
647 if (cflag & CRTSCTS) {
648 modem_ctl[0] &= ~0x7B;
649 modem_ctl[0] |= 0x09;
651 dbg("%s - flow control = CRTSCTS", __FUNCTION__);
653 modem_ctl[0] &= ~0x7B;
654 modem_ctl[0] |= 0x01;
655 modem_ctl[1] |= 0x40;
656 dbg("%s - flow control = NONE", __FUNCTION__);
659 dbg("%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
660 __FUNCTION__, modem_ctl[0], modem_ctl[1],
661 modem_ctl[2], modem_ctl[3]);
662 cp2101_set_config(port, CP2101_MODEMCTL, modem_ctl, 16);
667 static int cp2101_tiocmset (struct usb_serial_port *port, struct file *file,
668 unsigned int set, unsigned int clear)
672 dbg("%s - port %d", __FUNCTION__, port->number);
674 if (set & TIOCM_RTS) {
675 control |= CONTROL_RTS;
676 control |= CONTROL_WRITE_RTS;
678 if (set & TIOCM_DTR) {
679 control |= CONTROL_DTR;
680 control |= CONTROL_WRITE_DTR;
682 if (clear & TIOCM_RTS) {
683 control &= ~CONTROL_RTS;
684 control |= CONTROL_WRITE_RTS;
686 if (clear & TIOCM_DTR) {
687 control &= ~CONTROL_DTR;
688 control |= CONTROL_WRITE_DTR;
691 dbg("%s - control = 0x%.4x", __FUNCTION__, control);
693 return cp2101_set_config(port, CP2101_CONTROL, &control, 2);
697 static int cp2101_tiocmget (struct usb_serial_port *port, struct file *file)
701 dbg("%s - port %d", __FUNCTION__, port->number);
703 cp2101_get_config(port, CP2101_CONTROL, &control, 1);
705 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
706 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
707 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
708 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
709 |((control & CONTROL_RING)? TIOCM_RI : 0)
710 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
712 dbg("%s - control = 0x%.2x", __FUNCTION__, control);
717 static void cp2101_break_ctl (struct usb_serial_port *port, int break_state)
721 dbg("%s - port %d", __FUNCTION__, port->number);
722 if (break_state == 0)
726 dbg("%s - turning break %s", __FUNCTION__,
727 state==BREAK_OFF ? "off" : "on");
728 cp2101_set_config(port, CP2101_BREAK, &state, 2);
731 static int cp2101_startup (struct usb_serial *serial)
733 /* CP2101 buffers behave strangely unless device is reset */
734 usb_reset_device(serial->dev);
738 static void cp2101_shutdown (struct usb_serial *serial)
742 dbg("%s", __FUNCTION__);
744 /* Stop reads and writes on all ports */
745 for (i=0; i < serial->num_ports; ++i) {
746 cp2101_cleanup(serial->port[i]);
750 static int __init cp2101_init (void)
754 retval = usb_serial_register(&cp2101_device);
756 return retval; /* Failed to register */
758 retval = usb_register(&cp2101_driver);
760 /* Failed to register */
761 usb_serial_deregister(&cp2101_device);
766 info(DRIVER_DESC " " DRIVER_VERSION);
770 static void __exit cp2101_exit (void)
772 usb_deregister (&cp2101_driver);
773 usb_serial_deregister (&cp2101_device);
776 module_init(cp2101_init);
777 module_exit(cp2101_exit);
779 MODULE_DESCRIPTION(DRIVER_DESC);
780 MODULE_VERSION(DRIVER_VERSION);
781 MODULE_LICENSE("GPL");
783 module_param(debug, bool, S_IRUGO | S_IWUSR);
784 MODULE_PARM_DESC(debug, "Enable verbose debugging messages");