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