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  * Copyright (C) 2010-2021 Johan Hovold (johan@kernel.org)
   7  *
   8  * Support to set flow control line levels using TIOCMGET and TIOCMSET
   9  * thanks to Karl Hiramoto karl@hiramoto.org. RTSCTS hardware flow
  10  * control thanks to Munir Nassar nassarmu@real-time.com
  11  *
  12  */
  13
  14 #include <linux/kernel.h>
  15 #include <linux/errno.h>
  16 #include <linux/slab.h>
  17 #include <linux/tty.h>
  18 #include <linux/tty_flip.h>
  19 #include <linux/module.h>
  20 #include <linux/usb.h>
  21 #include <linux/usb/serial.h>
  22 #include <linux/gpio/driver.h>
  23 #include <linux/bitops.h>
  24 #include <linux/mutex.h>
  25
  26 #define DRIVER_DESC "Silicon Labs CP210x RS232 serial adaptor driver"
  27
  28 /*
  29  * Function Prototypes
  30  */
  31 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *);
  32 static void cp210x_close(struct usb_serial_port *);
  33 static void cp210x_change_speed(struct tty_struct *, struct usb_serial_port *,
  34                                                         struct ktermios *);
  35 static void cp210x_set_termios(struct tty_struct *, struct usb_serial_port *,
  36                                                         struct ktermios*);
  37 static bool cp210x_tx_empty(struct usb_serial_port *port);
  38 static int cp210x_tiocmget(struct tty_struct *);
  39 static int cp210x_tiocmset(struct tty_struct *, unsigned int, unsigned int);
  40 static int cp210x_tiocmset_port(struct usb_serial_port *port,
  41                 unsigned int, unsigned int);
  42 static void cp210x_break_ctl(struct tty_struct *, int);
  43 static int cp210x_attach(struct usb_serial *);
  44 static void cp210x_disconnect(struct usb_serial *);
  45 static void cp210x_release(struct usb_serial *);
  46 static int cp210x_port_probe(struct usb_serial_port *);
  47 static void cp210x_port_remove(struct usb_serial_port *);
  48 static void cp210x_dtr_rts(struct usb_serial_port *port, int on);
  49 static void cp210x_process_read_urb(struct urb *urb);
  50 static void cp210x_enable_event_mode(struct usb_serial_port *port);
  51 static void cp210x_disable_event_mode(struct usb_serial_port *port);
  52
  53 static const struct usb_device_id id_table[] = {
  54         { USB_DEVICE(0x0404, 0x034C) }, /* NCR Retail IO Box */
  55         { USB_DEVICE(0x045B, 0x0053) }, /* Renesas RX610 RX-Stick */
  56         { USB_DEVICE(0x0471, 0x066A) }, /* AKTAKOM ACE-1001 cable */
  57         { USB_DEVICE(0x0489, 0xE000) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
  58         { USB_DEVICE(0x0489, 0xE003) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
  59         { USB_DEVICE(0x0745, 0x1000) }, /* CipherLab USB CCD Barcode Scanner 1000 */
  60         { USB_DEVICE(0x0846, 0x1100) }, /* NetGear Managed Switch M4100 series, M5300 series, M7100 series */
  61         { USB_DEVICE(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
  62         { USB_DEVICE(0x08FD, 0x000A) }, /* Digianswer A/S , ZigBee/802.15.4 MAC Device */
  63         { USB_DEVICE(0x0908, 0x0070) }, /* Siemens SCALANCE LPE-9000 USB Serial Console */
  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, 0x0011) }, /* Kamstrup 444 MHz RF sniffer */
 200         { USB_DEVICE(0x17A8, 0x0013) }, /* Kamstrup 870 MHz RF sniffer */
 201         { USB_DEVICE(0x17A8, 0x0101) }, /* Kamstrup 868 MHz wM-Bus C-Mode Meter Reader (Int Ant) */
 202         { USB_DEVICE(0x17A8, 0x0102) }, /* Kamstrup 868 MHz wM-Bus C-Mode Meter Reader (Ext Ant) */
 203         { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */
 204         { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */
 205         { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
 206         { USB_DEVICE(0x18EF, 0xE025) }, /* ELV Marble Sound Board 1 */
 207         { USB_DEVICE(0x18EF, 0xE030) }, /* ELV ALC 8xxx Battery Charger */
 208         { USB_DEVICE(0x18EF, 0xE032) }, /* ELV TFD500 Data Logger */
 209         { USB_DEVICE(0x1901, 0x0190) }, /* GE B850 CP2105 Recorder interface */
 210         { USB_DEVICE(0x1901, 0x0193) }, /* GE B650 CP2104 PMC interface */
 211         { USB_DEVICE(0x1901, 0x0194) }, /* GE Healthcare Remote Alarm Box */
 212         { USB_DEVICE(0x1901, 0x0195) }, /* GE B850/B650/B450 CP2104 DP UART interface */
 213         { USB_DEVICE(0x1901, 0x0196) }, /* GE B850 CP2105 DP UART interface */
 214         { USB_DEVICE(0x1901, 0x0197) }, /* GE CS1000 M.2 Key E serial interface */
 215         { USB_DEVICE(0x1901, 0x0198) }, /* GE CS1000 Display serial interface */
 216         { USB_DEVICE(0x199B, 0xBA30) }, /* LORD WSDA-200-USB */
 217         { USB_DEVICE(0x19CF, 0x3000) }, /* Parrot NMEA GPS Flight Recorder */
 218         { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */
 219         { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */
 220         { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */
 221         { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */
 222         { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */
 223         { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */
 224         { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */
 225         { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */
 226         { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */
 227         { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */
 228         { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */
 229         { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */
 230         { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */
 231         { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */
 232         { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */
 233         { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */
 234         { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */
 235         { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */
 236         { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */
 237         { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */
 238         { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */
 239         { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */
 240         { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */
 241         { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */
 242         { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */
 243         { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */
 244         { USB_DEVICE(0x2184, 0x0030) }, /* GW Instek GDM-834x Digital Multimeter */
 245         { USB_DEVICE(0x2626, 0xEA60) }, /* Aruba Networks 7xxx USB Serial Console */
 246         { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */
 247         { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */
 248         { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */
 249         { USB_DEVICE(0x3923, 0x7A0B) }, /* National Instruments USB Serial Console */
 250         { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
 251         { } /* Terminating Entry */
 252 };
 253
 254 MODULE_DEVICE_TABLE(usb, id_table);
 255
 256 struct cp210x_serial_private {
 257 #ifdef CONFIG_GPIOLIB
 258         struct gpio_chip        gc;
 259         bool                    gpio_registered;
 260         u16                     gpio_pushpull;
 261         u16                     gpio_altfunc;
 262         u16                     gpio_input;
 263 #endif
 264         u8                      partnum;
 265         u32                     fw_version;
 266         speed_t                 min_speed;
 267         speed_t                 max_speed;
 268         bool                    use_actual_rate;
 269         bool                    no_flow_control;
 270         bool                    no_event_mode;
 271 };
 272
 273 enum cp210x_event_state {
 274         ES_DATA,
 275         ES_ESCAPE,
 276         ES_LSR,
 277         ES_LSR_DATA_0,
 278         ES_LSR_DATA_1,
 279         ES_MSR
 280 };
 281
 282 struct cp210x_port_private {
 283         u8                      bInterfaceNumber;
 284         bool                    event_mode;
 285         enum cp210x_event_state event_state;
 286         u8                      lsr;
 287
 288         struct mutex            mutex;
 289         bool                    crtscts;
 290         bool                    dtr;
 291         bool                    rts;
 292 };
 293
 294 static struct usb_serial_driver cp210x_device = {
 295         .driver = {
 296                 .owner =        THIS_MODULE,
 297                 .name =         "cp210x",
 298         },
 299         .id_table               = id_table,
 300         .num_ports              = 1,
 301         .bulk_in_size           = 256,
 302         .bulk_out_size          = 256,
 303         .open                   = cp210x_open,
 304         .close                  = cp210x_close,
 305         .break_ctl              = cp210x_break_ctl,
 306         .set_termios            = cp210x_set_termios,
 307         .tx_empty               = cp210x_tx_empty,
 308         .throttle               = usb_serial_generic_throttle,
 309         .unthrottle             = usb_serial_generic_unthrottle,
 310         .tiocmget               = cp210x_tiocmget,
 311         .tiocmset               = cp210x_tiocmset,
 312         .get_icount             = usb_serial_generic_get_icount,
 313         .attach                 = cp210x_attach,
 314         .disconnect             = cp210x_disconnect,
 315         .release                = cp210x_release,
 316         .port_probe             = cp210x_port_probe,
 317         .port_remove            = cp210x_port_remove,
 318         .dtr_rts                = cp210x_dtr_rts,
 319         .process_read_urb       = cp210x_process_read_urb,
 320 };
 321
 322 static struct usb_serial_driver * const serial_drivers[] = {
 323         &cp210x_device, NULL
 324 };
 325
 326 /* Config request types */
 327 #define REQTYPE_HOST_TO_INTERFACE       0x41
 328 #define REQTYPE_INTERFACE_TO_HOST       0xc1
 329 #define REQTYPE_HOST_TO_DEVICE  0x40
 330 #define REQTYPE_DEVICE_TO_HOST  0xc0
 331
 332 /* Config request codes */
 333 #define CP210X_IFC_ENABLE       0x00
 334 #define CP210X_SET_BAUDDIV      0x01
 335 #define CP210X_GET_BAUDDIV      0x02
 336 #define CP210X_SET_LINE_CTL     0x03
 337 #define CP210X_GET_LINE_CTL     0x04
 338 #define CP210X_SET_BREAK        0x05
 339 #define CP210X_IMM_CHAR         0x06
 340 #define CP210X_SET_MHS          0x07
 341 #define CP210X_GET_MDMSTS       0x08
 342 #define CP210X_SET_XON          0x09
 343 #define CP210X_SET_XOFF         0x0A
 344 #define CP210X_SET_EVENTMASK    0x0B
 345 #define CP210X_GET_EVENTMASK    0x0C
 346 #define CP210X_SET_CHAR         0x0D
 347 #define CP210X_GET_CHARS        0x0E
 348 #define CP210X_GET_PROPS        0x0F
 349 #define CP210X_GET_COMM_STATUS  0x10
 350 #define CP210X_RESET            0x11
 351 #define CP210X_PURGE            0x12
 352 #define CP210X_SET_FLOW         0x13
 353 #define CP210X_GET_FLOW         0x14
 354 #define CP210X_EMBED_EVENTS     0x15
 355 #define CP210X_GET_EVENTSTATE   0x16
 356 #define CP210X_SET_CHARS        0x19
 357 #define CP210X_GET_BAUDRATE     0x1D
 358 #define CP210X_SET_BAUDRATE     0x1E
 359 #define CP210X_VENDOR_SPECIFIC  0xFF
 360
 361 /* CP210X_IFC_ENABLE */
 362 #define UART_ENABLE             0x0001
 363 #define UART_DISABLE            0x0000
 364
 365 /* CP210X_(SET|GET)_BAUDDIV */
 366 #define BAUD_RATE_GEN_FREQ      0x384000
 367
 368 /* CP210X_(SET|GET)_LINE_CTL */
 369 #define BITS_DATA_MASK          0X0f00
 370 #define BITS_DATA_5             0X0500
 371 #define BITS_DATA_6             0X0600
 372 #define BITS_DATA_7             0X0700
 373 #define BITS_DATA_8             0X0800
 374 #define BITS_DATA_9             0X0900
 375
 376 #define BITS_PARITY_MASK        0x00f0
 377 #define BITS_PARITY_NONE        0x0000
 378 #define BITS_PARITY_ODD         0x0010
 379 #define BITS_PARITY_EVEN        0x0020
 380 #define BITS_PARITY_MARK        0x0030
 381 #define BITS_PARITY_SPACE       0x0040
 382
 383 #define BITS_STOP_MASK          0x000f
 384 #define BITS_STOP_1             0x0000
 385 #define BITS_STOP_1_5           0x0001
 386 #define BITS_STOP_2             0x0002
 387
 388 /* CP210X_SET_BREAK */
 389 #define BREAK_ON                0x0001
 390 #define BREAK_OFF               0x0000
 391
 392 /* CP210X_(SET_MHS|GET_MDMSTS) */
 393 #define CONTROL_DTR             0x0001
 394 #define CONTROL_RTS             0x0002
 395 #define CONTROL_CTS             0x0010
 396 #define CONTROL_DSR             0x0020
 397 #define CONTROL_RING            0x0040
 398 #define CONTROL_DCD             0x0080
 399 #define CONTROL_WRITE_DTR       0x0100
 400 #define CONTROL_WRITE_RTS       0x0200
 401
 402 /* CP210X_(GET|SET)_CHARS */
 403 struct cp210x_special_chars {
 404         u8      bEofChar;
 405         u8      bErrorChar;
 406         u8      bBreakChar;
 407         u8      bEventChar;
 408         u8      bXonChar;
 409         u8      bXoffChar;
 410 };
 411
 412 /* CP210X_VENDOR_SPECIFIC values */
 413 #define CP210X_GET_FW_VER       0x000E
 414 #define CP210X_READ_2NCONFIG    0x000E
 415 #define CP210X_GET_FW_VER_2N    0x0010
 416 #define CP210X_READ_LATCH       0x00C2
 417 #define CP210X_GET_PARTNUM      0x370B
 418 #define CP210X_GET_PORTCONFIG   0x370C
 419 #define CP210X_GET_DEVICEMODE   0x3711
 420 #define CP210X_WRITE_LATCH      0x37E1
 421
 422 /* Part number definitions */
 423 #define CP210X_PARTNUM_CP2101   0x01
 424 #define CP210X_PARTNUM_CP2102   0x02
 425 #define CP210X_PARTNUM_CP2103   0x03
 426 #define CP210X_PARTNUM_CP2104   0x04
 427 #define CP210X_PARTNUM_CP2105   0x05
 428 #define CP210X_PARTNUM_CP2108   0x08
 429 #define CP210X_PARTNUM_CP2102N_QFN28    0x20
 430 #define CP210X_PARTNUM_CP2102N_QFN24    0x21
 431 #define CP210X_PARTNUM_CP2102N_QFN20    0x22
 432 #define CP210X_PARTNUM_UNKNOWN  0xFF
 433
 434 /* CP210X_GET_COMM_STATUS returns these 0x13 bytes */
 435 struct cp210x_comm_status {
 436         __le32   ulErrors;
 437         __le32   ulHoldReasons;
 438         __le32   ulAmountInInQueue;
 439         __le32   ulAmountInOutQueue;
 440         u8       bEofReceived;
 441         u8       bWaitForImmediate;
 442         u8       bReserved;
 443 } __packed;
 444
 445 /*
 446  * CP210X_PURGE - 16 bits passed in wValue of USB request.
 447  * SiLabs app note AN571 gives a strange description of the 4 bits:
 448  * bit 0 or bit 2 clears the transmit queue and 1 or 3 receive.
 449  * writing 1 to all, however, purges cp2108 well enough to avoid the hang.
 450  */
 451 #define PURGE_ALL               0x000f
 452
 453 /* CP210X_EMBED_EVENTS */
 454 #define CP210X_ESCCHAR          0xec
 455
 456 #define CP210X_LSR_OVERRUN      BIT(1)
 457 #define CP210X_LSR_PARITY       BIT(2)
 458 #define CP210X_LSR_FRAME        BIT(3)
 459 #define CP210X_LSR_BREAK        BIT(4)
 460
 461
 462 /* CP210X_GET_FLOW/CP210X_SET_FLOW read/write these 0x10 bytes */
 463 struct cp210x_flow_ctl {
 464         __le32  ulControlHandshake;
 465         __le32  ulFlowReplace;
 466         __le32  ulXonLimit;
 467         __le32  ulXoffLimit;
 468 };
 469
 470 /* cp210x_flow_ctl::ulControlHandshake */
 471 #define CP210X_SERIAL_DTR_MASK          GENMASK(1, 0)
 472 #define CP210X_SERIAL_DTR_INACTIVE      (0 << 0)
 473 #define CP210X_SERIAL_DTR_ACTIVE        (1 << 0)
 474 #define CP210X_SERIAL_DTR_FLOW_CTL      (2 << 0)
 475 #define CP210X_SERIAL_CTS_HANDSHAKE     BIT(3)
 476 #define CP210X_SERIAL_DSR_HANDSHAKE     BIT(4)
 477 #define CP210X_SERIAL_DCD_HANDSHAKE     BIT(5)
 478 #define CP210X_SERIAL_DSR_SENSITIVITY   BIT(6)
 479
 480 /* cp210x_flow_ctl::ulFlowReplace */
 481 #define CP210X_SERIAL_AUTO_TRANSMIT     BIT(0)
 482 #define CP210X_SERIAL_AUTO_RECEIVE      BIT(1)
 483 #define CP210X_SERIAL_ERROR_CHAR        BIT(2)
 484 #define CP210X_SERIAL_NULL_STRIPPING    BIT(3)
 485 #define CP210X_SERIAL_BREAK_CHAR        BIT(4)
 486 #define CP210X_SERIAL_RTS_MASK          GENMASK(7, 6)
 487 #define CP210X_SERIAL_RTS_INACTIVE      (0 << 6)
 488 #define CP210X_SERIAL_RTS_ACTIVE        (1 << 6)
 489 #define CP210X_SERIAL_RTS_FLOW_CTL      (2 << 6)
 490 #define CP210X_SERIAL_XOFF_CONTINUE     BIT(31)
 491
 492 /* CP210X_VENDOR_SPECIFIC, CP210X_GET_DEVICEMODE call reads these 0x2 bytes. */
 493 struct cp210x_pin_mode {
 494         u8      eci;
 495         u8      sci;
 496 };
 497
 498 #define CP210X_PIN_MODE_MODEM           0
 499 #define CP210X_PIN_MODE_GPIO            BIT(0)
 500
 501 /*
 502  * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xf bytes
 503  * on a CP2105 chip. Structure needs padding due to unused/unspecified bytes.
 504  */
 505 struct cp210x_dual_port_config {
 506         __le16  gpio_mode;
 507         u8      __pad0[2];
 508         __le16  reset_state;
 509         u8      __pad1[4];
 510         __le16  suspend_state;
 511         u8      sci_cfg;
 512         u8      eci_cfg;
 513         u8      device_cfg;
 514 } __packed;
 515
 516 /*
 517  * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xd bytes
 518  * on a CP2104 chip. Structure needs padding due to unused/unspecified bytes.
 519  */
 520 struct cp210x_single_port_config {
 521         __le16  gpio_mode;
 522         u8      __pad0[2];
 523         __le16  reset_state;
 524         u8      __pad1[4];
 525         __le16  suspend_state;
 526         u8      device_cfg;
 527 } __packed;
 528
 529 /* GPIO modes */
 530 #define CP210X_SCI_GPIO_MODE_OFFSET     9
 531 #define CP210X_SCI_GPIO_MODE_MASK       GENMASK(11, 9)
 532
 533 #define CP210X_ECI_GPIO_MODE_OFFSET     2
 534 #define CP210X_ECI_GPIO_MODE_MASK       GENMASK(3, 2)
 535
 536 #define CP210X_GPIO_MODE_OFFSET         8
 537 #define CP210X_GPIO_MODE_MASK           GENMASK(11, 8)
 538
 539 /* CP2105 port configuration values */
 540 #define CP2105_GPIO0_TXLED_MODE         BIT(0)
 541 #define CP2105_GPIO1_RXLED_MODE         BIT(1)
 542 #define CP2105_GPIO1_RS485_MODE         BIT(2)
 543
 544 /* CP2104 port configuration values */
 545 #define CP2104_GPIO0_TXLED_MODE         BIT(0)
 546 #define CP2104_GPIO1_RXLED_MODE         BIT(1)
 547 #define CP2104_GPIO2_RS485_MODE         BIT(2)
 548
 549 struct cp210x_quad_port_state {
 550         __le16 gpio_mode_pb0;
 551         __le16 gpio_mode_pb1;
 552         __le16 gpio_mode_pb2;
 553         __le16 gpio_mode_pb3;
 554         __le16 gpio_mode_pb4;
 555
 556         __le16 gpio_lowpower_pb0;
 557         __le16 gpio_lowpower_pb1;
 558         __le16 gpio_lowpower_pb2;
 559         __le16 gpio_lowpower_pb3;
 560         __le16 gpio_lowpower_pb4;
 561
 562         __le16 gpio_latch_pb0;
 563         __le16 gpio_latch_pb1;
 564         __le16 gpio_latch_pb2;
 565         __le16 gpio_latch_pb3;
 566         __le16 gpio_latch_pb4;
 567 };
 568
 569 /*
 570  * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0x49 bytes
 571  * on a CP2108 chip.
 572  *
 573  * See https://www.silabs.com/documents/public/application-notes/an978-cp210x-usb-to-uart-api-specification.pdf
 574  */
 575 struct cp210x_quad_port_config {
 576         struct cp210x_quad_port_state reset_state;
 577         struct cp210x_quad_port_state suspend_state;
 578         u8 ipdelay_ifc[4];
 579         u8 enhancedfxn_ifc[4];
 580         u8 enhancedfxn_device;
 581         u8 extclkfreq[4];
 582 } __packed;
 583
 584 #define CP2108_EF_IFC_GPIO_TXLED                0x01
 585 #define CP2108_EF_IFC_GPIO_RXLED                0x02
 586 #define CP2108_EF_IFC_GPIO_RS485                0x04
 587 #define CP2108_EF_IFC_GPIO_RS485_LOGIC          0x08
 588 #define CP2108_EF_IFC_GPIO_CLOCK                0x10
 589 #define CP2108_EF_IFC_DYNAMIC_SUSPEND           0x40
 590
 591 /* CP2102N configuration array indices */
 592 #define CP210X_2NCONFIG_CONFIG_VERSION_IDX      2
 593 #define CP210X_2NCONFIG_GPIO_MODE_IDX           581
 594 #define CP210X_2NCONFIG_GPIO_RSTLATCH_IDX       587
 595 #define CP210X_2NCONFIG_GPIO_CONTROL_IDX        600
 596
 597 /* CP2102N QFN20 port configuration values */
 598 #define CP2102N_QFN20_GPIO2_TXLED_MODE          BIT(2)
 599 #define CP2102N_QFN20_GPIO3_RXLED_MODE          BIT(3)
 600 #define CP2102N_QFN20_GPIO1_RS485_MODE          BIT(4)
 601 #define CP2102N_QFN20_GPIO0_CLK_MODE            BIT(6)
 602
 603 /*
 604  * CP210X_VENDOR_SPECIFIC, CP210X_WRITE_LATCH call writes these 0x02 bytes
 605  * for CP2102N, CP2103, CP2104 and CP2105.
 606  */
 607 struct cp210x_gpio_write {
 608         u8      mask;
 609         u8      state;
 610 };
 611
 612 /*
 613  * CP210X_VENDOR_SPECIFIC, CP210X_WRITE_LATCH call writes these 0x04 bytes
 614  * for CP2108.
 615  */
 616 struct cp210x_gpio_write16 {
 617         __le16  mask;
 618         __le16  state;
 619 };
 620
 621 /*
 622  * Helper to get interface number when we only have struct usb_serial.
 623  */
 624 static u8 cp210x_interface_num(struct usb_serial *serial)
 625 {
 626         struct usb_host_interface *cur_altsetting;
 627
 628         cur_altsetting = serial->interface->cur_altsetting;
 629
 630         return cur_altsetting->desc.bInterfaceNumber;
 631 }
 632
 633 /*
 634  * Reads a variable-sized block of CP210X_ registers, identified by req.
 635  * Returns data into buf in native USB byte order.
 636  */
 637 static int cp210x_read_reg_block(struct usb_serial_port *port, u8 req,
 638                 void *buf, int bufsize)
 639 {
 640         struct usb_serial *serial = port->serial;
 641         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 642         void *dmabuf;
 643         int result;
 644
 645         dmabuf = kmalloc(bufsize, GFP_KERNEL);
 646         if (!dmabuf)
 647                 return -ENOMEM;
 648
 649         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 650                         req, REQTYPE_INTERFACE_TO_HOST, 0,
 651                         port_priv->bInterfaceNumber, dmabuf, bufsize,
 652                         USB_CTRL_GET_TIMEOUT);
 653         if (result == bufsize) {
 654                 memcpy(buf, dmabuf, bufsize);
 655                 result = 0;
 656         } else {
 657                 dev_err(&port->dev, "failed get req 0x%x size %d status: %d\n",
 658                                 req, bufsize, result);
 659                 if (result >= 0)
 660                         result = -EIO;
 661         }
 662
 663         kfree(dmabuf);
 664
 665         return result;
 666 }
 667
 668 /*
 669  * Reads any 8-bit CP210X_ register identified by req.
 670  */
 671 static int cp210x_read_u8_reg(struct usb_serial_port *port, u8 req, u8 *val)
 672 {
 673         return cp210x_read_reg_block(port, req, val, sizeof(*val));
 674 }
 675
 676 /*
 677  * Reads a variable-sized vendor block of CP210X_ registers, identified by val.
 678  * Returns data into buf in native USB byte order.
 679  */
 680 static int cp210x_read_vendor_block(struct usb_serial *serial, u8 type, u16 val,
 681                                     void *buf, int bufsize)
 682 {
 683         void *dmabuf;
 684         int result;
 685
 686         dmabuf = kmalloc(bufsize, GFP_KERNEL);
 687         if (!dmabuf)
 688                 return -ENOMEM;
 689
 690         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 691                                  CP210X_VENDOR_SPECIFIC, type, val,
 692                                  cp210x_interface_num(serial), dmabuf, bufsize,
 693                                  USB_CTRL_GET_TIMEOUT);
 694         if (result == bufsize) {
 695                 memcpy(buf, dmabuf, bufsize);
 696                 result = 0;
 697         } else {
 698                 dev_err(&serial->interface->dev,
 699                         "failed to get vendor val 0x%04x size %d: %d\n", val,
 700                         bufsize, result);
 701                 if (result >= 0)
 702                         result = -EIO;
 703         }
 704
 705         kfree(dmabuf);
 706
 707         return result;
 708 }
 709
 710 /*
 711  * Writes any 16-bit CP210X_ register (req) whose value is passed
 712  * entirely in the wValue field of the USB request.
 713  */
 714 static int cp210x_write_u16_reg(struct usb_serial_port *port, u8 req, u16 val)
 715 {
 716         struct usb_serial *serial = port->serial;
 717         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 718         int result;
 719
 720         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 721                         req, REQTYPE_HOST_TO_INTERFACE, val,
 722                         port_priv->bInterfaceNumber, NULL, 0,
 723                         USB_CTRL_SET_TIMEOUT);
 724         if (result < 0) {
 725                 dev_err(&port->dev, "failed set request 0x%x status: %d\n",
 726                                 req, result);
 727         }
 728
 729         return result;
 730 }
 731
 732 /*
 733  * Writes a variable-sized block of CP210X_ registers, identified by req.
 734  * Data in buf must be in native USB byte order.
 735  */
 736 static int cp210x_write_reg_block(struct usb_serial_port *port, u8 req,
 737                 void *buf, int bufsize)
 738 {
 739         struct usb_serial *serial = port->serial;
 740         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 741         void *dmabuf;
 742         int result;
 743
 744         dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
 745         if (!dmabuf)
 746                 return -ENOMEM;
 747
 748         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 749                         req, REQTYPE_HOST_TO_INTERFACE, 0,
 750                         port_priv->bInterfaceNumber, dmabuf, bufsize,
 751                         USB_CTRL_SET_TIMEOUT);
 752
 753         kfree(dmabuf);
 754
 755         if (result < 0) {
 756                 dev_err(&port->dev, "failed set req 0x%x size %d status: %d\n",
 757                                 req, bufsize, result);
 758                 return result;
 759         }
 760
 761         return 0;
 762 }
 763
 764 /*
 765  * Writes any 32-bit CP210X_ register identified by req.
 766  */
 767 static int cp210x_write_u32_reg(struct usb_serial_port *port, u8 req, u32 val)
 768 {
 769         __le32 le32_val;
 770
 771         le32_val = cpu_to_le32(val);
 772
 773         return cp210x_write_reg_block(port, req, &le32_val, sizeof(le32_val));
 774 }
 775
 776 #ifdef CONFIG_GPIOLIB
 777 /*
 778  * Writes a variable-sized vendor block of CP210X_ registers, identified by val.
 779  * Data in buf must be in native USB byte order.
 780  */
 781 static int cp210x_write_vendor_block(struct usb_serial *serial, u8 type,
 782                                      u16 val, void *buf, int bufsize)
 783 {
 784         void *dmabuf;
 785         int result;
 786
 787         dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
 788         if (!dmabuf)
 789                 return -ENOMEM;
 790
 791         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 792                                  CP210X_VENDOR_SPECIFIC, type, val,
 793                                  cp210x_interface_num(serial), dmabuf, bufsize,
 794                                  USB_CTRL_SET_TIMEOUT);
 795
 796         kfree(dmabuf);
 797
 798         if (result < 0) {
 799                 dev_err(&serial->interface->dev,
 800                         "failed to set vendor val 0x%04x size %d: %d\n", val,
 801                         bufsize, result);
 802                 return result;
 803         }
 804
 805         return 0;
 806 }
 807 #endif
 808
 809 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
 810 {
 811         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 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         if (tty)
 821                 cp210x_set_termios(tty, port, NULL);
 822
 823         result = usb_serial_generic_open(tty, port);
 824         if (result)
 825                 goto err_disable;
 826
 827         return 0;
 828
 829 err_disable:
 830         cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
 831         port_priv->event_mode = false;
 832
 833         return result;
 834 }
 835
 836 static void cp210x_close(struct usb_serial_port *port)
 837 {
 838         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 839
 840         usb_serial_generic_close(port);
 841
 842         /* Clear both queues; cp2108 needs this to avoid an occasional hang */
 843         cp210x_write_u16_reg(port, CP210X_PURGE, PURGE_ALL);
 844
 845         cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
 846
 847         /* Disabling the interface disables event-insertion mode. */
 848         port_priv->event_mode = false;
 849 }
 850
 851 static void cp210x_process_lsr(struct usb_serial_port *port, unsigned char lsr, char *flag)
 852 {
 853         if (lsr & CP210X_LSR_BREAK) {
 854                 port->icount.brk++;
 855                 *flag = TTY_BREAK;
 856         } else if (lsr & CP210X_LSR_PARITY) {
 857                 port->icount.parity++;
 858                 *flag = TTY_PARITY;
 859         } else if (lsr & CP210X_LSR_FRAME) {
 860                 port->icount.frame++;
 861                 *flag = TTY_FRAME;
 862         }
 863
 864         if (lsr & CP210X_LSR_OVERRUN) {
 865                 port->icount.overrun++;
 866                 tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
 867         }
 868 }
 869
 870 static bool cp210x_process_char(struct usb_serial_port *port, unsigned char *ch, char *flag)
 871 {
 872         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 873
 874         switch (port_priv->event_state) {
 875         case ES_DATA:
 876                 if (*ch == CP210X_ESCCHAR) {
 877                         port_priv->event_state = ES_ESCAPE;
 878                         break;
 879                 }
 880                 return false;
 881         case ES_ESCAPE:
 882                 switch (*ch) {
 883                 case 0:
 884                         dev_dbg(&port->dev, "%s - escape char\n", __func__);
 885                         *ch = CP210X_ESCCHAR;
 886                         port_priv->event_state = ES_DATA;
 887                         return false;
 888                 case 1:
 889                         port_priv->event_state = ES_LSR_DATA_0;
 890                         break;
 891                 case 2:
 892                         port_priv->event_state = ES_LSR;
 893                         break;
 894                 case 3:
 895                         port_priv->event_state = ES_MSR;
 896                         break;
 897                 default:
 898                         dev_err(&port->dev, "malformed event 0x%02x\n", *ch);
 899                         port_priv->event_state = ES_DATA;
 900                         break;
 901                 }
 902                 break;
 903         case ES_LSR_DATA_0:
 904                 port_priv->lsr = *ch;
 905                 port_priv->event_state = ES_LSR_DATA_1;
 906                 break;
 907         case ES_LSR_DATA_1:
 908                 dev_dbg(&port->dev, "%s - lsr = 0x%02x, data = 0x%02x\n",
 909                                 __func__, port_priv->lsr, *ch);
 910                 cp210x_process_lsr(port, port_priv->lsr, flag);
 911                 port_priv->event_state = ES_DATA;
 912                 return false;
 913         case ES_LSR:
 914                 dev_dbg(&port->dev, "%s - lsr = 0x%02x\n", __func__, *ch);
 915                 port_priv->lsr = *ch;
 916                 cp210x_process_lsr(port, port_priv->lsr, flag);
 917                 port_priv->event_state = ES_DATA;
 918                 break;
 919         case ES_MSR:
 920                 dev_dbg(&port->dev, "%s - msr = 0x%02x\n", __func__, *ch);
 921                 /* unimplemented */
 922                 port_priv->event_state = ES_DATA;
 923                 break;
 924         }
 925
 926         return true;
 927 }
 928
 929 static void cp210x_process_read_urb(struct urb *urb)
 930 {
 931         struct usb_serial_port *port = urb->context;
 932         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 933         unsigned char *ch = urb->transfer_buffer;
 934         char flag;
 935         int i;
 936
 937         if (!urb->actual_length)
 938                 return;
 939
 940         if (port_priv->event_mode) {
 941                 for (i = 0; i < urb->actual_length; i++, ch++) {
 942                         flag = TTY_NORMAL;
 943
 944                         if (cp210x_process_char(port, ch, &flag))
 945                                 continue;
 946
 947                         tty_insert_flip_char(&port->port, *ch, flag);
 948                 }
 949         } else {
 950                 tty_insert_flip_string(&port->port, ch, urb->actual_length);
 951         }
 952         tty_flip_buffer_push(&port->port);
 953 }
 954
 955 /*
 956  * Read how many bytes are waiting in the TX queue.
 957  */
 958 static int cp210x_get_tx_queue_byte_count(struct usb_serial_port *port,
 959                 u32 *count)
 960 {
 961         struct usb_serial *serial = port->serial;
 962         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 963         struct cp210x_comm_status *sts;
 964         int result;
 965
 966         sts = kmalloc(sizeof(*sts), GFP_KERNEL);
 967         if (!sts)
 968                 return -ENOMEM;
 969
 970         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 971                         CP210X_GET_COMM_STATUS, REQTYPE_INTERFACE_TO_HOST,
 972                         0, port_priv->bInterfaceNumber, sts, sizeof(*sts),
 973                         USB_CTRL_GET_TIMEOUT);
 974         if (result == sizeof(*sts)) {
 975                 *count = le32_to_cpu(sts->ulAmountInOutQueue);
 976                 result = 0;
 977         } else {
 978                 dev_err(&port->dev, "failed to get comm status: %d\n", result);
 979                 if (result >= 0)
 980                         result = -EIO;
 981         }
 982
 983         kfree(sts);
 984
 985         return result;
 986 }
 987
 988 static bool cp210x_tx_empty(struct usb_serial_port *port)
 989 {
 990         int err;
 991         u32 count;
 992
 993         err = cp210x_get_tx_queue_byte_count(port, &count);
 994         if (err)
 995                 return true;
 996
 997         return !count;
 998 }
 999
1000 struct cp210x_rate {
1001         speed_t rate;
1002         speed_t high;
1003 };
1004
1005 static const struct cp210x_rate cp210x_an205_table1[] = {
1006         { 300, 300 },
1007         { 600, 600 },
1008         { 1200, 1200 },
1009         { 1800, 1800 },
1010         { 2400, 2400 },
1011         { 4000, 4000 },
1012         { 4800, 4803 },
1013         { 7200, 7207 },
1014         { 9600, 9612 },
1015         { 14400, 14428 },
1016         { 16000, 16062 },
1017         { 19200, 19250 },
1018         { 28800, 28912 },
1019         { 38400, 38601 },
1020         { 51200, 51558 },
1021         { 56000, 56280 },
1022         { 57600, 58053 },
1023         { 64000, 64111 },
1024         { 76800, 77608 },
1025         { 115200, 117028 },
1026         { 128000, 129347 },
1027         { 153600, 156868 },
1028         { 230400, 237832 },
1029         { 250000, 254234 },
1030         { 256000, 273066 },
1031         { 460800, 491520 },
1032         { 500000, 567138 },
1033         { 576000, 670254 },
1034         { 921600, UINT_MAX }
1035 };
1036
1037 /*
1038  * Quantises the baud rate as per AN205 Table 1
1039  */
1040 static speed_t cp210x_get_an205_rate(speed_t baud)
1041 {
1042         int i;
1043
1044         for (i = 0; i < ARRAY_SIZE(cp210x_an205_table1); ++i) {
1045                 if (baud <= cp210x_an205_table1[i].high)
1046                         break;
1047         }
1048
1049         return cp210x_an205_table1[i].rate;
1050 }
1051
1052 static speed_t cp210x_get_actual_rate(speed_t baud)
1053 {
1054         unsigned int prescale = 1;
1055         unsigned int div;
1056
1057         if (baud <= 365)
1058                 prescale = 4;
1059
1060         div = DIV_ROUND_CLOSEST(48000000, 2 * prescale * baud);
1061         baud = 48000000 / (2 * prescale * div);
1062
1063         return baud;
1064 }
1065
1066 /*
1067  * CP2101 supports the following baud rates:
1068  *
1069  *      300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
1070  *      38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
1071  *
1072  * CP2102 and CP2103 support the following additional rates:
1073  *
1074  *      4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
1075  *      576000
1076  *
1077  * The device will map a requested rate to a supported one, but the result
1078  * of requests for rates greater than 1053257 is undefined (see AN205).
1079  *
1080  * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
1081  * respectively, with an error less than 1%. The actual rates are determined
1082  * by
1083  *
1084  *      div = round(freq / (2 x prescale x request))
1085  *      actual = freq / (2 x prescale x div)
1086  *
1087  * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
1088  * or 1 otherwise.
1089  * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
1090  * otherwise.
1091  */
1092 static void cp210x_change_speed(struct tty_struct *tty,
1093                 struct usb_serial_port *port, struct ktermios *old_termios)
1094 {
1095         struct usb_serial *serial = port->serial;
1096         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1097         u32 baud;
1098
1099         /*
1100          * This maps the requested rate to the actual rate, a valid rate on
1101          * cp2102 or cp2103, or to an arbitrary rate in [1M, max_speed].
1102          *
1103          * NOTE: B0 is not implemented.
1104          */
1105         baud = clamp(tty->termios.c_ospeed, priv->min_speed, priv->max_speed);
1106
1107         if (priv->use_actual_rate)
1108                 baud = cp210x_get_actual_rate(baud);
1109         else if (baud < 1000000)
1110                 baud = cp210x_get_an205_rate(baud);
1111
1112         dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
1113         if (cp210x_write_u32_reg(port, CP210X_SET_BAUDRATE, baud)) {
1114                 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
1115                 if (old_termios)
1116                         baud = old_termios->c_ospeed;
1117                 else
1118                         baud = 9600;
1119         }
1120
1121         tty_encode_baud_rate(tty, baud, baud);
1122 }
1123
1124 static void cp210x_enable_event_mode(struct usb_serial_port *port)
1125 {
1126         struct cp210x_serial_private *priv = usb_get_serial_data(port->serial);
1127         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1128         int ret;
1129
1130         if (port_priv->event_mode)
1131                 return;
1132
1133         if (priv->no_event_mode)
1134                 return;
1135
1136         port_priv->event_state = ES_DATA;
1137         port_priv->event_mode = true;
1138
1139         ret = cp210x_write_u16_reg(port, CP210X_EMBED_EVENTS, CP210X_ESCCHAR);
1140         if (ret) {
1141                 dev_err(&port->dev, "failed to enable events: %d\n", ret);
1142                 port_priv->event_mode = false;
1143         }
1144 }
1145
1146 static void cp210x_disable_event_mode(struct usb_serial_port *port)
1147 {
1148         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1149         int ret;
1150
1151         if (!port_priv->event_mode)
1152                 return;
1153
1154         ret = cp210x_write_u16_reg(port, CP210X_EMBED_EVENTS, 0);
1155         if (ret) {
1156                 dev_err(&port->dev, "failed to disable events: %d\n", ret);
1157                 return;
1158         }
1159
1160         port_priv->event_mode = false;
1161 }
1162
1163 static bool cp210x_termios_change(const struct ktermios *a, const struct ktermios *b)
1164 {
1165         bool iflag_change, cc_change;
1166
1167         iflag_change = ((a->c_iflag ^ b->c_iflag) & (INPCK | IXON | IXOFF));
1168         cc_change = a->c_cc[VSTART] != b->c_cc[VSTART] ||
1169                         a->c_cc[VSTOP] != b->c_cc[VSTOP];
1170
1171         return tty_termios_hw_change(a, b) || iflag_change || cc_change;
1172 }
1173
1174 static void cp210x_set_flow_control(struct tty_struct *tty,
1175                 struct usb_serial_port *port, struct ktermios *old_termios)
1176 {
1177         struct cp210x_serial_private *priv = usb_get_serial_data(port->serial);
1178         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1179         struct cp210x_special_chars chars;
1180         struct cp210x_flow_ctl flow_ctl;
1181         u32 flow_repl;
1182         u32 ctl_hs;
1183         bool crtscts;
1184         int ret;
1185
1186         /*
1187          * Some CP2102N interpret ulXonLimit as ulFlowReplace (erratum
1188          * CP2102N_E104). Report back that flow control is not supported.
1189          */
1190         if (priv->no_flow_control) {
1191                 tty->termios.c_cflag &= ~CRTSCTS;
1192                 tty->termios.c_iflag &= ~(IXON | IXOFF);
1193         }
1194
1195         if (old_termios &&
1196                         C_CRTSCTS(tty) == (old_termios->c_cflag & CRTSCTS) &&
1197                         I_IXON(tty) == (old_termios->c_iflag & IXON) &&
1198                         I_IXOFF(tty) == (old_termios->c_iflag & IXOFF) &&
1199                         START_CHAR(tty) == old_termios->c_cc[VSTART] &&
1200                         STOP_CHAR(tty) == old_termios->c_cc[VSTOP]) {
1201                 return;
1202         }
1203
1204         if (I_IXON(tty) || I_IXOFF(tty)) {
1205                 memset(&chars, 0, sizeof(chars));
1206
1207                 chars.bXonChar = START_CHAR(tty);
1208                 chars.bXoffChar = STOP_CHAR(tty);
1209
1210                 ret = cp210x_write_reg_block(port, CP210X_SET_CHARS, &chars,
1211                                 sizeof(chars));
1212                 if (ret) {
1213                         dev_err(&port->dev, "failed to set special chars: %d\n",
1214                                         ret);
1215                 }
1216         }
1217
1218         mutex_lock(&port_priv->mutex);
1219
1220         ret = cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1221                         sizeof(flow_ctl));
1222         if (ret)
1223                 goto out_unlock;
1224
1225         ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1226         flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1227
1228         ctl_hs &= ~CP210X_SERIAL_DSR_HANDSHAKE;
1229         ctl_hs &= ~CP210X_SERIAL_DCD_HANDSHAKE;
1230         ctl_hs &= ~CP210X_SERIAL_DSR_SENSITIVITY;
1231         ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1232         if (port_priv->dtr)
1233                 ctl_hs |= CP210X_SERIAL_DTR_ACTIVE;
1234         else
1235                 ctl_hs |= CP210X_SERIAL_DTR_INACTIVE;
1236
1237         flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1238         if (C_CRTSCTS(tty)) {
1239                 ctl_hs |= CP210X_SERIAL_CTS_HANDSHAKE;
1240                 if (port_priv->rts)
1241                         flow_repl |= CP210X_SERIAL_RTS_FLOW_CTL;
1242                 else
1243                         flow_repl |= CP210X_SERIAL_RTS_INACTIVE;
1244                 crtscts = true;
1245         } else {
1246                 ctl_hs &= ~CP210X_SERIAL_CTS_HANDSHAKE;
1247                 if (port_priv->rts)
1248                         flow_repl |= CP210X_SERIAL_RTS_ACTIVE;
1249                 else
1250                         flow_repl |= CP210X_SERIAL_RTS_INACTIVE;
1251                 crtscts = false;
1252         }
1253
1254         if (I_IXOFF(tty)) {
1255                 flow_repl |= CP210X_SERIAL_AUTO_RECEIVE;
1256
1257                 flow_ctl.ulXonLimit = cpu_to_le32(128);
1258                 flow_ctl.ulXoffLimit = cpu_to_le32(128);
1259         } else {
1260                 flow_repl &= ~CP210X_SERIAL_AUTO_RECEIVE;
1261         }
1262
1263         if (I_IXON(tty))
1264                 flow_repl |= CP210X_SERIAL_AUTO_TRANSMIT;
1265         else
1266                 flow_repl &= ~CP210X_SERIAL_AUTO_TRANSMIT;
1267
1268         dev_dbg(&port->dev, "%s - ctrl = 0x%02x, flow = 0x%02x\n", __func__,
1269                         ctl_hs, flow_repl);
1270
1271         flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1272         flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1273
1274         ret = cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1275                         sizeof(flow_ctl));
1276         if (ret)
1277                 goto out_unlock;
1278
1279         port_priv->crtscts = crtscts;
1280 out_unlock:
1281         mutex_unlock(&port_priv->mutex);
1282 }
1283
1284 static void cp210x_set_termios(struct tty_struct *tty,
1285                 struct usb_serial_port *port, struct ktermios *old_termios)
1286 {
1287         struct cp210x_serial_private *priv = usb_get_serial_data(port->serial);
1288         u16 bits;
1289         int ret;
1290
1291         if (old_termios && !cp210x_termios_change(&tty->termios, old_termios))
1292                 return;
1293
1294         if (!old_termios || tty->termios.c_ospeed != old_termios->c_ospeed)
1295                 cp210x_change_speed(tty, port, old_termios);
1296
1297         /* CP2101 only supports CS8, 1 stop bit and non-stick parity. */
1298         if (priv->partnum == CP210X_PARTNUM_CP2101) {
1299                 tty->termios.c_cflag &= ~(CSIZE | CSTOPB | CMSPAR);
1300                 tty->termios.c_cflag |= CS8;
1301         }
1302
1303         bits = 0;
1304
1305         switch (C_CSIZE(tty)) {
1306         case CS5:
1307                 bits |= BITS_DATA_5;
1308                 break;
1309         case CS6:
1310                 bits |= BITS_DATA_6;
1311                 break;
1312         case CS7:
1313                 bits |= BITS_DATA_7;
1314                 break;
1315         case CS8:
1316         default:
1317                 bits |= BITS_DATA_8;
1318                 break;
1319         }
1320
1321         if (C_PARENB(tty)) {
1322                 if (C_CMSPAR(tty)) {
1323                         if (C_PARODD(tty))
1324                                 bits |= BITS_PARITY_MARK;
1325                         else
1326                                 bits |= BITS_PARITY_SPACE;
1327                 } else {
1328                         if (C_PARODD(tty))
1329                                 bits |= BITS_PARITY_ODD;
1330                         else
1331                                 bits |= BITS_PARITY_EVEN;
1332                 }
1333         }
1334
1335         if (C_CSTOPB(tty))
1336                 bits |= BITS_STOP_2;
1337         else
1338                 bits |= BITS_STOP_1;
1339
1340         ret = cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
1341         if (ret)
1342                 dev_err(&port->dev, "failed to set line control: %d\n", ret);
1343
1344         cp210x_set_flow_control(tty, port, old_termios);
1345
1346         /*
1347          * Enable event-insertion mode only if input parity checking is
1348          * enabled for now.
1349          */
1350         if (I_INPCK(tty))
1351                 cp210x_enable_event_mode(port);
1352         else
1353                 cp210x_disable_event_mode(port);
1354 }
1355
1356 static int cp210x_tiocmset(struct tty_struct *tty,
1357                 unsigned int set, unsigned int clear)
1358 {
1359         struct usb_serial_port *port = tty->driver_data;
1360         return cp210x_tiocmset_port(port, set, clear);
1361 }
1362
1363 static int cp210x_tiocmset_port(struct usb_serial_port *port,
1364                 unsigned int set, unsigned int clear)
1365 {
1366         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1367         struct cp210x_flow_ctl flow_ctl;
1368         u32 ctl_hs, flow_repl;
1369         u16 control = 0;
1370         int ret;
1371
1372         mutex_lock(&port_priv->mutex);
1373
1374         if (set & TIOCM_RTS) {
1375                 port_priv->rts = true;
1376                 control |= CONTROL_RTS;
1377                 control |= CONTROL_WRITE_RTS;
1378         }
1379         if (set & TIOCM_DTR) {
1380                 port_priv->dtr = true;
1381                 control |= CONTROL_DTR;
1382                 control |= CONTROL_WRITE_DTR;
1383         }
1384         if (clear & TIOCM_RTS) {
1385                 port_priv->rts = false;
1386                 control &= ~CONTROL_RTS;
1387                 control |= CONTROL_WRITE_RTS;
1388         }
1389         if (clear & TIOCM_DTR) {
1390                 port_priv->dtr = false;
1391                 control &= ~CONTROL_DTR;
1392                 control |= CONTROL_WRITE_DTR;
1393         }
1394
1395         /*
1396          * Use SET_FLOW to set DTR and enable/disable auto-RTS when hardware
1397          * flow control is enabled.
1398          */
1399         if (port_priv->crtscts && control & CONTROL_WRITE_RTS) {
1400                 ret = cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1401                                 sizeof(flow_ctl));
1402                 if (ret)
1403                         goto out_unlock;
1404
1405                 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1406                 flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1407
1408                 ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1409                 if (port_priv->dtr)
1410                         ctl_hs |= CP210X_SERIAL_DTR_ACTIVE;
1411                 else
1412                         ctl_hs |= CP210X_SERIAL_DTR_INACTIVE;
1413
1414                 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1415                 if (port_priv->rts)
1416                         flow_repl |= CP210X_SERIAL_RTS_FLOW_CTL;
1417                 else
1418                         flow_repl |= CP210X_SERIAL_RTS_INACTIVE;
1419
1420                 flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1421                 flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1422
1423                 dev_dbg(&port->dev, "%s - ctrl = 0x%02x, flow = 0x%02x\n",
1424                                 __func__, ctl_hs, flow_repl);
1425
1426                 ret = cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1427                                 sizeof(flow_ctl));
1428         } else {
1429                 dev_dbg(&port->dev, "%s - control = 0x%04x\n", __func__, control);
1430
1431                 ret = cp210x_write_u16_reg(port, CP210X_SET_MHS, control);
1432         }
1433 out_unlock:
1434         mutex_unlock(&port_priv->mutex);
1435
1436         return ret;
1437 }
1438
1439 static void cp210x_dtr_rts(struct usb_serial_port *port, int on)
1440 {
1441         if (on)
1442                 cp210x_tiocmset_port(port, TIOCM_DTR | TIOCM_RTS, 0);
1443         else
1444                 cp210x_tiocmset_port(port, 0, TIOCM_DTR | TIOCM_RTS);
1445 }
1446
1447 static int cp210x_tiocmget(struct tty_struct *tty)
1448 {
1449         struct usb_serial_port *port = tty->driver_data;
1450         u8 control;
1451         int result;
1452
1453         result = cp210x_read_u8_reg(port, CP210X_GET_MDMSTS, &control);
1454         if (result)
1455                 return result;
1456
1457         result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
1458                 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
1459                 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
1460                 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
1461                 |((control & CONTROL_RING)? TIOCM_RI  : 0)
1462                 |((control & CONTROL_DCD) ? TIOCM_CD  : 0);
1463
1464         dev_dbg(&port->dev, "%s - control = 0x%02x\n", __func__, control);
1465
1466         return result;
1467 }
1468
1469 static void cp210x_break_ctl(struct tty_struct *tty, int break_state)
1470 {
1471         struct usb_serial_port *port = tty->driver_data;
1472         u16 state;
1473
1474         if (break_state == 0)
1475                 state = BREAK_OFF;
1476         else
1477                 state = BREAK_ON;
1478         dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
1479                 state == BREAK_OFF ? "off" : "on");
1480         cp210x_write_u16_reg(port, CP210X_SET_BREAK, state);
1481 }
1482
1483 #ifdef CONFIG_GPIOLIB
1484 static int cp210x_gpio_get(struct gpio_chip *gc, unsigned int gpio)
1485 {
1486         struct usb_serial *serial = gpiochip_get_data(gc);
1487         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1488         u8 req_type;
1489         u16 mask;
1490         int result;
1491         int len;
1492
1493         result = usb_autopm_get_interface(serial->interface);
1494         if (result)
1495                 return result;
1496
1497         switch (priv->partnum) {
1498         case CP210X_PARTNUM_CP2105:
1499                 req_type = REQTYPE_INTERFACE_TO_HOST;
1500                 len = 1;
1501                 break;
1502         case CP210X_PARTNUM_CP2108:
1503                 req_type = REQTYPE_INTERFACE_TO_HOST;
1504                 len = 2;
1505                 break;
1506         default:
1507                 req_type = REQTYPE_DEVICE_TO_HOST;
1508                 len = 1;
1509                 break;
1510         }
1511
1512         mask = 0;
1513         result = cp210x_read_vendor_block(serial, req_type, CP210X_READ_LATCH,
1514                                           &mask, len);
1515
1516         usb_autopm_put_interface(serial->interface);
1517
1518         if (result < 0)
1519                 return result;
1520
1521         le16_to_cpus(&mask);
1522
1523         return !!(mask & BIT(gpio));
1524 }
1525
1526 static void cp210x_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)
1527 {
1528         struct usb_serial *serial = gpiochip_get_data(gc);
1529         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1530         struct cp210x_gpio_write16 buf16;
1531         struct cp210x_gpio_write buf;
1532         u16 mask, state;
1533         u16 wIndex;
1534         int result;
1535
1536         if (value == 1)
1537                 state = BIT(gpio);
1538         else
1539                 state = 0;
1540
1541         mask = BIT(gpio);
1542
1543         result = usb_autopm_get_interface(serial->interface);
1544         if (result)
1545                 goto out;
1546
1547         switch (priv->partnum) {
1548         case CP210X_PARTNUM_CP2105:
1549                 buf.mask = (u8)mask;
1550                 buf.state = (u8)state;
1551                 result = cp210x_write_vendor_block(serial,
1552                                                    REQTYPE_HOST_TO_INTERFACE,
1553                                                    CP210X_WRITE_LATCH, &buf,
1554                                                    sizeof(buf));
1555                 break;
1556         case CP210X_PARTNUM_CP2108:
1557                 buf16.mask = cpu_to_le16(mask);
1558                 buf16.state = cpu_to_le16(state);
1559                 result = cp210x_write_vendor_block(serial,
1560                                                    REQTYPE_HOST_TO_INTERFACE,
1561                                                    CP210X_WRITE_LATCH, &buf16,
1562                                                    sizeof(buf16));
1563                 break;
1564         default:
1565                 wIndex = state << 8 | mask;
1566                 result = usb_control_msg(serial->dev,
1567                                          usb_sndctrlpipe(serial->dev, 0),
1568                                          CP210X_VENDOR_SPECIFIC,
1569                                          REQTYPE_HOST_TO_DEVICE,
1570                                          CP210X_WRITE_LATCH,
1571                                          wIndex,
1572                                          NULL, 0, USB_CTRL_SET_TIMEOUT);
1573                 break;
1574         }
1575
1576         usb_autopm_put_interface(serial->interface);
1577 out:
1578         if (result < 0) {
1579                 dev_err(&serial->interface->dev, "failed to set GPIO value: %d\n",
1580                                 result);
1581         }
1582 }
1583
1584 static int cp210x_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
1585 {
1586         struct usb_serial *serial = gpiochip_get_data(gc);
1587         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1588
1589         return priv->gpio_input & BIT(gpio);
1590 }
1591
1592 static int cp210x_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
1593 {
1594         struct usb_serial *serial = gpiochip_get_data(gc);
1595         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1596
1597         if (priv->partnum == CP210X_PARTNUM_CP2105) {
1598                 /* hardware does not support an input mode */
1599                 return -ENOTSUPP;
1600         }
1601
1602         /* push-pull pins cannot be changed to be inputs */
1603         if (priv->gpio_pushpull & BIT(gpio))
1604                 return -EINVAL;
1605
1606         /* make sure to release pin if it is being driven low */
1607         cp210x_gpio_set(gc, gpio, 1);
1608
1609         priv->gpio_input |= BIT(gpio);
1610
1611         return 0;
1612 }
1613
1614 static int cp210x_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
1615                                         int value)
1616 {
1617         struct usb_serial *serial = gpiochip_get_data(gc);
1618         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1619
1620         priv->gpio_input &= ~BIT(gpio);
1621         cp210x_gpio_set(gc, gpio, value);
1622
1623         return 0;
1624 }
1625
1626 static int cp210x_gpio_set_config(struct gpio_chip *gc, unsigned int gpio,
1627                                   unsigned long config)
1628 {
1629         struct usb_serial *serial = gpiochip_get_data(gc);
1630         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1631         enum pin_config_param param = pinconf_to_config_param(config);
1632
1633         /* Succeed only if in correct mode (this can't be set at runtime) */
1634         if ((param == PIN_CONFIG_DRIVE_PUSH_PULL) &&
1635             (priv->gpio_pushpull & BIT(gpio)))
1636                 return 0;
1637
1638         if ((param == PIN_CONFIG_DRIVE_OPEN_DRAIN) &&
1639             !(priv->gpio_pushpull & BIT(gpio)))
1640                 return 0;
1641
1642         return -ENOTSUPP;
1643 }
1644
1645 static int cp210x_gpio_init_valid_mask(struct gpio_chip *gc,
1646                 unsigned long *valid_mask, unsigned int ngpios)
1647 {
1648         struct usb_serial *serial = gpiochip_get_data(gc);
1649         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1650         struct device *dev = &serial->interface->dev;
1651         unsigned long altfunc_mask = priv->gpio_altfunc;
1652
1653         bitmap_complement(valid_mask, &altfunc_mask, ngpios);
1654
1655         if (bitmap_empty(valid_mask, ngpios))
1656                 dev_dbg(dev, "no pin configured for GPIO\n");
1657         else
1658                 dev_dbg(dev, "GPIO.%*pbl configured for GPIO\n", ngpios,
1659                                 valid_mask);
1660         return 0;
1661 }
1662
1663 /*
1664  * This function is for configuring GPIO using shared pins, where other signals
1665  * are made unavailable by configuring the use of GPIO. This is believed to be
1666  * only applicable to the cp2105 at this point, the other devices supported by
1667  * this driver that provide GPIO do so in a way that does not impact other
1668  * signals and are thus expected to have very different initialisation.
1669  */
1670 static int cp2105_gpioconf_init(struct usb_serial *serial)
1671 {
1672         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1673         struct cp210x_pin_mode mode;
1674         struct cp210x_dual_port_config config;
1675         u8 intf_num = cp210x_interface_num(serial);
1676         u8 iface_config;
1677         int result;
1678
1679         result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1680                                           CP210X_GET_DEVICEMODE, &mode,
1681                                           sizeof(mode));
1682         if (result < 0)
1683                 return result;
1684
1685         result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1686                                           CP210X_GET_PORTCONFIG, &config,
1687                                           sizeof(config));
1688         if (result < 0)
1689                 return result;
1690
1691         /*  2 banks of GPIO - One for the pins taken from each serial port */
1692         if (intf_num == 0) {
1693                 priv->gc.ngpio = 2;
1694
1695                 if (mode.eci == CP210X_PIN_MODE_MODEM) {
1696                         /* mark all GPIOs of this interface as reserved */
1697                         priv->gpio_altfunc = 0xff;
1698                         return 0;
1699                 }
1700
1701                 iface_config = config.eci_cfg;
1702                 priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1703                                                 CP210X_ECI_GPIO_MODE_MASK) >>
1704                                                 CP210X_ECI_GPIO_MODE_OFFSET);
1705         } else if (intf_num == 1) {
1706                 priv->gc.ngpio = 3;
1707
1708                 if (mode.sci == CP210X_PIN_MODE_MODEM) {
1709                         /* mark all GPIOs of this interface as reserved */
1710                         priv->gpio_altfunc = 0xff;
1711                         return 0;
1712                 }
1713
1714                 iface_config = config.sci_cfg;
1715                 priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1716                                                 CP210X_SCI_GPIO_MODE_MASK) >>
1717                                                 CP210X_SCI_GPIO_MODE_OFFSET);
1718         } else {
1719                 return -ENODEV;
1720         }
1721
1722         /* mark all pins which are not in GPIO mode */
1723         if (iface_config & CP2105_GPIO0_TXLED_MODE)     /* GPIO 0 */
1724                 priv->gpio_altfunc |= BIT(0);
1725         if (iface_config & (CP2105_GPIO1_RXLED_MODE |   /* GPIO 1 */
1726                         CP2105_GPIO1_RS485_MODE))
1727                 priv->gpio_altfunc |= BIT(1);
1728
1729         /* driver implementation for CP2105 only supports outputs */
1730         priv->gpio_input = 0;
1731
1732         return 0;
1733 }
1734
1735 static int cp2104_gpioconf_init(struct usb_serial *serial)
1736 {
1737         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1738         struct cp210x_single_port_config config;
1739         u8 iface_config;
1740         u8 gpio_latch;
1741         int result;
1742         u8 i;
1743
1744         result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1745                                           CP210X_GET_PORTCONFIG, &config,
1746                                           sizeof(config));
1747         if (result < 0)
1748                 return result;
1749
1750         priv->gc.ngpio = 4;
1751
1752         iface_config = config.device_cfg;
1753         priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1754                                         CP210X_GPIO_MODE_MASK) >>
1755                                         CP210X_GPIO_MODE_OFFSET);
1756         gpio_latch = (u8)((le16_to_cpu(config.reset_state) &
1757                                         CP210X_GPIO_MODE_MASK) >>
1758                                         CP210X_GPIO_MODE_OFFSET);
1759
1760         /* mark all pins which are not in GPIO mode */
1761         if (iface_config & CP2104_GPIO0_TXLED_MODE)     /* GPIO 0 */
1762                 priv->gpio_altfunc |= BIT(0);
1763         if (iface_config & CP2104_GPIO1_RXLED_MODE)     /* GPIO 1 */
1764                 priv->gpio_altfunc |= BIT(1);
1765         if (iface_config & CP2104_GPIO2_RS485_MODE)     /* GPIO 2 */
1766                 priv->gpio_altfunc |= BIT(2);
1767
1768         /*
1769          * Like CP2102N, CP2104 has also no strict input and output pin
1770          * modes.
1771          * Do the same input mode emulation as CP2102N.
1772          */
1773         for (i = 0; i < priv->gc.ngpio; ++i) {
1774                 /*
1775                  * Set direction to "input" iff pin is open-drain and reset
1776                  * value is 1.
1777                  */
1778                 if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1779                         priv->gpio_input |= BIT(i);
1780         }
1781
1782         return 0;
1783 }
1784
1785 static int cp2108_gpio_init(struct usb_serial *serial)
1786 {
1787         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1788         struct cp210x_quad_port_config config;
1789         u16 gpio_latch;
1790         int result;
1791         u8 i;
1792
1793         result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1794                                           CP210X_GET_PORTCONFIG, &config,
1795                                           sizeof(config));
1796         if (result < 0)
1797                 return result;
1798
1799         priv->gc.ngpio = 16;
1800         priv->gpio_pushpull = le16_to_cpu(config.reset_state.gpio_mode_pb1);
1801         gpio_latch = le16_to_cpu(config.reset_state.gpio_latch_pb1);
1802
1803         /*
1804          * Mark all pins which are not in GPIO mode.
1805          *
1806          * Refer to table 9.1 "GPIO Mode alternate Functions" in the datasheet:
1807          * https://www.silabs.com/documents/public/data-sheets/cp2108-datasheet.pdf
1808          *
1809          * Alternate functions of GPIO0 to GPIO3 are determine by enhancedfxn_ifc[0]
1810          * and the similarly for the other pins; enhancedfxn_ifc[1]: GPIO4 to GPIO7,
1811          * enhancedfxn_ifc[2]: GPIO8 to GPIO11, enhancedfxn_ifc[3]: GPIO12 to GPIO15.
1812          */
1813         for (i = 0; i < 4; i++) {
1814                 if (config.enhancedfxn_ifc[i] & CP2108_EF_IFC_GPIO_TXLED)
1815                         priv->gpio_altfunc |= BIT(i * 4);
1816                 if (config.enhancedfxn_ifc[i] & CP2108_EF_IFC_GPIO_RXLED)
1817                         priv->gpio_altfunc |= BIT((i * 4) + 1);
1818                 if (config.enhancedfxn_ifc[i] & CP2108_EF_IFC_GPIO_RS485)
1819                         priv->gpio_altfunc |= BIT((i * 4) + 2);
1820                 if (config.enhancedfxn_ifc[i] & CP2108_EF_IFC_GPIO_CLOCK)
1821                         priv->gpio_altfunc |= BIT((i * 4) + 3);
1822         }
1823
1824         /*
1825          * Like CP2102N, CP2108 has also no strict input and output pin
1826          * modes. Do the same input mode emulation as CP2102N.
1827          */
1828         for (i = 0; i < priv->gc.ngpio; ++i) {
1829                 /*
1830                  * Set direction to "input" iff pin is open-drain and reset
1831                  * value is 1.
1832                  */
1833                 if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1834                         priv->gpio_input |= BIT(i);
1835         }
1836
1837         return 0;
1838 }
1839
1840 static int cp2102n_gpioconf_init(struct usb_serial *serial)
1841 {
1842         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1843         const u16 config_size = 0x02a6;
1844         u8 gpio_rst_latch;
1845         u8 config_version;
1846         u8 gpio_pushpull;
1847         u8 *config_buf;
1848         u8 gpio_latch;
1849         u8 gpio_ctrl;
1850         int result;
1851         u8 i;
1852
1853         /*
1854          * Retrieve device configuration from the device.
1855          * The array received contains all customization settings done at the
1856          * factory/manufacturer. Format of the array is documented at the
1857          * time of writing at:
1858          * https://www.silabs.com/community/interface/knowledge-base.entry.html/2017/03/31/cp2102n_setconfig-xsfa
1859          */
1860         config_buf = kmalloc(config_size, GFP_KERNEL);
1861         if (!config_buf)
1862                 return -ENOMEM;
1863
1864         result = cp210x_read_vendor_block(serial,
1865                                           REQTYPE_DEVICE_TO_HOST,
1866                                           CP210X_READ_2NCONFIG,
1867                                           config_buf,
1868                                           config_size);
1869         if (result < 0) {
1870                 kfree(config_buf);
1871                 return result;
1872         }
1873
1874         config_version = config_buf[CP210X_2NCONFIG_CONFIG_VERSION_IDX];
1875         gpio_pushpull = config_buf[CP210X_2NCONFIG_GPIO_MODE_IDX];
1876         gpio_ctrl = config_buf[CP210X_2NCONFIG_GPIO_CONTROL_IDX];
1877         gpio_rst_latch = config_buf[CP210X_2NCONFIG_GPIO_RSTLATCH_IDX];
1878
1879         kfree(config_buf);
1880
1881         /* Make sure this is a config format we understand. */
1882         if (config_version != 0x01)
1883                 return -ENOTSUPP;
1884
1885         priv->gc.ngpio = 4;
1886
1887         /*
1888          * Get default pin states after reset. Needed so we can determine
1889          * the direction of an open-drain pin.
1890          */
1891         gpio_latch = (gpio_rst_latch >> 3) & 0x0f;
1892
1893         /* 0 indicates open-drain mode, 1 is push-pull */
1894         priv->gpio_pushpull = (gpio_pushpull >> 3) & 0x0f;
1895
1896         /* 0 indicates GPIO mode, 1 is alternate function */
1897         if (priv->partnum == CP210X_PARTNUM_CP2102N_QFN20) {
1898                 /* QFN20 is special... */
1899                 if (gpio_ctrl & CP2102N_QFN20_GPIO0_CLK_MODE)   /* GPIO 0 */
1900                         priv->gpio_altfunc |= BIT(0);
1901                 if (gpio_ctrl & CP2102N_QFN20_GPIO1_RS485_MODE) /* GPIO 1 */
1902                         priv->gpio_altfunc |= BIT(1);
1903                 if (gpio_ctrl & CP2102N_QFN20_GPIO2_TXLED_MODE) /* GPIO 2 */
1904                         priv->gpio_altfunc |= BIT(2);
1905                 if (gpio_ctrl & CP2102N_QFN20_GPIO3_RXLED_MODE) /* GPIO 3 */
1906                         priv->gpio_altfunc |= BIT(3);
1907         } else {
1908                 priv->gpio_altfunc = (gpio_ctrl >> 2) & 0x0f;
1909         }
1910
1911         if (priv->partnum == CP210X_PARTNUM_CP2102N_QFN28) {
1912                 /*
1913                  * For the QFN28 package, GPIO4-6 are controlled by
1914                  * the low three bits of the mode/latch fields.
1915                  * Contrary to the document linked above, the bits for
1916                  * the SUSPEND pins are elsewhere.  No alternate
1917                  * function is available for these pins.
1918                  */
1919                 priv->gc.ngpio = 7;
1920                 gpio_latch |= (gpio_rst_latch & 7) << 4;
1921                 priv->gpio_pushpull |= (gpio_pushpull & 7) << 4;
1922         }
1923
1924         /*
1925          * The CP2102N does not strictly has input and output pin modes,
1926          * it only knows open-drain and push-pull modes which is set at
1927          * factory. An open-drain pin can function both as an
1928          * input or an output. We emulate input mode for open-drain pins
1929          * by making sure they are not driven low, and we do not allow
1930          * push-pull pins to be set as an input.
1931          */
1932         for (i = 0; i < priv->gc.ngpio; ++i) {
1933                 /*
1934                  * Set direction to "input" iff pin is open-drain and reset
1935                  * value is 1.
1936                  */
1937                 if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1938                         priv->gpio_input |= BIT(i);
1939         }
1940
1941         return 0;
1942 }
1943
1944 static int cp210x_gpio_init(struct usb_serial *serial)
1945 {
1946         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1947         int result;
1948
1949         switch (priv->partnum) {
1950         case CP210X_PARTNUM_CP2104:
1951                 result = cp2104_gpioconf_init(serial);
1952                 break;
1953         case CP210X_PARTNUM_CP2105:
1954                 result = cp2105_gpioconf_init(serial);
1955                 break;
1956         case CP210X_PARTNUM_CP2108:
1957                 /*
1958                  * The GPIOs are not tied to any specific port so only register
1959                  * once for interface 0.
1960                  */
1961                 if (cp210x_interface_num(serial) != 0)
1962                         return 0;
1963                 result = cp2108_gpio_init(serial);
1964                 break;
1965         case CP210X_PARTNUM_CP2102N_QFN28:
1966         case CP210X_PARTNUM_CP2102N_QFN24:
1967         case CP210X_PARTNUM_CP2102N_QFN20:
1968                 result = cp2102n_gpioconf_init(serial);
1969                 break;
1970         default:
1971                 return 0;
1972         }
1973
1974         if (result < 0)
1975                 return result;
1976
1977         priv->gc.label = "cp210x";
1978         priv->gc.get_direction = cp210x_gpio_direction_get;
1979         priv->gc.direction_input = cp210x_gpio_direction_input;
1980         priv->gc.direction_output = cp210x_gpio_direction_output;
1981         priv->gc.get = cp210x_gpio_get;
1982         priv->gc.set = cp210x_gpio_set;
1983         priv->gc.set_config = cp210x_gpio_set_config;
1984         priv->gc.init_valid_mask = cp210x_gpio_init_valid_mask;
1985         priv->gc.owner = THIS_MODULE;
1986         priv->gc.parent = &serial->interface->dev;
1987         priv->gc.base = -1;
1988         priv->gc.can_sleep = true;
1989
1990         result = gpiochip_add_data(&priv->gc, serial);
1991         if (!result)
1992                 priv->gpio_registered = true;
1993
1994         return result;
1995 }
1996
1997 static void cp210x_gpio_remove(struct usb_serial *serial)
1998 {
1999         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2000
2001         if (priv->gpio_registered) {
2002                 gpiochip_remove(&priv->gc);
2003                 priv->gpio_registered = false;
2004         }
2005 }
2006
2007 #else
2008
2009 static int cp210x_gpio_init(struct usb_serial *serial)
2010 {
2011         return 0;
2012 }
2013
2014 static void cp210x_gpio_remove(struct usb_serial *serial)
2015 {
2016         /* Nothing to do */
2017 }
2018
2019 #endif
2020
2021 static int cp210x_port_probe(struct usb_serial_port *port)
2022 {
2023         struct usb_serial *serial = port->serial;
2024         struct cp210x_port_private *port_priv;
2025
2026         port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
2027         if (!port_priv)
2028                 return -ENOMEM;
2029
2030         port_priv->bInterfaceNumber = cp210x_interface_num(serial);
2031         mutex_init(&port_priv->mutex);
2032
2033         usb_set_serial_port_data(port, port_priv);
2034
2035         return 0;
2036 }
2037
2038 static void cp210x_port_remove(struct usb_serial_port *port)
2039 {
2040         struct cp210x_port_private *port_priv;
2041
2042         port_priv = usb_get_serial_port_data(port);
2043         kfree(port_priv);
2044 }
2045
2046 static void cp210x_init_max_speed(struct usb_serial *serial)
2047 {
2048         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2049         bool use_actual_rate = false;
2050         speed_t min = 300;
2051         speed_t max;
2052
2053         switch (priv->partnum) {
2054         case CP210X_PARTNUM_CP2101:
2055                 max = 921600;
2056                 break;
2057         case CP210X_PARTNUM_CP2102:
2058         case CP210X_PARTNUM_CP2103:
2059                 max = 1000000;
2060                 break;
2061         case CP210X_PARTNUM_CP2104:
2062                 use_actual_rate = true;
2063                 max = 2000000;
2064                 break;
2065         case CP210X_PARTNUM_CP2108:
2066                 max = 2000000;
2067                 break;
2068         case CP210X_PARTNUM_CP2105:
2069                 if (cp210x_interface_num(serial) == 0) {
2070                         use_actual_rate = true;
2071                         max = 2000000;  /* ECI */
2072                 } else {
2073                         min = 2400;
2074                         max = 921600;   /* SCI */
2075                 }
2076                 break;
2077         case CP210X_PARTNUM_CP2102N_QFN28:
2078         case CP210X_PARTNUM_CP2102N_QFN24:
2079         case CP210X_PARTNUM_CP2102N_QFN20:
2080                 use_actual_rate = true;
2081                 max = 3000000;
2082                 break;
2083         default:
2084                 max = 2000000;
2085                 break;
2086         }
2087
2088         priv->min_speed = min;
2089         priv->max_speed = max;
2090         priv->use_actual_rate = use_actual_rate;
2091 }
2092
2093 static void cp2102_determine_quirks(struct usb_serial *serial)
2094 {
2095         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2096         u8 *buf;
2097         int ret;
2098
2099         buf = kmalloc(2, GFP_KERNEL);
2100         if (!buf)
2101                 return;
2102         /*
2103          * Some (possibly counterfeit) CP2102 do not support event-insertion
2104          * mode and respond differently to malformed vendor requests.
2105          * Specifically, they return one instead of two bytes when sent a
2106          * two-byte part-number request.
2107          */
2108         ret = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
2109                         CP210X_VENDOR_SPECIFIC, REQTYPE_DEVICE_TO_HOST,
2110                         CP210X_GET_PARTNUM, 0, buf, 2, USB_CTRL_GET_TIMEOUT);
2111         if (ret == 1) {
2112                 dev_dbg(&serial->interface->dev,
2113                                 "device does not support event-insertion mode\n");
2114                 priv->no_event_mode = true;
2115         }
2116
2117         kfree(buf);
2118 }
2119
2120 static int cp210x_get_fw_version(struct usb_serial *serial, u16 value)
2121 {
2122         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2123         u8 ver[3];
2124         int ret;
2125
2126         ret = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST, value,
2127                         ver, sizeof(ver));
2128         if (ret)
2129                 return ret;
2130
2131         dev_dbg(&serial->interface->dev, "%s - %d.%d.%d\n", __func__,
2132                         ver[0], ver[1], ver[2]);
2133
2134         priv->fw_version = ver[0] << 16 | ver[1] << 8 | ver[2];
2135
2136         return 0;
2137 }
2138
2139 static void cp210x_determine_type(struct usb_serial *serial)
2140 {
2141         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2142         int ret;
2143
2144         ret = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
2145                         CP210X_GET_PARTNUM, &priv->partnum,
2146                         sizeof(priv->partnum));
2147         if (ret < 0) {
2148                 dev_warn(&serial->interface->dev,
2149                                 "querying part number failed\n");
2150                 priv->partnum = CP210X_PARTNUM_UNKNOWN;
2151                 return;
2152         }
2153
2154         dev_dbg(&serial->interface->dev, "partnum = 0x%02x\n", priv->partnum);
2155
2156         switch (priv->partnum) {
2157         case CP210X_PARTNUM_CP2102:
2158                 cp2102_determine_quirks(serial);
2159                 break;
2160         case CP210X_PARTNUM_CP2105:
2161         case CP210X_PARTNUM_CP2108:
2162                 cp210x_get_fw_version(serial, CP210X_GET_FW_VER);
2163                 break;
2164         case CP210X_PARTNUM_CP2102N_QFN28:
2165         case CP210X_PARTNUM_CP2102N_QFN24:
2166         case CP210X_PARTNUM_CP2102N_QFN20:
2167                 ret = cp210x_get_fw_version(serial, CP210X_GET_FW_VER_2N);
2168                 if (ret)
2169                         break;
2170                 if (priv->fw_version <= 0x10004)
2171                         priv->no_flow_control = true;
2172                 break;
2173         default:
2174                 break;
2175         }
2176 }
2177
2178 static int cp210x_attach(struct usb_serial *serial)
2179 {
2180         int result;
2181         struct cp210x_serial_private *priv;
2182
2183         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
2184         if (!priv)
2185                 return -ENOMEM;
2186
2187         usb_set_serial_data(serial, priv);
2188
2189         cp210x_determine_type(serial);
2190         cp210x_init_max_speed(serial);
2191
2192         result = cp210x_gpio_init(serial);
2193         if (result < 0) {
2194                 dev_err(&serial->interface->dev, "GPIO initialisation failed: %d\n",
2195                                 result);
2196         }
2197
2198         return 0;
2199 }
2200
2201 static void cp210x_disconnect(struct usb_serial *serial)
2202 {
2203         cp210x_gpio_remove(serial);
2204 }
2205
2206 static void cp210x_release(struct usb_serial *serial)
2207 {
2208         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
2209
2210         cp210x_gpio_remove(serial);
2211
2212         kfree(priv);
2213 }
2214
2215 module_usb_serial_driver(serial_drivers, id_table);
2216
2217 MODULE_DESCRIPTION(DRIVER_DESC);
2218 MODULE_LICENSE("GPL v2");