GNU Linux-libre 4.9.333-gnu1
[releases.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 #define DRIVER_DESC "Silicon Labs CP210x RS232 serial adaptor driver"
28
29 /*
30  * Function Prototypes
31  */
32 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *);
33 static void cp210x_close(struct usb_serial_port *);
34 static void cp210x_get_termios(struct tty_struct *, struct usb_serial_port *);
35 static void cp210x_get_termios_port(struct usb_serial_port *port,
36         tcflag_t *cflagp, unsigned int *baudp);
37 static void cp210x_change_speed(struct tty_struct *, struct usb_serial_port *,
38                                                         struct ktermios *);
39 static void cp210x_set_termios(struct tty_struct *, struct usb_serial_port *,
40                                                         struct ktermios*);
41 static bool cp210x_tx_empty(struct usb_serial_port *port);
42 static int cp210x_tiocmget(struct tty_struct *);
43 static int cp210x_tiocmset(struct tty_struct *, unsigned int, unsigned int);
44 static int cp210x_tiocmset_port(struct usb_serial_port *port,
45                 unsigned int, unsigned int);
46 static void cp210x_break_ctl(struct tty_struct *, int);
47 static int cp210x_port_probe(struct usb_serial_port *);
48 static int cp210x_port_remove(struct usb_serial_port *);
49 static void cp210x_dtr_rts(struct usb_serial_port *p, int on);
50
51 static const struct usb_device_id id_table[] = {
52         { USB_DEVICE(0x0404, 0x034C) }, /* NCR Retail IO Box */
53         { USB_DEVICE(0x045B, 0x0053) }, /* Renesas RX610 RX-Stick */
54         { USB_DEVICE(0x0471, 0x066A) }, /* AKTAKOM ACE-1001 cable */
55         { USB_DEVICE(0x0489, 0xE000) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
56         { USB_DEVICE(0x0489, 0xE003) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
57         { USB_DEVICE(0x0745, 0x1000) }, /* CipherLab USB CCD Barcode Scanner 1000 */
58         { USB_DEVICE(0x0846, 0x1100) }, /* NetGear Managed Switch M4100 series, M5300 series, M7100 series */
59         { USB_DEVICE(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
60         { USB_DEVICE(0x08FD, 0x000A) }, /* Digianswer A/S , ZigBee/802.15.4 MAC Device */
61         { USB_DEVICE(0x0908, 0x01FF) }, /* Siemens RUGGEDCOM USB Serial Console */
62         { USB_DEVICE(0x0988, 0x0578) }, /* Teraoka AD2000 */
63         { USB_DEVICE(0x0B00, 0x3070) }, /* Ingenico 3070 */
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(0x0FDE, 0xCA05) }, /* OWL Wireless Electricity Monitor CM-160 */
70         { USB_DEVICE(0x106F, 0x0003) }, /* CPI / Money Controls Bulk Coin Recycler */
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, 0x8056) }, /* Lorenz Messtechnik devices */
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, 0x817C) }, /* CESINEL MEDCAL N Power Quality Monitor */
101         { USB_DEVICE(0x10C4, 0x817D) }, /* CESINEL MEDCAL NT Power Quality Monitor */
102         { USB_DEVICE(0x10C4, 0x817E) }, /* CESINEL MEDCAL S Power Quality Monitor */
103         { USB_DEVICE(0x10C4, 0x818B) }, /* AVIT Research USB to TTL */
104         { USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
105         { USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
106         { USB_DEVICE(0x10C4, 0x81A9) }, /* Multiplex RC Interface */
107         { USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
108         { USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */
109         { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
110         { USB_DEVICE(0x10C4, 0x81D7) }, /* IAI Corp. RCB-CV-USB USB to RS485 Adaptor */
111         { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
112         { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
113         { USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
114         { USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
115         { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
116         { USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
117         { USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
118         { USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */
119         { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
120         { USB_DEVICE(0x10C4, 0x82EF) }, /* CESINEL FALCO 6105 AC Power Supply */
121         { USB_DEVICE(0x10C4, 0x82F1) }, /* CESINEL MEDCAL EFD Earth Fault Detector */
122         { USB_DEVICE(0x10C4, 0x82F2) }, /* CESINEL MEDCAL ST Network Analyzer */
123         { USB_DEVICE(0x10C4, 0x82F4) }, /* Starizona MicroTouch */
124         { USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
125         { USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
126         { USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
127         { USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
128         { USB_DEVICE(0x10C4, 0x83AA) }, /* Mark-10 Digital Force Gauge */
129         { USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
130         { USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
131         { USB_DEVICE(0x10C4, 0x8414) }, /* Decagon USB Cable Adapter */
132         { USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
133         { USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
134         { USB_DEVICE(0x10C4, 0x8470) }, /* Juniper Networks BX Series System Console */
135         { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
136         { USB_DEVICE(0x10C4, 0x84B6) }, /* Starizona Hyperion */
137         { USB_DEVICE(0x10C4, 0x851E) }, /* CESINEL MEDCAL PT Network Analyzer */
138         { USB_DEVICE(0x10C4, 0x85A7) }, /* LifeScan OneTouch Verio IQ */
139         { USB_DEVICE(0x10C4, 0x85B8) }, /* CESINEL ReCon T Energy Logger */
140         { USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
141         { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
142         { USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
143         { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
144         { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
145         { USB_DEVICE(0x10C4, 0x8856) }, /* CEL EM357 ZigBee USB Stick - LR */
146         { USB_DEVICE(0x10C4, 0x8857) }, /* CEL EM357 ZigBee USB Stick */
147         { USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
148         { USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
149         { USB_DEVICE(0x10C4, 0x88D8) }, /* Acuity Brands nLight Air Adapter */
150         { USB_DEVICE(0x10C4, 0x88FB) }, /* CESINEL MEDCAL STII Network Analyzer */
151         { USB_DEVICE(0x10C4, 0x8938) }, /* CESINEL MEDCAL S II Network Analyzer */
152         { USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
153         { USB_DEVICE(0x10C4, 0x8962) }, /* Brim Brothers charging dock */
154         { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit Device */
155         { USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
156         { USB_DEVICE(0x10C4, 0x89A4) }, /* CESINEL FTBC Flexible Thyristor Bridge Controller */
157         { USB_DEVICE(0x10C4, 0x89FB) }, /* Qivicon ZigBee USB Radio Stick */
158         { USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
159         { USB_DEVICE(0x10C4, 0x8A5B) }, /* CEL EM3588 ZigBee USB Stick */
160         { USB_DEVICE(0x10C4, 0x8A5E) }, /* CEL EM3588 ZigBee USB Stick Long Range */
161         { USB_DEVICE(0x10C4, 0x8B34) }, /* Qivicon ZigBee USB Radio Stick */
162         { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
163         { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
164         { USB_DEVICE(0x10C4, 0xEA63) }, /* Silicon Labs Windows Update (CP2101-4/CP2102N) */
165         { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
166         { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
167         { USB_DEVICE(0x10C4, 0xEA7A) }, /* Silicon Labs Windows Update (CP2105) */
168         { USB_DEVICE(0x10C4, 0xEA7B) }, /* Silicon Labs Windows Update (CP2108) */
169         { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
170         { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
171         { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
172         { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
173         { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
174         { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
175         { USB_DEVICE(0x12B8, 0xEC60) }, /* Link G4 ECU */
176         { USB_DEVICE(0x12B8, 0xEC62) }, /* Link G4+ ECU */
177         { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
178         { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
179         { USB_DEVICE(0x155A, 0x1006) }, /* ELDAT Easywave RX09 */
180         { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
181         { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
182         { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
183         { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
184         { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
185         { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
186         { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
187         { USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
188         { USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
189         { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
190         { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
191         { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
192         { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
193         { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
194         { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
195         { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
196         { USB_DEVICE(0x17A8, 0x0101) }, /* Kamstrup 868 MHz wM-Bus C-Mode Meter Reader (Int Ant) */
197         { USB_DEVICE(0x17A8, 0x0102) }, /* Kamstrup 868 MHz wM-Bus C-Mode Meter Reader (Ext Ant) */
198         { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
199         { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
200         { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
201         { USB_DEVICE(0x18EF, 0xE025) }, /* ELV Marble Sound Board 1 */
202         { USB_DEVICE(0x18EF, 0xE030) }, /* ELV ALC 8xxx Battery Charger */
203         { USB_DEVICE(0x18EF, 0xE032) }, /* ELV TFD500 Data Logger */
204         { USB_DEVICE(0x1901, 0x0190) }, /* GE B850 CP2105 Recorder interface */
205         { USB_DEVICE(0x1901, 0x0193) }, /* GE B650 CP2104 PMC interface */
206         { USB_DEVICE(0x1901, 0x0194) }, /* GE Healthcare Remote Alarm Box */
207         { USB_DEVICE(0x1901, 0x0195) }, /* GE B850/B650/B450 CP2104 DP UART interface */
208         { USB_DEVICE(0x1901, 0x0196) }, /* GE B850 CP2105 DP UART interface */
209         { USB_DEVICE(0x1901, 0x0197) }, /* GE CS1000 M.2 Key E serial interface */
210         { USB_DEVICE(0x1901, 0x0198) }, /* GE CS1000 Display serial interface */
211         { USB_DEVICE(0x199B, 0xBA30) }, /* LORD WSDA-200-USB */
212         { USB_DEVICE(0x19CF, 0x3000) }, /* Parrot NMEA GPS Flight Recorder */
213         { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
214         { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
215         { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
216         { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
217         { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
218         { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
219         { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
220         { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
221         { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
222         { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
223         { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
224         { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
225         { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
226         { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
227         { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
228         { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
229         { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
230         { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
231         { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
232         { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
233         { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
234         { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
235         { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
236         { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
237         { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
238         { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
239         { USB_DEVICE(0x2184, 0x0030) }, /* GW Instek GDM-834x Digital Multimeter */
240         { USB_DEVICE(0x2626, 0xEA60) }, /* Aruba Networks 7xxx USB Serial Console */
241         { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
242         { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
243         { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
244         { USB_DEVICE(0x3923, 0x7A0B) }, /* National Instruments USB Serial Console */
245         { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
246         { } /* Terminating Entry */
247 };
248
249 MODULE_DEVICE_TABLE(usb, id_table);
250
251 struct cp210x_port_private {
252         __u8                    bInterfaceNumber;
253         bool                    has_swapped_line_ctl;
254 };
255
256 static struct usb_serial_driver cp210x_device = {
257         .driver = {
258                 .owner =        THIS_MODULE,
259                 .name =         "cp210x",
260         },
261         .id_table               = id_table,
262         .num_ports              = 1,
263         .bulk_in_size           = 256,
264         .bulk_out_size          = 256,
265         .open                   = cp210x_open,
266         .close                  = cp210x_close,
267         .break_ctl              = cp210x_break_ctl,
268         .set_termios            = cp210x_set_termios,
269         .tx_empty               = cp210x_tx_empty,
270         .throttle               = usb_serial_generic_throttle,
271         .unthrottle             = usb_serial_generic_unthrottle,
272         .tiocmget               = cp210x_tiocmget,
273         .tiocmset               = cp210x_tiocmset,
274         .port_probe             = cp210x_port_probe,
275         .port_remove            = cp210x_port_remove,
276         .dtr_rts                = cp210x_dtr_rts
277 };
278
279 static struct usb_serial_driver * const serial_drivers[] = {
280         &cp210x_device, NULL
281 };
282
283 /* Config request types */
284 #define REQTYPE_HOST_TO_INTERFACE       0x41
285 #define REQTYPE_INTERFACE_TO_HOST       0xc1
286 #define REQTYPE_HOST_TO_DEVICE  0x40
287 #define REQTYPE_DEVICE_TO_HOST  0xc0
288
289 /* Config request codes */
290 #define CP210X_IFC_ENABLE       0x00
291 #define CP210X_SET_BAUDDIV      0x01
292 #define CP210X_GET_BAUDDIV      0x02
293 #define CP210X_SET_LINE_CTL     0x03
294 #define CP210X_GET_LINE_CTL     0x04
295 #define CP210X_SET_BREAK        0x05
296 #define CP210X_IMM_CHAR         0x06
297 #define CP210X_SET_MHS          0x07
298 #define CP210X_GET_MDMSTS       0x08
299 #define CP210X_SET_XON          0x09
300 #define CP210X_SET_XOFF         0x0A
301 #define CP210X_SET_EVENTMASK    0x0B
302 #define CP210X_GET_EVENTMASK    0x0C
303 #define CP210X_SET_CHAR         0x0D
304 #define CP210X_GET_CHARS        0x0E
305 #define CP210X_GET_PROPS        0x0F
306 #define CP210X_GET_COMM_STATUS  0x10
307 #define CP210X_RESET            0x11
308 #define CP210X_PURGE            0x12
309 #define CP210X_SET_FLOW         0x13
310 #define CP210X_GET_FLOW         0x14
311 #define CP210X_EMBED_EVENTS     0x15
312 #define CP210X_GET_EVENTSTATE   0x16
313 #define CP210X_SET_CHARS        0x19
314 #define CP210X_GET_BAUDRATE     0x1D
315 #define CP210X_SET_BAUDRATE     0x1E
316
317 /* CP210X_IFC_ENABLE */
318 #define UART_ENABLE             0x0001
319 #define UART_DISABLE            0x0000
320
321 /* CP210X_(SET|GET)_BAUDDIV */
322 #define BAUD_RATE_GEN_FREQ      0x384000
323
324 /* CP210X_(SET|GET)_LINE_CTL */
325 #define BITS_DATA_MASK          0X0f00
326 #define BITS_DATA_5             0X0500
327 #define BITS_DATA_6             0X0600
328 #define BITS_DATA_7             0X0700
329 #define BITS_DATA_8             0X0800
330 #define BITS_DATA_9             0X0900
331
332 #define BITS_PARITY_MASK        0x00f0
333 #define BITS_PARITY_NONE        0x0000
334 #define BITS_PARITY_ODD         0x0010
335 #define BITS_PARITY_EVEN        0x0020
336 #define BITS_PARITY_MARK        0x0030
337 #define BITS_PARITY_SPACE       0x0040
338
339 #define BITS_STOP_MASK          0x000f
340 #define BITS_STOP_1             0x0000
341 #define BITS_STOP_1_5           0x0001
342 #define BITS_STOP_2             0x0002
343
344 /* CP210X_SET_BREAK */
345 #define BREAK_ON                0x0001
346 #define BREAK_OFF               0x0000
347
348 /* CP210X_(SET_MHS|GET_MDMSTS) */
349 #define CONTROL_DTR             0x0001
350 #define CONTROL_RTS             0x0002
351 #define CONTROL_CTS             0x0010
352 #define CONTROL_DSR             0x0020
353 #define CONTROL_RING            0x0040
354 #define CONTROL_DCD             0x0080
355 #define CONTROL_WRITE_DTR       0x0100
356 #define CONTROL_WRITE_RTS       0x0200
357
358 /* CP210X_GET_COMM_STATUS returns these 0x13 bytes */
359 struct cp210x_comm_status {
360         __le32   ulErrors;
361         __le32   ulHoldReasons;
362         __le32   ulAmountInInQueue;
363         __le32   ulAmountInOutQueue;
364         u8       bEofReceived;
365         u8       bWaitForImmediate;
366         u8       bReserved;
367 } __packed;
368
369 /*
370  * CP210X_PURGE - 16 bits passed in wValue of USB request.
371  * SiLabs app note AN571 gives a strange description of the 4 bits:
372  * bit 0 or bit 2 clears the transmit queue and 1 or 3 receive.
373  * writing 1 to all, however, purges cp2108 well enough to avoid the hang.
374  */
375 #define PURGE_ALL               0x000f
376
377 /* CP210X_GET_FLOW/CP210X_SET_FLOW read/write these 0x10 bytes */
378 struct cp210x_flow_ctl {
379         __le32  ulControlHandshake;
380         __le32  ulFlowReplace;
381         __le32  ulXonLimit;
382         __le32  ulXoffLimit;
383 } __packed;
384
385 /* cp210x_flow_ctl::ulControlHandshake */
386 #define CP210X_SERIAL_DTR_MASK          GENMASK(1, 0)
387 #define CP210X_SERIAL_DTR_SHIFT(_mode)  (_mode)
388 #define CP210X_SERIAL_CTS_HANDSHAKE     BIT(3)
389 #define CP210X_SERIAL_DSR_HANDSHAKE     BIT(4)
390 #define CP210X_SERIAL_DCD_HANDSHAKE     BIT(5)
391 #define CP210X_SERIAL_DSR_SENSITIVITY   BIT(6)
392
393 /* values for cp210x_flow_ctl::ulControlHandshake::CP210X_SERIAL_DTR_MASK */
394 #define CP210X_SERIAL_DTR_INACTIVE      0
395 #define CP210X_SERIAL_DTR_ACTIVE        1
396 #define CP210X_SERIAL_DTR_FLOW_CTL      2
397
398 /* cp210x_flow_ctl::ulFlowReplace */
399 #define CP210X_SERIAL_AUTO_TRANSMIT     BIT(0)
400 #define CP210X_SERIAL_AUTO_RECEIVE      BIT(1)
401 #define CP210X_SERIAL_ERROR_CHAR        BIT(2)
402 #define CP210X_SERIAL_NULL_STRIPPING    BIT(3)
403 #define CP210X_SERIAL_BREAK_CHAR        BIT(4)
404 #define CP210X_SERIAL_RTS_MASK          GENMASK(7, 6)
405 #define CP210X_SERIAL_RTS_SHIFT(_mode)  (_mode << 6)
406 #define CP210X_SERIAL_XOFF_CONTINUE     BIT(31)
407
408 /* values for cp210x_flow_ctl::ulFlowReplace::CP210X_SERIAL_RTS_MASK */
409 #define CP210X_SERIAL_RTS_INACTIVE      0
410 #define CP210X_SERIAL_RTS_ACTIVE        1
411 #define CP210X_SERIAL_RTS_FLOW_CTL      2
412
413 /*
414  * Reads a variable-sized block of CP210X_ registers, identified by req.
415  * Returns data into buf in native USB byte order.
416  */
417 static int cp210x_read_reg_block(struct usb_serial_port *port, u8 req,
418                 void *buf, int bufsize)
419 {
420         struct usb_serial *serial = port->serial;
421         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
422         void *dmabuf;
423         int result;
424
425         dmabuf = kmalloc(bufsize, GFP_KERNEL);
426         if (!dmabuf) {
427                 /*
428                  * FIXME Some callers don't bother to check for error,
429                  * at least give them consistent junk until they are fixed
430                  */
431                 memset(buf, 0, bufsize);
432                 return -ENOMEM;
433         }
434
435         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
436                         req, REQTYPE_INTERFACE_TO_HOST, 0,
437                         port_priv->bInterfaceNumber, dmabuf, bufsize,
438                         USB_CTRL_SET_TIMEOUT);
439         if (result == bufsize) {
440                 memcpy(buf, dmabuf, bufsize);
441                 result = 0;
442         } else {
443                 dev_err(&port->dev, "failed get req 0x%x size %d status: %d\n",
444                                 req, bufsize, result);
445                 if (result >= 0)
446                         result = -EPROTO;
447
448                 /*
449                  * FIXME Some callers don't bother to check for error,
450                  * at least give them consistent junk until they are fixed
451                  */
452                 memset(buf, 0, bufsize);
453         }
454
455         kfree(dmabuf);
456
457         return result;
458 }
459
460 /*
461  * Reads any 32-bit CP210X_ register identified by req.
462  */
463 static int cp210x_read_u32_reg(struct usb_serial_port *port, u8 req, u32 *val)
464 {
465         __le32 le32_val;
466         int err;
467
468         err = cp210x_read_reg_block(port, req, &le32_val, sizeof(le32_val));
469         if (err) {
470                 /*
471                  * FIXME Some callers don't bother to check for error,
472                  * at least give them consistent junk until they are fixed
473                  */
474                 *val = 0;
475                 return err;
476         }
477
478         *val = le32_to_cpu(le32_val);
479
480         return 0;
481 }
482
483 /*
484  * Reads any 16-bit CP210X_ register identified by req.
485  */
486 static int cp210x_read_u16_reg(struct usb_serial_port *port, u8 req, u16 *val)
487 {
488         __le16 le16_val;
489         int err;
490
491         err = cp210x_read_reg_block(port, req, &le16_val, sizeof(le16_val));
492         if (err)
493                 return err;
494
495         *val = le16_to_cpu(le16_val);
496
497         return 0;
498 }
499
500 /*
501  * Reads any 8-bit CP210X_ register identified by req.
502  */
503 static int cp210x_read_u8_reg(struct usb_serial_port *port, u8 req, u8 *val)
504 {
505         return cp210x_read_reg_block(port, req, val, sizeof(*val));
506 }
507
508 /*
509  * Writes any 16-bit CP210X_ register (req) whose value is passed
510  * entirely in the wValue field of the USB request.
511  */
512 static int cp210x_write_u16_reg(struct usb_serial_port *port, u8 req, u16 val)
513 {
514         struct usb_serial *serial = port->serial;
515         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
516         int result;
517
518         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
519                         req, REQTYPE_HOST_TO_INTERFACE, val,
520                         port_priv->bInterfaceNumber, NULL, 0,
521                         USB_CTRL_SET_TIMEOUT);
522         if (result < 0) {
523                 dev_err(&port->dev, "failed set request 0x%x status: %d\n",
524                                 req, result);
525         }
526
527         return result;
528 }
529
530 /*
531  * Writes a variable-sized block of CP210X_ registers, identified by req.
532  * Data in buf must be in native USB byte order.
533  */
534 static int cp210x_write_reg_block(struct usb_serial_port *port, u8 req,
535                 void *buf, int bufsize)
536 {
537         struct usb_serial *serial = port->serial;
538         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
539         void *dmabuf;
540         int result;
541
542         dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
543         if (!dmabuf)
544                 return -ENOMEM;
545
546         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
547                         req, REQTYPE_HOST_TO_INTERFACE, 0,
548                         port_priv->bInterfaceNumber, dmabuf, bufsize,
549                         USB_CTRL_SET_TIMEOUT);
550
551         kfree(dmabuf);
552
553         if (result == bufsize) {
554                 result = 0;
555         } else {
556                 dev_err(&port->dev, "failed set req 0x%x size %d status: %d\n",
557                                 req, bufsize, result);
558                 if (result >= 0)
559                         result = -EPROTO;
560         }
561
562         return result;
563 }
564
565 /*
566  * Writes any 32-bit CP210X_ register identified by req.
567  */
568 static int cp210x_write_u32_reg(struct usb_serial_port *port, u8 req, u32 val)
569 {
570         __le32 le32_val;
571
572         le32_val = cpu_to_le32(val);
573
574         return cp210x_write_reg_block(port, req, &le32_val, sizeof(le32_val));
575 }
576
577 /*
578  * Detect CP2108 GET_LINE_CTL bug and activate workaround.
579  * Write a known good value 0x800, read it back.
580  * If it comes back swapped the bug is detected.
581  * Preserve the original register value.
582  */
583 static int cp210x_detect_swapped_line_ctl(struct usb_serial_port *port)
584 {
585         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
586         u16 line_ctl_save;
587         u16 line_ctl_test;
588         int err;
589
590         err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_save);
591         if (err)
592                 return err;
593
594         err = cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, 0x800);
595         if (err)
596                 return err;
597
598         err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_test);
599         if (err)
600                 return err;
601
602         if (line_ctl_test == 8) {
603                 port_priv->has_swapped_line_ctl = true;
604                 line_ctl_save = swab16(line_ctl_save);
605         }
606
607         return cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, line_ctl_save);
608 }
609
610 /*
611  * Must always be called instead of cp210x_read_u16_reg(CP210X_GET_LINE_CTL)
612  * to workaround cp2108 bug and get correct value.
613  */
614 static int cp210x_get_line_ctl(struct usb_serial_port *port, u16 *ctl)
615 {
616         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
617         int err;
618
619         err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, ctl);
620         if (err)
621                 return err;
622
623         /* Workaround swapped bytes in 16-bit value from CP210X_GET_LINE_CTL */
624         if (port_priv->has_swapped_line_ctl)
625                 *ctl = swab16(*ctl);
626
627         return 0;
628 }
629
630 /*
631  * cp210x_quantise_baudrate
632  * Quantises the baud rate as per AN205 Table 1
633  */
634 static unsigned int cp210x_quantise_baudrate(unsigned int baud)
635 {
636         if (baud <= 300)
637                 baud = 300;
638         else if (baud <= 600)      baud = 600;
639         else if (baud <= 1200)     baud = 1200;
640         else if (baud <= 1800)     baud = 1800;
641         else if (baud <= 2400)     baud = 2400;
642         else if (baud <= 4000)     baud = 4000;
643         else if (baud <= 4803)     baud = 4800;
644         else if (baud <= 7207)     baud = 7200;
645         else if (baud <= 9612)     baud = 9600;
646         else if (baud <= 14428)    baud = 14400;
647         else if (baud <= 16062)    baud = 16000;
648         else if (baud <= 19250)    baud = 19200;
649         else if (baud <= 28912)    baud = 28800;
650         else if (baud <= 38601)    baud = 38400;
651         else if (baud <= 51558)    baud = 51200;
652         else if (baud <= 56280)    baud = 56000;
653         else if (baud <= 58053)    baud = 57600;
654         else if (baud <= 64111)    baud = 64000;
655         else if (baud <= 77608)    baud = 76800;
656         else if (baud <= 117028)   baud = 115200;
657         else if (baud <= 129347)   baud = 128000;
658         else if (baud <= 156868)   baud = 153600;
659         else if (baud <= 237832)   baud = 230400;
660         else if (baud <= 254234)   baud = 250000;
661         else if (baud <= 273066)   baud = 256000;
662         else if (baud <= 491520)   baud = 460800;
663         else if (baud <= 567138)   baud = 500000;
664         else if (baud <= 670254)   baud = 576000;
665         else if (baud < 1000000)
666                 baud = 921600;
667         else if (baud > 2000000)
668                 baud = 2000000;
669         return baud;
670 }
671
672 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
673 {
674         int result;
675
676         result = cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_ENABLE);
677         if (result) {
678                 dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
679                 return result;
680         }
681
682         /* Configure the termios structure */
683         cp210x_get_termios(tty, port);
684
685         /* The baud rate must be initialised on cp2104 */
686         if (tty)
687                 cp210x_change_speed(tty, port, NULL);
688
689         return usb_serial_generic_open(tty, port);
690 }
691
692 static void cp210x_close(struct usb_serial_port *port)
693 {
694         usb_serial_generic_close(port);
695
696         /* Clear both queues; cp2108 needs this to avoid an occasional hang */
697         cp210x_write_u16_reg(port, CP210X_PURGE, PURGE_ALL);
698
699         cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
700 }
701
702 /*
703  * Read how many bytes are waiting in the TX queue.
704  */
705 static int cp210x_get_tx_queue_byte_count(struct usb_serial_port *port,
706                 u32 *count)
707 {
708         struct usb_serial *serial = port->serial;
709         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
710         struct cp210x_comm_status *sts;
711         int result;
712
713         sts = kmalloc(sizeof(*sts), GFP_KERNEL);
714         if (!sts)
715                 return -ENOMEM;
716
717         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
718                         CP210X_GET_COMM_STATUS, REQTYPE_INTERFACE_TO_HOST,
719                         0, port_priv->bInterfaceNumber, sts, sizeof(*sts),
720                         USB_CTRL_GET_TIMEOUT);
721         if (result == sizeof(*sts)) {
722                 *count = le32_to_cpu(sts->ulAmountInOutQueue);
723                 result = 0;
724         } else {
725                 dev_err(&port->dev, "failed to get comm status: %d\n", result);
726                 if (result >= 0)
727                         result = -EPROTO;
728         }
729
730         kfree(sts);
731
732         return result;
733 }
734
735 static bool cp210x_tx_empty(struct usb_serial_port *port)
736 {
737         int err;
738         u32 count;
739
740         err = cp210x_get_tx_queue_byte_count(port, &count);
741         if (err)
742                 return true;
743
744         return !count;
745 }
746
747 /*
748  * cp210x_get_termios
749  * Reads the baud rate, data bits, parity, stop bits and flow control mode
750  * from the device, corrects any unsupported values, and configures the
751  * termios structure to reflect the state of the device
752  */
753 static void cp210x_get_termios(struct tty_struct *tty,
754         struct usb_serial_port *port)
755 {
756         unsigned int baud;
757
758         if (tty) {
759                 cp210x_get_termios_port(tty->driver_data,
760                         &tty->termios.c_cflag, &baud);
761                 tty_encode_baud_rate(tty, baud, baud);
762         } else {
763                 tcflag_t cflag;
764                 cflag = 0;
765                 cp210x_get_termios_port(port, &cflag, &baud);
766         }
767 }
768
769 /*
770  * cp210x_get_termios_port
771  * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
772  */
773 static void cp210x_get_termios_port(struct usb_serial_port *port,
774         tcflag_t *cflagp, unsigned int *baudp)
775 {
776         struct device *dev = &port->dev;
777         tcflag_t cflag;
778         struct cp210x_flow_ctl flow_ctl;
779         u32 baud;
780         u16 bits;
781         u32 ctl_hs;
782         u32 flow_repl;
783
784         cp210x_read_u32_reg(port, CP210X_GET_BAUDRATE, &baud);
785
786         dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud);
787         *baudp = baud;
788
789         cflag = *cflagp;
790
791         cp210x_get_line_ctl(port, &bits);
792         cflag &= ~CSIZE;
793         switch (bits & BITS_DATA_MASK) {
794         case BITS_DATA_5:
795                 dev_dbg(dev, "%s - data bits = 5\n", __func__);
796                 cflag |= CS5;
797                 break;
798         case BITS_DATA_6:
799                 dev_dbg(dev, "%s - data bits = 6\n", __func__);
800                 cflag |= CS6;
801                 break;
802         case BITS_DATA_7:
803                 dev_dbg(dev, "%s - data bits = 7\n", __func__);
804                 cflag |= CS7;
805                 break;
806         case BITS_DATA_8:
807                 dev_dbg(dev, "%s - data bits = 8\n", __func__);
808                 cflag |= CS8;
809                 break;
810         case BITS_DATA_9:
811                 dev_dbg(dev, "%s - data bits = 9 (not supported, using 8 data bits)\n", __func__);
812                 cflag |= CS8;
813                 bits &= ~BITS_DATA_MASK;
814                 bits |= BITS_DATA_8;
815                 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
816                 break;
817         default:
818                 dev_dbg(dev, "%s - Unknown number of data bits, using 8\n", __func__);
819                 cflag |= CS8;
820                 bits &= ~BITS_DATA_MASK;
821                 bits |= BITS_DATA_8;
822                 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
823                 break;
824         }
825
826         switch (bits & BITS_PARITY_MASK) {
827         case BITS_PARITY_NONE:
828                 dev_dbg(dev, "%s - parity = NONE\n", __func__);
829                 cflag &= ~PARENB;
830                 break;
831         case BITS_PARITY_ODD:
832                 dev_dbg(dev, "%s - parity = ODD\n", __func__);
833                 cflag |= (PARENB|PARODD);
834                 break;
835         case BITS_PARITY_EVEN:
836                 dev_dbg(dev, "%s - parity = EVEN\n", __func__);
837                 cflag &= ~PARODD;
838                 cflag |= PARENB;
839                 break;
840         case BITS_PARITY_MARK:
841                 dev_dbg(dev, "%s - parity = MARK\n", __func__);
842                 cflag |= (PARENB|PARODD|CMSPAR);
843                 break;
844         case BITS_PARITY_SPACE:
845                 dev_dbg(dev, "%s - parity = SPACE\n", __func__);
846                 cflag &= ~PARODD;
847                 cflag |= (PARENB|CMSPAR);
848                 break;
849         default:
850                 dev_dbg(dev, "%s - Unknown parity mode, disabling parity\n", __func__);
851                 cflag &= ~PARENB;
852                 bits &= ~BITS_PARITY_MASK;
853                 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
854                 break;
855         }
856
857         cflag &= ~CSTOPB;
858         switch (bits & BITS_STOP_MASK) {
859         case BITS_STOP_1:
860                 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
861                 break;
862         case BITS_STOP_1_5:
863                 dev_dbg(dev, "%s - stop bits = 1.5 (not supported, using 1 stop bit)\n", __func__);
864                 bits &= ~BITS_STOP_MASK;
865                 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
866                 break;
867         case BITS_STOP_2:
868                 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
869                 cflag |= CSTOPB;
870                 break;
871         default:
872                 dev_dbg(dev, "%s - Unknown number of stop bits, using 1 stop bit\n", __func__);
873                 bits &= ~BITS_STOP_MASK;
874                 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
875                 break;
876         }
877
878         cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
879                         sizeof(flow_ctl));
880         ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
881         if (ctl_hs & CP210X_SERIAL_CTS_HANDSHAKE) {
882                 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
883                 /*
884                  * When the port is closed, the CP210x hardware disables
885                  * auto-RTS and RTS is deasserted but it leaves auto-CTS when
886                  * in hardware flow control mode. When re-opening the port, if
887                  * auto-CTS is enabled on the cp210x, then auto-RTS must be
888                  * re-enabled in the driver.
889                  */
890                 flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
891                 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
892                 flow_repl |= CP210X_SERIAL_RTS_SHIFT(CP210X_SERIAL_RTS_FLOW_CTL);
893                 flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
894                 cp210x_write_reg_block(port,
895                                 CP210X_SET_FLOW,
896                                 &flow_ctl,
897                                 sizeof(flow_ctl));
898
899                 cflag |= CRTSCTS;
900         } else {
901                 dev_dbg(dev, "%s - flow control = NONE\n", __func__);
902                 cflag &= ~CRTSCTS;
903         }
904
905         *cflagp = cflag;
906 }
907
908 /*
909  * CP2101 supports the following baud rates:
910  *
911  *      300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
912  *      38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
913  *
914  * CP2102 and CP2103 support the following additional rates:
915  *
916  *      4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
917  *      576000
918  *
919  * The device will map a requested rate to a supported one, but the result
920  * of requests for rates greater than 1053257 is undefined (see AN205).
921  *
922  * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
923  * respectively, with an error less than 1%. The actual rates are determined
924  * by
925  *
926  *      div = round(freq / (2 x prescale x request))
927  *      actual = freq / (2 x prescale x div)
928  *
929  * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
930  * or 1 otherwise.
931  * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
932  * otherwise.
933  */
934 static void cp210x_change_speed(struct tty_struct *tty,
935                 struct usb_serial_port *port, struct ktermios *old_termios)
936 {
937         u32 baud;
938
939         baud = tty->termios.c_ospeed;
940
941         /* This maps the requested rate to a rate valid on cp2102 or cp2103,
942          * or to an arbitrary rate in [1M,2M].
943          *
944          * NOTE: B0 is not implemented.
945          */
946         baud = cp210x_quantise_baudrate(baud);
947
948         dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
949         if (cp210x_write_u32_reg(port, CP210X_SET_BAUDRATE, baud)) {
950                 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
951                 if (old_termios)
952                         baud = old_termios->c_ospeed;
953                 else
954                         baud = 9600;
955         }
956
957         tty_encode_baud_rate(tty, baud, baud);
958 }
959
960 static void cp210x_set_termios(struct tty_struct *tty,
961                 struct usb_serial_port *port, struct ktermios *old_termios)
962 {
963         struct device *dev = &port->dev;
964         unsigned int cflag, old_cflag;
965         u16 bits;
966
967         cflag = tty->termios.c_cflag;
968         old_cflag = old_termios->c_cflag;
969
970         if (tty->termios.c_ospeed != old_termios->c_ospeed)
971                 cp210x_change_speed(tty, port, old_termios);
972
973         /* If the number of data bits is to be updated */
974         if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
975                 cp210x_get_line_ctl(port, &bits);
976                 bits &= ~BITS_DATA_MASK;
977                 switch (cflag & CSIZE) {
978                 case CS5:
979                         bits |= BITS_DATA_5;
980                         dev_dbg(dev, "%s - data bits = 5\n", __func__);
981                         break;
982                 case CS6:
983                         bits |= BITS_DATA_6;
984                         dev_dbg(dev, "%s - data bits = 6\n", __func__);
985                         break;
986                 case CS7:
987                         bits |= BITS_DATA_7;
988                         dev_dbg(dev, "%s - data bits = 7\n", __func__);
989                         break;
990                 case CS8:
991                         bits |= BITS_DATA_8;
992                         dev_dbg(dev, "%s - data bits = 8\n", __func__);
993                         break;
994                 /*case CS9:
995                         bits |= BITS_DATA_9;
996                         dev_dbg(dev, "%s - data bits = 9\n", __func__);
997                         break;*/
998                 default:
999                         dev_dbg(dev, "cp210x driver does not support the number of bits requested, using 8 bit mode\n");
1000                         bits |= BITS_DATA_8;
1001                         break;
1002                 }
1003                 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1004                         dev_dbg(dev, "Number of data bits requested not supported by device\n");
1005         }
1006
1007         if ((cflag     & (PARENB|PARODD|CMSPAR)) !=
1008             (old_cflag & (PARENB|PARODD|CMSPAR))) {
1009                 cp210x_get_line_ctl(port, &bits);
1010                 bits &= ~BITS_PARITY_MASK;
1011                 if (cflag & PARENB) {
1012                         if (cflag & CMSPAR) {
1013                                 if (cflag & PARODD) {
1014                                         bits |= BITS_PARITY_MARK;
1015                                         dev_dbg(dev, "%s - parity = MARK\n", __func__);
1016                                 } else {
1017                                         bits |= BITS_PARITY_SPACE;
1018                                         dev_dbg(dev, "%s - parity = SPACE\n", __func__);
1019                                 }
1020                         } else {
1021                                 if (cflag & PARODD) {
1022                                         bits |= BITS_PARITY_ODD;
1023                                         dev_dbg(dev, "%s - parity = ODD\n", __func__);
1024                                 } else {
1025                                         bits |= BITS_PARITY_EVEN;
1026                                         dev_dbg(dev, "%s - parity = EVEN\n", __func__);
1027                                 }
1028                         }
1029                 }
1030                 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1031                         dev_dbg(dev, "Parity mode not supported by device\n");
1032         }
1033
1034         if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
1035                 cp210x_get_line_ctl(port, &bits);
1036                 bits &= ~BITS_STOP_MASK;
1037                 if (cflag & CSTOPB) {
1038                         bits |= BITS_STOP_2;
1039                         dev_dbg(dev, "%s - stop bits = 2\n", __func__);
1040                 } else {
1041                         bits |= BITS_STOP_1;
1042                         dev_dbg(dev, "%s - stop bits = 1\n", __func__);
1043                 }
1044                 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1045                         dev_dbg(dev, "Number of stop bits requested not supported by device\n");
1046         }
1047
1048         if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
1049                 struct cp210x_flow_ctl flow_ctl;
1050                 u32 ctl_hs;
1051                 u32 flow_repl;
1052
1053                 cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1054                                 sizeof(flow_ctl));
1055                 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1056                 flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1057                 dev_dbg(dev, "%s - read ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1058                                 __func__, ctl_hs, flow_repl);
1059
1060                 ctl_hs &= ~CP210X_SERIAL_DSR_HANDSHAKE;
1061                 ctl_hs &= ~CP210X_SERIAL_DCD_HANDSHAKE;
1062                 ctl_hs &= ~CP210X_SERIAL_DSR_SENSITIVITY;
1063                 ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1064                 ctl_hs |= CP210X_SERIAL_DTR_SHIFT(CP210X_SERIAL_DTR_ACTIVE);
1065                 if (cflag & CRTSCTS) {
1066                         ctl_hs |= CP210X_SERIAL_CTS_HANDSHAKE;
1067
1068                         flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1069                         flow_repl |= CP210X_SERIAL_RTS_SHIFT(
1070                                         CP210X_SERIAL_RTS_FLOW_CTL);
1071                         dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
1072                 } else {
1073                         ctl_hs &= ~CP210X_SERIAL_CTS_HANDSHAKE;
1074
1075                         flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1076                         flow_repl |= CP210X_SERIAL_RTS_SHIFT(
1077                                         CP210X_SERIAL_RTS_ACTIVE);
1078                         dev_dbg(dev, "%s - flow control = NONE\n", __func__);
1079                 }
1080
1081                 dev_dbg(dev, "%s - write ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1082                                 __func__, ctl_hs, flow_repl);
1083                 flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1084                 flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1085                 cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1086                                 sizeof(flow_ctl));
1087         }
1088
1089 }
1090
1091 static int cp210x_tiocmset(struct tty_struct *tty,
1092                 unsigned int set, unsigned int clear)
1093 {
1094         struct usb_serial_port *port = tty->driver_data;
1095         return cp210x_tiocmset_port(port, set, clear);
1096 }
1097
1098 static int cp210x_tiocmset_port(struct usb_serial_port *port,
1099                 unsigned int set, unsigned int clear)
1100 {
1101         u16 control = 0;
1102
1103         if (set & TIOCM_RTS) {
1104                 control |= CONTROL_RTS;
1105                 control |= CONTROL_WRITE_RTS;
1106         }
1107         if (set & TIOCM_DTR) {
1108                 control |= CONTROL_DTR;
1109                 control |= CONTROL_WRITE_DTR;
1110         }
1111         if (clear & TIOCM_RTS) {
1112                 control &= ~CONTROL_RTS;
1113                 control |= CONTROL_WRITE_RTS;
1114         }
1115         if (clear & TIOCM_DTR) {
1116                 control &= ~CONTROL_DTR;
1117                 control |= CONTROL_WRITE_DTR;
1118         }
1119
1120         dev_dbg(&port->dev, "%s - control = 0x%.4x\n", __func__, control);
1121
1122         return cp210x_write_u16_reg(port, CP210X_SET_MHS, control);
1123 }
1124
1125 static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
1126 {
1127         if (on)
1128                 cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
1129         else
1130                 cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
1131 }
1132
1133 static int cp210x_tiocmget(struct tty_struct *tty)
1134 {
1135         struct usb_serial_port *port = tty->driver_data;
1136         u8 control;
1137         int result;
1138
1139         result = cp210x_read_u8_reg(port, CP210X_GET_MDMSTS, &control);
1140         if (result)
1141                 return result;
1142
1143         result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
1144                 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
1145                 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
1146                 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
1147                 |((control & CONTROL_RING)? TIOCM_RI  : 0)
1148                 |((control & CONTROL_DCD) ? TIOCM_CD  : 0);
1149
1150         dev_dbg(&port->dev, "%s - control = 0x%.2x\n", __func__, control);
1151
1152         return result;
1153 }
1154
1155 static void cp210x_break_ctl(struct tty_struct *tty, int break_state)
1156 {
1157         struct usb_serial_port *port = tty->driver_data;
1158         u16 state;
1159
1160         if (break_state == 0)
1161                 state = BREAK_OFF;
1162         else
1163                 state = BREAK_ON;
1164         dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
1165                 state == BREAK_OFF ? "off" : "on");
1166         cp210x_write_u16_reg(port, CP210X_SET_BREAK, state);
1167 }
1168
1169 static int cp210x_port_probe(struct usb_serial_port *port)
1170 {
1171         struct usb_serial *serial = port->serial;
1172         struct usb_host_interface *cur_altsetting;
1173         struct cp210x_port_private *port_priv;
1174         int ret;
1175
1176         port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
1177         if (!port_priv)
1178                 return -ENOMEM;
1179
1180         cur_altsetting = serial->interface->cur_altsetting;
1181         port_priv->bInterfaceNumber = cur_altsetting->desc.bInterfaceNumber;
1182
1183         usb_set_serial_port_data(port, port_priv);
1184
1185         ret = cp210x_detect_swapped_line_ctl(port);
1186         if (ret) {
1187                 kfree(port_priv);
1188                 return ret;
1189         }
1190
1191         return 0;
1192 }
1193
1194 static int cp210x_port_remove(struct usb_serial_port *port)
1195 {
1196         struct cp210x_port_private *port_priv;
1197
1198         port_priv = usb_get_serial_port_data(port);
1199         kfree(port_priv);
1200
1201         return 0;
1202 }
1203
1204 module_usb_serial_driver(serial_drivers, id_table);
1205
1206 MODULE_DESCRIPTION(DRIVER_DESC);
1207 MODULE_LICENSE("GPL");