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(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
59 { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
60 { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
61 { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
62 { USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
63 { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
64 { USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
65 { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
66 { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
67 { USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
68 { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
69 { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
70 { USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
71 { USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
72 { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
73 { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
74 { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
75 { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
76 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
77 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
78 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
79 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
80 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
81 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
82 { } /* Terminating Entry */
85 MODULE_DEVICE_TABLE (usb, id_table);
87 static struct usb_driver cp2101_driver = {
89 .probe = usb_serial_probe,
90 .disconnect = usb_serial_disconnect,
95 static struct usb_serial_driver cp2101_device = {
100 .usb_driver = &cp2101_driver,
101 .id_table = id_table,
102 .num_interrupt_in = 0,
103 .num_bulk_in = NUM_DONT_CARE,
104 .num_bulk_out = NUM_DONT_CARE,
107 .close = cp2101_close,
108 .break_ctl = cp2101_break_ctl,
109 .set_termios = cp2101_set_termios,
110 .tiocmget = cp2101_tiocmget,
111 .tiocmset = cp2101_tiocmset,
112 .attach = cp2101_startup,
113 .shutdown = cp2101_shutdown,
116 /* Config request types */
117 #define REQTYPE_HOST_TO_DEVICE 0x41
118 #define REQTYPE_DEVICE_TO_HOST 0xc1
120 /* Config SET requests. To GET, add 1 to the request number */
121 #define CP2101_UART 0x00 /* Enable / Disable */
122 #define CP2101_BAUDRATE 0x01 /* (BAUD_RATE_GEN_FREQ / baudrate) */
123 #define CP2101_BITS 0x03 /* 0x(0)(databits)(parity)(stopbits) */
124 #define CP2101_BREAK 0x05 /* On / Off */
125 #define CP2101_CONTROL 0x07 /* Flow control line states */
126 #define CP2101_MODEMCTL 0x13 /* Modem controls */
127 #define CP2101_CONFIG_6 0x19 /* 6 bytes of config data ??? */
130 #define UART_ENABLE 0x0001
131 #define UART_DISABLE 0x0000
133 /* CP2101_BAUDRATE */
134 #define BAUD_RATE_GEN_FREQ 0x384000
137 #define BITS_DATA_MASK 0X0f00
138 #define BITS_DATA_5 0X0500
139 #define BITS_DATA_6 0X0600
140 #define BITS_DATA_7 0X0700
141 #define BITS_DATA_8 0X0800
142 #define BITS_DATA_9 0X0900
144 #define BITS_PARITY_MASK 0x00f0
145 #define BITS_PARITY_NONE 0x0000
146 #define BITS_PARITY_ODD 0x0010
147 #define BITS_PARITY_EVEN 0x0020
148 #define BITS_PARITY_MARK 0x0030
149 #define BITS_PARITY_SPACE 0x0040
151 #define BITS_STOP_MASK 0x000f
152 #define BITS_STOP_1 0x0000
153 #define BITS_STOP_1_5 0x0001
154 #define BITS_STOP_2 0x0002
157 #define BREAK_ON 0x0000
158 #define BREAK_OFF 0x0001
161 #define CONTROL_DTR 0x0001
162 #define CONTROL_RTS 0x0002
163 #define CONTROL_CTS 0x0010
164 #define CONTROL_DSR 0x0020
165 #define CONTROL_RING 0x0040
166 #define CONTROL_DCD 0x0080
167 #define CONTROL_WRITE_DTR 0x0100
168 #define CONTROL_WRITE_RTS 0x0200
172 * Reads from the CP2101 configuration registers
173 * 'size' is specified in bytes.
174 * 'data' is a pointer to a pre-allocated array of integers large
175 * enough to hold 'size' bytes (with 4 bytes to each integer)
177 static int cp2101_get_config(struct usb_serial_port* port, u8 request,
178 unsigned int *data, int size)
180 struct usb_serial *serial = port->serial;
182 int result, i, length;
184 /* Number of integers required to contain the array */
185 length = (((size - 1) | 3) + 1)/4;
187 buf = kcalloc(length, sizeof(__le32), GFP_KERNEL);
189 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
193 /* For get requests, the request number must be incremented */
196 /* Issue the request, attempting to read 'size' bytes */
197 result = usb_control_msg (serial->dev,usb_rcvctrlpipe (serial->dev, 0),
198 request, REQTYPE_DEVICE_TO_HOST, 0x0000,
201 /* Convert data into an array of integers */
202 for (i=0; i<length; i++)
203 data[i] = le32_to_cpu(buf[i]);
207 if (result != size) {
208 dev_err(&port->dev, "%s - Unable to send config request, "
209 "request=0x%x size=%d result=%d\n",
210 __FUNCTION__, request, size, result);
219 * Writes to the CP2101 configuration registers
220 * Values less than 16 bits wide are sent directly
221 * 'size' is specified in bytes.
223 static int cp2101_set_config(struct usb_serial_port* port, u8 request,
224 unsigned int *data, int size)
226 struct usb_serial *serial = port->serial;
228 int result, i, length;
230 /* Number of integers required to contain the array */
231 length = (((size - 1) | 3) + 1)/4;
233 buf = kmalloc(length * sizeof(__le32), GFP_KERNEL);
235 dev_err(&port->dev, "%s - out of memory.\n",
240 /* Array of integers into bytes */
241 for (i = 0; i < length; i++)
242 buf[i] = cpu_to_le32(data[i]);
245 result = usb_control_msg (serial->dev,
246 usb_sndctrlpipe(serial->dev, 0),
247 request, REQTYPE_HOST_TO_DEVICE, 0x0000,
250 result = usb_control_msg (serial->dev,
251 usb_sndctrlpipe(serial->dev, 0),
252 request, REQTYPE_HOST_TO_DEVICE, data[0],
258 if ((size > 2 && result != size) || result < 0) {
259 dev_err(&port->dev, "%s - Unable to send request, "
260 "request=0x%x size=%d result=%d\n",
261 __FUNCTION__, request, size, result);
265 /* Single data value */
266 result = usb_control_msg (serial->dev,
267 usb_sndctrlpipe(serial->dev, 0),
268 request, REQTYPE_HOST_TO_DEVICE, data[0],
274 * cp2101_set_config_single
275 * Convenience function for calling cp2101_set_config on single data values
276 * without requiring an integer pointer
278 static inline int cp2101_set_config_single(struct usb_serial_port* port,
279 u8 request, unsigned int data)
281 return cp2101_set_config(port, request, &data, 2);
284 static int cp2101_open (struct usb_serial_port *port, struct file *filp)
286 struct usb_serial *serial = port->serial;
289 dbg("%s - port %d", __FUNCTION__, port->number);
291 if (cp2101_set_config_single(port, CP2101_UART, UART_ENABLE)) {
292 dev_err(&port->dev, "%s - Unable to enable UART\n",
297 /* Start reading from the device */
298 usb_fill_bulk_urb (port->read_urb, serial->dev,
299 usb_rcvbulkpipe(serial->dev,
300 port->bulk_in_endpointAddress),
301 port->read_urb->transfer_buffer,
302 port->read_urb->transfer_buffer_length,
303 serial->type->read_bulk_callback,
305 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
307 dev_err(&port->dev, "%s - failed resubmitting read urb, "
308 "error %d\n", __FUNCTION__, result);
312 /* Configure the termios structure */
313 cp2101_get_termios(port);
315 /* Set the DTR and RTS pins low */
316 cp2101_tiocmset(port, NULL, TIOCM_DTR | TIOCM_RTS, 0);
321 static void cp2101_cleanup (struct usb_serial_port *port)
323 struct usb_serial *serial = port->serial;
325 dbg("%s - port %d", __FUNCTION__, port->number);
328 /* shutdown any bulk reads that might be going on */
329 if (serial->num_bulk_out)
330 usb_kill_urb(port->write_urb);
331 if (serial->num_bulk_in)
332 usb_kill_urb(port->read_urb);
336 static void cp2101_close (struct usb_serial_port *port, struct file * filp)
338 dbg("%s - port %d", __FUNCTION__, port->number);
340 /* shutdown our urbs */
341 dbg("%s - shutting down urbs", __FUNCTION__);
342 usb_kill_urb(port->write_urb);
343 usb_kill_urb(port->read_urb);
345 cp2101_set_config_single(port, CP2101_UART, UART_DISABLE);
350 * Reads the baud rate, data bits, parity, stop bits and flow control mode
351 * from the device, corrects any unsupported values, and configures the
352 * termios structure to reflect the state of the device
354 static void cp2101_get_termios (struct usb_serial_port *port)
356 unsigned int cflag, modem_ctl[4];
360 dbg("%s - port %d", __FUNCTION__, port->number);
362 if (!port->tty || !port->tty->termios) {
363 dbg("%s - no tty structures", __FUNCTION__);
367 cp2101_get_config(port, CP2101_BAUDRATE, &baud, 2);
368 /* Convert to baudrate */
370 baud = BAUD_RATE_GEN_FREQ / baud;
372 dbg("%s - baud rate = %d", __FUNCTION__, baud);
374 tty_encode_baud_rate(port->tty, baud, baud);
375 cflag = port->tty->termios->c_cflag;
377 cp2101_get_config(port, CP2101_BITS, &bits, 2);
379 switch(bits & BITS_DATA_MASK) {
381 dbg("%s - data bits = 5", __FUNCTION__);
385 dbg("%s - data bits = 6", __FUNCTION__);
389 dbg("%s - data bits = 7", __FUNCTION__);
393 dbg("%s - data bits = 8", __FUNCTION__);
397 dbg("%s - data bits = 9 (not supported, "
398 "using 8 data bits)", __FUNCTION__);
400 bits &= ~BITS_DATA_MASK;
402 cp2101_set_config(port, CP2101_BITS, &bits, 2);
405 dbg("%s - Unknown number of data bits, "
406 "using 8", __FUNCTION__);
408 bits &= ~BITS_DATA_MASK;
410 cp2101_set_config(port, CP2101_BITS, &bits, 2);
414 switch(bits & BITS_PARITY_MASK) {
415 case BITS_PARITY_NONE:
416 dbg("%s - parity = NONE", __FUNCTION__);
419 case BITS_PARITY_ODD:
420 dbg("%s - parity = ODD", __FUNCTION__);
421 cflag |= (PARENB|PARODD);
423 case BITS_PARITY_EVEN:
424 dbg("%s - parity = EVEN", __FUNCTION__);
428 case BITS_PARITY_MARK:
429 dbg("%s - parity = MARK (not supported, "
430 "disabling parity)", __FUNCTION__);
432 bits &= ~BITS_PARITY_MASK;
433 cp2101_set_config(port, CP2101_BITS, &bits, 2);
435 case BITS_PARITY_SPACE:
436 dbg("%s - parity = SPACE (not supported, "
437 "disabling parity)", __FUNCTION__);
439 bits &= ~BITS_PARITY_MASK;
440 cp2101_set_config(port, CP2101_BITS, &bits, 2);
443 dbg("%s - Unknown parity mode, "
444 "disabling parity", __FUNCTION__);
446 bits &= ~BITS_PARITY_MASK;
447 cp2101_set_config(port, CP2101_BITS, &bits, 2);
452 switch(bits & BITS_STOP_MASK) {
454 dbg("%s - stop bits = 1", __FUNCTION__);
457 dbg("%s - stop bits = 1.5 (not supported, "
458 "using 1 stop bit)", __FUNCTION__);
459 bits &= ~BITS_STOP_MASK;
460 cp2101_set_config(port, CP2101_BITS, &bits, 2);
463 dbg("%s - stop bits = 2", __FUNCTION__);
467 dbg("%s - Unknown number of stop bits, "
468 "using 1 stop bit", __FUNCTION__);
469 bits &= ~BITS_STOP_MASK;
470 cp2101_set_config(port, CP2101_BITS, &bits, 2);
474 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
475 if (modem_ctl[0] & 0x0008) {
476 dbg("%s - flow control = CRTSCTS", __FUNCTION__);
479 dbg("%s - flow control = NONE", __FUNCTION__);
483 port->tty->termios->c_cflag = cflag;
486 static void cp2101_set_termios (struct usb_serial_port *port,
487 struct ktermios *old_termios)
489 unsigned int cflag, old_cflag;
491 unsigned int modem_ctl[4];
493 dbg("%s - port %d", __FUNCTION__, port->number);
495 if (!port->tty || !port->tty->termios) {
496 dbg("%s - no tty structures", __FUNCTION__);
499 port->tty->termios->c_cflag &= ~CMSPAR;
501 cflag = port->tty->termios->c_cflag;
502 old_cflag = old_termios->c_cflag;
503 baud = tty_get_baud_rate(port->tty);
505 /* If the baud rate is to be updated*/
506 if (baud != tty_termios_baud_rate(old_termios)) {
535 dbg("%s - Setting baud rate to %d baud", __FUNCTION__,
537 if (cp2101_set_config_single(port, CP2101_BAUDRATE,
538 (BAUD_RATE_GEN_FREQ / baud))) {
539 dev_err(&port->dev, "Baud rate requested not "
540 "supported by device\n");
541 baud = tty_termios_baud_rate(old_termios);
545 /* Report back the resulting baud rate */
546 tty_encode_baud_rate(port->tty, baud, baud);
548 /* If the number of data bits is to be updated */
549 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
550 cp2101_get_config(port, CP2101_BITS, &bits, 2);
551 bits &= ~BITS_DATA_MASK;
552 switch (cflag & CSIZE) {
555 dbg("%s - data bits = 5", __FUNCTION__);
559 dbg("%s - data bits = 6", __FUNCTION__);
563 dbg("%s - data bits = 7", __FUNCTION__);
567 dbg("%s - data bits = 8", __FUNCTION__);
571 dbg("%s - data bits = 9", __FUNCTION__);
574 dev_err(&port->dev, "cp2101 driver does not "
575 "support the number of bits requested,"
576 " using 8 bit mode\n");
580 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
581 dev_err(&port->dev, "Number of data bits requested "
582 "not supported by device\n");
585 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))) {
586 cp2101_get_config(port, CP2101_BITS, &bits, 2);
587 bits &= ~BITS_PARITY_MASK;
588 if (cflag & PARENB) {
589 if (cflag & PARODD) {
590 bits |= BITS_PARITY_ODD;
591 dbg("%s - parity = ODD", __FUNCTION__);
593 bits |= BITS_PARITY_EVEN;
594 dbg("%s - parity = EVEN", __FUNCTION__);
597 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
598 dev_err(&port->dev, "Parity mode not supported "
602 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
603 cp2101_get_config(port, CP2101_BITS, &bits, 2);
604 bits &= ~BITS_STOP_MASK;
605 if (cflag & CSTOPB) {
607 dbg("%s - stop bits = 2", __FUNCTION__);
610 dbg("%s - stop bits = 1", __FUNCTION__);
612 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
613 dev_err(&port->dev, "Number of stop bits requested "
614 "not supported by device\n");
617 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
618 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
619 dbg("%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
620 __FUNCTION__, modem_ctl[0], modem_ctl[1],
621 modem_ctl[2], modem_ctl[3]);
623 if (cflag & CRTSCTS) {
624 modem_ctl[0] &= ~0x7B;
625 modem_ctl[0] |= 0x09;
627 dbg("%s - flow control = CRTSCTS", __FUNCTION__);
629 modem_ctl[0] &= ~0x7B;
630 modem_ctl[0] |= 0x01;
631 modem_ctl[1] |= 0x40;
632 dbg("%s - flow control = NONE", __FUNCTION__);
635 dbg("%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
636 __FUNCTION__, modem_ctl[0], modem_ctl[1],
637 modem_ctl[2], modem_ctl[3]);
638 cp2101_set_config(port, CP2101_MODEMCTL, modem_ctl, 16);
643 static int cp2101_tiocmset (struct usb_serial_port *port, struct file *file,
644 unsigned int set, unsigned int clear)
648 dbg("%s - port %d", __FUNCTION__, port->number);
650 if (set & TIOCM_RTS) {
651 control |= CONTROL_RTS;
652 control |= CONTROL_WRITE_RTS;
654 if (set & TIOCM_DTR) {
655 control |= CONTROL_DTR;
656 control |= CONTROL_WRITE_DTR;
658 if (clear & TIOCM_RTS) {
659 control &= ~CONTROL_RTS;
660 control |= CONTROL_WRITE_RTS;
662 if (clear & TIOCM_DTR) {
663 control &= ~CONTROL_DTR;
664 control |= CONTROL_WRITE_DTR;
667 dbg("%s - control = 0x%.4x", __FUNCTION__, control);
669 return cp2101_set_config(port, CP2101_CONTROL, &control, 2);
673 static int cp2101_tiocmget (struct usb_serial_port *port, struct file *file)
677 dbg("%s - port %d", __FUNCTION__, port->number);
679 cp2101_get_config(port, CP2101_CONTROL, &control, 1);
681 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
682 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
683 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
684 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
685 |((control & CONTROL_RING)? TIOCM_RI : 0)
686 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
688 dbg("%s - control = 0x%.2x", __FUNCTION__, control);
693 static void cp2101_break_ctl (struct usb_serial_port *port, int break_state)
697 dbg("%s - port %d", __FUNCTION__, port->number);
698 if (break_state == 0)
702 dbg("%s - turning break %s", __FUNCTION__,
703 state==BREAK_OFF ? "off" : "on");
704 cp2101_set_config(port, CP2101_BREAK, &state, 2);
707 static int cp2101_startup (struct usb_serial *serial)
709 /* CP2101 buffers behave strangely unless device is reset */
710 usb_reset_device(serial->dev);
714 static void cp2101_shutdown (struct usb_serial *serial)
718 dbg("%s", __FUNCTION__);
720 /* Stop reads and writes on all ports */
721 for (i=0; i < serial->num_ports; ++i) {
722 cp2101_cleanup(serial->port[i]);
726 static int __init cp2101_init (void)
730 retval = usb_serial_register(&cp2101_device);
732 return retval; /* Failed to register */
734 retval = usb_register(&cp2101_driver);
736 /* Failed to register */
737 usb_serial_deregister(&cp2101_device);
742 info(DRIVER_DESC " " DRIVER_VERSION);
746 static void __exit cp2101_exit (void)
748 usb_deregister (&cp2101_driver);
749 usb_serial_deregister (&cp2101_device);
752 module_init(cp2101_init);
753 module_exit(cp2101_exit);
755 MODULE_DESCRIPTION(DRIVER_DESC);
756 MODULE_VERSION(DRIVER_VERSION);
757 MODULE_LICENSE("GPL");
759 module_param(debug, bool, S_IRUGO | S_IWUSR);
760 MODULE_PARM_DESC(debug, "Enable verbose debugging messages");