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)
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
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>
27 #define DRIVER_DESC "Silicon Labs CP210x RS232 serial adaptor driver"
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 *,
39 static void cp210x_set_termios(struct tty_struct *, struct usb_serial_port *,
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);
57 static const struct usb_device_id id_table[] = {
58 { USB_DEVICE(0x0404, 0x034C) }, /* NCR Retail IO Box */
59 { USB_DEVICE(0x045B, 0x0053) }, /* Renesas RX610 RX-Stick */
60 { USB_DEVICE(0x0471, 0x066A) }, /* AKTAKOM ACE-1001 cable */
61 { USB_DEVICE(0x0489, 0xE000) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
62 { USB_DEVICE(0x0489, 0xE003) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
63 { USB_DEVICE(0x0745, 0x1000) }, /* CipherLab USB CCD Barcode Scanner 1000 */
64 { USB_DEVICE(0x0846, 0x1100) }, /* NetGear Managed Switch M4100 series, M5300 series, M7100 series */
65 { USB_DEVICE(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
66 { USB_DEVICE(0x08FD, 0x000A) }, /* Digianswer A/S , ZigBee/802.15.4 MAC Device */
67 { USB_DEVICE(0x0908, 0x01FF) }, /* Siemens RUGGEDCOM USB Serial Console */
68 { USB_DEVICE(0x0988, 0x0578) }, /* Teraoka AD2000 */
69 { USB_DEVICE(0x0B00, 0x3070) }, /* Ingenico 3070 */
70 { USB_DEVICE(0x0BED, 0x1100) }, /* MEI (TM) Cashflow-SC Bill/Voucher Acceptor */
71 { USB_DEVICE(0x0BED, 0x1101) }, /* MEI series 2000 Combo Acceptor */
72 { USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
73 { USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
74 { USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */
75 { USB_DEVICE(0x0FDE, 0xCA05) }, /* OWL Wireless Electricity Monitor CM-160 */
76 { USB_DEVICE(0x106F, 0x0003) }, /* CPI / Money Controls Bulk Coin Recycler */
77 { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
78 { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
79 { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
80 { USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */
81 { USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */
82 { USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */
83 { USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
84 { USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
85 { USB_DEVICE(0x10C4, 0x8044) }, /* Cygnal Debug Adapter */
86 { USB_DEVICE(0x10C4, 0x804E) }, /* Software Bisque Paramount ME build-in converter */
87 { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
88 { USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */
89 { USB_DEVICE(0x10C4, 0x8056) }, /* Lorenz Messtechnik devices */
90 { USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
91 { USB_DEVICE(0x10C4, 0x806F) }, /* IMS USB to RS422 Converter Cable */
92 { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
93 { USB_DEVICE(0x10C4, 0x80C4) }, /* Cygnal Integrated Products, Inc., Optris infrared thermometer */
94 { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
95 { USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
96 { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
97 { USB_DEVICE(0x10C4, 0x8115) }, /* Arygon NFC/Mifare Reader */
98 { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
99 { USB_DEVICE(0x10C4, 0x813F) }, /* Tams Master Easy Control */
100 { USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
101 { USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
102 { USB_DEVICE(0x2405, 0x0003) }, /* West Mountain Radio RIGblaster Advantage */
103 { USB_DEVICE(0x10C4, 0x8156) }, /* B&G H3000 link cable */
104 { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
105 { USB_DEVICE(0x10C4, 0x815F) }, /* Timewave HamLinkUSB */
106 { USB_DEVICE(0x10C4, 0x817C) }, /* CESINEL MEDCAL N Power Quality Monitor */
107 { USB_DEVICE(0x10C4, 0x817D) }, /* CESINEL MEDCAL NT Power Quality Monitor */
108 { USB_DEVICE(0x10C4, 0x817E) }, /* CESINEL MEDCAL S Power Quality Monitor */
109 { USB_DEVICE(0x10C4, 0x818B) }, /* AVIT Research USB to TTL */
110 { USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
111 { USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
112 { USB_DEVICE(0x10C4, 0x81A9) }, /* Multiplex RC Interface */
113 { USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
114 { USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */
115 { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
116 { USB_DEVICE(0x10C4, 0x81D7) }, /* IAI Corp. RCB-CV-USB USB to RS485 Adaptor */
117 { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
118 { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
119 { USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
120 { USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
121 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
122 { USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
123 { USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
124 { USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */
125 { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
126 { USB_DEVICE(0x10C4, 0x82EF) }, /* CESINEL FALCO 6105 AC Power Supply */
127 { USB_DEVICE(0x10C4, 0x82F1) }, /* CESINEL MEDCAL EFD Earth Fault Detector */
128 { USB_DEVICE(0x10C4, 0x82F2) }, /* CESINEL MEDCAL ST Network Analyzer */
129 { USB_DEVICE(0x10C4, 0x82F4) }, /* Starizona MicroTouch */
130 { USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
131 { USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
132 { USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
133 { USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
134 { USB_DEVICE(0x10C4, 0x83AA) }, /* Mark-10 Digital Force Gauge */
135 { USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
136 { USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
137 { USB_DEVICE(0x10C4, 0x8414) }, /* Decagon USB Cable Adapter */
138 { USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
139 { USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
140 { USB_DEVICE(0x10C4, 0x8470) }, /* Juniper Networks BX Series System Console */
141 { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
142 { USB_DEVICE(0x10C4, 0x84B6) }, /* Starizona Hyperion */
143 { USB_DEVICE(0x10C4, 0x851E) }, /* CESINEL MEDCAL PT Network Analyzer */
144 { USB_DEVICE(0x10C4, 0x85A7) }, /* LifeScan OneTouch Verio IQ */
145 { USB_DEVICE(0x10C4, 0x85B8) }, /* CESINEL ReCon T Energy Logger */
146 { USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
147 { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
148 { USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
149 { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
150 { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
151 { USB_DEVICE(0x10C4, 0x8856) }, /* CEL EM357 ZigBee USB Stick - LR */
152 { USB_DEVICE(0x10C4, 0x8857) }, /* CEL EM357 ZigBee USB Stick */
153 { USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
154 { USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
155 { USB_DEVICE(0x10C4, 0x88D8) }, /* Acuity Brands nLight Air Adapter */
156 { USB_DEVICE(0x10C4, 0x88FB) }, /* CESINEL MEDCAL STII Network Analyzer */
157 { USB_DEVICE(0x10C4, 0x8938) }, /* CESINEL MEDCAL S II Network Analyzer */
158 { USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
159 { USB_DEVICE(0x10C4, 0x8962) }, /* Brim Brothers charging dock */
160 { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit Device */
161 { USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
162 { USB_DEVICE(0x10C4, 0x89A4) }, /* CESINEL FTBC Flexible Thyristor Bridge Controller */
163 { USB_DEVICE(0x10C4, 0x89FB) }, /* Qivicon ZigBee USB Radio Stick */
164 { USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
165 { USB_DEVICE(0x10C4, 0x8A5B) }, /* CEL EM3588 ZigBee USB Stick */
166 { USB_DEVICE(0x10C4, 0x8A5E) }, /* CEL EM3588 ZigBee USB Stick Long Range */
167 { USB_DEVICE(0x10C4, 0x8B34) }, /* Qivicon ZigBee USB Radio Stick */
168 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
169 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
170 { USB_DEVICE(0x10C4, 0xEA63) }, /* Silicon Labs Windows Update (CP2101-4/CP2102N) */
171 { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
172 { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
173 { USB_DEVICE(0x10C4, 0xEA7A) }, /* Silicon Labs Windows Update (CP2105) */
174 { USB_DEVICE(0x10C4, 0xEA7B) }, /* Silicon Labs Windows Update (CP2108) */
175 { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
176 { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
177 { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
178 { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
179 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
180 { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
181 { USB_DEVICE(0x12B8, 0xEC60) }, /* Link G4 ECU */
182 { USB_DEVICE(0x12B8, 0xEC62) }, /* Link G4+ ECU */
183 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
184 { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
185 { USB_DEVICE(0x155A, 0x1006) }, /* ELDAT Easywave RX09 */
186 { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
187 { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
188 { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
189 { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
190 { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
191 { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
192 { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
193 { USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
194 { USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
195 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
196 { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
197 { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
198 { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
199 { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
200 { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
201 { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
202 { USB_DEVICE(0x17A8, 0x0101) }, /* Kamstrup 868 MHz wM-Bus C-Mode Meter Reader (Int Ant) */
203 { USB_DEVICE(0x17A8, 0x0102) }, /* Kamstrup 868 MHz wM-Bus C-Mode Meter Reader (Ext Ant) */
204 { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
205 { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
206 { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
207 { USB_DEVICE(0x18EF, 0xE025) }, /* ELV Marble Sound Board 1 */
208 { USB_DEVICE(0x18EF, 0xE030) }, /* ELV ALC 8xxx Battery Charger */
209 { USB_DEVICE(0x18EF, 0xE032) }, /* ELV TFD500 Data Logger */
210 { USB_DEVICE(0x1901, 0x0190) }, /* GE B850 CP2105 Recorder interface */
211 { USB_DEVICE(0x1901, 0x0193) }, /* GE B650 CP2104 PMC interface */
212 { USB_DEVICE(0x1901, 0x0194) }, /* GE Healthcare Remote Alarm Box */
213 { USB_DEVICE(0x1901, 0x0195) }, /* GE B850/B650/B450 CP2104 DP UART interface */
214 { USB_DEVICE(0x1901, 0x0196) }, /* GE B850 CP2105 DP UART interface */
215 { USB_DEVICE(0x1901, 0x0197) }, /* GE CS1000 M.2 Key E serial interface */
216 { USB_DEVICE(0x1901, 0x0198) }, /* GE CS1000 Display serial interface */
217 { USB_DEVICE(0x199B, 0xBA30) }, /* LORD WSDA-200-USB */
218 { USB_DEVICE(0x19CF, 0x3000) }, /* Parrot NMEA GPS Flight Recorder */
219 { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
220 { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
221 { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
222 { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
223 { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
224 { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
225 { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
226 { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
227 { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
228 { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
229 { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
230 { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
231 { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
232 { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
233 { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
234 { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
235 { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
236 { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
237 { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
238 { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
239 { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
240 { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
241 { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
242 { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
243 { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
244 { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
245 { USB_DEVICE(0x2184, 0x0030) }, /* GW Instek GDM-834x Digital Multimeter */
246 { USB_DEVICE(0x2626, 0xEA60) }, /* Aruba Networks 7xxx USB Serial Console */
247 { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
248 { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
249 { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
250 { USB_DEVICE(0x3923, 0x7A0B) }, /* National Instruments USB Serial Console */
251 { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
252 { } /* Terminating Entry */
255 MODULE_DEVICE_TABLE(usb, id_table);
257 struct cp210x_serial_private {
258 #ifdef CONFIG_GPIOLIB
260 bool gpio_registered;
268 bool use_actual_rate;
272 enum cp210x_event_state {
281 struct cp210x_port_private {
283 bool has_swapped_line_ctl;
285 enum cp210x_event_state event_state;
289 static struct usb_serial_driver cp210x_device = {
291 .owner = THIS_MODULE,
294 .id_table = id_table,
297 .bulk_out_size = 256,
299 .close = cp210x_close,
300 .break_ctl = cp210x_break_ctl,
301 .set_termios = cp210x_set_termios,
302 .tx_empty = cp210x_tx_empty,
303 .throttle = usb_serial_generic_throttle,
304 .unthrottle = usb_serial_generic_unthrottle,
305 .tiocmget = cp210x_tiocmget,
306 .tiocmset = cp210x_tiocmset,
307 .get_icount = usb_serial_generic_get_icount,
308 .attach = cp210x_attach,
309 .disconnect = cp210x_disconnect,
310 .release = cp210x_release,
311 .port_probe = cp210x_port_probe,
312 .port_remove = cp210x_port_remove,
313 .dtr_rts = cp210x_dtr_rts,
314 .process_read_urb = cp210x_process_read_urb,
317 static struct usb_serial_driver * const serial_drivers[] = {
321 /* Config request types */
322 #define REQTYPE_HOST_TO_INTERFACE 0x41
323 #define REQTYPE_INTERFACE_TO_HOST 0xc1
324 #define REQTYPE_HOST_TO_DEVICE 0x40
325 #define REQTYPE_DEVICE_TO_HOST 0xc0
327 /* Config request codes */
328 #define CP210X_IFC_ENABLE 0x00
329 #define CP210X_SET_BAUDDIV 0x01
330 #define CP210X_GET_BAUDDIV 0x02
331 #define CP210X_SET_LINE_CTL 0x03
332 #define CP210X_GET_LINE_CTL 0x04
333 #define CP210X_SET_BREAK 0x05
334 #define CP210X_IMM_CHAR 0x06
335 #define CP210X_SET_MHS 0x07
336 #define CP210X_GET_MDMSTS 0x08
337 #define CP210X_SET_XON 0x09
338 #define CP210X_SET_XOFF 0x0A
339 #define CP210X_SET_EVENTMASK 0x0B
340 #define CP210X_GET_EVENTMASK 0x0C
341 #define CP210X_SET_CHAR 0x0D
342 #define CP210X_GET_CHARS 0x0E
343 #define CP210X_GET_PROPS 0x0F
344 #define CP210X_GET_COMM_STATUS 0x10
345 #define CP210X_RESET 0x11
346 #define CP210X_PURGE 0x12
347 #define CP210X_SET_FLOW 0x13
348 #define CP210X_GET_FLOW 0x14
349 #define CP210X_EMBED_EVENTS 0x15
350 #define CP210X_GET_EVENTSTATE 0x16
351 #define CP210X_SET_CHARS 0x19
352 #define CP210X_GET_BAUDRATE 0x1D
353 #define CP210X_SET_BAUDRATE 0x1E
354 #define CP210X_VENDOR_SPECIFIC 0xFF
356 /* CP210X_IFC_ENABLE */
357 #define UART_ENABLE 0x0001
358 #define UART_DISABLE 0x0000
360 /* CP210X_(SET|GET)_BAUDDIV */
361 #define BAUD_RATE_GEN_FREQ 0x384000
363 /* CP210X_(SET|GET)_LINE_CTL */
364 #define BITS_DATA_MASK 0X0f00
365 #define BITS_DATA_5 0X0500
366 #define BITS_DATA_6 0X0600
367 #define BITS_DATA_7 0X0700
368 #define BITS_DATA_8 0X0800
369 #define BITS_DATA_9 0X0900
371 #define BITS_PARITY_MASK 0x00f0
372 #define BITS_PARITY_NONE 0x0000
373 #define BITS_PARITY_ODD 0x0010
374 #define BITS_PARITY_EVEN 0x0020
375 #define BITS_PARITY_MARK 0x0030
376 #define BITS_PARITY_SPACE 0x0040
378 #define BITS_STOP_MASK 0x000f
379 #define BITS_STOP_1 0x0000
380 #define BITS_STOP_1_5 0x0001
381 #define BITS_STOP_2 0x0002
383 /* CP210X_SET_BREAK */
384 #define BREAK_ON 0x0001
385 #define BREAK_OFF 0x0000
387 /* CP210X_(SET_MHS|GET_MDMSTS) */
388 #define CONTROL_DTR 0x0001
389 #define CONTROL_RTS 0x0002
390 #define CONTROL_CTS 0x0010
391 #define CONTROL_DSR 0x0020
392 #define CONTROL_RING 0x0040
393 #define CONTROL_DCD 0x0080
394 #define CONTROL_WRITE_DTR 0x0100
395 #define CONTROL_WRITE_RTS 0x0200
397 /* CP210X_VENDOR_SPECIFIC values */
398 #define CP210X_READ_2NCONFIG 0x000E
399 #define CP210X_READ_LATCH 0x00C2
400 #define CP210X_GET_PARTNUM 0x370B
401 #define CP210X_GET_PORTCONFIG 0x370C
402 #define CP210X_GET_DEVICEMODE 0x3711
403 #define CP210X_WRITE_LATCH 0x37E1
405 /* Part number definitions */
406 #define CP210X_PARTNUM_CP2101 0x01
407 #define CP210X_PARTNUM_CP2102 0x02
408 #define CP210X_PARTNUM_CP2103 0x03
409 #define CP210X_PARTNUM_CP2104 0x04
410 #define CP210X_PARTNUM_CP2105 0x05
411 #define CP210X_PARTNUM_CP2108 0x08
412 #define CP210X_PARTNUM_CP2102N_QFN28 0x20
413 #define CP210X_PARTNUM_CP2102N_QFN24 0x21
414 #define CP210X_PARTNUM_CP2102N_QFN20 0x22
415 #define CP210X_PARTNUM_UNKNOWN 0xFF
417 /* CP210X_GET_COMM_STATUS returns these 0x13 bytes */
418 struct cp210x_comm_status {
420 __le32 ulHoldReasons;
421 __le32 ulAmountInInQueue;
422 __le32 ulAmountInOutQueue;
424 u8 bWaitForImmediate;
429 * CP210X_PURGE - 16 bits passed in wValue of USB request.
430 * SiLabs app note AN571 gives a strange description of the 4 bits:
431 * bit 0 or bit 2 clears the transmit queue and 1 or 3 receive.
432 * writing 1 to all, however, purges cp2108 well enough to avoid the hang.
434 #define PURGE_ALL 0x000f
436 /* CP210X_EMBED_EVENTS */
437 #define CP210X_ESCCHAR 0xec
439 #define CP210X_LSR_OVERRUN BIT(1)
440 #define CP210X_LSR_PARITY BIT(2)
441 #define CP210X_LSR_FRAME BIT(3)
442 #define CP210X_LSR_BREAK BIT(4)
445 /* CP210X_GET_FLOW/CP210X_SET_FLOW read/write these 0x10 bytes */
446 struct cp210x_flow_ctl {
447 __le32 ulControlHandshake;
448 __le32 ulFlowReplace;
453 /* cp210x_flow_ctl::ulControlHandshake */
454 #define CP210X_SERIAL_DTR_MASK GENMASK(1, 0)
455 #define CP210X_SERIAL_DTR_SHIFT(_mode) (_mode)
456 #define CP210X_SERIAL_CTS_HANDSHAKE BIT(3)
457 #define CP210X_SERIAL_DSR_HANDSHAKE BIT(4)
458 #define CP210X_SERIAL_DCD_HANDSHAKE BIT(5)
459 #define CP210X_SERIAL_DSR_SENSITIVITY BIT(6)
461 /* values for cp210x_flow_ctl::ulControlHandshake::CP210X_SERIAL_DTR_MASK */
462 #define CP210X_SERIAL_DTR_INACTIVE 0
463 #define CP210X_SERIAL_DTR_ACTIVE 1
464 #define CP210X_SERIAL_DTR_FLOW_CTL 2
466 /* cp210x_flow_ctl::ulFlowReplace */
467 #define CP210X_SERIAL_AUTO_TRANSMIT BIT(0)
468 #define CP210X_SERIAL_AUTO_RECEIVE BIT(1)
469 #define CP210X_SERIAL_ERROR_CHAR BIT(2)
470 #define CP210X_SERIAL_NULL_STRIPPING BIT(3)
471 #define CP210X_SERIAL_BREAK_CHAR BIT(4)
472 #define CP210X_SERIAL_RTS_MASK GENMASK(7, 6)
473 #define CP210X_SERIAL_RTS_SHIFT(_mode) (_mode << 6)
474 #define CP210X_SERIAL_XOFF_CONTINUE BIT(31)
476 /* values for cp210x_flow_ctl::ulFlowReplace::CP210X_SERIAL_RTS_MASK */
477 #define CP210X_SERIAL_RTS_INACTIVE 0
478 #define CP210X_SERIAL_RTS_ACTIVE 1
479 #define CP210X_SERIAL_RTS_FLOW_CTL 2
481 /* CP210X_VENDOR_SPECIFIC, CP210X_GET_DEVICEMODE call reads these 0x2 bytes. */
482 struct cp210x_pin_mode {
487 #define CP210X_PIN_MODE_MODEM 0
488 #define CP210X_PIN_MODE_GPIO BIT(0)
491 * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xf bytes
492 * on a CP2105 chip. Structure needs padding due to unused/unspecified bytes.
494 struct cp210x_dual_port_config {
499 __le16 suspend_state;
506 * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xd bytes
507 * on a CP2104 chip. Structure needs padding due to unused/unspecified bytes.
509 struct cp210x_single_port_config {
514 __le16 suspend_state;
519 #define CP210X_SCI_GPIO_MODE_OFFSET 9
520 #define CP210X_SCI_GPIO_MODE_MASK GENMASK(11, 9)
522 #define CP210X_ECI_GPIO_MODE_OFFSET 2
523 #define CP210X_ECI_GPIO_MODE_MASK GENMASK(3, 2)
525 #define CP210X_GPIO_MODE_OFFSET 8
526 #define CP210X_GPIO_MODE_MASK GENMASK(11, 8)
528 /* CP2105 port configuration values */
529 #define CP2105_GPIO0_TXLED_MODE BIT(0)
530 #define CP2105_GPIO1_RXLED_MODE BIT(1)
531 #define CP2105_GPIO1_RS485_MODE BIT(2)
533 /* CP2104 port configuration values */
534 #define CP2104_GPIO0_TXLED_MODE BIT(0)
535 #define CP2104_GPIO1_RXLED_MODE BIT(1)
536 #define CP2104_GPIO2_RS485_MODE BIT(2)
538 /* CP2102N configuration array indices */
539 #define CP210X_2NCONFIG_CONFIG_VERSION_IDX 2
540 #define CP210X_2NCONFIG_GPIO_MODE_IDX 581
541 #define CP210X_2NCONFIG_GPIO_RSTLATCH_IDX 587
542 #define CP210X_2NCONFIG_GPIO_CONTROL_IDX 600
544 /* CP2102N QFN20 port configuration values */
545 #define CP2102N_QFN20_GPIO2_TXLED_MODE BIT(2)
546 #define CP2102N_QFN20_GPIO3_RXLED_MODE BIT(3)
547 #define CP2102N_QFN20_GPIO1_RS485_MODE BIT(4)
548 #define CP2102N_QFN20_GPIO0_CLK_MODE BIT(6)
550 /* CP210X_VENDOR_SPECIFIC, CP210X_WRITE_LATCH call writes these 0x2 bytes. */
551 struct cp210x_gpio_write {
557 * Helper to get interface number when we only have struct usb_serial.
559 static u8 cp210x_interface_num(struct usb_serial *serial)
561 struct usb_host_interface *cur_altsetting;
563 cur_altsetting = serial->interface->cur_altsetting;
565 return cur_altsetting->desc.bInterfaceNumber;
569 * Reads a variable-sized block of CP210X_ registers, identified by req.
570 * Returns data into buf in native USB byte order.
572 static int cp210x_read_reg_block(struct usb_serial_port *port, u8 req,
573 void *buf, int bufsize)
575 struct usb_serial *serial = port->serial;
576 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
580 dmabuf = kmalloc(bufsize, GFP_KERNEL);
583 * FIXME Some callers don't bother to check for error,
584 * at least give them consistent junk until they are fixed
586 memset(buf, 0, bufsize);
590 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
591 req, REQTYPE_INTERFACE_TO_HOST, 0,
592 port_priv->bInterfaceNumber, dmabuf, bufsize,
593 USB_CTRL_SET_TIMEOUT);
594 if (result == bufsize) {
595 memcpy(buf, dmabuf, bufsize);
598 dev_err(&port->dev, "failed get req 0x%x size %d status: %d\n",
599 req, bufsize, result);
604 * FIXME Some callers don't bother to check for error,
605 * at least give them consistent junk until they are fixed
607 memset(buf, 0, bufsize);
616 * Reads any 32-bit CP210X_ register identified by req.
618 static int cp210x_read_u32_reg(struct usb_serial_port *port, u8 req, u32 *val)
623 err = cp210x_read_reg_block(port, req, &le32_val, sizeof(le32_val));
626 * FIXME Some callers don't bother to check for error,
627 * at least give them consistent junk until they are fixed
633 *val = le32_to_cpu(le32_val);
639 * Reads any 16-bit CP210X_ register identified by req.
641 static int cp210x_read_u16_reg(struct usb_serial_port *port, u8 req, u16 *val)
646 err = cp210x_read_reg_block(port, req, &le16_val, sizeof(le16_val));
650 *val = le16_to_cpu(le16_val);
656 * Reads any 8-bit CP210X_ register identified by req.
658 static int cp210x_read_u8_reg(struct usb_serial_port *port, u8 req, u8 *val)
660 return cp210x_read_reg_block(port, req, val, sizeof(*val));
664 * Reads a variable-sized vendor block of CP210X_ registers, identified by val.
665 * Returns data into buf in native USB byte order.
667 static int cp210x_read_vendor_block(struct usb_serial *serial, u8 type, u16 val,
668 void *buf, int bufsize)
673 dmabuf = kmalloc(bufsize, GFP_KERNEL);
677 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
678 CP210X_VENDOR_SPECIFIC, type, val,
679 cp210x_interface_num(serial), dmabuf, bufsize,
680 USB_CTRL_GET_TIMEOUT);
681 if (result == bufsize) {
682 memcpy(buf, dmabuf, bufsize);
685 dev_err(&serial->interface->dev,
686 "failed to get vendor val 0x%04x size %d: %d\n", val,
698 * Writes any 16-bit CP210X_ register (req) whose value is passed
699 * entirely in the wValue field of the USB request.
701 static int cp210x_write_u16_reg(struct usb_serial_port *port, u8 req, u16 val)
703 struct usb_serial *serial = port->serial;
704 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
707 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
708 req, REQTYPE_HOST_TO_INTERFACE, val,
709 port_priv->bInterfaceNumber, NULL, 0,
710 USB_CTRL_SET_TIMEOUT);
712 dev_err(&port->dev, "failed set request 0x%x status: %d\n",
720 * Writes a variable-sized block of CP210X_ registers, identified by req.
721 * Data in buf must be in native USB byte order.
723 static int cp210x_write_reg_block(struct usb_serial_port *port, u8 req,
724 void *buf, int bufsize)
726 struct usb_serial *serial = port->serial;
727 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
731 dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
735 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
736 req, REQTYPE_HOST_TO_INTERFACE, 0,
737 port_priv->bInterfaceNumber, dmabuf, bufsize,
738 USB_CTRL_SET_TIMEOUT);
742 if (result == bufsize) {
745 dev_err(&port->dev, "failed set req 0x%x size %d status: %d\n",
746 req, bufsize, result);
755 * Writes any 32-bit CP210X_ register identified by req.
757 static int cp210x_write_u32_reg(struct usb_serial_port *port, u8 req, u32 val)
761 le32_val = cpu_to_le32(val);
763 return cp210x_write_reg_block(port, req, &le32_val, sizeof(le32_val));
766 #ifdef CONFIG_GPIOLIB
768 * Writes a variable-sized vendor block of CP210X_ registers, identified by val.
769 * Data in buf must be in native USB byte order.
771 static int cp210x_write_vendor_block(struct usb_serial *serial, u8 type,
772 u16 val, void *buf, int bufsize)
777 dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
781 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
782 CP210X_VENDOR_SPECIFIC, type, val,
783 cp210x_interface_num(serial), dmabuf, bufsize,
784 USB_CTRL_SET_TIMEOUT);
788 if (result == bufsize) {
791 dev_err(&serial->interface->dev,
792 "failed to set vendor val 0x%04x size %d: %d\n", val,
803 * Detect CP2108 GET_LINE_CTL bug and activate workaround.
804 * Write a known good value 0x800, read it back.
805 * If it comes back swapped the bug is detected.
806 * Preserve the original register value.
808 static int cp210x_detect_swapped_line_ctl(struct usb_serial_port *port)
810 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
815 err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_save);
819 err = cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, 0x800);
823 err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_test);
827 if (line_ctl_test == 8) {
828 port_priv->has_swapped_line_ctl = true;
829 line_ctl_save = swab16(line_ctl_save);
832 return cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, line_ctl_save);
836 * Must always be called instead of cp210x_read_u16_reg(CP210X_GET_LINE_CTL)
837 * to workaround cp2108 bug and get correct value.
839 static int cp210x_get_line_ctl(struct usb_serial_port *port, u16 *ctl)
841 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
844 err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, ctl);
848 /* Workaround swapped bytes in 16-bit value from CP210X_GET_LINE_CTL */
849 if (port_priv->has_swapped_line_ctl)
855 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
857 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
860 result = cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_ENABLE);
862 dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
866 /* Configure the termios structure */
867 cp210x_get_termios(tty, port);
870 /* The baud rate must be initialised on cp2104 */
871 cp210x_change_speed(tty, port, NULL);
874 cp210x_enable_event_mode(port);
877 result = usb_serial_generic_open(tty, port);
884 cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
885 port_priv->event_mode = false;
890 static void cp210x_close(struct usb_serial_port *port)
892 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
894 usb_serial_generic_close(port);
896 /* Clear both queues; cp2108 needs this to avoid an occasional hang */
897 cp210x_write_u16_reg(port, CP210X_PURGE, PURGE_ALL);
899 cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
901 /* Disabling the interface disables event-insertion mode. */
902 port_priv->event_mode = false;
905 static void cp210x_process_lsr(struct usb_serial_port *port, unsigned char lsr, char *flag)
907 if (lsr & CP210X_LSR_BREAK) {
910 } else if (lsr & CP210X_LSR_PARITY) {
911 port->icount.parity++;
913 } else if (lsr & CP210X_LSR_FRAME) {
914 port->icount.frame++;
918 if (lsr & CP210X_LSR_OVERRUN) {
919 port->icount.overrun++;
920 tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
924 static bool cp210x_process_char(struct usb_serial_port *port, unsigned char *ch, char *flag)
926 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
928 switch (port_priv->event_state) {
930 if (*ch == CP210X_ESCCHAR) {
931 port_priv->event_state = ES_ESCAPE;
938 dev_dbg(&port->dev, "%s - escape char\n", __func__);
939 *ch = CP210X_ESCCHAR;
940 port_priv->event_state = ES_DATA;
943 port_priv->event_state = ES_LSR_DATA_0;
946 port_priv->event_state = ES_LSR;
949 port_priv->event_state = ES_MSR;
952 dev_err(&port->dev, "malformed event 0x%02x\n", *ch);
953 port_priv->event_state = ES_DATA;
958 port_priv->lsr = *ch;
959 port_priv->event_state = ES_LSR_DATA_1;
962 dev_dbg(&port->dev, "%s - lsr = 0x%02x, data = 0x%02x\n",
963 __func__, port_priv->lsr, *ch);
964 cp210x_process_lsr(port, port_priv->lsr, flag);
965 port_priv->event_state = ES_DATA;
968 dev_dbg(&port->dev, "%s - lsr = 0x%02x\n", __func__, *ch);
969 port_priv->lsr = *ch;
970 cp210x_process_lsr(port, port_priv->lsr, flag);
971 port_priv->event_state = ES_DATA;
974 dev_dbg(&port->dev, "%s - msr = 0x%02x\n", __func__, *ch);
976 port_priv->event_state = ES_DATA;
983 static void cp210x_process_read_urb(struct urb *urb)
985 struct usb_serial_port *port = urb->context;
986 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
987 unsigned char *ch = urb->transfer_buffer;
991 if (!urb->actual_length)
994 if (port_priv->event_mode) {
995 for (i = 0; i < urb->actual_length; i++, ch++) {
998 if (cp210x_process_char(port, ch, &flag))
1001 tty_insert_flip_char(&port->port, *ch, flag);
1004 tty_insert_flip_string(&port->port, ch, urb->actual_length);
1006 tty_flip_buffer_push(&port->port);
1010 * Read how many bytes are waiting in the TX queue.
1012 static int cp210x_get_tx_queue_byte_count(struct usb_serial_port *port,
1015 struct usb_serial *serial = port->serial;
1016 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1017 struct cp210x_comm_status *sts;
1020 sts = kmalloc(sizeof(*sts), GFP_KERNEL);
1024 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
1025 CP210X_GET_COMM_STATUS, REQTYPE_INTERFACE_TO_HOST,
1026 0, port_priv->bInterfaceNumber, sts, sizeof(*sts),
1027 USB_CTRL_GET_TIMEOUT);
1028 if (result == sizeof(*sts)) {
1029 *count = le32_to_cpu(sts->ulAmountInOutQueue);
1032 dev_err(&port->dev, "failed to get comm status: %d\n", result);
1042 static bool cp210x_tx_empty(struct usb_serial_port *port)
1047 err = cp210x_get_tx_queue_byte_count(port, &count);
1055 * cp210x_get_termios
1056 * Reads the baud rate, data bits, parity, stop bits and flow control mode
1057 * from the device, corrects any unsupported values, and configures the
1058 * termios structure to reflect the state of the device
1060 static void cp210x_get_termios(struct tty_struct *tty,
1061 struct usb_serial_port *port)
1066 cp210x_get_termios_port(tty->driver_data,
1067 &tty->termios.c_cflag, &baud);
1068 tty_encode_baud_rate(tty, baud, baud);
1072 cp210x_get_termios_port(port, &cflag, &baud);
1077 * cp210x_get_termios_port
1078 * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
1080 static void cp210x_get_termios_port(struct usb_serial_port *port,
1081 tcflag_t *cflagp, unsigned int *baudp)
1083 struct device *dev = &port->dev;
1085 struct cp210x_flow_ctl flow_ctl;
1091 cp210x_read_u32_reg(port, CP210X_GET_BAUDRATE, &baud);
1093 dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud);
1098 cp210x_get_line_ctl(port, &bits);
1100 switch (bits & BITS_DATA_MASK) {
1102 dev_dbg(dev, "%s - data bits = 5\n", __func__);
1106 dev_dbg(dev, "%s - data bits = 6\n", __func__);
1110 dev_dbg(dev, "%s - data bits = 7\n", __func__);
1114 dev_dbg(dev, "%s - data bits = 8\n", __func__);
1118 dev_dbg(dev, "%s - data bits = 9 (not supported, using 8 data bits)\n", __func__);
1120 bits &= ~BITS_DATA_MASK;
1121 bits |= BITS_DATA_8;
1122 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
1125 dev_dbg(dev, "%s - Unknown number of data bits, using 8\n", __func__);
1127 bits &= ~BITS_DATA_MASK;
1128 bits |= BITS_DATA_8;
1129 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
1133 switch (bits & BITS_PARITY_MASK) {
1134 case BITS_PARITY_NONE:
1135 dev_dbg(dev, "%s - parity = NONE\n", __func__);
1138 case BITS_PARITY_ODD:
1139 dev_dbg(dev, "%s - parity = ODD\n", __func__);
1140 cflag |= (PARENB|PARODD);
1142 case BITS_PARITY_EVEN:
1143 dev_dbg(dev, "%s - parity = EVEN\n", __func__);
1147 case BITS_PARITY_MARK:
1148 dev_dbg(dev, "%s - parity = MARK\n", __func__);
1149 cflag |= (PARENB|PARODD|CMSPAR);
1151 case BITS_PARITY_SPACE:
1152 dev_dbg(dev, "%s - parity = SPACE\n", __func__);
1154 cflag |= (PARENB|CMSPAR);
1157 dev_dbg(dev, "%s - Unknown parity mode, disabling parity\n", __func__);
1159 bits &= ~BITS_PARITY_MASK;
1160 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
1165 switch (bits & BITS_STOP_MASK) {
1167 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
1170 dev_dbg(dev, "%s - stop bits = 1.5 (not supported, using 1 stop bit)\n", __func__);
1171 bits &= ~BITS_STOP_MASK;
1172 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
1175 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
1179 dev_dbg(dev, "%s - Unknown number of stop bits, using 1 stop bit\n", __func__);
1180 bits &= ~BITS_STOP_MASK;
1181 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
1185 cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1187 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1188 if (ctl_hs & CP210X_SERIAL_CTS_HANDSHAKE) {
1189 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
1191 * When the port is closed, the CP210x hardware disables
1192 * auto-RTS and RTS is deasserted but it leaves auto-CTS when
1193 * in hardware flow control mode. When re-opening the port, if
1194 * auto-CTS is enabled on the cp210x, then auto-RTS must be
1195 * re-enabled in the driver.
1197 flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1198 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1199 flow_repl |= CP210X_SERIAL_RTS_SHIFT(CP210X_SERIAL_RTS_FLOW_CTL);
1200 flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1201 cp210x_write_reg_block(port,
1208 dev_dbg(dev, "%s - flow control = NONE\n", __func__);
1215 struct cp210x_rate {
1220 static const struct cp210x_rate cp210x_an205_table1[] = {
1249 { 921600, UINT_MAX }
1253 * Quantises the baud rate as per AN205 Table 1
1255 static speed_t cp210x_get_an205_rate(speed_t baud)
1259 for (i = 0; i < ARRAY_SIZE(cp210x_an205_table1); ++i) {
1260 if (baud <= cp210x_an205_table1[i].high)
1264 return cp210x_an205_table1[i].rate;
1267 static speed_t cp210x_get_actual_rate(speed_t baud)
1269 unsigned int prescale = 1;
1275 div = DIV_ROUND_CLOSEST(48000000, 2 * prescale * baud);
1276 baud = 48000000 / (2 * prescale * div);
1282 * CP2101 supports the following baud rates:
1284 * 300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
1285 * 38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
1287 * CP2102 and CP2103 support the following additional rates:
1289 * 4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
1292 * The device will map a requested rate to a supported one, but the result
1293 * of requests for rates greater than 1053257 is undefined (see AN205).
1295 * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
1296 * respectively, with an error less than 1%. The actual rates are determined
1299 * div = round(freq / (2 x prescale x request))
1300 * actual = freq / (2 x prescale x div)
1302 * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
1304 * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
1307 static void cp210x_change_speed(struct tty_struct *tty,
1308 struct usb_serial_port *port, struct ktermios *old_termios)
1310 struct usb_serial *serial = port->serial;
1311 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1315 * This maps the requested rate to the actual rate, a valid rate on
1316 * cp2102 or cp2103, or to an arbitrary rate in [1M, max_speed].
1318 * NOTE: B0 is not implemented.
1320 baud = clamp(tty->termios.c_ospeed, priv->min_speed, priv->max_speed);
1322 if (priv->use_actual_rate)
1323 baud = cp210x_get_actual_rate(baud);
1324 else if (baud < 1000000)
1325 baud = cp210x_get_an205_rate(baud);
1327 dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
1328 if (cp210x_write_u32_reg(port, CP210X_SET_BAUDRATE, baud)) {
1329 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
1331 baud = old_termios->c_ospeed;
1336 tty_encode_baud_rate(tty, baud, baud);
1339 static void cp210x_enable_event_mode(struct usb_serial_port *port)
1341 struct cp210x_serial_private *priv = usb_get_serial_data(port->serial);
1342 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1345 if (port_priv->event_mode)
1348 if (priv->no_event_mode)
1351 port_priv->event_state = ES_DATA;
1352 port_priv->event_mode = true;
1354 ret = cp210x_write_u16_reg(port, CP210X_EMBED_EVENTS, CP210X_ESCCHAR);
1356 dev_err(&port->dev, "failed to enable events: %d\n", ret);
1357 port_priv->event_mode = false;
1361 static void cp210x_disable_event_mode(struct usb_serial_port *port)
1363 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1366 if (!port_priv->event_mode)
1369 ret = cp210x_write_u16_reg(port, CP210X_EMBED_EVENTS, 0);
1371 dev_err(&port->dev, "failed to disable events: %d\n", ret);
1375 port_priv->event_mode = false;
1378 static void cp210x_set_termios(struct tty_struct *tty,
1379 struct usb_serial_port *port, struct ktermios *old_termios)
1381 struct device *dev = &port->dev;
1382 unsigned int cflag, old_cflag;
1385 cflag = tty->termios.c_cflag;
1386 old_cflag = old_termios->c_cflag;
1388 if (tty->termios.c_ospeed != old_termios->c_ospeed)
1389 cp210x_change_speed(tty, port, old_termios);
1391 /* If the number of data bits is to be updated */
1392 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
1393 cp210x_get_line_ctl(port, &bits);
1394 bits &= ~BITS_DATA_MASK;
1395 switch (cflag & CSIZE) {
1397 bits |= BITS_DATA_5;
1398 dev_dbg(dev, "%s - data bits = 5\n", __func__);
1401 bits |= BITS_DATA_6;
1402 dev_dbg(dev, "%s - data bits = 6\n", __func__);
1405 bits |= BITS_DATA_7;
1406 dev_dbg(dev, "%s - data bits = 7\n", __func__);
1410 bits |= BITS_DATA_8;
1411 dev_dbg(dev, "%s - data bits = 8\n", __func__);
1414 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1415 dev_dbg(dev, "Number of data bits requested not supported by device\n");
1418 if ((cflag & (PARENB|PARODD|CMSPAR)) !=
1419 (old_cflag & (PARENB|PARODD|CMSPAR))) {
1420 cp210x_get_line_ctl(port, &bits);
1421 bits &= ~BITS_PARITY_MASK;
1422 if (cflag & PARENB) {
1423 if (cflag & CMSPAR) {
1424 if (cflag & PARODD) {
1425 bits |= BITS_PARITY_MARK;
1426 dev_dbg(dev, "%s - parity = MARK\n", __func__);
1428 bits |= BITS_PARITY_SPACE;
1429 dev_dbg(dev, "%s - parity = SPACE\n", __func__);
1432 if (cflag & PARODD) {
1433 bits |= BITS_PARITY_ODD;
1434 dev_dbg(dev, "%s - parity = ODD\n", __func__);
1436 bits |= BITS_PARITY_EVEN;
1437 dev_dbg(dev, "%s - parity = EVEN\n", __func__);
1441 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1442 dev_dbg(dev, "Parity mode not supported by device\n");
1445 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
1446 cp210x_get_line_ctl(port, &bits);
1447 bits &= ~BITS_STOP_MASK;
1448 if (cflag & CSTOPB) {
1449 bits |= BITS_STOP_2;
1450 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
1452 bits |= BITS_STOP_1;
1453 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
1455 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1456 dev_dbg(dev, "Number of stop bits requested not supported by device\n");
1459 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
1460 struct cp210x_flow_ctl flow_ctl;
1464 cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1466 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1467 flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1468 dev_dbg(dev, "%s - read ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1469 __func__, ctl_hs, flow_repl);
1471 ctl_hs &= ~CP210X_SERIAL_DSR_HANDSHAKE;
1472 ctl_hs &= ~CP210X_SERIAL_DCD_HANDSHAKE;
1473 ctl_hs &= ~CP210X_SERIAL_DSR_SENSITIVITY;
1474 ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1475 ctl_hs |= CP210X_SERIAL_DTR_SHIFT(CP210X_SERIAL_DTR_ACTIVE);
1476 if (cflag & CRTSCTS) {
1477 ctl_hs |= CP210X_SERIAL_CTS_HANDSHAKE;
1479 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1480 flow_repl |= CP210X_SERIAL_RTS_SHIFT(
1481 CP210X_SERIAL_RTS_FLOW_CTL);
1482 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
1484 ctl_hs &= ~CP210X_SERIAL_CTS_HANDSHAKE;
1486 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1487 flow_repl |= CP210X_SERIAL_RTS_SHIFT(
1488 CP210X_SERIAL_RTS_ACTIVE);
1489 dev_dbg(dev, "%s - flow control = NONE\n", __func__);
1492 dev_dbg(dev, "%s - write ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1493 __func__, ctl_hs, flow_repl);
1494 flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1495 flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1496 cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1501 * Enable event-insertion mode only if input parity checking is
1505 cp210x_enable_event_mode(port);
1507 cp210x_disable_event_mode(port);
1510 static int cp210x_tiocmset(struct tty_struct *tty,
1511 unsigned int set, unsigned int clear)
1513 struct usb_serial_port *port = tty->driver_data;
1514 return cp210x_tiocmset_port(port, set, clear);
1517 static int cp210x_tiocmset_port(struct usb_serial_port *port,
1518 unsigned int set, unsigned int clear)
1522 if (set & TIOCM_RTS) {
1523 control |= CONTROL_RTS;
1524 control |= CONTROL_WRITE_RTS;
1526 if (set & TIOCM_DTR) {
1527 control |= CONTROL_DTR;
1528 control |= CONTROL_WRITE_DTR;
1530 if (clear & TIOCM_RTS) {
1531 control &= ~CONTROL_RTS;
1532 control |= CONTROL_WRITE_RTS;
1534 if (clear & TIOCM_DTR) {
1535 control &= ~CONTROL_DTR;
1536 control |= CONTROL_WRITE_DTR;
1539 dev_dbg(&port->dev, "%s - control = 0x%.4x\n", __func__, control);
1541 return cp210x_write_u16_reg(port, CP210X_SET_MHS, control);
1544 static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
1547 cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
1549 cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
1552 static int cp210x_tiocmget(struct tty_struct *tty)
1554 struct usb_serial_port *port = tty->driver_data;
1558 result = cp210x_read_u8_reg(port, CP210X_GET_MDMSTS, &control);
1562 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
1563 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
1564 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
1565 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
1566 |((control & CONTROL_RING)? TIOCM_RI : 0)
1567 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
1569 dev_dbg(&port->dev, "%s - control = 0x%.2x\n", __func__, control);
1574 static void cp210x_break_ctl(struct tty_struct *tty, int break_state)
1576 struct usb_serial_port *port = tty->driver_data;
1579 if (break_state == 0)
1583 dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
1584 state == BREAK_OFF ? "off" : "on");
1585 cp210x_write_u16_reg(port, CP210X_SET_BREAK, state);
1588 #ifdef CONFIG_GPIOLIB
1589 static int cp210x_gpio_request(struct gpio_chip *gc, unsigned int offset)
1591 struct usb_serial *serial = gpiochip_get_data(gc);
1592 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1594 if (priv->gpio_altfunc & BIT(offset))
1600 static int cp210x_gpio_get(struct gpio_chip *gc, unsigned int gpio)
1602 struct usb_serial *serial = gpiochip_get_data(gc);
1603 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1604 u8 req_type = REQTYPE_DEVICE_TO_HOST;
1608 if (priv->partnum == CP210X_PARTNUM_CP2105)
1609 req_type = REQTYPE_INTERFACE_TO_HOST;
1611 result = usb_autopm_get_interface(serial->interface);
1615 result = cp210x_read_vendor_block(serial, req_type,
1616 CP210X_READ_LATCH, &buf, sizeof(buf));
1617 usb_autopm_put_interface(serial->interface);
1621 return !!(buf & BIT(gpio));
1624 static void cp210x_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)
1626 struct usb_serial *serial = gpiochip_get_data(gc);
1627 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1628 struct cp210x_gpio_write buf;
1632 buf.state = BIT(gpio);
1636 buf.mask = BIT(gpio);
1638 result = usb_autopm_get_interface(serial->interface);
1642 if (priv->partnum == CP210X_PARTNUM_CP2105) {
1643 result = cp210x_write_vendor_block(serial,
1644 REQTYPE_HOST_TO_INTERFACE,
1645 CP210X_WRITE_LATCH, &buf,
1648 u16 wIndex = buf.state << 8 | buf.mask;
1650 result = usb_control_msg(serial->dev,
1651 usb_sndctrlpipe(serial->dev, 0),
1652 CP210X_VENDOR_SPECIFIC,
1653 REQTYPE_HOST_TO_DEVICE,
1656 NULL, 0, USB_CTRL_SET_TIMEOUT);
1659 usb_autopm_put_interface(serial->interface);
1662 dev_err(&serial->interface->dev, "failed to set GPIO value: %d\n",
1667 static int cp210x_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
1669 struct usb_serial *serial = gpiochip_get_data(gc);
1670 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1672 return priv->gpio_input & BIT(gpio);
1675 static int cp210x_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
1677 struct usb_serial *serial = gpiochip_get_data(gc);
1678 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1680 if (priv->partnum == CP210X_PARTNUM_CP2105) {
1681 /* hardware does not support an input mode */
1685 /* push-pull pins cannot be changed to be inputs */
1686 if (priv->gpio_pushpull & BIT(gpio))
1689 /* make sure to release pin if it is being driven low */
1690 cp210x_gpio_set(gc, gpio, 1);
1692 priv->gpio_input |= BIT(gpio);
1697 static int cp210x_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
1700 struct usb_serial *serial = gpiochip_get_data(gc);
1701 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1703 priv->gpio_input &= ~BIT(gpio);
1704 cp210x_gpio_set(gc, gpio, value);
1709 static int cp210x_gpio_set_config(struct gpio_chip *gc, unsigned int gpio,
1710 unsigned long config)
1712 struct usb_serial *serial = gpiochip_get_data(gc);
1713 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1714 enum pin_config_param param = pinconf_to_config_param(config);
1716 /* Succeed only if in correct mode (this can't be set at runtime) */
1717 if ((param == PIN_CONFIG_DRIVE_PUSH_PULL) &&
1718 (priv->gpio_pushpull & BIT(gpio)))
1721 if ((param == PIN_CONFIG_DRIVE_OPEN_DRAIN) &&
1722 !(priv->gpio_pushpull & BIT(gpio)))
1729 * This function is for configuring GPIO using shared pins, where other signals
1730 * are made unavailable by configuring the use of GPIO. This is believed to be
1731 * only applicable to the cp2105 at this point, the other devices supported by
1732 * this driver that provide GPIO do so in a way that does not impact other
1733 * signals and are thus expected to have very different initialisation.
1735 static int cp2105_gpioconf_init(struct usb_serial *serial)
1737 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1738 struct cp210x_pin_mode mode;
1739 struct cp210x_dual_port_config config;
1740 u8 intf_num = cp210x_interface_num(serial);
1744 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1745 CP210X_GET_DEVICEMODE, &mode,
1750 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1751 CP210X_GET_PORTCONFIG, &config,
1756 /* 2 banks of GPIO - One for the pins taken from each serial port */
1757 if (intf_num == 0) {
1760 if (mode.eci == CP210X_PIN_MODE_MODEM) {
1761 /* mark all GPIOs of this interface as reserved */
1762 priv->gpio_altfunc = 0xff;
1766 iface_config = config.eci_cfg;
1767 priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1768 CP210X_ECI_GPIO_MODE_MASK) >>
1769 CP210X_ECI_GPIO_MODE_OFFSET);
1770 } else if (intf_num == 1) {
1773 if (mode.sci == CP210X_PIN_MODE_MODEM) {
1774 /* mark all GPIOs of this interface as reserved */
1775 priv->gpio_altfunc = 0xff;
1779 iface_config = config.sci_cfg;
1780 priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1781 CP210X_SCI_GPIO_MODE_MASK) >>
1782 CP210X_SCI_GPIO_MODE_OFFSET);
1787 /* mark all pins which are not in GPIO mode */
1788 if (iface_config & CP2105_GPIO0_TXLED_MODE) /* GPIO 0 */
1789 priv->gpio_altfunc |= BIT(0);
1790 if (iface_config & (CP2105_GPIO1_RXLED_MODE | /* GPIO 1 */
1791 CP2105_GPIO1_RS485_MODE))
1792 priv->gpio_altfunc |= BIT(1);
1794 /* driver implementation for CP2105 only supports outputs */
1795 priv->gpio_input = 0;
1800 static int cp2104_gpioconf_init(struct usb_serial *serial)
1802 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1803 struct cp210x_single_port_config config;
1809 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1810 CP210X_GET_PORTCONFIG, &config,
1817 iface_config = config.device_cfg;
1818 priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1819 CP210X_GPIO_MODE_MASK) >>
1820 CP210X_GPIO_MODE_OFFSET);
1821 gpio_latch = (u8)((le16_to_cpu(config.reset_state) &
1822 CP210X_GPIO_MODE_MASK) >>
1823 CP210X_GPIO_MODE_OFFSET);
1825 /* mark all pins which are not in GPIO mode */
1826 if (iface_config & CP2104_GPIO0_TXLED_MODE) /* GPIO 0 */
1827 priv->gpio_altfunc |= BIT(0);
1828 if (iface_config & CP2104_GPIO1_RXLED_MODE) /* GPIO 1 */
1829 priv->gpio_altfunc |= BIT(1);
1830 if (iface_config & CP2104_GPIO2_RS485_MODE) /* GPIO 2 */
1831 priv->gpio_altfunc |= BIT(2);
1834 * Like CP2102N, CP2104 has also no strict input and output pin
1836 * Do the same input mode emulation as CP2102N.
1838 for (i = 0; i < priv->gc.ngpio; ++i) {
1840 * Set direction to "input" iff pin is open-drain and reset
1843 if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1844 priv->gpio_input |= BIT(i);
1850 static int cp2102n_gpioconf_init(struct usb_serial *serial)
1852 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1853 const u16 config_size = 0x02a6;
1864 * Retrieve device configuration from the device.
1865 * The array received contains all customization settings done at the
1866 * factory/manufacturer. Format of the array is documented at the
1867 * time of writing at:
1868 * https://www.silabs.com/community/interface/knowledge-base.entry.html/2017/03/31/cp2102n_setconfig-xsfa
1870 config_buf = kmalloc(config_size, GFP_KERNEL);
1874 result = cp210x_read_vendor_block(serial,
1875 REQTYPE_DEVICE_TO_HOST,
1876 CP210X_READ_2NCONFIG,
1884 config_version = config_buf[CP210X_2NCONFIG_CONFIG_VERSION_IDX];
1885 gpio_pushpull = config_buf[CP210X_2NCONFIG_GPIO_MODE_IDX];
1886 gpio_ctrl = config_buf[CP210X_2NCONFIG_GPIO_CONTROL_IDX];
1887 gpio_rst_latch = config_buf[CP210X_2NCONFIG_GPIO_RSTLATCH_IDX];
1891 /* Make sure this is a config format we understand. */
1892 if (config_version != 0x01)
1898 * Get default pin states after reset. Needed so we can determine
1899 * the direction of an open-drain pin.
1901 gpio_latch = (gpio_rst_latch >> 3) & 0x0f;
1903 /* 0 indicates open-drain mode, 1 is push-pull */
1904 priv->gpio_pushpull = (gpio_pushpull >> 3) & 0x0f;
1906 /* 0 indicates GPIO mode, 1 is alternate function */
1907 if (priv->partnum == CP210X_PARTNUM_CP2102N_QFN20) {
1908 /* QFN20 is special... */
1909 if (gpio_ctrl & CP2102N_QFN20_GPIO0_CLK_MODE) /* GPIO 0 */
1910 priv->gpio_altfunc |= BIT(0);
1911 if (gpio_ctrl & CP2102N_QFN20_GPIO1_RS485_MODE) /* GPIO 1 */
1912 priv->gpio_altfunc |= BIT(1);
1913 if (gpio_ctrl & CP2102N_QFN20_GPIO2_TXLED_MODE) /* GPIO 2 */
1914 priv->gpio_altfunc |= BIT(2);
1915 if (gpio_ctrl & CP2102N_QFN20_GPIO3_RXLED_MODE) /* GPIO 3 */
1916 priv->gpio_altfunc |= BIT(3);
1918 priv->gpio_altfunc = (gpio_ctrl >> 2) & 0x0f;
1921 if (priv->partnum == CP210X_PARTNUM_CP2102N_QFN28) {
1923 * For the QFN28 package, GPIO4-6 are controlled by
1924 * the low three bits of the mode/latch fields.
1925 * Contrary to the document linked above, the bits for
1926 * the SUSPEND pins are elsewhere. No alternate
1927 * function is available for these pins.
1930 gpio_latch |= (gpio_rst_latch & 7) << 4;
1931 priv->gpio_pushpull |= (gpio_pushpull & 7) << 4;
1935 * The CP2102N does not strictly has input and output pin modes,
1936 * it only knows open-drain and push-pull modes which is set at
1937 * factory. An open-drain pin can function both as an
1938 * input or an output. We emulate input mode for open-drain pins
1939 * by making sure they are not driven low, and we do not allow
1940 * push-pull pins to be set as an input.
1942 for (i = 0; i < priv->gc.ngpio; ++i) {
1944 * Set direction to "input" iff pin is open-drain and reset
1947 if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1948 priv->gpio_input |= BIT(i);
1954 static int cp210x_gpio_init(struct usb_serial *serial)
1956 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1959 switch (priv->partnum) {
1960 case CP210X_PARTNUM_CP2104:
1961 result = cp2104_gpioconf_init(serial);
1963 case CP210X_PARTNUM_CP2105:
1964 result = cp2105_gpioconf_init(serial);
1966 case CP210X_PARTNUM_CP2102N_QFN28:
1967 case CP210X_PARTNUM_CP2102N_QFN24:
1968 case CP210X_PARTNUM_CP2102N_QFN20:
1969 result = cp2102n_gpioconf_init(serial);
1978 priv->gc.label = "cp210x";
1979 priv->gc.request = cp210x_gpio_request;
1980 priv->gc.get_direction = cp210x_gpio_direction_get;
1981 priv->gc.direction_input = cp210x_gpio_direction_input;
1982 priv->gc.direction_output = cp210x_gpio_direction_output;
1983 priv->gc.get = cp210x_gpio_get;
1984 priv->gc.set = cp210x_gpio_set;
1985 priv->gc.set_config = cp210x_gpio_set_config;
1986 priv->gc.owner = THIS_MODULE;
1987 priv->gc.parent = &serial->interface->dev;
1989 priv->gc.can_sleep = true;
1991 result = gpiochip_add_data(&priv->gc, serial);
1993 priv->gpio_registered = true;
1998 static void cp210x_gpio_remove(struct usb_serial *serial)
2000 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2002 if (priv->gpio_registered) {
2003 gpiochip_remove(&priv->gc);
2004 priv->gpio_registered = false;
2010 static int cp210x_gpio_init(struct usb_serial *serial)
2015 static void cp210x_gpio_remove(struct usb_serial *serial)
2022 static int cp210x_port_probe(struct usb_serial_port *port)
2024 struct usb_serial *serial = port->serial;
2025 struct cp210x_port_private *port_priv;
2028 port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
2032 port_priv->bInterfaceNumber = cp210x_interface_num(serial);
2034 usb_set_serial_port_data(port, port_priv);
2036 ret = cp210x_detect_swapped_line_ctl(port);
2045 static int cp210x_port_remove(struct usb_serial_port *port)
2047 struct cp210x_port_private *port_priv;
2049 port_priv = usb_get_serial_port_data(port);
2055 static void cp210x_init_max_speed(struct usb_serial *serial)
2057 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2058 bool use_actual_rate = false;
2062 switch (priv->partnum) {
2063 case CP210X_PARTNUM_CP2101:
2066 case CP210X_PARTNUM_CP2102:
2067 case CP210X_PARTNUM_CP2103:
2070 case CP210X_PARTNUM_CP2104:
2071 use_actual_rate = true;
2074 case CP210X_PARTNUM_CP2108:
2077 case CP210X_PARTNUM_CP2105:
2078 if (cp210x_interface_num(serial) == 0) {
2079 use_actual_rate = true;
2080 max = 2000000; /* ECI */
2083 max = 921600; /* SCI */
2086 case CP210X_PARTNUM_CP2102N_QFN28:
2087 case CP210X_PARTNUM_CP2102N_QFN24:
2088 case CP210X_PARTNUM_CP2102N_QFN20:
2089 use_actual_rate = true;
2097 priv->min_speed = min;
2098 priv->max_speed = max;
2099 priv->use_actual_rate = use_actual_rate;
2102 static void cp2102_determine_quirks(struct usb_serial *serial)
2104 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2108 buf = kmalloc(2, GFP_KERNEL);
2112 * Some (possibly counterfeit) CP2102 do not support event-insertion
2113 * mode and respond differently to malformed vendor requests.
2114 * Specifically, they return one instead of two bytes when sent a
2115 * two-byte part-number request.
2117 ret = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
2118 CP210X_VENDOR_SPECIFIC, REQTYPE_DEVICE_TO_HOST,
2119 CP210X_GET_PARTNUM, 0, buf, 2, USB_CTRL_GET_TIMEOUT);
2121 dev_dbg(&serial->interface->dev,
2122 "device does not support event-insertion mode\n");
2123 priv->no_event_mode = true;
2129 static void cp210x_determine_quirks(struct usb_serial *serial)
2131 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2133 switch (priv->partnum) {
2134 case CP210X_PARTNUM_CP2102:
2135 cp2102_determine_quirks(serial);
2142 static int cp210x_attach(struct usb_serial *serial)
2145 struct cp210x_serial_private *priv;
2147 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
2151 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
2152 CP210X_GET_PARTNUM, &priv->partnum,
2153 sizeof(priv->partnum));
2155 dev_warn(&serial->interface->dev,
2156 "querying part number failed\n");
2157 priv->partnum = CP210X_PARTNUM_UNKNOWN;
2160 usb_set_serial_data(serial, priv);
2162 cp210x_determine_quirks(serial);
2163 cp210x_init_max_speed(serial);
2165 result = cp210x_gpio_init(serial);
2167 dev_err(&serial->interface->dev, "GPIO initialisation failed: %d\n",
2174 static void cp210x_disconnect(struct usb_serial *serial)
2176 cp210x_gpio_remove(serial);
2179 static void cp210x_release(struct usb_serial *serial)
2181 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2183 cp210x_gpio_remove(serial);
2188 module_usb_serial_driver(serial_drivers, id_table);
2190 MODULE_DESCRIPTION(DRIVER_DESC);
2191 MODULE_LICENSE("GPL v2");