kernel/drivers/usb/serial/spcp8x5.c

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