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/kernel.h>
21 #include <linux/errno.h>
22 #include <linux/slab.h>
23 #include <linux/tty.h>
24 #include <linux/tty_flip.h>
25 #include <linux/module.h>
26 #include <linux/moduleparam.h>
27 #include <linux/usb.h>
28 #include <asm/uaccess.h>
29 #include <linux/usb/serial.h>
34 #define DRIVER_VERSION "v0.07"
35 #define DRIVER_DESC "Silicon Labs CP2101/CP2102 RS232 serial adaptor driver"
40 static int cp2101_open(struct usb_serial_port*, struct file*);
41 static void cp2101_cleanup(struct usb_serial_port*);
42 static void cp2101_close(struct usb_serial_port*, struct file*);
43 static void cp2101_get_termios(struct usb_serial_port*);
44 static void cp2101_set_termios(struct usb_serial_port*, struct ktermios*);
45 static int cp2101_tiocmget (struct usb_serial_port *, struct file *);
46 static int cp2101_tiocmset (struct usb_serial_port *, struct file *,
47 unsigned int, unsigned int);
48 static void cp2101_break_ctl(struct usb_serial_port*, int);
49 static int cp2101_startup (struct usb_serial *);
50 static void cp2101_shutdown(struct usb_serial*);
55 static struct usb_device_id id_table [] = {
56 { USB_DEVICE(0x0489, 0xE000) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
57 { USB_DEVICE(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
58 { USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
59 { USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
60 { USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */
61 { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
62 { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
63 { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
64 { USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
65 { USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
66 { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
67 { USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
68 { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
69 { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
70 { USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
71 { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
72 { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
73 { USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
74 { USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
75 { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
76 { USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
77 { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
78 { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
79 { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
80 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
81 { USB_DEVICE(0x10c4, 0x8293) }, /* Telegesys ETRX2USB */
82 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
83 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
84 { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
85 { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
86 { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
87 { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
88 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
89 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
90 { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
91 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
92 { } /* Terminating Entry */
95 MODULE_DEVICE_TABLE (usb, id_table);
97 static struct usb_driver cp2101_driver = {
99 .probe = usb_serial_probe,
100 .disconnect = usb_serial_disconnect,
101 .id_table = id_table,
105 static struct usb_serial_driver cp2101_device = {
107 .owner = THIS_MODULE,
110 .usb_driver = &cp2101_driver,
111 .id_table = id_table,
114 .close = cp2101_close,
115 .break_ctl = cp2101_break_ctl,
116 .set_termios = cp2101_set_termios,
117 .tiocmget = cp2101_tiocmget,
118 .tiocmset = cp2101_tiocmset,
119 .attach = cp2101_startup,
120 .shutdown = cp2101_shutdown,
123 /* Config request types */
124 #define REQTYPE_HOST_TO_DEVICE 0x41
125 #define REQTYPE_DEVICE_TO_HOST 0xc1
127 /* Config SET requests. To GET, add 1 to the request number */
128 #define CP2101_UART 0x00 /* Enable / Disable */
129 #define CP2101_BAUDRATE 0x01 /* (BAUD_RATE_GEN_FREQ / baudrate) */
130 #define CP2101_BITS 0x03 /* 0x(0)(databits)(parity)(stopbits) */
131 #define CP2101_BREAK 0x05 /* On / Off */
132 #define CP2101_CONTROL 0x07 /* Flow control line states */
133 #define CP2101_MODEMCTL 0x13 /* Modem controls */
134 #define CP2101_CONFIG_6 0x19 /* 6 bytes of config data ??? */
137 #define UART_ENABLE 0x0001
138 #define UART_DISABLE 0x0000
140 /* CP2101_BAUDRATE */
141 #define BAUD_RATE_GEN_FREQ 0x384000
144 #define BITS_DATA_MASK 0X0f00
145 #define BITS_DATA_5 0X0500
146 #define BITS_DATA_6 0X0600
147 #define BITS_DATA_7 0X0700
148 #define BITS_DATA_8 0X0800
149 #define BITS_DATA_9 0X0900
151 #define BITS_PARITY_MASK 0x00f0
152 #define BITS_PARITY_NONE 0x0000
153 #define BITS_PARITY_ODD 0x0010
154 #define BITS_PARITY_EVEN 0x0020
155 #define BITS_PARITY_MARK 0x0030
156 #define BITS_PARITY_SPACE 0x0040
158 #define BITS_STOP_MASK 0x000f
159 #define BITS_STOP_1 0x0000
160 #define BITS_STOP_1_5 0x0001
161 #define BITS_STOP_2 0x0002
164 #define BREAK_ON 0x0000
165 #define BREAK_OFF 0x0001
168 #define CONTROL_DTR 0x0001
169 #define CONTROL_RTS 0x0002
170 #define CONTROL_CTS 0x0010
171 #define CONTROL_DSR 0x0020
172 #define CONTROL_RING 0x0040
173 #define CONTROL_DCD 0x0080
174 #define CONTROL_WRITE_DTR 0x0100
175 #define CONTROL_WRITE_RTS 0x0200
179 * Reads from the CP2101 configuration registers
180 * 'size' is specified in bytes.
181 * 'data' is a pointer to a pre-allocated array of integers large
182 * enough to hold 'size' bytes (with 4 bytes to each integer)
184 static int cp2101_get_config(struct usb_serial_port* port, u8 request,
185 unsigned int *data, int size)
187 struct usb_serial *serial = port->serial;
189 int result, i, length;
191 /* Number of integers required to contain the array */
192 length = (((size - 1) | 3) + 1)/4;
194 buf = kcalloc(length, sizeof(__le32), GFP_KERNEL);
196 dev_err(&port->dev, "%s - out of memory.\n", __func__);
200 /* For get requests, the request number must be incremented */
203 /* Issue the request, attempting to read 'size' bytes */
204 result = usb_control_msg (serial->dev,usb_rcvctrlpipe (serial->dev, 0),
205 request, REQTYPE_DEVICE_TO_HOST, 0x0000,
208 /* Convert data into an array of integers */
209 for (i=0; i<length; i++)
210 data[i] = le32_to_cpu(buf[i]);
214 if (result != size) {
215 dev_err(&port->dev, "%s - Unable to send config request, "
216 "request=0x%x size=%d result=%d\n",
217 __func__, request, size, result);
226 * Writes to the CP2101 configuration registers
227 * Values less than 16 bits wide are sent directly
228 * 'size' is specified in bytes.
230 static int cp2101_set_config(struct usb_serial_port* port, u8 request,
231 unsigned int *data, int size)
233 struct usb_serial *serial = port->serial;
235 int result, i, length;
237 /* Number of integers required to contain the array */
238 length = (((size - 1) | 3) + 1)/4;
240 buf = kmalloc(length * sizeof(__le32), GFP_KERNEL);
242 dev_err(&port->dev, "%s - out of memory.\n",
247 /* Array of integers into bytes */
248 for (i = 0; i < length; i++)
249 buf[i] = cpu_to_le32(data[i]);
252 result = usb_control_msg (serial->dev,
253 usb_sndctrlpipe(serial->dev, 0),
254 request, REQTYPE_HOST_TO_DEVICE, 0x0000,
257 result = usb_control_msg (serial->dev,
258 usb_sndctrlpipe(serial->dev, 0),
259 request, REQTYPE_HOST_TO_DEVICE, data[0],
265 if ((size > 2 && result != size) || result < 0) {
266 dev_err(&port->dev, "%s - Unable to send request, "
267 "request=0x%x size=%d result=%d\n",
268 __func__, request, size, result);
272 /* Single data value */
273 result = usb_control_msg (serial->dev,
274 usb_sndctrlpipe(serial->dev, 0),
275 request, REQTYPE_HOST_TO_DEVICE, data[0],
281 * cp2101_set_config_single
282 * Convenience function for calling cp2101_set_config on single data values
283 * without requiring an integer pointer
285 static inline int cp2101_set_config_single(struct usb_serial_port* port,
286 u8 request, unsigned int data)
288 return cp2101_set_config(port, request, &data, 2);
291 static int cp2101_open (struct usb_serial_port *port, struct file *filp)
293 struct usb_serial *serial = port->serial;
296 dbg("%s - port %d", __func__, port->number);
298 if (cp2101_set_config_single(port, CP2101_UART, UART_ENABLE)) {
299 dev_err(&port->dev, "%s - Unable to enable UART\n",
304 /* Start reading from the device */
305 usb_fill_bulk_urb (port->read_urb, serial->dev,
306 usb_rcvbulkpipe(serial->dev,
307 port->bulk_in_endpointAddress),
308 port->read_urb->transfer_buffer,
309 port->read_urb->transfer_buffer_length,
310 serial->type->read_bulk_callback,
312 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
314 dev_err(&port->dev, "%s - failed resubmitting read urb, "
315 "error %d\n", __func__, result);
319 /* Configure the termios structure */
320 cp2101_get_termios(port);
322 /* Set the DTR and RTS pins low */
323 cp2101_tiocmset(port, NULL, TIOCM_DTR | TIOCM_RTS, 0);
328 static void cp2101_cleanup (struct usb_serial_port *port)
330 struct usb_serial *serial = port->serial;
332 dbg("%s - port %d", __func__, port->number);
335 /* shutdown any bulk reads that might be going on */
336 if (serial->num_bulk_out)
337 usb_kill_urb(port->write_urb);
338 if (serial->num_bulk_in)
339 usb_kill_urb(port->read_urb);
343 static void cp2101_close (struct usb_serial_port *port, struct file * filp)
345 dbg("%s - port %d", __func__, port->number);
347 /* shutdown our urbs */
348 dbg("%s - shutting down urbs", __func__);
349 usb_kill_urb(port->write_urb);
350 usb_kill_urb(port->read_urb);
352 mutex_lock(&port->serial->disc_mutex);
353 if (!port->serial->disconnected)
354 cp2101_set_config_single(port, CP2101_UART, UART_DISABLE);
355 mutex_unlock(&port->serial->disc_mutex);
360 * Reads the baud rate, data bits, parity, stop bits and flow control mode
361 * from the device, corrects any unsupported values, and configures the
362 * termios structure to reflect the state of the device
364 static void cp2101_get_termios (struct usb_serial_port *port)
366 unsigned int cflag, modem_ctl[4];
370 dbg("%s - port %d", __func__, port->number);
372 if (!port->tty || !port->tty->termios) {
373 dbg("%s - no tty structures", __func__);
377 cp2101_get_config(port, CP2101_BAUDRATE, &baud, 2);
378 /* Convert to baudrate */
380 baud = BAUD_RATE_GEN_FREQ / baud;
382 dbg("%s - baud rate = %d", __func__, baud);
384 tty_encode_baud_rate(port->tty, baud, baud);
385 cflag = port->tty->termios->c_cflag;
387 cp2101_get_config(port, CP2101_BITS, &bits, 2);
389 switch(bits & BITS_DATA_MASK) {
391 dbg("%s - data bits = 5", __func__);
395 dbg("%s - data bits = 6", __func__);
399 dbg("%s - data bits = 7", __func__);
403 dbg("%s - data bits = 8", __func__);
407 dbg("%s - data bits = 9 (not supported, "
408 "using 8 data bits)", __func__);
410 bits &= ~BITS_DATA_MASK;
412 cp2101_set_config(port, CP2101_BITS, &bits, 2);
415 dbg("%s - Unknown number of data bits, "
416 "using 8", __func__);
418 bits &= ~BITS_DATA_MASK;
420 cp2101_set_config(port, CP2101_BITS, &bits, 2);
424 switch(bits & BITS_PARITY_MASK) {
425 case BITS_PARITY_NONE:
426 dbg("%s - parity = NONE", __func__);
429 case BITS_PARITY_ODD:
430 dbg("%s - parity = ODD", __func__);
431 cflag |= (PARENB|PARODD);
433 case BITS_PARITY_EVEN:
434 dbg("%s - parity = EVEN", __func__);
438 case BITS_PARITY_MARK:
439 dbg("%s - parity = MARK (not supported, "
440 "disabling parity)", __func__);
442 bits &= ~BITS_PARITY_MASK;
443 cp2101_set_config(port, CP2101_BITS, &bits, 2);
445 case BITS_PARITY_SPACE:
446 dbg("%s - parity = SPACE (not supported, "
447 "disabling parity)", __func__);
449 bits &= ~BITS_PARITY_MASK;
450 cp2101_set_config(port, CP2101_BITS, &bits, 2);
453 dbg("%s - Unknown parity mode, "
454 "disabling parity", __func__);
456 bits &= ~BITS_PARITY_MASK;
457 cp2101_set_config(port, CP2101_BITS, &bits, 2);
462 switch(bits & BITS_STOP_MASK) {
464 dbg("%s - stop bits = 1", __func__);
467 dbg("%s - stop bits = 1.5 (not supported, "
468 "using 1 stop bit)", __func__);
469 bits &= ~BITS_STOP_MASK;
470 cp2101_set_config(port, CP2101_BITS, &bits, 2);
473 dbg("%s - stop bits = 2", __func__);
477 dbg("%s - Unknown number of stop bits, "
478 "using 1 stop bit", __func__);
479 bits &= ~BITS_STOP_MASK;
480 cp2101_set_config(port, CP2101_BITS, &bits, 2);
484 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
485 if (modem_ctl[0] & 0x0008) {
486 dbg("%s - flow control = CRTSCTS", __func__);
489 dbg("%s - flow control = NONE", __func__);
493 port->tty->termios->c_cflag = cflag;
496 static void cp2101_set_termios (struct usb_serial_port *port,
497 struct ktermios *old_termios)
499 unsigned int cflag, old_cflag;
501 unsigned int modem_ctl[4];
503 dbg("%s - port %d", __func__, port->number);
505 if (!port->tty || !port->tty->termios) {
506 dbg("%s - no tty structures", __func__);
509 port->tty->termios->c_cflag &= ~CMSPAR;
511 cflag = port->tty->termios->c_cflag;
512 old_cflag = old_termios->c_cflag;
513 baud = tty_get_baud_rate(port->tty);
515 /* If the baud rate is to be updated*/
516 if (baud != tty_termios_baud_rate(old_termios)) {
545 dbg("%s - Setting baud rate to %d baud", __func__,
547 if (cp2101_set_config_single(port, CP2101_BAUDRATE,
548 (BAUD_RATE_GEN_FREQ / baud))) {
549 dev_err(&port->dev, "Baud rate requested not "
550 "supported by device\n");
551 baud = tty_termios_baud_rate(old_termios);
555 /* Report back the resulting baud rate */
556 tty_encode_baud_rate(port->tty, baud, baud);
558 /* If the number of data bits is to be updated */
559 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
560 cp2101_get_config(port, CP2101_BITS, &bits, 2);
561 bits &= ~BITS_DATA_MASK;
562 switch (cflag & CSIZE) {
565 dbg("%s - data bits = 5", __func__);
569 dbg("%s - data bits = 6", __func__);
573 dbg("%s - data bits = 7", __func__);
577 dbg("%s - data bits = 8", __func__);
581 dbg("%s - data bits = 9", __func__);
584 dev_err(&port->dev, "cp2101 driver does not "
585 "support the number of bits requested,"
586 " using 8 bit mode\n");
590 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
591 dev_err(&port->dev, "Number of data bits requested "
592 "not supported by device\n");
595 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))) {
596 cp2101_get_config(port, CP2101_BITS, &bits, 2);
597 bits &= ~BITS_PARITY_MASK;
598 if (cflag & PARENB) {
599 if (cflag & PARODD) {
600 bits |= BITS_PARITY_ODD;
601 dbg("%s - parity = ODD", __func__);
603 bits |= BITS_PARITY_EVEN;
604 dbg("%s - parity = EVEN", __func__);
607 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
608 dev_err(&port->dev, "Parity mode not supported "
612 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
613 cp2101_get_config(port, CP2101_BITS, &bits, 2);
614 bits &= ~BITS_STOP_MASK;
615 if (cflag & CSTOPB) {
617 dbg("%s - stop bits = 2", __func__);
620 dbg("%s - stop bits = 1", __func__);
622 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
623 dev_err(&port->dev, "Number of stop bits requested "
624 "not supported by device\n");
627 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
628 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
629 dbg("%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
630 __func__, modem_ctl[0], modem_ctl[1],
631 modem_ctl[2], modem_ctl[3]);
633 if (cflag & CRTSCTS) {
634 modem_ctl[0] &= ~0x7B;
635 modem_ctl[0] |= 0x09;
637 dbg("%s - flow control = CRTSCTS", __func__);
639 modem_ctl[0] &= ~0x7B;
640 modem_ctl[0] |= 0x01;
641 modem_ctl[1] |= 0x40;
642 dbg("%s - flow control = NONE", __func__);
645 dbg("%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
646 __func__, modem_ctl[0], modem_ctl[1],
647 modem_ctl[2], modem_ctl[3]);
648 cp2101_set_config(port, CP2101_MODEMCTL, modem_ctl, 16);
653 static int cp2101_tiocmset (struct usb_serial_port *port, struct file *file,
654 unsigned int set, unsigned int clear)
658 dbg("%s - port %d", __func__, port->number);
660 if (set & TIOCM_RTS) {
661 control |= CONTROL_RTS;
662 control |= CONTROL_WRITE_RTS;
664 if (set & TIOCM_DTR) {
665 control |= CONTROL_DTR;
666 control |= CONTROL_WRITE_DTR;
668 if (clear & TIOCM_RTS) {
669 control &= ~CONTROL_RTS;
670 control |= CONTROL_WRITE_RTS;
672 if (clear & TIOCM_DTR) {
673 control &= ~CONTROL_DTR;
674 control |= CONTROL_WRITE_DTR;
677 dbg("%s - control = 0x%.4x", __func__, control);
679 return cp2101_set_config(port, CP2101_CONTROL, &control, 2);
683 static int cp2101_tiocmget (struct usb_serial_port *port, struct file *file)
687 dbg("%s - port %d", __func__, port->number);
689 cp2101_get_config(port, CP2101_CONTROL, &control, 1);
691 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
692 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
693 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
694 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
695 |((control & CONTROL_RING)? TIOCM_RI : 0)
696 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
698 dbg("%s - control = 0x%.2x", __func__, control);
703 static void cp2101_break_ctl (struct usb_serial_port *port, int break_state)
707 dbg("%s - port %d", __func__, port->number);
708 if (break_state == 0)
712 dbg("%s - turning break %s", __func__,
713 state==BREAK_OFF ? "off" : "on");
714 cp2101_set_config(port, CP2101_BREAK, &state, 2);
717 static int cp2101_startup (struct usb_serial *serial)
719 /* CP2101 buffers behave strangely unless device is reset */
720 usb_reset_device(serial->dev);
724 static void cp2101_shutdown (struct usb_serial *serial)
730 /* Stop reads and writes on all ports */
731 for (i=0; i < serial->num_ports; ++i) {
732 cp2101_cleanup(serial->port[i]);
736 static int __init cp2101_init (void)
740 retval = usb_serial_register(&cp2101_device);
742 return retval; /* Failed to register */
744 retval = usb_register(&cp2101_driver);
746 /* Failed to register */
747 usb_serial_deregister(&cp2101_device);
752 info(DRIVER_DESC " " DRIVER_VERSION);
756 static void __exit cp2101_exit (void)
758 usb_deregister (&cp2101_driver);
759 usb_serial_deregister (&cp2101_device);
762 module_init(cp2101_init);
763 module_exit(cp2101_exit);
765 MODULE_DESCRIPTION(DRIVER_DESC);
766 MODULE_VERSION(DRIVER_VERSION);
767 MODULE_LICENSE("GPL");
769 module_param(debug, bool, S_IRUGO | S_IWUSR);
770 MODULE_PARM_DESC(debug, "Enable verbose debugging messages");