]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - drivers/usb/serial/cp210x.c
selftests: timers: freq-step: fix compile error
[mirror_ubuntu-artful-kernel.git] / drivers / usb / serial / cp210x.c
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 #include <linux/gpio/driver.h>
27 #include <linux/bitops.h>
28 #include <linux/mutex.h>
29
30 #define DRIVER_DESC "Silicon Labs CP210x RS232 serial adaptor driver"
31
32 /*
33 * Function Prototypes
34 */
35 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *);
36 static void cp210x_close(struct usb_serial_port *);
37 static void cp210x_get_termios(struct tty_struct *, struct usb_serial_port *);
38 static void cp210x_get_termios_port(struct usb_serial_port *port,
39 tcflag_t *cflagp, unsigned int *baudp);
40 static void cp210x_change_speed(struct tty_struct *, struct usb_serial_port *,
41 struct ktermios *);
42 static void cp210x_set_termios(struct tty_struct *, struct usb_serial_port *,
43 struct ktermios*);
44 static bool cp210x_tx_empty(struct usb_serial_port *port);
45 static int cp210x_tiocmget(struct tty_struct *);
46 static int cp210x_tiocmset(struct tty_struct *, unsigned int, unsigned int);
47 static int cp210x_tiocmset_port(struct usb_serial_port *port,
48 unsigned int, unsigned int);
49 static void cp210x_break_ctl(struct tty_struct *, int);
50 static int cp210x_attach(struct usb_serial *);
51 static void cp210x_disconnect(struct usb_serial *);
52 static void cp210x_release(struct usb_serial *);
53 static int cp210x_port_probe(struct usb_serial_port *);
54 static int cp210x_port_remove(struct usb_serial_port *);
55 static void cp210x_dtr_rts(struct usb_serial_port *p, int on);
56
57 static 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(0x0FDE, 0xCA05) }, /* OWL Wireless Electricity Monitor CM-160 */
73 { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
74 { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
75 { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
76 { USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */
77 { USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */
78 { USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */
79 { USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
80 { USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
81 { USB_DEVICE(0x10C4, 0x8044) }, /* Cygnal Debug Adapter */
82 { USB_DEVICE(0x10C4, 0x804E) }, /* Software Bisque Paramount ME build-in converter */
83 { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
84 { USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */
85 { USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
86 { USB_DEVICE(0x10C4, 0x806F) }, /* IMS USB to RS422 Converter Cable */
87 { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
88 { USB_DEVICE(0x10C4, 0x80C4) }, /* Cygnal Integrated Products, Inc., Optris infrared thermometer */
89 { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
90 { USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
91 { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
92 { USB_DEVICE(0x10C4, 0x8115) }, /* Arygon NFC/Mifare Reader */
93 { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
94 { USB_DEVICE(0x10C4, 0x813F) }, /* Tams Master Easy Control */
95 { USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
96 { USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
97 { USB_DEVICE(0x2405, 0x0003) }, /* West Mountain Radio RIGblaster Advantage */
98 { USB_DEVICE(0x10C4, 0x8156) }, /* B&G H3000 link cable */
99 { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
100 { USB_DEVICE(0x10C4, 0x815F) }, /* Timewave HamLinkUSB */
101 { USB_DEVICE(0x10C4, 0x818B) }, /* AVIT Research USB to TTL */
102 { USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
103 { USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
104 { USB_DEVICE(0x10C4, 0x81A9) }, /* Multiplex RC Interface */
105 { USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
106 { USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */
107 { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
108 { USB_DEVICE(0x10C4, 0x81D7) }, /* IAI Corp. RCB-CV-USB USB to RS485 Adaptor */
109 { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
110 { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
111 { USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
112 { USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
113 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
114 { USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
115 { USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
116 { USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */
117 { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
118 { USB_DEVICE(0x10C4, 0x82F4) }, /* Starizona MicroTouch */
119 { USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
120 { USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
121 { USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
122 { USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
123 { USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
124 { USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
125 { USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
126 { USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
127 { USB_DEVICE(0x10C4, 0x8470) }, /* Juniper Networks BX Series System Console */
128 { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
129 { USB_DEVICE(0x10C4, 0x84B6) }, /* Starizona Hyperion */
130 { USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
131 { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
132 { USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
133 { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
134 { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
135 { USB_DEVICE(0x10C4, 0x8856) }, /* CEL EM357 ZigBee USB Stick - LR */
136 { USB_DEVICE(0x10C4, 0x8857) }, /* CEL EM357 ZigBee USB Stick */
137 { USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
138 { USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
139 { USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
140 { USB_DEVICE(0x10C4, 0x8962) }, /* Brim Brothers charging dock */
141 { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit Device */
142 { USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
143 { USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
144 { USB_DEVICE(0x10C4, 0x8A5E) }, /* CEL EM3588 ZigBee USB Stick Long Range */
145 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
146 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
147 { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
148 { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
149 { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
150 { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
151 { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
152 { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
153 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
154 { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
155 { USB_DEVICE(0x12B8, 0xEC60) }, /* Link G4 ECU */
156 { USB_DEVICE(0x12B8, 0xEC62) }, /* Link G4+ ECU */
157 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
158 { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
159 { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
160 { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
161 { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
162 { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
163 { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
164 { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
165 { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
166 { USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
167 { USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
168 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
169 { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
170 { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
171 { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
172 { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
173 { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
174 { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
175 { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
176 { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
177 { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
178 { USB_DEVICE(0x18EF, 0xE025) }, /* ELV Marble Sound Board 1 */
179 { USB_DEVICE(0x1901, 0x0190) }, /* GE B850 CP2105 Recorder interface */
180 { USB_DEVICE(0x1901, 0x0193) }, /* GE B650 CP2104 PMC interface */
181 { USB_DEVICE(0x1901, 0x0194) }, /* GE Healthcare Remote Alarm Box */
182 { USB_DEVICE(0x1901, 0x0195) }, /* GE B850/B650/B450 CP2104 DP UART interface */
183 { USB_DEVICE(0x1901, 0x0196) }, /* GE B850 CP2105 DP UART interface */
184 { USB_DEVICE(0x19CF, 0x3000) }, /* Parrot NMEA GPS Flight Recorder */
185 { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
186 { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
187 { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
188 { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
189 { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
190 { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
191 { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
192 { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
193 { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
194 { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
195 { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
196 { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
197 { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
198 { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
199 { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
200 { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
201 { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
202 { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
203 { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
204 { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
205 { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
206 { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
207 { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
208 { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
209 { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
210 { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
211 { USB_DEVICE(0x2626, 0xEA60) }, /* Aruba Networks 7xxx USB Serial Console */
212 { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
213 { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
214 { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
215 { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
216 { } /* Terminating Entry */
217 };
218
219 MODULE_DEVICE_TABLE(usb, id_table);
220
221 struct cp210x_serial_private {
222 #ifdef CONFIG_GPIOLIB
223 struct gpio_chip gc;
224 u8 config;
225 u8 gpio_mode;
226 bool gpio_registered;
227 #endif
228 u8 partnum;
229 };
230
231 struct cp210x_port_private {
232 __u8 bInterfaceNumber;
233 bool has_swapped_line_ctl;
234 };
235
236 static struct usb_serial_driver cp210x_device = {
237 .driver = {
238 .owner = THIS_MODULE,
239 .name = "cp210x",
240 },
241 .id_table = id_table,
242 .num_ports = 1,
243 .bulk_in_size = 256,
244 .bulk_out_size = 256,
245 .open = cp210x_open,
246 .close = cp210x_close,
247 .break_ctl = cp210x_break_ctl,
248 .set_termios = cp210x_set_termios,
249 .tx_empty = cp210x_tx_empty,
250 .tiocmget = cp210x_tiocmget,
251 .tiocmset = cp210x_tiocmset,
252 .attach = cp210x_attach,
253 .disconnect = cp210x_disconnect,
254 .release = cp210x_release,
255 .port_probe = cp210x_port_probe,
256 .port_remove = cp210x_port_remove,
257 .dtr_rts = cp210x_dtr_rts
258 };
259
260 static struct usb_serial_driver * const serial_drivers[] = {
261 &cp210x_device, NULL
262 };
263
264 /* Config request types */
265 #define REQTYPE_HOST_TO_INTERFACE 0x41
266 #define REQTYPE_INTERFACE_TO_HOST 0xc1
267 #define REQTYPE_HOST_TO_DEVICE 0x40
268 #define REQTYPE_DEVICE_TO_HOST 0xc0
269
270 /* Config request codes */
271 #define CP210X_IFC_ENABLE 0x00
272 #define CP210X_SET_BAUDDIV 0x01
273 #define CP210X_GET_BAUDDIV 0x02
274 #define CP210X_SET_LINE_CTL 0x03
275 #define CP210X_GET_LINE_CTL 0x04
276 #define CP210X_SET_BREAK 0x05
277 #define CP210X_IMM_CHAR 0x06
278 #define CP210X_SET_MHS 0x07
279 #define CP210X_GET_MDMSTS 0x08
280 #define CP210X_SET_XON 0x09
281 #define CP210X_SET_XOFF 0x0A
282 #define CP210X_SET_EVENTMASK 0x0B
283 #define CP210X_GET_EVENTMASK 0x0C
284 #define CP210X_SET_CHAR 0x0D
285 #define CP210X_GET_CHARS 0x0E
286 #define CP210X_GET_PROPS 0x0F
287 #define CP210X_GET_COMM_STATUS 0x10
288 #define CP210X_RESET 0x11
289 #define CP210X_PURGE 0x12
290 #define CP210X_SET_FLOW 0x13
291 #define CP210X_GET_FLOW 0x14
292 #define CP210X_EMBED_EVENTS 0x15
293 #define CP210X_GET_EVENTSTATE 0x16
294 #define CP210X_SET_CHARS 0x19
295 #define CP210X_GET_BAUDRATE 0x1D
296 #define CP210X_SET_BAUDRATE 0x1E
297 #define CP210X_VENDOR_SPECIFIC 0xFF
298
299 /* CP210X_IFC_ENABLE */
300 #define UART_ENABLE 0x0001
301 #define UART_DISABLE 0x0000
302
303 /* CP210X_(SET|GET)_BAUDDIV */
304 #define BAUD_RATE_GEN_FREQ 0x384000
305
306 /* CP210X_(SET|GET)_LINE_CTL */
307 #define BITS_DATA_MASK 0X0f00
308 #define BITS_DATA_5 0X0500
309 #define BITS_DATA_6 0X0600
310 #define BITS_DATA_7 0X0700
311 #define BITS_DATA_8 0X0800
312 #define BITS_DATA_9 0X0900
313
314 #define BITS_PARITY_MASK 0x00f0
315 #define BITS_PARITY_NONE 0x0000
316 #define BITS_PARITY_ODD 0x0010
317 #define BITS_PARITY_EVEN 0x0020
318 #define BITS_PARITY_MARK 0x0030
319 #define BITS_PARITY_SPACE 0x0040
320
321 #define BITS_STOP_MASK 0x000f
322 #define BITS_STOP_1 0x0000
323 #define BITS_STOP_1_5 0x0001
324 #define BITS_STOP_2 0x0002
325
326 /* CP210X_SET_BREAK */
327 #define BREAK_ON 0x0001
328 #define BREAK_OFF 0x0000
329
330 /* CP210X_(SET_MHS|GET_MDMSTS) */
331 #define CONTROL_DTR 0x0001
332 #define CONTROL_RTS 0x0002
333 #define CONTROL_CTS 0x0010
334 #define CONTROL_DSR 0x0020
335 #define CONTROL_RING 0x0040
336 #define CONTROL_DCD 0x0080
337 #define CONTROL_WRITE_DTR 0x0100
338 #define CONTROL_WRITE_RTS 0x0200
339
340 /* CP210X_VENDOR_SPECIFIC values */
341 #define CP210X_READ_LATCH 0x00C2
342 #define CP210X_GET_PARTNUM 0x370B
343 #define CP210X_GET_PORTCONFIG 0x370C
344 #define CP210X_GET_DEVICEMODE 0x3711
345 #define CP210X_WRITE_LATCH 0x37E1
346
347 /* Part number definitions */
348 #define CP210X_PARTNUM_CP2101 0x01
349 #define CP210X_PARTNUM_CP2102 0x02
350 #define CP210X_PARTNUM_CP2103 0x03
351 #define CP210X_PARTNUM_CP2104 0x04
352 #define CP210X_PARTNUM_CP2105 0x05
353 #define CP210X_PARTNUM_CP2108 0x08
354
355 /* CP210X_GET_COMM_STATUS returns these 0x13 bytes */
356 struct cp210x_comm_status {
357 __le32 ulErrors;
358 __le32 ulHoldReasons;
359 __le32 ulAmountInInQueue;
360 __le32 ulAmountInOutQueue;
361 u8 bEofReceived;
362 u8 bWaitForImmediate;
363 u8 bReserved;
364 } __packed;
365
366 /*
367 * CP210X_PURGE - 16 bits passed in wValue of USB request.
368 * SiLabs app note AN571 gives a strange description of the 4 bits:
369 * bit 0 or bit 2 clears the transmit queue and 1 or 3 receive.
370 * writing 1 to all, however, purges cp2108 well enough to avoid the hang.
371 */
372 #define PURGE_ALL 0x000f
373
374 /* CP210X_GET_FLOW/CP210X_SET_FLOW read/write these 0x10 bytes */
375 struct cp210x_flow_ctl {
376 __le32 ulControlHandshake;
377 __le32 ulFlowReplace;
378 __le32 ulXonLimit;
379 __le32 ulXoffLimit;
380 } __packed;
381
382 /* cp210x_flow_ctl::ulControlHandshake */
383 #define CP210X_SERIAL_DTR_MASK GENMASK(1, 0)
384 #define CP210X_SERIAL_DTR_SHIFT(_mode) (_mode)
385 #define CP210X_SERIAL_CTS_HANDSHAKE BIT(3)
386 #define CP210X_SERIAL_DSR_HANDSHAKE BIT(4)
387 #define CP210X_SERIAL_DCD_HANDSHAKE BIT(5)
388 #define CP210X_SERIAL_DSR_SENSITIVITY BIT(6)
389
390 /* values for cp210x_flow_ctl::ulControlHandshake::CP210X_SERIAL_DTR_MASK */
391 #define CP210X_SERIAL_DTR_INACTIVE 0
392 #define CP210X_SERIAL_DTR_ACTIVE 1
393 #define CP210X_SERIAL_DTR_FLOW_CTL 2
394
395 /* cp210x_flow_ctl::ulFlowReplace */
396 #define CP210X_SERIAL_AUTO_TRANSMIT BIT(0)
397 #define CP210X_SERIAL_AUTO_RECEIVE BIT(1)
398 #define CP210X_SERIAL_ERROR_CHAR BIT(2)
399 #define CP210X_SERIAL_NULL_STRIPPING BIT(3)
400 #define CP210X_SERIAL_BREAK_CHAR BIT(4)
401 #define CP210X_SERIAL_RTS_MASK GENMASK(7, 6)
402 #define CP210X_SERIAL_RTS_SHIFT(_mode) (_mode << 6)
403 #define CP210X_SERIAL_XOFF_CONTINUE BIT(31)
404
405 /* values for cp210x_flow_ctl::ulFlowReplace::CP210X_SERIAL_RTS_MASK */
406 #define CP210X_SERIAL_RTS_INACTIVE 0
407 #define CP210X_SERIAL_RTS_ACTIVE 1
408 #define CP210X_SERIAL_RTS_FLOW_CTL 2
409
410 /* CP210X_VENDOR_SPECIFIC, CP210X_GET_DEVICEMODE call reads these 0x2 bytes. */
411 struct cp210x_pin_mode {
412 u8 eci;
413 u8 sci;
414 } __packed;
415
416 #define CP210X_PIN_MODE_MODEM 0
417 #define CP210X_PIN_MODE_GPIO BIT(0)
418
419 /*
420 * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xf bytes.
421 * Structure needs padding due to unused/unspecified bytes.
422 */
423 struct cp210x_config {
424 __le16 gpio_mode;
425 u8 __pad0[2];
426 __le16 reset_state;
427 u8 __pad1[4];
428 __le16 suspend_state;
429 u8 sci_cfg;
430 u8 eci_cfg;
431 u8 device_cfg;
432 } __packed;
433
434 /* GPIO modes */
435 #define CP210X_SCI_GPIO_MODE_OFFSET 9
436 #define CP210X_SCI_GPIO_MODE_MASK GENMASK(11, 9)
437
438 #define CP210X_ECI_GPIO_MODE_OFFSET 2
439 #define CP210X_ECI_GPIO_MODE_MASK GENMASK(3, 2)
440
441 /* CP2105 port configuration values */
442 #define CP2105_GPIO0_TXLED_MODE BIT(0)
443 #define CP2105_GPIO1_RXLED_MODE BIT(1)
444 #define CP2105_GPIO1_RS485_MODE BIT(2)
445
446 /* CP210X_VENDOR_SPECIFIC, CP210X_WRITE_LATCH call writes these 0x2 bytes. */
447 struct cp210x_gpio_write {
448 u8 mask;
449 u8 state;
450 } __packed;
451
452 /*
453 * Helper to get interface number when we only have struct usb_serial.
454 */
455 static u8 cp210x_interface_num(struct usb_serial *serial)
456 {
457 struct usb_host_interface *cur_altsetting;
458
459 cur_altsetting = serial->interface->cur_altsetting;
460
461 return cur_altsetting->desc.bInterfaceNumber;
462 }
463
464 /*
465 * Reads a variable-sized block of CP210X_ registers, identified by req.
466 * Returns data into buf in native USB byte order.
467 */
468 static int cp210x_read_reg_block(struct usb_serial_port *port, u8 req,
469 void *buf, int bufsize)
470 {
471 struct usb_serial *serial = port->serial;
472 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
473 void *dmabuf;
474 int result;
475
476 dmabuf = kmalloc(bufsize, GFP_KERNEL);
477 if (!dmabuf) {
478 /*
479 * FIXME Some callers don't bother to check for error,
480 * at least give them consistent junk until they are fixed
481 */
482 memset(buf, 0, bufsize);
483 return -ENOMEM;
484 }
485
486 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
487 req, REQTYPE_INTERFACE_TO_HOST, 0,
488 port_priv->bInterfaceNumber, dmabuf, bufsize,
489 USB_CTRL_SET_TIMEOUT);
490 if (result == bufsize) {
491 memcpy(buf, dmabuf, bufsize);
492 result = 0;
493 } else {
494 dev_err(&port->dev, "failed get req 0x%x size %d status: %d\n",
495 req, bufsize, result);
496 if (result >= 0)
497 result = -EIO;
498
499 /*
500 * FIXME Some callers don't bother to check for error,
501 * at least give them consistent junk until they are fixed
502 */
503 memset(buf, 0, bufsize);
504 }
505
506 kfree(dmabuf);
507
508 return result;
509 }
510
511 /*
512 * Reads any 32-bit CP210X_ register identified by req.
513 */
514 static int cp210x_read_u32_reg(struct usb_serial_port *port, u8 req, u32 *val)
515 {
516 __le32 le32_val;
517 int err;
518
519 err = cp210x_read_reg_block(port, req, &le32_val, sizeof(le32_val));
520 if (err) {
521 /*
522 * FIXME Some callers don't bother to check for error,
523 * at least give them consistent junk until they are fixed
524 */
525 *val = 0;
526 return err;
527 }
528
529 *val = le32_to_cpu(le32_val);
530
531 return 0;
532 }
533
534 /*
535 * Reads any 16-bit CP210X_ register identified by req.
536 */
537 static int cp210x_read_u16_reg(struct usb_serial_port *port, u8 req, u16 *val)
538 {
539 __le16 le16_val;
540 int err;
541
542 err = cp210x_read_reg_block(port, req, &le16_val, sizeof(le16_val));
543 if (err)
544 return err;
545
546 *val = le16_to_cpu(le16_val);
547
548 return 0;
549 }
550
551 /*
552 * Reads any 8-bit CP210X_ register identified by req.
553 */
554 static int cp210x_read_u8_reg(struct usb_serial_port *port, u8 req, u8 *val)
555 {
556 return cp210x_read_reg_block(port, req, val, sizeof(*val));
557 }
558
559 /*
560 * Reads a variable-sized vendor block of CP210X_ registers, identified by val.
561 * Returns data into buf in native USB byte order.
562 */
563 static int cp210x_read_vendor_block(struct usb_serial *serial, u8 type, u16 val,
564 void *buf, int bufsize)
565 {
566 void *dmabuf;
567 int result;
568
569 dmabuf = kmalloc(bufsize, GFP_KERNEL);
570 if (!dmabuf)
571 return -ENOMEM;
572
573 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
574 CP210X_VENDOR_SPECIFIC, type, val,
575 cp210x_interface_num(serial), dmabuf, bufsize,
576 USB_CTRL_GET_TIMEOUT);
577 if (result == bufsize) {
578 memcpy(buf, dmabuf, bufsize);
579 result = 0;
580 } else {
581 dev_err(&serial->interface->dev,
582 "failed to get vendor val 0x%04x size %d: %d\n", val,
583 bufsize, result);
584 if (result >= 0)
585 result = -EIO;
586 }
587
588 kfree(dmabuf);
589
590 return result;
591 }
592
593 /*
594 * Writes any 16-bit CP210X_ register (req) whose value is passed
595 * entirely in the wValue field of the USB request.
596 */
597 static int cp210x_write_u16_reg(struct usb_serial_port *port, u8 req, u16 val)
598 {
599 struct usb_serial *serial = port->serial;
600 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
601 int result;
602
603 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
604 req, REQTYPE_HOST_TO_INTERFACE, val,
605 port_priv->bInterfaceNumber, NULL, 0,
606 USB_CTRL_SET_TIMEOUT);
607 if (result < 0) {
608 dev_err(&port->dev, "failed set request 0x%x status: %d\n",
609 req, result);
610 }
611
612 return result;
613 }
614
615 /*
616 * Writes a variable-sized block of CP210X_ registers, identified by req.
617 * Data in buf must be in native USB byte order.
618 */
619 static int cp210x_write_reg_block(struct usb_serial_port *port, u8 req,
620 void *buf, int bufsize)
621 {
622 struct usb_serial *serial = port->serial;
623 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
624 void *dmabuf;
625 int result;
626
627 dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
628 if (!dmabuf)
629 return -ENOMEM;
630
631 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
632 req, REQTYPE_HOST_TO_INTERFACE, 0,
633 port_priv->bInterfaceNumber, dmabuf, bufsize,
634 USB_CTRL_SET_TIMEOUT);
635
636 kfree(dmabuf);
637
638 if (result == bufsize) {
639 result = 0;
640 } else {
641 dev_err(&port->dev, "failed set req 0x%x size %d status: %d\n",
642 req, bufsize, result);
643 if (result >= 0)
644 result = -EIO;
645 }
646
647 return result;
648 }
649
650 /*
651 * Writes any 32-bit CP210X_ register identified by req.
652 */
653 static int cp210x_write_u32_reg(struct usb_serial_port *port, u8 req, u32 val)
654 {
655 __le32 le32_val;
656
657 le32_val = cpu_to_le32(val);
658
659 return cp210x_write_reg_block(port, req, &le32_val, sizeof(le32_val));
660 }
661
662 #ifdef CONFIG_GPIOLIB
663 /*
664 * Writes a variable-sized vendor block of CP210X_ registers, identified by val.
665 * Data in buf must be in native USB byte order.
666 */
667 static int cp210x_write_vendor_block(struct usb_serial *serial, u8 type,
668 u16 val, void *buf, int bufsize)
669 {
670 void *dmabuf;
671 int result;
672
673 dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
674 if (!dmabuf)
675 return -ENOMEM;
676
677 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
678 CP210X_VENDOR_SPECIFIC, type, val,
679 cp210x_interface_num(serial), dmabuf, bufsize,
680 USB_CTRL_SET_TIMEOUT);
681
682 kfree(dmabuf);
683
684 if (result == bufsize) {
685 result = 0;
686 } else {
687 dev_err(&serial->interface->dev,
688 "failed to set vendor val 0x%04x size %d: %d\n", val,
689 bufsize, result);
690 if (result >= 0)
691 result = -EIO;
692 }
693
694 return result;
695 }
696 #endif
697
698 /*
699 * Detect CP2108 GET_LINE_CTL bug and activate workaround.
700 * Write a known good value 0x800, read it back.
701 * If it comes back swapped the bug is detected.
702 * Preserve the original register value.
703 */
704 static int cp210x_detect_swapped_line_ctl(struct usb_serial_port *port)
705 {
706 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
707 u16 line_ctl_save;
708 u16 line_ctl_test;
709 int err;
710
711 err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_save);
712 if (err)
713 return err;
714
715 err = cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, 0x800);
716 if (err)
717 return err;
718
719 err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_test);
720 if (err)
721 return err;
722
723 if (line_ctl_test == 8) {
724 port_priv->has_swapped_line_ctl = true;
725 line_ctl_save = swab16(line_ctl_save);
726 }
727
728 return cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, line_ctl_save);
729 }
730
731 /*
732 * Must always be called instead of cp210x_read_u16_reg(CP210X_GET_LINE_CTL)
733 * to workaround cp2108 bug and get correct value.
734 */
735 static int cp210x_get_line_ctl(struct usb_serial_port *port, u16 *ctl)
736 {
737 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
738 int err;
739
740 err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, ctl);
741 if (err)
742 return err;
743
744 /* Workaround swapped bytes in 16-bit value from CP210X_GET_LINE_CTL */
745 if (port_priv->has_swapped_line_ctl)
746 *ctl = swab16(*ctl);
747
748 return 0;
749 }
750
751 /*
752 * cp210x_quantise_baudrate
753 * Quantises the baud rate as per AN205 Table 1
754 */
755 static unsigned int cp210x_quantise_baudrate(unsigned int baud)
756 {
757 if (baud <= 300)
758 baud = 300;
759 else if (baud <= 600) baud = 600;
760 else if (baud <= 1200) baud = 1200;
761 else if (baud <= 1800) baud = 1800;
762 else if (baud <= 2400) baud = 2400;
763 else if (baud <= 4000) baud = 4000;
764 else if (baud <= 4803) baud = 4800;
765 else if (baud <= 7207) baud = 7200;
766 else if (baud <= 9612) baud = 9600;
767 else if (baud <= 14428) baud = 14400;
768 else if (baud <= 16062) baud = 16000;
769 else if (baud <= 19250) baud = 19200;
770 else if (baud <= 28912) baud = 28800;
771 else if (baud <= 38601) baud = 38400;
772 else if (baud <= 51558) baud = 51200;
773 else if (baud <= 56280) baud = 56000;
774 else if (baud <= 58053) baud = 57600;
775 else if (baud <= 64111) baud = 64000;
776 else if (baud <= 77608) baud = 76800;
777 else if (baud <= 117028) baud = 115200;
778 else if (baud <= 129347) baud = 128000;
779 else if (baud <= 156868) baud = 153600;
780 else if (baud <= 237832) baud = 230400;
781 else if (baud <= 254234) baud = 250000;
782 else if (baud <= 273066) baud = 256000;
783 else if (baud <= 491520) baud = 460800;
784 else if (baud <= 567138) baud = 500000;
785 else if (baud <= 670254) baud = 576000;
786 else if (baud < 1000000)
787 baud = 921600;
788 else if (baud > 2000000)
789 baud = 2000000;
790 return baud;
791 }
792
793 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
794 {
795 int result;
796
797 result = cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_ENABLE);
798 if (result) {
799 dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
800 return result;
801 }
802
803 /* Configure the termios structure */
804 cp210x_get_termios(tty, port);
805
806 /* The baud rate must be initialised on cp2104 */
807 if (tty)
808 cp210x_change_speed(tty, port, NULL);
809
810 return usb_serial_generic_open(tty, port);
811 }
812
813 static void cp210x_close(struct usb_serial_port *port)
814 {
815 usb_serial_generic_close(port);
816
817 /* Clear both queues; cp2108 needs this to avoid an occasional hang */
818 cp210x_write_u16_reg(port, CP210X_PURGE, PURGE_ALL);
819
820 cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
821 }
822
823 /*
824 * Read how many bytes are waiting in the TX queue.
825 */
826 static int cp210x_get_tx_queue_byte_count(struct usb_serial_port *port,
827 u32 *count)
828 {
829 struct usb_serial *serial = port->serial;
830 struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
831 struct cp210x_comm_status *sts;
832 int result;
833
834 sts = kmalloc(sizeof(*sts), GFP_KERNEL);
835 if (!sts)
836 return -ENOMEM;
837
838 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
839 CP210X_GET_COMM_STATUS, REQTYPE_INTERFACE_TO_HOST,
840 0, port_priv->bInterfaceNumber, sts, sizeof(*sts),
841 USB_CTRL_GET_TIMEOUT);
842 if (result == sizeof(*sts)) {
843 *count = le32_to_cpu(sts->ulAmountInOutQueue);
844 result = 0;
845 } else {
846 dev_err(&port->dev, "failed to get comm status: %d\n", result);
847 if (result >= 0)
848 result = -EIO;
849 }
850
851 kfree(sts);
852
853 return result;
854 }
855
856 static bool cp210x_tx_empty(struct usb_serial_port *port)
857 {
858 int err;
859 u32 count;
860
861 err = cp210x_get_tx_queue_byte_count(port, &count);
862 if (err)
863 return true;
864
865 return !count;
866 }
867
868 /*
869 * cp210x_get_termios
870 * Reads the baud rate, data bits, parity, stop bits and flow control mode
871 * from the device, corrects any unsupported values, and configures the
872 * termios structure to reflect the state of the device
873 */
874 static void cp210x_get_termios(struct tty_struct *tty,
875 struct usb_serial_port *port)
876 {
877 unsigned int baud;
878
879 if (tty) {
880 cp210x_get_termios_port(tty->driver_data,
881 &tty->termios.c_cflag, &baud);
882 tty_encode_baud_rate(tty, baud, baud);
883 } else {
884 tcflag_t cflag;
885 cflag = 0;
886 cp210x_get_termios_port(port, &cflag, &baud);
887 }
888 }
889
890 /*
891 * cp210x_get_termios_port
892 * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
893 */
894 static void cp210x_get_termios_port(struct usb_serial_port *port,
895 tcflag_t *cflagp, unsigned int *baudp)
896 {
897 struct device *dev = &port->dev;
898 tcflag_t cflag;
899 struct cp210x_flow_ctl flow_ctl;
900 u32 baud;
901 u16 bits;
902 u32 ctl_hs;
903
904 cp210x_read_u32_reg(port, CP210X_GET_BAUDRATE, &baud);
905
906 dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud);
907 *baudp = baud;
908
909 cflag = *cflagp;
910
911 cp210x_get_line_ctl(port, &bits);
912 cflag &= ~CSIZE;
913 switch (bits & BITS_DATA_MASK) {
914 case BITS_DATA_5:
915 dev_dbg(dev, "%s - data bits = 5\n", __func__);
916 cflag |= CS5;
917 break;
918 case BITS_DATA_6:
919 dev_dbg(dev, "%s - data bits = 6\n", __func__);
920 cflag |= CS6;
921 break;
922 case BITS_DATA_7:
923 dev_dbg(dev, "%s - data bits = 7\n", __func__);
924 cflag |= CS7;
925 break;
926 case BITS_DATA_8:
927 dev_dbg(dev, "%s - data bits = 8\n", __func__);
928 cflag |= CS8;
929 break;
930 case BITS_DATA_9:
931 dev_dbg(dev, "%s - data bits = 9 (not supported, using 8 data bits)\n", __func__);
932 cflag |= CS8;
933 bits &= ~BITS_DATA_MASK;
934 bits |= BITS_DATA_8;
935 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
936 break;
937 default:
938 dev_dbg(dev, "%s - Unknown number of data bits, using 8\n", __func__);
939 cflag |= CS8;
940 bits &= ~BITS_DATA_MASK;
941 bits |= BITS_DATA_8;
942 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
943 break;
944 }
945
946 switch (bits & BITS_PARITY_MASK) {
947 case BITS_PARITY_NONE:
948 dev_dbg(dev, "%s - parity = NONE\n", __func__);
949 cflag &= ~PARENB;
950 break;
951 case BITS_PARITY_ODD:
952 dev_dbg(dev, "%s - parity = ODD\n", __func__);
953 cflag |= (PARENB|PARODD);
954 break;
955 case BITS_PARITY_EVEN:
956 dev_dbg(dev, "%s - parity = EVEN\n", __func__);
957 cflag &= ~PARODD;
958 cflag |= PARENB;
959 break;
960 case BITS_PARITY_MARK:
961 dev_dbg(dev, "%s - parity = MARK\n", __func__);
962 cflag |= (PARENB|PARODD|CMSPAR);
963 break;
964 case BITS_PARITY_SPACE:
965 dev_dbg(dev, "%s - parity = SPACE\n", __func__);
966 cflag &= ~PARODD;
967 cflag |= (PARENB|CMSPAR);
968 break;
969 default:
970 dev_dbg(dev, "%s - Unknown parity mode, disabling parity\n", __func__);
971 cflag &= ~PARENB;
972 bits &= ~BITS_PARITY_MASK;
973 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
974 break;
975 }
976
977 cflag &= ~CSTOPB;
978 switch (bits & BITS_STOP_MASK) {
979 case BITS_STOP_1:
980 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
981 break;
982 case BITS_STOP_1_5:
983 dev_dbg(dev, "%s - stop bits = 1.5 (not supported, using 1 stop bit)\n", __func__);
984 bits &= ~BITS_STOP_MASK;
985 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
986 break;
987 case BITS_STOP_2:
988 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
989 cflag |= CSTOPB;
990 break;
991 default:
992 dev_dbg(dev, "%s - Unknown number of stop bits, using 1 stop bit\n", __func__);
993 bits &= ~BITS_STOP_MASK;
994 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
995 break;
996 }
997
998 cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
999 sizeof(flow_ctl));
1000 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1001 if (ctl_hs & CP210X_SERIAL_CTS_HANDSHAKE) {
1002 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
1003 cflag |= CRTSCTS;
1004 } else {
1005 dev_dbg(dev, "%s - flow control = NONE\n", __func__);
1006 cflag &= ~CRTSCTS;
1007 }
1008
1009 *cflagp = cflag;
1010 }
1011
1012 /*
1013 * CP2101 supports the following baud rates:
1014 *
1015 * 300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
1016 * 38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
1017 *
1018 * CP2102 and CP2103 support the following additional rates:
1019 *
1020 * 4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
1021 * 576000
1022 *
1023 * The device will map a requested rate to a supported one, but the result
1024 * of requests for rates greater than 1053257 is undefined (see AN205).
1025 *
1026 * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
1027 * respectively, with an error less than 1%. The actual rates are determined
1028 * by
1029 *
1030 * div = round(freq / (2 x prescale x request))
1031 * actual = freq / (2 x prescale x div)
1032 *
1033 * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
1034 * or 1 otherwise.
1035 * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
1036 * otherwise.
1037 */
1038 static void cp210x_change_speed(struct tty_struct *tty,
1039 struct usb_serial_port *port, struct ktermios *old_termios)
1040 {
1041 u32 baud;
1042
1043 baud = tty->termios.c_ospeed;
1044
1045 /* This maps the requested rate to a rate valid on cp2102 or cp2103,
1046 * or to an arbitrary rate in [1M,2M].
1047 *
1048 * NOTE: B0 is not implemented.
1049 */
1050 baud = cp210x_quantise_baudrate(baud);
1051
1052 dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
1053 if (cp210x_write_u32_reg(port, CP210X_SET_BAUDRATE, baud)) {
1054 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
1055 if (old_termios)
1056 baud = old_termios->c_ospeed;
1057 else
1058 baud = 9600;
1059 }
1060
1061 tty_encode_baud_rate(tty, baud, baud);
1062 }
1063
1064 static void cp210x_set_termios(struct tty_struct *tty,
1065 struct usb_serial_port *port, struct ktermios *old_termios)
1066 {
1067 struct device *dev = &port->dev;
1068 unsigned int cflag, old_cflag;
1069 u16 bits;
1070
1071 cflag = tty->termios.c_cflag;
1072 old_cflag = old_termios->c_cflag;
1073
1074 if (tty->termios.c_ospeed != old_termios->c_ospeed)
1075 cp210x_change_speed(tty, port, old_termios);
1076
1077 /* If the number of data bits is to be updated */
1078 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
1079 cp210x_get_line_ctl(port, &bits);
1080 bits &= ~BITS_DATA_MASK;
1081 switch (cflag & CSIZE) {
1082 case CS5:
1083 bits |= BITS_DATA_5;
1084 dev_dbg(dev, "%s - data bits = 5\n", __func__);
1085 break;
1086 case CS6:
1087 bits |= BITS_DATA_6;
1088 dev_dbg(dev, "%s - data bits = 6\n", __func__);
1089 break;
1090 case CS7:
1091 bits |= BITS_DATA_7;
1092 dev_dbg(dev, "%s - data bits = 7\n", __func__);
1093 break;
1094 case CS8:
1095 default:
1096 bits |= BITS_DATA_8;
1097 dev_dbg(dev, "%s - data bits = 8\n", __func__);
1098 break;
1099 }
1100 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1101 dev_dbg(dev, "Number of data bits requested not supported by device\n");
1102 }
1103
1104 if ((cflag & (PARENB|PARODD|CMSPAR)) !=
1105 (old_cflag & (PARENB|PARODD|CMSPAR))) {
1106 cp210x_get_line_ctl(port, &bits);
1107 bits &= ~BITS_PARITY_MASK;
1108 if (cflag & PARENB) {
1109 if (cflag & CMSPAR) {
1110 if (cflag & PARODD) {
1111 bits |= BITS_PARITY_MARK;
1112 dev_dbg(dev, "%s - parity = MARK\n", __func__);
1113 } else {
1114 bits |= BITS_PARITY_SPACE;
1115 dev_dbg(dev, "%s - parity = SPACE\n", __func__);
1116 }
1117 } else {
1118 if (cflag & PARODD) {
1119 bits |= BITS_PARITY_ODD;
1120 dev_dbg(dev, "%s - parity = ODD\n", __func__);
1121 } else {
1122 bits |= BITS_PARITY_EVEN;
1123 dev_dbg(dev, "%s - parity = EVEN\n", __func__);
1124 }
1125 }
1126 }
1127 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1128 dev_dbg(dev, "Parity mode not supported by device\n");
1129 }
1130
1131 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
1132 cp210x_get_line_ctl(port, &bits);
1133 bits &= ~BITS_STOP_MASK;
1134 if (cflag & CSTOPB) {
1135 bits |= BITS_STOP_2;
1136 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
1137 } else {
1138 bits |= BITS_STOP_1;
1139 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
1140 }
1141 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1142 dev_dbg(dev, "Number of stop bits requested not supported by device\n");
1143 }
1144
1145 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
1146 struct cp210x_flow_ctl flow_ctl;
1147 u32 ctl_hs;
1148 u32 flow_repl;
1149
1150 cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1151 sizeof(flow_ctl));
1152 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1153 flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1154 dev_dbg(dev, "%s - read ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1155 __func__, ctl_hs, flow_repl);
1156
1157 ctl_hs &= ~CP210X_SERIAL_DSR_HANDSHAKE;
1158 ctl_hs &= ~CP210X_SERIAL_DCD_HANDSHAKE;
1159 ctl_hs &= ~CP210X_SERIAL_DSR_SENSITIVITY;
1160 ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1161 ctl_hs |= CP210X_SERIAL_DTR_SHIFT(CP210X_SERIAL_DTR_ACTIVE);
1162 if (cflag & CRTSCTS) {
1163 ctl_hs |= CP210X_SERIAL_CTS_HANDSHAKE;
1164
1165 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1166 flow_repl |= CP210X_SERIAL_RTS_SHIFT(
1167 CP210X_SERIAL_RTS_FLOW_CTL);
1168 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
1169 } else {
1170 ctl_hs &= ~CP210X_SERIAL_CTS_HANDSHAKE;
1171
1172 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1173 flow_repl |= CP210X_SERIAL_RTS_SHIFT(
1174 CP210X_SERIAL_RTS_ACTIVE);
1175 dev_dbg(dev, "%s - flow control = NONE\n", __func__);
1176 }
1177
1178 dev_dbg(dev, "%s - write ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1179 __func__, ctl_hs, flow_repl);
1180 flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1181 flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1182 cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1183 sizeof(flow_ctl));
1184 }
1185
1186 }
1187
1188 static int cp210x_tiocmset(struct tty_struct *tty,
1189 unsigned int set, unsigned int clear)
1190 {
1191 struct usb_serial_port *port = tty->driver_data;
1192 return cp210x_tiocmset_port(port, set, clear);
1193 }
1194
1195 static int cp210x_tiocmset_port(struct usb_serial_port *port,
1196 unsigned int set, unsigned int clear)
1197 {
1198 u16 control = 0;
1199
1200 if (set & TIOCM_RTS) {
1201 control |= CONTROL_RTS;
1202 control |= CONTROL_WRITE_RTS;
1203 }
1204 if (set & TIOCM_DTR) {
1205 control |= CONTROL_DTR;
1206 control |= CONTROL_WRITE_DTR;
1207 }
1208 if (clear & TIOCM_RTS) {
1209 control &= ~CONTROL_RTS;
1210 control |= CONTROL_WRITE_RTS;
1211 }
1212 if (clear & TIOCM_DTR) {
1213 control &= ~CONTROL_DTR;
1214 control |= CONTROL_WRITE_DTR;
1215 }
1216
1217 dev_dbg(&port->dev, "%s - control = 0x%.4x\n", __func__, control);
1218
1219 return cp210x_write_u16_reg(port, CP210X_SET_MHS, control);
1220 }
1221
1222 static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
1223 {
1224 if (on)
1225 cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
1226 else
1227 cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
1228 }
1229
1230 static int cp210x_tiocmget(struct tty_struct *tty)
1231 {
1232 struct usb_serial_port *port = tty->driver_data;
1233 u8 control;
1234 int result;
1235
1236 result = cp210x_read_u8_reg(port, CP210X_GET_MDMSTS, &control);
1237 if (result)
1238 return result;
1239
1240 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
1241 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
1242 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
1243 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
1244 |((control & CONTROL_RING)? TIOCM_RI : 0)
1245 |((control & CONTROL_DCD) ? TIOCM_CD : 0);
1246
1247 dev_dbg(&port->dev, "%s - control = 0x%.2x\n", __func__, control);
1248
1249 return result;
1250 }
1251
1252 static void cp210x_break_ctl(struct tty_struct *tty, int break_state)
1253 {
1254 struct usb_serial_port *port = tty->driver_data;
1255 u16 state;
1256
1257 if (break_state == 0)
1258 state = BREAK_OFF;
1259 else
1260 state = BREAK_ON;
1261 dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
1262 state == BREAK_OFF ? "off" : "on");
1263 cp210x_write_u16_reg(port, CP210X_SET_BREAK, state);
1264 }
1265
1266 #ifdef CONFIG_GPIOLIB
1267 static int cp210x_gpio_request(struct gpio_chip *gc, unsigned int offset)
1268 {
1269 struct usb_serial *serial = gpiochip_get_data(gc);
1270 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1271
1272 switch (offset) {
1273 case 0:
1274 if (priv->config & CP2105_GPIO0_TXLED_MODE)
1275 return -ENODEV;
1276 break;
1277 case 1:
1278 if (priv->config & (CP2105_GPIO1_RXLED_MODE |
1279 CP2105_GPIO1_RS485_MODE))
1280 return -ENODEV;
1281 break;
1282 }
1283
1284 return 0;
1285 }
1286
1287 static int cp210x_gpio_get(struct gpio_chip *gc, unsigned int gpio)
1288 {
1289 struct usb_serial *serial = gpiochip_get_data(gc);
1290 int result;
1291 u8 buf;
1292
1293 result = cp210x_read_vendor_block(serial, REQTYPE_INTERFACE_TO_HOST,
1294 CP210X_READ_LATCH, &buf, sizeof(buf));
1295 if (result < 0)
1296 return result;
1297
1298 return !!(buf & BIT(gpio));
1299 }
1300
1301 static void cp210x_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)
1302 {
1303 struct usb_serial *serial = gpiochip_get_data(gc);
1304 struct cp210x_gpio_write buf;
1305
1306 if (value == 1)
1307 buf.state = BIT(gpio);
1308 else
1309 buf.state = 0;
1310
1311 buf.mask = BIT(gpio);
1312
1313 cp210x_write_vendor_block(serial, REQTYPE_HOST_TO_INTERFACE,
1314 CP210X_WRITE_LATCH, &buf, sizeof(buf));
1315 }
1316
1317 static int cp210x_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
1318 {
1319 /* Hardware does not support an input mode */
1320 return 0;
1321 }
1322
1323 static int cp210x_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
1324 {
1325 /* Hardware does not support an input mode */
1326 return -ENOTSUPP;
1327 }
1328
1329 static int cp210x_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
1330 int value)
1331 {
1332 return 0;
1333 }
1334
1335 static int cp210x_gpio_set_config(struct gpio_chip *gc, unsigned int gpio,
1336 unsigned long config)
1337 {
1338 struct usb_serial *serial = gpiochip_get_data(gc);
1339 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1340 enum pin_config_param param = pinconf_to_config_param(config);
1341
1342 /* Succeed only if in correct mode (this can't be set at runtime) */
1343 if ((param == PIN_CONFIG_DRIVE_PUSH_PULL) &&
1344 (priv->gpio_mode & BIT(gpio)))
1345 return 0;
1346
1347 if ((param == PIN_CONFIG_DRIVE_OPEN_DRAIN) &&
1348 !(priv->gpio_mode & BIT(gpio)))
1349 return 0;
1350
1351 return -ENOTSUPP;
1352 }
1353
1354 /*
1355 * This function is for configuring GPIO using shared pins, where other signals
1356 * are made unavailable by configuring the use of GPIO. This is believed to be
1357 * only applicable to the cp2105 at this point, the other devices supported by
1358 * this driver that provide GPIO do so in a way that does not impact other
1359 * signals and are thus expected to have very different initialisation.
1360 */
1361 static int cp2105_shared_gpio_init(struct usb_serial *serial)
1362 {
1363 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1364 struct cp210x_pin_mode mode;
1365 struct cp210x_config config;
1366 u8 intf_num = cp210x_interface_num(serial);
1367 int result;
1368
1369 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1370 CP210X_GET_DEVICEMODE, &mode,
1371 sizeof(mode));
1372 if (result < 0)
1373 return result;
1374
1375 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1376 CP210X_GET_PORTCONFIG, &config,
1377 sizeof(config));
1378 if (result < 0)
1379 return result;
1380
1381 /* 2 banks of GPIO - One for the pins taken from each serial port */
1382 if (intf_num == 0) {
1383 if (mode.eci == CP210X_PIN_MODE_MODEM)
1384 return 0;
1385
1386 priv->config = config.eci_cfg;
1387 priv->gpio_mode = (u8)((le16_to_cpu(config.gpio_mode) &
1388 CP210X_ECI_GPIO_MODE_MASK) >>
1389 CP210X_ECI_GPIO_MODE_OFFSET);
1390 priv->gc.ngpio = 2;
1391 } else if (intf_num == 1) {
1392 if (mode.sci == CP210X_PIN_MODE_MODEM)
1393 return 0;
1394
1395 priv->config = config.sci_cfg;
1396 priv->gpio_mode = (u8)((le16_to_cpu(config.gpio_mode) &
1397 CP210X_SCI_GPIO_MODE_MASK) >>
1398 CP210X_SCI_GPIO_MODE_OFFSET);
1399 priv->gc.ngpio = 3;
1400 } else {
1401 return -ENODEV;
1402 }
1403
1404 priv->gc.label = "cp210x";
1405 priv->gc.request = cp210x_gpio_request;
1406 priv->gc.get_direction = cp210x_gpio_direction_get;
1407 priv->gc.direction_input = cp210x_gpio_direction_input;
1408 priv->gc.direction_output = cp210x_gpio_direction_output;
1409 priv->gc.get = cp210x_gpio_get;
1410 priv->gc.set = cp210x_gpio_set;
1411 priv->gc.set_config = cp210x_gpio_set_config;
1412 priv->gc.owner = THIS_MODULE;
1413 priv->gc.parent = &serial->interface->dev;
1414 priv->gc.base = -1;
1415 priv->gc.can_sleep = true;
1416
1417 result = gpiochip_add_data(&priv->gc, serial);
1418 if (!result)
1419 priv->gpio_registered = true;
1420
1421 return result;
1422 }
1423
1424 static void cp210x_gpio_remove(struct usb_serial *serial)
1425 {
1426 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1427
1428 if (priv->gpio_registered) {
1429 gpiochip_remove(&priv->gc);
1430 priv->gpio_registered = false;
1431 }
1432 }
1433
1434 #else
1435
1436 static int cp2105_shared_gpio_init(struct usb_serial *serial)
1437 {
1438 return 0;
1439 }
1440
1441 static void cp210x_gpio_remove(struct usb_serial *serial)
1442 {
1443 /* Nothing to do */
1444 }
1445
1446 #endif
1447
1448 static int cp210x_port_probe(struct usb_serial_port *port)
1449 {
1450 struct usb_serial *serial = port->serial;
1451 struct cp210x_port_private *port_priv;
1452 int ret;
1453
1454 port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
1455 if (!port_priv)
1456 return -ENOMEM;
1457
1458 port_priv->bInterfaceNumber = cp210x_interface_num(serial);
1459
1460 usb_set_serial_port_data(port, port_priv);
1461
1462 ret = cp210x_detect_swapped_line_ctl(port);
1463 if (ret) {
1464 kfree(port_priv);
1465 return ret;
1466 }
1467
1468 return 0;
1469 }
1470
1471 static int cp210x_port_remove(struct usb_serial_port *port)
1472 {
1473 struct cp210x_port_private *port_priv;
1474
1475 port_priv = usb_get_serial_port_data(port);
1476 kfree(port_priv);
1477
1478 return 0;
1479 }
1480
1481 static int cp210x_attach(struct usb_serial *serial)
1482 {
1483 int result;
1484 struct cp210x_serial_private *priv;
1485
1486 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1487 if (!priv)
1488 return -ENOMEM;
1489
1490 result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1491 CP210X_GET_PARTNUM, &priv->partnum,
1492 sizeof(priv->partnum));
1493 if (result < 0)
1494 goto err_free_priv;
1495
1496 usb_set_serial_data(serial, priv);
1497
1498 if (priv->partnum == CP210X_PARTNUM_CP2105) {
1499 result = cp2105_shared_gpio_init(serial);
1500 if (result < 0) {
1501 dev_err(&serial->interface->dev,
1502 "GPIO initialisation failed, continuing without GPIO support\n");
1503 }
1504 }
1505
1506 return 0;
1507 err_free_priv:
1508 kfree(priv);
1509
1510 return result;
1511 }
1512
1513 static void cp210x_disconnect(struct usb_serial *serial)
1514 {
1515 cp210x_gpio_remove(serial);
1516 }
1517
1518 static void cp210x_release(struct usb_serial *serial)
1519 {
1520 struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1521
1522 cp210x_gpio_remove(serial);
1523
1524 kfree(priv);
1525 }
1526
1527 module_usb_serial_driver(serial_drivers, id_table);
1528
1529 MODULE_DESCRIPTION(DRIVER_DESC);
1530 MODULE_LICENSE("GPL");