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