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