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