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