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