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