]> Pileus Git - ~andy/linux/blob - drivers/usb/serial/digi_acceleport.c
Merge branch 'core-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[~andy/linux] / drivers / usb / serial / digi_acceleport.c
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
18 #include <linux/kernel.h>
19 #include <linux/errno.h>
20 #include <linux/slab.h>
21 #include <linux/tty.h>
22 #include <linux/tty_driver.h>
23 #include <linux/tty_flip.h>
24 #include <linux/module.h>
25 #include <linux/spinlock.h>
26 #include <linux/workqueue.h>
27 #include <linux/uaccess.h>
28 #include <linux/usb.h>
29 #include <linux/wait.h>
30 #include <linux/usb/serial.h>
31
32 /* Defines */
33
34 #define DRIVER_AUTHOR "Peter Berger <pberger@brimson.com>, Al Borchers <borchers@steinerpoint.com>"
35 #define DRIVER_DESC "Digi AccelePort USB-2/USB-4 Serial Converter driver"
36
37 /* port output buffer length -- must be <= transfer buffer length - 2 */
38 /* so we can be sure to send the full buffer in one urb */
39 #define DIGI_OUT_BUF_SIZE               8
40
41 /* port input buffer length -- must be >= transfer buffer length - 3 */
42 /* so we can be sure to hold at least one full buffer from one urb */
43 #define DIGI_IN_BUF_SIZE                64
44
45 /* retry timeout while sleeping */
46 #define DIGI_RETRY_TIMEOUT              (HZ/10)
47
48 /* timeout while waiting for tty output to drain in close */
49 /* this delay is used twice in close, so the total delay could */
50 /* be twice this value */
51 #define DIGI_CLOSE_TIMEOUT              (5*HZ)
52
53
54 /* AccelePort USB Defines */
55
56 /* ids */
57 #define DIGI_VENDOR_ID                  0x05c5
58 #define DIGI_2_ID                       0x0002  /* USB-2 */
59 #define DIGI_4_ID                       0x0004  /* USB-4 */
60
61 /* commands
62  * "INB": can be used on the in-band endpoint
63  * "OOB": can be used on the out-of-band endpoint
64  */
65 #define DIGI_CMD_SET_BAUD_RATE                  0       /* INB, OOB */
66 #define DIGI_CMD_SET_WORD_SIZE                  1       /* INB, OOB */
67 #define DIGI_CMD_SET_PARITY                     2       /* INB, OOB */
68 #define DIGI_CMD_SET_STOP_BITS                  3       /* INB, OOB */
69 #define DIGI_CMD_SET_INPUT_FLOW_CONTROL         4       /* INB, OOB */
70 #define DIGI_CMD_SET_OUTPUT_FLOW_CONTROL        5       /* INB, OOB */
71 #define DIGI_CMD_SET_DTR_SIGNAL                 6       /* INB, OOB */
72 #define DIGI_CMD_SET_RTS_SIGNAL                 7       /* INB, OOB */
73 #define DIGI_CMD_READ_INPUT_SIGNALS             8       /*      OOB */
74 #define DIGI_CMD_IFLUSH_FIFO                    9       /*      OOB */
75 #define DIGI_CMD_RECEIVE_ENABLE                 10      /* INB, OOB */
76 #define DIGI_CMD_BREAK_CONTROL                  11      /* INB, OOB */
77 #define DIGI_CMD_LOCAL_LOOPBACK                 12      /* INB, OOB */
78 #define DIGI_CMD_TRANSMIT_IDLE                  13      /* INB, OOB */
79 #define DIGI_CMD_READ_UART_REGISTER             14      /*      OOB */
80 #define DIGI_CMD_WRITE_UART_REGISTER            15      /* INB, OOB */
81 #define DIGI_CMD_AND_UART_REGISTER              16      /* INB, OOB */
82 #define DIGI_CMD_OR_UART_REGISTER               17      /* INB, OOB */
83 #define DIGI_CMD_SEND_DATA                      18      /* INB      */
84 #define DIGI_CMD_RECEIVE_DATA                   19      /* INB      */
85 #define DIGI_CMD_RECEIVE_DISABLE                20      /* INB      */
86 #define DIGI_CMD_GET_PORT_TYPE                  21      /*      OOB */
87
88 /* baud rates */
89 #define DIGI_BAUD_50                            0
90 #define DIGI_BAUD_75                            1
91 #define DIGI_BAUD_110                           2
92 #define DIGI_BAUD_150                           3
93 #define DIGI_BAUD_200                           4
94 #define DIGI_BAUD_300                           5
95 #define DIGI_BAUD_600                           6
96 #define DIGI_BAUD_1200                          7
97 #define DIGI_BAUD_1800                          8
98 #define DIGI_BAUD_2400                          9
99 #define DIGI_BAUD_4800                          10
100 #define DIGI_BAUD_7200                          11
101 #define DIGI_BAUD_9600                          12
102 #define DIGI_BAUD_14400                         13
103 #define DIGI_BAUD_19200                         14
104 #define DIGI_BAUD_28800                         15
105 #define DIGI_BAUD_38400                         16
106 #define DIGI_BAUD_57600                         17
107 #define DIGI_BAUD_76800                         18
108 #define DIGI_BAUD_115200                        19
109 #define DIGI_BAUD_153600                        20
110 #define DIGI_BAUD_230400                        21
111 #define DIGI_BAUD_460800                        22
112
113 /* arguments */
114 #define DIGI_WORD_SIZE_5                        0
115 #define DIGI_WORD_SIZE_6                        1
116 #define DIGI_WORD_SIZE_7                        2
117 #define DIGI_WORD_SIZE_8                        3
118
119 #define DIGI_PARITY_NONE                        0
120 #define DIGI_PARITY_ODD                         1
121 #define DIGI_PARITY_EVEN                        2
122 #define DIGI_PARITY_MARK                        3
123 #define DIGI_PARITY_SPACE                       4
124
125 #define DIGI_STOP_BITS_1                        0
126 #define DIGI_STOP_BITS_2                        1
127
128 #define DIGI_INPUT_FLOW_CONTROL_XON_XOFF        1
129 #define DIGI_INPUT_FLOW_CONTROL_RTS             2
130 #define DIGI_INPUT_FLOW_CONTROL_DTR             4
131
132 #define DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF       1
133 #define DIGI_OUTPUT_FLOW_CONTROL_CTS            2
134 #define DIGI_OUTPUT_FLOW_CONTROL_DSR            4
135
136 #define DIGI_DTR_INACTIVE                       0
137 #define DIGI_DTR_ACTIVE                         1
138 #define DIGI_DTR_INPUT_FLOW_CONTROL             2
139
140 #define DIGI_RTS_INACTIVE                       0
141 #define DIGI_RTS_ACTIVE                         1
142 #define DIGI_RTS_INPUT_FLOW_CONTROL             2
143 #define DIGI_RTS_TOGGLE                         3
144
145 #define DIGI_FLUSH_TX                           1
146 #define DIGI_FLUSH_RX                           2
147 #define DIGI_RESUME_TX                          4 /* clears xoff condition */
148
149 #define DIGI_TRANSMIT_NOT_IDLE                  0
150 #define DIGI_TRANSMIT_IDLE                      1
151
152 #define DIGI_DISABLE                            0
153 #define DIGI_ENABLE                             1
154
155 #define DIGI_DEASSERT                           0
156 #define DIGI_ASSERT                             1
157
158 /* in band status codes */
159 #define DIGI_OVERRUN_ERROR                      4
160 #define DIGI_PARITY_ERROR                       8
161 #define DIGI_FRAMING_ERROR                      16
162 #define DIGI_BREAK_ERROR                        32
163
164 /* out of band status */
165 #define DIGI_NO_ERROR                           0
166 #define DIGI_BAD_FIRST_PARAMETER                1
167 #define DIGI_BAD_SECOND_PARAMETER               2
168 #define DIGI_INVALID_LINE                       3
169 #define DIGI_INVALID_OPCODE                     4
170
171 /* input signals */
172 #define DIGI_READ_INPUT_SIGNALS_SLOT            1
173 #define DIGI_READ_INPUT_SIGNALS_ERR             2
174 #define DIGI_READ_INPUT_SIGNALS_BUSY            4
175 #define DIGI_READ_INPUT_SIGNALS_PE              8
176 #define DIGI_READ_INPUT_SIGNALS_CTS             16
177 #define DIGI_READ_INPUT_SIGNALS_DSR             32
178 #define DIGI_READ_INPUT_SIGNALS_RI              64
179 #define DIGI_READ_INPUT_SIGNALS_DCD             128
180
181
182 /* Structures */
183
184 struct digi_serial {
185         spinlock_t ds_serial_lock;
186         struct usb_serial_port *ds_oob_port;    /* out-of-band port */
187         int ds_oob_port_num;                    /* index of out-of-band port */
188         int ds_device_started;
189 };
190
191 struct digi_port {
192         spinlock_t dp_port_lock;
193         int dp_port_num;
194         int dp_out_buf_len;
195         unsigned char dp_out_buf[DIGI_OUT_BUF_SIZE];
196         int dp_write_urb_in_use;
197         unsigned int dp_modem_signals;
198         int dp_transmit_idle;
199         wait_queue_head_t dp_transmit_idle_wait;
200         int dp_throttled;
201         int dp_throttle_restart;
202         wait_queue_head_t dp_flush_wait;
203         wait_queue_head_t dp_close_wait;        /* wait queue for close */
204         struct work_struct dp_wakeup_work;
205         struct usb_serial_port *dp_port;
206 };
207
208
209 /* Local Function Declarations */
210
211 static void digi_wakeup_write_lock(struct work_struct *work);
212 static int digi_write_oob_command(struct usb_serial_port *port,
213         unsigned char *buf, int count, int interruptible);
214 static int digi_write_inb_command(struct usb_serial_port *port,
215         unsigned char *buf, int count, unsigned long timeout);
216 static int digi_set_modem_signals(struct usb_serial_port *port,
217         unsigned int modem_signals, int interruptible);
218 static int digi_transmit_idle(struct usb_serial_port *port,
219         unsigned long timeout);
220 static void digi_rx_throttle(struct tty_struct *tty);
221 static void digi_rx_unthrottle(struct tty_struct *tty);
222 static void digi_set_termios(struct tty_struct *tty,
223                 struct usb_serial_port *port, struct ktermios *old_termios);
224 static void digi_break_ctl(struct tty_struct *tty, int break_state);
225 static int digi_tiocmget(struct tty_struct *tty);
226 static int digi_tiocmset(struct tty_struct *tty, unsigned int set,
227                 unsigned int clear);
228 static int digi_write(struct tty_struct *tty, struct usb_serial_port *port,
229                 const unsigned char *buf, int count);
230 static void digi_write_bulk_callback(struct urb *urb);
231 static int digi_write_room(struct tty_struct *tty);
232 static int digi_chars_in_buffer(struct tty_struct *tty);
233 static int digi_open(struct tty_struct *tty, struct usb_serial_port *port);
234 static void digi_close(struct usb_serial_port *port);
235 static void digi_dtr_rts(struct usb_serial_port *port, int on);
236 static int digi_startup_device(struct usb_serial *serial);
237 static int digi_startup(struct usb_serial *serial);
238 static void digi_disconnect(struct usb_serial *serial);
239 static void digi_release(struct usb_serial *serial);
240 static int digi_port_probe(struct usb_serial_port *port);
241 static int digi_port_remove(struct usb_serial_port *port);
242 static void digi_read_bulk_callback(struct urb *urb);
243 static int digi_read_inb_callback(struct urb *urb);
244 static int digi_read_oob_callback(struct urb *urb);
245
246
247 static const struct usb_device_id id_table_combined[] = {
248         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
249         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
250         { }                                             /* Terminating entry */
251 };
252
253 static const struct usb_device_id id_table_2[] = {
254         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
255         { }                                             /* Terminating entry */
256 };
257
258 static const struct usb_device_id id_table_4[] = {
259         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
260         { }                                             /* Terminating entry */
261 };
262
263 MODULE_DEVICE_TABLE(usb, id_table_combined);
264
265 /* device info needed for the Digi serial converter */
266
267 static struct usb_serial_driver digi_acceleport_2_device = {
268         .driver = {
269                 .owner =                THIS_MODULE,
270                 .name =                 "digi_2",
271         },
272         .description =                  "Digi 2 port USB adapter",
273         .id_table =                     id_table_2,
274         .num_ports =                    3,
275         .open =                         digi_open,
276         .close =                        digi_close,
277         .dtr_rts =                      digi_dtr_rts,
278         .write =                        digi_write,
279         .write_room =                   digi_write_room,
280         .write_bulk_callback =          digi_write_bulk_callback,
281         .read_bulk_callback =           digi_read_bulk_callback,
282         .chars_in_buffer =              digi_chars_in_buffer,
283         .throttle =                     digi_rx_throttle,
284         .unthrottle =                   digi_rx_unthrottle,
285         .set_termios =                  digi_set_termios,
286         .break_ctl =                    digi_break_ctl,
287         .tiocmget =                     digi_tiocmget,
288         .tiocmset =                     digi_tiocmset,
289         .attach =                       digi_startup,
290         .disconnect =                   digi_disconnect,
291         .release =                      digi_release,
292         .port_probe =                   digi_port_probe,
293         .port_remove =                  digi_port_remove,
294 };
295
296 static struct usb_serial_driver digi_acceleport_4_device = {
297         .driver = {
298                 .owner =                THIS_MODULE,
299                 .name =                 "digi_4",
300         },
301         .description =                  "Digi 4 port USB adapter",
302         .id_table =                     id_table_4,
303         .num_ports =                    4,
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
324 static 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
343 static 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 /*
360  *  Digi Wakeup Write
361  *
362  *  Wake up port, line discipline, and tty processes sleeping
363  *  on writes.
364  */
365
366 static void digi_wakeup_write_lock(struct work_struct *work)
367 {
368         struct digi_port *priv =
369                         container_of(work, struct digi_port, dp_wakeup_work);
370         struct usb_serial_port *port = priv->dp_port;
371         unsigned long flags;
372
373         spin_lock_irqsave(&priv->dp_port_lock, flags);
374         tty_port_tty_wakeup(&port->port);
375         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
376 }
377
378 /*
379  *  Digi Write OOB Command
380  *
381  *  Write commands on the out of band port.  Commands are 4
382  *  bytes each, multiple commands can be sent at once, and
383  *  no command will be split across USB packets.  Returns 0
384  *  if successful, -EINTR if interrupted while sleeping and
385  *  the interruptible flag is true, or a negative error
386  *  returned by usb_submit_urb.
387  */
388
389 static int digi_write_oob_command(struct usb_serial_port *port,
390         unsigned char *buf, int count, int interruptible)
391 {
392         int ret = 0;
393         int len;
394         struct usb_serial_port *oob_port = (struct usb_serial_port *)((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
395         struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
396         unsigned long flags = 0;
397
398         dev_dbg(&port->dev,
399                 "digi_write_oob_command: TOP: port=%d, count=%d\n",
400                 oob_priv->dp_port_num, count);
401
402         spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
403         while (count > 0) {
404                 while (oob_priv->dp_write_urb_in_use) {
405                         cond_wait_interruptible_timeout_irqrestore(
406                                 &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
407                                 &oob_priv->dp_port_lock, flags);
408                         if (interruptible && signal_pending(current))
409                                 return -EINTR;
410                         spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
411                 }
412
413                 /* len must be a multiple of 4, so commands are not split */
414                 len = min(count, oob_port->bulk_out_size);
415                 if (len > 4)
416                         len &= ~3;
417                 memcpy(oob_port->write_urb->transfer_buffer, buf, len);
418                 oob_port->write_urb->transfer_buffer_length = len;
419                 ret = usb_submit_urb(oob_port->write_urb, GFP_ATOMIC);
420                 if (ret == 0) {
421                         oob_priv->dp_write_urb_in_use = 1;
422                         count -= len;
423                         buf += len;
424                 }
425         }
426         spin_unlock_irqrestore(&oob_priv->dp_port_lock, flags);
427         if (ret)
428                 dev_err(&port->dev, "%s: usb_submit_urb failed, ret=%d\n",
429                         __func__, ret);
430         return ret;
431
432 }
433
434
435 /*
436  *  Digi Write In Band Command
437  *
438  *  Write commands on the given port.  Commands are 4
439  *  bytes each, multiple commands can be sent at once, and
440  *  no command will be split across USB packets.  If timeout
441  *  is non-zero, write in band command will return after
442  *  waiting unsuccessfully for the URB status to clear for
443  *  timeout ticks.  Returns 0 if successful, or a negative
444  *  error returned by digi_write.
445  */
446
447 static int digi_write_inb_command(struct usb_serial_port *port,
448         unsigned char *buf, int count, unsigned long timeout)
449 {
450         int ret = 0;
451         int len;
452         struct digi_port *priv = usb_get_serial_port_data(port);
453         unsigned char *data = port->write_urb->transfer_buffer;
454         unsigned long flags = 0;
455
456         dev_dbg(&port->dev, "digi_write_inb_command: TOP: port=%d, count=%d\n",
457                 priv->dp_port_num, count);
458
459         if (timeout)
460                 timeout += jiffies;
461         else
462                 timeout = ULONG_MAX;
463
464         spin_lock_irqsave(&priv->dp_port_lock, flags);
465         while (count > 0 && ret == 0) {
466                 while (priv->dp_write_urb_in_use &&
467                        time_before(jiffies, timeout)) {
468                         cond_wait_interruptible_timeout_irqrestore(
469                                 &port->write_wait, DIGI_RETRY_TIMEOUT,
470                                 &priv->dp_port_lock, flags);
471                         if (signal_pending(current))
472                                 return -EINTR;
473                         spin_lock_irqsave(&priv->dp_port_lock, flags);
474                 }
475
476                 /* len must be a multiple of 4 and small enough to */
477                 /* guarantee the write will send buffered data first, */
478                 /* so commands are in order with data and not split */
479                 len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
480                 if (len > 4)
481                         len &= ~3;
482
483                 /* write any buffered data first */
484                 if (priv->dp_out_buf_len > 0) {
485                         data[0] = DIGI_CMD_SEND_DATA;
486                         data[1] = priv->dp_out_buf_len;
487                         memcpy(data + 2, priv->dp_out_buf,
488                                 priv->dp_out_buf_len);
489                         memcpy(data + 2 + priv->dp_out_buf_len, buf, len);
490                         port->write_urb->transfer_buffer_length
491                                 = priv->dp_out_buf_len + 2 + len;
492                 } else {
493                         memcpy(data, buf, len);
494                         port->write_urb->transfer_buffer_length = len;
495                 }
496
497                 ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
498                 if (ret == 0) {
499                         priv->dp_write_urb_in_use = 1;
500                         priv->dp_out_buf_len = 0;
501                         count -= len;
502                         buf += len;
503                 }
504
505         }
506         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
507
508         if (ret)
509                 dev_err(&port->dev,
510                         "%s: usb_submit_urb failed, ret=%d, port=%d\n",
511                         __func__, ret, priv->dp_port_num);
512         return ret;
513 }
514
515
516 /*
517  *  Digi Set Modem Signals
518  *
519  *  Sets or clears DTR and RTS on the port, according to the
520  *  modem_signals argument.  Use TIOCM_DTR and TIOCM_RTS flags
521  *  for the modem_signals argument.  Returns 0 if successful,
522  *  -EINTR if interrupted while sleeping, or a non-zero error
523  *  returned by usb_submit_urb.
524  */
525
526 static int digi_set_modem_signals(struct usb_serial_port *port,
527         unsigned int modem_signals, int interruptible)
528 {
529
530         int ret;
531         struct digi_port *port_priv = usb_get_serial_port_data(port);
532         struct usb_serial_port *oob_port = (struct usb_serial_port *) ((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
533         struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
534         unsigned char *data = oob_port->write_urb->transfer_buffer;
535         unsigned long flags = 0;
536
537
538         dev_dbg(&port->dev,
539                 "digi_set_modem_signals: TOP: port=%d, modem_signals=0x%x\n",
540                 port_priv->dp_port_num, modem_signals);
541
542         spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
543         spin_lock(&port_priv->dp_port_lock);
544
545         while (oob_priv->dp_write_urb_in_use) {
546                 spin_unlock(&port_priv->dp_port_lock);
547                 cond_wait_interruptible_timeout_irqrestore(
548                         &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
549                         &oob_priv->dp_port_lock, flags);
550                 if (interruptible && signal_pending(current))
551                         return -EINTR;
552                 spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
553                 spin_lock(&port_priv->dp_port_lock);
554         }
555         data[0] = DIGI_CMD_SET_DTR_SIGNAL;
556         data[1] = port_priv->dp_port_num;
557         data[2] = (modem_signals & TIOCM_DTR) ?
558                                         DIGI_DTR_ACTIVE : DIGI_DTR_INACTIVE;
559         data[3] = 0;
560         data[4] = DIGI_CMD_SET_RTS_SIGNAL;
561         data[5] = port_priv->dp_port_num;
562         data[6] = (modem_signals & TIOCM_RTS) ?
563                                         DIGI_RTS_ACTIVE : DIGI_RTS_INACTIVE;
564         data[7] = 0;
565
566         oob_port->write_urb->transfer_buffer_length = 8;
567
568         ret = usb_submit_urb(oob_port->write_urb, GFP_ATOMIC);
569         if (ret == 0) {
570                 oob_priv->dp_write_urb_in_use = 1;
571                 port_priv->dp_modem_signals =
572                         (port_priv->dp_modem_signals&~(TIOCM_DTR|TIOCM_RTS))
573                         | (modem_signals&(TIOCM_DTR|TIOCM_RTS));
574         }
575         spin_unlock(&port_priv->dp_port_lock);
576         spin_unlock_irqrestore(&oob_priv->dp_port_lock, flags);
577         if (ret)
578                 dev_err(&port->dev, "%s: usb_submit_urb failed, ret=%d\n",
579                         __func__, ret);
580         return ret;
581 }
582
583 /*
584  *  Digi Transmit Idle
585  *
586  *  Digi transmit idle waits, up to timeout ticks, for the transmitter
587  *  to go idle.  It returns 0 if successful or a negative error.
588  *
589  *  There are race conditions here if more than one process is calling
590  *  digi_transmit_idle on the same port at the same time.  However, this
591  *  is only called from close, and only one process can be in close on a
592  *  port at a time, so its ok.
593  */
594
595 static int digi_transmit_idle(struct usb_serial_port *port,
596         unsigned long timeout)
597 {
598         int ret;
599         unsigned char buf[2];
600         struct digi_port *priv = usb_get_serial_port_data(port);
601         unsigned long flags = 0;
602
603         spin_lock_irqsave(&priv->dp_port_lock, flags);
604         priv->dp_transmit_idle = 0;
605         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
606
607         buf[0] = DIGI_CMD_TRANSMIT_IDLE;
608         buf[1] = 0;
609
610         timeout += jiffies;
611
612         ret = digi_write_inb_command(port, buf, 2, timeout - jiffies);
613         if (ret != 0)
614                 return ret;
615
616         spin_lock_irqsave(&priv->dp_port_lock, flags);
617
618         while (time_before(jiffies, timeout) && !priv->dp_transmit_idle) {
619                 cond_wait_interruptible_timeout_irqrestore(
620                         &priv->dp_transmit_idle_wait, DIGI_RETRY_TIMEOUT,
621                         &priv->dp_port_lock, flags);
622                 if (signal_pending(current))
623                         return -EINTR;
624                 spin_lock_irqsave(&priv->dp_port_lock, flags);
625         }
626         priv->dp_transmit_idle = 0;
627         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
628         return 0;
629
630 }
631
632
633 static void digi_rx_throttle(struct tty_struct *tty)
634 {
635         unsigned long flags;
636         struct usb_serial_port *port = tty->driver_data;
637         struct digi_port *priv = usb_get_serial_port_data(port);
638
639         /* stop receiving characters by not resubmitting the read urb */
640         spin_lock_irqsave(&priv->dp_port_lock, flags);
641         priv->dp_throttled = 1;
642         priv->dp_throttle_restart = 0;
643         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
644 }
645
646
647 static void digi_rx_unthrottle(struct tty_struct *tty)
648 {
649         int ret = 0;
650         unsigned long flags;
651         struct usb_serial_port *port = tty->driver_data;
652         struct digi_port *priv = usb_get_serial_port_data(port);
653
654         spin_lock_irqsave(&priv->dp_port_lock, flags);
655
656         /* restart read chain */
657         if (priv->dp_throttle_restart)
658                 ret = usb_submit_urb(port->read_urb, GFP_ATOMIC);
659
660         /* turn throttle off */
661         priv->dp_throttled = 0;
662         priv->dp_throttle_restart = 0;
663
664         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
665
666         if (ret)
667                 dev_err(&port->dev,
668                         "%s: usb_submit_urb failed, ret=%d, port=%d\n",
669                         __func__, ret, priv->dp_port_num);
670 }
671
672
673 static void digi_set_termios(struct tty_struct *tty,
674                 struct usb_serial_port *port, struct ktermios *old_termios)
675 {
676         struct digi_port *priv = usb_get_serial_port_data(port);
677         struct device *dev = &port->dev;
678         unsigned int iflag = tty->termios.c_iflag;
679         unsigned int cflag = tty->termios.c_cflag;
680         unsigned int old_iflag = old_termios->c_iflag;
681         unsigned int old_cflag = old_termios->c_cflag;
682         unsigned char buf[32];
683         unsigned int modem_signals;
684         int arg, ret;
685         int i = 0;
686         speed_t baud;
687
688         dev_dbg(dev,
689                 "digi_set_termios: TOP: port=%d, iflag=0x%x, old_iflag=0x%x, cflag=0x%x, old_cflag=0x%x\n",
690                 priv->dp_port_num, iflag, old_iflag, cflag, old_cflag);
691
692         /* set baud rate */
693         baud = tty_get_baud_rate(tty);
694         if (baud != tty_termios_baud_rate(old_termios)) {
695                 arg = -1;
696
697                 /* reassert DTR and (maybe) RTS on transition from B0 */
698                 if ((old_cflag&CBAUD) == B0) {
699                         /* don't set RTS if using hardware flow control */
700                         /* and throttling input */
701                         modem_signals = TIOCM_DTR;
702                         if (!(tty->termios.c_cflag & CRTSCTS) ||
703                             !test_bit(TTY_THROTTLED, &tty->flags))
704                                 modem_signals |= TIOCM_RTS;
705                         digi_set_modem_signals(port, modem_signals, 1);
706                 }
707                 switch (baud) {
708                 /* drop DTR and RTS on transition to B0 */
709                 case 0: digi_set_modem_signals(port, 0, 1); break;
710                 case 50: arg = DIGI_BAUD_50; break;
711                 case 75: arg = DIGI_BAUD_75; break;
712                 case 110: arg = DIGI_BAUD_110; break;
713                 case 150: arg = DIGI_BAUD_150; break;
714                 case 200: arg = DIGI_BAUD_200; break;
715                 case 300: arg = DIGI_BAUD_300; break;
716                 case 600: arg = DIGI_BAUD_600; break;
717                 case 1200: arg = DIGI_BAUD_1200; break;
718                 case 1800: arg = DIGI_BAUD_1800; break;
719                 case 2400: arg = DIGI_BAUD_2400; break;
720                 case 4800: arg = DIGI_BAUD_4800; break;
721                 case 9600: arg = DIGI_BAUD_9600; break;
722                 case 19200: arg = DIGI_BAUD_19200; break;
723                 case 38400: arg = DIGI_BAUD_38400; break;
724                 case 57600: arg = DIGI_BAUD_57600; break;
725                 case 115200: arg = DIGI_BAUD_115200; break;
726                 case 230400: arg = DIGI_BAUD_230400; break;
727                 case 460800: arg = DIGI_BAUD_460800; break;
728                 default:
729                         arg = DIGI_BAUD_9600;
730                         baud = 9600;
731                         break;
732                 }
733                 if (arg != -1) {
734                         buf[i++] = DIGI_CMD_SET_BAUD_RATE;
735                         buf[i++] = priv->dp_port_num;
736                         buf[i++] = arg;
737                         buf[i++] = 0;
738                 }
739         }
740         /* set parity */
741         tty->termios.c_cflag &= ~CMSPAR;
742
743         if ((cflag&(PARENB|PARODD)) != (old_cflag&(PARENB|PARODD))) {
744                 if (cflag&PARENB) {
745                         if (cflag&PARODD)
746                                 arg = DIGI_PARITY_ODD;
747                         else
748                                 arg = DIGI_PARITY_EVEN;
749                 } else {
750                         arg = DIGI_PARITY_NONE;
751                 }
752                 buf[i++] = DIGI_CMD_SET_PARITY;
753                 buf[i++] = priv->dp_port_num;
754                 buf[i++] = arg;
755                 buf[i++] = 0;
756         }
757         /* set word size */
758         if ((cflag&CSIZE) != (old_cflag&CSIZE)) {
759                 arg = -1;
760                 switch (cflag&CSIZE) {
761                 case CS5: arg = DIGI_WORD_SIZE_5; break;
762                 case CS6: arg = DIGI_WORD_SIZE_6; break;
763                 case CS7: arg = DIGI_WORD_SIZE_7; break;
764                 case CS8: arg = DIGI_WORD_SIZE_8; break;
765                 default:
766                         dev_dbg(dev,
767                                 "digi_set_termios: can't handle word size %d\n",
768                                 (cflag&CSIZE));
769                         break;
770                 }
771
772                 if (arg != -1) {
773                         buf[i++] = DIGI_CMD_SET_WORD_SIZE;
774                         buf[i++] = priv->dp_port_num;
775                         buf[i++] = arg;
776                         buf[i++] = 0;
777                 }
778
779         }
780
781         /* set stop bits */
782         if ((cflag&CSTOPB) != (old_cflag&CSTOPB)) {
783
784                 if ((cflag&CSTOPB))
785                         arg = DIGI_STOP_BITS_2;
786                 else
787                         arg = DIGI_STOP_BITS_1;
788
789                 buf[i++] = DIGI_CMD_SET_STOP_BITS;
790                 buf[i++] = priv->dp_port_num;
791                 buf[i++] = arg;
792                 buf[i++] = 0;
793
794         }
795
796         /* set input flow control */
797         if ((iflag&IXOFF) != (old_iflag&IXOFF)
798             || (cflag&CRTSCTS) != (old_cflag&CRTSCTS)) {
799                 arg = 0;
800                 if (iflag&IXOFF)
801                         arg |= DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
802                 else
803                         arg &= ~DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
804
805                 if (cflag&CRTSCTS) {
806                         arg |= DIGI_INPUT_FLOW_CONTROL_RTS;
807
808                         /* On USB-4 it is necessary to assert RTS prior */
809                         /* to selecting RTS input flow control.  */
810                         buf[i++] = DIGI_CMD_SET_RTS_SIGNAL;
811                         buf[i++] = priv->dp_port_num;
812                         buf[i++] = DIGI_RTS_ACTIVE;
813                         buf[i++] = 0;
814
815                 } else {
816                         arg &= ~DIGI_INPUT_FLOW_CONTROL_RTS;
817                 }
818                 buf[i++] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
819                 buf[i++] = priv->dp_port_num;
820                 buf[i++] = arg;
821                 buf[i++] = 0;
822         }
823
824         /* set output flow control */
825         if ((iflag & IXON) != (old_iflag & IXON)
826             || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
827                 arg = 0;
828                 if (iflag & IXON)
829                         arg |= DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
830                 else
831                         arg &= ~DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
832
833                 if (cflag & CRTSCTS) {
834                         arg |= DIGI_OUTPUT_FLOW_CONTROL_CTS;
835                 } else {
836                         arg &= ~DIGI_OUTPUT_FLOW_CONTROL_CTS;
837                         tty->hw_stopped = 0;
838                 }
839
840                 buf[i++] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
841                 buf[i++] = priv->dp_port_num;
842                 buf[i++] = arg;
843                 buf[i++] = 0;
844         }
845
846         /* set receive enable/disable */
847         if ((cflag & CREAD) != (old_cflag & CREAD)) {
848                 if (cflag & CREAD)
849                         arg = DIGI_ENABLE;
850                 else
851                         arg = DIGI_DISABLE;
852
853                 buf[i++] = DIGI_CMD_RECEIVE_ENABLE;
854                 buf[i++] = priv->dp_port_num;
855                 buf[i++] = arg;
856                 buf[i++] = 0;
857         }
858         ret = digi_write_oob_command(port, buf, i, 1);
859         if (ret != 0)
860                 dev_dbg(dev, "digi_set_termios: write oob failed, ret=%d\n", ret);
861         tty_encode_baud_rate(tty, baud, baud);
862 }
863
864
865 static void digi_break_ctl(struct tty_struct *tty, int break_state)
866 {
867         struct usb_serial_port *port = tty->driver_data;
868         unsigned char buf[4];
869
870         buf[0] = DIGI_CMD_BREAK_CONTROL;
871         buf[1] = 2;                             /* length */
872         buf[2] = break_state ? 1 : 0;
873         buf[3] = 0;                             /* pad */
874         digi_write_inb_command(port, buf, 4, 0);
875 }
876
877
878 static int digi_tiocmget(struct tty_struct *tty)
879 {
880         struct usb_serial_port *port = tty->driver_data;
881         struct digi_port *priv = usb_get_serial_port_data(port);
882         unsigned int val;
883         unsigned long flags;
884
885         spin_lock_irqsave(&priv->dp_port_lock, flags);
886         val = priv->dp_modem_signals;
887         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
888         return val;
889 }
890
891
892 static int digi_tiocmset(struct tty_struct *tty,
893                                         unsigned int set, unsigned int clear)
894 {
895         struct usb_serial_port *port = tty->driver_data;
896         struct digi_port *priv = usb_get_serial_port_data(port);
897         unsigned int val;
898         unsigned long flags;
899
900         spin_lock_irqsave(&priv->dp_port_lock, flags);
901         val = (priv->dp_modem_signals & ~clear) | set;
902         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
903         return digi_set_modem_signals(port, val, 1);
904 }
905
906
907 static int digi_write(struct tty_struct *tty, struct usb_serial_port *port,
908                                         const unsigned char *buf, int count)
909 {
910
911         int ret, data_len, new_len;
912         struct digi_port *priv = usb_get_serial_port_data(port);
913         unsigned char *data = port->write_urb->transfer_buffer;
914         unsigned long flags = 0;
915
916         dev_dbg(&port->dev,
917                 "digi_write: TOP: port=%d, count=%d, in_interrupt=%ld\n",
918                 priv->dp_port_num, count, in_interrupt());
919
920         /* copy user data (which can sleep) before getting spin lock */
921         count = min(count, port->bulk_out_size-2);
922         count = min(64, count);
923
924         /* be sure only one write proceeds at a time */
925         /* there are races on the port private buffer */
926         spin_lock_irqsave(&priv->dp_port_lock, flags);
927
928         /* wait for urb status clear to submit another urb */
929         if (priv->dp_write_urb_in_use) {
930                 /* buffer data if count is 1 (probably put_char) if possible */
931                 if (count == 1 && priv->dp_out_buf_len < DIGI_OUT_BUF_SIZE) {
932                         priv->dp_out_buf[priv->dp_out_buf_len++] = *buf;
933                         new_len = 1;
934                 } else {
935                         new_len = 0;
936                 }
937                 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
938                 return new_len;
939         }
940
941         /* allow space for any buffered data and for new data, up to */
942         /* transfer buffer size - 2 (for command and length bytes) */
943         new_len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
944         data_len = new_len + priv->dp_out_buf_len;
945
946         if (data_len == 0) {
947                 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
948                 return 0;
949         }
950
951         port->write_urb->transfer_buffer_length = data_len+2;
952
953         *data++ = DIGI_CMD_SEND_DATA;
954         *data++ = data_len;
955
956         /* copy in buffered data first */
957         memcpy(data, priv->dp_out_buf, priv->dp_out_buf_len);
958         data += priv->dp_out_buf_len;
959
960         /* copy in new data */
961         memcpy(data, buf, new_len);
962
963         ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
964         if (ret == 0) {
965                 priv->dp_write_urb_in_use = 1;
966                 ret = new_len;
967                 priv->dp_out_buf_len = 0;
968         }
969
970         /* return length of new data written, or error */
971         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
972         if (ret < 0)
973                 dev_err_console(port,
974                         "%s: usb_submit_urb failed, ret=%d, port=%d\n",
975                         __func__, ret, priv->dp_port_num);
976         dev_dbg(&port->dev, "digi_write: returning %d\n", ret);
977         return ret;
978
979 }
980
981 static void digi_write_bulk_callback(struct urb *urb)
982 {
983
984         struct usb_serial_port *port = urb->context;
985         struct usb_serial *serial;
986         struct digi_port *priv;
987         struct digi_serial *serial_priv;
988         int ret = 0;
989         int status = urb->status;
990
991         /* port and serial sanity check */
992         if (port == NULL || (priv = usb_get_serial_port_data(port)) == NULL) {
993                 pr_err("%s: port or port->private is NULL, status=%d\n",
994                         __func__, status);
995                 return;
996         }
997         serial = port->serial;
998         if (serial == NULL || (serial_priv = usb_get_serial_data(serial)) == NULL) {
999                 dev_err(&port->dev,
1000                         "%s: serial or serial->private is NULL, status=%d\n",
1001                         __func__, status);
1002                 return;
1003         }
1004
1005         /* handle oob callback */
1006         if (priv->dp_port_num == serial_priv->ds_oob_port_num) {
1007                 dev_dbg(&port->dev, "digi_write_bulk_callback: oob callback\n");
1008                 spin_lock(&priv->dp_port_lock);
1009                 priv->dp_write_urb_in_use = 0;
1010                 wake_up_interruptible(&port->write_wait);
1011                 spin_unlock(&priv->dp_port_lock);
1012                 return;
1013         }
1014
1015         /* try to send any buffered data on this port */
1016         spin_lock(&priv->dp_port_lock);
1017         priv->dp_write_urb_in_use = 0;
1018         if (priv->dp_out_buf_len > 0) {
1019                 *((unsigned char *)(port->write_urb->transfer_buffer))
1020                         = (unsigned char)DIGI_CMD_SEND_DATA;
1021                 *((unsigned char *)(port->write_urb->transfer_buffer) + 1)
1022                         = (unsigned char)priv->dp_out_buf_len;
1023                 port->write_urb->transfer_buffer_length =
1024                                                 priv->dp_out_buf_len + 2;
1025                 memcpy(port->write_urb->transfer_buffer + 2, priv->dp_out_buf,
1026                         priv->dp_out_buf_len);
1027                 ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1028                 if (ret == 0) {
1029                         priv->dp_write_urb_in_use = 1;
1030                         priv->dp_out_buf_len = 0;
1031                 }
1032         }
1033         /* wake up processes sleeping on writes immediately */
1034         tty_port_tty_wakeup(&port->port);
1035         /* also queue up a wakeup at scheduler time, in case we */
1036         /* lost the race in write_chan(). */
1037         schedule_work(&priv->dp_wakeup_work);
1038
1039         spin_unlock(&priv->dp_port_lock);
1040         if (ret && ret != -EPERM)
1041                 dev_err_console(port,
1042                         "%s: usb_submit_urb failed, ret=%d, port=%d\n",
1043                         __func__, ret, priv->dp_port_num);
1044 }
1045
1046 static int digi_write_room(struct tty_struct *tty)
1047 {
1048         struct usb_serial_port *port = tty->driver_data;
1049         struct digi_port *priv = usb_get_serial_port_data(port);
1050         int room;
1051         unsigned long flags = 0;
1052
1053         spin_lock_irqsave(&priv->dp_port_lock, flags);
1054
1055         if (priv->dp_write_urb_in_use)
1056                 room = 0;
1057         else
1058                 room = port->bulk_out_size - 2 - priv->dp_out_buf_len;
1059
1060         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1061         dev_dbg(&port->dev, "digi_write_room: port=%d, room=%d\n", priv->dp_port_num, room);
1062         return room;
1063
1064 }
1065
1066 static int digi_chars_in_buffer(struct tty_struct *tty)
1067 {
1068         struct usb_serial_port *port = tty->driver_data;
1069         struct digi_port *priv = usb_get_serial_port_data(port);
1070
1071         if (priv->dp_write_urb_in_use) {
1072                 dev_dbg(&port->dev, "digi_chars_in_buffer: port=%d, chars=%d\n",
1073                         priv->dp_port_num, port->bulk_out_size - 2);
1074                 /* return(port->bulk_out_size - 2); */
1075                 return 256;
1076         } else {
1077                 dev_dbg(&port->dev, "digi_chars_in_buffer: port=%d, chars=%d\n",
1078                         priv->dp_port_num, priv->dp_out_buf_len);
1079                 return priv->dp_out_buf_len;
1080         }
1081
1082 }
1083
1084 static void digi_dtr_rts(struct usb_serial_port *port, int on)
1085 {
1086         /* Adjust DTR and RTS */
1087         digi_set_modem_signals(port, on * (TIOCM_DTR|TIOCM_RTS), 1);
1088 }
1089
1090 static int digi_open(struct tty_struct *tty, struct usb_serial_port *port)
1091 {
1092         int ret;
1093         unsigned char buf[32];
1094         struct digi_port *priv = usb_get_serial_port_data(port);
1095         struct ktermios not_termios;
1096
1097         /* be sure the device is started up */
1098         if (digi_startup_device(port->serial) != 0)
1099                 return -ENXIO;
1100
1101         /* read modem signals automatically whenever they change */
1102         buf[0] = DIGI_CMD_READ_INPUT_SIGNALS;
1103         buf[1] = priv->dp_port_num;
1104         buf[2] = DIGI_ENABLE;
1105         buf[3] = 0;
1106
1107         /* flush fifos */
1108         buf[4] = DIGI_CMD_IFLUSH_FIFO;
1109         buf[5] = priv->dp_port_num;
1110         buf[6] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1111         buf[7] = 0;
1112
1113         ret = digi_write_oob_command(port, buf, 8, 1);
1114         if (ret != 0)
1115                 dev_dbg(&port->dev, "digi_open: write oob failed, ret=%d\n", ret);
1116
1117         /* set termios settings */
1118         if (tty) {
1119                 not_termios.c_cflag = ~tty->termios.c_cflag;
1120                 not_termios.c_iflag = ~tty->termios.c_iflag;
1121                 digi_set_termios(tty, port, &not_termios);
1122         }
1123         return 0;
1124 }
1125
1126
1127 static void digi_close(struct usb_serial_port *port)
1128 {
1129         DEFINE_WAIT(wait);
1130         int ret;
1131         unsigned char buf[32];
1132         struct digi_port *priv = usb_get_serial_port_data(port);
1133
1134         mutex_lock(&port->serial->disc_mutex);
1135         /* if disconnected, just clear flags */
1136         if (port->serial->disconnected)
1137                 goto exit;
1138
1139         /* FIXME: Transmit idle belongs in the wait_unti_sent path */
1140         digi_transmit_idle(port, DIGI_CLOSE_TIMEOUT);
1141
1142         /* disable input flow control */
1143         buf[0] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1144         buf[1] = priv->dp_port_num;
1145         buf[2] = DIGI_DISABLE;
1146         buf[3] = 0;
1147
1148         /* disable output flow control */
1149         buf[4] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1150         buf[5] = priv->dp_port_num;
1151         buf[6] = DIGI_DISABLE;
1152         buf[7] = 0;
1153
1154         /* disable reading modem signals automatically */
1155         buf[8] = DIGI_CMD_READ_INPUT_SIGNALS;
1156         buf[9] = priv->dp_port_num;
1157         buf[10] = DIGI_DISABLE;
1158         buf[11] = 0;
1159
1160         /* disable receive */
1161         buf[12] = DIGI_CMD_RECEIVE_ENABLE;
1162         buf[13] = priv->dp_port_num;
1163         buf[14] = DIGI_DISABLE;
1164         buf[15] = 0;
1165
1166         /* flush fifos */
1167         buf[16] = DIGI_CMD_IFLUSH_FIFO;
1168         buf[17] = priv->dp_port_num;
1169         buf[18] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1170         buf[19] = 0;
1171
1172         ret = digi_write_oob_command(port, buf, 20, 0);
1173         if (ret != 0)
1174                 dev_dbg(&port->dev, "digi_close: write oob failed, ret=%d\n",
1175                                                                         ret);
1176         /* wait for final commands on oob port to complete */
1177         prepare_to_wait(&priv->dp_flush_wait, &wait,
1178                         TASK_INTERRUPTIBLE);
1179         schedule_timeout(DIGI_CLOSE_TIMEOUT);
1180         finish_wait(&priv->dp_flush_wait, &wait);
1181
1182         /* shutdown any outstanding bulk writes */
1183         usb_kill_urb(port->write_urb);
1184 exit:
1185         spin_lock_irq(&priv->dp_port_lock);
1186         priv->dp_write_urb_in_use = 0;
1187         wake_up_interruptible(&priv->dp_close_wait);
1188         spin_unlock_irq(&priv->dp_port_lock);
1189         mutex_unlock(&port->serial->disc_mutex);
1190 }
1191
1192
1193 /*
1194  *  Digi Startup Device
1195  *
1196  *  Starts reads on all ports.  Must be called AFTER startup, with
1197  *  urbs initialized.  Returns 0 if successful, non-zero error otherwise.
1198  */
1199
1200 static int digi_startup_device(struct usb_serial *serial)
1201 {
1202         int i, ret = 0;
1203         struct digi_serial *serial_priv = usb_get_serial_data(serial);
1204         struct usb_serial_port *port;
1205
1206         /* be sure this happens exactly once */
1207         spin_lock(&serial_priv->ds_serial_lock);
1208         if (serial_priv->ds_device_started) {
1209                 spin_unlock(&serial_priv->ds_serial_lock);
1210                 return 0;
1211         }
1212         serial_priv->ds_device_started = 1;
1213         spin_unlock(&serial_priv->ds_serial_lock);
1214
1215         /* start reading from each bulk in endpoint for the device */
1216         /* set USB_DISABLE_SPD flag for write bulk urbs */
1217         for (i = 0; i < serial->type->num_ports + 1; i++) {
1218                 port = serial->port[i];
1219                 ret = usb_submit_urb(port->read_urb, GFP_KERNEL);
1220                 if (ret != 0) {
1221                         dev_err(&port->dev,
1222                                 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
1223                                 __func__, ret, i);
1224                         break;
1225                 }
1226         }
1227         return ret;
1228 }
1229
1230 static int digi_port_init(struct usb_serial_port *port, unsigned port_num)
1231 {
1232         struct digi_port *priv;
1233
1234         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1235         if (!priv)
1236                 return -ENOMEM;
1237
1238         spin_lock_init(&priv->dp_port_lock);
1239         priv->dp_port_num = port_num;
1240         init_waitqueue_head(&priv->dp_transmit_idle_wait);
1241         init_waitqueue_head(&priv->dp_flush_wait);
1242         init_waitqueue_head(&priv->dp_close_wait);
1243         INIT_WORK(&priv->dp_wakeup_work, digi_wakeup_write_lock);
1244         priv->dp_port = port;
1245
1246         init_waitqueue_head(&port->write_wait);
1247
1248         usb_set_serial_port_data(port, priv);
1249
1250         return 0;
1251 }
1252
1253 static int digi_startup(struct usb_serial *serial)
1254 {
1255         struct digi_serial *serial_priv;
1256         int ret;
1257
1258         serial_priv = kzalloc(sizeof(*serial_priv), GFP_KERNEL);
1259         if (!serial_priv)
1260                 return -ENOMEM;
1261
1262         spin_lock_init(&serial_priv->ds_serial_lock);
1263         serial_priv->ds_oob_port_num = serial->type->num_ports;
1264         serial_priv->ds_oob_port = serial->port[serial_priv->ds_oob_port_num];
1265
1266         ret = digi_port_init(serial_priv->ds_oob_port,
1267                                                 serial_priv->ds_oob_port_num);
1268         if (ret) {
1269                 kfree(serial_priv);
1270                 return ret;
1271         }
1272
1273         usb_set_serial_data(serial, serial_priv);
1274
1275         return 0;
1276 }
1277
1278
1279 static void digi_disconnect(struct usb_serial *serial)
1280 {
1281         int i;
1282
1283         /* stop reads and writes on all ports */
1284         for (i = 0; i < serial->type->num_ports + 1; i++) {
1285                 usb_kill_urb(serial->port[i]->read_urb);
1286                 usb_kill_urb(serial->port[i]->write_urb);
1287         }
1288 }
1289
1290
1291 static void digi_release(struct usb_serial *serial)
1292 {
1293         struct digi_serial *serial_priv;
1294         struct digi_port *priv;
1295
1296         serial_priv = usb_get_serial_data(serial);
1297
1298         priv = usb_get_serial_port_data(serial_priv->ds_oob_port);
1299         kfree(priv);
1300
1301         kfree(serial_priv);
1302 }
1303
1304 static int digi_port_probe(struct usb_serial_port *port)
1305 {
1306         return digi_port_init(port, port->port_number);
1307 }
1308
1309 static int digi_port_remove(struct usb_serial_port *port)
1310 {
1311         struct digi_port *priv;
1312
1313         priv = usb_get_serial_port_data(port);
1314         kfree(priv);
1315
1316         return 0;
1317 }
1318
1319 static void digi_read_bulk_callback(struct urb *urb)
1320 {
1321         struct usb_serial_port *port = urb->context;
1322         struct digi_port *priv;
1323         struct digi_serial *serial_priv;
1324         int ret;
1325         int status = urb->status;
1326
1327         /* port sanity check, do not resubmit if port is not valid */
1328         if (port == NULL)
1329                 return;
1330         priv = usb_get_serial_port_data(port);
1331         if (priv == NULL) {
1332                 dev_err(&port->dev, "%s: port->private is NULL, status=%d\n",
1333                         __func__, status);
1334                 return;
1335         }
1336         if (port->serial == NULL ||
1337                 (serial_priv = usb_get_serial_data(port->serial)) == NULL) {
1338                 dev_err(&port->dev, "%s: serial is bad or serial->private "
1339                         "is NULL, status=%d\n", __func__, status);
1340                 return;
1341         }
1342
1343         /* do not resubmit urb if it has any status error */
1344         if (status) {
1345                 dev_err(&port->dev,
1346                         "%s: nonzero read bulk status: status=%d, port=%d\n",
1347                         __func__, status, priv->dp_port_num);
1348                 return;
1349         }
1350
1351         /* handle oob or inb callback, do not resubmit if error */
1352         if (priv->dp_port_num == serial_priv->ds_oob_port_num) {
1353                 if (digi_read_oob_callback(urb) != 0)
1354                         return;
1355         } else {
1356                 if (digi_read_inb_callback(urb) != 0)
1357                         return;
1358         }
1359
1360         /* continue read */
1361         ret = usb_submit_urb(urb, GFP_ATOMIC);
1362         if (ret != 0 && ret != -EPERM) {
1363                 dev_err(&port->dev,
1364                         "%s: failed resubmitting urb, ret=%d, port=%d\n",
1365                         __func__, ret, priv->dp_port_num);
1366         }
1367
1368 }
1369
1370 /*
1371  *  Digi Read INB Callback
1372  *
1373  *  Digi Read INB Callback handles reads on the in band ports, sending
1374  *  the data on to the tty subsystem.  When called we know port and
1375  *  port->private are not NULL and port->serial has been validated.
1376  *  It returns 0 if successful, 1 if successful but the port is
1377  *  throttled, and -1 if the sanity checks failed.
1378  */
1379
1380 static int digi_read_inb_callback(struct urb *urb)
1381 {
1382         struct usb_serial_port *port = urb->context;
1383         struct digi_port *priv = usb_get_serial_port_data(port);
1384         int opcode = ((unsigned char *)urb->transfer_buffer)[0];
1385         int len = ((unsigned char *)urb->transfer_buffer)[1];
1386         int port_status = ((unsigned char *)urb->transfer_buffer)[2];
1387         unsigned char *data = ((unsigned char *)urb->transfer_buffer) + 3;
1388         int flag, throttled;
1389         int status = urb->status;
1390
1391         /* do not process callbacks on closed ports */
1392         /* but do continue the read chain */
1393         if (urb->status == -ENOENT)
1394                 return 0;
1395
1396         /* short/multiple packet check */
1397         if (urb->actual_length != len + 2) {
1398                 dev_err(&port->dev, "%s: INCOMPLETE OR MULTIPLE PACKET, "
1399                         "status=%d, port=%d, opcode=%d, len=%d, "
1400                         "actual_length=%d, status=%d\n", __func__, status,
1401                         priv->dp_port_num, opcode, len, urb->actual_length,
1402                         port_status);
1403                 return -1;
1404         }
1405
1406         spin_lock(&priv->dp_port_lock);
1407
1408         /* check for throttle; if set, do not resubmit read urb */
1409         /* indicate the read chain needs to be restarted on unthrottle */
1410         throttled = priv->dp_throttled;
1411         if (throttled)
1412                 priv->dp_throttle_restart = 1;
1413
1414         /* receive data */
1415         if (opcode == DIGI_CMD_RECEIVE_DATA) {
1416                 /* get flag from port_status */
1417                 flag = 0;
1418
1419                 /* overrun is special, not associated with a char */
1420                 if (port_status & DIGI_OVERRUN_ERROR)
1421                         tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
1422
1423                 /* break takes precedence over parity, */
1424                 /* which takes precedence over framing errors */
1425                 if (port_status & DIGI_BREAK_ERROR)
1426                         flag = TTY_BREAK;
1427                 else if (port_status & DIGI_PARITY_ERROR)
1428                         flag = TTY_PARITY;
1429                 else if (port_status & DIGI_FRAMING_ERROR)
1430                         flag = TTY_FRAME;
1431
1432                 /* data length is len-1 (one byte of len is port_status) */
1433                 --len;
1434                 if (len > 0) {
1435                         tty_insert_flip_string_fixed_flag(&port->port, data,
1436                                         flag, len);
1437                         tty_flip_buffer_push(&port->port);
1438                 }
1439         }
1440         spin_unlock(&priv->dp_port_lock);
1441
1442         if (opcode == DIGI_CMD_RECEIVE_DISABLE)
1443                 dev_dbg(&port->dev, "%s: got RECEIVE_DISABLE\n", __func__);
1444         else if (opcode != DIGI_CMD_RECEIVE_DATA)
1445                 dev_dbg(&port->dev, "%s: unknown opcode: %d\n", __func__, opcode);
1446
1447         return throttled ? 1 : 0;
1448
1449 }
1450
1451
1452 /*
1453  *  Digi Read OOB Callback
1454  *
1455  *  Digi Read OOB Callback handles reads on the out of band port.
1456  *  When called we know port and port->private are not NULL and
1457  *  the port->serial is valid.  It returns 0 if successful, and
1458  *  -1 if the sanity checks failed.
1459  */
1460
1461 static int digi_read_oob_callback(struct urb *urb)
1462 {
1463
1464         struct usb_serial_port *port = urb->context;
1465         struct usb_serial *serial = port->serial;
1466         struct tty_struct *tty;
1467         struct digi_port *priv = usb_get_serial_port_data(port);
1468         int opcode, line, status, val;
1469         int i;
1470         unsigned int rts;
1471
1472         /* handle each oob command */
1473         for (i = 0; i < urb->actual_length - 3;) {
1474                 opcode = ((unsigned char *)urb->transfer_buffer)[i++];
1475                 line = ((unsigned char *)urb->transfer_buffer)[i++];
1476                 status = ((unsigned char *)urb->transfer_buffer)[i++];
1477                 val = ((unsigned char *)urb->transfer_buffer)[i++];
1478
1479                 dev_dbg(&port->dev, "digi_read_oob_callback: opcode=%d, line=%d, status=%d, val=%d\n",
1480                         opcode, line, status, val);
1481
1482                 if (status != 0 || line >= serial->type->num_ports)
1483                         continue;
1484
1485                 port = serial->port[line];
1486
1487                 priv = usb_get_serial_port_data(port);
1488                 if (priv == NULL)
1489                         return -1;
1490
1491                 tty = tty_port_tty_get(&port->port);
1492
1493                 rts = 0;
1494                 if (tty)
1495                         rts = tty->termios.c_cflag & CRTSCTS;
1496                 
1497                 if (tty && opcode == DIGI_CMD_READ_INPUT_SIGNALS) {
1498                         spin_lock(&priv->dp_port_lock);
1499                         /* convert from digi flags to termiox flags */
1500                         if (val & DIGI_READ_INPUT_SIGNALS_CTS) {
1501                                 priv->dp_modem_signals |= TIOCM_CTS;
1502                                 /* port must be open to use tty struct */
1503                                 if (rts) {
1504                                         tty->hw_stopped = 0;
1505                                         tty_port_tty_wakeup(&port->port);
1506                                 }
1507                         } else {
1508                                 priv->dp_modem_signals &= ~TIOCM_CTS;
1509                                 /* port must be open to use tty struct */
1510                                 if (rts)
1511                                         tty->hw_stopped = 1;
1512                         }
1513                         if (val & DIGI_READ_INPUT_SIGNALS_DSR)
1514                                 priv->dp_modem_signals |= TIOCM_DSR;
1515                         else
1516                                 priv->dp_modem_signals &= ~TIOCM_DSR;
1517                         if (val & DIGI_READ_INPUT_SIGNALS_RI)
1518                                 priv->dp_modem_signals |= TIOCM_RI;
1519                         else
1520                                 priv->dp_modem_signals &= ~TIOCM_RI;
1521                         if (val & DIGI_READ_INPUT_SIGNALS_DCD)
1522                                 priv->dp_modem_signals |= TIOCM_CD;
1523                         else
1524                                 priv->dp_modem_signals &= ~TIOCM_CD;
1525
1526                         spin_unlock(&priv->dp_port_lock);
1527                 } else if (opcode == DIGI_CMD_TRANSMIT_IDLE) {
1528                         spin_lock(&priv->dp_port_lock);
1529                         priv->dp_transmit_idle = 1;
1530                         wake_up_interruptible(&priv->dp_transmit_idle_wait);
1531                         spin_unlock(&priv->dp_port_lock);
1532                 } else if (opcode == DIGI_CMD_IFLUSH_FIFO) {
1533                         wake_up_interruptible(&priv->dp_flush_wait);
1534                 }
1535                 tty_kref_put(tty);
1536         }
1537         return 0;
1538
1539 }
1540
1541 module_usb_serial_driver(serial_drivers, id_table_combined);
1542
1543 MODULE_AUTHOR(DRIVER_AUTHOR);
1544 MODULE_DESCRIPTION(DRIVER_DESC);
1545 MODULE_LICENSE("GPL");