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