2 * Silicon Laboratories CP210x 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
16 #include <linux/kernel.h>
17 #include <linux/errno.h>
18 #include <linux/slab.h>
19 #include <linux/tty.h>
20 #include <linux/tty_flip.h>
21 #include <linux/module.h>
22 #include <linux/moduleparam.h>
23 #include <linux/usb.h>
24 #include <linux/uaccess.h>
25 #include <linux/usb/serial.h>
30 #define DRIVER_VERSION "v0.09"
31 #define DRIVER_DESC "Silicon Labs CP210x RS232 serial adaptor driver"
36 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *);
37 static void cp210x_close(struct usb_serial_port *);
38 static void cp210x_get_termios(struct tty_struct *,
39 struct usb_serial_port *port);
40 static void cp210x_get_termios_port(struct usb_serial_port *port,
41 unsigned int *cflagp, unsigned int *baudp);
42 static void cp210x_change_speed(struct tty_struct *, struct usb_serial_port *,
44 static void cp210x_set_termios(struct tty_struct *, struct usb_serial_port *,
46 static int cp210x_tiocmget(struct tty_struct *);
47 static int cp210x_tiocmset(struct tty_struct *, unsigned int, unsigned int);
48 static int cp210x_tiocmset_port(struct usb_serial_port *port,
49 unsigned int, unsigned int);
50 static void cp210x_break_ctl(struct tty_struct *, int);
51 static int cp210x_startup(struct usb_serial *);
52 static void cp210x_release(struct usb_serial *);
53 static void cp210x_dtr_rts(struct usb_serial_port *p, int on);
57 static const struct usb_device_id id_table[] = {
58 { USB_DEVICE(0x045B, 0x0053) }, /* Renesas RX610 RX-Stick */
59 { USB_DEVICE(0x0471, 0x066A) }, /* AKTAKOM ACE-1001 cable */
60 { USB_DEVICE(0x0489, 0xE000) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
61 { USB_DEVICE(0x0489, 0xE003) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
62 { USB_DEVICE(0x0745, 0x1000) }, /* CipherLab USB CCD Barcode Scanner 1000 */
63 { USB_DEVICE(0x0846, 0x1100) }, /* NetGear Managed Switch M4100 series, M5300 series, M7100 series */
64 { USB_DEVICE(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
65 { USB_DEVICE(0x08FD, 0x000A) }, /* Digianswer A/S , ZigBee/802.15.4 MAC Device */
66 { USB_DEVICE(0x0908, 0x01FF) }, /* Siemens RUGGEDCOM USB Serial Console */
67 { USB_DEVICE(0x0BED, 0x1100) }, /* MEI (TM) Cashflow-SC Bill/Voucher Acceptor */
68 { USB_DEVICE(0x0BED, 0x1101) }, /* MEI series 2000 Combo Acceptor */
69 { USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
70 { USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
71 { USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */
72 { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
73 { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
74 { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
75 { USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */
76 { USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */
77 { USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */
78 { USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
79 { USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
80 { USB_DEVICE(0x10C4, 0x8044) }, /* Cygnal Debug Adapter */
81 { USB_DEVICE(0x10C4, 0x804E) }, /* Software Bisque Paramount ME build-in converter */
82 { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
83 { USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */
84 { USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
85 { USB_DEVICE(0x10C4, 0x806F) }, /* IMS USB to RS422 Converter Cable */
86 { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
87 { USB_DEVICE(0x10C4, 0x80C4) }, /* Cygnal Integrated Products, Inc., Optris infrared thermometer */
88 { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
89 { USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
90 { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
91 { USB_DEVICE(0x10C4, 0x8115) }, /* Arygon NFC/Mifare Reader */
92 { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
93 { USB_DEVICE(0x10C4, 0x813F) }, /* Tams Master Easy Control */
94 { USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
95 { USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
96 { USB_DEVICE(0x2405, 0x0003) }, /* West Mountain Radio RIGblaster Advantage */
97 { USB_DEVICE(0x10C4, 0x8156) }, /* B&G H3000 link cable */
98 { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
99 { USB_DEVICE(0x10C4, 0x815F) }, /* Timewave HamLinkUSB */
100 { USB_DEVICE(0x10C4, 0x818B) }, /* AVIT Research USB to TTL */
101 { USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
102 { USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
103 { USB_DEVICE(0x10C4, 0x81A9) }, /* Multiplex RC Interface */
104 { USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
105 { USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */
106 { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
107 { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
108 { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
109 { USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
110 { USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
111 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
112 { USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
113 { USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
114 { USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */
115 { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
116 { USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
117 { USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
118 { USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
119 { USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
120 { USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
121 { USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
122 { USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
123 { USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
124 { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
125 { USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
126 { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
127 { USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
128 { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
129 { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
130 { USB_DEVICE(0x10C4, 0x8856) }, /* CEL EM357 ZigBee USB Stick - LR */
131 { USB_DEVICE(0x10C4, 0x8857) }, /* CEL EM357 ZigBee USB Stick */
132 { USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
133 { USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
134 { USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
135 { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit Device */
136 { USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
137 { USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
138 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
139 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
140 { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
141 { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
142 { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
143 { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
144 { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
145 { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
146 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
147 { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
148 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
149 { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
150 { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
151 { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
152 { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
153 { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
154 { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
155 { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
156 { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
157 { USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
158 { USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
159 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
160 { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
161 { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
162 { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
163 { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
164 { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
165 { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
166 { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
167 { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
168 { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
169 { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
170 { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
171 { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
172 { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
173 { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
174 { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
175 { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
176 { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
177 { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
178 { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
179 { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
180 { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
181 { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
182 { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
183 { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
184 { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
185 { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
186 { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
187 { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
188 { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
189 { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
190 { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
191 { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
192 { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
193 { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
194 { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
195 { USB_DEVICE(0x2626, 0xEA60) }, /* Aruba Networks 7xxx USB Serial Console */
196 { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
197 { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
198 { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
199 { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
200 { } /* Terminating Entry */
203 MODULE_DEVICE_TABLE(usb, id_table);
205 struct cp210x_port_private {
206 __u8 bInterfaceNumber;
209 static struct usb_driver cp210x_driver = {
211 .probe = usb_serial_probe,
212 .disconnect = usb_serial_disconnect,
213 .id_table = id_table,
217 static struct usb_serial_driver cp210x_device = {
219 .owner = THIS_MODULE,
222 .usb_driver = &cp210x_driver,
223 .id_table = id_table,
226 .bulk_out_size = 256,
228 .close = cp210x_close,
229 .break_ctl = cp210x_break_ctl,
230 .set_termios = cp210x_set_termios,
231 .tiocmget = cp210x_tiocmget,
232 .tiocmset = cp210x_tiocmset,
233 .attach = cp210x_startup,
234 .release = cp210x_release,
235 .dtr_rts = cp210x_dtr_rts
238 /* Config request types */
239 #define REQTYPE_HOST_TO_DEVICE 0x41
240 #define REQTYPE_DEVICE_TO_HOST 0xc1
242 /* Config request codes */
243 #define CP210X_IFC_ENABLE 0x00
244 #define CP210X_SET_BAUDDIV 0x01
245 #define CP210X_GET_BAUDDIV 0x02
246 #define CP210X_SET_LINE_CTL 0x03
247 #define CP210X_GET_LINE_CTL 0x04
248 #define CP210X_SET_BREAK 0x05
249 #define CP210X_IMM_CHAR 0x06
250 #define CP210X_SET_MHS 0x07
251 #define CP210X_GET_MDMSTS 0x08
252 #define CP210X_SET_XON 0x09
253 #define CP210X_SET_XOFF 0x0A
254 #define CP210X_SET_EVENTMASK 0x0B
255 #define CP210X_GET_EVENTMASK 0x0C
256 #define CP210X_SET_CHAR 0x0D
257 #define CP210X_GET_CHARS 0x0E
258 #define CP210X_GET_PROPS 0x0F
259 #define CP210X_GET_COMM_STATUS 0x10
260 #define CP210X_RESET 0x11
261 #define CP210X_PURGE 0x12
262 #define CP210X_SET_FLOW 0x13
263 #define CP210X_GET_FLOW 0x14
264 #define CP210X_EMBED_EVENTS 0x15
265 #define CP210X_GET_EVENTSTATE 0x16
266 #define CP210X_SET_CHARS 0x19
267 #define CP210X_GET_BAUDRATE 0x1D
268 #define CP210X_SET_BAUDRATE 0x1E
270 /* CP210X_IFC_ENABLE */
271 #define UART_ENABLE 0x0001
272 #define UART_DISABLE 0x0000
274 /* CP210X_(SET|GET)_BAUDDIV */
275 #define BAUD_RATE_GEN_FREQ 0x384000
277 /* CP210X_(SET|GET)_LINE_CTL */
278 #define BITS_DATA_MASK 0X0f00
279 #define BITS_DATA_5 0X0500
280 #define BITS_DATA_6 0X0600
281 #define BITS_DATA_7 0X0700
282 #define BITS_DATA_8 0X0800
283 #define BITS_DATA_9 0X0900
285 #define BITS_PARITY_MASK 0x00f0
286 #define BITS_PARITY_NONE 0x0000
287 #define BITS_PARITY_ODD 0x0010
288 #define BITS_PARITY_EVEN 0x0020
289 #define BITS_PARITY_MARK 0x0030
290 #define BITS_PARITY_SPACE 0x0040
292 #define BITS_STOP_MASK 0x000f
293 #define BITS_STOP_1 0x0000
294 #define BITS_STOP_1_5 0x0001
295 #define BITS_STOP_2 0x0002
297 /* CP210X_SET_BREAK */
298 #define BREAK_ON 0x0001
299 #define BREAK_OFF 0x0000
301 /* CP210X_(SET_MHS|GET_MDMSTS) */
302 #define CONTROL_DTR 0x0001
303 #define CONTROL_RTS 0x0002
304 #define CONTROL_CTS 0x0010
305 #define CONTROL_DSR 0x0020
306 #define CONTROL_RING 0x0040
307 #define CONTROL_DCD 0x0080
308 #define CONTROL_WRITE_DTR 0x0100
309 #define CONTROL_WRITE_RTS 0x0200
313 * Reads from the CP210x configuration registers
314 * 'size' is specified in bytes.
315 * 'data' is a pointer to a pre-allocated array of integers large
316 * enough to hold 'size' bytes (with 4 bytes to each integer)
318 static int cp210x_get_config(struct usb_serial_port *port, u8 request,
319 unsigned int *data, int size)
321 struct usb_serial *serial = port->serial;
322 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
324 int result, i, length;
326 /* Number of integers required to contain the array */
327 length = (((size - 1) | 3) + 1)/4;
329 buf = kcalloc(length, sizeof(__le32), GFP_KERNEL);
331 dev_err(&port->dev, "%s - out of memory.\n", __func__);
335 /* Issue the request, attempting to read 'size' bytes */
336 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
337 request, REQTYPE_DEVICE_TO_HOST, 0x0000,
338 port_priv->bInterfaceNumber, buf, size,
339 USB_CTRL_GET_TIMEOUT);
341 /* Convert data into an array of integers */
342 for (i = 0; i < length; i++)
343 data[i] = le32_to_cpu(buf[i]);
347 if (result != size) {
348 dbg("%s - Unable to send config request, "
349 "request=0x%x size=%d result=%d\n",
350 __func__, request, size, result);
359 * Writes to the CP210x configuration registers
360 * Values less than 16 bits wide are sent directly
361 * 'size' is specified in bytes.
363 static int cp210x_set_config(struct usb_serial_port *port, u8 request,
364 unsigned int *data, int size)
366 struct usb_serial *serial = port->serial;
367 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
369 int result, i, length;
371 /* Number of integers required to contain the array */
372 length = (((size - 1) | 3) + 1)/4;
374 buf = kmalloc(length * sizeof(__le32), GFP_KERNEL);
376 dev_err(&port->dev, "%s - out of memory.\n",
381 /* Array of integers into bytes */
382 for (i = 0; i < length; i++)
383 buf[i] = cpu_to_le32(data[i]);
386 result = usb_control_msg(serial->dev,
387 usb_sndctrlpipe(serial->dev, 0),
388 request, REQTYPE_HOST_TO_DEVICE, 0x0000,
389 port_priv->bInterfaceNumber, buf, size,
390 USB_CTRL_SET_TIMEOUT);
392 result = usb_control_msg(serial->dev,
393 usb_sndctrlpipe(serial->dev, 0),
394 request, REQTYPE_HOST_TO_DEVICE, data[0],
395 port_priv->bInterfaceNumber, NULL, 0,
396 USB_CTRL_SET_TIMEOUT);
401 if ((size > 2 && result != size) || result < 0) {
402 dbg("%s - Unable to send request, "
403 "request=0x%x size=%d result=%d\n",
404 __func__, request, size, result);
412 * cp210x_set_config_single
413 * Convenience function for calling cp210x_set_config on single data values
414 * without requiring an integer pointer
416 static inline int cp210x_set_config_single(struct usb_serial_port *port,
417 u8 request, unsigned int data)
419 return cp210x_set_config(port, request, &data, 2);
423 * cp210x_quantise_baudrate
424 * Quantises the baud rate as per AN205 Table 1
426 static unsigned int cp210x_quantise_baudrate(unsigned int baud) {
429 else if (baud <= 600) baud = 600;
430 else if (baud <= 1200) baud = 1200;
431 else if (baud <= 1800) baud = 1800;
432 else if (baud <= 2400) baud = 2400;
433 else if (baud <= 4000) baud = 4000;
434 else if (baud <= 4803) baud = 4800;
435 else if (baud <= 7207) baud = 7200;
436 else if (baud <= 9612) baud = 9600;
437 else if (baud <= 14428) baud = 14400;
438 else if (baud <= 16062) baud = 16000;
439 else if (baud <= 19250) baud = 19200;
440 else if (baud <= 28912) baud = 28800;
441 else if (baud <= 38601) baud = 38400;
442 else if (baud <= 51558) baud = 51200;
443 else if (baud <= 56280) baud = 56000;
444 else if (baud <= 58053) baud = 57600;
445 else if (baud <= 64111) baud = 64000;
446 else if (baud <= 77608) baud = 76800;
447 else if (baud <= 117028) baud = 115200;
448 else if (baud <= 129347) baud = 128000;
449 else if (baud <= 156868) baud = 153600;
450 else if (baud <= 237832) baud = 230400;
451 else if (baud <= 254234) baud = 250000;
452 else if (baud <= 273066) baud = 256000;
453 else if (baud <= 491520) baud = 460800;
454 else if (baud <= 567138) baud = 500000;
455 else if (baud <= 670254) baud = 576000;
456 else if (baud < 1000000)
458 else if (baud > 2000000)
463 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
465 dbg("%s - port %d", __func__, port->number);
467 if (cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_ENABLE)) {
468 dev_err(&port->dev, "%s - Unable to enable UART\n",
473 /* Configure the termios structure */
474 cp210x_get_termios(tty, port);
476 /* The baud rate must be initialised on cp2104 */
478 cp210x_change_speed(tty, port, NULL);
480 return usb_serial_generic_open(tty, port);
483 static void cp210x_close(struct usb_serial_port *port)
485 dbg("%s - port %d", __func__, port->number);
487 usb_serial_generic_close(port);
489 mutex_lock(&port->serial->disc_mutex);
490 if (!port->serial->disconnected)
491 cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_DISABLE);
492 mutex_unlock(&port->serial->disc_mutex);
497 * Reads the baud rate, data bits, parity, stop bits and flow control mode
498 * from the device, corrects any unsupported values, and configures the
499 * termios structure to reflect the state of the device
501 static void cp210x_get_termios(struct tty_struct *tty,
502 struct usb_serial_port *port)
507 cp210x_get_termios_port(tty->driver_data,
508 &tty->termios->c_cflag, &baud);
509 tty_encode_baud_rate(tty, baud, baud);
515 cp210x_get_termios_port(port, &cflag, &baud);
520 * cp210x_get_termios_port
521 * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
523 static void cp210x_get_termios_port(struct usb_serial_port *port,
524 unsigned int *cflagp, unsigned int *baudp)
526 unsigned int cflag, modem_ctl[4];
530 dbg("%s - port %d", __func__, port->number);
532 cp210x_get_config(port, CP210X_GET_BAUDRATE, &baud, 4);
534 dbg("%s - baud rate = %d", __func__, baud);
539 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
541 switch (bits & BITS_DATA_MASK) {
543 dbg("%s - data bits = 5", __func__);
547 dbg("%s - data bits = 6", __func__);
551 dbg("%s - data bits = 7", __func__);
555 dbg("%s - data bits = 8", __func__);
559 dbg("%s - data bits = 9 (not supported, using 8 data bits)",
562 bits &= ~BITS_DATA_MASK;
564 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
567 dbg("%s - Unknown number of data bits, using 8", __func__);
569 bits &= ~BITS_DATA_MASK;
571 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
575 switch (bits & BITS_PARITY_MASK) {
576 case BITS_PARITY_NONE:
577 dbg("%s - parity = NONE", __func__);
580 case BITS_PARITY_ODD:
581 dbg("%s - parity = ODD", __func__);
582 cflag |= (PARENB|PARODD);
584 case BITS_PARITY_EVEN:
585 dbg("%s - parity = EVEN", __func__);
589 case BITS_PARITY_MARK:
590 dbg("%s - parity = MARK (not supported, disabling parity)",
593 bits &= ~BITS_PARITY_MASK;
594 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
596 case BITS_PARITY_SPACE:
597 dbg("%s - parity = SPACE (not supported, disabling parity)",
600 bits &= ~BITS_PARITY_MASK;
601 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
604 dbg("%s - Unknown parity mode, disabling parity", __func__);
606 bits &= ~BITS_PARITY_MASK;
607 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
612 switch (bits & BITS_STOP_MASK) {
614 dbg("%s - stop bits = 1", __func__);
617 dbg("%s - stop bits = 1.5 (not supported, using 1 stop bit)",
619 bits &= ~BITS_STOP_MASK;
620 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
623 dbg("%s - stop bits = 2", __func__);
627 dbg("%s - Unknown number of stop bits, using 1 stop bit",
629 bits &= ~BITS_STOP_MASK;
630 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
634 cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
635 if (modem_ctl[0] & 0x0008) {
636 dbg("%s - flow control = CRTSCTS", __func__);
639 dbg("%s - flow control = NONE", __func__);
647 * CP2101 supports the following baud rates:
649 * 300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
650 * 38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
652 * CP2102 and CP2103 support the following additional rates:
654 * 4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
657 * The device will map a requested rate to a supported one, but the result
658 * of requests for rates greater than 1053257 is undefined (see AN205).
660 * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
661 * respectively, with an error less than 1%. The actual rates are determined
664 * div = round(freq / (2 x prescale x request))
665 * actual = freq / (2 x prescale x div)
667 * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
669 * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
672 static void cp210x_change_speed(struct tty_struct *tty,
673 struct usb_serial_port *port, struct ktermios *old_termios)
677 baud = tty->termios->c_ospeed;
679 /* This maps the requested rate to a rate valid on cp2102 or cp2103,
680 * or to an arbitrary rate in [1M,2M].
682 * NOTE: B0 is not implemented.
684 baud = cp210x_quantise_baudrate(baud);
686 dbg("%s - setting baud rate to %u", __func__, baud);
687 if (cp210x_set_config(port, CP210X_SET_BAUDRATE, &baud,
689 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
691 baud = old_termios->c_ospeed;
696 tty_encode_baud_rate(tty, baud, baud);
699 static void cp210x_set_termios(struct tty_struct *tty,
700 struct usb_serial_port *port, struct ktermios *old_termios)
702 unsigned int cflag, old_cflag;
704 unsigned int modem_ctl[4];
706 dbg("%s - port %d", __func__, port->number);
711 tty->termios->c_cflag &= ~CMSPAR;
712 cflag = tty->termios->c_cflag;
713 old_cflag = old_termios->c_cflag;
715 if (tty->termios->c_ospeed != old_termios->c_ospeed)
716 cp210x_change_speed(tty, port, old_termios);
718 /* If the number of data bits is to be updated */
719 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
720 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
721 bits &= ~BITS_DATA_MASK;
722 switch (cflag & CSIZE) {
725 dbg("%s - data bits = 5", __func__);
729 dbg("%s - data bits = 6", __func__);
733 dbg("%s - data bits = 7", __func__);
737 dbg("%s - data bits = 8", __func__);
741 dbg("%s - data bits = 9", __func__);
744 dbg("cp210x driver does not "
745 "support the number of bits requested,"
746 " using 8 bit mode\n");
750 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
751 dbg("Number of data bits requested "
752 "not supported by device\n");
755 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))) {
756 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
757 bits &= ~BITS_PARITY_MASK;
758 if (cflag & PARENB) {
759 if (cflag & PARODD) {
760 bits |= BITS_PARITY_ODD;
761 dbg("%s - parity = ODD", __func__);
763 bits |= BITS_PARITY_EVEN;
764 dbg("%s - parity = EVEN", __func__);
767 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
768 dbg("Parity mode not supported "
772 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
773 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
774 bits &= ~BITS_STOP_MASK;
775 if (cflag & CSTOPB) {
777 dbg("%s - stop bits = 2", __func__);
780 dbg("%s - stop bits = 1", __func__);
782 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
783 dbg("Number of stop bits requested "
784 "not supported by device\n");
787 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
788 cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
789 dbg("%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
790 __func__, modem_ctl[0], modem_ctl[1],
791 modem_ctl[2], modem_ctl[3]);
793 if (cflag & CRTSCTS) {
794 modem_ctl[0] &= ~0x7B;
795 modem_ctl[0] |= 0x09;
797 dbg("%s - flow control = CRTSCTS", __func__);
799 modem_ctl[0] &= ~0x7B;
800 modem_ctl[0] |= 0x01;
801 modem_ctl[1] |= 0x40;
802 dbg("%s - flow control = NONE", __func__);
805 dbg("%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
806 __func__, modem_ctl[0], modem_ctl[1],
807 modem_ctl[2], modem_ctl[3]);
808 cp210x_set_config(port, CP210X_SET_FLOW, modem_ctl, 16);
813 static int cp210x_tiocmset (struct tty_struct *tty,
814 unsigned int set, unsigned int clear)
816 struct usb_serial_port *port = tty->driver_data;
817 return cp210x_tiocmset_port(port, set, clear);
820 static int cp210x_tiocmset_port(struct usb_serial_port *port,
821 unsigned int set, unsigned int clear)
823 unsigned int control = 0;
825 dbg("%s - port %d", __func__, port->number);
827 if (set & TIOCM_RTS) {
828 control |= CONTROL_RTS;
829 control |= CONTROL_WRITE_RTS;
831 if (set & TIOCM_DTR) {
832 control |= CONTROL_DTR;
833 control |= CONTROL_WRITE_DTR;
835 if (clear & TIOCM_RTS) {
836 control &= ~CONTROL_RTS;
837 control |= CONTROL_WRITE_RTS;
839 if (clear & TIOCM_DTR) {
840 control &= ~CONTROL_DTR;
841 control |= CONTROL_WRITE_DTR;
844 dbg("%s - control = 0x%.4x", __func__, control);
846 return cp210x_set_config(port, CP210X_SET_MHS, &control, 2);
849 static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
852 cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
854 cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
857 static int cp210x_tiocmget (struct tty_struct *tty)
859 struct usb_serial_port *port = tty->driver_data;
860 unsigned int control;
863 dbg("%s - port %d", __func__, port->number);
865 cp210x_get_config(port, CP210X_GET_MDMSTS, &control, 1);
867 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
868 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
869 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
870 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
871 |((control & CONTROL_RING)? TIOCM_RI : 0)
872 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
874 dbg("%s - control = 0x%.2x", __func__, control);
879 static void cp210x_break_ctl (struct tty_struct *tty, int break_state)
881 struct usb_serial_port *port = tty->driver_data;
884 dbg("%s - port %d", __func__, port->number);
885 if (break_state == 0)
889 dbg("%s - turning break %s", __func__,
890 state == BREAK_OFF ? "off" : "on");
891 cp210x_set_config(port, CP210X_SET_BREAK, &state, 2);
894 static int cp210x_startup(struct usb_serial *serial)
896 struct cp210x_port_private *port_priv;
899 /* cp210x buffers behave strangely unless device is reset */
900 usb_reset_device(serial->dev);
902 for (i = 0; i < serial->num_ports; i++) {
903 port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
907 memset(port_priv, 0x00, sizeof(*port_priv));
908 port_priv->bInterfaceNumber =
909 serial->interface->cur_altsetting->desc.bInterfaceNumber;
911 usb_set_serial_port_data(serial->port[i], port_priv);
917 static void cp210x_release(struct usb_serial *serial)
919 struct cp210x_port_private *port_priv;
922 for (i = 0; i < serial->num_ports; i++) {
923 port_priv = usb_get_serial_port_data(serial->port[i]);
925 usb_set_serial_port_data(serial->port[i], NULL);
929 static int __init cp210x_init(void)
933 retval = usb_serial_register(&cp210x_device);
935 return retval; /* Failed to register */
937 retval = usb_register(&cp210x_driver);
939 /* Failed to register */
940 usb_serial_deregister(&cp210x_device);
945 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
950 static void __exit cp210x_exit(void)
952 usb_deregister(&cp210x_driver);
953 usb_serial_deregister(&cp210x_device);
956 module_init(cp210x_init);
957 module_exit(cp210x_exit);
959 MODULE_DESCRIPTION(DRIVER_DESC);
960 MODULE_VERSION(DRIVER_VERSION);
961 MODULE_LICENSE("GPL");
963 module_param(debug, bool, S_IRUGO | S_IWUSR);
964 MODULE_PARM_DESC(debug, "Enable verbose debugging messages");