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 .id_table = id_table,
160 struct spcp8x5_private {
162 enum spcp8x5_type type;
163 wait_queue_head_t delta_msr_wait;
168 /* desc : when device plug in,this function would be called.
169 * thanks to usb_serial subsystem,then do almost every things for us. And what
170 * we should do just alloc the buffer */
171 static int spcp8x5_startup(struct usb_serial *serial)
173 struct spcp8x5_private *priv;
175 enum spcp8x5_type type = SPCP825_007_TYPE;
176 u16 product = le16_to_cpu(serial->dev->descriptor.idProduct);
178 if (product == 0x0201)
179 type = SPCP825_007_TYPE;
180 else if (product == 0x0231)
182 else if (product == 0x0235)
183 type = SPCP825_008_TYPE;
184 else if (product == 0x0204)
185 type = SPCP825_INTERMATIC_TYPE;
186 else if (product == 0x0471 &&
187 serial->dev->descriptor.idVendor == cpu_to_le16(0x081e))
188 type = SPCP825_PHILIP_TYPE;
189 dev_dbg(&serial->dev->dev, "device type = %d\n", (int)type);
191 for (i = 0; i < serial->num_ports; ++i) {
192 priv = kzalloc(sizeof(struct spcp8x5_private), GFP_KERNEL);
196 spin_lock_init(&priv->lock);
197 init_waitqueue_head(&priv->delta_msr_wait);
199 usb_set_serial_port_data(serial->port[i] , priv);
204 for (--i; i >= 0; --i) {
205 priv = usb_get_serial_port_data(serial->port[i]);
207 usb_set_serial_port_data(serial->port[i] , NULL);
212 /* call when the device plug out. free all the memory alloced by probe */
213 static void spcp8x5_release(struct usb_serial *serial)
217 for (i = 0; i < serial->num_ports; i++)
218 kfree(usb_get_serial_port_data(serial->port[i]));
221 /* set the modem control line of the device.
222 * NOTE spcp825-007 not supported this */
223 static int spcp8x5_set_ctrlLine(struct usb_device *dev, u8 value,
224 enum spcp8x5_type type)
229 if (type == SPCP825_007_TYPE)
232 mcr = (unsigned short)value;
233 retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
234 SET_UART_STATUS_TYPE, SET_UART_STATUS,
235 mcr, 0x04, NULL, 0, 100);
237 dev_dbg(&dev->dev, "usb_control_msg return %#x\n", retval);
241 /* get the modem status register of the device
242 * NOTE spcp825-007 not supported this */
243 static int spcp8x5_get_msr(struct usb_device *dev, u8 *status,
244 enum spcp8x5_type type)
249 /* I return Permited not support here but seem inval device
251 if (type == SPCP825_007_TYPE)
256 status_buffer = kmalloc(1, GFP_KERNEL);
259 status_buffer[0] = status[0];
261 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
262 GET_UART_STATUS, GET_UART_STATUS_TYPE,
263 0, GET_UART_STATUS_MSR, status_buffer, 1, 100);
265 dev_dbg(&dev->dev, "Get MSR = 0x%p failed (error = %d)",
268 dev_dbg(&dev->dev, "0xc0:0x22:0:6 %d - 0x%p ", ret, status_buffer);
269 status[0] = status_buffer[0];
270 kfree(status_buffer);
275 /* select the work mode.
276 * NOTE this function not supported by spcp825-007 */
277 static void spcp8x5_set_workMode(struct usb_device *dev, u16 value,
278 u16 index, enum spcp8x5_type type)
282 /* I return Permited not support here but seem inval device
284 if (type == SPCP825_007_TYPE)
287 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
288 SET_WORKING_MODE_TYPE, SET_WORKING_MODE,
289 value, index, NULL, 0, 100);
290 dev_dbg(&dev->dev, "value = %#x , index = %#x\n", value, index);
293 "RTSCTS usb_control_msg(enable flowctrl) = %d\n", ret);
296 static int spcp8x5_carrier_raised(struct usb_serial_port *port)
298 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
299 if (priv->line_status & MSR_STATUS_LINE_DCD)
304 static void spcp8x5_dtr_rts(struct usb_serial_port *port, int on)
306 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
310 spin_lock_irqsave(&priv->lock, flags);
312 priv->line_control = MCR_CONTROL_LINE_DTR
313 | MCR_CONTROL_LINE_RTS;
315 priv->line_control &= ~ (MCR_CONTROL_LINE_DTR
316 | MCR_CONTROL_LINE_RTS);
317 control = priv->line_control;
318 spin_unlock_irqrestore(&priv->lock, flags);
319 spcp8x5_set_ctrlLine(port->serial->dev, control , priv->type);
322 static void spcp8x5_init_termios(struct tty_struct *tty)
324 /* for the 1st time call this function */
325 *(tty->termios) = tty_std_termios;
326 tty->termios->c_cflag = B115200 | CS8 | CREAD | HUPCL | CLOCAL;
327 tty->termios->c_ispeed = 115200;
328 tty->termios->c_ospeed = 115200;
331 /* set the serial param for transfer. we should check if we really need to
332 * transfer. if we set flow control we should do this too. */
333 static void spcp8x5_set_termios(struct tty_struct *tty,
334 struct usb_serial_port *port, struct ktermios *old_termios)
336 struct usb_serial *serial = port->serial;
337 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
339 unsigned int cflag = tty->termios->c_cflag;
340 unsigned int old_cflag = old_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 (!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_cflag & CBAUD) == B0) {
356 priv->line_control |= MCR_DTR;
357 if (!(old_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 */
398 switch (cflag & CSIZE) {
400 buf[1] |= SET_UART_FORMAT_SIZE_5;
403 buf[1] |= SET_UART_FORMAT_SIZE_6;
406 buf[1] |= SET_UART_FORMAT_SIZE_7;
410 buf[1] |= SET_UART_FORMAT_SIZE_8;
415 /* Set Stop bit2 : 0:1bit 1:2bit */
416 buf[1] |= (cflag & CSTOPB) ? SET_UART_FORMAT_STOP_2 :
417 SET_UART_FORMAT_STOP_1;
419 /* Set Parity bit3-4 01:Odd 11:Even */
420 if (cflag & PARENB) {
421 buf[1] |= (cflag & PARODD) ?
422 SET_UART_FORMAT_PAR_ODD : SET_UART_FORMAT_PAR_EVEN ;
424 buf[1] |= SET_UART_FORMAT_PAR_NONE;
426 uartdata = buf[0] | buf[1]<<8;
428 i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
429 SET_UART_FORMAT_TYPE, SET_UART_FORMAT,
430 uartdata, 0, NULL, 0, 100);
432 dev_err(&port->dev, "Set UART format %#x failed (error = %d)\n",
434 dbg("0x21:0x40:0:0 %d", i);
436 if (cflag & CRTSCTS) {
437 /* enable hardware flow control */
438 spcp8x5_set_workMode(serial->dev, 0x000a,
439 SET_WORKING_MODE_U2C, priv->type);
443 /* open the serial port. do some usb system call. set termios and get the line
444 * status of the device. */
445 static int spcp8x5_open(struct tty_struct *tty, struct usb_serial_port *port)
447 struct ktermios tmp_termios;
448 struct usb_serial *serial = port->serial;
449 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
453 /* status 0x30 means DSR and CTS = 1 other CDC RI and delta = 0 */
455 usb_clear_halt(serial->dev, port->write_urb->pipe);
456 usb_clear_halt(serial->dev, port->read_urb->pipe);
458 ret = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
460 0x01, 0x00, NULL, 0x00, 100);
464 spcp8x5_set_ctrlLine(serial->dev, priv->line_control , priv->type);
468 spcp8x5_set_termios(tty, port, &tmp_termios);
470 spcp8x5_get_msr(serial->dev, &status, priv->type);
472 /* may be we should update uart status here but now we did not do */
473 spin_lock_irqsave(&priv->lock, flags);
474 priv->line_status = status & 0xf0 ;
475 spin_unlock_irqrestore(&priv->lock, flags);
477 port->port.drain_delay = 256;
479 return usb_serial_generic_open(tty, port);
482 static void spcp8x5_process_read_urb(struct urb *urb)
484 struct usb_serial_port *port = urb->context;
485 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
486 struct tty_struct *tty;
487 unsigned char *data = urb->transfer_buffer;
492 /* get tty_flag from status */
493 tty_flag = TTY_NORMAL;
495 spin_lock_irqsave(&priv->lock, flags);
496 status = priv->line_status;
497 priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
498 spin_unlock_irqrestore(&priv->lock, flags);
499 /* wake up the wait for termios */
500 wake_up_interruptible(&priv->delta_msr_wait);
502 if (!urb->actual_length)
505 tty = tty_port_tty_get(&port->port);
509 if (status & UART_STATE_TRANSIENT_MASK) {
510 /* break takes precedence over parity, which takes precedence
511 * over framing errors */
512 if (status & UART_BREAK_ERROR)
513 tty_flag = TTY_BREAK;
514 else if (status & UART_PARITY_ERROR)
515 tty_flag = TTY_PARITY;
516 else if (status & UART_FRAME_ERROR)
517 tty_flag = TTY_FRAME;
518 dev_dbg(&port->dev, "tty_flag = %d\n", tty_flag);
520 /* overrun is special, not associated with a char */
521 if (status & UART_OVERRUN_ERROR)
522 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
524 if (status & UART_DCD)
525 usb_serial_handle_dcd_change(port, tty,
526 priv->line_status & MSR_STATUS_LINE_DCD);
529 tty_insert_flip_string_fixed_flag(tty, data, tty_flag,
531 tty_flip_buffer_push(tty);
535 static int spcp8x5_wait_modem_info(struct usb_serial_port *port,
538 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
540 unsigned int prevstatus;
542 unsigned int changed;
544 spin_lock_irqsave(&priv->lock, flags);
545 prevstatus = priv->line_status;
546 spin_unlock_irqrestore(&priv->lock, flags);
549 /* wake up in bulk read */
550 interruptible_sleep_on(&priv->delta_msr_wait);
552 /* see if a signal did it */
553 if (signal_pending(current))
556 spin_lock_irqsave(&priv->lock, flags);
557 status = priv->line_status;
558 spin_unlock_irqrestore(&priv->lock, flags);
560 changed = prevstatus^status;
562 if (((arg & TIOCM_RNG) && (changed & MSR_STATUS_LINE_RI)) ||
563 ((arg & TIOCM_DSR) && (changed & MSR_STATUS_LINE_DSR)) ||
564 ((arg & TIOCM_CD) && (changed & MSR_STATUS_LINE_DCD)) ||
565 ((arg & TIOCM_CTS) && (changed & MSR_STATUS_LINE_CTS)))
574 static int spcp8x5_ioctl(struct tty_struct *tty,
575 unsigned int cmd, unsigned long arg)
577 struct usb_serial_port *port = tty->driver_data;
578 dbg("%s (%d) cmd = 0x%04x", __func__, port->number, cmd);
582 dbg("%s (%d) TIOCMIWAIT", __func__, port->number);
583 return spcp8x5_wait_modem_info(port, arg);
586 dbg("%s not supported = 0x%04x", __func__, cmd);
593 static int spcp8x5_tiocmset(struct tty_struct *tty,
594 unsigned int set, unsigned int clear)
596 struct usb_serial_port *port = tty->driver_data;
597 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
601 spin_lock_irqsave(&priv->lock, flags);
603 priv->line_control |= MCR_RTS;
605 priv->line_control |= MCR_DTR;
606 if (clear & TIOCM_RTS)
607 priv->line_control &= ~MCR_RTS;
608 if (clear & TIOCM_DTR)
609 priv->line_control &= ~MCR_DTR;
610 control = priv->line_control;
611 spin_unlock_irqrestore(&priv->lock, flags);
613 return spcp8x5_set_ctrlLine(port->serial->dev, control , priv->type);
616 static int spcp8x5_tiocmget(struct tty_struct *tty)
618 struct usb_serial_port *port = tty->driver_data;
619 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
625 spin_lock_irqsave(&priv->lock, flags);
626 mcr = priv->line_control;
627 status = priv->line_status;
628 spin_unlock_irqrestore(&priv->lock, flags);
630 result = ((mcr & MCR_DTR) ? TIOCM_DTR : 0)
631 | ((mcr & MCR_RTS) ? TIOCM_RTS : 0)
632 | ((status & MSR_STATUS_LINE_CTS) ? TIOCM_CTS : 0)
633 | ((status & MSR_STATUS_LINE_DSR) ? TIOCM_DSR : 0)
634 | ((status & MSR_STATUS_LINE_RI) ? TIOCM_RI : 0)
635 | ((status & MSR_STATUS_LINE_DCD) ? TIOCM_CD : 0);
640 /* All of the device info needed for the spcp8x5 SIO serial converter */
641 static struct usb_serial_driver spcp8x5_device = {
643 .owner = THIS_MODULE,
646 .id_table = id_table,
648 .open = spcp8x5_open,
649 .dtr_rts = spcp8x5_dtr_rts,
650 .carrier_raised = spcp8x5_carrier_raised,
651 .set_termios = spcp8x5_set_termios,
652 .init_termios = spcp8x5_init_termios,
653 .ioctl = spcp8x5_ioctl,
654 .tiocmget = spcp8x5_tiocmget,
655 .tiocmset = spcp8x5_tiocmset,
656 .attach = spcp8x5_startup,
657 .release = spcp8x5_release,
658 .process_read_urb = spcp8x5_process_read_urb,
661 static struct usb_serial_driver * const serial_drivers[] = {
662 &spcp8x5_device, NULL
665 module_usb_serial_driver(spcp8x5_driver, serial_drivers);
667 MODULE_DESCRIPTION(DRIVER_DESC);
668 MODULE_VERSION(DRIVER_VERSION);
669 MODULE_LICENSE("GPL");
671 module_param(debug, bool, S_IRUGO | S_IWUSR);
672 MODULE_PARM_DESC(debug, "Debug enabled or not");