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