drivers/usb/serial/cp210x.c

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