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