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 #include <linux/kernel.h>
19 #include <linux/errno.h>
20 #include <linux/init.h>
21 #include <linux/slab.h>
22 #include <linux/tty.h>
23 #include <linux/tty_driver.h>
24 #include <linux/tty_flip.h>
25 #include <linux/module.h>
26 #include <linux/spinlock.h>
27 #include <linux/workqueue.h>
28 #include <linux/uaccess.h>
29 #include <linux/usb.h>
30 #include <linux/wait.h>
31 #include <linux/usb/serial.h>
38 #define DRIVER_VERSION "v1.80.1.2"
39 #define DRIVER_AUTHOR "Peter Berger <pberger@brimson.com>, Al Borchers <borchers@steinerpoint.com>"
40 #define DRIVER_DESC "Digi AccelePort USB-2/USB-4 Serial Converter driver"
42 /* port output buffer length -- must be <= transfer buffer length - 2 */
43 /* so we can be sure to send the full buffer in one urb */
44 #define DIGI_OUT_BUF_SIZE 8
46 /* port input buffer length -- must be >= transfer buffer length - 3 */
47 /* so we can be sure to hold at least one full buffer from one urb */
48 #define DIGI_IN_BUF_SIZE 64
50 /* retry timeout while sleeping */
51 #define DIGI_RETRY_TIMEOUT (HZ/10)
53 /* timeout while waiting for tty output to drain in close */
54 /* this delay is used twice in close, so the total delay could */
55 /* be twice this value */
56 #define DIGI_CLOSE_TIMEOUT (5*HZ)
59 /* AccelePort USB Defines */
62 #define DIGI_VENDOR_ID 0x05c5
63 #define DIGI_2_ID 0x0002 /* USB-2 */
64 #define DIGI_4_ID 0x0004 /* USB-4 */
67 * "INB": can be used on the in-band endpoint
68 * "OOB": can be used on the out-of-band endpoint
70 #define DIGI_CMD_SET_BAUD_RATE 0 /* INB, OOB */
71 #define DIGI_CMD_SET_WORD_SIZE 1 /* INB, OOB */
72 #define DIGI_CMD_SET_PARITY 2 /* INB, OOB */
73 #define DIGI_CMD_SET_STOP_BITS 3 /* INB, OOB */
74 #define DIGI_CMD_SET_INPUT_FLOW_CONTROL 4 /* INB, OOB */
75 #define DIGI_CMD_SET_OUTPUT_FLOW_CONTROL 5 /* INB, OOB */
76 #define DIGI_CMD_SET_DTR_SIGNAL 6 /* INB, OOB */
77 #define DIGI_CMD_SET_RTS_SIGNAL 7 /* INB, OOB */
78 #define DIGI_CMD_READ_INPUT_SIGNALS 8 /* OOB */
79 #define DIGI_CMD_IFLUSH_FIFO 9 /* OOB */
80 #define DIGI_CMD_RECEIVE_ENABLE 10 /* INB, OOB */
81 #define DIGI_CMD_BREAK_CONTROL 11 /* INB, OOB */
82 #define DIGI_CMD_LOCAL_LOOPBACK 12 /* INB, OOB */
83 #define DIGI_CMD_TRANSMIT_IDLE 13 /* INB, OOB */
84 #define DIGI_CMD_READ_UART_REGISTER 14 /* OOB */
85 #define DIGI_CMD_WRITE_UART_REGISTER 15 /* INB, OOB */
86 #define DIGI_CMD_AND_UART_REGISTER 16 /* INB, OOB */
87 #define DIGI_CMD_OR_UART_REGISTER 17 /* INB, OOB */
88 #define DIGI_CMD_SEND_DATA 18 /* INB */
89 #define DIGI_CMD_RECEIVE_DATA 19 /* INB */
90 #define DIGI_CMD_RECEIVE_DISABLE 20 /* INB */
91 #define DIGI_CMD_GET_PORT_TYPE 21 /* OOB */
94 #define DIGI_BAUD_50 0
95 #define DIGI_BAUD_75 1
96 #define DIGI_BAUD_110 2
97 #define DIGI_BAUD_150 3
98 #define DIGI_BAUD_200 4
99 #define DIGI_BAUD_300 5
100 #define DIGI_BAUD_600 6
101 #define DIGI_BAUD_1200 7
102 #define DIGI_BAUD_1800 8
103 #define DIGI_BAUD_2400 9
104 #define DIGI_BAUD_4800 10
105 #define DIGI_BAUD_7200 11
106 #define DIGI_BAUD_9600 12
107 #define DIGI_BAUD_14400 13
108 #define DIGI_BAUD_19200 14
109 #define DIGI_BAUD_28800 15
110 #define DIGI_BAUD_38400 16
111 #define DIGI_BAUD_57600 17
112 #define DIGI_BAUD_76800 18
113 #define DIGI_BAUD_115200 19
114 #define DIGI_BAUD_153600 20
115 #define DIGI_BAUD_230400 21
116 #define DIGI_BAUD_460800 22
119 #define DIGI_WORD_SIZE_5 0
120 #define DIGI_WORD_SIZE_6 1
121 #define DIGI_WORD_SIZE_7 2
122 #define DIGI_WORD_SIZE_8 3
124 #define DIGI_PARITY_NONE 0
125 #define DIGI_PARITY_ODD 1
126 #define DIGI_PARITY_EVEN 2
127 #define DIGI_PARITY_MARK 3
128 #define DIGI_PARITY_SPACE 4
130 #define DIGI_STOP_BITS_1 0
131 #define DIGI_STOP_BITS_2 1
133 #define DIGI_INPUT_FLOW_CONTROL_XON_XOFF 1
134 #define DIGI_INPUT_FLOW_CONTROL_RTS 2
135 #define DIGI_INPUT_FLOW_CONTROL_DTR 4
137 #define DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF 1
138 #define DIGI_OUTPUT_FLOW_CONTROL_CTS 2
139 #define DIGI_OUTPUT_FLOW_CONTROL_DSR 4
141 #define DIGI_DTR_INACTIVE 0
142 #define DIGI_DTR_ACTIVE 1
143 #define DIGI_DTR_INPUT_FLOW_CONTROL 2
145 #define DIGI_RTS_INACTIVE 0
146 #define DIGI_RTS_ACTIVE 1
147 #define DIGI_RTS_INPUT_FLOW_CONTROL 2
148 #define DIGI_RTS_TOGGLE 3
150 #define DIGI_FLUSH_TX 1
151 #define DIGI_FLUSH_RX 2
152 #define DIGI_RESUME_TX 4 /* clears xoff condition */
154 #define DIGI_TRANSMIT_NOT_IDLE 0
155 #define DIGI_TRANSMIT_IDLE 1
157 #define DIGI_DISABLE 0
158 #define DIGI_ENABLE 1
160 #define DIGI_DEASSERT 0
161 #define DIGI_ASSERT 1
163 /* in band status codes */
164 #define DIGI_OVERRUN_ERROR 4
165 #define DIGI_PARITY_ERROR 8
166 #define DIGI_FRAMING_ERROR 16
167 #define DIGI_BREAK_ERROR 32
169 /* out of band status */
170 #define DIGI_NO_ERROR 0
171 #define DIGI_BAD_FIRST_PARAMETER 1
172 #define DIGI_BAD_SECOND_PARAMETER 2
173 #define DIGI_INVALID_LINE 3
174 #define DIGI_INVALID_OPCODE 4
177 #define DIGI_READ_INPUT_SIGNALS_SLOT 1
178 #define DIGI_READ_INPUT_SIGNALS_ERR 2
179 #define DIGI_READ_INPUT_SIGNALS_BUSY 4
180 #define DIGI_READ_INPUT_SIGNALS_PE 8
181 #define DIGI_READ_INPUT_SIGNALS_CTS 16
182 #define DIGI_READ_INPUT_SIGNALS_DSR 32
183 #define DIGI_READ_INPUT_SIGNALS_RI 64
184 #define DIGI_READ_INPUT_SIGNALS_DCD 128
190 spinlock_t ds_serial_lock
;
191 struct usb_serial_port
*ds_oob_port
; /* out-of-band port */
192 int ds_oob_port_num
; /* index of out-of-band port */
193 int ds_device_started
;
197 spinlock_t dp_port_lock
;
200 unsigned char dp_out_buf
[DIGI_OUT_BUF_SIZE
];
201 int dp_write_urb_in_use
;
202 unsigned int dp_modem_signals
;
203 wait_queue_head_t dp_modem_change_wait
;
204 int dp_transmit_idle
;
205 wait_queue_head_t dp_transmit_idle_wait
;
207 int dp_throttle_restart
;
208 wait_queue_head_t dp_flush_wait
;
209 wait_queue_head_t dp_close_wait
; /* wait queue for close */
210 struct work_struct dp_wakeup_work
;
211 struct usb_serial_port
*dp_port
;
215 /* Local Function Declarations */
217 static void digi_wakeup_write(struct usb_serial_port
*port
);
218 static void digi_wakeup_write_lock(struct work_struct
*work
);
219 static int digi_write_oob_command(struct usb_serial_port
*port
,
220 unsigned char *buf
, int count
, int interruptible
);
221 static int digi_write_inb_command(struct usb_serial_port
*port
,
222 unsigned char *buf
, int count
, unsigned long timeout
);
223 static int digi_set_modem_signals(struct usb_serial_port
*port
,
224 unsigned int modem_signals
, int interruptible
);
225 static int digi_transmit_idle(struct usb_serial_port
*port
,
226 unsigned long timeout
);
227 static void digi_rx_throttle(struct tty_struct
*tty
);
228 static void digi_rx_unthrottle(struct tty_struct
*tty
);
229 static void digi_set_termios(struct tty_struct
*tty
,
230 struct usb_serial_port
*port
, struct ktermios
*old_termios
);
231 static void digi_break_ctl(struct tty_struct
*tty
, int break_state
);
232 static int digi_tiocmget(struct tty_struct
*tty
);
233 static int digi_tiocmset(struct tty_struct
*tty
, unsigned int set
,
235 static int digi_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
236 const unsigned char *buf
, int count
);
237 static void digi_write_bulk_callback(struct urb
*urb
);
238 static int digi_write_room(struct tty_struct
*tty
);
239 static int digi_chars_in_buffer(struct tty_struct
*tty
);
240 static int digi_open(struct tty_struct
*tty
, struct usb_serial_port
*port
);
241 static void digi_close(struct usb_serial_port
*port
);
242 static void digi_dtr_rts(struct usb_serial_port
*port
, int on
);
243 static int digi_startup_device(struct usb_serial
*serial
);
244 static int digi_startup(struct usb_serial
*serial
);
245 static void digi_disconnect(struct usb_serial
*serial
);
246 static void digi_release(struct usb_serial
*serial
);
247 static void digi_read_bulk_callback(struct urb
*urb
);
248 static int digi_read_inb_callback(struct urb
*urb
);
249 static int digi_read_oob_callback(struct urb
*urb
);
256 static const struct usb_device_id id_table_combined
[] = {
257 { USB_DEVICE(DIGI_VENDOR_ID
, DIGI_2_ID
) },
258 { USB_DEVICE(DIGI_VENDOR_ID
, DIGI_4_ID
) },
259 { } /* Terminating entry */
262 static const struct usb_device_id id_table_2
[] = {
263 { USB_DEVICE(DIGI_VENDOR_ID
, DIGI_2_ID
) },
264 { } /* Terminating entry */
267 static const struct usb_device_id id_table_4
[] = {
268 { USB_DEVICE(DIGI_VENDOR_ID
, DIGI_4_ID
) },
269 { } /* Terminating entry */
272 MODULE_DEVICE_TABLE(usb
, id_table_combined
);
274 /* device info needed for the Digi serial converter */
276 static struct usb_serial_driver digi_acceleport_2_device
= {
278 .owner
= THIS_MODULE
,
281 .description
= "Digi 2 port USB adapter",
282 .id_table
= id_table_2
,
286 .dtr_rts
= digi_dtr_rts
,
288 .write_room
= digi_write_room
,
289 .write_bulk_callback
= digi_write_bulk_callback
,
290 .read_bulk_callback
= digi_read_bulk_callback
,
291 .chars_in_buffer
= digi_chars_in_buffer
,
292 .throttle
= digi_rx_throttle
,
293 .unthrottle
= digi_rx_unthrottle
,
294 .set_termios
= digi_set_termios
,
295 .break_ctl
= digi_break_ctl
,
296 .tiocmget
= digi_tiocmget
,
297 .tiocmset
= digi_tiocmset
,
298 .attach
= digi_startup
,
299 .disconnect
= digi_disconnect
,
300 .release
= digi_release
,
303 static struct usb_serial_driver digi_acceleport_4_device
= {
305 .owner
= THIS_MODULE
,
308 .description
= "Digi 4 port USB adapter",
309 .id_table
= id_table_4
,
314 .write_room
= digi_write_room
,
315 .write_bulk_callback
= digi_write_bulk_callback
,
316 .read_bulk_callback
= digi_read_bulk_callback
,
317 .chars_in_buffer
= digi_chars_in_buffer
,
318 .throttle
= digi_rx_throttle
,
319 .unthrottle
= digi_rx_unthrottle
,
320 .set_termios
= digi_set_termios
,
321 .break_ctl
= digi_break_ctl
,
322 .tiocmget
= digi_tiocmget
,
323 .tiocmset
= digi_tiocmset
,
324 .attach
= digi_startup
,
325 .disconnect
= digi_disconnect
,
326 .release
= digi_release
,
329 static struct usb_serial_driver
* const serial_drivers
[] = {
330 &digi_acceleport_2_device
, &digi_acceleport_4_device
, NULL
336 * Cond Wait Interruptible Timeout Irqrestore
338 * Do spin_unlock_irqrestore and interruptible_sleep_on_timeout
339 * so that wake ups are not lost if they occur between the unlock
340 * and the sleep. In other words, spin_unlock_irqrestore and
341 * interruptible_sleep_on_timeout are "atomic" with respect to
342 * wake ups. This is used to implement condition variables.
344 * interruptible_sleep_on_timeout is deprecated and has been replaced
345 * with the equivalent code.
348 static long cond_wait_interruptible_timeout_irqrestore(
349 wait_queue_head_t
*q
, long timeout
,
350 spinlock_t
*lock
, unsigned long flags
)
355 prepare_to_wait(q
, &wait
, TASK_INTERRUPTIBLE
);
356 spin_unlock_irqrestore(lock
, flags
);
357 timeout
= schedule_timeout(timeout
);
358 finish_wait(q
, &wait
);
367 * Wake up port, line discipline, and tty processes sleeping
371 static void digi_wakeup_write_lock(struct work_struct
*work
)
373 struct digi_port
*priv
=
374 container_of(work
, struct digi_port
, dp_wakeup_work
);
375 struct usb_serial_port
*port
= priv
->dp_port
;
378 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
379 digi_wakeup_write(port
);
380 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
383 static void digi_wakeup_write(struct usb_serial_port
*port
)
385 struct tty_struct
*tty
= tty_port_tty_get(&port
->port
);
394 * Digi Write OOB Command
396 * Write commands on the out of band port. Commands are 4
397 * bytes each, multiple commands can be sent at once, and
398 * no command will be split across USB packets. Returns 0
399 * if successful, -EINTR if interrupted while sleeping and
400 * the interruptible flag is true, or a negative error
401 * returned by usb_submit_urb.
404 static int digi_write_oob_command(struct usb_serial_port
*port
,
405 unsigned char *buf
, int count
, int interruptible
)
410 struct usb_serial_port
*oob_port
= (struct usb_serial_port
*)((struct digi_serial
*)(usb_get_serial_data(port
->serial
)))->ds_oob_port
;
411 struct digi_port
*oob_priv
= usb_get_serial_port_data(oob_port
);
412 unsigned long flags
= 0;
414 dbg("digi_write_oob_command: TOP: port=%d, count=%d", oob_priv
->dp_port_num
, count
);
416 spin_lock_irqsave(&oob_priv
->dp_port_lock
, flags
);
418 while (oob_priv
->dp_write_urb_in_use
) {
419 cond_wait_interruptible_timeout_irqrestore(
420 &oob_port
->write_wait
, DIGI_RETRY_TIMEOUT
,
421 &oob_priv
->dp_port_lock
, flags
);
422 if (interruptible
&& signal_pending(current
))
424 spin_lock_irqsave(&oob_priv
->dp_port_lock
, flags
);
427 /* len must be a multiple of 4, so commands are not split */
428 len
= min(count
, oob_port
->bulk_out_size
);
431 memcpy(oob_port
->write_urb
->transfer_buffer
, buf
, len
);
432 oob_port
->write_urb
->transfer_buffer_length
= len
;
433 ret
= usb_submit_urb(oob_port
->write_urb
, GFP_ATOMIC
);
435 oob_priv
->dp_write_urb_in_use
= 1;
440 spin_unlock_irqrestore(&oob_priv
->dp_port_lock
, flags
);
442 dev_err(&port
->dev
, "%s: usb_submit_urb failed, ret=%d\n",
450 * Digi Write In Band Command
452 * Write commands on the given port. Commands are 4
453 * bytes each, multiple commands can be sent at once, and
454 * no command will be split across USB packets. If timeout
455 * is non-zero, write in band command will return after
456 * waiting unsuccessfully for the URB status to clear for
457 * timeout ticks. Returns 0 if successful, or a negative
458 * error returned by digi_write.
461 static int digi_write_inb_command(struct usb_serial_port
*port
,
462 unsigned char *buf
, int count
, unsigned long timeout
)
466 struct digi_port
*priv
= usb_get_serial_port_data(port
);
467 unsigned char *data
= port
->write_urb
->transfer_buffer
;
468 unsigned long flags
= 0;
470 dbg("digi_write_inb_command: TOP: port=%d, count=%d",
471 priv
->dp_port_num
, count
);
478 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
479 while (count
> 0 && ret
== 0) {
480 while (priv
->dp_write_urb_in_use
&&
481 time_before(jiffies
, timeout
)) {
482 cond_wait_interruptible_timeout_irqrestore(
483 &port
->write_wait
, DIGI_RETRY_TIMEOUT
,
484 &priv
->dp_port_lock
, flags
);
485 if (signal_pending(current
))
487 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
490 /* len must be a multiple of 4 and small enough to */
491 /* guarantee the write will send buffered data first, */
492 /* so commands are in order with data and not split */
493 len
= min(count
, port
->bulk_out_size
-2-priv
->dp_out_buf_len
);
497 /* write any buffered data first */
498 if (priv
->dp_out_buf_len
> 0) {
499 data
[0] = DIGI_CMD_SEND_DATA
;
500 data
[1] = priv
->dp_out_buf_len
;
501 memcpy(data
+ 2, priv
->dp_out_buf
,
502 priv
->dp_out_buf_len
);
503 memcpy(data
+ 2 + priv
->dp_out_buf_len
, buf
, len
);
504 port
->write_urb
->transfer_buffer_length
505 = priv
->dp_out_buf_len
+ 2 + len
;
507 memcpy(data
, buf
, len
);
508 port
->write_urb
->transfer_buffer_length
= len
;
511 ret
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
513 priv
->dp_write_urb_in_use
= 1;
514 priv
->dp_out_buf_len
= 0;
520 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
524 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
525 __func__
, ret
, priv
->dp_port_num
);
531 * Digi Set Modem Signals
533 * Sets or clears DTR and RTS on the port, according to the
534 * modem_signals argument. Use TIOCM_DTR and TIOCM_RTS flags
535 * for the modem_signals argument. Returns 0 if successful,
536 * -EINTR if interrupted while sleeping, or a non-zero error
537 * returned by usb_submit_urb.
540 static int digi_set_modem_signals(struct usb_serial_port
*port
,
541 unsigned int modem_signals
, int interruptible
)
545 struct digi_port
*port_priv
= usb_get_serial_port_data(port
);
546 struct usb_serial_port
*oob_port
= (struct usb_serial_port
*) ((struct digi_serial
*)(usb_get_serial_data(port
->serial
)))->ds_oob_port
;
547 struct digi_port
*oob_priv
= usb_get_serial_port_data(oob_port
);
548 unsigned char *data
= oob_port
->write_urb
->transfer_buffer
;
549 unsigned long flags
= 0;
552 dbg("digi_set_modem_signals: TOP: port=%d, modem_signals=0x%x",
553 port_priv
->dp_port_num
, modem_signals
);
555 spin_lock_irqsave(&oob_priv
->dp_port_lock
, flags
);
556 spin_lock(&port_priv
->dp_port_lock
);
558 while (oob_priv
->dp_write_urb_in_use
) {
559 spin_unlock(&port_priv
->dp_port_lock
);
560 cond_wait_interruptible_timeout_irqrestore(
561 &oob_port
->write_wait
, DIGI_RETRY_TIMEOUT
,
562 &oob_priv
->dp_port_lock
, flags
);
563 if (interruptible
&& signal_pending(current
))
565 spin_lock_irqsave(&oob_priv
->dp_port_lock
, flags
);
566 spin_lock(&port_priv
->dp_port_lock
);
568 data
[0] = DIGI_CMD_SET_DTR_SIGNAL
;
569 data
[1] = port_priv
->dp_port_num
;
570 data
[2] = (modem_signals
& TIOCM_DTR
) ?
571 DIGI_DTR_ACTIVE
: DIGI_DTR_INACTIVE
;
573 data
[4] = DIGI_CMD_SET_RTS_SIGNAL
;
574 data
[5] = port_priv
->dp_port_num
;
575 data
[6] = (modem_signals
& TIOCM_RTS
) ?
576 DIGI_RTS_ACTIVE
: DIGI_RTS_INACTIVE
;
579 oob_port
->write_urb
->transfer_buffer_length
= 8;
581 ret
= usb_submit_urb(oob_port
->write_urb
, GFP_ATOMIC
);
583 oob_priv
->dp_write_urb_in_use
= 1;
584 port_priv
->dp_modem_signals
=
585 (port_priv
->dp_modem_signals
&~(TIOCM_DTR
|TIOCM_RTS
))
586 | (modem_signals
&(TIOCM_DTR
|TIOCM_RTS
));
588 spin_unlock(&port_priv
->dp_port_lock
);
589 spin_unlock_irqrestore(&oob_priv
->dp_port_lock
, flags
);
591 dev_err(&port
->dev
, "%s: usb_submit_urb failed, ret=%d\n",
599 * Digi transmit idle waits, up to timeout ticks, for the transmitter
600 * to go idle. It returns 0 if successful or a negative error.
602 * There are race conditions here if more than one process is calling
603 * digi_transmit_idle on the same port at the same time. However, this
604 * is only called from close, and only one process can be in close on a
605 * port at a time, so its ok.
608 static int digi_transmit_idle(struct usb_serial_port
*port
,
609 unsigned long timeout
)
612 unsigned char buf
[2];
613 struct digi_port
*priv
= usb_get_serial_port_data(port
);
614 unsigned long flags
= 0;
616 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
617 priv
->dp_transmit_idle
= 0;
618 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
620 buf
[0] = DIGI_CMD_TRANSMIT_IDLE
;
625 ret
= digi_write_inb_command(port
, buf
, 2, timeout
- jiffies
);
629 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
631 while (time_before(jiffies
, timeout
) && !priv
->dp_transmit_idle
) {
632 cond_wait_interruptible_timeout_irqrestore(
633 &priv
->dp_transmit_idle_wait
, DIGI_RETRY_TIMEOUT
,
634 &priv
->dp_port_lock
, flags
);
635 if (signal_pending(current
))
637 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
639 priv
->dp_transmit_idle
= 0;
640 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
646 static void digi_rx_throttle(struct tty_struct
*tty
)
649 struct usb_serial_port
*port
= tty
->driver_data
;
650 struct digi_port
*priv
= usb_get_serial_port_data(port
);
652 /* stop receiving characters by not resubmitting the read urb */
653 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
654 priv
->dp_throttled
= 1;
655 priv
->dp_throttle_restart
= 0;
656 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
660 static void digi_rx_unthrottle(struct tty_struct
*tty
)
664 struct usb_serial_port
*port
= tty
->driver_data
;
665 struct digi_port
*priv
= usb_get_serial_port_data(port
);
667 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
669 /* restart read chain */
670 if (priv
->dp_throttle_restart
)
671 ret
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
673 /* turn throttle off */
674 priv
->dp_throttled
= 0;
675 priv
->dp_throttle_restart
= 0;
677 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
681 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
682 __func__
, ret
, priv
->dp_port_num
);
686 static void digi_set_termios(struct tty_struct
*tty
,
687 struct usb_serial_port
*port
, struct ktermios
*old_termios
)
689 struct digi_port
*priv
= usb_get_serial_port_data(port
);
690 unsigned int iflag
= tty
->termios
.c_iflag
;
691 unsigned int cflag
= tty
->termios
.c_cflag
;
692 unsigned int old_iflag
= old_termios
->c_iflag
;
693 unsigned int old_cflag
= old_termios
->c_cflag
;
694 unsigned char buf
[32];
695 unsigned int modem_signals
;
700 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
);
703 baud
= tty_get_baud_rate(tty
);
704 if (baud
!= tty_termios_baud_rate(old_termios
)) {
707 /* reassert DTR and (maybe) RTS on transition from B0 */
708 if ((old_cflag
&CBAUD
) == B0
) {
709 /* don't set RTS if using hardware flow control */
710 /* and throttling input */
711 modem_signals
= TIOCM_DTR
;
712 if (!(tty
->termios
.c_cflag
& CRTSCTS
) ||
713 !test_bit(TTY_THROTTLED
, &tty
->flags
))
714 modem_signals
|= TIOCM_RTS
;
715 digi_set_modem_signals(port
, modem_signals
, 1);
718 /* drop DTR and RTS on transition to B0 */
719 case 0: digi_set_modem_signals(port
, 0, 1); break;
720 case 50: arg
= DIGI_BAUD_50
; break;
721 case 75: arg
= DIGI_BAUD_75
; break;
722 case 110: arg
= DIGI_BAUD_110
; break;
723 case 150: arg
= DIGI_BAUD_150
; break;
724 case 200: arg
= DIGI_BAUD_200
; break;
725 case 300: arg
= DIGI_BAUD_300
; break;
726 case 600: arg
= DIGI_BAUD_600
; break;
727 case 1200: arg
= DIGI_BAUD_1200
; break;
728 case 1800: arg
= DIGI_BAUD_1800
; break;
729 case 2400: arg
= DIGI_BAUD_2400
; break;
730 case 4800: arg
= DIGI_BAUD_4800
; break;
731 case 9600: arg
= DIGI_BAUD_9600
; break;
732 case 19200: arg
= DIGI_BAUD_19200
; break;
733 case 38400: arg
= DIGI_BAUD_38400
; break;
734 case 57600: arg
= DIGI_BAUD_57600
; break;
735 case 115200: arg
= DIGI_BAUD_115200
; break;
736 case 230400: arg
= DIGI_BAUD_230400
; break;
737 case 460800: arg
= DIGI_BAUD_460800
; break;
739 arg
= DIGI_BAUD_9600
;
744 buf
[i
++] = DIGI_CMD_SET_BAUD_RATE
;
745 buf
[i
++] = priv
->dp_port_num
;
751 tty
->termios
.c_cflag
&= ~CMSPAR
;
753 if ((cflag
&(PARENB
|PARODD
)) != (old_cflag
&(PARENB
|PARODD
))) {
756 arg
= DIGI_PARITY_ODD
;
758 arg
= DIGI_PARITY_EVEN
;
760 arg
= DIGI_PARITY_NONE
;
762 buf
[i
++] = DIGI_CMD_SET_PARITY
;
763 buf
[i
++] = priv
->dp_port_num
;
768 if ((cflag
&CSIZE
) != (old_cflag
&CSIZE
)) {
770 switch (cflag
&CSIZE
) {
771 case CS5
: arg
= DIGI_WORD_SIZE_5
; break;
772 case CS6
: arg
= DIGI_WORD_SIZE_6
; break;
773 case CS7
: arg
= DIGI_WORD_SIZE_7
; break;
774 case CS8
: arg
= DIGI_WORD_SIZE_8
; break;
776 dbg("digi_set_termios: can't handle word size %d",
782 buf
[i
++] = DIGI_CMD_SET_WORD_SIZE
;
783 buf
[i
++] = priv
->dp_port_num
;
791 if ((cflag
&CSTOPB
) != (old_cflag
&CSTOPB
)) {
794 arg
= DIGI_STOP_BITS_2
;
796 arg
= DIGI_STOP_BITS_1
;
798 buf
[i
++] = DIGI_CMD_SET_STOP_BITS
;
799 buf
[i
++] = priv
->dp_port_num
;
805 /* set input flow control */
806 if ((iflag
&IXOFF
) != (old_iflag
&IXOFF
)
807 || (cflag
&CRTSCTS
) != (old_cflag
&CRTSCTS
)) {
810 arg
|= DIGI_INPUT_FLOW_CONTROL_XON_XOFF
;
812 arg
&= ~DIGI_INPUT_FLOW_CONTROL_XON_XOFF
;
815 arg
|= DIGI_INPUT_FLOW_CONTROL_RTS
;
817 /* On USB-4 it is necessary to assert RTS prior */
818 /* to selecting RTS input flow control. */
819 buf
[i
++] = DIGI_CMD_SET_RTS_SIGNAL
;
820 buf
[i
++] = priv
->dp_port_num
;
821 buf
[i
++] = DIGI_RTS_ACTIVE
;
825 arg
&= ~DIGI_INPUT_FLOW_CONTROL_RTS
;
827 buf
[i
++] = DIGI_CMD_SET_INPUT_FLOW_CONTROL
;
828 buf
[i
++] = priv
->dp_port_num
;
833 /* set output flow control */
834 if ((iflag
& IXON
) != (old_iflag
& IXON
)
835 || (cflag
& CRTSCTS
) != (old_cflag
& CRTSCTS
)) {
838 arg
|= DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF
;
840 arg
&= ~DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF
;
842 if (cflag
& CRTSCTS
) {
843 arg
|= DIGI_OUTPUT_FLOW_CONTROL_CTS
;
845 arg
&= ~DIGI_OUTPUT_FLOW_CONTROL_CTS
;
849 buf
[i
++] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL
;
850 buf
[i
++] = priv
->dp_port_num
;
855 /* set receive enable/disable */
856 if ((cflag
& CREAD
) != (old_cflag
& CREAD
)) {
862 buf
[i
++] = DIGI_CMD_RECEIVE_ENABLE
;
863 buf
[i
++] = priv
->dp_port_num
;
867 ret
= digi_write_oob_command(port
, buf
, i
, 1);
869 dbg("digi_set_termios: write oob failed, ret=%d", ret
);
870 tty_encode_baud_rate(tty
, baud
, baud
);
874 static void digi_break_ctl(struct tty_struct
*tty
, int break_state
)
876 struct usb_serial_port
*port
= tty
->driver_data
;
877 unsigned char buf
[4];
879 buf
[0] = DIGI_CMD_BREAK_CONTROL
;
880 buf
[1] = 2; /* length */
881 buf
[2] = break_state
? 1 : 0;
882 buf
[3] = 0; /* pad */
883 digi_write_inb_command(port
, buf
, 4, 0);
887 static int digi_tiocmget(struct tty_struct
*tty
)
889 struct usb_serial_port
*port
= tty
->driver_data
;
890 struct digi_port
*priv
= usb_get_serial_port_data(port
);
894 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
895 val
= priv
->dp_modem_signals
;
896 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
901 static int digi_tiocmset(struct tty_struct
*tty
,
902 unsigned int set
, unsigned int clear
)
904 struct usb_serial_port
*port
= tty
->driver_data
;
905 struct digi_port
*priv
= usb_get_serial_port_data(port
);
909 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
910 val
= (priv
->dp_modem_signals
& ~clear
) | set
;
911 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
912 return digi_set_modem_signals(port
, val
, 1);
916 static int digi_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
917 const unsigned char *buf
, int count
)
920 int ret
, data_len
, new_len
;
921 struct digi_port
*priv
= usb_get_serial_port_data(port
);
922 unsigned char *data
= port
->write_urb
->transfer_buffer
;
923 unsigned long flags
= 0;
925 dbg("digi_write: TOP: port=%d, count=%d, in_interrupt=%ld",
926 priv
->dp_port_num
, count
, in_interrupt());
928 /* copy user data (which can sleep) before getting spin lock */
929 count
= min(count
, port
->bulk_out_size
-2);
930 count
= min(64, count
);
932 /* be sure only one write proceeds at a time */
933 /* there are races on the port private buffer */
934 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
936 /* wait for urb status clear to submit another urb */
937 if (priv
->dp_write_urb_in_use
) {
938 /* buffer data if count is 1 (probably put_char) if possible */
939 if (count
== 1 && priv
->dp_out_buf_len
< DIGI_OUT_BUF_SIZE
) {
940 priv
->dp_out_buf
[priv
->dp_out_buf_len
++] = *buf
;
945 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
949 /* allow space for any buffered data and for new data, up to */
950 /* transfer buffer size - 2 (for command and length bytes) */
951 new_len
= min(count
, port
->bulk_out_size
-2-priv
->dp_out_buf_len
);
952 data_len
= new_len
+ priv
->dp_out_buf_len
;
955 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
959 port
->write_urb
->transfer_buffer_length
= data_len
+2;
961 *data
++ = DIGI_CMD_SEND_DATA
;
964 /* copy in buffered data first */
965 memcpy(data
, priv
->dp_out_buf
, priv
->dp_out_buf_len
);
966 data
+= priv
->dp_out_buf_len
;
968 /* copy in new data */
969 memcpy(data
, buf
, new_len
);
971 ret
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
973 priv
->dp_write_urb_in_use
= 1;
975 priv
->dp_out_buf_len
= 0;
978 /* return length of new data written, or error */
979 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
981 dev_err_console(port
,
982 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
983 __func__
, ret
, priv
->dp_port_num
);
984 dbg("digi_write: returning %d", ret
);
989 static void digi_write_bulk_callback(struct urb
*urb
)
992 struct usb_serial_port
*port
= urb
->context
;
993 struct usb_serial
*serial
;
994 struct digi_port
*priv
;
995 struct digi_serial
*serial_priv
;
997 int status
= urb
->status
;
999 /* port and serial sanity check */
1000 if (port
== NULL
|| (priv
= usb_get_serial_port_data(port
)) == NULL
) {
1001 pr_err("%s: port or port->private is NULL, status=%d\n",
1005 serial
= port
->serial
;
1006 if (serial
== NULL
|| (serial_priv
= usb_get_serial_data(serial
)) == NULL
) {
1008 "%s: serial or serial->private is NULL, status=%d\n",
1013 /* handle oob callback */
1014 if (priv
->dp_port_num
== serial_priv
->ds_oob_port_num
) {
1015 dbg("digi_write_bulk_callback: oob callback");
1016 spin_lock(&priv
->dp_port_lock
);
1017 priv
->dp_write_urb_in_use
= 0;
1018 wake_up_interruptible(&port
->write_wait
);
1019 spin_unlock(&priv
->dp_port_lock
);
1023 /* try to send any buffered data on this port */
1024 spin_lock(&priv
->dp_port_lock
);
1025 priv
->dp_write_urb_in_use
= 0;
1026 if (priv
->dp_out_buf_len
> 0) {
1027 *((unsigned char *)(port
->write_urb
->transfer_buffer
))
1028 = (unsigned char)DIGI_CMD_SEND_DATA
;
1029 *((unsigned char *)(port
->write_urb
->transfer_buffer
) + 1)
1030 = (unsigned char)priv
->dp_out_buf_len
;
1031 port
->write_urb
->transfer_buffer_length
=
1032 priv
->dp_out_buf_len
+ 2;
1033 memcpy(port
->write_urb
->transfer_buffer
+ 2, priv
->dp_out_buf
,
1034 priv
->dp_out_buf_len
);
1035 ret
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
1037 priv
->dp_write_urb_in_use
= 1;
1038 priv
->dp_out_buf_len
= 0;
1041 /* wake up processes sleeping on writes immediately */
1042 digi_wakeup_write(port
);
1043 /* also queue up a wakeup at scheduler time, in case we */
1044 /* lost the race in write_chan(). */
1045 schedule_work(&priv
->dp_wakeup_work
);
1047 spin_unlock(&priv
->dp_port_lock
);
1048 if (ret
&& ret
!= -EPERM
)
1049 dev_err_console(port
,
1050 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
1051 __func__
, ret
, priv
->dp_port_num
);
1054 static int digi_write_room(struct tty_struct
*tty
)
1056 struct usb_serial_port
*port
= tty
->driver_data
;
1057 struct digi_port
*priv
= usb_get_serial_port_data(port
);
1059 unsigned long flags
= 0;
1061 spin_lock_irqsave(&priv
->dp_port_lock
, flags
);
1063 if (priv
->dp_write_urb_in_use
)
1066 room
= port
->bulk_out_size
- 2 - priv
->dp_out_buf_len
;
1068 spin_unlock_irqrestore(&priv
->dp_port_lock
, flags
);
1069 dbg("digi_write_room: port=%d, room=%d", priv
->dp_port_num
, room
);
1074 static int digi_chars_in_buffer(struct tty_struct
*tty
)
1076 struct usb_serial_port
*port
= tty
->driver_data
;
1077 struct digi_port
*priv
= usb_get_serial_port_data(port
);
1079 if (priv
->dp_write_urb_in_use
) {
1080 dbg("digi_chars_in_buffer: port=%d, chars=%d",
1081 priv
->dp_port_num
, port
->bulk_out_size
- 2);
1082 /* return(port->bulk_out_size - 2); */
1085 dbg("digi_chars_in_buffer: port=%d, chars=%d",
1086 priv
->dp_port_num
, priv
->dp_out_buf_len
);
1087 return priv
->dp_out_buf_len
;
1092 static void digi_dtr_rts(struct usb_serial_port
*port
, int on
)
1094 /* Adjust DTR and RTS */
1095 digi_set_modem_signals(port
, on
* (TIOCM_DTR
|TIOCM_RTS
), 1);
1098 static int digi_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
1101 unsigned char buf
[32];
1102 struct digi_port
*priv
= usb_get_serial_port_data(port
);
1103 struct ktermios not_termios
;
1105 /* be sure the device is started up */
1106 if (digi_startup_device(port
->serial
) != 0)
1109 /* read modem signals automatically whenever they change */
1110 buf
[0] = DIGI_CMD_READ_INPUT_SIGNALS
;
1111 buf
[1] = priv
->dp_port_num
;
1112 buf
[2] = DIGI_ENABLE
;
1116 buf
[4] = DIGI_CMD_IFLUSH_FIFO
;
1117 buf
[5] = priv
->dp_port_num
;
1118 buf
[6] = DIGI_FLUSH_TX
| DIGI_FLUSH_RX
;
1121 ret
= digi_write_oob_command(port
, buf
, 8, 1);
1123 dbg("digi_open: write oob failed, ret=%d", ret
);
1125 /* set termios settings */
1127 not_termios
.c_cflag
= ~tty
->termios
.c_cflag
;
1128 not_termios
.c_iflag
= ~tty
->termios
.c_iflag
;
1129 digi_set_termios(tty
, port
, ¬_termios
);
1135 static void digi_close(struct usb_serial_port
*port
)
1139 unsigned char buf
[32];
1140 struct digi_port
*priv
= usb_get_serial_port_data(port
);
1142 mutex_lock(&port
->serial
->disc_mutex
);
1143 /* if disconnected, just clear flags */
1144 if (port
->serial
->disconnected
)
1147 if (port
->serial
->dev
) {
1148 /* FIXME: Transmit idle belongs in the wait_unti_sent path */
1149 digi_transmit_idle(port
, DIGI_CLOSE_TIMEOUT
);
1151 /* disable input flow control */
1152 buf
[0] = DIGI_CMD_SET_INPUT_FLOW_CONTROL
;
1153 buf
[1] = priv
->dp_port_num
;
1154 buf
[2] = DIGI_DISABLE
;
1157 /* disable output flow control */
1158 buf
[4] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL
;
1159 buf
[5] = priv
->dp_port_num
;
1160 buf
[6] = DIGI_DISABLE
;
1163 /* disable reading modem signals automatically */
1164 buf
[8] = DIGI_CMD_READ_INPUT_SIGNALS
;
1165 buf
[9] = priv
->dp_port_num
;
1166 buf
[10] = DIGI_DISABLE
;
1169 /* disable receive */
1170 buf
[12] = DIGI_CMD_RECEIVE_ENABLE
;
1171 buf
[13] = priv
->dp_port_num
;
1172 buf
[14] = DIGI_DISABLE
;
1176 buf
[16] = DIGI_CMD_IFLUSH_FIFO
;
1177 buf
[17] = priv
->dp_port_num
;
1178 buf
[18] = DIGI_FLUSH_TX
| DIGI_FLUSH_RX
;
1181 ret
= digi_write_oob_command(port
, buf
, 20, 0);
1183 dbg("digi_close: write oob failed, ret=%d", ret
);
1185 /* wait for final commands on oob port to complete */
1186 prepare_to_wait(&priv
->dp_flush_wait
, &wait
,
1187 TASK_INTERRUPTIBLE
);
1188 schedule_timeout(DIGI_CLOSE_TIMEOUT
);
1189 finish_wait(&priv
->dp_flush_wait
, &wait
);
1191 /* shutdown any outstanding bulk writes */
1192 usb_kill_urb(port
->write_urb
);
1195 spin_lock_irq(&priv
->dp_port_lock
);
1196 priv
->dp_write_urb_in_use
= 0;
1197 wake_up_interruptible(&priv
->dp_close_wait
);
1198 spin_unlock_irq(&priv
->dp_port_lock
);
1199 mutex_unlock(&port
->serial
->disc_mutex
);
1204 * Digi Startup Device
1206 * Starts reads on all ports. Must be called AFTER startup, with
1207 * urbs initialized. Returns 0 if successful, non-zero error otherwise.
1210 static int digi_startup_device(struct usb_serial
*serial
)
1213 struct digi_serial
*serial_priv
= usb_get_serial_data(serial
);
1214 struct usb_serial_port
*port
;
1216 /* be sure this happens exactly once */
1217 spin_lock(&serial_priv
->ds_serial_lock
);
1218 if (serial_priv
->ds_device_started
) {
1219 spin_unlock(&serial_priv
->ds_serial_lock
);
1222 serial_priv
->ds_device_started
= 1;
1223 spin_unlock(&serial_priv
->ds_serial_lock
);
1225 /* start reading from each bulk in endpoint for the device */
1226 /* set USB_DISABLE_SPD flag for write bulk urbs */
1227 for (i
= 0; i
< serial
->type
->num_ports
+ 1; i
++) {
1228 port
= serial
->port
[i
];
1229 ret
= usb_submit_urb(port
->read_urb
, GFP_KERNEL
);
1232 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
1241 static int digi_startup(struct usb_serial
*serial
)
1245 struct digi_port
*priv
;
1246 struct digi_serial
*serial_priv
;
1248 /* allocate the private data structures for all ports */
1249 /* number of regular ports + 1 for the out-of-band port */
1250 for (i
= 0; i
< serial
->type
->num_ports
+ 1; i
++) {
1251 /* allocate port private structure */
1252 priv
= kmalloc(sizeof(struct digi_port
), GFP_KERNEL
);
1255 kfree(usb_get_serial_port_data(serial
->port
[i
]));
1256 return 1; /* error */
1259 /* initialize port private structure */
1260 spin_lock_init(&priv
->dp_port_lock
);
1261 priv
->dp_port_num
= i
;
1262 priv
->dp_out_buf_len
= 0;
1263 priv
->dp_write_urb_in_use
= 0;
1264 priv
->dp_modem_signals
= 0;
1265 init_waitqueue_head(&priv
->dp_modem_change_wait
);
1266 priv
->dp_transmit_idle
= 0;
1267 init_waitqueue_head(&priv
->dp_transmit_idle_wait
);
1268 priv
->dp_throttled
= 0;
1269 priv
->dp_throttle_restart
= 0;
1270 init_waitqueue_head(&priv
->dp_flush_wait
);
1271 init_waitqueue_head(&priv
->dp_close_wait
);
1272 INIT_WORK(&priv
->dp_wakeup_work
, digi_wakeup_write_lock
);
1273 priv
->dp_port
= serial
->port
[i
];
1274 /* initialize write wait queue for this port */
1275 init_waitqueue_head(&serial
->port
[i
]->write_wait
);
1277 usb_set_serial_port_data(serial
->port
[i
], priv
);
1280 /* allocate serial private structure */
1281 serial_priv
= kmalloc(sizeof(struct digi_serial
), GFP_KERNEL
);
1282 if (serial_priv
== NULL
) {
1283 for (i
= 0; i
< serial
->type
->num_ports
+ 1; i
++)
1284 kfree(usb_get_serial_port_data(serial
->port
[i
]));
1285 return 1; /* error */
1288 /* initialize serial private structure */
1289 spin_lock_init(&serial_priv
->ds_serial_lock
);
1290 serial_priv
->ds_oob_port_num
= serial
->type
->num_ports
;
1291 serial_priv
->ds_oob_port
= serial
->port
[serial_priv
->ds_oob_port_num
];
1292 serial_priv
->ds_device_started
= 0;
1293 usb_set_serial_data(serial
, serial_priv
);
1299 static void digi_disconnect(struct usb_serial
*serial
)
1303 /* stop reads and writes on all ports */
1304 for (i
= 0; i
< serial
->type
->num_ports
+ 1; i
++) {
1305 usb_kill_urb(serial
->port
[i
]->read_urb
);
1306 usb_kill_urb(serial
->port
[i
]->write_urb
);
1311 static void digi_release(struct usb_serial
*serial
)
1315 /* free the private data structures for all ports */
1316 /* number of regular ports + 1 for the out-of-band port */
1317 for (i
= 0; i
< serial
->type
->num_ports
+ 1; i
++)
1318 kfree(usb_get_serial_port_data(serial
->port
[i
]));
1319 kfree(usb_get_serial_data(serial
));
1323 static void digi_read_bulk_callback(struct urb
*urb
)
1325 struct usb_serial_port
*port
= urb
->context
;
1326 struct digi_port
*priv
;
1327 struct digi_serial
*serial_priv
;
1329 int status
= urb
->status
;
1331 /* port sanity check, do not resubmit if port is not valid */
1334 priv
= usb_get_serial_port_data(port
);
1336 dev_err(&port
->dev
, "%s: port->private is NULL, status=%d\n",
1340 if (port
->serial
== NULL
||
1341 (serial_priv
= usb_get_serial_data(port
->serial
)) == NULL
) {
1342 dev_err(&port
->dev
, "%s: serial is bad or serial->private "
1343 "is NULL, status=%d\n", __func__
, status
);
1347 /* do not resubmit urb if it has any status error */
1350 "%s: nonzero read bulk status: status=%d, port=%d\n",
1351 __func__
, status
, priv
->dp_port_num
);
1355 /* handle oob or inb callback, do not resubmit if error */
1356 if (priv
->dp_port_num
== serial_priv
->ds_oob_port_num
) {
1357 if (digi_read_oob_callback(urb
) != 0)
1360 if (digi_read_inb_callback(urb
) != 0)
1365 ret
= usb_submit_urb(urb
, GFP_ATOMIC
);
1366 if (ret
!= 0 && ret
!= -EPERM
) {
1368 "%s: failed resubmitting urb, ret=%d, port=%d\n",
1369 __func__
, ret
, priv
->dp_port_num
);
1375 * Digi Read INB Callback
1377 * Digi Read INB Callback handles reads on the in band ports, sending
1378 * the data on to the tty subsystem. When called we know port and
1379 * port->private are not NULL and port->serial has been validated.
1380 * It returns 0 if successful, 1 if successful but the port is
1381 * throttled, and -1 if the sanity checks failed.
1384 static int digi_read_inb_callback(struct urb
*urb
)
1387 struct usb_serial_port
*port
= urb
->context
;
1388 struct tty_struct
*tty
;
1389 struct digi_port
*priv
= usb_get_serial_port_data(port
);
1390 int opcode
= ((unsigned char *)urb
->transfer_buffer
)[0];
1391 int len
= ((unsigned char *)urb
->transfer_buffer
)[1];
1392 int port_status
= ((unsigned char *)urb
->transfer_buffer
)[2];
1393 unsigned char *data
= ((unsigned char *)urb
->transfer_buffer
) + 3;
1394 int flag
, throttled
;
1395 int status
= urb
->status
;
1397 /* do not process callbacks on closed ports */
1398 /* but do continue the read chain */
1399 if (urb
->status
== -ENOENT
)
1402 /* short/multiple packet check */
1403 if (urb
->actual_length
!= len
+ 2) {
1404 dev_err(&port
->dev
, "%s: INCOMPLETE OR MULTIPLE PACKET, "
1405 "status=%d, port=%d, opcode=%d, len=%d, "
1406 "actual_length=%d, status=%d\n", __func__
, status
,
1407 priv
->dp_port_num
, opcode
, len
, urb
->actual_length
,
1412 tty
= tty_port_tty_get(&port
->port
);
1413 spin_lock(&priv
->dp_port_lock
);
1415 /* check for throttle; if set, do not resubmit read urb */
1416 /* indicate the read chain needs to be restarted on unthrottle */
1417 throttled
= priv
->dp_throttled
;
1419 priv
->dp_throttle_restart
= 1;
1422 if (tty
&& opcode
== DIGI_CMD_RECEIVE_DATA
) {
1423 /* get flag from port_status */
1426 /* overrun is special, not associated with a char */
1427 if (port_status
& DIGI_OVERRUN_ERROR
)
1428 tty_insert_flip_char(tty
, 0, TTY_OVERRUN
);
1430 /* break takes precedence over parity, */
1431 /* which takes precedence over framing errors */
1432 if (port_status
& DIGI_BREAK_ERROR
)
1434 else if (port_status
& DIGI_PARITY_ERROR
)
1436 else if (port_status
& DIGI_FRAMING_ERROR
)
1439 /* data length is len-1 (one byte of len is port_status) */
1442 tty_insert_flip_string_fixed_flag(tty
, data
, flag
,
1444 tty_flip_buffer_push(tty
);
1447 spin_unlock(&priv
->dp_port_lock
);
1450 if (opcode
== DIGI_CMD_RECEIVE_DISABLE
)
1451 dbg("%s: got RECEIVE_DISABLE", __func__
);
1452 else if (opcode
!= DIGI_CMD_RECEIVE_DATA
)
1453 dbg("%s: unknown opcode: %d", __func__
, opcode
);
1455 return throttled
? 1 : 0;
1461 * Digi Read OOB Callback
1463 * Digi Read OOB Callback handles reads on the out of band port.
1464 * When called we know port and port->private are not NULL and
1465 * the port->serial is valid. It returns 0 if successful, and
1466 * -1 if the sanity checks failed.
1469 static int digi_read_oob_callback(struct urb
*urb
)
1472 struct usb_serial_port
*port
= urb
->context
;
1473 struct usb_serial
*serial
= port
->serial
;
1474 struct tty_struct
*tty
;
1475 struct digi_port
*priv
= usb_get_serial_port_data(port
);
1476 int opcode
, line
, status
, val
;
1480 /* handle each oob command */
1481 for (i
= 0; i
< urb
->actual_length
- 3;) {
1482 opcode
= ((unsigned char *)urb
->transfer_buffer
)[i
++];
1483 line
= ((unsigned char *)urb
->transfer_buffer
)[i
++];
1484 status
= ((unsigned char *)urb
->transfer_buffer
)[i
++];
1485 val
= ((unsigned char *)urb
->transfer_buffer
)[i
++];
1487 dbg("digi_read_oob_callback: opcode=%d, line=%d, status=%d, val=%d",
1488 opcode
, line
, status
, val
);
1490 if (status
!= 0 || line
>= serial
->type
->num_ports
)
1493 port
= serial
->port
[line
];
1495 priv
= usb_get_serial_port_data(port
);
1499 tty
= tty_port_tty_get(&port
->port
);
1503 rts
= tty
->termios
.c_cflag
& CRTSCTS
;
1505 if (tty
&& opcode
== DIGI_CMD_READ_INPUT_SIGNALS
) {
1506 spin_lock(&priv
->dp_port_lock
);
1507 /* convert from digi flags to termiox flags */
1508 if (val
& DIGI_READ_INPUT_SIGNALS_CTS
) {
1509 priv
->dp_modem_signals
|= TIOCM_CTS
;
1510 /* port must be open to use tty struct */
1512 tty
->hw_stopped
= 0;
1513 digi_wakeup_write(port
);
1516 priv
->dp_modem_signals
&= ~TIOCM_CTS
;
1517 /* port must be open to use tty struct */
1519 tty
->hw_stopped
= 1;
1521 if (val
& DIGI_READ_INPUT_SIGNALS_DSR
)
1522 priv
->dp_modem_signals
|= TIOCM_DSR
;
1524 priv
->dp_modem_signals
&= ~TIOCM_DSR
;
1525 if (val
& DIGI_READ_INPUT_SIGNALS_RI
)
1526 priv
->dp_modem_signals
|= TIOCM_RI
;
1528 priv
->dp_modem_signals
&= ~TIOCM_RI
;
1529 if (val
& DIGI_READ_INPUT_SIGNALS_DCD
)
1530 priv
->dp_modem_signals
|= TIOCM_CD
;
1532 priv
->dp_modem_signals
&= ~TIOCM_CD
;
1534 wake_up_interruptible(&priv
->dp_modem_change_wait
);
1535 spin_unlock(&priv
->dp_port_lock
);
1536 } else if (opcode
== DIGI_CMD_TRANSMIT_IDLE
) {
1537 spin_lock(&priv
->dp_port_lock
);
1538 priv
->dp_transmit_idle
= 1;
1539 wake_up_interruptible(&priv
->dp_transmit_idle_wait
);
1540 spin_unlock(&priv
->dp_port_lock
);
1541 } else if (opcode
== DIGI_CMD_IFLUSH_FIFO
) {
1542 wake_up_interruptible(&priv
->dp_flush_wait
);
1550 module_usb_serial_driver(serial_drivers
, id_table_combined
);
1552 MODULE_AUTHOR(DRIVER_AUTHOR
);
1553 MODULE_DESCRIPTION(DRIVER_DESC
);
1554 MODULE_LICENSE("GPL");
1556 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
1557 MODULE_PARM_DESC(debug
, "Debug enabled or not");