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