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.04"
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(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
58 { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
59 { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
60 { } /* Terminating Entry */
63 MODULE_DEVICE_TABLE (usb, id_table);
65 static struct usb_driver cp2101_driver = {
68 .probe = usb_serial_probe,
69 .disconnect = usb_serial_disconnect,
73 static struct usb_serial_device_type cp2101_device = {
77 .num_interrupt_in = 0,
82 .close = cp2101_close,
83 .break_ctl = cp2101_break_ctl,
84 .set_termios = cp2101_set_termios,
85 .tiocmget = cp2101_tiocmget,
86 .tiocmset = cp2101_tiocmset,
87 .attach = cp2101_startup,
88 .shutdown = cp2101_shutdown,
91 /* Config request types */
92 #define REQTYPE_HOST_TO_DEVICE 0x41
93 #define REQTYPE_DEVICE_TO_HOST 0xc1
95 /* Config SET requests. To GET, add 1 to the request number */
96 #define CP2101_UART 0x00 /* Enable / Disable */
97 #define CP2101_BAUDRATE 0x01 /* (BAUD_RATE_GEN_FREQ / baudrate) */
98 #define CP2101_BITS 0x03 /* 0x(0)(databits)(parity)(stopbits) */
99 #define CP2101_BREAK 0x05 /* On / Off */
100 #define CP2101_CONTROL 0x07 /* Flow control line states */
101 #define CP2101_MODEMCTL 0x13 /* Modem controls */
102 #define CP2101_CONFIG_6 0x19 /* 6 bytes of config data ??? */
105 #define UART_ENABLE 0x0001
106 #define UART_DISABLE 0x0000
108 /* CP2101_BAUDRATE */
109 #define BAUD_RATE_GEN_FREQ 0x384000
112 #define BITS_DATA_MASK 0X0f00
113 #define BITS_DATA_5 0X0500
114 #define BITS_DATA_6 0X0600
115 #define BITS_DATA_7 0X0700
116 #define BITS_DATA_8 0X0800
117 #define BITS_DATA_9 0X0900
119 #define BITS_PARITY_MASK 0x00f0
120 #define BITS_PARITY_NONE 0x0000
121 #define BITS_PARITY_ODD 0x0010
122 #define BITS_PARITY_EVEN 0x0020
123 #define BITS_PARITY_MARK 0x0030
124 #define BITS_PARITY_SPACE 0x0040
126 #define BITS_STOP_MASK 0x000f
127 #define BITS_STOP_1 0x0000
128 #define BITS_STOP_1_5 0x0001
129 #define BITS_STOP_2 0x0002
132 #define BREAK_ON 0x0000
133 #define BREAK_OFF 0x0001
136 #define CONTROL_DTR 0x0001
137 #define CONTROL_RTS 0x0002
138 #define CONTROL_CTS 0x0010
139 #define CONTROL_DSR 0x0020
140 #define CONTROL_RING 0x0040
141 #define CONTROL_DCD 0x0080
142 #define CONTROL_WRITE_DTR 0x0100
143 #define CONTROL_WRITE_RTS 0x0200
147 * Reads from the CP2101 configuration registers
148 * 'size' is specified in bytes.
149 * 'data' is a pointer to a pre-allocated array of integers large
150 * enough to hold 'size' bytes (with 4 bytes to each integer)
152 static int cp2101_get_config(struct usb_serial_port* port, u8 request,
153 unsigned int *data, int size)
155 struct usb_serial *serial = port->serial;
157 int result, i, length;
159 /* Number of integers required to contain the array */
160 length = (((size - 1) | 3) + 1)/4;
162 buf = kmalloc (length * sizeof(u32), GFP_KERNEL);
163 memset(buf, 0, length * sizeof(u32));
166 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
170 /* For get requests, the request number must be incremented */
173 /* Issue the request, attempting to read 'size' bytes */
174 result = usb_control_msg (serial->dev,usb_rcvctrlpipe (serial->dev, 0),
175 request, REQTYPE_DEVICE_TO_HOST, 0x0000,
178 /* Convert data into an array of integers */
179 for (i=0; i<length; i++)
180 data[i] = le32_to_cpu(buf[i]);
184 if (result != size) {
185 dev_err(&port->dev, "%s - Unable to send config request, "
186 "request=0x%x size=%d result=%d\n",
187 __FUNCTION__, request, size, result);
196 * Writes to the CP2101 configuration registers
197 * Values less than 16 bits wide are sent directly
198 * 'size' is specified in bytes.
200 static int cp2101_set_config(struct usb_serial_port* port, u8 request,
201 unsigned int *data, int size)
203 struct usb_serial *serial = port->serial;
205 int result, i, length;
207 /* Number of integers required to contain the array */
208 length = (((size - 1) | 3) + 1)/4;
210 buf = kmalloc(length * sizeof(u32), GFP_KERNEL);
212 dev_err(&port->dev, "%s - out of memory.\n",
217 /* Array of integers into bytes */
218 for (i = 0; i < length; i++)
219 buf[i] = cpu_to_le32(data[i]);
222 result = usb_control_msg (serial->dev,
223 usb_sndctrlpipe(serial->dev, 0),
224 request, REQTYPE_HOST_TO_DEVICE, 0x0000,
227 result = usb_control_msg (serial->dev,
228 usb_sndctrlpipe(serial->dev, 0),
229 request, REQTYPE_HOST_TO_DEVICE, data[0],
235 if ((size > 2 && result != size) || result < 0) {
236 dev_err(&port->dev, "%s - Unable to send request, "
237 "request=0x%x size=%d result=%d\n",
238 __FUNCTION__, request, size, result);
242 /* Single data value */
243 result = usb_control_msg (serial->dev,
244 usb_sndctrlpipe(serial->dev, 0),
245 request, REQTYPE_HOST_TO_DEVICE, data[0],
251 * cp2101_set_config_single
252 * Convenience function for calling cp2101_set_config on single data values
253 * without requiring an integer pointer
255 static inline int cp2101_set_config_single(struct usb_serial_port* port,
256 u8 request, unsigned int data)
258 return cp2101_set_config(port, request, &data, 2);
261 static int cp2101_open (struct usb_serial_port *port, struct file *filp)
263 struct usb_serial *serial = port->serial;
266 dbg("%s - port %d", __FUNCTION__, port->number);
268 if (cp2101_set_config_single(port, CP2101_UART, UART_ENABLE)) {
269 dev_err(&port->dev, "%s - Unable to enable UART\n",
274 /* Start reading from the device */
275 usb_fill_bulk_urb (port->read_urb, serial->dev,
276 usb_rcvbulkpipe(serial->dev,
277 port->bulk_in_endpointAddress),
278 port->read_urb->transfer_buffer,
279 port->read_urb->transfer_buffer_length,
280 serial->type->read_bulk_callback,
282 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
284 dev_err(&port->dev, "%s - failed resubmitting read urb, "
285 "error %d\n", __FUNCTION__, result);
289 /* Configure the termios structure */
290 cp2101_get_termios(port);
292 /* Set the DTR and RTS pins low */
293 cp2101_tiocmset(port, NULL, TIOCM_DTR | TIOCM_RTS, 0);
298 static void cp2101_cleanup (struct usb_serial_port *port)
300 struct usb_serial *serial = port->serial;
302 dbg("%s - port %d", __FUNCTION__, port->number);
305 /* shutdown any bulk reads that might be going on */
306 if (serial->num_bulk_out)
307 usb_kill_urb(port->write_urb);
308 if (serial->num_bulk_in)
309 usb_kill_urb(port->read_urb);
313 static void cp2101_close (struct usb_serial_port *port, struct file * filp)
315 dbg("%s - port %d", __FUNCTION__, port->number);
317 /* shutdown our urbs */
318 dbg("%s - shutting down urbs", __FUNCTION__);
319 usb_kill_urb(port->write_urb);
320 usb_kill_urb(port->read_urb);
322 cp2101_set_config_single(port, CP2101_UART, UART_DISABLE);
327 * Reads the baud rate, data bits, parity, stop bits and flow control mode
328 * from the device, corrects any unsupported values, and configures the
329 * termios structure to reflect the state of the device
331 static void cp2101_get_termios (struct usb_serial_port *port)
333 unsigned int cflag, modem_ctl[4];
337 dbg("%s - port %d", __FUNCTION__, port->number);
339 if ((!port->tty) || (!port->tty->termios)) {
340 dbg("%s - no tty structures", __FUNCTION__);
343 cflag = port->tty->termios->c_cflag;
345 cp2101_get_config(port, CP2101_BAUDRATE, &baud, 2);
346 /* Convert to baudrate */
348 baud = BAUD_RATE_GEN_FREQ / baud;
350 dbg("%s - baud rate = %d", __FUNCTION__, baud);
354 * The baud rates which are commented out below
355 * appear to be supported by the device
356 * but are non-standard
358 case 600: cflag |= B600; break;
359 case 1200: cflag |= B1200; break;
360 case 1800: cflag |= B1800; break;
361 case 2400: cflag |= B2400; break;
362 case 4800: cflag |= B4800; break;
363 /*case 7200: cflag |= B7200; break;*/
364 case 9600: cflag |= B9600; break;
365 /*case 14400: cflag |= B14400; break;*/
366 case 19200: cflag |= B19200; break;
367 /*case 28800: cflag |= B28800; break;*/
368 case 38400: cflag |= B38400; break;
369 /*case 55854: cflag |= B55054; break;*/
370 case 57600: cflag |= B57600; break;
371 case 115200: cflag |= B115200; break;
372 /*case 127117: cflag |= B127117; break;*/
373 case 230400: cflag |= B230400; break;
374 case 460800: cflag |= B460800; break;
375 case 921600: cflag |= B921600; break;
376 /*case 3686400: cflag |= B3686400; break;*/
378 dbg("%s - Baud rate is not supported, "
379 "using 9600 baud", __FUNCTION__);
381 cp2101_set_config_single(port, CP2101_BAUDRATE,
382 (BAUD_RATE_GEN_FREQ/9600));
386 cp2101_get_config(port, CP2101_BITS, &bits, 2);
388 switch(bits & BITS_DATA_MASK) {
390 dbg("%s - data bits = 5", __FUNCTION__);
394 dbg("%s - data bits = 6", __FUNCTION__);
398 dbg("%s - data bits = 7", __FUNCTION__);
402 dbg("%s - data bits = 8", __FUNCTION__);
406 dbg("%s - data bits = 9 (not supported, "
407 "using 8 data bits)", __FUNCTION__);
409 bits &= ~BITS_DATA_MASK;
411 cp2101_set_config(port, CP2101_BITS, &bits, 2);
414 dbg("%s - Unknown number of data bits, "
415 "using 8", __FUNCTION__);
417 bits &= ~BITS_DATA_MASK;
419 cp2101_set_config(port, CP2101_BITS, &bits, 2);
423 switch(bits & BITS_PARITY_MASK) {
424 case BITS_PARITY_NONE:
425 dbg("%s - parity = NONE", __FUNCTION__);
428 case BITS_PARITY_ODD:
429 dbg("%s - parity = ODD", __FUNCTION__);
430 cflag |= (PARENB|PARODD);
432 case BITS_PARITY_EVEN:
433 dbg("%s - parity = EVEN", __FUNCTION__);
437 case BITS_PARITY_MARK:
438 dbg("%s - parity = MARK (not supported, "
439 "disabling parity)", __FUNCTION__);
441 bits &= ~BITS_PARITY_MASK;
442 cp2101_set_config(port, CP2101_BITS, &bits, 2);
444 case BITS_PARITY_SPACE:
445 dbg("%s - parity = SPACE (not supported, "
446 "disabling parity)", __FUNCTION__);
448 bits &= ~BITS_PARITY_MASK;
449 cp2101_set_config(port, CP2101_BITS, &bits, 2);
452 dbg("%s - Unknown parity mode, "
453 "disabling parity", __FUNCTION__);
455 bits &= ~BITS_PARITY_MASK;
456 cp2101_set_config(port, CP2101_BITS, &bits, 2);
461 switch(bits & BITS_STOP_MASK) {
463 dbg("%s - stop bits = 1", __FUNCTION__);
466 dbg("%s - stop bits = 1.5 (not supported, "
467 "using 1 stop bit)", __FUNCTION__);
468 bits &= ~BITS_STOP_MASK;
469 cp2101_set_config(port, CP2101_BITS, &bits, 2);
472 dbg("%s - stop bits = 2", __FUNCTION__);
476 dbg("%s - Unknown number of stop bits, "
477 "using 1 stop bit", __FUNCTION__);
478 bits &= ~BITS_STOP_MASK;
479 cp2101_set_config(port, CP2101_BITS, &bits, 2);
483 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
484 if (modem_ctl[0] & 0x0008) {
485 dbg("%s - flow control = CRTSCTS", __FUNCTION__);
488 dbg("%s - flow control = NONE", __FUNCTION__);
492 port->tty->termios->c_cflag = cflag;
495 static void cp2101_set_termios (struct usb_serial_port *port,
496 struct termios *old_termios)
498 unsigned int cflag, old_cflag=0;
500 unsigned int modem_ctl[4];
502 dbg("%s - port %d", __FUNCTION__, port->number);
504 if ((!port->tty) || (!port->tty->termios)) {
505 dbg("%s - no tty structures", __FUNCTION__);
508 cflag = port->tty->termios->c_cflag;
510 /* Check that they really want us to change something */
512 if ((cflag == old_termios->c_cflag) &&
513 (RELEVANT_IFLAG(port->tty->termios->c_iflag)
514 == RELEVANT_IFLAG(old_termios->c_iflag))) {
515 dbg("%s - nothing to change...", __FUNCTION__);
519 old_cflag = old_termios->c_cflag;
522 /* If the baud rate is to be updated*/
523 if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
524 switch (cflag & CBAUD) {
526 * The baud rates which are commented out below
527 * appear to be supported by the device
528 * but are non-standard
530 case B0: baud = 0; break;
531 case B600: baud = 600; break;
532 case B1200: baud = 1200; break;
533 case B1800: baud = 1800; break;
534 case B2400: baud = 2400; break;
535 case B4800: baud = 4800; break;
536 /*case B7200: baud = 7200; break;*/
537 case B9600: baud = 9600; break;
538 /*ase B14400: baud = 14400; break;*/
539 case B19200: baud = 19200; break;
540 /*case B28800: baud = 28800; break;*/
541 case B38400: baud = 38400; break;
542 /*case B55854: baud = 55054; break;*/
543 case B57600: baud = 57600; break;
544 case B115200: baud = 115200; break;
545 /*case B127117: baud = 127117; break;*/
546 case B230400: baud = 230400; break;
547 case B460800: baud = 460800; break;
548 case B921600: baud = 921600; break;
549 /*case B3686400: baud = 3686400; break;*/
551 dev_err(&port->dev, "cp2101 driver does not "
552 "support the baudrate requested\n");
557 dbg("%s - Setting baud rate to %d baud", __FUNCTION__,
559 if (cp2101_set_config_single(port, CP2101_BAUDRATE,
560 (BAUD_RATE_GEN_FREQ / baud)))
561 dev_err(&port->dev, "Baud rate requested not "
562 "supported by device\n");
566 /* If the number of data bits is to be updated */
567 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
568 cp2101_get_config(port, CP2101_BITS, &bits, 2);
569 bits &= ~BITS_DATA_MASK;
570 switch (cflag & CSIZE) {
573 dbg("%s - data bits = 5", __FUNCTION__);
577 dbg("%s - data bits = 6", __FUNCTION__);
581 dbg("%s - data bits = 7", __FUNCTION__);
585 dbg("%s - data bits = 8", __FUNCTION__);
589 dbg("%s - data bits = 9", __FUNCTION__);
592 dev_err(&port->dev, "cp2101 driver does not "
593 "support the number of bits requested,"
594 " using 8 bit mode\n");
598 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
599 dev_err(&port->dev, "Number of data bits requested "
600 "not supported by device\n");
603 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))) {
604 cp2101_get_config(port, CP2101_BITS, &bits, 2);
605 bits &= ~BITS_PARITY_MASK;
606 if (cflag & PARENB) {
607 if (cflag & PARODD) {
608 bits |= BITS_PARITY_ODD;
609 dbg("%s - parity = ODD", __FUNCTION__);
611 bits |= BITS_PARITY_EVEN;
612 dbg("%s - parity = EVEN", __FUNCTION__);
615 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
616 dev_err(&port->dev, "Parity mode not supported "
620 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
621 cp2101_get_config(port, CP2101_BITS, &bits, 2);
622 bits &= ~BITS_STOP_MASK;
623 if (cflag & CSTOPB) {
625 dbg("%s - stop bits = 2", __FUNCTION__);
628 dbg("%s - stop bits = 1", __FUNCTION__);
630 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
631 dev_err(&port->dev, "Number of stop bits requested "
632 "not supported by device\n");
635 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
636 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
637 dbg("%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
638 __FUNCTION__, modem_ctl[0], modem_ctl[1],
639 modem_ctl[2], modem_ctl[3]);
641 if (cflag & CRTSCTS) {
642 modem_ctl[0] &= ~0x7B;
643 modem_ctl[0] |= 0x09;
645 dbg("%s - flow control = CRTSCTS", __FUNCTION__);
647 modem_ctl[0] &= ~0x7B;
648 modem_ctl[0] |= 0x01;
649 modem_ctl[1] |= 0x40;
650 dbg("%s - flow control = NONE", __FUNCTION__);
653 dbg("%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
654 __FUNCTION__, modem_ctl[0], modem_ctl[1],
655 modem_ctl[2], modem_ctl[3]);
656 cp2101_set_config(port, CP2101_MODEMCTL, modem_ctl, 16);
661 static int cp2101_tiocmset (struct usb_serial_port *port, struct file *file,
662 unsigned int set, unsigned int clear)
666 dbg("%s - port %d", __FUNCTION__, port->number);
668 if (set & TIOCM_RTS) {
669 control |= CONTROL_RTS;
670 control |= CONTROL_WRITE_RTS;
672 if (set & TIOCM_DTR) {
673 control |= CONTROL_DTR;
674 control |= CONTROL_WRITE_DTR;
676 if (clear & TIOCM_RTS) {
677 control &= ~CONTROL_RTS;
678 control |= CONTROL_WRITE_RTS;
680 if (clear & TIOCM_DTR) {
681 control &= ~CONTROL_DTR;
682 control |= CONTROL_WRITE_DTR;
685 dbg("%s - control = 0x%.4x", __FUNCTION__, control);
687 return cp2101_set_config(port, CP2101_CONTROL, &control, 2);
691 static int cp2101_tiocmget (struct usb_serial_port *port, struct file *file)
695 dbg("%s - port %d", __FUNCTION__, port->number);
697 cp2101_get_config(port, CP2101_CONTROL, &control, 1);
699 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
700 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
701 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
702 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
703 |((control & CONTROL_RING)? TIOCM_RI : 0)
704 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
706 dbg("%s - control = 0x%.2x", __FUNCTION__, control);
711 static void cp2101_break_ctl (struct usb_serial_port *port, int break_state)
715 dbg("%s - port %d", __FUNCTION__, port->number);
716 if (break_state == 0)
720 dbg("%s - turning break %s", __FUNCTION__,
721 state==BREAK_OFF ? "off" : "on");
722 cp2101_set_config(port, CP2101_BREAK, &state, 2);
725 static int cp2101_startup (struct usb_serial *serial)
727 /* CP2101 buffers behave strangely unless device is reset */
728 usb_reset_device(serial->dev);
732 static void cp2101_shutdown (struct usb_serial *serial)
736 dbg("%s", __FUNCTION__);
738 /* Stop reads and writes on all ports */
739 for (i=0; i < serial->num_ports; ++i) {
740 cp2101_cleanup(serial->port[i]);
744 static int __init cp2101_init (void)
748 retval = usb_serial_register(&cp2101_device);
750 return retval; /* Failed to register */
752 retval = usb_register(&cp2101_driver);
754 /* Failed to register */
755 usb_serial_deregister(&cp2101_device);
760 info(DRIVER_DESC " " DRIVER_VERSION);
764 static void __exit cp2101_exit (void)
766 usb_deregister (&cp2101_driver);
767 usb_serial_deregister (&cp2101_device);
770 module_init(cp2101_init);
771 module_exit(cp2101_exit);
773 MODULE_DESCRIPTION(DRIVER_DESC);
774 MODULE_VERSION(DRIVER_VERSION);
775 MODULE_LICENSE("GPL");
777 module_param(debug, bool, S_IRUGO | S_IWUSR);
778 MODULE_PARM_DESC(debug, "Enable verbose debugging messages");