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