hcm's fixes
[kernel-power] / usbhost / drivers / usb2 / 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 * (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
405 struct 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
412 struct 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         int dp_in_close;                        /* close in progress */
426         wait_queue_head_t dp_close_wait;        /* wait queue for close */
427         struct work_struct dp_wakeup_work;
428         struct usb_serial_port *dp_port;
429 };
430
431
432 /* Local Function Declarations */
433
434 static void digi_wakeup_write(struct usb_serial_port *port);
435 static void digi_wakeup_write_lock(struct work_struct *work);
436 static int digi_write_oob_command(struct usb_serial_port *port,
437         unsigned char *buf, int count, int interruptible);
438 static int digi_write_inb_command(struct usb_serial_port *port,
439         unsigned char *buf, int count, unsigned long timeout);
440 static int digi_set_modem_signals(struct usb_serial_port *port,
441         unsigned int modem_signals, int interruptible);
442 static int digi_transmit_idle(struct usb_serial_port *port,
443         unsigned long timeout);
444 static void digi_rx_throttle(struct tty_struct *tty);
445 static void digi_rx_unthrottle(struct tty_struct *tty);
446 static void digi_set_termios(struct tty_struct *tty,
447                 struct usb_serial_port *port, struct ktermios *old_termios);
448 static void digi_break_ctl(struct tty_struct *tty, int break_state);
449 static int digi_tiocmget(struct tty_struct *tty, struct file *file);
450 static int digi_tiocmset(struct tty_struct *tty, struct file *file,
451         unsigned int set, unsigned int clear);
452 static int digi_write(struct tty_struct *tty, struct usb_serial_port *port,
453         const unsigned char *buf, int count);
454 static void digi_write_bulk_callback(struct urb *urb);
455 static int digi_write_room(struct tty_struct *tty);
456 static int digi_chars_in_buffer(struct tty_struct *tty);
457 static int digi_open(struct tty_struct *tty, struct usb_serial_port *port,
458         struct file *filp);
459 static void digi_close(struct tty_struct *tty, struct usb_serial_port *port,
460         struct file *filp);
461 static int digi_startup_device(struct usb_serial *serial);
462 static int digi_startup(struct usb_serial *serial);
463 static void digi_shutdown(struct usb_serial *serial);
464 static void digi_read_bulk_callback(struct urb *urb);
465 static int digi_read_inb_callback(struct urb *urb);
466 static int digi_read_oob_callback(struct urb *urb);
467
468
469 /* Statics */
470
471 static int debug;
472
473 static struct usb_device_id id_table_combined [] = {
474         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
475         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
476         { }                                             /* Terminating entry */
477 };
478
479 static struct usb_device_id id_table_2 [] = {
480         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_2_ID) },
481         { }                                             /* Terminating entry */
482 };
483
484 static struct usb_device_id id_table_4 [] = {
485         { USB_DEVICE(DIGI_VENDOR_ID, DIGI_4_ID) },
486         { }                                             /* Terminating entry */
487 };
488
489 MODULE_DEVICE_TABLE(usb, id_table_combined);
490
491 static struct usb_driver digi_driver = {
492         .name =         "digi_acceleport",
493         .probe =        usb_serial_probe,
494         .disconnect =   usb_serial_disconnect,
495         .id_table =     id_table_combined,
496         .no_dynamic_id =        1,
497 };
498
499
500 /* device info needed for the Digi serial converter */
501
502 static struct usb_serial_driver digi_acceleport_2_device = {
503         .driver = {
504                 .owner =                THIS_MODULE,
505                 .name =                 "digi_2",
506         },
507         .description =                  "Digi 2 port USB adapter",
508         .usb_driver =                   &digi_driver,
509         .id_table =                     id_table_2,
510         .num_ports =                    3,
511         .open =                         digi_open,
512         .close =                        digi_close,
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         .shutdown =                     digi_shutdown,
526 };
527
528 static struct usb_serial_driver digi_acceleport_4_device = {
529         .driver = {
530                 .owner =                THIS_MODULE,
531                 .name =                 "digi_4",
532         },
533         .description =                  "Digi 4 port USB adapter",
534         .usb_driver =                   &digi_driver,
535         .id_table =                     id_table_4,
536         .num_ports =                    4,
537         .open =                         digi_open,
538         .close =                        digi_close,
539         .write =                        digi_write,
540         .write_room =                   digi_write_room,
541         .write_bulk_callback =          digi_write_bulk_callback,
542         .read_bulk_callback =           digi_read_bulk_callback,
543         .chars_in_buffer =              digi_chars_in_buffer,
544         .throttle =                     digi_rx_throttle,
545         .unthrottle =                   digi_rx_unthrottle,
546         .set_termios =                  digi_set_termios,
547         .break_ctl =                    digi_break_ctl,
548         .tiocmget =                     digi_tiocmget,
549         .tiocmset =                     digi_tiocmset,
550         .attach =                       digi_startup,
551         .shutdown =                     digi_shutdown,
552 };
553
554
555 /* Functions */
556
557 /*
558  *  Cond Wait Interruptible Timeout Irqrestore
559  *
560  *  Do spin_unlock_irqrestore and interruptible_sleep_on_timeout
561  *  so that wake ups are not lost if they occur between the unlock
562  *  and the sleep.  In other words, spin_unlock_irqrestore and
563  *  interruptible_sleep_on_timeout are "atomic" with respect to
564  *  wake ups.  This is used to implement condition variables.
565  *
566  *  interruptible_sleep_on_timeout is deprecated and has been replaced
567  *  with the equivalent code.
568  */
569
570 static long cond_wait_interruptible_timeout_irqrestore(
571         wait_queue_head_t *q, long timeout,
572         spinlock_t *lock, unsigned long flags)
573 __releases(lock)
574 {
575         DEFINE_WAIT(wait);
576
577         prepare_to_wait(q, &wait, TASK_INTERRUPTIBLE);
578         spin_unlock_irqrestore(lock, flags);
579         timeout = schedule_timeout(timeout);
580         finish_wait(q, &wait);
581
582         return timeout;
583 }
584
585
586 /*
587  *  Digi Wakeup Write
588  *
589  *  Wake up port, line discipline, and tty processes sleeping
590  *  on writes.
591  */
592
593 static void digi_wakeup_write_lock(struct work_struct *work)
594 {
595         struct digi_port *priv =
596                         container_of(work, struct digi_port, dp_wakeup_work);
597         struct usb_serial_port *port = priv->dp_port;
598         unsigned long flags;
599
600         spin_lock_irqsave(&priv->dp_port_lock, flags);
601         digi_wakeup_write(port);
602         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
603 }
604
605 static void digi_wakeup_write(struct usb_serial_port *port)
606 {
607         struct tty_struct *tty = tty_port_tty_get(&port->port);
608         tty_wakeup(tty);
609         tty_kref_put(tty);
610 }
611
612
613 /*
614  *  Digi Write OOB Command
615  *
616  *  Write commands on the out of band port.  Commands are 4
617  *  bytes each, multiple commands can be sent at once, and
618  *  no command will be split across USB packets.  Returns 0
619  *  if successful, -EINTR if interrupted while sleeping and
620  *  the interruptible flag is true, or a negative error
621  *  returned by usb_submit_urb.
622  */
623
624 static int digi_write_oob_command(struct usb_serial_port *port,
625         unsigned char *buf, int count, int interruptible)
626 {
627
628         int ret = 0;
629         int len;
630         struct usb_serial_port *oob_port = (struct usb_serial_port *)((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
631         struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
632         unsigned long flags = 0;
633
634         dbg("digi_write_oob_command: TOP: port=%d, count=%d", oob_priv->dp_port_num, count);
635
636         spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
637         while (count > 0) {
638                 while (oob_port->write_urb->status == -EINPROGRESS
639                         || oob_priv->dp_write_urb_in_use) {
640                         cond_wait_interruptible_timeout_irqrestore(
641                                 &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
642                                 &oob_priv->dp_port_lock, flags);
643                         if (interruptible && signal_pending(current))
644                                 return -EINTR;
645                         spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
646                 }
647
648                 /* len must be a multiple of 4, so commands are not split */
649                 len = min(count, oob_port->bulk_out_size);
650                 if (len > 4)
651                         len &= ~3;
652                 memcpy(oob_port->write_urb->transfer_buffer, buf, len);
653                 oob_port->write_urb->transfer_buffer_length = len;
654                 oob_port->write_urb->dev = port->serial->dev;
655                 ret = usb_submit_urb(oob_port->write_urb, GFP_ATOMIC);
656                 if (ret == 0) {
657                         oob_priv->dp_write_urb_in_use = 1;
658                         count -= len;
659                         buf += len;
660                 }
661         }
662         spin_unlock_irqrestore(&oob_priv->dp_port_lock, flags);
663         if (ret)
664                 dev_err(&port->dev, "%s: usb_submit_urb failed, ret=%d\n",
665                         __func__, ret);
666         return ret;
667
668 }
669
670
671 /*
672  *  Digi Write In Band Command
673  *
674  *  Write commands on the given port.  Commands are 4
675  *  bytes each, multiple commands can be sent at once, and
676  *  no command will be split across USB packets.  If timeout
677  *  is non-zero, write in band command will return after
678  *  waiting unsuccessfully for the URB status to clear for
679  *  timeout ticks.  Returns 0 if successful, or a negative
680  *  error returned by digi_write.
681  */
682
683 static int digi_write_inb_command(struct usb_serial_port *port,
684         unsigned char *buf, int count, unsigned long timeout)
685 {
686         int ret = 0;
687         int len;
688         struct digi_port *priv = usb_get_serial_port_data(port);
689         unsigned char *data = port->write_urb->transfer_buffer;
690         unsigned long flags = 0;
691
692         dbg("digi_write_inb_command: TOP: port=%d, count=%d",
693                 priv->dp_port_num, count);
694
695         if (timeout)
696                 timeout += jiffies;
697         else
698                 timeout = ULONG_MAX;
699
700         spin_lock_irqsave(&priv->dp_port_lock, flags);
701         while (count > 0 && ret == 0) {
702                 while ((port->write_urb->status == -EINPROGRESS
703                                 || priv->dp_write_urb_in_use)
704                                         && time_before(jiffies, timeout)) {
705                         cond_wait_interruptible_timeout_irqrestore(
706                                 &port->write_wait, DIGI_RETRY_TIMEOUT,
707                                 &priv->dp_port_lock, flags);
708                         if (signal_pending(current))
709                                 return -EINTR;
710                         spin_lock_irqsave(&priv->dp_port_lock, flags);
711                 }
712
713                 /* len must be a multiple of 4 and small enough to */
714                 /* guarantee the write will send buffered data first, */
715                 /* so commands are in order with data and not split */
716                 len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
717                 if (len > 4)
718                         len &= ~3;
719
720                 /* write any buffered data first */
721                 if (priv->dp_out_buf_len > 0) {
722                         data[0] = DIGI_CMD_SEND_DATA;
723                         data[1] = priv->dp_out_buf_len;
724                         memcpy(data + 2, priv->dp_out_buf,
725                                 priv->dp_out_buf_len);
726                         memcpy(data + 2 + priv->dp_out_buf_len, buf, len);
727                         port->write_urb->transfer_buffer_length
728                                 = priv->dp_out_buf_len + 2 + len;
729                 } else {
730                         memcpy(data, buf, len);
731                         port->write_urb->transfer_buffer_length = len;
732                 }
733                 port->write_urb->dev = port->serial->dev;
734
735                 ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
736                 if (ret == 0) {
737                         priv->dp_write_urb_in_use = 1;
738                         priv->dp_out_buf_len = 0;
739                         count -= len;
740                         buf += len;
741                 }
742
743         }
744         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
745
746         if (ret)
747                 dev_err(&port->dev,
748                         "%s: usb_submit_urb failed, ret=%d, port=%d\n",
749                         __func__, ret, priv->dp_port_num);
750         return ret;
751 }
752
753
754 /*
755  *  Digi Set Modem Signals
756  *
757  *  Sets or clears DTR and RTS on the port, according to the
758  *  modem_signals argument.  Use TIOCM_DTR and TIOCM_RTS flags
759  *  for the modem_signals argument.  Returns 0 if successful,
760  *  -EINTR if interrupted while sleeping, or a non-zero error
761  *  returned by usb_submit_urb.
762  */
763
764 static int digi_set_modem_signals(struct usb_serial_port *port,
765         unsigned int modem_signals, int interruptible)
766 {
767
768         int ret;
769         struct digi_port *port_priv = usb_get_serial_port_data(port);
770         struct usb_serial_port *oob_port = (struct usb_serial_port *) ((struct digi_serial *)(usb_get_serial_data(port->serial)))->ds_oob_port;
771         struct digi_port *oob_priv = usb_get_serial_port_data(oob_port);
772         unsigned char *data = oob_port->write_urb->transfer_buffer;
773         unsigned long flags = 0;
774
775
776         dbg("digi_set_modem_signals: TOP: port=%d, modem_signals=0x%x",
777                 port_priv->dp_port_num, modem_signals);
778
779         spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
780         spin_lock(&port_priv->dp_port_lock);
781
782         while (oob_port->write_urb->status == -EINPROGRESS ||
783                                         oob_priv->dp_write_urb_in_use) {
784                 spin_unlock(&port_priv->dp_port_lock);
785                 cond_wait_interruptible_timeout_irqrestore(
786                         &oob_port->write_wait, DIGI_RETRY_TIMEOUT,
787                         &oob_priv->dp_port_lock, flags);
788                 if (interruptible && signal_pending(current))
789                         return -EINTR;
790                 spin_lock_irqsave(&oob_priv->dp_port_lock, flags);
791                 spin_lock(&port_priv->dp_port_lock);
792         }
793         data[0] = DIGI_CMD_SET_DTR_SIGNAL;
794         data[1] = port_priv->dp_port_num;
795         data[2] = (modem_signals & TIOCM_DTR) ?
796                                         DIGI_DTR_ACTIVE : DIGI_DTR_INACTIVE;
797         data[3] = 0;
798         data[4] = DIGI_CMD_SET_RTS_SIGNAL;
799         data[5] = port_priv->dp_port_num;
800         data[6] = (modem_signals & TIOCM_RTS) ?
801                                         DIGI_RTS_ACTIVE : DIGI_RTS_INACTIVE;
802         data[7] = 0;
803
804         oob_port->write_urb->transfer_buffer_length = 8;
805         oob_port->write_urb->dev = port->serial->dev;
806
807         ret = usb_submit_urb(oob_port->write_urb, GFP_ATOMIC);
808         if (ret == 0) {
809                 oob_priv->dp_write_urb_in_use = 1;
810                 port_priv->dp_modem_signals =
811                         (port_priv->dp_modem_signals&~(TIOCM_DTR|TIOCM_RTS))
812                         | (modem_signals&(TIOCM_DTR|TIOCM_RTS));
813         }
814         spin_unlock(&port_priv->dp_port_lock);
815         spin_unlock_irqrestore(&oob_priv->dp_port_lock, flags);
816         if (ret)
817                 dev_err(&port->dev, "%s: usb_submit_urb failed, ret=%d\n",
818                         __func__, ret);
819         return ret;
820 }
821
822 /*
823  *  Digi Transmit Idle
824  *
825  *  Digi transmit idle waits, up to timeout ticks, for the transmitter
826  *  to go idle.  It returns 0 if successful or a negative error.
827  *
828  *  There are race conditions here if more than one process is calling
829  *  digi_transmit_idle on the same port at the same time.  However, this
830  *  is only called from close, and only one process can be in close on a
831  *  port at a time, so its ok.
832  */
833
834 static int digi_transmit_idle(struct usb_serial_port *port,
835         unsigned long timeout)
836 {
837         int ret;
838         unsigned char buf[2];
839         struct digi_port *priv = usb_get_serial_port_data(port);
840         unsigned long flags = 0;
841
842         spin_lock_irqsave(&priv->dp_port_lock, flags);
843         priv->dp_transmit_idle = 0;
844         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
845
846         buf[0] = DIGI_CMD_TRANSMIT_IDLE;
847         buf[1] = 0;
848
849         timeout += jiffies;
850
851         ret = digi_write_inb_command(port, buf, 2, timeout - jiffies);
852         if (ret != 0)
853                 return ret;
854
855         spin_lock_irqsave(&priv->dp_port_lock, flags);
856
857         while (time_before(jiffies, timeout) && !priv->dp_transmit_idle) {
858                 cond_wait_interruptible_timeout_irqrestore(
859                         &priv->dp_transmit_idle_wait, DIGI_RETRY_TIMEOUT,
860                         &priv->dp_port_lock, flags);
861                 if (signal_pending(current))
862                         return -EINTR;
863                 spin_lock_irqsave(&priv->dp_port_lock, flags);
864         }
865         priv->dp_transmit_idle = 0;
866         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
867         return 0;
868
869 }
870
871
872 static void digi_rx_throttle(struct tty_struct *tty)
873 {
874         unsigned long flags;
875         struct usb_serial_port *port = tty->driver_data;
876         struct digi_port *priv = usb_get_serial_port_data(port);
877
878
879         dbg("digi_rx_throttle: TOP: port=%d", priv->dp_port_num);
880
881         /* stop receiving characters by not resubmitting the read urb */
882         spin_lock_irqsave(&priv->dp_port_lock, flags);
883         priv->dp_throttled = 1;
884         priv->dp_throttle_restart = 0;
885         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
886 }
887
888
889 static void digi_rx_unthrottle(struct tty_struct *tty)
890 {
891         int ret = 0;
892         unsigned long flags;
893         struct usb_serial_port *port = tty->driver_data;
894         struct digi_port *priv = usb_get_serial_port_data(port);
895
896         dbg("digi_rx_unthrottle: TOP: port=%d", priv->dp_port_num);
897
898         spin_lock_irqsave(&priv->dp_port_lock, flags);
899
900         /* turn throttle off */
901         priv->dp_throttled = 0;
902         priv->dp_throttle_restart = 0;
903
904         /* restart read chain */
905         if (priv->dp_throttle_restart) {
906                 port->read_urb->dev = port->serial->dev;
907                 ret = usb_submit_urb(port->read_urb, GFP_ATOMIC);
908         }
909
910         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
911
912         if (ret)
913                 dev_err(&port->dev,
914                         "%s: usb_submit_urb failed, ret=%d, port=%d\n",
915                         __func__, ret, priv->dp_port_num);
916 }
917
918
919 static void digi_set_termios(struct tty_struct *tty,
920                 struct usb_serial_port *port, struct ktermios *old_termios)
921 {
922         struct digi_port *priv = usb_get_serial_port_data(port);
923         unsigned int iflag = tty->termios->c_iflag;
924         unsigned int cflag = tty->termios->c_cflag;
925         unsigned int old_iflag = old_termios->c_iflag;
926         unsigned int old_cflag = old_termios->c_cflag;
927         unsigned char buf[32];
928         unsigned int modem_signals;
929         int arg, ret;
930         int i = 0;
931         speed_t baud;
932
933         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);
934
935         /* set baud rate */
936         baud = tty_get_baud_rate(tty);
937         if (baud != tty_termios_baud_rate(old_termios)) {
938                 arg = -1;
939
940                 /* reassert DTR and (maybe) RTS on transition from B0 */
941                 if ((old_cflag&CBAUD) == B0) {
942                         /* don't set RTS if using hardware flow control */
943                         /* and throttling input */
944                         modem_signals = TIOCM_DTR;
945                         if (!(tty->termios->c_cflag & CRTSCTS) ||
946                             !test_bit(TTY_THROTTLED, &tty->flags))
947                                 modem_signals |= TIOCM_RTS;
948                         digi_set_modem_signals(port, modem_signals, 1);
949                 }
950                 switch (baud) {
951                 /* drop DTR and RTS on transition to B0 */
952                 case 0: digi_set_modem_signals(port, 0, 1); break;
953                 case 50: arg = DIGI_BAUD_50; break;
954                 case 75: arg = DIGI_BAUD_75; break;
955                 case 110: arg = DIGI_BAUD_110; break;
956                 case 150: arg = DIGI_BAUD_150; break;
957                 case 200: arg = DIGI_BAUD_200; break;
958                 case 300: arg = DIGI_BAUD_300; break;
959                 case 600: arg = DIGI_BAUD_600; break;
960                 case 1200: arg = DIGI_BAUD_1200; break;
961                 case 1800: arg = DIGI_BAUD_1800; break;
962                 case 2400: arg = DIGI_BAUD_2400; break;
963                 case 4800: arg = DIGI_BAUD_4800; break;
964                 case 9600: arg = DIGI_BAUD_9600; break;
965                 case 19200: arg = DIGI_BAUD_19200; break;
966                 case 38400: arg = DIGI_BAUD_38400; break;
967                 case 57600: arg = DIGI_BAUD_57600; break;
968                 case 115200: arg = DIGI_BAUD_115200; break;
969                 case 230400: arg = DIGI_BAUD_230400; break;
970                 case 460800: arg = DIGI_BAUD_460800; break;
971                 default:
972                         arg = DIGI_BAUD_9600;
973                         baud = 9600;
974                         break;
975                 }
976                 if (arg != -1) {
977                         buf[i++] = DIGI_CMD_SET_BAUD_RATE;
978                         buf[i++] = priv->dp_port_num;
979                         buf[i++] = arg;
980                         buf[i++] = 0;
981                 }
982         }
983         /* set parity */
984         tty->termios->c_cflag &= ~CMSPAR;
985
986         if ((cflag&(PARENB|PARODD)) != (old_cflag&(PARENB|PARODD))) {
987                 if (cflag&PARENB) {
988                         if (cflag&PARODD)
989                                 arg = DIGI_PARITY_ODD;
990                         else
991                                 arg = DIGI_PARITY_EVEN;
992                 } else {
993                         arg = DIGI_PARITY_NONE;
994                 }
995                 buf[i++] = DIGI_CMD_SET_PARITY;
996                 buf[i++] = priv->dp_port_num;
997                 buf[i++] = arg;
998                 buf[i++] = 0;
999         }
1000         /* set word size */
1001         if ((cflag&CSIZE) != (old_cflag&CSIZE)) {
1002                 arg = -1;
1003                 switch (cflag&CSIZE) {
1004                 case CS5: arg = DIGI_WORD_SIZE_5; break;
1005                 case CS6: arg = DIGI_WORD_SIZE_6; break;
1006                 case CS7: arg = DIGI_WORD_SIZE_7; break;
1007                 case CS8: arg = DIGI_WORD_SIZE_8; break;
1008                 default:
1009                         dbg("digi_set_termios: can't handle word size %d",
1010                                 (cflag&CSIZE));
1011                         break;
1012                 }
1013
1014                 if (arg != -1) {
1015                         buf[i++] = DIGI_CMD_SET_WORD_SIZE;
1016                         buf[i++] = priv->dp_port_num;
1017                         buf[i++] = arg;
1018                         buf[i++] = 0;
1019                 }
1020
1021         }
1022
1023         /* set stop bits */
1024         if ((cflag&CSTOPB) != (old_cflag&CSTOPB)) {
1025
1026                 if ((cflag&CSTOPB))
1027                         arg = DIGI_STOP_BITS_2;
1028                 else
1029                         arg = DIGI_STOP_BITS_1;
1030
1031                 buf[i++] = DIGI_CMD_SET_STOP_BITS;
1032                 buf[i++] = priv->dp_port_num;
1033                 buf[i++] = arg;
1034                 buf[i++] = 0;
1035
1036         }
1037
1038         /* set input flow control */
1039         if ((iflag&IXOFF) != (old_iflag&IXOFF)
1040             || (cflag&CRTSCTS) != (old_cflag&CRTSCTS)) {
1041                 arg = 0;
1042                 if (iflag&IXOFF)
1043                         arg |= DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
1044                 else
1045                         arg &= ~DIGI_INPUT_FLOW_CONTROL_XON_XOFF;
1046
1047                 if (cflag&CRTSCTS) {
1048                         arg |= DIGI_INPUT_FLOW_CONTROL_RTS;
1049
1050                         /* On USB-4 it is necessary to assert RTS prior */
1051                         /* to selecting RTS input flow control.  */
1052                         buf[i++] = DIGI_CMD_SET_RTS_SIGNAL;
1053                         buf[i++] = priv->dp_port_num;
1054                         buf[i++] = DIGI_RTS_ACTIVE;
1055                         buf[i++] = 0;
1056
1057                 } else {
1058                         arg &= ~DIGI_INPUT_FLOW_CONTROL_RTS;
1059                 }
1060                 buf[i++] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1061                 buf[i++] = priv->dp_port_num;
1062                 buf[i++] = arg;
1063                 buf[i++] = 0;
1064         }
1065
1066         /* set output flow control */
1067         if ((iflag & IXON) != (old_iflag & IXON)
1068             || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
1069                 arg = 0;
1070                 if (iflag & IXON)
1071                         arg |= DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
1072                 else
1073                         arg &= ~DIGI_OUTPUT_FLOW_CONTROL_XON_XOFF;
1074
1075                 if (cflag & CRTSCTS) {
1076                         arg |= DIGI_OUTPUT_FLOW_CONTROL_CTS;
1077                 } else {
1078                         arg &= ~DIGI_OUTPUT_FLOW_CONTROL_CTS;
1079                         tty->hw_stopped = 0;
1080                 }
1081
1082                 buf[i++] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1083                 buf[i++] = priv->dp_port_num;
1084                 buf[i++] = arg;
1085                 buf[i++] = 0;
1086         }
1087
1088         /* set receive enable/disable */
1089         if ((cflag & CREAD) != (old_cflag & CREAD)) {
1090                 if (cflag & CREAD)
1091                         arg = DIGI_ENABLE;
1092                 else
1093                         arg = DIGI_DISABLE;
1094
1095                 buf[i++] = DIGI_CMD_RECEIVE_ENABLE;
1096                 buf[i++] = priv->dp_port_num;
1097                 buf[i++] = arg;
1098                 buf[i++] = 0;
1099         }
1100         ret = digi_write_oob_command(port, buf, i, 1);
1101         if (ret != 0)
1102                 dbg("digi_set_termios: write oob failed, ret=%d", ret);
1103         tty_encode_baud_rate(tty, baud, baud);
1104 }
1105
1106
1107 static void digi_break_ctl(struct tty_struct *tty, int break_state)
1108 {
1109         struct usb_serial_port *port = tty->driver_data;
1110         unsigned char buf[4];
1111
1112         buf[0] = DIGI_CMD_BREAK_CONTROL;
1113         buf[1] = 2;                             /* length */
1114         buf[2] = break_state ? 1 : 0;
1115         buf[3] = 0;                             /* pad */
1116         digi_write_inb_command(port, buf, 4, 0);
1117 }
1118
1119
1120 static int digi_tiocmget(struct tty_struct *tty, struct file *file)
1121 {
1122         struct usb_serial_port *port = tty->driver_data;
1123         struct digi_port *priv = usb_get_serial_port_data(port);
1124         unsigned int val;
1125         unsigned long flags;
1126
1127         dbg("%s: TOP: port=%d", __func__, priv->dp_port_num);
1128
1129         spin_lock_irqsave(&priv->dp_port_lock, flags);
1130         val = priv->dp_modem_signals;
1131         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1132         return val;
1133 }
1134
1135
1136 static int digi_tiocmset(struct tty_struct *tty, struct file *file,
1137         unsigned int set, unsigned int clear)
1138 {
1139         struct usb_serial_port *port = tty->driver_data;
1140         struct digi_port *priv = usb_get_serial_port_data(port);
1141         unsigned int val;
1142         unsigned long flags;
1143
1144         dbg("%s: TOP: port=%d", __func__, priv->dp_port_num);
1145
1146         spin_lock_irqsave(&priv->dp_port_lock, flags);
1147         val = (priv->dp_modem_signals & ~clear) | set;
1148         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1149         return digi_set_modem_signals(port, val, 1);
1150 }
1151
1152
1153 static int digi_write(struct tty_struct *tty, struct usb_serial_port *port,
1154                                         const unsigned char *buf, int count)
1155 {
1156
1157         int ret, data_len, new_len;
1158         struct digi_port *priv = usb_get_serial_port_data(port);
1159         unsigned char *data = port->write_urb->transfer_buffer;
1160         unsigned long flags = 0;
1161
1162         dbg("digi_write: TOP: port=%d, count=%d, in_interrupt=%ld",
1163                 priv->dp_port_num, count, in_interrupt());
1164
1165         /* copy user data (which can sleep) before getting spin lock */
1166         count = min(count, port->bulk_out_size-2);
1167         count = min(64, count);
1168
1169         /* be sure only one write proceeds at a time */
1170         /* there are races on the port private buffer */
1171         /* and races to check write_urb->status */
1172         spin_lock_irqsave(&priv->dp_port_lock, flags);
1173
1174         /* wait for urb status clear to submit another urb */
1175         if (port->write_urb->status == -EINPROGRESS ||
1176                                         priv->dp_write_urb_in_use) {
1177                 /* buffer data if count is 1 (probably put_char) if possible */
1178                 if (count == 1 && priv->dp_out_buf_len < DIGI_OUT_BUF_SIZE) {
1179                         priv->dp_out_buf[priv->dp_out_buf_len++] = *buf;
1180                         new_len = 1;
1181                 } else {
1182                         new_len = 0;
1183                 }
1184                 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1185                 return new_len;
1186         }
1187
1188         /* allow space for any buffered data and for new data, up to */
1189         /* transfer buffer size - 2 (for command and length bytes) */
1190         new_len = min(count, port->bulk_out_size-2-priv->dp_out_buf_len);
1191         data_len = new_len + priv->dp_out_buf_len;
1192
1193         if (data_len == 0) {
1194                 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1195                 return 0;
1196         }
1197
1198         port->write_urb->transfer_buffer_length = data_len+2;
1199         port->write_urb->dev = port->serial->dev;
1200
1201         *data++ = DIGI_CMD_SEND_DATA;
1202         *data++ = data_len;
1203
1204         /* copy in buffered data first */
1205         memcpy(data, priv->dp_out_buf, priv->dp_out_buf_len);
1206         data += priv->dp_out_buf_len;
1207
1208         /* copy in new data */
1209         memcpy(data, buf, new_len);
1210
1211         ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1212         if (ret == 0) {
1213                 priv->dp_write_urb_in_use = 1;
1214                 ret = new_len;
1215                 priv->dp_out_buf_len = 0;
1216         }
1217
1218         /* return length of new data written, or error */
1219         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1220         if (ret < 0)
1221                 dev_err(&port->dev,
1222                         "%s: usb_submit_urb failed, ret=%d, port=%d\n",
1223                         __func__, ret, priv->dp_port_num);
1224         dbg("digi_write: returning %d", ret);
1225         return ret;
1226
1227 }
1228
1229 static void digi_write_bulk_callback(struct urb *urb)
1230 {
1231
1232         struct usb_serial_port *port = urb->context;
1233         struct usb_serial *serial;
1234         struct digi_port *priv;
1235         struct digi_serial *serial_priv;
1236         int ret = 0;
1237         int status = urb->status;
1238
1239         dbg("digi_write_bulk_callback: TOP, urb->status=%d", status);
1240
1241         /* port and serial sanity check */
1242         if (port == NULL || (priv = usb_get_serial_port_data(port)) == NULL) {
1243                 dev_err(&port->dev,
1244                         "%s: port or port->private is NULL, status=%d\n",
1245                         __func__, status);
1246                 return;
1247         }
1248         serial = port->serial;
1249         if (serial == NULL || (serial_priv = usb_get_serial_data(serial)) == NULL) {
1250                 dev_err(&port->dev,
1251                         "%s: serial or serial->private is NULL, status=%d\n",
1252                         __func__, status);
1253                 return;
1254         }
1255
1256         /* handle oob callback */
1257         if (priv->dp_port_num == serial_priv->ds_oob_port_num) {
1258                 dbg("digi_write_bulk_callback: oob callback");
1259                 spin_lock(&priv->dp_port_lock);
1260                 priv->dp_write_urb_in_use = 0;
1261                 wake_up_interruptible(&port->write_wait);
1262                 spin_unlock(&priv->dp_port_lock);
1263                 return;
1264         }
1265
1266         /* try to send any buffered data on this port, if it is open */
1267         spin_lock(&priv->dp_port_lock);
1268         priv->dp_write_urb_in_use = 0;
1269         if (port->port.count && port->write_urb->status != -EINPROGRESS
1270             && priv->dp_out_buf_len > 0) {
1271                 *((unsigned char *)(port->write_urb->transfer_buffer))
1272                         = (unsigned char)DIGI_CMD_SEND_DATA;
1273                 *((unsigned char *)(port->write_urb->transfer_buffer) + 1)
1274                         = (unsigned char)priv->dp_out_buf_len;
1275                 port->write_urb->transfer_buffer_length =
1276                                                 priv->dp_out_buf_len + 2;
1277                 port->write_urb->dev = serial->dev;
1278                 memcpy(port->write_urb->transfer_buffer + 2, priv->dp_out_buf,
1279                         priv->dp_out_buf_len);
1280                 ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1281                 if (ret == 0) {
1282                         priv->dp_write_urb_in_use = 1;
1283                         priv->dp_out_buf_len = 0;
1284                 }
1285         }
1286         /* wake up processes sleeping on writes immediately */
1287         digi_wakeup_write(port);
1288         /* also queue up a wakeup at scheduler time, in case we */
1289         /* lost the race in write_chan(). */
1290         schedule_work(&priv->dp_wakeup_work);
1291
1292         spin_unlock(&priv->dp_port_lock);
1293         if (ret)
1294                 dev_err(&port->dev,
1295                         "%s: usb_submit_urb failed, ret=%d, port=%d\n",
1296                         __func__, ret, priv->dp_port_num);
1297 }
1298
1299 static int digi_write_room(struct tty_struct *tty)
1300 {
1301         struct usb_serial_port *port = tty->driver_data;
1302         struct digi_port *priv = usb_get_serial_port_data(port);
1303         int room;
1304         unsigned long flags = 0;
1305
1306         spin_lock_irqsave(&priv->dp_port_lock, flags);
1307
1308         if (port->write_urb->status == -EINPROGRESS ||
1309                                         priv->dp_write_urb_in_use)
1310                 room = 0;
1311         else
1312                 room = port->bulk_out_size - 2 - priv->dp_out_buf_len;
1313
1314         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1315         dbg("digi_write_room: port=%d, room=%d", priv->dp_port_num, room);
1316         return room;
1317
1318 }
1319
1320 static int digi_chars_in_buffer(struct tty_struct *tty)
1321 {
1322         struct usb_serial_port *port = tty->driver_data;
1323         struct digi_port *priv = usb_get_serial_port_data(port);
1324
1325         if (port->write_urb->status == -EINPROGRESS
1326             || priv->dp_write_urb_in_use) {
1327                 dbg("digi_chars_in_buffer: port=%d, chars=%d",
1328                         priv->dp_port_num, port->bulk_out_size - 2);
1329                 /* return(port->bulk_out_size - 2); */
1330                 return 256;
1331         } else {
1332                 dbg("digi_chars_in_buffer: port=%d, chars=%d",
1333                         priv->dp_port_num, priv->dp_out_buf_len);
1334                 return priv->dp_out_buf_len;
1335         }
1336
1337 }
1338
1339
1340 static int digi_open(struct tty_struct *tty, struct usb_serial_port *port,
1341                                 struct file *filp)
1342 {
1343         int ret;
1344         unsigned char buf[32];
1345         struct digi_port *priv = usb_get_serial_port_data(port);
1346         struct ktermios not_termios;
1347         unsigned long flags = 0;
1348
1349         dbg("digi_open: TOP: port=%d, open_count=%d",
1350                 priv->dp_port_num, port->port.count);
1351
1352         /* be sure the device is started up */
1353         if (digi_startup_device(port->serial) != 0)
1354                 return -ENXIO;
1355
1356         spin_lock_irqsave(&priv->dp_port_lock, flags);
1357
1358         /* don't wait on a close in progress for non-blocking opens */
1359         if (priv->dp_in_close && (filp->f_flags&(O_NDELAY|O_NONBLOCK)) == 0) {
1360                 spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1361                 return -EAGAIN;
1362         }
1363
1364         /* wait for a close in progress to finish */
1365         while (priv->dp_in_close) {
1366                 cond_wait_interruptible_timeout_irqrestore(
1367                         &priv->dp_close_wait, DIGI_RETRY_TIMEOUT,
1368                         &priv->dp_port_lock, flags);
1369                 if (signal_pending(current))
1370                         return -EINTR;
1371                 spin_lock_irqsave(&priv->dp_port_lock, flags);
1372         }
1373
1374         spin_unlock_irqrestore(&priv->dp_port_lock, flags);
1375
1376         /* read modem signals automatically whenever they change */
1377         buf[0] = DIGI_CMD_READ_INPUT_SIGNALS;
1378         buf[1] = priv->dp_port_num;
1379         buf[2] = DIGI_ENABLE;
1380         buf[3] = 0;
1381
1382         /* flush fifos */
1383         buf[4] = DIGI_CMD_IFLUSH_FIFO;
1384         buf[5] = priv->dp_port_num;
1385         buf[6] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1386         buf[7] = 0;
1387
1388         ret = digi_write_oob_command(port, buf, 8, 1);
1389         if (ret != 0)
1390                 dbg("digi_open: write oob failed, ret=%d", ret);
1391
1392         /* set termios settings */
1393         if (tty) {
1394                 not_termios.c_cflag = ~tty->termios->c_cflag;
1395                 not_termios.c_iflag = ~tty->termios->c_iflag;
1396                 digi_set_termios(tty, port, &not_termios);
1397         }
1398
1399         /* set DTR and RTS */
1400         digi_set_modem_signals(port, TIOCM_DTR|TIOCM_RTS, 1);
1401
1402         return 0;
1403 }
1404
1405
1406 static void digi_close(struct tty_struct *tty, struct usb_serial_port *port,
1407                                 struct file *filp)
1408 {
1409         DEFINE_WAIT(wait);
1410         int ret;
1411         unsigned char buf[32];
1412         struct digi_port *priv = usb_get_serial_port_data(port);
1413
1414         dbg("digi_close: TOP: port=%d, open_count=%d",
1415                 priv->dp_port_num, port->port.count);
1416
1417         mutex_lock(&port->serial->disc_mutex);
1418         /* if disconnected, just clear flags */
1419         if (port->serial->disconnected)
1420                 goto exit;
1421
1422         /* do cleanup only after final close on this port */
1423         spin_lock_irq(&priv->dp_port_lock);
1424         priv->dp_in_close = 1;
1425         spin_unlock_irq(&priv->dp_port_lock);
1426
1427         /* tell line discipline to process only XON/XOFF */
1428         tty->closing = 1;
1429
1430         /* wait for output to drain */
1431         if ((filp->f_flags&(O_NDELAY|O_NONBLOCK)) == 0)
1432                 tty_wait_until_sent(tty, DIGI_CLOSE_TIMEOUT);
1433
1434         /* flush driver and line discipline buffers */
1435         tty_driver_flush_buffer(tty);
1436         tty_ldisc_flush(tty);
1437
1438         if (port->serial->dev) {
1439                 /* wait for transmit idle */
1440                 if ((filp->f_flags&(O_NDELAY|O_NONBLOCK)) == 0)
1441                         digi_transmit_idle(port, DIGI_CLOSE_TIMEOUT);
1442                 /* drop DTR and RTS */
1443                 digi_set_modem_signals(port, 0, 0);
1444
1445                 /* disable input flow control */
1446                 buf[0] = DIGI_CMD_SET_INPUT_FLOW_CONTROL;
1447                 buf[1] = priv->dp_port_num;
1448                 buf[2] = DIGI_DISABLE;
1449                 buf[3] = 0;
1450
1451                 /* disable output flow control */
1452                 buf[4] = DIGI_CMD_SET_OUTPUT_FLOW_CONTROL;
1453                 buf[5] = priv->dp_port_num;
1454                 buf[6] = DIGI_DISABLE;
1455                 buf[7] = 0;
1456
1457                 /* disable reading modem signals automatically */
1458                 buf[8] = DIGI_CMD_READ_INPUT_SIGNALS;
1459                 buf[9] = priv->dp_port_num;
1460                 buf[10] = DIGI_DISABLE;
1461                 buf[11] = 0;
1462
1463                 /* disable receive */
1464                 buf[12] = DIGI_CMD_RECEIVE_ENABLE;
1465                 buf[13] = priv->dp_port_num;
1466                 buf[14] = DIGI_DISABLE;
1467                 buf[15] = 0;
1468
1469                 /* flush fifos */
1470                 buf[16] = DIGI_CMD_IFLUSH_FIFO;
1471                 buf[17] = priv->dp_port_num;
1472                 buf[18] = DIGI_FLUSH_TX | DIGI_FLUSH_RX;
1473                 buf[19] = 0;
1474
1475                 ret = digi_write_oob_command(port, buf, 20, 0);
1476                 if (ret != 0)
1477                         dbg("digi_close: write oob failed, ret=%d", ret);
1478
1479                 /* wait for final commands on oob port to complete */
1480                 prepare_to_wait(&priv->dp_flush_wait, &wait,
1481                                                         TASK_INTERRUPTIBLE);
1482                 schedule_timeout(DIGI_CLOSE_TIMEOUT);
1483                 finish_wait(&priv->dp_flush_wait, &wait);
1484
1485                 /* shutdown any outstanding bulk writes */
1486                 usb_kill_urb(port->write_urb);
1487         }
1488         tty->closing = 0;
1489 exit:
1490         spin_lock_irq(&priv->dp_port_lock);
1491         priv->dp_write_urb_in_use = 0;
1492         priv->dp_in_close = 0;
1493         wake_up_interruptible(&priv->dp_close_wait);
1494         spin_unlock_irq(&priv->dp_port_lock);
1495         mutex_unlock(&port->serial->disc_mutex);
1496         dbg("digi_close: done");
1497 }
1498
1499
1500 /*
1501  *  Digi Startup Device
1502  *
1503  *  Starts reads on all ports.  Must be called AFTER startup, with
1504  *  urbs initialized.  Returns 0 if successful, non-zero error otherwise.
1505  */
1506
1507 static int digi_startup_device(struct usb_serial *serial)
1508 {
1509         int i, ret = 0;
1510         struct digi_serial *serial_priv = usb_get_serial_data(serial);
1511         struct usb_serial_port *port;
1512
1513         /* be sure this happens exactly once */
1514         spin_lock(&serial_priv->ds_serial_lock);
1515         if (serial_priv->ds_device_started) {
1516                 spin_unlock(&serial_priv->ds_serial_lock);
1517                 return 0;
1518         }
1519         serial_priv->ds_device_started = 1;
1520         spin_unlock(&serial_priv->ds_serial_lock);
1521
1522         /* start reading from each bulk in endpoint for the device */
1523         /* set USB_DISABLE_SPD flag for write bulk urbs */
1524         for (i = 0; i < serial->type->num_ports + 1; i++) {
1525                 port = serial->port[i];
1526                 port->write_urb->dev = port->serial->dev;
1527                 ret = usb_submit_urb(port->read_urb, GFP_KERNEL);
1528                 if (ret != 0) {
1529                         dev_err(&port->dev,
1530                                 "%s: usb_submit_urb failed, ret=%d, port=%d\n",
1531                                 __func__, ret, i);
1532                         break;
1533                 }
1534         }
1535         return ret;
1536 }
1537
1538
1539 static int digi_startup(struct usb_serial *serial)
1540 {
1541
1542         int i;
1543         struct digi_port *priv;
1544         struct digi_serial *serial_priv;
1545
1546         dbg("digi_startup: TOP");
1547
1548         /* allocate the private data structures for all ports */
1549         /* number of regular ports + 1 for the out-of-band port */
1550         for (i = 0; i < serial->type->num_ports + 1; i++) {
1551                 /* allocate port private structure */
1552                 priv = kmalloc(sizeof(struct digi_port), GFP_KERNEL);
1553                 if (priv == NULL) {
1554                         while (--i >= 0)
1555                                 kfree(usb_get_serial_port_data(serial->port[i]));
1556                         return 1;                       /* error */
1557                 }
1558
1559                 /* initialize port private structure */
1560                 spin_lock_init(&priv->dp_port_lock);
1561                 priv->dp_port_num = i;
1562                 priv->dp_out_buf_len = 0;
1563                 priv->dp_write_urb_in_use = 0;
1564                 priv->dp_modem_signals = 0;
1565                 init_waitqueue_head(&priv->dp_modem_change_wait);
1566                 priv->dp_transmit_idle = 0;
1567                 init_waitqueue_head(&priv->dp_transmit_idle_wait);
1568                 priv->dp_throttled = 0;
1569                 priv->dp_throttle_restart = 0;
1570                 init_waitqueue_head(&priv->dp_flush_wait);
1571                 priv->dp_in_close = 0;
1572                 init_waitqueue_head(&priv->dp_close_wait);
1573                 INIT_WORK(&priv->dp_wakeup_work, digi_wakeup_write_lock);
1574                 priv->dp_port = serial->port[i];
1575                 /* initialize write wait queue for this port */
1576                 init_waitqueue_head(&serial->port[i]->write_wait);
1577
1578                 usb_set_serial_port_data(serial->port[i], priv);
1579         }
1580
1581         /* allocate serial private structure */
1582         serial_priv = kmalloc(sizeof(struct digi_serial), GFP_KERNEL);
1583         if (serial_priv == NULL) {
1584                 for (i = 0; i < serial->type->num_ports + 1; i++)
1585                         kfree(usb_get_serial_port_data(serial->port[i]));
1586                 return 1;                       /* error */
1587         }
1588
1589         /* initialize serial private structure */
1590         spin_lock_init(&serial_priv->ds_serial_lock);
1591         serial_priv->ds_oob_port_num = serial->type->num_ports;
1592         serial_priv->ds_oob_port = serial->port[serial_priv->ds_oob_port_num];
1593         serial_priv->ds_device_started = 0;
1594         usb_set_serial_data(serial, serial_priv);
1595
1596         return 0;
1597 }
1598
1599
1600 static void digi_shutdown(struct usb_serial *serial)
1601 {
1602         int i;
1603         dbg("digi_shutdown: TOP, in_interrupt()=%ld", in_interrupt());
1604
1605         /* stop reads and writes on all ports */
1606         for (i = 0; i < serial->type->num_ports + 1; i++) {
1607                 usb_kill_urb(serial->port[i]->read_urb);
1608                 usb_kill_urb(serial->port[i]->write_urb);
1609         }
1610
1611         /* free the private data structures for all ports */
1612         /* number of regular ports + 1 for the out-of-band port */
1613         for (i = 0; i < serial->type->num_ports + 1; i++)
1614                 kfree(usb_get_serial_port_data(serial->port[i]));
1615         kfree(usb_get_serial_data(serial));
1616 }
1617
1618
1619 static void digi_read_bulk_callback(struct urb *urb)
1620 {
1621         struct usb_serial_port *port = urb->context;
1622         struct digi_port *priv;
1623         struct digi_serial *serial_priv;
1624         int ret;
1625         int status = urb->status;
1626
1627         dbg("digi_read_bulk_callback: TOP");
1628
1629         /* port sanity check, do not resubmit if port is not valid */
1630         if (port == NULL)
1631                 return;
1632         priv = usb_get_serial_port_data(port);
1633         if (priv == NULL) {
1634                 dev_err(&port->dev, "%s: port->private is NULL, status=%d\n",
1635                         __func__, status);
1636                 return;
1637         }
1638         if (port->serial == NULL ||
1639                 (serial_priv = usb_get_serial_data(port->serial)) == NULL) {
1640                 dev_err(&port->dev, "%s: serial is bad or serial->private "
1641                         "is NULL, status=%d\n", __func__, status);
1642                 return;
1643         }
1644
1645         /* do not resubmit urb if it has any status error */
1646         if (status) {
1647                 dev_err(&port->dev,
1648                         "%s: nonzero read bulk status: status=%d, port=%d\n",
1649                         __func__, status, priv->dp_port_num);
1650                 return;
1651         }
1652
1653         /* handle oob or inb callback, do not resubmit if error */
1654         if (priv->dp_port_num == serial_priv->ds_oob_port_num) {
1655                 if (digi_read_oob_callback(urb) != 0)
1656                         return;
1657         } else {
1658                 if (digi_read_inb_callback(urb) != 0)
1659                         return;
1660         }
1661
1662         /* continue read */
1663         urb->dev = port->serial->dev;
1664         ret = usb_submit_urb(urb, GFP_ATOMIC);
1665         if (ret != 0) {
1666                 dev_err(&port->dev,
1667                         "%s: failed resubmitting urb, ret=%d, port=%d\n",
1668                         __func__, ret, priv->dp_port_num);
1669         }
1670
1671 }
1672
1673 /*
1674  *  Digi Read INB Callback
1675  *
1676  *  Digi Read INB Callback handles reads on the in band ports, sending
1677  *  the data on to the tty subsystem.  When called we know port and
1678  *  port->private are not NULL and port->serial has been validated.
1679  *  It returns 0 if successful, 1 if successful but the port is
1680  *  throttled, and -1 if the sanity checks failed.
1681  */
1682
1683 static int digi_read_inb_callback(struct urb *urb)
1684 {
1685
1686         struct usb_serial_port *port = urb->context;
1687         struct tty_struct *tty;
1688         struct digi_port *priv = usb_get_serial_port_data(port);
1689         int opcode = ((unsigned char *)urb->transfer_buffer)[0];
1690         int len = ((unsigned char *)urb->transfer_buffer)[1];
1691         int port_status = ((unsigned char *)urb->transfer_buffer)[2];
1692         unsigned char *data = ((unsigned char *)urb->transfer_buffer) + 3;
1693         int flag, throttled;
1694         int i;
1695         int status = urb->status;
1696
1697         /* do not process callbacks on closed ports */
1698         /* but do continue the read chain */
1699         if (port->port.count == 0)
1700                 return 0;
1701
1702         /* short/multiple packet check */
1703         if (urb->actual_length != len + 2) {
1704                 dev_err(&port->dev, "%s: INCOMPLETE OR MULTIPLE PACKET, "
1705                         "urb->status=%d, port=%d, opcode=%d, len=%d, "
1706                         "actual_length=%d, status=%d\n", __func__, status,
1707                         priv->dp_port_num, opcode, len, urb->actual_length,
1708                         port_status);
1709                 return -1;
1710         }
1711
1712         tty = tty_port_tty_get(&port->port);
1713         spin_lock(&priv->dp_port_lock);
1714
1715         /* check for throttle; if set, do not resubmit read urb */
1716         /* indicate the read chain needs to be restarted on unthrottle */
1717         throttled = priv->dp_throttled;
1718         if (throttled)
1719                 priv->dp_throttle_restart = 1;
1720
1721         /* receive data */
1722         if (opcode == DIGI_CMD_RECEIVE_DATA) {
1723                 /* get flag from port_status */
1724                 flag = 0;
1725
1726                 /* overrun is special, not associated with a char */
1727                 if (port_status & DIGI_OVERRUN_ERROR)
1728                         tty_insert_flip_char(tty, 0, TTY_OVERRUN);
1729
1730                 /* break takes precedence over parity, */
1731                 /* which takes precedence over framing errors */
1732                 if (port_status & DIGI_BREAK_ERROR)
1733                         flag = TTY_BREAK;
1734                 else if (port_status & DIGI_PARITY_ERROR)
1735                         flag = TTY_PARITY;
1736                 else if (port_status & DIGI_FRAMING_ERROR)
1737                         flag = TTY_FRAME;
1738
1739                 /* data length is len-1 (one byte of len is port_status) */
1740                 --len;
1741
1742                 len = tty_buffer_request_room(tty, len);
1743                 if (len > 0) {
1744                         /* Hot path */
1745                         if (flag == TTY_NORMAL)
1746                                 tty_insert_flip_string(tty, data, len);
1747                         else {
1748                                 for (i = 0; i < len; i++)
1749                                         tty_insert_flip_char(tty,
1750                                                                 data[i], flag);
1751                         }
1752                         tty_flip_buffer_push(tty);
1753                 }
1754         }
1755         spin_unlock(&priv->dp_port_lock);
1756         tty_kref_put(tty);
1757
1758         if (opcode == DIGI_CMD_RECEIVE_DISABLE)
1759                 dbg("%s: got RECEIVE_DISABLE", __func__);
1760         else if (opcode != DIGI_CMD_RECEIVE_DATA)
1761                 dbg("%s: unknown opcode: %d", __func__, opcode);
1762
1763         return throttled ? 1 : 0;
1764
1765 }
1766
1767
1768 /*
1769  *  Digi Read OOB Callback
1770  *
1771  *  Digi Read OOB Callback handles reads on the out of band port.
1772  *  When called we know port and port->private are not NULL and
1773  *  the port->serial is valid.  It returns 0 if successful, and
1774  *  -1 if the sanity checks failed.
1775  */
1776
1777 static int digi_read_oob_callback(struct urb *urb)
1778 {
1779
1780         struct usb_serial_port *port = urb->context;
1781         struct usb_serial *serial = port->serial;
1782         struct tty_struct *tty;
1783         struct digi_port *priv = usb_get_serial_port_data(port);
1784         int opcode, line, status, val;
1785         int i;
1786         unsigned int rts;
1787
1788         dbg("digi_read_oob_callback: port=%d, len=%d",
1789                         priv->dp_port_num, urb->actual_length);
1790
1791         /* handle each oob command */
1792         for (i = 0; i < urb->actual_length - 3;) {
1793                 opcode = ((unsigned char *)urb->transfer_buffer)[i++];
1794                 line = ((unsigned char *)urb->transfer_buffer)[i++];
1795                 status = ((unsigned char *)urb->transfer_buffer)[i++];
1796                 val = ((unsigned char *)urb->transfer_buffer)[i++];
1797
1798                 dbg("digi_read_oob_callback: opcode=%d, line=%d, status=%d, val=%d",
1799                         opcode, line, status, val);
1800
1801                 if (status != 0 || line >= serial->type->num_ports)
1802                         continue;
1803
1804                 port = serial->port[line];
1805
1806                 priv = usb_get_serial_port_data(port);
1807                 if (priv == NULL)
1808                         return -1;
1809
1810                 tty = tty_port_tty_get(&port->port);
1811                 rts = 0;
1812                 if (port->port.count)
1813                         rts = tty->termios->c_cflag & CRTSCTS;
1814                 
1815                 if (opcode == DIGI_CMD_READ_INPUT_SIGNALS) {
1816                         spin_lock(&priv->dp_port_lock);
1817                         /* convert from digi flags to termiox flags */
1818                         if (val & DIGI_READ_INPUT_SIGNALS_CTS) {
1819                                 priv->dp_modem_signals |= TIOCM_CTS;
1820                                 /* port must be open to use tty struct */
1821                                 if (rts) {
1822                                         tty->hw_stopped = 0;
1823                                         digi_wakeup_write(port);
1824                                 }
1825                         } else {
1826                                 priv->dp_modem_signals &= ~TIOCM_CTS;
1827                                 /* port must be open to use tty struct */
1828                                 if (rts)
1829                                         tty->hw_stopped = 1;
1830                         }
1831                         if (val & DIGI_READ_INPUT_SIGNALS_DSR)
1832                                 priv->dp_modem_signals |= TIOCM_DSR;
1833                         else
1834                                 priv->dp_modem_signals &= ~TIOCM_DSR;
1835                         if (val & DIGI_READ_INPUT_SIGNALS_RI)
1836                                 priv->dp_modem_signals |= TIOCM_RI;
1837                         else
1838                                 priv->dp_modem_signals &= ~TIOCM_RI;
1839                         if (val & DIGI_READ_INPUT_SIGNALS_DCD)
1840                                 priv->dp_modem_signals |= TIOCM_CD;
1841                         else
1842                                 priv->dp_modem_signals &= ~TIOCM_CD;
1843
1844                         wake_up_interruptible(&priv->dp_modem_change_wait);
1845                         spin_unlock(&priv->dp_port_lock);
1846                 } else if (opcode == DIGI_CMD_TRANSMIT_IDLE) {
1847                         spin_lock(&priv->dp_port_lock);
1848                         priv->dp_transmit_idle = 1;
1849                         wake_up_interruptible(&priv->dp_transmit_idle_wait);
1850                         spin_unlock(&priv->dp_port_lock);
1851                 } else if (opcode == DIGI_CMD_IFLUSH_FIFO) {
1852                         wake_up_interruptible(&priv->dp_flush_wait);
1853                 }
1854                 tty_kref_put(tty);
1855         }
1856         return 0;
1857
1858 }
1859
1860 static int __init digi_init(void)
1861 {
1862         int retval;
1863         retval = usb_serial_register(&digi_acceleport_2_device);
1864         if (retval)
1865                 goto failed_acceleport_2_device;
1866         retval = usb_serial_register(&digi_acceleport_4_device);
1867         if (retval)
1868                 goto failed_acceleport_4_device;
1869         retval = usb_register(&digi_driver);
1870         if (retval)
1871                 goto failed_usb_register;
1872         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1873                DRIVER_DESC "\n");
1874         return 0;
1875 failed_usb_register:
1876         usb_serial_deregister(&digi_acceleport_4_device);
1877 failed_acceleport_4_device:
1878         usb_serial_deregister(&digi_acceleport_2_device);
1879 failed_acceleport_2_device:
1880         return retval;
1881 }
1882
1883 static void __exit digi_exit (void)
1884 {
1885         usb_deregister(&digi_driver);
1886         usb_serial_deregister(&digi_acceleport_2_device);
1887         usb_serial_deregister(&digi_acceleport_4_device);
1888 }
1889
1890
1891 module_init(digi_init);
1892 module_exit(digi_exit);
1893
1894
1895 MODULE_AUTHOR(DRIVER_AUTHOR);
1896 MODULE_DESCRIPTION(DRIVER_DESC);
1897 MODULE_LICENSE("GPL");
1898
1899 module_param(debug, bool, S_IRUGO | S_IWUSR);
1900 MODULE_PARM_DESC(debug, "Debug enabled or not");