]> git.karo-electronics.de Git - karo-tx-linux.git/blob - drivers/usb/serial/cp210x.c
Merge branch 'for-4.11' of git://git.kernel.org/pub/scm/linux/kernel/git/tj/percpu
[karo-tx-linux.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 #include <linux/gpio/driver.h>
27 #include <linux/bitops.h>
28 #include <linux/mutex.h>
29
30 #define DRIVER_DESC "Silicon Labs CP210x RS232 serial adaptor driver"
31
32 /*
33  * Function Prototypes
34  */
35 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *);
36 static void cp210x_close(struct usb_serial_port *);
37 static void cp210x_get_termios(struct tty_struct *, struct usb_serial_port *);
38 static void cp210x_get_termios_port(struct usb_serial_port *port,
39         tcflag_t *cflagp, unsigned int *baudp);
40 static void cp210x_change_speed(struct tty_struct *, struct usb_serial_port *,
41                                                         struct ktermios *);
42 static void cp210x_set_termios(struct tty_struct *, struct usb_serial_port *,
43                                                         struct ktermios*);
44 static bool cp210x_tx_empty(struct usb_serial_port *port);
45 static int cp210x_tiocmget(struct tty_struct *);
46 static int cp210x_tiocmset(struct tty_struct *, unsigned int, unsigned int);
47 static int cp210x_tiocmset_port(struct usb_serial_port *port,
48                 unsigned int, unsigned int);
49 static void cp210x_break_ctl(struct tty_struct *, int);
50 static int cp210x_attach(struct usb_serial *);
51 static void cp210x_disconnect(struct usb_serial *);
52 static void cp210x_release(struct usb_serial *);
53 static int cp210x_port_probe(struct usb_serial_port *);
54 static int cp210x_port_remove(struct usb_serial_port *);
55 static void cp210x_dtr_rts(struct usb_serial_port *p, int on);
56
57 static const struct usb_device_id id_table[] = {
58         { USB_DEVICE(0x045B, 0x0053) }, /* Renesas RX610 RX-Stick */
59         { USB_DEVICE(0x0471, 0x066A) }, /* AKTAKOM ACE-1001 cable */
60         { USB_DEVICE(0x0489, 0xE000) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
61         { USB_DEVICE(0x0489, 0xE003) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
62         { USB_DEVICE(0x0745, 0x1000) }, /* CipherLab USB CCD Barcode Scanner 1000 */
63         { USB_DEVICE(0x0846, 0x1100) }, /* NetGear Managed Switch M4100 series, M5300 series, M7100 series */
64         { USB_DEVICE(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
65         { USB_DEVICE(0x08FD, 0x000A) }, /* Digianswer A/S , ZigBee/802.15.4 MAC Device */
66         { USB_DEVICE(0x0908, 0x01FF) }, /* Siemens RUGGEDCOM USB Serial Console */
67         { USB_DEVICE(0x0BED, 0x1100) }, /* MEI (TM) Cashflow-SC Bill/Voucher Acceptor */
68         { USB_DEVICE(0x0BED, 0x1101) }, /* MEI series 2000 Combo Acceptor */
69         { USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
70         { USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
71         { USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */
72         { USB_DEVICE(0x0FDE, 0xCA05) }, /* OWL Wireless Electricity Monitor CM-160 */
73         { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
74         { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
75         { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
76         { USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */
77         { USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */
78         { USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */
79         { USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
80         { USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
81         { USB_DEVICE(0x10C4, 0x8044) }, /* Cygnal Debug Adapter */
82         { USB_DEVICE(0x10C4, 0x804E) }, /* Software Bisque Paramount ME build-in converter */
83         { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
84         { USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */
85         { USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
86         { USB_DEVICE(0x10C4, 0x806F) }, /* IMS USB to RS422 Converter Cable */
87         { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
88         { USB_DEVICE(0x10C4, 0x80C4) }, /* Cygnal Integrated Products, Inc., Optris infrared thermometer */
89         { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
90         { USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
91         { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
92         { USB_DEVICE(0x10C4, 0x8115) }, /* Arygon NFC/Mifare Reader */
93         { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
94         { USB_DEVICE(0x10C4, 0x813F) }, /* Tams Master Easy Control */
95         { USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
96         { USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
97         { USB_DEVICE(0x2405, 0x0003) }, /* West Mountain Radio RIGblaster Advantage */
98         { USB_DEVICE(0x10C4, 0x8156) }, /* B&G H3000 link cable */
99         { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
100         { USB_DEVICE(0x10C4, 0x815F) }, /* Timewave HamLinkUSB */
101         { USB_DEVICE(0x10C4, 0x818B) }, /* AVIT Research USB to TTL */
102         { USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
103         { USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
104         { USB_DEVICE(0x10C4, 0x81A9) }, /* Multiplex RC Interface */
105         { USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
106         { USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */
107         { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
108         { USB_DEVICE(0x10C4, 0x81D7) }, /* IAI Corp. RCB-CV-USB USB to RS485 Adaptor */
109         { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
110         { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
111         { USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
112         { USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
113         { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
114         { USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
115         { USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
116         { USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */
117         { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
118         { USB_DEVICE(0x10C4, 0x82F4) }, /* Starizona MicroTouch */
119         { USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
120         { USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
121         { USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
122         { USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
123         { USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
124         { USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
125         { USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
126         { USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
127         { USB_DEVICE(0x10C4, 0x8470) }, /* Juniper Networks BX Series System Console */
128         { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
129         { USB_DEVICE(0x10C4, 0x84B6) }, /* Starizona Hyperion */
130         { USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
131         { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
132         { USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
133         { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
134         { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
135         { USB_DEVICE(0x10C4, 0x8856) }, /* CEL EM357 ZigBee USB Stick - LR */
136         { USB_DEVICE(0x10C4, 0x8857) }, /* CEL EM357 ZigBee USB Stick */
137         { USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
138         { USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
139         { USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
140         { USB_DEVICE(0x10C4, 0x8962) }, /* Brim Brothers charging dock */
141         { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit Device */
142         { USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
143         { USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
144         { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
145         { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
146         { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
147         { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
148         { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
149         { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
150         { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
151         { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
152         { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
153         { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
154         { USB_DEVICE(0x12B8, 0xEC60) }, /* Link G4 ECU */
155         { USB_DEVICE(0x12B8, 0xEC62) }, /* Link G4+ ECU */
156         { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
157         { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
158         { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
159         { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
160         { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
161         { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
162         { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
163         { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
164         { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
165         { USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
166         { USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
167         { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
168         { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
169         { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
170         { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
171         { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
172         { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
173         { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
174         { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
175         { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
176         { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
177         { USB_DEVICE(0x18EF, 0xE025) }, /* ELV Marble Sound Board 1 */
178         { USB_DEVICE(0x1901, 0x0190) }, /* GE B850 CP2105 Recorder interface */
179         { USB_DEVICE(0x1901, 0x0193) }, /* GE B650 CP2104 PMC interface */
180         { USB_DEVICE(0x1901, 0x0194) }, /* GE Healthcare Remote Alarm Box */
181         { USB_DEVICE(0x1901, 0x0195) }, /* GE B850/B650/B450 CP2104 DP UART interface */
182         { USB_DEVICE(0x1901, 0x0196) }, /* GE B850 CP2105 DP UART interface */
183         { USB_DEVICE(0x19CF, 0x3000) }, /* Parrot NMEA GPS Flight Recorder */
184         { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
185         { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
186         { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
187         { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
188         { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
189         { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
190         { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
191         { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
192         { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
193         { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
194         { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
195         { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
196         { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
197         { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
198         { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
199         { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
200         { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
201         { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
202         { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
203         { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
204         { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
205         { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
206         { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
207         { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
208         { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
209         { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
210         { USB_DEVICE(0x2626, 0xEA60) }, /* Aruba Networks 7xxx USB Serial Console */
211         { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
212         { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
213         { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
214         { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
215         { } /* Terminating Entry */
216 };
217
218 MODULE_DEVICE_TABLE(usb, id_table);
219
220 struct cp210x_serial_private {
221 #ifdef CONFIG_GPIOLIB
222         struct gpio_chip        gc;
223         u8                      config;
224         u8                      gpio_mode;
225         bool                    gpio_registered;
226 #endif
227         u8                      partnum;
228 };
229
230 struct cp210x_port_private {
231         __u8                    bInterfaceNumber;
232         bool                    has_swapped_line_ctl;
233 };
234
235 static struct usb_serial_driver cp210x_device = {
236         .driver = {
237                 .owner =        THIS_MODULE,
238                 .name =         "cp210x",
239         },
240         .id_table               = id_table,
241         .num_ports              = 1,
242         .bulk_in_size           = 256,
243         .bulk_out_size          = 256,
244         .open                   = cp210x_open,
245         .close                  = cp210x_close,
246         .break_ctl              = cp210x_break_ctl,
247         .set_termios            = cp210x_set_termios,
248         .tx_empty               = cp210x_tx_empty,
249         .tiocmget               = cp210x_tiocmget,
250         .tiocmset               = cp210x_tiocmset,
251         .attach                 = cp210x_attach,
252         .disconnect             = cp210x_disconnect,
253         .release                = cp210x_release,
254         .port_probe             = cp210x_port_probe,
255         .port_remove            = cp210x_port_remove,
256         .dtr_rts                = cp210x_dtr_rts
257 };
258
259 static struct usb_serial_driver * const serial_drivers[] = {
260         &cp210x_device, NULL
261 };
262
263 /* Config request types */
264 #define REQTYPE_HOST_TO_INTERFACE       0x41
265 #define REQTYPE_INTERFACE_TO_HOST       0xc1
266 #define REQTYPE_HOST_TO_DEVICE  0x40
267 #define REQTYPE_DEVICE_TO_HOST  0xc0
268
269 /* Config request codes */
270 #define CP210X_IFC_ENABLE       0x00
271 #define CP210X_SET_BAUDDIV      0x01
272 #define CP210X_GET_BAUDDIV      0x02
273 #define CP210X_SET_LINE_CTL     0x03
274 #define CP210X_GET_LINE_CTL     0x04
275 #define CP210X_SET_BREAK        0x05
276 #define CP210X_IMM_CHAR         0x06
277 #define CP210X_SET_MHS          0x07
278 #define CP210X_GET_MDMSTS       0x08
279 #define CP210X_SET_XON          0x09
280 #define CP210X_SET_XOFF         0x0A
281 #define CP210X_SET_EVENTMASK    0x0B
282 #define CP210X_GET_EVENTMASK    0x0C
283 #define CP210X_SET_CHAR         0x0D
284 #define CP210X_GET_CHARS        0x0E
285 #define CP210X_GET_PROPS        0x0F
286 #define CP210X_GET_COMM_STATUS  0x10
287 #define CP210X_RESET            0x11
288 #define CP210X_PURGE            0x12
289 #define CP210X_SET_FLOW         0x13
290 #define CP210X_GET_FLOW         0x14
291 #define CP210X_EMBED_EVENTS     0x15
292 #define CP210X_GET_EVENTSTATE   0x16
293 #define CP210X_SET_CHARS        0x19
294 #define CP210X_GET_BAUDRATE     0x1D
295 #define CP210X_SET_BAUDRATE     0x1E
296 #define CP210X_VENDOR_SPECIFIC  0xFF
297
298 /* CP210X_IFC_ENABLE */
299 #define UART_ENABLE             0x0001
300 #define UART_DISABLE            0x0000
301
302 /* CP210X_(SET|GET)_BAUDDIV */
303 #define BAUD_RATE_GEN_FREQ      0x384000
304
305 /* CP210X_(SET|GET)_LINE_CTL */
306 #define BITS_DATA_MASK          0X0f00
307 #define BITS_DATA_5             0X0500
308 #define BITS_DATA_6             0X0600
309 #define BITS_DATA_7             0X0700
310 #define BITS_DATA_8             0X0800
311 #define BITS_DATA_9             0X0900
312
313 #define BITS_PARITY_MASK        0x00f0
314 #define BITS_PARITY_NONE        0x0000
315 #define BITS_PARITY_ODD         0x0010
316 #define BITS_PARITY_EVEN        0x0020
317 #define BITS_PARITY_MARK        0x0030
318 #define BITS_PARITY_SPACE       0x0040
319
320 #define BITS_STOP_MASK          0x000f
321 #define BITS_STOP_1             0x0000
322 #define BITS_STOP_1_5           0x0001
323 #define BITS_STOP_2             0x0002
324
325 /* CP210X_SET_BREAK */
326 #define BREAK_ON                0x0001
327 #define BREAK_OFF               0x0000
328
329 /* CP210X_(SET_MHS|GET_MDMSTS) */
330 #define CONTROL_DTR             0x0001
331 #define CONTROL_RTS             0x0002
332 #define CONTROL_CTS             0x0010
333 #define CONTROL_DSR             0x0020
334 #define CONTROL_RING            0x0040
335 #define CONTROL_DCD             0x0080
336 #define CONTROL_WRITE_DTR       0x0100
337 #define CONTROL_WRITE_RTS       0x0200
338
339 /* CP210X_VENDOR_SPECIFIC values */
340 #define CP210X_READ_LATCH       0x00C2
341 #define CP210X_GET_PARTNUM      0x370B
342 #define CP210X_GET_PORTCONFIG   0x370C
343 #define CP210X_GET_DEVICEMODE   0x3711
344 #define CP210X_WRITE_LATCH      0x37E1
345
346 /* Part number definitions */
347 #define CP210X_PARTNUM_CP2101   0x01
348 #define CP210X_PARTNUM_CP2102   0x02
349 #define CP210X_PARTNUM_CP2103   0x03
350 #define CP210X_PARTNUM_CP2104   0x04
351 #define CP210X_PARTNUM_CP2105   0x05
352 #define CP210X_PARTNUM_CP2108   0x08
353
354 /* CP210X_GET_COMM_STATUS returns these 0x13 bytes */
355 struct cp210x_comm_status {
356         __le32   ulErrors;
357         __le32   ulHoldReasons;
358         __le32   ulAmountInInQueue;
359         __le32   ulAmountInOutQueue;
360         u8       bEofReceived;
361         u8       bWaitForImmediate;
362         u8       bReserved;
363 } __packed;
364
365 /*
366  * CP210X_PURGE - 16 bits passed in wValue of USB request.
367  * SiLabs app note AN571 gives a strange description of the 4 bits:
368  * bit 0 or bit 2 clears the transmit queue and 1 or 3 receive.
369  * writing 1 to all, however, purges cp2108 well enough to avoid the hang.
370  */
371 #define PURGE_ALL               0x000f
372
373 /* CP210X_GET_FLOW/CP210X_SET_FLOW read/write these 0x10 bytes */
374 struct cp210x_flow_ctl {
375         __le32  ulControlHandshake;
376         __le32  ulFlowReplace;
377         __le32  ulXonLimit;
378         __le32  ulXoffLimit;
379 } __packed;
380
381 /* cp210x_flow_ctl::ulControlHandshake */
382 #define CP210X_SERIAL_DTR_MASK          GENMASK(1, 0)
383 #define CP210X_SERIAL_DTR_SHIFT(_mode)  (_mode)
384 #define CP210X_SERIAL_CTS_HANDSHAKE     BIT(3)
385 #define CP210X_SERIAL_DSR_HANDSHAKE     BIT(4)
386 #define CP210X_SERIAL_DCD_HANDSHAKE     BIT(5)
387 #define CP210X_SERIAL_DSR_SENSITIVITY   BIT(6)
388
389 /* values for cp210x_flow_ctl::ulControlHandshake::CP210X_SERIAL_DTR_MASK */
390 #define CP210X_SERIAL_DTR_INACTIVE      0
391 #define CP210X_SERIAL_DTR_ACTIVE        1
392 #define CP210X_SERIAL_DTR_FLOW_CTL      2
393
394 /* cp210x_flow_ctl::ulFlowReplace */
395 #define CP210X_SERIAL_AUTO_TRANSMIT     BIT(0)
396 #define CP210X_SERIAL_AUTO_RECEIVE      BIT(1)
397 #define CP210X_SERIAL_ERROR_CHAR        BIT(2)
398 #define CP210X_SERIAL_NULL_STRIPPING    BIT(3)
399 #define CP210X_SERIAL_BREAK_CHAR        BIT(4)
400 #define CP210X_SERIAL_RTS_MASK          GENMASK(7, 6)
401 #define CP210X_SERIAL_RTS_SHIFT(_mode)  (_mode << 6)
402 #define CP210X_SERIAL_XOFF_CONTINUE     BIT(31)
403
404 /* values for cp210x_flow_ctl::ulFlowReplace::CP210X_SERIAL_RTS_MASK */
405 #define CP210X_SERIAL_RTS_INACTIVE      0
406 #define CP210X_SERIAL_RTS_ACTIVE        1
407 #define CP210X_SERIAL_RTS_FLOW_CTL      2
408
409 /* CP210X_VENDOR_SPECIFIC, CP210X_GET_DEVICEMODE call reads these 0x2 bytes. */
410 struct cp210x_pin_mode {
411         u8      eci;
412         u8      sci;
413 } __packed;
414
415 #define CP210X_PIN_MODE_MODEM           0
416 #define CP210X_PIN_MODE_GPIO            BIT(0)
417
418 /*
419  * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xf bytes.
420  * Structure needs padding due to unused/unspecified bytes.
421  */
422 struct cp210x_config {
423         __le16  gpio_mode;
424         u8      __pad0[2];
425         __le16  reset_state;
426         u8      __pad1[4];
427         __le16  suspend_state;
428         u8      sci_cfg;
429         u8      eci_cfg;
430         u8      device_cfg;
431 } __packed;
432
433 /* GPIO modes */
434 #define CP210X_SCI_GPIO_MODE_OFFSET     9
435 #define CP210X_SCI_GPIO_MODE_MASK       GENMASK(11, 9)
436
437 #define CP210X_ECI_GPIO_MODE_OFFSET     2
438 #define CP210X_ECI_GPIO_MODE_MASK       GENMASK(3, 2)
439
440 /* CP2105 port configuration values */
441 #define CP2105_GPIO0_TXLED_MODE         BIT(0)
442 #define CP2105_GPIO1_RXLED_MODE         BIT(1)
443 #define CP2105_GPIO1_RS485_MODE         BIT(2)
444
445 /* CP210X_VENDOR_SPECIFIC, CP210X_WRITE_LATCH call writes these 0x2 bytes. */
446 struct cp210x_gpio_write {
447         u8      mask;
448         u8      state;
449 } __packed;
450
451 /*
452  * Helper to get interface number when we only have struct usb_serial.
453  */
454 static u8 cp210x_interface_num(struct usb_serial *serial)
455 {
456         struct usb_host_interface *cur_altsetting;
457
458         cur_altsetting = serial->interface->cur_altsetting;
459
460         return cur_altsetting->desc.bInterfaceNumber;
461 }
462
463 /*
464  * Reads a variable-sized block of CP210X_ registers, identified by req.
465  * Returns data into buf in native USB byte order.
466  */
467 static int cp210x_read_reg_block(struct usb_serial_port *port, u8 req,
468                 void *buf, int bufsize)
469 {
470         struct usb_serial *serial = port->serial;
471         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
472         void *dmabuf;
473         int result;
474
475         dmabuf = kmalloc(bufsize, GFP_KERNEL);
476         if (!dmabuf) {
477                 /*
478                  * FIXME Some callers don't bother to check for error,
479                  * at least give them consistent junk until they are fixed
480                  */
481                 memset(buf, 0, bufsize);
482                 return -ENOMEM;
483         }
484
485         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
486                         req, REQTYPE_INTERFACE_TO_HOST, 0,
487                         port_priv->bInterfaceNumber, dmabuf, bufsize,
488                         USB_CTRL_SET_TIMEOUT);
489         if (result == bufsize) {
490                 memcpy(buf, dmabuf, bufsize);
491                 result = 0;
492         } else {
493                 dev_err(&port->dev, "failed get req 0x%x size %d status: %d\n",
494                                 req, bufsize, result);
495                 if (result >= 0)
496                         result = -EIO;
497
498                 /*
499                  * FIXME Some callers don't bother to check for error,
500                  * at least give them consistent junk until they are fixed
501                  */
502                 memset(buf, 0, bufsize);
503         }
504
505         kfree(dmabuf);
506
507         return result;
508 }
509
510 /*
511  * Reads any 32-bit CP210X_ register identified by req.
512  */
513 static int cp210x_read_u32_reg(struct usb_serial_port *port, u8 req, u32 *val)
514 {
515         __le32 le32_val;
516         int err;
517
518         err = cp210x_read_reg_block(port, req, &le32_val, sizeof(le32_val));
519         if (err) {
520                 /*
521                  * FIXME Some callers don't bother to check for error,
522                  * at least give them consistent junk until they are fixed
523                  */
524                 *val = 0;
525                 return err;
526         }
527
528         *val = le32_to_cpu(le32_val);
529
530         return 0;
531 }
532
533 /*
534  * Reads any 16-bit CP210X_ register identified by req.
535  */
536 static int cp210x_read_u16_reg(struct usb_serial_port *port, u8 req, u16 *val)
537 {
538         __le16 le16_val;
539         int err;
540
541         err = cp210x_read_reg_block(port, req, &le16_val, sizeof(le16_val));
542         if (err)
543                 return err;
544
545         *val = le16_to_cpu(le16_val);
546
547         return 0;
548 }
549
550 /*
551  * Reads any 8-bit CP210X_ register identified by req.
552  */
553 static int cp210x_read_u8_reg(struct usb_serial_port *port, u8 req, u8 *val)
554 {
555         return cp210x_read_reg_block(port, req, val, sizeof(*val));
556 }
557
558 /*
559  * Reads a variable-sized vendor block of CP210X_ registers, identified by val.
560  * Returns data into buf in native USB byte order.
561  */
562 static int cp210x_read_vendor_block(struct usb_serial *serial, u8 type, u16 val,
563                                     void *buf, int bufsize)
564 {
565         void *dmabuf;
566         int result;
567
568         dmabuf = kmalloc(bufsize, GFP_KERNEL);
569         if (!dmabuf)
570                 return -ENOMEM;
571
572         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
573                                  CP210X_VENDOR_SPECIFIC, type, val,
574                                  cp210x_interface_num(serial), dmabuf, bufsize,
575                                  USB_CTRL_GET_TIMEOUT);
576         if (result == bufsize) {
577                 memcpy(buf, dmabuf, bufsize);
578                 result = 0;
579         } else {
580                 dev_err(&serial->interface->dev,
581                         "failed to get vendor val 0x%04x size %d: %d\n", val,
582                         bufsize, result);
583                 if (result >= 0)
584                         result = -EIO;
585         }
586
587         kfree(dmabuf);
588
589         return result;
590 }
591
592 /*
593  * Writes any 16-bit CP210X_ register (req) whose value is passed
594  * entirely in the wValue field of the USB request.
595  */
596 static int cp210x_write_u16_reg(struct usb_serial_port *port, u8 req, u16 val)
597 {
598         struct usb_serial *serial = port->serial;
599         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
600         int result;
601
602         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
603                         req, REQTYPE_HOST_TO_INTERFACE, val,
604                         port_priv->bInterfaceNumber, NULL, 0,
605                         USB_CTRL_SET_TIMEOUT);
606         if (result < 0) {
607                 dev_err(&port->dev, "failed set request 0x%x status: %d\n",
608                                 req, result);
609         }
610
611         return result;
612 }
613
614 /*
615  * Writes a variable-sized block of CP210X_ registers, identified by req.
616  * Data in buf must be in native USB byte order.
617  */
618 static int cp210x_write_reg_block(struct usb_serial_port *port, u8 req,
619                 void *buf, int bufsize)
620 {
621         struct usb_serial *serial = port->serial;
622         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
623         void *dmabuf;
624         int result;
625
626         dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
627         if (!dmabuf)
628                 return -ENOMEM;
629
630         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
631                         req, REQTYPE_HOST_TO_INTERFACE, 0,
632                         port_priv->bInterfaceNumber, dmabuf, bufsize,
633                         USB_CTRL_SET_TIMEOUT);
634
635         kfree(dmabuf);
636
637         if (result == bufsize) {
638                 result = 0;
639         } else {
640                 dev_err(&port->dev, "failed set req 0x%x size %d status: %d\n",
641                                 req, bufsize, result);
642                 if (result >= 0)
643                         result = -EIO;
644         }
645
646         return result;
647 }
648
649 /*
650  * Writes any 32-bit CP210X_ register identified by req.
651  */
652 static int cp210x_write_u32_reg(struct usb_serial_port *port, u8 req, u32 val)
653 {
654         __le32 le32_val;
655
656         le32_val = cpu_to_le32(val);
657
658         return cp210x_write_reg_block(port, req, &le32_val, sizeof(le32_val));
659 }
660
661 #ifdef CONFIG_GPIOLIB
662 /*
663  * Writes a variable-sized vendor block of CP210X_ registers, identified by val.
664  * Data in buf must be in native USB byte order.
665  */
666 static int cp210x_write_vendor_block(struct usb_serial *serial, u8 type,
667                                      u16 val, void *buf, int bufsize)
668 {
669         void *dmabuf;
670         int result;
671
672         dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
673         if (!dmabuf)
674                 return -ENOMEM;
675
676         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
677                                  CP210X_VENDOR_SPECIFIC, type, val,
678                                  cp210x_interface_num(serial), dmabuf, bufsize,
679                                  USB_CTRL_SET_TIMEOUT);
680
681         kfree(dmabuf);
682
683         if (result == bufsize) {
684                 result = 0;
685         } else {
686                 dev_err(&serial->interface->dev,
687                         "failed to set vendor val 0x%04x size %d: %d\n", val,
688                         bufsize, result);
689                 if (result >= 0)
690                         result = -EIO;
691         }
692
693         return result;
694 }
695 #endif
696
697 /*
698  * Detect CP2108 GET_LINE_CTL bug and activate workaround.
699  * Write a known good value 0x800, read it back.
700  * If it comes back swapped the bug is detected.
701  * Preserve the original register value.
702  */
703 static int cp210x_detect_swapped_line_ctl(struct usb_serial_port *port)
704 {
705         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
706         u16 line_ctl_save;
707         u16 line_ctl_test;
708         int err;
709
710         err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_save);
711         if (err)
712                 return err;
713
714         err = cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, 0x800);
715         if (err)
716                 return err;
717
718         err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_test);
719         if (err)
720                 return err;
721
722         if (line_ctl_test == 8) {
723                 port_priv->has_swapped_line_ctl = true;
724                 line_ctl_save = swab16(line_ctl_save);
725         }
726
727         return cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, line_ctl_save);
728 }
729
730 /*
731  * Must always be called instead of cp210x_read_u16_reg(CP210X_GET_LINE_CTL)
732  * to workaround cp2108 bug and get correct value.
733  */
734 static int cp210x_get_line_ctl(struct usb_serial_port *port, u16 *ctl)
735 {
736         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
737         int err;
738
739         err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, ctl);
740         if (err)
741                 return err;
742
743         /* Workaround swapped bytes in 16-bit value from CP210X_GET_LINE_CTL */
744         if (port_priv->has_swapped_line_ctl)
745                 *ctl = swab16(*ctl);
746
747         return 0;
748 }
749
750 /*
751  * cp210x_quantise_baudrate
752  * Quantises the baud rate as per AN205 Table 1
753  */
754 static unsigned int cp210x_quantise_baudrate(unsigned int baud)
755 {
756         if (baud <= 300)
757                 baud = 300;
758         else if (baud <= 600)      baud = 600;
759         else if (baud <= 1200)     baud = 1200;
760         else if (baud <= 1800)     baud = 1800;
761         else if (baud <= 2400)     baud = 2400;
762         else if (baud <= 4000)     baud = 4000;
763         else if (baud <= 4803)     baud = 4800;
764         else if (baud <= 7207)     baud = 7200;
765         else if (baud <= 9612)     baud = 9600;
766         else if (baud <= 14428)    baud = 14400;
767         else if (baud <= 16062)    baud = 16000;
768         else if (baud <= 19250)    baud = 19200;
769         else if (baud <= 28912)    baud = 28800;
770         else if (baud <= 38601)    baud = 38400;
771         else if (baud <= 51558)    baud = 51200;
772         else if (baud <= 56280)    baud = 56000;
773         else if (baud <= 58053)    baud = 57600;
774         else if (baud <= 64111)    baud = 64000;
775         else if (baud <= 77608)    baud = 76800;
776         else if (baud <= 117028)   baud = 115200;
777         else if (baud <= 129347)   baud = 128000;
778         else if (baud <= 156868)   baud = 153600;
779         else if (baud <= 237832)   baud = 230400;
780         else if (baud <= 254234)   baud = 250000;
781         else if (baud <= 273066)   baud = 256000;
782         else if (baud <= 491520)   baud = 460800;
783         else if (baud <= 567138)   baud = 500000;
784         else if (baud <= 670254)   baud = 576000;
785         else if (baud < 1000000)
786                 baud = 921600;
787         else if (baud > 2000000)
788                 baud = 2000000;
789         return baud;
790 }
791
792 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
793 {
794         int result;
795
796         result = cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_ENABLE);
797         if (result) {
798                 dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
799                 return result;
800         }
801
802         /* Configure the termios structure */
803         cp210x_get_termios(tty, port);
804
805         /* The baud rate must be initialised on cp2104 */
806         if (tty)
807                 cp210x_change_speed(tty, port, NULL);
808
809         return usb_serial_generic_open(tty, port);
810 }
811
812 static void cp210x_close(struct usb_serial_port *port)
813 {
814         usb_serial_generic_close(port);
815
816         /* Clear both queues; cp2108 needs this to avoid an occasional hang */
817         cp210x_write_u16_reg(port, CP210X_PURGE, PURGE_ALL);
818
819         cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
820 }
821
822 /*
823  * Read how many bytes are waiting in the TX queue.
824  */
825 static int cp210x_get_tx_queue_byte_count(struct usb_serial_port *port,
826                 u32 *count)
827 {
828         struct usb_serial *serial = port->serial;
829         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
830         struct cp210x_comm_status *sts;
831         int result;
832
833         sts = kmalloc(sizeof(*sts), GFP_KERNEL);
834         if (!sts)
835                 return -ENOMEM;
836
837         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
838                         CP210X_GET_COMM_STATUS, REQTYPE_INTERFACE_TO_HOST,
839                         0, port_priv->bInterfaceNumber, sts, sizeof(*sts),
840                         USB_CTRL_GET_TIMEOUT);
841         if (result == sizeof(*sts)) {
842                 *count = le32_to_cpu(sts->ulAmountInOutQueue);
843                 result = 0;
844         } else {
845                 dev_err(&port->dev, "failed to get comm status: %d\n", result);
846                 if (result >= 0)
847                         result = -EIO;
848         }
849
850         kfree(sts);
851
852         return result;
853 }
854
855 static bool cp210x_tx_empty(struct usb_serial_port *port)
856 {
857         int err;
858         u32 count;
859
860         err = cp210x_get_tx_queue_byte_count(port, &count);
861         if (err)
862                 return true;
863
864         return !count;
865 }
866
867 /*
868  * cp210x_get_termios
869  * Reads the baud rate, data bits, parity, stop bits and flow control mode
870  * from the device, corrects any unsupported values, and configures the
871  * termios structure to reflect the state of the device
872  */
873 static void cp210x_get_termios(struct tty_struct *tty,
874         struct usb_serial_port *port)
875 {
876         unsigned int baud;
877
878         if (tty) {
879                 cp210x_get_termios_port(tty->driver_data,
880                         &tty->termios.c_cflag, &baud);
881                 tty_encode_baud_rate(tty, baud, baud);
882         } else {
883                 tcflag_t cflag;
884                 cflag = 0;
885                 cp210x_get_termios_port(port, &cflag, &baud);
886         }
887 }
888
889 /*
890  * cp210x_get_termios_port
891  * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
892  */
893 static void cp210x_get_termios_port(struct usb_serial_port *port,
894         tcflag_t *cflagp, unsigned int *baudp)
895 {
896         struct device *dev = &port->dev;
897         tcflag_t cflag;
898         struct cp210x_flow_ctl flow_ctl;
899         u32 baud;
900         u16 bits;
901         u32 ctl_hs;
902
903         cp210x_read_u32_reg(port, CP210X_GET_BAUDRATE, &baud);
904
905         dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud);
906         *baudp = baud;
907
908         cflag = *cflagp;
909
910         cp210x_get_line_ctl(port, &bits);
911         cflag &= ~CSIZE;
912         switch (bits & BITS_DATA_MASK) {
913         case BITS_DATA_5:
914                 dev_dbg(dev, "%s - data bits = 5\n", __func__);
915                 cflag |= CS5;
916                 break;
917         case BITS_DATA_6:
918                 dev_dbg(dev, "%s - data bits = 6\n", __func__);
919                 cflag |= CS6;
920                 break;
921         case BITS_DATA_7:
922                 dev_dbg(dev, "%s - data bits = 7\n", __func__);
923                 cflag |= CS7;
924                 break;
925         case BITS_DATA_8:
926                 dev_dbg(dev, "%s - data bits = 8\n", __func__);
927                 cflag |= CS8;
928                 break;
929         case BITS_DATA_9:
930                 dev_dbg(dev, "%s - data bits = 9 (not supported, using 8 data bits)\n", __func__);
931                 cflag |= CS8;
932                 bits &= ~BITS_DATA_MASK;
933                 bits |= BITS_DATA_8;
934                 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
935                 break;
936         default:
937                 dev_dbg(dev, "%s - Unknown number of data bits, using 8\n", __func__);
938                 cflag |= CS8;
939                 bits &= ~BITS_DATA_MASK;
940                 bits |= BITS_DATA_8;
941                 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
942                 break;
943         }
944
945         switch (bits & BITS_PARITY_MASK) {
946         case BITS_PARITY_NONE:
947                 dev_dbg(dev, "%s - parity = NONE\n", __func__);
948                 cflag &= ~PARENB;
949                 break;
950         case BITS_PARITY_ODD:
951                 dev_dbg(dev, "%s - parity = ODD\n", __func__);
952                 cflag |= (PARENB|PARODD);
953                 break;
954         case BITS_PARITY_EVEN:
955                 dev_dbg(dev, "%s - parity = EVEN\n", __func__);
956                 cflag &= ~PARODD;
957                 cflag |= PARENB;
958                 break;
959         case BITS_PARITY_MARK:
960                 dev_dbg(dev, "%s - parity = MARK\n", __func__);
961                 cflag |= (PARENB|PARODD|CMSPAR);
962                 break;
963         case BITS_PARITY_SPACE:
964                 dev_dbg(dev, "%s - parity = SPACE\n", __func__);
965                 cflag &= ~PARODD;
966                 cflag |= (PARENB|CMSPAR);
967                 break;
968         default:
969                 dev_dbg(dev, "%s - Unknown parity mode, disabling parity\n", __func__);
970                 cflag &= ~PARENB;
971                 bits &= ~BITS_PARITY_MASK;
972                 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
973                 break;
974         }
975
976         cflag &= ~CSTOPB;
977         switch (bits & BITS_STOP_MASK) {
978         case BITS_STOP_1:
979                 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
980                 break;
981         case BITS_STOP_1_5:
982                 dev_dbg(dev, "%s - stop bits = 1.5 (not supported, using 1 stop bit)\n", __func__);
983                 bits &= ~BITS_STOP_MASK;
984                 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
985                 break;
986         case BITS_STOP_2:
987                 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
988                 cflag |= CSTOPB;
989                 break;
990         default:
991                 dev_dbg(dev, "%s - Unknown number of stop bits, using 1 stop bit\n", __func__);
992                 bits &= ~BITS_STOP_MASK;
993                 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
994                 break;
995         }
996
997         cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
998                         sizeof(flow_ctl));
999         ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1000         if (ctl_hs & CP210X_SERIAL_CTS_HANDSHAKE) {
1001                 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
1002                 cflag |= CRTSCTS;
1003         } else {
1004                 dev_dbg(dev, "%s - flow control = NONE\n", __func__);
1005                 cflag &= ~CRTSCTS;
1006         }
1007
1008         *cflagp = cflag;
1009 }
1010
1011 /*
1012  * CP2101 supports the following baud rates:
1013  *
1014  *      300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
1015  *      38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
1016  *
1017  * CP2102 and CP2103 support the following additional rates:
1018  *
1019  *      4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
1020  *      576000
1021  *
1022  * The device will map a requested rate to a supported one, but the result
1023  * of requests for rates greater than 1053257 is undefined (see AN205).
1024  *
1025  * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
1026  * respectively, with an error less than 1%. The actual rates are determined
1027  * by
1028  *
1029  *      div = round(freq / (2 x prescale x request))
1030  *      actual = freq / (2 x prescale x div)
1031  *
1032  * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
1033  * or 1 otherwise.
1034  * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
1035  * otherwise.
1036  */
1037 static void cp210x_change_speed(struct tty_struct *tty,
1038                 struct usb_serial_port *port, struct ktermios *old_termios)
1039 {
1040         u32 baud;
1041
1042         baud = tty->termios.c_ospeed;
1043
1044         /* This maps the requested rate to a rate valid on cp2102 or cp2103,
1045          * or to an arbitrary rate in [1M,2M].
1046          *
1047          * NOTE: B0 is not implemented.
1048          */
1049         baud = cp210x_quantise_baudrate(baud);
1050
1051         dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
1052         if (cp210x_write_u32_reg(port, CP210X_SET_BAUDRATE, baud)) {
1053                 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
1054                 if (old_termios)
1055                         baud = old_termios->c_ospeed;
1056                 else
1057                         baud = 9600;
1058         }
1059
1060         tty_encode_baud_rate(tty, baud, baud);
1061 }
1062
1063 static void cp210x_set_termios(struct tty_struct *tty,
1064                 struct usb_serial_port *port, struct ktermios *old_termios)
1065 {
1066         struct device *dev = &port->dev;
1067         unsigned int cflag, old_cflag;
1068         u16 bits;
1069
1070         cflag = tty->termios.c_cflag;
1071         old_cflag = old_termios->c_cflag;
1072
1073         if (tty->termios.c_ospeed != old_termios->c_ospeed)
1074                 cp210x_change_speed(tty, port, old_termios);
1075
1076         /* If the number of data bits is to be updated */
1077         if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
1078                 cp210x_get_line_ctl(port, &bits);
1079                 bits &= ~BITS_DATA_MASK;
1080                 switch (cflag & CSIZE) {
1081                 case CS5:
1082                         bits |= BITS_DATA_5;
1083                         dev_dbg(dev, "%s - data bits = 5\n", __func__);
1084                         break;
1085                 case CS6:
1086                         bits |= BITS_DATA_6;
1087                         dev_dbg(dev, "%s - data bits = 6\n", __func__);
1088                         break;
1089                 case CS7:
1090                         bits |= BITS_DATA_7;
1091                         dev_dbg(dev, "%s - data bits = 7\n", __func__);
1092                         break;
1093                 case CS8:
1094                 default:
1095                         bits |= BITS_DATA_8;
1096                         dev_dbg(dev, "%s - data bits = 8\n", __func__);
1097                         break;
1098                 }
1099                 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1100                         dev_dbg(dev, "Number of data bits requested not supported by device\n");
1101         }
1102
1103         if ((cflag     & (PARENB|PARODD|CMSPAR)) !=
1104             (old_cflag & (PARENB|PARODD|CMSPAR))) {
1105                 cp210x_get_line_ctl(port, &bits);
1106                 bits &= ~BITS_PARITY_MASK;
1107                 if (cflag & PARENB) {
1108                         if (cflag & CMSPAR) {
1109                                 if (cflag & PARODD) {
1110                                         bits |= BITS_PARITY_MARK;
1111                                         dev_dbg(dev, "%s - parity = MARK\n", __func__);
1112                                 } else {
1113                                         bits |= BITS_PARITY_SPACE;
1114                                         dev_dbg(dev, "%s - parity = SPACE\n", __func__);
1115                                 }
1116                         } else {
1117                                 if (cflag & PARODD) {
1118                                         bits |= BITS_PARITY_ODD;
1119                                         dev_dbg(dev, "%s - parity = ODD\n", __func__);
1120                                 } else {
1121                                         bits |= BITS_PARITY_EVEN;
1122                                         dev_dbg(dev, "%s - parity = EVEN\n", __func__);
1123                                 }
1124                         }
1125                 }
1126                 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1127                         dev_dbg(dev, "Parity mode not supported by device\n");
1128         }
1129
1130         if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
1131                 cp210x_get_line_ctl(port, &bits);
1132                 bits &= ~BITS_STOP_MASK;
1133                 if (cflag & CSTOPB) {
1134                         bits |= BITS_STOP_2;
1135                         dev_dbg(dev, "%s - stop bits = 2\n", __func__);
1136                 } else {
1137                         bits |= BITS_STOP_1;
1138                         dev_dbg(dev, "%s - stop bits = 1\n", __func__);
1139                 }
1140                 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1141                         dev_dbg(dev, "Number of stop bits requested not supported by device\n");
1142         }
1143
1144         if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
1145                 struct cp210x_flow_ctl flow_ctl;
1146                 u32 ctl_hs;
1147                 u32 flow_repl;
1148
1149                 cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1150                                 sizeof(flow_ctl));
1151                 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1152                 flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1153                 dev_dbg(dev, "%s - read ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1154                                 __func__, ctl_hs, flow_repl);
1155
1156                 ctl_hs &= ~CP210X_SERIAL_DSR_HANDSHAKE;
1157                 ctl_hs &= ~CP210X_SERIAL_DCD_HANDSHAKE;
1158                 ctl_hs &= ~CP210X_SERIAL_DSR_SENSITIVITY;
1159                 ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1160                 ctl_hs |= CP210X_SERIAL_DTR_SHIFT(CP210X_SERIAL_DTR_ACTIVE);
1161                 if (cflag & CRTSCTS) {
1162                         ctl_hs |= CP210X_SERIAL_CTS_HANDSHAKE;
1163
1164                         flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1165                         flow_repl |= CP210X_SERIAL_RTS_SHIFT(
1166                                         CP210X_SERIAL_RTS_FLOW_CTL);
1167                         dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
1168                 } else {
1169                         ctl_hs &= ~CP210X_SERIAL_CTS_HANDSHAKE;
1170
1171                         flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1172                         flow_repl |= CP210X_SERIAL_RTS_SHIFT(
1173                                         CP210X_SERIAL_RTS_ACTIVE);
1174                         dev_dbg(dev, "%s - flow control = NONE\n", __func__);
1175                 }
1176
1177                 dev_dbg(dev, "%s - write ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1178                                 __func__, ctl_hs, flow_repl);
1179                 flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1180                 flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1181                 cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1182                                 sizeof(flow_ctl));
1183         }
1184
1185 }
1186
1187 static int cp210x_tiocmset(struct tty_struct *tty,
1188                 unsigned int set, unsigned int clear)
1189 {
1190         struct usb_serial_port *port = tty->driver_data;
1191         return cp210x_tiocmset_port(port, set, clear);
1192 }
1193
1194 static int cp210x_tiocmset_port(struct usb_serial_port *port,
1195                 unsigned int set, unsigned int clear)
1196 {
1197         u16 control = 0;
1198
1199         if (set & TIOCM_RTS) {
1200                 control |= CONTROL_RTS;
1201                 control |= CONTROL_WRITE_RTS;
1202         }
1203         if (set & TIOCM_DTR) {
1204                 control |= CONTROL_DTR;
1205                 control |= CONTROL_WRITE_DTR;
1206         }
1207         if (clear & TIOCM_RTS) {
1208                 control &= ~CONTROL_RTS;
1209                 control |= CONTROL_WRITE_RTS;
1210         }
1211         if (clear & TIOCM_DTR) {
1212                 control &= ~CONTROL_DTR;
1213                 control |= CONTROL_WRITE_DTR;
1214         }
1215
1216         dev_dbg(&port->dev, "%s - control = 0x%.4x\n", __func__, control);
1217
1218         return cp210x_write_u16_reg(port, CP210X_SET_MHS, control);
1219 }
1220
1221 static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
1222 {
1223         if (on)
1224                 cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
1225         else
1226                 cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
1227 }
1228
1229 static int cp210x_tiocmget(struct tty_struct *tty)
1230 {
1231         struct usb_serial_port *port = tty->driver_data;
1232         u8 control;
1233         int result;
1234
1235         result = cp210x_read_u8_reg(port, CP210X_GET_MDMSTS, &control);
1236         if (result)
1237                 return result;
1238
1239         result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
1240                 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
1241                 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
1242                 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
1243                 |((control & CONTROL_RING)? TIOCM_RI  : 0)
1244                 |((control & CONTROL_DCD) ? TIOCM_CD  : 0);
1245
1246         dev_dbg(&port->dev, "%s - control = 0x%.2x\n", __func__, control);
1247
1248         return result;
1249 }
1250
1251 static void cp210x_break_ctl(struct tty_struct *tty, int break_state)
1252 {
1253         struct usb_serial_port *port = tty->driver_data;
1254         u16 state;
1255
1256         if (break_state == 0)
1257                 state = BREAK_OFF;
1258         else
1259                 state = BREAK_ON;
1260         dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
1261                 state == BREAK_OFF ? "off" : "on");
1262         cp210x_write_u16_reg(port, CP210X_SET_BREAK, state);
1263 }
1264
1265 #ifdef CONFIG_GPIOLIB
1266 static int cp210x_gpio_request(struct gpio_chip *gc, unsigned int offset)
1267 {
1268         struct usb_serial *serial = gpiochip_get_data(gc);
1269         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1270
1271         switch (offset) {
1272         case 0:
1273                 if (priv->config & CP2105_GPIO0_TXLED_MODE)
1274                         return -ENODEV;
1275                 break;
1276         case 1:
1277                 if (priv->config & (CP2105_GPIO1_RXLED_MODE |
1278                                     CP2105_GPIO1_RS485_MODE))
1279                         return -ENODEV;
1280                 break;
1281         }
1282
1283         return 0;
1284 }
1285
1286 static int cp210x_gpio_get(struct gpio_chip *gc, unsigned int gpio)
1287 {
1288         struct usb_serial *serial = gpiochip_get_data(gc);
1289         int result;
1290         u8 buf;
1291
1292         result = cp210x_read_vendor_block(serial, REQTYPE_INTERFACE_TO_HOST,
1293                                           CP210X_READ_LATCH, &buf, sizeof(buf));
1294         if (result < 0)
1295                 return result;
1296
1297         return !!(buf & BIT(gpio));
1298 }
1299
1300 static void cp210x_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)
1301 {
1302         struct usb_serial *serial = gpiochip_get_data(gc);
1303         struct cp210x_gpio_write buf;
1304
1305         if (value == 1)
1306                 buf.state = BIT(gpio);
1307         else
1308                 buf.state = 0;
1309
1310         buf.mask = BIT(gpio);
1311
1312         cp210x_write_vendor_block(serial, REQTYPE_HOST_TO_INTERFACE,
1313                                   CP210X_WRITE_LATCH, &buf, sizeof(buf));
1314 }
1315
1316 static int cp210x_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
1317 {
1318         /* Hardware does not support an input mode */
1319         return 0;
1320 }
1321
1322 static int cp210x_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
1323 {
1324         /* Hardware does not support an input mode */
1325         return -ENOTSUPP;
1326 }
1327
1328 static int cp210x_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
1329                                         int value)
1330 {
1331         return 0;
1332 }
1333
1334 static int cp210x_gpio_set_config(struct gpio_chip *gc, unsigned int gpio,
1335                                   unsigned long config)
1336 {
1337         struct usb_serial *serial = gpiochip_get_data(gc);
1338         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1339         enum pin_config_param param = pinconf_to_config_param(config);
1340
1341         /* Succeed only if in correct mode (this can't be set at runtime) */
1342         if ((param == PIN_CONFIG_DRIVE_PUSH_PULL) &&
1343             (priv->gpio_mode & BIT(gpio)))
1344                 return 0;
1345
1346         if ((param == PIN_CONFIG_DRIVE_OPEN_DRAIN) &&
1347             !(priv->gpio_mode & BIT(gpio)))
1348                 return 0;
1349
1350         return -ENOTSUPP;
1351 }
1352
1353 /*
1354  * This function is for configuring GPIO using shared pins, where other signals
1355  * are made unavailable by configuring the use of GPIO. This is believed to be
1356  * only applicable to the cp2105 at this point, the other devices supported by
1357  * this driver that provide GPIO do so in a way that does not impact other
1358  * signals and are thus expected to have very different initialisation.
1359  */
1360 static int cp2105_shared_gpio_init(struct usb_serial *serial)
1361 {
1362         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1363         struct cp210x_pin_mode mode;
1364         struct cp210x_config config;
1365         u8 intf_num = cp210x_interface_num(serial);
1366         int result;
1367
1368         result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1369                                           CP210X_GET_DEVICEMODE, &mode,
1370                                           sizeof(mode));
1371         if (result < 0)
1372                 return result;
1373
1374         result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1375                                           CP210X_GET_PORTCONFIG, &config,
1376                                           sizeof(config));
1377         if (result < 0)
1378                 return result;
1379
1380         /*  2 banks of GPIO - One for the pins taken from each serial port */
1381         if (intf_num == 0) {
1382                 if (mode.eci == CP210X_PIN_MODE_MODEM)
1383                         return 0;
1384
1385                 priv->config = config.eci_cfg;
1386                 priv->gpio_mode = (u8)((le16_to_cpu(config.gpio_mode) &
1387                                                 CP210X_ECI_GPIO_MODE_MASK) >>
1388                                                 CP210X_ECI_GPIO_MODE_OFFSET);
1389                 priv->gc.ngpio = 2;
1390         } else if (intf_num == 1) {
1391                 if (mode.sci == CP210X_PIN_MODE_MODEM)
1392                         return 0;
1393
1394                 priv->config = config.sci_cfg;
1395                 priv->gpio_mode = (u8)((le16_to_cpu(config.gpio_mode) &
1396                                                 CP210X_SCI_GPIO_MODE_MASK) >>
1397                                                 CP210X_SCI_GPIO_MODE_OFFSET);
1398                 priv->gc.ngpio = 3;
1399         } else {
1400                 return -ENODEV;
1401         }
1402
1403         priv->gc.label = "cp210x";
1404         priv->gc.request = cp210x_gpio_request;
1405         priv->gc.get_direction = cp210x_gpio_direction_get;
1406         priv->gc.direction_input = cp210x_gpio_direction_input;
1407         priv->gc.direction_output = cp210x_gpio_direction_output;
1408         priv->gc.get = cp210x_gpio_get;
1409         priv->gc.set = cp210x_gpio_set;
1410         priv->gc.set_config = cp210x_gpio_set_config;
1411         priv->gc.owner = THIS_MODULE;
1412         priv->gc.parent = &serial->interface->dev;
1413         priv->gc.base = -1;
1414         priv->gc.can_sleep = true;
1415
1416         result = gpiochip_add_data(&priv->gc, serial);
1417         if (!result)
1418                 priv->gpio_registered = true;
1419
1420         return result;
1421 }
1422
1423 static void cp210x_gpio_remove(struct usb_serial *serial)
1424 {
1425         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1426
1427         if (priv->gpio_registered) {
1428                 gpiochip_remove(&priv->gc);
1429                 priv->gpio_registered = false;
1430         }
1431 }
1432
1433 #else
1434
1435 static int cp2105_shared_gpio_init(struct usb_serial *serial)
1436 {
1437         return 0;
1438 }
1439
1440 static void cp210x_gpio_remove(struct usb_serial *serial)
1441 {
1442         /* Nothing to do */
1443 }
1444
1445 #endif
1446
1447 static int cp210x_port_probe(struct usb_serial_port *port)
1448 {
1449         struct usb_serial *serial = port->serial;
1450         struct cp210x_port_private *port_priv;
1451         int ret;
1452
1453         port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
1454         if (!port_priv)
1455                 return -ENOMEM;
1456
1457         port_priv->bInterfaceNumber = cp210x_interface_num(serial);
1458
1459         usb_set_serial_port_data(port, port_priv);
1460
1461         ret = cp210x_detect_swapped_line_ctl(port);
1462         if (ret) {
1463                 kfree(port_priv);
1464                 return ret;
1465         }
1466
1467         return 0;
1468 }
1469
1470 static int cp210x_port_remove(struct usb_serial_port *port)
1471 {
1472         struct cp210x_port_private *port_priv;
1473
1474         port_priv = usb_get_serial_port_data(port);
1475         kfree(port_priv);
1476
1477         return 0;
1478 }
1479
1480 static int cp210x_attach(struct usb_serial *serial)
1481 {
1482         int result;
1483         struct cp210x_serial_private *priv;
1484
1485         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1486         if (!priv)
1487                 return -ENOMEM;
1488
1489         result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1490                                           CP210X_GET_PARTNUM, &priv->partnum,
1491                                           sizeof(priv->partnum));
1492         if (result < 0)
1493                 goto err_free_priv;
1494
1495         usb_set_serial_data(serial, priv);
1496
1497         if (priv->partnum == CP210X_PARTNUM_CP2105) {
1498                 result = cp2105_shared_gpio_init(serial);
1499                 if (result < 0) {
1500                         dev_err(&serial->interface->dev,
1501                                 "GPIO initialisation failed, continuing without GPIO support\n");
1502                 }
1503         }
1504
1505         return 0;
1506 err_free_priv:
1507         kfree(priv);
1508
1509         return result;
1510 }
1511
1512 static void cp210x_disconnect(struct usb_serial *serial)
1513 {
1514         cp210x_gpio_remove(serial);
1515 }
1516
1517 static void cp210x_release(struct usb_serial *serial)
1518 {
1519         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1520
1521         cp210x_gpio_remove(serial);
1522
1523         kfree(priv);
1524 }
1525
1526 module_usb_serial_driver(serial_drivers, id_table);
1527
1528 MODULE_DESCRIPTION(DRIVER_DESC);
1529 MODULE_LICENSE("GPL");