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->port.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
 234 #include <linux/kernel.h>
 235 #include <linux/errno.h>
 236 #include <linux/init.h>
 237 #include <linux/slab.h>
 238 #include <linux/tty.h>
 239 #include <linux/tty_driver.h>
 240 #include <linux/tty_flip.h>
 241 #include <linux/module.h>
 242 #include <linux/spinlock.h>
 243 #include <linux/workqueue.h>
 244 #include <linux/uaccess.h>
 245 #include <linux/usb.h>
 246 #include <linux/wait.h>
 247 #include <linux/usb/serial.h>
 248
 249 /* Defines */
 250
 251 /*
 252  * Version Information
 253  */
 254 #define DRIVER_VERSION "v1.80.1.2"
 255 #define DRIVER_AUTHOR "Peter Berger <pberger@brimson.com>, Al Borchers <borchers@steinerpoint.com>"
 256 #define DRIVER_DESC "Digi AccelePort USB-2/USB-4 Serial Converter driver"
 257
 258 /* port output buffer length -- must be <= transfer buffer length - 2 */
 259 /* so we can be sure to send the full buffer in one urb */
 260 #define DIGI_OUT_BUF_SIZE               8
 261
 262 /* port input buffer length -- must be >= transfer buffer length - 3 */
 263 /* so we can be sure to hold at least one full buffer from one urb */
 264 #define DIGI_IN_BUF_SIZE                64
 265
 266 /* retry timeout while sleeping */
 267 #define DIGI_RETRY_TIMEOUT              (HZ/10)
 268
 269 /* timeout while waiting for tty output to drain in close */
 270 /* this delay is used twice in close, so the total delay could */
 271 /* be twice this value */
 272 #define DIGI_CLOSE_TIMEOUT              (5*HZ)
 273
 274
 275 /* AccelePort USB Defines */
 276
 277 /* ids */
 278 #define DIGI_VENDOR_ID                  0x05c5
 279 #define DIGI_2_ID                       0x0002  /* USB-2 */
 280 #define DIGI_4_ID                       0x0004  /* USB-4 */
 281
 282 /* commands
 283  * "INB": can be used on the in-band endpoint
 284  * "OOB": can be used on the out-of-band endpoint
 285  */
 286 #define DIGI_CMD_SET_BAUD_RATE                  0       /* INB, OOB */
 287 #define DIGI_CMD_SET_WORD_SIZE                  1       /* INB, OOB */
 288 #define DIGI_CMD_SET_PARITY                     2       /* INB, OOB */
 289 #define DIGI_CMD_SET_STOP_BITS                  3       /* INB, OOB */
 290 #define DIGI_CMD_SET_INPUT_FLOW_CONTROL         4       /* INB, OOB */
 291 #define DIGI_CMD_SET_OUTPUT_FLOW_CONTROL        5       /* INB, OOB */
 292 #define DIGI_CMD_SET_DTR_SIGNAL                 6       /* INB, OOB */
 293 #define DIGI_CMD_SET_RTS_SIGNAL                 7       /* INB, OOB */
 294 #define DIGI_CMD_READ_INPUT_SIGNALS             8       /*      OOB */
 295 #define DIGI_CMD_IFLUSH_FIFO                    9       /*      OOB */
 296 #define DIGI_CMD_RECEIVE_ENABLE                 10      /* INB, OOB */
 297 #define DIGI_CMD_BREAK_CONTROL                  11      /* INB, OOB */
 298 #define DIGI_CMD_LOCAL_LOOPBACK                 12      /* INB, OOB */
 299 #define DIGI_CMD_TRANSMIT_IDLE                  13      /* INB, OOB */
 300 #define DIGI_CMD_READ_UART_REGISTER             14      /*      OOB */
 301 #define DIGI_CMD_WRITE_UART_REGISTER            15      /* INB, OOB */
 302 #define DIGI_CMD_AND_UART_REGISTER              16      /* INB, OOB */
 303 #define DIGI_CMD_OR_UART_REGISTER               17      /* INB, OOB */
 304 #define DIGI_CMD_SEND_DATA                      18      /* INB      */
 305 #define DIGI_CMD_RECEIVE_DATA                   19      /* INB      */
 306 #define DIGI_CMD_RECEIVE_DISABLE                20      /* INB      */
 307 #define DIGI_CMD_GET_PORT_TYPE                  21      /*      OOB */
 308
 309 /* baud rates */
 310 #define DIGI_BAUD_50                            0
 311 #define DIGI_BAUD_75                            1
 312 #define DIGI_BAUD_110                           2
 313 #define DIGI_BAUD_150                           3
 314 #define DIGI_BAUD_200                           4
 315 #define DIGI_BAUD_300                           5
 316 #define DIGI_BAUD_600                           6
 317 #define DIGI_BAUD_1200                          7
 318 #define DIGI_BAUD_1800                          8
 319 #define DIGI_BAUD_2400                          9
 320 #define DIGI_BAUD_4800                          10
 321 #define DIGI_BAUD_7200                          11
 322 #define DIGI_BAUD_9600                          12
 323 #define DIGI_BAUD_14400                         13
 324 #define DIGI_BAUD_19200                         14
 325 #define DIGI_BAUD_28800                         15
 326 #define DIGI_BAUD_38400                         16
 327 #define DIGI_BAUD_57600                         17
 328 #define DIGI_BAUD_76800                         18
 329 #define DIGI_BAUD_115200                        19
 330 #define DIGI_BAUD_153600                        20
 331 #define DIGI_BAUD_230400                        21
 332 #define DIGI_BAUD_460800                        22
 333
 334 /* arguments */
 335 #define DIGI_WORD_SIZE_5                        0
 336 #define DIGI_WORD_SIZE_6                        1
 337 #define DIGI_WORD_SIZE_7                        2
 338 #define DIGI_WORD_SIZE_8                        3
 339
 340 #define DIGI_PARITY_NONE                        0
 341 #define DIGI_PARITY_ODD                         1
 342 #define DIGI_PARITY_EVEN                        2
 343 #define DIGI_PARITY_MARK                        3
 344 #define DIGI_PARITY_SPACE                       4
 345
 346 #define DIGI_STOP_BITS_1                        0
 347 #define DIGI_STOP_BITS_2                        1
 348
 349 #define DIGI_INPUT_FLOW_CONTROL_XON_XOFF        1
 350 #define DIGI_INPUT_FLOW_CONTROL_RTS             2
 351 #define DIGI_INPUT_FLOW_CONTROL_DTR             4
 352
 353 #define DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF       1
 354 #define DIGI_OUTPUT_FLOW_CONTROL_CTS            2
 355 #define DIGI_OUTPUT_FLOW_CONTROL_DSR            4
 356
 357 #define DIGI_DTR_INACTIVE                       0
 358 #define DIGI_DTR_ACTIVE                         1
 359 #define DIGI_DTR_INPUT_FLOW_CONTROL             2
 360
 361 #define DIGI_RTS_INACTIVE                       0
 362 #define DIGI_RTS_ACTIVE                         1
 363 #define DIGI_RTS_INPUT_FLOW_CONTROL             2
 364 #define DIGI_RTS_TOGGLE                         3
 365
 366 #define DIGI_FLUSH_TX                           1
 367 #define DIGI_FLUSH_RX                           2
 368 #define DIGI_RESUME_TX                          4 /* clears xoff condition */
 369
 370 #define DIGI_TRANSMIT_NOT_IDLE                  0
 371 #define DIGI_TRANSMIT_IDLE                      1
 372
 373 #define DIGI_DISABLE                            0
 374 #define DIGI_ENABLE                             1
 375
 376 #define DIGI_DEASSERT                           0
 377 #define DIGI_ASSERT                             1
 378
 379 /* in band status codes */
 380 #define DIGI_OVERRUN_ERROR                      4
 381 #define DIGI_PARITY_ERROR                       8
 382 #define DIGI_FRAMING_ERROR                      16
 383 #define DIGI_BREAK_ERROR                        32
 384
 385 /* out of band status */
 386 #define DIGI_NO_ERROR                           0
 387 #define DIGI_BAD_FIRST_PARAMETER                1
 388 #define DIGI_BAD_SECOND_PARAMETER               2
 389 #define DIGI_INVALID_LINE                       3
 390 #define DIGI_INVALID_OPCODE                     4
 391
 392 /* input signals */
 393 #define DIGI_READ_INPUT_SIGNALS_SLOT            1
 394 #define DIGI_READ_INPUT_SIGNALS_ERR             2
 395 #define DIGI_READ_INPUT_SIGNALS_BUSY            4
 396 #define DIGI_READ_INPUT_SIGNALS_PE              8
 397 #define DIGI_READ_INPUT_SIGNALS_CTS             16
 398 #define DIGI_READ_INPUT_SIGNALS_DSR             32
 399 #define DIGI_READ_INPUT_SIGNALS_RI              64
 400 #define DIGI_READ_INPUT_SIGNALS_DCD             128
 401
 402
 403 /* Structures */
 404
 405 struct digi_serial {
 406         spinlock_t ds_serial_lock;
 407         struct usb_serial_port *ds_oob_port;    /* out-of-band port */
 408         int ds_oob_port_num;                    /* index of out-of-band port */
 409         int ds_device_started;
 410 };
 411
 412 struct digi_port {
 413         spinlock_t dp_port_lock;
 414         int dp_port_num;
 415         int dp_out_buf_len;
 416         unsigned char dp_out_buf[DIGI_OUT_BUF_SIZE];
 417         int dp_write_urb_in_use;
 418         unsigned int dp_modem_signals;
 419         wait_queue_head_t dp_modem_change_wait;
 420         int dp_transmit_idle;
 421         wait_queue_head_t dp_transmit_idle_wait;
 422         int dp_throttled;
 423         int dp_throttle_restart;
 424         wait_queue_head_t dp_flush_wait;
 425         wait_queue_head_t dp_close_wait;        /* wait queue for close */
 426         struct work_struct dp_wakeup_work;
 427         struct usb_serial_port *dp_port;
 428 };
 429
 430
 431 /* Local Function Declarations */
 432
 433 static void digi_wakeup_write(struct usb_serial_port *port);
 434 static void digi_wakeup_write_lock(struct work_struct *work);
 435 static int digi_write_oob_command(struct usb_serial_port *port,
 436         unsigned char *buf, int count, int interruptible);
 437 static int digi_write_inb_command(struct usb_serial_port *port,
 438         unsigned char *buf, int count, unsigned long timeout);
 439 static int digi_set_modem_signals(struct usb_serial_port *port,
 440         unsigned int modem_signals, int interruptible);
 441 static int digi_transmit_idle(struct usb_serial_port *port,
 442         unsigned long timeout);
 443 static void digi_rx_throttle(struct tty_struct *tty);
 444 static void digi_rx_unthrottle(struct tty_struct *tty);
 445 static void digi_set_termios(struct tty_struct *tty,
 446                 struct usb_serial_port *port, struct ktermios *old_termios);
 447 static void digi_break_ctl(struct tty_struct *tty, int break_state);
 448 static int digi_tiocmget(struct tty_struct *tty, struct file *file);
 449 static int digi_tiocmset(struct tty_struct *tty, struct file *file,
 450         unsigned int set, unsigned int clear);
 451 static int digi_write(struct tty_struct *tty, struct usb_serial_port *port,
 452         const unsigned char *buf, int count);
 453 static void digi_write_bulk_callback(struct urb *urb);
 454 static int digi_write_room(struct tty_struct *tty);
 455 static int digi_chars_in_buffer(struct tty_struct *tty);
 456 static int digi_open(struct tty_struct *tty, struct usb_serial_port *port);
 457 static void digi_close(struct usb_serial_port *port);
 458 static int digi_carrier_raised(struct usb_serial_port *port);
 459 static void digi_dtr_rts(struct usb_serial_port *port, int on);
 460 static int digi_startup_device(struct usb_serial *serial);
 461 static int digi_startup(struct usb_serial *serial);
 462 static void digi_disconnect(struct usb_serial *serial);
 463 static void digi_release(struct usb_serial *serial);
 464 static void digi_read_bulk_callback(struct urb *urb);
 465 static int digi_read_inb_callback(struct urb *urb);
 466 static int digi_read_oob_callback(struct urb *urb);
 467
 468
 469 /* Statics */
 470
 471 static int debug;
 472
 473 static const struct usb_device_id id_table_combined[] = {
 474         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
 475         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
 476         { }                                             /* Terminating entry */
 477 };
 478
 479 static const struct usb_device_id id_table_2[] = {
 480         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
 481         { }                                             /* Terminating entry */
 482 };
 483
 484 static const struct usb_device_id id_table_4[] = {
 485         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
 486         { }                                             /* Terminating entry */
 487 };
 488
 489 MODULE_DEVICE_TABLE(usb, id_table_combined);
 490
 491 static struct usb_driver digi_driver = {
 492         .name =         "digi_acceleport",
 493         .probe =        usb_serial_probe,
 494         .disconnect =   usb_serial_disconnect,
 495         .id_table =     id_table_combined,
 496         .no_dynamic_id =        1,
 497 };
 498
 499
 500 /* device info needed for the Digi serial converter */
 501
 502 static struct usb_serial_driver digi_acceleport_2_device = {
 503         .driver = {
 504                 .owner =                THIS_MODULE,
 505                 .name =                 "digi_2",
 506         },
 507         .description =                  "Digi 2 port USB adapter",
 508         .usb_driver =                   &digi_driver,
 509         .id_table =                     id_table_2,
 510         .num_ports =                    3,
 511         .open =                         digi_open,
 512         .close =                        digi_close,
 513         .dtr_rts =                      digi_dtr_rts,
 514         .carrier_raised =               digi_carrier_raised,
 515         .write =                        digi_write,
 516         .write_room =                   digi_write_room,
 517         .write_bulk_callback =          digi_write_bulk_callback,
 518         .read_bulk_callback =           digi_read_bulk_callback,
 519         .chars_in_buffer =              digi_chars_in_buffer,
 520         .throttle =                     digi_rx_throttle,
 521         .unthrottle =                   digi_rx_unthrottle,
 522         .set_termios =                  digi_set_termios,
 523         .break_ctl =                    digi_break_ctl,
 524         .tiocmget =                     digi_tiocmget,
 525         .tiocmset =                     digi_tiocmset,
 526         .attach =                       digi_startup,
 527         .disconnect =                   digi_disconnect,
 528         .release =                      digi_release,
 529 };
 530
 531 static struct usb_serial_driver digi_acceleport_4_device = {
 532         .driver = {
 533                 .owner =                THIS_MODULE,
 534                 .name =                 "digi_4",
 535         },
 536         .description =                  "Digi 4 port USB adapter",
 537         .usb_driver =                   &digi_driver,
 538         .id_table =                     id_table_4,
 539         .num_ports =                    4,
 540         .open =                         digi_open,
 541         .close =                        digi_close,
 542         .write =                        digi_write,
 543         .write_room =                   digi_write_room,
 544         .write_bulk_callback =          digi_write_bulk_callback,
 545         .read_bulk_callback =           digi_read_bulk_callback,
 546         .chars_in_buffer =              digi_chars_in_buffer,
 547         .throttle =                     digi_rx_throttle,
 548         .unthrottle =                   digi_rx_unthrottle,
 549         .set_termios =                  digi_set_termios,
 550         .break_ctl =                    digi_break_ctl,
 551         .tiocmget =                     digi_tiocmget,
 552         .tiocmset =                     digi_tiocmset,
 553         .attach =                       digi_startup,
 554         .disconnect =                   digi_disconnect,
 555         .release =                      digi_release,
 556 };
 557
 558
 559 /* Functions */
 560
 561 /*
 562  *  Cond Wait Interruptible Timeout Irqrestore
 563  *
 564  *  Do spin_unlock_irqrestore and interruptible_sleep_on_timeout
 565  *  so that wake ups are not lost if they occur between the unlock
 566  *  and the sleep.  In other words, spin_unlock_irqrestore and
 567  *  interruptible_sleep_on_timeout are "atomic" with respect to
 568  *  wake ups.  This is used to implement condition variables.
 569  *
 570  *  interruptible_sleep_on_timeout is deprecated and has been replaced
 571  *  with the equivalent code.
 572  */
 573
 574 static long cond_wait_interruptible_timeout_irqrestore(
 575         wait_queue_head_t *q, long timeout,
 576         spinlock_t *lock, unsigned long flags)
 577 __releases(lock)
 578 {
 579         DEFINE_WAIT(wait);
 580
 581         prepare_to_wait(q, &wait, TASK_INTERRUPTIBLE);
 582         spin_unlock_irqrestore(lock, flags);
 583         timeout = schedule_timeout(timeout);
 584         finish_wait(q, &wait);
 585
 586         return timeout;
 587 }
 588
 589
 590 /*
 591  *  Digi Wakeup Write
 592  *
 593  *  Wake up port, line discipline, and tty processes sleeping
 594  *  on writes.
 595  */
 596
 597 static void digi_wakeup_write_lock(struct work_struct *work)
 598 {
 599         struct digi_port *priv =
 600                         container_of(work, struct digi_port, dp_wakeup_work);
 601         struct usb_serial_port *port = priv->dp_port;
 602         unsigned long flags;
 603
 604         spin_lock_irqsave(&priv->dp_port_lock, flags);
 605         digi_wakeup_write(port);
 606         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 607 }
 608
 609 static void digi_wakeup_write(struct usb_serial_port *port)
 610 {
 611         struct tty_struct *tty = tty_port_tty_get(&port->port);
 612         if (tty) {
 613                 tty_wakeup(tty);
 614                 tty_kref_put(tty);
 615         }
 616 }
 617
 618
 619 /*
 620  *  Digi Write OOB Command
 621  *
 622  *  Write commands on the out of band port.  Commands are 4
 623  *  bytes each, multiple commands can be sent at once, and
 624  *  no command will be split across USB packets.  Returns 0
 625  *  if successful, -EINTR if interrupted while sleeping and
 626  *  the interruptible flag is true, or a negative error
 627  *  returned by usb_submit_urb.
 628  */
 629
 630 static int digi_write_oob_command(struct usb_serial_port *port,
 631         unsigned char *buf, int count, int interruptible)
 632 {
 633
 634         int ret = 0;
 635         int len;
 636         struct usb_serial_port *oob_port = (struct usb_serial_port *)((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
 637         struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
 638         unsigned long flags = 0;
 639
 640         dbg("digi_write_oob_command: TOP: port=%d, count=%d", oob_priv->dp_port_num, count);
 641
 642         spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
 643         while (count > 0) {
 644                 while (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                 ret = usb_submit_urb(oob_port->write_urb, GFP_ATOMIC);
 661                 if (ret == 0) {
 662                         oob_priv->dp_write_urb_in_use = 1;
 663                         count -= len;
 664                         buf += len;
 665                 }
 666         }
 667         spin_unlock_irqrestore(&oob_priv->dp_port_lock, flags);
 668         if (ret)
 669                 dev_err(&port->dev, "%s: usb_submit_urb failed, ret=%d\n",
 670                         __func__, ret);
 671         return ret;
 672
 673 }
 674
 675
 676 /*
 677  *  Digi Write In Band Command
 678  *
 679  *  Write commands on the given port.  Commands are 4
 680  *  bytes each, multiple commands can be sent at once, and
 681  *  no command will be split across USB packets.  If timeout
 682  *  is non-zero, write in band command will return after
 683  *  waiting unsuccessfully for the URB status to clear for
 684  *  timeout ticks.  Returns 0 if successful, or a negative
 685  *  error returned by digi_write.
 686  */
 687
 688 static int digi_write_inb_command(struct usb_serial_port *port,
 689         unsigned char *buf, int count, unsigned long timeout)
 690 {
 691         int ret = 0;
 692         int len;
 693         struct digi_port *priv = usb_get_serial_port_data(port);
 694         unsigned char *data = port->write_urb->transfer_buffer;
 695         unsigned long flags = 0;
 696
 697         dbg("digi_write_inb_command: TOP: port=%d, count=%d",
 698                 priv->dp_port_num, count);
 699
 700         if (timeout)
 701                 timeout += jiffies;
 702         else
 703                 timeout = ULONG_MAX;
 704
 705         spin_lock_irqsave(&priv->dp_port_lock, flags);
 706         while (count > 0 && ret == 0) {
 707                 while (priv->dp_write_urb_in_use &&
 708                        time_before(jiffies, timeout)) {
 709                         cond_wait_interruptible_timeout_irqrestore(
 710                                 &port->write_wait, DIGI_RETRY_TIMEOUT,
 711                                 &priv->dp_port_lock, flags);
 712                         if (signal_pending(current))
 713                                 return -EINTR;
 714                         spin_lock_irqsave(&priv->dp_port_lock, flags);
 715                 }
 716
 717                 /* len must be a multiple of 4 and small enough to */
 718                 /* guarantee the write will send buffered data first, */
 719                 /* so commands are in order with data and not split */
 720                 len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
 721                 if (len > 4)
 722                         len &= ~3;
 723
 724                 /* write any buffered data first */
 725                 if (priv->dp_out_buf_len > 0) {
 726                         data[0] = DIGI_CMD_SEND_DATA;
 727                         data[1] = priv->dp_out_buf_len;
 728                         memcpy(data + 2, priv->dp_out_buf,
 729                                 priv->dp_out_buf_len);
 730                         memcpy(data + 2 + priv->dp_out_buf_len, buf, len);
 731                         port->write_urb->transfer_buffer_length
 732                                 = priv->dp_out_buf_len + 2 + len;
 733                 } else {
 734                         memcpy(data, buf, len);
 735                         port->write_urb->transfer_buffer_length = len;
 736                 }
 737                 port->write_urb->dev = port->serial->dev;
 738
 739                 ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
 740                 if (ret == 0) {
 741                         priv->dp_write_urb_in_use = 1;
 742                         priv->dp_out_buf_len = 0;
 743                         count -= len;
 744                         buf += len;
 745                 }
 746
 747         }
 748         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 749
 750         if (ret)
 751                 dev_err(&port->dev,
 752                         "%s: usb_submit_urb failed, ret=%d, port=%d\n",
 753                         __func__, ret, priv->dp_port_num);
 754         return ret;
 755 }
 756
 757
 758 /*
 759  *  Digi Set Modem Signals
 760  *
 761  *  Sets or clears DTR and RTS on the port, according to the
 762  *  modem_signals argument.  Use TIOCM_DTR and TIOCM_RTS flags
 763  *  for the modem_signals argument.  Returns 0 if successful,
 764  *  -EINTR if interrupted while sleeping, or a non-zero error
 765  *  returned by usb_submit_urb.
 766  */
 767
 768 static int digi_set_modem_signals(struct usb_serial_port *port,
 769         unsigned int modem_signals, int interruptible)
 770 {
 771
 772         int ret;
 773         struct digi_port *port_priv = usb_get_serial_port_data(port);
 774         struct usb_serial_port *oob_port = (struct usb_serial_port *) ((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
 775         struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
 776         unsigned char *data = oob_port->write_urb->transfer_buffer;
 777         unsigned long flags = 0;
 778
 779
 780         dbg("digi_set_modem_signals: TOP: port=%d, modem_signals=0x%x",
 781                 port_priv->dp_port_num, modem_signals);
 782
 783         spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
 784         spin_lock(&port_priv->dp_port_lock);
 785
 786         while (oob_priv->dp_write_urb_in_use) {
 787                 spin_unlock(&port_priv->dp_port_lock);
 788                 cond_wait_interruptible_timeout_irqrestore(
 789                         &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
 790                         &oob_priv->dp_port_lock, flags);
 791                 if (interruptible && signal_pending(current))
 792                         return -EINTR;
 793                 spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
 794                 spin_lock(&port_priv->dp_port_lock);
 795         }
 796         data[0] = DIGI_CMD_SET_DTR_SIGNAL;
 797         data[1] = port_priv->dp_port_num;
 798         data[2] = (modem_signals & TIOCM_DTR) ?
 799                                         DIGI_DTR_ACTIVE : DIGI_DTR_INACTIVE;
 800         data[3] = 0;
 801         data[4] = DIGI_CMD_SET_RTS_SIGNAL;
 802         data[5] = port_priv->dp_port_num;
 803         data[6] = (modem_signals & TIOCM_RTS) ?
 804                                         DIGI_RTS_ACTIVE : DIGI_RTS_INACTIVE;
 805         data[7] = 0;
 806
 807         oob_port->write_urb->transfer_buffer_length = 8;
 808         oob_port->write_urb->dev = port->serial->dev;
 809
 810         ret = usb_submit_urb(oob_port->write_urb, GFP_ATOMIC);
 811         if (ret == 0) {
 812                 oob_priv->dp_write_urb_in_use = 1;
 813                 port_priv->dp_modem_signals =
 814                         (port_priv->dp_modem_signals&~(TIOCM_DTR|TIOCM_RTS))
 815                         | (modem_signals&(TIOCM_DTR|TIOCM_RTS));
 816         }
 817         spin_unlock(&port_priv->dp_port_lock);
 818         spin_unlock_irqrestore(&oob_priv->dp_port_lock, flags);
 819         if (ret)
 820                 dev_err(&port->dev, "%s: usb_submit_urb failed, ret=%d\n",
 821                         __func__, ret);
 822         return ret;
 823 }
 824
 825 /*
 826  *  Digi Transmit Idle
 827  *
 828  *  Digi transmit idle waits, up to timeout ticks, for the transmitter
 829  *  to go idle.  It returns 0 if successful or a negative error.
 830  *
 831  *  There are race conditions here if more than one process is calling
 832  *  digi_transmit_idle on the same port at the same time.  However, this
 833  *  is only called from close, and only one process can be in close on a
 834  *  port at a time, so its ok.
 835  */
 836
 837 static int digi_transmit_idle(struct usb_serial_port *port,
 838         unsigned long timeout)
 839 {
 840         int ret;
 841         unsigned char buf[2];
 842         struct digi_port *priv = usb_get_serial_port_data(port);
 843         unsigned long flags = 0;
 844
 845         spin_lock_irqsave(&priv->dp_port_lock, flags);
 846         priv->dp_transmit_idle = 0;
 847         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 848
 849         buf[0] = DIGI_CMD_TRANSMIT_IDLE;
 850         buf[1] = 0;
 851
 852         timeout += jiffies;
 853
 854         ret = digi_write_inb_command(port, buf, 2, timeout - jiffies);
 855         if (ret != 0)
 856                 return ret;
 857
 858         spin_lock_irqsave(&priv->dp_port_lock, flags);
 859
 860         while (time_before(jiffies, timeout) && !priv->dp_transmit_idle) {
 861                 cond_wait_interruptible_timeout_irqrestore(
 862                         &priv->dp_transmit_idle_wait, DIGI_RETRY_TIMEOUT,
 863                         &priv->dp_port_lock, flags);
 864                 if (signal_pending(current))
 865                         return -EINTR;
 866                 spin_lock_irqsave(&priv->dp_port_lock, flags);
 867         }
 868         priv->dp_transmit_idle = 0;
 869         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 870         return 0;
 871
 872 }
 873
 874
 875 static void digi_rx_throttle(struct tty_struct *tty)
 876 {
 877         unsigned long flags;
 878         struct usb_serial_port *port = tty->driver_data;
 879         struct digi_port *priv = usb_get_serial_port_data(port);
 880
 881
 882         dbg("digi_rx_throttle: TOP: port=%d", priv->dp_port_num);
 883
 884         /* stop receiving characters by not resubmitting the read urb */
 885         spin_lock_irqsave(&priv->dp_port_lock, flags);
 886         priv->dp_throttled = 1;
 887         priv->dp_throttle_restart = 0;
 888         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 889 }
 890
 891
 892 static void digi_rx_unthrottle(struct tty_struct *tty)
 893 {
 894         int ret = 0;
 895         unsigned long flags;
 896         struct usb_serial_port *port = tty->driver_data;
 897         struct digi_port *priv = usb_get_serial_port_data(port);
 898
 899         dbg("digi_rx_unthrottle: TOP: port=%d", priv->dp_port_num);
 900
 901         spin_lock_irqsave(&priv->dp_port_lock, flags);
 902
 903         /* restart read chain */
 904         if (priv->dp_throttle_restart) {
 905                 port->read_urb->dev = port->serial->dev;
 906                 ret = usb_submit_urb(port->read_urb, GFP_ATOMIC);
 907         }
 908
 909         /* turn throttle off */
 910         priv->dp_throttled = 0;
 911         priv->dp_throttle_restart = 0;
 912
 913         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
 914
 915         if (ret)
 916                 dev_err(&port->dev,
 917                         "%s: usb_submit_urb failed, ret=%d, port=%d\n",
 918                         __func__, ret, priv->dp_port_num);
 919 }
 920
 921
 922 static void digi_set_termios(struct tty_struct *tty,
 923                 struct usb_serial_port *port, struct ktermios *old_termios)
 924 {
 925         struct digi_port *priv = usb_get_serial_port_data(port);
 926         unsigned int iflag = tty->termios->c_iflag;
 927         unsigned int cflag = tty->termios->c_cflag;
 928         unsigned int old_iflag = old_termios->c_iflag;
 929         unsigned int old_cflag = old_termios->c_cflag;
 930         unsigned char buf[32];
 931         unsigned int modem_signals;
 932         int arg, ret;
 933         int i = 0;
 934         speed_t baud;
 935
 936         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);
 937
 938         /* set baud rate */
 939         baud = tty_get_baud_rate(tty);
 940         if (baud != tty_termios_baud_rate(old_termios)) {
 941                 arg = -1;
 942
 943                 /* reassert DTR and (maybe) RTS on transition from B0 */
 944                 if ((old_cflag&CBAUD) == B0) {
 945                         /* don't set RTS if using hardware flow control */
 946                         /* and throttling input */
 947                         modem_signals = TIOCM_DTR;
 948                         if (!(tty->termios->c_cflag & CRTSCTS) ||
 949                             !test_bit(TTY_THROTTLED, &tty->flags))
 950                                 modem_signals |= TIOCM_RTS;
 951                         digi_set_modem_signals(port, modem_signals, 1);
 952                 }
 953                 switch (baud) {
 954                 /* drop DTR and RTS on transition to B0 */
 955                 case 0: digi_set_modem_signals(port, 0, 1); break;
 956                 case 50: arg = DIGI_BAUD_50; break;
 957                 case 75: arg = DIGI_BAUD_75; break;
 958                 case 110: arg = DIGI_BAUD_110; break;
 959                 case 150: arg = DIGI_BAUD_150; break;
 960                 case 200: arg = DIGI_BAUD_200; break;
 961                 case 300: arg = DIGI_BAUD_300; break;
 962                 case 600: arg = DIGI_BAUD_600; break;
 963                 case 1200: arg = DIGI_BAUD_1200; break;
 964                 case 1800: arg = DIGI_BAUD_1800; break;
 965                 case 2400: arg = DIGI_BAUD_2400; break;
 966                 case 4800: arg = DIGI_BAUD_4800; break;
 967                 case 9600: arg = DIGI_BAUD_9600; break;
 968                 case 19200: arg = DIGI_BAUD_19200; break;
 969                 case 38400: arg = DIGI_BAUD_38400; break;
 970                 case 57600: arg = DIGI_BAUD_57600; break;
 971                 case 115200: arg = DIGI_BAUD_115200; break;
 972                 case 230400: arg = DIGI_BAUD_230400; break;
 973                 case 460800: arg = DIGI_BAUD_460800; break;
 974                 default:
 975                         arg = DIGI_BAUD_9600;
 976                         baud = 9600;
 977                         break;
 978                 }
 979                 if (arg != -1) {
 980                         buf[i++] = DIGI_CMD_SET_BAUD_RATE;
 981                         buf[i++] = priv->dp_port_num;
 982                         buf[i++] = arg;
 983                         buf[i++] = 0;
 984                 }
 985         }
 986         /* set parity */
 987         tty->termios->c_cflag &= ~CMSPAR;
 988
 989         if ((cflag&(PARENB|PARODD)) != (old_cflag&(PARENB|PARODD))) {
 990                 if (cflag&PARENB) {
 991                         if (cflag&PARODD)
 992                                 arg = DIGI_PARITY_ODD;
 993                         else
 994                                 arg = DIGI_PARITY_EVEN;
 995                 } else {
 996                         arg = DIGI_PARITY_NONE;
 997                 }
 998                 buf[i++] = DIGI_CMD_SET_PARITY;
 999                 buf[i++] = priv->dp_port_num;
1000                 buf[i++] = arg;
1001                 buf[i++] = 0;
1002         }
1003         /* set word size */
1004         if ((cflag&CSIZE) != (old_cflag&CSIZE)) {
1005                 arg = -1;
1006                 switch (cflag&CSIZE) {
1007                 case CS5: arg = DIGI_WORD_SIZE_5; break;
1008                 case CS6: arg = DIGI_WORD_SIZE_6; break;
1009                 case CS7: arg = DIGI_WORD_SIZE_7; break;
1010                 case CS8: arg = DIGI_WORD_SIZE_8; break;
1011                 default:
1012                         dbg("digi_set_termios: can't handle word size %d",
1013                                 (cflag&CSIZE));
1014                         break;
1015                 }
1016
1017                 if (arg != -1) {
1018                         buf[i++] = DIGI_CMD_SET_WORD_SIZE;
1019                         buf[i++] = priv->dp_port_num;
1020                         buf[i++] = arg;
1021                         buf[i++] = 0;
1022                 }
1023
1024         }
1025
1026         /* set stop bits */
1027         if ((cflag&CSTOPB) != (old_cflag&CSTOPB)) {
1028
1029                 if ((cflag&CSTOPB))
1030                         arg = DIGI_STOP_BITS_2;
1031                 else
1032                         arg = DIGI_STOP_BITS_1;
1033
1034                 buf[i++] = DIGI_CMD_SET_STOP_BITS;
1035                 buf[i++] = priv->dp_port_num;
1036                 buf[i++] = arg;
1037                 buf[i++] = 0;
1038
1039         }
1040
1041         /* set input flow control */
1042         if ((iflag&IXOFF) != (old_iflag&IXOFF)
1043             || (cflag&CRTSCTS) != (old_cflag&CRTSCTS)) {
1044                 arg = 0;
1045                 if (iflag&IXOFF)
1046                         arg |= DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
1047                 else
1048                         arg &= ~DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
1049
1050                 if (cflag&CRTSCTS) {
1051                         arg |= DIGI_INPUT_FLOW_CONTROL_RTS;
1052
1053                         /* On USB-4 it is necessary to assert RTS prior */
1054                         /* to selecting RTS input flow control.  */
1055                         buf[i++] = DIGI_CMD_SET_RTS_SIGNAL;
1056                         buf[i++] = priv->dp_port_num;
1057                         buf[i++] = DIGI_RTS_ACTIVE;
1058                         buf[i++] = 0;
1059
1060                 } else {
1061                         arg &= ~DIGI_INPUT_FLOW_CONTROL_RTS;
1062                 }
1063                 buf[i++] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1064                 buf[i++] = priv->dp_port_num;
1065                 buf[i++] = arg;
1066                 buf[i++] = 0;
1067         }
1068
1069         /* set output flow control */
1070         if ((iflag & IXON) != (old_iflag & IXON)
1071             || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
1072                 arg = 0;
1073                 if (iflag & IXON)
1074                         arg |= DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
1075                 else
1076                         arg &= ~DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
1077
1078                 if (cflag & CRTSCTS) {
1079                         arg |= DIGI_OUTPUT_FLOW_CONTROL_CTS;
1080                 } else {
1081                         arg &= ~DIGI_OUTPUT_FLOW_CONTROL_CTS;
1082                         tty->hw_stopped = 0;
1083                 }
1084
1085                 buf[i++] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1086                 buf[i++] = priv->dp_port_num;
1087                 buf[i++] = arg;
1088                 buf[i++] = 0;
1089         }
1090
1091         /* set receive enable/disable */
1092         if ((cflag & CREAD) != (old_cflag & CREAD)) {
1093                 if (cflag & CREAD)
1094                         arg = DIGI_ENABLE;
1095                 else
1096                         arg = DIGI_DISABLE;
1097
1098                 buf[i++] = DIGI_CMD_RECEIVE_ENABLE;
1099                 buf[i++] = priv->dp_port_num;
1100                 buf[i++] = arg;
1101                 buf[i++] = 0;
1102         }
1103         ret = digi_write_oob_command(port, buf, i, 1);
1104         if (ret != 0)
1105                 dbg("digi_set_termios: write oob failed, ret=%d", ret);
1106         tty_encode_baud_rate(tty, baud, baud);
1107 }
1108
1109
1110 static void digi_break_ctl(struct tty_struct *tty, int break_state)
1111 {
1112         struct usb_serial_port *port = tty->driver_data;
1113         unsigned char buf[4];
1114
1115         buf[0] = DIGI_CMD_BREAK_CONTROL;
1116         buf[1] = 2;                             /* length */
1117         buf[2] = break_state ? 1 : 0;
1118         buf[3] = 0;                             /* pad */
1119         digi_write_inb_command(port, buf, 4, 0);
1120 }
1121
1122
1123 static int digi_tiocmget(struct tty_struct *tty, struct file *file)
1124 {
1125         struct usb_serial_port *port = tty->driver_data;
1126         struct digi_port *priv = usb_get_serial_port_data(port);
1127         unsigned int val;
1128         unsigned long flags;
1129
1130         dbg("%s: TOP: port=%d", __func__, priv->dp_port_num);
1131
1132         spin_lock_irqsave(&priv->dp_port_lock, flags);
1133         val = priv->dp_modem_signals;
1134         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1135         return val;
1136 }
1137
1138
1139 static int digi_tiocmset(struct tty_struct *tty, struct file *file,
1140         unsigned int set, unsigned int clear)
1141 {
1142         struct usb_serial_port *port = tty->driver_data;
1143         struct digi_port *priv = usb_get_serial_port_data(port);
1144         unsigned int val;
1145         unsigned long flags;
1146
1147         dbg("%s: TOP: port=%d", __func__, priv->dp_port_num);
1148
1149         spin_lock_irqsave(&priv->dp_port_lock, flags);
1150         val = (priv->dp_modem_signals & ~clear) | set;
1151         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1152         return digi_set_modem_signals(port, val, 1);
1153 }
1154
1155
1156 static int digi_write(struct tty_struct *tty, struct usb_serial_port *port,
1157                                         const unsigned char *buf, int count)
1158 {
1159
1160         int ret, data_len, new_len;
1161         struct digi_port *priv = usb_get_serial_port_data(port);
1162         unsigned char *data = port->write_urb->transfer_buffer;
1163         unsigned long flags = 0;
1164
1165         dbg("digi_write: TOP: port=%d, count=%d, in_interrupt=%ld",
1166                 priv->dp_port_num, count, in_interrupt());
1167
1168         /* copy user data (which can sleep) before getting spin lock */
1169         count = min(count, port->bulk_out_size-2);
1170         count = min(64, count);
1171
1172         /* be sure only one write proceeds at a time */
1173         /* there are races on the port private buffer */
1174         spin_lock_irqsave(&priv->dp_port_lock, flags);
1175
1176         /* wait for urb status clear to submit another urb */
1177         if (priv->dp_write_urb_in_use) {
1178                 /* buffer data if count is 1 (probably put_char) if possible */
1179                 if (count == 1 && priv->dp_out_buf_len < DIGI_OUT_BUF_SIZE) {
1180                         priv->dp_out_buf[priv->dp_out_buf_len++] = *buf;
1181                         new_len = 1;
1182                 } else {
1183                         new_len = 0;
1184                 }
1185                 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1186                 return new_len;
1187         }
1188
1189         /* allow space for any buffered data and for new data, up to */
1190         /* transfer buffer size - 2 (for command and length bytes) */
1191         new_len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
1192         data_len = new_len + priv->dp_out_buf_len;
1193
1194         if (data_len == 0) {
1195                 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1196                 return 0;
1197         }
1198
1199         port->write_urb->transfer_buffer_length = data_len+2;
1200         port->write_urb->dev = port->serial->dev;
1201
1202         *data++ = DIGI_CMD_SEND_DATA;
1203         *data++ = data_len;
1204
1205         /* copy in buffered data first */
1206         memcpy(data, priv->dp_out_buf, priv->dp_out_buf_len);
1207         data += priv->dp_out_buf_len;
1208
1209         /* copy in new data */
1210         memcpy(data, buf, new_len);
1211
1212         ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1213         if (ret == 0) {
1214                 priv->dp_write_urb_in_use = 1;
1215                 ret = new_len;
1216                 priv->dp_out_buf_len = 0;
1217         }
1218
1219         /* return length of new data written, or error */
1220         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1221         if (ret < 0)
1222                 dev_err(&port->dev,
1223                         "%s: usb_submit_urb failed, ret=%d, port=%d\n",
1224                         __func__, ret, priv->dp_port_num);
1225         dbg("digi_write: returning %d", ret);
1226         return ret;
1227
1228 }
1229
1230 static void digi_write_bulk_callback(struct urb *urb)
1231 {
1232
1233         struct usb_serial_port *port = urb->context;
1234         struct usb_serial *serial;
1235         struct digi_port *priv;
1236         struct digi_serial *serial_priv;
1237         int ret = 0;
1238         int status = urb->status;
1239
1240         dbg("digi_write_bulk_callback: TOP, status=%d", status);
1241
1242         /* port and serial sanity check */
1243         if (port == NULL || (priv = usb_get_serial_port_data(port)) == NULL) {
1244                 pr_err("%s: port or port->private is NULL, status=%d\n",
1245                         __func__, status);
1246                 return;
1247         }
1248         serial = port->serial;
1249         if (serial == NULL || (serial_priv = usb_get_serial_data(serial)) == NULL) {
1250                 dev_err(&port->dev,
1251                         "%s: serial or serial->private is NULL, status=%d\n",
1252                         __func__, status);
1253                 return;
1254         }
1255
1256         /* handle oob callback */
1257         if (priv->dp_port_num == serial_priv->ds_oob_port_num) {
1258                 dbg("digi_write_bulk_callback: oob callback");
1259                 spin_lock(&priv->dp_port_lock);
1260                 priv->dp_write_urb_in_use = 0;
1261                 wake_up_interruptible(&port->write_wait);
1262                 spin_unlock(&priv->dp_port_lock);
1263                 return;
1264         }
1265
1266         /* try to send any buffered data on this port */
1267         spin_lock(&priv->dp_port_lock);
1268         priv->dp_write_urb_in_use = 0;
1269         if (priv->dp_out_buf_len > 0) {
1270                 *((unsigned char *)(port->write_urb->transfer_buffer))
1271                         = (unsigned char)DIGI_CMD_SEND_DATA;
1272                 *((unsigned char *)(port->write_urb->transfer_buffer) + 1)
1273                         = (unsigned char)priv->dp_out_buf_len;
1274                 port->write_urb->transfer_buffer_length =
1275                                                 priv->dp_out_buf_len + 2;
1276                 port->write_urb->dev = serial->dev;
1277                 memcpy(port->write_urb->transfer_buffer + 2, priv->dp_out_buf,
1278                         priv->dp_out_buf_len);
1279                 ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1280                 if (ret == 0) {
1281                         priv->dp_write_urb_in_use = 1;
1282                         priv->dp_out_buf_len = 0;
1283                 }
1284         }
1285         /* wake up processes sleeping on writes immediately */
1286         digi_wakeup_write(port);
1287         /* also queue up a wakeup at scheduler time, in case we */
1288         /* lost the race in write_chan(). */
1289         schedule_work(&priv->dp_wakeup_work);
1290
1291         spin_unlock(&priv->dp_port_lock);
1292         if (ret && ret != -EPERM)
1293                 dev_err(&port->dev,
1294                         "%s: usb_submit_urb failed, ret=%d, port=%d\n",
1295                         __func__, ret, priv->dp_port_num);
1296 }
1297
1298 static int digi_write_room(struct tty_struct *tty)
1299 {
1300         struct usb_serial_port *port = tty->driver_data;
1301         struct digi_port *priv = usb_get_serial_port_data(port);
1302         int room;
1303         unsigned long flags = 0;
1304
1305         spin_lock_irqsave(&priv->dp_port_lock, flags);
1306
1307         if (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 tty_struct *tty)
1319 {
1320         struct usb_serial_port *port = tty->driver_data;
1321         struct digi_port *priv = usb_get_serial_port_data(port);
1322
1323         if (priv->dp_write_urb_in_use) {
1324                 dbg("digi_chars_in_buffer: port=%d, chars=%d",
1325                         priv->dp_port_num, port->bulk_out_size - 2);
1326                 /* return(port->bulk_out_size - 2); */
1327                 return 256;
1328         } else {
1329                 dbg("digi_chars_in_buffer: port=%d, chars=%d",
1330                         priv->dp_port_num, priv->dp_out_buf_len);
1331                 return priv->dp_out_buf_len;
1332         }
1333
1334 }
1335
1336 static void digi_dtr_rts(struct usb_serial_port *port, int on)
1337 {
1338         /* Adjust DTR and RTS */
1339         digi_set_modem_signals(port, on * (TIOCM_DTR|TIOCM_RTS), 1);
1340 }
1341
1342 static int digi_carrier_raised(struct usb_serial_port *port)
1343 {
1344         struct digi_port *priv = usb_get_serial_port_data(port);
1345         if (priv->dp_modem_signals & TIOCM_CD)
1346                 return 1;
1347         return 0;
1348 }
1349
1350 static int digi_open(struct tty_struct *tty, struct usb_serial_port *port)
1351 {
1352         int ret;
1353         unsigned char buf[32];
1354         struct digi_port *priv = usb_get_serial_port_data(port);
1355         struct ktermios not_termios;
1356
1357         dbg("digi_open: TOP: port=%d", priv->dp_port_num);
1358
1359         /* be sure the device is started up */
1360         if (digi_startup_device(port->serial) != 0)
1361                 return -ENXIO;
1362
1363         /* read modem signals automatically whenever they change */
1364         buf[0] = DIGI_CMD_READ_INPUT_SIGNALS;
1365         buf[1] = priv->dp_port_num;
1366         buf[2] = DIGI_ENABLE;
1367         buf[3] = 0;
1368
1369         /* flush fifos */
1370         buf[4] = DIGI_CMD_IFLUSH_FIFO;
1371         buf[5] = priv->dp_port_num;
1372         buf[6] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1373         buf[7] = 0;
1374
1375         ret = digi_write_oob_command(port, buf, 8, 1);
1376         if (ret != 0)
1377                 dbg("digi_open: write oob failed, ret=%d", ret);
1378
1379         /* set termios settings */
1380         if (tty) {
1381                 not_termios.c_cflag = ~tty->termios->c_cflag;
1382                 not_termios.c_iflag = ~tty->termios->c_iflag;
1383                 digi_set_termios(tty, port, &not_termios);
1384         }
1385         return 0;
1386 }
1387
1388
1389 static void digi_close(struct usb_serial_port *port)
1390 {
1391         DEFINE_WAIT(wait);
1392         int ret;
1393         unsigned char buf[32];
1394         struct digi_port *priv = usb_get_serial_port_data(port);
1395
1396         dbg("digi_close: TOP: port=%d", priv->dp_port_num);
1397
1398         mutex_lock(&port->serial->disc_mutex);
1399         /* if disconnected, just clear flags */
1400         if (port->serial->disconnected)
1401                 goto exit;
1402
1403         if (port->serial->dev) {
1404                 /* FIXME: Transmit idle belongs in the wait_unti_sent path */
1405                 digi_transmit_idle(port, DIGI_CLOSE_TIMEOUT);
1406
1407                 /* disable input flow control */
1408                 buf[0] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1409                 buf[1] = priv->dp_port_num;
1410                 buf[2] = DIGI_DISABLE;
1411                 buf[3] = 0;
1412
1413                 /* disable output flow control */
1414                 buf[4] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1415                 buf[5] = priv->dp_port_num;
1416                 buf[6] = DIGI_DISABLE;
1417                 buf[7] = 0;
1418
1419                 /* disable reading modem signals automatically */
1420                 buf[8] = DIGI_CMD_READ_INPUT_SIGNALS;
1421                 buf[9] = priv->dp_port_num;
1422                 buf[10] = DIGI_DISABLE;
1423                 buf[11] = 0;
1424
1425                 /* disable receive */
1426                 buf[12] = DIGI_CMD_RECEIVE_ENABLE;
1427                 buf[13] = priv->dp_port_num;
1428                 buf[14] = DIGI_DISABLE;
1429                 buf[15] = 0;
1430
1431                 /* flush fifos */
1432                 buf[16] = DIGI_CMD_IFLUSH_FIFO;
1433                 buf[17] = priv->dp_port_num;
1434                 buf[18] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1435                 buf[19] = 0;
1436
1437                 ret = digi_write_oob_command(port, buf, 20, 0);
1438                 if (ret != 0)
1439                         dbg("digi_close: write oob failed, ret=%d", ret);
1440
1441                 /* wait for final commands on oob port to complete */
1442                 prepare_to_wait(&priv->dp_flush_wait, &wait,
1443                                                         TASK_INTERRUPTIBLE);
1444                 schedule_timeout(DIGI_CLOSE_TIMEOUT);
1445                 finish_wait(&priv->dp_flush_wait, &wait);
1446
1447                 /* shutdown any outstanding bulk writes */
1448                 usb_kill_urb(port->write_urb);
1449         }
1450 exit:
1451         spin_lock_irq(&priv->dp_port_lock);
1452         priv->dp_write_urb_in_use = 0;
1453         wake_up_interruptible(&priv->dp_close_wait);
1454         spin_unlock_irq(&priv->dp_port_lock);
1455         mutex_unlock(&port->serial->disc_mutex);
1456         dbg("digi_close: done");
1457 }
1458
1459
1460 /*
1461  *  Digi Startup Device
1462  *
1463  *  Starts reads on all ports.  Must be called AFTER startup, with
1464  *  urbs initialized.  Returns 0 if successful, non-zero error otherwise.
1465  */
1466
1467 static int digi_startup_device(struct usb_serial *serial)
1468 {
1469         int i, ret = 0;
1470         struct digi_serial *serial_priv = usb_get_serial_data(serial);
1471         struct usb_serial_port *port;
1472
1473         /* be sure this happens exactly once */
1474         spin_lock(&serial_priv->ds_serial_lock);
1475         if (serial_priv->ds_device_started) {
1476                 spin_unlock(&serial_priv->ds_serial_lock);
1477                 return 0;
1478         }
1479         serial_priv->ds_device_started = 1;
1480         spin_unlock(&serial_priv->ds_serial_lock);
1481
1482         /* start reading from each bulk in endpoint for the device */
1483         /* set USB_DISABLE_SPD flag for write bulk urbs */
1484         for (i = 0; i < serial->type->num_ports + 1; i++) {
1485                 port = serial->port[i];
1486                 port->write_urb->dev = port->serial->dev;
1487                 ret = usb_submit_urb(port->read_urb, GFP_KERNEL);
1488                 if (ret != 0) {
1489                         dev_err(&port->dev,
1490                                 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
1491                                 __func__, ret, i);
1492                         break;
1493                 }
1494         }
1495         return ret;
1496 }
1497
1498
1499 static int digi_startup(struct usb_serial *serial)
1500 {
1501
1502         int i;
1503         struct digi_port *priv;
1504         struct digi_serial *serial_priv;
1505
1506         dbg("digi_startup: TOP");
1507
1508         /* allocate the private data structures for all ports */
1509         /* number of regular ports + 1 for the out-of-band port */
1510         for (i = 0; i < serial->type->num_ports + 1; i++) {
1511                 /* allocate port private structure */
1512                 priv = kmalloc(sizeof(struct digi_port), GFP_KERNEL);
1513                 if (priv == NULL) {
1514                         while (--i >= 0)
1515                                 kfree(usb_get_serial_port_data(serial->port[i]));
1516                         return 1;                       /* error */
1517                 }
1518
1519                 /* initialize port private structure */
1520                 spin_lock_init(&priv->dp_port_lock);
1521                 priv->dp_port_num = i;
1522                 priv->dp_out_buf_len = 0;
1523                 priv->dp_write_urb_in_use = 0;
1524                 priv->dp_modem_signals = 0;
1525                 init_waitqueue_head(&priv->dp_modem_change_wait);
1526                 priv->dp_transmit_idle = 0;
1527                 init_waitqueue_head(&priv->dp_transmit_idle_wait);
1528                 priv->dp_throttled = 0;
1529                 priv->dp_throttle_restart = 0;
1530                 init_waitqueue_head(&priv->dp_flush_wait);
1531                 init_waitqueue_head(&priv->dp_close_wait);
1532                 INIT_WORK(&priv->dp_wakeup_work, digi_wakeup_write_lock);
1533                 priv->dp_port = serial->port[i];
1534                 /* initialize write wait queue for this port */
1535                 init_waitqueue_head(&serial->port[i]->write_wait);
1536
1537                 usb_set_serial_port_data(serial->port[i], priv);
1538         }
1539
1540         /* allocate serial private structure */
1541         serial_priv = kmalloc(sizeof(struct digi_serial), GFP_KERNEL);
1542         if (serial_priv == NULL) {
1543                 for (i = 0; i < serial->type->num_ports + 1; i++)
1544                         kfree(usb_get_serial_port_data(serial->port[i]));
1545                 return 1;                       /* error */
1546         }
1547
1548         /* initialize serial private structure */
1549         spin_lock_init(&serial_priv->ds_serial_lock);
1550         serial_priv->ds_oob_port_num = serial->type->num_ports;
1551         serial_priv->ds_oob_port = serial->port[serial_priv->ds_oob_port_num];
1552         serial_priv->ds_device_started = 0;
1553         usb_set_serial_data(serial, serial_priv);
1554
1555         return 0;
1556 }
1557
1558
1559 static void digi_disconnect(struct usb_serial *serial)
1560 {
1561         int i;
1562         dbg("digi_disconnect: TOP, in_interrupt()=%ld", in_interrupt());
1563
1564         /* stop reads and writes on all ports */
1565         for (i = 0; i < serial->type->num_ports + 1; i++) {
1566                 usb_kill_urb(serial->port[i]->read_urb);
1567                 usb_kill_urb(serial->port[i]->write_urb);
1568         }
1569 }
1570
1571
1572 static void digi_release(struct usb_serial *serial)
1573 {
1574         int i;
1575         dbg("digi_release: TOP, in_interrupt()=%ld", in_interrupt());
1576
1577         /* free the private data structures for all ports */
1578         /* number of regular ports + 1 for the out-of-band port */
1579         for (i = 0; i < serial->type->num_ports + 1; i++)
1580                 kfree(usb_get_serial_port_data(serial->port[i]));
1581         kfree(usb_get_serial_data(serial));
1582 }
1583
1584
1585 static void digi_read_bulk_callback(struct urb *urb)
1586 {
1587         struct usb_serial_port *port = urb->context;
1588         struct digi_port *priv;
1589         struct digi_serial *serial_priv;
1590         int ret;
1591         int status = urb->status;
1592
1593         dbg("digi_read_bulk_callback: TOP");
1594
1595         /* port sanity check, do not resubmit if port is not valid */
1596         if (port == NULL)
1597                 return;
1598         priv = usb_get_serial_port_data(port);
1599         if (priv == NULL) {
1600                 dev_err(&port->dev, "%s: port->private is NULL, status=%d\n",
1601                         __func__, status);
1602                 return;
1603         }
1604         if (port->serial == NULL ||
1605                 (serial_priv = usb_get_serial_data(port->serial)) == NULL) {
1606                 dev_err(&port->dev, "%s: serial is bad or serial->private "
1607                         "is NULL, status=%d\n", __func__, status);
1608                 return;
1609         }
1610
1611         /* do not resubmit urb if it has any status error */
1612         if (status) {
1613                 dev_err(&port->dev,
1614                         "%s: nonzero read bulk status: status=%d, port=%d\n",
1615                         __func__, status, priv->dp_port_num);
1616                 return;
1617         }
1618
1619         /* handle oob or inb callback, do not resubmit if error */
1620         if (priv->dp_port_num == serial_priv->ds_oob_port_num) {
1621                 if (digi_read_oob_callback(urb) != 0)
1622                         return;
1623         } else {
1624                 if (digi_read_inb_callback(urb) != 0)
1625                         return;
1626         }
1627
1628         /* continue read */
1629         urb->dev = port->serial->dev;
1630         ret = usb_submit_urb(urb, GFP_ATOMIC);
1631         if (ret != 0 && ret != -EPERM) {
1632                 dev_err(&port->dev,
1633                         "%s: failed resubmitting urb, ret=%d, port=%d\n",
1634                         __func__, ret, priv->dp_port_num);
1635         }
1636
1637 }
1638
1639 /*
1640  *  Digi Read INB Callback
1641  *
1642  *  Digi Read INB Callback handles reads on the in band ports, sending
1643  *  the data on to the tty subsystem.  When called we know port and
1644  *  port->private are not NULL and port->serial has been validated.
1645  *  It returns 0 if successful, 1 if successful but the port is
1646  *  throttled, and -1 if the sanity checks failed.
1647  */
1648
1649 static int digi_read_inb_callback(struct urb *urb)
1650 {
1651
1652         struct usb_serial_port *port = urb->context;
1653         struct tty_struct *tty;
1654         struct digi_port *priv = usb_get_serial_port_data(port);
1655         int opcode = ((unsigned char *)urb->transfer_buffer)[0];
1656         int len = ((unsigned char *)urb->transfer_buffer)[1];
1657         int port_status = ((unsigned char *)urb->transfer_buffer)[2];
1658         unsigned char *data = ((unsigned char *)urb->transfer_buffer) + 3;
1659         int flag, throttled;
1660         int status = urb->status;
1661
1662         /* do not process callbacks on closed ports */
1663         /* but do continue the read chain */
1664         if (urb->status == -ENOENT)
1665                 return 0;
1666
1667         /* short/multiple packet check */
1668         if (urb->actual_length != len + 2) {
1669                 dev_err(&port->dev, "%s: INCOMPLETE OR MULTIPLE PACKET, "
1670                         "status=%d, port=%d, opcode=%d, len=%d, "
1671                         "actual_length=%d, status=%d\n", __func__, status,
1672                         priv->dp_port_num, opcode, len, urb->actual_length,
1673                         port_status);
1674                 return -1;
1675         }
1676
1677         tty = tty_port_tty_get(&port->port);
1678         spin_lock(&priv->dp_port_lock);
1679
1680         /* check for throttle; if set, do not resubmit read urb */
1681         /* indicate the read chain needs to be restarted on unthrottle */
1682         throttled = priv->dp_throttled;
1683         if (throttled)
1684                 priv->dp_throttle_restart = 1;
1685
1686         /* receive data */
1687         if (tty && opcode == DIGI_CMD_RECEIVE_DATA) {
1688                 /* get flag from port_status */
1689                 flag = 0;
1690
1691                 /* overrun is special, not associated with a char */
1692                 if (port_status & DIGI_OVERRUN_ERROR)
1693                         tty_insert_flip_char(tty, 0, TTY_OVERRUN);
1694
1695                 /* break takes precedence over parity, */
1696                 /* which takes precedence over framing errors */
1697                 if (port_status & DIGI_BREAK_ERROR)
1698                         flag = TTY_BREAK;
1699                 else if (port_status & DIGI_PARITY_ERROR)
1700                         flag = TTY_PARITY;
1701                 else if (port_status & DIGI_FRAMING_ERROR)
1702                         flag = TTY_FRAME;
1703
1704                 /* data length is len-1 (one byte of len is port_status) */
1705                 --len;
1706                 if (len > 0) {
1707                         tty_insert_flip_string_fixed_flag(tty, data, flag,
1708                                                                         len);
1709                         tty_flip_buffer_push(tty);
1710                 }
1711         }
1712         spin_unlock(&priv->dp_port_lock);
1713         tty_kref_put(tty);
1714
1715         if (opcode == DIGI_CMD_RECEIVE_DISABLE)
1716                 dbg("%s: got RECEIVE_DISABLE", __func__);
1717         else if (opcode != DIGI_CMD_RECEIVE_DATA)
1718                 dbg("%s: unknown opcode: %d", __func__, opcode);
1719
1720         return throttled ? 1 : 0;
1721
1722 }
1723
1724
1725 /*
1726  *  Digi Read OOB Callback
1727  *
1728  *  Digi Read OOB Callback handles reads on the out of band port.
1729  *  When called we know port and port->private are not NULL and
1730  *  the port->serial is valid.  It returns 0 if successful, and
1731  *  -1 if the sanity checks failed.
1732  */
1733
1734 static int digi_read_oob_callback(struct urb *urb)
1735 {
1736
1737         struct usb_serial_port *port = urb->context;
1738         struct usb_serial *serial = port->serial;
1739         struct tty_struct *tty;
1740         struct digi_port *priv = usb_get_serial_port_data(port);
1741         int opcode, line, status, val;
1742         int i;
1743         unsigned int rts;
1744
1745         dbg("digi_read_oob_callback: port=%d, len=%d",
1746                         priv->dp_port_num, urb->actual_length);
1747
1748         /* handle each oob command */
1749         for (i = 0; i < urb->actual_length - 3;) {
1750                 opcode = ((unsigned char *)urb->transfer_buffer)[i++];
1751                 line = ((unsigned char *)urb->transfer_buffer)[i++];
1752                 status = ((unsigned char *)urb->transfer_buffer)[i++];
1753                 val = ((unsigned char *)urb->transfer_buffer)[i++];
1754
1755                 dbg("digi_read_oob_callback: opcode=%d, line=%d, status=%d, val=%d",
1756                         opcode, line, status, val);
1757
1758                 if (status != 0 || line >= serial->type->num_ports)
1759                         continue;
1760
1761                 port = serial->port[line];
1762
1763                 priv = usb_get_serial_port_data(port);
1764                 if (priv == NULL)
1765                         return -1;
1766
1767                 tty = tty_port_tty_get(&port->port);
1768
1769                 rts = 0;
1770                 if (tty)
1771                         rts = tty->termios->c_cflag & CRTSCTS;
1772
1773                 if (tty && opcode == DIGI_CMD_READ_INPUT_SIGNALS) {
1774                         spin_lock(&priv->dp_port_lock);
1775                         /* convert from digi flags to termiox flags */
1776                         if (val & DIGI_READ_INPUT_SIGNALS_CTS) {
1777                                 priv->dp_modem_signals |= TIOCM_CTS;
1778                                 /* port must be open to use tty struct */
1779                                 if (rts) {
1780                                         tty->hw_stopped = 0;
1781                                         digi_wakeup_write(port);
1782                                 }
1783                         } else {
1784                                 priv->dp_modem_signals &= ~TIOCM_CTS;
1785                                 /* port must be open to use tty struct */
1786                                 if (rts)
1787                                         tty->hw_stopped = 1;
1788                         }
1789                         if (val & DIGI_READ_INPUT_SIGNALS_DSR)
1790                                 priv->dp_modem_signals |= TIOCM_DSR;
1791                         else
1792                                 priv->dp_modem_signals &= ~TIOCM_DSR;
1793                         if (val & DIGI_READ_INPUT_SIGNALS_RI)
1794                                 priv->dp_modem_signals |= TIOCM_RI;
1795                         else
1796                                 priv->dp_modem_signals &= ~TIOCM_RI;
1797                         if (val & DIGI_READ_INPUT_SIGNALS_DCD)
1798                                 priv->dp_modem_signals |= TIOCM_CD;
1799                         else
1800                                 priv->dp_modem_signals &= ~TIOCM_CD;
1801
1802                         wake_up_interruptible(&priv->dp_modem_change_wait);
1803                         spin_unlock(&priv->dp_port_lock);
1804                 } else if (opcode == DIGI_CMD_TRANSMIT_IDLE) {
1805                         spin_lock(&priv->dp_port_lock);
1806                         priv->dp_transmit_idle = 1;
1807                         wake_up_interruptible(&priv->dp_transmit_idle_wait);
1808                         spin_unlock(&priv->dp_port_lock);
1809                 } else if (opcode == DIGI_CMD_IFLUSH_FIFO) {
1810                         wake_up_interruptible(&priv->dp_flush_wait);
1811                 }
1812                 tty_kref_put(tty);
1813         }
1814         return 0;
1815
1816 }
1817
1818 static int __init digi_init(void)
1819 {
1820         int retval;
1821         retval = usb_serial_register(&digi_acceleport_2_device);
1822         if (retval)
1823                 goto failed_acceleport_2_device;
1824         retval = usb_serial_register(&digi_acceleport_4_device);
1825         if (retval)
1826                 goto failed_acceleport_4_device;
1827         retval = usb_register(&digi_driver);
1828         if (retval)
1829                 goto failed_usb_register;
1830         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1831                DRIVER_DESC "\n");
1832         return 0;
1833 failed_usb_register:
1834         usb_serial_deregister(&digi_acceleport_4_device);
1835 failed_acceleport_4_device:
1836         usb_serial_deregister(&digi_acceleport_2_device);
1837 failed_acceleport_2_device:
1838         return retval;
1839 }
1840
1841 static void __exit digi_exit (void)
1842 {
1843         usb_deregister(&digi_driver);
1844         usb_serial_deregister(&digi_acceleport_2_device);
1845         usb_serial_deregister(&digi_acceleport_4_device);
1846 }
1847
1848
1849 module_init(digi_init);
1850 module_exit(digi_exit);
1851
1852
1853 MODULE_AUTHOR(DRIVER_AUTHOR);
1854 MODULE_DESCRIPTION(DRIVER_DESC);
1855 MODULE_LICENSE("GPL");
1856
1857 module_param(debug, bool, S_IRUGO | S_IWUSR);
1858 MODULE_PARM_DESC(debug, "Debug enabled or not");