drivers/usb/serial/digi_acceleport.c

   1 /*
   2 *  Digi AccelePort USB-4 and USB-2 Serial Converters
   3 *
   4 *  Copyright 2000 by Digi International
   5 *
   6 *  This program is free software; you can redistribute it and/or modify
   7 *  it under the terms of the GNU General Public License as published by
   8 *  the Free Software Foundation; either version 2 of the License, or
   9 *  (at your option) any later version.
  10 *
  11 *  Shamelessly based on Brian Warner's keyspan_pda.c and Greg Kroah-Hartman's
  12 *  usb-serial driver.
  13 *
  14 *  Peter Berger (pberger@brimson.com)
  15 *  Al Borchers (borchers@steinerpoint.com)
  16 */
  17
  18 #include <linux/kernel.h>
  19 #include <linux/errno.h>
  20 #include <linux/init.h>
  21 #include <linux/slab.h>
  22 #include <linux/tty.h>
  23 #include <linux/tty_driver.h>
  24 #include <linux/tty_flip.h>
  25 #include <linux/module.h>
  26 #include <linux/spinlock.h>
  27 #include <linux/workqueue.h>
  28 #include <linux/uaccess.h>
  29 #include <linux/usb.h>
  30 #include <linux/wait.h>
  31 #include <linux/usb/serial.h>
  32
  33 /* Defines */
  34
  35 /*
  36  * Version Information
  37  */
  38 #define DRIVER_VERSION "v1.80.1.2"
  39 #define DRIVER_AUTHOR "Peter Berger <pberger@brimson.com>, Al Borchers <borchers@steinerpoint.com>"
  40 #define DRIVER_DESC "Digi AccelePort USB-2/USB-4 Serial Converter driver"
  41
  42 /* port output buffer length -- must be <= transfer buffer length - 2 */
  43 /* so we can be sure to send the full buffer in one urb */
  44 #define DIGI_OUT_BUF_SIZE               8
  45
  46 /* port input buffer length -- must be >= transfer buffer length - 3 */
  47 /* so we can be sure to hold at least one full buffer from one urb */
  48 #define DIGI_IN_BUF_SIZE                64
  49
  50 /* retry timeout while sleeping */
  51 #define DIGI_RETRY_TIMEOUT              (HZ/10)
  52
  53 /* timeout while waiting for tty output to drain in close */
  54 /* this delay is used twice in close, so the total delay could */
  55 /* be twice this value */
  56 #define DIGI_CLOSE_TIMEOUT              (5*HZ)
  57
  58
  59 /* AccelePort USB Defines */
  60
  61 /* ids */
  62 #define DIGI_VENDOR_ID                  0x05c5
  63 #define DIGI_2_ID                       0x0002  /* USB-2 */
  64 #define DIGI_4_ID                       0x0004  /* USB-4 */
  65
  66 /* commands
  67  * "INB": can be used on the in-band endpoint
  68  * "OOB": can be used on the out-of-band endpoint
  69  */
  70 #define DIGI_CMD_SET_BAUD_RATE                  0       /* INB, OOB */
  71 #define DIGI_CMD_SET_WORD_SIZE                  1       /* INB, OOB */
  72 #define DIGI_CMD_SET_PARITY                     2       /* INB, OOB */
  73 #define DIGI_CMD_SET_STOP_BITS                  3       /* INB, OOB */
  74 #define DIGI_CMD_SET_INPUT_FLOW_CONTROL         4       /* INB, OOB */
  75 #define DIGI_CMD_SET_OUTPUT_FLOW_CONTROL        5       /* INB, OOB */
  76 #define DIGI_CMD_SET_DTR_SIGNAL                 6       /* INB, OOB */
  77 #define DIGI_CMD_SET_RTS_SIGNAL                 7       /* INB, OOB */
  78 #define DIGI_CMD_READ_INPUT_SIGNALS             8       /*      OOB */
  79 #define DIGI_CMD_IFLUSH_FIFO                    9       /*      OOB */
  80 #define DIGI_CMD_RECEIVE_ENABLE                 10      /* INB, OOB */
  81 #define DIGI_CMD_BREAK_CONTROL                  11      /* INB, OOB */
  82 #define DIGI_CMD_LOCAL_LOOPBACK                 12      /* INB, OOB */
  83 #define DIGI_CMD_TRANSMIT_IDLE                  13      /* INB, OOB */
  84 #define DIGI_CMD_READ_UART_REGISTER             14      /*      OOB */
  85 #define DIGI_CMD_WRITE_UART_REGISTER            15      /* INB, OOB */
  86 #define DIGI_CMD_AND_UART_REGISTER              16      /* INB, OOB */
  87 #define DIGI_CMD_OR_UART_REGISTER               17      /* INB, OOB */
  88 #define DIGI_CMD_SEND_DATA                      18      /* INB      */
  89 #define DIGI_CMD_RECEIVE_DATA                   19      /* INB      */
  90 #define DIGI_CMD_RECEIVE_DISABLE                20      /* INB      */
  91 #define DIGI_CMD_GET_PORT_TYPE                  21      /*      OOB */
  92
  93 /* baud rates */
  94 #define DIGI_BAUD_50                            0
  95 #define DIGI_BAUD_75                            1
  96 #define DIGI_BAUD_110                           2
  97 #define DIGI_BAUD_150                           3
  98 #define DIGI_BAUD_200                           4
  99 #define DIGI_BAUD_300                           5
 100 #define DIGI_BAUD_600                           6
 101 #define DIGI_BAUD_1200                          7
 102 #define DIGI_BAUD_1800                          8
 103 #define DIGI_BAUD_2400                          9
 104 #define DIGI_BAUD_4800                          10
 105 #define DIGI_BAUD_7200                          11
 106 #define DIGI_BAUD_9600                          12
 107 #define DIGI_BAUD_14400                         13
 108 #define DIGI_BAUD_19200                         14
 109 #define DIGI_BAUD_28800                         15
 110 #define DIGI_BAUD_38400                         16
 111 #define DIGI_BAUD_57600                         17
 112 #define DIGI_BAUD_76800                         18
 113 #define DIGI_BAUD_115200                        19
 114 #define DIGI_BAUD_153600                        20
 115 #define DIGI_BAUD_230400                        21
 116 #define DIGI_BAUD_460800                        22
 117
 118 /* arguments */
 119 #define DIGI_WORD_SIZE_5                        0
 120 #define DIGI_WORD_SIZE_6                        1
 121 #define DIGI_WORD_SIZE_7                        2
 122 #define DIGI_WORD_SIZE_8                        3
 123
 124 #define DIGI_PARITY_NONE                        0
 125 #define DIGI_PARITY_ODD                         1
 126 #define DIGI_PARITY_EVEN                        2
 127 #define DIGI_PARITY_MARK                        3
 128 #define DIGI_PARITY_SPACE                       4
 129
 130 #define DIGI_STOP_BITS_1                        0
 131 #define DIGI_STOP_BITS_2                        1
 132
 133 #define DIGI_INPUT_FLOW_CONTROL_XON_XOFF        1
 134 #define DIGI_INPUT_FLOW_CONTROL_RTS             2
 135 #define DIGI_INPUT_FLOW_CONTROL_DTR             4
 136
 137 #define DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF       1
 138 #define DIGI_OUTPUT_FLOW_CONTROL_CTS            2
 139 #define DIGI_OUTPUT_FLOW_CONTROL_DSR            4
 140
 141 #define DIGI_DTR_INACTIVE                       0
 142 #define DIGI_DTR_ACTIVE                         1
 143 #define DIGI_DTR_INPUT_FLOW_CONTROL             2
 144
 145 #define DIGI_RTS_INACTIVE                       0
 146 #define DIGI_RTS_ACTIVE                         1
 147 #define DIGI_RTS_INPUT_FLOW_CONTROL             2
 148 #define DIGI_RTS_TOGGLE                         3
 149
 150 #define DIGI_FLUSH_TX                           1
 151 #define DIGI_FLUSH_RX                           2
 152 #define DIGI_RESUME_TX                          4 /* clears xoff condition */
 153
 154 #define DIGI_TRANSMIT_NOT_IDLE                  0
 155 #define DIGI_TRANSMIT_IDLE                      1
 156
 157 #define DIGI_DISABLE                            0
 158 #define DIGI_ENABLE                             1
 159
 160 #define DIGI_DEASSERT                           0
 161 #define DIGI_ASSERT                             1
 162
 163 /* in band status codes */
 164 #define DIGI_OVERRUN_ERROR                      4
 165 #define DIGI_PARITY_ERROR                       8
 166 #define DIGI_FRAMING_ERROR                      16
 167 #define DIGI_BREAK_ERROR                        32
 168
 169 /* out of band status */
 170 #define DIGI_NO_ERROR                           0
 171 #define DIGI_BAD_FIRST_PARAMETER                1
 172 #define DIGI_BAD_SECOND_PARAMETER               2
 173 #define DIGI_INVALID_LINE                       3
 174 #define DIGI_INVALID_OPCODE                     4
 175
 176 /* input signals */
 177 #define DIGI_READ_INPUT_SIGNALS_SLOT            1
 178 #define DIGI_READ_INPUT_SIGNALS_ERR             2
 179 #define DIGI_READ_INPUT_SIGNALS_BUSY            4
 180 #define DIGI_READ_INPUT_SIGNALS_PE              8
 181 #define DIGI_READ_INPUT_SIGNALS_CTS             16
 182 #define DIGI_READ_INPUT_SIGNALS_DSR             32
 183 #define DIGI_READ_INPUT_SIGNALS_RI              64
 184 #define DIGI_READ_INPUT_SIGNALS_DCD             128
 185
 186
 187 /* Structures */
 188
 189 struct digi_serial {
 190         spinlock_t ds_serial_lock;
 191         struct usb_serial_port *ds_oob_port;    /* out-of-band port */
 192         int ds_oob_port_num;                    /* index of out-of-band port */
 193         int ds_device_started;
 194 };
 195
 196 struct digi_port {
 197         spinlock_t dp_port_lock;
 198         int dp_port_num;
 199         int dp_out_buf_len;
 200         unsigned char dp_out_buf[DIGI_OUT_BUF_SIZE];
 201         int dp_write_urb_in_use;
 202         unsigned int dp_modem_signals;
 203         wait_queue_head_t dp_modem_change_wait;
 204         int dp_transmit_idle;
 205         wait_queue_head_t dp_transmit_idle_wait;
 206         int dp_throttled;
 207         int dp_throttle_restart;
 208         wait_queue_head_t dp_flush_wait;
 209         wait_queue_head_t dp_close_wait;        /* wait queue for close */
 210         struct work_struct dp_wakeup_work;
 211         struct usb_serial_port *dp_port;
 212 };
 213
 214
 215 /* Local Function Declarations */
 216
 217 static void digi_wakeup_write(struct usb_serial_port *port);
 218 static void digi_wakeup_write_lock(struct work_struct *work);
 219 static int digi_write_oob_command(struct usb_serial_port *port,
 220         unsigned char *buf, int count, int interruptible);
 221 static int digi_write_inb_command(struct usb_serial_port *port,
 222         unsigned char *buf, int count, unsigned long timeout);
 223 static int digi_set_modem_signals(struct usb_serial_port *port,
 224         unsigned int modem_signals, int interruptible);
 225 static int digi_transmit_idle(struct usb_serial_port *port,
 226         unsigned long timeout);
 227 static void digi_rx_throttle(struct tty_struct *tty);
 228 static void digi_rx_unthrottle(struct tty_struct *tty);
 229 static void digi_set_termios(struct tty_struct *tty,
 230                 struct usb_serial_port *port, struct ktermios *old_termios);
 231 static void digi_break_ctl(struct tty_struct *tty, int break_state);
 232 static int digi_tiocmget(struct tty_struct *tty);
 233 static int digi_tiocmset(struct tty_struct *tty, unsigned int set,
 234                 unsigned int clear);
 235 static int digi_write(struct tty_struct *tty, struct usb_serial_port *port,
 236                 const unsigned char *buf, int count);
 237 static void digi_write_bulk_callback(struct urb *urb);
 238 static int digi_write_room(struct tty_struct *tty);
 239 static int digi_chars_in_buffer(struct tty_struct *tty);
 240 static int digi_open(struct tty_struct *tty, struct usb_serial_port *port);
 241 static void digi_close(struct usb_serial_port *port);
 242 static void digi_dtr_rts(struct usb_serial_port *port, int on);
 243 static int digi_startup_device(struct usb_serial *serial);
 244 static int digi_startup(struct usb_serial *serial);
 245 static void digi_disconnect(struct usb_serial *serial);
 246 static void digi_release(struct usb_serial *serial);
 247 static void digi_read_bulk_callback(struct urb *urb);
 248 static int digi_read_inb_callback(struct urb *urb);
 249 static int digi_read_oob_callback(struct urb *urb);
 250
 251
 252 /* Statics */
 253
 254 static bool debug;
 255
 256 static const struct usb_device_id id_table_combined[] = {
 257         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
 258         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
 259         { }                                             /* Terminating entry */
 260 };
 261
 262 static const struct usb_device_id id_table_2[] = {
 263         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
 264         { }                                             /* Terminating entry */
 265 };
 266
 267 static const struct usb_device_id id_table_4[] = {
 268         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
 269         { }                                             /* Terminating entry */
 270 };
 271
 272 MODULE_DEVICE_TABLE(usb, id_table_combined);
 273
 274 static struct usb_driver digi_driver = {
 275         .name =         "digi_acceleport",
 276         .id_table =     id_table_combined,
 277 };
 278
 279
 280 /* device info needed for the Digi serial converter */
 281
 282 static struct usb_serial_driver digi_acceleport_2_device = {
 283         .driver = {
 284                 .owner =                THIS_MODULE,
 285                 .name =                 "digi_2",
 286         },
 287         .description =                  "Digi 2 port USB adapter",
 288         .id_table =                     id_table_2,
 289         .num_ports =                    3,
 290         .open =                         digi_open,
 291         .close =                        digi_close,
 292         .dtr_rts =                      digi_dtr_rts,
 293         .write =                        digi_write,
 294         .write_room =                   digi_write_room,
 295         .write_bulk_callback =          digi_write_bulk_callback,
 296         .read_bulk_callback =           digi_read_bulk_callback,
 297         .chars_in_buffer =              digi_chars_in_buffer,
 298         .throttle =                     digi_rx_throttle,
 299         .unthrottle =                   digi_rx_unthrottle,
 300         .set_termios =                  digi_set_termios,
 301         .break_ctl =                    digi_break_ctl,
 302         .tiocmget =                     digi_tiocmget,
 303         .tiocmset =                     digi_tiocmset,
 304         .attach =                       digi_startup,
 305         .disconnect =                   digi_disconnect,
 306         .release =                      digi_release,
 307 };
 308
 309 static struct usb_serial_driver digi_acceleport_4_device = {
 310         .driver = {
 311                 .owner =                THIS_MODULE,
 312                 .name =                 "digi_4",
 313         },
 314         .description =                  "Digi 4 port USB adapter",
 315         .id_table =                     id_table_4,
 316         .num_ports =                    4,
 317         .open =                         digi_open,
 318         .close =                        digi_close,
 319         .write =                        digi_write,
 320         .write_room =                   digi_write_room,
 321         .write_bulk_callback =          digi_write_bulk_callback,
 322         .read_bulk_callback =           digi_read_bulk_callback,
 323         .chars_in_buffer =              digi_chars_in_buffer,
 324         .throttle =                     digi_rx_throttle,
 325         .unthrottle =                   digi_rx_unthrottle,
 326         .set_termios =                  digi_set_termios,
 327         .break_ctl =                    digi_break_ctl,
 328         .tiocmget =                     digi_tiocmget,
 329         .tiocmset =                     digi_tiocmset,
 330         .attach =                       digi_startup,
 331         .disconnect =                   digi_disconnect,
 332         .release =                      digi_release,
 333 };
 334
 335 static struct usb_serial_driver * const serial_drivers[] = {
 336         &digi_acceleport_2_device, &digi_acceleport_4_device, NULL
 337 };
 338
 339 /* Functions */
 340
 341 /*
 342  *  Cond Wait Interruptible Timeout Irqrestore
 343  *
 344  *  Do spin_unlock_irqrestore and interruptible_sleep_on_timeout
 345  *  so that wake ups are not lost if they occur between the unlock
 346  *  and the sleep.  In other words, spin_unlock_irqrestore and
 347  *  interruptible_sleep_on_timeout are "atomic" with respect to
 348  *  wake ups.  This is used to implement condition variables.
 349  *
 350  *  interruptible_sleep_on_timeout is deprecated and has been replaced
 351  *  with the equivalent code.
 352  */
 353
 354 static long cond_wait_interruptible_timeout_irqrestore(
 355         wait_queue_head_t *q, long timeout,
 356         spinlock_t *lock, unsigned long flags)
 357 __releases(lock)
 358 {
 359         DEFINE_WAIT(wait);
 360
 361         prepare_to_wait(q, &wait, TASK_INTERRUPTIBLE);
 362         spin_unlock_irqrestore(lock, flags);
 363         timeout = schedule_timeout(timeout);
 364         finish_wait(q, &wait);
 365
 366         return timeout;
 367 }
 368
 369
 370 /*
 371  *  Digi Wakeup Write
 372  *
 373  *  Wake up port, line discipline, and tty processes sleeping
 374  *  on writes.
 375  */
 376
 377 static void digi_wakeup_write_lock(struct work_struct *work)
 378 {
 379         struct digi_port *priv =
 380                         container_of(work, struct digi_port, dp_wakeup_work);
 381         struct usb_serial_port *port = priv->dp_port;
 382         unsigned long flags;
 383
 384         spin_lock_irqsave(&priv->dp_port_lock, flags);
 385         digi_wakeup_write(port);
 386         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 387 }
 388
 389 static void digi_wakeup_write(struct usb_serial_port *port)
 390 {
 391         struct tty_struct *tty = tty_port_tty_get(&port->port);
 392         if (tty) {
 393                 tty_wakeup(tty);
 394                 tty_kref_put(tty);
 395         }
 396 }
 397
 398
 399 /*
 400  *  Digi Write OOB Command
 401  *
 402  *  Write commands on the out of band port.  Commands are 4
 403  *  bytes each, multiple commands can be sent at once, and
 404  *  no command will be split across USB packets.  Returns 0
 405  *  if successful, -EINTR if interrupted while sleeping and
 406  *  the interruptible flag is true, or a negative error
 407  *  returned by usb_submit_urb.
 408  */
 409
 410 static int digi_write_oob_command(struct usb_serial_port *port,
 411         unsigned char *buf, int count, int interruptible)
 412 {
 413
 414         int ret = 0;
 415         int len;
 416         struct usb_serial_port *oob_port = (struct usb_serial_port *)((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
 417         struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
 418         unsigned long flags = 0;
 419
 420         dbg("digi_write_oob_command: TOP: port=%d, count=%d", oob_priv->dp_port_num, count);
 421
 422         spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
 423         while (count > 0) {
 424                 while (oob_priv->dp_write_urb_in_use) {
 425                         cond_wait_interruptible_timeout_irqrestore(
 426                                 &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
 427                                 &oob_priv->dp_port_lock, flags);
 428                         if (interruptible && signal_pending(current))
 429                                 return -EINTR;
 430                         spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
 431                 }
 432
 433                 /* len must be a multiple of 4, so commands are not split */
 434                 len = min(count, oob_port->bulk_out_size);
 435                 if (len > 4)
 436                         len &= ~3;
 437                 memcpy(oob_port->write_urb->transfer_buffer, buf, len);
 438                 oob_port->write_urb->transfer_buffer_length = len;
 439                 ret = usb_submit_urb(oob_port->write_urb, GFP_ATOMIC);
 440                 if (ret == 0) {
 441                         oob_priv->dp_write_urb_in_use = 1;
 442                         count -= len;
 443                         buf += len;
 444                 }
 445         }
 446         spin_unlock_irqrestore(&oob_priv->dp_port_lock, flags);
 447         if (ret)
 448                 dev_err(&port->dev, "%s: usb_submit_urb failed, ret=%d\n",
 449                         __func__, ret);
 450         return ret;
 451
 452 }
 453
 454
 455 /*
 456  *  Digi Write In Band Command
 457  *
 458  *  Write commands on the given port.  Commands are 4
 459  *  bytes each, multiple commands can be sent at once, and
 460  *  no command will be split across USB packets.  If timeout
 461  *  is non-zero, write in band command will return after
 462  *  waiting unsuccessfully for the URB status to clear for
 463  *  timeout ticks.  Returns 0 if successful, or a negative
 464  *  error returned by digi_write.
 465  */
 466
 467 static int digi_write_inb_command(struct usb_serial_port *port,
 468         unsigned char *buf, int count, unsigned long timeout)
 469 {
 470         int ret = 0;
 471         int len;
 472         struct digi_port *priv = usb_get_serial_port_data(port);
 473         unsigned char *data = port->write_urb->transfer_buffer;
 474         unsigned long flags = 0;
 475
 476         dbg("digi_write_inb_command: TOP: port=%d, count=%d",
 477                 priv->dp_port_num, count);
 478
 479         if (timeout)
 480                 timeout += jiffies;
 481         else
 482                 timeout = ULONG_MAX;
 483
 484         spin_lock_irqsave(&priv->dp_port_lock, flags);
 485         while (count > 0 && ret == 0) {
 486                 while (priv->dp_write_urb_in_use &&
 487                        time_before(jiffies, timeout)) {
 488                         cond_wait_interruptible_timeout_irqrestore(
 489                                 &port->write_wait, DIGI_RETRY_TIMEOUT,
 490                                 &priv->dp_port_lock, flags);
 491                         if (signal_pending(current))
 492                                 return -EINTR;
 493                         spin_lock_irqsave(&priv->dp_port_lock, flags);
 494                 }
 495
 496                 /* len must be a multiple of 4 and small enough to */
 497                 /* guarantee the write will send buffered data first, */
 498                 /* so commands are in order with data and not split */
 499                 len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
 500                 if (len > 4)
 501                         len &= ~3;
 502
 503                 /* write any buffered data first */
 504                 if (priv->dp_out_buf_len > 0) {
 505                         data[0] = DIGI_CMD_SEND_DATA;
 506                         data[1] = priv->dp_out_buf_len;
 507                         memcpy(data + 2, priv->dp_out_buf,
 508                                 priv->dp_out_buf_len);
 509                         memcpy(data + 2 + priv->dp_out_buf_len, buf, len);
 510                         port->write_urb->transfer_buffer_length
 511                                 = priv->dp_out_buf_len + 2 + len;
 512                 } else {
 513                         memcpy(data, buf, len);
 514                         port->write_urb->transfer_buffer_length = len;
 515                 }
 516
 517                 ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
 518                 if (ret == 0) {
 519                         priv->dp_write_urb_in_use = 1;
 520                         priv->dp_out_buf_len = 0;
 521                         count -= len;
 522                         buf += len;
 523                 }
 524
 525         }
 526         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 527
 528         if (ret)
 529                 dev_err(&port->dev,
 530                         "%s: usb_submit_urb failed, ret=%d, port=%d\n",
 531                         __func__, ret, priv->dp_port_num);
 532         return ret;
 533 }
 534
 535
 536 /*
 537  *  Digi Set Modem Signals
 538  *
 539  *  Sets or clears DTR and RTS on the port, according to the
 540  *  modem_signals argument.  Use TIOCM_DTR and TIOCM_RTS flags
 541  *  for the modem_signals argument.  Returns 0 if successful,
 542  *  -EINTR if interrupted while sleeping, or a non-zero error
 543  *  returned by usb_submit_urb.
 544  */
 545
 546 static int digi_set_modem_signals(struct usb_serial_port *port,
 547         unsigned int modem_signals, int interruptible)
 548 {
 549
 550         int ret;
 551         struct digi_port *port_priv = usb_get_serial_port_data(port);
 552         struct usb_serial_port *oob_port = (struct usb_serial_port *) ((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
 553         struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
 554         unsigned char *data = oob_port->write_urb->transfer_buffer;
 555         unsigned long flags = 0;
 556
 557
 558         dbg("digi_set_modem_signals: TOP: port=%d, modem_signals=0x%x",
 559                 port_priv->dp_port_num, modem_signals);
 560
 561         spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
 562         spin_lock(&port_priv->dp_port_lock);
 563
 564         while (oob_priv->dp_write_urb_in_use) {
 565                 spin_unlock(&port_priv->dp_port_lock);
 566                 cond_wait_interruptible_timeout_irqrestore(
 567                         &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
 568                         &oob_priv->dp_port_lock, flags);
 569                 if (interruptible && signal_pending(current))
 570                         return -EINTR;
 571                 spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
 572                 spin_lock(&port_priv->dp_port_lock);
 573         }
 574         data[0] = DIGI_CMD_SET_DTR_SIGNAL;
 575         data[1] = port_priv->dp_port_num;
 576         data[2] = (modem_signals & TIOCM_DTR) ?
 577                                         DIGI_DTR_ACTIVE : DIGI_DTR_INACTIVE;
 578         data[3] = 0;
 579         data[4] = DIGI_CMD_SET_RTS_SIGNAL;
 580         data[5] = port_priv->dp_port_num;
 581         data[6] = (modem_signals & TIOCM_RTS) ?
 582                                         DIGI_RTS_ACTIVE : DIGI_RTS_INACTIVE;
 583         data[7] = 0;
 584
 585         oob_port->write_urb->transfer_buffer_length = 8;
 586
 587         ret = usb_submit_urb(oob_port->write_urb, GFP_ATOMIC);
 588         if (ret == 0) {
 589                 oob_priv->dp_write_urb_in_use = 1;
 590                 port_priv->dp_modem_signals =
 591                         (port_priv->dp_modem_signals&~(TIOCM_DTR|TIOCM_RTS))
 592                         | (modem_signals&(TIOCM_DTR|TIOCM_RTS));
 593         }
 594         spin_unlock(&port_priv->dp_port_lock);
 595         spin_unlock_irqrestore(&oob_priv->dp_port_lock, flags);
 596         if (ret)
 597                 dev_err(&port->dev, "%s: usb_submit_urb failed, ret=%d\n",
 598                         __func__, ret);
 599         return ret;
 600 }
 601
 602 /*
 603  *  Digi Transmit Idle
 604  *
 605  *  Digi transmit idle waits, up to timeout ticks, for the transmitter
 606  *  to go idle.  It returns 0 if successful or a negative error.
 607  *
 608  *  There are race conditions here if more than one process is calling
 609  *  digi_transmit_idle on the same port at the same time.  However, this
 610  *  is only called from close, and only one process can be in close on a
 611  *  port at a time, so its ok.
 612  */
 613
 614 static int digi_transmit_idle(struct usb_serial_port *port,
 615         unsigned long timeout)
 616 {
 617         int ret;
 618         unsigned char buf[2];
 619         struct digi_port *priv = usb_get_serial_port_data(port);
 620         unsigned long flags = 0;
 621
 622         spin_lock_irqsave(&priv->dp_port_lock, flags);
 623         priv->dp_transmit_idle = 0;
 624         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 625
 626         buf[0] = DIGI_CMD_TRANSMIT_IDLE;
 627         buf[1] = 0;
 628
 629         timeout += jiffies;
 630
 631         ret = digi_write_inb_command(port, buf, 2, timeout - jiffies);
 632         if (ret != 0)
 633                 return ret;
 634
 635         spin_lock_irqsave(&priv->dp_port_lock, flags);
 636
 637         while (time_before(jiffies, timeout) && !priv->dp_transmit_idle) {
 638                 cond_wait_interruptible_timeout_irqrestore(
 639                         &priv->dp_transmit_idle_wait, DIGI_RETRY_TIMEOUT,
 640                         &priv->dp_port_lock, flags);
 641                 if (signal_pending(current))
 642                         return -EINTR;
 643                 spin_lock_irqsave(&priv->dp_port_lock, flags);
 644         }
 645         priv->dp_transmit_idle = 0;
 646         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 647         return 0;
 648
 649 }
 650
 651
 652 static void digi_rx_throttle(struct tty_struct *tty)
 653 {
 654         unsigned long flags;
 655         struct usb_serial_port *port = tty->driver_data;
 656         struct digi_port *priv = usb_get_serial_port_data(port);
 657
 658         /* stop receiving characters by not resubmitting the read urb */
 659         spin_lock_irqsave(&priv->dp_port_lock, flags);
 660         priv->dp_throttled = 1;
 661         priv->dp_throttle_restart = 0;
 662         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 663 }
 664
 665
 666 static void digi_rx_unthrottle(struct tty_struct *tty)
 667 {
 668         int ret = 0;
 669         unsigned long flags;
 670         struct usb_serial_port *port = tty->driver_data;
 671         struct digi_port *priv = usb_get_serial_port_data(port);
 672
 673         spin_lock_irqsave(&priv->dp_port_lock, flags);
 674
 675         /* restart read chain */
 676         if (priv->dp_throttle_restart)
 677                 ret = usb_submit_urb(port->read_urb, GFP_ATOMIC);
 678
 679         /* turn throttle off */
 680         priv->dp_throttled = 0;
 681         priv->dp_throttle_restart = 0;
 682
 683         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 684
 685         if (ret)
 686                 dev_err(&port->dev,
 687                         "%s: usb_submit_urb failed, ret=%d, port=%d\n",
 688                         __func__, ret, priv->dp_port_num);
 689 }
 690
 691
 692 static void digi_set_termios(struct tty_struct *tty,
 693                 struct usb_serial_port *port, struct ktermios *old_termios)
 694 {
 695         struct digi_port *priv = usb_get_serial_port_data(port);
 696         unsigned int iflag = tty->termios->c_iflag;
 697         unsigned int cflag = tty->termios->c_cflag;
 698         unsigned int old_iflag = old_termios->c_iflag;
 699         unsigned int old_cflag = old_termios->c_cflag;
 700         unsigned char buf[32];
 701         unsigned int modem_signals;
 702         int arg, ret;
 703         int i = 0;
 704         speed_t baud;
 705
 706         dbg("digi_set_termios: TOP: port=%d, iflag=0x%x, old_iflag=0x%x, cflag=0x%x, old_cflag=0x%x", priv->dp_port_num, iflag, old_iflag, cflag, old_cflag);
 707
 708         /* set baud rate */
 709         baud = tty_get_baud_rate(tty);
 710         if (baud != tty_termios_baud_rate(old_termios)) {
 711                 arg = -1;
 712
 713                 /* reassert DTR and (maybe) RTS on transition from B0 */
 714                 if ((old_cflag&CBAUD) == B0) {
 715                         /* don't set RTS if using hardware flow control */
 716                         /* and throttling input */
 717                         modem_signals = TIOCM_DTR;
 718                         if (!(tty->termios->c_cflag & CRTSCTS) ||
 719                             !test_bit(TTY_THROTTLED, &tty->flags))
 720                                 modem_signals |= TIOCM_RTS;
 721                         digi_set_modem_signals(port, modem_signals, 1);
 722                 }
 723                 switch (baud) {
 724                 /* drop DTR and RTS on transition to B0 */
 725                 case 0: digi_set_modem_signals(port, 0, 1); break;
 726                 case 50: arg = DIGI_BAUD_50; break;
 727                 case 75: arg = DIGI_BAUD_75; break;
 728                 case 110: arg = DIGI_BAUD_110; break;
 729                 case 150: arg = DIGI_BAUD_150; break;
 730                 case 200: arg = DIGI_BAUD_200; break;
 731                 case 300: arg = DIGI_BAUD_300; break;
 732                 case 600: arg = DIGI_BAUD_600; break;
 733                 case 1200: arg = DIGI_BAUD_1200; break;
 734                 case 1800: arg = DIGI_BAUD_1800; break;
 735                 case 2400: arg = DIGI_BAUD_2400; break;
 736                 case 4800: arg = DIGI_BAUD_4800; break;
 737                 case 9600: arg = DIGI_BAUD_9600; break;
 738                 case 19200: arg = DIGI_BAUD_19200; break;
 739                 case 38400: arg = DIGI_BAUD_38400; break;
 740                 case 57600: arg = DIGI_BAUD_57600; break;
 741                 case 115200: arg = DIGI_BAUD_115200; break;
 742                 case 230400: arg = DIGI_BAUD_230400; break;
 743                 case 460800: arg = DIGI_BAUD_460800; break;
 744                 default:
 745                         arg = DIGI_BAUD_9600;
 746                         baud = 9600;
 747                         break;
 748                 }
 749                 if (arg != -1) {
 750                         buf[i++] = DIGI_CMD_SET_BAUD_RATE;
 751                         buf[i++] = priv->dp_port_num;
 752                         buf[i++] = arg;
 753                         buf[i++] = 0;
 754                 }
 755         }
 756         /* set parity */
 757         tty->termios->c_cflag &= ~CMSPAR;
 758
 759         if ((cflag&(PARENB|PARODD)) != (old_cflag&(PARENB|PARODD))) {
 760                 if (cflag&PARENB) {
 761                         if (cflag&PARODD)
 762                                 arg = DIGI_PARITY_ODD;
 763                         else
 764                                 arg = DIGI_PARITY_EVEN;
 765                 } else {
 766                         arg = DIGI_PARITY_NONE;
 767                 }
 768                 buf[i++] = DIGI_CMD_SET_PARITY;
 769                 buf[i++] = priv->dp_port_num;
 770                 buf[i++] = arg;
 771                 buf[i++] = 0;
 772         }
 773         /* set word size */
 774         if ((cflag&CSIZE) != (old_cflag&CSIZE)) {
 775                 arg = -1;
 776                 switch (cflag&CSIZE) {
 777                 case CS5: arg = DIGI_WORD_SIZE_5; break;
 778                 case CS6: arg = DIGI_WORD_SIZE_6; break;
 779                 case CS7: arg = DIGI_WORD_SIZE_7; break;
 780                 case CS8: arg = DIGI_WORD_SIZE_8; break;
 781                 default:
 782                         dbg("digi_set_termios: can't handle word size %d",
 783                                 (cflag&CSIZE));
 784                         break;
 785                 }
 786
 787                 if (arg != -1) {
 788                         buf[i++] = DIGI_CMD_SET_WORD_SIZE;
 789                         buf[i++] = priv->dp_port_num;
 790                         buf[i++] = arg;
 791                         buf[i++] = 0;
 792                 }
 793
 794         }
 795
 796         /* set stop bits */
 797         if ((cflag&CSTOPB) != (old_cflag&CSTOPB)) {
 798
 799                 if ((cflag&CSTOPB))
 800                         arg = DIGI_STOP_BITS_2;
 801                 else
 802                         arg = DIGI_STOP_BITS_1;
 803
 804                 buf[i++] = DIGI_CMD_SET_STOP_BITS;
 805                 buf[i++] = priv->dp_port_num;
 806                 buf[i++] = arg;
 807                 buf[i++] = 0;
 808
 809         }
 810
 811         /* set input flow control */
 812         if ((iflag&IXOFF) != (old_iflag&IXOFF)
 813             || (cflag&CRTSCTS) != (old_cflag&CRTSCTS)) {
 814                 arg = 0;
 815                 if (iflag&IXOFF)
 816                         arg |= DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
 817                 else
 818                         arg &= ~DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
 819
 820                 if (cflag&CRTSCTS) {
 821                         arg |= DIGI_INPUT_FLOW_CONTROL_RTS;
 822
 823                         /* On USB-4 it is necessary to assert RTS prior */
 824                         /* to selecting RTS input flow control.  */
 825                         buf[i++] = DIGI_CMD_SET_RTS_SIGNAL;
 826                         buf[i++] = priv->dp_port_num;
 827                         buf[i++] = DIGI_RTS_ACTIVE;
 828                         buf[i++] = 0;
 829
 830                 } else {
 831                         arg &= ~DIGI_INPUT_FLOW_CONTROL_RTS;
 832                 }
 833                 buf[i++] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
 834                 buf[i++] = priv->dp_port_num;
 835                 buf[i++] = arg;
 836                 buf[i++] = 0;
 837         }
 838
 839         /* set output flow control */
 840         if ((iflag & IXON) != (old_iflag & IXON)
 841             || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
 842                 arg = 0;
 843                 if (iflag & IXON)
 844                         arg |= DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
 845                 else
 846                         arg &= ~DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
 847
 848                 if (cflag & CRTSCTS) {
 849                         arg |= DIGI_OUTPUT_FLOW_CONTROL_CTS;
 850                 } else {
 851                         arg &= ~DIGI_OUTPUT_FLOW_CONTROL_CTS;
 852                         tty->hw_stopped = 0;
 853                 }
 854
 855                 buf[i++] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
 856                 buf[i++] = priv->dp_port_num;
 857                 buf[i++] = arg;
 858                 buf[i++] = 0;
 859         }
 860
 861         /* set receive enable/disable */
 862         if ((cflag & CREAD) != (old_cflag & CREAD)) {
 863                 if (cflag & CREAD)
 864                         arg = DIGI_ENABLE;
 865                 else
 866                         arg = DIGI_DISABLE;
 867
 868                 buf[i++] = DIGI_CMD_RECEIVE_ENABLE;
 869                 buf[i++] = priv->dp_port_num;
 870                 buf[i++] = arg;
 871                 buf[i++] = 0;
 872         }
 873         ret = digi_write_oob_command(port, buf, i, 1);
 874         if (ret != 0)
 875                 dbg("digi_set_termios: write oob failed, ret=%d", ret);
 876         tty_encode_baud_rate(tty, baud, baud);
 877 }
 878
 879
 880 static void digi_break_ctl(struct tty_struct *tty, int break_state)
 881 {
 882         struct usb_serial_port *port = tty->driver_data;
 883         unsigned char buf[4];
 884
 885         buf[0] = DIGI_CMD_BREAK_CONTROL;
 886         buf[1] = 2;                             /* length */
 887         buf[2] = break_state ? 1 : 0;
 888         buf[3] = 0;                             /* pad */
 889         digi_write_inb_command(port, buf, 4, 0);
 890 }
 891
 892
 893 static int digi_tiocmget(struct tty_struct *tty)
 894 {
 895         struct usb_serial_port *port = tty->driver_data;
 896         struct digi_port *priv = usb_get_serial_port_data(port);
 897         unsigned int val;
 898         unsigned long flags;
 899
 900         spin_lock_irqsave(&priv->dp_port_lock, flags);
 901         val = priv->dp_modem_signals;
 902         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 903         return val;
 904 }
 905
 906
 907 static int digi_tiocmset(struct tty_struct *tty,
 908                                         unsigned int set, unsigned int clear)
 909 {
 910         struct usb_serial_port *port = tty->driver_data;
 911         struct digi_port *priv = usb_get_serial_port_data(port);
 912         unsigned int val;
 913         unsigned long flags;
 914
 915         spin_lock_irqsave(&priv->dp_port_lock, flags);
 916         val = (priv->dp_modem_signals & ~clear) | set;
 917         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 918         return digi_set_modem_signals(port, val, 1);
 919 }
 920
 921
 922 static int digi_write(struct tty_struct *tty, struct usb_serial_port *port,
 923                                         const unsigned char *buf, int count)
 924 {
 925
 926         int ret, data_len, new_len;
 927         struct digi_port *priv = usb_get_serial_port_data(port);
 928         unsigned char *data = port->write_urb->transfer_buffer;
 929         unsigned long flags = 0;
 930
 931         dbg("digi_write: TOP: port=%d, count=%d, in_interrupt=%ld",
 932                 priv->dp_port_num, count, in_interrupt());
 933
 934         /* copy user data (which can sleep) before getting spin lock */
 935         count = min(count, port->bulk_out_size-2);
 936         count = min(64, count);
 937
 938         /* be sure only one write proceeds at a time */
 939         /* there are races on the port private buffer */
 940         spin_lock_irqsave(&priv->dp_port_lock, flags);
 941
 942         /* wait for urb status clear to submit another urb */
 943         if (priv->dp_write_urb_in_use) {
 944                 /* buffer data if count is 1 (probably put_char) if possible */
 945                 if (count == 1 && priv->dp_out_buf_len < DIGI_OUT_BUF_SIZE) {
 946                         priv->dp_out_buf[priv->dp_out_buf_len++] = *buf;
 947                         new_len = 1;
 948                 } else {
 949                         new_len = 0;
 950                 }
 951                 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 952                 return new_len;
 953         }
 954
 955         /* allow space for any buffered data and for new data, up to */
 956         /* transfer buffer size - 2 (for command and length bytes) */
 957         new_len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
 958         data_len = new_len + priv->dp_out_buf_len;
 959
 960         if (data_len == 0) {
 961                 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 962                 return 0;
 963         }
 964
 965         port->write_urb->transfer_buffer_length = data_len+2;
 966
 967         *data++ = DIGI_CMD_SEND_DATA;
 968         *data++ = data_len;
 969
 970         /* copy in buffered data first */
 971         memcpy(data, priv->dp_out_buf, priv->dp_out_buf_len);
 972         data += priv->dp_out_buf_len;
 973
 974         /* copy in new data */
 975         memcpy(data, buf, new_len);
 976
 977         ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
 978         if (ret == 0) {
 979                 priv->dp_write_urb_in_use = 1;
 980                 ret = new_len;
 981                 priv->dp_out_buf_len = 0;
 982         }
 983
 984         /* return length of new data written, or error */
 985         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 986         if (ret < 0)
 987                 dev_err_console(port,
 988                         "%s: usb_submit_urb failed, ret=%d, port=%d\n",
 989                         __func__, ret, priv->dp_port_num);
 990         dbg("digi_write: returning %d", ret);
 991         return ret;
 992
 993 }
 994
 995 static void digi_write_bulk_callback(struct urb *urb)
 996 {
 997
 998         struct usb_serial_port *port = urb->context;
 999         struct usb_serial *serial;
1000         struct digi_port *priv;
1001         struct digi_serial *serial_priv;
1002         int ret = 0;
1003         int status = urb->status;
1004
1005         /* port and serial sanity check */
1006         if (port == NULL || (priv = usb_get_serial_port_data(port)) == NULL) {
1007                 pr_err("%s: port or port->private is NULL, status=%d\n",
1008                         __func__, status);
1009                 return;
1010         }
1011         serial = port->serial;
1012         if (serial == NULL || (serial_priv = usb_get_serial_data(serial)) == NULL) {
1013                 dev_err(&port->dev,
1014                         "%s: serial or serial->private is NULL, status=%d\n",
1015                         __func__, status);
1016                 return;
1017         }
1018
1019         /* handle oob callback */
1020         if (priv->dp_port_num == serial_priv->ds_oob_port_num) {
1021                 dbg("digi_write_bulk_callback: oob callback");
1022                 spin_lock(&priv->dp_port_lock);
1023                 priv->dp_write_urb_in_use = 0;
1024                 wake_up_interruptible(&port->write_wait);
1025                 spin_unlock(&priv->dp_port_lock);
1026                 return;
1027         }
1028
1029         /* try to send any buffered data on this port */
1030         spin_lock(&priv->dp_port_lock);
1031         priv->dp_write_urb_in_use = 0;
1032         if (priv->dp_out_buf_len > 0) {
1033                 *((unsigned char *)(port->write_urb->transfer_buffer))
1034                         = (unsigned char)DIGI_CMD_SEND_DATA;
1035                 *((unsigned char *)(port->write_urb->transfer_buffer) + 1)
1036                         = (unsigned char)priv->dp_out_buf_len;
1037                 port->write_urb->transfer_buffer_length =
1038                                                 priv->dp_out_buf_len + 2;
1039                 memcpy(port->write_urb->transfer_buffer + 2, priv->dp_out_buf,
1040                         priv->dp_out_buf_len);
1041                 ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1042                 if (ret == 0) {
1043                         priv->dp_write_urb_in_use = 1;
1044                         priv->dp_out_buf_len = 0;
1045                 }
1046         }
1047         /* wake up processes sleeping on writes immediately */
1048         digi_wakeup_write(port);
1049         /* also queue up a wakeup at scheduler time, in case we */
1050         /* lost the race in write_chan(). */
1051         schedule_work(&priv->dp_wakeup_work);
1052
1053         spin_unlock(&priv->dp_port_lock);
1054         if (ret && ret != -EPERM)
1055                 dev_err_console(port,
1056                         "%s: usb_submit_urb failed, ret=%d, port=%d\n",
1057                         __func__, ret, priv->dp_port_num);
1058 }
1059
1060 static int digi_write_room(struct tty_struct *tty)
1061 {
1062         struct usb_serial_port *port = tty->driver_data;
1063         struct digi_port *priv = usb_get_serial_port_data(port);
1064         int room;
1065         unsigned long flags = 0;
1066
1067         spin_lock_irqsave(&priv->dp_port_lock, flags);
1068
1069         if (priv->dp_write_urb_in_use)
1070                 room = 0;
1071         else
1072                 room = port->bulk_out_size - 2 - priv->dp_out_buf_len;
1073
1074         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1075         dbg("digi_write_room: port=%d, room=%d", priv->dp_port_num, room);
1076         return room;
1077
1078 }
1079
1080 static int digi_chars_in_buffer(struct tty_struct *tty)
1081 {
1082         struct usb_serial_port *port = tty->driver_data;
1083         struct digi_port *priv = usb_get_serial_port_data(port);
1084
1085         if (priv->dp_write_urb_in_use) {
1086                 dbg("digi_chars_in_buffer: port=%d, chars=%d",
1087                         priv->dp_port_num, port->bulk_out_size - 2);
1088                 /* return(port->bulk_out_size - 2); */
1089                 return 256;
1090         } else {
1091                 dbg("digi_chars_in_buffer: port=%d, chars=%d",
1092                         priv->dp_port_num, priv->dp_out_buf_len);
1093                 return priv->dp_out_buf_len;
1094         }
1095
1096 }
1097
1098 static void digi_dtr_rts(struct usb_serial_port *port, int on)
1099 {
1100         /* Adjust DTR and RTS */
1101         digi_set_modem_signals(port, on * (TIOCM_DTR|TIOCM_RTS), 1);
1102 }
1103
1104 static int digi_open(struct tty_struct *tty, struct usb_serial_port *port)
1105 {
1106         int ret;
1107         unsigned char buf[32];
1108         struct digi_port *priv = usb_get_serial_port_data(port);
1109         struct ktermios not_termios;
1110
1111         /* be sure the device is started up */
1112         if (digi_startup_device(port->serial) != 0)
1113                 return -ENXIO;
1114
1115         /* read modem signals automatically whenever they change */
1116         buf[0] = DIGI_CMD_READ_INPUT_SIGNALS;
1117         buf[1] = priv->dp_port_num;
1118         buf[2] = DIGI_ENABLE;
1119         buf[3] = 0;
1120
1121         /* flush fifos */
1122         buf[4] = DIGI_CMD_IFLUSH_FIFO;
1123         buf[5] = priv->dp_port_num;
1124         buf[6] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1125         buf[7] = 0;
1126
1127         ret = digi_write_oob_command(port, buf, 8, 1);
1128         if (ret != 0)
1129                 dbg("digi_open: write oob failed, ret=%d", ret);
1130
1131         /* set termios settings */
1132         if (tty) {
1133                 not_termios.c_cflag = ~tty->termios->c_cflag;
1134                 not_termios.c_iflag = ~tty->termios->c_iflag;
1135                 digi_set_termios(tty, port, &not_termios);
1136         }
1137         return 0;
1138 }
1139
1140
1141 static void digi_close(struct usb_serial_port *port)
1142 {
1143         DEFINE_WAIT(wait);
1144         int ret;
1145         unsigned char buf[32];
1146         struct digi_port *priv = usb_get_serial_port_data(port);
1147
1148         mutex_lock(&port->serial->disc_mutex);
1149         /* if disconnected, just clear flags */
1150         if (port->serial->disconnected)
1151                 goto exit;
1152
1153         if (port->serial->dev) {
1154                 /* FIXME: Transmit idle belongs in the wait_unti_sent path */
1155                 digi_transmit_idle(port, DIGI_CLOSE_TIMEOUT);
1156
1157                 /* disable input flow control */
1158                 buf[0] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1159                 buf[1] = priv->dp_port_num;
1160                 buf[2] = DIGI_DISABLE;
1161                 buf[3] = 0;
1162
1163                 /* disable output flow control */
1164                 buf[4] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1165                 buf[5] = priv->dp_port_num;
1166                 buf[6] = DIGI_DISABLE;
1167                 buf[7] = 0;
1168
1169                 /* disable reading modem signals automatically */
1170                 buf[8] = DIGI_CMD_READ_INPUT_SIGNALS;
1171                 buf[9] = priv->dp_port_num;
1172                 buf[10] = DIGI_DISABLE;
1173                 buf[11] = 0;
1174
1175                 /* disable receive */
1176                 buf[12] = DIGI_CMD_RECEIVE_ENABLE;
1177                 buf[13] = priv->dp_port_num;
1178                 buf[14] = DIGI_DISABLE;
1179                 buf[15] = 0;
1180
1181                 /* flush fifos */
1182                 buf[16] = DIGI_CMD_IFLUSH_FIFO;
1183                 buf[17] = priv->dp_port_num;
1184                 buf[18] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1185                 buf[19] = 0;
1186
1187                 ret = digi_write_oob_command(port, buf, 20, 0);
1188                 if (ret != 0)
1189                         dbg("digi_close: write oob failed, ret=%d", ret);
1190
1191                 /* wait for final commands on oob port to complete */
1192                 prepare_to_wait(&priv->dp_flush_wait, &wait,
1193                                                         TASK_INTERRUPTIBLE);
1194                 schedule_timeout(DIGI_CLOSE_TIMEOUT);
1195                 finish_wait(&priv->dp_flush_wait, &wait);
1196
1197                 /* shutdown any outstanding bulk writes */
1198                 usb_kill_urb(port->write_urb);
1199         }
1200 exit:
1201         spin_lock_irq(&priv->dp_port_lock);
1202         priv->dp_write_urb_in_use = 0;
1203         wake_up_interruptible(&priv->dp_close_wait);
1204         spin_unlock_irq(&priv->dp_port_lock);
1205         mutex_unlock(&port->serial->disc_mutex);
1206 }
1207
1208
1209 /*
1210  *  Digi Startup Device
1211  *
1212  *  Starts reads on all ports.  Must be called AFTER startup, with
1213  *  urbs initialized.  Returns 0 if successful, non-zero error otherwise.
1214  */
1215
1216 static int digi_startup_device(struct usb_serial *serial)
1217 {
1218         int i, ret = 0;
1219         struct digi_serial *serial_priv = usb_get_serial_data(serial);
1220         struct usb_serial_port *port;
1221
1222         /* be sure this happens exactly once */
1223         spin_lock(&serial_priv->ds_serial_lock);
1224         if (serial_priv->ds_device_started) {
1225                 spin_unlock(&serial_priv->ds_serial_lock);
1226                 return 0;
1227         }
1228         serial_priv->ds_device_started = 1;
1229         spin_unlock(&serial_priv->ds_serial_lock);
1230
1231         /* start reading from each bulk in endpoint for the device */
1232         /* set USB_DISABLE_SPD flag for write bulk urbs */
1233         for (i = 0; i < serial->type->num_ports + 1; i++) {
1234                 port = serial->port[i];
1235                 ret = usb_submit_urb(port->read_urb, GFP_KERNEL);
1236                 if (ret != 0) {
1237                         dev_err(&port->dev,
1238                                 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
1239                                 __func__, ret, i);
1240                         break;
1241                 }
1242         }
1243         return ret;
1244 }
1245
1246
1247 static int digi_startup(struct usb_serial *serial)
1248 {
1249
1250         int i;
1251         struct digi_port *priv;
1252         struct digi_serial *serial_priv;
1253
1254         /* allocate the private data structures for all ports */
1255         /* number of regular ports + 1 for the out-of-band port */
1256         for (i = 0; i < serial->type->num_ports + 1; i++) {
1257                 /* allocate port private structure */
1258                 priv = kmalloc(sizeof(struct digi_port), GFP_KERNEL);
1259                 if (priv == NULL) {
1260                         while (--i >= 0)
1261                                 kfree(usb_get_serial_port_data(serial->port[i]));
1262                         return 1;                       /* error */
1263                 }
1264
1265                 /* initialize port private structure */
1266                 spin_lock_init(&priv->dp_port_lock);
1267                 priv->dp_port_num = i;
1268                 priv->dp_out_buf_len = 0;
1269                 priv->dp_write_urb_in_use = 0;
1270                 priv->dp_modem_signals = 0;
1271                 init_waitqueue_head(&priv->dp_modem_change_wait);
1272                 priv->dp_transmit_idle = 0;
1273                 init_waitqueue_head(&priv->dp_transmit_idle_wait);
1274                 priv->dp_throttled = 0;
1275                 priv->dp_throttle_restart = 0;
1276                 init_waitqueue_head(&priv->dp_flush_wait);
1277                 init_waitqueue_head(&priv->dp_close_wait);
1278                 INIT_WORK(&priv->dp_wakeup_work, digi_wakeup_write_lock);
1279                 priv->dp_port = serial->port[i];
1280                 /* initialize write wait queue for this port */
1281                 init_waitqueue_head(&serial->port[i]->write_wait);
1282
1283                 usb_set_serial_port_data(serial->port[i], priv);
1284         }
1285
1286         /* allocate serial private structure */
1287         serial_priv = kmalloc(sizeof(struct digi_serial), GFP_KERNEL);
1288         if (serial_priv == NULL) {
1289                 for (i = 0; i < serial->type->num_ports + 1; i++)
1290                         kfree(usb_get_serial_port_data(serial->port[i]));
1291                 return 1;                       /* error */
1292         }
1293
1294         /* initialize serial private structure */
1295         spin_lock_init(&serial_priv->ds_serial_lock);
1296         serial_priv->ds_oob_port_num = serial->type->num_ports;
1297         serial_priv->ds_oob_port = serial->port[serial_priv->ds_oob_port_num];
1298         serial_priv->ds_device_started = 0;
1299         usb_set_serial_data(serial, serial_priv);
1300
1301         return 0;
1302 }
1303
1304
1305 static void digi_disconnect(struct usb_serial *serial)
1306 {
1307         int i;
1308
1309         /* stop reads and writes on all ports */
1310         for (i = 0; i < serial->type->num_ports + 1; i++) {
1311                 usb_kill_urb(serial->port[i]->read_urb);
1312                 usb_kill_urb(serial->port[i]->write_urb);
1313         }
1314 }
1315
1316
1317 static void digi_release(struct usb_serial *serial)
1318 {
1319         int i;
1320
1321         /* free the private data structures for all ports */
1322         /* number of regular ports + 1 for the out-of-band port */
1323         for (i = 0; i < serial->type->num_ports + 1; i++)
1324                 kfree(usb_get_serial_port_data(serial->port[i]));
1325         kfree(usb_get_serial_data(serial));
1326 }
1327
1328
1329 static void digi_read_bulk_callback(struct urb *urb)
1330 {
1331         struct usb_serial_port *port = urb->context;
1332         struct digi_port *priv;
1333         struct digi_serial *serial_priv;
1334         int ret;
1335         int status = urb->status;
1336
1337         /* port sanity check, do not resubmit if port is not valid */
1338         if (port == NULL)
1339                 return;
1340         priv = usb_get_serial_port_data(port);
1341         if (priv == NULL) {
1342                 dev_err(&port->dev, "%s: port->private is NULL, status=%d\n",
1343                         __func__, status);
1344                 return;
1345         }
1346         if (port->serial == NULL ||
1347                 (serial_priv = usb_get_serial_data(port->serial)) == NULL) {
1348                 dev_err(&port->dev, "%s: serial is bad or serial->private "
1349                         "is NULL, status=%d\n", __func__, status);
1350                 return;
1351         }
1352
1353         /* do not resubmit urb if it has any status error */
1354         if (status) {
1355                 dev_err(&port->dev,
1356                         "%s: nonzero read bulk status: status=%d, port=%d\n",
1357                         __func__, status, priv->dp_port_num);
1358                 return;
1359         }
1360
1361         /* handle oob or inb callback, do not resubmit if error */
1362         if (priv->dp_port_num == serial_priv->ds_oob_port_num) {
1363                 if (digi_read_oob_callback(urb) != 0)
1364                         return;
1365         } else {
1366                 if (digi_read_inb_callback(urb) != 0)
1367                         return;
1368         }
1369
1370         /* continue read */
1371         ret = usb_submit_urb(urb, GFP_ATOMIC);
1372         if (ret != 0 && ret != -EPERM) {
1373                 dev_err(&port->dev,
1374                         "%s: failed resubmitting urb, ret=%d, port=%d\n",
1375                         __func__, ret, priv->dp_port_num);
1376         }
1377
1378 }
1379
1380 /*
1381  *  Digi Read INB Callback
1382  *
1383  *  Digi Read INB Callback handles reads on the in band ports, sending
1384  *  the data on to the tty subsystem.  When called we know port and
1385  *  port->private are not NULL and port->serial has been validated.
1386  *  It returns 0 if successful, 1 if successful but the port is
1387  *  throttled, and -1 if the sanity checks failed.
1388  */
1389
1390 static int digi_read_inb_callback(struct urb *urb)
1391 {
1392
1393         struct usb_serial_port *port = urb->context;
1394         struct tty_struct *tty;
1395         struct digi_port *priv = usb_get_serial_port_data(port);
1396         int opcode = ((unsigned char *)urb->transfer_buffer)[0];
1397         int len = ((unsigned char *)urb->transfer_buffer)[1];
1398         int port_status = ((unsigned char *)urb->transfer_buffer)[2];
1399         unsigned char *data = ((unsigned char *)urb->transfer_buffer) + 3;
1400         int flag, throttled;
1401         int status = urb->status;
1402
1403         /* do not process callbacks on closed ports */
1404         /* but do continue the read chain */
1405         if (urb->status == -ENOENT)
1406                 return 0;
1407
1408         /* short/multiple packet check */
1409         if (urb->actual_length != len + 2) {
1410                 dev_err(&port->dev, "%s: INCOMPLETE OR MULTIPLE PACKET, "
1411                         "status=%d, port=%d, opcode=%d, len=%d, "
1412                         "actual_length=%d, status=%d\n", __func__, status,
1413                         priv->dp_port_num, opcode, len, urb->actual_length,
1414                         port_status);
1415                 return -1;
1416         }
1417
1418         tty = tty_port_tty_get(&port->port);
1419         spin_lock(&priv->dp_port_lock);
1420
1421         /* check for throttle; if set, do not resubmit read urb */
1422         /* indicate the read chain needs to be restarted on unthrottle */
1423         throttled = priv->dp_throttled;
1424         if (throttled)
1425                 priv->dp_throttle_restart = 1;
1426
1427         /* receive data */
1428         if (tty && opcode == DIGI_CMD_RECEIVE_DATA) {
1429                 /* get flag from port_status */
1430                 flag = 0;
1431
1432                 /* overrun is special, not associated with a char */
1433                 if (port_status & DIGI_OVERRUN_ERROR)
1434                         tty_insert_flip_char(tty, 0, TTY_OVERRUN);
1435
1436                 /* break takes precedence over parity, */
1437                 /* which takes precedence over framing errors */
1438                 if (port_status & DIGI_BREAK_ERROR)
1439                         flag = TTY_BREAK;
1440                 else if (port_status & DIGI_PARITY_ERROR)
1441                         flag = TTY_PARITY;
1442                 else if (port_status & DIGI_FRAMING_ERROR)
1443                         flag = TTY_FRAME;
1444
1445                 /* data length is len-1 (one byte of len is port_status) */
1446                 --len;
1447                 if (len > 0) {
1448                         tty_insert_flip_string_fixed_flag(tty, data, flag,
1449                                                                         len);
1450                         tty_flip_buffer_push(tty);
1451                 }
1452         }
1453         spin_unlock(&priv->dp_port_lock);
1454         tty_kref_put(tty);
1455
1456         if (opcode == DIGI_CMD_RECEIVE_DISABLE)
1457                 dbg("%s: got RECEIVE_DISABLE", __func__);
1458         else if (opcode != DIGI_CMD_RECEIVE_DATA)
1459                 dbg("%s: unknown opcode: %d", __func__, opcode);
1460
1461         return throttled ? 1 : 0;
1462
1463 }
1464
1465
1466 /*
1467  *  Digi Read OOB Callback
1468  *
1469  *  Digi Read OOB Callback handles reads on the out of band port.
1470  *  When called we know port and port->private are not NULL and
1471  *  the port->serial is valid.  It returns 0 if successful, and
1472  *  -1 if the sanity checks failed.
1473  */
1474
1475 static int digi_read_oob_callback(struct urb *urb)
1476 {
1477
1478         struct usb_serial_port *port = urb->context;
1479         struct usb_serial *serial = port->serial;
1480         struct tty_struct *tty;
1481         struct digi_port *priv = usb_get_serial_port_data(port);
1482         int opcode, line, status, val;
1483         int i;
1484         unsigned int rts;
1485
1486         /* handle each oob command */
1487         for (i = 0; i < urb->actual_length - 3;) {
1488                 opcode = ((unsigned char *)urb->transfer_buffer)[i++];
1489                 line = ((unsigned char *)urb->transfer_buffer)[i++];
1490                 status = ((unsigned char *)urb->transfer_buffer)[i++];
1491                 val = ((unsigned char *)urb->transfer_buffer)[i++];
1492
1493                 dbg("digi_read_oob_callback: opcode=%d, line=%d, status=%d, val=%d",
1494                         opcode, line, status, val);
1495
1496                 if (status != 0 || line >= serial->type->num_ports)
1497                         continue;
1498
1499                 port = serial->port[line];
1500
1501                 priv = usb_get_serial_port_data(port);
1502                 if (priv == NULL)
1503                         return -1;
1504
1505                 tty = tty_port_tty_get(&port->port);
1506
1507                 rts = 0;
1508                 if (tty)
1509                         rts = tty->termios->c_cflag & CRTSCTS;
1510
1511                 if (tty && opcode == DIGI_CMD_READ_INPUT_SIGNALS) {
1512                         spin_lock(&priv->dp_port_lock);
1513                         /* convert from digi flags to termiox flags */
1514                         if (val & DIGI_READ_INPUT_SIGNALS_CTS) {
1515                                 priv->dp_modem_signals |= TIOCM_CTS;
1516                                 /* port must be open to use tty struct */
1517                                 if (rts) {
1518                                         tty->hw_stopped = 0;
1519                                         digi_wakeup_write(port);
1520                                 }
1521                         } else {
1522                                 priv->dp_modem_signals &= ~TIOCM_CTS;
1523                                 /* port must be open to use tty struct */
1524                                 if (rts)
1525                                         tty->hw_stopped = 1;
1526                         }
1527                         if (val & DIGI_READ_INPUT_SIGNALS_DSR)
1528                                 priv->dp_modem_signals |= TIOCM_DSR;
1529                         else
1530                                 priv->dp_modem_signals &= ~TIOCM_DSR;
1531                         if (val & DIGI_READ_INPUT_SIGNALS_RI)
1532                                 priv->dp_modem_signals |= TIOCM_RI;
1533                         else
1534                                 priv->dp_modem_signals &= ~TIOCM_RI;
1535                         if (val & DIGI_READ_INPUT_SIGNALS_DCD)
1536                                 priv->dp_modem_signals |= TIOCM_CD;
1537                         else
1538                                 priv->dp_modem_signals &= ~TIOCM_CD;
1539
1540                         wake_up_interruptible(&priv->dp_modem_change_wait);
1541                         spin_unlock(&priv->dp_port_lock);
1542                 } else if (opcode == DIGI_CMD_TRANSMIT_IDLE) {
1543                         spin_lock(&priv->dp_port_lock);
1544                         priv->dp_transmit_idle = 1;
1545                         wake_up_interruptible(&priv->dp_transmit_idle_wait);
1546                         spin_unlock(&priv->dp_port_lock);
1547                 } else if (opcode == DIGI_CMD_IFLUSH_FIFO) {
1548                         wake_up_interruptible(&priv->dp_flush_wait);
1549                 }
1550                 tty_kref_put(tty);
1551         }
1552         return 0;
1553
1554 }
1555
1556 module_usb_serial_driver(digi_driver, serial_drivers);
1557
1558 MODULE_AUTHOR(DRIVER_AUTHOR);
1559 MODULE_DESCRIPTION(DRIVER_DESC);
1560 MODULE_LICENSE("GPL");
1561
1562 module_param(debug, bool, S_IRUGO | S_IWUSR);
1563 MODULE_PARM_DESC(debug, "Debug enabled or not");