?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Linux 4.14.51
[linux/fpc-iii.git] / drivers / usb / serial / cp210x.c
blobd0f00274d16c7f915d613a428b478a4528da2970
1 /*
2 * Silicon Laboratories CP210x USB to RS232 serial adaptor driver
3 *
4 * Copyright (C) 2005 Craig Shelley (craig@microtron.org.uk)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License version
8 * 2 as published by the Free Software Foundation.
9 *
10 * Support to set flow control line levels using TIOCMGET and TIOCMSET
11 * thanks to Karl Hiramoto karl@hiramoto.org. RTSCTS hardware flow
12 * control thanks to Munir Nassar nassarmu@real-time.com
13 *
14 */
15
16 #include <linux/kernel.h>
17 #include <linux/errno.h>
18 #include <linux/slab.h>
19 #include <linux/tty.h>
20 #include <linux/tty_flip.h>
21 #include <linux/module.h>
22 #include <linux/moduleparam.h>
23 #include <linux/usb.h>
24 #include <linux/uaccess.h>
25 #include <linux/usb/serial.h>
26 #include <linux/gpio/driver.h>
27 #include <linux/bitops.h>
28 #include <linux/mutex.h>
29
30 #define DRIVER_DESC "Silicon Labs CP210x RS232 serial adaptor driver"
31
32 /*
33 * Function Prototypes
34 */
35 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *);
36 static void cp210x_close(struct usb_serial_port *);
37 static void cp210x_get_termios(struct tty_struct *, struct usb_serial_port *);
38 static void cp210x_get_termios_port(struct usb_serial_port *port,
39 tcflag_t *cflagp, unsigned int *baudp);
40 static void cp210x_change_speed(struct tty_struct *, struct usb_serial_port *,
41 struct ktermios *);
42 static void cp210x_set_termios(struct tty_struct *, struct usb_serial_port *,
43 struct ktermios*);
44 static bool cp210x_tx_empty(struct usb_serial_port *port);
45 static int cp210x_tiocmget(struct tty_struct *);
46 static int cp210x_tiocmset(struct tty_struct *, unsigned int, unsigned int);
47 static int cp210x_tiocmset_port(struct usb_serial_port *port,
48 unsigned int, unsigned int);
49 static void cp210x_break_ctl(struct tty_struct *, int);
50 static int cp210x_attach(struct usb_serial *);
51 static void cp210x_disconnect(struct usb_serial *);
52 static void cp210x_release(struct usb_serial *);
53 static int cp210x_port_probe(struct usb_serial_port *);
54 static int cp210x_port_remove(struct usb_serial_port *);
55 static void cp210x_dtr_rts(struct usb_serial_port *p, int on);
56
57 static const struct usb_device_id id_table[] = {
58 { USB_DEVICE(0x045B, 0x0053) }, /* Renesas RX610 RX-Stick */
59 { USB_DEVICE(0x0471, 0x066A) }, /* AKTAKOM ACE-1001 cable */
60 { USB_DEVICE(0x0489, 0xE000) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
61 { USB_DEVICE(0x0489, 0xE003) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
62 { USB_DEVICE(0x0745, 0x1000) }, /* CipherLab USB CCD Barcode Scanner 1000 */
63 { USB_DEVICE(0x0846, 0x1100) }, /* NetGear Managed Switch M4100 series, M5300 series, M7100 series */
64 { USB_DEVICE(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
65 { USB_DEVICE(0x08FD, 0x000A) }, /* Digianswer A/S , ZigBee/802.15.4 MAC Device */
66 { USB_DEVICE(0x0908, 0x01FF) }, /* Siemens RUGGEDCOM USB Serial Console */
67 { USB_DEVICE(0x0BED, 0x1100) }, /* MEI (TM) Cashflow-SC Bill/Voucher Acceptor */
68 { USB_DEVICE(0x0BED, 0x1101) }, /* MEI series 2000 Combo Acceptor */
69 { USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
70 { USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
71 { USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */
72 { USB_DEVICE(0x0FDE, 0xCA05) }, /* OWL Wireless Electricity Monitor CM-160 */
73 { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
74 { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
75 { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
76 { USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */
77 { USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */
78 { USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */
79 { USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
80 { USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
81 { USB_DEVICE(0x10C4, 0x8044) }, /* Cygnal Debug Adapter */
82 { USB_DEVICE(0x10C4, 0x804E) }, /* Software Bisque Paramount ME build-in converter */
83 { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
84 { USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */
85 { USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
86 { USB_DEVICE(0x10C4, 0x806F) }, /* IMS USB to RS422 Converter Cable */
87 { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
88 { USB_DEVICE(0x10C4, 0x80C4) }, /* Cygnal Integrated Products, Inc., Optris infrared thermometer */
89 { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
90 { USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
91 { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
92 { USB_DEVICE(0x10C4, 0x8115) }, /* Arygon NFC/Mifare Reader */
93 { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
94 { USB_DEVICE(0x10C4, 0x813F) }, /* Tams Master Easy Control */
95 { USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
96 { USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
97 { USB_DEVICE(0x2405, 0x0003) }, /* West Mountain Radio RIGblaster Advantage */
98 { USB_DEVICE(0x10C4, 0x8156) }, /* B&G H3000 link cable */
99 { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
100 { USB_DEVICE(0x10C4, 0x815F) }, /* Timewave HamLinkUSB */
101 { USB_DEVICE(0x10C4, 0x818B) }, /* AVIT Research USB to TTL */
102 { USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
103 { USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
104 { USB_DEVICE(0x10C4, 0x81A9) }, /* Multiplex RC Interface */
105 { USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
106 { USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */
107 { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
108 { USB_DEVICE(0x10C4, 0x81D7) }, /* IAI Corp. RCB-CV-USB USB to RS485 Adaptor */
109 { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
110 { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
111 { USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
112 { USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
113 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
114 { USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
115 { USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
116 { USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */
117 { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
118 { USB_DEVICE(0x10C4, 0x82F4) }, /* Starizona MicroTouch */
119 { USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
120 { USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
121 { USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
122 { USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
123 { USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
124 { USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
125 { USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
126 { USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
127 { USB_DEVICE(0x10C4, 0x8470) }, /* Juniper Networks BX Series System Console */
128 { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
129 { USB_DEVICE(0x10C4, 0x84B6) }, /* Starizona Hyperion */
130 { USB_DEVICE(0x10C4, 0x85A7) }, /* LifeScan OneTouch Verio IQ */
131 { USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
132 { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
133 { USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
134 { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
135 { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
136 { USB_DEVICE(0x10C4, 0x8856) }, /* CEL EM357 ZigBee USB Stick - LR */
137 { USB_DEVICE(0x10C4, 0x8857) }, /* CEL EM357 ZigBee USB Stick */
138 { USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
139 { USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
140 { USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
141 { USB_DEVICE(0x10C4, 0x8962) }, /* Brim Brothers charging dock */
142 { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit Device */
143 { USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
144 { USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
145 { USB_DEVICE(0x10C4, 0x8A5E) }, /* CEL EM3588 ZigBee USB Stick Long Range */
146 { USB_DEVICE(0x10C4, 0x8B34) }, /* Qivicon ZigBee USB Radio Stick */
147 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
148 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
149 { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
150 { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
151 { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
152 { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
153 { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
154 { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
155 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
156 { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
157 { USB_DEVICE(0x12B8, 0xEC60) }, /* Link G4 ECU */
158 { USB_DEVICE(0x12B8, 0xEC62) }, /* Link G4+ ECU */
159 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
160 { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
161 { USB_DEVICE(0x155A, 0x1006) }, /* ELDAT Easywave RX09 */
162 { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
163 { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
164 { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
165 { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
166 { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
167 { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
168 { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
169 { USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
170 { USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
171 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
172 { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
173 { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
174 { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
175 { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
176 { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
177 { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
178 { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
179 { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
180 { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
181 { USB_DEVICE(0x18EF, 0xE025) }, /* ELV Marble Sound Board 1 */
182 { USB_DEVICE(0x18EF, 0xE030) }, /* ELV ALC 8xxx Battery Charger */
183 { USB_DEVICE(0x18EF, 0xE032) }, /* ELV TFD500 Data Logger */
184 { USB_DEVICE(0x1901, 0x0190) }, /* GE B850 CP2105 Recorder interface */
185 { USB_DEVICE(0x1901, 0x0193) }, /* GE B650 CP2104 PMC interface */
186 { USB_DEVICE(0x1901, 0x0194) }, /* GE Healthcare Remote Alarm Box */
187 { USB_DEVICE(0x1901, 0x0195) }, /* GE B850/B650/B450 CP2104 DP UART interface */
188 { USB_DEVICE(0x1901, 0x0196) }, /* GE B850 CP2105 DP UART interface */
189 { USB_DEVICE(0x19CF, 0x3000) }, /* Parrot NMEA GPS Flight Recorder */
190 { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
191 { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
192 { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
193 { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
194 { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
195 { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
196 { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
197 { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
198 { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
199 { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
200 { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
201 { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
202 { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
203 { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
204 { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
205 { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
206 { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
207 { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
208 { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
209 { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
210 { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
211 { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
212 { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
213 { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
214 { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
215 { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
216 { USB_DEVICE(0x2626, 0xEA60) }, /* Aruba Networks 7xxx USB Serial Console */
217 { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
218 { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
219 { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
220 { USB_DEVICE(0x3923, 0x7A0B) }, /* National Instruments USB Serial Console */
221 { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
222 { } /* Terminating Entry */
223 };
224
225 MODULE_DEVICE_TABLE(usb, id_table);
226
227 struct cp210x_serial_private {
228 #ifdef CONFIG_GPIOLIB
229 struct gpio_chip gc;
230 u8 config;
231 u8 gpio_mode;
232 bool gpio_registered;
233 #endif
234 u8 partnum;
235 };
236
237 struct cp210x_port_private {
238 __u8 bInterfaceNumber;
239 bool has_swapped_line_ctl;
240 };
241
242 static struct usb_serial_driver cp210x_device = {
243 .driver = {
244 .owner = THIS_MODULE,
245 .name = "cp210x",
246 },
247 .id_table = id_table,
248 .num_ports = 1,
249 .bulk_in_size = 256,
250 .bulk_out_size = 256,
251 .open = cp210x_open,
252 .close = cp210x_close,
253 .break_ctl = cp210x_break_ctl,
254 .set_termios = cp210x_set_termios,
255 .tx_empty = cp210x_tx_empty,
256 .tiocmget = cp210x_tiocmget,
257 .tiocmset = cp210x_tiocmset,
258 .attach = cp210x_attach,
259 .disconnect = cp210x_disconnect,
260 .release = cp210x_release,
261 .port_probe = cp210x_port_probe,
262 .port_remove = cp210x_port_remove,
263 .dtr_rts = cp210x_dtr_rts
264 };
265
266 static struct usb_serial_driver * const serial_drivers[] = {
267 &cp210x_device, NULL
268 };
269
270 /* Config request types */
271 #define REQTYPE_HOST_TO_INTERFACE 0x41
272 #define REQTYPE_INTERFACE_TO_HOST 0xc1
273 #define REQTYPE_HOST_TO_DEVICE 0x40
274 #define REQTYPE_DEVICE_TO_HOST 0xc0
275
276 /* Config request codes */
277 #define CP210X_IFC_ENABLE 0x00
278 #define CP210X_SET_BAUDDIV 0x01
279 #define CP210X_GET_BAUDDIV 0x02
280 #define CP210X_SET_LINE_CTL 0x03
281 #define CP210X_GET_LINE_CTL 0x04
282 #define CP210X_SET_BREAK 0x05
283 #define CP210X_IMM_CHAR 0x06
284 #define CP210X_SET_MHS 0x07
285 #define CP210X_GET_MDMSTS 0x08
286 #define CP210X_SET_XON 0x09
287 #define CP210X_SET_XOFF 0x0A
288 #define CP210X_SET_EVENTMASK 0x0B
289 #define CP210X_GET_EVENTMASK 0x0C
290 #define CP210X_SET_CHAR 0x0D
291 #define CP210X_GET_CHARS 0x0E
292 #define CP210X_GET_PROPS 0x0F
293 #define CP210X_GET_COMM_STATUS 0x10
294 #define CP210X_RESET 0x11
295 #define CP210X_PURGE 0x12
296 #define CP210X_SET_FLOW 0x13
297 #define CP210X_GET_FLOW 0x14
298 #define CP210X_EMBED_EVENTS 0x15
299 #define CP210X_GET_EVENTSTATE 0x16
300 #define CP210X_SET_CHARS 0x19
301 #define CP210X_GET_BAUDRATE 0x1D
302 #define CP210X_SET_BAUDRATE 0x1E
303 #define CP210X_VENDOR_SPECIFIC 0xFF
304
305 /* CP210X_IFC_ENABLE */
306 #define UART_ENABLE 0x0001
307 #define UART_DISABLE 0x0000
308
309 /* CP210X_(SET|GET)_BAUDDIV */
310 #define BAUD_RATE_GEN_FREQ 0x384000
311
312 /* CP210X_(SET|GET)_LINE_CTL */
313 #define BITS_DATA_MASK 0X0f00
314 #define BITS_DATA_5 0X0500
315 #define BITS_DATA_6 0X0600
316 #define BITS_DATA_7 0X0700
317 #define BITS_DATA_8 0X0800
318 #define BITS_DATA_9 0X0900
319
320 #define BITS_PARITY_MASK 0x00f0
321 #define BITS_PARITY_NONE 0x0000
322 #define BITS_PARITY_ODD 0x0010
323 #define BITS_PARITY_EVEN 0x0020
324 #define BITS_PARITY_MARK 0x0030
325 #define BITS_PARITY_SPACE 0x0040
326
327 #define BITS_STOP_MASK 0x000f
328 #define BITS_STOP_1 0x0000
329 #define BITS_STOP_1_5 0x0001
330 #define BITS_STOP_2 0x0002
331
332 /* CP210X_SET_BREAK */
333 #define BREAK_ON 0x0001
334 #define BREAK_OFF 0x0000
335
336 /* CP210X_(SET_MHS|GET_MDMSTS) */
337 #define CONTROL_DTR 0x0001
338 #define CONTROL_RTS 0x0002
339 #define CONTROL_CTS 0x0010
340 #define CONTROL_DSR 0x0020
341 #define CONTROL_RING 0x0040
342 #define CONTROL_DCD 0x0080
343 #define CONTROL_WRITE_DTR 0x0100
344 #define CONTROL_WRITE_RTS 0x0200
345
346 /* CP210X_VENDOR_SPECIFIC values */
347 #define CP210X_READ_LATCH 0x00C2
348 #define CP210X_GET_PARTNUM 0x370B
349 #define CP210X_GET_PORTCONFIG 0x370C
350 #define CP210X_GET_DEVICEMODE 0x3711
351 #define CP210X_WRITE_LATCH 0x37E1
352
353 /* Part number definitions */
354 #define CP210X_PARTNUM_CP2101 0x01
355 #define CP210X_PARTNUM_CP2102 0x02
356 #define CP210X_PARTNUM_CP2103 0x03
357 #define CP210X_PARTNUM_CP2104 0x04
358 #define CP210X_PARTNUM_CP2105 0x05
359 #define CP210X_PARTNUM_CP2108 0x08
360 #define CP210X_PARTNUM_UNKNOWN 0xFF
361
362 /* CP210X_GET_COMM_STATUS returns these 0x13 bytes */
363 struct cp210x_comm_status {
364 __le32 ulErrors;
365 __le32 ulHoldReasons;
366 __le32 ulAmountInInQueue;
367 __le32 ulAmountInOutQueue;
368 u8 bEofReceived;
369 u8 bWaitForImmediate;
370 u8 bReserved;
371 } __packed;
372
373 /*
374 * CP210X_PURGE - 16 bits passed in wValue of USB request.
375 * SiLabs app note AN571 gives a strange description of the 4 bits:
376 * bit 0 or bit 2 clears the transmit queue and 1 or 3 receive.
377 * writing 1 to all, however, purges cp2108 well enough to avoid the hang.
378 */
379 #define PURGE_ALL 0x000f
380
381 /* CP210X_GET_FLOW/CP210X_SET_FLOW read/write these 0x10 bytes */
382 struct cp210x_flow_ctl {
383 __le32 ulControlHandshake;
384 __le32 ulFlowReplace;
385 __le32 ulXonLimit;
386 __le32 ulXoffLimit;
387 } __packed;
388
389 /* cp210x_flow_ctl::ulControlHandshake */
390 #define CP210X_SERIAL_DTR_MASK GENMASK(1, 0)
391 #define CP210X_SERIAL_DTR_SHIFT(_mode) (_mode)
392 #define CP210X_SERIAL_CTS_HANDSHAKE BIT(3)
393 #define CP210X_SERIAL_DSR_HANDSHAKE BIT(4)
394 #define CP210X_SERIAL_DCD_HANDSHAKE BIT(5)
395 #define CP210X_SERIAL_DSR_SENSITIVITY BIT(6)
396
397 /* values for cp210x_flow_ctl::ulControlHandshake::CP210X_SERIAL_DTR_MASK */
398 #define CP210X_SERIAL_DTR_INACTIVE 0
399 #define CP210X_SERIAL_DTR_ACTIVE 1
400 #define CP210X_SERIAL_DTR_FLOW_CTL 2
401
402 /* cp210x_flow_ctl::ulFlowReplace */
403 #define CP210X_SERIAL_AUTO_TRANSMIT BIT(0)
404 #define CP210X_SERIAL_AUTO_RECEIVE BIT(1)
405 #define CP210X_SERIAL_ERROR_CHAR BIT(2)
406 #define CP210X_SERIAL_NULL_STRIPPING BIT(3)
407 #define CP210X_SERIAL_BREAK_CHAR BIT(4)
408 #define CP210X_SERIAL_RTS_MASK GENMASK(7, 6)
409 #define CP210X_SERIAL_RTS_SHIFT(_mode) (_mode << 6)
410 #define CP210X_SERIAL_XOFF_CONTINUE BIT(31)
411
412 /* values for cp210x_flow_ctl::ulFlowReplace::CP210X_SERIAL_RTS_MASK */
413 #define CP210X_SERIAL_RTS_INACTIVE 0
414 #define CP210X_SERIAL_RTS_ACTIVE 1
415 #define CP210X_SERIAL_RTS_FLOW_CTL 2
416
417 /* CP210X_VENDOR_SPECIFIC, CP210X_GET_DEVICEMODE call reads these 0x2 bytes. */
418 struct cp210x_pin_mode {
419 u8 eci;
420 u8 sci;
421 } __packed;
422
423 #define CP210X_PIN_MODE_MODEM 0
424 #define CP210X_PIN_MODE_GPIO BIT(0)
425
426 /*
427 * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xf bytes.
428 * Structure needs padding due to unused/unspecified bytes.
429 */
430 struct cp210x_config {
431 __le16 gpio_mode;
432 u8 __pad0[2];
433 __le16 reset_state;
434 u8 __pad1[4];
435 __le16 suspend_state;
436 u8 sci_cfg;
437 u8 eci_cfg;
438 u8 device_cfg;
439 } __packed;
440
441 /* GPIO modes */
442 #define CP210X_SCI_GPIO_MODE_OFFSET 9
443 #define CP210X_SCI_GPIO_MODE_MASK GENMASK(11, 9)
444
445 #define CP210X_ECI_GPIO_MODE_OFFSET 2
446 #define CP210X_ECI_GPIO_MODE_MASK GENMASK(3, 2)
447
448 /* CP2105 port configuration values */
449 #define CP2105_GPIO0_TXLED_MODE BIT(0)
450 #define CP2105_GPIO1_RXLED_MODE BIT(1)
451 #define CP2105_GPIO1_RS485_MODE BIT(2)
452
453 /* CP210X_VENDOR_SPECIFIC, CP210X_WRITE_LATCH call writes these 0x2 bytes. */
454 struct cp210x_gpio_write {
455 u8 mask;
456 u8 state;
457 } __packed;
458
459 /*
460 * Helper to get interface number when we only have struct usb_serial.
461 */
462 static u8 cp210x_interface_num(struct usb_serial *serial)
463 {
464 struct usb_host_interface *cur_altsetting;
465
466 cur_altsetting = serial->interface->cur_altsetting;
467
468 return cur_altsetting->desc.bInterfaceNumber;
469 }
470
471 /*
472 * Reads a variable-sized block of CP210X_ registers, identified by req.
473 * Returns data into buf in native USB byte order.
474 */
475 static int cp210x_read_reg_block(struct usb_serial_port *port, u8 req,
476 void *buf, int bufsize)
477 {
478 struct usb_serial *serial = port->serial;
479 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
480 void *dmabuf;
481 int result;
482
483 dmabuf = kmalloc(bufsize, GFP_KERNEL);
484 if (!dmabuf) {
485 /*
486 * FIXME Some callers don't bother to check for error,
487 * at least give them consistent junk until they are fixed
488 */
489 memset(buf, 0, bufsize);
490 return -ENOMEM;
491 }
492
493 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
494 req, REQTYPE_INTERFACE_TO_HOST, 0,
495 port_priv->bInterfaceNumber, dmabuf, bufsize,
496 USB_CTRL_SET_TIMEOUT);
497 if (result == bufsize) {
498 memcpy(buf, dmabuf, bufsize);
499 result = 0;
500 } else {
501 dev_err(&port->dev, "failed get req 0x%x size %d status: %d\n",
502 req, bufsize, result);
503 if (result >= 0)
504 result = -EIO;
505
506 /*
507 * FIXME Some callers don't bother to check for error,
508 * at least give them consistent junk until they are fixed
509 */
510 memset(buf, 0, bufsize);
511 }
512
513 kfree(dmabuf);
514
515 return result;
516 }
517
518 /*
519 * Reads any 32-bit CP210X_ register identified by req.
520 */
521 static int cp210x_read_u32_reg(struct usb_serial_port *port, u8 req, u32 *val)
522 {
523 __le32 le32_val;
524 int err;
525
526 err = cp210x_read_reg_block(port, req, &le32_val, sizeof(le32_val));
527 if (err) {
528 /*
529 * FIXME Some callers don't bother to check for error,
530 * at least give them consistent junk until they are fixed
531 */
532 *val = 0;
533 return err;
534 }
535
536 *val = le32_to_cpu(le32_val);
537
538 return 0;
539 }
540
541 /*
542 * Reads any 16-bit CP210X_ register identified by req.
543 */
544 static int cp210x_read_u16_reg(struct usb_serial_port *port, u8 req, u16 *val)
545 {
546 __le16 le16_val;
547 int err;
548
549 err = cp210x_read_reg_block(port, req, &le16_val, sizeof(le16_val));
550 if (err)
551 return err;
552
553 *val = le16_to_cpu(le16_val);
554
555 return 0;
556 }
557
558 /*
559 * Reads any 8-bit CP210X_ register identified by req.
560 */
561 static int cp210x_read_u8_reg(struct usb_serial_port *port, u8 req, u8 *val)
562 {
563 return cp210x_read_reg_block(port, req, val, sizeof(*val));
564 }
565
566 /*
567 * Reads a variable-sized vendor block of CP210X_ registers, identified by val.
568 * Returns data into buf in native USB byte order.
569 */
570 static int cp210x_read_vendor_block(struct usb_serial *serial, u8 type, u16 val,
571 void *buf, int bufsize)
572 {
573 void *dmabuf;
574 int result;
575
576 dmabuf = kmalloc(bufsize, GFP_KERNEL);
577 if (!dmabuf)
578 return -ENOMEM;
579
580 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
581 CP210X_VENDOR_SPECIFIC, type, val,
582 cp210x_interface_num(serial), dmabuf, bufsize,
583 USB_CTRL_GET_TIMEOUT);
584 if (result == bufsize) {
585 memcpy(buf, dmabuf, bufsize);
586 result = 0;
587 } else {
588 dev_err(&serial->interface->dev,
589 "failed to get vendor val 0x%04x size %d: %d\n", val,
590 bufsize, result);
591 if (result >= 0)
592 result = -EIO;
593 }
594
595 kfree(dmabuf);
596
597 return result;
598 }
599
600 /*
601 * Writes any 16-bit CP210X_ register (req) whose value is passed
602 * entirely in the wValue field of the USB request.
603 */
604 static int cp210x_write_u16_reg(struct usb_serial_port *port, u8 req, u16 val)
605 {
606 struct usb_serial *serial = port->serial;
607 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
608 int result;
609
610 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
611 req, REQTYPE_HOST_TO_INTERFACE, val,
612 port_priv->bInterfaceNumber, NULL, 0,
613 USB_CTRL_SET_TIMEOUT);
614 if (result < 0) {
615 dev_err(&port->dev, "failed set request 0x%x status: %d\n",
616 req, result);
617 }
618
619 return result;
620 }
621
622 /*
623 * Writes a variable-sized block of CP210X_ registers, identified by req.
624 * Data in buf must be in native USB byte order.
625 */
626 static int cp210x_write_reg_block(struct usb_serial_port *port, u8 req,
627 void *buf, int bufsize)
628 {
629 struct usb_serial *serial = port->serial;
630 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
631 void *dmabuf;
632 int result;
633
634 dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
635 if (!dmabuf)
636 return -ENOMEM;
637
638 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
639 req, REQTYPE_HOST_TO_INTERFACE, 0,
640 port_priv->bInterfaceNumber, dmabuf, bufsize,
641 USB_CTRL_SET_TIMEOUT);
642
643 kfree(dmabuf);
644
645 if (result == bufsize) {
646 result = 0;
647 } else {
648 dev_err(&port->dev, "failed set req 0x%x size %d status: %d\n",
649 req, bufsize, result);
650 if (result >= 0)
651 result = -EIO;
652 }
653
654 return result;
655 }
656
657 /*
658 * Writes any 32-bit CP210X_ register identified by req.
659 */
660 static int cp210x_write_u32_reg(struct usb_serial_port *port, u8 req, u32 val)
661 {
662 __le32 le32_val;
663
664 le32_val = cpu_to_le32(val);
665
666 return cp210x_write_reg_block(port, req, &le32_val, sizeof(le32_val));
667 }
668
669 #ifdef CONFIG_GPIOLIB
670 /*
671 * Writes a variable-sized vendor block of CP210X_ registers, identified by val.
672 * Data in buf must be in native USB byte order.
673 */
674 static int cp210x_write_vendor_block(struct usb_serial *serial, u8 type,
675 u16 val, void *buf, int bufsize)
676 {
677 void *dmabuf;
678 int result;
679
680 dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
681 if (!dmabuf)
682 return -ENOMEM;
683
684 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
685 CP210X_VENDOR_SPECIFIC, type, val,
686 cp210x_interface_num(serial), dmabuf, bufsize,
687 USB_CTRL_SET_TIMEOUT);
688
689 kfree(dmabuf);
690
691 if (result == bufsize) {
692 result = 0;
693 } else {
694 dev_err(&serial->interface->dev,
695 "failed to set vendor val 0x%04x size %d: %d\n", val,
696 bufsize, result);
697 if (result >= 0)
698 result = -EIO;
699 }
700
701 return result;
702 }
703 #endif
704
705 /*
706 * Detect CP2108 GET_LINE_CTL bug and activate workaround.
707 * Write a known good value 0x800, read it back.
708 * If it comes back swapped the bug is detected.
709 * Preserve the original register value.
710 */
711 static int cp210x_detect_swapped_line_ctl(struct usb_serial_port *port)
712 {
713 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
714 u16 line_ctl_save;
715 u16 line_ctl_test;
716 int err;
717
718 err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_save);
719 if (err)
720 return err;
721
722 err = cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, 0x800);
723 if (err)
724 return err;
725
726 err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_test);
727 if (err)
728 return err;
729
730 if (line_ctl_test == 8) {
731 port_priv->has_swapped_line_ctl = true;
732 line_ctl_save = swab16(line_ctl_save);
733 }
734
735 return cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, line_ctl_save);
736 }
737
738 /*
739 * Must always be called instead of cp210x_read_u16_reg(CP210X_GET_LINE_CTL)
740 * to workaround cp2108 bug and get correct value.
741 */
742 static int cp210x_get_line_ctl(struct usb_serial_port *port, u16 *ctl)
743 {
744 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
745 int err;
746
747 err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, ctl);
748 if (err)
749 return err;
750
751 /* Workaround swapped bytes in 16-bit value from CP210X_GET_LINE_CTL */
752 if (port_priv->has_swapped_line_ctl)
753 *ctl = swab16(*ctl);
754
755 return 0;
756 }
757
758 /*
759 * cp210x_quantise_baudrate
760 * Quantises the baud rate as per AN205 Table 1
761 */
762 static unsigned int cp210x_quantise_baudrate(unsigned int baud)
763 {
764 if (baud <= 300)
765 baud = 300;
766 else if (baud <= 600) baud = 600;
767 else if (baud <= 1200) baud = 1200;
768 else if (baud <= 1800) baud = 1800;
769 else if (baud <= 2400) baud = 2400;
770 else if (baud <= 4000) baud = 4000;
771 else if (baud <= 4803) baud = 4800;
772 else if (baud <= 7207) baud = 7200;
773 else if (baud <= 9612) baud = 9600;
774 else if (baud <= 14428) baud = 14400;
775 else if (baud <= 16062) baud = 16000;
776 else if (baud <= 19250) baud = 19200;
777 else if (baud <= 28912) baud = 28800;
778 else if (baud <= 38601) baud = 38400;
779 else if (baud <= 51558) baud = 51200;
780 else if (baud <= 56280) baud = 56000;
781 else if (baud <= 58053) baud = 57600;
782 else if (baud <= 64111) baud = 64000;
783 else if (baud <= 77608) baud = 76800;
784 else if (baud <= 117028) baud = 115200;
785 else if (baud <= 129347) baud = 128000;
786 else if (baud <= 156868) baud = 153600;
787 else if (baud <= 237832) baud = 230400;
788 else if (baud <= 254234) baud = 250000;
789 else if (baud <= 273066) baud = 256000;
790 else if (baud <= 491520) baud = 460800;
791 else if (baud <= 567138) baud = 500000;
792 else if (baud <= 670254) baud = 576000;
793 else if (baud < 1000000)
794 baud = 921600;
795 else if (baud > 2000000)
796 baud = 2000000;
797 return baud;
798 }
799
800 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
801 {
802 int result;
803
804 result = cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_ENABLE);
805 if (result) {
806 dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
807 return result;
808 }
809
810 /* Configure the termios structure */
811 cp210x_get_termios(tty, port);
812
813 /* The baud rate must be initialised on cp2104 */
814 if (tty)
815 cp210x_change_speed(tty, port, NULL);
816
817 return usb_serial_generic_open(tty, port);
818 }
819
820 static void cp210x_close(struct usb_serial_port *port)
821 {
822 usb_serial_generic_close(port);
823
824 /* Clear both queues; cp2108 needs this to avoid an occasional hang */
825 cp210x_write_u16_reg(port, CP210X_PURGE, PURGE_ALL);
826
827 cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
828 }
829
830 /*
831 * Read how many bytes are waiting in the TX queue.
832 */
833 static int cp210x_get_tx_queue_byte_count(struct usb_serial_port *port,
834 u32 *count)
835 {
836 struct usb_serial *serial = port->serial;
837 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
838 struct cp210x_comm_status *sts;
839 int result;
840
841 sts = kmalloc(sizeof(*sts), GFP_KERNEL);
842 if (!sts)
843 return -ENOMEM;
844
845 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
846 CP210X_GET_COMM_STATUS, REQTYPE_INTERFACE_TO_HOST,
847 0, port_priv->bInterfaceNumber, sts, sizeof(*sts),
848 USB_CTRL_GET_TIMEOUT);
849 if (result == sizeof(*sts)) {
850 *count = le32_to_cpu(sts->ulAmountInOutQueue);
851 result = 0;
852 } else {
853 dev_err(&port->dev, "failed to get comm status: %d\n", result);
854 if (result >= 0)
855 result = -EIO;
856 }
857
858 kfree(sts);
859
860 return result;
861 }
862
863 static bool cp210x_tx_empty(struct usb_serial_port *port)
864 {
865 int err;
866 u32 count;
867
868 err = cp210x_get_tx_queue_byte_count(port, &count);
869 if (err)
870 return true;
871
872 return !count;
873 }
874
875 /*
876 * cp210x_get_termios
877 * Reads the baud rate, data bits, parity, stop bits and flow control mode
878 * from the device, corrects any unsupported values, and configures the
879 * termios structure to reflect the state of the device
880 */
881 static void cp210x_get_termios(struct tty_struct *tty,
882 struct usb_serial_port *port)
883 {
884 unsigned int baud;
885
886 if (tty) {
887 cp210x_get_termios_port(tty->driver_data,
888 &tty->termios.c_cflag, &baud);
889 tty_encode_baud_rate(tty, baud, baud);
890 } else {
891 tcflag_t cflag;
892 cflag = 0;
893 cp210x_get_termios_port(port, &cflag, &baud);
894 }
895 }
896
897 /*
898 * cp210x_get_termios_port
899 * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
900 */
901 static void cp210x_get_termios_port(struct usb_serial_port *port,
902 tcflag_t *cflagp, unsigned int *baudp)
903 {
904 struct device *dev = &port->dev;
905 tcflag_t cflag;
906 struct cp210x_flow_ctl flow_ctl;
907 u32 baud;
908 u16 bits;
909 u32 ctl_hs;
910
911 cp210x_read_u32_reg(port, CP210X_GET_BAUDRATE, &baud);
912
913 dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud);
914 *baudp = baud;
915
916 cflag = *cflagp;
917
918 cp210x_get_line_ctl(port, &bits);
919 cflag &= ~CSIZE;
920 switch (bits & BITS_DATA_MASK) {
921 case BITS_DATA_5:
922 dev_dbg(dev, "%s - data bits = 5\n", __func__);
923 cflag |= CS5;
924 break;
925 case BITS_DATA_6:
926 dev_dbg(dev, "%s - data bits = 6\n", __func__);
927 cflag |= CS6;
928 break;
929 case BITS_DATA_7:
930 dev_dbg(dev, "%s - data bits = 7\n", __func__);
931 cflag |= CS7;
932 break;
933 case BITS_DATA_8:
934 dev_dbg(dev, "%s - data bits = 8\n", __func__);
935 cflag |= CS8;
936 break;
937 case BITS_DATA_9:
938 dev_dbg(dev, "%s - data bits = 9 (not supported, using 8 data bits)\n", __func__);
939 cflag |= CS8;
940 bits &= ~BITS_DATA_MASK;
941 bits |= BITS_DATA_8;
942 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
943 break;
944 default:
945 dev_dbg(dev, "%s - Unknown number of data bits, using 8\n", __func__);
946 cflag |= CS8;
947 bits &= ~BITS_DATA_MASK;
948 bits |= BITS_DATA_8;
949 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
950 break;
951 }
952
953 switch (bits & BITS_PARITY_MASK) {
954 case BITS_PARITY_NONE:
955 dev_dbg(dev, "%s - parity = NONE\n", __func__);
956 cflag &= ~PARENB;
957 break;
958 case BITS_PARITY_ODD:
959 dev_dbg(dev, "%s - parity = ODD\n", __func__);
960 cflag |= (PARENB|PARODD);
961 break;
962 case BITS_PARITY_EVEN:
963 dev_dbg(dev, "%s - parity = EVEN\n", __func__);
964 cflag &= ~PARODD;
965 cflag |= PARENB;
966 break;
967 case BITS_PARITY_MARK:
968 dev_dbg(dev, "%s - parity = MARK\n", __func__);
969 cflag |= (PARENB|PARODD|CMSPAR);
970 break;
971 case BITS_PARITY_SPACE:
972 dev_dbg(dev, "%s - parity = SPACE\n", __func__);
973 cflag &= ~PARODD;
974 cflag |= (PARENB|CMSPAR);
975 break;
976 default:
977 dev_dbg(dev, "%s - Unknown parity mode, disabling parity\n", __func__);
978 cflag &= ~PARENB;
979 bits &= ~BITS_PARITY_MASK;
980 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
981 break;
982 }
983
984 cflag &= ~CSTOPB;
985 switch (bits & BITS_STOP_MASK) {
986 case BITS_STOP_1:
987 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
988 break;
989 case BITS_STOP_1_5:
990 dev_dbg(dev, "%s - stop bits = 1.5 (not supported, using 1 stop bit)\n", __func__);
991 bits &= ~BITS_STOP_MASK;
992 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
993 break;
994 case BITS_STOP_2:
995 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
996 cflag |= CSTOPB;
997 break;
998 default:
999 dev_dbg(dev, "%s - Unknown number of stop bits, using 1 stop bit\n", __func__);
1000 bits &= ~BITS_STOP_MASK;
1001 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
1002 break;
1003 }
1004
1005 cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1006 sizeof(flow_ctl));
1007 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1008 if (ctl_hs & CP210X_SERIAL_CTS_HANDSHAKE) {
1009 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
1010 cflag |= CRTSCTS;
1011 } else {
1012 dev_dbg(dev, "%s - flow control = NONE\n", __func__);
1013 cflag &= ~CRTSCTS;
1014 }
1015
1016 *cflagp = cflag;
1017 }
1018
1019 /*
1020 * CP2101 supports the following baud rates:
1021 *
1022 * 300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
1023 * 38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
1024 *
1025 * CP2102 and CP2103 support the following additional rates:
1026 *
1027 * 4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
1028 * 576000
1029 *
1030 * The device will map a requested rate to a supported one, but the result
1031 * of requests for rates greater than 1053257 is undefined (see AN205).
1032 *
1033 * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
1034 * respectively, with an error less than 1%. The actual rates are determined
1035 * by
1036 *
1037 * div = round(freq / (2 x prescale x request))
1038 * actual = freq / (2 x prescale x div)
1039 *
1040 * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
1041 * or 1 otherwise.
1042 * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
1043 * otherwise.
1044 */
1045 static void cp210x_change_speed(struct tty_struct *tty,
1046 struct usb_serial_port *port, struct ktermios *old_termios)
1047 {
1048 u32 baud;
1049
1050 baud = tty->termios.c_ospeed;
1051
1052 /* This maps the requested rate to a rate valid on cp2102 or cp2103,
1053 * or to an arbitrary rate in [1M,2M].
1054 *
1055 * NOTE: B0 is not implemented.
1056 */
1057 baud = cp210x_quantise_baudrate(baud);
1058
1059 dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
1060 if (cp210x_write_u32_reg(port, CP210X_SET_BAUDRATE, baud)) {
1061 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
1062 if (old_termios)
1063 baud = old_termios->c_ospeed;
1064 else
1065 baud = 9600;
1066 }
1067
1068 tty_encode_baud_rate(tty, baud, baud);
1069 }
1070
1071 static void cp210x_set_termios(struct tty_struct *tty,
1072 struct usb_serial_port *port, struct ktermios *old_termios)
1073 {
1074 struct device *dev = &port->dev;
1075 unsigned int cflag, old_cflag;
1076 u16 bits;
1077
1078 cflag = tty->termios.c_cflag;
1079 old_cflag = old_termios->c_cflag;
1080
1081 if (tty->termios.c_ospeed != old_termios->c_ospeed)
1082 cp210x_change_speed(tty, port, old_termios);
1083
1084 /* If the number of data bits is to be updated */
1085 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
1086 cp210x_get_line_ctl(port, &bits);
1087 bits &= ~BITS_DATA_MASK;
1088 switch (cflag & CSIZE) {
1089 case CS5:
1090 bits |= BITS_DATA_5;
1091 dev_dbg(dev, "%s - data bits = 5\n", __func__);
1092 break;
1093 case CS6:
1094 bits |= BITS_DATA_6;
1095 dev_dbg(dev, "%s - data bits = 6\n", __func__);
1096 break;
1097 case CS7:
1098 bits |= BITS_DATA_7;
1099 dev_dbg(dev, "%s - data bits = 7\n", __func__);
1100 break;
1101 case CS8:
1102 default:
1103 bits |= BITS_DATA_8;
1104 dev_dbg(dev, "%s - data bits = 8\n", __func__);
1105 break;
1106 }
1107 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1108 dev_dbg(dev, "Number of data bits requested not supported by device\n");
1109 }
1110
1111 if ((cflag & (PARENB|PARODD|CMSPAR)) !=
1112 (old_cflag & (PARENB|PARODD|CMSPAR))) {
1113 cp210x_get_line_ctl(port, &bits);
1114 bits &= ~BITS_PARITY_MASK;
1115 if (cflag & PARENB) {
1116 if (cflag & CMSPAR) {
1117 if (cflag & PARODD) {
1118 bits |= BITS_PARITY_MARK;
1119 dev_dbg(dev, "%s - parity = MARK\n", __func__);
1120 } else {
1121 bits |= BITS_PARITY_SPACE;
1122 dev_dbg(dev, "%s - parity = SPACE\n", __func__);
1123 }
1124 } else {
1125 if (cflag & PARODD) {
1126 bits |= BITS_PARITY_ODD;
1127 dev_dbg(dev, "%s - parity = ODD\n", __func__);
1128 } else {
1129 bits |= BITS_PARITY_EVEN;
1130 dev_dbg(dev, "%s - parity = EVEN\n", __func__);
1131 }
1132 }
1133 }
1134 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1135 dev_dbg(dev, "Parity mode not supported by device\n");
1136 }
1137
1138 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
1139 cp210x_get_line_ctl(port, &bits);
1140 bits &= ~BITS_STOP_MASK;
1141 if (cflag & CSTOPB) {
1142 bits |= BITS_STOP_2;
1143 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
1144 } else {
1145 bits |= BITS_STOP_1;
1146 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
1147 }
1148 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1149 dev_dbg(dev, "Number of stop bits requested not supported by device\n");
1150 }
1151
1152 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
1153 struct cp210x_flow_ctl flow_ctl;
1154 u32 ctl_hs;
1155 u32 flow_repl;
1156
1157 cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1158 sizeof(flow_ctl));
1159 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1160 flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1161 dev_dbg(dev, "%s - read ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1162 __func__, ctl_hs, flow_repl);
1163
1164 ctl_hs &= ~CP210X_SERIAL_DSR_HANDSHAKE;
1165 ctl_hs &= ~CP210X_SERIAL_DCD_HANDSHAKE;
1166 ctl_hs &= ~CP210X_SERIAL_DSR_SENSITIVITY;
1167 ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1168 ctl_hs |= CP210X_SERIAL_DTR_SHIFT(CP210X_SERIAL_DTR_ACTIVE);
1169 if (cflag & CRTSCTS) {
1170 ctl_hs |= CP210X_SERIAL_CTS_HANDSHAKE;
1171
1172 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1173 flow_repl |= CP210X_SERIAL_RTS_SHIFT(
1174 CP210X_SERIAL_RTS_FLOW_CTL);
1175 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
1176 } else {
1177 ctl_hs &= ~CP210X_SERIAL_CTS_HANDSHAKE;
1178
1179 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1180 flow_repl |= CP210X_SERIAL_RTS_SHIFT(
1181 CP210X_SERIAL_RTS_ACTIVE);
1182 dev_dbg(dev, "%s - flow control = NONE\n", __func__);
1183 }
1184
1185 dev_dbg(dev, "%s - write ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1186 __func__, ctl_hs, flow_repl);
1187 flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1188 flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1189 cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1190 sizeof(flow_ctl));
1191 }
1192
1193 }
1194
1195 static int cp210x_tiocmset(struct tty_struct *tty,
1196 unsigned int set, unsigned int clear)
1197 {
1198 struct usb_serial_port *port = tty->driver_data;
1199 return cp210x_tiocmset_port(port, set, clear);
1200 }
1201
1202 static int cp210x_tiocmset_port(struct usb_serial_port *port,
1203 unsigned int set, unsigned int clear)
1204 {
1205 u16 control = 0;
1206
1207 if (set & TIOCM_RTS) {
1208 control |= CONTROL_RTS;
1209 control |= CONTROL_WRITE_RTS;
1210 }
1211 if (set & TIOCM_DTR) {
1212 control |= CONTROL_DTR;
1213 control |= CONTROL_WRITE_DTR;
1214 }
1215 if (clear & TIOCM_RTS) {
1216 control &= ~CONTROL_RTS;
1217 control |= CONTROL_WRITE_RTS;
1218 }
1219 if (clear & TIOCM_DTR) {
1220 control &= ~CONTROL_DTR;
1221 control |= CONTROL_WRITE_DTR;
1222 }
1223
1224 dev_dbg(&port->dev, "%s - control = 0x%.4x\n", __func__, control);
1225
1226 return cp210x_write_u16_reg(port, CP210X_SET_MHS, control);
1227 }
1228
1229 static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
1230 {
1231 if (on)
1232 cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
1233 else
1234 cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
1235 }
1236
1237 static int cp210x_tiocmget(struct tty_struct *tty)
1238 {
1239 struct usb_serial_port *port = tty->driver_data;
1240 u8 control;
1241 int result;
1242
1243 result = cp210x_read_u8_reg(port, CP210X_GET_MDMSTS, &control);
1244 if (result)
1245 return result;
1246
1247 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
1248 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
1249 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
1250 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
1251 |((control & CONTROL_RING)? TIOCM_RI : 0)
1252 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
1253
1254 dev_dbg(&port->dev, "%s - control = 0x%.2x\n", __func__, control);
1255
1256 return result;
1257 }
1258
1259 static void cp210x_break_ctl(struct tty_struct *tty, int break_state)
1260 {
1261 struct usb_serial_port *port = tty->driver_data;
1262 u16 state;
1263
1264 if (break_state == 0)
1265 state = BREAK_OFF;
1266 else
1267 state = BREAK_ON;
1268 dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
1269 state == BREAK_OFF ? "off" : "on");
1270 cp210x_write_u16_reg(port, CP210X_SET_BREAK, state);
1271 }
1272
1273 #ifdef CONFIG_GPIOLIB
1274 static int cp210x_gpio_request(struct gpio_chip *gc, unsigned int offset)
1275 {
1276 struct usb_serial *serial = gpiochip_get_data(gc);
1277 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1278
1279 switch (offset) {
1280 case 0:
1281 if (priv->config & CP2105_GPIO0_TXLED_MODE)
1282 return -ENODEV;
1283 break;
1284 case 1:
1285 if (priv->config & (CP2105_GPIO1_RXLED_MODE |
1286 CP2105_GPIO1_RS485_MODE))
1287 return -ENODEV;
1288 break;
1289 }
1290
1291 return 0;
1292 }
1293
1294 static int cp210x_gpio_get(struct gpio_chip *gc, unsigned int gpio)
1295 {
1296 struct usb_serial *serial = gpiochip_get_data(gc);
1297 int result;
1298 u8 buf;
1299
1300 result = cp210x_read_vendor_block(serial, REQTYPE_INTERFACE_TO_HOST,
1301 CP210X_READ_LATCH, &buf, sizeof(buf));
1302 if (result < 0)
1303 return result;
1304
1305 return !!(buf & BIT(gpio));
1306 }
1307
1308 static void cp210x_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)
1309 {
1310 struct usb_serial *serial = gpiochip_get_data(gc);
1311 struct cp210x_gpio_write buf;
1312
1313 if (value == 1)
1314 buf.state = BIT(gpio);
1315 else
1316 buf.state = 0;
1317
1318 buf.mask = BIT(gpio);
1319
1320 cp210x_write_vendor_block(serial, REQTYPE_HOST_TO_INTERFACE,
1321 CP210X_WRITE_LATCH, &buf, sizeof(buf));
1322 }
1323
1324 static int cp210x_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
1325 {
1326 /* Hardware does not support an input mode */
1327 return 0;
1328 }
1329
1330 static int cp210x_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
1331 {
1332 /* Hardware does not support an input mode */
1333 return -ENOTSUPP;
1334 }
1335
1336 static int cp210x_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
1337 int value)
1338 {
1339 return 0;
1340 }
1341
1342 static int cp210x_gpio_set_config(struct gpio_chip *gc, unsigned int gpio,
1343 unsigned long config)
1344 {
1345 struct usb_serial *serial = gpiochip_get_data(gc);
1346 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1347 enum pin_config_param param = pinconf_to_config_param(config);
1348
1349 /* Succeed only if in correct mode (this can't be set at runtime) */
1350 if ((param == PIN_CONFIG_DRIVE_PUSH_PULL) &&
1351 (priv->gpio_mode & BIT(gpio)))
1352 return 0;
1353
1354 if ((param == PIN_CONFIG_DRIVE_OPEN_DRAIN) &&
1355 !(priv->gpio_mode & BIT(gpio)))
1356 return 0;
1357
1358 return -ENOTSUPP;
1359 }
1360
1361 /*
1362 * This function is for configuring GPIO using shared pins, where other signals
1363 * are made unavailable by configuring the use of GPIO. This is believed to be
1364 * only applicable to the cp2105 at this point, the other devices supported by
1365 * this driver that provide GPIO do so in a way that does not impact other
1366 * signals and are thus expected to have very different initialisation.
1367 */
1368 static int cp2105_shared_gpio_init(struct usb_serial *serial)
1369 {
1370 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1371 struct cp210x_pin_mode mode;
1372 struct cp210x_config config;
1373 u8 intf_num = cp210x_interface_num(serial);
1374 int result;
1375
1376 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1377 CP210X_GET_DEVICEMODE, &mode,
1378 sizeof(mode));
1379 if (result < 0)
1380 return result;
1381
1382 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1383 CP210X_GET_PORTCONFIG, &config,
1384 sizeof(config));
1385 if (result < 0)
1386 return result;
1387
1388 /* 2 banks of GPIO - One for the pins taken from each serial port */
1389 if (intf_num == 0) {
1390 if (mode.eci == CP210X_PIN_MODE_MODEM)
1391 return 0;
1392
1393 priv->config = config.eci_cfg;
1394 priv->gpio_mode = (u8)((le16_to_cpu(config.gpio_mode) &
1395 CP210X_ECI_GPIO_MODE_MASK) >>
1396 CP210X_ECI_GPIO_MODE_OFFSET);
1397 priv->gc.ngpio = 2;
1398 } else if (intf_num == 1) {
1399 if (mode.sci == CP210X_PIN_MODE_MODEM)
1400 return 0;
1401
1402 priv->config = config.sci_cfg;
1403 priv->gpio_mode = (u8)((le16_to_cpu(config.gpio_mode) &
1404 CP210X_SCI_GPIO_MODE_MASK) >>
1405 CP210X_SCI_GPIO_MODE_OFFSET);
1406 priv->gc.ngpio = 3;
1407 } else {
1408 return -ENODEV;
1409 }
1410
1411 priv->gc.label = "cp210x";
1412 priv->gc.request = cp210x_gpio_request;
1413 priv->gc.get_direction = cp210x_gpio_direction_get;
1414 priv->gc.direction_input = cp210x_gpio_direction_input;
1415 priv->gc.direction_output = cp210x_gpio_direction_output;
1416 priv->gc.get = cp210x_gpio_get;
1417 priv->gc.set = cp210x_gpio_set;
1418 priv->gc.set_config = cp210x_gpio_set_config;
1419 priv->gc.owner = THIS_MODULE;
1420 priv->gc.parent = &serial->interface->dev;
1421 priv->gc.base = -1;
1422 priv->gc.can_sleep = true;
1423
1424 result = gpiochip_add_data(&priv->gc, serial);
1425 if (!result)
1426 priv->gpio_registered = true;
1427
1428 return result;
1429 }
1430
1431 static void cp210x_gpio_remove(struct usb_serial *serial)
1432 {
1433 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1434
1435 if (priv->gpio_registered) {
1436 gpiochip_remove(&priv->gc);
1437 priv->gpio_registered = false;
1438 }
1439 }
1440
1441 #else
1442
1443 static int cp2105_shared_gpio_init(struct usb_serial *serial)
1444 {
1445 return 0;
1446 }
1447
1448 static void cp210x_gpio_remove(struct usb_serial *serial)
1449 {
1450 /* Nothing to do */
1451 }
1452
1453 #endif
1454
1455 static int cp210x_port_probe(struct usb_serial_port *port)
1456 {
1457 struct usb_serial *serial = port->serial;
1458 struct cp210x_port_private *port_priv;
1459 int ret;
1460
1461 port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
1462 if (!port_priv)
1463 return -ENOMEM;
1464
1465 port_priv->bInterfaceNumber = cp210x_interface_num(serial);
1466
1467 usb_set_serial_port_data(port, port_priv);
1468
1469 ret = cp210x_detect_swapped_line_ctl(port);
1470 if (ret) {
1471 kfree(port_priv);
1472 return ret;
1473 }
1474
1475 return 0;
1476 }
1477
1478 static int cp210x_port_remove(struct usb_serial_port *port)
1479 {
1480 struct cp210x_port_private *port_priv;
1481
1482 port_priv = usb_get_serial_port_data(port);
1483 kfree(port_priv);
1484
1485 return 0;
1486 }
1487
1488 static int cp210x_attach(struct usb_serial *serial)
1489 {
1490 int result;
1491 struct cp210x_serial_private *priv;
1492
1493 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1494 if (!priv)
1495 return -ENOMEM;
1496
1497 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1498 CP210X_GET_PARTNUM, &priv->partnum,
1499 sizeof(priv->partnum));
1500 if (result < 0) {
1501 dev_warn(&serial->interface->dev,
1502 "querying part number failed\n");
1503 priv->partnum = CP210X_PARTNUM_UNKNOWN;
1504 }
1505
1506 usb_set_serial_data(serial, priv);
1507
1508 if (priv->partnum == CP210X_PARTNUM_CP2105) {
1509 result = cp2105_shared_gpio_init(serial);
1510 if (result < 0) {
1511 dev_err(&serial->interface->dev,
1512 "GPIO initialisation failed, continuing without GPIO support\n");
1513 }
1514 }
1515
1516 return 0;
1517 }
1518
1519 static void cp210x_disconnect(struct usb_serial *serial)
1520 {
1521 cp210x_gpio_remove(serial);
1522 }
1523
1524 static void cp210x_release(struct usb_serial *serial)
1525 {
1526 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1527
1528 cp210x_gpio_remove(serial);
1529
1530 kfree(priv);
1531 }
1532
1533 module_usb_serial_driver(serial_drivers, id_table);
1534
1535 MODULE_DESCRIPTION(DRIVER_DESC);
1536 MODULE_LICENSE("GPL");
Linux with added FPC-III support