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 asynchronously from an interrupt, rather than
161 * from the scheduler. We can avoid the race by calling the wakeup
162 * from the scheduler queue and that's our fix: Now, at the end of
163 * write_bulk_callback() we queue up a wakeup call on the scheduler
164 * task queue. We still also invoke the wakeup directly since that
165 * squeezes a bit more performance out of the driver, and any lost
166 * race conditions will get cleaned up at the next scheduler run.
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.
234 #include <linux/kernel.h>
235 #include <linux/errno.h>
236 #include <linux/init.h>
237 #include <linux/slab.h>
238 #include <linux/tty.h>
239 #include <linux/tty_driver.h>
240 #include <linux/tty_flip.h>
241 #include <linux/module.h>
242 #include <linux/spinlock.h>
243 #include <linux/workqueue.h>
244 #include <asm/uaccess.h>
245 #include <linux/usb.h>
246 #include <linux/wait.h>
247 #include <linux/usb/serial.h>
252 * Version Information
254 #define DRIVER_VERSION "v1.80.1.2"
255 #define DRIVER_AUTHOR "Peter Berger <pberger@brimson.com>, Al Borchers <borchers@steinerpoint.com>"
256 #define DRIVER_DESC "Digi AccelePort USB-2/USB-4 Serial Converter driver"
258 /* port output buffer length -- must be <= transfer buffer length - 2 */
259 /* so we can be sure to send the full buffer in one urb */
260 #define DIGI_OUT_BUF_SIZE 8
262 /* port input buffer length -- must be >= transfer buffer length - 3 */
263 /* so we can be sure to hold at least one full buffer from one urb */
264 #define DIGI_IN_BUF_SIZE 64
266 /* retry timeout while sleeping */
267 #define DIGI_RETRY_TIMEOUT (HZ/10)
269 /* timeout while waiting for tty output to drain in close */
270 /* this delay is used twice in close, so the total delay could */
271 /* be twice this value */
272 #define DIGI_CLOSE_TIMEOUT (5*HZ)
275 /* AccelePort USB Defines */
278 #define DIGI_VENDOR_ID 0x05c5
279 #define DIGI_2_ID 0x0002 /* USB-2 */
280 #define DIGI_4_ID 0x0004 /* USB-4 */
283 * "INB": can be used on the in-band endpoint
284 * "OOB": can be used on the out-of-band endpoint
286 #define DIGI_CMD_SET_BAUD_RATE 0 /* INB, OOB */
287 #define DIGI_CMD_SET_WORD_SIZE 1 /* INB, OOB */
288 #define DIGI_CMD_SET_PARITY 2 /* INB, OOB */
289 #define DIGI_CMD_SET_STOP_BITS 3 /* INB, OOB */
290 #define DIGI_CMD_SET_INPUT_FLOW_CONTROL 4 /* INB, OOB */
291 #define DIGI_CMD_SET_OUTPUT_FLOW_CONTROL 5 /* INB, OOB */
292 #define DIGI_CMD_SET_DTR_SIGNAL 6 /* INB, OOB */
293 #define DIGI_CMD_SET_RTS_SIGNAL 7 /* INB, OOB */
294 #define DIGI_CMD_READ_INPUT_SIGNALS 8 /* OOB */
295 #define DIGI_CMD_IFLUSH_FIFO 9 /* OOB */
296 #define DIGI_CMD_RECEIVE_ENABLE 10 /* INB, OOB */
297 #define DIGI_CMD_BREAK_CONTROL 11 /* INB, OOB */
298 #define DIGI_CMD_LOCAL_LOOPBACK 12 /* INB, OOB */
299 #define DIGI_CMD_TRANSMIT_IDLE 13 /* INB, OOB */
300 #define DIGI_CMD_READ_UART_REGISTER 14 /* OOB */
301 #define DIGI_CMD_WRITE_UART_REGISTER 15 /* INB, OOB */
302 #define DIGI_CMD_AND_UART_REGISTER 16 /* INB, OOB */
303 #define DIGI_CMD_OR_UART_REGISTER 17 /* INB, OOB */
304 #define DIGI_CMD_SEND_DATA 18 /* INB */
305 #define DIGI_CMD_RECEIVE_DATA 19 /* INB */
306 #define DIGI_CMD_RECEIVE_DISABLE 20 /* INB */
307 #define DIGI_CMD_GET_PORT_TYPE 21 /* OOB */
310 #define DIGI_BAUD_50 0
311 #define DIGI_BAUD_75 1
312 #define DIGI_BAUD_110 2
313 #define DIGI_BAUD_150 3
314 #define DIGI_BAUD_200 4
315 #define DIGI_BAUD_300 5
316 #define DIGI_BAUD_600 6
317 #define DIGI_BAUD_1200 7
318 #define DIGI_BAUD_1800 8
319 #define DIGI_BAUD_2400 9
320 #define DIGI_BAUD_4800 10
321 #define DIGI_BAUD_7200 11
322 #define DIGI_BAUD_9600 12
323 #define DIGI_BAUD_14400 13
324 #define DIGI_BAUD_19200 14
325 #define DIGI_BAUD_28800 15
326 #define DIGI_BAUD_38400 16
327 #define DIGI_BAUD_57600 17
328 #define DIGI_BAUD_76800 18
329 #define DIGI_BAUD_115200 19
330 #define DIGI_BAUD_153600 20
331 #define DIGI_BAUD_230400 21
332 #define DIGI_BAUD_460800 22
335 #define DIGI_WORD_SIZE_5 0
336 #define DIGI_WORD_SIZE_6 1
337 #define DIGI_WORD_SIZE_7 2
338 #define DIGI_WORD_SIZE_8 3
340 #define DIGI_PARITY_NONE 0
341 #define DIGI_PARITY_ODD 1
342 #define DIGI_PARITY_EVEN 2
343 #define DIGI_PARITY_MARK 3
344 #define DIGI_PARITY_SPACE 4
346 #define DIGI_STOP_BITS_1 0
347 #define DIGI_STOP_BITS_2 1
349 #define DIGI_INPUT_FLOW_CONTROL_XON_XOFF 1
350 #define DIGI_INPUT_FLOW_CONTROL_RTS 2
351 #define DIGI_INPUT_FLOW_CONTROL_DTR 4
353 #define DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF 1
354 #define DIGI_OUTPUT_FLOW_CONTROL_CTS 2
355 #define DIGI_OUTPUT_FLOW_CONTROL_DSR 4
357 #define DIGI_DTR_INACTIVE 0
358 #define DIGI_DTR_ACTIVE 1
359 #define DIGI_DTR_INPUT_FLOW_CONTROL 2
361 #define DIGI_RTS_INACTIVE 0
362 #define DIGI_RTS_ACTIVE 1
363 #define DIGI_RTS_INPUT_FLOW_CONTROL 2
364 #define DIGI_RTS_TOGGLE 3
366 #define DIGI_FLUSH_TX 1
367 #define DIGI_FLUSH_RX 2
368 #define DIGI_RESUME_TX 4 /* clears xoff condition */
370 #define DIGI_TRANSMIT_NOT_IDLE 0
371 #define DIGI_TRANSMIT_IDLE 1
373 #define DIGI_DISABLE 0
374 #define DIGI_ENABLE 1
376 #define DIGI_DEASSERT 0
377 #define DIGI_ASSERT 1
379 /* in band status codes */
380 #define DIGI_OVERRUN_ERROR 4
381 #define DIGI_PARITY_ERROR 8
382 #define DIGI_FRAMING_ERROR 16
383 #define DIGI_BREAK_ERROR 32
385 /* out of band status */
386 #define DIGI_NO_ERROR 0
387 #define DIGI_BAD_FIRST_PARAMETER 1
388 #define DIGI_BAD_SECOND_PARAMETER 2
389 #define DIGI_INVALID_LINE 3
390 #define DIGI_INVALID_OPCODE 4
393 #define DIGI_READ_INPUT_SIGNALS_SLOT 1
394 #define DIGI_READ_INPUT_SIGNALS_ERR 2
395 #define DIGI_READ_INPUT_SIGNALS_BUSY 4
396 #define DIGI_READ_INPUT_SIGNALS_PE 8
397 #define DIGI_READ_INPUT_SIGNALS_CTS 16
398 #define DIGI_READ_INPUT_SIGNALS_DSR 32
399 #define DIGI_READ_INPUT_SIGNALS_RI 64
400 #define DIGI_READ_INPUT_SIGNALS_DCD 128
406 spinlock_t ds_serial_lock
;
407 struct usb_serial_port
*ds_oob_port
; /* out-of-band port */
408 int ds_oob_port_num
; /* index of out-of-band port */
409 int ds_device_started
;
413 spinlock_t dp_port_lock
;
416 unsigned char dp_out_buf
[DIGI_OUT_BUF_SIZE
];
417 int dp_write_urb_in_use
;
418 unsigned int dp_modem_signals
;
419 wait_queue_head_t dp_modem_change_wait
;
420 int dp_transmit_idle
;
421 wait_queue_head_t dp_transmit_idle_wait
;
423 int dp_throttle_restart
;
424 wait_queue_head_t dp_flush_wait
;
425 int dp_in_close
; /* close in progress */
426 wait_queue_head_t dp_close_wait
; /* wait queue for close */
427 struct work_struct dp_wakeup_work
;
428 struct usb_serial_port
*dp_port
;
432 /* Local Function Declarations */
434 static void digi_wakeup_write(struct usb_serial_port
*port
);
435 static void digi_wakeup_write_lock(struct work_struct
*work
);
436 static int digi_write_oob_command(struct usb_serial_port
*port
,
437 unsigned char *buf
, int count
, int interruptible
);
438 static int digi_write_inb_command(struct usb_serial_port
*port
,
439 unsigned char *buf
, int count
, unsigned long timeout
);
440 static int digi_set_modem_signals(struct usb_serial_port
*port
,
441 unsigned int modem_signals
, int interruptible
);
442 static int digi_transmit_idle(struct usb_serial_port
*port
,
443 unsigned long timeout
);
444 static void digi_rx_throttle (struct usb_serial_port
*port
);
445 static void digi_rx_unthrottle (struct usb_serial_port
*port
);
446 static void digi_set_termios(struct usb_serial_port
*port
,
447 struct ktermios
*old_termios
);
448 static void digi_break_ctl(struct usb_serial_port
*port
, int break_state
);
449 static int digi_ioctl(struct usb_serial_port
*port
, struct file
*file
,
450 unsigned int cmd
, unsigned long arg
);
451 static int digi_tiocmget(struct usb_serial_port
*port
, struct file
*file
);
452 static int digi_tiocmset(struct usb_serial_port
*port
, struct file
*file
,
453 unsigned int set
, unsigned int clear
);
454 static int digi_write(struct usb_serial_port
*port
, const unsigned char *buf
, int count
);
455 static void digi_write_bulk_callback(struct urb
*urb
);
456 static int digi_write_room(struct usb_serial_port
*port
);
457 static int digi_chars_in_buffer(struct usb_serial_port
*port
);
458 static int digi_open(struct usb_serial_port
*port
, struct file
*filp
);
459 static void digi_close(struct usb_serial_port
*port
, struct file
*filp
);
460 static int digi_startup_device(struct usb_serial
*serial
);
461 static int digi_startup(struct usb_serial
*serial
);
462 static void digi_shutdown(struct usb_serial
*serial
);
463 static void digi_read_bulk_callback(struct urb
*urb
);
464 static int digi_read_inb_callback(struct urb
*urb
);
465 static int digi_read_oob_callback(struct urb
*urb
);
472 static struct usb_device_id id_table_combined
[] = {
473 { USB_DEVICE(DIGI_VENDOR_ID
, DIGI_2_ID
) },
474 { USB_DEVICE(DIGI_VENDOR_ID
, DIGI_4_ID
) },
475 { } /* Terminating entry */
478 static struct usb_device_id id_table_2
[] = {
479 { USB_DEVICE(DIGI_VENDOR_ID
, DIGI_2_ID
) },
480 { } /* Terminating entry */
483 static struct usb_device_id id_table_4
[] = {
484 { USB_DEVICE(DIGI_VENDOR_ID
, DIGI_4_ID
) },
485 { } /* Terminating entry */
488 MODULE_DEVICE_TABLE (usb
, id_table_combined
);
490 static struct usb_driver digi_driver
= {
491 .name
= "digi_acceleport",
492 .probe
= usb_serial_probe
,
493 .disconnect
= usb_serial_disconnect
,
494 .id_table
= id_table_combined
,
499 /* device info needed for the Digi serial converter */
501 static struct usb_serial_driver digi_acceleport_2_device
= {
503 .owner
= THIS_MODULE
,
506 .description
= "Digi 2 port USB adapter",
507 .usb_driver
= &digi_driver
,
508 .id_table
= id_table_2
,
513 .write_room
= digi_write_room
,
514 .write_bulk_callback
= digi_write_bulk_callback
,
515 .read_bulk_callback
= digi_read_bulk_callback
,
516 .chars_in_buffer
= digi_chars_in_buffer
,
517 .throttle
= digi_rx_throttle
,
518 .unthrottle
= digi_rx_unthrottle
,
520 .set_termios
= digi_set_termios
,
521 .break_ctl
= digi_break_ctl
,
522 .tiocmget
= digi_tiocmget
,
523 .tiocmset
= digi_tiocmset
,
524 .attach
= digi_startup
,
525 .shutdown
= digi_shutdown
,
528 static struct usb_serial_driver digi_acceleport_4_device
= {
530 .owner
= THIS_MODULE
,
533 .description
= "Digi 4 port USB adapter",
534 .usb_driver
= &digi_driver
,
535 .id_table
= id_table_4
,
540 .write_room
= digi_write_room
,
541 .write_bulk_callback
= digi_write_bulk_callback
,
542 .read_bulk_callback
= digi_read_bulk_callback
,
543 .chars_in_buffer
= digi_chars_in_buffer
,
544 .throttle
= digi_rx_throttle
,
545 .unthrottle
= digi_rx_unthrottle
,
547 .set_termios
= digi_set_termios
,
548 .break_ctl
= digi_break_ctl
,
549 .tiocmget
= digi_tiocmget
,
550 .tiocmset
= digi_tiocmset
,
551 .attach
= digi_startup
,
552 .shutdown
= digi_shutdown
,
559 * Cond Wait Interruptible Timeout Irqrestore
561 * Do spin_unlock_irqrestore and interruptible_sleep_on_timeout
562 * so that wake ups are not lost if they occur between the unlock
563 * and the sleep. In other words, spin_unlock_irqrestore and
564 * interruptible_sleep_on_timeout are "atomic" with respect to
565 * wake ups. This is used to implement condition variables.
567 * interruptible_sleep_on_timeout is deprecated and has been replaced
568 * with the equivalent code.
571 static long cond_wait_interruptible_timeout_irqrestore(
572 wait_queue_head_t
*q
, long timeout
,
573 spinlock_t
*lock
, unsigned long flags
)
577 prepare_to_wait(q
, &wait
, TASK_INTERRUPTIBLE
);
578 spin_unlock_irqrestore(lock
, flags
);
579 timeout
= schedule_timeout(timeout
);
580 finish_wait(q
, &wait
);
589 * Wake up port, line discipline, and tty processes sleeping
593 static void digi_wakeup_write_lock(struct work_struct
*work
)
595 struct digi_port
*priv
= container_of(work
, struct digi_port
, dp_wakeup_work
);
596 struct usb_serial_port
*port
= priv
->dp_port
;
599 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
600 digi_wakeup_write(port
);
601 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
604 static void digi_wakeup_write(struct usb_serial_port
*port
)
606 tty_wakeup(port
->tty
);
611 * Digi Write OOB Command
613 * Write commands on the out of band port. Commands are 4
614 * bytes each, multiple commands can be sent at once, and
615 * no command will be split across USB packets. Returns 0
616 * if successful, -EINTR if interrupted while sleeping and
617 * the interruptible flag is true, or a negative error
618 * returned by usb_submit_urb.
621 static int digi_write_oob_command(struct usb_serial_port
*port
,
622 unsigned char *buf
, int count
, int interruptible
)
627 struct usb_serial_port
*oob_port
= (struct usb_serial_port
*)((struct digi_serial
*)(usb_get_serial_data(port
->serial
)))->ds_oob_port
;
628 struct digi_port
*oob_priv
= usb_get_serial_port_data(oob_port
);
629 unsigned long flags
= 0;
631 dbg("digi_write_oob_command: TOP: port=%d, count=%d", oob_priv
->dp_port_num
, count
);
633 spin_lock_irqsave(&oob_priv
->dp_port_lock
, flags
);
635 while(oob_port
->write_urb
->status
== -EINPROGRESS
636 || oob_priv
->dp_write_urb_in_use
) {
637 cond_wait_interruptible_timeout_irqrestore(
638 &oob_port
->write_wait
, DIGI_RETRY_TIMEOUT
,
639 &oob_priv
->dp_port_lock
, flags
);
640 if (interruptible
&& signal_pending(current
))
642 spin_lock_irqsave(&oob_priv
->dp_port_lock
, flags
);
645 /* len must be a multiple of 4, so commands are not split */
646 len
= min(count
, oob_port
->bulk_out_size
);
649 memcpy(oob_port
->write_urb
->transfer_buffer
, buf
, len
);
650 oob_port
->write_urb
->transfer_buffer_length
= len
;
651 oob_port
->write_urb
->dev
= port
->serial
->dev
;
652 if ((ret
= usb_submit_urb(oob_port
->write_urb
, GFP_ATOMIC
)) == 0) {
653 oob_priv
->dp_write_urb_in_use
= 1;
658 spin_unlock_irqrestore(&oob_priv
->dp_port_lock
, flags
);
660 err("%s: usb_submit_urb failed, ret=%d", __func__
, ret
);
667 * Digi Write In Band Command
669 * Write commands on the given port. Commands are 4
670 * bytes each, multiple commands can be sent at once, and
671 * no command will be split across USB packets. If timeout
672 * is non-zero, write in band command will return after
673 * waiting unsuccessfully for the URB status to clear for
674 * timeout ticks. Returns 0 if successful, or a negative
675 * error returned by digi_write.
678 static int digi_write_inb_command(struct usb_serial_port
*port
,
679 unsigned char *buf
, int count
, unsigned long timeout
)
683 struct digi_port
*priv
= usb_get_serial_port_data(port
);
684 unsigned char *data
= port
->write_urb
->transfer_buffer
;
685 unsigned long flags
= 0;
687 dbg("digi_write_inb_command: TOP: port=%d, count=%d",
688 priv
->dp_port_num
, count
);
695 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
696 while(count
> 0 && ret
== 0) {
697 while((port
->write_urb
->status
== -EINPROGRESS
698 || priv
->dp_write_urb_in_use
) && time_before(jiffies
, timeout
)) {
699 cond_wait_interruptible_timeout_irqrestore(
700 &port
->write_wait
, DIGI_RETRY_TIMEOUT
,
701 &priv
->dp_port_lock
, flags
);
702 if (signal_pending(current
))
704 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
707 /* len must be a multiple of 4 and small enough to */
708 /* guarantee the write will send buffered data first, */
709 /* so commands are in order with data and not split */
710 len
= min(count
, port
->bulk_out_size
-2-priv
->dp_out_buf_len
);
714 /* write any buffered data first */
715 if (priv
->dp_out_buf_len
> 0) {
716 data
[0] = DIGI_CMD_SEND_DATA
;
717 data
[1] = priv
->dp_out_buf_len
;
718 memcpy(data
+ 2, priv
->dp_out_buf
,
719 priv
->dp_out_buf_len
);
720 memcpy(data
+ 2 + priv
->dp_out_buf_len
, buf
, len
);
721 port
->write_urb
->transfer_buffer_length
722 = priv
->dp_out_buf_len
+ 2 + len
;
724 memcpy(data
, buf
, len
);
725 port
->write_urb
->transfer_buffer_length
= len
;
727 port
->write_urb
->dev
= port
->serial
->dev
;
729 if ((ret
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
)) == 0) {
730 priv
->dp_write_urb_in_use
= 1;
731 priv
->dp_out_buf_len
= 0;
737 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
740 err("%s: usb_submit_urb failed, ret=%d, port=%d",
741 __func__
, ret
, priv
->dp_port_num
);
747 * Digi Set Modem Signals
749 * Sets or clears DTR and RTS on the port, according to the
750 * modem_signals argument. Use TIOCM_DTR and TIOCM_RTS flags
751 * for the modem_signals argument. Returns 0 if successful,
752 * -EINTR if interrupted while sleeping, or a non-zero error
753 * returned by usb_submit_urb.
756 static int digi_set_modem_signals(struct usb_serial_port
*port
,
757 unsigned int modem_signals
, int interruptible
)
761 struct digi_port
*port_priv
= usb_get_serial_port_data(port
);
762 struct usb_serial_port
*oob_port
= (struct usb_serial_port
*)((struct digi_serial
*)(usb_get_serial_data(port
->serial
)))->ds_oob_port
;
763 struct digi_port
*oob_priv
= usb_get_serial_port_data(oob_port
);
764 unsigned char *data
= oob_port
->write_urb
->transfer_buffer
;
765 unsigned long flags
= 0;
768 dbg("digi_set_modem_signals: TOP: port=%d, modem_signals=0x%x",
769 port_priv
->dp_port_num
, modem_signals
);
771 spin_lock_irqsave(&oob_priv
->dp_port_lock
, flags
);
772 spin_lock(&port_priv
->dp_port_lock
);
774 while(oob_port
->write_urb
->status
== -EINPROGRESS
|| oob_priv
->dp_write_urb_in_use
) {
775 spin_unlock(&port_priv
->dp_port_lock
);
776 cond_wait_interruptible_timeout_irqrestore(
777 &oob_port
->write_wait
, DIGI_RETRY_TIMEOUT
,
778 &oob_priv
->dp_port_lock
, flags
);
779 if (interruptible
&& signal_pending(current
))
781 spin_lock_irqsave(&oob_priv
->dp_port_lock
, flags
);
782 spin_lock(&port_priv
->dp_port_lock
);
784 data
[0] = DIGI_CMD_SET_DTR_SIGNAL
;
785 data
[1] = port_priv
->dp_port_num
;
786 data
[2] = (modem_signals
&TIOCM_DTR
) ? DIGI_DTR_ACTIVE
: DIGI_DTR_INACTIVE
;
788 data
[4] = DIGI_CMD_SET_RTS_SIGNAL
;
789 data
[5] = port_priv
->dp_port_num
;
790 data
[6] = (modem_signals
&TIOCM_RTS
) ? DIGI_RTS_ACTIVE
: DIGI_RTS_INACTIVE
;
793 oob_port
->write_urb
->transfer_buffer_length
= 8;
794 oob_port
->write_urb
->dev
= port
->serial
->dev
;
796 if ((ret
= usb_submit_urb(oob_port
->write_urb
, GFP_ATOMIC
)) == 0) {
797 oob_priv
->dp_write_urb_in_use
= 1;
798 port_priv
->dp_modem_signals
=
799 (port_priv
->dp_modem_signals
&~(TIOCM_DTR
|TIOCM_RTS
))
800 | (modem_signals
&(TIOCM_DTR
|TIOCM_RTS
));
802 spin_unlock(&port_priv
->dp_port_lock
);
803 spin_unlock_irqrestore(&oob_priv
->dp_port_lock
, flags
);
805 err("%s: usb_submit_urb failed, ret=%d", __func__
, ret
);
812 * Digi transmit idle waits, up to timeout ticks, for the transmitter
813 * to go idle. It returns 0 if successful or a negative error.
815 * There are race conditions here if more than one process is calling
816 * digi_transmit_idle on the same port at the same time. However, this
817 * is only called from close, and only one process can be in close on a
818 * port at a time, so its ok.
821 static int digi_transmit_idle(struct usb_serial_port
*port
,
822 unsigned long timeout
)
825 unsigned char buf
[2];
826 struct digi_port
*priv
= usb_get_serial_port_data(port
);
827 unsigned long flags
= 0;
829 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
830 priv
->dp_transmit_idle
= 0;
831 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
833 buf
[0] = DIGI_CMD_TRANSMIT_IDLE
;
838 if ((ret
= digi_write_inb_command(port
, buf
, 2, timeout
- jiffies
)) != 0)
841 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
843 while(time_before(jiffies
, timeout
) && !priv
->dp_transmit_idle
) {
844 cond_wait_interruptible_timeout_irqrestore(
845 &priv
->dp_transmit_idle_wait
, DIGI_RETRY_TIMEOUT
,
846 &priv
->dp_port_lock
, flags
);
847 if (signal_pending(current
))
849 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
851 priv
->dp_transmit_idle
= 0;
852 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
858 static void digi_rx_throttle(struct usb_serial_port
*port
)
861 struct digi_port
*priv
= usb_get_serial_port_data(port
);
864 dbg("digi_rx_throttle: TOP: port=%d", priv
->dp_port_num
);
866 /* stop receiving characters by not resubmitting the read urb */
867 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
868 priv
->dp_throttled
= 1;
869 priv
->dp_throttle_restart
= 0;
870 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
874 static void digi_rx_unthrottle(struct usb_serial_port
*port
)
878 struct digi_port
*priv
= usb_get_serial_port_data(port
);
880 dbg("digi_rx_unthrottle: TOP: port=%d", priv
->dp_port_num
);
882 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
884 /* turn throttle off */
885 priv
->dp_throttled
= 0;
886 priv
->dp_throttle_restart
= 0;
888 /* restart read chain */
889 if (priv
->dp_throttle_restart
) {
890 port
->read_urb
->dev
= port
->serial
->dev
;
891 ret
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
894 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
897 err("%s: usb_submit_urb failed, ret=%d, port=%d",
898 __func__
, ret
, priv
->dp_port_num
);
902 static void digi_set_termios(struct usb_serial_port
*port
,
903 struct ktermios
*old_termios
)
906 struct digi_port
*priv
= usb_get_serial_port_data(port
);
907 struct tty_struct
*tty
= port
->tty
;
908 unsigned int iflag
= tty
->termios
->c_iflag
;
909 unsigned int cflag
= tty
->termios
->c_cflag
;
910 unsigned int old_iflag
= old_termios
->c_iflag
;
911 unsigned int old_cflag
= old_termios
->c_cflag
;
912 unsigned char buf
[32];
913 unsigned int modem_signals
;
918 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
);
921 if ((baud
= tty_get_baud_rate(tty
)) != tty_termios_baud_rate(old_termios
)) {
924 /* reassert DTR and (maybe) RTS on transition from B0 */
925 if ((old_cflag
&CBAUD
) == B0
) {
926 /* don't set RTS if using hardware flow control */
927 /* and throttling input */
928 modem_signals
= TIOCM_DTR
;
929 if (!(tty
->termios
->c_cflag
& CRTSCTS
) ||
930 !test_bit(TTY_THROTTLED
, &tty
->flags
))
931 modem_signals
|= TIOCM_RTS
;
932 digi_set_modem_signals(port
, modem_signals
, 1);
935 /* drop DTR and RTS on transition to B0 */
936 case 0: digi_set_modem_signals(port
, 0, 1); break;
937 case 50: arg
= DIGI_BAUD_50
; break;
938 case 75: arg
= DIGI_BAUD_75
; break;
939 case 110: arg
= DIGI_BAUD_110
; break;
940 case 150: arg
= DIGI_BAUD_150
; break;
941 case 200: arg
= DIGI_BAUD_200
; break;
942 case 300: arg
= DIGI_BAUD_300
; break;
943 case 600: arg
= DIGI_BAUD_600
; break;
944 case 1200: arg
= DIGI_BAUD_1200
; break;
945 case 1800: arg
= DIGI_BAUD_1800
; break;
946 case 2400: arg
= DIGI_BAUD_2400
; break;
947 case 4800: arg
= DIGI_BAUD_4800
; break;
948 case 9600: arg
= DIGI_BAUD_9600
; break;
949 case 19200: arg
= DIGI_BAUD_19200
; break;
950 case 38400: arg
= DIGI_BAUD_38400
; break;
951 case 57600: arg
= DIGI_BAUD_57600
; break;
952 case 115200: arg
= DIGI_BAUD_115200
; break;
953 case 230400: arg
= DIGI_BAUD_230400
; break;
954 case 460800: arg
= DIGI_BAUD_460800
; break;
956 arg
= DIGI_BAUD_9600
;
961 buf
[i
++] = DIGI_CMD_SET_BAUD_RATE
;
962 buf
[i
++] = priv
->dp_port_num
;
968 tty
->termios
->c_cflag
&= ~CMSPAR
;
970 if ((cflag
&(PARENB
|PARODD
)) != (old_cflag
&(PARENB
|PARODD
))) {
973 arg
= DIGI_PARITY_ODD
;
975 arg
= DIGI_PARITY_EVEN
;
977 arg
= DIGI_PARITY_NONE
;
979 buf
[i
++] = DIGI_CMD_SET_PARITY
;
980 buf
[i
++] = priv
->dp_port_num
;
985 if ((cflag
&CSIZE
) != (old_cflag
&CSIZE
)) {
987 switch (cflag
&CSIZE
) {
988 case CS5
: arg
= DIGI_WORD_SIZE_5
; break;
989 case CS6
: arg
= DIGI_WORD_SIZE_6
; break;
990 case CS7
: arg
= DIGI_WORD_SIZE_7
; break;
991 case CS8
: arg
= DIGI_WORD_SIZE_8
; break;
993 dbg("digi_set_termios: can't handle word size %d",
999 buf
[i
++] = DIGI_CMD_SET_WORD_SIZE
;
1000 buf
[i
++] = priv
->dp_port_num
;
1008 if ((cflag
&CSTOPB
) != (old_cflag
&CSTOPB
)) {
1011 arg
= DIGI_STOP_BITS_2
;
1013 arg
= DIGI_STOP_BITS_1
;
1015 buf
[i
++] = DIGI_CMD_SET_STOP_BITS
;
1016 buf
[i
++] = priv
->dp_port_num
;
1022 /* set input flow control */
1023 if ((iflag
&IXOFF
) != (old_iflag
&IXOFF
)
1024 || (cflag
&CRTSCTS
) != (old_cflag
&CRTSCTS
)) {
1027 arg
|= DIGI_INPUT_FLOW_CONTROL_XON_XOFF
;
1029 arg
&= ~DIGI_INPUT_FLOW_CONTROL_XON_XOFF
;
1031 if (cflag
&CRTSCTS
) {
1032 arg
|= DIGI_INPUT_FLOW_CONTROL_RTS
;
1034 /* On USB-4 it is necessary to assert RTS prior */
1035 /* to selecting RTS input flow control. */
1036 buf
[i
++] = DIGI_CMD_SET_RTS_SIGNAL
;
1037 buf
[i
++] = priv
->dp_port_num
;
1038 buf
[i
++] = DIGI_RTS_ACTIVE
;
1042 arg
&= ~DIGI_INPUT_FLOW_CONTROL_RTS
;
1044 buf
[i
++] = DIGI_CMD_SET_INPUT_FLOW_CONTROL
;
1045 buf
[i
++] = priv
->dp_port_num
;
1050 /* set output flow control */
1051 if ((iflag
& IXON
) != (old_iflag
& IXON
)
1052 || (cflag
& CRTSCTS
) != (old_cflag
& CRTSCTS
)) {
1055 arg
|= DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF
;
1057 arg
&= ~DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF
;
1059 if (cflag
& CRTSCTS
) {
1060 arg
|= DIGI_OUTPUT_FLOW_CONTROL_CTS
;
1062 arg
&= ~DIGI_OUTPUT_FLOW_CONTROL_CTS
;
1063 tty
->hw_stopped
= 0;
1066 buf
[i
++] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL
;
1067 buf
[i
++] = priv
->dp_port_num
;
1072 /* set receive enable/disable */
1073 if ((cflag
& CREAD
) != (old_cflag
& CREAD
)) {
1079 buf
[i
++] = DIGI_CMD_RECEIVE_ENABLE
;
1080 buf
[i
++] = priv
->dp_port_num
;
1084 if ((ret
= digi_write_oob_command(port
, buf
, i
, 1)) != 0)
1085 dbg("digi_set_termios: write oob failed, ret=%d", ret
);
1086 tty_encode_baud_rate(tty
, baud
, baud
);
1090 static void digi_break_ctl(struct usb_serial_port
*port
, int break_state
)
1092 unsigned char buf
[4];
1094 buf
[0] = DIGI_CMD_BREAK_CONTROL
;
1095 buf
[1] = 2; /* length */
1096 buf
[2] = break_state
? 1 : 0;
1097 buf
[3] = 0; /* pad */
1098 digi_write_inb_command(port
, buf
, 4, 0);
1102 static int digi_tiocmget(struct usb_serial_port
*port
, struct file
*file
)
1104 struct digi_port
*priv
= usb_get_serial_port_data(port
);
1106 unsigned long flags
;
1108 dbg("%s: TOP: port=%d", __func__
, priv
->dp_port_num
);
1110 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
1111 val
= priv
->dp_modem_signals
;
1112 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
1117 static int digi_tiocmset(struct usb_serial_port
*port
, struct file
*file
,
1118 unsigned int set
, unsigned int clear
)
1120 struct digi_port
*priv
= usb_get_serial_port_data(port
);
1122 unsigned long flags
;
1124 dbg("%s: TOP: port=%d", __func__
, priv
->dp_port_num
);
1126 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
1127 val
= (priv
->dp_modem_signals
& ~clear
) | set
;
1128 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
1129 return digi_set_modem_signals(port
, val
, 1);
1133 static int digi_ioctl(struct usb_serial_port
*port
, struct file
*file
,
1134 unsigned int cmd
, unsigned long arg
)
1136 struct digi_port
*priv
= usb_get_serial_port_data(port
);
1137 dbg("digi_ioctl: TOP: port=%d, cmd=0x%x", priv
->dp_port_num
, cmd
);
1141 /* wait for any of the 4 modem inputs (DCD,RI,DSR,CTS)*/
1145 /* return count of modemline transitions */
1149 return -ENOIOCTLCMD
;
1153 static int digi_write(struct usb_serial_port
*port
, const unsigned char *buf
, int count
)
1156 int ret
,data_len
,new_len
;
1157 struct digi_port
*priv
= usb_get_serial_port_data(port
);
1158 unsigned char *data
= port
->write_urb
->transfer_buffer
;
1159 unsigned long flags
= 0;
1161 dbg("digi_write: TOP: port=%d, count=%d, in_interrupt=%ld",
1162 priv
->dp_port_num
, count
, in_interrupt());
1164 /* copy user data (which can sleep) before getting spin lock */
1165 count
= min(count
, port
->bulk_out_size
-2);
1166 count
= min(64, count
);
1168 /* be sure only one write proceeds at a time */
1169 /* there are races on the port private buffer */
1170 /* and races to check write_urb->status */
1171 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
1173 /* wait for urb status clear to submit another urb */
1174 if (port
->write_urb
->status
== -EINPROGRESS
|| priv
->dp_write_urb_in_use
) {
1175 /* buffer data if count is 1 (probably put_char) if possible */
1176 if (count
== 1 && priv
->dp_out_buf_len
< DIGI_OUT_BUF_SIZE
) {
1177 priv
->dp_out_buf
[priv
->dp_out_buf_len
++] = *buf
;
1182 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
1186 /* allow space for any buffered data and for new data, up to */
1187 /* transfer buffer size - 2 (for command and length bytes) */
1188 new_len
= min(count
, port
->bulk_out_size
-2-priv
->dp_out_buf_len
);
1189 data_len
= new_len
+ priv
->dp_out_buf_len
;
1191 if (data_len
== 0) {
1192 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
1196 port
->write_urb
->transfer_buffer_length
= data_len
+2;
1197 port
->write_urb
->dev
= port
->serial
->dev
;
1199 *data
++ = DIGI_CMD_SEND_DATA
;
1202 /* copy in buffered data first */
1203 memcpy(data
, priv
->dp_out_buf
, priv
->dp_out_buf_len
);
1204 data
+= priv
->dp_out_buf_len
;
1206 /* copy in new data */
1207 memcpy(data
, buf
, new_len
);
1209 if ((ret
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
)) == 0) {
1210 priv
->dp_write_urb_in_use
= 1;
1212 priv
->dp_out_buf_len
= 0;
1215 /* return length of new data written, or error */
1216 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
1218 err("%s: usb_submit_urb failed, ret=%d, port=%d",
1219 __func__
, ret
, priv
->dp_port_num
);
1220 dbg("digi_write: returning %d", ret
);
1225 static void digi_write_bulk_callback(struct urb
*urb
)
1228 struct usb_serial_port
*port
= urb
->context
;
1229 struct usb_serial
*serial
;
1230 struct digi_port
*priv
;
1231 struct digi_serial
*serial_priv
;
1233 int status
= urb
->status
;
1235 dbg("digi_write_bulk_callback: TOP, urb->status=%d", status
);
1237 /* port and serial sanity check */
1238 if (port
== NULL
|| (priv
=usb_get_serial_port_data(port
)) == NULL
) {
1239 err("%s: port or port->private is NULL, status=%d",
1243 serial
= port
->serial
;
1244 if (serial
== NULL
|| (serial_priv
=usb_get_serial_data(serial
)) == NULL
) {
1245 err("%s: serial or serial->private is NULL, status=%d",
1250 /* handle oob callback */
1251 if (priv
->dp_port_num
== serial_priv
->ds_oob_port_num
) {
1252 dbg("digi_write_bulk_callback: oob callback");
1253 spin_lock(&priv
->dp_port_lock
);
1254 priv
->dp_write_urb_in_use
= 0;
1255 wake_up_interruptible(&port
->write_wait
);
1256 spin_unlock(&priv
->dp_port_lock
);
1260 /* try to send any buffered data on this port, if it is open */
1261 spin_lock(&priv
->dp_port_lock
);
1262 priv
->dp_write_urb_in_use
= 0;
1263 if (port
->open_count
&& port
->write_urb
->status
!= -EINPROGRESS
1264 && priv
->dp_out_buf_len
> 0) {
1265 *((unsigned char *)(port
->write_urb
->transfer_buffer
))
1266 = (unsigned char)DIGI_CMD_SEND_DATA
;
1267 *((unsigned char *)(port
->write_urb
->transfer_buffer
)+1)
1268 = (unsigned char)priv
->dp_out_buf_len
;
1269 port
->write_urb
->transfer_buffer_length
= priv
->dp_out_buf_len
+2;
1270 port
->write_urb
->dev
= serial
->dev
;
1271 memcpy(port
->write_urb
->transfer_buffer
+2, priv
->dp_out_buf
,
1272 priv
->dp_out_buf_len
);
1273 if ((ret
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
)) == 0) {
1274 priv
->dp_write_urb_in_use
= 1;
1275 priv
->dp_out_buf_len
= 0;
1278 /* wake up processes sleeping on writes immediately */
1279 digi_wakeup_write(port
);
1280 /* also queue up a wakeup at scheduler time, in case we */
1281 /* lost the race in write_chan(). */
1282 schedule_work(&priv
->dp_wakeup_work
);
1284 spin_unlock(&priv
->dp_port_lock
);
1286 err("%s: usb_submit_urb failed, ret=%d, port=%d",
1287 __func__
, ret
, priv
->dp_port_num
);
1290 static int digi_write_room(struct usb_serial_port
*port
)
1294 struct digi_port
*priv
= usb_get_serial_port_data(port
);
1295 unsigned long flags
= 0;
1297 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
1299 if (port
->write_urb
->status
== -EINPROGRESS
|| priv
->dp_write_urb_in_use
)
1302 room
= port
->bulk_out_size
- 2 - priv
->dp_out_buf_len
;
1304 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
1305 dbg("digi_write_room: port=%d, room=%d", priv
->dp_port_num
, room
);
1310 static int digi_chars_in_buffer(struct usb_serial_port
*port
)
1313 struct digi_port
*priv
= usb_get_serial_port_data(port
);
1316 if (port
->write_urb
->status
== -EINPROGRESS
1317 || priv
->dp_write_urb_in_use
) {
1318 dbg("digi_chars_in_buffer: port=%d, chars=%d",
1319 priv
->dp_port_num
, port
->bulk_out_size
- 2);
1320 /* return(port->bulk_out_size - 2); */
1323 dbg("digi_chars_in_buffer: port=%d, chars=%d",
1324 priv
->dp_port_num
, priv
->dp_out_buf_len
);
1325 return priv
->dp_out_buf_len
;
1331 static int digi_open(struct usb_serial_port
*port
, struct file
*filp
)
1334 unsigned char buf
[32];
1335 struct digi_port
*priv
= usb_get_serial_port_data(port
);
1336 struct ktermios not_termios
;
1337 unsigned long flags
= 0;
1339 dbg("digi_open: TOP: port=%d, open_count=%d",
1340 priv
->dp_port_num
, port
->open_count
);
1342 /* be sure the device is started up */
1343 if (digi_startup_device(port
->serial
) != 0)
1346 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
1348 /* don't wait on a close in progress for non-blocking opens */
1349 if (priv
->dp_in_close
&& (filp
->f_flags
&(O_NDELAY
|O_NONBLOCK
)) == 0) {
1350 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
1354 /* wait for a close in progress to finish */
1355 while(priv
->dp_in_close
) {
1356 cond_wait_interruptible_timeout_irqrestore(
1357 &priv
->dp_close_wait
, DIGI_RETRY_TIMEOUT
,
1358 &priv
->dp_port_lock
, flags
);
1359 if (signal_pending(current
))
1361 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
1364 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
1366 /* read modem signals automatically whenever they change */
1367 buf
[0] = DIGI_CMD_READ_INPUT_SIGNALS
;
1368 buf
[1] = priv
->dp_port_num
;
1369 buf
[2] = DIGI_ENABLE
;
1373 buf
[4] = DIGI_CMD_IFLUSH_FIFO
;
1374 buf
[5] = priv
->dp_port_num
;
1375 buf
[6] = DIGI_FLUSH_TX
| DIGI_FLUSH_RX
;
1378 if ((ret
= digi_write_oob_command(port
, buf
, 8, 1)) != 0)
1379 dbg("digi_open: write oob failed, ret=%d", ret
);
1381 /* set termios settings */
1382 not_termios
.c_cflag
= ~port
->tty
->termios
->c_cflag
;
1383 not_termios
.c_iflag
= ~port
->tty
->termios
->c_iflag
;
1384 digi_set_termios(port
, ¬_termios
);
1386 /* set DTR and RTS */
1387 digi_set_modem_signals(port
, TIOCM_DTR
|TIOCM_RTS
, 1);
1393 static void digi_close(struct usb_serial_port
*port
, struct file
*filp
)
1397 unsigned char buf
[32];
1398 struct tty_struct
*tty
= port
->tty
;
1399 struct digi_port
*priv
= usb_get_serial_port_data(port
);
1401 dbg("digi_close: TOP: port=%d, open_count=%d",
1402 priv
->dp_port_num
, port
->open_count
);
1404 mutex_lock(&port
->serial
->disc_mutex
);
1405 /* if disconnected, just clear flags */
1406 if (port
->serial
->disconnected
)
1409 /* do cleanup only after final close on this port */
1410 spin_lock_irq(&priv
->dp_port_lock
);
1411 priv
->dp_in_close
= 1;
1412 spin_unlock_irq(&priv
->dp_port_lock
);
1414 /* tell line discipline to process only XON/XOFF */
1417 /* wait for output to drain */
1418 if ((filp
->f_flags
&(O_NDELAY
|O_NONBLOCK
)) == 0)
1419 tty_wait_until_sent(tty
, DIGI_CLOSE_TIMEOUT
);
1421 /* flush driver and line discipline buffers */
1422 tty_driver_flush_buffer(tty
);
1423 tty_ldisc_flush(tty
);
1425 if (port
->serial
->dev
) {
1426 /* wait for transmit idle */
1427 if ((filp
->f_flags
&(O_NDELAY
|O_NONBLOCK
)) == 0) {
1428 digi_transmit_idle(port
, DIGI_CLOSE_TIMEOUT
);
1430 /* drop DTR and RTS */
1431 digi_set_modem_signals(port
, 0, 0);
1433 /* disable input flow control */
1434 buf
[0] = DIGI_CMD_SET_INPUT_FLOW_CONTROL
;
1435 buf
[1] = priv
->dp_port_num
;
1436 buf
[2] = DIGI_DISABLE
;
1439 /* disable output flow control */
1440 buf
[4] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL
;
1441 buf
[5] = priv
->dp_port_num
;
1442 buf
[6] = DIGI_DISABLE
;
1445 /* disable reading modem signals automatically */
1446 buf
[8] = DIGI_CMD_READ_INPUT_SIGNALS
;
1447 buf
[9] = priv
->dp_port_num
;
1448 buf
[10] = DIGI_DISABLE
;
1451 /* disable receive */
1452 buf
[12] = DIGI_CMD_RECEIVE_ENABLE
;
1453 buf
[13] = priv
->dp_port_num
;
1454 buf
[14] = DIGI_DISABLE
;
1458 buf
[16] = DIGI_CMD_IFLUSH_FIFO
;
1459 buf
[17] = priv
->dp_port_num
;
1460 buf
[18] = DIGI_FLUSH_TX
| DIGI_FLUSH_RX
;
1463 if ((ret
= digi_write_oob_command(port
, buf
, 20, 0)) != 0)
1464 dbg("digi_close: write oob failed, ret=%d", ret
);
1466 /* wait for final commands on oob port to complete */
1467 prepare_to_wait(&priv
->dp_flush_wait
, &wait
, TASK_INTERRUPTIBLE
);
1468 schedule_timeout(DIGI_CLOSE_TIMEOUT
);
1469 finish_wait(&priv
->dp_flush_wait
, &wait
);
1471 /* shutdown any outstanding bulk writes */
1472 usb_kill_urb(port
->write_urb
);
1476 spin_lock_irq(&priv
->dp_port_lock
);
1477 priv
->dp_write_urb_in_use
= 0;
1478 priv
->dp_in_close
= 0;
1479 wake_up_interruptible(&priv
->dp_close_wait
);
1480 spin_unlock_irq(&priv
->dp_port_lock
);
1481 mutex_unlock(&port
->serial
->disc_mutex
);
1482 dbg("digi_close: done");
1487 * Digi Startup Device
1489 * Starts reads on all ports. Must be called AFTER startup, with
1490 * urbs initialized. Returns 0 if successful, non-zero error otherwise.
1493 static int digi_startup_device(struct usb_serial
*serial
)
1496 struct digi_serial
*serial_priv
= usb_get_serial_data(serial
);
1497 struct usb_serial_port
*port
;
1499 /* be sure this happens exactly once */
1500 spin_lock(&serial_priv
->ds_serial_lock
);
1501 if (serial_priv
->ds_device_started
) {
1502 spin_unlock(&serial_priv
->ds_serial_lock
);
1505 serial_priv
->ds_device_started
= 1;
1506 spin_unlock(&serial_priv
->ds_serial_lock
);
1508 /* start reading from each bulk in endpoint for the device */
1509 /* set USB_DISABLE_SPD flag for write bulk urbs */
1510 for (i
= 0; i
< serial
->type
->num_ports
+ 1; i
++) {
1511 port
= serial
->port
[i
];
1512 port
->write_urb
->dev
= port
->serial
->dev
;
1513 if ((ret
= usb_submit_urb(port
->read_urb
, GFP_KERNEL
)) != 0) {
1514 err("%s: usb_submit_urb failed, ret=%d, port=%d",
1523 static int digi_startup(struct usb_serial
*serial
)
1527 struct digi_port
*priv
;
1528 struct digi_serial
*serial_priv
;
1530 dbg("digi_startup: TOP");
1532 /* allocate the private data structures for all ports */
1533 /* number of regular ports + 1 for the out-of-band port */
1534 for(i
= 0; i
< serial
->type
->num_ports
+ 1; i
++) {
1535 /* allocate port private structure */
1536 priv
= kmalloc(sizeof(struct digi_port
), GFP_KERNEL
);
1539 kfree(usb_get_serial_port_data(serial
->port
[i
]));
1540 return 1; /* error */
1543 /* initialize port private structure */
1544 spin_lock_init(&priv
->dp_port_lock
);
1545 priv
->dp_port_num
= i
;
1546 priv
->dp_out_buf_len
= 0;
1547 priv
->dp_write_urb_in_use
= 0;
1548 priv
->dp_modem_signals
= 0;
1549 init_waitqueue_head(&priv
->dp_modem_change_wait
);
1550 priv
->dp_transmit_idle
= 0;
1551 init_waitqueue_head(&priv
->dp_transmit_idle_wait
);
1552 priv
->dp_throttled
= 0;
1553 priv
->dp_throttle_restart
= 0;
1554 init_waitqueue_head(&priv
->dp_flush_wait
);
1555 priv
->dp_in_close
= 0;
1556 init_waitqueue_head(&priv
->dp_close_wait
);
1557 INIT_WORK(&priv
->dp_wakeup_work
, digi_wakeup_write_lock
);
1558 priv
->dp_port
= serial
->port
[i
];
1559 /* initialize write wait queue for this port */
1560 init_waitqueue_head(&serial
->port
[i
]->write_wait
);
1562 usb_set_serial_port_data(serial
->port
[i
], priv
);
1565 /* allocate serial private structure */
1566 serial_priv
= kmalloc(sizeof(struct digi_serial
), GFP_KERNEL
);
1567 if (serial_priv
== NULL
) {
1568 for (i
= 0; i
< serial
->type
->num_ports
+ 1; i
++)
1569 kfree(usb_get_serial_port_data(serial
->port
[i
]));
1570 return 1; /* error */
1573 /* initialize serial private structure */
1574 spin_lock_init(&serial_priv
->ds_serial_lock
);
1575 serial_priv
->ds_oob_port_num
= serial
->type
->num_ports
;
1576 serial_priv
->ds_oob_port
= serial
->port
[serial_priv
->ds_oob_port_num
];
1577 serial_priv
->ds_device_started
= 0;
1578 usb_set_serial_data(serial
, serial_priv
);
1584 static void digi_shutdown(struct usb_serial
*serial
)
1587 dbg("digi_shutdown: TOP, in_interrupt()=%ld", in_interrupt());
1589 /* stop reads and writes on all ports */
1590 for (i
= 0; i
< serial
->type
->num_ports
+ 1; i
++) {
1591 usb_kill_urb(serial
->port
[i
]->read_urb
);
1592 usb_kill_urb(serial
->port
[i
]->write_urb
);
1595 /* free the private data structures for all ports */
1596 /* number of regular ports + 1 for the out-of-band port */
1597 for(i
= 0; i
< serial
->type
->num_ports
+ 1; i
++)
1598 kfree(usb_get_serial_port_data(serial
->port
[i
]));
1599 kfree(usb_get_serial_data(serial
));
1603 static void digi_read_bulk_callback(struct urb
*urb
)
1605 struct usb_serial_port
*port
= urb
->context
;
1606 struct digi_port
*priv
;
1607 struct digi_serial
*serial_priv
;
1609 int status
= urb
->status
;
1611 dbg("digi_read_bulk_callback: TOP");
1613 /* port sanity check, do not resubmit if port is not valid */
1614 if (port
== NULL
|| (priv
= usb_get_serial_port_data(port
)) == NULL
) {
1615 err("%s: port or port->private is NULL, status=%d",
1619 if (port
->serial
== NULL
||
1620 (serial_priv
=usb_get_serial_data(port
->serial
)) == NULL
) {
1621 err("%s: serial is bad or serial->private is NULL, status=%d",
1626 /* do not resubmit urb if it has any status error */
1628 err("%s: nonzero read bulk status: status=%d, port=%d",
1629 __func__
, status
, priv
->dp_port_num
);
1633 /* handle oob or inb callback, do not resubmit if error */
1634 if (priv
->dp_port_num
== serial_priv
->ds_oob_port_num
) {
1635 if (digi_read_oob_callback(urb
) != 0)
1638 if (digi_read_inb_callback(urb
) != 0)
1643 urb
->dev
= port
->serial
->dev
;
1644 if ((ret
= usb_submit_urb(urb
, GFP_ATOMIC
)) != 0) {
1645 err("%s: failed resubmitting urb, ret=%d, port=%d",
1646 __func__
, ret
, priv
->dp_port_num
);
1652 * Digi Read INB Callback
1654 * Digi Read INB Callback handles reads on the in band ports, sending
1655 * the data on to the tty subsystem. When called we know port and
1656 * port->private are not NULL and port->serial has been validated.
1657 * It returns 0 if successful, 1 if successful but the port is
1658 * throttled, and -1 if the sanity checks failed.
1661 static int digi_read_inb_callback(struct urb
*urb
)
1664 struct usb_serial_port
*port
= urb
->context
;
1665 struct tty_struct
*tty
= port
->tty
;
1666 struct digi_port
*priv
= usb_get_serial_port_data(port
);
1667 int opcode
= ((unsigned char *)urb
->transfer_buffer
)[0];
1668 int len
= ((unsigned char *)urb
->transfer_buffer
)[1];
1669 int port_status
= ((unsigned char *)urb
->transfer_buffer
)[2];
1670 unsigned char *data
= ((unsigned char *)urb
->transfer_buffer
)+3;
1673 int status
= urb
->status
;
1675 /* do not process callbacks on closed ports */
1676 /* but do continue the read chain */
1677 if (port
->open_count
== 0)
1680 /* short/multiple packet check */
1681 if (urb
->actual_length
!= len
+ 2) {
1682 err("%s: INCOMPLETE OR MULTIPLE PACKET, urb->status=%d, "
1683 "port=%d, opcode=%d, len=%d, actual_length=%d, "
1684 "status=%d", __func__
, status
, priv
->dp_port_num
,
1685 opcode
, len
, urb
->actual_length
, port_status
);
1689 spin_lock(&priv
->dp_port_lock
);
1691 /* check for throttle; if set, do not resubmit read urb */
1692 /* indicate the read chain needs to be restarted on unthrottle */
1693 throttled
= priv
->dp_throttled
;
1695 priv
->dp_throttle_restart
= 1;
1698 if (opcode
== DIGI_CMD_RECEIVE_DATA
) {
1699 /* get flag from port_status */
1702 /* overrun is special, not associated with a char */
1703 if (port_status
& DIGI_OVERRUN_ERROR
)
1704 tty_insert_flip_char(tty
, 0, TTY_OVERRUN
);
1706 /* break takes precedence over parity, */
1707 /* which takes precedence over framing errors */
1708 if (port_status
& DIGI_BREAK_ERROR
)
1710 else if (port_status
& DIGI_PARITY_ERROR
)
1712 else if (port_status
& DIGI_FRAMING_ERROR
)
1715 /* data length is len-1 (one byte of len is port_status) */
1718 len
= tty_buffer_request_room(tty
, len
);
1721 if (flag
== TTY_NORMAL
)
1722 tty_insert_flip_string(tty
, data
, len
);
1724 for(i
= 0; i
< len
; i
++)
1725 tty_insert_flip_char(tty
, data
[i
], flag
);
1727 tty_flip_buffer_push(tty
);
1730 spin_unlock(&priv
->dp_port_lock
);
1732 if (opcode
== DIGI_CMD_RECEIVE_DISABLE
)
1733 dbg("%s: got RECEIVE_DISABLE", __func__
);
1734 else if (opcode
!= DIGI_CMD_RECEIVE_DATA
)
1735 dbg("%s: unknown opcode: %d", __func__
, opcode
);
1737 return(throttled
? 1 : 0);
1743 * Digi Read OOB Callback
1745 * Digi Read OOB Callback handles reads on the out of band port.
1746 * When called we know port and port->private are not NULL and
1747 * the port->serial is valid. It returns 0 if successful, and
1748 * -1 if the sanity checks failed.
1751 static int digi_read_oob_callback(struct urb
*urb
)
1754 struct usb_serial_port
*port
= urb
->context
;
1755 struct usb_serial
*serial
= port
->serial
;
1756 struct digi_port
*priv
= usb_get_serial_port_data(port
);
1757 int opcode
, line
, status
, val
;
1760 dbg("digi_read_oob_callback: port=%d, len=%d",
1761 priv
->dp_port_num
, urb
->actual_length
);
1763 /* handle each oob command */
1764 for(i
= 0; i
< urb
->actual_length
- 3;) {
1765 opcode
= ((unsigned char *)urb
->transfer_buffer
)[i
++];
1766 line
= ((unsigned char *)urb
->transfer_buffer
)[i
++];
1767 status
= ((unsigned char *)urb
->transfer_buffer
)[i
++];
1768 val
= ((unsigned char *)urb
->transfer_buffer
)[i
++];
1770 dbg("digi_read_oob_callback: opcode=%d, line=%d, status=%d, val=%d",
1771 opcode
, line
, status
, val
);
1773 if (status
!= 0 || line
>= serial
->type
->num_ports
)
1776 port
= serial
->port
[line
];
1778 if ((priv
=usb_get_serial_port_data(port
)) == NULL
)
1781 if (opcode
== DIGI_CMD_READ_INPUT_SIGNALS
) {
1782 spin_lock(&priv
->dp_port_lock
);
1783 /* convert from digi flags to termiox flags */
1784 if (val
& DIGI_READ_INPUT_SIGNALS_CTS
) {
1785 priv
->dp_modem_signals
|= TIOCM_CTS
;
1786 /* port must be open to use tty struct */
1787 if (port
->open_count
1788 && port
->tty
->termios
->c_cflag
& CRTSCTS
) {
1789 port
->tty
->hw_stopped
= 0;
1790 digi_wakeup_write(port
);
1793 priv
->dp_modem_signals
&= ~TIOCM_CTS
;
1794 /* port must be open to use tty struct */
1795 if (port
->open_count
1796 && port
->tty
->termios
->c_cflag
& CRTSCTS
) {
1797 port
->tty
->hw_stopped
= 1;
1800 if (val
& DIGI_READ_INPUT_SIGNALS_DSR
)
1801 priv
->dp_modem_signals
|= TIOCM_DSR
;
1803 priv
->dp_modem_signals
&= ~TIOCM_DSR
;
1804 if (val
& DIGI_READ_INPUT_SIGNALS_RI
)
1805 priv
->dp_modem_signals
|= TIOCM_RI
;
1807 priv
->dp_modem_signals
&= ~TIOCM_RI
;
1808 if (val
& DIGI_READ_INPUT_SIGNALS_DCD
)
1809 priv
->dp_modem_signals
|= TIOCM_CD
;
1811 priv
->dp_modem_signals
&= ~TIOCM_CD
;
1813 wake_up_interruptible(&priv
->dp_modem_change_wait
);
1814 spin_unlock(&priv
->dp_port_lock
);
1815 } else if (opcode
== DIGI_CMD_TRANSMIT_IDLE
) {
1816 spin_lock(&priv
->dp_port_lock
);
1817 priv
->dp_transmit_idle
= 1;
1818 wake_up_interruptible(&priv
->dp_transmit_idle_wait
);
1819 spin_unlock(&priv
->dp_port_lock
);
1820 } else if (opcode
== DIGI_CMD_IFLUSH_FIFO
) {
1821 wake_up_interruptible(&priv
->dp_flush_wait
);
1828 static int __init
digi_init(void)
1831 retval
= usb_serial_register(&digi_acceleport_2_device
);
1833 goto failed_acceleport_2_device
;
1834 retval
= usb_serial_register(&digi_acceleport_4_device
);
1836 goto failed_acceleport_4_device
;
1837 retval
= usb_register(&digi_driver
);
1839 goto failed_usb_register
;
1840 info(DRIVER_VERSION
":" DRIVER_DESC
);
1842 failed_usb_register
:
1843 usb_serial_deregister(&digi_acceleport_4_device
);
1844 failed_acceleport_4_device
:
1845 usb_serial_deregister(&digi_acceleport_2_device
);
1846 failed_acceleport_2_device
:
1850 static void __exit
digi_exit (void)
1852 usb_deregister(&digi_driver
);
1853 usb_serial_deregister(&digi_acceleport_2_device
);
1854 usb_serial_deregister(&digi_acceleport_4_device
);
1858 module_init(digi_init
);
1859 module_exit(digi_exit
);
1862 MODULE_AUTHOR(DRIVER_AUTHOR
);
1863 MODULE_DESCRIPTION(DRIVER_DESC
);
1864 MODULE_LICENSE("GPL");
1866 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
1867 MODULE_PARM_DESC(debug
, "Debug enabled or not");