2 * USB ConnectTech WhiteHEAT driver
7 * Copyright (C) 1999 - 2001
8 * Greg Kroah-Hartman (greg@kroah.com)
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.
15 * See Documentation/usb/usb-serial.txt for more information on using this driver
17 * (10/09/2002) Stuart MacDonald (stuartm@connecttech.com)
18 * Upgrade to full working driver
21 * switched from using spinlock to a semaphore, which fixes lots of problems.
24 * Identify version on module load.
27 * Fixed MOD_INC and MOD_DEC logic, the ability to open a port more
28 * than once, and the got the proper usb_device_id table entries so
29 * the driver works again.
31 * (11/01/2000) Adam J. Richter
32 * usb_device_id table support
35 * Fixed bug with urb->dev not being set properly, now that the usb
39 * firmware is improved to guard against crap sent to device
40 * firmware now replies CMD_FAILURE on bad things
41 * read_callback fix you provided for private info struct
42 * command_finished now indicates success or fail
43 * setup_port struct now packed to avoid gcc padding
44 * firmware uses 1 based port numbering, driver now handles that
47 * Removed DEBUG #ifdefs with call to usb_serial_debug_data
50 * Added module_init and module_exit functions to handle the fact that this
51 * driver is a loadable module now.
52 * Fixed bug with port->minor that was found by Al Borchers
55 * Added support for port settings. Baud rate can now be changed. Line signals
56 * are not transferred to and from the tty layer yet, but things seem to be
60 * First cut at open and close commands. Data can flow through the ports at
64 * Split driver up into device specific pieces.
68 #include <linux/config.h>
69 #include <linux/kernel.h>
70 #include <linux/errno.h>
71 #include <linux/init.h>
72 #include <linux/slab.h>
73 #include <linux/tty.h>
74 #include <linux/tty_driver.h>
75 #include <linux/tty_flip.h>
76 #include <linux/module.h>
77 #include <linux/spinlock.h>
78 #include <asm/uaccess.h>
79 #include <asm/termbits.h>
80 #include <linux/usb.h>
81 #include <linux/serial_reg.h>
82 #include <linux/serial.h>
83 #include "usb-serial.h"
84 #include "whiteheat_fw.h" /* firmware for the ConnectTech WhiteHEAT device */
85 #include "whiteheat.h" /* WhiteHEAT specific commands */
96 #define DRIVER_VERSION "v2.0"
97 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Stuart MacDonald <stuartm@connecttech.com>"
98 #define DRIVER_DESC "USB ConnectTech WhiteHEAT driver"
100 #define CONNECT_TECH_VENDOR_ID 0x0710
101 #define CONNECT_TECH_FAKE_WHITE_HEAT_ID 0x0001
102 #define CONNECT_TECH_WHITE_HEAT_ID 0x8001
105 ID tables for whiteheat are unusual, because we want to different
106 things for different versions of the device. Eventually, this
107 will be doable from a single table. But, for now, we define two
108 separate ID tables, and then a third table that combines them
109 just for the purpose of exporting the autoloading information.
111 static struct usb_device_id id_table_std [] = {
112 { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) },
113 { } /* Terminating entry */
116 static struct usb_device_id id_table_prerenumeration [] = {
117 { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) },
118 { } /* Terminating entry */
121 static struct usb_device_id id_table_combined [] = {
122 { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) },
123 { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) },
124 { } /* Terminating entry */
127 MODULE_DEVICE_TABLE (usb, id_table_combined);
129 static struct usb_driver whiteheat_driver = {
130 .owner = THIS_MODULE,
132 .probe = usb_serial_probe,
133 .disconnect = usb_serial_disconnect,
134 .id_table = id_table_combined,
137 /* function prototypes for the Connect Tech WhiteHEAT prerenumeration device */
138 static int whiteheat_firmware_download (struct usb_serial *serial, const struct usb_device_id *id);
139 static int whiteheat_firmware_attach (struct usb_serial *serial);
141 /* function prototypes for the Connect Tech WhiteHEAT serial converter */
142 static int whiteheat_attach (struct usb_serial *serial);
143 static void whiteheat_shutdown (struct usb_serial *serial);
144 static int whiteheat_open (struct usb_serial_port *port, struct file *filp);
145 static void whiteheat_close (struct usb_serial_port *port, struct file *filp);
146 static int whiteheat_write (struct usb_serial_port *port, const unsigned char *buf, int count);
147 static int whiteheat_write_room (struct usb_serial_port *port);
148 static int whiteheat_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
149 static void whiteheat_set_termios (struct usb_serial_port *port, struct termios * old);
150 static int whiteheat_tiocmget (struct usb_serial_port *port, struct file *file);
151 static int whiteheat_tiocmset (struct usb_serial_port *port, struct file *file, unsigned int set, unsigned int clear);
152 static void whiteheat_break_ctl (struct usb_serial_port *port, int break_state);
153 static int whiteheat_chars_in_buffer (struct usb_serial_port *port);
154 static void whiteheat_throttle (struct usb_serial_port *port);
155 static void whiteheat_unthrottle (struct usb_serial_port *port);
156 static void whiteheat_read_callback (struct urb *urb, struct pt_regs *regs);
157 static void whiteheat_write_callback (struct urb *urb, struct pt_regs *regs);
159 static struct usb_serial_device_type whiteheat_fake_device = {
160 .owner = THIS_MODULE,
161 .name = "Connect Tech - WhiteHEAT - (prerenumeration)",
162 .short_name = "whiteheatnofirm",
163 .id_table = id_table_prerenumeration,
164 .num_interrupt_in = NUM_DONT_CARE,
165 .num_bulk_in = NUM_DONT_CARE,
166 .num_bulk_out = NUM_DONT_CARE,
168 .probe = whiteheat_firmware_download,
169 .attach = whiteheat_firmware_attach,
172 static struct usb_serial_device_type whiteheat_device = {
173 .owner = THIS_MODULE,
174 .name = "Connect Tech - WhiteHEAT",
175 .short_name = "whiteheat",
176 .id_table = id_table_std,
177 .num_interrupt_in = NUM_DONT_CARE,
178 .num_bulk_in = NUM_DONT_CARE,
179 .num_bulk_out = NUM_DONT_CARE,
181 .attach = whiteheat_attach,
182 .shutdown = whiteheat_shutdown,
183 .open = whiteheat_open,
184 .close = whiteheat_close,
185 .write = whiteheat_write,
186 .write_room = whiteheat_write_room,
187 .ioctl = whiteheat_ioctl,
188 .set_termios = whiteheat_set_termios,
189 .break_ctl = whiteheat_break_ctl,
190 .tiocmget = whiteheat_tiocmget,
191 .tiocmset = whiteheat_tiocmset,
192 .chars_in_buffer = whiteheat_chars_in_buffer,
193 .throttle = whiteheat_throttle,
194 .unthrottle = whiteheat_unthrottle,
195 .read_bulk_callback = whiteheat_read_callback,
196 .write_bulk_callback = whiteheat_write_callback,
200 struct whiteheat_command_private {
203 __u8 command_finished;
204 wait_queue_head_t wait_command; /* for handling sleeping while waiting for a command to finish */
205 __u8 result_buffer[64];
209 #define THROTTLED 0x01
210 #define ACTUALLY_THROTTLED 0x02
212 static int urb_pool_size = 8;
214 struct whiteheat_urb_wrap {
215 struct list_head list;
219 struct whiteheat_private {
223 struct list_head rx_urbs_free;
224 struct list_head rx_urbs_submitted;
225 struct list_head rx_urb_q;
226 struct work_struct rx_work;
227 struct list_head tx_urbs_free;
228 struct list_head tx_urbs_submitted;
232 /* local function prototypes */
233 static int start_command_port(struct usb_serial *serial);
234 static void stop_command_port(struct usb_serial *serial);
235 static void command_port_write_callback(struct urb *urb, struct pt_regs *regs);
236 static void command_port_read_callback(struct urb *urb, struct pt_regs *regs);
238 static int start_port_read(struct usb_serial_port *port);
239 static struct whiteheat_urb_wrap *urb_to_wrap(struct urb *urb, struct list_head *head);
240 static struct list_head *list_first(struct list_head *head);
241 static void rx_data_softint(void *private);
243 static int firm_send_command(struct usb_serial_port *port, __u8 command, __u8 *data, __u8 datasize);
244 static int firm_open(struct usb_serial_port *port);
245 static int firm_close(struct usb_serial_port *port);
246 static int firm_setup_port(struct usb_serial_port *port);
247 static int firm_set_rts(struct usb_serial_port *port, __u8 onoff);
248 static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff);
249 static int firm_set_break(struct usb_serial_port *port, __u8 onoff);
250 static int firm_purge(struct usb_serial_port *port, __u8 rxtx);
251 static int firm_get_dtr_rts(struct usb_serial_port *port);
252 static int firm_report_tx_done(struct usb_serial_port *port);
255 #define COMMAND_PORT 4
256 #define COMMAND_TIMEOUT (2*HZ) /* 2 second timeout for a command */
257 #define CLOSING_DELAY (30 * HZ)
260 /*****************************************************************************
261 * Connect Tech's White Heat prerenumeration driver functions
262 *****************************************************************************/
264 /* steps to download the firmware to the WhiteHEAT device:
265 - hold the reset (by writing to the reset bit of the CPUCS register)
266 - download the VEND_AX.HEX file to the chip using VENDOR_REQUEST-ANCHOR_LOAD
267 - release the reset (by writing to the CPUCS register)
268 - download the WH.HEX file for all addresses greater than 0x1b3f using
269 VENDOR_REQUEST-ANCHOR_EXTERNAL_RAM_LOAD
271 - download the WH.HEX file for all addresses less than 0x1b40 using
272 VENDOR_REQUEST_ANCHOR_LOAD
274 - device renumerated itself and comes up as new device id with all
275 firmware download completed.
277 static int whiteheat_firmware_download (struct usb_serial *serial, const struct usb_device_id *id)
280 const struct whiteheat_hex_record *record;
282 dbg("%s", __FUNCTION__);
284 response = ezusb_set_reset (serial, 1);
286 record = &whiteheat_loader[0];
287 while (record->address != 0xffff) {
288 response = ezusb_writememory (serial, record->address,
289 (unsigned char *)record->data, record->data_size, 0xa0);
291 err("%s - ezusb_writememory failed for loader (%d %04X %p %d)",
292 __FUNCTION__, response, record->address, record->data, record->data_size);
298 response = ezusb_set_reset (serial, 0);
300 record = &whiteheat_firmware[0];
301 while (record->address < 0x1b40) {
304 while (record->address != 0xffff) {
305 response = ezusb_writememory (serial, record->address,
306 (unsigned char *)record->data, record->data_size, 0xa3);
308 err("%s - ezusb_writememory failed for first firmware step (%d %04X %p %d)",
309 __FUNCTION__, response, record->address, record->data, record->data_size);
315 response = ezusb_set_reset (serial, 1);
317 record = &whiteheat_firmware[0];
318 while (record->address < 0x1b40) {
319 response = ezusb_writememory (serial, record->address,
320 (unsigned char *)record->data, record->data_size, 0xa0);
322 err("%s - ezusb_writememory failed for second firmware step (%d %04X %p %d)",
323 __FUNCTION__, response, record->address, record->data, record->data_size);
329 response = ezusb_set_reset (serial, 0);
335 static int whiteheat_firmware_attach (struct usb_serial *serial)
337 /* We want this device to fail to have a driver assigned to it */
342 /*****************************************************************************
343 * Connect Tech's White Heat serial driver functions
344 *****************************************************************************/
345 static int whiteheat_attach (struct usb_serial *serial)
347 struct usb_serial_port *command_port;
348 struct whiteheat_command_private *command_info;
349 struct usb_serial_port *port;
350 struct whiteheat_private *info;
351 struct whiteheat_hw_info *hw_info;
361 struct whiteheat_urb_wrap *wrap;
362 struct list_head *tmp;
364 command_port = serial->port[COMMAND_PORT];
366 pipe = usb_sndbulkpipe (serial->dev, command_port->bulk_out_endpointAddress);
367 command = kmalloc(2, GFP_KERNEL);
369 goto no_command_buffer;
370 command[0] = WHITEHEAT_GET_HW_INFO;
373 result = kmalloc(sizeof(*hw_info) + 1, GFP_KERNEL);
375 goto no_result_buffer;
377 * When the module is reloaded the firmware is still there and
378 * the endpoints are still in the usb core unchanged. This is the
379 * unlinking bug in disguise. Same for the call below.
381 usb_clear_halt(serial->dev, pipe);
382 ret = usb_bulk_msg (serial->dev, pipe, command, 2, &alen, COMMAND_TIMEOUT);
384 err("%s: Couldn't send command [%d]", serial->type->name, ret);
386 } else if (alen != sizeof(command)) {
387 err("%s: Send command incomplete [%d]", serial->type->name, alen);
391 pipe = usb_rcvbulkpipe (serial->dev, command_port->bulk_in_endpointAddress);
392 /* See the comment on the usb_clear_halt() above */
393 usb_clear_halt(serial->dev, pipe);
394 ret = usb_bulk_msg (serial->dev, pipe, result, sizeof(*hw_info) + 1, &alen, COMMAND_TIMEOUT);
396 err("%s: Couldn't get results [%d]", serial->type->name, ret);
398 } else if (alen != sizeof(result)) {
399 err("%s: Get results incomplete [%d]", serial->type->name, alen);
401 } else if (result[0] != command[0]) {
402 err("%s: Command failed [%d]", serial->type->name, result[0]);
406 hw_info = (struct whiteheat_hw_info *)&result[1];
408 info("%s: Driver %s: Firmware v%d.%02d", serial->type->name,
409 DRIVER_VERSION, hw_info->sw_major_rev, hw_info->sw_minor_rev);
411 for (i = 0; i < serial->num_ports; i++) {
412 port = serial->port[i];
414 info = (struct whiteheat_private *)kmalloc(sizeof(struct whiteheat_private), GFP_KERNEL);
416 err("%s: Out of memory for port structures\n", serial->type->name);
420 spin_lock_init(&info->lock);
423 INIT_WORK(&info->rx_work, rx_data_softint, port);
425 INIT_LIST_HEAD(&info->rx_urbs_free);
426 INIT_LIST_HEAD(&info->rx_urbs_submitted);
427 INIT_LIST_HEAD(&info->rx_urb_q);
428 INIT_LIST_HEAD(&info->tx_urbs_free);
429 INIT_LIST_HEAD(&info->tx_urbs_submitted);
431 for (j = 0; j < urb_pool_size; j++) {
432 urb = usb_alloc_urb(0, GFP_KERNEL);
434 err("No free urbs available");
437 buf_size = port->read_urb->transfer_buffer_length;
438 urb->transfer_buffer = kmalloc(buf_size, GFP_KERNEL);
439 if (!urb->transfer_buffer) {
440 err("Couldn't allocate urb buffer");
443 wrap = kmalloc(sizeof(*wrap), GFP_KERNEL);
445 err("Couldn't allocate urb wrapper");
448 usb_fill_bulk_urb(urb, serial->dev,
449 usb_rcvbulkpipe(serial->dev,
450 port->bulk_in_endpointAddress),
451 urb->transfer_buffer, buf_size,
452 whiteheat_read_callback, port);
454 list_add(&wrap->list, &info->rx_urbs_free);
456 urb = usb_alloc_urb(0, GFP_KERNEL);
458 err("No free urbs available");
461 buf_size = port->write_urb->transfer_buffer_length;
462 urb->transfer_buffer = kmalloc(buf_size, GFP_KERNEL);
463 if (!urb->transfer_buffer) {
464 err("Couldn't allocate urb buffer");
467 wrap = kmalloc(sizeof(*wrap), GFP_KERNEL);
469 err("Couldn't allocate urb wrapper");
472 usb_fill_bulk_urb(urb, serial->dev,
473 usb_sndbulkpipe(serial->dev,
474 port->bulk_out_endpointAddress),
475 urb->transfer_buffer, buf_size,
476 whiteheat_write_callback, port);
478 list_add(&wrap->list, &info->tx_urbs_free);
481 usb_set_serial_port_data(port, info);
484 command_info = (struct whiteheat_command_private *)kmalloc(sizeof(struct whiteheat_command_private), GFP_KERNEL);
485 if (command_info == NULL) {
486 err("%s: Out of memory for port structures\n", serial->type->name);
487 goto no_command_private;
490 spin_lock_init(&command_info->lock);
491 command_info->port_running = 0;
492 init_waitqueue_head(&command_info->wait_command);
493 usb_set_serial_port_data(command_port, command_info);
494 command_port->write_urb->complete = command_port_write_callback;
495 command_port->read_urb->complete = command_port_read_callback;
502 /* Firmware likely not running */
503 err("%s: Unable to retrieve firmware version, try replugging\n", serial->type->name);
504 err("%s: If the firmware is not running (status led not blinking)\n", serial->type->name);
505 err("%s: please contact support@connecttech.com\n", serial->type->name);
509 for (i = serial->num_ports - 1; i >= 0; i--) {
510 port = serial->port[i];
511 info = usb_get_serial_port_data(port);
512 for (j = urb_pool_size - 1; j >= 0; j--) {
513 tmp = list_first(&info->tx_urbs_free);
515 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
519 kfree(urb->transfer_buffer);
523 tmp = list_first(&info->rx_urbs_free);
525 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
529 kfree(urb->transfer_buffer);
547 static void whiteheat_shutdown (struct usb_serial *serial)
549 struct usb_serial_port *command_port;
550 struct usb_serial_port *port;
551 struct whiteheat_private *info;
552 struct whiteheat_urb_wrap *wrap;
554 struct list_head *tmp;
555 struct list_head *tmp2;
558 dbg("%s", __FUNCTION__);
560 /* free up our private data for our command port */
561 command_port = serial->port[COMMAND_PORT];
562 kfree (usb_get_serial_port_data(command_port));
564 for (i = 0; i < serial->num_ports; i++) {
565 port = serial->port[i];
566 info = usb_get_serial_port_data(port);
567 list_for_each_safe(tmp, tmp2, &info->rx_urbs_free) {
569 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
572 kfree(urb->transfer_buffer);
575 list_for_each_safe(tmp, tmp2, &info->tx_urbs_free) {
577 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
580 kfree(urb->transfer_buffer);
590 static int whiteheat_open (struct usb_serial_port *port, struct file *filp)
593 struct termios old_term;
595 dbg("%s - port %d", __FUNCTION__, port->number);
597 retval = start_command_port(port->serial);
602 port->tty->low_latency = 1;
604 /* send an open port command */
605 retval = firm_open(port);
607 stop_command_port(port->serial);
611 retval = firm_purge(port, WHITEHEAT_PURGE_RX | WHITEHEAT_PURGE_TX);
614 stop_command_port(port->serial);
618 old_term.c_cflag = ~port->tty->termios->c_cflag;
619 old_term.c_iflag = ~port->tty->termios->c_iflag;
620 whiteheat_set_termios(port, &old_term);
622 /* Work around HCD bugs */
623 usb_clear_halt(port->serial->dev, port->read_urb->pipe);
624 usb_clear_halt(port->serial->dev, port->write_urb->pipe);
626 /* Start reading from the device */
627 retval = start_port_read(port);
629 err("%s - failed submitting read urb, error %d", __FUNCTION__, retval);
631 stop_command_port(port->serial);
636 dbg("%s - exit, retval = %d", __FUNCTION__, retval);
641 static void whiteheat_close(struct usb_serial_port *port, struct file * filp)
643 struct whiteheat_private *info = usb_get_serial_port_data(port);
644 struct whiteheat_urb_wrap *wrap;
646 struct list_head *tmp;
647 struct list_head *tmp2;
650 dbg("%s - port %d", __FUNCTION__, port->number);
652 /* filp is NULL when called from usb_serial_disconnect */
653 if (filp && (tty_hung_up_p(filp))) {
657 port->tty->closing = 1;
660 * Not currently in use; tty_wait_until_sent() calls
661 * serial_chars_in_buffer() which deadlocks on the second semaphore
662 * acquisition. This should be fixed at some point. Greg's been
664 if ((filp->f_flags & (O_NDELAY | O_NONBLOCK)) == 0) {
665 tty_wait_until_sent(port->tty, CLOSING_DELAY);
669 if (port->tty->driver->flush_buffer)
670 port->tty->driver->flush_buffer(port->tty);
671 tty_ldisc_flush(port->tty);
673 firm_report_tx_done(port);
677 /* shutdown our bulk reads and writes */
678 spin_lock_irqsave(&info->lock, flags);
679 list_for_each_safe(tmp, tmp2, &info->rx_urbs_submitted) {
680 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
684 list_add(tmp, &info->rx_urbs_free);
686 list_for_each_safe(tmp, tmp2, &info->rx_urb_q) {
688 list_add(tmp, &info->rx_urbs_free);
690 list_for_each_safe(tmp, tmp2, &info->tx_urbs_submitted) {
691 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
695 list_add(tmp, &info->tx_urbs_free);
697 spin_unlock_irqrestore(&info->lock, flags);
699 stop_command_port(port->serial);
701 port->tty->closing = 0;
705 static int whiteheat_write(struct usb_serial_port *port, const unsigned char *buf, int count)
707 struct usb_serial *serial = port->serial;
708 struct whiteheat_private *info = usb_get_serial_port_data(port);
709 struct whiteheat_urb_wrap *wrap;
715 struct list_head *tmp;
717 dbg("%s - port %d", __FUNCTION__, port->number);
720 dbg("%s - write request of 0 bytes", __FUNCTION__);
725 spin_lock_irqsave(&info->lock, flags);
726 if (list_empty(&info->tx_urbs_free)) {
727 spin_unlock_irqrestore(&info->lock, flags);
730 tmp = list_first(&info->tx_urbs_free);
732 spin_unlock_irqrestore(&info->lock, flags);
734 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
736 bytes = (count > port->bulk_out_size) ? port->bulk_out_size : count;
737 memcpy (urb->transfer_buffer, buf + sent, bytes);
739 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, bytes, urb->transfer_buffer);
741 urb->dev = serial->dev;
742 urb->transfer_buffer_length = bytes;
743 result = usb_submit_urb(urb, GFP_ATOMIC);
745 err("%s - failed submitting write urb, error %d", __FUNCTION__, result);
747 spin_lock_irqsave(&info->lock, flags);
748 list_add(tmp, &info->tx_urbs_free);
749 spin_unlock_irqrestore(&info->lock, flags);
754 spin_lock_irqsave(&info->lock, flags);
755 list_add(tmp, &info->tx_urbs_submitted);
756 spin_unlock_irqrestore(&info->lock, flags);
764 static int whiteheat_write_room(struct usb_serial_port *port)
766 struct whiteheat_private *info = usb_get_serial_port_data(port);
767 struct list_head *tmp;
771 dbg("%s - port %d", __FUNCTION__, port->number);
773 spin_lock_irqsave(&info->lock, flags);
774 list_for_each(tmp, &info->tx_urbs_free)
776 spin_unlock_irqrestore(&info->lock, flags);
777 room *= port->bulk_out_size;
779 dbg("%s - returns %d", __FUNCTION__, room);
784 static int whiteheat_tiocmget (struct usb_serial_port *port, struct file *file)
786 struct whiteheat_private *info = usb_get_serial_port_data(port);
787 unsigned int modem_signals = 0;
789 dbg("%s - port %d", __FUNCTION__, port->number);
791 firm_get_dtr_rts(port);
792 if (info->mcr & UART_MCR_DTR)
793 modem_signals |= TIOCM_DTR;
794 if (info->mcr & UART_MCR_RTS)
795 modem_signals |= TIOCM_RTS;
797 return modem_signals;
801 static int whiteheat_tiocmset (struct usb_serial_port *port, struct file *file,
802 unsigned int set, unsigned int clear)
804 struct whiteheat_private *info = usb_get_serial_port_data(port);
806 dbg("%s - port %d", __FUNCTION__, port->number);
809 info->mcr |= UART_MCR_RTS;
811 info->mcr |= UART_MCR_DTR;
813 if (clear & TIOCM_RTS)
814 info->mcr &= ~UART_MCR_RTS;
815 if (clear & TIOCM_DTR)
816 info->mcr &= ~UART_MCR_DTR;
818 firm_set_dtr(port, info->mcr & UART_MCR_DTR);
819 firm_set_rts(port, info->mcr & UART_MCR_RTS);
824 static int whiteheat_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
826 struct serial_struct serstruct;
827 void __user *user_arg = (void __user *)arg;
829 dbg("%s - port %d, cmd 0x%.4x", __FUNCTION__, port->number, cmd);
833 memset(&serstruct, 0, sizeof(serstruct));
834 serstruct.type = PORT_16654;
835 serstruct.line = port->serial->minor;
836 serstruct.port = port->number;
837 serstruct.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
838 serstruct.xmit_fifo_size = port->bulk_out_size;
839 serstruct.custom_divisor = 0;
840 serstruct.baud_base = 460800;
841 serstruct.close_delay = CLOSING_DELAY;
842 serstruct.closing_wait = CLOSING_DELAY;
844 if (copy_to_user(user_arg, &serstruct, sizeof(serstruct)))
850 if (copy_from_user(&serstruct, user_arg, sizeof(serstruct)))
854 * For now this is ignored. dip sets the ASYNC_[V]HI flags
855 * but this isn't used by us at all. Maybe someone somewhere
856 * will need the custom_divisor setting.
869 static void whiteheat_set_termios (struct usb_serial_port *port, struct termios *old_termios)
871 dbg("%s -port %d", __FUNCTION__, port->number);
873 if ((!port->tty) || (!port->tty->termios)) {
874 dbg("%s - no tty structures", __FUNCTION__);
878 /* check that they really want us to change something */
880 if ((port->tty->termios->c_cflag == old_termios->c_cflag) &&
881 (port->tty->termios->c_iflag == old_termios->c_iflag)) {
882 dbg("%s - nothing to change...", __FUNCTION__);
887 firm_setup_port(port);
894 static void whiteheat_break_ctl(struct usb_serial_port *port, int break_state) {
895 firm_set_break(port, break_state);
899 static int whiteheat_chars_in_buffer(struct usb_serial_port *port)
901 struct whiteheat_private *info = usb_get_serial_port_data(port);
902 struct list_head *tmp;
903 struct whiteheat_urb_wrap *wrap;
907 dbg("%s - port %d", __FUNCTION__, port->number);
909 spin_lock_irqsave(&info->lock, flags);
910 list_for_each(tmp, &info->tx_urbs_submitted) {
911 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
912 chars += wrap->urb->transfer_buffer_length;
914 spin_unlock_irqrestore(&info->lock, flags);
916 dbg ("%s - returns %d", __FUNCTION__, chars);
921 static void whiteheat_throttle (struct usb_serial_port *port)
923 struct whiteheat_private *info = usb_get_serial_port_data(port);
926 dbg("%s - port %d", __FUNCTION__, port->number);
928 spin_lock_irqsave(&info->lock, flags);
929 info->flags |= THROTTLED;
930 spin_unlock_irqrestore(&info->lock, flags);
936 static void whiteheat_unthrottle (struct usb_serial_port *port)
938 struct whiteheat_private *info = usb_get_serial_port_data(port);
939 int actually_throttled;
942 dbg("%s - port %d", __FUNCTION__, port->number);
944 spin_lock_irqsave(&info->lock, flags);
945 actually_throttled = info->flags & ACTUALLY_THROTTLED;
946 info->flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
947 spin_unlock_irqrestore(&info->lock, flags);
949 if (actually_throttled)
950 rx_data_softint(port);
956 /*****************************************************************************
957 * Connect Tech's White Heat callback routines
958 *****************************************************************************/
959 static void command_port_write_callback (struct urb *urb, struct pt_regs *regs)
961 dbg("%s", __FUNCTION__);
964 dbg ("nonzero urb status: %d", urb->status);
970 static void command_port_read_callback (struct urb *urb, struct pt_regs *regs)
972 struct usb_serial_port *command_port = (struct usb_serial_port *)urb->context;
973 struct whiteheat_command_private *command_info;
974 unsigned char *data = urb->transfer_buffer;
978 dbg("%s", __FUNCTION__);
981 dbg("%s - nonzero urb status: %d", __FUNCTION__, urb->status);
985 usb_serial_debug_data(debug, &command_port->dev, __FUNCTION__, urb->actual_length, data);
987 command_info = usb_get_serial_port_data(command_port);
989 dbg ("%s - command_info is NULL, exiting.", __FUNCTION__);
992 spin_lock_irqsave(&command_info->lock, flags);
994 if (data[0] == WHITEHEAT_CMD_COMPLETE) {
995 command_info->command_finished = WHITEHEAT_CMD_COMPLETE;
996 wake_up_interruptible(&command_info->wait_command);
997 } else if (data[0] == WHITEHEAT_CMD_FAILURE) {
998 command_info->command_finished = WHITEHEAT_CMD_FAILURE;
999 wake_up_interruptible(&command_info->wait_command);
1000 } else if (data[0] == WHITEHEAT_EVENT) {
1001 /* These are unsolicited reports from the firmware, hence no waiting command to wakeup */
1002 dbg("%s - event received", __FUNCTION__);
1003 } else if (data[0] == WHITEHEAT_GET_DTR_RTS) {
1004 memcpy(command_info->result_buffer, &data[1], urb->actual_length - 1);
1005 command_info->command_finished = WHITEHEAT_CMD_COMPLETE;
1006 wake_up_interruptible(&command_info->wait_command);
1008 dbg("%s - bad reply from firmware", __FUNCTION__);
1011 /* Continue trying to always read */
1012 command_port->read_urb->dev = command_port->serial->dev;
1013 result = usb_submit_urb(command_port->read_urb, GFP_ATOMIC);
1014 spin_unlock_irqrestore(&command_info->lock, flags);
1016 dbg("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1020 static void whiteheat_read_callback(struct urb *urb, struct pt_regs *regs)
1022 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1023 struct whiteheat_urb_wrap *wrap;
1024 unsigned char *data = urb->transfer_buffer;
1025 struct whiteheat_private *info = usb_get_serial_port_data(port);
1027 dbg("%s - port %d", __FUNCTION__, port->number);
1029 spin_lock(&info->lock);
1030 wrap = urb_to_wrap(urb, &info->rx_urbs_submitted);
1032 spin_unlock(&info->lock);
1033 err("%s - Not my urb!", __FUNCTION__);
1036 list_del(&wrap->list);
1037 spin_unlock(&info->lock);
1040 dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status);
1041 spin_lock(&info->lock);
1042 list_add(&wrap->list, &info->rx_urbs_free);
1043 spin_unlock(&info->lock);
1047 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
1049 spin_lock(&info->lock);
1050 list_add_tail(&wrap->list, &info->rx_urb_q);
1051 if (info->flags & THROTTLED) {
1052 info->flags |= ACTUALLY_THROTTLED;
1053 spin_unlock(&info->lock);
1056 spin_unlock(&info->lock);
1058 schedule_work(&info->rx_work);
1062 static void whiteheat_write_callback(struct urb *urb, struct pt_regs *regs)
1064 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1065 struct whiteheat_private *info = usb_get_serial_port_data(port);
1066 struct whiteheat_urb_wrap *wrap;
1068 dbg("%s - port %d", __FUNCTION__, port->number);
1070 spin_lock(&info->lock);
1071 wrap = urb_to_wrap(urb, &info->tx_urbs_submitted);
1073 spin_unlock(&info->lock);
1074 err("%s - Not my urb!", __FUNCTION__);
1077 list_del(&wrap->list);
1078 list_add(&wrap->list, &info->tx_urbs_free);
1079 spin_unlock(&info->lock);
1082 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
1086 usb_serial_port_softint((void *)port);
1088 schedule_work(&port->work);
1092 /*****************************************************************************
1093 * Connect Tech's White Heat firmware interface
1094 *****************************************************************************/
1095 static int firm_send_command (struct usb_serial_port *port, __u8 command, __u8 *data, __u8 datasize)
1097 struct usb_serial_port *command_port;
1098 struct whiteheat_command_private *command_info;
1099 struct whiteheat_private *info;
1100 __u8 *transfer_buffer;
1102 unsigned long flags;
1104 dbg("%s - command %d", __FUNCTION__, command);
1106 command_port = port->serial->port[COMMAND_PORT];
1107 command_info = usb_get_serial_port_data(command_port);
1108 spin_lock_irqsave(&command_info->lock, flags);
1109 command_info->command_finished = FALSE;
1111 transfer_buffer = (__u8 *)command_port->write_urb->transfer_buffer;
1112 transfer_buffer[0] = command;
1113 memcpy (&transfer_buffer[1], data, datasize);
1114 command_port->write_urb->transfer_buffer_length = datasize + 1;
1115 command_port->write_urb->dev = port->serial->dev;
1116 retval = usb_submit_urb (command_port->write_urb, GFP_KERNEL);
1118 dbg("%s - submit urb failed", __FUNCTION__);
1121 spin_unlock_irqrestore(&command_info->lock, flags);
1123 /* wait for the command to complete */
1124 wait_event_interruptible_timeout(command_info->wait_command,
1125 (command_info->command_finished != FALSE), COMMAND_TIMEOUT);
1127 spin_lock_irqsave(&command_info->lock, flags);
1129 if (command_info->command_finished == FALSE) {
1130 dbg("%s - command timed out.", __FUNCTION__);
1131 retval = -ETIMEDOUT;
1135 if (command_info->command_finished == WHITEHEAT_CMD_FAILURE) {
1136 dbg("%s - command failed.", __FUNCTION__);
1141 if (command_info->command_finished == WHITEHEAT_CMD_COMPLETE) {
1142 dbg("%s - command completed.", __FUNCTION__);
1144 case WHITEHEAT_GET_DTR_RTS:
1145 info = usb_get_serial_port_data(port);
1146 memcpy(&info->mcr, command_info->result_buffer, sizeof(struct whiteheat_dr_info));
1152 spin_unlock_irqrestore(&command_info->lock, flags);
1157 static int firm_open(struct usb_serial_port *port) {
1158 struct whiteheat_simple open_command;
1160 open_command.port = port->number - port->serial->minor + 1;
1161 return firm_send_command(port, WHITEHEAT_OPEN, (__u8 *)&open_command, sizeof(open_command));
1165 static int firm_close(struct usb_serial_port *port) {
1166 struct whiteheat_simple close_command;
1168 close_command.port = port->number - port->serial->minor + 1;
1169 return firm_send_command(port, WHITEHEAT_CLOSE, (__u8 *)&close_command, sizeof(close_command));
1173 static int firm_setup_port(struct usb_serial_port *port) {
1174 struct whiteheat_port_settings port_settings;
1175 unsigned int cflag = port->tty->termios->c_cflag;
1177 port_settings.port = port->number + 1;
1179 /* get the byte size */
1180 switch (cflag & CSIZE) {
1181 case CS5: port_settings.bits = 5; break;
1182 case CS6: port_settings.bits = 6; break;
1183 case CS7: port_settings.bits = 7; break;
1185 case CS8: port_settings.bits = 8; break;
1187 dbg("%s - data bits = %d", __FUNCTION__, port_settings.bits);
1189 /* determine the parity */
1193 port_settings.parity = WHITEHEAT_PAR_MARK;
1195 port_settings.parity = WHITEHEAT_PAR_SPACE;
1198 port_settings.parity = WHITEHEAT_PAR_ODD;
1200 port_settings.parity = WHITEHEAT_PAR_EVEN;
1202 port_settings.parity = WHITEHEAT_PAR_NONE;
1203 dbg("%s - parity = %c", __FUNCTION__, port_settings.parity);
1205 /* figure out the stop bits requested */
1207 port_settings.stop = 2;
1209 port_settings.stop = 1;
1210 dbg("%s - stop bits = %d", __FUNCTION__, port_settings.stop);
1212 /* figure out the flow control settings */
1213 if (cflag & CRTSCTS)
1214 port_settings.hflow = (WHITEHEAT_HFLOW_CTS | WHITEHEAT_HFLOW_RTS);
1216 port_settings.hflow = WHITEHEAT_HFLOW_NONE;
1217 dbg("%s - hardware flow control = %s %s %s %s", __FUNCTION__,
1218 (port_settings.hflow & WHITEHEAT_HFLOW_CTS) ? "CTS" : "",
1219 (port_settings.hflow & WHITEHEAT_HFLOW_RTS) ? "RTS" : "",
1220 (port_settings.hflow & WHITEHEAT_HFLOW_DSR) ? "DSR" : "",
1221 (port_settings.hflow & WHITEHEAT_HFLOW_DTR) ? "DTR" : "");
1223 /* determine software flow control */
1224 if (I_IXOFF(port->tty))
1225 port_settings.sflow = WHITEHEAT_SFLOW_RXTX;
1227 port_settings.sflow = WHITEHEAT_SFLOW_NONE;
1228 dbg("%s - software flow control = %c", __FUNCTION__, port_settings.sflow);
1230 port_settings.xon = START_CHAR(port->tty);
1231 port_settings.xoff = STOP_CHAR(port->tty);
1232 dbg("%s - XON = %2x, XOFF = %2x", __FUNCTION__, port_settings.xon, port_settings.xoff);
1234 /* get the baud rate wanted */
1235 port_settings.baud = tty_get_baud_rate(port->tty);
1236 dbg("%s - baud rate = %d", __FUNCTION__, port_settings.baud);
1238 /* handle any settings that aren't specified in the tty structure */
1239 port_settings.lloop = 0;
1241 /* now send the message to the device */
1242 return firm_send_command(port, WHITEHEAT_SETUP_PORT, (__u8 *)&port_settings, sizeof(port_settings));
1246 static int firm_set_rts(struct usb_serial_port *port, __u8 onoff) {
1247 struct whiteheat_set_rdb rts_command;
1249 rts_command.port = port->number - port->serial->minor + 1;
1250 rts_command.state = onoff;
1251 return firm_send_command(port, WHITEHEAT_SET_RTS, (__u8 *)&rts_command, sizeof(rts_command));
1255 static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff) {
1256 struct whiteheat_set_rdb dtr_command;
1258 dtr_command.port = port->number - port->serial->minor + 1;
1259 dtr_command.state = onoff;
1260 return firm_send_command(port, WHITEHEAT_SET_RTS, (__u8 *)&dtr_command, sizeof(dtr_command));
1264 static int firm_set_break(struct usb_serial_port *port, __u8 onoff) {
1265 struct whiteheat_set_rdb break_command;
1267 break_command.port = port->number - port->serial->minor + 1;
1268 break_command.state = onoff;
1269 return firm_send_command(port, WHITEHEAT_SET_RTS, (__u8 *)&break_command, sizeof(break_command));
1273 static int firm_purge(struct usb_serial_port *port, __u8 rxtx) {
1274 struct whiteheat_purge purge_command;
1276 purge_command.port = port->number - port->serial->minor + 1;
1277 purge_command.what = rxtx;
1278 return firm_send_command(port, WHITEHEAT_PURGE, (__u8 *)&purge_command, sizeof(purge_command));
1282 static int firm_get_dtr_rts(struct usb_serial_port *port) {
1283 struct whiteheat_simple get_dr_command;
1285 get_dr_command.port = port->number - port->serial->minor + 1;
1286 return firm_send_command(port, WHITEHEAT_GET_DTR_RTS, (__u8 *)&get_dr_command, sizeof(get_dr_command));
1290 static int firm_report_tx_done(struct usb_serial_port *port) {
1291 struct whiteheat_simple close_command;
1293 close_command.port = port->number - port->serial->minor + 1;
1294 return firm_send_command(port, WHITEHEAT_REPORT_TX_DONE, (__u8 *)&close_command, sizeof(close_command));
1298 /*****************************************************************************
1299 * Connect Tech's White Heat utility functions
1300 *****************************************************************************/
1301 static int start_command_port(struct usb_serial *serial)
1303 struct usb_serial_port *command_port;
1304 struct whiteheat_command_private *command_info;
1305 unsigned long flags;
1308 command_port = serial->port[COMMAND_PORT];
1309 command_info = usb_get_serial_port_data(command_port);
1310 spin_lock_irqsave(&command_info->lock, flags);
1311 if (!command_info->port_running) {
1312 /* Work around HCD bugs */
1313 usb_clear_halt(serial->dev, command_port->read_urb->pipe);
1315 command_port->read_urb->dev = serial->dev;
1316 retval = usb_submit_urb(command_port->read_urb, GFP_KERNEL);
1318 err("%s - failed submitting read urb, error %d", __FUNCTION__, retval);
1322 command_info->port_running++;
1325 spin_unlock_irqrestore(&command_info->lock, flags);
1330 static void stop_command_port(struct usb_serial *serial)
1332 struct usb_serial_port *command_port;
1333 struct whiteheat_command_private *command_info;
1334 unsigned long flags;
1336 command_port = serial->port[COMMAND_PORT];
1337 command_info = usb_get_serial_port_data(command_port);
1338 spin_lock_irqsave(&command_info->lock, flags);
1339 command_info->port_running--;
1340 if (!command_info->port_running)
1341 usb_kill_urb(command_port->read_urb);
1342 spin_unlock_irqrestore(&command_info->lock, flags);
1346 static int start_port_read(struct usb_serial_port *port)
1348 struct whiteheat_private *info = usb_get_serial_port_data(port);
1349 struct whiteheat_urb_wrap *wrap;
1352 unsigned long flags;
1353 struct list_head *tmp;
1354 struct list_head *tmp2;
1356 spin_lock_irqsave(&info->lock, flags);
1358 list_for_each_safe(tmp, tmp2, &info->rx_urbs_free) {
1360 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1362 urb->dev = port->serial->dev;
1363 retval = usb_submit_urb(urb, GFP_KERNEL);
1365 list_add(tmp, &info->rx_urbs_free);
1366 list_for_each_safe(tmp, tmp2, &info->rx_urbs_submitted) {
1367 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1371 list_add(tmp, &info->rx_urbs_free);
1375 list_add(tmp, &info->rx_urbs_submitted);
1378 spin_unlock_irqrestore(&info->lock, flags);
1384 static struct whiteheat_urb_wrap *urb_to_wrap(struct urb* urb, struct list_head *head)
1386 struct whiteheat_urb_wrap *wrap;
1387 struct list_head *tmp;
1389 list_for_each(tmp, head) {
1390 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1391 if (wrap->urb == urb)
1399 static struct list_head *list_first(struct list_head *head)
1405 static void rx_data_softint(void *private)
1407 struct usb_serial_port *port = (struct usb_serial_port *)private;
1408 struct whiteheat_private *info = usb_get_serial_port_data(port);
1409 struct tty_struct *tty = port->tty;
1410 struct whiteheat_urb_wrap *wrap;
1412 unsigned long flags;
1413 struct list_head *tmp;
1414 struct list_head *tmp2;
1418 spin_lock_irqsave(&info->lock, flags);
1419 if (info->flags & THROTTLED) {
1420 spin_unlock_irqrestore(&info->lock, flags);
1424 list_for_each_safe(tmp, tmp2, &info->rx_urb_q) {
1426 spin_unlock_irqrestore(&info->lock, flags);
1428 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1431 if (tty && urb->actual_length) {
1432 if (urb->actual_length > TTY_FLIPBUF_SIZE - tty->flip.count) {
1433 spin_lock_irqsave(&info->lock, flags);
1434 list_add(tmp, &info->rx_urb_q);
1435 spin_unlock_irqrestore(&info->lock, flags);
1436 tty_flip_buffer_push(tty);
1437 schedule_work(&info->rx_work);
1441 memcpy(tty->flip.char_buf_ptr, urb->transfer_buffer, urb->actual_length);
1442 tty->flip.char_buf_ptr += urb->actual_length;
1443 tty->flip.count += urb->actual_length;
1444 sent += urb->actual_length;
1447 urb->dev = port->serial->dev;
1448 result = usb_submit_urb(urb, GFP_ATOMIC);
1450 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1451 spin_lock_irqsave(&info->lock, flags);
1452 list_add(tmp, &info->rx_urbs_free);
1456 spin_lock_irqsave(&info->lock, flags);
1457 list_add(tmp, &info->rx_urbs_submitted);
1459 spin_unlock_irqrestore(&info->lock, flags);
1462 tty_flip_buffer_push(tty);
1466 /*****************************************************************************
1467 * Connect Tech's White Heat module functions
1468 *****************************************************************************/
1469 static int __init whiteheat_init (void)
1472 retval = usb_serial_register(&whiteheat_fake_device);
1474 goto failed_fake_register;
1475 retval = usb_serial_register(&whiteheat_device);
1477 goto failed_device_register;
1478 retval = usb_register(&whiteheat_driver);
1480 goto failed_usb_register;
1481 info(DRIVER_DESC " " DRIVER_VERSION);
1483 failed_usb_register:
1484 usb_serial_deregister(&whiteheat_device);
1485 failed_device_register:
1486 usb_serial_deregister(&whiteheat_fake_device);
1487 failed_fake_register:
1492 static void __exit whiteheat_exit (void)
1494 usb_deregister (&whiteheat_driver);
1495 usb_serial_deregister (&whiteheat_fake_device);
1496 usb_serial_deregister (&whiteheat_device);
1500 module_init(whiteheat_init);
1501 module_exit(whiteheat_exit);
1503 MODULE_AUTHOR( DRIVER_AUTHOR );
1504 MODULE_DESCRIPTION( DRIVER_DESC );
1505 MODULE_LICENSE("GPL");
1507 module_param(urb_pool_size, int, 0);
1508 MODULE_PARM_DESC(urb_pool_size, "Number of urbs to use for buffering");
1510 module_param(debug, bool, S_IRUGO | S_IWUSR);
1511 MODULE_PARM_DESC(debug, "Debug enabled or not");