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