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/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 SPCP825_QUIRK_NO_UART_STATUS    0x01
  32 #define SPCP825_QUIRK_NO_WORK_MODE      0x02
  33
  34 #define SPCP8x5_007_VID         0x04FC
  35 #define SPCP8x5_007_PID         0x0201
  36 #define SPCP8x5_008_VID         0x04fc
  37 #define SPCP8x5_008_PID         0x0235
  38 #define SPCP8x5_PHILIPS_VID     0x0471
  39 #define SPCP8x5_PHILIPS_PID     0x081e
  40 #define SPCP8x5_INTERMATIC_VID  0x04FC
  41 #define SPCP8x5_INTERMATIC_PID  0x0204
  42 #define SPCP8x5_835_VID         0x04fc
  43 #define SPCP8x5_835_PID         0x0231
  44
  45 static const struct usb_device_id id_table[] = {
  46         { USB_DEVICE(SPCP8x5_PHILIPS_VID , SPCP8x5_PHILIPS_PID)},
  47         { USB_DEVICE(SPCP8x5_INTERMATIC_VID, SPCP8x5_INTERMATIC_PID)},
  48         { USB_DEVICE(SPCP8x5_835_VID, SPCP8x5_835_PID)},
  49         { USB_DEVICE(SPCP8x5_008_VID, SPCP8x5_008_PID)},
  50         { USB_DEVICE(SPCP8x5_007_VID, SPCP8x5_007_PID),
  51           .driver_info = SPCP825_QUIRK_NO_UART_STATUS |
  52                                 SPCP825_QUIRK_NO_WORK_MODE },
  53         { }                                     /* Terminating entry */
  54 };
  55 MODULE_DEVICE_TABLE(usb, id_table);
  56
  57 struct spcp8x5_usb_ctrl_arg {
  58         u8      type;
  59         u8      cmd;
  60         u8      cmd_type;
  61         u16     value;
  62         u16     index;
  63         u16     length;
  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
 144 struct spcp8x5_private {
 145         unsigned                quirks;
 146         spinlock_t              lock;
 147         u8                      line_control;
 148 };
 149
 150 static int spcp8x5_probe(struct usb_serial *serial,
 151                                                 const struct usb_device_id *id)
 152 {
 153         usb_set_serial_data(serial, (void *)id);
 154
 155         return 0;
 156 }
 157
 158 static int spcp8x5_port_probe(struct usb_serial_port *port)
 159 {
 160         const struct usb_device_id *id = usb_get_serial_data(port->serial);
 161         struct spcp8x5_private *priv;
 162
 163         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
 164         if (!priv)
 165                 return -ENOMEM;
 166
 167         spin_lock_init(&priv->lock);
 168         priv->quirks = id->driver_info;
 169
 170         usb_set_serial_port_data(port, priv);
 171
 172         return 0;
 173 }
 174
 175 static int spcp8x5_port_remove(struct usb_serial_port *port)
 176 {
 177         struct spcp8x5_private *priv;
 178
 179         priv = usb_get_serial_port_data(port);
 180         kfree(priv);
 181
 182         return 0;
 183 }
 184
 185 static int spcp8x5_set_ctrl_line(struct usb_serial_port *port, u8 mcr)
 186 {
 187         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 188         struct usb_device *dev = port->serial->dev;
 189         int retval;
 190
 191         if (priv->quirks & SPCP825_QUIRK_NO_UART_STATUS)
 192                 return -EPERM;
 193
 194         retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 195                                  SET_UART_STATUS_TYPE, SET_UART_STATUS,
 196                                  mcr, 0x04, NULL, 0, 100);
 197         if (retval != 0) {
 198                 dev_err(&port->dev, "failed to set control lines: %d\n",
 199                                                                 retval);
 200         }
 201         return retval;
 202 }
 203
 204 static int spcp8x5_get_msr(struct usb_serial_port *port, u8 *status)
 205 {
 206         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 207         struct usb_device *dev = port->serial->dev;
 208         u8 *buf;
 209         int ret;
 210
 211         if (priv->quirks & SPCP825_QUIRK_NO_UART_STATUS)
 212                 return -EPERM;
 213
 214         buf = kzalloc(1, GFP_KERNEL);
 215         if (!buf)
 216                 return -ENOMEM;
 217
 218         ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 219                               GET_UART_STATUS, GET_UART_STATUS_TYPE,
 220                               0, GET_UART_STATUS_MSR, buf, 1, 100);
 221         if (ret < 0)
 222                 dev_err(&port->dev, "failed to get modem status: %d", ret);
 223
 224         dev_dbg(&port->dev, "0xc0:0x22:0:6  %d - 0x02%x", ret, *buf);
 225         *status = *buf;
 226         kfree(buf);
 227
 228         return ret;
 229 }
 230
 231 static void spcp8x5_set_work_mode(struct usb_serial_port *port, u16 value,
 232                                                                  u16 index)
 233 {
 234         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 235         struct usb_device *dev = port->serial->dev;
 236         int ret;
 237
 238         if (priv->quirks & SPCP825_QUIRK_NO_WORK_MODE)
 239                 return;
 240
 241         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 242                               SET_WORKING_MODE_TYPE, SET_WORKING_MODE,
 243                               value, index, NULL, 0, 100);
 244         dev_dbg(&port->dev, "value = %#x , index = %#x\n", value, index);
 245         if (ret < 0)
 246                 dev_err(&port->dev, "failed to set work mode: %d\n", ret);
 247 }
 248
 249 static int spcp8x5_carrier_raised(struct usb_serial_port *port)
 250 {
 251         u8 msr;
 252         int ret;
 253
 254         ret = spcp8x5_get_msr(port, &msr);
 255         if (ret || msr & MSR_STATUS_LINE_DCD)
 256                 return 1;
 257
 258         return 0;
 259 }
 260
 261 static void spcp8x5_dtr_rts(struct usb_serial_port *port, int on)
 262 {
 263         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 264         unsigned long flags;
 265         u8 control;
 266
 267         spin_lock_irqsave(&priv->lock, flags);
 268         if (on)
 269                 priv->line_control = MCR_CONTROL_LINE_DTR
 270                                                 | MCR_CONTROL_LINE_RTS;
 271         else
 272                 priv->line_control &= ~ (MCR_CONTROL_LINE_DTR
 273                                                 | MCR_CONTROL_LINE_RTS);
 274         control = priv->line_control;
 275         spin_unlock_irqrestore(&priv->lock, flags);
 276         spcp8x5_set_ctrl_line(port, control);
 277 }
 278
 279 static void spcp8x5_init_termios(struct tty_struct *tty)
 280 {
 281         tty->termios = tty_std_termios;
 282         tty->termios.c_cflag = B115200 | CS8 | CREAD | HUPCL | CLOCAL;
 283         tty->termios.c_ispeed = 115200;
 284         tty->termios.c_ospeed = 115200;
 285 }
 286
 287 static void spcp8x5_set_termios(struct tty_struct *tty,
 288                 struct usb_serial_port *port, struct ktermios *old_termios)
 289 {
 290         struct usb_serial *serial = port->serial;
 291         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 292         unsigned long flags;
 293         unsigned int cflag = tty->termios.c_cflag;
 294         unsigned int old_cflag = old_termios->c_cflag;
 295         unsigned short uartdata;
 296         unsigned char buf[2] = {0, 0};
 297         int baud;
 298         int i;
 299         u8 control;
 300
 301         /* check that they really want us to change something */
 302         if (!tty_termios_hw_change(&tty->termios, old_termios))
 303                 return;
 304
 305         /* set DTR/RTS active */
 306         spin_lock_irqsave(&priv->lock, flags);
 307         control = priv->line_control;
 308         if ((old_cflag & CBAUD) == B0) {
 309                 priv->line_control |= MCR_DTR;
 310                 if (!(old_cflag & CRTSCTS))
 311                         priv->line_control |= MCR_RTS;
 312         }
 313         if (control != priv->line_control) {
 314                 control = priv->line_control;
 315                 spin_unlock_irqrestore(&priv->lock, flags);
 316                 spcp8x5_set_ctrl_line(port, control);
 317         } else {
 318                 spin_unlock_irqrestore(&priv->lock, flags);
 319         }
 320
 321         /* Set Baud Rate */
 322         baud = tty_get_baud_rate(tty);
 323         switch (baud) {
 324         case 300:       buf[0] = 0x00;  break;
 325         case 600:       buf[0] = 0x01;  break;
 326         case 1200:      buf[0] = 0x02;  break;
 327         case 2400:      buf[0] = 0x03;  break;
 328         case 4800:      buf[0] = 0x04;  break;
 329         case 9600:      buf[0] = 0x05;  break;
 330         case 19200:     buf[0] = 0x07;  break;
 331         case 38400:     buf[0] = 0x09;  break;
 332         case 57600:     buf[0] = 0x0a;  break;
 333         case 115200:    buf[0] = 0x0b;  break;
 334         case 230400:    buf[0] = 0x0c;  break;
 335         case 460800:    buf[0] = 0x0d;  break;
 336         case 921600:    buf[0] = 0x0e;  break;
 337 /*      case 1200000:   buf[0] = 0x0f;  break; */
 338 /*      case 2400000:   buf[0] = 0x10;  break; */
 339         case 3000000:   buf[0] = 0x11;  break;
 340 /*      case 6000000:   buf[0] = 0x12;  break; */
 341         case 0:
 342         case 1000000:
 343                         buf[0] = 0x0b;  break;
 344         default:
 345                 dev_err(&port->dev, "spcp825 driver does not support the "
 346                         "baudrate requested, using default of 9600.\n");
 347         }
 348
 349         /* Set Data Length : 00:5bit, 01:6bit, 10:7bit, 11:8bit */
 350         if (cflag & CSIZE) {
 351                 switch (cflag & CSIZE) {
 352                 case CS5:
 353                         buf[1] |= SET_UART_FORMAT_SIZE_5;
 354                         break;
 355                 case CS6:
 356                         buf[1] |= SET_UART_FORMAT_SIZE_6;
 357                         break;
 358                 case CS7:
 359                         buf[1] |= SET_UART_FORMAT_SIZE_7;
 360                         break;
 361                 default:
 362                 case CS8:
 363                         buf[1] |= SET_UART_FORMAT_SIZE_8;
 364                         break;
 365                 }
 366         }
 367
 368         /* Set Stop bit2 : 0:1bit 1:2bit */
 369         buf[1] |= (cflag & CSTOPB) ? SET_UART_FORMAT_STOP_2 :
 370                                      SET_UART_FORMAT_STOP_1;
 371
 372         /* Set Parity bit3-4 01:Odd 11:Even */
 373         if (cflag & PARENB) {
 374                 buf[1] |= (cflag & PARODD) ?
 375                 SET_UART_FORMAT_PAR_ODD : SET_UART_FORMAT_PAR_EVEN ;
 376         } else {
 377                 buf[1] |= SET_UART_FORMAT_PAR_NONE;
 378         }
 379         uartdata = buf[0] | buf[1]<<8;
 380
 381         i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 382                             SET_UART_FORMAT_TYPE, SET_UART_FORMAT,
 383                             uartdata, 0, NULL, 0, 100);
 384         if (i < 0)
 385                 dev_err(&port->dev, "Set UART format %#x failed (error = %d)\n",
 386                         uartdata, i);
 387         dev_dbg(&port->dev, "0x21:0x40:0:0  %d\n", i);
 388
 389         if (cflag & CRTSCTS) {
 390                 /* enable hardware flow control */
 391                 spcp8x5_set_work_mode(port, 0x000a, SET_WORKING_MODE_U2C);
 392         }
 393 }
 394
 395 static int spcp8x5_open(struct tty_struct *tty, struct usb_serial_port *port)
 396 {
 397         struct ktermios tmp_termios;
 398         struct usb_serial *serial = port->serial;
 399         struct spcp8x5_private *priv = usb_get_serial_port_data(port);
 400         int ret;
 401
 402         usb_clear_halt(serial->dev, port->write_urb->pipe);
 403         usb_clear_halt(serial->dev, port->read_urb->pipe);
 404
 405         ret = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 406                               0x09, 0x00,
 407                               0x01, 0x00, NULL, 0x00, 100);
 408         if (ret)
 409                 return ret;
 410
 411         spcp8x5_set_ctrl_line(port, priv->line_control);
 412
 413         if (tty)
 414                 spcp8x5_set_termios(tty, port, &tmp_termios);
 415
 416         port->port.drain_delay = 256;
 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         .open                   = spcp8x5_open,
 479         .dtr_rts                = spcp8x5_dtr_rts,
 480         .carrier_raised         = spcp8x5_carrier_raised,
 481         .set_termios            = spcp8x5_set_termios,
 482         .init_termios           = spcp8x5_init_termios,
 483         .tiocmget               = spcp8x5_tiocmget,
 484         .tiocmset               = spcp8x5_tiocmset,
 485         .probe                  = spcp8x5_probe,
 486         .port_probe             = spcp8x5_port_probe,
 487         .port_remove            = spcp8x5_port_remove,
 488 };
 489
 490 static struct usb_serial_driver * const serial_drivers[] = {
 491         &spcp8x5_device, NULL
 492 };
 493
 494 module_usb_serial_driver(serial_drivers, id_table);
 495
 496 MODULE_DESCRIPTION(DRIVER_DESC);
 497 MODULE_LICENSE("GPL");