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