1 // SPDX-License-Identifier: GPL-2.0+
3 * spcp8x5 USB to serial adaptor driver
5 * Copyright (C) 2010-2013 Johan Hovold (jhovold@gmail.com)
6 * Copyright (C) 2006 Linxb (xubin.lin@worldplus.com.cn)
7 * Copyright (C) 2006 S1 Corp.
9 * Original driver for 2.6.10 pl2303 driver by
10 * Greg Kroah-Hartman (greg@kroah.com)
11 * Changes for 2.6.20 by Harald Klein <hari@vt100.at>
13 #include <linux/kernel.h>
14 #include <linux/errno.h>
15 #include <linux/slab.h>
16 #include <linux/tty.h>
17 #include <linux/tty_driver.h>
18 #include <linux/tty_flip.h>
19 #include <linux/module.h>
20 #include <linux/spinlock.h>
21 #include <linux/usb.h>
22 #include <linux/usb/serial.h>
24 #define DRIVER_DESC "SPCP8x5 USB to serial adaptor driver"
26 #define SPCP825_QUIRK_NO_UART_STATUS 0x01
27 #define SPCP825_QUIRK_NO_WORK_MODE 0x02
29 #define SPCP8x5_007_VID 0x04FC
30 #define SPCP8x5_007_PID 0x0201
31 #define SPCP8x5_008_VID 0x04fc
32 #define SPCP8x5_008_PID 0x0235
33 #define SPCP8x5_PHILIPS_VID 0x0471
34 #define SPCP8x5_PHILIPS_PID 0x081e
35 #define SPCP8x5_INTERMATIC_VID 0x04FC
36 #define SPCP8x5_INTERMATIC_PID 0x0204
37 #define SPCP8x5_835_VID 0x04fc
38 #define SPCP8x5_835_PID 0x0231
40 static const struct usb_device_id id_table[] = {
41 { USB_DEVICE(SPCP8x5_PHILIPS_VID , SPCP8x5_PHILIPS_PID)},
42 { USB_DEVICE(SPCP8x5_INTERMATIC_VID, SPCP8x5_INTERMATIC_PID)},
43 { USB_DEVICE(SPCP8x5_835_VID, SPCP8x5_835_PID)},
44 { USB_DEVICE(SPCP8x5_008_VID, SPCP8x5_008_PID)},
45 { USB_DEVICE(SPCP8x5_007_VID, SPCP8x5_007_PID),
46 .driver_info = SPCP825_QUIRK_NO_UART_STATUS |
47 SPCP825_QUIRK_NO_WORK_MODE },
48 { } /* Terminating entry */
50 MODULE_DEVICE_TABLE(usb, id_table);
52 struct spcp8x5_usb_ctrl_arg {
62 /* spcp8x5 spec register define */
63 #define MCR_CONTROL_LINE_RTS 0x02
64 #define MCR_CONTROL_LINE_DTR 0x01
68 #define MSR_STATUS_LINE_DCD 0x80
69 #define MSR_STATUS_LINE_RI 0x40
70 #define MSR_STATUS_LINE_DSR 0x20
71 #define MSR_STATUS_LINE_CTS 0x10
73 /* verdor command here , we should define myself */
74 #define SET_DEFAULT 0x40
75 #define SET_DEFAULT_TYPE 0x20
77 #define SET_UART_FORMAT 0x40
78 #define SET_UART_FORMAT_TYPE 0x21
79 #define SET_UART_FORMAT_SIZE_5 0x00
80 #define SET_UART_FORMAT_SIZE_6 0x01
81 #define SET_UART_FORMAT_SIZE_7 0x02
82 #define SET_UART_FORMAT_SIZE_8 0x03
83 #define SET_UART_FORMAT_STOP_1 0x00
84 #define SET_UART_FORMAT_STOP_2 0x04
85 #define SET_UART_FORMAT_PAR_NONE 0x00
86 #define SET_UART_FORMAT_PAR_ODD 0x10
87 #define SET_UART_FORMAT_PAR_EVEN 0x30
88 #define SET_UART_FORMAT_PAR_MASK 0xD0
89 #define SET_UART_FORMAT_PAR_SPACE 0x90
91 #define GET_UART_STATUS_TYPE 0xc0
92 #define GET_UART_STATUS 0x22
93 #define GET_UART_STATUS_MSR 0x06
95 #define SET_UART_STATUS 0x40
96 #define SET_UART_STATUS_TYPE 0x23
97 #define SET_UART_STATUS_MCR 0x0004
98 #define SET_UART_STATUS_MCR_DTR 0x01
99 #define SET_UART_STATUS_MCR_RTS 0x02
100 #define SET_UART_STATUS_MCR_LOOP 0x10
102 #define SET_WORKING_MODE 0x40
103 #define SET_WORKING_MODE_TYPE 0x24
104 #define SET_WORKING_MODE_U2C 0x00
105 #define SET_WORKING_MODE_RS485 0x01
106 #define SET_WORKING_MODE_PDMA 0x02
107 #define SET_WORKING_MODE_SPP 0x03
109 #define SET_FLOWCTL_CHAR 0x40
110 #define SET_FLOWCTL_CHAR_TYPE 0x25
112 #define GET_VERSION 0xc0
113 #define GET_VERSION_TYPE 0x26
115 #define SET_REGISTER 0x40
116 #define SET_REGISTER_TYPE 0x27
118 #define GET_REGISTER 0xc0
119 #define GET_REGISTER_TYPE 0x28
122 #define SET_RAM_TYPE 0x31
125 #define GET_RAM_TYPE 0x32
128 #define UART_STATE 0x08
129 #define UART_STATE_TRANSIENT_MASK 0x75
130 #define UART_DCD 0x01
131 #define UART_DSR 0x02
132 #define UART_BREAK_ERROR 0x04
133 #define UART_RING 0x08
134 #define UART_FRAME_ERROR 0x10
135 #define UART_PARITY_ERROR 0x20
136 #define UART_OVERRUN_ERROR 0x40
137 #define UART_CTS 0x80
139 struct spcp8x5_private {
145 static int spcp8x5_probe(struct usb_serial *serial,
146 const struct usb_device_id *id)
148 usb_set_serial_data(serial, (void *)id);
153 static int spcp8x5_port_probe(struct usb_serial_port *port)
155 const struct usb_device_id *id = usb_get_serial_data(port->serial);
156 struct spcp8x5_private *priv;
158 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
162 spin_lock_init(&priv->lock);
163 priv->quirks = id->driver_info;
165 usb_set_serial_port_data(port, priv);
167 port->port.drain_delay = 256;
172 static void spcp8x5_port_remove(struct usb_serial_port *port)
174 struct spcp8x5_private *priv;
176 priv = usb_get_serial_port_data(port);
180 static int spcp8x5_set_ctrl_line(struct usb_serial_port *port, u8 mcr)
182 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
183 struct usb_device *dev = port->serial->dev;
186 if (priv->quirks & SPCP825_QUIRK_NO_UART_STATUS)
189 retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
190 SET_UART_STATUS_TYPE, SET_UART_STATUS,
191 mcr, 0x04, NULL, 0, 100);
193 dev_err(&port->dev, "failed to set control lines: %d\n",
199 static int spcp8x5_get_msr(struct usb_serial_port *port, u8 *status)
201 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
202 struct usb_device *dev = port->serial->dev;
206 if (priv->quirks & SPCP825_QUIRK_NO_UART_STATUS)
209 buf = kzalloc(1, GFP_KERNEL);
213 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
214 GET_UART_STATUS, GET_UART_STATUS_TYPE,
215 0, GET_UART_STATUS_MSR, buf, 1, 100);
217 dev_err(&port->dev, "failed to get modem status: %d\n", ret);
223 dev_dbg(&port->dev, "0xc0:0x22:0:6 %d - 0x02%x\n", ret, *buf);
232 static void spcp8x5_set_work_mode(struct usb_serial_port *port, u16 value,
235 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
236 struct usb_device *dev = port->serial->dev;
239 if (priv->quirks & SPCP825_QUIRK_NO_WORK_MODE)
242 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
243 SET_WORKING_MODE_TYPE, SET_WORKING_MODE,
244 value, index, NULL, 0, 100);
245 dev_dbg(&port->dev, "value = %#x , index = %#x\n", value, index);
247 dev_err(&port->dev, "failed to set work mode: %d\n", ret);
250 static int spcp8x5_carrier_raised(struct usb_serial_port *port)
255 ret = spcp8x5_get_msr(port, &msr);
256 if (ret || msr & MSR_STATUS_LINE_DCD)
262 static void spcp8x5_dtr_rts(struct usb_serial_port *port, int on)
264 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
268 spin_lock_irqsave(&priv->lock, flags);
270 priv->line_control = MCR_CONTROL_LINE_DTR
271 | MCR_CONTROL_LINE_RTS;
273 priv->line_control &= ~ (MCR_CONTROL_LINE_DTR
274 | MCR_CONTROL_LINE_RTS);
275 control = priv->line_control;
276 spin_unlock_irqrestore(&priv->lock, flags);
277 spcp8x5_set_ctrl_line(port, control);
280 static void spcp8x5_init_termios(struct tty_struct *tty)
282 tty_encode_baud_rate(tty, 115200, 115200);
285 static void spcp8x5_set_termios(struct tty_struct *tty,
286 struct usb_serial_port *port,
287 const struct ktermios *old_termios)
289 struct usb_serial *serial = port->serial;
290 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
292 unsigned int cflag = tty->termios.c_cflag;
293 unsigned short uartdata;
294 unsigned char buf[2] = {0, 0};
299 /* check that they really want us to change something */
300 if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios))
303 /* set DTR/RTS active */
304 spin_lock_irqsave(&priv->lock, flags);
305 control = priv->line_control;
306 if (old_termios && (old_termios->c_cflag & CBAUD) == B0) {
307 priv->line_control |= MCR_DTR;
308 if (!(old_termios->c_cflag & CRTSCTS))
309 priv->line_control |= MCR_RTS;
311 if (control != priv->line_control) {
312 control = priv->line_control;
313 spin_unlock_irqrestore(&priv->lock, flags);
314 spcp8x5_set_ctrl_line(port, control);
316 spin_unlock_irqrestore(&priv->lock, flags);
320 baud = tty_get_baud_rate(tty);
322 case 300: buf[0] = 0x00; break;
323 case 600: buf[0] = 0x01; break;
324 case 1200: buf[0] = 0x02; break;
325 case 2400: buf[0] = 0x03; break;
326 case 4800: buf[0] = 0x04; break;
327 case 9600: buf[0] = 0x05; break;
328 case 19200: buf[0] = 0x07; break;
329 case 38400: buf[0] = 0x09; break;
330 case 57600: buf[0] = 0x0a; break;
331 case 115200: buf[0] = 0x0b; break;
332 case 230400: buf[0] = 0x0c; break;
333 case 460800: buf[0] = 0x0d; break;
334 case 921600: buf[0] = 0x0e; break;
335 /* case 1200000: buf[0] = 0x0f; break; */
336 /* case 2400000: buf[0] = 0x10; break; */
337 case 3000000: buf[0] = 0x11; break;
338 /* case 6000000: buf[0] = 0x12; break; */
341 buf[0] = 0x0b; break;
343 dev_err(&port->dev, "unsupported baudrate, using 9600\n");
346 /* Set Data Length : 00:5bit, 01:6bit, 10:7bit, 11:8bit */
347 switch (cflag & CSIZE) {
349 buf[1] |= SET_UART_FORMAT_SIZE_5;
352 buf[1] |= SET_UART_FORMAT_SIZE_6;
355 buf[1] |= SET_UART_FORMAT_SIZE_7;
359 buf[1] |= SET_UART_FORMAT_SIZE_8;
363 /* Set Stop bit2 : 0:1bit 1:2bit */
364 buf[1] |= (cflag & CSTOPB) ? SET_UART_FORMAT_STOP_2 :
365 SET_UART_FORMAT_STOP_1;
367 /* Set Parity bit3-4 01:Odd 11:Even */
368 if (cflag & PARENB) {
369 buf[1] |= (cflag & PARODD) ?
370 SET_UART_FORMAT_PAR_ODD : SET_UART_FORMAT_PAR_EVEN ;
372 buf[1] |= SET_UART_FORMAT_PAR_NONE;
374 uartdata = buf[0] | buf[1]<<8;
376 i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
377 SET_UART_FORMAT_TYPE, SET_UART_FORMAT,
378 uartdata, 0, NULL, 0, 100);
380 dev_err(&port->dev, "Set UART format %#x failed (error = %d)\n",
382 dev_dbg(&port->dev, "0x21:0x40:0:0 %d\n", i);
384 if (cflag & CRTSCTS) {
385 /* enable hardware flow control */
386 spcp8x5_set_work_mode(port, 0x000a, SET_WORKING_MODE_U2C);
390 static int spcp8x5_open(struct tty_struct *tty, struct usb_serial_port *port)
392 struct usb_serial *serial = port->serial;
393 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
396 usb_clear_halt(serial->dev, port->write_urb->pipe);
397 usb_clear_halt(serial->dev, port->read_urb->pipe);
399 ret = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
401 0x01, 0x00, NULL, 0x00, 100);
405 spcp8x5_set_ctrl_line(port, priv->line_control);
408 spcp8x5_set_termios(tty, port, NULL);
410 return usb_serial_generic_open(tty, port);
413 static int spcp8x5_tiocmset(struct tty_struct *tty,
414 unsigned int set, unsigned int clear)
416 struct usb_serial_port *port = tty->driver_data;
417 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
421 spin_lock_irqsave(&priv->lock, flags);
423 priv->line_control |= MCR_RTS;
425 priv->line_control |= MCR_DTR;
426 if (clear & TIOCM_RTS)
427 priv->line_control &= ~MCR_RTS;
428 if (clear & TIOCM_DTR)
429 priv->line_control &= ~MCR_DTR;
430 control = priv->line_control;
431 spin_unlock_irqrestore(&priv->lock, flags);
433 return spcp8x5_set_ctrl_line(port, control);
436 static int spcp8x5_tiocmget(struct tty_struct *tty)
438 struct usb_serial_port *port = tty->driver_data;
439 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
445 result = spcp8x5_get_msr(port, &status);
449 spin_lock_irqsave(&priv->lock, flags);
450 mcr = priv->line_control;
451 spin_unlock_irqrestore(&priv->lock, flags);
453 result = ((mcr & MCR_DTR) ? TIOCM_DTR : 0)
454 | ((mcr & MCR_RTS) ? TIOCM_RTS : 0)
455 | ((status & MSR_STATUS_LINE_CTS) ? TIOCM_CTS : 0)
456 | ((status & MSR_STATUS_LINE_DSR) ? TIOCM_DSR : 0)
457 | ((status & MSR_STATUS_LINE_RI) ? TIOCM_RI : 0)
458 | ((status & MSR_STATUS_LINE_DCD) ? TIOCM_CD : 0);
463 static struct usb_serial_driver spcp8x5_device = {
465 .owner = THIS_MODULE,
468 .id_table = id_table,
472 .open = spcp8x5_open,
473 .dtr_rts = spcp8x5_dtr_rts,
474 .carrier_raised = spcp8x5_carrier_raised,
475 .set_termios = spcp8x5_set_termios,
476 .init_termios = spcp8x5_init_termios,
477 .tiocmget = spcp8x5_tiocmget,
478 .tiocmset = spcp8x5_tiocmset,
479 .probe = spcp8x5_probe,
480 .port_probe = spcp8x5_port_probe,
481 .port_remove = spcp8x5_port_remove,
484 static struct usb_serial_driver * const serial_drivers[] = {
485 &spcp8x5_device, NULL
488 module_usb_serial_driver(serial_drivers, id_table);
490 MODULE_DESCRIPTION(DRIVER_DESC);
491 MODULE_LICENSE("GPL");