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