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