2 * spcp8x5 USB to serial adaptor driver
4 * Copyright (C) 2010 Johan Hovold (jhovold@gmail.com)
5 * Copyright (C) 2006 Linxb (xubin.lin@worldplus.com.cn)
6 * Copyright (C) 2006 S1 Corp.
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>
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.
19 #include <linux/kernel.h>
20 #include <linux/errno.h>
21 #include <linux/init.h>
22 #include <linux/slab.h>
23 #include <linux/tty.h>
24 #include <linux/tty_driver.h>
25 #include <linux/tty_flip.h>
26 #include <linux/module.h>
27 #include <linux/spinlock.h>
28 #include <linux/usb.h>
29 #include <linux/usb/serial.h>
32 /* Version Information */
33 #define DRIVER_VERSION "v0.10"
34 #define DRIVER_DESC "SPCP8x5 USB to serial adaptor driver"
38 #define SPCP8x5_007_VID 0x04FC
39 #define SPCP8x5_007_PID 0x0201
40 #define SPCP8x5_008_VID 0x04fc
41 #define SPCP8x5_008_PID 0x0235
42 #define SPCP8x5_PHILIPS_VID 0x0471
43 #define SPCP8x5_PHILIPS_PID 0x081e
44 #define SPCP8x5_INTERMATIC_VID 0x04FC
45 #define SPCP8x5_INTERMATIC_PID 0x0204
46 #define SPCP8x5_835_VID 0x04fc
47 #define SPCP8x5_835_PID 0x0231
49 static const struct usb_device_id id_table[] = {
50 { USB_DEVICE(SPCP8x5_PHILIPS_VID , SPCP8x5_PHILIPS_PID)},
51 { USB_DEVICE(SPCP8x5_INTERMATIC_VID, SPCP8x5_INTERMATIC_PID)},
52 { USB_DEVICE(SPCP8x5_835_VID, SPCP8x5_835_PID)},
53 { USB_DEVICE(SPCP8x5_008_VID, SPCP8x5_008_PID)},
54 { USB_DEVICE(SPCP8x5_007_VID, SPCP8x5_007_PID)},
55 { } /* Terminating entry */
57 MODULE_DEVICE_TABLE(usb, id_table);
59 struct spcp8x5_usb_ctrl_arg {
69 /* spcp8x5 spec register define */
70 #define MCR_CONTROL_LINE_RTS 0x02
71 #define MCR_CONTROL_LINE_DTR 0x01
75 #define MSR_STATUS_LINE_DCD 0x80
76 #define MSR_STATUS_LINE_RI 0x40
77 #define MSR_STATUS_LINE_DSR 0x20
78 #define MSR_STATUS_LINE_CTS 0x10
80 /* verdor command here , we should define myself */
81 #define SET_DEFAULT 0x40
82 #define SET_DEFAULT_TYPE 0x20
84 #define SET_UART_FORMAT 0x40
85 #define SET_UART_FORMAT_TYPE 0x21
86 #define SET_UART_FORMAT_SIZE_5 0x00
87 #define SET_UART_FORMAT_SIZE_6 0x01
88 #define SET_UART_FORMAT_SIZE_7 0x02
89 #define SET_UART_FORMAT_SIZE_8 0x03
90 #define SET_UART_FORMAT_STOP_1 0x00
91 #define SET_UART_FORMAT_STOP_2 0x04
92 #define SET_UART_FORMAT_PAR_NONE 0x00
93 #define SET_UART_FORMAT_PAR_ODD 0x10
94 #define SET_UART_FORMAT_PAR_EVEN 0x30
95 #define SET_UART_FORMAT_PAR_MASK 0xD0
96 #define SET_UART_FORMAT_PAR_SPACE 0x90
98 #define GET_UART_STATUS_TYPE 0xc0
99 #define GET_UART_STATUS 0x22
100 #define GET_UART_STATUS_MSR 0x06
102 #define SET_UART_STATUS 0x40
103 #define SET_UART_STATUS_TYPE 0x23
104 #define SET_UART_STATUS_MCR 0x0004
105 #define SET_UART_STATUS_MCR_DTR 0x01
106 #define SET_UART_STATUS_MCR_RTS 0x02
107 #define SET_UART_STATUS_MCR_LOOP 0x10
109 #define SET_WORKING_MODE 0x40
110 #define SET_WORKING_MODE_TYPE 0x24
111 #define SET_WORKING_MODE_U2C 0x00
112 #define SET_WORKING_MODE_RS485 0x01
113 #define SET_WORKING_MODE_PDMA 0x02
114 #define SET_WORKING_MODE_SPP 0x03
116 #define SET_FLOWCTL_CHAR 0x40
117 #define SET_FLOWCTL_CHAR_TYPE 0x25
119 #define GET_VERSION 0xc0
120 #define GET_VERSION_TYPE 0x26
122 #define SET_REGISTER 0x40
123 #define SET_REGISTER_TYPE 0x27
125 #define GET_REGISTER 0xc0
126 #define GET_REGISTER_TYPE 0x28
129 #define SET_RAM_TYPE 0x31
132 #define GET_RAM_TYPE 0x32
135 #define UART_STATE 0x08
136 #define UART_STATE_TRANSIENT_MASK 0x75
137 #define UART_DCD 0x01
138 #define UART_DSR 0x02
139 #define UART_BREAK_ERROR 0x04
140 #define UART_RING 0x08
141 #define UART_FRAME_ERROR 0x10
142 #define UART_PARITY_ERROR 0x20
143 #define UART_OVERRUN_ERROR 0x40
144 #define UART_CTS 0x80
150 SPCP825_INTERMATIC_TYPE,
154 static struct usb_driver spcp8x5_driver = {
156 .probe = usb_serial_probe,
157 .disconnect = usb_serial_disconnect,
158 .id_table = id_table,
163 struct spcp8x5_private {
165 enum spcp8x5_type type;
170 /* desc : when device plug in,this function would be called.
171 * thanks to usb_serial subsystem,then do almost every things for us. And what
172 * we should do just alloc the buffer */
173 static int spcp8x5_startup(struct usb_serial *serial)
175 struct spcp8x5_private *priv;
177 enum spcp8x5_type type = SPCP825_007_TYPE;
178 u16 product = le16_to_cpu(serial->dev->descriptor.idProduct);
180 if (product == 0x0201)
181 type = SPCP825_007_TYPE;
182 else if (product == 0x0231)
184 else if (product == 0x0235)
185 type = SPCP825_008_TYPE;
186 else if (product == 0x0204)
187 type = SPCP825_INTERMATIC_TYPE;
188 else if (product == 0x0471 &&
189 serial->dev->descriptor.idVendor == cpu_to_le16(0x081e))
190 type = SPCP825_PHILIP_TYPE;
191 dev_dbg(&serial->dev->dev, "device type = %d\n", (int)type);
193 for (i = 0; i < serial->num_ports; ++i) {
194 priv = kzalloc(sizeof(struct spcp8x5_private), GFP_KERNEL);
198 spin_lock_init(&priv->lock);
200 usb_set_serial_port_data(serial->port[i] , priv);
205 for (--i; i >= 0; --i) {
206 priv = usb_get_serial_port_data(serial->port[i]);
208 usb_set_serial_port_data(serial->port[i] , NULL);
213 /* call when the device plug out. free all the memory alloced by probe */
214 static void spcp8x5_release(struct usb_serial *serial)
218 for (i = 0; i < serial->num_ports; i++)
219 kfree(usb_get_serial_port_data(serial->port[i]));
222 /* set the modem control line of the device.
223 * NOTE spcp825-007 not supported this */
224 static int spcp8x5_set_ctrlLine(struct usb_device *dev, u8 value,
225 enum spcp8x5_type type)
230 if (type == SPCP825_007_TYPE)
233 mcr = (unsigned short)value;
234 retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
235 SET_UART_STATUS_TYPE, SET_UART_STATUS,
236 mcr, 0x04, NULL, 0, 100);
238 dev_dbg(&dev->dev, "usb_control_msg return %#x\n", retval);
242 /* get the modem status register of the device
243 * NOTE spcp825-007 not supported this */
244 static int spcp8x5_get_msr(struct usb_device *dev, u8 *status,
245 enum spcp8x5_type type)
250 /* I return Permited not support here but seem inval device
252 if (type == SPCP825_007_TYPE)
257 status_buffer = kmalloc(1, GFP_KERNEL);
260 status_buffer[0] = status[0];
262 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
263 GET_UART_STATUS, GET_UART_STATUS_TYPE,
264 0, GET_UART_STATUS_MSR, status_buffer, 1, 100);
266 dev_dbg(&dev->dev, "Get MSR = 0x%p failed (error = %d)",
269 dev_dbg(&dev->dev, "0xc0:0x22:0:6 %d - 0x%p ", ret, status_buffer);
270 status[0] = status_buffer[0];
271 kfree(status_buffer);
276 /* select the work mode.
277 * NOTE this function not supported by spcp825-007 */
278 static void spcp8x5_set_workMode(struct usb_device *dev, u16 value,
279 u16 index, enum spcp8x5_type type)
283 /* I return Permited not support here but seem inval device
285 if (type == SPCP825_007_TYPE)
288 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
289 SET_WORKING_MODE_TYPE, SET_WORKING_MODE,
290 value, index, NULL, 0, 100);
291 dev_dbg(&dev->dev, "value = %#x , index = %#x\n", value, index);
294 "RTSCTS usb_control_msg(enable flowctrl) = %d\n", ret);
297 static int spcp8x5_carrier_raised(struct usb_serial_port *port)
299 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
300 if (priv->line_status & MSR_STATUS_LINE_DCD)
305 static void spcp8x5_dtr_rts(struct usb_serial_port *port, int on)
307 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
311 spin_lock_irqsave(&priv->lock, flags);
313 priv->line_control = MCR_CONTROL_LINE_DTR
314 | MCR_CONTROL_LINE_RTS;
316 priv->line_control &= ~ (MCR_CONTROL_LINE_DTR
317 | MCR_CONTROL_LINE_RTS);
318 control = priv->line_control;
319 spin_unlock_irqrestore(&priv->lock, flags);
320 spcp8x5_set_ctrlLine(port->serial->dev, control , priv->type);
323 static void spcp8x5_init_termios(struct tty_struct *tty)
325 /* for the 1st time call this function */
326 *(tty->termios) = tty_std_termios;
327 tty->termios->c_cflag = B115200 | CS8 | CREAD | HUPCL | CLOCAL;
328 tty->termios->c_ispeed = 115200;
329 tty->termios->c_ospeed = 115200;
332 /* set the serial param for transfer. we should check if we really need to
333 * transfer. if we set flow control we should do this too. */
334 static void spcp8x5_set_termios(struct tty_struct *tty,
335 struct usb_serial_port *port, struct ktermios *old_termios)
337 struct usb_serial *serial = port->serial;
338 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
340 unsigned int cflag = tty->termios->c_cflag;
341 unsigned short uartdata;
342 unsigned char buf[2] = {0, 0};
348 /* check that they really want us to change something */
349 if (old_termios && !tty_termios_hw_change(tty->termios, old_termios))
352 /* set DTR/RTS active */
353 spin_lock_irqsave(&priv->lock, flags);
354 control = priv->line_control;
355 if (old_termios && (old_termios->c_cflag & CBAUD) == B0) {
356 priv->line_control |= MCR_DTR;
357 if (!(old_termios->c_cflag & CRTSCTS))
358 priv->line_control |= MCR_RTS;
360 if (control != priv->line_control) {
361 control = priv->line_control;
362 spin_unlock_irqrestore(&priv->lock, flags);
363 spcp8x5_set_ctrlLine(serial->dev, control , priv->type);
365 spin_unlock_irqrestore(&priv->lock, flags);
369 baud = tty_get_baud_rate(tty);
371 case 300: buf[0] = 0x00; break;
372 case 600: buf[0] = 0x01; break;
373 case 1200: buf[0] = 0x02; break;
374 case 2400: buf[0] = 0x03; break;
375 case 4800: buf[0] = 0x04; break;
376 case 9600: buf[0] = 0x05; break;
377 case 19200: buf[0] = 0x07; break;
378 case 38400: buf[0] = 0x09; break;
379 case 57600: buf[0] = 0x0a; break;
380 case 115200: buf[0] = 0x0b; break;
381 case 230400: buf[0] = 0x0c; break;
382 case 460800: buf[0] = 0x0d; break;
383 case 921600: buf[0] = 0x0e; break;
384 /* case 1200000: buf[0] = 0x0f; break; */
385 /* case 2400000: buf[0] = 0x10; break; */
386 case 3000000: buf[0] = 0x11; break;
387 /* case 6000000: buf[0] = 0x12; break; */
390 buf[0] = 0x0b; break;
392 dev_err(&port->dev, "spcp825 driver does not support the "
393 "baudrate requested, using default of 9600.\n");
396 /* Set Data Length : 00:5bit, 01:6bit, 10:7bit, 11:8bit */
397 switch (cflag & CSIZE) {
399 buf[1] |= SET_UART_FORMAT_SIZE_5;
402 buf[1] |= SET_UART_FORMAT_SIZE_6;
405 buf[1] |= SET_UART_FORMAT_SIZE_7;
409 buf[1] |= SET_UART_FORMAT_SIZE_8;
413 /* Set Stop bit2 : 0:1bit 1:2bit */
414 buf[1] |= (cflag & CSTOPB) ? SET_UART_FORMAT_STOP_2 :
415 SET_UART_FORMAT_STOP_1;
417 /* Set Parity bit3-4 01:Odd 11:Even */
418 if (cflag & PARENB) {
419 buf[1] |= (cflag & PARODD) ?
420 SET_UART_FORMAT_PAR_ODD : SET_UART_FORMAT_PAR_EVEN ;
422 buf[1] |= SET_UART_FORMAT_PAR_NONE;
424 uartdata = buf[0] | buf[1]<<8;
426 i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
427 SET_UART_FORMAT_TYPE, SET_UART_FORMAT,
428 uartdata, 0, NULL, 0, 100);
430 dev_err(&port->dev, "Set UART format %#x failed (error = %d)\n",
432 dbg("0x21:0x40:0:0 %d", i);
434 if (cflag & CRTSCTS) {
435 /* enable hardware flow control */
436 spcp8x5_set_workMode(serial->dev, 0x000a,
437 SET_WORKING_MODE_U2C, priv->type);
441 /* open the serial port. do some usb system call. set termios and get the line
442 * status of the device. */
443 static int spcp8x5_open(struct tty_struct *tty, struct usb_serial_port *port)
445 struct usb_serial *serial = port->serial;
446 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
450 /* status 0x30 means DSR and CTS = 1 other CDC RI and delta = 0 */
452 dbg("%s - port %d", __func__, port->number);
454 usb_clear_halt(serial->dev, port->write_urb->pipe);
455 usb_clear_halt(serial->dev, port->read_urb->pipe);
457 ret = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
459 0x01, 0x00, NULL, 0x00, 100);
463 spcp8x5_set_ctrlLine(serial->dev, priv->line_control , priv->type);
467 spcp8x5_set_termios(tty, port, NULL);
469 spcp8x5_get_msr(serial->dev, &status, priv->type);
471 /* may be we should update uart status here but now we did not do */
472 spin_lock_irqsave(&priv->lock, flags);
473 priv->line_status = status & 0xf0 ;
474 spin_unlock_irqrestore(&priv->lock, flags);
476 port->port.drain_delay = 256;
478 return usb_serial_generic_open(tty, port);
481 static void spcp8x5_process_read_urb(struct urb *urb)
483 struct usb_serial_port *port = urb->context;
484 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
485 struct tty_struct *tty;
486 unsigned char *data = urb->transfer_buffer;
491 /* get tty_flag from status */
492 tty_flag = TTY_NORMAL;
494 spin_lock_irqsave(&priv->lock, flags);
495 status = priv->line_status;
496 priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
497 spin_unlock_irqrestore(&priv->lock, flags);
498 /* wake up the wait for termios */
499 wake_up_interruptible(&port->delta_msr_wait);
501 if (!urb->actual_length)
504 tty = tty_port_tty_get(&port->port);
508 if (status & UART_STATE_TRANSIENT_MASK) {
509 /* break takes precedence over parity, which takes precedence
510 * over framing errors */
511 if (status & UART_BREAK_ERROR)
512 tty_flag = TTY_BREAK;
513 else if (status & UART_PARITY_ERROR)
514 tty_flag = TTY_PARITY;
515 else if (status & UART_FRAME_ERROR)
516 tty_flag = TTY_FRAME;
517 dev_dbg(&port->dev, "tty_flag = %d\n", tty_flag);
519 /* overrun is special, not associated with a char */
520 if (status & UART_OVERRUN_ERROR)
521 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
523 if (status & UART_DCD)
524 usb_serial_handle_dcd_change(port, tty,
525 priv->line_status & MSR_STATUS_LINE_DCD);
528 tty_insert_flip_string_fixed_flag(tty, data, tty_flag,
530 tty_flip_buffer_push(tty);
534 static int spcp8x5_wait_modem_info(struct usb_serial_port *port,
537 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
539 unsigned int prevstatus;
541 unsigned int changed;
543 spin_lock_irqsave(&priv->lock, flags);
544 prevstatus = priv->line_status;
545 spin_unlock_irqrestore(&priv->lock, flags);
548 /* wake up in bulk read */
549 interruptible_sleep_on(&port->delta_msr_wait);
551 /* see if a signal did it */
552 if (signal_pending(current))
555 if (port->serial->disconnected)
558 spin_lock_irqsave(&priv->lock, flags);
559 status = priv->line_status;
560 spin_unlock_irqrestore(&priv->lock, flags);
562 changed = prevstatus^status;
564 if (((arg & TIOCM_RNG) && (changed & MSR_STATUS_LINE_RI)) ||
565 ((arg & TIOCM_DSR) && (changed & MSR_STATUS_LINE_DSR)) ||
566 ((arg & TIOCM_CD) && (changed & MSR_STATUS_LINE_DCD)) ||
567 ((arg & TIOCM_CTS) && (changed & MSR_STATUS_LINE_CTS)))
576 static int spcp8x5_ioctl(struct tty_struct *tty,
577 unsigned int cmd, unsigned long arg)
579 struct usb_serial_port *port = tty->driver_data;
580 dbg("%s (%d) cmd = 0x%04x", __func__, port->number, cmd);
584 dbg("%s (%d) TIOCMIWAIT", __func__, port->number);
585 return spcp8x5_wait_modem_info(port, arg);
588 dbg("%s not supported = 0x%04x", __func__, cmd);
595 static int spcp8x5_tiocmset(struct tty_struct *tty,
596 unsigned int set, unsigned int clear)
598 struct usb_serial_port *port = tty->driver_data;
599 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
603 spin_lock_irqsave(&priv->lock, flags);
605 priv->line_control |= MCR_RTS;
607 priv->line_control |= MCR_DTR;
608 if (clear & TIOCM_RTS)
609 priv->line_control &= ~MCR_RTS;
610 if (clear & TIOCM_DTR)
611 priv->line_control &= ~MCR_DTR;
612 control = priv->line_control;
613 spin_unlock_irqrestore(&priv->lock, flags);
615 return spcp8x5_set_ctrlLine(port->serial->dev, control , priv->type);
618 static int spcp8x5_tiocmget(struct tty_struct *tty)
620 struct usb_serial_port *port = tty->driver_data;
621 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
627 spin_lock_irqsave(&priv->lock, flags);
628 mcr = priv->line_control;
629 status = priv->line_status;
630 spin_unlock_irqrestore(&priv->lock, flags);
632 result = ((mcr & MCR_DTR) ? TIOCM_DTR : 0)
633 | ((mcr & MCR_RTS) ? TIOCM_RTS : 0)
634 | ((status & MSR_STATUS_LINE_CTS) ? TIOCM_CTS : 0)
635 | ((status & MSR_STATUS_LINE_DSR) ? TIOCM_DSR : 0)
636 | ((status & MSR_STATUS_LINE_RI) ? TIOCM_RI : 0)
637 | ((status & MSR_STATUS_LINE_DCD) ? TIOCM_CD : 0);
642 /* All of the device info needed for the spcp8x5 SIO serial converter */
643 static struct usb_serial_driver spcp8x5_device = {
645 .owner = THIS_MODULE,
648 .id_table = id_table,
649 .usb_driver = &spcp8x5_driver,
651 .open = spcp8x5_open,
652 .dtr_rts = spcp8x5_dtr_rts,
653 .carrier_raised = spcp8x5_carrier_raised,
654 .set_termios = spcp8x5_set_termios,
655 .init_termios = spcp8x5_init_termios,
656 .ioctl = spcp8x5_ioctl,
657 .tiocmget = spcp8x5_tiocmget,
658 .tiocmset = spcp8x5_tiocmset,
659 .attach = spcp8x5_startup,
660 .release = spcp8x5_release,
661 .process_read_urb = spcp8x5_process_read_urb,
664 static int __init spcp8x5_init(void)
667 retval = usb_serial_register(&spcp8x5_device);
669 goto failed_usb_serial_register;
670 retval = usb_register(&spcp8x5_driver);
672 goto failed_usb_register;
673 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
677 usb_serial_deregister(&spcp8x5_device);
678 failed_usb_serial_register:
682 static void __exit spcp8x5_exit(void)
684 usb_deregister(&spcp8x5_driver);
685 usb_serial_deregister(&spcp8x5_device);
688 module_init(spcp8x5_init);
689 module_exit(spcp8x5_exit);
691 MODULE_DESCRIPTION(DRIVER_DESC);
692 MODULE_VERSION(DRIVER_VERSION);
693 MODULE_LICENSE("GPL");
695 module_param(debug, bool, S_IRUGO | S_IWUSR);
696 MODULE_PARM_DESC(debug, "Debug enabled or not");