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