drivers/usb/serial/cp210x.c

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