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, 0x818B) }, /* AVIT Research USB to TTL */
99 { USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
100 { USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
101 { USB_DEVICE(0x10C4, 0x81A9) }, /* Multiplex RC Interface */
102 { USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
103 { USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */
104 { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
105 { USB_DEVICE(0x10C4, 0x81D7) }, /* IAI Corp. RCB-CV-USB USB to RS485 Adaptor */
106 { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
107 { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
108 { USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
109 { USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
110 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
111 { USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
112 { USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
113 { USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */
114 { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
115 { USB_DEVICE(0x10C4, 0x82F4) }, /* Starizona MicroTouch */
116 { USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
117 { USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
118 { USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
119 { USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
120 { USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
121 { USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
122 { USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
123 { USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
124 { USB_DEVICE(0x10C4, 0x8470) }, /* Juniper Networks BX Series System Console */
125 { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
126 { USB_DEVICE(0x10C4, 0x84B6) }, /* Starizona Hyperion */
127 { USB_DEVICE(0x10C4, 0x85A7) }, /* LifeScan OneTouch Verio IQ */
128 { USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
129 { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
130 { USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
131 { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
132 { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
133 { USB_DEVICE(0x10C4, 0x8856) }, /* CEL EM357 ZigBee USB Stick - LR */
134 { USB_DEVICE(0x10C4, 0x8857) }, /* CEL EM357 ZigBee USB Stick */
135 { USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
136 { USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
137 { USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
138 { USB_DEVICE(0x10C4, 0x8962) }, /* Brim Brothers charging dock */
139 { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit Device */
140 { USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
141 { USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
142 { USB_DEVICE(0x10C4, 0x8A5E) }, /* CEL EM3588 ZigBee USB Stick Long Range */
143 { USB_DEVICE(0x10C4, 0x8B34) }, /* Qivicon ZigBee USB Radio Stick */
144 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
145 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
146 { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
147 { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
148 { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
149 { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
150 { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
151 { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
152 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
153 { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
154 { USB_DEVICE(0x12B8, 0xEC60) }, /* Link G4 ECU */
155 { USB_DEVICE(0x12B8, 0xEC62) }, /* Link G4+ ECU */
156 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
157 { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
158 { USB_DEVICE(0x155A, 0x1006) }, /* ELDAT Easywave RX09 */
159 { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
160 { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
161 { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
162 { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
163 { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
164 { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
165 { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
166 { USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
167 { USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
168 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
169 { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
170 { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
171 { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
172 { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
173 { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
174 { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
175 { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
176 { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
177 { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
178 { USB_DEVICE(0x18EF, 0xE025) }, /* ELV Marble Sound Board 1 */
179 { USB_DEVICE(0x18EF, 0xE030) }, /* ELV ALC 8xxx Battery Charger */
180 { USB_DEVICE(0x18EF, 0xE032) }, /* ELV TFD500 Data Logger */
181 { USB_DEVICE(0x1901, 0x0190) }, /* GE B850 CP2105 Recorder interface */
182 { USB_DEVICE(0x1901, 0x0193) }, /* GE B650 CP2104 PMC interface */
183 { USB_DEVICE(0x1901, 0x0194) }, /* GE Healthcare Remote Alarm Box */
184 { USB_DEVICE(0x1901, 0x0195) }, /* GE B850/B650/B450 CP2104 DP UART interface */
185 { USB_DEVICE(0x1901, 0x0196) }, /* GE B850 CP2105 DP UART interface */
186 { USB_DEVICE(0x19CF, 0x3000) }, /* Parrot NMEA GPS Flight Recorder */
187 { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
188 { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
189 { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
190 { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
191 { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
192 { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
193 { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
194 { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
195 { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
196 { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
197 { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
198 { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
199 { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
200 { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
201 { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
202 { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
203 { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
204 { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
205 { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
206 { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
207 { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
208 { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
209 { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
210 { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
211 { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
212 { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
213 { USB_DEVICE(0x2626, 0xEA60) }, /* Aruba Networks 7xxx USB Serial Console */
214 { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
215 { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
216 { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
217 { USB_DEVICE(0x3923, 0x7A0B) }, /* National Instruments USB Serial Console */
218 { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
219 { } /* Terminating Entry */
222 MODULE_DEVICE_TABLE(usb, id_table);
224 struct cp210x_serial_private {
225 #ifdef CONFIG_GPIOLIB
229 bool gpio_registered;
235 struct cp210x_port_private {
236 __u8 bInterfaceNumber;
237 bool has_swapped_line_ctl;
240 static struct usb_serial_driver cp210x_device = {
242 .owner = THIS_MODULE,
245 .id_table = id_table,
248 .bulk_out_size = 256,
250 .close = cp210x_close,
251 .break_ctl = cp210x_break_ctl,
252 .set_termios = cp210x_set_termios,
253 .tx_empty = cp210x_tx_empty,
254 .tiocmget = cp210x_tiocmget,
255 .tiocmset = cp210x_tiocmset,
256 .attach = cp210x_attach,
257 .disconnect = cp210x_disconnect,
258 .release = cp210x_release,
259 .port_probe = cp210x_port_probe,
260 .port_remove = cp210x_port_remove,
261 .dtr_rts = cp210x_dtr_rts
264 static struct usb_serial_driver * const serial_drivers[] = {
268 /* Config request types */
269 #define REQTYPE_HOST_TO_INTERFACE 0x41
270 #define REQTYPE_INTERFACE_TO_HOST 0xc1
271 #define REQTYPE_HOST_TO_DEVICE 0x40
272 #define REQTYPE_DEVICE_TO_HOST 0xc0
274 /* Config request codes */
275 #define CP210X_IFC_ENABLE 0x00
276 #define CP210X_SET_BAUDDIV 0x01
277 #define CP210X_GET_BAUDDIV 0x02
278 #define CP210X_SET_LINE_CTL 0x03
279 #define CP210X_GET_LINE_CTL 0x04
280 #define CP210X_SET_BREAK 0x05
281 #define CP210X_IMM_CHAR 0x06
282 #define CP210X_SET_MHS 0x07
283 #define CP210X_GET_MDMSTS 0x08
284 #define CP210X_SET_XON 0x09
285 #define CP210X_SET_XOFF 0x0A
286 #define CP210X_SET_EVENTMASK 0x0B
287 #define CP210X_GET_EVENTMASK 0x0C
288 #define CP210X_SET_CHAR 0x0D
289 #define CP210X_GET_CHARS 0x0E
290 #define CP210X_GET_PROPS 0x0F
291 #define CP210X_GET_COMM_STATUS 0x10
292 #define CP210X_RESET 0x11
293 #define CP210X_PURGE 0x12
294 #define CP210X_SET_FLOW 0x13
295 #define CP210X_GET_FLOW 0x14
296 #define CP210X_EMBED_EVENTS 0x15
297 #define CP210X_GET_EVENTSTATE 0x16
298 #define CP210X_SET_CHARS 0x19
299 #define CP210X_GET_BAUDRATE 0x1D
300 #define CP210X_SET_BAUDRATE 0x1E
301 #define CP210X_VENDOR_SPECIFIC 0xFF
303 /* CP210X_IFC_ENABLE */
304 #define UART_ENABLE 0x0001
305 #define UART_DISABLE 0x0000
307 /* CP210X_(SET|GET)_BAUDDIV */
308 #define BAUD_RATE_GEN_FREQ 0x384000
310 /* CP210X_(SET|GET)_LINE_CTL */
311 #define BITS_DATA_MASK 0X0f00
312 #define BITS_DATA_5 0X0500
313 #define BITS_DATA_6 0X0600
314 #define BITS_DATA_7 0X0700
315 #define BITS_DATA_8 0X0800
316 #define BITS_DATA_9 0X0900
318 #define BITS_PARITY_MASK 0x00f0
319 #define BITS_PARITY_NONE 0x0000
320 #define BITS_PARITY_ODD 0x0010
321 #define BITS_PARITY_EVEN 0x0020
322 #define BITS_PARITY_MARK 0x0030
323 #define BITS_PARITY_SPACE 0x0040
325 #define BITS_STOP_MASK 0x000f
326 #define BITS_STOP_1 0x0000
327 #define BITS_STOP_1_5 0x0001
328 #define BITS_STOP_2 0x0002
330 /* CP210X_SET_BREAK */
331 #define BREAK_ON 0x0001
332 #define BREAK_OFF 0x0000
334 /* CP210X_(SET_MHS|GET_MDMSTS) */
335 #define CONTROL_DTR 0x0001
336 #define CONTROL_RTS 0x0002
337 #define CONTROL_CTS 0x0010
338 #define CONTROL_DSR 0x0020
339 #define CONTROL_RING 0x0040
340 #define CONTROL_DCD 0x0080
341 #define CONTROL_WRITE_DTR 0x0100
342 #define CONTROL_WRITE_RTS 0x0200
344 /* CP210X_VENDOR_SPECIFIC values */
345 #define CP210X_READ_LATCH 0x00C2
346 #define CP210X_GET_PARTNUM 0x370B
347 #define CP210X_GET_PORTCONFIG 0x370C
348 #define CP210X_GET_DEVICEMODE 0x3711
349 #define CP210X_WRITE_LATCH 0x37E1
351 /* Part number definitions */
352 #define CP210X_PARTNUM_CP2101 0x01
353 #define CP210X_PARTNUM_CP2102 0x02
354 #define CP210X_PARTNUM_CP2103 0x03
355 #define CP210X_PARTNUM_CP2104 0x04
356 #define CP210X_PARTNUM_CP2105 0x05
357 #define CP210X_PARTNUM_CP2108 0x08
358 #define CP210X_PARTNUM_CP2102N_QFN28 0x20
359 #define CP210X_PARTNUM_CP2102N_QFN24 0x21
360 #define CP210X_PARTNUM_CP2102N_QFN20 0x22
361 #define CP210X_PARTNUM_UNKNOWN 0xFF
363 /* CP210X_GET_COMM_STATUS returns these 0x13 bytes */
364 struct cp210x_comm_status {
366 __le32 ulHoldReasons;
367 __le32 ulAmountInInQueue;
368 __le32 ulAmountInOutQueue;
370 u8 bWaitForImmediate;
375 * CP210X_PURGE - 16 bits passed in wValue of USB request.
376 * SiLabs app note AN571 gives a strange description of the 4 bits:
377 * bit 0 or bit 2 clears the transmit queue and 1 or 3 receive.
378 * writing 1 to all, however, purges cp2108 well enough to avoid the hang.
380 #define PURGE_ALL 0x000f
382 /* CP210X_GET_FLOW/CP210X_SET_FLOW read/write these 0x10 bytes */
383 struct cp210x_flow_ctl {
384 __le32 ulControlHandshake;
385 __le32 ulFlowReplace;
390 /* cp210x_flow_ctl::ulControlHandshake */
391 #define CP210X_SERIAL_DTR_MASK GENMASK(1, 0)
392 #define CP210X_SERIAL_DTR_SHIFT(_mode) (_mode)
393 #define CP210X_SERIAL_CTS_HANDSHAKE BIT(3)
394 #define CP210X_SERIAL_DSR_HANDSHAKE BIT(4)
395 #define CP210X_SERIAL_DCD_HANDSHAKE BIT(5)
396 #define CP210X_SERIAL_DSR_SENSITIVITY BIT(6)
398 /* values for cp210x_flow_ctl::ulControlHandshake::CP210X_SERIAL_DTR_MASK */
399 #define CP210X_SERIAL_DTR_INACTIVE 0
400 #define CP210X_SERIAL_DTR_ACTIVE 1
401 #define CP210X_SERIAL_DTR_FLOW_CTL 2
403 /* cp210x_flow_ctl::ulFlowReplace */
404 #define CP210X_SERIAL_AUTO_TRANSMIT BIT(0)
405 #define CP210X_SERIAL_AUTO_RECEIVE BIT(1)
406 #define CP210X_SERIAL_ERROR_CHAR BIT(2)
407 #define CP210X_SERIAL_NULL_STRIPPING BIT(3)
408 #define CP210X_SERIAL_BREAK_CHAR BIT(4)
409 #define CP210X_SERIAL_RTS_MASK GENMASK(7, 6)
410 #define CP210X_SERIAL_RTS_SHIFT(_mode) (_mode << 6)
411 #define CP210X_SERIAL_XOFF_CONTINUE BIT(31)
413 /* values for cp210x_flow_ctl::ulFlowReplace::CP210X_SERIAL_RTS_MASK */
414 #define CP210X_SERIAL_RTS_INACTIVE 0
415 #define CP210X_SERIAL_RTS_ACTIVE 1
416 #define CP210X_SERIAL_RTS_FLOW_CTL 2
418 /* CP210X_VENDOR_SPECIFIC, CP210X_GET_DEVICEMODE call reads these 0x2 bytes. */
419 struct cp210x_pin_mode {
424 #define CP210X_PIN_MODE_MODEM 0
425 #define CP210X_PIN_MODE_GPIO BIT(0)
428 * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xf bytes.
429 * Structure needs padding due to unused/unspecified bytes.
431 struct cp210x_config {
436 __le16 suspend_state;
443 #define CP210X_SCI_GPIO_MODE_OFFSET 9
444 #define CP210X_SCI_GPIO_MODE_MASK GENMASK(11, 9)
446 #define CP210X_ECI_GPIO_MODE_OFFSET 2
447 #define CP210X_ECI_GPIO_MODE_MASK GENMASK(3, 2)
449 /* CP2105 port configuration values */
450 #define CP2105_GPIO0_TXLED_MODE BIT(0)
451 #define CP2105_GPIO1_RXLED_MODE BIT(1)
452 #define CP2105_GPIO1_RS485_MODE BIT(2)
454 /* CP210X_VENDOR_SPECIFIC, CP210X_WRITE_LATCH call writes these 0x2 bytes. */
455 struct cp210x_gpio_write {
460 static bool cp210x_is_cp2102n(struct usb_serial *serial)
462 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
464 return (priv->partnum == CP210X_PARTNUM_CP2102N_QFN28) ||
465 (priv->partnum == CP210X_PARTNUM_CP2102N_QFN24) ||
466 (priv->partnum == CP210X_PARTNUM_CP2102N_QFN20);
470 * Helper to get interface number when we only have struct usb_serial.
472 static u8 cp210x_interface_num(struct usb_serial *serial)
474 struct usb_host_interface *cur_altsetting;
476 cur_altsetting = serial->interface->cur_altsetting;
478 return cur_altsetting->desc.bInterfaceNumber;
482 * Reads a variable-sized block of CP210X_ registers, identified by req.
483 * Returns data into buf in native USB byte order.
485 static int cp210x_read_reg_block(struct usb_serial_port *port, u8 req,
486 void *buf, int bufsize)
488 struct usb_serial *serial = port->serial;
489 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
493 dmabuf = kmalloc(bufsize, GFP_KERNEL);
496 * FIXME Some callers don't bother to check for error,
497 * at least give them consistent junk until they are fixed
499 memset(buf, 0, bufsize);
503 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
504 req, REQTYPE_INTERFACE_TO_HOST, 0,
505 port_priv->bInterfaceNumber, dmabuf, bufsize,
506 USB_CTRL_SET_TIMEOUT);
507 if (result == bufsize) {
508 memcpy(buf, dmabuf, bufsize);
511 dev_err(&port->dev, "failed get req 0x%x size %d status: %d\n",
512 req, bufsize, result);
517 * FIXME Some callers don't bother to check for error,
518 * at least give them consistent junk until they are fixed
520 memset(buf, 0, bufsize);
529 * Reads any 32-bit CP210X_ register identified by req.
531 static int cp210x_read_u32_reg(struct usb_serial_port *port, u8 req, u32 *val)
536 err = cp210x_read_reg_block(port, req, &le32_val, sizeof(le32_val));
539 * FIXME Some callers don't bother to check for error,
540 * at least give them consistent junk until they are fixed
546 *val = le32_to_cpu(le32_val);
552 * Reads any 16-bit CP210X_ register identified by req.
554 static int cp210x_read_u16_reg(struct usb_serial_port *port, u8 req, u16 *val)
559 err = cp210x_read_reg_block(port, req, &le16_val, sizeof(le16_val));
563 *val = le16_to_cpu(le16_val);
569 * Reads any 8-bit CP210X_ register identified by req.
571 static int cp210x_read_u8_reg(struct usb_serial_port *port, u8 req, u8 *val)
573 return cp210x_read_reg_block(port, req, val, sizeof(*val));
577 * Reads a variable-sized vendor block of CP210X_ registers, identified by val.
578 * Returns data into buf in native USB byte order.
580 static int cp210x_read_vendor_block(struct usb_serial *serial, u8 type, u16 val,
581 void *buf, int bufsize)
586 dmabuf = kmalloc(bufsize, GFP_KERNEL);
590 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
591 CP210X_VENDOR_SPECIFIC, type, val,
592 cp210x_interface_num(serial), dmabuf, bufsize,
593 USB_CTRL_GET_TIMEOUT);
594 if (result == bufsize) {
595 memcpy(buf, dmabuf, bufsize);
598 dev_err(&serial->interface->dev,
599 "failed to get vendor val 0x%04x size %d: %d\n", val,
611 * Writes any 16-bit CP210X_ register (req) whose value is passed
612 * entirely in the wValue field of the USB request.
614 static int cp210x_write_u16_reg(struct usb_serial_port *port, u8 req, u16 val)
616 struct usb_serial *serial = port->serial;
617 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
620 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
621 req, REQTYPE_HOST_TO_INTERFACE, val,
622 port_priv->bInterfaceNumber, NULL, 0,
623 USB_CTRL_SET_TIMEOUT);
625 dev_err(&port->dev, "failed set request 0x%x status: %d\n",
633 * Writes a variable-sized block of CP210X_ registers, identified by req.
634 * Data in buf must be in native USB byte order.
636 static int cp210x_write_reg_block(struct usb_serial_port *port, u8 req,
637 void *buf, int bufsize)
639 struct usb_serial *serial = port->serial;
640 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
644 dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
648 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
649 req, REQTYPE_HOST_TO_INTERFACE, 0,
650 port_priv->bInterfaceNumber, dmabuf, bufsize,
651 USB_CTRL_SET_TIMEOUT);
655 if (result == bufsize) {
658 dev_err(&port->dev, "failed set req 0x%x size %d status: %d\n",
659 req, bufsize, result);
668 * Writes any 32-bit CP210X_ register identified by req.
670 static int cp210x_write_u32_reg(struct usb_serial_port *port, u8 req, u32 val)
674 le32_val = cpu_to_le32(val);
676 return cp210x_write_reg_block(port, req, &le32_val, sizeof(le32_val));
679 #ifdef CONFIG_GPIOLIB
681 * Writes a variable-sized vendor block of CP210X_ registers, identified by val.
682 * Data in buf must be in native USB byte order.
684 static int cp210x_write_vendor_block(struct usb_serial *serial, u8 type,
685 u16 val, void *buf, int bufsize)
690 dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
694 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
695 CP210X_VENDOR_SPECIFIC, type, val,
696 cp210x_interface_num(serial), dmabuf, bufsize,
697 USB_CTRL_SET_TIMEOUT);
701 if (result == bufsize) {
704 dev_err(&serial->interface->dev,
705 "failed to set vendor val 0x%04x size %d: %d\n", val,
716 * Detect CP2108 GET_LINE_CTL bug and activate workaround.
717 * Write a known good value 0x800, read it back.
718 * If it comes back swapped the bug is detected.
719 * Preserve the original register value.
721 static int cp210x_detect_swapped_line_ctl(struct usb_serial_port *port)
723 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
728 err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_save);
732 err = cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, 0x800);
736 err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_test);
740 if (line_ctl_test == 8) {
741 port_priv->has_swapped_line_ctl = true;
742 line_ctl_save = swab16(line_ctl_save);
745 return cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, line_ctl_save);
749 * Must always be called instead of cp210x_read_u16_reg(CP210X_GET_LINE_CTL)
750 * to workaround cp2108 bug and get correct value.
752 static int cp210x_get_line_ctl(struct usb_serial_port *port, u16 *ctl)
754 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
757 err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, ctl);
761 /* Workaround swapped bytes in 16-bit value from CP210X_GET_LINE_CTL */
762 if (port_priv->has_swapped_line_ctl)
768 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
772 result = cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_ENABLE);
774 dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
778 /* Configure the termios structure */
779 cp210x_get_termios(tty, port);
781 /* The baud rate must be initialised on cp2104 */
783 cp210x_change_speed(tty, port, NULL);
785 return usb_serial_generic_open(tty, port);
788 static void cp210x_close(struct usb_serial_port *port)
790 usb_serial_generic_close(port);
792 /* Clear both queues; cp2108 needs this to avoid an occasional hang */
793 cp210x_write_u16_reg(port, CP210X_PURGE, PURGE_ALL);
795 cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
799 * Read how many bytes are waiting in the TX queue.
801 static int cp210x_get_tx_queue_byte_count(struct usb_serial_port *port,
804 struct usb_serial *serial = port->serial;
805 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
806 struct cp210x_comm_status *sts;
809 sts = kmalloc(sizeof(*sts), GFP_KERNEL);
813 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
814 CP210X_GET_COMM_STATUS, REQTYPE_INTERFACE_TO_HOST,
815 0, port_priv->bInterfaceNumber, sts, sizeof(*sts),
816 USB_CTRL_GET_TIMEOUT);
817 if (result == sizeof(*sts)) {
818 *count = le32_to_cpu(sts->ulAmountInOutQueue);
821 dev_err(&port->dev, "failed to get comm status: %d\n", result);
831 static bool cp210x_tx_empty(struct usb_serial_port *port)
836 err = cp210x_get_tx_queue_byte_count(port, &count);
845 * Reads the baud rate, data bits, parity, stop bits and flow control mode
846 * from the device, corrects any unsupported values, and configures the
847 * termios structure to reflect the state of the device
849 static void cp210x_get_termios(struct tty_struct *tty,
850 struct usb_serial_port *port)
855 cp210x_get_termios_port(tty->driver_data,
856 &tty->termios.c_cflag, &baud);
857 tty_encode_baud_rate(tty, baud, baud);
861 cp210x_get_termios_port(port, &cflag, &baud);
866 * cp210x_get_termios_port
867 * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
869 static void cp210x_get_termios_port(struct usb_serial_port *port,
870 tcflag_t *cflagp, unsigned int *baudp)
872 struct device *dev = &port->dev;
874 struct cp210x_flow_ctl flow_ctl;
879 cp210x_read_u32_reg(port, CP210X_GET_BAUDRATE, &baud);
881 dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud);
886 cp210x_get_line_ctl(port, &bits);
888 switch (bits & BITS_DATA_MASK) {
890 dev_dbg(dev, "%s - data bits = 5\n", __func__);
894 dev_dbg(dev, "%s - data bits = 6\n", __func__);
898 dev_dbg(dev, "%s - data bits = 7\n", __func__);
902 dev_dbg(dev, "%s - data bits = 8\n", __func__);
906 dev_dbg(dev, "%s - data bits = 9 (not supported, using 8 data bits)\n", __func__);
908 bits &= ~BITS_DATA_MASK;
910 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
913 dev_dbg(dev, "%s - Unknown number of data bits, using 8\n", __func__);
915 bits &= ~BITS_DATA_MASK;
917 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
921 switch (bits & BITS_PARITY_MASK) {
922 case BITS_PARITY_NONE:
923 dev_dbg(dev, "%s - parity = NONE\n", __func__);
926 case BITS_PARITY_ODD:
927 dev_dbg(dev, "%s - parity = ODD\n", __func__);
928 cflag |= (PARENB|PARODD);
930 case BITS_PARITY_EVEN:
931 dev_dbg(dev, "%s - parity = EVEN\n", __func__);
935 case BITS_PARITY_MARK:
936 dev_dbg(dev, "%s - parity = MARK\n", __func__);
937 cflag |= (PARENB|PARODD|CMSPAR);
939 case BITS_PARITY_SPACE:
940 dev_dbg(dev, "%s - parity = SPACE\n", __func__);
942 cflag |= (PARENB|CMSPAR);
945 dev_dbg(dev, "%s - Unknown parity mode, disabling parity\n", __func__);
947 bits &= ~BITS_PARITY_MASK;
948 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
953 switch (bits & BITS_STOP_MASK) {
955 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
958 dev_dbg(dev, "%s - stop bits = 1.5 (not supported, using 1 stop bit)\n", __func__);
959 bits &= ~BITS_STOP_MASK;
960 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
963 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
967 dev_dbg(dev, "%s - Unknown number of stop bits, using 1 stop bit\n", __func__);
968 bits &= ~BITS_STOP_MASK;
969 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
973 cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
975 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
976 if (ctl_hs & CP210X_SERIAL_CTS_HANDSHAKE) {
977 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
980 dev_dbg(dev, "%s - flow control = NONE\n", __func__);
992 static const struct cp210x_rate cp210x_an205_table1[] = {
1021 { 921600, UINT_MAX }
1025 * Quantises the baud rate as per AN205 Table 1
1027 static speed_t cp210x_get_an205_rate(speed_t baud)
1031 for (i = 0; i < ARRAY_SIZE(cp210x_an205_table1); ++i) {
1032 if (baud <= cp210x_an205_table1[i].high)
1036 return cp210x_an205_table1[i].rate;
1040 * CP2101 supports the following baud rates:
1042 * 300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
1043 * 38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
1045 * CP2102 and CP2103 support the following additional rates:
1047 * 4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
1050 * The device will map a requested rate to a supported one, but the result
1051 * of requests for rates greater than 1053257 is undefined (see AN205).
1053 * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
1054 * respectively, with an error less than 1%. The actual rates are determined
1057 * div = round(freq / (2 x prescale x request))
1058 * actual = freq / (2 x prescale x div)
1060 * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
1062 * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
1065 static void cp210x_change_speed(struct tty_struct *tty,
1066 struct usb_serial_port *port, struct ktermios *old_termios)
1068 struct usb_serial *serial = port->serial;
1069 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1072 baud = tty->termios.c_ospeed;
1075 * This maps the requested rate to the actual rate on cp2102n, a valid
1076 * rate on cp2102 or cp2103, or to an arbitrary rate in
1079 * NOTE: B0 is not implemented.
1081 if (cp210x_is_cp2102n(serial)) {
1085 baud = clamp(baud, 300u, priv->max_speed);
1086 prescaler = (baud <= 365) ? 4 : 1;
1087 clk_div = DIV_ROUND_CLOSEST(48000000, 2 * prescaler * baud);
1088 baud = 48000000 / (2 * prescaler * clk_div);
1089 } else if (baud < 1000000) {
1090 baud = cp210x_get_an205_rate(baud);
1091 } else if (baud > priv->max_speed) {
1092 baud = priv->max_speed;
1095 dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
1096 if (cp210x_write_u32_reg(port, CP210X_SET_BAUDRATE, baud)) {
1097 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
1099 baud = old_termios->c_ospeed;
1104 tty_encode_baud_rate(tty, baud, baud);
1107 static void cp210x_set_termios(struct tty_struct *tty,
1108 struct usb_serial_port *port, struct ktermios *old_termios)
1110 struct device *dev = &port->dev;
1111 unsigned int cflag, old_cflag;
1114 cflag = tty->termios.c_cflag;
1115 old_cflag = old_termios->c_cflag;
1117 if (tty->termios.c_ospeed != old_termios->c_ospeed)
1118 cp210x_change_speed(tty, port, old_termios);
1120 /* If the number of data bits is to be updated */
1121 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
1122 cp210x_get_line_ctl(port, &bits);
1123 bits &= ~BITS_DATA_MASK;
1124 switch (cflag & CSIZE) {
1126 bits |= BITS_DATA_5;
1127 dev_dbg(dev, "%s - data bits = 5\n", __func__);
1130 bits |= BITS_DATA_6;
1131 dev_dbg(dev, "%s - data bits = 6\n", __func__);
1134 bits |= BITS_DATA_7;
1135 dev_dbg(dev, "%s - data bits = 7\n", __func__);
1139 bits |= BITS_DATA_8;
1140 dev_dbg(dev, "%s - data bits = 8\n", __func__);
1143 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1144 dev_dbg(dev, "Number of data bits requested not supported by device\n");
1147 if ((cflag & (PARENB|PARODD|CMSPAR)) !=
1148 (old_cflag & (PARENB|PARODD|CMSPAR))) {
1149 cp210x_get_line_ctl(port, &bits);
1150 bits &= ~BITS_PARITY_MASK;
1151 if (cflag & PARENB) {
1152 if (cflag & CMSPAR) {
1153 if (cflag & PARODD) {
1154 bits |= BITS_PARITY_MARK;
1155 dev_dbg(dev, "%s - parity = MARK\n", __func__);
1157 bits |= BITS_PARITY_SPACE;
1158 dev_dbg(dev, "%s - parity = SPACE\n", __func__);
1161 if (cflag & PARODD) {
1162 bits |= BITS_PARITY_ODD;
1163 dev_dbg(dev, "%s - parity = ODD\n", __func__);
1165 bits |= BITS_PARITY_EVEN;
1166 dev_dbg(dev, "%s - parity = EVEN\n", __func__);
1170 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1171 dev_dbg(dev, "Parity mode not supported by device\n");
1174 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
1175 cp210x_get_line_ctl(port, &bits);
1176 bits &= ~BITS_STOP_MASK;
1177 if (cflag & CSTOPB) {
1178 bits |= BITS_STOP_2;
1179 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
1181 bits |= BITS_STOP_1;
1182 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
1184 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1185 dev_dbg(dev, "Number of stop bits requested not supported by device\n");
1188 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
1189 struct cp210x_flow_ctl flow_ctl;
1193 cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1195 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1196 flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1197 dev_dbg(dev, "%s - read ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1198 __func__, ctl_hs, flow_repl);
1200 ctl_hs &= ~CP210X_SERIAL_DSR_HANDSHAKE;
1201 ctl_hs &= ~CP210X_SERIAL_DCD_HANDSHAKE;
1202 ctl_hs &= ~CP210X_SERIAL_DSR_SENSITIVITY;
1203 ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1204 ctl_hs |= CP210X_SERIAL_DTR_SHIFT(CP210X_SERIAL_DTR_ACTIVE);
1205 if (cflag & CRTSCTS) {
1206 ctl_hs |= CP210X_SERIAL_CTS_HANDSHAKE;
1208 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1209 flow_repl |= CP210X_SERIAL_RTS_SHIFT(
1210 CP210X_SERIAL_RTS_FLOW_CTL);
1211 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
1213 ctl_hs &= ~CP210X_SERIAL_CTS_HANDSHAKE;
1215 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1216 flow_repl |= CP210X_SERIAL_RTS_SHIFT(
1217 CP210X_SERIAL_RTS_ACTIVE);
1218 dev_dbg(dev, "%s - flow control = NONE\n", __func__);
1221 dev_dbg(dev, "%s - write ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1222 __func__, ctl_hs, flow_repl);
1223 flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1224 flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1225 cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1231 static int cp210x_tiocmset(struct tty_struct *tty,
1232 unsigned int set, unsigned int clear)
1234 struct usb_serial_port *port = tty->driver_data;
1235 return cp210x_tiocmset_port(port, set, clear);
1238 static int cp210x_tiocmset_port(struct usb_serial_port *port,
1239 unsigned int set, unsigned int clear)
1243 if (set & TIOCM_RTS) {
1244 control |= CONTROL_RTS;
1245 control |= CONTROL_WRITE_RTS;
1247 if (set & TIOCM_DTR) {
1248 control |= CONTROL_DTR;
1249 control |= CONTROL_WRITE_DTR;
1251 if (clear & TIOCM_RTS) {
1252 control &= ~CONTROL_RTS;
1253 control |= CONTROL_WRITE_RTS;
1255 if (clear & TIOCM_DTR) {
1256 control &= ~CONTROL_DTR;
1257 control |= CONTROL_WRITE_DTR;
1260 dev_dbg(&port->dev, "%s - control = 0x%.4x\n", __func__, control);
1262 return cp210x_write_u16_reg(port, CP210X_SET_MHS, control);
1265 static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
1268 cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
1270 cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
1273 static int cp210x_tiocmget(struct tty_struct *tty)
1275 struct usb_serial_port *port = tty->driver_data;
1279 result = cp210x_read_u8_reg(port, CP210X_GET_MDMSTS, &control);
1283 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
1284 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
1285 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
1286 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
1287 |((control & CONTROL_RING)? TIOCM_RI : 0)
1288 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
1290 dev_dbg(&port->dev, "%s - control = 0x%.2x\n", __func__, control);
1295 static void cp210x_break_ctl(struct tty_struct *tty, int break_state)
1297 struct usb_serial_port *port = tty->driver_data;
1300 if (break_state == 0)
1304 dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
1305 state == BREAK_OFF ? "off" : "on");
1306 cp210x_write_u16_reg(port, CP210X_SET_BREAK, state);
1309 #ifdef CONFIG_GPIOLIB
1310 static int cp210x_gpio_request(struct gpio_chip *gc, unsigned int offset)
1312 struct usb_serial *serial = gpiochip_get_data(gc);
1313 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1317 if (priv->config & CP2105_GPIO0_TXLED_MODE)
1321 if (priv->config & (CP2105_GPIO1_RXLED_MODE |
1322 CP2105_GPIO1_RS485_MODE))
1330 static int cp210x_gpio_get(struct gpio_chip *gc, unsigned int gpio)
1332 struct usb_serial *serial = gpiochip_get_data(gc);
1336 result = cp210x_read_vendor_block(serial, REQTYPE_INTERFACE_TO_HOST,
1337 CP210X_READ_LATCH, &buf, sizeof(buf));
1341 return !!(buf & BIT(gpio));
1344 static void cp210x_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)
1346 struct usb_serial *serial = gpiochip_get_data(gc);
1347 struct cp210x_gpio_write buf;
1350 buf.state = BIT(gpio);
1354 buf.mask = BIT(gpio);
1356 cp210x_write_vendor_block(serial, REQTYPE_HOST_TO_INTERFACE,
1357 CP210X_WRITE_LATCH, &buf, sizeof(buf));
1360 static int cp210x_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
1362 /* Hardware does not support an input mode */
1366 static int cp210x_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
1368 /* Hardware does not support an input mode */
1372 static int cp210x_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
1378 static int cp210x_gpio_set_config(struct gpio_chip *gc, unsigned int gpio,
1379 unsigned long config)
1381 struct usb_serial *serial = gpiochip_get_data(gc);
1382 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1383 enum pin_config_param param = pinconf_to_config_param(config);
1385 /* Succeed only if in correct mode (this can't be set at runtime) */
1386 if ((param == PIN_CONFIG_DRIVE_PUSH_PULL) &&
1387 (priv->gpio_mode & BIT(gpio)))
1390 if ((param == PIN_CONFIG_DRIVE_OPEN_DRAIN) &&
1391 !(priv->gpio_mode & BIT(gpio)))
1398 * This function is for configuring GPIO using shared pins, where other signals
1399 * are made unavailable by configuring the use of GPIO. This is believed to be
1400 * only applicable to the cp2105 at this point, the other devices supported by
1401 * this driver that provide GPIO do so in a way that does not impact other
1402 * signals and are thus expected to have very different initialisation.
1404 static int cp2105_shared_gpio_init(struct usb_serial *serial)
1406 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1407 struct cp210x_pin_mode mode;
1408 struct cp210x_config config;
1409 u8 intf_num = cp210x_interface_num(serial);
1412 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1413 CP210X_GET_DEVICEMODE, &mode,
1418 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1419 CP210X_GET_PORTCONFIG, &config,
1424 /* 2 banks of GPIO - One for the pins taken from each serial port */
1425 if (intf_num == 0) {
1426 if (mode.eci == CP210X_PIN_MODE_MODEM)
1429 priv->config = config.eci_cfg;
1430 priv->gpio_mode = (u8)((le16_to_cpu(config.gpio_mode) &
1431 CP210X_ECI_GPIO_MODE_MASK) >>
1432 CP210X_ECI_GPIO_MODE_OFFSET);
1434 } else if (intf_num == 1) {
1435 if (mode.sci == CP210X_PIN_MODE_MODEM)
1438 priv->config = config.sci_cfg;
1439 priv->gpio_mode = (u8)((le16_to_cpu(config.gpio_mode) &
1440 CP210X_SCI_GPIO_MODE_MASK) >>
1441 CP210X_SCI_GPIO_MODE_OFFSET);
1447 priv->gc.label = "cp210x";
1448 priv->gc.request = cp210x_gpio_request;
1449 priv->gc.get_direction = cp210x_gpio_direction_get;
1450 priv->gc.direction_input = cp210x_gpio_direction_input;
1451 priv->gc.direction_output = cp210x_gpio_direction_output;
1452 priv->gc.get = cp210x_gpio_get;
1453 priv->gc.set = cp210x_gpio_set;
1454 priv->gc.set_config = cp210x_gpio_set_config;
1455 priv->gc.owner = THIS_MODULE;
1456 priv->gc.parent = &serial->interface->dev;
1458 priv->gc.can_sleep = true;
1460 result = gpiochip_add_data(&priv->gc, serial);
1462 priv->gpio_registered = true;
1467 static void cp210x_gpio_remove(struct usb_serial *serial)
1469 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1471 if (priv->gpio_registered) {
1472 gpiochip_remove(&priv->gc);
1473 priv->gpio_registered = false;
1479 static int cp2105_shared_gpio_init(struct usb_serial *serial)
1484 static void cp210x_gpio_remove(struct usb_serial *serial)
1491 static int cp210x_port_probe(struct usb_serial_port *port)
1493 struct usb_serial *serial = port->serial;
1494 struct cp210x_port_private *port_priv;
1497 port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
1501 port_priv->bInterfaceNumber = cp210x_interface_num(serial);
1503 usb_set_serial_port_data(port, port_priv);
1505 ret = cp210x_detect_swapped_line_ctl(port);
1514 static int cp210x_port_remove(struct usb_serial_port *port)
1516 struct cp210x_port_private *port_priv;
1518 port_priv = usb_get_serial_port_data(port);
1524 static void cp210x_init_max_speed(struct usb_serial *serial)
1526 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1529 switch (priv->partnum) {
1530 case CP210X_PARTNUM_CP2101:
1533 case CP210X_PARTNUM_CP2102:
1534 case CP210X_PARTNUM_CP2103:
1537 case CP210X_PARTNUM_CP2104:
1538 case CP210X_PARTNUM_CP2108:
1541 case CP210X_PARTNUM_CP2105:
1542 if (cp210x_interface_num(serial) == 0)
1543 max = 2000000; /* ECI */
1545 max = 921600; /* SCI */
1547 case CP210X_PARTNUM_CP2102N_QFN28:
1548 case CP210X_PARTNUM_CP2102N_QFN24:
1549 case CP210X_PARTNUM_CP2102N_QFN20:
1557 priv->max_speed = max;
1560 static int cp210x_attach(struct usb_serial *serial)
1563 struct cp210x_serial_private *priv;
1565 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1569 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1570 CP210X_GET_PARTNUM, &priv->partnum,
1571 sizeof(priv->partnum));
1573 dev_warn(&serial->interface->dev,
1574 "querying part number failed\n");
1575 priv->partnum = CP210X_PARTNUM_UNKNOWN;
1578 usb_set_serial_data(serial, priv);
1580 cp210x_init_max_speed(serial);
1582 if (priv->partnum == CP210X_PARTNUM_CP2105) {
1583 result = cp2105_shared_gpio_init(serial);
1585 dev_err(&serial->interface->dev,
1586 "GPIO initialisation failed, continuing without GPIO support\n");
1593 static void cp210x_disconnect(struct usb_serial *serial)
1595 cp210x_gpio_remove(serial);
1598 static void cp210x_release(struct usb_serial *serial)
1600 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1602 cp210x_gpio_remove(serial);
1607 module_usb_serial_driver(serial_drivers, id_table);
1609 MODULE_DESCRIPTION(DRIVER_DESC);
1610 MODULE_LICENSE("GPL v2");