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