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