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>
31 #define DRIVER_DESC "SPCP8x5 USB to serial adaptor driver"
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
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 { } /* Terminating entry */
52 MODULE_DEVICE_TABLE(usb, id_table);
54 struct spcp8x5_usb_ctrl_arg {
64 /* spcp8x5 spec register define */
65 #define MCR_CONTROL_LINE_RTS 0x02
66 #define MCR_CONTROL_LINE_DTR 0x01
70 #define MSR_STATUS_LINE_DCD 0x80
71 #define MSR_STATUS_LINE_RI 0x40
72 #define MSR_STATUS_LINE_DSR 0x20
73 #define MSR_STATUS_LINE_CTS 0x10
75 /* verdor command here , we should define myself */
76 #define SET_DEFAULT 0x40
77 #define SET_DEFAULT_TYPE 0x20
79 #define SET_UART_FORMAT 0x40
80 #define SET_UART_FORMAT_TYPE 0x21
81 #define SET_UART_FORMAT_SIZE_5 0x00
82 #define SET_UART_FORMAT_SIZE_6 0x01
83 #define SET_UART_FORMAT_SIZE_7 0x02
84 #define SET_UART_FORMAT_SIZE_8 0x03
85 #define SET_UART_FORMAT_STOP_1 0x00
86 #define SET_UART_FORMAT_STOP_2 0x04
87 #define SET_UART_FORMAT_PAR_NONE 0x00
88 #define SET_UART_FORMAT_PAR_ODD 0x10
89 #define SET_UART_FORMAT_PAR_EVEN 0x30
90 #define SET_UART_FORMAT_PAR_MASK 0xD0
91 #define SET_UART_FORMAT_PAR_SPACE 0x90
93 #define GET_UART_STATUS_TYPE 0xc0
94 #define GET_UART_STATUS 0x22
95 #define GET_UART_STATUS_MSR 0x06
97 #define SET_UART_STATUS 0x40
98 #define SET_UART_STATUS_TYPE 0x23
99 #define SET_UART_STATUS_MCR 0x0004
100 #define SET_UART_STATUS_MCR_DTR 0x01
101 #define SET_UART_STATUS_MCR_RTS 0x02
102 #define SET_UART_STATUS_MCR_LOOP 0x10
104 #define SET_WORKING_MODE 0x40
105 #define SET_WORKING_MODE_TYPE 0x24
106 #define SET_WORKING_MODE_U2C 0x00
107 #define SET_WORKING_MODE_RS485 0x01
108 #define SET_WORKING_MODE_PDMA 0x02
109 #define SET_WORKING_MODE_SPP 0x03
111 #define SET_FLOWCTL_CHAR 0x40
112 #define SET_FLOWCTL_CHAR_TYPE 0x25
114 #define GET_VERSION 0xc0
115 #define GET_VERSION_TYPE 0x26
117 #define SET_REGISTER 0x40
118 #define SET_REGISTER_TYPE 0x27
120 #define GET_REGISTER 0xc0
121 #define GET_REGISTER_TYPE 0x28
124 #define SET_RAM_TYPE 0x31
127 #define GET_RAM_TYPE 0x32
130 #define UART_STATE 0x08
131 #define UART_STATE_TRANSIENT_MASK 0x75
132 #define UART_DCD 0x01
133 #define UART_DSR 0x02
134 #define UART_BREAK_ERROR 0x04
135 #define UART_RING 0x08
136 #define UART_FRAME_ERROR 0x10
137 #define UART_PARITY_ERROR 0x20
138 #define UART_OVERRUN_ERROR 0x40
139 #define UART_CTS 0x80
145 SPCP825_INTERMATIC_TYPE,
149 struct spcp8x5_private {
151 enum spcp8x5_type type;
152 wait_queue_head_t delta_msr_wait;
157 static int spcp8x5_port_probe(struct usb_serial_port *port)
159 struct usb_serial *serial = port->serial;
160 struct spcp8x5_private *priv;
161 enum spcp8x5_type type = SPCP825_007_TYPE;
162 u16 product = le16_to_cpu(serial->dev->descriptor.idProduct);
164 if (product == 0x0201)
165 type = SPCP825_007_TYPE;
166 else if (product == 0x0231)
168 else if (product == 0x0235)
169 type = SPCP825_008_TYPE;
170 else if (product == 0x0204)
171 type = SPCP825_INTERMATIC_TYPE;
172 else if (product == 0x0471 &&
173 serial->dev->descriptor.idVendor == cpu_to_le16(0x081e))
174 type = SPCP825_PHILIP_TYPE;
175 dev_dbg(&serial->dev->dev, "device type = %d\n", (int)type);
177 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
181 spin_lock_init(&priv->lock);
182 init_waitqueue_head(&priv->delta_msr_wait);
185 usb_set_serial_port_data(port , priv);
190 static int spcp8x5_port_remove(struct usb_serial_port *port)
192 struct spcp8x5_private *priv;
194 priv = usb_get_serial_port_data(port);
200 /* set the modem control line of the device.
201 * NOTE spcp825-007 not supported this */
202 static int spcp8x5_set_ctrlLine(struct usb_device *dev, u8 value,
203 enum spcp8x5_type type)
208 if (type == SPCP825_007_TYPE)
211 mcr = (unsigned short)value;
212 retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
213 SET_UART_STATUS_TYPE, SET_UART_STATUS,
214 mcr, 0x04, NULL, 0, 100);
216 dev_dbg(&dev->dev, "usb_control_msg return %#x\n", retval);
220 /* get the modem status register of the device
221 * NOTE spcp825-007 not supported this */
222 static int spcp8x5_get_msr(struct usb_device *dev, u8 *status,
223 enum spcp8x5_type type)
228 /* I return Permited not support here but seem inval device
230 if (type == SPCP825_007_TYPE)
235 status_buffer = kmalloc(1, GFP_KERNEL);
238 status_buffer[0] = status[0];
240 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
241 GET_UART_STATUS, GET_UART_STATUS_TYPE,
242 0, GET_UART_STATUS_MSR, status_buffer, 1, 100);
244 dev_dbg(&dev->dev, "Get MSR = 0x%p failed (error = %d)",
247 dev_dbg(&dev->dev, "0xc0:0x22:0:6 %d - 0x%p ", ret, status_buffer);
248 status[0] = status_buffer[0];
249 kfree(status_buffer);
254 /* select the work mode.
255 * NOTE this function not supported by spcp825-007 */
256 static void spcp8x5_set_workMode(struct usb_device *dev, u16 value,
257 u16 index, enum spcp8x5_type type)
261 /* I return Permited not support here but seem inval device
263 if (type == SPCP825_007_TYPE)
266 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
267 SET_WORKING_MODE_TYPE, SET_WORKING_MODE,
268 value, index, NULL, 0, 100);
269 dev_dbg(&dev->dev, "value = %#x , index = %#x\n", value, index);
272 "RTSCTS usb_control_msg(enable flowctrl) = %d\n", ret);
275 static int spcp8x5_carrier_raised(struct usb_serial_port *port)
277 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
278 if (priv->line_status & MSR_STATUS_LINE_DCD)
283 static void spcp8x5_dtr_rts(struct usb_serial_port *port, int on)
285 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
289 spin_lock_irqsave(&priv->lock, flags);
291 priv->line_control = MCR_CONTROL_LINE_DTR
292 | MCR_CONTROL_LINE_RTS;
294 priv->line_control &= ~ (MCR_CONTROL_LINE_DTR
295 | MCR_CONTROL_LINE_RTS);
296 control = priv->line_control;
297 spin_unlock_irqrestore(&priv->lock, flags);
298 spcp8x5_set_ctrlLine(port->serial->dev, control , priv->type);
301 static void spcp8x5_init_termios(struct tty_struct *tty)
303 /* for the 1st time call this function */
304 tty->termios = tty_std_termios;
305 tty->termios.c_cflag = B115200 | CS8 | CREAD | HUPCL | CLOCAL;
306 tty->termios.c_ispeed = 115200;
307 tty->termios.c_ospeed = 115200;
310 /* set the serial param for transfer. we should check if we really need to
311 * transfer. if we set flow control we should do this too. */
312 static void spcp8x5_set_termios(struct tty_struct *tty,
313 struct usb_serial_port *port, struct ktermios *old_termios)
315 struct usb_serial *serial = port->serial;
316 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
318 unsigned int cflag = tty->termios.c_cflag;
319 unsigned int old_cflag = old_termios->c_cflag;
320 unsigned short uartdata;
321 unsigned char buf[2] = {0, 0};
327 /* check that they really want us to change something */
328 if (!tty_termios_hw_change(&tty->termios, old_termios))
331 /* set DTR/RTS active */
332 spin_lock_irqsave(&priv->lock, flags);
333 control = priv->line_control;
334 if ((old_cflag & CBAUD) == B0) {
335 priv->line_control |= MCR_DTR;
336 if (!(old_cflag & CRTSCTS))
337 priv->line_control |= MCR_RTS;
339 if (control != priv->line_control) {
340 control = priv->line_control;
341 spin_unlock_irqrestore(&priv->lock, flags);
342 spcp8x5_set_ctrlLine(serial->dev, control , priv->type);
344 spin_unlock_irqrestore(&priv->lock, flags);
348 baud = tty_get_baud_rate(tty);
350 case 300: buf[0] = 0x00; break;
351 case 600: buf[0] = 0x01; break;
352 case 1200: buf[0] = 0x02; break;
353 case 2400: buf[0] = 0x03; break;
354 case 4800: buf[0] = 0x04; break;
355 case 9600: buf[0] = 0x05; break;
356 case 19200: buf[0] = 0x07; break;
357 case 38400: buf[0] = 0x09; break;
358 case 57600: buf[0] = 0x0a; break;
359 case 115200: buf[0] = 0x0b; break;
360 case 230400: buf[0] = 0x0c; break;
361 case 460800: buf[0] = 0x0d; break;
362 case 921600: buf[0] = 0x0e; break;
363 /* case 1200000: buf[0] = 0x0f; break; */
364 /* case 2400000: buf[0] = 0x10; break; */
365 case 3000000: buf[0] = 0x11; break;
366 /* case 6000000: buf[0] = 0x12; break; */
369 buf[0] = 0x0b; break;
371 dev_err(&port->dev, "spcp825 driver does not support the "
372 "baudrate requested, using default of 9600.\n");
375 /* Set Data Length : 00:5bit, 01:6bit, 10:7bit, 11:8bit */
377 switch (cflag & CSIZE) {
379 buf[1] |= SET_UART_FORMAT_SIZE_5;
382 buf[1] |= SET_UART_FORMAT_SIZE_6;
385 buf[1] |= SET_UART_FORMAT_SIZE_7;
389 buf[1] |= SET_UART_FORMAT_SIZE_8;
394 /* Set Stop bit2 : 0:1bit 1:2bit */
395 buf[1] |= (cflag & CSTOPB) ? SET_UART_FORMAT_STOP_2 :
396 SET_UART_FORMAT_STOP_1;
398 /* Set Parity bit3-4 01:Odd 11:Even */
399 if (cflag & PARENB) {
400 buf[1] |= (cflag & PARODD) ?
401 SET_UART_FORMAT_PAR_ODD : SET_UART_FORMAT_PAR_EVEN ;
403 buf[1] |= SET_UART_FORMAT_PAR_NONE;
405 uartdata = buf[0] | buf[1]<<8;
407 i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
408 SET_UART_FORMAT_TYPE, SET_UART_FORMAT,
409 uartdata, 0, NULL, 0, 100);
411 dev_err(&port->dev, "Set UART format %#x failed (error = %d)\n",
413 dev_dbg(&port->dev, "0x21:0x40:0:0 %d\n", i);
415 if (cflag & CRTSCTS) {
416 /* enable hardware flow control */
417 spcp8x5_set_workMode(serial->dev, 0x000a,
418 SET_WORKING_MODE_U2C, priv->type);
422 /* open the serial port. do some usb system call. set termios and get the line
423 * status of the device. */
424 static int spcp8x5_open(struct tty_struct *tty, struct usb_serial_port *port)
426 struct ktermios tmp_termios;
427 struct usb_serial *serial = port->serial;
428 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
432 /* status 0x30 means DSR and CTS = 1 other CDC RI and delta = 0 */
434 usb_clear_halt(serial->dev, port->write_urb->pipe);
435 usb_clear_halt(serial->dev, port->read_urb->pipe);
437 ret = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
439 0x01, 0x00, NULL, 0x00, 100);
443 spcp8x5_set_ctrlLine(serial->dev, priv->line_control , priv->type);
447 spcp8x5_set_termios(tty, port, &tmp_termios);
449 spcp8x5_get_msr(serial->dev, &status, priv->type);
451 /* may be we should update uart status here but now we did not do */
452 spin_lock_irqsave(&priv->lock, flags);
453 priv->line_status = status & 0xf0 ;
454 spin_unlock_irqrestore(&priv->lock, flags);
456 port->port.drain_delay = 256;
458 return usb_serial_generic_open(tty, port);
461 static void spcp8x5_process_read_urb(struct urb *urb)
463 struct usb_serial_port *port = urb->context;
464 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
465 struct tty_struct *tty;
466 unsigned char *data = urb->transfer_buffer;
471 /* get tty_flag from status */
472 tty_flag = TTY_NORMAL;
474 spin_lock_irqsave(&priv->lock, flags);
475 status = priv->line_status;
476 priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
477 spin_unlock_irqrestore(&priv->lock, flags);
478 /* wake up the wait for termios */
479 wake_up_interruptible(&priv->delta_msr_wait);
481 if (!urb->actual_length)
484 tty = tty_port_tty_get(&port->port);
488 if (status & UART_STATE_TRANSIENT_MASK) {
489 /* break takes precedence over parity, which takes precedence
490 * over framing errors */
491 if (status & UART_BREAK_ERROR)
492 tty_flag = TTY_BREAK;
493 else if (status & UART_PARITY_ERROR)
494 tty_flag = TTY_PARITY;
495 else if (status & UART_FRAME_ERROR)
496 tty_flag = TTY_FRAME;
497 dev_dbg(&port->dev, "tty_flag = %d\n", tty_flag);
499 /* overrun is special, not associated with a char */
500 if (status & UART_OVERRUN_ERROR)
501 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
503 if (status & UART_DCD)
504 usb_serial_handle_dcd_change(port, tty,
505 priv->line_status & MSR_STATUS_LINE_DCD);
508 tty_insert_flip_string_fixed_flag(tty, data, tty_flag,
510 tty_flip_buffer_push(tty);
514 static int spcp8x5_wait_modem_info(struct usb_serial_port *port,
517 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
519 unsigned int prevstatus;
521 unsigned int changed;
523 spin_lock_irqsave(&priv->lock, flags);
524 prevstatus = priv->line_status;
525 spin_unlock_irqrestore(&priv->lock, flags);
528 /* wake up in bulk read */
529 interruptible_sleep_on(&priv->delta_msr_wait);
531 /* see if a signal did it */
532 if (signal_pending(current))
535 spin_lock_irqsave(&priv->lock, flags);
536 status = priv->line_status;
537 spin_unlock_irqrestore(&priv->lock, flags);
539 changed = prevstatus^status;
541 if (((arg & TIOCM_RNG) && (changed & MSR_STATUS_LINE_RI)) ||
542 ((arg & TIOCM_DSR) && (changed & MSR_STATUS_LINE_DSR)) ||
543 ((arg & TIOCM_CD) && (changed & MSR_STATUS_LINE_DCD)) ||
544 ((arg & TIOCM_CTS) && (changed & MSR_STATUS_LINE_CTS)))
553 static int spcp8x5_ioctl(struct tty_struct *tty,
554 unsigned int cmd, unsigned long arg)
556 struct usb_serial_port *port = tty->driver_data;
558 dev_dbg(&port->dev, "%s (%d) cmd = 0x%04x\n", __func__,
563 dev_dbg(&port->dev, "%s (%d) TIOCMIWAIT\n", __func__,
565 return spcp8x5_wait_modem_info(port, arg);
568 dev_dbg(&port->dev, "%s not supported = 0x%04x", __func__,
576 static int spcp8x5_tiocmset(struct tty_struct *tty,
577 unsigned int set, unsigned int clear)
579 struct usb_serial_port *port = tty->driver_data;
580 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
584 spin_lock_irqsave(&priv->lock, flags);
586 priv->line_control |= MCR_RTS;
588 priv->line_control |= MCR_DTR;
589 if (clear & TIOCM_RTS)
590 priv->line_control &= ~MCR_RTS;
591 if (clear & TIOCM_DTR)
592 priv->line_control &= ~MCR_DTR;
593 control = priv->line_control;
594 spin_unlock_irqrestore(&priv->lock, flags);
596 return spcp8x5_set_ctrlLine(port->serial->dev, control , priv->type);
599 static int spcp8x5_tiocmget(struct tty_struct *tty)
601 struct usb_serial_port *port = tty->driver_data;
602 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
608 spin_lock_irqsave(&priv->lock, flags);
609 mcr = priv->line_control;
610 status = priv->line_status;
611 spin_unlock_irqrestore(&priv->lock, flags);
613 result = ((mcr & MCR_DTR) ? TIOCM_DTR : 0)
614 | ((mcr & MCR_RTS) ? TIOCM_RTS : 0)
615 | ((status & MSR_STATUS_LINE_CTS) ? TIOCM_CTS : 0)
616 | ((status & MSR_STATUS_LINE_DSR) ? TIOCM_DSR : 0)
617 | ((status & MSR_STATUS_LINE_RI) ? TIOCM_RI : 0)
618 | ((status & MSR_STATUS_LINE_DCD) ? TIOCM_CD : 0);
623 /* All of the device info needed for the spcp8x5 SIO serial converter */
624 static struct usb_serial_driver spcp8x5_device = {
626 .owner = THIS_MODULE,
629 .id_table = id_table,
631 .open = spcp8x5_open,
632 .dtr_rts = spcp8x5_dtr_rts,
633 .carrier_raised = spcp8x5_carrier_raised,
634 .set_termios = spcp8x5_set_termios,
635 .init_termios = spcp8x5_init_termios,
636 .ioctl = spcp8x5_ioctl,
637 .tiocmget = spcp8x5_tiocmget,
638 .tiocmset = spcp8x5_tiocmset,
639 .port_probe = spcp8x5_port_probe,
640 .port_remove = spcp8x5_port_remove,
641 .process_read_urb = spcp8x5_process_read_urb,
644 static struct usb_serial_driver * const serial_drivers[] = {
645 &spcp8x5_device, NULL
648 module_usb_serial_driver(serial_drivers, id_table);
650 MODULE_DESCRIPTION(DRIVER_DESC);
651 MODULE_LICENSE("GPL");