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