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