xref: /openbmc/linux/drivers/usb/serial/cp210x.c (revision 3c3df979)
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 		.owner =	THIS_MODULE,
303 		.name =		"cp210x",
304 	},
305 	.id_table		= id_table,
306 	.num_ports		= 1,
307 	.bulk_in_size		= 256,
308 	.bulk_out_size		= 256,
309 	.open			= cp210x_open,
310 	.close			= cp210x_close,
311 	.break_ctl		= cp210x_break_ctl,
312 	.set_termios		= cp210x_set_termios,
313 	.tx_empty		= cp210x_tx_empty,
314 	.throttle		= usb_serial_generic_throttle,
315 	.unthrottle		= usb_serial_generic_unthrottle,
316 	.tiocmget		= cp210x_tiocmget,
317 	.tiocmset		= cp210x_tiocmset,
318 	.get_icount		= usb_serial_generic_get_icount,
319 	.attach			= cp210x_attach,
320 	.disconnect		= cp210x_disconnect,
321 	.release		= cp210x_release,
322 	.port_probe		= cp210x_port_probe,
323 	.port_remove		= cp210x_port_remove,
324 	.dtr_rts		= cp210x_dtr_rts,
325 	.process_read_urb	= cp210x_process_read_urb,
326 };
327 
328 static struct usb_serial_driver * const serial_drivers[] = {
329 	&cp210x_device, NULL
330 };
331 
332 /* Config request types */
333 #define REQTYPE_HOST_TO_INTERFACE	0x41
334 #define REQTYPE_INTERFACE_TO_HOST	0xc1
335 #define REQTYPE_HOST_TO_DEVICE	0x40
336 #define REQTYPE_DEVICE_TO_HOST	0xc0
337 
338 /* Config request codes */
339 #define CP210X_IFC_ENABLE	0x00
340 #define CP210X_SET_BAUDDIV	0x01
341 #define CP210X_GET_BAUDDIV	0x02
342 #define CP210X_SET_LINE_CTL	0x03
343 #define CP210X_GET_LINE_CTL	0x04
344 #define CP210X_SET_BREAK	0x05
345 #define CP210X_IMM_CHAR		0x06
346 #define CP210X_SET_MHS		0x07
347 #define CP210X_GET_MDMSTS	0x08
348 #define CP210X_SET_XON		0x09
349 #define CP210X_SET_XOFF		0x0A
350 #define CP210X_SET_EVENTMASK	0x0B
351 #define CP210X_GET_EVENTMASK	0x0C
352 #define CP210X_SET_CHAR		0x0D
353 #define CP210X_GET_CHARS	0x0E
354 #define CP210X_GET_PROPS	0x0F
355 #define CP210X_GET_COMM_STATUS	0x10
356 #define CP210X_RESET		0x11
357 #define CP210X_PURGE		0x12
358 #define CP210X_SET_FLOW		0x13
359 #define CP210X_GET_FLOW		0x14
360 #define CP210X_EMBED_EVENTS	0x15
361 #define CP210X_GET_EVENTSTATE	0x16
362 #define CP210X_SET_CHARS	0x19
363 #define CP210X_GET_BAUDRATE	0x1D
364 #define CP210X_SET_BAUDRATE	0x1E
365 #define CP210X_VENDOR_SPECIFIC	0xFF
366 
367 /* CP210X_IFC_ENABLE */
368 #define UART_ENABLE		0x0001
369 #define UART_DISABLE		0x0000
370 
371 /* CP210X_(SET|GET)_BAUDDIV */
372 #define BAUD_RATE_GEN_FREQ	0x384000
373 
374 /* CP210X_(SET|GET)_LINE_CTL */
375 #define BITS_DATA_MASK		0X0f00
376 #define BITS_DATA_5		0X0500
377 #define BITS_DATA_6		0X0600
378 #define BITS_DATA_7		0X0700
379 #define BITS_DATA_8		0X0800
380 #define BITS_DATA_9		0X0900
381 
382 #define BITS_PARITY_MASK	0x00f0
383 #define BITS_PARITY_NONE	0x0000
384 #define BITS_PARITY_ODD		0x0010
385 #define BITS_PARITY_EVEN	0x0020
386 #define BITS_PARITY_MARK	0x0030
387 #define BITS_PARITY_SPACE	0x0040
388 
389 #define BITS_STOP_MASK		0x000f
390 #define BITS_STOP_1		0x0000
391 #define BITS_STOP_1_5		0x0001
392 #define BITS_STOP_2		0x0002
393 
394 /* CP210X_SET_BREAK */
395 #define BREAK_ON		0x0001
396 #define BREAK_OFF		0x0000
397 
398 /* CP210X_(SET_MHS|GET_MDMSTS) */
399 #define CONTROL_DTR		0x0001
400 #define CONTROL_RTS		0x0002
401 #define CONTROL_CTS		0x0010
402 #define CONTROL_DSR		0x0020
403 #define CONTROL_RING		0x0040
404 #define CONTROL_DCD		0x0080
405 #define CONTROL_WRITE_DTR	0x0100
406 #define CONTROL_WRITE_RTS	0x0200
407 
408 /* CP210X_(GET|SET)_CHARS */
409 struct cp210x_special_chars {
410 	u8	bEofChar;
411 	u8	bErrorChar;
412 	u8	bBreakChar;
413 	u8	bEventChar;
414 	u8	bXonChar;
415 	u8	bXoffChar;
416 };
417 
418 /* CP210X_VENDOR_SPECIFIC values */
419 #define CP210X_GET_FW_VER	0x000E
420 #define CP210X_READ_2NCONFIG	0x000E
421 #define CP210X_GET_FW_VER_2N	0x0010
422 #define CP210X_READ_LATCH	0x00C2
423 #define CP210X_GET_PARTNUM	0x370B
424 #define CP210X_GET_PORTCONFIG	0x370C
425 #define CP210X_GET_DEVICEMODE	0x3711
426 #define CP210X_WRITE_LATCH	0x37E1
427 
428 /* Part number definitions */
429 #define CP210X_PARTNUM_CP2101	0x01
430 #define CP210X_PARTNUM_CP2102	0x02
431 #define CP210X_PARTNUM_CP2103	0x03
432 #define CP210X_PARTNUM_CP2104	0x04
433 #define CP210X_PARTNUM_CP2105	0x05
434 #define CP210X_PARTNUM_CP2108	0x08
435 #define CP210X_PARTNUM_CP2102N_QFN28	0x20
436 #define CP210X_PARTNUM_CP2102N_QFN24	0x21
437 #define CP210X_PARTNUM_CP2102N_QFN20	0x22
438 #define CP210X_PARTNUM_UNKNOWN	0xFF
439 
440 /* CP210X_GET_COMM_STATUS returns these 0x13 bytes */
441 struct cp210x_comm_status {
442 	__le32   ulErrors;
443 	__le32   ulHoldReasons;
444 	__le32   ulAmountInInQueue;
445 	__le32   ulAmountInOutQueue;
446 	u8       bEofReceived;
447 	u8       bWaitForImmediate;
448 	u8       bReserved;
449 } __packed;
450 
451 /*
452  * CP210X_PURGE - 16 bits passed in wValue of USB request.
453  * SiLabs app note AN571 gives a strange description of the 4 bits:
454  * bit 0 or bit 2 clears the transmit queue and 1 or 3 receive.
455  * writing 1 to all, however, purges cp2108 well enough to avoid the hang.
456  */
457 #define PURGE_ALL		0x000f
458 
459 /* CP210X_EMBED_EVENTS */
460 #define CP210X_ESCCHAR		0xec
461 
462 #define CP210X_LSR_OVERRUN	BIT(1)
463 #define CP210X_LSR_PARITY	BIT(2)
464 #define CP210X_LSR_FRAME	BIT(3)
465 #define CP210X_LSR_BREAK	BIT(4)
466 
467 
468 /* CP210X_GET_FLOW/CP210X_SET_FLOW read/write these 0x10 bytes */
469 struct cp210x_flow_ctl {
470 	__le32	ulControlHandshake;
471 	__le32	ulFlowReplace;
472 	__le32	ulXonLimit;
473 	__le32	ulXoffLimit;
474 };
475 
476 /* cp210x_flow_ctl::ulControlHandshake */
477 #define CP210X_SERIAL_DTR_MASK		GENMASK(1, 0)
478 #define CP210X_SERIAL_DTR_INACTIVE	(0 << 0)
479 #define CP210X_SERIAL_DTR_ACTIVE	(1 << 0)
480 #define CP210X_SERIAL_DTR_FLOW_CTL	(2 << 0)
481 #define CP210X_SERIAL_CTS_HANDSHAKE	BIT(3)
482 #define CP210X_SERIAL_DSR_HANDSHAKE	BIT(4)
483 #define CP210X_SERIAL_DCD_HANDSHAKE	BIT(5)
484 #define CP210X_SERIAL_DSR_SENSITIVITY	BIT(6)
485 
486 /* cp210x_flow_ctl::ulFlowReplace */
487 #define CP210X_SERIAL_AUTO_TRANSMIT	BIT(0)
488 #define CP210X_SERIAL_AUTO_RECEIVE	BIT(1)
489 #define CP210X_SERIAL_ERROR_CHAR	BIT(2)
490 #define CP210X_SERIAL_NULL_STRIPPING	BIT(3)
491 #define CP210X_SERIAL_BREAK_CHAR	BIT(4)
492 #define CP210X_SERIAL_RTS_MASK		GENMASK(7, 6)
493 #define CP210X_SERIAL_RTS_INACTIVE	(0 << 6)
494 #define CP210X_SERIAL_RTS_ACTIVE	(1 << 6)
495 #define CP210X_SERIAL_RTS_FLOW_CTL	(2 << 6)
496 #define CP210X_SERIAL_XOFF_CONTINUE	BIT(31)
497 
498 /* CP210X_VENDOR_SPECIFIC, CP210X_GET_DEVICEMODE call reads these 0x2 bytes. */
499 struct cp210x_pin_mode {
500 	u8	eci;
501 	u8	sci;
502 };
503 
504 #define CP210X_PIN_MODE_MODEM		0
505 #define CP210X_PIN_MODE_GPIO		BIT(0)
506 
507 /*
508  * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xf bytes
509  * on a CP2105 chip. Structure needs padding due to unused/unspecified bytes.
510  */
511 struct cp210x_dual_port_config {
512 	__le16	gpio_mode;
513 	u8	__pad0[2];
514 	__le16	reset_state;
515 	u8	__pad1[4];
516 	__le16	suspend_state;
517 	u8	sci_cfg;
518 	u8	eci_cfg;
519 	u8	device_cfg;
520 } __packed;
521 
522 /*
523  * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xd bytes
524  * on a CP2104 chip. Structure needs padding due to unused/unspecified bytes.
525  */
526 struct cp210x_single_port_config {
527 	__le16	gpio_mode;
528 	u8	__pad0[2];
529 	__le16	reset_state;
530 	u8	__pad1[4];
531 	__le16	suspend_state;
532 	u8	device_cfg;
533 } __packed;
534 
535 /* GPIO modes */
536 #define CP210X_SCI_GPIO_MODE_OFFSET	9
537 #define CP210X_SCI_GPIO_MODE_MASK	GENMASK(11, 9)
538 
539 #define CP210X_ECI_GPIO_MODE_OFFSET	2
540 #define CP210X_ECI_GPIO_MODE_MASK	GENMASK(3, 2)
541 
542 #define CP210X_GPIO_MODE_OFFSET		8
543 #define CP210X_GPIO_MODE_MASK		GENMASK(11, 8)
544 
545 /* CP2105 port configuration values */
546 #define CP2105_GPIO0_TXLED_MODE		BIT(0)
547 #define CP2105_GPIO1_RXLED_MODE		BIT(1)
548 #define CP2105_GPIO1_RS485_MODE		BIT(2)
549 
550 /* CP2104 port configuration values */
551 #define CP2104_GPIO0_TXLED_MODE		BIT(0)
552 #define CP2104_GPIO1_RXLED_MODE		BIT(1)
553 #define CP2104_GPIO2_RS485_MODE		BIT(2)
554 
555 struct cp210x_quad_port_state {
556 	__le16 gpio_mode_pb0;
557 	__le16 gpio_mode_pb1;
558 	__le16 gpio_mode_pb2;
559 	__le16 gpio_mode_pb3;
560 	__le16 gpio_mode_pb4;
561 
562 	__le16 gpio_lowpower_pb0;
563 	__le16 gpio_lowpower_pb1;
564 	__le16 gpio_lowpower_pb2;
565 	__le16 gpio_lowpower_pb3;
566 	__le16 gpio_lowpower_pb4;
567 
568 	__le16 gpio_latch_pb0;
569 	__le16 gpio_latch_pb1;
570 	__le16 gpio_latch_pb2;
571 	__le16 gpio_latch_pb3;
572 	__le16 gpio_latch_pb4;
573 };
574 
575 /*
576  * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0x49 bytes
577  * on a CP2108 chip.
578  *
579  * See https://www.silabs.com/documents/public/application-notes/an978-cp210x-usb-to-uart-api-specification.pdf
580  */
581 struct cp210x_quad_port_config {
582 	struct cp210x_quad_port_state reset_state;
583 	struct cp210x_quad_port_state suspend_state;
584 	u8 ipdelay_ifc[4];
585 	u8 enhancedfxn_ifc[4];
586 	u8 enhancedfxn_device;
587 	u8 extclkfreq[4];
588 } __packed;
589 
590 #define CP2108_EF_IFC_GPIO_TXLED		0x01
591 #define CP2108_EF_IFC_GPIO_RXLED		0x02
592 #define CP2108_EF_IFC_GPIO_RS485		0x04
593 #define CP2108_EF_IFC_GPIO_RS485_LOGIC		0x08
594 #define CP2108_EF_IFC_GPIO_CLOCK		0x10
595 #define CP2108_EF_IFC_DYNAMIC_SUSPEND		0x40
596 
597 /* CP2102N configuration array indices */
598 #define CP210X_2NCONFIG_CONFIG_VERSION_IDX	2
599 #define CP210X_2NCONFIG_GPIO_MODE_IDX		581
600 #define CP210X_2NCONFIG_GPIO_RSTLATCH_IDX	587
601 #define CP210X_2NCONFIG_GPIO_CONTROL_IDX	600
602 
603 /* CP2102N QFN20 port configuration values */
604 #define CP2102N_QFN20_GPIO2_TXLED_MODE		BIT(2)
605 #define CP2102N_QFN20_GPIO3_RXLED_MODE		BIT(3)
606 #define CP2102N_QFN20_GPIO1_RS485_MODE		BIT(4)
607 #define CP2102N_QFN20_GPIO0_CLK_MODE		BIT(6)
608 
609 /*
610  * CP210X_VENDOR_SPECIFIC, CP210X_WRITE_LATCH call writes these 0x02 bytes
611  * for CP2102N, CP2103, CP2104 and CP2105.
612  */
613 struct cp210x_gpio_write {
614 	u8	mask;
615 	u8	state;
616 };
617 
618 /*
619  * CP210X_VENDOR_SPECIFIC, CP210X_WRITE_LATCH call writes these 0x04 bytes
620  * for CP2108.
621  */
622 struct cp210x_gpio_write16 {
623 	__le16	mask;
624 	__le16	state;
625 };
626 
627 /*
628  * Helper to get interface number when we only have struct usb_serial.
629  */
cp210x_interface_num(struct usb_serial * serial)630 static u8 cp210x_interface_num(struct usb_serial *serial)
631 {
632 	struct usb_host_interface *cur_altsetting;
633 
634 	cur_altsetting = serial->interface->cur_altsetting;
635 
636 	return cur_altsetting->desc.bInterfaceNumber;
637 }
638 
639 /*
640  * Reads a variable-sized block of CP210X_ registers, identified by req.
641  * Returns data into buf in native USB byte order.
642  */
cp210x_read_reg_block(struct usb_serial_port * port,u8 req,void * buf,int bufsize)643 static int cp210x_read_reg_block(struct usb_serial_port *port, u8 req,
644 		void *buf, int bufsize)
645 {
646 	struct usb_serial *serial = port->serial;
647 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
648 	int result;
649 
650 
651 	result = usb_control_msg_recv(serial->dev, 0, req,
652 			REQTYPE_INTERFACE_TO_HOST, 0,
653 			port_priv->bInterfaceNumber, buf, bufsize,
654 			USB_CTRL_SET_TIMEOUT, GFP_KERNEL);
655 	if (result) {
656 		dev_err(&port->dev, "failed get req 0x%x size %d status: %d\n",
657 				req, bufsize, result);
658 		return result;
659 	}
660 
661 	return 0;
662 }
663 
664 /*
665  * Reads any 8-bit CP210X_ register identified by req.
666  */
cp210x_read_u8_reg(struct usb_serial_port * port,u8 req,u8 * val)667 static int cp210x_read_u8_reg(struct usb_serial_port *port, u8 req, u8 *val)
668 {
669 	return cp210x_read_reg_block(port, req, val, sizeof(*val));
670 }
671 
672 /*
673  * Reads a variable-sized vendor block of CP210X_ registers, identified by val.
674  * Returns data into buf in native USB byte order.
675  */
cp210x_read_vendor_block(struct usb_serial * serial,u8 type,u16 val,void * buf,int bufsize)676 static int cp210x_read_vendor_block(struct usb_serial *serial, u8 type, u16 val,
677 				    void *buf, int bufsize)
678 {
679 	int result;
680 
681 	result = usb_control_msg_recv(serial->dev, 0, CP210X_VENDOR_SPECIFIC,
682 			type, val, cp210x_interface_num(serial), buf, bufsize,
683 			USB_CTRL_GET_TIMEOUT, GFP_KERNEL);
684 	if (result) {
685 		dev_err(&serial->interface->dev,
686 			"failed to get vendor val 0x%04x size %d: %d\n", val,
687 			bufsize, result);
688 		return result;
689 	}
690 
691 	return 0;
692 }
693 
694 /*
695  * Writes any 16-bit CP210X_ register (req) whose value is passed
696  * entirely in the wValue field of the USB request.
697  */
cp210x_write_u16_reg(struct usb_serial_port * port,u8 req,u16 val)698 static int cp210x_write_u16_reg(struct usb_serial_port *port, u8 req, u16 val)
699 {
700 	struct usb_serial *serial = port->serial;
701 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
702 	int result;
703 
704 	result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
705 			req, REQTYPE_HOST_TO_INTERFACE, val,
706 			port_priv->bInterfaceNumber, NULL, 0,
707 			USB_CTRL_SET_TIMEOUT);
708 	if (result < 0) {
709 		dev_err(&port->dev, "failed set request 0x%x status: %d\n",
710 				req, result);
711 	}
712 
713 	return result;
714 }
715 
716 /*
717  * Writes a variable-sized block of CP210X_ registers, identified by req.
718  * Data in buf must be in native USB byte order.
719  */
cp210x_write_reg_block(struct usb_serial_port * port,u8 req,void * buf,int bufsize)720 static int cp210x_write_reg_block(struct usb_serial_port *port, u8 req,
721 		void *buf, int bufsize)
722 {
723 	struct usb_serial *serial = port->serial;
724 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
725 	int result;
726 
727 	result = usb_control_msg_send(serial->dev, 0, req,
728 			REQTYPE_HOST_TO_INTERFACE, 0,
729 			port_priv->bInterfaceNumber, buf, bufsize,
730 			USB_CTRL_SET_TIMEOUT, GFP_KERNEL);
731 	if (result) {
732 		dev_err(&port->dev, "failed set req 0x%x size %d status: %d\n",
733 				req, bufsize, result);
734 		return result;
735 	}
736 
737 	return 0;
738 }
739 
740 /*
741  * Writes any 32-bit CP210X_ register identified by req.
742  */
cp210x_write_u32_reg(struct usb_serial_port * port,u8 req,u32 val)743 static int cp210x_write_u32_reg(struct usb_serial_port *port, u8 req, u32 val)
744 {
745 	__le32 le32_val;
746 
747 	le32_val = cpu_to_le32(val);
748 
749 	return cp210x_write_reg_block(port, req, &le32_val, sizeof(le32_val));
750 }
751 
752 #ifdef CONFIG_GPIOLIB
753 /*
754  * Writes a variable-sized vendor block of CP210X_ registers, identified by val.
755  * Data in buf must be in native USB byte order.
756  */
cp210x_write_vendor_block(struct usb_serial * serial,u8 type,u16 val,void * buf,int bufsize)757 static int cp210x_write_vendor_block(struct usb_serial *serial, u8 type,
758 				     u16 val, void *buf, int bufsize)
759 {
760 	int result;
761 
762 	result = usb_control_msg_send(serial->dev, 0, CP210X_VENDOR_SPECIFIC,
763 			type, val, cp210x_interface_num(serial), buf, bufsize,
764 			USB_CTRL_SET_TIMEOUT, GFP_KERNEL);
765 	if (result) {
766 		dev_err(&serial->interface->dev,
767 			"failed to set vendor val 0x%04x size %d: %d\n", val,
768 			bufsize, result);
769 		return result;
770 	}
771 
772 	return 0;
773 }
774 #endif
775 
cp210x_open(struct tty_struct * tty,struct usb_serial_port * port)776 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
777 {
778 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
779 	int result;
780 
781 	result = cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_ENABLE);
782 	if (result) {
783 		dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
784 		return result;
785 	}
786 
787 	if (tty)
788 		cp210x_set_termios(tty, port, NULL);
789 
790 	result = usb_serial_generic_open(tty, port);
791 	if (result)
792 		goto err_disable;
793 
794 	return 0;
795 
796 err_disable:
797 	cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
798 	port_priv->event_mode = false;
799 
800 	return result;
801 }
802 
cp210x_close(struct usb_serial_port * port)803 static void cp210x_close(struct usb_serial_port *port)
804 {
805 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
806 
807 	usb_serial_generic_close(port);
808 
809 	/* Clear both queues; cp2108 needs this to avoid an occasional hang */
810 	cp210x_write_u16_reg(port, CP210X_PURGE, PURGE_ALL);
811 
812 	cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
813 
814 	/* Disabling the interface disables event-insertion mode. */
815 	port_priv->event_mode = false;
816 }
817 
cp210x_process_lsr(struct usb_serial_port * port,unsigned char lsr,char * flag)818 static void cp210x_process_lsr(struct usb_serial_port *port, unsigned char lsr, char *flag)
819 {
820 	if (lsr & CP210X_LSR_BREAK) {
821 		port->icount.brk++;
822 		*flag = TTY_BREAK;
823 	} else if (lsr & CP210X_LSR_PARITY) {
824 		port->icount.parity++;
825 		*flag = TTY_PARITY;
826 	} else if (lsr & CP210X_LSR_FRAME) {
827 		port->icount.frame++;
828 		*flag = TTY_FRAME;
829 	}
830 
831 	if (lsr & CP210X_LSR_OVERRUN) {
832 		port->icount.overrun++;
833 		tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
834 	}
835 }
836 
cp210x_process_char(struct usb_serial_port * port,unsigned char * ch,char * flag)837 static bool cp210x_process_char(struct usb_serial_port *port, unsigned char *ch, char *flag)
838 {
839 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
840 
841 	switch (port_priv->event_state) {
842 	case ES_DATA:
843 		if (*ch == CP210X_ESCCHAR) {
844 			port_priv->event_state = ES_ESCAPE;
845 			break;
846 		}
847 		return false;
848 	case ES_ESCAPE:
849 		switch (*ch) {
850 		case 0:
851 			dev_dbg(&port->dev, "%s - escape char\n", __func__);
852 			*ch = CP210X_ESCCHAR;
853 			port_priv->event_state = ES_DATA;
854 			return false;
855 		case 1:
856 			port_priv->event_state = ES_LSR_DATA_0;
857 			break;
858 		case 2:
859 			port_priv->event_state = ES_LSR;
860 			break;
861 		case 3:
862 			port_priv->event_state = ES_MSR;
863 			break;
864 		default:
865 			dev_err(&port->dev, "malformed event 0x%02x\n", *ch);
866 			port_priv->event_state = ES_DATA;
867 			break;
868 		}
869 		break;
870 	case ES_LSR_DATA_0:
871 		port_priv->lsr = *ch;
872 		port_priv->event_state = ES_LSR_DATA_1;
873 		break;
874 	case ES_LSR_DATA_1:
875 		dev_dbg(&port->dev, "%s - lsr = 0x%02x, data = 0x%02x\n",
876 				__func__, port_priv->lsr, *ch);
877 		cp210x_process_lsr(port, port_priv->lsr, flag);
878 		port_priv->event_state = ES_DATA;
879 		return false;
880 	case ES_LSR:
881 		dev_dbg(&port->dev, "%s - lsr = 0x%02x\n", __func__, *ch);
882 		port_priv->lsr = *ch;
883 		cp210x_process_lsr(port, port_priv->lsr, flag);
884 		port_priv->event_state = ES_DATA;
885 		break;
886 	case ES_MSR:
887 		dev_dbg(&port->dev, "%s - msr = 0x%02x\n", __func__, *ch);
888 		/* unimplemented */
889 		port_priv->event_state = ES_DATA;
890 		break;
891 	}
892 
893 	return true;
894 }
895 
cp210x_process_read_urb(struct urb * urb)896 static void cp210x_process_read_urb(struct urb *urb)
897 {
898 	struct usb_serial_port *port = urb->context;
899 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
900 	unsigned char *ch = urb->transfer_buffer;
901 	char flag;
902 	int i;
903 
904 	if (!urb->actual_length)
905 		return;
906 
907 	if (port_priv->event_mode) {
908 		for (i = 0; i < urb->actual_length; i++, ch++) {
909 			flag = TTY_NORMAL;
910 
911 			if (cp210x_process_char(port, ch, &flag))
912 				continue;
913 
914 			tty_insert_flip_char(&port->port, *ch, flag);
915 		}
916 	} else {
917 		tty_insert_flip_string(&port->port, ch, urb->actual_length);
918 	}
919 	tty_flip_buffer_push(&port->port);
920 }
921 
922 /*
923  * Read how many bytes are waiting in the TX queue.
924  */
cp210x_get_tx_queue_byte_count(struct usb_serial_port * port,u32 * count)925 static int cp210x_get_tx_queue_byte_count(struct usb_serial_port *port,
926 		u32 *count)
927 {
928 	struct usb_serial *serial = port->serial;
929 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
930 	struct cp210x_comm_status sts;
931 	int result;
932 
933 	result = usb_control_msg_recv(serial->dev, 0, CP210X_GET_COMM_STATUS,
934 			REQTYPE_INTERFACE_TO_HOST, 0,
935 			port_priv->bInterfaceNumber, &sts, sizeof(sts),
936 			USB_CTRL_GET_TIMEOUT, GFP_KERNEL);
937 	if (result) {
938 		dev_err(&port->dev, "failed to get comm status: %d\n", result);
939 		return result;
940 	}
941 
942 	*count = le32_to_cpu(sts.ulAmountInOutQueue);
943 
944 	return 0;
945 }
946 
cp210x_tx_empty(struct usb_serial_port * port)947 static bool cp210x_tx_empty(struct usb_serial_port *port)
948 {
949 	int err;
950 	u32 count;
951 
952 	err = cp210x_get_tx_queue_byte_count(port, &count);
953 	if (err)
954 		return true;
955 
956 	return !count;
957 }
958 
959 struct cp210x_rate {
960 	speed_t rate;
961 	speed_t high;
962 };
963 
964 static const struct cp210x_rate cp210x_an205_table1[] = {
965 	{ 300, 300 },
966 	{ 600, 600 },
967 	{ 1200, 1200 },
968 	{ 1800, 1800 },
969 	{ 2400, 2400 },
970 	{ 4000, 4000 },
971 	{ 4800, 4803 },
972 	{ 7200, 7207 },
973 	{ 9600, 9612 },
974 	{ 14400, 14428 },
975 	{ 16000, 16062 },
976 	{ 19200, 19250 },
977 	{ 28800, 28912 },
978 	{ 38400, 38601 },
979 	{ 51200, 51558 },
980 	{ 56000, 56280 },
981 	{ 57600, 58053 },
982 	{ 64000, 64111 },
983 	{ 76800, 77608 },
984 	{ 115200, 117028 },
985 	{ 128000, 129347 },
986 	{ 153600, 156868 },
987 	{ 230400, 237832 },
988 	{ 250000, 254234 },
989 	{ 256000, 273066 },
990 	{ 460800, 491520 },
991 	{ 500000, 567138 },
992 	{ 576000, 670254 },
993 	{ 921600, UINT_MAX }
994 };
995 
996 /*
997  * Quantises the baud rate as per AN205 Table 1
998  */
cp210x_get_an205_rate(speed_t baud)999 static speed_t cp210x_get_an205_rate(speed_t baud)
1000 {
1001 	int i;
1002 
1003 	for (i = 0; i < ARRAY_SIZE(cp210x_an205_table1); ++i) {
1004 		if (baud <= cp210x_an205_table1[i].high)
1005 			break;
1006 	}
1007 
1008 	return cp210x_an205_table1[i].rate;
1009 }
1010 
cp210x_get_actual_rate(speed_t baud)1011 static speed_t cp210x_get_actual_rate(speed_t baud)
1012 {
1013 	unsigned int prescale = 1;
1014 	unsigned int div;
1015 
1016 	if (baud <= 365)
1017 		prescale = 4;
1018 
1019 	div = DIV_ROUND_CLOSEST(48000000, 2 * prescale * baud);
1020 	baud = 48000000 / (2 * prescale * div);
1021 
1022 	return baud;
1023 }
1024 
1025 /*
1026  * CP2101 supports the following baud rates:
1027  *
1028  *	300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
1029  *	38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
1030  *
1031  * CP2102 and CP2103 support the following additional rates:
1032  *
1033  *	4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
1034  *	576000
1035  *
1036  * The device will map a requested rate to a supported one, but the result
1037  * of requests for rates greater than 1053257 is undefined (see AN205).
1038  *
1039  * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
1040  * respectively, with an error less than 1%. The actual rates are determined
1041  * by
1042  *
1043  *	div = round(freq / (2 x prescale x request))
1044  *	actual = freq / (2 x prescale x div)
1045  *
1046  * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
1047  * or 1 otherwise.
1048  * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
1049  * otherwise.
1050  */
cp210x_change_speed(struct tty_struct * tty,struct usb_serial_port * port,const struct ktermios * old_termios)1051 static void cp210x_change_speed(struct tty_struct *tty,
1052 				struct usb_serial_port *port,
1053 				const struct ktermios *old_termios)
1054 {
1055 	struct usb_serial *serial = port->serial;
1056 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1057 	u32 baud;
1058 
1059 	if (tty->termios.c_ospeed == 0)
1060 		return;
1061 
1062 	/*
1063 	 * This maps the requested rate to the actual rate, a valid rate on
1064 	 * cp2102 or cp2103, or to an arbitrary rate in [1M, max_speed].
1065 	 */
1066 	baud = clamp(tty->termios.c_ospeed, priv->min_speed, priv->max_speed);
1067 
1068 	if (priv->use_actual_rate)
1069 		baud = cp210x_get_actual_rate(baud);
1070 	else if (baud < 1000000)
1071 		baud = cp210x_get_an205_rate(baud);
1072 
1073 	dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
1074 	if (cp210x_write_u32_reg(port, CP210X_SET_BAUDRATE, baud)) {
1075 		dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
1076 		if (old_termios)
1077 			baud = old_termios->c_ospeed;
1078 		else
1079 			baud = 9600;
1080 	}
1081 
1082 	tty_encode_baud_rate(tty, baud, baud);
1083 }
1084 
cp210x_enable_event_mode(struct usb_serial_port * port)1085 static void cp210x_enable_event_mode(struct usb_serial_port *port)
1086 {
1087 	struct cp210x_serial_private *priv = usb_get_serial_data(port->serial);
1088 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1089 	int ret;
1090 
1091 	if (port_priv->event_mode)
1092 		return;
1093 
1094 	if (priv->no_event_mode)
1095 		return;
1096 
1097 	port_priv->event_state = ES_DATA;
1098 	port_priv->event_mode = true;
1099 
1100 	ret = cp210x_write_u16_reg(port, CP210X_EMBED_EVENTS, CP210X_ESCCHAR);
1101 	if (ret) {
1102 		dev_err(&port->dev, "failed to enable events: %d\n", ret);
1103 		port_priv->event_mode = false;
1104 	}
1105 }
1106 
cp210x_disable_event_mode(struct usb_serial_port * port)1107 static void cp210x_disable_event_mode(struct usb_serial_port *port)
1108 {
1109 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1110 	int ret;
1111 
1112 	if (!port_priv->event_mode)
1113 		return;
1114 
1115 	ret = cp210x_write_u16_reg(port, CP210X_EMBED_EVENTS, 0);
1116 	if (ret) {
1117 		dev_err(&port->dev, "failed to disable events: %d\n", ret);
1118 		return;
1119 	}
1120 
1121 	port_priv->event_mode = false;
1122 }
1123 
cp210x_termios_change(const struct ktermios * a,const struct ktermios * b)1124 static bool cp210x_termios_change(const struct ktermios *a, const struct ktermios *b)
1125 {
1126 	bool iflag_change, cc_change;
1127 
1128 	iflag_change = ((a->c_iflag ^ b->c_iflag) & (INPCK | IXON | IXOFF));
1129 	cc_change = a->c_cc[VSTART] != b->c_cc[VSTART] ||
1130 			a->c_cc[VSTOP] != b->c_cc[VSTOP];
1131 
1132 	return tty_termios_hw_change(a, b) || iflag_change || cc_change;
1133 }
1134 
cp210x_set_flow_control(struct tty_struct * tty,struct usb_serial_port * port,const struct ktermios * old_termios)1135 static void cp210x_set_flow_control(struct tty_struct *tty,
1136 				    struct usb_serial_port *port,
1137 				    const struct ktermios *old_termios)
1138 {
1139 	struct cp210x_serial_private *priv = usb_get_serial_data(port->serial);
1140 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1141 	struct cp210x_special_chars chars;
1142 	struct cp210x_flow_ctl flow_ctl;
1143 	u32 flow_repl;
1144 	u32 ctl_hs;
1145 	bool crtscts;
1146 	int ret;
1147 
1148 	/*
1149 	 * Some CP2102N interpret ulXonLimit as ulFlowReplace (erratum
1150 	 * CP2102N_E104). Report back that flow control is not supported.
1151 	 */
1152 	if (priv->no_flow_control) {
1153 		tty->termios.c_cflag &= ~CRTSCTS;
1154 		tty->termios.c_iflag &= ~(IXON | IXOFF);
1155 	}
1156 
1157 	if (tty->termios.c_ospeed != 0 &&
1158 			old_termios && old_termios->c_ospeed != 0 &&
1159 			C_CRTSCTS(tty) == (old_termios->c_cflag & CRTSCTS) &&
1160 			I_IXON(tty) == (old_termios->c_iflag & IXON) &&
1161 			I_IXOFF(tty) == (old_termios->c_iflag & IXOFF) &&
1162 			START_CHAR(tty) == old_termios->c_cc[VSTART] &&
1163 			STOP_CHAR(tty) == old_termios->c_cc[VSTOP]) {
1164 		return;
1165 	}
1166 
1167 	if (I_IXON(tty) || I_IXOFF(tty)) {
1168 		memset(&chars, 0, sizeof(chars));
1169 
1170 		chars.bXonChar = START_CHAR(tty);
1171 		chars.bXoffChar = STOP_CHAR(tty);
1172 
1173 		ret = cp210x_write_reg_block(port, CP210X_SET_CHARS, &chars,
1174 				sizeof(chars));
1175 		if (ret) {
1176 			dev_err(&port->dev, "failed to set special chars: %d\n",
1177 					ret);
1178 		}
1179 	}
1180 
1181 	mutex_lock(&port_priv->mutex);
1182 
1183 	if (tty->termios.c_ospeed == 0) {
1184 		port_priv->dtr = false;
1185 		port_priv->rts = false;
1186 	} else if (old_termios && old_termios->c_ospeed == 0) {
1187 		port_priv->dtr = true;
1188 		port_priv->rts = true;
1189 	}
1190 
1191 	ret = cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1192 			sizeof(flow_ctl));
1193 	if (ret)
1194 		goto out_unlock;
1195 
1196 	ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1197 	flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1198 
1199 	ctl_hs &= ~CP210X_SERIAL_DSR_HANDSHAKE;
1200 	ctl_hs &= ~CP210X_SERIAL_DCD_HANDSHAKE;
1201 	ctl_hs &= ~CP210X_SERIAL_DSR_SENSITIVITY;
1202 	ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1203 	if (port_priv->dtr)
1204 		ctl_hs |= CP210X_SERIAL_DTR_ACTIVE;
1205 	else
1206 		ctl_hs |= CP210X_SERIAL_DTR_INACTIVE;
1207 
1208 	flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1209 	if (C_CRTSCTS(tty)) {
1210 		ctl_hs |= CP210X_SERIAL_CTS_HANDSHAKE;
1211 		if (port_priv->rts)
1212 			flow_repl |= CP210X_SERIAL_RTS_FLOW_CTL;
1213 		else
1214 			flow_repl |= CP210X_SERIAL_RTS_INACTIVE;
1215 		crtscts = true;
1216 	} else {
1217 		ctl_hs &= ~CP210X_SERIAL_CTS_HANDSHAKE;
1218 		if (port_priv->rts)
1219 			flow_repl |= CP210X_SERIAL_RTS_ACTIVE;
1220 		else
1221 			flow_repl |= CP210X_SERIAL_RTS_INACTIVE;
1222 		crtscts = false;
1223 	}
1224 
1225 	if (I_IXOFF(tty)) {
1226 		flow_repl |= CP210X_SERIAL_AUTO_RECEIVE;
1227 
1228 		flow_ctl.ulXonLimit = cpu_to_le32(128);
1229 		flow_ctl.ulXoffLimit = cpu_to_le32(128);
1230 	} else {
1231 		flow_repl &= ~CP210X_SERIAL_AUTO_RECEIVE;
1232 	}
1233 
1234 	if (I_IXON(tty))
1235 		flow_repl |= CP210X_SERIAL_AUTO_TRANSMIT;
1236 	else
1237 		flow_repl &= ~CP210X_SERIAL_AUTO_TRANSMIT;
1238 
1239 	dev_dbg(&port->dev, "%s - ctrl = 0x%02x, flow = 0x%02x\n", __func__,
1240 			ctl_hs, flow_repl);
1241 
1242 	flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1243 	flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1244 
1245 	ret = cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1246 			sizeof(flow_ctl));
1247 	if (ret)
1248 		goto out_unlock;
1249 
1250 	port_priv->crtscts = crtscts;
1251 out_unlock:
1252 	mutex_unlock(&port_priv->mutex);
1253 }
1254 
cp210x_set_termios(struct tty_struct * tty,struct usb_serial_port * port,const struct ktermios * old_termios)1255 static void cp210x_set_termios(struct tty_struct *tty,
1256 		               struct usb_serial_port *port,
1257 		               const struct ktermios *old_termios)
1258 {
1259 	struct cp210x_serial_private *priv = usb_get_serial_data(port->serial);
1260 	u16 bits;
1261 	int ret;
1262 
1263 	if (old_termios && !cp210x_termios_change(&tty->termios, old_termios) &&
1264 			tty->termios.c_ospeed != 0)
1265 		return;
1266 
1267 	if (!old_termios || tty->termios.c_ospeed != old_termios->c_ospeed)
1268 		cp210x_change_speed(tty, port, old_termios);
1269 
1270 	/* CP2101 only supports CS8, 1 stop bit and non-stick parity. */
1271 	if (priv->partnum == CP210X_PARTNUM_CP2101) {
1272 		tty->termios.c_cflag &= ~(CSIZE | CSTOPB | CMSPAR);
1273 		tty->termios.c_cflag |= CS8;
1274 	}
1275 
1276 	bits = 0;
1277 
1278 	switch (C_CSIZE(tty)) {
1279 	case CS5:
1280 		bits |= BITS_DATA_5;
1281 		break;
1282 	case CS6:
1283 		bits |= BITS_DATA_6;
1284 		break;
1285 	case CS7:
1286 		bits |= BITS_DATA_7;
1287 		break;
1288 	case CS8:
1289 	default:
1290 		bits |= BITS_DATA_8;
1291 		break;
1292 	}
1293 
1294 	if (C_PARENB(tty)) {
1295 		if (C_CMSPAR(tty)) {
1296 			if (C_PARODD(tty))
1297 				bits |= BITS_PARITY_MARK;
1298 			else
1299 				bits |= BITS_PARITY_SPACE;
1300 		} else {
1301 			if (C_PARODD(tty))
1302 				bits |= BITS_PARITY_ODD;
1303 			else
1304 				bits |= BITS_PARITY_EVEN;
1305 		}
1306 	}
1307 
1308 	if (C_CSTOPB(tty))
1309 		bits |= BITS_STOP_2;
1310 	else
1311 		bits |= BITS_STOP_1;
1312 
1313 	ret = cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
1314 	if (ret)
1315 		dev_err(&port->dev, "failed to set line control: %d\n", ret);
1316 
1317 	cp210x_set_flow_control(tty, port, old_termios);
1318 
1319 	/*
1320 	 * Enable event-insertion mode only if input parity checking is
1321 	 * enabled for now.
1322 	 */
1323 	if (I_INPCK(tty))
1324 		cp210x_enable_event_mode(port);
1325 	else
1326 		cp210x_disable_event_mode(port);
1327 }
1328 
cp210x_tiocmset(struct tty_struct * tty,unsigned int set,unsigned int clear)1329 static int cp210x_tiocmset(struct tty_struct *tty,
1330 		unsigned int set, unsigned int clear)
1331 {
1332 	struct usb_serial_port *port = tty->driver_data;
1333 	return cp210x_tiocmset_port(port, set, clear);
1334 }
1335 
cp210x_tiocmset_port(struct usb_serial_port * port,unsigned int set,unsigned int clear)1336 static int cp210x_tiocmset_port(struct usb_serial_port *port,
1337 		unsigned int set, unsigned int clear)
1338 {
1339 	struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1340 	struct cp210x_flow_ctl flow_ctl;
1341 	u32 ctl_hs, flow_repl;
1342 	u16 control = 0;
1343 	int ret;
1344 
1345 	mutex_lock(&port_priv->mutex);
1346 
1347 	if (set & TIOCM_RTS) {
1348 		port_priv->rts = true;
1349 		control |= CONTROL_RTS;
1350 		control |= CONTROL_WRITE_RTS;
1351 	}
1352 	if (set & TIOCM_DTR) {
1353 		port_priv->dtr = true;
1354 		control |= CONTROL_DTR;
1355 		control |= CONTROL_WRITE_DTR;
1356 	}
1357 	if (clear & TIOCM_RTS) {
1358 		port_priv->rts = false;
1359 		control &= ~CONTROL_RTS;
1360 		control |= CONTROL_WRITE_RTS;
1361 	}
1362 	if (clear & TIOCM_DTR) {
1363 		port_priv->dtr = false;
1364 		control &= ~CONTROL_DTR;
1365 		control |= CONTROL_WRITE_DTR;
1366 	}
1367 
1368 	/*
1369 	 * Use SET_FLOW to set DTR and enable/disable auto-RTS when hardware
1370 	 * flow control is enabled.
1371 	 */
1372 	if (port_priv->crtscts && control & CONTROL_WRITE_RTS) {
1373 		ret = cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1374 				sizeof(flow_ctl));
1375 		if (ret)
1376 			goto out_unlock;
1377 
1378 		ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1379 		flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1380 
1381 		ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1382 		if (port_priv->dtr)
1383 			ctl_hs |= CP210X_SERIAL_DTR_ACTIVE;
1384 		else
1385 			ctl_hs |= CP210X_SERIAL_DTR_INACTIVE;
1386 
1387 		flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1388 		if (port_priv->rts)
1389 			flow_repl |= CP210X_SERIAL_RTS_FLOW_CTL;
1390 		else
1391 			flow_repl |= CP210X_SERIAL_RTS_INACTIVE;
1392 
1393 		flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1394 		flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1395 
1396 		dev_dbg(&port->dev, "%s - ctrl = 0x%02x, flow = 0x%02x\n",
1397 				__func__, ctl_hs, flow_repl);
1398 
1399 		ret = cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1400 				sizeof(flow_ctl));
1401 	} else {
1402 		dev_dbg(&port->dev, "%s - control = 0x%04x\n", __func__, control);
1403 
1404 		ret = cp210x_write_u16_reg(port, CP210X_SET_MHS, control);
1405 	}
1406 out_unlock:
1407 	mutex_unlock(&port_priv->mutex);
1408 
1409 	return ret;
1410 }
1411 
cp210x_dtr_rts(struct usb_serial_port * port,int on)1412 static void cp210x_dtr_rts(struct usb_serial_port *port, int on)
1413 {
1414 	if (on)
1415 		cp210x_tiocmset_port(port, TIOCM_DTR | TIOCM_RTS, 0);
1416 	else
1417 		cp210x_tiocmset_port(port, 0, TIOCM_DTR | TIOCM_RTS);
1418 }
1419 
cp210x_tiocmget(struct tty_struct * tty)1420 static int cp210x_tiocmget(struct tty_struct *tty)
1421 {
1422 	struct usb_serial_port *port = tty->driver_data;
1423 	u8 control;
1424 	int result;
1425 
1426 	result = cp210x_read_u8_reg(port, CP210X_GET_MDMSTS, &control);
1427 	if (result)
1428 		return result;
1429 
1430 	result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
1431 		|((control & CONTROL_RTS) ? TIOCM_RTS : 0)
1432 		|((control & CONTROL_CTS) ? TIOCM_CTS : 0)
1433 		|((control & CONTROL_DSR) ? TIOCM_DSR : 0)
1434 		|((control & CONTROL_RING)? TIOCM_RI  : 0)
1435 		|((control & CONTROL_DCD) ? TIOCM_CD  : 0);
1436 
1437 	dev_dbg(&port->dev, "%s - control = 0x%02x\n", __func__, control);
1438 
1439 	return result;
1440 }
1441 
cp210x_break_ctl(struct tty_struct * tty,int break_state)1442 static int cp210x_break_ctl(struct tty_struct *tty, int break_state)
1443 {
1444 	struct usb_serial_port *port = tty->driver_data;
1445 	struct cp210x_serial_private *priv = usb_get_serial_data(port->serial);
1446 	u16 state;
1447 
1448 	if (priv->partnum == CP210X_PARTNUM_CP2105) {
1449 		if (cp210x_interface_num(port->serial) == 1)
1450 			return -ENOTTY;
1451 	}
1452 
1453 	if (break_state == 0)
1454 		state = BREAK_OFF;
1455 	else
1456 		state = BREAK_ON;
1457 
1458 	dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
1459 		state == BREAK_OFF ? "off" : "on");
1460 
1461 	return cp210x_write_u16_reg(port, CP210X_SET_BREAK, state);
1462 }
1463 
1464 #ifdef CONFIG_GPIOLIB
cp210x_gpio_get(struct gpio_chip * gc,unsigned int gpio)1465 static int cp210x_gpio_get(struct gpio_chip *gc, unsigned int gpio)
1466 {
1467 	struct usb_serial *serial = gpiochip_get_data(gc);
1468 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1469 	u8 req_type;
1470 	u16 mask;
1471 	int result;
1472 	int len;
1473 
1474 	result = usb_autopm_get_interface(serial->interface);
1475 	if (result)
1476 		return result;
1477 
1478 	switch (priv->partnum) {
1479 	case CP210X_PARTNUM_CP2105:
1480 		req_type = REQTYPE_INTERFACE_TO_HOST;
1481 		len = 1;
1482 		break;
1483 	case CP210X_PARTNUM_CP2108:
1484 		req_type = REQTYPE_INTERFACE_TO_HOST;
1485 		len = 2;
1486 		break;
1487 	default:
1488 		req_type = REQTYPE_DEVICE_TO_HOST;
1489 		len = 1;
1490 		break;
1491 	}
1492 
1493 	mask = 0;
1494 	result = cp210x_read_vendor_block(serial, req_type, CP210X_READ_LATCH,
1495 					  &mask, len);
1496 
1497 	usb_autopm_put_interface(serial->interface);
1498 
1499 	if (result < 0)
1500 		return result;
1501 
1502 	le16_to_cpus(&mask);
1503 
1504 	return !!(mask & BIT(gpio));
1505 }
1506 
cp210x_gpio_set(struct gpio_chip * gc,unsigned int gpio,int value)1507 static void cp210x_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)
1508 {
1509 	struct usb_serial *serial = gpiochip_get_data(gc);
1510 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1511 	struct cp210x_gpio_write16 buf16;
1512 	struct cp210x_gpio_write buf;
1513 	u16 mask, state;
1514 	u16 wIndex;
1515 	int result;
1516 
1517 	if (value == 1)
1518 		state = BIT(gpio);
1519 	else
1520 		state = 0;
1521 
1522 	mask = BIT(gpio);
1523 
1524 	result = usb_autopm_get_interface(serial->interface);
1525 	if (result)
1526 		goto out;
1527 
1528 	switch (priv->partnum) {
1529 	case CP210X_PARTNUM_CP2105:
1530 		buf.mask = (u8)mask;
1531 		buf.state = (u8)state;
1532 		result = cp210x_write_vendor_block(serial,
1533 						   REQTYPE_HOST_TO_INTERFACE,
1534 						   CP210X_WRITE_LATCH, &buf,
1535 						   sizeof(buf));
1536 		break;
1537 	case CP210X_PARTNUM_CP2108:
1538 		buf16.mask = cpu_to_le16(mask);
1539 		buf16.state = cpu_to_le16(state);
1540 		result = cp210x_write_vendor_block(serial,
1541 						   REQTYPE_HOST_TO_INTERFACE,
1542 						   CP210X_WRITE_LATCH, &buf16,
1543 						   sizeof(buf16));
1544 		break;
1545 	default:
1546 		wIndex = state << 8 | mask;
1547 		result = usb_control_msg(serial->dev,
1548 					 usb_sndctrlpipe(serial->dev, 0),
1549 					 CP210X_VENDOR_SPECIFIC,
1550 					 REQTYPE_HOST_TO_DEVICE,
1551 					 CP210X_WRITE_LATCH,
1552 					 wIndex,
1553 					 NULL, 0, USB_CTRL_SET_TIMEOUT);
1554 		break;
1555 	}
1556 
1557 	usb_autopm_put_interface(serial->interface);
1558 out:
1559 	if (result < 0) {
1560 		dev_err(&serial->interface->dev, "failed to set GPIO value: %d\n",
1561 				result);
1562 	}
1563 }
1564 
cp210x_gpio_direction_get(struct gpio_chip * gc,unsigned int gpio)1565 static int cp210x_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
1566 {
1567 	struct usb_serial *serial = gpiochip_get_data(gc);
1568 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1569 
1570 	return priv->gpio_input & BIT(gpio);
1571 }
1572 
cp210x_gpio_direction_input(struct gpio_chip * gc,unsigned int gpio)1573 static int cp210x_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
1574 {
1575 	struct usb_serial *serial = gpiochip_get_data(gc);
1576 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1577 
1578 	if (priv->partnum == CP210X_PARTNUM_CP2105) {
1579 		/* hardware does not support an input mode */
1580 		return -ENOTSUPP;
1581 	}
1582 
1583 	/* push-pull pins cannot be changed to be inputs */
1584 	if (priv->gpio_pushpull & BIT(gpio))
1585 		return -EINVAL;
1586 
1587 	/* make sure to release pin if it is being driven low */
1588 	cp210x_gpio_set(gc, gpio, 1);
1589 
1590 	priv->gpio_input |= BIT(gpio);
1591 
1592 	return 0;
1593 }
1594 
cp210x_gpio_direction_output(struct gpio_chip * gc,unsigned int gpio,int value)1595 static int cp210x_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
1596 					int value)
1597 {
1598 	struct usb_serial *serial = gpiochip_get_data(gc);
1599 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1600 
1601 	priv->gpio_input &= ~BIT(gpio);
1602 	cp210x_gpio_set(gc, gpio, value);
1603 
1604 	return 0;
1605 }
1606 
cp210x_gpio_set_config(struct gpio_chip * gc,unsigned int gpio,unsigned long config)1607 static int cp210x_gpio_set_config(struct gpio_chip *gc, unsigned int gpio,
1608 				  unsigned long config)
1609 {
1610 	struct usb_serial *serial = gpiochip_get_data(gc);
1611 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1612 	enum pin_config_param param = pinconf_to_config_param(config);
1613 
1614 	/* Succeed only if in correct mode (this can't be set at runtime) */
1615 	if ((param == PIN_CONFIG_DRIVE_PUSH_PULL) &&
1616 	    (priv->gpio_pushpull & BIT(gpio)))
1617 		return 0;
1618 
1619 	if ((param == PIN_CONFIG_DRIVE_OPEN_DRAIN) &&
1620 	    !(priv->gpio_pushpull & BIT(gpio)))
1621 		return 0;
1622 
1623 	return -ENOTSUPP;
1624 }
1625 
cp210x_gpio_init_valid_mask(struct gpio_chip * gc,unsigned long * valid_mask,unsigned int ngpios)1626 static int cp210x_gpio_init_valid_mask(struct gpio_chip *gc,
1627 		unsigned long *valid_mask, unsigned int ngpios)
1628 {
1629 	struct usb_serial *serial = gpiochip_get_data(gc);
1630 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1631 	struct device *dev = &serial->interface->dev;
1632 	unsigned long altfunc_mask = priv->gpio_altfunc;
1633 
1634 	bitmap_complement(valid_mask, &altfunc_mask, ngpios);
1635 
1636 	if (bitmap_empty(valid_mask, ngpios))
1637 		dev_dbg(dev, "no pin configured for GPIO\n");
1638 	else
1639 		dev_dbg(dev, "GPIO.%*pbl configured for GPIO\n", ngpios,
1640 				valid_mask);
1641 	return 0;
1642 }
1643 
1644 /*
1645  * This function is for configuring GPIO using shared pins, where other signals
1646  * are made unavailable by configuring the use of GPIO. This is believed to be
1647  * only applicable to the cp2105 at this point, the other devices supported by
1648  * this driver that provide GPIO do so in a way that does not impact other
1649  * signals and are thus expected to have very different initialisation.
1650  */
cp2105_gpioconf_init(struct usb_serial * serial)1651 static int cp2105_gpioconf_init(struct usb_serial *serial)
1652 {
1653 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1654 	struct cp210x_pin_mode mode;
1655 	struct cp210x_dual_port_config config;
1656 	u8 intf_num = cp210x_interface_num(serial);
1657 	u8 iface_config;
1658 	int result;
1659 
1660 	result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1661 					  CP210X_GET_DEVICEMODE, &mode,
1662 					  sizeof(mode));
1663 	if (result < 0)
1664 		return result;
1665 
1666 	result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1667 					  CP210X_GET_PORTCONFIG, &config,
1668 					  sizeof(config));
1669 	if (result < 0)
1670 		return result;
1671 
1672 	/*  2 banks of GPIO - One for the pins taken from each serial port */
1673 	if (intf_num == 0) {
1674 		priv->gc.ngpio = 2;
1675 
1676 		if (mode.eci == CP210X_PIN_MODE_MODEM) {
1677 			/* mark all GPIOs of this interface as reserved */
1678 			priv->gpio_altfunc = 0xff;
1679 			return 0;
1680 		}
1681 
1682 		iface_config = config.eci_cfg;
1683 		priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1684 						CP210X_ECI_GPIO_MODE_MASK) >>
1685 						CP210X_ECI_GPIO_MODE_OFFSET);
1686 	} else if (intf_num == 1) {
1687 		priv->gc.ngpio = 3;
1688 
1689 		if (mode.sci == CP210X_PIN_MODE_MODEM) {
1690 			/* mark all GPIOs of this interface as reserved */
1691 			priv->gpio_altfunc = 0xff;
1692 			return 0;
1693 		}
1694 
1695 		iface_config = config.sci_cfg;
1696 		priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1697 						CP210X_SCI_GPIO_MODE_MASK) >>
1698 						CP210X_SCI_GPIO_MODE_OFFSET);
1699 	} else {
1700 		return -ENODEV;
1701 	}
1702 
1703 	/* mark all pins which are not in GPIO mode */
1704 	if (iface_config & CP2105_GPIO0_TXLED_MODE)	/* GPIO 0 */
1705 		priv->gpio_altfunc |= BIT(0);
1706 	if (iface_config & (CP2105_GPIO1_RXLED_MODE |	/* GPIO 1 */
1707 			CP2105_GPIO1_RS485_MODE))
1708 		priv->gpio_altfunc |= BIT(1);
1709 
1710 	/* driver implementation for CP2105 only supports outputs */
1711 	priv->gpio_input = 0;
1712 
1713 	return 0;
1714 }
1715 
cp2104_gpioconf_init(struct usb_serial * serial)1716 static int cp2104_gpioconf_init(struct usb_serial *serial)
1717 {
1718 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1719 	struct cp210x_single_port_config config;
1720 	u8 iface_config;
1721 	u8 gpio_latch;
1722 	int result;
1723 	u8 i;
1724 
1725 	result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1726 					  CP210X_GET_PORTCONFIG, &config,
1727 					  sizeof(config));
1728 	if (result < 0)
1729 		return result;
1730 
1731 	priv->gc.ngpio = 4;
1732 
1733 	iface_config = config.device_cfg;
1734 	priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1735 					CP210X_GPIO_MODE_MASK) >>
1736 					CP210X_GPIO_MODE_OFFSET);
1737 	gpio_latch = (u8)((le16_to_cpu(config.reset_state) &
1738 					CP210X_GPIO_MODE_MASK) >>
1739 					CP210X_GPIO_MODE_OFFSET);
1740 
1741 	/* mark all pins which are not in GPIO mode */
1742 	if (iface_config & CP2104_GPIO0_TXLED_MODE)	/* GPIO 0 */
1743 		priv->gpio_altfunc |= BIT(0);
1744 	if (iface_config & CP2104_GPIO1_RXLED_MODE)	/* GPIO 1 */
1745 		priv->gpio_altfunc |= BIT(1);
1746 	if (iface_config & CP2104_GPIO2_RS485_MODE)	/* GPIO 2 */
1747 		priv->gpio_altfunc |= BIT(2);
1748 
1749 	/*
1750 	 * Like CP2102N, CP2104 has also no strict input and output pin
1751 	 * modes.
1752 	 * Do the same input mode emulation as CP2102N.
1753 	 */
1754 	for (i = 0; i < priv->gc.ngpio; ++i) {
1755 		/*
1756 		 * Set direction to "input" iff pin is open-drain and reset
1757 		 * value is 1.
1758 		 */
1759 		if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1760 			priv->gpio_input |= BIT(i);
1761 	}
1762 
1763 	return 0;
1764 }
1765 
cp2108_gpio_init(struct usb_serial * serial)1766 static int cp2108_gpio_init(struct usb_serial *serial)
1767 {
1768 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1769 	struct cp210x_quad_port_config config;
1770 	u16 gpio_latch;
1771 	int result;
1772 	u8 i;
1773 
1774 	result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1775 					  CP210X_GET_PORTCONFIG, &config,
1776 					  sizeof(config));
1777 	if (result < 0)
1778 		return result;
1779 
1780 	priv->gc.ngpio = 16;
1781 	priv->gpio_pushpull = le16_to_cpu(config.reset_state.gpio_mode_pb1);
1782 	gpio_latch = le16_to_cpu(config.reset_state.gpio_latch_pb1);
1783 
1784 	/*
1785 	 * Mark all pins which are not in GPIO mode.
1786 	 *
1787 	 * Refer to table 9.1 "GPIO Mode alternate Functions" in the datasheet:
1788 	 * https://www.silabs.com/documents/public/data-sheets/cp2108-datasheet.pdf
1789 	 *
1790 	 * Alternate functions of GPIO0 to GPIO3 are determine by enhancedfxn_ifc[0]
1791 	 * and the similarly for the other pins; enhancedfxn_ifc[1]: GPIO4 to GPIO7,
1792 	 * enhancedfxn_ifc[2]: GPIO8 to GPIO11, enhancedfxn_ifc[3]: GPIO12 to GPIO15.
1793 	 */
1794 	for (i = 0; i < 4; i++) {
1795 		if (config.enhancedfxn_ifc[i] & CP2108_EF_IFC_GPIO_TXLED)
1796 			priv->gpio_altfunc |= BIT(i * 4);
1797 		if (config.enhancedfxn_ifc[i] & CP2108_EF_IFC_GPIO_RXLED)
1798 			priv->gpio_altfunc |= BIT((i * 4) + 1);
1799 		if (config.enhancedfxn_ifc[i] & CP2108_EF_IFC_GPIO_RS485)
1800 			priv->gpio_altfunc |= BIT((i * 4) + 2);
1801 		if (config.enhancedfxn_ifc[i] & CP2108_EF_IFC_GPIO_CLOCK)
1802 			priv->gpio_altfunc |= BIT((i * 4) + 3);
1803 	}
1804 
1805 	/*
1806 	 * Like CP2102N, CP2108 has also no strict input and output pin
1807 	 * modes. Do the same input mode emulation as CP2102N.
1808 	 */
1809 	for (i = 0; i < priv->gc.ngpio; ++i) {
1810 		/*
1811 		 * Set direction to "input" iff pin is open-drain and reset
1812 		 * value is 1.
1813 		 */
1814 		if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1815 			priv->gpio_input |= BIT(i);
1816 	}
1817 
1818 	return 0;
1819 }
1820 
cp2102n_gpioconf_init(struct usb_serial * serial)1821 static int cp2102n_gpioconf_init(struct usb_serial *serial)
1822 {
1823 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1824 	const u16 config_size = 0x02a6;
1825 	u8 gpio_rst_latch;
1826 	u8 config_version;
1827 	u8 gpio_pushpull;
1828 	u8 *config_buf;
1829 	u8 gpio_latch;
1830 	u8 gpio_ctrl;
1831 	int result;
1832 	u8 i;
1833 
1834 	/*
1835 	 * Retrieve device configuration from the device.
1836 	 * The array received contains all customization settings done at the
1837 	 * factory/manufacturer. Format of the array is documented at the
1838 	 * time of writing at:
1839 	 * https://www.silabs.com/community/interface/knowledge-base.entry.html/2017/03/31/cp2102n_setconfig-xsfa
1840 	 */
1841 	config_buf = kmalloc(config_size, GFP_KERNEL);
1842 	if (!config_buf)
1843 		return -ENOMEM;
1844 
1845 	result = cp210x_read_vendor_block(serial,
1846 					  REQTYPE_DEVICE_TO_HOST,
1847 					  CP210X_READ_2NCONFIG,
1848 					  config_buf,
1849 					  config_size);
1850 	if (result < 0) {
1851 		kfree(config_buf);
1852 		return result;
1853 	}
1854 
1855 	config_version = config_buf[CP210X_2NCONFIG_CONFIG_VERSION_IDX];
1856 	gpio_pushpull = config_buf[CP210X_2NCONFIG_GPIO_MODE_IDX];
1857 	gpio_ctrl = config_buf[CP210X_2NCONFIG_GPIO_CONTROL_IDX];
1858 	gpio_rst_latch = config_buf[CP210X_2NCONFIG_GPIO_RSTLATCH_IDX];
1859 
1860 	kfree(config_buf);
1861 
1862 	/* Make sure this is a config format we understand. */
1863 	if (config_version != 0x01)
1864 		return -ENOTSUPP;
1865 
1866 	priv->gc.ngpio = 4;
1867 
1868 	/*
1869 	 * Get default pin states after reset. Needed so we can determine
1870 	 * the direction of an open-drain pin.
1871 	 */
1872 	gpio_latch = (gpio_rst_latch >> 3) & 0x0f;
1873 
1874 	/* 0 indicates open-drain mode, 1 is push-pull */
1875 	priv->gpio_pushpull = (gpio_pushpull >> 3) & 0x0f;
1876 
1877 	/* 0 indicates GPIO mode, 1 is alternate function */
1878 	if (priv->partnum == CP210X_PARTNUM_CP2102N_QFN20) {
1879 		/* QFN20 is special... */
1880 		if (gpio_ctrl & CP2102N_QFN20_GPIO0_CLK_MODE)   /* GPIO 0 */
1881 			priv->gpio_altfunc |= BIT(0);
1882 		if (gpio_ctrl & CP2102N_QFN20_GPIO1_RS485_MODE) /* GPIO 1 */
1883 			priv->gpio_altfunc |= BIT(1);
1884 		if (gpio_ctrl & CP2102N_QFN20_GPIO2_TXLED_MODE) /* GPIO 2 */
1885 			priv->gpio_altfunc |= BIT(2);
1886 		if (gpio_ctrl & CP2102N_QFN20_GPIO3_RXLED_MODE) /* GPIO 3 */
1887 			priv->gpio_altfunc |= BIT(3);
1888 	} else {
1889 		priv->gpio_altfunc = (gpio_ctrl >> 2) & 0x0f;
1890 	}
1891 
1892 	if (priv->partnum == CP210X_PARTNUM_CP2102N_QFN28) {
1893 		/*
1894 		 * For the QFN28 package, GPIO4-6 are controlled by
1895 		 * the low three bits of the mode/latch fields.
1896 		 * Contrary to the document linked above, the bits for
1897 		 * the SUSPEND pins are elsewhere.  No alternate
1898 		 * function is available for these pins.
1899 		 */
1900 		priv->gc.ngpio = 7;
1901 		gpio_latch |= (gpio_rst_latch & 7) << 4;
1902 		priv->gpio_pushpull |= (gpio_pushpull & 7) << 4;
1903 	}
1904 
1905 	/*
1906 	 * The CP2102N does not strictly has input and output pin modes,
1907 	 * it only knows open-drain and push-pull modes which is set at
1908 	 * factory. An open-drain pin can function both as an
1909 	 * input or an output. We emulate input mode for open-drain pins
1910 	 * by making sure they are not driven low, and we do not allow
1911 	 * push-pull pins to be set as an input.
1912 	 */
1913 	for (i = 0; i < priv->gc.ngpio; ++i) {
1914 		/*
1915 		 * Set direction to "input" iff pin is open-drain and reset
1916 		 * value is 1.
1917 		 */
1918 		if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1919 			priv->gpio_input |= BIT(i);
1920 	}
1921 
1922 	return 0;
1923 }
1924 
cp210x_gpio_init(struct usb_serial * serial)1925 static int cp210x_gpio_init(struct usb_serial *serial)
1926 {
1927 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1928 	int result;
1929 
1930 	switch (priv->partnum) {
1931 	case CP210X_PARTNUM_CP2104:
1932 		result = cp2104_gpioconf_init(serial);
1933 		break;
1934 	case CP210X_PARTNUM_CP2105:
1935 		result = cp2105_gpioconf_init(serial);
1936 		break;
1937 	case CP210X_PARTNUM_CP2108:
1938 		/*
1939 		 * The GPIOs are not tied to any specific port so only register
1940 		 * once for interface 0.
1941 		 */
1942 		if (cp210x_interface_num(serial) != 0)
1943 			return 0;
1944 		result = cp2108_gpio_init(serial);
1945 		break;
1946 	case CP210X_PARTNUM_CP2102N_QFN28:
1947 	case CP210X_PARTNUM_CP2102N_QFN24:
1948 	case CP210X_PARTNUM_CP2102N_QFN20:
1949 		result = cp2102n_gpioconf_init(serial);
1950 		break;
1951 	default:
1952 		return 0;
1953 	}
1954 
1955 	if (result < 0)
1956 		return result;
1957 
1958 	priv->gc.label = "cp210x";
1959 	priv->gc.get_direction = cp210x_gpio_direction_get;
1960 	priv->gc.direction_input = cp210x_gpio_direction_input;
1961 	priv->gc.direction_output = cp210x_gpio_direction_output;
1962 	priv->gc.get = cp210x_gpio_get;
1963 	priv->gc.set = cp210x_gpio_set;
1964 	priv->gc.set_config = cp210x_gpio_set_config;
1965 	priv->gc.init_valid_mask = cp210x_gpio_init_valid_mask;
1966 	priv->gc.owner = THIS_MODULE;
1967 	priv->gc.parent = &serial->interface->dev;
1968 	priv->gc.base = -1;
1969 	priv->gc.can_sleep = true;
1970 
1971 	result = gpiochip_add_data(&priv->gc, serial);
1972 	if (!result)
1973 		priv->gpio_registered = true;
1974 
1975 	return result;
1976 }
1977 
cp210x_gpio_remove(struct usb_serial * serial)1978 static void cp210x_gpio_remove(struct usb_serial *serial)
1979 {
1980 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1981 
1982 	if (priv->gpio_registered) {
1983 		gpiochip_remove(&priv->gc);
1984 		priv->gpio_registered = false;
1985 	}
1986 }
1987 
1988 #else
1989 
cp210x_gpio_init(struct usb_serial * serial)1990 static int cp210x_gpio_init(struct usb_serial *serial)
1991 {
1992 	return 0;
1993 }
1994 
cp210x_gpio_remove(struct usb_serial * serial)1995 static void cp210x_gpio_remove(struct usb_serial *serial)
1996 {
1997 	/* Nothing to do */
1998 }
1999 
2000 #endif
2001 
cp210x_port_probe(struct usb_serial_port * port)2002 static int cp210x_port_probe(struct usb_serial_port *port)
2003 {
2004 	struct usb_serial *serial = port->serial;
2005 	struct cp210x_port_private *port_priv;
2006 
2007 	port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
2008 	if (!port_priv)
2009 		return -ENOMEM;
2010 
2011 	port_priv->bInterfaceNumber = cp210x_interface_num(serial);
2012 	mutex_init(&port_priv->mutex);
2013 
2014 	usb_set_serial_port_data(port, port_priv);
2015 
2016 	return 0;
2017 }
2018 
cp210x_port_remove(struct usb_serial_port * port)2019 static void cp210x_port_remove(struct usb_serial_port *port)
2020 {
2021 	struct cp210x_port_private *port_priv;
2022 
2023 	port_priv = usb_get_serial_port_data(port);
2024 	kfree(port_priv);
2025 }
2026 
cp210x_init_max_speed(struct usb_serial * serial)2027 static void cp210x_init_max_speed(struct usb_serial *serial)
2028 {
2029 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2030 	bool use_actual_rate = false;
2031 	speed_t min = 300;
2032 	speed_t max;
2033 
2034 	switch (priv->partnum) {
2035 	case CP210X_PARTNUM_CP2101:
2036 		max = 921600;
2037 		break;
2038 	case CP210X_PARTNUM_CP2102:
2039 	case CP210X_PARTNUM_CP2103:
2040 		max = 1000000;
2041 		break;
2042 	case CP210X_PARTNUM_CP2104:
2043 		use_actual_rate = true;
2044 		max = 2000000;
2045 		break;
2046 	case CP210X_PARTNUM_CP2108:
2047 		max = 2000000;
2048 		break;
2049 	case CP210X_PARTNUM_CP2105:
2050 		if (cp210x_interface_num(serial) == 0) {
2051 			use_actual_rate = true;
2052 			max = 2000000;	/* ECI */
2053 		} else {
2054 			min = 2400;
2055 			max = 921600;	/* SCI */
2056 		}
2057 		break;
2058 	case CP210X_PARTNUM_CP2102N_QFN28:
2059 	case CP210X_PARTNUM_CP2102N_QFN24:
2060 	case CP210X_PARTNUM_CP2102N_QFN20:
2061 		use_actual_rate = true;
2062 		max = 3000000;
2063 		break;
2064 	default:
2065 		max = 2000000;
2066 		break;
2067 	}
2068 
2069 	priv->min_speed = min;
2070 	priv->max_speed = max;
2071 	priv->use_actual_rate = use_actual_rate;
2072 }
2073 
cp2102_determine_quirks(struct usb_serial * serial)2074 static void cp2102_determine_quirks(struct usb_serial *serial)
2075 {
2076 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2077 	u8 *buf;
2078 	int ret;
2079 
2080 	buf = kmalloc(2, GFP_KERNEL);
2081 	if (!buf)
2082 		return;
2083 	/*
2084 	 * Some (possibly counterfeit) CP2102 do not support event-insertion
2085 	 * mode and respond differently to malformed vendor requests.
2086 	 * Specifically, they return one instead of two bytes when sent a
2087 	 * two-byte part-number request.
2088 	 */
2089 	ret = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
2090 			CP210X_VENDOR_SPECIFIC, REQTYPE_DEVICE_TO_HOST,
2091 			CP210X_GET_PARTNUM, 0, buf, 2, USB_CTRL_GET_TIMEOUT);
2092 	if (ret == 1) {
2093 		dev_dbg(&serial->interface->dev,
2094 				"device does not support event-insertion mode\n");
2095 		priv->no_event_mode = true;
2096 	}
2097 
2098 	kfree(buf);
2099 }
2100 
cp210x_get_fw_version(struct usb_serial * serial,u16 value)2101 static int cp210x_get_fw_version(struct usb_serial *serial, u16 value)
2102 {
2103 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2104 	u8 ver[3];
2105 	int ret;
2106 
2107 	ret = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST, value,
2108 			ver, sizeof(ver));
2109 	if (ret)
2110 		return ret;
2111 
2112 	dev_dbg(&serial->interface->dev, "%s - %d.%d.%d\n", __func__,
2113 			ver[0], ver[1], ver[2]);
2114 
2115 	priv->fw_version = ver[0] << 16 | ver[1] << 8 | ver[2];
2116 
2117 	return 0;
2118 }
2119 
cp210x_determine_type(struct usb_serial * serial)2120 static void cp210x_determine_type(struct usb_serial *serial)
2121 {
2122 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2123 	int ret;
2124 
2125 	ret = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
2126 			CP210X_GET_PARTNUM, &priv->partnum,
2127 			sizeof(priv->partnum));
2128 	if (ret < 0) {
2129 		dev_warn(&serial->interface->dev,
2130 				"querying part number failed\n");
2131 		priv->partnum = CP210X_PARTNUM_UNKNOWN;
2132 		return;
2133 	}
2134 
2135 	dev_dbg(&serial->interface->dev, "partnum = 0x%02x\n", priv->partnum);
2136 
2137 	switch (priv->partnum) {
2138 	case CP210X_PARTNUM_CP2102:
2139 		cp2102_determine_quirks(serial);
2140 		break;
2141 	case CP210X_PARTNUM_CP2105:
2142 	case CP210X_PARTNUM_CP2108:
2143 		cp210x_get_fw_version(serial, CP210X_GET_FW_VER);
2144 		break;
2145 	case CP210X_PARTNUM_CP2102N_QFN28:
2146 	case CP210X_PARTNUM_CP2102N_QFN24:
2147 	case CP210X_PARTNUM_CP2102N_QFN20:
2148 		ret = cp210x_get_fw_version(serial, CP210X_GET_FW_VER_2N);
2149 		if (ret)
2150 			break;
2151 		if (priv->fw_version <= 0x10004)
2152 			priv->no_flow_control = true;
2153 		break;
2154 	default:
2155 		break;
2156 	}
2157 }
2158 
cp210x_attach(struct usb_serial * serial)2159 static int cp210x_attach(struct usb_serial *serial)
2160 {
2161 	int result;
2162 	struct cp210x_serial_private *priv;
2163 
2164 	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
2165 	if (!priv)
2166 		return -ENOMEM;
2167 
2168 	usb_set_serial_data(serial, priv);
2169 
2170 	cp210x_determine_type(serial);
2171 	cp210x_init_max_speed(serial);
2172 
2173 	result = cp210x_gpio_init(serial);
2174 	if (result < 0) {
2175 		dev_err(&serial->interface->dev, "GPIO initialisation failed: %d\n",
2176 				result);
2177 	}
2178 
2179 	return 0;
2180 }
2181 
cp210x_disconnect(struct usb_serial * serial)2182 static void cp210x_disconnect(struct usb_serial *serial)
2183 {
2184 	cp210x_gpio_remove(serial);
2185 }
2186 
cp210x_release(struct usb_serial * serial)2187 static void cp210x_release(struct usb_serial *serial)
2188 {
2189 	struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2190 
2191 	cp210x_gpio_remove(serial);
2192 
2193 	kfree(priv);
2194 }
2195 
2196 module_usb_serial_driver(serial_drivers, id_table);
2197 
2198 MODULE_DESCRIPTION(DRIVER_DESC);
2199 MODULE_LICENSE("GPL v2");
2200