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