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 * (12/03/2001) gkh
  18 *       switched to using port->open_count instead of private version.
  19 *       Removed port->active
  20 *
  21 * (04/08/2001) gb
  22 *       Identify version on module load.
  23 *
  24 * (11/01/2000) Adam J. Richter
  25 *       usb_device_id table support
  26 *
  27 * (11/01/2000) pberger and borchers
  28 *    -- Turned off the USB_DISABLE_SPD flag for write bulk urbs--it caused
  29 *       USB 4 ports to hang on startup.
  30 *    -- Serialized access to write urbs by adding the dp_write_urb_in_use
  31 *       flag; otherwise, the driver caused SMP system hangs.  Watching the
  32 *       urb status is not sufficient.
  33 *
  34 * (10/05/2000) gkh
  35 *    -- Fixed bug with urb->dev not being set properly, now that the usb
  36 *       core needs it.
  37 *
  38 *  (8/8/2000) pberger and borchers
  39 *    -- Fixed close so that
  40 *       - it can timeout while waiting for transmit idle, if needed;
  41 *       - it ignores interrupts when flushing the port, turning
  42 *         of modem signalling, and so on;
  43 *       - it waits for the flush to really complete before returning.
  44 *    -- Read_bulk_callback and write_bulk_callback check for a closed
  45 *       port before using the tty struct or writing to the port.
  46 *    -- The two changes above fix the oops caused by interrupted closes.
  47 *    -- Added interruptible args to write_oob_command and set_modem_signals
  48 *       and added a timeout arg to transmit_idle; needed for fixes to
  49 *       close.
  50 *    -- Added code for rx_throttle and rx_unthrottle so that input flow
  51 *       control works.
  52 *    -- Added code to set overrun, parity, framing, and break errors
  53 *       (untested).
  54 *    -- Set USB_DISABLE_SPD flag for write bulk urbs, so no 0 length
  55 *       bulk writes are done.  These hung the Digi USB device.  The
  56 *       0 length bulk writes were a new feature of usb-uhci added in
  57 *       the 2.4.0-test6 kernels.
  58 *    -- Fixed mod inc race in open; do mod inc before sleeping to wait
  59 *       for a close to finish.
  60 *
  61 *  (7/31/2000) pberger
  62 *    -- Fixed bugs with hardware handshaking:
  63 *       - Added code to set/clear tty->hw_stopped in digi_read_oob_callback()
  64 *         and digi_set_termios()
  65 *    -- Added code in digi_set_termios() to
  66 *       - add conditional in code handling transition from B0 to only
  67 *         set RTS if RTS/CTS flow control is either not in use or if
  68 *         the port is not currently throttled.
  69 *       - handle turning off CRTSCTS.
  70 *
  71 *  (7/30/2000) borchers
  72 *    -- Added support for more than one Digi USB device by moving
  73 *       globals to a private structure in the pointed to from the
  74 *       usb_serial structure.
  75 *    -- Moved the modem change and transmit idle wait queues into
  76 *       the port private structure, so each port has its own queue
  77 *       rather than sharing global queues.
  78 *    -- Added support for break signals.
  79 *
  80 *  (7/25/2000) pberger
  81 *    -- Added USB-2 support.  Note: the USB-2 supports 3 devices: two
  82 *       serial and a parallel port.  The parallel port is implemented
  83 *       as a serial-to-parallel converter.  That is, the driver actually
  84 *       presents all three USB-2 interfaces as serial ports, but the third
  85 *       one physically connects to a parallel device.  Thus, for example,
  86 *       one could plug a parallel printer into the USB-2's third port,
  87 *       but from the kernel's (and userland's) point of view what's
  88 *       actually out there is a serial device.
  89 *
  90 *  (7/15/2000) borchers
  91 *    -- Fixed race in open when a close is in progress.
  92 *    -- Keep count of opens and dec the module use count for each
  93 *       outstanding open when shutdown is called (on disconnect).
  94 *    -- Fixed sanity checks in read_bulk_callback and write_bulk_callback
  95 *       so pointers are checked before use.
  96 *    -- Split read bulk callback into in band and out of band
  97 *       callbacks, and no longer restart read chains if there is
  98 *       a status error or a sanity error.  This fixed the seg
  99 *       faults and other errors we used to get on disconnect.
 100 *    -- Port->active is once again a flag as usb-serial intended it
 101 *       to be, not a count.  Since it was only a char it would
 102 *       have been limited to 256 simultaneous opens.  Now the open
 103 *       count is kept in the port private structure in dp_open_count.
 104 *    -- Added code for modularization of the digi_acceleport driver.
 105 *
 106 *  (6/27/2000) pberger and borchers
 107 *    -- Zeroed out sync field in the wakeup_task before first use;
 108 *       otherwise the uninitialized value might prevent the task from
 109 *       being scheduled.
 110 *    -- Initialized ret value to 0 in write_bulk_callback, otherwise
 111 *       the uninitialized value could cause a spurious debugging message.
 112 *
 113 *  (6/22/2000) pberger and borchers
 114 *    -- Made cond_wait_... inline--apparently on SPARC the flags arg
 115 *       to spin_lock_irqsave cannot be passed to another function
 116 *       to call spin_unlock_irqrestore.  Thanks to Pauline Middelink.
 117 *    -- In digi_set_modem_signals the inner nested spin locks use just
 118 *       spin_lock() rather than spin_lock_irqsave().  The old code
 119 *       mistakenly left interrupts off.  Thanks to Pauline Middelink.
 120 *    -- copy_from_user (which can sleep) is no longer called while a
 121 *       spinlock is held.  We copy to a local buffer before getting
 122 *       the spinlock--don't like the extra copy but the code is simpler.
 123 *    -- Printk and dbg are no longer called while a spin lock is held.
 124 *
 125 *  (6/4/2000) pberger and borchers
 126 *    -- Replaced separate calls to spin_unlock_irqrestore and
 127 *       interruptible_sleep_on_timeout with a new function
 128 *       cond_wait_interruptible_timeout_irqrestore.  This eliminates
 129 *       the race condition where the wake up could happen after
 130 *       the unlock and before the sleep.
 131 *    -- Close now waits for output to drain.
 132 *    -- Open waits until any close in progress is finished.
 133 *    -- All out of band responses are now processed, not just the
 134 *       first in a USB packet.
 135 *    -- Fixed a bug that prevented the driver from working when the
 136 *       first Digi port was not the first USB serial port--the driver
 137 *       was mistakenly using the external USB serial port number to
 138 *       try to index into its internal ports.
 139 *    -- Fixed an SMP bug -- write_bulk_callback is called directly from
 140 *       an interrupt, so spin_lock_irqsave/spin_unlock_irqrestore are
 141 *       needed for locks outside write_bulk_callback that are also
 142 *       acquired by write_bulk_callback to prevent deadlocks.
 143 *    -- Fixed support for select() by making digi_chars_in_buffer()
 144 *       return 256 when -EINPROGRESS is set, as the line discipline
 145 *       code in n_tty.c expects.
 146 *    -- Fixed an include file ordering problem that prevented debugging
 147 *       messages from working.
 148 *    -- Fixed an intermittent timeout problem that caused writes to
 149 *       sometimes get stuck on some machines on some kernels.  It turns
 150 *       out in these circumstances write_chan() (in n_tty.c) was
 151 *       asleep waiting for our wakeup call.  Even though we call
 152 *       wake_up_interruptible() in digi_write_bulk_callback(), there is
 153 *       a race condition that could cause the wakeup to fail: if our
 154 *       wake_up_interruptible() call occurs between the time that our
 155 *       driver write routine finishes and write_chan() sets current->state
 156 *       to TASK_INTERRUPTIBLE, the effect of our wakeup setting the state
 157 *       to TASK_RUNNING will be lost and write_chan's subsequent call to
 158 *       schedule() will never return (unless it catches a signal).
 159 *       This race condition occurs because write_bulk_callback() (and thus
 160 *       the wakeup) are called asynchronously from an interrupt, rather than
 161 *       from the scheduler.  We can avoid the race by calling the wakeup
 162 *       from the scheduler queue and that's our fix:  Now, at the end of
 163 *       write_bulk_callback() we queue up a wakeup call on the scheduler
 164 *       task queue.  We still also invoke the wakeup directly since that
 165 *       squeezes a bit more performance out of the driver, and any lost
 166 *       race conditions will get cleaned up at the next scheduler run.
 167 *
 168 *       NOTE:  The problem also goes away if you comment out
 169 *       the two code lines in write_chan() where current->state
 170 *       is set to TASK_RUNNING just before calling driver.write() and to
 171 *       TASK_INTERRUPTIBLE immediately afterwards.  This is why the
 172 *       problem did not show up with the 2.2 kernels -- they do not
 173 *       include that code.
 174 *
 175 *  (5/16/2000) pberger and borchers
 176 *    -- Added timeouts to sleeps, to defend against lost wake ups.
 177 *    -- Handle transition to/from B0 baud rate in digi_set_termios.
 178 *
 179 *  (5/13/2000) pberger and borchers
 180 *    -- All commands now sent on out of band port, using
 181 *       digi_write_oob_command.
 182 *    -- Get modem control signals whenever they change, support TIOCMGET/
 183 *       SET/BIS/BIC ioctls.
 184 *    -- digi_set_termios now supports parity, word size, stop bits, and
 185 *       receive enable.
 186 *    -- Cleaned up open and close, use digi_set_termios and
 187 *       digi_write_oob_command to set port parameters.
 188 *    -- Added digi_startup_device to start read chains on all ports.
 189 *    -- Write buffer is only used when count==1, to be sure put_char can
 190 *       write a char (unless the buffer is full).
 191 *
 192 *  (5/10/2000) pberger and borchers
 193 *    -- Added MOD_INC_USE_COUNT/MOD_DEC_USE_COUNT calls on open/close.
 194 *    -- Fixed problem where the first incoming character is lost on
 195 *       port opens after the first close on that port.  Now we keep
 196 *       the read_urb chain open until shutdown.
 197 *    -- Added more port conditioning calls in digi_open and digi_close.
 198 *    -- Convert port->active to a use count so that we can deal with multiple
 199 *       opens and closes properly.
 200 *    -- Fixed some problems with the locking code.
 201 *
 202 *  (5/3/2000) pberger and borchers
 203 *    -- First alpha version of the driver--many known limitations and bugs.
 204 *
 205 *
 206 *  Locking and SMP
 207 *
 208 *  - Each port, including the out-of-band port, has a lock used to
 209 *    serialize all access to the port's private structure.
 210 *  - The port lock is also used to serialize all writes and access to
 211 *    the port's URB.
 212 *  - The port lock is also used for the port write_wait condition
 213 *    variable.  Holding the port lock will prevent a wake up on the
 214 *    port's write_wait; this can be used with cond_wait_... to be sure
 215 *    the wake up is not lost in a race when dropping the lock and
 216 *    sleeping waiting for the wakeup.
 217 *  - digi_write() does not sleep, since it is sometimes called on
 218 *    interrupt time.
 219 *  - digi_write_bulk_callback() and digi_read_bulk_callback() are
 220 *    called directly from interrupts.  Hence spin_lock_irqsave()
 221 *    and spin_unlock_irqrestore() are used in the rest of the code
 222 *    for any locks they acquire.
 223 *  - digi_write_bulk_callback() gets the port lock before waking up
 224 *    processes sleeping on the port write_wait.  It also schedules
 225 *    wake ups so they happen from the scheduler, because the tty
 226 *    system can miss wake ups from interrupts.
 227 *  - All sleeps use a timeout of DIGI_RETRY_TIMEOUT before looping to
 228 *    recheck the condition they are sleeping on.  This is defensive,
 229 *    in case a wake up is lost.
 230 *  - Following Documentation/DocBook/kernel-locking.pdf no spin locks
 231 *    are held when calling copy_to/from_user or printk.
 232 *
 233 *  $Id: digi_acceleport.c,v 1.80.1.2 2000/11/02 05:45:08 root Exp $
 234 */
 235
 236 #include <linux/kernel.h>
 237 #include <linux/errno.h>
 238 #include <linux/init.h>
 239 #include <linux/slab.h>
 240 #include <linux/tty.h>
 241 #include <linux/tty_driver.h>
 242 #include <linux/tty_flip.h>
 243 #include <linux/module.h>
 244 #include <linux/spinlock.h>
 245 #include <linux/workqueue.h>
 246 #include <asm/uaccess.h>
 247 #include <linux/usb.h>
 248 #include <linux/wait.h>
 249 #include <linux/usb/serial.h>
 250
 251 /* Defines */
 252
 253 /*
 254  * Version Information
 255  */
 256 #define DRIVER_VERSION "v1.80.1.2"
 257 #define DRIVER_AUTHOR "Peter Berger <pberger@brimson.com>, Al Borchers <borchers@steinerpoint.com>"
 258 #define DRIVER_DESC "Digi AccelePort USB-2/USB-4 Serial Converter driver"
 259
 260 /* port output buffer length -- must be <= transfer buffer length - 2 */
 261 /* so we can be sure to send the full buffer in one urb */
 262 #define DIGI_OUT_BUF_SIZE               8
 263
 264 /* port input buffer length -- must be >= transfer buffer length - 3 */
 265 /* so we can be sure to hold at least one full buffer from one urb */
 266 #define DIGI_IN_BUF_SIZE                64
 267
 268 /* retry timeout while sleeping */
 269 #define DIGI_RETRY_TIMEOUT              (HZ/10)
 270
 271 /* timeout while waiting for tty output to drain in close */
 272 /* this delay is used twice in close, so the total delay could */
 273 /* be twice this value */
 274 #define DIGI_CLOSE_TIMEOUT              (5*HZ)
 275
 276
 277 /* AccelePort USB Defines */
 278
 279 /* ids */
 280 #define DIGI_VENDOR_ID                  0x05c5
 281 #define DIGI_2_ID                       0x0002  /* USB-2 */
 282 #define DIGI_4_ID                       0x0004  /* USB-4 */
 283
 284 /* commands
 285  * "INB": can be used on the in-band endpoint
 286  * "OOB": can be used on the out-of-band endpoint
 287  */
 288 #define DIGI_CMD_SET_BAUD_RATE                  0       /* INB, OOB */
 289 #define DIGI_CMD_SET_WORD_SIZE                  1       /* INB, OOB */
 290 #define DIGI_CMD_SET_PARITY                     2       /* INB, OOB */
 291 #define DIGI_CMD_SET_STOP_BITS                  3       /* INB, OOB */
 292 #define DIGI_CMD_SET_INPUT_FLOW_CONTROL         4       /* INB, OOB */
 293 #define DIGI_CMD_SET_OUTPUT_FLOW_CONTROL        5       /* INB, OOB */
 294 #define DIGI_CMD_SET_DTR_SIGNAL                 6       /* INB, OOB */
 295 #define DIGI_CMD_SET_RTS_SIGNAL                 7       /* INB, OOB */
 296 #define DIGI_CMD_READ_INPUT_SIGNALS             8       /*      OOB */
 297 #define DIGI_CMD_IFLUSH_FIFO                    9       /*      OOB */
 298 #define DIGI_CMD_RECEIVE_ENABLE                 10      /* INB, OOB */
 299 #define DIGI_CMD_BREAK_CONTROL                  11      /* INB, OOB */
 300 #define DIGI_CMD_LOCAL_LOOPBACK                 12      /* INB, OOB */
 301 #define DIGI_CMD_TRANSMIT_IDLE                  13      /* INB, OOB */
 302 #define DIGI_CMD_READ_UART_REGISTER             14      /*      OOB */
 303 #define DIGI_CMD_WRITE_UART_REGISTER            15      /* INB, OOB */
 304 #define DIGI_CMD_AND_UART_REGISTER              16      /* INB, OOB */
 305 #define DIGI_CMD_OR_UART_REGISTER               17      /* INB, OOB */
 306 #define DIGI_CMD_SEND_DATA                      18      /* INB      */
 307 #define DIGI_CMD_RECEIVE_DATA                   19      /* INB      */
 308 #define DIGI_CMD_RECEIVE_DISABLE                20      /* INB      */
 309 #define DIGI_CMD_GET_PORT_TYPE                  21      /*      OOB */
 310
 311 /* baud rates */
 312 #define DIGI_BAUD_50                            0
 313 #define DIGI_BAUD_75                            1
 314 #define DIGI_BAUD_110                           2
 315 #define DIGI_BAUD_150                           3
 316 #define DIGI_BAUD_200                           4
 317 #define DIGI_BAUD_300                           5
 318 #define DIGI_BAUD_600                           6
 319 #define DIGI_BAUD_1200                          7
 320 #define DIGI_BAUD_1800                          8
 321 #define DIGI_BAUD_2400                          9
 322 #define DIGI_BAUD_4800                          10
 323 #define DIGI_BAUD_7200                          11
 324 #define DIGI_BAUD_9600                          12
 325 #define DIGI_BAUD_14400                         13
 326 #define DIGI_BAUD_19200                         14
 327 #define DIGI_BAUD_28800                         15
 328 #define DIGI_BAUD_38400                         16
 329 #define DIGI_BAUD_57600                         17
 330 #define DIGI_BAUD_76800                         18
 331 #define DIGI_BAUD_115200                        19
 332 #define DIGI_BAUD_153600                        20
 333 #define DIGI_BAUD_230400                        21
 334 #define DIGI_BAUD_460800                        22
 335
 336 /* arguments */
 337 #define DIGI_WORD_SIZE_5                        0
 338 #define DIGI_WORD_SIZE_6                        1
 339 #define DIGI_WORD_SIZE_7                        2
 340 #define DIGI_WORD_SIZE_8                        3
 341
 342 #define DIGI_PARITY_NONE                        0
 343 #define DIGI_PARITY_ODD                         1
 344 #define DIGI_PARITY_EVEN                        2
 345 #define DIGI_PARITY_MARK                        3
 346 #define DIGI_PARITY_SPACE                       4
 347
 348 #define DIGI_STOP_BITS_1                        0
 349 #define DIGI_STOP_BITS_2                        1
 350
 351 #define DIGI_INPUT_FLOW_CONTROL_XON_XOFF        1
 352 #define DIGI_INPUT_FLOW_CONTROL_RTS             2
 353 #define DIGI_INPUT_FLOW_CONTROL_DTR             4
 354
 355 #define DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF       1
 356 #define DIGI_OUTPUT_FLOW_CONTROL_CTS            2
 357 #define DIGI_OUTPUT_FLOW_CONTROL_DSR            4
 358
 359 #define DIGI_DTR_INACTIVE                       0
 360 #define DIGI_DTR_ACTIVE                         1
 361 #define DIGI_DTR_INPUT_FLOW_CONTROL             2
 362
 363 #define DIGI_RTS_INACTIVE                       0
 364 #define DIGI_RTS_ACTIVE                         1
 365 #define DIGI_RTS_INPUT_FLOW_CONTROL             2
 366 #define DIGI_RTS_TOGGLE                         3
 367
 368 #define DIGI_FLUSH_TX                           1
 369 #define DIGI_FLUSH_RX                           2
 370 #define DIGI_RESUME_TX                          4 /* clears xoff condition */
 371
 372 #define DIGI_TRANSMIT_NOT_IDLE                  0
 373 #define DIGI_TRANSMIT_IDLE                      1
 374
 375 #define DIGI_DISABLE                            0
 376 #define DIGI_ENABLE                             1
 377
 378 #define DIGI_DEASSERT                           0
 379 #define DIGI_ASSERT                             1
 380
 381 /* in band status codes */
 382 #define DIGI_OVERRUN_ERROR                      4
 383 #define DIGI_PARITY_ERROR                       8
 384 #define DIGI_FRAMING_ERROR                      16
 385 #define DIGI_BREAK_ERROR                        32
 386
 387 /* out of band status */
 388 #define DIGI_NO_ERROR                           0
 389 #define DIGI_BAD_FIRST_PARAMETER                1
 390 #define DIGI_BAD_SECOND_PARAMETER               2
 391 #define DIGI_INVALID_LINE                       3
 392 #define DIGI_INVALID_OPCODE                     4
 393
 394 /* input signals */
 395 #define DIGI_READ_INPUT_SIGNALS_SLOT            1
 396 #define DIGI_READ_INPUT_SIGNALS_ERR             2
 397 #define DIGI_READ_INPUT_SIGNALS_BUSY            4
 398 #define DIGI_READ_INPUT_SIGNALS_PE              8
 399 #define DIGI_READ_INPUT_SIGNALS_CTS             16
 400 #define DIGI_READ_INPUT_SIGNALS_DSR             32
 401 #define DIGI_READ_INPUT_SIGNALS_RI              64
 402 #define DIGI_READ_INPUT_SIGNALS_DCD             128
 403
 404
 405 /* Structures */
 406
 407 struct digi_serial {
 408         spinlock_t ds_serial_lock;
 409         struct usb_serial_port *ds_oob_port;    /* out-of-band port */
 410         int ds_oob_port_num;                    /* index of out-of-band port */
 411         int ds_device_started;
 412 };
 413
 414 struct digi_port {
 415         spinlock_t dp_port_lock;
 416         int dp_port_num;
 417         int dp_out_buf_len;
 418         unsigned char dp_out_buf[DIGI_OUT_BUF_SIZE];
 419         int dp_write_urb_in_use;
 420         unsigned int dp_modem_signals;
 421         wait_queue_head_t dp_modem_change_wait;
 422         int dp_transmit_idle;
 423         wait_queue_head_t dp_transmit_idle_wait;
 424         int dp_throttled;
 425         int dp_throttle_restart;
 426         wait_queue_head_t dp_flush_wait;
 427         int dp_in_close;                        /* close in progress */
 428         wait_queue_head_t dp_close_wait;        /* wait queue for close */
 429         struct work_struct dp_wakeup_work;
 430         struct usb_serial_port *dp_port;
 431 };
 432
 433
 434 /* Local Function Declarations */
 435
 436 static void digi_wakeup_write(struct usb_serial_port *port);
 437 static void digi_wakeup_write_lock(struct work_struct *work);
 438 static int digi_write_oob_command(struct usb_serial_port *port,
 439         unsigned char *buf, int count, int interruptible);
 440 static int digi_write_inb_command(struct usb_serial_port *port,
 441         unsigned char *buf, int count, unsigned long timeout);
 442 static int digi_set_modem_signals(struct usb_serial_port *port,
 443         unsigned int modem_signals, int interruptible);
 444 static int digi_transmit_idle(struct usb_serial_port *port,
 445         unsigned long timeout);
 446 static void digi_rx_throttle (struct usb_serial_port *port);
 447 static void digi_rx_unthrottle (struct usb_serial_port *port);
 448 static void digi_set_termios(struct usb_serial_port *port,
 449         struct ktermios *old_termios);
 450 static void digi_break_ctl(struct usb_serial_port *port, int break_state);
 451 static int digi_ioctl(struct usb_serial_port *port, struct file *file,
 452         unsigned int cmd, unsigned long arg);
 453 static int digi_tiocmget(struct usb_serial_port *port, struct file *file);
 454 static int digi_tiocmset(struct usb_serial_port *port, struct file *file,
 455         unsigned int set, unsigned int clear);
 456 static int digi_write(struct usb_serial_port *port, const unsigned char *buf, int count);
 457 static void digi_write_bulk_callback(struct urb *urb);
 458 static int digi_write_room(struct usb_serial_port *port);
 459 static int digi_chars_in_buffer(struct usb_serial_port *port);
 460 static int digi_open(struct usb_serial_port *port, struct file *filp);
 461 static void digi_close(struct usb_serial_port *port, struct file *filp);
 462 static int digi_startup_device(struct usb_serial *serial);
 463 static int digi_startup(struct usb_serial *serial);
 464 static void digi_shutdown(struct usb_serial *serial);
 465 static void digi_read_bulk_callback(struct urb *urb);
 466 static int digi_read_inb_callback(struct urb *urb);
 467 static int digi_read_oob_callback(struct urb *urb);
 468
 469
 470 /* Statics */
 471
 472 static int debug;
 473
 474 static struct usb_device_id id_table_combined [] = {
 475         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
 476         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
 477         { }                                             /* Terminating entry */
 478 };
 479
 480 static struct usb_device_id id_table_2 [] = {
 481         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
 482         { }                                             /* Terminating entry */
 483 };
 484
 485 static struct usb_device_id id_table_4 [] = {
 486         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
 487         { }                                             /* Terminating entry */
 488 };
 489
 490 MODULE_DEVICE_TABLE (usb, id_table_combined);
 491
 492 static struct usb_driver digi_driver = {
 493         .name =         "digi_acceleport",
 494         .probe =        usb_serial_probe,
 495         .disconnect =   usb_serial_disconnect,
 496         .id_table =     id_table_combined,
 497         .no_dynamic_id =        1,
 498 };
 499
 500
 501 /* device info needed for the Digi serial converter */
 502
 503 static struct usb_serial_driver digi_acceleport_2_device = {
 504         .driver = {
 505                 .owner =                THIS_MODULE,
 506                 .name =                 "digi_2",
 507         },
 508         .description =                  "Digi 2 port USB adapter",
 509         .usb_driver =                   &digi_driver,
 510         .id_table =                     id_table_2,
 511         .num_interrupt_in =             0,
 512         .num_bulk_in =                  4,
 513         .num_bulk_out =                 4,
 514         .num_ports =                    3,
 515         .open =                         digi_open,
 516         .close =                        digi_close,
 517         .write =                        digi_write,
 518         .write_room =                   digi_write_room,
 519         .write_bulk_callback =          digi_write_bulk_callback,
 520         .read_bulk_callback =           digi_read_bulk_callback,
 521         .chars_in_buffer =              digi_chars_in_buffer,
 522         .throttle =                     digi_rx_throttle,
 523         .unthrottle =                   digi_rx_unthrottle,
 524         .ioctl =                        digi_ioctl,
 525         .set_termios =                  digi_set_termios,
 526         .break_ctl =                    digi_break_ctl,
 527         .tiocmget =                     digi_tiocmget,
 528         .tiocmset =                     digi_tiocmset,
 529         .attach =                       digi_startup,
 530         .shutdown =                     digi_shutdown,
 531 };
 532
 533 static struct usb_serial_driver digi_acceleport_4_device = {
 534         .driver = {
 535                 .owner =                THIS_MODULE,
 536                 .name =                 "digi_4",
 537         },
 538         .description =                  "Digi 4 port USB adapter",
 539         .usb_driver =                   &digi_driver,
 540         .id_table =                     id_table_4,
 541         .num_interrupt_in =             0,
 542         .num_bulk_in =                  5,
 543         .num_bulk_out =                 5,
 544         .num_ports =                    4,
 545         .open =                         digi_open,
 546         .close =                        digi_close,
 547         .write =                        digi_write,
 548         .write_room =                   digi_write_room,
 549         .write_bulk_callback =          digi_write_bulk_callback,
 550         .read_bulk_callback =           digi_read_bulk_callback,
 551         .chars_in_buffer =              digi_chars_in_buffer,
 552         .throttle =                     digi_rx_throttle,
 553         .unthrottle =                   digi_rx_unthrottle,
 554         .ioctl =                        digi_ioctl,
 555         .set_termios =                  digi_set_termios,
 556         .break_ctl =                    digi_break_ctl,
 557         .tiocmget =                     digi_tiocmget,
 558         .tiocmset =                     digi_tiocmset,
 559         .attach =                       digi_startup,
 560         .shutdown =                     digi_shutdown,
 561 };
 562
 563
 564 /* Functions */
 565
 566 /*
 567 *  Cond Wait Interruptible Timeout Irqrestore
 568 *
 569 *  Do spin_unlock_irqrestore and interruptible_sleep_on_timeout
 570 *  so that wake ups are not lost if they occur between the unlock
 571 *  and the sleep.  In other words, spin_unlock_irqrestore and
 572 *  interruptible_sleep_on_timeout are "atomic" with respect to
 573 *  wake ups.  This is used to implement condition variables.
 574 *
 575 *  interruptible_sleep_on_timeout is deprecated and has been replaced
 576 *  with the equivalent code.
 577 */
 578
 579 static long cond_wait_interruptible_timeout_irqrestore(
 580         wait_queue_head_t *q, long timeout,
 581         spinlock_t *lock, unsigned long flags)
 582 {
 583         DEFINE_WAIT(wait);
 584
 585         prepare_to_wait(q, &wait, TASK_INTERRUPTIBLE);
 586         spin_unlock_irqrestore(lock, flags);
 587         timeout = schedule_timeout(timeout);
 588         finish_wait(q, &wait);
 589
 590         return timeout;
 591 }
 592
 593
 594 /*
 595 *  Digi Wakeup Write
 596 *
 597 *  Wake up port, line discipline, and tty processes sleeping
 598 *  on writes.
 599 */
 600
 601 static void digi_wakeup_write_lock(struct work_struct *work)
 602 {
 603         struct digi_port *priv = container_of(work, struct digi_port, dp_wakeup_work);
 604         struct usb_serial_port *port = priv->dp_port;
 605         unsigned long flags;
 606
 607         spin_lock_irqsave(&priv->dp_port_lock, flags);
 608         digi_wakeup_write(port);
 609         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 610 }
 611
 612 static void digi_wakeup_write(struct usb_serial_port *port)
 613 {
 614         tty_wakeup(port->tty);
 615 }
 616
 617
 618 /*
 619 *  Digi Write OOB Command
 620 *
 621 *  Write commands on the out of band port.  Commands are 4
 622 *  bytes each, multiple commands can be sent at once, and
 623 *  no command will be split across USB packets.  Returns 0
 624 *  if successful, -EINTR if interrupted while sleeping and
 625 *  the interruptible flag is true, or a negative error
 626 *  returned by usb_submit_urb.
 627 */
 628
 629 static int digi_write_oob_command(struct usb_serial_port *port,
 630         unsigned char *buf, int count, int interruptible)
 631 {
 632
 633         int ret = 0;
 634         int len;
 635         struct usb_serial_port *oob_port = (struct usb_serial_port *)((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
 636         struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
 637         unsigned long flags = 0;
 638
 639         dbg("digi_write_oob_command: TOP: port=%d, count=%d", oob_priv->dp_port_num, count);
 640
 641         spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
 642         while(count > 0) {
 643                 while(oob_port->write_urb->status == -EINPROGRESS
 644                         || oob_priv->dp_write_urb_in_use) {
 645                         cond_wait_interruptible_timeout_irqrestore(
 646                                 &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
 647                                 &oob_priv->dp_port_lock, flags);
 648                         if (interruptible && signal_pending(current))
 649                                 return -EINTR;
 650                         spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
 651                 }
 652
 653                 /* len must be a multiple of 4, so commands are not split */
 654                 len = min(count, oob_port->bulk_out_size);
 655                 if (len > 4)
 656                         len &= ~3;
 657                 memcpy(oob_port->write_urb->transfer_buffer, buf, len);
 658                 oob_port->write_urb->transfer_buffer_length = len;
 659                 oob_port->write_urb->dev = port->serial->dev;
 660                 if ((ret = usb_submit_urb(oob_port->write_urb, GFP_ATOMIC)) == 0) {
 661                         oob_priv->dp_write_urb_in_use = 1;
 662                         count -= len;
 663                         buf += len;
 664                 }
 665         }
 666         spin_unlock_irqrestore(&oob_priv->dp_port_lock, flags);
 667         if (ret)
 668                 err("%s: usb_submit_urb failed, ret=%d", __FUNCTION__, ret);
 669         return ret;
 670
 671 }
 672
 673
 674 /*
 675 *  Digi Write In Band Command
 676 *
 677 *  Write commands on the given port.  Commands are 4
 678 *  bytes each, multiple commands can be sent at once, and
 679 *  no command will be split across USB packets.  If timeout
 680 *  is non-zero, write in band command will return after
 681 *  waiting unsuccessfully for the URB status to clear for
 682 *  timeout ticks.  Returns 0 if successful, or a negative
 683 *  error returned by digi_write.
 684 */
 685
 686 static int digi_write_inb_command(struct usb_serial_port *port,
 687         unsigned char *buf, int count, unsigned long timeout)
 688 {
 689         int ret = 0;
 690         int len;
 691         struct digi_port *priv = usb_get_serial_port_data(port);
 692         unsigned char *data = port->write_urb->transfer_buffer;
 693         unsigned long flags = 0;
 694
 695         dbg("digi_write_inb_command: TOP: port=%d, count=%d",
 696                 priv->dp_port_num, count);
 697
 698         if (timeout)
 699                 timeout += jiffies;
 700         else
 701                 timeout = ULONG_MAX;
 702
 703         spin_lock_irqsave(&priv->dp_port_lock, flags);
 704         while(count > 0 && ret == 0) {
 705                 while((port->write_urb->status == -EINPROGRESS
 706                         || priv->dp_write_urb_in_use) && time_before(jiffies, timeout)) {
 707                         cond_wait_interruptible_timeout_irqrestore(
 708                                 &port->write_wait, DIGI_RETRY_TIMEOUT,
 709                                 &priv->dp_port_lock, flags);
 710                         if (signal_pending(current))
 711                                 return -EINTR;
 712                         spin_lock_irqsave(&priv->dp_port_lock, flags);
 713                 }
 714
 715                 /* len must be a multiple of 4 and small enough to */
 716                 /* guarantee the write will send buffered data first, */
 717                 /* so commands are in order with data and not split */
 718                 len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
 719                 if (len > 4)
 720                         len &= ~3;
 721
 722                 /* write any buffered data first */
 723                 if (priv->dp_out_buf_len > 0) {
 724                         data[0] = DIGI_CMD_SEND_DATA;
 725                         data[1] = priv->dp_out_buf_len;
 726                         memcpy(data + 2, priv->dp_out_buf,
 727                                 priv->dp_out_buf_len);
 728                         memcpy(data + 2 + priv->dp_out_buf_len, buf, len);
 729                         port->write_urb->transfer_buffer_length
 730                                 = priv->dp_out_buf_len + 2 + len;
 731                 } else {
 732                         memcpy(data, buf, len);
 733                         port->write_urb->transfer_buffer_length = len;
 734                 }
 735                 port->write_urb->dev = port->serial->dev;
 736
 737                 if ((ret = usb_submit_urb(port->write_urb, GFP_ATOMIC)) == 0) {
 738                         priv->dp_write_urb_in_use = 1;
 739                         priv->dp_out_buf_len = 0;
 740                         count -= len;
 741                         buf += len;
 742                 }
 743
 744         }
 745         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 746
 747         if (ret)
 748                 err("%s: usb_submit_urb failed, ret=%d, port=%d",
 749                         __FUNCTION__, ret, priv->dp_port_num);
 750         return ret;
 751 }
 752
 753
 754 /*
 755 *  Digi Set Modem Signals
 756 *
 757 *  Sets or clears DTR and RTS on the port, according to the
 758 *  modem_signals argument.  Use TIOCM_DTR and TIOCM_RTS flags
 759 *  for the modem_signals argument.  Returns 0 if successful,
 760 *  -EINTR if interrupted while sleeping, or a non-zero error
 761 *  returned by usb_submit_urb.
 762 */
 763
 764 static int digi_set_modem_signals(struct usb_serial_port *port,
 765         unsigned int modem_signals, int interruptible)
 766 {
 767
 768         int ret;
 769         struct digi_port *port_priv = usb_get_serial_port_data(port);
 770         struct usb_serial_port *oob_port = (struct usb_serial_port *)((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
 771         struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
 772         unsigned char *data = oob_port->write_urb->transfer_buffer;
 773         unsigned long flags = 0;
 774
 775
 776         dbg("digi_set_modem_signals: TOP: port=%d, modem_signals=0x%x",
 777                 port_priv->dp_port_num, modem_signals);
 778
 779         spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
 780         spin_lock(&port_priv->dp_port_lock);
 781
 782         while(oob_port->write_urb->status == -EINPROGRESS || oob_priv->dp_write_urb_in_use) {
 783                 spin_unlock(&port_priv->dp_port_lock);
 784                 cond_wait_interruptible_timeout_irqrestore(
 785                         &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
 786                         &oob_priv->dp_port_lock, flags);
 787                 if (interruptible && signal_pending(current))
 788                         return -EINTR;
 789                 spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
 790                 spin_lock(&port_priv->dp_port_lock);
 791         }
 792         data[0] = DIGI_CMD_SET_DTR_SIGNAL;
 793         data[1] = port_priv->dp_port_num;
 794         data[2] = (modem_signals&TIOCM_DTR) ? DIGI_DTR_ACTIVE : DIGI_DTR_INACTIVE;
 795         data[3] = 0;
 796         data[4] = DIGI_CMD_SET_RTS_SIGNAL;
 797         data[5] = port_priv->dp_port_num;
 798         data[6] = (modem_signals&TIOCM_RTS) ? DIGI_RTS_ACTIVE : DIGI_RTS_INACTIVE;
 799         data[7] = 0;
 800
 801         oob_port->write_urb->transfer_buffer_length = 8;
 802         oob_port->write_urb->dev = port->serial->dev;
 803
 804         if ((ret = usb_submit_urb(oob_port->write_urb, GFP_ATOMIC)) == 0) {
 805                 oob_priv->dp_write_urb_in_use = 1;
 806                 port_priv->dp_modem_signals =
 807                         (port_priv->dp_modem_signals&~(TIOCM_DTR|TIOCM_RTS))
 808                         | (modem_signals&(TIOCM_DTR|TIOCM_RTS));
 809         }
 810         spin_unlock(&port_priv->dp_port_lock);
 811         spin_unlock_irqrestore(&oob_priv->dp_port_lock, flags);
 812         if (ret)
 813                 err("%s: usb_submit_urb failed, ret=%d", __FUNCTION__, ret);
 814         return ret;
 815 }
 816
 817 /*
 818 *  Digi Transmit Idle
 819 *
 820 *  Digi transmit idle waits, up to timeout ticks, for the transmitter
 821 *  to go idle.  It returns 0 if successful or a negative error.
 822 *
 823 *  There are race conditions here if more than one process is calling
 824 *  digi_transmit_idle on the same port at the same time.  However, this
 825 *  is only called from close, and only one process can be in close on a
 826 *  port at a time, so its ok.
 827 */
 828
 829 static int digi_transmit_idle(struct usb_serial_port *port,
 830         unsigned long timeout)
 831 {
 832         int ret;
 833         unsigned char buf[2];
 834         struct digi_port *priv = usb_get_serial_port_data(port);
 835         unsigned long flags = 0;
 836
 837         spin_lock_irqsave(&priv->dp_port_lock, flags);
 838         priv->dp_transmit_idle = 0;
 839         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 840
 841         buf[0] = DIGI_CMD_TRANSMIT_IDLE;
 842         buf[1] = 0;
 843
 844         timeout += jiffies;
 845
 846         if ((ret = digi_write_inb_command(port, buf, 2, timeout - jiffies)) != 0)
 847                 return ret;
 848
 849         spin_lock_irqsave(&priv->dp_port_lock, flags);
 850
 851         while(time_before(jiffies, timeout) && !priv->dp_transmit_idle) {
 852                 cond_wait_interruptible_timeout_irqrestore(
 853                         &priv->dp_transmit_idle_wait, DIGI_RETRY_TIMEOUT,
 854                         &priv->dp_port_lock, flags);
 855                 if (signal_pending(current))
 856                         return -EINTR;
 857                 spin_lock_irqsave(&priv->dp_port_lock, flags);
 858         }
 859         priv->dp_transmit_idle = 0;
 860         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 861         return 0;
 862
 863 }
 864
 865
 866 static void digi_rx_throttle(struct usb_serial_port *port)
 867 {
 868         unsigned long flags;
 869         struct digi_port *priv = usb_get_serial_port_data(port);
 870
 871
 872         dbg("digi_rx_throttle: TOP: port=%d", priv->dp_port_num);
 873
 874         /* stop receiving characters by not resubmitting the read urb */
 875         spin_lock_irqsave(&priv->dp_port_lock, flags);
 876         priv->dp_throttled = 1;
 877         priv->dp_throttle_restart = 0;
 878         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 879 }
 880
 881
 882 static void digi_rx_unthrottle(struct usb_serial_port *port)
 883 {
 884         int ret = 0;
 885         unsigned long flags;
 886         struct digi_port *priv = usb_get_serial_port_data(port);
 887
 888         dbg("digi_rx_unthrottle: TOP: port=%d", priv->dp_port_num);
 889
 890         spin_lock_irqsave(&priv->dp_port_lock, flags);
 891
 892         /* turn throttle off */
 893         priv->dp_throttled = 0;
 894         priv->dp_throttle_restart = 0;
 895
 896         /* restart read chain */
 897         if (priv->dp_throttle_restart) {
 898                 port->read_urb->dev = port->serial->dev;
 899                 ret = usb_submit_urb(port->read_urb, GFP_ATOMIC);
 900         }
 901
 902         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 903
 904         if (ret)
 905                 err("%s: usb_submit_urb failed, ret=%d, port=%d",
 906                         __FUNCTION__, ret, priv->dp_port_num);
 907 }
 908
 909
 910 static void digi_set_termios(struct usb_serial_port *port,
 911                                         struct ktermios *old_termios)
 912 {
 913
 914         struct digi_port *priv = usb_get_serial_port_data(port);
 915         struct tty_struct *tty = port->tty;
 916         unsigned int iflag = tty->termios->c_iflag;
 917         unsigned int cflag = tty->termios->c_cflag;
 918         unsigned int old_iflag = old_termios->c_iflag;
 919         unsigned int old_cflag = old_termios->c_cflag;
 920         unsigned char buf[32];
 921         unsigned int modem_signals;
 922         int arg,ret;
 923         int i = 0;
 924         speed_t baud;
 925
 926         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);
 927
 928         /* set baud rate */
 929         if ((baud = tty_get_baud_rate(tty)) != tty_termios_baud_rate(old_termios)) {
 930                 arg = -1;
 931
 932                 /* reassert DTR and (maybe) RTS on transition from B0 */
 933                 if ((old_cflag&CBAUD) == B0) {
 934                         /* don't set RTS if using hardware flow control */
 935                         /* and throttling input */
 936                         modem_signals = TIOCM_DTR;
 937                         if (!(tty->termios->c_cflag & CRTSCTS) ||
 938                             !test_bit(TTY_THROTTLED, &tty->flags))
 939                                 modem_signals |= TIOCM_RTS;
 940                         digi_set_modem_signals(port, modem_signals, 1);
 941                 }
 942                 switch (baud) {
 943                         /* drop DTR and RTS on transition to B0 */
 944                         case 0: digi_set_modem_signals(port, 0, 1); break;
 945                         case 50: arg = DIGI_BAUD_50; break;
 946                         case 75: arg = DIGI_BAUD_75; break;
 947                         case 110: arg = DIGI_BAUD_110; break;
 948                         case 150: arg = DIGI_BAUD_150; break;
 949                         case 200: arg = DIGI_BAUD_200; break;
 950                         case 300: arg = DIGI_BAUD_300; break;
 951                         case 600: arg = DIGI_BAUD_600; break;
 952                         case 1200: arg = DIGI_BAUD_1200; break;
 953                         case 1800: arg = DIGI_BAUD_1800; break;
 954                         case 2400: arg = DIGI_BAUD_2400; break;
 955                         case 4800: arg = DIGI_BAUD_4800; break;
 956                         case 9600: arg = DIGI_BAUD_9600; break;
 957                         case 19200: arg = DIGI_BAUD_19200; break;
 958                         case 38400: arg = DIGI_BAUD_38400; break;
 959                         case 57600: arg = DIGI_BAUD_57600; break;
 960                         case 115200: arg = DIGI_BAUD_115200; break;
 961                         case 230400: arg = DIGI_BAUD_230400; break;
 962                         case 460800: arg = DIGI_BAUD_460800; break;
 963                         default:
 964                                 arg = DIGI_BAUD_9600;
 965                                 baud = 9600;
 966                                 break;
 967                 }
 968                 if (arg != -1) {
 969                         buf[i++] = DIGI_CMD_SET_BAUD_RATE;
 970                         buf[i++] = priv->dp_port_num;
 971                         buf[i++] = arg;
 972                         buf[i++] = 0;
 973                 }
 974         }
 975         /* set parity */
 976         tty->termios->c_cflag &= ~CMSPAR;
 977
 978         if ((cflag&(PARENB|PARODD)) != (old_cflag&(PARENB|PARODD))) {
 979                 if (cflag&PARENB) {
 980                         if (cflag&PARODD)
 981                                 arg = DIGI_PARITY_ODD;
 982                         else
 983                                 arg = DIGI_PARITY_EVEN;
 984                 } else {
 985                         arg = DIGI_PARITY_NONE;
 986                 }
 987                 buf[i++] = DIGI_CMD_SET_PARITY;
 988                 buf[i++] = priv->dp_port_num;
 989                 buf[i++] = arg;
 990                 buf[i++] = 0;
 991         }
 992         /* set word size */
 993         if ((cflag&CSIZE) != (old_cflag&CSIZE)) {
 994                 arg = -1;
 995                 switch (cflag&CSIZE) {
 996                 case CS5: arg = DIGI_WORD_SIZE_5; break;
 997                 case CS6: arg = DIGI_WORD_SIZE_6; break;
 998                 case CS7: arg = DIGI_WORD_SIZE_7; break;
 999                 case CS8: arg = DIGI_WORD_SIZE_8; break;
1000                 default:
1001                         dbg("digi_set_termios: can't handle word size %d",
1002                                 (cflag&CSIZE));
1003                         break;
1004                 }
1005
1006                 if (arg != -1) {
1007                         buf[i++] = DIGI_CMD_SET_WORD_SIZE;
1008                         buf[i++] = priv->dp_port_num;
1009                         buf[i++] = arg;
1010                         buf[i++] = 0;
1011                 }
1012
1013         }
1014
1015         /* set stop bits */
1016         if ((cflag&CSTOPB) != (old_cflag&CSTOPB)) {
1017
1018                 if ((cflag&CSTOPB))
1019                         arg = DIGI_STOP_BITS_2;
1020                 else
1021                         arg = DIGI_STOP_BITS_1;
1022
1023                 buf[i++] = DIGI_CMD_SET_STOP_BITS;
1024                 buf[i++] = priv->dp_port_num;
1025                 buf[i++] = arg;
1026                 buf[i++] = 0;
1027
1028         }
1029
1030         /* set input flow control */
1031         if ((iflag&IXOFF) != (old_iflag&IXOFF)
1032             || (cflag&CRTSCTS) != (old_cflag&CRTSCTS)) {
1033                 arg = 0;
1034                 if (iflag&IXOFF)
1035                         arg |= DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
1036                 else
1037                         arg &= ~DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
1038
1039                 if (cflag&CRTSCTS) {
1040                         arg |= DIGI_INPUT_FLOW_CONTROL_RTS;
1041
1042                         /* On USB-4 it is necessary to assert RTS prior */
1043                         /* to selecting RTS input flow control.  */
1044                         buf[i++] = DIGI_CMD_SET_RTS_SIGNAL;
1045                         buf[i++] = priv->dp_port_num;
1046                         buf[i++] = DIGI_RTS_ACTIVE;
1047                         buf[i++] = 0;
1048
1049                 } else {
1050                         arg &= ~DIGI_INPUT_FLOW_CONTROL_RTS;
1051                 }
1052                 buf[i++] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1053                 buf[i++] = priv->dp_port_num;
1054                 buf[i++] = arg;
1055                 buf[i++] = 0;
1056         }
1057
1058         /* set output flow control */
1059         if ((iflag & IXON) != (old_iflag & IXON)
1060             || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
1061                 arg = 0;
1062                 if (iflag & IXON)
1063                         arg |= DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
1064                 else
1065                         arg &= ~DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
1066
1067                 if (cflag & CRTSCTS) {
1068                         arg |= DIGI_OUTPUT_FLOW_CONTROL_CTS;
1069                 } else {
1070                         arg &= ~DIGI_OUTPUT_FLOW_CONTROL_CTS;
1071                         tty->hw_stopped = 0;
1072                 }
1073
1074                 buf[i++] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1075                 buf[i++] = priv->dp_port_num;
1076                 buf[i++] = arg;
1077                 buf[i++] = 0;
1078         }
1079
1080         /* set receive enable/disable */
1081         if ((cflag & CREAD) != (old_cflag & CREAD)) {
1082                 if (cflag & CREAD)
1083                         arg = DIGI_ENABLE;
1084                 else
1085                         arg = DIGI_DISABLE;
1086
1087                 buf[i++] = DIGI_CMD_RECEIVE_ENABLE;
1088                 buf[i++] = priv->dp_port_num;
1089                 buf[i++] = arg;
1090                 buf[i++] = 0;
1091         }
1092         if ((ret = digi_write_oob_command(port, buf, i, 1)) != 0)
1093                 dbg("digi_set_termios: write oob failed, ret=%d", ret);
1094         tty_encode_baud_rate(tty, baud, baud);
1095 }
1096
1097
1098 static void digi_break_ctl(struct usb_serial_port *port, int break_state)
1099 {
1100         unsigned char buf[4];
1101
1102         buf[0] = DIGI_CMD_BREAK_CONTROL;
1103         buf[1] = 2;                             /* length */
1104         buf[2] = break_state ? 1 : 0;
1105         buf[3] = 0;                             /* pad */
1106         digi_write_inb_command(port, buf, 4, 0);
1107 }
1108
1109
1110 static int digi_tiocmget(struct usb_serial_port *port, struct file *file)
1111 {
1112         struct digi_port *priv = usb_get_serial_port_data(port);
1113         unsigned int val;
1114         unsigned long flags;
1115
1116         dbg("%s: TOP: port=%d", __FUNCTION__, priv->dp_port_num);
1117
1118         spin_lock_irqsave(&priv->dp_port_lock, flags);
1119         val = priv->dp_modem_signals;
1120         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1121         return val;
1122 }
1123
1124
1125 static int digi_tiocmset(struct usb_serial_port *port, struct file *file,
1126         unsigned int set, unsigned int clear)
1127 {
1128         struct digi_port *priv = usb_get_serial_port_data(port);
1129         unsigned int val;
1130         unsigned long flags;
1131
1132         dbg("%s: TOP: port=%d", __FUNCTION__, priv->dp_port_num);
1133
1134         spin_lock_irqsave(&priv->dp_port_lock, flags);
1135         val = (priv->dp_modem_signals & ~clear) | set;
1136         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1137         return digi_set_modem_signals(port, val, 1);
1138 }
1139
1140
1141 static int digi_ioctl(struct usb_serial_port *port, struct file *file,
1142         unsigned int cmd, unsigned long arg)
1143 {
1144         struct digi_port *priv = usb_get_serial_port_data(port);
1145         dbg("digi_ioctl: TOP: port=%d, cmd=0x%x", priv->dp_port_num, cmd);
1146
1147         switch (cmd) {
1148         case TIOCMIWAIT:
1149                 /* wait for any of the 4 modem inputs (DCD,RI,DSR,CTS)*/
1150                 /* TODO */
1151                 return 0;
1152         case TIOCGICOUNT:
1153                 /* return count of modemline transitions */
1154                 /* TODO */
1155                 return 0;
1156         }
1157         return -ENOIOCTLCMD;
1158
1159 }
1160
1161 static int digi_write(struct usb_serial_port *port, const unsigned char *buf, int count)
1162 {
1163
1164         int ret,data_len,new_len;
1165         struct digi_port *priv = usb_get_serial_port_data(port);
1166         unsigned char *data = port->write_urb->transfer_buffer;
1167         unsigned long flags = 0;
1168
1169         dbg("digi_write: TOP: port=%d, count=%d, in_interrupt=%ld",
1170                 priv->dp_port_num, count, in_interrupt());
1171
1172         /* copy user data (which can sleep) before getting spin lock */
1173         count = min(count, port->bulk_out_size-2);
1174         count = min(64, count);
1175
1176         /* be sure only one write proceeds at a time */
1177         /* there are races on the port private buffer */
1178         /* and races to check write_urb->status */
1179         spin_lock_irqsave(&priv->dp_port_lock, flags);
1180
1181         /* wait for urb status clear to submit another urb */
1182         if (port->write_urb->status == -EINPROGRESS || priv->dp_write_urb_in_use) {
1183                 /* buffer data if count is 1 (probably put_char) if possible */
1184                 if (count == 1 && priv->dp_out_buf_len < DIGI_OUT_BUF_SIZE) {
1185                         priv->dp_out_buf[priv->dp_out_buf_len++] = *buf;
1186                         new_len = 1;
1187                 } else {
1188                         new_len = 0;
1189                 }
1190                 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1191                 return new_len;
1192         }
1193
1194         /* allow space for any buffered data and for new data, up to */
1195         /* transfer buffer size - 2 (for command and length bytes) */
1196         new_len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
1197         data_len = new_len + priv->dp_out_buf_len;
1198
1199         if (data_len == 0) {
1200                 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1201                 return 0;
1202         }
1203
1204         port->write_urb->transfer_buffer_length = data_len+2;
1205         port->write_urb->dev = port->serial->dev;
1206
1207         *data++ = DIGI_CMD_SEND_DATA;
1208         *data++ = data_len;
1209
1210         /* copy in buffered data first */
1211         memcpy(data, priv->dp_out_buf, priv->dp_out_buf_len);
1212         data += priv->dp_out_buf_len;
1213
1214         /* copy in new data */
1215         memcpy(data, buf, new_len);
1216
1217         if ((ret = usb_submit_urb(port->write_urb, GFP_ATOMIC)) == 0) {
1218                 priv->dp_write_urb_in_use = 1;
1219                 ret = new_len;
1220                 priv->dp_out_buf_len = 0;
1221         }
1222
1223         /* return length of new data written, or error */
1224         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1225         if (ret < 0)
1226                 err("%s: usb_submit_urb failed, ret=%d, port=%d",
1227                         __FUNCTION__, ret, priv->dp_port_num);
1228         dbg("digi_write: returning %d", ret);
1229         return ret;
1230
1231 }
1232
1233 static void digi_write_bulk_callback(struct urb *urb)
1234 {
1235
1236         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1237         struct usb_serial *serial;
1238         struct digi_port *priv;
1239         struct digi_serial *serial_priv;
1240         int ret = 0;
1241         int status = urb->status;
1242
1243         dbg("digi_write_bulk_callback: TOP, urb->status=%d", status);
1244
1245         /* port and serial sanity check */
1246         if (port == NULL || (priv=usb_get_serial_port_data(port)) == NULL) {
1247                 err("%s: port or port->private is NULL, status=%d",
1248                     __FUNCTION__, status);
1249                 return;
1250         }
1251         serial = port->serial;
1252         if (serial == NULL || (serial_priv=usb_get_serial_data(serial)) == NULL) {
1253                 err("%s: serial or serial->private is NULL, status=%d",
1254                     __FUNCTION__, status);
1255                 return;
1256         }
1257
1258         /* handle oob callback */
1259         if (priv->dp_port_num == serial_priv->ds_oob_port_num) {
1260                 dbg("digi_write_bulk_callback: oob callback");
1261                 spin_lock(&priv->dp_port_lock);
1262                 priv->dp_write_urb_in_use = 0;
1263                 wake_up_interruptible(&port->write_wait);
1264                 spin_unlock(&priv->dp_port_lock);
1265                 return;
1266         }
1267
1268         /* try to send any buffered data on this port, if it is open */
1269         spin_lock(&priv->dp_port_lock);
1270         priv->dp_write_urb_in_use = 0;
1271         if (port->open_count && port->write_urb->status != -EINPROGRESS
1272             && priv->dp_out_buf_len > 0) {
1273                 *((unsigned char *)(port->write_urb->transfer_buffer))
1274                         = (unsigned char)DIGI_CMD_SEND_DATA;
1275                 *((unsigned char *)(port->write_urb->transfer_buffer)+1)
1276                         = (unsigned char)priv->dp_out_buf_len;
1277                 port->write_urb->transfer_buffer_length = priv->dp_out_buf_len+2;
1278                 port->write_urb->dev = serial->dev;
1279                 memcpy(port->write_urb->transfer_buffer+2, priv->dp_out_buf,
1280                         priv->dp_out_buf_len);
1281                 if ((ret = usb_submit_urb(port->write_urb, GFP_ATOMIC)) == 0) {
1282                         priv->dp_write_urb_in_use = 1;
1283                         priv->dp_out_buf_len = 0;
1284                 }
1285         }
1286         /* wake up processes sleeping on writes immediately */
1287         digi_wakeup_write(port);
1288         /* also queue up a wakeup at scheduler time, in case we */
1289         /* lost the race in write_chan(). */
1290         schedule_work(&priv->dp_wakeup_work);
1291
1292         spin_unlock(&priv->dp_port_lock);
1293         if (ret)
1294                 err("%s: usb_submit_urb failed, ret=%d, port=%d",
1295                         __FUNCTION__, ret, priv->dp_port_num);
1296 }
1297
1298 static int digi_write_room(struct usb_serial_port *port)
1299 {
1300
1301         int room;
1302         struct digi_port *priv = usb_get_serial_port_data(port);
1303         unsigned long flags = 0;
1304
1305         spin_lock_irqsave(&priv->dp_port_lock, flags);
1306
1307         if (port->write_urb->status == -EINPROGRESS || priv->dp_write_urb_in_use)
1308                 room = 0;
1309         else
1310                 room = port->bulk_out_size - 2 - priv->dp_out_buf_len;
1311
1312         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1313         dbg("digi_write_room: port=%d, room=%d", priv->dp_port_num, room);
1314         return room;
1315
1316 }
1317
1318 static int digi_chars_in_buffer(struct usb_serial_port *port)
1319 {
1320
1321         struct digi_port *priv = usb_get_serial_port_data(port);
1322
1323
1324         if (port->write_urb->status == -EINPROGRESS
1325             || priv->dp_write_urb_in_use) {
1326                 dbg("digi_chars_in_buffer: port=%d, chars=%d",
1327                         priv->dp_port_num, port->bulk_out_size - 2);
1328                 /* return(port->bulk_out_size - 2); */
1329                 return 256;
1330         } else {
1331                 dbg("digi_chars_in_buffer: port=%d, chars=%d",
1332                         priv->dp_port_num, priv->dp_out_buf_len);
1333                 return priv->dp_out_buf_len;
1334         }
1335
1336 }
1337
1338
1339 static int digi_open(struct usb_serial_port *port, struct file *filp)
1340 {
1341         int ret;
1342         unsigned char buf[32];
1343         struct digi_port *priv = usb_get_serial_port_data(port);
1344         struct ktermios not_termios;
1345         unsigned long flags = 0;
1346
1347         dbg("digi_open: TOP: port=%d, open_count=%d",
1348                 priv->dp_port_num, port->open_count);
1349
1350         /* be sure the device is started up */
1351         if (digi_startup_device(port->serial) != 0)
1352                 return -ENXIO;
1353
1354         spin_lock_irqsave(&priv->dp_port_lock, flags);
1355
1356         /* don't wait on a close in progress for non-blocking opens */
1357         if (priv->dp_in_close && (filp->f_flags&(O_NDELAY|O_NONBLOCK)) == 0) {
1358                 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1359                 return -EAGAIN;
1360         }
1361
1362         /* wait for a close in progress to finish */
1363         while(priv->dp_in_close) {
1364                 cond_wait_interruptible_timeout_irqrestore(
1365                         &priv->dp_close_wait, DIGI_RETRY_TIMEOUT,
1366                         &priv->dp_port_lock, flags);
1367                 if (signal_pending(current))
1368                         return -EINTR;
1369                 spin_lock_irqsave(&priv->dp_port_lock, flags);
1370         }
1371
1372         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1373
1374         /* read modem signals automatically whenever they change */
1375         buf[0] = DIGI_CMD_READ_INPUT_SIGNALS;
1376         buf[1] = priv->dp_port_num;
1377         buf[2] = DIGI_ENABLE;
1378         buf[3] = 0;
1379
1380         /* flush fifos */
1381         buf[4] = DIGI_CMD_IFLUSH_FIFO;
1382         buf[5] = priv->dp_port_num;
1383         buf[6] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1384         buf[7] = 0;
1385
1386         if ((ret = digi_write_oob_command(port, buf, 8, 1)) != 0)
1387                 dbg("digi_open: write oob failed, ret=%d", ret);
1388
1389         /* set termios settings */
1390         not_termios.c_cflag = ~port->tty->termios->c_cflag;
1391         not_termios.c_iflag = ~port->tty->termios->c_iflag;
1392         digi_set_termios(port, &not_termios);
1393
1394         /* set DTR and RTS */
1395         digi_set_modem_signals(port, TIOCM_DTR|TIOCM_RTS, 1);
1396
1397         return 0;
1398 }
1399
1400
1401 static void digi_close(struct usb_serial_port *port, struct file *filp)
1402 {
1403         DEFINE_WAIT(wait);
1404         int ret;
1405         unsigned char buf[32];
1406         struct tty_struct *tty = port->tty;
1407         struct digi_port *priv = usb_get_serial_port_data(port);
1408
1409         dbg("digi_close: TOP: port=%d, open_count=%d",
1410                 priv->dp_port_num, port->open_count);
1411
1412         mutex_lock(&port->serial->disc_mutex);
1413         /* if disconnected, just clear flags */
1414         if (port->serial->disconnected)
1415                 goto exit;
1416
1417         /* do cleanup only after final close on this port */
1418         spin_lock_irq(&priv->dp_port_lock);
1419         priv->dp_in_close = 1;
1420         spin_unlock_irq(&priv->dp_port_lock);
1421
1422         /* tell line discipline to process only XON/XOFF */
1423         tty->closing = 1;
1424
1425         /* wait for output to drain */
1426         if ((filp->f_flags&(O_NDELAY|O_NONBLOCK)) == 0)
1427                 tty_wait_until_sent(tty, DIGI_CLOSE_TIMEOUT);
1428
1429         /* flush driver and line discipline buffers */
1430         if (tty->driver->flush_buffer)
1431                 tty->driver->flush_buffer(tty);
1432         tty_ldisc_flush(tty);
1433
1434         if (port->serial->dev) {
1435                 /* wait for transmit idle */
1436                 if ((filp->f_flags&(O_NDELAY|O_NONBLOCK)) == 0) {
1437                         digi_transmit_idle(port, DIGI_CLOSE_TIMEOUT);
1438                 }
1439                 /* drop DTR and RTS */
1440                 digi_set_modem_signals(port, 0, 0);
1441
1442                 /* disable input flow control */
1443                 buf[0] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1444                 buf[1] = priv->dp_port_num;
1445                 buf[2] = DIGI_DISABLE;
1446                 buf[3] = 0;
1447
1448                 /* disable output flow control */
1449                 buf[4] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1450                 buf[5] = priv->dp_port_num;
1451                 buf[6] = DIGI_DISABLE;
1452                 buf[7] = 0;
1453
1454                 /* disable reading modem signals automatically */
1455                 buf[8] = DIGI_CMD_READ_INPUT_SIGNALS;
1456                 buf[9] = priv->dp_port_num;
1457                 buf[10] = DIGI_DISABLE;
1458                 buf[11] = 0;
1459
1460                 /* disable receive */
1461                 buf[12] = DIGI_CMD_RECEIVE_ENABLE;
1462                 buf[13] = priv->dp_port_num;
1463                 buf[14] = DIGI_DISABLE;
1464                 buf[15] = 0;
1465
1466                 /* flush fifos */
1467                 buf[16] = DIGI_CMD_IFLUSH_FIFO;
1468                 buf[17] = priv->dp_port_num;
1469                 buf[18] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1470                 buf[19] = 0;
1471
1472                 if ((ret = digi_write_oob_command(port, buf, 20, 0)) != 0)
1473                         dbg("digi_close: write oob failed, ret=%d", ret);
1474
1475                 /* wait for final commands on oob port to complete */
1476                 prepare_to_wait(&priv->dp_flush_wait, &wait, TASK_INTERRUPTIBLE);
1477                 schedule_timeout(DIGI_CLOSE_TIMEOUT);
1478                 finish_wait(&priv->dp_flush_wait, &wait);
1479
1480                 /* shutdown any outstanding bulk writes */
1481                 usb_kill_urb(port->write_urb);
1482         }
1483         tty->closing = 0;
1484 exit:
1485         spin_lock_irq(&priv->dp_port_lock);
1486         priv->dp_write_urb_in_use = 0;
1487         priv->dp_in_close = 0;
1488         wake_up_interruptible(&priv->dp_close_wait);
1489         spin_unlock_irq(&priv->dp_port_lock);
1490         mutex_unlock(&port->serial->disc_mutex);
1491         dbg("digi_close: done");
1492 }
1493
1494
1495 /*
1496 *  Digi Startup Device
1497 *
1498 *  Starts reads on all ports.  Must be called AFTER startup, with
1499 *  urbs initialized.  Returns 0 if successful, non-zero error otherwise.
1500 */
1501
1502 static int digi_startup_device(struct usb_serial *serial)
1503 {
1504         int i,ret = 0;
1505         struct digi_serial *serial_priv = usb_get_serial_data(serial);
1506         struct usb_serial_port *port;
1507
1508         /* be sure this happens exactly once */
1509         spin_lock(&serial_priv->ds_serial_lock);
1510         if (serial_priv->ds_device_started) {
1511                 spin_unlock(&serial_priv->ds_serial_lock);
1512                 return 0;
1513         }
1514         serial_priv->ds_device_started = 1;
1515         spin_unlock(&serial_priv->ds_serial_lock);
1516
1517         /* start reading from each bulk in endpoint for the device */
1518         /* set USB_DISABLE_SPD flag for write bulk urbs */
1519         for (i = 0; i < serial->type->num_ports + 1; i++) {
1520                 port = serial->port[i];
1521                 port->write_urb->dev = port->serial->dev;
1522                 if ((ret = usb_submit_urb(port->read_urb, GFP_KERNEL)) != 0) {
1523                         err("%s: usb_submit_urb failed, ret=%d, port=%d",
1524                                         __FUNCTION__, ret, i);
1525                         break;
1526                 }
1527         }
1528         return ret;
1529 }
1530
1531
1532 static int digi_startup(struct usb_serial *serial)
1533 {
1534
1535         int i;
1536         struct digi_port *priv;
1537         struct digi_serial *serial_priv;
1538
1539         dbg("digi_startup: TOP");
1540
1541         /* allocate the private data structures for all ports */
1542         /* number of regular ports + 1 for the out-of-band port */
1543         for(i = 0; i < serial->type->num_ports + 1; i++) {
1544                 /* allocate port private structure */
1545                 priv = kmalloc(sizeof(struct digi_port), GFP_KERNEL);
1546                 if (priv == NULL) {
1547                         while (--i >= 0)
1548                                 kfree(usb_get_serial_port_data(serial->port[i]));
1549                         return 1;                       /* error */
1550                 }
1551
1552                 /* initialize port private structure */
1553                 spin_lock_init(&priv->dp_port_lock);
1554                 priv->dp_port_num = i;
1555                 priv->dp_out_buf_len = 0;
1556                 priv->dp_write_urb_in_use = 0;
1557                 priv->dp_modem_signals = 0;
1558                 init_waitqueue_head(&priv->dp_modem_change_wait);
1559                 priv->dp_transmit_idle = 0;
1560                 init_waitqueue_head(&priv->dp_transmit_idle_wait);
1561                 priv->dp_throttled = 0;
1562                 priv->dp_throttle_restart = 0;
1563                 init_waitqueue_head(&priv->dp_flush_wait);
1564                 priv->dp_in_close = 0;
1565                 init_waitqueue_head(&priv->dp_close_wait);
1566                 INIT_WORK(&priv->dp_wakeup_work, digi_wakeup_write_lock);
1567                 priv->dp_port = serial->port[i];
1568                 /* initialize write wait queue for this port */
1569                 init_waitqueue_head(&serial->port[i]->write_wait);
1570
1571                 usb_set_serial_port_data(serial->port[i], priv);
1572         }
1573
1574         /* allocate serial private structure */
1575         serial_priv = kmalloc(sizeof(struct digi_serial), GFP_KERNEL);
1576         if (serial_priv == NULL) {
1577                 for (i = 0; i < serial->type->num_ports + 1; i++)
1578                         kfree(usb_get_serial_port_data(serial->port[i]));
1579                 return 1;                       /* error */
1580         }
1581
1582         /* initialize serial private structure */
1583         spin_lock_init(&serial_priv->ds_serial_lock);
1584         serial_priv->ds_oob_port_num = serial->type->num_ports;
1585         serial_priv->ds_oob_port = serial->port[serial_priv->ds_oob_port_num];
1586         serial_priv->ds_device_started = 0;
1587         usb_set_serial_data(serial, serial_priv);
1588
1589         return 0;
1590 }
1591
1592
1593 static void digi_shutdown(struct usb_serial *serial)
1594 {
1595         int i;
1596         dbg("digi_shutdown: TOP, in_interrupt()=%ld", in_interrupt());
1597
1598         /* stop reads and writes on all ports */
1599         for (i = 0; i < serial->type->num_ports + 1; i++) {
1600                 usb_kill_urb(serial->port[i]->read_urb);
1601                 usb_kill_urb(serial->port[i]->write_urb);
1602         }
1603
1604         /* free the private data structures for all ports */
1605         /* number of regular ports + 1 for the out-of-band port */
1606         for(i = 0; i < serial->type->num_ports + 1; i++)
1607                 kfree(usb_get_serial_port_data(serial->port[i]));
1608         kfree(usb_get_serial_data(serial));
1609 }
1610
1611
1612 static void digi_read_bulk_callback(struct urb *urb)
1613 {
1614         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1615         struct digi_port *priv;
1616         struct digi_serial *serial_priv;
1617         int ret;
1618         int status = urb->status;
1619
1620         dbg("digi_read_bulk_callback: TOP");
1621
1622         /* port sanity check, do not resubmit if port is not valid */
1623         if (port == NULL || (priv = usb_get_serial_port_data(port)) == NULL) {
1624                 err("%s: port or port->private is NULL, status=%d",
1625                     __FUNCTION__, status);
1626                 return;
1627         }
1628         if (port->serial == NULL ||
1629                 (serial_priv=usb_get_serial_data(port->serial)) == NULL) {
1630                 err("%s: serial is bad or serial->private is NULL, status=%d",
1631                         __FUNCTION__, status);
1632                 return;
1633         }
1634
1635         /* do not resubmit urb if it has any status error */
1636         if (status) {
1637                 err("%s: nonzero read bulk status: status=%d, port=%d",
1638                     __FUNCTION__, status, priv->dp_port_num);
1639                 return;
1640         }
1641
1642         /* handle oob or inb callback, do not resubmit if error */
1643         if (priv->dp_port_num == serial_priv->ds_oob_port_num) {
1644                 if (digi_read_oob_callback(urb) != 0)
1645                         return;
1646         } else {
1647                 if (digi_read_inb_callback(urb) != 0)
1648                         return;
1649         }
1650
1651         /* continue read */
1652         urb->dev = port->serial->dev;
1653         if ((ret = usb_submit_urb(urb, GFP_ATOMIC)) != 0) {
1654                 err("%s: failed resubmitting urb, ret=%d, port=%d",
1655                     __FUNCTION__, ret, priv->dp_port_num);
1656         }
1657
1658 }
1659
1660 /*
1661 *  Digi Read INB Callback
1662 *
1663 *  Digi Read INB Callback handles reads on the in band ports, sending
1664 *  the data on to the tty subsystem.  When called we know port and
1665 *  port->private are not NULL and port->serial has been validated.
1666 *  It returns 0 if successful, 1 if successful but the port is
1667 *  throttled, and -1 if the sanity checks failed.
1668 */
1669
1670 static int digi_read_inb_callback(struct urb *urb)
1671 {
1672
1673         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1674         struct tty_struct *tty = port->tty;
1675         struct digi_port *priv = usb_get_serial_port_data(port);
1676         int opcode = ((unsigned char *)urb->transfer_buffer)[0];
1677         int len = ((unsigned char *)urb->transfer_buffer)[1];
1678         int port_status = ((unsigned char *)urb->transfer_buffer)[2];
1679         unsigned char *data = ((unsigned char *)urb->transfer_buffer)+3;
1680         int flag,throttled;
1681         int i;
1682         int status = urb->status;
1683
1684         /* do not process callbacks on closed ports */
1685         /* but do continue the read chain */
1686         if (port->open_count == 0)
1687                 return 0;
1688
1689         /* short/multiple packet check */
1690         if (urb->actual_length != len + 2) {
1691                 err("%s: INCOMPLETE OR MULTIPLE PACKET, urb->status=%d, "
1692                     "port=%d, opcode=%d, len=%d, actual_length=%d, "
1693                     "status=%d", __FUNCTION__, status, priv->dp_port_num,
1694                     opcode, len, urb->actual_length, port_status);
1695                 return -1;
1696         }
1697
1698         spin_lock(&priv->dp_port_lock);
1699
1700         /* check for throttle; if set, do not resubmit read urb */
1701         /* indicate the read chain needs to be restarted on unthrottle */
1702         throttled = priv->dp_throttled;
1703         if (throttled)
1704                 priv->dp_throttle_restart = 1;
1705
1706         /* receive data */
1707         if (opcode == DIGI_CMD_RECEIVE_DATA) {
1708                 /* get flag from port_status */
1709                 flag = 0;
1710
1711                 /* overrun is special, not associated with a char */
1712                 if (port_status & DIGI_OVERRUN_ERROR)
1713                         tty_insert_flip_char(tty, 0, TTY_OVERRUN);
1714
1715                 /* break takes precedence over parity, */
1716                 /* which takes precedence over framing errors */
1717                 if (port_status & DIGI_BREAK_ERROR)
1718                         flag = TTY_BREAK;
1719                 else if (port_status & DIGI_PARITY_ERROR)
1720                         flag = TTY_PARITY;
1721                 else if (port_status & DIGI_FRAMING_ERROR)
1722                         flag = TTY_FRAME;
1723
1724                 /* data length is len-1 (one byte of len is port_status) */
1725                 --len;
1726
1727                 len = tty_buffer_request_room(tty, len);
1728                 if (len > 0) {
1729                         /* Hot path */
1730                         if (flag == TTY_NORMAL)
1731                                 tty_insert_flip_string(tty, data, len);
1732                         else {
1733                                 for(i = 0; i < len; i++)
1734                                         tty_insert_flip_char(tty, data[i], flag);
1735                         }
1736                         tty_flip_buffer_push(tty);
1737                 }
1738         }
1739         spin_unlock(&priv->dp_port_lock);
1740
1741         if (opcode == DIGI_CMD_RECEIVE_DISABLE)
1742                 dbg("%s: got RECEIVE_DISABLE", __FUNCTION__);
1743         else if (opcode != DIGI_CMD_RECEIVE_DATA)
1744                 dbg("%s: unknown opcode: %d", __FUNCTION__, opcode);
1745
1746         return(throttled ? 1 : 0);
1747
1748 }
1749
1750
1751 /*
1752 *  Digi Read OOB Callback
1753 *
1754 *  Digi Read OOB Callback handles reads on the out of band port.
1755 *  When called we know port and port->private are not NULL and
1756 *  the port->serial is valid.  It returns 0 if successful, and
1757 *  -1 if the sanity checks failed.
1758 */
1759
1760 static int digi_read_oob_callback(struct urb *urb)
1761 {
1762
1763         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1764         struct usb_serial *serial = port->serial;
1765         struct digi_port *priv = usb_get_serial_port_data(port);
1766         int opcode, line, status, val;
1767         int i;
1768
1769         dbg("digi_read_oob_callback: port=%d, len=%d",
1770                         priv->dp_port_num, urb->actual_length);
1771
1772         /* handle each oob command */
1773         for(i = 0; i < urb->actual_length - 3;) {
1774                 opcode = ((unsigned char *)urb->transfer_buffer)[i++];
1775                 line = ((unsigned char *)urb->transfer_buffer)[i++];
1776                 status = ((unsigned char *)urb->transfer_buffer)[i++];
1777                 val = ((unsigned char *)urb->transfer_buffer)[i++];
1778
1779                 dbg("digi_read_oob_callback: opcode=%d, line=%d, status=%d, val=%d",
1780                         opcode, line, status, val);
1781
1782                 if (status != 0 || line >= serial->type->num_ports)
1783                         continue;
1784
1785                 port = serial->port[line];
1786
1787                 if ((priv=usb_get_serial_port_data(port)) == NULL)
1788                         return -1;
1789
1790                 if (opcode == DIGI_CMD_READ_INPUT_SIGNALS) {
1791                         spin_lock(&priv->dp_port_lock);
1792                         /* convert from digi flags to termiox flags */
1793                         if (val & DIGI_READ_INPUT_SIGNALS_CTS) {
1794                                 priv->dp_modem_signals |= TIOCM_CTS;
1795                                 /* port must be open to use tty struct */
1796                                 if (port->open_count
1797                                         && port->tty->termios->c_cflag & CRTSCTS) {
1798                                         port->tty->hw_stopped = 0;
1799                                         digi_wakeup_write(port);
1800                                 }
1801                         } else {
1802                                 priv->dp_modem_signals &= ~TIOCM_CTS;
1803                                 /* port must be open to use tty struct */
1804                                 if (port->open_count
1805                                         && port->tty->termios->c_cflag & CRTSCTS) {
1806                                         port->tty->hw_stopped = 1;
1807                                 }
1808                         }
1809                         if (val & DIGI_READ_INPUT_SIGNALS_DSR)
1810                                 priv->dp_modem_signals |= TIOCM_DSR;
1811                         else
1812                                 priv->dp_modem_signals &= ~TIOCM_DSR;
1813                         if (val & DIGI_READ_INPUT_SIGNALS_RI)
1814                                 priv->dp_modem_signals |= TIOCM_RI;
1815                         else
1816                                 priv->dp_modem_signals &= ~TIOCM_RI;
1817                         if (val & DIGI_READ_INPUT_SIGNALS_DCD)
1818                                 priv->dp_modem_signals |= TIOCM_CD;
1819                         else
1820                                 priv->dp_modem_signals &= ~TIOCM_CD;
1821
1822                         wake_up_interruptible(&priv->dp_modem_change_wait);
1823                         spin_unlock(&priv->dp_port_lock);
1824                 } else if (opcode == DIGI_CMD_TRANSMIT_IDLE) {
1825                         spin_lock(&priv->dp_port_lock);
1826                         priv->dp_transmit_idle = 1;
1827                         wake_up_interruptible(&priv->dp_transmit_idle_wait);
1828                         spin_unlock(&priv->dp_port_lock);
1829                 } else if (opcode == DIGI_CMD_IFLUSH_FIFO) {
1830                         wake_up_interruptible(&priv->dp_flush_wait);
1831                 }
1832         }
1833         return 0;
1834
1835 }
1836
1837 static int __init digi_init(void)
1838 {
1839         int retval;
1840         retval = usb_serial_register(&digi_acceleport_2_device);
1841         if (retval)
1842                 goto failed_acceleport_2_device;
1843         retval = usb_serial_register(&digi_acceleport_4_device);
1844         if (retval)
1845                 goto failed_acceleport_4_device;
1846         retval = usb_register(&digi_driver);
1847         if (retval)
1848                 goto failed_usb_register;
1849         info(DRIVER_VERSION ":" DRIVER_DESC);
1850         return 0;
1851 failed_usb_register:
1852         usb_serial_deregister(&digi_acceleport_4_device);
1853 failed_acceleport_4_device:
1854         usb_serial_deregister(&digi_acceleport_2_device);
1855 failed_acceleport_2_device:
1856         return retval;
1857 }
1858
1859 static void __exit digi_exit (void)
1860 {
1861         usb_deregister(&digi_driver);
1862         usb_serial_deregister(&digi_acceleport_2_device);
1863         usb_serial_deregister(&digi_acceleport_4_device);
1864 }
1865
1866
1867 module_init(digi_init);
1868 module_exit(digi_exit);
1869
1870
1871 MODULE_AUTHOR(DRIVER_AUTHOR);
1872 MODULE_DESCRIPTION(DRIVER_DESC);
1873 MODULE_LICENSE("GPL");
1874
1875 module_param(debug, bool, S_IRUGO | S_IWUSR);
1876 MODULE_PARM_DESC(debug, "Debug enabled or not");