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