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