Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/drzeus/mmc
[linux-2.6] / drivers / usb / serial / digi_acceleport.c
1 /*
2 *  Digi AccelePort USB-4 and USB-2 Serial Converters
3 *
4 *  Copyright 2000 by Digi International
5 *
6 *  This program is free software; you can redistribute it and/or modify
7 *  it under the terms of the GNU General Public License as published by
8 *  the Free Software Foundation; either version 2 of the License, or
9 *  (at your option) any later version.
10 *
11 *  Shamelessly based on Brian Warner's keyspan_pda.c and Greg Kroah-Hartman's
12 *  usb-serial driver.
13 *
14 *  Peter Berger (pberger@brimson.com)
15 *  Al Borchers (borchers@steinerpoint.com)
16
17 * (12/03/2001) gkh
18 *       switched to using port->open_count instead of private version.
19 *       Removed port->active
20 *
21 * (04/08/2001) gb
22 *       Identify version on module load.
23 *
24 * (11/01/2000) Adam J. Richter
25 *       usb_device_id table support
26
27 * (11/01/2000) pberger and borchers
28 *    -- Turned off the USB_DISABLE_SPD flag for write bulk urbs--it caused
29 *       USB 4 ports to hang on startup.
30 *    -- Serialized access to write urbs by adding the dp_write_urb_in_use
31 *       flag; otherwise, the driver caused SMP system hangs.  Watching the
32 *       urb status is not sufficient.
33 *
34 * (10/05/2000) gkh
35 *    -- Fixed bug with urb->dev not being set properly, now that the usb
36 *       core needs it.
37
38 *  (8/8/2000) pberger and borchers
39 *    -- Fixed close so that 
40 *       - it can timeout while waiting for transmit idle, if needed;
41 *       - it ignores interrupts when flushing the port, turning
42 *         of modem signalling, and so on;
43 *       - it waits for the flush to really complete before returning.
44 *    -- Read_bulk_callback and write_bulk_callback check for a closed
45 *       port before using the tty struct or writing to the port.
46 *    -- The two changes above fix the oops caused by interrupted closes.
47 *    -- Added interruptible args to write_oob_command and set_modem_signals
48 *       and added a timeout arg to transmit_idle; needed for fixes to
49 *       close.
50 *    -- Added code for rx_throttle and rx_unthrottle so that input flow
51 *       control works.
52 *    -- Added code to set overrun, parity, framing, and break errors
53 *       (untested).
54 *    -- Set USB_DISABLE_SPD flag for write bulk urbs, so no 0 length
55 *       bulk writes are done.  These hung the Digi USB device.  The
56 *       0 length bulk writes were a new feature of usb-uhci added in
57 *       the 2.4.0-test6 kernels.
58 *    -- Fixed mod inc race in open; do mod inc before sleeping to wait
59 *       for a close to finish.
60 *
61 *  (7/31/2000) pberger
62 *    -- Fixed bugs with hardware handshaking:
63 *       - Added code to set/clear tty->hw_stopped in digi_read_oob_callback()
64 *         and digi_set_termios()
65 *    -- Added code in digi_set_termios() to
66 *       - add conditional in code handling transition from B0 to only
67 *         set RTS if RTS/CTS flow control is either not in use or if
68 *         the port is not currently throttled.
69 *       - handle turning off CRTSCTS.
70 *
71 *  (7/30/2000) borchers
72 *    -- Added support for more than one Digi USB device by moving
73 *       globals to a private structure in the pointed to from the
74 *       usb_serial structure.
75 *    -- Moved the modem change and transmit idle wait queues into
76 *       the port private structure, so each port has its own queue
77 *       rather than sharing global queues.
78 *    -- Added support for break signals.
79 *
80 *  (7/25/2000) pberger
81 *    -- Added USB-2 support.  Note: the USB-2 supports 3 devices: two
82 *       serial and a parallel port.  The parallel port is implemented
83 *       as a serial-to-parallel converter.  That is, the driver actually
84 *       presents all three USB-2 interfaces as serial ports, but the third
85 *       one physically connects to a parallel device.  Thus, for example,
86 *       one could plug a parallel printer into the USB-2's third port,
87 *       but from the kernel's (and userland's) point of view what's
88 *       actually out there is a serial device.
89 *
90 *  (7/15/2000) borchers
91 *    -- Fixed race in open when a close is in progress.
92 *    -- Keep count of opens and dec the module use count for each
93 *       outstanding open when shutdown is called (on disconnect).
94 *    -- Fixed sanity checks in read_bulk_callback and write_bulk_callback
95 *       so pointers are checked before use.
96 *    -- Split read bulk callback into in band and out of band
97 *       callbacks, and no longer restart read chains if there is
98 *       a status error or a sanity error.  This fixed the seg
99 *       faults and other errors we used to get on disconnect.
100 *    -- Port->active is once again a flag as usb-serial intended it
101 *       to be, not a count.  Since it was only a char it would
102 *       have been limited to 256 simultaneous opens.  Now the open
103 *       count is kept in the port private structure in dp_open_count.
104 *    -- Added code for modularization of the digi_acceleport driver.
105 *
106 *  (6/27/2000) pberger and borchers
107 *    -- Zeroed out sync field in the wakeup_task before first use;
108 *       otherwise the uninitialized value might prevent the task from
109 *       being scheduled.
110 *    -- Initialized ret value to 0 in write_bulk_callback, otherwise
111 *       the uninitialized value could cause a spurious debugging message.
112 *
113 *  (6/22/2000) pberger and borchers
114 *    -- Made cond_wait_... inline--apparently on SPARC the flags arg
115 *       to spin_lock_irqsave cannot be passed to another function
116 *       to call spin_unlock_irqrestore.  Thanks to Pauline Middelink.
117 *    -- In digi_set_modem_signals the inner nested spin locks use just
118 *       spin_lock() rather than spin_lock_irqsave().  The old code
119 *       mistakenly left interrupts off.  Thanks to Pauline Middelink.
120 *    -- copy_from_user (which can sleep) is no longer called while a
121 *       spinlock is held.  We copy to a local buffer before getting
122 *       the spinlock--don't like the extra copy but the code is simpler.
123 *    -- Printk and dbg are no longer called while a spin lock is held.
124 *
125 *  (6/4/2000) pberger and borchers
126 *    -- Replaced separate calls to spin_unlock_irqrestore and
127 *       interruptible_sleep_on_timeout with a new function
128 *       cond_wait_interruptible_timeout_irqrestore.  This eliminates
129 *       the race condition where the wake up could happen after
130 *       the unlock and before the sleep.
131 *    -- Close now waits for output to drain.
132 *    -- Open waits until any close in progress is finished.
133 *    -- All out of band responses are now processed, not just the
134 *       first in a USB packet.
135 *    -- Fixed a bug that prevented the driver from working when the
136 *       first Digi port was not the first USB serial port--the driver
137 *       was mistakenly using the external USB serial port number to
138 *       try to index into its internal ports.
139 *    -- Fixed an SMP bug -- write_bulk_callback is called directly from
140 *       an interrupt, so spin_lock_irqsave/spin_unlock_irqrestore are
141 *       needed for locks outside write_bulk_callback that are also
142 *       acquired by write_bulk_callback to prevent deadlocks.
143 *    -- Fixed support for select() by making digi_chars_in_buffer()
144 *       return 256 when -EINPROGRESS is set, as the line discipline
145 *       code in n_tty.c expects.
146 *    -- Fixed an include file ordering problem that prevented debugging
147 *       messages from working.
148 *    -- Fixed an intermittent timeout problem that caused writes to
149 *       sometimes get stuck on some machines on some kernels.  It turns
150 *       out in these circumstances write_chan() (in n_tty.c) was
151 *       asleep waiting for our wakeup call.  Even though we call
152 *       wake_up_interruptible() in digi_write_bulk_callback(), there is
153 *       a race condition that could cause the wakeup to fail: if our
154 *       wake_up_interruptible() call occurs between the time that our
155 *       driver write routine finishes and write_chan() sets current->state
156 *       to TASK_INTERRUPTIBLE, the effect of our wakeup setting the state
157 *       to TASK_RUNNING will be lost and write_chan's subsequent call to
158 *       schedule() will never return (unless it catches a signal).
159 *       This race condition occurs because write_bulk_callback() (and thus
160 *       the wakeup) are called asynchronously from an interrupt, rather than
161 *       from the scheduler.  We can avoid the race by calling the wakeup
162 *       from the scheduler queue and that's our fix:  Now, at the end of
163 *       write_bulk_callback() we queue up a wakeup call on the scheduler
164 *       task queue.  We still also invoke the wakeup directly since that
165 *       squeezes a bit more performance out of the driver, and any lost
166 *       race conditions will get cleaned up at the next scheduler run.
167 *
168 *       NOTE:  The problem also goes away if you comment out
169 *       the two code lines in write_chan() where current->state
170 *       is set to TASK_RUNNING just before calling driver.write() and to
171 *       TASK_INTERRUPTIBLE immediately afterwards.  This is why the
172 *       problem did not show up with the 2.2 kernels -- they do not
173 *       include that code.
174 *
175 *  (5/16/2000) pberger and borchers
176 *    -- Added timeouts to sleeps, to defend against lost wake ups.
177 *    -- Handle transition to/from B0 baud rate in digi_set_termios.
178 *
179 *  (5/13/2000) pberger and borchers
180 *    -- All commands now sent on out of band port, using
181 *       digi_write_oob_command.
182 *    -- Get modem control signals whenever they change, support TIOCMGET/
183 *       SET/BIS/BIC ioctls.
184 *    -- digi_set_termios now supports parity, word size, stop bits, and
185 *       receive enable.
186 *    -- Cleaned up open and close, use digi_set_termios and
187 *       digi_write_oob_command to set port parameters.
188 *    -- Added digi_startup_device to start read chains on all ports.
189 *    -- Write buffer is only used when count==1, to be sure put_char can
190 *       write a char (unless the buffer is full).
191 *
192 *  (5/10/2000) pberger and borchers
193 *    -- Added MOD_INC_USE_COUNT/MOD_DEC_USE_COUNT calls on open/close.
194 *    -- Fixed problem where the first incoming character is lost on
195 *       port opens after the first close on that port.  Now we keep
196 *       the read_urb chain open until shutdown.
197 *    -- Added more port conditioning calls in digi_open and digi_close.
198 *    -- Convert port->active to a use count so that we can deal with multiple
199 *       opens and closes properly.
200 *    -- Fixed some problems with the locking code.
201 *
202 *  (5/3/2000) pberger and borchers
203 *    -- First alpha version of the driver--many known limitations and bugs.
204 *
205 *
206 *  Locking and SMP
207 *
208 *  - Each port, including the out-of-band port, has a lock used to
209 *    serialize all access to the port's private structure.
210 *  - The port lock is also used to serialize all writes and access to
211 *    the port's URB.
212 *  - The port lock is also used for the port write_wait condition
213 *    variable.  Holding the port lock will prevent a wake up on the
214 *    port's write_wait; this can be used with cond_wait_... to be sure
215 *    the wake up is not lost in a race when dropping the lock and
216 *    sleeping waiting for the wakeup.
217 *  - digi_write() does not sleep, since it is sometimes called on
218 *    interrupt time.
219 *  - digi_write_bulk_callback() and digi_read_bulk_callback() are
220 *    called directly from interrupts.  Hence spin_lock_irqsave()
221 *    and spin_unlock_irqrestore() are used in the rest of the code
222 *    for any locks they acquire.
223 *  - digi_write_bulk_callback() gets the port lock before waking up
224 *    processes sleeping on the port write_wait.  It also schedules
225 *    wake ups so they happen from the scheduler, because the tty
226 *    system can miss wake ups from interrupts.
227 *  - All sleeps use a timeout of DIGI_RETRY_TIMEOUT before looping to
228 *    recheck the condition they are sleeping on.  This is defensive,
229 *    in case a wake up is lost.
230 *  - Following Documentation/DocBook/kernel-locking.pdf no spin locks
231 *    are held when calling copy_to/from_user or printk.
232 *    
233 *  $Id: digi_acceleport.c,v 1.80.1.2 2000/11/02 05:45:08 root Exp $
234 */
235
236 #include <linux/kernel.h>
237 #include <linux/errno.h>
238 #include <linux/init.h>
239 #include <linux/slab.h>
240 #include <linux/tty.h>
241 #include <linux/tty_driver.h>
242 #include <linux/tty_flip.h>
243 #include <linux/module.h>
244 #include <linux/spinlock.h>
245 #include <linux/workqueue.h>
246 #include <asm/uaccess.h>
247 #include <linux/usb.h>
248 #include <linux/wait.h>
249 #include <linux/usb/serial.h>
250
251 /* Defines */
252
253 /*
254  * Version Information
255  */
256 #define DRIVER_VERSION "v1.80.1.2"
257 #define DRIVER_AUTHOR "Peter Berger <pberger@brimson.com>, Al Borchers <borchers@steinerpoint.com>"
258 #define DRIVER_DESC "Digi AccelePort USB-2/USB-4 Serial Converter driver"
259
260 /* port output buffer length -- must be <= transfer buffer length - 2 */
261 /* so we can be sure to send the full buffer in one urb */
262 #define DIGI_OUT_BUF_SIZE               8
263
264 /* port input buffer length -- must be >= transfer buffer length - 3 */
265 /* so we can be sure to hold at least one full buffer from one urb */
266 #define DIGI_IN_BUF_SIZE                64
267
268 /* retry timeout while sleeping */
269 #define DIGI_RETRY_TIMEOUT              (HZ/10)
270
271 /* timeout while waiting for tty output to drain in close */
272 /* this delay is used twice in close, so the total delay could */
273 /* be twice this value */
274 #define DIGI_CLOSE_TIMEOUT              (5*HZ)
275
276
277 /* AccelePort USB Defines */
278
279 /* ids */
280 #define DIGI_VENDOR_ID                  0x05c5
281 #define DIGI_2_ID                       0x0002  /* USB-2 */
282 #define DIGI_4_ID                       0x0004  /* USB-4 */
283
284 /* commands
285  * "INB": can be used on the in-band endpoint
286  * "OOB": can be used on the out-of-band endpoint
287  */
288 #define DIGI_CMD_SET_BAUD_RATE                  0       /* INB, OOB */
289 #define DIGI_CMD_SET_WORD_SIZE                  1       /* INB, OOB */
290 #define DIGI_CMD_SET_PARITY                     2       /* INB, OOB */
291 #define DIGI_CMD_SET_STOP_BITS                  3       /* INB, OOB */
292 #define DIGI_CMD_SET_INPUT_FLOW_CONTROL         4       /* INB, OOB */
293 #define DIGI_CMD_SET_OUTPUT_FLOW_CONTROL        5       /* INB, OOB */
294 #define DIGI_CMD_SET_DTR_SIGNAL                 6       /* INB, OOB */
295 #define DIGI_CMD_SET_RTS_SIGNAL                 7       /* INB, OOB */
296 #define DIGI_CMD_READ_INPUT_SIGNALS             8       /*      OOB */
297 #define DIGI_CMD_IFLUSH_FIFO                    9       /*      OOB */
298 #define DIGI_CMD_RECEIVE_ENABLE                 10      /* INB, OOB */
299 #define DIGI_CMD_BREAK_CONTROL                  11      /* INB, OOB */
300 #define DIGI_CMD_LOCAL_LOOPBACK                 12      /* INB, OOB */
301 #define DIGI_CMD_TRANSMIT_IDLE                  13      /* INB, OOB */
302 #define DIGI_CMD_READ_UART_REGISTER             14      /*      OOB */
303 #define DIGI_CMD_WRITE_UART_REGISTER            15      /* INB, OOB */
304 #define DIGI_CMD_AND_UART_REGISTER              16      /* INB, OOB */
305 #define DIGI_CMD_OR_UART_REGISTER               17      /* INB, OOB */
306 #define DIGI_CMD_SEND_DATA                      18      /* INB      */
307 #define DIGI_CMD_RECEIVE_DATA                   19      /* INB      */
308 #define DIGI_CMD_RECEIVE_DISABLE                20      /* INB      */
309 #define DIGI_CMD_GET_PORT_TYPE                  21      /*      OOB */
310
311 /* baud rates */
312 #define DIGI_BAUD_50                            0
313 #define DIGI_BAUD_75                            1
314 #define DIGI_BAUD_110                           2
315 #define DIGI_BAUD_150                           3
316 #define DIGI_BAUD_200                           4
317 #define DIGI_BAUD_300                           5
318 #define DIGI_BAUD_600                           6
319 #define DIGI_BAUD_1200                          7
320 #define DIGI_BAUD_1800                          8
321 #define DIGI_BAUD_2400                          9
322 #define DIGI_BAUD_4800                          10
323 #define DIGI_BAUD_7200                          11
324 #define DIGI_BAUD_9600                          12
325 #define DIGI_BAUD_14400                         13
326 #define DIGI_BAUD_19200                         14
327 #define DIGI_BAUD_28800                         15
328 #define DIGI_BAUD_38400                         16
329 #define DIGI_BAUD_57600                         17
330 #define DIGI_BAUD_76800                         18
331 #define DIGI_BAUD_115200                        19
332 #define DIGI_BAUD_153600                        20
333 #define DIGI_BAUD_230400                        21
334 #define DIGI_BAUD_460800                        22
335
336 /* arguments */
337 #define DIGI_WORD_SIZE_5                        0
338 #define DIGI_WORD_SIZE_6                        1
339 #define DIGI_WORD_SIZE_7                        2
340 #define DIGI_WORD_SIZE_8                        3
341
342 #define DIGI_PARITY_NONE                        0
343 #define DIGI_PARITY_ODD                         1
344 #define DIGI_PARITY_EVEN                        2
345 #define DIGI_PARITY_MARK                        3
346 #define DIGI_PARITY_SPACE                       4
347
348 #define DIGI_STOP_BITS_1                        0
349 #define DIGI_STOP_BITS_2                        1
350
351 #define DIGI_INPUT_FLOW_CONTROL_XON_XOFF        1
352 #define DIGI_INPUT_FLOW_CONTROL_RTS             2
353 #define DIGI_INPUT_FLOW_CONTROL_DTR             4
354
355 #define DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF       1
356 #define DIGI_OUTPUT_FLOW_CONTROL_CTS            2
357 #define DIGI_OUTPUT_FLOW_CONTROL_DSR            4
358
359 #define DIGI_DTR_INACTIVE                       0
360 #define DIGI_DTR_ACTIVE                         1
361 #define DIGI_DTR_INPUT_FLOW_CONTROL             2
362
363 #define DIGI_RTS_INACTIVE                       0
364 #define DIGI_RTS_ACTIVE                         1
365 #define DIGI_RTS_INPUT_FLOW_CONTROL             2
366 #define DIGI_RTS_TOGGLE                         3
367
368 #define DIGI_FLUSH_TX                           1
369 #define DIGI_FLUSH_RX                           2
370 #define DIGI_RESUME_TX                          4 /* clears xoff condition */
371
372 #define DIGI_TRANSMIT_NOT_IDLE                  0
373 #define DIGI_TRANSMIT_IDLE                      1
374
375 #define DIGI_DISABLE                            0
376 #define DIGI_ENABLE                             1
377
378 #define DIGI_DEASSERT                           0
379 #define DIGI_ASSERT                             1
380
381 /* in band status codes */
382 #define DIGI_OVERRUN_ERROR                      4
383 #define DIGI_PARITY_ERROR                       8
384 #define DIGI_FRAMING_ERROR                      16
385 #define DIGI_BREAK_ERROR                        32
386
387 /* out of band status */
388 #define DIGI_NO_ERROR                           0
389 #define DIGI_BAD_FIRST_PARAMETER                1
390 #define DIGI_BAD_SECOND_PARAMETER               2
391 #define DIGI_INVALID_LINE                       3
392 #define DIGI_INVALID_OPCODE                     4
393
394 /* input signals */
395 #define DIGI_READ_INPUT_SIGNALS_SLOT            1
396 #define DIGI_READ_INPUT_SIGNALS_ERR             2
397 #define DIGI_READ_INPUT_SIGNALS_BUSY            4
398 #define DIGI_READ_INPUT_SIGNALS_PE              8
399 #define DIGI_READ_INPUT_SIGNALS_CTS             16
400 #define DIGI_READ_INPUT_SIGNALS_DSR             32
401 #define DIGI_READ_INPUT_SIGNALS_RI              64
402 #define DIGI_READ_INPUT_SIGNALS_DCD             128
403
404
405 /* Structures */
406
407 struct digi_serial {
408         spinlock_t ds_serial_lock;
409         struct usb_serial_port *ds_oob_port;    /* out-of-band port */
410         int ds_oob_port_num;                    /* index of out-of-band port */
411         int ds_device_started;
412 };
413
414 struct digi_port {
415         spinlock_t dp_port_lock;
416         int dp_port_num;
417         int dp_out_buf_len;
418         unsigned char dp_out_buf[DIGI_OUT_BUF_SIZE];
419         int dp_write_urb_in_use;
420         unsigned int dp_modem_signals;
421         wait_queue_head_t dp_modem_change_wait;
422         int dp_transmit_idle;
423         wait_queue_head_t dp_transmit_idle_wait;
424         int dp_throttled;
425         int dp_throttle_restart;
426         wait_queue_head_t dp_flush_wait;
427         int dp_in_close;                        /* close in progress */
428         wait_queue_head_t dp_close_wait;        /* wait queue for close */
429         struct work_struct dp_wakeup_work;
430         struct usb_serial_port *dp_port;
431 };
432
433
434 /* Local Function Declarations */
435
436 static void digi_wakeup_write( struct usb_serial_port *port );
437 static void digi_wakeup_write_lock(struct work_struct *work);
438 static int digi_write_oob_command( struct usb_serial_port *port,
439         unsigned char *buf, int count, int interruptible );
440 static int digi_write_inb_command( struct usb_serial_port *port,
441         unsigned char *buf, int count, unsigned long timeout );
442 static int digi_set_modem_signals( struct usb_serial_port *port,
443         unsigned int modem_signals, int interruptible );
444 static int digi_transmit_idle( struct usb_serial_port *port,
445         unsigned long timeout );
446 static void digi_rx_throttle (struct usb_serial_port *port);
447 static void digi_rx_unthrottle (struct usb_serial_port *port);
448 static void digi_set_termios( struct usb_serial_port *port, 
449         struct ktermios *old_termios );
450 static void digi_break_ctl( struct usb_serial_port *port, int break_state );
451 static int digi_ioctl( struct usb_serial_port *port, struct file *file,
452         unsigned int cmd, unsigned long arg );
453 static int digi_tiocmget( struct usb_serial_port *port, struct file *file );
454 static int digi_tiocmset( struct usb_serial_port *port, struct file *file,
455         unsigned int set, unsigned int clear );
456 static int digi_write( struct usb_serial_port *port, const unsigned char *buf, int count );
457 static void digi_write_bulk_callback( struct urb *urb );
458 static int digi_write_room( struct usb_serial_port *port );
459 static int digi_chars_in_buffer( struct usb_serial_port *port );
460 static int digi_open( struct usb_serial_port *port, struct file *filp );
461 static void digi_close( struct usb_serial_port *port, struct file *filp );
462 static int digi_startup_device( struct usb_serial *serial );
463 static int digi_startup( struct usb_serial *serial );
464 static void digi_shutdown( struct usb_serial *serial );
465 static void digi_read_bulk_callback( struct urb *urb );
466 static int digi_read_inb_callback( struct urb *urb );
467 static int digi_read_oob_callback( struct urb *urb );
468
469
470 /* Statics */
471
472 static int debug;
473
474 static struct usb_device_id id_table_combined [] = {
475         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
476         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
477         { }                                             /* Terminating entry */
478 };
479
480 static struct usb_device_id id_table_2 [] = {
481         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
482         { }                                             /* Terminating entry */
483 };
484
485 static struct usb_device_id id_table_4 [] = {
486         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
487         { }                                             /* Terminating entry */
488 };
489
490 MODULE_DEVICE_TABLE (usb, id_table_combined);
491
492 static struct usb_driver digi_driver = {
493         .name =         "digi_acceleport",
494         .probe =        usb_serial_probe,
495         .disconnect =   usb_serial_disconnect,
496         .id_table =     id_table_combined,
497         .no_dynamic_id =        1,
498 };
499
500
501 /* device info needed for the Digi serial converter */
502
503 static struct usb_serial_driver digi_acceleport_2_device = {
504         .driver = {
505                 .owner =                THIS_MODULE,
506                 .name =                 "digi_2",
507         },
508         .description =                  "Digi 2 port USB adapter",
509         .usb_driver =                   &digi_driver,
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_driver digi_acceleport_4_device = {
534         .driver = {
535                 .owner =                THIS_MODULE,
536                 .name =                 "digi_4",
537         },
538         .description =                  "Digi 4 port USB adapter",
539         .usb_driver =                   &digi_driver,
540         .id_table =                     id_table_4,
541         .num_interrupt_in =             0,
542         .num_bulk_in =                  5,
543         .num_bulk_out =                 5,
544         .num_ports =                    4,
545         .open =                         digi_open,
546         .close =                        digi_close,
547         .write =                        digi_write,
548         .write_room =                   digi_write_room,
549         .write_bulk_callback =          digi_write_bulk_callback,
550         .read_bulk_callback =           digi_read_bulk_callback,
551         .chars_in_buffer =              digi_chars_in_buffer,
552         .throttle =                     digi_rx_throttle,
553         .unthrottle =                   digi_rx_unthrottle,
554         .ioctl =                        digi_ioctl,
555         .set_termios =                  digi_set_termios,
556         .break_ctl =                    digi_break_ctl,
557         .tiocmget =                     digi_tiocmget,
558         .tiocmset =                     digi_tiocmset,
559         .attach =                       digi_startup,
560         .shutdown =                     digi_shutdown,
561 };
562
563
564 /* Functions */
565
566 /*
567 *  Cond Wait Interruptible Timeout Irqrestore
568 *
569 *  Do spin_unlock_irqrestore and interruptible_sleep_on_timeout
570 *  so that wake ups are not lost if they occur between the unlock
571 *  and the sleep.  In other words, spin_unlock_irqrestore and
572 *  interruptible_sleep_on_timeout are "atomic" with respect to
573 *  wake ups.  This is used to implement condition variables.
574 *
575 *  interruptible_sleep_on_timeout is deprecated and has been replaced
576 *  with the equivalent code.
577 */
578
579 static inline long cond_wait_interruptible_timeout_irqrestore(
580         wait_queue_head_t *q, long timeout,
581         spinlock_t *lock, unsigned long flags )
582 {
583         DEFINE_WAIT(wait);
584
585         prepare_to_wait(q, &wait, TASK_INTERRUPTIBLE);
586         spin_unlock_irqrestore(lock, flags);
587         timeout = schedule_timeout(timeout);
588         finish_wait(q, &wait);
589
590         return timeout;
591 }
592
593
594 /*
595 *  Digi Wakeup Write
596 *
597 *  Wake up port, line discipline, and tty processes sleeping
598 *  on writes.
599 */
600
601 static void digi_wakeup_write_lock(struct work_struct *work)
602 {
603         struct digi_port *priv =
604                 container_of(work, struct digi_port, dp_wakeup_work);
605         struct usb_serial_port *port = priv->dp_port;
606         unsigned long flags;
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         tty_wakeup(port->tty);
617 }
618
619
620 /*
621 *  Digi Write OOB Command
622 *
623 *  Write commands on the out of band port.  Commands are 4
624 *  bytes each, multiple commands can be sent at once, and
625 *  no command will be split across USB packets.  Returns 0
626 *  if successful, -EINTR if interrupted while sleeping and
627 *  the interruptible flag is true, or a negative error
628 *  returned by usb_submit_urb.
629 */
630
631 static int digi_write_oob_command( struct usb_serial_port *port,
632         unsigned char *buf, int count, int interruptible )
633 {
634
635         int ret = 0;
636         int len;
637         struct usb_serial_port *oob_port = (struct usb_serial_port *)((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
638         struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
639         unsigned long flags = 0;
640
641
642 dbg( "digi_write_oob_command: TOP: port=%d, count=%d", oob_priv->dp_port_num, count );
643
644         spin_lock_irqsave( &oob_priv->dp_port_lock, flags );
645
646         while( count > 0 ) {
647
648                 while( oob_port->write_urb->status == -EINPROGRESS
649                 || oob_priv->dp_write_urb_in_use ) {
650                         cond_wait_interruptible_timeout_irqrestore(
651                                 &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
652                                 &oob_priv->dp_port_lock, flags );
653                         if( interruptible && signal_pending(current) ) {
654                                 return( -EINTR );
655                         }
656                         spin_lock_irqsave( &oob_priv->dp_port_lock, flags );
657                 }
658
659                 /* len must be a multiple of 4, so commands are not split */
660                 len = min(count, oob_port->bulk_out_size );
661                 if( len > 4 )
662                         len &= ~3;
663
664                 memcpy( oob_port->write_urb->transfer_buffer, buf, len );
665                 oob_port->write_urb->transfer_buffer_length = len;
666                 oob_port->write_urb->dev = port->serial->dev;
667
668                 if( (ret=usb_submit_urb(oob_port->write_urb, GFP_ATOMIC)) == 0 ) {
669                         oob_priv->dp_write_urb_in_use = 1;
670                         count -= len;
671                         buf += len;
672                 }
673
674         }
675
676         spin_unlock_irqrestore( &oob_priv->dp_port_lock, flags );
677
678         if( ret ) {
679                 err("%s: usb_submit_urb failed, ret=%d", __FUNCTION__,
680                         ret );
681         }
682
683         return( ret );
684
685 }
686
687
688 /*
689 *  Digi Write In Band Command
690 *
691 *  Write commands on the given port.  Commands are 4
692 *  bytes each, multiple commands can be sent at once, and
693 *  no command will be split across USB packets.  If timeout
694 *  is non-zero, write in band command will return after
695 *  waiting unsuccessfully for the URB status to clear for
696 *  timeout ticks.  Returns 0 if successful, or a negative
697 *  error returned by digi_write.
698 */
699
700 static int digi_write_inb_command( struct usb_serial_port *port,
701         unsigned char *buf, int count, unsigned long timeout )
702 {
703
704         int ret = 0;
705         int len;
706         struct digi_port *priv = usb_get_serial_port_data(port);
707         unsigned char *data = port->write_urb->transfer_buffer;
708         unsigned long flags = 0;
709
710
711 dbg( "digi_write_inb_command: TOP: port=%d, count=%d", priv->dp_port_num,
712 count );
713
714         if( timeout )
715                 timeout += jiffies;
716         else
717                 timeout = ULONG_MAX;
718
719         spin_lock_irqsave( &priv->dp_port_lock, flags );
720
721         while( count > 0 && ret == 0 ) {
722
723                 while( (port->write_urb->status == -EINPROGRESS
724                 || priv->dp_write_urb_in_use) && time_before(jiffies, timeout)) {
725                         cond_wait_interruptible_timeout_irqrestore(
726                                 &port->write_wait, DIGI_RETRY_TIMEOUT,
727                                 &priv->dp_port_lock, flags );
728                         if( signal_pending(current) ) {
729                                 return( -EINTR );
730                         }
731                         spin_lock_irqsave( &priv->dp_port_lock, flags );
732                 }
733
734                 /* len must be a multiple of 4 and small enough to */
735                 /* guarantee the write will send buffered data first, */
736                 /* so commands are in order with data and not split */
737                 len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len );
738                 if( len > 4 )
739                         len &= ~3;
740
741                 /* write any buffered data first */
742                 if( priv->dp_out_buf_len > 0 ) {
743                         data[0] = DIGI_CMD_SEND_DATA;
744                         data[1] = priv->dp_out_buf_len;
745                         memcpy( data+2, priv->dp_out_buf,
746                                 priv->dp_out_buf_len );
747                         memcpy( data+2+priv->dp_out_buf_len, buf, len );
748                         port->write_urb->transfer_buffer_length
749                                 = priv->dp_out_buf_len+2+len;
750                 } else {
751                         memcpy( data, buf, len );
752                         port->write_urb->transfer_buffer_length = len;
753                 }
754                 port->write_urb->dev = port->serial->dev;
755
756                 if( (ret=usb_submit_urb(port->write_urb, GFP_ATOMIC)) == 0 ) {
757                         priv->dp_write_urb_in_use = 1;
758                         priv->dp_out_buf_len = 0;
759                         count -= len;
760                         buf += len;
761                 }
762
763         }
764
765         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
766
767         if( ret ) {
768                 err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
769                 ret, priv->dp_port_num );
770         }
771
772         return( ret );
773
774 }
775
776
777 /*
778 *  Digi Set Modem Signals
779 *
780 *  Sets or clears DTR and RTS on the port, according to the
781 *  modem_signals argument.  Use TIOCM_DTR and TIOCM_RTS flags
782 *  for the modem_signals argument.  Returns 0 if successful,
783 *  -EINTR if interrupted while sleeping, or a non-zero error
784 *  returned by usb_submit_urb.
785 */
786
787 static int digi_set_modem_signals( struct usb_serial_port *port,
788         unsigned int modem_signals, int interruptible )
789 {
790
791         int ret;
792         struct digi_port *port_priv = usb_get_serial_port_data(port);
793         struct usb_serial_port *oob_port = (struct usb_serial_port *)((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
794         struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
795         unsigned char *data = oob_port->write_urb->transfer_buffer;
796         unsigned long flags = 0;
797
798
799 dbg( "digi_set_modem_signals: TOP: port=%d, modem_signals=0x%x",
800 port_priv->dp_port_num, modem_signals );
801
802         spin_lock_irqsave( &oob_priv->dp_port_lock, flags );
803         spin_lock( &port_priv->dp_port_lock );
804
805         while( oob_port->write_urb->status == -EINPROGRESS
806         || oob_priv->dp_write_urb_in_use ) {
807                 spin_unlock( &port_priv->dp_port_lock );
808                 cond_wait_interruptible_timeout_irqrestore(
809                         &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
810                         &oob_priv->dp_port_lock, flags );
811                 if( interruptible && signal_pending(current) ) {
812                         return( -EINTR );
813                 }
814                 spin_lock_irqsave( &oob_priv->dp_port_lock, flags );
815                 spin_lock( &port_priv->dp_port_lock );
816         }
817
818         data[0] = DIGI_CMD_SET_DTR_SIGNAL;
819         data[1] = port_priv->dp_port_num;
820         data[2] = (modem_signals&TIOCM_DTR) ?
821                 DIGI_DTR_ACTIVE : DIGI_DTR_INACTIVE;
822         data[3] = 0;
823
824         data[4] = DIGI_CMD_SET_RTS_SIGNAL;
825         data[5] = port_priv->dp_port_num;
826         data[6] = (modem_signals&TIOCM_RTS) ?
827                 DIGI_RTS_ACTIVE : DIGI_RTS_INACTIVE;
828         data[7] = 0;
829
830         oob_port->write_urb->transfer_buffer_length = 8;
831         oob_port->write_urb->dev = port->serial->dev;
832
833         if( (ret=usb_submit_urb(oob_port->write_urb, GFP_ATOMIC)) == 0 ) {
834                 oob_priv->dp_write_urb_in_use = 1;
835                 port_priv->dp_modem_signals =
836                         (port_priv->dp_modem_signals&~(TIOCM_DTR|TIOCM_RTS))
837                         | (modem_signals&(TIOCM_DTR|TIOCM_RTS));
838         }
839
840         spin_unlock( &port_priv->dp_port_lock );
841         spin_unlock_irqrestore( &oob_priv->dp_port_lock, flags );
842
843         if( ret ) {
844                 err("%s: usb_submit_urb failed, ret=%d", __FUNCTION__,
845                 ret );
846         }
847
848         return( ret );
849
850 }
851
852
853 /*
854 *  Digi Transmit Idle
855 *
856 *  Digi transmit idle waits, up to timeout ticks, for the transmitter
857 *  to go idle.  It returns 0 if successful or a negative error.
858 *
859 *  There are race conditions here if more than one process is calling
860 *  digi_transmit_idle on the same port at the same time.  However, this
861 *  is only called from close, and only one process can be in close on a
862 *  port at a time, so its ok.
863 */
864
865 static int digi_transmit_idle( struct usb_serial_port *port,
866         unsigned long timeout )
867 {
868
869         int ret;
870         unsigned char buf[2];
871         struct digi_port *priv = usb_get_serial_port_data(port);
872         unsigned long flags = 0;
873
874
875         spin_lock_irqsave( &priv->dp_port_lock, flags );
876         priv->dp_transmit_idle = 0;
877         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
878
879         buf[0] = DIGI_CMD_TRANSMIT_IDLE;
880         buf[1] = 0;
881
882         timeout += jiffies;
883
884         if( (ret=digi_write_inb_command( port, buf, 2, timeout-jiffies )) != 0 )
885                 return( ret );
886
887         spin_lock_irqsave( &priv->dp_port_lock, flags );
888
889         while( time_before(jiffies, timeout) && !priv->dp_transmit_idle ) {
890                 cond_wait_interruptible_timeout_irqrestore(
891                         &priv->dp_transmit_idle_wait, DIGI_RETRY_TIMEOUT,
892                         &priv->dp_port_lock, flags );
893                 if( signal_pending(current) ) {
894                         return( -EINTR );
895                 }
896                 spin_lock_irqsave( &priv->dp_port_lock, flags );
897         }
898
899         priv->dp_transmit_idle = 0;
900         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
901
902         return( 0 );
903
904 }
905
906
907 static void digi_rx_throttle( struct usb_serial_port *port )
908 {
909
910         unsigned long flags;
911         struct digi_port *priv = usb_get_serial_port_data(port);
912
913
914 dbg( "digi_rx_throttle: TOP: port=%d", priv->dp_port_num );
915
916         /* stop receiving characters by not resubmitting the read urb */
917         spin_lock_irqsave( &priv->dp_port_lock, flags );
918         priv->dp_throttled = 1;
919         priv->dp_throttle_restart = 0;
920         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
921
922 }
923
924
925 static void digi_rx_unthrottle( struct usb_serial_port *port )
926 {
927
928         int ret = 0;
929         unsigned long flags;
930         struct digi_port *priv = usb_get_serial_port_data(port);
931
932 dbg( "digi_rx_unthrottle: TOP: port=%d", priv->dp_port_num );
933
934         spin_lock_irqsave( &priv->dp_port_lock, flags );
935
936         /* turn throttle off */
937         priv->dp_throttled = 0;
938         priv->dp_throttle_restart = 0;
939
940         /* restart read chain */
941         if( priv->dp_throttle_restart ) {
942                 port->read_urb->dev = port->serial->dev;
943                 ret = usb_submit_urb( port->read_urb, GFP_ATOMIC );
944         }
945
946         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
947
948         if( ret ) {
949                 err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
950                         ret, priv->dp_port_num );
951         }
952
953 }
954
955
956 static void digi_set_termios( struct usb_serial_port *port, 
957         struct ktermios *old_termios )
958 {
959
960         struct digi_port *priv = usb_get_serial_port_data(port);
961         unsigned int iflag = port->tty->termios->c_iflag;
962         unsigned int cflag = port->tty->termios->c_cflag;
963         unsigned int old_iflag = old_termios->c_iflag;
964         unsigned int old_cflag = old_termios->c_cflag;
965         unsigned char buf[32];
966         unsigned int modem_signals;
967         int arg,ret;
968         int i = 0;
969
970
971 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 );
972
973         /* set baud rate */
974         if( (cflag&CBAUD) != (old_cflag&CBAUD) ) {
975
976                 arg = -1;
977
978                 /* reassert DTR and (maybe) RTS on transition from B0 */
979                 if( (old_cflag&CBAUD) == B0 ) {
980                         /* don't set RTS if using hardware flow control */
981                         /* and throttling input */
982                         modem_signals = TIOCM_DTR;
983                         if( !(port->tty->termios->c_cflag & CRTSCTS) ||
984                         !test_bit(TTY_THROTTLED, &port->tty->flags) ) {
985                                 modem_signals |= TIOCM_RTS;
986                         }
987                         digi_set_modem_signals( port, modem_signals, 1 );
988                 }
989
990                 switch( (cflag&CBAUD) ) {
991                         /* drop DTR and RTS on transition to B0 */
992                 case B0: digi_set_modem_signals( port, 0, 1 ); break;
993                 case B50: arg = DIGI_BAUD_50; break;
994                 case B75: arg = DIGI_BAUD_75; break;
995                 case B110: arg = DIGI_BAUD_110; break;
996                 case B150: arg = DIGI_BAUD_150; break;
997                 case B200: arg = DIGI_BAUD_200; break;
998                 case B300: arg = DIGI_BAUD_300; break;
999                 case B600: arg = DIGI_BAUD_600; break;
1000                 case B1200: arg = DIGI_BAUD_1200; break;
1001                 case B1800: arg = DIGI_BAUD_1800; break;
1002                 case B2400: arg = DIGI_BAUD_2400; break;
1003                 case B4800: arg = DIGI_BAUD_4800; break;
1004                 case B9600: arg = DIGI_BAUD_9600; break;
1005                 case B19200: arg = DIGI_BAUD_19200; break;
1006                 case B38400: arg = DIGI_BAUD_38400; break;
1007                 case B57600: arg = DIGI_BAUD_57600; break;
1008                 case B115200: arg = DIGI_BAUD_115200; break;
1009                 case B230400: arg = DIGI_BAUD_230400; break;
1010                 case B460800: arg = DIGI_BAUD_460800; break;
1011                 default:
1012                         dbg( "digi_set_termios: can't handle baud rate 0x%x",
1013                                 (cflag&CBAUD) );
1014                         break;
1015                 }
1016
1017                 if( arg != -1 ) {
1018                         buf[i++] = DIGI_CMD_SET_BAUD_RATE;
1019                         buf[i++] = priv->dp_port_num;
1020                         buf[i++] = arg;
1021                         buf[i++] = 0;
1022                 }
1023
1024         }
1025
1026         /* set parity */
1027         if( (cflag&(PARENB|PARODD)) != (old_cflag&(PARENB|PARODD)) ) {
1028
1029                 if( (cflag&PARENB) ) {
1030                         if( (cflag&PARODD) )
1031                                 arg = DIGI_PARITY_ODD;
1032                         else
1033                                 arg = DIGI_PARITY_EVEN;
1034                 } else {
1035                         arg = DIGI_PARITY_NONE;
1036                 }
1037
1038                 buf[i++] = DIGI_CMD_SET_PARITY;
1039                 buf[i++] = priv->dp_port_num;
1040                 buf[i++] = arg;
1041                 buf[i++] = 0;
1042
1043         }
1044
1045         /* set word size */
1046         if( (cflag&CSIZE) != (old_cflag&CSIZE) ) {
1047
1048                 arg = -1;
1049
1050                 switch( (cflag&CSIZE) ) {
1051                 case CS5: arg = DIGI_WORD_SIZE_5; break;
1052                 case CS6: arg = DIGI_WORD_SIZE_6; break;
1053                 case CS7: arg = DIGI_WORD_SIZE_7; break;
1054                 case CS8: arg = DIGI_WORD_SIZE_8; break;
1055                 default:
1056                         dbg( "digi_set_termios: can't handle word size %d",
1057                                 (cflag&CSIZE) );
1058                         break;
1059                 }
1060
1061                 if( arg != -1 ) {
1062                         buf[i++] = DIGI_CMD_SET_WORD_SIZE;
1063                         buf[i++] = priv->dp_port_num;
1064                         buf[i++] = arg;
1065                         buf[i++] = 0;
1066                 }
1067
1068         }
1069
1070         /* set stop bits */
1071         if( (cflag&CSTOPB) != (old_cflag&CSTOPB) ) {
1072
1073                 if( (cflag&CSTOPB) )
1074                         arg = DIGI_STOP_BITS_2;
1075                 else
1076                         arg = DIGI_STOP_BITS_1;
1077
1078                 buf[i++] = DIGI_CMD_SET_STOP_BITS;
1079                 buf[i++] = priv->dp_port_num;
1080                 buf[i++] = arg;
1081                 buf[i++] = 0;
1082
1083         }
1084
1085         /* set input flow control */
1086         if( (iflag&IXOFF) != (old_iflag&IXOFF)
1087         || (cflag&CRTSCTS) != (old_cflag&CRTSCTS) ) {
1088
1089                 arg = 0;
1090
1091                 if( (iflag&IXOFF) )
1092                         arg |= DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
1093                 else
1094                         arg &= ~DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
1095
1096                 if( (cflag&CRTSCTS) ) {
1097
1098                         arg |= DIGI_INPUT_FLOW_CONTROL_RTS;
1099
1100                         /* On USB-4 it is necessary to assert RTS prior */
1101                         /* to selecting RTS input flow control.  */
1102                         buf[i++] = DIGI_CMD_SET_RTS_SIGNAL;
1103                         buf[i++] = priv->dp_port_num;
1104                         buf[i++] = DIGI_RTS_ACTIVE;
1105                         buf[i++] = 0;
1106
1107                 } else {
1108                         arg &= ~DIGI_INPUT_FLOW_CONTROL_RTS;
1109                 }
1110
1111                 buf[i++] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1112                 buf[i++] = priv->dp_port_num;
1113                 buf[i++] = arg;
1114                 buf[i++] = 0;
1115
1116         }
1117
1118         /* set output flow control */
1119         if( (iflag&IXON) != (old_iflag&IXON)
1120         || (cflag&CRTSCTS) != (old_cflag&CRTSCTS) ) {
1121
1122                 arg = 0;
1123
1124                 if( (iflag&IXON) )
1125                         arg |= DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
1126                 else
1127                         arg &= ~DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
1128
1129                 if( (cflag&CRTSCTS) ) {
1130                         arg |= DIGI_OUTPUT_FLOW_CONTROL_CTS;
1131                 } else {
1132                         arg &= ~DIGI_OUTPUT_FLOW_CONTROL_CTS;
1133                         port->tty->hw_stopped = 0;
1134                 }
1135
1136                 buf[i++] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1137                 buf[i++] = priv->dp_port_num;
1138                 buf[i++] = arg;
1139                 buf[i++] = 0;
1140
1141         }
1142
1143         /* set receive enable/disable */
1144         if( (cflag&CREAD) != (old_cflag&CREAD) ) {
1145
1146                 if( (cflag&CREAD) )
1147                         arg = DIGI_ENABLE;
1148                 else
1149                         arg = DIGI_DISABLE;
1150
1151                 buf[i++] = DIGI_CMD_RECEIVE_ENABLE;
1152                 buf[i++] = priv->dp_port_num;
1153                 buf[i++] = arg;
1154                 buf[i++] = 0;
1155
1156         }
1157
1158         if( (ret=digi_write_oob_command( port, buf, i, 1 )) != 0 )
1159                 dbg( "digi_set_termios: write oob failed, ret=%d", ret );
1160
1161 }
1162
1163
1164 static void digi_break_ctl( struct usb_serial_port *port, int break_state )
1165 {
1166
1167         unsigned char buf[4];
1168
1169
1170         buf[0] = DIGI_CMD_BREAK_CONTROL;
1171         buf[1] = 2;                             /* length */
1172         buf[2] = break_state ? 1 : 0;
1173         buf[3] = 0;                             /* pad */
1174
1175         digi_write_inb_command( port, buf, 4, 0 );
1176
1177 }
1178
1179
1180 static int digi_tiocmget( struct usb_serial_port *port, struct file *file )
1181 {
1182         struct digi_port *priv = usb_get_serial_port_data(port);
1183         unsigned int val;
1184         unsigned long flags;
1185
1186         dbg("%s: TOP: port=%d", __FUNCTION__, priv->dp_port_num);
1187
1188         spin_lock_irqsave( &priv->dp_port_lock, flags );
1189         val = priv->dp_modem_signals;
1190         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1191         return val;
1192 }
1193
1194
1195 static int digi_tiocmset( struct usb_serial_port *port, struct file *file,
1196         unsigned int set, unsigned int clear )
1197 {
1198         struct digi_port *priv = usb_get_serial_port_data(port);
1199         unsigned int val;
1200         unsigned long flags;
1201
1202         dbg("%s: TOP: port=%d", __FUNCTION__, priv->dp_port_num);
1203
1204         spin_lock_irqsave( &priv->dp_port_lock, flags );
1205         val = (priv->dp_modem_signals & ~clear) | set;
1206         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1207         return digi_set_modem_signals( port, val, 1 );
1208 }
1209
1210
1211 static int digi_ioctl( struct usb_serial_port *port, struct file *file,
1212         unsigned int cmd, unsigned long arg )
1213 {
1214
1215         struct digi_port *priv = usb_get_serial_port_data(port);
1216
1217 dbg( "digi_ioctl: TOP: port=%d, cmd=0x%x", priv->dp_port_num, cmd );
1218
1219         switch (cmd) {
1220
1221         case TIOCMIWAIT:
1222                 /* wait for any of the 4 modem inputs (DCD,RI,DSR,CTS)*/
1223                 /* TODO */
1224                 return( 0 );
1225
1226         case TIOCGICOUNT:
1227                 /* return count of modemline transitions */
1228                 /* TODO */
1229                 return 0;
1230
1231         }
1232
1233         return( -ENOIOCTLCMD );
1234
1235 }
1236
1237
1238 static int digi_write( struct usb_serial_port *port, const unsigned char *buf, int count )
1239 {
1240
1241         int ret,data_len,new_len;
1242         struct digi_port *priv = usb_get_serial_port_data(port);
1243         unsigned char *data = port->write_urb->transfer_buffer;
1244         unsigned long flags = 0;
1245
1246
1247 dbg( "digi_write: TOP: port=%d, count=%d, in_interrupt=%ld",
1248 priv->dp_port_num, count, in_interrupt() );
1249
1250         /* copy user data (which can sleep) before getting spin lock */
1251         count = min( count, port->bulk_out_size-2 );
1252         count = min( 64, count);
1253
1254         /* be sure only one write proceeds at a time */
1255         /* there are races on the port private buffer */
1256         /* and races to check write_urb->status */
1257         spin_lock_irqsave( &priv->dp_port_lock, flags );
1258
1259         /* wait for urb status clear to submit another urb */
1260         if( port->write_urb->status == -EINPROGRESS
1261         || priv->dp_write_urb_in_use ) {
1262
1263                 /* buffer data if count is 1 (probably put_char) if possible */
1264                 if( count == 1 && priv->dp_out_buf_len < DIGI_OUT_BUF_SIZE ) {
1265                         priv->dp_out_buf[priv->dp_out_buf_len++] = *buf;
1266                         new_len = 1;
1267                 } else {
1268                         new_len = 0;
1269                 }
1270
1271                 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1272
1273                 return( new_len );
1274
1275         }
1276
1277         /* allow space for any buffered data and for new data, up to */
1278         /* transfer buffer size - 2 (for command and length bytes) */
1279         new_len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
1280         data_len = new_len + priv->dp_out_buf_len;
1281
1282         if( data_len == 0 ) {
1283                 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1284                 return( 0 );
1285         }
1286
1287         port->write_urb->transfer_buffer_length = data_len+2;
1288         port->write_urb->dev = port->serial->dev;
1289
1290         *data++ = DIGI_CMD_SEND_DATA;
1291         *data++ = data_len;
1292
1293         /* copy in buffered data first */
1294         memcpy( data, priv->dp_out_buf, priv->dp_out_buf_len );
1295         data += priv->dp_out_buf_len;
1296
1297         /* copy in new data */
1298         memcpy( data, buf, new_len );
1299
1300         if( (ret=usb_submit_urb(port->write_urb, GFP_ATOMIC)) == 0 ) {
1301                 priv->dp_write_urb_in_use = 1;
1302                 ret = new_len;
1303                 priv->dp_out_buf_len = 0;
1304         }
1305
1306         /* return length of new data written, or error */
1307         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1308         if( ret < 0 ) {
1309                 err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
1310                         ret, priv->dp_port_num );
1311         }
1312
1313 dbg( "digi_write: returning %d", ret );
1314         return( ret );
1315
1316
1317
1318
1319 static void digi_write_bulk_callback( struct urb *urb )
1320 {
1321
1322         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1323         struct usb_serial *serial;
1324         struct digi_port *priv;
1325         struct digi_serial *serial_priv;
1326         int ret = 0;
1327         int status = urb->status;
1328
1329
1330         dbg("digi_write_bulk_callback: TOP, urb status=%d", status);
1331
1332         /* port and serial sanity check */
1333         if( port == NULL || (priv=usb_get_serial_port_data(port)) == NULL ) {
1334                 err("%s: port or port->private is NULL, status=%d",
1335                     __FUNCTION__, status);
1336                 return;
1337         }
1338         serial = port->serial;
1339         if( serial == NULL || (serial_priv=usb_get_serial_data(serial)) == NULL ) {
1340                 err("%s: serial or serial->private is NULL, status=%d",
1341                     __FUNCTION__, status);
1342                 return;
1343         }
1344
1345         /* handle oob callback */
1346         if( priv->dp_port_num == serial_priv->ds_oob_port_num ) {
1347                 dbg( "digi_write_bulk_callback: oob callback" );
1348                 spin_lock( &priv->dp_port_lock );
1349                 priv->dp_write_urb_in_use = 0;
1350                 wake_up_interruptible( &port->write_wait );
1351                 spin_unlock( &priv->dp_port_lock );
1352                 return;
1353         }
1354
1355         /* try to send any buffered data on this port, if it is open */
1356         spin_lock( &priv->dp_port_lock );
1357         priv->dp_write_urb_in_use = 0;
1358         if( port->open_count && port->write_urb->status != -EINPROGRESS
1359         && priv->dp_out_buf_len > 0 ) {
1360
1361                 *((unsigned char *)(port->write_urb->transfer_buffer))
1362                         = (unsigned char)DIGI_CMD_SEND_DATA;
1363                 *((unsigned char *)(port->write_urb->transfer_buffer)+1)
1364                         = (unsigned char)priv->dp_out_buf_len;
1365
1366                 port->write_urb->transfer_buffer_length
1367                         = priv->dp_out_buf_len+2;
1368                 port->write_urb->dev = serial->dev;
1369
1370                 memcpy( port->write_urb->transfer_buffer+2, priv->dp_out_buf,
1371                         priv->dp_out_buf_len );
1372
1373                 if( (ret=usb_submit_urb(port->write_urb, GFP_ATOMIC)) == 0 ) {
1374                         priv->dp_write_urb_in_use = 1;
1375                         priv->dp_out_buf_len = 0;
1376                 }
1377
1378         }
1379
1380         /* wake up processes sleeping on writes immediately */
1381         digi_wakeup_write( port );
1382
1383         /* also queue up a wakeup at scheduler time, in case we */
1384         /* lost the race in write_chan(). */
1385         schedule_work(&priv->dp_wakeup_work);
1386
1387         spin_unlock( &priv->dp_port_lock );
1388
1389         if( ret ) {
1390                 err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
1391                         ret, priv->dp_port_num );
1392         }
1393
1394 }
1395
1396
1397 static int digi_write_room( struct usb_serial_port *port )
1398 {
1399
1400         int room;
1401         struct digi_port *priv = usb_get_serial_port_data(port);
1402         unsigned long flags = 0;
1403
1404
1405         spin_lock_irqsave( &priv->dp_port_lock, flags );
1406
1407         if( port->write_urb->status == -EINPROGRESS
1408         || priv->dp_write_urb_in_use )
1409                 room = 0;
1410         else
1411                 room = port->bulk_out_size - 2 - priv->dp_out_buf_len;
1412
1413         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1414
1415 dbg( "digi_write_room: port=%d, room=%d", priv->dp_port_num, room );
1416         return( room );
1417
1418 }
1419
1420
1421 static int digi_chars_in_buffer( struct usb_serial_port *port )
1422 {
1423
1424         struct digi_port *priv = usb_get_serial_port_data(port);
1425
1426
1427         if( port->write_urb->status == -EINPROGRESS
1428         || priv->dp_write_urb_in_use ) {
1429 dbg( "digi_chars_in_buffer: port=%d, chars=%d", priv->dp_port_num, port->bulk_out_size - 2 );
1430                 /* return( port->bulk_out_size - 2 ); */
1431                 return( 256 );
1432         } else {
1433 dbg( "digi_chars_in_buffer: port=%d, chars=%d", priv->dp_port_num, priv->dp_out_buf_len );
1434                 return( priv->dp_out_buf_len );
1435         }
1436
1437 }
1438
1439
1440 static int digi_open( struct usb_serial_port *port, struct file *filp )
1441 {
1442
1443         int ret;
1444         unsigned char buf[32];
1445         struct digi_port *priv = usb_get_serial_port_data(port);
1446         struct ktermios not_termios;
1447         unsigned long flags = 0;
1448
1449
1450 dbg( "digi_open: TOP: port=%d, open_count=%d", priv->dp_port_num, port->open_count );
1451
1452         /* be sure the device is started up */
1453         if( digi_startup_device( port->serial ) != 0 )
1454                 return( -ENXIO );
1455
1456         spin_lock_irqsave( &priv->dp_port_lock, flags );
1457
1458         /* don't wait on a close in progress for non-blocking opens */
1459         if( priv->dp_in_close && (filp->f_flags&(O_NDELAY|O_NONBLOCK)) == 0 ) {
1460                 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1461                 return( -EAGAIN );
1462         }
1463
1464         /* wait for a close in progress to finish */
1465         while( priv->dp_in_close ) {
1466                 cond_wait_interruptible_timeout_irqrestore(
1467                         &priv->dp_close_wait, DIGI_RETRY_TIMEOUT,
1468                         &priv->dp_port_lock, flags );
1469                 if( signal_pending(current) ) {
1470                         return( -EINTR );
1471                 }
1472                 spin_lock_irqsave( &priv->dp_port_lock, flags );
1473         }
1474
1475         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1476  
1477         /* read modem signals automatically whenever they change */
1478         buf[0] = DIGI_CMD_READ_INPUT_SIGNALS;
1479         buf[1] = priv->dp_port_num;
1480         buf[2] = DIGI_ENABLE;
1481         buf[3] = 0;
1482
1483         /* flush fifos */
1484         buf[4] = DIGI_CMD_IFLUSH_FIFO;
1485         buf[5] = priv->dp_port_num;
1486         buf[6] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1487         buf[7] = 0;
1488
1489         if( (ret=digi_write_oob_command( port, buf, 8, 1 )) != 0 )
1490                 dbg( "digi_open: write oob failed, ret=%d", ret );
1491
1492         /* set termios settings */
1493         not_termios.c_cflag = ~port->tty->termios->c_cflag;
1494         not_termios.c_iflag = ~port->tty->termios->c_iflag;
1495         digi_set_termios( port, &not_termios );
1496
1497         /* set DTR and RTS */
1498         digi_set_modem_signals( port, TIOCM_DTR|TIOCM_RTS, 1 );
1499
1500         return( 0 );
1501
1502 }
1503
1504
1505 static void digi_close( struct usb_serial_port *port, struct file *filp )
1506 {
1507         DEFINE_WAIT(wait);
1508         int ret;
1509         unsigned char buf[32];
1510         struct tty_struct *tty = port->tty;
1511         struct digi_port *priv = usb_get_serial_port_data(port);
1512         unsigned long flags = 0;
1513
1514
1515 dbg( "digi_close: TOP: port=%d, open_count=%d", priv->dp_port_num, port->open_count );
1516
1517
1518         /* if disconnected, just clear flags */
1519         if (!usb_get_intfdata(port->serial->interface))
1520                 goto exit;
1521
1522         /* do cleanup only after final close on this port */
1523         spin_lock_irqsave( &priv->dp_port_lock, flags );
1524         priv->dp_in_close = 1;
1525         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1526
1527         /* tell line discipline to process only XON/XOFF */
1528         tty->closing = 1;
1529
1530         /* wait for output to drain */
1531         if( (filp->f_flags&(O_NDELAY|O_NONBLOCK)) == 0 ) {
1532                 tty_wait_until_sent( tty, DIGI_CLOSE_TIMEOUT );
1533         }
1534
1535         /* flush driver and line discipline buffers */
1536         if( tty->driver->flush_buffer )
1537                 tty->driver->flush_buffer( tty );
1538         tty_ldisc_flush(tty);
1539
1540         if (port->serial->dev) {
1541                 /* wait for transmit idle */
1542                 if( (filp->f_flags&(O_NDELAY|O_NONBLOCK)) == 0 ) {
1543                         digi_transmit_idle( port, DIGI_CLOSE_TIMEOUT );
1544                 }
1545
1546                 /* drop DTR and RTS */
1547                 digi_set_modem_signals( port, 0, 0 );
1548
1549                 /* disable input flow control */
1550                 buf[0] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1551                 buf[1] = priv->dp_port_num;
1552                 buf[2] = DIGI_DISABLE;
1553                 buf[3] = 0;
1554
1555                 /* disable output flow control */
1556                 buf[4] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1557                 buf[5] = priv->dp_port_num;
1558                 buf[6] = DIGI_DISABLE;
1559                 buf[7] = 0;
1560
1561                 /* disable reading modem signals automatically */
1562                 buf[8] = DIGI_CMD_READ_INPUT_SIGNALS;
1563                 buf[9] = priv->dp_port_num;
1564                 buf[10] = DIGI_DISABLE;
1565                 buf[11] = 0;
1566
1567                 /* disable receive */
1568                 buf[12] = DIGI_CMD_RECEIVE_ENABLE;
1569                 buf[13] = priv->dp_port_num;
1570                 buf[14] = DIGI_DISABLE;
1571                 buf[15] = 0;
1572
1573                 /* flush fifos */
1574                 buf[16] = DIGI_CMD_IFLUSH_FIFO;
1575                 buf[17] = priv->dp_port_num;
1576                 buf[18] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1577                 buf[19] = 0;
1578
1579                 if( (ret=digi_write_oob_command( port, buf, 20, 0 )) != 0 )
1580                         dbg( "digi_close: write oob failed, ret=%d", ret );
1581
1582                 /* wait for final commands on oob port to complete */
1583                 prepare_to_wait(&priv->dp_flush_wait, &wait, TASK_INTERRUPTIBLE);
1584                 schedule_timeout(DIGI_CLOSE_TIMEOUT);
1585                 finish_wait(&priv->dp_flush_wait, &wait);
1586
1587                 /* shutdown any outstanding bulk writes */
1588                 usb_kill_urb(port->write_urb);
1589         }
1590
1591         tty->closing = 0;
1592
1593 exit:
1594         spin_lock_irqsave( &priv->dp_port_lock, flags );
1595         priv->dp_write_urb_in_use = 0;
1596         priv->dp_in_close = 0;
1597         wake_up_interruptible( &priv->dp_close_wait );
1598         spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1599
1600 dbg( "digi_close: done" );
1601 }
1602
1603
1604 /*
1605 *  Digi Startup Device
1606 *
1607 *  Starts reads on all ports.  Must be called AFTER startup, with
1608 *  urbs initialized.  Returns 0 if successful, non-zero error otherwise.
1609 */
1610
1611 static int digi_startup_device( struct usb_serial *serial )
1612 {
1613
1614         int i,ret = 0;
1615         struct digi_serial *serial_priv = usb_get_serial_data(serial);
1616         struct usb_serial_port *port;
1617
1618
1619         /* be sure this happens exactly once */
1620         spin_lock( &serial_priv->ds_serial_lock );
1621         if( serial_priv->ds_device_started ) {
1622                 spin_unlock( &serial_priv->ds_serial_lock );
1623                 return( 0 );
1624         }
1625         serial_priv->ds_device_started = 1;
1626         spin_unlock( &serial_priv->ds_serial_lock );
1627
1628         /* start reading from each bulk in endpoint for the device */
1629         /* set USB_DISABLE_SPD flag for write bulk urbs */
1630         for( i=0; i<serial->type->num_ports+1; i++ ) {
1631
1632                 port = serial->port[i];
1633
1634                 port->write_urb->dev = port->serial->dev;
1635
1636                 if( (ret=usb_submit_urb(port->read_urb, GFP_KERNEL)) != 0 ) {
1637                         err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
1638                         ret, i );
1639                         break;
1640                 }
1641
1642         }
1643
1644         return( ret );
1645
1646 }
1647
1648
1649 static int digi_startup( struct usb_serial *serial )
1650 {
1651
1652         int i;
1653         struct digi_port *priv;
1654         struct digi_serial *serial_priv;
1655
1656
1657 dbg( "digi_startup: TOP" );
1658
1659         /* allocate the private data structures for all ports */
1660         /* number of regular ports + 1 for the out-of-band port */
1661         for( i=0; i<serial->type->num_ports+1; i++ ) {
1662
1663                 /* allocate port private structure */
1664                 priv = kmalloc( sizeof(struct digi_port),
1665                         GFP_KERNEL );
1666                 if( priv == (struct digi_port *)0 ) {
1667                         while( --i >= 0 )
1668                                 kfree( usb_get_serial_port_data(serial->port[i]) );
1669                         return( 1 );                    /* error */
1670                 }
1671
1672                 /* initialize port private structure */
1673                 spin_lock_init( &priv->dp_port_lock );
1674                 priv->dp_port_num = i;
1675                 priv->dp_out_buf_len = 0;
1676                 priv->dp_write_urb_in_use = 0;
1677                 priv->dp_modem_signals = 0;
1678                 init_waitqueue_head( &priv->dp_modem_change_wait );
1679                 priv->dp_transmit_idle = 0;
1680                 init_waitqueue_head( &priv->dp_transmit_idle_wait );
1681                 priv->dp_throttled = 0;
1682                 priv->dp_throttle_restart = 0;
1683                 init_waitqueue_head( &priv->dp_flush_wait );
1684                 priv->dp_in_close = 0;
1685                 init_waitqueue_head( &priv->dp_close_wait );
1686                 INIT_WORK(&priv->dp_wakeup_work, digi_wakeup_write_lock);
1687                 priv->dp_port = serial->port[i];
1688
1689                 /* initialize write wait queue for this port */
1690                 init_waitqueue_head( &serial->port[i]->write_wait );
1691
1692                 usb_set_serial_port_data(serial->port[i], priv);
1693         }
1694
1695         /* allocate serial private structure */
1696         serial_priv = kmalloc( sizeof(struct digi_serial),
1697                 GFP_KERNEL );
1698         if( serial_priv == (struct digi_serial *)0 ) {
1699                 for( i=0; i<serial->type->num_ports+1; i++ )
1700                         kfree( usb_get_serial_port_data(serial->port[i]) );
1701                 return( 1 );                    /* error */
1702         }
1703
1704         /* initialize serial private structure */
1705         spin_lock_init( &serial_priv->ds_serial_lock );
1706         serial_priv->ds_oob_port_num = serial->type->num_ports;
1707         serial_priv->ds_oob_port = serial->port[serial_priv->ds_oob_port_num];
1708         serial_priv->ds_device_started = 0;
1709         usb_set_serial_data(serial, serial_priv);
1710
1711         return( 0 );
1712
1713 }
1714
1715
1716 static void digi_shutdown( struct usb_serial *serial )
1717 {
1718
1719         int i;
1720
1721
1722 dbg( "digi_shutdown: TOP, in_interrupt()=%ld", in_interrupt() );
1723
1724         /* stop reads and writes on all ports */
1725         for( i=0; i<serial->type->num_ports+1; i++ ) {
1726                 usb_kill_urb(serial->port[i]->read_urb);
1727                 usb_kill_urb(serial->port[i]->write_urb);
1728         }
1729
1730         /* free the private data structures for all ports */
1731         /* number of regular ports + 1 for the out-of-band port */
1732         for( i=0; i<serial->type->num_ports+1; i++ )
1733                 kfree( usb_get_serial_port_data(serial->port[i]) );
1734         kfree( usb_get_serial_data(serial) );
1735 }
1736
1737
1738 static void digi_read_bulk_callback( struct urb *urb )
1739 {
1740
1741         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1742         struct digi_port *priv;
1743         struct digi_serial *serial_priv;
1744         int ret;
1745         int status = urb->status;
1746
1747
1748 dbg( "digi_read_bulk_callback: TOP" );
1749
1750         /* port sanity check, do not resubmit if port is not valid */
1751         if( port == NULL || (priv=usb_get_serial_port_data(port)) == NULL ) {
1752                 err("%s: port or port->private is NULL, status=%d",
1753                     __FUNCTION__, status);
1754                 return;
1755         }
1756         if( port->serial == NULL
1757         || (serial_priv=usb_get_serial_data(port->serial)) == NULL ) {
1758                 err("%s: serial is bad or serial->private is NULL, status=%d",
1759                     __FUNCTION__, status);
1760                 return;
1761         }
1762
1763         /* do not resubmit urb if it has any status error */
1764         if (status) {
1765                 err("%s: nonzero read bulk status: status=%d, port=%d",
1766                     __FUNCTION__, status, priv->dp_port_num);
1767                 return;
1768         }
1769
1770         /* handle oob or inb callback, do not resubmit if error */
1771         if( priv->dp_port_num == serial_priv->ds_oob_port_num ) {
1772                 if( digi_read_oob_callback( urb ) != 0 )
1773                         return;
1774         } else {
1775                 if( digi_read_inb_callback( urb ) != 0 )
1776                         return;
1777         }
1778
1779         /* continue read */
1780         urb->dev = port->serial->dev;
1781         if( (ret=usb_submit_urb(urb, GFP_ATOMIC)) != 0 ) {
1782                 err("%s: failed resubmitting urb, ret=%d, port=%d", __FUNCTION__,
1783                         ret, priv->dp_port_num );
1784         }
1785
1786 }
1787
1788
1789 /* 
1790 *  Digi Read INB Callback
1791 *
1792 *  Digi Read INB Callback handles reads on the in band ports, sending
1793 *  the data on to the tty subsystem.  When called we know port and
1794 *  port->private are not NULL and port->serial has been validated.
1795 *  It returns 0 if successful, 1 if successful but the port is
1796 *  throttled, and -1 if the sanity checks failed.
1797 */
1798
1799 static int digi_read_inb_callback( struct urb *urb )
1800 {
1801
1802         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1803         struct tty_struct *tty = port->tty;
1804         struct digi_port *priv = usb_get_serial_port_data(port);
1805         int opcode = ((unsigned char *)urb->transfer_buffer)[0];
1806         int len = ((unsigned char *)urb->transfer_buffer)[1];
1807         int port_status = ((unsigned char *)urb->transfer_buffer)[2];
1808         unsigned char *data = ((unsigned char *)urb->transfer_buffer)+3;
1809         int flag,throttled;
1810         int i;
1811         int status = urb->status;
1812
1813         /* do not process callbacks on closed ports */
1814         /* but do continue the read chain */
1815         if( port->open_count == 0 )
1816                 return( 0 );
1817
1818         /* short/multiple packet check */
1819         if( urb->actual_length != len + 2 ) {
1820                 err("%s: INCOMPLETE OR MULTIPLE PACKET, urb status=%d, "
1821                     "port=%d, opcode=%d, len=%d, actual_length=%d, "
1822                     "port_status=%d", __FUNCTION__, status, priv->dp_port_num,
1823                     opcode, len, urb->actual_length, port_status);
1824                 return( -1 );
1825         }
1826
1827         spin_lock( &priv->dp_port_lock );
1828
1829         /* check for throttle; if set, do not resubmit read urb */
1830         /* indicate the read chain needs to be restarted on unthrottle */
1831         throttled = priv->dp_throttled;
1832         if( throttled )
1833                 priv->dp_throttle_restart = 1;
1834
1835         /* receive data */
1836         if( opcode == DIGI_CMD_RECEIVE_DATA ) {
1837
1838                 /* get flag from port_status */
1839                 flag = 0;
1840
1841                 /* overrun is special, not associated with a char */
1842                 if (port_status & DIGI_OVERRUN_ERROR) {
1843                         tty_insert_flip_char( tty, 0, TTY_OVERRUN );
1844                 }
1845
1846                 /* break takes precedence over parity, */
1847                 /* which takes precedence over framing errors */
1848                 if (port_status & DIGI_BREAK_ERROR) {
1849                         flag = TTY_BREAK;
1850                 } else if (port_status & DIGI_PARITY_ERROR) {
1851                         flag = TTY_PARITY;
1852                 } else if (port_status & DIGI_FRAMING_ERROR) {
1853                         flag = TTY_FRAME;
1854                 }
1855
1856                 /* data length is len-1 (one byte of len is port_status) */
1857                 --len;
1858
1859                 len = tty_buffer_request_room(tty, len);
1860                 if( len > 0 ) {
1861                         /* Hot path */
1862                         if(flag == TTY_NORMAL)
1863                                 tty_insert_flip_string(tty, data, len);
1864                         else {
1865                                 for(i = 0; i < len; i++)
1866                                         tty_insert_flip_char(tty, data[i], flag);
1867                         }
1868                         tty_flip_buffer_push( tty );
1869                 }
1870         }
1871
1872         spin_unlock( &priv->dp_port_lock );
1873
1874         if( opcode == DIGI_CMD_RECEIVE_DISABLE ) {
1875                 dbg("%s: got RECEIVE_DISABLE", __FUNCTION__ );
1876         } else if( opcode != DIGI_CMD_RECEIVE_DATA ) {
1877                 dbg("%s: unknown opcode: %d", __FUNCTION__, opcode );
1878         }
1879
1880         return( throttled ? 1 : 0 );
1881
1882 }
1883
1884
1885 /* 
1886 *  Digi Read OOB Callback
1887 *
1888 *  Digi Read OOB Callback handles reads on the out of band port.
1889 *  When called we know port and port->private are not NULL and
1890 *  the port->serial is valid.  It returns 0 if successful, and
1891 *  -1 if the sanity checks failed.
1892 */
1893
1894 static int digi_read_oob_callback( struct urb *urb )
1895 {
1896
1897         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1898         struct usb_serial *serial = port->serial;
1899         struct digi_port *priv = usb_get_serial_port_data(port);
1900         int opcode, line, status, val;
1901         int i;
1902
1903
1904 dbg( "digi_read_oob_callback: port=%d, len=%d", priv->dp_port_num,
1905 urb->actual_length );
1906
1907         /* handle each oob command */
1908         for( i=0; i<urb->actual_length-3; ) {
1909
1910                 opcode = ((unsigned char *)urb->transfer_buffer)[i++];
1911                 line = ((unsigned char *)urb->transfer_buffer)[i++];
1912                 status = ((unsigned char *)urb->transfer_buffer)[i++];
1913                 val = ((unsigned char *)urb->transfer_buffer)[i++];
1914
1915 dbg( "digi_read_oob_callback: opcode=%d, line=%d, status=%d, val=%d",
1916 opcode, line, status, val );
1917
1918                 if( status != 0 || line >= serial->type->num_ports )
1919                         continue;
1920
1921                 port = serial->port[line];
1922
1923                 if ((priv=usb_get_serial_port_data(port)) == NULL )
1924                         return -1;
1925
1926                 if( opcode == DIGI_CMD_READ_INPUT_SIGNALS ) {
1927
1928                         spin_lock( &priv->dp_port_lock );
1929
1930                         /* convert from digi flags to termiox flags */
1931                         if( val & DIGI_READ_INPUT_SIGNALS_CTS ) {
1932                                 priv->dp_modem_signals |= TIOCM_CTS;
1933                                 /* port must be open to use tty struct */
1934                                 if( port->open_count
1935                                 && port->tty->termios->c_cflag & CRTSCTS ) {
1936                                         port->tty->hw_stopped = 0;
1937                                         digi_wakeup_write( port );
1938                                 }
1939                         } else {
1940                                 priv->dp_modem_signals &= ~TIOCM_CTS;
1941                                 /* port must be open to use tty struct */
1942                                 if( port->open_count
1943                                 && port->tty->termios->c_cflag & CRTSCTS ) {
1944                                         port->tty->hw_stopped = 1;
1945                                 }
1946                         }
1947                         if( val & DIGI_READ_INPUT_SIGNALS_DSR )
1948                                 priv->dp_modem_signals |= TIOCM_DSR;
1949                         else
1950                                 priv->dp_modem_signals &= ~TIOCM_DSR;
1951                         if( val & DIGI_READ_INPUT_SIGNALS_RI )
1952                                 priv->dp_modem_signals |= TIOCM_RI;
1953                         else
1954                                 priv->dp_modem_signals &= ~TIOCM_RI;
1955                         if( val & DIGI_READ_INPUT_SIGNALS_DCD )
1956                                 priv->dp_modem_signals |= TIOCM_CD;
1957                         else
1958                                 priv->dp_modem_signals &= ~TIOCM_CD;
1959
1960                         wake_up_interruptible( &priv->dp_modem_change_wait );
1961                         spin_unlock( &priv->dp_port_lock );
1962
1963                 } else if( opcode == DIGI_CMD_TRANSMIT_IDLE ) {
1964
1965                         spin_lock( &priv->dp_port_lock );
1966                         priv->dp_transmit_idle = 1;
1967                         wake_up_interruptible( &priv->dp_transmit_idle_wait );
1968                         spin_unlock( &priv->dp_port_lock );
1969
1970                 } else if( opcode == DIGI_CMD_IFLUSH_FIFO ) {
1971
1972                         wake_up_interruptible( &priv->dp_flush_wait );
1973
1974                 }
1975
1976         }
1977
1978         return( 0 );
1979
1980 }
1981
1982
1983 static int __init digi_init (void)
1984 {
1985         int retval;
1986         retval = usb_serial_register(&digi_acceleport_2_device);
1987         if (retval)
1988                 goto failed_acceleport_2_device;
1989         retval = usb_serial_register(&digi_acceleport_4_device);
1990         if (retval) 
1991                 goto failed_acceleport_4_device;
1992         retval = usb_register(&digi_driver);
1993         if (retval)
1994                 goto failed_usb_register;
1995         info(DRIVER_VERSION ":" DRIVER_DESC);
1996         return 0;
1997 failed_usb_register:
1998         usb_serial_deregister(&digi_acceleport_4_device);
1999 failed_acceleport_4_device:
2000         usb_serial_deregister(&digi_acceleport_2_device);
2001 failed_acceleport_2_device:
2002         return retval;
2003 }
2004
2005
2006 static void __exit digi_exit (void)
2007 {
2008         usb_deregister (&digi_driver);
2009         usb_serial_deregister (&digi_acceleport_2_device);
2010         usb_serial_deregister (&digi_acceleport_4_device);
2011 }
2012
2013
2014 module_init(digi_init);
2015 module_exit(digi_exit);
2016
2017
2018 MODULE_AUTHOR( DRIVER_AUTHOR );
2019 MODULE_DESCRIPTION( DRIVER_DESC );
2020 MODULE_LICENSE("GPL");
2021
2022 module_param(debug, bool, S_IRUGO | S_IWUSR);
2023 MODULE_PARM_DESC(debug, "Debug enabled or not");