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"
36 #define SPCP8x5_007_VID 0x04FC
37 #define SPCP8x5_007_PID 0x0201
38 #define SPCP8x5_008_VID 0x04fc
39 #define SPCP8x5_008_PID 0x0235
40 #define SPCP8x5_PHILIPS_VID 0x0471
41 #define SPCP8x5_PHILIPS_PID 0x081e
42 #define SPCP8x5_INTERMATIC_VID 0x04FC
43 #define SPCP8x5_INTERMATIC_PID 0x0204
44 #define SPCP8x5_835_VID 0x04fc
45 #define SPCP8x5_835_PID 0x0231
47 static const struct usb_device_id id_table
[] = {
48 { USB_DEVICE(SPCP8x5_PHILIPS_VID
, SPCP8x5_PHILIPS_PID
)},
49 { USB_DEVICE(SPCP8x5_INTERMATIC_VID
, SPCP8x5_INTERMATIC_PID
)},
50 { USB_DEVICE(SPCP8x5_835_VID
, SPCP8x5_835_PID
)},
51 { USB_DEVICE(SPCP8x5_008_VID
, SPCP8x5_008_PID
)},
52 { USB_DEVICE(SPCP8x5_007_VID
, SPCP8x5_007_PID
)},
53 { } /* Terminating entry */
55 MODULE_DEVICE_TABLE(usb
, id_table
);
57 struct spcp8x5_usb_ctrl_arg
{
67 /* spcp8x5 spec register define */
68 #define MCR_CONTROL_LINE_RTS 0x02
69 #define MCR_CONTROL_LINE_DTR 0x01
73 #define MSR_STATUS_LINE_DCD 0x80
74 #define MSR_STATUS_LINE_RI 0x40
75 #define MSR_STATUS_LINE_DSR 0x20
76 #define MSR_STATUS_LINE_CTS 0x10
78 /* verdor command here , we should define myself */
79 #define SET_DEFAULT 0x40
80 #define SET_DEFAULT_TYPE 0x20
82 #define SET_UART_FORMAT 0x40
83 #define SET_UART_FORMAT_TYPE 0x21
84 #define SET_UART_FORMAT_SIZE_5 0x00
85 #define SET_UART_FORMAT_SIZE_6 0x01
86 #define SET_UART_FORMAT_SIZE_7 0x02
87 #define SET_UART_FORMAT_SIZE_8 0x03
88 #define SET_UART_FORMAT_STOP_1 0x00
89 #define SET_UART_FORMAT_STOP_2 0x04
90 #define SET_UART_FORMAT_PAR_NONE 0x00
91 #define SET_UART_FORMAT_PAR_ODD 0x10
92 #define SET_UART_FORMAT_PAR_EVEN 0x30
93 #define SET_UART_FORMAT_PAR_MASK 0xD0
94 #define SET_UART_FORMAT_PAR_SPACE 0x90
96 #define GET_UART_STATUS_TYPE 0xc0
97 #define GET_UART_STATUS 0x22
98 #define GET_UART_STATUS_MSR 0x06
100 #define SET_UART_STATUS 0x40
101 #define SET_UART_STATUS_TYPE 0x23
102 #define SET_UART_STATUS_MCR 0x0004
103 #define SET_UART_STATUS_MCR_DTR 0x01
104 #define SET_UART_STATUS_MCR_RTS 0x02
105 #define SET_UART_STATUS_MCR_LOOP 0x10
107 #define SET_WORKING_MODE 0x40
108 #define SET_WORKING_MODE_TYPE 0x24
109 #define SET_WORKING_MODE_U2C 0x00
110 #define SET_WORKING_MODE_RS485 0x01
111 #define SET_WORKING_MODE_PDMA 0x02
112 #define SET_WORKING_MODE_SPP 0x03
114 #define SET_FLOWCTL_CHAR 0x40
115 #define SET_FLOWCTL_CHAR_TYPE 0x25
117 #define GET_VERSION 0xc0
118 #define GET_VERSION_TYPE 0x26
120 #define SET_REGISTER 0x40
121 #define SET_REGISTER_TYPE 0x27
123 #define GET_REGISTER 0xc0
124 #define GET_REGISTER_TYPE 0x28
127 #define SET_RAM_TYPE 0x31
130 #define GET_RAM_TYPE 0x32
133 #define UART_STATE 0x08
134 #define UART_STATE_TRANSIENT_MASK 0x75
135 #define UART_DCD 0x01
136 #define UART_DSR 0x02
137 #define UART_BREAK_ERROR 0x04
138 #define UART_RING 0x08
139 #define UART_FRAME_ERROR 0x10
140 #define UART_PARITY_ERROR 0x20
141 #define UART_OVERRUN_ERROR 0x40
142 #define UART_CTS 0x80
148 SPCP825_INTERMATIC_TYPE
,
152 struct spcp8x5_private
{
154 enum spcp8x5_type type
;
155 wait_queue_head_t delta_msr_wait
;
160 /* desc : when device plug in,this function would be called.
161 * thanks to usb_serial subsystem,then do almost every things for us. And what
162 * we should do just alloc the buffer */
163 static int spcp8x5_startup(struct usb_serial
*serial
)
165 struct spcp8x5_private
*priv
;
167 enum spcp8x5_type type
= SPCP825_007_TYPE
;
168 u16 product
= le16_to_cpu(serial
->dev
->descriptor
.idProduct
);
170 if (product
== 0x0201)
171 type
= SPCP825_007_TYPE
;
172 else if (product
== 0x0231)
174 else if (product
== 0x0235)
175 type
= SPCP825_008_TYPE
;
176 else if (product
== 0x0204)
177 type
= SPCP825_INTERMATIC_TYPE
;
178 else if (product
== 0x0471 &&
179 serial
->dev
->descriptor
.idVendor
== cpu_to_le16(0x081e))
180 type
= SPCP825_PHILIP_TYPE
;
181 dev_dbg(&serial
->dev
->dev
, "device type = %d\n", (int)type
);
183 for (i
= 0; i
< serial
->num_ports
; ++i
) {
184 priv
= kzalloc(sizeof(struct spcp8x5_private
), GFP_KERNEL
);
188 spin_lock_init(&priv
->lock
);
189 init_waitqueue_head(&priv
->delta_msr_wait
);
191 usb_set_serial_port_data(serial
->port
[i
] , priv
);
196 for (--i
; i
>= 0; --i
) {
197 priv
= usb_get_serial_port_data(serial
->port
[i
]);
199 usb_set_serial_port_data(serial
->port
[i
] , NULL
);
204 /* call when the device plug out. free all the memory alloced by probe */
205 static void spcp8x5_release(struct usb_serial
*serial
)
209 for (i
= 0; i
< serial
->num_ports
; i
++)
210 kfree(usb_get_serial_port_data(serial
->port
[i
]));
213 /* set the modem control line of the device.
214 * NOTE spcp825-007 not supported this */
215 static int spcp8x5_set_ctrlLine(struct usb_device
*dev
, u8 value
,
216 enum spcp8x5_type type
)
221 if (type
== SPCP825_007_TYPE
)
224 mcr
= (unsigned short)value
;
225 retval
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
226 SET_UART_STATUS_TYPE
, SET_UART_STATUS
,
227 mcr
, 0x04, NULL
, 0, 100);
229 dev_dbg(&dev
->dev
, "usb_control_msg return %#x\n", retval
);
233 /* get the modem status register of the device
234 * NOTE spcp825-007 not supported this */
235 static int spcp8x5_get_msr(struct usb_device
*dev
, u8
*status
,
236 enum spcp8x5_type type
)
241 /* I return Permited not support here but seem inval device
243 if (type
== SPCP825_007_TYPE
)
248 status_buffer
= kmalloc(1, GFP_KERNEL
);
251 status_buffer
[0] = status
[0];
253 ret
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
254 GET_UART_STATUS
, GET_UART_STATUS_TYPE
,
255 0, GET_UART_STATUS_MSR
, status_buffer
, 1, 100);
257 dev_dbg(&dev
->dev
, "Get MSR = 0x%p failed (error = %d)",
260 dev_dbg(&dev
->dev
, "0xc0:0x22:0:6 %d - 0x%p ", ret
, status_buffer
);
261 status
[0] = status_buffer
[0];
262 kfree(status_buffer
);
267 /* select the work mode.
268 * NOTE this function not supported by spcp825-007 */
269 static void spcp8x5_set_workMode(struct usb_device
*dev
, u16 value
,
270 u16 index
, enum spcp8x5_type type
)
274 /* I return Permited not support here but seem inval device
276 if (type
== SPCP825_007_TYPE
)
279 ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
280 SET_WORKING_MODE_TYPE
, SET_WORKING_MODE
,
281 value
, index
, NULL
, 0, 100);
282 dev_dbg(&dev
->dev
, "value = %#x , index = %#x\n", value
, index
);
285 "RTSCTS usb_control_msg(enable flowctrl) = %d\n", ret
);
288 static int spcp8x5_carrier_raised(struct usb_serial_port
*port
)
290 struct spcp8x5_private
*priv
= usb_get_serial_port_data(port
);
291 if (priv
->line_status
& MSR_STATUS_LINE_DCD
)
296 static void spcp8x5_dtr_rts(struct usb_serial_port
*port
, int on
)
298 struct spcp8x5_private
*priv
= usb_get_serial_port_data(port
);
302 spin_lock_irqsave(&priv
->lock
, flags
);
304 priv
->line_control
= MCR_CONTROL_LINE_DTR
305 | MCR_CONTROL_LINE_RTS
;
307 priv
->line_control
&= ~ (MCR_CONTROL_LINE_DTR
308 | MCR_CONTROL_LINE_RTS
);
309 control
= priv
->line_control
;
310 spin_unlock_irqrestore(&priv
->lock
, flags
);
311 spcp8x5_set_ctrlLine(port
->serial
->dev
, control
, priv
->type
);
314 static void spcp8x5_init_termios(struct tty_struct
*tty
)
316 /* for the 1st time call this function */
317 tty
->termios
= tty_std_termios
;
318 tty
->termios
.c_cflag
= B115200
| CS8
| CREAD
| HUPCL
| CLOCAL
;
319 tty
->termios
.c_ispeed
= 115200;
320 tty
->termios
.c_ospeed
= 115200;
323 /* set the serial param for transfer. we should check if we really need to
324 * transfer. if we set flow control we should do this too. */
325 static void spcp8x5_set_termios(struct tty_struct
*tty
,
326 struct usb_serial_port
*port
, struct ktermios
*old_termios
)
328 struct usb_serial
*serial
= port
->serial
;
329 struct spcp8x5_private
*priv
= usb_get_serial_port_data(port
);
331 unsigned int cflag
= tty
->termios
.c_cflag
;
332 unsigned int old_cflag
= old_termios
->c_cflag
;
333 unsigned short uartdata
;
334 unsigned char buf
[2] = {0, 0};
340 /* check that they really want us to change something */
341 if (!tty_termios_hw_change(&tty
->termios
, old_termios
))
344 /* set DTR/RTS active */
345 spin_lock_irqsave(&priv
->lock
, flags
);
346 control
= priv
->line_control
;
347 if ((old_cflag
& CBAUD
) == B0
) {
348 priv
->line_control
|= MCR_DTR
;
349 if (!(old_cflag
& CRTSCTS
))
350 priv
->line_control
|= MCR_RTS
;
352 if (control
!= priv
->line_control
) {
353 control
= priv
->line_control
;
354 spin_unlock_irqrestore(&priv
->lock
, flags
);
355 spcp8x5_set_ctrlLine(serial
->dev
, control
, priv
->type
);
357 spin_unlock_irqrestore(&priv
->lock
, flags
);
361 baud
= tty_get_baud_rate(tty
);
363 case 300: buf
[0] = 0x00; break;
364 case 600: buf
[0] = 0x01; break;
365 case 1200: buf
[0] = 0x02; break;
366 case 2400: buf
[0] = 0x03; break;
367 case 4800: buf
[0] = 0x04; break;
368 case 9600: buf
[0] = 0x05; break;
369 case 19200: buf
[0] = 0x07; break;
370 case 38400: buf
[0] = 0x09; break;
371 case 57600: buf
[0] = 0x0a; break;
372 case 115200: buf
[0] = 0x0b; break;
373 case 230400: buf
[0] = 0x0c; break;
374 case 460800: buf
[0] = 0x0d; break;
375 case 921600: buf
[0] = 0x0e; break;
376 /* case 1200000: buf[0] = 0x0f; break; */
377 /* case 2400000: buf[0] = 0x10; break; */
378 case 3000000: buf
[0] = 0x11; break;
379 /* case 6000000: buf[0] = 0x12; break; */
382 buf
[0] = 0x0b; break;
384 dev_err(&port
->dev
, "spcp825 driver does not support the "
385 "baudrate requested, using default of 9600.\n");
388 /* Set Data Length : 00:5bit, 01:6bit, 10:7bit, 11:8bit */
390 switch (cflag
& CSIZE
) {
392 buf
[1] |= SET_UART_FORMAT_SIZE_5
;
395 buf
[1] |= SET_UART_FORMAT_SIZE_6
;
398 buf
[1] |= SET_UART_FORMAT_SIZE_7
;
402 buf
[1] |= SET_UART_FORMAT_SIZE_8
;
407 /* Set Stop bit2 : 0:1bit 1:2bit */
408 buf
[1] |= (cflag
& CSTOPB
) ? SET_UART_FORMAT_STOP_2
:
409 SET_UART_FORMAT_STOP_1
;
411 /* Set Parity bit3-4 01:Odd 11:Even */
412 if (cflag
& PARENB
) {
413 buf
[1] |= (cflag
& PARODD
) ?
414 SET_UART_FORMAT_PAR_ODD
: SET_UART_FORMAT_PAR_EVEN
;
416 buf
[1] |= SET_UART_FORMAT_PAR_NONE
;
418 uartdata
= buf
[0] | buf
[1]<<8;
420 i
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
421 SET_UART_FORMAT_TYPE
, SET_UART_FORMAT
,
422 uartdata
, 0, NULL
, 0, 100);
424 dev_err(&port
->dev
, "Set UART format %#x failed (error = %d)\n",
426 dev_dbg(&port
->dev
, "0x21:0x40:0:0 %d\n", i
);
428 if (cflag
& CRTSCTS
) {
429 /* enable hardware flow control */
430 spcp8x5_set_workMode(serial
->dev
, 0x000a,
431 SET_WORKING_MODE_U2C
, priv
->type
);
435 /* open the serial port. do some usb system call. set termios and get the line
436 * status of the device. */
437 static int spcp8x5_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
439 struct ktermios tmp_termios
;
440 struct usb_serial
*serial
= port
->serial
;
441 struct spcp8x5_private
*priv
= usb_get_serial_port_data(port
);
445 /* status 0x30 means DSR and CTS = 1 other CDC RI and delta = 0 */
447 usb_clear_halt(serial
->dev
, port
->write_urb
->pipe
);
448 usb_clear_halt(serial
->dev
, port
->read_urb
->pipe
);
450 ret
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
452 0x01, 0x00, NULL
, 0x00, 100);
456 spcp8x5_set_ctrlLine(serial
->dev
, priv
->line_control
, priv
->type
);
460 spcp8x5_set_termios(tty
, port
, &tmp_termios
);
462 spcp8x5_get_msr(serial
->dev
, &status
, priv
->type
);
464 /* may be we should update uart status here but now we did not do */
465 spin_lock_irqsave(&priv
->lock
, flags
);
466 priv
->line_status
= status
& 0xf0 ;
467 spin_unlock_irqrestore(&priv
->lock
, flags
);
469 port
->port
.drain_delay
= 256;
471 return usb_serial_generic_open(tty
, port
);
474 static void spcp8x5_process_read_urb(struct urb
*urb
)
476 struct usb_serial_port
*port
= urb
->context
;
477 struct spcp8x5_private
*priv
= usb_get_serial_port_data(port
);
478 struct tty_struct
*tty
;
479 unsigned char *data
= urb
->transfer_buffer
;
484 /* get tty_flag from status */
485 tty_flag
= TTY_NORMAL
;
487 spin_lock_irqsave(&priv
->lock
, flags
);
488 status
= priv
->line_status
;
489 priv
->line_status
&= ~UART_STATE_TRANSIENT_MASK
;
490 spin_unlock_irqrestore(&priv
->lock
, flags
);
491 /* wake up the wait for termios */
492 wake_up_interruptible(&priv
->delta_msr_wait
);
494 if (!urb
->actual_length
)
497 tty
= tty_port_tty_get(&port
->port
);
501 if (status
& UART_STATE_TRANSIENT_MASK
) {
502 /* break takes precedence over parity, which takes precedence
503 * over framing errors */
504 if (status
& UART_BREAK_ERROR
)
505 tty_flag
= TTY_BREAK
;
506 else if (status
& UART_PARITY_ERROR
)
507 tty_flag
= TTY_PARITY
;
508 else if (status
& UART_FRAME_ERROR
)
509 tty_flag
= TTY_FRAME
;
510 dev_dbg(&port
->dev
, "tty_flag = %d\n", tty_flag
);
512 /* overrun is special, not associated with a char */
513 if (status
& UART_OVERRUN_ERROR
)
514 tty_insert_flip_char(tty
, 0, TTY_OVERRUN
);
516 if (status
& UART_DCD
)
517 usb_serial_handle_dcd_change(port
, tty
,
518 priv
->line_status
& MSR_STATUS_LINE_DCD
);
521 tty_insert_flip_string_fixed_flag(tty
, data
, tty_flag
,
523 tty_flip_buffer_push(tty
);
527 static int spcp8x5_wait_modem_info(struct usb_serial_port
*port
,
530 struct spcp8x5_private
*priv
= usb_get_serial_port_data(port
);
532 unsigned int prevstatus
;
534 unsigned int changed
;
536 spin_lock_irqsave(&priv
->lock
, flags
);
537 prevstatus
= priv
->line_status
;
538 spin_unlock_irqrestore(&priv
->lock
, flags
);
541 /* wake up in bulk read */
542 interruptible_sleep_on(&priv
->delta_msr_wait
);
544 /* see if a signal did it */
545 if (signal_pending(current
))
548 spin_lock_irqsave(&priv
->lock
, flags
);
549 status
= priv
->line_status
;
550 spin_unlock_irqrestore(&priv
->lock
, flags
);
552 changed
= prevstatus
^status
;
554 if (((arg
& TIOCM_RNG
) && (changed
& MSR_STATUS_LINE_RI
)) ||
555 ((arg
& TIOCM_DSR
) && (changed
& MSR_STATUS_LINE_DSR
)) ||
556 ((arg
& TIOCM_CD
) && (changed
& MSR_STATUS_LINE_DCD
)) ||
557 ((arg
& TIOCM_CTS
) && (changed
& MSR_STATUS_LINE_CTS
)))
566 static int spcp8x5_ioctl(struct tty_struct
*tty
,
567 unsigned int cmd
, unsigned long arg
)
569 struct usb_serial_port
*port
= tty
->driver_data
;
571 dev_dbg(&port
->dev
, "%s (%d) cmd = 0x%04x\n", __func__
,
576 dev_dbg(&port
->dev
, "%s (%d) TIOCMIWAIT\n", __func__
,
578 return spcp8x5_wait_modem_info(port
, arg
);
581 dev_dbg(&port
->dev
, "%s not supported = 0x%04x", __func__
,
589 static int spcp8x5_tiocmset(struct tty_struct
*tty
,
590 unsigned int set
, unsigned int clear
)
592 struct usb_serial_port
*port
= tty
->driver_data
;
593 struct spcp8x5_private
*priv
= usb_get_serial_port_data(port
);
597 spin_lock_irqsave(&priv
->lock
, flags
);
599 priv
->line_control
|= MCR_RTS
;
601 priv
->line_control
|= MCR_DTR
;
602 if (clear
& TIOCM_RTS
)
603 priv
->line_control
&= ~MCR_RTS
;
604 if (clear
& TIOCM_DTR
)
605 priv
->line_control
&= ~MCR_DTR
;
606 control
= priv
->line_control
;
607 spin_unlock_irqrestore(&priv
->lock
, flags
);
609 return spcp8x5_set_ctrlLine(port
->serial
->dev
, control
, priv
->type
);
612 static int spcp8x5_tiocmget(struct tty_struct
*tty
)
614 struct usb_serial_port
*port
= tty
->driver_data
;
615 struct spcp8x5_private
*priv
= usb_get_serial_port_data(port
);
621 spin_lock_irqsave(&priv
->lock
, flags
);
622 mcr
= priv
->line_control
;
623 status
= priv
->line_status
;
624 spin_unlock_irqrestore(&priv
->lock
, flags
);
626 result
= ((mcr
& MCR_DTR
) ? TIOCM_DTR
: 0)
627 | ((mcr
& MCR_RTS
) ? TIOCM_RTS
: 0)
628 | ((status
& MSR_STATUS_LINE_CTS
) ? TIOCM_CTS
: 0)
629 | ((status
& MSR_STATUS_LINE_DSR
) ? TIOCM_DSR
: 0)
630 | ((status
& MSR_STATUS_LINE_RI
) ? TIOCM_RI
: 0)
631 | ((status
& MSR_STATUS_LINE_DCD
) ? TIOCM_CD
: 0);
636 /* All of the device info needed for the spcp8x5 SIO serial converter */
637 static struct usb_serial_driver spcp8x5_device
= {
639 .owner
= THIS_MODULE
,
642 .id_table
= id_table
,
644 .open
= spcp8x5_open
,
645 .dtr_rts
= spcp8x5_dtr_rts
,
646 .carrier_raised
= spcp8x5_carrier_raised
,
647 .set_termios
= spcp8x5_set_termios
,
648 .init_termios
= spcp8x5_init_termios
,
649 .ioctl
= spcp8x5_ioctl
,
650 .tiocmget
= spcp8x5_tiocmget
,
651 .tiocmset
= spcp8x5_tiocmset
,
652 .attach
= spcp8x5_startup
,
653 .release
= spcp8x5_release
,
654 .process_read_urb
= spcp8x5_process_read_urb
,
657 static struct usb_serial_driver
* const serial_drivers
[] = {
658 &spcp8x5_device
, NULL
661 module_usb_serial_driver(serial_drivers
, id_table
);
663 MODULE_DESCRIPTION(DRIVER_DESC
);
664 MODULE_VERSION(DRIVER_VERSION
);
665 MODULE_LICENSE("GPL");