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