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
  16  * driver
  17  */
  18
  19 #include <linux/kernel.h>
  20 #include <linux/errno.h>
  21 #include <linux/slab.h>
  22 #include <linux/tty.h>
  23 #include <linux/tty_driver.h>
  24 #include <linux/tty_flip.h>
  25 #include <linux/module.h>
  26 #include <linux/spinlock.h>
  27 #include <linux/mutex.h>
  28 #include <linux/uaccess.h>
  29 #include <asm/termbits.h>
  30 #include <linux/usb.h>
  31 #include <linux/serial_reg.h>
  32 #include <linux/serial.h>
  33 #include <linux/usb/serial.h>
  34 #include <linux/usb/ezusb.h>
  35 #include "whiteheat.h"                  /* WhiteHEAT specific commands */
  36
  37 #ifndef CMSPAR
  38 #define CMSPAR 0
  39 #endif
  40
  41 /*
  42  * Version Information
  43  */
  44 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Stuart MacDonald <stuartm@connecttech.com>"
  45 #define DRIVER_DESC "USB ConnectTech WhiteHEAT driver"
  46
  47 #define CONNECT_TECH_VENDOR_ID          0x0710
  48 #define CONNECT_TECH_FAKE_WHITE_HEAT_ID 0x0001
  49 #define CONNECT_TECH_WHITE_HEAT_ID      0x8001
  50
  51 /*
  52    ID tables for whiteheat are unusual, because we want to different
  53    things for different versions of the device.  Eventually, this
  54    will be doable from a single table.  But, for now, we define two
  55    separate ID tables, and then a third table that combines them
  56    just for the purpose of exporting the autoloading information.
  57 */
  58 static const struct usb_device_id id_table_std[] = {
  59         { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) },
  60         { }                                             /* Terminating entry */
  61 };
  62
  63 static const struct usb_device_id id_table_prerenumeration[] = {
  64         { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) },
  65         { }                                             /* Terminating entry */
  66 };
  67
  68 static const struct usb_device_id id_table_combined[] = {
  69         { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) },
  70         { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) },
  71         { }                                             /* Terminating entry */
  72 };
  73
  74 MODULE_DEVICE_TABLE(usb, id_table_combined);
  75
  76
  77 /* function prototypes for the Connect Tech WhiteHEAT prerenumeration device */
  78 static int  whiteheat_firmware_download(struct usb_serial *serial,
  79                                         const struct usb_device_id *id);
  80 static int  whiteheat_firmware_attach(struct usb_serial *serial);
  81
  82 /* function prototypes for the Connect Tech WhiteHEAT serial converter */
  83 static int  whiteheat_attach(struct usb_serial *serial);
  84 static void whiteheat_release(struct usb_serial *serial);
  85 static int  whiteheat_port_probe(struct usb_serial_port *port);
  86 static int  whiteheat_port_remove(struct usb_serial_port *port);
  87 static int  whiteheat_open(struct tty_struct *tty,
  88                         struct usb_serial_port *port);
  89 static void whiteheat_close(struct usb_serial_port *port);
  90 static int  whiteheat_ioctl(struct tty_struct *tty,
  91                         unsigned int cmd, unsigned long arg);
  92 static void whiteheat_set_termios(struct tty_struct *tty,
  93                         struct usb_serial_port *port, struct ktermios *old);
  94 static int  whiteheat_tiocmget(struct tty_struct *tty);
  95 static int  whiteheat_tiocmset(struct tty_struct *tty,
  96                         unsigned int set, unsigned int clear);
  97 static void whiteheat_break_ctl(struct tty_struct *tty, int break_state);
  98
  99 static struct usb_serial_driver whiteheat_fake_device = {
 100         .driver = {
 101                 .owner =        THIS_MODULE,
 102                 .name =         "whiteheatnofirm",
 103         },
 104         .description =          "Connect Tech - WhiteHEAT - (prerenumeration)",
 105         .id_table =             id_table_prerenumeration,
 106         .num_ports =            1,
 107         .probe =                whiteheat_firmware_download,
 108         .attach =               whiteheat_firmware_attach,
 109 };
 110
 111 static struct usb_serial_driver whiteheat_device = {
 112         .driver = {
 113                 .owner =        THIS_MODULE,
 114                 .name =         "whiteheat",
 115         },
 116         .description =          "Connect Tech - WhiteHEAT",
 117         .id_table =             id_table_std,
 118         .num_ports =            4,
 119         .num_bulk_in =          5,
 120         .num_bulk_out =         5,
 121         .attach =               whiteheat_attach,
 122         .release =              whiteheat_release,
 123         .port_probe =           whiteheat_port_probe,
 124         .port_remove =          whiteheat_port_remove,
 125         .open =                 whiteheat_open,
 126         .close =                whiteheat_close,
 127         .ioctl =                whiteheat_ioctl,
 128         .set_termios =          whiteheat_set_termios,
 129         .break_ctl =            whiteheat_break_ctl,
 130         .tiocmget =             whiteheat_tiocmget,
 131         .tiocmset =             whiteheat_tiocmset,
 132         .throttle =             usb_serial_generic_throttle,
 133         .unthrottle =           usb_serial_generic_unthrottle,
 134 };
 135
 136 static struct usb_serial_driver * const serial_drivers[] = {
 137         &whiteheat_fake_device, &whiteheat_device, NULL
 138 };
 139
 140 struct whiteheat_command_private {
 141         struct mutex            mutex;
 142         __u8                    port_running;
 143         __u8                    command_finished;
 144         wait_queue_head_t       wait_command; /* for handling sleeping whilst
 145                                                  waiting for a command to
 146                                                  finish */
 147         __u8                    result_buffer[64];
 148 };
 149
 150 struct whiteheat_private {
 151         __u8                    mcr;            /* FIXME: no locking on mcr */
 152 };
 153
 154
 155 /* local function prototypes */
 156 static int start_command_port(struct usb_serial *serial);
 157 static void stop_command_port(struct usb_serial *serial);
 158 static void command_port_write_callback(struct urb *urb);
 159 static void command_port_read_callback(struct urb *urb);
 160
 161 static int firm_send_command(struct usb_serial_port *port, __u8 command,
 162                                                 __u8 *data, __u8 datasize);
 163 static int firm_open(struct usb_serial_port *port);
 164 static int firm_close(struct usb_serial_port *port);
 165 static void firm_setup_port(struct tty_struct *tty);
 166 static int firm_set_rts(struct usb_serial_port *port, __u8 onoff);
 167 static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff);
 168 static int firm_set_break(struct usb_serial_port *port, __u8 onoff);
 169 static int firm_purge(struct usb_serial_port *port, __u8 rxtx);
 170 static int firm_get_dtr_rts(struct usb_serial_port *port);
 171 static int firm_report_tx_done(struct usb_serial_port *port);
 172
 173
 174 #define COMMAND_PORT            4
 175 #define COMMAND_TIMEOUT         (2*HZ)  /* 2 second timeout for a command */
 176 #define COMMAND_TIMEOUT_MS      2000
 177 #define CLOSING_DELAY           (30 * HZ)
 178
 179
 180 /*****************************************************************************
 181  * Connect Tech's White Heat prerenumeration driver functions
 182  *****************************************************************************/
 183
 184 /* steps to download the firmware to the WhiteHEAT device:
 185  - hold the reset (by writing to the reset bit of the CPUCS register)
 186  - download the VEND_AX.HEX file to the chip using VENDOR_REQUEST-ANCHOR_LOAD
 187  - release the reset (by writing to the CPUCS register)
 188  - download the WH.HEX file for all addresses greater than 0x1b3f using
 189    VENDOR_REQUEST-ANCHOR_EXTERNAL_RAM_LOAD
 190  - hold the reset
 191  - download the WH.HEX file for all addresses less than 0x1b40 using
 192    VENDOR_REQUEST_ANCHOR_LOAD
 193  - release the reset
 194  - device renumerated itself and comes up as new device id with all
 195    firmware download completed.
 196 */
 197 static int whiteheat_firmware_download(struct usb_serial *serial,
 198                                         const struct usb_device_id *id)
 199 {
 200         int response;
 201
 202         response = ezusb_fx1_ihex_firmware_download(serial->dev, "/*(DEBLOBBED)*/");
 203         if (response >= 0) {
 204                 response = ezusb_fx1_ihex_firmware_download(serial->dev, "/*(DEBLOBBED)*/");
 205                 if (response >= 0)
 206                         return 0;
 207         }
 208         return -ENOENT;
 209 }
 210
 211
 212 static int whiteheat_firmware_attach(struct usb_serial *serial)
 213 {
 214         /* We want this device to fail to have a driver assigned to it */
 215         return 1;
 216 }
 217
 218
 219 /*****************************************************************************
 220  * Connect Tech's White Heat serial driver functions
 221  *****************************************************************************/
 222
 223 static int whiteheat_attach(struct usb_serial *serial)
 224 {
 225         struct usb_serial_port *command_port;
 226         struct whiteheat_command_private *command_info;
 227         struct whiteheat_hw_info *hw_info;
 228         int pipe;
 229         int ret;
 230         int alen;
 231         __u8 *command;
 232         __u8 *result;
 233
 234         command_port = serial->port[COMMAND_PORT];
 235
 236         pipe = usb_sndbulkpipe(serial->dev,
 237                         command_port->bulk_out_endpointAddress);
 238         command = kmalloc(2, GFP_KERNEL);
 239         if (!command)
 240                 goto no_command_buffer;
 241         command[0] = WHITEHEAT_GET_HW_INFO;
 242         command[1] = 0;
 243
 244         result = kmalloc(sizeof(*hw_info) + 1, GFP_KERNEL);
 245         if (!result)
 246                 goto no_result_buffer;
 247         /*
 248          * When the module is reloaded the firmware is still there and
 249          * the endpoints are still in the usb core unchanged. This is the
 250          * unlinking bug in disguise. Same for the call below.
 251          */
 252         usb_clear_halt(serial->dev, pipe);
 253         ret = usb_bulk_msg(serial->dev, pipe, command, 2,
 254                                                 &alen, COMMAND_TIMEOUT_MS);
 255         if (ret) {
 256                 dev_err(&serial->dev->dev, "%s: Couldn't send command [%d]\n",
 257                         serial->type->description, ret);
 258                 goto no_firmware;
 259         } else if (alen != 2) {
 260                 dev_err(&serial->dev->dev, "%s: Send command incomplete [%d]\n",
 261                         serial->type->description, alen);
 262                 goto no_firmware;
 263         }
 264
 265         pipe = usb_rcvbulkpipe(serial->dev,
 266                                 command_port->bulk_in_endpointAddress);
 267         /* See the comment on the usb_clear_halt() above */
 268         usb_clear_halt(serial->dev, pipe);
 269         ret = usb_bulk_msg(serial->dev, pipe, result,
 270                         sizeof(*hw_info) + 1, &alen, COMMAND_TIMEOUT_MS);
 271         if (ret) {
 272                 dev_err(&serial->dev->dev, "%s: Couldn't get results [%d]\n",
 273                         serial->type->description, ret);
 274                 goto no_firmware;
 275         } else if (alen != sizeof(*hw_info) + 1) {
 276                 dev_err(&serial->dev->dev, "%s: Get results incomplete [%d]\n",
 277                         serial->type->description, alen);
 278                 goto no_firmware;
 279         } else if (result[0] != command[0]) {
 280                 dev_err(&serial->dev->dev, "%s: Command failed [%d]\n",
 281                         serial->type->description, result[0]);
 282                 goto no_firmware;
 283         }
 284
 285         hw_info = (struct whiteheat_hw_info *)&result[1];
 286
 287         dev_info(&serial->dev->dev, "%s: Firmware v%d.%02d\n",
 288                  serial->type->description,
 289                  hw_info->sw_major_rev, hw_info->sw_minor_rev);
 290
 291         command_info = kmalloc(sizeof(struct whiteheat_command_private),
 292                                                                 GFP_KERNEL);
 293         if (!command_info)
 294                 goto no_command_private;
 295
 296         mutex_init(&command_info->mutex);
 297         command_info->port_running = 0;
 298         init_waitqueue_head(&command_info->wait_command);
 299         usb_set_serial_port_data(command_port, command_info);
 300         command_port->write_urb->complete = command_port_write_callback;
 301         command_port->read_urb->complete = command_port_read_callback;
 302         kfree(result);
 303         kfree(command);
 304
 305         return 0;
 306
 307 no_firmware:
 308         /* Firmware likely not running */
 309         dev_err(&serial->dev->dev,
 310                 "%s: Unable to retrieve firmware version, try replugging\n",
 311                 serial->type->description);
 312         dev_err(&serial->dev->dev,
 313                 "%s: If the firmware is not running (status led not blinking)\n",
 314                 serial->type->description);
 315         dev_err(&serial->dev->dev,
 316                 "%s: please contact support@connecttech.com\n",
 317                 serial->type->description);
 318         kfree(result);
 319         kfree(command);
 320         return -ENODEV;
 321
 322 no_command_private:
 323         kfree(result);
 324 no_result_buffer:
 325         kfree(command);
 326 no_command_buffer:
 327         return -ENOMEM;
 328 }
 329
 330 static void whiteheat_release(struct usb_serial *serial)
 331 {
 332         struct usb_serial_port *command_port;
 333
 334         /* free up our private data for our command port */
 335         command_port = serial->port[COMMAND_PORT];
 336         kfree(usb_get_serial_port_data(command_port));
 337 }
 338
 339 static int whiteheat_port_probe(struct usb_serial_port *port)
 340 {
 341         struct whiteheat_private *info;
 342
 343         info = kzalloc(sizeof(*info), GFP_KERNEL);
 344         if (!info)
 345                 return -ENOMEM;
 346
 347         usb_set_serial_port_data(port, info);
 348
 349         return 0;
 350 }
 351
 352 static int whiteheat_port_remove(struct usb_serial_port *port)
 353 {
 354         struct whiteheat_private *info;
 355
 356         info = usb_get_serial_port_data(port);
 357         kfree(info);
 358
 359         return 0;
 360 }
 361
 362 static int whiteheat_open(struct tty_struct *tty, struct usb_serial_port *port)
 363 {
 364         int retval;
 365
 366         retval = start_command_port(port->serial);
 367         if (retval)
 368                 goto exit;
 369
 370         /* send an open port command */
 371         retval = firm_open(port);
 372         if (retval) {
 373                 stop_command_port(port->serial);
 374                 goto exit;
 375         }
 376
 377         retval = firm_purge(port, WHITEHEAT_PURGE_RX | WHITEHEAT_PURGE_TX);
 378         if (retval) {
 379                 firm_close(port);
 380                 stop_command_port(port->serial);
 381                 goto exit;
 382         }
 383
 384         if (tty)
 385                 firm_setup_port(tty);
 386
 387         /* Work around HCD bugs */
 388         usb_clear_halt(port->serial->dev, port->read_urb->pipe);
 389         usb_clear_halt(port->serial->dev, port->write_urb->pipe);
 390
 391         retval = usb_serial_generic_open(tty, port);
 392         if (retval) {
 393                 firm_close(port);
 394                 stop_command_port(port->serial);
 395                 goto exit;
 396         }
 397 exit:
 398         return retval;
 399 }
 400
 401
 402 static void whiteheat_close(struct usb_serial_port *port)
 403 {
 404         firm_report_tx_done(port);
 405         firm_close(port);
 406
 407         usb_serial_generic_close(port);
 408
 409         stop_command_port(port->serial);
 410 }
 411
 412 static int whiteheat_tiocmget(struct tty_struct *tty)
 413 {
 414         struct usb_serial_port *port = tty->driver_data;
 415         struct whiteheat_private *info = usb_get_serial_port_data(port);
 416         unsigned int modem_signals = 0;
 417
 418         firm_get_dtr_rts(port);
 419         if (info->mcr & UART_MCR_DTR)
 420                 modem_signals |= TIOCM_DTR;
 421         if (info->mcr & UART_MCR_RTS)
 422                 modem_signals |= TIOCM_RTS;
 423
 424         return modem_signals;
 425 }
 426
 427 static int whiteheat_tiocmset(struct tty_struct *tty,
 428                                unsigned int set, unsigned int clear)
 429 {
 430         struct usb_serial_port *port = tty->driver_data;
 431         struct whiteheat_private *info = usb_get_serial_port_data(port);
 432
 433         if (set & TIOCM_RTS)
 434                 info->mcr |= UART_MCR_RTS;
 435         if (set & TIOCM_DTR)
 436                 info->mcr |= UART_MCR_DTR;
 437
 438         if (clear & TIOCM_RTS)
 439                 info->mcr &= ~UART_MCR_RTS;
 440         if (clear & TIOCM_DTR)
 441                 info->mcr &= ~UART_MCR_DTR;
 442
 443         firm_set_dtr(port, info->mcr & UART_MCR_DTR);
 444         firm_set_rts(port, info->mcr & UART_MCR_RTS);
 445         return 0;
 446 }
 447
 448
 449 static int whiteheat_ioctl(struct tty_struct *tty,
 450                                         unsigned int cmd, unsigned long arg)
 451 {
 452         struct usb_serial_port *port = tty->driver_data;
 453         struct serial_struct serstruct;
 454         void __user *user_arg = (void __user *)arg;
 455
 456         switch (cmd) {
 457         case TIOCGSERIAL:
 458                 memset(&serstruct, 0, sizeof(serstruct));
 459                 serstruct.type = PORT_16654;
 460                 serstruct.line = port->minor;
 461                 serstruct.port = port->port_number;
 462                 serstruct.xmit_fifo_size = kfifo_size(&port->write_fifo);
 463                 serstruct.custom_divisor = 0;
 464                 serstruct.baud_base = 460800;
 465                 serstruct.close_delay = CLOSING_DELAY;
 466                 serstruct.closing_wait = CLOSING_DELAY;
 467
 468                 if (copy_to_user(user_arg, &serstruct, sizeof(serstruct)))
 469                         return -EFAULT;
 470                 break;
 471         default:
 472                 break;
 473         }
 474
 475         return -ENOIOCTLCMD;
 476 }
 477
 478
 479 static void whiteheat_set_termios(struct tty_struct *tty,
 480         struct usb_serial_port *port, struct ktermios *old_termios)
 481 {
 482         firm_setup_port(tty);
 483 }
 484
 485 static void whiteheat_break_ctl(struct tty_struct *tty, int break_state)
 486 {
 487         struct usb_serial_port *port = tty->driver_data;
 488         firm_set_break(port, break_state);
 489 }
 490
 491
 492 /*****************************************************************************
 493  * Connect Tech's White Heat callback routines
 494  *****************************************************************************/
 495 static void command_port_write_callback(struct urb *urb)
 496 {
 497         int status = urb->status;
 498
 499         if (status) {
 500                 dev_dbg(&urb->dev->dev, "nonzero urb status: %d\n", status);
 501                 return;
 502         }
 503 }
 504
 505
 506 static void command_port_read_callback(struct urb *urb)
 507 {
 508         struct usb_serial_port *command_port = urb->context;
 509         struct whiteheat_command_private *command_info;
 510         int status = urb->status;
 511         unsigned char *data = urb->transfer_buffer;
 512         int result;
 513
 514         command_info = usb_get_serial_port_data(command_port);
 515         if (!command_info) {
 516                 dev_dbg(&urb->dev->dev, "%s - command_info is NULL, exiting.\n", __func__);
 517                 return;
 518         }
 519         if (!urb->actual_length) {
 520                 dev_dbg(&urb->dev->dev, "%s - empty response, exiting.\n", __func__);
 521                 return;
 522         }
 523         if (status) {
 524                 dev_dbg(&urb->dev->dev, "%s - nonzero urb status: %d\n", __func__, status);
 525                 if (status != -ENOENT)
 526                         command_info->command_finished = WHITEHEAT_CMD_FAILURE;
 527                 wake_up(&command_info->wait_command);
 528                 return;
 529         }
 530
 531         usb_serial_debug_data(&command_port->dev, __func__, urb->actual_length, data);
 532
 533         if (data[0] == WHITEHEAT_CMD_COMPLETE) {
 534                 command_info->command_finished = WHITEHEAT_CMD_COMPLETE;
 535                 wake_up(&command_info->wait_command);
 536         } else if (data[0] == WHITEHEAT_CMD_FAILURE) {
 537                 command_info->command_finished = WHITEHEAT_CMD_FAILURE;
 538                 wake_up(&command_info->wait_command);
 539         } else if (data[0] == WHITEHEAT_EVENT) {
 540                 /* These are unsolicited reports from the firmware, hence no
 541                    waiting command to wakeup */
 542                 dev_dbg(&urb->dev->dev, "%s - event received\n", __func__);
 543         } else if ((data[0] == WHITEHEAT_GET_DTR_RTS) &&
 544                 (urb->actual_length - 1 <= sizeof(command_info->result_buffer))) {
 545                 memcpy(command_info->result_buffer, &data[1],
 546                                                 urb->actual_length - 1);
 547                 command_info->command_finished = WHITEHEAT_CMD_COMPLETE;
 548                 wake_up(&command_info->wait_command);
 549         } else
 550                 dev_dbg(&urb->dev->dev, "%s - bad reply from firmware\n", __func__);
 551
 552         /* Continue trying to always read */
 553         result = usb_submit_urb(command_port->read_urb, GFP_ATOMIC);
 554         if (result)
 555                 dev_dbg(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n",
 556                         __func__, result);
 557 }
 558
 559
 560 /*****************************************************************************
 561  * Connect Tech's White Heat firmware interface
 562  *****************************************************************************/
 563 static int firm_send_command(struct usb_serial_port *port, __u8 command,
 564                                                 __u8 *data, __u8 datasize)
 565 {
 566         struct usb_serial_port *command_port;
 567         struct whiteheat_command_private *command_info;
 568         struct whiteheat_private *info;
 569         struct device *dev = &port->dev;
 570         __u8 *transfer_buffer;
 571         int retval = 0;
 572         int t;
 573
 574         dev_dbg(dev, "%s - command %d\n", __func__, command);
 575
 576         command_port = port->serial->port[COMMAND_PORT];
 577         command_info = usb_get_serial_port_data(command_port);
 578
 579         if (command_port->bulk_out_size < datasize + 1)
 580                 return -EIO;
 581
 582         mutex_lock(&command_info->mutex);
 583         command_info->command_finished = false;
 584
 585         transfer_buffer = (__u8 *)command_port->write_urb->transfer_buffer;
 586         transfer_buffer[0] = command;
 587         memcpy(&transfer_buffer[1], data, datasize);
 588         command_port->write_urb->transfer_buffer_length = datasize + 1;
 589         retval = usb_submit_urb(command_port->write_urb, GFP_NOIO);
 590         if (retval) {
 591                 dev_dbg(dev, "%s - submit urb failed\n", __func__);
 592                 goto exit;
 593         }
 594
 595         /* wait for the command to complete */
 596         t = wait_event_timeout(command_info->wait_command,
 597                 (bool)command_info->command_finished, COMMAND_TIMEOUT);
 598         if (!t)
 599                 usb_kill_urb(command_port->write_urb);
 600
 601         if (command_info->command_finished == false) {
 602                 dev_dbg(dev, "%s - command timed out.\n", __func__);
 603                 retval = -ETIMEDOUT;
 604                 goto exit;
 605         }
 606
 607         if (command_info->command_finished == WHITEHEAT_CMD_FAILURE) {
 608                 dev_dbg(dev, "%s - command failed.\n", __func__);
 609                 retval = -EIO;
 610                 goto exit;
 611         }
 612
 613         if (command_info->command_finished == WHITEHEAT_CMD_COMPLETE) {
 614                 dev_dbg(dev, "%s - command completed.\n", __func__);
 615                 switch (command) {
 616                 case WHITEHEAT_GET_DTR_RTS:
 617                         info = usb_get_serial_port_data(port);
 618                         memcpy(&info->mcr, command_info->result_buffer,
 619                                         sizeof(struct whiteheat_dr_info));
 620                                 break;
 621                 }
 622         }
 623 exit:
 624         mutex_unlock(&command_info->mutex);
 625         return retval;
 626 }
 627
 628
 629 static int firm_open(struct usb_serial_port *port)
 630 {
 631         struct whiteheat_simple open_command;
 632
 633         open_command.port = port->port_number + 1;
 634         return firm_send_command(port, WHITEHEAT_OPEN,
 635                 (__u8 *)&open_command, sizeof(open_command));
 636 }
 637
 638
 639 static int firm_close(struct usb_serial_port *port)
 640 {
 641         struct whiteheat_simple close_command;
 642
 643         close_command.port = port->port_number + 1;
 644         return firm_send_command(port, WHITEHEAT_CLOSE,
 645                         (__u8 *)&close_command, sizeof(close_command));
 646 }
 647
 648
 649 static void firm_setup_port(struct tty_struct *tty)
 650 {
 651         struct usb_serial_port *port = tty->driver_data;
 652         struct device *dev = &port->dev;
 653         struct whiteheat_port_settings port_settings;
 654         unsigned int cflag = tty->termios.c_cflag;
 655         speed_t baud;
 656
 657         port_settings.port = port->port_number + 1;
 658
 659         /* get the byte size */
 660         switch (cflag & CSIZE) {
 661         case CS5:       port_settings.bits = 5;   break;
 662         case CS6:       port_settings.bits = 6;   break;
 663         case CS7:       port_settings.bits = 7;   break;
 664         default:
 665         case CS8:       port_settings.bits = 8;   break;
 666         }
 667         dev_dbg(dev, "%s - data bits = %d\n", __func__, port_settings.bits);
 668
 669         /* determine the parity */
 670         if (cflag & PARENB)
 671                 if (cflag & CMSPAR)
 672                         if (cflag & PARODD)
 673                                 port_settings.parity = WHITEHEAT_PAR_MARK;
 674                         else
 675                                 port_settings.parity = WHITEHEAT_PAR_SPACE;
 676                 else
 677                         if (cflag & PARODD)
 678                                 port_settings.parity = WHITEHEAT_PAR_ODD;
 679                         else
 680                                 port_settings.parity = WHITEHEAT_PAR_EVEN;
 681         else
 682                 port_settings.parity = WHITEHEAT_PAR_NONE;
 683         dev_dbg(dev, "%s - parity = %c\n", __func__, port_settings.parity);
 684
 685         /* figure out the stop bits requested */
 686         if (cflag & CSTOPB)
 687                 port_settings.stop = 2;
 688         else
 689                 port_settings.stop = 1;
 690         dev_dbg(dev, "%s - stop bits = %d\n", __func__, port_settings.stop);
 691
 692         /* figure out the flow control settings */
 693         if (cflag & CRTSCTS)
 694                 port_settings.hflow = (WHITEHEAT_HFLOW_CTS |
 695                                                 WHITEHEAT_HFLOW_RTS);
 696         else
 697                 port_settings.hflow = WHITEHEAT_HFLOW_NONE;
 698         dev_dbg(dev, "%s - hardware flow control = %s %s %s %s\n", __func__,
 699             (port_settings.hflow & WHITEHEAT_HFLOW_CTS) ? "CTS" : "",
 700             (port_settings.hflow & WHITEHEAT_HFLOW_RTS) ? "RTS" : "",
 701             (port_settings.hflow & WHITEHEAT_HFLOW_DSR) ? "DSR" : "",
 702             (port_settings.hflow & WHITEHEAT_HFLOW_DTR) ? "DTR" : "");
 703
 704         /* determine software flow control */
 705         if (I_IXOFF(tty))
 706                 port_settings.sflow = WHITEHEAT_SFLOW_RXTX;
 707         else
 708                 port_settings.sflow = WHITEHEAT_SFLOW_NONE;
 709         dev_dbg(dev, "%s - software flow control = %c\n", __func__, port_settings.sflow);
 710
 711         port_settings.xon = START_CHAR(tty);
 712         port_settings.xoff = STOP_CHAR(tty);
 713         dev_dbg(dev, "%s - XON = %2x, XOFF = %2x\n", __func__, port_settings.xon, port_settings.xoff);
 714
 715         /* get the baud rate wanted */
 716         baud = tty_get_baud_rate(tty);
 717         port_settings.baud = cpu_to_le32(baud);
 718         dev_dbg(dev, "%s - baud rate = %u\n", __func__, baud);
 719
 720         /* fixme: should set validated settings */
 721         tty_encode_baud_rate(tty, baud, baud);
 722
 723         /* handle any settings that aren't specified in the tty structure */
 724         port_settings.lloop = 0;
 725
 726         /* now send the message to the device */
 727         firm_send_command(port, WHITEHEAT_SETUP_PORT,
 728                         (__u8 *)&port_settings, sizeof(port_settings));
 729 }
 730
 731
 732 static int firm_set_rts(struct usb_serial_port *port, __u8 onoff)
 733 {
 734         struct whiteheat_set_rdb rts_command;
 735
 736         rts_command.port = port->port_number + 1;
 737         rts_command.state = onoff;
 738         return firm_send_command(port, WHITEHEAT_SET_RTS,
 739                         (__u8 *)&rts_command, sizeof(rts_command));
 740 }
 741
 742
 743 static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff)
 744 {
 745         struct whiteheat_set_rdb dtr_command;
 746
 747         dtr_command.port = port->port_number + 1;
 748         dtr_command.state = onoff;
 749         return firm_send_command(port, WHITEHEAT_SET_DTR,
 750                         (__u8 *)&dtr_command, sizeof(dtr_command));
 751 }
 752
 753
 754 static int firm_set_break(struct usb_serial_port *port, __u8 onoff)
 755 {
 756         struct whiteheat_set_rdb break_command;
 757
 758         break_command.port = port->port_number + 1;
 759         break_command.state = onoff;
 760         return firm_send_command(port, WHITEHEAT_SET_BREAK,
 761                         (__u8 *)&break_command, sizeof(break_command));
 762 }
 763
 764
 765 static int firm_purge(struct usb_serial_port *port, __u8 rxtx)
 766 {
 767         struct whiteheat_purge purge_command;
 768
 769         purge_command.port = port->port_number + 1;
 770         purge_command.what = rxtx;
 771         return firm_send_command(port, WHITEHEAT_PURGE,
 772                         (__u8 *)&purge_command, sizeof(purge_command));
 773 }
 774
 775
 776 static int firm_get_dtr_rts(struct usb_serial_port *port)
 777 {
 778         struct whiteheat_simple get_dr_command;
 779
 780         get_dr_command.port = port->port_number + 1;
 781         return firm_send_command(port, WHITEHEAT_GET_DTR_RTS,
 782                         (__u8 *)&get_dr_command, sizeof(get_dr_command));
 783 }
 784
 785
 786 static int firm_report_tx_done(struct usb_serial_port *port)
 787 {
 788         struct whiteheat_simple close_command;
 789
 790         close_command.port = port->port_number + 1;
 791         return firm_send_command(port, WHITEHEAT_REPORT_TX_DONE,
 792                         (__u8 *)&close_command, sizeof(close_command));
 793 }
 794
 795
 796 /*****************************************************************************
 797  * Connect Tech's White Heat utility functions
 798  *****************************************************************************/
 799 static int start_command_port(struct usb_serial *serial)
 800 {
 801         struct usb_serial_port *command_port;
 802         struct whiteheat_command_private *command_info;
 803         int retval = 0;
 804
 805         command_port = serial->port[COMMAND_PORT];
 806         command_info = usb_get_serial_port_data(command_port);
 807         mutex_lock(&command_info->mutex);
 808         if (!command_info->port_running) {
 809                 /* Work around HCD bugs */
 810                 usb_clear_halt(serial->dev, command_port->read_urb->pipe);
 811
 812                 retval = usb_submit_urb(command_port->read_urb, GFP_KERNEL);
 813                 if (retval) {
 814                         dev_err(&serial->dev->dev,
 815                                 "%s - failed submitting read urb, error %d\n",
 816                                 __func__, retval);
 817                         goto exit;
 818                 }
 819         }
 820         command_info->port_running++;
 821
 822 exit:
 823         mutex_unlock(&command_info->mutex);
 824         return retval;
 825 }
 826
 827
 828 static void stop_command_port(struct usb_serial *serial)
 829 {
 830         struct usb_serial_port *command_port;
 831         struct whiteheat_command_private *command_info;
 832
 833         command_port = serial->port[COMMAND_PORT];
 834         command_info = usb_get_serial_port_data(command_port);
 835         mutex_lock(&command_info->mutex);
 836         command_info->port_running--;
 837         if (!command_info->port_running)
 838                 usb_kill_urb(command_port->read_urb);
 839         mutex_unlock(&command_info->mutex);
 840 }
 841
 842 module_usb_serial_driver(serial_drivers, id_table_combined);
 843
 844 MODULE_AUTHOR(DRIVER_AUTHOR);
 845 MODULE_DESCRIPTION(DRIVER_DESC);
 846 MODULE_LICENSE("GPL");
 847
 848 /*(DEBLOBBED)*/