xref: /openbmc/linux/drivers/usb/serial/cp210x.c (revision fee4b700)
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(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
57 	{ USB_DEVICE(0x08FD, 0x000A) }, /* Digianswer A/S , ZigBee/802.15.4 MAC Device */
58 	{ USB_DEVICE(0x0BED, 0x1100) }, /* MEI (TM) Cashflow-SC Bill/Voucher Acceptor */
59 	{ USB_DEVICE(0x0BED, 0x1101) }, /* MEI series 2000 Combo Acceptor */
60 	{ USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
61 	{ USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
62 	{ USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */
63 	{ USB_DEVICE(0x0FDE, 0xCA05) }, /* OWL Wireless Electricity Monitor CM-160 */
64 	{ USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
65 	{ USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
66 	{ USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
67 	{ USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */
68 	{ USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */
69 	{ USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */
70 	{ USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
71 	{ USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
72 	{ USB_DEVICE(0x10C4, 0x8044) }, /* Cygnal Debug Adapter */
73 	{ USB_DEVICE(0x10C4, 0x804E) }, /* Software Bisque Paramount ME build-in converter */
74 	{ USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
75 	{ USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */
76 	{ USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
77 	{ USB_DEVICE(0x10C4, 0x806F) }, /* IMS USB to RS422 Converter Cable */
78 	{ USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
79 	{ USB_DEVICE(0x10C4, 0x80C4) }, /* Cygnal Integrated Products, Inc., Optris infrared thermometer */
80 	{ USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
81 	{ USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
82 	{ USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
83 	{ USB_DEVICE(0x10C4, 0x8115) }, /* Arygon NFC/Mifare Reader */
84 	{ USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
85 	{ USB_DEVICE(0x10C4, 0x813F) }, /* Tams Master Easy Control */
86 	{ USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
87 	{ USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
88 	{ USB_DEVICE(0x2405, 0x0003) }, /* West Mountain Radio RIGblaster Advantage */
89 	{ USB_DEVICE(0x10C4, 0x8156) }, /* B&G H3000 link cable */
90 	{ USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
91 	{ USB_DEVICE(0x10C4, 0x815F) }, /* Timewave HamLinkUSB */
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, 0x85F8) }, /* Virtenio Preon32 */
119 	{ USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
120 	{ USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
121 	{ USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
122 	{ USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
123 	{ USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
124 	{ USB_DEVICE(0x10C4, 0xEA80) }, /* Silicon Labs factory default */
125 	{ USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
126 	{ USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
127 	{ USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
128 	{ USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
129 	{ USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
130 	{ USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
131 	{ USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
132 	{ USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
133 	{ USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
134 	{ USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
135 	{ USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
136 	{ USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
137 	{ USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
138 	{ USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
139 	{ USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
140 	{ USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
141 	{ USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
142 	{ USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
143 	{ USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
144 	{ USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
145 	{ USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
146 	{ USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
147 	{ USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
148 	{ USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
149 	{ USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
150 	{ USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
151 	{ USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
152 	{ USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
153 	{ USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
154 	{ USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
155 	{ USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
156 	{ USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
157 	{ USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
158 	{ USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
159 	{ USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
160 	{ USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
161 	{ USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
162 	{ USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
163 	{ USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
164 	{ USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
165 	{ USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
166 	{ USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
167 	{ USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
168 	{ USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
169 	{ USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
170 	{ USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
171 	{ USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
172 	{ USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
173 	{ USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
174 	{ USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
175 	{ USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
176 	{ USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
177 	{ } /* Terminating Entry */
178 };
179 
180 MODULE_DEVICE_TABLE(usb, id_table);
181 
182 struct cp210x_serial_private {
183 	__u8			bInterfaceNumber;
184 };
185 
186 static struct usb_serial_driver cp210x_device = {
187 	.driver = {
188 		.owner =	THIS_MODULE,
189 		.name =		"cp210x",
190 	},
191 	.id_table		= id_table,
192 	.num_ports		= 1,
193 	.bulk_in_size		= 256,
194 	.bulk_out_size		= 256,
195 	.open			= cp210x_open,
196 	.close			= cp210x_close,
197 	.break_ctl		= cp210x_break_ctl,
198 	.set_termios		= cp210x_set_termios,
199 	.tiocmget		= cp210x_tiocmget,
200 	.tiocmset		= cp210x_tiocmset,
201 	.attach			= cp210x_startup,
202 	.release		= cp210x_release,
203 	.dtr_rts		= cp210x_dtr_rts
204 };
205 
206 static struct usb_serial_driver * const serial_drivers[] = {
207 	&cp210x_device, NULL
208 };
209 
210 /* Config request types */
211 #define REQTYPE_HOST_TO_INTERFACE	0x41
212 #define REQTYPE_INTERFACE_TO_HOST	0xc1
213 #define REQTYPE_HOST_TO_DEVICE	0x40
214 #define REQTYPE_DEVICE_TO_HOST	0xc0
215 
216 /* Config request codes */
217 #define CP210X_IFC_ENABLE	0x00
218 #define CP210X_SET_BAUDDIV	0x01
219 #define CP210X_GET_BAUDDIV	0x02
220 #define CP210X_SET_LINE_CTL	0x03
221 #define CP210X_GET_LINE_CTL	0x04
222 #define CP210X_SET_BREAK	0x05
223 #define CP210X_IMM_CHAR		0x06
224 #define CP210X_SET_MHS		0x07
225 #define CP210X_GET_MDMSTS	0x08
226 #define CP210X_SET_XON		0x09
227 #define CP210X_SET_XOFF		0x0A
228 #define CP210X_SET_EVENTMASK	0x0B
229 #define CP210X_GET_EVENTMASK	0x0C
230 #define CP210X_SET_CHAR		0x0D
231 #define CP210X_GET_CHARS	0x0E
232 #define CP210X_GET_PROPS	0x0F
233 #define CP210X_GET_COMM_STATUS	0x10
234 #define CP210X_RESET		0x11
235 #define CP210X_PURGE		0x12
236 #define CP210X_SET_FLOW		0x13
237 #define CP210X_GET_FLOW		0x14
238 #define CP210X_EMBED_EVENTS	0x15
239 #define CP210X_GET_EVENTSTATE	0x16
240 #define CP210X_SET_CHARS	0x19
241 #define CP210X_GET_BAUDRATE	0x1D
242 #define CP210X_SET_BAUDRATE	0x1E
243 
244 /* CP210X_IFC_ENABLE */
245 #define UART_ENABLE		0x0001
246 #define UART_DISABLE		0x0000
247 
248 /* CP210X_(SET|GET)_BAUDDIV */
249 #define BAUD_RATE_GEN_FREQ	0x384000
250 
251 /* CP210X_(SET|GET)_LINE_CTL */
252 #define BITS_DATA_MASK		0X0f00
253 #define BITS_DATA_5		0X0500
254 #define BITS_DATA_6		0X0600
255 #define BITS_DATA_7		0X0700
256 #define BITS_DATA_8		0X0800
257 #define BITS_DATA_9		0X0900
258 
259 #define BITS_PARITY_MASK	0x00f0
260 #define BITS_PARITY_NONE	0x0000
261 #define BITS_PARITY_ODD		0x0010
262 #define BITS_PARITY_EVEN	0x0020
263 #define BITS_PARITY_MARK	0x0030
264 #define BITS_PARITY_SPACE	0x0040
265 
266 #define BITS_STOP_MASK		0x000f
267 #define BITS_STOP_1		0x0000
268 #define BITS_STOP_1_5		0x0001
269 #define BITS_STOP_2		0x0002
270 
271 /* CP210X_SET_BREAK */
272 #define BREAK_ON		0x0001
273 #define BREAK_OFF		0x0000
274 
275 /* CP210X_(SET_MHS|GET_MDMSTS) */
276 #define CONTROL_DTR		0x0001
277 #define CONTROL_RTS		0x0002
278 #define CONTROL_CTS		0x0010
279 #define CONTROL_DSR		0x0020
280 #define CONTROL_RING		0x0040
281 #define CONTROL_DCD		0x0080
282 #define CONTROL_WRITE_DTR	0x0100
283 #define CONTROL_WRITE_RTS	0x0200
284 
285 /*
286  * cp210x_get_config
287  * Reads from the CP210x configuration registers
288  * 'size' is specified in bytes.
289  * 'data' is a pointer to a pre-allocated array of integers large
290  * enough to hold 'size' bytes (with 4 bytes to each integer)
291  */
292 static int cp210x_get_config(struct usb_serial_port *port, u8 request,
293 		unsigned int *data, int size)
294 {
295 	struct usb_serial *serial = port->serial;
296 	struct cp210x_serial_private *spriv = usb_get_serial_data(serial);
297 	__le32 *buf;
298 	int result, i, length;
299 
300 	/* Number of integers required to contain the array */
301 	length = (((size - 1) | 3) + 1) / 4;
302 
303 	buf = kcalloc(length, sizeof(__le32), GFP_KERNEL);
304 	if (!buf) {
305 		dev_err(&port->dev, "%s - out of memory.\n", __func__);
306 		return -ENOMEM;
307 	}
308 
309 	/* Issue the request, attempting to read 'size' bytes */
310 	result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
311 				request, REQTYPE_INTERFACE_TO_HOST, 0x0000,
312 				spriv->bInterfaceNumber, buf, size,
313 				USB_CTRL_GET_TIMEOUT);
314 
315 	/* Convert data into an array of integers */
316 	for (i = 0; i < length; i++)
317 		data[i] = le32_to_cpu(buf[i]);
318 
319 	kfree(buf);
320 
321 	if (result != size) {
322 		dev_dbg(&port->dev, "%s - Unable to send config request, request=0x%x size=%d result=%d\n",
323 			__func__, request, size, result);
324 		if (result > 0)
325 			result = -EPROTO;
326 
327 		return result;
328 	}
329 
330 	return 0;
331 }
332 
333 /*
334  * cp210x_set_config
335  * Writes to the CP210x configuration registers
336  * Values less than 16 bits wide are sent directly
337  * 'size' is specified in bytes.
338  */
339 static int cp210x_set_config(struct usb_serial_port *port, u8 request,
340 		unsigned int *data, int size)
341 {
342 	struct usb_serial *serial = port->serial;
343 	struct cp210x_serial_private *spriv = usb_get_serial_data(serial);
344 	__le32 *buf;
345 	int result, i, length;
346 
347 	/* Number of integers required to contain the array */
348 	length = (((size - 1) | 3) + 1) / 4;
349 
350 	buf = kmalloc(length * sizeof(__le32), GFP_KERNEL);
351 	if (!buf) {
352 		dev_err(&port->dev, "%s - out of memory.\n", __func__);
353 		return -ENOMEM;
354 	}
355 
356 	/* Array of integers into bytes */
357 	for (i = 0; i < length; i++)
358 		buf[i] = cpu_to_le32(data[i]);
359 
360 	if (size > 2) {
361 		result = usb_control_msg(serial->dev,
362 				usb_sndctrlpipe(serial->dev, 0),
363 				request, REQTYPE_HOST_TO_INTERFACE, 0x0000,
364 				spriv->bInterfaceNumber, buf, size,
365 				USB_CTRL_SET_TIMEOUT);
366 	} else {
367 		result = usb_control_msg(serial->dev,
368 				usb_sndctrlpipe(serial->dev, 0),
369 				request, REQTYPE_HOST_TO_INTERFACE, data[0],
370 				spriv->bInterfaceNumber, NULL, 0,
371 				USB_CTRL_SET_TIMEOUT);
372 	}
373 
374 	kfree(buf);
375 
376 	if ((size > 2 && result != size) || result < 0) {
377 		dev_dbg(&port->dev, "%s - Unable to send request, request=0x%x size=%d result=%d\n",
378 			__func__, request, size, result);
379 		if (result > 0)
380 			result = -EPROTO;
381 
382 		return result;
383 	}
384 
385 	return 0;
386 }
387 
388 /*
389  * cp210x_set_config_single
390  * Convenience function for calling cp210x_set_config on single data values
391  * without requiring an integer pointer
392  */
393 static inline int cp210x_set_config_single(struct usb_serial_port *port,
394 		u8 request, unsigned int data)
395 {
396 	return cp210x_set_config(port, request, &data, 2);
397 }
398 
399 /*
400  * cp210x_quantise_baudrate
401  * Quantises the baud rate as per AN205 Table 1
402  */
403 static unsigned int cp210x_quantise_baudrate(unsigned int baud)
404 {
405 	if (baud <= 300)
406 		baud = 300;
407 	else if (baud <= 600)      baud = 600;
408 	else if (baud <= 1200)     baud = 1200;
409 	else if (baud <= 1800)     baud = 1800;
410 	else if (baud <= 2400)     baud = 2400;
411 	else if (baud <= 4000)     baud = 4000;
412 	else if (baud <= 4803)     baud = 4800;
413 	else if (baud <= 7207)     baud = 7200;
414 	else if (baud <= 9612)     baud = 9600;
415 	else if (baud <= 14428)    baud = 14400;
416 	else if (baud <= 16062)    baud = 16000;
417 	else if (baud <= 19250)    baud = 19200;
418 	else if (baud <= 28912)    baud = 28800;
419 	else if (baud <= 38601)    baud = 38400;
420 	else if (baud <= 51558)    baud = 51200;
421 	else if (baud <= 56280)    baud = 56000;
422 	else if (baud <= 58053)    baud = 57600;
423 	else if (baud <= 64111)    baud = 64000;
424 	else if (baud <= 77608)    baud = 76800;
425 	else if (baud <= 117028)   baud = 115200;
426 	else if (baud <= 129347)   baud = 128000;
427 	else if (baud <= 156868)   baud = 153600;
428 	else if (baud <= 237832)   baud = 230400;
429 	else if (baud <= 254234)   baud = 250000;
430 	else if (baud <= 273066)   baud = 256000;
431 	else if (baud <= 491520)   baud = 460800;
432 	else if (baud <= 567138)   baud = 500000;
433 	else if (baud <= 670254)   baud = 576000;
434 	else if (baud < 1000000)
435 		baud = 921600;
436 	else if (baud > 2000000)
437 		baud = 2000000;
438 	return baud;
439 }
440 
441 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
442 {
443 	int result;
444 
445 	result = cp210x_set_config_single(port, CP210X_IFC_ENABLE,
446 								UART_ENABLE);
447 	if (result) {
448 		dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
449 		return result;
450 	}
451 
452 	/* Configure the termios structure */
453 	cp210x_get_termios(tty, port);
454 
455 	/* The baud rate must be initialised on cp2104 */
456 	if (tty)
457 		cp210x_change_speed(tty, port, NULL);
458 
459 	return usb_serial_generic_open(tty, port);
460 }
461 
462 static void cp210x_close(struct usb_serial_port *port)
463 {
464 	usb_serial_generic_close(port);
465 	cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_DISABLE);
466 }
467 
468 /*
469  * cp210x_get_termios
470  * Reads the baud rate, data bits, parity, stop bits and flow control mode
471  * from the device, corrects any unsupported values, and configures the
472  * termios structure to reflect the state of the device
473  */
474 static void cp210x_get_termios(struct tty_struct *tty,
475 	struct usb_serial_port *port)
476 {
477 	unsigned int baud;
478 
479 	if (tty) {
480 		cp210x_get_termios_port(tty->driver_data,
481 			&tty->termios.c_cflag, &baud);
482 		tty_encode_baud_rate(tty, baud, baud);
483 	} else {
484 		unsigned int cflag;
485 		cflag = 0;
486 		cp210x_get_termios_port(port, &cflag, &baud);
487 	}
488 }
489 
490 /*
491  * cp210x_get_termios_port
492  * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
493  */
494 static void cp210x_get_termios_port(struct usb_serial_port *port,
495 	unsigned int *cflagp, unsigned int *baudp)
496 {
497 	struct device *dev = &port->dev;
498 	unsigned int cflag, modem_ctl[4];
499 	unsigned int baud;
500 	unsigned int bits;
501 
502 	cp210x_get_config(port, CP210X_GET_BAUDRATE, &baud, 4);
503 
504 	dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud);
505 	*baudp = baud;
506 
507 	cflag = *cflagp;
508 
509 	cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
510 	cflag &= ~CSIZE;
511 	switch (bits & BITS_DATA_MASK) {
512 	case BITS_DATA_5:
513 		dev_dbg(dev, "%s - data bits = 5\n", __func__);
514 		cflag |= CS5;
515 		break;
516 	case BITS_DATA_6:
517 		dev_dbg(dev, "%s - data bits = 6\n", __func__);
518 		cflag |= CS6;
519 		break;
520 	case BITS_DATA_7:
521 		dev_dbg(dev, "%s - data bits = 7\n", __func__);
522 		cflag |= CS7;
523 		break;
524 	case BITS_DATA_8:
525 		dev_dbg(dev, "%s - data bits = 8\n", __func__);
526 		cflag |= CS8;
527 		break;
528 	case BITS_DATA_9:
529 		dev_dbg(dev, "%s - data bits = 9 (not supported, using 8 data bits)\n", __func__);
530 		cflag |= CS8;
531 		bits &= ~BITS_DATA_MASK;
532 		bits |= BITS_DATA_8;
533 		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
534 		break;
535 	default:
536 		dev_dbg(dev, "%s - Unknown number of data bits, using 8\n", __func__);
537 		cflag |= CS8;
538 		bits &= ~BITS_DATA_MASK;
539 		bits |= BITS_DATA_8;
540 		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
541 		break;
542 	}
543 
544 	switch (bits & BITS_PARITY_MASK) {
545 	case BITS_PARITY_NONE:
546 		dev_dbg(dev, "%s - parity = NONE\n", __func__);
547 		cflag &= ~PARENB;
548 		break;
549 	case BITS_PARITY_ODD:
550 		dev_dbg(dev, "%s - parity = ODD\n", __func__);
551 		cflag |= (PARENB|PARODD);
552 		break;
553 	case BITS_PARITY_EVEN:
554 		dev_dbg(dev, "%s - parity = EVEN\n", __func__);
555 		cflag &= ~PARODD;
556 		cflag |= PARENB;
557 		break;
558 	case BITS_PARITY_MARK:
559 		dev_dbg(dev, "%s - parity = MARK\n", __func__);
560 		cflag |= (PARENB|PARODD|CMSPAR);
561 		break;
562 	case BITS_PARITY_SPACE:
563 		dev_dbg(dev, "%s - parity = SPACE\n", __func__);
564 		cflag &= ~PARODD;
565 		cflag |= (PARENB|CMSPAR);
566 		break;
567 	default:
568 		dev_dbg(dev, "%s - Unknown parity mode, disabling parity\n", __func__);
569 		cflag &= ~PARENB;
570 		bits &= ~BITS_PARITY_MASK;
571 		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
572 		break;
573 	}
574 
575 	cflag &= ~CSTOPB;
576 	switch (bits & BITS_STOP_MASK) {
577 	case BITS_STOP_1:
578 		dev_dbg(dev, "%s - stop bits = 1\n", __func__);
579 		break;
580 	case BITS_STOP_1_5:
581 		dev_dbg(dev, "%s - stop bits = 1.5 (not supported, using 1 stop bit)\n", __func__);
582 		bits &= ~BITS_STOP_MASK;
583 		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
584 		break;
585 	case BITS_STOP_2:
586 		dev_dbg(dev, "%s - stop bits = 2\n", __func__);
587 		cflag |= CSTOPB;
588 		break;
589 	default:
590 		dev_dbg(dev, "%s - Unknown number of stop bits, using 1 stop bit\n", __func__);
591 		bits &= ~BITS_STOP_MASK;
592 		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
593 		break;
594 	}
595 
596 	cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
597 	if (modem_ctl[0] & 0x0008) {
598 		dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
599 		cflag |= CRTSCTS;
600 	} else {
601 		dev_dbg(dev, "%s - flow control = NONE\n", __func__);
602 		cflag &= ~CRTSCTS;
603 	}
604 
605 	*cflagp = cflag;
606 }
607 
608 /*
609  * CP2101 supports the following baud rates:
610  *
611  *	300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
612  *	38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
613  *
614  * CP2102 and CP2103 support the following additional rates:
615  *
616  *	4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
617  *	576000
618  *
619  * The device will map a requested rate to a supported one, but the result
620  * of requests for rates greater than 1053257 is undefined (see AN205).
621  *
622  * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
623  * respectively, with an error less than 1%. The actual rates are determined
624  * by
625  *
626  *	div = round(freq / (2 x prescale x request))
627  *	actual = freq / (2 x prescale x div)
628  *
629  * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
630  * or 1 otherwise.
631  * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
632  * otherwise.
633  */
634 static void cp210x_change_speed(struct tty_struct *tty,
635 		struct usb_serial_port *port, struct ktermios *old_termios)
636 {
637 	u32 baud;
638 
639 	baud = tty->termios.c_ospeed;
640 
641 	/* This maps the requested rate to a rate valid on cp2102 or cp2103,
642 	 * or to an arbitrary rate in [1M,2M].
643 	 *
644 	 * NOTE: B0 is not implemented.
645 	 */
646 	baud = cp210x_quantise_baudrate(baud);
647 
648 	dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
649 	if (cp210x_set_config(port, CP210X_SET_BAUDRATE, &baud,
650 							sizeof(baud))) {
651 		dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
652 		if (old_termios)
653 			baud = old_termios->c_ospeed;
654 		else
655 			baud = 9600;
656 	}
657 
658 	tty_encode_baud_rate(tty, baud, baud);
659 }
660 
661 static void cp210x_set_termios(struct tty_struct *tty,
662 		struct usb_serial_port *port, struct ktermios *old_termios)
663 {
664 	struct device *dev = &port->dev;
665 	unsigned int cflag, old_cflag;
666 	unsigned int bits;
667 	unsigned int modem_ctl[4];
668 
669 	if (!tty)
670 		return;
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 	/* cp210x buffers behave strangely unless device is reset */
861 	usb_reset_device(serial->dev);
862 
863 	spriv = kzalloc(sizeof(*spriv), GFP_KERNEL);
864 	if (!spriv)
865 		return -ENOMEM;
866 
867 	cur_altsetting = serial->interface->cur_altsetting;
868 	spriv->bInterfaceNumber = cur_altsetting->desc.bInterfaceNumber;
869 
870 	usb_set_serial_data(serial, spriv);
871 
872 	return 0;
873 }
874 
875 static void cp210x_release(struct usb_serial *serial)
876 {
877 	struct cp210x_serial_private *spriv;
878 
879 	spriv = usb_get_serial_data(serial);
880 	kfree(spriv);
881 }
882 
883 module_usb_serial_driver(serial_drivers, id_table);
884 
885 MODULE_DESCRIPTION(DRIVER_DESC);
886 MODULE_LICENSE("GPL");
887