drivers/usb/serial/digi_acceleport.c

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