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