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