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