drivers/usb/serial/quatech2.c

   1 /*
   2  * usb-serial driver for Quatech USB 2 devices
   3  *
   4  * Copyright (C) 2012 Bill Pemberton (wfp5p@virginia.edu)
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License version 2
   8  * as published by the Free Software Foundation.
   9  *
  10  *
  11  *  These devices all have only 1 bulk in and 1 bulk out that is shared
  12  *  for all serial ports.
  13  *
  14  */
  15
  16 #include <asm/unaligned.h>
  17 #include <linux/errno.h>
  18 #include <linux/slab.h>
  19 #include <linux/tty.h>
  20 #include <linux/tty_driver.h>
  21 #include <linux/tty_flip.h>
  22 #include <linux/module.h>
  23 #include <linux/serial.h>
  24 #include <linux/usb.h>
  25 #include <linux/usb/serial.h>
  26 #include <linux/serial_reg.h>
  27 #include <linux/uaccess.h>
  28
  29 /* default urb timeout for usb operations */
  30 #define QT2_USB_TIMEOUT USB_CTRL_SET_TIMEOUT
  31
  32 #define QT_OPEN_CLOSE_CHANNEL       0xca
  33 #define QT_SET_GET_DEVICE           0xc2
  34 #define QT_SET_GET_REGISTER         0xc0
  35 #define QT_GET_SET_PREBUF_TRIG_LVL  0xcc
  36 #define QT_SET_ATF                  0xcd
  37 #define QT_TRANSFER_IN              0xc0
  38 #define QT_HW_FLOW_CONTROL_MASK     0xc5
  39 #define QT_SW_FLOW_CONTROL_MASK     0xc6
  40 #define QT2_BREAK_CONTROL           0xc8
  41 #define QT2_GET_SET_UART            0xc1
  42 #define QT2_FLUSH_DEVICE            0xc4
  43 #define QT2_GET_SET_QMCR            0xe1
  44 #define QT2_QMCR_RS232              0x40
  45 #define QT2_QMCR_RS422              0x10
  46
  47 #define  SERIAL_CRTSCTS ((UART_MCR_RTS << 8) | UART_MSR_CTS)
  48
  49 #define  SERIAL_EVEN_PARITY         (UART_LCR_PARITY | UART_LCR_EPAR)
  50
  51 /* status bytes for the device */
  52 #define QT2_CONTROL_BYTE    0x1b
  53 #define QT2_LINE_STATUS     0x00  /* following 1 byte is line status */
  54 #define QT2_MODEM_STATUS    0x01  /* following 1 byte is modem status */
  55 #define QT2_XMIT_HOLD       0x02  /* following 2 bytes are ?? */
  56 #define QT2_CHANGE_PORT     0x03  /* following 1 byte is port to change to */
  57 #define QT2_REC_FLUSH       0x04  /* no following info */
  58 #define QT2_XMIT_FLUSH      0x05  /* no following info */
  59 #define QT2_CONTROL_ESCAPE  0xff  /* pass through previous 2 control bytes */
  60
  61 #define  MAX_BAUD_RATE              921600
  62 #define  DEFAULT_BAUD_RATE          9600
  63
  64 #define QT2_READ_BUFFER_SIZE    512  /* size of read buffer */
  65 #define QT2_WRITE_BUFFER_SIZE   512  /* size of write buffer */
  66 #define QT2_WRITE_CONTROL_SIZE  5    /* control bytes used for a write */
  67
  68 #define DRIVER_DESC "Quatech 2nd gen USB to Serial Driver"
  69
  70 #define USB_VENDOR_ID_QUATECH   0x061d
  71 #define QUATECH_SSU2_100        0xC120  /* RS232 single port */
  72 #define QUATECH_DSU2_100        0xC140  /* RS232 dual port */
  73 #define QUATECH_DSU2_400        0xC150  /* RS232/422/485 dual port */
  74 #define QUATECH_QSU2_100        0xC160  /* RS232 four port */
  75 #define QUATECH_QSU2_400        0xC170  /* RS232/422/485 four port */
  76 #define QUATECH_ESU2_100        0xC1A0  /* RS232 eight port */
  77 #define QUATECH_ESU2_400        0xC180  /* RS232/422/485 eight port */
  78
  79 struct qt2_device_detail {
  80         int product_id;
  81         int num_ports;
  82 };
  83
  84 #define QT_DETAILS(prod, ports) \
  85         .product_id = (prod),   \
  86         .num_ports = (ports)
  87
  88 static const struct qt2_device_detail qt2_device_details[] = {
  89         {QT_DETAILS(QUATECH_SSU2_100, 1)},
  90         {QT_DETAILS(QUATECH_DSU2_400, 2)},
  91         {QT_DETAILS(QUATECH_DSU2_100, 2)},
  92         {QT_DETAILS(QUATECH_QSU2_400, 4)},
  93         {QT_DETAILS(QUATECH_QSU2_100, 4)},
  94         {QT_DETAILS(QUATECH_ESU2_400, 8)},
  95         {QT_DETAILS(QUATECH_ESU2_100, 8)},
  96         {QT_DETAILS(0, 0)}      /* Terminating entry */
  97 };
  98
  99 static const struct usb_device_id id_table[] = {
 100         {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_SSU2_100)},
 101         {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU2_100)},
 102         {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU2_400)},
 103         {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU2_100)},
 104         {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU2_400)},
 105         {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU2_100)},
 106         {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU2_400)},
 107         {}                      /* Terminating entry */
 108 };
 109 MODULE_DEVICE_TABLE(usb, id_table);
 110
 111 struct qt2_serial_private {
 112         unsigned char current_port;  /* current port for incoming data */
 113
 114         struct urb      *read_urb;   /* shared among all ports */
 115         char            *read_buffer;
 116 };
 117
 118 struct qt2_port_private {
 119         u8   device_port;
 120
 121         spinlock_t urb_lock;
 122         bool       urb_in_use;
 123         struct urb *write_urb;
 124         char       *write_buffer;
 125
 126         spinlock_t  lock;
 127         u8          shadowLSR;
 128         u8          shadowMSR;
 129
 130         struct usb_serial_port *port;
 131 };
 132
 133 static void qt2_update_lsr(struct usb_serial_port *port, unsigned char *ch);
 134 static void qt2_update_msr(struct usb_serial_port *port, unsigned char *ch);
 135 static void qt2_write_bulk_callback(struct urb *urb);
 136 static void qt2_read_bulk_callback(struct urb *urb);
 137
 138 static void qt2_release(struct usb_serial *serial)
 139 {
 140         struct qt2_serial_private *serial_priv;
 141
 142         serial_priv = usb_get_serial_data(serial);
 143
 144         usb_kill_urb(serial_priv->read_urb);
 145         usb_free_urb(serial_priv->read_urb);
 146         kfree(serial_priv->read_buffer);
 147         kfree(serial_priv);
 148 }
 149
 150 static inline int calc_baud_divisor(int baudrate)
 151 {
 152         int divisor, rem;
 153
 154         divisor = MAX_BAUD_RATE / baudrate;
 155         rem = MAX_BAUD_RATE % baudrate;
 156         /* Round to nearest divisor */
 157         if (((rem * 2) >= baudrate) && (baudrate != 110))
 158                 divisor++;
 159
 160         return divisor;
 161 }
 162
 163 static inline int qt2_set_port_config(struct usb_device *dev,
 164                                       unsigned char port_number,
 165                                       u16 baudrate, u16 lcr)
 166 {
 167         int divisor = calc_baud_divisor(baudrate);
 168         u16 index = ((u16) (lcr << 8) | (u16) (port_number));
 169
 170         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 171                                QT2_GET_SET_UART, 0x40,
 172                                divisor, index, NULL, 0, QT2_USB_TIMEOUT);
 173 }
 174
 175 static inline int qt2_control_msg(struct usb_device *dev,
 176                                   u8 request, u16 data, u16 index)
 177 {
 178         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 179                                request, 0x40, data, index,
 180                                NULL, 0, QT2_USB_TIMEOUT);
 181 }
 182
 183 static inline int qt2_setdevice(struct usb_device *dev, u8 *data)
 184 {
 185         u16 x = ((u16) (data[1] << 8) | (u16) (data[0]));
 186
 187         return qt2_control_msg(dev, QT_SET_GET_DEVICE, x, 0);
 188 }
 189
 190
 191 static inline int qt2_getdevice(struct usb_device *dev, u8 *data)
 192 {
 193         return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 194                                QT_SET_GET_DEVICE, 0xc0, 0, 0,
 195                                data, 3, QT2_USB_TIMEOUT);
 196 }
 197
 198 static inline int qt2_getregister(struct usb_device *dev,
 199                                   u8 uart,
 200                                   u8 reg,
 201                                   u8 *data)
 202 {
 203         return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 204                                QT_SET_GET_REGISTER, 0xc0, reg,
 205                                uart, data, sizeof(*data), QT2_USB_TIMEOUT);
 206
 207 }
 208
 209 static inline int qt2_setregister(struct usb_device *dev,
 210                                   u8 uart, u8 reg, u16 data)
 211 {
 212         u16 value = (data << 8) | reg;
 213
 214         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 215                                QT_SET_GET_REGISTER, 0x40, value, uart,
 216                                NULL, 0, QT2_USB_TIMEOUT);
 217 }
 218
 219 static inline int update_mctrl(struct qt2_port_private *port_priv,
 220                                unsigned int set, unsigned int clear)
 221 {
 222         struct usb_serial_port *port = port_priv->port;
 223         struct usb_device *dev = port->serial->dev;
 224         unsigned urb_value;
 225         int status;
 226
 227         if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
 228                 dev_dbg(&port->dev,
 229                         "update_mctrl - DTR|RTS not being set|cleared\n");
 230                 return 0;       /* no change */
 231         }
 232
 233         clear &= ~set;  /* 'set' takes precedence over 'clear' */
 234         urb_value = 0;
 235         if (set & TIOCM_DTR)
 236                 urb_value |= UART_MCR_DTR;
 237         if (set & TIOCM_RTS)
 238                 urb_value |= UART_MCR_RTS;
 239
 240         status = qt2_setregister(dev, port_priv->device_port, UART_MCR,
 241                                  urb_value);
 242         if (status < 0)
 243                 dev_err(&port->dev,
 244                         "update_mctrl - Error from MODEM_CTRL urb: %i\n",
 245                         status);
 246         return status;
 247 }
 248
 249 static int qt2_calc_num_ports(struct usb_serial *serial)
 250 {
 251         struct qt2_device_detail d;
 252         int i;
 253
 254         for (i = 0; d = qt2_device_details[i], d.product_id != 0; i++) {
 255                 if (d.product_id == le16_to_cpu(serial->dev->descriptor.idProduct))
 256                         return d.num_ports;
 257         }
 258
 259         /* we didn't recognize the device */
 260         dev_err(&serial->dev->dev,
 261                  "don't know the number of ports, assuming 1\n");
 262
 263         return 1;
 264 }
 265
 266 static void qt2_set_termios(struct tty_struct *tty,
 267                             struct usb_serial_port *port,
 268                             struct ktermios *old_termios)
 269 {
 270         struct usb_device *dev = port->serial->dev;
 271         struct qt2_port_private *port_priv;
 272         struct ktermios *termios = &tty->termios;
 273         u16 baud;
 274         unsigned int cflag = termios->c_cflag;
 275         u16 new_lcr = 0;
 276         int status;
 277
 278         port_priv = usb_get_serial_port_data(port);
 279
 280         if (cflag & PARENB) {
 281                 if (cflag & PARODD)
 282                         new_lcr |= UART_LCR_PARITY;
 283                 else
 284                         new_lcr |= SERIAL_EVEN_PARITY;
 285         }
 286
 287         switch (cflag & CSIZE) {
 288         case CS5:
 289                 new_lcr |= UART_LCR_WLEN5;
 290                 break;
 291         case CS6:
 292                 new_lcr |= UART_LCR_WLEN6;
 293                 break;
 294         case CS7:
 295                 new_lcr |= UART_LCR_WLEN7;
 296                 break;
 297         default:
 298         case CS8:
 299                 new_lcr |= UART_LCR_WLEN8;
 300                 break;
 301         }
 302
 303         baud = tty_get_baud_rate(tty);
 304         if (!baud)
 305                 baud = 9600;
 306
 307         status = qt2_set_port_config(dev, port_priv->device_port, baud,
 308                                      new_lcr);
 309         if (status < 0)
 310                 dev_err(&port->dev, "%s - qt2_set_port_config failed: %i\n",
 311                         __func__, status);
 312
 313         if (cflag & CRTSCTS)
 314                 status = qt2_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
 315                                          SERIAL_CRTSCTS,
 316                                          port_priv->device_port);
 317         else
 318                 status = qt2_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
 319                                          0, port_priv->device_port);
 320         if (status < 0)
 321                 dev_err(&port->dev, "%s - set HW flow control failed: %i\n",
 322                         __func__, status);
 323
 324         if (I_IXOFF(tty) || I_IXON(tty)) {
 325                 u16 x = ((u16) (START_CHAR(tty) << 8) | (u16) (STOP_CHAR(tty)));
 326
 327                 status = qt2_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
 328                                          x, port_priv->device_port);
 329         } else
 330                 status = qt2_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
 331                                          0, port_priv->device_port);
 332
 333         if (status < 0)
 334                 dev_err(&port->dev, "%s - set SW flow control failed: %i\n",
 335                         __func__, status);
 336
 337 }
 338
 339 static int qt2_open(struct tty_struct *tty, struct usb_serial_port *port)
 340 {
 341         struct usb_serial *serial;
 342         struct qt2_port_private *port_priv;
 343         u8 *data;
 344         u16 device_port;
 345         int status;
 346         unsigned long flags;
 347
 348         device_port = port->port_number;
 349
 350         serial = port->serial;
 351
 352         port_priv = usb_get_serial_port_data(port);
 353
 354         /* set the port to RS232 mode */
 355         status = qt2_control_msg(serial->dev, QT2_GET_SET_QMCR,
 356                                  QT2_QMCR_RS232, device_port);
 357         if (status < 0) {
 358                 dev_err(&port->dev,
 359                         "%s failed to set RS232 mode for port %i error %i\n",
 360                         __func__, device_port, status);
 361                 return status;
 362         }
 363
 364         data = kzalloc(2, GFP_KERNEL);
 365         if (!data)
 366                 return -ENOMEM;
 367
 368         /* open the port */
 369         status = usb_control_msg(serial->dev,
 370                                  usb_rcvctrlpipe(serial->dev, 0),
 371                                  QT_OPEN_CLOSE_CHANNEL,
 372                                  0xc0, 0,
 373                                  device_port, data, 2, QT2_USB_TIMEOUT);
 374
 375         if (status < 0) {
 376                 dev_err(&port->dev, "%s - open port failed %i\n", __func__,
 377                         status);
 378                 kfree(data);
 379                 return status;
 380         }
 381
 382         spin_lock_irqsave(&port_priv->lock, flags);
 383         port_priv->shadowLSR = data[0];
 384         port_priv->shadowMSR = data[1];
 385         spin_unlock_irqrestore(&port_priv->lock, flags);
 386
 387         kfree(data);
 388
 389         /* set to default speed and 8bit word size */
 390         status = qt2_set_port_config(serial->dev, device_port,
 391                                      DEFAULT_BAUD_RATE, UART_LCR_WLEN8);
 392         if (status < 0) {
 393                 dev_err(&port->dev, "%s - initial setup failed (%i)\n",
 394                         __func__, device_port);
 395                 return status;
 396         }
 397
 398         port_priv->device_port = (u8) device_port;
 399
 400         if (tty)
 401                 qt2_set_termios(tty, port, &tty->termios);
 402
 403         return 0;
 404
 405 }
 406
 407 static void qt2_close(struct usb_serial_port *port)
 408 {
 409         struct usb_serial *serial;
 410         struct qt2_port_private *port_priv;
 411         int i;
 412
 413         serial = port->serial;
 414         port_priv = usb_get_serial_port_data(port);
 415
 416         usb_kill_urb(port_priv->write_urb);
 417
 418         /* flush the port transmit buffer */
 419         i = usb_control_msg(serial->dev,
 420                             usb_rcvctrlpipe(serial->dev, 0),
 421                             QT2_FLUSH_DEVICE, 0x40, 1,
 422                             port_priv->device_port, NULL, 0, QT2_USB_TIMEOUT);
 423
 424         if (i < 0)
 425                 dev_err(&port->dev, "%s - transmit buffer flush failed: %i\n",
 426                         __func__, i);
 427
 428         /* flush the port receive buffer */
 429         i = usb_control_msg(serial->dev,
 430                             usb_rcvctrlpipe(serial->dev, 0),
 431                             QT2_FLUSH_DEVICE, 0x40, 0,
 432                             port_priv->device_port, NULL, 0, QT2_USB_TIMEOUT);
 433
 434         if (i < 0)
 435                 dev_err(&port->dev, "%s - receive buffer flush failed: %i\n",
 436                         __func__, i);
 437
 438         /* close the port */
 439         i = usb_control_msg(serial->dev,
 440                             usb_sndctrlpipe(serial->dev, 0),
 441                             QT_OPEN_CLOSE_CHANNEL,
 442                             0x40, 0,
 443                             port_priv->device_port, NULL, 0, QT2_USB_TIMEOUT);
 444
 445         if (i < 0)
 446                 dev_err(&port->dev, "%s - close port failed %i\n",
 447                         __func__, i);
 448 }
 449
 450 static void qt2_disconnect(struct usb_serial *serial)
 451 {
 452         struct qt2_serial_private *serial_priv = usb_get_serial_data(serial);
 453
 454         usb_kill_urb(serial_priv->read_urb);
 455 }
 456
 457 static int get_serial_info(struct usb_serial_port *port,
 458                            struct serial_struct __user *retinfo)
 459 {
 460         struct serial_struct tmp;
 461
 462         memset(&tmp, 0, sizeof(tmp));
 463         tmp.line                = port->minor;
 464         tmp.port                = 0;
 465         tmp.irq                 = 0;
 466         tmp.flags               = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
 467         tmp.xmit_fifo_size      = port->bulk_out_size;
 468         tmp.baud_base           = 9600;
 469         tmp.close_delay         = 5*HZ;
 470         tmp.closing_wait        = 30*HZ;
 471
 472         if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
 473                 return -EFAULT;
 474         return 0;
 475 }
 476
 477 static int qt2_ioctl(struct tty_struct *tty,
 478                      unsigned int cmd, unsigned long arg)
 479 {
 480         struct usb_serial_port *port = tty->driver_data;
 481
 482         switch (cmd) {
 483         case TIOCGSERIAL:
 484                 return get_serial_info(port,
 485                                        (struct serial_struct __user *)arg);
 486         default:
 487                 break;
 488         }
 489
 490         return -ENOIOCTLCMD;
 491 }
 492
 493 static void qt2_process_status(struct usb_serial_port *port, unsigned char *ch)
 494 {
 495         switch (*ch) {
 496         case QT2_LINE_STATUS:
 497                 qt2_update_lsr(port, ch + 1);
 498                 break;
 499         case QT2_MODEM_STATUS:
 500                 qt2_update_msr(port, ch + 1);
 501                 break;
 502         }
 503 }
 504
 505 /* not needed, kept to document functionality */
 506 static void qt2_process_xmit_empty(struct usb_serial_port *port,
 507                                    unsigned char *ch)
 508 {
 509         int bytes_written;
 510
 511         bytes_written = (int)(*ch) + (int)(*(ch + 1) << 4);
 512 }
 513
 514 /* not needed, kept to document functionality */
 515 static void qt2_process_flush(struct usb_serial_port *port, unsigned char *ch)
 516 {
 517         return;
 518 }
 519
 520 static void qt2_process_read_urb(struct urb *urb)
 521 {
 522         struct usb_serial *serial;
 523         struct qt2_serial_private *serial_priv;
 524         struct usb_serial_port *port;
 525         struct qt2_port_private *port_priv;
 526         bool escapeflag;
 527         unsigned char *ch;
 528         int i;
 529         unsigned char newport;
 530         int len = urb->actual_length;
 531
 532         if (!len)
 533                 return;
 534
 535         ch = urb->transfer_buffer;
 536         serial = urb->context;
 537         serial_priv = usb_get_serial_data(serial);
 538         port = serial->port[serial_priv->current_port];
 539         port_priv = usb_get_serial_port_data(port);
 540
 541         for (i = 0; i < urb->actual_length; i++) {
 542                 ch = (unsigned char *)urb->transfer_buffer + i;
 543                 if ((i <= (len - 3)) &&
 544                     (*ch == QT2_CONTROL_BYTE) &&
 545                     (*(ch + 1) == QT2_CONTROL_BYTE)) {
 546                         escapeflag = false;
 547                         switch (*(ch + 2)) {
 548                         case QT2_LINE_STATUS:
 549                         case QT2_MODEM_STATUS:
 550                                 if (i > (len - 4)) {
 551                                         dev_warn(&port->dev,
 552                                                  "%s - status message too short\n",
 553                                                 __func__);
 554                                         break;
 555                                 }
 556                                 qt2_process_status(port, ch + 2);
 557                                 i += 3;
 558                                 escapeflag = true;
 559                                 break;
 560                         case QT2_XMIT_HOLD:
 561                                 if (i > (len - 5)) {
 562                                         dev_warn(&port->dev,
 563                                                  "%s - xmit_empty message too short\n",
 564                                                  __func__);
 565                                         break;
 566                                 }
 567                                 qt2_process_xmit_empty(port, ch + 3);
 568                                 i += 4;
 569                                 escapeflag = true;
 570                                 break;
 571                         case QT2_CHANGE_PORT:
 572                                 if (i > (len - 4)) {
 573                                         dev_warn(&port->dev,
 574                                                  "%s - change_port message too short\n",
 575                                                  __func__);
 576                                         break;
 577                                 }
 578                                 tty_flip_buffer_push(&port->port);
 579
 580                                 newport = *(ch + 3);
 581
 582                                 if (newport > serial->num_ports) {
 583                                         dev_err(&port->dev,
 584                                                 "%s - port change to invalid port: %i\n",
 585                                                 __func__, newport);
 586                                         break;
 587                                 }
 588
 589                                 serial_priv->current_port = newport;
 590                                 port = serial->port[serial_priv->current_port];
 591                                 port_priv = usb_get_serial_port_data(port);
 592                                 i += 3;
 593                                 escapeflag = true;
 594                                 break;
 595                         case QT2_REC_FLUSH:
 596                         case QT2_XMIT_FLUSH:
 597                                 qt2_process_flush(port, ch + 2);
 598                                 i += 2;
 599                                 escapeflag = true;
 600                                 break;
 601                         case QT2_CONTROL_ESCAPE:
 602                                 tty_buffer_request_room(&port->port, 2);
 603                                 tty_insert_flip_string(&port->port, ch, 2);
 604                                 i += 2;
 605                                 escapeflag = true;
 606                                 break;
 607                         default:
 608                                 dev_warn(&port->dev,
 609                                          "%s - unsupported command %i\n",
 610                                          __func__, *(ch + 2));
 611                                 break;
 612                         }
 613                         if (escapeflag)
 614                                 continue;
 615                 }
 616
 617                 tty_buffer_request_room(&port->port, 1);
 618                 tty_insert_flip_string(&port->port, ch, 1);
 619         }
 620
 621         tty_flip_buffer_push(&port->port);
 622 }
 623
 624 static void qt2_write_bulk_callback(struct urb *urb)
 625 {
 626         struct usb_serial_port *port;
 627         struct qt2_port_private *port_priv;
 628
 629         port = urb->context;
 630         port_priv = usb_get_serial_port_data(port);
 631
 632         spin_lock(&port_priv->urb_lock);
 633
 634         port_priv->urb_in_use = false;
 635         usb_serial_port_softint(port);
 636
 637         spin_unlock(&port_priv->urb_lock);
 638
 639 }
 640
 641 static void qt2_read_bulk_callback(struct urb *urb)
 642 {
 643         struct usb_serial *serial = urb->context;
 644         int status;
 645
 646         if (urb->status) {
 647                 dev_warn(&serial->dev->dev,
 648                          "%s - non-zero urb status: %i\n", __func__,
 649                          urb->status);
 650                 return;
 651         }
 652
 653         qt2_process_read_urb(urb);
 654
 655         status = usb_submit_urb(urb, GFP_ATOMIC);
 656         if (status != 0)
 657                 dev_err(&serial->dev->dev,
 658                         "%s - resubmit read urb failed: %i\n",
 659                         __func__, status);
 660 }
 661
 662 static int qt2_setup_urbs(struct usb_serial *serial)
 663 {
 664         struct usb_serial_port *port0;
 665         struct qt2_serial_private *serial_priv;
 666         int status;
 667
 668         port0 = serial->port[0];
 669
 670         serial_priv = usb_get_serial_data(serial);
 671         serial_priv->read_urb = usb_alloc_urb(0, GFP_KERNEL);
 672         if (!serial_priv->read_urb)
 673                 return -ENOMEM;
 674
 675         usb_fill_bulk_urb(serial_priv->read_urb, serial->dev,
 676                           usb_rcvbulkpipe(serial->dev,
 677                                           port0->bulk_in_endpointAddress),
 678                           serial_priv->read_buffer,
 679                           QT2_READ_BUFFER_SIZE,
 680                           qt2_read_bulk_callback, serial);
 681
 682         status = usb_submit_urb(serial_priv->read_urb, GFP_KERNEL);
 683         if (status != 0) {
 684                 dev_err(&serial->dev->dev,
 685                         "%s - submit read urb failed %i\n", __func__, status);
 686                 usb_free_urb(serial_priv->read_urb);
 687                 return status;
 688         }
 689
 690         return 0;
 691 }
 692
 693 static int qt2_attach(struct usb_serial *serial)
 694 {
 695         struct qt2_serial_private *serial_priv;
 696         int status;
 697
 698         /* power on unit */
 699         status = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 700                                  0xc2, 0x40, 0x8000, 0, NULL, 0,
 701                                  QT2_USB_TIMEOUT);
 702         if (status < 0) {
 703                 dev_err(&serial->dev->dev,
 704                         "%s - failed to power on unit: %i\n", __func__, status);
 705                 return status;
 706         }
 707
 708         serial_priv = kzalloc(sizeof(*serial_priv), GFP_KERNEL);
 709         if (!serial_priv)
 710                 return -ENOMEM;
 711
 712         serial_priv->read_buffer = kmalloc(QT2_READ_BUFFER_SIZE, GFP_KERNEL);
 713         if (!serial_priv->read_buffer) {
 714                 status = -ENOMEM;
 715                 goto err_buf;
 716         }
 717
 718         usb_set_serial_data(serial, serial_priv);
 719
 720         status = qt2_setup_urbs(serial);
 721         if (status != 0)
 722                 goto attach_failed;
 723
 724         return 0;
 725
 726 attach_failed:
 727         kfree(serial_priv->read_buffer);
 728 err_buf:
 729         kfree(serial_priv);
 730         return status;
 731 }
 732
 733 static int qt2_port_probe(struct usb_serial_port *port)
 734 {
 735         struct usb_serial *serial = port->serial;
 736         struct qt2_port_private *port_priv;
 737         u8 bEndpointAddress;
 738
 739         port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
 740         if (!port_priv)
 741                 return -ENOMEM;
 742
 743         spin_lock_init(&port_priv->lock);
 744         spin_lock_init(&port_priv->urb_lock);
 745         port_priv->port = port;
 746
 747         port_priv->write_buffer = kmalloc(QT2_WRITE_BUFFER_SIZE, GFP_KERNEL);
 748         if (!port_priv->write_buffer)
 749                 goto err_buf;
 750
 751         port_priv->write_urb = usb_alloc_urb(0, GFP_KERNEL);
 752         if (!port_priv->write_urb)
 753                 goto err_urb;
 754
 755         bEndpointAddress = serial->port[0]->bulk_out_endpointAddress;
 756         usb_fill_bulk_urb(port_priv->write_urb, serial->dev,
 757                                 usb_sndbulkpipe(serial->dev, bEndpointAddress),
 758                                 port_priv->write_buffer,
 759                                 QT2_WRITE_BUFFER_SIZE,
 760                                 qt2_write_bulk_callback, port);
 761
 762         usb_set_serial_port_data(port, port_priv);
 763
 764         return 0;
 765 err_urb:
 766         kfree(port_priv->write_buffer);
 767 err_buf:
 768         kfree(port_priv);
 769         return -ENOMEM;
 770 }
 771
 772 static int qt2_port_remove(struct usb_serial_port *port)
 773 {
 774         struct qt2_port_private *port_priv;
 775
 776         port_priv = usb_get_serial_port_data(port);
 777         usb_free_urb(port_priv->write_urb);
 778         kfree(port_priv->write_buffer);
 779         kfree(port_priv);
 780
 781         return 0;
 782 }
 783
 784 static int qt2_tiocmget(struct tty_struct *tty)
 785 {
 786         struct usb_serial_port *port = tty->driver_data;
 787         struct usb_device *dev = port->serial->dev;
 788         struct qt2_port_private *port_priv = usb_get_serial_port_data(port);
 789         u8 *d;
 790         int r;
 791
 792         d = kzalloc(2, GFP_KERNEL);
 793         if (!d)
 794                 return -ENOMEM;
 795
 796         r = qt2_getregister(dev, port_priv->device_port, UART_MCR, d);
 797         if (r < 0)
 798                 goto mget_out;
 799
 800         r = qt2_getregister(dev, port_priv->device_port, UART_MSR, d + 1);
 801         if (r < 0)
 802                 goto mget_out;
 803
 804         r = (d[0] & UART_MCR_DTR ? TIOCM_DTR : 0) |
 805             (d[0] & UART_MCR_RTS ? TIOCM_RTS : 0) |
 806             (d[1] & UART_MSR_CTS ? TIOCM_CTS : 0) |
 807             (d[1] & UART_MSR_DCD ? TIOCM_CAR : 0) |
 808             (d[1] & UART_MSR_RI ? TIOCM_RI : 0) |
 809             (d[1] & UART_MSR_DSR ? TIOCM_DSR : 0);
 810
 811 mget_out:
 812         kfree(d);
 813         return r;
 814 }
 815
 816 static int qt2_tiocmset(struct tty_struct *tty,
 817                         unsigned int set, unsigned int clear)
 818 {
 819         struct qt2_port_private *port_priv;
 820
 821         port_priv = usb_get_serial_port_data(tty->driver_data);
 822         return update_mctrl(port_priv, set, clear);
 823 }
 824
 825 static void qt2_break_ctl(struct tty_struct *tty, int break_state)
 826 {
 827         struct usb_serial_port *port = tty->driver_data;
 828         struct qt2_port_private *port_priv;
 829         int status;
 830         u16 val;
 831
 832         port_priv = usb_get_serial_port_data(port);
 833
 834         val = (break_state == -1) ? 1 : 0;
 835
 836         status = qt2_control_msg(port->serial->dev, QT2_BREAK_CONTROL,
 837                                  val, port_priv->device_port);
 838         if (status < 0)
 839                 dev_warn(&port->dev,
 840                          "%s - failed to send control message: %i\n", __func__,
 841                          status);
 842 }
 843
 844
 845
 846 static void qt2_dtr_rts(struct usb_serial_port *port, int on)
 847 {
 848         struct usb_device *dev = port->serial->dev;
 849         struct qt2_port_private *port_priv = usb_get_serial_port_data(port);
 850
 851         /* Disable flow control */
 852         if (!on) {
 853                 if (qt2_setregister(dev, port_priv->device_port,
 854                                            UART_MCR, 0) < 0)
 855                         dev_warn(&port->dev, "error from flowcontrol urb\n");
 856         }
 857         /* drop RTS and DTR */
 858         if (on)
 859                 update_mctrl(port_priv, TIOCM_DTR | TIOCM_RTS, 0);
 860         else
 861                 update_mctrl(port_priv, 0, TIOCM_DTR | TIOCM_RTS);
 862 }
 863
 864 static void qt2_update_msr(struct usb_serial_port *port, unsigned char *ch)
 865 {
 866         struct qt2_port_private *port_priv;
 867         u8 newMSR = (u8) *ch;
 868         unsigned long flags;
 869
 870         port_priv = usb_get_serial_port_data(port);
 871
 872         spin_lock_irqsave(&port_priv->lock, flags);
 873         port_priv->shadowMSR = newMSR;
 874         spin_unlock_irqrestore(&port_priv->lock, flags);
 875
 876         if (newMSR & UART_MSR_ANY_DELTA) {
 877                 /* update input line counters */
 878                 if (newMSR & UART_MSR_DCTS)
 879                         port->icount.cts++;
 880                 if (newMSR & UART_MSR_DDSR)
 881                         port->icount.dsr++;
 882                 if (newMSR & UART_MSR_DDCD)
 883                         port->icount.dcd++;
 884                 if (newMSR & UART_MSR_TERI)
 885                         port->icount.rng++;
 886
 887                 wake_up_interruptible(&port->port.delta_msr_wait);
 888         }
 889 }
 890
 891 static void qt2_update_lsr(struct usb_serial_port *port, unsigned char *ch)
 892 {
 893         struct qt2_port_private *port_priv;
 894         struct async_icount *icount;
 895         unsigned long flags;
 896         u8 newLSR = (u8) *ch;
 897
 898         port_priv = usb_get_serial_port_data(port);
 899
 900         if (newLSR & UART_LSR_BI)
 901                 newLSR &= (u8) (UART_LSR_OE | UART_LSR_BI);
 902
 903         spin_lock_irqsave(&port_priv->lock, flags);
 904         port_priv->shadowLSR = newLSR;
 905         spin_unlock_irqrestore(&port_priv->lock, flags);
 906
 907         icount = &port->icount;
 908
 909         if (newLSR & UART_LSR_BRK_ERROR_BITS) {
 910
 911                 if (newLSR & UART_LSR_BI)
 912                         icount->brk++;
 913
 914                 if (newLSR & UART_LSR_OE)
 915                         icount->overrun++;
 916
 917                 if (newLSR & UART_LSR_PE)
 918                         icount->parity++;
 919
 920                 if (newLSR & UART_LSR_FE)
 921                         icount->frame++;
 922         }
 923
 924 }
 925
 926 static int qt2_write_room(struct tty_struct *tty)
 927 {
 928         struct usb_serial_port *port = tty->driver_data;
 929         struct qt2_port_private *port_priv;
 930         unsigned long flags = 0;
 931         int r;
 932
 933         port_priv = usb_get_serial_port_data(port);
 934
 935         spin_lock_irqsave(&port_priv->urb_lock, flags);
 936
 937         if (port_priv->urb_in_use)
 938                 r = 0;
 939         else
 940                 r = QT2_WRITE_BUFFER_SIZE - QT2_WRITE_CONTROL_SIZE;
 941
 942         spin_unlock_irqrestore(&port_priv->urb_lock, flags);
 943
 944         return r;
 945 }
 946
 947 static int qt2_write(struct tty_struct *tty,
 948                      struct usb_serial_port *port,
 949                      const unsigned char *buf, int count)
 950 {
 951         struct qt2_port_private *port_priv;
 952         struct urb *write_urb;
 953         unsigned char *data;
 954         unsigned long flags;
 955         int status;
 956         int bytes_out = 0;
 957
 958         port_priv = usb_get_serial_port_data(port);
 959
 960         if (port_priv->write_urb == NULL) {
 961                 dev_err(&port->dev, "%s - no output urb\n", __func__);
 962                 return 0;
 963         }
 964         write_urb = port_priv->write_urb;
 965
 966         count = min(count, QT2_WRITE_BUFFER_SIZE - QT2_WRITE_CONTROL_SIZE);
 967
 968         data = write_urb->transfer_buffer;
 969         spin_lock_irqsave(&port_priv->urb_lock, flags);
 970         if (port_priv->urb_in_use) {
 971                 dev_err(&port->dev, "qt2_write - urb is in use\n");
 972                 goto write_out;
 973         }
 974
 975         *data++ = QT2_CONTROL_BYTE;
 976         *data++ = QT2_CONTROL_BYTE;
 977         *data++ = port_priv->device_port;
 978         put_unaligned_le16(count, data);
 979         data += 2;
 980         memcpy(data, buf, count);
 981
 982         write_urb->transfer_buffer_length = count + QT2_WRITE_CONTROL_SIZE;
 983
 984         status = usb_submit_urb(write_urb, GFP_ATOMIC);
 985         if (status == 0) {
 986                 port_priv->urb_in_use = true;
 987                 bytes_out += count;
 988         }
 989
 990 write_out:
 991         spin_unlock_irqrestore(&port_priv->urb_lock, flags);
 992         return bytes_out;
 993 }
 994
 995
 996 static struct usb_serial_driver qt2_device = {
 997         .driver = {
 998                 .owner = THIS_MODULE,
 999                 .name = "quatech-serial",
1000         },
1001         .description         = DRIVER_DESC,
1002         .id_table            = id_table,
1003         .open                = qt2_open,
1004         .close               = qt2_close,
1005         .write               = qt2_write,
1006         .write_room          = qt2_write_room,
1007         .calc_num_ports      = qt2_calc_num_ports,
1008         .attach              = qt2_attach,
1009         .release             = qt2_release,
1010         .disconnect          = qt2_disconnect,
1011         .port_probe          = qt2_port_probe,
1012         .port_remove         = qt2_port_remove,
1013         .dtr_rts             = qt2_dtr_rts,
1014         .break_ctl           = qt2_break_ctl,
1015         .tiocmget            = qt2_tiocmget,
1016         .tiocmset            = qt2_tiocmset,
1017         .tiocmiwait          = usb_serial_generic_tiocmiwait,
1018         .get_icount          = usb_serial_generic_get_icount,
1019         .ioctl               = qt2_ioctl,
1020         .set_termios         = qt2_set_termios,
1021 };
1022
1023 static struct usb_serial_driver *const serial_drivers[] = {
1024         &qt2_device, NULL
1025 };
1026
1027 module_usb_serial_driver(serial_drivers, id_table);
1028
1029 MODULE_DESCRIPTION(DRIVER_DESC);
1030 MODULE_LICENSE("GPL");