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