Merge branch 'upstream-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jgarzi...
[linux-2.6] / drivers / usb / serial / whiteheat.c
1 /*
2  * USB ConnectTech WhiteHEAT driver
3  *
4  *      Copyright (C) 2002
5  *          Connect Tech Inc.
6  *
7  *      Copyright (C) 1999 - 2001
8  *          Greg Kroah-Hartman (greg@kroah.com)
9  *
10  *      This program is free software; you can redistribute it and/or modify
11  *      it under the terms of the GNU General Public License as published by
12  *      the Free Software Foundation; either version 2 of the License, or
13  *      (at your option) any later version.
14  *
15  * See Documentation/usb/usb-serial.txt for more information on using this driver
16  *
17  * (10/09/2002) Stuart MacDonald (stuartm@connecttech.com)
18  *      Upgrade to full working driver
19  *
20  * (05/30/2001) gkh
21  *      switched from using spinlock to a semaphore, which fixes lots of problems.
22  *
23  * (04/08/2001) gb
24  *      Identify version on module load.
25  * 
26  * 2001_Mar_19 gkh
27  *      Fixed MOD_INC and MOD_DEC logic, the ability to open a port more 
28  *      than once, and the got the proper usb_device_id table entries so
29  *      the driver works again.
30  *
31  * (11/01/2000) Adam J. Richter
32  *      usb_device_id table support
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  * (10/03/2000) smd
39  *      firmware is improved to guard against crap sent to device
40  *      firmware now replies CMD_FAILURE on bad things
41  *      read_callback fix you provided for private info struct
42  *      command_finished now indicates success or fail
43  *      setup_port struct now packed to avoid gcc padding
44  *      firmware uses 1 based port numbering, driver now handles that
45  *
46  * (09/11/2000) gkh
47  *      Removed DEBUG #ifdefs with call to usb_serial_debug_data
48  *
49  * (07/19/2000) gkh
50  *      Added module_init and module_exit functions to handle the fact that this
51  *      driver is a loadable module now.
52  *      Fixed bug with port->minor that was found by Al Borchers
53  *
54  * (07/04/2000) gkh
55  *      Added support for port settings. Baud rate can now be changed. Line signals
56  *      are not transferred to and from the tty layer yet, but things seem to be 
57  *      working well now.
58  *
59  * (05/04/2000) gkh
60  *      First cut at open and close commands. Data can flow through the ports at
61  *      default speeds now.
62  *
63  * (03/26/2000) gkh
64  *      Split driver up into device specific pieces.
65  * 
66  */
67
68 #include <linux/kernel.h>
69 #include <linux/errno.h>
70 #include <linux/init.h>
71 #include <linux/slab.h>
72 #include <linux/tty.h>
73 #include <linux/tty_driver.h>
74 #include <linux/tty_flip.h>
75 #include <linux/module.h>
76 #include <linux/spinlock.h>
77 #include <linux/mutex.h>
78 #include <asm/uaccess.h>
79 #include <asm/termbits.h>
80 #include <linux/usb.h>
81 #include <linux/serial_reg.h>
82 #include <linux/serial.h>
83 #include <linux/usb/serial.h>
84 #include "whiteheat_fw.h"               /* firmware for the ConnectTech WhiteHEAT device */
85 #include "whiteheat.h"                  /* WhiteHEAT specific commands */
86
87 static int debug;
88
89 #ifndef CMSPAR
90 #define CMSPAR 0
91 #endif
92
93 /*
94  * Version Information
95  */
96 #define DRIVER_VERSION "v2.0"
97 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Stuart MacDonald <stuartm@connecttech.com>"
98 #define DRIVER_DESC "USB ConnectTech WhiteHEAT driver"
99
100 #define CONNECT_TECH_VENDOR_ID          0x0710
101 #define CONNECT_TECH_FAKE_WHITE_HEAT_ID 0x0001
102 #define CONNECT_TECH_WHITE_HEAT_ID      0x8001
103
104 /*
105    ID tables for whiteheat are unusual, because we want to different
106    things for different versions of the device.  Eventually, this
107    will be doable from a single table.  But, for now, we define two
108    separate ID tables, and then a third table that combines them
109    just for the purpose of exporting the autoloading information.
110 */
111 static struct usb_device_id id_table_std [] = {
112         { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) },
113         { }                                             /* Terminating entry */
114 };
115
116 static struct usb_device_id id_table_prerenumeration [] = {
117         { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) },
118         { }                                             /* Terminating entry */
119 };
120
121 static struct usb_device_id id_table_combined [] = {
122         { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) },
123         { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) },
124         { }                                             /* Terminating entry */
125 };
126
127 MODULE_DEVICE_TABLE (usb, id_table_combined);
128
129 static struct usb_driver whiteheat_driver = {
130         .name =         "whiteheat",
131         .probe =        usb_serial_probe,
132         .disconnect =   usb_serial_disconnect,
133         .id_table =     id_table_combined,
134         .no_dynamic_id =        1,
135 };
136
137 /* function prototypes for the Connect Tech WhiteHEAT prerenumeration device */
138 static int  whiteheat_firmware_download (struct usb_serial *serial, const struct usb_device_id *id);
139 static int  whiteheat_firmware_attach   (struct usb_serial *serial);
140
141 /* function prototypes for the Connect Tech WhiteHEAT serial converter */
142 static int  whiteheat_attach            (struct usb_serial *serial);
143 static void whiteheat_shutdown          (struct usb_serial *serial);
144 static int  whiteheat_open              (struct usb_serial_port *port, struct file *filp);
145 static void whiteheat_close             (struct usb_serial_port *port, struct file *filp);
146 static int  whiteheat_write             (struct usb_serial_port *port, const unsigned char *buf, int count);
147 static int  whiteheat_write_room        (struct usb_serial_port *port);
148 static int  whiteheat_ioctl             (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
149 static void whiteheat_set_termios       (struct usb_serial_port *port, struct ktermios * old);
150 static int  whiteheat_tiocmget          (struct usb_serial_port *port, struct file *file);
151 static int  whiteheat_tiocmset          (struct usb_serial_port *port, struct file *file, unsigned int set, unsigned int clear);
152 static void whiteheat_break_ctl         (struct usb_serial_port *port, int break_state);
153 static int  whiteheat_chars_in_buffer   (struct usb_serial_port *port);
154 static void whiteheat_throttle          (struct usb_serial_port *port);
155 static void whiteheat_unthrottle        (struct usb_serial_port *port);
156 static void whiteheat_read_callback     (struct urb *urb);
157 static void whiteheat_write_callback    (struct urb *urb);
158
159 static struct usb_serial_driver whiteheat_fake_device = {
160         .driver = {
161                 .owner =        THIS_MODULE,
162                 .name =         "whiteheatnofirm",
163         },
164         .description =          "Connect Tech - WhiteHEAT - (prerenumeration)",
165         .usb_driver =           &whiteheat_driver,
166         .id_table =             id_table_prerenumeration,
167         .num_interrupt_in =     NUM_DONT_CARE,
168         .num_bulk_in =          NUM_DONT_CARE,
169         .num_bulk_out =         NUM_DONT_CARE,
170         .num_ports =            1,
171         .probe =                whiteheat_firmware_download,
172         .attach =               whiteheat_firmware_attach,
173 };
174
175 static struct usb_serial_driver whiteheat_device = {
176         .driver = {
177                 .owner =        THIS_MODULE,
178                 .name =         "whiteheat",
179         },
180         .description =          "Connect Tech - WhiteHEAT",
181         .usb_driver =           &whiteheat_driver,
182         .id_table =             id_table_std,
183         .num_interrupt_in =     NUM_DONT_CARE,
184         .num_bulk_in =          NUM_DONT_CARE,
185         .num_bulk_out =         NUM_DONT_CARE,
186         .num_ports =            4,
187         .attach =               whiteheat_attach,
188         .shutdown =             whiteheat_shutdown,
189         .open =                 whiteheat_open,
190         .close =                whiteheat_close,
191         .write =                whiteheat_write,
192         .write_room =           whiteheat_write_room,
193         .ioctl =                whiteheat_ioctl,
194         .set_termios =          whiteheat_set_termios,
195         .break_ctl =            whiteheat_break_ctl,
196         .tiocmget =             whiteheat_tiocmget,
197         .tiocmset =             whiteheat_tiocmset,
198         .chars_in_buffer =      whiteheat_chars_in_buffer,
199         .throttle =             whiteheat_throttle,
200         .unthrottle =           whiteheat_unthrottle,
201         .read_bulk_callback =   whiteheat_read_callback,
202         .write_bulk_callback =  whiteheat_write_callback,
203 };
204
205
206 struct whiteheat_command_private {
207         struct mutex            mutex;
208         __u8                    port_running;
209         __u8                    command_finished;
210         wait_queue_head_t       wait_command;   /* for handling sleeping while waiting for a command to finish */
211         __u8                    result_buffer[64];
212 };
213
214
215 #define THROTTLED               0x01
216 #define ACTUALLY_THROTTLED      0x02
217
218 static int urb_pool_size = 8;
219
220 struct whiteheat_urb_wrap {
221         struct list_head        list;
222         struct urb              *urb;
223 };
224
225 struct whiteheat_private {
226         spinlock_t              lock;
227         __u8                    flags;
228         __u8                    mcr;
229         struct list_head        rx_urbs_free;
230         struct list_head        rx_urbs_submitted;
231         struct list_head        rx_urb_q;
232         struct work_struct      rx_work;
233         struct usb_serial_port  *port;
234         struct list_head        tx_urbs_free;
235         struct list_head        tx_urbs_submitted;
236         struct mutex            deathwarrant;
237 };
238
239
240 /* local function prototypes */
241 static int start_command_port(struct usb_serial *serial);
242 static void stop_command_port(struct usb_serial *serial);
243 static void command_port_write_callback(struct urb *urb);
244 static void command_port_read_callback(struct urb *urb);
245
246 static int start_port_read(struct usb_serial_port *port);
247 static struct whiteheat_urb_wrap *urb_to_wrap(struct urb *urb, struct list_head *head);
248 static struct list_head *list_first(struct list_head *head);
249 static void rx_data_softint(struct work_struct *work);
250
251 static int firm_send_command(struct usb_serial_port *port, __u8 command, __u8 *data, __u8 datasize);
252 static int firm_open(struct usb_serial_port *port);
253 static int firm_close(struct usb_serial_port *port);
254 static int firm_setup_port(struct usb_serial_port *port);
255 static int firm_set_rts(struct usb_serial_port *port, __u8 onoff);
256 static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff);
257 static int firm_set_break(struct usb_serial_port *port, __u8 onoff);
258 static int firm_purge(struct usb_serial_port *port, __u8 rxtx);
259 static int firm_get_dtr_rts(struct usb_serial_port *port);
260 static int firm_report_tx_done(struct usb_serial_port *port);
261
262
263 #define COMMAND_PORT            4
264 #define COMMAND_TIMEOUT         (2*HZ)  /* 2 second timeout for a command */
265 #define COMMAND_TIMEOUT_MS      2000
266 #define CLOSING_DELAY           (30 * HZ)
267
268
269 /*****************************************************************************
270  * Connect Tech's White Heat prerenumeration driver functions
271  *****************************************************************************/
272
273 /* steps to download the firmware to the WhiteHEAT device:
274  - hold the reset (by writing to the reset bit of the CPUCS register)
275  - download the VEND_AX.HEX file to the chip using VENDOR_REQUEST-ANCHOR_LOAD
276  - release the reset (by writing to the CPUCS register)
277  - download the WH.HEX file for all addresses greater than 0x1b3f using
278    VENDOR_REQUEST-ANCHOR_EXTERNAL_RAM_LOAD
279  - hold the reset
280  - download the WH.HEX file for all addresses less than 0x1b40 using
281    VENDOR_REQUEST_ANCHOR_LOAD
282  - release the reset
283  - device renumerated itself and comes up as new device id with all
284    firmware download completed.
285 */
286 static int whiteheat_firmware_download (struct usb_serial *serial, const struct usb_device_id *id)
287 {
288         int response;
289         const struct whiteheat_hex_record *record;
290         
291         dbg("%s", __FUNCTION__);
292         
293         response = ezusb_set_reset (serial, 1);
294
295         record = &whiteheat_loader[0];
296         while (record->address != 0xffff) {
297                 response = ezusb_writememory (serial, record->address, 
298                                 (unsigned char *)record->data, record->data_size, 0xa0);
299                 if (response < 0) {
300                         err("%s - ezusb_writememory failed for loader (%d %04X %p %d)",
301                                 __FUNCTION__, response, record->address, record->data, record->data_size);
302                         break;
303                 }
304                 ++record;
305         }
306
307         response = ezusb_set_reset (serial, 0);
308
309         record = &whiteheat_firmware[0];
310         while (record->address < 0x1b40) {
311                 ++record;
312         }
313         while (record->address != 0xffff) {
314                 response = ezusb_writememory (serial, record->address, 
315                                 (unsigned char *)record->data, record->data_size, 0xa3);
316                 if (response < 0) {
317                         err("%s - ezusb_writememory failed for first firmware step (%d %04X %p %d)", 
318                                 __FUNCTION__, response, record->address, record->data, record->data_size);
319                         break;
320                 }
321                 ++record;
322         }
323         
324         response = ezusb_set_reset (serial, 1);
325
326         record = &whiteheat_firmware[0];
327         while (record->address < 0x1b40) {
328                 response = ezusb_writememory (serial, record->address, 
329                                 (unsigned char *)record->data, record->data_size, 0xa0);
330                 if (response < 0) {
331                         err("%s - ezusb_writememory failed for second firmware step (%d %04X %p %d)", 
332                                 __FUNCTION__, response, record->address, record->data, record->data_size);
333                         break;
334                 }
335                 ++record;
336         }
337
338         response = ezusb_set_reset (serial, 0);
339
340         return 0;
341 }
342
343
344 static int whiteheat_firmware_attach (struct usb_serial *serial)
345 {
346         /* We want this device to fail to have a driver assigned to it */
347         return 1;
348 }
349
350
351 /*****************************************************************************
352  * Connect Tech's White Heat serial driver functions
353  *****************************************************************************/
354 static int whiteheat_attach (struct usb_serial *serial)
355 {
356         struct usb_serial_port *command_port;
357         struct whiteheat_command_private *command_info;
358         struct usb_serial_port *port;
359         struct whiteheat_private *info;
360         struct whiteheat_hw_info *hw_info;
361         int pipe;
362         int ret;
363         int alen;
364         __u8 *command;
365         __u8 *result;
366         int i;
367         int j;
368         struct urb *urb;
369         int buf_size;
370         struct whiteheat_urb_wrap *wrap;
371         struct list_head *tmp;
372
373         command_port = serial->port[COMMAND_PORT];
374
375         pipe = usb_sndbulkpipe (serial->dev, command_port->bulk_out_endpointAddress);
376         command = kmalloc(2, GFP_KERNEL);
377         if (!command)
378                 goto no_command_buffer;
379         command[0] = WHITEHEAT_GET_HW_INFO;
380         command[1] = 0;
381         
382         result = kmalloc(sizeof(*hw_info) + 1, GFP_KERNEL);
383         if (!result)
384                 goto no_result_buffer;
385         /*
386          * When the module is reloaded the firmware is still there and
387          * the endpoints are still in the usb core unchanged. This is the
388          * unlinking bug in disguise. Same for the call below.
389          */
390         usb_clear_halt(serial->dev, pipe);
391         ret = usb_bulk_msg (serial->dev, pipe, command, 2, &alen, COMMAND_TIMEOUT_MS);
392         if (ret) {
393                 err("%s: Couldn't send command [%d]", serial->type->description, ret);
394                 goto no_firmware;
395         } else if (alen != 2) {
396                 err("%s: Send command incomplete [%d]", serial->type->description, alen);
397                 goto no_firmware;
398         }
399
400         pipe = usb_rcvbulkpipe (serial->dev, command_port->bulk_in_endpointAddress);
401         /* See the comment on the usb_clear_halt() above */
402         usb_clear_halt(serial->dev, pipe);
403         ret = usb_bulk_msg (serial->dev, pipe, result, sizeof(*hw_info) + 1, &alen, COMMAND_TIMEOUT_MS);
404         if (ret) {
405                 err("%s: Couldn't get results [%d]", serial->type->description, ret);
406                 goto no_firmware;
407         } else if (alen != sizeof(*hw_info) + 1) {
408                 err("%s: Get results incomplete [%d]", serial->type->description, alen);
409                 goto no_firmware;
410         } else if (result[0] != command[0]) {
411                 err("%s: Command failed [%d]", serial->type->description, result[0]);
412                 goto no_firmware;
413         }
414
415         hw_info = (struct whiteheat_hw_info *)&result[1];
416
417         info("%s: Driver %s: Firmware v%d.%02d", serial->type->description,
418              DRIVER_VERSION, hw_info->sw_major_rev, hw_info->sw_minor_rev);
419
420         for (i = 0; i < serial->num_ports; i++) {
421                 port = serial->port[i];
422
423                 info = kmalloc(sizeof(struct whiteheat_private), GFP_KERNEL);
424                 if (info == NULL) {
425                         err("%s: Out of memory for port structures\n", serial->type->description);
426                         goto no_private;
427                 }
428
429                 spin_lock_init(&info->lock);
430                 mutex_init(&info->deathwarrant);
431                 info->flags = 0;
432                 info->mcr = 0;
433                 INIT_WORK(&info->rx_work, rx_data_softint);
434                 info->port = port;
435
436                 INIT_LIST_HEAD(&info->rx_urbs_free);
437                 INIT_LIST_HEAD(&info->rx_urbs_submitted);
438                 INIT_LIST_HEAD(&info->rx_urb_q);
439                 INIT_LIST_HEAD(&info->tx_urbs_free);
440                 INIT_LIST_HEAD(&info->tx_urbs_submitted);
441
442                 for (j = 0; j < urb_pool_size; j++) {
443                         urb = usb_alloc_urb(0, GFP_KERNEL);
444                         if (!urb) {
445                                 err("No free urbs available");
446                                 goto no_rx_urb;
447                         }
448                         buf_size = port->read_urb->transfer_buffer_length;
449                         urb->transfer_buffer = kmalloc(buf_size, GFP_KERNEL);
450                         if (!urb->transfer_buffer) {
451                                 err("Couldn't allocate urb buffer");
452                                 goto no_rx_buf;
453                         }
454                         wrap = kmalloc(sizeof(*wrap), GFP_KERNEL);
455                         if (!wrap) {
456                                 err("Couldn't allocate urb wrapper");
457                                 goto no_rx_wrap;
458                         }
459                         usb_fill_bulk_urb(urb, serial->dev,
460                                         usb_rcvbulkpipe(serial->dev,
461                                                 port->bulk_in_endpointAddress),
462                                         urb->transfer_buffer, buf_size,
463                                         whiteheat_read_callback, port);
464                         wrap->urb = urb;
465                         list_add(&wrap->list, &info->rx_urbs_free);
466
467                         urb = usb_alloc_urb(0, GFP_KERNEL);
468                         if (!urb) {
469                                 err("No free urbs available");
470                                 goto no_tx_urb;
471                         }
472                         buf_size = port->write_urb->transfer_buffer_length;
473                         urb->transfer_buffer = kmalloc(buf_size, GFP_KERNEL);
474                         if (!urb->transfer_buffer) {
475                                 err("Couldn't allocate urb buffer");
476                                 goto no_tx_buf;
477                         }
478                         wrap = kmalloc(sizeof(*wrap), GFP_KERNEL);
479                         if (!wrap) {
480                                 err("Couldn't allocate urb wrapper");
481                                 goto no_tx_wrap;
482                         }
483                         usb_fill_bulk_urb(urb, serial->dev,
484                                         usb_sndbulkpipe(serial->dev,
485                                                 port->bulk_out_endpointAddress),
486                                         urb->transfer_buffer, buf_size,
487                                         whiteheat_write_callback, port);
488                         wrap->urb = urb;
489                         list_add(&wrap->list, &info->tx_urbs_free);
490                 }
491
492                 usb_set_serial_port_data(port, info);
493         }
494
495         command_info = kmalloc(sizeof(struct whiteheat_command_private), GFP_KERNEL);
496         if (command_info == NULL) {
497                 err("%s: Out of memory for port structures\n", serial->type->description);
498                 goto no_command_private;
499         }
500
501         mutex_init(&command_info->mutex);
502         command_info->port_running = 0;
503         init_waitqueue_head(&command_info->wait_command);
504         usb_set_serial_port_data(command_port, command_info);
505         command_port->write_urb->complete = command_port_write_callback;
506         command_port->read_urb->complete = command_port_read_callback;
507         kfree(result);
508         kfree(command);
509
510         return 0;
511
512 no_firmware:
513         /* Firmware likely not running */
514         err("%s: Unable to retrieve firmware version, try replugging\n", serial->type->description);
515         err("%s: If the firmware is not running (status led not blinking)\n", serial->type->description);
516         err("%s: please contact support@connecttech.com\n", serial->type->description);
517         kfree(result);
518         return -ENODEV;
519
520 no_command_private:
521         for (i = serial->num_ports - 1; i >= 0; i--) {
522                 port = serial->port[i];
523                 info = usb_get_serial_port_data(port);
524                 for (j = urb_pool_size - 1; j >= 0; j--) {
525                         tmp = list_first(&info->tx_urbs_free);
526                         list_del(tmp);
527                         wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
528                         urb = wrap->urb;
529                         kfree(wrap);
530 no_tx_wrap:
531                         kfree(urb->transfer_buffer);
532 no_tx_buf:
533                         usb_free_urb(urb);
534 no_tx_urb:
535                         tmp = list_first(&info->rx_urbs_free);
536                         list_del(tmp);
537                         wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
538                         urb = wrap->urb;
539                         kfree(wrap);
540 no_rx_wrap:
541                         kfree(urb->transfer_buffer);
542 no_rx_buf:
543                         usb_free_urb(urb);
544 no_rx_urb:
545                         ;
546                 }
547                 kfree(info);
548 no_private:
549                 ;
550         }
551         kfree(result);
552 no_result_buffer:
553         kfree(command);
554 no_command_buffer:
555         return -ENOMEM;
556 }
557
558
559 static void whiteheat_shutdown (struct usb_serial *serial)
560 {
561         struct usb_serial_port *command_port;
562         struct usb_serial_port *port;
563         struct whiteheat_private *info;
564         struct whiteheat_urb_wrap *wrap;
565         struct urb *urb;
566         struct list_head *tmp;
567         struct list_head *tmp2;
568         int i;
569
570         dbg("%s", __FUNCTION__);
571
572         /* free up our private data for our command port */
573         command_port = serial->port[COMMAND_PORT];
574         kfree (usb_get_serial_port_data(command_port));
575
576         for (i = 0; i < serial->num_ports; i++) {
577                 port = serial->port[i];
578                 info = usb_get_serial_port_data(port);
579                 list_for_each_safe(tmp, tmp2, &info->rx_urbs_free) {
580                         list_del(tmp);
581                         wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
582                         urb = wrap->urb;
583                         kfree(wrap);
584                         kfree(urb->transfer_buffer);
585                         usb_free_urb(urb);
586                 }
587                 list_for_each_safe(tmp, tmp2, &info->tx_urbs_free) {
588                         list_del(tmp);
589                         wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
590                         urb = wrap->urb;
591                         kfree(wrap);
592                         kfree(urb->transfer_buffer);
593                         usb_free_urb(urb);
594                 }
595                 kfree(info);
596         }
597
598         return;
599 }
600
601
602 static int whiteheat_open (struct usb_serial_port *port, struct file *filp)
603 {
604         int             retval = 0;
605         struct ktermios old_term;
606
607         dbg("%s - port %d", __FUNCTION__, port->number);
608
609         retval = start_command_port(port->serial);
610         if (retval)
611                 goto exit;
612
613         if (port->tty)
614                 port->tty->low_latency = 1;
615
616         /* send an open port command */
617         retval = firm_open(port);
618         if (retval) {
619                 stop_command_port(port->serial);
620                 goto exit;
621         }
622
623         retval = firm_purge(port, WHITEHEAT_PURGE_RX | WHITEHEAT_PURGE_TX);
624         if (retval) {
625                 firm_close(port);
626                 stop_command_port(port->serial);
627                 goto exit;
628         }
629
630         old_term.c_cflag = ~port->tty->termios->c_cflag;
631         old_term.c_iflag = ~port->tty->termios->c_iflag;
632         whiteheat_set_termios(port, &old_term);
633
634         /* Work around HCD bugs */
635         usb_clear_halt(port->serial->dev, port->read_urb->pipe);
636         usb_clear_halt(port->serial->dev, port->write_urb->pipe);
637
638         /* Start reading from the device */
639         retval = start_port_read(port);
640         if (retval) {
641                 err("%s - failed submitting read urb, error %d", __FUNCTION__, retval);
642                 firm_close(port);
643                 stop_command_port(port->serial);
644                 goto exit;
645         }
646
647 exit:
648         dbg("%s - exit, retval = %d", __FUNCTION__, retval);
649         return retval;
650 }
651
652
653 static void whiteheat_close(struct usb_serial_port *port, struct file * filp)
654 {
655         struct whiteheat_private *info = usb_get_serial_port_data(port);
656         struct whiteheat_urb_wrap *wrap;
657         struct urb *urb;
658         struct list_head *tmp;
659         struct list_head *tmp2;
660
661         dbg("%s - port %d", __FUNCTION__, port->number);
662         
663         /* filp is NULL when called from usb_serial_disconnect */
664         if (filp && (tty_hung_up_p(filp))) {
665                 return;
666         }
667
668         port->tty->closing = 1;
669
670 /*
671  * Not currently in use; tty_wait_until_sent() calls
672  * serial_chars_in_buffer() which deadlocks on the second semaphore
673  * acquisition. This should be fixed at some point. Greg's been
674  * notified.
675         if ((filp->f_flags & (O_NDELAY | O_NONBLOCK)) == 0) {
676                 tty_wait_until_sent(port->tty, CLOSING_DELAY);
677         }
678 */
679
680         if (port->tty->driver->flush_buffer)
681                 port->tty->driver->flush_buffer(port->tty);
682         tty_ldisc_flush(port->tty);
683
684         firm_report_tx_done(port);
685
686         firm_close(port);
687
688 printk(KERN_ERR"Before processing rx_urbs_submitted.\n");
689         /* shutdown our bulk reads and writes */
690         mutex_lock(&info->deathwarrant);
691         spin_lock_irq(&info->lock);
692         list_for_each_safe(tmp, tmp2, &info->rx_urbs_submitted) {
693                 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
694                 urb = wrap->urb;
695                 list_del(tmp);
696                 spin_unlock_irq(&info->lock);
697                 usb_kill_urb(urb);
698                 spin_lock_irq(&info->lock);
699                 list_add(tmp, &info->rx_urbs_free);
700         }
701         list_for_each_safe(tmp, tmp2, &info->rx_urb_q)
702                 list_move(tmp, &info->rx_urbs_free);
703         list_for_each_safe(tmp, tmp2, &info->tx_urbs_submitted) {
704                 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
705                 urb = wrap->urb;
706                 list_del(tmp);
707                 spin_unlock_irq(&info->lock);
708                 usb_kill_urb(urb);
709                 spin_lock_irq(&info->lock);
710                 list_add(tmp, &info->tx_urbs_free);
711         }
712         spin_unlock_irq(&info->lock);
713         mutex_unlock(&info->deathwarrant);
714
715         stop_command_port(port->serial);
716
717         port->tty->closing = 0;
718 }
719
720
721 static int whiteheat_write(struct usb_serial_port *port, const unsigned char *buf, int count)
722 {
723         struct usb_serial *serial = port->serial;
724         struct whiteheat_private *info = usb_get_serial_port_data(port);
725         struct whiteheat_urb_wrap *wrap;
726         struct urb *urb;
727         int result;
728         int bytes;
729         int sent = 0;
730         unsigned long flags;
731         struct list_head *tmp;
732
733         dbg("%s - port %d", __FUNCTION__, port->number);
734
735         if (count == 0) {
736                 dbg("%s - write request of 0 bytes", __FUNCTION__);
737                 return (0);
738         }
739
740         while (count) {
741                 spin_lock_irqsave(&info->lock, flags);
742                 if (list_empty(&info->tx_urbs_free)) {
743                         spin_unlock_irqrestore(&info->lock, flags);
744                         break;
745                 }
746                 tmp = list_first(&info->tx_urbs_free);
747                 list_del(tmp);
748                 spin_unlock_irqrestore(&info->lock, flags);
749
750                 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
751                 urb = wrap->urb;
752                 bytes = (count > port->bulk_out_size) ? port->bulk_out_size : count;
753                 memcpy (urb->transfer_buffer, buf + sent, bytes);
754
755                 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, bytes, urb->transfer_buffer);
756
757                 urb->dev = serial->dev;
758                 urb->transfer_buffer_length = bytes;
759                 result = usb_submit_urb(urb, GFP_ATOMIC);
760                 if (result) {
761                         err("%s - failed submitting write urb, error %d", __FUNCTION__, result);
762                         sent = result;
763                         spin_lock_irqsave(&info->lock, flags);
764                         list_add(tmp, &info->tx_urbs_free);
765                         spin_unlock_irqrestore(&info->lock, flags);
766                         break;
767                 } else {
768                         sent += bytes;
769                         count -= bytes;
770                         spin_lock_irqsave(&info->lock, flags);
771                         list_add(tmp, &info->tx_urbs_submitted);
772                         spin_unlock_irqrestore(&info->lock, flags);
773                 }
774         }
775
776         return sent;
777 }
778
779
780 static int whiteheat_write_room(struct usb_serial_port *port)
781 {
782         struct whiteheat_private *info = usb_get_serial_port_data(port);
783         struct list_head *tmp;
784         int room = 0;
785         unsigned long flags;
786
787         dbg("%s - port %d", __FUNCTION__, port->number);
788         
789         spin_lock_irqsave(&info->lock, flags);
790         list_for_each(tmp, &info->tx_urbs_free)
791                 room++;
792         spin_unlock_irqrestore(&info->lock, flags);
793         room *= port->bulk_out_size;
794
795         dbg("%s - returns %d", __FUNCTION__, room);
796         return (room);
797 }
798
799
800 static int whiteheat_tiocmget (struct usb_serial_port *port, struct file *file)
801 {
802         struct whiteheat_private *info = usb_get_serial_port_data(port);
803         unsigned int modem_signals = 0;
804
805         dbg("%s - port %d", __FUNCTION__, port->number);
806
807         firm_get_dtr_rts(port);
808         if (info->mcr & UART_MCR_DTR)
809                 modem_signals |= TIOCM_DTR;
810         if (info->mcr & UART_MCR_RTS)
811                 modem_signals |= TIOCM_RTS;
812
813         return modem_signals;
814 }
815
816
817 static int whiteheat_tiocmset (struct usb_serial_port *port, struct file *file,
818                                unsigned int set, unsigned int clear)
819 {
820         struct whiteheat_private *info = usb_get_serial_port_data(port);
821
822         dbg("%s - port %d", __FUNCTION__, port->number);
823
824         if (set & TIOCM_RTS)
825                 info->mcr |= UART_MCR_RTS;
826         if (set & TIOCM_DTR)
827                 info->mcr |= UART_MCR_DTR;
828
829         if (clear & TIOCM_RTS)
830                 info->mcr &= ~UART_MCR_RTS;
831         if (clear & TIOCM_DTR)
832                 info->mcr &= ~UART_MCR_DTR;
833
834         firm_set_dtr(port, info->mcr & UART_MCR_DTR);
835         firm_set_rts(port, info->mcr & UART_MCR_RTS);
836         return 0;
837 }
838
839
840 static int whiteheat_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
841 {
842         struct serial_struct serstruct;
843         void __user *user_arg = (void __user *)arg;
844
845         dbg("%s - port %d, cmd 0x%.4x", __FUNCTION__, port->number, cmd);
846
847         switch (cmd) {
848                 case TIOCGSERIAL:
849                         memset(&serstruct, 0, sizeof(serstruct));
850                         serstruct.type = PORT_16654;
851                         serstruct.line = port->serial->minor;
852                         serstruct.port = port->number;
853                         serstruct.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
854                         serstruct.xmit_fifo_size = port->bulk_out_size;
855                         serstruct.custom_divisor = 0;
856                         serstruct.baud_base = 460800;
857                         serstruct.close_delay = CLOSING_DELAY;
858                         serstruct.closing_wait = CLOSING_DELAY;
859
860                         if (copy_to_user(user_arg, &serstruct, sizeof(serstruct)))
861                                 return -EFAULT;
862
863                         break;
864
865                 case TIOCSSERIAL:
866                         if (copy_from_user(&serstruct, user_arg, sizeof(serstruct)))
867                                 return -EFAULT;
868
869                         /*
870                          * For now this is ignored. dip sets the ASYNC_[V]HI flags
871                          * but this isn't used by us at all. Maybe someone somewhere
872                          * will need the custom_divisor setting.
873                          */
874
875                         break;
876
877                 default:
878                         break;
879         }
880
881         return -ENOIOCTLCMD;
882 }
883
884
885 static void whiteheat_set_termios(struct usb_serial_port *port, struct ktermios *old_termios)
886 {
887         dbg("%s -port %d", __FUNCTION__, port->number);
888         firm_setup_port(port);
889 }
890
891
892 static void whiteheat_break_ctl(struct usb_serial_port *port, int break_state) {
893         firm_set_break(port, break_state);
894 }
895
896
897 static int whiteheat_chars_in_buffer(struct usb_serial_port *port)
898 {
899         struct whiteheat_private *info = usb_get_serial_port_data(port);
900         struct list_head *tmp;
901         struct whiteheat_urb_wrap *wrap;
902         int chars = 0;
903         unsigned long flags;
904
905         dbg("%s - port %d", __FUNCTION__, port->number);
906
907         spin_lock_irqsave(&info->lock, flags);
908         list_for_each(tmp, &info->tx_urbs_submitted) {
909                 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
910                 chars += wrap->urb->transfer_buffer_length;
911         }
912         spin_unlock_irqrestore(&info->lock, flags);
913
914         dbg ("%s - returns %d", __FUNCTION__, chars);
915         return chars;
916 }
917
918
919 static void whiteheat_throttle (struct usb_serial_port *port)
920 {
921         struct whiteheat_private *info = usb_get_serial_port_data(port);
922         unsigned long flags;
923
924         dbg("%s - port %d", __FUNCTION__, port->number);
925
926         spin_lock_irqsave(&info->lock, flags);
927         info->flags |= THROTTLED;
928         spin_unlock_irqrestore(&info->lock, flags);
929
930         return;
931 }
932
933
934 static void whiteheat_unthrottle (struct usb_serial_port *port)
935 {
936         struct whiteheat_private *info = usb_get_serial_port_data(port);
937         int actually_throttled;
938         unsigned long flags;
939
940         dbg("%s - port %d", __FUNCTION__, port->number);
941
942         spin_lock_irqsave(&info->lock, flags);
943         actually_throttled = info->flags & ACTUALLY_THROTTLED;
944         info->flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
945         spin_unlock_irqrestore(&info->lock, flags);
946
947         if (actually_throttled)
948                 rx_data_softint(&info->rx_work);
949
950         return;
951 }
952
953
954 /*****************************************************************************
955  * Connect Tech's White Heat callback routines
956  *****************************************************************************/
957 static void command_port_write_callback(struct urb *urb)
958 {
959         int status = urb->status;
960
961         dbg("%s", __FUNCTION__);
962
963         if (status) {
964                 dbg("nonzero urb status: %d", status);
965                 return;
966         }
967 }
968
969
970 static void command_port_read_callback(struct urb *urb)
971 {
972         struct usb_serial_port *command_port = (struct usb_serial_port *)urb->context;
973         struct whiteheat_command_private *command_info;
974         int status = urb->status;
975         unsigned char *data = urb->transfer_buffer;
976         int result;
977
978         dbg("%s", __FUNCTION__);
979
980         command_info = usb_get_serial_port_data(command_port);
981         if (!command_info) {
982                 dbg ("%s - command_info is NULL, exiting.", __FUNCTION__);
983                 return;
984         }
985         if (status) {
986                 dbg("%s - nonzero urb status: %d", __FUNCTION__, status);
987                 if (status != -ENOENT)
988                         command_info->command_finished = WHITEHEAT_CMD_FAILURE;
989                 wake_up(&command_info->wait_command);
990                 return;
991         }
992
993         usb_serial_debug_data(debug, &command_port->dev, __FUNCTION__, urb->actual_length, data);
994
995         if (data[0] == WHITEHEAT_CMD_COMPLETE) {
996                 command_info->command_finished = WHITEHEAT_CMD_COMPLETE;
997                 wake_up(&command_info->wait_command);
998         } else if (data[0] == WHITEHEAT_CMD_FAILURE) {
999                 command_info->command_finished = WHITEHEAT_CMD_FAILURE;
1000                 wake_up(&command_info->wait_command);
1001         } else if (data[0] == WHITEHEAT_EVENT) {
1002                 /* These are unsolicited reports from the firmware, hence no waiting command to wakeup */
1003                 dbg("%s - event received", __FUNCTION__);
1004         } else if (data[0] == WHITEHEAT_GET_DTR_RTS) {
1005                 memcpy(command_info->result_buffer, &data[1], urb->actual_length - 1);
1006                 command_info->command_finished = WHITEHEAT_CMD_COMPLETE;
1007                 wake_up(&command_info->wait_command);
1008         } else {
1009                 dbg("%s - bad reply from firmware", __FUNCTION__);
1010         }
1011         
1012         /* Continue trying to always read */
1013         command_port->read_urb->dev = command_port->serial->dev;
1014         result = usb_submit_urb(command_port->read_urb, GFP_ATOMIC);
1015         if (result)
1016                 dbg("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1017 }
1018
1019
1020 static void whiteheat_read_callback(struct urb *urb)
1021 {
1022         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1023         struct whiteheat_urb_wrap *wrap;
1024         unsigned char *data = urb->transfer_buffer;
1025         struct whiteheat_private *info = usb_get_serial_port_data(port);
1026         int status = urb->status;
1027
1028         dbg("%s - port %d", __FUNCTION__, port->number);
1029
1030         spin_lock(&info->lock);
1031         wrap = urb_to_wrap(urb, &info->rx_urbs_submitted);
1032         if (!wrap) {
1033                 spin_unlock(&info->lock);
1034                 err("%s - Not my urb!", __FUNCTION__);
1035                 return;
1036         }
1037         list_del(&wrap->list);
1038         spin_unlock(&info->lock);
1039
1040         if (status) {
1041                 dbg("%s - nonzero read bulk status received: %d",
1042                     __FUNCTION__, status);
1043                 spin_lock(&info->lock);
1044                 list_add(&wrap->list, &info->rx_urbs_free);
1045                 spin_unlock(&info->lock);
1046                 return;
1047         }
1048
1049         usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
1050
1051         spin_lock(&info->lock);
1052         list_add_tail(&wrap->list, &info->rx_urb_q);
1053         if (info->flags & THROTTLED) {
1054                 info->flags |= ACTUALLY_THROTTLED;
1055                 spin_unlock(&info->lock);
1056                 return;
1057         }
1058         spin_unlock(&info->lock);
1059
1060         schedule_work(&info->rx_work);
1061 }
1062
1063
1064 static void whiteheat_write_callback(struct urb *urb)
1065 {
1066         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1067         struct whiteheat_private *info = usb_get_serial_port_data(port);
1068         struct whiteheat_urb_wrap *wrap;
1069         int status = urb->status;
1070
1071         dbg("%s - port %d", __FUNCTION__, port->number);
1072
1073         spin_lock(&info->lock);
1074         wrap = urb_to_wrap(urb, &info->tx_urbs_submitted);
1075         if (!wrap) {
1076                 spin_unlock(&info->lock);
1077                 err("%s - Not my urb!", __FUNCTION__);
1078                 return;
1079         }
1080         list_move(&wrap->list, &info->tx_urbs_free);
1081         spin_unlock(&info->lock);
1082
1083         if (status) {
1084                 dbg("%s - nonzero write bulk status received: %d",
1085                     __FUNCTION__, status);
1086                 return;
1087         }
1088
1089         usb_serial_port_softint(port);
1090 }
1091
1092
1093 /*****************************************************************************
1094  * Connect Tech's White Heat firmware interface
1095  *****************************************************************************/
1096 static int firm_send_command(struct usb_serial_port *port, __u8 command, __u8 *data, __u8 datasize)
1097 {
1098         struct usb_serial_port *command_port;
1099         struct whiteheat_command_private *command_info;
1100         struct whiteheat_private *info;
1101         __u8 *transfer_buffer;
1102         int retval = 0;
1103         int t;
1104
1105         dbg("%s - command %d", __FUNCTION__, command);
1106
1107         command_port = port->serial->port[COMMAND_PORT];
1108         command_info = usb_get_serial_port_data(command_port);
1109         mutex_lock(&command_info->mutex);
1110         command_info->command_finished = false;
1111         
1112         transfer_buffer = (__u8 *)command_port->write_urb->transfer_buffer;
1113         transfer_buffer[0] = command;
1114         memcpy (&transfer_buffer[1], data, datasize);
1115         command_port->write_urb->transfer_buffer_length = datasize + 1;
1116         command_port->write_urb->dev = port->serial->dev;
1117         retval = usb_submit_urb (command_port->write_urb, GFP_NOIO);
1118         if (retval) {
1119                 dbg("%s - submit urb failed", __FUNCTION__);
1120                 goto exit;
1121         }
1122
1123         /* wait for the command to complete */
1124         t = wait_event_timeout(command_info->wait_command,
1125                 (bool)command_info->command_finished, COMMAND_TIMEOUT);
1126         if (!t)
1127                 usb_kill_urb(command_port->write_urb);
1128
1129         if (command_info->command_finished == false) {
1130                 dbg("%s - command timed out.", __FUNCTION__);
1131                 retval = -ETIMEDOUT;
1132                 goto exit;
1133         }
1134
1135         if (command_info->command_finished == WHITEHEAT_CMD_FAILURE) {
1136                 dbg("%s - command failed.", __FUNCTION__);
1137                 retval = -EIO;
1138                 goto exit;
1139         }
1140
1141         if (command_info->command_finished == WHITEHEAT_CMD_COMPLETE) {
1142                 dbg("%s - command completed.", __FUNCTION__);
1143                 switch (command) {
1144                         case WHITEHEAT_GET_DTR_RTS:
1145                                 info = usb_get_serial_port_data(port);
1146                                 memcpy(&info->mcr, command_info->result_buffer, sizeof(struct whiteheat_dr_info));
1147                                 break;
1148                 }
1149         }
1150
1151 exit:
1152         mutex_unlock(&command_info->mutex);
1153         return retval;
1154 }
1155
1156
1157 static int firm_open(struct usb_serial_port *port) {
1158         struct whiteheat_simple open_command;
1159
1160         open_command.port = port->number - port->serial->minor + 1;
1161         return firm_send_command(port, WHITEHEAT_OPEN, (__u8 *)&open_command, sizeof(open_command));
1162 }
1163
1164
1165 static int firm_close(struct usb_serial_port *port) {
1166         struct whiteheat_simple close_command;
1167
1168         close_command.port = port->number - port->serial->minor + 1;
1169         return firm_send_command(port, WHITEHEAT_CLOSE, (__u8 *)&close_command, sizeof(close_command));
1170 }
1171
1172
1173 static int firm_setup_port(struct usb_serial_port *port) {
1174         struct whiteheat_port_settings port_settings;
1175         unsigned int cflag = port->tty->termios->c_cflag;
1176
1177         port_settings.port = port->number + 1;
1178
1179         /* get the byte size */
1180         switch (cflag & CSIZE) {
1181                 case CS5:       port_settings.bits = 5;   break;
1182                 case CS6:       port_settings.bits = 6;   break;
1183                 case CS7:       port_settings.bits = 7;   break;
1184                 default:
1185                 case CS8:       port_settings.bits = 8;   break;
1186         }
1187         dbg("%s - data bits = %d", __FUNCTION__, port_settings.bits);
1188         
1189         /* determine the parity */
1190         if (cflag & PARENB)
1191                 if (cflag & CMSPAR)
1192                         if (cflag & PARODD)
1193                                 port_settings.parity = WHITEHEAT_PAR_MARK;
1194                         else
1195                                 port_settings.parity = WHITEHEAT_PAR_SPACE;
1196                 else
1197                         if (cflag & PARODD)
1198                                 port_settings.parity = WHITEHEAT_PAR_ODD;
1199                         else
1200                                 port_settings.parity = WHITEHEAT_PAR_EVEN;
1201         else
1202                 port_settings.parity = WHITEHEAT_PAR_NONE;
1203         dbg("%s - parity = %c", __FUNCTION__, port_settings.parity);
1204
1205         /* figure out the stop bits requested */
1206         if (cflag & CSTOPB)
1207                 port_settings.stop = 2;
1208         else
1209                 port_settings.stop = 1;
1210         dbg("%s - stop bits = %d", __FUNCTION__, port_settings.stop);
1211
1212         /* figure out the flow control settings */
1213         if (cflag & CRTSCTS)
1214                 port_settings.hflow = (WHITEHEAT_HFLOW_CTS | WHITEHEAT_HFLOW_RTS);
1215         else
1216                 port_settings.hflow = WHITEHEAT_HFLOW_NONE;
1217         dbg("%s - hardware flow control = %s %s %s %s", __FUNCTION__,
1218             (port_settings.hflow & WHITEHEAT_HFLOW_CTS) ? "CTS" : "",
1219             (port_settings.hflow & WHITEHEAT_HFLOW_RTS) ? "RTS" : "",
1220             (port_settings.hflow & WHITEHEAT_HFLOW_DSR) ? "DSR" : "",
1221             (port_settings.hflow & WHITEHEAT_HFLOW_DTR) ? "DTR" : "");
1222         
1223         /* determine software flow control */
1224         if (I_IXOFF(port->tty))
1225                 port_settings.sflow = WHITEHEAT_SFLOW_RXTX;
1226         else
1227                 port_settings.sflow = WHITEHEAT_SFLOW_NONE;
1228         dbg("%s - software flow control = %c", __FUNCTION__, port_settings.sflow);
1229         
1230         port_settings.xon = START_CHAR(port->tty);
1231         port_settings.xoff = STOP_CHAR(port->tty);
1232         dbg("%s - XON = %2x, XOFF = %2x", __FUNCTION__, port_settings.xon, port_settings.xoff);
1233
1234         /* get the baud rate wanted */
1235         port_settings.baud = tty_get_baud_rate(port->tty);
1236         dbg("%s - baud rate = %d", __FUNCTION__, port_settings.baud);
1237
1238         /* fixme: should set validated settings */
1239         tty_encode_baud_rate(port->tty, port_settings.baud, port_settings.baud);
1240         /* handle any settings that aren't specified in the tty structure */
1241         port_settings.lloop = 0;
1242         
1243         /* now send the message to the device */
1244         return firm_send_command(port, WHITEHEAT_SETUP_PORT, (__u8 *)&port_settings, sizeof(port_settings));
1245 }
1246
1247
1248 static int firm_set_rts(struct usb_serial_port *port, __u8 onoff) {
1249         struct whiteheat_set_rdb rts_command;
1250
1251         rts_command.port = port->number - port->serial->minor + 1;
1252         rts_command.state = onoff;
1253         return firm_send_command(port, WHITEHEAT_SET_RTS, (__u8 *)&rts_command, sizeof(rts_command));
1254 }
1255
1256
1257 static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff) {
1258         struct whiteheat_set_rdb dtr_command;
1259
1260         dtr_command.port = port->number - port->serial->minor + 1;
1261         dtr_command.state = onoff;
1262         return firm_send_command(port, WHITEHEAT_SET_RTS, (__u8 *)&dtr_command, sizeof(dtr_command));
1263 }
1264
1265
1266 static int firm_set_break(struct usb_serial_port *port, __u8 onoff) {
1267         struct whiteheat_set_rdb break_command;
1268
1269         break_command.port = port->number - port->serial->minor + 1;
1270         break_command.state = onoff;
1271         return firm_send_command(port, WHITEHEAT_SET_RTS, (__u8 *)&break_command, sizeof(break_command));
1272 }
1273
1274
1275 static int firm_purge(struct usb_serial_port *port, __u8 rxtx) {
1276         struct whiteheat_purge purge_command;
1277
1278         purge_command.port = port->number - port->serial->minor + 1;
1279         purge_command.what = rxtx;
1280         return firm_send_command(port, WHITEHEAT_PURGE, (__u8 *)&purge_command, sizeof(purge_command));
1281 }
1282
1283
1284 static int firm_get_dtr_rts(struct usb_serial_port *port) {
1285         struct whiteheat_simple get_dr_command;
1286
1287         get_dr_command.port = port->number - port->serial->minor + 1;
1288         return firm_send_command(port, WHITEHEAT_GET_DTR_RTS, (__u8 *)&get_dr_command, sizeof(get_dr_command));
1289 }
1290
1291
1292 static int firm_report_tx_done(struct usb_serial_port *port) {
1293         struct whiteheat_simple close_command;
1294
1295         close_command.port = port->number - port->serial->minor + 1;
1296         return firm_send_command(port, WHITEHEAT_REPORT_TX_DONE, (__u8 *)&close_command, sizeof(close_command));
1297 }
1298
1299
1300 /*****************************************************************************
1301  * Connect Tech's White Heat utility functions
1302  *****************************************************************************/
1303 static int start_command_port(struct usb_serial *serial)
1304 {
1305         struct usb_serial_port *command_port;
1306         struct whiteheat_command_private *command_info;
1307         int retval = 0;
1308         
1309         command_port = serial->port[COMMAND_PORT];
1310         command_info = usb_get_serial_port_data(command_port);
1311         mutex_lock(&command_info->mutex);
1312         if (!command_info->port_running) {
1313                 /* Work around HCD bugs */
1314                 usb_clear_halt(serial->dev, command_port->read_urb->pipe);
1315
1316                 command_port->read_urb->dev = serial->dev;
1317                 retval = usb_submit_urb(command_port->read_urb, GFP_KERNEL);
1318                 if (retval) {
1319                         err("%s - failed submitting read urb, error %d", __FUNCTION__, retval);
1320                         goto exit;
1321                 }
1322         }
1323         command_info->port_running++;
1324
1325 exit:
1326         mutex_unlock(&command_info->mutex);
1327         return retval;
1328 }
1329
1330
1331 static void stop_command_port(struct usb_serial *serial)
1332 {
1333         struct usb_serial_port *command_port;
1334         struct whiteheat_command_private *command_info;
1335
1336         command_port = serial->port[COMMAND_PORT];
1337         command_info = usb_get_serial_port_data(command_port);
1338         mutex_lock(&command_info->mutex);
1339         command_info->port_running--;
1340         if (!command_info->port_running)
1341                 usb_kill_urb(command_port->read_urb);
1342         mutex_unlock(&command_info->mutex);
1343 }
1344
1345
1346 static int start_port_read(struct usb_serial_port *port)
1347 {
1348         struct whiteheat_private *info = usb_get_serial_port_data(port);
1349         struct whiteheat_urb_wrap *wrap;
1350         struct urb *urb;
1351         int retval = 0;
1352         unsigned long flags;
1353         struct list_head *tmp;
1354         struct list_head *tmp2;
1355
1356         spin_lock_irqsave(&info->lock, flags);
1357
1358         list_for_each_safe(tmp, tmp2, &info->rx_urbs_free) {
1359                 list_del(tmp);
1360                 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1361                 urb = wrap->urb;
1362                 urb->dev = port->serial->dev;
1363                 spin_unlock_irqrestore(&info->lock, flags);
1364                 retval = usb_submit_urb(urb, GFP_KERNEL);
1365                 if (retval) {
1366                         spin_lock_irqsave(&info->lock, flags);
1367                         list_add(tmp, &info->rx_urbs_free);
1368                         list_for_each_safe(tmp, tmp2, &info->rx_urbs_submitted) {
1369                                 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1370                                 urb = wrap->urb;
1371                                 list_del(tmp);
1372                                 spin_unlock_irqrestore(&info->lock, flags);
1373                                 usb_kill_urb(urb);
1374                                 spin_lock_irqsave(&info->lock, flags);
1375                                 list_add(tmp, &info->rx_urbs_free);
1376                         }
1377                         break;
1378                 }
1379                 spin_lock_irqsave(&info->lock, flags);
1380                 list_add(tmp, &info->rx_urbs_submitted);
1381         }
1382
1383         spin_unlock_irqrestore(&info->lock, flags);
1384
1385         return retval;
1386 }
1387
1388
1389 static struct whiteheat_urb_wrap *urb_to_wrap(struct urb* urb, struct list_head *head)
1390 {
1391         struct whiteheat_urb_wrap *wrap;
1392         struct list_head *tmp;
1393
1394         list_for_each(tmp, head) {
1395                 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1396                 if (wrap->urb == urb)
1397                         return wrap;
1398         }
1399
1400         return NULL;
1401 }
1402
1403
1404 static struct list_head *list_first(struct list_head *head)
1405 {
1406         return head->next;
1407 }
1408
1409
1410 static void rx_data_softint(struct work_struct *work)
1411 {
1412         struct whiteheat_private *info =
1413                 container_of(work, struct whiteheat_private, rx_work);
1414         struct usb_serial_port *port = info->port;
1415         struct tty_struct *tty = port->tty;
1416         struct whiteheat_urb_wrap *wrap;
1417         struct urb *urb;
1418         unsigned long flags;
1419         struct list_head *tmp;
1420         struct list_head *tmp2;
1421         int result;
1422         int sent = 0;
1423
1424         spin_lock_irqsave(&info->lock, flags);
1425         if (info->flags & THROTTLED) {
1426                 spin_unlock_irqrestore(&info->lock, flags);
1427                 return;
1428         }
1429
1430         list_for_each_safe(tmp, tmp2, &info->rx_urb_q) {
1431                 list_del(tmp);
1432                 spin_unlock_irqrestore(&info->lock, flags);
1433
1434                 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1435                 urb = wrap->urb;
1436
1437                 if (tty && urb->actual_length) {
1438                         int len = tty_buffer_request_room(tty, urb->actual_length);
1439                         /* This stuff can go away now I suspect */
1440                         if (unlikely(len < urb->actual_length)) {
1441                                 spin_lock_irqsave(&info->lock, flags);
1442                                 list_add(tmp, &info->rx_urb_q);
1443                                 spin_unlock_irqrestore(&info->lock, flags);
1444                                 tty_flip_buffer_push(tty);
1445                                 schedule_work(&info->rx_work);
1446                                 return;
1447                         }
1448                         tty_insert_flip_string(tty, urb->transfer_buffer, len);
1449                         sent += len;
1450                 }
1451
1452                 urb->dev = port->serial->dev;
1453                 result = usb_submit_urb(urb, GFP_ATOMIC);
1454                 if (result) {
1455                         err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1456                         spin_lock_irqsave(&info->lock, flags);
1457                         list_add(tmp, &info->rx_urbs_free);
1458                         continue;
1459                 }
1460
1461                 spin_lock_irqsave(&info->lock, flags);
1462                 list_add(tmp, &info->rx_urbs_submitted);
1463         }
1464         spin_unlock_irqrestore(&info->lock, flags);
1465
1466         if (sent)
1467                 tty_flip_buffer_push(tty);
1468 }
1469
1470
1471 /*****************************************************************************
1472  * Connect Tech's White Heat module functions
1473  *****************************************************************************/
1474 static int __init whiteheat_init (void)
1475 {
1476         int retval;
1477         retval = usb_serial_register(&whiteheat_fake_device);
1478         if (retval)
1479                 goto failed_fake_register;
1480         retval = usb_serial_register(&whiteheat_device);
1481         if (retval)
1482                 goto failed_device_register;
1483         retval = usb_register(&whiteheat_driver);
1484         if (retval)
1485                 goto failed_usb_register;
1486         info(DRIVER_DESC " " DRIVER_VERSION);
1487         return 0;
1488 failed_usb_register:
1489         usb_serial_deregister(&whiteheat_device);
1490 failed_device_register:
1491         usb_serial_deregister(&whiteheat_fake_device);
1492 failed_fake_register:
1493         return retval;
1494 }
1495
1496
1497 static void __exit whiteheat_exit (void)
1498 {
1499         usb_deregister (&whiteheat_driver);
1500         usb_serial_deregister (&whiteheat_fake_device);
1501         usb_serial_deregister (&whiteheat_device);
1502 }
1503
1504
1505 module_init(whiteheat_init);
1506 module_exit(whiteheat_exit);
1507
1508 MODULE_AUTHOR( DRIVER_AUTHOR );
1509 MODULE_DESCRIPTION( DRIVER_DESC );
1510 MODULE_LICENSE("GPL");
1511
1512 module_param(urb_pool_size, int, 0);
1513 MODULE_PARM_DESC(urb_pool_size, "Number of urbs to use for buffering");
1514
1515 module_param(debug, bool, S_IRUGO | S_IWUSR);
1516 MODULE_PARM_DESC(debug, "Debug enabled or not");