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 == NULL) { 292 dev_err(&serial->dev->dev, 293 "%s: Out of memory for port structures\n", 294 serial->type->description); 295 goto no_command_private; 296 } 297 298 mutex_init(&command_info->mutex); 299 command_info->port_running = 0; 300 init_waitqueue_head(&command_info->wait_command); 301 usb_set_serial_port_data(command_port, command_info); 302 command_port->write_urb->complete = command_port_write_callback; 303 command_port->read_urb->complete = command_port_read_callback; 304 kfree(result); 305 kfree(command); 306 307 return 0; 308 309 no_firmware: 310 /* Firmware likely not running */ 311 dev_err(&serial->dev->dev, 312 "%s: Unable to retrieve firmware version, try replugging\n", 313 serial->type->description); 314 dev_err(&serial->dev->dev, 315 "%s: If the firmware is not running (status led not blinking)\n", 316 serial->type->description); 317 dev_err(&serial->dev->dev, 318 "%s: please contact support@connecttech.com\n", 319 serial->type->description); 320 kfree(result); 321 kfree(command); 322 return -ENODEV; 323 324 no_command_private: 325 kfree(result); 326 no_result_buffer: 327 kfree(command); 328 no_command_buffer: 329 return -ENOMEM; 330 } 331 332 static void whiteheat_release(struct usb_serial *serial) 333 { 334 struct usb_serial_port *command_port; 335 336 /* free up our private data for our command port */ 337 command_port = serial->port[COMMAND_PORT]; 338 kfree(usb_get_serial_port_data(command_port)); 339 } 340 341 static int whiteheat_port_probe(struct usb_serial_port *port) 342 { 343 struct whiteheat_private *info; 344 345 info = kzalloc(sizeof(*info), GFP_KERNEL); 346 if (!info) 347 return -ENOMEM; 348 349 usb_set_serial_port_data(port, info); 350 351 return 0; 352 } 353 354 static int whiteheat_port_remove(struct usb_serial_port *port) 355 { 356 struct whiteheat_private *info; 357 358 info = usb_get_serial_port_data(port); 359 kfree(info); 360 361 return 0; 362 } 363 364 static int whiteheat_open(struct tty_struct *tty, struct usb_serial_port *port) 365 { 366 int retval; 367 368 retval = start_command_port(port->serial); 369 if (retval) 370 goto exit; 371 372 /* send an open port command */ 373 retval = firm_open(port); 374 if (retval) { 375 stop_command_port(port->serial); 376 goto exit; 377 } 378 379 retval = firm_purge(port, WHITEHEAT_PURGE_RX | WHITEHEAT_PURGE_TX); 380 if (retval) { 381 firm_close(port); 382 stop_command_port(port->serial); 383 goto exit; 384 } 385 386 if (tty) 387 firm_setup_port(tty); 388 389 /* Work around HCD bugs */ 390 usb_clear_halt(port->serial->dev, port->read_urb->pipe); 391 usb_clear_halt(port->serial->dev, port->write_urb->pipe); 392 393 retval = usb_serial_generic_open(tty, port); 394 if (retval) { 395 firm_close(port); 396 stop_command_port(port->serial); 397 goto exit; 398 } 399 exit: 400 return retval; 401 } 402 403 404 static void whiteheat_close(struct usb_serial_port *port) 405 { 406 firm_report_tx_done(port); 407 firm_close(port); 408 409 usb_serial_generic_close(port); 410 411 stop_command_port(port->serial); 412 } 413 414 static int whiteheat_tiocmget(struct tty_struct *tty) 415 { 416 struct usb_serial_port *port = tty->driver_data; 417 struct whiteheat_private *info = usb_get_serial_port_data(port); 418 unsigned int modem_signals = 0; 419 420 firm_get_dtr_rts(port); 421 if (info->mcr & UART_MCR_DTR) 422 modem_signals |= TIOCM_DTR; 423 if (info->mcr & UART_MCR_RTS) 424 modem_signals |= TIOCM_RTS; 425 426 return modem_signals; 427 } 428 429 static int whiteheat_tiocmset(struct tty_struct *tty, 430 unsigned int set, unsigned int clear) 431 { 432 struct usb_serial_port *port = tty->driver_data; 433 struct whiteheat_private *info = usb_get_serial_port_data(port); 434 435 if (set & TIOCM_RTS) 436 info->mcr |= UART_MCR_RTS; 437 if (set & TIOCM_DTR) 438 info->mcr |= UART_MCR_DTR; 439 440 if (clear & TIOCM_RTS) 441 info->mcr &= ~UART_MCR_RTS; 442 if (clear & TIOCM_DTR) 443 info->mcr &= ~UART_MCR_DTR; 444 445 firm_set_dtr(port, info->mcr & UART_MCR_DTR); 446 firm_set_rts(port, info->mcr & UART_MCR_RTS); 447 return 0; 448 } 449 450 451 static int whiteheat_ioctl(struct tty_struct *tty, 452 unsigned int cmd, unsigned long arg) 453 { 454 struct usb_serial_port *port = tty->driver_data; 455 struct serial_struct serstruct; 456 void __user *user_arg = (void __user *)arg; 457 458 dev_dbg(&port->dev, "%s - cmd 0x%.4x\n", __func__, cmd); 459 460 switch (cmd) { 461 case TIOCGSERIAL: 462 memset(&serstruct, 0, sizeof(serstruct)); 463 serstruct.type = PORT_16654; 464 serstruct.line = port->minor; 465 serstruct.port = port->port_number; 466 serstruct.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ; 467 serstruct.xmit_fifo_size = kfifo_size(&port->write_fifo); 468 serstruct.custom_divisor = 0; 469 serstruct.baud_base = 460800; 470 serstruct.close_delay = CLOSING_DELAY; 471 serstruct.closing_wait = CLOSING_DELAY; 472 473 if (copy_to_user(user_arg, &serstruct, sizeof(serstruct))) 474 return -EFAULT; 475 break; 476 default: 477 break; 478 } 479 480 return -ENOIOCTLCMD; 481 } 482 483 484 static void whiteheat_set_termios(struct tty_struct *tty, 485 struct usb_serial_port *port, struct ktermios *old_termios) 486 { 487 firm_setup_port(tty); 488 } 489 490 static void whiteheat_break_ctl(struct tty_struct *tty, int break_state) 491 { 492 struct usb_serial_port *port = tty->driver_data; 493 firm_set_break(port, break_state); 494 } 495 496 497 /***************************************************************************** 498 * Connect Tech's White Heat callback routines 499 *****************************************************************************/ 500 static void command_port_write_callback(struct urb *urb) 501 { 502 int status = urb->status; 503 504 if (status) { 505 dev_dbg(&urb->dev->dev, "nonzero urb status: %d\n", status); 506 return; 507 } 508 } 509 510 511 static void command_port_read_callback(struct urb *urb) 512 { 513 struct usb_serial_port *command_port = urb->context; 514 struct whiteheat_command_private *command_info; 515 int status = urb->status; 516 unsigned char *data = urb->transfer_buffer; 517 int result; 518 519 command_info = usb_get_serial_port_data(command_port); 520 if (!command_info) { 521 dev_dbg(&urb->dev->dev, "%s - command_info is NULL, exiting.\n", __func__); 522 return; 523 } 524 if (status) { 525 dev_dbg(&urb->dev->dev, "%s - nonzero urb status: %d\n", __func__, status); 526 if (status != -ENOENT) 527 command_info->command_finished = WHITEHEAT_CMD_FAILURE; 528 wake_up(&command_info->wait_command); 529 return; 530 } 531 532 usb_serial_debug_data(&command_port->dev, __func__, urb->actual_length, data); 533 534 if (data[0] == WHITEHEAT_CMD_COMPLETE) { 535 command_info->command_finished = WHITEHEAT_CMD_COMPLETE; 536 wake_up(&command_info->wait_command); 537 } else if (data[0] == WHITEHEAT_CMD_FAILURE) { 538 command_info->command_finished = WHITEHEAT_CMD_FAILURE; 539 wake_up(&command_info->wait_command); 540 } else if (data[0] == WHITEHEAT_EVENT) { 541 /* These are unsolicited reports from the firmware, hence no 542 waiting command to wakeup */ 543 dev_dbg(&urb->dev->dev, "%s - event received\n", __func__); 544 } else if (data[0] == WHITEHEAT_GET_DTR_RTS) { 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 mutex_lock(&command_info->mutex); 579 command_info->command_finished = false; 580 581 transfer_buffer = (__u8 *)command_port->write_urb->transfer_buffer; 582 transfer_buffer[0] = command; 583 memcpy(&transfer_buffer[1], data, datasize); 584 command_port->write_urb->transfer_buffer_length = datasize + 1; 585 retval = usb_submit_urb(command_port->write_urb, GFP_NOIO); 586 if (retval) { 587 dev_dbg(dev, "%s - submit urb failed\n", __func__); 588 goto exit; 589 } 590 591 /* wait for the command to complete */ 592 t = wait_event_timeout(command_info->wait_command, 593 (bool)command_info->command_finished, COMMAND_TIMEOUT); 594 if (!t) 595 usb_kill_urb(command_port->write_urb); 596 597 if (command_info->command_finished == false) { 598 dev_dbg(dev, "%s - command timed out.\n", __func__); 599 retval = -ETIMEDOUT; 600 goto exit; 601 } 602 603 if (command_info->command_finished == WHITEHEAT_CMD_FAILURE) { 604 dev_dbg(dev, "%s - command failed.\n", __func__); 605 retval = -EIO; 606 goto exit; 607 } 608 609 if (command_info->command_finished == WHITEHEAT_CMD_COMPLETE) { 610 dev_dbg(dev, "%s - command completed.\n", __func__); 611 switch (command) { 612 case WHITEHEAT_GET_DTR_RTS: 613 info = usb_get_serial_port_data(port); 614 memcpy(&info->mcr, command_info->result_buffer, 615 sizeof(struct whiteheat_dr_info)); 616 break; 617 } 618 } 619 exit: 620 mutex_unlock(&command_info->mutex); 621 return retval; 622 } 623 624 625 static int firm_open(struct usb_serial_port *port) 626 { 627 struct whiteheat_simple open_command; 628 629 open_command.port = port->port_number + 1; 630 return firm_send_command(port, WHITEHEAT_OPEN, 631 (__u8 *)&open_command, sizeof(open_command)); 632 } 633 634 635 static int firm_close(struct usb_serial_port *port) 636 { 637 struct whiteheat_simple close_command; 638 639 close_command.port = port->port_number + 1; 640 return firm_send_command(port, WHITEHEAT_CLOSE, 641 (__u8 *)&close_command, sizeof(close_command)); 642 } 643 644 645 static void firm_setup_port(struct tty_struct *tty) 646 { 647 struct usb_serial_port *port = tty->driver_data; 648 struct device *dev = &port->dev; 649 struct whiteheat_port_settings port_settings; 650 unsigned int cflag = tty->termios.c_cflag; 651 652 port_settings.port = port->port_number + 1; 653 654 /* get the byte size */ 655 switch (cflag & CSIZE) { 656 case CS5: port_settings.bits = 5; break; 657 case CS6: port_settings.bits = 6; break; 658 case CS7: port_settings.bits = 7; break; 659 default: 660 case CS8: port_settings.bits = 8; break; 661 } 662 dev_dbg(dev, "%s - data bits = %d\n", __func__, port_settings.bits); 663 664 /* determine the parity */ 665 if (cflag & PARENB) 666 if (cflag & CMSPAR) 667 if (cflag & PARODD) 668 port_settings.parity = WHITEHEAT_PAR_MARK; 669 else 670 port_settings.parity = WHITEHEAT_PAR_SPACE; 671 else 672 if (cflag & PARODD) 673 port_settings.parity = WHITEHEAT_PAR_ODD; 674 else 675 port_settings.parity = WHITEHEAT_PAR_EVEN; 676 else 677 port_settings.parity = WHITEHEAT_PAR_NONE; 678 dev_dbg(dev, "%s - parity = %c\n", __func__, port_settings.parity); 679 680 /* figure out the stop bits requested */ 681 if (cflag & CSTOPB) 682 port_settings.stop = 2; 683 else 684 port_settings.stop = 1; 685 dev_dbg(dev, "%s - stop bits = %d\n", __func__, port_settings.stop); 686 687 /* figure out the flow control settings */ 688 if (cflag & CRTSCTS) 689 port_settings.hflow = (WHITEHEAT_HFLOW_CTS | 690 WHITEHEAT_HFLOW_RTS); 691 else 692 port_settings.hflow = WHITEHEAT_HFLOW_NONE; 693 dev_dbg(dev, "%s - hardware flow control = %s %s %s %s\n", __func__, 694 (port_settings.hflow & WHITEHEAT_HFLOW_CTS) ? "CTS" : "", 695 (port_settings.hflow & WHITEHEAT_HFLOW_RTS) ? "RTS" : "", 696 (port_settings.hflow & WHITEHEAT_HFLOW_DSR) ? "DSR" : "", 697 (port_settings.hflow & WHITEHEAT_HFLOW_DTR) ? "DTR" : ""); 698 699 /* determine software flow control */ 700 if (I_IXOFF(tty)) 701 port_settings.sflow = WHITEHEAT_SFLOW_RXTX; 702 else 703 port_settings.sflow = WHITEHEAT_SFLOW_NONE; 704 dev_dbg(dev, "%s - software flow control = %c\n", __func__, port_settings.sflow); 705 706 port_settings.xon = START_CHAR(tty); 707 port_settings.xoff = STOP_CHAR(tty); 708 dev_dbg(dev, "%s - XON = %2x, XOFF = %2x\n", __func__, port_settings.xon, port_settings.xoff); 709 710 /* get the baud rate wanted */ 711 port_settings.baud = tty_get_baud_rate(tty); 712 dev_dbg(dev, "%s - baud rate = %d\n", __func__, port_settings.baud); 713 714 /* fixme: should set validated settings */ 715 tty_encode_baud_rate(tty, port_settings.baud, port_settings.baud); 716 /* handle any settings that aren't specified in the tty structure */ 717 port_settings.lloop = 0; 718 719 /* now send the message to the device */ 720 firm_send_command(port, WHITEHEAT_SETUP_PORT, 721 (__u8 *)&port_settings, sizeof(port_settings)); 722 } 723 724 725 static int firm_set_rts(struct usb_serial_port *port, __u8 onoff) 726 { 727 struct whiteheat_set_rdb rts_command; 728 729 rts_command.port = port->port_number + 1; 730 rts_command.state = onoff; 731 return firm_send_command(port, WHITEHEAT_SET_RTS, 732 (__u8 *)&rts_command, sizeof(rts_command)); 733 } 734 735 736 static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff) 737 { 738 struct whiteheat_set_rdb dtr_command; 739 740 dtr_command.port = port->port_number + 1; 741 dtr_command.state = onoff; 742 return firm_send_command(port, WHITEHEAT_SET_DTR, 743 (__u8 *)&dtr_command, sizeof(dtr_command)); 744 } 745 746 747 static int firm_set_break(struct usb_serial_port *port, __u8 onoff) 748 { 749 struct whiteheat_set_rdb break_command; 750 751 break_command.port = port->port_number + 1; 752 break_command.state = onoff; 753 return firm_send_command(port, WHITEHEAT_SET_BREAK, 754 (__u8 *)&break_command, sizeof(break_command)); 755 } 756 757 758 static int firm_purge(struct usb_serial_port *port, __u8 rxtx) 759 { 760 struct whiteheat_purge purge_command; 761 762 purge_command.port = port->port_number + 1; 763 purge_command.what = rxtx; 764 return firm_send_command(port, WHITEHEAT_PURGE, 765 (__u8 *)&purge_command, sizeof(purge_command)); 766 } 767 768 769 static int firm_get_dtr_rts(struct usb_serial_port *port) 770 { 771 struct whiteheat_simple get_dr_command; 772 773 get_dr_command.port = port->port_number + 1; 774 return firm_send_command(port, WHITEHEAT_GET_DTR_RTS, 775 (__u8 *)&get_dr_command, sizeof(get_dr_command)); 776 } 777 778 779 static int firm_report_tx_done(struct usb_serial_port *port) 780 { 781 struct whiteheat_simple close_command; 782 783 close_command.port = port->port_number + 1; 784 return firm_send_command(port, WHITEHEAT_REPORT_TX_DONE, 785 (__u8 *)&close_command, sizeof(close_command)); 786 } 787 788 789 /***************************************************************************** 790 * Connect Tech's White Heat utility functions 791 *****************************************************************************/ 792 static int start_command_port(struct usb_serial *serial) 793 { 794 struct usb_serial_port *command_port; 795 struct whiteheat_command_private *command_info; 796 int retval = 0; 797 798 command_port = serial->port[COMMAND_PORT]; 799 command_info = usb_get_serial_port_data(command_port); 800 mutex_lock(&command_info->mutex); 801 if (!command_info->port_running) { 802 /* Work around HCD bugs */ 803 usb_clear_halt(serial->dev, command_port->read_urb->pipe); 804 805 retval = usb_submit_urb(command_port->read_urb, GFP_KERNEL); 806 if (retval) { 807 dev_err(&serial->dev->dev, 808 "%s - failed submitting read urb, error %d\n", 809 __func__, retval); 810 goto exit; 811 } 812 } 813 command_info->port_running++; 814 815 exit: 816 mutex_unlock(&command_info->mutex); 817 return retval; 818 } 819 820 821 static void stop_command_port(struct usb_serial *serial) 822 { 823 struct usb_serial_port *command_port; 824 struct whiteheat_command_private *command_info; 825 826 command_port = serial->port[COMMAND_PORT]; 827 command_info = usb_get_serial_port_data(command_port); 828 mutex_lock(&command_info->mutex); 829 command_info->port_running--; 830 if (!command_info->port_running) 831 usb_kill_urb(command_port->read_urb); 832 mutex_unlock(&command_info->mutex); 833 } 834 835 module_usb_serial_driver(serial_drivers, id_table_combined); 836 837 MODULE_AUTHOR(DRIVER_AUTHOR); 838 MODULE_DESCRIPTION(DRIVER_DESC); 839 MODULE_LICENSE("GPL"); 840 841 MODULE_FIRMWARE("whiteheat.fw"); 842 MODULE_FIRMWARE("whiteheat_loader.fw"); 843