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