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