drivers/usb/serial/spcp8x5.c

   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 #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 SPCP8x5_007_VID         0x04FC
  32 #define SPCP8x5_007_PID         0x0201
  33 #define SPCP8x5_008_VID         0x04fc
  34 #define SPCP8x5_008_PID         0x0235
  35 #define SPCP8x5_PHILIPS_VID     0x0471
  36 #define SPCP8x5_PHILIPS_PID     0x081e
  37 #define SPCP8x5_INTERMATIC_VID  0x04FC
  38 #define SPCP8x5_INTERMATIC_PID  0x0204
  39 #define SPCP8x5_835_VID         0x04fc
  40 #define SPCP8x5_835_PID         0x0231
  41
  42 static const struct usb_device_id id_table[] = {
  43         { USB_DEVICE(SPCP8x5_PHILIPS_VID , SPCP8x5_PHILIPS_PID)},
  44         { USB_DEVICE(SPCP8x5_INTERMATIC_VID, SPCP8x5_INTERMATIC_PID)},
  45         { USB_DEVICE(SPCP8x5_835_VID, SPCP8x5_835_PID)},
  46         { USB_DEVICE(SPCP8x5_008_VID, SPCP8x5_008_PID)},
  47         { USB_DEVICE(SPCP8x5_007_VID, SPCP8x5_007_PID)},
  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 enum spcp8x5_type {
 140         SPCP825_007_TYPE,
 141         SPCP825_008_TYPE,
 142         SPCP825_PHILIP_TYPE,
 143         SPCP825_INTERMATIC_TYPE,
 144         SPCP835_TYPE,
 145 };
 146
 147 struct spcp8x5_private {
 148         spinlock_t              lock;
 149         enum spcp8x5_type       type;
 150         u8                      line_control;
 151         u8                      line_status;
 152 };
 153
 154 static int spcp8x5_port_probe(struct usb_serial_port *port)
 155 {
 156         struct usb_serial *serial = port->serial;
 157         struct spcp8x5_private *priv;
 158         enum spcp8x5_type type = SPCP825_007_TYPE;
 159         u16 product = le16_to_cpu(serial->dev->descriptor.idProduct);
 160
 161         if (product == 0x0201)
 162                 type = SPCP825_007_TYPE;
 163         else if (product == 0x0231)
 164                 type = SPCP835_TYPE;
 165         else if (product == 0x0235)
 166                 type = SPCP825_008_TYPE;
 167         else if (product == 0x0204)
 168                 type = SPCP825_INTERMATIC_TYPE;
 169         else if (product == 0x0471 &&
 170                  serial->dev->descriptor.idVendor == cpu_to_le16(0x081e))
 171                 type = SPCP825_PHILIP_TYPE;
 172         dev_dbg(&serial->dev->dev, "device type = %d\n", (int)type);
 173
 174         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
 175         if (!priv)
 176                 return -ENOMEM;
 177
 178         spin_lock_init(&priv->lock);
 179         priv->type = type;
 180
 181         usb_set_serial_port_data(port, priv);
 182
 183         return 0;
 184 }
 185
 186 static int spcp8x5_port_remove(struct usb_serial_port *port)
 187 {
 188         struct spcp8x5_private *priv;
 189
 190         priv = usb_get_serial_port_data(port);
 191         kfree(priv);
 192
 193         return 0;
 194 }
 195
 196 /*
 197  * Set the modem control line of the device.
 198  *
 199  * NOTE: not supported by spcp825-007
 200  */
 201 static int spcp8x5_set_ctrl_line(struct usb_serial_port *port, u8 mcr)
 202 {
 203         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 204         struct usb_device *dev = port->serial->dev;
 205         int retval;
 206
 207         if (priv->type == SPCP825_007_TYPE)
 208                 return -EPERM;
 209
 210         retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 211                                  SET_UART_STATUS_TYPE, SET_UART_STATUS,
 212                                  mcr, 0x04, NULL, 0, 100);
 213         if (retval != 0) {
 214                 dev_err(&port->dev, "failed to set control lines: %d\n",
 215                                                                 retval);
 216         }
 217         return retval;
 218 }
 219
 220 /*
 221  * Get the modem status register of the device.
 222  *
 223  * NOTE: not supported by spcp825-007
 224  */
 225 static int spcp8x5_get_msr(struct usb_serial_port *port, u8 *status)
 226 {
 227         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 228         struct usb_device *dev = port->serial->dev;
 229         u8 *status_buffer;
 230         int ret;
 231
 232         /* I return Permited not support here but seem inval device
 233          * is more fix */
 234         if (priv->type == SPCP825_007_TYPE)
 235                 return -EPERM;
 236         if (status == NULL)
 237                 return -EINVAL;
 238
 239         status_buffer = kmalloc(1, GFP_KERNEL);
 240         if (!status_buffer)
 241                 return -ENOMEM;
 242         status_buffer[0] = status[0];
 243
 244         ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 245                               GET_UART_STATUS, GET_UART_STATUS_TYPE,
 246                               0, GET_UART_STATUS_MSR, status_buffer, 1, 100);
 247         if (ret < 0)
 248                 dev_err(&port->dev, "failed to get modem status: %d", ret);
 249
 250         dev_dbg(&port->dev, "0xc0:0x22:0:6  %d - 0x02%x", ret, *status_buffer);
 251
 252         status[0] = status_buffer[0];
 253         kfree(status_buffer);
 254
 255         return ret;
 256 }
 257
 258 /*
 259  * Select the work mode.
 260  *
 261  * NOTE: not supported by spcp825-007
 262  */
 263 static void spcp8x5_set_work_mode(struct usb_serial_port *port, u16 value,
 264                                                                  u16 index)
 265 {
 266         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 267         struct usb_device *dev = port->serial->dev;
 268         int ret;
 269
 270         /* I return Permited not support here but seem inval device
 271          * is more fix */
 272         if (priv->type == SPCP825_007_TYPE)
 273                 return;
 274
 275         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 276                               SET_WORKING_MODE_TYPE, SET_WORKING_MODE,
 277                               value, index, NULL, 0, 100);
 278         dev_dbg(&port->dev, "value = %#x , index = %#x\n", value, index);
 279         if (ret < 0)
 280                 dev_err(&port->dev, "failed to set work mode: %d\n", ret);
 281 }
 282
 283 static int spcp8x5_carrier_raised(struct usb_serial_port *port)
 284 {
 285         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 286
 287         if (priv->line_status & MSR_STATUS_LINE_DCD)
 288                 return 1;
 289
 290         return 0;
 291 }
 292
 293 static void spcp8x5_dtr_rts(struct usb_serial_port *port, int on)
 294 {
 295         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 296         unsigned long flags;
 297         u8 control;
 298
 299         spin_lock_irqsave(&priv->lock, flags);
 300         if (on)
 301                 priv->line_control = MCR_CONTROL_LINE_DTR
 302                                                 | MCR_CONTROL_LINE_RTS;
 303         else
 304                 priv->line_control &= ~ (MCR_CONTROL_LINE_DTR
 305                                                 | MCR_CONTROL_LINE_RTS);
 306         control = priv->line_control;
 307         spin_unlock_irqrestore(&priv->lock, flags);
 308         spcp8x5_set_ctrl_line(port, control);
 309 }
 310
 311 static void spcp8x5_init_termios(struct tty_struct *tty)
 312 {
 313         tty->termios = tty_std_termios;
 314         tty->termios.c_cflag = B115200 | CS8 | CREAD | HUPCL | CLOCAL;
 315         tty->termios.c_ispeed = 115200;
 316         tty->termios.c_ospeed = 115200;
 317 }
 318
 319 static void spcp8x5_set_termios(struct tty_struct *tty,
 320                 struct usb_serial_port *port, struct ktermios *old_termios)
 321 {
 322         struct usb_serial *serial = port->serial;
 323         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 324         unsigned long flags;
 325         unsigned int cflag = tty->termios.c_cflag;
 326         unsigned int old_cflag = old_termios->c_cflag;
 327         unsigned short uartdata;
 328         unsigned char buf[2] = {0, 0};
 329         int baud;
 330         int i;
 331         u8 control;
 332
 333         /* check that they really want us to change something */
 334         if (!tty_termios_hw_change(&tty->termios, old_termios))
 335                 return;
 336
 337         /* set DTR/RTS active */
 338         spin_lock_irqsave(&priv->lock, flags);
 339         control = priv->line_control;
 340         if ((old_cflag & CBAUD) == B0) {
 341                 priv->line_control |= MCR_DTR;
 342                 if (!(old_cflag & CRTSCTS))
 343                         priv->line_control |= MCR_RTS;
 344         }
 345         if (control != priv->line_control) {
 346                 control = priv->line_control;
 347                 spin_unlock_irqrestore(&priv->lock, flags);
 348                 spcp8x5_set_ctrl_line(port, control);
 349         } else {
 350                 spin_unlock_irqrestore(&priv->lock, flags);
 351         }
 352
 353         /* Set Baud Rate */
 354         baud = tty_get_baud_rate(tty);
 355         switch (baud) {
 356         case 300:       buf[0] = 0x00;  break;
 357         case 600:       buf[0] = 0x01;  break;
 358         case 1200:      buf[0] = 0x02;  break;
 359         case 2400:      buf[0] = 0x03;  break;
 360         case 4800:      buf[0] = 0x04;  break;
 361         case 9600:      buf[0] = 0x05;  break;
 362         case 19200:     buf[0] = 0x07;  break;
 363         case 38400:     buf[0] = 0x09;  break;
 364         case 57600:     buf[0] = 0x0a;  break;
 365         case 115200:    buf[0] = 0x0b;  break;
 366         case 230400:    buf[0] = 0x0c;  break;
 367         case 460800:    buf[0] = 0x0d;  break;
 368         case 921600:    buf[0] = 0x0e;  break;
 369 /*      case 1200000:   buf[0] = 0x0f;  break; */
 370 /*      case 2400000:   buf[0] = 0x10;  break; */
 371         case 3000000:   buf[0] = 0x11;  break;
 372 /*      case 6000000:   buf[0] = 0x12;  break; */
 373         case 0:
 374         case 1000000:
 375                         buf[0] = 0x0b;  break;
 376         default:
 377                 dev_err(&port->dev, "spcp825 driver does not support the "
 378                         "baudrate requested, using default of 9600.\n");
 379         }
 380
 381         /* Set Data Length : 00:5bit, 01:6bit, 10:7bit, 11:8bit */
 382         if (cflag & CSIZE) {
 383                 switch (cflag & CSIZE) {
 384                 case CS5:
 385                         buf[1] |= SET_UART_FORMAT_SIZE_5;
 386                         break;
 387                 case CS6:
 388                         buf[1] |= SET_UART_FORMAT_SIZE_6;
 389                         break;
 390                 case CS7:
 391                         buf[1] |= SET_UART_FORMAT_SIZE_7;
 392                         break;
 393                 default:
 394                 case CS8:
 395                         buf[1] |= SET_UART_FORMAT_SIZE_8;
 396                         break;
 397                 }
 398         }
 399
 400         /* Set Stop bit2 : 0:1bit 1:2bit */
 401         buf[1] |= (cflag & CSTOPB) ? SET_UART_FORMAT_STOP_2 :
 402                                      SET_UART_FORMAT_STOP_1;
 403
 404         /* Set Parity bit3-4 01:Odd 11:Even */
 405         if (cflag & PARENB) {
 406                 buf[1] |= (cflag & PARODD) ?
 407                 SET_UART_FORMAT_PAR_ODD : SET_UART_FORMAT_PAR_EVEN ;
 408         } else {
 409                 buf[1] |= SET_UART_FORMAT_PAR_NONE;
 410         }
 411         uartdata = buf[0] | buf[1]<<8;
 412
 413         i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 414                             SET_UART_FORMAT_TYPE, SET_UART_FORMAT,
 415                             uartdata, 0, NULL, 0, 100);
 416         if (i < 0)
 417                 dev_err(&port->dev, "Set UART format %#x failed (error = %d)\n",
 418                         uartdata, i);
 419         dev_dbg(&port->dev, "0x21:0x40:0:0  %d\n", i);
 420
 421         if (cflag & CRTSCTS) {
 422                 /* enable hardware flow control */
 423                 spcp8x5_set_work_mode(port, 0x000a, SET_WORKING_MODE_U2C);
 424         }
 425 }
 426
 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_ctrl_line(port, priv->line_control);
 447
 448         /* Setup termios */
 449         if (tty)
 450                 spcp8x5_set_termios(tty, port, &tmp_termios);
 451
 452         spcp8x5_get_msr(port, &status);
 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 int spcp8x5_tiocmset(struct tty_struct *tty,
 465                             unsigned int set, unsigned int clear)
 466 {
 467         struct usb_serial_port *port = tty->driver_data;
 468         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 469         unsigned long flags;
 470         u8 control;
 471
 472         spin_lock_irqsave(&priv->lock, flags);
 473         if (set & TIOCM_RTS)
 474                 priv->line_control |= MCR_RTS;
 475         if (set & TIOCM_DTR)
 476                 priv->line_control |= MCR_DTR;
 477         if (clear & TIOCM_RTS)
 478                 priv->line_control &= ~MCR_RTS;
 479         if (clear & TIOCM_DTR)
 480                 priv->line_control &= ~MCR_DTR;
 481         control = priv->line_control;
 482         spin_unlock_irqrestore(&priv->lock, flags);
 483
 484         return spcp8x5_set_ctrl_line(port, control);
 485 }
 486
 487 static int spcp8x5_tiocmget(struct tty_struct *tty)
 488 {
 489         struct usb_serial_port *port = tty->driver_data;
 490         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 491         unsigned long flags;
 492         unsigned int mcr;
 493         unsigned int status;
 494         unsigned int result;
 495
 496         spin_lock_irqsave(&priv->lock, flags);
 497         mcr = priv->line_control;
 498         status = priv->line_status;
 499         spin_unlock_irqrestore(&priv->lock, flags);
 500
 501         result = ((mcr & MCR_DTR)                       ? TIOCM_DTR : 0)
 502                   | ((mcr & MCR_RTS)                    ? TIOCM_RTS : 0)
 503                   | ((status & MSR_STATUS_LINE_CTS)     ? TIOCM_CTS : 0)
 504                   | ((status & MSR_STATUS_LINE_DSR)     ? TIOCM_DSR : 0)
 505                   | ((status & MSR_STATUS_LINE_RI)      ? TIOCM_RI  : 0)
 506                   | ((status & MSR_STATUS_LINE_DCD)     ? TIOCM_CD  : 0);
 507
 508         return result;
 509 }
 510
 511 static struct usb_serial_driver spcp8x5_device = {
 512         .driver = {
 513                 .owner =        THIS_MODULE,
 514                 .name =         "SPCP8x5",
 515         },
 516         .id_table               = id_table,
 517         .num_ports              = 1,
 518         .open                   = spcp8x5_open,
 519         .dtr_rts                = spcp8x5_dtr_rts,
 520         .carrier_raised         = spcp8x5_carrier_raised,
 521         .set_termios            = spcp8x5_set_termios,
 522         .init_termios           = spcp8x5_init_termios,
 523         .tiocmget               = spcp8x5_tiocmget,
 524         .tiocmset               = spcp8x5_tiocmset,
 525         .port_probe             = spcp8x5_port_probe,
 526         .port_remove            = spcp8x5_port_remove,
 527 };
 528
 529 static struct usb_serial_driver * const serial_drivers[] = {
 530         &spcp8x5_device, NULL
 531 };
 532
 533 module_usb_serial_driver(serial_drivers, id_table);
 534
 535 MODULE_DESCRIPTION(DRIVER_DESC);
 536 MODULE_LICENSE("GPL");