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