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