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