blob: 29bf3830925287edd0a1b57272bc468bbba3fd74 [file] [log] [blame]
yuezonghe824eb0c2024-06-27 02:32:26 -07001/*
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_change_speed(struct tty_struct *, struct usb_serial_port *,
43 struct ktermios *);
44static void cp210x_set_termios(struct tty_struct *, struct usb_serial_port *,
45 struct ktermios*);
46static int cp210x_tiocmget(struct tty_struct *);
47static int cp210x_tiocmset(struct tty_struct *, unsigned int, unsigned int);
48static int cp210x_tiocmset_port(struct usb_serial_port *port,
49 unsigned int, unsigned int);
50static void cp210x_break_ctl(struct tty_struct *, int);
51static int cp210x_startup(struct usb_serial *);
52static void cp210x_release(struct usb_serial *);
53static void cp210x_dtr_rts(struct usb_serial_port *p, int on);
54
55static bool debug;
56
57static const struct usb_device_id id_table[] = {
58 { USB_DEVICE(0x045B, 0x0053) }, /* Renesas RX610 RX-Stick */
59 { USB_DEVICE(0x0471, 0x066A) }, /* AKTAKOM ACE-1001 cable */
60 { USB_DEVICE(0x0489, 0xE000) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
61 { USB_DEVICE(0x0489, 0xE003) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
62 { USB_DEVICE(0x0745, 0x1000) }, /* CipherLab USB CCD Barcode Scanner 1000 */
63 { USB_DEVICE(0x0846, 0x1100) }, /* NetGear Managed Switch M4100 series, M5300 series, M7100 series */
64 { USB_DEVICE(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
65 { USB_DEVICE(0x08FD, 0x000A) }, /* Digianswer A/S , ZigBee/802.15.4 MAC Device */
66 { USB_DEVICE(0x0908, 0x01FF) }, /* Siemens RUGGEDCOM USB Serial Console */
67 { USB_DEVICE(0x0BED, 0x1100) }, /* MEI (TM) Cashflow-SC Bill/Voucher Acceptor */
68 { USB_DEVICE(0x0BED, 0x1101) }, /* MEI series 2000 Combo Acceptor */
69 { USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
70 { USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
71 { USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */
72 { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
73 { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
74 { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
75 { USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */
76 { USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */
77 { USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */
78 { USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
79 { USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
80 { USB_DEVICE(0x10C4, 0x8044) }, /* Cygnal Debug Adapter */
81 { USB_DEVICE(0x10C4, 0x804E) }, /* Software Bisque Paramount ME build-in converter */
82 { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
83 { USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */
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, 0x818B) }, /* AVIT Research USB to TTL */
101 { USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
102 { USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
103 { USB_DEVICE(0x10C4, 0x81A9) }, /* Multiplex RC Interface */
104 { USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
105 { USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */
106 { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
107 { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
108 { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
109 { USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
110 { USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
111 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
112 { USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
113 { USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
114 { USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */
115 { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
116 { USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
117 { USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
118 { USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
119 { USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
120 { USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
121 { USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
122 { USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
123 { USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
124 { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
125 { USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
126 { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
127 { USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
128 { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
129 { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
130 { USB_DEVICE(0x10C4, 0x8856) }, /* CEL EM357 ZigBee USB Stick - LR */
131 { USB_DEVICE(0x10C4, 0x8857) }, /* CEL EM357 ZigBee USB Stick */
132 { USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
133 { USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
134 { USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
135 { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit Device */
136 { USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
137 { USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
138 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
139 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
140 { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
141 { USB_DEVICE(0x10C4, 0xEA80) }, /* Silicon Labs factory default */
142 { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
143 { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
144 { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
145 { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
146 { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
147 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
148 { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
149 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
150 { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
151 { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
152 { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
153 { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
154 { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
155 { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
156 { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
157 { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
158 { USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
159 { USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
160 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
161 { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
162 { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
163 { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
164 { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
165 { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
166 { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
167 { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
168 { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
169 { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
170 { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
171 { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
172 { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
173 { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
174 { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
175 { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
176 { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
177 { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
178 { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
179 { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
180 { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
181 { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
182 { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
183 { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
184 { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
185 { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
186 { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
187 { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
188 { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
189 { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
190 { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
191 { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
192 { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
193 { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
194 { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
195 { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
196 { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
197 { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
198 { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
199 { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
200 { } /* Terminating Entry */
201};
202
203MODULE_DEVICE_TABLE(usb, id_table);
204
205struct cp210x_port_private {
206 __u8 bInterfaceNumber;
207};
208
209static struct usb_driver cp210x_driver = {
210 .name = "cp210x",
211 .probe = usb_serial_probe,
212 .disconnect = usb_serial_disconnect,
213 .id_table = id_table,
214};
215
216static struct usb_serial_driver cp210x_device = {
217 .driver = {
218 .owner = THIS_MODULE,
219 .name = "cp210x",
220 },
221 .id_table = id_table,
222 .num_ports = 1,
223 .bulk_in_size = 256,
224 .bulk_out_size = 256,
225 .open = cp210x_open,
226 .close = cp210x_close,
227 .break_ctl = cp210x_break_ctl,
228 .set_termios = cp210x_set_termios,
229 .tiocmget = cp210x_tiocmget,
230 .tiocmset = cp210x_tiocmset,
231 .attach = cp210x_startup,
232 .release = cp210x_release,
233 .dtr_rts = cp210x_dtr_rts
234};
235
236static struct usb_serial_driver * const serial_drivers[] = {
237 &cp210x_device, NULL
238};
239
240/* Config request types */
241#define REQTYPE_HOST_TO_DEVICE 0x41
242#define REQTYPE_DEVICE_TO_HOST 0xc1
243
244/* Config request codes */
245#define CP210X_IFC_ENABLE 0x00
246#define CP210X_SET_BAUDDIV 0x01
247#define CP210X_GET_BAUDDIV 0x02
248#define CP210X_SET_LINE_CTL 0x03
249#define CP210X_GET_LINE_CTL 0x04
250#define CP210X_SET_BREAK 0x05
251#define CP210X_IMM_CHAR 0x06
252#define CP210X_SET_MHS 0x07
253#define CP210X_GET_MDMSTS 0x08
254#define CP210X_SET_XON 0x09
255#define CP210X_SET_XOFF 0x0A
256#define CP210X_SET_EVENTMASK 0x0B
257#define CP210X_GET_EVENTMASK 0x0C
258#define CP210X_SET_CHAR 0x0D
259#define CP210X_GET_CHARS 0x0E
260#define CP210X_GET_PROPS 0x0F
261#define CP210X_GET_COMM_STATUS 0x10
262#define CP210X_RESET 0x11
263#define CP210X_PURGE 0x12
264#define CP210X_SET_FLOW 0x13
265#define CP210X_GET_FLOW 0x14
266#define CP210X_EMBED_EVENTS 0x15
267#define CP210X_GET_EVENTSTATE 0x16
268#define CP210X_SET_CHARS 0x19
269#define CP210X_GET_BAUDRATE 0x1D
270#define CP210X_SET_BAUDRATE 0x1E
271
272/* CP210X_IFC_ENABLE */
273#define UART_ENABLE 0x0001
274#define UART_DISABLE 0x0000
275
276/* CP210X_(SET|GET)_BAUDDIV */
277#define BAUD_RATE_GEN_FREQ 0x384000
278
279/* CP210X_(SET|GET)_LINE_CTL */
280#define BITS_DATA_MASK 0X0f00
281#define BITS_DATA_5 0X0500
282#define BITS_DATA_6 0X0600
283#define BITS_DATA_7 0X0700
284#define BITS_DATA_8 0X0800
285#define BITS_DATA_9 0X0900
286
287#define BITS_PARITY_MASK 0x00f0
288#define BITS_PARITY_NONE 0x0000
289#define BITS_PARITY_ODD 0x0010
290#define BITS_PARITY_EVEN 0x0020
291#define BITS_PARITY_MARK 0x0030
292#define BITS_PARITY_SPACE 0x0040
293
294#define BITS_STOP_MASK 0x000f
295#define BITS_STOP_1 0x0000
296#define BITS_STOP_1_5 0x0001
297#define BITS_STOP_2 0x0002
298
299/* CP210X_SET_BREAK */
300#define BREAK_ON 0x0001
301#define BREAK_OFF 0x0000
302
303/* CP210X_(SET_MHS|GET_MDMSTS) */
304#define CONTROL_DTR 0x0001
305#define CONTROL_RTS 0x0002
306#define CONTROL_CTS 0x0010
307#define CONTROL_DSR 0x0020
308#define CONTROL_RING 0x0040
309#define CONTROL_DCD 0x0080
310#define CONTROL_WRITE_DTR 0x0100
311#define CONTROL_WRITE_RTS 0x0200
312
313/*
314 * cp210x_get_config
315 * Reads from the CP210x configuration registers
316 * 'size' is specified in bytes.
317 * 'data' is a pointer to a pre-allocated array of integers large
318 * enough to hold 'size' bytes (with 4 bytes to each integer)
319 */
320static int cp210x_get_config(struct usb_serial_port *port, u8 request,
321 unsigned int *data, int size)
322{
323 struct usb_serial *serial = port->serial;
324 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
325 __le32 *buf;
326 int result, i, length;
327
328 /* Number of integers required to contain the array */
329 length = (((size - 1) | 3) + 1)/4;
330
331 buf = kcalloc(length, sizeof(__le32), GFP_KERNEL);
332 if (!buf) {
333 dev_err(&port->dev, "%s - out of memory.\n", __func__);
334 return -ENOMEM;
335 }
336
337 /* Issue the request, attempting to read 'size' bytes */
338 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
339 request, REQTYPE_DEVICE_TO_HOST, 0x0000,
340 port_priv->bInterfaceNumber, buf, size,
341 USB_CTRL_GET_TIMEOUT);
342
343 /* Convert data into an array of integers */
344 for (i = 0; i < length; i++)
345 data[i] = le32_to_cpu(buf[i]);
346
347 kfree(buf);
348
349 if (result != size) {
350 dbg("%s - Unable to send config request, "
351 "request=0x%x size=%d result=%d",
352 __func__, request, size, result);
353 if (result > 0)
354 result = -EPROTO;
355
356 return result;
357 }
358
359 return 0;
360}
361
362/*
363 * cp210x_set_config
364 * Writes to the CP210x configuration registers
365 * Values less than 16 bits wide are sent directly
366 * 'size' is specified in bytes.
367 */
368static int cp210x_set_config(struct usb_serial_port *port, u8 request,
369 unsigned int *data, int size)
370{
371 struct usb_serial *serial = port->serial;
372 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
373 __le32 *buf;
374 int result, i, length;
375
376 /* Number of integers required to contain the array */
377 length = (((size - 1) | 3) + 1)/4;
378
379 buf = kmalloc(length * sizeof(__le32), GFP_KERNEL);
380 if (!buf) {
381 dev_err(&port->dev, "%s - out of memory.\n",
382 __func__);
383 return -ENOMEM;
384 }
385
386 /* Array of integers into bytes */
387 for (i = 0; i < length; i++)
388 buf[i] = cpu_to_le32(data[i]);
389
390 if (size > 2) {
391 result = usb_control_msg(serial->dev,
392 usb_sndctrlpipe(serial->dev, 0),
393 request, REQTYPE_HOST_TO_DEVICE, 0x0000,
394 port_priv->bInterfaceNumber, buf, size,
395 USB_CTRL_SET_TIMEOUT);
396 } else {
397 result = usb_control_msg(serial->dev,
398 usb_sndctrlpipe(serial->dev, 0),
399 request, REQTYPE_HOST_TO_DEVICE, data[0],
400 port_priv->bInterfaceNumber, NULL, 0,
401 USB_CTRL_SET_TIMEOUT);
402 }
403
404 kfree(buf);
405
406 if ((size > 2 && result != size) || result < 0) {
407 dbg("%s - Unable to send request, "
408 "request=0x%x size=%d result=%d",
409 __func__, request, size, result);
410 if (result > 0)
411 result = -EPROTO;
412
413 return result;
414 }
415
416 return 0;
417}
418
419/*
420 * cp210x_set_config_single
421 * Convenience function for calling cp210x_set_config on single data values
422 * without requiring an integer pointer
423 */
424static inline int cp210x_set_config_single(struct usb_serial_port *port,
425 u8 request, unsigned int data)
426{
427 return cp210x_set_config(port, request, &data, 2);
428}
429
430/*
431 * cp210x_quantise_baudrate
432 * Quantises the baud rate as per AN205 Table 1
433 */
434static unsigned int cp210x_quantise_baudrate(unsigned int baud) {
435 if (baud <= 300)
436 baud = 300;
437 else if (baud <= 600) baud = 600;
438 else if (baud <= 1200) baud = 1200;
439 else if (baud <= 1800) baud = 1800;
440 else if (baud <= 2400) baud = 2400;
441 else if (baud <= 4000) baud = 4000;
442 else if (baud <= 4803) baud = 4800;
443 else if (baud <= 7207) baud = 7200;
444 else if (baud <= 9612) baud = 9600;
445 else if (baud <= 14428) baud = 14400;
446 else if (baud <= 16062) baud = 16000;
447 else if (baud <= 19250) baud = 19200;
448 else if (baud <= 28912) baud = 28800;
449 else if (baud <= 38601) baud = 38400;
450 else if (baud <= 51558) baud = 51200;
451 else if (baud <= 56280) baud = 56000;
452 else if (baud <= 58053) baud = 57600;
453 else if (baud <= 64111) baud = 64000;
454 else if (baud <= 77608) baud = 76800;
455 else if (baud <= 117028) baud = 115200;
456 else if (baud <= 129347) baud = 128000;
457 else if (baud <= 156868) baud = 153600;
458 else if (baud <= 237832) baud = 230400;
459 else if (baud <= 254234) baud = 250000;
460 else if (baud <= 273066) baud = 256000;
461 else if (baud <= 491520) baud = 460800;
462 else if (baud <= 567138) baud = 500000;
463 else if (baud <= 670254) baud = 576000;
464 else if (baud < 1000000)
465 baud = 921600;
466 else if (baud > 2000000)
467 baud = 2000000;
468 return baud;
469}
470
471static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
472{
473 int result;
474
475 dbg("%s - port %d", __func__, port->number);
476
477 result = cp210x_set_config_single(port, CP210X_IFC_ENABLE,
478 UART_ENABLE);
479 if (result) {
480 dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
481 return result;
482 }
483
484 /* Configure the termios structure */
485 cp210x_get_termios(tty, port);
486
487 /* The baud rate must be initialised on cp2104 */
488 if (tty)
489 cp210x_change_speed(tty, port, NULL);
490
491 return usb_serial_generic_open(tty, port);
492}
493
494static void cp210x_close(struct usb_serial_port *port)
495{
496 dbg("%s - port %d", __func__, port->number);
497
498 usb_serial_generic_close(port);
499
500 mutex_lock(&port->serial->disc_mutex);
501 if (!port->serial->disconnected)
502 cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_DISABLE);
503 mutex_unlock(&port->serial->disc_mutex);
504}
505
506/*
507 * cp210x_get_termios
508 * Reads the baud rate, data bits, parity, stop bits and flow control mode
509 * from the device, corrects any unsupported values, and configures the
510 * termios structure to reflect the state of the device
511 */
512static void cp210x_get_termios(struct tty_struct *tty,
513 struct usb_serial_port *port)
514{
515 unsigned int baud;
516
517 if (tty) {
518 cp210x_get_termios_port(tty->driver_data,
519 &tty->termios->c_cflag, &baud);
520 tty_encode_baud_rate(tty, baud, baud);
521 }
522
523 else {
524 unsigned int cflag;
525 cflag = 0;
526 cp210x_get_termios_port(port, &cflag, &baud);
527 }
528}
529
530/*
531 * cp210x_get_termios_port
532 * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
533 */
534static void cp210x_get_termios_port(struct usb_serial_port *port,
535 unsigned int *cflagp, unsigned int *baudp)
536{
537 unsigned int cflag, modem_ctl[4];
538 unsigned int baud;
539 unsigned int bits;
540
541 dbg("%s - port %d", __func__, port->number);
542
543 cp210x_get_config(port, CP210X_GET_BAUDRATE, &baud, 4);
544
545 dbg("%s - baud rate = %d", __func__, baud);
546 *baudp = baud;
547
548 cflag = *cflagp;
549
550 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
551 cflag &= ~CSIZE;
552 switch (bits & BITS_DATA_MASK) {
553 case BITS_DATA_5:
554 dbg("%s - data bits = 5", __func__);
555 cflag |= CS5;
556 break;
557 case BITS_DATA_6:
558 dbg("%s - data bits = 6", __func__);
559 cflag |= CS6;
560 break;
561 case BITS_DATA_7:
562 dbg("%s - data bits = 7", __func__);
563 cflag |= CS7;
564 break;
565 case BITS_DATA_8:
566 dbg("%s - data bits = 8", __func__);
567 cflag |= CS8;
568 break;
569 case BITS_DATA_9:
570 dbg("%s - data bits = 9 (not supported, using 8 data bits)",
571 __func__);
572 cflag |= CS8;
573 bits &= ~BITS_DATA_MASK;
574 bits |= BITS_DATA_8;
575 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
576 break;
577 default:
578 dbg("%s - Unknown number of data bits, using 8", __func__);
579 cflag |= CS8;
580 bits &= ~BITS_DATA_MASK;
581 bits |= BITS_DATA_8;
582 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
583 break;
584 }
585
586 switch (bits & BITS_PARITY_MASK) {
587 case BITS_PARITY_NONE:
588 dbg("%s - parity = NONE", __func__);
589 cflag &= ~PARENB;
590 break;
591 case BITS_PARITY_ODD:
592 dbg("%s - parity = ODD", __func__);
593 cflag |= (PARENB|PARODD);
594 break;
595 case BITS_PARITY_EVEN:
596 dbg("%s - parity = EVEN", __func__);
597 cflag &= ~PARODD;
598 cflag |= PARENB;
599 break;
600 case BITS_PARITY_MARK:
601 dbg("%s - parity = MARK", __func__);
602 cflag |= (PARENB|PARODD|CMSPAR);
603 break;
604 case BITS_PARITY_SPACE:
605 dbg("%s - parity = SPACE", __func__);
606 cflag &= ~PARODD;
607 cflag |= (PARENB|CMSPAR);
608 break;
609 default:
610 dbg("%s - Unknown parity mode, disabling parity", __func__);
611 cflag &= ~PARENB;
612 bits &= ~BITS_PARITY_MASK;
613 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
614 break;
615 }
616
617 cflag &= ~CSTOPB;
618 switch (bits & BITS_STOP_MASK) {
619 case BITS_STOP_1:
620 dbg("%s - stop bits = 1", __func__);
621 break;
622 case BITS_STOP_1_5:
623 dbg("%s - stop bits = 1.5 (not supported, using 1 stop bit)",
624 __func__);
625 bits &= ~BITS_STOP_MASK;
626 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
627 break;
628 case BITS_STOP_2:
629 dbg("%s - stop bits = 2", __func__);
630 cflag |= CSTOPB;
631 break;
632 default:
633 dbg("%s - Unknown number of stop bits, using 1 stop bit",
634 __func__);
635 bits &= ~BITS_STOP_MASK;
636 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
637 break;
638 }
639
640 cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
641 if (modem_ctl[0] & 0x0008) {
642 dbg("%s - flow control = CRTSCTS", __func__);
643 cflag |= CRTSCTS;
644 } else {
645 dbg("%s - flow control = NONE", __func__);
646 cflag &= ~CRTSCTS;
647 }
648
649 *cflagp = cflag;
650}
651
652/*
653 * CP2101 supports the following baud rates:
654 *
655 * 300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
656 * 38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
657 *
658 * CP2102 and CP2103 support the following additional rates:
659 *
660 * 4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
661 * 576000
662 *
663 * The device will map a requested rate to a supported one, but the result
664 * of requests for rates greater than 1053257 is undefined (see AN205).
665 *
666 * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
667 * respectively, with an error less than 1%. The actual rates are determined
668 * by
669 *
670 * div = round(freq / (2 x prescale x request))
671 * actual = freq / (2 x prescale x div)
672 *
673 * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
674 * or 1 otherwise.
675 * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
676 * otherwise.
677 */
678static void cp210x_change_speed(struct tty_struct *tty,
679 struct usb_serial_port *port, struct ktermios *old_termios)
680{
681 u32 baud;
682
683 baud = tty->termios->c_ospeed;
684
685 /* This maps the requested rate to a rate valid on cp2102 or cp2103,
686 * or to an arbitrary rate in [1M,2M].
687 *
688 * NOTE: B0 is not implemented.
689 */
690 baud = cp210x_quantise_baudrate(baud);
691
692 dbg("%s - setting baud rate to %u", __func__, baud);
693 if (cp210x_set_config(port, CP210X_SET_BAUDRATE, &baud,
694 sizeof(baud))) {
695 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
696 if (old_termios)
697 baud = old_termios->c_ospeed;
698 else
699 baud = 9600;
700 }
701
702 tty_encode_baud_rate(tty, baud, baud);
703}
704
705static void cp210x_set_termios(struct tty_struct *tty,
706 struct usb_serial_port *port, struct ktermios *old_termios)
707{
708 unsigned int cflag, old_cflag;
709 unsigned int bits;
710 unsigned int modem_ctl[4];
711
712 dbg("%s - port %d", __func__, port->number);
713
714 if (!tty)
715 return;
716
717 cflag = tty->termios->c_cflag;
718 old_cflag = old_termios->c_cflag;
719
720 if (tty->termios->c_ospeed != old_termios->c_ospeed)
721 cp210x_change_speed(tty, port, old_termios);
722
723 /* If the number of data bits is to be updated */
724 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
725 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
726 bits &= ~BITS_DATA_MASK;
727 switch (cflag & CSIZE) {
728 case CS5:
729 bits |= BITS_DATA_5;
730 dbg("%s - data bits = 5", __func__);
731 break;
732 case CS6:
733 bits |= BITS_DATA_6;
734 dbg("%s - data bits = 6", __func__);
735 break;
736 case CS7:
737 bits |= BITS_DATA_7;
738 dbg("%s - data bits = 7", __func__);
739 break;
740 case CS8:
741 bits |= BITS_DATA_8;
742 dbg("%s - data bits = 8", __func__);
743 break;
744 /*case CS9:
745 bits |= BITS_DATA_9;
746 dbg("%s - data bits = 9", __func__);
747 break;*/
748 default:
749 dbg("cp210x driver does not "
750 "support the number of bits requested,"
751 " using 8 bit mode");
752 bits |= BITS_DATA_8;
753 break;
754 }
755 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
756 dbg("Number of data bits requested "
757 "not supported by device");
758 }
759
760 if ((cflag & (PARENB|PARODD|CMSPAR)) !=
761 (old_cflag & (PARENB|PARODD|CMSPAR))) {
762 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
763 bits &= ~BITS_PARITY_MASK;
764 if (cflag & PARENB) {
765 if (cflag & CMSPAR) {
766 if (cflag & PARODD) {
767 bits |= BITS_PARITY_MARK;
768 dbg("%s - parity = MARK", __func__);
769 } else {
770 bits |= BITS_PARITY_SPACE;
771 dbg("%s - parity = SPACE", __func__);
772 }
773 } else {
774 if (cflag & PARODD) {
775 bits |= BITS_PARITY_ODD;
776 dbg("%s - parity = ODD", __func__);
777 } else {
778 bits |= BITS_PARITY_EVEN;
779 dbg("%s - parity = EVEN", __func__);
780 }
781 }
782 }
783 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
784 dbg("Parity mode not supported by device");
785 }
786
787 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
788 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
789 bits &= ~BITS_STOP_MASK;
790 if (cflag & CSTOPB) {
791 bits |= BITS_STOP_2;
792 dbg("%s - stop bits = 2", __func__);
793 } else {
794 bits |= BITS_STOP_1;
795 dbg("%s - stop bits = 1", __func__);
796 }
797 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
798 dbg("Number of stop bits requested "
799 "not supported by device");
800 }
801
802 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
803 cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
804 dbg("%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
805 __func__, modem_ctl[0], modem_ctl[1],
806 modem_ctl[2], modem_ctl[3]);
807
808 if (cflag & CRTSCTS) {
809 modem_ctl[0] &= ~0x7B;
810 modem_ctl[0] |= 0x09;
811 modem_ctl[1] = 0x80;
812 dbg("%s - flow control = CRTSCTS", __func__);
813 } else {
814 modem_ctl[0] &= ~0x7B;
815 modem_ctl[0] |= 0x01;
816 modem_ctl[1] |= 0x40;
817 dbg("%s - flow control = NONE", __func__);
818 }
819
820 dbg("%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
821 __func__, modem_ctl[0], modem_ctl[1],
822 modem_ctl[2], modem_ctl[3]);
823 cp210x_set_config(port, CP210X_SET_FLOW, modem_ctl, 16);
824 }
825
826}
827
828static int cp210x_tiocmset (struct tty_struct *tty,
829 unsigned int set, unsigned int clear)
830{
831 struct usb_serial_port *port = tty->driver_data;
832 return cp210x_tiocmset_port(port, set, clear);
833}
834
835static int cp210x_tiocmset_port(struct usb_serial_port *port,
836 unsigned int set, unsigned int clear)
837{
838 unsigned int control = 0;
839
840 dbg("%s - port %d", __func__, port->number);
841
842 if (set & TIOCM_RTS) {
843 control |= CONTROL_RTS;
844 control |= CONTROL_WRITE_RTS;
845 }
846 if (set & TIOCM_DTR) {
847 control |= CONTROL_DTR;
848 control |= CONTROL_WRITE_DTR;
849 }
850 if (clear & TIOCM_RTS) {
851 control &= ~CONTROL_RTS;
852 control |= CONTROL_WRITE_RTS;
853 }
854 if (clear & TIOCM_DTR) {
855 control &= ~CONTROL_DTR;
856 control |= CONTROL_WRITE_DTR;
857 }
858
859 dbg("%s - control = 0x%.4x", __func__, control);
860
861 return cp210x_set_config(port, CP210X_SET_MHS, &control, 2);
862}
863
864static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
865{
866 if (on)
867 cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
868 else
869 cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
870}
871
872static int cp210x_tiocmget (struct tty_struct *tty)
873{
874 struct usb_serial_port *port = tty->driver_data;
875 unsigned int control;
876 int result;
877
878 dbg("%s - port %d", __func__, port->number);
879
880 cp210x_get_config(port, CP210X_GET_MDMSTS, &control, 1);
881
882 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
883 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
884 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
885 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
886 |((control & CONTROL_RING)? TIOCM_RI : 0)
887 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
888
889 dbg("%s - control = 0x%.2x", __func__, control);
890
891 return result;
892}
893
894static void cp210x_break_ctl (struct tty_struct *tty, int break_state)
895{
896 struct usb_serial_port *port = tty->driver_data;
897 unsigned int state;
898
899 dbg("%s - port %d", __func__, port->number);
900 if (break_state == 0)
901 state = BREAK_OFF;
902 else
903 state = BREAK_ON;
904 dbg("%s - turning break %s", __func__,
905 state == BREAK_OFF ? "off" : "on");
906 cp210x_set_config(port, CP210X_SET_BREAK, &state, 2);
907}
908
909static int cp210x_startup(struct usb_serial *serial)
910{
911 struct cp210x_port_private *port_priv;
912 int i;
913
914 /* cp210x buffers behave strangely unless device is reset */
915 usb_reset_device(serial->dev);
916
917 for (i = 0; i < serial->num_ports; i++) {
918 port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
919 if (!port_priv)
920 return -ENOMEM;
921
922 memset(port_priv, 0x00, sizeof(*port_priv));
923 port_priv->bInterfaceNumber =
924 serial->interface->cur_altsetting->desc.bInterfaceNumber;
925
926 usb_set_serial_port_data(serial->port[i], port_priv);
927 }
928
929 return 0;
930}
931
932static void cp210x_release(struct usb_serial *serial)
933{
934 struct cp210x_port_private *port_priv;
935 int i;
936
937 for (i = 0; i < serial->num_ports; i++) {
938 port_priv = usb_get_serial_port_data(serial->port[i]);
939 kfree(port_priv);
940 usb_set_serial_port_data(serial->port[i], NULL);
941 }
942}
943
944module_usb_serial_driver(cp210x_driver, serial_drivers);
945
946MODULE_DESCRIPTION(DRIVER_DESC);
947MODULE_VERSION(DRIVER_VERSION);
948MODULE_LICENSE("GPL");
949
950module_param(debug, bool, S_IRUGO | S_IWUSR);
951MODULE_PARM_DESC(debug, "Enable verbose debugging messages");