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);
179 unsigned char num_ports = serial->num_ports;
181 if (serial->num_bulk_in < num_ports ||
182 serial->num_bulk_out < num_ports) {
183 dev_err(&serial->interface->dev, "missing endpoints\n");
187 if (product == 0x0201)
188 type = SPCP825_007_TYPE;
189 else if (product == 0x0231)
191 else if (product == 0x0235)
192 type = SPCP825_008_TYPE;
193 else if (product == 0x0204)
194 type = SPCP825_INTERMATIC_TYPE;
195 else if (product == 0x0471 &&
196 serial->dev->descriptor.idVendor == cpu_to_le16(0x081e))
197 type = SPCP825_PHILIP_TYPE;
198 dev_dbg(&serial->dev->dev, "device type = %d\n", (int)type);
200 for (i = 0; i < serial->num_ports; ++i) {
201 priv = kzalloc(sizeof(struct spcp8x5_private), GFP_KERNEL);
205 spin_lock_init(&priv->lock);
207 usb_set_serial_port_data(serial->port[i] , priv);
212 for (--i; i >= 0; --i) {
213 priv = usb_get_serial_port_data(serial->port[i]);
215 usb_set_serial_port_data(serial->port[i] , NULL);
220 /* call when the device plug out. free all the memory alloced by probe */
221 static void spcp8x5_release(struct usb_serial *serial)
225 for (i = 0; i < serial->num_ports; i++)
226 kfree(usb_get_serial_port_data(serial->port[i]));
229 /* set the modem control line of the device.
230 * NOTE spcp825-007 not supported this */
231 static int spcp8x5_set_ctrlLine(struct usb_device *dev, u8 value,
232 enum spcp8x5_type type)
237 if (type == SPCP825_007_TYPE)
240 mcr = (unsigned short)value;
241 retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
242 SET_UART_STATUS_TYPE, SET_UART_STATUS,
243 mcr, 0x04, NULL, 0, 100);
245 dev_dbg(&dev->dev, "usb_control_msg return %#x\n", retval);
249 /* get the modem status register of the device
250 * NOTE spcp825-007 not supported this */
251 static int spcp8x5_get_msr(struct usb_device *dev, u8 *status,
252 enum spcp8x5_type type)
257 /* I return Permited not support here but seem inval device
259 if (type == SPCP825_007_TYPE)
264 status_buffer = kmalloc(1, GFP_KERNEL);
267 status_buffer[0] = status[0];
269 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
270 GET_UART_STATUS, GET_UART_STATUS_TYPE,
271 0, GET_UART_STATUS_MSR, status_buffer, 1, 100);
273 dev_dbg(&dev->dev, "Get MSR = 0x%p failed (error = %d)",
276 dev_dbg(&dev->dev, "0xc0:0x22:0:6 %d - 0x%p ", ret, status_buffer);
277 status[0] = status_buffer[0];
278 kfree(status_buffer);
283 /* select the work mode.
284 * NOTE this function not supported by spcp825-007 */
285 static void spcp8x5_set_workMode(struct usb_device *dev, u16 value,
286 u16 index, enum spcp8x5_type type)
290 /* I return Permited not support here but seem inval device
292 if (type == SPCP825_007_TYPE)
295 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
296 SET_WORKING_MODE_TYPE, SET_WORKING_MODE,
297 value, index, NULL, 0, 100);
298 dev_dbg(&dev->dev, "value = %#x , index = %#x\n", value, index);
301 "RTSCTS usb_control_msg(enable flowctrl) = %d\n", ret);
304 static int spcp8x5_carrier_raised(struct usb_serial_port *port)
306 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
307 if (priv->line_status & MSR_STATUS_LINE_DCD)
312 static void spcp8x5_dtr_rts(struct usb_serial_port *port, int on)
314 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
318 spin_lock_irqsave(&priv->lock, flags);
320 priv->line_control = MCR_CONTROL_LINE_DTR
321 | MCR_CONTROL_LINE_RTS;
323 priv->line_control &= ~ (MCR_CONTROL_LINE_DTR
324 | MCR_CONTROL_LINE_RTS);
325 control = priv->line_control;
326 spin_unlock_irqrestore(&priv->lock, flags);
327 spcp8x5_set_ctrlLine(port->serial->dev, control , priv->type);
330 static void spcp8x5_init_termios(struct tty_struct *tty)
332 /* for the 1st time call this function */
333 *(tty->termios) = tty_std_termios;
334 tty->termios->c_cflag = B115200 | CS8 | CREAD | HUPCL | CLOCAL;
335 tty->termios->c_ispeed = 115200;
336 tty->termios->c_ospeed = 115200;
339 /* set the serial param for transfer. we should check if we really need to
340 * transfer. if we set flow control we should do this too. */
341 static void spcp8x5_set_termios(struct tty_struct *tty,
342 struct usb_serial_port *port, struct ktermios *old_termios)
344 struct usb_serial *serial = port->serial;
345 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
347 unsigned int cflag = tty->termios->c_cflag;
348 unsigned short uartdata;
349 unsigned char buf[2] = {0, 0};
355 /* check that they really want us to change something */
356 if (old_termios && !tty_termios_hw_change(tty->termios, old_termios))
359 /* set DTR/RTS active */
360 spin_lock_irqsave(&priv->lock, flags);
361 control = priv->line_control;
362 if (old_termios && (old_termios->c_cflag & CBAUD) == B0) {
363 priv->line_control |= MCR_DTR;
364 if (!(old_termios->c_cflag & CRTSCTS))
365 priv->line_control |= MCR_RTS;
367 if (control != priv->line_control) {
368 control = priv->line_control;
369 spin_unlock_irqrestore(&priv->lock, flags);
370 spcp8x5_set_ctrlLine(serial->dev, control , priv->type);
372 spin_unlock_irqrestore(&priv->lock, flags);
376 baud = tty_get_baud_rate(tty);
378 case 300: buf[0] = 0x00; break;
379 case 600: buf[0] = 0x01; break;
380 case 1200: buf[0] = 0x02; break;
381 case 2400: buf[0] = 0x03; break;
382 case 4800: buf[0] = 0x04; break;
383 case 9600: buf[0] = 0x05; break;
384 case 19200: buf[0] = 0x07; break;
385 case 38400: buf[0] = 0x09; break;
386 case 57600: buf[0] = 0x0a; break;
387 case 115200: buf[0] = 0x0b; break;
388 case 230400: buf[0] = 0x0c; break;
389 case 460800: buf[0] = 0x0d; break;
390 case 921600: buf[0] = 0x0e; break;
391 /* case 1200000: buf[0] = 0x0f; break; */
392 /* case 2400000: buf[0] = 0x10; break; */
393 case 3000000: buf[0] = 0x11; break;
394 /* case 6000000: buf[0] = 0x12; break; */
397 buf[0] = 0x0b; break;
399 dev_err(&port->dev, "spcp825 driver does not support the "
400 "baudrate requested, using default of 9600.\n");
403 /* Set Data Length : 00:5bit, 01:6bit, 10:7bit, 11:8bit */
404 switch (cflag & CSIZE) {
406 buf[1] |= SET_UART_FORMAT_SIZE_5;
409 buf[1] |= SET_UART_FORMAT_SIZE_6;
412 buf[1] |= SET_UART_FORMAT_SIZE_7;
416 buf[1] |= SET_UART_FORMAT_SIZE_8;
420 /* Set Stop bit2 : 0:1bit 1:2bit */
421 buf[1] |= (cflag & CSTOPB) ? SET_UART_FORMAT_STOP_2 :
422 SET_UART_FORMAT_STOP_1;
424 /* Set Parity bit3-4 01:Odd 11:Even */
425 if (cflag & PARENB) {
426 buf[1] |= (cflag & PARODD) ?
427 SET_UART_FORMAT_PAR_ODD : SET_UART_FORMAT_PAR_EVEN ;
429 buf[1] |= SET_UART_FORMAT_PAR_NONE;
431 uartdata = buf[0] | buf[1]<<8;
433 i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
434 SET_UART_FORMAT_TYPE, SET_UART_FORMAT,
435 uartdata, 0, NULL, 0, 100);
437 dev_err(&port->dev, "Set UART format %#x failed (error = %d)\n",
439 dbg("0x21:0x40:0:0 %d", i);
441 if (cflag & CRTSCTS) {
442 /* enable hardware flow control */
443 spcp8x5_set_workMode(serial->dev, 0x000a,
444 SET_WORKING_MODE_U2C, priv->type);
448 /* open the serial port. do some usb system call. set termios and get the line
449 * status of the device. */
450 static int spcp8x5_open(struct tty_struct *tty, struct usb_serial_port *port)
452 struct usb_serial *serial = port->serial;
453 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
457 /* status 0x30 means DSR and CTS = 1 other CDC RI and delta = 0 */
459 dbg("%s - port %d", __func__, port->number);
461 usb_clear_halt(serial->dev, port->write_urb->pipe);
462 usb_clear_halt(serial->dev, port->read_urb->pipe);
464 ret = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
466 0x01, 0x00, NULL, 0x00, 100);
470 spcp8x5_set_ctrlLine(serial->dev, priv->line_control , priv->type);
474 spcp8x5_set_termios(tty, port, NULL);
476 spcp8x5_get_msr(serial->dev, &status, priv->type);
478 /* may be we should update uart status here but now we did not do */
479 spin_lock_irqsave(&priv->lock, flags);
480 priv->line_status = status & 0xf0 ;
481 spin_unlock_irqrestore(&priv->lock, flags);
483 port->port.drain_delay = 256;
485 return usb_serial_generic_open(tty, port);
488 static void spcp8x5_process_read_urb(struct urb *urb)
490 struct usb_serial_port *port = urb->context;
491 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
492 struct tty_struct *tty;
493 unsigned char *data = urb->transfer_buffer;
498 /* get tty_flag from status */
499 tty_flag = TTY_NORMAL;
501 spin_lock_irqsave(&priv->lock, flags);
502 status = priv->line_status;
503 priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
504 spin_unlock_irqrestore(&priv->lock, flags);
505 /* wake up the wait for termios */
506 wake_up_interruptible(&port->delta_msr_wait);
508 if (!urb->actual_length)
511 tty = tty_port_tty_get(&port->port);
515 if (status & UART_STATE_TRANSIENT_MASK) {
516 /* break takes precedence over parity, which takes precedence
517 * over framing errors */
518 if (status & UART_BREAK_ERROR)
519 tty_flag = TTY_BREAK;
520 else if (status & UART_PARITY_ERROR)
521 tty_flag = TTY_PARITY;
522 else if (status & UART_FRAME_ERROR)
523 tty_flag = TTY_FRAME;
524 dev_dbg(&port->dev, "tty_flag = %d\n", tty_flag);
526 /* overrun is special, not associated with a char */
527 if (status & UART_OVERRUN_ERROR)
528 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
530 if (status & UART_DCD)
531 usb_serial_handle_dcd_change(port, tty,
532 priv->line_status & MSR_STATUS_LINE_DCD);
535 tty_insert_flip_string_fixed_flag(tty, data, tty_flag,
537 tty_flip_buffer_push(tty);
541 static int spcp8x5_wait_modem_info(struct usb_serial_port *port,
544 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
546 unsigned int prevstatus;
548 unsigned int changed;
550 spin_lock_irqsave(&priv->lock, flags);
551 prevstatus = priv->line_status;
552 spin_unlock_irqrestore(&priv->lock, flags);
555 /* wake up in bulk read */
556 interruptible_sleep_on(&port->delta_msr_wait);
558 /* see if a signal did it */
559 if (signal_pending(current))
562 if (port->serial->disconnected)
565 spin_lock_irqsave(&priv->lock, flags);
566 status = priv->line_status;
567 spin_unlock_irqrestore(&priv->lock, flags);
569 changed = prevstatus^status;
571 if (((arg & TIOCM_RNG) && (changed & MSR_STATUS_LINE_RI)) ||
572 ((arg & TIOCM_DSR) && (changed & MSR_STATUS_LINE_DSR)) ||
573 ((arg & TIOCM_CD) && (changed & MSR_STATUS_LINE_DCD)) ||
574 ((arg & TIOCM_CTS) && (changed & MSR_STATUS_LINE_CTS)))
583 static int spcp8x5_ioctl(struct tty_struct *tty,
584 unsigned int cmd, unsigned long arg)
586 struct usb_serial_port *port = tty->driver_data;
587 dbg("%s (%d) cmd = 0x%04x", __func__, port->number, cmd);
591 dbg("%s (%d) TIOCMIWAIT", __func__, port->number);
592 return spcp8x5_wait_modem_info(port, arg);
595 dbg("%s not supported = 0x%04x", __func__, cmd);
602 static int spcp8x5_tiocmset(struct tty_struct *tty,
603 unsigned int set, unsigned int clear)
605 struct usb_serial_port *port = tty->driver_data;
606 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
610 spin_lock_irqsave(&priv->lock, flags);
612 priv->line_control |= MCR_RTS;
614 priv->line_control |= MCR_DTR;
615 if (clear & TIOCM_RTS)
616 priv->line_control &= ~MCR_RTS;
617 if (clear & TIOCM_DTR)
618 priv->line_control &= ~MCR_DTR;
619 control = priv->line_control;
620 spin_unlock_irqrestore(&priv->lock, flags);
622 return spcp8x5_set_ctrlLine(port->serial->dev, control , priv->type);
625 static int spcp8x5_tiocmget(struct tty_struct *tty)
627 struct usb_serial_port *port = tty->driver_data;
628 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
634 spin_lock_irqsave(&priv->lock, flags);
635 mcr = priv->line_control;
636 status = priv->line_status;
637 spin_unlock_irqrestore(&priv->lock, flags);
639 result = ((mcr & MCR_DTR) ? TIOCM_DTR : 0)
640 | ((mcr & MCR_RTS) ? TIOCM_RTS : 0)
641 | ((status & MSR_STATUS_LINE_CTS) ? TIOCM_CTS : 0)
642 | ((status & MSR_STATUS_LINE_DSR) ? TIOCM_DSR : 0)
643 | ((status & MSR_STATUS_LINE_RI) ? TIOCM_RI : 0)
644 | ((status & MSR_STATUS_LINE_DCD) ? TIOCM_CD : 0);
649 /* All of the device info needed for the spcp8x5 SIO serial converter */
650 static struct usb_serial_driver spcp8x5_device = {
652 .owner = THIS_MODULE,
655 .id_table = id_table,
656 .usb_driver = &spcp8x5_driver,
658 .open = spcp8x5_open,
659 .dtr_rts = spcp8x5_dtr_rts,
660 .carrier_raised = spcp8x5_carrier_raised,
661 .set_termios = spcp8x5_set_termios,
662 .init_termios = spcp8x5_init_termios,
663 .ioctl = spcp8x5_ioctl,
664 .tiocmget = spcp8x5_tiocmget,
665 .tiocmset = spcp8x5_tiocmset,
666 .attach = spcp8x5_startup,
667 .release = spcp8x5_release,
668 .process_read_urb = spcp8x5_process_read_urb,
671 static int __init spcp8x5_init(void)
674 retval = usb_serial_register(&spcp8x5_device);
676 goto failed_usb_serial_register;
677 retval = usb_register(&spcp8x5_driver);
679 goto failed_usb_register;
680 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
684 usb_serial_deregister(&spcp8x5_device);
685 failed_usb_serial_register:
689 static void __exit spcp8x5_exit(void)
691 usb_deregister(&spcp8x5_driver);
692 usb_serial_deregister(&spcp8x5_device);
695 module_init(spcp8x5_init);
696 module_exit(spcp8x5_exit);
698 MODULE_DESCRIPTION(DRIVER_DESC);
699 MODULE_VERSION(DRIVER_VERSION);
700 MODULE_LICENSE("GPL");
702 module_param(debug, bool, S_IRUGO | S_IWUSR);
703 MODULE_PARM_DESC(debug, "Debug enabled or not");