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
);
54 static const struct usb_device_id id_table
[] = {
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, 0x01FF) }, /* Siemens RUGGEDCOM USB Serial Console */
64 { USB_DEVICE(0x0BED, 0x1100) }, /* MEI (TM) Cashflow-SC Bill/Voucher Acceptor */
65 { USB_DEVICE(0x0BED, 0x1101) }, /* MEI series 2000 Combo Acceptor */
66 { USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
67 { USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
68 { USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */
69 { USB_DEVICE(0x0FDE, 0xCA05) }, /* OWL Wireless Electricity Monitor CM-160 */
70 { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
71 { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
72 { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
73 { USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */
74 { USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */
75 { USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */
76 { USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
77 { USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
78 { USB_DEVICE(0x10C4, 0x8044) }, /* Cygnal Debug Adapter */
79 { USB_DEVICE(0x10C4, 0x804E) }, /* Software Bisque Paramount ME build-in converter */
80 { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
81 { USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */
82 { USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
83 { USB_DEVICE(0x10C4, 0x806F) }, /* IMS USB to RS422 Converter Cable */
84 { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
85 { USB_DEVICE(0x10C4, 0x80C4) }, /* Cygnal Integrated Products, Inc., Optris infrared thermometer */
86 { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
87 { USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
88 { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
89 { USB_DEVICE(0x10C4, 0x8115) }, /* Arygon NFC/Mifare Reader */
90 { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
91 { USB_DEVICE(0x10C4, 0x813F) }, /* Tams Master Easy Control */
92 { USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
93 { USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
94 { USB_DEVICE(0x2405, 0x0003) }, /* West Mountain Radio RIGblaster Advantage */
95 { USB_DEVICE(0x10C4, 0x8156) }, /* B&G H3000 link cable */
96 { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
97 { USB_DEVICE(0x10C4, 0x815F) }, /* Timewave HamLinkUSB */
98 { USB_DEVICE(0x10C4, 0x817C) }, /* CESINEL MEDCAL N Power Quality Monitor */
99 { USB_DEVICE(0x10C4, 0x817D) }, /* CESINEL MEDCAL NT Power Quality Monitor */
100 { USB_DEVICE(0x10C4, 0x817E) }, /* CESINEL MEDCAL S Power Quality Monitor */
101 { USB_DEVICE(0x10C4, 0x818B) }, /* AVIT Research USB to TTL */
102 { USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
103 { USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
104 { USB_DEVICE(0x10C4, 0x81A9) }, /* Multiplex RC Interface */
105 { USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
106 { USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */
107 { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
108 { USB_DEVICE(0x10C4, 0x81D7) }, /* IAI Corp. RCB-CV-USB USB to RS485 Adaptor */
109 { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
110 { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
111 { USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
112 { USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
113 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
114 { USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
115 { USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
116 { USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */
117 { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
118 { USB_DEVICE(0x10C4, 0x82EF) }, /* CESINEL FALCO 6105 AC Power Supply */
119 { USB_DEVICE(0x10C4, 0x82F1) }, /* CESINEL MEDCAL EFD Earth Fault Detector */
120 { USB_DEVICE(0x10C4, 0x82F2) }, /* CESINEL MEDCAL ST Network Analyzer */
121 { USB_DEVICE(0x10C4, 0x82F4) }, /* Starizona MicroTouch */
122 { USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
123 { USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
124 { USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
125 { USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
126 { USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
127 { USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
128 { USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
129 { USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
130 { USB_DEVICE(0x10C4, 0x8470) }, /* Juniper Networks BX Series System Console */
131 { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
132 { USB_DEVICE(0x10C4, 0x84B6) }, /* Starizona Hyperion */
133 { USB_DEVICE(0x10C4, 0x851E) }, /* CESINEL MEDCAL PT Network Analyzer */
134 { USB_DEVICE(0x10C4, 0x85A7) }, /* LifeScan OneTouch Verio IQ */
135 { USB_DEVICE(0x10C4, 0x85B8) }, /* CESINEL ReCon T Energy Logger */
136 { USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
137 { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
138 { USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
139 { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
140 { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
141 { USB_DEVICE(0x10C4, 0x8856) }, /* CEL EM357 ZigBee USB Stick - LR */
142 { USB_DEVICE(0x10C4, 0x8857) }, /* CEL EM357 ZigBee USB Stick */
143 { USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
144 { USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
145 { USB_DEVICE(0x10C4, 0x88FB) }, /* CESINEL MEDCAL STII Network Analyzer */
146 { USB_DEVICE(0x10C4, 0x8938) }, /* CESINEL MEDCAL S II Network Analyzer */
147 { USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
148 { USB_DEVICE(0x10C4, 0x8962) }, /* Brim Brothers charging dock */
149 { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit Device */
150 { USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
151 { USB_DEVICE(0x10C4, 0x89A4) }, /* CESINEL FTBC Flexible Thyristor Bridge Controller */
152 { USB_DEVICE(0x10C4, 0x89FB) }, /* Qivicon ZigBee USB Radio Stick */
153 { USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
154 { USB_DEVICE(0x10C4, 0x8A5E) }, /* CEL EM3588 ZigBee USB Stick Long Range */
155 { USB_DEVICE(0x10C4, 0x8B34) }, /* Qivicon ZigBee USB Radio Stick */
156 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
157 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
158 { USB_DEVICE(0x10C4, 0xEA63) }, /* Silicon Labs Windows Update (CP2101-4/CP2102N) */
159 { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
160 { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
161 { USB_DEVICE(0x10C4, 0xEA7A) }, /* Silicon Labs Windows Update (CP2105) */
162 { USB_DEVICE(0x10C4, 0xEA7B) }, /* Silicon Labs Windows Update (CP2108) */
163 { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
164 { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
165 { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
166 { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
167 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
168 { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
169 { USB_DEVICE(0x12B8, 0xEC60) }, /* Link G4 ECU */
170 { USB_DEVICE(0x12B8, 0xEC62) }, /* Link G4+ ECU */
171 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
172 { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
173 { USB_DEVICE(0x155A, 0x1006) }, /* ELDAT Easywave RX09 */
174 { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
175 { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
176 { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
177 { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
178 { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
179 { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
180 { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
181 { USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
182 { USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
183 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
184 { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
185 { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
186 { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
187 { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
188 { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
189 { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
190 { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
191 { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
192 { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
193 { USB_DEVICE(0x18EF, 0xE025) }, /* ELV Marble Sound Board 1 */
194 { USB_DEVICE(0x18EF, 0xE030) }, /* ELV ALC 8xxx Battery Charger */
195 { USB_DEVICE(0x18EF, 0xE032) }, /* ELV TFD500 Data Logger */
196 { USB_DEVICE(0x1901, 0x0190) }, /* GE B850 CP2105 Recorder interface */
197 { USB_DEVICE(0x1901, 0x0193) }, /* GE B650 CP2104 PMC interface */
198 { USB_DEVICE(0x1901, 0x0194) }, /* GE Healthcare Remote Alarm Box */
199 { USB_DEVICE(0x1901, 0x0195) }, /* GE B850/B650/B450 CP2104 DP UART interface */
200 { USB_DEVICE(0x1901, 0x0196) }, /* GE B850 CP2105 DP UART interface */
201 { USB_DEVICE(0x19CF, 0x3000) }, /* Parrot NMEA GPS Flight Recorder */
202 { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
203 { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
204 { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
205 { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
206 { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
207 { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
208 { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
209 { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
210 { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
211 { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
212 { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
213 { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
214 { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
215 { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
216 { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
217 { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
218 { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
219 { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
220 { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
221 { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
222 { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
223 { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
224 { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
225 { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
226 { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
227 { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
228 { USB_DEVICE(0x2626, 0xEA60) }, /* Aruba Networks 7xxx USB Serial Console */
229 { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
230 { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
231 { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
232 { USB_DEVICE(0x3923, 0x7A0B) }, /* National Instruments USB Serial Console */
233 { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
234 { } /* Terminating Entry */
237 MODULE_DEVICE_TABLE(usb
, id_table
);
239 struct cp210x_serial_private
{
240 #ifdef CONFIG_GPIOLIB
242 bool gpio_registered
;
249 bool use_actual_rate
;
252 struct cp210x_port_private
{
253 __u8 bInterfaceNumber
;
254 bool has_swapped_line_ctl
;
257 static struct usb_serial_driver cp210x_device
= {
259 .owner
= THIS_MODULE
,
262 .id_table
= id_table
,
265 .bulk_out_size
= 256,
267 .close
= cp210x_close
,
268 .break_ctl
= cp210x_break_ctl
,
269 .set_termios
= cp210x_set_termios
,
270 .tx_empty
= cp210x_tx_empty
,
271 .tiocmget
= cp210x_tiocmget
,
272 .tiocmset
= cp210x_tiocmset
,
273 .attach
= cp210x_attach
,
274 .disconnect
= cp210x_disconnect
,
275 .release
= cp210x_release
,
276 .port_probe
= cp210x_port_probe
,
277 .port_remove
= cp210x_port_remove
,
278 .dtr_rts
= cp210x_dtr_rts
281 static struct usb_serial_driver
* const serial_drivers
[] = {
285 /* Config request types */
286 #define REQTYPE_HOST_TO_INTERFACE 0x41
287 #define REQTYPE_INTERFACE_TO_HOST 0xc1
288 #define REQTYPE_HOST_TO_DEVICE 0x40
289 #define REQTYPE_DEVICE_TO_HOST 0xc0
291 /* Config request codes */
292 #define CP210X_IFC_ENABLE 0x00
293 #define CP210X_SET_BAUDDIV 0x01
294 #define CP210X_GET_BAUDDIV 0x02
295 #define CP210X_SET_LINE_CTL 0x03
296 #define CP210X_GET_LINE_CTL 0x04
297 #define CP210X_SET_BREAK 0x05
298 #define CP210X_IMM_CHAR 0x06
299 #define CP210X_SET_MHS 0x07
300 #define CP210X_GET_MDMSTS 0x08
301 #define CP210X_SET_XON 0x09
302 #define CP210X_SET_XOFF 0x0A
303 #define CP210X_SET_EVENTMASK 0x0B
304 #define CP210X_GET_EVENTMASK 0x0C
305 #define CP210X_SET_CHAR 0x0D
306 #define CP210X_GET_CHARS 0x0E
307 #define CP210X_GET_PROPS 0x0F
308 #define CP210X_GET_COMM_STATUS 0x10
309 #define CP210X_RESET 0x11
310 #define CP210X_PURGE 0x12
311 #define CP210X_SET_FLOW 0x13
312 #define CP210X_GET_FLOW 0x14
313 #define CP210X_EMBED_EVENTS 0x15
314 #define CP210X_GET_EVENTSTATE 0x16
315 #define CP210X_SET_CHARS 0x19
316 #define CP210X_GET_BAUDRATE 0x1D
317 #define CP210X_SET_BAUDRATE 0x1E
318 #define CP210X_VENDOR_SPECIFIC 0xFF
320 /* CP210X_IFC_ENABLE */
321 #define UART_ENABLE 0x0001
322 #define UART_DISABLE 0x0000
324 /* CP210X_(SET|GET)_BAUDDIV */
325 #define BAUD_RATE_GEN_FREQ 0x384000
327 /* CP210X_(SET|GET)_LINE_CTL */
328 #define BITS_DATA_MASK 0X0f00
329 #define BITS_DATA_5 0X0500
330 #define BITS_DATA_6 0X0600
331 #define BITS_DATA_7 0X0700
332 #define BITS_DATA_8 0X0800
333 #define BITS_DATA_9 0X0900
335 #define BITS_PARITY_MASK 0x00f0
336 #define BITS_PARITY_NONE 0x0000
337 #define BITS_PARITY_ODD 0x0010
338 #define BITS_PARITY_EVEN 0x0020
339 #define BITS_PARITY_MARK 0x0030
340 #define BITS_PARITY_SPACE 0x0040
342 #define BITS_STOP_MASK 0x000f
343 #define BITS_STOP_1 0x0000
344 #define BITS_STOP_1_5 0x0001
345 #define BITS_STOP_2 0x0002
347 /* CP210X_SET_BREAK */
348 #define BREAK_ON 0x0001
349 #define BREAK_OFF 0x0000
351 /* CP210X_(SET_MHS|GET_MDMSTS) */
352 #define CONTROL_DTR 0x0001
353 #define CONTROL_RTS 0x0002
354 #define CONTROL_CTS 0x0010
355 #define CONTROL_DSR 0x0020
356 #define CONTROL_RING 0x0040
357 #define CONTROL_DCD 0x0080
358 #define CONTROL_WRITE_DTR 0x0100
359 #define CONTROL_WRITE_RTS 0x0200
361 /* CP210X_VENDOR_SPECIFIC values */
362 #define CP210X_READ_2NCONFIG 0x000E
363 #define CP210X_READ_LATCH 0x00C2
364 #define CP210X_GET_PARTNUM 0x370B
365 #define CP210X_GET_PORTCONFIG 0x370C
366 #define CP210X_GET_DEVICEMODE 0x3711
367 #define CP210X_WRITE_LATCH 0x37E1
369 /* Part number definitions */
370 #define CP210X_PARTNUM_CP2101 0x01
371 #define CP210X_PARTNUM_CP2102 0x02
372 #define CP210X_PARTNUM_CP2103 0x03
373 #define CP210X_PARTNUM_CP2104 0x04
374 #define CP210X_PARTNUM_CP2105 0x05
375 #define CP210X_PARTNUM_CP2108 0x08
376 #define CP210X_PARTNUM_CP2102N_QFN28 0x20
377 #define CP210X_PARTNUM_CP2102N_QFN24 0x21
378 #define CP210X_PARTNUM_CP2102N_QFN20 0x22
379 #define CP210X_PARTNUM_UNKNOWN 0xFF
381 /* CP210X_GET_COMM_STATUS returns these 0x13 bytes */
382 struct cp210x_comm_status
{
384 __le32 ulHoldReasons
;
385 __le32 ulAmountInInQueue
;
386 __le32 ulAmountInOutQueue
;
388 u8 bWaitForImmediate
;
393 * CP210X_PURGE - 16 bits passed in wValue of USB request.
394 * SiLabs app note AN571 gives a strange description of the 4 bits:
395 * bit 0 or bit 2 clears the transmit queue and 1 or 3 receive.
396 * writing 1 to all, however, purges cp2108 well enough to avoid the hang.
398 #define PURGE_ALL 0x000f
400 /* CP210X_GET_FLOW/CP210X_SET_FLOW read/write these 0x10 bytes */
401 struct cp210x_flow_ctl
{
402 __le32 ulControlHandshake
;
403 __le32 ulFlowReplace
;
408 /* cp210x_flow_ctl::ulControlHandshake */
409 #define CP210X_SERIAL_DTR_MASK GENMASK(1, 0)
410 #define CP210X_SERIAL_DTR_SHIFT(_mode) (_mode)
411 #define CP210X_SERIAL_CTS_HANDSHAKE BIT(3)
412 #define CP210X_SERIAL_DSR_HANDSHAKE BIT(4)
413 #define CP210X_SERIAL_DCD_HANDSHAKE BIT(5)
414 #define CP210X_SERIAL_DSR_SENSITIVITY BIT(6)
416 /* values for cp210x_flow_ctl::ulControlHandshake::CP210X_SERIAL_DTR_MASK */
417 #define CP210X_SERIAL_DTR_INACTIVE 0
418 #define CP210X_SERIAL_DTR_ACTIVE 1
419 #define CP210X_SERIAL_DTR_FLOW_CTL 2
421 /* cp210x_flow_ctl::ulFlowReplace */
422 #define CP210X_SERIAL_AUTO_TRANSMIT BIT(0)
423 #define CP210X_SERIAL_AUTO_RECEIVE BIT(1)
424 #define CP210X_SERIAL_ERROR_CHAR BIT(2)
425 #define CP210X_SERIAL_NULL_STRIPPING BIT(3)
426 #define CP210X_SERIAL_BREAK_CHAR BIT(4)
427 #define CP210X_SERIAL_RTS_MASK GENMASK(7, 6)
428 #define CP210X_SERIAL_RTS_SHIFT(_mode) (_mode << 6)
429 #define CP210X_SERIAL_XOFF_CONTINUE BIT(31)
431 /* values for cp210x_flow_ctl::ulFlowReplace::CP210X_SERIAL_RTS_MASK */
432 #define CP210X_SERIAL_RTS_INACTIVE 0
433 #define CP210X_SERIAL_RTS_ACTIVE 1
434 #define CP210X_SERIAL_RTS_FLOW_CTL 2
436 /* CP210X_VENDOR_SPECIFIC, CP210X_GET_DEVICEMODE call reads these 0x2 bytes. */
437 struct cp210x_pin_mode
{
442 #define CP210X_PIN_MODE_MODEM 0
443 #define CP210X_PIN_MODE_GPIO BIT(0)
446 * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xf bytes.
447 * Structure needs padding due to unused/unspecified bytes.
449 struct cp210x_config
{
454 __le16 suspend_state
;
461 #define CP210X_SCI_GPIO_MODE_OFFSET 9
462 #define CP210X_SCI_GPIO_MODE_MASK GENMASK(11, 9)
464 #define CP210X_ECI_GPIO_MODE_OFFSET 2
465 #define CP210X_ECI_GPIO_MODE_MASK GENMASK(3, 2)
467 /* CP2105 port configuration values */
468 #define CP2105_GPIO0_TXLED_MODE BIT(0)
469 #define CP2105_GPIO1_RXLED_MODE BIT(1)
470 #define CP2105_GPIO1_RS485_MODE BIT(2)
472 /* CP2102N configuration array indices */
473 #define CP210X_2NCONFIG_CONFIG_VERSION_IDX 2
474 #define CP210X_2NCONFIG_GPIO_MODE_IDX 581
475 #define CP210X_2NCONFIG_GPIO_RSTLATCH_IDX 587
476 #define CP210X_2NCONFIG_GPIO_CONTROL_IDX 600
478 /* CP210X_VENDOR_SPECIFIC, CP210X_WRITE_LATCH call writes these 0x2 bytes. */
479 struct cp210x_gpio_write
{
485 * Helper to get interface number when we only have struct usb_serial.
487 static u8
cp210x_interface_num(struct usb_serial
*serial
)
489 struct usb_host_interface
*cur_altsetting
;
491 cur_altsetting
= serial
->interface
->cur_altsetting
;
493 return cur_altsetting
->desc
.bInterfaceNumber
;
497 * Reads a variable-sized block of CP210X_ registers, identified by req.
498 * Returns data into buf in native USB byte order.
500 static int cp210x_read_reg_block(struct usb_serial_port
*port
, u8 req
,
501 void *buf
, int bufsize
)
503 struct usb_serial
*serial
= port
->serial
;
504 struct cp210x_port_private
*port_priv
= usb_get_serial_port_data(port
);
508 dmabuf
= kmalloc(bufsize
, GFP_KERNEL
);
511 * FIXME Some callers don't bother to check for error,
512 * at least give them consistent junk until they are fixed
514 memset(buf
, 0, bufsize
);
518 result
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
519 req
, REQTYPE_INTERFACE_TO_HOST
, 0,
520 port_priv
->bInterfaceNumber
, dmabuf
, bufsize
,
521 USB_CTRL_SET_TIMEOUT
);
522 if (result
== bufsize
) {
523 memcpy(buf
, dmabuf
, bufsize
);
526 dev_err(&port
->dev
, "failed get req 0x%x size %d status: %d\n",
527 req
, bufsize
, result
);
532 * FIXME Some callers don't bother to check for error,
533 * at least give them consistent junk until they are fixed
535 memset(buf
, 0, bufsize
);
544 * Reads any 32-bit CP210X_ register identified by req.
546 static int cp210x_read_u32_reg(struct usb_serial_port
*port
, u8 req
, u32
*val
)
551 err
= cp210x_read_reg_block(port
, req
, &le32_val
, sizeof(le32_val
));
554 * FIXME Some callers don't bother to check for error,
555 * at least give them consistent junk until they are fixed
561 *val
= le32_to_cpu(le32_val
);
567 * Reads any 16-bit CP210X_ register identified by req.
569 static int cp210x_read_u16_reg(struct usb_serial_port
*port
, u8 req
, u16
*val
)
574 err
= cp210x_read_reg_block(port
, req
, &le16_val
, sizeof(le16_val
));
578 *val
= le16_to_cpu(le16_val
);
584 * Reads any 8-bit CP210X_ register identified by req.
586 static int cp210x_read_u8_reg(struct usb_serial_port
*port
, u8 req
, u8
*val
)
588 return cp210x_read_reg_block(port
, req
, val
, sizeof(*val
));
592 * Reads a variable-sized vendor block of CP210X_ registers, identified by val.
593 * Returns data into buf in native USB byte order.
595 static int cp210x_read_vendor_block(struct usb_serial
*serial
, u8 type
, u16 val
,
596 void *buf
, int bufsize
)
601 dmabuf
= kmalloc(bufsize
, GFP_KERNEL
);
605 result
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
606 CP210X_VENDOR_SPECIFIC
, type
, val
,
607 cp210x_interface_num(serial
), dmabuf
, bufsize
,
608 USB_CTRL_GET_TIMEOUT
);
609 if (result
== bufsize
) {
610 memcpy(buf
, dmabuf
, bufsize
);
613 dev_err(&serial
->interface
->dev
,
614 "failed to get vendor val 0x%04x size %d: %d\n", val
,
626 * Writes any 16-bit CP210X_ register (req) whose value is passed
627 * entirely in the wValue field of the USB request.
629 static int cp210x_write_u16_reg(struct usb_serial_port
*port
, u8 req
, u16 val
)
631 struct usb_serial
*serial
= port
->serial
;
632 struct cp210x_port_private
*port_priv
= usb_get_serial_port_data(port
);
635 result
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
636 req
, REQTYPE_HOST_TO_INTERFACE
, val
,
637 port_priv
->bInterfaceNumber
, NULL
, 0,
638 USB_CTRL_SET_TIMEOUT
);
640 dev_err(&port
->dev
, "failed set request 0x%x status: %d\n",
648 * Writes a variable-sized block of CP210X_ registers, identified by req.
649 * Data in buf must be in native USB byte order.
651 static int cp210x_write_reg_block(struct usb_serial_port
*port
, u8 req
,
652 void *buf
, int bufsize
)
654 struct usb_serial
*serial
= port
->serial
;
655 struct cp210x_port_private
*port_priv
= usb_get_serial_port_data(port
);
659 dmabuf
= kmemdup(buf
, bufsize
, GFP_KERNEL
);
663 result
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
664 req
, REQTYPE_HOST_TO_INTERFACE
, 0,
665 port_priv
->bInterfaceNumber
, dmabuf
, bufsize
,
666 USB_CTRL_SET_TIMEOUT
);
670 if (result
== bufsize
) {
673 dev_err(&port
->dev
, "failed set req 0x%x size %d status: %d\n",
674 req
, bufsize
, result
);
683 * Writes any 32-bit CP210X_ register identified by req.
685 static int cp210x_write_u32_reg(struct usb_serial_port
*port
, u8 req
, u32 val
)
689 le32_val
= cpu_to_le32(val
);
691 return cp210x_write_reg_block(port
, req
, &le32_val
, sizeof(le32_val
));
694 #ifdef CONFIG_GPIOLIB
696 * Writes a variable-sized vendor block of CP210X_ registers, identified by val.
697 * Data in buf must be in native USB byte order.
699 static int cp210x_write_vendor_block(struct usb_serial
*serial
, u8 type
,
700 u16 val
, void *buf
, int bufsize
)
705 dmabuf
= kmemdup(buf
, bufsize
, GFP_KERNEL
);
709 result
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
710 CP210X_VENDOR_SPECIFIC
, type
, val
,
711 cp210x_interface_num(serial
), dmabuf
, bufsize
,
712 USB_CTRL_SET_TIMEOUT
);
716 if (result
== bufsize
) {
719 dev_err(&serial
->interface
->dev
,
720 "failed to set vendor val 0x%04x size %d: %d\n", val
,
731 * Detect CP2108 GET_LINE_CTL bug and activate workaround.
732 * Write a known good value 0x800, read it back.
733 * If it comes back swapped the bug is detected.
734 * Preserve the original register value.
736 static int cp210x_detect_swapped_line_ctl(struct usb_serial_port
*port
)
738 struct cp210x_port_private
*port_priv
= usb_get_serial_port_data(port
);
743 err
= cp210x_read_u16_reg(port
, CP210X_GET_LINE_CTL
, &line_ctl_save
);
747 err
= cp210x_write_u16_reg(port
, CP210X_SET_LINE_CTL
, 0x800);
751 err
= cp210x_read_u16_reg(port
, CP210X_GET_LINE_CTL
, &line_ctl_test
);
755 if (line_ctl_test
== 8) {
756 port_priv
->has_swapped_line_ctl
= true;
757 line_ctl_save
= swab16(line_ctl_save
);
760 return cp210x_write_u16_reg(port
, CP210X_SET_LINE_CTL
, line_ctl_save
);
764 * Must always be called instead of cp210x_read_u16_reg(CP210X_GET_LINE_CTL)
765 * to workaround cp2108 bug and get correct value.
767 static int cp210x_get_line_ctl(struct usb_serial_port
*port
, u16
*ctl
)
769 struct cp210x_port_private
*port_priv
= usb_get_serial_port_data(port
);
772 err
= cp210x_read_u16_reg(port
, CP210X_GET_LINE_CTL
, ctl
);
776 /* Workaround swapped bytes in 16-bit value from CP210X_GET_LINE_CTL */
777 if (port_priv
->has_swapped_line_ctl
)
783 static int cp210x_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
787 result
= cp210x_write_u16_reg(port
, CP210X_IFC_ENABLE
, UART_ENABLE
);
789 dev_err(&port
->dev
, "%s - Unable to enable UART\n", __func__
);
793 /* Configure the termios structure */
794 cp210x_get_termios(tty
, port
);
796 /* The baud rate must be initialised on cp2104 */
798 cp210x_change_speed(tty
, port
, NULL
);
800 return usb_serial_generic_open(tty
, port
);
803 static void cp210x_close(struct usb_serial_port
*port
)
805 usb_serial_generic_close(port
);
807 /* Clear both queues; cp2108 needs this to avoid an occasional hang */
808 cp210x_write_u16_reg(port
, CP210X_PURGE
, PURGE_ALL
);
810 cp210x_write_u16_reg(port
, CP210X_IFC_ENABLE
, UART_DISABLE
);
814 * Read how many bytes are waiting in the TX queue.
816 static int cp210x_get_tx_queue_byte_count(struct usb_serial_port
*port
,
819 struct usb_serial
*serial
= port
->serial
;
820 struct cp210x_port_private
*port_priv
= usb_get_serial_port_data(port
);
821 struct cp210x_comm_status
*sts
;
824 sts
= kmalloc(sizeof(*sts
), GFP_KERNEL
);
828 result
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
829 CP210X_GET_COMM_STATUS
, REQTYPE_INTERFACE_TO_HOST
,
830 0, port_priv
->bInterfaceNumber
, sts
, sizeof(*sts
),
831 USB_CTRL_GET_TIMEOUT
);
832 if (result
== sizeof(*sts
)) {
833 *count
= le32_to_cpu(sts
->ulAmountInOutQueue
);
836 dev_err(&port
->dev
, "failed to get comm status: %d\n", result
);
846 static bool cp210x_tx_empty(struct usb_serial_port
*port
)
851 err
= cp210x_get_tx_queue_byte_count(port
, &count
);
860 * Reads the baud rate, data bits, parity, stop bits and flow control mode
861 * from the device, corrects any unsupported values, and configures the
862 * termios structure to reflect the state of the device
864 static void cp210x_get_termios(struct tty_struct
*tty
,
865 struct usb_serial_port
*port
)
870 cp210x_get_termios_port(tty
->driver_data
,
871 &tty
->termios
.c_cflag
, &baud
);
872 tty_encode_baud_rate(tty
, baud
, baud
);
876 cp210x_get_termios_port(port
, &cflag
, &baud
);
881 * cp210x_get_termios_port
882 * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
884 static void cp210x_get_termios_port(struct usb_serial_port
*port
,
885 tcflag_t
*cflagp
, unsigned int *baudp
)
887 struct device
*dev
= &port
->dev
;
889 struct cp210x_flow_ctl flow_ctl
;
894 cp210x_read_u32_reg(port
, CP210X_GET_BAUDRATE
, &baud
);
896 dev_dbg(dev
, "%s - baud rate = %d\n", __func__
, baud
);
901 cp210x_get_line_ctl(port
, &bits
);
903 switch (bits
& BITS_DATA_MASK
) {
905 dev_dbg(dev
, "%s - data bits = 5\n", __func__
);
909 dev_dbg(dev
, "%s - data bits = 6\n", __func__
);
913 dev_dbg(dev
, "%s - data bits = 7\n", __func__
);
917 dev_dbg(dev
, "%s - data bits = 8\n", __func__
);
921 dev_dbg(dev
, "%s - data bits = 9 (not supported, using 8 data bits)\n", __func__
);
923 bits
&= ~BITS_DATA_MASK
;
925 cp210x_write_u16_reg(port
, CP210X_SET_LINE_CTL
, bits
);
928 dev_dbg(dev
, "%s - Unknown number of data bits, using 8\n", __func__
);
930 bits
&= ~BITS_DATA_MASK
;
932 cp210x_write_u16_reg(port
, CP210X_SET_LINE_CTL
, bits
);
936 switch (bits
& BITS_PARITY_MASK
) {
937 case BITS_PARITY_NONE
:
938 dev_dbg(dev
, "%s - parity = NONE\n", __func__
);
941 case BITS_PARITY_ODD
:
942 dev_dbg(dev
, "%s - parity = ODD\n", __func__
);
943 cflag
|= (PARENB
|PARODD
);
945 case BITS_PARITY_EVEN
:
946 dev_dbg(dev
, "%s - parity = EVEN\n", __func__
);
950 case BITS_PARITY_MARK
:
951 dev_dbg(dev
, "%s - parity = MARK\n", __func__
);
952 cflag
|= (PARENB
|PARODD
|CMSPAR
);
954 case BITS_PARITY_SPACE
:
955 dev_dbg(dev
, "%s - parity = SPACE\n", __func__
);
957 cflag
|= (PARENB
|CMSPAR
);
960 dev_dbg(dev
, "%s - Unknown parity mode, disabling parity\n", __func__
);
962 bits
&= ~BITS_PARITY_MASK
;
963 cp210x_write_u16_reg(port
, CP210X_SET_LINE_CTL
, bits
);
968 switch (bits
& BITS_STOP_MASK
) {
970 dev_dbg(dev
, "%s - stop bits = 1\n", __func__
);
973 dev_dbg(dev
, "%s - stop bits = 1.5 (not supported, using 1 stop bit)\n", __func__
);
974 bits
&= ~BITS_STOP_MASK
;
975 cp210x_write_u16_reg(port
, CP210X_SET_LINE_CTL
, bits
);
978 dev_dbg(dev
, "%s - stop bits = 2\n", __func__
);
982 dev_dbg(dev
, "%s - Unknown number of stop bits, using 1 stop bit\n", __func__
);
983 bits
&= ~BITS_STOP_MASK
;
984 cp210x_write_u16_reg(port
, CP210X_SET_LINE_CTL
, bits
);
988 cp210x_read_reg_block(port
, CP210X_GET_FLOW
, &flow_ctl
,
990 ctl_hs
= le32_to_cpu(flow_ctl
.ulControlHandshake
);
991 if (ctl_hs
& CP210X_SERIAL_CTS_HANDSHAKE
) {
992 dev_dbg(dev
, "%s - flow control = CRTSCTS\n", __func__
);
995 dev_dbg(dev
, "%s - flow control = NONE\n", __func__
);
1002 struct cp210x_rate
{
1007 static const struct cp210x_rate cp210x_an205_table1
[] = {
1036 { 921600, UINT_MAX
}
1040 * Quantises the baud rate as per AN205 Table 1
1042 static speed_t
cp210x_get_an205_rate(speed_t baud
)
1046 for (i
= 0; i
< ARRAY_SIZE(cp210x_an205_table1
); ++i
) {
1047 if (baud
<= cp210x_an205_table1
[i
].high
)
1051 return cp210x_an205_table1
[i
].rate
;
1054 static speed_t
cp210x_get_actual_rate(struct usb_serial
*serial
, speed_t baud
)
1056 struct cp210x_serial_private
*priv
= usb_get_serial_data(serial
);
1057 unsigned int prescale
= 1;
1060 baud
= clamp(baud
, 300u, priv
->max_speed
);
1065 div
= DIV_ROUND_CLOSEST(48000000, 2 * prescale
* baud
);
1066 baud
= 48000000 / (2 * prescale
* div
);
1072 * CP2101 supports the following baud rates:
1074 * 300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
1075 * 38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
1077 * CP2102 and CP2103 support the following additional rates:
1079 * 4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
1082 * The device will map a requested rate to a supported one, but the result
1083 * of requests for rates greater than 1053257 is undefined (see AN205).
1085 * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
1086 * respectively, with an error less than 1%. The actual rates are determined
1089 * div = round(freq / (2 x prescale x request))
1090 * actual = freq / (2 x prescale x div)
1092 * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
1094 * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
1097 static void cp210x_change_speed(struct tty_struct
*tty
,
1098 struct usb_serial_port
*port
, struct ktermios
*old_termios
)
1100 struct usb_serial
*serial
= port
->serial
;
1101 struct cp210x_serial_private
*priv
= usb_get_serial_data(serial
);
1104 baud
= tty
->termios
.c_ospeed
;
1107 * This maps the requested rate to the actual rate, a valid rate on
1108 * cp2102 or cp2103, or to an arbitrary rate in [1M, max_speed].
1110 * NOTE: B0 is not implemented.
1112 if (priv
->use_actual_rate
)
1113 baud
= cp210x_get_actual_rate(serial
, baud
);
1114 else if (baud
< 1000000)
1115 baud
= cp210x_get_an205_rate(baud
);
1116 else if (baud
> priv
->max_speed
)
1117 baud
= priv
->max_speed
;
1119 dev_dbg(&port
->dev
, "%s - setting baud rate to %u\n", __func__
, baud
);
1120 if (cp210x_write_u32_reg(port
, CP210X_SET_BAUDRATE
, baud
)) {
1121 dev_warn(&port
->dev
, "failed to set baud rate to %u\n", baud
);
1123 baud
= old_termios
->c_ospeed
;
1128 tty_encode_baud_rate(tty
, baud
, baud
);
1131 static void cp210x_set_termios(struct tty_struct
*tty
,
1132 struct usb_serial_port
*port
, struct ktermios
*old_termios
)
1134 struct device
*dev
= &port
->dev
;
1135 unsigned int cflag
, old_cflag
;
1138 cflag
= tty
->termios
.c_cflag
;
1139 old_cflag
= old_termios
->c_cflag
;
1141 if (tty
->termios
.c_ospeed
!= old_termios
->c_ospeed
)
1142 cp210x_change_speed(tty
, port
, old_termios
);
1144 /* If the number of data bits is to be updated */
1145 if ((cflag
& CSIZE
) != (old_cflag
& CSIZE
)) {
1146 cp210x_get_line_ctl(port
, &bits
);
1147 bits
&= ~BITS_DATA_MASK
;
1148 switch (cflag
& CSIZE
) {
1150 bits
|= BITS_DATA_5
;
1151 dev_dbg(dev
, "%s - data bits = 5\n", __func__
);
1154 bits
|= BITS_DATA_6
;
1155 dev_dbg(dev
, "%s - data bits = 6\n", __func__
);
1158 bits
|= BITS_DATA_7
;
1159 dev_dbg(dev
, "%s - data bits = 7\n", __func__
);
1163 bits
|= BITS_DATA_8
;
1164 dev_dbg(dev
, "%s - data bits = 8\n", __func__
);
1167 if (cp210x_write_u16_reg(port
, CP210X_SET_LINE_CTL
, bits
))
1168 dev_dbg(dev
, "Number of data bits requested not supported by device\n");
1171 if ((cflag
& (PARENB
|PARODD
|CMSPAR
)) !=
1172 (old_cflag
& (PARENB
|PARODD
|CMSPAR
))) {
1173 cp210x_get_line_ctl(port
, &bits
);
1174 bits
&= ~BITS_PARITY_MASK
;
1175 if (cflag
& PARENB
) {
1176 if (cflag
& CMSPAR
) {
1177 if (cflag
& PARODD
) {
1178 bits
|= BITS_PARITY_MARK
;
1179 dev_dbg(dev
, "%s - parity = MARK\n", __func__
);
1181 bits
|= BITS_PARITY_SPACE
;
1182 dev_dbg(dev
, "%s - parity = SPACE\n", __func__
);
1185 if (cflag
& PARODD
) {
1186 bits
|= BITS_PARITY_ODD
;
1187 dev_dbg(dev
, "%s - parity = ODD\n", __func__
);
1189 bits
|= BITS_PARITY_EVEN
;
1190 dev_dbg(dev
, "%s - parity = EVEN\n", __func__
);
1194 if (cp210x_write_u16_reg(port
, CP210X_SET_LINE_CTL
, bits
))
1195 dev_dbg(dev
, "Parity mode not supported by device\n");
1198 if ((cflag
& CSTOPB
) != (old_cflag
& CSTOPB
)) {
1199 cp210x_get_line_ctl(port
, &bits
);
1200 bits
&= ~BITS_STOP_MASK
;
1201 if (cflag
& CSTOPB
) {
1202 bits
|= BITS_STOP_2
;
1203 dev_dbg(dev
, "%s - stop bits = 2\n", __func__
);
1205 bits
|= BITS_STOP_1
;
1206 dev_dbg(dev
, "%s - stop bits = 1\n", __func__
);
1208 if (cp210x_write_u16_reg(port
, CP210X_SET_LINE_CTL
, bits
))
1209 dev_dbg(dev
, "Number of stop bits requested not supported by device\n");
1212 if ((cflag
& CRTSCTS
) != (old_cflag
& CRTSCTS
)) {
1213 struct cp210x_flow_ctl flow_ctl
;
1217 cp210x_read_reg_block(port
, CP210X_GET_FLOW
, &flow_ctl
,
1219 ctl_hs
= le32_to_cpu(flow_ctl
.ulControlHandshake
);
1220 flow_repl
= le32_to_cpu(flow_ctl
.ulFlowReplace
);
1221 dev_dbg(dev
, "%s - read ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1222 __func__
, ctl_hs
, flow_repl
);
1224 ctl_hs
&= ~CP210X_SERIAL_DSR_HANDSHAKE
;
1225 ctl_hs
&= ~CP210X_SERIAL_DCD_HANDSHAKE
;
1226 ctl_hs
&= ~CP210X_SERIAL_DSR_SENSITIVITY
;
1227 ctl_hs
&= ~CP210X_SERIAL_DTR_MASK
;
1228 ctl_hs
|= CP210X_SERIAL_DTR_SHIFT(CP210X_SERIAL_DTR_ACTIVE
);
1229 if (cflag
& CRTSCTS
) {
1230 ctl_hs
|= CP210X_SERIAL_CTS_HANDSHAKE
;
1232 flow_repl
&= ~CP210X_SERIAL_RTS_MASK
;
1233 flow_repl
|= CP210X_SERIAL_RTS_SHIFT(
1234 CP210X_SERIAL_RTS_FLOW_CTL
);
1235 dev_dbg(dev
, "%s - flow control = CRTSCTS\n", __func__
);
1237 ctl_hs
&= ~CP210X_SERIAL_CTS_HANDSHAKE
;
1239 flow_repl
&= ~CP210X_SERIAL_RTS_MASK
;
1240 flow_repl
|= CP210X_SERIAL_RTS_SHIFT(
1241 CP210X_SERIAL_RTS_ACTIVE
);
1242 dev_dbg(dev
, "%s - flow control = NONE\n", __func__
);
1245 dev_dbg(dev
, "%s - write ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1246 __func__
, ctl_hs
, flow_repl
);
1247 flow_ctl
.ulControlHandshake
= cpu_to_le32(ctl_hs
);
1248 flow_ctl
.ulFlowReplace
= cpu_to_le32(flow_repl
);
1249 cp210x_write_reg_block(port
, CP210X_SET_FLOW
, &flow_ctl
,
1255 static int cp210x_tiocmset(struct tty_struct
*tty
,
1256 unsigned int set
, unsigned int clear
)
1258 struct usb_serial_port
*port
= tty
->driver_data
;
1259 return cp210x_tiocmset_port(port
, set
, clear
);
1262 static int cp210x_tiocmset_port(struct usb_serial_port
*port
,
1263 unsigned int set
, unsigned int clear
)
1267 if (set
& TIOCM_RTS
) {
1268 control
|= CONTROL_RTS
;
1269 control
|= CONTROL_WRITE_RTS
;
1271 if (set
& TIOCM_DTR
) {
1272 control
|= CONTROL_DTR
;
1273 control
|= CONTROL_WRITE_DTR
;
1275 if (clear
& TIOCM_RTS
) {
1276 control
&= ~CONTROL_RTS
;
1277 control
|= CONTROL_WRITE_RTS
;
1279 if (clear
& TIOCM_DTR
) {
1280 control
&= ~CONTROL_DTR
;
1281 control
|= CONTROL_WRITE_DTR
;
1284 dev_dbg(&port
->dev
, "%s - control = 0x%.4x\n", __func__
, control
);
1286 return cp210x_write_u16_reg(port
, CP210X_SET_MHS
, control
);
1289 static void cp210x_dtr_rts(struct usb_serial_port
*p
, int on
)
1292 cp210x_tiocmset_port(p
, TIOCM_DTR
|TIOCM_RTS
, 0);
1294 cp210x_tiocmset_port(p
, 0, TIOCM_DTR
|TIOCM_RTS
);
1297 static int cp210x_tiocmget(struct tty_struct
*tty
)
1299 struct usb_serial_port
*port
= tty
->driver_data
;
1303 result
= cp210x_read_u8_reg(port
, CP210X_GET_MDMSTS
, &control
);
1307 result
= ((control
& CONTROL_DTR
) ? TIOCM_DTR
: 0)
1308 |((control
& CONTROL_RTS
) ? TIOCM_RTS
: 0)
1309 |((control
& CONTROL_CTS
) ? TIOCM_CTS
: 0)
1310 |((control
& CONTROL_DSR
) ? TIOCM_DSR
: 0)
1311 |((control
& CONTROL_RING
)? TIOCM_RI
: 0)
1312 |((control
& CONTROL_DCD
) ? TIOCM_CD
: 0);
1314 dev_dbg(&port
->dev
, "%s - control = 0x%.2x\n", __func__
, control
);
1319 static void cp210x_break_ctl(struct tty_struct
*tty
, int break_state
)
1321 struct usb_serial_port
*port
= tty
->driver_data
;
1324 if (break_state
== 0)
1328 dev_dbg(&port
->dev
, "%s - turning break %s\n", __func__
,
1329 state
== BREAK_OFF
? "off" : "on");
1330 cp210x_write_u16_reg(port
, CP210X_SET_BREAK
, state
);
1333 #ifdef CONFIG_GPIOLIB
1334 static int cp210x_gpio_request(struct gpio_chip
*gc
, unsigned int offset
)
1336 struct usb_serial
*serial
= gpiochip_get_data(gc
);
1337 struct cp210x_serial_private
*priv
= usb_get_serial_data(serial
);
1339 if (priv
->gpio_altfunc
& BIT(offset
))
1345 static int cp210x_gpio_get(struct gpio_chip
*gc
, unsigned int gpio
)
1347 struct usb_serial
*serial
= gpiochip_get_data(gc
);
1348 struct cp210x_serial_private
*priv
= usb_get_serial_data(serial
);
1349 u8 req_type
= REQTYPE_DEVICE_TO_HOST
;
1353 if (priv
->partnum
== CP210X_PARTNUM_CP2105
)
1354 req_type
= REQTYPE_INTERFACE_TO_HOST
;
1356 result
= cp210x_read_vendor_block(serial
, req_type
,
1357 CP210X_READ_LATCH
, &buf
, sizeof(buf
));
1361 return !!(buf
& BIT(gpio
));
1364 static void cp210x_gpio_set(struct gpio_chip
*gc
, unsigned int gpio
, int value
)
1366 struct usb_serial
*serial
= gpiochip_get_data(gc
);
1367 struct cp210x_serial_private
*priv
= usb_get_serial_data(serial
);
1368 struct cp210x_gpio_write buf
;
1372 buf
.state
= BIT(gpio
);
1376 buf
.mask
= BIT(gpio
);
1378 if (priv
->partnum
== CP210X_PARTNUM_CP2105
) {
1379 result
= cp210x_write_vendor_block(serial
,
1380 REQTYPE_HOST_TO_INTERFACE
,
1381 CP210X_WRITE_LATCH
, &buf
,
1384 u16 wIndex
= buf
.state
<< 8 | buf
.mask
;
1386 result
= usb_control_msg(serial
->dev
,
1387 usb_sndctrlpipe(serial
->dev
, 0),
1388 CP210X_VENDOR_SPECIFIC
,
1389 REQTYPE_HOST_TO_DEVICE
,
1392 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
1396 dev_err(&serial
->interface
->dev
, "failed to set GPIO value: %d\n",
1401 static int cp210x_gpio_direction_get(struct gpio_chip
*gc
, unsigned int gpio
)
1403 struct usb_serial
*serial
= gpiochip_get_data(gc
);
1404 struct cp210x_serial_private
*priv
= usb_get_serial_data(serial
);
1406 return priv
->gpio_input
& BIT(gpio
);
1409 static int cp210x_gpio_direction_input(struct gpio_chip
*gc
, unsigned int gpio
)
1411 struct usb_serial
*serial
= gpiochip_get_data(gc
);
1412 struct cp210x_serial_private
*priv
= usb_get_serial_data(serial
);
1414 if (priv
->partnum
== CP210X_PARTNUM_CP2105
) {
1415 /* hardware does not support an input mode */
1419 /* push-pull pins cannot be changed to be inputs */
1420 if (priv
->gpio_pushpull
& BIT(gpio
))
1423 /* make sure to release pin if it is being driven low */
1424 cp210x_gpio_set(gc
, gpio
, 1);
1426 priv
->gpio_input
|= BIT(gpio
);
1431 static int cp210x_gpio_direction_output(struct gpio_chip
*gc
, unsigned int gpio
,
1434 struct usb_serial
*serial
= gpiochip_get_data(gc
);
1435 struct cp210x_serial_private
*priv
= usb_get_serial_data(serial
);
1437 priv
->gpio_input
&= ~BIT(gpio
);
1438 cp210x_gpio_set(gc
, gpio
, value
);
1443 static int cp210x_gpio_set_config(struct gpio_chip
*gc
, unsigned int gpio
,
1444 unsigned long config
)
1446 struct usb_serial
*serial
= gpiochip_get_data(gc
);
1447 struct cp210x_serial_private
*priv
= usb_get_serial_data(serial
);
1448 enum pin_config_param param
= pinconf_to_config_param(config
);
1450 /* Succeed only if in correct mode (this can't be set at runtime) */
1451 if ((param
== PIN_CONFIG_DRIVE_PUSH_PULL
) &&
1452 (priv
->gpio_pushpull
& BIT(gpio
)))
1455 if ((param
== PIN_CONFIG_DRIVE_OPEN_DRAIN
) &&
1456 !(priv
->gpio_pushpull
& BIT(gpio
)))
1463 * This function is for configuring GPIO using shared pins, where other signals
1464 * are made unavailable by configuring the use of GPIO. This is believed to be
1465 * only applicable to the cp2105 at this point, the other devices supported by
1466 * this driver that provide GPIO do so in a way that does not impact other
1467 * signals and are thus expected to have very different initialisation.
1469 static int cp2105_gpioconf_init(struct usb_serial
*serial
)
1471 struct cp210x_serial_private
*priv
= usb_get_serial_data(serial
);
1472 struct cp210x_pin_mode mode
;
1473 struct cp210x_config config
;
1474 u8 intf_num
= cp210x_interface_num(serial
);
1478 result
= cp210x_read_vendor_block(serial
, REQTYPE_DEVICE_TO_HOST
,
1479 CP210X_GET_DEVICEMODE
, &mode
,
1484 result
= cp210x_read_vendor_block(serial
, REQTYPE_DEVICE_TO_HOST
,
1485 CP210X_GET_PORTCONFIG
, &config
,
1490 /* 2 banks of GPIO - One for the pins taken from each serial port */
1491 if (intf_num
== 0) {
1492 if (mode
.eci
== CP210X_PIN_MODE_MODEM
) {
1493 /* mark all GPIOs of this interface as reserved */
1494 priv
->gpio_altfunc
= 0xff;
1498 iface_config
= config
.eci_cfg
;
1499 priv
->gpio_pushpull
= (u8
)((le16_to_cpu(config
.gpio_mode
) &
1500 CP210X_ECI_GPIO_MODE_MASK
) >>
1501 CP210X_ECI_GPIO_MODE_OFFSET
);
1503 } else if (intf_num
== 1) {
1504 if (mode
.sci
== CP210X_PIN_MODE_MODEM
) {
1505 /* mark all GPIOs of this interface as reserved */
1506 priv
->gpio_altfunc
= 0xff;
1510 iface_config
= config
.sci_cfg
;
1511 priv
->gpio_pushpull
= (u8
)((le16_to_cpu(config
.gpio_mode
) &
1512 CP210X_SCI_GPIO_MODE_MASK
) >>
1513 CP210X_SCI_GPIO_MODE_OFFSET
);
1519 /* mark all pins which are not in GPIO mode */
1520 if (iface_config
& CP2105_GPIO0_TXLED_MODE
) /* GPIO 0 */
1521 priv
->gpio_altfunc
|= BIT(0);
1522 if (iface_config
& (CP2105_GPIO1_RXLED_MODE
| /* GPIO 1 */
1523 CP2105_GPIO1_RS485_MODE
))
1524 priv
->gpio_altfunc
|= BIT(1);
1526 /* driver implementation for CP2105 only supports outputs */
1527 priv
->gpio_input
= 0;
1532 static int cp2102n_gpioconf_init(struct usb_serial
*serial
)
1534 struct cp210x_serial_private
*priv
= usb_get_serial_data(serial
);
1535 const u16 config_size
= 0x02a6;
1546 * Retrieve device configuration from the device.
1547 * The array received contains all customization settings done at the
1548 * factory/manufacturer. Format of the array is documented at the
1549 * time of writing at:
1550 * https://www.silabs.com/community/interface/knowledge-base.entry.html/2017/03/31/cp2102n_setconfig-xsfa
1552 config_buf
= kmalloc(config_size
, GFP_KERNEL
);
1556 result
= cp210x_read_vendor_block(serial
,
1557 REQTYPE_DEVICE_TO_HOST
,
1558 CP210X_READ_2NCONFIG
,
1566 config_version
= config_buf
[CP210X_2NCONFIG_CONFIG_VERSION_IDX
];
1567 gpio_pushpull
= config_buf
[CP210X_2NCONFIG_GPIO_MODE_IDX
];
1568 gpio_ctrl
= config_buf
[CP210X_2NCONFIG_GPIO_CONTROL_IDX
];
1569 gpio_rst_latch
= config_buf
[CP210X_2NCONFIG_GPIO_RSTLATCH_IDX
];
1573 /* Make sure this is a config format we understand. */
1574 if (config_version
!= 0x01)
1578 * We only support 4 GPIOs even on the QFN28 package, because
1579 * config locations of GPIOs 4-6 determined using reverse
1580 * engineering revealed conflicting offsets with other
1581 * documented functions. So we'll just play it safe for now.
1586 * Get default pin states after reset. Needed so we can determine
1587 * the direction of an open-drain pin.
1589 gpio_latch
= (gpio_rst_latch
>> 3) & 0x0f;
1591 /* 0 indicates open-drain mode, 1 is push-pull */
1592 priv
->gpio_pushpull
= (gpio_pushpull
>> 3) & 0x0f;
1594 /* 0 indicates GPIO mode, 1 is alternate function */
1595 priv
->gpio_altfunc
= (gpio_ctrl
>> 2) & 0x0f;
1598 * The CP2102N does not strictly has input and output pin modes,
1599 * it only knows open-drain and push-pull modes which is set at
1600 * factory. An open-drain pin can function both as an
1601 * input or an output. We emulate input mode for open-drain pins
1602 * by making sure they are not driven low, and we do not allow
1603 * push-pull pins to be set as an input.
1605 for (i
= 0; i
< priv
->gc
.ngpio
; ++i
) {
1607 * Set direction to "input" iff pin is open-drain and reset
1610 if (!(priv
->gpio_pushpull
& BIT(i
)) && (gpio_latch
& BIT(i
)))
1611 priv
->gpio_input
|= BIT(i
);
1617 static int cp210x_gpio_init(struct usb_serial
*serial
)
1619 struct cp210x_serial_private
*priv
= usb_get_serial_data(serial
);
1622 switch (priv
->partnum
) {
1623 case CP210X_PARTNUM_CP2105
:
1624 result
= cp2105_gpioconf_init(serial
);
1626 case CP210X_PARTNUM_CP2102N_QFN28
:
1627 case CP210X_PARTNUM_CP2102N_QFN24
:
1628 case CP210X_PARTNUM_CP2102N_QFN20
:
1629 result
= cp2102n_gpioconf_init(serial
);
1638 priv
->gc
.label
= "cp210x";
1639 priv
->gc
.request
= cp210x_gpio_request
;
1640 priv
->gc
.get_direction
= cp210x_gpio_direction_get
;
1641 priv
->gc
.direction_input
= cp210x_gpio_direction_input
;
1642 priv
->gc
.direction_output
= cp210x_gpio_direction_output
;
1643 priv
->gc
.get
= cp210x_gpio_get
;
1644 priv
->gc
.set
= cp210x_gpio_set
;
1645 priv
->gc
.set_config
= cp210x_gpio_set_config
;
1646 priv
->gc
.owner
= THIS_MODULE
;
1647 priv
->gc
.parent
= &serial
->interface
->dev
;
1649 priv
->gc
.can_sleep
= true;
1651 result
= gpiochip_add_data(&priv
->gc
, serial
);
1653 priv
->gpio_registered
= true;
1658 static void cp210x_gpio_remove(struct usb_serial
*serial
)
1660 struct cp210x_serial_private
*priv
= usb_get_serial_data(serial
);
1662 if (priv
->gpio_registered
) {
1663 gpiochip_remove(&priv
->gc
);
1664 priv
->gpio_registered
= false;
1670 static int cp210x_gpio_init(struct usb_serial
*serial
)
1675 static void cp210x_gpio_remove(struct usb_serial
*serial
)
1682 static int cp210x_port_probe(struct usb_serial_port
*port
)
1684 struct usb_serial
*serial
= port
->serial
;
1685 struct cp210x_port_private
*port_priv
;
1688 port_priv
= kzalloc(sizeof(*port_priv
), GFP_KERNEL
);
1692 port_priv
->bInterfaceNumber
= cp210x_interface_num(serial
);
1694 usb_set_serial_port_data(port
, port_priv
);
1696 ret
= cp210x_detect_swapped_line_ctl(port
);
1705 static int cp210x_port_remove(struct usb_serial_port
*port
)
1707 struct cp210x_port_private
*port_priv
;
1709 port_priv
= usb_get_serial_port_data(port
);
1715 static void cp210x_init_max_speed(struct usb_serial
*serial
)
1717 struct cp210x_serial_private
*priv
= usb_get_serial_data(serial
);
1718 bool use_actual_rate
= false;
1721 switch (priv
->partnum
) {
1722 case CP210X_PARTNUM_CP2101
:
1725 case CP210X_PARTNUM_CP2102
:
1726 case CP210X_PARTNUM_CP2103
:
1729 case CP210X_PARTNUM_CP2104
:
1730 use_actual_rate
= true;
1733 case CP210X_PARTNUM_CP2108
:
1736 case CP210X_PARTNUM_CP2105
:
1737 if (cp210x_interface_num(serial
) == 0) {
1738 use_actual_rate
= true;
1739 max
= 2000000; /* ECI */
1741 max
= 921600; /* SCI */
1744 case CP210X_PARTNUM_CP2102N_QFN28
:
1745 case CP210X_PARTNUM_CP2102N_QFN24
:
1746 case CP210X_PARTNUM_CP2102N_QFN20
:
1747 use_actual_rate
= true;
1755 priv
->max_speed
= max
;
1756 priv
->use_actual_rate
= use_actual_rate
;
1759 static int cp210x_attach(struct usb_serial
*serial
)
1762 struct cp210x_serial_private
*priv
;
1764 priv
= kzalloc(sizeof(*priv
), GFP_KERNEL
);
1768 result
= cp210x_read_vendor_block(serial
, REQTYPE_DEVICE_TO_HOST
,
1769 CP210X_GET_PARTNUM
, &priv
->partnum
,
1770 sizeof(priv
->partnum
));
1772 dev_warn(&serial
->interface
->dev
,
1773 "querying part number failed\n");
1774 priv
->partnum
= CP210X_PARTNUM_UNKNOWN
;
1777 usb_set_serial_data(serial
, priv
);
1779 cp210x_init_max_speed(serial
);
1781 result
= cp210x_gpio_init(serial
);
1783 dev_err(&serial
->interface
->dev
, "GPIO initialisation failed: %d\n",
1790 static void cp210x_disconnect(struct usb_serial
*serial
)
1792 cp210x_gpio_remove(serial
);
1795 static void cp210x_release(struct usb_serial
*serial
)
1797 struct cp210x_serial_private
*priv
= usb_get_serial_data(serial
);
1799 cp210x_gpio_remove(serial
);
1804 module_usb_serial_driver(serial_drivers
, id_table
);
1806 MODULE_DESCRIPTION(DRIVER_DESC
);
1807 MODULE_LICENSE("GPL v2");