1 /* 2 * spcp8x5 USB to serial adaptor driver 3 * 4 * Copyright (C) 2010-2013 Johan Hovold (jhovold@gmail.com) 5 * Copyright (C) 2006 Linxb (xubin.lin@worldplus.com.cn) 6 * Copyright (C) 2006 S1 Corp. 7 * 8 * Original driver for 2.6.10 pl2303 driver by 9 * Greg Kroah-Hartman (greg@kroah.com) 10 * Changes for 2.6.20 by Harald Klein <hari@vt100.at> 11 * 12 * This program is free software; you can redistribute it and/or modify 13 * it under the terms of the GNU General Public License as published by 14 * the Free Software Foundation; either version 2 of the License, or 15 * (at your option) any later version. 16 */ 17 #include <linux/kernel.h> 18 #include <linux/errno.h> 19 #include <linux/slab.h> 20 #include <linux/tty.h> 21 #include <linux/tty_driver.h> 22 #include <linux/tty_flip.h> 23 #include <linux/module.h> 24 #include <linux/spinlock.h> 25 #include <linux/usb.h> 26 #include <linux/usb/serial.h> 27 28 #define DRIVER_DESC "SPCP8x5 USB to serial adaptor driver" 29 30 #define SPCP825_QUIRK_NO_UART_STATUS 0x01 31 #define SPCP825_QUIRK_NO_WORK_MODE 0x02 32 33 #define SPCP8x5_007_VID 0x04FC 34 #define SPCP8x5_007_PID 0x0201 35 #define SPCP8x5_008_VID 0x04fc 36 #define SPCP8x5_008_PID 0x0235 37 #define SPCP8x5_PHILIPS_VID 0x0471 38 #define SPCP8x5_PHILIPS_PID 0x081e 39 #define SPCP8x5_INTERMATIC_VID 0x04FC 40 #define SPCP8x5_INTERMATIC_PID 0x0204 41 #define SPCP8x5_835_VID 0x04fc 42 #define SPCP8x5_835_PID 0x0231 43 44 static const struct usb_device_id id_table[] = { 45 { USB_DEVICE(SPCP8x5_PHILIPS_VID , SPCP8x5_PHILIPS_PID)}, 46 { USB_DEVICE(SPCP8x5_INTERMATIC_VID, SPCP8x5_INTERMATIC_PID)}, 47 { USB_DEVICE(SPCP8x5_835_VID, SPCP8x5_835_PID)}, 48 { USB_DEVICE(SPCP8x5_008_VID, SPCP8x5_008_PID)}, 49 { USB_DEVICE(SPCP8x5_007_VID, SPCP8x5_007_PID), 50 .driver_info = SPCP825_QUIRK_NO_UART_STATUS | 51 SPCP825_QUIRK_NO_WORK_MODE }, 52 { } /* Terminating entry */ 53 }; 54 MODULE_DEVICE_TABLE(usb, id_table); 55 56 struct spcp8x5_usb_ctrl_arg { 57 u8 type; 58 u8 cmd; 59 u8 cmd_type; 60 u16 value; 61 u16 index; 62 u16 length; 63 }; 64 65 66 /* spcp8x5 spec register define */ 67 #define MCR_CONTROL_LINE_RTS 0x02 68 #define MCR_CONTROL_LINE_DTR 0x01 69 #define MCR_DTR 0x01 70 #define MCR_RTS 0x02 71 72 #define MSR_STATUS_LINE_DCD 0x80 73 #define MSR_STATUS_LINE_RI 0x40 74 #define MSR_STATUS_LINE_DSR 0x20 75 #define MSR_STATUS_LINE_CTS 0x10 76 77 /* verdor command here , we should define myself */ 78 #define SET_DEFAULT 0x40 79 #define SET_DEFAULT_TYPE 0x20 80 81 #define SET_UART_FORMAT 0x40 82 #define SET_UART_FORMAT_TYPE 0x21 83 #define SET_UART_FORMAT_SIZE_5 0x00 84 #define SET_UART_FORMAT_SIZE_6 0x01 85 #define SET_UART_FORMAT_SIZE_7 0x02 86 #define SET_UART_FORMAT_SIZE_8 0x03 87 #define SET_UART_FORMAT_STOP_1 0x00 88 #define SET_UART_FORMAT_STOP_2 0x04 89 #define SET_UART_FORMAT_PAR_NONE 0x00 90 #define SET_UART_FORMAT_PAR_ODD 0x10 91 #define SET_UART_FORMAT_PAR_EVEN 0x30 92 #define SET_UART_FORMAT_PAR_MASK 0xD0 93 #define SET_UART_FORMAT_PAR_SPACE 0x90 94 95 #define GET_UART_STATUS_TYPE 0xc0 96 #define GET_UART_STATUS 0x22 97 #define GET_UART_STATUS_MSR 0x06 98 99 #define SET_UART_STATUS 0x40 100 #define SET_UART_STATUS_TYPE 0x23 101 #define SET_UART_STATUS_MCR 0x0004 102 #define SET_UART_STATUS_MCR_DTR 0x01 103 #define SET_UART_STATUS_MCR_RTS 0x02 104 #define SET_UART_STATUS_MCR_LOOP 0x10 105 106 #define SET_WORKING_MODE 0x40 107 #define SET_WORKING_MODE_TYPE 0x24 108 #define SET_WORKING_MODE_U2C 0x00 109 #define SET_WORKING_MODE_RS485 0x01 110 #define SET_WORKING_MODE_PDMA 0x02 111 #define SET_WORKING_MODE_SPP 0x03 112 113 #define SET_FLOWCTL_CHAR 0x40 114 #define SET_FLOWCTL_CHAR_TYPE 0x25 115 116 #define GET_VERSION 0xc0 117 #define GET_VERSION_TYPE 0x26 118 119 #define SET_REGISTER 0x40 120 #define SET_REGISTER_TYPE 0x27 121 122 #define GET_REGISTER 0xc0 123 #define GET_REGISTER_TYPE 0x28 124 125 #define SET_RAM 0x40 126 #define SET_RAM_TYPE 0x31 127 128 #define GET_RAM 0xc0 129 #define GET_RAM_TYPE 0x32 130 131 /* how come ??? */ 132 #define UART_STATE 0x08 133 #define UART_STATE_TRANSIENT_MASK 0x75 134 #define UART_DCD 0x01 135 #define UART_DSR 0x02 136 #define UART_BREAK_ERROR 0x04 137 #define UART_RING 0x08 138 #define UART_FRAME_ERROR 0x10 139 #define UART_PARITY_ERROR 0x20 140 #define UART_OVERRUN_ERROR 0x40 141 #define UART_CTS 0x80 142 143 struct spcp8x5_private { 144 unsigned quirks; 145 spinlock_t lock; 146 u8 line_control; 147 }; 148 149 static int spcp8x5_probe(struct usb_serial *serial, 150 const struct usb_device_id *id) 151 { 152 usb_set_serial_data(serial, (void *)id); 153 154 return 0; 155 } 156 157 static int spcp8x5_port_probe(struct usb_serial_port *port) 158 { 159 const struct usb_device_id *id = usb_get_serial_data(port->serial); 160 struct spcp8x5_private *priv; 161 162 priv = kzalloc(sizeof(*priv), GFP_KERNEL); 163 if (!priv) 164 return -ENOMEM; 165 166 spin_lock_init(&priv->lock); 167 priv->quirks = id->driver_info; 168 169 usb_set_serial_port_data(port, priv); 170 171 port->port.drain_delay = 256; 172 173 return 0; 174 } 175 176 static int spcp8x5_port_remove(struct usb_serial_port *port) 177 { 178 struct spcp8x5_private *priv; 179 180 priv = usb_get_serial_port_data(port); 181 kfree(priv); 182 183 return 0; 184 } 185 186 static int spcp8x5_set_ctrl_line(struct usb_serial_port *port, u8 mcr) 187 { 188 struct spcp8x5_private *priv = usb_get_serial_port_data(port); 189 struct usb_device *dev = port->serial->dev; 190 int retval; 191 192 if (priv->quirks & SPCP825_QUIRK_NO_UART_STATUS) 193 return -EPERM; 194 195 retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 196 SET_UART_STATUS_TYPE, SET_UART_STATUS, 197 mcr, 0x04, NULL, 0, 100); 198 if (retval != 0) { 199 dev_err(&port->dev, "failed to set control lines: %d\n", 200 retval); 201 } 202 return retval; 203 } 204 205 static int spcp8x5_get_msr(struct usb_serial_port *port, u8 *status) 206 { 207 struct spcp8x5_private *priv = usb_get_serial_port_data(port); 208 struct usb_device *dev = port->serial->dev; 209 u8 *buf; 210 int ret; 211 212 if (priv->quirks & SPCP825_QUIRK_NO_UART_STATUS) 213 return -EPERM; 214 215 buf = kzalloc(1, GFP_KERNEL); 216 if (!buf) 217 return -ENOMEM; 218 219 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), 220 GET_UART_STATUS, GET_UART_STATUS_TYPE, 221 0, GET_UART_STATUS_MSR, buf, 1, 100); 222 if (ret < 0) 223 dev_err(&port->dev, "failed to get modem status: %d\n", ret); 224 225 dev_dbg(&port->dev, "0xc0:0x22:0:6 %d - 0x02%x\n", ret, *buf); 226 *status = *buf; 227 kfree(buf); 228 229 return ret; 230 } 231 232 static void spcp8x5_set_work_mode(struct usb_serial_port *port, u16 value, 233 u16 index) 234 { 235 struct spcp8x5_private *priv = usb_get_serial_port_data(port); 236 struct usb_device *dev = port->serial->dev; 237 int ret; 238 239 if (priv->quirks & SPCP825_QUIRK_NO_WORK_MODE) 240 return; 241 242 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 243 SET_WORKING_MODE_TYPE, SET_WORKING_MODE, 244 value, index, NULL, 0, 100); 245 dev_dbg(&port->dev, "value = %#x , index = %#x\n", value, index); 246 if (ret < 0) 247 dev_err(&port->dev, "failed to set work mode: %d\n", ret); 248 } 249 250 static int spcp8x5_carrier_raised(struct usb_serial_port *port) 251 { 252 u8 msr; 253 int ret; 254 255 ret = spcp8x5_get_msr(port, &msr); 256 if (ret || msr & MSR_STATUS_LINE_DCD) 257 return 1; 258 259 return 0; 260 } 261 262 static void spcp8x5_dtr_rts(struct usb_serial_port *port, int on) 263 { 264 struct spcp8x5_private *priv = usb_get_serial_port_data(port); 265 unsigned long flags; 266 u8 control; 267 268 spin_lock_irqsave(&priv->lock, flags); 269 if (on) 270 priv->line_control = MCR_CONTROL_LINE_DTR 271 | MCR_CONTROL_LINE_RTS; 272 else 273 priv->line_control &= ~ (MCR_CONTROL_LINE_DTR 274 | MCR_CONTROL_LINE_RTS); 275 control = priv->line_control; 276 spin_unlock_irqrestore(&priv->lock, flags); 277 spcp8x5_set_ctrl_line(port, control); 278 } 279 280 static void spcp8x5_init_termios(struct tty_struct *tty) 281 { 282 tty->termios = tty_std_termios; 283 tty->termios.c_cflag = B115200 | CS8 | CREAD | HUPCL | CLOCAL; 284 tty->termios.c_ispeed = 115200; 285 tty->termios.c_ospeed = 115200; 286 } 287 288 static void spcp8x5_set_termios(struct tty_struct *tty, 289 struct usb_serial_port *port, struct ktermios *old_termios) 290 { 291 struct usb_serial *serial = port->serial; 292 struct spcp8x5_private *priv = usb_get_serial_port_data(port); 293 unsigned long flags; 294 unsigned int cflag = tty->termios.c_cflag; 295 unsigned short uartdata; 296 unsigned char buf[2] = {0, 0}; 297 int baud; 298 int i; 299 u8 control; 300 301 /* check that they really want us to change something */ 302 if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios)) 303 return; 304 305 /* set DTR/RTS active */ 306 spin_lock_irqsave(&priv->lock, flags); 307 control = priv->line_control; 308 if (old_termios && (old_termios->c_cflag & CBAUD) == B0) { 309 priv->line_control |= MCR_DTR; 310 if (!(old_termios->c_cflag & CRTSCTS)) 311 priv->line_control |= MCR_RTS; 312 } 313 if (control != priv->line_control) { 314 control = priv->line_control; 315 spin_unlock_irqrestore(&priv->lock, flags); 316 spcp8x5_set_ctrl_line(port, control); 317 } else { 318 spin_unlock_irqrestore(&priv->lock, flags); 319 } 320 321 /* Set Baud Rate */ 322 baud = tty_get_baud_rate(tty); 323 switch (baud) { 324 case 300: buf[0] = 0x00; break; 325 case 600: buf[0] = 0x01; break; 326 case 1200: buf[0] = 0x02; break; 327 case 2400: buf[0] = 0x03; break; 328 case 4800: buf[0] = 0x04; break; 329 case 9600: buf[0] = 0x05; break; 330 case 19200: buf[0] = 0x07; break; 331 case 38400: buf[0] = 0x09; break; 332 case 57600: buf[0] = 0x0a; break; 333 case 115200: buf[0] = 0x0b; break; 334 case 230400: buf[0] = 0x0c; break; 335 case 460800: buf[0] = 0x0d; break; 336 case 921600: buf[0] = 0x0e; break; 337 /* case 1200000: buf[0] = 0x0f; break; */ 338 /* case 2400000: buf[0] = 0x10; break; */ 339 case 3000000: buf[0] = 0x11; break; 340 /* case 6000000: buf[0] = 0x12; break; */ 341 case 0: 342 case 1000000: 343 buf[0] = 0x0b; break; 344 default: 345 dev_err(&port->dev, "unsupported baudrate, using 9600\n"); 346 } 347 348 /* Set Data Length : 00:5bit, 01:6bit, 10:7bit, 11:8bit */ 349 switch (cflag & CSIZE) { 350 case CS5: 351 buf[1] |= SET_UART_FORMAT_SIZE_5; 352 break; 353 case CS6: 354 buf[1] |= SET_UART_FORMAT_SIZE_6; 355 break; 356 case CS7: 357 buf[1] |= SET_UART_FORMAT_SIZE_7; 358 break; 359 default: 360 case CS8: 361 buf[1] |= SET_UART_FORMAT_SIZE_8; 362 break; 363 } 364 365 /* Set Stop bit2 : 0:1bit 1:2bit */ 366 buf[1] |= (cflag & CSTOPB) ? SET_UART_FORMAT_STOP_2 : 367 SET_UART_FORMAT_STOP_1; 368 369 /* Set Parity bit3-4 01:Odd 11:Even */ 370 if (cflag & PARENB) { 371 buf[1] |= (cflag & PARODD) ? 372 SET_UART_FORMAT_PAR_ODD : SET_UART_FORMAT_PAR_EVEN ; 373 } else { 374 buf[1] |= SET_UART_FORMAT_PAR_NONE; 375 } 376 uartdata = buf[0] | buf[1]<<8; 377 378 i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0), 379 SET_UART_FORMAT_TYPE, SET_UART_FORMAT, 380 uartdata, 0, NULL, 0, 100); 381 if (i < 0) 382 dev_err(&port->dev, "Set UART format %#x failed (error = %d)\n", 383 uartdata, i); 384 dev_dbg(&port->dev, "0x21:0x40:0:0 %d\n", i); 385 386 if (cflag & CRTSCTS) { 387 /* enable hardware flow control */ 388 spcp8x5_set_work_mode(port, 0x000a, SET_WORKING_MODE_U2C); 389 } 390 } 391 392 static int spcp8x5_open(struct tty_struct *tty, struct usb_serial_port *port) 393 { 394 struct usb_serial *serial = port->serial; 395 struct spcp8x5_private *priv = usb_get_serial_port_data(port); 396 int ret; 397 398 usb_clear_halt(serial->dev, port->write_urb->pipe); 399 usb_clear_halt(serial->dev, port->read_urb->pipe); 400 401 ret = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0), 402 0x09, 0x00, 403 0x01, 0x00, NULL, 0x00, 100); 404 if (ret) 405 return ret; 406 407 spcp8x5_set_ctrl_line(port, priv->line_control); 408 409 if (tty) 410 spcp8x5_set_termios(tty, port, NULL); 411 412 return usb_serial_generic_open(tty, port); 413 } 414 415 static int spcp8x5_tiocmset(struct tty_struct *tty, 416 unsigned int set, unsigned int clear) 417 { 418 struct usb_serial_port *port = tty->driver_data; 419 struct spcp8x5_private *priv = usb_get_serial_port_data(port); 420 unsigned long flags; 421 u8 control; 422 423 spin_lock_irqsave(&priv->lock, flags); 424 if (set & TIOCM_RTS) 425 priv->line_control |= MCR_RTS; 426 if (set & TIOCM_DTR) 427 priv->line_control |= MCR_DTR; 428 if (clear & TIOCM_RTS) 429 priv->line_control &= ~MCR_RTS; 430 if (clear & TIOCM_DTR) 431 priv->line_control &= ~MCR_DTR; 432 control = priv->line_control; 433 spin_unlock_irqrestore(&priv->lock, flags); 434 435 return spcp8x5_set_ctrl_line(port, control); 436 } 437 438 static int spcp8x5_tiocmget(struct tty_struct *tty) 439 { 440 struct usb_serial_port *port = tty->driver_data; 441 struct spcp8x5_private *priv = usb_get_serial_port_data(port); 442 unsigned long flags; 443 unsigned int mcr; 444 u8 status; 445 unsigned int result; 446 447 result = spcp8x5_get_msr(port, &status); 448 if (result) 449 return result; 450 451 spin_lock_irqsave(&priv->lock, flags); 452 mcr = priv->line_control; 453 spin_unlock_irqrestore(&priv->lock, flags); 454 455 result = ((mcr & MCR_DTR) ? TIOCM_DTR : 0) 456 | ((mcr & MCR_RTS) ? TIOCM_RTS : 0) 457 | ((status & MSR_STATUS_LINE_CTS) ? TIOCM_CTS : 0) 458 | ((status & MSR_STATUS_LINE_DSR) ? TIOCM_DSR : 0) 459 | ((status & MSR_STATUS_LINE_RI) ? TIOCM_RI : 0) 460 | ((status & MSR_STATUS_LINE_DCD) ? TIOCM_CD : 0); 461 462 return result; 463 } 464 465 static struct usb_serial_driver spcp8x5_device = { 466 .driver = { 467 .owner = THIS_MODULE, 468 .name = "SPCP8x5", 469 }, 470 .id_table = id_table, 471 .num_ports = 1, 472 .open = spcp8x5_open, 473 .dtr_rts = spcp8x5_dtr_rts, 474 .carrier_raised = spcp8x5_carrier_raised, 475 .set_termios = spcp8x5_set_termios, 476 .init_termios = spcp8x5_init_termios, 477 .tiocmget = spcp8x5_tiocmget, 478 .tiocmset = spcp8x5_tiocmset, 479 .probe = spcp8x5_probe, 480 .port_probe = spcp8x5_port_probe, 481 .port_remove = spcp8x5_port_remove, 482 }; 483 484 static struct usb_serial_driver * const serial_drivers[] = { 485 &spcp8x5_device, NULL 486 }; 487 488 module_usb_serial_driver(serial_drivers, id_table); 489 490 MODULE_DESCRIPTION(DRIVER_DESC); 491 MODULE_LICENSE("GPL"); 492