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/kernel.h>
69 #include <linux/errno.h>
70 #include <linux/init.h>
71 #include <linux/slab.h>
72 #include <linux/tty.h>
73 #include <linux/tty_driver.h>
74 #include <linux/tty_flip.h>
75 #include <linux/module.h>
76 #include <linux/spinlock.h>
77 #include <linux/mutex.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 <linux/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 = {
131 .probe = usb_serial_probe,
132 .disconnect = usb_serial_disconnect,
133 .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 ktermios * 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);
157 static void whiteheat_write_callback (struct urb *urb);
159 static struct usb_serial_driver whiteheat_fake_device = {
161 .owner = THIS_MODULE,
162 .name = "whiteheatnofirm",
164 .description = "Connect Tech - WhiteHEAT - (prerenumeration)",
165 .usb_driver = &whiteheat_driver,
166 .id_table = id_table_prerenumeration,
167 .num_interrupt_in = NUM_DONT_CARE,
168 .num_bulk_in = NUM_DONT_CARE,
169 .num_bulk_out = NUM_DONT_CARE,
171 .probe = whiteheat_firmware_download,
172 .attach = whiteheat_firmware_attach,
175 static struct usb_serial_driver whiteheat_device = {
177 .owner = THIS_MODULE,
180 .description = "Connect Tech - WhiteHEAT",
181 .usb_driver = &whiteheat_driver,
182 .id_table = id_table_std,
183 .num_interrupt_in = NUM_DONT_CARE,
184 .num_bulk_in = NUM_DONT_CARE,
185 .num_bulk_out = NUM_DONT_CARE,
187 .attach = whiteheat_attach,
188 .shutdown = whiteheat_shutdown,
189 .open = whiteheat_open,
190 .close = whiteheat_close,
191 .write = whiteheat_write,
192 .write_room = whiteheat_write_room,
193 .ioctl = whiteheat_ioctl,
194 .set_termios = whiteheat_set_termios,
195 .break_ctl = whiteheat_break_ctl,
196 .tiocmget = whiteheat_tiocmget,
197 .tiocmset = whiteheat_tiocmset,
198 .chars_in_buffer = whiteheat_chars_in_buffer,
199 .throttle = whiteheat_throttle,
200 .unthrottle = whiteheat_unthrottle,
201 .read_bulk_callback = whiteheat_read_callback,
202 .write_bulk_callback = whiteheat_write_callback,
206 struct whiteheat_command_private {
209 __u8 command_finished;
210 wait_queue_head_t wait_command; /* for handling sleeping while waiting for a command to finish */
211 __u8 result_buffer[64];
215 #define THROTTLED 0x01
216 #define ACTUALLY_THROTTLED 0x02
218 static int urb_pool_size = 8;
220 struct whiteheat_urb_wrap {
221 struct list_head list;
225 struct whiteheat_private {
229 struct list_head rx_urbs_free;
230 struct list_head rx_urbs_submitted;
231 struct list_head rx_urb_q;
232 struct work_struct rx_work;
233 struct usb_serial_port *port;
234 struct list_head tx_urbs_free;
235 struct list_head tx_urbs_submitted;
236 struct mutex deathwarrant;
240 /* local function prototypes */
241 static int start_command_port(struct usb_serial *serial);
242 static void stop_command_port(struct usb_serial *serial);
243 static void command_port_write_callback(struct urb *urb);
244 static void command_port_read_callback(struct urb *urb);
246 static int start_port_read(struct usb_serial_port *port);
247 static struct whiteheat_urb_wrap *urb_to_wrap(struct urb *urb, struct list_head *head);
248 static struct list_head *list_first(struct list_head *head);
249 static void rx_data_softint(struct work_struct *work);
251 static int firm_send_command(struct usb_serial_port *port, __u8 command, __u8 *data, __u8 datasize);
252 static int firm_open(struct usb_serial_port *port);
253 static int firm_close(struct usb_serial_port *port);
254 static int firm_setup_port(struct usb_serial_port *port);
255 static int firm_set_rts(struct usb_serial_port *port, __u8 onoff);
256 static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff);
257 static int firm_set_break(struct usb_serial_port *port, __u8 onoff);
258 static int firm_purge(struct usb_serial_port *port, __u8 rxtx);
259 static int firm_get_dtr_rts(struct usb_serial_port *port);
260 static int firm_report_tx_done(struct usb_serial_port *port);
263 #define COMMAND_PORT 4
264 #define COMMAND_TIMEOUT (2*HZ) /* 2 second timeout for a command */
265 #define COMMAND_TIMEOUT_MS 2000
266 #define CLOSING_DELAY (30 * HZ)
269 /*****************************************************************************
270 * Connect Tech's White Heat prerenumeration driver functions
271 *****************************************************************************/
273 /* steps to download the firmware to the WhiteHEAT device:
274 - hold the reset (by writing to the reset bit of the CPUCS register)
275 - download the VEND_AX.HEX file to the chip using VENDOR_REQUEST-ANCHOR_LOAD
276 - release the reset (by writing to the CPUCS register)
277 - download the WH.HEX file for all addresses greater than 0x1b3f using
278 VENDOR_REQUEST-ANCHOR_EXTERNAL_RAM_LOAD
280 - download the WH.HEX file for all addresses less than 0x1b40 using
281 VENDOR_REQUEST_ANCHOR_LOAD
283 - device renumerated itself and comes up as new device id with all
284 firmware download completed.
286 static int whiteheat_firmware_download (struct usb_serial *serial, const struct usb_device_id *id)
289 const struct whiteheat_hex_record *record;
291 dbg("%s", __FUNCTION__);
293 response = ezusb_set_reset (serial, 1);
295 record = &whiteheat_loader[0];
296 while (record->address != 0xffff) {
297 response = ezusb_writememory (serial, record->address,
298 (unsigned char *)record->data, record->data_size, 0xa0);
300 err("%s - ezusb_writememory failed for loader (%d %04X %p %d)",
301 __FUNCTION__, response, record->address, record->data, record->data_size);
307 response = ezusb_set_reset (serial, 0);
309 record = &whiteheat_firmware[0];
310 while (record->address < 0x1b40) {
313 while (record->address != 0xffff) {
314 response = ezusb_writememory (serial, record->address,
315 (unsigned char *)record->data, record->data_size, 0xa3);
317 err("%s - ezusb_writememory failed for first firmware step (%d %04X %p %d)",
318 __FUNCTION__, response, record->address, record->data, record->data_size);
324 response = ezusb_set_reset (serial, 1);
326 record = &whiteheat_firmware[0];
327 while (record->address < 0x1b40) {
328 response = ezusb_writememory (serial, record->address,
329 (unsigned char *)record->data, record->data_size, 0xa0);
331 err("%s - ezusb_writememory failed for second firmware step (%d %04X %p %d)",
332 __FUNCTION__, response, record->address, record->data, record->data_size);
338 response = ezusb_set_reset (serial, 0);
344 static int whiteheat_firmware_attach (struct usb_serial *serial)
346 /* We want this device to fail to have a driver assigned to it */
351 /*****************************************************************************
352 * Connect Tech's White Heat serial driver functions
353 *****************************************************************************/
354 static int whiteheat_attach (struct usb_serial *serial)
356 struct usb_serial_port *command_port;
357 struct whiteheat_command_private *command_info;
358 struct usb_serial_port *port;
359 struct whiteheat_private *info;
360 struct whiteheat_hw_info *hw_info;
370 struct whiteheat_urb_wrap *wrap;
371 struct list_head *tmp;
373 command_port = serial->port[COMMAND_PORT];
375 pipe = usb_sndbulkpipe (serial->dev, command_port->bulk_out_endpointAddress);
376 command = kmalloc(2, GFP_KERNEL);
378 goto no_command_buffer;
379 command[0] = WHITEHEAT_GET_HW_INFO;
382 result = kmalloc(sizeof(*hw_info) + 1, GFP_KERNEL);
384 goto no_result_buffer;
386 * When the module is reloaded the firmware is still there and
387 * the endpoints are still in the usb core unchanged. This is the
388 * unlinking bug in disguise. Same for the call below.
390 usb_clear_halt(serial->dev, pipe);
391 ret = usb_bulk_msg (serial->dev, pipe, command, 2, &alen, COMMAND_TIMEOUT_MS);
393 err("%s: Couldn't send command [%d]", serial->type->description, ret);
395 } else if (alen != 2) {
396 err("%s: Send command incomplete [%d]", serial->type->description, alen);
400 pipe = usb_rcvbulkpipe (serial->dev, command_port->bulk_in_endpointAddress);
401 /* See the comment on the usb_clear_halt() above */
402 usb_clear_halt(serial->dev, pipe);
403 ret = usb_bulk_msg (serial->dev, pipe, result, sizeof(*hw_info) + 1, &alen, COMMAND_TIMEOUT_MS);
405 err("%s: Couldn't get results [%d]", serial->type->description, ret);
407 } else if (alen != sizeof(*hw_info) + 1) {
408 err("%s: Get results incomplete [%d]", serial->type->description, alen);
410 } else if (result[0] != command[0]) {
411 err("%s: Command failed [%d]", serial->type->description, result[0]);
415 hw_info = (struct whiteheat_hw_info *)&result[1];
417 info("%s: Driver %s: Firmware v%d.%02d", serial->type->description,
418 DRIVER_VERSION, hw_info->sw_major_rev, hw_info->sw_minor_rev);
420 for (i = 0; i < serial->num_ports; i++) {
421 port = serial->port[i];
423 info = kmalloc(sizeof(struct whiteheat_private), GFP_KERNEL);
425 err("%s: Out of memory for port structures\n", serial->type->description);
429 spin_lock_init(&info->lock);
430 mutex_init(&info->deathwarrant);
433 INIT_WORK(&info->rx_work, rx_data_softint);
436 INIT_LIST_HEAD(&info->rx_urbs_free);
437 INIT_LIST_HEAD(&info->rx_urbs_submitted);
438 INIT_LIST_HEAD(&info->rx_urb_q);
439 INIT_LIST_HEAD(&info->tx_urbs_free);
440 INIT_LIST_HEAD(&info->tx_urbs_submitted);
442 for (j = 0; j < urb_pool_size; j++) {
443 urb = usb_alloc_urb(0, GFP_KERNEL);
445 err("No free urbs available");
448 buf_size = port->read_urb->transfer_buffer_length;
449 urb->transfer_buffer = kmalloc(buf_size, GFP_KERNEL);
450 if (!urb->transfer_buffer) {
451 err("Couldn't allocate urb buffer");
454 wrap = kmalloc(sizeof(*wrap), GFP_KERNEL);
456 err("Couldn't allocate urb wrapper");
459 usb_fill_bulk_urb(urb, serial->dev,
460 usb_rcvbulkpipe(serial->dev,
461 port->bulk_in_endpointAddress),
462 urb->transfer_buffer, buf_size,
463 whiteheat_read_callback, port);
465 list_add(&wrap->list, &info->rx_urbs_free);
467 urb = usb_alloc_urb(0, GFP_KERNEL);
469 err("No free urbs available");
472 buf_size = port->write_urb->transfer_buffer_length;
473 urb->transfer_buffer = kmalloc(buf_size, GFP_KERNEL);
474 if (!urb->transfer_buffer) {
475 err("Couldn't allocate urb buffer");
478 wrap = kmalloc(sizeof(*wrap), GFP_KERNEL);
480 err("Couldn't allocate urb wrapper");
483 usb_fill_bulk_urb(urb, serial->dev,
484 usb_sndbulkpipe(serial->dev,
485 port->bulk_out_endpointAddress),
486 urb->transfer_buffer, buf_size,
487 whiteheat_write_callback, port);
489 list_add(&wrap->list, &info->tx_urbs_free);
492 usb_set_serial_port_data(port, info);
495 command_info = kmalloc(sizeof(struct whiteheat_command_private), GFP_KERNEL);
496 if (command_info == NULL) {
497 err("%s: Out of memory for port structures\n", serial->type->description);
498 goto no_command_private;
501 mutex_init(&command_info->mutex);
502 command_info->port_running = 0;
503 init_waitqueue_head(&command_info->wait_command);
504 usb_set_serial_port_data(command_port, command_info);
505 command_port->write_urb->complete = command_port_write_callback;
506 command_port->read_urb->complete = command_port_read_callback;
513 /* Firmware likely not running */
514 err("%s: Unable to retrieve firmware version, try replugging\n", serial->type->description);
515 err("%s: If the firmware is not running (status led not blinking)\n", serial->type->description);
516 err("%s: please contact support@connecttech.com\n", serial->type->description);
521 for (i = serial->num_ports - 1; i >= 0; i--) {
522 port = serial->port[i];
523 info = usb_get_serial_port_data(port);
524 for (j = urb_pool_size - 1; j >= 0; j--) {
525 tmp = list_first(&info->tx_urbs_free);
527 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
531 kfree(urb->transfer_buffer);
535 tmp = list_first(&info->rx_urbs_free);
537 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
541 kfree(urb->transfer_buffer);
559 static void whiteheat_shutdown (struct usb_serial *serial)
561 struct usb_serial_port *command_port;
562 struct usb_serial_port *port;
563 struct whiteheat_private *info;
564 struct whiteheat_urb_wrap *wrap;
566 struct list_head *tmp;
567 struct list_head *tmp2;
570 dbg("%s", __FUNCTION__);
572 /* free up our private data for our command port */
573 command_port = serial->port[COMMAND_PORT];
574 kfree (usb_get_serial_port_data(command_port));
576 for (i = 0; i < serial->num_ports; i++) {
577 port = serial->port[i];
578 info = usb_get_serial_port_data(port);
579 list_for_each_safe(tmp, tmp2, &info->rx_urbs_free) {
581 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
584 kfree(urb->transfer_buffer);
587 list_for_each_safe(tmp, tmp2, &info->tx_urbs_free) {
589 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
592 kfree(urb->transfer_buffer);
602 static int whiteheat_open (struct usb_serial_port *port, struct file *filp)
605 struct ktermios old_term;
607 dbg("%s - port %d", __FUNCTION__, port->number);
609 retval = start_command_port(port->serial);
614 port->tty->low_latency = 1;
616 /* send an open port command */
617 retval = firm_open(port);
619 stop_command_port(port->serial);
623 retval = firm_purge(port, WHITEHEAT_PURGE_RX | WHITEHEAT_PURGE_TX);
626 stop_command_port(port->serial);
630 old_term.c_cflag = ~port->tty->termios->c_cflag;
631 old_term.c_iflag = ~port->tty->termios->c_iflag;
632 whiteheat_set_termios(port, &old_term);
634 /* Work around HCD bugs */
635 usb_clear_halt(port->serial->dev, port->read_urb->pipe);
636 usb_clear_halt(port->serial->dev, port->write_urb->pipe);
638 /* Start reading from the device */
639 retval = start_port_read(port);
641 err("%s - failed submitting read urb, error %d", __FUNCTION__, retval);
643 stop_command_port(port->serial);
648 dbg("%s - exit, retval = %d", __FUNCTION__, retval);
653 static void whiteheat_close(struct usb_serial_port *port, struct file * filp)
655 struct whiteheat_private *info = usb_get_serial_port_data(port);
656 struct whiteheat_urb_wrap *wrap;
658 struct list_head *tmp;
659 struct list_head *tmp2;
661 dbg("%s - port %d", __FUNCTION__, port->number);
663 /* filp is NULL when called from usb_serial_disconnect */
664 if (filp && (tty_hung_up_p(filp))) {
668 port->tty->closing = 1;
671 * Not currently in use; tty_wait_until_sent() calls
672 * serial_chars_in_buffer() which deadlocks on the second semaphore
673 * acquisition. This should be fixed at some point. Greg's been
675 if ((filp->f_flags & (O_NDELAY | O_NONBLOCK)) == 0) {
676 tty_wait_until_sent(port->tty, CLOSING_DELAY);
680 if (port->tty->driver->flush_buffer)
681 port->tty->driver->flush_buffer(port->tty);
682 tty_ldisc_flush(port->tty);
684 firm_report_tx_done(port);
688 printk(KERN_ERR"Before processing rx_urbs_submitted.\n");
689 /* shutdown our bulk reads and writes */
690 mutex_lock(&info->deathwarrant);
691 spin_lock_irq(&info->lock);
692 list_for_each_safe(tmp, tmp2, &info->rx_urbs_submitted) {
693 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
696 spin_unlock_irq(&info->lock);
698 spin_lock_irq(&info->lock);
699 list_add(tmp, &info->rx_urbs_free);
701 list_for_each_safe(tmp, tmp2, &info->rx_urb_q)
702 list_move(tmp, &info->rx_urbs_free);
703 list_for_each_safe(tmp, tmp2, &info->tx_urbs_submitted) {
704 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
707 spin_unlock_irq(&info->lock);
709 spin_lock_irq(&info->lock);
710 list_add(tmp, &info->tx_urbs_free);
712 spin_unlock_irq(&info->lock);
713 mutex_unlock(&info->deathwarrant);
715 stop_command_port(port->serial);
717 port->tty->closing = 0;
721 static int whiteheat_write(struct usb_serial_port *port, const unsigned char *buf, int count)
723 struct usb_serial *serial = port->serial;
724 struct whiteheat_private *info = usb_get_serial_port_data(port);
725 struct whiteheat_urb_wrap *wrap;
731 struct list_head *tmp;
733 dbg("%s - port %d", __FUNCTION__, port->number);
736 dbg("%s - write request of 0 bytes", __FUNCTION__);
741 spin_lock_irqsave(&info->lock, flags);
742 if (list_empty(&info->tx_urbs_free)) {
743 spin_unlock_irqrestore(&info->lock, flags);
746 tmp = list_first(&info->tx_urbs_free);
748 spin_unlock_irqrestore(&info->lock, flags);
750 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
752 bytes = (count > port->bulk_out_size) ? port->bulk_out_size : count;
753 memcpy (urb->transfer_buffer, buf + sent, bytes);
755 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, bytes, urb->transfer_buffer);
757 urb->dev = serial->dev;
758 urb->transfer_buffer_length = bytes;
759 result = usb_submit_urb(urb, GFP_ATOMIC);
761 err("%s - failed submitting write urb, error %d", __FUNCTION__, result);
763 spin_lock_irqsave(&info->lock, flags);
764 list_add(tmp, &info->tx_urbs_free);
765 spin_unlock_irqrestore(&info->lock, flags);
770 spin_lock_irqsave(&info->lock, flags);
771 list_add(tmp, &info->tx_urbs_submitted);
772 spin_unlock_irqrestore(&info->lock, flags);
780 static int whiteheat_write_room(struct usb_serial_port *port)
782 struct whiteheat_private *info = usb_get_serial_port_data(port);
783 struct list_head *tmp;
787 dbg("%s - port %d", __FUNCTION__, port->number);
789 spin_lock_irqsave(&info->lock, flags);
790 list_for_each(tmp, &info->tx_urbs_free)
792 spin_unlock_irqrestore(&info->lock, flags);
793 room *= port->bulk_out_size;
795 dbg("%s - returns %d", __FUNCTION__, room);
800 static int whiteheat_tiocmget (struct usb_serial_port *port, struct file *file)
802 struct whiteheat_private *info = usb_get_serial_port_data(port);
803 unsigned int modem_signals = 0;
805 dbg("%s - port %d", __FUNCTION__, port->number);
807 firm_get_dtr_rts(port);
808 if (info->mcr & UART_MCR_DTR)
809 modem_signals |= TIOCM_DTR;
810 if (info->mcr & UART_MCR_RTS)
811 modem_signals |= TIOCM_RTS;
813 return modem_signals;
817 static int whiteheat_tiocmset (struct usb_serial_port *port, struct file *file,
818 unsigned int set, unsigned int clear)
820 struct whiteheat_private *info = usb_get_serial_port_data(port);
822 dbg("%s - port %d", __FUNCTION__, port->number);
825 info->mcr |= UART_MCR_RTS;
827 info->mcr |= UART_MCR_DTR;
829 if (clear & TIOCM_RTS)
830 info->mcr &= ~UART_MCR_RTS;
831 if (clear & TIOCM_DTR)
832 info->mcr &= ~UART_MCR_DTR;
834 firm_set_dtr(port, info->mcr & UART_MCR_DTR);
835 firm_set_rts(port, info->mcr & UART_MCR_RTS);
840 static int whiteheat_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
842 struct serial_struct serstruct;
843 void __user *user_arg = (void __user *)arg;
845 dbg("%s - port %d, cmd 0x%.4x", __FUNCTION__, port->number, cmd);
849 memset(&serstruct, 0, sizeof(serstruct));
850 serstruct.type = PORT_16654;
851 serstruct.line = port->serial->minor;
852 serstruct.port = port->number;
853 serstruct.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
854 serstruct.xmit_fifo_size = port->bulk_out_size;
855 serstruct.custom_divisor = 0;
856 serstruct.baud_base = 460800;
857 serstruct.close_delay = CLOSING_DELAY;
858 serstruct.closing_wait = CLOSING_DELAY;
860 if (copy_to_user(user_arg, &serstruct, sizeof(serstruct)))
866 if (copy_from_user(&serstruct, user_arg, sizeof(serstruct)))
870 * For now this is ignored. dip sets the ASYNC_[V]HI flags
871 * but this isn't used by us at all. Maybe someone somewhere
872 * will need the custom_divisor setting.
885 static void whiteheat_set_termios(struct usb_serial_port *port, struct ktermios *old_termios)
887 dbg("%s -port %d", __FUNCTION__, port->number);
889 if ((!port->tty) || (!port->tty->termios)) {
890 dbg("%s - no tty structures", __FUNCTION__);
894 /* check that they really want us to change something */
896 if ((port->tty->termios->c_cflag == old_termios->c_cflag) &&
897 (port->tty->termios->c_iflag == old_termios->c_iflag)) {
898 dbg("%s - nothing to change...", __FUNCTION__);
903 firm_setup_port(port);
910 static void whiteheat_break_ctl(struct usb_serial_port *port, int break_state) {
911 firm_set_break(port, break_state);
915 static int whiteheat_chars_in_buffer(struct usb_serial_port *port)
917 struct whiteheat_private *info = usb_get_serial_port_data(port);
918 struct list_head *tmp;
919 struct whiteheat_urb_wrap *wrap;
923 dbg("%s - port %d", __FUNCTION__, port->number);
925 spin_lock_irqsave(&info->lock, flags);
926 list_for_each(tmp, &info->tx_urbs_submitted) {
927 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
928 chars += wrap->urb->transfer_buffer_length;
930 spin_unlock_irqrestore(&info->lock, flags);
932 dbg ("%s - returns %d", __FUNCTION__, chars);
937 static void whiteheat_throttle (struct usb_serial_port *port)
939 struct whiteheat_private *info = usb_get_serial_port_data(port);
942 dbg("%s - port %d", __FUNCTION__, port->number);
944 spin_lock_irqsave(&info->lock, flags);
945 info->flags |= THROTTLED;
946 spin_unlock_irqrestore(&info->lock, flags);
952 static void whiteheat_unthrottle (struct usb_serial_port *port)
954 struct whiteheat_private *info = usb_get_serial_port_data(port);
955 int actually_throttled;
958 dbg("%s - port %d", __FUNCTION__, port->number);
960 spin_lock_irqsave(&info->lock, flags);
961 actually_throttled = info->flags & ACTUALLY_THROTTLED;
962 info->flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
963 spin_unlock_irqrestore(&info->lock, flags);
965 if (actually_throttled)
966 rx_data_softint(&info->rx_work);
972 /*****************************************************************************
973 * Connect Tech's White Heat callback routines
974 *****************************************************************************/
975 static void command_port_write_callback(struct urb *urb)
977 int status = urb->status;
979 dbg("%s", __FUNCTION__);
982 dbg("nonzero urb status: %d", status);
988 static void command_port_read_callback(struct urb *urb)
990 struct usb_serial_port *command_port = (struct usb_serial_port *)urb->context;
991 struct whiteheat_command_private *command_info;
992 int status = urb->status;
993 unsigned char *data = urb->transfer_buffer;
996 dbg("%s", __FUNCTION__);
998 command_info = usb_get_serial_port_data(command_port);
1000 dbg ("%s - command_info is NULL, exiting.", __FUNCTION__);
1004 dbg("%s - nonzero urb status: %d", __FUNCTION__, status);
1005 if (status != -ENOENT)
1006 command_info->command_finished = WHITEHEAT_CMD_FAILURE;
1007 wake_up(&command_info->wait_command);
1011 usb_serial_debug_data(debug, &command_port->dev, __FUNCTION__, urb->actual_length, data);
1013 if (data[0] == WHITEHEAT_CMD_COMPLETE) {
1014 command_info->command_finished = WHITEHEAT_CMD_COMPLETE;
1015 wake_up(&command_info->wait_command);
1016 } else if (data[0] == WHITEHEAT_CMD_FAILURE) {
1017 command_info->command_finished = WHITEHEAT_CMD_FAILURE;
1018 wake_up(&command_info->wait_command);
1019 } else if (data[0] == WHITEHEAT_EVENT) {
1020 /* These are unsolicited reports from the firmware, hence no waiting command to wakeup */
1021 dbg("%s - event received", __FUNCTION__);
1022 } else if (data[0] == WHITEHEAT_GET_DTR_RTS) {
1023 memcpy(command_info->result_buffer, &data[1], urb->actual_length - 1);
1024 command_info->command_finished = WHITEHEAT_CMD_COMPLETE;
1025 wake_up(&command_info->wait_command);
1027 dbg("%s - bad reply from firmware", __FUNCTION__);
1030 /* Continue trying to always read */
1031 command_port->read_urb->dev = command_port->serial->dev;
1032 result = usb_submit_urb(command_port->read_urb, GFP_ATOMIC);
1034 dbg("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1038 static void whiteheat_read_callback(struct urb *urb)
1040 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1041 struct whiteheat_urb_wrap *wrap;
1042 unsigned char *data = urb->transfer_buffer;
1043 struct whiteheat_private *info = usb_get_serial_port_data(port);
1044 int status = urb->status;
1046 dbg("%s - port %d", __FUNCTION__, port->number);
1048 spin_lock(&info->lock);
1049 wrap = urb_to_wrap(urb, &info->rx_urbs_submitted);
1051 spin_unlock(&info->lock);
1052 err("%s - Not my urb!", __FUNCTION__);
1055 list_del(&wrap->list);
1056 spin_unlock(&info->lock);
1059 dbg("%s - nonzero read bulk status received: %d",
1060 __FUNCTION__, status);
1061 spin_lock(&info->lock);
1062 list_add(&wrap->list, &info->rx_urbs_free);
1063 spin_unlock(&info->lock);
1067 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
1069 spin_lock(&info->lock);
1070 list_add_tail(&wrap->list, &info->rx_urb_q);
1071 if (info->flags & THROTTLED) {
1072 info->flags |= ACTUALLY_THROTTLED;
1073 spin_unlock(&info->lock);
1076 spin_unlock(&info->lock);
1078 schedule_work(&info->rx_work);
1082 static void whiteheat_write_callback(struct urb *urb)
1084 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1085 struct whiteheat_private *info = usb_get_serial_port_data(port);
1086 struct whiteheat_urb_wrap *wrap;
1087 int status = urb->status;
1089 dbg("%s - port %d", __FUNCTION__, port->number);
1091 spin_lock(&info->lock);
1092 wrap = urb_to_wrap(urb, &info->tx_urbs_submitted);
1094 spin_unlock(&info->lock);
1095 err("%s - Not my urb!", __FUNCTION__);
1098 list_move(&wrap->list, &info->tx_urbs_free);
1099 spin_unlock(&info->lock);
1102 dbg("%s - nonzero write bulk status received: %d",
1103 __FUNCTION__, status);
1107 usb_serial_port_softint(port);
1111 /*****************************************************************************
1112 * Connect Tech's White Heat firmware interface
1113 *****************************************************************************/
1114 static int firm_send_command(struct usb_serial_port *port, __u8 command, __u8 *data, __u8 datasize)
1116 struct usb_serial_port *command_port;
1117 struct whiteheat_command_private *command_info;
1118 struct whiteheat_private *info;
1119 __u8 *transfer_buffer;
1123 dbg("%s - command %d", __FUNCTION__, command);
1125 command_port = port->serial->port[COMMAND_PORT];
1126 command_info = usb_get_serial_port_data(command_port);
1127 mutex_lock(&command_info->mutex);
1128 command_info->command_finished = false;
1130 transfer_buffer = (__u8 *)command_port->write_urb->transfer_buffer;
1131 transfer_buffer[0] = command;
1132 memcpy (&transfer_buffer[1], data, datasize);
1133 command_port->write_urb->transfer_buffer_length = datasize + 1;
1134 command_port->write_urb->dev = port->serial->dev;
1135 retval = usb_submit_urb (command_port->write_urb, GFP_NOIO);
1137 dbg("%s - submit urb failed", __FUNCTION__);
1141 /* wait for the command to complete */
1142 t = wait_event_timeout(command_info->wait_command,
1143 (bool)command_info->command_finished, COMMAND_TIMEOUT);
1145 usb_kill_urb(command_port->write_urb);
1147 if (command_info->command_finished == false) {
1148 dbg("%s - command timed out.", __FUNCTION__);
1149 retval = -ETIMEDOUT;
1153 if (command_info->command_finished == WHITEHEAT_CMD_FAILURE) {
1154 dbg("%s - command failed.", __FUNCTION__);
1159 if (command_info->command_finished == WHITEHEAT_CMD_COMPLETE) {
1160 dbg("%s - command completed.", __FUNCTION__);
1162 case WHITEHEAT_GET_DTR_RTS:
1163 info = usb_get_serial_port_data(port);
1164 memcpy(&info->mcr, command_info->result_buffer, sizeof(struct whiteheat_dr_info));
1170 mutex_unlock(&command_info->mutex);
1175 static int firm_open(struct usb_serial_port *port) {
1176 struct whiteheat_simple open_command;
1178 open_command.port = port->number - port->serial->minor + 1;
1179 return firm_send_command(port, WHITEHEAT_OPEN, (__u8 *)&open_command, sizeof(open_command));
1183 static int firm_close(struct usb_serial_port *port) {
1184 struct whiteheat_simple close_command;
1186 close_command.port = port->number - port->serial->minor + 1;
1187 return firm_send_command(port, WHITEHEAT_CLOSE, (__u8 *)&close_command, sizeof(close_command));
1191 static int firm_setup_port(struct usb_serial_port *port) {
1192 struct whiteheat_port_settings port_settings;
1193 unsigned int cflag = port->tty->termios->c_cflag;
1195 port_settings.port = port->number + 1;
1197 /* get the byte size */
1198 switch (cflag & CSIZE) {
1199 case CS5: port_settings.bits = 5; break;
1200 case CS6: port_settings.bits = 6; break;
1201 case CS7: port_settings.bits = 7; break;
1203 case CS8: port_settings.bits = 8; break;
1205 dbg("%s - data bits = %d", __FUNCTION__, port_settings.bits);
1207 /* determine the parity */
1211 port_settings.parity = WHITEHEAT_PAR_MARK;
1213 port_settings.parity = WHITEHEAT_PAR_SPACE;
1216 port_settings.parity = WHITEHEAT_PAR_ODD;
1218 port_settings.parity = WHITEHEAT_PAR_EVEN;
1220 port_settings.parity = WHITEHEAT_PAR_NONE;
1221 dbg("%s - parity = %c", __FUNCTION__, port_settings.parity);
1223 /* figure out the stop bits requested */
1225 port_settings.stop = 2;
1227 port_settings.stop = 1;
1228 dbg("%s - stop bits = %d", __FUNCTION__, port_settings.stop);
1230 /* figure out the flow control settings */
1231 if (cflag & CRTSCTS)
1232 port_settings.hflow = (WHITEHEAT_HFLOW_CTS | WHITEHEAT_HFLOW_RTS);
1234 port_settings.hflow = WHITEHEAT_HFLOW_NONE;
1235 dbg("%s - hardware flow control = %s %s %s %s", __FUNCTION__,
1236 (port_settings.hflow & WHITEHEAT_HFLOW_CTS) ? "CTS" : "",
1237 (port_settings.hflow & WHITEHEAT_HFLOW_RTS) ? "RTS" : "",
1238 (port_settings.hflow & WHITEHEAT_HFLOW_DSR) ? "DSR" : "",
1239 (port_settings.hflow & WHITEHEAT_HFLOW_DTR) ? "DTR" : "");
1241 /* determine software flow control */
1242 if (I_IXOFF(port->tty))
1243 port_settings.sflow = WHITEHEAT_SFLOW_RXTX;
1245 port_settings.sflow = WHITEHEAT_SFLOW_NONE;
1246 dbg("%s - software flow control = %c", __FUNCTION__, port_settings.sflow);
1248 port_settings.xon = START_CHAR(port->tty);
1249 port_settings.xoff = STOP_CHAR(port->tty);
1250 dbg("%s - XON = %2x, XOFF = %2x", __FUNCTION__, port_settings.xon, port_settings.xoff);
1252 /* get the baud rate wanted */
1253 port_settings.baud = tty_get_baud_rate(port->tty);
1254 dbg("%s - baud rate = %d", __FUNCTION__, port_settings.baud);
1256 /* handle any settings that aren't specified in the tty structure */
1257 port_settings.lloop = 0;
1259 /* now send the message to the device */
1260 return firm_send_command(port, WHITEHEAT_SETUP_PORT, (__u8 *)&port_settings, sizeof(port_settings));
1264 static int firm_set_rts(struct usb_serial_port *port, __u8 onoff) {
1265 struct whiteheat_set_rdb rts_command;
1267 rts_command.port = port->number - port->serial->minor + 1;
1268 rts_command.state = onoff;
1269 return firm_send_command(port, WHITEHEAT_SET_RTS, (__u8 *)&rts_command, sizeof(rts_command));
1273 static int firm_set_dtr(struct usb_serial_port *port, __u8 onoff) {
1274 struct whiteheat_set_rdb dtr_command;
1276 dtr_command.port = port->number - port->serial->minor + 1;
1277 dtr_command.state = onoff;
1278 return firm_send_command(port, WHITEHEAT_SET_RTS, (__u8 *)&dtr_command, sizeof(dtr_command));
1282 static int firm_set_break(struct usb_serial_port *port, __u8 onoff) {
1283 struct whiteheat_set_rdb break_command;
1285 break_command.port = port->number - port->serial->minor + 1;
1286 break_command.state = onoff;
1287 return firm_send_command(port, WHITEHEAT_SET_RTS, (__u8 *)&break_command, sizeof(break_command));
1291 static int firm_purge(struct usb_serial_port *port, __u8 rxtx) {
1292 struct whiteheat_purge purge_command;
1294 purge_command.port = port->number - port->serial->minor + 1;
1295 purge_command.what = rxtx;
1296 return firm_send_command(port, WHITEHEAT_PURGE, (__u8 *)&purge_command, sizeof(purge_command));
1300 static int firm_get_dtr_rts(struct usb_serial_port *port) {
1301 struct whiteheat_simple get_dr_command;
1303 get_dr_command.port = port->number - port->serial->minor + 1;
1304 return firm_send_command(port, WHITEHEAT_GET_DTR_RTS, (__u8 *)&get_dr_command, sizeof(get_dr_command));
1308 static int firm_report_tx_done(struct usb_serial_port *port) {
1309 struct whiteheat_simple close_command;
1311 close_command.port = port->number - port->serial->minor + 1;
1312 return firm_send_command(port, WHITEHEAT_REPORT_TX_DONE, (__u8 *)&close_command, sizeof(close_command));
1316 /*****************************************************************************
1317 * Connect Tech's White Heat utility functions
1318 *****************************************************************************/
1319 static int start_command_port(struct usb_serial *serial)
1321 struct usb_serial_port *command_port;
1322 struct whiteheat_command_private *command_info;
1325 command_port = serial->port[COMMAND_PORT];
1326 command_info = usb_get_serial_port_data(command_port);
1327 mutex_lock(&command_info->mutex);
1328 if (!command_info->port_running) {
1329 /* Work around HCD bugs */
1330 usb_clear_halt(serial->dev, command_port->read_urb->pipe);
1332 command_port->read_urb->dev = serial->dev;
1333 retval = usb_submit_urb(command_port->read_urb, GFP_KERNEL);
1335 err("%s - failed submitting read urb, error %d", __FUNCTION__, retval);
1339 command_info->port_running++;
1342 mutex_unlock(&command_info->mutex);
1347 static void stop_command_port(struct usb_serial *serial)
1349 struct usb_serial_port *command_port;
1350 struct whiteheat_command_private *command_info;
1352 command_port = serial->port[COMMAND_PORT];
1353 command_info = usb_get_serial_port_data(command_port);
1354 mutex_lock(&command_info->mutex);
1355 command_info->port_running--;
1356 if (!command_info->port_running)
1357 usb_kill_urb(command_port->read_urb);
1358 mutex_unlock(&command_info->mutex);
1362 static int start_port_read(struct usb_serial_port *port)
1364 struct whiteheat_private *info = usb_get_serial_port_data(port);
1365 struct whiteheat_urb_wrap *wrap;
1368 unsigned long flags;
1369 struct list_head *tmp;
1370 struct list_head *tmp2;
1372 spin_lock_irqsave(&info->lock, flags);
1374 list_for_each_safe(tmp, tmp2, &info->rx_urbs_free) {
1376 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1378 urb->dev = port->serial->dev;
1379 spin_unlock_irqrestore(&info->lock, flags);
1380 retval = usb_submit_urb(urb, GFP_KERNEL);
1382 spin_lock_irqsave(&info->lock, flags);
1383 list_add(tmp, &info->rx_urbs_free);
1384 list_for_each_safe(tmp, tmp2, &info->rx_urbs_submitted) {
1385 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1388 spin_unlock_irqrestore(&info->lock, flags);
1390 spin_lock_irqsave(&info->lock, flags);
1391 list_add(tmp, &info->rx_urbs_free);
1395 spin_lock_irqsave(&info->lock, flags);
1396 list_add(tmp, &info->rx_urbs_submitted);
1399 spin_unlock_irqrestore(&info->lock, flags);
1405 static struct whiteheat_urb_wrap *urb_to_wrap(struct urb* urb, struct list_head *head)
1407 struct whiteheat_urb_wrap *wrap;
1408 struct list_head *tmp;
1410 list_for_each(tmp, head) {
1411 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1412 if (wrap->urb == urb)
1420 static struct list_head *list_first(struct list_head *head)
1426 static void rx_data_softint(struct work_struct *work)
1428 struct whiteheat_private *info =
1429 container_of(work, struct whiteheat_private, rx_work);
1430 struct usb_serial_port *port = info->port;
1431 struct tty_struct *tty = port->tty;
1432 struct whiteheat_urb_wrap *wrap;
1434 unsigned long flags;
1435 struct list_head *tmp;
1436 struct list_head *tmp2;
1440 spin_lock_irqsave(&info->lock, flags);
1441 if (info->flags & THROTTLED) {
1442 spin_unlock_irqrestore(&info->lock, flags);
1446 list_for_each_safe(tmp, tmp2, &info->rx_urb_q) {
1448 spin_unlock_irqrestore(&info->lock, flags);
1450 wrap = list_entry(tmp, struct whiteheat_urb_wrap, list);
1453 if (tty && urb->actual_length) {
1454 int len = tty_buffer_request_room(tty, urb->actual_length);
1455 /* This stuff can go away now I suspect */
1456 if (unlikely(len < urb->actual_length)) {
1457 spin_lock_irqsave(&info->lock, flags);
1458 list_add(tmp, &info->rx_urb_q);
1459 spin_unlock_irqrestore(&info->lock, flags);
1460 tty_flip_buffer_push(tty);
1461 schedule_work(&info->rx_work);
1464 tty_insert_flip_string(tty, urb->transfer_buffer, len);
1468 urb->dev = port->serial->dev;
1469 result = usb_submit_urb(urb, GFP_ATOMIC);
1471 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
1472 spin_lock_irqsave(&info->lock, flags);
1473 list_add(tmp, &info->rx_urbs_free);
1477 spin_lock_irqsave(&info->lock, flags);
1478 list_add(tmp, &info->rx_urbs_submitted);
1480 spin_unlock_irqrestore(&info->lock, flags);
1483 tty_flip_buffer_push(tty);
1487 /*****************************************************************************
1488 * Connect Tech's White Heat module functions
1489 *****************************************************************************/
1490 static int __init whiteheat_init (void)
1493 retval = usb_serial_register(&whiteheat_fake_device);
1495 goto failed_fake_register;
1496 retval = usb_serial_register(&whiteheat_device);
1498 goto failed_device_register;
1499 retval = usb_register(&whiteheat_driver);
1501 goto failed_usb_register;
1502 info(DRIVER_DESC " " DRIVER_VERSION);
1504 failed_usb_register:
1505 usb_serial_deregister(&whiteheat_device);
1506 failed_device_register:
1507 usb_serial_deregister(&whiteheat_fake_device);
1508 failed_fake_register:
1513 static void __exit whiteheat_exit (void)
1515 usb_deregister (&whiteheat_driver);
1516 usb_serial_deregister (&whiteheat_fake_device);
1517 usb_serial_deregister (&whiteheat_device);
1521 module_init(whiteheat_init);
1522 module_exit(whiteheat_exit);
1524 MODULE_AUTHOR( DRIVER_AUTHOR );
1525 MODULE_DESCRIPTION( DRIVER_DESC );
1526 MODULE_LICENSE("GPL");
1528 module_param(urb_pool_size, int, 0);
1529 MODULE_PARM_DESC(urb_pool_size, "Number of urbs to use for buffering");
1531 module_param(debug, bool, S_IRUGO | S_IWUSR);
1532 MODULE_PARM_DESC(debug, "Debug enabled or not");