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