Loading...
1// SPDX-License-Identifier: GPL-2.0+
2/*
3* Digi AccelePort USB-4 and USB-2 Serial Converters
4*
5* Copyright 2000 by Digi International
6*
7* Shamelessly based on Brian Warner's keyspan_pda.c and Greg Kroah-Hartman's
8* usb-serial driver.
9*
10* Peter Berger (pberger@brimson.com)
11* Al Borchers (borchers@steinerpoint.com)
12*/
13
14#include <linux/kernel.h>
15#include <linux/errno.h>
16#include <linux/slab.h>
17#include <linux/tty.h>
18#include <linux/tty_driver.h>
19#include <linux/tty_flip.h>
20#include <linux/module.h>
21#include <linux/spinlock.h>
22#include <linux/uaccess.h>
23#include <linux/usb.h>
24#include <linux/wait.h>
25#include <linux/sched/signal.h>
26#include <linux/usb/serial.h>
27
28/* Defines */
29
30#define DRIVER_AUTHOR "Peter Berger <pberger@brimson.com>, Al Borchers <borchers@steinerpoint.com>"
31#define DRIVER_DESC "Digi AccelePort USB-2/USB-4 Serial Converter driver"
32
33/* port output buffer length -- must be <= transfer buffer length - 2 */
34/* so we can be sure to send the full buffer in one urb */
35#define DIGI_OUT_BUF_SIZE 8
36
37/* port input buffer length -- must be >= transfer buffer length - 3 */
38/* so we can be sure to hold at least one full buffer from one urb */
39#define DIGI_IN_BUF_SIZE 64
40
41/* retry timeout while sleeping */
42#define DIGI_RETRY_TIMEOUT (HZ/10)
43
44/* timeout while waiting for tty output to drain in close */
45/* this delay is used twice in close, so the total delay could */
46/* be twice this value */
47#define DIGI_CLOSE_TIMEOUT (5*HZ)
48
49
50/* AccelePort USB Defines */
51
52/* ids */
53#define DIGI_VENDOR_ID 0x05c5
54#define DIGI_2_ID 0x0002 /* USB-2 */
55#define DIGI_4_ID 0x0004 /* USB-4 */
56
57/* commands
58 * "INB": can be used on the in-band endpoint
59 * "OOB": can be used on the out-of-band endpoint
60 */
61#define DIGI_CMD_SET_BAUD_RATE 0 /* INB, OOB */
62#define DIGI_CMD_SET_WORD_SIZE 1 /* INB, OOB */
63#define DIGI_CMD_SET_PARITY 2 /* INB, OOB */
64#define DIGI_CMD_SET_STOP_BITS 3 /* INB, OOB */
65#define DIGI_CMD_SET_INPUT_FLOW_CONTROL 4 /* INB, OOB */
66#define DIGI_CMD_SET_OUTPUT_FLOW_CONTROL 5 /* INB, OOB */
67#define DIGI_CMD_SET_DTR_SIGNAL 6 /* INB, OOB */
68#define DIGI_CMD_SET_RTS_SIGNAL 7 /* INB, OOB */
69#define DIGI_CMD_READ_INPUT_SIGNALS 8 /* OOB */
70#define DIGI_CMD_IFLUSH_FIFO 9 /* OOB */
71#define DIGI_CMD_RECEIVE_ENABLE 10 /* INB, OOB */
72#define DIGI_CMD_BREAK_CONTROL 11 /* INB, OOB */
73#define DIGI_CMD_LOCAL_LOOPBACK 12 /* INB, OOB */
74#define DIGI_CMD_TRANSMIT_IDLE 13 /* INB, OOB */
75#define DIGI_CMD_READ_UART_REGISTER 14 /* OOB */
76#define DIGI_CMD_WRITE_UART_REGISTER 15 /* INB, OOB */
77#define DIGI_CMD_AND_UART_REGISTER 16 /* INB, OOB */
78#define DIGI_CMD_OR_UART_REGISTER 17 /* INB, OOB */
79#define DIGI_CMD_SEND_DATA 18 /* INB */
80#define DIGI_CMD_RECEIVE_DATA 19 /* INB */
81#define DIGI_CMD_RECEIVE_DISABLE 20 /* INB */
82#define DIGI_CMD_GET_PORT_TYPE 21 /* OOB */
83
84/* baud rates */
85#define DIGI_BAUD_50 0
86#define DIGI_BAUD_75 1
87#define DIGI_BAUD_110 2
88#define DIGI_BAUD_150 3
89#define DIGI_BAUD_200 4
90#define DIGI_BAUD_300 5
91#define DIGI_BAUD_600 6
92#define DIGI_BAUD_1200 7
93#define DIGI_BAUD_1800 8
94#define DIGI_BAUD_2400 9
95#define DIGI_BAUD_4800 10
96#define DIGI_BAUD_7200 11
97#define DIGI_BAUD_9600 12
98#define DIGI_BAUD_14400 13
99#define DIGI_BAUD_19200 14
100#define DIGI_BAUD_28800 15
101#define DIGI_BAUD_38400 16
102#define DIGI_BAUD_57600 17
103#define DIGI_BAUD_76800 18
104#define DIGI_BAUD_115200 19
105#define DIGI_BAUD_153600 20
106#define DIGI_BAUD_230400 21
107#define DIGI_BAUD_460800 22
108
109/* arguments */
110#define DIGI_WORD_SIZE_5 0
111#define DIGI_WORD_SIZE_6 1
112#define DIGI_WORD_SIZE_7 2
113#define DIGI_WORD_SIZE_8 3
114
115#define DIGI_PARITY_NONE 0
116#define DIGI_PARITY_ODD 1
117#define DIGI_PARITY_EVEN 2
118#define DIGI_PARITY_MARK 3
119#define DIGI_PARITY_SPACE 4
120
121#define DIGI_STOP_BITS_1 0
122#define DIGI_STOP_BITS_2 1
123
124#define DIGI_INPUT_FLOW_CONTROL_XON_XOFF 1
125#define DIGI_INPUT_FLOW_CONTROL_RTS 2
126#define DIGI_INPUT_FLOW_CONTROL_DTR 4
127
128#define DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF 1
129#define DIGI_OUTPUT_FLOW_CONTROL_CTS 2
130#define DIGI_OUTPUT_FLOW_CONTROL_DSR 4
131
132#define DIGI_DTR_INACTIVE 0
133#define DIGI_DTR_ACTIVE 1
134#define DIGI_DTR_INPUT_FLOW_CONTROL 2
135
136#define DIGI_RTS_INACTIVE 0
137#define DIGI_RTS_ACTIVE 1
138#define DIGI_RTS_INPUT_FLOW_CONTROL 2
139#define DIGI_RTS_TOGGLE 3
140
141#define DIGI_FLUSH_TX 1
142#define DIGI_FLUSH_RX 2
143#define DIGI_RESUME_TX 4 /* clears xoff condition */
144
145#define DIGI_TRANSMIT_NOT_IDLE 0
146#define DIGI_TRANSMIT_IDLE 1
147
148#define DIGI_DISABLE 0
149#define DIGI_ENABLE 1
150
151#define DIGI_DEASSERT 0
152#define DIGI_ASSERT 1
153
154/* in band status codes */
155#define DIGI_OVERRUN_ERROR 4
156#define DIGI_PARITY_ERROR 8
157#define DIGI_FRAMING_ERROR 16
158#define DIGI_BREAK_ERROR 32
159
160/* out of band status */
161#define DIGI_NO_ERROR 0
162#define DIGI_BAD_FIRST_PARAMETER 1
163#define DIGI_BAD_SECOND_PARAMETER 2
164#define DIGI_INVALID_LINE 3
165#define DIGI_INVALID_OPCODE 4
166
167/* input signals */
168#define DIGI_READ_INPUT_SIGNALS_SLOT 1
169#define DIGI_READ_INPUT_SIGNALS_ERR 2
170#define DIGI_READ_INPUT_SIGNALS_BUSY 4
171#define DIGI_READ_INPUT_SIGNALS_PE 8
172#define DIGI_READ_INPUT_SIGNALS_CTS 16
173#define DIGI_READ_INPUT_SIGNALS_DSR 32
174#define DIGI_READ_INPUT_SIGNALS_RI 64
175#define DIGI_READ_INPUT_SIGNALS_DCD 128
176
177
178/* Structures */
179
180struct digi_serial {
181 spinlock_t ds_serial_lock;
182 struct usb_serial_port *ds_oob_port; /* out-of-band port */
183 int ds_oob_port_num; /* index of out-of-band port */
184 int ds_device_started;
185};
186
187struct digi_port {
188 spinlock_t dp_port_lock;
189 int dp_port_num;
190 int dp_out_buf_len;
191 unsigned char dp_out_buf[DIGI_OUT_BUF_SIZE];
192 int dp_write_urb_in_use;
193 unsigned int dp_modem_signals;
194 int dp_transmit_idle;
195 wait_queue_head_t dp_transmit_idle_wait;
196 int dp_throttled;
197 int dp_throttle_restart;
198 wait_queue_head_t dp_flush_wait;
199 wait_queue_head_t dp_close_wait; /* wait queue for close */
200 wait_queue_head_t write_wait;
201 struct usb_serial_port *dp_port;
202};
203
204
205/* Local Function Declarations */
206
207static int digi_write_oob_command(struct usb_serial_port *port,
208 unsigned char *buf, int count, int interruptible);
209static int digi_write_inb_command(struct usb_serial_port *port,
210 unsigned char *buf, int count, unsigned long timeout);
211static int digi_set_modem_signals(struct usb_serial_port *port,
212 unsigned int modem_signals, int interruptible);
213static int digi_transmit_idle(struct usb_serial_port *port,
214 unsigned long timeout);
215static void digi_rx_throttle(struct tty_struct *tty);
216static void digi_rx_unthrottle(struct tty_struct *tty);
217static void digi_set_termios(struct tty_struct *tty,
218 struct usb_serial_port *port,
219 const struct ktermios *old_termios);
220static int digi_break_ctl(struct tty_struct *tty, int break_state);
221static int digi_tiocmget(struct tty_struct *tty);
222static int digi_tiocmset(struct tty_struct *tty, unsigned int set,
223 unsigned int clear);
224static int digi_write(struct tty_struct *tty, struct usb_serial_port *port,
225 const unsigned char *buf, int count);
226static void digi_write_bulk_callback(struct urb *urb);
227static unsigned int digi_write_room(struct tty_struct *tty);
228static unsigned int digi_chars_in_buffer(struct tty_struct *tty);
229static int digi_open(struct tty_struct *tty, struct usb_serial_port *port);
230static void digi_close(struct usb_serial_port *port);
231static void digi_dtr_rts(struct usb_serial_port *port, int on);
232static int digi_startup_device(struct usb_serial *serial);
233static int digi_startup(struct usb_serial *serial);
234static void digi_disconnect(struct usb_serial *serial);
235static void digi_release(struct usb_serial *serial);
236static int digi_port_probe(struct usb_serial_port *port);
237static void digi_port_remove(struct usb_serial_port *port);
238static void digi_read_bulk_callback(struct urb *urb);
239static int digi_read_inb_callback(struct urb *urb);
240static int digi_read_oob_callback(struct urb *urb);
241
242
243static const struct usb_device_id id_table_combined[] = {
244 { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
245 { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
246 { } /* Terminating entry */
247};
248
249static const struct usb_device_id id_table_2[] = {
250 { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
251 { } /* Terminating entry */
252};
253
254static const struct usb_device_id id_table_4[] = {
255 { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
256 { } /* Terminating entry */
257};
258
259MODULE_DEVICE_TABLE(usb, id_table_combined);
260
261/* device info needed for the Digi serial converter */
262
263static struct usb_serial_driver digi_acceleport_2_device = {
264 .driver = {
265 .owner = THIS_MODULE,
266 .name = "digi_2",
267 },
268 .description = "Digi 2 port USB adapter",
269 .id_table = id_table_2,
270 .num_ports = 3,
271 .num_bulk_in = 4,
272 .num_bulk_out = 4,
273 .open = digi_open,
274 .close = digi_close,
275 .dtr_rts = digi_dtr_rts,
276 .write = digi_write,
277 .write_room = digi_write_room,
278 .write_bulk_callback = digi_write_bulk_callback,
279 .read_bulk_callback = digi_read_bulk_callback,
280 .chars_in_buffer = digi_chars_in_buffer,
281 .throttle = digi_rx_throttle,
282 .unthrottle = digi_rx_unthrottle,
283 .set_termios = digi_set_termios,
284 .break_ctl = digi_break_ctl,
285 .tiocmget = digi_tiocmget,
286 .tiocmset = digi_tiocmset,
287 .attach = digi_startup,
288 .disconnect = digi_disconnect,
289 .release = digi_release,
290 .port_probe = digi_port_probe,
291 .port_remove = digi_port_remove,
292};
293
294static struct usb_serial_driver digi_acceleport_4_device = {
295 .driver = {
296 .owner = THIS_MODULE,
297 .name = "digi_4",
298 },
299 .description = "Digi 4 port USB adapter",
300 .id_table = id_table_4,
301 .num_ports = 4,
302 .num_bulk_in = 5,
303 .num_bulk_out = 5,
304 .open = digi_open,
305 .close = digi_close,
306 .write = digi_write,
307 .write_room = digi_write_room,
308 .write_bulk_callback = digi_write_bulk_callback,
309 .read_bulk_callback = digi_read_bulk_callback,
310 .chars_in_buffer = digi_chars_in_buffer,
311 .throttle = digi_rx_throttle,
312 .unthrottle = digi_rx_unthrottle,
313 .set_termios = digi_set_termios,
314 .break_ctl = digi_break_ctl,
315 .tiocmget = digi_tiocmget,
316 .tiocmset = digi_tiocmset,
317 .attach = digi_startup,
318 .disconnect = digi_disconnect,
319 .release = digi_release,
320 .port_probe = digi_port_probe,
321 .port_remove = digi_port_remove,
322};
323
324static struct usb_serial_driver * const serial_drivers[] = {
325 &digi_acceleport_2_device, &digi_acceleport_4_device, NULL
326};
327
328/* Functions */
329
330/*
331 * Cond Wait Interruptible Timeout Irqrestore
332 *
333 * Do spin_unlock_irqrestore and interruptible_sleep_on_timeout
334 * so that wake ups are not lost if they occur between the unlock
335 * and the sleep. In other words, spin_unlock_irqrestore and
336 * interruptible_sleep_on_timeout are "atomic" with respect to
337 * wake ups. This is used to implement condition variables.
338 *
339 * interruptible_sleep_on_timeout is deprecated and has been replaced
340 * with the equivalent code.
341 */
342
343static long cond_wait_interruptible_timeout_irqrestore(
344 wait_queue_head_t *q, long timeout,
345 spinlock_t *lock, unsigned long flags)
346__releases(lock)
347{
348 DEFINE_WAIT(wait);
349
350 prepare_to_wait(q, &wait, TASK_INTERRUPTIBLE);
351 spin_unlock_irqrestore(lock, flags);
352 timeout = schedule_timeout(timeout);
353 finish_wait(q, &wait);
354
355 return timeout;
356}
357
358/*
359 * Digi Write OOB Command
360 *
361 * Write commands on the out of band port. Commands are 4
362 * bytes each, multiple commands can be sent at once, and
363 * no command will be split across USB packets. Returns 0
364 * if successful, -EINTR if interrupted while sleeping and
365 * the interruptible flag is true, or a negative error
366 * returned by usb_submit_urb.
367 */
368
369static int digi_write_oob_command(struct usb_serial_port *port,
370 unsigned char *buf, int count, int interruptible)
371{
372 int ret = 0;
373 int len;
374 struct usb_serial_port *oob_port = (struct usb_serial_port *)((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
375 struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
376 unsigned long flags;
377
378 dev_dbg(&port->dev,
379 "digi_write_oob_command: TOP: port=%d, count=%d\n",
380 oob_priv->dp_port_num, count);
381
382 spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
383 while (count > 0) {
384 while (oob_priv->dp_write_urb_in_use) {
385 cond_wait_interruptible_timeout_irqrestore(
386 &oob_priv->write_wait, DIGI_RETRY_TIMEOUT,
387 &oob_priv->dp_port_lock, flags);
388 if (interruptible && signal_pending(current))
389 return -EINTR;
390 spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
391 }
392
393 /* len must be a multiple of 4, so commands are not split */
394 len = min(count, oob_port->bulk_out_size);
395 if (len > 4)
396 len &= ~3;
397 memcpy(oob_port->write_urb->transfer_buffer, buf, len);
398 oob_port->write_urb->transfer_buffer_length = len;
399 ret = usb_submit_urb(oob_port->write_urb, GFP_ATOMIC);
400 if (ret == 0) {
401 oob_priv->dp_write_urb_in_use = 1;
402 count -= len;
403 buf += len;
404 }
405 }
406 spin_unlock_irqrestore(&oob_priv->dp_port_lock, flags);
407 if (ret)
408 dev_err(&port->dev, "%s: usb_submit_urb failed, ret=%d\n",
409 __func__, ret);
410 return ret;
411
412}
413
414
415/*
416 * Digi Write In Band Command
417 *
418 * Write commands on the given port. Commands are 4
419 * bytes each, multiple commands can be sent at once, and
420 * no command will be split across USB packets. If timeout
421 * is non-zero, write in band command will return after
422 * waiting unsuccessfully for the URB status to clear for
423 * timeout ticks. Returns 0 if successful, or a negative
424 * error returned by digi_write.
425 */
426
427static int digi_write_inb_command(struct usb_serial_port *port,
428 unsigned char *buf, int count, unsigned long timeout)
429{
430 int ret = 0;
431 int len;
432 struct digi_port *priv = usb_get_serial_port_data(port);
433 unsigned char *data = port->write_urb->transfer_buffer;
434 unsigned long flags;
435
436 dev_dbg(&port->dev, "digi_write_inb_command: TOP: port=%d, count=%d\n",
437 priv->dp_port_num, count);
438
439 if (timeout)
440 timeout += jiffies;
441 else
442 timeout = ULONG_MAX;
443
444 spin_lock_irqsave(&priv->dp_port_lock, flags);
445 while (count > 0 && ret == 0) {
446 while (priv->dp_write_urb_in_use &&
447 time_before(jiffies, timeout)) {
448 cond_wait_interruptible_timeout_irqrestore(
449 &priv->write_wait, DIGI_RETRY_TIMEOUT,
450 &priv->dp_port_lock, flags);
451 if (signal_pending(current))
452 return -EINTR;
453 spin_lock_irqsave(&priv->dp_port_lock, flags);
454 }
455
456 /* len must be a multiple of 4 and small enough to */
457 /* guarantee the write will send buffered data first, */
458 /* so commands are in order with data and not split */
459 len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
460 if (len > 4)
461 len &= ~3;
462
463 /* write any buffered data first */
464 if (priv->dp_out_buf_len > 0) {
465 data[0] = DIGI_CMD_SEND_DATA;
466 data[1] = priv->dp_out_buf_len;
467 memcpy(data + 2, priv->dp_out_buf,
468 priv->dp_out_buf_len);
469 memcpy(data + 2 + priv->dp_out_buf_len, buf, len);
470 port->write_urb->transfer_buffer_length
471 = priv->dp_out_buf_len + 2 + len;
472 } else {
473 memcpy(data, buf, len);
474 port->write_urb->transfer_buffer_length = len;
475 }
476
477 ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
478 if (ret == 0) {
479 priv->dp_write_urb_in_use = 1;
480 priv->dp_out_buf_len = 0;
481 count -= len;
482 buf += len;
483 }
484
485 }
486 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
487
488 if (ret)
489 dev_err(&port->dev,
490 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
491 __func__, ret, priv->dp_port_num);
492 return ret;
493}
494
495
496/*
497 * Digi Set Modem Signals
498 *
499 * Sets or clears DTR and RTS on the port, according to the
500 * modem_signals argument. Use TIOCM_DTR and TIOCM_RTS flags
501 * for the modem_signals argument. Returns 0 if successful,
502 * -EINTR if interrupted while sleeping, or a non-zero error
503 * returned by usb_submit_urb.
504 */
505
506static int digi_set_modem_signals(struct usb_serial_port *port,
507 unsigned int modem_signals, int interruptible)
508{
509
510 int ret;
511 struct digi_port *port_priv = usb_get_serial_port_data(port);
512 struct usb_serial_port *oob_port = (struct usb_serial_port *) ((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
513 struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
514 unsigned char *data = oob_port->write_urb->transfer_buffer;
515 unsigned long flags;
516
517 dev_dbg(&port->dev,
518 "digi_set_modem_signals: TOP: port=%d, modem_signals=0x%x\n",
519 port_priv->dp_port_num, modem_signals);
520
521 spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
522 spin_lock(&port_priv->dp_port_lock);
523
524 while (oob_priv->dp_write_urb_in_use) {
525 spin_unlock(&port_priv->dp_port_lock);
526 cond_wait_interruptible_timeout_irqrestore(
527 &oob_priv->write_wait, DIGI_RETRY_TIMEOUT,
528 &oob_priv->dp_port_lock, flags);
529 if (interruptible && signal_pending(current))
530 return -EINTR;
531 spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
532 spin_lock(&port_priv->dp_port_lock);
533 }
534 data[0] = DIGI_CMD_SET_DTR_SIGNAL;
535 data[1] = port_priv->dp_port_num;
536 data[2] = (modem_signals & TIOCM_DTR) ?
537 DIGI_DTR_ACTIVE : DIGI_DTR_INACTIVE;
538 data[3] = 0;
539 data[4] = DIGI_CMD_SET_RTS_SIGNAL;
540 data[5] = port_priv->dp_port_num;
541 data[6] = (modem_signals & TIOCM_RTS) ?
542 DIGI_RTS_ACTIVE : DIGI_RTS_INACTIVE;
543 data[7] = 0;
544
545 oob_port->write_urb->transfer_buffer_length = 8;
546
547 ret = usb_submit_urb(oob_port->write_urb, GFP_ATOMIC);
548 if (ret == 0) {
549 oob_priv->dp_write_urb_in_use = 1;
550 port_priv->dp_modem_signals &= ~(TIOCM_DTR | TIOCM_RTS);
551 port_priv->dp_modem_signals |=
552 modem_signals & (TIOCM_DTR | TIOCM_RTS);
553 }
554 spin_unlock(&port_priv->dp_port_lock);
555 spin_unlock_irqrestore(&oob_priv->dp_port_lock, flags);
556 if (ret)
557 dev_err(&port->dev, "%s: usb_submit_urb failed, ret=%d\n",
558 __func__, ret);
559 return ret;
560}
561
562/*
563 * Digi Transmit Idle
564 *
565 * Digi transmit idle waits, up to timeout ticks, for the transmitter
566 * to go idle. It returns 0 if successful or a negative error.
567 *
568 * There are race conditions here if more than one process is calling
569 * digi_transmit_idle on the same port at the same time. However, this
570 * is only called from close, and only one process can be in close on a
571 * port at a time, so its ok.
572 */
573
574static int digi_transmit_idle(struct usb_serial_port *port,
575 unsigned long timeout)
576{
577 int ret;
578 unsigned char buf[2];
579 struct digi_port *priv = usb_get_serial_port_data(port);
580 unsigned long flags;
581
582 spin_lock_irqsave(&priv->dp_port_lock, flags);
583 priv->dp_transmit_idle = 0;
584 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
585
586 buf[0] = DIGI_CMD_TRANSMIT_IDLE;
587 buf[1] = 0;
588
589 timeout += jiffies;
590
591 ret = digi_write_inb_command(port, buf, 2, timeout - jiffies);
592 if (ret != 0)
593 return ret;
594
595 spin_lock_irqsave(&priv->dp_port_lock, flags);
596
597 while (time_before(jiffies, timeout) && !priv->dp_transmit_idle) {
598 cond_wait_interruptible_timeout_irqrestore(
599 &priv->dp_transmit_idle_wait, DIGI_RETRY_TIMEOUT,
600 &priv->dp_port_lock, flags);
601 if (signal_pending(current))
602 return -EINTR;
603 spin_lock_irqsave(&priv->dp_port_lock, flags);
604 }
605 priv->dp_transmit_idle = 0;
606 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
607 return 0;
608
609}
610
611
612static void digi_rx_throttle(struct tty_struct *tty)
613{
614 unsigned long flags;
615 struct usb_serial_port *port = tty->driver_data;
616 struct digi_port *priv = usb_get_serial_port_data(port);
617
618 /* stop receiving characters by not resubmitting the read urb */
619 spin_lock_irqsave(&priv->dp_port_lock, flags);
620 priv->dp_throttled = 1;
621 priv->dp_throttle_restart = 0;
622 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
623}
624
625
626static void digi_rx_unthrottle(struct tty_struct *tty)
627{
628 int ret = 0;
629 unsigned long flags;
630 struct usb_serial_port *port = tty->driver_data;
631 struct digi_port *priv = usb_get_serial_port_data(port);
632
633 spin_lock_irqsave(&priv->dp_port_lock, flags);
634
635 /* restart read chain */
636 if (priv->dp_throttle_restart)
637 ret = usb_submit_urb(port->read_urb, GFP_ATOMIC);
638
639 /* turn throttle off */
640 priv->dp_throttled = 0;
641 priv->dp_throttle_restart = 0;
642
643 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
644
645 if (ret)
646 dev_err(&port->dev,
647 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
648 __func__, ret, priv->dp_port_num);
649}
650
651
652static void digi_set_termios(struct tty_struct *tty,
653 struct usb_serial_port *port,
654 const struct ktermios *old_termios)
655{
656 struct digi_port *priv = usb_get_serial_port_data(port);
657 struct device *dev = &port->dev;
658 unsigned int iflag = tty->termios.c_iflag;
659 unsigned int cflag = tty->termios.c_cflag;
660 unsigned int old_iflag = old_termios->c_iflag;
661 unsigned int old_cflag = old_termios->c_cflag;
662 unsigned char buf[32];
663 unsigned int modem_signals;
664 int arg, ret;
665 int i = 0;
666 speed_t baud;
667
668 dev_dbg(dev,
669 "digi_set_termios: TOP: port=%d, iflag=0x%x, old_iflag=0x%x, cflag=0x%x, old_cflag=0x%x\n",
670 priv->dp_port_num, iflag, old_iflag, cflag, old_cflag);
671
672 /* set baud rate */
673 baud = tty_get_baud_rate(tty);
674 if (baud != tty_termios_baud_rate(old_termios)) {
675 arg = -1;
676
677 /* reassert DTR and (maybe) RTS on transition from B0 */
678 if ((old_cflag & CBAUD) == B0) {
679 /* don't set RTS if using hardware flow control */
680 /* and throttling input */
681 modem_signals = TIOCM_DTR;
682 if (!C_CRTSCTS(tty) || !tty_throttled(tty))
683 modem_signals |= TIOCM_RTS;
684 digi_set_modem_signals(port, modem_signals, 1);
685 }
686 switch (baud) {
687 /* drop DTR and RTS on transition to B0 */
688 case 0: digi_set_modem_signals(port, 0, 1); break;
689 case 50: arg = DIGI_BAUD_50; break;
690 case 75: arg = DIGI_BAUD_75; break;
691 case 110: arg = DIGI_BAUD_110; break;
692 case 150: arg = DIGI_BAUD_150; break;
693 case 200: arg = DIGI_BAUD_200; break;
694 case 300: arg = DIGI_BAUD_300; break;
695 case 600: arg = DIGI_BAUD_600; break;
696 case 1200: arg = DIGI_BAUD_1200; break;
697 case 1800: arg = DIGI_BAUD_1800; break;
698 case 2400: arg = DIGI_BAUD_2400; break;
699 case 4800: arg = DIGI_BAUD_4800; break;
700 case 9600: arg = DIGI_BAUD_9600; break;
701 case 19200: arg = DIGI_BAUD_19200; break;
702 case 38400: arg = DIGI_BAUD_38400; break;
703 case 57600: arg = DIGI_BAUD_57600; break;
704 case 115200: arg = DIGI_BAUD_115200; break;
705 case 230400: arg = DIGI_BAUD_230400; break;
706 case 460800: arg = DIGI_BAUD_460800; break;
707 default:
708 arg = DIGI_BAUD_9600;
709 baud = 9600;
710 break;
711 }
712 if (arg != -1) {
713 buf[i++] = DIGI_CMD_SET_BAUD_RATE;
714 buf[i++] = priv->dp_port_num;
715 buf[i++] = arg;
716 buf[i++] = 0;
717 }
718 }
719 /* set parity */
720 tty->termios.c_cflag &= ~CMSPAR;
721
722 if ((cflag & (PARENB | PARODD)) != (old_cflag & (PARENB | PARODD))) {
723 if (cflag & PARENB) {
724 if (cflag & PARODD)
725 arg = DIGI_PARITY_ODD;
726 else
727 arg = DIGI_PARITY_EVEN;
728 } else {
729 arg = DIGI_PARITY_NONE;
730 }
731 buf[i++] = DIGI_CMD_SET_PARITY;
732 buf[i++] = priv->dp_port_num;
733 buf[i++] = arg;
734 buf[i++] = 0;
735 }
736 /* set word size */
737 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
738 arg = -1;
739 switch (cflag & CSIZE) {
740 case CS5: arg = DIGI_WORD_SIZE_5; break;
741 case CS6: arg = DIGI_WORD_SIZE_6; break;
742 case CS7: arg = DIGI_WORD_SIZE_7; break;
743 case CS8: arg = DIGI_WORD_SIZE_8; break;
744 default:
745 dev_dbg(dev,
746 "digi_set_termios: can't handle word size %d\n",
747 cflag & CSIZE);
748 break;
749 }
750
751 if (arg != -1) {
752 buf[i++] = DIGI_CMD_SET_WORD_SIZE;
753 buf[i++] = priv->dp_port_num;
754 buf[i++] = arg;
755 buf[i++] = 0;
756 }
757
758 }
759
760 /* set stop bits */
761 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
762
763 if ((cflag & CSTOPB))
764 arg = DIGI_STOP_BITS_2;
765 else
766 arg = DIGI_STOP_BITS_1;
767
768 buf[i++] = DIGI_CMD_SET_STOP_BITS;
769 buf[i++] = priv->dp_port_num;
770 buf[i++] = arg;
771 buf[i++] = 0;
772
773 }
774
775 /* set input flow control */
776 if ((iflag & IXOFF) != (old_iflag & IXOFF) ||
777 (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
778 arg = 0;
779 if (iflag & IXOFF)
780 arg |= DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
781 else
782 arg &= ~DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
783
784 if (cflag & CRTSCTS) {
785 arg |= DIGI_INPUT_FLOW_CONTROL_RTS;
786
787 /* On USB-4 it is necessary to assert RTS prior */
788 /* to selecting RTS input flow control. */
789 buf[i++] = DIGI_CMD_SET_RTS_SIGNAL;
790 buf[i++] = priv->dp_port_num;
791 buf[i++] = DIGI_RTS_ACTIVE;
792 buf[i++] = 0;
793
794 } else {
795 arg &= ~DIGI_INPUT_FLOW_CONTROL_RTS;
796 }
797 buf[i++] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
798 buf[i++] = priv->dp_port_num;
799 buf[i++] = arg;
800 buf[i++] = 0;
801 }
802
803 /* set output flow control */
804 if ((iflag & IXON) != (old_iflag & IXON) ||
805 (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
806 arg = 0;
807 if (iflag & IXON)
808 arg |= DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
809 else
810 arg &= ~DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
811
812 if (cflag & CRTSCTS)
813 arg |= DIGI_OUTPUT_FLOW_CONTROL_CTS;
814 else
815 arg &= ~DIGI_OUTPUT_FLOW_CONTROL_CTS;
816
817 buf[i++] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
818 buf[i++] = priv->dp_port_num;
819 buf[i++] = arg;
820 buf[i++] = 0;
821 }
822
823 /* set receive enable/disable */
824 if ((cflag & CREAD) != (old_cflag & CREAD)) {
825 if (cflag & CREAD)
826 arg = DIGI_ENABLE;
827 else
828 arg = DIGI_DISABLE;
829
830 buf[i++] = DIGI_CMD_RECEIVE_ENABLE;
831 buf[i++] = priv->dp_port_num;
832 buf[i++] = arg;
833 buf[i++] = 0;
834 }
835 ret = digi_write_oob_command(port, buf, i, 1);
836 if (ret != 0)
837 dev_dbg(dev, "digi_set_termios: write oob failed, ret=%d\n", ret);
838 tty_encode_baud_rate(tty, baud, baud);
839}
840
841
842static int digi_break_ctl(struct tty_struct *tty, int break_state)
843{
844 struct usb_serial_port *port = tty->driver_data;
845 unsigned char buf[4];
846
847 buf[0] = DIGI_CMD_BREAK_CONTROL;
848 buf[1] = 2; /* length */
849 buf[2] = break_state ? 1 : 0;
850 buf[3] = 0; /* pad */
851
852 return digi_write_inb_command(port, buf, 4, 0);
853}
854
855
856static int digi_tiocmget(struct tty_struct *tty)
857{
858 struct usb_serial_port *port = tty->driver_data;
859 struct digi_port *priv = usb_get_serial_port_data(port);
860 unsigned int val;
861 unsigned long flags;
862
863 spin_lock_irqsave(&priv->dp_port_lock, flags);
864 val = priv->dp_modem_signals;
865 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
866 return val;
867}
868
869
870static int digi_tiocmset(struct tty_struct *tty,
871 unsigned int set, unsigned int clear)
872{
873 struct usb_serial_port *port = tty->driver_data;
874 struct digi_port *priv = usb_get_serial_port_data(port);
875 unsigned int val;
876 unsigned long flags;
877
878 spin_lock_irqsave(&priv->dp_port_lock, flags);
879 val = (priv->dp_modem_signals & ~clear) | set;
880 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
881 return digi_set_modem_signals(port, val, 1);
882}
883
884
885static int digi_write(struct tty_struct *tty, struct usb_serial_port *port,
886 const unsigned char *buf, int count)
887{
888
889 int ret, data_len, new_len;
890 struct digi_port *priv = usb_get_serial_port_data(port);
891 unsigned char *data = port->write_urb->transfer_buffer;
892 unsigned long flags;
893
894 dev_dbg(&port->dev, "digi_write: TOP: port=%d, count=%d\n",
895 priv->dp_port_num, count);
896
897 /* copy user data (which can sleep) before getting spin lock */
898 count = min(count, port->bulk_out_size-2);
899 count = min(64, count);
900
901 /* be sure only one write proceeds at a time */
902 /* there are races on the port private buffer */
903 spin_lock_irqsave(&priv->dp_port_lock, flags);
904
905 /* wait for urb status clear to submit another urb */
906 if (priv->dp_write_urb_in_use) {
907 /* buffer data if count is 1 (probably put_char) if possible */
908 if (count == 1 && priv->dp_out_buf_len < DIGI_OUT_BUF_SIZE) {
909 priv->dp_out_buf[priv->dp_out_buf_len++] = *buf;
910 new_len = 1;
911 } else {
912 new_len = 0;
913 }
914 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
915 return new_len;
916 }
917
918 /* allow space for any buffered data and for new data, up to */
919 /* transfer buffer size - 2 (for command and length bytes) */
920 new_len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
921 data_len = new_len + priv->dp_out_buf_len;
922
923 if (data_len == 0) {
924 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
925 return 0;
926 }
927
928 port->write_urb->transfer_buffer_length = data_len+2;
929
930 *data++ = DIGI_CMD_SEND_DATA;
931 *data++ = data_len;
932
933 /* copy in buffered data first */
934 memcpy(data, priv->dp_out_buf, priv->dp_out_buf_len);
935 data += priv->dp_out_buf_len;
936
937 /* copy in new data */
938 memcpy(data, buf, new_len);
939
940 ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
941 if (ret == 0) {
942 priv->dp_write_urb_in_use = 1;
943 ret = new_len;
944 priv->dp_out_buf_len = 0;
945 }
946
947 /* return length of new data written, or error */
948 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
949 if (ret < 0)
950 dev_err_console(port,
951 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
952 __func__, ret, priv->dp_port_num);
953 dev_dbg(&port->dev, "digi_write: returning %d\n", ret);
954 return ret;
955
956}
957
958static void digi_write_bulk_callback(struct urb *urb)
959{
960
961 struct usb_serial_port *port = urb->context;
962 struct usb_serial *serial;
963 struct digi_port *priv;
964 struct digi_serial *serial_priv;
965 unsigned long flags;
966 int ret = 0;
967 int status = urb->status;
968 bool wakeup;
969
970 /* port and serial sanity check */
971 if (port == NULL || (priv = usb_get_serial_port_data(port)) == NULL) {
972 pr_err("%s: port or port->private is NULL, status=%d\n",
973 __func__, status);
974 return;
975 }
976 serial = port->serial;
977 if (serial == NULL || (serial_priv = usb_get_serial_data(serial)) == NULL) {
978 dev_err(&port->dev,
979 "%s: serial or serial->private is NULL, status=%d\n",
980 __func__, status);
981 return;
982 }
983
984 /* handle oob callback */
985 if (priv->dp_port_num == serial_priv->ds_oob_port_num) {
986 dev_dbg(&port->dev, "digi_write_bulk_callback: oob callback\n");
987 spin_lock_irqsave(&priv->dp_port_lock, flags);
988 priv->dp_write_urb_in_use = 0;
989 wake_up_interruptible(&priv->write_wait);
990 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
991 return;
992 }
993
994 /* try to send any buffered data on this port */
995 wakeup = true;
996 spin_lock_irqsave(&priv->dp_port_lock, flags);
997 priv->dp_write_urb_in_use = 0;
998 if (priv->dp_out_buf_len > 0) {
999 *((unsigned char *)(port->write_urb->transfer_buffer))
1000 = (unsigned char)DIGI_CMD_SEND_DATA;
1001 *((unsigned char *)(port->write_urb->transfer_buffer) + 1)
1002 = (unsigned char)priv->dp_out_buf_len;
1003 port->write_urb->transfer_buffer_length =
1004 priv->dp_out_buf_len + 2;
1005 memcpy(port->write_urb->transfer_buffer + 2, priv->dp_out_buf,
1006 priv->dp_out_buf_len);
1007 ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1008 if (ret == 0) {
1009 priv->dp_write_urb_in_use = 1;
1010 priv->dp_out_buf_len = 0;
1011 wakeup = false;
1012 }
1013 }
1014 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1015
1016 if (ret && ret != -EPERM)
1017 dev_err_console(port,
1018 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
1019 __func__, ret, priv->dp_port_num);
1020
1021 if (wakeup)
1022 tty_port_tty_wakeup(&port->port);
1023}
1024
1025static unsigned int digi_write_room(struct tty_struct *tty)
1026{
1027 struct usb_serial_port *port = tty->driver_data;
1028 struct digi_port *priv = usb_get_serial_port_data(port);
1029 unsigned long flags;
1030 unsigned int room;
1031
1032 spin_lock_irqsave(&priv->dp_port_lock, flags);
1033
1034 if (priv->dp_write_urb_in_use)
1035 room = 0;
1036 else
1037 room = port->bulk_out_size - 2 - priv->dp_out_buf_len;
1038
1039 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1040 dev_dbg(&port->dev, "digi_write_room: port=%d, room=%u\n", priv->dp_port_num, room);
1041 return room;
1042
1043}
1044
1045static unsigned int digi_chars_in_buffer(struct tty_struct *tty)
1046{
1047 struct usb_serial_port *port = tty->driver_data;
1048 struct digi_port *priv = usb_get_serial_port_data(port);
1049 unsigned long flags;
1050 unsigned int chars;
1051
1052 spin_lock_irqsave(&priv->dp_port_lock, flags);
1053 if (priv->dp_write_urb_in_use)
1054 chars = port->bulk_out_size - 2;
1055 else
1056 chars = priv->dp_out_buf_len;
1057 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1058
1059 dev_dbg(&port->dev, "%s: port=%d, chars=%d\n", __func__,
1060 priv->dp_port_num, chars);
1061 return chars;
1062}
1063
1064static void digi_dtr_rts(struct usb_serial_port *port, int on)
1065{
1066 /* Adjust DTR and RTS */
1067 digi_set_modem_signals(port, on * (TIOCM_DTR | TIOCM_RTS), 1);
1068}
1069
1070static int digi_open(struct tty_struct *tty, struct usb_serial_port *port)
1071{
1072 int ret;
1073 unsigned char buf[32];
1074 struct digi_port *priv = usb_get_serial_port_data(port);
1075 struct ktermios not_termios;
1076
1077 /* be sure the device is started up */
1078 if (digi_startup_device(port->serial) != 0)
1079 return -ENXIO;
1080
1081 /* read modem signals automatically whenever they change */
1082 buf[0] = DIGI_CMD_READ_INPUT_SIGNALS;
1083 buf[1] = priv->dp_port_num;
1084 buf[2] = DIGI_ENABLE;
1085 buf[3] = 0;
1086
1087 /* flush fifos */
1088 buf[4] = DIGI_CMD_IFLUSH_FIFO;
1089 buf[5] = priv->dp_port_num;
1090 buf[6] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1091 buf[7] = 0;
1092
1093 ret = digi_write_oob_command(port, buf, 8, 1);
1094 if (ret != 0)
1095 dev_dbg(&port->dev, "digi_open: write oob failed, ret=%d\n", ret);
1096
1097 /* set termios settings */
1098 if (tty) {
1099 not_termios.c_cflag = ~tty->termios.c_cflag;
1100 not_termios.c_iflag = ~tty->termios.c_iflag;
1101 digi_set_termios(tty, port, ¬_termios);
1102 }
1103 return 0;
1104}
1105
1106
1107static void digi_close(struct usb_serial_port *port)
1108{
1109 DEFINE_WAIT(wait);
1110 int ret;
1111 unsigned char buf[32];
1112 struct digi_port *priv = usb_get_serial_port_data(port);
1113
1114 mutex_lock(&port->serial->disc_mutex);
1115 /* if disconnected, just clear flags */
1116 if (port->serial->disconnected)
1117 goto exit;
1118
1119 /* FIXME: Transmit idle belongs in the wait_unti_sent path */
1120 digi_transmit_idle(port, DIGI_CLOSE_TIMEOUT);
1121
1122 /* disable input flow control */
1123 buf[0] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1124 buf[1] = priv->dp_port_num;
1125 buf[2] = DIGI_DISABLE;
1126 buf[3] = 0;
1127
1128 /* disable output flow control */
1129 buf[4] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1130 buf[5] = priv->dp_port_num;
1131 buf[6] = DIGI_DISABLE;
1132 buf[7] = 0;
1133
1134 /* disable reading modem signals automatically */
1135 buf[8] = DIGI_CMD_READ_INPUT_SIGNALS;
1136 buf[9] = priv->dp_port_num;
1137 buf[10] = DIGI_DISABLE;
1138 buf[11] = 0;
1139
1140 /* disable receive */
1141 buf[12] = DIGI_CMD_RECEIVE_ENABLE;
1142 buf[13] = priv->dp_port_num;
1143 buf[14] = DIGI_DISABLE;
1144 buf[15] = 0;
1145
1146 /* flush fifos */
1147 buf[16] = DIGI_CMD_IFLUSH_FIFO;
1148 buf[17] = priv->dp_port_num;
1149 buf[18] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1150 buf[19] = 0;
1151
1152 ret = digi_write_oob_command(port, buf, 20, 0);
1153 if (ret != 0)
1154 dev_dbg(&port->dev, "digi_close: write oob failed, ret=%d\n",
1155 ret);
1156 /* wait for final commands on oob port to complete */
1157 prepare_to_wait(&priv->dp_flush_wait, &wait,
1158 TASK_INTERRUPTIBLE);
1159 schedule_timeout(DIGI_CLOSE_TIMEOUT);
1160 finish_wait(&priv->dp_flush_wait, &wait);
1161
1162 /* shutdown any outstanding bulk writes */
1163 usb_kill_urb(port->write_urb);
1164exit:
1165 spin_lock_irq(&priv->dp_port_lock);
1166 priv->dp_write_urb_in_use = 0;
1167 wake_up_interruptible(&priv->dp_close_wait);
1168 spin_unlock_irq(&priv->dp_port_lock);
1169 mutex_unlock(&port->serial->disc_mutex);
1170}
1171
1172
1173/*
1174 * Digi Startup Device
1175 *
1176 * Starts reads on all ports. Must be called AFTER startup, with
1177 * urbs initialized. Returns 0 if successful, non-zero error otherwise.
1178 */
1179
1180static int digi_startup_device(struct usb_serial *serial)
1181{
1182 int i, ret = 0;
1183 struct digi_serial *serial_priv = usb_get_serial_data(serial);
1184 struct usb_serial_port *port;
1185
1186 /* be sure this happens exactly once */
1187 spin_lock(&serial_priv->ds_serial_lock);
1188 if (serial_priv->ds_device_started) {
1189 spin_unlock(&serial_priv->ds_serial_lock);
1190 return 0;
1191 }
1192 serial_priv->ds_device_started = 1;
1193 spin_unlock(&serial_priv->ds_serial_lock);
1194
1195 /* start reading from each bulk in endpoint for the device */
1196 /* set USB_DISABLE_SPD flag for write bulk urbs */
1197 for (i = 0; i < serial->type->num_ports + 1; i++) {
1198 port = serial->port[i];
1199 ret = usb_submit_urb(port->read_urb, GFP_KERNEL);
1200 if (ret != 0) {
1201 dev_err(&port->dev,
1202 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
1203 __func__, ret, i);
1204 break;
1205 }
1206 }
1207 return ret;
1208}
1209
1210static int digi_port_init(struct usb_serial_port *port, unsigned port_num)
1211{
1212 struct digi_port *priv;
1213
1214 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1215 if (!priv)
1216 return -ENOMEM;
1217
1218 spin_lock_init(&priv->dp_port_lock);
1219 priv->dp_port_num = port_num;
1220 init_waitqueue_head(&priv->dp_transmit_idle_wait);
1221 init_waitqueue_head(&priv->dp_flush_wait);
1222 init_waitqueue_head(&priv->dp_close_wait);
1223 init_waitqueue_head(&priv->write_wait);
1224 priv->dp_port = port;
1225
1226 usb_set_serial_port_data(port, priv);
1227
1228 return 0;
1229}
1230
1231static int digi_startup(struct usb_serial *serial)
1232{
1233 struct digi_serial *serial_priv;
1234 int ret;
1235
1236 serial_priv = kzalloc(sizeof(*serial_priv), GFP_KERNEL);
1237 if (!serial_priv)
1238 return -ENOMEM;
1239
1240 spin_lock_init(&serial_priv->ds_serial_lock);
1241 serial_priv->ds_oob_port_num = serial->type->num_ports;
1242 serial_priv->ds_oob_port = serial->port[serial_priv->ds_oob_port_num];
1243
1244 ret = digi_port_init(serial_priv->ds_oob_port,
1245 serial_priv->ds_oob_port_num);
1246 if (ret) {
1247 kfree(serial_priv);
1248 return ret;
1249 }
1250
1251 usb_set_serial_data(serial, serial_priv);
1252
1253 return 0;
1254}
1255
1256
1257static void digi_disconnect(struct usb_serial *serial)
1258{
1259 int i;
1260
1261 /* stop reads and writes on all ports */
1262 for (i = 0; i < serial->type->num_ports + 1; i++) {
1263 usb_kill_urb(serial->port[i]->read_urb);
1264 usb_kill_urb(serial->port[i]->write_urb);
1265 }
1266}
1267
1268
1269static void digi_release(struct usb_serial *serial)
1270{
1271 struct digi_serial *serial_priv;
1272 struct digi_port *priv;
1273
1274 serial_priv = usb_get_serial_data(serial);
1275
1276 priv = usb_get_serial_port_data(serial_priv->ds_oob_port);
1277 kfree(priv);
1278
1279 kfree(serial_priv);
1280}
1281
1282static int digi_port_probe(struct usb_serial_port *port)
1283{
1284 return digi_port_init(port, port->port_number);
1285}
1286
1287static void digi_port_remove(struct usb_serial_port *port)
1288{
1289 struct digi_port *priv;
1290
1291 priv = usb_get_serial_port_data(port);
1292 kfree(priv);
1293}
1294
1295static void digi_read_bulk_callback(struct urb *urb)
1296{
1297 struct usb_serial_port *port = urb->context;
1298 struct digi_port *priv;
1299 struct digi_serial *serial_priv;
1300 int ret;
1301 int status = urb->status;
1302
1303 /* port sanity check, do not resubmit if port is not valid */
1304 if (port == NULL)
1305 return;
1306 priv = usb_get_serial_port_data(port);
1307 if (priv == NULL) {
1308 dev_err(&port->dev, "%s: port->private is NULL, status=%d\n",
1309 __func__, status);
1310 return;
1311 }
1312 if (port->serial == NULL ||
1313 (serial_priv = usb_get_serial_data(port->serial)) == NULL) {
1314 dev_err(&port->dev, "%s: serial is bad or serial->private "
1315 "is NULL, status=%d\n", __func__, status);
1316 return;
1317 }
1318
1319 /* do not resubmit urb if it has any status error */
1320 if (status) {
1321 dev_err(&port->dev,
1322 "%s: nonzero read bulk status: status=%d, port=%d\n",
1323 __func__, status, priv->dp_port_num);
1324 return;
1325 }
1326
1327 /* handle oob or inb callback, do not resubmit if error */
1328 if (priv->dp_port_num == serial_priv->ds_oob_port_num) {
1329 if (digi_read_oob_callback(urb) != 0)
1330 return;
1331 } else {
1332 if (digi_read_inb_callback(urb) != 0)
1333 return;
1334 }
1335
1336 /* continue read */
1337 ret = usb_submit_urb(urb, GFP_ATOMIC);
1338 if (ret != 0 && ret != -EPERM) {
1339 dev_err(&port->dev,
1340 "%s: failed resubmitting urb, ret=%d, port=%d\n",
1341 __func__, ret, priv->dp_port_num);
1342 }
1343
1344}
1345
1346/*
1347 * Digi Read INB Callback
1348 *
1349 * Digi Read INB Callback handles reads on the in band ports, sending
1350 * the data on to the tty subsystem. When called we know port and
1351 * port->private are not NULL and port->serial has been validated.
1352 * It returns 0 if successful, 1 if successful but the port is
1353 * throttled, and -1 if the sanity checks failed.
1354 */
1355
1356static int digi_read_inb_callback(struct urb *urb)
1357{
1358 struct usb_serial_port *port = urb->context;
1359 struct digi_port *priv = usb_get_serial_port_data(port);
1360 unsigned char *buf = urb->transfer_buffer;
1361 unsigned long flags;
1362 int opcode;
1363 int len;
1364 int port_status;
1365 unsigned char *data;
1366 int tty_flag, throttled;
1367
1368 /* short/multiple packet check */
1369 if (urb->actual_length < 2) {
1370 dev_warn(&port->dev, "short packet received\n");
1371 return -1;
1372 }
1373
1374 opcode = buf[0];
1375 len = buf[1];
1376
1377 if (urb->actual_length != len + 2) {
1378 dev_err(&port->dev, "malformed packet received: port=%d, opcode=%d, len=%d, actual_length=%u\n",
1379 priv->dp_port_num, opcode, len, urb->actual_length);
1380 return -1;
1381 }
1382
1383 if (opcode == DIGI_CMD_RECEIVE_DATA && len < 1) {
1384 dev_err(&port->dev, "malformed data packet received\n");
1385 return -1;
1386 }
1387
1388 spin_lock_irqsave(&priv->dp_port_lock, flags);
1389
1390 /* check for throttle; if set, do not resubmit read urb */
1391 /* indicate the read chain needs to be restarted on unthrottle */
1392 throttled = priv->dp_throttled;
1393 if (throttled)
1394 priv->dp_throttle_restart = 1;
1395
1396 /* receive data */
1397 if (opcode == DIGI_CMD_RECEIVE_DATA) {
1398 port_status = buf[2];
1399 data = &buf[3];
1400
1401 /* get flag from port_status */
1402 tty_flag = 0;
1403
1404 /* overrun is special, not associated with a char */
1405 if (port_status & DIGI_OVERRUN_ERROR)
1406 tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
1407
1408 /* break takes precedence over parity, */
1409 /* which takes precedence over framing errors */
1410 if (port_status & DIGI_BREAK_ERROR)
1411 tty_flag = TTY_BREAK;
1412 else if (port_status & DIGI_PARITY_ERROR)
1413 tty_flag = TTY_PARITY;
1414 else if (port_status & DIGI_FRAMING_ERROR)
1415 tty_flag = TTY_FRAME;
1416
1417 /* data length is len-1 (one byte of len is port_status) */
1418 --len;
1419 if (len > 0) {
1420 tty_insert_flip_string_fixed_flag(&port->port, data,
1421 tty_flag, len);
1422 tty_flip_buffer_push(&port->port);
1423 }
1424 }
1425 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1426
1427 if (opcode == DIGI_CMD_RECEIVE_DISABLE)
1428 dev_dbg(&port->dev, "%s: got RECEIVE_DISABLE\n", __func__);
1429 else if (opcode != DIGI_CMD_RECEIVE_DATA)
1430 dev_dbg(&port->dev, "%s: unknown opcode: %d\n", __func__, opcode);
1431
1432 return throttled ? 1 : 0;
1433
1434}
1435
1436
1437/*
1438 * Digi Read OOB Callback
1439 *
1440 * Digi Read OOB Callback handles reads on the out of band port.
1441 * When called we know port and port->private are not NULL and
1442 * the port->serial is valid. It returns 0 if successful, and
1443 * -1 if the sanity checks failed.
1444 */
1445
1446static int digi_read_oob_callback(struct urb *urb)
1447{
1448
1449 struct usb_serial_port *port = urb->context;
1450 struct usb_serial *serial = port->serial;
1451 struct tty_struct *tty;
1452 struct digi_port *priv;
1453 unsigned char *buf = urb->transfer_buffer;
1454 int opcode, line, status, val;
1455 unsigned long flags;
1456 int i;
1457 unsigned int rts;
1458
1459 if (urb->actual_length < 4)
1460 return -1;
1461
1462 /* handle each oob command */
1463 for (i = 0; i < urb->actual_length - 3; i += 4) {
1464 opcode = buf[i];
1465 line = buf[i + 1];
1466 status = buf[i + 2];
1467 val = buf[i + 3];
1468
1469 dev_dbg(&port->dev, "digi_read_oob_callback: opcode=%d, line=%d, status=%d, val=%d\n",
1470 opcode, line, status, val);
1471
1472 if (status != 0 || line >= serial->type->num_ports)
1473 continue;
1474
1475 port = serial->port[line];
1476
1477 priv = usb_get_serial_port_data(port);
1478 if (priv == NULL)
1479 return -1;
1480
1481 tty = tty_port_tty_get(&port->port);
1482
1483 rts = 0;
1484 if (tty)
1485 rts = C_CRTSCTS(tty);
1486
1487 if (tty && opcode == DIGI_CMD_READ_INPUT_SIGNALS) {
1488 bool wakeup = false;
1489
1490 spin_lock_irqsave(&priv->dp_port_lock, flags);
1491 /* convert from digi flags to termiox flags */
1492 if (val & DIGI_READ_INPUT_SIGNALS_CTS) {
1493 priv->dp_modem_signals |= TIOCM_CTS;
1494 if (rts)
1495 wakeup = true;
1496 } else {
1497 priv->dp_modem_signals &= ~TIOCM_CTS;
1498 /* port must be open to use tty struct */
1499 }
1500 if (val & DIGI_READ_INPUT_SIGNALS_DSR)
1501 priv->dp_modem_signals |= TIOCM_DSR;
1502 else
1503 priv->dp_modem_signals &= ~TIOCM_DSR;
1504 if (val & DIGI_READ_INPUT_SIGNALS_RI)
1505 priv->dp_modem_signals |= TIOCM_RI;
1506 else
1507 priv->dp_modem_signals &= ~TIOCM_RI;
1508 if (val & DIGI_READ_INPUT_SIGNALS_DCD)
1509 priv->dp_modem_signals |= TIOCM_CD;
1510 else
1511 priv->dp_modem_signals &= ~TIOCM_CD;
1512
1513 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1514
1515 if (wakeup)
1516 tty_port_tty_wakeup(&port->port);
1517 } else if (opcode == DIGI_CMD_TRANSMIT_IDLE) {
1518 spin_lock_irqsave(&priv->dp_port_lock, flags);
1519 priv->dp_transmit_idle = 1;
1520 wake_up_interruptible(&priv->dp_transmit_idle_wait);
1521 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1522 } else if (opcode == DIGI_CMD_IFLUSH_FIFO) {
1523 wake_up_interruptible(&priv->dp_flush_wait);
1524 }
1525 tty_kref_put(tty);
1526 }
1527 return 0;
1528
1529}
1530
1531module_usb_serial_driver(serial_drivers, id_table_combined);
1532
1533MODULE_AUTHOR(DRIVER_AUTHOR);
1534MODULE_DESCRIPTION(DRIVER_DESC);
1535MODULE_LICENSE("GPL");
1/*
2* Digi AccelePort USB-4 and USB-2 Serial Converters
3*
4* Copyright 2000 by Digi International
5*
6* This program is free software; you can redistribute it and/or modify
7* it under the terms of the GNU General Public License as published by
8* the Free Software Foundation; either version 2 of the License, or
9* (at your option) any later version.
10*
11* Shamelessly based on Brian Warner's keyspan_pda.c and Greg Kroah-Hartman's
12* usb-serial driver.
13*
14* Peter Berger (pberger@brimson.com)
15* Al Borchers (borchers@steinerpoint.com)
16*
17* (12/03/2001) gkh
18* switched to using port->port.count instead of private version.
19* Removed port->active
20*
21* (04/08/2001) gb
22* Identify version on module load.
23*
24* (11/01/2000) Adam J. Richter
25* usb_device_id table support
26*
27* (11/01/2000) pberger and borchers
28* -- Turned off the USB_DISABLE_SPD flag for write bulk urbs--it caused
29* USB 4 ports to hang on startup.
30* -- Serialized access to write urbs by adding the dp_write_urb_in_use
31* flag; otherwise, the driver caused SMP system hangs. Watching the
32* urb status is not sufficient.
33*
34* (10/05/2000) gkh
35* -- Fixed bug with urb->dev not being set properly, now that the usb
36* core needs it.
37*
38* (8/8/2000) pberger and borchers
39* -- Fixed close so that
40* - it can timeout while waiting for transmit idle, if needed;
41* - it ignores interrupts when flushing the port, turning
42* of modem signalling, and so on;
43* - it waits for the flush to really complete before returning.
44* -- Read_bulk_callback and write_bulk_callback check for a closed
45* port before using the tty struct or writing to the port.
46* -- The two changes above fix the oops caused by interrupted closes.
47* -- Added interruptible args to write_oob_command and set_modem_signals
48* and added a timeout arg to transmit_idle; needed for fixes to
49* close.
50* -- Added code for rx_throttle and rx_unthrottle so that input flow
51* control works.
52* -- Added code to set overrun, parity, framing, and break errors
53* (untested).
54* -- Set USB_DISABLE_SPD flag for write bulk urbs, so no 0 length
55* bulk writes are done. These hung the Digi USB device. The
56* 0 length bulk writes were a new feature of usb-uhci added in
57* the 2.4.0-test6 kernels.
58* -- Fixed mod inc race in open; do mod inc before sleeping to wait
59* for a close to finish.
60*
61* (7/31/2000) pberger
62* -- Fixed bugs with hardware handshaking:
63* - Added code to set/clear tty->hw_stopped in digi_read_oob_callback()
64* and digi_set_termios()
65* -- Added code in digi_set_termios() to
66* - add conditional in code handling transition from B0 to only
67* set RTS if RTS/CTS flow control is either not in use or if
68* the port is not currently throttled.
69* - handle turning off CRTSCTS.
70*
71* (7/30/2000) borchers
72* -- Added support for more than one Digi USB device by moving
73* globals to a private structure in the pointed to from the
74* usb_serial structure.
75* -- Moved the modem change and transmit idle wait queues into
76* the port private structure, so each port has its own queue
77* rather than sharing global queues.
78* -- Added support for break signals.
79*
80* (7/25/2000) pberger
81* -- Added USB-2 support. Note: the USB-2 supports 3 devices: two
82* serial and a parallel port. The parallel port is implemented
83* as a serial-to-parallel converter. That is, the driver actually
84* presents all three USB-2 interfaces as serial ports, but the third
85* one physically connects to a parallel device. Thus, for example,
86* one could plug a parallel printer into the USB-2's third port,
87* but from the kernel's (and userland's) point of view what's
88* actually out there is a serial device.
89*
90* (7/15/2000) borchers
91* -- Fixed race in open when a close is in progress.
92* -- Keep count of opens and dec the module use count for each
93* outstanding open when shutdown is called (on disconnect).
94* -- Fixed sanity checks in read_bulk_callback and write_bulk_callback
95* so pointers are checked before use.
96* -- Split read bulk callback into in band and out of band
97* callbacks, and no longer restart read chains if there is
98* a status error or a sanity error. This fixed the seg
99* faults and other errors we used to get on disconnect.
100* -- Port->active is once again a flag as usb-serial intended it
101* to be, not a count. Since it was only a char it would
102* have been limited to 256 simultaneous opens. Now the open
103* count is kept in the port private structure in dp_open_count.
104* -- Added code for modularization of the digi_acceleport driver.
105*
106* (6/27/2000) pberger and borchers
107* -- Zeroed out sync field in the wakeup_task before first use;
108* otherwise the uninitialized value might prevent the task from
109* being scheduled.
110* -- Initialized ret value to 0 in write_bulk_callback, otherwise
111* the uninitialized value could cause a spurious debugging message.
112*
113* (6/22/2000) pberger and borchers
114* -- Made cond_wait_... inline--apparently on SPARC the flags arg
115* to spin_lock_irqsave cannot be passed to another function
116* to call spin_unlock_irqrestore. Thanks to Pauline Middelink.
117* -- In digi_set_modem_signals the inner nested spin locks use just
118* spin_lock() rather than spin_lock_irqsave(). The old code
119* mistakenly left interrupts off. Thanks to Pauline Middelink.
120* -- copy_from_user (which can sleep) is no longer called while a
121* spinlock is held. We copy to a local buffer before getting
122* the spinlock--don't like the extra copy but the code is simpler.
123* -- Printk and dbg are no longer called while a spin lock is held.
124*
125* (6/4/2000) pberger and borchers
126* -- Replaced separate calls to spin_unlock_irqrestore and
127* interruptible_sleep_on_timeout with a new function
128* cond_wait_interruptible_timeout_irqrestore. This eliminates
129* the race condition where the wake up could happen after
130* the unlock and before the sleep.
131* -- Close now waits for output to drain.
132* -- Open waits until any close in progress is finished.
133* -- All out of band responses are now processed, not just the
134* first in a USB packet.
135* -- Fixed a bug that prevented the driver from working when the
136* first Digi port was not the first USB serial port--the driver
137* was mistakenly using the external USB serial port number to
138* try to index into its internal ports.
139* -- Fixed an SMP bug -- write_bulk_callback is called directly from
140* an interrupt, so spin_lock_irqsave/spin_unlock_irqrestore are
141* needed for locks outside write_bulk_callback that are also
142* acquired by write_bulk_callback to prevent deadlocks.
143* -- Fixed support for select() by making digi_chars_in_buffer()
144* return 256 when -EINPROGRESS is set, as the line discipline
145* code in n_tty.c expects.
146* -- Fixed an include file ordering problem that prevented debugging
147* messages from working.
148* -- Fixed an intermittent timeout problem that caused writes to
149* sometimes get stuck on some machines on some kernels. It turns
150* out in these circumstances write_chan() (in n_tty.c) was
151* asleep waiting for our wakeup call. Even though we call
152* wake_up_interruptible() in digi_write_bulk_callback(), there is
153* a race condition that could cause the wakeup to fail: if our
154* wake_up_interruptible() call occurs between the time that our
155* driver write routine finishes and write_chan() sets current->state
156* to TASK_INTERRUPTIBLE, the effect of our wakeup setting the state
157* to TASK_RUNNING will be lost and write_chan's subsequent call to
158* schedule() will never return (unless it catches a signal).
159* This race condition occurs because write_bulk_callback() (and thus
160* the wakeup) are called 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.
167*
168* NOTE: The problem also goes away if you comment out
169* the two code lines in write_chan() where current->state
170* is set to TASK_RUNNING just before calling driver.write() and to
171* TASK_INTERRUPTIBLE immediately afterwards. This is why the
172* problem did not show up with the 2.2 kernels -- they do not
173* include that code.
174*
175* (5/16/2000) pberger and borchers
176* -- Added timeouts to sleeps, to defend against lost wake ups.
177* -- Handle transition to/from B0 baud rate in digi_set_termios.
178*
179* (5/13/2000) pberger and borchers
180* -- All commands now sent on out of band port, using
181* digi_write_oob_command.
182* -- Get modem control signals whenever they change, support TIOCMGET/
183* SET/BIS/BIC ioctls.
184* -- digi_set_termios now supports parity, word size, stop bits, and
185* receive enable.
186* -- Cleaned up open and close, use digi_set_termios and
187* digi_write_oob_command to set port parameters.
188* -- Added digi_startup_device to start read chains on all ports.
189* -- Write buffer is only used when count==1, to be sure put_char can
190* write a char (unless the buffer is full).
191*
192* (5/10/2000) pberger and borchers
193* -- Added MOD_INC_USE_COUNT/MOD_DEC_USE_COUNT calls on open/close.
194* -- Fixed problem where the first incoming character is lost on
195* port opens after the first close on that port. Now we keep
196* the read_urb chain open until shutdown.
197* -- Added more port conditioning calls in digi_open and digi_close.
198* -- Convert port->active to a use count so that we can deal with multiple
199* opens and closes properly.
200* -- Fixed some problems with the locking code.
201*
202* (5/3/2000) pberger and borchers
203* -- First alpha version of the driver--many known limitations and bugs.
204*
205*
206* Locking and SMP
207*
208* - Each port, including the out-of-band port, has a lock used to
209* serialize all access to the port's private structure.
210* - The port lock is also used to serialize all writes and access to
211* the port's URB.
212* - The port lock is also used for the port write_wait condition
213* variable. Holding the port lock will prevent a wake up on the
214* port's write_wait; this can be used with cond_wait_... to be sure
215* the wake up is not lost in a race when dropping the lock and
216* sleeping waiting for the wakeup.
217* - digi_write() does not sleep, since it is sometimes called on
218* interrupt time.
219* - digi_write_bulk_callback() and digi_read_bulk_callback() are
220* called directly from interrupts. Hence spin_lock_irqsave()
221* and spin_unlock_irqrestore() are used in the rest of the code
222* for any locks they acquire.
223* - digi_write_bulk_callback() gets the port lock before waking up
224* processes sleeping on the port write_wait. It also schedules
225* wake ups so they happen from the scheduler, because the tty
226* system can miss wake ups from interrupts.
227* - All sleeps use a timeout of DIGI_RETRY_TIMEOUT before looping to
228* recheck the condition they are sleeping on. This is defensive,
229* in case a wake up is lost.
230* - Following Documentation/DocBook/kernel-locking.pdf no spin locks
231* are held when calling copy_to/from_user or printk.
232*/
233
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 <linux/uaccess.h>
245#include <linux/usb.h>
246#include <linux/wait.h>
247#include <linux/usb/serial.h>
248
249/* Defines */
250
251/*
252 * Version Information
253 */
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"
257
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
261
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
265
266/* retry timeout while sleeping */
267#define DIGI_RETRY_TIMEOUT (HZ/10)
268
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)
273
274
275/* AccelePort USB Defines */
276
277/* ids */
278#define DIGI_VENDOR_ID 0x05c5
279#define DIGI_2_ID 0x0002 /* USB-2 */
280#define DIGI_4_ID 0x0004 /* USB-4 */
281
282/* commands
283 * "INB": can be used on the in-band endpoint
284 * "OOB": can be used on the out-of-band endpoint
285 */
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 */
308
309/* baud rates */
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
333
334/* arguments */
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
339
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
345
346#define DIGI_STOP_BITS_1 0
347#define DIGI_STOP_BITS_2 1
348
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
352
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
356
357#define DIGI_DTR_INACTIVE 0
358#define DIGI_DTR_ACTIVE 1
359#define DIGI_DTR_INPUT_FLOW_CONTROL 2
360
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
365
366#define DIGI_FLUSH_TX 1
367#define DIGI_FLUSH_RX 2
368#define DIGI_RESUME_TX 4 /* clears xoff condition */
369
370#define DIGI_TRANSMIT_NOT_IDLE 0
371#define DIGI_TRANSMIT_IDLE 1
372
373#define DIGI_DISABLE 0
374#define DIGI_ENABLE 1
375
376#define DIGI_DEASSERT 0
377#define DIGI_ASSERT 1
378
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
384
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
391
392/* input signals */
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
401
402
403/* Structures */
404
405struct digi_serial {
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;
410};
411
412struct digi_port {
413 spinlock_t dp_port_lock;
414 int dp_port_num;
415 int dp_out_buf_len;
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;
422 int dp_throttled;
423 int dp_throttle_restart;
424 wait_queue_head_t dp_flush_wait;
425 wait_queue_head_t dp_close_wait; /* wait queue for close */
426 struct work_struct dp_wakeup_work;
427 struct usb_serial_port *dp_port;
428};
429
430
431/* Local Function Declarations */
432
433static void digi_wakeup_write(struct usb_serial_port *port);
434static void digi_wakeup_write_lock(struct work_struct *work);
435static int digi_write_oob_command(struct usb_serial_port *port,
436 unsigned char *buf, int count, int interruptible);
437static int digi_write_inb_command(struct usb_serial_port *port,
438 unsigned char *buf, int count, unsigned long timeout);
439static int digi_set_modem_signals(struct usb_serial_port *port,
440 unsigned int modem_signals, int interruptible);
441static int digi_transmit_idle(struct usb_serial_port *port,
442 unsigned long timeout);
443static void digi_rx_throttle(struct tty_struct *tty);
444static void digi_rx_unthrottle(struct tty_struct *tty);
445static void digi_set_termios(struct tty_struct *tty,
446 struct usb_serial_port *port, struct ktermios *old_termios);
447static void digi_break_ctl(struct tty_struct *tty, int break_state);
448static int digi_tiocmget(struct tty_struct *tty);
449static int digi_tiocmset(struct tty_struct *tty, unsigned int set,
450 unsigned int clear);
451static int digi_write(struct tty_struct *tty, struct usb_serial_port *port,
452 const unsigned char *buf, int count);
453static void digi_write_bulk_callback(struct urb *urb);
454static int digi_write_room(struct tty_struct *tty);
455static int digi_chars_in_buffer(struct tty_struct *tty);
456static int digi_open(struct tty_struct *tty, struct usb_serial_port *port);
457static void digi_close(struct usb_serial_port *port);
458static void digi_dtr_rts(struct usb_serial_port *port, int on);
459static int digi_startup_device(struct usb_serial *serial);
460static int digi_startup(struct usb_serial *serial);
461static void digi_disconnect(struct usb_serial *serial);
462static void digi_release(struct usb_serial *serial);
463static void digi_read_bulk_callback(struct urb *urb);
464static int digi_read_inb_callback(struct urb *urb);
465static int digi_read_oob_callback(struct urb *urb);
466
467
468/* Statics */
469
470static int debug;
471
472static const 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 */
476};
477
478static const struct usb_device_id id_table_2[] = {
479 { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
480 { } /* Terminating entry */
481};
482
483static const struct usb_device_id id_table_4[] = {
484 { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
485 { } /* Terminating entry */
486};
487
488MODULE_DEVICE_TABLE(usb, id_table_combined);
489
490static 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,
495 .no_dynamic_id = 1,
496};
497
498
499/* device info needed for the Digi serial converter */
500
501static struct usb_serial_driver digi_acceleport_2_device = {
502 .driver = {
503 .owner = THIS_MODULE,
504 .name = "digi_2",
505 },
506 .description = "Digi 2 port USB adapter",
507 .usb_driver = &digi_driver,
508 .id_table = id_table_2,
509 .num_ports = 3,
510 .open = digi_open,
511 .close = digi_close,
512 .dtr_rts = digi_dtr_rts,
513 .write = digi_write,
514 .write_room = digi_write_room,
515 .write_bulk_callback = digi_write_bulk_callback,
516 .read_bulk_callback = digi_read_bulk_callback,
517 .chars_in_buffer = digi_chars_in_buffer,
518 .throttle = digi_rx_throttle,
519 .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 .disconnect = digi_disconnect,
526 .release = digi_release,
527};
528
529static struct usb_serial_driver digi_acceleport_4_device = {
530 .driver = {
531 .owner = THIS_MODULE,
532 .name = "digi_4",
533 },
534 .description = "Digi 4 port USB adapter",
535 .usb_driver = &digi_driver,
536 .id_table = id_table_4,
537 .num_ports = 4,
538 .open = digi_open,
539 .close = digi_close,
540 .write = digi_write,
541 .write_room = digi_write_room,
542 .write_bulk_callback = digi_write_bulk_callback,
543 .read_bulk_callback = digi_read_bulk_callback,
544 .chars_in_buffer = digi_chars_in_buffer,
545 .throttle = digi_rx_throttle,
546 .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 .disconnect = digi_disconnect,
553 .release = digi_release,
554};
555
556
557/* Functions */
558
559/*
560 * Cond Wait Interruptible Timeout Irqrestore
561 *
562 * Do spin_unlock_irqrestore and interruptible_sleep_on_timeout
563 * so that wake ups are not lost if they occur between the unlock
564 * and the sleep. In other words, spin_unlock_irqrestore and
565 * interruptible_sleep_on_timeout are "atomic" with respect to
566 * wake ups. This is used to implement condition variables.
567 *
568 * interruptible_sleep_on_timeout is deprecated and has been replaced
569 * with the equivalent code.
570 */
571
572static long cond_wait_interruptible_timeout_irqrestore(
573 wait_queue_head_t *q, long timeout,
574 spinlock_t *lock, unsigned long flags)
575__releases(lock)
576{
577 DEFINE_WAIT(wait);
578
579 prepare_to_wait(q, &wait, TASK_INTERRUPTIBLE);
580 spin_unlock_irqrestore(lock, flags);
581 timeout = schedule_timeout(timeout);
582 finish_wait(q, &wait);
583
584 return timeout;
585}
586
587
588/*
589 * Digi Wakeup Write
590 *
591 * Wake up port, line discipline, and tty processes sleeping
592 * on writes.
593 */
594
595static void digi_wakeup_write_lock(struct work_struct *work)
596{
597 struct digi_port *priv =
598 container_of(work, struct digi_port, dp_wakeup_work);
599 struct usb_serial_port *port = priv->dp_port;
600 unsigned long flags;
601
602 spin_lock_irqsave(&priv->dp_port_lock, flags);
603 digi_wakeup_write(port);
604 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
605}
606
607static void digi_wakeup_write(struct usb_serial_port *port)
608{
609 struct tty_struct *tty = tty_port_tty_get(&port->port);
610 if (tty) {
611 tty_wakeup(tty);
612 tty_kref_put(tty);
613 }
614}
615
616
617/*
618 * Digi Write OOB Command
619 *
620 * Write commands on the out of band port. Commands are 4
621 * bytes each, multiple commands can be sent at once, and
622 * no command will be split across USB packets. Returns 0
623 * if successful, -EINTR if interrupted while sleeping and
624 * the interruptible flag is true, or a negative error
625 * returned by usb_submit_urb.
626 */
627
628static int digi_write_oob_command(struct usb_serial_port *port,
629 unsigned char *buf, int count, int interruptible)
630{
631
632 int ret = 0;
633 int len;
634 struct usb_serial_port *oob_port = (struct usb_serial_port *)((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
635 struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
636 unsigned long flags = 0;
637
638 dbg("digi_write_oob_command: TOP: port=%d, count=%d", oob_priv->dp_port_num, count);
639
640 spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
641 while (count > 0) {
642 while (oob_priv->dp_write_urb_in_use) {
643 cond_wait_interruptible_timeout_irqrestore(
644 &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
645 &oob_priv->dp_port_lock, flags);
646 if (interruptible && signal_pending(current))
647 return -EINTR;
648 spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
649 }
650
651 /* len must be a multiple of 4, so commands are not split */
652 len = min(count, oob_port->bulk_out_size);
653 if (len > 4)
654 len &= ~3;
655 memcpy(oob_port->write_urb->transfer_buffer, buf, len);
656 oob_port->write_urb->transfer_buffer_length = len;
657 oob_port->write_urb->dev = port->serial->dev;
658 ret = usb_submit_urb(oob_port->write_urb, GFP_ATOMIC);
659 if (ret == 0) {
660 oob_priv->dp_write_urb_in_use = 1;
661 count -= len;
662 buf += len;
663 }
664 }
665 spin_unlock_irqrestore(&oob_priv->dp_port_lock, flags);
666 if (ret)
667 dev_err(&port->dev, "%s: usb_submit_urb failed, ret=%d\n",
668 __func__, ret);
669 return ret;
670
671}
672
673
674/*
675 * Digi Write In Band Command
676 *
677 * Write commands on the given port. Commands are 4
678 * bytes each, multiple commands can be sent at once, and
679 * no command will be split across USB packets. If timeout
680 * is non-zero, write in band command will return after
681 * waiting unsuccessfully for the URB status to clear for
682 * timeout ticks. Returns 0 if successful, or a negative
683 * error returned by digi_write.
684 */
685
686static int digi_write_inb_command(struct usb_serial_port *port,
687 unsigned char *buf, int count, unsigned long timeout)
688{
689 int ret = 0;
690 int len;
691 struct digi_port *priv = usb_get_serial_port_data(port);
692 unsigned char *data = port->write_urb->transfer_buffer;
693 unsigned long flags = 0;
694
695 dbg("digi_write_inb_command: TOP: port=%d, count=%d",
696 priv->dp_port_num, count);
697
698 if (timeout)
699 timeout += jiffies;
700 else
701 timeout = ULONG_MAX;
702
703 spin_lock_irqsave(&priv->dp_port_lock, flags);
704 while (count > 0 && ret == 0) {
705 while (priv->dp_write_urb_in_use &&
706 time_before(jiffies, timeout)) {
707 cond_wait_interruptible_timeout_irqrestore(
708 &port->write_wait, DIGI_RETRY_TIMEOUT,
709 &priv->dp_port_lock, flags);
710 if (signal_pending(current))
711 return -EINTR;
712 spin_lock_irqsave(&priv->dp_port_lock, flags);
713 }
714
715 /* len must be a multiple of 4 and small enough to */
716 /* guarantee the write will send buffered data first, */
717 /* so commands are in order with data and not split */
718 len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
719 if (len > 4)
720 len &= ~3;
721
722 /* write any buffered data first */
723 if (priv->dp_out_buf_len > 0) {
724 data[0] = DIGI_CMD_SEND_DATA;
725 data[1] = priv->dp_out_buf_len;
726 memcpy(data + 2, priv->dp_out_buf,
727 priv->dp_out_buf_len);
728 memcpy(data + 2 + priv->dp_out_buf_len, buf, len);
729 port->write_urb->transfer_buffer_length
730 = priv->dp_out_buf_len + 2 + len;
731 } else {
732 memcpy(data, buf, len);
733 port->write_urb->transfer_buffer_length = len;
734 }
735 port->write_urb->dev = port->serial->dev;
736
737 ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
738 if (ret == 0) {
739 priv->dp_write_urb_in_use = 1;
740 priv->dp_out_buf_len = 0;
741 count -= len;
742 buf += len;
743 }
744
745 }
746 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
747
748 if (ret)
749 dev_err(&port->dev,
750 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
751 __func__, ret, priv->dp_port_num);
752 return ret;
753}
754
755
756/*
757 * Digi Set Modem Signals
758 *
759 * Sets or clears DTR and RTS on the port, according to the
760 * modem_signals argument. Use TIOCM_DTR and TIOCM_RTS flags
761 * for the modem_signals argument. Returns 0 if successful,
762 * -EINTR if interrupted while sleeping, or a non-zero error
763 * returned by usb_submit_urb.
764 */
765
766static int digi_set_modem_signals(struct usb_serial_port *port,
767 unsigned int modem_signals, int interruptible)
768{
769
770 int ret;
771 struct digi_port *port_priv = usb_get_serial_port_data(port);
772 struct usb_serial_port *oob_port = (struct usb_serial_port *) ((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
773 struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
774 unsigned char *data = oob_port->write_urb->transfer_buffer;
775 unsigned long flags = 0;
776
777
778 dbg("digi_set_modem_signals: TOP: port=%d, modem_signals=0x%x",
779 port_priv->dp_port_num, modem_signals);
780
781 spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
782 spin_lock(&port_priv->dp_port_lock);
783
784 while (oob_priv->dp_write_urb_in_use) {
785 spin_unlock(&port_priv->dp_port_lock);
786 cond_wait_interruptible_timeout_irqrestore(
787 &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
788 &oob_priv->dp_port_lock, flags);
789 if (interruptible && signal_pending(current))
790 return -EINTR;
791 spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
792 spin_lock(&port_priv->dp_port_lock);
793 }
794 data[0] = DIGI_CMD_SET_DTR_SIGNAL;
795 data[1] = port_priv->dp_port_num;
796 data[2] = (modem_signals & TIOCM_DTR) ?
797 DIGI_DTR_ACTIVE : DIGI_DTR_INACTIVE;
798 data[3] = 0;
799 data[4] = DIGI_CMD_SET_RTS_SIGNAL;
800 data[5] = port_priv->dp_port_num;
801 data[6] = (modem_signals & TIOCM_RTS) ?
802 DIGI_RTS_ACTIVE : DIGI_RTS_INACTIVE;
803 data[7] = 0;
804
805 oob_port->write_urb->transfer_buffer_length = 8;
806 oob_port->write_urb->dev = port->serial->dev;
807
808 ret = usb_submit_urb(oob_port->write_urb, GFP_ATOMIC);
809 if (ret == 0) {
810 oob_priv->dp_write_urb_in_use = 1;
811 port_priv->dp_modem_signals =
812 (port_priv->dp_modem_signals&~(TIOCM_DTR|TIOCM_RTS))
813 | (modem_signals&(TIOCM_DTR|TIOCM_RTS));
814 }
815 spin_unlock(&port_priv->dp_port_lock);
816 spin_unlock_irqrestore(&oob_priv->dp_port_lock, flags);
817 if (ret)
818 dev_err(&port->dev, "%s: usb_submit_urb failed, ret=%d\n",
819 __func__, ret);
820 return ret;
821}
822
823/*
824 * Digi Transmit Idle
825 *
826 * Digi transmit idle waits, up to timeout ticks, for the transmitter
827 * to go idle. It returns 0 if successful or a negative error.
828 *
829 * There are race conditions here if more than one process is calling
830 * digi_transmit_idle on the same port at the same time. However, this
831 * is only called from close, and only one process can be in close on a
832 * port at a time, so its ok.
833 */
834
835static int digi_transmit_idle(struct usb_serial_port *port,
836 unsigned long timeout)
837{
838 int ret;
839 unsigned char buf[2];
840 struct digi_port *priv = usb_get_serial_port_data(port);
841 unsigned long flags = 0;
842
843 spin_lock_irqsave(&priv->dp_port_lock, flags);
844 priv->dp_transmit_idle = 0;
845 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
846
847 buf[0] = DIGI_CMD_TRANSMIT_IDLE;
848 buf[1] = 0;
849
850 timeout += jiffies;
851
852 ret = digi_write_inb_command(port, buf, 2, timeout - jiffies);
853 if (ret != 0)
854 return ret;
855
856 spin_lock_irqsave(&priv->dp_port_lock, flags);
857
858 while (time_before(jiffies, timeout) && !priv->dp_transmit_idle) {
859 cond_wait_interruptible_timeout_irqrestore(
860 &priv->dp_transmit_idle_wait, DIGI_RETRY_TIMEOUT,
861 &priv->dp_port_lock, flags);
862 if (signal_pending(current))
863 return -EINTR;
864 spin_lock_irqsave(&priv->dp_port_lock, flags);
865 }
866 priv->dp_transmit_idle = 0;
867 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
868 return 0;
869
870}
871
872
873static void digi_rx_throttle(struct tty_struct *tty)
874{
875 unsigned long flags;
876 struct usb_serial_port *port = tty->driver_data;
877 struct digi_port *priv = usb_get_serial_port_data(port);
878
879
880 dbg("digi_rx_throttle: TOP: port=%d", priv->dp_port_num);
881
882 /* stop receiving characters by not resubmitting the read urb */
883 spin_lock_irqsave(&priv->dp_port_lock, flags);
884 priv->dp_throttled = 1;
885 priv->dp_throttle_restart = 0;
886 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
887}
888
889
890static void digi_rx_unthrottle(struct tty_struct *tty)
891{
892 int ret = 0;
893 unsigned long flags;
894 struct usb_serial_port *port = tty->driver_data;
895 struct digi_port *priv = usb_get_serial_port_data(port);
896
897 dbg("digi_rx_unthrottle: TOP: port=%d", priv->dp_port_num);
898
899 spin_lock_irqsave(&priv->dp_port_lock, flags);
900
901 /* restart read chain */
902 if (priv->dp_throttle_restart) {
903 port->read_urb->dev = port->serial->dev;
904 ret = usb_submit_urb(port->read_urb, GFP_ATOMIC);
905 }
906
907 /* turn throttle off */
908 priv->dp_throttled = 0;
909 priv->dp_throttle_restart = 0;
910
911 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
912
913 if (ret)
914 dev_err(&port->dev,
915 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
916 __func__, ret, priv->dp_port_num);
917}
918
919
920static void digi_set_termios(struct tty_struct *tty,
921 struct usb_serial_port *port, struct ktermios *old_termios)
922{
923 struct digi_port *priv = usb_get_serial_port_data(port);
924 unsigned int iflag = tty->termios->c_iflag;
925 unsigned int cflag = tty->termios->c_cflag;
926 unsigned int old_iflag = old_termios->c_iflag;
927 unsigned int old_cflag = old_termios->c_cflag;
928 unsigned char buf[32];
929 unsigned int modem_signals;
930 int arg, ret;
931 int i = 0;
932 speed_t baud;
933
934 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);
935
936 /* set baud rate */
937 baud = tty_get_baud_rate(tty);
938 if (baud != tty_termios_baud_rate(old_termios)) {
939 arg = -1;
940
941 /* reassert DTR and (maybe) RTS on transition from B0 */
942 if ((old_cflag&CBAUD) == B0) {
943 /* don't set RTS if using hardware flow control */
944 /* and throttling input */
945 modem_signals = TIOCM_DTR;
946 if (!(tty->termios->c_cflag & CRTSCTS) ||
947 !test_bit(TTY_THROTTLED, &tty->flags))
948 modem_signals |= TIOCM_RTS;
949 digi_set_modem_signals(port, modem_signals, 1);
950 }
951 switch (baud) {
952 /* drop DTR and RTS on transition to B0 */
953 case 0: digi_set_modem_signals(port, 0, 1); break;
954 case 50: arg = DIGI_BAUD_50; break;
955 case 75: arg = DIGI_BAUD_75; break;
956 case 110: arg = DIGI_BAUD_110; break;
957 case 150: arg = DIGI_BAUD_150; break;
958 case 200: arg = DIGI_BAUD_200; break;
959 case 300: arg = DIGI_BAUD_300; break;
960 case 600: arg = DIGI_BAUD_600; break;
961 case 1200: arg = DIGI_BAUD_1200; break;
962 case 1800: arg = DIGI_BAUD_1800; break;
963 case 2400: arg = DIGI_BAUD_2400; break;
964 case 4800: arg = DIGI_BAUD_4800; break;
965 case 9600: arg = DIGI_BAUD_9600; break;
966 case 19200: arg = DIGI_BAUD_19200; break;
967 case 38400: arg = DIGI_BAUD_38400; break;
968 case 57600: arg = DIGI_BAUD_57600; break;
969 case 115200: arg = DIGI_BAUD_115200; break;
970 case 230400: arg = DIGI_BAUD_230400; break;
971 case 460800: arg = DIGI_BAUD_460800; break;
972 default:
973 arg = DIGI_BAUD_9600;
974 baud = 9600;
975 break;
976 }
977 if (arg != -1) {
978 buf[i++] = DIGI_CMD_SET_BAUD_RATE;
979 buf[i++] = priv->dp_port_num;
980 buf[i++] = arg;
981 buf[i++] = 0;
982 }
983 }
984 /* set parity */
985 tty->termios->c_cflag &= ~CMSPAR;
986
987 if ((cflag&(PARENB|PARODD)) != (old_cflag&(PARENB|PARODD))) {
988 if (cflag&PARENB) {
989 if (cflag&PARODD)
990 arg = DIGI_PARITY_ODD;
991 else
992 arg = DIGI_PARITY_EVEN;
993 } else {
994 arg = DIGI_PARITY_NONE;
995 }
996 buf[i++] = DIGI_CMD_SET_PARITY;
997 buf[i++] = priv->dp_port_num;
998 buf[i++] = arg;
999 buf[i++] = 0;
1000 }
1001 /* set word size */
1002 if ((cflag&CSIZE) != (old_cflag&CSIZE)) {
1003 arg = -1;
1004 switch (cflag&CSIZE) {
1005 case CS5: arg = DIGI_WORD_SIZE_5; break;
1006 case CS6: arg = DIGI_WORD_SIZE_6; break;
1007 case CS7: arg = DIGI_WORD_SIZE_7; break;
1008 case CS8: arg = DIGI_WORD_SIZE_8; break;
1009 default:
1010 dbg("digi_set_termios: can't handle word size %d",
1011 (cflag&CSIZE));
1012 break;
1013 }
1014
1015 if (arg != -1) {
1016 buf[i++] = DIGI_CMD_SET_WORD_SIZE;
1017 buf[i++] = priv->dp_port_num;
1018 buf[i++] = arg;
1019 buf[i++] = 0;
1020 }
1021
1022 }
1023
1024 /* set stop bits */
1025 if ((cflag&CSTOPB) != (old_cflag&CSTOPB)) {
1026
1027 if ((cflag&CSTOPB))
1028 arg = DIGI_STOP_BITS_2;
1029 else
1030 arg = DIGI_STOP_BITS_1;
1031
1032 buf[i++] = DIGI_CMD_SET_STOP_BITS;
1033 buf[i++] = priv->dp_port_num;
1034 buf[i++] = arg;
1035 buf[i++] = 0;
1036
1037 }
1038
1039 /* set input flow control */
1040 if ((iflag&IXOFF) != (old_iflag&IXOFF)
1041 || (cflag&CRTSCTS) != (old_cflag&CRTSCTS)) {
1042 arg = 0;
1043 if (iflag&IXOFF)
1044 arg |= DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
1045 else
1046 arg &= ~DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
1047
1048 if (cflag&CRTSCTS) {
1049 arg |= DIGI_INPUT_FLOW_CONTROL_RTS;
1050
1051 /* On USB-4 it is necessary to assert RTS prior */
1052 /* to selecting RTS input flow control. */
1053 buf[i++] = DIGI_CMD_SET_RTS_SIGNAL;
1054 buf[i++] = priv->dp_port_num;
1055 buf[i++] = DIGI_RTS_ACTIVE;
1056 buf[i++] = 0;
1057
1058 } else {
1059 arg &= ~DIGI_INPUT_FLOW_CONTROL_RTS;
1060 }
1061 buf[i++] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1062 buf[i++] = priv->dp_port_num;
1063 buf[i++] = arg;
1064 buf[i++] = 0;
1065 }
1066
1067 /* set output flow control */
1068 if ((iflag & IXON) != (old_iflag & IXON)
1069 || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
1070 arg = 0;
1071 if (iflag & IXON)
1072 arg |= DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
1073 else
1074 arg &= ~DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
1075
1076 if (cflag & CRTSCTS) {
1077 arg |= DIGI_OUTPUT_FLOW_CONTROL_CTS;
1078 } else {
1079 arg &= ~DIGI_OUTPUT_FLOW_CONTROL_CTS;
1080 tty->hw_stopped = 0;
1081 }
1082
1083 buf[i++] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1084 buf[i++] = priv->dp_port_num;
1085 buf[i++] = arg;
1086 buf[i++] = 0;
1087 }
1088
1089 /* set receive enable/disable */
1090 if ((cflag & CREAD) != (old_cflag & CREAD)) {
1091 if (cflag & CREAD)
1092 arg = DIGI_ENABLE;
1093 else
1094 arg = DIGI_DISABLE;
1095
1096 buf[i++] = DIGI_CMD_RECEIVE_ENABLE;
1097 buf[i++] = priv->dp_port_num;
1098 buf[i++] = arg;
1099 buf[i++] = 0;
1100 }
1101 ret = digi_write_oob_command(port, buf, i, 1);
1102 if (ret != 0)
1103 dbg("digi_set_termios: write oob failed, ret=%d", ret);
1104 tty_encode_baud_rate(tty, baud, baud);
1105}
1106
1107
1108static void digi_break_ctl(struct tty_struct *tty, int break_state)
1109{
1110 struct usb_serial_port *port = tty->driver_data;
1111 unsigned char buf[4];
1112
1113 buf[0] = DIGI_CMD_BREAK_CONTROL;
1114 buf[1] = 2; /* length */
1115 buf[2] = break_state ? 1 : 0;
1116 buf[3] = 0; /* pad */
1117 digi_write_inb_command(port, buf, 4, 0);
1118}
1119
1120
1121static int digi_tiocmget(struct tty_struct *tty)
1122{
1123 struct usb_serial_port *port = tty->driver_data;
1124 struct digi_port *priv = usb_get_serial_port_data(port);
1125 unsigned int val;
1126 unsigned long flags;
1127
1128 dbg("%s: TOP: port=%d", __func__, priv->dp_port_num);
1129
1130 spin_lock_irqsave(&priv->dp_port_lock, flags);
1131 val = priv->dp_modem_signals;
1132 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1133 return val;
1134}
1135
1136
1137static int digi_tiocmset(struct tty_struct *tty,
1138 unsigned int set, unsigned int clear)
1139{
1140 struct usb_serial_port *port = tty->driver_data;
1141 struct digi_port *priv = usb_get_serial_port_data(port);
1142 unsigned int val;
1143 unsigned long flags;
1144
1145 dbg("%s: TOP: port=%d", __func__, priv->dp_port_num);
1146
1147 spin_lock_irqsave(&priv->dp_port_lock, flags);
1148 val = (priv->dp_modem_signals & ~clear) | set;
1149 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1150 return digi_set_modem_signals(port, val, 1);
1151}
1152
1153
1154static int digi_write(struct tty_struct *tty, struct usb_serial_port *port,
1155 const unsigned char *buf, int count)
1156{
1157
1158 int ret, data_len, new_len;
1159 struct digi_port *priv = usb_get_serial_port_data(port);
1160 unsigned char *data = port->write_urb->transfer_buffer;
1161 unsigned long flags = 0;
1162
1163 dbg("digi_write: TOP: port=%d, count=%d, in_interrupt=%ld",
1164 priv->dp_port_num, count, in_interrupt());
1165
1166 /* copy user data (which can sleep) before getting spin lock */
1167 count = min(count, port->bulk_out_size-2);
1168 count = min(64, count);
1169
1170 /* be sure only one write proceeds at a time */
1171 /* there are races on the port private buffer */
1172 spin_lock_irqsave(&priv->dp_port_lock, flags);
1173
1174 /* wait for urb status clear to submit another urb */
1175 if (priv->dp_write_urb_in_use) {
1176 /* buffer data if count is 1 (probably put_char) if possible */
1177 if (count == 1 && priv->dp_out_buf_len < DIGI_OUT_BUF_SIZE) {
1178 priv->dp_out_buf[priv->dp_out_buf_len++] = *buf;
1179 new_len = 1;
1180 } else {
1181 new_len = 0;
1182 }
1183 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1184 return new_len;
1185 }
1186
1187 /* allow space for any buffered data and for new data, up to */
1188 /* transfer buffer size - 2 (for command and length bytes) */
1189 new_len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
1190 data_len = new_len + priv->dp_out_buf_len;
1191
1192 if (data_len == 0) {
1193 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1194 return 0;
1195 }
1196
1197 port->write_urb->transfer_buffer_length = data_len+2;
1198 port->write_urb->dev = port->serial->dev;
1199
1200 *data++ = DIGI_CMD_SEND_DATA;
1201 *data++ = data_len;
1202
1203 /* copy in buffered data first */
1204 memcpy(data, priv->dp_out_buf, priv->dp_out_buf_len);
1205 data += priv->dp_out_buf_len;
1206
1207 /* copy in new data */
1208 memcpy(data, buf, new_len);
1209
1210 ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1211 if (ret == 0) {
1212 priv->dp_write_urb_in_use = 1;
1213 ret = new_len;
1214 priv->dp_out_buf_len = 0;
1215 }
1216
1217 /* return length of new data written, or error */
1218 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1219 if (ret < 0)
1220 dev_err(&port->dev,
1221 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
1222 __func__, ret, priv->dp_port_num);
1223 dbg("digi_write: returning %d", ret);
1224 return ret;
1225
1226}
1227
1228static void digi_write_bulk_callback(struct urb *urb)
1229{
1230
1231 struct usb_serial_port *port = urb->context;
1232 struct usb_serial *serial;
1233 struct digi_port *priv;
1234 struct digi_serial *serial_priv;
1235 int ret = 0;
1236 int status = urb->status;
1237
1238 dbg("digi_write_bulk_callback: TOP, status=%d", status);
1239
1240 /* port and serial sanity check */
1241 if (port == NULL || (priv = usb_get_serial_port_data(port)) == NULL) {
1242 pr_err("%s: port or port->private is NULL, status=%d\n",
1243 __func__, status);
1244 return;
1245 }
1246 serial = port->serial;
1247 if (serial == NULL || (serial_priv = usb_get_serial_data(serial)) == NULL) {
1248 dev_err(&port->dev,
1249 "%s: serial or serial->private is NULL, status=%d\n",
1250 __func__, status);
1251 return;
1252 }
1253
1254 /* handle oob callback */
1255 if (priv->dp_port_num == serial_priv->ds_oob_port_num) {
1256 dbg("digi_write_bulk_callback: oob callback");
1257 spin_lock(&priv->dp_port_lock);
1258 priv->dp_write_urb_in_use = 0;
1259 wake_up_interruptible(&port->write_wait);
1260 spin_unlock(&priv->dp_port_lock);
1261 return;
1262 }
1263
1264 /* try to send any buffered data on this port */
1265 spin_lock(&priv->dp_port_lock);
1266 priv->dp_write_urb_in_use = 0;
1267 if (priv->dp_out_buf_len > 0) {
1268 *((unsigned char *)(port->write_urb->transfer_buffer))
1269 = (unsigned char)DIGI_CMD_SEND_DATA;
1270 *((unsigned char *)(port->write_urb->transfer_buffer) + 1)
1271 = (unsigned char)priv->dp_out_buf_len;
1272 port->write_urb->transfer_buffer_length =
1273 priv->dp_out_buf_len + 2;
1274 port->write_urb->dev = serial->dev;
1275 memcpy(port->write_urb->transfer_buffer + 2, priv->dp_out_buf,
1276 priv->dp_out_buf_len);
1277 ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1278 if (ret == 0) {
1279 priv->dp_write_urb_in_use = 1;
1280 priv->dp_out_buf_len = 0;
1281 }
1282 }
1283 /* wake up processes sleeping on writes immediately */
1284 digi_wakeup_write(port);
1285 /* also queue up a wakeup at scheduler time, in case we */
1286 /* lost the race in write_chan(). */
1287 schedule_work(&priv->dp_wakeup_work);
1288
1289 spin_unlock(&priv->dp_port_lock);
1290 if (ret && ret != -EPERM)
1291 dev_err(&port->dev,
1292 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
1293 __func__, ret, priv->dp_port_num);
1294}
1295
1296static int digi_write_room(struct tty_struct *tty)
1297{
1298 struct usb_serial_port *port = tty->driver_data;
1299 struct digi_port *priv = usb_get_serial_port_data(port);
1300 int room;
1301 unsigned long flags = 0;
1302
1303 spin_lock_irqsave(&priv->dp_port_lock, flags);
1304
1305 if (priv->dp_write_urb_in_use)
1306 room = 0;
1307 else
1308 room = port->bulk_out_size - 2 - priv->dp_out_buf_len;
1309
1310 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1311 dbg("digi_write_room: port=%d, room=%d", priv->dp_port_num, room);
1312 return room;
1313
1314}
1315
1316static int digi_chars_in_buffer(struct tty_struct *tty)
1317{
1318 struct usb_serial_port *port = tty->driver_data;
1319 struct digi_port *priv = usb_get_serial_port_data(port);
1320
1321 if (priv->dp_write_urb_in_use) {
1322 dbg("digi_chars_in_buffer: port=%d, chars=%d",
1323 priv->dp_port_num, port->bulk_out_size - 2);
1324 /* return(port->bulk_out_size - 2); */
1325 return 256;
1326 } else {
1327 dbg("digi_chars_in_buffer: port=%d, chars=%d",
1328 priv->dp_port_num, priv->dp_out_buf_len);
1329 return priv->dp_out_buf_len;
1330 }
1331
1332}
1333
1334static void digi_dtr_rts(struct usb_serial_port *port, int on)
1335{
1336 /* Adjust DTR and RTS */
1337 digi_set_modem_signals(port, on * (TIOCM_DTR|TIOCM_RTS), 1);
1338}
1339
1340static int digi_open(struct tty_struct *tty, struct usb_serial_port *port)
1341{
1342 int ret;
1343 unsigned char buf[32];
1344 struct digi_port *priv = usb_get_serial_port_data(port);
1345 struct ktermios not_termios;
1346
1347 dbg("digi_open: TOP: port=%d", priv->dp_port_num);
1348
1349 /* be sure the device is started up */
1350 if (digi_startup_device(port->serial) != 0)
1351 return -ENXIO;
1352
1353 /* read modem signals automatically whenever they change */
1354 buf[0] = DIGI_CMD_READ_INPUT_SIGNALS;
1355 buf[1] = priv->dp_port_num;
1356 buf[2] = DIGI_ENABLE;
1357 buf[3] = 0;
1358
1359 /* flush fifos */
1360 buf[4] = DIGI_CMD_IFLUSH_FIFO;
1361 buf[5] = priv->dp_port_num;
1362 buf[6] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1363 buf[7] = 0;
1364
1365 ret = digi_write_oob_command(port, buf, 8, 1);
1366 if (ret != 0)
1367 dbg("digi_open: write oob failed, ret=%d", ret);
1368
1369 /* set termios settings */
1370 if (tty) {
1371 not_termios.c_cflag = ~tty->termios->c_cflag;
1372 not_termios.c_iflag = ~tty->termios->c_iflag;
1373 digi_set_termios(tty, port, ¬_termios);
1374 }
1375 return 0;
1376}
1377
1378
1379static void digi_close(struct usb_serial_port *port)
1380{
1381 DEFINE_WAIT(wait);
1382 int ret;
1383 unsigned char buf[32];
1384 struct digi_port *priv = usb_get_serial_port_data(port);
1385
1386 dbg("digi_close: TOP: port=%d", priv->dp_port_num);
1387
1388 mutex_lock(&port->serial->disc_mutex);
1389 /* if disconnected, just clear flags */
1390 if (port->serial->disconnected)
1391 goto exit;
1392
1393 if (port->serial->dev) {
1394 /* FIXME: Transmit idle belongs in the wait_unti_sent path */
1395 digi_transmit_idle(port, DIGI_CLOSE_TIMEOUT);
1396
1397 /* disable input flow control */
1398 buf[0] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1399 buf[1] = priv->dp_port_num;
1400 buf[2] = DIGI_DISABLE;
1401 buf[3] = 0;
1402
1403 /* disable output flow control */
1404 buf[4] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1405 buf[5] = priv->dp_port_num;
1406 buf[6] = DIGI_DISABLE;
1407 buf[7] = 0;
1408
1409 /* disable reading modem signals automatically */
1410 buf[8] = DIGI_CMD_READ_INPUT_SIGNALS;
1411 buf[9] = priv->dp_port_num;
1412 buf[10] = DIGI_DISABLE;
1413 buf[11] = 0;
1414
1415 /* disable receive */
1416 buf[12] = DIGI_CMD_RECEIVE_ENABLE;
1417 buf[13] = priv->dp_port_num;
1418 buf[14] = DIGI_DISABLE;
1419 buf[15] = 0;
1420
1421 /* flush fifos */
1422 buf[16] = DIGI_CMD_IFLUSH_FIFO;
1423 buf[17] = priv->dp_port_num;
1424 buf[18] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1425 buf[19] = 0;
1426
1427 ret = digi_write_oob_command(port, buf, 20, 0);
1428 if (ret != 0)
1429 dbg("digi_close: write oob failed, ret=%d", ret);
1430
1431 /* wait for final commands on oob port to complete */
1432 prepare_to_wait(&priv->dp_flush_wait, &wait,
1433 TASK_INTERRUPTIBLE);
1434 schedule_timeout(DIGI_CLOSE_TIMEOUT);
1435 finish_wait(&priv->dp_flush_wait, &wait);
1436
1437 /* shutdown any outstanding bulk writes */
1438 usb_kill_urb(port->write_urb);
1439 }
1440exit:
1441 spin_lock_irq(&priv->dp_port_lock);
1442 priv->dp_write_urb_in_use = 0;
1443 wake_up_interruptible(&priv->dp_close_wait);
1444 spin_unlock_irq(&priv->dp_port_lock);
1445 mutex_unlock(&port->serial->disc_mutex);
1446 dbg("digi_close: done");
1447}
1448
1449
1450/*
1451 * Digi Startup Device
1452 *
1453 * Starts reads on all ports. Must be called AFTER startup, with
1454 * urbs initialized. Returns 0 if successful, non-zero error otherwise.
1455 */
1456
1457static int digi_startup_device(struct usb_serial *serial)
1458{
1459 int i, ret = 0;
1460 struct digi_serial *serial_priv = usb_get_serial_data(serial);
1461 struct usb_serial_port *port;
1462
1463 /* be sure this happens exactly once */
1464 spin_lock(&serial_priv->ds_serial_lock);
1465 if (serial_priv->ds_device_started) {
1466 spin_unlock(&serial_priv->ds_serial_lock);
1467 return 0;
1468 }
1469 serial_priv->ds_device_started = 1;
1470 spin_unlock(&serial_priv->ds_serial_lock);
1471
1472 /* start reading from each bulk in endpoint for the device */
1473 /* set USB_DISABLE_SPD flag for write bulk urbs */
1474 for (i = 0; i < serial->type->num_ports + 1; i++) {
1475 port = serial->port[i];
1476 port->write_urb->dev = port->serial->dev;
1477 ret = usb_submit_urb(port->read_urb, GFP_KERNEL);
1478 if (ret != 0) {
1479 dev_err(&port->dev,
1480 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
1481 __func__, ret, i);
1482 break;
1483 }
1484 }
1485 return ret;
1486}
1487
1488
1489static int digi_startup(struct usb_serial *serial)
1490{
1491
1492 int i;
1493 struct digi_port *priv;
1494 struct digi_serial *serial_priv;
1495
1496 dbg("digi_startup: TOP");
1497
1498 /* allocate the private data structures for all ports */
1499 /* number of regular ports + 1 for the out-of-band port */
1500 for (i = 0; i < serial->type->num_ports + 1; i++) {
1501 /* allocate port private structure */
1502 priv = kmalloc(sizeof(struct digi_port), GFP_KERNEL);
1503 if (priv == NULL) {
1504 while (--i >= 0)
1505 kfree(usb_get_serial_port_data(serial->port[i]));
1506 return 1; /* error */
1507 }
1508
1509 /* initialize port private structure */
1510 spin_lock_init(&priv->dp_port_lock);
1511 priv->dp_port_num = i;
1512 priv->dp_out_buf_len = 0;
1513 priv->dp_write_urb_in_use = 0;
1514 priv->dp_modem_signals = 0;
1515 init_waitqueue_head(&priv->dp_modem_change_wait);
1516 priv->dp_transmit_idle = 0;
1517 init_waitqueue_head(&priv->dp_transmit_idle_wait);
1518 priv->dp_throttled = 0;
1519 priv->dp_throttle_restart = 0;
1520 init_waitqueue_head(&priv->dp_flush_wait);
1521 init_waitqueue_head(&priv->dp_close_wait);
1522 INIT_WORK(&priv->dp_wakeup_work, digi_wakeup_write_lock);
1523 priv->dp_port = serial->port[i];
1524 /* initialize write wait queue for this port */
1525 init_waitqueue_head(&serial->port[i]->write_wait);
1526
1527 usb_set_serial_port_data(serial->port[i], priv);
1528 }
1529
1530 /* allocate serial private structure */
1531 serial_priv = kmalloc(sizeof(struct digi_serial), GFP_KERNEL);
1532 if (serial_priv == NULL) {
1533 for (i = 0; i < serial->type->num_ports + 1; i++)
1534 kfree(usb_get_serial_port_data(serial->port[i]));
1535 return 1; /* error */
1536 }
1537
1538 /* initialize serial private structure */
1539 spin_lock_init(&serial_priv->ds_serial_lock);
1540 serial_priv->ds_oob_port_num = serial->type->num_ports;
1541 serial_priv->ds_oob_port = serial->port[serial_priv->ds_oob_port_num];
1542 serial_priv->ds_device_started = 0;
1543 usb_set_serial_data(serial, serial_priv);
1544
1545 return 0;
1546}
1547
1548
1549static void digi_disconnect(struct usb_serial *serial)
1550{
1551 int i;
1552 dbg("digi_disconnect: TOP, in_interrupt()=%ld", in_interrupt());
1553
1554 /* stop reads and writes on all ports */
1555 for (i = 0; i < serial->type->num_ports + 1; i++) {
1556 usb_kill_urb(serial->port[i]->read_urb);
1557 usb_kill_urb(serial->port[i]->write_urb);
1558 }
1559}
1560
1561
1562static void digi_release(struct usb_serial *serial)
1563{
1564 int i;
1565 dbg("digi_release: TOP, in_interrupt()=%ld", in_interrupt());
1566
1567 /* free the private data structures for all ports */
1568 /* number of regular ports + 1 for the out-of-band port */
1569 for (i = 0; i < serial->type->num_ports + 1; i++)
1570 kfree(usb_get_serial_port_data(serial->port[i]));
1571 kfree(usb_get_serial_data(serial));
1572}
1573
1574
1575static void digi_read_bulk_callback(struct urb *urb)
1576{
1577 struct usb_serial_port *port = urb->context;
1578 struct digi_port *priv;
1579 struct digi_serial *serial_priv;
1580 int ret;
1581 int status = urb->status;
1582
1583 dbg("digi_read_bulk_callback: TOP");
1584
1585 /* port sanity check, do not resubmit if port is not valid */
1586 if (port == NULL)
1587 return;
1588 priv = usb_get_serial_port_data(port);
1589 if (priv == NULL) {
1590 dev_err(&port->dev, "%s: port->private is NULL, status=%d\n",
1591 __func__, status);
1592 return;
1593 }
1594 if (port->serial == NULL ||
1595 (serial_priv = usb_get_serial_data(port->serial)) == NULL) {
1596 dev_err(&port->dev, "%s: serial is bad or serial->private "
1597 "is NULL, status=%d\n", __func__, status);
1598 return;
1599 }
1600
1601 /* do not resubmit urb if it has any status error */
1602 if (status) {
1603 dev_err(&port->dev,
1604 "%s: nonzero read bulk status: status=%d, port=%d\n",
1605 __func__, status, priv->dp_port_num);
1606 return;
1607 }
1608
1609 /* handle oob or inb callback, do not resubmit if error */
1610 if (priv->dp_port_num == serial_priv->ds_oob_port_num) {
1611 if (digi_read_oob_callback(urb) != 0)
1612 return;
1613 } else {
1614 if (digi_read_inb_callback(urb) != 0)
1615 return;
1616 }
1617
1618 /* continue read */
1619 urb->dev = port->serial->dev;
1620 ret = usb_submit_urb(urb, GFP_ATOMIC);
1621 if (ret != 0 && ret != -EPERM) {
1622 dev_err(&port->dev,
1623 "%s: failed resubmitting urb, ret=%d, port=%d\n",
1624 __func__, ret, priv->dp_port_num);
1625 }
1626
1627}
1628
1629/*
1630 * Digi Read INB Callback
1631 *
1632 * Digi Read INB Callback handles reads on the in band ports, sending
1633 * the data on to the tty subsystem. When called we know port and
1634 * port->private are not NULL and port->serial has been validated.
1635 * It returns 0 if successful, 1 if successful but the port is
1636 * throttled, and -1 if the sanity checks failed.
1637 */
1638
1639static int digi_read_inb_callback(struct urb *urb)
1640{
1641
1642 struct usb_serial_port *port = urb->context;
1643 struct tty_struct *tty;
1644 struct digi_port *priv = usb_get_serial_port_data(port);
1645 int opcode = ((unsigned char *)urb->transfer_buffer)[0];
1646 int len = ((unsigned char *)urb->transfer_buffer)[1];
1647 int port_status = ((unsigned char *)urb->transfer_buffer)[2];
1648 unsigned char *data = ((unsigned char *)urb->transfer_buffer) + 3;
1649 int flag, throttled;
1650 int status = urb->status;
1651
1652 /* do not process callbacks on closed ports */
1653 /* but do continue the read chain */
1654 if (urb->status == -ENOENT)
1655 return 0;
1656
1657 /* short/multiple packet check */
1658 if (urb->actual_length != len + 2) {
1659 dev_err(&port->dev, "%s: INCOMPLETE OR MULTIPLE PACKET, "
1660 "status=%d, port=%d, opcode=%d, len=%d, "
1661 "actual_length=%d, status=%d\n", __func__, status,
1662 priv->dp_port_num, opcode, len, urb->actual_length,
1663 port_status);
1664 return -1;
1665 }
1666
1667 tty = tty_port_tty_get(&port->port);
1668 spin_lock(&priv->dp_port_lock);
1669
1670 /* check for throttle; if set, do not resubmit read urb */
1671 /* indicate the read chain needs to be restarted on unthrottle */
1672 throttled = priv->dp_throttled;
1673 if (throttled)
1674 priv->dp_throttle_restart = 1;
1675
1676 /* receive data */
1677 if (tty && opcode == DIGI_CMD_RECEIVE_DATA) {
1678 /* get flag from port_status */
1679 flag = 0;
1680
1681 /* overrun is special, not associated with a char */
1682 if (port_status & DIGI_OVERRUN_ERROR)
1683 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
1684
1685 /* break takes precedence over parity, */
1686 /* which takes precedence over framing errors */
1687 if (port_status & DIGI_BREAK_ERROR)
1688 flag = TTY_BREAK;
1689 else if (port_status & DIGI_PARITY_ERROR)
1690 flag = TTY_PARITY;
1691 else if (port_status & DIGI_FRAMING_ERROR)
1692 flag = TTY_FRAME;
1693
1694 /* data length is len-1 (one byte of len is port_status) */
1695 --len;
1696 if (len > 0) {
1697 tty_insert_flip_string_fixed_flag(tty, data, flag,
1698 len);
1699 tty_flip_buffer_push(tty);
1700 }
1701 }
1702 spin_unlock(&priv->dp_port_lock);
1703 tty_kref_put(tty);
1704
1705 if (opcode == DIGI_CMD_RECEIVE_DISABLE)
1706 dbg("%s: got RECEIVE_DISABLE", __func__);
1707 else if (opcode != DIGI_CMD_RECEIVE_DATA)
1708 dbg("%s: unknown opcode: %d", __func__, opcode);
1709
1710 return throttled ? 1 : 0;
1711
1712}
1713
1714
1715/*
1716 * Digi Read OOB Callback
1717 *
1718 * Digi Read OOB Callback handles reads on the out of band port.
1719 * When called we know port and port->private are not NULL and
1720 * the port->serial is valid. It returns 0 if successful, and
1721 * -1 if the sanity checks failed.
1722 */
1723
1724static int digi_read_oob_callback(struct urb *urb)
1725{
1726
1727 struct usb_serial_port *port = urb->context;
1728 struct usb_serial *serial = port->serial;
1729 struct tty_struct *tty;
1730 struct digi_port *priv = usb_get_serial_port_data(port);
1731 int opcode, line, status, val;
1732 int i;
1733 unsigned int rts;
1734
1735 dbg("digi_read_oob_callback: port=%d, len=%d",
1736 priv->dp_port_num, urb->actual_length);
1737
1738 /* handle each oob command */
1739 for (i = 0; i < urb->actual_length - 3;) {
1740 opcode = ((unsigned char *)urb->transfer_buffer)[i++];
1741 line = ((unsigned char *)urb->transfer_buffer)[i++];
1742 status = ((unsigned char *)urb->transfer_buffer)[i++];
1743 val = ((unsigned char *)urb->transfer_buffer)[i++];
1744
1745 dbg("digi_read_oob_callback: opcode=%d, line=%d, status=%d, val=%d",
1746 opcode, line, status, val);
1747
1748 if (status != 0 || line >= serial->type->num_ports)
1749 continue;
1750
1751 port = serial->port[line];
1752
1753 priv = usb_get_serial_port_data(port);
1754 if (priv == NULL)
1755 return -1;
1756
1757 tty = tty_port_tty_get(&port->port);
1758
1759 rts = 0;
1760 if (tty)
1761 rts = tty->termios->c_cflag & CRTSCTS;
1762
1763 if (tty && opcode == DIGI_CMD_READ_INPUT_SIGNALS) {
1764 spin_lock(&priv->dp_port_lock);
1765 /* convert from digi flags to termiox flags */
1766 if (val & DIGI_READ_INPUT_SIGNALS_CTS) {
1767 priv->dp_modem_signals |= TIOCM_CTS;
1768 /* port must be open to use tty struct */
1769 if (rts) {
1770 tty->hw_stopped = 0;
1771 digi_wakeup_write(port);
1772 }
1773 } else {
1774 priv->dp_modem_signals &= ~TIOCM_CTS;
1775 /* port must be open to use tty struct */
1776 if (rts)
1777 tty->hw_stopped = 1;
1778 }
1779 if (val & DIGI_READ_INPUT_SIGNALS_DSR)
1780 priv->dp_modem_signals |= TIOCM_DSR;
1781 else
1782 priv->dp_modem_signals &= ~TIOCM_DSR;
1783 if (val & DIGI_READ_INPUT_SIGNALS_RI)
1784 priv->dp_modem_signals |= TIOCM_RI;
1785 else
1786 priv->dp_modem_signals &= ~TIOCM_RI;
1787 if (val & DIGI_READ_INPUT_SIGNALS_DCD)
1788 priv->dp_modem_signals |= TIOCM_CD;
1789 else
1790 priv->dp_modem_signals &= ~TIOCM_CD;
1791
1792 wake_up_interruptible(&priv->dp_modem_change_wait);
1793 spin_unlock(&priv->dp_port_lock);
1794 } else if (opcode == DIGI_CMD_TRANSMIT_IDLE) {
1795 spin_lock(&priv->dp_port_lock);
1796 priv->dp_transmit_idle = 1;
1797 wake_up_interruptible(&priv->dp_transmit_idle_wait);
1798 spin_unlock(&priv->dp_port_lock);
1799 } else if (opcode == DIGI_CMD_IFLUSH_FIFO) {
1800 wake_up_interruptible(&priv->dp_flush_wait);
1801 }
1802 tty_kref_put(tty);
1803 }
1804 return 0;
1805
1806}
1807
1808static int __init digi_init(void)
1809{
1810 int retval;
1811 retval = usb_serial_register(&digi_acceleport_2_device);
1812 if (retval)
1813 goto failed_acceleport_2_device;
1814 retval = usb_serial_register(&digi_acceleport_4_device);
1815 if (retval)
1816 goto failed_acceleport_4_device;
1817 retval = usb_register(&digi_driver);
1818 if (retval)
1819 goto failed_usb_register;
1820 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1821 DRIVER_DESC "\n");
1822 return 0;
1823failed_usb_register:
1824 usb_serial_deregister(&digi_acceleport_4_device);
1825failed_acceleport_4_device:
1826 usb_serial_deregister(&digi_acceleport_2_device);
1827failed_acceleport_2_device:
1828 return retval;
1829}
1830
1831static void __exit digi_exit (void)
1832{
1833 usb_deregister(&digi_driver);
1834 usb_serial_deregister(&digi_acceleport_2_device);
1835 usb_serial_deregister(&digi_acceleport_4_device);
1836}
1837
1838
1839module_init(digi_init);
1840module_exit(digi_exit);
1841
1842
1843MODULE_AUTHOR(DRIVER_AUTHOR);
1844MODULE_DESCRIPTION(DRIVER_DESC);
1845MODULE_LICENSE("GPL");
1846
1847module_param(debug, bool, S_IRUGO | S_IWUSR);
1848MODULE_PARM_DESC(debug, "Debug enabled or not");