1 // SPDX-License-Identifier: GPL-2.0
3 * Silicon Laboratories CP210x USB to RS232 serial adaptor driver
5 * Copyright (C) 2005 Craig Shelley (craig@microtron.org.uk)
6 * Copyright (C) 2010-2021 Johan Hovold (johan@kernel.org)
8 * Support to set flow control line levels using TIOCMGET and TIOCMSET
9 * thanks to Karl Hiramoto karl@hiramoto.org. RTSCTS hardware flow
10 * control thanks to Munir Nassar nassarmu@real-time.com
14 #include <linux/kernel.h>
15 #include <linux/errno.h>
16 #include <linux/slab.h>
17 #include <linux/tty.h>
18 #include <linux/tty_flip.h>
19 #include <linux/module.h>
20 #include <linux/usb.h>
21 #include <linux/usb/serial.h>
22 #include <linux/gpio/driver.h>
23 #include <linux/bitops.h>
24 #include <linux/mutex.h>
26 #define DRIVER_DESC "Silicon Labs CP210x RS232 serial adaptor driver"
31 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *);
32 static void cp210x_close(struct usb_serial_port *);
33 static void cp210x_change_speed(struct tty_struct *, struct usb_serial_port *,
34 const struct ktermios *);
35 static void cp210x_set_termios(struct tty_struct *, struct usb_serial_port *,
36 const struct ktermios *);
37 static bool cp210x_tx_empty(struct usb_serial_port *port);
38 static int cp210x_tiocmget(struct tty_struct *);
39 static int cp210x_tiocmset(struct tty_struct *, unsigned int, unsigned int);
40 static int cp210x_tiocmset_port(struct usb_serial_port *port,
41 unsigned int, unsigned int);
42 static int cp210x_break_ctl(struct tty_struct *, int);
43 static int cp210x_attach(struct usb_serial *);
44 static void cp210x_disconnect(struct usb_serial *);
45 static void cp210x_release(struct usb_serial *);
46 static int cp210x_port_probe(struct usb_serial_port *);
47 static void cp210x_port_remove(struct usb_serial_port *);
48 static void cp210x_dtr_rts(struct usb_serial_port *port, int on);
49 static void cp210x_process_read_urb(struct urb *urb);
50 static void cp210x_enable_event_mode(struct usb_serial_port *port);
51 static void cp210x_disable_event_mode(struct usb_serial_port *port);
53 static const struct usb_device_id id_table[] = {
54 { USB_DEVICE(0x0404, 0x034C) }, /* NCR Retail IO Box */
55 { USB_DEVICE(0x045B, 0x0053) }, /* Renesas RX610 RX-Stick */
56 { USB_DEVICE(0x0471, 0x066A) }, /* AKTAKOM ACE-1001 cable */
57 { USB_DEVICE(0x0489, 0xE000) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
58 { USB_DEVICE(0x0489, 0xE003) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
59 { USB_DEVICE(0x0745, 0x1000) }, /* CipherLab USB CCD Barcode Scanner 1000 */
60 { USB_DEVICE(0x0846, 0x1100) }, /* NetGear Managed Switch M4100 series, M5300 series, M7100 series */
61 { USB_DEVICE(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
62 { USB_DEVICE(0x08FD, 0x000A) }, /* Digianswer A/S , ZigBee/802.15.4 MAC Device */
63 { USB_DEVICE(0x0908, 0x0070) }, /* Siemens SCALANCE LPE-9000 USB Serial Console */
64 { USB_DEVICE(0x0908, 0x01FF) }, /* Siemens RUGGEDCOM USB Serial Console */
65 { USB_DEVICE(0x0988, 0x0578) }, /* Teraoka AD2000 */
66 { USB_DEVICE(0x0B00, 0x3070) }, /* Ingenico 3070 */
67 { USB_DEVICE(0x0BED, 0x1100) }, /* MEI (TM) Cashflow-SC Bill/Voucher Acceptor */
68 { USB_DEVICE(0x0BED, 0x1101) }, /* MEI series 2000 Combo Acceptor */
69 { USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
70 { USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
71 { USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */
72 { USB_DEVICE(0x0FDE, 0xCA05) }, /* OWL Wireless Electricity Monitor CM-160 */
73 { USB_DEVICE(0x106F, 0x0003) }, /* CPI / Money Controls Bulk Coin Recycler */
74 { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
75 { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
76 { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
77 { USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */
78 { USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */
79 { USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */
80 { USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
81 { USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
82 { USB_DEVICE(0x10C4, 0x8044) }, /* Cygnal Debug Adapter */
83 { USB_DEVICE(0x10C4, 0x804E) }, /* Software Bisque Paramount ME build-in converter */
84 { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
85 { USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */
86 { USB_DEVICE(0x10C4, 0x8056) }, /* Lorenz Messtechnik devices */
87 { USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
88 { USB_DEVICE(0x10C4, 0x806F) }, /* IMS USB to RS422 Converter Cable */
89 { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
90 { USB_DEVICE(0x10C4, 0x80C4) }, /* Cygnal Integrated Products, Inc., Optris infrared thermometer */
91 { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
92 { USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
93 { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
94 { USB_DEVICE(0x10C4, 0x8115) }, /* Arygon NFC/Mifare Reader */
95 { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
96 { USB_DEVICE(0x10C4, 0x813F) }, /* Tams Master Easy Control */
97 { USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
98 { USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
99 { USB_DEVICE(0x2405, 0x0003) }, /* West Mountain Radio RIGblaster Advantage */
100 { USB_DEVICE(0x10C4, 0x8156) }, /* B&G H3000 link cable */
101 { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
102 { USB_DEVICE(0x10C4, 0x815F) }, /* Timewave HamLinkUSB */
103 { USB_DEVICE(0x10C4, 0x817C) }, /* CESINEL MEDCAL N Power Quality Monitor */
104 { USB_DEVICE(0x10C4, 0x817D) }, /* CESINEL MEDCAL NT Power Quality Monitor */
105 { USB_DEVICE(0x10C4, 0x817E) }, /* CESINEL MEDCAL S Power Quality Monitor */
106 { USB_DEVICE(0x10C4, 0x818B) }, /* AVIT Research USB to TTL */
107 { USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
108 { USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
109 { USB_DEVICE(0x10C4, 0x81A9) }, /* Multiplex RC Interface */
110 { USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
111 { USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */
112 { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
113 { USB_DEVICE(0x10C4, 0x81D7) }, /* IAI Corp. RCB-CV-USB USB to RS485 Adaptor */
114 { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
115 { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
116 { USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
117 { USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
118 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
119 { USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
120 { USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
121 { USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */
122 { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
123 { USB_DEVICE(0x10C4, 0x82AA) }, /* Silicon Labs IFS-USB-DATACABLE used with Quint UPS */
124 { USB_DEVICE(0x10C4, 0x82EF) }, /* CESINEL FALCO 6105 AC Power Supply */
125 { USB_DEVICE(0x10C4, 0x82F1) }, /* CESINEL MEDCAL EFD Earth Fault Detector */
126 { USB_DEVICE(0x10C4, 0x82F2) }, /* CESINEL MEDCAL ST Network Analyzer */
127 { USB_DEVICE(0x10C4, 0x82F4) }, /* Starizona MicroTouch */
128 { USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
129 { USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
130 { USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
131 { USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
132 { USB_DEVICE(0x10C4, 0x83AA) }, /* Mark-10 Digital Force Gauge */
133 { USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
134 { USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
135 { USB_DEVICE(0x10C4, 0x8414) }, /* Decagon USB Cable Adapter */
136 { USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
137 { USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
138 { USB_DEVICE(0x10C4, 0x8470) }, /* Juniper Networks BX Series System Console */
139 { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
140 { USB_DEVICE(0x10C4, 0x84B6) }, /* Starizona Hyperion */
141 { USB_DEVICE(0x10C4, 0x851E) }, /* CESINEL MEDCAL PT Network Analyzer */
142 { USB_DEVICE(0x10C4, 0x85A7) }, /* LifeScan OneTouch Verio IQ */
143 { USB_DEVICE(0x10C4, 0x85B8) }, /* CESINEL ReCon T Energy Logger */
144 { USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
145 { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
146 { USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
147 { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
148 { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
149 { USB_DEVICE(0x10C4, 0x87ED) }, /* IMST USB-Stick for Smart Meter */
150 { USB_DEVICE(0x10C4, 0x8856) }, /* CEL EM357 ZigBee USB Stick - LR */
151 { USB_DEVICE(0x10C4, 0x8857) }, /* CEL EM357 ZigBee USB Stick */
152 { USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
153 { USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
154 { USB_DEVICE(0x10C4, 0x88D8) }, /* Acuity Brands nLight Air Adapter */
155 { USB_DEVICE(0x10C4, 0x88FB) }, /* CESINEL MEDCAL STII Network Analyzer */
156 { USB_DEVICE(0x10C4, 0x8938) }, /* CESINEL MEDCAL S II Network Analyzer */
157 { USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
158 { USB_DEVICE(0x10C4, 0x8962) }, /* Brim Brothers charging dock */
159 { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit Device */
160 { USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
161 { USB_DEVICE(0x10C4, 0x89A4) }, /* CESINEL FTBC Flexible Thyristor Bridge Controller */
162 { USB_DEVICE(0x10C4, 0x89FB) }, /* Qivicon ZigBee USB Radio Stick */
163 { USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
164 { USB_DEVICE(0x10C4, 0x8A5B) }, /* CEL EM3588 ZigBee USB Stick */
165 { USB_DEVICE(0x10C4, 0x8A5E) }, /* CEL EM3588 ZigBee USB Stick Long Range */
166 { USB_DEVICE(0x10C4, 0x8B34) }, /* Qivicon ZigBee USB Radio Stick */
167 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
168 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
169 { USB_DEVICE(0x10C4, 0xEA63) }, /* Silicon Labs Windows Update (CP2101-4/CP2102N) */
170 { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
171 { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
172 { USB_DEVICE(0x10C4, 0xEA7A) }, /* Silicon Labs Windows Update (CP2105) */
173 { USB_DEVICE(0x10C4, 0xEA7B) }, /* Silicon Labs Windows Update (CP2108) */
174 { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
175 { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
176 { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
177 { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
178 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
179 { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
180 { USB_DEVICE(0x12B8, 0xEC60) }, /* Link G4 ECU */
181 { USB_DEVICE(0x12B8, 0xEC62) }, /* Link G4+ ECU */
182 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
183 { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
184 { USB_DEVICE(0x155A, 0x1006) }, /* ELDAT Easywave RX09 */
185 { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
186 { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
187 { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
188 { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
189 { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
190 { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
191 { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
192 { USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
193 { USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
194 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
195 { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
196 { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
197 { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
198 { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
199 { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
200 { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
201 { USB_DEVICE(0x17A8, 0x0011) }, /* Kamstrup 444 MHz RF sniffer */
202 { USB_DEVICE(0x17A8, 0x0013) }, /* Kamstrup 870 MHz RF sniffer */
203 { USB_DEVICE(0x17A8, 0x0101) }, /* Kamstrup 868 MHz wM-Bus C-Mode Meter Reader (Int Ant) */
204 { USB_DEVICE(0x17A8, 0x0102) }, /* Kamstrup 868 MHz wM-Bus C-Mode Meter Reader (Ext Ant) */
205 { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
206 { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
207 { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
208 { USB_DEVICE(0x18EF, 0xE025) }, /* ELV Marble Sound Board 1 */
209 { USB_DEVICE(0x18EF, 0xE030) }, /* ELV ALC 8xxx Battery Charger */
210 { USB_DEVICE(0x18EF, 0xE032) }, /* ELV TFD500 Data Logger */
211 { USB_DEVICE(0x1901, 0x0190) }, /* GE B850 CP2105 Recorder interface */
212 { USB_DEVICE(0x1901, 0x0193) }, /* GE B650 CP2104 PMC interface */
213 { USB_DEVICE(0x1901, 0x0194) }, /* GE Healthcare Remote Alarm Box */
214 { USB_DEVICE(0x1901, 0x0195) }, /* GE B850/B650/B450 CP2104 DP UART interface */
215 { USB_DEVICE(0x1901, 0x0196) }, /* GE B850 CP2105 DP UART interface */
216 { USB_DEVICE(0x1901, 0x0197) }, /* GE CS1000 M.2 Key E serial interface */
217 { USB_DEVICE(0x1901, 0x0198) }, /* GE CS1000 Display serial interface */
218 { USB_DEVICE(0x199B, 0xBA30) }, /* LORD WSDA-200-USB */
219 { USB_DEVICE(0x19CF, 0x3000) }, /* Parrot NMEA GPS Flight Recorder */
220 { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
221 { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
222 { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
223 { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
224 { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
225 { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
226 { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
227 { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
228 { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
229 { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
230 { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
231 { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
232 { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
233 { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
234 { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
235 { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
236 { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
237 { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
238 { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
239 { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
240 { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
241 { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
242 { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
243 { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
244 { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
245 { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
246 { USB_DEVICE(0x2184, 0x0030) }, /* GW Instek GDM-834x Digital Multimeter */
247 { USB_DEVICE(0x2626, 0xEA60) }, /* Aruba Networks 7xxx USB Serial Console */
248 { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
249 { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
250 { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
251 { USB_DEVICE(0x3923, 0x7A0B) }, /* National Instruments USB Serial Console */
252 { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
253 { } /* Terminating Entry */
256 MODULE_DEVICE_TABLE(usb, id_table);
258 struct cp210x_serial_private {
259 #ifdef CONFIG_GPIOLIB
261 bool gpio_registered;
270 bool use_actual_rate;
271 bool no_flow_control;
275 enum cp210x_event_state {
284 struct cp210x_port_private {
287 enum cp210x_event_state event_state;
296 static struct usb_serial_driver cp210x_device = {
298 .owner = THIS_MODULE,
301 .id_table = id_table,
304 .bulk_out_size = 256,
306 .close = cp210x_close,
307 .break_ctl = cp210x_break_ctl,
308 .set_termios = cp210x_set_termios,
309 .tx_empty = cp210x_tx_empty,
310 .throttle = usb_serial_generic_throttle,
311 .unthrottle = usb_serial_generic_unthrottle,
312 .tiocmget = cp210x_tiocmget,
313 .tiocmset = cp210x_tiocmset,
314 .get_icount = usb_serial_generic_get_icount,
315 .attach = cp210x_attach,
316 .disconnect = cp210x_disconnect,
317 .release = cp210x_release,
318 .port_probe = cp210x_port_probe,
319 .port_remove = cp210x_port_remove,
320 .dtr_rts = cp210x_dtr_rts,
321 .process_read_urb = cp210x_process_read_urb,
324 static struct usb_serial_driver * const serial_drivers[] = {
328 /* Config request types */
329 #define REQTYPE_HOST_TO_INTERFACE 0x41
330 #define REQTYPE_INTERFACE_TO_HOST 0xc1
331 #define REQTYPE_HOST_TO_DEVICE 0x40
332 #define REQTYPE_DEVICE_TO_HOST 0xc0
334 /* Config request codes */
335 #define CP210X_IFC_ENABLE 0x00
336 #define CP210X_SET_BAUDDIV 0x01
337 #define CP210X_GET_BAUDDIV 0x02
338 #define CP210X_SET_LINE_CTL 0x03
339 #define CP210X_GET_LINE_CTL 0x04
340 #define CP210X_SET_BREAK 0x05
341 #define CP210X_IMM_CHAR 0x06
342 #define CP210X_SET_MHS 0x07
343 #define CP210X_GET_MDMSTS 0x08
344 #define CP210X_SET_XON 0x09
345 #define CP210X_SET_XOFF 0x0A
346 #define CP210X_SET_EVENTMASK 0x0B
347 #define CP210X_GET_EVENTMASK 0x0C
348 #define CP210X_SET_CHAR 0x0D
349 #define CP210X_GET_CHARS 0x0E
350 #define CP210X_GET_PROPS 0x0F
351 #define CP210X_GET_COMM_STATUS 0x10
352 #define CP210X_RESET 0x11
353 #define CP210X_PURGE 0x12
354 #define CP210X_SET_FLOW 0x13
355 #define CP210X_GET_FLOW 0x14
356 #define CP210X_EMBED_EVENTS 0x15
357 #define CP210X_GET_EVENTSTATE 0x16
358 #define CP210X_SET_CHARS 0x19
359 #define CP210X_GET_BAUDRATE 0x1D
360 #define CP210X_SET_BAUDRATE 0x1E
361 #define CP210X_VENDOR_SPECIFIC 0xFF
363 /* CP210X_IFC_ENABLE */
364 #define UART_ENABLE 0x0001
365 #define UART_DISABLE 0x0000
367 /* CP210X_(SET|GET)_BAUDDIV */
368 #define BAUD_RATE_GEN_FREQ 0x384000
370 /* CP210X_(SET|GET)_LINE_CTL */
371 #define BITS_DATA_MASK 0X0f00
372 #define BITS_DATA_5 0X0500
373 #define BITS_DATA_6 0X0600
374 #define BITS_DATA_7 0X0700
375 #define BITS_DATA_8 0X0800
376 #define BITS_DATA_9 0X0900
378 #define BITS_PARITY_MASK 0x00f0
379 #define BITS_PARITY_NONE 0x0000
380 #define BITS_PARITY_ODD 0x0010
381 #define BITS_PARITY_EVEN 0x0020
382 #define BITS_PARITY_MARK 0x0030
383 #define BITS_PARITY_SPACE 0x0040
385 #define BITS_STOP_MASK 0x000f
386 #define BITS_STOP_1 0x0000
387 #define BITS_STOP_1_5 0x0001
388 #define BITS_STOP_2 0x0002
390 /* CP210X_SET_BREAK */
391 #define BREAK_ON 0x0001
392 #define BREAK_OFF 0x0000
394 /* CP210X_(SET_MHS|GET_MDMSTS) */
395 #define CONTROL_DTR 0x0001
396 #define CONTROL_RTS 0x0002
397 #define CONTROL_CTS 0x0010
398 #define CONTROL_DSR 0x0020
399 #define CONTROL_RING 0x0040
400 #define CONTROL_DCD 0x0080
401 #define CONTROL_WRITE_DTR 0x0100
402 #define CONTROL_WRITE_RTS 0x0200
404 /* CP210X_(GET|SET)_CHARS */
405 struct cp210x_special_chars {
414 /* CP210X_VENDOR_SPECIFIC values */
415 #define CP210X_GET_FW_VER 0x000E
416 #define CP210X_READ_2NCONFIG 0x000E
417 #define CP210X_GET_FW_VER_2N 0x0010
418 #define CP210X_READ_LATCH 0x00C2
419 #define CP210X_GET_PARTNUM 0x370B
420 #define CP210X_GET_PORTCONFIG 0x370C
421 #define CP210X_GET_DEVICEMODE 0x3711
422 #define CP210X_WRITE_LATCH 0x37E1
424 /* Part number definitions */
425 #define CP210X_PARTNUM_CP2101 0x01
426 #define CP210X_PARTNUM_CP2102 0x02
427 #define CP210X_PARTNUM_CP2103 0x03
428 #define CP210X_PARTNUM_CP2104 0x04
429 #define CP210X_PARTNUM_CP2105 0x05
430 #define CP210X_PARTNUM_CP2108 0x08
431 #define CP210X_PARTNUM_CP2102N_QFN28 0x20
432 #define CP210X_PARTNUM_CP2102N_QFN24 0x21
433 #define CP210X_PARTNUM_CP2102N_QFN20 0x22
434 #define CP210X_PARTNUM_UNKNOWN 0xFF
436 /* CP210X_GET_COMM_STATUS returns these 0x13 bytes */
437 struct cp210x_comm_status {
439 __le32 ulHoldReasons;
440 __le32 ulAmountInInQueue;
441 __le32 ulAmountInOutQueue;
443 u8 bWaitForImmediate;
448 * CP210X_PURGE - 16 bits passed in wValue of USB request.
449 * SiLabs app note AN571 gives a strange description of the 4 bits:
450 * bit 0 or bit 2 clears the transmit queue and 1 or 3 receive.
451 * writing 1 to all, however, purges cp2108 well enough to avoid the hang.
453 #define PURGE_ALL 0x000f
455 /* CP210X_EMBED_EVENTS */
456 #define CP210X_ESCCHAR 0xec
458 #define CP210X_LSR_OVERRUN BIT(1)
459 #define CP210X_LSR_PARITY BIT(2)
460 #define CP210X_LSR_FRAME BIT(3)
461 #define CP210X_LSR_BREAK BIT(4)
464 /* CP210X_GET_FLOW/CP210X_SET_FLOW read/write these 0x10 bytes */
465 struct cp210x_flow_ctl {
466 __le32 ulControlHandshake;
467 __le32 ulFlowReplace;
472 /* cp210x_flow_ctl::ulControlHandshake */
473 #define CP210X_SERIAL_DTR_MASK GENMASK(1, 0)
474 #define CP210X_SERIAL_DTR_INACTIVE (0 << 0)
475 #define CP210X_SERIAL_DTR_ACTIVE (1 << 0)
476 #define CP210X_SERIAL_DTR_FLOW_CTL (2 << 0)
477 #define CP210X_SERIAL_CTS_HANDSHAKE BIT(3)
478 #define CP210X_SERIAL_DSR_HANDSHAKE BIT(4)
479 #define CP210X_SERIAL_DCD_HANDSHAKE BIT(5)
480 #define CP210X_SERIAL_DSR_SENSITIVITY BIT(6)
482 /* cp210x_flow_ctl::ulFlowReplace */
483 #define CP210X_SERIAL_AUTO_TRANSMIT BIT(0)
484 #define CP210X_SERIAL_AUTO_RECEIVE BIT(1)
485 #define CP210X_SERIAL_ERROR_CHAR BIT(2)
486 #define CP210X_SERIAL_NULL_STRIPPING BIT(3)
487 #define CP210X_SERIAL_BREAK_CHAR BIT(4)
488 #define CP210X_SERIAL_RTS_MASK GENMASK(7, 6)
489 #define CP210X_SERIAL_RTS_INACTIVE (0 << 6)
490 #define CP210X_SERIAL_RTS_ACTIVE (1 << 6)
491 #define CP210X_SERIAL_RTS_FLOW_CTL (2 << 6)
492 #define CP210X_SERIAL_XOFF_CONTINUE BIT(31)
494 /* CP210X_VENDOR_SPECIFIC, CP210X_GET_DEVICEMODE call reads these 0x2 bytes. */
495 struct cp210x_pin_mode {
500 #define CP210X_PIN_MODE_MODEM 0
501 #define CP210X_PIN_MODE_GPIO BIT(0)
504 * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xf bytes
505 * on a CP2105 chip. Structure needs padding due to unused/unspecified bytes.
507 struct cp210x_dual_port_config {
512 __le16 suspend_state;
519 * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xd bytes
520 * on a CP2104 chip. Structure needs padding due to unused/unspecified bytes.
522 struct cp210x_single_port_config {
527 __le16 suspend_state;
532 #define CP210X_SCI_GPIO_MODE_OFFSET 9
533 #define CP210X_SCI_GPIO_MODE_MASK GENMASK(11, 9)
535 #define CP210X_ECI_GPIO_MODE_OFFSET 2
536 #define CP210X_ECI_GPIO_MODE_MASK GENMASK(3, 2)
538 #define CP210X_GPIO_MODE_OFFSET 8
539 #define CP210X_GPIO_MODE_MASK GENMASK(11, 8)
541 /* CP2105 port configuration values */
542 #define CP2105_GPIO0_TXLED_MODE BIT(0)
543 #define CP2105_GPIO1_RXLED_MODE BIT(1)
544 #define CP2105_GPIO1_RS485_MODE BIT(2)
546 /* CP2104 port configuration values */
547 #define CP2104_GPIO0_TXLED_MODE BIT(0)
548 #define CP2104_GPIO1_RXLED_MODE BIT(1)
549 #define CP2104_GPIO2_RS485_MODE BIT(2)
551 struct cp210x_quad_port_state {
552 __le16 gpio_mode_pb0;
553 __le16 gpio_mode_pb1;
554 __le16 gpio_mode_pb2;
555 __le16 gpio_mode_pb3;
556 __le16 gpio_mode_pb4;
558 __le16 gpio_lowpower_pb0;
559 __le16 gpio_lowpower_pb1;
560 __le16 gpio_lowpower_pb2;
561 __le16 gpio_lowpower_pb3;
562 __le16 gpio_lowpower_pb4;
564 __le16 gpio_latch_pb0;
565 __le16 gpio_latch_pb1;
566 __le16 gpio_latch_pb2;
567 __le16 gpio_latch_pb3;
568 __le16 gpio_latch_pb4;
572 * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0x49 bytes
575 * See https://www.silabs.com/documents/public/application-notes/an978-cp210x-usb-to-uart-api-specification.pdf
577 struct cp210x_quad_port_config {
578 struct cp210x_quad_port_state reset_state;
579 struct cp210x_quad_port_state suspend_state;
581 u8 enhancedfxn_ifc[4];
582 u8 enhancedfxn_device;
586 #define CP2108_EF_IFC_GPIO_TXLED 0x01
587 #define CP2108_EF_IFC_GPIO_RXLED 0x02
588 #define CP2108_EF_IFC_GPIO_RS485 0x04
589 #define CP2108_EF_IFC_GPIO_RS485_LOGIC 0x08
590 #define CP2108_EF_IFC_GPIO_CLOCK 0x10
591 #define CP2108_EF_IFC_DYNAMIC_SUSPEND 0x40
593 /* CP2102N configuration array indices */
594 #define CP210X_2NCONFIG_CONFIG_VERSION_IDX 2
595 #define CP210X_2NCONFIG_GPIO_MODE_IDX 581
596 #define CP210X_2NCONFIG_GPIO_RSTLATCH_IDX 587
597 #define CP210X_2NCONFIG_GPIO_CONTROL_IDX 600
599 /* CP2102N QFN20 port configuration values */
600 #define CP2102N_QFN20_GPIO2_TXLED_MODE BIT(2)
601 #define CP2102N_QFN20_GPIO3_RXLED_MODE BIT(3)
602 #define CP2102N_QFN20_GPIO1_RS485_MODE BIT(4)
603 #define CP2102N_QFN20_GPIO0_CLK_MODE BIT(6)
606 * CP210X_VENDOR_SPECIFIC, CP210X_WRITE_LATCH call writes these 0x02 bytes
607 * for CP2102N, CP2103, CP2104 and CP2105.
609 struct cp210x_gpio_write {
615 * CP210X_VENDOR_SPECIFIC, CP210X_WRITE_LATCH call writes these 0x04 bytes
618 struct cp210x_gpio_write16 {
624 * Helper to get interface number when we only have struct usb_serial.
626 static u8 cp210x_interface_num(struct usb_serial *serial)
628 struct usb_host_interface *cur_altsetting;
630 cur_altsetting = serial->interface->cur_altsetting;
632 return cur_altsetting->desc.bInterfaceNumber;
636 * Reads a variable-sized block of CP210X_ registers, identified by req.
637 * Returns data into buf in native USB byte order.
639 static int cp210x_read_reg_block(struct usb_serial_port *port, u8 req,
640 void *buf, int bufsize)
642 struct usb_serial *serial = port->serial;
643 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
647 result = usb_control_msg_recv(serial->dev, 0, req,
648 REQTYPE_INTERFACE_TO_HOST, 0,
649 port_priv->bInterfaceNumber, buf, bufsize,
650 USB_CTRL_SET_TIMEOUT, GFP_KERNEL);
652 dev_err(&port->dev, "failed get req 0x%x size %d status: %d\n",
653 req, bufsize, result);
661 * Reads any 8-bit CP210X_ register identified by req.
663 static int cp210x_read_u8_reg(struct usb_serial_port *port, u8 req, u8 *val)
665 return cp210x_read_reg_block(port, req, val, sizeof(*val));
669 * Reads a variable-sized vendor block of CP210X_ registers, identified by val.
670 * Returns data into buf in native USB byte order.
672 static int cp210x_read_vendor_block(struct usb_serial *serial, u8 type, u16 val,
673 void *buf, int bufsize)
677 result = usb_control_msg_recv(serial->dev, 0, CP210X_VENDOR_SPECIFIC,
678 type, val, cp210x_interface_num(serial), buf, bufsize,
679 USB_CTRL_GET_TIMEOUT, GFP_KERNEL);
681 dev_err(&serial->interface->dev,
682 "failed to get vendor val 0x%04x size %d: %d\n", val,
691 * Writes any 16-bit CP210X_ register (req) whose value is passed
692 * entirely in the wValue field of the USB request.
694 static int cp210x_write_u16_reg(struct usb_serial_port *port, u8 req, u16 val)
696 struct usb_serial *serial = port->serial;
697 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
700 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
701 req, REQTYPE_HOST_TO_INTERFACE, val,
702 port_priv->bInterfaceNumber, NULL, 0,
703 USB_CTRL_SET_TIMEOUT);
705 dev_err(&port->dev, "failed set request 0x%x status: %d\n",
713 * Writes a variable-sized block of CP210X_ registers, identified by req.
714 * Data in buf must be in native USB byte order.
716 static int cp210x_write_reg_block(struct usb_serial_port *port, u8 req,
717 void *buf, int bufsize)
719 struct usb_serial *serial = port->serial;
720 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
723 result = usb_control_msg_send(serial->dev, 0, req,
724 REQTYPE_HOST_TO_INTERFACE, 0,
725 port_priv->bInterfaceNumber, buf, bufsize,
726 USB_CTRL_SET_TIMEOUT, GFP_KERNEL);
728 dev_err(&port->dev, "failed set req 0x%x size %d status: %d\n",
729 req, bufsize, result);
737 * Writes any 32-bit CP210X_ register identified by req.
739 static int cp210x_write_u32_reg(struct usb_serial_port *port, u8 req, u32 val)
743 le32_val = cpu_to_le32(val);
745 return cp210x_write_reg_block(port, req, &le32_val, sizeof(le32_val));
748 #ifdef CONFIG_GPIOLIB
750 * Writes a variable-sized vendor block of CP210X_ registers, identified by val.
751 * Data in buf must be in native USB byte order.
753 static int cp210x_write_vendor_block(struct usb_serial *serial, u8 type,
754 u16 val, void *buf, int bufsize)
758 result = usb_control_msg_send(serial->dev, 0, CP210X_VENDOR_SPECIFIC,
759 type, val, cp210x_interface_num(serial), buf, bufsize,
760 USB_CTRL_SET_TIMEOUT, GFP_KERNEL);
762 dev_err(&serial->interface->dev,
763 "failed to set vendor val 0x%04x size %d: %d\n", val,
772 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
774 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
777 result = cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_ENABLE);
779 dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
784 cp210x_set_termios(tty, port, NULL);
786 result = usb_serial_generic_open(tty, port);
793 cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
794 port_priv->event_mode = false;
799 static void cp210x_close(struct usb_serial_port *port)
801 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
803 usb_serial_generic_close(port);
805 /* Clear both queues; cp2108 needs this to avoid an occasional hang */
806 cp210x_write_u16_reg(port, CP210X_PURGE, PURGE_ALL);
808 cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
810 /* Disabling the interface disables event-insertion mode. */
811 port_priv->event_mode = false;
814 static void cp210x_process_lsr(struct usb_serial_port *port, unsigned char lsr, char *flag)
816 if (lsr & CP210X_LSR_BREAK) {
819 } else if (lsr & CP210X_LSR_PARITY) {
820 port->icount.parity++;
822 } else if (lsr & CP210X_LSR_FRAME) {
823 port->icount.frame++;
827 if (lsr & CP210X_LSR_OVERRUN) {
828 port->icount.overrun++;
829 tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
833 static bool cp210x_process_char(struct usb_serial_port *port, unsigned char *ch, char *flag)
835 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
837 switch (port_priv->event_state) {
839 if (*ch == CP210X_ESCCHAR) {
840 port_priv->event_state = ES_ESCAPE;
847 dev_dbg(&port->dev, "%s - escape char\n", __func__);
848 *ch = CP210X_ESCCHAR;
849 port_priv->event_state = ES_DATA;
852 port_priv->event_state = ES_LSR_DATA_0;
855 port_priv->event_state = ES_LSR;
858 port_priv->event_state = ES_MSR;
861 dev_err(&port->dev, "malformed event 0x%02x\n", *ch);
862 port_priv->event_state = ES_DATA;
867 port_priv->lsr = *ch;
868 port_priv->event_state = ES_LSR_DATA_1;
871 dev_dbg(&port->dev, "%s - lsr = 0x%02x, data = 0x%02x\n",
872 __func__, port_priv->lsr, *ch);
873 cp210x_process_lsr(port, port_priv->lsr, flag);
874 port_priv->event_state = ES_DATA;
877 dev_dbg(&port->dev, "%s - lsr = 0x%02x\n", __func__, *ch);
878 port_priv->lsr = *ch;
879 cp210x_process_lsr(port, port_priv->lsr, flag);
880 port_priv->event_state = ES_DATA;
883 dev_dbg(&port->dev, "%s - msr = 0x%02x\n", __func__, *ch);
885 port_priv->event_state = ES_DATA;
892 static void cp210x_process_read_urb(struct urb *urb)
894 struct usb_serial_port *port = urb->context;
895 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
896 unsigned char *ch = urb->transfer_buffer;
900 if (!urb->actual_length)
903 if (port_priv->event_mode) {
904 for (i = 0; i < urb->actual_length; i++, ch++) {
907 if (cp210x_process_char(port, ch, &flag))
910 tty_insert_flip_char(&port->port, *ch, flag);
913 tty_insert_flip_string(&port->port, ch, urb->actual_length);
915 tty_flip_buffer_push(&port->port);
919 * Read how many bytes are waiting in the TX queue.
921 static int cp210x_get_tx_queue_byte_count(struct usb_serial_port *port,
924 struct usb_serial *serial = port->serial;
925 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
926 struct cp210x_comm_status sts;
929 result = usb_control_msg_recv(serial->dev, 0, CP210X_GET_COMM_STATUS,
930 REQTYPE_INTERFACE_TO_HOST, 0,
931 port_priv->bInterfaceNumber, &sts, sizeof(sts),
932 USB_CTRL_GET_TIMEOUT, GFP_KERNEL);
934 dev_err(&port->dev, "failed to get comm status: %d\n", result);
938 *count = le32_to_cpu(sts.ulAmountInOutQueue);
943 static bool cp210x_tx_empty(struct usb_serial_port *port)
948 err = cp210x_get_tx_queue_byte_count(port, &count);
960 static const struct cp210x_rate cp210x_an205_table1[] = {
993 * Quantises the baud rate as per AN205 Table 1
995 static speed_t cp210x_get_an205_rate(speed_t baud)
999 for (i = 0; i < ARRAY_SIZE(cp210x_an205_table1); ++i) {
1000 if (baud <= cp210x_an205_table1[i].high)
1004 return cp210x_an205_table1[i].rate;
1007 static speed_t cp210x_get_actual_rate(speed_t baud)
1009 unsigned int prescale = 1;
1015 div = DIV_ROUND_CLOSEST(48000000, 2 * prescale * baud);
1016 baud = 48000000 / (2 * prescale * div);
1022 * CP2101 supports the following baud rates:
1024 * 300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
1025 * 38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
1027 * CP2102 and CP2103 support the following additional rates:
1029 * 4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
1032 * The device will map a requested rate to a supported one, but the result
1033 * of requests for rates greater than 1053257 is undefined (see AN205).
1035 * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
1036 * respectively, with an error less than 1%. The actual rates are determined
1039 * div = round(freq / (2 x prescale x request))
1040 * actual = freq / (2 x prescale x div)
1042 * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
1044 * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
1047 static void cp210x_change_speed(struct tty_struct *tty,
1048 struct usb_serial_port *port,
1049 const struct ktermios *old_termios)
1051 struct usb_serial *serial = port->serial;
1052 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1055 if (tty->termios.c_ospeed == 0)
1059 * This maps the requested rate to the actual rate, a valid rate on
1060 * cp2102 or cp2103, or to an arbitrary rate in [1M, max_speed].
1062 baud = clamp(tty->termios.c_ospeed, priv->min_speed, priv->max_speed);
1064 if (priv->use_actual_rate)
1065 baud = cp210x_get_actual_rate(baud);
1066 else if (baud < 1000000)
1067 baud = cp210x_get_an205_rate(baud);
1069 dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
1070 if (cp210x_write_u32_reg(port, CP210X_SET_BAUDRATE, baud)) {
1071 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
1073 baud = old_termios->c_ospeed;
1078 tty_encode_baud_rate(tty, baud, baud);
1081 static void cp210x_enable_event_mode(struct usb_serial_port *port)
1083 struct cp210x_serial_private *priv = usb_get_serial_data(port->serial);
1084 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1087 if (port_priv->event_mode)
1090 if (priv->no_event_mode)
1093 port_priv->event_state = ES_DATA;
1094 port_priv->event_mode = true;
1096 ret = cp210x_write_u16_reg(port, CP210X_EMBED_EVENTS, CP210X_ESCCHAR);
1098 dev_err(&port->dev, "failed to enable events: %d\n", ret);
1099 port_priv->event_mode = false;
1103 static void cp210x_disable_event_mode(struct usb_serial_port *port)
1105 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1108 if (!port_priv->event_mode)
1111 ret = cp210x_write_u16_reg(port, CP210X_EMBED_EVENTS, 0);
1113 dev_err(&port->dev, "failed to disable events: %d\n", ret);
1117 port_priv->event_mode = false;
1120 static bool cp210x_termios_change(const struct ktermios *a, const struct ktermios *b)
1122 bool iflag_change, cc_change;
1124 iflag_change = ((a->c_iflag ^ b->c_iflag) & (INPCK | IXON | IXOFF));
1125 cc_change = a->c_cc[VSTART] != b->c_cc[VSTART] ||
1126 a->c_cc[VSTOP] != b->c_cc[VSTOP];
1128 return tty_termios_hw_change(a, b) || iflag_change || cc_change;
1131 static void cp210x_set_flow_control(struct tty_struct *tty,
1132 struct usb_serial_port *port,
1133 const struct ktermios *old_termios)
1135 struct cp210x_serial_private *priv = usb_get_serial_data(port->serial);
1136 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1137 struct cp210x_special_chars chars;
1138 struct cp210x_flow_ctl flow_ctl;
1145 * Some CP2102N interpret ulXonLimit as ulFlowReplace (erratum
1146 * CP2102N_E104). Report back that flow control is not supported.
1148 if (priv->no_flow_control) {
1149 tty->termios.c_cflag &= ~CRTSCTS;
1150 tty->termios.c_iflag &= ~(IXON | IXOFF);
1153 if (tty->termios.c_ospeed != 0 &&
1154 old_termios && old_termios->c_ospeed != 0 &&
1155 C_CRTSCTS(tty) == (old_termios->c_cflag & CRTSCTS) &&
1156 I_IXON(tty) == (old_termios->c_iflag & IXON) &&
1157 I_IXOFF(tty) == (old_termios->c_iflag & IXOFF) &&
1158 START_CHAR(tty) == old_termios->c_cc[VSTART] &&
1159 STOP_CHAR(tty) == old_termios->c_cc[VSTOP]) {
1163 if (I_IXON(tty) || I_IXOFF(tty)) {
1164 memset(&chars, 0, sizeof(chars));
1166 chars.bXonChar = START_CHAR(tty);
1167 chars.bXoffChar = STOP_CHAR(tty);
1169 ret = cp210x_write_reg_block(port, CP210X_SET_CHARS, &chars,
1172 dev_err(&port->dev, "failed to set special chars: %d\n",
1177 mutex_lock(&port_priv->mutex);
1179 if (tty->termios.c_ospeed == 0) {
1180 port_priv->dtr = false;
1181 port_priv->rts = false;
1182 } else if (old_termios && old_termios->c_ospeed == 0) {
1183 port_priv->dtr = true;
1184 port_priv->rts = true;
1187 ret = cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1192 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1193 flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1195 ctl_hs &= ~CP210X_SERIAL_DSR_HANDSHAKE;
1196 ctl_hs &= ~CP210X_SERIAL_DCD_HANDSHAKE;
1197 ctl_hs &= ~CP210X_SERIAL_DSR_SENSITIVITY;
1198 ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1200 ctl_hs |= CP210X_SERIAL_DTR_ACTIVE;
1202 ctl_hs |= CP210X_SERIAL_DTR_INACTIVE;
1204 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1205 if (C_CRTSCTS(tty)) {
1206 ctl_hs |= CP210X_SERIAL_CTS_HANDSHAKE;
1208 flow_repl |= CP210X_SERIAL_RTS_FLOW_CTL;
1210 flow_repl |= CP210X_SERIAL_RTS_INACTIVE;
1213 ctl_hs &= ~CP210X_SERIAL_CTS_HANDSHAKE;
1215 flow_repl |= CP210X_SERIAL_RTS_ACTIVE;
1217 flow_repl |= CP210X_SERIAL_RTS_INACTIVE;
1222 flow_repl |= CP210X_SERIAL_AUTO_RECEIVE;
1224 flow_ctl.ulXonLimit = cpu_to_le32(128);
1225 flow_ctl.ulXoffLimit = cpu_to_le32(128);
1227 flow_repl &= ~CP210X_SERIAL_AUTO_RECEIVE;
1231 flow_repl |= CP210X_SERIAL_AUTO_TRANSMIT;
1233 flow_repl &= ~CP210X_SERIAL_AUTO_TRANSMIT;
1235 dev_dbg(&port->dev, "%s - ctrl = 0x%02x, flow = 0x%02x\n", __func__,
1238 flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1239 flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1241 ret = cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1246 port_priv->crtscts = crtscts;
1248 mutex_unlock(&port_priv->mutex);
1251 static void cp210x_set_termios(struct tty_struct *tty,
1252 struct usb_serial_port *port,
1253 const struct ktermios *old_termios)
1255 struct cp210x_serial_private *priv = usb_get_serial_data(port->serial);
1259 if (old_termios && !cp210x_termios_change(&tty->termios, old_termios) &&
1260 tty->termios.c_ospeed != 0)
1263 if (!old_termios || tty->termios.c_ospeed != old_termios->c_ospeed)
1264 cp210x_change_speed(tty, port, old_termios);
1266 /* CP2101 only supports CS8, 1 stop bit and non-stick parity. */
1267 if (priv->partnum == CP210X_PARTNUM_CP2101) {
1268 tty->termios.c_cflag &= ~(CSIZE | CSTOPB | CMSPAR);
1269 tty->termios.c_cflag |= CS8;
1274 switch (C_CSIZE(tty)) {
1276 bits |= BITS_DATA_5;
1279 bits |= BITS_DATA_6;
1282 bits |= BITS_DATA_7;
1286 bits |= BITS_DATA_8;
1290 if (C_PARENB(tty)) {
1291 if (C_CMSPAR(tty)) {
1293 bits |= BITS_PARITY_MARK;
1295 bits |= BITS_PARITY_SPACE;
1298 bits |= BITS_PARITY_ODD;
1300 bits |= BITS_PARITY_EVEN;
1305 bits |= BITS_STOP_2;
1307 bits |= BITS_STOP_1;
1309 ret = cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
1311 dev_err(&port->dev, "failed to set line control: %d\n", ret);
1313 cp210x_set_flow_control(tty, port, old_termios);
1316 * Enable event-insertion mode only if input parity checking is
1320 cp210x_enable_event_mode(port);
1322 cp210x_disable_event_mode(port);
1325 static int cp210x_tiocmset(struct tty_struct *tty,
1326 unsigned int set, unsigned int clear)
1328 struct usb_serial_port *port = tty->driver_data;
1329 return cp210x_tiocmset_port(port, set, clear);
1332 static int cp210x_tiocmset_port(struct usb_serial_port *port,
1333 unsigned int set, unsigned int clear)
1335 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1336 struct cp210x_flow_ctl flow_ctl;
1337 u32 ctl_hs, flow_repl;
1341 mutex_lock(&port_priv->mutex);
1343 if (set & TIOCM_RTS) {
1344 port_priv->rts = true;
1345 control |= CONTROL_RTS;
1346 control |= CONTROL_WRITE_RTS;
1348 if (set & TIOCM_DTR) {
1349 port_priv->dtr = true;
1350 control |= CONTROL_DTR;
1351 control |= CONTROL_WRITE_DTR;
1353 if (clear & TIOCM_RTS) {
1354 port_priv->rts = false;
1355 control &= ~CONTROL_RTS;
1356 control |= CONTROL_WRITE_RTS;
1358 if (clear & TIOCM_DTR) {
1359 port_priv->dtr = false;
1360 control &= ~CONTROL_DTR;
1361 control |= CONTROL_WRITE_DTR;
1365 * Use SET_FLOW to set DTR and enable/disable auto-RTS when hardware
1366 * flow control is enabled.
1368 if (port_priv->crtscts && control & CONTROL_WRITE_RTS) {
1369 ret = cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1374 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1375 flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1377 ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1379 ctl_hs |= CP210X_SERIAL_DTR_ACTIVE;
1381 ctl_hs |= CP210X_SERIAL_DTR_INACTIVE;
1383 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1385 flow_repl |= CP210X_SERIAL_RTS_FLOW_CTL;
1387 flow_repl |= CP210X_SERIAL_RTS_INACTIVE;
1389 flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1390 flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1392 dev_dbg(&port->dev, "%s - ctrl = 0x%02x, flow = 0x%02x\n",
1393 __func__, ctl_hs, flow_repl);
1395 ret = cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1398 dev_dbg(&port->dev, "%s - control = 0x%04x\n", __func__, control);
1400 ret = cp210x_write_u16_reg(port, CP210X_SET_MHS, control);
1403 mutex_unlock(&port_priv->mutex);
1408 static void cp210x_dtr_rts(struct usb_serial_port *port, int on)
1411 cp210x_tiocmset_port(port, TIOCM_DTR | TIOCM_RTS, 0);
1413 cp210x_tiocmset_port(port, 0, TIOCM_DTR | TIOCM_RTS);
1416 static int cp210x_tiocmget(struct tty_struct *tty)
1418 struct usb_serial_port *port = tty->driver_data;
1422 result = cp210x_read_u8_reg(port, CP210X_GET_MDMSTS, &control);
1426 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
1427 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
1428 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
1429 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
1430 |((control & CONTROL_RING)? TIOCM_RI : 0)
1431 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
1433 dev_dbg(&port->dev, "%s - control = 0x%02x\n", __func__, control);
1438 static int cp210x_break_ctl(struct tty_struct *tty, int break_state)
1440 struct usb_serial_port *port = tty->driver_data;
1441 struct cp210x_serial_private *priv = usb_get_serial_data(port->serial);
1444 if (priv->partnum == CP210X_PARTNUM_CP2105) {
1445 if (cp210x_interface_num(port->serial) == 1)
1449 if (break_state == 0)
1454 dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
1455 state == BREAK_OFF ? "off" : "on");
1457 return cp210x_write_u16_reg(port, CP210X_SET_BREAK, state);
1460 #ifdef CONFIG_GPIOLIB
1461 static int cp210x_gpio_get(struct gpio_chip *gc, unsigned int gpio)
1463 struct usb_serial *serial = gpiochip_get_data(gc);
1464 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1470 result = usb_autopm_get_interface(serial->interface);
1474 switch (priv->partnum) {
1475 case CP210X_PARTNUM_CP2105:
1476 req_type = REQTYPE_INTERFACE_TO_HOST;
1479 case CP210X_PARTNUM_CP2108:
1480 req_type = REQTYPE_INTERFACE_TO_HOST;
1484 req_type = REQTYPE_DEVICE_TO_HOST;
1490 result = cp210x_read_vendor_block(serial, req_type, CP210X_READ_LATCH,
1493 usb_autopm_put_interface(serial->interface);
1498 le16_to_cpus(&mask);
1500 return !!(mask & BIT(gpio));
1503 static void cp210x_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)
1505 struct usb_serial *serial = gpiochip_get_data(gc);
1506 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1507 struct cp210x_gpio_write16 buf16;
1508 struct cp210x_gpio_write buf;
1520 result = usb_autopm_get_interface(serial->interface);
1524 switch (priv->partnum) {
1525 case CP210X_PARTNUM_CP2105:
1526 buf.mask = (u8)mask;
1527 buf.state = (u8)state;
1528 result = cp210x_write_vendor_block(serial,
1529 REQTYPE_HOST_TO_INTERFACE,
1530 CP210X_WRITE_LATCH, &buf,
1533 case CP210X_PARTNUM_CP2108:
1534 buf16.mask = cpu_to_le16(mask);
1535 buf16.state = cpu_to_le16(state);
1536 result = cp210x_write_vendor_block(serial,
1537 REQTYPE_HOST_TO_INTERFACE,
1538 CP210X_WRITE_LATCH, &buf16,
1542 wIndex = state << 8 | mask;
1543 result = usb_control_msg(serial->dev,
1544 usb_sndctrlpipe(serial->dev, 0),
1545 CP210X_VENDOR_SPECIFIC,
1546 REQTYPE_HOST_TO_DEVICE,
1549 NULL, 0, USB_CTRL_SET_TIMEOUT);
1553 usb_autopm_put_interface(serial->interface);
1556 dev_err(&serial->interface->dev, "failed to set GPIO value: %d\n",
1561 static int cp210x_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
1563 struct usb_serial *serial = gpiochip_get_data(gc);
1564 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1566 return priv->gpio_input & BIT(gpio);
1569 static int cp210x_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
1571 struct usb_serial *serial = gpiochip_get_data(gc);
1572 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1574 if (priv->partnum == CP210X_PARTNUM_CP2105) {
1575 /* hardware does not support an input mode */
1579 /* push-pull pins cannot be changed to be inputs */
1580 if (priv->gpio_pushpull & BIT(gpio))
1583 /* make sure to release pin if it is being driven low */
1584 cp210x_gpio_set(gc, gpio, 1);
1586 priv->gpio_input |= BIT(gpio);
1591 static int cp210x_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
1594 struct usb_serial *serial = gpiochip_get_data(gc);
1595 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1597 priv->gpio_input &= ~BIT(gpio);
1598 cp210x_gpio_set(gc, gpio, value);
1603 static int cp210x_gpio_set_config(struct gpio_chip *gc, unsigned int gpio,
1604 unsigned long config)
1606 struct usb_serial *serial = gpiochip_get_data(gc);
1607 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1608 enum pin_config_param param = pinconf_to_config_param(config);
1610 /* Succeed only if in correct mode (this can't be set at runtime) */
1611 if ((param == PIN_CONFIG_DRIVE_PUSH_PULL) &&
1612 (priv->gpio_pushpull & BIT(gpio)))
1615 if ((param == PIN_CONFIG_DRIVE_OPEN_DRAIN) &&
1616 !(priv->gpio_pushpull & BIT(gpio)))
1622 static int cp210x_gpio_init_valid_mask(struct gpio_chip *gc,
1623 unsigned long *valid_mask, unsigned int ngpios)
1625 struct usb_serial *serial = gpiochip_get_data(gc);
1626 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1627 struct device *dev = &serial->interface->dev;
1628 unsigned long altfunc_mask = priv->gpio_altfunc;
1630 bitmap_complement(valid_mask, &altfunc_mask, ngpios);
1632 if (bitmap_empty(valid_mask, ngpios))
1633 dev_dbg(dev, "no pin configured for GPIO\n");
1635 dev_dbg(dev, "GPIO.%*pbl configured for GPIO\n", ngpios,
1641 * This function is for configuring GPIO using shared pins, where other signals
1642 * are made unavailable by configuring the use of GPIO. This is believed to be
1643 * only applicable to the cp2105 at this point, the other devices supported by
1644 * this driver that provide GPIO do so in a way that does not impact other
1645 * signals and are thus expected to have very different initialisation.
1647 static int cp2105_gpioconf_init(struct usb_serial *serial)
1649 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1650 struct cp210x_pin_mode mode;
1651 struct cp210x_dual_port_config config;
1652 u8 intf_num = cp210x_interface_num(serial);
1656 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1657 CP210X_GET_DEVICEMODE, &mode,
1662 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1663 CP210X_GET_PORTCONFIG, &config,
1668 /* 2 banks of GPIO - One for the pins taken from each serial port */
1669 if (intf_num == 0) {
1672 if (mode.eci == CP210X_PIN_MODE_MODEM) {
1673 /* mark all GPIOs of this interface as reserved */
1674 priv->gpio_altfunc = 0xff;
1678 iface_config = config.eci_cfg;
1679 priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1680 CP210X_ECI_GPIO_MODE_MASK) >>
1681 CP210X_ECI_GPIO_MODE_OFFSET);
1682 } else if (intf_num == 1) {
1685 if (mode.sci == CP210X_PIN_MODE_MODEM) {
1686 /* mark all GPIOs of this interface as reserved */
1687 priv->gpio_altfunc = 0xff;
1691 iface_config = config.sci_cfg;
1692 priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1693 CP210X_SCI_GPIO_MODE_MASK) >>
1694 CP210X_SCI_GPIO_MODE_OFFSET);
1699 /* mark all pins which are not in GPIO mode */
1700 if (iface_config & CP2105_GPIO0_TXLED_MODE) /* GPIO 0 */
1701 priv->gpio_altfunc |= BIT(0);
1702 if (iface_config & (CP2105_GPIO1_RXLED_MODE | /* GPIO 1 */
1703 CP2105_GPIO1_RS485_MODE))
1704 priv->gpio_altfunc |= BIT(1);
1706 /* driver implementation for CP2105 only supports outputs */
1707 priv->gpio_input = 0;
1712 static int cp2104_gpioconf_init(struct usb_serial *serial)
1714 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1715 struct cp210x_single_port_config config;
1721 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1722 CP210X_GET_PORTCONFIG, &config,
1729 iface_config = config.device_cfg;
1730 priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1731 CP210X_GPIO_MODE_MASK) >>
1732 CP210X_GPIO_MODE_OFFSET);
1733 gpio_latch = (u8)((le16_to_cpu(config.reset_state) &
1734 CP210X_GPIO_MODE_MASK) >>
1735 CP210X_GPIO_MODE_OFFSET);
1737 /* mark all pins which are not in GPIO mode */
1738 if (iface_config & CP2104_GPIO0_TXLED_MODE) /* GPIO 0 */
1739 priv->gpio_altfunc |= BIT(0);
1740 if (iface_config & CP2104_GPIO1_RXLED_MODE) /* GPIO 1 */
1741 priv->gpio_altfunc |= BIT(1);
1742 if (iface_config & CP2104_GPIO2_RS485_MODE) /* GPIO 2 */
1743 priv->gpio_altfunc |= BIT(2);
1746 * Like CP2102N, CP2104 has also no strict input and output pin
1748 * Do the same input mode emulation as CP2102N.
1750 for (i = 0; i < priv->gc.ngpio; ++i) {
1752 * Set direction to "input" iff pin is open-drain and reset
1755 if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1756 priv->gpio_input |= BIT(i);
1762 static int cp2108_gpio_init(struct usb_serial *serial)
1764 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1765 struct cp210x_quad_port_config config;
1770 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1771 CP210X_GET_PORTCONFIG, &config,
1776 priv->gc.ngpio = 16;
1777 priv->gpio_pushpull = le16_to_cpu(config.reset_state.gpio_mode_pb1);
1778 gpio_latch = le16_to_cpu(config.reset_state.gpio_latch_pb1);
1781 * Mark all pins which are not in GPIO mode.
1783 * Refer to table 9.1 "GPIO Mode alternate Functions" in the datasheet:
1784 * https://www.silabs.com/documents/public/data-sheets/cp2108-datasheet.pdf
1786 * Alternate functions of GPIO0 to GPIO3 are determine by enhancedfxn_ifc[0]
1787 * and the similarly for the other pins; enhancedfxn_ifc[1]: GPIO4 to GPIO7,
1788 * enhancedfxn_ifc[2]: GPIO8 to GPIO11, enhancedfxn_ifc[3]: GPIO12 to GPIO15.
1790 for (i = 0; i < 4; i++) {
1791 if (config.enhancedfxn_ifc[i] & CP2108_EF_IFC_GPIO_TXLED)
1792 priv->gpio_altfunc |= BIT(i * 4);
1793 if (config.enhancedfxn_ifc[i] & CP2108_EF_IFC_GPIO_RXLED)
1794 priv->gpio_altfunc |= BIT((i * 4) + 1);
1795 if (config.enhancedfxn_ifc[i] & CP2108_EF_IFC_GPIO_RS485)
1796 priv->gpio_altfunc |= BIT((i * 4) + 2);
1797 if (config.enhancedfxn_ifc[i] & CP2108_EF_IFC_GPIO_CLOCK)
1798 priv->gpio_altfunc |= BIT((i * 4) + 3);
1802 * Like CP2102N, CP2108 has also no strict input and output pin
1803 * modes. Do the same input mode emulation as CP2102N.
1805 for (i = 0; i < priv->gc.ngpio; ++i) {
1807 * Set direction to "input" iff pin is open-drain and reset
1810 if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1811 priv->gpio_input |= BIT(i);
1817 static int cp2102n_gpioconf_init(struct usb_serial *serial)
1819 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1820 const u16 config_size = 0x02a6;
1831 * Retrieve device configuration from the device.
1832 * The array received contains all customization settings done at the
1833 * factory/manufacturer. Format of the array is documented at the
1834 * time of writing at:
1835 * https://www.silabs.com/community/interface/knowledge-base.entry.html/2017/03/31/cp2102n_setconfig-xsfa
1837 config_buf = kmalloc(config_size, GFP_KERNEL);
1841 result = cp210x_read_vendor_block(serial,
1842 REQTYPE_DEVICE_TO_HOST,
1843 CP210X_READ_2NCONFIG,
1851 config_version = config_buf[CP210X_2NCONFIG_CONFIG_VERSION_IDX];
1852 gpio_pushpull = config_buf[CP210X_2NCONFIG_GPIO_MODE_IDX];
1853 gpio_ctrl = config_buf[CP210X_2NCONFIG_GPIO_CONTROL_IDX];
1854 gpio_rst_latch = config_buf[CP210X_2NCONFIG_GPIO_RSTLATCH_IDX];
1858 /* Make sure this is a config format we understand. */
1859 if (config_version != 0x01)
1865 * Get default pin states after reset. Needed so we can determine
1866 * the direction of an open-drain pin.
1868 gpio_latch = (gpio_rst_latch >> 3) & 0x0f;
1870 /* 0 indicates open-drain mode, 1 is push-pull */
1871 priv->gpio_pushpull = (gpio_pushpull >> 3) & 0x0f;
1873 /* 0 indicates GPIO mode, 1 is alternate function */
1874 if (priv->partnum == CP210X_PARTNUM_CP2102N_QFN20) {
1875 /* QFN20 is special... */
1876 if (gpio_ctrl & CP2102N_QFN20_GPIO0_CLK_MODE) /* GPIO 0 */
1877 priv->gpio_altfunc |= BIT(0);
1878 if (gpio_ctrl & CP2102N_QFN20_GPIO1_RS485_MODE) /* GPIO 1 */
1879 priv->gpio_altfunc |= BIT(1);
1880 if (gpio_ctrl & CP2102N_QFN20_GPIO2_TXLED_MODE) /* GPIO 2 */
1881 priv->gpio_altfunc |= BIT(2);
1882 if (gpio_ctrl & CP2102N_QFN20_GPIO3_RXLED_MODE) /* GPIO 3 */
1883 priv->gpio_altfunc |= BIT(3);
1885 priv->gpio_altfunc = (gpio_ctrl >> 2) & 0x0f;
1888 if (priv->partnum == CP210X_PARTNUM_CP2102N_QFN28) {
1890 * For the QFN28 package, GPIO4-6 are controlled by
1891 * the low three bits of the mode/latch fields.
1892 * Contrary to the document linked above, the bits for
1893 * the SUSPEND pins are elsewhere. No alternate
1894 * function is available for these pins.
1897 gpio_latch |= (gpio_rst_latch & 7) << 4;
1898 priv->gpio_pushpull |= (gpio_pushpull & 7) << 4;
1902 * The CP2102N does not strictly has input and output pin modes,
1903 * it only knows open-drain and push-pull modes which is set at
1904 * factory. An open-drain pin can function both as an
1905 * input or an output. We emulate input mode for open-drain pins
1906 * by making sure they are not driven low, and we do not allow
1907 * push-pull pins to be set as an input.
1909 for (i = 0; i < priv->gc.ngpio; ++i) {
1911 * Set direction to "input" iff pin is open-drain and reset
1914 if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1915 priv->gpio_input |= BIT(i);
1921 static int cp210x_gpio_init(struct usb_serial *serial)
1923 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1926 switch (priv->partnum) {
1927 case CP210X_PARTNUM_CP2104:
1928 result = cp2104_gpioconf_init(serial);
1930 case CP210X_PARTNUM_CP2105:
1931 result = cp2105_gpioconf_init(serial);
1933 case CP210X_PARTNUM_CP2108:
1935 * The GPIOs are not tied to any specific port so only register
1936 * once for interface 0.
1938 if (cp210x_interface_num(serial) != 0)
1940 result = cp2108_gpio_init(serial);
1942 case CP210X_PARTNUM_CP2102N_QFN28:
1943 case CP210X_PARTNUM_CP2102N_QFN24:
1944 case CP210X_PARTNUM_CP2102N_QFN20:
1945 result = cp2102n_gpioconf_init(serial);
1954 priv->gc.label = "cp210x";
1955 priv->gc.get_direction = cp210x_gpio_direction_get;
1956 priv->gc.direction_input = cp210x_gpio_direction_input;
1957 priv->gc.direction_output = cp210x_gpio_direction_output;
1958 priv->gc.get = cp210x_gpio_get;
1959 priv->gc.set = cp210x_gpio_set;
1960 priv->gc.set_config = cp210x_gpio_set_config;
1961 priv->gc.init_valid_mask = cp210x_gpio_init_valid_mask;
1962 priv->gc.owner = THIS_MODULE;
1963 priv->gc.parent = &serial->interface->dev;
1965 priv->gc.can_sleep = true;
1967 result = gpiochip_add_data(&priv->gc, serial);
1969 priv->gpio_registered = true;
1974 static void cp210x_gpio_remove(struct usb_serial *serial)
1976 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1978 if (priv->gpio_registered) {
1979 gpiochip_remove(&priv->gc);
1980 priv->gpio_registered = false;
1986 static int cp210x_gpio_init(struct usb_serial *serial)
1991 static void cp210x_gpio_remove(struct usb_serial *serial)
1998 static int cp210x_port_probe(struct usb_serial_port *port)
2000 struct usb_serial *serial = port->serial;
2001 struct cp210x_port_private *port_priv;
2003 port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
2007 port_priv->bInterfaceNumber = cp210x_interface_num(serial);
2008 mutex_init(&port_priv->mutex);
2010 usb_set_serial_port_data(port, port_priv);
2015 static void cp210x_port_remove(struct usb_serial_port *port)
2017 struct cp210x_port_private *port_priv;
2019 port_priv = usb_get_serial_port_data(port);
2023 static void cp210x_init_max_speed(struct usb_serial *serial)
2025 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2026 bool use_actual_rate = false;
2030 switch (priv->partnum) {
2031 case CP210X_PARTNUM_CP2101:
2034 case CP210X_PARTNUM_CP2102:
2035 case CP210X_PARTNUM_CP2103:
2038 case CP210X_PARTNUM_CP2104:
2039 use_actual_rate = true;
2042 case CP210X_PARTNUM_CP2108:
2045 case CP210X_PARTNUM_CP2105:
2046 if (cp210x_interface_num(serial) == 0) {
2047 use_actual_rate = true;
2048 max = 2000000; /* ECI */
2051 max = 921600; /* SCI */
2054 case CP210X_PARTNUM_CP2102N_QFN28:
2055 case CP210X_PARTNUM_CP2102N_QFN24:
2056 case CP210X_PARTNUM_CP2102N_QFN20:
2057 use_actual_rate = true;
2065 priv->min_speed = min;
2066 priv->max_speed = max;
2067 priv->use_actual_rate = use_actual_rate;
2070 static void cp2102_determine_quirks(struct usb_serial *serial)
2072 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2076 buf = kmalloc(2, GFP_KERNEL);
2080 * Some (possibly counterfeit) CP2102 do not support event-insertion
2081 * mode and respond differently to malformed vendor requests.
2082 * Specifically, they return one instead of two bytes when sent a
2083 * two-byte part-number request.
2085 ret = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
2086 CP210X_VENDOR_SPECIFIC, REQTYPE_DEVICE_TO_HOST,
2087 CP210X_GET_PARTNUM, 0, buf, 2, USB_CTRL_GET_TIMEOUT);
2089 dev_dbg(&serial->interface->dev,
2090 "device does not support event-insertion mode\n");
2091 priv->no_event_mode = true;
2097 static int cp210x_get_fw_version(struct usb_serial *serial, u16 value)
2099 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2103 ret = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST, value,
2108 dev_dbg(&serial->interface->dev, "%s - %d.%d.%d\n", __func__,
2109 ver[0], ver[1], ver[2]);
2111 priv->fw_version = ver[0] << 16 | ver[1] << 8 | ver[2];
2116 static void cp210x_determine_type(struct usb_serial *serial)
2118 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2121 ret = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
2122 CP210X_GET_PARTNUM, &priv->partnum,
2123 sizeof(priv->partnum));
2125 dev_warn(&serial->interface->dev,
2126 "querying part number failed\n");
2127 priv->partnum = CP210X_PARTNUM_UNKNOWN;
2131 dev_dbg(&serial->interface->dev, "partnum = 0x%02x\n", priv->partnum);
2133 switch (priv->partnum) {
2134 case CP210X_PARTNUM_CP2102:
2135 cp2102_determine_quirks(serial);
2137 case CP210X_PARTNUM_CP2105:
2138 case CP210X_PARTNUM_CP2108:
2139 cp210x_get_fw_version(serial, CP210X_GET_FW_VER);
2141 case CP210X_PARTNUM_CP2102N_QFN28:
2142 case CP210X_PARTNUM_CP2102N_QFN24:
2143 case CP210X_PARTNUM_CP2102N_QFN20:
2144 ret = cp210x_get_fw_version(serial, CP210X_GET_FW_VER_2N);
2147 if (priv->fw_version <= 0x10004)
2148 priv->no_flow_control = true;
2155 static int cp210x_attach(struct usb_serial *serial)
2158 struct cp210x_serial_private *priv;
2160 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
2164 usb_set_serial_data(serial, priv);
2166 cp210x_determine_type(serial);
2167 cp210x_init_max_speed(serial);
2169 result = cp210x_gpio_init(serial);
2171 dev_err(&serial->interface->dev, "GPIO initialisation failed: %d\n",
2178 static void cp210x_disconnect(struct usb_serial *serial)
2180 cp210x_gpio_remove(serial);
2183 static void cp210x_release(struct usb_serial *serial)
2185 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2187 cp210x_gpio_remove(serial);
2192 module_usb_serial_driver(serial_drivers, id_table);
2194 MODULE_DESCRIPTION(DRIVER_DESC);
2195 MODULE_LICENSE("GPL v2");