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