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_dtr_rts(struct usb_serial_port *p, int on);
  53
  54 static bool debug;
  55
  56 static const struct usb_device_id id_table[] = {
  57         { USB_DEVICE(0x045B, 0x0053) }, /* Renesas RX610 RX-Stick */
  58         { USB_DEVICE(0x0471, 0x066A) }, /* AKTAKOM ACE-1001 cable */
  59         { USB_DEVICE(0x0489, 0xE000) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
  60         { USB_DEVICE(0x0489, 0xE003) }, /* 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 demonstration module */
 108         { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis 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         .bulk_in_size           = 256,
 169         .bulk_out_size          = 256,
 170         .open                   = cp210x_open,
 171         .close                  = cp210x_close,
 172         .break_ctl              = cp210x_break_ctl,
 173         .set_termios            = cp210x_set_termios,
 174         .tiocmget               = cp210x_tiocmget,
 175         .tiocmset               = cp210x_tiocmset,
 176         .attach                 = cp210x_startup,
 177         .dtr_rts                = cp210x_dtr_rts
 178 };
 179
 180 /* Config request types */
 181 #define REQTYPE_HOST_TO_DEVICE  0x41
 182 #define REQTYPE_DEVICE_TO_HOST  0xc1
 183
 184 /* Config request codes */
 185 #define CP210X_IFC_ENABLE       0x00
 186 #define CP210X_SET_BAUDDIV      0x01
 187 #define CP210X_GET_BAUDDIV      0x02
 188 #define CP210X_SET_LINE_CTL     0x03
 189 #define CP210X_GET_LINE_CTL     0x04
 190 #define CP210X_SET_BREAK        0x05
 191 #define CP210X_IMM_CHAR         0x06
 192 #define CP210X_SET_MHS          0x07
 193 #define CP210X_GET_MDMSTS       0x08
 194 #define CP210X_SET_XON          0x09
 195 #define CP210X_SET_XOFF         0x0A
 196 #define CP210X_SET_EVENTMASK    0x0B
 197 #define CP210X_GET_EVENTMASK    0x0C
 198 #define CP210X_SET_CHAR         0x0D
 199 #define CP210X_GET_CHARS        0x0E
 200 #define CP210X_GET_PROPS        0x0F
 201 #define CP210X_GET_COMM_STATUS  0x10
 202 #define CP210X_RESET            0x11
 203 #define CP210X_PURGE            0x12
 204 #define CP210X_SET_FLOW         0x13
 205 #define CP210X_GET_FLOW         0x14
 206 #define CP210X_EMBED_EVENTS     0x15
 207 #define CP210X_GET_EVENTSTATE   0x16
 208 #define CP210X_SET_CHARS        0x19
 209 #define CP210X_GET_BAUDRATE     0x1D
 210 #define CP210X_SET_BAUDRATE     0x1E
 211
 212 /* CP210X_IFC_ENABLE */
 213 #define UART_ENABLE             0x0001
 214 #define UART_DISABLE            0x0000
 215
 216 /* CP210X_(SET|GET)_BAUDDIV */
 217 #define BAUD_RATE_GEN_FREQ      0x384000
 218
 219 /* CP210X_(SET|GET)_LINE_CTL */
 220 #define BITS_DATA_MASK          0X0f00
 221 #define BITS_DATA_5             0X0500
 222 #define BITS_DATA_6             0X0600
 223 #define BITS_DATA_7             0X0700
 224 #define BITS_DATA_8             0X0800
 225 #define BITS_DATA_9             0X0900
 226
 227 #define BITS_PARITY_MASK        0x00f0
 228 #define BITS_PARITY_NONE        0x0000
 229 #define BITS_PARITY_ODD         0x0010
 230 #define BITS_PARITY_EVEN        0x0020
 231 #define BITS_PARITY_MARK        0x0030
 232 #define BITS_PARITY_SPACE       0x0040
 233
 234 #define BITS_STOP_MASK          0x000f
 235 #define BITS_STOP_1             0x0000
 236 #define BITS_STOP_1_5           0x0001
 237 #define BITS_STOP_2             0x0002
 238
 239 /* CP210X_SET_BREAK */
 240 #define BREAK_ON                0x0001
 241 #define BREAK_OFF               0x0000
 242
 243 /* CP210X_(SET_MHS|GET_MDMSTS) */
 244 #define CONTROL_DTR             0x0001
 245 #define CONTROL_RTS             0x0002
 246 #define CONTROL_CTS             0x0010
 247 #define CONTROL_DSR             0x0020
 248 #define CONTROL_RING            0x0040
 249 #define CONTROL_DCD             0x0080
 250 #define CONTROL_WRITE_DTR       0x0100
 251 #define CONTROL_WRITE_RTS       0x0200
 252
 253 /*
 254  * cp210x_get_config
 255  * Reads from the CP210x configuration registers
 256  * 'size' is specified in bytes.
 257  * 'data' is a pointer to a pre-allocated array of integers large
 258  * enough to hold 'size' bytes (with 4 bytes to each integer)
 259  */
 260 static int cp210x_get_config(struct usb_serial_port *port, u8 request,
 261                 unsigned int *data, int size)
 262 {
 263         struct usb_serial *serial = port->serial;
 264         __le32 *buf;
 265         int result, i, length;
 266
 267         /* Number of integers required to contain the array */
 268         length = (((size - 1) | 3) + 1)/4;
 269
 270         buf = kcalloc(length, sizeof(__le32), GFP_KERNEL);
 271         if (!buf) {
 272                 dev_err(&port->dev, "%s - out of memory.\n", __func__);
 273                 return -ENOMEM;
 274         }
 275
 276         /* Issue the request, attempting to read 'size' bytes */
 277         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 278                                 request, REQTYPE_DEVICE_TO_HOST, 0x0000,
 279                                 0, buf, size, 300);
 280
 281         /* Convert data into an array of integers */
 282         for (i = 0; i < length; i++)
 283                 data[i] = le32_to_cpu(buf[i]);
 284
 285         kfree(buf);
 286
 287         if (result != size) {
 288                 dbg("%s - Unable to send config request, "
 289                                 "request=0x%x size=%d result=%d\n",
 290                                 __func__, request, size, result);
 291                 if (result > 0)
 292                         result = -EPROTO;
 293
 294                 return result;
 295         }
 296
 297         return 0;
 298 }
 299
 300 /*
 301  * cp210x_set_config
 302  * Writes to the CP210x configuration registers
 303  * Values less than 16 bits wide are sent directly
 304  * 'size' is specified in bytes.
 305  */
 306 static int cp210x_set_config(struct usb_serial_port *port, u8 request,
 307                 unsigned int *data, int size)
 308 {
 309         struct usb_serial *serial = port->serial;
 310         __le32 *buf;
 311         int result, i, length;
 312
 313         /* Number of integers required to contain the array */
 314         length = (((size - 1) | 3) + 1)/4;
 315
 316         buf = kmalloc(length * sizeof(__le32), GFP_KERNEL);
 317         if (!buf) {
 318                 dev_err(&port->dev, "%s - out of memory.\n",
 319                                 __func__);
 320                 return -ENOMEM;
 321         }
 322
 323         /* Array of integers into bytes */
 324         for (i = 0; i < length; i++)
 325                 buf[i] = cpu_to_le32(data[i]);
 326
 327         if (size > 2) {
 328                 result = usb_control_msg(serial->dev,
 329                                 usb_sndctrlpipe(serial->dev, 0),
 330                                 request, REQTYPE_HOST_TO_DEVICE, 0x0000,
 331                                 0, buf, size, 300);
 332         } else {
 333                 result = usb_control_msg(serial->dev,
 334                                 usb_sndctrlpipe(serial->dev, 0),
 335                                 request, REQTYPE_HOST_TO_DEVICE, data[0],
 336                                 0, NULL, 0, 300);
 337         }
 338
 339         kfree(buf);
 340
 341         if ((size > 2 && result != size) || result < 0) {
 342                 dbg("%s - Unable to send request, "
 343                                 "request=0x%x size=%d result=%d\n",
 344                                 __func__, request, size, result);
 345                 if (result > 0)
 346                         result = -EPROTO;
 347
 348                 return result;
 349         }
 350
 351         return 0;
 352 }
 353
 354 /*
 355  * cp210x_set_config_single
 356  * Convenience function for calling cp210x_set_config on single data values
 357  * without requiring an integer pointer
 358  */
 359 static inline int cp210x_set_config_single(struct usb_serial_port *port,
 360                 u8 request, unsigned int data)
 361 {
 362         return cp210x_set_config(port, request, &data, 2);
 363 }
 364
 365 /*
 366  * cp210x_quantise_baudrate
 367  * Quantises the baud rate as per AN205 Table 1
 368  */
 369 static unsigned int cp210x_quantise_baudrate(unsigned int baud) {
 370         if (baud <= 300)
 371                 baud = 300;
 372         else if (baud <= 600)      baud = 600;
 373         else if (baud <= 1200)     baud = 1200;
 374         else if (baud <= 1800)     baud = 1800;
 375         else if (baud <= 2400)     baud = 2400;
 376         else if (baud <= 4000)     baud = 4000;
 377         else if (baud <= 4803)     baud = 4800;
 378         else if (baud <= 7207)     baud = 7200;
 379         else if (baud <= 9612)     baud = 9600;
 380         else if (baud <= 14428)    baud = 14400;
 381         else if (baud <= 16062)    baud = 16000;
 382         else if (baud <= 19250)    baud = 19200;
 383         else if (baud <= 28912)    baud = 28800;
 384         else if (baud <= 38601)    baud = 38400;
 385         else if (baud <= 51558)    baud = 51200;
 386         else if (baud <= 56280)    baud = 56000;
 387         else if (baud <= 58053)    baud = 57600;
 388         else if (baud <= 64111)    baud = 64000;
 389         else if (baud <= 77608)    baud = 76800;
 390         else if (baud <= 117028)   baud = 115200;
 391         else if (baud <= 129347)   baud = 128000;
 392         else if (baud <= 156868)   baud = 153600;
 393         else if (baud <= 237832)   baud = 230400;
 394         else if (baud <= 254234)   baud = 250000;
 395         else if (baud <= 273066)   baud = 256000;
 396         else if (baud <= 491520)   baud = 460800;
 397         else if (baud <= 567138)   baud = 500000;
 398         else if (baud <= 670254)   baud = 576000;
 399         else if (baud < 1000000)
 400                 baud = 921600;
 401         else if (baud > 2000000)
 402                 baud = 2000000;
 403         return baud;
 404 }
 405
 406 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
 407 {
 408         int result;
 409
 410         dbg("%s - port %d", __func__, port->number);
 411
 412         result = cp210x_set_config_single(port, CP210X_IFC_ENABLE,
 413                                                                 UART_ENABLE);
 414         if (result) {
 415                 dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
 416                 return result;
 417         }
 418
 419         /* Configure the termios structure */
 420         cp210x_get_termios(tty, port);
 421
 422         /* The baud rate must be initialised on cp2104 */
 423         if (tty)
 424                 cp210x_change_speed(tty, port, NULL);
 425
 426         return usb_serial_generic_open(tty, port);
 427 }
 428
 429 static void cp210x_close(struct usb_serial_port *port)
 430 {
 431         dbg("%s - port %d", __func__, port->number);
 432
 433         usb_serial_generic_close(port);
 434
 435         mutex_lock(&port->serial->disc_mutex);
 436         if (!port->serial->disconnected)
 437                 cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_DISABLE);
 438         mutex_unlock(&port->serial->disc_mutex);
 439 }
 440
 441 /*
 442  * cp210x_get_termios
 443  * Reads the baud rate, data bits, parity, stop bits and flow control mode
 444  * from the device, corrects any unsupported values, and configures the
 445  * termios structure to reflect the state of the device
 446  */
 447 static void cp210x_get_termios(struct tty_struct *tty,
 448         struct usb_serial_port *port)
 449 {
 450         unsigned int baud;
 451
 452         if (tty) {
 453                 cp210x_get_termios_port(tty->driver_data,
 454                         &tty->termios->c_cflag, &baud);
 455                 tty_encode_baud_rate(tty, baud, baud);
 456         }
 457
 458         else {
 459                 unsigned int cflag;
 460                 cflag = 0;
 461                 cp210x_get_termios_port(port, &cflag, &baud);
 462         }
 463 }
 464
 465 /*
 466  * cp210x_get_termios_port
 467  * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
 468  */
 469 static void cp210x_get_termios_port(struct usb_serial_port *port,
 470         unsigned int *cflagp, unsigned int *baudp)
 471 {
 472         unsigned int cflag, modem_ctl[4];
 473         unsigned int baud;
 474         unsigned int bits;
 475
 476         dbg("%s - port %d", __func__, port->number);
 477
 478         cp210x_get_config(port, CP210X_GET_BAUDRATE, &baud, 4);
 479
 480         dbg("%s - baud rate = %d", __func__, baud);
 481         *baudp = baud;
 482
 483         cflag = *cflagp;
 484
 485         cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
 486         cflag &= ~CSIZE;
 487         switch (bits & BITS_DATA_MASK) {
 488         case BITS_DATA_5:
 489                 dbg("%s - data bits = 5", __func__);
 490                 cflag |= CS5;
 491                 break;
 492         case BITS_DATA_6:
 493                 dbg("%s - data bits = 6", __func__);
 494                 cflag |= CS6;
 495                 break;
 496         case BITS_DATA_7:
 497                 dbg("%s - data bits = 7", __func__);
 498                 cflag |= CS7;
 499                 break;
 500         case BITS_DATA_8:
 501                 dbg("%s - data bits = 8", __func__);
 502                 cflag |= CS8;
 503                 break;
 504         case BITS_DATA_9:
 505                 dbg("%s - data bits = 9 (not supported, using 8 data bits)",
 506                                                                 __func__);
 507                 cflag |= CS8;
 508                 bits &= ~BITS_DATA_MASK;
 509                 bits |= BITS_DATA_8;
 510                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 511                 break;
 512         default:
 513                 dbg("%s - Unknown number of data bits, using 8", __func__);
 514                 cflag |= CS8;
 515                 bits &= ~BITS_DATA_MASK;
 516                 bits |= BITS_DATA_8;
 517                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 518                 break;
 519         }
 520
 521         switch (bits & BITS_PARITY_MASK) {
 522         case BITS_PARITY_NONE:
 523                 dbg("%s - parity = NONE", __func__);
 524                 cflag &= ~PARENB;
 525                 break;
 526         case BITS_PARITY_ODD:
 527                 dbg("%s - parity = ODD", __func__);
 528                 cflag |= (PARENB|PARODD);
 529                 break;
 530         case BITS_PARITY_EVEN:
 531                 dbg("%s - parity = EVEN", __func__);
 532                 cflag &= ~PARODD;
 533                 cflag |= PARENB;
 534                 break;
 535         case BITS_PARITY_MARK:
 536                 dbg("%s - parity = MARK", __func__);
 537                 cflag |= (PARENB|PARODD|CMSPAR);
 538                 break;
 539         case BITS_PARITY_SPACE:
 540                 dbg("%s - parity = SPACE", __func__);
 541                 cflag &= ~PARODD;
 542                 cflag |= (PARENB|CMSPAR);
 543                 break;
 544         default:
 545                 dbg("%s - Unknown parity mode, disabling parity", __func__);
 546                 cflag &= ~PARENB;
 547                 bits &= ~BITS_PARITY_MASK;
 548                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 549                 break;
 550         }
 551
 552         cflag &= ~CSTOPB;
 553         switch (bits & BITS_STOP_MASK) {
 554         case BITS_STOP_1:
 555                 dbg("%s - stop bits = 1", __func__);
 556                 break;
 557         case BITS_STOP_1_5:
 558                 dbg("%s - stop bits = 1.5 (not supported, using 1 stop bit)",
 559                                                                 __func__);
 560                 bits &= ~BITS_STOP_MASK;
 561                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 562                 break;
 563         case BITS_STOP_2:
 564                 dbg("%s - stop bits = 2", __func__);
 565                 cflag |= CSTOPB;
 566                 break;
 567         default:
 568                 dbg("%s - Unknown number of stop bits, using 1 stop bit",
 569                                                                 __func__);
 570                 bits &= ~BITS_STOP_MASK;
 571                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 572                 break;
 573         }
 574
 575         cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
 576         if (modem_ctl[0] & 0x0008) {
 577                 dbg("%s - flow control = CRTSCTS", __func__);
 578                 cflag |= CRTSCTS;
 579         } else {
 580                 dbg("%s - flow control = NONE", __func__);
 581                 cflag &= ~CRTSCTS;
 582         }
 583
 584         *cflagp = cflag;
 585 }
 586
 587 /*
 588  * CP2101 supports the following baud rates:
 589  *
 590  *      300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
 591  *      38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
 592  *
 593  * CP2102 and CP2103 support the following additional rates:
 594  *
 595  *      4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
 596  *      576000
 597  *
 598  * The device will map a requested rate to a supported one, but the result
 599  * of requests for rates greater than 1053257 is undefined (see AN205).
 600  *
 601  * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
 602  * respectively, with an error less than 1%. The actual rates are determined
 603  * by
 604  *
 605  *      div = round(freq / (2 x prescale x request))
 606  *      actual = freq / (2 x prescale x div)
 607  *
 608  * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
 609  * or 1 otherwise.
 610  * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
 611  * otherwise.
 612  */
 613 static void cp210x_change_speed(struct tty_struct *tty,
 614                 struct usb_serial_port *port, struct ktermios *old_termios)
 615 {
 616         u32 baud;
 617
 618         baud = tty->termios->c_ospeed;
 619
 620         /* This maps the requested rate to a rate valid on cp2102 or cp2103,
 621          * or to an arbitrary rate in [1M,2M].
 622          *
 623          * NOTE: B0 is not implemented.
 624          */
 625         baud = cp210x_quantise_baudrate(baud);
 626
 627         dbg("%s - setting baud rate to %u", __func__, baud);
 628         if (cp210x_set_config(port, CP210X_SET_BAUDRATE, &baud,
 629                                                         sizeof(baud))) {
 630                 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
 631                 if (old_termios)
 632                         baud = old_termios->c_ospeed;
 633                 else
 634                         baud = 9600;
 635         }
 636
 637         tty_encode_baud_rate(tty, baud, baud);
 638 }
 639
 640 static void cp210x_set_termios(struct tty_struct *tty,
 641                 struct usb_serial_port *port, struct ktermios *old_termios)
 642 {
 643         unsigned int cflag, old_cflag;
 644         unsigned int bits;
 645         unsigned int modem_ctl[4];
 646
 647         dbg("%s - port %d", __func__, port->number);
 648
 649         if (!tty)
 650                 return;
 651
 652         cflag = tty->termios->c_cflag;
 653         old_cflag = old_termios->c_cflag;
 654
 655         if (tty->termios->c_ospeed != old_termios->c_ospeed)
 656                 cp210x_change_speed(tty, port, old_termios);
 657
 658         /* If the number of data bits is to be updated */
 659         if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
 660                 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
 661                 bits &= ~BITS_DATA_MASK;
 662                 switch (cflag & CSIZE) {
 663                 case CS5:
 664                         bits |= BITS_DATA_5;
 665                         dbg("%s - data bits = 5", __func__);
 666                         break;
 667                 case CS6:
 668                         bits |= BITS_DATA_6;
 669                         dbg("%s - data bits = 6", __func__);
 670                         break;
 671                 case CS7:
 672                         bits |= BITS_DATA_7;
 673                         dbg("%s - data bits = 7", __func__);
 674                         break;
 675                 case CS8:
 676                         bits |= BITS_DATA_8;
 677                         dbg("%s - data bits = 8", __func__);
 678                         break;
 679                 /*case CS9:
 680                         bits |= BITS_DATA_9;
 681                         dbg("%s - data bits = 9", __func__);
 682                         break;*/
 683                 default:
 684                         dbg("cp210x driver does not "
 685                                         "support the number of bits requested,"
 686                                         " using 8 bit mode\n");
 687                                 bits |= BITS_DATA_8;
 688                                 break;
 689                 }
 690                 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
 691                         dbg("Number of data bits requested "
 692                                         "not supported by device\n");
 693         }
 694
 695         if ((cflag     & (PARENB|PARODD|CMSPAR)) !=
 696             (old_cflag & (PARENB|PARODD|CMSPAR))) {
 697                 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
 698                 bits &= ~BITS_PARITY_MASK;
 699                 if (cflag & PARENB) {
 700                         if (cflag & CMSPAR) {
 701                             if (cflag & PARODD) {
 702                                     bits |= BITS_PARITY_MARK;
 703                                     dbg("%s - parity = MARK", __func__);
 704                             } else {
 705                                     bits |= BITS_PARITY_SPACE;
 706                                     dbg("%s - parity = SPACE", __func__);
 707                             }
 708                         } else {
 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                 }
 718                 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
 719                         dbg("Parity mode not supported "
 720                                         "by device\n");
 721         }
 722
 723         if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
 724                 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
 725                 bits &= ~BITS_STOP_MASK;
 726                 if (cflag & CSTOPB) {
 727                         bits |= BITS_STOP_2;
 728                         dbg("%s - stop bits = 2", __func__);
 729                 } else {
 730                         bits |= BITS_STOP_1;
 731                         dbg("%s - stop bits = 1", __func__);
 732                 }
 733                 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
 734                         dbg("Number of stop bits requested "
 735                                         "not supported by device\n");
 736         }
 737
 738         if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
 739                 cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
 740                 dbg("%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
 741                                 __func__, modem_ctl[0], modem_ctl[1],
 742                                 modem_ctl[2], modem_ctl[3]);
 743
 744                 if (cflag & CRTSCTS) {
 745                         modem_ctl[0] &= ~0x7B;
 746                         modem_ctl[0] |= 0x09;
 747                         modem_ctl[1] = 0x80;
 748                         dbg("%s - flow control = CRTSCTS", __func__);
 749                 } else {
 750                         modem_ctl[0] &= ~0x7B;
 751                         modem_ctl[0] |= 0x01;
 752                         modem_ctl[1] |= 0x40;
 753                         dbg("%s - flow control = NONE", __func__);
 754                 }
 755
 756                 dbg("%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
 757                                 __func__, modem_ctl[0], modem_ctl[1],
 758                                 modem_ctl[2], modem_ctl[3]);
 759                 cp210x_set_config(port, CP210X_SET_FLOW, modem_ctl, 16);
 760         }
 761
 762 }
 763
 764 static int cp210x_tiocmset (struct tty_struct *tty,
 765                 unsigned int set, unsigned int clear)
 766 {
 767         struct usb_serial_port *port = tty->driver_data;
 768         return cp210x_tiocmset_port(port, set, clear);
 769 }
 770
 771 static int cp210x_tiocmset_port(struct usb_serial_port *port,
 772                 unsigned int set, unsigned int clear)
 773 {
 774         unsigned int control = 0;
 775
 776         dbg("%s - port %d", __func__, port->number);
 777
 778         if (set & TIOCM_RTS) {
 779                 control |= CONTROL_RTS;
 780                 control |= CONTROL_WRITE_RTS;
 781         }
 782         if (set & TIOCM_DTR) {
 783                 control |= CONTROL_DTR;
 784                 control |= CONTROL_WRITE_DTR;
 785         }
 786         if (clear & TIOCM_RTS) {
 787                 control &= ~CONTROL_RTS;
 788                 control |= CONTROL_WRITE_RTS;
 789         }
 790         if (clear & TIOCM_DTR) {
 791                 control &= ~CONTROL_DTR;
 792                 control |= CONTROL_WRITE_DTR;
 793         }
 794
 795         dbg("%s - control = 0x%.4x", __func__, control);
 796
 797         return cp210x_set_config(port, CP210X_SET_MHS, &control, 2);
 798 }
 799
 800 static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
 801 {
 802         if (on)
 803                 cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
 804         else
 805                 cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
 806 }
 807
 808 static int cp210x_tiocmget (struct tty_struct *tty)
 809 {
 810         struct usb_serial_port *port = tty->driver_data;
 811         unsigned int control;
 812         int result;
 813
 814         dbg("%s - port %d", __func__, port->number);
 815
 816         cp210x_get_config(port, CP210X_GET_MDMSTS, &control, 1);
 817
 818         result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
 819                 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
 820                 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
 821                 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
 822                 |((control & CONTROL_RING)? TIOCM_RI  : 0)
 823                 |((control & CONTROL_DCD) ? TIOCM_CD  : 0);
 824
 825         dbg("%s - control = 0x%.2x", __func__, control);
 826
 827         return result;
 828 }
 829
 830 static void cp210x_break_ctl (struct tty_struct *tty, int break_state)
 831 {
 832         struct usb_serial_port *port = tty->driver_data;
 833         unsigned int state;
 834
 835         dbg("%s - port %d", __func__, port->number);
 836         if (break_state == 0)
 837                 state = BREAK_OFF;
 838         else
 839                 state = BREAK_ON;
 840         dbg("%s - turning break %s", __func__,
 841                         state == BREAK_OFF ? "off" : "on");
 842         cp210x_set_config(port, CP210X_SET_BREAK, &state, 2);
 843 }
 844
 845 static int cp210x_startup(struct usb_serial *serial)
 846 {
 847         /* cp210x buffers behave strangely unless device is reset */
 848         usb_reset_device(serial->dev);
 849         return 0;
 850 }
 851
 852 static int __init cp210x_init(void)
 853 {
 854         int retval;
 855
 856         retval = usb_serial_register(&cp210x_device);
 857         if (retval)
 858                 return retval; /* Failed to register */
 859
 860         retval = usb_register(&cp210x_driver);
 861         if (retval) {
 862                 /* Failed to register */
 863                 usb_serial_deregister(&cp210x_device);
 864                 return retval;
 865         }
 866
 867         /* Success */
 868         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
 869                DRIVER_DESC "\n");
 870         return 0;
 871 }
 872
 873 static void __exit cp210x_exit(void)
 874 {
 875         usb_deregister(&cp210x_driver);
 876         usb_serial_deregister(&cp210x_device);
 877 }
 878
 879 module_init(cp210x_init);
 880 module_exit(cp210x_exit);
 881
 882 MODULE_DESCRIPTION(DRIVER_DESC);
 883 MODULE_VERSION(DRIVER_VERSION);
 884 MODULE_LICENSE("GPL");
 885
 886 module_param(debug, bool, S_IRUGO | S_IWUSR);
 887 MODULE_PARM_DESC(debug, "Enable verbose debugging messages");