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