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