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_device_type cp2101_device = {
80 .num_interrupt_in = 0,
85 .close = cp2101_close,
86 .break_ctl = cp2101_break_ctl,
87 .set_termios = cp2101_set_termios,
88 .tiocmget = cp2101_tiocmget,
89 .tiocmset = cp2101_tiocmset,
90 .attach = cp2101_startup,
91 .shutdown = cp2101_shutdown,
94 /* Config request types */
95 #define REQTYPE_HOST_TO_DEVICE 0x41
96 #define REQTYPE_DEVICE_TO_HOST 0xc1
98 /* Config SET requests. To GET, add 1 to the request number */
99 #define CP2101_UART 0x00 /* Enable / Disable */
100 #define CP2101_BAUDRATE 0x01 /* (BAUD_RATE_GEN_FREQ / baudrate) */
101 #define CP2101_BITS 0x03 /* 0x(0)(databits)(parity)(stopbits) */
102 #define CP2101_BREAK 0x05 /* On / Off */
103 #define CP2101_CONTROL 0x07 /* Flow control line states */
104 #define CP2101_MODEMCTL 0x13 /* Modem controls */
105 #define CP2101_CONFIG_6 0x19 /* 6 bytes of config data ??? */
108 #define UART_ENABLE 0x0001
109 #define UART_DISABLE 0x0000
111 /* CP2101_BAUDRATE */
112 #define BAUD_RATE_GEN_FREQ 0x384000
115 #define BITS_DATA_MASK 0X0f00
116 #define BITS_DATA_5 0X0500
117 #define BITS_DATA_6 0X0600
118 #define BITS_DATA_7 0X0700
119 #define BITS_DATA_8 0X0800
120 #define BITS_DATA_9 0X0900
122 #define BITS_PARITY_MASK 0x00f0
123 #define BITS_PARITY_NONE 0x0000
124 #define BITS_PARITY_ODD 0x0010
125 #define BITS_PARITY_EVEN 0x0020
126 #define BITS_PARITY_MARK 0x0030
127 #define BITS_PARITY_SPACE 0x0040
129 #define BITS_STOP_MASK 0x000f
130 #define BITS_STOP_1 0x0000
131 #define BITS_STOP_1_5 0x0001
132 #define BITS_STOP_2 0x0002
135 #define BREAK_ON 0x0000
136 #define BREAK_OFF 0x0001
139 #define CONTROL_DTR 0x0001
140 #define CONTROL_RTS 0x0002
141 #define CONTROL_CTS 0x0010
142 #define CONTROL_DSR 0x0020
143 #define CONTROL_RING 0x0040
144 #define CONTROL_DCD 0x0080
145 #define CONTROL_WRITE_DTR 0x0100
146 #define CONTROL_WRITE_RTS 0x0200
150 * Reads from the CP2101 configuration registers
151 * 'size' is specified in bytes.
152 * 'data' is a pointer to a pre-allocated array of integers large
153 * enough to hold 'size' bytes (with 4 bytes to each integer)
155 static int cp2101_get_config(struct usb_serial_port* port, u8 request,
156 unsigned int *data, int size)
158 struct usb_serial *serial = port->serial;
160 int result, i, length;
162 /* Number of integers required to contain the array */
163 length = (((size - 1) | 3) + 1)/4;
165 buf = kmalloc (length * sizeof(u32), GFP_KERNEL);
166 memset(buf, 0, length * sizeof(u32));
169 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
173 /* For get requests, the request number must be incremented */
176 /* Issue the request, attempting to read 'size' bytes */
177 result = usb_control_msg (serial->dev,usb_rcvctrlpipe (serial->dev, 0),
178 request, REQTYPE_DEVICE_TO_HOST, 0x0000,
181 /* Convert data into an array of integers */
182 for (i=0; i<length; i++)
183 data[i] = le32_to_cpu(buf[i]);
187 if (result != size) {
188 dev_err(&port->dev, "%s - Unable to send config request, "
189 "request=0x%x size=%d result=%d\n",
190 __FUNCTION__, request, size, result);
199 * Writes to the CP2101 configuration registers
200 * Values less than 16 bits wide are sent directly
201 * 'size' is specified in bytes.
203 static int cp2101_set_config(struct usb_serial_port* port, u8 request,
204 unsigned int *data, int size)
206 struct usb_serial *serial = port->serial;
208 int result, i, length;
210 /* Number of integers required to contain the array */
211 length = (((size - 1) | 3) + 1)/4;
213 buf = kmalloc(length * sizeof(u32), GFP_KERNEL);
215 dev_err(&port->dev, "%s - out of memory.\n",
220 /* Array of integers into bytes */
221 for (i = 0; i < length; i++)
222 buf[i] = cpu_to_le32(data[i]);
225 result = usb_control_msg (serial->dev,
226 usb_sndctrlpipe(serial->dev, 0),
227 request, REQTYPE_HOST_TO_DEVICE, 0x0000,
230 result = usb_control_msg (serial->dev,
231 usb_sndctrlpipe(serial->dev, 0),
232 request, REQTYPE_HOST_TO_DEVICE, data[0],
238 if ((size > 2 && result != size) || result < 0) {
239 dev_err(&port->dev, "%s - Unable to send request, "
240 "request=0x%x size=%d result=%d\n",
241 __FUNCTION__, request, size, result);
245 /* Single data value */
246 result = usb_control_msg (serial->dev,
247 usb_sndctrlpipe(serial->dev, 0),
248 request, REQTYPE_HOST_TO_DEVICE, data[0],
254 * cp2101_set_config_single
255 * Convenience function for calling cp2101_set_config on single data values
256 * without requiring an integer pointer
258 static inline int cp2101_set_config_single(struct usb_serial_port* port,
259 u8 request, unsigned int data)
261 return cp2101_set_config(port, request, &data, 2);
264 static int cp2101_open (struct usb_serial_port *port, struct file *filp)
266 struct usb_serial *serial = port->serial;
269 dbg("%s - port %d", __FUNCTION__, port->number);
271 if (cp2101_set_config_single(port, CP2101_UART, UART_ENABLE)) {
272 dev_err(&port->dev, "%s - Unable to enable UART\n",
277 /* Start reading from the device */
278 usb_fill_bulk_urb (port->read_urb, serial->dev,
279 usb_rcvbulkpipe(serial->dev,
280 port->bulk_in_endpointAddress),
281 port->read_urb->transfer_buffer,
282 port->read_urb->transfer_buffer_length,
283 serial->type->read_bulk_callback,
285 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
287 dev_err(&port->dev, "%s - failed resubmitting read urb, "
288 "error %d\n", __FUNCTION__, result);
292 /* Configure the termios structure */
293 cp2101_get_termios(port);
295 /* Set the DTR and RTS pins low */
296 cp2101_tiocmset(port, NULL, TIOCM_DTR | TIOCM_RTS, 0);
301 static void cp2101_cleanup (struct usb_serial_port *port)
303 struct usb_serial *serial = port->serial;
305 dbg("%s - port %d", __FUNCTION__, port->number);
308 /* shutdown any bulk reads that might be going on */
309 if (serial->num_bulk_out)
310 usb_kill_urb(port->write_urb);
311 if (serial->num_bulk_in)
312 usb_kill_urb(port->read_urb);
316 static void cp2101_close (struct usb_serial_port *port, struct file * filp)
318 dbg("%s - port %d", __FUNCTION__, port->number);
320 /* shutdown our urbs */
321 dbg("%s - shutting down urbs", __FUNCTION__);
322 usb_kill_urb(port->write_urb);
323 usb_kill_urb(port->read_urb);
325 cp2101_set_config_single(port, CP2101_UART, UART_DISABLE);
330 * Reads the baud rate, data bits, parity, stop bits and flow control mode
331 * from the device, corrects any unsupported values, and configures the
332 * termios structure to reflect the state of the device
334 static void cp2101_get_termios (struct usb_serial_port *port)
336 unsigned int cflag, modem_ctl[4];
340 dbg("%s - port %d", __FUNCTION__, port->number);
342 if ((!port->tty) || (!port->tty->termios)) {
343 dbg("%s - no tty structures", __FUNCTION__);
346 cflag = port->tty->termios->c_cflag;
348 cp2101_get_config(port, CP2101_BAUDRATE, &baud, 2);
349 /* Convert to baudrate */
351 baud = BAUD_RATE_GEN_FREQ / baud;
353 dbg("%s - baud rate = %d", __FUNCTION__, baud);
357 * The baud rates which are commented out below
358 * appear to be supported by the device
359 * but are non-standard
361 case 600: cflag |= B600; break;
362 case 1200: cflag |= B1200; break;
363 case 1800: cflag |= B1800; break;
364 case 2400: cflag |= B2400; break;
365 case 4800: cflag |= B4800; break;
366 /*case 7200: cflag |= B7200; break;*/
367 case 9600: cflag |= B9600; break;
368 /*case 14400: cflag |= B14400; break;*/
369 case 19200: cflag |= B19200; break;
370 /*case 28800: cflag |= B28800; break;*/
371 case 38400: cflag |= B38400; break;
372 /*case 55854: cflag |= B55054; break;*/
373 case 57600: cflag |= B57600; break;
374 case 115200: cflag |= B115200; break;
375 /*case 127117: cflag |= B127117; break;*/
376 case 230400: cflag |= B230400; break;
377 case 460800: cflag |= B460800; break;
378 case 921600: cflag |= B921600; break;
379 /*case 3686400: cflag |= B3686400; break;*/
381 dbg("%s - Baud rate is not supported, "
382 "using 9600 baud", __FUNCTION__);
384 cp2101_set_config_single(port, CP2101_BAUDRATE,
385 (BAUD_RATE_GEN_FREQ/9600));
389 cp2101_get_config(port, CP2101_BITS, &bits, 2);
391 switch(bits & BITS_DATA_MASK) {
393 dbg("%s - data bits = 5", __FUNCTION__);
397 dbg("%s - data bits = 6", __FUNCTION__);
401 dbg("%s - data bits = 7", __FUNCTION__);
405 dbg("%s - data bits = 8", __FUNCTION__);
409 dbg("%s - data bits = 9 (not supported, "
410 "using 8 data bits)", __FUNCTION__);
412 bits &= ~BITS_DATA_MASK;
414 cp2101_set_config(port, CP2101_BITS, &bits, 2);
417 dbg("%s - Unknown number of data bits, "
418 "using 8", __FUNCTION__);
420 bits &= ~BITS_DATA_MASK;
422 cp2101_set_config(port, CP2101_BITS, &bits, 2);
426 switch(bits & BITS_PARITY_MASK) {
427 case BITS_PARITY_NONE:
428 dbg("%s - parity = NONE", __FUNCTION__);
431 case BITS_PARITY_ODD:
432 dbg("%s - parity = ODD", __FUNCTION__);
433 cflag |= (PARENB|PARODD);
435 case BITS_PARITY_EVEN:
436 dbg("%s - parity = EVEN", __FUNCTION__);
440 case BITS_PARITY_MARK:
441 dbg("%s - parity = MARK (not supported, "
442 "disabling parity)", __FUNCTION__);
444 bits &= ~BITS_PARITY_MASK;
445 cp2101_set_config(port, CP2101_BITS, &bits, 2);
447 case BITS_PARITY_SPACE:
448 dbg("%s - parity = SPACE (not supported, "
449 "disabling parity)", __FUNCTION__);
451 bits &= ~BITS_PARITY_MASK;
452 cp2101_set_config(port, CP2101_BITS, &bits, 2);
455 dbg("%s - Unknown parity mode, "
456 "disabling parity", __FUNCTION__);
458 bits &= ~BITS_PARITY_MASK;
459 cp2101_set_config(port, CP2101_BITS, &bits, 2);
464 switch(bits & BITS_STOP_MASK) {
466 dbg("%s - stop bits = 1", __FUNCTION__);
469 dbg("%s - stop bits = 1.5 (not supported, "
470 "using 1 stop bit)", __FUNCTION__);
471 bits &= ~BITS_STOP_MASK;
472 cp2101_set_config(port, CP2101_BITS, &bits, 2);
475 dbg("%s - stop bits = 2", __FUNCTION__);
479 dbg("%s - Unknown number of stop bits, "
480 "using 1 stop bit", __FUNCTION__);
481 bits &= ~BITS_STOP_MASK;
482 cp2101_set_config(port, CP2101_BITS, &bits, 2);
486 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
487 if (modem_ctl[0] & 0x0008) {
488 dbg("%s - flow control = CRTSCTS", __FUNCTION__);
491 dbg("%s - flow control = NONE", __FUNCTION__);
495 port->tty->termios->c_cflag = cflag;
498 static void cp2101_set_termios (struct usb_serial_port *port,
499 struct termios *old_termios)
501 unsigned int cflag, old_cflag=0;
503 unsigned int modem_ctl[4];
505 dbg("%s - port %d", __FUNCTION__, port->number);
507 if ((!port->tty) || (!port->tty->termios)) {
508 dbg("%s - no tty structures", __FUNCTION__);
511 cflag = port->tty->termios->c_cflag;
513 /* Check that they really want us to change something */
515 if ((cflag == old_termios->c_cflag) &&
516 (RELEVANT_IFLAG(port->tty->termios->c_iflag)
517 == RELEVANT_IFLAG(old_termios->c_iflag))) {
518 dbg("%s - nothing to change...", __FUNCTION__);
522 old_cflag = old_termios->c_cflag;
525 /* If the baud rate is to be updated*/
526 if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
527 switch (cflag & CBAUD) {
529 * The baud rates which are commented out below
530 * appear to be supported by the device
531 * but are non-standard
533 case B0: baud = 0; break;
534 case B600: baud = 600; break;
535 case B1200: baud = 1200; break;
536 case B1800: baud = 1800; break;
537 case B2400: baud = 2400; break;
538 case B4800: baud = 4800; break;
539 /*case B7200: baud = 7200; break;*/
540 case B9600: baud = 9600; break;
541 /*ase B14400: baud = 14400; break;*/
542 case B19200: baud = 19200; break;
543 /*case B28800: baud = 28800; break;*/
544 case B38400: baud = 38400; break;
545 /*case B55854: baud = 55054; break;*/
546 case B57600: baud = 57600; break;
547 case B115200: baud = 115200; break;
548 /*case B127117: baud = 127117; break;*/
549 case B230400: baud = 230400; break;
550 case B460800: baud = 460800; break;
551 case B921600: baud = 921600; break;
552 /*case B3686400: baud = 3686400; break;*/
554 dev_err(&port->dev, "cp2101 driver does not "
555 "support the baudrate requested\n");
560 dbg("%s - Setting baud rate to %d baud", __FUNCTION__,
562 if (cp2101_set_config_single(port, CP2101_BAUDRATE,
563 (BAUD_RATE_GEN_FREQ / baud)))
564 dev_err(&port->dev, "Baud rate requested not "
565 "supported by device\n");
569 /* If the number of data bits is to be updated */
570 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
571 cp2101_get_config(port, CP2101_BITS, &bits, 2);
572 bits &= ~BITS_DATA_MASK;
573 switch (cflag & CSIZE) {
576 dbg("%s - data bits = 5", __FUNCTION__);
580 dbg("%s - data bits = 6", __FUNCTION__);
584 dbg("%s - data bits = 7", __FUNCTION__);
588 dbg("%s - data bits = 8", __FUNCTION__);
592 dbg("%s - data bits = 9", __FUNCTION__);
595 dev_err(&port->dev, "cp2101 driver does not "
596 "support the number of bits requested,"
597 " using 8 bit mode\n");
601 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
602 dev_err(&port->dev, "Number of data bits requested "
603 "not supported by device\n");
606 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))) {
607 cp2101_get_config(port, CP2101_BITS, &bits, 2);
608 bits &= ~BITS_PARITY_MASK;
609 if (cflag & PARENB) {
610 if (cflag & PARODD) {
611 bits |= BITS_PARITY_ODD;
612 dbg("%s - parity = ODD", __FUNCTION__);
614 bits |= BITS_PARITY_EVEN;
615 dbg("%s - parity = EVEN", __FUNCTION__);
618 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
619 dev_err(&port->dev, "Parity mode not supported "
623 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
624 cp2101_get_config(port, CP2101_BITS, &bits, 2);
625 bits &= ~BITS_STOP_MASK;
626 if (cflag & CSTOPB) {
628 dbg("%s - stop bits = 2", __FUNCTION__);
631 dbg("%s - stop bits = 1", __FUNCTION__);
633 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
634 dev_err(&port->dev, "Number of stop bits requested "
635 "not supported by device\n");
638 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
639 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
640 dbg("%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
641 __FUNCTION__, modem_ctl[0], modem_ctl[1],
642 modem_ctl[2], modem_ctl[3]);
644 if (cflag & CRTSCTS) {
645 modem_ctl[0] &= ~0x7B;
646 modem_ctl[0] |= 0x09;
648 dbg("%s - flow control = CRTSCTS", __FUNCTION__);
650 modem_ctl[0] &= ~0x7B;
651 modem_ctl[0] |= 0x01;
652 modem_ctl[1] |= 0x40;
653 dbg("%s - flow control = NONE", __FUNCTION__);
656 dbg("%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
657 __FUNCTION__, modem_ctl[0], modem_ctl[1],
658 modem_ctl[2], modem_ctl[3]);
659 cp2101_set_config(port, CP2101_MODEMCTL, modem_ctl, 16);
664 static int cp2101_tiocmset (struct usb_serial_port *port, struct file *file,
665 unsigned int set, unsigned int clear)
669 dbg("%s - port %d", __FUNCTION__, port->number);
671 if (set & TIOCM_RTS) {
672 control |= CONTROL_RTS;
673 control |= CONTROL_WRITE_RTS;
675 if (set & TIOCM_DTR) {
676 control |= CONTROL_DTR;
677 control |= CONTROL_WRITE_DTR;
679 if (clear & TIOCM_RTS) {
680 control &= ~CONTROL_RTS;
681 control |= CONTROL_WRITE_RTS;
683 if (clear & TIOCM_DTR) {
684 control &= ~CONTROL_DTR;
685 control |= CONTROL_WRITE_DTR;
688 dbg("%s - control = 0x%.4x", __FUNCTION__, control);
690 return cp2101_set_config(port, CP2101_CONTROL, &control, 2);
694 static int cp2101_tiocmget (struct usb_serial_port *port, struct file *file)
698 dbg("%s - port %d", __FUNCTION__, port->number);
700 cp2101_get_config(port, CP2101_CONTROL, &control, 1);
702 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
703 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
704 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
705 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
706 |((control & CONTROL_RING)? TIOCM_RI : 0)
707 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
709 dbg("%s - control = 0x%.2x", __FUNCTION__, control);
714 static void cp2101_break_ctl (struct usb_serial_port *port, int break_state)
718 dbg("%s - port %d", __FUNCTION__, port->number);
719 if (break_state == 0)
723 dbg("%s - turning break %s", __FUNCTION__,
724 state==BREAK_OFF ? "off" : "on");
725 cp2101_set_config(port, CP2101_BREAK, &state, 2);
728 static int cp2101_startup (struct usb_serial *serial)
730 /* CP2101 buffers behave strangely unless device is reset */
731 usb_reset_device(serial->dev);
735 static void cp2101_shutdown (struct usb_serial *serial)
739 dbg("%s", __FUNCTION__);
741 /* Stop reads and writes on all ports */
742 for (i=0; i < serial->num_ports; ++i) {
743 cp2101_cleanup(serial->port[i]);
747 static int __init cp2101_init (void)
751 retval = usb_serial_register(&cp2101_device);
753 return retval; /* Failed to register */
755 retval = usb_register(&cp2101_driver);
757 /* Failed to register */
758 usb_serial_deregister(&cp2101_device);
763 info(DRIVER_DESC " " DRIVER_VERSION);
767 static void __exit cp2101_exit (void)
769 usb_deregister (&cp2101_driver);
770 usb_serial_deregister (&cp2101_device);
773 module_init(cp2101_init);
774 module_exit(cp2101_exit);
776 MODULE_DESCRIPTION(DRIVER_DESC);
777 MODULE_VERSION(DRIVER_VERSION);
778 MODULE_LICENSE("GPL");
780 module_param(debug, bool, S_IRUGO | S_IWUSR);
781 MODULE_PARM_DESC(debug, "Enable verbose debugging messages");