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