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 */ 32 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *); 33 static void cp210x_close(struct usb_serial_port *); 34 static void cp210x_get_termios(struct tty_struct *, struct usb_serial_port *); 35 static void cp210x_get_termios_port(struct usb_serial_port *port, 36 unsigned int *cflagp, unsigned int *baudp); 37 static void cp210x_change_speed(struct tty_struct *, struct usb_serial_port *, 38 struct ktermios *); 39 static void cp210x_set_termios(struct tty_struct *, struct usb_serial_port *, 40 struct ktermios*); 41 static int cp210x_tiocmget(struct tty_struct *); 42 static int cp210x_tiocmset(struct tty_struct *, unsigned int, unsigned int); 43 static int cp210x_tiocmset_port(struct usb_serial_port *port, 44 unsigned int, unsigned int); 45 static void cp210x_break_ctl(struct tty_struct *, int); 46 static int cp210x_startup(struct usb_serial *); 47 static void cp210x_release(struct usb_serial *); 48 static void cp210x_dtr_rts(struct usb_serial_port *p, int on); 49 50 static 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(0x0908, 0x01FF) }, /* Siemens RUGGEDCOM USB Serial Console */ 60 { USB_DEVICE(0x0BED, 0x1100) }, /* MEI (TM) Cashflow-SC Bill/Voucher Acceptor */ 61 { USB_DEVICE(0x0BED, 0x1101) }, /* MEI series 2000 Combo Acceptor */ 62 { USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */ 63 { USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */ 64 { USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */ 65 { USB_DEVICE(0x0FDE, 0xCA05) }, /* OWL Wireless Electricity Monitor CM-160 */ 66 { USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */ 67 { USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */ 68 { USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */ 69 { USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */ 70 { USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */ 71 { USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */ 72 { USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */ 73 { USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */ 74 { USB_DEVICE(0x10C4, 0x8044) }, /* Cygnal Debug Adapter */ 75 { USB_DEVICE(0x10C4, 0x804E) }, /* Software Bisque Paramount ME build-in converter */ 76 { USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */ 77 { USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */ 78 { USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */ 79 { USB_DEVICE(0x10C4, 0x806F) }, /* IMS USB to RS422 Converter Cable */ 80 { USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */ 81 { USB_DEVICE(0x10C4, 0x80C4) }, /* Cygnal Integrated Products, Inc., Optris infrared thermometer */ 82 { USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */ 83 { USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */ 84 { USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */ 85 { USB_DEVICE(0x10C4, 0x8115) }, /* Arygon NFC/Mifare Reader */ 86 { USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */ 87 { USB_DEVICE(0x10C4, 0x813F) }, /* Tams Master Easy Control */ 88 { USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */ 89 { USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */ 90 { USB_DEVICE(0x2405, 0x0003) }, /* West Mountain Radio RIGblaster Advantage */ 91 { USB_DEVICE(0x10C4, 0x8156) }, /* B&G H3000 link cable */ 92 { USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */ 93 { USB_DEVICE(0x10C4, 0x815F) }, /* Timewave HamLinkUSB */ 94 { USB_DEVICE(0x10C4, 0x818B) }, /* AVIT Research USB to TTL */ 95 { USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */ 96 { USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */ 97 { USB_DEVICE(0x10C4, 0x81A9) }, /* Multiplex RC Interface */ 98 { USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */ 99 { USB_DEVICE(0x10C4, 0x81AD) }, /* INSYS USB Modem */ 100 { USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */ 101 { USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */ 102 { USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */ 103 { USB_DEVICE(0x10C4, 0x81E8) }, /* Zephyr Bioharness */ 104 { USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */ 105 { USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */ 106 { USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */ 107 { USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demonstration module */ 108 { USB_DEVICE(0x10C4, 0x8281) }, /* Nanotec Plug & Drive */ 109 { USB_DEVICE(0x10C4, 0x8293) }, /* Telegesis ETRX2USB */ 110 { USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */ 111 { USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */ 112 { USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */ 113 { USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */ 114 { USB_DEVICE(0x10C4, 0x83D8) }, /* DekTec DTA Plus VHF/UHF Booster/Attenuator */ 115 { USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */ 116 { USB_DEVICE(0x10C4, 0x8418) }, /* IRZ Automation Teleport SG-10 GSM/GPRS Modem */ 117 { USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */ 118 { USB_DEVICE(0x10C4, 0x8477) }, /* Balluff RFID */ 119 { USB_DEVICE(0x10C4, 0x85EA) }, /* AC-Services IBUS-IF */ 120 { USB_DEVICE(0x10C4, 0x85EB) }, /* AC-Services CIS-IBUS */ 121 { USB_DEVICE(0x10C4, 0x85F8) }, /* Virtenio Preon32 */ 122 { USB_DEVICE(0x10C4, 0x8664) }, /* AC-Services CAN-IF */ 123 { USB_DEVICE(0x10C4, 0x8665) }, /* AC-Services OBD-IF */ 124 { USB_DEVICE(0x10C4, 0x8856) }, /* CEL EM357 ZigBee USB Stick - LR */ 125 { USB_DEVICE(0x10C4, 0x8857) }, /* CEL EM357 ZigBee USB Stick */ 126 { USB_DEVICE(0x10C4, 0x88A4) }, /* MMB Networks ZigBee USB Device */ 127 { USB_DEVICE(0x10C4, 0x88A5) }, /* Planet Innovation Ingeni ZigBee USB Device */ 128 { USB_DEVICE(0x10C4, 0x8946) }, /* Ketra N1 Wireless Interface */ 129 { USB_DEVICE(0x10C4, 0x8977) }, /* CEL MeshWorks DevKit Device */ 130 { USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */ 131 { USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */ 132 { USB_DEVICE(0x10C4, 0xEA70) }, /* Silicon Labs factory default */ 133 { USB_DEVICE(0x10C4, 0xEA80) }, /* Silicon Labs factory default */ 134 { USB_DEVICE(0x10C4, 0xEA71) }, /* Infinity GPS-MIC-1 Radio Monophone */ 135 { USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */ 136 { USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */ 137 { USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */ 138 { USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */ 139 { USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */ 140 { USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */ 141 { USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */ 142 { USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */ 143 { USB_DEVICE(0x166A, 0x0201) }, /* Clipsal 5500PACA C-Bus Pascal Automation Controller */ 144 { USB_DEVICE(0x166A, 0x0301) }, /* Clipsal 5800PC C-Bus Wireless PC Interface */ 145 { USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */ 146 { USB_DEVICE(0x166A, 0x0304) }, /* Clipsal 5000CT2 C-Bus Black and White Touchscreen */ 147 { USB_DEVICE(0x166A, 0x0305) }, /* Clipsal C-5000CT2 C-Bus Spectrum Colour Touchscreen */ 148 { USB_DEVICE(0x166A, 0x0401) }, /* Clipsal L51xx C-Bus Architectural Dimmer */ 149 { USB_DEVICE(0x166A, 0x0101) }, /* Clipsal 5560884 C-Bus Multi-room Audio Matrix Switcher */ 150 { USB_DEVICE(0x16C0, 0x09B0) }, /* Lunatico Seletek */ 151 { USB_DEVICE(0x16C0, 0x09B1) }, /* Lunatico Seletek */ 152 { USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */ 153 { USB_DEVICE(0x16DC, 0x0010) }, /* W-IE-NE-R Plein & Baus GmbH PL512 Power Supply */ 154 { USB_DEVICE(0x16DC, 0x0011) }, /* W-IE-NE-R Plein & Baus GmbH RCM Remote Control for MARATON Power Supply */ 155 { USB_DEVICE(0x16DC, 0x0012) }, /* W-IE-NE-R Plein & Baus GmbH MPOD Multi Channel Power Supply */ 156 { USB_DEVICE(0x16DC, 0x0015) }, /* W-IE-NE-R Plein & Baus GmbH CML Control, Monitoring and Data Logger */ 157 { USB_DEVICE(0x17A8, 0x0001) }, /* Kamstrup Optical Eye/3-wire */ 158 { USB_DEVICE(0x17A8, 0x0005) }, /* Kamstrup M-Bus Master MultiPort 250D */ 159 { USB_DEVICE(0x17F4, 0xAAAA) }, /* Wavesense Jazz blood glucose meter */ 160 { USB_DEVICE(0x1843, 0x0200) }, /* Vaisala USB Instrument Cable */ 161 { USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */ 162 { USB_DEVICE(0x1ADB, 0x0001) }, /* Schweitzer Engineering C662 Cable */ 163 { USB_DEVICE(0x1B1C, 0x1C00) }, /* Corsair USB Dongle */ 164 { USB_DEVICE(0x1BA4, 0x0002) }, /* Silicon Labs 358x factory default */ 165 { USB_DEVICE(0x1BE3, 0x07A6) }, /* WAGO 750-923 USB Service Cable */ 166 { USB_DEVICE(0x1D6F, 0x0010) }, /* Seluxit ApS RF Dongle */ 167 { USB_DEVICE(0x1E29, 0x0102) }, /* Festo CPX-USB */ 168 { USB_DEVICE(0x1E29, 0x0501) }, /* Festo CMSP */ 169 { USB_DEVICE(0x1FB9, 0x0100) }, /* Lake Shore Model 121 Current Source */ 170 { USB_DEVICE(0x1FB9, 0x0200) }, /* Lake Shore Model 218A Temperature Monitor */ 171 { USB_DEVICE(0x1FB9, 0x0201) }, /* Lake Shore Model 219 Temperature Monitor */ 172 { USB_DEVICE(0x1FB9, 0x0202) }, /* Lake Shore Model 233 Temperature Transmitter */ 173 { USB_DEVICE(0x1FB9, 0x0203) }, /* Lake Shore Model 235 Temperature Transmitter */ 174 { USB_DEVICE(0x1FB9, 0x0300) }, /* Lake Shore Model 335 Temperature Controller */ 175 { USB_DEVICE(0x1FB9, 0x0301) }, /* Lake Shore Model 336 Temperature Controller */ 176 { USB_DEVICE(0x1FB9, 0x0302) }, /* Lake Shore Model 350 Temperature Controller */ 177 { USB_DEVICE(0x1FB9, 0x0303) }, /* Lake Shore Model 371 AC Bridge */ 178 { USB_DEVICE(0x1FB9, 0x0400) }, /* Lake Shore Model 411 Handheld Gaussmeter */ 179 { USB_DEVICE(0x1FB9, 0x0401) }, /* Lake Shore Model 425 Gaussmeter */ 180 { USB_DEVICE(0x1FB9, 0x0402) }, /* Lake Shore Model 455A Gaussmeter */ 181 { USB_DEVICE(0x1FB9, 0x0403) }, /* Lake Shore Model 475A Gaussmeter */ 182 { USB_DEVICE(0x1FB9, 0x0404) }, /* Lake Shore Model 465 Three Axis Gaussmeter */ 183 { USB_DEVICE(0x1FB9, 0x0600) }, /* Lake Shore Model 625A Superconducting MPS */ 184 { USB_DEVICE(0x1FB9, 0x0601) }, /* Lake Shore Model 642A Magnet Power Supply */ 185 { USB_DEVICE(0x1FB9, 0x0602) }, /* Lake Shore Model 648 Magnet Power Supply */ 186 { USB_DEVICE(0x1FB9, 0x0700) }, /* Lake Shore Model 737 VSM Controller */ 187 { USB_DEVICE(0x1FB9, 0x0701) }, /* Lake Shore Model 776 Hall Matrix */ 188 { USB_DEVICE(0x3195, 0xF190) }, /* Link Instruments MSO-19 */ 189 { USB_DEVICE(0x3195, 0xF280) }, /* Link Instruments MSO-28 */ 190 { USB_DEVICE(0x3195, 0xF281) }, /* Link Instruments MSO-28 */ 191 { USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */ 192 { } /* Terminating Entry */ 193 }; 194 195 MODULE_DEVICE_TABLE(usb, id_table); 196 197 struct cp210x_serial_private { 198 __u8 bInterfaceNumber; 199 }; 200 201 static struct usb_serial_driver cp210x_device = { 202 .driver = { 203 .owner = THIS_MODULE, 204 .name = "cp210x", 205 }, 206 .id_table = id_table, 207 .num_ports = 1, 208 .bulk_in_size = 256, 209 .bulk_out_size = 256, 210 .open = cp210x_open, 211 .close = cp210x_close, 212 .break_ctl = cp210x_break_ctl, 213 .set_termios = cp210x_set_termios, 214 .tiocmget = cp210x_tiocmget, 215 .tiocmset = cp210x_tiocmset, 216 .attach = cp210x_startup, 217 .release = cp210x_release, 218 .dtr_rts = cp210x_dtr_rts 219 }; 220 221 static struct usb_serial_driver * const serial_drivers[] = { 222 &cp210x_device, NULL 223 }; 224 225 /* Config request types */ 226 #define REQTYPE_HOST_TO_INTERFACE 0x41 227 #define REQTYPE_INTERFACE_TO_HOST 0xc1 228 #define REQTYPE_HOST_TO_DEVICE 0x40 229 #define REQTYPE_DEVICE_TO_HOST 0xc0 230 231 /* Config request codes */ 232 #define CP210X_IFC_ENABLE 0x00 233 #define CP210X_SET_BAUDDIV 0x01 234 #define CP210X_GET_BAUDDIV 0x02 235 #define CP210X_SET_LINE_CTL 0x03 236 #define CP210X_GET_LINE_CTL 0x04 237 #define CP210X_SET_BREAK 0x05 238 #define CP210X_IMM_CHAR 0x06 239 #define CP210X_SET_MHS 0x07 240 #define CP210X_GET_MDMSTS 0x08 241 #define CP210X_SET_XON 0x09 242 #define CP210X_SET_XOFF 0x0A 243 #define CP210X_SET_EVENTMASK 0x0B 244 #define CP210X_GET_EVENTMASK 0x0C 245 #define CP210X_SET_CHAR 0x0D 246 #define CP210X_GET_CHARS 0x0E 247 #define CP210X_GET_PROPS 0x0F 248 #define CP210X_GET_COMM_STATUS 0x10 249 #define CP210X_RESET 0x11 250 #define CP210X_PURGE 0x12 251 #define CP210X_SET_FLOW 0x13 252 #define CP210X_GET_FLOW 0x14 253 #define CP210X_EMBED_EVENTS 0x15 254 #define CP210X_GET_EVENTSTATE 0x16 255 #define CP210X_SET_CHARS 0x19 256 #define CP210X_GET_BAUDRATE 0x1D 257 #define CP210X_SET_BAUDRATE 0x1E 258 259 /* CP210X_IFC_ENABLE */ 260 #define UART_ENABLE 0x0001 261 #define UART_DISABLE 0x0000 262 263 /* CP210X_(SET|GET)_BAUDDIV */ 264 #define BAUD_RATE_GEN_FREQ 0x384000 265 266 /* CP210X_(SET|GET)_LINE_CTL */ 267 #define BITS_DATA_MASK 0X0f00 268 #define BITS_DATA_5 0X0500 269 #define BITS_DATA_6 0X0600 270 #define BITS_DATA_7 0X0700 271 #define BITS_DATA_8 0X0800 272 #define BITS_DATA_9 0X0900 273 274 #define BITS_PARITY_MASK 0x00f0 275 #define BITS_PARITY_NONE 0x0000 276 #define BITS_PARITY_ODD 0x0010 277 #define BITS_PARITY_EVEN 0x0020 278 #define BITS_PARITY_MARK 0x0030 279 #define BITS_PARITY_SPACE 0x0040 280 281 #define BITS_STOP_MASK 0x000f 282 #define BITS_STOP_1 0x0000 283 #define BITS_STOP_1_5 0x0001 284 #define BITS_STOP_2 0x0002 285 286 /* CP210X_SET_BREAK */ 287 #define BREAK_ON 0x0001 288 #define BREAK_OFF 0x0000 289 290 /* CP210X_(SET_MHS|GET_MDMSTS) */ 291 #define CONTROL_DTR 0x0001 292 #define CONTROL_RTS 0x0002 293 #define CONTROL_CTS 0x0010 294 #define CONTROL_DSR 0x0020 295 #define CONTROL_RING 0x0040 296 #define CONTROL_DCD 0x0080 297 #define CONTROL_WRITE_DTR 0x0100 298 #define CONTROL_WRITE_RTS 0x0200 299 300 /* 301 * cp210x_get_config 302 * Reads from the CP210x configuration registers 303 * 'size' is specified in bytes. 304 * 'data' is a pointer to a pre-allocated array of integers large 305 * enough to hold 'size' bytes (with 4 bytes to each integer) 306 */ 307 static int cp210x_get_config(struct usb_serial_port *port, u8 request, 308 unsigned int *data, int size) 309 { 310 struct usb_serial *serial = port->serial; 311 struct cp210x_serial_private *spriv = usb_get_serial_data(serial); 312 __le32 *buf; 313 int result, i, length; 314 315 /* Number of integers required to contain the array */ 316 length = (((size - 1) | 3) + 1) / 4; 317 318 buf = kcalloc(length, sizeof(__le32), GFP_KERNEL); 319 if (!buf) 320 return -ENOMEM; 321 322 /* Issue the request, attempting to read 'size' bytes */ 323 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0), 324 request, REQTYPE_INTERFACE_TO_HOST, 0x0000, 325 spriv->bInterfaceNumber, buf, size, 326 USB_CTRL_GET_TIMEOUT); 327 328 /* Convert data into an array of integers */ 329 for (i = 0; i < length; i++) 330 data[i] = le32_to_cpu(buf[i]); 331 332 kfree(buf); 333 334 if (result != size) { 335 dev_dbg(&port->dev, "%s - Unable to send config request, request=0x%x size=%d result=%d\n", 336 __func__, request, size, result); 337 if (result > 0) 338 result = -EPROTO; 339 340 return result; 341 } 342 343 return 0; 344 } 345 346 /* 347 * cp210x_set_config 348 * Writes to the CP210x configuration registers 349 * Values less than 16 bits wide are sent directly 350 * 'size' is specified in bytes. 351 */ 352 static int cp210x_set_config(struct usb_serial_port *port, u8 request, 353 unsigned int *data, int size) 354 { 355 struct usb_serial *serial = port->serial; 356 struct cp210x_serial_private *spriv = usb_get_serial_data(serial); 357 __le32 *buf; 358 int result, i, length; 359 360 /* Number of integers required to contain the array */ 361 length = (((size - 1) | 3) + 1) / 4; 362 363 buf = kmalloc(length * sizeof(__le32), GFP_KERNEL); 364 if (!buf) 365 return -ENOMEM; 366 367 /* Array of integers into bytes */ 368 for (i = 0; i < length; i++) 369 buf[i] = cpu_to_le32(data[i]); 370 371 if (size > 2) { 372 result = usb_control_msg(serial->dev, 373 usb_sndctrlpipe(serial->dev, 0), 374 request, REQTYPE_HOST_TO_INTERFACE, 0x0000, 375 spriv->bInterfaceNumber, buf, size, 376 USB_CTRL_SET_TIMEOUT); 377 } else { 378 result = usb_control_msg(serial->dev, 379 usb_sndctrlpipe(serial->dev, 0), 380 request, REQTYPE_HOST_TO_INTERFACE, data[0], 381 spriv->bInterfaceNumber, NULL, 0, 382 USB_CTRL_SET_TIMEOUT); 383 } 384 385 kfree(buf); 386 387 if ((size > 2 && result != size) || result < 0) { 388 dev_dbg(&port->dev, "%s - Unable to send request, request=0x%x size=%d result=%d\n", 389 __func__, request, size, result); 390 if (result > 0) 391 result = -EPROTO; 392 393 return result; 394 } 395 396 return 0; 397 } 398 399 /* 400 * cp210x_set_config_single 401 * Convenience function for calling cp210x_set_config on single data values 402 * without requiring an integer pointer 403 */ 404 static inline int cp210x_set_config_single(struct usb_serial_port *port, 405 u8 request, unsigned int data) 406 { 407 return cp210x_set_config(port, request, &data, 2); 408 } 409 410 /* 411 * cp210x_quantise_baudrate 412 * Quantises the baud rate as per AN205 Table 1 413 */ 414 static unsigned int cp210x_quantise_baudrate(unsigned int baud) 415 { 416 if (baud <= 300) 417 baud = 300; 418 else if (baud <= 600) baud = 600; 419 else if (baud <= 1200) baud = 1200; 420 else if (baud <= 1800) baud = 1800; 421 else if (baud <= 2400) baud = 2400; 422 else if (baud <= 4000) baud = 4000; 423 else if (baud <= 4803) baud = 4800; 424 else if (baud <= 7207) baud = 7200; 425 else if (baud <= 9612) baud = 9600; 426 else if (baud <= 14428) baud = 14400; 427 else if (baud <= 16062) baud = 16000; 428 else if (baud <= 19250) baud = 19200; 429 else if (baud <= 28912) baud = 28800; 430 else if (baud <= 38601) baud = 38400; 431 else if (baud <= 51558) baud = 51200; 432 else if (baud <= 56280) baud = 56000; 433 else if (baud <= 58053) baud = 57600; 434 else if (baud <= 64111) baud = 64000; 435 else if (baud <= 77608) baud = 76800; 436 else if (baud <= 117028) baud = 115200; 437 else if (baud <= 129347) baud = 128000; 438 else if (baud <= 156868) baud = 153600; 439 else if (baud <= 237832) baud = 230400; 440 else if (baud <= 254234) baud = 250000; 441 else if (baud <= 273066) baud = 256000; 442 else if (baud <= 491520) baud = 460800; 443 else if (baud <= 567138) baud = 500000; 444 else if (baud <= 670254) baud = 576000; 445 else if (baud < 1000000) 446 baud = 921600; 447 else if (baud > 2000000) 448 baud = 2000000; 449 return baud; 450 } 451 452 static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port) 453 { 454 int result; 455 456 result = cp210x_set_config_single(port, CP210X_IFC_ENABLE, 457 UART_ENABLE); 458 if (result) { 459 dev_err(&port->dev, "%s - Unable to enable UART\n", __func__); 460 return result; 461 } 462 463 /* Configure the termios structure */ 464 cp210x_get_termios(tty, port); 465 466 /* The baud rate must be initialised on cp2104 */ 467 if (tty) 468 cp210x_change_speed(tty, port, NULL); 469 470 return usb_serial_generic_open(tty, port); 471 } 472 473 static void cp210x_close(struct usb_serial_port *port) 474 { 475 usb_serial_generic_close(port); 476 cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_DISABLE); 477 } 478 479 /* 480 * cp210x_get_termios 481 * Reads the baud rate, data bits, parity, stop bits and flow control mode 482 * from the device, corrects any unsupported values, and configures the 483 * termios structure to reflect the state of the device 484 */ 485 static void cp210x_get_termios(struct tty_struct *tty, 486 struct usb_serial_port *port) 487 { 488 unsigned int baud; 489 490 if (tty) { 491 cp210x_get_termios_port(tty->driver_data, 492 &tty->termios.c_cflag, &baud); 493 tty_encode_baud_rate(tty, baud, baud); 494 } else { 495 unsigned int cflag; 496 cflag = 0; 497 cp210x_get_termios_port(port, &cflag, &baud); 498 } 499 } 500 501 /* 502 * cp210x_get_termios_port 503 * This is the heart of cp210x_get_termios which always uses a &usb_serial_port. 504 */ 505 static void cp210x_get_termios_port(struct usb_serial_port *port, 506 unsigned int *cflagp, unsigned int *baudp) 507 { 508 struct device *dev = &port->dev; 509 unsigned int cflag, modem_ctl[4]; 510 unsigned int baud; 511 unsigned int bits; 512 513 cp210x_get_config(port, CP210X_GET_BAUDRATE, &baud, 4); 514 515 dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud); 516 *baudp = baud; 517 518 cflag = *cflagp; 519 520 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2); 521 cflag &= ~CSIZE; 522 switch (bits & BITS_DATA_MASK) { 523 case BITS_DATA_5: 524 dev_dbg(dev, "%s - data bits = 5\n", __func__); 525 cflag |= CS5; 526 break; 527 case BITS_DATA_6: 528 dev_dbg(dev, "%s - data bits = 6\n", __func__); 529 cflag |= CS6; 530 break; 531 case BITS_DATA_7: 532 dev_dbg(dev, "%s - data bits = 7\n", __func__); 533 cflag |= CS7; 534 break; 535 case BITS_DATA_8: 536 dev_dbg(dev, "%s - data bits = 8\n", __func__); 537 cflag |= CS8; 538 break; 539 case BITS_DATA_9: 540 dev_dbg(dev, "%s - data bits = 9 (not supported, using 8 data bits)\n", __func__); 541 cflag |= CS8; 542 bits &= ~BITS_DATA_MASK; 543 bits |= BITS_DATA_8; 544 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2); 545 break; 546 default: 547 dev_dbg(dev, "%s - Unknown number of data bits, using 8\n", __func__); 548 cflag |= CS8; 549 bits &= ~BITS_DATA_MASK; 550 bits |= BITS_DATA_8; 551 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2); 552 break; 553 } 554 555 switch (bits & BITS_PARITY_MASK) { 556 case BITS_PARITY_NONE: 557 dev_dbg(dev, "%s - parity = NONE\n", __func__); 558 cflag &= ~PARENB; 559 break; 560 case BITS_PARITY_ODD: 561 dev_dbg(dev, "%s - parity = ODD\n", __func__); 562 cflag |= (PARENB|PARODD); 563 break; 564 case BITS_PARITY_EVEN: 565 dev_dbg(dev, "%s - parity = EVEN\n", __func__); 566 cflag &= ~PARODD; 567 cflag |= PARENB; 568 break; 569 case BITS_PARITY_MARK: 570 dev_dbg(dev, "%s - parity = MARK\n", __func__); 571 cflag |= (PARENB|PARODD|CMSPAR); 572 break; 573 case BITS_PARITY_SPACE: 574 dev_dbg(dev, "%s - parity = SPACE\n", __func__); 575 cflag &= ~PARODD; 576 cflag |= (PARENB|CMSPAR); 577 break; 578 default: 579 dev_dbg(dev, "%s - Unknown parity mode, disabling parity\n", __func__); 580 cflag &= ~PARENB; 581 bits &= ~BITS_PARITY_MASK; 582 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2); 583 break; 584 } 585 586 cflag &= ~CSTOPB; 587 switch (bits & BITS_STOP_MASK) { 588 case BITS_STOP_1: 589 dev_dbg(dev, "%s - stop bits = 1\n", __func__); 590 break; 591 case BITS_STOP_1_5: 592 dev_dbg(dev, "%s - stop bits = 1.5 (not supported, using 1 stop bit)\n", __func__); 593 bits &= ~BITS_STOP_MASK; 594 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2); 595 break; 596 case BITS_STOP_2: 597 dev_dbg(dev, "%s - stop bits = 2\n", __func__); 598 cflag |= CSTOPB; 599 break; 600 default: 601 dev_dbg(dev, "%s - Unknown number of stop bits, using 1 stop bit\n", __func__); 602 bits &= ~BITS_STOP_MASK; 603 cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2); 604 break; 605 } 606 607 cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16); 608 if (modem_ctl[0] & 0x0008) { 609 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__); 610 cflag |= CRTSCTS; 611 } else { 612 dev_dbg(dev, "%s - flow control = NONE\n", __func__); 613 cflag &= ~CRTSCTS; 614 } 615 616 *cflagp = cflag; 617 } 618 619 /* 620 * CP2101 supports the following baud rates: 621 * 622 * 300, 600, 1200, 1800, 2400, 4800, 7200, 9600, 14400, 19200, 28800, 623 * 38400, 56000, 57600, 115200, 128000, 230400, 460800, 921600 624 * 625 * CP2102 and CP2103 support the following additional rates: 626 * 627 * 4000, 16000, 51200, 64000, 76800, 153600, 250000, 256000, 500000, 628 * 576000 629 * 630 * The device will map a requested rate to a supported one, but the result 631 * of requests for rates greater than 1053257 is undefined (see AN205). 632 * 633 * CP2104, CP2105 and CP2110 support most rates up to 2M, 921k and 1M baud, 634 * respectively, with an error less than 1%. The actual rates are determined 635 * by 636 * 637 * div = round(freq / (2 x prescale x request)) 638 * actual = freq / (2 x prescale x div) 639 * 640 * For CP2104 and CP2105 freq is 48Mhz and prescale is 4 for request <= 365bps 641 * or 1 otherwise. 642 * For CP2110 freq is 24Mhz and prescale is 4 for request <= 300bps or 1 643 * otherwise. 644 */ 645 static void cp210x_change_speed(struct tty_struct *tty, 646 struct usb_serial_port *port, struct ktermios *old_termios) 647 { 648 u32 baud; 649 650 baud = tty->termios.c_ospeed; 651 652 /* This maps the requested rate to a rate valid on cp2102 or cp2103, 653 * or to an arbitrary rate in [1M,2M]. 654 * 655 * NOTE: B0 is not implemented. 656 */ 657 baud = cp210x_quantise_baudrate(baud); 658 659 dev_dbg(&port->dev, "%s - setting baud rate to %u\n", __func__, baud); 660 if (cp210x_set_config(port, CP210X_SET_BAUDRATE, &baud, 661 sizeof(baud))) { 662 dev_warn(&port->dev, "failed to set baud rate to %u\n", baud); 663 if (old_termios) 664 baud = old_termios->c_ospeed; 665 else 666 baud = 9600; 667 } 668 669 tty_encode_baud_rate(tty, baud, baud); 670 } 671 672 static void cp210x_set_termios(struct tty_struct *tty, 673 struct usb_serial_port *port, struct ktermios *old_termios) 674 { 675 struct device *dev = &port->dev; 676 unsigned int cflag, old_cflag; 677 unsigned int bits; 678 unsigned int modem_ctl[4]; 679 680 cflag = tty->termios.c_cflag; 681 old_cflag = old_termios->c_cflag; 682 683 if (tty->termios.c_ospeed != old_termios->c_ospeed) 684 cp210x_change_speed(tty, port, old_termios); 685 686 /* If the number of data bits is to be updated */ 687 if ((cflag & CSIZE) != (old_cflag & CSIZE)) { 688 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2); 689 bits &= ~BITS_DATA_MASK; 690 switch (cflag & CSIZE) { 691 case CS5: 692 bits |= BITS_DATA_5; 693 dev_dbg(dev, "%s - data bits = 5\n", __func__); 694 break; 695 case CS6: 696 bits |= BITS_DATA_6; 697 dev_dbg(dev, "%s - data bits = 6\n", __func__); 698 break; 699 case CS7: 700 bits |= BITS_DATA_7; 701 dev_dbg(dev, "%s - data bits = 7\n", __func__); 702 break; 703 case CS8: 704 bits |= BITS_DATA_8; 705 dev_dbg(dev, "%s - data bits = 8\n", __func__); 706 break; 707 /*case CS9: 708 bits |= BITS_DATA_9; 709 dev_dbg(dev, "%s - data bits = 9\n", __func__); 710 break;*/ 711 default: 712 dev_dbg(dev, "cp210x driver does not support the number of bits requested, using 8 bit mode\n"); 713 bits |= BITS_DATA_8; 714 break; 715 } 716 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2)) 717 dev_dbg(dev, "Number of data bits requested not supported by device\n"); 718 } 719 720 if ((cflag & (PARENB|PARODD|CMSPAR)) != 721 (old_cflag & (PARENB|PARODD|CMSPAR))) { 722 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2); 723 bits &= ~BITS_PARITY_MASK; 724 if (cflag & PARENB) { 725 if (cflag & CMSPAR) { 726 if (cflag & PARODD) { 727 bits |= BITS_PARITY_MARK; 728 dev_dbg(dev, "%s - parity = MARK\n", __func__); 729 } else { 730 bits |= BITS_PARITY_SPACE; 731 dev_dbg(dev, "%s - parity = SPACE\n", __func__); 732 } 733 } else { 734 if (cflag & PARODD) { 735 bits |= BITS_PARITY_ODD; 736 dev_dbg(dev, "%s - parity = ODD\n", __func__); 737 } else { 738 bits |= BITS_PARITY_EVEN; 739 dev_dbg(dev, "%s - parity = EVEN\n", __func__); 740 } 741 } 742 } 743 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2)) 744 dev_dbg(dev, "Parity mode not supported by device\n"); 745 } 746 747 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) { 748 cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2); 749 bits &= ~BITS_STOP_MASK; 750 if (cflag & CSTOPB) { 751 bits |= BITS_STOP_2; 752 dev_dbg(dev, "%s - stop bits = 2\n", __func__); 753 } else { 754 bits |= BITS_STOP_1; 755 dev_dbg(dev, "%s - stop bits = 1\n", __func__); 756 } 757 if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2)) 758 dev_dbg(dev, "Number of stop bits requested not supported by device\n"); 759 } 760 761 if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) { 762 cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16); 763 dev_dbg(dev, "%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x\n", 764 __func__, modem_ctl[0], modem_ctl[1], 765 modem_ctl[2], modem_ctl[3]); 766 767 if (cflag & CRTSCTS) { 768 modem_ctl[0] &= ~0x7B; 769 modem_ctl[0] |= 0x09; 770 modem_ctl[1] = 0x80; 771 dev_dbg(dev, "%s - flow control = CRTSCTS\n", __func__); 772 } else { 773 modem_ctl[0] &= ~0x7B; 774 modem_ctl[0] |= 0x01; 775 modem_ctl[1] |= 0x40; 776 dev_dbg(dev, "%s - flow control = NONE\n", __func__); 777 } 778 779 dev_dbg(dev, "%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x\n", 780 __func__, modem_ctl[0], modem_ctl[1], 781 modem_ctl[2], modem_ctl[3]); 782 cp210x_set_config(port, CP210X_SET_FLOW, modem_ctl, 16); 783 } 784 785 } 786 787 static int cp210x_tiocmset(struct tty_struct *tty, 788 unsigned int set, unsigned int clear) 789 { 790 struct usb_serial_port *port = tty->driver_data; 791 return cp210x_tiocmset_port(port, set, clear); 792 } 793 794 static int cp210x_tiocmset_port(struct usb_serial_port *port, 795 unsigned int set, unsigned int clear) 796 { 797 unsigned int control = 0; 798 799 if (set & TIOCM_RTS) { 800 control |= CONTROL_RTS; 801 control |= CONTROL_WRITE_RTS; 802 } 803 if (set & TIOCM_DTR) { 804 control |= CONTROL_DTR; 805 control |= CONTROL_WRITE_DTR; 806 } 807 if (clear & TIOCM_RTS) { 808 control &= ~CONTROL_RTS; 809 control |= CONTROL_WRITE_RTS; 810 } 811 if (clear & TIOCM_DTR) { 812 control &= ~CONTROL_DTR; 813 control |= CONTROL_WRITE_DTR; 814 } 815 816 dev_dbg(&port->dev, "%s - control = 0x%.4x\n", __func__, control); 817 818 return cp210x_set_config(port, CP210X_SET_MHS, &control, 2); 819 } 820 821 static void cp210x_dtr_rts(struct usb_serial_port *p, int on) 822 { 823 if (on) 824 cp210x_tiocmset_port(p, TIOCM_DTR|TIOCM_RTS, 0); 825 else 826 cp210x_tiocmset_port(p, 0, TIOCM_DTR|TIOCM_RTS); 827 } 828 829 static int cp210x_tiocmget(struct tty_struct *tty) 830 { 831 struct usb_serial_port *port = tty->driver_data; 832 unsigned int control; 833 int result; 834 835 cp210x_get_config(port, CP210X_GET_MDMSTS, &control, 1); 836 837 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0) 838 |((control & CONTROL_RTS) ? TIOCM_RTS : 0) 839 |((control & CONTROL_CTS) ? TIOCM_CTS : 0) 840 |((control & CONTROL_DSR) ? TIOCM_DSR : 0) 841 |((control & CONTROL_RING)? TIOCM_RI : 0) 842 |((control & CONTROL_DCD) ? TIOCM_CD : 0); 843 844 dev_dbg(&port->dev, "%s - control = 0x%.2x\n", __func__, control); 845 846 return result; 847 } 848 849 static void cp210x_break_ctl(struct tty_struct *tty, int break_state) 850 { 851 struct usb_serial_port *port = tty->driver_data; 852 unsigned int state; 853 854 if (break_state == 0) 855 state = BREAK_OFF; 856 else 857 state = BREAK_ON; 858 dev_dbg(&port->dev, "%s - turning break %s\n", __func__, 859 state == BREAK_OFF ? "off" : "on"); 860 cp210x_set_config(port, CP210X_SET_BREAK, &state, 2); 861 } 862 863 static int cp210x_startup(struct usb_serial *serial) 864 { 865 struct usb_host_interface *cur_altsetting; 866 struct cp210x_serial_private *spriv; 867 868 spriv = kzalloc(sizeof(*spriv), GFP_KERNEL); 869 if (!spriv) 870 return -ENOMEM; 871 872 cur_altsetting = serial->interface->cur_altsetting; 873 spriv->bInterfaceNumber = cur_altsetting->desc.bInterfaceNumber; 874 875 usb_set_serial_data(serial, spriv); 876 877 return 0; 878 } 879 880 static void cp210x_release(struct usb_serial *serial) 881 { 882 struct cp210x_serial_private *spriv; 883 884 spriv = usb_get_serial_data(serial); 885 kfree(spriv); 886 } 887 888 module_usb_serial_driver(serial_drivers, id_table); 889 890 MODULE_DESCRIPTION(DRIVER_DESC); 891 MODULE_LICENSE("GPL"); 892