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, 0x81E7) }, /* Aerocomm Radio */
75 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
76 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
77 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
78 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
79 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
80 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
81 { } /* Terminating Entry */
84 MODULE_DEVICE_TABLE (usb, id_table);
86 static struct usb_driver cp2101_driver = {
88 .probe = usb_serial_probe,
89 .disconnect = usb_serial_disconnect,
94 static struct usb_serial_driver cp2101_device = {
99 .usb_driver = &cp2101_driver,
100 .id_table = id_table,
101 .num_interrupt_in = 0,
102 .num_bulk_in = NUM_DONT_CARE,
103 .num_bulk_out = NUM_DONT_CARE,
106 .close = cp2101_close,
107 .break_ctl = cp2101_break_ctl,
108 .set_termios = cp2101_set_termios,
109 .tiocmget = cp2101_tiocmget,
110 .tiocmset = cp2101_tiocmset,
111 .attach = cp2101_startup,
112 .shutdown = cp2101_shutdown,
115 /* Config request types */
116 #define REQTYPE_HOST_TO_DEVICE 0x41
117 #define REQTYPE_DEVICE_TO_HOST 0xc1
119 /* Config SET requests. To GET, add 1 to the request number */
120 #define CP2101_UART 0x00 /* Enable / Disable */
121 #define CP2101_BAUDRATE 0x01 /* (BAUD_RATE_GEN_FREQ / baudrate) */
122 #define CP2101_BITS 0x03 /* 0x(0)(databits)(parity)(stopbits) */
123 #define CP2101_BREAK 0x05 /* On / Off */
124 #define CP2101_CONTROL 0x07 /* Flow control line states */
125 #define CP2101_MODEMCTL 0x13 /* Modem controls */
126 #define CP2101_CONFIG_6 0x19 /* 6 bytes of config data ??? */
129 #define UART_ENABLE 0x0001
130 #define UART_DISABLE 0x0000
132 /* CP2101_BAUDRATE */
133 #define BAUD_RATE_GEN_FREQ 0x384000
136 #define BITS_DATA_MASK 0X0f00
137 #define BITS_DATA_5 0X0500
138 #define BITS_DATA_6 0X0600
139 #define BITS_DATA_7 0X0700
140 #define BITS_DATA_8 0X0800
141 #define BITS_DATA_9 0X0900
143 #define BITS_PARITY_MASK 0x00f0
144 #define BITS_PARITY_NONE 0x0000
145 #define BITS_PARITY_ODD 0x0010
146 #define BITS_PARITY_EVEN 0x0020
147 #define BITS_PARITY_MARK 0x0030
148 #define BITS_PARITY_SPACE 0x0040
150 #define BITS_STOP_MASK 0x000f
151 #define BITS_STOP_1 0x0000
152 #define BITS_STOP_1_5 0x0001
153 #define BITS_STOP_2 0x0002
156 #define BREAK_ON 0x0000
157 #define BREAK_OFF 0x0001
160 #define CONTROL_DTR 0x0001
161 #define CONTROL_RTS 0x0002
162 #define CONTROL_CTS 0x0010
163 #define CONTROL_DSR 0x0020
164 #define CONTROL_RING 0x0040
165 #define CONTROL_DCD 0x0080
166 #define CONTROL_WRITE_DTR 0x0100
167 #define CONTROL_WRITE_RTS 0x0200
171 * Reads from the CP2101 configuration registers
172 * 'size' is specified in bytes.
173 * 'data' is a pointer to a pre-allocated array of integers large
174 * enough to hold 'size' bytes (with 4 bytes to each integer)
176 static int cp2101_get_config(struct usb_serial_port* port, u8 request,
177 unsigned int *data, int size)
179 struct usb_serial *serial = port->serial;
181 int result, i, length;
183 /* Number of integers required to contain the array */
184 length = (((size - 1) | 3) + 1)/4;
186 buf = kcalloc(length, sizeof(__le32), GFP_KERNEL);
188 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
192 /* For get requests, the request number must be incremented */
195 /* Issue the request, attempting to read 'size' bytes */
196 result = usb_control_msg (serial->dev,usb_rcvctrlpipe (serial->dev, 0),
197 request, REQTYPE_DEVICE_TO_HOST, 0x0000,
200 /* Convert data into an array of integers */
201 for (i=0; i<length; i++)
202 data[i] = le32_to_cpu(buf[i]);
206 if (result != size) {
207 dev_err(&port->dev, "%s - Unable to send config request, "
208 "request=0x%x size=%d result=%d\n",
209 __FUNCTION__, request, size, result);
218 * Writes to the CP2101 configuration registers
219 * Values less than 16 bits wide are sent directly
220 * 'size' is specified in bytes.
222 static int cp2101_set_config(struct usb_serial_port* port, u8 request,
223 unsigned int *data, int size)
225 struct usb_serial *serial = port->serial;
227 int result, i, length;
229 /* Number of integers required to contain the array */
230 length = (((size - 1) | 3) + 1)/4;
232 buf = kmalloc(length * sizeof(__le32), GFP_KERNEL);
234 dev_err(&port->dev, "%s - out of memory.\n",
239 /* Array of integers into bytes */
240 for (i = 0; i < length; i++)
241 buf[i] = cpu_to_le32(data[i]);
244 result = usb_control_msg (serial->dev,
245 usb_sndctrlpipe(serial->dev, 0),
246 request, REQTYPE_HOST_TO_DEVICE, 0x0000,
249 result = usb_control_msg (serial->dev,
250 usb_sndctrlpipe(serial->dev, 0),
251 request, REQTYPE_HOST_TO_DEVICE, data[0],
257 if ((size > 2 && result != size) || result < 0) {
258 dev_err(&port->dev, "%s - Unable to send request, "
259 "request=0x%x size=%d result=%d\n",
260 __FUNCTION__, request, size, result);
264 /* Single data value */
265 result = usb_control_msg (serial->dev,
266 usb_sndctrlpipe(serial->dev, 0),
267 request, REQTYPE_HOST_TO_DEVICE, data[0],
273 * cp2101_set_config_single
274 * Convenience function for calling cp2101_set_config on single data values
275 * without requiring an integer pointer
277 static inline int cp2101_set_config_single(struct usb_serial_port* port,
278 u8 request, unsigned int data)
280 return cp2101_set_config(port, request, &data, 2);
283 static int cp2101_open (struct usb_serial_port *port, struct file *filp)
285 struct usb_serial *serial = port->serial;
288 dbg("%s - port %d", __FUNCTION__, port->number);
290 if (cp2101_set_config_single(port, CP2101_UART, UART_ENABLE)) {
291 dev_err(&port->dev, "%s - Unable to enable UART\n",
296 /* Start reading from the device */
297 usb_fill_bulk_urb (port->read_urb, serial->dev,
298 usb_rcvbulkpipe(serial->dev,
299 port->bulk_in_endpointAddress),
300 port->read_urb->transfer_buffer,
301 port->read_urb->transfer_buffer_length,
302 serial->type->read_bulk_callback,
304 result = usb_submit_urb(port->read_urb, GFP_KERNEL);
306 dev_err(&port->dev, "%s - failed resubmitting read urb, "
307 "error %d\n", __FUNCTION__, result);
311 /* Configure the termios structure */
312 cp2101_get_termios(port);
314 /* Set the DTR and RTS pins low */
315 cp2101_tiocmset(port, NULL, TIOCM_DTR | TIOCM_RTS, 0);
320 static void cp2101_cleanup (struct usb_serial_port *port)
322 struct usb_serial *serial = port->serial;
324 dbg("%s - port %d", __FUNCTION__, port->number);
327 /* shutdown any bulk reads that might be going on */
328 if (serial->num_bulk_out)
329 usb_kill_urb(port->write_urb);
330 if (serial->num_bulk_in)
331 usb_kill_urb(port->read_urb);
335 static void cp2101_close (struct usb_serial_port *port, struct file * filp)
337 dbg("%s - port %d", __FUNCTION__, port->number);
339 /* shutdown our urbs */
340 dbg("%s - shutting down urbs", __FUNCTION__);
341 usb_kill_urb(port->write_urb);
342 usb_kill_urb(port->read_urb);
344 cp2101_set_config_single(port, CP2101_UART, UART_DISABLE);
349 * Reads the baud rate, data bits, parity, stop bits and flow control mode
350 * from the device, corrects any unsupported values, and configures the
351 * termios structure to reflect the state of the device
353 static void cp2101_get_termios (struct usb_serial_port *port)
355 unsigned int cflag, modem_ctl[4];
359 dbg("%s - port %d", __FUNCTION__, port->number);
361 if (!port->tty || !port->tty->termios) {
362 dbg("%s - no tty structures", __FUNCTION__);
366 cp2101_get_config(port, CP2101_BAUDRATE, &baud, 2);
367 /* Convert to baudrate */
369 baud = BAUD_RATE_GEN_FREQ / baud;
371 dbg("%s - baud rate = %d", __FUNCTION__, baud);
373 tty_encode_baud_rate(port->tty, baud, baud);
374 cflag = port->tty->termios->c_cflag;
376 cp2101_get_config(port, CP2101_BITS, &bits, 2);
378 switch(bits & BITS_DATA_MASK) {
380 dbg("%s - data bits = 5", __FUNCTION__);
384 dbg("%s - data bits = 6", __FUNCTION__);
388 dbg("%s - data bits = 7", __FUNCTION__);
392 dbg("%s - data bits = 8", __FUNCTION__);
396 dbg("%s - data bits = 9 (not supported, "
397 "using 8 data bits)", __FUNCTION__);
399 bits &= ~BITS_DATA_MASK;
401 cp2101_set_config(port, CP2101_BITS, &bits, 2);
404 dbg("%s - Unknown number of data bits, "
405 "using 8", __FUNCTION__);
407 bits &= ~BITS_DATA_MASK;
409 cp2101_set_config(port, CP2101_BITS, &bits, 2);
413 switch(bits & BITS_PARITY_MASK) {
414 case BITS_PARITY_NONE:
415 dbg("%s - parity = NONE", __FUNCTION__);
418 case BITS_PARITY_ODD:
419 dbg("%s - parity = ODD", __FUNCTION__);
420 cflag |= (PARENB|PARODD);
422 case BITS_PARITY_EVEN:
423 dbg("%s - parity = EVEN", __FUNCTION__);
427 case BITS_PARITY_MARK:
428 dbg("%s - parity = MARK (not supported, "
429 "disabling parity)", __FUNCTION__);
431 bits &= ~BITS_PARITY_MASK;
432 cp2101_set_config(port, CP2101_BITS, &bits, 2);
434 case BITS_PARITY_SPACE:
435 dbg("%s - parity = SPACE (not supported, "
436 "disabling parity)", __FUNCTION__);
438 bits &= ~BITS_PARITY_MASK;
439 cp2101_set_config(port, CP2101_BITS, &bits, 2);
442 dbg("%s - Unknown parity mode, "
443 "disabling parity", __FUNCTION__);
445 bits &= ~BITS_PARITY_MASK;
446 cp2101_set_config(port, CP2101_BITS, &bits, 2);
451 switch(bits & BITS_STOP_MASK) {
453 dbg("%s - stop bits = 1", __FUNCTION__);
456 dbg("%s - stop bits = 1.5 (not supported, "
457 "using 1 stop bit)", __FUNCTION__);
458 bits &= ~BITS_STOP_MASK;
459 cp2101_set_config(port, CP2101_BITS, &bits, 2);
462 dbg("%s - stop bits = 2", __FUNCTION__);
466 dbg("%s - Unknown number of stop bits, "
467 "using 1 stop bit", __FUNCTION__);
468 bits &= ~BITS_STOP_MASK;
469 cp2101_set_config(port, CP2101_BITS, &bits, 2);
473 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
474 if (modem_ctl[0] & 0x0008) {
475 dbg("%s - flow control = CRTSCTS", __FUNCTION__);
478 dbg("%s - flow control = NONE", __FUNCTION__);
482 port->tty->termios->c_cflag = cflag;
485 static void cp2101_set_termios (struct usb_serial_port *port,
486 struct ktermios *old_termios)
488 unsigned int cflag, old_cflag;
490 unsigned int modem_ctl[4];
492 dbg("%s - port %d", __FUNCTION__, port->number);
494 if (!port->tty || !port->tty->termios) {
495 dbg("%s - no tty structures", __FUNCTION__);
498 port->tty->termios->c_cflag &= ~CMSPAR;
500 cflag = port->tty->termios->c_cflag;
501 old_cflag = old_termios->c_cflag;
502 baud = tty_get_baud_rate(port->tty);
504 /* If the baud rate is to be updated*/
505 if (baud != tty_termios_baud_rate(old_termios)) {
534 dbg("%s - Setting baud rate to %d baud", __FUNCTION__,
536 if (cp2101_set_config_single(port, CP2101_BAUDRATE,
537 (BAUD_RATE_GEN_FREQ / baud))) {
538 dev_err(&port->dev, "Baud rate requested not "
539 "supported by device\n");
540 baud = tty_termios_baud_rate(old_termios);
544 /* Report back the resulting baud rate */
545 tty_encode_baud_rate(port->tty, baud, baud);
547 /* If the number of data bits is to be updated */
548 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
549 cp2101_get_config(port, CP2101_BITS, &bits, 2);
550 bits &= ~BITS_DATA_MASK;
551 switch (cflag & CSIZE) {
554 dbg("%s - data bits = 5", __FUNCTION__);
558 dbg("%s - data bits = 6", __FUNCTION__);
562 dbg("%s - data bits = 7", __FUNCTION__);
566 dbg("%s - data bits = 8", __FUNCTION__);
570 dbg("%s - data bits = 9", __FUNCTION__);
573 dev_err(&port->dev, "cp2101 driver does not "
574 "support the number of bits requested,"
575 " using 8 bit mode\n");
579 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
580 dev_err(&port->dev, "Number of data bits requested "
581 "not supported by device\n");
584 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))) {
585 cp2101_get_config(port, CP2101_BITS, &bits, 2);
586 bits &= ~BITS_PARITY_MASK;
587 if (cflag & PARENB) {
588 if (cflag & PARODD) {
589 bits |= BITS_PARITY_ODD;
590 dbg("%s - parity = ODD", __FUNCTION__);
592 bits |= BITS_PARITY_EVEN;
593 dbg("%s - parity = EVEN", __FUNCTION__);
596 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
597 dev_err(&port->dev, "Parity mode not supported "
601 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
602 cp2101_get_config(port, CP2101_BITS, &bits, 2);
603 bits &= ~BITS_STOP_MASK;
604 if (cflag & CSTOPB) {
606 dbg("%s - stop bits = 2", __FUNCTION__);
609 dbg("%s - stop bits = 1", __FUNCTION__);
611 if (cp2101_set_config(port, CP2101_BITS, &bits, 2))
612 dev_err(&port->dev, "Number of stop bits requested "
613 "not supported by device\n");
616 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
617 cp2101_get_config(port, CP2101_MODEMCTL, modem_ctl, 16);
618 dbg("%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
619 __FUNCTION__, modem_ctl[0], modem_ctl[1],
620 modem_ctl[2], modem_ctl[3]);
622 if (cflag & CRTSCTS) {
623 modem_ctl[0] &= ~0x7B;
624 modem_ctl[0] |= 0x09;
626 dbg("%s - flow control = CRTSCTS", __FUNCTION__);
628 modem_ctl[0] &= ~0x7B;
629 modem_ctl[0] |= 0x01;
630 modem_ctl[1] |= 0x40;
631 dbg("%s - flow control = NONE", __FUNCTION__);
634 dbg("%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
635 __FUNCTION__, modem_ctl[0], modem_ctl[1],
636 modem_ctl[2], modem_ctl[3]);
637 cp2101_set_config(port, CP2101_MODEMCTL, modem_ctl, 16);
642 static int cp2101_tiocmset (struct usb_serial_port *port, struct file *file,
643 unsigned int set, unsigned int clear)
647 dbg("%s - port %d", __FUNCTION__, port->number);
649 if (set & TIOCM_RTS) {
650 control |= CONTROL_RTS;
651 control |= CONTROL_WRITE_RTS;
653 if (set & TIOCM_DTR) {
654 control |= CONTROL_DTR;
655 control |= CONTROL_WRITE_DTR;
657 if (clear & TIOCM_RTS) {
658 control &= ~CONTROL_RTS;
659 control |= CONTROL_WRITE_RTS;
661 if (clear & TIOCM_DTR) {
662 control &= ~CONTROL_DTR;
663 control |= CONTROL_WRITE_DTR;
666 dbg("%s - control = 0x%.4x", __FUNCTION__, control);
668 return cp2101_set_config(port, CP2101_CONTROL, &control, 2);
672 static int cp2101_tiocmget (struct usb_serial_port *port, struct file *file)
676 dbg("%s - port %d", __FUNCTION__, port->number);
678 cp2101_get_config(port, CP2101_CONTROL, &control, 1);
680 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
681 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
682 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
683 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
684 |((control & CONTROL_RING)? TIOCM_RI : 0)
685 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
687 dbg("%s - control = 0x%.2x", __FUNCTION__, control);
692 static void cp2101_break_ctl (struct usb_serial_port *port, int break_state)
696 dbg("%s - port %d", __FUNCTION__, port->number);
697 if (break_state == 0)
701 dbg("%s - turning break %s", __FUNCTION__,
702 state==BREAK_OFF ? "off" : "on");
703 cp2101_set_config(port, CP2101_BREAK, &state, 2);
706 static int cp2101_startup (struct usb_serial *serial)
708 /* CP2101 buffers behave strangely unless device is reset */
709 usb_reset_device(serial->dev);
713 static void cp2101_shutdown (struct usb_serial *serial)
717 dbg("%s", __FUNCTION__);
719 /* Stop reads and writes on all ports */
720 for (i=0; i < serial->num_ports; ++i) {
721 cp2101_cleanup(serial->port[i]);
725 static int __init cp2101_init (void)
729 retval = usb_serial_register(&cp2101_device);
731 return retval; /* Failed to register */
733 retval = usb_register(&cp2101_driver);
735 /* Failed to register */
736 usb_serial_deregister(&cp2101_device);
741 info(DRIVER_DESC " " DRIVER_VERSION);
745 static void __exit cp2101_exit (void)
747 usb_deregister (&cp2101_driver);
748 usb_serial_deregister (&cp2101_device);
751 module_init(cp2101_init);
752 module_exit(cp2101_exit);
754 MODULE_DESCRIPTION(DRIVER_DESC);
755 MODULE_VERSION(DRIVER_VERSION);
756 MODULE_LICENSE("GPL");
758 module_param(debug, bool, S_IRUGO | S_IWUSR);
759 MODULE_PARM_DESC(debug, "Enable verbose debugging messages");