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_port_probe(struct usb_serial_port *port)
 158 {
 159         const struct usb_device_id *id = usb_get_serial_data(port->serial);
 160         struct spcp8x5_private *priv;
 161
 162         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
 163         if (!priv)
 164                 return -ENOMEM;
 165
 166         spin_lock_init(&priv->lock);
 167         priv->quirks = id->driver_info;
 168
 169         usb_set_serial_port_data(port, priv);
 170
 171         port->port.drain_delay = 256;
 172
 173         return 0;
 174 }
 175
 176 static int spcp8x5_port_remove(struct usb_serial_port *port)
 177 {
 178         struct spcp8x5_private *priv;
 179
 180         priv = usb_get_serial_port_data(port);
 181         kfree(priv);
 182
 183         return 0;
 184 }
 185
 186 static int spcp8x5_set_ctrl_line(struct usb_serial_port *port, u8 mcr)
 187 {
 188         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 189         struct usb_device *dev = port->serial->dev;
 190         int retval;
 191
 192         if (priv->quirks & SPCP825_QUIRK_NO_UART_STATUS)
 193                 return -EPERM;
 194
 195         retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 196                                  SET_UART_STATUS_TYPE, SET_UART_STATUS,
 197                                  mcr, 0x04, NULL, 0, 100);
 198         if (retval != 0) {
 199                 dev_err(&port->dev, "failed to set control lines: %d\n",
 200                                                                 retval);
 201         }
 202         return retval;
 203 }
 204
 205 static int spcp8x5_get_msr(struct usb_serial_port *port, u8 *status)
 206 {
 207         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 208         struct usb_device *dev = port->serial->dev;
 209         u8 *buf;
 210         int ret;
 211
 212         if (priv->quirks & SPCP825_QUIRK_NO_UART_STATUS)
 213                 return -EPERM;
 214
 215         buf = kzalloc(1, GFP_KERNEL);
 216         if (!buf)
 217                 return -ENOMEM;
 218
 219         ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 220                               GET_UART_STATUS, GET_UART_STATUS_TYPE,
 221                               0, GET_UART_STATUS_MSR, buf, 1, 100);
 222         if (ret < 1) {
 223                 dev_err(&port->dev, "failed to get modem status: %d\n", ret);
 224                 if (ret >= 0)
 225                         ret = -EIO;
 226                 goto out;
 227         }
 228
 229         dev_dbg(&port->dev, "0xc0:0x22:0:6  %d - 0x02%x\n", ret, *buf);
 230         *status = *buf;
 231         ret = 0;
 232 out:
 233         kfree(buf);
 234
 235         return ret;
 236 }
 237
 238 static void spcp8x5_set_work_mode(struct usb_serial_port *port, u16 value,
 239                                                                  u16 index)
 240 {
 241         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 242         struct usb_device *dev = port->serial->dev;
 243         int ret;
 244
 245         if (priv->quirks & SPCP825_QUIRK_NO_WORK_MODE)
 246                 return;
 247
 248         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 249                               SET_WORKING_MODE_TYPE, SET_WORKING_MODE,
 250                               value, index, NULL, 0, 100);
 251         dev_dbg(&port->dev, "value = %#x , index = %#x\n", value, index);
 252         if (ret < 0)
 253                 dev_err(&port->dev, "failed to set work mode: %d\n", ret);
 254 }
 255
 256 static int spcp8x5_carrier_raised(struct usb_serial_port *port)
 257 {
 258         u8 msr;
 259         int ret;
 260
 261         ret = spcp8x5_get_msr(port, &msr);
 262         if (ret || msr & MSR_STATUS_LINE_DCD)
 263                 return 1;
 264
 265         return 0;
 266 }
 267
 268 static void spcp8x5_dtr_rts(struct usb_serial_port *port, int on)
 269 {
 270         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 271         unsigned long flags;
 272         u8 control;
 273
 274         spin_lock_irqsave(&priv->lock, flags);
 275         if (on)
 276                 priv->line_control = MCR_CONTROL_LINE_DTR
 277                                                 | MCR_CONTROL_LINE_RTS;
 278         else
 279                 priv->line_control &= ~ (MCR_CONTROL_LINE_DTR
 280                                                 | MCR_CONTROL_LINE_RTS);
 281         control = priv->line_control;
 282         spin_unlock_irqrestore(&priv->lock, flags);
 283         spcp8x5_set_ctrl_line(port, control);
 284 }
 285
 286 static void spcp8x5_init_termios(struct tty_struct *tty)
 287 {
 288         tty->termios = tty_std_termios;
 289         tty->termios.c_cflag = B115200 | CS8 | CREAD | HUPCL | CLOCAL;
 290         tty->termios.c_ispeed = 115200;
 291         tty->termios.c_ospeed = 115200;
 292 }
 293
 294 static void spcp8x5_set_termios(struct tty_struct *tty,
 295                 struct usb_serial_port *port, struct ktermios *old_termios)
 296 {
 297         struct usb_serial *serial = port->serial;
 298         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 299         unsigned long flags;
 300         unsigned int cflag = tty->termios.c_cflag;
 301         unsigned short uartdata;
 302         unsigned char buf[2] = {0, 0};
 303         int baud;
 304         int i;
 305         u8 control;
 306
 307         /* check that they really want us to change something */
 308         if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios))
 309                 return;
 310
 311         /* set DTR/RTS active */
 312         spin_lock_irqsave(&priv->lock, flags);
 313         control = priv->line_control;
 314         if (old_termios && (old_termios->c_cflag & CBAUD) == B0) {
 315                 priv->line_control |= MCR_DTR;
 316                 if (!(old_termios->c_cflag & CRTSCTS))
 317                         priv->line_control |= MCR_RTS;
 318         }
 319         if (control != priv->line_control) {
 320                 control = priv->line_control;
 321                 spin_unlock_irqrestore(&priv->lock, flags);
 322                 spcp8x5_set_ctrl_line(port, control);
 323         } else {
 324                 spin_unlock_irqrestore(&priv->lock, flags);
 325         }
 326
 327         /* Set Baud Rate */
 328         baud = tty_get_baud_rate(tty);
 329         switch (baud) {
 330         case 300:       buf[0] = 0x00;  break;
 331         case 600:       buf[0] = 0x01;  break;
 332         case 1200:      buf[0] = 0x02;  break;
 333         case 2400:      buf[0] = 0x03;  break;
 334         case 4800:      buf[0] = 0x04;  break;
 335         case 9600:      buf[0] = 0x05;  break;
 336         case 19200:     buf[0] = 0x07;  break;
 337         case 38400:     buf[0] = 0x09;  break;
 338         case 57600:     buf[0] = 0x0a;  break;
 339         case 115200:    buf[0] = 0x0b;  break;
 340         case 230400:    buf[0] = 0x0c;  break;
 341         case 460800:    buf[0] = 0x0d;  break;
 342         case 921600:    buf[0] = 0x0e;  break;
 343 /*      case 1200000:   buf[0] = 0x0f;  break; */
 344 /*      case 2400000:   buf[0] = 0x10;  break; */
 345         case 3000000:   buf[0] = 0x11;  break;
 346 /*      case 6000000:   buf[0] = 0x12;  break; */
 347         case 0:
 348         case 1000000:
 349                         buf[0] = 0x0b;  break;
 350         default:
 351                 dev_err(&port->dev, "unsupported baudrate, using 9600\n");
 352         }
 353
 354         /* Set Data Length : 00:5bit, 01:6bit, 10:7bit, 11:8bit */
 355         switch (cflag & CSIZE) {
 356         case CS5:
 357                 buf[1] |= SET_UART_FORMAT_SIZE_5;
 358                 break;
 359         case CS6:
 360                 buf[1] |= SET_UART_FORMAT_SIZE_6;
 361                 break;
 362         case CS7:
 363                 buf[1] |= SET_UART_FORMAT_SIZE_7;
 364                 break;
 365         default:
 366         case CS8:
 367                 buf[1] |= SET_UART_FORMAT_SIZE_8;
 368                 break;
 369         }
 370
 371         /* Set Stop bit2 : 0:1bit 1:2bit */
 372         buf[1] |= (cflag & CSTOPB) ? SET_UART_FORMAT_STOP_2 :
 373                                      SET_UART_FORMAT_STOP_1;
 374
 375         /* Set Parity bit3-4 01:Odd 11:Even */
 376         if (cflag & PARENB) {
 377                 buf[1] |= (cflag & PARODD) ?
 378                 SET_UART_FORMAT_PAR_ODD : SET_UART_FORMAT_PAR_EVEN ;
 379         } else {
 380                 buf[1] |= SET_UART_FORMAT_PAR_NONE;
 381         }
 382         uartdata = buf[0] | buf[1]<<8;
 383
 384         i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 385                             SET_UART_FORMAT_TYPE, SET_UART_FORMAT,
 386                             uartdata, 0, NULL, 0, 100);
 387         if (i < 0)
 388                 dev_err(&port->dev, "Set UART format %#x failed (error = %d)\n",
 389                         uartdata, i);
 390         dev_dbg(&port->dev, "0x21:0x40:0:0  %d\n", i);
 391
 392         if (cflag & CRTSCTS) {
 393                 /* enable hardware flow control */
 394                 spcp8x5_set_work_mode(port, 0x000a, SET_WORKING_MODE_U2C);
 395         }
 396 }
 397
 398 static int spcp8x5_open(struct tty_struct *tty, struct usb_serial_port *port)
 399 {
 400         struct usb_serial *serial = port->serial;
 401         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 402         int ret;
 403
 404         usb_clear_halt(serial->dev, port->write_urb->pipe);
 405         usb_clear_halt(serial->dev, port->read_urb->pipe);
 406
 407         ret = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 408                               0x09, 0x00,
 409                               0x01, 0x00, NULL, 0x00, 100);
 410         if (ret)
 411                 return ret;
 412
 413         spcp8x5_set_ctrl_line(port, priv->line_control);
 414
 415         if (tty)
 416                 spcp8x5_set_termios(tty, port, NULL);
 417
 418         return usb_serial_generic_open(tty, port);
 419 }
 420
 421 static int spcp8x5_tiocmset(struct tty_struct *tty,
 422                             unsigned int set, unsigned int clear)
 423 {
 424         struct usb_serial_port *port = tty->driver_data;
 425         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 426         unsigned long flags;
 427         u8 control;
 428
 429         spin_lock_irqsave(&priv->lock, flags);
 430         if (set & TIOCM_RTS)
 431                 priv->line_control |= MCR_RTS;
 432         if (set & TIOCM_DTR)
 433                 priv->line_control |= MCR_DTR;
 434         if (clear & TIOCM_RTS)
 435                 priv->line_control &= ~MCR_RTS;
 436         if (clear & TIOCM_DTR)
 437                 priv->line_control &= ~MCR_DTR;
 438         control = priv->line_control;
 439         spin_unlock_irqrestore(&priv->lock, flags);
 440
 441         return spcp8x5_set_ctrl_line(port, control);
 442 }
 443
 444 static int spcp8x5_tiocmget(struct tty_struct *tty)
 445 {
 446         struct usb_serial_port *port = tty->driver_data;
 447         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 448         unsigned long flags;
 449         unsigned int mcr;
 450         u8 status;
 451         unsigned int result;
 452
 453         result = spcp8x5_get_msr(port, &status);
 454         if (result)
 455                 return result;
 456
 457         spin_lock_irqsave(&priv->lock, flags);
 458         mcr = priv->line_control;
 459         spin_unlock_irqrestore(&priv->lock, flags);
 460
 461         result = ((mcr & MCR_DTR)                       ? TIOCM_DTR : 0)
 462                   | ((mcr & MCR_RTS)                    ? TIOCM_RTS : 0)
 463                   | ((status & MSR_STATUS_LINE_CTS)     ? TIOCM_CTS : 0)
 464                   | ((status & MSR_STATUS_LINE_DSR)     ? TIOCM_DSR : 0)
 465                   | ((status & MSR_STATUS_LINE_RI)      ? TIOCM_RI  : 0)
 466                   | ((status & MSR_STATUS_LINE_DCD)     ? TIOCM_CD  : 0);
 467
 468         return result;
 469 }
 470
 471 static struct usb_serial_driver spcp8x5_device = {
 472         .driver = {
 473                 .owner =        THIS_MODULE,
 474                 .name =         "SPCP8x5",
 475         },
 476         .id_table               = id_table,
 477         .num_ports              = 1,
 478         .num_bulk_in            = 1,
 479         .num_bulk_out           = 1,
 480         .open                   = spcp8x5_open,
 481         .dtr_rts                = spcp8x5_dtr_rts,
 482         .carrier_raised         = spcp8x5_carrier_raised,
 483         .set_termios            = spcp8x5_set_termios,
 484         .init_termios           = spcp8x5_init_termios,
 485         .tiocmget               = spcp8x5_tiocmget,
 486         .tiocmset               = spcp8x5_tiocmset,
 487         .probe                  = spcp8x5_probe,
 488         .port_probe             = spcp8x5_port_probe,
 489         .port_remove            = spcp8x5_port_remove,
 490 };
 491
 492 static struct usb_serial_driver * const serial_drivers[] = {
 493         &spcp8x5_device, NULL
 494 };
 495
 496 module_usb_serial_driver(serial_drivers, id_table);
 497
 498 MODULE_DESCRIPTION(DRIVER_DESC);
 499 MODULE_LICENSE("GPL");