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