1
2
3
4
5
6
7
8
9
10
11
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
40static 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 { }
49};
50MODULE_DEVICE_TABLE(usb, id_table);
51
52struct 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
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
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
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
139struct spcp8x5_private {
140 unsigned quirks;
141 spinlock_t lock;
142 u8 line_control;
143};
144
145static 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
153static 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
172static void 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
180static int spcp8x5_set_ctrl_line(struct usb_serial_port *port, u8 mcr)
181{
182 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
183 struct usb_device *dev = port->serial->dev;
184 int retval;
185
186 if (priv->quirks & SPCP825_QUIRK_NO_UART_STATUS)
187 return -EPERM;
188
189 retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
190 SET_UART_STATUS_TYPE, SET_UART_STATUS,
191 mcr, 0x04, NULL, 0, 100);
192 if (retval != 0) {
193 dev_err(&port->dev, "failed to set control lines: %d\n",
194 retval);
195 }
196 return retval;
197}
198
199static int spcp8x5_get_msr(struct usb_serial_port *port, u8 *status)
200{
201 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
202 struct usb_device *dev = port->serial->dev;
203 u8 *buf;
204 int ret;
205
206 if (priv->quirks & SPCP825_QUIRK_NO_UART_STATUS)
207 return -EPERM;
208
209 buf = kzalloc(1, GFP_KERNEL);
210 if (!buf)
211 return -ENOMEM;
212
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);
216 if (ret < 1) {
217 dev_err(&port->dev, "failed to get modem status: %d\n", ret);
218 if (ret >= 0)
219 ret = -EIO;
220 goto out;
221 }
222
223 dev_dbg(&port->dev, "0xc0:0x22:0:6 %d - 0x02%x\n", ret, *buf);
224 *status = *buf;
225 ret = 0;
226out:
227 kfree(buf);
228
229 return ret;
230}
231
232static void spcp8x5_set_work_mode(struct usb_serial_port *port, u16 value,
233 u16 index)
234{
235 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
236 struct usb_device *dev = port->serial->dev;
237 int ret;
238
239 if (priv->quirks & SPCP825_QUIRK_NO_WORK_MODE)
240 return;
241
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);
246 if (ret < 0)
247 dev_err(&port->dev, "failed to set work mode: %d\n", ret);
248}
249
250static int spcp8x5_carrier_raised(struct usb_serial_port *port)
251{
252 u8 msr;
253 int ret;
254
255 ret = spcp8x5_get_msr(port, &msr);
256 if (ret || msr & MSR_STATUS_LINE_DCD)
257 return 1;
258
259 return 0;
260}
261
262static void spcp8x5_dtr_rts(struct usb_serial_port *port, int on)
263{
264 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
265 unsigned long flags;
266 u8 control;
267
268 spin_lock_irqsave(&priv->lock, flags);
269 if (on)
270 priv->line_control = MCR_CONTROL_LINE_DTR
271 | MCR_CONTROL_LINE_RTS;
272 else
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);
278}
279
280static void spcp8x5_init_termios(struct tty_struct *tty)
281{
282 tty_encode_baud_rate(tty, 115200, 115200);
283}
284
285static void spcp8x5_set_termios(struct tty_struct *tty,
286 struct usb_serial_port *port, struct ktermios *old_termios)
287{
288 struct usb_serial *serial = port->serial;
289 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
290 unsigned long flags;
291 unsigned int cflag = tty->termios.c_cflag;
292 unsigned short uartdata;
293 unsigned char buf[2] = {0, 0};
294 int baud;
295 int i;
296 u8 control;
297
298
299 if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios))
300 return;
301
302
303 spin_lock_irqsave(&priv->lock, flags);
304 control = priv->line_control;
305 if (old_termios && (old_termios->c_cflag & CBAUD) == B0) {
306 priv->line_control |= MCR_DTR;
307 if (!(old_termios->c_cflag & CRTSCTS))
308 priv->line_control |= MCR_RTS;
309 }
310 if (control != priv->line_control) {
311 control = priv->line_control;
312 spin_unlock_irqrestore(&priv->lock, flags);
313 spcp8x5_set_ctrl_line(port, control);
314 } else {
315 spin_unlock_irqrestore(&priv->lock, flags);
316 }
317
318
319 baud = tty_get_baud_rate(tty);
320 switch (baud) {
321 case 300: buf[0] = 0x00; break;
322 case 600: buf[0] = 0x01; break;
323 case 1200: buf[0] = 0x02; break;
324 case 2400: buf[0] = 0x03; break;
325 case 4800: buf[0] = 0x04; break;
326 case 9600: buf[0] = 0x05; break;
327 case 19200: buf[0] = 0x07; break;
328 case 38400: buf[0] = 0x09; break;
329 case 57600: buf[0] = 0x0a; break;
330 case 115200: buf[0] = 0x0b; break;
331 case 230400: buf[0] = 0x0c; break;
332 case 460800: buf[0] = 0x0d; break;
333 case 921600: buf[0] = 0x0e; break;
334
335
336 case 3000000: buf[0] = 0x11; break;
337
338 case 0:
339 case 1000000:
340 buf[0] = 0x0b; break;
341 default:
342 dev_err(&port->dev, "unsupported baudrate, using 9600\n");
343 }
344
345
346 switch (cflag & CSIZE) {
347 case CS5:
348 buf[1] |= SET_UART_FORMAT_SIZE_5;
349 break;
350 case CS6:
351 buf[1] |= SET_UART_FORMAT_SIZE_6;
352 break;
353 case CS7:
354 buf[1] |= SET_UART_FORMAT_SIZE_7;
355 break;
356 default:
357 case CS8:
358 buf[1] |= SET_UART_FORMAT_SIZE_8;
359 break;
360 }
361
362
363 buf[1] |= (cflag & CSTOPB) ? SET_UART_FORMAT_STOP_2 :
364 SET_UART_FORMAT_STOP_1;
365
366
367 if (cflag & PARENB) {
368 buf[1] |= (cflag & PARODD) ?
369 SET_UART_FORMAT_PAR_ODD : SET_UART_FORMAT_PAR_EVEN ;
370 } else {
371 buf[1] |= SET_UART_FORMAT_PAR_NONE;
372 }
373 uartdata = buf[0] | buf[1]<<8;
374
375 i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
376 SET_UART_FORMAT_TYPE, SET_UART_FORMAT,
377 uartdata, 0, NULL, 0, 100);
378 if (i < 0)
379 dev_err(&port->dev, "Set UART format %#x failed (error = %d)\n",
380 uartdata, i);
381 dev_dbg(&port->dev, "0x21:0x40:0:0 %d\n", i);
382
383 if (cflag & CRTSCTS) {
384
385 spcp8x5_set_work_mode(port, 0x000a, SET_WORKING_MODE_U2C);
386 }
387}
388
389static int spcp8x5_open(struct tty_struct *tty, struct usb_serial_port *port)
390{
391 struct usb_serial *serial = port->serial;
392 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
393 int ret;
394
395 usb_clear_halt(serial->dev, port->write_urb->pipe);
396 usb_clear_halt(serial->dev, port->read_urb->pipe);
397
398 ret = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
399 0x09, 0x00,
400 0x01, 0x00, NULL, 0x00, 100);
401 if (ret)
402 return ret;
403
404 spcp8x5_set_ctrl_line(port, priv->line_control);
405
406 if (tty)
407 spcp8x5_set_termios(tty, port, NULL);
408
409 return usb_serial_generic_open(tty, port);
410}
411
412static int spcp8x5_tiocmset(struct tty_struct *tty,
413 unsigned int set, unsigned int clear)
414{
415 struct usb_serial_port *port = tty->driver_data;
416 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
417 unsigned long flags;
418 u8 control;
419
420 spin_lock_irqsave(&priv->lock, flags);
421 if (set & TIOCM_RTS)
422 priv->line_control |= MCR_RTS;
423 if (set & TIOCM_DTR)
424 priv->line_control |= MCR_DTR;
425 if (clear & TIOCM_RTS)
426 priv->line_control &= ~MCR_RTS;
427 if (clear & TIOCM_DTR)
428 priv->line_control &= ~MCR_DTR;
429 control = priv->line_control;
430 spin_unlock_irqrestore(&priv->lock, flags);
431
432 return spcp8x5_set_ctrl_line(port, control);
433}
434
435static int spcp8x5_tiocmget(struct tty_struct *tty)
436{
437 struct usb_serial_port *port = tty->driver_data;
438 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
439 unsigned long flags;
440 unsigned int mcr;
441 u8 status;
442 unsigned int result;
443
444 result = spcp8x5_get_msr(port, &status);
445 if (result)
446 return result;
447
448 spin_lock_irqsave(&priv->lock, flags);
449 mcr = priv->line_control;
450 spin_unlock_irqrestore(&priv->lock, flags);
451
452 result = ((mcr & MCR_DTR) ? TIOCM_DTR : 0)
453 | ((mcr & MCR_RTS) ? TIOCM_RTS : 0)
454 | ((status & MSR_STATUS_LINE_CTS) ? TIOCM_CTS : 0)
455 | ((status & MSR_STATUS_LINE_DSR) ? TIOCM_DSR : 0)
456 | ((status & MSR_STATUS_LINE_RI) ? TIOCM_RI : 0)
457 | ((status & MSR_STATUS_LINE_DCD) ? TIOCM_CD : 0);
458
459 return result;
460}
461
462static struct usb_serial_driver spcp8x5_device = {
463 .driver = {
464 .owner = THIS_MODULE,
465 .name = "SPCP8x5",
466 },
467 .id_table = id_table,
468 .num_ports = 1,
469 .num_bulk_in = 1,
470 .num_bulk_out = 1,
471 .open = spcp8x5_open,
472 .dtr_rts = spcp8x5_dtr_rts,
473 .carrier_raised = spcp8x5_carrier_raised,
474 .set_termios = spcp8x5_set_termios,
475 .init_termios = spcp8x5_init_termios,
476 .tiocmget = spcp8x5_tiocmget,
477 .tiocmset = spcp8x5_tiocmset,
478 .probe = spcp8x5_probe,
479 .port_probe = spcp8x5_port_probe,
480 .port_remove = spcp8x5_port_remove,
481};
482
483static struct usb_serial_driver * const serial_drivers[] = {
484 &spcp8x5_device, NULL
485};
486
487module_usb_serial_driver(serial_drivers, id_table);
488
489MODULE_DESCRIPTION(DRIVER_DESC);
490MODULE_LICENSE("GPL");
491
