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