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