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