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