2 * spcp8x5 USB to serial adaptor driver
4 * Copyright (C) 2010-2013 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.
17 #include <linux/kernel.h>
18 #include <linux/errno.h>
19 #include <linux/slab.h>
20 #include <linux/tty.h>
21 #include <linux/tty_driver.h>
22 #include <linux/tty_flip.h>
23 #include <linux/module.h>
24 #include <linux/spinlock.h>
25 #include <linux/usb.h>
26 #include <linux/usb/serial.h>
28 #define DRIVER_DESC "SPCP8x5 USB to serial adaptor driver"
30 #define SPCP825_QUIRK_NO_UART_STATUS 0x01
31 #define SPCP825_QUIRK_NO_WORK_MODE 0x02
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 .driver_info
= SPCP825_QUIRK_NO_UART_STATUS
|
51 SPCP825_QUIRK_NO_WORK_MODE
},
52 { } /* Terminating entry */
54 MODULE_DEVICE_TABLE(usb
, id_table
);
56 struct spcp8x5_usb_ctrl_arg
{
66 /* spcp8x5 spec register define */
67 #define MCR_CONTROL_LINE_RTS 0x02
68 #define MCR_CONTROL_LINE_DTR 0x01
72 #define MSR_STATUS_LINE_DCD 0x80
73 #define MSR_STATUS_LINE_RI 0x40
74 #define MSR_STATUS_LINE_DSR 0x20
75 #define MSR_STATUS_LINE_CTS 0x10
77 /* verdor command here , we should define myself */
78 #define SET_DEFAULT 0x40
79 #define SET_DEFAULT_TYPE 0x20
81 #define SET_UART_FORMAT 0x40
82 #define SET_UART_FORMAT_TYPE 0x21
83 #define SET_UART_FORMAT_SIZE_5 0x00
84 #define SET_UART_FORMAT_SIZE_6 0x01
85 #define SET_UART_FORMAT_SIZE_7 0x02
86 #define SET_UART_FORMAT_SIZE_8 0x03
87 #define SET_UART_FORMAT_STOP_1 0x00
88 #define SET_UART_FORMAT_STOP_2 0x04
89 #define SET_UART_FORMAT_PAR_NONE 0x00
90 #define SET_UART_FORMAT_PAR_ODD 0x10
91 #define SET_UART_FORMAT_PAR_EVEN 0x30
92 #define SET_UART_FORMAT_PAR_MASK 0xD0
93 #define SET_UART_FORMAT_PAR_SPACE 0x90
95 #define GET_UART_STATUS_TYPE 0xc0
96 #define GET_UART_STATUS 0x22
97 #define GET_UART_STATUS_MSR 0x06
99 #define SET_UART_STATUS 0x40
100 #define SET_UART_STATUS_TYPE 0x23
101 #define SET_UART_STATUS_MCR 0x0004
102 #define SET_UART_STATUS_MCR_DTR 0x01
103 #define SET_UART_STATUS_MCR_RTS 0x02
104 #define SET_UART_STATUS_MCR_LOOP 0x10
106 #define SET_WORKING_MODE 0x40
107 #define SET_WORKING_MODE_TYPE 0x24
108 #define SET_WORKING_MODE_U2C 0x00
109 #define SET_WORKING_MODE_RS485 0x01
110 #define SET_WORKING_MODE_PDMA 0x02
111 #define SET_WORKING_MODE_SPP 0x03
113 #define SET_FLOWCTL_CHAR 0x40
114 #define SET_FLOWCTL_CHAR_TYPE 0x25
116 #define GET_VERSION 0xc0
117 #define GET_VERSION_TYPE 0x26
119 #define SET_REGISTER 0x40
120 #define SET_REGISTER_TYPE 0x27
122 #define GET_REGISTER 0xc0
123 #define GET_REGISTER_TYPE 0x28
126 #define SET_RAM_TYPE 0x31
129 #define GET_RAM_TYPE 0x32
132 #define UART_STATE 0x08
133 #define UART_STATE_TRANSIENT_MASK 0x75
134 #define UART_DCD 0x01
135 #define UART_DSR 0x02
136 #define UART_BREAK_ERROR 0x04
137 #define UART_RING 0x08
138 #define UART_FRAME_ERROR 0x10
139 #define UART_PARITY_ERROR 0x20
140 #define UART_OVERRUN_ERROR 0x40
141 #define UART_CTS 0x80
143 struct spcp8x5_private
{
149 static int spcp8x5_probe(struct usb_serial
*serial
,
150 const struct usb_device_id
*id
)
152 usb_set_serial_data(serial
, (void *)id
);
157 static int spcp8x5_attach(struct usb_serial
*serial
)
159 unsigned char num_ports
= serial
->num_ports
;
161 if (serial
->num_bulk_in
< num_ports
||
162 serial
->num_bulk_out
< num_ports
) {
163 dev_err(&serial
->interface
->dev
, "missing endpoints\n");
170 static int spcp8x5_port_probe(struct usb_serial_port
*port
)
172 const struct usb_device_id
*id
= usb_get_serial_data(port
->serial
);
173 struct spcp8x5_private
*priv
;
175 priv
= kzalloc(sizeof(*priv
), GFP_KERNEL
);
179 spin_lock_init(&priv
->lock
);
180 priv
->quirks
= id
->driver_info
;
182 usb_set_serial_port_data(port
, priv
);
184 port
->port
.drain_delay
= 256;
189 static int spcp8x5_port_remove(struct usb_serial_port
*port
)
191 struct spcp8x5_private
*priv
;
193 priv
= usb_get_serial_port_data(port
);
199 static int spcp8x5_set_ctrl_line(struct usb_serial_port
*port
, u8 mcr
)
201 struct spcp8x5_private
*priv
= usb_get_serial_port_data(port
);
202 struct usb_device
*dev
= port
->serial
->dev
;
205 if (priv
->quirks
& SPCP825_QUIRK_NO_UART_STATUS
)
208 retval
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
209 SET_UART_STATUS_TYPE
, SET_UART_STATUS
,
210 mcr
, 0x04, NULL
, 0, 100);
212 dev_err(&port
->dev
, "failed to set control lines: %d\n",
218 static int spcp8x5_get_msr(struct usb_serial_port
*port
, u8
*status
)
220 struct spcp8x5_private
*priv
= usb_get_serial_port_data(port
);
221 struct usb_device
*dev
= port
->serial
->dev
;
225 if (priv
->quirks
& SPCP825_QUIRK_NO_UART_STATUS
)
228 buf
= kzalloc(1, GFP_KERNEL
);
232 ret
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
233 GET_UART_STATUS
, GET_UART_STATUS_TYPE
,
234 0, GET_UART_STATUS_MSR
, buf
, 1, 100);
236 dev_err(&port
->dev
, "failed to get modem status: %d\n", ret
);
242 dev_dbg(&port
->dev
, "0xc0:0x22:0:6 %d - 0x02%x\n", ret
, *buf
);
251 static void spcp8x5_set_work_mode(struct usb_serial_port
*port
, u16 value
,
254 struct spcp8x5_private
*priv
= usb_get_serial_port_data(port
);
255 struct usb_device
*dev
= port
->serial
->dev
;
258 if (priv
->quirks
& SPCP825_QUIRK_NO_WORK_MODE
)
261 ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
262 SET_WORKING_MODE_TYPE
, SET_WORKING_MODE
,
263 value
, index
, NULL
, 0, 100);
264 dev_dbg(&port
->dev
, "value = %#x , index = %#x\n", value
, index
);
266 dev_err(&port
->dev
, "failed to set work mode: %d\n", ret
);
269 static int spcp8x5_carrier_raised(struct usb_serial_port
*port
)
274 ret
= spcp8x5_get_msr(port
, &msr
);
275 if (ret
|| msr
& MSR_STATUS_LINE_DCD
)
281 static void spcp8x5_dtr_rts(struct usb_serial_port
*port
, int on
)
283 struct spcp8x5_private
*priv
= usb_get_serial_port_data(port
);
287 spin_lock_irqsave(&priv
->lock
, flags
);
289 priv
->line_control
= MCR_CONTROL_LINE_DTR
290 | MCR_CONTROL_LINE_RTS
;
292 priv
->line_control
&= ~ (MCR_CONTROL_LINE_DTR
293 | MCR_CONTROL_LINE_RTS
);
294 control
= priv
->line_control
;
295 spin_unlock_irqrestore(&priv
->lock
, flags
);
296 spcp8x5_set_ctrl_line(port
, control
);
299 static void spcp8x5_init_termios(struct tty_struct
*tty
)
301 tty
->termios
= tty_std_termios
;
302 tty
->termios
.c_cflag
= B115200
| CS8
| CREAD
| HUPCL
| CLOCAL
;
303 tty
->termios
.c_ispeed
= 115200;
304 tty
->termios
.c_ospeed
= 115200;
307 static void spcp8x5_set_termios(struct tty_struct
*tty
,
308 struct usb_serial_port
*port
, struct ktermios
*old_termios
)
310 struct usb_serial
*serial
= port
->serial
;
311 struct spcp8x5_private
*priv
= usb_get_serial_port_data(port
);
313 unsigned int cflag
= tty
->termios
.c_cflag
;
314 unsigned short uartdata
;
315 unsigned char buf
[2] = {0, 0};
320 /* check that they really want us to change something */
321 if (old_termios
&& !tty_termios_hw_change(&tty
->termios
, old_termios
))
324 /* set DTR/RTS active */
325 spin_lock_irqsave(&priv
->lock
, flags
);
326 control
= priv
->line_control
;
327 if (old_termios
&& (old_termios
->c_cflag
& CBAUD
) == B0
) {
328 priv
->line_control
|= MCR_DTR
;
329 if (!(old_termios
->c_cflag
& CRTSCTS
))
330 priv
->line_control
|= MCR_RTS
;
332 if (control
!= priv
->line_control
) {
333 control
= priv
->line_control
;
334 spin_unlock_irqrestore(&priv
->lock
, flags
);
335 spcp8x5_set_ctrl_line(port
, control
);
337 spin_unlock_irqrestore(&priv
->lock
, flags
);
341 baud
= tty_get_baud_rate(tty
);
343 case 300: buf
[0] = 0x00; break;
344 case 600: buf
[0] = 0x01; break;
345 case 1200: buf
[0] = 0x02; break;
346 case 2400: buf
[0] = 0x03; break;
347 case 4800: buf
[0] = 0x04; break;
348 case 9600: buf
[0] = 0x05; break;
349 case 19200: buf
[0] = 0x07; break;
350 case 38400: buf
[0] = 0x09; break;
351 case 57600: buf
[0] = 0x0a; break;
352 case 115200: buf
[0] = 0x0b; break;
353 case 230400: buf
[0] = 0x0c; break;
354 case 460800: buf
[0] = 0x0d; break;
355 case 921600: buf
[0] = 0x0e; break;
356 /* case 1200000: buf[0] = 0x0f; break; */
357 /* case 2400000: buf[0] = 0x10; break; */
358 case 3000000: buf
[0] = 0x11; break;
359 /* case 6000000: buf[0] = 0x12; break; */
362 buf
[0] = 0x0b; break;
364 dev_err(&port
->dev
, "unsupported baudrate, using 9600\n");
367 /* Set Data Length : 00:5bit, 01:6bit, 10:7bit, 11:8bit */
368 switch (cflag
& CSIZE
) {
370 buf
[1] |= SET_UART_FORMAT_SIZE_5
;
373 buf
[1] |= SET_UART_FORMAT_SIZE_6
;
376 buf
[1] |= SET_UART_FORMAT_SIZE_7
;
380 buf
[1] |= SET_UART_FORMAT_SIZE_8
;
384 /* Set Stop bit2 : 0:1bit 1:2bit */
385 buf
[1] |= (cflag
& CSTOPB
) ? SET_UART_FORMAT_STOP_2
:
386 SET_UART_FORMAT_STOP_1
;
388 /* Set Parity bit3-4 01:Odd 11:Even */
389 if (cflag
& PARENB
) {
390 buf
[1] |= (cflag
& PARODD
) ?
391 SET_UART_FORMAT_PAR_ODD
: SET_UART_FORMAT_PAR_EVEN
;
393 buf
[1] |= SET_UART_FORMAT_PAR_NONE
;
395 uartdata
= buf
[0] | buf
[1]<<8;
397 i
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
398 SET_UART_FORMAT_TYPE
, SET_UART_FORMAT
,
399 uartdata
, 0, NULL
, 0, 100);
401 dev_err(&port
->dev
, "Set UART format %#x failed (error = %d)\n",
403 dev_dbg(&port
->dev
, "0x21:0x40:0:0 %d\n", i
);
405 if (cflag
& CRTSCTS
) {
406 /* enable hardware flow control */
407 spcp8x5_set_work_mode(port
, 0x000a, SET_WORKING_MODE_U2C
);
411 static int spcp8x5_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
413 struct usb_serial
*serial
= port
->serial
;
414 struct spcp8x5_private
*priv
= usb_get_serial_port_data(port
);
417 usb_clear_halt(serial
->dev
, port
->write_urb
->pipe
);
418 usb_clear_halt(serial
->dev
, port
->read_urb
->pipe
);
420 ret
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
422 0x01, 0x00, NULL
, 0x00, 100);
426 spcp8x5_set_ctrl_line(port
, priv
->line_control
);
429 spcp8x5_set_termios(tty
, port
, NULL
);
431 return usb_serial_generic_open(tty
, port
);
434 static int spcp8x5_tiocmset(struct tty_struct
*tty
,
435 unsigned int set
, unsigned int clear
)
437 struct usb_serial_port
*port
= tty
->driver_data
;
438 struct spcp8x5_private
*priv
= usb_get_serial_port_data(port
);
442 spin_lock_irqsave(&priv
->lock
, flags
);
444 priv
->line_control
|= MCR_RTS
;
446 priv
->line_control
|= MCR_DTR
;
447 if (clear
& TIOCM_RTS
)
448 priv
->line_control
&= ~MCR_RTS
;
449 if (clear
& TIOCM_DTR
)
450 priv
->line_control
&= ~MCR_DTR
;
451 control
= priv
->line_control
;
452 spin_unlock_irqrestore(&priv
->lock
, flags
);
454 return spcp8x5_set_ctrl_line(port
, control
);
457 static int spcp8x5_tiocmget(struct tty_struct
*tty
)
459 struct usb_serial_port
*port
= tty
->driver_data
;
460 struct spcp8x5_private
*priv
= usb_get_serial_port_data(port
);
466 result
= spcp8x5_get_msr(port
, &status
);
470 spin_lock_irqsave(&priv
->lock
, flags
);
471 mcr
= priv
->line_control
;
472 spin_unlock_irqrestore(&priv
->lock
, flags
);
474 result
= ((mcr
& MCR_DTR
) ? TIOCM_DTR
: 0)
475 | ((mcr
& MCR_RTS
) ? TIOCM_RTS
: 0)
476 | ((status
& MSR_STATUS_LINE_CTS
) ? TIOCM_CTS
: 0)
477 | ((status
& MSR_STATUS_LINE_DSR
) ? TIOCM_DSR
: 0)
478 | ((status
& MSR_STATUS_LINE_RI
) ? TIOCM_RI
: 0)
479 | ((status
& MSR_STATUS_LINE_DCD
) ? TIOCM_CD
: 0);
484 static struct usb_serial_driver spcp8x5_device
= {
486 .owner
= THIS_MODULE
,
489 .id_table
= id_table
,
491 .open
= spcp8x5_open
,
492 .dtr_rts
= spcp8x5_dtr_rts
,
493 .carrier_raised
= spcp8x5_carrier_raised
,
494 .set_termios
= spcp8x5_set_termios
,
495 .init_termios
= spcp8x5_init_termios
,
496 .tiocmget
= spcp8x5_tiocmget
,
497 .tiocmset
= spcp8x5_tiocmset
,
498 .probe
= spcp8x5_probe
,
499 .attach
= spcp8x5_attach
,
500 .port_probe
= spcp8x5_port_probe
,
501 .port_remove
= spcp8x5_port_remove
,
504 static struct usb_serial_driver
* const serial_drivers
[] = {
505 &spcp8x5_device
, NULL
508 module_usb_serial_driver(serial_drivers
, id_table
);
510 MODULE_DESCRIPTION(DRIVER_DESC
);
511 MODULE_LICENSE("GPL");