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.06"
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(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
59 { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
60 { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
61 { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
62 { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
63 { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
64 { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
65 { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
66 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
67 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
68 { } /* Terminating Entry */
71 MODULE_DEVICE_TABLE (usb, id_table);
73 static struct usb_driver cp2101_driver = {
75 .probe = usb_serial_probe,
76 .disconnect = usb_serial_disconnect,
81 static struct usb_serial_driver cp2101_device = {
87 .num_interrupt_in = 0,
92 .close = cp2101_close,
93 .break_ctl = cp2101_break_ctl,
94 .set_termios = cp2101_set_termios,
95 .tiocmget = cp2101_tiocmget,
96 .tiocmset = cp2101_tiocmset,
97 .attach = cp2101_startup,
98 .shutdown = cp2101_shutdown,
101 /* Config request types */
102 #define REQTYPE_HOST_TO_DEVICE 0x41
103 #define REQTYPE_DEVICE_TO_HOST 0xc1
105 /* Config SET requests. To GET, add 1 to the request number */
106 #define CP2101_UART 0x00 /* Enable / Disable */
107 #define CP2101_BAUDRATE 0x01 /* (BAUD_RATE_GEN_FREQ / baudrate) */
108 #define CP2101_BITS 0x03 /* 0x(0)(databits)(parity)(stopbits) */
109 #define CP2101_BREAK 0x05 /* On / Off */
110 #define CP2101_CONTROL 0x07 /* Flow control line states */
111 #define CP2101_MODEMCTL 0x13 /* Modem controls */
112 #define CP2101_CONFIG_6 0x19 /* 6 bytes of config data ??? */
115 #define UART_ENABLE 0x0001
116 #define UART_DISABLE 0x0000
118 /* CP2101_BAUDRATE */
119 #define BAUD_RATE_GEN_FREQ 0x384000
122 #define BITS_DATA_MASK 0X0f00
123 #define BITS_DATA_5 0X0500
124 #define BITS_DATA_6 0X0600
125 #define BITS_DATA_7 0X0700
126 #define BITS_DATA_8 0X0800
127 #define BITS_DATA_9 0X0900
129 #define BITS_PARITY_MASK 0x00f0
130 #define BITS_PARITY_NONE 0x0000
131 #define BITS_PARITY_ODD 0x0010
132 #define BITS_PARITY_EVEN 0x0020
133 #define BITS_PARITY_MARK 0x0030
134 #define BITS_PARITY_SPACE 0x0040
136 #define BITS_STOP_MASK 0x000f
137 #define BITS_STOP_1 0x0000
138 #define BITS_STOP_1_5 0x0001
139 #define BITS_STOP_2 0x0002
142 #define BREAK_ON 0x0000
143 #define BREAK_OFF 0x0001
146 #define CONTROL_DTR 0x0001
147 #define CONTROL_RTS 0x0002
148 #define CONTROL_CTS 0x0010
149 #define CONTROL_DSR 0x0020
150 #define CONTROL_RING 0x0040
151 #define CONTROL_DCD 0x0080
152 #define CONTROL_WRITE_DTR 0x0100
153 #define CONTROL_WRITE_RTS 0x0200
157 * Reads from the CP2101 configuration registers
158 * 'size' is specified in bytes.
159 * 'data' is a pointer to a pre-allocated array of integers large
160 * enough to hold 'size' bytes (with 4 bytes to each integer)
162 static int cp2101_get_config(struct usb_serial_port* port, u8 request,
163 unsigned int *data, int size)
165 struct usb_serial *serial = port->serial;
167 int result, i, length;
169 /* Number of integers required to contain the array */
170 length = (((size - 1) | 3) + 1)/4;
172 buf = kcalloc(length, sizeof(u32), GFP_KERNEL);
174 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
178 /* For get requests, the request number must be incremented */
181 /* Issue the request, attempting to read 'size' bytes */
182 result = usb_control_msg (serial->dev,usb_rcvctrlpipe (serial->dev, 0),
183 request, REQTYPE_DEVICE_TO_HOST, 0x0000,
186 /* Convert data into an array of integers */
187 for (i=0; i<length; i++)
188 data[i] = le32_to_cpu(buf[i]);
192 if (result != size) {
193 dev_err(&port->dev, "%s - Unable to send config request, "
194 "request=0x%x size=%d result=%d\n",
195 __FUNCTION__, request, size, result);
204 * Writes to the CP2101 configuration registers
205 * Values less than 16 bits wide are sent directly
206 * 'size' is specified in bytes.
208 static int cp2101_set_config(struct usb_serial_port* port, u8 request,
209 unsigned int *data, int size)
211 struct usb_serial *serial = port->serial;
213 int result, i, length;
215 /* Number of integers required to contain the array */
216 length = (((size - 1) | 3) + 1)/4;
218 buf = kmalloc(length * sizeof(u32), GFP_KERNEL);
220 dev_err(&port->dev, "%s - out of memory.\n",
225 /* Array of integers into bytes */
226 for (i = 0; i < length; i++)
227 buf[i] = cpu_to_le32(data[i]);
230 result = usb_control_msg (serial->dev,
231 usb_sndctrlpipe(serial->dev, 0),
232 request, REQTYPE_HOST_TO_DEVICE, 0x0000,
235 result = usb_control_msg (serial->dev,
236 usb_sndctrlpipe(serial->dev, 0),
237 request, REQTYPE_HOST_TO_DEVICE, data[0],
243 if ((size > 2 && result != size) || result < 0) {
244 dev_err(&port->dev, "%s - Unable to send request, "
245 "request=0x%x size=%d result=%d\n",
246 __FUNCTION__, request, size, result);
250 /* Single data value */
251 result = usb_control_msg (serial->dev,
252 usb_sndctrlpipe(serial->dev, 0),
253 request, REQTYPE_HOST_TO_DEVICE, data[0],
259 * cp2101_set_config_single
260 * Convenience function for calling cp2101_set_config on single data values
261 * without requiring an integer pointer
263 static inline int cp2101_set_config_single(struct usb_serial_port* port,
264 u8 request, unsigned int data)
266 return cp2101_set_config(port, request, &data, 2);
269 static int cp2101_open (struct usb_serial_port *port, struct file *filp)
271 struct usb_serial *serial = port->serial;
274 dbg("%s - port %d", __FUNCTION__, port->number);
276 if (cp2101_set_config_single(port, CP2101_UART, UART_ENABLE)) {
277 dev_err(&port->dev, "%s - Unable to enable UART\n",
282 /* Start reading from the device */
283 usb_fill_bulk_urb (port->read_urb, serial->dev,
284 usb_rcvbulkpipe(serial->dev,
285 port->bulk_in_endpointAddress),
286 port->read_urb->transfer_buffer,
287 port->read_urb->transfer_buffer_length,
288 serial->type->read_bulk_callback,
290 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
292 dev_err(&port->dev, "%s - failed resubmitting read urb, "
293 "error %d\n", __FUNCTION__, result);
297 /* Configure the termios structure */
298 cp2101_get_termios(port);
300 /* Set the DTR and RTS pins low */
301 cp2101_tiocmset(port, NULL, TIOCM_DTR | TIOCM_RTS, 0);
306 static void cp2101_cleanup (struct usb_serial_port *port)
308 struct usb_serial *serial = port->serial;
310 dbg("%s - port %d", __FUNCTION__, port->number);
313 /* shutdown any bulk reads that might be going on */
314 if (serial->num_bulk_out)
315 usb_kill_urb(port->write_urb);
316 if (serial->num_bulk_in)
317 usb_kill_urb(port->read_urb);
321 static void cp2101_close (struct usb_serial_port *port, struct file * filp)
323 dbg("%s - port %d", __FUNCTION__, port->number);
325 /* shutdown our urbs */
326 dbg("%s - shutting down urbs", __FUNCTION__);
327 usb_kill_urb(port->write_urb);
328 usb_kill_urb(port->read_urb);
330 cp2101_set_config_single(port, CP2101_UART, UART_DISABLE);
335 * Reads the baud rate, data bits, parity, stop bits and flow control mode
336 * from the device, corrects any unsupported values, and configures the
337 * termios structure to reflect the state of the device
339 static void cp2101_get_termios (struct usb_serial_port *port)
341 unsigned int cflag, modem_ctl[4];
345 dbg("%s - port %d", __FUNCTION__, port->number);
347 if ((!port->tty) || (!port->tty->termios)) {
348 dbg("%s - no tty structures", __FUNCTION__);
351 cflag = port->tty->termios->c_cflag;
353 cp2101_get_config(port, CP2101_BAUDRATE, &baud, 2);
354 /* Convert to baudrate */
356 baud = BAUD_RATE_GEN_FREQ / baud;
358 dbg("%s - baud rate = %d", __FUNCTION__, baud);
362 * The baud rates which are commented out below
363 * appear to be supported by the device
364 * but are non-standard
366 case 600: cflag |= B600; break;
367 case 1200: cflag |= B1200; break;
368 case 1800: cflag |= B1800; break;
369 case 2400: cflag |= B2400; break;
370 case 4800: cflag |= B4800; break;
371 /*case 7200: cflag |= B7200; break;*/
372 case 9600: cflag |= B9600; break;
373 /*case 14400: cflag |= B14400; break;*/
374 case 19200: cflag |= B19200; break;
375 /*case 28800: cflag |= B28800; break;*/
376 case 38400: cflag |= B38400; break;
377 /*case 55854: cflag |= B55054; break;*/
378 case 57600: cflag |= B57600; break;
379 case 115200: cflag |= B115200; break;
380 /*case 127117: cflag |= B127117; break;*/
381 case 230400: cflag |= B230400; break;
382 case 460800: cflag |= B460800; break;
383 case 921600: cflag |= B921600; break;
384 /*case 3686400: cflag |= B3686400; break;*/
386 dbg("%s - Baud rate is not supported, "
387 "using 9600 baud", __FUNCTION__);
389 cp2101_set_config_single(port, CP2101_BAUDRATE,
390 (BAUD_RATE_GEN_FREQ/9600));
394 cp2101_get_config(port, CP2101_BITS, &bits, 2);
396 switch(bits & BITS_DATA_MASK) {
398 dbg("%s - data bits = 5", __FUNCTION__);
402 dbg("%s - data bits = 6", __FUNCTION__);
406 dbg("%s - data bits = 7", __FUNCTION__);
410 dbg("%s - data bits = 8", __FUNCTION__);
414 dbg("%s - data bits = 9 (not supported, "
415 "using 8 data bits)", __FUNCTION__);
417 bits &= ~BITS_DATA_MASK;
419 cp2101_set_config(port, CP2101_BITS, &bits, 2);
422 dbg("%s - Unknown number of data bits, "
423 "using 8", __FUNCTION__);
425 bits &= ~BITS_DATA_MASK;
427 cp2101_set_config(port, CP2101_BITS, &bits, 2);
431 switch(bits & BITS_PARITY_MASK) {
432 case BITS_PARITY_NONE:
433 dbg("%s - parity = NONE", __FUNCTION__);
436 case BITS_PARITY_ODD:
437 dbg("%s - parity = ODD", __FUNCTION__);
438 cflag |= (PARENB|PARODD);
440 case BITS_PARITY_EVEN:
441 dbg("%s - parity = EVEN", __FUNCTION__);
445 case BITS_PARITY_MARK:
446 dbg("%s - parity = MARK (not supported, "
447 "disabling parity)", __FUNCTION__);
449 bits &= ~BITS_PARITY_MASK;
450 cp2101_set_config(port, CP2101_BITS, &bits, 2);
452 case BITS_PARITY_SPACE:
453 dbg("%s - parity = SPACE (not supported, "
454 "disabling parity)", __FUNCTION__);
456 bits &= ~BITS_PARITY_MASK;
457 cp2101_set_config(port, CP2101_BITS, &bits, 2);
460 dbg("%s - Unknown parity mode, "
461 "disabling parity", __FUNCTION__);
463 bits &= ~BITS_PARITY_MASK;
464 cp2101_set_config(port, CP2101_BITS, &bits, 2);
469 switch(bits & BITS_STOP_MASK) {
471 dbg("%s - stop bits = 1", __FUNCTION__);
474 dbg("%s - stop bits = 1.5 (not supported, "
475 "using 1 stop bit)", __FUNCTION__);
476 bits &= ~BITS_STOP_MASK;
477 cp2101_set_config(port, CP2101_BITS, &bits, 2);
480 dbg("%s - stop bits = 2", __FUNCTION__);
484 dbg("%s - Unknown number of stop bits, "
485 "using 1 stop bit", __FUNCTION__);
486 bits &= ~BITS_STOP_MASK;
487 cp2101_set_config(port, CP2101_BITS, &bits, 2);
491 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
492 if (modem_ctl[0] & 0x0008) {
493 dbg("%s - flow control = CRTSCTS", __FUNCTION__);
496 dbg("%s - flow control = NONE", __FUNCTION__);
500 port->tty->termios->c_cflag = cflag;
503 static void cp2101_set_termios (struct usb_serial_port *port,
504 struct termios *old_termios)
506 unsigned int cflag, old_cflag=0;
508 unsigned int modem_ctl[4];
510 dbg("%s - port %d", __FUNCTION__, port->number);
512 if ((!port->tty) || (!port->tty->termios)) {
513 dbg("%s - no tty structures", __FUNCTION__);
516 cflag = port->tty->termios->c_cflag;
518 /* Check that they really want us to change something */
520 if ((cflag == old_termios->c_cflag) &&
521 (RELEVANT_IFLAG(port->tty->termios->c_iflag)
522 == RELEVANT_IFLAG(old_termios->c_iflag))) {
523 dbg("%s - nothing to change...", __FUNCTION__);
527 old_cflag = old_termios->c_cflag;
530 /* If the baud rate is to be updated*/
531 if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
532 switch (cflag & CBAUD) {
534 * The baud rates which are commented out below
535 * appear to be supported by the device
536 * but are non-standard
538 case B0: baud = 0; break;
539 case B600: baud = 600; break;
540 case B1200: baud = 1200; break;
541 case B1800: baud = 1800; break;
542 case B2400: baud = 2400; break;
543 case B4800: baud = 4800; break;
544 /*case B7200: baud = 7200; break;*/
545 case B9600: baud = 9600; break;
546 /*ase B14400: baud = 14400; break;*/
547 case B19200: baud = 19200; break;
548 /*case B28800: baud = 28800; break;*/
549 case B38400: baud = 38400; break;
550 /*case B55854: baud = 55054; break;*/
551 case B57600: baud = 57600; break;
552 case B115200: baud = 115200; break;
553 /*case B127117: baud = 127117; break;*/
554 case B230400: baud = 230400; break;
555 case B460800: baud = 460800; break;
556 case B921600: baud = 921600; break;
557 /*case B3686400: baud = 3686400; break;*/
559 dev_err(&port->dev, "cp2101 driver does not "
560 "support the baudrate requested\n");
565 dbg("%s - Setting baud rate to %d baud", __FUNCTION__,
567 if (cp2101_set_config_single(port, CP2101_BAUDRATE,
568 (BAUD_RATE_GEN_FREQ / baud)))
569 dev_err(&port->dev, "Baud rate requested not "
570 "supported by device\n");
574 /* If the number of data bits is to be updated */
575 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
576 cp2101_get_config(port, CP2101_BITS, &bits, 2);
577 bits &= ~BITS_DATA_MASK;
578 switch (cflag & CSIZE) {
581 dbg("%s - data bits = 5", __FUNCTION__);
585 dbg("%s - data bits = 6", __FUNCTION__);
589 dbg("%s - data bits = 7", __FUNCTION__);
593 dbg("%s - data bits = 8", __FUNCTION__);
597 dbg("%s - data bits = 9", __FUNCTION__);
600 dev_err(&port->dev, "cp2101 driver does not "
601 "support the number of bits requested,"
602 " using 8 bit mode\n");
606 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
607 dev_err(&port->dev, "Number of data bits requested "
608 "not supported by device\n");
611 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))) {
612 cp2101_get_config(port, CP2101_BITS, &bits, 2);
613 bits &= ~BITS_PARITY_MASK;
614 if (cflag & PARENB) {
615 if (cflag & PARODD) {
616 bits |= BITS_PARITY_ODD;
617 dbg("%s - parity = ODD", __FUNCTION__);
619 bits |= BITS_PARITY_EVEN;
620 dbg("%s - parity = EVEN", __FUNCTION__);
623 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
624 dev_err(&port->dev, "Parity mode not supported "
628 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
629 cp2101_get_config(port, CP2101_BITS, &bits, 2);
630 bits &= ~BITS_STOP_MASK;
631 if (cflag & CSTOPB) {
633 dbg("%s - stop bits = 2", __FUNCTION__);
636 dbg("%s - stop bits = 1", __FUNCTION__);
638 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
639 dev_err(&port->dev, "Number of stop bits requested "
640 "not supported by device\n");
643 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
644 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
645 dbg("%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
646 __FUNCTION__, modem_ctl[0], modem_ctl[1],
647 modem_ctl[2], modem_ctl[3]);
649 if (cflag & CRTSCTS) {
650 modem_ctl[0] &= ~0x7B;
651 modem_ctl[0] |= 0x09;
653 dbg("%s - flow control = CRTSCTS", __FUNCTION__);
655 modem_ctl[0] &= ~0x7B;
656 modem_ctl[0] |= 0x01;
657 modem_ctl[1] |= 0x40;
658 dbg("%s - flow control = NONE", __FUNCTION__);
661 dbg("%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
662 __FUNCTION__, modem_ctl[0], modem_ctl[1],
663 modem_ctl[2], modem_ctl[3]);
664 cp2101_set_config(port, CP2101_MODEMCTL, modem_ctl, 16);
669 static int cp2101_tiocmset (struct usb_serial_port *port, struct file *file,
670 unsigned int set, unsigned int clear)
674 dbg("%s - port %d", __FUNCTION__, port->number);
676 if (set & TIOCM_RTS) {
677 control |= CONTROL_RTS;
678 control |= CONTROL_WRITE_RTS;
680 if (set & TIOCM_DTR) {
681 control |= CONTROL_DTR;
682 control |= CONTROL_WRITE_DTR;
684 if (clear & TIOCM_RTS) {
685 control &= ~CONTROL_RTS;
686 control |= CONTROL_WRITE_RTS;
688 if (clear & TIOCM_DTR) {
689 control &= ~CONTROL_DTR;
690 control |= CONTROL_WRITE_DTR;
693 dbg("%s - control = 0x%.4x", __FUNCTION__, control);
695 return cp2101_set_config(port, CP2101_CONTROL, &control, 2);
699 static int cp2101_tiocmget (struct usb_serial_port *port, struct file *file)
703 dbg("%s - port %d", __FUNCTION__, port->number);
705 cp2101_get_config(port, CP2101_CONTROL, &control, 1);
707 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
708 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
709 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
710 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
711 |((control & CONTROL_RING)? TIOCM_RI : 0)
712 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
714 dbg("%s - control = 0x%.2x", __FUNCTION__, control);
719 static void cp2101_break_ctl (struct usb_serial_port *port, int break_state)
723 dbg("%s - port %d", __FUNCTION__, port->number);
724 if (break_state == 0)
728 dbg("%s - turning break %s", __FUNCTION__,
729 state==BREAK_OFF ? "off" : "on");
730 cp2101_set_config(port, CP2101_BREAK, &state, 2);
733 static int cp2101_startup (struct usb_serial *serial)
735 /* CP2101 buffers behave strangely unless device is reset */
736 usb_reset_device(serial->dev);
740 static void cp2101_shutdown (struct usb_serial *serial)
744 dbg("%s", __FUNCTION__);
746 /* Stop reads and writes on all ports */
747 for (i=0; i < serial->num_ports; ++i) {
748 cp2101_cleanup(serial->port[i]);
752 static int __init cp2101_init (void)
756 retval = usb_serial_register(&cp2101_device);
758 return retval; /* Failed to register */
760 retval = usb_register(&cp2101_driver);
762 /* Failed to register */
763 usb_serial_deregister(&cp2101_device);
768 info(DRIVER_DESC " " DRIVER_VERSION);
772 static void __exit cp2101_exit (void)
774 usb_deregister (&cp2101_driver);
775 usb_serial_deregister (&cp2101_device);
778 module_init(cp2101_init);
779 module_exit(cp2101_exit);
781 MODULE_DESCRIPTION(DRIVER_DESC);
782 MODULE_VERSION(DRIVER_VERSION);
783 MODULE_LICENSE("GPL");
785 module_param(debug, bool, S_IRUGO | S_IWUSR);
786 MODULE_PARM_DESC(debug, "Enable verbose debugging messages");