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>
249 #include "usb-serial.h"
254 * Version Information
256 #define DRIVER_VERSION "v1.80.1.2"
257 #define DRIVER_AUTHOR "Peter Berger <pberger@brimson.com>, Al Borchers <borchers@steinerpoint.com>"
258 #define DRIVER_DESC "Digi AccelePort USB-2/USB-4 Serial Converter driver"
260 /* port output buffer length -- must be <= transfer buffer length - 2 */
261 /* so we can be sure to send the full buffer in one urb */
262 #define DIGI_OUT_BUF_SIZE 8
264 /* port input buffer length -- must be >= transfer buffer length - 3 */
265 /* so we can be sure to hold at least one full buffer from one urb */
266 #define DIGI_IN_BUF_SIZE 64
268 /* retry timeout while sleeping */
269 #define DIGI_RETRY_TIMEOUT (HZ/10)
271 /* timeout while waiting for tty output to drain in close */
272 /* this delay is used twice in close, so the total delay could */
273 /* be twice this value */
274 #define DIGI_CLOSE_TIMEOUT (5*HZ)
277 /* AccelePort USB Defines */
280 #define DIGI_VENDOR_ID 0x05c5
281 #define DIGI_2_ID 0x0002 /* USB-2 */
282 #define DIGI_4_ID 0x0004 /* USB-4 */
285 * "INB": can be used on the in-band endpoint
286 * "OOB": can be used on the out-of-band endpoint
288 #define DIGI_CMD_SET_BAUD_RATE 0 /* INB, OOB */
289 #define DIGI_CMD_SET_WORD_SIZE 1 /* INB, OOB */
290 #define DIGI_CMD_SET_PARITY 2 /* INB, OOB */
291 #define DIGI_CMD_SET_STOP_BITS 3 /* INB, OOB */
292 #define DIGI_CMD_SET_INPUT_FLOW_CONTROL 4 /* INB, OOB */
293 #define DIGI_CMD_SET_OUTPUT_FLOW_CONTROL 5 /* INB, OOB */
294 #define DIGI_CMD_SET_DTR_SIGNAL 6 /* INB, OOB */
295 #define DIGI_CMD_SET_RTS_SIGNAL 7 /* INB, OOB */
296 #define DIGI_CMD_READ_INPUT_SIGNALS 8 /* OOB */
297 #define DIGI_CMD_IFLUSH_FIFO 9 /* OOB */
298 #define DIGI_CMD_RECEIVE_ENABLE 10 /* INB, OOB */
299 #define DIGI_CMD_BREAK_CONTROL 11 /* INB, OOB */
300 #define DIGI_CMD_LOCAL_LOOPBACK 12 /* INB, OOB */
301 #define DIGI_CMD_TRANSMIT_IDLE 13 /* INB, OOB */
302 #define DIGI_CMD_READ_UART_REGISTER 14 /* OOB */
303 #define DIGI_CMD_WRITE_UART_REGISTER 15 /* INB, OOB */
304 #define DIGI_CMD_AND_UART_REGISTER 16 /* INB, OOB */
305 #define DIGI_CMD_OR_UART_REGISTER 17 /* INB, OOB */
306 #define DIGI_CMD_SEND_DATA 18 /* INB */
307 #define DIGI_CMD_RECEIVE_DATA 19 /* INB */
308 #define DIGI_CMD_RECEIVE_DISABLE 20 /* INB */
309 #define DIGI_CMD_GET_PORT_TYPE 21 /* OOB */
312 #define DIGI_BAUD_50 0
313 #define DIGI_BAUD_75 1
314 #define DIGI_BAUD_110 2
315 #define DIGI_BAUD_150 3
316 #define DIGI_BAUD_200 4
317 #define DIGI_BAUD_300 5
318 #define DIGI_BAUD_600 6
319 #define DIGI_BAUD_1200 7
320 #define DIGI_BAUD_1800 8
321 #define DIGI_BAUD_2400 9
322 #define DIGI_BAUD_4800 10
323 #define DIGI_BAUD_7200 11
324 #define DIGI_BAUD_9600 12
325 #define DIGI_BAUD_14400 13
326 #define DIGI_BAUD_19200 14
327 #define DIGI_BAUD_28800 15
328 #define DIGI_BAUD_38400 16
329 #define DIGI_BAUD_57600 17
330 #define DIGI_BAUD_76800 18
331 #define DIGI_BAUD_115200 19
332 #define DIGI_BAUD_153600 20
333 #define DIGI_BAUD_230400 21
334 #define DIGI_BAUD_460800 22
337 #define DIGI_WORD_SIZE_5 0
338 #define DIGI_WORD_SIZE_6 1
339 #define DIGI_WORD_SIZE_7 2
340 #define DIGI_WORD_SIZE_8 3
342 #define DIGI_PARITY_NONE 0
343 #define DIGI_PARITY_ODD 1
344 #define DIGI_PARITY_EVEN 2
345 #define DIGI_PARITY_MARK 3
346 #define DIGI_PARITY_SPACE 4
348 #define DIGI_STOP_BITS_1 0
349 #define DIGI_STOP_BITS_2 1
351 #define DIGI_INPUT_FLOW_CONTROL_XON_XOFF 1
352 #define DIGI_INPUT_FLOW_CONTROL_RTS 2
353 #define DIGI_INPUT_FLOW_CONTROL_DTR 4
355 #define DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF 1
356 #define DIGI_OUTPUT_FLOW_CONTROL_CTS 2
357 #define DIGI_OUTPUT_FLOW_CONTROL_DSR 4
359 #define DIGI_DTR_INACTIVE 0
360 #define DIGI_DTR_ACTIVE 1
361 #define DIGI_DTR_INPUT_FLOW_CONTROL 2
363 #define DIGI_RTS_INACTIVE 0
364 #define DIGI_RTS_ACTIVE 1
365 #define DIGI_RTS_INPUT_FLOW_CONTROL 2
366 #define DIGI_RTS_TOGGLE 3
368 #define DIGI_FLUSH_TX 1
369 #define DIGI_FLUSH_RX 2
370 #define DIGI_RESUME_TX 4 /* clears xoff condition */
372 #define DIGI_TRANSMIT_NOT_IDLE 0
373 #define DIGI_TRANSMIT_IDLE 1
375 #define DIGI_DISABLE 0
376 #define DIGI_ENABLE 1
378 #define DIGI_DEASSERT 0
379 #define DIGI_ASSERT 1
381 /* in band status codes */
382 #define DIGI_OVERRUN_ERROR 4
383 #define DIGI_PARITY_ERROR 8
384 #define DIGI_FRAMING_ERROR 16
385 #define DIGI_BREAK_ERROR 32
387 /* out of band status */
388 #define DIGI_NO_ERROR 0
389 #define DIGI_BAD_FIRST_PARAMETER 1
390 #define DIGI_BAD_SECOND_PARAMETER 2
391 #define DIGI_INVALID_LINE 3
392 #define DIGI_INVALID_OPCODE 4
395 #define DIGI_READ_INPUT_SIGNALS_SLOT 1
396 #define DIGI_READ_INPUT_SIGNALS_ERR 2
397 #define DIGI_READ_INPUT_SIGNALS_BUSY 4
398 #define DIGI_READ_INPUT_SIGNALS_PE 8
399 #define DIGI_READ_INPUT_SIGNALS_CTS 16
400 #define DIGI_READ_INPUT_SIGNALS_DSR 32
401 #define DIGI_READ_INPUT_SIGNALS_RI 64
402 #define DIGI_READ_INPUT_SIGNALS_DCD 128
408 spinlock_t ds_serial_lock;
409 struct usb_serial_port *ds_oob_port; /* out-of-band port */
410 int ds_oob_port_num; /* index of out-of-band port */
411 int ds_device_started;
415 spinlock_t dp_port_lock;
418 unsigned char dp_out_buf[DIGI_OUT_BUF_SIZE];
420 unsigned char dp_in_buf[DIGI_IN_BUF_SIZE];
421 unsigned char dp_in_flag_buf[DIGI_IN_BUF_SIZE];
422 int dp_write_urb_in_use;
423 unsigned int dp_modem_signals;
424 wait_queue_head_t dp_modem_change_wait;
425 int dp_transmit_idle;
426 wait_queue_head_t dp_transmit_idle_wait;
428 int dp_throttle_restart;
429 wait_queue_head_t dp_flush_wait;
430 int dp_in_close; /* close in progress */
431 wait_queue_head_t dp_close_wait; /* wait queue for close */
432 struct work_struct dp_wakeup_work;
436 /* Local Function Declarations */
438 static void digi_wakeup_write( struct usb_serial_port *port );
439 static void digi_wakeup_write_lock(void *);
440 static int digi_write_oob_command( struct usb_serial_port *port,
441 unsigned char *buf, int count, int interruptible );
442 static int digi_write_inb_command( struct usb_serial_port *port,
443 unsigned char *buf, int count, unsigned long timeout );
444 static int digi_set_modem_signals( struct usb_serial_port *port,
445 unsigned int modem_signals, int interruptible );
446 static int digi_transmit_idle( struct usb_serial_port *port,
447 unsigned long timeout );
448 static void digi_rx_throttle (struct usb_serial_port *port);
449 static void digi_rx_unthrottle (struct usb_serial_port *port);
450 static void digi_set_termios( struct usb_serial_port *port,
451 struct termios *old_termios );
452 static void digi_break_ctl( struct usb_serial_port *port, int break_state );
453 static int digi_ioctl( struct usb_serial_port *port, struct file *file,
454 unsigned int cmd, unsigned long arg );
455 static int digi_tiocmget( struct usb_serial_port *port, struct file *file );
456 static int digi_tiocmset( struct usb_serial_port *port, struct file *file,
457 unsigned int set, unsigned int clear );
458 static int digi_write( struct usb_serial_port *port, const unsigned char *buf, int count );
459 static void digi_write_bulk_callback( struct urb *urb, struct pt_regs *regs );
460 static int digi_write_room( struct usb_serial_port *port );
461 static int digi_chars_in_buffer( struct usb_serial_port *port );
462 static int digi_open( struct usb_serial_port *port, struct file *filp );
463 static void digi_close( struct usb_serial_port *port, struct file *filp );
464 static int digi_startup_device( struct usb_serial *serial );
465 static int digi_startup( struct usb_serial *serial );
466 static void digi_shutdown( struct usb_serial *serial );
467 static void digi_read_bulk_callback( struct urb *urb, struct pt_regs *regs );
468 static int digi_read_inb_callback( struct urb *urb );
469 static int digi_read_oob_callback( struct urb *urb );
476 static struct usb_device_id id_table_combined [] = {
477 { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
478 { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
479 { } /* Terminating entry */
482 static struct usb_device_id id_table_2 [] = {
483 { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
484 { } /* Terminating entry */
487 static struct usb_device_id id_table_4 [] = {
488 { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
489 { } /* Terminating entry */
492 MODULE_DEVICE_TABLE (usb, id_table_combined);
494 static struct usb_driver digi_driver = {
495 .owner = THIS_MODULE,
496 .name = "digi_acceleport",
497 .probe = usb_serial_probe,
498 .disconnect = usb_serial_disconnect,
499 .id_table = id_table_combined,
503 /* device info needed for the Digi serial converter */
505 static struct usb_serial_device_type digi_acceleport_2_device = {
506 .owner = THIS_MODULE,
507 .name = "Digi 2 port USB adapter",
508 .short_name = "digi_2",
509 .id_table = id_table_2,
510 .num_interrupt_in = 0,
517 .write_room = digi_write_room,
518 .write_bulk_callback = digi_write_bulk_callback,
519 .read_bulk_callback = digi_read_bulk_callback,
520 .chars_in_buffer = digi_chars_in_buffer,
521 .throttle = digi_rx_throttle,
522 .unthrottle = digi_rx_unthrottle,
524 .set_termios = digi_set_termios,
525 .break_ctl = digi_break_ctl,
526 .tiocmget = digi_tiocmget,
527 .tiocmset = digi_tiocmset,
528 .attach = digi_startup,
529 .shutdown = digi_shutdown,
532 static struct usb_serial_device_type digi_acceleport_4_device = {
533 .owner = THIS_MODULE,
534 .name = "Digi 4 port USB adapter",
535 .short_name = "digi_4",
536 .id_table = id_table_4,
537 .num_interrupt_in = 0,
544 .write_room = digi_write_room,
545 .write_bulk_callback = digi_write_bulk_callback,
546 .read_bulk_callback = digi_read_bulk_callback,
547 .chars_in_buffer = digi_chars_in_buffer,
548 .throttle = digi_rx_throttle,
549 .unthrottle = digi_rx_unthrottle,
551 .set_termios = digi_set_termios,
552 .break_ctl = digi_break_ctl,
553 .tiocmget = digi_tiocmget,
554 .tiocmset = digi_tiocmset,
555 .attach = digi_startup,
556 .shutdown = digi_shutdown,
563 * Cond Wait Interruptible Timeout Irqrestore
565 * Do spin_unlock_irqrestore and interruptible_sleep_on_timeout
566 * so that wake ups are not lost if they occur between the unlock
567 * and the sleep. In other words, spin_unlock_irqrestore and
568 * interruptible_sleep_on_timeout are "atomic" with respect to
569 * wake ups. This is used to implement condition variables.
572 static inline long cond_wait_interruptible_timeout_irqrestore(
573 wait_queue_head_t *q, long timeout,
574 spinlock_t *lock, unsigned long flags )
580 init_waitqueue_entry( &wait, current );
582 set_current_state( TASK_INTERRUPTIBLE );
584 add_wait_queue( q, &wait );
586 spin_unlock_irqrestore( lock, flags );
588 timeout = schedule_timeout(timeout);
590 remove_wait_queue( q, &wait );
600 * Wake up port, line discipline, and tty processes sleeping
604 static void digi_wakeup_write_lock(void *arg)
606 struct usb_serial_port *port = arg;
608 struct digi_port *priv = usb_get_serial_port_data(port);
611 spin_lock_irqsave( &priv->dp_port_lock, flags );
612 digi_wakeup_write( port );
613 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
616 static void digi_wakeup_write( struct usb_serial_port *port )
619 struct tty_struct *tty = port->tty;
622 /* wake up port processes */
623 wake_up_interruptible( &port->write_wait );
625 /* wake up line discipline */
631 * Digi Write OOB Command
633 * Write commands on the out of band port. Commands are 4
634 * bytes each, multiple commands can be sent at once, and
635 * no command will be split across USB packets. Returns 0
636 * if successful, -EINTR if interrupted while sleeping and
637 * the interruptible flag is true, or a negative error
638 * returned by usb_submit_urb.
641 static int digi_write_oob_command( struct usb_serial_port *port,
642 unsigned char *buf, int count, int interruptible )
647 struct usb_serial_port *oob_port = (struct usb_serial_port *)((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
648 struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
649 unsigned long flags = 0;
652 dbg( "digi_write_oob_command: TOP: port=%d, count=%d", oob_priv->dp_port_num, count );
654 spin_lock_irqsave( &oob_priv->dp_port_lock, flags );
658 while( oob_port->write_urb->status == -EINPROGRESS
659 || oob_priv->dp_write_urb_in_use ) {
660 cond_wait_interruptible_timeout_irqrestore(
661 &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
662 &oob_priv->dp_port_lock, flags );
663 if( interruptible && signal_pending(current) ) {
666 spin_lock_irqsave( &oob_priv->dp_port_lock, flags );
669 /* len must be a multiple of 4, so commands are not split */
670 len = min(count, oob_port->bulk_out_size );
674 memcpy( oob_port->write_urb->transfer_buffer, buf, len );
675 oob_port->write_urb->transfer_buffer_length = len;
676 oob_port->write_urb->dev = port->serial->dev;
678 if( (ret=usb_submit_urb(oob_port->write_urb, GFP_ATOMIC)) == 0 ) {
679 oob_priv->dp_write_urb_in_use = 1;
686 spin_unlock_irqrestore( &oob_priv->dp_port_lock, flags );
689 err("%s: usb_submit_urb failed, ret=%d", __FUNCTION__,
699 * Digi Write In Band Command
701 * Write commands on the given port. Commands are 4
702 * bytes each, multiple commands can be sent at once, and
703 * no command will be split across USB packets. If timeout
704 * is non-zero, write in band command will return after
705 * waiting unsuccessfully for the URB status to clear for
706 * timeout ticks. Returns 0 if successful, or a negative
707 * error returned by digi_write.
710 static int digi_write_inb_command( struct usb_serial_port *port,
711 unsigned char *buf, int count, unsigned long timeout )
716 struct digi_port *priv = usb_get_serial_port_data(port);
717 unsigned char *data = port->write_urb->transfer_buffer;
718 unsigned long flags = 0;
721 dbg( "digi_write_inb_command: TOP: port=%d, count=%d", priv->dp_port_num,
729 spin_lock_irqsave( &priv->dp_port_lock, flags );
731 while( count > 0 && ret == 0 ) {
733 while( (port->write_urb->status == -EINPROGRESS
734 || priv->dp_write_urb_in_use) && time_before(jiffies, timeout)) {
735 cond_wait_interruptible_timeout_irqrestore(
736 &port->write_wait, DIGI_RETRY_TIMEOUT,
737 &priv->dp_port_lock, flags );
738 if( signal_pending(current) ) {
741 spin_lock_irqsave( &priv->dp_port_lock, flags );
744 /* len must be a multiple of 4 and small enough to */
745 /* guarantee the write will send buffered data first, */
746 /* so commands are in order with data and not split */
747 len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len );
751 /* write any buffered data first */
752 if( priv->dp_out_buf_len > 0 ) {
753 data[0] = DIGI_CMD_SEND_DATA;
754 data[1] = priv->dp_out_buf_len;
755 memcpy( data+2, priv->dp_out_buf,
756 priv->dp_out_buf_len );
757 memcpy( data+2+priv->dp_out_buf_len, buf, len );
758 port->write_urb->transfer_buffer_length
759 = priv->dp_out_buf_len+2+len;
761 memcpy( data, buf, len );
762 port->write_urb->transfer_buffer_length = len;
764 port->write_urb->dev = port->serial->dev;
766 if( (ret=usb_submit_urb(port->write_urb, GFP_ATOMIC)) == 0 ) {
767 priv->dp_write_urb_in_use = 1;
768 priv->dp_out_buf_len = 0;
775 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
778 err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
779 ret, priv->dp_port_num );
788 * Digi Set Modem Signals
790 * Sets or clears DTR and RTS on the port, according to the
791 * modem_signals argument. Use TIOCM_DTR and TIOCM_RTS flags
792 * for the modem_signals argument. Returns 0 if successful,
793 * -EINTR if interrupted while sleeping, or a non-zero error
794 * returned by usb_submit_urb.
797 static int digi_set_modem_signals( struct usb_serial_port *port,
798 unsigned int modem_signals, int interruptible )
802 struct digi_port *port_priv = usb_get_serial_port_data(port);
803 struct usb_serial_port *oob_port = (struct usb_serial_port *)((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
804 struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
805 unsigned char *data = oob_port->write_urb->transfer_buffer;
806 unsigned long flags = 0;
809 dbg( "digi_set_modem_signals: TOP: port=%d, modem_signals=0x%x",
810 port_priv->dp_port_num, modem_signals );
812 spin_lock_irqsave( &oob_priv->dp_port_lock, flags );
813 spin_lock( &port_priv->dp_port_lock );
815 while( oob_port->write_urb->status == -EINPROGRESS
816 || oob_priv->dp_write_urb_in_use ) {
817 spin_unlock( &port_priv->dp_port_lock );
818 cond_wait_interruptible_timeout_irqrestore(
819 &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
820 &oob_priv->dp_port_lock, flags );
821 if( interruptible && signal_pending(current) ) {
824 spin_lock_irqsave( &oob_priv->dp_port_lock, flags );
825 spin_lock( &port_priv->dp_port_lock );
828 data[0] = DIGI_CMD_SET_DTR_SIGNAL;
829 data[1] = port_priv->dp_port_num;
830 data[2] = (modem_signals&TIOCM_DTR) ?
831 DIGI_DTR_ACTIVE : DIGI_DTR_INACTIVE;
834 data[4] = DIGI_CMD_SET_RTS_SIGNAL;
835 data[5] = port_priv->dp_port_num;
836 data[6] = (modem_signals&TIOCM_RTS) ?
837 DIGI_RTS_ACTIVE : DIGI_RTS_INACTIVE;
840 oob_port->write_urb->transfer_buffer_length = 8;
841 oob_port->write_urb->dev = port->serial->dev;
843 if( (ret=usb_submit_urb(oob_port->write_urb, GFP_ATOMIC)) == 0 ) {
844 oob_priv->dp_write_urb_in_use = 1;
845 port_priv->dp_modem_signals =
846 (port_priv->dp_modem_signals&~(TIOCM_DTR|TIOCM_RTS))
847 | (modem_signals&(TIOCM_DTR|TIOCM_RTS));
850 spin_unlock( &port_priv->dp_port_lock );
851 spin_unlock_irqrestore( &oob_priv->dp_port_lock, flags );
854 err("%s: usb_submit_urb failed, ret=%d", __FUNCTION__,
866 * Digi transmit idle waits, up to timeout ticks, for the transmitter
867 * to go idle. It returns 0 if successful or a negative error.
869 * There are race conditions here if more than one process is calling
870 * digi_transmit_idle on the same port at the same time. However, this
871 * is only called from close, and only one process can be in close on a
872 * port at a time, so its ok.
875 static int digi_transmit_idle( struct usb_serial_port *port,
876 unsigned long timeout )
880 unsigned char buf[2];
881 struct digi_port *priv = usb_get_serial_port_data(port);
882 unsigned long flags = 0;
885 spin_lock_irqsave( &priv->dp_port_lock, flags );
886 priv->dp_transmit_idle = 0;
887 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
889 buf[0] = DIGI_CMD_TRANSMIT_IDLE;
894 if( (ret=digi_write_inb_command( port, buf, 2, timeout-jiffies )) != 0 )
897 spin_lock_irqsave( &priv->dp_port_lock, flags );
899 while( time_before(jiffies, timeout) && !priv->dp_transmit_idle ) {
900 cond_wait_interruptible_timeout_irqrestore(
901 &priv->dp_transmit_idle_wait, DIGI_RETRY_TIMEOUT,
902 &priv->dp_port_lock, flags );
903 if( signal_pending(current) ) {
906 spin_lock_irqsave( &priv->dp_port_lock, flags );
909 priv->dp_transmit_idle = 0;
910 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
917 static void digi_rx_throttle( struct usb_serial_port *port )
921 struct digi_port *priv = usb_get_serial_port_data(port);
924 dbg( "digi_rx_throttle: TOP: port=%d", priv->dp_port_num );
926 /* stop receiving characters by not resubmitting the read urb */
927 spin_lock_irqsave( &priv->dp_port_lock, flags );
928 priv->dp_throttled = 1;
929 priv->dp_throttle_restart = 0;
930 priv->dp_in_buf_len = 0;
931 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
936 static void digi_rx_unthrottle( struct usb_serial_port *port )
942 struct digi_port *priv = usb_get_serial_port_data(port);
943 struct tty_struct *tty = port->tty;
946 dbg( "digi_rx_unthrottle: TOP: port=%d", priv->dp_port_num );
948 spin_lock_irqsave( &priv->dp_port_lock, flags );
950 /* send any buffered chars from throttle time on to tty subsystem */
951 len = min(priv->dp_in_buf_len, TTY_FLIPBUF_SIZE - tty->flip.count );
953 memcpy( tty->flip.char_buf_ptr, priv->dp_in_buf, len );
954 memcpy( tty->flip.flag_buf_ptr, priv->dp_in_flag_buf, len );
955 tty->flip.char_buf_ptr += len;
956 tty->flip.flag_buf_ptr += len;
957 tty->flip.count += len;
958 tty_flip_buffer_push( tty );
961 /* restart read chain */
962 if( priv->dp_throttle_restart ) {
963 port->read_urb->dev = port->serial->dev;
964 ret = usb_submit_urb( port->read_urb, GFP_ATOMIC );
967 /* turn throttle off */
968 priv->dp_throttled = 0;
969 priv->dp_in_buf_len = 0;
970 priv->dp_throttle_restart = 0;
972 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
975 err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
976 ret, priv->dp_port_num );
982 static void digi_set_termios( struct usb_serial_port *port,
983 struct termios *old_termios )
986 struct digi_port *priv = usb_get_serial_port_data(port);
987 unsigned int iflag = port->tty->termios->c_iflag;
988 unsigned int cflag = port->tty->termios->c_cflag;
989 unsigned int old_iflag = old_termios->c_iflag;
990 unsigned int old_cflag = old_termios->c_cflag;
991 unsigned char buf[32];
992 unsigned int modem_signals;
997 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 );
1000 if( (cflag&CBAUD) != (old_cflag&CBAUD) ) {
1004 /* reassert DTR and (maybe) RTS on transition from B0 */
1005 if( (old_cflag&CBAUD) == B0 ) {
1006 /* don't set RTS if using hardware flow control */
1007 /* and throttling input */
1008 modem_signals = TIOCM_DTR;
1009 if( !(port->tty->termios->c_cflag & CRTSCTS) ||
1010 !test_bit(TTY_THROTTLED, &port->tty->flags) ) {
1011 modem_signals |= TIOCM_RTS;
1013 digi_set_modem_signals( port, modem_signals, 1 );
1016 switch( (cflag&CBAUD) ) {
1017 /* drop DTR and RTS on transition to B0 */
1018 case B0: digi_set_modem_signals( port, 0, 1 ); break;
1019 case B50: arg = DIGI_BAUD_50; break;
1020 case B75: arg = DIGI_BAUD_75; break;
1021 case B110: arg = DIGI_BAUD_110; break;
1022 case B150: arg = DIGI_BAUD_150; break;
1023 case B200: arg = DIGI_BAUD_200; break;
1024 case B300: arg = DIGI_BAUD_300; break;
1025 case B600: arg = DIGI_BAUD_600; break;
1026 case B1200: arg = DIGI_BAUD_1200; break;
1027 case B1800: arg = DIGI_BAUD_1800; break;
1028 case B2400: arg = DIGI_BAUD_2400; break;
1029 case B4800: arg = DIGI_BAUD_4800; break;
1030 case B9600: arg = DIGI_BAUD_9600; break;
1031 case B19200: arg = DIGI_BAUD_19200; break;
1032 case B38400: arg = DIGI_BAUD_38400; break;
1033 case B57600: arg = DIGI_BAUD_57600; break;
1034 case B115200: arg = DIGI_BAUD_115200; break;
1035 case B230400: arg = DIGI_BAUD_230400; break;
1036 case B460800: arg = DIGI_BAUD_460800; break;
1038 dbg( "digi_set_termios: can't handle baud rate 0x%x",
1044 buf[i++] = DIGI_CMD_SET_BAUD_RATE;
1045 buf[i++] = priv->dp_port_num;
1053 if( (cflag&(PARENB|PARODD)) != (old_cflag&(PARENB|PARODD)) ) {
1055 if( (cflag&PARENB) ) {
1056 if( (cflag&PARODD) )
1057 arg = DIGI_PARITY_ODD;
1059 arg = DIGI_PARITY_EVEN;
1061 arg = DIGI_PARITY_NONE;
1064 buf[i++] = DIGI_CMD_SET_PARITY;
1065 buf[i++] = priv->dp_port_num;
1072 if( (cflag&CSIZE) != (old_cflag&CSIZE) ) {
1076 switch( (cflag&CSIZE) ) {
1077 case CS5: arg = DIGI_WORD_SIZE_5; break;
1078 case CS6: arg = DIGI_WORD_SIZE_6; break;
1079 case CS7: arg = DIGI_WORD_SIZE_7; break;
1080 case CS8: arg = DIGI_WORD_SIZE_8; break;
1082 dbg( "digi_set_termios: can't handle word size %d",
1088 buf[i++] = DIGI_CMD_SET_WORD_SIZE;
1089 buf[i++] = priv->dp_port_num;
1097 if( (cflag&CSTOPB) != (old_cflag&CSTOPB) ) {
1099 if( (cflag&CSTOPB) )
1100 arg = DIGI_STOP_BITS_2;
1102 arg = DIGI_STOP_BITS_1;
1104 buf[i++] = DIGI_CMD_SET_STOP_BITS;
1105 buf[i++] = priv->dp_port_num;
1111 /* set input flow control */
1112 if( (iflag&IXOFF) != (old_iflag&IXOFF)
1113 || (cflag&CRTSCTS) != (old_cflag&CRTSCTS) ) {
1118 arg |= DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
1120 arg &= ~DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
1122 if( (cflag&CRTSCTS) ) {
1124 arg |= DIGI_INPUT_FLOW_CONTROL_RTS;
1126 /* On USB-4 it is necessary to assert RTS prior */
1127 /* to selecting RTS input flow control. */
1128 buf[i++] = DIGI_CMD_SET_RTS_SIGNAL;
1129 buf[i++] = priv->dp_port_num;
1130 buf[i++] = DIGI_RTS_ACTIVE;
1134 arg &= ~DIGI_INPUT_FLOW_CONTROL_RTS;
1137 buf[i++] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1138 buf[i++] = priv->dp_port_num;
1144 /* set output flow control */
1145 if( (iflag&IXON) != (old_iflag&IXON)
1146 || (cflag&CRTSCTS) != (old_cflag&CRTSCTS) ) {
1151 arg |= DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
1153 arg &= ~DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
1155 if( (cflag&CRTSCTS) ) {
1156 arg |= DIGI_OUTPUT_FLOW_CONTROL_CTS;
1158 arg &= ~DIGI_OUTPUT_FLOW_CONTROL_CTS;
1159 port->tty->hw_stopped = 0;
1162 buf[i++] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1163 buf[i++] = priv->dp_port_num;
1169 /* set receive enable/disable */
1170 if( (cflag&CREAD) != (old_cflag&CREAD) ) {
1177 buf[i++] = DIGI_CMD_RECEIVE_ENABLE;
1178 buf[i++] = priv->dp_port_num;
1184 if( (ret=digi_write_oob_command( port, buf, i, 1 )) != 0 )
1185 dbg( "digi_set_termios: write oob failed, ret=%d", ret );
1190 static void digi_break_ctl( struct usb_serial_port *port, int break_state )
1193 unsigned char buf[4];
1196 buf[0] = DIGI_CMD_BREAK_CONTROL;
1197 buf[1] = 2; /* length */
1198 buf[2] = break_state ? 1 : 0;
1199 buf[3] = 0; /* pad */
1201 digi_write_inb_command( port, buf, 4, 0 );
1206 static int digi_tiocmget( struct usb_serial_port *port, struct file *file )
1208 struct digi_port *priv = usb_get_serial_port_data(port);
1210 unsigned long flags;
1212 dbg("%s: TOP: port=%d", __FUNCTION__, priv->dp_port_num);
1214 spin_lock_irqsave( &priv->dp_port_lock, flags );
1215 val = priv->dp_modem_signals;
1216 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1221 static int digi_tiocmset( struct usb_serial_port *port, struct file *file,
1222 unsigned int set, unsigned int clear )
1224 struct digi_port *priv = usb_get_serial_port_data(port);
1226 unsigned long flags;
1228 dbg("%s: TOP: port=%d", __FUNCTION__, priv->dp_port_num);
1230 spin_lock_irqsave( &priv->dp_port_lock, flags );
1231 val = (priv->dp_modem_signals & ~clear) | set;
1232 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1233 return digi_set_modem_signals( port, val, 1 );
1237 static int digi_ioctl( struct usb_serial_port *port, struct file *file,
1238 unsigned int cmd, unsigned long arg )
1241 struct digi_port *priv = usb_get_serial_port_data(port);
1243 dbg( "digi_ioctl: TOP: port=%d, cmd=0x%x", priv->dp_port_num, cmd );
1248 /* wait for any of the 4 modem inputs (DCD,RI,DSR,CTS)*/
1253 /* return count of modemline transitions */
1259 return( -ENOIOCTLCMD );
1264 static int digi_write( struct usb_serial_port *port, const unsigned char *buf, int count )
1267 int ret,data_len,new_len;
1268 struct digi_port *priv = usb_get_serial_port_data(port);
1269 unsigned char *data = port->write_urb->transfer_buffer;
1270 unsigned long flags = 0;
1273 dbg( "digi_write: TOP: port=%d, count=%d, in_interrupt=%ld",
1274 priv->dp_port_num, count, in_interrupt() );
1276 /* copy user data (which can sleep) before getting spin lock */
1277 count = min( count, port->bulk_out_size-2 );
1278 count = min( 64, count);
1280 /* be sure only one write proceeds at a time */
1281 /* there are races on the port private buffer */
1282 /* and races to check write_urb->status */
1283 spin_lock_irqsave( &priv->dp_port_lock, flags );
1285 /* wait for urb status clear to submit another urb */
1286 if( port->write_urb->status == -EINPROGRESS
1287 || priv->dp_write_urb_in_use ) {
1289 /* buffer data if count is 1 (probably put_char) if possible */
1290 if( count == 1 && priv->dp_out_buf_len < DIGI_OUT_BUF_SIZE ) {
1291 priv->dp_out_buf[priv->dp_out_buf_len++] = *buf;
1297 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1303 /* allow space for any buffered data and for new data, up to */
1304 /* transfer buffer size - 2 (for command and length bytes) */
1305 new_len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
1306 data_len = new_len + priv->dp_out_buf_len;
1308 if( data_len == 0 ) {
1309 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1313 port->write_urb->transfer_buffer_length = data_len+2;
1314 port->write_urb->dev = port->serial->dev;
1316 *data++ = DIGI_CMD_SEND_DATA;
1319 /* copy in buffered data first */
1320 memcpy( data, priv->dp_out_buf, priv->dp_out_buf_len );
1321 data += priv->dp_out_buf_len;
1323 /* copy in new data */
1324 memcpy( data, buf, new_len );
1326 if( (ret=usb_submit_urb(port->write_urb, GFP_ATOMIC)) == 0 ) {
1327 priv->dp_write_urb_in_use = 1;
1329 priv->dp_out_buf_len = 0;
1332 /* return length of new data written, or error */
1333 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1335 err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
1336 ret, priv->dp_port_num );
1339 dbg( "digi_write: returning %d", ret );
1345 static void digi_write_bulk_callback( struct urb *urb, struct pt_regs *regs )
1348 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1349 struct usb_serial *serial;
1350 struct digi_port *priv;
1351 struct digi_serial *serial_priv;
1355 dbg( "digi_write_bulk_callback: TOP, urb->status=%d", urb->status );
1357 /* port and serial sanity check */
1358 if( port == NULL || (priv=usb_get_serial_port_data(port)) == NULL ) {
1359 err("%s: port or port->private is NULL, status=%d", __FUNCTION__,
1363 serial = port->serial;
1364 if( serial == NULL || (serial_priv=usb_get_serial_data(serial)) == NULL ) {
1365 err("%s: serial or serial->private is NULL, status=%d", __FUNCTION__, urb->status );
1369 /* handle oob callback */
1370 if( priv->dp_port_num == serial_priv->ds_oob_port_num ) {
1371 dbg( "digi_write_bulk_callback: oob callback" );
1372 spin_lock( &priv->dp_port_lock );
1373 priv->dp_write_urb_in_use = 0;
1374 wake_up_interruptible( &port->write_wait );
1375 spin_unlock( &priv->dp_port_lock );
1379 /* try to send any buffered data on this port, if it is open */
1380 spin_lock( &priv->dp_port_lock );
1381 priv->dp_write_urb_in_use = 0;
1382 if( port->open_count && port->write_urb->status != -EINPROGRESS
1383 && priv->dp_out_buf_len > 0 ) {
1385 *((unsigned char *)(port->write_urb->transfer_buffer))
1386 = (unsigned char)DIGI_CMD_SEND_DATA;
1387 *((unsigned char *)(port->write_urb->transfer_buffer)+1)
1388 = (unsigned char)priv->dp_out_buf_len;
1390 port->write_urb->transfer_buffer_length
1391 = priv->dp_out_buf_len+2;
1392 port->write_urb->dev = serial->dev;
1394 memcpy( port->write_urb->transfer_buffer+2, priv->dp_out_buf,
1395 priv->dp_out_buf_len );
1397 if( (ret=usb_submit_urb(port->write_urb, GFP_ATOMIC)) == 0 ) {
1398 priv->dp_write_urb_in_use = 1;
1399 priv->dp_out_buf_len = 0;
1404 /* wake up processes sleeping on writes immediately */
1405 digi_wakeup_write( port );
1407 /* also queue up a wakeup at scheduler time, in case we */
1408 /* lost the race in write_chan(). */
1409 schedule_work(&priv->dp_wakeup_work);
1411 spin_unlock( &priv->dp_port_lock );
1414 err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
1415 ret, priv->dp_port_num );
1421 static int digi_write_room( struct usb_serial_port *port )
1425 struct digi_port *priv = usb_get_serial_port_data(port);
1426 unsigned long flags = 0;
1429 spin_lock_irqsave( &priv->dp_port_lock, flags );
1431 if( port->write_urb->status == -EINPROGRESS
1432 || priv->dp_write_urb_in_use )
1435 room = port->bulk_out_size - 2 - priv->dp_out_buf_len;
1437 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1439 dbg( "digi_write_room: port=%d, room=%d", priv->dp_port_num, room );
1445 static int digi_chars_in_buffer( struct usb_serial_port *port )
1448 struct digi_port *priv = usb_get_serial_port_data(port);
1451 if( port->write_urb->status == -EINPROGRESS
1452 || priv->dp_write_urb_in_use ) {
1453 dbg( "digi_chars_in_buffer: port=%d, chars=%d", priv->dp_port_num, port->bulk_out_size - 2 );
1454 /* return( port->bulk_out_size - 2 ); */
1457 dbg( "digi_chars_in_buffer: port=%d, chars=%d", priv->dp_port_num, priv->dp_out_buf_len );
1458 return( priv->dp_out_buf_len );
1464 static int digi_open( struct usb_serial_port *port, struct file *filp )
1468 unsigned char buf[32];
1469 struct digi_port *priv = usb_get_serial_port_data(port);
1470 struct termios not_termios;
1471 unsigned long flags = 0;
1474 dbg( "digi_open: TOP: port=%d, open_count=%d", priv->dp_port_num, port->open_count );
1476 /* be sure the device is started up */
1477 if( digi_startup_device( port->serial ) != 0 )
1480 spin_lock_irqsave( &priv->dp_port_lock, flags );
1482 /* don't wait on a close in progress for non-blocking opens */
1483 if( priv->dp_in_close && (filp->f_flags&(O_NDELAY|O_NONBLOCK)) == 0 ) {
1484 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1488 /* wait for a close in progress to finish */
1489 while( priv->dp_in_close ) {
1490 cond_wait_interruptible_timeout_irqrestore(
1491 &priv->dp_close_wait, DIGI_RETRY_TIMEOUT,
1492 &priv->dp_port_lock, flags );
1493 if( signal_pending(current) ) {
1496 spin_lock_irqsave( &priv->dp_port_lock, flags );
1499 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1501 /* read modem signals automatically whenever they change */
1502 buf[0] = DIGI_CMD_READ_INPUT_SIGNALS;
1503 buf[1] = priv->dp_port_num;
1504 buf[2] = DIGI_ENABLE;
1508 buf[4] = DIGI_CMD_IFLUSH_FIFO;
1509 buf[5] = priv->dp_port_num;
1510 buf[6] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1513 if( (ret=digi_write_oob_command( port, buf, 8, 1 )) != 0 )
1514 dbg( "digi_open: write oob failed, ret=%d", ret );
1516 /* set termios settings */
1517 not_termios.c_cflag = ~port->tty->termios->c_cflag;
1518 not_termios.c_iflag = ~port->tty->termios->c_iflag;
1519 digi_set_termios( port, ¬_termios );
1521 /* set DTR and RTS */
1522 digi_set_modem_signals( port, TIOCM_DTR|TIOCM_RTS, 1 );
1529 static void digi_close( struct usb_serial_port *port, struct file *filp )
1533 unsigned char buf[32];
1534 struct tty_struct *tty = port->tty;
1535 struct digi_port *priv = usb_get_serial_port_data(port);
1536 unsigned long flags = 0;
1539 dbg( "digi_close: TOP: port=%d, open_count=%d", priv->dp_port_num, port->open_count );
1542 /* if disconnected, just clear flags */
1543 if (!usb_get_intfdata(port->serial->interface))
1546 /* do cleanup only after final close on this port */
1547 spin_lock_irqsave( &priv->dp_port_lock, flags );
1548 priv->dp_in_close = 1;
1549 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1551 /* tell line discipline to process only XON/XOFF */
1554 /* wait for output to drain */
1555 if( (filp->f_flags&(O_NDELAY|O_NONBLOCK)) == 0 ) {
1556 tty_wait_until_sent( tty, DIGI_CLOSE_TIMEOUT );
1559 /* flush driver and line discipline buffers */
1560 if( tty->driver->flush_buffer )
1561 tty->driver->flush_buffer( tty );
1562 tty_ldisc_flush(tty);
1564 if (port->serial->dev) {
1565 /* wait for transmit idle */
1566 if( (filp->f_flags&(O_NDELAY|O_NONBLOCK)) == 0 ) {
1567 digi_transmit_idle( port, DIGI_CLOSE_TIMEOUT );
1570 /* drop DTR and RTS */
1571 digi_set_modem_signals( port, 0, 0 );
1573 /* disable input flow control */
1574 buf[0] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1575 buf[1] = priv->dp_port_num;
1576 buf[2] = DIGI_DISABLE;
1579 /* disable output flow control */
1580 buf[4] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1581 buf[5] = priv->dp_port_num;
1582 buf[6] = DIGI_DISABLE;
1585 /* disable reading modem signals automatically */
1586 buf[8] = DIGI_CMD_READ_INPUT_SIGNALS;
1587 buf[9] = priv->dp_port_num;
1588 buf[10] = DIGI_DISABLE;
1591 /* disable receive */
1592 buf[12] = DIGI_CMD_RECEIVE_ENABLE;
1593 buf[13] = priv->dp_port_num;
1594 buf[14] = DIGI_DISABLE;
1598 buf[16] = DIGI_CMD_IFLUSH_FIFO;
1599 buf[17] = priv->dp_port_num;
1600 buf[18] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1603 if( (ret=digi_write_oob_command( port, buf, 20, 0 )) != 0 )
1604 dbg( "digi_close: write oob failed, ret=%d", ret );
1606 /* wait for final commands on oob port to complete */
1607 interruptible_sleep_on_timeout( &priv->dp_flush_wait,
1608 DIGI_CLOSE_TIMEOUT );
1610 /* shutdown any outstanding bulk writes */
1611 usb_kill_urb(port->write_urb);
1617 spin_lock_irqsave( &priv->dp_port_lock, flags );
1618 priv->dp_write_urb_in_use = 0;
1619 priv->dp_in_close = 0;
1620 wake_up_interruptible( &priv->dp_close_wait );
1621 spin_unlock_irqrestore( &priv->dp_port_lock, flags );
1623 dbg( "digi_close: done" );
1628 * Digi Startup Device
1630 * Starts reads on all ports. Must be called AFTER startup, with
1631 * urbs initialized. Returns 0 if successful, non-zero error otherwise.
1634 static int digi_startup_device( struct usb_serial *serial )
1638 struct digi_serial *serial_priv = usb_get_serial_data(serial);
1639 struct usb_serial_port *port;
1642 /* be sure this happens exactly once */
1643 spin_lock( &serial_priv->ds_serial_lock );
1644 if( serial_priv->ds_device_started ) {
1645 spin_unlock( &serial_priv->ds_serial_lock );
1648 serial_priv->ds_device_started = 1;
1649 spin_unlock( &serial_priv->ds_serial_lock );
1651 /* start reading from each bulk in endpoint for the device */
1652 /* set USB_DISABLE_SPD flag for write bulk urbs */
1653 for( i=0; i<serial->type->num_ports+1; i++ ) {
1655 port = serial->port[i];
1657 port->write_urb->dev = port->serial->dev;
1659 if( (ret=usb_submit_urb(port->read_urb, GFP_KERNEL)) != 0 ) {
1660 err("%s: usb_submit_urb failed, ret=%d, port=%d", __FUNCTION__,
1672 static int digi_startup( struct usb_serial *serial )
1676 struct digi_port *priv;
1677 struct digi_serial *serial_priv;
1680 dbg( "digi_startup: TOP" );
1682 /* allocate the private data structures for all ports */
1683 /* number of regular ports + 1 for the out-of-band port */
1684 for( i=0; i<serial->type->num_ports+1; i++ ) {
1686 /* allocate port private structure */
1687 priv = (struct digi_port *)kmalloc( sizeof(struct digi_port),
1689 if( priv == (struct digi_port *)0 ) {
1691 kfree( usb_get_serial_port_data(serial->port[i]) );
1692 return( 1 ); /* error */
1695 /* initialize port private structure */
1696 spin_lock_init( &priv->dp_port_lock );
1697 priv->dp_port_num = i;
1698 priv->dp_out_buf_len = 0;
1699 priv->dp_in_buf_len = 0;
1700 priv->dp_write_urb_in_use = 0;
1701 priv->dp_modem_signals = 0;
1702 init_waitqueue_head( &priv->dp_modem_change_wait );
1703 priv->dp_transmit_idle = 0;
1704 init_waitqueue_head( &priv->dp_transmit_idle_wait );
1705 priv->dp_throttled = 0;
1706 priv->dp_throttle_restart = 0;
1707 init_waitqueue_head( &priv->dp_flush_wait );
1708 priv->dp_in_close = 0;
1709 init_waitqueue_head( &priv->dp_close_wait );
1710 INIT_WORK(&priv->dp_wakeup_work,
1711 digi_wakeup_write_lock, serial->port[i]);
1713 /* initialize write wait queue for this port */
1714 init_waitqueue_head( &serial->port[i]->write_wait );
1716 usb_set_serial_port_data(serial->port[i], priv);
1719 /* allocate serial private structure */
1720 serial_priv = (struct digi_serial *)kmalloc( sizeof(struct digi_serial),
1722 if( serial_priv == (struct digi_serial *)0 ) {
1723 for( i=0; i<serial->type->num_ports+1; i++ )
1724 kfree( usb_get_serial_port_data(serial->port[i]) );
1725 return( 1 ); /* error */
1728 /* initialize serial private structure */
1729 spin_lock_init( &serial_priv->ds_serial_lock );
1730 serial_priv->ds_oob_port_num = serial->type->num_ports;
1731 serial_priv->ds_oob_port = serial->port[serial_priv->ds_oob_port_num];
1732 serial_priv->ds_device_started = 0;
1733 usb_set_serial_data(serial, serial_priv);
1740 static void digi_shutdown( struct usb_serial *serial )
1746 dbg( "digi_shutdown: TOP, in_interrupt()=%ld", in_interrupt() );
1748 /* stop reads and writes on all ports */
1749 for( i=0; i<serial->type->num_ports+1; i++ ) {
1750 usb_kill_urb(serial->port[i]->read_urb);
1751 usb_kill_urb(serial->port[i]->write_urb);
1754 /* free the private data structures for all ports */
1755 /* number of regular ports + 1 for the out-of-band port */
1756 for( i=0; i<serial->type->num_ports+1; i++ )
1757 kfree( usb_get_serial_port_data(serial->port[i]) );
1758 kfree( usb_get_serial_data(serial) );
1762 static void digi_read_bulk_callback( struct urb *urb, struct pt_regs *regs )
1765 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1766 struct digi_port *priv;
1767 struct digi_serial *serial_priv;
1771 dbg( "digi_read_bulk_callback: TOP" );
1773 /* port sanity check, do not resubmit if port is not valid */
1774 if( port == NULL || (priv=usb_get_serial_port_data(port)) == NULL ) {
1775 err("%s: port or port->private is NULL, status=%d", __FUNCTION__,
1779 if( port->serial == NULL
1780 || (serial_priv=usb_get_serial_data(port->serial)) == NULL ) {
1781 err("%s: serial is bad or serial->private is NULL, status=%d", __FUNCTION__, urb->status );
1785 /* do not resubmit urb if it has any status error */
1787 err("%s: nonzero read bulk status: status=%d, port=%d", __FUNCTION__, urb->status, priv->dp_port_num );
1791 /* handle oob or inb callback, do not resubmit if error */
1792 if( priv->dp_port_num == serial_priv->ds_oob_port_num ) {
1793 if( digi_read_oob_callback( urb ) != 0 )
1796 if( digi_read_inb_callback( urb ) != 0 )
1801 urb->dev = port->serial->dev;
1802 if( (ret=usb_submit_urb(urb, GFP_ATOMIC)) != 0 ) {
1803 err("%s: failed resubmitting urb, ret=%d, port=%d", __FUNCTION__,
1804 ret, priv->dp_port_num );
1811 * Digi Read INB Callback
1813 * Digi Read INB Callback handles reads on the in band ports, sending
1814 * the data on to the tty subsystem. When called we know port and
1815 * port->private are not NULL and port->serial has been validated.
1816 * It returns 0 if successful, 1 if successful but the port is
1817 * throttled, and -1 if the sanity checks failed.
1820 static int digi_read_inb_callback( struct urb *urb )
1823 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1824 struct tty_struct *tty = port->tty;
1825 struct digi_port *priv = usb_get_serial_port_data(port);
1826 int opcode = ((unsigned char *)urb->transfer_buffer)[0];
1827 int len = ((unsigned char *)urb->transfer_buffer)[1];
1828 int status = ((unsigned char *)urb->transfer_buffer)[2];
1829 unsigned char *data = ((unsigned char *)urb->transfer_buffer)+3;
1832 /* do not process callbacks on closed ports */
1833 /* but do continue the read chain */
1834 if( port->open_count == 0 )
1837 /* short/multiple packet check */
1838 if( urb->actual_length != len + 2 ) {
1839 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 );
1843 spin_lock( &priv->dp_port_lock );
1845 /* check for throttle; if set, do not resubmit read urb */
1846 /* indicate the read chain needs to be restarted on unthrottle */
1847 throttled = priv->dp_throttled;
1849 priv->dp_throttle_restart = 1;
1852 if( opcode == DIGI_CMD_RECEIVE_DATA ) {
1854 /* get flag from status */
1857 /* overrun is special, not associated with a char */
1858 if( status & DIGI_OVERRUN_ERROR ) {
1859 tty_insert_flip_char( tty, 0, TTY_OVERRUN );
1862 /* break takes precedence over parity, */
1863 /* which takes precedence over framing errors */
1864 if( status & DIGI_BREAK_ERROR ) {
1866 } else if( status & DIGI_PARITY_ERROR ) {
1868 } else if( status & DIGI_FRAMING_ERROR ) {
1872 /* data length is len-1 (one byte of len is status) */
1878 DIGI_IN_BUF_SIZE - priv->dp_in_buf_len );
1881 memcpy( priv->dp_in_buf + priv->dp_in_buf_len,
1883 memset( priv->dp_in_flag_buf
1884 + priv->dp_in_buf_len, flag, len );
1885 priv->dp_in_buf_len += len;
1890 len = min( len, TTY_FLIPBUF_SIZE - tty->flip.count );
1893 memcpy( tty->flip.char_buf_ptr, data, len );
1894 memset( tty->flip.flag_buf_ptr, flag, len );
1895 tty->flip.char_buf_ptr += len;
1896 tty->flip.flag_buf_ptr += len;
1897 tty->flip.count += len;
1898 tty_flip_buffer_push( tty );
1905 spin_unlock( &priv->dp_port_lock );
1907 if( opcode == DIGI_CMD_RECEIVE_DISABLE ) {
1908 dbg("%s: got RECEIVE_DISABLE", __FUNCTION__ );
1909 } else if( opcode != DIGI_CMD_RECEIVE_DATA ) {
1910 dbg("%s: unknown opcode: %d", __FUNCTION__, opcode );
1913 return( throttled ? 1 : 0 );
1919 * Digi Read OOB Callback
1921 * Digi Read OOB Callback handles reads on the out of band port.
1922 * When called we know port and port->private are not NULL and
1923 * the port->serial is valid. It returns 0 if successful, and
1924 * -1 if the sanity checks failed.
1927 static int digi_read_oob_callback( struct urb *urb )
1930 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1931 struct usb_serial *serial = port->serial;
1932 struct digi_port *priv = usb_get_serial_port_data(port);
1933 int opcode, line, status, val;
1937 dbg( "digi_read_oob_callback: port=%d, len=%d", priv->dp_port_num,
1938 urb->actual_length );
1940 /* handle each oob command */
1941 for( i=0; i<urb->actual_length-3; ) {
1943 opcode = ((unsigned char *)urb->transfer_buffer)[i++];
1944 line = ((unsigned char *)urb->transfer_buffer)[i++];
1945 status = ((unsigned char *)urb->transfer_buffer)[i++];
1946 val = ((unsigned char *)urb->transfer_buffer)[i++];
1948 dbg( "digi_read_oob_callback: opcode=%d, line=%d, status=%d, val=%d",
1949 opcode, line, status, val );
1951 if( status != 0 || line >= serial->type->num_ports )
1954 port = serial->port[line];
1956 if ((priv=usb_get_serial_port_data(port)) == NULL )
1959 if( opcode == DIGI_CMD_READ_INPUT_SIGNALS ) {
1961 spin_lock( &priv->dp_port_lock );
1963 /* convert from digi flags to termiox flags */
1964 if( val & DIGI_READ_INPUT_SIGNALS_CTS ) {
1965 priv->dp_modem_signals |= TIOCM_CTS;
1966 /* port must be open to use tty struct */
1967 if( port->open_count
1968 && port->tty->termios->c_cflag & CRTSCTS ) {
1969 port->tty->hw_stopped = 0;
1970 digi_wakeup_write( port );
1973 priv->dp_modem_signals &= ~TIOCM_CTS;
1974 /* port must be open to use tty struct */
1975 if( port->open_count
1976 && port->tty->termios->c_cflag & CRTSCTS ) {
1977 port->tty->hw_stopped = 1;
1980 if( val & DIGI_READ_INPUT_SIGNALS_DSR )
1981 priv->dp_modem_signals |= TIOCM_DSR;
1983 priv->dp_modem_signals &= ~TIOCM_DSR;
1984 if( val & DIGI_READ_INPUT_SIGNALS_RI )
1985 priv->dp_modem_signals |= TIOCM_RI;
1987 priv->dp_modem_signals &= ~TIOCM_RI;
1988 if( val & DIGI_READ_INPUT_SIGNALS_DCD )
1989 priv->dp_modem_signals |= TIOCM_CD;
1991 priv->dp_modem_signals &= ~TIOCM_CD;
1993 wake_up_interruptible( &priv->dp_modem_change_wait );
1994 spin_unlock( &priv->dp_port_lock );
1996 } else if( opcode == DIGI_CMD_TRANSMIT_IDLE ) {
1998 spin_lock( &priv->dp_port_lock );
1999 priv->dp_transmit_idle = 1;
2000 wake_up_interruptible( &priv->dp_transmit_idle_wait );
2001 spin_unlock( &priv->dp_port_lock );
2003 } else if( opcode == DIGI_CMD_IFLUSH_FIFO ) {
2005 wake_up_interruptible( &priv->dp_flush_wait );
2016 static int __init digi_init (void)
2019 retval = usb_serial_register(&digi_acceleport_2_device);
2021 goto failed_acceleport_2_device;
2022 retval = usb_serial_register(&digi_acceleport_4_device);
2024 goto failed_acceleport_4_device;
2025 retval = usb_register(&digi_driver);
2027 goto failed_usb_register;
2028 info(DRIVER_VERSION ":" DRIVER_DESC);
2030 failed_usb_register:
2031 usb_serial_deregister(&digi_acceleport_4_device);
2032 failed_acceleport_4_device:
2033 usb_serial_deregister(&digi_acceleport_2_device);
2034 failed_acceleport_2_device:
2039 static void __exit digi_exit (void)
2041 usb_deregister (&digi_driver);
2042 usb_serial_deregister (&digi_acceleport_2_device);
2043 usb_serial_deregister (&digi_acceleport_4_device);
2047 module_init(digi_init);
2048 module_exit(digi_exit);
2051 MODULE_AUTHOR( DRIVER_AUTHOR );
2052 MODULE_DESCRIPTION( DRIVER_DESC );
2053 MODULE_LICENSE("GPL");
2055 module_param(debug, bool, S_IRUGO | S_IWUSR);
2056 MODULE_PARM_DESC(debug, "Debug enabled or not");