Loading...
1/*
2 * spcp8x5 USB to serial adaptor driver
3 *
4 * Copyright (C) 2010 Johan Hovold (jhovold@gmail.com)
5 * Copyright (C) 2006 Linxb (xubin.lin@worldplus.com.cn)
6 * Copyright (C) 2006 S1 Corp.
7 *
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>
11 *
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.
16 *
17 *
18 */
19#include <linux/kernel.h>
20#include <linux/errno.h>
21#include <linux/init.h>
22#include <linux/slab.h>
23#include <linux/tty.h>
24#include <linux/tty_driver.h>
25#include <linux/tty_flip.h>
26#include <linux/module.h>
27#include <linux/spinlock.h>
28#include <linux/usb.h>
29#include <linux/usb/serial.h>
30
31
32/* Version Information */
33#define DRIVER_VERSION "v0.10"
34#define DRIVER_DESC "SPCP8x5 USB to serial adaptor driver"
35
36static int debug;
37
38#define SPCP8x5_007_VID 0x04FC
39#define SPCP8x5_007_PID 0x0201
40#define SPCP8x5_008_VID 0x04fc
41#define SPCP8x5_008_PID 0x0235
42#define SPCP8x5_PHILIPS_VID 0x0471
43#define SPCP8x5_PHILIPS_PID 0x081e
44#define SPCP8x5_INTERMATIC_VID 0x04FC
45#define SPCP8x5_INTERMATIC_PID 0x0204
46#define SPCP8x5_835_VID 0x04fc
47#define SPCP8x5_835_PID 0x0231
48
49static const struct usb_device_id id_table[] = {
50 { USB_DEVICE(SPCP8x5_PHILIPS_VID , SPCP8x5_PHILIPS_PID)},
51 { USB_DEVICE(SPCP8x5_INTERMATIC_VID, SPCP8x5_INTERMATIC_PID)},
52 { USB_DEVICE(SPCP8x5_835_VID, SPCP8x5_835_PID)},
53 { USB_DEVICE(SPCP8x5_008_VID, SPCP8x5_008_PID)},
54 { USB_DEVICE(SPCP8x5_007_VID, SPCP8x5_007_PID)},
55 { } /* Terminating entry */
56};
57MODULE_DEVICE_TABLE(usb, id_table);
58
59struct spcp8x5_usb_ctrl_arg {
60 u8 type;
61 u8 cmd;
62 u8 cmd_type;
63 u16 value;
64 u16 index;
65 u16 length;
66};
67
68
69/* spcp8x5 spec register define */
70#define MCR_CONTROL_LINE_RTS 0x02
71#define MCR_CONTROL_LINE_DTR 0x01
72#define MCR_DTR 0x01
73#define MCR_RTS 0x02
74
75#define MSR_STATUS_LINE_DCD 0x80
76#define MSR_STATUS_LINE_RI 0x40
77#define MSR_STATUS_LINE_DSR 0x20
78#define MSR_STATUS_LINE_CTS 0x10
79
80/* verdor command here , we should define myself */
81#define SET_DEFAULT 0x40
82#define SET_DEFAULT_TYPE 0x20
83
84#define SET_UART_FORMAT 0x40
85#define SET_UART_FORMAT_TYPE 0x21
86#define SET_UART_FORMAT_SIZE_5 0x00
87#define SET_UART_FORMAT_SIZE_6 0x01
88#define SET_UART_FORMAT_SIZE_7 0x02
89#define SET_UART_FORMAT_SIZE_8 0x03
90#define SET_UART_FORMAT_STOP_1 0x00
91#define SET_UART_FORMAT_STOP_2 0x04
92#define SET_UART_FORMAT_PAR_NONE 0x00
93#define SET_UART_FORMAT_PAR_ODD 0x10
94#define SET_UART_FORMAT_PAR_EVEN 0x30
95#define SET_UART_FORMAT_PAR_MASK 0xD0
96#define SET_UART_FORMAT_PAR_SPACE 0x90
97
98#define GET_UART_STATUS_TYPE 0xc0
99#define GET_UART_STATUS 0x22
100#define GET_UART_STATUS_MSR 0x06
101
102#define SET_UART_STATUS 0x40
103#define SET_UART_STATUS_TYPE 0x23
104#define SET_UART_STATUS_MCR 0x0004
105#define SET_UART_STATUS_MCR_DTR 0x01
106#define SET_UART_STATUS_MCR_RTS 0x02
107#define SET_UART_STATUS_MCR_LOOP 0x10
108
109#define SET_WORKING_MODE 0x40
110#define SET_WORKING_MODE_TYPE 0x24
111#define SET_WORKING_MODE_U2C 0x00
112#define SET_WORKING_MODE_RS485 0x01
113#define SET_WORKING_MODE_PDMA 0x02
114#define SET_WORKING_MODE_SPP 0x03
115
116#define SET_FLOWCTL_CHAR 0x40
117#define SET_FLOWCTL_CHAR_TYPE 0x25
118
119#define GET_VERSION 0xc0
120#define GET_VERSION_TYPE 0x26
121
122#define SET_REGISTER 0x40
123#define SET_REGISTER_TYPE 0x27
124
125#define GET_REGISTER 0xc0
126#define GET_REGISTER_TYPE 0x28
127
128#define SET_RAM 0x40
129#define SET_RAM_TYPE 0x31
130
131#define GET_RAM 0xc0
132#define GET_RAM_TYPE 0x32
133
134/* how come ??? */
135#define UART_STATE 0x08
136#define UART_STATE_TRANSIENT_MASK 0x75
137#define UART_DCD 0x01
138#define UART_DSR 0x02
139#define UART_BREAK_ERROR 0x04
140#define UART_RING 0x08
141#define UART_FRAME_ERROR 0x10
142#define UART_PARITY_ERROR 0x20
143#define UART_OVERRUN_ERROR 0x40
144#define UART_CTS 0x80
145
146enum spcp8x5_type {
147 SPCP825_007_TYPE,
148 SPCP825_008_TYPE,
149 SPCP825_PHILIP_TYPE,
150 SPCP825_INTERMATIC_TYPE,
151 SPCP835_TYPE,
152};
153
154static struct usb_driver spcp8x5_driver = {
155 .name = "spcp8x5",
156 .probe = usb_serial_probe,
157 .disconnect = usb_serial_disconnect,
158 .id_table = id_table,
159 .no_dynamic_id = 1,
160};
161
162
163struct spcp8x5_private {
164 spinlock_t lock;
165 enum spcp8x5_type type;
166 wait_queue_head_t delta_msr_wait;
167 u8 line_control;
168 u8 line_status;
169};
170
171/* desc : when device plug in,this function would be called.
172 * thanks to usb_serial subsystem,then do almost every things for us. And what
173 * we should do just alloc the buffer */
174static int spcp8x5_startup(struct usb_serial *serial)
175{
176 struct spcp8x5_private *priv;
177 int i;
178 enum spcp8x5_type type = SPCP825_007_TYPE;
179 u16 product = le16_to_cpu(serial->dev->descriptor.idProduct);
180
181 if (product == 0x0201)
182 type = SPCP825_007_TYPE;
183 else if (product == 0x0231)
184 type = SPCP835_TYPE;
185 else if (product == 0x0235)
186 type = SPCP825_008_TYPE;
187 else if (product == 0x0204)
188 type = SPCP825_INTERMATIC_TYPE;
189 else if (product == 0x0471 &&
190 serial->dev->descriptor.idVendor == cpu_to_le16(0x081e))
191 type = SPCP825_PHILIP_TYPE;
192 dev_dbg(&serial->dev->dev, "device type = %d\n", (int)type);
193
194 for (i = 0; i < serial->num_ports; ++i) {
195 priv = kzalloc(sizeof(struct spcp8x5_private), GFP_KERNEL);
196 if (!priv)
197 goto cleanup;
198
199 spin_lock_init(&priv->lock);
200 init_waitqueue_head(&priv->delta_msr_wait);
201 priv->type = type;
202 usb_set_serial_port_data(serial->port[i] , priv);
203 }
204
205 return 0;
206cleanup:
207 for (--i; i >= 0; --i) {
208 priv = usb_get_serial_port_data(serial->port[i]);
209 kfree(priv);
210 usb_set_serial_port_data(serial->port[i] , NULL);
211 }
212 return -ENOMEM;
213}
214
215/* call when the device plug out. free all the memory alloced by probe */
216static void spcp8x5_release(struct usb_serial *serial)
217{
218 int i;
219
220 for (i = 0; i < serial->num_ports; i++)
221 kfree(usb_get_serial_port_data(serial->port[i]));
222}
223
224/* set the modem control line of the device.
225 * NOTE spcp825-007 not supported this */
226static int spcp8x5_set_ctrlLine(struct usb_device *dev, u8 value,
227 enum spcp8x5_type type)
228{
229 int retval;
230 u8 mcr = 0 ;
231
232 if (type == SPCP825_007_TYPE)
233 return -EPERM;
234
235 mcr = (unsigned short)value;
236 retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
237 SET_UART_STATUS_TYPE, SET_UART_STATUS,
238 mcr, 0x04, NULL, 0, 100);
239 if (retval != 0)
240 dev_dbg(&dev->dev, "usb_control_msg return %#x\n", retval);
241 return retval;
242}
243
244/* get the modem status register of the device
245 * NOTE spcp825-007 not supported this */
246static int spcp8x5_get_msr(struct usb_device *dev, u8 *status,
247 enum spcp8x5_type type)
248{
249 u8 *status_buffer;
250 int ret;
251
252 /* I return Permited not support here but seem inval device
253 * is more fix */
254 if (type == SPCP825_007_TYPE)
255 return -EPERM;
256 if (status == NULL)
257 return -EINVAL;
258
259 status_buffer = kmalloc(1, GFP_KERNEL);
260 if (!status_buffer)
261 return -ENOMEM;
262 status_buffer[0] = status[0];
263
264 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
265 GET_UART_STATUS, GET_UART_STATUS_TYPE,
266 0, GET_UART_STATUS_MSR, status_buffer, 1, 100);
267 if (ret < 0)
268 dev_dbg(&dev->dev, "Get MSR = 0x%p failed (error = %d)",
269 status_buffer, ret);
270
271 dev_dbg(&dev->dev, "0xc0:0x22:0:6 %d - 0x%p ", ret, status_buffer);
272 status[0] = status_buffer[0];
273 kfree(status_buffer);
274
275 return ret;
276}
277
278/* select the work mode.
279 * NOTE this function not supported by spcp825-007 */
280static void spcp8x5_set_workMode(struct usb_device *dev, u16 value,
281 u16 index, enum spcp8x5_type type)
282{
283 int ret;
284
285 /* I return Permited not support here but seem inval device
286 * is more fix */
287 if (type == SPCP825_007_TYPE)
288 return;
289
290 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
291 SET_WORKING_MODE_TYPE, SET_WORKING_MODE,
292 value, index, NULL, 0, 100);
293 dev_dbg(&dev->dev, "value = %#x , index = %#x\n", value, index);
294 if (ret < 0)
295 dev_dbg(&dev->dev,
296 "RTSCTS usb_control_msg(enable flowctrl) = %d\n", ret);
297}
298
299static int spcp8x5_carrier_raised(struct usb_serial_port *port)
300{
301 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
302 if (priv->line_status & MSR_STATUS_LINE_DCD)
303 return 1;
304 return 0;
305}
306
307static void spcp8x5_dtr_rts(struct usb_serial_port *port, int on)
308{
309 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
310 unsigned long flags;
311 u8 control;
312
313 spin_lock_irqsave(&priv->lock, flags);
314 if (on)
315 priv->line_control = MCR_CONTROL_LINE_DTR
316 | MCR_CONTROL_LINE_RTS;
317 else
318 priv->line_control &= ~ (MCR_CONTROL_LINE_DTR
319 | MCR_CONTROL_LINE_RTS);
320 control = priv->line_control;
321 spin_unlock_irqrestore(&priv->lock, flags);
322 spcp8x5_set_ctrlLine(port->serial->dev, control , priv->type);
323}
324
325static void spcp8x5_init_termios(struct tty_struct *tty)
326{
327 /* for the 1st time call this function */
328 *(tty->termios) = tty_std_termios;
329 tty->termios->c_cflag = B115200 | CS8 | CREAD | HUPCL | CLOCAL;
330 tty->termios->c_ispeed = 115200;
331 tty->termios->c_ospeed = 115200;
332}
333
334/* set the serial param for transfer. we should check if we really need to
335 * transfer. if we set flow control we should do this too. */
336static void spcp8x5_set_termios(struct tty_struct *tty,
337 struct usb_serial_port *port, struct ktermios *old_termios)
338{
339 struct usb_serial *serial = port->serial;
340 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
341 unsigned long flags;
342 unsigned int cflag = tty->termios->c_cflag;
343 unsigned int old_cflag = old_termios->c_cflag;
344 unsigned short uartdata;
345 unsigned char buf[2] = {0, 0};
346 int baud;
347 int i;
348 u8 control;
349
350
351 /* check that they really want us to change something */
352 if (!tty_termios_hw_change(tty->termios, old_termios))
353 return;
354
355 /* set DTR/RTS active */
356 spin_lock_irqsave(&priv->lock, flags);
357 control = priv->line_control;
358 if ((old_cflag & CBAUD) == B0) {
359 priv->line_control |= MCR_DTR;
360 if (!(old_cflag & CRTSCTS))
361 priv->line_control |= MCR_RTS;
362 }
363 if (control != priv->line_control) {
364 control = priv->line_control;
365 spin_unlock_irqrestore(&priv->lock, flags);
366 spcp8x5_set_ctrlLine(serial->dev, control , priv->type);
367 } else {
368 spin_unlock_irqrestore(&priv->lock, flags);
369 }
370
371 /* Set Baud Rate */
372 baud = tty_get_baud_rate(tty);
373 switch (baud) {
374 case 300: buf[0] = 0x00; break;
375 case 600: buf[0] = 0x01; break;
376 case 1200: buf[0] = 0x02; break;
377 case 2400: buf[0] = 0x03; break;
378 case 4800: buf[0] = 0x04; break;
379 case 9600: buf[0] = 0x05; break;
380 case 19200: buf[0] = 0x07; break;
381 case 38400: buf[0] = 0x09; break;
382 case 57600: buf[0] = 0x0a; break;
383 case 115200: buf[0] = 0x0b; break;
384 case 230400: buf[0] = 0x0c; break;
385 case 460800: buf[0] = 0x0d; break;
386 case 921600: buf[0] = 0x0e; break;
387/* case 1200000: buf[0] = 0x0f; break; */
388/* case 2400000: buf[0] = 0x10; break; */
389 case 3000000: buf[0] = 0x11; break;
390/* case 6000000: buf[0] = 0x12; break; */
391 case 0:
392 case 1000000:
393 buf[0] = 0x0b; break;
394 default:
395 dev_err(&port->dev, "spcp825 driver does not support the "
396 "baudrate requested, using default of 9600.\n");
397 }
398
399 /* Set Data Length : 00:5bit, 01:6bit, 10:7bit, 11:8bit */
400 if (cflag & CSIZE) {
401 switch (cflag & CSIZE) {
402 case CS5:
403 buf[1] |= SET_UART_FORMAT_SIZE_5;
404 break;
405 case CS6:
406 buf[1] |= SET_UART_FORMAT_SIZE_6;
407 break;
408 case CS7:
409 buf[1] |= SET_UART_FORMAT_SIZE_7;
410 break;
411 default:
412 case CS8:
413 buf[1] |= SET_UART_FORMAT_SIZE_8;
414 break;
415 }
416 }
417
418 /* Set Stop bit2 : 0:1bit 1:2bit */
419 buf[1] |= (cflag & CSTOPB) ? SET_UART_FORMAT_STOP_2 :
420 SET_UART_FORMAT_STOP_1;
421
422 /* Set Parity bit3-4 01:Odd 11:Even */
423 if (cflag & PARENB) {
424 buf[1] |= (cflag & PARODD) ?
425 SET_UART_FORMAT_PAR_ODD : SET_UART_FORMAT_PAR_EVEN ;
426 } else
427 buf[1] |= SET_UART_FORMAT_PAR_NONE;
428
429 uartdata = buf[0] | buf[1]<<8;
430
431 i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
432 SET_UART_FORMAT_TYPE, SET_UART_FORMAT,
433 uartdata, 0, NULL, 0, 100);
434 if (i < 0)
435 dev_err(&port->dev, "Set UART format %#x failed (error = %d)\n",
436 uartdata, i);
437 dbg("0x21:0x40:0:0 %d", i);
438
439 if (cflag & CRTSCTS) {
440 /* enable hardware flow control */
441 spcp8x5_set_workMode(serial->dev, 0x000a,
442 SET_WORKING_MODE_U2C, priv->type);
443 }
444}
445
446/* open the serial port. do some usb system call. set termios and get the line
447 * status of the device. */
448static int spcp8x5_open(struct tty_struct *tty, struct usb_serial_port *port)
449{
450 struct ktermios tmp_termios;
451 struct usb_serial *serial = port->serial;
452 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
453 int ret;
454 unsigned long flags;
455 u8 status = 0x30;
456 /* status 0x30 means DSR and CTS = 1 other CDC RI and delta = 0 */
457
458 dbg("%s - port %d", __func__, port->number);
459
460 usb_clear_halt(serial->dev, port->write_urb->pipe);
461 usb_clear_halt(serial->dev, port->read_urb->pipe);
462
463 ret = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
464 0x09, 0x00,
465 0x01, 0x00, NULL, 0x00, 100);
466 if (ret)
467 return ret;
468
469 spcp8x5_set_ctrlLine(serial->dev, priv->line_control , priv->type);
470
471 /* Setup termios */
472 if (tty)
473 spcp8x5_set_termios(tty, port, &tmp_termios);
474
475 spcp8x5_get_msr(serial->dev, &status, priv->type);
476
477 /* may be we should update uart status here but now we did not do */
478 spin_lock_irqsave(&priv->lock, flags);
479 priv->line_status = status & 0xf0 ;
480 spin_unlock_irqrestore(&priv->lock, flags);
481
482 port->port.drain_delay = 256;
483
484 return usb_serial_generic_open(tty, port);
485}
486
487static void spcp8x5_process_read_urb(struct urb *urb)
488{
489 struct usb_serial_port *port = urb->context;
490 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
491 struct tty_struct *tty;
492 unsigned char *data = urb->transfer_buffer;
493 unsigned long flags;
494 u8 status;
495 char tty_flag;
496
497 /* get tty_flag from status */
498 tty_flag = TTY_NORMAL;
499
500 spin_lock_irqsave(&priv->lock, flags);
501 status = priv->line_status;
502 priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
503 spin_unlock_irqrestore(&priv->lock, flags);
504 /* wake up the wait for termios */
505 wake_up_interruptible(&priv->delta_msr_wait);
506
507 if (!urb->actual_length)
508 return;
509
510 tty = tty_port_tty_get(&port->port);
511 if (!tty)
512 return;
513
514 if (status & UART_STATE_TRANSIENT_MASK) {
515 /* break takes precedence over parity, which takes precedence
516 * over framing errors */
517 if (status & UART_BREAK_ERROR)
518 tty_flag = TTY_BREAK;
519 else if (status & UART_PARITY_ERROR)
520 tty_flag = TTY_PARITY;
521 else if (status & UART_FRAME_ERROR)
522 tty_flag = TTY_FRAME;
523 dev_dbg(&port->dev, "tty_flag = %d\n", tty_flag);
524
525 /* overrun is special, not associated with a char */
526 if (status & UART_OVERRUN_ERROR)
527 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
528
529 if (status & UART_DCD)
530 usb_serial_handle_dcd_change(port, tty,
531 priv->line_status & MSR_STATUS_LINE_DCD);
532 }
533
534 tty_insert_flip_string_fixed_flag(tty, data, tty_flag,
535 urb->actual_length);
536 tty_flip_buffer_push(tty);
537 tty_kref_put(tty);
538}
539
540static int spcp8x5_wait_modem_info(struct usb_serial_port *port,
541 unsigned int arg)
542{
543 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
544 unsigned long flags;
545 unsigned int prevstatus;
546 unsigned int status;
547 unsigned int changed;
548
549 spin_lock_irqsave(&priv->lock, flags);
550 prevstatus = priv->line_status;
551 spin_unlock_irqrestore(&priv->lock, flags);
552
553 while (1) {
554 /* wake up in bulk read */
555 interruptible_sleep_on(&priv->delta_msr_wait);
556
557 /* see if a signal did it */
558 if (signal_pending(current))
559 return -ERESTARTSYS;
560
561 spin_lock_irqsave(&priv->lock, flags);
562 status = priv->line_status;
563 spin_unlock_irqrestore(&priv->lock, flags);
564
565 changed = prevstatus^status;
566
567 if (((arg & TIOCM_RNG) && (changed & MSR_STATUS_LINE_RI)) ||
568 ((arg & TIOCM_DSR) && (changed & MSR_STATUS_LINE_DSR)) ||
569 ((arg & TIOCM_CD) && (changed & MSR_STATUS_LINE_DCD)) ||
570 ((arg & TIOCM_CTS) && (changed & MSR_STATUS_LINE_CTS)))
571 return 0;
572
573 prevstatus = status;
574 }
575 /* NOTREACHED */
576 return 0;
577}
578
579static int spcp8x5_ioctl(struct tty_struct *tty,
580 unsigned int cmd, unsigned long arg)
581{
582 struct usb_serial_port *port = tty->driver_data;
583 dbg("%s (%d) cmd = 0x%04x", __func__, port->number, cmd);
584
585 switch (cmd) {
586 case TIOCMIWAIT:
587 dbg("%s (%d) TIOCMIWAIT", __func__, port->number);
588 return spcp8x5_wait_modem_info(port, arg);
589
590 default:
591 dbg("%s not supported = 0x%04x", __func__, cmd);
592 break;
593 }
594
595 return -ENOIOCTLCMD;
596}
597
598static int spcp8x5_tiocmset(struct tty_struct *tty,
599 unsigned int set, unsigned int clear)
600{
601 struct usb_serial_port *port = tty->driver_data;
602 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
603 unsigned long flags;
604 u8 control;
605
606 spin_lock_irqsave(&priv->lock, flags);
607 if (set & TIOCM_RTS)
608 priv->line_control |= MCR_RTS;
609 if (set & TIOCM_DTR)
610 priv->line_control |= MCR_DTR;
611 if (clear & TIOCM_RTS)
612 priv->line_control &= ~MCR_RTS;
613 if (clear & TIOCM_DTR)
614 priv->line_control &= ~MCR_DTR;
615 control = priv->line_control;
616 spin_unlock_irqrestore(&priv->lock, flags);
617
618 return spcp8x5_set_ctrlLine(port->serial->dev, control , priv->type);
619}
620
621static int spcp8x5_tiocmget(struct tty_struct *tty)
622{
623 struct usb_serial_port *port = tty->driver_data;
624 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
625 unsigned long flags;
626 unsigned int mcr;
627 unsigned int status;
628 unsigned int result;
629
630 spin_lock_irqsave(&priv->lock, flags);
631 mcr = priv->line_control;
632 status = priv->line_status;
633 spin_unlock_irqrestore(&priv->lock, flags);
634
635 result = ((mcr & MCR_DTR) ? TIOCM_DTR : 0)
636 | ((mcr & MCR_RTS) ? TIOCM_RTS : 0)
637 | ((status & MSR_STATUS_LINE_CTS) ? TIOCM_CTS : 0)
638 | ((status & MSR_STATUS_LINE_DSR) ? TIOCM_DSR : 0)
639 | ((status & MSR_STATUS_LINE_RI) ? TIOCM_RI : 0)
640 | ((status & MSR_STATUS_LINE_DCD) ? TIOCM_CD : 0);
641
642 return result;
643}
644
645/* All of the device info needed for the spcp8x5 SIO serial converter */
646static struct usb_serial_driver spcp8x5_device = {
647 .driver = {
648 .owner = THIS_MODULE,
649 .name = "SPCP8x5",
650 },
651 .id_table = id_table,
652 .usb_driver = &spcp8x5_driver,
653 .num_ports = 1,
654 .open = spcp8x5_open,
655 .dtr_rts = spcp8x5_dtr_rts,
656 .carrier_raised = spcp8x5_carrier_raised,
657 .set_termios = spcp8x5_set_termios,
658 .init_termios = spcp8x5_init_termios,
659 .ioctl = spcp8x5_ioctl,
660 .tiocmget = spcp8x5_tiocmget,
661 .tiocmset = spcp8x5_tiocmset,
662 .attach = spcp8x5_startup,
663 .release = spcp8x5_release,
664 .process_read_urb = spcp8x5_process_read_urb,
665};
666
667static int __init spcp8x5_init(void)
668{
669 int retval;
670 retval = usb_serial_register(&spcp8x5_device);
671 if (retval)
672 goto failed_usb_serial_register;
673 retval = usb_register(&spcp8x5_driver);
674 if (retval)
675 goto failed_usb_register;
676 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
677 DRIVER_DESC "\n");
678 return 0;
679failed_usb_register:
680 usb_serial_deregister(&spcp8x5_device);
681failed_usb_serial_register:
682 return retval;
683}
684
685static void __exit spcp8x5_exit(void)
686{
687 usb_deregister(&spcp8x5_driver);
688 usb_serial_deregister(&spcp8x5_device);
689}
690
691module_init(spcp8x5_init);
692module_exit(spcp8x5_exit);
693
694MODULE_DESCRIPTION(DRIVER_DESC);
695MODULE_VERSION(DRIVER_VERSION);
696MODULE_LICENSE("GPL");
697
698module_param(debug, bool, S_IRUGO | S_IWUSR);
699MODULE_PARM_DESC(debug, "Debug enabled or not");
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
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 { } /* Terminating entry */
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/* 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
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,
287 const struct ktermios *old_termios)
288{
289 struct usb_serial *serial = port->serial;
290 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
291 unsigned long flags;
292 unsigned int cflag = tty->termios.c_cflag;
293 unsigned short uartdata;
294 unsigned char buf[2] = {0, 0};
295 int baud;
296 int i;
297 u8 control;
298
299 /* check that they really want us to change something */
300 if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios))
301 return;
302
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;
310 }
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);
315 } else {
316 spin_unlock_irqrestore(&priv->lock, flags);
317 }
318
319 /* Set Baud Rate */
320 baud = tty_get_baud_rate(tty);
321 switch (baud) {
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; */
339 case 0:
340 case 1000000:
341 buf[0] = 0x0b; break;
342 default:
343 dev_err(&port->dev, "unsupported baudrate, using 9600\n");
344 }
345
346 /* Set Data Length : 00:5bit, 01:6bit, 10:7bit, 11:8bit */
347 switch (cflag & CSIZE) {
348 case CS5:
349 buf[1] |= SET_UART_FORMAT_SIZE_5;
350 break;
351 case CS6:
352 buf[1] |= SET_UART_FORMAT_SIZE_6;
353 break;
354 case CS7:
355 buf[1] |= SET_UART_FORMAT_SIZE_7;
356 break;
357 default:
358 case CS8:
359 buf[1] |= SET_UART_FORMAT_SIZE_8;
360 break;
361 }
362
363 /* Set Stop bit2 : 0:1bit 1:2bit */
364 buf[1] |= (cflag & CSTOPB) ? SET_UART_FORMAT_STOP_2 :
365 SET_UART_FORMAT_STOP_1;
366
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 ;
371 } else {
372 buf[1] |= SET_UART_FORMAT_PAR_NONE;
373 }
374 uartdata = buf[0] | buf[1]<<8;
375
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);
379 if (i < 0)
380 dev_err(&port->dev, "Set UART format %#x failed (error = %d)\n",
381 uartdata, i);
382 dev_dbg(&port->dev, "0x21:0x40:0:0 %d\n", i);
383
384 if (cflag & CRTSCTS) {
385 /* enable hardware flow control */
386 spcp8x5_set_work_mode(port, 0x000a, SET_WORKING_MODE_U2C);
387 }
388}
389
390static int spcp8x5_open(struct tty_struct *tty, struct usb_serial_port *port)
391{
392 struct usb_serial *serial = port->serial;
393 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
394 int ret;
395
396 usb_clear_halt(serial->dev, port->write_urb->pipe);
397 usb_clear_halt(serial->dev, port->read_urb->pipe);
398
399 ret = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
400 0x09, 0x00,
401 0x01, 0x00, NULL, 0x00, 100);
402 if (ret)
403 return ret;
404
405 spcp8x5_set_ctrl_line(port, priv->line_control);
406
407 if (tty)
408 spcp8x5_set_termios(tty, port, NULL);
409
410 return usb_serial_generic_open(tty, port);
411}
412
413static int spcp8x5_tiocmset(struct tty_struct *tty,
414 unsigned int set, unsigned int clear)
415{
416 struct usb_serial_port *port = tty->driver_data;
417 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
418 unsigned long flags;
419 u8 control;
420
421 spin_lock_irqsave(&priv->lock, flags);
422 if (set & TIOCM_RTS)
423 priv->line_control |= MCR_RTS;
424 if (set & TIOCM_DTR)
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);
432
433 return spcp8x5_set_ctrl_line(port, control);
434}
435
436static int spcp8x5_tiocmget(struct tty_struct *tty)
437{
438 struct usb_serial_port *port = tty->driver_data;
439 struct spcp8x5_private *priv = usb_get_serial_port_data(port);
440 unsigned long flags;
441 unsigned int mcr;
442 u8 status;
443 unsigned int result;
444
445 result = spcp8x5_get_msr(port, &status);
446 if (result)
447 return result;
448
449 spin_lock_irqsave(&priv->lock, flags);
450 mcr = priv->line_control;
451 spin_unlock_irqrestore(&priv->lock, flags);
452
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);
459
460 return result;
461}
462
463static struct usb_serial_driver spcp8x5_device = {
464 .driver = {
465 .owner = THIS_MODULE,
466 .name = "SPCP8x5",
467 },
468 .id_table = id_table,
469 .num_ports = 1,
470 .num_bulk_in = 1,
471 .num_bulk_out = 1,
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,
482};
483
484static struct usb_serial_driver * const serial_drivers[] = {
485 &spcp8x5_device, NULL
486};
487
488module_usb_serial_driver(serial_drivers, id_table);
489
490MODULE_DESCRIPTION(DRIVER_DESC);
491MODULE_LICENSE("GPL");