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