Linux 4.16.11
[linux/fpc-iii.git] / drivers / usb / serial / cp210x.c
blobeb6c26cbe5792b0e535c77b9e2e245b700071458
1 // SPDX-License-Identifier: GPL-2.0
2 /*
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"
30 * Function Prototypes
32 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *);
33 static void cp210x_close(struct usb_serial_port *);
34 static void cp210x_get_termios(struct tty_struct *, struct usb_serial_port *);
35 static void cp210x_get_termios_port(struct usb_serial_port *port,
36 tcflag_t *cflagp, unsigned int *baudp);
37 static void cp210x_change_speed(struct tty_struct *, struct usb_serial_port *,
38 struct ktermios *);
39 static void cp210x_set_termios(struct tty_struct *, struct usb_serial_port *,
40 struct ktermios*);
41 static bool cp210x_tx_empty(struct usb_serial_port *port);
42 static int cp210x_tiocmget(struct tty_struct *);
43 static int cp210x_tiocmset(struct tty_struct *, unsigned int, unsigned int);
44 static int cp210x_tiocmset_port(struct usb_serial_port *port,
45 unsigned int, unsigned int);
46 static void cp210x_break_ctl(struct tty_struct *, int);
47 static int cp210x_attach(struct usb_serial *);
48 static void cp210x_disconnect(struct usb_serial *);
49 static void cp210x_release(struct usb_serial *);
50 static int cp210x_port_probe(struct usb_serial_port *);
51 static int cp210x_port_remove(struct usb_serial_port *);
52 static void cp210x_dtr_rts(struct usb_serial_port *p, int on);
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
226 struct gpio_chip gc;
227 u8 config;
228 u8 gpio_mode;
229 bool gpio_registered;
230 #endif
231 u8 partnum;
234 struct cp210x_port_private {
235 __u8 bInterfaceNumber;
236 bool has_swapped_line_ctl;
239 static struct usb_serial_driver cp210x_device = {
240 .driver = {
241 .owner = THIS_MODULE,
242 .name = "cp210x",
244 .id_table = id_table,
245 .num_ports = 1,
246 .bulk_in_size = 256,
247 .bulk_out_size = 256,
248 .open = cp210x_open,
249 .close = cp210x_close,
250 .break_ctl = cp210x_break_ctl,
251 .set_termios = cp210x_set_termios,
252 .tx_empty = cp210x_tx_empty,
253 .tiocmget = cp210x_tiocmget,
254 .tiocmset = cp210x_tiocmset,
255 .attach = cp210x_attach,
256 .disconnect = cp210x_disconnect,
257 .release = cp210x_release,
258 .port_probe = cp210x_port_probe,
259 .port_remove = cp210x_port_remove,
260 .dtr_rts = cp210x_dtr_rts
263 static struct usb_serial_driver * const serial_drivers[] = {
264 &cp210x_device, NULL
267 /* Config request types */
268 #define REQTYPE_HOST_TO_INTERFACE 0x41
269 #define REQTYPE_INTERFACE_TO_HOST 0xc1
270 #define REQTYPE_HOST_TO_DEVICE 0x40
271 #define REQTYPE_DEVICE_TO_HOST 0xc0
273 /* Config request codes */
274 #define CP210X_IFC_ENABLE 0x00
275 #define CP210X_SET_BAUDDIV 0x01
276 #define CP210X_GET_BAUDDIV 0x02
277 #define CP210X_SET_LINE_CTL 0x03
278 #define CP210X_GET_LINE_CTL 0x04
279 #define CP210X_SET_BREAK 0x05
280 #define CP210X_IMM_CHAR 0x06
281 #define CP210X_SET_MHS 0x07
282 #define CP210X_GET_MDMSTS 0x08
283 #define CP210X_SET_XON 0x09
284 #define CP210X_SET_XOFF 0x0A
285 #define CP210X_SET_EVENTMASK 0x0B
286 #define CP210X_GET_EVENTMASK 0x0C
287 #define CP210X_SET_CHAR 0x0D
288 #define CP210X_GET_CHARS 0x0E
289 #define CP210X_GET_PROPS 0x0F
290 #define CP210X_GET_COMM_STATUS 0x10
291 #define CP210X_RESET 0x11
292 #define CP210X_PURGE 0x12
293 #define CP210X_SET_FLOW 0x13
294 #define CP210X_GET_FLOW 0x14
295 #define CP210X_EMBED_EVENTS 0x15
296 #define CP210X_GET_EVENTSTATE 0x16
297 #define CP210X_SET_CHARS 0x19
298 #define CP210X_GET_BAUDRATE 0x1D
299 #define CP210X_SET_BAUDRATE 0x1E
300 #define CP210X_VENDOR_SPECIFIC 0xFF
302 /* CP210X_IFC_ENABLE */
303 #define UART_ENABLE 0x0001
304 #define UART_DISABLE 0x0000
306 /* CP210X_(SET|GET)_BAUDDIV */
307 #define BAUD_RATE_GEN_FREQ 0x384000
309 /* CP210X_(SET|GET)_LINE_CTL */
310 #define BITS_DATA_MASK 0X0f00
311 #define BITS_DATA_5 0X0500
312 #define BITS_DATA_6 0X0600
313 #define BITS_DATA_7 0X0700
314 #define BITS_DATA_8 0X0800
315 #define BITS_DATA_9 0X0900
317 #define BITS_PARITY_MASK 0x00f0
318 #define BITS_PARITY_NONE 0x0000
319 #define BITS_PARITY_ODD 0x0010
320 #define BITS_PARITY_EVEN 0x0020
321 #define BITS_PARITY_MARK 0x0030
322 #define BITS_PARITY_SPACE 0x0040
324 #define BITS_STOP_MASK 0x000f
325 #define BITS_STOP_1 0x0000
326 #define BITS_STOP_1_5 0x0001
327 #define BITS_STOP_2 0x0002
329 /* CP210X_SET_BREAK */
330 #define BREAK_ON 0x0001
331 #define BREAK_OFF 0x0000
333 /* CP210X_(SET_MHS|GET_MDMSTS) */
334 #define CONTROL_DTR 0x0001
335 #define CONTROL_RTS 0x0002
336 #define CONTROL_CTS 0x0010
337 #define CONTROL_DSR 0x0020
338 #define CONTROL_RING 0x0040
339 #define CONTROL_DCD 0x0080
340 #define CONTROL_WRITE_DTR 0x0100
341 #define CONTROL_WRITE_RTS 0x0200
343 /* CP210X_VENDOR_SPECIFIC values */
344 #define CP210X_READ_LATCH 0x00C2
345 #define CP210X_GET_PARTNUM 0x370B
346 #define CP210X_GET_PORTCONFIG 0x370C
347 #define CP210X_GET_DEVICEMODE 0x3711
348 #define CP210X_WRITE_LATCH 0x37E1
350 /* Part number definitions */
351 #define CP210X_PARTNUM_CP2101 0x01
352 #define CP210X_PARTNUM_CP2102 0x02
353 #define CP210X_PARTNUM_CP2103 0x03
354 #define CP210X_PARTNUM_CP2104 0x04
355 #define CP210X_PARTNUM_CP2105 0x05
356 #define CP210X_PARTNUM_CP2108 0x08
357 #define CP210X_PARTNUM_UNKNOWN 0xFF
359 /* CP210X_GET_COMM_STATUS returns these 0x13 bytes */
360 struct cp210x_comm_status {
361 __le32 ulErrors;
362 __le32 ulHoldReasons;
363 __le32 ulAmountInInQueue;
364 __le32 ulAmountInOutQueue;
365 u8 bEofReceived;
366 u8 bWaitForImmediate;
367 u8 bReserved;
368 } __packed;
371 * CP210X_PURGE - 16 bits passed in wValue of USB request.
372 * SiLabs app note AN571 gives a strange description of the 4 bits:
373 * bit 0 or bit 2 clears the transmit queue and 1 or 3 receive.
374 * writing 1 to all, however, purges cp2108 well enough to avoid the hang.
376 #define PURGE_ALL 0x000f
378 /* CP210X_GET_FLOW/CP210X_SET_FLOW read/write these 0x10 bytes */
379 struct cp210x_flow_ctl {
380 __le32 ulControlHandshake;
381 __le32 ulFlowReplace;
382 __le32 ulXonLimit;
383 __le32 ulXoffLimit;
384 } __packed;
386 /* cp210x_flow_ctl::ulControlHandshake */
387 #define CP210X_SERIAL_DTR_MASK GENMASK(1, 0)
388 #define CP210X_SERIAL_DTR_SHIFT(_mode) (_mode)
389 #define CP210X_SERIAL_CTS_HANDSHAKE BIT(3)
390 #define CP210X_SERIAL_DSR_HANDSHAKE BIT(4)
391 #define CP210X_SERIAL_DCD_HANDSHAKE BIT(5)
392 #define CP210X_SERIAL_DSR_SENSITIVITY BIT(6)
394 /* values for cp210x_flow_ctl::ulControlHandshake::CP210X_SERIAL_DTR_MASK */
395 #define CP210X_SERIAL_DTR_INACTIVE 0
396 #define CP210X_SERIAL_DTR_ACTIVE 1
397 #define CP210X_SERIAL_DTR_FLOW_CTL 2
399 /* cp210x_flow_ctl::ulFlowReplace */
400 #define CP210X_SERIAL_AUTO_TRANSMIT BIT(0)
401 #define CP210X_SERIAL_AUTO_RECEIVE BIT(1)
402 #define CP210X_SERIAL_ERROR_CHAR BIT(2)
403 #define CP210X_SERIAL_NULL_STRIPPING BIT(3)
404 #define CP210X_SERIAL_BREAK_CHAR BIT(4)
405 #define CP210X_SERIAL_RTS_MASK GENMASK(7, 6)
406 #define CP210X_SERIAL_RTS_SHIFT(_mode) (_mode << 6)
407 #define CP210X_SERIAL_XOFF_CONTINUE BIT(31)
409 /* values for cp210x_flow_ctl::ulFlowReplace::CP210X_SERIAL_RTS_MASK */
410 #define CP210X_SERIAL_RTS_INACTIVE 0
411 #define CP210X_SERIAL_RTS_ACTIVE 1
412 #define CP210X_SERIAL_RTS_FLOW_CTL 2
414 /* CP210X_VENDOR_SPECIFIC, CP210X_GET_DEVICEMODE call reads these 0x2 bytes. */
415 struct cp210x_pin_mode {
416 u8 eci;
417 u8 sci;
418 } __packed;
420 #define CP210X_PIN_MODE_MODEM 0
421 #define CP210X_PIN_MODE_GPIO BIT(0)
424 * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xf bytes.
425 * Structure needs padding due to unused/unspecified bytes.
427 struct cp210x_config {
428 __le16 gpio_mode;
429 u8 __pad0[2];
430 __le16 reset_state;
431 u8 __pad1[4];
432 __le16 suspend_state;
433 u8 sci_cfg;
434 u8 eci_cfg;
435 u8 device_cfg;
436 } __packed;
438 /* GPIO modes */
439 #define CP210X_SCI_GPIO_MODE_OFFSET 9
440 #define CP210X_SCI_GPIO_MODE_MASK GENMASK(11, 9)
442 #define CP210X_ECI_GPIO_MODE_OFFSET 2
443 #define CP210X_ECI_GPIO_MODE_MASK GENMASK(3, 2)
445 /* CP2105 port configuration values */
446 #define CP2105_GPIO0_TXLED_MODE BIT(0)
447 #define CP2105_GPIO1_RXLED_MODE BIT(1)
448 #define CP2105_GPIO1_RS485_MODE BIT(2)
450 /* CP210X_VENDOR_SPECIFIC, CP210X_WRITE_LATCH call writes these 0x2 bytes. */
451 struct cp210x_gpio_write {
452 u8 mask;
453 u8 state;
454 } __packed;
457 * Helper to get interface number when we only have struct usb_serial.
459 static u8 cp210x_interface_num(struct usb_serial *serial)
461 struct usb_host_interface *cur_altsetting;
463 cur_altsetting = serial->interface->cur_altsetting;
465 return cur_altsetting->desc.bInterfaceNumber;
469 * Reads a variable-sized block of CP210X_ registers, identified by req.
470 * Returns data into buf in native USB byte order.
472 static int cp210x_read_reg_block(struct usb_serial_port *port, u8 req,
473 void *buf, int bufsize)
475 struct usb_serial *serial = port->serial;
476 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
477 void *dmabuf;
478 int result;
480 dmabuf = kmalloc(bufsize, GFP_KERNEL);
481 if (!dmabuf) {
483 * FIXME Some callers don't bother to check for error,
484 * at least give them consistent junk until they are fixed
486 memset(buf, 0, bufsize);
487 return -ENOMEM;
490 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
491 req, REQTYPE_INTERFACE_TO_HOST, 0,
492 port_priv->bInterfaceNumber, dmabuf, bufsize,
493 USB_CTRL_SET_TIMEOUT);
494 if (result == bufsize) {
495 memcpy(buf, dmabuf, bufsize);
496 result = 0;
497 } else {
498 dev_err(&port->dev, "failed get req 0x%x size %d status: %d\n",
499 req, bufsize, result);
500 if (result >= 0)
501 result = -EIO;
504 * FIXME Some callers don't bother to check for error,
505 * at least give them consistent junk until they are fixed
507 memset(buf, 0, bufsize);
510 kfree(dmabuf);
512 return result;
516 * Reads any 32-bit CP210X_ register identified by req.
518 static int cp210x_read_u32_reg(struct usb_serial_port *port, u8 req, u32 *val)
520 __le32 le32_val;
521 int err;
523 err = cp210x_read_reg_block(port, req, &le32_val, sizeof(le32_val));
524 if (err) {
526 * FIXME Some callers don't bother to check for error,
527 * at least give them consistent junk until they are fixed
529 *val = 0;
530 return err;
533 *val = le32_to_cpu(le32_val);
535 return 0;
539 * Reads any 16-bit CP210X_ register identified by req.
541 static int cp210x_read_u16_reg(struct usb_serial_port *port, u8 req, u16 *val)
543 __le16 le16_val;
544 int err;
546 err = cp210x_read_reg_block(port, req, &le16_val, sizeof(le16_val));
547 if (err)
548 return err;
550 *val = le16_to_cpu(le16_val);
552 return 0;
556 * Reads any 8-bit CP210X_ register identified by req.
558 static int cp210x_read_u8_reg(struct usb_serial_port *port, u8 req, u8 *val)
560 return cp210x_read_reg_block(port, req, val, sizeof(*val));
564 * Reads a variable-sized vendor block of CP210X_ registers, identified by val.
565 * Returns data into buf in native USB byte order.
567 static int cp210x_read_vendor_block(struct usb_serial *serial, u8 type, u16 val,
568 void *buf, int bufsize)
570 void *dmabuf;
571 int result;
573 dmabuf = kmalloc(bufsize, GFP_KERNEL);
574 if (!dmabuf)
575 return -ENOMEM;
577 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
578 CP210X_VENDOR_SPECIFIC, type, val,
579 cp210x_interface_num(serial), dmabuf, bufsize,
580 USB_CTRL_GET_TIMEOUT);
581 if (result == bufsize) {
582 memcpy(buf, dmabuf, bufsize);
583 result = 0;
584 } else {
585 dev_err(&serial->interface->dev,
586 "failed to get vendor val 0x%04x size %d: %d\n", val,
587 bufsize, result);
588 if (result >= 0)
589 result = -EIO;
592 kfree(dmabuf);
594 return result;
598 * Writes any 16-bit CP210X_ register (req) whose value is passed
599 * entirely in the wValue field of the USB request.
601 static int cp210x_write_u16_reg(struct usb_serial_port *port, u8 req, u16 val)
603 struct usb_serial *serial = port->serial;
604 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
605 int result;
607 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
608 req, REQTYPE_HOST_TO_INTERFACE, val,
609 port_priv->bInterfaceNumber, NULL, 0,
610 USB_CTRL_SET_TIMEOUT);
611 if (result < 0) {
612 dev_err(&port->dev, "failed set request 0x%x status: %d\n",
613 req, result);
616 return result;
620 * Writes a variable-sized block of CP210X_ registers, identified by req.
621 * Data in buf must be in native USB byte order.
623 static int cp210x_write_reg_block(struct usb_serial_port *port, u8 req,
624 void *buf, int bufsize)
626 struct usb_serial *serial = port->serial;
627 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
628 void *dmabuf;
629 int result;
631 dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
632 if (!dmabuf)
633 return -ENOMEM;
635 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
636 req, REQTYPE_HOST_TO_INTERFACE, 0,
637 port_priv->bInterfaceNumber, dmabuf, bufsize,
638 USB_CTRL_SET_TIMEOUT);
640 kfree(dmabuf);
642 if (result == bufsize) {
643 result = 0;
644 } else {
645 dev_err(&port->dev, "failed set req 0x%x size %d status: %d\n",
646 req, bufsize, result);
647 if (result >= 0)
648 result = -EIO;
651 return result;
655 * Writes any 32-bit CP210X_ register identified by req.
657 static int cp210x_write_u32_reg(struct usb_serial_port *port, u8 req, u32 val)
659 __le32 le32_val;
661 le32_val = cpu_to_le32(val);
663 return cp210x_write_reg_block(port, req, &le32_val, sizeof(le32_val));
666 #ifdef CONFIG_GPIOLIB
668 * Writes a variable-sized vendor block of CP210X_ registers, identified by val.
669 * Data in buf must be in native USB byte order.
671 static int cp210x_write_vendor_block(struct usb_serial *serial, u8 type,
672 u16 val, void *buf, int bufsize)
674 void *dmabuf;
675 int result;
677 dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
678 if (!dmabuf)
679 return -ENOMEM;
681 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
682 CP210X_VENDOR_SPECIFIC, type, val,
683 cp210x_interface_num(serial), dmabuf, bufsize,
684 USB_CTRL_SET_TIMEOUT);
686 kfree(dmabuf);
688 if (result == bufsize) {
689 result = 0;
690 } else {
691 dev_err(&serial->interface->dev,
692 "failed to set vendor val 0x%04x size %d: %d\n", val,
693 bufsize, result);
694 if (result >= 0)
695 result = -EIO;
698 return result;
700 #endif
703 * Detect CP2108 GET_LINE_CTL bug and activate workaround.
704 * Write a known good value 0x800, read it back.
705 * If it comes back swapped the bug is detected.
706 * Preserve the original register value.
708 static int cp210x_detect_swapped_line_ctl(struct usb_serial_port *port)
710 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
711 u16 line_ctl_save;
712 u16 line_ctl_test;
713 int err;
715 err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_save);
716 if (err)
717 return err;
719 err = cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, 0x800);
720 if (err)
721 return err;
723 err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_test);
724 if (err)
725 return err;
727 if (line_ctl_test == 8) {
728 port_priv->has_swapped_line_ctl = true;
729 line_ctl_save = swab16(line_ctl_save);
732 return cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, line_ctl_save);
736 * Must always be called instead of cp210x_read_u16_reg(CP210X_GET_LINE_CTL)
737 * to workaround cp2108 bug and get correct value.
739 static int cp210x_get_line_ctl(struct usb_serial_port *port, u16 *ctl)
741 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
742 int err;
744 err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, ctl);
745 if (err)
746 return err;
748 /* Workaround swapped bytes in 16-bit value from CP210X_GET_LINE_CTL */
749 if (port_priv->has_swapped_line_ctl)
750 *ctl = swab16(*ctl);
752 return 0;
756 * cp210x_quantise_baudrate
757 * Quantises the baud rate as per AN205 Table 1
759 static unsigned int cp210x_quantise_baudrate(unsigned int baud)
761 if (baud <= 300)
762 baud = 300;
763 else if (baud <= 600) baud = 600;
764 else if (baud <= 1200) baud = 1200;
765 else if (baud <= 1800) baud = 1800;
766 else if (baud <= 2400) baud = 2400;
767 else if (baud <= 4000) baud = 4000;
768 else if (baud <= 4803) baud = 4800;
769 else if (baud <= 7207) baud = 7200;
770 else if (baud <= 9612) baud = 9600;
771 else if (baud <= 14428) baud = 14400;
772 else if (baud <= 16062) baud = 16000;
773 else if (baud <= 19250) baud = 19200;
774 else if (baud <= 28912) baud = 28800;
775 else if (baud <= 38601) baud = 38400;
776 else if (baud <= 51558) baud = 51200;
777 else if (baud <= 56280) baud = 56000;
778 else if (baud <= 58053) baud = 57600;
779 else if (baud <= 64111) baud = 64000;
780 else if (baud <= 77608) baud = 76800;
781 else if (baud <= 117028) baud = 115200;
782 else if (baud <= 129347) baud = 128000;
783 else if (baud <= 156868) baud = 153600;
784 else if (baud <= 237832) baud = 230400;
785 else if (baud <= 254234) baud = 250000;
786 else if (baud <= 273066) baud = 256000;
787 else if (baud <= 491520) baud = 460800;
788 else if (baud <= 567138) baud = 500000;
789 else if (baud <= 670254) baud = 576000;
790 else if (baud < 1000000)
791 baud = 921600;
792 else if (baud > 2000000)
793 baud = 2000000;
794 return baud;
797 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
799 int result;
801 result = cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_ENABLE);
802 if (result) {
803 dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
804 return result;
807 /* Configure the termios structure */
808 cp210x_get_termios(tty, port);
810 /* The baud rate must be initialised on cp2104 */
811 if (tty)
812 cp210x_change_speed(tty, port, NULL);
814 return usb_serial_generic_open(tty, port);
817 static void cp210x_close(struct usb_serial_port *port)
819 usb_serial_generic_close(port);
821 /* Clear both queues; cp2108 needs this to avoid an occasional hang */
822 cp210x_write_u16_reg(port, CP210X_PURGE, PURGE_ALL);
824 cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
828 * Read how many bytes are waiting in the TX queue.
830 static int cp210x_get_tx_queue_byte_count(struct usb_serial_port *port,
831 u32 *count)
833 struct usb_serial *serial = port->serial;
834 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
835 struct cp210x_comm_status *sts;
836 int result;
838 sts = kmalloc(sizeof(*sts), GFP_KERNEL);
839 if (!sts)
840 return -ENOMEM;
842 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
843 CP210X_GET_COMM_STATUS, REQTYPE_INTERFACE_TO_HOST,
844 0, port_priv->bInterfaceNumber, sts, sizeof(*sts),
845 USB_CTRL_GET_TIMEOUT);
846 if (result == sizeof(*sts)) {
847 *count = le32_to_cpu(sts->ulAmountInOutQueue);
848 result = 0;
849 } else {
850 dev_err(&port->dev, "failed to get comm status: %d\n", result);
851 if (result >= 0)
852 result = -EIO;
855 kfree(sts);
857 return result;
860 static bool cp210x_tx_empty(struct usb_serial_port *port)
862 int err;
863 u32 count;
865 err = cp210x_get_tx_queue_byte_count(port, &count);
866 if (err)
867 return true;
869 return !count;
873 * cp210x_get_termios
874 * Reads the baud rate, data bits, parity, stop bits and flow control mode
875 * from the device, corrects any unsupported values, and configures the
876 * termios structure to reflect the state of the device
878 static void cp210x_get_termios(struct tty_struct *tty,
879 struct usb_serial_port *port)
881 unsigned int baud;
883 if (tty) {
884 cp210x_get_termios_port(tty->driver_data,
885 &tty->termios.c_cflag, &baud);
886 tty_encode_baud_rate(tty, baud, baud);
887 } else {
888 tcflag_t cflag;
889 cflag = 0;
890 cp210x_get_termios_port(port, &cflag, &baud);
895 * cp210x_get_termios_port
896 * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
898 static void cp210x_get_termios_port(struct usb_serial_port *port,
899 tcflag_t *cflagp, unsigned int *baudp)
901 struct device *dev = &port->dev;
902 tcflag_t cflag;
903 struct cp210x_flow_ctl flow_ctl;
904 u32 baud;
905 u16 bits;
906 u32 ctl_hs;
908 cp210x_read_u32_reg(port, CP210X_GET_BAUDRATE, &baud);
910 dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud);
911 *baudp = baud;
913 cflag = *cflagp;
915 cp210x_get_line_ctl(port, &bits);
916 cflag &= ~CSIZE;
917 switch (bits & BITS_DATA_MASK) {
918 case BITS_DATA_5:
919 dev_dbg(dev, "%s - data bits = 5\n", __func__);
920 cflag |= CS5;
921 break;
922 case BITS_DATA_6:
923 dev_dbg(dev, "%s - data bits = 6\n", __func__);
924 cflag |= CS6;
925 break;
926 case BITS_DATA_7:
927 dev_dbg(dev, "%s - data bits = 7\n", __func__);
928 cflag |= CS7;
929 break;
930 case BITS_DATA_8:
931 dev_dbg(dev, "%s - data bits = 8\n", __func__);
932 cflag |= CS8;
933 break;
934 case BITS_DATA_9:
935 dev_dbg(dev, "%s - data bits = 9 (not supported, using 8 data bits)\n", __func__);
936 cflag |= CS8;
937 bits &= ~BITS_DATA_MASK;
938 bits |= BITS_DATA_8;
939 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
940 break;
941 default:
942 dev_dbg(dev, "%s - Unknown number of data bits, using 8\n", __func__);
943 cflag |= CS8;
944 bits &= ~BITS_DATA_MASK;
945 bits |= BITS_DATA_8;
946 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
947 break;
950 switch (bits & BITS_PARITY_MASK) {
951 case BITS_PARITY_NONE:
952 dev_dbg(dev, "%s - parity = NONE\n", __func__);
953 cflag &= ~PARENB;
954 break;
955 case BITS_PARITY_ODD:
956 dev_dbg(dev, "%s - parity = ODD\n", __func__);
957 cflag |= (PARENB|PARODD);
958 break;
959 case BITS_PARITY_EVEN:
960 dev_dbg(dev, "%s - parity = EVEN\n", __func__);
961 cflag &= ~PARODD;
962 cflag |= PARENB;
963 break;
964 case BITS_PARITY_MARK:
965 dev_dbg(dev, "%s - parity = MARK\n", __func__);
966 cflag |= (PARENB|PARODD|CMSPAR);
967 break;
968 case BITS_PARITY_SPACE:
969 dev_dbg(dev, "%s - parity = SPACE\n", __func__);
970 cflag &= ~PARODD;
971 cflag |= (PARENB|CMSPAR);
972 break;
973 default:
974 dev_dbg(dev, "%s - Unknown parity mode, disabling parity\n", __func__);
975 cflag &= ~PARENB;
976 bits &= ~BITS_PARITY_MASK;
977 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
978 break;
981 cflag &= ~CSTOPB;
982 switch (bits & BITS_STOP_MASK) {
983 case BITS_STOP_1:
984 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
985 break;
986 case BITS_STOP_1_5:
987 dev_dbg(dev, "%s - stop bits = 1.5 (not supported, using 1 stop bit)\n", __func__);
988 bits &= ~BITS_STOP_MASK;
989 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
990 break;
991 case BITS_STOP_2:
992 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
993 cflag |= CSTOPB;
994 break;
995 default:
996 dev_dbg(dev, "%s - Unknown number of stop bits, using 1 stop bit\n", __func__);
997 bits &= ~BITS_STOP_MASK;
998 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
999 break;
1002 cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1003 sizeof(flow_ctl));
1004 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1005 if (ctl_hs & CP210X_SERIAL_CTS_HANDSHAKE) {
1006 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
1007 cflag |= CRTSCTS;
1008 } else {
1009 dev_dbg(dev, "%s - flow control = NONE\n", __func__);
1010 cflag &= ~CRTSCTS;
1013 *cflagp = cflag;
1017 * CP2101 supports the following baud rates:
1019 * 300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
1020 * 38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
1022 * CP2102 and CP2103 support the following additional rates:
1024 * 4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
1025 * 576000
1027 * The device will map a requested rate to a supported one, but the result
1028 * of requests for rates greater than 1053257 is undefined (see AN205).
1030 * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
1031 * respectively, with an error less than 1%. The actual rates are determined
1032 * by
1034 * div = round(freq / (2 x prescale x request))
1035 * actual = freq / (2 x prescale x div)
1037 * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
1038 * or 1 otherwise.
1039 * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
1040 * otherwise.
1042 static void cp210x_change_speed(struct tty_struct *tty,
1043 struct usb_serial_port *port, struct ktermios *old_termios)
1045 u32 baud;
1047 baud = tty->termios.c_ospeed;
1049 /* This maps the requested rate to a rate valid on cp2102 or cp2103,
1050 * or to an arbitrary rate in [1M,2M].
1052 * NOTE: B0 is not implemented.
1054 baud = cp210x_quantise_baudrate(baud);
1056 dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
1057 if (cp210x_write_u32_reg(port, CP210X_SET_BAUDRATE, baud)) {
1058 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
1059 if (old_termios)
1060 baud = old_termios->c_ospeed;
1061 else
1062 baud = 9600;
1065 tty_encode_baud_rate(tty, baud, baud);
1068 static void cp210x_set_termios(struct tty_struct *tty,
1069 struct usb_serial_port *port, struct ktermios *old_termios)
1071 struct device *dev = &port->dev;
1072 unsigned int cflag, old_cflag;
1073 u16 bits;
1075 cflag = tty->termios.c_cflag;
1076 old_cflag = old_termios->c_cflag;
1078 if (tty->termios.c_ospeed != old_termios->c_ospeed)
1079 cp210x_change_speed(tty, port, old_termios);
1081 /* If the number of data bits is to be updated */
1082 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
1083 cp210x_get_line_ctl(port, &bits);
1084 bits &= ~BITS_DATA_MASK;
1085 switch (cflag & CSIZE) {
1086 case CS5:
1087 bits |= BITS_DATA_5;
1088 dev_dbg(dev, "%s - data bits = 5\n", __func__);
1089 break;
1090 case CS6:
1091 bits |= BITS_DATA_6;
1092 dev_dbg(dev, "%s - data bits = 6\n", __func__);
1093 break;
1094 case CS7:
1095 bits |= BITS_DATA_7;
1096 dev_dbg(dev, "%s - data bits = 7\n", __func__);
1097 break;
1098 case CS8:
1099 default:
1100 bits |= BITS_DATA_8;
1101 dev_dbg(dev, "%s - data bits = 8\n", __func__);
1102 break;
1104 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1105 dev_dbg(dev, "Number of data bits requested not supported by device\n");
1108 if ((cflag & (PARENB|PARODD|CMSPAR)) !=
1109 (old_cflag & (PARENB|PARODD|CMSPAR))) {
1110 cp210x_get_line_ctl(port, &bits);
1111 bits &= ~BITS_PARITY_MASK;
1112 if (cflag & PARENB) {
1113 if (cflag & CMSPAR) {
1114 if (cflag & PARODD) {
1115 bits |= BITS_PARITY_MARK;
1116 dev_dbg(dev, "%s - parity = MARK\n", __func__);
1117 } else {
1118 bits |= BITS_PARITY_SPACE;
1119 dev_dbg(dev, "%s - parity = SPACE\n", __func__);
1121 } else {
1122 if (cflag & PARODD) {
1123 bits |= BITS_PARITY_ODD;
1124 dev_dbg(dev, "%s - parity = ODD\n", __func__);
1125 } else {
1126 bits |= BITS_PARITY_EVEN;
1127 dev_dbg(dev, "%s - parity = EVEN\n", __func__);
1131 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1132 dev_dbg(dev, "Parity mode not supported by device\n");
1135 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
1136 cp210x_get_line_ctl(port, &bits);
1137 bits &= ~BITS_STOP_MASK;
1138 if (cflag & CSTOPB) {
1139 bits |= BITS_STOP_2;
1140 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
1141 } else {
1142 bits |= BITS_STOP_1;
1143 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
1145 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1146 dev_dbg(dev, "Number of stop bits requested not supported by device\n");
1149 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
1150 struct cp210x_flow_ctl flow_ctl;
1151 u32 ctl_hs;
1152 u32 flow_repl;
1154 cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1155 sizeof(flow_ctl));
1156 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1157 flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1158 dev_dbg(dev, "%s - read ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1159 __func__, ctl_hs, flow_repl);
1161 ctl_hs &= ~CP210X_SERIAL_DSR_HANDSHAKE;
1162 ctl_hs &= ~CP210X_SERIAL_DCD_HANDSHAKE;
1163 ctl_hs &= ~CP210X_SERIAL_DSR_SENSITIVITY;
1164 ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1165 ctl_hs |= CP210X_SERIAL_DTR_SHIFT(CP210X_SERIAL_DTR_ACTIVE);
1166 if (cflag & CRTSCTS) {
1167 ctl_hs |= CP210X_SERIAL_CTS_HANDSHAKE;
1169 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1170 flow_repl |= CP210X_SERIAL_RTS_SHIFT(
1171 CP210X_SERIAL_RTS_FLOW_CTL);
1172 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
1173 } else {
1174 ctl_hs &= ~CP210X_SERIAL_CTS_HANDSHAKE;
1176 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1177 flow_repl |= CP210X_SERIAL_RTS_SHIFT(
1178 CP210X_SERIAL_RTS_ACTIVE);
1179 dev_dbg(dev, "%s - flow control = NONE\n", __func__);
1182 dev_dbg(dev, "%s - write ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1183 __func__, ctl_hs, flow_repl);
1184 flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1185 flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1186 cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1187 sizeof(flow_ctl));
1192 static int cp210x_tiocmset(struct tty_struct *tty,
1193 unsigned int set, unsigned int clear)
1195 struct usb_serial_port *port = tty->driver_data;
1196 return cp210x_tiocmset_port(port, set, clear);
1199 static int cp210x_tiocmset_port(struct usb_serial_port *port,
1200 unsigned int set, unsigned int clear)
1202 u16 control = 0;
1204 if (set & TIOCM_RTS) {
1205 control |= CONTROL_RTS;
1206 control |= CONTROL_WRITE_RTS;
1208 if (set & TIOCM_DTR) {
1209 control |= CONTROL_DTR;
1210 control |= CONTROL_WRITE_DTR;
1212 if (clear & TIOCM_RTS) {
1213 control &= ~CONTROL_RTS;
1214 control |= CONTROL_WRITE_RTS;
1216 if (clear & TIOCM_DTR) {
1217 control &= ~CONTROL_DTR;
1218 control |= CONTROL_WRITE_DTR;
1221 dev_dbg(&port->dev, "%s - control = 0x%.4x\n", __func__, control);
1223 return cp210x_write_u16_reg(port, CP210X_SET_MHS, control);
1226 static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
1228 if (on)
1229 cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
1230 else
1231 cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
1234 static int cp210x_tiocmget(struct tty_struct *tty)
1236 struct usb_serial_port *port = tty->driver_data;
1237 u8 control;
1238 int result;
1240 result = cp210x_read_u8_reg(port, CP210X_GET_MDMSTS, &control);
1241 if (result)
1242 return result;
1244 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
1245 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
1246 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
1247 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
1248 |((control & CONTROL_RING)? TIOCM_RI : 0)
1249 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
1251 dev_dbg(&port->dev, "%s - control = 0x%.2x\n", __func__, control);
1253 return result;
1256 static void cp210x_break_ctl(struct tty_struct *tty, int break_state)
1258 struct usb_serial_port *port = tty->driver_data;
1259 u16 state;
1261 if (break_state == 0)
1262 state = BREAK_OFF;
1263 else
1264 state = BREAK_ON;
1265 dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
1266 state == BREAK_OFF ? "off" : "on");
1267 cp210x_write_u16_reg(port, CP210X_SET_BREAK, state);
1270 #ifdef CONFIG_GPIOLIB
1271 static int cp210x_gpio_request(struct gpio_chip *gc, unsigned int offset)
1273 struct usb_serial *serial = gpiochip_get_data(gc);
1274 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1276 switch (offset) {
1277 case 0:
1278 if (priv->config & CP2105_GPIO0_TXLED_MODE)
1279 return -ENODEV;
1280 break;
1281 case 1:
1282 if (priv->config & (CP2105_GPIO1_RXLED_MODE |
1283 CP2105_GPIO1_RS485_MODE))
1284 return -ENODEV;
1285 break;
1288 return 0;
1291 static int cp210x_gpio_get(struct gpio_chip *gc, unsigned int gpio)
1293 struct usb_serial *serial = gpiochip_get_data(gc);
1294 int result;
1295 u8 buf;
1297 result = cp210x_read_vendor_block(serial, REQTYPE_INTERFACE_TO_HOST,
1298 CP210X_READ_LATCH, &buf, sizeof(buf));
1299 if (result < 0)
1300 return result;
1302 return !!(buf & BIT(gpio));
1305 static void cp210x_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)
1307 struct usb_serial *serial = gpiochip_get_data(gc);
1308 struct cp210x_gpio_write buf;
1310 if (value == 1)
1311 buf.state = BIT(gpio);
1312 else
1313 buf.state = 0;
1315 buf.mask = BIT(gpio);
1317 cp210x_write_vendor_block(serial, REQTYPE_HOST_TO_INTERFACE,
1318 CP210X_WRITE_LATCH, &buf, sizeof(buf));
1321 static int cp210x_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
1323 /* Hardware does not support an input mode */
1324 return 0;
1327 static int cp210x_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
1329 /* Hardware does not support an input mode */
1330 return -ENOTSUPP;
1333 static int cp210x_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
1334 int value)
1336 return 0;
1339 static int cp210x_gpio_set_config(struct gpio_chip *gc, unsigned int gpio,
1340 unsigned long config)
1342 struct usb_serial *serial = gpiochip_get_data(gc);
1343 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1344 enum pin_config_param param = pinconf_to_config_param(config);
1346 /* Succeed only if in correct mode (this can't be set at runtime) */
1347 if ((param == PIN_CONFIG_DRIVE_PUSH_PULL) &&
1348 (priv->gpio_mode & BIT(gpio)))
1349 return 0;
1351 if ((param == PIN_CONFIG_DRIVE_OPEN_DRAIN) &&
1352 !(priv->gpio_mode & BIT(gpio)))
1353 return 0;
1355 return -ENOTSUPP;
1359 * This function is for configuring GPIO using shared pins, where other signals
1360 * are made unavailable by configuring the use of GPIO. This is believed to be
1361 * only applicable to the cp2105 at this point, the other devices supported by
1362 * this driver that provide GPIO do so in a way that does not impact other
1363 * signals and are thus expected to have very different initialisation.
1365 static int cp2105_shared_gpio_init(struct usb_serial *serial)
1367 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1368 struct cp210x_pin_mode mode;
1369 struct cp210x_config config;
1370 u8 intf_num = cp210x_interface_num(serial);
1371 int result;
1373 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1374 CP210X_GET_DEVICEMODE, &mode,
1375 sizeof(mode));
1376 if (result < 0)
1377 return result;
1379 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1380 CP210X_GET_PORTCONFIG, &config,
1381 sizeof(config));
1382 if (result < 0)
1383 return result;
1385 /* 2 banks of GPIO - One for the pins taken from each serial port */
1386 if (intf_num == 0) {
1387 if (mode.eci == CP210X_PIN_MODE_MODEM)
1388 return 0;
1390 priv->config = config.eci_cfg;
1391 priv->gpio_mode = (u8)((le16_to_cpu(config.gpio_mode) &
1392 CP210X_ECI_GPIO_MODE_MASK) >>
1393 CP210X_ECI_GPIO_MODE_OFFSET);
1394 priv->gc.ngpio = 2;
1395 } else if (intf_num == 1) {
1396 if (mode.sci == CP210X_PIN_MODE_MODEM)
1397 return 0;
1399 priv->config = config.sci_cfg;
1400 priv->gpio_mode = (u8)((le16_to_cpu(config.gpio_mode) &
1401 CP210X_SCI_GPIO_MODE_MASK) >>
1402 CP210X_SCI_GPIO_MODE_OFFSET);
1403 priv->gc.ngpio = 3;
1404 } else {
1405 return -ENODEV;
1408 priv->gc.label = "cp210x";
1409 priv->gc.request = cp210x_gpio_request;
1410 priv->gc.get_direction = cp210x_gpio_direction_get;
1411 priv->gc.direction_input = cp210x_gpio_direction_input;
1412 priv->gc.direction_output = cp210x_gpio_direction_output;
1413 priv->gc.get = cp210x_gpio_get;
1414 priv->gc.set = cp210x_gpio_set;
1415 priv->gc.set_config = cp210x_gpio_set_config;
1416 priv->gc.owner = THIS_MODULE;
1417 priv->gc.parent = &serial->interface->dev;
1418 priv->gc.base = -1;
1419 priv->gc.can_sleep = true;
1421 result = gpiochip_add_data(&priv->gc, serial);
1422 if (!result)
1423 priv->gpio_registered = true;
1425 return result;
1428 static void cp210x_gpio_remove(struct usb_serial *serial)
1430 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1432 if (priv->gpio_registered) {
1433 gpiochip_remove(&priv->gc);
1434 priv->gpio_registered = false;
1438 #else
1440 static int cp2105_shared_gpio_init(struct usb_serial *serial)
1442 return 0;
1445 static void cp210x_gpio_remove(struct usb_serial *serial)
1447 /* Nothing to do */
1450 #endif
1452 static int cp210x_port_probe(struct usb_serial_port *port)
1454 struct usb_serial *serial = port->serial;
1455 struct cp210x_port_private *port_priv;
1456 int ret;
1458 port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
1459 if (!port_priv)
1460 return -ENOMEM;
1462 port_priv->bInterfaceNumber = cp210x_interface_num(serial);
1464 usb_set_serial_port_data(port, port_priv);
1466 ret = cp210x_detect_swapped_line_ctl(port);
1467 if (ret) {
1468 kfree(port_priv);
1469 return ret;
1472 return 0;
1475 static int cp210x_port_remove(struct usb_serial_port *port)
1477 struct cp210x_port_private *port_priv;
1479 port_priv = usb_get_serial_port_data(port);
1480 kfree(port_priv);
1482 return 0;
1485 static int cp210x_attach(struct usb_serial *serial)
1487 int result;
1488 struct cp210x_serial_private *priv;
1490 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1491 if (!priv)
1492 return -ENOMEM;
1494 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1495 CP210X_GET_PARTNUM, &priv->partnum,
1496 sizeof(priv->partnum));
1497 if (result < 0) {
1498 dev_warn(&serial->interface->dev,
1499 "querying part number failed\n");
1500 priv->partnum = CP210X_PARTNUM_UNKNOWN;
1503 usb_set_serial_data(serial, priv);
1505 if (priv->partnum == CP210X_PARTNUM_CP2105) {
1506 result = cp2105_shared_gpio_init(serial);
1507 if (result < 0) {
1508 dev_err(&serial->interface->dev,
1509 "GPIO initialisation failed, continuing without GPIO support\n");
1513 return 0;
1516 static void cp210x_disconnect(struct usb_serial *serial)
1518 cp210x_gpio_remove(serial);
1521 static void cp210x_release(struct usb_serial *serial)
1523 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1525 cp210x_gpio_remove(serial);
1527 kfree(priv);
1530 module_usb_serial_driver(serial_drivers, id_table);
1532 MODULE_DESCRIPTION(DRIVER_DESC);
1533 MODULE_LICENSE("GPL v2");