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