2 * Silicon Laboratories CP210x USB to RS232 serial adaptor driver
4 * Copyright (C) 2005 Craig Shelley (craig@microtron.org.uk)
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.
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
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>
27 #define DRIVER_DESC "Silicon Labs CP210x RS232 serial adaptor driver"
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
*,
39 static void cp210x_set_termios(struct tty_struct
*, struct usb_serial_port
*,
41 static bool cp210x_tx_empty(struct usb_serial_port
*port
);
42 static int cp210x_tiocmget(struct tty_struct
*);
43 static int cp210x_tiocmset(struct tty_struct
*, unsigned int, unsigned int);
44 static int cp210x_tiocmset_port(struct usb_serial_port
*port
,
45 unsigned int, unsigned int);
46 static void cp210x_break_ctl(struct tty_struct
*, int);
47 static int cp210x_port_probe(struct usb_serial_port
*);
48 static int cp210x_port_remove(struct usb_serial_port
*);
49 static void cp210x_dtr_rts(struct usb_serial_port
*p
, int on
);
51 static const struct usb_device_id id_table
[] = {
52 { USB_DEVICE(0x045B, 0x0053) }, /* Renesas RX610 RX-Stick */
53 { USB_DEVICE(0x0471, 0x066A) }, /* AKTAKOM ACE-1001 cable */
54 { USB_DEVICE(0x0489, 0xE000) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
55 { USB_DEVICE(0x0489, 0xE003) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
56 { USB_DEVICE(0x0745, 0x1000) }, /* CipherLab USB CCD Barcode Scanner 1000 */
57 { USB_DEVICE(0x0846, 0x1100) }, /* NetGear Managed Switch M4100 series, M5300 series, M7100 series */
58 { USB_DEVICE(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
59 { USB_DEVICE(0x08FD, 0x000A) }, /* Digianswer A/S , ZigBee/802.15.4 MAC Device */
60 { USB_DEVICE(0x0908, 0x01FF) }, /* Siemens RUGGEDCOM USB Serial Console */
61 { USB_DEVICE(0x0BED, 0x1100) }, /* MEI (TM) Cashflow-SC Bill/Voucher Acceptor */
62 { USB_DEVICE(0x0BED, 0x1101) }, /* MEI series 2000 Combo Acceptor */
63 { USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
64 { USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
65 { USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */
66 { USB_DEVICE(0x0FDE, 0xCA05) }, /* OWL Wireless Electricity Monitor CM-160 */
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, 0x80C4) }, /* Cygnal Integrated Products, Inc., Optris infrared thermometer */
83 { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
84 { USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
85 { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
86 { USB_DEVICE(0x10C4, 0x8115) }, /* Arygon NFC/Mifare Reader */
87 { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
88 { USB_DEVICE(0x10C4, 0x813F) }, /* Tams Master Easy Control */
89 { USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
90 { USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
91 { USB_DEVICE(0x2405, 0x0003) }, /* West Mountain Radio RIGblaster Advantage */
92 { USB_DEVICE(0x10C4, 0x8156) }, /* B&G H3000 link cable */
93 { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
94 { USB_DEVICE(0x10C4, 0x815F) }, /* Timewave HamLinkUSB */
95 { USB_DEVICE(0x10C4, 0x818B) }, /* AVIT Research USB to TTL */
96 { USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
97 { USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
98 { USB_DEVICE(0x10C4, 0x81A9) }, /* Multiplex RC Interface */
99 { USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
100 { USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */
101 { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
102 { USB_DEVICE(0x10C4, 0x81D7) }, /* IAI Corp. RCB-CV-USB USB to RS485 Adaptor */
103 { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
104 { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
105 { USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
106 { USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
107 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
108 { USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
109 { USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
110 { USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */
111 { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
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, 0x85EA) }, /* AC-Services IBUS-IF */
122 { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
123 { USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
124 { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
125 { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
126 { USB_DEVICE(0x10C4, 0x8856) }, /* CEL EM357 ZigBee USB Stick - LR */
127 { USB_DEVICE(0x10C4, 0x8857) }, /* CEL EM357 ZigBee USB Stick */
128 { USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
129 { USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
130 { USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
131 { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit Device */
132 { USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
133 { USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
134 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
135 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
136 { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
137 { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
138 { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
139 { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
140 { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
141 { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
142 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
143 { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
144 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
145 { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
146 { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
147 { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
148 { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
149 { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
150 { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
151 { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
152 { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
153 { USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
154 { USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
155 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
156 { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
157 { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
158 { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
159 { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
160 { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
161 { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
162 { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
163 { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
164 { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
165 { USB_DEVICE(0x18EF, 0xE025) }, /* ELV Marble Sound Board 1 */
166 { USB_DEVICE(0x1901, 0x0190) }, /* GE B850 CP2105 Recorder interface */
167 { USB_DEVICE(0x1901, 0x0193) }, /* GE B650 CP2104 PMC interface */
168 { USB_DEVICE(0x19CF, 0x3000) }, /* Parrot NMEA GPS Flight Recorder */
169 { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
170 { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
171 { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
172 { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
173 { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
174 { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
175 { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
176 { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
177 { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
178 { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
179 { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
180 { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
181 { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
182 { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
183 { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
184 { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
185 { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
186 { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
187 { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
188 { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
189 { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
190 { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
191 { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
192 { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
193 { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
194 { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
195 { USB_DEVICE(0x2626, 0xEA60) }, /* Aruba Networks 7xxx USB Serial Console */
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 */
203 MODULE_DEVICE_TABLE(usb
, id_table
);
205 struct cp210x_port_private
{
206 __u8 bInterfaceNumber
;
207 bool has_swapped_line_ctl
;
210 static struct usb_serial_driver cp210x_device
= {
212 .owner
= THIS_MODULE
,
215 .id_table
= id_table
,
218 .bulk_out_size
= 256,
220 .close
= cp210x_close
,
221 .break_ctl
= cp210x_break_ctl
,
222 .set_termios
= cp210x_set_termios
,
223 .tx_empty
= cp210x_tx_empty
,
224 .tiocmget
= cp210x_tiocmget
,
225 .tiocmset
= cp210x_tiocmset
,
226 .port_probe
= cp210x_port_probe
,
227 .port_remove
= cp210x_port_remove
,
228 .dtr_rts
= cp210x_dtr_rts
231 static struct usb_serial_driver
* const serial_drivers
[] = {
235 /* Config request types */
236 #define REQTYPE_HOST_TO_INTERFACE 0x41
237 #define REQTYPE_INTERFACE_TO_HOST 0xc1
238 #define REQTYPE_HOST_TO_DEVICE 0x40
239 #define REQTYPE_DEVICE_TO_HOST 0xc0
241 /* Config request codes */
242 #define CP210X_IFC_ENABLE 0x00
243 #define CP210X_SET_BAUDDIV 0x01
244 #define CP210X_GET_BAUDDIV 0x02
245 #define CP210X_SET_LINE_CTL 0x03
246 #define CP210X_GET_LINE_CTL 0x04
247 #define CP210X_SET_BREAK 0x05
248 #define CP210X_IMM_CHAR 0x06
249 #define CP210X_SET_MHS 0x07
250 #define CP210X_GET_MDMSTS 0x08
251 #define CP210X_SET_XON 0x09
252 #define CP210X_SET_XOFF 0x0A
253 #define CP210X_SET_EVENTMASK 0x0B
254 #define CP210X_GET_EVENTMASK 0x0C
255 #define CP210X_SET_CHAR 0x0D
256 #define CP210X_GET_CHARS 0x0E
257 #define CP210X_GET_PROPS 0x0F
258 #define CP210X_GET_COMM_STATUS 0x10
259 #define CP210X_RESET 0x11
260 #define CP210X_PURGE 0x12
261 #define CP210X_SET_FLOW 0x13
262 #define CP210X_GET_FLOW 0x14
263 #define CP210X_EMBED_EVENTS 0x15
264 #define CP210X_GET_EVENTSTATE 0x16
265 #define CP210X_SET_CHARS 0x19
266 #define CP210X_GET_BAUDRATE 0x1D
267 #define CP210X_SET_BAUDRATE 0x1E
269 /* CP210X_IFC_ENABLE */
270 #define UART_ENABLE 0x0001
271 #define UART_DISABLE 0x0000
273 /* CP210X_(SET|GET)_BAUDDIV */
274 #define BAUD_RATE_GEN_FREQ 0x384000
276 /* CP210X_(SET|GET)_LINE_CTL */
277 #define BITS_DATA_MASK 0X0f00
278 #define BITS_DATA_5 0X0500
279 #define BITS_DATA_6 0X0600
280 #define BITS_DATA_7 0X0700
281 #define BITS_DATA_8 0X0800
282 #define BITS_DATA_9 0X0900
284 #define BITS_PARITY_MASK 0x00f0
285 #define BITS_PARITY_NONE 0x0000
286 #define BITS_PARITY_ODD 0x0010
287 #define BITS_PARITY_EVEN 0x0020
288 #define BITS_PARITY_MARK 0x0030
289 #define BITS_PARITY_SPACE 0x0040
291 #define BITS_STOP_MASK 0x000f
292 #define BITS_STOP_1 0x0000
293 #define BITS_STOP_1_5 0x0001
294 #define BITS_STOP_2 0x0002
296 /* CP210X_SET_BREAK */
297 #define BREAK_ON 0x0001
298 #define BREAK_OFF 0x0000
300 /* CP210X_(SET_MHS|GET_MDMSTS) */
301 #define CONTROL_DTR 0x0001
302 #define CONTROL_RTS 0x0002
303 #define CONTROL_CTS 0x0010
304 #define CONTROL_DSR 0x0020
305 #define CONTROL_RING 0x0040
306 #define CONTROL_DCD 0x0080
307 #define CONTROL_WRITE_DTR 0x0100
308 #define CONTROL_WRITE_RTS 0x0200
310 /* CP210X_GET_COMM_STATUS returns these 0x13 bytes */
311 struct cp210x_comm_status
{
313 __le32 ulHoldReasons
;
314 __le32 ulAmountInInQueue
;
315 __le32 ulAmountInOutQueue
;
317 u8 bWaitForImmediate
;
322 * CP210X_PURGE - 16 bits passed in wValue of USB request.
323 * SiLabs app note AN571 gives a strange description of the 4 bits:
324 * bit 0 or bit 2 clears the transmit queue and 1 or 3 receive.
325 * writing 1 to all, however, purges cp2108 well enough to avoid the hang.
327 #define PURGE_ALL 0x000f
331 * Reads from the CP210x configuration registers
332 * 'size' is specified in bytes.
333 * 'data' is a pointer to a pre-allocated array of integers large
334 * enough to hold 'size' bytes (with 4 bytes to each integer)
336 static int cp210x_get_config(struct usb_serial_port
*port
, u8 request
,
337 unsigned int *data
, int size
)
339 struct usb_serial
*serial
= port
->serial
;
340 struct cp210x_port_private
*port_priv
= usb_get_serial_port_data(port
);
342 int result
, i
, length
;
344 /* Number of integers required to contain the array */
345 length
= (((size
- 1) | 3) + 1) / 4;
347 buf
= kcalloc(length
, sizeof(__le32
), GFP_KERNEL
);
351 /* Issue the request, attempting to read 'size' bytes */
352 result
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
353 request
, REQTYPE_INTERFACE_TO_HOST
, 0x0000,
354 port_priv
->bInterfaceNumber
, buf
, size
,
355 USB_CTRL_GET_TIMEOUT
);
357 /* Convert data into an array of integers */
358 for (i
= 0; i
< length
; i
++)
359 data
[i
] = le32_to_cpu(buf
[i
]);
363 if (result
!= size
) {
364 dev_dbg(&port
->dev
, "%s - Unable to send config request, request=0x%x size=%d result=%d\n",
365 __func__
, request
, size
, result
);
377 * Writes to the CP210x configuration registers
378 * Values less than 16 bits wide are sent directly
379 * 'size' is specified in bytes.
381 static int cp210x_set_config(struct usb_serial_port
*port
, u8 request
,
382 unsigned int *data
, int size
)
384 struct usb_serial
*serial
= port
->serial
;
385 struct cp210x_port_private
*port_priv
= usb_get_serial_port_data(port
);
387 int result
, i
, length
;
389 /* Number of integers required to contain the array */
390 length
= (((size
- 1) | 3) + 1) / 4;
392 buf
= kmalloc(length
* sizeof(__le32
), GFP_KERNEL
);
396 /* Array of integers into bytes */
397 for (i
= 0; i
< length
; i
++)
398 buf
[i
] = cpu_to_le32(data
[i
]);
401 result
= usb_control_msg(serial
->dev
,
402 usb_sndctrlpipe(serial
->dev
, 0),
403 request
, REQTYPE_HOST_TO_INTERFACE
, 0x0000,
404 port_priv
->bInterfaceNumber
, buf
, size
,
405 USB_CTRL_SET_TIMEOUT
);
407 result
= usb_control_msg(serial
->dev
,
408 usb_sndctrlpipe(serial
->dev
, 0),
409 request
, REQTYPE_HOST_TO_INTERFACE
, data
[0],
410 port_priv
->bInterfaceNumber
, NULL
, 0,
411 USB_CTRL_SET_TIMEOUT
);
416 if ((size
> 2 && result
!= size
) || result
< 0) {
417 dev_dbg(&port
->dev
, "%s - Unable to send request, request=0x%x size=%d result=%d\n",
418 __func__
, request
, size
, result
);
429 * cp210x_set_config_single
430 * Convenience function for calling cp210x_set_config on single data values
431 * without requiring an integer pointer
433 static inline int cp210x_set_config_single(struct usb_serial_port
*port
,
434 u8 request
, unsigned int data
)
436 return cp210x_set_config(port
, request
, &data
, 2);
440 * Detect CP2108 GET_LINE_CTL bug and activate workaround.
441 * Write a known good value 0x800, read it back.
442 * If it comes back swapped the bug is detected.
443 * Preserve the original register value.
445 static int cp210x_detect_swapped_line_ctl(struct usb_serial_port
*port
)
447 struct cp210x_port_private
*port_priv
= usb_get_serial_port_data(port
);
448 unsigned int line_ctl_save
;
449 unsigned int line_ctl_test
;
452 err
= cp210x_get_config(port
, CP210X_GET_LINE_CTL
, &line_ctl_save
, 2);
456 line_ctl_test
= 0x800;
457 err
= cp210x_set_config(port
, CP210X_SET_LINE_CTL
, &line_ctl_test
, 2);
461 err
= cp210x_get_config(port
, CP210X_GET_LINE_CTL
, &line_ctl_test
, 2);
465 if (line_ctl_test
== 8) {
466 port_priv
->has_swapped_line_ctl
= true;
467 line_ctl_save
= swab16((u16
)line_ctl_save
);
470 return cp210x_set_config(port
, CP210X_SET_LINE_CTL
, &line_ctl_save
, 2);
474 * Must always be called instead of cp210x_get_config(CP210X_GET_LINE_CTL)
475 * to workaround cp2108 bug and get correct value.
477 static int cp210x_get_line_ctl(struct usb_serial_port
*port
, unsigned int *ctl
)
479 struct cp210x_port_private
*port_priv
= usb_get_serial_port_data(port
);
482 err
= cp210x_get_config(port
, CP210X_GET_LINE_CTL
, ctl
, 2);
486 /* Workaround swapped bytes in 16-bit value from CP210X_GET_LINE_CTL */
487 if (port_priv
->has_swapped_line_ctl
)
488 *ctl
= swab16((u16
)(*ctl
));
494 * cp210x_quantise_baudrate
495 * Quantises the baud rate as per AN205 Table 1
497 static unsigned int cp210x_quantise_baudrate(unsigned int baud
)
501 else if (baud
<= 600) baud
= 600;
502 else if (baud
<= 1200) baud
= 1200;
503 else if (baud
<= 1800) baud
= 1800;
504 else if (baud
<= 2400) baud
= 2400;
505 else if (baud
<= 4000) baud
= 4000;
506 else if (baud
<= 4803) baud
= 4800;
507 else if (baud
<= 7207) baud
= 7200;
508 else if (baud
<= 9612) baud
= 9600;
509 else if (baud
<= 14428) baud
= 14400;
510 else if (baud
<= 16062) baud
= 16000;
511 else if (baud
<= 19250) baud
= 19200;
512 else if (baud
<= 28912) baud
= 28800;
513 else if (baud
<= 38601) baud
= 38400;
514 else if (baud
<= 51558) baud
= 51200;
515 else if (baud
<= 56280) baud
= 56000;
516 else if (baud
<= 58053) baud
= 57600;
517 else if (baud
<= 64111) baud
= 64000;
518 else if (baud
<= 77608) baud
= 76800;
519 else if (baud
<= 117028) baud
= 115200;
520 else if (baud
<= 129347) baud
= 128000;
521 else if (baud
<= 156868) baud
= 153600;
522 else if (baud
<= 237832) baud
= 230400;
523 else if (baud
<= 254234) baud
= 250000;
524 else if (baud
<= 273066) baud
= 256000;
525 else if (baud
<= 491520) baud
= 460800;
526 else if (baud
<= 567138) baud
= 500000;
527 else if (baud
<= 670254) baud
= 576000;
528 else if (baud
< 1000000)
530 else if (baud
> 2000000)
535 static int cp210x_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
539 result
= cp210x_set_config_single(port
, CP210X_IFC_ENABLE
,
542 dev_err(&port
->dev
, "%s - Unable to enable UART\n", __func__
);
546 /* Configure the termios structure */
547 cp210x_get_termios(tty
, port
);
549 /* The baud rate must be initialised on cp2104 */
551 cp210x_change_speed(tty
, port
, NULL
);
553 return usb_serial_generic_open(tty
, port
);
556 static void cp210x_close(struct usb_serial_port
*port
)
558 unsigned int purge_ctl
;
560 usb_serial_generic_close(port
);
562 /* Clear both queues; cp2108 needs this to avoid an occasional hang */
563 purge_ctl
= PURGE_ALL
;
564 cp210x_set_config(port
, CP210X_PURGE
, &purge_ctl
, 2);
566 cp210x_set_config_single(port
, CP210X_IFC_ENABLE
, UART_DISABLE
);
570 * Read how many bytes are waiting in the TX queue.
572 static int cp210x_get_tx_queue_byte_count(struct usb_serial_port
*port
,
575 struct usb_serial
*serial
= port
->serial
;
576 struct cp210x_port_private
*port_priv
= usb_get_serial_port_data(port
);
577 struct cp210x_comm_status
*sts
;
580 sts
= kmalloc(sizeof(*sts
), GFP_KERNEL
);
584 result
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
585 CP210X_GET_COMM_STATUS
, REQTYPE_INTERFACE_TO_HOST
,
586 0, port_priv
->bInterfaceNumber
, sts
, sizeof(*sts
),
587 USB_CTRL_GET_TIMEOUT
);
588 if (result
== sizeof(*sts
)) {
589 *count
= le32_to_cpu(sts
->ulAmountInOutQueue
);
592 dev_err(&port
->dev
, "failed to get comm status: %d\n", result
);
602 static bool cp210x_tx_empty(struct usb_serial_port
*port
)
607 err
= cp210x_get_tx_queue_byte_count(port
, &count
);
616 * Reads the baud rate, data bits, parity, stop bits and flow control mode
617 * from the device, corrects any unsupported values, and configures the
618 * termios structure to reflect the state of the device
620 static void cp210x_get_termios(struct tty_struct
*tty
,
621 struct usb_serial_port
*port
)
626 cp210x_get_termios_port(tty
->driver_data
,
627 &tty
->termios
.c_cflag
, &baud
);
628 tty_encode_baud_rate(tty
, baud
, baud
);
632 cp210x_get_termios_port(port
, &cflag
, &baud
);
637 * cp210x_get_termios_port
638 * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
640 static void cp210x_get_termios_port(struct usb_serial_port
*port
,
641 unsigned int *cflagp
, unsigned int *baudp
)
643 struct device
*dev
= &port
->dev
;
644 unsigned int cflag
, modem_ctl
[4];
648 cp210x_get_config(port
, CP210X_GET_BAUDRATE
, &baud
, 4);
650 dev_dbg(dev
, "%s - baud rate = %d\n", __func__
, baud
);
655 cp210x_get_line_ctl(port
, &bits
);
657 switch (bits
& BITS_DATA_MASK
) {
659 dev_dbg(dev
, "%s - data bits = 5\n", __func__
);
663 dev_dbg(dev
, "%s - data bits = 6\n", __func__
);
667 dev_dbg(dev
, "%s - data bits = 7\n", __func__
);
671 dev_dbg(dev
, "%s - data bits = 8\n", __func__
);
675 dev_dbg(dev
, "%s - data bits = 9 (not supported, using 8 data bits)\n", __func__
);
677 bits
&= ~BITS_DATA_MASK
;
679 cp210x_set_config(port
, CP210X_SET_LINE_CTL
, &bits
, 2);
682 dev_dbg(dev
, "%s - Unknown number of data bits, using 8\n", __func__
);
684 bits
&= ~BITS_DATA_MASK
;
686 cp210x_set_config(port
, CP210X_SET_LINE_CTL
, &bits
, 2);
690 switch (bits
& BITS_PARITY_MASK
) {
691 case BITS_PARITY_NONE
:
692 dev_dbg(dev
, "%s - parity = NONE\n", __func__
);
695 case BITS_PARITY_ODD
:
696 dev_dbg(dev
, "%s - parity = ODD\n", __func__
);
697 cflag
|= (PARENB
|PARODD
);
699 case BITS_PARITY_EVEN
:
700 dev_dbg(dev
, "%s - parity = EVEN\n", __func__
);
704 case BITS_PARITY_MARK
:
705 dev_dbg(dev
, "%s - parity = MARK\n", __func__
);
706 cflag
|= (PARENB
|PARODD
|CMSPAR
);
708 case BITS_PARITY_SPACE
:
709 dev_dbg(dev
, "%s - parity = SPACE\n", __func__
);
711 cflag
|= (PARENB
|CMSPAR
);
714 dev_dbg(dev
, "%s - Unknown parity mode, disabling parity\n", __func__
);
716 bits
&= ~BITS_PARITY_MASK
;
717 cp210x_set_config(port
, CP210X_SET_LINE_CTL
, &bits
, 2);
722 switch (bits
& BITS_STOP_MASK
) {
724 dev_dbg(dev
, "%s - stop bits = 1\n", __func__
);
727 dev_dbg(dev
, "%s - stop bits = 1.5 (not supported, using 1 stop bit)\n", __func__
);
728 bits
&= ~BITS_STOP_MASK
;
729 cp210x_set_config(port
, CP210X_SET_LINE_CTL
, &bits
, 2);
732 dev_dbg(dev
, "%s - stop bits = 2\n", __func__
);
736 dev_dbg(dev
, "%s - Unknown number of stop bits, using 1 stop bit\n", __func__
);
737 bits
&= ~BITS_STOP_MASK
;
738 cp210x_set_config(port
, CP210X_SET_LINE_CTL
, &bits
, 2);
742 cp210x_get_config(port
, CP210X_GET_FLOW
, modem_ctl
, 16);
743 if (modem_ctl
[0] & 0x0008) {
744 dev_dbg(dev
, "%s - flow control = CRTSCTS\n", __func__
);
747 dev_dbg(dev
, "%s - flow control = NONE\n", __func__
);
755 * CP2101 supports the following baud rates:
757 * 300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
758 * 38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
760 * CP2102 and CP2103 support the following additional rates:
762 * 4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
765 * The device will map a requested rate to a supported one, but the result
766 * of requests for rates greater than 1053257 is undefined (see AN205).
768 * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
769 * respectively, with an error less than 1%. The actual rates are determined
772 * div = round(freq / (2 x prescale x request))
773 * actual = freq / (2 x prescale x div)
775 * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
777 * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
780 static void cp210x_change_speed(struct tty_struct
*tty
,
781 struct usb_serial_port
*port
, struct ktermios
*old_termios
)
785 baud
= tty
->termios
.c_ospeed
;
787 /* This maps the requested rate to a rate valid on cp2102 or cp2103,
788 * or to an arbitrary rate in [1M,2M].
790 * NOTE: B0 is not implemented.
792 baud
= cp210x_quantise_baudrate(baud
);
794 dev_dbg(&port
->dev
, "%s - setting baud rate to %u\n", __func__
, baud
);
795 if (cp210x_set_config(port
, CP210X_SET_BAUDRATE
, &baud
,
797 dev_warn(&port
->dev
, "failed to set baud rate to %u\n", baud
);
799 baud
= old_termios
->c_ospeed
;
804 tty_encode_baud_rate(tty
, baud
, baud
);
807 static void cp210x_set_termios(struct tty_struct
*tty
,
808 struct usb_serial_port
*port
, struct ktermios
*old_termios
)
810 struct device
*dev
= &port
->dev
;
811 unsigned int cflag
, old_cflag
;
813 unsigned int modem_ctl
[4];
815 cflag
= tty
->termios
.c_cflag
;
816 old_cflag
= old_termios
->c_cflag
;
818 if (tty
->termios
.c_ospeed
!= old_termios
->c_ospeed
)
819 cp210x_change_speed(tty
, port
, old_termios
);
821 /* If the number of data bits is to be updated */
822 if ((cflag
& CSIZE
) != (old_cflag
& CSIZE
)) {
823 cp210x_get_line_ctl(port
, &bits
);
824 bits
&= ~BITS_DATA_MASK
;
825 switch (cflag
& CSIZE
) {
828 dev_dbg(dev
, "%s - data bits = 5\n", __func__
);
832 dev_dbg(dev
, "%s - data bits = 6\n", __func__
);
836 dev_dbg(dev
, "%s - data bits = 7\n", __func__
);
840 dev_dbg(dev
, "%s - data bits = 8\n", __func__
);
844 dev_dbg(dev, "%s - data bits = 9\n", __func__);
847 dev_dbg(dev
, "cp210x driver does not support the number of bits requested, using 8 bit mode\n");
851 if (cp210x_set_config(port
, CP210X_SET_LINE_CTL
, &bits
, 2))
852 dev_dbg(dev
, "Number of data bits requested not supported by device\n");
855 if ((cflag
& (PARENB
|PARODD
|CMSPAR
)) !=
856 (old_cflag
& (PARENB
|PARODD
|CMSPAR
))) {
857 cp210x_get_line_ctl(port
, &bits
);
858 bits
&= ~BITS_PARITY_MASK
;
859 if (cflag
& PARENB
) {
860 if (cflag
& CMSPAR
) {
861 if (cflag
& PARODD
) {
862 bits
|= BITS_PARITY_MARK
;
863 dev_dbg(dev
, "%s - parity = MARK\n", __func__
);
865 bits
|= BITS_PARITY_SPACE
;
866 dev_dbg(dev
, "%s - parity = SPACE\n", __func__
);
869 if (cflag
& PARODD
) {
870 bits
|= BITS_PARITY_ODD
;
871 dev_dbg(dev
, "%s - parity = ODD\n", __func__
);
873 bits
|= BITS_PARITY_EVEN
;
874 dev_dbg(dev
, "%s - parity = EVEN\n", __func__
);
878 if (cp210x_set_config(port
, CP210X_SET_LINE_CTL
, &bits
, 2))
879 dev_dbg(dev
, "Parity mode not supported by device\n");
882 if ((cflag
& CSTOPB
) != (old_cflag
& CSTOPB
)) {
883 cp210x_get_line_ctl(port
, &bits
);
884 bits
&= ~BITS_STOP_MASK
;
885 if (cflag
& CSTOPB
) {
887 dev_dbg(dev
, "%s - stop bits = 2\n", __func__
);
890 dev_dbg(dev
, "%s - stop bits = 1\n", __func__
);
892 if (cp210x_set_config(port
, CP210X_SET_LINE_CTL
, &bits
, 2))
893 dev_dbg(dev
, "Number of stop bits requested not supported by device\n");
896 if ((cflag
& CRTSCTS
) != (old_cflag
& CRTSCTS
)) {
897 cp210x_get_config(port
, CP210X_GET_FLOW
, modem_ctl
, 16);
898 dev_dbg(dev
, "%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x\n",
899 __func__
, modem_ctl
[0], modem_ctl
[1],
900 modem_ctl
[2], modem_ctl
[3]);
902 if (cflag
& CRTSCTS
) {
903 modem_ctl
[0] &= ~0x7B;
904 modem_ctl
[0] |= 0x09;
906 dev_dbg(dev
, "%s - flow control = CRTSCTS\n", __func__
);
908 modem_ctl
[0] &= ~0x7B;
909 modem_ctl
[0] |= 0x01;
910 modem_ctl
[1] |= 0x40;
911 dev_dbg(dev
, "%s - flow control = NONE\n", __func__
);
914 dev_dbg(dev
, "%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x\n",
915 __func__
, modem_ctl
[0], modem_ctl
[1],
916 modem_ctl
[2], modem_ctl
[3]);
917 cp210x_set_config(port
, CP210X_SET_FLOW
, modem_ctl
, 16);
922 static int cp210x_tiocmset(struct tty_struct
*tty
,
923 unsigned int set
, unsigned int clear
)
925 struct usb_serial_port
*port
= tty
->driver_data
;
926 return cp210x_tiocmset_port(port
, set
, clear
);
929 static int cp210x_tiocmset_port(struct usb_serial_port
*port
,
930 unsigned int set
, unsigned int clear
)
932 unsigned int control
= 0;
934 if (set
& TIOCM_RTS
) {
935 control
|= CONTROL_RTS
;
936 control
|= CONTROL_WRITE_RTS
;
938 if (set
& TIOCM_DTR
) {
939 control
|= CONTROL_DTR
;
940 control
|= CONTROL_WRITE_DTR
;
942 if (clear
& TIOCM_RTS
) {
943 control
&= ~CONTROL_RTS
;
944 control
|= CONTROL_WRITE_RTS
;
946 if (clear
& TIOCM_DTR
) {
947 control
&= ~CONTROL_DTR
;
948 control
|= CONTROL_WRITE_DTR
;
951 dev_dbg(&port
->dev
, "%s - control = 0x%.4x\n", __func__
, control
);
953 return cp210x_set_config(port
, CP210X_SET_MHS
, &control
, 2);
956 static void cp210x_dtr_rts(struct usb_serial_port
*p
, int on
)
959 cp210x_tiocmset_port(p
, TIOCM_DTR
|TIOCM_RTS
, 0);
961 cp210x_tiocmset_port(p
, 0, TIOCM_DTR
|TIOCM_RTS
);
964 static int cp210x_tiocmget(struct tty_struct
*tty
)
966 struct usb_serial_port
*port
= tty
->driver_data
;
967 unsigned int control
;
970 cp210x_get_config(port
, CP210X_GET_MDMSTS
, &control
, 1);
972 result
= ((control
& CONTROL_DTR
) ? TIOCM_DTR
: 0)
973 |((control
& CONTROL_RTS
) ? TIOCM_RTS
: 0)
974 |((control
& CONTROL_CTS
) ? TIOCM_CTS
: 0)
975 |((control
& CONTROL_DSR
) ? TIOCM_DSR
: 0)
976 |((control
& CONTROL_RING
)? TIOCM_RI
: 0)
977 |((control
& CONTROL_DCD
) ? TIOCM_CD
: 0);
979 dev_dbg(&port
->dev
, "%s - control = 0x%.2x\n", __func__
, control
);
984 static void cp210x_break_ctl(struct tty_struct
*tty
, int break_state
)
986 struct usb_serial_port
*port
= tty
->driver_data
;
989 if (break_state
== 0)
993 dev_dbg(&port
->dev
, "%s - turning break %s\n", __func__
,
994 state
== BREAK_OFF
? "off" : "on");
995 cp210x_set_config(port
, CP210X_SET_BREAK
, &state
, 2);
998 static int cp210x_port_probe(struct usb_serial_port
*port
)
1000 struct usb_serial
*serial
= port
->serial
;
1001 struct usb_host_interface
*cur_altsetting
;
1002 struct cp210x_port_private
*port_priv
;
1005 port_priv
= kzalloc(sizeof(*port_priv
), GFP_KERNEL
);
1009 cur_altsetting
= serial
->interface
->cur_altsetting
;
1010 port_priv
->bInterfaceNumber
= cur_altsetting
->desc
.bInterfaceNumber
;
1012 usb_set_serial_port_data(port
, port_priv
);
1014 ret
= cp210x_detect_swapped_line_ctl(port
);
1023 static int cp210x_port_remove(struct usb_serial_port
*port
)
1025 struct cp210x_port_private
*port_priv
;
1027 port_priv
= usb_get_serial_port_data(port
);
1033 module_usb_serial_driver(serial_drivers
, id_table
);
1035 MODULE_DESCRIPTION(DRIVER_DESC
);
1036 MODULE_LICENSE("GPL");