Loading...
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
27/*
28 * Version Information
29 */
30#define DRIVER_VERSION "v0.09"
31#define DRIVER_DESC "Silicon Labs CP210x RS232 serial adaptor driver"
32
33/*
34 * Function Prototypes
35 */
36static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *);
37static void cp210x_close(struct usb_serial_port *);
38static void cp210x_get_termios(struct tty_struct *,
39 struct usb_serial_port *port);
40static void cp210x_get_termios_port(struct usb_serial_port *port,
41 unsigned int *cflagp, unsigned int *baudp);
42static void cp210x_set_termios(struct tty_struct *, struct usb_serial_port *,
43 struct ktermios*);
44static int cp210x_tiocmget(struct tty_struct *);
45static int cp210x_tiocmset(struct tty_struct *, unsigned int, unsigned int);
46static int cp210x_tiocmset_port(struct usb_serial_port *port,
47 unsigned int, unsigned int);
48static void cp210x_break_ctl(struct tty_struct *, int);
49static int cp210x_startup(struct usb_serial *);
50static void cp210x_dtr_rts(struct usb_serial_port *p, int on);
51
52static int debug;
53
54static 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(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
61 { USB_DEVICE(0x08FD, 0x000A) }, /* Digianswer A/S , ZigBee/802.15.4 MAC Device */
62 { USB_DEVICE(0x0BED, 0x1100) }, /* MEI (TM) Cashflow-SC Bill/Voucher Acceptor */
63 { USB_DEVICE(0x0BED, 0x1101) }, /* MEI series 2000 Combo Acceptor */
64 { USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
65 { USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
66 { USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */
67 { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
68 { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
69 { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
70 { USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */
71 { USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */
72 { USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */
73 { USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
74 { USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
75 { USB_DEVICE(0x10C4, 0x8044) }, /* Cygnal Debug Adapter */
76 { USB_DEVICE(0x10C4, 0x804E) }, /* Software Bisque Paramount ME build-in converter */
77 { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
78 { USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */
79 { USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
80 { USB_DEVICE(0x10C4, 0x806F) }, /* IMS USB to RS422 Converter Cable */
81 { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
82 { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
83 { USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
84 { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
85 { USB_DEVICE(0x10C4, 0x8115) }, /* Arygon NFC/Mifare Reader */
86 { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
87 { USB_DEVICE(0x10C4, 0x813F) }, /* Tams Master Easy Control */
88 { USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
89 { USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
90 { USB_DEVICE(0x10C4, 0x8156) }, /* B&G H3000 link cable */
91 { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
92 { USB_DEVICE(0x10C4, 0x818B) }, /* AVIT Research USB to TTL */
93 { USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
94 { USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
95 { USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
96 { USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */
97 { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
98 { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
99 { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
100 { USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
101 { USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
102 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
103 { USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
104 { USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
105 { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
106 { USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
107 { USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
108 { USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
109 { USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
110 { USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
111 { USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
112 { USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
113 { USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
114 { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
115 { USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
116 { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
117 { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
118 { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
119 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
120 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
121 { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
122 { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
123 { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
124 { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
125 { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
126 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
127 { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
128 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
129 { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
130 { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
131 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
132 { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
133 { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
134 { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
135 { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
136 { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
137 { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
138 { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
139 { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
140 { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
141 { } /* Terminating Entry */
142};
143
144MODULE_DEVICE_TABLE(usb, id_table);
145
146static struct usb_driver cp210x_driver = {
147 .name = "cp210x",
148 .probe = usb_serial_probe,
149 .disconnect = usb_serial_disconnect,
150 .id_table = id_table,
151 .no_dynamic_id = 1,
152};
153
154static struct usb_serial_driver cp210x_device = {
155 .driver = {
156 .owner = THIS_MODULE,
157 .name = "cp210x",
158 },
159 .usb_driver = &cp210x_driver,
160 .id_table = id_table,
161 .num_ports = 1,
162 .bulk_in_size = 256,
163 .bulk_out_size = 256,
164 .open = cp210x_open,
165 .close = cp210x_close,
166 .break_ctl = cp210x_break_ctl,
167 .set_termios = cp210x_set_termios,
168 .tiocmget = cp210x_tiocmget,
169 .tiocmset = cp210x_tiocmset,
170 .attach = cp210x_startup,
171 .dtr_rts = cp210x_dtr_rts
172};
173
174/* Config request types */
175#define REQTYPE_HOST_TO_DEVICE 0x41
176#define REQTYPE_DEVICE_TO_HOST 0xc1
177
178/* Config request codes */
179#define CP210X_IFC_ENABLE 0x00
180#define CP210X_SET_BAUDDIV 0x01
181#define CP210X_GET_BAUDDIV 0x02
182#define CP210X_SET_LINE_CTL 0x03
183#define CP210X_GET_LINE_CTL 0x04
184#define CP210X_SET_BREAK 0x05
185#define CP210X_IMM_CHAR 0x06
186#define CP210X_SET_MHS 0x07
187#define CP210X_GET_MDMSTS 0x08
188#define CP210X_SET_XON 0x09
189#define CP210X_SET_XOFF 0x0A
190#define CP210X_SET_EVENTMASK 0x0B
191#define CP210X_GET_EVENTMASK 0x0C
192#define CP210X_SET_CHAR 0x0D
193#define CP210X_GET_CHARS 0x0E
194#define CP210X_GET_PROPS 0x0F
195#define CP210X_GET_COMM_STATUS 0x10
196#define CP210X_RESET 0x11
197#define CP210X_PURGE 0x12
198#define CP210X_SET_FLOW 0x13
199#define CP210X_GET_FLOW 0x14
200#define CP210X_EMBED_EVENTS 0x15
201#define CP210X_GET_EVENTSTATE 0x16
202#define CP210X_SET_CHARS 0x19
203
204/* CP210X_IFC_ENABLE */
205#define UART_ENABLE 0x0001
206#define UART_DISABLE 0x0000
207
208/* CP210X_(SET|GET)_BAUDDIV */
209#define BAUD_RATE_GEN_FREQ 0x384000
210
211/* CP210X_(SET|GET)_LINE_CTL */
212#define BITS_DATA_MASK 0X0f00
213#define BITS_DATA_5 0X0500
214#define BITS_DATA_6 0X0600
215#define BITS_DATA_7 0X0700
216#define BITS_DATA_8 0X0800
217#define BITS_DATA_9 0X0900
218
219#define BITS_PARITY_MASK 0x00f0
220#define BITS_PARITY_NONE 0x0000
221#define BITS_PARITY_ODD 0x0010
222#define BITS_PARITY_EVEN 0x0020
223#define BITS_PARITY_MARK 0x0030
224#define BITS_PARITY_SPACE 0x0040
225
226#define BITS_STOP_MASK 0x000f
227#define BITS_STOP_1 0x0000
228#define BITS_STOP_1_5 0x0001
229#define BITS_STOP_2 0x0002
230
231/* CP210X_SET_BREAK */
232#define BREAK_ON 0x0001
233#define BREAK_OFF 0x0000
234
235/* CP210X_(SET_MHS|GET_MDMSTS) */
236#define CONTROL_DTR 0x0001
237#define CONTROL_RTS 0x0002
238#define CONTROL_CTS 0x0010
239#define CONTROL_DSR 0x0020
240#define CONTROL_RING 0x0040
241#define CONTROL_DCD 0x0080
242#define CONTROL_WRITE_DTR 0x0100
243#define CONTROL_WRITE_RTS 0x0200
244
245/*
246 * cp210x_get_config
247 * Reads from the CP210x configuration registers
248 * 'size' is specified in bytes.
249 * 'data' is a pointer to a pre-allocated array of integers large
250 * enough to hold 'size' bytes (with 4 bytes to each integer)
251 */
252static int cp210x_get_config(struct usb_serial_port *port, u8 request,
253 unsigned int *data, int size)
254{
255 struct usb_serial *serial = port->serial;
256 __le32 *buf;
257 int result, i, length;
258
259 /* Number of integers required to contain the array */
260 length = (((size - 1) | 3) + 1)/4;
261
262 buf = kcalloc(length, sizeof(__le32), GFP_KERNEL);
263 if (!buf) {
264 dev_err(&port->dev, "%s - out of memory.\n", __func__);
265 return -ENOMEM;
266 }
267
268 /* Issue the request, attempting to read 'size' bytes */
269 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
270 request, REQTYPE_DEVICE_TO_HOST, 0x0000,
271 0, buf, size, 300);
272
273 /* Convert data into an array of integers */
274 for (i = 0; i < length; i++)
275 data[i] = le32_to_cpu(buf[i]);
276
277 kfree(buf);
278
279 if (result != size) {
280 dbg("%s - Unable to send config request, "
281 "request=0x%x size=%d result=%d\n",
282 __func__, request, size, result);
283 return -EPROTO;
284 }
285
286 return 0;
287}
288
289/*
290 * cp210x_set_config
291 * Writes to the CP210x configuration registers
292 * Values less than 16 bits wide are sent directly
293 * 'size' is specified in bytes.
294 */
295static int cp210x_set_config(struct usb_serial_port *port, u8 request,
296 unsigned int *data, int size)
297{
298 struct usb_serial *serial = port->serial;
299 __le32 *buf;
300 int result, i, length;
301
302 /* Number of integers required to contain the array */
303 length = (((size - 1) | 3) + 1)/4;
304
305 buf = kmalloc(length * sizeof(__le32), GFP_KERNEL);
306 if (!buf) {
307 dev_err(&port->dev, "%s - out of memory.\n",
308 __func__);
309 return -ENOMEM;
310 }
311
312 /* Array of integers into bytes */
313 for (i = 0; i < length; i++)
314 buf[i] = cpu_to_le32(data[i]);
315
316 if (size > 2) {
317 result = usb_control_msg(serial->dev,
318 usb_sndctrlpipe(serial->dev, 0),
319 request, REQTYPE_HOST_TO_DEVICE, 0x0000,
320 0, buf, size, 300);
321 } else {
322 result = usb_control_msg(serial->dev,
323 usb_sndctrlpipe(serial->dev, 0),
324 request, REQTYPE_HOST_TO_DEVICE, data[0],
325 0, NULL, 0, 300);
326 }
327
328 kfree(buf);
329
330 if ((size > 2 && result != size) || result < 0) {
331 dbg("%s - Unable to send request, "
332 "request=0x%x size=%d result=%d\n",
333 __func__, request, size, result);
334 return -EPROTO;
335 }
336
337 return 0;
338}
339
340/*
341 * cp210x_set_config_single
342 * Convenience function for calling cp210x_set_config on single data values
343 * without requiring an integer pointer
344 */
345static inline int cp210x_set_config_single(struct usb_serial_port *port,
346 u8 request, unsigned int data)
347{
348 return cp210x_set_config(port, request, &data, 2);
349}
350
351/*
352 * cp210x_quantise_baudrate
353 * Quantises the baud rate as per AN205 Table 1
354 */
355static unsigned int cp210x_quantise_baudrate(unsigned int baud) {
356 if (baud <= 56) baud = 0;
357 else if (baud <= 300) baud = 300;
358 else if (baud <= 600) baud = 600;
359 else if (baud <= 1200) baud = 1200;
360 else if (baud <= 1800) baud = 1800;
361 else if (baud <= 2400) baud = 2400;
362 else if (baud <= 4000) baud = 4000;
363 else if (baud <= 4803) baud = 4800;
364 else if (baud <= 7207) baud = 7200;
365 else if (baud <= 9612) baud = 9600;
366 else if (baud <= 14428) baud = 14400;
367 else if (baud <= 16062) baud = 16000;
368 else if (baud <= 19250) baud = 19200;
369 else if (baud <= 28912) baud = 28800;
370 else if (baud <= 38601) baud = 38400;
371 else if (baud <= 51558) baud = 51200;
372 else if (baud <= 56280) baud = 56000;
373 else if (baud <= 58053) baud = 57600;
374 else if (baud <= 64111) baud = 64000;
375 else if (baud <= 77608) baud = 76800;
376 else if (baud <= 117028) baud = 115200;
377 else if (baud <= 129347) baud = 128000;
378 else if (baud <= 156868) baud = 153600;
379 else if (baud <= 237832) baud = 230400;
380 else if (baud <= 254234) baud = 250000;
381 else if (baud <= 273066) baud = 256000;
382 else if (baud <= 491520) baud = 460800;
383 else if (baud <= 567138) baud = 500000;
384 else if (baud <= 670254) baud = 576000;
385 else if (baud <= 1053257) baud = 921600;
386 else if (baud <= 1474560) baud = 1228800;
387 else if (baud <= 2457600) baud = 1843200;
388 else baud = 3686400;
389 return baud;
390}
391
392static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
393{
394 int result;
395
396 dbg("%s - port %d", __func__, port->number);
397
398 if (cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_ENABLE)) {
399 dev_err(&port->dev, "%s - Unable to enable UART\n",
400 __func__);
401 return -EPROTO;
402 }
403
404 result = usb_serial_generic_open(tty, port);
405 if (result)
406 return result;
407
408 /* Configure the termios structure */
409 cp210x_get_termios(tty, port);
410 return 0;
411}
412
413static void cp210x_close(struct usb_serial_port *port)
414{
415 dbg("%s - port %d", __func__, port->number);
416
417 usb_serial_generic_close(port);
418
419 mutex_lock(&port->serial->disc_mutex);
420 if (!port->serial->disconnected)
421 cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_DISABLE);
422 mutex_unlock(&port->serial->disc_mutex);
423}
424
425/*
426 * cp210x_get_termios
427 * Reads the baud rate, data bits, parity, stop bits and flow control mode
428 * from the device, corrects any unsupported values, and configures the
429 * termios structure to reflect the state of the device
430 */
431static void cp210x_get_termios(struct tty_struct *tty,
432 struct usb_serial_port *port)
433{
434 unsigned int baud;
435
436 if (tty) {
437 cp210x_get_termios_port(tty->driver_data,
438 &tty->termios->c_cflag, &baud);
439 tty_encode_baud_rate(tty, baud, baud);
440 }
441
442 else {
443 unsigned int cflag;
444 cflag = 0;
445 cp210x_get_termios_port(port, &cflag, &baud);
446 }
447}
448
449/*
450 * cp210x_get_termios_port
451 * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
452 */
453static void cp210x_get_termios_port(struct usb_serial_port *port,
454 unsigned int *cflagp, unsigned int *baudp)
455{
456 unsigned int cflag, modem_ctl[4];
457 unsigned int baud;
458 unsigned int bits;
459
460 dbg("%s - port %d", __func__, port->number);
461
462 cp210x_get_config(port, CP210X_GET_BAUDDIV, &baud, 2);
463 /* Convert to baudrate */
464 if (baud)
465 baud = cp210x_quantise_baudrate((BAUD_RATE_GEN_FREQ + baud/2)/ baud);
466
467 dbg("%s - baud rate = %d", __func__, baud);
468 *baudp = baud;
469
470 cflag = *cflagp;
471
472 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
473 cflag &= ~CSIZE;
474 switch (bits & BITS_DATA_MASK) {
475 case BITS_DATA_5:
476 dbg("%s - data bits = 5", __func__);
477 cflag |= CS5;
478 break;
479 case BITS_DATA_6:
480 dbg("%s - data bits = 6", __func__);
481 cflag |= CS6;
482 break;
483 case BITS_DATA_7:
484 dbg("%s - data bits = 7", __func__);
485 cflag |= CS7;
486 break;
487 case BITS_DATA_8:
488 dbg("%s - data bits = 8", __func__);
489 cflag |= CS8;
490 break;
491 case BITS_DATA_9:
492 dbg("%s - data bits = 9 (not supported, using 8 data bits)",
493 __func__);
494 cflag |= CS8;
495 bits &= ~BITS_DATA_MASK;
496 bits |= BITS_DATA_8;
497 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
498 break;
499 default:
500 dbg("%s - Unknown number of data bits, using 8", __func__);
501 cflag |= CS8;
502 bits &= ~BITS_DATA_MASK;
503 bits |= BITS_DATA_8;
504 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
505 break;
506 }
507
508 switch (bits & BITS_PARITY_MASK) {
509 case BITS_PARITY_NONE:
510 dbg("%s - parity = NONE", __func__);
511 cflag &= ~PARENB;
512 break;
513 case BITS_PARITY_ODD:
514 dbg("%s - parity = ODD", __func__);
515 cflag |= (PARENB|PARODD);
516 break;
517 case BITS_PARITY_EVEN:
518 dbg("%s - parity = EVEN", __func__);
519 cflag &= ~PARODD;
520 cflag |= PARENB;
521 break;
522 case BITS_PARITY_MARK:
523 dbg("%s - parity = MARK (not supported, disabling parity)",
524 __func__);
525 cflag &= ~PARENB;
526 bits &= ~BITS_PARITY_MASK;
527 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
528 break;
529 case BITS_PARITY_SPACE:
530 dbg("%s - parity = SPACE (not supported, disabling parity)",
531 __func__);
532 cflag &= ~PARENB;
533 bits &= ~BITS_PARITY_MASK;
534 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
535 break;
536 default:
537 dbg("%s - Unknown parity mode, disabling parity", __func__);
538 cflag &= ~PARENB;
539 bits &= ~BITS_PARITY_MASK;
540 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
541 break;
542 }
543
544 cflag &= ~CSTOPB;
545 switch (bits & BITS_STOP_MASK) {
546 case BITS_STOP_1:
547 dbg("%s - stop bits = 1", __func__);
548 break;
549 case BITS_STOP_1_5:
550 dbg("%s - stop bits = 1.5 (not supported, using 1 stop bit)",
551 __func__);
552 bits &= ~BITS_STOP_MASK;
553 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
554 break;
555 case BITS_STOP_2:
556 dbg("%s - stop bits = 2", __func__);
557 cflag |= CSTOPB;
558 break;
559 default:
560 dbg("%s - Unknown number of stop bits, using 1 stop bit",
561 __func__);
562 bits &= ~BITS_STOP_MASK;
563 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
564 break;
565 }
566
567 cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
568 if (modem_ctl[0] & 0x0008) {
569 dbg("%s - flow control = CRTSCTS", __func__);
570 cflag |= CRTSCTS;
571 } else {
572 dbg("%s - flow control = NONE", __func__);
573 cflag &= ~CRTSCTS;
574 }
575
576 *cflagp = cflag;
577}
578
579static void cp210x_set_termios(struct tty_struct *tty,
580 struct usb_serial_port *port, struct ktermios *old_termios)
581{
582 unsigned int cflag, old_cflag;
583 unsigned int baud = 0, bits;
584 unsigned int modem_ctl[4];
585
586 dbg("%s - port %d", __func__, port->number);
587
588 if (!tty)
589 return;
590
591 tty->termios->c_cflag &= ~CMSPAR;
592 cflag = tty->termios->c_cflag;
593 old_cflag = old_termios->c_cflag;
594 baud = cp210x_quantise_baudrate(tty_get_baud_rate(tty));
595
596 /* If the baud rate is to be updated*/
597 if (baud != tty_termios_baud_rate(old_termios) && baud != 0) {
598 dbg("%s - Setting baud rate to %d baud", __func__,
599 baud);
600 if (cp210x_set_config_single(port, CP210X_SET_BAUDDIV,
601 ((BAUD_RATE_GEN_FREQ + baud/2) / baud))) {
602 dbg("Baud rate requested not supported by device");
603 baud = tty_termios_baud_rate(old_termios);
604 }
605 }
606 /* Report back the resulting baud rate */
607 tty_encode_baud_rate(tty, baud, baud);
608
609 /* If the number of data bits is to be updated */
610 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
611 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
612 bits &= ~BITS_DATA_MASK;
613 switch (cflag & CSIZE) {
614 case CS5:
615 bits |= BITS_DATA_5;
616 dbg("%s - data bits = 5", __func__);
617 break;
618 case CS6:
619 bits |= BITS_DATA_6;
620 dbg("%s - data bits = 6", __func__);
621 break;
622 case CS7:
623 bits |= BITS_DATA_7;
624 dbg("%s - data bits = 7", __func__);
625 break;
626 case CS8:
627 bits |= BITS_DATA_8;
628 dbg("%s - data bits = 8", __func__);
629 break;
630 /*case CS9:
631 bits |= BITS_DATA_9;
632 dbg("%s - data bits = 9", __func__);
633 break;*/
634 default:
635 dbg("cp210x driver does not "
636 "support the number of bits requested,"
637 " using 8 bit mode\n");
638 bits |= BITS_DATA_8;
639 break;
640 }
641 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
642 dbg("Number of data bits requested "
643 "not supported by device\n");
644 }
645
646 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))) {
647 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
648 bits &= ~BITS_PARITY_MASK;
649 if (cflag & PARENB) {
650 if (cflag & PARODD) {
651 bits |= BITS_PARITY_ODD;
652 dbg("%s - parity = ODD", __func__);
653 } else {
654 bits |= BITS_PARITY_EVEN;
655 dbg("%s - parity = EVEN", __func__);
656 }
657 }
658 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
659 dbg("Parity mode not supported "
660 "by device\n");
661 }
662
663 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
664 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
665 bits &= ~BITS_STOP_MASK;
666 if (cflag & CSTOPB) {
667 bits |= BITS_STOP_2;
668 dbg("%s - stop bits = 2", __func__);
669 } else {
670 bits |= BITS_STOP_1;
671 dbg("%s - stop bits = 1", __func__);
672 }
673 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
674 dbg("Number of stop bits requested "
675 "not supported by device\n");
676 }
677
678 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
679 cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
680 dbg("%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
681 __func__, modem_ctl[0], modem_ctl[1],
682 modem_ctl[2], modem_ctl[3]);
683
684 if (cflag & CRTSCTS) {
685 modem_ctl[0] &= ~0x7B;
686 modem_ctl[0] |= 0x09;
687 modem_ctl[1] = 0x80;
688 dbg("%s - flow control = CRTSCTS", __func__);
689 } else {
690 modem_ctl[0] &= ~0x7B;
691 modem_ctl[0] |= 0x01;
692 modem_ctl[1] |= 0x40;
693 dbg("%s - flow control = NONE", __func__);
694 }
695
696 dbg("%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
697 __func__, modem_ctl[0], modem_ctl[1],
698 modem_ctl[2], modem_ctl[3]);
699 cp210x_set_config(port, CP210X_SET_FLOW, modem_ctl, 16);
700 }
701
702}
703
704static int cp210x_tiocmset (struct tty_struct *tty,
705 unsigned int set, unsigned int clear)
706{
707 struct usb_serial_port *port = tty->driver_data;
708 return cp210x_tiocmset_port(port, set, clear);
709}
710
711static int cp210x_tiocmset_port(struct usb_serial_port *port,
712 unsigned int set, unsigned int clear)
713{
714 unsigned int control = 0;
715
716 dbg("%s - port %d", __func__, port->number);
717
718 if (set & TIOCM_RTS) {
719 control |= CONTROL_RTS;
720 control |= CONTROL_WRITE_RTS;
721 }
722 if (set & TIOCM_DTR) {
723 control |= CONTROL_DTR;
724 control |= CONTROL_WRITE_DTR;
725 }
726 if (clear & TIOCM_RTS) {
727 control &= ~CONTROL_RTS;
728 control |= CONTROL_WRITE_RTS;
729 }
730 if (clear & TIOCM_DTR) {
731 control &= ~CONTROL_DTR;
732 control |= CONTROL_WRITE_DTR;
733 }
734
735 dbg("%s - control = 0x%.4x", __func__, control);
736
737 return cp210x_set_config(port, CP210X_SET_MHS, &control, 2);
738}
739
740static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
741{
742 if (on)
743 cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
744 else
745 cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
746}
747
748static int cp210x_tiocmget (struct tty_struct *tty)
749{
750 struct usb_serial_port *port = tty->driver_data;
751 unsigned int control;
752 int result;
753
754 dbg("%s - port %d", __func__, port->number);
755
756 cp210x_get_config(port, CP210X_GET_MDMSTS, &control, 1);
757
758 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
759 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
760 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
761 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
762 |((control & CONTROL_RING)? TIOCM_RI : 0)
763 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
764
765 dbg("%s - control = 0x%.2x", __func__, control);
766
767 return result;
768}
769
770static void cp210x_break_ctl (struct tty_struct *tty, int break_state)
771{
772 struct usb_serial_port *port = tty->driver_data;
773 unsigned int state;
774
775 dbg("%s - port %d", __func__, port->number);
776 if (break_state == 0)
777 state = BREAK_OFF;
778 else
779 state = BREAK_ON;
780 dbg("%s - turning break %s", __func__,
781 state == BREAK_OFF ? "off" : "on");
782 cp210x_set_config(port, CP210X_SET_BREAK, &state, 2);
783}
784
785static int cp210x_startup(struct usb_serial *serial)
786{
787 /* cp210x buffers behave strangely unless device is reset */
788 usb_reset_device(serial->dev);
789 return 0;
790}
791
792static int __init cp210x_init(void)
793{
794 int retval;
795
796 retval = usb_serial_register(&cp210x_device);
797 if (retval)
798 return retval; /* Failed to register */
799
800 retval = usb_register(&cp210x_driver);
801 if (retval) {
802 /* Failed to register */
803 usb_serial_deregister(&cp210x_device);
804 return retval;
805 }
806
807 /* Success */
808 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
809 DRIVER_DESC "\n");
810 return 0;
811}
812
813static void __exit cp210x_exit(void)
814{
815 usb_deregister(&cp210x_driver);
816 usb_serial_deregister(&cp210x_device);
817}
818
819module_init(cp210x_init);
820module_exit(cp210x_exit);
821
822MODULE_DESCRIPTION(DRIVER_DESC);
823MODULE_VERSION(DRIVER_VERSION);
824MODULE_LICENSE("GPL");
825
826module_param(debug, bool, S_IRUGO | S_IWUSR);
827MODULE_PARM_DESC(debug, "Enable verbose debugging messages");
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 * Copyright (C) 2010-2021 Johan Hovold (johan@kernel.org)
7 *
8 * Support to set flow control line levels using TIOCMGET and TIOCMSET
9 * thanks to Karl Hiramoto karl@hiramoto.org. RTSCTS hardware flow
10 * control thanks to Munir Nassar nassarmu@real-time.com
11 *
12 */
13
14#include <linux/kernel.h>
15#include <linux/errno.h>
16#include <linux/slab.h>
17#include <linux/tty.h>
18#include <linux/tty_flip.h>
19#include <linux/module.h>
20#include <linux/usb.h>
21#include <linux/usb/serial.h>
22#include <linux/gpio/driver.h>
23#include <linux/bitops.h>
24#include <linux/mutex.h>
25
26#define DRIVER_DESC "Silicon Labs CP210x RS232 serial adaptor driver"
27
28/*
29 * Function Prototypes
30 */
31static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *);
32static void cp210x_close(struct usb_serial_port *);
33static void cp210x_change_speed(struct tty_struct *, struct usb_serial_port *,
34 const struct ktermios *);
35static void cp210x_set_termios(struct tty_struct *, struct usb_serial_port *,
36 const struct ktermios *);
37static bool cp210x_tx_empty(struct usb_serial_port *port);
38static int cp210x_tiocmget(struct tty_struct *);
39static int cp210x_tiocmset(struct tty_struct *, unsigned int, unsigned int);
40static int cp210x_tiocmset_port(struct usb_serial_port *port,
41 unsigned int, unsigned int);
42static void cp210x_break_ctl(struct tty_struct *, int);
43static int cp210x_attach(struct usb_serial *);
44static void cp210x_disconnect(struct usb_serial *);
45static void cp210x_release(struct usb_serial *);
46static int cp210x_port_probe(struct usb_serial_port *);
47static void cp210x_port_remove(struct usb_serial_port *);
48static void cp210x_dtr_rts(struct usb_serial_port *port, int on);
49static void cp210x_process_read_urb(struct urb *urb);
50static void cp210x_enable_event_mode(struct usb_serial_port *port);
51static void cp210x_disable_event_mode(struct usb_serial_port *port);
52
53static const struct usb_device_id id_table[] = {
54 { USB_DEVICE(0x0404, 0x034C) }, /* NCR Retail IO Box */
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, 0x0070) }, /* Siemens SCALANCE LPE-9000 USB Serial Console */
64 { USB_DEVICE(0x0908, 0x01FF) }, /* Siemens RUGGEDCOM USB Serial Console */
65 { USB_DEVICE(0x0988, 0x0578) }, /* Teraoka AD2000 */
66 { USB_DEVICE(0x0B00, 0x3070) }, /* Ingenico 3070 */
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(0x106F, 0x0003) }, /* CPI / Money Controls Bulk Coin Recycler */
74 { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
75 { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
76 { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
77 { USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */
78 { USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */
79 { USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */
80 { USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
81 { USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
82 { USB_DEVICE(0x10C4, 0x8044) }, /* Cygnal Debug Adapter */
83 { USB_DEVICE(0x10C4, 0x804E) }, /* Software Bisque Paramount ME build-in converter */
84 { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
85 { USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */
86 { USB_DEVICE(0x10C4, 0x8056) }, /* Lorenz Messtechnik devices */
87 { USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
88 { USB_DEVICE(0x10C4, 0x806F) }, /* IMS USB to RS422 Converter Cable */
89 { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
90 { USB_DEVICE(0x10C4, 0x80C4) }, /* Cygnal Integrated Products, Inc., Optris infrared thermometer */
91 { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
92 { USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
93 { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
94 { USB_DEVICE(0x10C4, 0x8115) }, /* Arygon NFC/Mifare Reader */
95 { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
96 { USB_DEVICE(0x10C4, 0x813F) }, /* Tams Master Easy Control */
97 { USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
98 { USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
99 { USB_DEVICE(0x2405, 0x0003) }, /* West Mountain Radio RIGblaster Advantage */
100 { USB_DEVICE(0x10C4, 0x8156) }, /* B&G H3000 link cable */
101 { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
102 { USB_DEVICE(0x10C4, 0x815F) }, /* Timewave HamLinkUSB */
103 { USB_DEVICE(0x10C4, 0x817C) }, /* CESINEL MEDCAL N Power Quality Monitor */
104 { USB_DEVICE(0x10C4, 0x817D) }, /* CESINEL MEDCAL NT Power Quality Monitor */
105 { USB_DEVICE(0x10C4, 0x817E) }, /* CESINEL MEDCAL S Power Quality Monitor */
106 { USB_DEVICE(0x10C4, 0x818B) }, /* AVIT Research USB to TTL */
107 { USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
108 { USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
109 { USB_DEVICE(0x10C4, 0x81A9) }, /* Multiplex RC Interface */
110 { USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
111 { USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */
112 { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
113 { USB_DEVICE(0x10C4, 0x81D7) }, /* IAI Corp. RCB-CV-USB USB to RS485 Adaptor */
114 { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
115 { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
116 { USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
117 { USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
118 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
119 { USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
120 { USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
121 { USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */
122 { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
123 { USB_DEVICE(0x10C4, 0x82EF) }, /* CESINEL FALCO 6105 AC Power Supply */
124 { USB_DEVICE(0x10C4, 0x82F1) }, /* CESINEL MEDCAL EFD Earth Fault Detector */
125 { USB_DEVICE(0x10C4, 0x82F2) }, /* CESINEL MEDCAL ST Network Analyzer */
126 { USB_DEVICE(0x10C4, 0x82F4) }, /* Starizona MicroTouch */
127 { USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
128 { USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
129 { USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
130 { USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
131 { USB_DEVICE(0x10C4, 0x83AA) }, /* Mark-10 Digital Force Gauge */
132 { USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
133 { USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
134 { USB_DEVICE(0x10C4, 0x8414) }, /* Decagon USB Cable Adapter */
135 { USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
136 { USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
137 { USB_DEVICE(0x10C4, 0x8470) }, /* Juniper Networks BX Series System Console */
138 { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
139 { USB_DEVICE(0x10C4, 0x84B6) }, /* Starizona Hyperion */
140 { USB_DEVICE(0x10C4, 0x851E) }, /* CESINEL MEDCAL PT Network Analyzer */
141 { USB_DEVICE(0x10C4, 0x85A7) }, /* LifeScan OneTouch Verio IQ */
142 { USB_DEVICE(0x10C4, 0x85B8) }, /* CESINEL ReCon T Energy Logger */
143 { USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
144 { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
145 { USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
146 { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
147 { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
148 { USB_DEVICE(0x10C4, 0x8856) }, /* CEL EM357 ZigBee USB Stick - LR */
149 { USB_DEVICE(0x10C4, 0x8857) }, /* CEL EM357 ZigBee USB Stick */
150 { USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
151 { USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
152 { USB_DEVICE(0x10C4, 0x88D8) }, /* Acuity Brands nLight Air Adapter */
153 { USB_DEVICE(0x10C4, 0x88FB) }, /* CESINEL MEDCAL STII Network Analyzer */
154 { USB_DEVICE(0x10C4, 0x8938) }, /* CESINEL MEDCAL S II Network Analyzer */
155 { USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
156 { USB_DEVICE(0x10C4, 0x8962) }, /* Brim Brothers charging dock */
157 { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit Device */
158 { USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
159 { USB_DEVICE(0x10C4, 0x89A4) }, /* CESINEL FTBC Flexible Thyristor Bridge Controller */
160 { USB_DEVICE(0x10C4, 0x89FB) }, /* Qivicon ZigBee USB Radio Stick */
161 { USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
162 { USB_DEVICE(0x10C4, 0x8A5B) }, /* CEL EM3588 ZigBee USB Stick */
163 { USB_DEVICE(0x10C4, 0x8A5E) }, /* CEL EM3588 ZigBee USB Stick Long Range */
164 { USB_DEVICE(0x10C4, 0x8B34) }, /* Qivicon ZigBee USB Radio Stick */
165 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
166 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
167 { USB_DEVICE(0x10C4, 0xEA63) }, /* Silicon Labs Windows Update (CP2101-4/CP2102N) */
168 { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
169 { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
170 { USB_DEVICE(0x10C4, 0xEA7A) }, /* Silicon Labs Windows Update (CP2105) */
171 { USB_DEVICE(0x10C4, 0xEA7B) }, /* Silicon Labs Windows Update (CP2108) */
172 { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
173 { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
174 { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
175 { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
176 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
177 { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
178 { USB_DEVICE(0x12B8, 0xEC60) }, /* Link G4 ECU */
179 { USB_DEVICE(0x12B8, 0xEC62) }, /* Link G4+ ECU */
180 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
181 { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
182 { USB_DEVICE(0x155A, 0x1006) }, /* ELDAT Easywave RX09 */
183 { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
184 { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
185 { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
186 { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
187 { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
188 { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
189 { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
190 { USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
191 { USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
192 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
193 { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
194 { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
195 { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
196 { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
197 { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
198 { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
199 { USB_DEVICE(0x17A8, 0x0011) }, /* Kamstrup 444 MHz RF sniffer */
200 { USB_DEVICE(0x17A8, 0x0013) }, /* Kamstrup 870 MHz RF sniffer */
201 { USB_DEVICE(0x17A8, 0x0101) }, /* Kamstrup 868 MHz wM-Bus C-Mode Meter Reader (Int Ant) */
202 { USB_DEVICE(0x17A8, 0x0102) }, /* Kamstrup 868 MHz wM-Bus C-Mode Meter Reader (Ext Ant) */
203 { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
204 { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
205 { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
206 { USB_DEVICE(0x18EF, 0xE025) }, /* ELV Marble Sound Board 1 */
207 { USB_DEVICE(0x18EF, 0xE030) }, /* ELV ALC 8xxx Battery Charger */
208 { USB_DEVICE(0x18EF, 0xE032) }, /* ELV TFD500 Data Logger */
209 { USB_DEVICE(0x1901, 0x0190) }, /* GE B850 CP2105 Recorder interface */
210 { USB_DEVICE(0x1901, 0x0193) }, /* GE B650 CP2104 PMC interface */
211 { USB_DEVICE(0x1901, 0x0194) }, /* GE Healthcare Remote Alarm Box */
212 { USB_DEVICE(0x1901, 0x0195) }, /* GE B850/B650/B450 CP2104 DP UART interface */
213 { USB_DEVICE(0x1901, 0x0196) }, /* GE B850 CP2105 DP UART interface */
214 { USB_DEVICE(0x1901, 0x0197) }, /* GE CS1000 M.2 Key E serial interface */
215 { USB_DEVICE(0x1901, 0x0198) }, /* GE CS1000 Display serial interface */
216 { USB_DEVICE(0x199B, 0xBA30) }, /* LORD WSDA-200-USB */
217 { USB_DEVICE(0x19CF, 0x3000) }, /* Parrot NMEA GPS Flight Recorder */
218 { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
219 { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
220 { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
221 { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
222 { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
223 { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
224 { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
225 { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
226 { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
227 { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
228 { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
229 { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
230 { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
231 { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
232 { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
233 { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
234 { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
235 { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
236 { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
237 { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
238 { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
239 { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
240 { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
241 { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
242 { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
243 { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
244 { USB_DEVICE(0x2184, 0x0030) }, /* GW Instek GDM-834x Digital Multimeter */
245 { USB_DEVICE(0x2626, 0xEA60) }, /* Aruba Networks 7xxx USB Serial Console */
246 { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
247 { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
248 { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
249 { USB_DEVICE(0x3923, 0x7A0B) }, /* National Instruments USB Serial Console */
250 { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
251 { } /* Terminating Entry */
252};
253
254MODULE_DEVICE_TABLE(usb, id_table);
255
256struct cp210x_serial_private {
257#ifdef CONFIG_GPIOLIB
258 struct gpio_chip gc;
259 bool gpio_registered;
260 u16 gpio_pushpull;
261 u16 gpio_altfunc;
262 u16 gpio_input;
263#endif
264 u8 partnum;
265 u32 fw_version;
266 speed_t min_speed;
267 speed_t max_speed;
268 bool use_actual_rate;
269 bool no_flow_control;
270 bool no_event_mode;
271};
272
273enum cp210x_event_state {
274 ES_DATA,
275 ES_ESCAPE,
276 ES_LSR,
277 ES_LSR_DATA_0,
278 ES_LSR_DATA_1,
279 ES_MSR
280};
281
282struct cp210x_port_private {
283 u8 bInterfaceNumber;
284 bool event_mode;
285 enum cp210x_event_state event_state;
286 u8 lsr;
287
288 struct mutex mutex;
289 bool crtscts;
290 bool dtr;
291 bool rts;
292};
293
294static struct usb_serial_driver cp210x_device = {
295 .driver = {
296 .owner = THIS_MODULE,
297 .name = "cp210x",
298 },
299 .id_table = id_table,
300 .num_ports = 1,
301 .bulk_in_size = 256,
302 .bulk_out_size = 256,
303 .open = cp210x_open,
304 .close = cp210x_close,
305 .break_ctl = cp210x_break_ctl,
306 .set_termios = cp210x_set_termios,
307 .tx_empty = cp210x_tx_empty,
308 .throttle = usb_serial_generic_throttle,
309 .unthrottle = usb_serial_generic_unthrottle,
310 .tiocmget = cp210x_tiocmget,
311 .tiocmset = cp210x_tiocmset,
312 .get_icount = usb_serial_generic_get_icount,
313 .attach = cp210x_attach,
314 .disconnect = cp210x_disconnect,
315 .release = cp210x_release,
316 .port_probe = cp210x_port_probe,
317 .port_remove = cp210x_port_remove,
318 .dtr_rts = cp210x_dtr_rts,
319 .process_read_urb = cp210x_process_read_urb,
320};
321
322static struct usb_serial_driver * const serial_drivers[] = {
323 &cp210x_device, NULL
324};
325
326/* Config request types */
327#define REQTYPE_HOST_TO_INTERFACE 0x41
328#define REQTYPE_INTERFACE_TO_HOST 0xc1
329#define REQTYPE_HOST_TO_DEVICE 0x40
330#define REQTYPE_DEVICE_TO_HOST 0xc0
331
332/* Config request codes */
333#define CP210X_IFC_ENABLE 0x00
334#define CP210X_SET_BAUDDIV 0x01
335#define CP210X_GET_BAUDDIV 0x02
336#define CP210X_SET_LINE_CTL 0x03
337#define CP210X_GET_LINE_CTL 0x04
338#define CP210X_SET_BREAK 0x05
339#define CP210X_IMM_CHAR 0x06
340#define CP210X_SET_MHS 0x07
341#define CP210X_GET_MDMSTS 0x08
342#define CP210X_SET_XON 0x09
343#define CP210X_SET_XOFF 0x0A
344#define CP210X_SET_EVENTMASK 0x0B
345#define CP210X_GET_EVENTMASK 0x0C
346#define CP210X_SET_CHAR 0x0D
347#define CP210X_GET_CHARS 0x0E
348#define CP210X_GET_PROPS 0x0F
349#define CP210X_GET_COMM_STATUS 0x10
350#define CP210X_RESET 0x11
351#define CP210X_PURGE 0x12
352#define CP210X_SET_FLOW 0x13
353#define CP210X_GET_FLOW 0x14
354#define CP210X_EMBED_EVENTS 0x15
355#define CP210X_GET_EVENTSTATE 0x16
356#define CP210X_SET_CHARS 0x19
357#define CP210X_GET_BAUDRATE 0x1D
358#define CP210X_SET_BAUDRATE 0x1E
359#define CP210X_VENDOR_SPECIFIC 0xFF
360
361/* CP210X_IFC_ENABLE */
362#define UART_ENABLE 0x0001
363#define UART_DISABLE 0x0000
364
365/* CP210X_(SET|GET)_BAUDDIV */
366#define BAUD_RATE_GEN_FREQ 0x384000
367
368/* CP210X_(SET|GET)_LINE_CTL */
369#define BITS_DATA_MASK 0X0f00
370#define BITS_DATA_5 0X0500
371#define BITS_DATA_6 0X0600
372#define BITS_DATA_7 0X0700
373#define BITS_DATA_8 0X0800
374#define BITS_DATA_9 0X0900
375
376#define BITS_PARITY_MASK 0x00f0
377#define BITS_PARITY_NONE 0x0000
378#define BITS_PARITY_ODD 0x0010
379#define BITS_PARITY_EVEN 0x0020
380#define BITS_PARITY_MARK 0x0030
381#define BITS_PARITY_SPACE 0x0040
382
383#define BITS_STOP_MASK 0x000f
384#define BITS_STOP_1 0x0000
385#define BITS_STOP_1_5 0x0001
386#define BITS_STOP_2 0x0002
387
388/* CP210X_SET_BREAK */
389#define BREAK_ON 0x0001
390#define BREAK_OFF 0x0000
391
392/* CP210X_(SET_MHS|GET_MDMSTS) */
393#define CONTROL_DTR 0x0001
394#define CONTROL_RTS 0x0002
395#define CONTROL_CTS 0x0010
396#define CONTROL_DSR 0x0020
397#define CONTROL_RING 0x0040
398#define CONTROL_DCD 0x0080
399#define CONTROL_WRITE_DTR 0x0100
400#define CONTROL_WRITE_RTS 0x0200
401
402/* CP210X_(GET|SET)_CHARS */
403struct cp210x_special_chars {
404 u8 bEofChar;
405 u8 bErrorChar;
406 u8 bBreakChar;
407 u8 bEventChar;
408 u8 bXonChar;
409 u8 bXoffChar;
410};
411
412/* CP210X_VENDOR_SPECIFIC values */
413#define CP210X_GET_FW_VER 0x000E
414#define CP210X_READ_2NCONFIG 0x000E
415#define CP210X_GET_FW_VER_2N 0x0010
416#define CP210X_READ_LATCH 0x00C2
417#define CP210X_GET_PARTNUM 0x370B
418#define CP210X_GET_PORTCONFIG 0x370C
419#define CP210X_GET_DEVICEMODE 0x3711
420#define CP210X_WRITE_LATCH 0x37E1
421
422/* Part number definitions */
423#define CP210X_PARTNUM_CP2101 0x01
424#define CP210X_PARTNUM_CP2102 0x02
425#define CP210X_PARTNUM_CP2103 0x03
426#define CP210X_PARTNUM_CP2104 0x04
427#define CP210X_PARTNUM_CP2105 0x05
428#define CP210X_PARTNUM_CP2108 0x08
429#define CP210X_PARTNUM_CP2102N_QFN28 0x20
430#define CP210X_PARTNUM_CP2102N_QFN24 0x21
431#define CP210X_PARTNUM_CP2102N_QFN20 0x22
432#define CP210X_PARTNUM_UNKNOWN 0xFF
433
434/* CP210X_GET_COMM_STATUS returns these 0x13 bytes */
435struct cp210x_comm_status {
436 __le32 ulErrors;
437 __le32 ulHoldReasons;
438 __le32 ulAmountInInQueue;
439 __le32 ulAmountInOutQueue;
440 u8 bEofReceived;
441 u8 bWaitForImmediate;
442 u8 bReserved;
443} __packed;
444
445/*
446 * CP210X_PURGE - 16 bits passed in wValue of USB request.
447 * SiLabs app note AN571 gives a strange description of the 4 bits:
448 * bit 0 or bit 2 clears the transmit queue and 1 or 3 receive.
449 * writing 1 to all, however, purges cp2108 well enough to avoid the hang.
450 */
451#define PURGE_ALL 0x000f
452
453/* CP210X_EMBED_EVENTS */
454#define CP210X_ESCCHAR 0xec
455
456#define CP210X_LSR_OVERRUN BIT(1)
457#define CP210X_LSR_PARITY BIT(2)
458#define CP210X_LSR_FRAME BIT(3)
459#define CP210X_LSR_BREAK BIT(4)
460
461
462/* CP210X_GET_FLOW/CP210X_SET_FLOW read/write these 0x10 bytes */
463struct cp210x_flow_ctl {
464 __le32 ulControlHandshake;
465 __le32 ulFlowReplace;
466 __le32 ulXonLimit;
467 __le32 ulXoffLimit;
468};
469
470/* cp210x_flow_ctl::ulControlHandshake */
471#define CP210X_SERIAL_DTR_MASK GENMASK(1, 0)
472#define CP210X_SERIAL_DTR_INACTIVE (0 << 0)
473#define CP210X_SERIAL_DTR_ACTIVE (1 << 0)
474#define CP210X_SERIAL_DTR_FLOW_CTL (2 << 0)
475#define CP210X_SERIAL_CTS_HANDSHAKE BIT(3)
476#define CP210X_SERIAL_DSR_HANDSHAKE BIT(4)
477#define CP210X_SERIAL_DCD_HANDSHAKE BIT(5)
478#define CP210X_SERIAL_DSR_SENSITIVITY BIT(6)
479
480/* cp210x_flow_ctl::ulFlowReplace */
481#define CP210X_SERIAL_AUTO_TRANSMIT BIT(0)
482#define CP210X_SERIAL_AUTO_RECEIVE BIT(1)
483#define CP210X_SERIAL_ERROR_CHAR BIT(2)
484#define CP210X_SERIAL_NULL_STRIPPING BIT(3)
485#define CP210X_SERIAL_BREAK_CHAR BIT(4)
486#define CP210X_SERIAL_RTS_MASK GENMASK(7, 6)
487#define CP210X_SERIAL_RTS_INACTIVE (0 << 6)
488#define CP210X_SERIAL_RTS_ACTIVE (1 << 6)
489#define CP210X_SERIAL_RTS_FLOW_CTL (2 << 6)
490#define CP210X_SERIAL_XOFF_CONTINUE BIT(31)
491
492/* CP210X_VENDOR_SPECIFIC, CP210X_GET_DEVICEMODE call reads these 0x2 bytes. */
493struct cp210x_pin_mode {
494 u8 eci;
495 u8 sci;
496};
497
498#define CP210X_PIN_MODE_MODEM 0
499#define CP210X_PIN_MODE_GPIO BIT(0)
500
501/*
502 * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xf bytes
503 * on a CP2105 chip. Structure needs padding due to unused/unspecified bytes.
504 */
505struct cp210x_dual_port_config {
506 __le16 gpio_mode;
507 u8 __pad0[2];
508 __le16 reset_state;
509 u8 __pad1[4];
510 __le16 suspend_state;
511 u8 sci_cfg;
512 u8 eci_cfg;
513 u8 device_cfg;
514} __packed;
515
516/*
517 * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xd bytes
518 * on a CP2104 chip. Structure needs padding due to unused/unspecified bytes.
519 */
520struct cp210x_single_port_config {
521 __le16 gpio_mode;
522 u8 __pad0[2];
523 __le16 reset_state;
524 u8 __pad1[4];
525 __le16 suspend_state;
526 u8 device_cfg;
527} __packed;
528
529/* GPIO modes */
530#define CP210X_SCI_GPIO_MODE_OFFSET 9
531#define CP210X_SCI_GPIO_MODE_MASK GENMASK(11, 9)
532
533#define CP210X_ECI_GPIO_MODE_OFFSET 2
534#define CP210X_ECI_GPIO_MODE_MASK GENMASK(3, 2)
535
536#define CP210X_GPIO_MODE_OFFSET 8
537#define CP210X_GPIO_MODE_MASK GENMASK(11, 8)
538
539/* CP2105 port configuration values */
540#define CP2105_GPIO0_TXLED_MODE BIT(0)
541#define CP2105_GPIO1_RXLED_MODE BIT(1)
542#define CP2105_GPIO1_RS485_MODE BIT(2)
543
544/* CP2104 port configuration values */
545#define CP2104_GPIO0_TXLED_MODE BIT(0)
546#define CP2104_GPIO1_RXLED_MODE BIT(1)
547#define CP2104_GPIO2_RS485_MODE BIT(2)
548
549struct cp210x_quad_port_state {
550 __le16 gpio_mode_pb0;
551 __le16 gpio_mode_pb1;
552 __le16 gpio_mode_pb2;
553 __le16 gpio_mode_pb3;
554 __le16 gpio_mode_pb4;
555
556 __le16 gpio_lowpower_pb0;
557 __le16 gpio_lowpower_pb1;
558 __le16 gpio_lowpower_pb2;
559 __le16 gpio_lowpower_pb3;
560 __le16 gpio_lowpower_pb4;
561
562 __le16 gpio_latch_pb0;
563 __le16 gpio_latch_pb1;
564 __le16 gpio_latch_pb2;
565 __le16 gpio_latch_pb3;
566 __le16 gpio_latch_pb4;
567};
568
569/*
570 * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0x49 bytes
571 * on a CP2108 chip.
572 *
573 * See https://www.silabs.com/documents/public/application-notes/an978-cp210x-usb-to-uart-api-specification.pdf
574 */
575struct cp210x_quad_port_config {
576 struct cp210x_quad_port_state reset_state;
577 struct cp210x_quad_port_state suspend_state;
578 u8 ipdelay_ifc[4];
579 u8 enhancedfxn_ifc[4];
580 u8 enhancedfxn_device;
581 u8 extclkfreq[4];
582} __packed;
583
584#define CP2108_EF_IFC_GPIO_TXLED 0x01
585#define CP2108_EF_IFC_GPIO_RXLED 0x02
586#define CP2108_EF_IFC_GPIO_RS485 0x04
587#define CP2108_EF_IFC_GPIO_RS485_LOGIC 0x08
588#define CP2108_EF_IFC_GPIO_CLOCK 0x10
589#define CP2108_EF_IFC_DYNAMIC_SUSPEND 0x40
590
591/* CP2102N configuration array indices */
592#define CP210X_2NCONFIG_CONFIG_VERSION_IDX 2
593#define CP210X_2NCONFIG_GPIO_MODE_IDX 581
594#define CP210X_2NCONFIG_GPIO_RSTLATCH_IDX 587
595#define CP210X_2NCONFIG_GPIO_CONTROL_IDX 600
596
597/* CP2102N QFN20 port configuration values */
598#define CP2102N_QFN20_GPIO2_TXLED_MODE BIT(2)
599#define CP2102N_QFN20_GPIO3_RXLED_MODE BIT(3)
600#define CP2102N_QFN20_GPIO1_RS485_MODE BIT(4)
601#define CP2102N_QFN20_GPIO0_CLK_MODE BIT(6)
602
603/*
604 * CP210X_VENDOR_SPECIFIC, CP210X_WRITE_LATCH call writes these 0x02 bytes
605 * for CP2102N, CP2103, CP2104 and CP2105.
606 */
607struct cp210x_gpio_write {
608 u8 mask;
609 u8 state;
610};
611
612/*
613 * CP210X_VENDOR_SPECIFIC, CP210X_WRITE_LATCH call writes these 0x04 bytes
614 * for CP2108.
615 */
616struct cp210x_gpio_write16 {
617 __le16 mask;
618 __le16 state;
619};
620
621/*
622 * Helper to get interface number when we only have struct usb_serial.
623 */
624static u8 cp210x_interface_num(struct usb_serial *serial)
625{
626 struct usb_host_interface *cur_altsetting;
627
628 cur_altsetting = serial->interface->cur_altsetting;
629
630 return cur_altsetting->desc.bInterfaceNumber;
631}
632
633/*
634 * Reads a variable-sized block of CP210X_ registers, identified by req.
635 * Returns data into buf in native USB byte order.
636 */
637static int cp210x_read_reg_block(struct usb_serial_port *port, u8 req,
638 void *buf, int bufsize)
639{
640 struct usb_serial *serial = port->serial;
641 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
642 int result;
643
644
645 result = usb_control_msg_recv(serial->dev, 0, req,
646 REQTYPE_INTERFACE_TO_HOST, 0,
647 port_priv->bInterfaceNumber, buf, bufsize,
648 USB_CTRL_SET_TIMEOUT, GFP_KERNEL);
649 if (result) {
650 dev_err(&port->dev, "failed get req 0x%x size %d status: %d\n",
651 req, bufsize, result);
652 return result;
653 }
654
655 return 0;
656}
657
658/*
659 * Reads any 8-bit CP210X_ register identified by req.
660 */
661static int cp210x_read_u8_reg(struct usb_serial_port *port, u8 req, u8 *val)
662{
663 return cp210x_read_reg_block(port, req, val, sizeof(*val));
664}
665
666/*
667 * Reads a variable-sized vendor block of CP210X_ registers, identified by val.
668 * Returns data into buf in native USB byte order.
669 */
670static int cp210x_read_vendor_block(struct usb_serial *serial, u8 type, u16 val,
671 void *buf, int bufsize)
672{
673 int result;
674
675 result = usb_control_msg_recv(serial->dev, 0, CP210X_VENDOR_SPECIFIC,
676 type, val, cp210x_interface_num(serial), buf, bufsize,
677 USB_CTRL_GET_TIMEOUT, GFP_KERNEL);
678 if (result) {
679 dev_err(&serial->interface->dev,
680 "failed to get vendor val 0x%04x size %d: %d\n", val,
681 bufsize, result);
682 return result;
683 }
684
685 return 0;
686}
687
688/*
689 * Writes any 16-bit CP210X_ register (req) whose value is passed
690 * entirely in the wValue field of the USB request.
691 */
692static int cp210x_write_u16_reg(struct usb_serial_port *port, u8 req, u16 val)
693{
694 struct usb_serial *serial = port->serial;
695 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
696 int result;
697
698 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
699 req, REQTYPE_HOST_TO_INTERFACE, val,
700 port_priv->bInterfaceNumber, NULL, 0,
701 USB_CTRL_SET_TIMEOUT);
702 if (result < 0) {
703 dev_err(&port->dev, "failed set request 0x%x status: %d\n",
704 req, result);
705 }
706
707 return result;
708}
709
710/*
711 * Writes a variable-sized block of CP210X_ registers, identified by req.
712 * Data in buf must be in native USB byte order.
713 */
714static int cp210x_write_reg_block(struct usb_serial_port *port, u8 req,
715 void *buf, int bufsize)
716{
717 struct usb_serial *serial = port->serial;
718 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
719 int result;
720
721 result = usb_control_msg_send(serial->dev, 0, req,
722 REQTYPE_HOST_TO_INTERFACE, 0,
723 port_priv->bInterfaceNumber, buf, bufsize,
724 USB_CTRL_SET_TIMEOUT, GFP_KERNEL);
725 if (result) {
726 dev_err(&port->dev, "failed set req 0x%x size %d status: %d\n",
727 req, bufsize, result);
728 return result;
729 }
730
731 return 0;
732}
733
734/*
735 * Writes any 32-bit CP210X_ register identified by req.
736 */
737static int cp210x_write_u32_reg(struct usb_serial_port *port, u8 req, u32 val)
738{
739 __le32 le32_val;
740
741 le32_val = cpu_to_le32(val);
742
743 return cp210x_write_reg_block(port, req, &le32_val, sizeof(le32_val));
744}
745
746#ifdef CONFIG_GPIOLIB
747/*
748 * Writes a variable-sized vendor block of CP210X_ registers, identified by val.
749 * Data in buf must be in native USB byte order.
750 */
751static int cp210x_write_vendor_block(struct usb_serial *serial, u8 type,
752 u16 val, void *buf, int bufsize)
753{
754 int result;
755
756 result = usb_control_msg_send(serial->dev, 0, CP210X_VENDOR_SPECIFIC,
757 type, val, cp210x_interface_num(serial), buf, bufsize,
758 USB_CTRL_SET_TIMEOUT, GFP_KERNEL);
759 if (result) {
760 dev_err(&serial->interface->dev,
761 "failed to set vendor val 0x%04x size %d: %d\n", val,
762 bufsize, result);
763 return result;
764 }
765
766 return 0;
767}
768#endif
769
770static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
771{
772 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
773 int result;
774
775 result = cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_ENABLE);
776 if (result) {
777 dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
778 return result;
779 }
780
781 if (tty)
782 cp210x_set_termios(tty, port, NULL);
783
784 result = usb_serial_generic_open(tty, port);
785 if (result)
786 goto err_disable;
787
788 return 0;
789
790err_disable:
791 cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
792 port_priv->event_mode = false;
793
794 return result;
795}
796
797static void cp210x_close(struct usb_serial_port *port)
798{
799 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
800
801 usb_serial_generic_close(port);
802
803 /* Clear both queues; cp2108 needs this to avoid an occasional hang */
804 cp210x_write_u16_reg(port, CP210X_PURGE, PURGE_ALL);
805
806 cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
807
808 /* Disabling the interface disables event-insertion mode. */
809 port_priv->event_mode = false;
810}
811
812static void cp210x_process_lsr(struct usb_serial_port *port, unsigned char lsr, char *flag)
813{
814 if (lsr & CP210X_LSR_BREAK) {
815 port->icount.brk++;
816 *flag = TTY_BREAK;
817 } else if (lsr & CP210X_LSR_PARITY) {
818 port->icount.parity++;
819 *flag = TTY_PARITY;
820 } else if (lsr & CP210X_LSR_FRAME) {
821 port->icount.frame++;
822 *flag = TTY_FRAME;
823 }
824
825 if (lsr & CP210X_LSR_OVERRUN) {
826 port->icount.overrun++;
827 tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
828 }
829}
830
831static bool cp210x_process_char(struct usb_serial_port *port, unsigned char *ch, char *flag)
832{
833 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
834
835 switch (port_priv->event_state) {
836 case ES_DATA:
837 if (*ch == CP210X_ESCCHAR) {
838 port_priv->event_state = ES_ESCAPE;
839 break;
840 }
841 return false;
842 case ES_ESCAPE:
843 switch (*ch) {
844 case 0:
845 dev_dbg(&port->dev, "%s - escape char\n", __func__);
846 *ch = CP210X_ESCCHAR;
847 port_priv->event_state = ES_DATA;
848 return false;
849 case 1:
850 port_priv->event_state = ES_LSR_DATA_0;
851 break;
852 case 2:
853 port_priv->event_state = ES_LSR;
854 break;
855 case 3:
856 port_priv->event_state = ES_MSR;
857 break;
858 default:
859 dev_err(&port->dev, "malformed event 0x%02x\n", *ch);
860 port_priv->event_state = ES_DATA;
861 break;
862 }
863 break;
864 case ES_LSR_DATA_0:
865 port_priv->lsr = *ch;
866 port_priv->event_state = ES_LSR_DATA_1;
867 break;
868 case ES_LSR_DATA_1:
869 dev_dbg(&port->dev, "%s - lsr = 0x%02x, data = 0x%02x\n",
870 __func__, port_priv->lsr, *ch);
871 cp210x_process_lsr(port, port_priv->lsr, flag);
872 port_priv->event_state = ES_DATA;
873 return false;
874 case ES_LSR:
875 dev_dbg(&port->dev, "%s - lsr = 0x%02x\n", __func__, *ch);
876 port_priv->lsr = *ch;
877 cp210x_process_lsr(port, port_priv->lsr, flag);
878 port_priv->event_state = ES_DATA;
879 break;
880 case ES_MSR:
881 dev_dbg(&port->dev, "%s - msr = 0x%02x\n", __func__, *ch);
882 /* unimplemented */
883 port_priv->event_state = ES_DATA;
884 break;
885 }
886
887 return true;
888}
889
890static void cp210x_process_read_urb(struct urb *urb)
891{
892 struct usb_serial_port *port = urb->context;
893 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
894 unsigned char *ch = urb->transfer_buffer;
895 char flag;
896 int i;
897
898 if (!urb->actual_length)
899 return;
900
901 if (port_priv->event_mode) {
902 for (i = 0; i < urb->actual_length; i++, ch++) {
903 flag = TTY_NORMAL;
904
905 if (cp210x_process_char(port, ch, &flag))
906 continue;
907
908 tty_insert_flip_char(&port->port, *ch, flag);
909 }
910 } else {
911 tty_insert_flip_string(&port->port, ch, urb->actual_length);
912 }
913 tty_flip_buffer_push(&port->port);
914}
915
916/*
917 * Read how many bytes are waiting in the TX queue.
918 */
919static int cp210x_get_tx_queue_byte_count(struct usb_serial_port *port,
920 u32 *count)
921{
922 struct usb_serial *serial = port->serial;
923 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
924 struct cp210x_comm_status sts;
925 int result;
926
927 result = usb_control_msg_recv(serial->dev, 0, CP210X_GET_COMM_STATUS,
928 REQTYPE_INTERFACE_TO_HOST, 0,
929 port_priv->bInterfaceNumber, &sts, sizeof(sts),
930 USB_CTRL_GET_TIMEOUT, GFP_KERNEL);
931 if (result) {
932 dev_err(&port->dev, "failed to get comm status: %d\n", result);
933 return result;
934 }
935
936 *count = le32_to_cpu(sts.ulAmountInOutQueue);
937
938 return 0;
939}
940
941static bool cp210x_tx_empty(struct usb_serial_port *port)
942{
943 int err;
944 u32 count;
945
946 err = cp210x_get_tx_queue_byte_count(port, &count);
947 if (err)
948 return true;
949
950 return !count;
951}
952
953struct cp210x_rate {
954 speed_t rate;
955 speed_t high;
956};
957
958static const struct cp210x_rate cp210x_an205_table1[] = {
959 { 300, 300 },
960 { 600, 600 },
961 { 1200, 1200 },
962 { 1800, 1800 },
963 { 2400, 2400 },
964 { 4000, 4000 },
965 { 4800, 4803 },
966 { 7200, 7207 },
967 { 9600, 9612 },
968 { 14400, 14428 },
969 { 16000, 16062 },
970 { 19200, 19250 },
971 { 28800, 28912 },
972 { 38400, 38601 },
973 { 51200, 51558 },
974 { 56000, 56280 },
975 { 57600, 58053 },
976 { 64000, 64111 },
977 { 76800, 77608 },
978 { 115200, 117028 },
979 { 128000, 129347 },
980 { 153600, 156868 },
981 { 230400, 237832 },
982 { 250000, 254234 },
983 { 256000, 273066 },
984 { 460800, 491520 },
985 { 500000, 567138 },
986 { 576000, 670254 },
987 { 921600, UINT_MAX }
988};
989
990/*
991 * Quantises the baud rate as per AN205 Table 1
992 */
993static speed_t cp210x_get_an205_rate(speed_t baud)
994{
995 int i;
996
997 for (i = 0; i < ARRAY_SIZE(cp210x_an205_table1); ++i) {
998 if (baud <= cp210x_an205_table1[i].high)
999 break;
1000 }
1001
1002 return cp210x_an205_table1[i].rate;
1003}
1004
1005static speed_t cp210x_get_actual_rate(speed_t baud)
1006{
1007 unsigned int prescale = 1;
1008 unsigned int div;
1009
1010 if (baud <= 365)
1011 prescale = 4;
1012
1013 div = DIV_ROUND_CLOSEST(48000000, 2 * prescale * baud);
1014 baud = 48000000 / (2 * prescale * div);
1015
1016 return baud;
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 */
1045static void cp210x_change_speed(struct tty_struct *tty,
1046 struct usb_serial_port *port,
1047 const struct ktermios *old_termios)
1048{
1049 struct usb_serial *serial = port->serial;
1050 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1051 u32 baud;
1052
1053 if (tty->termios.c_ospeed == 0)
1054 return;
1055
1056 /*
1057 * This maps the requested rate to the actual rate, a valid rate on
1058 * cp2102 or cp2103, or to an arbitrary rate in [1M, max_speed].
1059 */
1060 baud = clamp(tty->termios.c_ospeed, priv->min_speed, priv->max_speed);
1061
1062 if (priv->use_actual_rate)
1063 baud = cp210x_get_actual_rate(baud);
1064 else if (baud < 1000000)
1065 baud = cp210x_get_an205_rate(baud);
1066
1067 dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
1068 if (cp210x_write_u32_reg(port, CP210X_SET_BAUDRATE, baud)) {
1069 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
1070 if (old_termios)
1071 baud = old_termios->c_ospeed;
1072 else
1073 baud = 9600;
1074 }
1075
1076 tty_encode_baud_rate(tty, baud, baud);
1077}
1078
1079static void cp210x_enable_event_mode(struct usb_serial_port *port)
1080{
1081 struct cp210x_serial_private *priv = usb_get_serial_data(port->serial);
1082 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1083 int ret;
1084
1085 if (port_priv->event_mode)
1086 return;
1087
1088 if (priv->no_event_mode)
1089 return;
1090
1091 port_priv->event_state = ES_DATA;
1092 port_priv->event_mode = true;
1093
1094 ret = cp210x_write_u16_reg(port, CP210X_EMBED_EVENTS, CP210X_ESCCHAR);
1095 if (ret) {
1096 dev_err(&port->dev, "failed to enable events: %d\n", ret);
1097 port_priv->event_mode = false;
1098 }
1099}
1100
1101static void cp210x_disable_event_mode(struct usb_serial_port *port)
1102{
1103 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1104 int ret;
1105
1106 if (!port_priv->event_mode)
1107 return;
1108
1109 ret = cp210x_write_u16_reg(port, CP210X_EMBED_EVENTS, 0);
1110 if (ret) {
1111 dev_err(&port->dev, "failed to disable events: %d\n", ret);
1112 return;
1113 }
1114
1115 port_priv->event_mode = false;
1116}
1117
1118static bool cp210x_termios_change(const struct ktermios *a, const struct ktermios *b)
1119{
1120 bool iflag_change, cc_change;
1121
1122 iflag_change = ((a->c_iflag ^ b->c_iflag) & (INPCK | IXON | IXOFF));
1123 cc_change = a->c_cc[VSTART] != b->c_cc[VSTART] ||
1124 a->c_cc[VSTOP] != b->c_cc[VSTOP];
1125
1126 return tty_termios_hw_change(a, b) || iflag_change || cc_change;
1127}
1128
1129static void cp210x_set_flow_control(struct tty_struct *tty,
1130 struct usb_serial_port *port,
1131 const struct ktermios *old_termios)
1132{
1133 struct cp210x_serial_private *priv = usb_get_serial_data(port->serial);
1134 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1135 struct cp210x_special_chars chars;
1136 struct cp210x_flow_ctl flow_ctl;
1137 u32 flow_repl;
1138 u32 ctl_hs;
1139 bool crtscts;
1140 int ret;
1141
1142 /*
1143 * Some CP2102N interpret ulXonLimit as ulFlowReplace (erratum
1144 * CP2102N_E104). Report back that flow control is not supported.
1145 */
1146 if (priv->no_flow_control) {
1147 tty->termios.c_cflag &= ~CRTSCTS;
1148 tty->termios.c_iflag &= ~(IXON | IXOFF);
1149 }
1150
1151 if (tty->termios.c_ospeed != 0 &&
1152 old_termios && old_termios->c_ospeed != 0 &&
1153 C_CRTSCTS(tty) == (old_termios->c_cflag & CRTSCTS) &&
1154 I_IXON(tty) == (old_termios->c_iflag & IXON) &&
1155 I_IXOFF(tty) == (old_termios->c_iflag & IXOFF) &&
1156 START_CHAR(tty) == old_termios->c_cc[VSTART] &&
1157 STOP_CHAR(tty) == old_termios->c_cc[VSTOP]) {
1158 return;
1159 }
1160
1161 if (I_IXON(tty) || I_IXOFF(tty)) {
1162 memset(&chars, 0, sizeof(chars));
1163
1164 chars.bXonChar = START_CHAR(tty);
1165 chars.bXoffChar = STOP_CHAR(tty);
1166
1167 ret = cp210x_write_reg_block(port, CP210X_SET_CHARS, &chars,
1168 sizeof(chars));
1169 if (ret) {
1170 dev_err(&port->dev, "failed to set special chars: %d\n",
1171 ret);
1172 }
1173 }
1174
1175 mutex_lock(&port_priv->mutex);
1176
1177 if (tty->termios.c_ospeed == 0) {
1178 port_priv->dtr = false;
1179 port_priv->rts = false;
1180 } else if (old_termios && old_termios->c_ospeed == 0) {
1181 port_priv->dtr = true;
1182 port_priv->rts = true;
1183 }
1184
1185 ret = cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1186 sizeof(flow_ctl));
1187 if (ret)
1188 goto out_unlock;
1189
1190 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1191 flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1192
1193 ctl_hs &= ~CP210X_SERIAL_DSR_HANDSHAKE;
1194 ctl_hs &= ~CP210X_SERIAL_DCD_HANDSHAKE;
1195 ctl_hs &= ~CP210X_SERIAL_DSR_SENSITIVITY;
1196 ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1197 if (port_priv->dtr)
1198 ctl_hs |= CP210X_SERIAL_DTR_ACTIVE;
1199 else
1200 ctl_hs |= CP210X_SERIAL_DTR_INACTIVE;
1201
1202 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1203 if (C_CRTSCTS(tty)) {
1204 ctl_hs |= CP210X_SERIAL_CTS_HANDSHAKE;
1205 if (port_priv->rts)
1206 flow_repl |= CP210X_SERIAL_RTS_FLOW_CTL;
1207 else
1208 flow_repl |= CP210X_SERIAL_RTS_INACTIVE;
1209 crtscts = true;
1210 } else {
1211 ctl_hs &= ~CP210X_SERIAL_CTS_HANDSHAKE;
1212 if (port_priv->rts)
1213 flow_repl |= CP210X_SERIAL_RTS_ACTIVE;
1214 else
1215 flow_repl |= CP210X_SERIAL_RTS_INACTIVE;
1216 crtscts = false;
1217 }
1218
1219 if (I_IXOFF(tty)) {
1220 flow_repl |= CP210X_SERIAL_AUTO_RECEIVE;
1221
1222 flow_ctl.ulXonLimit = cpu_to_le32(128);
1223 flow_ctl.ulXoffLimit = cpu_to_le32(128);
1224 } else {
1225 flow_repl &= ~CP210X_SERIAL_AUTO_RECEIVE;
1226 }
1227
1228 if (I_IXON(tty))
1229 flow_repl |= CP210X_SERIAL_AUTO_TRANSMIT;
1230 else
1231 flow_repl &= ~CP210X_SERIAL_AUTO_TRANSMIT;
1232
1233 dev_dbg(&port->dev, "%s - ctrl = 0x%02x, flow = 0x%02x\n", __func__,
1234 ctl_hs, flow_repl);
1235
1236 flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1237 flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1238
1239 ret = cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1240 sizeof(flow_ctl));
1241 if (ret)
1242 goto out_unlock;
1243
1244 port_priv->crtscts = crtscts;
1245out_unlock:
1246 mutex_unlock(&port_priv->mutex);
1247}
1248
1249static void cp210x_set_termios(struct tty_struct *tty,
1250 struct usb_serial_port *port,
1251 const struct ktermios *old_termios)
1252{
1253 struct cp210x_serial_private *priv = usb_get_serial_data(port->serial);
1254 u16 bits;
1255 int ret;
1256
1257 if (old_termios && !cp210x_termios_change(&tty->termios, old_termios) &&
1258 tty->termios.c_ospeed != 0)
1259 return;
1260
1261 if (!old_termios || tty->termios.c_ospeed != old_termios->c_ospeed)
1262 cp210x_change_speed(tty, port, old_termios);
1263
1264 /* CP2101 only supports CS8, 1 stop bit and non-stick parity. */
1265 if (priv->partnum == CP210X_PARTNUM_CP2101) {
1266 tty->termios.c_cflag &= ~(CSIZE | CSTOPB | CMSPAR);
1267 tty->termios.c_cflag |= CS8;
1268 }
1269
1270 bits = 0;
1271
1272 switch (C_CSIZE(tty)) {
1273 case CS5:
1274 bits |= BITS_DATA_5;
1275 break;
1276 case CS6:
1277 bits |= BITS_DATA_6;
1278 break;
1279 case CS7:
1280 bits |= BITS_DATA_7;
1281 break;
1282 case CS8:
1283 default:
1284 bits |= BITS_DATA_8;
1285 break;
1286 }
1287
1288 if (C_PARENB(tty)) {
1289 if (C_CMSPAR(tty)) {
1290 if (C_PARODD(tty))
1291 bits |= BITS_PARITY_MARK;
1292 else
1293 bits |= BITS_PARITY_SPACE;
1294 } else {
1295 if (C_PARODD(tty))
1296 bits |= BITS_PARITY_ODD;
1297 else
1298 bits |= BITS_PARITY_EVEN;
1299 }
1300 }
1301
1302 if (C_CSTOPB(tty))
1303 bits |= BITS_STOP_2;
1304 else
1305 bits |= BITS_STOP_1;
1306
1307 ret = cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
1308 if (ret)
1309 dev_err(&port->dev, "failed to set line control: %d\n", ret);
1310
1311 cp210x_set_flow_control(tty, port, old_termios);
1312
1313 /*
1314 * Enable event-insertion mode only if input parity checking is
1315 * enabled for now.
1316 */
1317 if (I_INPCK(tty))
1318 cp210x_enable_event_mode(port);
1319 else
1320 cp210x_disable_event_mode(port);
1321}
1322
1323static int cp210x_tiocmset(struct tty_struct *tty,
1324 unsigned int set, unsigned int clear)
1325{
1326 struct usb_serial_port *port = tty->driver_data;
1327 return cp210x_tiocmset_port(port, set, clear);
1328}
1329
1330static int cp210x_tiocmset_port(struct usb_serial_port *port,
1331 unsigned int set, unsigned int clear)
1332{
1333 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1334 struct cp210x_flow_ctl flow_ctl;
1335 u32 ctl_hs, flow_repl;
1336 u16 control = 0;
1337 int ret;
1338
1339 mutex_lock(&port_priv->mutex);
1340
1341 if (set & TIOCM_RTS) {
1342 port_priv->rts = true;
1343 control |= CONTROL_RTS;
1344 control |= CONTROL_WRITE_RTS;
1345 }
1346 if (set & TIOCM_DTR) {
1347 port_priv->dtr = true;
1348 control |= CONTROL_DTR;
1349 control |= CONTROL_WRITE_DTR;
1350 }
1351 if (clear & TIOCM_RTS) {
1352 port_priv->rts = false;
1353 control &= ~CONTROL_RTS;
1354 control |= CONTROL_WRITE_RTS;
1355 }
1356 if (clear & TIOCM_DTR) {
1357 port_priv->dtr = false;
1358 control &= ~CONTROL_DTR;
1359 control |= CONTROL_WRITE_DTR;
1360 }
1361
1362 /*
1363 * Use SET_FLOW to set DTR and enable/disable auto-RTS when hardware
1364 * flow control is enabled.
1365 */
1366 if (port_priv->crtscts && control & CONTROL_WRITE_RTS) {
1367 ret = cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1368 sizeof(flow_ctl));
1369 if (ret)
1370 goto out_unlock;
1371
1372 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1373 flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1374
1375 ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1376 if (port_priv->dtr)
1377 ctl_hs |= CP210X_SERIAL_DTR_ACTIVE;
1378 else
1379 ctl_hs |= CP210X_SERIAL_DTR_INACTIVE;
1380
1381 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1382 if (port_priv->rts)
1383 flow_repl |= CP210X_SERIAL_RTS_FLOW_CTL;
1384 else
1385 flow_repl |= CP210X_SERIAL_RTS_INACTIVE;
1386
1387 flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1388 flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1389
1390 dev_dbg(&port->dev, "%s - ctrl = 0x%02x, flow = 0x%02x\n",
1391 __func__, ctl_hs, flow_repl);
1392
1393 ret = cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1394 sizeof(flow_ctl));
1395 } else {
1396 dev_dbg(&port->dev, "%s - control = 0x%04x\n", __func__, control);
1397
1398 ret = cp210x_write_u16_reg(port, CP210X_SET_MHS, control);
1399 }
1400out_unlock:
1401 mutex_unlock(&port_priv->mutex);
1402
1403 return ret;
1404}
1405
1406static void cp210x_dtr_rts(struct usb_serial_port *port, int on)
1407{
1408 if (on)
1409 cp210x_tiocmset_port(port, TIOCM_DTR | TIOCM_RTS, 0);
1410 else
1411 cp210x_tiocmset_port(port, 0, TIOCM_DTR | TIOCM_RTS);
1412}
1413
1414static int cp210x_tiocmget(struct tty_struct *tty)
1415{
1416 struct usb_serial_port *port = tty->driver_data;
1417 u8 control;
1418 int result;
1419
1420 result = cp210x_read_u8_reg(port, CP210X_GET_MDMSTS, &control);
1421 if (result)
1422 return result;
1423
1424 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
1425 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
1426 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
1427 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
1428 |((control & CONTROL_RING)? TIOCM_RI : 0)
1429 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
1430
1431 dev_dbg(&port->dev, "%s - control = 0x%02x\n", __func__, control);
1432
1433 return result;
1434}
1435
1436static void cp210x_break_ctl(struct tty_struct *tty, int break_state)
1437{
1438 struct usb_serial_port *port = tty->driver_data;
1439 u16 state;
1440
1441 if (break_state == 0)
1442 state = BREAK_OFF;
1443 else
1444 state = BREAK_ON;
1445 dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
1446 state == BREAK_OFF ? "off" : "on");
1447 cp210x_write_u16_reg(port, CP210X_SET_BREAK, state);
1448}
1449
1450#ifdef CONFIG_GPIOLIB
1451static int cp210x_gpio_get(struct gpio_chip *gc, unsigned int gpio)
1452{
1453 struct usb_serial *serial = gpiochip_get_data(gc);
1454 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1455 u8 req_type;
1456 u16 mask;
1457 int result;
1458 int len;
1459
1460 result = usb_autopm_get_interface(serial->interface);
1461 if (result)
1462 return result;
1463
1464 switch (priv->partnum) {
1465 case CP210X_PARTNUM_CP2105:
1466 req_type = REQTYPE_INTERFACE_TO_HOST;
1467 len = 1;
1468 break;
1469 case CP210X_PARTNUM_CP2108:
1470 req_type = REQTYPE_INTERFACE_TO_HOST;
1471 len = 2;
1472 break;
1473 default:
1474 req_type = REQTYPE_DEVICE_TO_HOST;
1475 len = 1;
1476 break;
1477 }
1478
1479 mask = 0;
1480 result = cp210x_read_vendor_block(serial, req_type, CP210X_READ_LATCH,
1481 &mask, len);
1482
1483 usb_autopm_put_interface(serial->interface);
1484
1485 if (result < 0)
1486 return result;
1487
1488 le16_to_cpus(&mask);
1489
1490 return !!(mask & BIT(gpio));
1491}
1492
1493static void cp210x_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)
1494{
1495 struct usb_serial *serial = gpiochip_get_data(gc);
1496 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1497 struct cp210x_gpio_write16 buf16;
1498 struct cp210x_gpio_write buf;
1499 u16 mask, state;
1500 u16 wIndex;
1501 int result;
1502
1503 if (value == 1)
1504 state = BIT(gpio);
1505 else
1506 state = 0;
1507
1508 mask = BIT(gpio);
1509
1510 result = usb_autopm_get_interface(serial->interface);
1511 if (result)
1512 goto out;
1513
1514 switch (priv->partnum) {
1515 case CP210X_PARTNUM_CP2105:
1516 buf.mask = (u8)mask;
1517 buf.state = (u8)state;
1518 result = cp210x_write_vendor_block(serial,
1519 REQTYPE_HOST_TO_INTERFACE,
1520 CP210X_WRITE_LATCH, &buf,
1521 sizeof(buf));
1522 break;
1523 case CP210X_PARTNUM_CP2108:
1524 buf16.mask = cpu_to_le16(mask);
1525 buf16.state = cpu_to_le16(state);
1526 result = cp210x_write_vendor_block(serial,
1527 REQTYPE_HOST_TO_INTERFACE,
1528 CP210X_WRITE_LATCH, &buf16,
1529 sizeof(buf16));
1530 break;
1531 default:
1532 wIndex = state << 8 | mask;
1533 result = usb_control_msg(serial->dev,
1534 usb_sndctrlpipe(serial->dev, 0),
1535 CP210X_VENDOR_SPECIFIC,
1536 REQTYPE_HOST_TO_DEVICE,
1537 CP210X_WRITE_LATCH,
1538 wIndex,
1539 NULL, 0, USB_CTRL_SET_TIMEOUT);
1540 break;
1541 }
1542
1543 usb_autopm_put_interface(serial->interface);
1544out:
1545 if (result < 0) {
1546 dev_err(&serial->interface->dev, "failed to set GPIO value: %d\n",
1547 result);
1548 }
1549}
1550
1551static int cp210x_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
1552{
1553 struct usb_serial *serial = gpiochip_get_data(gc);
1554 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1555
1556 return priv->gpio_input & BIT(gpio);
1557}
1558
1559static int cp210x_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
1560{
1561 struct usb_serial *serial = gpiochip_get_data(gc);
1562 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1563
1564 if (priv->partnum == CP210X_PARTNUM_CP2105) {
1565 /* hardware does not support an input mode */
1566 return -ENOTSUPP;
1567 }
1568
1569 /* push-pull pins cannot be changed to be inputs */
1570 if (priv->gpio_pushpull & BIT(gpio))
1571 return -EINVAL;
1572
1573 /* make sure to release pin if it is being driven low */
1574 cp210x_gpio_set(gc, gpio, 1);
1575
1576 priv->gpio_input |= BIT(gpio);
1577
1578 return 0;
1579}
1580
1581static int cp210x_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
1582 int value)
1583{
1584 struct usb_serial *serial = gpiochip_get_data(gc);
1585 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1586
1587 priv->gpio_input &= ~BIT(gpio);
1588 cp210x_gpio_set(gc, gpio, value);
1589
1590 return 0;
1591}
1592
1593static int cp210x_gpio_set_config(struct gpio_chip *gc, unsigned int gpio,
1594 unsigned long config)
1595{
1596 struct usb_serial *serial = gpiochip_get_data(gc);
1597 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1598 enum pin_config_param param = pinconf_to_config_param(config);
1599
1600 /* Succeed only if in correct mode (this can't be set at runtime) */
1601 if ((param == PIN_CONFIG_DRIVE_PUSH_PULL) &&
1602 (priv->gpio_pushpull & BIT(gpio)))
1603 return 0;
1604
1605 if ((param == PIN_CONFIG_DRIVE_OPEN_DRAIN) &&
1606 !(priv->gpio_pushpull & BIT(gpio)))
1607 return 0;
1608
1609 return -ENOTSUPP;
1610}
1611
1612static int cp210x_gpio_init_valid_mask(struct gpio_chip *gc,
1613 unsigned long *valid_mask, unsigned int ngpios)
1614{
1615 struct usb_serial *serial = gpiochip_get_data(gc);
1616 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1617 struct device *dev = &serial->interface->dev;
1618 unsigned long altfunc_mask = priv->gpio_altfunc;
1619
1620 bitmap_complement(valid_mask, &altfunc_mask, ngpios);
1621
1622 if (bitmap_empty(valid_mask, ngpios))
1623 dev_dbg(dev, "no pin configured for GPIO\n");
1624 else
1625 dev_dbg(dev, "GPIO.%*pbl configured for GPIO\n", ngpios,
1626 valid_mask);
1627 return 0;
1628}
1629
1630/*
1631 * This function is for configuring GPIO using shared pins, where other signals
1632 * are made unavailable by configuring the use of GPIO. This is believed to be
1633 * only applicable to the cp2105 at this point, the other devices supported by
1634 * this driver that provide GPIO do so in a way that does not impact other
1635 * signals and are thus expected to have very different initialisation.
1636 */
1637static int cp2105_gpioconf_init(struct usb_serial *serial)
1638{
1639 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1640 struct cp210x_pin_mode mode;
1641 struct cp210x_dual_port_config config;
1642 u8 intf_num = cp210x_interface_num(serial);
1643 u8 iface_config;
1644 int result;
1645
1646 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1647 CP210X_GET_DEVICEMODE, &mode,
1648 sizeof(mode));
1649 if (result < 0)
1650 return result;
1651
1652 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1653 CP210X_GET_PORTCONFIG, &config,
1654 sizeof(config));
1655 if (result < 0)
1656 return result;
1657
1658 /* 2 banks of GPIO - One for the pins taken from each serial port */
1659 if (intf_num == 0) {
1660 priv->gc.ngpio = 2;
1661
1662 if (mode.eci == CP210X_PIN_MODE_MODEM) {
1663 /* mark all GPIOs of this interface as reserved */
1664 priv->gpio_altfunc = 0xff;
1665 return 0;
1666 }
1667
1668 iface_config = config.eci_cfg;
1669 priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1670 CP210X_ECI_GPIO_MODE_MASK) >>
1671 CP210X_ECI_GPIO_MODE_OFFSET);
1672 } else if (intf_num == 1) {
1673 priv->gc.ngpio = 3;
1674
1675 if (mode.sci == CP210X_PIN_MODE_MODEM) {
1676 /* mark all GPIOs of this interface as reserved */
1677 priv->gpio_altfunc = 0xff;
1678 return 0;
1679 }
1680
1681 iface_config = config.sci_cfg;
1682 priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1683 CP210X_SCI_GPIO_MODE_MASK) >>
1684 CP210X_SCI_GPIO_MODE_OFFSET);
1685 } else {
1686 return -ENODEV;
1687 }
1688
1689 /* mark all pins which are not in GPIO mode */
1690 if (iface_config & CP2105_GPIO0_TXLED_MODE) /* GPIO 0 */
1691 priv->gpio_altfunc |= BIT(0);
1692 if (iface_config & (CP2105_GPIO1_RXLED_MODE | /* GPIO 1 */
1693 CP2105_GPIO1_RS485_MODE))
1694 priv->gpio_altfunc |= BIT(1);
1695
1696 /* driver implementation for CP2105 only supports outputs */
1697 priv->gpio_input = 0;
1698
1699 return 0;
1700}
1701
1702static int cp2104_gpioconf_init(struct usb_serial *serial)
1703{
1704 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1705 struct cp210x_single_port_config config;
1706 u8 iface_config;
1707 u8 gpio_latch;
1708 int result;
1709 u8 i;
1710
1711 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1712 CP210X_GET_PORTCONFIG, &config,
1713 sizeof(config));
1714 if (result < 0)
1715 return result;
1716
1717 priv->gc.ngpio = 4;
1718
1719 iface_config = config.device_cfg;
1720 priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1721 CP210X_GPIO_MODE_MASK) >>
1722 CP210X_GPIO_MODE_OFFSET);
1723 gpio_latch = (u8)((le16_to_cpu(config.reset_state) &
1724 CP210X_GPIO_MODE_MASK) >>
1725 CP210X_GPIO_MODE_OFFSET);
1726
1727 /* mark all pins which are not in GPIO mode */
1728 if (iface_config & CP2104_GPIO0_TXLED_MODE) /* GPIO 0 */
1729 priv->gpio_altfunc |= BIT(0);
1730 if (iface_config & CP2104_GPIO1_RXLED_MODE) /* GPIO 1 */
1731 priv->gpio_altfunc |= BIT(1);
1732 if (iface_config & CP2104_GPIO2_RS485_MODE) /* GPIO 2 */
1733 priv->gpio_altfunc |= BIT(2);
1734
1735 /*
1736 * Like CP2102N, CP2104 has also no strict input and output pin
1737 * modes.
1738 * Do the same input mode emulation as CP2102N.
1739 */
1740 for (i = 0; i < priv->gc.ngpio; ++i) {
1741 /*
1742 * Set direction to "input" iff pin is open-drain and reset
1743 * value is 1.
1744 */
1745 if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1746 priv->gpio_input |= BIT(i);
1747 }
1748
1749 return 0;
1750}
1751
1752static int cp2108_gpio_init(struct usb_serial *serial)
1753{
1754 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1755 struct cp210x_quad_port_config config;
1756 u16 gpio_latch;
1757 int result;
1758 u8 i;
1759
1760 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1761 CP210X_GET_PORTCONFIG, &config,
1762 sizeof(config));
1763 if (result < 0)
1764 return result;
1765
1766 priv->gc.ngpio = 16;
1767 priv->gpio_pushpull = le16_to_cpu(config.reset_state.gpio_mode_pb1);
1768 gpio_latch = le16_to_cpu(config.reset_state.gpio_latch_pb1);
1769
1770 /*
1771 * Mark all pins which are not in GPIO mode.
1772 *
1773 * Refer to table 9.1 "GPIO Mode alternate Functions" in the datasheet:
1774 * https://www.silabs.com/documents/public/data-sheets/cp2108-datasheet.pdf
1775 *
1776 * Alternate functions of GPIO0 to GPIO3 are determine by enhancedfxn_ifc[0]
1777 * and the similarly for the other pins; enhancedfxn_ifc[1]: GPIO4 to GPIO7,
1778 * enhancedfxn_ifc[2]: GPIO8 to GPIO11, enhancedfxn_ifc[3]: GPIO12 to GPIO15.
1779 */
1780 for (i = 0; i < 4; i++) {
1781 if (config.enhancedfxn_ifc[i] & CP2108_EF_IFC_GPIO_TXLED)
1782 priv->gpio_altfunc |= BIT(i * 4);
1783 if (config.enhancedfxn_ifc[i] & CP2108_EF_IFC_GPIO_RXLED)
1784 priv->gpio_altfunc |= BIT((i * 4) + 1);
1785 if (config.enhancedfxn_ifc[i] & CP2108_EF_IFC_GPIO_RS485)
1786 priv->gpio_altfunc |= BIT((i * 4) + 2);
1787 if (config.enhancedfxn_ifc[i] & CP2108_EF_IFC_GPIO_CLOCK)
1788 priv->gpio_altfunc |= BIT((i * 4) + 3);
1789 }
1790
1791 /*
1792 * Like CP2102N, CP2108 has also no strict input and output pin
1793 * modes. Do the same input mode emulation as CP2102N.
1794 */
1795 for (i = 0; i < priv->gc.ngpio; ++i) {
1796 /*
1797 * Set direction to "input" iff pin is open-drain and reset
1798 * value is 1.
1799 */
1800 if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1801 priv->gpio_input |= BIT(i);
1802 }
1803
1804 return 0;
1805}
1806
1807static int cp2102n_gpioconf_init(struct usb_serial *serial)
1808{
1809 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1810 const u16 config_size = 0x02a6;
1811 u8 gpio_rst_latch;
1812 u8 config_version;
1813 u8 gpio_pushpull;
1814 u8 *config_buf;
1815 u8 gpio_latch;
1816 u8 gpio_ctrl;
1817 int result;
1818 u8 i;
1819
1820 /*
1821 * Retrieve device configuration from the device.
1822 * The array received contains all customization settings done at the
1823 * factory/manufacturer. Format of the array is documented at the
1824 * time of writing at:
1825 * https://www.silabs.com/community/interface/knowledge-base.entry.html/2017/03/31/cp2102n_setconfig-xsfa
1826 */
1827 config_buf = kmalloc(config_size, GFP_KERNEL);
1828 if (!config_buf)
1829 return -ENOMEM;
1830
1831 result = cp210x_read_vendor_block(serial,
1832 REQTYPE_DEVICE_TO_HOST,
1833 CP210X_READ_2NCONFIG,
1834 config_buf,
1835 config_size);
1836 if (result < 0) {
1837 kfree(config_buf);
1838 return result;
1839 }
1840
1841 config_version = config_buf[CP210X_2NCONFIG_CONFIG_VERSION_IDX];
1842 gpio_pushpull = config_buf[CP210X_2NCONFIG_GPIO_MODE_IDX];
1843 gpio_ctrl = config_buf[CP210X_2NCONFIG_GPIO_CONTROL_IDX];
1844 gpio_rst_latch = config_buf[CP210X_2NCONFIG_GPIO_RSTLATCH_IDX];
1845
1846 kfree(config_buf);
1847
1848 /* Make sure this is a config format we understand. */
1849 if (config_version != 0x01)
1850 return -ENOTSUPP;
1851
1852 priv->gc.ngpio = 4;
1853
1854 /*
1855 * Get default pin states after reset. Needed so we can determine
1856 * the direction of an open-drain pin.
1857 */
1858 gpio_latch = (gpio_rst_latch >> 3) & 0x0f;
1859
1860 /* 0 indicates open-drain mode, 1 is push-pull */
1861 priv->gpio_pushpull = (gpio_pushpull >> 3) & 0x0f;
1862
1863 /* 0 indicates GPIO mode, 1 is alternate function */
1864 if (priv->partnum == CP210X_PARTNUM_CP2102N_QFN20) {
1865 /* QFN20 is special... */
1866 if (gpio_ctrl & CP2102N_QFN20_GPIO0_CLK_MODE) /* GPIO 0 */
1867 priv->gpio_altfunc |= BIT(0);
1868 if (gpio_ctrl & CP2102N_QFN20_GPIO1_RS485_MODE) /* GPIO 1 */
1869 priv->gpio_altfunc |= BIT(1);
1870 if (gpio_ctrl & CP2102N_QFN20_GPIO2_TXLED_MODE) /* GPIO 2 */
1871 priv->gpio_altfunc |= BIT(2);
1872 if (gpio_ctrl & CP2102N_QFN20_GPIO3_RXLED_MODE) /* GPIO 3 */
1873 priv->gpio_altfunc |= BIT(3);
1874 } else {
1875 priv->gpio_altfunc = (gpio_ctrl >> 2) & 0x0f;
1876 }
1877
1878 if (priv->partnum == CP210X_PARTNUM_CP2102N_QFN28) {
1879 /*
1880 * For the QFN28 package, GPIO4-6 are controlled by
1881 * the low three bits of the mode/latch fields.
1882 * Contrary to the document linked above, the bits for
1883 * the SUSPEND pins are elsewhere. No alternate
1884 * function is available for these pins.
1885 */
1886 priv->gc.ngpio = 7;
1887 gpio_latch |= (gpio_rst_latch & 7) << 4;
1888 priv->gpio_pushpull |= (gpio_pushpull & 7) << 4;
1889 }
1890
1891 /*
1892 * The CP2102N does not strictly has input and output pin modes,
1893 * it only knows open-drain and push-pull modes which is set at
1894 * factory. An open-drain pin can function both as an
1895 * input or an output. We emulate input mode for open-drain pins
1896 * by making sure they are not driven low, and we do not allow
1897 * push-pull pins to be set as an input.
1898 */
1899 for (i = 0; i < priv->gc.ngpio; ++i) {
1900 /*
1901 * Set direction to "input" iff pin is open-drain and reset
1902 * value is 1.
1903 */
1904 if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1905 priv->gpio_input |= BIT(i);
1906 }
1907
1908 return 0;
1909}
1910
1911static int cp210x_gpio_init(struct usb_serial *serial)
1912{
1913 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1914 int result;
1915
1916 switch (priv->partnum) {
1917 case CP210X_PARTNUM_CP2104:
1918 result = cp2104_gpioconf_init(serial);
1919 break;
1920 case CP210X_PARTNUM_CP2105:
1921 result = cp2105_gpioconf_init(serial);
1922 break;
1923 case CP210X_PARTNUM_CP2108:
1924 /*
1925 * The GPIOs are not tied to any specific port so only register
1926 * once for interface 0.
1927 */
1928 if (cp210x_interface_num(serial) != 0)
1929 return 0;
1930 result = cp2108_gpio_init(serial);
1931 break;
1932 case CP210X_PARTNUM_CP2102N_QFN28:
1933 case CP210X_PARTNUM_CP2102N_QFN24:
1934 case CP210X_PARTNUM_CP2102N_QFN20:
1935 result = cp2102n_gpioconf_init(serial);
1936 break;
1937 default:
1938 return 0;
1939 }
1940
1941 if (result < 0)
1942 return result;
1943
1944 priv->gc.label = "cp210x";
1945 priv->gc.get_direction = cp210x_gpio_direction_get;
1946 priv->gc.direction_input = cp210x_gpio_direction_input;
1947 priv->gc.direction_output = cp210x_gpio_direction_output;
1948 priv->gc.get = cp210x_gpio_get;
1949 priv->gc.set = cp210x_gpio_set;
1950 priv->gc.set_config = cp210x_gpio_set_config;
1951 priv->gc.init_valid_mask = cp210x_gpio_init_valid_mask;
1952 priv->gc.owner = THIS_MODULE;
1953 priv->gc.parent = &serial->interface->dev;
1954 priv->gc.base = -1;
1955 priv->gc.can_sleep = true;
1956
1957 result = gpiochip_add_data(&priv->gc, serial);
1958 if (!result)
1959 priv->gpio_registered = true;
1960
1961 return result;
1962}
1963
1964static void cp210x_gpio_remove(struct usb_serial *serial)
1965{
1966 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1967
1968 if (priv->gpio_registered) {
1969 gpiochip_remove(&priv->gc);
1970 priv->gpio_registered = false;
1971 }
1972}
1973
1974#else
1975
1976static int cp210x_gpio_init(struct usb_serial *serial)
1977{
1978 return 0;
1979}
1980
1981static void cp210x_gpio_remove(struct usb_serial *serial)
1982{
1983 /* Nothing to do */
1984}
1985
1986#endif
1987
1988static int cp210x_port_probe(struct usb_serial_port *port)
1989{
1990 struct usb_serial *serial = port->serial;
1991 struct cp210x_port_private *port_priv;
1992
1993 port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
1994 if (!port_priv)
1995 return -ENOMEM;
1996
1997 port_priv->bInterfaceNumber = cp210x_interface_num(serial);
1998 mutex_init(&port_priv->mutex);
1999
2000 usb_set_serial_port_data(port, port_priv);
2001
2002 return 0;
2003}
2004
2005static void cp210x_port_remove(struct usb_serial_port *port)
2006{
2007 struct cp210x_port_private *port_priv;
2008
2009 port_priv = usb_get_serial_port_data(port);
2010 kfree(port_priv);
2011}
2012
2013static void cp210x_init_max_speed(struct usb_serial *serial)
2014{
2015 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2016 bool use_actual_rate = false;
2017 speed_t min = 300;
2018 speed_t max;
2019
2020 switch (priv->partnum) {
2021 case CP210X_PARTNUM_CP2101:
2022 max = 921600;
2023 break;
2024 case CP210X_PARTNUM_CP2102:
2025 case CP210X_PARTNUM_CP2103:
2026 max = 1000000;
2027 break;
2028 case CP210X_PARTNUM_CP2104:
2029 use_actual_rate = true;
2030 max = 2000000;
2031 break;
2032 case CP210X_PARTNUM_CP2108:
2033 max = 2000000;
2034 break;
2035 case CP210X_PARTNUM_CP2105:
2036 if (cp210x_interface_num(serial) == 0) {
2037 use_actual_rate = true;
2038 max = 2000000; /* ECI */
2039 } else {
2040 min = 2400;
2041 max = 921600; /* SCI */
2042 }
2043 break;
2044 case CP210X_PARTNUM_CP2102N_QFN28:
2045 case CP210X_PARTNUM_CP2102N_QFN24:
2046 case CP210X_PARTNUM_CP2102N_QFN20:
2047 use_actual_rate = true;
2048 max = 3000000;
2049 break;
2050 default:
2051 max = 2000000;
2052 break;
2053 }
2054
2055 priv->min_speed = min;
2056 priv->max_speed = max;
2057 priv->use_actual_rate = use_actual_rate;
2058}
2059
2060static void cp2102_determine_quirks(struct usb_serial *serial)
2061{
2062 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2063 u8 *buf;
2064 int ret;
2065
2066 buf = kmalloc(2, GFP_KERNEL);
2067 if (!buf)
2068 return;
2069 /*
2070 * Some (possibly counterfeit) CP2102 do not support event-insertion
2071 * mode and respond differently to malformed vendor requests.
2072 * Specifically, they return one instead of two bytes when sent a
2073 * two-byte part-number request.
2074 */
2075 ret = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
2076 CP210X_VENDOR_SPECIFIC, REQTYPE_DEVICE_TO_HOST,
2077 CP210X_GET_PARTNUM, 0, buf, 2, USB_CTRL_GET_TIMEOUT);
2078 if (ret == 1) {
2079 dev_dbg(&serial->interface->dev,
2080 "device does not support event-insertion mode\n");
2081 priv->no_event_mode = true;
2082 }
2083
2084 kfree(buf);
2085}
2086
2087static int cp210x_get_fw_version(struct usb_serial *serial, u16 value)
2088{
2089 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2090 u8 ver[3];
2091 int ret;
2092
2093 ret = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST, value,
2094 ver, sizeof(ver));
2095 if (ret)
2096 return ret;
2097
2098 dev_dbg(&serial->interface->dev, "%s - %d.%d.%d\n", __func__,
2099 ver[0], ver[1], ver[2]);
2100
2101 priv->fw_version = ver[0] << 16 | ver[1] << 8 | ver[2];
2102
2103 return 0;
2104}
2105
2106static void cp210x_determine_type(struct usb_serial *serial)
2107{
2108 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2109 int ret;
2110
2111 ret = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
2112 CP210X_GET_PARTNUM, &priv->partnum,
2113 sizeof(priv->partnum));
2114 if (ret < 0) {
2115 dev_warn(&serial->interface->dev,
2116 "querying part number failed\n");
2117 priv->partnum = CP210X_PARTNUM_UNKNOWN;
2118 return;
2119 }
2120
2121 dev_dbg(&serial->interface->dev, "partnum = 0x%02x\n", priv->partnum);
2122
2123 switch (priv->partnum) {
2124 case CP210X_PARTNUM_CP2102:
2125 cp2102_determine_quirks(serial);
2126 break;
2127 case CP210X_PARTNUM_CP2105:
2128 case CP210X_PARTNUM_CP2108:
2129 cp210x_get_fw_version(serial, CP210X_GET_FW_VER);
2130 break;
2131 case CP210X_PARTNUM_CP2102N_QFN28:
2132 case CP210X_PARTNUM_CP2102N_QFN24:
2133 case CP210X_PARTNUM_CP2102N_QFN20:
2134 ret = cp210x_get_fw_version(serial, CP210X_GET_FW_VER_2N);
2135 if (ret)
2136 break;
2137 if (priv->fw_version <= 0x10004)
2138 priv->no_flow_control = true;
2139 break;
2140 default:
2141 break;
2142 }
2143}
2144
2145static int cp210x_attach(struct usb_serial *serial)
2146{
2147 int result;
2148 struct cp210x_serial_private *priv;
2149
2150 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
2151 if (!priv)
2152 return -ENOMEM;
2153
2154 usb_set_serial_data(serial, priv);
2155
2156 cp210x_determine_type(serial);
2157 cp210x_init_max_speed(serial);
2158
2159 result = cp210x_gpio_init(serial);
2160 if (result < 0) {
2161 dev_err(&serial->interface->dev, "GPIO initialisation failed: %d\n",
2162 result);
2163 }
2164
2165 return 0;
2166}
2167
2168static void cp210x_disconnect(struct usb_serial *serial)
2169{
2170 cp210x_gpio_remove(serial);
2171}
2172
2173static void cp210x_release(struct usb_serial *serial)
2174{
2175 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2176
2177 cp210x_gpio_remove(serial);
2178
2179 kfree(priv);
2180}
2181
2182module_usb_serial_driver(serial_drivers, id_table);
2183
2184MODULE_DESCRIPTION(DRIVER_DESC);
2185MODULE_LICENSE("GPL v2");