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