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