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