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