xref: /linux/drivers/usb/serial/cp210x.c (revision e2ae67a3b55188b0342522d8139acf013feb2a69)
1 /*
2  * Silicon Laboratories CP210x USB to RS232 serial adaptor driver
3  *
4  * Copyright (C) 2005 Craig Shelley (craig@microtron.org.uk)
5  *
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.
9  *
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
13  *
14  */
15 
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>
26 
27 #define DRIVER_DESC "Silicon Labs CP210x RS232 serial adaptor driver"
28 
29 /*
30  * Function Prototypes
31  */
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 *,
38 							struct ktermios *);
39 static void cp210x_set_termios(struct tty_struct *, struct usb_serial_port *,
40 							struct ktermios*);
41 static int cp210x_tiocmget(struct tty_struct *);
42 static int cp210x_tiocmset(struct tty_struct *, unsigned int, unsigned int);
43 static int cp210x_tiocmset_port(struct usb_serial_port *port,
44 		unsigned int, unsigned int);
45 static void cp210x_break_ctl(struct tty_struct *, int);
46 static int cp210x_port_probe(struct usb_serial_port *);
47 static int cp210x_port_remove(struct usb_serial_port *);
48 static void cp210x_dtr_rts(struct usb_serial_port *p, int on);
49 
50 static const struct usb_device_id id_table[] = {
51 	{ USB_DEVICE(0x045B, 0x0053) }, /* Renesas RX610 RX-Stick */
52 	{ USB_DEVICE(0x0471, 0x066A) }, /* AKTAKOM ACE-1001 cable */
53 	{ USB_DEVICE(0x0489, 0xE000) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
54 	{ USB_DEVICE(0x0489, 0xE003) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
55 	{ USB_DEVICE(0x0745, 0x1000) }, /* CipherLab USB CCD Barcode Scanner 1000 */
56 	{ USB_DEVICE(0x0846, 0x1100) }, /* NetGear Managed Switch M4100 series, M5300 series, M7100 series */
57 	{ USB_DEVICE(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
58 	{ USB_DEVICE(0x08FD, 0x000A) }, /* Digianswer A/S , ZigBee/802.15.4 MAC Device */
59 	{ USB_DEVICE(0x0908, 0x01FF) }, /* Siemens RUGGEDCOM USB Serial Console */
60 	{ USB_DEVICE(0x0BED, 0x1100) }, /* MEI (TM) Cashflow-SC Bill/Voucher Acceptor */
61 	{ USB_DEVICE(0x0BED, 0x1101) }, /* MEI series 2000 Combo Acceptor */
62 	{ USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
63 	{ USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
64 	{ USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */
65 	{ USB_DEVICE(0x0FDE, 0xCA05) }, /* OWL Wireless Electricity Monitor CM-160 */
66 	{ USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
67 	{ USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
68 	{ USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
69 	{ USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */
70 	{ USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */
71 	{ USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */
72 	{ USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
73 	{ USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
74 	{ USB_DEVICE(0x10C4, 0x8044) }, /* Cygnal Debug Adapter */
75 	{ USB_DEVICE(0x10C4, 0x804E) }, /* Software Bisque Paramount ME build-in converter */
76 	{ USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
77 	{ USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */
78 	{ USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
79 	{ USB_DEVICE(0x10C4, 0x806F) }, /* IMS USB to RS422 Converter Cable */
80 	{ USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
81 	{ USB_DEVICE(0x10C4, 0x80C4) }, /* Cygnal Integrated Products, Inc., Optris infrared thermometer */
82 	{ USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
83 	{ USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
84 	{ USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
85 	{ USB_DEVICE(0x10C4, 0x8115) }, /* Arygon NFC/Mifare Reader */
86 	{ USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
87 	{ USB_DEVICE(0x10C4, 0x813F) }, /* Tams Master Easy Control */
88 	{ USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
89 	{ USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
90 	{ USB_DEVICE(0x2405, 0x0003) }, /* West Mountain Radio RIGblaster Advantage */
91 	{ USB_DEVICE(0x10C4, 0x8156) }, /* B&G H3000 link cable */
92 	{ USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
93 	{ USB_DEVICE(0x10C4, 0x815F) }, /* Timewave HamLinkUSB */
94 	{ USB_DEVICE(0x10C4, 0x818B) }, /* AVIT Research USB to TTL */
95 	{ USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
96 	{ USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
97 	{ USB_DEVICE(0x10C4, 0x81A9) }, /* Multiplex RC Interface */
98 	{ USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
99 	{ USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */
100 	{ USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
101 	{ USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
102 	{ USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
103 	{ USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
104 	{ USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
105 	{ USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
106 	{ USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
107 	{ USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
108 	{ USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */
109 	{ USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
110 	{ USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
111 	{ USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
112 	{ USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
113 	{ USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
114 	{ USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
115 	{ USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
116 	{ USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
117 	{ USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
118 	{ USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
119 	{ USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
120 	{ USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
121 	{ USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
122 	{ USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
123 	{ USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
124 	{ USB_DEVICE(0x10C4, 0x8856) },	/* CEL EM357 ZigBee USB Stick - LR */
125 	{ USB_DEVICE(0x10C4, 0x8857) },	/* CEL EM357 ZigBee USB Stick */
126 	{ USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
127 	{ USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
128 	{ USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
129 	{ USB_DEVICE(0x10C4, 0x8977) },	/* CEL MeshWorks DevKit Device */
130 	{ USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
131 	{ USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
132 	{ USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
133 	{ USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
134 	{ USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
135 	{ USB_DEVICE(0x10C4, 0xEA80) }, /* Silicon Labs factory default */
136 	{ USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
137 	{ USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
138 	{ USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
139 	{ USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
140 	{ USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
141 	{ USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
142 	{ USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
143 	{ USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
144 	{ USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
145 	{ USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
146 	{ USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
147 	{ USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
148 	{ USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
149 	{ USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
150 	{ USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
151 	{ USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
152 	{ USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
153 	{ USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
154 	{ USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
155 	{ USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
156 	{ USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
157 	{ USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
158 	{ USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
159 	{ USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
160 	{ USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
161 	{ USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
162 	{ USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
163 	{ USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
164 	{ USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
165 	{ USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
166 	{ USB_DEVICE(0x1BA4, 0x0002) },	/* Silicon Labs 358x factory default */
167 	{ USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
168 	{ USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
169 	{ USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
170 	{ USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
171 	{ USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
172 	{ USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
173 	{ USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
174 	{ USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
175 	{ USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
176 	{ USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
177 	{ USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
178 	{ USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
179 	{ USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
180 	{ USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
181 	{ USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
182 	{ USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
183 	{ USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
184 	{ USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
185 	{ USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
186 	{ USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
187 	{ USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
188 	{ USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
189 	{ USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
190 	{ USB_DEVICE(0x2626, 0xEA60) }, /* Aruba Networks 7xxx USB Serial Console */
191 	{ USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
192 	{ USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
193 	{ USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
194 	{ USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
195 	{ } /* Terminating Entry */
196 };
197 
198 MODULE_DEVICE_TABLE(usb, id_table);
199 
200 struct cp210x_port_private {
201 	__u8			bInterfaceNumber;
202 };
203 
204 static struct usb_serial_driver cp210x_device = {
205 	.driver = {
206 		.owner =	THIS_MODULE,
207 		.name =		"cp210x",
208 	},
209 	.id_table		= id_table,
210 	.num_ports		= 1,
211 	.bulk_in_size		= 256,
212 	.bulk_out_size		= 256,
213 	.open			= cp210x_open,
214 	.close			= cp210x_close,
215 	.break_ctl		= cp210x_break_ctl,
216 	.set_termios		= cp210x_set_termios,
217 	.tiocmget		= cp210x_tiocmget,
218 	.tiocmset		= cp210x_tiocmset,
219 	.port_probe		= cp210x_port_probe,
220 	.port_remove		= cp210x_port_remove,
221 	.dtr_rts		= cp210x_dtr_rts
222 };
223 
224 static struct usb_serial_driver * const serial_drivers[] = {
225 	&cp210x_device, NULL
226 };
227 
228 /* Config request types */
229 #define REQTYPE_HOST_TO_INTERFACE	0x41
230 #define REQTYPE_INTERFACE_TO_HOST	0xc1
231 #define REQTYPE_HOST_TO_DEVICE	0x40
232 #define REQTYPE_DEVICE_TO_HOST	0xc0
233 
234 /* Config request codes */
235 #define CP210X_IFC_ENABLE	0x00
236 #define CP210X_SET_BAUDDIV	0x01
237 #define CP210X_GET_BAUDDIV	0x02
238 #define CP210X_SET_LINE_CTL	0x03
239 #define CP210X_GET_LINE_CTL	0x04
240 #define CP210X_SET_BREAK	0x05
241 #define CP210X_IMM_CHAR		0x06
242 #define CP210X_SET_MHS		0x07
243 #define CP210X_GET_MDMSTS	0x08
244 #define CP210X_SET_XON		0x09
245 #define CP210X_SET_XOFF		0x0A
246 #define CP210X_SET_EVENTMASK	0x0B
247 #define CP210X_GET_EVENTMASK	0x0C
248 #define CP210X_SET_CHAR		0x0D
249 #define CP210X_GET_CHARS	0x0E
250 #define CP210X_GET_PROPS	0x0F
251 #define CP210X_GET_COMM_STATUS	0x10
252 #define CP210X_RESET		0x11
253 #define CP210X_PURGE		0x12
254 #define CP210X_SET_FLOW		0x13
255 #define CP210X_GET_FLOW		0x14
256 #define CP210X_EMBED_EVENTS	0x15
257 #define CP210X_GET_EVENTSTATE	0x16
258 #define CP210X_SET_CHARS	0x19
259 #define CP210X_GET_BAUDRATE	0x1D
260 #define CP210X_SET_BAUDRATE	0x1E
261 
262 /* CP210X_IFC_ENABLE */
263 #define UART_ENABLE		0x0001
264 #define UART_DISABLE		0x0000
265 
266 /* CP210X_(SET|GET)_BAUDDIV */
267 #define BAUD_RATE_GEN_FREQ	0x384000
268 
269 /* CP210X_(SET|GET)_LINE_CTL */
270 #define BITS_DATA_MASK		0X0f00
271 #define BITS_DATA_5		0X0500
272 #define BITS_DATA_6		0X0600
273 #define BITS_DATA_7		0X0700
274 #define BITS_DATA_8		0X0800
275 #define BITS_DATA_9		0X0900
276 
277 #define BITS_PARITY_MASK	0x00f0
278 #define BITS_PARITY_NONE	0x0000
279 #define BITS_PARITY_ODD		0x0010
280 #define BITS_PARITY_EVEN	0x0020
281 #define BITS_PARITY_MARK	0x0030
282 #define BITS_PARITY_SPACE	0x0040
283 
284 #define BITS_STOP_MASK		0x000f
285 #define BITS_STOP_1		0x0000
286 #define BITS_STOP_1_5		0x0001
287 #define BITS_STOP_2		0x0002
288 
289 /* CP210X_SET_BREAK */
290 #define BREAK_ON		0x0001
291 #define BREAK_OFF		0x0000
292 
293 /* CP210X_(SET_MHS|GET_MDMSTS) */
294 #define CONTROL_DTR		0x0001
295 #define CONTROL_RTS		0x0002
296 #define CONTROL_CTS		0x0010
297 #define CONTROL_DSR		0x0020
298 #define CONTROL_RING		0x0040
299 #define CONTROL_DCD		0x0080
300 #define CONTROL_WRITE_DTR	0x0100
301 #define CONTROL_WRITE_RTS	0x0200
302 
303 /*
304  * CP210X_PURGE - 16 bits passed in wValue of USB request.
305  * SiLabs app note AN571 gives a strange description of the 4 bits:
306  * bit 0 or bit 2 clears the transmit queue and 1 or 3 receive.
307  * writing 1 to all, however, purges cp2108 well enough to avoid the hang.
308  */
309 #define PURGE_ALL		0x000f
310 
311 /*
312  * cp210x_get_config
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)
317  */
318 static int cp210x_get_config(struct usb_serial_port *port, u8 request,
319 		unsigned int *data, int size)
320 {
321 	struct usb_serial *serial = port->serial;
322 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
323 	__le32 *buf;
324 	int result, i, length;
325 
326 	/* Number of integers required to contain the array */
327 	length = (((size - 1) | 3) + 1) / 4;
328 
329 	buf = kcalloc(length, sizeof(__le32), GFP_KERNEL);
330 	if (!buf)
331 		return -ENOMEM;
332 
333 	/* Issue the request, attempting to read 'size' bytes */
334 	result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
335 				request, REQTYPE_INTERFACE_TO_HOST, 0x0000,
336 				port_priv->bInterfaceNumber, buf, size,
337 				USB_CTRL_GET_TIMEOUT);
338 
339 	/* Convert data into an array of integers */
340 	for (i = 0; i < length; i++)
341 		data[i] = le32_to_cpu(buf[i]);
342 
343 	kfree(buf);
344 
345 	if (result != size) {
346 		dev_dbg(&port->dev, "%s - Unable to send config request, request=0x%x size=%d result=%d\n",
347 			__func__, request, size, result);
348 		if (result > 0)
349 			result = -EPROTO;
350 
351 		return result;
352 	}
353 
354 	return 0;
355 }
356 
357 /*
358  * cp210x_set_config
359  * Writes to the CP210x configuration registers
360  * Values less than 16 bits wide are sent directly
361  * 'size' is specified in bytes.
362  */
363 static int cp210x_set_config(struct usb_serial_port *port, u8 request,
364 		unsigned int *data, int size)
365 {
366 	struct usb_serial *serial = port->serial;
367 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
368 	__le32 *buf;
369 	int result, i, length;
370 
371 	/* Number of integers required to contain the array */
372 	length = (((size - 1) | 3) + 1) / 4;
373 
374 	buf = kmalloc(length * sizeof(__le32), GFP_KERNEL);
375 	if (!buf)
376 		return -ENOMEM;
377 
378 	/* Array of integers into bytes */
379 	for (i = 0; i < length; i++)
380 		buf[i] = cpu_to_le32(data[i]);
381 
382 	if (size > 2) {
383 		result = usb_control_msg(serial->dev,
384 				usb_sndctrlpipe(serial->dev, 0),
385 				request, REQTYPE_HOST_TO_INTERFACE, 0x0000,
386 				port_priv->bInterfaceNumber, buf, size,
387 				USB_CTRL_SET_TIMEOUT);
388 	} else {
389 		result = usb_control_msg(serial->dev,
390 				usb_sndctrlpipe(serial->dev, 0),
391 				request, REQTYPE_HOST_TO_INTERFACE, data[0],
392 				port_priv->bInterfaceNumber, NULL, 0,
393 				USB_CTRL_SET_TIMEOUT);
394 	}
395 
396 	kfree(buf);
397 
398 	if ((size > 2 && result != size) || result < 0) {
399 		dev_dbg(&port->dev, "%s - Unable to send request, request=0x%x size=%d result=%d\n",
400 			__func__, request, size, result);
401 		if (result > 0)
402 			result = -EPROTO;
403 
404 		return result;
405 	}
406 
407 	return 0;
408 }
409 
410 /*
411  * cp210x_set_config_single
412  * Convenience function for calling cp210x_set_config on single data values
413  * without requiring an integer pointer
414  */
415 static inline int cp210x_set_config_single(struct usb_serial_port *port,
416 		u8 request, unsigned int data)
417 {
418 	return cp210x_set_config(port, request, &data, 2);
419 }
420 
421 /*
422  * cp210x_quantise_baudrate
423  * Quantises the baud rate as per AN205 Table 1
424  */
425 static unsigned int cp210x_quantise_baudrate(unsigned int baud)
426 {
427 	if (baud <= 300)
428 		baud = 300;
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)
457 		baud = 921600;
458 	else if (baud > 2000000)
459 		baud = 2000000;
460 	return baud;
461 }
462 
463 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
464 {
465 	int result;
466 
467 	result = cp210x_set_config_single(port, CP210X_IFC_ENABLE,
468 								UART_ENABLE);
469 	if (result) {
470 		dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
471 		return result;
472 	}
473 
474 	/* Configure the termios structure */
475 	cp210x_get_termios(tty, port);
476 
477 	/* The baud rate must be initialised on cp2104 */
478 	if (tty)
479 		cp210x_change_speed(tty, port, NULL);
480 
481 	return usb_serial_generic_open(tty, port);
482 }
483 
484 static void cp210x_close(struct usb_serial_port *port)
485 {
486 	unsigned int purge_ctl;
487 
488 	usb_serial_generic_close(port);
489 
490 	/* Clear both queues; cp2108 needs this to avoid an occasional hang */
491 	purge_ctl = PURGE_ALL;
492 	cp210x_set_config(port, CP210X_PURGE, &purge_ctl, 2);
493 
494 	cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_DISABLE);
495 }
496 
497 /*
498  * cp210x_get_termios
499  * Reads the baud rate, data bits, parity, stop bits and flow control mode
500  * from the device, corrects any unsupported values, and configures the
501  * termios structure to reflect the state of the device
502  */
503 static void cp210x_get_termios(struct tty_struct *tty,
504 	struct usb_serial_port *port)
505 {
506 	unsigned int baud;
507 
508 	if (tty) {
509 		cp210x_get_termios_port(tty->driver_data,
510 			&tty->termios.c_cflag, &baud);
511 		tty_encode_baud_rate(tty, baud, baud);
512 	} else {
513 		unsigned int cflag;
514 		cflag = 0;
515 		cp210x_get_termios_port(port, &cflag, &baud);
516 	}
517 }
518 
519 /*
520  * cp210x_get_termios_port
521  * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
522  */
523 static void cp210x_get_termios_port(struct usb_serial_port *port,
524 	unsigned int *cflagp, unsigned int *baudp)
525 {
526 	struct device *dev = &port->dev;
527 	unsigned int cflag, modem_ctl[4];
528 	unsigned int baud;
529 	unsigned int bits;
530 
531 	cp210x_get_config(port, CP210X_GET_BAUDRATE, &baud, 4);
532 
533 	dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud);
534 	*baudp = baud;
535 
536 	cflag = *cflagp;
537 
538 	cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
539 	cflag &= ~CSIZE;
540 	switch (bits & BITS_DATA_MASK) {
541 	case BITS_DATA_5:
542 		dev_dbg(dev, "%s - data bits = 5\n", __func__);
543 		cflag |= CS5;
544 		break;
545 	case BITS_DATA_6:
546 		dev_dbg(dev, "%s - data bits = 6\n", __func__);
547 		cflag |= CS6;
548 		break;
549 	case BITS_DATA_7:
550 		dev_dbg(dev, "%s - data bits = 7\n", __func__);
551 		cflag |= CS7;
552 		break;
553 	case BITS_DATA_8:
554 		dev_dbg(dev, "%s - data bits = 8\n", __func__);
555 		cflag |= CS8;
556 		break;
557 	case BITS_DATA_9:
558 		dev_dbg(dev, "%s - data bits = 9 (not supported, using 8 data bits)\n", __func__);
559 		cflag |= CS8;
560 		bits &= ~BITS_DATA_MASK;
561 		bits |= BITS_DATA_8;
562 		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
563 		break;
564 	default:
565 		dev_dbg(dev, "%s - Unknown number of data bits, using 8\n", __func__);
566 		cflag |= CS8;
567 		bits &= ~BITS_DATA_MASK;
568 		bits |= BITS_DATA_8;
569 		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
570 		break;
571 	}
572 
573 	switch (bits & BITS_PARITY_MASK) {
574 	case BITS_PARITY_NONE:
575 		dev_dbg(dev, "%s - parity = NONE\n", __func__);
576 		cflag &= ~PARENB;
577 		break;
578 	case BITS_PARITY_ODD:
579 		dev_dbg(dev, "%s - parity = ODD\n", __func__);
580 		cflag |= (PARENB|PARODD);
581 		break;
582 	case BITS_PARITY_EVEN:
583 		dev_dbg(dev, "%s - parity = EVEN\n", __func__);
584 		cflag &= ~PARODD;
585 		cflag |= PARENB;
586 		break;
587 	case BITS_PARITY_MARK:
588 		dev_dbg(dev, "%s - parity = MARK\n", __func__);
589 		cflag |= (PARENB|PARODD|CMSPAR);
590 		break;
591 	case BITS_PARITY_SPACE:
592 		dev_dbg(dev, "%s - parity = SPACE\n", __func__);
593 		cflag &= ~PARODD;
594 		cflag |= (PARENB|CMSPAR);
595 		break;
596 	default:
597 		dev_dbg(dev, "%s - Unknown parity mode, disabling parity\n", __func__);
598 		cflag &= ~PARENB;
599 		bits &= ~BITS_PARITY_MASK;
600 		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
601 		break;
602 	}
603 
604 	cflag &= ~CSTOPB;
605 	switch (bits & BITS_STOP_MASK) {
606 	case BITS_STOP_1:
607 		dev_dbg(dev, "%s - stop bits = 1\n", __func__);
608 		break;
609 	case BITS_STOP_1_5:
610 		dev_dbg(dev, "%s - stop bits = 1.5 (not supported, using 1 stop bit)\n", __func__);
611 		bits &= ~BITS_STOP_MASK;
612 		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
613 		break;
614 	case BITS_STOP_2:
615 		dev_dbg(dev, "%s - stop bits = 2\n", __func__);
616 		cflag |= CSTOPB;
617 		break;
618 	default:
619 		dev_dbg(dev, "%s - Unknown number of stop bits, using 1 stop bit\n", __func__);
620 		bits &= ~BITS_STOP_MASK;
621 		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
622 		break;
623 	}
624 
625 	cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
626 	if (modem_ctl[0] & 0x0008) {
627 		dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
628 		cflag |= CRTSCTS;
629 	} else {
630 		dev_dbg(dev, "%s - flow control = NONE\n", __func__);
631 		cflag &= ~CRTSCTS;
632 	}
633 
634 	*cflagp = cflag;
635 }
636 
637 /*
638  * CP2101 supports the following baud rates:
639  *
640  *	300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
641  *	38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
642  *
643  * CP2102 and CP2103 support the following additional rates:
644  *
645  *	4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
646  *	576000
647  *
648  * The device will map a requested rate to a supported one, but the result
649  * of requests for rates greater than 1053257 is undefined (see AN205).
650  *
651  * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
652  * respectively, with an error less than 1%. The actual rates are determined
653  * by
654  *
655  *	div = round(freq / (2 x prescale x request))
656  *	actual = freq / (2 x prescale x div)
657  *
658  * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
659  * or 1 otherwise.
660  * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
661  * otherwise.
662  */
663 static void cp210x_change_speed(struct tty_struct *tty,
664 		struct usb_serial_port *port, struct ktermios *old_termios)
665 {
666 	u32 baud;
667 
668 	baud = tty->termios.c_ospeed;
669 
670 	/* This maps the requested rate to a rate valid on cp2102 or cp2103,
671 	 * or to an arbitrary rate in [1M,2M].
672 	 *
673 	 * NOTE: B0 is not implemented.
674 	 */
675 	baud = cp210x_quantise_baudrate(baud);
676 
677 	dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
678 	if (cp210x_set_config(port, CP210X_SET_BAUDRATE, &baud,
679 							sizeof(baud))) {
680 		dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
681 		if (old_termios)
682 			baud = old_termios->c_ospeed;
683 		else
684 			baud = 9600;
685 	}
686 
687 	tty_encode_baud_rate(tty, baud, baud);
688 }
689 
690 static void cp210x_set_termios(struct tty_struct *tty,
691 		struct usb_serial_port *port, struct ktermios *old_termios)
692 {
693 	struct device *dev = &port->dev;
694 	unsigned int cflag, old_cflag;
695 	unsigned int bits;
696 	unsigned int modem_ctl[4];
697 
698 	cflag = tty->termios.c_cflag;
699 	old_cflag = old_termios->c_cflag;
700 
701 	if (tty->termios.c_ospeed != old_termios->c_ospeed)
702 		cp210x_change_speed(tty, port, old_termios);
703 
704 	/* If the number of data bits is to be updated */
705 	if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
706 		cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
707 		bits &= ~BITS_DATA_MASK;
708 		switch (cflag & CSIZE) {
709 		case CS5:
710 			bits |= BITS_DATA_5;
711 			dev_dbg(dev, "%s - data bits = 5\n", __func__);
712 			break;
713 		case CS6:
714 			bits |= BITS_DATA_6;
715 			dev_dbg(dev, "%s - data bits = 6\n", __func__);
716 			break;
717 		case CS7:
718 			bits |= BITS_DATA_7;
719 			dev_dbg(dev, "%s - data bits = 7\n", __func__);
720 			break;
721 		case CS8:
722 			bits |= BITS_DATA_8;
723 			dev_dbg(dev, "%s - data bits = 8\n", __func__);
724 			break;
725 		/*case CS9:
726 			bits |= BITS_DATA_9;
727 			dev_dbg(dev, "%s - data bits = 9\n", __func__);
728 			break;*/
729 		default:
730 			dev_dbg(dev, "cp210x driver does not support the number of bits requested, using 8 bit mode\n");
731 			bits |= BITS_DATA_8;
732 			break;
733 		}
734 		if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
735 			dev_dbg(dev, "Number of data bits requested not supported by device\n");
736 	}
737 
738 	if ((cflag     & (PARENB|PARODD|CMSPAR)) !=
739 	    (old_cflag & (PARENB|PARODD|CMSPAR))) {
740 		cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
741 		bits &= ~BITS_PARITY_MASK;
742 		if (cflag & PARENB) {
743 			if (cflag & CMSPAR) {
744 				if (cflag & PARODD) {
745 					bits |= BITS_PARITY_MARK;
746 					dev_dbg(dev, "%s - parity = MARK\n", __func__);
747 				} else {
748 					bits |= BITS_PARITY_SPACE;
749 					dev_dbg(dev, "%s - parity = SPACE\n", __func__);
750 				}
751 			} else {
752 				if (cflag & PARODD) {
753 					bits |= BITS_PARITY_ODD;
754 					dev_dbg(dev, "%s - parity = ODD\n", __func__);
755 				} else {
756 					bits |= BITS_PARITY_EVEN;
757 					dev_dbg(dev, "%s - parity = EVEN\n", __func__);
758 				}
759 			}
760 		}
761 		if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
762 			dev_dbg(dev, "Parity mode not supported by device\n");
763 	}
764 
765 	if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
766 		cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
767 		bits &= ~BITS_STOP_MASK;
768 		if (cflag & CSTOPB) {
769 			bits |= BITS_STOP_2;
770 			dev_dbg(dev, "%s - stop bits = 2\n", __func__);
771 		} else {
772 			bits |= BITS_STOP_1;
773 			dev_dbg(dev, "%s - stop bits = 1\n", __func__);
774 		}
775 		if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
776 			dev_dbg(dev, "Number of stop bits requested not supported by device\n");
777 	}
778 
779 	if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
780 		cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
781 		dev_dbg(dev, "%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x\n",
782 			__func__, modem_ctl[0], modem_ctl[1],
783 			modem_ctl[2], modem_ctl[3]);
784 
785 		if (cflag & CRTSCTS) {
786 			modem_ctl[0] &= ~0x7B;
787 			modem_ctl[0] |= 0x09;
788 			modem_ctl[1] = 0x80;
789 			dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
790 		} else {
791 			modem_ctl[0] &= ~0x7B;
792 			modem_ctl[0] |= 0x01;
793 			modem_ctl[1] |= 0x40;
794 			dev_dbg(dev, "%s - flow control = NONE\n", __func__);
795 		}
796 
797 		dev_dbg(dev, "%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x\n",
798 			__func__, modem_ctl[0], modem_ctl[1],
799 			modem_ctl[2], modem_ctl[3]);
800 		cp210x_set_config(port, CP210X_SET_FLOW, modem_ctl, 16);
801 	}
802 
803 }
804 
805 static int cp210x_tiocmset(struct tty_struct *tty,
806 		unsigned int set, unsigned int clear)
807 {
808 	struct usb_serial_port *port = tty->driver_data;
809 	return cp210x_tiocmset_port(port, set, clear);
810 }
811 
812 static int cp210x_tiocmset_port(struct usb_serial_port *port,
813 		unsigned int set, unsigned int clear)
814 {
815 	unsigned int control = 0;
816 
817 	if (set & TIOCM_RTS) {
818 		control |= CONTROL_RTS;
819 		control |= CONTROL_WRITE_RTS;
820 	}
821 	if (set & TIOCM_DTR) {
822 		control |= CONTROL_DTR;
823 		control |= CONTROL_WRITE_DTR;
824 	}
825 	if (clear & TIOCM_RTS) {
826 		control &= ~CONTROL_RTS;
827 		control |= CONTROL_WRITE_RTS;
828 	}
829 	if (clear & TIOCM_DTR) {
830 		control &= ~CONTROL_DTR;
831 		control |= CONTROL_WRITE_DTR;
832 	}
833 
834 	dev_dbg(&port->dev, "%s - control = 0x%.4x\n", __func__, control);
835 
836 	return cp210x_set_config(port, CP210X_SET_MHS, &control, 2);
837 }
838 
839 static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
840 {
841 	if (on)
842 		cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
843 	else
844 		cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
845 }
846 
847 static int cp210x_tiocmget(struct tty_struct *tty)
848 {
849 	struct usb_serial_port *port = tty->driver_data;
850 	unsigned int control;
851 	int result;
852 
853 	cp210x_get_config(port, CP210X_GET_MDMSTS, &control, 1);
854 
855 	result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
856 		|((control & CONTROL_RTS) ? TIOCM_RTS : 0)
857 		|((control & CONTROL_CTS) ? TIOCM_CTS : 0)
858 		|((control & CONTROL_DSR) ? TIOCM_DSR : 0)
859 		|((control & CONTROL_RING)? TIOCM_RI  : 0)
860 		|((control & CONTROL_DCD) ? TIOCM_CD  : 0);
861 
862 	dev_dbg(&port->dev, "%s - control = 0x%.2x\n", __func__, control);
863 
864 	return result;
865 }
866 
867 static void cp210x_break_ctl(struct tty_struct *tty, int break_state)
868 {
869 	struct usb_serial_port *port = tty->driver_data;
870 	unsigned int state;
871 
872 	if (break_state == 0)
873 		state = BREAK_OFF;
874 	else
875 		state = BREAK_ON;
876 	dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
877 		state == BREAK_OFF ? "off" : "on");
878 	cp210x_set_config(port, CP210X_SET_BREAK, &state, 2);
879 }
880 
881 static int cp210x_port_probe(struct usb_serial_port *port)
882 {
883 	struct usb_serial *serial = port->serial;
884 	struct usb_host_interface *cur_altsetting;
885 	struct cp210x_port_private *port_priv;
886 
887 	port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
888 	if (!port_priv)
889 		return -ENOMEM;
890 
891 	cur_altsetting = serial->interface->cur_altsetting;
892 	port_priv->bInterfaceNumber = cur_altsetting->desc.bInterfaceNumber;
893 
894 	usb_set_serial_port_data(port, port_priv);
895 
896 	return 0;
897 }
898 
899 static int cp210x_port_remove(struct usb_serial_port *port)
900 {
901 	struct cp210x_port_private *port_priv;
902 
903 	port_priv = usb_get_serial_port_data(port);
904 	kfree(port_priv);
905 
906 	return 0;
907 }
908 
909 module_usb_serial_driver(serial_drivers, id_table);
910 
911 MODULE_DESCRIPTION(DRIVER_DESC);
912 MODULE_LICENSE("GPL");
913