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