drivers/usb/serial/whiteheat.c

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