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