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>
27 #define DRIVER_DESC "Silicon Labs CP210x RS232 serial adaptor driver"
32 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *);
33 static void cp210x_close(struct usb_serial_port *);
34 static void cp210x_get_termios(struct tty_struct *, struct usb_serial_port *);
35 static void cp210x_get_termios_port(struct usb_serial_port *port,
36 unsigned int *cflagp, unsigned int *baudp);
37 static void cp210x_change_speed(struct tty_struct *, struct usb_serial_port *,
39 static void cp210x_set_termios(struct tty_struct *, struct usb_serial_port *,
41 static bool cp210x_tx_empty(struct usb_serial_port *port);
42 static int cp210x_tiocmget(struct tty_struct *);
43 static int cp210x_tiocmset(struct tty_struct *, unsigned int, unsigned int);
44 static int cp210x_tiocmset_port(struct usb_serial_port *port,
45 unsigned int, unsigned int);
46 static void cp210x_break_ctl(struct tty_struct *, int);
47 static int cp210x_port_probe(struct usb_serial_port *);
48 static int cp210x_port_remove(struct usb_serial_port *);
49 static void cp210x_dtr_rts(struct usb_serial_port *p, int on);
51 static const struct usb_device_id id_table[] = {
52 { USB_DEVICE(0x045B, 0x0053) }, /* Renesas RX610 RX-Stick */
53 { USB_DEVICE(0x0471, 0x066A) }, /* AKTAKOM ACE-1001 cable */
54 { USB_DEVICE(0x0489, 0xE000) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
55 { USB_DEVICE(0x0489, 0xE003) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
56 { USB_DEVICE(0x0745, 0x1000) }, /* CipherLab USB CCD Barcode Scanner 1000 */
57 { USB_DEVICE(0x0846, 0x1100) }, /* NetGear Managed Switch M4100 series, M5300 series, M7100 series */
58 { USB_DEVICE(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
59 { USB_DEVICE(0x08FD, 0x000A) }, /* Digianswer A/S , ZigBee/802.15.4 MAC Device */
60 { USB_DEVICE(0x0908, 0x01FF) }, /* Siemens RUGGEDCOM USB Serial Console */
61 { USB_DEVICE(0x0BED, 0x1100) }, /* MEI (TM) Cashflow-SC Bill/Voucher Acceptor */
62 { USB_DEVICE(0x0BED, 0x1101) }, /* MEI series 2000 Combo Acceptor */
63 { USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
64 { USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
65 { USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */
66 { USB_DEVICE(0x0FDE, 0xCA05) }, /* OWL Wireless Electricity Monitor CM-160 */
67 { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
68 { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
69 { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
70 { USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */
71 { USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */
72 { USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */
73 { USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
74 { USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
75 { USB_DEVICE(0x10C4, 0x8044) }, /* Cygnal Debug Adapter */
76 { USB_DEVICE(0x10C4, 0x804E) }, /* Software Bisque Paramount ME build-in converter */
77 { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
78 { USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */
79 { USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
80 { USB_DEVICE(0x10C4, 0x806F) }, /* IMS USB to RS422 Converter Cable */
81 { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
82 { USB_DEVICE(0x10C4, 0x80C4) }, /* Cygnal Integrated Products, Inc., Optris infrared thermometer */
83 { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
84 { USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
85 { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
86 { USB_DEVICE(0x10C4, 0x8115) }, /* Arygon NFC/Mifare Reader */
87 { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
88 { USB_DEVICE(0x10C4, 0x813F) }, /* Tams Master Easy Control */
89 { USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
90 { USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
91 { USB_DEVICE(0x2405, 0x0003) }, /* West Mountain Radio RIGblaster Advantage */
92 { USB_DEVICE(0x10C4, 0x8156) }, /* B&G H3000 link cable */
93 { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
94 { USB_DEVICE(0x10C4, 0x815F) }, /* Timewave HamLinkUSB */
95 { USB_DEVICE(0x10C4, 0x818B) }, /* AVIT Research USB to TTL */
96 { USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
97 { USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
98 { USB_DEVICE(0x10C4, 0x81A9) }, /* Multiplex RC Interface */
99 { USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
100 { USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */
101 { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
102 { USB_DEVICE(0x10C4, 0x81D7) }, /* IAI Corp. RCB-CV-USB USB to RS485 Adaptor */
103 { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
104 { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
105 { USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
106 { USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
107 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
108 { USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
109 { USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
110 { USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */
111 { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
112 { USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
113 { USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
114 { USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
115 { USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
116 { USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
117 { USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
118 { USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
119 { USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
120 { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
121 { USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
122 { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
123 { USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
124 { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
125 { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
126 { USB_DEVICE(0x10C4, 0x8856) }, /* CEL EM357 ZigBee USB Stick - LR */
127 { USB_DEVICE(0x10C4, 0x8857) }, /* CEL EM357 ZigBee USB Stick */
128 { USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
129 { USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
130 { USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
131 { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit Device */
132 { USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
133 { USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
134 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
135 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
136 { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
137 { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
138 { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
139 { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
140 { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
141 { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
142 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
143 { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
144 { USB_DEVICE(0x12B8, 0xEC60) }, /* Link G4 ECU */
145 { USB_DEVICE(0x12B8, 0xEC62) }, /* Link G4+ ECU */
146 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
147 { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
148 { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
149 { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
150 { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
151 { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
152 { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
153 { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
154 { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
155 { USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
156 { USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
157 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
158 { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
159 { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
160 { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
161 { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
162 { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
163 { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
164 { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
165 { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
166 { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
167 { USB_DEVICE(0x18EF, 0xE025) }, /* ELV Marble Sound Board 1 */
168 { USB_DEVICE(0x1901, 0x0190) }, /* GE B850 CP2105 Recorder interface */
169 { USB_DEVICE(0x1901, 0x0193) }, /* GE B650 CP2104 PMC interface */
170 { USB_DEVICE(0x1901, 0x0194) }, /* GE Healthcare Remote Alarm Box */
171 { USB_DEVICE(0x19CF, 0x3000) }, /* Parrot NMEA GPS Flight Recorder */
172 { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
173 { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
174 { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
175 { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
176 { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
177 { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
178 { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
179 { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
180 { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
181 { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
182 { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
183 { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
184 { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
185 { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
186 { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
187 { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
188 { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
189 { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
190 { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
191 { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
192 { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
193 { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
194 { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
195 { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
196 { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
197 { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
198 { USB_DEVICE(0x2626, 0xEA60) }, /* Aruba Networks 7xxx USB Serial Console */
199 { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
200 { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
201 { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
202 { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
203 { } /* Terminating Entry */
206 MODULE_DEVICE_TABLE(usb, id_table);
208 struct cp210x_port_private {
209 __u8 bInterfaceNumber;
210 bool has_swapped_line_ctl;
213 static struct usb_serial_driver cp210x_device = {
215 .owner = THIS_MODULE,
218 .id_table = id_table,
221 .bulk_out_size = 256,
223 .close = cp210x_close,
224 .break_ctl = cp210x_break_ctl,
225 .set_termios = cp210x_set_termios,
226 .tx_empty = cp210x_tx_empty,
227 .tiocmget = cp210x_tiocmget,
228 .tiocmset = cp210x_tiocmset,
229 .port_probe = cp210x_port_probe,
230 .port_remove = cp210x_port_remove,
231 .dtr_rts = cp210x_dtr_rts
234 static struct usb_serial_driver * const serial_drivers[] = {
238 /* Config request types */
239 #define REQTYPE_HOST_TO_INTERFACE 0x41
240 #define REQTYPE_INTERFACE_TO_HOST 0xc1
241 #define REQTYPE_HOST_TO_DEVICE 0x40
242 #define REQTYPE_DEVICE_TO_HOST 0xc0
244 /* Config request codes */
245 #define CP210X_IFC_ENABLE 0x00
246 #define CP210X_SET_BAUDDIV 0x01
247 #define CP210X_GET_BAUDDIV 0x02
248 #define CP210X_SET_LINE_CTL 0x03
249 #define CP210X_GET_LINE_CTL 0x04
250 #define CP210X_SET_BREAK 0x05
251 #define CP210X_IMM_CHAR 0x06
252 #define CP210X_SET_MHS 0x07
253 #define CP210X_GET_MDMSTS 0x08
254 #define CP210X_SET_XON 0x09
255 #define CP210X_SET_XOFF 0x0A
256 #define CP210X_SET_EVENTMASK 0x0B
257 #define CP210X_GET_EVENTMASK 0x0C
258 #define CP210X_SET_CHAR 0x0D
259 #define CP210X_GET_CHARS 0x0E
260 #define CP210X_GET_PROPS 0x0F
261 #define CP210X_GET_COMM_STATUS 0x10
262 #define CP210X_RESET 0x11
263 #define CP210X_PURGE 0x12
264 #define CP210X_SET_FLOW 0x13
265 #define CP210X_GET_FLOW 0x14
266 #define CP210X_EMBED_EVENTS 0x15
267 #define CP210X_GET_EVENTSTATE 0x16
268 #define CP210X_SET_CHARS 0x19
269 #define CP210X_GET_BAUDRATE 0x1D
270 #define CP210X_SET_BAUDRATE 0x1E
272 /* CP210X_IFC_ENABLE */
273 #define UART_ENABLE 0x0001
274 #define UART_DISABLE 0x0000
276 /* CP210X_(SET|GET)_BAUDDIV */
277 #define BAUD_RATE_GEN_FREQ 0x384000
279 /* CP210X_(SET|GET)_LINE_CTL */
280 #define BITS_DATA_MASK 0X0f00
281 #define BITS_DATA_5 0X0500
282 #define BITS_DATA_6 0X0600
283 #define BITS_DATA_7 0X0700
284 #define BITS_DATA_8 0X0800
285 #define BITS_DATA_9 0X0900
287 #define BITS_PARITY_MASK 0x00f0
288 #define BITS_PARITY_NONE 0x0000
289 #define BITS_PARITY_ODD 0x0010
290 #define BITS_PARITY_EVEN 0x0020
291 #define BITS_PARITY_MARK 0x0030
292 #define BITS_PARITY_SPACE 0x0040
294 #define BITS_STOP_MASK 0x000f
295 #define BITS_STOP_1 0x0000
296 #define BITS_STOP_1_5 0x0001
297 #define BITS_STOP_2 0x0002
299 /* CP210X_SET_BREAK */
300 #define BREAK_ON 0x0001
301 #define BREAK_OFF 0x0000
303 /* CP210X_(SET_MHS|GET_MDMSTS) */
304 #define CONTROL_DTR 0x0001
305 #define CONTROL_RTS 0x0002
306 #define CONTROL_CTS 0x0010
307 #define CONTROL_DSR 0x0020
308 #define CONTROL_RING 0x0040
309 #define CONTROL_DCD 0x0080
310 #define CONTROL_WRITE_DTR 0x0100
311 #define CONTROL_WRITE_RTS 0x0200
313 /* CP210X_GET_COMM_STATUS returns these 0x13 bytes */
314 struct cp210x_comm_status {
316 __le32 ulHoldReasons;
317 __le32 ulAmountInInQueue;
318 __le32 ulAmountInOutQueue;
320 u8 bWaitForImmediate;
325 * CP210X_PURGE - 16 bits passed in wValue of USB request.
326 * SiLabs app note AN571 gives a strange description of the 4 bits:
327 * bit 0 or bit 2 clears the transmit queue and 1 or 3 receive.
328 * writing 1 to all, however, purges cp2108 well enough to avoid the hang.
330 #define PURGE_ALL 0x000f
333 * Reads a variable-sized block of CP210X_ registers, identified by req.
334 * Returns data into buf in native USB byte order.
336 static int cp210x_read_reg_block(struct usb_serial_port *port, u8 req,
337 void *buf, int bufsize)
339 struct usb_serial *serial = port->serial;
340 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
344 dmabuf = kmalloc(bufsize, GFP_KERNEL);
347 * FIXME Some callers don't bother to check for error,
348 * at least give them consistent junk until they are fixed
350 memset(buf, 0, bufsize);
354 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
355 req, REQTYPE_INTERFACE_TO_HOST, 0,
356 port_priv->bInterfaceNumber, dmabuf, bufsize,
357 USB_CTRL_SET_TIMEOUT);
358 if (result == bufsize) {
359 memcpy(buf, dmabuf, bufsize);
362 dev_err(&port->dev, "failed get req 0x%x size %d status: %d\n",
363 req, bufsize, result);
368 * FIXME Some callers don't bother to check for error,
369 * at least give them consistent junk until they are fixed
371 memset(buf, 0, bufsize);
380 * Reads any 32-bit CP210X_ register identified by req.
382 static int cp210x_read_u32_reg(struct usb_serial_port *port, u8 req, u32 *val)
387 err = cp210x_read_reg_block(port, req, &le32_val, sizeof(le32_val));
390 * FIXME Some callers don't bother to check for error,
391 * at least give them consistent junk until they are fixed
397 *val = le32_to_cpu(le32_val);
403 * Reads any 16-bit CP210X_ register identified by req.
405 static int cp210x_read_u16_reg(struct usb_serial_port *port, u8 req, u16 *val)
410 err = cp210x_read_reg_block(port, req, &le16_val, sizeof(le16_val));
414 *val = le16_to_cpu(le16_val);
420 * Reads any 8-bit CP210X_ register identified by req.
422 static int cp210x_read_u8_reg(struct usb_serial_port *port, u8 req, u8 *val)
424 return cp210x_read_reg_block(port, req, val, sizeof(*val));
428 * Writes any 16-bit CP210X_ register (req) whose value is passed
429 * entirely in the wValue field of the USB request.
431 static int cp210x_write_u16_reg(struct usb_serial_port *port, u8 req, u16 val)
433 struct usb_serial *serial = port->serial;
434 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
437 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
438 req, REQTYPE_HOST_TO_INTERFACE, val,
439 port_priv->bInterfaceNumber, NULL, 0,
440 USB_CTRL_SET_TIMEOUT);
442 dev_err(&port->dev, "failed set request 0x%x status: %d\n",
450 * Writes a variable-sized block of CP210X_ registers, identified by req.
451 * Data in buf must be in native USB byte order.
453 static int cp210x_write_reg_block(struct usb_serial_port *port, u8 req,
454 void *buf, int bufsize)
456 struct usb_serial *serial = port->serial;
457 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
461 dmabuf = kmalloc(bufsize, GFP_KERNEL);
465 memcpy(dmabuf, buf, bufsize);
467 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
468 req, REQTYPE_HOST_TO_INTERFACE, 0,
469 port_priv->bInterfaceNumber, dmabuf, bufsize,
470 USB_CTRL_SET_TIMEOUT);
474 if (result == bufsize) {
477 dev_err(&port->dev, "failed set req 0x%x size %d status: %d\n",
478 req, bufsize, result);
487 * Writes any 32-bit CP210X_ register identified by req.
489 static int cp210x_write_u32_reg(struct usb_serial_port *port, u8 req, u32 val)
493 le32_val = cpu_to_le32(val);
495 return cp210x_write_reg_block(port, req, &le32_val, sizeof(le32_val));
499 * Detect CP2108 GET_LINE_CTL bug and activate workaround.
500 * Write a known good value 0x800, read it back.
501 * If it comes back swapped the bug is detected.
502 * Preserve the original register value.
504 static int cp210x_detect_swapped_line_ctl(struct usb_serial_port *port)
506 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
511 err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_save);
515 err = cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, 0x800);
519 err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_test);
523 if (line_ctl_test == 8) {
524 port_priv->has_swapped_line_ctl = true;
525 line_ctl_save = swab16(line_ctl_save);
528 return cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, line_ctl_save);
532 * Must always be called instead of cp210x_read_u16_reg(CP210X_GET_LINE_CTL)
533 * to workaround cp2108 bug and get correct value.
535 static int cp210x_get_line_ctl(struct usb_serial_port *port, u16 *ctl)
537 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
540 err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, ctl);
544 /* Workaround swapped bytes in 16-bit value from CP210X_GET_LINE_CTL */
545 if (port_priv->has_swapped_line_ctl)
552 * cp210x_quantise_baudrate
553 * Quantises the baud rate as per AN205 Table 1
555 static unsigned int cp210x_quantise_baudrate(unsigned int baud)
559 else if (baud <= 600) baud = 600;
560 else if (baud <= 1200) baud = 1200;
561 else if (baud <= 1800) baud = 1800;
562 else if (baud <= 2400) baud = 2400;
563 else if (baud <= 4000) baud = 4000;
564 else if (baud <= 4803) baud = 4800;
565 else if (baud <= 7207) baud = 7200;
566 else if (baud <= 9612) baud = 9600;
567 else if (baud <= 14428) baud = 14400;
568 else if (baud <= 16062) baud = 16000;
569 else if (baud <= 19250) baud = 19200;
570 else if (baud <= 28912) baud = 28800;
571 else if (baud <= 38601) baud = 38400;
572 else if (baud <= 51558) baud = 51200;
573 else if (baud <= 56280) baud = 56000;
574 else if (baud <= 58053) baud = 57600;
575 else if (baud <= 64111) baud = 64000;
576 else if (baud <= 77608) baud = 76800;
577 else if (baud <= 117028) baud = 115200;
578 else if (baud <= 129347) baud = 128000;
579 else if (baud <= 156868) baud = 153600;
580 else if (baud <= 237832) baud = 230400;
581 else if (baud <= 254234) baud = 250000;
582 else if (baud <= 273066) baud = 256000;
583 else if (baud <= 491520) baud = 460800;
584 else if (baud <= 567138) baud = 500000;
585 else if (baud <= 670254) baud = 576000;
586 else if (baud < 1000000)
588 else if (baud > 2000000)
593 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
597 result = cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_ENABLE);
599 dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
603 /* Configure the termios structure */
604 cp210x_get_termios(tty, port);
606 /* The baud rate must be initialised on cp2104 */
608 cp210x_change_speed(tty, port, NULL);
610 return usb_serial_generic_open(tty, port);
613 static void cp210x_close(struct usb_serial_port *port)
615 usb_serial_generic_close(port);
617 /* Clear both queues; cp2108 needs this to avoid an occasional hang */
618 cp210x_write_u16_reg(port, CP210X_PURGE, PURGE_ALL);
620 cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
624 * Read how many bytes are waiting in the TX queue.
626 static int cp210x_get_tx_queue_byte_count(struct usb_serial_port *port,
629 struct usb_serial *serial = port->serial;
630 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
631 struct cp210x_comm_status *sts;
634 sts = kmalloc(sizeof(*sts), GFP_KERNEL);
638 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
639 CP210X_GET_COMM_STATUS, REQTYPE_INTERFACE_TO_HOST,
640 0, port_priv->bInterfaceNumber, sts, sizeof(*sts),
641 USB_CTRL_GET_TIMEOUT);
642 if (result == sizeof(*sts)) {
643 *count = le32_to_cpu(sts->ulAmountInOutQueue);
646 dev_err(&port->dev, "failed to get comm status: %d\n", result);
656 static bool cp210x_tx_empty(struct usb_serial_port *port)
661 err = cp210x_get_tx_queue_byte_count(port, &count);
670 * Reads the baud rate, data bits, parity, stop bits and flow control mode
671 * from the device, corrects any unsupported values, and configures the
672 * termios structure to reflect the state of the device
674 static void cp210x_get_termios(struct tty_struct *tty,
675 struct usb_serial_port *port)
680 cp210x_get_termios_port(tty->driver_data,
681 &tty->termios.c_cflag, &baud);
682 tty_encode_baud_rate(tty, baud, baud);
686 cp210x_get_termios_port(port, &cflag, &baud);
691 * cp210x_get_termios_port
692 * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
694 static void cp210x_get_termios_port(struct usb_serial_port *port,
695 unsigned int *cflagp, unsigned int *baudp)
697 struct device *dev = &port->dev;
703 cp210x_read_u32_reg(port, CP210X_GET_BAUDRATE, &baud);
705 dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud);
710 cp210x_get_line_ctl(port, &bits);
712 switch (bits & BITS_DATA_MASK) {
714 dev_dbg(dev, "%s - data bits = 5\n", __func__);
718 dev_dbg(dev, "%s - data bits = 6\n", __func__);
722 dev_dbg(dev, "%s - data bits = 7\n", __func__);
726 dev_dbg(dev, "%s - data bits = 8\n", __func__);
730 dev_dbg(dev, "%s - data bits = 9 (not supported, using 8 data bits)\n", __func__);
732 bits &= ~BITS_DATA_MASK;
734 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
737 dev_dbg(dev, "%s - Unknown number of data bits, using 8\n", __func__);
739 bits &= ~BITS_DATA_MASK;
741 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
745 switch (bits & BITS_PARITY_MASK) {
746 case BITS_PARITY_NONE:
747 dev_dbg(dev, "%s - parity = NONE\n", __func__);
750 case BITS_PARITY_ODD:
751 dev_dbg(dev, "%s - parity = ODD\n", __func__);
752 cflag |= (PARENB|PARODD);
754 case BITS_PARITY_EVEN:
755 dev_dbg(dev, "%s - parity = EVEN\n", __func__);
759 case BITS_PARITY_MARK:
760 dev_dbg(dev, "%s - parity = MARK\n", __func__);
761 cflag |= (PARENB|PARODD|CMSPAR);
763 case BITS_PARITY_SPACE:
764 dev_dbg(dev, "%s - parity = SPACE\n", __func__);
766 cflag |= (PARENB|CMSPAR);
769 dev_dbg(dev, "%s - Unknown parity mode, disabling parity\n", __func__);
771 bits &= ~BITS_PARITY_MASK;
772 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
777 switch (bits & BITS_STOP_MASK) {
779 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
782 dev_dbg(dev, "%s - stop bits = 1.5 (not supported, using 1 stop bit)\n", __func__);
783 bits &= ~BITS_STOP_MASK;
784 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
787 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
791 dev_dbg(dev, "%s - Unknown number of stop bits, using 1 stop bit\n", __func__);
792 bits &= ~BITS_STOP_MASK;
793 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
797 cp210x_read_reg_block(port, CP210X_GET_FLOW, modem_ctl,
799 if (modem_ctl[0] & 0x08) {
800 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
803 dev_dbg(dev, "%s - flow control = NONE\n", __func__);
811 * CP2101 supports the following baud rates:
813 * 300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
814 * 38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
816 * CP2102 and CP2103 support the following additional rates:
818 * 4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
821 * The device will map a requested rate to a supported one, but the result
822 * of requests for rates greater than 1053257 is undefined (see AN205).
824 * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
825 * respectively, with an error less than 1%. The actual rates are determined
828 * div = round(freq / (2 x prescale x request))
829 * actual = freq / (2 x prescale x div)
831 * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
833 * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
836 static void cp210x_change_speed(struct tty_struct *tty,
837 struct usb_serial_port *port, struct ktermios *old_termios)
841 baud = tty->termios.c_ospeed;
843 /* This maps the requested rate to a rate valid on cp2102 or cp2103,
844 * or to an arbitrary rate in [1M,2M].
846 * NOTE: B0 is not implemented.
848 baud = cp210x_quantise_baudrate(baud);
850 dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
851 if (cp210x_write_u32_reg(port, CP210X_SET_BAUDRATE, baud)) {
852 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
854 baud = old_termios->c_ospeed;
859 tty_encode_baud_rate(tty, baud, baud);
862 static void cp210x_set_termios(struct tty_struct *tty,
863 struct usb_serial_port *port, struct ktermios *old_termios)
865 struct device *dev = &port->dev;
866 unsigned int cflag, old_cflag;
870 cflag = tty->termios.c_cflag;
871 old_cflag = old_termios->c_cflag;
873 if (tty->termios.c_ospeed != old_termios->c_ospeed)
874 cp210x_change_speed(tty, port, old_termios);
876 /* If the number of data bits is to be updated */
877 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
878 cp210x_get_line_ctl(port, &bits);
879 bits &= ~BITS_DATA_MASK;
880 switch (cflag & CSIZE) {
883 dev_dbg(dev, "%s - data bits = 5\n", __func__);
887 dev_dbg(dev, "%s - data bits = 6\n", __func__);
891 dev_dbg(dev, "%s - data bits = 7\n", __func__);
895 dev_dbg(dev, "%s - data bits = 8\n", __func__);
899 dev_dbg(dev, "%s - data bits = 9\n", __func__);
902 dev_dbg(dev, "cp210x driver does not support the number of bits requested, using 8 bit mode\n");
906 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
907 dev_dbg(dev, "Number of data bits requested not supported by device\n");
910 if ((cflag & (PARENB|PARODD|CMSPAR)) !=
911 (old_cflag & (PARENB|PARODD|CMSPAR))) {
912 cp210x_get_line_ctl(port, &bits);
913 bits &= ~BITS_PARITY_MASK;
914 if (cflag & PARENB) {
915 if (cflag & CMSPAR) {
916 if (cflag & PARODD) {
917 bits |= BITS_PARITY_MARK;
918 dev_dbg(dev, "%s - parity = MARK\n", __func__);
920 bits |= BITS_PARITY_SPACE;
921 dev_dbg(dev, "%s - parity = SPACE\n", __func__);
924 if (cflag & PARODD) {
925 bits |= BITS_PARITY_ODD;
926 dev_dbg(dev, "%s - parity = ODD\n", __func__);
928 bits |= BITS_PARITY_EVEN;
929 dev_dbg(dev, "%s - parity = EVEN\n", __func__);
933 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
934 dev_dbg(dev, "Parity mode not supported by device\n");
937 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
938 cp210x_get_line_ctl(port, &bits);
939 bits &= ~BITS_STOP_MASK;
940 if (cflag & CSTOPB) {
942 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
945 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
947 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
948 dev_dbg(dev, "Number of stop bits requested not supported by device\n");
951 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
953 /* Only bytes 0, 4 and 7 out of first 8 have functional bits */
955 cp210x_read_reg_block(port, CP210X_GET_FLOW, modem_ctl,
957 dev_dbg(dev, "%s - read modem controls = %02x .. .. .. %02x .. .. %02x\n",
958 __func__, modem_ctl[0], modem_ctl[4], modem_ctl[7]);
960 if (cflag & CRTSCTS) {
961 modem_ctl[0] &= ~0x7B;
962 modem_ctl[0] |= 0x09;
964 /* FIXME - why clear reserved bits just read? */
968 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
970 modem_ctl[0] &= ~0x7B;
971 modem_ctl[0] |= 0x01;
972 /* FIXME - OR here instead of assignment looks wrong */
973 modem_ctl[4] |= 0x40;
974 dev_dbg(dev, "%s - flow control = NONE\n", __func__);
977 dev_dbg(dev, "%s - write modem controls = %02x .. .. .. %02x .. .. %02x\n",
978 __func__, modem_ctl[0], modem_ctl[4], modem_ctl[7]);
979 cp210x_write_reg_block(port, CP210X_SET_FLOW, modem_ctl,
985 static int cp210x_tiocmset(struct tty_struct *tty,
986 unsigned int set, unsigned int clear)
988 struct usb_serial_port *port = tty->driver_data;
989 return cp210x_tiocmset_port(port, set, clear);
992 static int cp210x_tiocmset_port(struct usb_serial_port *port,
993 unsigned int set, unsigned int clear)
997 if (set & TIOCM_RTS) {
998 control |= CONTROL_RTS;
999 control |= CONTROL_WRITE_RTS;
1001 if (set & TIOCM_DTR) {
1002 control |= CONTROL_DTR;
1003 control |= CONTROL_WRITE_DTR;
1005 if (clear & TIOCM_RTS) {
1006 control &= ~CONTROL_RTS;
1007 control |= CONTROL_WRITE_RTS;
1009 if (clear & TIOCM_DTR) {
1010 control &= ~CONTROL_DTR;
1011 control |= CONTROL_WRITE_DTR;
1014 dev_dbg(&port->dev, "%s - control = 0x%.4x\n", __func__, control);
1016 return cp210x_write_u16_reg(port, CP210X_SET_MHS, control);
1019 static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
1022 cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
1024 cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
1027 static int cp210x_tiocmget(struct tty_struct *tty)
1029 struct usb_serial_port *port = tty->driver_data;
1033 cp210x_read_u8_reg(port, CP210X_GET_MDMSTS, &control);
1035 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
1036 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
1037 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
1038 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
1039 |((control & CONTROL_RING)? TIOCM_RI : 0)
1040 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
1042 dev_dbg(&port->dev, "%s - control = 0x%.2x\n", __func__, control);
1047 static void cp210x_break_ctl(struct tty_struct *tty, int break_state)
1049 struct usb_serial_port *port = tty->driver_data;
1052 if (break_state == 0)
1056 dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
1057 state == BREAK_OFF ? "off" : "on");
1058 cp210x_write_u16_reg(port, CP210X_SET_BREAK, state);
1061 static int cp210x_port_probe(struct usb_serial_port *port)
1063 struct usb_serial *serial = port->serial;
1064 struct usb_host_interface *cur_altsetting;
1065 struct cp210x_port_private *port_priv;
1068 port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
1072 cur_altsetting = serial->interface->cur_altsetting;
1073 port_priv->bInterfaceNumber = cur_altsetting->desc.bInterfaceNumber;
1075 usb_set_serial_port_data(port, port_priv);
1077 ret = cp210x_detect_swapped_line_ctl(port);
1086 static int cp210x_port_remove(struct usb_serial_port *port)
1088 struct cp210x_port_private *port_priv;
1090 port_priv = usb_get_serial_port_data(port);
1096 module_usb_serial_driver(serial_drivers, id_table);
1098 MODULE_DESCRIPTION(DRIVER_DESC);
1099 MODULE_LICENSE("GPL");