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(0x0908, 0x01FF) }, /* Siemens RUGGEDCOM USB Serial Console */
  60         { USB_DEVICE(0x0BED, 0x1100) }, /* MEI (TM) Cashflow-SC Bill/Voucher Acceptor */
  61         { USB_DEVICE(0x0BED, 0x1101) }, /* MEI series 2000 Combo Acceptor */
  62         { USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
  63         { USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
  64         { USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */
  65         { USB_DEVICE(0x0FDE, 0xCA05) }, /* OWL Wireless Electricity Monitor CM-160 */
  66         { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
  67         { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
  68         { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
  69         { USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */
  70         { USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */
  71         { USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */
  72         { USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
  73         { USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
  74         { USB_DEVICE(0x10C4, 0x8044) }, /* Cygnal Debug Adapter */
  75         { USB_DEVICE(0x10C4, 0x804E) }, /* Software Bisque Paramount ME build-in converter */
  76         { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
  77         { USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */
  78         { USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
  79         { USB_DEVICE(0x10C4, 0x806F) }, /* IMS USB to RS422 Converter Cable */
  80         { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
  81         { USB_DEVICE(0x10C4, 0x80C4) }, /* Cygnal Integrated Products, Inc., Optris infrared thermometer */
  82         { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
  83         { USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
  84         { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
  85         { USB_DEVICE(0x10C4, 0x8115) }, /* Arygon NFC/Mifare Reader */
  86         { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
  87         { USB_DEVICE(0x10C4, 0x813F) }, /* Tams Master Easy Control */
  88         { USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
  89         { USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
  90         { USB_DEVICE(0x2405, 0x0003) }, /* West Mountain Radio RIGblaster Advantage */
  91         { USB_DEVICE(0x10C4, 0x8156) }, /* B&G H3000 link cable */
  92         { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
  93         { USB_DEVICE(0x10C4, 0x815F) }, /* Timewave HamLinkUSB */
  94         { USB_DEVICE(0x10C4, 0x818B) }, /* AVIT Research USB to TTL */
  95         { USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
  96         { USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
  97         { USB_DEVICE(0x10C4, 0x81A9) }, /* Multiplex RC Interface */
  98         { USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
  99         { USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */
 100         { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
 101         { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
 102         { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
 103         { USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
 104         { USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
 105         { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
 106         { USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
 107         { USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
 108         { USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */
 109         { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
 110         { USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
 111         { USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
 112         { USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
 113         { USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
 114         { USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
 115         { USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
 116         { USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
 117         { USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
 118         { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
 119         { USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
 120         { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
 121         { USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
 122         { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
 123         { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
 124         { USB_DEVICE(0x10C4, 0x8856) }, /* CEL EM357 ZigBee USB Stick - LR */
 125         { USB_DEVICE(0x10C4, 0x8857) }, /* CEL EM357 ZigBee USB Stick */
 126         { USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
 127         { USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
 128         { USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
 129         { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit 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(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
 162         { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
 163         { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
 164         { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
 165         { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
 166         { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
 167         { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
 168         { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
 169         { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
 170         { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
 171         { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
 172         { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
 173         { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
 174         { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
 175         { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
 176         { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
 177         { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
 178         { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
 179         { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
 180         { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
 181         { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
 182         { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
 183         { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
 184         { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
 185         { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
 186         { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
 187         { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
 188         { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
 189         { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
 190         { } /* Terminating Entry */
 191 };
 192
 193 MODULE_DEVICE_TABLE(usb, id_table);
 194
 195 struct cp210x_serial_private {
 196         __u8                    bInterfaceNumber;
 197 };
 198
 199 static struct usb_serial_driver cp210x_device = {
 200         .driver = {
 201                 .owner =        THIS_MODULE,
 202                 .name =         "cp210x",
 203         },
 204         .id_table               = id_table,
 205         .num_ports              = 1,
 206         .bulk_in_size           = 256,
 207         .bulk_out_size          = 256,
 208         .open                   = cp210x_open,
 209         .close                  = cp210x_close,
 210         .break_ctl              = cp210x_break_ctl,
 211         .set_termios            = cp210x_set_termios,
 212         .tiocmget               = cp210x_tiocmget,
 213         .tiocmset               = cp210x_tiocmset,
 214         .attach                 = cp210x_startup,
 215         .release                = cp210x_release,
 216         .dtr_rts                = cp210x_dtr_rts
 217 };
 218
 219 static struct usb_serial_driver * const serial_drivers[] = {
 220         &cp210x_device, NULL
 221 };
 222
 223 /* Config request types */
 224 #define REQTYPE_HOST_TO_INTERFACE       0x41
 225 #define REQTYPE_INTERFACE_TO_HOST       0xc1
 226 #define REQTYPE_HOST_TO_DEVICE  0x40
 227 #define REQTYPE_DEVICE_TO_HOST  0xc0
 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_serial_private *spriv = usb_get_serial_data(serial);
 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                 return -ENOMEM;
 319
 320         /* Issue the request, attempting to read 'size' bytes */
 321         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 322                                 request, REQTYPE_INTERFACE_TO_HOST, 0x0000,
 323                                 spriv->bInterfaceNumber, buf, size,
 324                                 USB_CTRL_GET_TIMEOUT);
 325
 326         /* Convert data into an array of integers */
 327         for (i = 0; i < length; i++)
 328                 data[i] = le32_to_cpu(buf[i]);
 329
 330         kfree(buf);
 331
 332         if (result != size) {
 333                 dev_dbg(&port->dev, "%s - Unable to send config request, request=0x%x size=%d result=%d\n",
 334                         __func__, request, size, result);
 335                 if (result > 0)
 336                         result = -EPROTO;
 337
 338                 return result;
 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_serial_private *spriv = usb_get_serial_data(serial);
 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                 return -ENOMEM;
 364
 365         /* Array of integers into bytes */
 366         for (i = 0; i < length; i++)
 367                 buf[i] = cpu_to_le32(data[i]);
 368
 369         if (size > 2) {
 370                 result = usb_control_msg(serial->dev,
 371                                 usb_sndctrlpipe(serial->dev, 0),
 372                                 request, REQTYPE_HOST_TO_INTERFACE, 0x0000,
 373                                 spriv->bInterfaceNumber, buf, size,
 374                                 USB_CTRL_SET_TIMEOUT);
 375         } else {
 376                 result = usb_control_msg(serial->dev,
 377                                 usb_sndctrlpipe(serial->dev, 0),
 378                                 request, REQTYPE_HOST_TO_INTERFACE, data[0],
 379                                 spriv->bInterfaceNumber, NULL, 0,
 380                                 USB_CTRL_SET_TIMEOUT);
 381         }
 382
 383         kfree(buf);
 384
 385         if ((size > 2 && result != size) || result < 0) {
 386                 dev_dbg(&port->dev, "%s - Unable to send request, request=0x%x size=%d result=%d\n",
 387                         __func__, request, size, result);
 388                 if (result > 0)
 389                         result = -EPROTO;
 390
 391                 return result;
 392         }
 393
 394         return 0;
 395 }
 396
 397 /*
 398  * cp210x_set_config_single
 399  * Convenience function for calling cp210x_set_config on single data values
 400  * without requiring an integer pointer
 401  */
 402 static inline int cp210x_set_config_single(struct usb_serial_port *port,
 403                 u8 request, unsigned int data)
 404 {
 405         return cp210x_set_config(port, request, &data, 2);
 406 }
 407
 408 /*
 409  * cp210x_quantise_baudrate
 410  * Quantises the baud rate as per AN205 Table 1
 411  */
 412 static unsigned int cp210x_quantise_baudrate(unsigned int baud)
 413 {
 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         int result;
 453
 454         result = cp210x_set_config_single(port, CP210X_IFC_ENABLE,
 455                                                                 UART_ENABLE);
 456         if (result) {
 457                 dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
 458                 return result;
 459         }
 460
 461         /* Configure the termios structure */
 462         cp210x_get_termios(tty, port);
 463
 464         /* The baud rate must be initialised on cp2104 */
 465         if (tty)
 466                 cp210x_change_speed(tty, port, NULL);
 467
 468         return usb_serial_generic_open(tty, port);
 469 }
 470
 471 static void cp210x_close(struct usb_serial_port *port)
 472 {
 473         usb_serial_generic_close(port);
 474         cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_DISABLE);
 475 }
 476
 477 /*
 478  * cp210x_get_termios
 479  * Reads the baud rate, data bits, parity, stop bits and flow control mode
 480  * from the device, corrects any unsupported values, and configures the
 481  * termios structure to reflect the state of the device
 482  */
 483 static void cp210x_get_termios(struct tty_struct *tty,
 484         struct usb_serial_port *port)
 485 {
 486         unsigned int baud;
 487
 488         if (tty) {
 489                 cp210x_get_termios_port(tty->driver_data,
 490                         &tty->termios.c_cflag, &baud);
 491                 tty_encode_baud_rate(tty, baud, baud);
 492         } else {
 493                 unsigned int cflag;
 494                 cflag = 0;
 495                 cp210x_get_termios_port(port, &cflag, &baud);
 496         }
 497 }
 498
 499 /*
 500  * cp210x_get_termios_port
 501  * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
 502  */
 503 static void cp210x_get_termios_port(struct usb_serial_port *port,
 504         unsigned int *cflagp, unsigned int *baudp)
 505 {
 506         struct device *dev = &port->dev;
 507         unsigned int cflag, modem_ctl[4];
 508         unsigned int baud;
 509         unsigned int bits;
 510
 511         cp210x_get_config(port, CP210X_GET_BAUDRATE, &baud, 4);
 512
 513         dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud);
 514         *baudp = baud;
 515
 516         cflag = *cflagp;
 517
 518         cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
 519         cflag &= ~CSIZE;
 520         switch (bits & BITS_DATA_MASK) {
 521         case BITS_DATA_5:
 522                 dev_dbg(dev, "%s - data bits = 5\n", __func__);
 523                 cflag |= CS5;
 524                 break;
 525         case BITS_DATA_6:
 526                 dev_dbg(dev, "%s - data bits = 6\n", __func__);
 527                 cflag |= CS6;
 528                 break;
 529         case BITS_DATA_7:
 530                 dev_dbg(dev, "%s - data bits = 7\n", __func__);
 531                 cflag |= CS7;
 532                 break;
 533         case BITS_DATA_8:
 534                 dev_dbg(dev, "%s - data bits = 8\n", __func__);
 535                 cflag |= CS8;
 536                 break;
 537         case BITS_DATA_9:
 538                 dev_dbg(dev, "%s - data bits = 9 (not supported, using 8 data bits)\n", __func__);
 539                 cflag |= CS8;
 540                 bits &= ~BITS_DATA_MASK;
 541                 bits |= BITS_DATA_8;
 542                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 543                 break;
 544         default:
 545                 dev_dbg(dev, "%s - Unknown number of data bits, using 8\n", __func__);
 546                 cflag |= CS8;
 547                 bits &= ~BITS_DATA_MASK;
 548                 bits |= BITS_DATA_8;
 549                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 550                 break;
 551         }
 552
 553         switch (bits & BITS_PARITY_MASK) {
 554         case BITS_PARITY_NONE:
 555                 dev_dbg(dev, "%s - parity = NONE\n", __func__);
 556                 cflag &= ~PARENB;
 557                 break;
 558         case BITS_PARITY_ODD:
 559                 dev_dbg(dev, "%s - parity = ODD\n", __func__);
 560                 cflag |= (PARENB|PARODD);
 561                 break;
 562         case BITS_PARITY_EVEN:
 563                 dev_dbg(dev, "%s - parity = EVEN\n", __func__);
 564                 cflag &= ~PARODD;
 565                 cflag |= PARENB;
 566                 break;
 567         case BITS_PARITY_MARK:
 568                 dev_dbg(dev, "%s - parity = MARK\n", __func__);
 569                 cflag |= (PARENB|PARODD|CMSPAR);
 570                 break;
 571         case BITS_PARITY_SPACE:
 572                 dev_dbg(dev, "%s - parity = SPACE\n", __func__);
 573                 cflag &= ~PARODD;
 574                 cflag |= (PARENB|CMSPAR);
 575                 break;
 576         default:
 577                 dev_dbg(dev, "%s - Unknown parity mode, disabling parity\n", __func__);
 578                 cflag &= ~PARENB;
 579                 bits &= ~BITS_PARITY_MASK;
 580                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 581                 break;
 582         }
 583
 584         cflag &= ~CSTOPB;
 585         switch (bits & BITS_STOP_MASK) {
 586         case BITS_STOP_1:
 587                 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
 588                 break;
 589         case BITS_STOP_1_5:
 590                 dev_dbg(dev, "%s - stop bits = 1.5 (not supported, using 1 stop bit)\n", __func__);
 591                 bits &= ~BITS_STOP_MASK;
 592                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 593                 break;
 594         case BITS_STOP_2:
 595                 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
 596                 cflag |= CSTOPB;
 597                 break;
 598         default:
 599                 dev_dbg(dev, "%s - Unknown number of stop bits, using 1 stop bit\n", __func__);
 600                 bits &= ~BITS_STOP_MASK;
 601                 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
 602                 break;
 603         }
 604
 605         cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
 606         if (modem_ctl[0] & 0x0008) {
 607                 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
 608                 cflag |= CRTSCTS;
 609         } else {
 610                 dev_dbg(dev, "%s - flow control = NONE\n", __func__);
 611                 cflag &= ~CRTSCTS;
 612         }
 613
 614         *cflagp = cflag;
 615 }
 616
 617 /*
 618  * CP2101 supports the following baud rates:
 619  *
 620  *      300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
 621  *      38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
 622  *
 623  * CP2102 and CP2103 support the following additional rates:
 624  *
 625  *      4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
 626  *      576000
 627  *
 628  * The device will map a requested rate to a supported one, but the result
 629  * of requests for rates greater than 1053257 is undefined (see AN205).
 630  *
 631  * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
 632  * respectively, with an error less than 1%. The actual rates are determined
 633  * by
 634  *
 635  *      div = round(freq / (2 x prescale x request))
 636  *      actual = freq / (2 x prescale x div)
 637  *
 638  * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
 639  * or 1 otherwise.
 640  * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
 641  * otherwise.
 642  */
 643 static void cp210x_change_speed(struct tty_struct *tty,
 644                 struct usb_serial_port *port, struct ktermios *old_termios)
 645 {
 646         u32 baud;
 647
 648         baud = tty->termios.c_ospeed;
 649
 650         /* This maps the requested rate to a rate valid on cp2102 or cp2103,
 651          * or to an arbitrary rate in [1M,2M].
 652          *
 653          * NOTE: B0 is not implemented.
 654          */
 655         baud = cp210x_quantise_baudrate(baud);
 656
 657         dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
 658         if (cp210x_set_config(port, CP210X_SET_BAUDRATE, &baud,
 659                                                         sizeof(baud))) {
 660                 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
 661                 if (old_termios)
 662                         baud = old_termios->c_ospeed;
 663                 else
 664                         baud = 9600;
 665         }
 666
 667         tty_encode_baud_rate(tty, baud, baud);
 668 }
 669
 670 static void cp210x_set_termios(struct tty_struct *tty,
 671                 struct usb_serial_port *port, struct ktermios *old_termios)
 672 {
 673         struct device *dev = &port->dev;
 674         unsigned int cflag, old_cflag;
 675         unsigned int bits;
 676         unsigned int modem_ctl[4];
 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         spriv = kzalloc(sizeof(*spriv), GFP_KERNEL);
 867         if (!spriv)
 868                 return -ENOMEM;
 869
 870         cur_altsetting = serial->interface->cur_altsetting;
 871         spriv->bInterfaceNumber = cur_altsetting->desc.bInterfaceNumber;
 872
 873         usb_set_serial_data(serial, spriv);
 874
 875         return 0;
 876 }
 877
 878 static void cp210x_release(struct usb_serial *serial)
 879 {
 880         struct cp210x_serial_private *spriv;
 881
 882         spriv = usb_get_serial_data(serial);
 883         kfree(spriv);
 884 }
 885
 886 module_usb_serial_driver(serial_drivers, id_table);
 887
 888 MODULE_DESCRIPTION(DRIVER_DESC);
 889 MODULE_LICENSE("GPL");