linux/drivers/usb/serial/cp210x.c
<<
>>
Prefs
   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#define DRIVER_DESC "Silicon Labs CP210x RS232 serial adaptor driver"
  28
  29/*
  30 * Function Prototypes
  31 */
  32static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *);
  33static void cp210x_close(struct usb_serial_port *);
  34static void cp210x_get_termios(struct tty_struct *, struct usb_serial_port *);
  35static void cp210x_get_termios_port(struct usb_serial_port *port,
  36        unsigned int *cflagp, unsigned int *baudp);
  37static void cp210x_change_speed(struct tty_struct *, struct usb_serial_port *,
  38                                                        struct ktermios *);
  39static void cp210x_set_termios(struct tty_struct *, struct usb_serial_port *,
  40                                                        struct ktermios*);
  41static int cp210x_tiocmget(struct tty_struct *);
  42static int cp210x_tiocmset(struct tty_struct *, unsigned int, unsigned int);
  43static int cp210x_tiocmset_port(struct usb_serial_port *port,
  44                unsigned int, unsigned int);
  45static void cp210x_break_ctl(struct tty_struct *, int);
  46static int cp210x_startup(struct usb_serial *);
  47static void cp210x_release(struct usb_serial *);
  48static void cp210x_dtr_rts(struct usb_serial_port *p, int on);
  49
  50static const struct usb_device_id id_table[] = {
  51        { USB_DEVICE(0x045B, 0x0053) }, /* Renesas RX610 RX-Stick */
  52        { USB_DEVICE(0x0471, 0x066A) }, /* AKTAKOM ACE-1001 cable */
  53        { USB_DEVICE(0x0489, 0xE000) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
  54        { USB_DEVICE(0x0489, 0xE003) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
  55        { USB_DEVICE(0x0745, 0x1000) }, /* CipherLab USB CCD Barcode Scanner 1000 */
  56        { USB_DEVICE(0x0846, 0x1100) }, /* NetGear Managed Switch M4100 series, M5300 series, M7100 series */
  57        { USB_DEVICE(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
  58        { USB_DEVICE(0x08FD, 0x000A) }, /* Digianswer A/S , ZigBee/802.15.4 MAC Device */
  59        { USB_DEVICE(0x0908, 0x01FF) }, /* Siemens RUGGEDCOM USB Serial Console */
  60        { USB_DEVICE(0x0BED, 0x1100) }, /* MEI (TM) Cashflow-SC Bill/Voucher Acceptor */
  61        { USB_DEVICE(0x0BED, 0x1101) }, /* MEI series 2000 Combo Acceptor */
  62        { USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
  63        { USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
  64        { USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */
  65        { USB_DEVICE(0x0FDE, 0xCA05) }, /* OWL Wireless Electricity Monitor CM-160 */
  66        { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
  67        { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
  68        { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
  69        { USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */
  70        { USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */
  71        { USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */
  72        { USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
  73        { USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
  74        { USB_DEVICE(0x10C4, 0x8044) }, /* Cygnal Debug Adapter */
  75        { USB_DEVICE(0x10C4, 0x804E) }, /* Software Bisque Paramount ME build-in converter */
  76        { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
  77        { USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */
  78        { USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
  79        { USB_DEVICE(0x10C4, 0x806F) }, /* IMS USB to RS422 Converter Cable */
  80        { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
  81        { USB_DEVICE(0x10C4, 0x80C4) }, /* Cygnal Integrated Products, Inc., Optris infrared thermometer */
  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(0x2405, 0x0003) }, /* West Mountain Radio RIGblaster Advantage */
  91        { USB_DEVICE(0x10C4, 0x8156) }, /* B&G H3000 link cable */
  92        { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
  93        { USB_DEVICE(0x10C4, 0x815F) }, /* Timewave HamLinkUSB */
  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, 0x8281) }, /* Nanotec Plug & Drive */
 109        { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
 110        { USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
 111        { USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
 112        { USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
 113        { USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
 114        { USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
 115        { USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
 116        { USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
 117        { USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
 118        { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
 119        { USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
 120        { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
 121        { USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
 122        { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
 123        { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
 124        { USB_DEVICE(0x10C4, 0x8856) }, /* CEL EM357 ZigBee USB Stick - LR */
 125        { USB_DEVICE(0x10C4, 0x8857) }, /* CEL EM357 ZigBee USB Stick */
 126        { USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
 127        { USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
 128        { USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
 129        { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit Device */
 130        { USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
 131        { USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
 132        { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
 133        { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
 134        { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
 135        { USB_DEVICE(0x10C4, 0xEA80) }, /* Silicon Labs factory default */
 136        { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
 137        { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
 138        { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
 139        { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
 140        { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
 141        { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
 142        { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
 143        { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
 144        { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
 145        { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
 146        { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
 147        { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
 148        { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
 149        { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
 150        { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
 151        { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
 152        { USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
 153        { USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
 154        { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
 155        { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
 156        { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
 157        { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
 158        { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
 159        { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
 160        { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
 161        { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
 162        { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
 163        { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
 164        { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
 165        { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
 166        { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
 167        { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
 168        { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
 169        { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
 170        { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
 171        { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
 172        { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
 173        { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
 174        { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
 175        { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
 176        { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
 177        { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
 178        { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
 179        { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
 180        { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
 181        { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
 182        { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
 183        { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
 184        { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
 185        { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
 186        { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
 187        { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
 188        { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
 189        { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
 190        { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
 191        { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
 192        { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
 193        { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
 194        { } /* Terminating Entry */
 195};
 196
 197MODULE_DEVICE_TABLE(usb, id_table);
 198
 199struct cp210x_serial_private {
 200        __u8                    bInterfaceNumber;
 201};
 202
 203static struct usb_serial_driver cp210x_device = {
 204        .driver = {
 205                .owner =        THIS_MODULE,
 206                .name =         "cp210x",
 207        },
 208        .id_table               = id_table,
 209        .num_ports              = 1,
 210        .bulk_in_size           = 256,
 211        .bulk_out_size          = 256,
 212        .open                   = cp210x_open,
 213        .close                  = cp210x_close,
 214        .break_ctl              = cp210x_break_ctl,
 215        .set_termios            = cp210x_set_termios,
 216        .tiocmget               = cp210x_tiocmget,
 217        .tiocmset               = cp210x_tiocmset,
 218        .attach                 = cp210x_startup,
 219        .release                = cp210x_release,
 220        .dtr_rts                = cp210x_dtr_rts
 221};
 222
 223static struct usb_serial_driver * const serial_drivers[] = {
 224        &cp210x_device, NULL
 225};
 226
 227/* Config request types */
 228#define REQTYPE_HOST_TO_INTERFACE       0x41
 229#define REQTYPE_INTERFACE_TO_HOST       0xc1
 230#define REQTYPE_HOST_TO_DEVICE  0x40
 231#define REQTYPE_DEVICE_TO_HOST  0xc0
 232
 233/* Config request codes */
 234#define CP210X_IFC_ENABLE       0x00
 235#define CP210X_SET_BAUDDIV      0x01
 236#define CP210X_GET_BAUDDIV      0x02
 237#define CP210X_SET_LINE_CTL     0x03
 238#define CP210X_GET_LINE_CTL     0x04
 239#define CP210X_SET_BREAK        0x05
 240#define CP210X_IMM_CHAR         0x06
 241#define CP210X_SET_MHS          0x07
 242#define CP210X_GET_MDMSTS       0x08
 243#define CP210X_SET_XON          0x09
 244#define CP210X_SET_XOFF         0x0A
 245#define CP210X_SET_EVENTMASK    0x0B
 246#define CP210X_GET_EVENTMASK    0x0C
 247#define CP210X_SET_CHAR         0x0D
 248#define CP210X_GET_CHARS        0x0E
 249#define CP210X_GET_PROPS        0x0F
 250#define CP210X_GET_COMM_STATUS  0x10
 251#define CP210X_RESET            0x11
 252#define CP210X_PURGE            0x12
 253#define CP210X_SET_FLOW         0x13
 254#define CP210X_GET_FLOW         0x14
 255#define CP210X_EMBED_EVENTS     0x15
 256#define CP210X_GET_EVENTSTATE   0x16
 257#define CP210X_SET_CHARS        0x19
 258#define CP210X_GET_BAUDRATE     0x1D
 259#define CP210X_SET_BAUDRATE     0x1E
 260
 261/* CP210X_IFC_ENABLE */
 262#define UART_ENABLE             0x0001
 263#define UART_DISABLE            0x0000
 264
 265/* CP210X_(SET|GET)_BAUDDIV */
 266#define BAUD_RATE_GEN_FREQ      0x384000
 267
 268/* CP210X_(SET|GET)_LINE_CTL */
 269#define BITS_DATA_MASK          0X0f00
 270#define BITS_DATA_5             0X0500
 271#define BITS_DATA_6             0X0600
 272#define BITS_DATA_7             0X0700
 273#define BITS_DATA_8             0X0800
 274#define BITS_DATA_9             0X0900
 275
 276#define BITS_PARITY_MASK        0x00f0
 277#define BITS_PARITY_NONE        0x0000
 278#define BITS_PARITY_ODD         0x0010
 279#define BITS_PARITY_EVEN        0x0020
 280#define BITS_PARITY_MARK        0x0030
 281#define BITS_PARITY_SPACE       0x0040
 282
 283#define BITS_STOP_MASK          0x000f
 284#define BITS_STOP_1             0x0000
 285#define BITS_STOP_1_5           0x0001
 286#define BITS_STOP_2             0x0002
 287
 288/* CP210X_SET_BREAK */
 289#define BREAK_ON                0x0001
 290#define BREAK_OFF               0x0000
 291
 292/* CP210X_(SET_MHS|GET_MDMSTS) */
 293#define CONTROL_DTR             0x0001
 294#define CONTROL_RTS             0x0002
 295#define CONTROL_CTS             0x0010
 296#define CONTROL_DSR             0x0020
 297#define CONTROL_RING            0x0040
 298#define CONTROL_DCD             0x0080
 299#define CONTROL_WRITE_DTR       0x0100
 300#define CONTROL_WRITE_RTS       0x0200
 301
 302/*
 303 * cp210x_get_config
 304 * Reads from the CP210x configuration registers
 305 * 'size' is specified in bytes.
 306 * 'data' is a pointer to a pre-allocated array of integers large
 307 * enough to hold 'size' bytes (with 4 bytes to each integer)
 308 */
 309static int cp210x_get_config(struct usb_serial_port *port, u8 request,
 310                unsigned int *data, int size)
 311{
 312        struct usb_serial *serial = port->serial;
 313        struct cp210x_serial_private *spriv = usb_get_serial_data(serial);
 314        __le32 *buf;
 315        int result, i, length;
 316
 317        /* Number of integers required to contain the array */
 318        length = (((size - 1) | 3) + 1) / 4;
 319
 320        buf = kcalloc(length, sizeof(__le32), GFP_KERNEL);
 321        if (!buf)
 322                return -ENOMEM;
 323
 324        /* Issue the request, attempting to read 'size' bytes */
 325        result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 326                                request, REQTYPE_INTERFACE_TO_HOST, 0x0000,
 327                                spriv->bInterfaceNumber, buf, size,
 328                                USB_CTRL_GET_TIMEOUT);
 329
 330        /* Convert data into an array of integers */
 331        for (i = 0; i < length; i++)
 332                data[i] = le32_to_cpu(buf[i]);
 333
 334        kfree(buf);
 335
 336        if (result != size) {
 337                dev_dbg(&port->dev, "%s - Unable to send config request, request=0x%x size=%d result=%d\n",
 338                        __func__, request, size, result);
 339                if (result > 0)
 340                        result = -EPROTO;
 341
 342                return result;
 343        }
 344
 345        return 0;
 346}
 347
 348/*
 349 * cp210x_set_config
 350 * Writes to the CP210x configuration registers
 351 * Values less than 16 bits wide are sent directly
 352 * 'size' is specified in bytes.
 353 */
 354static int cp210x_set_config(struct usb_serial_port *port, u8 request,
 355                unsigned int *data, int size)
 356{
 357        struct usb_serial *serial = port->serial;
 358        struct cp210x_serial_private *spriv = usb_get_serial_data(serial);
 359        __le32 *buf;
 360        int result, i, length;
 361
 362        /* Number of integers required to contain the array */
 363        length = (((size - 1) | 3) + 1) / 4;
 364
 365        buf = kmalloc(length * sizeof(__le32), GFP_KERNEL);
 366        if (!buf)
 367                return -ENOMEM;
 368
 369        /* Array of integers into bytes */
 370        for (i = 0; i < length; i++)
 371                buf[i] = cpu_to_le32(data[i]);
 372
 373        if (size > 2) {
 374                result = usb_control_msg(serial->dev,
 375                                usb_sndctrlpipe(serial->dev, 0),
 376                                request, REQTYPE_HOST_TO_INTERFACE, 0x0000,
 377                                spriv->bInterfaceNumber, buf, size,
 378                                USB_CTRL_SET_TIMEOUT);
 379        } else {
 380                result = usb_control_msg(serial->dev,
 381                                usb_sndctrlpipe(serial->dev, 0),
 382                                request, REQTYPE_HOST_TO_INTERFACE, data[0],
 383                                spriv->bInterfaceNumber, NULL, 0,
 384                                USB_CTRL_SET_TIMEOUT);
 385        }
 386
 387        kfree(buf);
 388
 389        if ((size > 2 && result != size) || result < 0) {
 390                dev_dbg(&port->dev, "%s - Unable to send request, request=0x%x size=%d result=%d\n",
 391                        __func__, request, size, result);
 392                if (result > 0)
 393                        result = -EPROTO;
 394
 395                return result;
 396        }
 397
 398        return 0;
 399}
 400
 401/*
 402 * cp210x_set_config_single
 403 * Convenience function for calling cp210x_set_config on single data values
 404 * without requiring an integer pointer
 405 */
 406static inline int cp210x_set_config_single(struct usb_serial_port *port,
 407                u8 request, unsigned int data)
 408{
 409        return cp210x_set_config(port, request, &data, 2);
 410}
 411
 412/*
 413 * cp210x_quantise_baudrate
 414 * Quantises the baud rate as per AN205 Table 1
 415 */
 416static unsigned int cp210x_quantise_baudrate(unsigned int baud)
 417{
 418        if (baud <= 300)
 419                baud = 300;
 420        else if (baud <= 600)      baud = 600;
 421        else if (baud <= 1200)     baud = 1200;
 422        else if (baud <= 1800)     baud = 1800;
 423        else if (baud <= 2400)     baud = 2400;
 424        else if (baud <= 4000)     baud = 4000;
 425        else if (baud <= 4803)     baud = 4800;
 426        else if (baud <= 7207)     baud = 7200;
 427        else if (baud <= 9612)     baud = 9600;
 428        else if (baud <= 14428)    baud = 14400;
 429        else if (baud <= 16062)    baud = 16000;
 430        else if (baud <= 19250)    baud = 19200;
 431        else if (baud <= 28912)    baud = 28800;
 432        else if (baud <= 38601)    baud = 38400;
 433        else if (baud <= 51558)    baud = 51200;
 434        else if (baud <= 56280)    baud = 56000;
 435        else if (baud <= 58053)    baud = 57600;
 436        else if (baud <= 64111)    baud = 64000;
 437        else if (baud <= 77608)    baud = 76800;
 438        else if (baud <= 117028)   baud = 115200;
 439        else if (baud <= 129347)   baud = 128000;
 440        else if (baud <= 156868)   baud = 153600;
 441        else if (baud <= 237832)   baud = 230400;
 442        else if (baud <= 254234)   baud = 250000;
 443        else if (baud <= 273066)   baud = 256000;
 444        else if (baud <= 491520)   baud = 460800;
 445        else if (baud <= 567138)   baud = 500000;
 446        else if (baud <= 670254)   baud = 576000;
 447        else if (baud < 1000000)
 448                baud = 921600;
 449        else if (baud > 2000000)
 450                baud = 2000000;
 451        return baud;
 452}
 453
 454static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
 455{
 456        int result;
 457
 458        result = cp210x_set_config_single(port, CP210X_IFC_ENABLE,
 459                                                                UART_ENABLE);
 460        if (result) {
 461                dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
 462                return result;
 463        }
 464
 465        /* Configure the termios structure */
 466        cp210x_get_termios(tty, port);
 467
 468        /* The baud rate must be initialised on cp2104 */
 469        if (tty)
 470                cp210x_change_speed(tty, port, NULL);
 471
 472        return usb_serial_generic_open(tty, port);
 473}
 474
 475static void cp210x_close(struct usb_serial_port *port)
 476{
 477        usb_serial_generic_close(port);
 478        cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_DISABLE);
 479}
 480
 481/*
 482 * cp210x_get_termios
 483 * Reads the baud rate, data bits, parity, stop bits and flow control mode
 484 * from the device, corrects any unsupported values, and configures the
 485 * termios structure to reflect the state of the device
 486 */
 487static void cp210x_get_termios(struct tty_struct *tty,
 488        struct usb_serial_port *port)
 489{
 490        unsigned int baud;
 491
 492        if (tty) {
 493                cp210x_get_termios_port(tty->driver_data,
 494                        &tty->termios.c_cflag, &baud);
 495                tty_encode_baud_rate(tty, baud, baud);
 496        } else {
 497                unsigned int cflag;
 498                cflag = 0;
 499                cp210x_get_termios_port(port, &cflag, &baud);
 500        }
 501}
 502
 503/*
 504 * cp210x_get_termios_port
 505 * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
 506 */
 507static void cp210x_get_termios_port(struct usb_serial_port *port,
 508        unsigned int *cflagp, unsigned int *baudp)
 509{
 510        struct device *dev = &port->dev;
 511        unsigned int cflag, modem_ctl[4];
 512        unsigned int baud;
 513        unsigned int bits;
 514
 515        cp210x_get_config(port, CP210X_GET_BAUDRATE, &baud, 4);
 516
 517        dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud);
 518        *baudp = baud;
 519
 520        cflag = *cflagp;
 521
 522        cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
 523        cflag &= ~CSIZE;
 524        switch (bits & BITS_DATA_MASK) {
 525        case BITS_DATA_5:
 526                dev_dbg(dev, "%s - data bits = 5\n", __func__);
 527                cflag |= CS5;
 528                break;
 529        case BITS_DATA_6:
 530                dev_dbg(dev, "%s - data bits = 6\n", __func__);
 531                cflag |= CS6;
 532                break;
 533        case BITS_DATA_7:
 534                dev_dbg(dev, "%s - data bits = 7\n", __func__);
 535                cflag |= CS7;
 536                break;
 537        case BITS_DATA_8:
 538                dev_dbg(dev, "%s - data bits = 8\n", __func__);
 539                cflag |= CS8;
 540                break;
 541        case BITS_DATA_9:
 542                dev_dbg(dev, "%s - data bits = 9 (not supported, using 8 data bits)\n", __func__);
 543                cflag |= CS8;
 544                bits &= ~BITS_DATA_MASK;
 545                bits |= BITS_DATA_8;
 546                cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 547                break;
 548        default:
 549                dev_dbg(dev, "%s - Unknown number of data bits, using 8\n", __func__);
 550                cflag |= CS8;
 551                bits &= ~BITS_DATA_MASK;
 552                bits |= BITS_DATA_8;
 553                cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 554                break;
 555        }
 556
 557        switch (bits & BITS_PARITY_MASK) {
 558        case BITS_PARITY_NONE:
 559                dev_dbg(dev, "%s - parity = NONE\n", __func__);
 560                cflag &= ~PARENB;
 561                break;
 562        case BITS_PARITY_ODD:
 563                dev_dbg(dev, "%s - parity = ODD\n", __func__);
 564                cflag |= (PARENB|PARODD);
 565                break;
 566        case BITS_PARITY_EVEN:
 567                dev_dbg(dev, "%s - parity = EVEN\n", __func__);
 568                cflag &= ~PARODD;
 569                cflag |= PARENB;
 570                break;
 571        case BITS_PARITY_MARK:
 572                dev_dbg(dev, "%s - parity = MARK\n", __func__);
 573                cflag |= (PARENB|PARODD|CMSPAR);
 574                break;
 575        case BITS_PARITY_SPACE:
 576                dev_dbg(dev, "%s - parity = SPACE\n", __func__);
 577                cflag &= ~PARODD;
 578                cflag |= (PARENB|CMSPAR);
 579                break;
 580        default:
 581                dev_dbg(dev, "%s - Unknown parity mode, disabling parity\n", __func__);
 582                cflag &= ~PARENB;
 583                bits &= ~BITS_PARITY_MASK;
 584                cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 585                break;
 586        }
 587
 588        cflag &= ~CSTOPB;
 589        switch (bits & BITS_STOP_MASK) {
 590        case BITS_STOP_1:
 591                dev_dbg(dev, "%s - stop bits = 1\n", __func__);
 592                break;
 593        case BITS_STOP_1_5:
 594                dev_dbg(dev, "%s - stop bits = 1.5 (not supported, using 1 stop bit)\n", __func__);
 595                bits &= ~BITS_STOP_MASK;
 596                cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 597                break;
 598        case BITS_STOP_2:
 599                dev_dbg(dev, "%s - stop bits = 2\n", __func__);
 600                cflag |= CSTOPB;
 601                break;
 602        default:
 603                dev_dbg(dev, "%s - Unknown number of stop bits, using 1 stop bit\n", __func__);
 604                bits &= ~BITS_STOP_MASK;
 605                cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 606                break;
 607        }
 608
 609        cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
 610        if (modem_ctl[0] & 0x0008) {
 611                dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
 612                cflag |= CRTSCTS;
 613        } else {
 614                dev_dbg(dev, "%s - flow control = NONE\n", __func__);
 615                cflag &= ~CRTSCTS;
 616        }
 617
 618        *cflagp = cflag;
 619}
 620
 621/*
 622 * CP2101 supports the following baud rates:
 623 *
 624 *      300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
 625 *      38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
 626 *
 627 * CP2102 and CP2103 support the following additional rates:
 628 *
 629 *      4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
 630 *      576000
 631 *
 632 * The device will map a requested rate to a supported one, but the result
 633 * of requests for rates greater than 1053257 is undefined (see AN205).
 634 *
 635 * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
 636 * respectively, with an error less than 1%. The actual rates are determined
 637 * by
 638 *
 639 *      div = round(freq / (2 x prescale x request))
 640 *      actual = freq / (2 x prescale x div)
 641 *
 642 * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
 643 * or 1 otherwise.
 644 * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
 645 * otherwise.
 646 */
 647static void cp210x_change_speed(struct tty_struct *tty,
 648                struct usb_serial_port *port, struct ktermios *old_termios)
 649{
 650        u32 baud;
 651
 652        baud = tty->termios.c_ospeed;
 653
 654        /* This maps the requested rate to a rate valid on cp2102 or cp2103,
 655         * or to an arbitrary rate in [1M,2M].
 656         *
 657         * NOTE: B0 is not implemented.
 658         */
 659        baud = cp210x_quantise_baudrate(baud);
 660
 661        dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
 662        if (cp210x_set_config(port, CP210X_SET_BAUDRATE, &baud,
 663                                                        sizeof(baud))) {
 664                dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
 665                if (old_termios)
 666                        baud = old_termios->c_ospeed;
 667                else
 668                        baud = 9600;
 669        }
 670
 671        tty_encode_baud_rate(tty, baud, baud);
 672}
 673
 674static void cp210x_set_termios(struct tty_struct *tty,
 675                struct usb_serial_port *port, struct ktermios *old_termios)
 676{
 677        struct device *dev = &port->dev;
 678        unsigned int cflag, old_cflag;
 679        unsigned int bits;
 680        unsigned int modem_ctl[4];
 681
 682        cflag = tty->termios.c_cflag;
 683        old_cflag = old_termios->c_cflag;
 684
 685        if (tty->termios.c_ospeed != old_termios->c_ospeed)
 686                cp210x_change_speed(tty, port, old_termios);
 687
 688        /* If the number of data bits is to be updated */
 689        if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
 690                cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
 691                bits &= ~BITS_DATA_MASK;
 692                switch (cflag & CSIZE) {
 693                case CS5:
 694                        bits |= BITS_DATA_5;
 695                        dev_dbg(dev, "%s - data bits = 5\n", __func__);
 696                        break;
 697                case CS6:
 698                        bits |= BITS_DATA_6;
 699                        dev_dbg(dev, "%s - data bits = 6\n", __func__);
 700                        break;
 701                case CS7:
 702                        bits |= BITS_DATA_7;
 703                        dev_dbg(dev, "%s - data bits = 7\n", __func__);
 704                        break;
 705                case CS8:
 706                        bits |= BITS_DATA_8;
 707                        dev_dbg(dev, "%s - data bits = 8\n", __func__);
 708                        break;
 709                /*case CS9:
 710                        bits |= BITS_DATA_9;
 711                        dev_dbg(dev, "%s - data bits = 9\n", __func__);
 712                        break;*/
 713                default:
 714                        dev_dbg(dev, "cp210x driver does not support the number of bits requested, using 8 bit mode\n");
 715                        bits |= BITS_DATA_8;
 716                        break;
 717                }
 718                if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
 719                        dev_dbg(dev, "Number of data bits requested not supported by device\n");
 720        }
 721
 722        if ((cflag     & (PARENB|PARODD|CMSPAR)) !=
 723            (old_cflag & (PARENB|PARODD|CMSPAR))) {
 724                cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
 725                bits &= ~BITS_PARITY_MASK;
 726                if (cflag & PARENB) {
 727                        if (cflag & CMSPAR) {
 728                                if (cflag & PARODD) {
 729                                        bits |= BITS_PARITY_MARK;
 730                                        dev_dbg(dev, "%s - parity = MARK\n", __func__);
 731                                } else {
 732                                        bits |= BITS_PARITY_SPACE;
 733                                        dev_dbg(dev, "%s - parity = SPACE\n", __func__);
 734                                }
 735                        } else {
 736                                if (cflag & PARODD) {
 737                                        bits |= BITS_PARITY_ODD;
 738                                        dev_dbg(dev, "%s - parity = ODD\n", __func__);
 739                                } else {
 740                                        bits |= BITS_PARITY_EVEN;
 741                                        dev_dbg(dev, "%s - parity = EVEN\n", __func__);
 742                                }
 743                        }
 744                }
 745                if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
 746                        dev_dbg(dev, "Parity mode not supported by device\n");
 747        }
 748
 749        if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
 750                cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
 751                bits &= ~BITS_STOP_MASK;
 752                if (cflag & CSTOPB) {
 753                        bits |= BITS_STOP_2;
 754                        dev_dbg(dev, "%s - stop bits = 2\n", __func__);
 755                } else {
 756                        bits |= BITS_STOP_1;
 757                        dev_dbg(dev, "%s - stop bits = 1\n", __func__);
 758                }
 759                if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
 760                        dev_dbg(dev, "Number of stop bits requested not supported by device\n");
 761        }
 762
 763        if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
 764                cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
 765                dev_dbg(dev, "%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x\n",
 766                        __func__, modem_ctl[0], modem_ctl[1],
 767                        modem_ctl[2], modem_ctl[3]);
 768
 769                if (cflag & CRTSCTS) {
 770                        modem_ctl[0] &= ~0x7B;
 771                        modem_ctl[0] |= 0x09;
 772                        modem_ctl[1] = 0x80;
 773                        dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
 774                } else {
 775                        modem_ctl[0] &= ~0x7B;
 776                        modem_ctl[0] |= 0x01;
 777                        modem_ctl[1] |= 0x40;
 778                        dev_dbg(dev, "%s - flow control = NONE\n", __func__);
 779                }
 780
 781                dev_dbg(dev, "%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x\n",
 782                        __func__, modem_ctl[0], modem_ctl[1],
 783                        modem_ctl[2], modem_ctl[3]);
 784                cp210x_set_config(port, CP210X_SET_FLOW, modem_ctl, 16);
 785        }
 786
 787}
 788
 789static int cp210x_tiocmset(struct tty_struct *tty,
 790                unsigned int set, unsigned int clear)
 791{
 792        struct usb_serial_port *port = tty->driver_data;
 793        return cp210x_tiocmset_port(port, set, clear);
 794}
 795
 796static int cp210x_tiocmset_port(struct usb_serial_port *port,
 797                unsigned int set, unsigned int clear)
 798{
 799        unsigned int control = 0;
 800
 801        if (set & TIOCM_RTS) {
 802                control |= CONTROL_RTS;
 803                control |= CONTROL_WRITE_RTS;
 804        }
 805        if (set & TIOCM_DTR) {
 806                control |= CONTROL_DTR;
 807                control |= CONTROL_WRITE_DTR;
 808        }
 809        if (clear & TIOCM_RTS) {
 810                control &= ~CONTROL_RTS;
 811                control |= CONTROL_WRITE_RTS;
 812        }
 813        if (clear & TIOCM_DTR) {
 814                control &= ~CONTROL_DTR;
 815                control |= CONTROL_WRITE_DTR;
 816        }
 817
 818        dev_dbg(&port->dev, "%s - control = 0x%.4x\n", __func__, control);
 819
 820        return cp210x_set_config(port, CP210X_SET_MHS, &control, 2);
 821}
 822
 823static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
 824{
 825        if (on)
 826                cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
 827        else
 828                cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
 829}
 830
 831static int cp210x_tiocmget(struct tty_struct *tty)
 832{
 833        struct usb_serial_port *port = tty->driver_data;
 834        unsigned int control;
 835        int result;
 836
 837        cp210x_get_config(port, CP210X_GET_MDMSTS, &control, 1);
 838
 839        result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
 840                |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
 841                |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
 842                |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
 843                |((control & CONTROL_RING)? TIOCM_RI  : 0)
 844                |((control & CONTROL_DCD) ? TIOCM_CD  : 0);
 845
 846        dev_dbg(&port->dev, "%s - control = 0x%.2x\n", __func__, control);
 847
 848        return result;
 849}
 850
 851static void cp210x_break_ctl(struct tty_struct *tty, int break_state)
 852{
 853        struct usb_serial_port *port = tty->driver_data;
 854        unsigned int state;
 855
 856        if (break_state == 0)
 857                state = BREAK_OFF;
 858        else
 859                state = BREAK_ON;
 860        dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
 861                state == BREAK_OFF ? "off" : "on");
 862        cp210x_set_config(port, CP210X_SET_BREAK, &state, 2);
 863}
 864
 865static int cp210x_startup(struct usb_serial *serial)
 866{
 867        struct usb_host_interface *cur_altsetting;
 868        struct cp210x_serial_private *spriv;
 869
 870        spriv = kzalloc(sizeof(*spriv), GFP_KERNEL);
 871        if (!spriv)
 872                return -ENOMEM;
 873
 874        cur_altsetting = serial->interface->cur_altsetting;
 875        spriv->bInterfaceNumber = cur_altsetting->desc.bInterfaceNumber;
 876
 877        usb_set_serial_data(serial, spriv);
 878
 879        return 0;
 880}
 881
 882static void cp210x_release(struct usb_serial *serial)
 883{
 884        struct cp210x_serial_private *spriv;
 885
 886        spriv = usb_get_serial_data(serial);
 887        kfree(spriv);
 888}
 889
 890module_usb_serial_driver(serial_drivers, id_table);
 891
 892MODULE_DESCRIPTION(DRIVER_DESC);
 893MODULE_LICENSE("GPL");
 894