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