drivers/usb/serial/cp210x.c

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