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>
84 #ifdef CONFIG_USB_SERIAL_DEBUG
90 #include "usb-serial.h"
91 #include "whiteheat_fw.h" /* firmware for the ConnectTech WhiteHEAT device */
92 #include "whiteheat.h" /* WhiteHEAT specific commands */
101 #define DRIVER_VERSION "v2.0"
102 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Stuart MacDonald <stuartm@connecttech.com>"
103 #define DRIVER_DESC "USB ConnectTech WhiteHEAT driver"
105 #define CONNECT_TECH_VENDOR_ID 0x0710
106 #define CONNECT_TECH_FAKE_WHITE_HEAT_ID 0x0001
107 #define CONNECT_TECH_WHITE_HEAT_ID 0x8001
110 ID tables for whiteheat are unusual, because we want to different
111 things for different versions of the device. Eventually, this
112 will be doable from a single table. But, for now, we define two
113 separate ID tables, and then a third table that combines them
114 just for the purpose of exporting the autoloading information.
116 static struct usb_device_id id_table_std [] = {
117 { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) },
118 { } /* Terminating entry */
121 static struct usb_device_id id_table_prerenumeration [] = {
122 { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) },
123 { } /* Terminating entry */
126 static struct usb_device_id id_table_combined [] = {
127 { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_WHITE_HEAT_ID) },
128 { USB_DEVICE(CONNECT_TECH_VENDOR_ID, CONNECT_TECH_FAKE_WHITE_HEAT_ID) },
129 { } /* Terminating entry */
132 MODULE_DEVICE_TABLE (usb, id_table_combined);
134 static struct usb_driver whiteheat_driver = {
135 .owner = THIS_MODULE,
137 .probe = usb_serial_probe,
138 .disconnect = usb_serial_disconnect,
139 .id_table = id_table_combined,
142 /* function prototypes for the Connect Tech WhiteHEAT prerenumeration device */
143 static int whiteheat_firmware_download (struct usb_serial *serial, const struct usb_device_id *id);
144 static int whiteheat_firmware_attach (struct usb_serial *serial);
146 /* function prototypes for the Connect Tech WhiteHEAT serial converter */
147 static int whiteheat_attach (struct usb_serial *serial);
148 static void whiteheat_shutdown (struct usb_serial *serial);
149 static int whiteheat_open (struct usb_serial_port *port, struct file *filp);
150 static void whiteheat_close (struct usb_serial_port *port, struct file *filp);
151 static int whiteheat_write (struct usb_serial_port *port, int from_user, const unsigned char *buf, int count);
152 static int whiteheat_write_room (struct usb_serial_port *port);
153 static int whiteheat_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
154 static void whiteheat_set_termios (struct usb_serial_port *port, struct termios * old);
155 static int whiteheat_tiocmget (struct usb_serial_port *port, struct file *file);
156 static int whiteheat_tiocmset (struct usb_serial_port *port, struct file *file, unsigned int set, unsigned int clear);
157 static void whiteheat_break_ctl (struct usb_serial_port *port, int break_state);
158 static int whiteheat_chars_in_buffer (struct usb_serial_port *port);
159 static void whiteheat_throttle (struct usb_serial_port *port);
160 static void whiteheat_unthrottle (struct usb_serial_port *port);
161 static void whiteheat_read_callback (struct urb *urb, struct pt_regs *regs);
162 static void whiteheat_write_callback (struct urb *urb, struct pt_regs *regs);
164 static struct usb_serial_device_type whiteheat_fake_device = {
165 .owner = THIS_MODULE,
166 .name = "Connect Tech - WhiteHEAT - (prerenumeration)",
167 .short_name = "whiteheatnofirm",
168 .id_table = id_table_prerenumeration,
169 .num_interrupt_in = NUM_DONT_CARE,
170 .num_bulk_in = NUM_DONT_CARE,
171 .num_bulk_out = NUM_DONT_CARE,
173 .probe = whiteheat_firmware_download,
174 .attach = whiteheat_firmware_attach,
177 static struct usb_serial_device_type whiteheat_device = {
178 .owner = THIS_MODULE,
179 .name = "Connect Tech - WhiteHEAT",
180 .short_name = "whiteheat",
181 .id_table = id_table_std,
182 .num_interrupt_in = NUM_DONT_CARE,
183 .num_bulk_in = NUM_DONT_CARE,
184 .num_bulk_out = NUM_DONT_CARE,
186 .attach = whiteheat_attach,
187 .shutdown = whiteheat_shutdown,
188 .open = whiteheat_open,
189 .close = whiteheat_close,
190 .write = whiteheat_write,
191 .write_room = whiteheat_write_room,
192 .ioctl = whiteheat_ioctl,
193 .set_termios = whiteheat_set_termios,
194 .break_ctl = whiteheat_break_ctl,
195 .tiocmget = whiteheat_tiocmget,
196 .tiocmset = whiteheat_tiocmset,
197 .chars_in_buffer = whiteheat_chars_in_buffer,
198 .throttle = whiteheat_throttle,
199 .unthrottle = whiteheat_unthrottle,
200 .read_bulk_callback = whiteheat_read_callback,
201 .write_bulk_callback = whiteheat_write_callback,
205 struct whiteheat_command_private {
208 __u8 command_finished;
209 wait_queue_head_t wait_command; /* for handling sleeping while waiting for a command to finish */
210 __u8 result_buffer[64];
214 #define THROTTLED 0x01
215 #define ACTUALLY_THROTTLED 0x02
217 static int urb_pool_size = 8;
219 struct whiteheat_urb_wrap {
220 struct list_head list;
224 struct whiteheat_private {
228 struct list_head rx_urbs_free;
229 struct list_head rx_urbs_submitted;
230 struct list_head rx_urb_q;
231 struct work_struct rx_work;
232 struct list_head tx_urbs_free;
233 struct list_head tx_urbs_submitted;
237 /* local function prototypes */
238 static int start_command_port(struct usb_serial *serial);
239 static void stop_command_port(struct usb_serial *serial);
240 static void command_port_write_callback(struct urb *urb, struct pt_regs *regs);
241 static void command_port_read_callback(struct urb *urb, struct pt_regs *regs);
243 static int start_port_read(struct usb_serial_port *port);
244 static struct whiteheat_urb_wrap *urb_to_wrap(struct urb *urb, struct list_head *head);
245 static struct list_head *list_first(struct list_head *head);
246 static void rx_data_softint(void *private);
248 static int firm_send_command(struct usb_serial_port *port, __u8 command, __u8 *data, __u8 datasize);
249 static int firm_open(struct usb_serial_port *port);
250 static int firm_close(struct usb_serial_port *port);
251 static int firm_setup_port(struct usb_serial_port *port);
252 static int firm_set_rts(struct usb_serial_port *port, __u8 onoff);
253 static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff);
254 static int firm_set_break(struct usb_serial_port *port, __u8 onoff);
255 static int firm_purge(struct usb_serial_port *port, __u8 rxtx);
256 static int firm_get_dtr_rts(struct usb_serial_port *port);
257 static int firm_report_tx_done(struct usb_serial_port *port);
260 #define COMMAND_PORT 4
261 #define COMMAND_TIMEOUT (2*HZ) /* 2 second timeout for a command */
262 #define CLOSING_DELAY (30 * HZ)
265 /*****************************************************************************
266 * Connect Tech's White Heat prerenumeration driver functions
267 *****************************************************************************/
269 /* steps to download the firmware to the WhiteHEAT device:
270 - hold the reset (by writing to the reset bit of the CPUCS register)
271 - download the VEND_AX.HEX file to the chip using VENDOR_REQUEST-ANCHOR_LOAD
272 - release the reset (by writing to the CPUCS register)
273 - download the WH.HEX file for all addresses greater than 0x1b3f using
274 VENDOR_REQUEST-ANCHOR_EXTERNAL_RAM_LOAD
276 - download the WH.HEX file for all addresses less than 0x1b40 using
277 VENDOR_REQUEST_ANCHOR_LOAD
279 - device renumerated itself and comes up as new device id with all
280 firmware download completed.
282 static int whiteheat_firmware_download (struct usb_serial *serial, const struct usb_device_id *id)
285 const struct whiteheat_hex_record *record;
287 dbg("%s", __FUNCTION__);
289 response = ezusb_set_reset (serial, 1);
291 record = &whiteheat_loader[0];
292 while (record->address != 0xffff) {
293 response = ezusb_writememory (serial, record->address,
294 (unsigned char *)record->data, record->data_size, 0xa0);
296 err("%s - ezusb_writememory failed for loader (%d %04X %p %d)",
297 __FUNCTION__, response, record->address, record->data, record->data_size);
303 response = ezusb_set_reset (serial, 0);
305 record = &whiteheat_firmware[0];
306 while (record->address < 0x1b40) {
309 while (record->address != 0xffff) {
310 response = ezusb_writememory (serial, record->address,
311 (unsigned char *)record->data, record->data_size, 0xa3);
313 err("%s - ezusb_writememory failed for first firmware step (%d %04X %p %d)",
314 __FUNCTION__, response, record->address, record->data, record->data_size);
320 response = ezusb_set_reset (serial, 1);
322 record = &whiteheat_firmware[0];
323 while (record->address < 0x1b40) {
324 response = ezusb_writememory (serial, record->address,
325 (unsigned char *)record->data, record->data_size, 0xa0);
327 err("%s - ezusb_writememory failed for second firmware step (%d %04X %p %d)",
328 __FUNCTION__, response, record->address, record->data, record->data_size);
334 response = ezusb_set_reset (serial, 0);
340 static int whiteheat_firmware_attach (struct usb_serial *serial)
342 /* We want this device to fail to have a driver assigned to it */
347 /*****************************************************************************
348 * Connect Tech's White Heat serial driver functions
349 *****************************************************************************/
350 static int whiteheat_attach (struct usb_serial *serial)
352 struct usb_serial_port *command_port;
353 struct whiteheat_command_private *command_info;
354 struct usb_serial_port *port;
355 struct whiteheat_private *info;
356 struct whiteheat_hw_info *hw_info;
366 struct whiteheat_urb_wrap *wrap;
367 struct list_head *tmp;
369 command_port = serial->port[COMMAND_PORT];
371 pipe = usb_sndbulkpipe (serial->dev, command_port->bulk_out_endpointAddress);
372 command = kmalloc(2, GFP_KERNEL);
374 goto no_command_buffer;
375 command[0] = WHITEHEAT_GET_HW_INFO;
378 result = kmalloc(sizeof(*hw_info) + 1, GFP_KERNEL);
380 goto no_result_buffer;
382 * When the module is reloaded the firmware is still there and
383 * the endpoints are still in the usb core unchanged. This is the
384 * unlinking bug in disguise. Same for the call below.
386 usb_clear_halt(serial->dev, pipe);
387 ret = usb_bulk_msg (serial->dev, pipe, command, 2, &alen, COMMAND_TIMEOUT);
389 err("%s: Couldn't send command [%d]", serial->type->name, ret);
391 } else if (alen != sizeof(command)) {
392 err("%s: Send command incomplete [%d]", serial->type->name, alen);
396 pipe = usb_rcvbulkpipe (serial->dev, command_port->bulk_in_endpointAddress);
397 /* See the comment on the usb_clear_halt() above */
398 usb_clear_halt(serial->dev, pipe);
399 ret = usb_bulk_msg (serial->dev, pipe, result, sizeof(*hw_info) + 1, &alen, COMMAND_TIMEOUT);
401 err("%s: Couldn't get results [%d]", serial->type->name, ret);
403 } else if (alen != sizeof(result)) {
404 err("%s: Get results incomplete [%d]", serial->type->name, alen);
406 } else if (result[0] != command[0]) {
407 err("%s: Command failed [%d]", serial->type->name, result[0]);
411 hw_info = (struct whiteheat_hw_info *)&result[1];
413 info("%s: Driver %s: Firmware v%d.%02d", serial->type->name,
414 DRIVER_VERSION, hw_info->sw_major_rev, hw_info->sw_minor_rev);
416 for (i = 0; i < serial->num_ports; i++) {
417 port = serial->port[i];
419 info = (struct whiteheat_private *)kmalloc(sizeof(struct whiteheat_private), GFP_KERNEL);
421 err("%s: Out of memory for port structures\n", serial->type->name);
425 spin_lock_init(&info->lock);
428 INIT_WORK(&info->rx_work, rx_data_softint, port);
430 INIT_LIST_HEAD(&info->rx_urbs_free);
431 INIT_LIST_HEAD(&info->rx_urbs_submitted);
432 INIT_LIST_HEAD(&info->rx_urb_q);
433 INIT_LIST_HEAD(&info->tx_urbs_free);
434 INIT_LIST_HEAD(&info->tx_urbs_submitted);
436 for (j = 0; j < urb_pool_size; j++) {
437 urb = usb_alloc_urb(0, GFP_KERNEL);
439 err("No free urbs available");
442 buf_size = port->read_urb->transfer_buffer_length;
443 urb->transfer_buffer = kmalloc(buf_size, GFP_KERNEL);
444 if (!urb->transfer_buffer) {
445 err("Couldn't allocate urb buffer");
448 wrap = kmalloc(sizeof(*wrap), GFP_KERNEL);
450 err("Couldn't allocate urb wrapper");
453 usb_fill_bulk_urb(urb, serial->dev,
454 usb_rcvbulkpipe(serial->dev,
455 port->bulk_in_endpointAddress),
456 urb->transfer_buffer, buf_size,
457 whiteheat_read_callback, port);
459 list_add(&wrap->list, &info->rx_urbs_free);
461 urb = usb_alloc_urb(0, GFP_KERNEL);
463 err("No free urbs available");
466 buf_size = port->write_urb->transfer_buffer_length;
467 urb->transfer_buffer = kmalloc(buf_size, GFP_KERNEL);
468 if (!urb->transfer_buffer) {
469 err("Couldn't allocate urb buffer");
472 wrap = kmalloc(sizeof(*wrap), GFP_KERNEL);
474 err("Couldn't allocate urb wrapper");
477 usb_fill_bulk_urb(urb, serial->dev,
478 usb_sndbulkpipe(serial->dev,
479 port->bulk_out_endpointAddress),
480 urb->transfer_buffer, buf_size,
481 whiteheat_write_callback, port);
483 list_add(&wrap->list, &info->tx_urbs_free);
486 usb_set_serial_port_data(port, info);
489 command_info = (struct whiteheat_command_private *)kmalloc(sizeof(struct whiteheat_command_private), GFP_KERNEL);
490 if (command_info == NULL) {
491 err("%s: Out of memory for port structures\n", serial->type->name);
492 goto no_command_private;
495 spin_lock_init(&command_info->lock);
496 command_info->port_running = 0;
497 init_waitqueue_head(&command_info->wait_command);
498 usb_set_serial_port_data(command_port, command_info);
499 command_port->write_urb->complete = command_port_write_callback;
500 command_port->read_urb->complete = command_port_read_callback;
507 /* Firmware likely not running */
508 err("%s: Unable to retrieve firmware version, try replugging\n", serial->type->name);
509 err("%s: If the firmware is not running (status led not blinking)\n", serial->type->name);
510 err("%s: please contact support@connecttech.com\n", serial->type->name);
514 for (i = serial->num_ports - 1; i >= 0; i--) {
515 port = serial->port[i];
516 info = usb_get_serial_port_data(port);
517 for (j = urb_pool_size - 1; j >= 0; j--) {
518 tmp = list_first(&info->tx_urbs_free);
520 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
524 kfree(urb->transfer_buffer);
528 tmp = list_first(&info->rx_urbs_free);
530 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
534 kfree(urb->transfer_buffer);
552 static void whiteheat_shutdown (struct usb_serial *serial)
554 struct usb_serial_port *command_port;
555 struct usb_serial_port *port;
556 struct whiteheat_private *info;
557 struct whiteheat_urb_wrap *wrap;
559 struct list_head *tmp;
560 struct list_head *tmp2;
563 dbg("%s", __FUNCTION__);
565 /* free up our private data for our command port */
566 command_port = serial->port[COMMAND_PORT];
567 kfree (usb_get_serial_port_data(command_port));
569 for (i = 0; i < serial->num_ports; i++) {
570 port = serial->port[i];
571 info = usb_get_serial_port_data(port);
572 list_for_each_safe(tmp, tmp2, &info->rx_urbs_free) {
574 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
577 kfree(urb->transfer_buffer);
580 list_for_each_safe(tmp, tmp2, &info->tx_urbs_free) {
582 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
585 kfree(urb->transfer_buffer);
595 static int whiteheat_open (struct usb_serial_port *port, struct file *filp)
598 struct termios old_term;
600 dbg("%s - port %d", __FUNCTION__, port->number);
602 retval = start_command_port(port->serial);
607 port->tty->low_latency = 1;
609 /* send an open port command */
610 retval = firm_open(port);
612 stop_command_port(port->serial);
616 retval = firm_purge(port, WHITEHEAT_PURGE_RX | WHITEHEAT_PURGE_TX);
619 stop_command_port(port->serial);
623 old_term.c_cflag = ~port->tty->termios->c_cflag;
624 old_term.c_iflag = ~port->tty->termios->c_iflag;
625 whiteheat_set_termios(port, &old_term);
627 /* Work around HCD bugs */
628 usb_clear_halt(port->serial->dev, port->read_urb->pipe);
629 usb_clear_halt(port->serial->dev, port->write_urb->pipe);
631 /* Start reading from the device */
632 retval = start_port_read(port);
634 err("%s - failed submitting read urb, error %d", __FUNCTION__, retval);
636 stop_command_port(port->serial);
641 dbg("%s - exit, retval = %d", __FUNCTION__, retval);
646 static void whiteheat_close(struct usb_serial_port *port, struct file * filp)
648 struct whiteheat_private *info = usb_get_serial_port_data(port);
649 struct whiteheat_urb_wrap *wrap;
651 struct list_head *tmp;
652 struct list_head *tmp2;
655 dbg("%s - port %d", __FUNCTION__, port->number);
657 /* filp is NULL when called from usb_serial_disconnect */
658 if (filp && (tty_hung_up_p(filp))) {
662 port->tty->closing = 1;
665 * Not currently in use; tty_wait_until_sent() calls
666 * serial_chars_in_buffer() which deadlocks on the second semaphore
667 * acquisition. This should be fixed at some point. Greg's been
669 if ((filp->f_flags & (O_NDELAY | O_NONBLOCK)) == 0) {
670 tty_wait_until_sent(port->tty, CLOSING_DELAY);
674 if (port->tty->driver->flush_buffer)
675 port->tty->driver->flush_buffer(port->tty);
676 if (port->tty->ldisc.flush_buffer)
677 port->tty->ldisc.flush_buffer(port->tty);
679 firm_report_tx_done(port);
683 /* shutdown our bulk reads and writes */
684 spin_lock_irqsave(&info->lock, flags);
685 list_for_each_safe(tmp, tmp2, &info->rx_urbs_submitted) {
686 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
690 list_add(tmp, &info->rx_urbs_free);
692 list_for_each_safe(tmp, tmp2, &info->rx_urb_q) {
694 list_add(tmp, &info->rx_urbs_free);
696 list_for_each_safe(tmp, tmp2, &info->tx_urbs_submitted) {
697 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
701 list_add(tmp, &info->tx_urbs_free);
703 spin_unlock_irqrestore(&info->lock, flags);
705 stop_command_port(port->serial);
707 port->tty->closing = 0;
711 static int whiteheat_write(struct usb_serial_port *port, int from_user, const unsigned char *buf, int count)
713 struct usb_serial *serial = port->serial;
714 struct whiteheat_private *info = usb_get_serial_port_data(port);
715 struct whiteheat_urb_wrap *wrap;
721 struct list_head *tmp;
723 dbg("%s - port %d", __FUNCTION__, port->number);
726 dbg("%s - write request of 0 bytes", __FUNCTION__);
731 spin_lock_irqsave(&info->lock, flags);
732 if (list_empty(&info->tx_urbs_free)) {
733 spin_unlock_irqrestore(&info->lock, flags);
736 tmp = list_first(&info->tx_urbs_free);
738 spin_unlock_irqrestore(&info->lock, flags);
740 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
742 bytes = (count > port->bulk_out_size) ? port->bulk_out_size : count;
744 if (copy_from_user(urb->transfer_buffer, buf + sent, bytes))
747 memcpy (urb->transfer_buffer, buf + sent, bytes);
750 usb_serial_debug_data (__FILE__, __FUNCTION__, bytes, urb->transfer_buffer);
752 urb->dev = serial->dev;
753 urb->transfer_buffer_length = bytes;
754 result = usb_submit_urb(urb, GFP_ATOMIC);
756 err("%s - failed submitting write urb, error %d", __FUNCTION__, result);
758 spin_lock_irqsave(&info->lock, flags);
759 list_add(tmp, &info->tx_urbs_free);
760 spin_unlock_irqrestore(&info->lock, flags);
765 spin_lock_irqsave(&info->lock, flags);
766 list_add(tmp, &info->tx_urbs_submitted);
767 spin_unlock_irqrestore(&info->lock, flags);
775 static int whiteheat_write_room(struct usb_serial_port *port)
777 struct whiteheat_private *info = usb_get_serial_port_data(port);
778 struct list_head *tmp;
782 dbg("%s - port %d", __FUNCTION__, port->number);
784 spin_lock_irqsave(&info->lock, flags);
785 list_for_each(tmp, &info->tx_urbs_free)
787 spin_unlock_irqrestore(&info->lock, flags);
788 room *= port->bulk_out_size;
790 dbg("%s - returns %d", __FUNCTION__, room);
795 static int whiteheat_tiocmget (struct usb_serial_port *port, struct file *file)
797 struct whiteheat_private *info = usb_get_serial_port_data(port);
798 unsigned int modem_signals = 0;
800 dbg("%s - port %d", __FUNCTION__, port->number);
802 firm_get_dtr_rts(port);
803 if (info->mcr & UART_MCR_DTR)
804 modem_signals |= TIOCM_DTR;
805 if (info->mcr & UART_MCR_RTS)
806 modem_signals |= TIOCM_RTS;
808 return modem_signals;
812 static int whiteheat_tiocmset (struct usb_serial_port *port, struct file *file,
813 unsigned int set, unsigned int clear)
815 struct whiteheat_private *info = usb_get_serial_port_data(port);
817 dbg("%s - port %d", __FUNCTION__, port->number);
820 info->mcr |= UART_MCR_RTS;
822 info->mcr |= UART_MCR_DTR;
824 if (clear & TIOCM_RTS)
825 info->mcr &= ~UART_MCR_RTS;
826 if (clear & TIOCM_DTR)
827 info->mcr &= ~UART_MCR_DTR;
829 firm_set_dtr(port, info->mcr & UART_MCR_DTR);
830 firm_set_rts(port, info->mcr & UART_MCR_RTS);
835 static int whiteheat_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
837 struct serial_struct serstruct;
839 dbg("%s - port %d, cmd 0x%.4x", __FUNCTION__, port->number, cmd);
843 memset(&serstruct, 0, sizeof(serstruct));
844 serstruct.type = PORT_16654;
845 serstruct.line = port->serial->minor;
846 serstruct.port = port->number;
847 serstruct.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
848 serstruct.xmit_fifo_size = port->bulk_out_size;
849 serstruct.custom_divisor = 0;
850 serstruct.baud_base = 460800;
851 serstruct.close_delay = CLOSING_DELAY;
852 serstruct.closing_wait = CLOSING_DELAY;
854 if (copy_to_user((void *)arg, &serstruct, sizeof(serstruct)))
860 if (copy_from_user(&serstruct, (void *)arg, sizeof(serstruct)))
864 * For now this is ignored. dip sets the ASYNC_[V]HI flags
865 * but this isn't used by us at all. Maybe someone somewhere
866 * will need the custom_divisor setting.
879 static void whiteheat_set_termios (struct usb_serial_port *port, struct termios *old_termios)
881 dbg("%s -port %d", __FUNCTION__, port->number);
883 if ((!port->tty) || (!port->tty->termios)) {
884 dbg("%s - no tty structures", __FUNCTION__);
888 /* check that they really want us to change something */
890 if ((port->tty->termios->c_cflag == old_termios->c_cflag) &&
891 (port->tty->termios->c_iflag == old_termios->c_iflag)) {
892 dbg("%s - nothing to change...", __FUNCTION__);
897 firm_setup_port(port);
904 static void whiteheat_break_ctl(struct usb_serial_port *port, int break_state) {
905 firm_set_break(port, break_state);
909 static int whiteheat_chars_in_buffer(struct usb_serial_port *port)
911 struct whiteheat_private *info = usb_get_serial_port_data(port);
912 struct list_head *tmp;
913 struct whiteheat_urb_wrap *wrap;
917 dbg("%s - port %d", __FUNCTION__, port->number);
919 spin_lock_irqsave(&info->lock, flags);
920 list_for_each(tmp, &info->tx_urbs_submitted) {
921 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
922 chars += wrap->urb->transfer_buffer_length;
924 spin_unlock_irqrestore(&info->lock, flags);
926 dbg ("%s - returns %d", __FUNCTION__, chars);
931 static void whiteheat_throttle (struct usb_serial_port *port)
933 struct whiteheat_private *info = usb_get_serial_port_data(port);
936 dbg("%s - port %d", __FUNCTION__, port->number);
938 spin_lock_irqsave(&info->lock, flags);
939 info->flags |= THROTTLED;
940 spin_unlock_irqrestore(&info->lock, flags);
946 static void whiteheat_unthrottle (struct usb_serial_port *port)
948 struct whiteheat_private *info = usb_get_serial_port_data(port);
949 int actually_throttled;
952 dbg("%s - port %d", __FUNCTION__, port->number);
954 spin_lock_irqsave(&info->lock, flags);
955 actually_throttled = info->flags & ACTUALLY_THROTTLED;
956 info->flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
957 spin_unlock_irqrestore(&info->lock, flags);
959 if (actually_throttled)
960 rx_data_softint(port);
966 /*****************************************************************************
967 * Connect Tech's White Heat callback routines
968 *****************************************************************************/
969 static void command_port_write_callback (struct urb *urb, struct pt_regs *regs)
971 dbg("%s", __FUNCTION__);
974 dbg ("nonzero urb status: %d", urb->status);
978 usb_serial_debug_data (__FILE__, __FUNCTION__, urb->actual_length, urb->transfer_buffer);
984 static void command_port_read_callback (struct urb *urb, struct pt_regs *regs)
986 struct usb_serial_port *command_port = (struct usb_serial_port *)urb->context;
987 struct whiteheat_command_private *command_info;
988 unsigned char *data = urb->transfer_buffer;
992 dbg("%s", __FUNCTION__);
995 dbg("%s - nonzero urb status: %d", __FUNCTION__, urb->status);
999 usb_serial_debug_data (__FILE__, __FUNCTION__, urb->actual_length, data);
1001 command_info = usb_get_serial_port_data(command_port);
1002 if (!command_info) {
1003 dbg ("%s - command_info is NULL, exiting.", __FUNCTION__);
1006 spin_lock_irqsave(&command_info->lock, flags);
1008 if (data[0] == WHITEHEAT_CMD_COMPLETE) {
1009 command_info->command_finished = WHITEHEAT_CMD_COMPLETE;
1010 wake_up_interruptible(&command_info->wait_command);
1011 } else if (data[0] == WHITEHEAT_CMD_FAILURE) {
1012 command_info->command_finished = WHITEHEAT_CMD_FAILURE;
1013 wake_up_interruptible(&command_info->wait_command);
1014 } else if (data[0] == WHITEHEAT_EVENT) {
1015 /* These are unsolicited reports from the firmware, hence no waiting command to wakeup */
1016 dbg("%s - event received", __FUNCTION__);
1017 } else if (data[0] == WHITEHEAT_GET_DTR_RTS) {
1018 memcpy(command_info->result_buffer, &data[1], urb->actual_length - 1);
1019 command_info->command_finished = WHITEHEAT_CMD_COMPLETE;
1020 wake_up_interruptible(&command_info->wait_command);
1022 dbg("%s - bad reply from firmware", __FUNCTION__);
1025 /* Continue trying to always read */
1026 command_port->read_urb->dev = command_port->serial->dev;
1027 result = usb_submit_urb(command_port->read_urb, GFP_ATOMIC);
1028 spin_unlock_irqrestore(&command_info->lock, flags);
1030 dbg("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1034 static void whiteheat_read_callback(struct urb *urb, struct pt_regs *regs)
1036 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1037 struct whiteheat_urb_wrap *wrap;
1038 unsigned char *data = urb->transfer_buffer;
1039 struct whiteheat_private *info = usb_get_serial_port_data(port);
1041 dbg("%s - port %d", __FUNCTION__, port->number);
1043 spin_lock(&info->lock);
1044 wrap = urb_to_wrap(urb, &info->rx_urbs_submitted);
1046 spin_unlock(&info->lock);
1047 err("%s - Not my urb!", __FUNCTION__);
1050 list_del(&wrap->list);
1051 spin_unlock(&info->lock);
1054 dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status);
1055 spin_lock(&info->lock);
1056 list_add(&wrap->list, &info->rx_urbs_free);
1057 spin_unlock(&info->lock);
1061 usb_serial_debug_data (__FILE__, __FUNCTION__, urb->actual_length, data);
1063 spin_lock(&info->lock);
1064 list_add_tail(&wrap->list, &info->rx_urb_q);
1065 if (info->flags & THROTTLED) {
1066 info->flags |= ACTUALLY_THROTTLED;
1067 spin_unlock(&info->lock);
1070 spin_unlock(&info->lock);
1072 schedule_work(&info->rx_work);
1076 static void whiteheat_write_callback(struct urb *urb, struct pt_regs *regs)
1078 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1079 struct whiteheat_private *info = usb_get_serial_port_data(port);
1080 struct whiteheat_urb_wrap *wrap;
1082 dbg("%s - port %d", __FUNCTION__, port->number);
1084 spin_lock(&info->lock);
1085 wrap = urb_to_wrap(urb, &info->tx_urbs_submitted);
1087 spin_unlock(&info->lock);
1088 err("%s - Not my urb!", __FUNCTION__);
1091 list_del(&wrap->list);
1092 list_add(&wrap->list, &info->tx_urbs_free);
1093 spin_unlock(&info->lock);
1096 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
1100 usb_serial_port_softint((void *)port);
1102 schedule_work(&port->work);
1106 /*****************************************************************************
1107 * Connect Tech's White Heat firmware interface
1108 *****************************************************************************/
1109 static int firm_send_command (struct usb_serial_port *port, __u8 command, __u8 *data, __u8 datasize)
1111 struct usb_serial_port *command_port;
1112 struct whiteheat_command_private *command_info;
1113 struct whiteheat_private *info;
1114 __u8 *transfer_buffer;
1116 unsigned long flags;
1118 dbg("%s - command %d", __FUNCTION__, command);
1120 command_port = port->serial->port[COMMAND_PORT];
1121 command_info = usb_get_serial_port_data(command_port);
1122 spin_lock_irqsave(&command_info->lock, flags);
1123 command_info->command_finished = FALSE;
1125 transfer_buffer = (__u8 *)command_port->write_urb->transfer_buffer;
1126 transfer_buffer[0] = command;
1127 memcpy (&transfer_buffer[1], data, datasize);
1128 command_port->write_urb->transfer_buffer_length = datasize + 1;
1129 command_port->write_urb->dev = port->serial->dev;
1130 retval = usb_submit_urb (command_port->write_urb, GFP_KERNEL);
1131 spin_unlock_irqrestore(&command_info->lock, flags);
1133 dbg("%s - submit urb failed", __FUNCTION__);
1137 /* wait for the command to complete */
1138 wait_event_interruptible_timeout(command_info->wait_command,
1139 (command_info->command_finished != FALSE), COMMAND_TIMEOUT);
1141 spin_lock_irqsave(&command_info->lock, flags);
1143 if (command_info->command_finished == FALSE) {
1144 dbg("%s - command timed out.", __FUNCTION__);
1145 retval = -ETIMEDOUT;
1149 if (command_info->command_finished == WHITEHEAT_CMD_FAILURE) {
1150 dbg("%s - command failed.", __FUNCTION__);
1155 if (command_info->command_finished == WHITEHEAT_CMD_COMPLETE) {
1156 dbg("%s - command completed.", __FUNCTION__);
1158 case WHITEHEAT_GET_DTR_RTS:
1159 info = usb_get_serial_port_data(port);
1160 memcpy(&info->mcr, command_info->result_buffer, sizeof(struct whiteheat_dr_info));
1166 spin_unlock_irqrestore(&command_info->lock, flags);
1171 static int firm_open(struct usb_serial_port *port) {
1172 struct whiteheat_simple open_command;
1174 open_command.port = port->number - port->serial->minor + 1;
1175 return firm_send_command(port, WHITEHEAT_OPEN, (__u8 *)&open_command, sizeof(open_command));
1179 static int firm_close(struct usb_serial_port *port) {
1180 struct whiteheat_simple close_command;
1182 close_command.port = port->number - port->serial->minor + 1;
1183 return firm_send_command(port, WHITEHEAT_CLOSE, (__u8 *)&close_command, sizeof(close_command));
1187 static int firm_setup_port(struct usb_serial_port *port) {
1188 struct whiteheat_port_settings port_settings;
1189 unsigned int cflag = port->tty->termios->c_cflag;
1191 port_settings.port = port->number + 1;
1193 /* get the byte size */
1194 switch (cflag & CSIZE) {
1195 case CS5: port_settings.bits = 5; break;
1196 case CS6: port_settings.bits = 6; break;
1197 case CS7: port_settings.bits = 7; break;
1199 case CS8: port_settings.bits = 8; break;
1201 dbg("%s - data bits = %d", __FUNCTION__, port_settings.bits);
1203 /* determine the parity */
1207 port_settings.parity = WHITEHEAT_PAR_MARK;
1209 port_settings.parity = WHITEHEAT_PAR_SPACE;
1212 port_settings.parity = WHITEHEAT_PAR_ODD;
1214 port_settings.parity = WHITEHEAT_PAR_EVEN;
1216 port_settings.parity = WHITEHEAT_PAR_NONE;
1217 dbg("%s - parity = %c", __FUNCTION__, port_settings.parity);
1219 /* figure out the stop bits requested */
1221 port_settings.stop = 2;
1223 port_settings.stop = 1;
1224 dbg("%s - stop bits = %d", __FUNCTION__, port_settings.stop);
1226 /* figure out the flow control settings */
1227 if (cflag & CRTSCTS)
1228 port_settings.hflow = (WHITEHEAT_HFLOW_CTS | WHITEHEAT_HFLOW_RTS);
1230 port_settings.hflow = WHITEHEAT_HFLOW_NONE;
1231 dbg("%s - hardware flow control = %s %s %s %s", __FUNCTION__,
1232 (port_settings.hflow & WHITEHEAT_HFLOW_CTS) ? "CTS" : "",
1233 (port_settings.hflow & WHITEHEAT_HFLOW_RTS) ? "RTS" : "",
1234 (port_settings.hflow & WHITEHEAT_HFLOW_DSR) ? "DSR" : "",
1235 (port_settings.hflow & WHITEHEAT_HFLOW_DTR) ? "DTR" : "");
1237 /* determine software flow control */
1238 if (I_IXOFF(port->tty))
1239 port_settings.sflow = WHITEHEAT_SFLOW_RXTX;
1241 port_settings.sflow = WHITEHEAT_SFLOW_NONE;
1242 dbg("%s - software flow control = %c", __FUNCTION__, port_settings.sflow);
1244 port_settings.xon = START_CHAR(port->tty);
1245 port_settings.xoff = STOP_CHAR(port->tty);
1246 dbg("%s - XON = %2x, XOFF = %2x", __FUNCTION__, port_settings.xon, port_settings.xoff);
1248 /* get the baud rate wanted */
1249 port_settings.baud = tty_get_baud_rate(port->tty);
1250 dbg("%s - baud rate = %d", __FUNCTION__, port_settings.baud);
1252 /* handle any settings that aren't specified in the tty structure */
1253 port_settings.lloop = 0;
1255 /* now send the message to the device */
1256 return firm_send_command(port, WHITEHEAT_SETUP_PORT, (__u8 *)&port_settings, sizeof(port_settings));
1260 static int firm_set_rts(struct usb_serial_port *port, __u8 onoff) {
1261 struct whiteheat_set_rdb rts_command;
1263 rts_command.port = port->number - port->serial->minor + 1;
1264 rts_command.state = onoff;
1265 return firm_send_command(port, WHITEHEAT_SET_RTS, (__u8 *)&rts_command, sizeof(rts_command));
1269 static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff) {
1270 struct whiteheat_set_rdb dtr_command;
1272 dtr_command.port = port->number - port->serial->minor + 1;
1273 dtr_command.state = onoff;
1274 return firm_send_command(port, WHITEHEAT_SET_RTS, (__u8 *)&dtr_command, sizeof(dtr_command));
1278 static int firm_set_break(struct usb_serial_port *port, __u8 onoff) {
1279 struct whiteheat_set_rdb break_command;
1281 break_command.port = port->number - port->serial->minor + 1;
1282 break_command.state = onoff;
1283 return firm_send_command(port, WHITEHEAT_SET_RTS, (__u8 *)&break_command, sizeof(break_command));
1287 static int firm_purge(struct usb_serial_port *port, __u8 rxtx) {
1288 struct whiteheat_purge purge_command;
1290 purge_command.port = port->number - port->serial->minor + 1;
1291 purge_command.what = rxtx;
1292 return firm_send_command(port, WHITEHEAT_PURGE, (__u8 *)&purge_command, sizeof(purge_command));
1296 static int firm_get_dtr_rts(struct usb_serial_port *port) {
1297 struct whiteheat_simple get_dr_command;
1299 get_dr_command.port = port->number - port->serial->minor + 1;
1300 return firm_send_command(port, WHITEHEAT_GET_DTR_RTS, (__u8 *)&get_dr_command, sizeof(get_dr_command));
1304 static int firm_report_tx_done(struct usb_serial_port *port) {
1305 struct whiteheat_simple close_command;
1307 close_command.port = port->number - port->serial->minor + 1;
1308 return firm_send_command(port, WHITEHEAT_REPORT_TX_DONE, (__u8 *)&close_command, sizeof(close_command));
1312 /*****************************************************************************
1313 * Connect Tech's White Heat utility functions
1314 *****************************************************************************/
1315 static int start_command_port(struct usb_serial *serial)
1317 struct usb_serial_port *command_port;
1318 struct whiteheat_command_private *command_info;
1319 unsigned long flags;
1322 command_port = serial->port[COMMAND_PORT];
1323 command_info = usb_get_serial_port_data(command_port);
1324 spin_lock_irqsave(&command_info->lock, flags);
1325 if (!command_info->port_running) {
1326 /* Work around HCD bugs */
1327 usb_clear_halt(serial->dev, command_port->read_urb->pipe);
1329 command_port->read_urb->dev = serial->dev;
1330 retval = usb_submit_urb(command_port->read_urb, GFP_KERNEL);
1332 err("%s - failed submitting read urb, error %d", __FUNCTION__, retval);
1336 command_info->port_running++;
1339 spin_unlock_irqrestore(&command_info->lock, flags);
1344 static void stop_command_port(struct usb_serial *serial)
1346 struct usb_serial_port *command_port;
1347 struct whiteheat_command_private *command_info;
1348 unsigned long flags;
1350 command_port = serial->port[COMMAND_PORT];
1351 command_info = usb_get_serial_port_data(command_port);
1352 spin_lock_irqsave(&command_info->lock, flags);
1353 command_info->port_running--;
1354 if (!command_info->port_running)
1355 usb_unlink_urb(command_port->read_urb);
1356 spin_unlock_irqrestore(&command_info->lock, flags);
1360 static int start_port_read(struct usb_serial_port *port)
1362 struct whiteheat_private *info = usb_get_serial_port_data(port);
1363 struct whiteheat_urb_wrap *wrap;
1366 unsigned long flags;
1367 struct list_head *tmp;
1368 struct list_head *tmp2;
1370 spin_lock_irqsave(&info->lock, flags);
1372 list_for_each_safe(tmp, tmp2, &info->rx_urbs_free) {
1374 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1376 urb->dev = port->serial->dev;
1377 retval = usb_submit_urb(urb, GFP_KERNEL);
1379 list_add(tmp, &info->rx_urbs_free);
1380 list_for_each_safe(tmp, tmp2, &info->rx_urbs_submitted) {
1381 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1383 usb_unlink_urb(urb);
1385 list_add(tmp, &info->rx_urbs_free);
1389 list_add(tmp, &info->rx_urbs_submitted);
1392 spin_unlock_irqrestore(&info->lock, flags);
1398 static struct whiteheat_urb_wrap *urb_to_wrap(struct urb* urb, struct list_head *head)
1400 struct whiteheat_urb_wrap *wrap;
1401 struct list_head *tmp;
1403 list_for_each(tmp, head) {
1404 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1405 if (wrap->urb == urb)
1413 static struct list_head *list_first(struct list_head *head)
1419 static void rx_data_softint(void *private)
1421 struct usb_serial_port *port = (struct usb_serial_port *)private;
1422 struct whiteheat_private *info = usb_get_serial_port_data(port);
1423 struct tty_struct *tty = port->tty;
1424 struct whiteheat_urb_wrap *wrap;
1426 unsigned long flags;
1427 struct list_head *tmp;
1428 struct list_head *tmp2;
1432 spin_lock_irqsave(&info->lock, flags);
1433 if (info->flags & THROTTLED) {
1434 spin_unlock_irqrestore(&info->lock, flags);
1438 list_for_each_safe(tmp, tmp2, &info->rx_urb_q) {
1440 spin_unlock_irqrestore(&info->lock, flags);
1442 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1445 if (tty && urb->actual_length) {
1446 if (urb->actual_length > TTY_FLIPBUF_SIZE - tty->flip.count) {
1447 spin_lock_irqsave(&info->lock, flags);
1448 list_add(tmp, &info->rx_urb_q);
1449 spin_unlock_irqrestore(&info->lock, flags);
1450 tty_flip_buffer_push(tty);
1451 schedule_work(&info->rx_work);
1455 memcpy(tty->flip.char_buf_ptr, urb->transfer_buffer, urb->actual_length);
1456 tty->flip.char_buf_ptr += urb->actual_length;
1457 tty->flip.count += urb->actual_length;
1458 sent += urb->actual_length;
1461 urb->dev = port->serial->dev;
1462 result = usb_submit_urb(urb, GFP_ATOMIC);
1464 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1465 spin_lock_irqsave(&info->lock, flags);
1466 list_add(tmp, &info->rx_urbs_free);
1470 spin_lock_irqsave(&info->lock, flags);
1471 list_add(tmp, &info->rx_urbs_submitted);
1473 spin_unlock_irqrestore(&info->lock, flags);
1476 tty_flip_buffer_push(tty);
1480 /*****************************************************************************
1481 * Connect Tech's White Heat module functions
1482 *****************************************************************************/
1483 static int __init whiteheat_init (void)
1486 retval = usb_serial_register(&whiteheat_fake_device);
1488 goto failed_fake_register;
1489 retval = usb_serial_register(&whiteheat_device);
1491 goto failed_device_register;
1492 retval = usb_register(&whiteheat_driver);
1494 goto failed_usb_register;
1495 info(DRIVER_DESC " " DRIVER_VERSION);
1497 failed_usb_register:
1498 usb_serial_deregister(&whiteheat_device);
1499 failed_device_register:
1500 usb_serial_deregister(&whiteheat_fake_device);
1501 failed_fake_register:
1506 static void __exit whiteheat_exit (void)
1508 usb_deregister (&whiteheat_driver);
1509 usb_serial_deregister (&whiteheat_fake_device);
1510 usb_serial_deregister (&whiteheat_device);
1514 module_init(whiteheat_init);
1515 module_exit(whiteheat_exit);
1517 MODULE_AUTHOR( DRIVER_AUTHOR );
1518 MODULE_DESCRIPTION( DRIVER_DESC );
1519 MODULE_LICENSE("GPL");
1521 MODULE_PARM(urb_pool_size, "i");
1522 MODULE_PARM_DESC(urb_pool_size, "Number of urbs to use for buffering");
1524 MODULE_PARM(debug, "i");
1525 MODULE_PARM_DESC(debug, "Debug enabled or not");