xref: /openbmc/linux/drivers/usb/serial/cp210x.c (revision 681e4a5e13c1c8315694eb4f44e0cdd84c9082d2)
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_driver cp210x_driver = {
160 	.name		= "cp210x",
161 	.probe		= usb_serial_probe,
162 	.disconnect	= usb_serial_disconnect,
163 	.id_table	= id_table,
164 };
165 
166 static struct usb_serial_driver cp210x_device = {
167 	.driver = {
168 		.owner =	THIS_MODULE,
169 		.name = 	"cp210x",
170 	},
171 	.id_table		= id_table,
172 	.num_ports		= 1,
173 	.bulk_in_size		= 256,
174 	.bulk_out_size		= 256,
175 	.open			= cp210x_open,
176 	.close			= cp210x_close,
177 	.break_ctl		= cp210x_break_ctl,
178 	.set_termios		= cp210x_set_termios,
179 	.tiocmget 		= cp210x_tiocmget,
180 	.tiocmset		= cp210x_tiocmset,
181 	.attach			= cp210x_startup,
182 	.release		= cp210x_release,
183 	.dtr_rts		= cp210x_dtr_rts
184 };
185 
186 static struct usb_serial_driver * const serial_drivers[] = {
187 	&cp210x_device, NULL
188 };
189 
190 /* Config request types */
191 #define REQTYPE_HOST_TO_DEVICE	0x41
192 #define REQTYPE_DEVICE_TO_HOST	0xc1
193 
194 /* Config request codes */
195 #define CP210X_IFC_ENABLE	0x00
196 #define CP210X_SET_BAUDDIV	0x01
197 #define CP210X_GET_BAUDDIV	0x02
198 #define CP210X_SET_LINE_CTL	0x03
199 #define CP210X_GET_LINE_CTL	0x04
200 #define CP210X_SET_BREAK	0x05
201 #define CP210X_IMM_CHAR		0x06
202 #define CP210X_SET_MHS		0x07
203 #define CP210X_GET_MDMSTS	0x08
204 #define CP210X_SET_XON		0x09
205 #define CP210X_SET_XOFF		0x0A
206 #define CP210X_SET_EVENTMASK	0x0B
207 #define CP210X_GET_EVENTMASK	0x0C
208 #define CP210X_SET_CHAR		0x0D
209 #define CP210X_GET_CHARS	0x0E
210 #define CP210X_GET_PROPS	0x0F
211 #define CP210X_GET_COMM_STATUS	0x10
212 #define CP210X_RESET		0x11
213 #define CP210X_PURGE		0x12
214 #define CP210X_SET_FLOW		0x13
215 #define CP210X_GET_FLOW		0x14
216 #define CP210X_EMBED_EVENTS	0x15
217 #define CP210X_GET_EVENTSTATE	0x16
218 #define CP210X_SET_CHARS	0x19
219 #define CP210X_GET_BAUDRATE	0x1D
220 #define CP210X_SET_BAUDRATE	0x1E
221 
222 /* CP210X_IFC_ENABLE */
223 #define UART_ENABLE		0x0001
224 #define UART_DISABLE		0x0000
225 
226 /* CP210X_(SET|GET)_BAUDDIV */
227 #define BAUD_RATE_GEN_FREQ	0x384000
228 
229 /* CP210X_(SET|GET)_LINE_CTL */
230 #define BITS_DATA_MASK		0X0f00
231 #define BITS_DATA_5		0X0500
232 #define BITS_DATA_6		0X0600
233 #define BITS_DATA_7		0X0700
234 #define BITS_DATA_8		0X0800
235 #define BITS_DATA_9		0X0900
236 
237 #define BITS_PARITY_MASK	0x00f0
238 #define BITS_PARITY_NONE	0x0000
239 #define BITS_PARITY_ODD		0x0010
240 #define BITS_PARITY_EVEN	0x0020
241 #define BITS_PARITY_MARK	0x0030
242 #define BITS_PARITY_SPACE	0x0040
243 
244 #define BITS_STOP_MASK		0x000f
245 #define BITS_STOP_1		0x0000
246 #define BITS_STOP_1_5		0x0001
247 #define BITS_STOP_2		0x0002
248 
249 /* CP210X_SET_BREAK */
250 #define BREAK_ON		0x0001
251 #define BREAK_OFF		0x0000
252 
253 /* CP210X_(SET_MHS|GET_MDMSTS) */
254 #define CONTROL_DTR		0x0001
255 #define CONTROL_RTS		0x0002
256 #define CONTROL_CTS		0x0010
257 #define CONTROL_DSR		0x0020
258 #define CONTROL_RING		0x0040
259 #define CONTROL_DCD		0x0080
260 #define CONTROL_WRITE_DTR	0x0100
261 #define CONTROL_WRITE_RTS	0x0200
262 
263 /*
264  * cp210x_get_config
265  * Reads from the CP210x configuration registers
266  * 'size' is specified in bytes.
267  * 'data' is a pointer to a pre-allocated array of integers large
268  * enough to hold 'size' bytes (with 4 bytes to each integer)
269  */
270 static int cp210x_get_config(struct usb_serial_port *port, u8 request,
271 		unsigned int *data, int size)
272 {
273 	struct usb_serial *serial = port->serial;
274 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
275 	__le32 *buf;
276 	int result, i, length;
277 
278 	/* Number of integers required to contain the array */
279 	length = (((size - 1) | 3) + 1)/4;
280 
281 	buf = kcalloc(length, sizeof(__le32), GFP_KERNEL);
282 	if (!buf) {
283 		dev_err(&port->dev, "%s - out of memory.\n", __func__);
284 		return -ENOMEM;
285 	}
286 
287 	/* Issue the request, attempting to read 'size' bytes */
288 	result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
289 				request, REQTYPE_DEVICE_TO_HOST, 0x0000,
290 				port_priv->bInterfaceNumber, buf, size, 300);
291 
292 	/* Convert data into an array of integers */
293 	for (i = 0; i < length; i++)
294 		data[i] = le32_to_cpu(buf[i]);
295 
296 	kfree(buf);
297 
298 	if (result != size) {
299 		dbg("%s - Unable to send config request, "
300 				"request=0x%x size=%d result=%d",
301 				__func__, request, size, result);
302 		if (result > 0)
303 			result = -EPROTO;
304 
305 		return result;
306 	}
307 
308 	return 0;
309 }
310 
311 /*
312  * cp210x_set_config
313  * Writes to the CP210x configuration registers
314  * Values less than 16 bits wide are sent directly
315  * 'size' is specified in bytes.
316  */
317 static int cp210x_set_config(struct usb_serial_port *port, u8 request,
318 		unsigned int *data, int size)
319 {
320 	struct usb_serial *serial = port->serial;
321 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
322 	__le32 *buf;
323 	int result, i, length;
324 
325 	/* Number of integers required to contain the array */
326 	length = (((size - 1) | 3) + 1)/4;
327 
328 	buf = kmalloc(length * sizeof(__le32), GFP_KERNEL);
329 	if (!buf) {
330 		dev_err(&port->dev, "%s - out of memory.\n",
331 				__func__);
332 		return -ENOMEM;
333 	}
334 
335 	/* Array of integers into bytes */
336 	for (i = 0; i < length; i++)
337 		buf[i] = cpu_to_le32(data[i]);
338 
339 	if (size > 2) {
340 		result = usb_control_msg(serial->dev,
341 				usb_sndctrlpipe(serial->dev, 0),
342 				request, REQTYPE_HOST_TO_DEVICE, 0x0000,
343 				port_priv->bInterfaceNumber, buf, size, 300);
344 	} else {
345 		result = usb_control_msg(serial->dev,
346 				usb_sndctrlpipe(serial->dev, 0),
347 				request, REQTYPE_HOST_TO_DEVICE, data[0],
348 				port_priv->bInterfaceNumber, NULL, 0, 300);
349 	}
350 
351 	kfree(buf);
352 
353 	if ((size > 2 && result != size) || result < 0) {
354 		dbg("%s - Unable to send request, "
355 				"request=0x%x size=%d result=%d",
356 				__func__, request, size, result);
357 		if (result > 0)
358 			result = -EPROTO;
359 
360 		return result;
361 	}
362 
363 	return 0;
364 }
365 
366 /*
367  * cp210x_set_config_single
368  * Convenience function for calling cp210x_set_config on single data values
369  * without requiring an integer pointer
370  */
371 static inline int cp210x_set_config_single(struct usb_serial_port *port,
372 		u8 request, unsigned int data)
373 {
374 	return cp210x_set_config(port, request, &data, 2);
375 }
376 
377 /*
378  * cp210x_quantise_baudrate
379  * Quantises the baud rate as per AN205 Table 1
380  */
381 static unsigned int cp210x_quantise_baudrate(unsigned int baud) {
382 	if (baud <= 300)
383 		baud = 300;
384 	else if (baud <= 600)      baud = 600;
385 	else if (baud <= 1200)     baud = 1200;
386 	else if (baud <= 1800)     baud = 1800;
387 	else if (baud <= 2400)     baud = 2400;
388 	else if (baud <= 4000)     baud = 4000;
389 	else if (baud <= 4803)     baud = 4800;
390 	else if (baud <= 7207)     baud = 7200;
391 	else if (baud <= 9612)     baud = 9600;
392 	else if (baud <= 14428)    baud = 14400;
393 	else if (baud <= 16062)    baud = 16000;
394 	else if (baud <= 19250)    baud = 19200;
395 	else if (baud <= 28912)    baud = 28800;
396 	else if (baud <= 38601)    baud = 38400;
397 	else if (baud <= 51558)    baud = 51200;
398 	else if (baud <= 56280)    baud = 56000;
399 	else if (baud <= 58053)    baud = 57600;
400 	else if (baud <= 64111)    baud = 64000;
401 	else if (baud <= 77608)    baud = 76800;
402 	else if (baud <= 117028)   baud = 115200;
403 	else if (baud <= 129347)   baud = 128000;
404 	else if (baud <= 156868)   baud = 153600;
405 	else if (baud <= 237832)   baud = 230400;
406 	else if (baud <= 254234)   baud = 250000;
407 	else if (baud <= 273066)   baud = 256000;
408 	else if (baud <= 491520)   baud = 460800;
409 	else if (baud <= 567138)   baud = 500000;
410 	else if (baud <= 670254)   baud = 576000;
411 	else if (baud < 1000000)
412 		baud = 921600;
413 	else if (baud > 2000000)
414 		baud = 2000000;
415 	return baud;
416 }
417 
418 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
419 {
420 	int result;
421 
422 	dbg("%s - port %d", __func__, port->number);
423 
424 	result = cp210x_set_config_single(port, CP210X_IFC_ENABLE,
425 								UART_ENABLE);
426 	if (result) {
427 		dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
428 		return result;
429 	}
430 
431 	/* Configure the termios structure */
432 	cp210x_get_termios(tty, port);
433 
434 	/* The baud rate must be initialised on cp2104 */
435 	if (tty)
436 		cp210x_change_speed(tty, port, NULL);
437 
438 	return usb_serial_generic_open(tty, port);
439 }
440 
441 static void cp210x_close(struct usb_serial_port *port)
442 {
443 	dbg("%s - port %d", __func__, port->number);
444 
445 	usb_serial_generic_close(port);
446 
447 	mutex_lock(&port->serial->disc_mutex);
448 	if (!port->serial->disconnected)
449 		cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_DISABLE);
450 	mutex_unlock(&port->serial->disc_mutex);
451 }
452 
453 /*
454  * cp210x_get_termios
455  * Reads the baud rate, data bits, parity, stop bits and flow control mode
456  * from the device, corrects any unsupported values, and configures the
457  * termios structure to reflect the state of the device
458  */
459 static void cp210x_get_termios(struct tty_struct *tty,
460 	struct usb_serial_port *port)
461 {
462 	unsigned int baud;
463 
464 	if (tty) {
465 		cp210x_get_termios_port(tty->driver_data,
466 			&tty->termios->c_cflag, &baud);
467 		tty_encode_baud_rate(tty, baud, baud);
468 	}
469 
470 	else {
471 		unsigned int cflag;
472 		cflag = 0;
473 		cp210x_get_termios_port(port, &cflag, &baud);
474 	}
475 }
476 
477 /*
478  * cp210x_get_termios_port
479  * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
480  */
481 static void cp210x_get_termios_port(struct usb_serial_port *port,
482 	unsigned int *cflagp, unsigned int *baudp)
483 {
484 	unsigned int cflag, modem_ctl[4];
485 	unsigned int baud;
486 	unsigned int bits;
487 
488 	dbg("%s - port %d", __func__, port->number);
489 
490 	cp210x_get_config(port, CP210X_GET_BAUDRATE, &baud, 4);
491 
492 	dbg("%s - baud rate = %d", __func__, baud);
493 	*baudp = baud;
494 
495 	cflag = *cflagp;
496 
497 	cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
498 	cflag &= ~CSIZE;
499 	switch (bits & BITS_DATA_MASK) {
500 	case BITS_DATA_5:
501 		dbg("%s - data bits = 5", __func__);
502 		cflag |= CS5;
503 		break;
504 	case BITS_DATA_6:
505 		dbg("%s - data bits = 6", __func__);
506 		cflag |= CS6;
507 		break;
508 	case BITS_DATA_7:
509 		dbg("%s - data bits = 7", __func__);
510 		cflag |= CS7;
511 		break;
512 	case BITS_DATA_8:
513 		dbg("%s - data bits = 8", __func__);
514 		cflag |= CS8;
515 		break;
516 	case BITS_DATA_9:
517 		dbg("%s - data bits = 9 (not supported, using 8 data bits)",
518 								__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 	default:
525 		dbg("%s - Unknown number of data bits, using 8", __func__);
526 		cflag |= CS8;
527 		bits &= ~BITS_DATA_MASK;
528 		bits |= BITS_DATA_8;
529 		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
530 		break;
531 	}
532 
533 	switch (bits & BITS_PARITY_MASK) {
534 	case BITS_PARITY_NONE:
535 		dbg("%s - parity = NONE", __func__);
536 		cflag &= ~PARENB;
537 		break;
538 	case BITS_PARITY_ODD:
539 		dbg("%s - parity = ODD", __func__);
540 		cflag |= (PARENB|PARODD);
541 		break;
542 	case BITS_PARITY_EVEN:
543 		dbg("%s - parity = EVEN", __func__);
544 		cflag &= ~PARODD;
545 		cflag |= PARENB;
546 		break;
547 	case BITS_PARITY_MARK:
548 		dbg("%s - parity = MARK", __func__);
549 		cflag |= (PARENB|PARODD|CMSPAR);
550 		break;
551 	case BITS_PARITY_SPACE:
552 		dbg("%s - parity = SPACE", __func__);
553 		cflag &= ~PARODD;
554 		cflag |= (PARENB|CMSPAR);
555 		break;
556 	default:
557 		dbg("%s - Unknown parity mode, disabling parity", __func__);
558 		cflag &= ~PARENB;
559 		bits &= ~BITS_PARITY_MASK;
560 		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
561 		break;
562 	}
563 
564 	cflag &= ~CSTOPB;
565 	switch (bits & BITS_STOP_MASK) {
566 	case BITS_STOP_1:
567 		dbg("%s - stop bits = 1", __func__);
568 		break;
569 	case BITS_STOP_1_5:
570 		dbg("%s - stop bits = 1.5 (not supported, using 1 stop bit)",
571 								__func__);
572 		bits &= ~BITS_STOP_MASK;
573 		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
574 		break;
575 	case BITS_STOP_2:
576 		dbg("%s - stop bits = 2", __func__);
577 		cflag |= CSTOPB;
578 		break;
579 	default:
580 		dbg("%s - Unknown number of stop bits, using 1 stop bit",
581 								__func__);
582 		bits &= ~BITS_STOP_MASK;
583 		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
584 		break;
585 	}
586 
587 	cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
588 	if (modem_ctl[0] & 0x0008) {
589 		dbg("%s - flow control = CRTSCTS", __func__);
590 		cflag |= CRTSCTS;
591 	} else {
592 		dbg("%s - flow control = NONE", __func__);
593 		cflag &= ~CRTSCTS;
594 	}
595 
596 	*cflagp = cflag;
597 }
598 
599 /*
600  * CP2101 supports the following baud rates:
601  *
602  *	300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
603  *	38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
604  *
605  * CP2102 and CP2103 support the following additional rates:
606  *
607  *	4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
608  *	576000
609  *
610  * The device will map a requested rate to a supported one, but the result
611  * of requests for rates greater than 1053257 is undefined (see AN205).
612  *
613  * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
614  * respectively, with an error less than 1%. The actual rates are determined
615  * by
616  *
617  *	div = round(freq / (2 x prescale x request))
618  *	actual = freq / (2 x prescale x div)
619  *
620  * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
621  * or 1 otherwise.
622  * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
623  * otherwise.
624  */
625 static void cp210x_change_speed(struct tty_struct *tty,
626 		struct usb_serial_port *port, struct ktermios *old_termios)
627 {
628 	u32 baud;
629 
630 	baud = tty->termios->c_ospeed;
631 
632 	/* This maps the requested rate to a rate valid on cp2102 or cp2103,
633 	 * or to an arbitrary rate in [1M,2M].
634 	 *
635 	 * NOTE: B0 is not implemented.
636 	 */
637 	baud = cp210x_quantise_baudrate(baud);
638 
639 	dbg("%s - setting baud rate to %u", __func__, baud);
640 	if (cp210x_set_config(port, CP210X_SET_BAUDRATE, &baud,
641 							sizeof(baud))) {
642 		dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
643 		if (old_termios)
644 			baud = old_termios->c_ospeed;
645 		else
646 			baud = 9600;
647 	}
648 
649 	tty_encode_baud_rate(tty, baud, baud);
650 }
651 
652 static void cp210x_set_termios(struct tty_struct *tty,
653 		struct usb_serial_port *port, struct ktermios *old_termios)
654 {
655 	unsigned int cflag, old_cflag;
656 	unsigned int bits;
657 	unsigned int modem_ctl[4];
658 
659 	dbg("%s - port %d", __func__, port->number);
660 
661 	if (!tty)
662 		return;
663 
664 	cflag = tty->termios->c_cflag;
665 	old_cflag = old_termios->c_cflag;
666 
667 	if (tty->termios->c_ospeed != old_termios->c_ospeed)
668 		cp210x_change_speed(tty, port, old_termios);
669 
670 	/* If the number of data bits is to be updated */
671 	if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
672 		cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
673 		bits &= ~BITS_DATA_MASK;
674 		switch (cflag & CSIZE) {
675 		case CS5:
676 			bits |= BITS_DATA_5;
677 			dbg("%s - data bits = 5", __func__);
678 			break;
679 		case CS6:
680 			bits |= BITS_DATA_6;
681 			dbg("%s - data bits = 6", __func__);
682 			break;
683 		case CS7:
684 			bits |= BITS_DATA_7;
685 			dbg("%s - data bits = 7", __func__);
686 			break;
687 		case CS8:
688 			bits |= BITS_DATA_8;
689 			dbg("%s - data bits = 8", __func__);
690 			break;
691 		/*case CS9:
692 			bits |= BITS_DATA_9;
693 			dbg("%s - data bits = 9", __func__);
694 			break;*/
695 		default:
696 			dbg("cp210x driver does not "
697 					"support the number of bits requested,"
698 					" using 8 bit mode");
699 				bits |= BITS_DATA_8;
700 				break;
701 		}
702 		if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
703 			dbg("Number of data bits requested "
704 					"not supported by device");
705 	}
706 
707 	if ((cflag     & (PARENB|PARODD|CMSPAR)) !=
708 	    (old_cflag & (PARENB|PARODD|CMSPAR))) {
709 		cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
710 		bits &= ~BITS_PARITY_MASK;
711 		if (cflag & PARENB) {
712 			if (cflag & CMSPAR) {
713 			    if (cflag & PARODD) {
714 				    bits |= BITS_PARITY_MARK;
715 				    dbg("%s - parity = MARK", __func__);
716 			    } else {
717 				    bits |= BITS_PARITY_SPACE;
718 				    dbg("%s - parity = SPACE", __func__);
719 			    }
720 			} else {
721 			    if (cflag & PARODD) {
722 				    bits |= BITS_PARITY_ODD;
723 				    dbg("%s - parity = ODD", __func__);
724 			    } else {
725 				    bits |= BITS_PARITY_EVEN;
726 				    dbg("%s - parity = EVEN", __func__);
727 			    }
728 			}
729 		}
730 		if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
731 			dbg("Parity mode not supported by device");
732 	}
733 
734 	if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
735 		cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
736 		bits &= ~BITS_STOP_MASK;
737 		if (cflag & CSTOPB) {
738 			bits |= BITS_STOP_2;
739 			dbg("%s - stop bits = 2", __func__);
740 		} else {
741 			bits |= BITS_STOP_1;
742 			dbg("%s - stop bits = 1", __func__);
743 		}
744 		if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
745 			dbg("Number of stop bits requested "
746 					"not supported by device");
747 	}
748 
749 	if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
750 		cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
751 		dbg("%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
752 				__func__, modem_ctl[0], modem_ctl[1],
753 				modem_ctl[2], modem_ctl[3]);
754 
755 		if (cflag & CRTSCTS) {
756 			modem_ctl[0] &= ~0x7B;
757 			modem_ctl[0] |= 0x09;
758 			modem_ctl[1] = 0x80;
759 			dbg("%s - flow control = CRTSCTS", __func__);
760 		} else {
761 			modem_ctl[0] &= ~0x7B;
762 			modem_ctl[0] |= 0x01;
763 			modem_ctl[1] |= 0x40;
764 			dbg("%s - flow control = NONE", __func__);
765 		}
766 
767 		dbg("%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
768 				__func__, modem_ctl[0], modem_ctl[1],
769 				modem_ctl[2], modem_ctl[3]);
770 		cp210x_set_config(port, CP210X_SET_FLOW, modem_ctl, 16);
771 	}
772 
773 }
774 
775 static int cp210x_tiocmset (struct tty_struct *tty,
776 		unsigned int set, unsigned int clear)
777 {
778 	struct usb_serial_port *port = tty->driver_data;
779 	return cp210x_tiocmset_port(port, set, clear);
780 }
781 
782 static int cp210x_tiocmset_port(struct usb_serial_port *port,
783 		unsigned int set, unsigned int clear)
784 {
785 	unsigned int control = 0;
786 
787 	dbg("%s - port %d", __func__, port->number);
788 
789 	if (set & TIOCM_RTS) {
790 		control |= CONTROL_RTS;
791 		control |= CONTROL_WRITE_RTS;
792 	}
793 	if (set & TIOCM_DTR) {
794 		control |= CONTROL_DTR;
795 		control |= CONTROL_WRITE_DTR;
796 	}
797 	if (clear & TIOCM_RTS) {
798 		control &= ~CONTROL_RTS;
799 		control |= CONTROL_WRITE_RTS;
800 	}
801 	if (clear & TIOCM_DTR) {
802 		control &= ~CONTROL_DTR;
803 		control |= CONTROL_WRITE_DTR;
804 	}
805 
806 	dbg("%s - control = 0x%.4x", __func__, control);
807 
808 	return cp210x_set_config(port, CP210X_SET_MHS, &control, 2);
809 }
810 
811 static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
812 {
813 	if (on)
814 		cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
815 	else
816 		cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
817 }
818 
819 static int cp210x_tiocmget (struct tty_struct *tty)
820 {
821 	struct usb_serial_port *port = tty->driver_data;
822 	unsigned int control;
823 	int result;
824 
825 	dbg("%s - port %d", __func__, port->number);
826 
827 	cp210x_get_config(port, CP210X_GET_MDMSTS, &control, 1);
828 
829 	result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
830 		|((control & CONTROL_RTS) ? TIOCM_RTS : 0)
831 		|((control & CONTROL_CTS) ? TIOCM_CTS : 0)
832 		|((control & CONTROL_DSR) ? TIOCM_DSR : 0)
833 		|((control & CONTROL_RING)? TIOCM_RI  : 0)
834 		|((control & CONTROL_DCD) ? TIOCM_CD  : 0);
835 
836 	dbg("%s - control = 0x%.2x", __func__, control);
837 
838 	return result;
839 }
840 
841 static void cp210x_break_ctl (struct tty_struct *tty, int break_state)
842 {
843 	struct usb_serial_port *port = tty->driver_data;
844 	unsigned int state;
845 
846 	dbg("%s - port %d", __func__, port->number);
847 	if (break_state == 0)
848 		state = BREAK_OFF;
849 	else
850 		state = BREAK_ON;
851 	dbg("%s - turning break %s", __func__,
852 			state == BREAK_OFF ? "off" : "on");
853 	cp210x_set_config(port, CP210X_SET_BREAK, &state, 2);
854 }
855 
856 static int cp210x_startup(struct usb_serial *serial)
857 {
858 	struct cp210x_port_private *port_priv;
859 	int i;
860 
861 	/* cp210x buffers behave strangely unless device is reset */
862 	usb_reset_device(serial->dev);
863 
864 	for (i = 0; i < serial->num_ports; i++) {
865 		port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
866 		if (!port_priv)
867 			return -ENOMEM;
868 
869 		memset(port_priv, 0x00, sizeof(*port_priv));
870 		port_priv->bInterfaceNumber =
871 		    serial->interface->cur_altsetting->desc.bInterfaceNumber;
872 
873 		usb_set_serial_port_data(serial->port[i], port_priv);
874 	}
875 
876 	return 0;
877 }
878 
879 static void cp210x_release(struct usb_serial *serial)
880 {
881 	struct cp210x_port_private *port_priv;
882 	int i;
883 
884 	for (i = 0; i < serial->num_ports; i++) {
885 		port_priv = usb_get_serial_port_data(serial->port[i]);
886 		kfree(port_priv);
887 		usb_set_serial_port_data(serial->port[i], NULL);
888 	}
889 }
890 
891 module_usb_serial_driver(cp210x_driver, serial_drivers);
892 
893 MODULE_DESCRIPTION(DRIVER_DESC);
894 MODULE_VERSION(DRIVER_VERSION);
895 MODULE_LICENSE("GPL");
896 
897 module_param(debug, bool, S_IRUGO | S_IWUSR);
898 MODULE_PARM_DESC(debug, "Enable verbose debugging messages");
899