Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
spcp8x5.c
Go to the documentation of this file.
1 /*
2  * spcp8x5 USB to serial adaptor driver
3  *
4  * Copyright (C) 2010 Johan Hovold ([email protected])
5  * Copyright (C) 2006 Linxb ([email protected])
6  * Copyright (C) 2006 S1 Corp.
7  *
8  * Original driver for 2.6.10 pl2303 driver by
9  * Greg Kroah-Hartman ([email protected])
10  * Changes for 2.6.20 by Harald Klein <[email protected]>
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 
36 #define SPCP8x5_007_VID 0x04FC
37 #define SPCP8x5_007_PID 0x0201
38 #define SPCP8x5_008_VID 0x04fc
39 #define SPCP8x5_008_PID 0x0235
40 #define SPCP8x5_PHILIPS_VID 0x0471
41 #define SPCP8x5_PHILIPS_PID 0x081e
42 #define SPCP8x5_INTERMATIC_VID 0x04FC
43 #define SPCP8x5_INTERMATIC_PID 0x0204
44 #define SPCP8x5_835_VID 0x04fc
45 #define SPCP8x5_835_PID 0x0231
46 
47 static const struct usb_device_id id_table[] = {
50  { USB_DEVICE(SPCP8x5_835_VID, SPCP8x5_835_PID)},
51  { USB_DEVICE(SPCP8x5_008_VID, SPCP8x5_008_PID)},
52  { USB_DEVICE(SPCP8x5_007_VID, SPCP8x5_007_PID)},
53  { } /* Terminating entry */
54 };
55 MODULE_DEVICE_TABLE(usb, id_table);
56 
64 };
65 
66 
67 /* spcp8x5 spec register define */
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 /* verdor command here , we should define myself */
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 /* how come ??? */
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 
150 };
151 
158 };
159 
160 static int spcp8x5_port_probe(struct usb_serial_port *port)
161 {
162  struct usb_serial *serial = port->serial;
163  struct spcp8x5_private *priv;
165  u16 product = le16_to_cpu(serial->dev->descriptor.idProduct);
166 
167  if (product == 0x0201)
168  type = SPCP825_007_TYPE;
169  else if (product == 0x0231)
170  type = SPCP835_TYPE;
171  else if (product == 0x0235)
172  type = SPCP825_008_TYPE;
173  else if (product == 0x0204)
175  else if (product == 0x0471 &&
176  serial->dev->descriptor.idVendor == cpu_to_le16(0x081e))
177  type = SPCP825_PHILIP_TYPE;
178  dev_dbg(&serial->dev->dev, "device type = %d\n", (int)type);
179 
180  priv = kzalloc(sizeof(*priv), GFP_KERNEL);
181  if (!priv)
182  return -ENOMEM;
183 
184  spin_lock_init(&priv->lock);
186  priv->type = type;
187 
188  usb_set_serial_port_data(port , priv);
189 
190  return 0;
191 }
192 
193 static int spcp8x5_port_remove(struct usb_serial_port *port)
194 {
195  struct spcp8x5_private *priv;
196 
197  priv = usb_get_serial_port_data(port);
198  kfree(priv);
199 
200  return 0;
201 }
202 
203 /* set the modem control line of the device.
204  * NOTE spcp825-007 not supported this */
205 static int spcp8x5_set_ctrlLine(struct usb_device *dev, u8 value,
206  enum spcp8x5_type type)
207 {
208  int retval;
209  u8 mcr = 0 ;
210 
211  if (type == SPCP825_007_TYPE)
212  return -EPERM;
213 
214  mcr = (unsigned short)value;
215  retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
217  mcr, 0x04, NULL, 0, 100);
218  if (retval != 0)
219  dev_dbg(&dev->dev, "usb_control_msg return %#x\n", retval);
220  return retval;
221 }
222 
223 /* get the modem status register of the device
224  * NOTE spcp825-007 not supported this */
225 static int spcp8x5_get_msr(struct usb_device *dev, u8 *status,
226  enum spcp8x5_type type)
227 {
228  u8 *status_buffer;
229  int ret;
230 
231  /* I return Permited not support here but seem inval device
232  * is more fix */
233  if (type == SPCP825_007_TYPE)
234  return -EPERM;
235  if (status == NULL)
236  return -EINVAL;
237 
238  status_buffer = kmalloc(1, GFP_KERNEL);
239  if (!status_buffer)
240  return -ENOMEM;
241  status_buffer[0] = status[0];
242 
243  ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
245  0, GET_UART_STATUS_MSR, status_buffer, 1, 100);
246  if (ret < 0)
247  dev_dbg(&dev->dev, "Get MSR = 0x%p failed (error = %d)",
248  status_buffer, ret);
249 
250  dev_dbg(&dev->dev, "0xc0:0x22:0:6 %d - 0x%p ", ret, status_buffer);
251  status[0] = status_buffer[0];
252  kfree(status_buffer);
253 
254  return ret;
255 }
256 
257 /* select the work mode.
258  * NOTE this function not supported by spcp825-007 */
259 static void spcp8x5_set_workMode(struct usb_device *dev, u16 value,
260  u16 index, enum spcp8x5_type type)
261 {
262  int ret;
263 
264  /* I return Permited not support here but seem inval device
265  * is more fix */
266  if (type == SPCP825_007_TYPE)
267  return;
268 
269  ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
271  value, index, NULL, 0, 100);
272  dev_dbg(&dev->dev, "value = %#x , index = %#x\n", value, index);
273  if (ret < 0)
274  dev_dbg(&dev->dev,
275  "RTSCTS usb_control_msg(enable flowctrl) = %d\n", ret);
276 }
277 
278 static int spcp8x5_carrier_raised(struct usb_serial_port *port)
279 {
280  struct spcp8x5_private *priv = usb_get_serial_port_data(port);
281  if (priv->line_status & MSR_STATUS_LINE_DCD)
282  return 1;
283  return 0;
284 }
285 
286 static void spcp8x5_dtr_rts(struct usb_serial_port *port, int on)
287 {
288  struct spcp8x5_private *priv = usb_get_serial_port_data(port);
289  unsigned long flags;
290  u8 control;
291 
292  spin_lock_irqsave(&priv->lock, flags);
293  if (on)
296  else
299  control = priv->line_control;
300  spin_unlock_irqrestore(&priv->lock, flags);
301  spcp8x5_set_ctrlLine(port->serial->dev, control , priv->type);
302 }
303 
304 static void spcp8x5_init_termios(struct tty_struct *tty)
305 {
306  /* for the 1st time call this function */
307  tty->termios = tty_std_termios;
308  tty->termios.c_cflag = B115200 | CS8 | CREAD | HUPCL | CLOCAL;
309  tty->termios.c_ispeed = 115200;
310  tty->termios.c_ospeed = 115200;
311 }
312 
313 /* set the serial param for transfer. we should check if we really need to
314  * transfer. if we set flow control we should do this too. */
315 static void spcp8x5_set_termios(struct tty_struct *tty,
316  struct usb_serial_port *port, struct ktermios *old_termios)
317 {
318  struct usb_serial *serial = port->serial;
319  struct spcp8x5_private *priv = usb_get_serial_port_data(port);
320  unsigned long flags;
321  unsigned int cflag = tty->termios.c_cflag;
322  unsigned int old_cflag = old_termios->c_cflag;
323  unsigned short uartdata;
324  unsigned char buf[2] = {0, 0};
325  int baud;
326  int i;
327  u8 control;
328 
329 
330  /* check that they really want us to change something */
331  if (!tty_termios_hw_change(&tty->termios, old_termios))
332  return;
333 
334  /* set DTR/RTS active */
335  spin_lock_irqsave(&priv->lock, flags);
336  control = priv->line_control;
337  if ((old_cflag & CBAUD) == B0) {
338  priv->line_control |= MCR_DTR;
339  if (!(old_cflag & CRTSCTS))
340  priv->line_control |= MCR_RTS;
341  }
342  if (control != priv->line_control) {
343  control = priv->line_control;
344  spin_unlock_irqrestore(&priv->lock, flags);
345  spcp8x5_set_ctrlLine(serial->dev, control , priv->type);
346  } else {
347  spin_unlock_irqrestore(&priv->lock, flags);
348  }
349 
350  /* Set Baud Rate */
351  baud = tty_get_baud_rate(tty);
352  switch (baud) {
353  case 300: buf[0] = 0x00; break;
354  case 600: buf[0] = 0x01; break;
355  case 1200: buf[0] = 0x02; break;
356  case 2400: buf[0] = 0x03; break;
357  case 4800: buf[0] = 0x04; break;
358  case 9600: buf[0] = 0x05; break;
359  case 19200: buf[0] = 0x07; break;
360  case 38400: buf[0] = 0x09; break;
361  case 57600: buf[0] = 0x0a; break;
362  case 115200: buf[0] = 0x0b; break;
363  case 230400: buf[0] = 0x0c; break;
364  case 460800: buf[0] = 0x0d; break;
365  case 921600: buf[0] = 0x0e; break;
366 /* case 1200000: buf[0] = 0x0f; break; */
367 /* case 2400000: buf[0] = 0x10; break; */
368  case 3000000: buf[0] = 0x11; break;
369 /* case 6000000: buf[0] = 0x12; break; */
370  case 0:
371  case 1000000:
372  buf[0] = 0x0b; break;
373  default:
374  dev_err(&port->dev, "spcp825 driver does not support the "
375  "baudrate requested, using default of 9600.\n");
376  }
377 
378  /* Set Data Length : 00:5bit, 01:6bit, 10:7bit, 11:8bit */
379  if (cflag & CSIZE) {
380  switch (cflag & CSIZE) {
381  case CS5:
382  buf[1] |= SET_UART_FORMAT_SIZE_5;
383  break;
384  case CS6:
385  buf[1] |= SET_UART_FORMAT_SIZE_6;
386  break;
387  case CS7:
388  buf[1] |= SET_UART_FORMAT_SIZE_7;
389  break;
390  default:
391  case CS8:
392  buf[1] |= SET_UART_FORMAT_SIZE_8;
393  break;
394  }
395  }
396 
397  /* Set Stop bit2 : 0:1bit 1:2bit */
398  buf[1] |= (cflag & CSTOPB) ? SET_UART_FORMAT_STOP_2 :
400 
401  /* Set Parity bit3-4 01:Odd 11:Even */
402  if (cflag & PARENB) {
403  buf[1] |= (cflag & PARODD) ?
405  } else
406  buf[1] |= SET_UART_FORMAT_PAR_NONE;
407 
408  uartdata = buf[0] | buf[1]<<8;
409 
410  i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
412  uartdata, 0, NULL, 0, 100);
413  if (i < 0)
414  dev_err(&port->dev, "Set UART format %#x failed (error = %d)\n",
415  uartdata, i);
416  dev_dbg(&port->dev, "0x21:0x40:0:0 %d\n", i);
417 
418  if (cflag & CRTSCTS) {
419  /* enable hardware flow control */
420  spcp8x5_set_workMode(serial->dev, 0x000a,
421  SET_WORKING_MODE_U2C, priv->type);
422  }
423 }
424 
425 /* open the serial port. do some usb system call. set termios and get the line
426  * status of the device. */
427 static int spcp8x5_open(struct tty_struct *tty, struct usb_serial_port *port)
428 {
429  struct ktermios tmp_termios;
430  struct usb_serial *serial = port->serial;
431  struct spcp8x5_private *priv = usb_get_serial_port_data(port);
432  int ret;
433  unsigned long flags;
434  u8 status = 0x30;
435  /* status 0x30 means DSR and CTS = 1 other CDC RI and delta = 0 */
436 
437  usb_clear_halt(serial->dev, port->write_urb->pipe);
438  usb_clear_halt(serial->dev, port->read_urb->pipe);
439 
440  ret = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
441  0x09, 0x00,
442  0x01, 0x00, NULL, 0x00, 100);
443  if (ret)
444  return ret;
445 
446  spcp8x5_set_ctrlLine(serial->dev, priv->line_control , priv->type);
447 
448  /* Setup termios */
449  if (tty)
450  spcp8x5_set_termios(tty, port, &tmp_termios);
451 
452  spcp8x5_get_msr(serial->dev, &status, priv->type);
453 
454  /* may be we should update uart status here but now we did not do */
455  spin_lock_irqsave(&priv->lock, flags);
456  priv->line_status = status & 0xf0 ;
457  spin_unlock_irqrestore(&priv->lock, flags);
458 
459  port->port.drain_delay = 256;
460 
461  return usb_serial_generic_open(tty, port);
462 }
463 
464 static void spcp8x5_process_read_urb(struct urb *urb)
465 {
466  struct usb_serial_port *port = urb->context;
467  struct spcp8x5_private *priv = usb_get_serial_port_data(port);
468  struct tty_struct *tty;
469  unsigned char *data = urb->transfer_buffer;
470  unsigned long flags;
471  u8 status;
472  char tty_flag;
473 
474  /* get tty_flag from status */
475  tty_flag = TTY_NORMAL;
476 
477  spin_lock_irqsave(&priv->lock, flags);
478  status = priv->line_status;
480  spin_unlock_irqrestore(&priv->lock, flags);
481  /* wake up the wait for termios */
483 
484  if (!urb->actual_length)
485  return;
486 
487  tty = tty_port_tty_get(&port->port);
488  if (!tty)
489  return;
490 
491  if (status & UART_STATE_TRANSIENT_MASK) {
492  /* break takes precedence over parity, which takes precedence
493  * over framing errors */
494  if (status & UART_BREAK_ERROR)
495  tty_flag = TTY_BREAK;
496  else if (status & UART_PARITY_ERROR)
497  tty_flag = TTY_PARITY;
498  else if (status & UART_FRAME_ERROR)
499  tty_flag = TTY_FRAME;
500  dev_dbg(&port->dev, "tty_flag = %d\n", tty_flag);
501 
502  /* overrun is special, not associated with a char */
503  if (status & UART_OVERRUN_ERROR)
504  tty_insert_flip_char(tty, 0, TTY_OVERRUN);
505 
506  if (status & UART_DCD)
509  }
510 
511  tty_insert_flip_string_fixed_flag(tty, data, tty_flag,
512  urb->actual_length);
514  tty_kref_put(tty);
515 }
516 
517 static int spcp8x5_wait_modem_info(struct usb_serial_port *port,
518  unsigned int arg)
519 {
520  struct spcp8x5_private *priv = usb_get_serial_port_data(port);
521  unsigned long flags;
522  unsigned int prevstatus;
523  unsigned int status;
524  unsigned int changed;
525 
526  spin_lock_irqsave(&priv->lock, flags);
527  prevstatus = priv->line_status;
528  spin_unlock_irqrestore(&priv->lock, flags);
529 
530  while (1) {
531  /* wake up in bulk read */
533 
534  /* see if a signal did it */
535  if (signal_pending(current))
536  return -ERESTARTSYS;
537 
538  spin_lock_irqsave(&priv->lock, flags);
539  status = priv->line_status;
540  spin_unlock_irqrestore(&priv->lock, flags);
541 
542  changed = prevstatus^status;
543 
544  if (((arg & TIOCM_RNG) && (changed & MSR_STATUS_LINE_RI)) ||
545  ((arg & TIOCM_DSR) && (changed & MSR_STATUS_LINE_DSR)) ||
546  ((arg & TIOCM_CD) && (changed & MSR_STATUS_LINE_DCD)) ||
547  ((arg & TIOCM_CTS) && (changed & MSR_STATUS_LINE_CTS)))
548  return 0;
549 
550  prevstatus = status;
551  }
552  /* NOTREACHED */
553  return 0;
554 }
555 
556 static int spcp8x5_ioctl(struct tty_struct *tty,
557  unsigned int cmd, unsigned long arg)
558 {
559  struct usb_serial_port *port = tty->driver_data;
560 
561  dev_dbg(&port->dev, "%s (%d) cmd = 0x%04x\n", __func__,
562  port->number, cmd);
563 
564  switch (cmd) {
565  case TIOCMIWAIT:
566  dev_dbg(&port->dev, "%s (%d) TIOCMIWAIT\n", __func__,
567  port->number);
568  return spcp8x5_wait_modem_info(port, arg);
569 
570  default:
571  dev_dbg(&port->dev, "%s not supported = 0x%04x", __func__,
572  cmd);
573  break;
574  }
575 
576  return -ENOIOCTLCMD;
577 }
578 
579 static int spcp8x5_tiocmset(struct tty_struct *tty,
580  unsigned int set, unsigned int clear)
581 {
582  struct usb_serial_port *port = tty->driver_data;
583  struct spcp8x5_private *priv = usb_get_serial_port_data(port);
584  unsigned long flags;
585  u8 control;
586 
587  spin_lock_irqsave(&priv->lock, flags);
588  if (set & TIOCM_RTS)
589  priv->line_control |= MCR_RTS;
590  if (set & TIOCM_DTR)
591  priv->line_control |= MCR_DTR;
592  if (clear & TIOCM_RTS)
593  priv->line_control &= ~MCR_RTS;
594  if (clear & TIOCM_DTR)
595  priv->line_control &= ~MCR_DTR;
596  control = priv->line_control;
597  spin_unlock_irqrestore(&priv->lock, flags);
598 
599  return spcp8x5_set_ctrlLine(port->serial->dev, control , priv->type);
600 }
601 
602 static int spcp8x5_tiocmget(struct tty_struct *tty)
603 {
604  struct usb_serial_port *port = tty->driver_data;
605  struct spcp8x5_private *priv = usb_get_serial_port_data(port);
606  unsigned long flags;
607  unsigned int mcr;
608  unsigned int status;
609  unsigned int result;
610 
611  spin_lock_irqsave(&priv->lock, flags);
612  mcr = priv->line_control;
613  status = priv->line_status;
614  spin_unlock_irqrestore(&priv->lock, flags);
615 
616  result = ((mcr & MCR_DTR) ? TIOCM_DTR : 0)
617  | ((mcr & MCR_RTS) ? TIOCM_RTS : 0)
618  | ((status & MSR_STATUS_LINE_CTS) ? TIOCM_CTS : 0)
619  | ((status & MSR_STATUS_LINE_DSR) ? TIOCM_DSR : 0)
620  | ((status & MSR_STATUS_LINE_RI) ? TIOCM_RI : 0)
621  | ((status & MSR_STATUS_LINE_DCD) ? TIOCM_CD : 0);
622 
623  return result;
624 }
625 
626 /* All of the device info needed for the spcp8x5 SIO serial converter */
627 static struct usb_serial_driver spcp8x5_device = {
628  .driver = {
629  .owner = THIS_MODULE,
630  .name = "SPCP8x5",
631  },
632  .id_table = id_table,
633  .num_ports = 1,
634  .open = spcp8x5_open,
635  .dtr_rts = spcp8x5_dtr_rts,
636  .carrier_raised = spcp8x5_carrier_raised,
637  .set_termios = spcp8x5_set_termios,
638  .init_termios = spcp8x5_init_termios,
639  .ioctl = spcp8x5_ioctl,
640  .tiocmget = spcp8x5_tiocmget,
641  .tiocmset = spcp8x5_tiocmset,
642  .port_probe = spcp8x5_port_probe,
643  .port_remove = spcp8x5_port_remove,
644  .process_read_urb = spcp8x5_process_read_urb,
645 };
646 
647 static struct usb_serial_driver * const serial_drivers[] = {
648  &spcp8x5_device, NULL
649 };
650 
651 module_usb_serial_driver(serial_drivers, id_table);
652 
655 MODULE_LICENSE("GPL");