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