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