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(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
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, 0x803B) }, /* Pololu USB-serial converter */
62 { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
63 { USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
64 { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
65 { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
66 { USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
67 { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
68 { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
69 { USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
70 { USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
71 { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
72 { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
73 { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
74 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
75 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
76 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
77 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
78 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
79 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
80 { } /* Terminating Entry */
83 MODULE_DEVICE_TABLE (usb, id_table);
85 static struct usb_driver cp2101_driver = {
87 .probe = usb_serial_probe,
88 .disconnect = usb_serial_disconnect,
93 static struct usb_serial_driver cp2101_device = {
98 .usb_driver = &cp2101_driver,
100 .num_interrupt_in = 0,
105 .close = cp2101_close,
106 .break_ctl = cp2101_break_ctl,
107 .set_termios = cp2101_set_termios,
108 .tiocmget = cp2101_tiocmget,
109 .tiocmset = cp2101_tiocmset,
110 .attach = cp2101_startup,
111 .shutdown = cp2101_shutdown,
114 /* Config request types */
115 #define REQTYPE_HOST_TO_DEVICE 0x41
116 #define REQTYPE_DEVICE_TO_HOST 0xc1
118 /* Config SET requests. To GET, add 1 to the request number */
119 #define CP2101_UART 0x00 /* Enable / Disable */
120 #define CP2101_BAUDRATE 0x01 /* (BAUD_RATE_GEN_FREQ / baudrate) */
121 #define CP2101_BITS 0x03 /* 0x(0)(databits)(parity)(stopbits) */
122 #define CP2101_BREAK 0x05 /* On / Off */
123 #define CP2101_CONTROL 0x07 /* Flow control line states */
124 #define CP2101_MODEMCTL 0x13 /* Modem controls */
125 #define CP2101_CONFIG_6 0x19 /* 6 bytes of config data ??? */
128 #define UART_ENABLE 0x0001
129 #define UART_DISABLE 0x0000
131 /* CP2101_BAUDRATE */
132 #define BAUD_RATE_GEN_FREQ 0x384000
135 #define BITS_DATA_MASK 0X0f00
136 #define BITS_DATA_5 0X0500
137 #define BITS_DATA_6 0X0600
138 #define BITS_DATA_7 0X0700
139 #define BITS_DATA_8 0X0800
140 #define BITS_DATA_9 0X0900
142 #define BITS_PARITY_MASK 0x00f0
143 #define BITS_PARITY_NONE 0x0000
144 #define BITS_PARITY_ODD 0x0010
145 #define BITS_PARITY_EVEN 0x0020
146 #define BITS_PARITY_MARK 0x0030
147 #define BITS_PARITY_SPACE 0x0040
149 #define BITS_STOP_MASK 0x000f
150 #define BITS_STOP_1 0x0000
151 #define BITS_STOP_1_5 0x0001
152 #define BITS_STOP_2 0x0002
155 #define BREAK_ON 0x0000
156 #define BREAK_OFF 0x0001
159 #define CONTROL_DTR 0x0001
160 #define CONTROL_RTS 0x0002
161 #define CONTROL_CTS 0x0010
162 #define CONTROL_DSR 0x0020
163 #define CONTROL_RING 0x0040
164 #define CONTROL_DCD 0x0080
165 #define CONTROL_WRITE_DTR 0x0100
166 #define CONTROL_WRITE_RTS 0x0200
170 * Reads from the CP2101 configuration registers
171 * 'size' is specified in bytes.
172 * 'data' is a pointer to a pre-allocated array of integers large
173 * enough to hold 'size' bytes (with 4 bytes to each integer)
175 static int cp2101_get_config(struct usb_serial_port* port, u8 request,
176 unsigned int *data, int size)
178 struct usb_serial *serial = port->serial;
180 int result, i, length;
182 /* Number of integers required to contain the array */
183 length = (((size - 1) | 3) + 1)/4;
185 buf = kcalloc(length, sizeof(__le32), GFP_KERNEL);
187 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
191 /* For get requests, the request number must be incremented */
194 /* Issue the request, attempting to read 'size' bytes */
195 result = usb_control_msg (serial->dev,usb_rcvctrlpipe (serial->dev, 0),
196 request, REQTYPE_DEVICE_TO_HOST, 0x0000,
199 /* Convert data into an array of integers */
200 for (i=0; i<length; i++)
201 data[i] = le32_to_cpu(buf[i]);
205 if (result != size) {
206 dev_err(&port->dev, "%s - Unable to send config request, "
207 "request=0x%x size=%d result=%d\n",
208 __FUNCTION__, request, size, result);
217 * Writes to the CP2101 configuration registers
218 * Values less than 16 bits wide are sent directly
219 * 'size' is specified in bytes.
221 static int cp2101_set_config(struct usb_serial_port* port, u8 request,
222 unsigned int *data, int size)
224 struct usb_serial *serial = port->serial;
226 int result, i, length;
228 /* Number of integers required to contain the array */
229 length = (((size - 1) | 3) + 1)/4;
231 buf = kmalloc(length * sizeof(__le32), GFP_KERNEL);
233 dev_err(&port->dev, "%s - out of memory.\n",
238 /* Array of integers into bytes */
239 for (i = 0; i < length; i++)
240 buf[i] = cpu_to_le32(data[i]);
243 result = usb_control_msg (serial->dev,
244 usb_sndctrlpipe(serial->dev, 0),
245 request, REQTYPE_HOST_TO_DEVICE, 0x0000,
248 result = usb_control_msg (serial->dev,
249 usb_sndctrlpipe(serial->dev, 0),
250 request, REQTYPE_HOST_TO_DEVICE, data[0],
256 if ((size > 2 && result != size) || result < 0) {
257 dev_err(&port->dev, "%s - Unable to send request, "
258 "request=0x%x size=%d result=%d\n",
259 __FUNCTION__, request, size, result);
263 /* Single data value */
264 result = usb_control_msg (serial->dev,
265 usb_sndctrlpipe(serial->dev, 0),
266 request, REQTYPE_HOST_TO_DEVICE, data[0],
272 * cp2101_set_config_single
273 * Convenience function for calling cp2101_set_config on single data values
274 * without requiring an integer pointer
276 static inline int cp2101_set_config_single(struct usb_serial_port* port,
277 u8 request, unsigned int data)
279 return cp2101_set_config(port, request, &data, 2);
282 static int cp2101_open (struct usb_serial_port *port, struct file *filp)
284 struct usb_serial *serial = port->serial;
287 dbg("%s - port %d", __FUNCTION__, port->number);
289 if (cp2101_set_config_single(port, CP2101_UART, UART_ENABLE)) {
290 dev_err(&port->dev, "%s - Unable to enable UART\n",
295 /* Start reading from the device */
296 usb_fill_bulk_urb (port->read_urb, serial->dev,
297 usb_rcvbulkpipe(serial->dev,
298 port->bulk_in_endpointAddress),
299 port->read_urb->transfer_buffer,
300 port->read_urb->transfer_buffer_length,
301 serial->type->read_bulk_callback,
303 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
305 dev_err(&port->dev, "%s - failed resubmitting read urb, "
306 "error %d\n", __FUNCTION__, result);
310 /* Configure the termios structure */
311 cp2101_get_termios(port);
313 /* Set the DTR and RTS pins low */
314 cp2101_tiocmset(port, NULL, TIOCM_DTR | TIOCM_RTS, 0);
319 static void cp2101_cleanup (struct usb_serial_port *port)
321 struct usb_serial *serial = port->serial;
323 dbg("%s - port %d", __FUNCTION__, port->number);
326 /* shutdown any bulk reads that might be going on */
327 if (serial->num_bulk_out)
328 usb_kill_urb(port->write_urb);
329 if (serial->num_bulk_in)
330 usb_kill_urb(port->read_urb);
334 static void cp2101_close (struct usb_serial_port *port, struct file * filp)
336 dbg("%s - port %d", __FUNCTION__, port->number);
338 /* shutdown our urbs */
339 dbg("%s - shutting down urbs", __FUNCTION__);
340 usb_kill_urb(port->write_urb);
341 usb_kill_urb(port->read_urb);
343 cp2101_set_config_single(port, CP2101_UART, UART_DISABLE);
348 * Reads the baud rate, data bits, parity, stop bits and flow control mode
349 * from the device, corrects any unsupported values, and configures the
350 * termios structure to reflect the state of the device
352 static void cp2101_get_termios (struct usb_serial_port *port)
354 unsigned int cflag, modem_ctl[4];
358 dbg("%s - port %d", __FUNCTION__, port->number);
360 if (!port->tty || !port->tty->termios) {
361 dbg("%s - no tty structures", __FUNCTION__);
365 cp2101_get_config(port, CP2101_BAUDRATE, &baud, 2);
366 /* Convert to baudrate */
368 baud = BAUD_RATE_GEN_FREQ / baud;
370 dbg("%s - baud rate = %d", __FUNCTION__, baud);
372 tty_encode_baud_rate(port->tty, baud, baud);
373 cflag = port->tty->termios->c_cflag;
375 cp2101_get_config(port, CP2101_BITS, &bits, 2);
377 switch(bits & BITS_DATA_MASK) {
379 dbg("%s - data bits = 5", __FUNCTION__);
383 dbg("%s - data bits = 6", __FUNCTION__);
387 dbg("%s - data bits = 7", __FUNCTION__);
391 dbg("%s - data bits = 8", __FUNCTION__);
395 dbg("%s - data bits = 9 (not supported, "
396 "using 8 data bits)", __FUNCTION__);
398 bits &= ~BITS_DATA_MASK;
400 cp2101_set_config(port, CP2101_BITS, &bits, 2);
403 dbg("%s - Unknown number of data bits, "
404 "using 8", __FUNCTION__);
406 bits &= ~BITS_DATA_MASK;
408 cp2101_set_config(port, CP2101_BITS, &bits, 2);
412 switch(bits & BITS_PARITY_MASK) {
413 case BITS_PARITY_NONE:
414 dbg("%s - parity = NONE", __FUNCTION__);
417 case BITS_PARITY_ODD:
418 dbg("%s - parity = ODD", __FUNCTION__);
419 cflag |= (PARENB|PARODD);
421 case BITS_PARITY_EVEN:
422 dbg("%s - parity = EVEN", __FUNCTION__);
426 case BITS_PARITY_MARK:
427 dbg("%s - parity = MARK (not supported, "
428 "disabling parity)", __FUNCTION__);
430 bits &= ~BITS_PARITY_MASK;
431 cp2101_set_config(port, CP2101_BITS, &bits, 2);
433 case BITS_PARITY_SPACE:
434 dbg("%s - parity = SPACE (not supported, "
435 "disabling parity)", __FUNCTION__);
437 bits &= ~BITS_PARITY_MASK;
438 cp2101_set_config(port, CP2101_BITS, &bits, 2);
441 dbg("%s - Unknown parity mode, "
442 "disabling parity", __FUNCTION__);
444 bits &= ~BITS_PARITY_MASK;
445 cp2101_set_config(port, CP2101_BITS, &bits, 2);
450 switch(bits & BITS_STOP_MASK) {
452 dbg("%s - stop bits = 1", __FUNCTION__);
455 dbg("%s - stop bits = 1.5 (not supported, "
456 "using 1 stop bit)", __FUNCTION__);
457 bits &= ~BITS_STOP_MASK;
458 cp2101_set_config(port, CP2101_BITS, &bits, 2);
461 dbg("%s - stop bits = 2", __FUNCTION__);
465 dbg("%s - Unknown number of stop bits, "
466 "using 1 stop bit", __FUNCTION__);
467 bits &= ~BITS_STOP_MASK;
468 cp2101_set_config(port, CP2101_BITS, &bits, 2);
472 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
473 if (modem_ctl[0] & 0x0008) {
474 dbg("%s - flow control = CRTSCTS", __FUNCTION__);
477 dbg("%s - flow control = NONE", __FUNCTION__);
481 port->tty->termios->c_cflag = cflag;
484 static void cp2101_set_termios (struct usb_serial_port *port,
485 struct ktermios *old_termios)
487 unsigned int cflag, old_cflag;
489 unsigned int modem_ctl[4];
491 dbg("%s - port %d", __FUNCTION__, port->number);
493 if (!port->tty || !port->tty->termios) {
494 dbg("%s - no tty structures", __FUNCTION__);
497 port->tty->termios->c_cflag &= ~CMSPAR;
499 cflag = port->tty->termios->c_cflag;
500 old_cflag = old_termios->c_cflag;
501 baud = tty_get_baud_rate(port->tty);
503 /* If the baud rate is to be updated*/
504 if (baud != tty_termios_baud_rate(old_termios)) {
533 dbg("%s - Setting baud rate to %d baud", __FUNCTION__,
535 if (cp2101_set_config_single(port, CP2101_BAUDRATE,
536 (BAUD_RATE_GEN_FREQ / baud))) {
537 dev_err(&port->dev, "Baud rate requested not "
538 "supported by device\n");
539 baud = tty_termios_baud_rate(old_termios);
543 /* Report back the resulting baud rate */
544 tty_encode_baud_rate(port->tty, baud, baud);
546 /* If the number of data bits is to be updated */
547 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
548 cp2101_get_config(port, CP2101_BITS, &bits, 2);
549 bits &= ~BITS_DATA_MASK;
550 switch (cflag & CSIZE) {
553 dbg("%s - data bits = 5", __FUNCTION__);
557 dbg("%s - data bits = 6", __FUNCTION__);
561 dbg("%s - data bits = 7", __FUNCTION__);
565 dbg("%s - data bits = 8", __FUNCTION__);
569 dbg("%s - data bits = 9", __FUNCTION__);
572 dev_err(&port->dev, "cp2101 driver does not "
573 "support the number of bits requested,"
574 " using 8 bit mode\n");
578 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
579 dev_err(&port->dev, "Number of data bits requested "
580 "not supported by device\n");
583 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))) {
584 cp2101_get_config(port, CP2101_BITS, &bits, 2);
585 bits &= ~BITS_PARITY_MASK;
586 if (cflag & PARENB) {
587 if (cflag & PARODD) {
588 bits |= BITS_PARITY_ODD;
589 dbg("%s - parity = ODD", __FUNCTION__);
591 bits |= BITS_PARITY_EVEN;
592 dbg("%s - parity = EVEN", __FUNCTION__);
595 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
596 dev_err(&port->dev, "Parity mode not supported "
600 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
601 cp2101_get_config(port, CP2101_BITS, &bits, 2);
602 bits &= ~BITS_STOP_MASK;
603 if (cflag & CSTOPB) {
605 dbg("%s - stop bits = 2", __FUNCTION__);
608 dbg("%s - stop bits = 1", __FUNCTION__);
610 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
611 dev_err(&port->dev, "Number of stop bits requested "
612 "not supported by device\n");
615 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
616 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
617 dbg("%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
618 __FUNCTION__, modem_ctl[0], modem_ctl[1],
619 modem_ctl[2], modem_ctl[3]);
621 if (cflag & CRTSCTS) {
622 modem_ctl[0] &= ~0x7B;
623 modem_ctl[0] |= 0x09;
625 dbg("%s - flow control = CRTSCTS", __FUNCTION__);
627 modem_ctl[0] &= ~0x7B;
628 modem_ctl[0] |= 0x01;
629 modem_ctl[1] |= 0x40;
630 dbg("%s - flow control = NONE", __FUNCTION__);
633 dbg("%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
634 __FUNCTION__, modem_ctl[0], modem_ctl[1],
635 modem_ctl[2], modem_ctl[3]);
636 cp2101_set_config(port, CP2101_MODEMCTL, modem_ctl, 16);
641 static int cp2101_tiocmset (struct usb_serial_port *port, struct file *file,
642 unsigned int set, unsigned int clear)
646 dbg("%s - port %d", __FUNCTION__, port->number);
648 if (set & TIOCM_RTS) {
649 control |= CONTROL_RTS;
650 control |= CONTROL_WRITE_RTS;
652 if (set & TIOCM_DTR) {
653 control |= CONTROL_DTR;
654 control |= CONTROL_WRITE_DTR;
656 if (clear & TIOCM_RTS) {
657 control &= ~CONTROL_RTS;
658 control |= CONTROL_WRITE_RTS;
660 if (clear & TIOCM_DTR) {
661 control &= ~CONTROL_DTR;
662 control |= CONTROL_WRITE_DTR;
665 dbg("%s - control = 0x%.4x", __FUNCTION__, control);
667 return cp2101_set_config(port, CP2101_CONTROL, &control, 2);
671 static int cp2101_tiocmget (struct usb_serial_port *port, struct file *file)
675 dbg("%s - port %d", __FUNCTION__, port->number);
677 cp2101_get_config(port, CP2101_CONTROL, &control, 1);
679 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
680 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
681 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
682 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
683 |((control & CONTROL_RING)? TIOCM_RI : 0)
684 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
686 dbg("%s - control = 0x%.2x", __FUNCTION__, control);
691 static void cp2101_break_ctl (struct usb_serial_port *port, int break_state)
695 dbg("%s - port %d", __FUNCTION__, port->number);
696 if (break_state == 0)
700 dbg("%s - turning break %s", __FUNCTION__,
701 state==BREAK_OFF ? "off" : "on");
702 cp2101_set_config(port, CP2101_BREAK, &state, 2);
705 static int cp2101_startup (struct usb_serial *serial)
707 /* CP2101 buffers behave strangely unless device is reset */
708 usb_reset_device(serial->dev);
712 static void cp2101_shutdown (struct usb_serial *serial)
716 dbg("%s", __FUNCTION__);
718 /* Stop reads and writes on all ports */
719 for (i=0; i < serial->num_ports; ++i) {
720 cp2101_cleanup(serial->port[i]);
724 static int __init cp2101_init (void)
728 retval = usb_serial_register(&cp2101_device);
730 return retval; /* Failed to register */
732 retval = usb_register(&cp2101_driver);
734 /* Failed to register */
735 usb_serial_deregister(&cp2101_device);
740 info(DRIVER_DESC " " DRIVER_VERSION);
744 static void __exit cp2101_exit (void)
746 usb_deregister (&cp2101_driver);
747 usb_serial_deregister (&cp2101_device);
750 module_init(cp2101_init);
751 module_exit(cp2101_exit);
753 MODULE_DESCRIPTION(DRIVER_DESC);
754 MODULE_VERSION(DRIVER_VERSION);
755 MODULE_LICENSE("GPL");
757 module_param(debug, bool, S_IRUGO | S_IWUSR);
758 MODULE_PARM_DESC(debug, "Enable verbose debugging messages");