drivers/usb/serial/cp210x.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Silicon Laboratories CP210x USB to RS232 serial adaptor driver
   4  *
   5  * Copyright (C) 2005 Craig Shelley (craig@microtron.org.uk)
   6  *
   7  * Support to set flow control line levels using TIOCMGET and TIOCMSET
   8  * thanks to Karl Hiramoto karl@hiramoto.org. RTSCTS hardware flow
   9  * control thanks to Munir Nassar nassarmu@real-time.com
  10  *
  11  */
  12
  13 #include <linux/kernel.h>
  14 #include <linux/errno.h>
  15 #include <linux/slab.h>
  16 #include <linux/tty.h>
  17 #include <linux/tty_flip.h>
  18 #include <linux/module.h>
  19 #include <linux/moduleparam.h>
  20 #include <linux/usb.h>
  21 #include <linux/uaccess.h>
  22 #include <linux/usb/serial.h>
  23 #include <linux/gpio/driver.h>
  24 #include <linux/bitops.h>
  25 #include <linux/mutex.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         tcflag_t *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 bool cp210x_tx_empty(struct usb_serial_port *port);
  42 static int cp210x_tiocmget(struct tty_struct *);
  43 static int cp210x_tiocmset(struct tty_struct *, unsigned int, unsigned int);
  44 static int cp210x_tiocmset_port(struct usb_serial_port *port,
  45                 unsigned int, unsigned int);
  46 static void cp210x_break_ctl(struct tty_struct *, int);
  47 static int cp210x_attach(struct usb_serial *);
  48 static void cp210x_disconnect(struct usb_serial *);
  49 static void cp210x_release(struct usb_serial *);
  50 static int cp210x_port_probe(struct usb_serial_port *);
  51 static int cp210x_port_remove(struct usb_serial_port *);
  52 static void cp210x_dtr_rts(struct usb_serial_port *p, int on);
  53
  54 static const struct usb_device_id id_table[] = {
  55         { USB_DEVICE(0x0404, 0x034C) }, /* NCR Retail IO Box */
  56         { USB_DEVICE(0x045B, 0x0053) }, /* Renesas RX610 RX-Stick */
  57         { USB_DEVICE(0x0471, 0x066A) }, /* AKTAKOM ACE-1001 cable */
  58         { USB_DEVICE(0x0489, 0xE000) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
  59         { USB_DEVICE(0x0489, 0xE003) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
  60         { USB_DEVICE(0x0745, 0x1000) }, /* CipherLab USB CCD Barcode Scanner 1000 */
  61         { USB_DEVICE(0x0846, 0x1100) }, /* NetGear Managed Switch M4100 series, M5300 series, M7100 series */
  62         { USB_DEVICE(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
  63         { USB_DEVICE(0x08FD, 0x000A) }, /* Digianswer A/S , ZigBee/802.15.4 MAC Device */
  64         { USB_DEVICE(0x0908, 0x01FF) }, /* Siemens RUGGEDCOM USB Serial Console */
  65         { USB_DEVICE(0x0988, 0x0578) }, /* Teraoka AD2000 */
  66         { USB_DEVICE(0x0B00, 0x3070) }, /* Ingenico 3070 */
  67         { USB_DEVICE(0x0BED, 0x1100) }, /* MEI (TM) Cashflow-SC Bill/Voucher Acceptor */
  68         { USB_DEVICE(0x0BED, 0x1101) }, /* MEI series 2000 Combo Acceptor */
  69         { USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
  70         { USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
  71         { USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */
  72         { USB_DEVICE(0x0FDE, 0xCA05) }, /* OWL Wireless Electricity Monitor CM-160 */
  73         { USB_DEVICE(0x106F, 0x0003) }, /* CPI / Money Controls Bulk Coin Recycler */
  74         { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
  75         { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
  76         { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
  77         { USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */
  78         { USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */
  79         { USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */
  80         { USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
  81         { USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
  82         { USB_DEVICE(0x10C4, 0x8044) }, /* Cygnal Debug Adapter */
  83         { USB_DEVICE(0x10C4, 0x804E) }, /* Software Bisque Paramount ME build-in converter */
  84         { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
  85         { USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */
  86         { USB_DEVICE(0x10C4, 0x8056) }, /* Lorenz Messtechnik devices */
  87         { USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
  88         { USB_DEVICE(0x10C4, 0x806F) }, /* IMS USB to RS422 Converter Cable */
  89         { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
  90         { USB_DEVICE(0x10C4, 0x80C4) }, /* Cygnal Integrated Products, Inc., Optris infrared thermometer */
  91         { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
  92         { USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
  93         { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
  94         { USB_DEVICE(0x10C4, 0x8115) }, /* Arygon NFC/Mifare Reader */
  95         { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
  96         { USB_DEVICE(0x10C4, 0x813F) }, /* Tams Master Easy Control */
  97         { USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
  98         { USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
  99         { USB_DEVICE(0x2405, 0x0003) }, /* West Mountain Radio RIGblaster Advantage */
 100         { USB_DEVICE(0x10C4, 0x8156) }, /* B&G H3000 link cable */
 101         { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
 102         { USB_DEVICE(0x10C4, 0x815F) }, /* Timewave HamLinkUSB */
 103         { USB_DEVICE(0x10C4, 0x817C) }, /* CESINEL MEDCAL N Power Quality Monitor */
 104         { USB_DEVICE(0x10C4, 0x817D) }, /* CESINEL MEDCAL NT Power Quality Monitor */
 105         { USB_DEVICE(0x10C4, 0x817E) }, /* CESINEL MEDCAL S Power Quality Monitor */
 106         { USB_DEVICE(0x10C4, 0x818B) }, /* AVIT Research USB to TTL */
 107         { USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
 108         { USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
 109         { USB_DEVICE(0x10C4, 0x81A9) }, /* Multiplex RC Interface */
 110         { USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
 111         { USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */
 112         { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
 113         { USB_DEVICE(0x10C4, 0x81D7) }, /* IAI Corp. RCB-CV-USB USB to RS485 Adaptor */
 114         { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
 115         { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
 116         { USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */
 117         { USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
 118         { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
 119         { USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
 120         { USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */
 121         { USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */
 122         { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */
 123         { USB_DEVICE(0x10C4, 0x82EF) }, /* CESINEL FALCO 6105 AC Power Supply */
 124         { USB_DEVICE(0x10C4, 0x82F1) }, /* CESINEL MEDCAL EFD Earth Fault Detector */
 125         { USB_DEVICE(0x10C4, 0x82F2) }, /* CESINEL MEDCAL ST Network Analyzer */
 126         { USB_DEVICE(0x10C4, 0x82F4) }, /* Starizona MicroTouch */
 127         { USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
 128         { USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
 129         { USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
 130         { USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
 131         { USB_DEVICE(0x10C4, 0x83AA) }, /* Mark-10 Digital Force Gauge */
 132         { USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */
 133         { USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
 134         { USB_DEVICE(0x10C4, 0x8414) }, /* Decagon USB Cable Adapter */
 135         { USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */
 136         { USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
 137         { USB_DEVICE(0x10C4, 0x8470) }, /* Juniper Networks BX Series System Console */
 138         { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */
 139         { USB_DEVICE(0x10C4, 0x84B6) }, /* Starizona Hyperion */
 140         { USB_DEVICE(0x10C4, 0x851E) }, /* CESINEL MEDCAL PT Network Analyzer */
 141         { USB_DEVICE(0x10C4, 0x85A7) }, /* LifeScan OneTouch Verio IQ */
 142         { USB_DEVICE(0x10C4, 0x85B8) }, /* CESINEL ReCon T Energy Logger */
 143         { USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */
 144         { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */
 145         { USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */
 146         { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */
 147         { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */
 148         { USB_DEVICE(0x10C4, 0x8856) }, /* CEL EM357 ZigBee USB Stick - LR */
 149         { USB_DEVICE(0x10C4, 0x8857) }, /* CEL EM357 ZigBee USB Stick */
 150         { USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */
 151         { USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */
 152         { USB_DEVICE(0x10C4, 0x88D8) }, /* Acuity Brands nLight Air Adapter */
 153         { USB_DEVICE(0x10C4, 0x88FB) }, /* CESINEL MEDCAL STII Network Analyzer */
 154         { USB_DEVICE(0x10C4, 0x8938) }, /* CESINEL MEDCAL S II Network Analyzer */
 155         { USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */
 156         { USB_DEVICE(0x10C4, 0x8962) }, /* Brim Brothers charging dock */
 157         { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit Device */
 158         { USB_DEVICE(0x10C4, 0x8998) }, /* KCF Technologies PRN */
 159         { USB_DEVICE(0x10C4, 0x89A4) }, /* CESINEL FTBC Flexible Thyristor Bridge Controller */
 160         { USB_DEVICE(0x10C4, 0x89FB) }, /* Qivicon ZigBee USB Radio Stick */
 161         { USB_DEVICE(0x10C4, 0x8A2A) }, /* HubZ dual ZigBee and Z-Wave dongle */
 162         { USB_DEVICE(0x10C4, 0x8A5B) }, /* CEL EM3588 ZigBee USB Stick */
 163         { USB_DEVICE(0x10C4, 0x8A5E) }, /* CEL EM3588 ZigBee USB Stick Long Range */
 164         { USB_DEVICE(0x10C4, 0x8B34) }, /* Qivicon ZigBee USB Radio Stick */
 165         { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
 166         { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
 167         { USB_DEVICE(0x10C4, 0xEA63) }, /* Silicon Labs Windows Update (CP2101-4/CP2102N) */
 168         { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */
 169         { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */
 170         { USB_DEVICE(0x10C4, 0xEA7A) }, /* Silicon Labs Windows Update (CP2105) */
 171         { USB_DEVICE(0x10C4, 0xEA7B) }, /* Silicon Labs Windows Update (CP2108) */
 172         { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
 173         { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
 174         { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
 175         { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
 176         { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
 177         { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
 178         { USB_DEVICE(0x12B8, 0xEC60) }, /* Link G4 ECU */
 179         { USB_DEVICE(0x12B8, 0xEC62) }, /* Link G4+ ECU */
 180         { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
 181         { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
 182         { USB_DEVICE(0x155A, 0x1006) }, /* ELDAT Easywave RX09 */
 183         { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */
 184         { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */
 185         { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
 186         { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */
 187         { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */
 188         { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */
 189         { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */
 190         { USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */
 191         { USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */
 192         { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
 193         { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */
 194         { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */
 195         { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */
 196         { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */
 197         { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */
 198         { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */
 199         { USB_DEVICE(0x17A8, 0x0101) }, /* Kamstrup 868 MHz wM-Bus C-Mode Meter Reader (Int Ant) */
 200         { USB_DEVICE(0x17A8, 0x0102) }, /* Kamstrup 868 MHz wM-Bus C-Mode Meter Reader (Ext Ant) */
 201         { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
 202         { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
 203         { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
 204         { USB_DEVICE(0x18EF, 0xE025) }, /* ELV Marble Sound Board 1 */
 205         { USB_DEVICE(0x18EF, 0xE030) }, /* ELV ALC 8xxx Battery Charger */
 206         { USB_DEVICE(0x18EF, 0xE032) }, /* ELV TFD500 Data Logger */
 207         { USB_DEVICE(0x1901, 0x0190) }, /* GE B850 CP2105 Recorder interface */
 208         { USB_DEVICE(0x1901, 0x0193) }, /* GE B650 CP2104 PMC interface */
 209         { USB_DEVICE(0x1901, 0x0194) }, /* GE Healthcare Remote Alarm Box */
 210         { USB_DEVICE(0x1901, 0x0195) }, /* GE B850/B650/B450 CP2104 DP UART interface */
 211         { USB_DEVICE(0x1901, 0x0196) }, /* GE B850 CP2105 DP UART interface */
 212         { USB_DEVICE(0x1901, 0x0197) }, /* GE CS1000 M.2 Key E serial interface */
 213         { USB_DEVICE(0x1901, 0x0198) }, /* GE CS1000 Display serial interface */
 214         { USB_DEVICE(0x199B, 0xBA30) }, /* LORD WSDA-200-USB */
 215         { USB_DEVICE(0x19CF, 0x3000) }, /* Parrot NMEA GPS Flight Recorder */
 216         { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
 217         { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
 218         { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
 219         { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
 220         { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
 221         { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
 222         { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
 223         { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
 224         { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
 225         { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
 226         { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
 227         { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
 228         { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
 229         { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
 230         { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
 231         { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
 232         { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
 233         { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
 234         { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
 235         { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
 236         { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
 237         { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
 238         { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
 239         { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
 240         { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
 241         { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
 242         { USB_DEVICE(0x2184, 0x0030) }, /* GW Instek GDM-834x Digital Multimeter */
 243         { USB_DEVICE(0x2626, 0xEA60) }, /* Aruba Networks 7xxx USB Serial Console */
 244         { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
 245         { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
 246         { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
 247         { USB_DEVICE(0x3923, 0x7A0B) }, /* National Instruments USB Serial Console */
 248         { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
 249         { } /* Terminating Entry */
 250 };
 251
 252 MODULE_DEVICE_TABLE(usb, id_table);
 253
 254 struct cp210x_serial_private {
 255 #ifdef CONFIG_GPIOLIB
 256         struct gpio_chip        gc;
 257         bool                    gpio_registered;
 258         u8                      gpio_pushpull;
 259         u8                      gpio_altfunc;
 260         u8                      gpio_input;
 261 #endif
 262         u8                      partnum;
 263         speed_t                 max_speed;
 264         bool                    use_actual_rate;
 265 };
 266
 267 struct cp210x_port_private {
 268         __u8                    bInterfaceNumber;
 269         bool                    has_swapped_line_ctl;
 270 };
 271
 272 static struct usb_serial_driver cp210x_device = {
 273         .driver = {
 274                 .owner =        THIS_MODULE,
 275                 .name =         "cp210x",
 276         },
 277         .id_table               = id_table,
 278         .num_ports              = 1,
 279         .bulk_in_size           = 256,
 280         .bulk_out_size          = 256,
 281         .open                   = cp210x_open,
 282         .close                  = cp210x_close,
 283         .break_ctl              = cp210x_break_ctl,
 284         .set_termios            = cp210x_set_termios,
 285         .tx_empty               = cp210x_tx_empty,
 286         .throttle               = usb_serial_generic_throttle,
 287         .unthrottle             = usb_serial_generic_unthrottle,
 288         .tiocmget               = cp210x_tiocmget,
 289         .tiocmset               = cp210x_tiocmset,
 290         .attach                 = cp210x_attach,
 291         .disconnect             = cp210x_disconnect,
 292         .release                = cp210x_release,
 293         .port_probe             = cp210x_port_probe,
 294         .port_remove            = cp210x_port_remove,
 295         .dtr_rts                = cp210x_dtr_rts
 296 };
 297
 298 static struct usb_serial_driver * const serial_drivers[] = {
 299         &cp210x_device, NULL
 300 };
 301
 302 /* Config request types */
 303 #define REQTYPE_HOST_TO_INTERFACE       0x41
 304 #define REQTYPE_INTERFACE_TO_HOST       0xc1
 305 #define REQTYPE_HOST_TO_DEVICE  0x40
 306 #define REQTYPE_DEVICE_TO_HOST  0xc0
 307
 308 /* Config request codes */
 309 #define CP210X_IFC_ENABLE       0x00
 310 #define CP210X_SET_BAUDDIV      0x01
 311 #define CP210X_GET_BAUDDIV      0x02
 312 #define CP210X_SET_LINE_CTL     0x03
 313 #define CP210X_GET_LINE_CTL     0x04
 314 #define CP210X_SET_BREAK        0x05
 315 #define CP210X_IMM_CHAR         0x06
 316 #define CP210X_SET_MHS          0x07
 317 #define CP210X_GET_MDMSTS       0x08
 318 #define CP210X_SET_XON          0x09
 319 #define CP210X_SET_XOFF         0x0A
 320 #define CP210X_SET_EVENTMASK    0x0B
 321 #define CP210X_GET_EVENTMASK    0x0C
 322 #define CP210X_SET_CHAR         0x0D
 323 #define CP210X_GET_CHARS        0x0E
 324 #define CP210X_GET_PROPS        0x0F
 325 #define CP210X_GET_COMM_STATUS  0x10
 326 #define CP210X_RESET            0x11
 327 #define CP210X_PURGE            0x12
 328 #define CP210X_SET_FLOW         0x13
 329 #define CP210X_GET_FLOW         0x14
 330 #define CP210X_EMBED_EVENTS     0x15
 331 #define CP210X_GET_EVENTSTATE   0x16
 332 #define CP210X_SET_CHARS        0x19
 333 #define CP210X_GET_BAUDRATE     0x1D
 334 #define CP210X_SET_BAUDRATE     0x1E
 335 #define CP210X_VENDOR_SPECIFIC  0xFF
 336
 337 /* CP210X_IFC_ENABLE */
 338 #define UART_ENABLE             0x0001
 339 #define UART_DISABLE            0x0000
 340
 341 /* CP210X_(SET|GET)_BAUDDIV */
 342 #define BAUD_RATE_GEN_FREQ      0x384000
 343
 344 /* CP210X_(SET|GET)_LINE_CTL */
 345 #define BITS_DATA_MASK          0X0f00
 346 #define BITS_DATA_5             0X0500
 347 #define BITS_DATA_6             0X0600
 348 #define BITS_DATA_7             0X0700
 349 #define BITS_DATA_8             0X0800
 350 #define BITS_DATA_9             0X0900
 351
 352 #define BITS_PARITY_MASK        0x00f0
 353 #define BITS_PARITY_NONE        0x0000
 354 #define BITS_PARITY_ODD         0x0010
 355 #define BITS_PARITY_EVEN        0x0020
 356 #define BITS_PARITY_MARK        0x0030
 357 #define BITS_PARITY_SPACE       0x0040
 358
 359 #define BITS_STOP_MASK          0x000f
 360 #define BITS_STOP_1             0x0000
 361 #define BITS_STOP_1_5           0x0001
 362 #define BITS_STOP_2             0x0002
 363
 364 /* CP210X_SET_BREAK */
 365 #define BREAK_ON                0x0001
 366 #define BREAK_OFF               0x0000
 367
 368 /* CP210X_(SET_MHS|GET_MDMSTS) */
 369 #define CONTROL_DTR             0x0001
 370 #define CONTROL_RTS             0x0002
 371 #define CONTROL_CTS             0x0010
 372 #define CONTROL_DSR             0x0020
 373 #define CONTROL_RING            0x0040
 374 #define CONTROL_DCD             0x0080
 375 #define CONTROL_WRITE_DTR       0x0100
 376 #define CONTROL_WRITE_RTS       0x0200
 377
 378 /* CP210X_VENDOR_SPECIFIC values */
 379 #define CP210X_READ_2NCONFIG    0x000E
 380 #define CP210X_READ_LATCH       0x00C2
 381 #define CP210X_GET_PARTNUM      0x370B
 382 #define CP210X_GET_PORTCONFIG   0x370C
 383 #define CP210X_GET_DEVICEMODE   0x3711
 384 #define CP210X_WRITE_LATCH      0x37E1
 385
 386 /* Part number definitions */
 387 #define CP210X_PARTNUM_CP2101   0x01
 388 #define CP210X_PARTNUM_CP2102   0x02
 389 #define CP210X_PARTNUM_CP2103   0x03
 390 #define CP210X_PARTNUM_CP2104   0x04
 391 #define CP210X_PARTNUM_CP2105   0x05
 392 #define CP210X_PARTNUM_CP2108   0x08
 393 #define CP210X_PARTNUM_CP2102N_QFN28    0x20
 394 #define CP210X_PARTNUM_CP2102N_QFN24    0x21
 395 #define CP210X_PARTNUM_CP2102N_QFN20    0x22
 396 #define CP210X_PARTNUM_UNKNOWN  0xFF
 397
 398 /* CP210X_GET_COMM_STATUS returns these 0x13 bytes */
 399 struct cp210x_comm_status {
 400         __le32   ulErrors;
 401         __le32   ulHoldReasons;
 402         __le32   ulAmountInInQueue;
 403         __le32   ulAmountInOutQueue;
 404         u8       bEofReceived;
 405         u8       bWaitForImmediate;
 406         u8       bReserved;
 407 } __packed;
 408
 409 /*
 410  * CP210X_PURGE - 16 bits passed in wValue of USB request.
 411  * SiLabs app note AN571 gives a strange description of the 4 bits:
 412  * bit 0 or bit 2 clears the transmit queue and 1 or 3 receive.
 413  * writing 1 to all, however, purges cp2108 well enough to avoid the hang.
 414  */
 415 #define PURGE_ALL               0x000f
 416
 417 /* CP210X_GET_FLOW/CP210X_SET_FLOW read/write these 0x10 bytes */
 418 struct cp210x_flow_ctl {
 419         __le32  ulControlHandshake;
 420         __le32  ulFlowReplace;
 421         __le32  ulXonLimit;
 422         __le32  ulXoffLimit;
 423 } __packed;
 424
 425 /* cp210x_flow_ctl::ulControlHandshake */
 426 #define CP210X_SERIAL_DTR_MASK          GENMASK(1, 0)
 427 #define CP210X_SERIAL_DTR_SHIFT(_mode)  (_mode)
 428 #define CP210X_SERIAL_CTS_HANDSHAKE     BIT(3)
 429 #define CP210X_SERIAL_DSR_HANDSHAKE     BIT(4)
 430 #define CP210X_SERIAL_DCD_HANDSHAKE     BIT(5)
 431 #define CP210X_SERIAL_DSR_SENSITIVITY   BIT(6)
 432
 433 /* values for cp210x_flow_ctl::ulControlHandshake::CP210X_SERIAL_DTR_MASK */
 434 #define CP210X_SERIAL_DTR_INACTIVE      0
 435 #define CP210X_SERIAL_DTR_ACTIVE        1
 436 #define CP210X_SERIAL_DTR_FLOW_CTL      2
 437
 438 /* cp210x_flow_ctl::ulFlowReplace */
 439 #define CP210X_SERIAL_AUTO_TRANSMIT     BIT(0)
 440 #define CP210X_SERIAL_AUTO_RECEIVE      BIT(1)
 441 #define CP210X_SERIAL_ERROR_CHAR        BIT(2)
 442 #define CP210X_SERIAL_NULL_STRIPPING    BIT(3)
 443 #define CP210X_SERIAL_BREAK_CHAR        BIT(4)
 444 #define CP210X_SERIAL_RTS_MASK          GENMASK(7, 6)
 445 #define CP210X_SERIAL_RTS_SHIFT(_mode)  (_mode << 6)
 446 #define CP210X_SERIAL_XOFF_CONTINUE     BIT(31)
 447
 448 /* values for cp210x_flow_ctl::ulFlowReplace::CP210X_SERIAL_RTS_MASK */
 449 #define CP210X_SERIAL_RTS_INACTIVE      0
 450 #define CP210X_SERIAL_RTS_ACTIVE        1
 451 #define CP210X_SERIAL_RTS_FLOW_CTL      2
 452
 453 /* CP210X_VENDOR_SPECIFIC, CP210X_GET_DEVICEMODE call reads these 0x2 bytes. */
 454 struct cp210x_pin_mode {
 455         u8      eci;
 456         u8      sci;
 457 } __packed;
 458
 459 #define CP210X_PIN_MODE_MODEM           0
 460 #define CP210X_PIN_MODE_GPIO            BIT(0)
 461
 462 /*
 463  * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xf bytes.
 464  * Structure needs padding due to unused/unspecified bytes.
 465  */
 466 struct cp210x_config {
 467         __le16  gpio_mode;
 468         u8      __pad0[2];
 469         __le16  reset_state;
 470         u8      __pad1[4];
 471         __le16  suspend_state;
 472         u8      sci_cfg;
 473         u8      eci_cfg;
 474         u8      device_cfg;
 475 } __packed;
 476
 477 /* GPIO modes */
 478 #define CP210X_SCI_GPIO_MODE_OFFSET     9
 479 #define CP210X_SCI_GPIO_MODE_MASK       GENMASK(11, 9)
 480
 481 #define CP210X_ECI_GPIO_MODE_OFFSET     2
 482 #define CP210X_ECI_GPIO_MODE_MASK       GENMASK(3, 2)
 483
 484 /* CP2105 port configuration values */
 485 #define CP2105_GPIO0_TXLED_MODE         BIT(0)
 486 #define CP2105_GPIO1_RXLED_MODE         BIT(1)
 487 #define CP2105_GPIO1_RS485_MODE         BIT(2)
 488
 489 /* CP2102N configuration array indices */
 490 #define CP210X_2NCONFIG_CONFIG_VERSION_IDX      2
 491 #define CP210X_2NCONFIG_GPIO_MODE_IDX           581
 492 #define CP210X_2NCONFIG_GPIO_RSTLATCH_IDX       587
 493 #define CP210X_2NCONFIG_GPIO_CONTROL_IDX        600
 494
 495 /* CP2102N QFN20 port configuration values */
 496 #define CP2102N_QFN20_GPIO2_TXLED_MODE          BIT(2)
 497 #define CP2102N_QFN20_GPIO3_RXLED_MODE          BIT(3)
 498 #define CP2102N_QFN20_GPIO1_RS485_MODE          BIT(4)
 499 #define CP2102N_QFN20_GPIO0_CLK_MODE            BIT(6)
 500
 501 /* CP210X_VENDOR_SPECIFIC, CP210X_WRITE_LATCH call writes these 0x2 bytes. */
 502 struct cp210x_gpio_write {
 503         u8      mask;
 504         u8      state;
 505 } __packed;
 506
 507 /*
 508  * Helper to get interface number when we only have struct usb_serial.
 509  */
 510 static u8 cp210x_interface_num(struct usb_serial *serial)
 511 {
 512         struct usb_host_interface *cur_altsetting;
 513
 514         cur_altsetting = serial->interface->cur_altsetting;
 515
 516         return cur_altsetting->desc.bInterfaceNumber;
 517 }
 518
 519 /*
 520  * Reads a variable-sized block of CP210X_ registers, identified by req.
 521  * Returns data into buf in native USB byte order.
 522  */
 523 static int cp210x_read_reg_block(struct usb_serial_port *port, u8 req,
 524                 void *buf, int bufsize)
 525 {
 526         struct usb_serial *serial = port->serial;
 527         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 528         void *dmabuf;
 529         int result;
 530
 531         dmabuf = kmalloc(bufsize, GFP_KERNEL);
 532         if (!dmabuf) {
 533                 /*
 534                  * FIXME Some callers don't bother to check for error,
 535                  * at least give them consistent junk until they are fixed
 536                  */
 537                 memset(buf, 0, bufsize);
 538                 return -ENOMEM;
 539         }
 540
 541         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 542                         req, REQTYPE_INTERFACE_TO_HOST, 0,
 543                         port_priv->bInterfaceNumber, dmabuf, bufsize,
 544                         USB_CTRL_SET_TIMEOUT);
 545         if (result == bufsize) {
 546                 memcpy(buf, dmabuf, bufsize);
 547                 result = 0;
 548         } else {
 549                 dev_err(&port->dev, "failed get req 0x%x size %d status: %d\n",
 550                                 req, bufsize, result);
 551                 if (result >= 0)
 552                         result = -EIO;
 553
 554                 /*
 555                  * FIXME Some callers don't bother to check for error,
 556                  * at least give them consistent junk until they are fixed
 557                  */
 558                 memset(buf, 0, bufsize);
 559         }
 560
 561         kfree(dmabuf);
 562
 563         return result;
 564 }
 565
 566 /*
 567  * Reads any 32-bit CP210X_ register identified by req.
 568  */
 569 static int cp210x_read_u32_reg(struct usb_serial_port *port, u8 req, u32 *val)
 570 {
 571         __le32 le32_val;
 572         int err;
 573
 574         err = cp210x_read_reg_block(port, req, &le32_val, sizeof(le32_val));
 575         if (err) {
 576                 /*
 577                  * FIXME Some callers don't bother to check for error,
 578                  * at least give them consistent junk until they are fixed
 579                  */
 580                 *val = 0;
 581                 return err;
 582         }
 583
 584         *val = le32_to_cpu(le32_val);
 585
 586         return 0;
 587 }
 588
 589 /*
 590  * Reads any 16-bit CP210X_ register identified by req.
 591  */
 592 static int cp210x_read_u16_reg(struct usb_serial_port *port, u8 req, u16 *val)
 593 {
 594         __le16 le16_val;
 595         int err;
 596
 597         err = cp210x_read_reg_block(port, req, &le16_val, sizeof(le16_val));
 598         if (err)
 599                 return err;
 600
 601         *val = le16_to_cpu(le16_val);
 602
 603         return 0;
 604 }
 605
 606 /*
 607  * Reads any 8-bit CP210X_ register identified by req.
 608  */
 609 static int cp210x_read_u8_reg(struct usb_serial_port *port, u8 req, u8 *val)
 610 {
 611         return cp210x_read_reg_block(port, req, val, sizeof(*val));
 612 }
 613
 614 /*
 615  * Reads a variable-sized vendor block of CP210X_ registers, identified by val.
 616  * Returns data into buf in native USB byte order.
 617  */
 618 static int cp210x_read_vendor_block(struct usb_serial *serial, u8 type, u16 val,
 619                                     void *buf, int bufsize)
 620 {
 621         void *dmabuf;
 622         int result;
 623
 624         dmabuf = kmalloc(bufsize, GFP_KERNEL);
 625         if (!dmabuf)
 626                 return -ENOMEM;
 627
 628         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 629                                  CP210X_VENDOR_SPECIFIC, type, val,
 630                                  cp210x_interface_num(serial), dmabuf, bufsize,
 631                                  USB_CTRL_GET_TIMEOUT);
 632         if (result == bufsize) {
 633                 memcpy(buf, dmabuf, bufsize);
 634                 result = 0;
 635         } else {
 636                 dev_err(&serial->interface->dev,
 637                         "failed to get vendor val 0x%04x size %d: %d\n", val,
 638                         bufsize, result);
 639                 if (result >= 0)
 640                         result = -EIO;
 641         }
 642
 643         kfree(dmabuf);
 644
 645         return result;
 646 }
 647
 648 /*
 649  * Writes any 16-bit CP210X_ register (req) whose value is passed
 650  * entirely in the wValue field of the USB request.
 651  */
 652 static int cp210x_write_u16_reg(struct usb_serial_port *port, u8 req, u16 val)
 653 {
 654         struct usb_serial *serial = port->serial;
 655         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 656         int result;
 657
 658         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 659                         req, REQTYPE_HOST_TO_INTERFACE, val,
 660                         port_priv->bInterfaceNumber, NULL, 0,
 661                         USB_CTRL_SET_TIMEOUT);
 662         if (result < 0) {
 663                 dev_err(&port->dev, "failed set request 0x%x status: %d\n",
 664                                 req, result);
 665         }
 666
 667         return result;
 668 }
 669
 670 /*
 671  * Writes a variable-sized block of CP210X_ registers, identified by req.
 672  * Data in buf must be in native USB byte order.
 673  */
 674 static int cp210x_write_reg_block(struct usb_serial_port *port, u8 req,
 675                 void *buf, int bufsize)
 676 {
 677         struct usb_serial *serial = port->serial;
 678         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 679         void *dmabuf;
 680         int result;
 681
 682         dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
 683         if (!dmabuf)
 684                 return -ENOMEM;
 685
 686         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 687                         req, REQTYPE_HOST_TO_INTERFACE, 0,
 688                         port_priv->bInterfaceNumber, dmabuf, bufsize,
 689                         USB_CTRL_SET_TIMEOUT);
 690
 691         kfree(dmabuf);
 692
 693         if (result == bufsize) {
 694                 result = 0;
 695         } else {
 696                 dev_err(&port->dev, "failed set req 0x%x size %d status: %d\n",
 697                                 req, bufsize, result);
 698                 if (result >= 0)
 699                         result = -EIO;
 700         }
 701
 702         return result;
 703 }
 704
 705 /*
 706  * Writes any 32-bit CP210X_ register identified by req.
 707  */
 708 static int cp210x_write_u32_reg(struct usb_serial_port *port, u8 req, u32 val)
 709 {
 710         __le32 le32_val;
 711
 712         le32_val = cpu_to_le32(val);
 713
 714         return cp210x_write_reg_block(port, req, &le32_val, sizeof(le32_val));
 715 }
 716
 717 #ifdef CONFIG_GPIOLIB
 718 /*
 719  * Writes a variable-sized vendor block of CP210X_ registers, identified by val.
 720  * Data in buf must be in native USB byte order.
 721  */
 722 static int cp210x_write_vendor_block(struct usb_serial *serial, u8 type,
 723                                      u16 val, void *buf, int bufsize)
 724 {
 725         void *dmabuf;
 726         int result;
 727
 728         dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
 729         if (!dmabuf)
 730                 return -ENOMEM;
 731
 732         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 733                                  CP210X_VENDOR_SPECIFIC, type, val,
 734                                  cp210x_interface_num(serial), dmabuf, bufsize,
 735                                  USB_CTRL_SET_TIMEOUT);
 736
 737         kfree(dmabuf);
 738
 739         if (result == bufsize) {
 740                 result = 0;
 741         } else {
 742                 dev_err(&serial->interface->dev,
 743                         "failed to set vendor val 0x%04x size %d: %d\n", val,
 744                         bufsize, result);
 745                 if (result >= 0)
 746                         result = -EIO;
 747         }
 748
 749         return result;
 750 }
 751 #endif
 752
 753 /*
 754  * Detect CP2108 GET_LINE_CTL bug and activate workaround.
 755  * Write a known good value 0x800, read it back.
 756  * If it comes back swapped the bug is detected.
 757  * Preserve the original register value.
 758  */
 759 static int cp210x_detect_swapped_line_ctl(struct usb_serial_port *port)
 760 {
 761         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 762         u16 line_ctl_save;
 763         u16 line_ctl_test;
 764         int err;
 765
 766         err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_save);
 767         if (err)
 768                 return err;
 769
 770         err = cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, 0x800);
 771         if (err)
 772                 return err;
 773
 774         err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, &line_ctl_test);
 775         if (err)
 776                 return err;
 777
 778         if (line_ctl_test == 8) {
 779                 port_priv->has_swapped_line_ctl = true;
 780                 line_ctl_save = swab16(line_ctl_save);
 781         }
 782
 783         return cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, line_ctl_save);
 784 }
 785
 786 /*
 787  * Must always be called instead of cp210x_read_u16_reg(CP210X_GET_LINE_CTL)
 788  * to workaround cp2108 bug and get correct value.
 789  */
 790 static int cp210x_get_line_ctl(struct usb_serial_port *port, u16 *ctl)
 791 {
 792         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 793         int err;
 794
 795         err = cp210x_read_u16_reg(port, CP210X_GET_LINE_CTL, ctl);
 796         if (err)
 797                 return err;
 798
 799         /* Workaround swapped bytes in 16-bit value from CP210X_GET_LINE_CTL */
 800         if (port_priv->has_swapped_line_ctl)
 801                 *ctl = swab16(*ctl);
 802
 803         return 0;
 804 }
 805
 806 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
 807 {
 808         int result;
 809
 810         result = cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_ENABLE);
 811         if (result) {
 812                 dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
 813                 return result;
 814         }
 815
 816         /* Configure the termios structure */
 817         cp210x_get_termios(tty, port);
 818
 819         /* The baud rate must be initialised on cp2104 */
 820         if (tty)
 821                 cp210x_change_speed(tty, port, NULL);
 822
 823         return usb_serial_generic_open(tty, port);
 824 }
 825
 826 static void cp210x_close(struct usb_serial_port *port)
 827 {
 828         usb_serial_generic_close(port);
 829
 830         /* Clear both queues; cp2108 needs this to avoid an occasional hang */
 831         cp210x_write_u16_reg(port, CP210X_PURGE, PURGE_ALL);
 832
 833         cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
 834 }
 835
 836 /*
 837  * Read how many bytes are waiting in the TX queue.
 838  */
 839 static int cp210x_get_tx_queue_byte_count(struct usb_serial_port *port,
 840                 u32 *count)
 841 {
 842         struct usb_serial *serial = port->serial;
 843         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 844         struct cp210x_comm_status *sts;
 845         int result;
 846
 847         sts = kmalloc(sizeof(*sts), GFP_KERNEL);
 848         if (!sts)
 849                 return -ENOMEM;
 850
 851         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 852                         CP210X_GET_COMM_STATUS, REQTYPE_INTERFACE_TO_HOST,
 853                         0, port_priv->bInterfaceNumber, sts, sizeof(*sts),
 854                         USB_CTRL_GET_TIMEOUT);
 855         if (result == sizeof(*sts)) {
 856                 *count = le32_to_cpu(sts->ulAmountInOutQueue);
 857                 result = 0;
 858         } else {
 859                 dev_err(&port->dev, "failed to get comm status: %d\n", result);
 860                 if (result >= 0)
 861                         result = -EIO;
 862         }
 863
 864         kfree(sts);
 865
 866         return result;
 867 }
 868
 869 static bool cp210x_tx_empty(struct usb_serial_port *port)
 870 {
 871         int err;
 872         u32 count;
 873
 874         err = cp210x_get_tx_queue_byte_count(port, &count);
 875         if (err)
 876                 return true;
 877
 878         return !count;
 879 }
 880
 881 /*
 882  * cp210x_get_termios
 883  * Reads the baud rate, data bits, parity, stop bits and flow control mode
 884  * from the device, corrects any unsupported values, and configures the
 885  * termios structure to reflect the state of the device
 886  */
 887 static void cp210x_get_termios(struct tty_struct *tty,
 888         struct usb_serial_port *port)
 889 {
 890         unsigned int baud;
 891
 892         if (tty) {
 893                 cp210x_get_termios_port(tty->driver_data,
 894                         &tty->termios.c_cflag, &baud);
 895                 tty_encode_baud_rate(tty, baud, baud);
 896         } else {
 897                 tcflag_t cflag;
 898                 cflag = 0;
 899                 cp210x_get_termios_port(port, &cflag, &baud);
 900         }
 901 }
 902
 903 /*
 904  * cp210x_get_termios_port
 905  * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
 906  */
 907 static void cp210x_get_termios_port(struct usb_serial_port *port,
 908         tcflag_t *cflagp, unsigned int *baudp)
 909 {
 910         struct device *dev = &port->dev;
 911         tcflag_t cflag;
 912         struct cp210x_flow_ctl flow_ctl;
 913         u32 baud;
 914         u16 bits;
 915         u32 ctl_hs;
 916         u32 flow_repl;
 917
 918         cp210x_read_u32_reg(port, CP210X_GET_BAUDRATE, &baud);
 919
 920         dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud);
 921         *baudp = baud;
 922
 923         cflag = *cflagp;
 924
 925         cp210x_get_line_ctl(port, &bits);
 926         cflag &= ~CSIZE;
 927         switch (bits & BITS_DATA_MASK) {
 928         case BITS_DATA_5:
 929                 dev_dbg(dev, "%s - data bits = 5\n", __func__);
 930                 cflag |= CS5;
 931                 break;
 932         case BITS_DATA_6:
 933                 dev_dbg(dev, "%s - data bits = 6\n", __func__);
 934                 cflag |= CS6;
 935                 break;
 936         case BITS_DATA_7:
 937                 dev_dbg(dev, "%s - data bits = 7\n", __func__);
 938                 cflag |= CS7;
 939                 break;
 940         case BITS_DATA_8:
 941                 dev_dbg(dev, "%s - data bits = 8\n", __func__);
 942                 cflag |= CS8;
 943                 break;
 944         case BITS_DATA_9:
 945                 dev_dbg(dev, "%s - data bits = 9 (not supported, using 8 data bits)\n", __func__);
 946                 cflag |= CS8;
 947                 bits &= ~BITS_DATA_MASK;
 948                 bits |= BITS_DATA_8;
 949                 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
 950                 break;
 951         default:
 952                 dev_dbg(dev, "%s - Unknown number of data bits, using 8\n", __func__);
 953                 cflag |= CS8;
 954                 bits &= ~BITS_DATA_MASK;
 955                 bits |= BITS_DATA_8;
 956                 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
 957                 break;
 958         }
 959
 960         switch (bits & BITS_PARITY_MASK) {
 961         case BITS_PARITY_NONE:
 962                 dev_dbg(dev, "%s - parity = NONE\n", __func__);
 963                 cflag &= ~PARENB;
 964                 break;
 965         case BITS_PARITY_ODD:
 966                 dev_dbg(dev, "%s - parity = ODD\n", __func__);
 967                 cflag |= (PARENB|PARODD);
 968                 break;
 969         case BITS_PARITY_EVEN:
 970                 dev_dbg(dev, "%s - parity = EVEN\n", __func__);
 971                 cflag &= ~PARODD;
 972                 cflag |= PARENB;
 973                 break;
 974         case BITS_PARITY_MARK:
 975                 dev_dbg(dev, "%s - parity = MARK\n", __func__);
 976                 cflag |= (PARENB|PARODD|CMSPAR);
 977                 break;
 978         case BITS_PARITY_SPACE:
 979                 dev_dbg(dev, "%s - parity = SPACE\n", __func__);
 980                 cflag &= ~PARODD;
 981                 cflag |= (PARENB|CMSPAR);
 982                 break;
 983         default:
 984                 dev_dbg(dev, "%s - Unknown parity mode, disabling parity\n", __func__);
 985                 cflag &= ~PARENB;
 986                 bits &= ~BITS_PARITY_MASK;
 987                 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
 988                 break;
 989         }
 990
 991         cflag &= ~CSTOPB;
 992         switch (bits & BITS_STOP_MASK) {
 993         case BITS_STOP_1:
 994                 dev_dbg(dev, "%s - stop bits = 1\n", __func__);
 995                 break;
 996         case BITS_STOP_1_5:
 997                 dev_dbg(dev, "%s - stop bits = 1.5 (not supported, using 1 stop bit)\n", __func__);
 998                 bits &= ~BITS_STOP_MASK;
 999                 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
1000                 break;
1001         case BITS_STOP_2:
1002                 dev_dbg(dev, "%s - stop bits = 2\n", __func__);
1003                 cflag |= CSTOPB;
1004                 break;
1005         default:
1006                 dev_dbg(dev, "%s - Unknown number of stop bits, using 1 stop bit\n", __func__);
1007                 bits &= ~BITS_STOP_MASK;
1008                 cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
1009                 break;
1010         }
1011
1012         cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1013                         sizeof(flow_ctl));
1014         ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1015         if (ctl_hs & CP210X_SERIAL_CTS_HANDSHAKE) {
1016                 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
1017                 /*
1018                  * When the port is closed, the CP210x hardware disables
1019                  * auto-RTS and RTS is deasserted but it leaves auto-CTS when
1020                  * in hardware flow control mode. When re-opening the port, if
1021                  * auto-CTS is enabled on the cp210x, then auto-RTS must be
1022                  * re-enabled in the driver.
1023                  */
1024                 flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1025                 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1026                 flow_repl |= CP210X_SERIAL_RTS_SHIFT(CP210X_SERIAL_RTS_FLOW_CTL);
1027                 flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1028                 cp210x_write_reg_block(port,
1029                                 CP210X_SET_FLOW,
1030                                 &flow_ctl,
1031                                 sizeof(flow_ctl));
1032
1033                 cflag |= CRTSCTS;
1034         } else {
1035                 dev_dbg(dev, "%s - flow control = NONE\n", __func__);
1036                 cflag &= ~CRTSCTS;
1037         }
1038
1039         *cflagp = cflag;
1040 }
1041
1042 struct cp210x_rate {
1043         speed_t rate;
1044         speed_t high;
1045 };
1046
1047 static const struct cp210x_rate cp210x_an205_table1[] = {
1048         { 300, 300 },
1049         { 600, 600 },
1050         { 1200, 1200 },
1051         { 1800, 1800 },
1052         { 2400, 2400 },
1053         { 4000, 4000 },
1054         { 4800, 4803 },
1055         { 7200, 7207 },
1056         { 9600, 9612 },
1057         { 14400, 14428 },
1058         { 16000, 16062 },
1059         { 19200, 19250 },
1060         { 28800, 28912 },
1061         { 38400, 38601 },
1062         { 51200, 51558 },
1063         { 56000, 56280 },
1064         { 57600, 58053 },
1065         { 64000, 64111 },
1066         { 76800, 77608 },
1067         { 115200, 117028 },
1068         { 128000, 129347 },
1069         { 153600, 156868 },
1070         { 230400, 237832 },
1071         { 250000, 254234 },
1072         { 256000, 273066 },
1073         { 460800, 491520 },
1074         { 500000, 567138 },
1075         { 576000, 670254 },
1076         { 921600, UINT_MAX }
1077 };
1078
1079 /*
1080  * Quantises the baud rate as per AN205 Table 1
1081  */
1082 static speed_t cp210x_get_an205_rate(speed_t baud)
1083 {
1084         int i;
1085
1086         for (i = 0; i < ARRAY_SIZE(cp210x_an205_table1); ++i) {
1087                 if (baud <= cp210x_an205_table1[i].high)
1088                         break;
1089         }
1090
1091         return cp210x_an205_table1[i].rate;
1092 }
1093
1094 static speed_t cp210x_get_actual_rate(struct usb_serial *serial, speed_t baud)
1095 {
1096         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1097         unsigned int prescale = 1;
1098         unsigned int div;
1099
1100         baud = clamp(baud, 300u, priv->max_speed);
1101
1102         if (baud <= 365)
1103                 prescale = 4;
1104
1105         div = DIV_ROUND_CLOSEST(48000000, 2 * prescale * baud);
1106         baud = 48000000 / (2 * prescale * div);
1107
1108         return baud;
1109 }
1110
1111 /*
1112  * CP2101 supports the following baud rates:
1113  *
1114  *      300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
1115  *      38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
1116  *
1117  * CP2102 and CP2103 support the following additional rates:
1118  *
1119  *      4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
1120  *      576000
1121  *
1122  * The device will map a requested rate to a supported one, but the result
1123  * of requests for rates greater than 1053257 is undefined (see AN205).
1124  *
1125  * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
1126  * respectively, with an error less than 1%. The actual rates are determined
1127  * by
1128  *
1129  *      div = round(freq / (2 x prescale x request))
1130  *      actual = freq / (2 x prescale x div)
1131  *
1132  * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
1133  * or 1 otherwise.
1134  * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
1135  * otherwise.
1136  */
1137 static void cp210x_change_speed(struct tty_struct *tty,
1138                 struct usb_serial_port *port, struct ktermios *old_termios)
1139 {
1140         struct usb_serial *serial = port->serial;
1141         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1142         u32 baud;
1143
1144         baud = tty->termios.c_ospeed;
1145
1146         /*
1147          * This maps the requested rate to the actual rate, a valid rate on
1148          * cp2102 or cp2103, or to an arbitrary rate in [1M, max_speed].
1149          *
1150          * NOTE: B0 is not implemented.
1151          */
1152         if (priv->use_actual_rate)
1153                 baud = cp210x_get_actual_rate(serial, baud);
1154         else if (baud < 1000000)
1155                 baud = cp210x_get_an205_rate(baud);
1156         else if (baud > priv->max_speed)
1157                 baud = priv->max_speed;
1158
1159         dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
1160         if (cp210x_write_u32_reg(port, CP210X_SET_BAUDRATE, baud)) {
1161                 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
1162                 if (old_termios)
1163                         baud = old_termios->c_ospeed;
1164                 else
1165                         baud = 9600;
1166         }
1167
1168         tty_encode_baud_rate(tty, baud, baud);
1169 }
1170
1171 static void cp210x_set_termios(struct tty_struct *tty,
1172                 struct usb_serial_port *port, struct ktermios *old_termios)
1173 {
1174         struct device *dev = &port->dev;
1175         unsigned int cflag, old_cflag;
1176         u16 bits;
1177
1178         cflag = tty->termios.c_cflag;
1179         old_cflag = old_termios->c_cflag;
1180
1181         if (tty->termios.c_ospeed != old_termios->c_ospeed)
1182                 cp210x_change_speed(tty, port, old_termios);
1183
1184         /* If the number of data bits is to be updated */
1185         if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
1186                 cp210x_get_line_ctl(port, &bits);
1187                 bits &= ~BITS_DATA_MASK;
1188                 switch (cflag & CSIZE) {
1189                 case CS5:
1190                         bits |= BITS_DATA_5;
1191                         dev_dbg(dev, "%s - data bits = 5\n", __func__);
1192                         break;
1193                 case CS6:
1194                         bits |= BITS_DATA_6;
1195                         dev_dbg(dev, "%s - data bits = 6\n", __func__);
1196                         break;
1197                 case CS7:
1198                         bits |= BITS_DATA_7;
1199                         dev_dbg(dev, "%s - data bits = 7\n", __func__);
1200                         break;
1201                 case CS8:
1202                 default:
1203                         bits |= BITS_DATA_8;
1204                         dev_dbg(dev, "%s - data bits = 8\n", __func__);
1205                         break;
1206                 }
1207                 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1208                         dev_dbg(dev, "Number of data bits requested not supported by device\n");
1209         }
1210
1211         if ((cflag     & (PARENB|PARODD|CMSPAR)) !=
1212             (old_cflag & (PARENB|PARODD|CMSPAR))) {
1213                 cp210x_get_line_ctl(port, &bits);
1214                 bits &= ~BITS_PARITY_MASK;
1215                 if (cflag & PARENB) {
1216                         if (cflag & CMSPAR) {
1217                                 if (cflag & PARODD) {
1218                                         bits |= BITS_PARITY_MARK;
1219                                         dev_dbg(dev, "%s - parity = MARK\n", __func__);
1220                                 } else {
1221                                         bits |= BITS_PARITY_SPACE;
1222                                         dev_dbg(dev, "%s - parity = SPACE\n", __func__);
1223                                 }
1224                         } else {
1225                                 if (cflag & PARODD) {
1226                                         bits |= BITS_PARITY_ODD;
1227                                         dev_dbg(dev, "%s - parity = ODD\n", __func__);
1228                                 } else {
1229                                         bits |= BITS_PARITY_EVEN;
1230                                         dev_dbg(dev, "%s - parity = EVEN\n", __func__);
1231                                 }
1232                         }
1233                 }
1234                 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1235                         dev_dbg(dev, "Parity mode not supported by device\n");
1236         }
1237
1238         if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
1239                 cp210x_get_line_ctl(port, &bits);
1240                 bits &= ~BITS_STOP_MASK;
1241                 if (cflag & CSTOPB) {
1242                         bits |= BITS_STOP_2;
1243                         dev_dbg(dev, "%s - stop bits = 2\n", __func__);
1244                 } else {
1245                         bits |= BITS_STOP_1;
1246                         dev_dbg(dev, "%s - stop bits = 1\n", __func__);
1247                 }
1248                 if (cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits))
1249                         dev_dbg(dev, "Number of stop bits requested not supported by device\n");
1250         }
1251
1252         if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
1253                 struct cp210x_flow_ctl flow_ctl;
1254                 u32 ctl_hs;
1255                 u32 flow_repl;
1256
1257                 cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1258                                 sizeof(flow_ctl));
1259                 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1260                 flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1261                 dev_dbg(dev, "%s - read ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1262                                 __func__, ctl_hs, flow_repl);
1263
1264                 ctl_hs &= ~CP210X_SERIAL_DSR_HANDSHAKE;
1265                 ctl_hs &= ~CP210X_SERIAL_DCD_HANDSHAKE;
1266                 ctl_hs &= ~CP210X_SERIAL_DSR_SENSITIVITY;
1267                 ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1268                 ctl_hs |= CP210X_SERIAL_DTR_SHIFT(CP210X_SERIAL_DTR_ACTIVE);
1269                 if (cflag & CRTSCTS) {
1270                         ctl_hs |= CP210X_SERIAL_CTS_HANDSHAKE;
1271
1272                         flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1273                         flow_repl |= CP210X_SERIAL_RTS_SHIFT(
1274                                         CP210X_SERIAL_RTS_FLOW_CTL);
1275                         dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__);
1276                 } else {
1277                         ctl_hs &= ~CP210X_SERIAL_CTS_HANDSHAKE;
1278
1279                         flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1280                         flow_repl |= CP210X_SERIAL_RTS_SHIFT(
1281                                         CP210X_SERIAL_RTS_ACTIVE);
1282                         dev_dbg(dev, "%s - flow control = NONE\n", __func__);
1283                 }
1284
1285                 dev_dbg(dev, "%s - write ulControlHandshake=0x%08x, ulFlowReplace=0x%08x\n",
1286                                 __func__, ctl_hs, flow_repl);
1287                 flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1288                 flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1289                 cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1290                                 sizeof(flow_ctl));
1291         }
1292
1293 }
1294
1295 static int cp210x_tiocmset(struct tty_struct *tty,
1296                 unsigned int set, unsigned int clear)
1297 {
1298         struct usb_serial_port *port = tty->driver_data;
1299         return cp210x_tiocmset_port(port, set, clear);
1300 }
1301
1302 static int cp210x_tiocmset_port(struct usb_serial_port *port,
1303                 unsigned int set, unsigned int clear)
1304 {
1305         u16 control = 0;
1306
1307         if (set & TIOCM_RTS) {
1308                 control |= CONTROL_RTS;
1309                 control |= CONTROL_WRITE_RTS;
1310         }
1311         if (set & TIOCM_DTR) {
1312                 control |= CONTROL_DTR;
1313                 control |= CONTROL_WRITE_DTR;
1314         }
1315         if (clear & TIOCM_RTS) {
1316                 control &= ~CONTROL_RTS;
1317                 control |= CONTROL_WRITE_RTS;
1318         }
1319         if (clear & TIOCM_DTR) {
1320                 control &= ~CONTROL_DTR;
1321                 control |= CONTROL_WRITE_DTR;
1322         }
1323
1324         dev_dbg(&port->dev, "%s - control = 0x%.4x\n", __func__, control);
1325
1326         return cp210x_write_u16_reg(port, CP210X_SET_MHS, control);
1327 }
1328
1329 static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
1330 {
1331         if (on)
1332                 cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0);
1333         else
1334                 cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS);
1335 }
1336
1337 static int cp210x_tiocmget(struct tty_struct *tty)
1338 {
1339         struct usb_serial_port *port = tty->driver_data;
1340         u8 control;
1341         int result;
1342
1343         result = cp210x_read_u8_reg(port, CP210X_GET_MDMSTS, &control);
1344         if (result)
1345                 return result;
1346
1347         result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
1348                 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
1349                 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
1350                 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
1351                 |((control & CONTROL_RING)? TIOCM_RI  : 0)
1352                 |((control & CONTROL_DCD) ? TIOCM_CD  : 0);
1353
1354         dev_dbg(&port->dev, "%s - control = 0x%.2x\n", __func__, control);
1355
1356         return result;
1357 }
1358
1359 static void cp210x_break_ctl(struct tty_struct *tty, int break_state)
1360 {
1361         struct usb_serial_port *port = tty->driver_data;
1362         u16 state;
1363
1364         if (break_state == 0)
1365                 state = BREAK_OFF;
1366         else
1367                 state = BREAK_ON;
1368         dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
1369                 state == BREAK_OFF ? "off" : "on");
1370         cp210x_write_u16_reg(port, CP210X_SET_BREAK, state);
1371 }
1372
1373 #ifdef CONFIG_GPIOLIB
1374 static int cp210x_gpio_request(struct gpio_chip *gc, unsigned int offset)
1375 {
1376         struct usb_serial *serial = gpiochip_get_data(gc);
1377         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1378
1379         if (priv->gpio_altfunc & BIT(offset))
1380                 return -ENODEV;
1381
1382         return 0;
1383 }
1384
1385 static int cp210x_gpio_get(struct gpio_chip *gc, unsigned int gpio)
1386 {
1387         struct usb_serial *serial = gpiochip_get_data(gc);
1388         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1389         u8 req_type = REQTYPE_DEVICE_TO_HOST;
1390         int result;
1391         u8 buf;
1392
1393         if (priv->partnum == CP210X_PARTNUM_CP2105)
1394                 req_type = REQTYPE_INTERFACE_TO_HOST;
1395
1396         result = usb_autopm_get_interface(serial->interface);
1397         if (result)
1398                 return result;
1399
1400         result = cp210x_read_vendor_block(serial, req_type,
1401                                           CP210X_READ_LATCH, &buf, sizeof(buf));
1402         usb_autopm_put_interface(serial->interface);
1403         if (result < 0)
1404                 return result;
1405
1406         return !!(buf & BIT(gpio));
1407 }
1408
1409 static void cp210x_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)
1410 {
1411         struct usb_serial *serial = gpiochip_get_data(gc);
1412         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1413         struct cp210x_gpio_write buf;
1414         int result;
1415
1416         if (value == 1)
1417                 buf.state = BIT(gpio);
1418         else
1419                 buf.state = 0;
1420
1421         buf.mask = BIT(gpio);
1422
1423         result = usb_autopm_get_interface(serial->interface);
1424         if (result)
1425                 goto out;
1426
1427         if (priv->partnum == CP210X_PARTNUM_CP2105) {
1428                 result = cp210x_write_vendor_block(serial,
1429                                                    REQTYPE_HOST_TO_INTERFACE,
1430                                                    CP210X_WRITE_LATCH, &buf,
1431                                                    sizeof(buf));
1432         } else {
1433                 u16 wIndex = buf.state << 8 | buf.mask;
1434
1435                 result = usb_control_msg(serial->dev,
1436                                          usb_sndctrlpipe(serial->dev, 0),
1437                                          CP210X_VENDOR_SPECIFIC,
1438                                          REQTYPE_HOST_TO_DEVICE,
1439                                          CP210X_WRITE_LATCH,
1440                                          wIndex,
1441                                          NULL, 0, USB_CTRL_SET_TIMEOUT);
1442         }
1443
1444         usb_autopm_put_interface(serial->interface);
1445 out:
1446         if (result < 0) {
1447                 dev_err(&serial->interface->dev, "failed to set GPIO value: %d\n",
1448                                 result);
1449         }
1450 }
1451
1452 static int cp210x_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
1453 {
1454         struct usb_serial *serial = gpiochip_get_data(gc);
1455         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1456
1457         return priv->gpio_input & BIT(gpio);
1458 }
1459
1460 static int cp210x_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
1461 {
1462         struct usb_serial *serial = gpiochip_get_data(gc);
1463         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1464
1465         if (priv->partnum == CP210X_PARTNUM_CP2105) {
1466                 /* hardware does not support an input mode */
1467                 return -ENOTSUPP;
1468         }
1469
1470         /* push-pull pins cannot be changed to be inputs */
1471         if (priv->gpio_pushpull & BIT(gpio))
1472                 return -EINVAL;
1473
1474         /* make sure to release pin if it is being driven low */
1475         cp210x_gpio_set(gc, gpio, 1);
1476
1477         priv->gpio_input |= BIT(gpio);
1478
1479         return 0;
1480 }
1481
1482 static int cp210x_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
1483                                         int value)
1484 {
1485         struct usb_serial *serial = gpiochip_get_data(gc);
1486         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1487
1488         priv->gpio_input &= ~BIT(gpio);
1489         cp210x_gpio_set(gc, gpio, value);
1490
1491         return 0;
1492 }
1493
1494 static int cp210x_gpio_set_config(struct gpio_chip *gc, unsigned int gpio,
1495                                   unsigned long config)
1496 {
1497         struct usb_serial *serial = gpiochip_get_data(gc);
1498         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1499         enum pin_config_param param = pinconf_to_config_param(config);
1500
1501         /* Succeed only if in correct mode (this can't be set at runtime) */
1502         if ((param == PIN_CONFIG_DRIVE_PUSH_PULL) &&
1503             (priv->gpio_pushpull & BIT(gpio)))
1504                 return 0;
1505
1506         if ((param == PIN_CONFIG_DRIVE_OPEN_DRAIN) &&
1507             !(priv->gpio_pushpull & BIT(gpio)))
1508                 return 0;
1509
1510         return -ENOTSUPP;
1511 }
1512
1513 /*
1514  * This function is for configuring GPIO using shared pins, where other signals
1515  * are made unavailable by configuring the use of GPIO. This is believed to be
1516  * only applicable to the cp2105 at this point, the other devices supported by
1517  * this driver that provide GPIO do so in a way that does not impact other
1518  * signals and are thus expected to have very different initialisation.
1519  */
1520 static int cp2105_gpioconf_init(struct usb_serial *serial)
1521 {
1522         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1523         struct cp210x_pin_mode mode;
1524         struct cp210x_config config;
1525         u8 intf_num = cp210x_interface_num(serial);
1526         u8 iface_config;
1527         int result;
1528
1529         result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1530                                           CP210X_GET_DEVICEMODE, &mode,
1531                                           sizeof(mode));
1532         if (result < 0)
1533                 return result;
1534
1535         result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1536                                           CP210X_GET_PORTCONFIG, &config,
1537                                           sizeof(config));
1538         if (result < 0)
1539                 return result;
1540
1541         /*  2 banks of GPIO - One for the pins taken from each serial port */
1542         if (intf_num == 0) {
1543                 priv->gc.ngpio = 2;
1544
1545                 if (mode.eci == CP210X_PIN_MODE_MODEM) {
1546                         /* mark all GPIOs of this interface as reserved */
1547                         priv->gpio_altfunc = 0xff;
1548                         return 0;
1549                 }
1550
1551                 iface_config = config.eci_cfg;
1552                 priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1553                                                 CP210X_ECI_GPIO_MODE_MASK) >>
1554                                                 CP210X_ECI_GPIO_MODE_OFFSET);
1555         } else if (intf_num == 1) {
1556                 priv->gc.ngpio = 3;
1557
1558                 if (mode.sci == CP210X_PIN_MODE_MODEM) {
1559                         /* mark all GPIOs of this interface as reserved */
1560                         priv->gpio_altfunc = 0xff;
1561                         return 0;
1562                 }
1563
1564                 iface_config = config.sci_cfg;
1565                 priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1566                                                 CP210X_SCI_GPIO_MODE_MASK) >>
1567                                                 CP210X_SCI_GPIO_MODE_OFFSET);
1568         } else {
1569                 return -ENODEV;
1570         }
1571
1572         /* mark all pins which are not in GPIO mode */
1573         if (iface_config & CP2105_GPIO0_TXLED_MODE)     /* GPIO 0 */
1574                 priv->gpio_altfunc |= BIT(0);
1575         if (iface_config & (CP2105_GPIO1_RXLED_MODE |   /* GPIO 1 */
1576                         CP2105_GPIO1_RS485_MODE))
1577                 priv->gpio_altfunc |= BIT(1);
1578
1579         /* driver implementation for CP2105 only supports outputs */
1580         priv->gpio_input = 0;
1581
1582         return 0;
1583 }
1584
1585 static int cp2102n_gpioconf_init(struct usb_serial *serial)
1586 {
1587         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1588         const u16 config_size = 0x02a6;
1589         u8 gpio_rst_latch;
1590         u8 config_version;
1591         u8 gpio_pushpull;
1592         u8 *config_buf;
1593         u8 gpio_latch;
1594         u8 gpio_ctrl;
1595         int result;
1596         u8 i;
1597
1598         /*
1599          * Retrieve device configuration from the device.
1600          * The array received contains all customization settings done at the
1601          * factory/manufacturer. Format of the array is documented at the
1602          * time of writing at:
1603          * https://www.silabs.com/community/interface/knowledge-base.entry.html/2017/03/31/cp2102n_setconfig-xsfa
1604          */
1605         config_buf = kmalloc(config_size, GFP_KERNEL);
1606         if (!config_buf)
1607                 return -ENOMEM;
1608
1609         result = cp210x_read_vendor_block(serial,
1610                                           REQTYPE_DEVICE_TO_HOST,
1611                                           CP210X_READ_2NCONFIG,
1612                                           config_buf,
1613                                           config_size);
1614         if (result < 0) {
1615                 kfree(config_buf);
1616                 return result;
1617         }
1618
1619         config_version = config_buf[CP210X_2NCONFIG_CONFIG_VERSION_IDX];
1620         gpio_pushpull = config_buf[CP210X_2NCONFIG_GPIO_MODE_IDX];
1621         gpio_ctrl = config_buf[CP210X_2NCONFIG_GPIO_CONTROL_IDX];
1622         gpio_rst_latch = config_buf[CP210X_2NCONFIG_GPIO_RSTLATCH_IDX];
1623
1624         kfree(config_buf);
1625
1626         /* Make sure this is a config format we understand. */
1627         if (config_version != 0x01)
1628                 return -ENOTSUPP;
1629
1630         /*
1631          * We only support 4 GPIOs even on the QFN28 package, because
1632          * config locations of GPIOs 4-6 determined using reverse
1633          * engineering revealed conflicting offsets with other
1634          * documented functions. So we'll just play it safe for now.
1635          */
1636         priv->gc.ngpio = 4;
1637
1638         /*
1639          * Get default pin states after reset. Needed so we can determine
1640          * the direction of an open-drain pin.
1641          */
1642         gpio_latch = (gpio_rst_latch >> 3) & 0x0f;
1643
1644         /* 0 indicates open-drain mode, 1 is push-pull */
1645         priv->gpio_pushpull = (gpio_pushpull >> 3) & 0x0f;
1646
1647         /* 0 indicates GPIO mode, 1 is alternate function */
1648         if (priv->partnum == CP210X_PARTNUM_CP2102N_QFN20) {
1649                 /* QFN20 is special... */
1650                 if (gpio_ctrl & CP2102N_QFN20_GPIO0_CLK_MODE)   /* GPIO 0 */
1651                         priv->gpio_altfunc |= BIT(0);
1652                 if (gpio_ctrl & CP2102N_QFN20_GPIO1_RS485_MODE) /* GPIO 1 */
1653                         priv->gpio_altfunc |= BIT(1);
1654                 if (gpio_ctrl & CP2102N_QFN20_GPIO2_TXLED_MODE) /* GPIO 2 */
1655                         priv->gpio_altfunc |= BIT(2);
1656                 if (gpio_ctrl & CP2102N_QFN20_GPIO3_RXLED_MODE) /* GPIO 3 */
1657                         priv->gpio_altfunc |= BIT(3);
1658         } else {
1659                 priv->gpio_altfunc = (gpio_ctrl >> 2) & 0x0f;
1660         }
1661
1662         /*
1663          * The CP2102N does not strictly has input and output pin modes,
1664          * it only knows open-drain and push-pull modes which is set at
1665          * factory. An open-drain pin can function both as an
1666          * input or an output. We emulate input mode for open-drain pins
1667          * by making sure they are not driven low, and we do not allow
1668          * push-pull pins to be set as an input.
1669          */
1670         for (i = 0; i < priv->gc.ngpio; ++i) {
1671                 /*
1672                  * Set direction to "input" iff pin is open-drain and reset
1673                  * value is 1.
1674                  */
1675                 if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1676                         priv->gpio_input |= BIT(i);
1677         }
1678
1679         return 0;
1680 }
1681
1682 static int cp210x_gpio_init(struct usb_serial *serial)
1683 {
1684         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1685         int result;
1686
1687         switch (priv->partnum) {
1688         case CP210X_PARTNUM_CP2105:
1689                 result = cp2105_gpioconf_init(serial);
1690                 break;
1691         case CP210X_PARTNUM_CP2102N_QFN28:
1692         case CP210X_PARTNUM_CP2102N_QFN24:
1693         case CP210X_PARTNUM_CP2102N_QFN20:
1694                 result = cp2102n_gpioconf_init(serial);
1695                 break;
1696         default:
1697                 return 0;
1698         }
1699
1700         if (result < 0)
1701                 return result;
1702
1703         priv->gc.label = "cp210x";
1704         priv->gc.request = cp210x_gpio_request;
1705         priv->gc.get_direction = cp210x_gpio_direction_get;
1706         priv->gc.direction_input = cp210x_gpio_direction_input;
1707         priv->gc.direction_output = cp210x_gpio_direction_output;
1708         priv->gc.get = cp210x_gpio_get;
1709         priv->gc.set = cp210x_gpio_set;
1710         priv->gc.set_config = cp210x_gpio_set_config;
1711         priv->gc.owner = THIS_MODULE;
1712         priv->gc.parent = &serial->interface->dev;
1713         priv->gc.base = -1;
1714         priv->gc.can_sleep = true;
1715
1716         result = gpiochip_add_data(&priv->gc, serial);
1717         if (!result)
1718                 priv->gpio_registered = true;
1719
1720         return result;
1721 }
1722
1723 static void cp210x_gpio_remove(struct usb_serial *serial)
1724 {
1725         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1726
1727         if (priv->gpio_registered) {
1728                 gpiochip_remove(&priv->gc);
1729                 priv->gpio_registered = false;
1730         }
1731 }
1732
1733 #else
1734
1735 static int cp210x_gpio_init(struct usb_serial *serial)
1736 {
1737         return 0;
1738 }
1739
1740 static void cp210x_gpio_remove(struct usb_serial *serial)
1741 {
1742         /* Nothing to do */
1743 }
1744
1745 #endif
1746
1747 static int cp210x_port_probe(struct usb_serial_port *port)
1748 {
1749         struct usb_serial *serial = port->serial;
1750         struct cp210x_port_private *port_priv;
1751         int ret;
1752
1753         port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
1754         if (!port_priv)
1755                 return -ENOMEM;
1756
1757         port_priv->bInterfaceNumber = cp210x_interface_num(serial);
1758
1759         usb_set_serial_port_data(port, port_priv);
1760
1761         ret = cp210x_detect_swapped_line_ctl(port);
1762         if (ret) {
1763                 kfree(port_priv);
1764                 return ret;
1765         }
1766
1767         return 0;
1768 }
1769
1770 static int cp210x_port_remove(struct usb_serial_port *port)
1771 {
1772         struct cp210x_port_private *port_priv;
1773
1774         port_priv = usb_get_serial_port_data(port);
1775         kfree(port_priv);
1776
1777         return 0;
1778 }
1779
1780 static void cp210x_init_max_speed(struct usb_serial *serial)
1781 {
1782         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1783         bool use_actual_rate = false;
1784         speed_t max;
1785
1786         switch (priv->partnum) {
1787         case CP210X_PARTNUM_CP2101:
1788                 max = 921600;
1789                 break;
1790         case CP210X_PARTNUM_CP2102:
1791         case CP210X_PARTNUM_CP2103:
1792                 max = 1000000;
1793                 break;
1794         case CP210X_PARTNUM_CP2104:
1795                 use_actual_rate = true;
1796                 max = 2000000;
1797                 break;
1798         case CP210X_PARTNUM_CP2108:
1799                 max = 2000000;
1800                 break;
1801         case CP210X_PARTNUM_CP2105:
1802                 if (cp210x_interface_num(serial) == 0) {
1803                         use_actual_rate = true;
1804                         max = 2000000;  /* ECI */
1805                 } else {
1806                         max = 921600;   /* SCI */
1807                 }
1808                 break;
1809         case CP210X_PARTNUM_CP2102N_QFN28:
1810         case CP210X_PARTNUM_CP2102N_QFN24:
1811         case CP210X_PARTNUM_CP2102N_QFN20:
1812                 use_actual_rate = true;
1813                 max = 3000000;
1814                 break;
1815         default:
1816                 max = 2000000;
1817                 break;
1818         }
1819
1820         priv->max_speed = max;
1821         priv->use_actual_rate = use_actual_rate;
1822 }
1823
1824 static int cp210x_attach(struct usb_serial *serial)
1825 {
1826         int result;
1827         struct cp210x_serial_private *priv;
1828
1829         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1830         if (!priv)
1831                 return -ENOMEM;
1832
1833         result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1834                                           CP210X_GET_PARTNUM, &priv->partnum,
1835                                           sizeof(priv->partnum));
1836         if (result < 0) {
1837                 dev_warn(&serial->interface->dev,
1838                          "querying part number failed\n");
1839                 priv->partnum = CP210X_PARTNUM_UNKNOWN;
1840         }
1841
1842         usb_set_serial_data(serial, priv);
1843
1844         cp210x_init_max_speed(serial);
1845
1846         result = cp210x_gpio_init(serial);
1847         if (result < 0) {
1848                 dev_err(&serial->interface->dev, "GPIO initialisation failed: %d\n",
1849                                 result);
1850         }
1851
1852         return 0;
1853 }
1854
1855 static void cp210x_disconnect(struct usb_serial *serial)
1856 {
1857         cp210x_gpio_remove(serial);
1858 }
1859
1860 static void cp210x_release(struct usb_serial *serial)
1861 {
1862         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1863
1864         cp210x_gpio_remove(serial);
1865
1866         kfree(priv);
1867 }
1868
1869 module_usb_serial_driver(serial_drivers, id_table);
1870
1871 MODULE_DESCRIPTION(DRIVER_DESC);
1872 MODULE_LICENSE("GPL v2");