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         speed_t                 min_speed;
 256         speed_t                 max_speed;
 257         bool                    use_actual_rate;
 258 };
 259
 260 enum cp210x_event_state {
 261         ES_DATA,
 262         ES_ESCAPE,
 263         ES_LSR,
 264         ES_LSR_DATA_0,
 265         ES_LSR_DATA_1,
 266         ES_MSR
 267 };
 268
 269 struct cp210x_port_private {
 270         u8                      bInterfaceNumber;
 271         bool                    event_mode;
 272         enum cp210x_event_state event_state;
 273         u8                      lsr;
 274
 275         struct mutex            mutex;
 276         bool                    crtscts;
 277         bool                    dtr;
 278         bool                    rts;
 279 };
 280
 281 static struct usb_serial_driver cp210x_device = {
 282         .driver = {
 283                 .owner =        THIS_MODULE,
 284                 .name =         "cp210x",
 285         },
 286         .id_table               = id_table,
 287         .num_ports              = 1,
 288         .bulk_in_size           = 256,
 289         .bulk_out_size          = 256,
 290         .open                   = cp210x_open,
 291         .close                  = cp210x_close,
 292         .break_ctl              = cp210x_break_ctl,
 293         .set_termios            = cp210x_set_termios,
 294         .tx_empty               = cp210x_tx_empty,
 295         .throttle               = usb_serial_generic_throttle,
 296         .unthrottle             = usb_serial_generic_unthrottle,
 297         .tiocmget               = cp210x_tiocmget,
 298         .tiocmset               = cp210x_tiocmset,
 299         .get_icount             = usb_serial_generic_get_icount,
 300         .attach                 = cp210x_attach,
 301         .disconnect             = cp210x_disconnect,
 302         .release                = cp210x_release,
 303         .port_probe             = cp210x_port_probe,
 304         .port_remove            = cp210x_port_remove,
 305         .dtr_rts                = cp210x_dtr_rts,
 306         .process_read_urb       = cp210x_process_read_urb,
 307 };
 308
 309 static struct usb_serial_driver * const serial_drivers[] = {
 310         &cp210x_device, NULL
 311 };
 312
 313 /* Config request types */
 314 #define REQTYPE_HOST_TO_INTERFACE       0x41
 315 #define REQTYPE_INTERFACE_TO_HOST       0xc1
 316 #define REQTYPE_HOST_TO_DEVICE  0x40
 317 #define REQTYPE_DEVICE_TO_HOST  0xc0
 318
 319 /* Config request codes */
 320 #define CP210X_IFC_ENABLE       0x00
 321 #define CP210X_SET_BAUDDIV      0x01
 322 #define CP210X_GET_BAUDDIV      0x02
 323 #define CP210X_SET_LINE_CTL     0x03
 324 #define CP210X_GET_LINE_CTL     0x04
 325 #define CP210X_SET_BREAK        0x05
 326 #define CP210X_IMM_CHAR         0x06
 327 #define CP210X_SET_MHS          0x07
 328 #define CP210X_GET_MDMSTS       0x08
 329 #define CP210X_SET_XON          0x09
 330 #define CP210X_SET_XOFF         0x0A
 331 #define CP210X_SET_EVENTMASK    0x0B
 332 #define CP210X_GET_EVENTMASK    0x0C
 333 #define CP210X_SET_CHAR         0x0D
 334 #define CP210X_GET_CHARS        0x0E
 335 #define CP210X_GET_PROPS        0x0F
 336 #define CP210X_GET_COMM_STATUS  0x10
 337 #define CP210X_RESET            0x11
 338 #define CP210X_PURGE            0x12
 339 #define CP210X_SET_FLOW         0x13
 340 #define CP210X_GET_FLOW         0x14
 341 #define CP210X_EMBED_EVENTS     0x15
 342 #define CP210X_GET_EVENTSTATE   0x16
 343 #define CP210X_SET_CHARS        0x19
 344 #define CP210X_GET_BAUDRATE     0x1D
 345 #define CP210X_SET_BAUDRATE     0x1E
 346 #define CP210X_VENDOR_SPECIFIC  0xFF
 347
 348 /* CP210X_IFC_ENABLE */
 349 #define UART_ENABLE             0x0001
 350 #define UART_DISABLE            0x0000
 351
 352 /* CP210X_(SET|GET)_BAUDDIV */
 353 #define BAUD_RATE_GEN_FREQ      0x384000
 354
 355 /* CP210X_(SET|GET)_LINE_CTL */
 356 #define BITS_DATA_MASK          0X0f00
 357 #define BITS_DATA_5             0X0500
 358 #define BITS_DATA_6             0X0600
 359 #define BITS_DATA_7             0X0700
 360 #define BITS_DATA_8             0X0800
 361 #define BITS_DATA_9             0X0900
 362
 363 #define BITS_PARITY_MASK        0x00f0
 364 #define BITS_PARITY_NONE        0x0000
 365 #define BITS_PARITY_ODD         0x0010
 366 #define BITS_PARITY_EVEN        0x0020
 367 #define BITS_PARITY_MARK        0x0030
 368 #define BITS_PARITY_SPACE       0x0040
 369
 370 #define BITS_STOP_MASK          0x000f
 371 #define BITS_STOP_1             0x0000
 372 #define BITS_STOP_1_5           0x0001
 373 #define BITS_STOP_2             0x0002
 374
 375 /* CP210X_SET_BREAK */
 376 #define BREAK_ON                0x0001
 377 #define BREAK_OFF               0x0000
 378
 379 /* CP210X_(SET_MHS|GET_MDMSTS) */
 380 #define CONTROL_DTR             0x0001
 381 #define CONTROL_RTS             0x0002
 382 #define CONTROL_CTS             0x0010
 383 #define CONTROL_DSR             0x0020
 384 #define CONTROL_RING            0x0040
 385 #define CONTROL_DCD             0x0080
 386 #define CONTROL_WRITE_DTR       0x0100
 387 #define CONTROL_WRITE_RTS       0x0200
 388
 389 /* CP210X_(GET|SET)_CHARS */
 390 struct cp210x_special_chars {
 391         u8      bEofChar;
 392         u8      bErrorChar;
 393         u8      bBreakChar;
 394         u8      bEventChar;
 395         u8      bXonChar;
 396         u8      bXoffChar;
 397 };
 398
 399 /* CP210X_VENDOR_SPECIFIC values */
 400 #define CP210X_READ_2NCONFIG    0x000E
 401 #define CP210X_READ_LATCH       0x00C2
 402 #define CP210X_GET_PARTNUM      0x370B
 403 #define CP210X_GET_PORTCONFIG   0x370C
 404 #define CP210X_GET_DEVICEMODE   0x3711
 405 #define CP210X_WRITE_LATCH      0x37E1
 406
 407 /* Part number definitions */
 408 #define CP210X_PARTNUM_CP2101   0x01
 409 #define CP210X_PARTNUM_CP2102   0x02
 410 #define CP210X_PARTNUM_CP2103   0x03
 411 #define CP210X_PARTNUM_CP2104   0x04
 412 #define CP210X_PARTNUM_CP2105   0x05
 413 #define CP210X_PARTNUM_CP2108   0x08
 414 #define CP210X_PARTNUM_CP2102N_QFN28    0x20
 415 #define CP210X_PARTNUM_CP2102N_QFN24    0x21
 416 #define CP210X_PARTNUM_CP2102N_QFN20    0x22
 417 #define CP210X_PARTNUM_UNKNOWN  0xFF
 418
 419 /* CP210X_GET_COMM_STATUS returns these 0x13 bytes */
 420 struct cp210x_comm_status {
 421         __le32   ulErrors;
 422         __le32   ulHoldReasons;
 423         __le32   ulAmountInInQueue;
 424         __le32   ulAmountInOutQueue;
 425         u8       bEofReceived;
 426         u8       bWaitForImmediate;
 427         u8       bReserved;
 428 } __packed;
 429
 430 /*
 431  * CP210X_PURGE - 16 bits passed in wValue of USB request.
 432  * SiLabs app note AN571 gives a strange description of the 4 bits:
 433  * bit 0 or bit 2 clears the transmit queue and 1 or 3 receive.
 434  * writing 1 to all, however, purges cp2108 well enough to avoid the hang.
 435  */
 436 #define PURGE_ALL               0x000f
 437
 438 /* CP210X_EMBED_EVENTS */
 439 #define CP210X_ESCCHAR          0xec
 440
 441 #define CP210X_LSR_OVERRUN      BIT(1)
 442 #define CP210X_LSR_PARITY       BIT(2)
 443 #define CP210X_LSR_FRAME        BIT(3)
 444 #define CP210X_LSR_BREAK        BIT(4)
 445
 446
 447 /* CP210X_GET_FLOW/CP210X_SET_FLOW read/write these 0x10 bytes */
 448 struct cp210x_flow_ctl {
 449         __le32  ulControlHandshake;
 450         __le32  ulFlowReplace;
 451         __le32  ulXonLimit;
 452         __le32  ulXoffLimit;
 453 };
 454
 455 /* cp210x_flow_ctl::ulControlHandshake */
 456 #define CP210X_SERIAL_DTR_MASK          GENMASK(1, 0)
 457 #define CP210X_SERIAL_DTR_INACTIVE      (0 << 0)
 458 #define CP210X_SERIAL_DTR_ACTIVE        (1 << 0)
 459 #define CP210X_SERIAL_DTR_FLOW_CTL      (2 << 0)
 460 #define CP210X_SERIAL_CTS_HANDSHAKE     BIT(3)
 461 #define CP210X_SERIAL_DSR_HANDSHAKE     BIT(4)
 462 #define CP210X_SERIAL_DCD_HANDSHAKE     BIT(5)
 463 #define CP210X_SERIAL_DSR_SENSITIVITY   BIT(6)
 464
 465 /* cp210x_flow_ctl::ulFlowReplace */
 466 #define CP210X_SERIAL_AUTO_TRANSMIT     BIT(0)
 467 #define CP210X_SERIAL_AUTO_RECEIVE      BIT(1)
 468 #define CP210X_SERIAL_ERROR_CHAR        BIT(2)
 469 #define CP210X_SERIAL_NULL_STRIPPING    BIT(3)
 470 #define CP210X_SERIAL_BREAK_CHAR        BIT(4)
 471 #define CP210X_SERIAL_RTS_MASK          GENMASK(7, 6)
 472 #define CP210X_SERIAL_RTS_INACTIVE      (0 << 6)
 473 #define CP210X_SERIAL_RTS_ACTIVE        (1 << 6)
 474 #define CP210X_SERIAL_RTS_FLOW_CTL      (2 << 6)
 475 #define CP210X_SERIAL_XOFF_CONTINUE     BIT(31)
 476
 477 /* CP210X_VENDOR_SPECIFIC, CP210X_GET_DEVICEMODE call reads these 0x2 bytes. */
 478 struct cp210x_pin_mode {
 479         u8      eci;
 480         u8      sci;
 481 };
 482
 483 #define CP210X_PIN_MODE_MODEM           0
 484 #define CP210X_PIN_MODE_GPIO            BIT(0)
 485
 486 /*
 487  * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xf bytes
 488  * on a CP2105 chip. Structure needs padding due to unused/unspecified bytes.
 489  */
 490 struct cp210x_dual_port_config {
 491         __le16  gpio_mode;
 492         u8      __pad0[2];
 493         __le16  reset_state;
 494         u8      __pad1[4];
 495         __le16  suspend_state;
 496         u8      sci_cfg;
 497         u8      eci_cfg;
 498         u8      device_cfg;
 499 } __packed;
 500
 501 /*
 502  * CP210X_VENDOR_SPECIFIC, CP210X_GET_PORTCONFIG call reads these 0xd bytes
 503  * on a CP2104 chip. Structure needs padding due to unused/unspecified bytes.
 504  */
 505 struct cp210x_single_port_config {
 506         __le16  gpio_mode;
 507         u8      __pad0[2];
 508         __le16  reset_state;
 509         u8      __pad1[4];
 510         __le16  suspend_state;
 511         u8      device_cfg;
 512 } __packed;
 513
 514 /* GPIO modes */
 515 #define CP210X_SCI_GPIO_MODE_OFFSET     9
 516 #define CP210X_SCI_GPIO_MODE_MASK       GENMASK(11, 9)
 517
 518 #define CP210X_ECI_GPIO_MODE_OFFSET     2
 519 #define CP210X_ECI_GPIO_MODE_MASK       GENMASK(3, 2)
 520
 521 #define CP210X_GPIO_MODE_OFFSET         8
 522 #define CP210X_GPIO_MODE_MASK           GENMASK(11, 8)
 523
 524 /* CP2105 port configuration values */
 525 #define CP2105_GPIO0_TXLED_MODE         BIT(0)
 526 #define CP2105_GPIO1_RXLED_MODE         BIT(1)
 527 #define CP2105_GPIO1_RS485_MODE         BIT(2)
 528
 529 /* CP2104 port configuration values */
 530 #define CP2104_GPIO0_TXLED_MODE         BIT(0)
 531 #define CP2104_GPIO1_RXLED_MODE         BIT(1)
 532 #define CP2104_GPIO2_RS485_MODE         BIT(2)
 533
 534 /* CP2102N configuration array indices */
 535 #define CP210X_2NCONFIG_CONFIG_VERSION_IDX      2
 536 #define CP210X_2NCONFIG_GPIO_MODE_IDX           581
 537 #define CP210X_2NCONFIG_GPIO_RSTLATCH_IDX       587
 538 #define CP210X_2NCONFIG_GPIO_CONTROL_IDX        600
 539
 540 /* CP210X_VENDOR_SPECIFIC, CP210X_WRITE_LATCH call writes these 0x2 bytes. */
 541 struct cp210x_gpio_write {
 542         u8      mask;
 543         u8      state;
 544 };
 545
 546 /*
 547  * Helper to get interface number when we only have struct usb_serial.
 548  */
 549 static u8 cp210x_interface_num(struct usb_serial *serial)
 550 {
 551         struct usb_host_interface *cur_altsetting;
 552
 553         cur_altsetting = serial->interface->cur_altsetting;
 554
 555         return cur_altsetting->desc.bInterfaceNumber;
 556 }
 557
 558 /*
 559  * Reads a variable-sized block of CP210X_ registers, identified by req.
 560  * Returns data into buf in native USB byte order.
 561  */
 562 static int cp210x_read_reg_block(struct usb_serial_port *port, u8 req,
 563                 void *buf, int bufsize)
 564 {
 565         struct usb_serial *serial = port->serial;
 566         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 567         void *dmabuf;
 568         int result;
 569
 570         dmabuf = kmalloc(bufsize, GFP_KERNEL);
 571         if (!dmabuf)
 572                 return -ENOMEM;
 573
 574         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 575                         req, REQTYPE_INTERFACE_TO_HOST, 0,
 576                         port_priv->bInterfaceNumber, dmabuf, bufsize,
 577                         USB_CTRL_SET_TIMEOUT);
 578         if (result == bufsize) {
 579                 memcpy(buf, dmabuf, bufsize);
 580                 result = 0;
 581         } else {
 582                 dev_err(&port->dev, "failed get req 0x%x size %d status: %d\n",
 583                                 req, bufsize, result);
 584                 if (result >= 0)
 585                         result = -EIO;
 586         }
 587
 588         kfree(dmabuf);
 589
 590         return result;
 591 }
 592
 593 /*
 594  * Reads any 8-bit CP210X_ register identified by req.
 595  */
 596 static int cp210x_read_u8_reg(struct usb_serial_port *port, u8 req, u8 *val)
 597 {
 598         return cp210x_read_reg_block(port, req, val, sizeof(*val));
 599 }
 600
 601 /*
 602  * Reads a variable-sized vendor block of CP210X_ registers, identified by val.
 603  * Returns data into buf in native USB byte order.
 604  */
 605 static int cp210x_read_vendor_block(struct usb_serial *serial, u8 type, u16 val,
 606                                     void *buf, int bufsize)
 607 {
 608         void *dmabuf;
 609         int result;
 610
 611         dmabuf = kmalloc(bufsize, GFP_KERNEL);
 612         if (!dmabuf)
 613                 return -ENOMEM;
 614
 615         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 616                                  CP210X_VENDOR_SPECIFIC, type, val,
 617                                  cp210x_interface_num(serial), dmabuf, bufsize,
 618                                  USB_CTRL_GET_TIMEOUT);
 619         if (result == bufsize) {
 620                 memcpy(buf, dmabuf, bufsize);
 621                 result = 0;
 622         } else {
 623                 dev_err(&serial->interface->dev,
 624                         "failed to get vendor val 0x%04x size %d: %d\n", val,
 625                         bufsize, result);
 626                 if (result >= 0)
 627                         result = -EIO;
 628         }
 629
 630         kfree(dmabuf);
 631
 632         return result;
 633 }
 634
 635 /*
 636  * Writes any 16-bit CP210X_ register (req) whose value is passed
 637  * entirely in the wValue field of the USB request.
 638  */
 639 static int cp210x_write_u16_reg(struct usb_serial_port *port, u8 req, u16 val)
 640 {
 641         struct usb_serial *serial = port->serial;
 642         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 643         int result;
 644
 645         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 646                         req, REQTYPE_HOST_TO_INTERFACE, val,
 647                         port_priv->bInterfaceNumber, NULL, 0,
 648                         USB_CTRL_SET_TIMEOUT);
 649         if (result < 0) {
 650                 dev_err(&port->dev, "failed set request 0x%x status: %d\n",
 651                                 req, result);
 652         }
 653
 654         return result;
 655 }
 656
 657 /*
 658  * Writes a variable-sized block of CP210X_ registers, identified by req.
 659  * Data in buf must be in native USB byte order.
 660  */
 661 static int cp210x_write_reg_block(struct usb_serial_port *port, u8 req,
 662                 void *buf, int bufsize)
 663 {
 664         struct usb_serial *serial = port->serial;
 665         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 666         void *dmabuf;
 667         int result;
 668
 669         dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
 670         if (!dmabuf)
 671                 return -ENOMEM;
 672
 673         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 674                         req, REQTYPE_HOST_TO_INTERFACE, 0,
 675                         port_priv->bInterfaceNumber, dmabuf, bufsize,
 676                         USB_CTRL_SET_TIMEOUT);
 677
 678         kfree(dmabuf);
 679
 680         if (result < 0) {
 681                 dev_err(&port->dev, "failed set req 0x%x size %d status: %d\n",
 682                                 req, bufsize, result);
 683                 return result;
 684         }
 685
 686         return 0;
 687 }
 688
 689 /*
 690  * Writes any 32-bit CP210X_ register identified by req.
 691  */
 692 static int cp210x_write_u32_reg(struct usb_serial_port *port, u8 req, u32 val)
 693 {
 694         __le32 le32_val;
 695
 696         le32_val = cpu_to_le32(val);
 697
 698         return cp210x_write_reg_block(port, req, &le32_val, sizeof(le32_val));
 699 }
 700
 701 #ifdef CONFIG_GPIOLIB
 702 /*
 703  * Writes a variable-sized vendor block of CP210X_ registers, identified by val.
 704  * Data in buf must be in native USB byte order.
 705  */
 706 static int cp210x_write_vendor_block(struct usb_serial *serial, u8 type,
 707                                      u16 val, void *buf, int bufsize)
 708 {
 709         void *dmabuf;
 710         int result;
 711
 712         dmabuf = kmemdup(buf, bufsize, GFP_KERNEL);
 713         if (!dmabuf)
 714                 return -ENOMEM;
 715
 716         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 717                                  CP210X_VENDOR_SPECIFIC, type, val,
 718                                  cp210x_interface_num(serial), dmabuf, bufsize,
 719                                  USB_CTRL_SET_TIMEOUT);
 720
 721         kfree(dmabuf);
 722
 723         if (result < 0) {
 724                 dev_err(&serial->interface->dev,
 725                         "failed to set vendor val 0x%04x size %d: %d\n", val,
 726                         bufsize, result);
 727                 return result;
 728         }
 729
 730         return 0;
 731 }
 732 #endif
 733
 734 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
 735 {
 736         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 737         int result;
 738
 739         result = cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_ENABLE);
 740         if (result) {
 741                 dev_err(&port->dev, "%s - Unable to enable UART\n", __func__);
 742                 return result;
 743         }
 744
 745         if (tty)
 746                 cp210x_set_termios(tty, port, NULL);
 747
 748         result = usb_serial_generic_open(tty, port);
 749         if (result)
 750                 goto err_disable;
 751
 752         return 0;
 753
 754 err_disable:
 755         cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
 756         port_priv->event_mode = false;
 757
 758         return result;
 759 }
 760
 761 static void cp210x_close(struct usb_serial_port *port)
 762 {
 763         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 764
 765         usb_serial_generic_close(port);
 766
 767         /* Clear both queues; cp2108 needs this to avoid an occasional hang */
 768         cp210x_write_u16_reg(port, CP210X_PURGE, PURGE_ALL);
 769
 770         cp210x_write_u16_reg(port, CP210X_IFC_ENABLE, UART_DISABLE);
 771
 772         /* Disabling the interface disables event-insertion mode. */
 773         port_priv->event_mode = false;
 774 }
 775
 776 static void cp210x_process_lsr(struct usb_serial_port *port, unsigned char lsr, char *flag)
 777 {
 778         if (lsr & CP210X_LSR_BREAK) {
 779                 port->icount.brk++;
 780                 *flag = TTY_BREAK;
 781         } else if (lsr & CP210X_LSR_PARITY) {
 782                 port->icount.parity++;
 783                 *flag = TTY_PARITY;
 784         } else if (lsr & CP210X_LSR_FRAME) {
 785                 port->icount.frame++;
 786                 *flag = TTY_FRAME;
 787         }
 788
 789         if (lsr & CP210X_LSR_OVERRUN) {
 790                 port->icount.overrun++;
 791                 tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
 792         }
 793 }
 794
 795 static bool cp210x_process_char(struct usb_serial_port *port, unsigned char *ch, char *flag)
 796 {
 797         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 798
 799         switch (port_priv->event_state) {
 800         case ES_DATA:
 801                 if (*ch == CP210X_ESCCHAR) {
 802                         port_priv->event_state = ES_ESCAPE;
 803                         break;
 804                 }
 805                 return false;
 806         case ES_ESCAPE:
 807                 switch (*ch) {
 808                 case 0:
 809                         dev_dbg(&port->dev, "%s - escape char\n", __func__);
 810                         *ch = CP210X_ESCCHAR;
 811                         port_priv->event_state = ES_DATA;
 812                         return false;
 813                 case 1:
 814                         port_priv->event_state = ES_LSR_DATA_0;
 815                         break;
 816                 case 2:
 817                         port_priv->event_state = ES_LSR;
 818                         break;
 819                 case 3:
 820                         port_priv->event_state = ES_MSR;
 821                         break;
 822                 default:
 823                         dev_err(&port->dev, "malformed event 0x%02x\n", *ch);
 824                         port_priv->event_state = ES_DATA;
 825                         break;
 826                 }
 827                 break;
 828         case ES_LSR_DATA_0:
 829                 port_priv->lsr = *ch;
 830                 port_priv->event_state = ES_LSR_DATA_1;
 831                 break;
 832         case ES_LSR_DATA_1:
 833                 dev_dbg(&port->dev, "%s - lsr = 0x%02x, data = 0x%02x\n",
 834                                 __func__, port_priv->lsr, *ch);
 835                 cp210x_process_lsr(port, port_priv->lsr, flag);
 836                 port_priv->event_state = ES_DATA;
 837                 return false;
 838         case ES_LSR:
 839                 dev_dbg(&port->dev, "%s - lsr = 0x%02x\n", __func__, *ch);
 840                 port_priv->lsr = *ch;
 841                 cp210x_process_lsr(port, port_priv->lsr, flag);
 842                 port_priv->event_state = ES_DATA;
 843                 break;
 844         case ES_MSR:
 845                 dev_dbg(&port->dev, "%s - msr = 0x%02x\n", __func__, *ch);
 846                 /* unimplemented */
 847                 port_priv->event_state = ES_DATA;
 848                 break;
 849         }
 850
 851         return true;
 852 }
 853
 854 static void cp210x_process_read_urb(struct urb *urb)
 855 {
 856         struct usb_serial_port *port = urb->context;
 857         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 858         unsigned char *ch = urb->transfer_buffer;
 859         char flag;
 860         int i;
 861
 862         if (!urb->actual_length)
 863                 return;
 864
 865         if (port_priv->event_mode) {
 866                 for (i = 0; i < urb->actual_length; i++, ch++) {
 867                         flag = TTY_NORMAL;
 868
 869                         if (cp210x_process_char(port, ch, &flag))
 870                                 continue;
 871
 872                         tty_insert_flip_char(&port->port, *ch, flag);
 873                 }
 874         } else {
 875                 tty_insert_flip_string(&port->port, ch, urb->actual_length);
 876         }
 877         tty_flip_buffer_push(&port->port);
 878 }
 879
 880 /*
 881  * Read how many bytes are waiting in the TX queue.
 882  */
 883 static int cp210x_get_tx_queue_byte_count(struct usb_serial_port *port,
 884                 u32 *count)
 885 {
 886         struct usb_serial *serial = port->serial;
 887         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
 888         struct cp210x_comm_status *sts;
 889         int result;
 890
 891         sts = kmalloc(sizeof(*sts), GFP_KERNEL);
 892         if (!sts)
 893                 return -ENOMEM;
 894
 895         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 896                         CP210X_GET_COMM_STATUS, REQTYPE_INTERFACE_TO_HOST,
 897                         0, port_priv->bInterfaceNumber, sts, sizeof(*sts),
 898                         USB_CTRL_GET_TIMEOUT);
 899         if (result == sizeof(*sts)) {
 900                 *count = le32_to_cpu(sts->ulAmountInOutQueue);
 901                 result = 0;
 902         } else {
 903                 dev_err(&port->dev, "failed to get comm status: %d\n", result);
 904                 if (result >= 0)
 905                         result = -EIO;
 906         }
 907
 908         kfree(sts);
 909
 910         return result;
 911 }
 912
 913 static bool cp210x_tx_empty(struct usb_serial_port *port)
 914 {
 915         int err;
 916         u32 count;
 917
 918         err = cp210x_get_tx_queue_byte_count(port, &count);
 919         if (err)
 920                 return true;
 921
 922         return !count;
 923 }
 924
 925 struct cp210x_rate {
 926         speed_t rate;
 927         speed_t high;
 928 };
 929
 930 static const struct cp210x_rate cp210x_an205_table1[] = {
 931         { 300, 300 },
 932         { 600, 600 },
 933         { 1200, 1200 },
 934         { 1800, 1800 },
 935         { 2400, 2400 },
 936         { 4000, 4000 },
 937         { 4800, 4803 },
 938         { 7200, 7207 },
 939         { 9600, 9612 },
 940         { 14400, 14428 },
 941         { 16000, 16062 },
 942         { 19200, 19250 },
 943         { 28800, 28912 },
 944         { 38400, 38601 },
 945         { 51200, 51558 },
 946         { 56000, 56280 },
 947         { 57600, 58053 },
 948         { 64000, 64111 },
 949         { 76800, 77608 },
 950         { 115200, 117028 },
 951         { 128000, 129347 },
 952         { 153600, 156868 },
 953         { 230400, 237832 },
 954         { 250000, 254234 },
 955         { 256000, 273066 },
 956         { 460800, 491520 },
 957         { 500000, 567138 },
 958         { 576000, 670254 },
 959         { 921600, UINT_MAX }
 960 };
 961
 962 /*
 963  * Quantises the baud rate as per AN205 Table 1
 964  */
 965 static speed_t cp210x_get_an205_rate(speed_t baud)
 966 {
 967         int i;
 968
 969         for (i = 0; i < ARRAY_SIZE(cp210x_an205_table1); ++i) {
 970                 if (baud <= cp210x_an205_table1[i].high)
 971                         break;
 972         }
 973
 974         return cp210x_an205_table1[i].rate;
 975 }
 976
 977 static speed_t cp210x_get_actual_rate(speed_t baud)
 978 {
 979         unsigned int prescale = 1;
 980         unsigned int div;
 981
 982         if (baud <= 365)
 983                 prescale = 4;
 984
 985         div = DIV_ROUND_CLOSEST(48000000, 2 * prescale * baud);
 986         baud = 48000000 / (2 * prescale * div);
 987
 988         return baud;
 989 }
 990
 991 /*
 992  * CP2101 supports the following baud rates:
 993  *
 994  *      300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800,
 995  *      38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600
 996  *
 997  * CP2102 and CP2103 support the following additional rates:
 998  *
 999  *      4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000,
1000  *      576000
1001  *
1002  * The device will map a requested rate to a supported one, but the result
1003  * of requests for rates greater than 1053257 is undefined (see AN205).
1004  *
1005  * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud,
1006  * respectively, with an error less than 1%. The actual rates are determined
1007  * by
1008  *
1009  *      div = round(freq / (2 x prescale x request))
1010  *      actual = freq / (2 x prescale x div)
1011  *
1012  * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps
1013  * or 1 otherwise.
1014  * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1
1015  * otherwise.
1016  */
1017 static void cp210x_change_speed(struct tty_struct *tty,
1018                 struct usb_serial_port *port, struct ktermios *old_termios)
1019 {
1020         struct usb_serial *serial = port->serial;
1021         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1022         u32 baud;
1023
1024         /*
1025          * This maps the requested rate to the actual rate, a valid rate on
1026          * cp2102 or cp2103, or to an arbitrary rate in [1M, max_speed].
1027          *
1028          * NOTE: B0 is not implemented.
1029          */
1030         baud = clamp(tty->termios.c_ospeed, priv->min_speed, priv->max_speed);
1031
1032         if (priv->use_actual_rate)
1033                 baud = cp210x_get_actual_rate(baud);
1034         else if (baud < 1000000)
1035                 baud = cp210x_get_an205_rate(baud);
1036
1037         dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud);
1038         if (cp210x_write_u32_reg(port, CP210X_SET_BAUDRATE, baud)) {
1039                 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud);
1040                 if (old_termios)
1041                         baud = old_termios->c_ospeed;
1042                 else
1043                         baud = 9600;
1044         }
1045
1046         tty_encode_baud_rate(tty, baud, baud);
1047 }
1048
1049 static void cp210x_enable_event_mode(struct usb_serial_port *port)
1050 {
1051         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1052         int ret;
1053
1054         if (port_priv->event_mode)
1055                 return;
1056
1057         port_priv->event_state = ES_DATA;
1058         port_priv->event_mode = true;
1059
1060         ret = cp210x_write_u16_reg(port, CP210X_EMBED_EVENTS, CP210X_ESCCHAR);
1061         if (ret) {
1062                 dev_err(&port->dev, "failed to enable events: %d\n", ret);
1063                 port_priv->event_mode = false;
1064         }
1065 }
1066
1067 static void cp210x_disable_event_mode(struct usb_serial_port *port)
1068 {
1069         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1070         int ret;
1071
1072         if (!port_priv->event_mode)
1073                 return;
1074
1075         ret = cp210x_write_u16_reg(port, CP210X_EMBED_EVENTS, 0);
1076         if (ret) {
1077                 dev_err(&port->dev, "failed to disable events: %d\n", ret);
1078                 return;
1079         }
1080
1081         port_priv->event_mode = false;
1082 }
1083
1084 static int cp210x_set_chars(struct usb_serial_port *port,
1085                 struct cp210x_special_chars *chars)
1086 {
1087         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1088         struct usb_serial *serial = port->serial;
1089         void *dmabuf;
1090         int result;
1091
1092         dmabuf = kmemdup(chars, sizeof(*chars), GFP_KERNEL);
1093         if (!dmabuf)
1094                 return -ENOMEM;
1095
1096         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
1097                                 CP210X_SET_CHARS, REQTYPE_HOST_TO_INTERFACE, 0,
1098                                 port_priv->bInterfaceNumber,
1099                                 dmabuf, sizeof(*chars), USB_CTRL_SET_TIMEOUT);
1100
1101         kfree(dmabuf);
1102
1103         if (result < 0) {
1104                 dev_err(&port->dev, "failed to set special chars: %d\n", result);
1105                 return result;
1106         }
1107
1108         return 0;
1109 }
1110
1111 static bool cp210x_termios_change(const struct ktermios *a, const struct ktermios *b)
1112 {
1113         bool iflag_change, cc_change;
1114
1115         iflag_change = ((a->c_iflag ^ b->c_iflag) & (INPCK | IXON | IXOFF));
1116         cc_change = a->c_cc[VSTART] != b->c_cc[VSTART] ||
1117                         a->c_cc[VSTOP] != b->c_cc[VSTOP];
1118
1119         return tty_termios_hw_change(a, b) || iflag_change || cc_change;
1120 }
1121
1122 static void cp210x_set_flow_control(struct tty_struct *tty,
1123                 struct usb_serial_port *port, struct ktermios *old_termios)
1124 {
1125         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1126         struct cp210x_special_chars chars;
1127         struct cp210x_flow_ctl flow_ctl;
1128         u32 flow_repl;
1129         u32 ctl_hs;
1130         int ret;
1131
1132         if (old_termios &&
1133                         C_CRTSCTS(tty) == (old_termios->c_cflag & CRTSCTS) &&
1134                         I_IXON(tty) == (old_termios->c_iflag & IXON) &&
1135                         I_IXOFF(tty) == (old_termios->c_iflag & IXOFF) &&
1136                         START_CHAR(tty) == old_termios->c_cc[VSTART] &&
1137                         STOP_CHAR(tty) == old_termios->c_cc[VSTOP]) {
1138                 return;
1139         }
1140
1141         if (I_IXON(tty) || I_IXOFF(tty)) {
1142                 memset(&chars, 0, sizeof(chars));
1143
1144                 chars.bXonChar = START_CHAR(tty);
1145                 chars.bXoffChar = STOP_CHAR(tty);
1146
1147                 ret = cp210x_set_chars(port, &chars);
1148                 if (ret)
1149                         return;
1150         }
1151
1152         mutex_lock(&port_priv->mutex);
1153
1154         ret = cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1155                         sizeof(flow_ctl));
1156         if (ret)
1157                 goto out_unlock;
1158
1159         ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1160         flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1161
1162         ctl_hs &= ~CP210X_SERIAL_DSR_HANDSHAKE;
1163         ctl_hs &= ~CP210X_SERIAL_DCD_HANDSHAKE;
1164         ctl_hs &= ~CP210X_SERIAL_DSR_SENSITIVITY;
1165         ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1166         if (port_priv->dtr)
1167                 ctl_hs |= CP210X_SERIAL_DTR_ACTIVE;
1168         else
1169                 ctl_hs |= CP210X_SERIAL_DTR_INACTIVE;
1170
1171         flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1172         if (C_CRTSCTS(tty)) {
1173                 ctl_hs |= CP210X_SERIAL_CTS_HANDSHAKE;
1174                 if (port_priv->rts)
1175                         flow_repl |= CP210X_SERIAL_RTS_FLOW_CTL;
1176                 else
1177                         flow_repl |= CP210X_SERIAL_RTS_INACTIVE;
1178                 port_priv->crtscts = true;
1179         } else {
1180                 ctl_hs &= ~CP210X_SERIAL_CTS_HANDSHAKE;
1181                 if (port_priv->rts)
1182                         flow_repl |= CP210X_SERIAL_RTS_ACTIVE;
1183                 else
1184                         flow_repl |= CP210X_SERIAL_RTS_INACTIVE;
1185                 port_priv->crtscts = false;
1186         }
1187
1188         if (I_IXOFF(tty))
1189                 flow_repl |= CP210X_SERIAL_AUTO_RECEIVE;
1190         else
1191                 flow_repl &= ~CP210X_SERIAL_AUTO_RECEIVE;
1192
1193         if (I_IXON(tty))
1194                 flow_repl |= CP210X_SERIAL_AUTO_TRANSMIT;
1195         else
1196                 flow_repl &= ~CP210X_SERIAL_AUTO_TRANSMIT;
1197
1198         flow_ctl.ulXonLimit = cpu_to_le32(128);
1199         flow_ctl.ulXoffLimit = cpu_to_le32(128);
1200
1201         dev_dbg(&port->dev, "%s - ctrl = 0x%02x, flow = 0x%02x\n", __func__,
1202                         ctl_hs, flow_repl);
1203
1204         flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1205         flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1206
1207         cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1208                         sizeof(flow_ctl));
1209 out_unlock:
1210         mutex_unlock(&port_priv->mutex);
1211 }
1212
1213 static void cp210x_set_termios(struct tty_struct *tty,
1214                 struct usb_serial_port *port, struct ktermios *old_termios)
1215 {
1216         struct cp210x_serial_private *priv = usb_get_serial_data(port->serial);
1217         u16 bits;
1218         int ret;
1219
1220         if (old_termios && !cp210x_termios_change(&tty->termios, old_termios))
1221                 return;
1222
1223         if (!old_termios || tty->termios.c_ospeed != old_termios->c_ospeed)
1224                 cp210x_change_speed(tty, port, old_termios);
1225
1226         /* CP2101 only supports CS8, 1 stop bit and non-stick parity. */
1227         if (priv->partnum == CP210X_PARTNUM_CP2101) {
1228                 tty->termios.c_cflag &= ~(CSIZE | CSTOPB | CMSPAR);
1229                 tty->termios.c_cflag |= CS8;
1230         }
1231
1232         bits = 0;
1233
1234         switch (C_CSIZE(tty)) {
1235         case CS5:
1236                 bits |= BITS_DATA_5;
1237                 break;
1238         case CS6:
1239                 bits |= BITS_DATA_6;
1240                 break;
1241         case CS7:
1242                 bits |= BITS_DATA_7;
1243                 break;
1244         case CS8:
1245         default:
1246                 bits |= BITS_DATA_8;
1247                 break;
1248         }
1249
1250         if (C_PARENB(tty)) {
1251                 if (C_CMSPAR(tty)) {
1252                         if (C_PARODD(tty))
1253                                 bits |= BITS_PARITY_MARK;
1254                         else
1255                                 bits |= BITS_PARITY_SPACE;
1256                 } else {
1257                         if (C_PARODD(tty))
1258                                 bits |= BITS_PARITY_ODD;
1259                         else
1260                                 bits |= BITS_PARITY_EVEN;
1261                 }
1262         }
1263
1264         if (C_CSTOPB(tty))
1265                 bits |= BITS_STOP_2;
1266         else
1267                 bits |= BITS_STOP_1;
1268
1269         ret = cp210x_write_u16_reg(port, CP210X_SET_LINE_CTL, bits);
1270         if (ret)
1271                 dev_err(&port->dev, "failed to set line control: %d\n", ret);
1272
1273         cp210x_set_flow_control(tty, port, old_termios);
1274
1275         /*
1276          * Enable event-insertion mode only if input parity checking is
1277          * enabled for now.
1278          */
1279         if (I_INPCK(tty))
1280                 cp210x_enable_event_mode(port);
1281         else
1282                 cp210x_disable_event_mode(port);
1283 }
1284
1285 static int cp210x_tiocmset(struct tty_struct *tty,
1286                 unsigned int set, unsigned int clear)
1287 {
1288         struct usb_serial_port *port = tty->driver_data;
1289         return cp210x_tiocmset_port(port, set, clear);
1290 }
1291
1292 static int cp210x_tiocmset_port(struct usb_serial_port *port,
1293                 unsigned int set, unsigned int clear)
1294 {
1295         struct cp210x_port_private *port_priv = usb_get_serial_port_data(port);
1296         struct cp210x_flow_ctl flow_ctl;
1297         u32 ctl_hs, flow_repl;
1298         u16 control = 0;
1299         int ret;
1300
1301         mutex_lock(&port_priv->mutex);
1302
1303         if (set & TIOCM_RTS) {
1304                 port_priv->rts = true;
1305                 control |= CONTROL_RTS;
1306                 control |= CONTROL_WRITE_RTS;
1307         }
1308         if (set & TIOCM_DTR) {
1309                 port_priv->dtr = true;
1310                 control |= CONTROL_DTR;
1311                 control |= CONTROL_WRITE_DTR;
1312         }
1313         if (clear & TIOCM_RTS) {
1314                 port_priv->rts = false;
1315                 control &= ~CONTROL_RTS;
1316                 control |= CONTROL_WRITE_RTS;
1317         }
1318         if (clear & TIOCM_DTR) {
1319                 port_priv->dtr = false;
1320                 control &= ~CONTROL_DTR;
1321                 control |= CONTROL_WRITE_DTR;
1322         }
1323
1324         /*
1325          * Use SET_FLOW to set DTR and enable/disable auto-RTS when hardware
1326          * flow control is enabled.
1327          */
1328         if (port_priv->crtscts && control & CONTROL_WRITE_RTS) {
1329                 ret = cp210x_read_reg_block(port, CP210X_GET_FLOW, &flow_ctl,
1330                                 sizeof(flow_ctl));
1331                 if (ret)
1332                         goto out_unlock;
1333
1334                 ctl_hs = le32_to_cpu(flow_ctl.ulControlHandshake);
1335                 flow_repl = le32_to_cpu(flow_ctl.ulFlowReplace);
1336
1337                 ctl_hs &= ~CP210X_SERIAL_DTR_MASK;
1338                 if (port_priv->dtr)
1339                         ctl_hs |= CP210X_SERIAL_DTR_ACTIVE;
1340                 else
1341                         ctl_hs |= CP210X_SERIAL_DTR_INACTIVE;
1342
1343                 flow_repl &= ~CP210X_SERIAL_RTS_MASK;
1344                 if (port_priv->rts)
1345                         flow_repl |= CP210X_SERIAL_RTS_FLOW_CTL;
1346                 else
1347                         flow_repl |= CP210X_SERIAL_RTS_INACTIVE;
1348
1349                 flow_ctl.ulControlHandshake = cpu_to_le32(ctl_hs);
1350                 flow_ctl.ulFlowReplace = cpu_to_le32(flow_repl);
1351
1352                 dev_dbg(&port->dev, "%s - ctrl = 0x%02x, flow = 0x%02x\n",
1353                                 __func__, ctl_hs, flow_repl);
1354
1355                 ret = cp210x_write_reg_block(port, CP210X_SET_FLOW, &flow_ctl,
1356                                 sizeof(flow_ctl));
1357         } else {
1358                 dev_dbg(&port->dev, "%s - control = 0x%04x\n", __func__, control);
1359
1360                 ret = cp210x_write_u16_reg(port, CP210X_SET_MHS, control);
1361         }
1362 out_unlock:
1363         mutex_unlock(&port_priv->mutex);
1364
1365         return ret;
1366 }
1367
1368 static void cp210x_dtr_rts(struct usb_serial_port *port, int on)
1369 {
1370         if (on)
1371                 cp210x_tiocmset_port(port, TIOCM_DTR | TIOCM_RTS, 0);
1372         else
1373                 cp210x_tiocmset_port(port, 0, TIOCM_DTR | TIOCM_RTS);
1374 }
1375
1376 static int cp210x_tiocmget(struct tty_struct *tty)
1377 {
1378         struct usb_serial_port *port = tty->driver_data;
1379         u8 control;
1380         int result;
1381
1382         result = cp210x_read_u8_reg(port, CP210X_GET_MDMSTS, &control);
1383         if (result)
1384                 return result;
1385
1386         result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
1387                 |((control & CONTROL_RTS) ? TIOCM_RTS : 0)
1388                 |((control & CONTROL_CTS) ? TIOCM_CTS : 0)
1389                 |((control & CONTROL_DSR) ? TIOCM_DSR : 0)
1390                 |((control & CONTROL_RING)? TIOCM_RI  : 0)
1391                 |((control & CONTROL_DCD) ? TIOCM_CD  : 0);
1392
1393         dev_dbg(&port->dev, "%s - control = 0x%02x\n", __func__, control);
1394
1395         return result;
1396 }
1397
1398 static void cp210x_break_ctl(struct tty_struct *tty, int break_state)
1399 {
1400         struct usb_serial_port *port = tty->driver_data;
1401         u16 state;
1402
1403         if (break_state == 0)
1404                 state = BREAK_OFF;
1405         else
1406                 state = BREAK_ON;
1407         dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
1408                 state == BREAK_OFF ? "off" : "on");
1409         cp210x_write_u16_reg(port, CP210X_SET_BREAK, state);
1410 }
1411
1412 #ifdef CONFIG_GPIOLIB
1413 static int cp210x_gpio_get(struct gpio_chip *gc, unsigned int gpio)
1414 {
1415         struct usb_serial *serial = gpiochip_get_data(gc);
1416         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1417         u8 req_type = REQTYPE_DEVICE_TO_HOST;
1418         int result;
1419         u8 buf;
1420
1421         if (priv->partnum == CP210X_PARTNUM_CP2105)
1422                 req_type = REQTYPE_INTERFACE_TO_HOST;
1423
1424         result = usb_autopm_get_interface(serial->interface);
1425         if (result)
1426                 return result;
1427
1428         result = cp210x_read_vendor_block(serial, req_type,
1429                                           CP210X_READ_LATCH, &buf, sizeof(buf));
1430         usb_autopm_put_interface(serial->interface);
1431         if (result < 0)
1432                 return result;
1433
1434         return !!(buf & BIT(gpio));
1435 }
1436
1437 static void cp210x_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)
1438 {
1439         struct usb_serial *serial = gpiochip_get_data(gc);
1440         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1441         struct cp210x_gpio_write buf;
1442         int result;
1443
1444         if (value == 1)
1445                 buf.state = BIT(gpio);
1446         else
1447                 buf.state = 0;
1448
1449         buf.mask = BIT(gpio);
1450
1451         result = usb_autopm_get_interface(serial->interface);
1452         if (result)
1453                 goto out;
1454
1455         if (priv->partnum == CP210X_PARTNUM_CP2105) {
1456                 result = cp210x_write_vendor_block(serial,
1457                                                    REQTYPE_HOST_TO_INTERFACE,
1458                                                    CP210X_WRITE_LATCH, &buf,
1459                                                    sizeof(buf));
1460         } else {
1461                 u16 wIndex = buf.state << 8 | buf.mask;
1462
1463                 result = usb_control_msg(serial->dev,
1464                                          usb_sndctrlpipe(serial->dev, 0),
1465                                          CP210X_VENDOR_SPECIFIC,
1466                                          REQTYPE_HOST_TO_DEVICE,
1467                                          CP210X_WRITE_LATCH,
1468                                          wIndex,
1469                                          NULL, 0, USB_CTRL_SET_TIMEOUT);
1470         }
1471
1472         usb_autopm_put_interface(serial->interface);
1473 out:
1474         if (result < 0) {
1475                 dev_err(&serial->interface->dev, "failed to set GPIO value: %d\n",
1476                                 result);
1477         }
1478 }
1479
1480 static int cp210x_gpio_direction_get(struct gpio_chip *gc, unsigned int gpio)
1481 {
1482         struct usb_serial *serial = gpiochip_get_data(gc);
1483         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1484
1485         return priv->gpio_input & BIT(gpio);
1486 }
1487
1488 static int cp210x_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
1489 {
1490         struct usb_serial *serial = gpiochip_get_data(gc);
1491         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1492
1493         if (priv->partnum == CP210X_PARTNUM_CP2105) {
1494                 /* hardware does not support an input mode */
1495                 return -ENOTSUPP;
1496         }
1497
1498         /* push-pull pins cannot be changed to be inputs */
1499         if (priv->gpio_pushpull & BIT(gpio))
1500                 return -EINVAL;
1501
1502         /* make sure to release pin if it is being driven low */
1503         cp210x_gpio_set(gc, gpio, 1);
1504
1505         priv->gpio_input |= BIT(gpio);
1506
1507         return 0;
1508 }
1509
1510 static int cp210x_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
1511                                         int value)
1512 {
1513         struct usb_serial *serial = gpiochip_get_data(gc);
1514         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1515
1516         priv->gpio_input &= ~BIT(gpio);
1517         cp210x_gpio_set(gc, gpio, value);
1518
1519         return 0;
1520 }
1521
1522 static int cp210x_gpio_set_config(struct gpio_chip *gc, unsigned int gpio,
1523                                   unsigned long config)
1524 {
1525         struct usb_serial *serial = gpiochip_get_data(gc);
1526         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1527         enum pin_config_param param = pinconf_to_config_param(config);
1528
1529         /* Succeed only if in correct mode (this can't be set at runtime) */
1530         if ((param == PIN_CONFIG_DRIVE_PUSH_PULL) &&
1531             (priv->gpio_pushpull & BIT(gpio)))
1532                 return 0;
1533
1534         if ((param == PIN_CONFIG_DRIVE_OPEN_DRAIN) &&
1535             !(priv->gpio_pushpull & BIT(gpio)))
1536                 return 0;
1537
1538         return -ENOTSUPP;
1539 }
1540
1541 static int cp210x_gpio_init_valid_mask(struct gpio_chip *gc,
1542                 unsigned long *valid_mask, unsigned int ngpios)
1543 {
1544         struct usb_serial *serial = gpiochip_get_data(gc);
1545         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1546         struct device *dev = &serial->interface->dev;
1547         unsigned long altfunc_mask = priv->gpio_altfunc;
1548
1549         bitmap_complement(valid_mask, &altfunc_mask, ngpios);
1550
1551         if (bitmap_empty(valid_mask, ngpios))
1552                 dev_dbg(dev, "no pin configured for GPIO\n");
1553         else
1554                 dev_dbg(dev, "GPIO.%*pbl configured for GPIO\n", ngpios,
1555                                 valid_mask);
1556         return 0;
1557 }
1558
1559 /*
1560  * This function is for configuring GPIO using shared pins, where other signals
1561  * are made unavailable by configuring the use of GPIO. This is believed to be
1562  * only applicable to the cp2105 at this point, the other devices supported by
1563  * this driver that provide GPIO do so in a way that does not impact other
1564  * signals and are thus expected to have very different initialisation.
1565  */
1566 static int cp2105_gpioconf_init(struct usb_serial *serial)
1567 {
1568         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1569         struct cp210x_pin_mode mode;
1570         struct cp210x_dual_port_config config;
1571         u8 intf_num = cp210x_interface_num(serial);
1572         u8 iface_config;
1573         int result;
1574
1575         result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1576                                           CP210X_GET_DEVICEMODE, &mode,
1577                                           sizeof(mode));
1578         if (result < 0)
1579                 return result;
1580
1581         result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1582                                           CP210X_GET_PORTCONFIG, &config,
1583                                           sizeof(config));
1584         if (result < 0)
1585                 return result;
1586
1587         /*  2 banks of GPIO - One for the pins taken from each serial port */
1588         if (intf_num == 0) {
1589                 if (mode.eci == CP210X_PIN_MODE_MODEM) {
1590                         /* mark all GPIOs of this interface as reserved */
1591                         priv->gpio_altfunc = 0xff;
1592                         return 0;
1593                 }
1594
1595                 iface_config = config.eci_cfg;
1596                 priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1597                                                 CP210X_ECI_GPIO_MODE_MASK) >>
1598                                                 CP210X_ECI_GPIO_MODE_OFFSET);
1599                 priv->gc.ngpio = 2;
1600         } else if (intf_num == 1) {
1601                 if (mode.sci == CP210X_PIN_MODE_MODEM) {
1602                         /* mark all GPIOs of this interface as reserved */
1603                         priv->gpio_altfunc = 0xff;
1604                         return 0;
1605                 }
1606
1607                 iface_config = config.sci_cfg;
1608                 priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1609                                                 CP210X_SCI_GPIO_MODE_MASK) >>
1610                                                 CP210X_SCI_GPIO_MODE_OFFSET);
1611                 priv->gc.ngpio = 3;
1612         } else {
1613                 return -ENODEV;
1614         }
1615
1616         /* mark all pins which are not in GPIO mode */
1617         if (iface_config & CP2105_GPIO0_TXLED_MODE)     /* GPIO 0 */
1618                 priv->gpio_altfunc |= BIT(0);
1619         if (iface_config & (CP2105_GPIO1_RXLED_MODE |   /* GPIO 1 */
1620                         CP2105_GPIO1_RS485_MODE))
1621                 priv->gpio_altfunc |= BIT(1);
1622
1623         /* driver implementation for CP2105 only supports outputs */
1624         priv->gpio_input = 0;
1625
1626         return 0;
1627 }
1628
1629 static int cp2104_gpioconf_init(struct usb_serial *serial)
1630 {
1631         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1632         struct cp210x_single_port_config config;
1633         u8 iface_config;
1634         u8 gpio_latch;
1635         int result;
1636         u8 i;
1637
1638         result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1639                                           CP210X_GET_PORTCONFIG, &config,
1640                                           sizeof(config));
1641         if (result < 0)
1642                 return result;
1643
1644         priv->gc.ngpio = 4;
1645
1646         iface_config = config.device_cfg;
1647         priv->gpio_pushpull = (u8)((le16_to_cpu(config.gpio_mode) &
1648                                         CP210X_GPIO_MODE_MASK) >>
1649                                         CP210X_GPIO_MODE_OFFSET);
1650         gpio_latch = (u8)((le16_to_cpu(config.reset_state) &
1651                                         CP210X_GPIO_MODE_MASK) >>
1652                                         CP210X_GPIO_MODE_OFFSET);
1653
1654         /* mark all pins which are not in GPIO mode */
1655         if (iface_config & CP2104_GPIO0_TXLED_MODE)     /* GPIO 0 */
1656                 priv->gpio_altfunc |= BIT(0);
1657         if (iface_config & CP2104_GPIO1_RXLED_MODE)     /* GPIO 1 */
1658                 priv->gpio_altfunc |= BIT(1);
1659         if (iface_config & CP2104_GPIO2_RS485_MODE)     /* GPIO 2 */
1660                 priv->gpio_altfunc |= BIT(2);
1661
1662         /*
1663          * Like CP2102N, CP2104 has also no strict input and output pin
1664          * modes.
1665          * Do the same input mode emulation as CP2102N.
1666          */
1667         for (i = 0; i < priv->gc.ngpio; ++i) {
1668                 /*
1669                  * Set direction to "input" iff pin is open-drain and reset
1670                  * value is 1.
1671                  */
1672                 if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1673                         priv->gpio_input |= BIT(i);
1674         }
1675
1676         return 0;
1677 }
1678
1679 static int cp2102n_gpioconf_init(struct usb_serial *serial)
1680 {
1681         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1682         const u16 config_size = 0x02a6;
1683         u8 gpio_rst_latch;
1684         u8 config_version;
1685         u8 gpio_pushpull;
1686         u8 *config_buf;
1687         u8 gpio_latch;
1688         u8 gpio_ctrl;
1689         int result;
1690         u8 i;
1691
1692         /*
1693          * Retrieve device configuration from the device.
1694          * The array received contains all customization settings done at the
1695          * factory/manufacturer. Format of the array is documented at the
1696          * time of writing at:
1697          * https://www.silabs.com/community/interface/knowledge-base.entry.html/2017/03/31/cp2102n_setconfig-xsfa
1698          */
1699         config_buf = kmalloc(config_size, GFP_KERNEL);
1700         if (!config_buf)
1701                 return -ENOMEM;
1702
1703         result = cp210x_read_vendor_block(serial,
1704                                           REQTYPE_DEVICE_TO_HOST,
1705                                           CP210X_READ_2NCONFIG,
1706                                           config_buf,
1707                                           config_size);
1708         if (result < 0) {
1709                 kfree(config_buf);
1710                 return result;
1711         }
1712
1713         config_version = config_buf[CP210X_2NCONFIG_CONFIG_VERSION_IDX];
1714         gpio_pushpull = config_buf[CP210X_2NCONFIG_GPIO_MODE_IDX];
1715         gpio_ctrl = config_buf[CP210X_2NCONFIG_GPIO_CONTROL_IDX];
1716         gpio_rst_latch = config_buf[CP210X_2NCONFIG_GPIO_RSTLATCH_IDX];
1717
1718         kfree(config_buf);
1719
1720         /* Make sure this is a config format we understand. */
1721         if (config_version != 0x01)
1722                 return -ENOTSUPP;
1723
1724         priv->gc.ngpio = 4;
1725
1726         /*
1727          * Get default pin states after reset. Needed so we can determine
1728          * the direction of an open-drain pin.
1729          */
1730         gpio_latch = (gpio_rst_latch >> 3) & 0x0f;
1731
1732         /* 0 indicates open-drain mode, 1 is push-pull */
1733         priv->gpio_pushpull = (gpio_pushpull >> 3) & 0x0f;
1734
1735         /* 0 indicates GPIO mode, 1 is alternate function */
1736         priv->gpio_altfunc = (gpio_ctrl >> 2) & 0x0f;
1737
1738         if (priv->partnum == CP210X_PARTNUM_CP2102N_QFN28) {
1739                 /*
1740                  * For the QFN28 package, GPIO4-6 are controlled by
1741                  * the low three bits of the mode/latch fields.
1742                  * Contrary to the document linked above, the bits for
1743                  * the SUSPEND pins are elsewhere.  No alternate
1744                  * function is available for these pins.
1745                  */
1746                 priv->gc.ngpio = 7;
1747                 gpio_latch |= (gpio_rst_latch & 7) << 4;
1748                 priv->gpio_pushpull |= (gpio_pushpull & 7) << 4;
1749         }
1750
1751         /*
1752          * The CP2102N does not strictly has input and output pin modes,
1753          * it only knows open-drain and push-pull modes which is set at
1754          * factory. An open-drain pin can function both as an
1755          * input or an output. We emulate input mode for open-drain pins
1756          * by making sure they are not driven low, and we do not allow
1757          * push-pull pins to be set as an input.
1758          */
1759         for (i = 0; i < priv->gc.ngpio; ++i) {
1760                 /*
1761                  * Set direction to "input" iff pin is open-drain and reset
1762                  * value is 1.
1763                  */
1764                 if (!(priv->gpio_pushpull & BIT(i)) && (gpio_latch & BIT(i)))
1765                         priv->gpio_input |= BIT(i);
1766         }
1767
1768         return 0;
1769 }
1770
1771 static int cp210x_gpio_init(struct usb_serial *serial)
1772 {
1773         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1774         int result;
1775
1776         switch (priv->partnum) {
1777         case CP210X_PARTNUM_CP2104:
1778                 result = cp2104_gpioconf_init(serial);
1779                 break;
1780         case CP210X_PARTNUM_CP2105:
1781                 result = cp2105_gpioconf_init(serial);
1782                 break;
1783         case CP210X_PARTNUM_CP2102N_QFN28:
1784         case CP210X_PARTNUM_CP2102N_QFN24:
1785         case CP210X_PARTNUM_CP2102N_QFN20:
1786                 result = cp2102n_gpioconf_init(serial);
1787                 break;
1788         default:
1789                 return 0;
1790         }
1791
1792         if (result < 0)
1793                 return result;
1794
1795         priv->gc.label = "cp210x";
1796         priv->gc.get_direction = cp210x_gpio_direction_get;
1797         priv->gc.direction_input = cp210x_gpio_direction_input;
1798         priv->gc.direction_output = cp210x_gpio_direction_output;
1799         priv->gc.get = cp210x_gpio_get;
1800         priv->gc.set = cp210x_gpio_set;
1801         priv->gc.set_config = cp210x_gpio_set_config;
1802         priv->gc.init_valid_mask = cp210x_gpio_init_valid_mask;
1803         priv->gc.owner = THIS_MODULE;
1804         priv->gc.parent = &serial->interface->dev;
1805         priv->gc.base = -1;
1806         priv->gc.can_sleep = true;
1807
1808         result = gpiochip_add_data(&priv->gc, serial);
1809         if (!result)
1810                 priv->gpio_registered = true;
1811
1812         return result;
1813 }
1814
1815 static void cp210x_gpio_remove(struct usb_serial *serial)
1816 {
1817         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1818
1819         if (priv->gpio_registered) {
1820                 gpiochip_remove(&priv->gc);
1821                 priv->gpio_registered = false;
1822         }
1823 }
1824
1825 #else
1826
1827 static int cp210x_gpio_init(struct usb_serial *serial)
1828 {
1829         return 0;
1830 }
1831
1832 static void cp210x_gpio_remove(struct usb_serial *serial)
1833 {
1834         /* Nothing to do */
1835 }
1836
1837 #endif
1838
1839 static int cp210x_port_probe(struct usb_serial_port *port)
1840 {
1841         struct usb_serial *serial = port->serial;
1842         struct cp210x_port_private *port_priv;
1843
1844         port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
1845         if (!port_priv)
1846                 return -ENOMEM;
1847
1848         port_priv->bInterfaceNumber = cp210x_interface_num(serial);
1849         mutex_init(&port_priv->mutex);
1850
1851         usb_set_serial_port_data(port, port_priv);
1852
1853         return 0;
1854 }
1855
1856 static void cp210x_port_remove(struct usb_serial_port *port)
1857 {
1858         struct cp210x_port_private *port_priv;
1859
1860         port_priv = usb_get_serial_port_data(port);
1861         kfree(port_priv);
1862 }
1863
1864 static void cp210x_init_max_speed(struct usb_serial *serial)
1865 {
1866         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1867         bool use_actual_rate = false;
1868         speed_t min = 300;
1869         speed_t max;
1870
1871         switch (priv->partnum) {
1872         case CP210X_PARTNUM_CP2101:
1873                 max = 921600;
1874                 break;
1875         case CP210X_PARTNUM_CP2102:
1876         case CP210X_PARTNUM_CP2103:
1877                 max = 1000000;
1878                 break;
1879         case CP210X_PARTNUM_CP2104:
1880                 use_actual_rate = true;
1881                 max = 2000000;
1882                 break;
1883         case CP210X_PARTNUM_CP2108:
1884                 max = 2000000;
1885                 break;
1886         case CP210X_PARTNUM_CP2105:
1887                 if (cp210x_interface_num(serial) == 0) {
1888                         use_actual_rate = true;
1889                         max = 2000000;  /* ECI */
1890                 } else {
1891                         min = 2400;
1892                         max = 921600;   /* SCI */
1893                 }
1894                 break;
1895         case CP210X_PARTNUM_CP2102N_QFN28:
1896         case CP210X_PARTNUM_CP2102N_QFN24:
1897         case CP210X_PARTNUM_CP2102N_QFN20:
1898                 use_actual_rate = true;
1899                 max = 3000000;
1900                 break;
1901         default:
1902                 max = 2000000;
1903                 break;
1904         }
1905
1906         priv->min_speed = min;
1907         priv->max_speed = max;
1908         priv->use_actual_rate = use_actual_rate;
1909 }
1910
1911 static int cp210x_attach(struct usb_serial *serial)
1912 {
1913         int result;
1914         struct cp210x_serial_private *priv;
1915
1916         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1917         if (!priv)
1918                 return -ENOMEM;
1919
1920         result = cp210x_read_vendor_block(serial, REQTYPE_DEVICE_TO_HOST,
1921                                           CP210X_GET_PARTNUM, &priv->partnum,
1922                                           sizeof(priv->partnum));
1923         if (result < 0) {
1924                 dev_warn(&serial->interface->dev,
1925                          "querying part number failed\n");
1926                 priv->partnum = CP210X_PARTNUM_UNKNOWN;
1927         }
1928
1929         usb_set_serial_data(serial, priv);
1930
1931         cp210x_init_max_speed(serial);
1932
1933         result = cp210x_gpio_init(serial);
1934         if (result < 0) {
1935                 dev_err(&serial->interface->dev, "GPIO initialisation failed: %d\n",
1936                                 result);
1937         }
1938
1939         return 0;
1940 }
1941
1942 static void cp210x_disconnect(struct usb_serial *serial)
1943 {
1944         cp210x_gpio_remove(serial);
1945 }
1946
1947 static void cp210x_release(struct usb_serial *serial)
1948 {
1949         struct cp210x_serial_private *priv = usb_get_serial_data(serial);
1950
1951         cp210x_gpio_remove(serial);
1952
1953         kfree(priv);
1954 }
1955
1956 module_usb_serial_driver(serial_drivers, id_table);
1957
1958 MODULE_DESCRIPTION(DRIVER_DESC);
1959 MODULE_LICENSE("GPL v2");