1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * spcp8x5 USB to serial adaptor driver
4 *
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.
8 *
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>
12 */
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>
23
24 #define DRIVER_DESC "SPCP8x5 USB to serial adaptor driver"
25
26 #define SPCP825_QUIRK_NO_UART_STATUS 0x01
27 #define SPCP825_QUIRK_NO_WORK_MODE 0x02
28
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
39
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 */
49 };
50 MODULE_DEVICE_TABLE(usb, id_table);
51
52 struct spcp8x5_usb_ctrl_arg {
53 u8 type;
54 u8 cmd;
55 u8 cmd_type;
56 u16 value;
57 u16 index;
58 u16 length;
59 };
60
61
62 /* spcp8x5 spec register define */
63 #define MCR_CONTROL_LINE_RTS 0x02
64 #define MCR_CONTROL_LINE_DTR 0x01
65 #define MCR_DTR 0x01
66 #define MCR_RTS 0x02
67
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
72
73 /* verdor command here , we should define myself */
74 #define SET_DEFAULT 0x40
75 #define SET_DEFAULT_TYPE 0x20
76
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
90
91 #define GET_UART_STATUS_TYPE 0xc0
92 #define GET_UART_STATUS 0x22
93 #define GET_UART_STATUS_MSR 0x06
94
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
101
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
108
109 #define SET_FLOWCTL_CHAR 0x40
110 #define SET_FLOWCTL_CHAR_TYPE 0x25
111
112 #define GET_VERSION 0xc0
113 #define GET_VERSION_TYPE 0x26
114
115 #define SET_REGISTER 0x40
116 #define SET_REGISTER_TYPE 0x27
117
118 #define GET_REGISTER 0xc0
119 #define GET_REGISTER_TYPE 0x28
120
121 #define SET_RAM 0x40
122 #define SET_RAM_TYPE 0x31
123
124 #define GET_RAM 0xc0
125 #define GET_RAM_TYPE 0x32
126
127 /* how come ??? */
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
138
139 struct spcp8x5_private {
140 unsigned quirks;
141 spinlock_t lock;
142 u8 line_control;
143 };
144
spcp8x5_probe(struct usb_serial * serial,const struct usb_device_id * id)145 static int spcp8x5_probe(struct usb_serial *serial,
146 const struct usb_device_id *id)
147 {
148 usb_set_serial_data(serial, (void *)id);
149
150 return 0;
151 }
152
spcp8x5_port_probe(struct usb_serial_port * port)153 static int spcp8x5_port_probe(struct usb_serial_port *port)
154 {
155 const struct usb_device_id *id = usb_get_serial_data(port->serial);
156 struct spcp8x5_private *priv;
157
158 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
159 if (!priv)
160 return -ENOMEM;
161
162 spin_lock_init(&priv->lock);
163 priv->quirks = id->driver_info;
164
165 usb_set_serial_port_data(port, priv);
166
167 port->port.drain_delay = 256;
168
169 return 0;
170 }
171
spcp8x5_port_remove(struct usb_serial_port * port)172 static int spcp8x5_port_remove(struct usb_serial_port *port)
173 {
174 struct spcp8x5_private *priv;
175
176 priv = usb_get_serial_port_data(port);
177 kfree(priv);
178
179 return 0;
180 }
181
spcp8x5_set_ctrl_line(struct usb_serial_port * port,u8 mcr)182 static int spcp8x5_set_ctrl_line(struct usb_serial_port *port, u8 mcr)
183 {
184 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
185 struct usb_device *dev = port->serial->dev;
186 int retval;
187
188 if (priv->quirks & SPCP825_QUIRK_NO_UART_STATUS)
189 return -EPERM;
190
191 retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
192 SET_UART_STATUS_TYPE, SET_UART_STATUS,
193 mcr, 0x04, NULL, 0, 100);
194 if (retval != 0) {
195 dev_err(&port->dev, "failed to set control lines: %d\n",
196 retval);
197 }
198 return retval;
199 }
200
spcp8x5_get_msr(struct usb_serial_port * port,u8 * status)201 static int spcp8x5_get_msr(struct usb_serial_port *port, u8 *status)
202 {
203 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
204 struct usb_device *dev = port->serial->dev;
205 u8 *buf;
206 int ret;
207
208 if (priv->quirks & SPCP825_QUIRK_NO_UART_STATUS)
209 return -EPERM;
210
211 buf = kzalloc(1, GFP_KERNEL);
212 if (!buf)
213 return -ENOMEM;
214
215 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
216 GET_UART_STATUS, GET_UART_STATUS_TYPE,
217 0, GET_UART_STATUS_MSR, buf, 1, 100);
218 if (ret < 1) {
219 dev_err(&port->dev, "failed to get modem status: %d\n", ret);
220 if (ret >= 0)
221 ret = -EIO;
222 goto out;
223 }
224
225 dev_dbg(&port->dev, "0xc0:0x22:0:6 %d - 0x02%x\n", ret, *buf);
226 *status = *buf;
227 ret = 0;
228 out:
229 kfree(buf);
230
231 return ret;
232 }
233
spcp8x5_set_work_mode(struct usb_serial_port * port,u16 value,u16 index)234 static void spcp8x5_set_work_mode(struct usb_serial_port *port, u16 value,
235 u16 index)
236 {
237 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
238 struct usb_device *dev = port->serial->dev;
239 int ret;
240
241 if (priv->quirks & SPCP825_QUIRK_NO_WORK_MODE)
242 return;
243
244 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
245 SET_WORKING_MODE_TYPE, SET_WORKING_MODE,
246 value, index, NULL, 0, 100);
247 dev_dbg(&port->dev, "value = %#x , index = %#x\n", value, index);
248 if (ret < 0)
249 dev_err(&port->dev, "failed to set work mode: %d\n", ret);
250 }
251
spcp8x5_carrier_raised(struct usb_serial_port * port)252 static int spcp8x5_carrier_raised(struct usb_serial_port *port)
253 {
254 u8 msr;
255 int ret;
256
257 ret = spcp8x5_get_msr(port, &msr);
258 if (ret || msr & MSR_STATUS_LINE_DCD)
259 return 1;
260
261 return 0;
262 }
263
spcp8x5_dtr_rts(struct usb_serial_port * port,int on)264 static void spcp8x5_dtr_rts(struct usb_serial_port *port, int on)
265 {
266 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
267 unsigned long flags;
268 u8 control;
269
270 spin_lock_irqsave(&priv->lock, flags);
271 if (on)
272 priv->line_control = MCR_CONTROL_LINE_DTR
273 | MCR_CONTROL_LINE_RTS;
274 else
275 priv->line_control &= ~ (MCR_CONTROL_LINE_DTR
276 | MCR_CONTROL_LINE_RTS);
277 control = priv->line_control;
278 spin_unlock_irqrestore(&priv->lock, flags);
279 spcp8x5_set_ctrl_line(port, control);
280 }
281
spcp8x5_init_termios(struct tty_struct * tty)282 static void spcp8x5_init_termios(struct tty_struct *tty)
283 {
284 tty_encode_baud_rate(tty, 115200, 115200);
285 }
286
spcp8x5_set_termios(struct tty_struct * tty,struct usb_serial_port * port,struct ktermios * old_termios)287 static void spcp8x5_set_termios(struct tty_struct *tty,
288 struct usb_serial_port *port, struct ktermios *old_termios)
289 {
290 struct usb_serial *serial = port->serial;
291 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
292 unsigned long flags;
293 unsigned int cflag = tty->termios.c_cflag;
294 unsigned short uartdata;
295 unsigned char buf[2] = {0, 0};
296 int baud;
297 int i;
298 u8 control;
299
300 /* check that they really want us to change something */
301 if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios))
302 return;
303
304 /* set DTR/RTS active */
305 spin_lock_irqsave(&priv->lock, flags);
306 control = priv->line_control;
307 if (old_termios && (old_termios->c_cflag & CBAUD) == B0) {
308 priv->line_control |= MCR_DTR;
309 if (!(old_termios->c_cflag & CRTSCTS))
310 priv->line_control |= MCR_RTS;
311 }
312 if (control != priv->line_control) {
313 control = priv->line_control;
314 spin_unlock_irqrestore(&priv->lock, flags);
315 spcp8x5_set_ctrl_line(port, control);
316 } else {
317 spin_unlock_irqrestore(&priv->lock, flags);
318 }
319
320 /* Set Baud Rate */
321 baud = tty_get_baud_rate(tty);
322 switch (baud) {
323 case 300: buf[0] = 0x00; break;
324 case 600: buf[0] = 0x01; break;
325 case 1200: buf[0] = 0x02; break;
326 case 2400: buf[0] = 0x03; break;
327 case 4800: buf[0] = 0x04; break;
328 case 9600: buf[0] = 0x05; break;
329 case 19200: buf[0] = 0x07; break;
330 case 38400: buf[0] = 0x09; break;
331 case 57600: buf[0] = 0x0a; break;
332 case 115200: buf[0] = 0x0b; break;
333 case 230400: buf[0] = 0x0c; break;
334 case 460800: buf[0] = 0x0d; break;
335 case 921600: buf[0] = 0x0e; break;
336 /* case 1200000: buf[0] = 0x0f; break; */
337 /* case 2400000: buf[0] = 0x10; break; */
338 case 3000000: buf[0] = 0x11; break;
339 /* case 6000000: buf[0] = 0x12; break; */
340 case 0:
341 case 1000000:
342 buf[0] = 0x0b; break;
343 default:
344 dev_err(&port->dev, "unsupported baudrate, using 9600\n");
345 }
346
347 /* Set Data Length : 00:5bit, 01:6bit, 10:7bit, 11:8bit */
348 switch (cflag & CSIZE) {
349 case CS5:
350 buf[1] |= SET_UART_FORMAT_SIZE_5;
351 break;
352 case CS6:
353 buf[1] |= SET_UART_FORMAT_SIZE_6;
354 break;
355 case CS7:
356 buf[1] |= SET_UART_FORMAT_SIZE_7;
357 break;
358 default:
359 case CS8:
360 buf[1] |= SET_UART_FORMAT_SIZE_8;
361 break;
362 }
363
364 /* Set Stop bit2 : 0:1bit 1:2bit */
365 buf[1] |= (cflag & CSTOPB) ? SET_UART_FORMAT_STOP_2 :
366 SET_UART_FORMAT_STOP_1;
367
368 /* Set Parity bit3-4 01:Odd 11:Even */
369 if (cflag & PARENB) {
370 buf[1] |= (cflag & PARODD) ?
371 SET_UART_FORMAT_PAR_ODD : SET_UART_FORMAT_PAR_EVEN ;
372 } else {
373 buf[1] |= SET_UART_FORMAT_PAR_NONE;
374 }
375 uartdata = buf[0] | buf[1]<<8;
376
377 i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
378 SET_UART_FORMAT_TYPE, SET_UART_FORMAT,
379 uartdata, 0, NULL, 0, 100);
380 if (i < 0)
381 dev_err(&port->dev, "Set UART format %#x failed (error = %d)\n",
382 uartdata, i);
383 dev_dbg(&port->dev, "0x21:0x40:0:0 %d\n", i);
384
385 if (cflag & CRTSCTS) {
386 /* enable hardware flow control */
387 spcp8x5_set_work_mode(port, 0x000a, SET_WORKING_MODE_U2C);
388 }
389 }
390
spcp8x5_open(struct tty_struct * tty,struct usb_serial_port * port)391 static int spcp8x5_open(struct tty_struct *tty, struct usb_serial_port *port)
392 {
393 struct usb_serial *serial = port->serial;
394 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
395 int ret;
396
397 usb_clear_halt(serial->dev, port->write_urb->pipe);
398 usb_clear_halt(serial->dev, port->read_urb->pipe);
399
400 ret = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
401 0x09, 0x00,
402 0x01, 0x00, NULL, 0x00, 100);
403 if (ret)
404 return ret;
405
406 spcp8x5_set_ctrl_line(port, priv->line_control);
407
408 if (tty)
409 spcp8x5_set_termios(tty, port, NULL);
410
411 return usb_serial_generic_open(tty, port);
412 }
413
spcp8x5_tiocmset(struct tty_struct * tty,unsigned int set,unsigned int clear)414 static int spcp8x5_tiocmset(struct tty_struct *tty,
415 unsigned int set, unsigned int clear)
416 {
417 struct usb_serial_port *port = tty->driver_data;
418 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
419 unsigned long flags;
420 u8 control;
421
422 spin_lock_irqsave(&priv->lock, flags);
423 if (set & TIOCM_RTS)
424 priv->line_control |= MCR_RTS;
425 if (set & TIOCM_DTR)
426 priv->line_control |= MCR_DTR;
427 if (clear & TIOCM_RTS)
428 priv->line_control &= ~MCR_RTS;
429 if (clear & TIOCM_DTR)
430 priv->line_control &= ~MCR_DTR;
431 control = priv->line_control;
432 spin_unlock_irqrestore(&priv->lock, flags);
433
434 return spcp8x5_set_ctrl_line(port, control);
435 }
436
spcp8x5_tiocmget(struct tty_struct * tty)437 static int spcp8x5_tiocmget(struct tty_struct *tty)
438 {
439 struct usb_serial_port *port = tty->driver_data;
440 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
441 unsigned long flags;
442 unsigned int mcr;
443 u8 status;
444 unsigned int result;
445
446 result = spcp8x5_get_msr(port, &status);
447 if (result)
448 return result;
449
450 spin_lock_irqsave(&priv->lock, flags);
451 mcr = priv->line_control;
452 spin_unlock_irqrestore(&priv->lock, flags);
453
454 result = ((mcr & MCR_DTR) ? TIOCM_DTR : 0)
455 | ((mcr & MCR_RTS) ? TIOCM_RTS : 0)
456 | ((status & MSR_STATUS_LINE_CTS) ? TIOCM_CTS : 0)
457 | ((status & MSR_STATUS_LINE_DSR) ? TIOCM_DSR : 0)
458 | ((status & MSR_STATUS_LINE_RI) ? TIOCM_RI : 0)
459 | ((status & MSR_STATUS_LINE_DCD) ? TIOCM_CD : 0);
460
461 return result;
462 }
463
464 static struct usb_serial_driver spcp8x5_device = {
465 .driver = {
466 .owner = THIS_MODULE,
467 .name = "SPCP8x5",
468 },
469 .id_table = id_table,
470 .num_ports = 1,
471 .num_bulk_in = 1,
472 .num_bulk_out = 1,
473 .open = spcp8x5_open,
474 .dtr_rts = spcp8x5_dtr_rts,
475 .carrier_raised = spcp8x5_carrier_raised,
476 .set_termios = spcp8x5_set_termios,
477 .init_termios = spcp8x5_init_termios,
478 .tiocmget = spcp8x5_tiocmget,
479 .tiocmset = spcp8x5_tiocmset,
480 .probe = spcp8x5_probe,
481 .port_probe = spcp8x5_port_probe,
482 .port_remove = spcp8x5_port_remove,
483 };
484
485 static struct usb_serial_driver * const serial_drivers[] = {
486 &spcp8x5_device, NULL
487 };
488
489 module_usb_serial_driver(serial_drivers, id_table);
490
491 MODULE_DESCRIPTION(DRIVER_DESC);
492 MODULE_LICENSE("GPL");
493
