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, 0xEA60) }, /* Silicon Labs factory default */
 132         { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
 133         { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
 134         { USB_DEVICE(0x10C4, 0xEA80) }, /* Silicon Labs factory default */
 135         { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
 136         { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
 137         { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
 138         { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
 139         { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
 140         { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
 141         { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
 142         { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
 143         { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
 144         { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
 145         { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
 146         { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
 147         { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
 148         { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
 149         { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
 150         { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
 151         { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
 152         { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
 153         { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
 154         { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
 155         { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
 156         { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
 157         { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
 158         { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
 159         { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
 160         { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
 161         { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
 162         { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
 163         { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
 164         { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
 165         { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
 166         { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
 167         { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
 168         { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
 169         { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
 170         { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
 171         { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
 172         { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
 173         { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
 174         { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
 175         { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
 176         { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
 177         { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
 178         { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
 179         { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
 180         { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
 181         { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
 182         { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
 183         { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
 184         { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
 185         { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
 186         { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
 187         { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
 188         { } /* Terminating Entry */
 189 };
 190
 191 MODULE_DEVICE_TABLE(usb, id_table);
 192
 193 struct cp210x_port_private {
 194         __u8                    bInterfaceNumber;
 195 };
 196
 197 static struct usb_driver cp210x_driver = {
 198         .name           = "cp210x",
 199         .probe          = usb_serial_probe,
 200         .disconnect     = usb_serial_disconnect,
 201         .id_table       = id_table,
 202         .no_dynamic_id  =       1,
 203 };
 204
 205 static struct usb_serial_driver cp210x_device = {
 206         .driver = {
 207                 .owner =        THIS_MODULE,
 208                 .name =         "cp210x",
 209         },
 210         .usb_driver             = &cp210x_driver,
 211         .id_table               = id_table,
 212         .num_ports              = 1,
 213         .bulk_in_size           = 256,
 214         .bulk_out_size          = 256,
 215         .open                   = cp210x_open,
 216         .close                  = cp210x_close,
 217         .break_ctl              = cp210x_break_ctl,
 218         .set_termios            = cp210x_set_termios,
 219         .tiocmget               = cp210x_tiocmget,
 220         .tiocmset               = cp210x_tiocmset,
 221         .attach                 = cp210x_startup,
 222         .release                = cp210x_release,
 223         .dtr_rts                = cp210x_dtr_rts
 224 };
 225
 226 /* Config request types */
 227 #define REQTYPE_HOST_TO_DEVICE  0x41
 228 #define REQTYPE_DEVICE_TO_HOST  0xc1
 229
 230 /* Config request codes */
 231 #define CP210X_IFC_ENABLE       0x00
 232 #define CP210X_SET_BAUDDIV      0x01
 233 #define CP210X_GET_BAUDDIV      0x02
 234 #define CP210X_SET_LINE_CTL     0x03
 235 #define CP210X_GET_LINE_CTL     0x04
 236 #define CP210X_SET_BREAK        0x05
 237 #define CP210X_IMM_CHAR         0x06
 238 #define CP210X_SET_MHS          0x07
 239 #define CP210X_GET_MDMSTS       0x08
 240 #define CP210X_SET_XON          0x09
 241 #define CP210X_SET_XOFF         0x0A
 242 #define CP210X_SET_EVENTMASK    0x0B
 243 #define CP210X_GET_EVENTMASK    0x0C
 244 #define CP210X_SET_CHAR         0x0D
 245 #define CP210X_GET_CHARS        0x0E
 246 #define CP210X_GET_PROPS        0x0F
 247 #define CP210X_GET_COMM_STATUS  0x10
 248 #define CP210X_RESET            0x11
 249 #define CP210X_PURGE            0x12
 250 #define CP210X_SET_FLOW         0x13
 251 #define CP210X_GET_FLOW         0x14
 252 #define CP210X_EMBED_EVENTS     0x15
 253 #define CP210X_GET_EVENTSTATE   0x16
 254 #define CP210X_SET_CHARS        0x19
 255 #define CP210X_GET_BAUDRATE     0x1D
 256 #define CP210X_SET_BAUDRATE     0x1E
 257
 258 /* CP210X_IFC_ENABLE */
 259 #define UART_ENABLE             0x0001
 260 #define UART_DISABLE            0x0000
 261
 262 /* CP210X_(SET|GET)_BAUDDIV */
 263 #define BAUD_RATE_GEN_FREQ      0x384000
 264
 265 /* CP210X_(SET|GET)_LINE_CTL */
 266 #define BITS_DATA_MASK          0X0f00
 267 #define BITS_DATA_5             0X0500
 268 #define BITS_DATA_6             0X0600
 269 #define BITS_DATA_7             0X0700
 270 #define BITS_DATA_8             0X0800
 271 #define BITS_DATA_9             0X0900
 272
 273 #define BITS_PARITY_MASK        0x00f0
 274 #define BITS_PARITY_NONE        0x0000
 275 #define BITS_PARITY_ODD         0x0010
 276 #define BITS_PARITY_EVEN        0x0020
 277 #define BITS_PARITY_MARK        0x0030
 278 #define BITS_PARITY_SPACE       0x0040
 279
 280 #define BITS_STOP_MASK          0x000f
 281 #define BITS_STOP_1             0x0000
 282 #define BITS_STOP_1_5           0x0001
 283 #define BITS_STOP_2             0x0002
 284
 285 /* CP210X_SET_BREAK */
 286 #define BREAK_ON                0x0001
 287 #define BREAK_OFF               0x0000
 288
 289 /* CP210X_(SET_MHS|GET_MDMSTS) */
 290 #define CONTROL_DTR             0x0001
 291 #define CONTROL_RTS             0x0002
 292 #define CONTROL_CTS             0x0010
 293 #define CONTROL_DSR             0x0020
 294 #define CONTROL_RING            0x0040
 295 #define CONTROL_DCD             0x0080
 296 #define CONTROL_WRITE_DTR       0x0100
 297 #define CONTROL_WRITE_RTS       0x0200
 298
 299 /*
 300  * cp210x_get_config
 301  * Reads from the CP210x configuration registers
 302  * 'size' is specified in bytes.
 303  * 'data' is a pointer to a pre-allocated array of integers large
 304  * enough to hold 'size' bytes (with 4 bytes to each integer)
 305  */
 306 static int cp210x_get_config(struct usb_serial_port *port, u8 request,
 307                 unsigned int *data, int size)
 308 {
 309         struct usb_serial *serial = port->serial;
 310         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 311         __le32 *buf;
 312         int result, i, length;
 313
 314         /* Number of integers required to contain the array */
 315         length = (((size - 1) | 3) + 1)/4;
 316
 317         buf = kcalloc(length, sizeof(__le32), GFP_KERNEL);
 318         if (!buf) {
 319                 dev_err(&port->dev, "%s - out of memory.\n", __func__);
 320                 return -ENOMEM;
 321         }
 322
 323         /* Issue the request, attempting to read 'size' bytes */
 324         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 325                                 request, REQTYPE_DEVICE_TO_HOST, 0x0000,
 326                                 port_priv->bInterfaceNumber, buf, size,
 327                                 USB_CTRL_GET_TIMEOUT);
 328
 329         /* Convert data into an array of integers */
 330         for (i = 0; i < length; i++)
 331                 data[i] = le32_to_cpu(buf[i]);
 332
 333         kfree(buf);
 334
 335         if (result != size) {
 336                 dbg("%s - Unable to send config request, "
 337                                 "request=0x%x size=%d result=%d\n",
 338                                 __func__, request, size, result);
 339                 return -EPROTO;
 340         }
 341
 342         return 0;
 343 }
 344
 345 /*
 346  * cp210x_set_config
 347  * Writes to the CP210x configuration registers
 348  * Values less than 16 bits wide are sent directly
 349  * 'size' is specified in bytes.
 350  */
 351 static int cp210x_set_config(struct usb_serial_port *port, u8 request,
 352                 unsigned int *data, int size)
 353 {
 354         struct usb_serial *serial = port->serial;
 355         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 356         __le32 *buf;
 357         int result, i, length;
 358
 359         /* Number of integers required to contain the array */
 360         length = (((size - 1) | 3) + 1)/4;
 361
 362         buf = kmalloc(length * sizeof(__le32), GFP_KERNEL);
 363         if (!buf) {
 364                 dev_err(&port->dev, "%s - out of memory.\n",
 365                                 __func__);
 366                 return -ENOMEM;
 367         }
 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_DEVICE, 0x0000,
 377                                 port_priv->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_DEVICE, data[0],
 383                                 port_priv->bInterfaceNumber, NULL, 0,
 384                                 USB_CTRL_SET_TIMEOUT);
 385         }
 386
 387         kfree(buf);
 388
 389         if ((size > 2 && result != size) || result < 0) {
 390                 dbg("%s - Unable to send request, "
 391                                 "request=0x%x size=%d result=%d\n",
 392                                 __func__, request, size, result);
 393                 return -EPROTO;
 394         }
 395
 396         return 0;
 397 }
 398
 399 /*
 400  * cp210x_set_config_single
 401  * Convenience function for calling cp210x_set_config on single data values
 402  * without requiring an integer pointer
 403  */
 404 static inline int cp210x_set_config_single(struct usb_serial_port *port,
 405                 u8 request, unsigned int data)
 406 {
 407         return cp210x_set_config(port, request, &data, 2);
 408 }
 409
 410 /*
 411  * cp210x_quantise_baudrate
 412  * Quantises the baud rate as per AN205 Table 1
 413  */
 414 static unsigned int cp210x_quantise_baudrate(unsigned int baud) {
 415         if (baud <= 300)
 416                 baud = 300;
 417         else if (baud <= 600)      baud = 600;
 418         else if (baud <= 1200)     baud = 1200;
 419         else if (baud <= 1800)     baud = 1800;
 420         else if (baud <= 2400)     baud = 2400;
 421         else if (baud <= 4000)     baud = 4000;
 422         else if (baud <= 4803)     baud = 4800;
 423         else if (baud <= 7207)     baud = 7200;
 424         else if (baud <= 9612)     baud = 9600;
 425         else if (baud <= 14428)    baud = 14400;
 426         else if (baud <= 16062)    baud = 16000;
 427         else if (baud <= 19250)    baud = 19200;
 428         else if (baud <= 28912)    baud = 28800;
 429         else if (baud <= 38601)    baud = 38400;
 430         else if (baud <= 51558)    baud = 51200;
 431         else if (baud <= 56280)    baud = 56000;
 432         else if (baud <= 58053)    baud = 57600;
 433         else if (baud <= 64111)    baud = 64000;
 434         else if (baud <= 77608)    baud = 76800;
 435         else if (baud <= 117028)   baud = 115200;
 436         else if (baud <= 129347)   baud = 128000;
 437         else if (baud <= 156868)   baud = 153600;
 438         else if (baud <= 237832)   baud = 230400;
 439         else if (baud <= 254234)   baud = 250000;
 440         else if (baud <= 273066)   baud = 256000;
 441         else if (baud <= 491520)   baud = 460800;
 442         else if (baud <= 567138)   baud = 500000;
 443         else if (baud <= 670254)   baud = 576000;
 444         else if (baud < 1000000)
 445                 baud = 921600;
 446         else if (baud > 2000000)
 447                 baud = 2000000;
 448         return baud;
 449 }
 450
 451 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
 452 {
 453         dbg("%s - port %d", __func__, port->number);
 454
 455         if (cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_ENABLE)) {
 456                 dev_err(&port->dev, "%s - Unable to enable UART\n",
 457                                 __func__);
 458                 return -EPROTO;
 459         }
 460
 461         /* Configure the termios structure */
 462         cp210x_get_termios(tty, port);
 463
 464         /* The baud rate must be initialised on cp2104 */
 465         if (tty)
 466                 cp210x_change_speed(tty, port, NULL);
 467
 468         return usb_serial_generic_open(tty, port);
 469 }
 470
 471 static void cp210x_close(struct usb_serial_port *port)
 472 {
 473         dbg("%s - port %d", __func__, port->number);
 474
 475         usb_serial_generic_close(port);
 476
 477         mutex_lock(&port->serial->disc_mutex);
 478         if (!port->serial->disconnected)
 479                 cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_DISABLE);
 480         mutex_unlock(&port->serial->disc_mutex);
 481 }
 482
 483 /*
 484  * cp210x_get_termios
 485  * Reads the baud rate, data bits, parity, stop bits and flow control mode
 486  * from the device, corrects any unsupported values, and configures the
 487  * termios structure to reflect the state of the device
 488  */
 489 static void cp210x_get_termios(struct tty_struct *tty,
 490         struct usb_serial_port *port)
 491 {
 492         unsigned int baud;
 493
 494         if (tty) {
 495                 cp210x_get_termios_port(tty->driver_data,
 496                         &tty->termios->c_cflag, &baud);
 497                 tty_encode_baud_rate(tty, baud, baud);
 498         }
 499
 500         else {
 501                 unsigned int cflag;
 502                 cflag = 0;
 503                 cp210x_get_termios_port(port, &cflag, &baud);
 504         }
 505 }
 506
 507 /*
 508  * cp210x_get_termios_port
 509  * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
 510  */
 511 static void cp210x_get_termios_port(struct usb_serial_port *port,
 512         unsigned int *cflagp, unsigned int *baudp)
 513 {
 514         unsigned int cflag, modem_ctl[4];
 515         unsigned int baud;
 516         unsigned int bits;
 517
 518         dbg("%s - port %d", __func__, port->number);
 519
 520         cp210x_get_config(port, CP210X_GET_BAUDRATE, &baud, 4);
 521
 522         dbg("%s - baud rate = %d", __func__, baud);
 523         *baudp = baud;
 524
 525         cflag = *cflagp;
 526
 527         cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
 528         cflag &= ~CSIZE;
 529         switch (bits & BITS_DATA_MASK) {
 530         case BITS_DATA_5:
 531                 dbg("%s - data bits = 5", __func__);
 532                 cflag |= CS5;
 533                 break;
 534         case BITS_DATA_6:
 535                 dbg("%s - data bits = 6", __func__);
 536                 cflag |= CS6;
 537                 break;
 538         case BITS_DATA_7:
 539                 dbg("%s - data bits = 7", __func__);
 540                 cflag |= CS7;
 541                 break;
 542         case BITS_DATA_8:
 543                 dbg("%s - data bits = 8", __func__);
 544                 cflag |= CS8;
 545                 break;
 546         case BITS_DATA_9:
 547                 dbg("%s - data bits = 9 (not supported, using 8 data bits)",
 548                                                                 __func__);
 549                 cflag |= CS8;
 550                 bits &= ~BITS_DATA_MASK;
 551                 bits |= BITS_DATA_8;
 552                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 553                 break;
 554         default:
 555                 dbg("%s - Unknown number of data bits, using 8", __func__);
 556                 cflag |= CS8;
 557                 bits &= ~BITS_DATA_MASK;
 558                 bits |= BITS_DATA_8;
 559                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 560                 break;
 561         }
 562
 563         switch (bits & BITS_PARITY_MASK) {
 564         case BITS_PARITY_NONE:
 565                 dbg("%s - parity = NONE", __func__);
 566                 cflag &= ~PARENB;
 567                 break;
 568         case BITS_PARITY_ODD:
 569                 dbg("%s - parity = ODD", __func__);
 570                 cflag |= (PARENB|PARODD);
 571                 break;
 572         case BITS_PARITY_EVEN:
 573                 dbg("%s - parity = EVEN", __func__);
 574                 cflag &= ~PARODD;
 575                 cflag |= PARENB;
 576                 break;
 577         case BITS_PARITY_MARK:
 578                 dbg("%s - parity = MARK (not supported, disabling parity)",
 579                                 __func__);
 580                 cflag &= ~PARENB;
 581                 bits &= ~BITS_PARITY_MASK;
 582                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 583                 break;
 584         case BITS_PARITY_SPACE:
 585                 dbg("%s - parity = SPACE (not supported, disabling parity)",
 586                                 __func__);
 587                 cflag &= ~PARENB;
 588                 bits &= ~BITS_PARITY_MASK;
 589                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 590                 break;
 591         default:
 592                 dbg("%s - Unknown parity mode, disabling parity", __func__);
 593                 cflag &= ~PARENB;
 594                 bits &= ~BITS_PARITY_MASK;
 595                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 596                 break;
 597         }
 598
 599         cflag &= ~CSTOPB;
 600         switch (bits & BITS_STOP_MASK) {
 601         case BITS_STOP_1:
 602                 dbg("%s - stop bits = 1", __func__);
 603                 break;
 604         case BITS_STOP_1_5:
 605                 dbg("%s - stop bits = 1.5 (not supported, using 1 stop bit)",
 606                                                                 __func__);
 607                 bits &= ~BITS_STOP_MASK;
 608                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 609                 break;
 610         case BITS_STOP_2:
 611                 dbg("%s - stop bits = 2", __func__);
 612                 cflag |= CSTOPB;
 613                 break;
 614         default:
 615                 dbg("%s - Unknown number of stop bits, using 1 stop bit",
 616                                                                 __func__);
 617                 bits &= ~BITS_STOP_MASK;
 618                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 619                 break;
 620         }
 621
 622         cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
 623         if (modem_ctl[0] & 0x0008) {
 624                 dbg("%s - flow control = CRTSCTS", __func__);
 625                 cflag |= CRTSCTS;
 626         } else {
 627                 dbg("%s - flow control = NONE", __func__);
 628                 cflag &= ~CRTSCTS;
 629         }
 630
 631         *cflagp = cflag;
 632 }
 633
 634 /*
 635  * CP2101 supports the following baud rates:
 636  *
 637  *      300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
 638  *      38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
 639  *
 640  * CP2102 and CP2103 support the following additional rates:
 641  *
 642  *      4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
 643  *      576000
 644  *
 645  * The device will map a requested rate to a supported one, but the result
 646  * of requests for rates greater than 1053257 is undefined (see AN205).
 647  *
 648  * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
 649  * respectively, with an error less than 1%. The actual rates are determined
 650  * by
 651  *
 652  *      div = round(freq / (2 x prescale x request))
 653  *      actual = freq / (2 x prescale x div)
 654  *
 655  * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
 656  * or 1 otherwise.
 657  * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
 658  * otherwise.
 659  */
 660 static void cp210x_change_speed(struct tty_struct *tty,
 661                 struct usb_serial_port *port, struct ktermios *old_termios)
 662 {
 663         u32 baud;
 664
 665         baud = tty->termios->c_ospeed;
 666
 667         /* This maps the requested rate to a rate valid on cp2102 or cp2103,
 668          * or to an arbitrary rate in [1M,2M].
 669          *
 670          * NOTE: B0 is not implemented.
 671          */
 672         baud = cp210x_quantise_baudrate(baud);
 673
 674         dbg("%s - setting baud rate to %u", __func__, baud);
 675         if (cp210x_set_config(port, CP210X_SET_BAUDRATE, &baud,
 676                                                         sizeof(baud))) {
 677                 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
 678                 if (old_termios)
 679                         baud = old_termios->c_ospeed;
 680                 else
 681                         baud = 9600;
 682         }
 683
 684         tty_encode_baud_rate(tty, baud, baud);
 685 }
 686
 687 static void cp210x_set_termios(struct tty_struct *tty,
 688                 struct usb_serial_port *port, struct ktermios *old_termios)
 689 {
 690         unsigned int cflag, old_cflag;
 691         unsigned int bits;
 692         unsigned int modem_ctl[4];
 693
 694         dbg("%s - port %d", __func__, port->number);
 695
 696         if (!tty)
 697                 return;
 698
 699         tty->termios->c_cflag &= ~CMSPAR;
 700         cflag = tty->termios->c_cflag;
 701         old_cflag = old_termios->c_cflag;
 702
 703         if (tty->termios->c_ospeed != old_termios->c_ospeed)
 704                 cp210x_change_speed(tty, port, old_termios);
 705
 706         /* If the number of data bits is to be updated */
 707         if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
 708                 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
 709                 bits &= ~BITS_DATA_MASK;
 710                 switch (cflag & CSIZE) {
 711                 case CS5:
 712                         bits |= BITS_DATA_5;
 713                         dbg("%s - data bits = 5", __func__);
 714                         break;
 715                 case CS6:
 716                         bits |= BITS_DATA_6;
 717                         dbg("%s - data bits = 6", __func__);
 718                         break;
 719                 case CS7:
 720                         bits |= BITS_DATA_7;
 721                         dbg("%s - data bits = 7", __func__);
 722                         break;
 723                 case CS8:
 724                         bits |= BITS_DATA_8;
 725                         dbg("%s - data bits = 8", __func__);
 726                         break;
 727                 /*case CS9:
 728                         bits |= BITS_DATA_9;
 729                         dbg("%s - data bits = 9", __func__);
 730                         break;*/
 731                 default:
 732                         dbg("cp210x driver does not "
 733                                         "support the number of bits requested,"
 734                                         " using 8 bit mode\n");
 735                                 bits |= BITS_DATA_8;
 736                                 break;
 737                 }
 738                 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
 739                         dbg("Number of data bits requested "
 740                                         "not supported by device\n");
 741         }
 742
 743         if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))) {
 744                 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
 745                 bits &= ~BITS_PARITY_MASK;
 746                 if (cflag & PARENB) {
 747                         if (cflag & PARODD) {
 748                                 bits |= BITS_PARITY_ODD;
 749                                 dbg("%s - parity = ODD", __func__);
 750                         } else {
 751                                 bits |= BITS_PARITY_EVEN;
 752                                 dbg("%s - parity = EVEN", __func__);
 753                         }
 754                 }
 755                 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
 756                         dbg("Parity mode not supported "
 757                                         "by device\n");
 758         }
 759
 760         if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
 761                 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
 762                 bits &= ~BITS_STOP_MASK;
 763                 if (cflag & CSTOPB) {
 764                         bits |= BITS_STOP_2;
 765                         dbg("%s - stop bits = 2", __func__);
 766                 } else {
 767                         bits |= BITS_STOP_1;
 768                         dbg("%s - stop bits = 1", __func__);
 769                 }
 770                 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
 771                         dbg("Number of stop bits requested "
 772                                         "not supported by device\n");
 773         }
 774
 775         if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
 776                 cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
 777                 dbg("%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
 778                                 __func__, modem_ctl[0], modem_ctl[1],
 779                                 modem_ctl[2], modem_ctl[3]);
 780
 781                 if (cflag & CRTSCTS) {
 782                         modem_ctl[0] &= ~0x7B;
 783                         modem_ctl[0] |= 0x09;
 784                         modem_ctl[1] = 0x80;
 785                         dbg("%s - flow control = CRTSCTS", __func__);
 786                 } else {
 787                         modem_ctl[0] &= ~0x7B;
 788                         modem_ctl[0] |= 0x01;
 789                         modem_ctl[1] |= 0x40;
 790                         dbg("%s - flow control = NONE", __func__);
 791                 }
 792
 793                 dbg("%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
 794                                 __func__, modem_ctl[0], modem_ctl[1],
 795                                 modem_ctl[2], modem_ctl[3]);
 796                 cp210x_set_config(port, CP210X_SET_FLOW, modem_ctl, 16);
 797         }
 798
 799 }
 800
 801 static int cp210x_tiocmset (struct tty_struct *tty,
 802                 unsigned int set, unsigned int clear)
 803 {
 804         struct usb_serial_port *port = tty->driver_data;
 805         return cp210x_tiocmset_port(port, set, clear);
 806 }
 807
 808 static int cp210x_tiocmset_port(struct usb_serial_port *port,
 809                 unsigned int set, unsigned int clear)
 810 {
 811         unsigned int control = 0;
 812
 813         dbg("%s - port %d", __func__, port->number);
 814
 815         if (set & TIOCM_RTS) {
 816                 control |= CONTROL_RTS;
 817                 control |= CONTROL_WRITE_RTS;
 818         }
 819         if (set & TIOCM_DTR) {
 820                 control |= CONTROL_DTR;
 821                 control |= CONTROL_WRITE_DTR;
 822         }
 823         if (clear & TIOCM_RTS) {
 824                 control &= ~CONTROL_RTS;
 825                 control |= CONTROL_WRITE_RTS;
 826         }
 827         if (clear & TIOCM_DTR) {
 828                 control &= ~CONTROL_DTR;
 829                 control |= CONTROL_WRITE_DTR;
 830         }
 831
 832         dbg("%s - control = 0x%.4x", __func__, control);
 833
 834         return cp210x_set_config(port, CP210X_SET_MHS, &control, 2);
 835 }
 836
 837 static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
 838 {
 839         if (on)
 840                 cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
 841         else
 842                 cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
 843 }
 844
 845 static int cp210x_tiocmget (struct tty_struct *tty)
 846 {
 847         struct usb_serial_port *port = tty->driver_data;
 848         unsigned int control;
 849         int result;
 850
 851         dbg("%s - port %d", __func__, port->number);
 852
 853         cp210x_get_config(port, CP210X_GET_MDMSTS, &control, 1);
 854
 855         result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
 856                 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
 857                 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
 858                 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
 859                 |((control & CONTROL_RING)? TIOCM_RI  : 0)
 860                 |((control & CONTROL_DCD) ? TIOCM_CD  : 0);
 861
 862         dbg("%s - control = 0x%.2x", __func__, control);
 863
 864         return result;
 865 }
 866
 867 static void cp210x_break_ctl (struct tty_struct *tty, int break_state)
 868 {
 869         struct usb_serial_port *port = tty->driver_data;
 870         unsigned int state;
 871
 872         dbg("%s - port %d", __func__, port->number);
 873         if (break_state == 0)
 874                 state = BREAK_OFF;
 875         else
 876                 state = BREAK_ON;
 877         dbg("%s - turning break %s", __func__,
 878                         state == BREAK_OFF ? "off" : "on");
 879         cp210x_set_config(port, CP210X_SET_BREAK, &state, 2);
 880 }
 881
 882 static int cp210x_startup(struct usb_serial *serial)
 883 {
 884         struct cp210x_port_private *port_priv;
 885         int i;
 886
 887         /* cp210x buffers behave strangely unless device is reset */
 888         usb_reset_device(serial->dev);
 889
 890         for (i = 0; i < serial->num_ports; i++) {
 891                 port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
 892                 if (!port_priv)
 893                         return -ENOMEM;
 894
 895                 memset(port_priv, 0x00, sizeof(*port_priv));
 896                 port_priv->bInterfaceNumber =
 897                     serial->interface->cur_altsetting->desc.bInterfaceNumber;
 898
 899                 usb_set_serial_port_data(serial->port[i], port_priv);
 900         }
 901
 902         return 0;
 903 }
 904
 905 static void cp210x_release(struct usb_serial *serial)
 906 {
 907         struct cp210x_port_private *port_priv;
 908         int i;
 909
 910         for (i = 0; i < serial->num_ports; i++) {
 911                 port_priv = usb_get_serial_port_data(serial->port[i]);
 912                 kfree(port_priv);
 913                 usb_set_serial_port_data(serial->port[i], NULL);
 914         }
 915 }
 916
 917 static int __init cp210x_init(void)
 918 {
 919         int retval;
 920
 921         retval = usb_serial_register(&cp210x_device);
 922         if (retval)
 923                 return retval; /* Failed to register */
 924
 925         retval = usb_register(&cp210x_driver);
 926         if (retval) {
 927                 /* Failed to register */
 928                 usb_serial_deregister(&cp210x_device);
 929                 return retval;
 930         }
 931
 932         /* Success */
 933         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
 934                DRIVER_DESC "\n");
 935         return 0;
 936 }
 937
 938 static void __exit cp210x_exit(void)
 939 {
 940         usb_deregister(&cp210x_driver);
 941         usb_serial_deregister(&cp210x_device);
 942 }
 943
 944 module_init(cp210x_init);
 945 module_exit(cp210x_exit);
 946
 947 MODULE_DESCRIPTION(DRIVER_DESC);
 948 MODULE_VERSION(DRIVER_VERSION);
 949 MODULE_LICENSE("GPL");
 950
 951 module_param(debug, bool, S_IRUGO | S_IWUSR);
 952 MODULE_PARM_DESC(debug, "Enable verbose debugging messages");