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