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, 0x81D7) }, /* IAI Corp. RCB-CV-USB USB to RS485 Adaptor */
108 { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
109 { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
110 { USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
111 { USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
112 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
113 { USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
114 { USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
115 { USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */
116 { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
117 { USB_DEVICE(0x10C4, 0x82F4) }, /* Starizona MicroTouch */
118 { USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
119 { USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
120 { USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
121 { USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
122 { USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
123 { USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
124 { USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
125 { USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
126 { USB_DEVICE(0x10C4, 0x8470) }, /* Juniper Networks BX Series System Console */
127 { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
128 { USB_DEVICE(0x10C4, 0x84B6) }, /* Starizona Hyperion */
129 { USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
130 { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
131 { USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
132 { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
133 { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
134 { USB_DEVICE(0x10C4, 0x8856) }, /* CEL EM357 ZigBee USB Stick - LR */
135 { USB_DEVICE(0x10C4, 0x8857) }, /* CEL EM357 ZigBee USB Stick */
136 { USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
137 { USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
138 { USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
139 { USB_DEVICE(0x10C4, 0x8962) }, /* Brim Brothers charging dock */
140 { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit Device */
141 { USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
142 { USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
143 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
144 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
145 { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
146 { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
147 { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
148 { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
149 { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
150 { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
151 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
152 { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
153 { USB_DEVICE(0x12B8, 0xEC60) }, /* Link G4 ECU */
154 { USB_DEVICE(0x12B8, 0xEC62) }, /* Link G4+ ECU */
155 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
156 { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
157 { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
158 { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
159 { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
160 { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
161 { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
162 { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
163 { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
164 { USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
165 { USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
166 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
167 { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
168 { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
169 { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
170 { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
171 { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
172 { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
173 { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
174 { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
175 { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
176 { USB_DEVICE(0x18EF, 0xE025) }, /* ELV Marble Sound Board 1 */
177 { USB_DEVICE(0x1901, 0x0190) }, /* GE B850 CP2105 Recorder interface */
178 { USB_DEVICE(0x1901, 0x0193) }, /* GE B650 CP2104 PMC interface */
179 { USB_DEVICE(0x1901, 0x0194) }, /* GE Healthcare Remote Alarm Box */
180 { USB_DEVICE(0x19CF, 0x3000) }, /* Parrot NMEA GPS Flight Recorder */
181 { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
182 { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
183 { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
184 { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
185 { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
186 { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
187 { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
188 { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
189 { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
190 { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
191 { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
192 { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
193 { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
194 { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
195 { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
196 { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
197 { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
198 { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
199 { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
200 { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
201 { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
202 { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
203 { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
204 { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
205 { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
206 { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
207 { USB_DEVICE(0x2626, 0xEA60) }, /* Aruba Networks 7xxx USB Serial Console */
208 { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
209 { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
210 { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
211 { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
212 { } /* Terminating Entry */
215 MODULE_DEVICE_TABLE(usb, id_table);
217 struct cp210x_port_private {
218 __u8 bInterfaceNumber;
221 static struct usb_driver cp210x_driver = {
223 .probe = usb_serial_probe,
224 .disconnect = usb_serial_disconnect,
225 .id_table = id_table,
229 static struct usb_serial_driver cp210x_device = {
231 .owner = THIS_MODULE,
234 .usb_driver = &cp210x_driver,
235 .id_table = id_table,
238 .bulk_out_size = 256,
240 .close = cp210x_close,
241 .break_ctl = cp210x_break_ctl,
242 .set_termios = cp210x_set_termios,
243 .tiocmget = cp210x_tiocmget,
244 .tiocmset = cp210x_tiocmset,
245 .attach = cp210x_startup,
246 .release = cp210x_release,
247 .dtr_rts = cp210x_dtr_rts
250 /* Config request types */
251 #define REQTYPE_HOST_TO_DEVICE 0x41
252 #define REQTYPE_DEVICE_TO_HOST 0xc1
254 /* Config request codes */
255 #define CP210X_IFC_ENABLE 0x00
256 #define CP210X_SET_BAUDDIV 0x01
257 #define CP210X_GET_BAUDDIV 0x02
258 #define CP210X_SET_LINE_CTL 0x03
259 #define CP210X_GET_LINE_CTL 0x04
260 #define CP210X_SET_BREAK 0x05
261 #define CP210X_IMM_CHAR 0x06
262 #define CP210X_SET_MHS 0x07
263 #define CP210X_GET_MDMSTS 0x08
264 #define CP210X_SET_XON 0x09
265 #define CP210X_SET_XOFF 0x0A
266 #define CP210X_SET_EVENTMASK 0x0B
267 #define CP210X_GET_EVENTMASK 0x0C
268 #define CP210X_SET_CHAR 0x0D
269 #define CP210X_GET_CHARS 0x0E
270 #define CP210X_GET_PROPS 0x0F
271 #define CP210X_GET_COMM_STATUS 0x10
272 #define CP210X_RESET 0x11
273 #define CP210X_PURGE 0x12
274 #define CP210X_SET_FLOW 0x13
275 #define CP210X_GET_FLOW 0x14
276 #define CP210X_EMBED_EVENTS 0x15
277 #define CP210X_GET_EVENTSTATE 0x16
278 #define CP210X_SET_CHARS 0x19
279 #define CP210X_GET_BAUDRATE 0x1D
280 #define CP210X_SET_BAUDRATE 0x1E
282 /* CP210X_IFC_ENABLE */
283 #define UART_ENABLE 0x0001
284 #define UART_DISABLE 0x0000
286 /* CP210X_(SET|GET)_BAUDDIV */
287 #define BAUD_RATE_GEN_FREQ 0x384000
289 /* CP210X_(SET|GET)_LINE_CTL */
290 #define BITS_DATA_MASK 0X0f00
291 #define BITS_DATA_5 0X0500
292 #define BITS_DATA_6 0X0600
293 #define BITS_DATA_7 0X0700
294 #define BITS_DATA_8 0X0800
295 #define BITS_DATA_9 0X0900
297 #define BITS_PARITY_MASK 0x00f0
298 #define BITS_PARITY_NONE 0x0000
299 #define BITS_PARITY_ODD 0x0010
300 #define BITS_PARITY_EVEN 0x0020
301 #define BITS_PARITY_MARK 0x0030
302 #define BITS_PARITY_SPACE 0x0040
304 #define BITS_STOP_MASK 0x000f
305 #define BITS_STOP_1 0x0000
306 #define BITS_STOP_1_5 0x0001
307 #define BITS_STOP_2 0x0002
309 /* CP210X_SET_BREAK */
310 #define BREAK_ON 0x0001
311 #define BREAK_OFF 0x0000
313 /* CP210X_(SET_MHS|GET_MDMSTS) */
314 #define CONTROL_DTR 0x0001
315 #define CONTROL_RTS 0x0002
316 #define CONTROL_CTS 0x0010
317 #define CONTROL_DSR 0x0020
318 #define CONTROL_RING 0x0040
319 #define CONTROL_DCD 0x0080
320 #define CONTROL_WRITE_DTR 0x0100
321 #define CONTROL_WRITE_RTS 0x0200
325 * Reads from the CP210x configuration registers
326 * 'size' is specified in bytes.
327 * 'data' is a pointer to a pre-allocated array of integers large
328 * enough to hold 'size' bytes (with 4 bytes to each integer)
330 static int cp210x_get_config(struct usb_serial_port *port, u8 request,
331 unsigned int *data, int size)
333 struct usb_serial *serial = port->serial;
334 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
336 int result, i, length;
338 /* Number of integers required to contain the array */
339 length = (((size - 1) | 3) + 1)/4;
341 buf = kcalloc(length, sizeof(__le32), GFP_KERNEL);
343 dev_err(&port->dev, "%s - out of memory.\n", __func__);
347 /* Issue the request, attempting to read 'size' bytes */
348 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
349 request, REQTYPE_DEVICE_TO_HOST, 0x0000,
350 port_priv->bInterfaceNumber, buf, size,
351 USB_CTRL_GET_TIMEOUT);
353 /* Convert data into an array of integers */
354 for (i = 0; i < length; i++)
355 data[i] = le32_to_cpu(buf[i]);
359 if (result != size) {
360 dbg("%s - Unable to send config request, "
361 "request=0x%x size=%d result=%d\n",
362 __func__, request, size, result);
371 * Writes to the CP210x configuration registers
372 * Values less than 16 bits wide are sent directly
373 * 'size' is specified in bytes.
375 static int cp210x_set_config(struct usb_serial_port *port, u8 request,
376 unsigned int *data, int size)
378 struct usb_serial *serial = port->serial;
379 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
381 int result, i, length;
383 /* Number of integers required to contain the array */
384 length = (((size - 1) | 3) + 1)/4;
386 buf = kmalloc(length * sizeof(__le32), GFP_KERNEL);
388 dev_err(&port->dev, "%s - out of memory.\n",
393 /* Array of integers into bytes */
394 for (i = 0; i < length; i++)
395 buf[i] = cpu_to_le32(data[i]);
398 result = usb_control_msg(serial->dev,
399 usb_sndctrlpipe(serial->dev, 0),
400 request, REQTYPE_HOST_TO_DEVICE, 0x0000,
401 port_priv->bInterfaceNumber, buf, size,
402 USB_CTRL_SET_TIMEOUT);
404 result = usb_control_msg(serial->dev,
405 usb_sndctrlpipe(serial->dev, 0),
406 request, REQTYPE_HOST_TO_DEVICE, data[0],
407 port_priv->bInterfaceNumber, NULL, 0,
408 USB_CTRL_SET_TIMEOUT);
413 if ((size > 2 && result != size) || result < 0) {
414 dbg("%s - Unable to send request, "
415 "request=0x%x size=%d result=%d\n",
416 __func__, request, size, result);
424 * cp210x_set_config_single
425 * Convenience function for calling cp210x_set_config on single data values
426 * without requiring an integer pointer
428 static inline int cp210x_set_config_single(struct usb_serial_port *port,
429 u8 request, unsigned int data)
431 return cp210x_set_config(port, request, &data, 2);
435 * cp210x_quantise_baudrate
436 * Quantises the baud rate as per AN205 Table 1
438 static unsigned int cp210x_quantise_baudrate(unsigned int baud) {
441 else if (baud <= 600) baud = 600;
442 else if (baud <= 1200) baud = 1200;
443 else if (baud <= 1800) baud = 1800;
444 else if (baud <= 2400) baud = 2400;
445 else if (baud <= 4000) baud = 4000;
446 else if (baud <= 4803) baud = 4800;
447 else if (baud <= 7207) baud = 7200;
448 else if (baud <= 9612) baud = 9600;
449 else if (baud <= 14428) baud = 14400;
450 else if (baud <= 16062) baud = 16000;
451 else if (baud <= 19250) baud = 19200;
452 else if (baud <= 28912) baud = 28800;
453 else if (baud <= 38601) baud = 38400;
454 else if (baud <= 51558) baud = 51200;
455 else if (baud <= 56280) baud = 56000;
456 else if (baud <= 58053) baud = 57600;
457 else if (baud <= 64111) baud = 64000;
458 else if (baud <= 77608) baud = 76800;
459 else if (baud <= 117028) baud = 115200;
460 else if (baud <= 129347) baud = 128000;
461 else if (baud <= 156868) baud = 153600;
462 else if (baud <= 237832) baud = 230400;
463 else if (baud <= 254234) baud = 250000;
464 else if (baud <= 273066) baud = 256000;
465 else if (baud <= 491520) baud = 460800;
466 else if (baud <= 567138) baud = 500000;
467 else if (baud <= 670254) baud = 576000;
468 else if (baud < 1000000)
470 else if (baud > 2000000)
475 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
477 dbg("%s - port %d", __func__, port->number);
479 if (cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_ENABLE)) {
480 dev_err(&port->dev, "%s - Unable to enable UART\n",
485 /* Configure the termios structure */
486 cp210x_get_termios(tty, port);
488 /* The baud rate must be initialised on cp2104 */
490 cp210x_change_speed(tty, port, NULL);
492 return usb_serial_generic_open(tty, port);
495 static void cp210x_close(struct usb_serial_port *port)
497 dbg("%s - port %d", __func__, port->number);
499 usb_serial_generic_close(port);
501 mutex_lock(&port->serial->disc_mutex);
502 if (!port->serial->disconnected)
503 cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_DISABLE);
504 mutex_unlock(&port->serial->disc_mutex);
509 * Reads the baud rate, data bits, parity, stop bits and flow control mode
510 * from the device, corrects any unsupported values, and configures the
511 * termios structure to reflect the state of the device
513 static void cp210x_get_termios(struct tty_struct *tty,
514 struct usb_serial_port *port)
519 cp210x_get_termios_port(tty->driver_data,
520 &tty->termios->c_cflag, &baud);
521 tty_encode_baud_rate(tty, baud, baud);
527 cp210x_get_termios_port(port, &cflag, &baud);
532 * cp210x_get_termios_port
533 * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
535 static void cp210x_get_termios_port(struct usb_serial_port *port,
536 unsigned int *cflagp, unsigned int *baudp)
538 unsigned int cflag, modem_ctl[4];
542 dbg("%s - port %d", __func__, port->number);
544 cp210x_get_config(port, CP210X_GET_BAUDRATE, &baud, 4);
546 dbg("%s - baud rate = %d", __func__, baud);
551 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
553 switch (bits & BITS_DATA_MASK) {
555 dbg("%s - data bits = 5", __func__);
559 dbg("%s - data bits = 6", __func__);
563 dbg("%s - data bits = 7", __func__);
567 dbg("%s - data bits = 8", __func__);
571 dbg("%s - data bits = 9 (not supported, using 8 data bits)",
574 bits &= ~BITS_DATA_MASK;
576 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
579 dbg("%s - Unknown number of data bits, using 8", __func__);
581 bits &= ~BITS_DATA_MASK;
583 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
587 switch (bits & BITS_PARITY_MASK) {
588 case BITS_PARITY_NONE:
589 dbg("%s - parity = NONE", __func__);
592 case BITS_PARITY_ODD:
593 dbg("%s - parity = ODD", __func__);
594 cflag |= (PARENB|PARODD);
596 case BITS_PARITY_EVEN:
597 dbg("%s - parity = EVEN", __func__);
601 case BITS_PARITY_MARK:
602 dbg("%s - parity = MARK (not supported, disabling parity)",
605 bits &= ~BITS_PARITY_MASK;
606 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
608 case BITS_PARITY_SPACE:
609 dbg("%s - parity = SPACE (not supported, disabling parity)",
612 bits &= ~BITS_PARITY_MASK;
613 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
616 dbg("%s - Unknown parity mode, disabling parity", __func__);
618 bits &= ~BITS_PARITY_MASK;
619 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
624 switch (bits & BITS_STOP_MASK) {
626 dbg("%s - stop bits = 1", __func__);
629 dbg("%s - stop bits = 1.5 (not supported, using 1 stop bit)",
631 bits &= ~BITS_STOP_MASK;
632 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
635 dbg("%s - stop bits = 2", __func__);
639 dbg("%s - Unknown number of stop bits, using 1 stop bit",
641 bits &= ~BITS_STOP_MASK;
642 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
646 cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
647 if (modem_ctl[0] & 0x0008) {
648 dbg("%s - flow control = CRTSCTS", __func__);
651 dbg("%s - flow control = NONE", __func__);
659 * CP2101 supports the following baud rates:
661 * 300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
662 * 38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
664 * CP2102 and CP2103 support the following additional rates:
666 * 4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
669 * The device will map a requested rate to a supported one, but the result
670 * of requests for rates greater than 1053257 is undefined (see AN205).
672 * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
673 * respectively, with an error less than 1%. The actual rates are determined
676 * div = round(freq / (2 x prescale x request))
677 * actual = freq / (2 x prescale x div)
679 * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
681 * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
684 static void cp210x_change_speed(struct tty_struct *tty,
685 struct usb_serial_port *port, struct ktermios *old_termios)
689 baud = tty->termios->c_ospeed;
691 /* This maps the requested rate to a rate valid on cp2102 or cp2103,
692 * or to an arbitrary rate in [1M,2M].
694 * NOTE: B0 is not implemented.
696 baud = cp210x_quantise_baudrate(baud);
698 dbg("%s - setting baud rate to %u", __func__, baud);
699 if (cp210x_set_config(port, CP210X_SET_BAUDRATE, &baud,
701 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
703 baud = old_termios->c_ospeed;
708 tty_encode_baud_rate(tty, baud, baud);
711 static void cp210x_set_termios(struct tty_struct *tty,
712 struct usb_serial_port *port, struct ktermios *old_termios)
714 unsigned int cflag, old_cflag;
716 unsigned int modem_ctl[4];
718 dbg("%s - port %d", __func__, port->number);
723 tty->termios->c_cflag &= ~CMSPAR;
724 cflag = tty->termios->c_cflag;
725 old_cflag = old_termios->c_cflag;
727 if (tty->termios->c_ospeed != old_termios->c_ospeed)
728 cp210x_change_speed(tty, port, old_termios);
730 /* If the number of data bits is to be updated */
731 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
732 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
733 bits &= ~BITS_DATA_MASK;
734 switch (cflag & CSIZE) {
737 dbg("%s - data bits = 5", __func__);
741 dbg("%s - data bits = 6", __func__);
745 dbg("%s - data bits = 7", __func__);
749 dbg("%s - data bits = 8", __func__);
753 dbg("%s - data bits = 9", __func__);
756 dbg("cp210x driver does not "
757 "support the number of bits requested,"
758 " using 8 bit mode\n");
762 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
763 dbg("Number of data bits requested "
764 "not supported by device\n");
767 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))) {
768 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
769 bits &= ~BITS_PARITY_MASK;
770 if (cflag & PARENB) {
771 if (cflag & PARODD) {
772 bits |= BITS_PARITY_ODD;
773 dbg("%s - parity = ODD", __func__);
775 bits |= BITS_PARITY_EVEN;
776 dbg("%s - parity = EVEN", __func__);
779 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
780 dbg("Parity mode not supported "
784 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
785 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
786 bits &= ~BITS_STOP_MASK;
787 if (cflag & CSTOPB) {
789 dbg("%s - stop bits = 2", __func__);
792 dbg("%s - stop bits = 1", __func__);
794 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
795 dbg("Number of stop bits requested "
796 "not supported by device\n");
799 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
800 cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
801 dbg("%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
802 __func__, modem_ctl[0], modem_ctl[1],
803 modem_ctl[2], modem_ctl[3]);
805 if (cflag & CRTSCTS) {
806 modem_ctl[0] &= ~0x7B;
807 modem_ctl[0] |= 0x09;
809 dbg("%s - flow control = CRTSCTS", __func__);
811 modem_ctl[0] &= ~0x7B;
812 modem_ctl[0] |= 0x01;
813 modem_ctl[1] |= 0x40;
814 dbg("%s - flow control = NONE", __func__);
817 dbg("%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
818 __func__, modem_ctl[0], modem_ctl[1],
819 modem_ctl[2], modem_ctl[3]);
820 cp210x_set_config(port, CP210X_SET_FLOW, modem_ctl, 16);
825 static int cp210x_tiocmset (struct tty_struct *tty,
826 unsigned int set, unsigned int clear)
828 struct usb_serial_port *port = tty->driver_data;
829 return cp210x_tiocmset_port(port, set, clear);
832 static int cp210x_tiocmset_port(struct usb_serial_port *port,
833 unsigned int set, unsigned int clear)
835 unsigned int control = 0;
837 dbg("%s - port %d", __func__, port->number);
839 if (set & TIOCM_RTS) {
840 control |= CONTROL_RTS;
841 control |= CONTROL_WRITE_RTS;
843 if (set & TIOCM_DTR) {
844 control |= CONTROL_DTR;
845 control |= CONTROL_WRITE_DTR;
847 if (clear & TIOCM_RTS) {
848 control &= ~CONTROL_RTS;
849 control |= CONTROL_WRITE_RTS;
851 if (clear & TIOCM_DTR) {
852 control &= ~CONTROL_DTR;
853 control |= CONTROL_WRITE_DTR;
856 dbg("%s - control = 0x%.4x", __func__, control);
858 return cp210x_set_config(port, CP210X_SET_MHS, &control, 2);
861 static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
864 cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
866 cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
869 static int cp210x_tiocmget (struct tty_struct *tty)
871 struct usb_serial_port *port = tty->driver_data;
872 unsigned int control;
875 dbg("%s - port %d", __func__, port->number);
877 cp210x_get_config(port, CP210X_GET_MDMSTS, &control, 1);
879 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
880 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
881 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
882 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
883 |((control & CONTROL_RING)? TIOCM_RI : 0)
884 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
886 dbg("%s - control = 0x%.2x", __func__, control);
891 static void cp210x_break_ctl (struct tty_struct *tty, int break_state)
893 struct usb_serial_port *port = tty->driver_data;
896 dbg("%s - port %d", __func__, port->number);
897 if (break_state == 0)
901 dbg("%s - turning break %s", __func__,
902 state == BREAK_OFF ? "off" : "on");
903 cp210x_set_config(port, CP210X_SET_BREAK, &state, 2);
906 static int cp210x_startup(struct usb_serial *serial)
908 struct cp210x_port_private *port_priv;
911 /* cp210x buffers behave strangely unless device is reset */
912 usb_reset_device(serial->dev);
914 for (i = 0; i < serial->num_ports; i++) {
915 port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
919 memset(port_priv, 0x00, sizeof(*port_priv));
920 port_priv->bInterfaceNumber =
921 serial->interface->cur_altsetting->desc.bInterfaceNumber;
923 usb_set_serial_port_data(serial->port[i], port_priv);
929 static void cp210x_release(struct usb_serial *serial)
931 struct cp210x_port_private *port_priv;
934 for (i = 0; i < serial->num_ports; i++) {
935 port_priv = usb_get_serial_port_data(serial->port[i]);
937 usb_set_serial_port_data(serial->port[i], NULL);
941 static int __init cp210x_init(void)
945 retval = usb_serial_register(&cp210x_device);
947 return retval; /* Failed to register */
949 retval = usb_register(&cp210x_driver);
951 /* Failed to register */
952 usb_serial_deregister(&cp210x_device);
957 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
962 static void __exit cp210x_exit(void)
964 usb_deregister(&cp210x_driver);
965 usb_serial_deregister(&cp210x_device);
968 module_init(cp210x_init);
969 module_exit(cp210x_exit);
971 MODULE_DESCRIPTION(DRIVER_DESC);
972 MODULE_VERSION(DRIVER_VERSION);
973 MODULE_LICENSE("GPL");
975 module_param(debug, bool, S_IRUGO | S_IWUSR);
976 MODULE_PARM_DESC(debug, "Enable verbose debugging messages");