Linux Audio

Check our new training course

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