2 * Digi AccelePort USB-4 and USB-2 Serial Converters
4 * Copyright 2000 by Digi International
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.
11 * Shamelessly based on Brian Warner's keyspan_pda.c and Greg Kroah-Hartman's
14 * Peter Berger (pberger@brimson.com)
15 * Al Borchers (borchers@steinerpoint.com)
18 * switched to using port->open_count instead of private version.
19 * Removed port->active
22 * Identify version on module load.
24 * (11/01/2000) Adam J. Richter
25 * usb_device_id table support
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.
35 * -- Fixed bug with urb->dev not being set properly, now that the usb
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
50 * -- Added code for rx_throttle and rx_unthrottle so that input flow
52 * -- Added code to set overrun, parity, framing, and break errors
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.
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.
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.
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.
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.
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
110 * -- Initialized ret value to 0 in write_bulk_callback, otherwise
111 * the uninitialized value could cause a spurious debugging message.
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.
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.
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
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.
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
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).
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.
202 * (5/3/2000) pberger and borchers
203 * -- First alpha version of the driver--many known limitations and bugs.
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
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
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.
233 * $Id: digi_acceleport.c,v 1.80.1.2 2000/11/02 05:45:08 root Exp $
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>
250 #ifdef CONFIG_USB_SERIAL_DEBUG
251 static int debug = 1;
256 #include "usb-serial.h"
262 * Version Information
264 #define DRIVER_VERSION "v1.80.1.2"
265 #define DRIVER_AUTHOR "Peter Berger <pberger@brimson.com>, Al Borchers <borchers@steinerpoint.com>"
266 #define DRIVER_DESC "Digi AccelePort USB-2/USB-4 Serial Converter driver"
268 /* port output buffer length -- must be <= transfer buffer length - 2 */
269 /* so we can be sure to send the full buffer in one urb */
270 #define DIGI_OUT_BUF_SIZE 8
272 /* port input buffer length -- must be >= transfer buffer length - 3 */
273 /* so we can be sure to hold at least one full buffer from one urb */
274 #define DIGI_IN_BUF_SIZE 64
276 /* retry timeout while sleeping */
277 #define DIGI_RETRY_TIMEOUT (HZ/10)
279 /* timeout while waiting for tty output to drain in close */
280 /* this delay is used twice in close, so the total delay could */
281 /* be twice this value */
282 #define DIGI_CLOSE_TIMEOUT (5*HZ)
285 /* AccelePort USB Defines */
288 #define DIGI_VENDOR_ID 0x05c5
289 #define DIGI_2_ID 0x0002 /* USB-2 */
290 #define DIGI_4_ID 0x0004 /* USB-4 */
293 * "INB": can be used on the in-band endpoint
294 * "OOB": can be used on the out-of-band endpoint
296 #define DIGI_CMD_SET_BAUD_RATE 0 /* INB, OOB */
297 #define DIGI_CMD_SET_WORD_SIZE 1 /* INB, OOB */
298 #define DIGI_CMD_SET_PARITY 2 /* INB, OOB */
299 #define DIGI_CMD_SET_STOP_BITS 3 /* INB, OOB */
300 #define DIGI_CMD_SET_INPUT_FLOW_CONTROL 4 /* INB, OOB */
301 #define DIGI_CMD_SET_OUTPUT_FLOW_CONTROL 5 /* INB, OOB */
302 #define DIGI_CMD_SET_DTR_SIGNAL 6 /* INB, OOB */
303 #define DIGI_CMD_SET_RTS_SIGNAL 7 /* INB, OOB */
304 #define DIGI_CMD_READ_INPUT_SIGNALS 8 /* OOB */
305 #define DIGI_CMD_IFLUSH_FIFO 9 /* OOB */
306 #define DIGI_CMD_RECEIVE_ENABLE 10 /* INB, OOB */
307 #define DIGI_CMD_BREAK_CONTROL 11 /* INB, OOB */
308 #define DIGI_CMD_LOCAL_LOOPBACK 12 /* INB, OOB */
309 #define DIGI_CMD_TRANSMIT_IDLE 13 /* INB, OOB */
310 #define DIGI_CMD_READ_UART_REGISTER 14 /* OOB */
311 #define DIGI_CMD_WRITE_UART_REGISTER 15 /* INB, OOB */
312 #define DIGI_CMD_AND_UART_REGISTER 16 /* INB, OOB */
313 #define DIGI_CMD_OR_UART_REGISTER 17 /* INB, OOB */
314 #define DIGI_CMD_SEND_DATA 18 /* INB */
315 #define DIGI_CMD_RECEIVE_DATA 19 /* INB */
316 #define DIGI_CMD_RECEIVE_DISABLE 20 /* INB */
317 #define DIGI_CMD_GET_PORT_TYPE 21 /* OOB */
320 #define DIGI_BAUD_50 0
321 #define DIGI_BAUD_75 1
322 #define DIGI_BAUD_110 2
323 #define DIGI_BAUD_150 3
324 #define DIGI_BAUD_200 4
325 #define DIGI_BAUD_300 5
326 #define DIGI_BAUD_600 6
327 #define DIGI_BAUD_1200 7
328 #define DIGI_BAUD_1800 8
329 #define DIGI_BAUD_2400 9
330 #define DIGI_BAUD_4800 10
331 #define DIGI_BAUD_7200 11
332 #define DIGI_BAUD_9600 12
333 #define DIGI_BAUD_14400 13
334 #define DIGI_BAUD_19200 14
335 #define DIGI_BAUD_28800 15
336 #define DIGI_BAUD_38400 16
337 #define DIGI_BAUD_57600 17
338 #define DIGI_BAUD_76800 18
339 #define DIGI_BAUD_115200 19
340 #define DIGI_BAUD_153600 20
341 #define DIGI_BAUD_230400 21
342 #define DIGI_BAUD_460800 22
345 #define DIGI_WORD_SIZE_5 0
346 #define DIGI_WORD_SIZE_6 1
347 #define DIGI_WORD_SIZE_7 2
348 #define DIGI_WORD_SIZE_8 3
350 #define DIGI_PARITY_NONE 0
351 #define DIGI_PARITY_ODD 1
352 #define DIGI_PARITY_EVEN 2
353 #define DIGI_PARITY_MARK 3
354 #define DIGI_PARITY_SPACE 4
356 #define DIGI_STOP_BITS_1 0
357 #define DIGI_STOP_BITS_2 1
359 #define DIGI_INPUT_FLOW_CONTROL_XON_XOFF 1
360 #define DIGI_INPUT_FLOW_CONTROL_RTS 2
361 #define DIGI_INPUT_FLOW_CONTROL_DTR 4
363 #define DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF 1
364 #define DIGI_OUTPUT_FLOW_CONTROL_CTS 2
365 #define DIGI_OUTPUT_FLOW_CONTROL_DSR 4
367 #define DIGI_DTR_INACTIVE 0
368 #define DIGI_DTR_ACTIVE 1
369 #define DIGI_DTR_INPUT_FLOW_CONTROL 2
371 #define DIGI_RTS_INACTIVE 0
372 #define DIGI_RTS_ACTIVE 1
373 #define DIGI_RTS_INPUT_FLOW_CONTROL 2
374 #define DIGI_RTS_TOGGLE 3
376 #define DIGI_FLUSH_TX 1
377 #define DIGI_FLUSH_RX 2
378 #define DIGI_RESUME_TX 4 /* clears xoff condition */
380 #define DIGI_TRANSMIT_NOT_IDLE 0
381 #define DIGI_TRANSMIT_IDLE 1
383 #define DIGI_DISABLE 0
384 #define DIGI_ENABLE 1
386 #define DIGI_DEASSERT 0
387 #define DIGI_ASSERT 1
389 /* in band status codes */
390 #define DIGI_OVERRUN_ERROR 4
391 #define DIGI_PARITY_ERROR 8
392 #define DIGI_FRAMING_ERROR 16
393 #define DIGI_BREAK_ERROR 32
395 /* out of band status */
396 #define DIGI_NO_ERROR 0
397 #define DIGI_BAD_FIRST_PARAMETER 1
398 #define DIGI_BAD_SECOND_PARAMETER 2
399 #define DIGI_INVALID_LINE 3
400 #define DIGI_INVALID_OPCODE 4
403 #define DIGI_READ_INPUT_SIGNALS_SLOT 1
404 #define DIGI_READ_INPUT_SIGNALS_ERR 2
405 #define DIGI_READ_INPUT_SIGNALS_BUSY 4
406 #define DIGI_READ_INPUT_SIGNALS_PE 8
407 #define DIGI_READ_INPUT_SIGNALS_CTS 16
408 #define DIGI_READ_INPUT_SIGNALS_DSR 32
409 #define DIGI_READ_INPUT_SIGNALS_RI 64
410 #define DIGI_READ_INPUT_SIGNALS_DCD 128
416 spinlock_t ds_serial_lock;
417 struct usb_serial_port *ds_oob_port; /* out-of-band port */
418 int ds_oob_port_num; /* index of out-of-band port */
419 int ds_device_started;
423 spinlock_t dp_port_lock;
426 unsigned char dp_out_buf[DIGI_OUT_BUF_SIZE];
428 unsigned char dp_in_buf[DIGI_IN_BUF_SIZE];
429 unsigned char dp_in_flag_buf[DIGI_IN_BUF_SIZE];
430 int dp_write_urb_in_use;
431 unsigned int dp_modem_signals;
432 wait_queue_head_t dp_modem_change_wait;
433 int dp_transmit_idle;
434 wait_queue_head_t dp_transmit_idle_wait;
436 int dp_throttle_restart;
437 wait_queue_head_t dp_flush_wait;
438 int dp_in_close; /* close in progress */
439 wait_queue_head_t dp_close_wait; /* wait queue for close */
440 struct work_struct dp_wakeup_work;
444 /* Local Function Declarations */
446 static void digi_wakeup_write( struct usb_serial_port *port );
447 static void digi_wakeup_write_lock(void *);
448 static int digi_write_oob_command( struct usb_serial_port *port,
449 unsigned char *buf, int count, int interruptible );
450 static int digi_write_inb_command( struct usb_serial_port *port,
451 unsigned char *buf, int count, unsigned long timeout );
452 static int digi_set_modem_signals( struct usb_serial_port *port,
453 unsigned int modem_signals, int interruptible );
454 static int digi_transmit_idle( struct usb_serial_port *port,
455 unsigned long timeout );
456 static void digi_rx_throttle (struct usb_serial_port *port);
457 static void digi_rx_unthrottle (struct usb_serial_port *port);
458 static void digi_set_termios( struct usb_serial_port *port,
459 struct termios *old_termios );
460 static void digi_break_ctl( struct usb_serial_port *port, int break_state );
461 static int digi_ioctl( struct usb_serial_port *port, struct file *file,
462 unsigned int cmd, unsigned long arg );
463 static int digi_tiocmget( struct usb_serial_port *port, struct file *file );
464 static int digi_tiocmset( struct usb_serial_port *port, struct file *file,
465 unsigned int set, unsigned int clear );
466 static int digi_write( struct usb_serial_port *port, int from_user,
467 const unsigned char *buf, int count );
468 static void digi_write_bulk_callback( struct urb *urb, struct pt_regs *regs );
469 static int digi_write_room( struct usb_serial_port *port );
470 static int digi_chars_in_buffer( struct usb_serial_port *port );
471 static int digi_open( struct usb_serial_port *port, struct file *filp );
472 static void digi_close( struct usb_serial_port *port, struct file *filp );
473 static int digi_startup_device( struct usb_serial *serial );
474 static int digi_startup( struct usb_serial *serial );
475 static void digi_shutdown( struct usb_serial *serial );
476 static void digi_read_bulk_callback( struct urb *urb, struct pt_regs *regs );
477 static int digi_read_inb_callback( struct urb *urb );
478 static int digi_read_oob_callback( struct urb *urb );
483 static struct usb_device_id id_table_combined [] = {
484 { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
485 { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
486 { } /* Terminating entry */
489 static struct usb_device_id id_table_2 [] = {
490 { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
491 { } /* Terminating entry */
494 static struct usb_device_id id_table_4 [] = {
495 { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
496 { } /* Terminating entry */
499 MODULE_DEVICE_TABLE (usb, id_table_combined);
501 static struct usb_driver digi_driver = {
502 .owner = THIS_MODULE,
503 .name = "digi_acceleport",
504 .probe = usb_serial_probe,
505 .disconnect = usb_serial_disconnect,
506 .id_table = id_table_combined,
510 /* device info needed for the Digi serial converter */
512 static struct usb_serial_device_type digi_acceleport_2_device = {
513 .owner = THIS_MODULE,
514 .name = "Digi 2 port USB adapter",
515 .short_name = "digi_2",
516 .id_table = id_table_2,
517 .num_interrupt_in = 0,
524 .write_room = digi_write_room,
525 .write_bulk_callback = digi_write_bulk_callback,
526 .read_bulk_callback = digi_read_bulk_callback,
527 .chars_in_buffer = digi_chars_in_buffer,
528 .throttle = digi_rx_throttle,
529 .unthrottle = digi_rx_unthrottle,
531 .set_termios = digi_set_termios,
532 .break_ctl = digi_break_ctl,
533 .tiocmget = digi_tiocmget,
534 .tiocmset = digi_tiocmset,
535 .attach = digi_startup,
536 .shutdown = digi_shutdown,
539 static struct usb_serial_device_type digi_acceleport_4_device = {
540 .owner = THIS_MODULE,
541 .name = "Digi 4 port USB adapter",
542 .short_name = "digi_4",
543 .id_table = id_table_4,
544 .num_interrupt_in = 0,
551 .write_room = digi_write_room,
552 .write_bulk_callback = digi_write_bulk_callback,
553 .read_bulk_callback = digi_read_bulk_callback,
554 .chars_in_buffer = digi_chars_in_buffer,
555 .throttle = digi_rx_throttle,
556 .unthrottle = digi_rx_unthrottle,
558 .set_termios = digi_set_termios,
559 .break_ctl = digi_break_ctl,
560 .tiocmget = digi_tiocmget,
561 .tiocmset = digi_tiocmset,
562 .attach = digi_startup,
563 .shutdown = digi_shutdown,
570 * Cond Wait Interruptible Timeout Irqrestore
572 * Do spin_unlock_irqrestore and interruptible_sleep_on_timeout
573 * so that wake ups are not lost if they occur between the unlock
574 * and the sleep. In other words, spin_unlock_irqrestore and
575 * interruptible_sleep_on_timeout are "atomic" with respect to
576 * wake ups. This is used to implement condition variables.
579 static inline long cond_wait_interruptible_timeout_irqrestore(
580 wait_queue_head_t *q, long timeout,
581 spinlock_t *lock, unsigned long flags )
587 init_waitqueue_entry( &wait, current );
589 set_current_state( TASK_INTERRUPTIBLE );
591 add_wait_queue( q, &wait );
593 spin_unlock_irqrestore( lock, flags );
595 timeout = schedule_timeout(timeout);
597 remove_wait_queue( q, &wait );
607 * Wake up port, line discipline, and tty processes sleeping
611 static void digi_wakeup_write_lock(void *arg)
613 struct usb_serial_port *port = arg;
615 struct digi_port *priv = usb_get_serial_port_data(port);
618 spin_lock_irqsave( &priv->dp_port_lock, flags );
619 digi_wakeup_write( port );
620 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
623 static void digi_wakeup_write( struct usb_serial_port *port )
626 struct tty_struct *tty = port->tty;
629 /* wake up port processes */
630 wake_up_interruptible( &port->write_wait );
632 /* wake up line discipline */
633 if( (tty->flags & (1 << TTY_DO_WRITE_WAKEUP))
634 && tty->ldisc.write_wakeup )
635 (tty->ldisc.write_wakeup)(tty);
637 /* wake up other tty processes */
638 wake_up_interruptible( &tty->write_wait );
639 /* For 2.2.16 backport -- wake_up_interruptible( &tty->poll_wait ); */
645 * Digi Write OOB Command
647 * Write commands on the out of band port. Commands are 4
648 * bytes each, multiple commands can be sent at once, and
649 * no command will be split across USB packets. Returns 0
650 * if successful, -EINTR if interrupted while sleeping and
651 * the interruptible flag is true, or a negative error
652 * returned by usb_submit_urb.
655 static int digi_write_oob_command( struct usb_serial_port *port,
656 unsigned char *buf, int count, int interruptible )
661 struct usb_serial_port *oob_port = (struct usb_serial_port *)((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
662 struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
663 unsigned long flags = 0;
666 dbg( "digi_write_oob_command: TOP: port=%d, count=%d", oob_priv->dp_port_num, count );
668 spin_lock_irqsave( &oob_priv->dp_port_lock, flags );
672 while( oob_port->write_urb->status == -EINPROGRESS
673 || oob_priv->dp_write_urb_in_use ) {
674 cond_wait_interruptible_timeout_irqrestore(
675 &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
676 &oob_priv->dp_port_lock, flags );
677 if( interruptible && signal_pending(current) ) {
680 spin_lock_irqsave( &oob_priv->dp_port_lock, flags );
683 /* len must be a multiple of 4, so commands are not split */
684 len = min(count, oob_port->bulk_out_size );
688 memcpy( oob_port->write_urb->transfer_buffer, buf, len );
689 oob_port->write_urb->transfer_buffer_length = len;
690 oob_port->write_urb->dev = port->serial->dev;
692 if( (ret=usb_submit_urb(oob_port->write_urb, GFP_ATOMIC)) == 0 ) {
693 oob_priv->dp_write_urb_in_use = 1;
700 spin_unlock_irqrestore( &oob_priv->dp_port_lock, flags );
703 err("%s: usb_submit_urb failed, ret=%d", __FUNCTION__,
713 * Digi Write In Band Command
715 * Write commands on the given port. Commands are 4
716 * bytes each, multiple commands can be sent at once, and
717 * no command will be split across USB packets. If timeout
718 * is non-zero, write in band command will return after
719 * waiting unsuccessfully for the URB status to clear for
720 * timeout ticks. Returns 0 if successful, or a negative
721 * error returned by digi_write.
724 static int digi_write_inb_command( struct usb_serial_port *port,
725 unsigned char *buf, int count, unsigned long timeout )
730 struct digi_port *priv = usb_get_serial_port_data(port);
731 unsigned char *data = port->write_urb->transfer_buffer;
732 unsigned long flags = 0;
735 dbg( "digi_write_inb_command: TOP: port=%d, count=%d", priv->dp_port_num,
743 spin_lock_irqsave( &priv->dp_port_lock, flags );
745 while( count > 0 && ret == 0 ) {
747 while( (port->write_urb->status == -EINPROGRESS
748 || priv->dp_write_urb_in_use) && time_before(jiffies, timeout)) {
749 cond_wait_interruptible_timeout_irqrestore(
750 &port->write_wait, DIGI_RETRY_TIMEOUT,
751 &priv->dp_port_lock, flags );
752 if( signal_pending(current) ) {
755 spin_lock_irqsave( &priv->dp_port_lock, flags );
758 /* len must be a multiple of 4 and small enough to */
759 /* guarantee the write will send buffered data first, */
760 /* so commands are in order with data and not split */
761 len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len );
765 /* write any buffered data first */
766 if( priv->dp_out_buf_len > 0 ) {
767 data[0] = DIGI_CMD_SEND_DATA;
768 data[1] = priv->dp_out_buf_len;
769 memcpy( data+2, priv->dp_out_buf,
770 priv->dp_out_buf_len );
771 memcpy( data+2+priv->dp_out_buf_len, buf, len );
772 port->write_urb->transfer_buffer_length
773 = priv->dp_out_buf_len+2+len;
775 memcpy( data, buf, len );
776 port->write_urb->transfer_buffer_length = len;
778 port->write_urb->dev = port->serial->dev;
780 if( (ret=usb_submit_urb(port->write_urb, GFP_ATOMIC)) == 0 ) {
781 priv->dp_write_urb_in_use = 1;
782 priv->dp_out_buf_len = 0;
789 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
792 err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
793 ret, priv->dp_port_num );
802 * Digi Set Modem Signals
804 * Sets or clears DTR and RTS on the port, according to the
805 * modem_signals argument. Use TIOCM_DTR and TIOCM_RTS flags
806 * for the modem_signals argument. Returns 0 if successful,
807 * -EINTR if interrupted while sleeping, or a non-zero error
808 * returned by usb_submit_urb.
811 static int digi_set_modem_signals( struct usb_serial_port *port,
812 unsigned int modem_signals, int interruptible )
816 struct digi_port *port_priv = usb_get_serial_port_data(port);
817 struct usb_serial_port *oob_port = (struct usb_serial_port *)((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
818 struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
819 unsigned char *data = oob_port->write_urb->transfer_buffer;
820 unsigned long flags = 0;
823 dbg( "digi_set_modem_signals: TOP: port=%d, modem_signals=0x%x",
824 port_priv->dp_port_num, modem_signals );
826 spin_lock_irqsave( &oob_priv->dp_port_lock, flags );
827 spin_lock( &port_priv->dp_port_lock );
829 while( oob_port->write_urb->status == -EINPROGRESS
830 || oob_priv->dp_write_urb_in_use ) {
831 spin_unlock( &port_priv->dp_port_lock );
832 cond_wait_interruptible_timeout_irqrestore(
833 &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
834 &oob_priv->dp_port_lock, flags );
835 if( interruptible && signal_pending(current) ) {
838 spin_lock_irqsave( &oob_priv->dp_port_lock, flags );
839 spin_lock( &port_priv->dp_port_lock );
842 data[0] = DIGI_CMD_SET_DTR_SIGNAL;
843 data[1] = port_priv->dp_port_num;
844 data[2] = (modem_signals&TIOCM_DTR) ?
845 DIGI_DTR_ACTIVE : DIGI_DTR_INACTIVE;
848 data[4] = DIGI_CMD_SET_RTS_SIGNAL;
849 data[5] = port_priv->dp_port_num;
850 data[6] = (modem_signals&TIOCM_RTS) ?
851 DIGI_RTS_ACTIVE : DIGI_RTS_INACTIVE;
854 oob_port->write_urb->transfer_buffer_length = 8;
855 oob_port->write_urb->dev = port->serial->dev;
857 if( (ret=usb_submit_urb(oob_port->write_urb, GFP_ATOMIC)) == 0 ) {
858 oob_priv->dp_write_urb_in_use = 1;
859 port_priv->dp_modem_signals =
860 (port_priv->dp_modem_signals&~(TIOCM_DTR|TIOCM_RTS))
861 | (modem_signals&(TIOCM_DTR|TIOCM_RTS));
864 spin_unlock( &port_priv->dp_port_lock );
865 spin_unlock_irqrestore( &oob_priv->dp_port_lock, flags );
868 err("%s: usb_submit_urb failed, ret=%d", __FUNCTION__,
880 * Digi transmit idle waits, up to timeout ticks, for the transmitter
881 * to go idle. It returns 0 if successful or a negative error.
883 * There are race conditions here if more than one process is calling
884 * digi_transmit_idle on the same port at the same time. However, this
885 * is only called from close, and only one process can be in close on a
886 * port at a time, so its ok.
889 static int digi_transmit_idle( struct usb_serial_port *port,
890 unsigned long timeout )
894 unsigned char buf[2];
895 struct digi_port *priv = usb_get_serial_port_data(port);
896 unsigned long flags = 0;
899 spin_lock_irqsave( &priv->dp_port_lock, flags );
900 priv->dp_transmit_idle = 0;
901 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
903 buf[0] = DIGI_CMD_TRANSMIT_IDLE;
908 if( (ret=digi_write_inb_command( port, buf, 2, timeout-jiffies )) != 0 )
911 spin_lock_irqsave( &priv->dp_port_lock, flags );
913 while( time_before(jiffies, timeout) && !priv->dp_transmit_idle ) {
914 cond_wait_interruptible_timeout_irqrestore(
915 &priv->dp_transmit_idle_wait, DIGI_RETRY_TIMEOUT,
916 &priv->dp_port_lock, flags );
917 if( signal_pending(current) ) {
920 spin_lock_irqsave( &priv->dp_port_lock, flags );
923 priv->dp_transmit_idle = 0;
924 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
931 static void digi_rx_throttle( struct usb_serial_port *port )
935 struct digi_port *priv = usb_get_serial_port_data(port);
938 dbg( "digi_rx_throttle: TOP: port=%d", priv->dp_port_num );
940 /* stop receiving characters by not resubmitting the read urb */
941 spin_lock_irqsave( &priv->dp_port_lock, flags );
942 priv->dp_throttled = 1;
943 priv->dp_throttle_restart = 0;
944 priv->dp_in_buf_len = 0;
945 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
950 static void digi_rx_unthrottle( struct usb_serial_port *port )
956 struct digi_port *priv = usb_get_serial_port_data(port);
957 struct tty_struct *tty = port->tty;
960 dbg( "digi_rx_unthrottle: TOP: port=%d", priv->dp_port_num );
962 spin_lock_irqsave( &priv->dp_port_lock, flags );
964 /* send any buffered chars from throttle time on to tty subsystem */
965 len = min(priv->dp_in_buf_len, TTY_FLIPBUF_SIZE - tty->flip.count );
967 memcpy( tty->flip.char_buf_ptr, priv->dp_in_buf, len );
968 memcpy( tty->flip.flag_buf_ptr, priv->dp_in_flag_buf, len );
969 tty->flip.char_buf_ptr += len;
970 tty->flip.flag_buf_ptr += len;
971 tty->flip.count += len;
972 tty_flip_buffer_push( tty );
975 /* restart read chain */
976 if( priv->dp_throttle_restart ) {
977 port->read_urb->dev = port->serial->dev;
978 ret = usb_submit_urb( port->read_urb, GFP_ATOMIC );
981 /* turn throttle off */
982 priv->dp_throttled = 0;
983 priv->dp_in_buf_len = 0;
984 priv->dp_throttle_restart = 0;
986 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
989 err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
990 ret, priv->dp_port_num );
996 static void digi_set_termios( struct usb_serial_port *port,
997 struct termios *old_termios )
1000 struct digi_port *priv = usb_get_serial_port_data(port);
1001 unsigned int iflag = port->tty->termios->c_iflag;
1002 unsigned int cflag = port->tty->termios->c_cflag;
1003 unsigned int old_iflag = old_termios->c_iflag;
1004 unsigned int old_cflag = old_termios->c_cflag;
1005 unsigned char buf[32];
1006 unsigned int modem_signals;
1011 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 );
1014 if( (cflag&CBAUD) != (old_cflag&CBAUD) ) {
1018 /* reassert DTR and (maybe) RTS on transition from B0 */
1019 if( (old_cflag&CBAUD) == B0 ) {
1020 /* don't set RTS if using hardware flow control */
1021 /* and throttling input */
1022 modem_signals = TIOCM_DTR;
1023 if( !(port->tty->termios->c_cflag & CRTSCTS) ||
1024 !test_bit(TTY_THROTTLED, &port->tty->flags) ) {
1025 modem_signals |= TIOCM_RTS;
1027 digi_set_modem_signals( port, modem_signals, 1 );
1030 switch( (cflag&CBAUD) ) {
1031 /* drop DTR and RTS on transition to B0 */
1032 case B0: digi_set_modem_signals( port, 0, 1 ); break;
1033 case B50: arg = DIGI_BAUD_50; break;
1034 case B75: arg = DIGI_BAUD_75; break;
1035 case B110: arg = DIGI_BAUD_110; break;
1036 case B150: arg = DIGI_BAUD_150; break;
1037 case B200: arg = DIGI_BAUD_200; break;
1038 case B300: arg = DIGI_BAUD_300; break;
1039 case B600: arg = DIGI_BAUD_600; break;
1040 case B1200: arg = DIGI_BAUD_1200; break;
1041 case B1800: arg = DIGI_BAUD_1800; break;
1042 case B2400: arg = DIGI_BAUD_2400; break;
1043 case B4800: arg = DIGI_BAUD_4800; break;
1044 case B9600: arg = DIGI_BAUD_9600; break;
1045 case B19200: arg = DIGI_BAUD_19200; break;
1046 case B38400: arg = DIGI_BAUD_38400; break;
1047 case B57600: arg = DIGI_BAUD_57600; break;
1048 case B115200: arg = DIGI_BAUD_115200; break;
1049 case B230400: arg = DIGI_BAUD_230400; break;
1050 case B460800: arg = DIGI_BAUD_460800; break;
1052 dbg( "digi_set_termios: can't handle baud rate 0x%x",
1058 buf[i++] = DIGI_CMD_SET_BAUD_RATE;
1059 buf[i++] = priv->dp_port_num;
1067 if( (cflag&(PARENB|PARODD)) != (old_cflag&(PARENB|PARODD)) ) {
1069 if( (cflag&PARENB) ) {
1070 if( (cflag&PARODD) )
1071 arg = DIGI_PARITY_ODD;
1073 arg = DIGI_PARITY_EVEN;
1075 arg = DIGI_PARITY_NONE;
1078 buf[i++] = DIGI_CMD_SET_PARITY;
1079 buf[i++] = priv->dp_port_num;
1086 if( (cflag&CSIZE) != (old_cflag&CSIZE) ) {
1090 switch( (cflag&CSIZE) ) {
1091 case CS5: arg = DIGI_WORD_SIZE_5; break;
1092 case CS6: arg = DIGI_WORD_SIZE_6; break;
1093 case CS7: arg = DIGI_WORD_SIZE_7; break;
1094 case CS8: arg = DIGI_WORD_SIZE_8; break;
1096 dbg( "digi_set_termios: can't handle word size %d",
1102 buf[i++] = DIGI_CMD_SET_WORD_SIZE;
1103 buf[i++] = priv->dp_port_num;
1111 if( (cflag&CSTOPB) != (old_cflag&CSTOPB) ) {
1113 if( (cflag&CSTOPB) )
1114 arg = DIGI_STOP_BITS_2;
1116 arg = DIGI_STOP_BITS_1;
1118 buf[i++] = DIGI_CMD_SET_STOP_BITS;
1119 buf[i++] = priv->dp_port_num;
1125 /* set input flow control */
1126 if( (iflag&IXOFF) != (old_iflag&IXOFF)
1127 || (cflag&CRTSCTS) != (old_cflag&CRTSCTS) ) {
1132 arg |= DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
1134 arg &= ~DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
1136 if( (cflag&CRTSCTS) ) {
1138 arg |= DIGI_INPUT_FLOW_CONTROL_RTS;
1140 /* On USB-4 it is necessary to assert RTS prior */
1141 /* to selecting RTS input flow control. */
1142 buf[i++] = DIGI_CMD_SET_RTS_SIGNAL;
1143 buf[i++] = priv->dp_port_num;
1144 buf[i++] = DIGI_RTS_ACTIVE;
1148 arg &= ~DIGI_INPUT_FLOW_CONTROL_RTS;
1151 buf[i++] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1152 buf[i++] = priv->dp_port_num;
1158 /* set output flow control */
1159 if( (iflag&IXON) != (old_iflag&IXON)
1160 || (cflag&CRTSCTS) != (old_cflag&CRTSCTS) ) {
1165 arg |= DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
1167 arg &= ~DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
1169 if( (cflag&CRTSCTS) ) {
1170 arg |= DIGI_OUTPUT_FLOW_CONTROL_CTS;
1172 arg &= ~DIGI_OUTPUT_FLOW_CONTROL_CTS;
1173 port->tty->hw_stopped = 0;
1176 buf[i++] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1177 buf[i++] = priv->dp_port_num;
1183 /* set receive enable/disable */
1184 if( (cflag&CREAD) != (old_cflag&CREAD) ) {
1191 buf[i++] = DIGI_CMD_RECEIVE_ENABLE;
1192 buf[i++] = priv->dp_port_num;
1198 if( (ret=digi_write_oob_command( port, buf, i, 1 )) != 0 )
1199 dbg( "digi_set_termios: write oob failed, ret=%d", ret );
1204 static void digi_break_ctl( struct usb_serial_port *port, int break_state )
1207 unsigned char buf[4];
1210 buf[0] = DIGI_CMD_BREAK_CONTROL;
1211 buf[1] = 2; /* length */
1212 buf[2] = break_state ? 1 : 0;
1213 buf[3] = 0; /* pad */
1215 digi_write_inb_command( port, buf, 4, 0 );
1220 static int digi_tiocmget( struct usb_serial_port *port, struct file *file )
1222 struct digi_port *priv = usb_get_serial_port_data(port);
1224 unsigned long flags;
1226 dbg("%s: TOP: port=%d", __FUNCTION__, priv->dp_port_num);
1228 spin_lock_irqsave( &priv->dp_port_lock, flags );
1229 val = priv->dp_modem_signals;
1230 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1235 static int digi_tiocmset( struct usb_serial_port *port, struct file *file,
1236 unsigned int set, unsigned int clear )
1238 struct digi_port *priv = usb_get_serial_port_data(port);
1240 unsigned long flags;
1242 dbg("%s: TOP: port=%d", __FUNCTION__, priv->dp_port_num);
1244 spin_lock_irqsave( &priv->dp_port_lock, flags );
1245 val = (priv->dp_modem_signals & ~clear) | set;
1246 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1247 return digi_set_modem_signals( port, val, 1 );
1251 static int digi_ioctl( struct usb_serial_port *port, struct file *file,
1252 unsigned int cmd, unsigned long arg )
1255 struct digi_port *priv = usb_get_serial_port_data(port);
1257 dbg( "digi_ioctl: TOP: port=%d, cmd=0x%x", priv->dp_port_num, cmd );
1262 /* wait for any of the 4 modem inputs (DCD,RI,DSR,CTS)*/
1267 /* return count of modemline transitions */
1273 return( -ENOIOCTLCMD );
1278 static int digi_write( struct usb_serial_port *port, int from_user,
1279 const unsigned char *buf, int count )
1282 int ret,data_len,new_len;
1283 struct digi_port *priv = usb_get_serial_port_data(port);
1284 unsigned char *data = port->write_urb->transfer_buffer;
1285 unsigned char user_buf[64]; /* 64 bytes is max USB bulk packet */
1286 unsigned long flags = 0;
1289 dbg( "digi_write: TOP: port=%d, count=%d, from_user=%d, in_interrupt=%ld",
1290 priv->dp_port_num, count, from_user, in_interrupt() );
1292 /* copy user data (which can sleep) before getting spin lock */
1293 count = min( count, port->bulk_out_size-2 );
1294 count = min( 64, count);
1295 if( from_user && copy_from_user( user_buf, buf, count ) ) {
1299 /* be sure only one write proceeds at a time */
1300 /* there are races on the port private buffer */
1301 /* and races to check write_urb->status */
1302 spin_lock_irqsave( &priv->dp_port_lock, flags );
1304 /* wait for urb status clear to submit another urb */
1305 if( port->write_urb->status == -EINPROGRESS
1306 || priv->dp_write_urb_in_use ) {
1308 /* buffer data if count is 1 (probably put_char) if possible */
1309 if( count == 1 && priv->dp_out_buf_len < DIGI_OUT_BUF_SIZE ) {
1310 priv->dp_out_buf[priv->dp_out_buf_len++]
1311 = *(from_user ? user_buf : buf);
1317 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1323 /* allow space for any buffered data and for new data, up to */
1324 /* transfer buffer size - 2 (for command and length bytes) */
1325 new_len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
1326 data_len = new_len + priv->dp_out_buf_len;
1328 if( data_len == 0 ) {
1329 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1333 port->write_urb->transfer_buffer_length = data_len+2;
1334 port->write_urb->dev = port->serial->dev;
1336 *data++ = DIGI_CMD_SEND_DATA;
1339 /* copy in buffered data first */
1340 memcpy( data, priv->dp_out_buf, priv->dp_out_buf_len );
1341 data += priv->dp_out_buf_len;
1343 /* copy in new data */
1344 memcpy( data, from_user ? user_buf : buf, new_len );
1346 if( (ret=usb_submit_urb(port->write_urb, GFP_ATOMIC)) == 0 ) {
1347 priv->dp_write_urb_in_use = 1;
1349 priv->dp_out_buf_len = 0;
1352 /* return length of new data written, or error */
1353 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1355 err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
1356 ret, priv->dp_port_num );
1359 dbg( "digi_write: returning %d", ret );
1365 static void digi_write_bulk_callback( struct urb *urb, struct pt_regs *regs )
1368 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1369 struct usb_serial *serial;
1370 struct digi_port *priv;
1371 struct digi_serial *serial_priv;
1375 dbg( "digi_write_bulk_callback: TOP, urb->status=%d", urb->status );
1377 /* port and serial sanity check */
1378 if( port == NULL || (priv=usb_get_serial_port_data(port)) == NULL ) {
1379 err("%s: port or port->private is NULL, status=%d", __FUNCTION__,
1383 serial = port->serial;
1384 if( serial == NULL || (serial_priv=usb_get_serial_data(serial)) == NULL ) {
1385 err("%s: serial or serial->private is NULL, status=%d", __FUNCTION__, urb->status );
1389 /* handle oob callback */
1390 if( priv->dp_port_num == serial_priv->ds_oob_port_num ) {
1391 dbg( "digi_write_bulk_callback: oob callback" );
1392 spin_lock( &priv->dp_port_lock );
1393 priv->dp_write_urb_in_use = 0;
1394 wake_up_interruptible( &port->write_wait );
1395 spin_unlock( &priv->dp_port_lock );
1399 /* further sanity checks */
1400 if( port_paranoia_check( port, __FUNCTION__ )
1401 || serial_paranoia_check( serial, __FUNCTION__ ) )
1404 /* try to send any buffered data on this port, if it is open */
1405 spin_lock( &priv->dp_port_lock );
1406 priv->dp_write_urb_in_use = 0;
1407 if( port->open_count && port->write_urb->status != -EINPROGRESS
1408 && priv->dp_out_buf_len > 0 ) {
1410 *((unsigned char *)(port->write_urb->transfer_buffer))
1411 = (unsigned char)DIGI_CMD_SEND_DATA;
1412 *((unsigned char *)(port->write_urb->transfer_buffer)+1)
1413 = (unsigned char)priv->dp_out_buf_len;
1415 port->write_urb->transfer_buffer_length
1416 = priv->dp_out_buf_len+2;
1417 port->write_urb->dev = serial->dev;
1419 memcpy( port->write_urb->transfer_buffer+2, priv->dp_out_buf,
1420 priv->dp_out_buf_len );
1422 if( (ret=usb_submit_urb(port->write_urb, GFP_ATOMIC)) == 0 ) {
1423 priv->dp_write_urb_in_use = 1;
1424 priv->dp_out_buf_len = 0;
1429 /* wake up processes sleeping on writes immediately */
1430 digi_wakeup_write( port );
1432 /* also queue up a wakeup at scheduler time, in case we */
1433 /* lost the race in write_chan(). */
1434 schedule_work(&priv->dp_wakeup_work);
1436 spin_unlock( &priv->dp_port_lock );
1439 err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
1440 ret, priv->dp_port_num );
1446 static int digi_write_room( struct usb_serial_port *port )
1450 struct digi_port *priv = usb_get_serial_port_data(port);
1451 unsigned long flags = 0;
1454 spin_lock_irqsave( &priv->dp_port_lock, flags );
1456 if( port->write_urb->status == -EINPROGRESS
1457 || priv->dp_write_urb_in_use )
1460 room = port->bulk_out_size - 2 - priv->dp_out_buf_len;
1462 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1464 dbg( "digi_write_room: port=%d, room=%d", priv->dp_port_num, room );
1470 static int digi_chars_in_buffer( struct usb_serial_port *port )
1473 struct digi_port *priv = usb_get_serial_port_data(port);
1476 if( port->write_urb->status == -EINPROGRESS
1477 || priv->dp_write_urb_in_use ) {
1478 dbg( "digi_chars_in_buffer: port=%d, chars=%d", priv->dp_port_num, port->bulk_out_size - 2 );
1479 /* return( port->bulk_out_size - 2 ); */
1482 dbg( "digi_chars_in_buffer: port=%d, chars=%d", priv->dp_port_num, priv->dp_out_buf_len );
1483 return( priv->dp_out_buf_len );
1489 static int digi_open( struct usb_serial_port *port, struct file *filp )
1493 unsigned char buf[32];
1494 struct digi_port *priv = usb_get_serial_port_data(port);
1495 struct termios not_termios;
1496 unsigned long flags = 0;
1499 dbg( "digi_open: TOP: port=%d, open_count=%d", priv->dp_port_num, port->open_count );
1501 /* be sure the device is started up */
1502 if( digi_startup_device( port->serial ) != 0 )
1505 spin_lock_irqsave( &priv->dp_port_lock, flags );
1507 /* don't wait on a close in progress for non-blocking opens */
1508 if( priv->dp_in_close && (filp->f_flags&(O_NDELAY|O_NONBLOCK)) == 0 ) {
1509 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1513 /* wait for a close in progress to finish */
1514 while( priv->dp_in_close ) {
1515 cond_wait_interruptible_timeout_irqrestore(
1516 &priv->dp_close_wait, DIGI_RETRY_TIMEOUT,
1517 &priv->dp_port_lock, flags );
1518 if( signal_pending(current) ) {
1521 spin_lock_irqsave( &priv->dp_port_lock, flags );
1524 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1526 /* read modem signals automatically whenever they change */
1527 buf[0] = DIGI_CMD_READ_INPUT_SIGNALS;
1528 buf[1] = priv->dp_port_num;
1529 buf[2] = DIGI_ENABLE;
1533 buf[4] = DIGI_CMD_IFLUSH_FIFO;
1534 buf[5] = priv->dp_port_num;
1535 buf[6] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1538 if( (ret=digi_write_oob_command( port, buf, 8, 1 )) != 0 )
1539 dbg( "digi_open: write oob failed, ret=%d", ret );
1541 /* set termios settings */
1542 not_termios.c_cflag = ~port->tty->termios->c_cflag;
1543 not_termios.c_iflag = ~port->tty->termios->c_iflag;
1544 digi_set_termios( port, ¬_termios );
1546 /* set DTR and RTS */
1547 digi_set_modem_signals( port, TIOCM_DTR|TIOCM_RTS, 1 );
1554 static void digi_close( struct usb_serial_port *port, struct file *filp )
1558 unsigned char buf[32];
1559 struct tty_struct *tty = port->tty;
1560 struct digi_port *priv = usb_get_serial_port_data(port);
1561 unsigned long flags = 0;
1564 dbg( "digi_close: TOP: port=%d, open_count=%d", priv->dp_port_num, port->open_count );
1567 /* do cleanup only after final close on this port */
1568 spin_lock_irqsave( &priv->dp_port_lock, flags );
1569 priv->dp_in_close = 1;
1570 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1572 /* tell line discipline to process only XON/XOFF */
1575 /* wait for output to drain */
1576 if( (filp->f_flags&(O_NDELAY|O_NONBLOCK)) == 0 ) {
1577 tty_wait_until_sent( tty, DIGI_CLOSE_TIMEOUT );
1580 /* flush driver and line discipline buffers */
1581 if( tty->driver->flush_buffer )
1582 tty->driver->flush_buffer( tty );
1583 if( tty->ldisc.flush_buffer )
1584 tty->ldisc.flush_buffer( tty );
1586 if (port->serial->dev) {
1587 /* wait for transmit idle */
1588 if( (filp->f_flags&(O_NDELAY|O_NONBLOCK)) == 0 ) {
1589 digi_transmit_idle( port, DIGI_CLOSE_TIMEOUT );
1592 /* drop DTR and RTS */
1593 digi_set_modem_signals( port, 0, 0 );
1595 /* disable input flow control */
1596 buf[0] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1597 buf[1] = priv->dp_port_num;
1598 buf[2] = DIGI_DISABLE;
1601 /* disable output flow control */
1602 buf[4] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1603 buf[5] = priv->dp_port_num;
1604 buf[6] = DIGI_DISABLE;
1607 /* disable reading modem signals automatically */
1608 buf[8] = DIGI_CMD_READ_INPUT_SIGNALS;
1609 buf[9] = priv->dp_port_num;
1610 buf[10] = DIGI_DISABLE;
1613 /* disable receive */
1614 buf[12] = DIGI_CMD_RECEIVE_ENABLE;
1615 buf[13] = priv->dp_port_num;
1616 buf[14] = DIGI_DISABLE;
1620 buf[16] = DIGI_CMD_IFLUSH_FIFO;
1621 buf[17] = priv->dp_port_num;
1622 buf[18] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1625 if( (ret=digi_write_oob_command( port, buf, 20, 0 )) != 0 )
1626 dbg( "digi_close: write oob failed, ret=%d", ret );
1628 /* wait for final commands on oob port to complete */
1629 interruptible_sleep_on_timeout( &priv->dp_flush_wait,
1630 DIGI_CLOSE_TIMEOUT );
1632 /* shutdown any outstanding bulk writes */
1633 usb_unlink_urb (port->write_urb);
1638 spin_lock_irqsave( &priv->dp_port_lock, flags );
1639 priv->dp_write_urb_in_use = 0;
1640 priv->dp_in_close = 0;
1641 wake_up_interruptible( &priv->dp_close_wait );
1642 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1644 dbg( "digi_close: done" );
1649 * Digi Startup Device
1651 * Starts reads on all ports. Must be called AFTER startup, with
1652 * urbs initialized. Returns 0 if successful, non-zero error otherwise.
1655 static int digi_startup_device( struct usb_serial *serial )
1659 struct digi_serial *serial_priv = usb_get_serial_data(serial);
1660 struct usb_serial_port *port;
1663 /* be sure this happens exactly once */
1664 spin_lock( &serial_priv->ds_serial_lock );
1665 if( serial_priv->ds_device_started ) {
1666 spin_unlock( &serial_priv->ds_serial_lock );
1669 serial_priv->ds_device_started = 1;
1670 spin_unlock( &serial_priv->ds_serial_lock );
1672 /* start reading from each bulk in endpoint for the device */
1673 /* set USB_DISABLE_SPD flag for write bulk urbs */
1674 for( i=0; i<serial->type->num_ports+1; i++ ) {
1676 port = serial->port[i];
1678 port->write_urb->dev = port->serial->dev;
1680 if( (ret=usb_submit_urb(port->read_urb, GFP_KERNEL)) != 0 ) {
1681 err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
1693 static int digi_startup( struct usb_serial *serial )
1697 struct digi_port *priv;
1698 struct digi_serial *serial_priv;
1701 dbg( "digi_startup: TOP" );
1703 /* allocate the private data structures for all ports */
1704 /* number of regular ports + 1 for the out-of-band port */
1705 for( i=0; i<serial->type->num_ports+1; i++ ) {
1707 /* allocate port private structure */
1708 priv = (struct digi_port *)kmalloc( sizeof(struct digi_port),
1710 if( priv == (struct digi_port *)0 ) {
1712 kfree( usb_get_serial_port_data(serial->port[i]) );
1713 return( 1 ); /* error */
1716 /* initialize port private structure */
1717 spin_lock_init( &priv->dp_port_lock );
1718 priv->dp_port_num = i;
1719 priv->dp_out_buf_len = 0;
1720 priv->dp_in_buf_len = 0;
1721 priv->dp_write_urb_in_use = 0;
1722 priv->dp_modem_signals = 0;
1723 init_waitqueue_head( &priv->dp_modem_change_wait );
1724 priv->dp_transmit_idle = 0;
1725 init_waitqueue_head( &priv->dp_transmit_idle_wait );
1726 priv->dp_throttled = 0;
1727 priv->dp_throttle_restart = 0;
1728 init_waitqueue_head( &priv->dp_flush_wait );
1729 priv->dp_in_close = 0;
1730 init_waitqueue_head( &priv->dp_close_wait );
1731 INIT_WORK(&priv->dp_wakeup_work,
1732 digi_wakeup_write_lock, serial->port[i]);
1734 /* initialize write wait queue for this port */
1735 init_waitqueue_head( &serial->port[i]->write_wait );
1737 usb_set_serial_port_data(serial->port[i], priv);
1740 /* allocate serial private structure */
1741 serial_priv = (struct digi_serial *)kmalloc( sizeof(struct digi_serial),
1743 if( serial_priv == (struct digi_serial *)0 ) {
1744 for( i=0; i<serial->type->num_ports+1; i++ )
1745 kfree( usb_get_serial_port_data(serial->port[i]) );
1746 return( 1 ); /* error */
1749 /* initialize serial private structure */
1750 spin_lock_init( &serial_priv->ds_serial_lock );
1751 serial_priv->ds_oob_port_num = serial->type->num_ports;
1752 serial_priv->ds_oob_port = serial->port[serial_priv->ds_oob_port_num];
1753 serial_priv->ds_device_started = 0;
1754 usb_set_serial_data(serial, serial_priv);
1761 static void digi_shutdown( struct usb_serial *serial )
1767 dbg( "digi_shutdown: TOP, in_interrupt()=%ld", in_interrupt() );
1769 /* stop reads and writes on all ports */
1770 for( i=0; i<serial->type->num_ports+1; i++ ) {
1771 usb_unlink_urb( serial->port[i]->read_urb );
1772 usb_unlink_urb( serial->port[i]->write_urb );
1775 /* free the private data structures for all ports */
1776 /* number of regular ports + 1 for the out-of-band port */
1777 for( i=0; i<serial->type->num_ports+1; i++ )
1778 kfree( usb_get_serial_port_data(serial->port[i]) );
1779 kfree( usb_get_serial_data(serial) );
1783 static void digi_read_bulk_callback( struct urb *urb, struct pt_regs *regs )
1786 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1787 struct digi_port *priv;
1788 struct digi_serial *serial_priv;
1792 dbg( "digi_read_bulk_callback: TOP" );
1794 /* port sanity check, do not resubmit if port is not valid */
1795 if( port == NULL || (priv=usb_get_serial_port_data(port)) == NULL ) {
1796 err("%s: port or port->private is NULL, status=%d", __FUNCTION__,
1800 if( port->serial == NULL
1801 || serial_paranoia_check( port->serial, __FUNCTION__ )
1802 || (serial_priv=usb_get_serial_data(port->serial)) == NULL ) {
1803 err("%s: serial is bad or serial->private is NULL, status=%d", __FUNCTION__, urb->status );
1807 /* do not resubmit urb if it has any status error */
1809 err("%s: nonzero read bulk status: status=%d, port=%d", __FUNCTION__, urb->status, priv->dp_port_num );
1813 /* handle oob or inb callback, do not resubmit if error */
1814 if( priv->dp_port_num == serial_priv->ds_oob_port_num ) {
1815 if( digi_read_oob_callback( urb ) != 0 )
1818 if( digi_read_inb_callback( urb ) != 0 )
1823 urb->dev = port->serial->dev;
1824 if( (ret=usb_submit_urb(urb, GFP_ATOMIC)) != 0 ) {
1825 err("%s: failed resubmitting urb, ret=%d, port=%d", __FUNCTION__,
1826 ret, priv->dp_port_num );
1833 * Digi Read INB Callback
1835 * Digi Read INB Callback handles reads on the in band ports, sending
1836 * the data on to the tty subsystem. When called we know port and
1837 * port->private are not NULL and port->serial has been validated.
1838 * It returns 0 if successful, 1 if successful but the port is
1839 * throttled, and -1 if the sanity checks failed.
1842 static int digi_read_inb_callback( struct urb *urb )
1845 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1846 struct tty_struct *tty = port->tty;
1847 struct digi_port *priv = usb_get_serial_port_data(port);
1848 int opcode = ((unsigned char *)urb->transfer_buffer)[0];
1849 int len = ((unsigned char *)urb->transfer_buffer)[1];
1850 int status = ((unsigned char *)urb->transfer_buffer)[2];
1851 unsigned char *data = ((unsigned char *)urb->transfer_buffer)+3;
1856 if( port_paranoia_check( port, __FUNCTION__ ) )
1859 /* do not process callbacks on closed ports */
1860 /* but do continue the read chain */
1861 if( port->open_count == 0 )
1864 /* short/multiple packet check */
1865 if( urb->actual_length != len + 2 ) {
1866 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 );
1870 spin_lock( &priv->dp_port_lock );
1872 /* check for throttle; if set, do not resubmit read urb */
1873 /* indicate the read chain needs to be restarted on unthrottle */
1874 throttled = priv->dp_throttled;
1876 priv->dp_throttle_restart = 1;
1879 if( opcode == DIGI_CMD_RECEIVE_DATA ) {
1881 /* get flag from status */
1884 /* overrun is special, not associated with a char */
1885 if( status & DIGI_OVERRUN_ERROR ) {
1886 tty_insert_flip_char( tty, 0, TTY_OVERRUN );
1889 /* break takes precedence over parity, */
1890 /* which takes precedence over framing errors */
1891 if( status & DIGI_BREAK_ERROR ) {
1893 } else if( status & DIGI_PARITY_ERROR ) {
1895 } else if( status & DIGI_FRAMING_ERROR ) {
1899 /* data length is len-1 (one byte of len is status) */
1905 DIGI_IN_BUF_SIZE - priv->dp_in_buf_len );
1908 memcpy( priv->dp_in_buf + priv->dp_in_buf_len,
1910 memset( priv->dp_in_flag_buf
1911 + priv->dp_in_buf_len, flag, len );
1912 priv->dp_in_buf_len += len;
1917 len = min( len, TTY_FLIPBUF_SIZE - tty->flip.count );
1920 memcpy( tty->flip.char_buf_ptr, data, len );
1921 memset( tty->flip.flag_buf_ptr, flag, len );
1922 tty->flip.char_buf_ptr += len;
1923 tty->flip.flag_buf_ptr += len;
1924 tty->flip.count += len;
1925 tty_flip_buffer_push( tty );
1932 spin_unlock( &priv->dp_port_lock );
1934 if( opcode == DIGI_CMD_RECEIVE_DISABLE ) {
1935 dbg("%s: got RECEIVE_DISABLE", __FUNCTION__ );
1936 } else if( opcode != DIGI_CMD_RECEIVE_DATA ) {
1937 dbg("%s: unknown opcode: %d", __FUNCTION__, opcode );
1940 return( throttled ? 1 : 0 );
1946 * Digi Read OOB Callback
1948 * Digi Read OOB Callback handles reads on the out of band port.
1949 * When called we know port and port->private are not NULL and
1950 * the port->serial is valid. It returns 0 if successful, and
1951 * -1 if the sanity checks failed.
1954 static int digi_read_oob_callback( struct urb *urb )
1957 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1958 struct usb_serial *serial = port->serial;
1959 struct digi_port *priv = usb_get_serial_port_data(port);
1960 int opcode, line, status, val;
1964 dbg( "digi_read_oob_callback: port=%d, len=%d", priv->dp_port_num,
1965 urb->actual_length );
1967 /* handle each oob command */
1968 for( i=0; i<urb->actual_length-3; ) {
1970 opcode = ((unsigned char *)urb->transfer_buffer)[i++];
1971 line = ((unsigned char *)urb->transfer_buffer)[i++];
1972 status = ((unsigned char *)urb->transfer_buffer)[i++];
1973 val = ((unsigned char *)urb->transfer_buffer)[i++];
1975 dbg( "digi_read_oob_callback: opcode=%d, line=%d, status=%d, val=%d",
1976 opcode, line, status, val );
1978 if( status != 0 || line >= serial->type->num_ports )
1981 port = serial->port[line];
1983 if( port_paranoia_check( port, __FUNCTION__ )
1984 || (priv=usb_get_serial_port_data(port)) == NULL )
1987 if( opcode == DIGI_CMD_READ_INPUT_SIGNALS ) {
1989 spin_lock( &priv->dp_port_lock );
1991 /* convert from digi flags to termiox flags */
1992 if( val & DIGI_READ_INPUT_SIGNALS_CTS ) {
1993 priv->dp_modem_signals |= TIOCM_CTS;
1994 /* port must be open to use tty struct */
1995 if( port->open_count
1996 && port->tty->termios->c_cflag & CRTSCTS ) {
1997 port->tty->hw_stopped = 0;
1998 digi_wakeup_write( port );
2001 priv->dp_modem_signals &= ~TIOCM_CTS;
2002 /* port must be open to use tty struct */
2003 if( port->open_count
2004 && port->tty->termios->c_cflag & CRTSCTS ) {
2005 port->tty->hw_stopped = 1;
2008 if( val & DIGI_READ_INPUT_SIGNALS_DSR )
2009 priv->dp_modem_signals |= TIOCM_DSR;
2011 priv->dp_modem_signals &= ~TIOCM_DSR;
2012 if( val & DIGI_READ_INPUT_SIGNALS_RI )
2013 priv->dp_modem_signals |= TIOCM_RI;
2015 priv->dp_modem_signals &= ~TIOCM_RI;
2016 if( val & DIGI_READ_INPUT_SIGNALS_DCD )
2017 priv->dp_modem_signals |= TIOCM_CD;
2019 priv->dp_modem_signals &= ~TIOCM_CD;
2021 wake_up_interruptible( &priv->dp_modem_change_wait );
2022 spin_unlock( &priv->dp_port_lock );
2024 } else if( opcode == DIGI_CMD_TRANSMIT_IDLE ) {
2026 spin_lock( &priv->dp_port_lock );
2027 priv->dp_transmit_idle = 1;
2028 wake_up_interruptible( &priv->dp_transmit_idle_wait );
2029 spin_unlock( &priv->dp_port_lock );
2031 } else if( opcode == DIGI_CMD_IFLUSH_FIFO ) {
2033 wake_up_interruptible( &priv->dp_flush_wait );
2044 static int __init digi_init (void)
2047 retval = usb_serial_register(&digi_acceleport_2_device);
2049 goto failed_acceleport_2_device;
2050 retval = usb_serial_register(&digi_acceleport_4_device);
2052 goto failed_acceleport_4_device;
2053 retval = usb_register(&digi_driver);
2055 goto failed_usb_register;
2056 info(DRIVER_VERSION ":" DRIVER_DESC);
2058 failed_usb_register:
2059 usb_serial_deregister(&digi_acceleport_4_device);
2060 failed_acceleport_4_device:
2061 usb_serial_deregister(&digi_acceleport_2_device);
2062 failed_acceleport_2_device:
2067 static void __exit digi_exit (void)
2069 usb_deregister (&digi_driver);
2070 usb_serial_deregister (&digi_acceleport_2_device);
2071 usb_serial_deregister (&digi_acceleport_4_device);
2075 module_init(digi_init);
2076 module_exit(digi_exit);
2079 MODULE_AUTHOR( DRIVER_AUTHOR );
2080 MODULE_DESCRIPTION( DRIVER_DESC );
2081 MODULE_LICENSE("GPL");
2083 MODULE_PARM(debug, "i");
2084 MODULE_PARM_DESC(debug, "Debug enabled or not");