]> www.infradead.org Git - users/dwmw2/linux.git/blob
1339532
[users/dwmw2/linux.git] /
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_startup(struct usb_serial *);
47 static void cp210x_release(struct usb_serial *);
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, 0x8470) }, /* Juniper Networks BX Series System Console */
121         { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
122         { USB_DEVICE(0x10C4, 0x84B6) }, /* Starizona Hyperion */
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, 0x8962) }, /* Brim Brothers charging dock */
134         { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit Device */
135         { USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
136         { USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
137         { USB_DEVICE(0x10C4, 0x8A5E) }, /* CEL EM3588 ZigBee USB Stick Long Range */
138         { USB_DEVICE(0x10C4, 0x8B34) }, /* Qivicon ZigBee USB Radio Stick */
139         { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
140         { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
141         { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
142         { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
143         { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
144         { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
145         { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
146         { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
147         { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
148         { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
149         { USB_DEVICE(0x12B8, 0xEC60) }, /* Link G4 ECU */
150         { USB_DEVICE(0x12B8, 0xEC62) }, /* Link G4+ ECU */
151         { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
152         { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
153         { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
154         { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
155         { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
156         { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
157         { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
158         { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
159         { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
160         { USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
161         { USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
162         { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
163         { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
164         { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
165         { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
166         { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
167         { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
168         { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
169         { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
170         { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
171         { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
172         { USB_DEVICE(0x18EF, 0xE025) }, /* ELV Marble Sound Board 1 */
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(0x1901, 0x0195) }, /* GE B850/B650/B450 CP2104 DP UART interface */
178         { USB_DEVICE(0x1901, 0x0196) }, /* GE B850 CP2105 DP UART interface */
179         { USB_DEVICE(0x19CF, 0x3000) }, /* Parrot NMEA GPS Flight Recorder */
180         { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
181         { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
182         { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
183         { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
184         { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
185         { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
186         { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
187         { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
188         { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
189         { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
190         { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
191         { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
192         { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
193         { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
194         { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
195         { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
196         { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
197         { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
198         { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
199         { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
200         { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
201         { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
202         { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
203         { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
204         { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
205         { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
206         { USB_DEVICE(0x2626, 0xEA60) }, /* Aruba Networks 7xxx USB Serial Console */
207         { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
208         { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
209         { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
210         { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
211         { } /* Terminating Entry */
212 };
213
214 MODULE_DEVICE_TABLE(usb, id_table);
215
216 struct cp210x_serial_private {
217         __u8                    bInterfaceNumber;
218 };
219
220 static struct usb_serial_driver cp210x_device = {
221         .driver = {
222                 .owner =        THIS_MODULE,
223                 .name =         "cp210x",
224         },
225         .id_table               = id_table,
226         .num_ports              = 1,
227         .bulk_in_size           = 256,
228         .bulk_out_size          = 256,
229         .open                   = cp210x_open,
230         .close                  = cp210x_close,
231         .break_ctl              = cp210x_break_ctl,
232         .set_termios            = cp210x_set_termios,
233         .tiocmget               = cp210x_tiocmget,
234         .tiocmset               = cp210x_tiocmset,
235         .attach                 = cp210x_startup,
236         .release                = cp210x_release,
237         .dtr_rts                = cp210x_dtr_rts
238 };
239
240 static struct usb_serial_driver * const serial_drivers[] = {
241         &cp210x_device, NULL
242 };
243
244 /* Config request types */
245 #define REQTYPE_HOST_TO_INTERFACE       0x41
246 #define REQTYPE_INTERFACE_TO_HOST       0xc1
247 #define REQTYPE_HOST_TO_DEVICE  0x40
248 #define REQTYPE_DEVICE_TO_HOST  0xc0
249
250 /* Config request codes */
251 #define CP210X_IFC_ENABLE       0x00
252 #define CP210X_SET_BAUDDIV      0x01
253 #define CP210X_GET_BAUDDIV      0x02
254 #define CP210X_SET_LINE_CTL     0x03
255 #define CP210X_GET_LINE_CTL     0x04
256 #define CP210X_SET_BREAK        0x05
257 #define CP210X_IMM_CHAR         0x06
258 #define CP210X_SET_MHS          0x07
259 #define CP210X_GET_MDMSTS       0x08
260 #define CP210X_SET_XON          0x09
261 #define CP210X_SET_XOFF         0x0A
262 #define CP210X_SET_EVENTMASK    0x0B
263 #define CP210X_GET_EVENTMASK    0x0C
264 #define CP210X_SET_CHAR         0x0D
265 #define CP210X_GET_CHARS        0x0E
266 #define CP210X_GET_PROPS        0x0F
267 #define CP210X_GET_COMM_STATUS  0x10
268 #define CP210X_RESET            0x11
269 #define CP210X_PURGE            0x12
270 #define CP210X_SET_FLOW         0x13
271 #define CP210X_GET_FLOW         0x14
272 #define CP210X_EMBED_EVENTS     0x15
273 #define CP210X_GET_EVENTSTATE   0x16
274 #define CP210X_SET_CHARS        0x19
275 #define CP210X_GET_BAUDRATE     0x1D
276 #define CP210X_SET_BAUDRATE     0x1E
277
278 /* CP210X_IFC_ENABLE */
279 #define UART_ENABLE             0x0001
280 #define UART_DISABLE            0x0000
281
282 /* CP210X_(SET|GET)_BAUDDIV */
283 #define BAUD_RATE_GEN_FREQ      0x384000
284
285 /* CP210X_(SET|GET)_LINE_CTL */
286 #define BITS_DATA_MASK          0X0f00
287 #define BITS_DATA_5             0X0500
288 #define BITS_DATA_6             0X0600
289 #define BITS_DATA_7             0X0700
290 #define BITS_DATA_8             0X0800
291 #define BITS_DATA_9             0X0900
292
293 #define BITS_PARITY_MASK        0x00f0
294 #define BITS_PARITY_NONE        0x0000
295 #define BITS_PARITY_ODD         0x0010
296 #define BITS_PARITY_EVEN        0x0020
297 #define BITS_PARITY_MARK        0x0030
298 #define BITS_PARITY_SPACE       0x0040
299
300 #define BITS_STOP_MASK          0x000f
301 #define BITS_STOP_1             0x0000
302 #define BITS_STOP_1_5           0x0001
303 #define BITS_STOP_2             0x0002
304
305 /* CP210X_SET_BREAK */
306 #define BREAK_ON                0x0001
307 #define BREAK_OFF               0x0000
308
309 /* CP210X_(SET_MHS|GET_MDMSTS) */
310 #define CONTROL_DTR             0x0001
311 #define CONTROL_RTS             0x0002
312 #define CONTROL_CTS             0x0010
313 #define CONTROL_DSR             0x0020
314 #define CONTROL_RING            0x0040
315 #define CONTROL_DCD             0x0080
316 #define CONTROL_WRITE_DTR       0x0100
317 #define CONTROL_WRITE_RTS       0x0200
318
319 /*
320  * cp210x_get_config
321  * Reads from the CP210x configuration registers
322  * 'size' is specified in bytes.
323  * 'data' is a pointer to a pre-allocated array of integers large
324  * enough to hold 'size' bytes (with 4 bytes to each integer)
325  */
326 static int cp210x_get_config(struct usb_serial_port *port, u8 request,
327                 unsigned int *data, int size)
328 {
329         struct usb_serial *serial = port->serial;
330         struct cp210x_serial_private *spriv = usb_get_serial_data(serial);
331         __le32 *buf;
332         int result, i, length;
333
334         /* Number of integers required to contain the array */
335         length = (((size - 1) | 3) + 1) / 4;
336
337         buf = kcalloc(length, sizeof(__le32), GFP_KERNEL);
338         if (!buf)
339                 return -ENOMEM;
340
341         /* Issue the request, attempting to read 'size' bytes */
342         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
343                                 request, REQTYPE_INTERFACE_TO_HOST, 0x0000,
344                                 spriv->bInterfaceNumber, buf, size,
345                                 USB_CTRL_GET_TIMEOUT);
346
347         /* Convert data into an array of integers */
348         for (i = 0; i < length; i++)
349                 data[i] = le32_to_cpu(buf[i]);
350
351         kfree(buf);
352
353         if (result != size) {
354                 dev_dbg(&port->dev, "%s - Unable to send config request, request=0x%x size=%d result=%d\n",
355                         __func__, request, size, result);
356                 if (result > 0)
357                         result = -EPROTO;
358
359                 return result;
360         }
361
362         return 0;
363 }
364
365 /*
366  * cp210x_set_config
367  * Writes to the CP210x configuration registers
368  * Values less than 16 bits wide are sent directly
369  * 'size' is specified in bytes.
370  */
371 static int cp210x_set_config(struct usb_serial_port *port, u8 request,
372                 unsigned int *data, int size)
373 {
374         struct usb_serial *serial = port->serial;
375         struct cp210x_serial_private *spriv = usb_get_serial_data(serial);
376         __le32 *buf;
377         int result, i, length;
378
379         /* Number of integers required to contain the array */
380         length = (((size - 1) | 3) + 1) / 4;
381
382         buf = kmalloc(length * sizeof(__le32), GFP_KERNEL);
383         if (!buf)
384                 return -ENOMEM;
385
386         /* Array of integers into bytes */
387         for (i = 0; i < length; i++)
388                 buf[i] = cpu_to_le32(data[i]);
389
390         if (size > 2) {
391                 result = usb_control_msg(serial->dev,
392                                 usb_sndctrlpipe(serial->dev, 0),
393                                 request, REQTYPE_HOST_TO_INTERFACE, 0x0000,
394                                 spriv->bInterfaceNumber, buf, size,
395                                 USB_CTRL_SET_TIMEOUT);
396         } else {
397                 result = usb_control_msg(serial->dev,
398                                 usb_sndctrlpipe(serial->dev, 0),
399                                 request, REQTYPE_HOST_TO_INTERFACE, data[0],
400                                 spriv->bInterfaceNumber, NULL, 0,
401                                 USB_CTRL_SET_TIMEOUT);
402         }
403
404         kfree(buf);
405
406         if ((size > 2 && result != size) || result < 0) {
407                 dev_dbg(&port->dev, "%s - Unable to send request, request=0x%x size=%d result=%d\n",
408                         __func__, request, size, result);
409                 if (result > 0)
410                         result = -EPROTO;
411
412                 return result;
413         }
414
415         return 0;
416 }
417
418 /*
419  * cp210x_set_config_single
420  * Convenience function for calling cp210x_set_config on single data values
421  * without requiring an integer pointer
422  */
423 static inline int cp210x_set_config_single(struct usb_serial_port *port,
424                 u8 request, unsigned int data)
425 {
426         return cp210x_set_config(port, request, &data, 2);
427 }
428
429 /*
430  * cp210x_quantise_baudrate
431  * Quantises the baud rate as per AN205 Table 1
432  */
433 static unsigned int cp210x_quantise_baudrate(unsigned int baud)
434 {
435         if (baud <= 300)
436                 baud = 300;
437         else if (baud <= 600)      baud = 600;
438         else if (baud <= 1200)     baud = 1200;
439         else if (baud <= 1800)     baud = 1800;
440         else if (baud <= 2400)     baud = 2400;
441         else if (baud <= 4000)     baud = 4000;
442         else if (baud <= 4803)     baud = 4800;
443         else if (baud <= 7207)     baud = 7200;
444         else if (baud <= 9612)     baud = 9600;
445         else if (baud <= 14428)    baud = 14400;
446         else if (baud <= 16062)    baud = 16000;
447         else if (baud <= 19250)    baud = 19200;
448         else if (baud <= 28912)    baud = 28800;
449         else if (baud <= 38601)    baud = 38400;
450         else if (baud <= 51558)    baud = 51200;
451         else if (baud <= 56280)    baud = 56000;
452         else if (baud <= 58053)    baud = 57600;
453         else if (baud <= 64111)    baud = 64000;
454         else if (baud <= 77608)    baud = 76800;
455         else if (baud <= 117028)   baud = 115200;
456         else if (baud <= 129347)   baud = 128000;
457         else if (baud <= 156868)   baud = 153600;
458         else if (baud <= 237832)   baud = 230400;
459         else if (baud <= 254234)   baud = 250000;
460         else if (baud <= 273066)   baud = 256000;
461         else if (baud <= 491520)   baud = 460800;
462         else if (baud <= 567138)   baud = 500000;
463         else if (baud <= 670254)   baud = 576000;
464         else if (baud < 1000000)
465                 baud = 921600;
466         else if (baud > 2000000)
467                 baud = 2000000;
468         return baud;
469 }
470
471 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
472 {
473         int result;
474
475         result = cp210x_set_config_single(port, CP210X_IFC_ENABLE,
476                                                                 UART_ENABLE);
477         if (result) {
478                 dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
479                 return result;
480         }
481
482         /* Configure the termios structure */
483         cp210x_get_termios(tty, port);
484
485         /* The baud rate must be initialised on cp2104 */
486         if (tty)
487                 cp210x_change_speed(tty, port, NULL);
488
489         return usb_serial_generic_open(tty, port);
490 }
491
492 static void cp210x_close(struct usb_serial_port *port)
493 {
494         usb_serial_generic_close(port);
495         cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_DISABLE);
496 }
497
498 /*
499  * cp210x_get_termios
500  * Reads the baud rate, data bits, parity, stop bits and flow control mode
501  * from the device, corrects any unsupported values, and configures the
502  * termios structure to reflect the state of the device
503  */
504 static void cp210x_get_termios(struct tty_struct *tty,
505         struct usb_serial_port *port)
506 {
507         unsigned int baud;
508
509         if (tty) {
510                 cp210x_get_termios_port(tty->driver_data,
511                         &tty->termios.c_cflag, &baud);
512                 tty_encode_baud_rate(tty, baud, baud);
513         } else {
514                 unsigned int cflag;
515                 cflag = 0;
516                 cp210x_get_termios_port(port, &cflag, &baud);
517         }
518 }
519
520 /*
521  * cp210x_get_termios_port
522  * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
523  */
524 static void cp210x_get_termios_port(struct usb_serial_port *port,
525         unsigned int *cflagp, unsigned int *baudp)
526 {
527         struct device *dev = &port->dev;
528         unsigned int cflag, modem_ctl[4];
529         unsigned int baud;
530         unsigned int bits;
531
532         cp210x_get_config(port, CP210X_GET_BAUDRATE, &baud, 4);
533
534         dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud);
535         *baudp = baud;
536
537         cflag = *cflagp;
538
539         cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
540         cflag &= ~CSIZE;
541         switch (bits & BITS_DATA_MASK) {
542         case BITS_DATA_5:
543                 dev_dbg(dev, "%s - data bits = 5\n", __func__);
544                 cflag |= CS5;
545                 break;
546         case BITS_DATA_6:
547                 dev_dbg(dev, "%s - data bits = 6\n", __func__);
548                 cflag |= CS6;
549                 break;
550         case BITS_DATA_7:
551                 dev_dbg(dev, "%s - data bits = 7\n", __func__);
552                 cflag |= CS7;
553                 break;
554         case BITS_DATA_8:
555                 dev_dbg(dev, "%s - data bits = 8\n", __func__);
556                 cflag |= CS8;
557                 break;
558         case BITS_DATA_9:
559                 dev_dbg(dev, "%s - data bits = 9 (not supported, using 8 data bits)\n", __func__);
560                 cflag |= CS8;
561                 bits &= ~BITS_DATA_MASK;
562                 bits |= BITS_DATA_8;
563                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
564                 break;
565         default:
566                 dev_dbg(dev, "%s - Unknown number of data bits, using 8\n", __func__);
567                 cflag |= CS8;
568                 bits &= ~BITS_DATA_MASK;
569                 bits |= BITS_DATA_8;
570                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
571                 break;
572         }
573
574         switch (bits & BITS_PARITY_MASK) {
575         case BITS_PARITY_NONE:
576                 dev_dbg(dev, "%s - parity = NONE\n", __func__);
577                 cflag &= ~PARENB;
578                 break;
579         case BITS_PARITY_ODD:
580                 dev_dbg(dev, "%s - parity = ODD\n", __func__);
581                 cflag |= (PARENB|PARODD);
582                 break;
583         case BITS_PARITY_EVEN:
584                 dev_dbg(dev, "%s - parity = EVEN\n", __func__);
585                 cflag &= ~PARODD;
586                 cflag |= PARENB;
587                 break;
588         case BITS_PARITY_MARK:
589                 dev_dbg(dev, "%s - parity = MARK\n", __func__);
590                 cflag |= (PARENB|PARODD|CMSPAR);
591                 break;
592         case BITS_PARITY_SPACE:
593                 dev_dbg(dev, "%s - parity = SPACE\n", __func__);
594                 cflag &= ~PARODD;
595                 cflag |= (PARENB|CMSPAR);
596                 break;
597         default:
598                 dev_dbg(dev, "%s - Unknown parity mode, disabling parity\n", __func__);
599                 cflag &= ~PARENB;
600                 bits &= ~BITS_PARITY_MASK;
601                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
602                 break;
603         }
604
605         cflag &= ~CSTOPB;
606         switch (bits & BITS_STOP_MASK) {
607         case BITS_STOP_1:
608                 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
609                 break;
610         case BITS_STOP_1_5:
611                 dev_dbg(dev, "%s - stop bits = 1.5 (not supported, using 1 stop bit)\n", __func__);
612                 bits &= ~BITS_STOP_MASK;
613                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
614                 break;
615         case BITS_STOP_2:
616                 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
617                 cflag |= CSTOPB;
618                 break;
619         default:
620                 dev_dbg(dev, "%s - Unknown number of stop bits, using 1 stop bit\n", __func__);
621                 bits &= ~BITS_STOP_MASK;
622                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
623                 break;
624         }
625
626         cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
627         if (modem_ctl[0] & 0x0008) {
628                 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
629                 cflag |= CRTSCTS;
630         } else {
631                 dev_dbg(dev, "%s - flow control = NONE\n", __func__);
632                 cflag &= ~CRTSCTS;
633         }
634
635         *cflagp = cflag;
636 }
637
638 /*
639  * CP2101 supports the following baud rates:
640  *
641  *      300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
642  *      38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
643  *
644  * CP2102 and CP2103 support the following additional rates:
645  *
646  *      4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
647  *      576000
648  *
649  * The device will map a requested rate to a supported one, but the result
650  * of requests for rates greater than 1053257 is undefined (see AN205).
651  *
652  * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
653  * respectively, with an error less than 1%. The actual rates are determined
654  * by
655  *
656  *      div = round(freq / (2 x prescale x request))
657  *      actual = freq / (2 x prescale x div)
658  *
659  * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
660  * or 1 otherwise.
661  * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
662  * otherwise.
663  */
664 static void cp210x_change_speed(struct tty_struct *tty,
665                 struct usb_serial_port *port, struct ktermios *old_termios)
666 {
667         u32 baud;
668
669         baud = tty->termios.c_ospeed;
670
671         /* This maps the requested rate to a rate valid on cp2102 or cp2103,
672          * or to an arbitrary rate in [1M,2M].
673          *
674          * NOTE: B0 is not implemented.
675          */
676         baud = cp210x_quantise_baudrate(baud);
677
678         dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
679         if (cp210x_set_config(port, CP210X_SET_BAUDRATE, &baud,
680                                                         sizeof(baud))) {
681                 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
682                 if (old_termios)
683                         baud = old_termios->c_ospeed;
684                 else
685                         baud = 9600;
686         }
687
688         tty_encode_baud_rate(tty, baud, baud);
689 }
690
691 static void cp210x_set_termios(struct tty_struct *tty,
692                 struct usb_serial_port *port, struct ktermios *old_termios)
693 {
694         struct device *dev = &port->dev;
695         unsigned int cflag, old_cflag;
696         unsigned int bits;
697         unsigned int modem_ctl[4];
698
699         cflag = tty->termios.c_cflag;
700         old_cflag = old_termios->c_cflag;
701
702         if (tty->termios.c_ospeed != old_termios->c_ospeed)
703                 cp210x_change_speed(tty, port, old_termios);
704
705         /* If the number of data bits is to be updated */
706         if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
707                 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
708                 bits &= ~BITS_DATA_MASK;
709                 switch (cflag & CSIZE) {
710                 case CS5:
711                         bits |= BITS_DATA_5;
712                         dev_dbg(dev, "%s - data bits = 5\n", __func__);
713                         break;
714                 case CS6:
715                         bits |= BITS_DATA_6;
716                         dev_dbg(dev, "%s - data bits = 6\n", __func__);
717                         break;
718                 case CS7:
719                         bits |= BITS_DATA_7;
720                         dev_dbg(dev, "%s - data bits = 7\n", __func__);
721                         break;
722                 case CS8:
723                         bits |= BITS_DATA_8;
724                         dev_dbg(dev, "%s - data bits = 8\n", __func__);
725                         break;
726                 /*case CS9:
727                         bits |= BITS_DATA_9;
728                         dev_dbg(dev, "%s - data bits = 9\n", __func__);
729                         break;*/
730                 default:
731                         dev_dbg(dev, "cp210x driver does not support the number of bits requested, using 8 bit mode\n");
732                         bits |= BITS_DATA_8;
733                         break;
734                 }
735                 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
736                         dev_dbg(dev, "Number of data bits requested not supported by device\n");
737         }
738
739         if ((cflag     & (PARENB|PARODD|CMSPAR)) !=
740             (old_cflag & (PARENB|PARODD|CMSPAR))) {
741                 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
742                 bits &= ~BITS_PARITY_MASK;
743                 if (cflag & PARENB) {
744                         if (cflag & CMSPAR) {
745                                 if (cflag & PARODD) {
746                                         bits |= BITS_PARITY_MARK;
747                                         dev_dbg(dev, "%s - parity = MARK\n", __func__);
748                                 } else {
749                                         bits |= BITS_PARITY_SPACE;
750                                         dev_dbg(dev, "%s - parity = SPACE\n", __func__);
751                                 }
752                         } else {
753                                 if (cflag & PARODD) {
754                                         bits |= BITS_PARITY_ODD;
755                                         dev_dbg(dev, "%s - parity = ODD\n", __func__);
756                                 } else {
757                                         bits |= BITS_PARITY_EVEN;
758                                         dev_dbg(dev, "%s - parity = EVEN\n", __func__);
759                                 }
760                         }
761                 }
762                 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
763                         dev_dbg(dev, "Parity mode not supported by device\n");
764         }
765
766         if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
767                 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
768                 bits &= ~BITS_STOP_MASK;
769                 if (cflag & CSTOPB) {
770                         bits |= BITS_STOP_2;
771                         dev_dbg(dev, "%s - stop bits = 2\n", __func__);
772                 } else {
773                         bits |= BITS_STOP_1;
774                         dev_dbg(dev, "%s - stop bits = 1\n", __func__);
775                 }
776                 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
777                         dev_dbg(dev, "Number of stop bits requested not supported by device\n");
778         }
779
780         if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
781                 cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
782                 dev_dbg(dev, "%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x\n",
783                         __func__, modem_ctl[0], modem_ctl[1],
784                         modem_ctl[2], modem_ctl[3]);
785
786                 if (cflag & CRTSCTS) {
787                         modem_ctl[0] &= ~0x7B;
788                         modem_ctl[0] |= 0x09;
789                         modem_ctl[1] = 0x80;
790                         dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
791                 } else {
792                         modem_ctl[0] &= ~0x7B;
793                         modem_ctl[0] |= 0x01;
794                         modem_ctl[1] |= 0x40;
795                         dev_dbg(dev, "%s - flow control = NONE\n", __func__);
796                 }
797
798                 dev_dbg(dev, "%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x\n",
799                         __func__, modem_ctl[0], modem_ctl[1],
800                         modem_ctl[2], modem_ctl[3]);
801                 cp210x_set_config(port, CP210X_SET_FLOW, modem_ctl, 16);
802         }
803
804 }
805
806 static int cp210x_tiocmset(struct tty_struct *tty,
807                 unsigned int set, unsigned int clear)
808 {
809         struct usb_serial_port *port = tty->driver_data;
810         return cp210x_tiocmset_port(port, set, clear);
811 }
812
813 static int cp210x_tiocmset_port(struct usb_serial_port *port,
814                 unsigned int set, unsigned int clear)
815 {
816         unsigned int control = 0;
817
818         if (set & TIOCM_RTS) {
819                 control |= CONTROL_RTS;
820                 control |= CONTROL_WRITE_RTS;
821         }
822         if (set & TIOCM_DTR) {
823                 control |= CONTROL_DTR;
824                 control |= CONTROL_WRITE_DTR;
825         }
826         if (clear & TIOCM_RTS) {
827                 control &= ~CONTROL_RTS;
828                 control |= CONTROL_WRITE_RTS;
829         }
830         if (clear & TIOCM_DTR) {
831                 control &= ~CONTROL_DTR;
832                 control |= CONTROL_WRITE_DTR;
833         }
834
835         dev_dbg(&port->dev, "%s - control = 0x%.4x\n", __func__, control);
836
837         return cp210x_set_config(port, CP210X_SET_MHS, &control, 2);
838 }
839
840 static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
841 {
842         if (on)
843                 cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
844         else
845                 cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
846 }
847
848 static int cp210x_tiocmget(struct tty_struct *tty)
849 {
850         struct usb_serial_port *port = tty->driver_data;
851         unsigned int control;
852         int result;
853
854         cp210x_get_config(port, CP210X_GET_MDMSTS, &control, 1);
855
856         result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
857                 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
858                 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
859                 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
860                 |((control & CONTROL_RING)? TIOCM_RI  : 0)
861                 |((control & CONTROL_DCD) ? TIOCM_CD  : 0);
862
863         dev_dbg(&port->dev, "%s - control = 0x%.2x\n", __func__, control);
864
865         return result;
866 }
867
868 static void cp210x_break_ctl(struct tty_struct *tty, int break_state)
869 {
870         struct usb_serial_port *port = tty->driver_data;
871         unsigned int state;
872
873         if (break_state == 0)
874                 state = BREAK_OFF;
875         else
876                 state = BREAK_ON;
877         dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
878                 state == BREAK_OFF ? "off" : "on");
879         cp210x_set_config(port, CP210X_SET_BREAK, &state, 2);
880 }
881
882 static int cp210x_startup(struct usb_serial *serial)
883 {
884         struct usb_host_interface *cur_altsetting;
885         struct cp210x_serial_private *spriv;
886
887         /* cp210x buffers behave strangely unless device is reset */
888         usb_reset_device(serial->dev);
889
890         spriv = kzalloc(sizeof(*spriv), GFP_KERNEL);
891         if (!spriv)
892                 return -ENOMEM;
893
894         cur_altsetting = serial->interface->cur_altsetting;
895         spriv->bInterfaceNumber = cur_altsetting->desc.bInterfaceNumber;
896
897         usb_set_serial_data(serial, spriv);
898
899         return 0;
900 }
901
902 static void cp210x_release(struct usb_serial *serial)
903 {
904         struct cp210x_serial_private *spriv;
905
906         spriv = usb_get_serial_data(serial);
907         kfree(spriv);
908 }
909
910 module_usb_serial_driver(serial_drivers, id_table);
911
912 MODULE_DESCRIPTION(DRIVER_DESC);
913 MODULE_LICENSE("GPL");