1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Silicon Laboratories CP210x USB to RS232 serial adaptor driver
4  *
5  * Copyright (C) 2005 Craig Shelley (craig@microtron.org.uk)
6  *
7  * Support to set flow control line levels using TIOCMGET and TIOCMSET
8  * thanks to Karl Hiramoto karl@hiramoto.org. RTSCTS hardware flow
9  * control thanks to Munir Nassar nassarmu@real-time.com
10  *
11  */
12 
13 #include <linux/kernel.h>
14 #include <linux/errno.h>
15 #include <linux/slab.h>
16 #include <linux/tty.h>
17 #include <linux/tty_flip.h>
18 #include <linux/module.h>
19 #include <linux/moduleparam.h>
20 #include <linux/usb.h>
21 #include <linux/uaccess.h>
22 #include <linux/usb/serial.h>
23 #include <linux/gpio/driver.h>
24 #include <linux/bitops.h>
25 #include <linux/mutex.h>
26 
27 #define DRIVER_DESC "Silicon Labs CP210x RS232 serial adaptor driver"
28 
29 /*
30  * Function Prototypes
31  */
32 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *);
33 static void cp210x_close(struct usb_serial_port *);
34 static void cp210x_get_termios(struct tty_struct *, struct usb_serial_port *);
35 static void cp210x_get_termios_port(struct usb_serial_port *port,
36 	tcflag_t *cflagp, unsigned int *baudp);
37 static void cp210x_change_speed(struct tty_struct *, struct usb_serial_port *,
38 							struct ktermios *);
39 static void cp210x_set_termios(struct tty_struct *, struct usb_serial_port *,
40 							struct ktermios*);
41 static bool cp210x_tx_empty(struct usb_serial_port *port);
42 static int cp210x_tiocmget(struct tty_struct *);
43 static int cp210x_tiocmset(struct tty_struct *, unsigned int, unsigned int);
44 static int cp210x_tiocmset_port(struct usb_serial_port *port,
45 		unsigned int, unsigned int);
46 static void cp210x_break_ctl(struct tty_struct *, int);
47 static int cp210x_attach(struct usb_serial *);
48 static void cp210x_disconnect(struct usb_serial *);
49 static void cp210x_release(struct usb_serial *);
50 static int cp210x_port_probe(struct usb_serial_port *);
51 static int cp210x_port_remove(struct usb_serial_port *);
52 static void cp210x_dtr_rts(struct usb_serial_port *p, int on);
53 static void cp210x_process_read_urb(struct urb *urb);
54 static void cp210x_enable_event_mode(struct usb_serial_port *port);
55 static void cp210x_disable_event_mode(struct usb_serial_port *port);
56 
57 static const struct usb_device_id id_table[] = {
58 	{ USB_DEVICE(0x0404, 0x034C) },	/* NCR Retail IO Box */
59 	{ USB_DEVICE(0x045B, 0x0053) }, /* Renesas RX610 RX-Stick */
60 	{ USB_DEVICE(0x0471, 0x066A) }, /* AKTAKOM ACE-1001 cable */
61 	{ USB_DEVICE(0x0489, 0xE000) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
62 	{ USB_DEVICE(0x0489, 0xE003) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
63 	{ USB_DEVICE(0x0745, 0x1000) }, /* CipherLab USB CCD Barcode Scanner 1000 */
64 	{ USB_DEVICE(0x0846, 0x1100) }, /* NetGear Managed Switch M4100 series, M5300 series, M7100 series */
65 	{ USB_DEVICE(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
66 	{ USB_DEVICE(0x08FD, 0x000A) }, /* Digianswer A/S , ZigBee/802.15.4 MAC Device */
67 	{ USB_DEVICE(0x0908, 0x0070) }, /* Siemens SCALANCE LPE-9000 USB Serial Console */
68 	{ USB_DEVICE(0x0908, 0x01FF) }, /* Siemens RUGGEDCOM USB Serial Console */
69 	{ USB_DEVICE(0x0988, 0x0578) }, /* Teraoka AD2000 */
70 	{ USB_DEVICE(0x0B00, 0x3070) }, /* Ingenico 3070 */
71 	{ USB_DEVICE(0x0BED, 0x1100) }, /* MEI (TM) Cashflow-SC Bill/Voucher Acceptor */
72 	{ USB_DEVICE(0x0BED, 0x1101) }, /* MEI series 2000 Combo Acceptor */
73 	{ USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
74 	{ USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
75 	{ USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */
76 	{ USB_DEVICE(0x0FDE, 0xCA05) }, /* OWL Wireless Electricity Monitor CM-160 */
77 	{ USB_DEVICE(0x106F, 0x0003) },	/* CPI / Money Controls Bulk Coin Recycler */
78 	{ USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
79 	{ USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
80 	{ USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
81 	{ USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */
82 	{ USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */
83 	{ USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */
84 	{ USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
85 	{ USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
86 	{ USB_DEVICE(0x10C4, 0x8044) }, /* Cygnal Debug Adapter */
87 	{ USB_DEVICE(0x10C4, 0x804E) }, /* Software Bisque Paramount ME build-in converter */
88 	{ USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
89 	{ USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */
90 	{ USB_DEVICE(0x10C4, 0x8056) }, /* Lorenz Messtechnik devices */
91 	{ USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
92 	{ USB_DEVICE(0x10C4, 0x806F) }, /* IMS USB to RS422 Converter Cable */
93 	{ USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
94 	{ USB_DEVICE(0x10C4, 0x80C4) }, /* Cygnal Integrated Products, Inc., Optris infrared thermometer */
95 	{ USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
96 	{ USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
97 	{ USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
98 	{ USB_DEVICE(0x10C4, 0x8115) }, /* Arygon NFC/Mifare Reader */
99 	{ USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
100 	{ USB_DEVICE(0x10C4, 0x813F) }, /* Tams Master Easy Control */
101 	{ USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
102 	{ USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
103 	{ USB_DEVICE(0x2405, 0x0003) }, /* West Mountain Radio RIGblaster Advantage */
104 	{ USB_DEVICE(0x10C4, 0x8156) }, /* B&G H3000 link cable */
105 	{ USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
106 	{ USB_DEVICE(0x10C4, 0x815F) }, /* Timewave HamLinkUSB */
107 	{ USB_DEVICE(0x10C4, 0x817C) }, /* CESINEL MEDCAL N Power Quality Monitor */
108 	{ USB_DEVICE(0x10C4, 0x817D) }, /* CESINEL MEDCAL NT Power Quality Monitor */
109 	{ USB_DEVICE(0x10C4, 0x817E) }, /* CESINEL MEDCAL S Power Quality Monitor */
110 	{ USB_DEVICE(0x10C4, 0x818B) }, /* AVIT Research USB to TTL */
111 	{ USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
112 	{ USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
113 	{ USB_DEVICE(0x10C4, 0x81A9) }, /* Multiplex RC Interface */
114 	{ USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
115 	{ USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */
116 	{ USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
117 	{ USB_DEVICE(0x10C4, 0x81D7) }, /* IAI Corp. RCB-CV-USB USB to RS485 Adaptor */
118 	{ USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
119 	{ USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
120 	{ USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
121 	{ USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
122 	{ USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
123 	{ USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
124 	{ USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
125 	{ USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */
126 	{ USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
127 	{ USB_DEVICE(0x10C4, 0x82AA) }, /* Silicon Labs IFS-USB-DATACABLE used with Quint UPS */
128 	{ USB_DEVICE(0x10C4, 0x82EF) }, /* CESINEL FALCO 6105 AC Power Supply */
129 	{ USB_DEVICE(0x10C4, 0x82F1) }, /* CESINEL MEDCAL EFD Earth Fault Detector */
130 	{ USB_DEVICE(0x10C4, 0x82F2) }, /* CESINEL MEDCAL ST Network Analyzer */
131 	{ USB_DEVICE(0x10C4, 0x82F4) }, /* Starizona MicroTouch */
132 	{ USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
133 	{ USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
134 	{ USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
135 	{ USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
136 	{ USB_DEVICE(0x10C4, 0x83AA) }, /* Mark-10 Digital Force Gauge */
137 	{ USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
138 	{ USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
139 	{ USB_DEVICE(0x10C4, 0x8414) }, /* Decagon USB Cable Adapter */
140 	{ USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
141 	{ USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
142 	{ USB_DEVICE(0x10C4, 0x8470) }, /* Juniper Networks BX Series System Console */
143 	{ USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
144 	{ USB_DEVICE(0x10C4, 0x84B6) }, /* Starizona Hyperion */
145 	{ USB_DEVICE(0x10C4, 0x851E) }, /* CESINEL MEDCAL PT Network Analyzer */
146 	{ USB_DEVICE(0x10C4, 0x85A7) }, /* LifeScan OneTouch Verio IQ */
147 	{ USB_DEVICE(0x10C4, 0x85B8) }, /* CESINEL ReCon T Energy Logger */
148 	{ USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
149 	{ USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
150 	{ USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
151 	{ USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
152 	{ USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
153 	{ USB_DEVICE(0x10C4, 0x87ED) }, /* IMST USB-Stick for Smart Meter */
154 	{ USB_DEVICE(0x10C4, 0x8856) },	/* CEL EM357 ZigBee USB Stick - LR */
155 	{ USB_DEVICE(0x10C4, 0x8857) },	/* CEL EM357 ZigBee USB Stick */
156 	{ USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
157 	{ USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
158 	{ USB_DEVICE(0x10C4, 0x88D8) }, /* Acuity Brands nLight Air Adapter */
159 	{ USB_DEVICE(0x10C4, 0x88FB) }, /* CESINEL MEDCAL STII Network Analyzer */
160 	{ USB_DEVICE(0x10C4, 0x8938) }, /* CESINEL MEDCAL S II Network Analyzer */
161 	{ USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
162 	{ USB_DEVICE(0x10C4, 0x8962) }, /* Brim Brothers charging dock */
163 	{ USB_DEVICE(0x10C4, 0x8977) },	/* CEL MeshWorks DevKit Device */
164 	{ USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
165 	{ USB_DEVICE(0x10C4, 0x89A4) }, /* CESINEL FTBC Flexible Thyristor Bridge Controller */
166 	{ USB_DEVICE(0x10C4, 0x89FB) }, /* Qivicon ZigBee USB Radio Stick */
167 	{ USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
168 	{ USB_DEVICE(0x10C4, 0x8A5B) }, /* CEL EM3588 ZigBee USB Stick */
169 	{ USB_DEVICE(0x10C4, 0x8A5E) }, /* CEL EM3588 ZigBee USB Stick Long Range */
170 	{ USB_DEVICE(0x10C4, 0x8B34) }, /* Qivicon ZigBee USB Radio Stick */
171 	{ USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
172 	{ USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
173 	{ USB_DEVICE(0x10C4, 0xEA63) }, /* Silicon Labs Windows Update (CP2101-4/CP2102N) */
174 	{ USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
175 	{ USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
176 	{ USB_DEVICE(0x10C4, 0xEA7A) }, /* Silicon Labs Windows Update (CP2105) */
177 	{ USB_DEVICE(0x10C4, 0xEA7B) }, /* Silicon Labs Windows Update (CP2108) */
178 	{ USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
179 	{ USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
180 	{ USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
181 	{ USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
182 	{ USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
183 	{ USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
184 	{ USB_DEVICE(0x12B8, 0xEC60) }, /* Link G4 ECU */
185 	{ USB_DEVICE(0x12B8, 0xEC62) }, /* Link G4+ ECU */
186 	{ USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
187 	{ USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
188 	{ USB_DEVICE(0x155A, 0x1006) },	/* ELDAT Easywave RX09 */
189 	{ USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
190 	{ USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
191 	{ USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
192 	{ USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
193 	{ USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
194 	{ USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
195 	{ USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
196 	{ USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
197 	{ USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
198 	{ USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
199 	{ USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
200 	{ USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
201 	{ USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
202 	{ USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
203 	{ USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
204 	{ USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
205 	{ USB_DEVICE(0x17A8, 0x0011) }, /* Kamstrup 444 MHz RF sniffer */
206 	{ USB_DEVICE(0x17A8, 0x0013) }, /* Kamstrup 870 MHz RF sniffer */
207 	{ USB_DEVICE(0x17A8, 0x0101) }, /* Kamstrup 868 MHz wM-Bus C-Mode Meter Reader (Int Ant) */
208 	{ USB_DEVICE(0x17A8, 0x0102) }, /* Kamstrup 868 MHz wM-Bus C-Mode Meter Reader (Ext Ant) */
209 	{ USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
210 	{ USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
211 	{ USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
212 	{ USB_DEVICE(0x18EF, 0xE025) }, /* ELV Marble Sound Board 1 */
213 	{ USB_DEVICE(0x18EF, 0xE030) }, /* ELV ALC 8xxx Battery Charger */
214 	{ USB_DEVICE(0x18EF, 0xE032) }, /* ELV TFD500 Data Logger */
215 	{ USB_DEVICE(0x1901, 0x0190) }, /* GE B850 CP2105 Recorder interface */
216 	{ USB_DEVICE(0x1901, 0x0193) }, /* GE B650 CP2104 PMC interface */
217 	{ USB_DEVICE(0x1901, 0x0194) },	/* GE Healthcare Remote Alarm Box */
218 	{ USB_DEVICE(0x1901, 0x0195) },	/* GE B850/B650/B450 CP2104 DP UART interface */
219 	{ USB_DEVICE(0x1901, 0x0196) },	/* GE B850 CP2105 DP UART interface */
220 	{ USB_DEVICE(0x1901, 0x0197) }, /* GE CS1000 M.2 Key E serial interface */
221 	{ USB_DEVICE(0x1901, 0x0198) }, /* GE CS1000 Display serial interface */
222 	{ USB_DEVICE(0x199B, 0xBA30) }, /* LORD WSDA-200-USB */
223 	{ USB_DEVICE(0x19CF, 0x3000) }, /* Parrot NMEA GPS Flight Recorder */
224 	{ USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
225 	{ USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
226 	{ USB_DEVICE(0x1BA4, 0x0002) },	/* Silicon Labs 358x factory default */
227 	{ USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
228 	{ USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
229 	{ USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
230 	{ USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
231 	{ USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
232 	{ USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
233 	{ USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
234 	{ USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
235 	{ USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
236 	{ USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
237 	{ USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
238 	{ USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
239 	{ USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
240 	{ USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
241 	{ USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
242 	{ USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
243 	{ USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
244 	{ USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
245 	{ USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
246 	{ USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
247 	{ USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
248 	{ USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
249 	{ USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
250 	{ USB_DEVICE(0x2184, 0x0030) }, /* GW Instek GDM-834x Digital Multimeter */
251 	{ USB_DEVICE(0x2626, 0xEA60) }, /* Aruba Networks 7xxx USB Serial Console */
252 	{ USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
253 	{ USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
254 	{ USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
255 	{ USB_DEVICE(0x3923, 0x7A0B) }, /* National Instruments USB Serial Console */
256 	{ USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
257 	{ } /* Terminating Entry */
258 };
259 
260 MODULE_DEVICE_TABLE(usb, id_table);
261 
262 struct cp210x_serial_private {
263 #ifdef CONFIG_GPIOLIB
264 	struct gpio_chip	gc;
265 	bool			gpio_registered;
266 	u8			gpio_pushpull;
267 	u8			gpio_altfunc;
268 	u8			gpio_input;
269 #endif
270 	u8			partnum;
271 	speed_t			min_speed;
272 	speed_t			max_speed;
273 	bool			use_actual_rate;
274 	bool			no_event_mode;
275 };
276 
277 enum cp210x_event_state {
278 	ES_DATA,
279 	ES_ESCAPE,
280 	ES_LSR,
281 	ES_LSR_DATA_0,
282 	ES_LSR_DATA_1,
283 	ES_MSR
284 };
285 
286 struct cp210x_port_private {
287 	u8			bInterfaceNumber;
288 	bool			has_swapped_line_ctl;
289 	bool			event_mode;
290 	enum cp210x_event_state event_state;
291 	u8 lsr;
292 };
293 
294 static struct usb_serial_driver cp210x_device = {
295 	.driver = {
296 		.owner =	THIS_MODULE,
297 		.name =		"cp210x",
298 	},
299 	.id_table		= id_table,
300 	.num_ports		= 1,
301 	.bulk_in_size		= 256,
302 	.bulk_out_size		= 256,
303 	.open			= cp210x_open,
304 	.close			= cp210x_close,
305 	.break_ctl		= cp210x_break_ctl,
306 	.set_termios		= cp210x_set_termios,
307 	.tx_empty		= cp210x_tx_empty,
308 	.throttle		= usb_serial_generic_throttle,
309 	.unthrottle		= usb_serial_generic_unthrottle,
310 	.tiocmget		= cp210x_tiocmget,
311 	.tiocmset		= cp210x_tiocmset,
312 	.get_icount		= usb_serial_generic_get_icount,
313 	.attach			= cp210x_attach,
314 	.disconnect		= cp210x_disconnect,
315 	.release		= cp210x_release,
316 	.port_probe		= cp210x_port_probe,
317 	.port_remove		= cp210x_port_remove,
318 	.dtr_rts		= cp210x_dtr_rts,
319 	.process_read_urb	= cp210x_process_read_urb,
320 };
321 
322 static struct usb_serial_driver * const serial_drivers[] = {
323 	&cp210x_device, NULL
324 };
325 
326 /* Config request types */
327 #define REQTYPE_HOST_TO_INTERFACE	0x41
328 #define REQTYPE_INTERFACE_TO_HOST	0xc1
329 #define REQTYPE_HOST_TO_DEVICE	0x40
330 #define REQTYPE_DEVICE_TO_HOST	0xc0
331 
332 /* Config request codes */
333 #define CP210X_IFC_ENABLE	0x00
334 #define CP210X_SET_BAUDDIV	0x01
335 #define CP210X_GET_BAUDDIV	0x02
336 #define CP210X_SET_LINE_CTL	0x03
337 #define CP210X_GET_LINE_CTL	0x04
338 #define CP210X_SET_BREAK	0x05
339 #define CP210X_IMM_CHAR		0x06
340 #define CP210X_SET_MHS		0x07
341 #define CP210X_GET_MDMSTS	0x08
342 #define CP210X_SET_XON		0x09
343 #define CP210X_SET_XOFF		0x0A
344 #define CP210X_SET_EVENTMASK	0x0B
345 #define CP210X_GET_EVENTMASK	0x0C
346 #define CP210X_SET_CHAR		0x0D
347 #define CP210X_GET_CHARS	0x0E
348 #define CP210X_GET_PROPS	0x0F
349 #define CP210X_GET_COMM_STATUS	0x10
350 #define CP210X_RESET		0x11
351 #define CP210X_PURGE		0x12
352 #define CP210X_SET_FLOW		0x13
353 #define CP210X_GET_FLOW		0x14
354 #define CP210X_EMBED_EVENTS	0x15
355 #define CP210X_GET_EVENTSTATE	0x16
356 #define CP210X_SET_CHARS	0x19
357 #define CP210X_GET_BAUDRATE	0x1D
358 #define CP210X_SET_BAUDRATE	0x1E
359 #define CP210X_VENDOR_SPECIFIC	0xFF
360 
361 /* CP210X_IFC_ENABLE */
362 #define UART_ENABLE		0x0001
363 #define UART_DISABLE		0x0000
364 
365 /* CP210X_(SET|GET)_BAUDDIV */
366 #define BAUD_RATE_GEN_FREQ	0x384000
367 
368 /* CP210X_(SET|GET)_LINE_CTL */
369 #define BITS_DATA_MASK		0X0f00
370 #define BITS_DATA_5		0X0500
371 #define BITS_DATA_6		0X0600
372 #define BITS_DATA_7		0X0700
373 #define BITS_DATA_8		0X0800
374 #define BITS_DATA_9		0X0900
375 
376 #define BITS_PARITY_MASK	0x00f0
377 #define BITS_PARITY_NONE	0x0000
378 #define BITS_PARITY_ODD		0x0010
379 #define BITS_PARITY_EVEN	0x0020
380 #define BITS_PARITY_MARK	0x0030
381 #define BITS_PARITY_SPACE	0x0040
382 
383 #define BITS_STOP_MASK		0x000f
384 #define BITS_STOP_1		0x0000
385 #define BITS_STOP_1_5		0x0001
386 #define BITS_STOP_2		0x0002
387 
388 /* CP210X_SET_BREAK */
389 #define BREAK_ON		0x0001
390 #define BREAK_OFF		0x0000
391 
392 /* CP210X_(SET_MHS|GET_MDMSTS) */
393 #define CONTROL_DTR		0x0001
394 #define CONTROL_RTS		0x0002
395 #define CONTROL_CTS		0x0010
396 #define CONTROL_DSR		0x0020
397 #define CONTROL_RING		0x0040
398 #define CONTROL_DCD		0x0080
399 #define CONTROL_WRITE_DTR	0x0100
400 #define CONTROL_WRITE_RTS	0x0200
401 
402 /* CP210X_VENDOR_SPECIFIC values */
403 #define CP210X_READ_2NCONFIG	0x000E
404 #define CP210X_READ_LATCH	0x00C2
405 #define CP210X_GET_PARTNUM	0x370B
406 #define CP210X_GET_PORTCONFIG	0x370C
407 #define CP210X_GET_DEVICEMODE	0x3711
408 #define CP210X_WRITE_LATCH	0x37E1
409 
410 /* Part number definitions */
411 #define CP210X_PARTNUM_CP2101	0x01
412 #define CP210X_PARTNUM_CP2102	0x02
413 #define CP210X_PARTNUM_CP2103	0x03
414 #define CP210X_PARTNUM_CP2104	0x04
415 #define CP210X_PARTNUM_CP2105	0x05
416 #define CP210X_PARTNUM_CP2108	0x08
417 #define CP210X_PARTNUM_CP2102N_QFN28	0x20
418 #define CP210X_PARTNUM_CP2102N_QFN24	0x21
419 #define CP210X_PARTNUM_CP2102N_QFN20	0x22
420 #define CP210X_PARTNUM_UNKNOWN	0xFF
421 
422 /* CP210X_GET_COMM_STATUS returns these 0x13 bytes */
423 struct cp210x_comm_status {
424 	__le32   ulErrors;
425 	__le32   ulHoldReasons;
426 	__le32   ulAmountInInQueue;
427 	__le32   ulAmountInOutQueue;
428 	u8       bEofReceived;
429 	u8       bWaitForImmediate;
430 	u8       bReserved;
431 } __packed;
432 
433 /*
434  * CP210X_PURGE - 16 bits passed in wValue of USB request.
435  * SiLabs app note AN571 gives a strange description of the 4 bits:
436  * bit 0 or bit 2 clears the transmit queue and 1 or 3 receive.
437  * writing 1 to all, however, purges cp2108 well enough to avoid the hang.
438  */
439 #define PURGE_ALL		0x000f
440 
441 /* CP210X_EMBED_EVENTS */
442 #define CP210X_ESCCHAR		0xec
443 
444 #define CP210X_LSR_OVERRUN	BIT(1)
445 #define CP210X_LSR_PARITY	BIT(2)
446 #define CP210X_LSR_FRAME	BIT(3)
447 #define CP210X_LSR_BREAK	BIT(4)
448 
449 
450 /* CP210X_GET_FLOW/CP210X_SET_FLOW read/write these 0x10 bytes */
451 struct cp210x_flow_ctl {
452 	__le32	ulControlHandshake;
453 	__le32	ulFlowReplace;
454 	__le32	ulXonLimit;
455 	__le32	ulXoffLimit;
456 };
457 
458 /* cp210x_flow_ctl::ulControlHandshake */
459 #define CP210X_SERIAL_DTR_MASK		GENMASK(1, 0)
460 #define CP210X_SERIAL_DTR_SHIFT(_mode)	(_mode)
461 #define CP210X_SERIAL_CTS_HANDSHAKE	BIT(3)
462 #define CP210X_SERIAL_DSR_HANDSHAKE	BIT(4)
463 #define CP210X_SERIAL_DCD_HANDSHAKE	BIT(5)
464 #define CP210X_SERIAL_DSR_SENSITIVITY	BIT(6)
465 
466 /* values for cp210x_flow_ctl::ulControlHandshake::CP210X_SERIAL_DTR_MASK */
467 #define CP210X_SERIAL_DTR_INACTIVE	0
468 #define CP210X_SERIAL_DTR_ACTIVE	1
469 #define CP210X_SERIAL_DTR_FLOW_CTL	2
470 
471 /* cp210x_flow_ctl::ulFlowReplace */
472 #define CP210X_SERIAL_AUTO_TRANSMIT	BIT(0)
473 #define CP210X_SERIAL_AUTO_RECEIVE	BIT(1)
474 #define CP210X_SERIAL_ERROR_CHAR	BIT(2)
475 #define CP210X_SERIAL_NULL_STRIPPING	BIT(3)
476 #define CP210X_SERIAL_BREAK_CHAR	BIT(4)
477 #define CP210X_SERIAL_RTS_MASK		GENMASK(7, 6)
478 #define CP210X_SERIAL_RTS_SHIFT(_mode)	(_mode << 6)
479 #define CP210X_SERIAL_XOFF_CONTINUE	BIT(31)
480 
481 /* values for cp210x_flow_ctl::ulFlowReplace::CP210X_SERIAL_RTS_MASK */
482 #define CP210X_SERIAL_RTS_INACTIVE	0
483 #define CP210X_SERIAL_RTS_ACTIVE	1
484 #define CP210X_SERIAL_RTS_FLOW_CTL	2
485 
486 /* CP210X_VENDOR_SPECIFIC, CP210X_GET_DEVICEMODE call reads these 0x2 bytes. */
487 struct cp210x_pin_mode {
488 	u8	eci;
489 	u8	sci;
490 };
491 
492 #define CP210X_PIN_MODE_MODEM		0
493 #define CP210X_PIN_MODE_GPIO		BIT(0)
494 
495 /*
496  * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xf bytes
497  * on a CP2105 chip. Structure needs padding due to unused/unspecified bytes.
498  */
499 struct cp210x_dual_port_config {
500 	__le16	gpio_mode;
501 	u8	__pad0[2];
502 	__le16	reset_state;
503 	u8	__pad1[4];
504 	__le16	suspend_state;
505 	u8	sci_cfg;
506 	u8	eci_cfg;
507 	u8	device_cfg;
508 } __packed;
509 
510 /*
511  * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xd bytes
512  * on a CP2104 chip. Structure needs padding due to unused/unspecified bytes.
513  */
514 struct cp210x_single_port_config {
515 	__le16	gpio_mode;
516 	u8	__pad0[2];
517 	__le16	reset_state;
518 	u8	__pad1[4];
519 	__le16	suspend_state;
520 	u8	device_cfg;
521 } __packed;
522 
523 /* GPIO modes */
524 #define CP210X_SCI_GPIO_MODE_OFFSET	9
525 #define CP210X_SCI_GPIO_MODE_MASK	GENMASK(11, 9)
526 
527 #define CP210X_ECI_GPIO_MODE_OFFSET	2
528 #define CP210X_ECI_GPIO_MODE_MASK	GENMASK(3, 2)
529 
530 #define CP210X_GPIO_MODE_OFFSET		8
531 #define CP210X_GPIO_MODE_MASK		GENMASK(11, 8)
532 
533 /* CP2105 port configuration values */
534 #define CP2105_GPIO0_TXLED_MODE		BIT(0)
535 #define CP2105_GPIO1_RXLED_MODE		BIT(1)
536 #define CP2105_GPIO1_RS485_MODE		BIT(2)
537 
538 /* CP2104 port configuration values */
539 #define CP2104_GPIO0_TXLED_MODE		BIT(0)
540 #define CP2104_GPIO1_RXLED_MODE		BIT(1)
541 #define CP2104_GPIO2_RS485_MODE		BIT(2)
542 
543 /* CP2102N configuration array indices */
544 #define CP210X_2NCONFIG_CONFIG_VERSION_IDX	2
545 #define CP210X_2NCONFIG_GPIO_MODE_IDX		581
546 #define CP210X_2NCONFIG_GPIO_RSTLATCH_IDX	587
547 #define CP210X_2NCONFIG_GPIO_CONTROL_IDX	600
548 
549 /* CP2102N QFN20 port configuration values */
550 #define CP2102N_QFN20_GPIO2_TXLED_MODE		BIT(2)
551 #define CP2102N_QFN20_GPIO3_RXLED_MODE		BIT(3)
552 #define CP2102N_QFN20_GPIO1_RS485_MODE		BIT(4)
553 #define CP2102N_QFN20_GPIO0_CLK_MODE		BIT(6)
554 
555 /* CP210X_VENDOR_SPECIFIC, CP210X_WRITE_LATCH call writes these 0x2 bytes. */
556 struct cp210x_gpio_write {
557 	u8	mask;
558 	u8	state;
559 };
560 
561 /*
562  * Helper to get interface number when we only have struct usb_serial.
563  */
cp210x_interface_num(struct usb_serial *serial)564 static u8 cp210x_interface_num(struct usb_serial *serial)
565 {
566 	struct usb_host_interface *cur_altsetting;
567 
568 	cur_altsetting = serial->interface->cur_altsetting;
569 
570 	return cur_altsetting->desc.bInterfaceNumber;
571 }
572 
573 /*
574  * Reads a variable-sized block of CP210X_ registers, identified by req.
575  * Returns data into buf in native USB byte order.
576  */
cp210x_read_reg_block(struct usb_serial_port *port, u8 req, void *buf, int bufsize)577 static int cp210x_read_reg_block(struct usb_serial_port *port, u8 req,
578 		void *buf, int bufsize)
579 {
580 	struct usb_serial *serial = port->serial;
581 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
582 	void *dmabuf;
583 	int result;
584 
585 	dmabuf = kmalloc(bufsize, GFP_KERNEL);
586 	if (!dmabuf) {
587 		/*
588 		 * FIXME Some callers don't bother to check for error,
589 		 * at least give them consistent junk until they are fixed
590 		 */
591 		memset(buf, 0, bufsize);
592 		return -ENOMEM;
593 	}
594 
595 	result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
596 			req, REQTYPE_INTERFACE_TO_HOST, 0,
597 			port_priv->bInterfaceNumber, dmabuf, bufsize,
598 			USB_CTRL_SET_TIMEOUT);
599 	if (result == bufsize) {
600 		memcpy(buf, dmabuf, bufsize);
601 		result = 0;
602 	} else {
603 		dev_err(&port->dev, "failed get req 0x%x size %d status: %d\n",
604 				req, bufsize, result);
605 		if (result >= 0)
606 			result = -EIO;
607 
608 		/*
609 		 * FIXME Some callers don't bother to check for error,
610 		 * at least give them consistent junk until they are fixed
611 		 */
612 		memset(buf, 0, bufsize);
613 	}
614 
615 	kfree(dmabuf);
616 
617 	return result;
618 }
619 
620 /*
621  * Reads any 32-bit CP210X_ register identified by req.
622  */
cp210x_read_u32_reg(struct usb_serial_port *port, u8 req, u32 *val)623 static int cp210x_read_u32_reg(struct usb_serial_port *port, u8 req, u32 *val)
624 {
625 	__le32 le32_val;
626 	int err;
627 
628 	err = cp210x_read_reg_block(port, req, &le32_val, sizeof(le32_val));
629 	if (err) {
630 		/*
631 		 * FIXME Some callers don't bother to check for error,
632 		 * at least give them consistent junk until they are fixed
633 		 */
634 		*val = 0;
635 		return err;
636 	}
637 
638 	*val = le32_to_cpu(le32_val);
639 
640 	return 0;
641 }
642 
643 /*
644  * Reads any 16-bit CP210X_ register identified by req.
645  */
cp210x_read_u16_reg(struct usb_serial_port *port, u8 req, u16 *val)646 static int cp210x_read_u16_reg(struct usb_serial_port *port, u8 req, u16 *val)
647 {
648 	__le16 le16_val;
649 	int err;
650 
651 	err = cp210x_read_reg_block(port, req, &le16_val, sizeof(le16_val));
652 	if (err)
653 		return err;
654 
655 	*val = le16_to_cpu(le16_val);
656 
657 	return 0;
658 }
659 
660 /*
661  * Reads any 8-bit CP210X_ register identified by req.
662  */
cp210x_read_u8_reg(struct usb_serial_port *port, u8 req, u8 *val)663 static int cp210x_read_u8_reg(struct usb_serial_port *port, u8 req, u8 *val)
664 {
665 	return cp210x_read_reg_block(port, req, val, sizeof(*val));
666 }
667 
668 /*
669  * Reads a variable-sized vendor block of CP210X_ registers, identified by val.
670  * Returns data into buf in native USB byte order.
671  */
cp210x_read_vendor_block(struct usb_serial *serial, u8 type, u16 val, void *buf, int bufsize)672 static int cp210x_read_vendor_block(struct usb_serial *serial, u8 type, u16 val,
673 				    void *buf, int bufsize)
674 {
675 	void *dmabuf;
676 	int result;
677 
678 	dmabuf = kmalloc(bufsize, GFP_KERNEL);
679 	if (!dmabuf)
680 		return -ENOMEM;
681 
682 	result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
683 				 CP210X_VENDOR_SPECIFIC, type, val,
684 				 cp210x_interface_num(serial), dmabuf, bufsize,
685 				 USB_CTRL_GET_TIMEOUT);
686 	if (result == bufsize) {
687 		memcpy(buf, dmabuf, bufsize);
688 		result = 0;
689 	} else {
690 		dev_err(&serial->interface->dev,
691 			"failed to get vendor val 0x%04x size %d: %d\n", val,
692 			bufsize, result);
693 		if (result >= 0)
694 			result = -EIO;
695 	}
696 
697 	kfree(dmabuf);
698 
699 	return result;
700 }
701 
702 /*
703  * Writes any 16-bit CP210X_ register (req) whose value is passed
704  * entirely in the wValue field of the USB request.
705  */
cp210x_write_u16_reg(struct usb_serial_port *port, u8 req, u16 val)706 static int cp210x_write_u16_reg(struct usb_serial_port *port, u8 req, u16 val)
707 {
708 	struct usb_serial *serial = port->serial;
709 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
710 	int result;
711 
712 	result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
713 			req, REQTYPE_HOST_TO_INTERFACE, val,
714 			port_priv->bInterfaceNumber, NULL, 0,
715 			USB_CTRL_SET_TIMEOUT);
716 	if (result < 0) {
717 		dev_err(&port->dev, "failed set request 0x%x status: %d\n",
718 				req, result);
719 	}
720 
721 	return result;
722 }
723 
724 /*
725  * Writes a variable-sized block of CP210X_ registers, identified by req.
726  * Data in buf must be in native USB byte order.
727  */
cp210x_write_reg_block(struct usb_serial_port *port, u8 req, void *buf, int bufsize)728 static int cp210x_write_reg_block(struct usb_serial_port *port, u8 req,
729 		void *buf, int bufsize)
730 {
731 	struct usb_serial *serial = port->serial;
732 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
733 	void *dmabuf;
734 	int result;
735 
736 	dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
737 	if (!dmabuf)
738 		return -ENOMEM;
739 
740 	result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
741 			req, REQTYPE_HOST_TO_INTERFACE, 0,
742 			port_priv->bInterfaceNumber, dmabuf, bufsize,
743 			USB_CTRL_SET_TIMEOUT);
744 
745 	kfree(dmabuf);
746 
747 	if (result == bufsize) {
748 		result = 0;
749 	} else {
750 		dev_err(&port->dev, "failed set req 0x%x size %d status: %d\n",
751 				req, bufsize, result);
752 		if (result >= 0)
753 			result = -EIO;
754 	}
755 
756 	return result;
757 }
758 
759 /*
760  * Writes any 32-bit CP210X_ register identified by req.
761  */
cp210x_write_u32_reg(struct usb_serial_port *port, u8 req, u32 val)762 static int cp210x_write_u32_reg(struct usb_serial_port *port, u8 req, u32 val)
763 {
764 	__le32 le32_val;
765 
766 	le32_val = cpu_to_le32(val);
767 
768 	return cp210x_write_reg_block(port, req, &le32_val, sizeof(le32_val));
769 }
770 
771 #ifdef CONFIG_GPIOLIB
772 /*
773  * Writes a variable-sized vendor block of CP210X_ registers, identified by val.
774  * Data in buf must be in native USB byte order.
775  */
cp210x_write_vendor_block(struct usb_serial *serial, u8 type, u16 val, void *buf, int bufsize)776 static int cp210x_write_vendor_block(struct usb_serial *serial, u8 type,
777 				     u16 val, void *buf, int bufsize)
778 {
779 	void *dmabuf;
780 	int result;
781 
782 	dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
783 	if (!dmabuf)
784 		return -ENOMEM;
785 
786 	result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
787 				 CP210X_VENDOR_SPECIFIC, type, val,
788 				 cp210x_interface_num(serial), dmabuf, bufsize,
789 				 USB_CTRL_SET_TIMEOUT);
790 
791 	kfree(dmabuf);
792 
793 	if (result == bufsize) {
794 		result = 0;
795 	} else {
796 		dev_err(&serial->interface->dev,
797 			"failed to set vendor val 0x%04x size %d: %d\n", val,
798 			bufsize, result);
799 		if (result >= 0)
800 			result = -EIO;
801 	}
802 
803 	return result;
804 }
805 #endif
806 
807 /*
808  * Detect CP2108 GET_LINE_CTL bug and activate workaround.
809  * Write a known good value 0x800, read it back.
810  * If it comes back swapped the bug is detected.
811  * Preserve the original register value.
812  */
cp210x_detect_swapped_line_ctl(struct usb_serial_port *port)813 static int cp210x_detect_swapped_line_ctl(struct usb_serial_port *port)
814 {
815 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
816 	u16 line_ctl_save;
817 	u16 line_ctl_test;
818 	int err;
819 
820 	err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_save);
821 	if (err)
822 		return err;
823 
824 	err = cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, 0x800);
825 	if (err)
826 		return err;
827 
828 	err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_test);
829 	if (err)
830 		return err;
831 
832 	if (line_ctl_test == 8) {
833 		port_priv->has_swapped_line_ctl = true;
834 		line_ctl_save = swab16(line_ctl_save);
835 	}
836 
837 	return cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, line_ctl_save);
838 }
839 
840 /*
841  * Must always be called instead of cp210x_read_u16_reg(CP210X_GET_LINE_CTL)
842  * to workaround cp2108 bug and get correct value.
843  */
cp210x_get_line_ctl(struct usb_serial_port *port, u16 *ctl)844 static int cp210x_get_line_ctl(struct usb_serial_port *port, u16 *ctl)
845 {
846 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
847 	int err;
848 
849 	err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, ctl);
850 	if (err)
851 		return err;
852 
853 	/* Workaround swapped bytes in 16-bit value from CP210X_GET_LINE_CTL */
854 	if (port_priv->has_swapped_line_ctl)
855 		*ctl = swab16(*ctl);
856 
857 	return 0;
858 }
859 
cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)860 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
861 {
862 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
863 	int result;
864 
865 	result = cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_ENABLE);
866 	if (result) {
867 		dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
868 		return result;
869 	}
870 
871 	/* Configure the termios structure */
872 	cp210x_get_termios(tty, port);
873 
874 	if (tty) {
875 		/* The baud rate must be initialised on cp2104 */
876 		cp210x_change_speed(tty, port, NULL);
877 
878 		if (I_INPCK(tty))
879 			cp210x_enable_event_mode(port);
880 	}
881 
882 	result = usb_serial_generic_open(tty, port);
883 	if (result)
884 		goto err_disable;
885 
886 	return 0;
887 
888 err_disable:
889 	cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
890 	port_priv->event_mode = false;
891 
892 	return result;
893 }
894 
cp210x_close(struct usb_serial_port *port)895 static void cp210x_close(struct usb_serial_port *port)
896 {
897 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
898 
899 	usb_serial_generic_close(port);
900 
901 	/* Clear both queues; cp2108 needs this to avoid an occasional hang */
902 	cp210x_write_u16_reg(port, CP210X_PURGE, PURGE_ALL);
903 
904 	cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
905 
906 	/* Disabling the interface disables event-insertion mode. */
907 	port_priv->event_mode = false;
908 }
909 
cp210x_process_lsr(struct usb_serial_port *port, unsigned char lsr, char *flag)910 static void cp210x_process_lsr(struct usb_serial_port *port, unsigned char lsr, char *flag)
911 {
912 	if (lsr & CP210X_LSR_BREAK) {
913 		port->icount.brk++;
914 		*flag = TTY_BREAK;
915 	} else if (lsr & CP210X_LSR_PARITY) {
916 		port->icount.parity++;
917 		*flag = TTY_PARITY;
918 	} else if (lsr & CP210X_LSR_FRAME) {
919 		port->icount.frame++;
920 		*flag = TTY_FRAME;
921 	}
922 
923 	if (lsr & CP210X_LSR_OVERRUN) {
924 		port->icount.overrun++;
925 		tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
926 	}
927 }
928 
cp210x_process_char(struct usb_serial_port *port, unsigned char *ch, char *flag)929 static bool cp210x_process_char(struct usb_serial_port *port, unsigned char *ch, char *flag)
930 {
931 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
932 
933 	switch (port_priv->event_state) {
934 	case ES_DATA:
935 		if (*ch == CP210X_ESCCHAR) {
936 			port_priv->event_state = ES_ESCAPE;
937 			break;
938 		}
939 		return false;
940 	case ES_ESCAPE:
941 		switch (*ch) {
942 		case 0:
943 			dev_dbg(&port->dev, "%s - escape char\n", __func__);
944 			*ch = CP210X_ESCCHAR;
945 			port_priv->event_state = ES_DATA;
946 			return false;
947 		case 1:
948 			port_priv->event_state = ES_LSR_DATA_0;
949 			break;
950 		case 2:
951 			port_priv->event_state = ES_LSR;
952 			break;
953 		case 3:
954 			port_priv->event_state = ES_MSR;
955 			break;
956 		default:
957 			dev_err(&port->dev, "malformed event 0x%02x\n", *ch);
958 			port_priv->event_state = ES_DATA;
959 			break;
960 		}
961 		break;
962 	case ES_LSR_DATA_0:
963 		port_priv->lsr = *ch;
964 		port_priv->event_state = ES_LSR_DATA_1;
965 		break;
966 	case ES_LSR_DATA_1:
967 		dev_dbg(&port->dev, "%s - lsr = 0x%02x, data = 0x%02x\n",
968 				__func__, port_priv->lsr, *ch);
969 		cp210x_process_lsr(port, port_priv->lsr, flag);
970 		port_priv->event_state = ES_DATA;
971 		return false;
972 	case ES_LSR:
973 		dev_dbg(&port->dev, "%s - lsr = 0x%02x\n", __func__, *ch);
974 		port_priv->lsr = *ch;
975 		cp210x_process_lsr(port, port_priv->lsr, flag);
976 		port_priv->event_state = ES_DATA;
977 		break;
978 	case ES_MSR:
979 		dev_dbg(&port->dev, "%s - msr = 0x%02x\n", __func__, *ch);
980 		/* unimplemented */
981 		port_priv->event_state = ES_DATA;
982 		break;
983 	}
984 
985 	return true;
986 }
987 
cp210x_process_read_urb(struct urb *urb)988 static void cp210x_process_read_urb(struct urb *urb)
989 {
990 	struct usb_serial_port *port = urb->context;
991 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
992 	unsigned char *ch = urb->transfer_buffer;
993 	char flag;
994 	int i;
995 
996 	if (!urb->actual_length)
997 		return;
998 
999 	if (port_priv->event_mode) {
1000 		for (i = 0; i < urb->actual_length; i++, ch++) {
1001 			flag = TTY_NORMAL;
1002 
1003 			if (cp210x_process_char(port, ch, &flag))
1004 				continue;
1005 
1006 			tty_insert_flip_char(&port->port, *ch, flag);
1007 		}
1008 	} else {
1009 		tty_insert_flip_string(&port->port, ch, urb->actual_length);
1010 	}
1011 	tty_flip_buffer_push(&port->port);
1012 }
1013 
1014 /*
1015  * Read how many bytes are waiting in the TX queue.
1016  */
cp210x_get_tx_queue_byte_count(struct usb_serial_port *port, u32 *count)1017 static int cp210x_get_tx_queue_byte_count(struct usb_serial_port *port,
1018 		u32 *count)
1019 {
1020 	struct usb_serial *serial = port->serial;
1021 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1022 	struct cp210x_comm_status *sts;
1023 	int result;
1024 
1025 	sts = kmalloc(sizeof(*sts), GFP_KERNEL);
1026 	if (!sts)
1027 		return -ENOMEM;
1028 
1029 	result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
1030 			CP210X_GET_COMM_STATUS, REQTYPE_INTERFACE_TO_HOST,
1031 			0, port_priv->bInterfaceNumber, sts, sizeof(*sts),
1032 			USB_CTRL_GET_TIMEOUT);
1033 	if (result == sizeof(*sts)) {
1034 		*count = le32_to_cpu(sts->ulAmountInOutQueue);
1035 		result = 0;
1036 	} else {
1037 		dev_err(&port->dev, "failed to get comm status: %d\n", result);
1038 		if (result >= 0)
1039 			result = -EIO;
1040 	}
1041 
1042 	kfree(sts);
1043 
1044 	return result;
1045 }
1046 
cp210x_tx_empty(struct usb_serial_port *port)1047 static bool cp210x_tx_empty(struct usb_serial_port *port)
1048 {
1049 	int err;
1050 	u32 count;
1051 
1052 	err = cp210x_get_tx_queue_byte_count(port, &count);
1053 	if (err)
1054 		return true;
1055 
1056 	return !count;
1057 }
1058 
1059 /*
1060  * cp210x_get_termios
1061  * Reads the baud rate, data bits, parity, stop bits and flow control mode
1062  * from the device, corrects any unsupported values, and configures the
1063  * termios structure to reflect the state of the device
1064  */
cp210x_get_termios(struct tty_struct *tty, struct usb_serial_port *port)1065 static void cp210x_get_termios(struct tty_struct *tty,
1066 	struct usb_serial_port *port)
1067 {
1068 	unsigned int baud;
1069 
1070 	if (tty) {
1071 		cp210x_get_termios_port(tty->driver_data,
1072 			&tty->termios.c_cflag, &baud);
1073 		tty_encode_baud_rate(tty, baud, baud);
1074 	} else {
1075 		tcflag_t cflag;
1076 		cflag = 0;
1077 		cp210x_get_termios_port(port, &cflag, &baud);
1078 	}
1079 }
1080 
1081 /*
1082  * cp210x_get_termios_port
1083  * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
1084  */
cp210x_get_termios_port(struct usb_serial_port *port, tcflag_t *cflagp, unsigned int *baudp)1085 static void cp210x_get_termios_port(struct usb_serial_port *port,
1086 	tcflag_t *cflagp, unsigned int *baudp)
1087 {
1088 	struct device *dev = &port->dev;
1089 	tcflag_t cflag;
1090 	struct cp210x_flow_ctl flow_ctl;
1091 	u32 baud;
1092 	u16 bits;
1093 	u32 ctl_hs;
1094 	u32 flow_repl;
1095 
1096 	cp210x_read_u32_reg(port, CP210X_GET_BAUDRATE, &baud);
1097 
1098 	dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud);
1099 	*baudp = baud;
1100 
1101 	cflag = *cflagp;
1102 
1103 	cp210x_get_line_ctl(port, &bits);
1104 	cflag &= ~CSIZE;
1105 	switch (bits & BITS_DATA_MASK) {
1106 	case BITS_DATA_5:
1107 		dev_dbg(dev, "%s - data bits = 5\n", __func__);
1108 		cflag |= CS5;
1109 		break;
1110 	case BITS_DATA_6:
1111 		dev_dbg(dev, "%s - data bits = 6\n", __func__);
1112 		cflag |= CS6;
1113 		break;
1114 	case BITS_DATA_7:
1115 		dev_dbg(dev, "%s - data bits = 7\n", __func__);
1116 		cflag |= CS7;
1117 		break;
1118 	case BITS_DATA_8:
1119 		dev_dbg(dev, "%s - data bits = 8\n", __func__);
1120 		cflag |= CS8;
1121 		break;
1122 	case BITS_DATA_9:
1123 		dev_dbg(dev, "%s - data bits = 9 (not supported, using 8 data bits)\n", __func__);
1124 		cflag |= CS8;
1125 		bits &= ~BITS_DATA_MASK;
1126 		bits |= BITS_DATA_8;
1127 		cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
1128 		break;
1129 	default:
1130 		dev_dbg(dev, "%s - Unknown number of data bits, using 8\n", __func__);
1131 		cflag |= CS8;
1132 		bits &= ~BITS_DATA_MASK;
1133 		bits |= BITS_DATA_8;
1134 		cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
1135 		break;
1136 	}
1137 
1138 	switch (bits & BITS_PARITY_MASK) {
1139 	case BITS_PARITY_NONE:
1140 		dev_dbg(dev, "%s - parity = NONE\n", __func__);
1141 		cflag &= ~PARENB;
1142 		break;
1143 	case BITS_PARITY_ODD:
1144 		dev_dbg(dev, "%s - parity = ODD\n", __func__);
1145 		cflag |= (PARENB|PARODD);
1146 		break;
1147 	case BITS_PARITY_EVEN:
1148 		dev_dbg(dev, "%s - parity = EVEN\n", __func__);
1149 		cflag &= ~PARODD;
1150 		cflag |= PARENB;
1151 		break;
1152 	case BITS_PARITY_MARK:
1153 		dev_dbg(dev, "%s - parity = MARK\n", __func__);
1154 		cflag |= (PARENB|PARODD|CMSPAR);
1155 		break;
1156 	case BITS_PARITY_SPACE:
1157 		dev_dbg(dev, "%s - parity = SPACE\n", __func__);
1158 		cflag &= ~PARODD;
1159 		cflag |= (PARENB|CMSPAR);
1160 		break;
1161 	default:
1162 		dev_dbg(dev, "%s - Unknown parity mode, disabling parity\n", __func__);
1163 		cflag &= ~PARENB;
1164 		bits &= ~BITS_PARITY_MASK;
1165 		cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
1166 		break;
1167 	}
1168 
1169 	cflag &= ~CSTOPB;
1170 	switch (bits & BITS_STOP_MASK) {
1171 	case BITS_STOP_1:
1172 		dev_dbg(dev, "%s - stop bits = 1\n", __func__);
1173 		break;
1174 	case BITS_STOP_1_5:
1175 		dev_dbg(dev, "%s - stop bits = 1.5 (not supported, using 1 stop bit)\n", __func__);
1176 		bits &= ~BITS_STOP_MASK;
1177 		cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
1178 		break;
1179 	case BITS_STOP_2:
1180 		dev_dbg(dev, "%s - stop bits = 2\n", __func__);
1181 		cflag |= CSTOPB;
1182 		break;
1183 	default:
1184 		dev_dbg(dev, "%s - Unknown number of stop bits, using 1 stop bit\n", __func__);
1185 		bits &= ~BITS_STOP_MASK;
1186 		cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
1187 		break;
1188 	}
1189 
1190 	cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1191 			sizeof(flow_ctl));
1192 	ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1193 	if (ctl_hs & CP210X_SERIAL_CTS_HANDSHAKE) {
1194 		dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
1195 		/*
1196 		 * When the port is closed, the CP210x hardware disables
1197 		 * auto-RTS and RTS is deasserted but it leaves auto-CTS when
1198 		 * in hardware flow control mode. When re-opening the port, if
1199 		 * auto-CTS is enabled on the cp210x, then auto-RTS must be
1200 		 * re-enabled in the driver.
1201 		 */
1202 		flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1203 		flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1204 		flow_repl |= CP210X_SERIAL_RTS_SHIFT(CP210X_SERIAL_RTS_FLOW_CTL);
1205 		flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1206 		cp210x_write_reg_block(port,
1207 				CP210X_SET_FLOW,
1208 				&flow_ctl,
1209 				sizeof(flow_ctl));
1210 
1211 		cflag |= CRTSCTS;
1212 	} else {
1213 		dev_dbg(dev, "%s - flow control = NONE\n", __func__);
1214 		cflag &= ~CRTSCTS;
1215 	}
1216 
1217 	*cflagp = cflag;
1218 }
1219 
1220 struct cp210x_rate {
1221 	speed_t rate;
1222 	speed_t high;
1223 };
1224 
1225 static const struct cp210x_rate cp210x_an205_table1[] = {
1226 	{ 300, 300 },
1227 	{ 600, 600 },
1228 	{ 1200, 1200 },
1229 	{ 1800, 1800 },
1230 	{ 2400, 2400 },
1231 	{ 4000, 4000 },
1232 	{ 4800, 4803 },
1233 	{ 7200, 7207 },
1234 	{ 9600, 9612 },
1235 	{ 14400, 14428 },
1236 	{ 16000, 16062 },
1237 	{ 19200, 19250 },
1238 	{ 28800, 28912 },
1239 	{ 38400, 38601 },
1240 	{ 51200, 51558 },
1241 	{ 56000, 56280 },
1242 	{ 57600, 58053 },
1243 	{ 64000, 64111 },
1244 	{ 76800, 77608 },
1245 	{ 115200, 117028 },
1246 	{ 128000, 129347 },
1247 	{ 153600, 156868 },
1248 	{ 230400, 237832 },
1249 	{ 250000, 254234 },
1250 	{ 256000, 273066 },
1251 	{ 460800, 491520 },
1252 	{ 500000, 567138 },
1253 	{ 576000, 670254 },
1254 	{ 921600, UINT_MAX }
1255 };
1256 
1257 /*
1258  * Quantises the baud rate as per AN205 Table 1
1259  */
cp210x_get_an205_rate(speed_t baud)1260 static speed_t cp210x_get_an205_rate(speed_t baud)
1261 {
1262 	int i;
1263 
1264 	for (i = 0; i < ARRAY_SIZE(cp210x_an205_table1); ++i) {
1265 		if (baud <= cp210x_an205_table1[i].high)
1266 			break;
1267 	}
1268 
1269 	return cp210x_an205_table1[i].rate;
1270 }
1271 
cp210x_get_actual_rate(speed_t baud)1272 static speed_t cp210x_get_actual_rate(speed_t baud)
1273 {
1274 	unsigned int prescale = 1;
1275 	unsigned int div;
1276 
1277 	if (baud <= 365)
1278 		prescale = 4;
1279 
1280 	div = DIV_ROUND_CLOSEST(48000000, 2 * prescale * baud);
1281 	baud = 48000000 / (2 * prescale * div);
1282 
1283 	return baud;
1284 }
1285 
1286 /*
1287  * CP2101 supports the following baud rates:
1288  *
1289  *	300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
1290  *	38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
1291  *
1292  * CP2102 and CP2103 support the following additional rates:
1293  *
1294  *	4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
1295  *	576000
1296  *
1297  * The device will map a requested rate to a supported one, but the result
1298  * of requests for rates greater than 1053257 is undefined (see AN205).
1299  *
1300  * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
1301  * respectively, with an error less than 1%. The actual rates are determined
1302  * by
1303  *
1304  *	div = round(freq / (2 x prescale x request))
1305  *	actual = freq / (2 x prescale x div)
1306  *
1307  * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
1308  * or 1 otherwise.
1309  * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
1310  * otherwise.
1311  */
cp210x_change_speed(struct tty_struct *tty, struct usb_serial_port *port, struct ktermios *old_termios)1312 static void cp210x_change_speed(struct tty_struct *tty,
1313 		struct usb_serial_port *port, struct ktermios *old_termios)
1314 {
1315 	struct usb_serial *serial = port->serial;
1316 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1317 	u32 baud;
1318 
1319 	/*
1320 	 * This maps the requested rate to the actual rate, a valid rate on
1321 	 * cp2102 or cp2103, or to an arbitrary rate in [1M, max_speed].
1322 	 *
1323 	 * NOTE: B0 is not implemented.
1324 	 */
1325 	baud = clamp(tty->termios.c_ospeed, priv->min_speed, priv->max_speed);
1326 
1327 	if (priv->use_actual_rate)
1328 		baud = cp210x_get_actual_rate(baud);
1329 	else if (baud < 1000000)
1330 		baud = cp210x_get_an205_rate(baud);
1331 
1332 	dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
1333 	if (cp210x_write_u32_reg(port, CP210X_SET_BAUDRATE, baud)) {
1334 		dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
1335 		if (old_termios)
1336 			baud = old_termios->c_ospeed;
1337 		else
1338 			baud = 9600;
1339 	}
1340 
1341 	tty_encode_baud_rate(tty, baud, baud);
1342 }
1343 
cp210x_enable_event_mode(struct usb_serial_port *port)1344 static void cp210x_enable_event_mode(struct usb_serial_port *port)
1345 {
1346 	struct cp210x_serial_private *priv = usb_get_serial_data(port->serial);
1347 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1348 	int ret;
1349 
1350 	if (port_priv->event_mode)
1351 		return;
1352 
1353 	if (priv->no_event_mode)
1354 		return;
1355 
1356 	port_priv->event_state = ES_DATA;
1357 	port_priv->event_mode = true;
1358 
1359 	ret = cp210x_write_u16_reg(port, CP210X_EMBED_EVENTS, CP210X_ESCCHAR);
1360 	if (ret) {
1361 		dev_err(&port->dev, "failed to enable events: %d\n", ret);
1362 		port_priv->event_mode = false;
1363 	}
1364 }
1365 
cp210x_disable_event_mode(struct usb_serial_port *port)1366 static void cp210x_disable_event_mode(struct usb_serial_port *port)
1367 {
1368 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1369 	int ret;
1370 
1371 	if (!port_priv->event_mode)
1372 		return;
1373 
1374 	ret = cp210x_write_u16_reg(port, CP210X_EMBED_EVENTS, 0);
1375 	if (ret) {
1376 		dev_err(&port->dev, "failed to disable events: %d\n", ret);
1377 		return;
1378 	}
1379 
1380 	port_priv->event_mode = false;
1381 }
1382 
cp210x_set_termios(struct tty_struct *tty, struct usb_serial_port *port, struct ktermios *old_termios)1383 static void cp210x_set_termios(struct tty_struct *tty,
1384 		struct usb_serial_port *port, struct ktermios *old_termios)
1385 {
1386 	struct device *dev = &port->dev;
1387 	unsigned int cflag, old_cflag;
1388 	u16 bits;
1389 
1390 	cflag = tty->termios.c_cflag;
1391 	old_cflag = old_termios->c_cflag;
1392 
1393 	if (tty->termios.c_ospeed != old_termios->c_ospeed)
1394 		cp210x_change_speed(tty, port, old_termios);
1395 
1396 	/* If the number of data bits is to be updated */
1397 	if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
1398 		cp210x_get_line_ctl(port, &bits);
1399 		bits &= ~BITS_DATA_MASK;
1400 		switch (cflag & CSIZE) {
1401 		case CS5:
1402 			bits |= BITS_DATA_5;
1403 			dev_dbg(dev, "%s - data bits = 5\n", __func__);
1404 			break;
1405 		case CS6:
1406 			bits |= BITS_DATA_6;
1407 			dev_dbg(dev, "%s - data bits = 6\n", __func__);
1408 			break;
1409 		case CS7:
1410 			bits |= BITS_DATA_7;
1411 			dev_dbg(dev, "%s - data bits = 7\n", __func__);
1412 			break;
1413 		case CS8:
1414 		default:
1415 			bits |= BITS_DATA_8;
1416 			dev_dbg(dev, "%s - data bits = 8\n", __func__);
1417 			break;
1418 		}
1419 		if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1420 			dev_dbg(dev, "Number of data bits requested not supported by device\n");
1421 	}
1422 
1423 	if ((cflag     & (PARENB|PARODD|CMSPAR)) !=
1424 	    (old_cflag & (PARENB|PARODD|CMSPAR))) {
1425 		cp210x_get_line_ctl(port, &bits);
1426 		bits &= ~BITS_PARITY_MASK;
1427 		if (cflag & PARENB) {
1428 			if (cflag & CMSPAR) {
1429 				if (cflag & PARODD) {
1430 					bits |= BITS_PARITY_MARK;
1431 					dev_dbg(dev, "%s - parity = MARK\n", __func__);
1432 				} else {
1433 					bits |= BITS_PARITY_SPACE;
1434 					dev_dbg(dev, "%s - parity = SPACE\n", __func__);
1435 				}
1436 			} else {
1437 				if (cflag & PARODD) {
1438 					bits |= BITS_PARITY_ODD;
1439 					dev_dbg(dev, "%s - parity = ODD\n", __func__);
1440 				} else {
1441 					bits |= BITS_PARITY_EVEN;
1442 					dev_dbg(dev, "%s - parity = EVEN\n", __func__);
1443 				}
1444 			}
1445 		}
1446 		if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1447 			dev_dbg(dev, "Parity mode not supported by device\n");
1448 	}
1449 
1450 	if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
1451 		cp210x_get_line_ctl(port, &bits);
1452 		bits &= ~BITS_STOP_MASK;
1453 		if (cflag & CSTOPB) {
1454 			bits |= BITS_STOP_2;
1455 			dev_dbg(dev, "%s - stop bits = 2\n", __func__);
1456 		} else {
1457 			bits |= BITS_STOP_1;
1458 			dev_dbg(dev, "%s - stop bits = 1\n", __func__);
1459 		}
1460 		if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1461 			dev_dbg(dev, "Number of stop bits requested not supported by device\n");
1462 	}
1463 
1464 	if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
1465 		struct cp210x_flow_ctl flow_ctl;
1466 		u32 ctl_hs;
1467 		u32 flow_repl;
1468 
1469 		cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1470 				sizeof(flow_ctl));
1471 		ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1472 		flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1473 		dev_dbg(dev, "%s - read ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1474 				__func__, ctl_hs, flow_repl);
1475 
1476 		ctl_hs &= ~CP210X_SERIAL_DSR_HANDSHAKE;
1477 		ctl_hs &= ~CP210X_SERIAL_DCD_HANDSHAKE;
1478 		ctl_hs &= ~CP210X_SERIAL_DSR_SENSITIVITY;
1479 		ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1480 		ctl_hs |= CP210X_SERIAL_DTR_SHIFT(CP210X_SERIAL_DTR_ACTIVE);
1481 		if (cflag & CRTSCTS) {
1482 			ctl_hs |= CP210X_SERIAL_CTS_HANDSHAKE;
1483 
1484 			flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1485 			flow_repl |= CP210X_SERIAL_RTS_SHIFT(
1486 					CP210X_SERIAL_RTS_FLOW_CTL);
1487 			dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
1488 		} else {
1489 			ctl_hs &= ~CP210X_SERIAL_CTS_HANDSHAKE;
1490 
1491 			flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1492 			flow_repl |= CP210X_SERIAL_RTS_SHIFT(
1493 					CP210X_SERIAL_RTS_ACTIVE);
1494 			dev_dbg(dev, "%s - flow control = NONE\n", __func__);
1495 		}
1496 
1497 		dev_dbg(dev, "%s - write ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1498 				__func__, ctl_hs, flow_repl);
1499 		flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1500 		flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1501 		cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1502 				sizeof(flow_ctl));
1503 	}
1504 
1505 	/*
1506 	 * Enable event-insertion mode only if input parity checking is
1507 	 * enabled for now.
1508 	 */
1509 	if (I_INPCK(tty))
1510 		cp210x_enable_event_mode(port);
1511 	else
1512 		cp210x_disable_event_mode(port);
1513 }
1514 
cp210x_tiocmset(struct tty_struct *tty, unsigned int set, unsigned int clear)1515 static int cp210x_tiocmset(struct tty_struct *tty,
1516 		unsigned int set, unsigned int clear)
1517 {
1518 	struct usb_serial_port *port = tty->driver_data;
1519 	return cp210x_tiocmset_port(port, set, clear);
1520 }
1521 
cp210x_tiocmset_port(struct usb_serial_port *port, unsigned int set, unsigned int clear)1522 static int cp210x_tiocmset_port(struct usb_serial_port *port,
1523 		unsigned int set, unsigned int clear)
1524 {
1525 	u16 control = 0;
1526 
1527 	if (set & TIOCM_RTS) {
1528 		control |= CONTROL_RTS;
1529 		control |= CONTROL_WRITE_RTS;
1530 	}
1531 	if (set & TIOCM_DTR) {
1532 		control |= CONTROL_DTR;
1533 		control |= CONTROL_WRITE_DTR;
1534 	}
1535 	if (clear & TIOCM_RTS) {
1536 		control &= ~CONTROL_RTS;
1537 		control |= CONTROL_WRITE_RTS;
1538 	}
1539 	if (clear & TIOCM_DTR) {
1540 		control &= ~CONTROL_DTR;
1541 		control |= CONTROL_WRITE_DTR;
1542 	}
1543 
1544 	dev_dbg(&port->dev, "%s - control = 0x%.4x\n", __func__, control);
1545 
1546 	return cp210x_write_u16_reg(port, CP210X_SET_MHS, control);
1547 }
1548 
cp210x_dtr_rts(struct usb_serial_port *p, int on)1549 static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
1550 {
1551 	if (on)
1552 		cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
1553 	else
1554 		cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
1555 }
1556 
cp210x_tiocmget(struct tty_struct *tty)1557 static int cp210x_tiocmget(struct tty_struct *tty)
1558 {
1559 	struct usb_serial_port *port = tty->driver_data;
1560 	u8 control;
1561 	int result;
1562 
1563 	result = cp210x_read_u8_reg(port, CP210X_GET_MDMSTS, &control);
1564 	if (result)
1565 		return result;
1566 
1567 	result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
1568 		|((control & CONTROL_RTS) ? TIOCM_RTS : 0)
1569 		|((control & CONTROL_CTS) ? TIOCM_CTS : 0)
1570 		|((control & CONTROL_DSR) ? TIOCM_DSR : 0)
1571 		|((control & CONTROL_RING)? TIOCM_RI  : 0)
1572 		|((control & CONTROL_DCD) ? TIOCM_CD  : 0);
1573 
1574 	dev_dbg(&port->dev, "%s - control = 0x%.2x\n", __func__, control);
1575 
1576 	return result;
1577 }
1578 
cp210x_break_ctl(struct tty_struct *tty, int break_state)1579 static void cp210x_break_ctl(struct tty_struct *tty, int break_state)
1580 {
1581 	struct usb_serial_port *port = tty->driver_data;
1582 	u16 state;
1583 
1584 	if (break_state == 0)
1585 		state = BREAK_OFF;
1586 	else
1587 		state = BREAK_ON;
1588 	dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
1589 		state == BREAK_OFF ? "off" : "on");
1590 	cp210x_write_u16_reg(port, CP210X_SET_BREAK, state);
1591 }
1592 
1593 #ifdef CONFIG_GPIOLIB
cp210x_gpio_request(struct gpio_chip *gc, unsigned int offset)1594 static int cp210x_gpio_request(struct gpio_chip *gc, unsigned int offset)
1595 {
1596 	struct usb_serial *serial = gpiochip_get_data(gc);
1597 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1598 
1599 	if (priv->gpio_altfunc & BIT(offset))
1600 		return -ENODEV;
1601 
1602 	return 0;
1603 }
1604 
cp210x_gpio_get(struct gpio_chip *gc, unsigned int gpio)1605 static int cp210x_gpio_get(struct gpio_chip *gc, unsigned int gpio)
1606 {
1607 	struct usb_serial *serial = gpiochip_get_data(gc);
1608 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1609 	u8 req_type = REQTYPE_DEVICE_TO_HOST;
1610 	int result;
1611 	u8 buf;
1612 
1613 	if (priv->partnum == CP210X_PARTNUM_CP2105)
1614 		req_type = REQTYPE_INTERFACE_TO_HOST;
1615 
1616 	result = usb_autopm_get_interface(serial->interface);
1617 	if (result)
1618 		return result;
1619 
1620 	result = cp210x_read_vendor_block(serial, req_type,
1621 					  CP210X_READ_LATCH, &buf, sizeof(buf));
1622 	usb_autopm_put_interface(serial->interface);
1623 	if (result < 0)
1624 		return result;
1625 
1626 	return !!(buf & BIT(gpio));
1627 }
1628 
cp210x_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)1629 static void cp210x_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)
1630 {
1631 	struct usb_serial *serial = gpiochip_get_data(gc);
1632 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1633 	struct cp210x_gpio_write buf;
1634 	int result;
1635 
1636 	if (value == 1)
1637 		buf.state = BIT(gpio);
1638 	else
1639 		buf.state = 0;
1640 
1641 	buf.mask = BIT(gpio);
1642 
1643 	result = usb_autopm_get_interface(serial->interface);
1644 	if (result)
1645 		goto out;
1646 
1647 	if (priv->partnum == CP210X_PARTNUM_CP2105) {
1648 		result = cp210x_write_vendor_block(serial,
1649 						   REQTYPE_HOST_TO_INTERFACE,
1650 						   CP210X_WRITE_LATCH, &buf,
1651 						   sizeof(buf));
1652 	} else {
1653 		u16 wIndex = buf.state << 8 | buf.mask;
1654 
1655 		result = usb_control_msg(serial->dev,
1656 					 usb_sndctrlpipe(serial->dev, 0),
1657 					 CP210X_VENDOR_SPECIFIC,
1658 					 REQTYPE_HOST_TO_DEVICE,
1659 					 CP210X_WRITE_LATCH,
1660 					 wIndex,
1661 					 NULL, 0, USB_CTRL_SET_TIMEOUT);
1662 	}
1663 
1664 	usb_autopm_put_interface(serial->interface);
1665 out:
1666 	if (result < 0) {
1667 		dev_err(&serial->interface->dev, "failed to set GPIO value: %d\n",
1668 				result);
1669 	}
1670 }
1671 
cp210x_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)1672 static int cp210x_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
1673 {
1674 	struct usb_serial *serial = gpiochip_get_data(gc);
1675 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1676 
1677 	return priv->gpio_input & BIT(gpio);
1678 }
1679 
cp210x_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)1680 static int cp210x_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
1681 {
1682 	struct usb_serial *serial = gpiochip_get_data(gc);
1683 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1684 
1685 	if (priv->partnum == CP210X_PARTNUM_CP2105) {
1686 		/* hardware does not support an input mode */
1687 		return -ENOTSUPP;
1688 	}
1689 
1690 	/* push-pull pins cannot be changed to be inputs */
1691 	if (priv->gpio_pushpull & BIT(gpio))
1692 		return -EINVAL;
1693 
1694 	/* make sure to release pin if it is being driven low */
1695 	cp210x_gpio_set(gc, gpio, 1);
1696 
1697 	priv->gpio_input |= BIT(gpio);
1698 
1699 	return 0;
1700 }
1701 
cp210x_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio, int value)1702 static int cp210x_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
1703 					int value)
1704 {
1705 	struct usb_serial *serial = gpiochip_get_data(gc);
1706 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1707 
1708 	priv->gpio_input &= ~BIT(gpio);
1709 	cp210x_gpio_set(gc, gpio, value);
1710 
1711 	return 0;
1712 }
1713 
cp210x_gpio_set_config(struct gpio_chip *gc, unsigned int gpio, unsigned long config)1714 static int cp210x_gpio_set_config(struct gpio_chip *gc, unsigned int gpio,
1715 				  unsigned long config)
1716 {
1717 	struct usb_serial *serial = gpiochip_get_data(gc);
1718 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1719 	enum pin_config_param param = pinconf_to_config_param(config);
1720 
1721 	/* Succeed only if in correct mode (this can't be set at runtime) */
1722 	if ((param == PIN_CONFIG_DRIVE_PUSH_PULL) &&
1723 	    (priv->gpio_pushpull & BIT(gpio)))
1724 		return 0;
1725 
1726 	if ((param == PIN_CONFIG_DRIVE_OPEN_DRAIN) &&
1727 	    !(priv->gpio_pushpull & BIT(gpio)))
1728 		return 0;
1729 
1730 	return -ENOTSUPP;
1731 }
1732 
1733 /*
1734  * This function is for configuring GPIO using shared pins, where other signals
1735  * are made unavailable by configuring the use of GPIO. This is believed to be
1736  * only applicable to the cp2105 at this point, the other devices supported by
1737  * this driver that provide GPIO do so in a way that does not impact other
1738  * signals and are thus expected to have very different initialisation.
1739  */
cp2105_gpioconf_init(struct usb_serial *serial)1740 static int cp2105_gpioconf_init(struct usb_serial *serial)
1741 {
1742 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1743 	struct cp210x_pin_mode mode;
1744 	struct cp210x_dual_port_config config;
1745 	u8 intf_num = cp210x_interface_num(serial);
1746 	u8 iface_config;
1747 	int result;
1748 
1749 	result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1750 					  CP210X_GET_DEVICEMODE, &mode,
1751 					  sizeof(mode));
1752 	if (result < 0)
1753 		return result;
1754 
1755 	result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1756 					  CP210X_GET_PORTCONFIG, &config,
1757 					  sizeof(config));
1758 	if (result < 0)
1759 		return result;
1760 
1761 	/*  2 banks of GPIO - One for the pins taken from each serial port */
1762 	if (intf_num == 0) {
1763 		priv->gc.ngpio = 2;
1764 
1765 		if (mode.eci == CP210X_PIN_MODE_MODEM) {
1766 			/* mark all GPIOs of this interface as reserved */
1767 			priv->gpio_altfunc = 0xff;
1768 			return 0;
1769 		}
1770 
1771 		iface_config = config.eci_cfg;
1772 		priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1773 						CP210X_ECI_GPIO_MODE_MASK) >>
1774 						CP210X_ECI_GPIO_MODE_OFFSET);
1775 	} else if (intf_num == 1) {
1776 		priv->gc.ngpio = 3;
1777 
1778 		if (mode.sci == CP210X_PIN_MODE_MODEM) {
1779 			/* mark all GPIOs of this interface as reserved */
1780 			priv->gpio_altfunc = 0xff;
1781 			return 0;
1782 		}
1783 
1784 		iface_config = config.sci_cfg;
1785 		priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1786 						CP210X_SCI_GPIO_MODE_MASK) >>
1787 						CP210X_SCI_GPIO_MODE_OFFSET);
1788 	} else {
1789 		return -ENODEV;
1790 	}
1791 
1792 	/* mark all pins which are not in GPIO mode */
1793 	if (iface_config & CP2105_GPIO0_TXLED_MODE)	/* GPIO 0 */
1794 		priv->gpio_altfunc |= BIT(0);
1795 	if (iface_config & (CP2105_GPIO1_RXLED_MODE |	/* GPIO 1 */
1796 			CP2105_GPIO1_RS485_MODE))
1797 		priv->gpio_altfunc |= BIT(1);
1798 
1799 	/* driver implementation for CP2105 only supports outputs */
1800 	priv->gpio_input = 0;
1801 
1802 	return 0;
1803 }
1804 
cp2104_gpioconf_init(struct usb_serial *serial)1805 static int cp2104_gpioconf_init(struct usb_serial *serial)
1806 {
1807 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1808 	struct cp210x_single_port_config config;
1809 	u8 iface_config;
1810 	u8 gpio_latch;
1811 	int result;
1812 	u8 i;
1813 
1814 	result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1815 					  CP210X_GET_PORTCONFIG, &config,
1816 					  sizeof(config));
1817 	if (result < 0)
1818 		return result;
1819 
1820 	priv->gc.ngpio = 4;
1821 
1822 	iface_config = config.device_cfg;
1823 	priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1824 					CP210X_GPIO_MODE_MASK) >>
1825 					CP210X_GPIO_MODE_OFFSET);
1826 	gpio_latch = (u8)((le16_to_cpu(config.reset_state) &
1827 					CP210X_GPIO_MODE_MASK) >>
1828 					CP210X_GPIO_MODE_OFFSET);
1829 
1830 	/* mark all pins which are not in GPIO mode */
1831 	if (iface_config & CP2104_GPIO0_TXLED_MODE)	/* GPIO 0 */
1832 		priv->gpio_altfunc |= BIT(0);
1833 	if (iface_config & CP2104_GPIO1_RXLED_MODE)	/* GPIO 1 */
1834 		priv->gpio_altfunc |= BIT(1);
1835 	if (iface_config & CP2104_GPIO2_RS485_MODE)	/* GPIO 2 */
1836 		priv->gpio_altfunc |= BIT(2);
1837 
1838 	/*
1839 	 * Like CP2102N, CP2104 has also no strict input and output pin
1840 	 * modes.
1841 	 * Do the same input mode emulation as CP2102N.
1842 	 */
1843 	for (i = 0; i < priv->gc.ngpio; ++i) {
1844 		/*
1845 		 * Set direction to "input" iff pin is open-drain and reset
1846 		 * value is 1.
1847 		 */
1848 		if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1849 			priv->gpio_input |= BIT(i);
1850 	}
1851 
1852 	return 0;
1853 }
1854 
cp2102n_gpioconf_init(struct usb_serial *serial)1855 static int cp2102n_gpioconf_init(struct usb_serial *serial)
1856 {
1857 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1858 	const u16 config_size = 0x02a6;
1859 	u8 gpio_rst_latch;
1860 	u8 config_version;
1861 	u8 gpio_pushpull;
1862 	u8 *config_buf;
1863 	u8 gpio_latch;
1864 	u8 gpio_ctrl;
1865 	int result;
1866 	u8 i;
1867 
1868 	/*
1869 	 * Retrieve device configuration from the device.
1870 	 * The array received contains all customization settings done at the
1871 	 * factory/manufacturer. Format of the array is documented at the
1872 	 * time of writing at:
1873 	 * https://www.silabs.com/community/interface/knowledge-base.entry.html/2017/03/31/cp2102n_setconfig-xsfa
1874 	 */
1875 	config_buf = kmalloc(config_size, GFP_KERNEL);
1876 	if (!config_buf)
1877 		return -ENOMEM;
1878 
1879 	result = cp210x_read_vendor_block(serial,
1880 					  REQTYPE_DEVICE_TO_HOST,
1881 					  CP210X_READ_2NCONFIG,
1882 					  config_buf,
1883 					  config_size);
1884 	if (result < 0) {
1885 		kfree(config_buf);
1886 		return result;
1887 	}
1888 
1889 	config_version = config_buf[CP210X_2NCONFIG_CONFIG_VERSION_IDX];
1890 	gpio_pushpull = config_buf[CP210X_2NCONFIG_GPIO_MODE_IDX];
1891 	gpio_ctrl = config_buf[CP210X_2NCONFIG_GPIO_CONTROL_IDX];
1892 	gpio_rst_latch = config_buf[CP210X_2NCONFIG_GPIO_RSTLATCH_IDX];
1893 
1894 	kfree(config_buf);
1895 
1896 	/* Make sure this is a config format we understand. */
1897 	if (config_version != 0x01)
1898 		return -ENOTSUPP;
1899 
1900 	priv->gc.ngpio = 4;
1901 
1902 	/*
1903 	 * Get default pin states after reset. Needed so we can determine
1904 	 * the direction of an open-drain pin.
1905 	 */
1906 	gpio_latch = (gpio_rst_latch >> 3) & 0x0f;
1907 
1908 	/* 0 indicates open-drain mode, 1 is push-pull */
1909 	priv->gpio_pushpull = (gpio_pushpull >> 3) & 0x0f;
1910 
1911 	/* 0 indicates GPIO mode, 1 is alternate function */
1912 	if (priv->partnum == CP210X_PARTNUM_CP2102N_QFN20) {
1913 		/* QFN20 is special... */
1914 		if (gpio_ctrl & CP2102N_QFN20_GPIO0_CLK_MODE)   /* GPIO 0 */
1915 			priv->gpio_altfunc |= BIT(0);
1916 		if (gpio_ctrl & CP2102N_QFN20_GPIO1_RS485_MODE) /* GPIO 1 */
1917 			priv->gpio_altfunc |= BIT(1);
1918 		if (gpio_ctrl & CP2102N_QFN20_GPIO2_TXLED_MODE) /* GPIO 2 */
1919 			priv->gpio_altfunc |= BIT(2);
1920 		if (gpio_ctrl & CP2102N_QFN20_GPIO3_RXLED_MODE) /* GPIO 3 */
1921 			priv->gpio_altfunc |= BIT(3);
1922 	} else {
1923 		priv->gpio_altfunc = (gpio_ctrl >> 2) & 0x0f;
1924 	}
1925 
1926 	if (priv->partnum == CP210X_PARTNUM_CP2102N_QFN28) {
1927 		/*
1928 		 * For the QFN28 package, GPIO4-6 are controlled by
1929 		 * the low three bits of the mode/latch fields.
1930 		 * Contrary to the document linked above, the bits for
1931 		 * the SUSPEND pins are elsewhere.  No alternate
1932 		 * function is available for these pins.
1933 		 */
1934 		priv->gc.ngpio = 7;
1935 		gpio_latch |= (gpio_rst_latch & 7) << 4;
1936 		priv->gpio_pushpull |= (gpio_pushpull & 7) << 4;
1937 	}
1938 
1939 	/*
1940 	 * The CP2102N does not strictly has input and output pin modes,
1941 	 * it only knows open-drain and push-pull modes which is set at
1942 	 * factory. An open-drain pin can function both as an
1943 	 * input or an output. We emulate input mode for open-drain pins
1944 	 * by making sure they are not driven low, and we do not allow
1945 	 * push-pull pins to be set as an input.
1946 	 */
1947 	for (i = 0; i < priv->gc.ngpio; ++i) {
1948 		/*
1949 		 * Set direction to "input" iff pin is open-drain and reset
1950 		 * value is 1.
1951 		 */
1952 		if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1953 			priv->gpio_input |= BIT(i);
1954 	}
1955 
1956 	return 0;
1957 }
1958 
cp210x_gpio_init(struct usb_serial *serial)1959 static int cp210x_gpio_init(struct usb_serial *serial)
1960 {
1961 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1962 	int result;
1963 
1964 	switch (priv->partnum) {
1965 	case CP210X_PARTNUM_CP2104:
1966 		result = cp2104_gpioconf_init(serial);
1967 		break;
1968 	case CP210X_PARTNUM_CP2105:
1969 		result = cp2105_gpioconf_init(serial);
1970 		break;
1971 	case CP210X_PARTNUM_CP2102N_QFN28:
1972 	case CP210X_PARTNUM_CP2102N_QFN24:
1973 	case CP210X_PARTNUM_CP2102N_QFN20:
1974 		result = cp2102n_gpioconf_init(serial);
1975 		break;
1976 	default:
1977 		return 0;
1978 	}
1979 
1980 	if (result < 0)
1981 		return result;
1982 
1983 	priv->gc.label = "cp210x";
1984 	priv->gc.request = cp210x_gpio_request;
1985 	priv->gc.get_direction = cp210x_gpio_direction_get;
1986 	priv->gc.direction_input = cp210x_gpio_direction_input;
1987 	priv->gc.direction_output = cp210x_gpio_direction_output;
1988 	priv->gc.get = cp210x_gpio_get;
1989 	priv->gc.set = cp210x_gpio_set;
1990 	priv->gc.set_config = cp210x_gpio_set_config;
1991 	priv->gc.owner = THIS_MODULE;
1992 	priv->gc.parent = &serial->interface->dev;
1993 	priv->gc.base = -1;
1994 	priv->gc.can_sleep = true;
1995 
1996 	result = gpiochip_add_data(&priv->gc, serial);
1997 	if (!result)
1998 		priv->gpio_registered = true;
1999 
2000 	return result;
2001 }
2002 
cp210x_gpio_remove(struct usb_serial *serial)2003 static void cp210x_gpio_remove(struct usb_serial *serial)
2004 {
2005 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2006 
2007 	if (priv->gpio_registered) {
2008 		gpiochip_remove(&priv->gc);
2009 		priv->gpio_registered = false;
2010 	}
2011 }
2012 
2013 #else
2014 
cp210x_gpio_init(struct usb_serial *serial)2015 static int cp210x_gpio_init(struct usb_serial *serial)
2016 {
2017 	return 0;
2018 }
2019 
cp210x_gpio_remove(struct usb_serial *serial)2020 static void cp210x_gpio_remove(struct usb_serial *serial)
2021 {
2022 	/* Nothing to do */
2023 }
2024 
2025 #endif
2026 
cp210x_port_probe(struct usb_serial_port *port)2027 static int cp210x_port_probe(struct usb_serial_port *port)
2028 {
2029 	struct usb_serial *serial = port->serial;
2030 	struct cp210x_port_private *port_priv;
2031 	int ret;
2032 
2033 	port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
2034 	if (!port_priv)
2035 		return -ENOMEM;
2036 
2037 	port_priv->bInterfaceNumber = cp210x_interface_num(serial);
2038 
2039 	usb_set_serial_port_data(port, port_priv);
2040 
2041 	ret = cp210x_detect_swapped_line_ctl(port);
2042 	if (ret) {
2043 		kfree(port_priv);
2044 		return ret;
2045 	}
2046 
2047 	return 0;
2048 }
2049 
cp210x_port_remove(struct usb_serial_port *port)2050 static int cp210x_port_remove(struct usb_serial_port *port)
2051 {
2052 	struct cp210x_port_private *port_priv;
2053 
2054 	port_priv = usb_get_serial_port_data(port);
2055 	kfree(port_priv);
2056 
2057 	return 0;
2058 }
2059 
cp210x_init_max_speed(struct usb_serial *serial)2060 static void cp210x_init_max_speed(struct usb_serial *serial)
2061 {
2062 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2063 	bool use_actual_rate = false;
2064 	speed_t min = 300;
2065 	speed_t max;
2066 
2067 	switch (priv->partnum) {
2068 	case CP210X_PARTNUM_CP2101:
2069 		max = 921600;
2070 		break;
2071 	case CP210X_PARTNUM_CP2102:
2072 	case CP210X_PARTNUM_CP2103:
2073 		max = 1000000;
2074 		break;
2075 	case CP210X_PARTNUM_CP2104:
2076 		use_actual_rate = true;
2077 		max = 2000000;
2078 		break;
2079 	case CP210X_PARTNUM_CP2108:
2080 		max = 2000000;
2081 		break;
2082 	case CP210X_PARTNUM_CP2105:
2083 		if (cp210x_interface_num(serial) == 0) {
2084 			use_actual_rate = true;
2085 			max = 2000000;	/* ECI */
2086 		} else {
2087 			min = 2400;
2088 			max = 921600;	/* SCI */
2089 		}
2090 		break;
2091 	case CP210X_PARTNUM_CP2102N_QFN28:
2092 	case CP210X_PARTNUM_CP2102N_QFN24:
2093 	case CP210X_PARTNUM_CP2102N_QFN20:
2094 		use_actual_rate = true;
2095 		max = 3000000;
2096 		break;
2097 	default:
2098 		max = 2000000;
2099 		break;
2100 	}
2101 
2102 	priv->min_speed = min;
2103 	priv->max_speed = max;
2104 	priv->use_actual_rate = use_actual_rate;
2105 }
2106 
cp2102_determine_quirks(struct usb_serial *serial)2107 static void cp2102_determine_quirks(struct usb_serial *serial)
2108 {
2109 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2110 	u8 *buf;
2111 	int ret;
2112 
2113 	buf = kmalloc(2, GFP_KERNEL);
2114 	if (!buf)
2115 		return;
2116 	/*
2117 	 * Some (possibly counterfeit) CP2102 do not support event-insertion
2118 	 * mode and respond differently to malformed vendor requests.
2119 	 * Specifically, they return one instead of two bytes when sent a
2120 	 * two-byte part-number request.
2121 	 */
2122 	ret = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
2123 			CP210X_VENDOR_SPECIFIC, REQTYPE_DEVICE_TO_HOST,
2124 			CP210X_GET_PARTNUM, 0, buf, 2, USB_CTRL_GET_TIMEOUT);
2125 	if (ret == 1) {
2126 		dev_dbg(&serial->interface->dev,
2127 				"device does not support event-insertion mode\n");
2128 		priv->no_event_mode = true;
2129 	}
2130 
2131 	kfree(buf);
2132 }
2133 
cp210x_determine_quirks(struct usb_serial *serial)2134 static void cp210x_determine_quirks(struct usb_serial *serial)
2135 {
2136 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2137 
2138 	switch (priv->partnum) {
2139 	case CP210X_PARTNUM_CP2102:
2140 		cp2102_determine_quirks(serial);
2141 		break;
2142 	default:
2143 		break;
2144 	}
2145 }
2146 
cp210x_attach(struct usb_serial *serial)2147 static int cp210x_attach(struct usb_serial *serial)
2148 {
2149 	int result;
2150 	struct cp210x_serial_private *priv;
2151 
2152 	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
2153 	if (!priv)
2154 		return -ENOMEM;
2155 
2156 	result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
2157 					  CP210X_GET_PARTNUM, &priv->partnum,
2158 					  sizeof(priv->partnum));
2159 	if (result < 0) {
2160 		dev_warn(&serial->interface->dev,
2161 			 "querying part number failed\n");
2162 		priv->partnum = CP210X_PARTNUM_UNKNOWN;
2163 	}
2164 
2165 	usb_set_serial_data(serial, priv);
2166 
2167 	cp210x_determine_quirks(serial);
2168 	cp210x_init_max_speed(serial);
2169 
2170 	result = cp210x_gpio_init(serial);
2171 	if (result < 0) {
2172 		dev_err(&serial->interface->dev, "GPIO initialisation failed: %d\n",
2173 				result);
2174 	}
2175 
2176 	return 0;
2177 }
2178 
cp210x_disconnect(struct usb_serial *serial)2179 static void cp210x_disconnect(struct usb_serial *serial)
2180 {
2181 	cp210x_gpio_remove(serial);
2182 }
2183 
cp210x_release(struct usb_serial *serial)2184 static void cp210x_release(struct usb_serial *serial)
2185 {
2186 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2187 
2188 	cp210x_gpio_remove(serial);
2189 
2190 	kfree(priv);
2191 }
2192 
2193 module_usb_serial_driver(serial_drivers, id_table);
2194 
2195 MODULE_DESCRIPTION(DRIVER_DESC);
2196 MODULE_LICENSE("GPL v2");
2197