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