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