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         if( (tty->flags & (1 << TTY_DO_WRITE_WAKEUP))
 628         && tty->ldisc.write_wakeup )
 629                 (tty->ldisc.write_wakeup)(tty);
 630
 631         /* wake up other tty processes */
 632         wake_up_interruptible( &tty->write_wait );
 633         /* For 2.2.16 backport -- wake_up_interruptible( &tty->poll_wait ); */
 634
 635 }
 636
 637
 638 /*
 639 *  Digi Write OOB Command
 640 *
 641 *  Write commands on the out of band port.  Commands are 4
 642 *  bytes each, multiple commands can be sent at once, and
 643 *  no command will be split across USB packets.  Returns 0
 644 *  if successful, -EINTR if interrupted while sleeping and
 645 *  the interruptible flag is true, or a negative error
 646 *  returned by usb_submit_urb.
 647 */
 648
 649 static int digi_write_oob_command( struct usb_serial_port *port,
 650         unsigned char *buf, int count, int interruptible )
 651 {
 652
 653         int ret = 0;
 654         int len;
 655         struct usb_serial_port *oob_port = (struct usb_serial_port *)((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
 656         struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
 657         unsigned long flags = 0;
 658
 659
 660 dbg( "digi_write_oob_command: TOP: port=%d, count=%d", oob_priv->dp_port_num, count );
 661
 662         spin_lock_irqsave( &oob_priv->dp_port_lock, flags );
 663
 664         while( count > 0 ) {
 665
 666                 while( oob_port->write_urb->status == -EINPROGRESS
 667                 || oob_priv->dp_write_urb_in_use ) {
 668                         cond_wait_interruptible_timeout_irqrestore(
 669                                 &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
 670                                 &oob_priv->dp_port_lock, flags );
 671                         if( interruptible && signal_pending(current) ) {
 672                                 return( -EINTR );
 673                         }
 674                         spin_lock_irqsave( &oob_priv->dp_port_lock, flags );
 675                 }
 676
 677                 /* len must be a multiple of 4, so commands are not split */
 678                 len = min(count, oob_port->bulk_out_size );
 679                 if( len > 4 )
 680                         len &= ~3;
 681
 682                 memcpy( oob_port->write_urb->transfer_buffer, buf, len );
 683                 oob_port->write_urb->transfer_buffer_length = len;
 684                 oob_port->write_urb->dev = port->serial->dev;
 685
 686                 if( (ret=usb_submit_urb(oob_port->write_urb, GFP_ATOMIC)) == 0 ) {
 687                         oob_priv->dp_write_urb_in_use = 1;
 688                         count -= len;
 689                         buf += len;
 690                 }
 691
 692         }
 693
 694         spin_unlock_irqrestore( &oob_priv->dp_port_lock, flags );
 695
 696         if( ret ) {
 697                 err("%s: usb_submit_urb failed, ret=%d", __FUNCTION__,
 698                         ret );
 699         }
 700
 701         return( ret );
 702
 703 }
 704
 705
 706 /*
 707 *  Digi Write In Band Command
 708 *
 709 *  Write commands on the given port.  Commands are 4
 710 *  bytes each, multiple commands can be sent at once, and
 711 *  no command will be split across USB packets.  If timeout
 712 *  is non-zero, write in band command will return after
 713 *  waiting unsuccessfully for the URB status to clear for
 714 *  timeout ticks.  Returns 0 if successful, or a negative
 715 *  error returned by digi_write.
 716 */
 717
 718 static int digi_write_inb_command( struct usb_serial_port *port,
 719         unsigned char *buf, int count, unsigned long timeout )
 720 {
 721
 722         int ret = 0;
 723         int len;
 724         struct digi_port *priv = usb_get_serial_port_data(port);
 725         unsigned char *data = port->write_urb->transfer_buffer;
 726         unsigned long flags = 0;
 727
 728
 729 dbg( "digi_write_inb_command: TOP: port=%d, count=%d", priv->dp_port_num,
 730 count );
 731
 732         if( timeout )
 733                 timeout += jiffies;
 734         else
 735                 timeout = ULONG_MAX;
 736
 737         spin_lock_irqsave( &priv->dp_port_lock, flags );
 738
 739         while( count > 0 && ret == 0 ) {
 740
 741                 while( (port->write_urb->status == -EINPROGRESS
 742                 || priv->dp_write_urb_in_use) && time_before(jiffies, timeout)) {
 743                         cond_wait_interruptible_timeout_irqrestore(
 744                                 &port->write_wait, DIGI_RETRY_TIMEOUT,
 745                                 &priv->dp_port_lock, flags );
 746                         if( signal_pending(current) ) {
 747                                 return( -EINTR );
 748                         }
 749                         spin_lock_irqsave( &priv->dp_port_lock, flags );
 750                 }
 751
 752                 /* len must be a multiple of 4 and small enough to */
 753                 /* guarantee the write will send buffered data first, */
 754                 /* so commands are in order with data and not split */
 755                 len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len );
 756                 if( len > 4 )
 757                         len &= ~3;
 758
 759                 /* write any buffered data first */
 760                 if( priv->dp_out_buf_len > 0 ) {
 761                         data[0] = DIGI_CMD_SEND_DATA;
 762                         data[1] = priv->dp_out_buf_len;
 763                         memcpy( data+2, priv->dp_out_buf,
 764                                 priv->dp_out_buf_len );
 765                         memcpy( data+2+priv->dp_out_buf_len, buf, len );
 766                         port->write_urb->transfer_buffer_length
 767                                 = priv->dp_out_buf_len+2+len;
 768                 } else {
 769                         memcpy( data, buf, len );
 770                         port->write_urb->transfer_buffer_length = len;
 771                 }
 772                 port->write_urb->dev = port->serial->dev;
 773
 774                 if( (ret=usb_submit_urb(port->write_urb, GFP_ATOMIC)) == 0 ) {
 775                         priv->dp_write_urb_in_use = 1;
 776                         priv->dp_out_buf_len = 0;
 777                         count -= len;
 778                         buf += len;
 779                 }
 780
 781         }
 782
 783         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
 784
 785         if( ret ) {
 786                 err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
 787                 ret, priv->dp_port_num );
 788         }
 789
 790         return( ret );
 791
 792 }
 793
 794
 795 /*
 796 *  Digi Set Modem Signals
 797 *
 798 *  Sets or clears DTR and RTS on the port, according to the
 799 *  modem_signals argument.  Use TIOCM_DTR and TIOCM_RTS flags
 800 *  for the modem_signals argument.  Returns 0 if successful,
 801 *  -EINTR if interrupted while sleeping, or a non-zero error
 802 *  returned by usb_submit_urb.
 803 */
 804
 805 static int digi_set_modem_signals( struct usb_serial_port *port,
 806         unsigned int modem_signals, int interruptible )
 807 {
 808
 809         int ret;
 810         struct digi_port *port_priv = usb_get_serial_port_data(port);
 811         struct usb_serial_port *oob_port = (struct usb_serial_port *)((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
 812         struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
 813         unsigned char *data = oob_port->write_urb->transfer_buffer;
 814         unsigned long flags = 0;
 815
 816
 817 dbg( "digi_set_modem_signals: TOP: port=%d, modem_signals=0x%x",
 818 port_priv->dp_port_num, modem_signals );
 819
 820         spin_lock_irqsave( &oob_priv->dp_port_lock, flags );
 821         spin_lock( &port_priv->dp_port_lock );
 822
 823         while( oob_port->write_urb->status == -EINPROGRESS
 824         || oob_priv->dp_write_urb_in_use ) {
 825                 spin_unlock( &port_priv->dp_port_lock );
 826                 cond_wait_interruptible_timeout_irqrestore(
 827                         &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
 828                         &oob_priv->dp_port_lock, flags );
 829                 if( interruptible && signal_pending(current) ) {
 830                         return( -EINTR );
 831                 }
 832                 spin_lock_irqsave( &oob_priv->dp_port_lock, flags );
 833                 spin_lock( &port_priv->dp_port_lock );
 834         }
 835
 836         data[0] = DIGI_CMD_SET_DTR_SIGNAL;
 837         data[1] = port_priv->dp_port_num;
 838         data[2] = (modem_signals&TIOCM_DTR) ?
 839                 DIGI_DTR_ACTIVE : DIGI_DTR_INACTIVE;
 840         data[3] = 0;
 841
 842         data[4] = DIGI_CMD_SET_RTS_SIGNAL;
 843         data[5] = port_priv->dp_port_num;
 844         data[6] = (modem_signals&TIOCM_RTS) ?
 845                 DIGI_RTS_ACTIVE : DIGI_RTS_INACTIVE;
 846         data[7] = 0;
 847
 848         oob_port->write_urb->transfer_buffer_length = 8;
 849         oob_port->write_urb->dev = port->serial->dev;
 850
 851         if( (ret=usb_submit_urb(oob_port->write_urb, GFP_ATOMIC)) == 0 ) {
 852                 oob_priv->dp_write_urb_in_use = 1;
 853                 port_priv->dp_modem_signals =
 854                         (port_priv->dp_modem_signals&~(TIOCM_DTR|TIOCM_RTS))
 855                         | (modem_signals&(TIOCM_DTR|TIOCM_RTS));
 856         }
 857
 858         spin_unlock( &port_priv->dp_port_lock );
 859         spin_unlock_irqrestore( &oob_priv->dp_port_lock, flags );
 860
 861         if( ret ) {
 862                 err("%s: usb_submit_urb failed, ret=%d", __FUNCTION__,
 863                 ret );
 864         }
 865
 866         return( ret );
 867
 868 }
 869
 870
 871 /*
 872 *  Digi Transmit Idle
 873 *
 874 *  Digi transmit idle waits, up to timeout ticks, for the transmitter
 875 *  to go idle.  It returns 0 if successful or a negative error.
 876 *
 877 *  There are race conditions here if more than one process is calling
 878 *  digi_transmit_idle on the same port at the same time.  However, this
 879 *  is only called from close, and only one process can be in close on a
 880 *  port at a time, so its ok.
 881 */
 882
 883 static int digi_transmit_idle( struct usb_serial_port *port,
 884         unsigned long timeout )
 885 {
 886
 887         int ret;
 888         unsigned char buf[2];
 889         struct digi_port *priv = usb_get_serial_port_data(port);
 890         unsigned long flags = 0;
 891
 892
 893         spin_lock_irqsave( &priv->dp_port_lock, flags );
 894         priv->dp_transmit_idle = 0;
 895         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
 896
 897         buf[0] = DIGI_CMD_TRANSMIT_IDLE;
 898         buf[1] = 0;
 899
 900         timeout += jiffies;
 901
 902         if( (ret=digi_write_inb_command( port, buf, 2, timeout-jiffies )) != 0 )
 903                 return( ret );
 904
 905         spin_lock_irqsave( &priv->dp_port_lock, flags );
 906
 907         while( time_before(jiffies, timeout) && !priv->dp_transmit_idle ) {
 908                 cond_wait_interruptible_timeout_irqrestore(
 909                         &priv->dp_transmit_idle_wait, DIGI_RETRY_TIMEOUT,
 910                         &priv->dp_port_lock, flags );
 911                 if( signal_pending(current) ) {
 912                         return( -EINTR );
 913                 }
 914                 spin_lock_irqsave( &priv->dp_port_lock, flags );
 915         }
 916
 917         priv->dp_transmit_idle = 0;
 918         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
 919
 920         return( 0 );
 921
 922 }
 923
 924
 925 static void digi_rx_throttle( struct usb_serial_port *port )
 926 {
 927
 928         unsigned long flags;
 929         struct digi_port *priv = usb_get_serial_port_data(port);
 930
 931
 932 dbg( "digi_rx_throttle: TOP: port=%d", priv->dp_port_num );
 933
 934         /* stop receiving characters by not resubmitting the read urb */
 935         spin_lock_irqsave( &priv->dp_port_lock, flags );
 936         priv->dp_throttled = 1;
 937         priv->dp_throttle_restart = 0;
 938         priv->dp_in_buf_len = 0;
 939         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
 940
 941 }
 942
 943
 944 static void digi_rx_unthrottle( struct usb_serial_port *port )
 945 {
 946
 947         int ret = 0;
 948         int len;
 949         unsigned long flags;
 950         struct digi_port *priv = usb_get_serial_port_data(port);
 951         struct tty_struct *tty = port->tty;
 952
 953
 954 dbg( "digi_rx_unthrottle: TOP: port=%d", priv->dp_port_num );
 955
 956         spin_lock_irqsave( &priv->dp_port_lock, flags );
 957
 958         /* send any buffered chars from throttle time on to tty subsystem */
 959         len = min(priv->dp_in_buf_len, TTY_FLIPBUF_SIZE - tty->flip.count );
 960         if( len > 0 ) {
 961                 memcpy( tty->flip.char_buf_ptr, priv->dp_in_buf, len );
 962                 memcpy( tty->flip.flag_buf_ptr, priv->dp_in_flag_buf, len );
 963                 tty->flip.char_buf_ptr += len;
 964                 tty->flip.flag_buf_ptr += len;
 965                 tty->flip.count += len;
 966                 tty_flip_buffer_push( tty );
 967         }
 968
 969         /* restart read chain */
 970         if( priv->dp_throttle_restart ) {
 971                 port->read_urb->dev = port->serial->dev;
 972                 ret = usb_submit_urb( port->read_urb, GFP_ATOMIC );
 973         }
 974
 975         /* turn throttle off */
 976         priv->dp_throttled = 0;
 977         priv->dp_in_buf_len = 0;
 978         priv->dp_throttle_restart = 0;
 979
 980         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
 981
 982         if( ret ) {
 983                 err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
 984                         ret, priv->dp_port_num );
 985         }
 986
 987 }
 988
 989
 990 static void digi_set_termios( struct usb_serial_port *port,
 991         struct termios *old_termios )
 992 {
 993
 994         struct digi_port *priv = usb_get_serial_port_data(port);
 995         unsigned int iflag = port->tty->termios->c_iflag;
 996         unsigned int cflag = port->tty->termios->c_cflag;
 997         unsigned int old_iflag = old_termios->c_iflag;
 998         unsigned int old_cflag = old_termios->c_cflag;
 999         unsigned char buf[32];
1000         unsigned int modem_signals;
1001         int arg,ret;
1002         int i = 0;
1003
1004
1005 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 );
1006
1007         /* set baud rate */
1008         if( (cflag&CBAUD) != (old_cflag&CBAUD) ) {
1009
1010                 arg = -1;
1011
1012                 /* reassert DTR and (maybe) RTS on transition from B0 */
1013                 if( (old_cflag&CBAUD) == B0 ) {
1014                         /* don't set RTS if using hardware flow control */
1015                         /* and throttling input */
1016                         modem_signals = TIOCM_DTR;
1017                         if( !(port->tty->termios->c_cflag & CRTSCTS) ||
1018                         !test_bit(TTY_THROTTLED, &port->tty->flags) ) {
1019                                 modem_signals |= TIOCM_RTS;
1020                         }
1021                         digi_set_modem_signals( port, modem_signals, 1 );
1022                 }
1023
1024                 switch( (cflag&CBAUD) ) {
1025                         /* drop DTR and RTS on transition to B0 */
1026                 case B0: digi_set_modem_signals( port, 0, 1 ); break;
1027                 case B50: arg = DIGI_BAUD_50; break;
1028                 case B75: arg = DIGI_BAUD_75; break;
1029                 case B110: arg = DIGI_BAUD_110; break;
1030                 case B150: arg = DIGI_BAUD_150; break;
1031                 case B200: arg = DIGI_BAUD_200; break;
1032                 case B300: arg = DIGI_BAUD_300; break;
1033                 case B600: arg = DIGI_BAUD_600; break;
1034                 case B1200: arg = DIGI_BAUD_1200; break;
1035                 case B1800: arg = DIGI_BAUD_1800; break;
1036                 case B2400: arg = DIGI_BAUD_2400; break;
1037                 case B4800: arg = DIGI_BAUD_4800; break;
1038                 case B9600: arg = DIGI_BAUD_9600; break;
1039                 case B19200: arg = DIGI_BAUD_19200; break;
1040                 case B38400: arg = DIGI_BAUD_38400; break;
1041                 case B57600: arg = DIGI_BAUD_57600; break;
1042                 case B115200: arg = DIGI_BAUD_115200; break;
1043                 case B230400: arg = DIGI_BAUD_230400; break;
1044                 case B460800: arg = DIGI_BAUD_460800; break;
1045                 default:
1046                         dbg( "digi_set_termios: can't handle baud rate 0x%x",
1047                                 (cflag&CBAUD) );
1048                         break;
1049                 }
1050
1051                 if( arg != -1 ) {
1052                         buf[i++] = DIGI_CMD_SET_BAUD_RATE;
1053                         buf[i++] = priv->dp_port_num;
1054                         buf[i++] = arg;
1055                         buf[i++] = 0;
1056                 }
1057
1058         }
1059
1060         /* set parity */
1061         if( (cflag&(PARENB|PARODD)) != (old_cflag&(PARENB|PARODD)) ) {
1062
1063                 if( (cflag&PARENB) ) {
1064                         if( (cflag&PARODD) )
1065                                 arg = DIGI_PARITY_ODD;
1066                         else
1067                                 arg = DIGI_PARITY_EVEN;
1068                 } else {
1069                         arg = DIGI_PARITY_NONE;
1070                 }
1071
1072                 buf[i++] = DIGI_CMD_SET_PARITY;
1073                 buf[i++] = priv->dp_port_num;
1074                 buf[i++] = arg;
1075                 buf[i++] = 0;
1076
1077         }
1078
1079         /* set word size */
1080         if( (cflag&CSIZE) != (old_cflag&CSIZE) ) {
1081
1082                 arg = -1;
1083
1084                 switch( (cflag&CSIZE) ) {
1085                 case CS5: arg = DIGI_WORD_SIZE_5; break;
1086                 case CS6: arg = DIGI_WORD_SIZE_6; break;
1087                 case CS7: arg = DIGI_WORD_SIZE_7; break;
1088                 case CS8: arg = DIGI_WORD_SIZE_8; break;
1089                 default:
1090                         dbg( "digi_set_termios: can't handle word size %d",
1091                                 (cflag&CSIZE) );
1092                         break;
1093                 }
1094
1095                 if( arg != -1 ) {
1096                         buf[i++] = DIGI_CMD_SET_WORD_SIZE;
1097                         buf[i++] = priv->dp_port_num;
1098                         buf[i++] = arg;
1099                         buf[i++] = 0;
1100                 }
1101
1102         }
1103
1104         /* set stop bits */
1105         if( (cflag&CSTOPB) != (old_cflag&CSTOPB) ) {
1106
1107                 if( (cflag&CSTOPB) )
1108                         arg = DIGI_STOP_BITS_2;
1109                 else
1110                         arg = DIGI_STOP_BITS_1;
1111
1112                 buf[i++] = DIGI_CMD_SET_STOP_BITS;
1113                 buf[i++] = priv->dp_port_num;
1114                 buf[i++] = arg;
1115                 buf[i++] = 0;
1116
1117         }
1118
1119         /* set input flow control */
1120         if( (iflag&IXOFF) != (old_iflag&IXOFF)
1121         || (cflag&CRTSCTS) != (old_cflag&CRTSCTS) ) {
1122
1123                 arg = 0;
1124
1125                 if( (iflag&IXOFF) )
1126                         arg |= DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
1127                 else
1128                         arg &= ~DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
1129
1130                 if( (cflag&CRTSCTS) ) {
1131
1132                         arg |= DIGI_INPUT_FLOW_CONTROL_RTS;
1133
1134                         /* On USB-4 it is necessary to assert RTS prior */
1135                         /* to selecting RTS input flow control.  */
1136                         buf[i++] = DIGI_CMD_SET_RTS_SIGNAL;
1137                         buf[i++] = priv->dp_port_num;
1138                         buf[i++] = DIGI_RTS_ACTIVE;
1139                         buf[i++] = 0;
1140
1141                 } else {
1142                         arg &= ~DIGI_INPUT_FLOW_CONTROL_RTS;
1143                 }
1144
1145                 buf[i++] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1146                 buf[i++] = priv->dp_port_num;
1147                 buf[i++] = arg;
1148                 buf[i++] = 0;
1149
1150         }
1151
1152         /* set output flow control */
1153         if( (iflag&IXON) != (old_iflag&IXON)
1154         || (cflag&CRTSCTS) != (old_cflag&CRTSCTS) ) {
1155
1156                 arg = 0;
1157
1158                 if( (iflag&IXON) )
1159                         arg |= DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
1160                 else
1161                         arg &= ~DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
1162
1163                 if( (cflag&CRTSCTS) ) {
1164                         arg |= DIGI_OUTPUT_FLOW_CONTROL_CTS;
1165                 } else {
1166                         arg &= ~DIGI_OUTPUT_FLOW_CONTROL_CTS;
1167                         port->tty->hw_stopped = 0;
1168                 }
1169
1170                 buf[i++] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1171                 buf[i++] = priv->dp_port_num;
1172                 buf[i++] = arg;
1173                 buf[i++] = 0;
1174
1175         }
1176
1177         /* set receive enable/disable */
1178         if( (cflag&CREAD) != (old_cflag&CREAD) ) {
1179
1180                 if( (cflag&CREAD) )
1181                         arg = DIGI_ENABLE;
1182                 else
1183                         arg = DIGI_DISABLE;
1184
1185                 buf[i++] = DIGI_CMD_RECEIVE_ENABLE;
1186                 buf[i++] = priv->dp_port_num;
1187                 buf[i++] = arg;
1188                 buf[i++] = 0;
1189
1190         }
1191
1192         if( (ret=digi_write_oob_command( port, buf, i, 1 )) != 0 )
1193                 dbg( "digi_set_termios: write oob failed, ret=%d", ret );
1194
1195 }
1196
1197
1198 static void digi_break_ctl( struct usb_serial_port *port, int break_state )
1199 {
1200
1201         unsigned char buf[4];
1202
1203
1204         buf[0] = DIGI_CMD_BREAK_CONTROL;
1205         buf[1] = 2;                             /* length */
1206         buf[2] = break_state ? 1 : 0;
1207         buf[3] = 0;                             /* pad */
1208
1209         digi_write_inb_command( port, buf, 4, 0 );
1210
1211 }
1212
1213
1214 static int digi_tiocmget( struct usb_serial_port *port, struct file *file )
1215 {
1216         struct digi_port *priv = usb_get_serial_port_data(port);
1217         unsigned int val;
1218         unsigned long flags;
1219
1220         dbg("%s: TOP: port=%d", __FUNCTION__, priv->dp_port_num);
1221
1222         spin_lock_irqsave( &priv->dp_port_lock, flags );
1223         val = priv->dp_modem_signals;
1224         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1225         return val;
1226 }
1227
1228
1229 static int digi_tiocmset( struct usb_serial_port *port, struct file *file,
1230         unsigned int set, unsigned int clear )
1231 {
1232         struct digi_port *priv = usb_get_serial_port_data(port);
1233         unsigned int val;
1234         unsigned long flags;
1235
1236         dbg("%s: TOP: port=%d", __FUNCTION__, priv->dp_port_num);
1237
1238         spin_lock_irqsave( &priv->dp_port_lock, flags );
1239         val = (priv->dp_modem_signals & ~clear) | set;
1240         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1241         return digi_set_modem_signals( port, val, 1 );
1242 }
1243
1244
1245 static int digi_ioctl( struct usb_serial_port *port, struct file *file,
1246         unsigned int cmd, unsigned long arg )
1247 {
1248
1249         struct digi_port *priv = usb_get_serial_port_data(port);
1250
1251 dbg( "digi_ioctl: TOP: port=%d, cmd=0x%x", priv->dp_port_num, cmd );
1252
1253         switch (cmd) {
1254
1255         case TIOCMIWAIT:
1256                 /* wait for any of the 4 modem inputs (DCD,RI,DSR,CTS)*/
1257                 /* TODO */
1258                 return( 0 );
1259
1260         case TIOCGICOUNT:
1261                 /* return count of modemline transitions */
1262                 /* TODO */
1263                 return 0;
1264
1265         }
1266
1267         return( -ENOIOCTLCMD );
1268
1269 }
1270
1271
1272 static int digi_write( struct usb_serial_port *port, int from_user,
1273         const unsigned char *buf, int count )
1274 {
1275
1276         int ret,data_len,new_len;
1277         struct digi_port *priv = usb_get_serial_port_data(port);
1278         unsigned char *data = port->write_urb->transfer_buffer;
1279         unsigned char user_buf[64];     /* 64 bytes is max USB bulk packet */
1280         unsigned long flags = 0;
1281
1282
1283 dbg( "digi_write: TOP: port=%d, count=%d, from_user=%d, in_interrupt=%ld",
1284 priv->dp_port_num, count, from_user, in_interrupt() );
1285
1286         /* copy user data (which can sleep) before getting spin lock */
1287         count = min( count, port->bulk_out_size-2 );
1288         count = min( 64, count);
1289         if( from_user && copy_from_user( user_buf, buf, count ) ) {
1290                 return( -EFAULT );
1291         }
1292
1293         /* be sure only one write proceeds at a time */
1294         /* there are races on the port private buffer */
1295         /* and races to check write_urb->status */
1296         spin_lock_irqsave( &priv->dp_port_lock, flags );
1297
1298         /* wait for urb status clear to submit another urb */
1299         if( port->write_urb->status == -EINPROGRESS
1300         || priv->dp_write_urb_in_use ) {
1301
1302                 /* buffer data if count is 1 (probably put_char) if possible */
1303                 if( count == 1 && priv->dp_out_buf_len < DIGI_OUT_BUF_SIZE ) {
1304                         priv->dp_out_buf[priv->dp_out_buf_len++]
1305                                 = *(from_user ? user_buf : buf);
1306                         new_len = 1;
1307                 } else {
1308                         new_len = 0;
1309                 }
1310
1311                 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1312
1313                 return( new_len );
1314
1315         }
1316
1317         /* allow space for any buffered data and for new data, up to */
1318         /* transfer buffer size - 2 (for command and length bytes) */
1319         new_len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
1320         data_len = new_len + priv->dp_out_buf_len;
1321
1322         if( data_len == 0 ) {
1323                 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1324                 return( 0 );
1325         }
1326
1327         port->write_urb->transfer_buffer_length = data_len+2;
1328         port->write_urb->dev = port->serial->dev;
1329
1330         *data++ = DIGI_CMD_SEND_DATA;
1331         *data++ = data_len;
1332
1333         /* copy in buffered data first */
1334         memcpy( data, priv->dp_out_buf, priv->dp_out_buf_len );
1335         data += priv->dp_out_buf_len;
1336
1337         /* copy in new data */
1338         memcpy( data, from_user ? user_buf : buf, new_len );
1339
1340         if( (ret=usb_submit_urb(port->write_urb, GFP_ATOMIC)) == 0 ) {
1341                 priv->dp_write_urb_in_use = 1;
1342                 ret = new_len;
1343                 priv->dp_out_buf_len = 0;
1344         }
1345
1346         /* return length of new data written, or error */
1347         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1348         if( ret < 0 ) {
1349                 err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
1350                         ret, priv->dp_port_num );
1351         }
1352
1353 dbg( "digi_write: returning %d", ret );
1354         return( ret );
1355
1356 }
1357
1358
1359 static void digi_write_bulk_callback( struct urb *urb, struct pt_regs *regs )
1360 {
1361
1362         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1363         struct usb_serial *serial;
1364         struct digi_port *priv;
1365         struct digi_serial *serial_priv;
1366         int ret = 0;
1367
1368
1369 dbg( "digi_write_bulk_callback: TOP, urb->status=%d", urb->status );
1370
1371         /* port and serial sanity check */
1372         if( port == NULL || (priv=usb_get_serial_port_data(port)) == NULL ) {
1373                 err("%s: port or port->private is NULL, status=%d", __FUNCTION__,
1374                         urb->status );
1375                 return;
1376         }
1377         serial = port->serial;
1378         if( serial == NULL || (serial_priv=usb_get_serial_data(serial)) == NULL ) {
1379                 err("%s: serial or serial->private is NULL, status=%d", __FUNCTION__, urb->status );
1380                 return;
1381         }
1382
1383         /* handle oob callback */
1384         if( priv->dp_port_num == serial_priv->ds_oob_port_num ) {
1385                 dbg( "digi_write_bulk_callback: oob callback" );
1386                 spin_lock( &priv->dp_port_lock );
1387                 priv->dp_write_urb_in_use = 0;
1388                 wake_up_interruptible( &port->write_wait );
1389                 spin_unlock( &priv->dp_port_lock );
1390                 return;
1391         }
1392
1393         /* try to send any buffered data on this port, if it is open */
1394         spin_lock( &priv->dp_port_lock );
1395         priv->dp_write_urb_in_use = 0;
1396         if( port->open_count && port->write_urb->status != -EINPROGRESS
1397         && priv->dp_out_buf_len > 0 ) {
1398
1399                 *((unsigned char *)(port->write_urb->transfer_buffer))
1400                         = (unsigned char)DIGI_CMD_SEND_DATA;
1401                 *((unsigned char *)(port->write_urb->transfer_buffer)+1)
1402                         = (unsigned char)priv->dp_out_buf_len;
1403
1404                 port->write_urb->transfer_buffer_length
1405                         = priv->dp_out_buf_len+2;
1406                 port->write_urb->dev = serial->dev;
1407
1408                 memcpy( port->write_urb->transfer_buffer+2, priv->dp_out_buf,
1409                         priv->dp_out_buf_len );
1410
1411                 if( (ret=usb_submit_urb(port->write_urb, GFP_ATOMIC)) == 0 ) {
1412                         priv->dp_write_urb_in_use = 1;
1413                         priv->dp_out_buf_len = 0;
1414                 }
1415
1416         }
1417
1418         /* wake up processes sleeping on writes immediately */
1419         digi_wakeup_write( port );
1420
1421         /* also queue up a wakeup at scheduler time, in case we */
1422         /* lost the race in write_chan(). */
1423         schedule_work(&priv->dp_wakeup_work);
1424
1425         spin_unlock( &priv->dp_port_lock );
1426
1427         if( ret ) {
1428                 err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
1429                         ret, priv->dp_port_num );
1430         }
1431
1432 }
1433
1434
1435 static int digi_write_room( struct usb_serial_port *port )
1436 {
1437
1438         int room;
1439         struct digi_port *priv = usb_get_serial_port_data(port);
1440         unsigned long flags = 0;
1441
1442
1443         spin_lock_irqsave( &priv->dp_port_lock, flags );
1444
1445         if( port->write_urb->status == -EINPROGRESS
1446         || priv->dp_write_urb_in_use )
1447                 room = 0;
1448         else
1449                 room = port->bulk_out_size - 2 - priv->dp_out_buf_len;
1450
1451         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1452
1453 dbg( "digi_write_room: port=%d, room=%d", priv->dp_port_num, room );
1454         return( room );
1455
1456 }
1457
1458
1459 static int digi_chars_in_buffer( struct usb_serial_port *port )
1460 {
1461
1462         struct digi_port *priv = usb_get_serial_port_data(port);
1463
1464
1465         if( port->write_urb->status == -EINPROGRESS
1466         || priv->dp_write_urb_in_use ) {
1467 dbg( "digi_chars_in_buffer: port=%d, chars=%d", priv->dp_port_num, port->bulk_out_size - 2 );
1468                 /* return( port->bulk_out_size - 2 ); */
1469                 return( 256 );
1470         } else {
1471 dbg( "digi_chars_in_buffer: port=%d, chars=%d", priv->dp_port_num, priv->dp_out_buf_len );
1472                 return( priv->dp_out_buf_len );
1473         }
1474
1475 }
1476
1477
1478 static int digi_open( struct usb_serial_port *port, struct file *filp )
1479 {
1480
1481         int ret;
1482         unsigned char buf[32];
1483         struct digi_port *priv = usb_get_serial_port_data(port);
1484         struct termios not_termios;
1485         unsigned long flags = 0;
1486
1487
1488 dbg( "digi_open: TOP: port=%d, open_count=%d", priv->dp_port_num, port->open_count );
1489
1490         /* be sure the device is started up */
1491         if( digi_startup_device( port->serial ) != 0 )
1492                 return( -ENXIO );
1493
1494         spin_lock_irqsave( &priv->dp_port_lock, flags );
1495
1496         /* don't wait on a close in progress for non-blocking opens */
1497         if( priv->dp_in_close && (filp->f_flags&(O_NDELAY|O_NONBLOCK)) == 0 ) {
1498                 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1499                 return( -EAGAIN );
1500         }
1501
1502         /* wait for a close in progress to finish */
1503         while( priv->dp_in_close ) {
1504                 cond_wait_interruptible_timeout_irqrestore(
1505                         &priv->dp_close_wait, DIGI_RETRY_TIMEOUT,
1506                         &priv->dp_port_lock, flags );
1507                 if( signal_pending(current) ) {
1508                         return( -EINTR );
1509                 }
1510                 spin_lock_irqsave( &priv->dp_port_lock, flags );
1511         }
1512
1513         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1514
1515         /* read modem signals automatically whenever they change */
1516         buf[0] = DIGI_CMD_READ_INPUT_SIGNALS;
1517         buf[1] = priv->dp_port_num;
1518         buf[2] = DIGI_ENABLE;
1519         buf[3] = 0;
1520
1521         /* flush fifos */
1522         buf[4] = DIGI_CMD_IFLUSH_FIFO;
1523         buf[5] = priv->dp_port_num;
1524         buf[6] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1525         buf[7] = 0;
1526
1527         if( (ret=digi_write_oob_command( port, buf, 8, 1 )) != 0 )
1528                 dbg( "digi_open: write oob failed, ret=%d", ret );
1529
1530         /* set termios settings */
1531         not_termios.c_cflag = ~port->tty->termios->c_cflag;
1532         not_termios.c_iflag = ~port->tty->termios->c_iflag;
1533         digi_set_termios( port, &not_termios );
1534
1535         /* set DTR and RTS */
1536         digi_set_modem_signals( port, TIOCM_DTR|TIOCM_RTS, 1 );
1537
1538         return( 0 );
1539
1540 }
1541
1542
1543 static void digi_close( struct usb_serial_port *port, struct file *filp )
1544 {
1545
1546         int ret;
1547         unsigned char buf[32];
1548         struct tty_struct *tty = port->tty;
1549         struct digi_port *priv = usb_get_serial_port_data(port);
1550         unsigned long flags = 0;
1551
1552
1553 dbg( "digi_close: TOP: port=%d, open_count=%d", priv->dp_port_num, port->open_count );
1554
1555
1556         /* do cleanup only after final close on this port */
1557         spin_lock_irqsave( &priv->dp_port_lock, flags );
1558         priv->dp_in_close = 1;
1559         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1560
1561         /* tell line discipline to process only XON/XOFF */
1562         tty->closing = 1;
1563
1564         /* wait for output to drain */
1565         if( (filp->f_flags&(O_NDELAY|O_NONBLOCK)) == 0 ) {
1566                 tty_wait_until_sent( tty, DIGI_CLOSE_TIMEOUT );
1567         }
1568
1569         /* flush driver and line discipline buffers */
1570         if( tty->driver->flush_buffer )
1571                 tty->driver->flush_buffer( tty );
1572         if( tty->ldisc.flush_buffer )
1573                 tty->ldisc.flush_buffer( tty );
1574
1575         if (port->serial->dev) {
1576                 /* wait for transmit idle */
1577                 if( (filp->f_flags&(O_NDELAY|O_NONBLOCK)) == 0 ) {
1578                         digi_transmit_idle( port, DIGI_CLOSE_TIMEOUT );
1579                 }
1580
1581                 /* drop DTR and RTS */
1582                 digi_set_modem_signals( port, 0, 0 );
1583
1584                 /* disable input flow control */
1585                 buf[0] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1586                 buf[1] = priv->dp_port_num;
1587                 buf[2] = DIGI_DISABLE;
1588                 buf[3] = 0;
1589
1590                 /* disable output flow control */
1591                 buf[4] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1592                 buf[5] = priv->dp_port_num;
1593                 buf[6] = DIGI_DISABLE;
1594                 buf[7] = 0;
1595
1596                 /* disable reading modem signals automatically */
1597                 buf[8] = DIGI_CMD_READ_INPUT_SIGNALS;
1598                 buf[9] = priv->dp_port_num;
1599                 buf[10] = DIGI_DISABLE;
1600                 buf[11] = 0;
1601
1602                 /* disable receive */
1603                 buf[12] = DIGI_CMD_RECEIVE_ENABLE;
1604                 buf[13] = priv->dp_port_num;
1605                 buf[14] = DIGI_DISABLE;
1606                 buf[15] = 0;
1607
1608                 /* flush fifos */
1609                 buf[16] = DIGI_CMD_IFLUSH_FIFO;
1610                 buf[17] = priv->dp_port_num;
1611                 buf[18] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1612                 buf[19] = 0;
1613
1614                 if( (ret=digi_write_oob_command( port, buf, 20, 0 )) != 0 )
1615                         dbg( "digi_close: write oob failed, ret=%d", ret );
1616
1617                 /* wait for final commands on oob port to complete */
1618                 interruptible_sleep_on_timeout( &priv->dp_flush_wait,
1619                         DIGI_CLOSE_TIMEOUT );
1620
1621                 /* shutdown any outstanding bulk writes */
1622                 usb_unlink_urb (port->write_urb);
1623         }
1624
1625         tty->closing = 0;
1626
1627         spin_lock_irqsave( &priv->dp_port_lock, flags );
1628         priv->dp_write_urb_in_use = 0;
1629         priv->dp_in_close = 0;
1630         wake_up_interruptible( &priv->dp_close_wait );
1631         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1632
1633 dbg( "digi_close: done" );
1634 }
1635
1636
1637 /*
1638 *  Digi Startup Device
1639 *
1640 *  Starts reads on all ports.  Must be called AFTER startup, with
1641 *  urbs initialized.  Returns 0 if successful, non-zero error otherwise.
1642 */
1643
1644 static int digi_startup_device( struct usb_serial *serial )
1645 {
1646
1647         int i,ret = 0;
1648         struct digi_serial *serial_priv = usb_get_serial_data(serial);
1649         struct usb_serial_port *port;
1650
1651
1652         /* be sure this happens exactly once */
1653         spin_lock( &serial_priv->ds_serial_lock );
1654         if( serial_priv->ds_device_started ) {
1655                 spin_unlock( &serial_priv->ds_serial_lock );
1656                 return( 0 );
1657         }
1658         serial_priv->ds_device_started = 1;
1659         spin_unlock( &serial_priv->ds_serial_lock );
1660
1661         /* start reading from each bulk in endpoint for the device */
1662         /* set USB_DISABLE_SPD flag for write bulk urbs */
1663         for( i=0; i<serial->type->num_ports+1; i++ ) {
1664
1665                 port = serial->port[i];
1666
1667                 port->write_urb->dev = port->serial->dev;
1668
1669                 if( (ret=usb_submit_urb(port->read_urb, GFP_KERNEL)) != 0 ) {
1670                         err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
1671                         ret, i );
1672                         break;
1673                 }
1674
1675         }
1676
1677         return( ret );
1678
1679 }
1680
1681
1682 static int digi_startup( struct usb_serial *serial )
1683 {
1684
1685         int i;
1686         struct digi_port *priv;
1687         struct digi_serial *serial_priv;
1688
1689
1690 dbg( "digi_startup: TOP" );
1691
1692         /* allocate the private data structures for all ports */
1693         /* number of regular ports + 1 for the out-of-band port */
1694         for( i=0; i<serial->type->num_ports+1; i++ ) {
1695
1696                 /* allocate port private structure */
1697                 priv = (struct digi_port *)kmalloc( sizeof(struct digi_port),
1698                         GFP_KERNEL );
1699                 if( priv == (struct digi_port *)0 ) {
1700                         while( --i >= 0 )
1701                                 kfree( usb_get_serial_port_data(serial->port[i]) );
1702                         return( 1 );                    /* error */
1703                 }
1704
1705                 /* initialize port private structure */
1706                 spin_lock_init( &priv->dp_port_lock );
1707                 priv->dp_port_num = i;
1708                 priv->dp_out_buf_len = 0;
1709                 priv->dp_in_buf_len = 0;
1710                 priv->dp_write_urb_in_use = 0;
1711                 priv->dp_modem_signals = 0;
1712                 init_waitqueue_head( &priv->dp_modem_change_wait );
1713                 priv->dp_transmit_idle = 0;
1714                 init_waitqueue_head( &priv->dp_transmit_idle_wait );
1715                 priv->dp_throttled = 0;
1716                 priv->dp_throttle_restart = 0;
1717                 init_waitqueue_head( &priv->dp_flush_wait );
1718                 priv->dp_in_close = 0;
1719                 init_waitqueue_head( &priv->dp_close_wait );
1720                 INIT_WORK(&priv->dp_wakeup_work,
1721                                 digi_wakeup_write_lock, serial->port[i]);
1722
1723                 /* initialize write wait queue for this port */
1724                 init_waitqueue_head( &serial->port[i]->write_wait );
1725
1726                 usb_set_serial_port_data(serial->port[i], priv);
1727         }
1728
1729         /* allocate serial private structure */
1730         serial_priv = (struct digi_serial *)kmalloc( sizeof(struct digi_serial),
1731                 GFP_KERNEL );
1732         if( serial_priv == (struct digi_serial *)0 ) {
1733                 for( i=0; i<serial->type->num_ports+1; i++ )
1734                         kfree( usb_get_serial_port_data(serial->port[i]) );
1735                 return( 1 );                    /* error */
1736         }
1737
1738         /* initialize serial private structure */
1739         spin_lock_init( &serial_priv->ds_serial_lock );
1740         serial_priv->ds_oob_port_num = serial->type->num_ports;
1741         serial_priv->ds_oob_port = serial->port[serial_priv->ds_oob_port_num];
1742         serial_priv->ds_device_started = 0;
1743         usb_set_serial_data(serial, serial_priv);
1744
1745         return( 0 );
1746
1747 }
1748
1749
1750 static void digi_shutdown( struct usb_serial *serial )
1751 {
1752
1753         int i;
1754
1755
1756 dbg( "digi_shutdown: TOP, in_interrupt()=%ld", in_interrupt() );
1757
1758         /* stop reads and writes on all ports */
1759         for( i=0; i<serial->type->num_ports+1; i++ ) {
1760                 usb_unlink_urb( serial->port[i]->read_urb );
1761                 usb_unlink_urb( serial->port[i]->write_urb );
1762         }
1763
1764         /* free the private data structures for all ports */
1765         /* number of regular ports + 1 for the out-of-band port */
1766         for( i=0; i<serial->type->num_ports+1; i++ )
1767                 kfree( usb_get_serial_port_data(serial->port[i]) );
1768         kfree( usb_get_serial_data(serial) );
1769 }
1770
1771
1772 static void digi_read_bulk_callback( struct urb *urb, struct pt_regs *regs )
1773 {
1774
1775         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1776         struct digi_port *priv;
1777         struct digi_serial *serial_priv;
1778         int ret;
1779
1780
1781 dbg( "digi_read_bulk_callback: TOP" );
1782
1783         /* port sanity check, do not resubmit if port is not valid */
1784         if( port == NULL || (priv=usb_get_serial_port_data(port)) == NULL ) {
1785                 err("%s: port or port->private is NULL, status=%d", __FUNCTION__,
1786                         urb->status );
1787                 return;
1788         }
1789         if( port->serial == NULL
1790         || (serial_priv=usb_get_serial_data(port->serial)) == NULL ) {
1791                 err("%s: serial is bad or serial->private is NULL, status=%d", __FUNCTION__, urb->status );
1792                 return;
1793         }
1794
1795         /* do not resubmit urb if it has any status error */
1796         if( urb->status ) {
1797                 err("%s: nonzero read bulk status: status=%d, port=%d", __FUNCTION__, urb->status, priv->dp_port_num );
1798                 return;
1799         }
1800
1801         /* handle oob or inb callback, do not resubmit if error */
1802         if( priv->dp_port_num == serial_priv->ds_oob_port_num ) {
1803                 if( digi_read_oob_callback( urb ) != 0 )
1804                         return;
1805         } else {
1806                 if( digi_read_inb_callback( urb ) != 0 )
1807                         return;
1808         }
1809
1810         /* continue read */
1811         urb->dev = port->serial->dev;
1812         if( (ret=usb_submit_urb(urb, GFP_ATOMIC)) != 0 ) {
1813                 err("%s: failed resubmitting urb, ret=%d, port=%d", __FUNCTION__,
1814                         ret, priv->dp_port_num );
1815         }
1816
1817 }
1818
1819
1820 /*
1821 *  Digi Read INB Callback
1822 *
1823 *  Digi Read INB Callback handles reads on the in band ports, sending
1824 *  the data on to the tty subsystem.  When called we know port and
1825 *  port->private are not NULL and port->serial has been validated.
1826 *  It returns 0 if successful, 1 if successful but the port is
1827 *  throttled, and -1 if the sanity checks failed.
1828 */
1829
1830 static int digi_read_inb_callback( struct urb *urb )
1831 {
1832
1833         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1834         struct tty_struct *tty = port->tty;
1835         struct digi_port *priv = usb_get_serial_port_data(port);
1836         int opcode = ((unsigned char *)urb->transfer_buffer)[0];
1837         int len = ((unsigned char *)urb->transfer_buffer)[1];
1838         int status = ((unsigned char *)urb->transfer_buffer)[2];
1839         unsigned char *data = ((unsigned char *)urb->transfer_buffer)+3;
1840         int flag,throttled;
1841
1842         /* do not process callbacks on closed ports */
1843         /* but do continue the read chain */
1844         if( port->open_count == 0 )
1845                 return( 0 );
1846
1847         /* short/multiple packet check */
1848         if( urb->actual_length != len + 2 ) {
1849                 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 );
1850                 return( -1 );
1851         }
1852
1853         spin_lock( &priv->dp_port_lock );
1854
1855         /* check for throttle; if set, do not resubmit read urb */
1856         /* indicate the read chain needs to be restarted on unthrottle */
1857         throttled = priv->dp_throttled;
1858         if( throttled )
1859                 priv->dp_throttle_restart = 1;
1860
1861         /* receive data */
1862         if( opcode == DIGI_CMD_RECEIVE_DATA ) {
1863
1864                 /* get flag from status */
1865                 flag = 0;
1866
1867                 /* overrun is special, not associated with a char */
1868                 if( status & DIGI_OVERRUN_ERROR ) {
1869                         tty_insert_flip_char( tty, 0, TTY_OVERRUN );
1870                 }
1871
1872                 /* break takes precedence over parity, */
1873                 /* which takes precedence over framing errors */
1874                 if( status & DIGI_BREAK_ERROR ) {
1875                         flag = TTY_BREAK;
1876                 } else if( status & DIGI_PARITY_ERROR ) {
1877                         flag = TTY_PARITY;
1878                 } else if( status & DIGI_FRAMING_ERROR ) {
1879                         flag = TTY_FRAME;
1880                 }
1881
1882                 /* data length is len-1 (one byte of len is status) */
1883                 --len;
1884
1885                 if( throttled ) {
1886
1887                         len = min( len,
1888                                 DIGI_IN_BUF_SIZE - priv->dp_in_buf_len );
1889
1890                         if( len > 0 ) {
1891                                 memcpy( priv->dp_in_buf + priv->dp_in_buf_len,
1892                                         data, len );
1893                                 memset( priv->dp_in_flag_buf
1894                                         + priv->dp_in_buf_len, flag, len );
1895                                 priv->dp_in_buf_len += len;
1896                         }
1897
1898                 } else {
1899
1900                         len = min( len, TTY_FLIPBUF_SIZE - tty->flip.count );
1901
1902                         if( len > 0 ) {
1903                                 memcpy( tty->flip.char_buf_ptr, data, len );
1904                                 memset( tty->flip.flag_buf_ptr, flag, len );
1905                                 tty->flip.char_buf_ptr += len;
1906                                 tty->flip.flag_buf_ptr += len;
1907                                 tty->flip.count += len;
1908                                 tty_flip_buffer_push( tty );
1909                         }
1910
1911                 }
1912
1913         }
1914
1915         spin_unlock( &priv->dp_port_lock );
1916
1917         if( opcode == DIGI_CMD_RECEIVE_DISABLE ) {
1918                 dbg("%s: got RECEIVE_DISABLE", __FUNCTION__ );
1919         } else if( opcode != DIGI_CMD_RECEIVE_DATA ) {
1920                 dbg("%s: unknown opcode: %d", __FUNCTION__, opcode );
1921         }
1922
1923         return( throttled ? 1 : 0 );
1924
1925 }
1926
1927
1928 /*
1929 *  Digi Read OOB Callback
1930 *
1931 *  Digi Read OOB Callback handles reads on the out of band port.
1932 *  When called we know port and port->private are not NULL and
1933 *  the port->serial is valid.  It returns 0 if successful, and
1934 *  -1 if the sanity checks failed.
1935 */
1936
1937 static int digi_read_oob_callback( struct urb *urb )
1938 {
1939
1940         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1941         struct usb_serial *serial = port->serial;
1942         struct digi_port *priv = usb_get_serial_port_data(port);
1943         int opcode, line, status, val;
1944         int i;
1945
1946
1947 dbg( "digi_read_oob_callback: port=%d, len=%d", priv->dp_port_num,
1948 urb->actual_length );
1949
1950         /* handle each oob command */
1951         for( i=0; i<urb->actual_length-3; ) {
1952
1953                 opcode = ((unsigned char *)urb->transfer_buffer)[i++];
1954                 line = ((unsigned char *)urb->transfer_buffer)[i++];
1955                 status = ((unsigned char *)urb->transfer_buffer)[i++];
1956                 val = ((unsigned char *)urb->transfer_buffer)[i++];
1957
1958 dbg( "digi_read_oob_callback: opcode=%d, line=%d, status=%d, val=%d",
1959 opcode, line, status, val );
1960
1961                 if( status != 0 || line >= serial->type->num_ports )
1962                         continue;
1963
1964                 port = serial->port[line];
1965
1966                 if ((priv=usb_get_serial_port_data(port)) == NULL )
1967                         return -1;
1968
1969                 if( opcode == DIGI_CMD_READ_INPUT_SIGNALS ) {
1970
1971                         spin_lock( &priv->dp_port_lock );
1972
1973                         /* convert from digi flags to termiox flags */
1974                         if( val & DIGI_READ_INPUT_SIGNALS_CTS ) {
1975                                 priv->dp_modem_signals |= TIOCM_CTS;
1976                                 /* port must be open to use tty struct */
1977                                 if( port->open_count
1978                                 && port->tty->termios->c_cflag & CRTSCTS ) {
1979                                         port->tty->hw_stopped = 0;
1980                                         digi_wakeup_write( port );
1981                                 }
1982                         } else {
1983                                 priv->dp_modem_signals &= ~TIOCM_CTS;
1984                                 /* port must be open to use tty struct */
1985                                 if( port->open_count
1986                                 && port->tty->termios->c_cflag & CRTSCTS ) {
1987                                         port->tty->hw_stopped = 1;
1988                                 }
1989                         }
1990                         if( val & DIGI_READ_INPUT_SIGNALS_DSR )
1991                                 priv->dp_modem_signals |= TIOCM_DSR;
1992                         else
1993                                 priv->dp_modem_signals &= ~TIOCM_DSR;
1994                         if( val & DIGI_READ_INPUT_SIGNALS_RI )
1995                                 priv->dp_modem_signals |= TIOCM_RI;
1996                         else
1997                                 priv->dp_modem_signals &= ~TIOCM_RI;
1998                         if( val & DIGI_READ_INPUT_SIGNALS_DCD )
1999                                 priv->dp_modem_signals |= TIOCM_CD;
2000                         else
2001                                 priv->dp_modem_signals &= ~TIOCM_CD;
2002
2003                         wake_up_interruptible( &priv->dp_modem_change_wait );
2004                         spin_unlock( &priv->dp_port_lock );
2005
2006                 } else if( opcode == DIGI_CMD_TRANSMIT_IDLE ) {
2007
2008                         spin_lock( &priv->dp_port_lock );
2009                         priv->dp_transmit_idle = 1;
2010                         wake_up_interruptible( &priv->dp_transmit_idle_wait );
2011                         spin_unlock( &priv->dp_port_lock );
2012
2013                 } else if( opcode == DIGI_CMD_IFLUSH_FIFO ) {
2014
2015                         wake_up_interruptible( &priv->dp_flush_wait );
2016
2017                 }
2018
2019         }
2020
2021         return( 0 );
2022
2023 }
2024
2025
2026 static int __init digi_init (void)
2027 {
2028         int retval;
2029         retval = usb_serial_register(&digi_acceleport_2_device);
2030         if (retval)
2031                 goto failed_acceleport_2_device;
2032         retval = usb_serial_register(&digi_acceleport_4_device);
2033         if (retval)
2034                 goto failed_acceleport_4_device;
2035         retval = usb_register(&digi_driver);
2036         if (retval)
2037                 goto failed_usb_register;
2038         info(DRIVER_VERSION ":" DRIVER_DESC);
2039         return 0;
2040 failed_usb_register:
2041         usb_serial_deregister(&digi_acceleport_4_device);
2042 failed_acceleport_4_device:
2043         usb_serial_deregister(&digi_acceleport_2_device);
2044 failed_acceleport_2_device:
2045         return retval;
2046 }
2047
2048
2049 static void __exit digi_exit (void)
2050 {
2051         usb_deregister (&digi_driver);
2052         usb_serial_deregister (&digi_acceleport_2_device);
2053         usb_serial_deregister (&digi_acceleport_4_device);
2054 }
2055
2056
2057 module_init(digi_init);
2058 module_exit(digi_exit);
2059
2060
2061 MODULE_AUTHOR( DRIVER_AUTHOR );
2062 MODULE_DESCRIPTION( DRIVER_DESC );
2063 MODULE_LICENSE("GPL");
2064
2065 module_param(debug, bool, S_IRUGO | S_IWUSR);
2066 MODULE_PARM_DESC(debug, "Debug enabled or not");