drivers/usb/serial/oti6858.c

   1 /*
   2  * Ours Technology Inc. OTi-6858 USB to serial adapter driver.
   3  *
   4  * Copyleft  (C) 2007 Kees Lemmens (adapted for kernel 2.6.20)
   5  * Copyright (C) 2006 Tomasz Michal Lukaszewski (FIXME: add e-mail)
   6  * Copyright (C) 2001-2004 Greg Kroah-Hartman (greg@kroah.com)
   7  * Copyright (C) 2003 IBM Corp.
   8  *
   9  * Many thanks to the authors of pl2303 driver: all functions in this file
  10  * are heavily based on pl2303 code, buffering code is a 1-to-1 copy.
  11  *
  12  * Warning! You use this driver on your own risk! The only official
  13  * description of this device I have is datasheet from manufacturer,
  14  * and it doesn't contain almost any information needed to write a driver.
  15  * Almost all knowlegde used while writing this driver was gathered by:
  16  *  - analyzing traffic between device and the M$ Windows 2000 driver,
  17  *  - trying different bit combinations and checking pin states
  18  *    with a voltmeter,
  19  *  - receiving malformed frames and producing buffer overflows
  20  *    to learn how errors are reported,
  21  * So, THIS CODE CAN DESTROY OTi-6858 AND ANY OTHER DEVICES, THAT ARE
  22  * CONNECTED TO IT!
  23  *
  24  * This program is free software; you can redistribute it and/or modify
  25  * it under the terms of the GNU General Public License as published by
  26  * the Free Software Foundation; either version 2 of the License.
  27  *
  28  * See Documentation/usb/usb-serial.txt for more information on using this
  29  * driver
  30  *
  31  * TODO:
  32  *  - implement correct flushing for ioctls and oti6858_close()
  33  *  - check how errors (rx overflow, parity error, framing error) are reported
  34  *  - implement oti6858_break_ctl()
  35  *  - implement more ioctls
  36  *  - test/implement flow control
  37  *  - allow setting custom baud rates
  38  */
  39
  40 #include <linux/kernel.h>
  41 #include <linux/errno.h>
  42 #include <linux/init.h>
  43 #include <linux/slab.h>
  44 #include <linux/tty.h>
  45 #include <linux/tty_driver.h>
  46 #include <linux/tty_flip.h>
  47 #include <linux/serial.h>
  48 #include <linux/module.h>
  49 #include <linux/moduleparam.h>
  50 #include <linux/spinlock.h>
  51 #include <linux/usb.h>
  52 #include <linux/usb/serial.h>
  53 #include <linux/uaccess.h>
  54 #include <linux/kfifo.h>
  55 #include "oti6858.h"
  56
  57 #define OTI6858_DESCRIPTION \
  58         "Ours Technology Inc. OTi-6858 USB to serial adapter driver"
  59 #define OTI6858_AUTHOR "Tomasz Michal Lukaszewski <FIXME@FIXME>"
  60 #define OTI6858_VERSION "0.2"
  61
  62 static const struct usb_device_id id_table[] = {
  63         { USB_DEVICE(OTI6858_VENDOR_ID, OTI6858_PRODUCT_ID) },
  64         { }
  65 };
  66
  67 MODULE_DEVICE_TABLE(usb, id_table);
  68
  69 static struct usb_driver oti6858_driver = {
  70         .name =         "oti6858",
  71         .disconnect =   usb_serial_disconnect,
  72         .id_table =     id_table,
  73 };
  74
  75 static bool debug;
  76
  77 /* requests */
  78 #define OTI6858_REQ_GET_STATUS          (USB_DIR_IN | USB_TYPE_VENDOR | 0x00)
  79 #define OTI6858_REQ_T_GET_STATUS        0x01
  80
  81 #define OTI6858_REQ_SET_LINE            (USB_DIR_OUT | USB_TYPE_VENDOR | 0x00)
  82 #define OTI6858_REQ_T_SET_LINE          0x00
  83
  84 #define OTI6858_REQ_CHECK_TXBUFF        (USB_DIR_IN | USB_TYPE_VENDOR | 0x01)
  85 #define OTI6858_REQ_T_CHECK_TXBUFF      0x00
  86
  87 /* format of the control packet */
  88 struct oti6858_control_pkt {
  89         __le16  divisor;        /* baud rate = 96000000 / (16 * divisor), LE */
  90 #define OTI6858_MAX_BAUD_RATE   3000000
  91         u8      frame_fmt;
  92 #define FMT_STOP_BITS_MASK      0xc0
  93 #define FMT_STOP_BITS_1         0x00
  94 #define FMT_STOP_BITS_2         0x40    /* 1.5 stop bits if FMT_DATA_BITS_5 */
  95 #define FMT_PARITY_MASK         0x38
  96 #define FMT_PARITY_NONE         0x00
  97 #define FMT_PARITY_ODD          0x08
  98 #define FMT_PARITY_EVEN         0x18
  99 #define FMT_PARITY_MARK         0x28
 100 #define FMT_PARITY_SPACE        0x38
 101 #define FMT_DATA_BITS_MASK      0x03
 102 #define FMT_DATA_BITS_5         0x00
 103 #define FMT_DATA_BITS_6         0x01
 104 #define FMT_DATA_BITS_7         0x02
 105 #define FMT_DATA_BITS_8         0x03
 106         u8      something;      /* always equals 0x43 */
 107         u8      control;        /* settings of flow control lines */
 108 #define CONTROL_MASK            0x0c
 109 #define CONTROL_DTR_HIGH        0x08
 110 #define CONTROL_RTS_HIGH        0x04
 111         u8      tx_status;
 112 #define TX_BUFFER_EMPTIED       0x09
 113         u8      pin_state;
 114 #define PIN_MASK                0x3f
 115 #define PIN_RTS                 0x20    /* output pin */
 116 #define PIN_CTS                 0x10    /* input pin, active low */
 117 #define PIN_DSR                 0x08    /* input pin, active low */
 118 #define PIN_DTR                 0x04    /* output pin */
 119 #define PIN_RI                  0x02    /* input pin, active low */
 120 #define PIN_DCD                 0x01    /* input pin, active low */
 121         u8      rx_bytes_avail;         /* number of bytes in rx buffer */;
 122 };
 123
 124 #define OTI6858_CTRL_PKT_SIZE   sizeof(struct oti6858_control_pkt)
 125 #define OTI6858_CTRL_EQUALS_PENDING(a, priv) \
 126         (((a)->divisor == (priv)->pending_setup.divisor) \
 127           && ((a)->control == (priv)->pending_setup.control) \
 128           && ((a)->frame_fmt == (priv)->pending_setup.frame_fmt))
 129
 130 /* function prototypes */
 131 static int oti6858_open(struct tty_struct *tty, struct usb_serial_port *port);
 132 static void oti6858_close(struct usb_serial_port *port);
 133 static void oti6858_set_termios(struct tty_struct *tty,
 134                         struct usb_serial_port *port, struct ktermios *old);
 135 static void oti6858_init_termios(struct tty_struct *tty);
 136 static int oti6858_ioctl(struct tty_struct *tty,
 137                         unsigned int cmd, unsigned long arg);
 138 static void oti6858_read_int_callback(struct urb *urb);
 139 static void oti6858_read_bulk_callback(struct urb *urb);
 140 static void oti6858_write_bulk_callback(struct urb *urb);
 141 static int oti6858_write(struct tty_struct *tty, struct usb_serial_port *port,
 142                         const unsigned char *buf, int count);
 143 static int oti6858_write_room(struct tty_struct *tty);
 144 static int oti6858_chars_in_buffer(struct tty_struct *tty);
 145 static int oti6858_tiocmget(struct tty_struct *tty);
 146 static int oti6858_tiocmset(struct tty_struct *tty,
 147                                 unsigned int set, unsigned int clear);
 148 static int oti6858_startup(struct usb_serial *serial);
 149 static void oti6858_release(struct usb_serial *serial);
 150
 151 /* device info */
 152 static struct usb_serial_driver oti6858_device = {
 153         .driver = {
 154                 .owner =        THIS_MODULE,
 155                 .name =         "oti6858",
 156         },
 157         .id_table =             id_table,
 158         .num_ports =            1,
 159         .open =                 oti6858_open,
 160         .close =                oti6858_close,
 161         .write =                oti6858_write,
 162         .ioctl =                oti6858_ioctl,
 163         .set_termios =          oti6858_set_termios,
 164         .init_termios =         oti6858_init_termios,
 165         .tiocmget =             oti6858_tiocmget,
 166         .tiocmset =             oti6858_tiocmset,
 167         .read_bulk_callback =   oti6858_read_bulk_callback,
 168         .read_int_callback =    oti6858_read_int_callback,
 169         .write_bulk_callback =  oti6858_write_bulk_callback,
 170         .write_room =           oti6858_write_room,
 171         .chars_in_buffer =      oti6858_chars_in_buffer,
 172         .attach =               oti6858_startup,
 173         .release =              oti6858_release,
 174 };
 175
 176 static struct usb_serial_driver * const serial_drivers[] = {
 177         &oti6858_device, NULL
 178 };
 179
 180 struct oti6858_private {
 181         spinlock_t lock;
 182
 183         struct oti6858_control_pkt status;
 184
 185         struct {
 186                 u8 read_urb_in_use;
 187                 u8 write_urb_in_use;
 188         } flags;
 189         struct delayed_work delayed_write_work;
 190
 191         struct {
 192                 __le16 divisor;
 193                 u8 frame_fmt;
 194                 u8 control;
 195         } pending_setup;
 196         u8 transient;
 197         u8 setup_done;
 198         struct delayed_work delayed_setup_work;
 199
 200         wait_queue_head_t intr_wait;
 201         struct usb_serial_port *port;   /* USB port with which associated */
 202 };
 203
 204 static void setup_line(struct work_struct *work)
 205 {
 206         struct oti6858_private *priv = container_of(work,
 207                         struct oti6858_private, delayed_setup_work.work);
 208         struct usb_serial_port *port = priv->port;
 209         struct oti6858_control_pkt *new_setup;
 210         unsigned long flags;
 211         int result;
 212
 213         new_setup = kmalloc(OTI6858_CTRL_PKT_SIZE, GFP_KERNEL);
 214         if (new_setup == NULL) {
 215                 dev_err(&port->dev, "%s(): out of memory!\n", __func__);
 216                 /* we will try again */
 217                 schedule_delayed_work(&priv->delayed_setup_work,
 218                                                 msecs_to_jiffies(2));
 219                 return;
 220         }
 221
 222         result = usb_control_msg(port->serial->dev,
 223                                 usb_rcvctrlpipe(port->serial->dev, 0),
 224                                 OTI6858_REQ_T_GET_STATUS,
 225                                 OTI6858_REQ_GET_STATUS,
 226                                 0, 0,
 227                                 new_setup, OTI6858_CTRL_PKT_SIZE,
 228                                 100);
 229
 230         if (result != OTI6858_CTRL_PKT_SIZE) {
 231                 dev_err(&port->dev, "%s(): error reading status\n", __func__);
 232                 kfree(new_setup);
 233                 /* we will try again */
 234                 schedule_delayed_work(&priv->delayed_setup_work,
 235                                                         msecs_to_jiffies(2));
 236                 return;
 237         }
 238
 239         spin_lock_irqsave(&priv->lock, flags);
 240         if (!OTI6858_CTRL_EQUALS_PENDING(new_setup, priv)) {
 241                 new_setup->divisor = priv->pending_setup.divisor;
 242                 new_setup->control = priv->pending_setup.control;
 243                 new_setup->frame_fmt = priv->pending_setup.frame_fmt;
 244
 245                 spin_unlock_irqrestore(&priv->lock, flags);
 246                 result = usb_control_msg(port->serial->dev,
 247                                         usb_sndctrlpipe(port->serial->dev, 0),
 248                                         OTI6858_REQ_T_SET_LINE,
 249                                         OTI6858_REQ_SET_LINE,
 250                                         0, 0,
 251                                         new_setup, OTI6858_CTRL_PKT_SIZE,
 252                                         100);
 253         } else {
 254                 spin_unlock_irqrestore(&priv->lock, flags);
 255                 result = 0;
 256         }
 257         kfree(new_setup);
 258
 259         spin_lock_irqsave(&priv->lock, flags);
 260         if (result != OTI6858_CTRL_PKT_SIZE)
 261                 priv->transient = 0;
 262         priv->setup_done = 1;
 263         spin_unlock_irqrestore(&priv->lock, flags);
 264
 265         dbg("%s(): submitting interrupt urb", __func__);
 266         result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
 267         if (result != 0) {
 268                 dev_err(&port->dev, "%s(): usb_submit_urb() failed"
 269                                 " with error %d\n", __func__, result);
 270         }
 271 }
 272
 273 static void send_data(struct work_struct *work)
 274 {
 275         struct oti6858_private *priv = container_of(work,
 276                         struct oti6858_private, delayed_write_work.work);
 277         struct usb_serial_port *port = priv->port;
 278         int count = 0, result;
 279         unsigned long flags;
 280         u8 *allow;
 281
 282         spin_lock_irqsave(&priv->lock, flags);
 283         if (priv->flags.write_urb_in_use) {
 284                 spin_unlock_irqrestore(&priv->lock, flags);
 285                 schedule_delayed_work(&priv->delayed_write_work,
 286                                                 msecs_to_jiffies(2));
 287                 return;
 288         }
 289         priv->flags.write_urb_in_use = 1;
 290         spin_unlock_irqrestore(&priv->lock, flags);
 291
 292         spin_lock_irqsave(&port->lock, flags);
 293         count = kfifo_len(&port->write_fifo);
 294         spin_unlock_irqrestore(&port->lock, flags);
 295
 296         if (count > port->bulk_out_size)
 297                 count = port->bulk_out_size;
 298
 299         if (count != 0) {
 300                 allow = kmalloc(1, GFP_KERNEL);
 301                 if (!allow) {
 302                         dev_err_console(port, "%s(): kmalloc failed\n",
 303                                         __func__);
 304                         return;
 305                 }
 306                 result = usb_control_msg(port->serial->dev,
 307                                 usb_rcvctrlpipe(port->serial->dev, 0),
 308                                 OTI6858_REQ_T_CHECK_TXBUFF,
 309                                 OTI6858_REQ_CHECK_TXBUFF,
 310                                 count, 0, allow, 1, 100);
 311                 if (result != 1 || *allow != 0)
 312                         count = 0;
 313                 kfree(allow);
 314         }
 315
 316         if (count == 0) {
 317                 priv->flags.write_urb_in_use = 0;
 318
 319                 dbg("%s(): submitting interrupt urb", __func__);
 320                 result = usb_submit_urb(port->interrupt_in_urb, GFP_NOIO);
 321                 if (result != 0) {
 322                         dev_err(&port->dev, "%s(): usb_submit_urb() failed"
 323                                 " with error %d\n", __func__, result);
 324                 }
 325                 return;
 326         }
 327
 328         count = kfifo_out_locked(&port->write_fifo,
 329                                         port->write_urb->transfer_buffer,
 330                                         count, &port->lock);
 331         port->write_urb->transfer_buffer_length = count;
 332         result = usb_submit_urb(port->write_urb, GFP_NOIO);
 333         if (result != 0) {
 334                 dev_err_console(port, "%s(): usb_submit_urb() failed"
 335                                " with error %d\n", __func__, result);
 336                 priv->flags.write_urb_in_use = 0;
 337         }
 338
 339         usb_serial_port_softint(port);
 340 }
 341
 342 static int oti6858_startup(struct usb_serial *serial)
 343 {
 344         struct usb_serial_port *port = serial->port[0];
 345         struct oti6858_private *priv;
 346         int i;
 347
 348         for (i = 0; i < serial->num_ports; ++i) {
 349                 priv = kzalloc(sizeof(struct oti6858_private), GFP_KERNEL);
 350                 if (!priv)
 351                         break;
 352
 353                 spin_lock_init(&priv->lock);
 354                 init_waitqueue_head(&priv->intr_wait);
 355 /*              INIT_WORK(&priv->setup_work, setup_line, serial->port[i]); */
 356 /*              INIT_WORK(&priv->write_work, send_data, serial->port[i]); */
 357                 priv->port = port;
 358                 INIT_DELAYED_WORK(&priv->delayed_setup_work, setup_line);
 359                 INIT_DELAYED_WORK(&priv->delayed_write_work, send_data);
 360
 361                 usb_set_serial_port_data(serial->port[i], priv);
 362         }
 363         if (i == serial->num_ports)
 364                 return 0;
 365
 366         for (--i; i >= 0; --i) {
 367                 priv = usb_get_serial_port_data(serial->port[i]);
 368                 kfree(priv);
 369                 usb_set_serial_port_data(serial->port[i], NULL);
 370         }
 371         return -ENOMEM;
 372 }
 373
 374 static int oti6858_write(struct tty_struct *tty, struct usb_serial_port *port,
 375                         const unsigned char *buf, int count)
 376 {
 377         if (!count)
 378                 return count;
 379
 380         count = kfifo_in_locked(&port->write_fifo, buf, count, &port->lock);
 381
 382         return count;
 383 }
 384
 385 static int oti6858_write_room(struct tty_struct *tty)
 386 {
 387         struct usb_serial_port *port = tty->driver_data;
 388         int room = 0;
 389         unsigned long flags;
 390
 391         spin_lock_irqsave(&port->lock, flags);
 392         room = kfifo_avail(&port->write_fifo);
 393         spin_unlock_irqrestore(&port->lock, flags);
 394
 395         return room;
 396 }
 397
 398 static int oti6858_chars_in_buffer(struct tty_struct *tty)
 399 {
 400         struct usb_serial_port *port = tty->driver_data;
 401         int chars = 0;
 402         unsigned long flags;
 403
 404         spin_lock_irqsave(&port->lock, flags);
 405         chars = kfifo_len(&port->write_fifo);
 406         spin_unlock_irqrestore(&port->lock, flags);
 407
 408         return chars;
 409 }
 410
 411 static void oti6858_init_termios(struct tty_struct *tty)
 412 {
 413         *(tty->termios) = tty_std_termios;
 414         tty->termios->c_cflag = B38400 | CS8 | CREAD | HUPCL | CLOCAL;
 415         tty->termios->c_ispeed = 38400;
 416         tty->termios->c_ospeed = 38400;
 417 }
 418
 419 static void oti6858_set_termios(struct tty_struct *tty,
 420                 struct usb_serial_port *port, struct ktermios *old_termios)
 421 {
 422         struct oti6858_private *priv = usb_get_serial_port_data(port);
 423         unsigned long flags;
 424         unsigned int cflag;
 425         u8 frame_fmt, control;
 426         __le16 divisor;
 427         int br;
 428
 429         if (!tty) {
 430                 dbg("%s(): no tty structures", __func__);
 431                 return;
 432         }
 433
 434         cflag = tty->termios->c_cflag;
 435
 436         spin_lock_irqsave(&priv->lock, flags);
 437         divisor = priv->pending_setup.divisor;
 438         frame_fmt = priv->pending_setup.frame_fmt;
 439         control = priv->pending_setup.control;
 440         spin_unlock_irqrestore(&priv->lock, flags);
 441
 442         frame_fmt &= ~FMT_DATA_BITS_MASK;
 443         switch (cflag & CSIZE) {
 444         case CS5:
 445                 frame_fmt |= FMT_DATA_BITS_5;
 446                 break;
 447         case CS6:
 448                 frame_fmt |= FMT_DATA_BITS_6;
 449                 break;
 450         case CS7:
 451                 frame_fmt |= FMT_DATA_BITS_7;
 452                 break;
 453         default:
 454         case CS8:
 455                 frame_fmt |= FMT_DATA_BITS_8;
 456                 break;
 457         }
 458
 459         /* manufacturer claims that this device can work with baud rates
 460          * up to 3 Mbps; I've tested it only on 115200 bps, so I can't
 461          * guarantee that any other baud rate will work (especially
 462          * the higher ones)
 463          */
 464         br = tty_get_baud_rate(tty);
 465         if (br == 0) {
 466                 divisor = 0;
 467         } else {
 468                 int real_br;
 469                 int new_divisor;
 470                 br = min(br, OTI6858_MAX_BAUD_RATE);
 471
 472                 new_divisor = (96000000 + 8 * br) / (16 * br);
 473                 real_br = 96000000 / (16 * new_divisor);
 474                 divisor = cpu_to_le16(new_divisor);
 475                 tty_encode_baud_rate(tty, real_br, real_br);
 476         }
 477
 478         frame_fmt &= ~FMT_STOP_BITS_MASK;
 479         if ((cflag & CSTOPB) != 0)
 480                 frame_fmt |= FMT_STOP_BITS_2;
 481         else
 482                 frame_fmt |= FMT_STOP_BITS_1;
 483
 484         frame_fmt &= ~FMT_PARITY_MASK;
 485         if ((cflag & PARENB) != 0) {
 486                 if ((cflag & PARODD) != 0)
 487                         frame_fmt |= FMT_PARITY_ODD;
 488                 else
 489                         frame_fmt |= FMT_PARITY_EVEN;
 490         } else {
 491                 frame_fmt |= FMT_PARITY_NONE;
 492         }
 493
 494         control &= ~CONTROL_MASK;
 495         if ((cflag & CRTSCTS) != 0)
 496                 control |= (CONTROL_DTR_HIGH | CONTROL_RTS_HIGH);
 497
 498         /* change control lines if we are switching to or from B0 */
 499         /* FIXME:
 500         spin_lock_irqsave(&priv->lock, flags);
 501         control = priv->line_control;
 502         if ((cflag & CBAUD) == B0)
 503                 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
 504         else
 505                 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
 506         if (control != priv->line_control) {
 507                 control = priv->line_control;
 508                 spin_unlock_irqrestore(&priv->lock, flags);
 509                 set_control_lines(serial->dev, control);
 510         } else {
 511                 spin_unlock_irqrestore(&priv->lock, flags);
 512         }
 513         */
 514
 515         spin_lock_irqsave(&priv->lock, flags);
 516         if (divisor != priv->pending_setup.divisor
 517                         || control != priv->pending_setup.control
 518                         || frame_fmt != priv->pending_setup.frame_fmt) {
 519                 priv->pending_setup.divisor = divisor;
 520                 priv->pending_setup.control = control;
 521                 priv->pending_setup.frame_fmt = frame_fmt;
 522         }
 523         spin_unlock_irqrestore(&priv->lock, flags);
 524 }
 525
 526 static int oti6858_open(struct tty_struct *tty, struct usb_serial_port *port)
 527 {
 528         struct oti6858_private *priv = usb_get_serial_port_data(port);
 529         struct ktermios tmp_termios;
 530         struct usb_serial *serial = port->serial;
 531         struct oti6858_control_pkt *buf;
 532         unsigned long flags;
 533         int result;
 534
 535         usb_clear_halt(serial->dev, port->write_urb->pipe);
 536         usb_clear_halt(serial->dev, port->read_urb->pipe);
 537
 538         buf = kmalloc(OTI6858_CTRL_PKT_SIZE, GFP_KERNEL);
 539         if (buf == NULL) {
 540                 dev_err(&port->dev, "%s(): out of memory!\n", __func__);
 541                 return -ENOMEM;
 542         }
 543
 544         result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 545                                 OTI6858_REQ_T_GET_STATUS,
 546                                 OTI6858_REQ_GET_STATUS,
 547                                 0, 0,
 548                                 buf, OTI6858_CTRL_PKT_SIZE,
 549                                 100);
 550         if (result != OTI6858_CTRL_PKT_SIZE) {
 551                 /* assume default (after power-on reset) values */
 552                 buf->divisor = cpu_to_le16(0x009c);     /* 38400 bps */
 553                 buf->frame_fmt = 0x03;  /* 8N1 */
 554                 buf->something = 0x43;
 555                 buf->control = 0x4c;    /* DTR, RTS */
 556                 buf->tx_status = 0x00;
 557                 buf->pin_state = 0x5b;  /* RTS, CTS, DSR, DTR, RI, DCD */
 558                 buf->rx_bytes_avail = 0x00;
 559         }
 560
 561         spin_lock_irqsave(&priv->lock, flags);
 562         memcpy(&priv->status, buf, OTI6858_CTRL_PKT_SIZE);
 563         priv->pending_setup.divisor = buf->divisor;
 564         priv->pending_setup.frame_fmt = buf->frame_fmt;
 565         priv->pending_setup.control = buf->control;
 566         spin_unlock_irqrestore(&priv->lock, flags);
 567         kfree(buf);
 568
 569         dbg("%s(): submitting interrupt urb", __func__);
 570         result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
 571         if (result != 0) {
 572                 dev_err(&port->dev, "%s(): usb_submit_urb() failed"
 573                                " with error %d\n", __func__, result);
 574                 oti6858_close(port);
 575                 return result;
 576         }
 577
 578         /* setup termios */
 579         if (tty)
 580                 oti6858_set_termios(tty, port, &tmp_termios);
 581         port->port.drain_delay = 256;   /* FIXME: check the FIFO length */
 582         return 0;
 583 }
 584
 585 static void oti6858_close(struct usb_serial_port *port)
 586 {
 587         struct oti6858_private *priv = usb_get_serial_port_data(port);
 588         unsigned long flags;
 589
 590         spin_lock_irqsave(&port->lock, flags);
 591         /* clear out any remaining data in the buffer */
 592         kfifo_reset_out(&port->write_fifo);
 593         spin_unlock_irqrestore(&port->lock, flags);
 594
 595         dbg("%s(): after buf_clear()", __func__);
 596
 597         /* cancel scheduled setup */
 598         cancel_delayed_work_sync(&priv->delayed_setup_work);
 599         cancel_delayed_work_sync(&priv->delayed_write_work);
 600
 601         /* shutdown our urbs */
 602         dbg("%s(): shutting down urbs", __func__);
 603         usb_kill_urb(port->write_urb);
 604         usb_kill_urb(port->read_urb);
 605         usb_kill_urb(port->interrupt_in_urb);
 606 }
 607
 608 static int oti6858_tiocmset(struct tty_struct *tty,
 609                                 unsigned int set, unsigned int clear)
 610 {
 611         struct usb_serial_port *port = tty->driver_data;
 612         struct oti6858_private *priv = usb_get_serial_port_data(port);
 613         unsigned long flags;
 614         u8 control;
 615
 616         dbg("%s(port = %d, set = 0x%08x, clear = 0x%08x)",
 617                                 __func__, port->number, set, clear);
 618
 619         /* FIXME: check if this is correct (active high/low) */
 620         spin_lock_irqsave(&priv->lock, flags);
 621         control = priv->pending_setup.control;
 622         if ((set & TIOCM_RTS) != 0)
 623                 control |= CONTROL_RTS_HIGH;
 624         if ((set & TIOCM_DTR) != 0)
 625                 control |= CONTROL_DTR_HIGH;
 626         if ((clear & TIOCM_RTS) != 0)
 627                 control &= ~CONTROL_RTS_HIGH;
 628         if ((clear & TIOCM_DTR) != 0)
 629                 control &= ~CONTROL_DTR_HIGH;
 630
 631         if (control != priv->pending_setup.control)
 632                 priv->pending_setup.control = control;
 633
 634         spin_unlock_irqrestore(&priv->lock, flags);
 635         return 0;
 636 }
 637
 638 static int oti6858_tiocmget(struct tty_struct *tty)
 639 {
 640         struct usb_serial_port *port = tty->driver_data;
 641         struct oti6858_private *priv = usb_get_serial_port_data(port);
 642         unsigned long flags;
 643         unsigned pin_state;
 644         unsigned result = 0;
 645
 646         spin_lock_irqsave(&priv->lock, flags);
 647         pin_state = priv->status.pin_state & PIN_MASK;
 648         spin_unlock_irqrestore(&priv->lock, flags);
 649
 650         /* FIXME: check if this is correct (active high/low) */
 651         if ((pin_state & PIN_RTS) != 0)
 652                 result |= TIOCM_RTS;
 653         if ((pin_state & PIN_CTS) != 0)
 654                 result |= TIOCM_CTS;
 655         if ((pin_state & PIN_DSR) != 0)
 656                 result |= TIOCM_DSR;
 657         if ((pin_state & PIN_DTR) != 0)
 658                 result |= TIOCM_DTR;
 659         if ((pin_state & PIN_RI) != 0)
 660                 result |= TIOCM_RI;
 661         if ((pin_state & PIN_DCD) != 0)
 662                 result |= TIOCM_CD;
 663
 664         dbg("%s() = 0x%08x", __func__, result);
 665
 666         return result;
 667 }
 668
 669 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
 670 {
 671         struct oti6858_private *priv = usb_get_serial_port_data(port);
 672         unsigned long flags;
 673         unsigned int prev, status;
 674         unsigned int changed;
 675
 676         spin_lock_irqsave(&priv->lock, flags);
 677         prev = priv->status.pin_state;
 678         spin_unlock_irqrestore(&priv->lock, flags);
 679
 680         while (1) {
 681                 wait_event_interruptible(priv->intr_wait,
 682                                         priv->status.pin_state != prev);
 683                 if (signal_pending(current))
 684                         return -ERESTARTSYS;
 685
 686                 spin_lock_irqsave(&priv->lock, flags);
 687                 status = priv->status.pin_state & PIN_MASK;
 688                 spin_unlock_irqrestore(&priv->lock, flags);
 689
 690                 changed = prev ^ status;
 691                 /* FIXME: check if this is correct (active high/low) */
 692                 if (((arg & TIOCM_RNG) && (changed & PIN_RI)) ||
 693                     ((arg & TIOCM_DSR) && (changed & PIN_DSR)) ||
 694                     ((arg & TIOCM_CD)  && (changed & PIN_DCD)) ||
 695                     ((arg & TIOCM_CTS) && (changed & PIN_CTS)))
 696                         return 0;
 697                 prev = status;
 698         }
 699
 700         /* NOTREACHED */
 701         return 0;
 702 }
 703
 704 static int oti6858_ioctl(struct tty_struct *tty,
 705                         unsigned int cmd, unsigned long arg)
 706 {
 707         struct usb_serial_port *port = tty->driver_data;
 708
 709         dbg("%s(port = %d, cmd = 0x%04x, arg = 0x%08lx)",
 710                                 __func__, port->number, cmd, arg);
 711
 712         switch (cmd) {
 713         case TIOCMIWAIT:
 714                 dbg("%s(): TIOCMIWAIT", __func__);
 715                 return wait_modem_info(port, arg);
 716         default:
 717                 dbg("%s(): 0x%04x not supported", __func__, cmd);
 718                 break;
 719         }
 720         return -ENOIOCTLCMD;
 721 }
 722
 723
 724 static void oti6858_release(struct usb_serial *serial)
 725 {
 726         int i;
 727
 728         for (i = 0; i < serial->num_ports; ++i)
 729                 kfree(usb_get_serial_port_data(serial->port[i]));
 730 }
 731
 732 static void oti6858_read_int_callback(struct urb *urb)
 733 {
 734         struct usb_serial_port *port =  urb->context;
 735         struct oti6858_private *priv = usb_get_serial_port_data(port);
 736         int transient = 0, can_recv = 0, resubmit = 1;
 737         int status = urb->status;
 738
 739         switch (status) {
 740         case 0:
 741                 /* success */
 742                 break;
 743         case -ECONNRESET:
 744         case -ENOENT:
 745         case -ESHUTDOWN:
 746                 /* this urb is terminated, clean up */
 747                 dbg("%s(): urb shutting down with status: %d",
 748                                         __func__, status);
 749                 return;
 750         default:
 751                 dbg("%s(): nonzero urb status received: %d",
 752                                         __func__, status);
 753                 break;
 754         }
 755
 756         if (status == 0 && urb->actual_length == OTI6858_CTRL_PKT_SIZE) {
 757                 struct oti6858_control_pkt *xs = urb->transfer_buffer;
 758                 unsigned long flags;
 759
 760                 spin_lock_irqsave(&priv->lock, flags);
 761
 762                 if (!priv->transient) {
 763                         if (!OTI6858_CTRL_EQUALS_PENDING(xs, priv)) {
 764                                 if (xs->rx_bytes_avail == 0) {
 765                                         priv->transient = 4;
 766                                         priv->setup_done = 0;
 767                                         resubmit = 0;
 768                                         dbg("%s(): scheduling setup_line()",
 769                                             __func__);
 770                                         schedule_delayed_work(&priv->delayed_setup_work, 0);
 771                                 }
 772                         }
 773                 } else {
 774                         if (OTI6858_CTRL_EQUALS_PENDING(xs, priv)) {
 775                                 priv->transient = 0;
 776                         } else if (!priv->setup_done) {
 777                                 resubmit = 0;
 778                         } else if (--priv->transient == 0) {
 779                                 if (xs->rx_bytes_avail == 0) {
 780                                         priv->transient = 4;
 781                                         priv->setup_done = 0;
 782                                         resubmit = 0;
 783                                         dbg("%s(): scheduling setup_line()",
 784                                             __func__);
 785                                         schedule_delayed_work(&priv->delayed_setup_work, 0);
 786                                 }
 787                         }
 788                 }
 789
 790                 if (!priv->transient) {
 791                         if (xs->pin_state != priv->status.pin_state)
 792                                 wake_up_interruptible(&priv->intr_wait);
 793                         memcpy(&priv->status, xs, OTI6858_CTRL_PKT_SIZE);
 794                 }
 795
 796                 if (!priv->transient && xs->rx_bytes_avail != 0) {
 797                         can_recv = xs->rx_bytes_avail;
 798                         priv->flags.read_urb_in_use = 1;
 799                 }
 800
 801                 transient = priv->transient;
 802                 spin_unlock_irqrestore(&priv->lock, flags);
 803         }
 804
 805         if (can_recv) {
 806                 int result;
 807
 808                 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
 809                 if (result != 0) {
 810                         priv->flags.read_urb_in_use = 0;
 811                         dev_err(&port->dev, "%s(): usb_submit_urb() failed,"
 812                                         " error %d\n", __func__, result);
 813                 } else {
 814                         resubmit = 0;
 815                 }
 816         } else if (!transient) {
 817                 unsigned long flags;
 818                 int count;
 819
 820                 spin_lock_irqsave(&port->lock, flags);
 821                 count = kfifo_len(&port->write_fifo);
 822                 spin_unlock_irqrestore(&port->lock, flags);
 823
 824                 spin_lock_irqsave(&priv->lock, flags);
 825                 if (priv->flags.write_urb_in_use == 0 && count != 0) {
 826                         schedule_delayed_work(&priv->delayed_write_work, 0);
 827                         resubmit = 0;
 828                 }
 829                 spin_unlock_irqrestore(&priv->lock, flags);
 830         }
 831
 832         if (resubmit) {
 833                 int result;
 834
 835 /*              dbg("%s(): submitting interrupt urb", __func__); */
 836                 result = usb_submit_urb(urb, GFP_ATOMIC);
 837                 if (result != 0) {
 838                         dev_err(&urb->dev->dev,
 839                                         "%s(): usb_submit_urb() failed with"
 840                                         " error %d\n", __func__, result);
 841                 }
 842         }
 843 }
 844
 845 static void oti6858_read_bulk_callback(struct urb *urb)
 846 {
 847         struct usb_serial_port *port =  urb->context;
 848         struct oti6858_private *priv = usb_get_serial_port_data(port);
 849         struct tty_struct *tty;
 850         unsigned char *data = urb->transfer_buffer;
 851         unsigned long flags;
 852         int status = urb->status;
 853         int result;
 854
 855         spin_lock_irqsave(&priv->lock, flags);
 856         priv->flags.read_urb_in_use = 0;
 857         spin_unlock_irqrestore(&priv->lock, flags);
 858
 859         if (status != 0) {
 860                 dbg("%s(): unable to handle the error, exiting", __func__);
 861                 return;
 862         }
 863
 864         tty = tty_port_tty_get(&port->port);
 865         if (tty != NULL && urb->actual_length > 0) {
 866                 tty_insert_flip_string(tty, data, urb->actual_length);
 867                 tty_flip_buffer_push(tty);
 868         }
 869         tty_kref_put(tty);
 870
 871         /* schedule the interrupt urb */
 872         result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
 873         if (result != 0 && result != -EPERM) {
 874                 dev_err(&port->dev, "%s(): usb_submit_urb() failed,"
 875                                 " error %d\n", __func__, result);
 876         }
 877 }
 878
 879 static void oti6858_write_bulk_callback(struct urb *urb)
 880 {
 881         struct usb_serial_port *port =  urb->context;
 882         struct oti6858_private *priv = usb_get_serial_port_data(port);
 883         int status = urb->status;
 884         int result;
 885
 886         switch (status) {
 887         case 0:
 888                 /* success */
 889                 break;
 890         case -ECONNRESET:
 891         case -ENOENT:
 892         case -ESHUTDOWN:
 893                 /* this urb is terminated, clean up */
 894                 dbg("%s(): urb shutting down with status: %d",
 895                                         __func__, status);
 896                 priv->flags.write_urb_in_use = 0;
 897                 return;
 898         default:
 899                 /* error in the urb, so we have to resubmit it */
 900                 dbg("%s(): nonzero write bulk status received: %d",
 901                                         __func__, status);
 902                 dbg("%s(): overflow in write", __func__);
 903
 904                 port->write_urb->transfer_buffer_length = 1;
 905                 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
 906                 if (result) {
 907                         dev_err_console(port, "%s(): usb_submit_urb() failed,"
 908                                         " error %d\n", __func__, result);
 909                 } else {
 910                         return;
 911                 }
 912         }
 913
 914         priv->flags.write_urb_in_use = 0;
 915
 916         /* schedule the interrupt urb if we are still open */
 917         dbg("%s(): submitting interrupt urb", __func__);
 918         result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
 919         if (result != 0) {
 920                 dev_err(&port->dev, "%s(): failed submitting int urb,"
 921                                         " error %d\n", __func__, result);
 922         }
 923 }
 924
 925 module_usb_serial_driver(oti6858_driver, serial_drivers);
 926
 927 MODULE_DESCRIPTION(OTI6858_DESCRIPTION);
 928 MODULE_AUTHOR(OTI6858_AUTHOR);
 929 MODULE_VERSION(OTI6858_VERSION);
 930 MODULE_LICENSE("GPL");
 931
 932 module_param(debug, bool, S_IRUGO | S_IWUSR);
 933 MODULE_PARM_DESC(debug, "enable debug output");
 934