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