2 * LEGO USB Tower driver
4 * Copyright (C) 2003 David Glance <davidgsf@sourceforge.net>
5 * 2001-2004 Juergen Stuber <starblue@users.sourceforge.net>
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License as
9 * published by the Free Software Foundation; either version 2 of
10 * the License, or (at your option) any later version.
12 * derived from USB Skeleton driver - 0.5
13 * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
20 * - simplified buffering, one-shot URBs for writing
22 * - removed IOCTL (setting power/mode is more complicated, postponed)
24 * - added vendor commands for mode of operation and power level in open
26 * - set IR mode by default (by oversight 0.4 set VLL mode)
27 * 2002-01-11 - 0.5? pcchan
28 * - make read buffer reusable and work around bytes_to_write issue between
29 * uhci and legusbtower
30 * 2002-09-23 - 0.52 david (david@csse.uwa.edu.au)
31 * - imported into lejos project
32 * - changed wake_up to wake_up_interruptible
33 * - changed to use lego0 rather than tower0
34 * - changed dbg() to use __func__ rather than deprecated __FUNCTION__
35 * 2003-01-12 - 0.53 david (david@csse.uwa.edu.au)
36 * - changed read and write to write everything or
37 * timeout (from a patch by Chris Riesen and Brett Thaeler driver)
38 * - added ioctl functionality to set timeouts
39 * 2003-07-18 - 0.54 davidgsf (david@csse.uwa.edu.au)
40 * - initial import into LegoUSB project
41 * - merge of existing LegoUSB.c driver
42 * 2003-07-18 - 0.56 davidgsf (david@csse.uwa.edu.au)
43 * - port to 2.6 style driver
44 * 2004-02-29 - 0.6 Juergen Stuber <starblue@users.sourceforge.net>
46 * - unlink read URBs which are no longer needed
47 * - allow increased buffer size, eliminates need for timeout on write
48 * - have read URB running continuously
51 * - added nonblocking I/O
52 * - changed back __func__ to __FUNCTION__
53 * - read and log tower firmware version
54 * - reset tower on probe, avoids failure of first write
55 * 2004-03-09 - 0.7 Juergen Stuber <starblue@users.sourceforge.net>
56 * - timeout read now only after inactivity, shorten default accordingly
57 * 2004-03-11 - 0.8 Juergen Stuber <starblue@users.sourceforge.net>
58 * - log major, minor instead of possibly confusing device filename
59 * - whitespace cleanup
60 * 2004-03-12 - 0.9 Juergen Stuber <starblue@users.sourceforge.net>
61 * - normalize whitespace in debug messages
62 * - take care about endianness in control message responses
63 * 2004-03-13 - 0.91 Juergen Stuber <starblue@users.sourceforge.net>
64 * - make default intervals longer to accommodate current EHCI driver
65 * 2004-03-19 - 0.92 Juergen Stuber <starblue@users.sourceforge.net>
66 * - replaced atomic_t by memory barriers
67 * 2004-04-21 - 0.93 Juergen Stuber <starblue@users.sourceforge.net>
68 * - wait for completion of write urb in release (needed for remotecontrol)
69 * - corrected poll for write direction (missing negation)
70 * 2004-04-22 - 0.94 Juergen Stuber <starblue@users.sourceforge.net>
71 * - make device locking interruptible
72 * 2004-04-30 - 0.95 Juergen Stuber <starblue@users.sourceforge.net>
73 * - check for valid udev on resubmitting and unlinking urbs
76 #include <linux/config.h>
77 #include <linux/kernel.h>
78 #include <linux/errno.h>
79 #include <linux/init.h>
80 #include <linux/slab.h>
81 #include <linux/module.h>
82 #include <linux/smp_lock.h>
83 #include <linux/completion.h>
84 #include <asm/uaccess.h>
85 #include <linux/usb.h>
86 #include <linux/poll.h>
89 #ifdef CONFIG_USB_DEBUG
95 /* Use our own dbg macro */
97 #define dbg(lvl, format, arg...) do { if (debug >= lvl) printk(KERN_DEBUG __FILE__ ": " format "\n", ## arg); } while (0)
100 /* Version Information */
101 #define DRIVER_VERSION "v0.95"
102 #define DRIVER_AUTHOR "Juergen Stuber <starblue@sourceforge.net>"
103 #define DRIVER_DESC "LEGO USB Tower Driver"
105 /* Module parameters */
106 MODULE_PARM(debug, "i");
107 MODULE_PARM_DESC(debug, "Debug enabled or not");
109 /* The defaults are chosen to work with the latest versions of leJOS and NQC.
112 /* Some legacy software likes to receive packets in one piece.
113 * In this case read_buffer_size should exceed the maximal packet length
114 * (417 for datalog uploads), and packet_timeout should be set.
116 static size_t read_buffer_size = 480;
117 MODULE_PARM(read_buffer_size, "i");
118 MODULE_PARM_DESC(read_buffer_size, "Read buffer size");
120 /* Some legacy software likes to send packets in one piece.
121 * In this case write_buffer_size should exceed the maximal packet length
122 * (417 for firmware and program downloads).
123 * A problem with long writes is that the following read may time out
124 * if the software is not prepared to wait long enough.
126 static size_t write_buffer_size = 480;
127 MODULE_PARM(write_buffer_size, "i");
128 MODULE_PARM_DESC(write_buffer_size, "Write buffer size");
130 /* Some legacy software expects reads to contain whole LASM packets.
131 * To achieve this, characters which arrive before a packet timeout
132 * occurs will be returned in a single read operation.
133 * A problem with long reads is that the software may time out
134 * if it is not prepared to wait long enough.
135 * The packet timeout should be greater than the time between the
136 * reception of subsequent characters, which should arrive about
137 * every 5ms for the standard 2400 baud.
138 * Set it to 0 to disable.
140 static int packet_timeout = 50;
141 MODULE_PARM(packet_timeout, "i");
142 MODULE_PARM_DESC(packet_timeout, "Packet timeout in ms");
144 /* Some legacy software expects blocking reads to time out.
145 * Timeout occurs after the specified time of read and write inactivity.
146 * Set it to 0 to disable.
148 static int read_timeout = 200;
149 MODULE_PARM(read_timeout, "i");
150 MODULE_PARM_DESC(read_timeout, "Read timeout in ms");
152 /* As of kernel version 2.6.4 ehci-hcd uses an
153 * "only one interrupt transfer per frame" shortcut
154 * to simplify the scheduling of periodic transfers.
155 * This conflicts with our standard 1ms intervals for in and out URBs.
156 * We use default intervals of 2ms for in and 8ms for out transfers,
157 * which is fast enough for 2400 baud and allows a small additional load.
158 * Increase the interval to allow more devices that do interrupt transfers,
159 * or set to 0 to use the standard interval from the endpoint descriptors.
161 static int interrupt_in_interval = 2;
162 MODULE_PARM(interrupt_in_interval, "i");
163 MODULE_PARM_DESC(interrupt_in_interval, "Interrupt in interval in ms");
165 static int interrupt_out_interval = 8;
166 MODULE_PARM(interrupt_out_interval, "i");
167 MODULE_PARM_DESC(interrupt_out_interval, "Interrupt out interval in ms");
169 /* Define these values to match your device */
170 #define LEGO_USB_TOWER_VENDOR_ID 0x0694
171 #define LEGO_USB_TOWER_PRODUCT_ID 0x0001
173 /* Vendor requests */
174 #define LEGO_USB_TOWER_REQUEST_RESET 0x04
175 #define LEGO_USB_TOWER_REQUEST_GET_VERSION 0xFD
177 struct tower_reset_reply {
178 __u16 size; /* little-endian */
181 } __attribute__ ((packed));
183 struct tower_get_version_reply {
184 __u16 size; /* little-endian */
189 __u16 build_no; /* little-endian */
190 } __attribute__ ((packed));
193 /* table of devices that work with this driver */
194 static struct usb_device_id tower_table [] = {
195 { USB_DEVICE(LEGO_USB_TOWER_VENDOR_ID, LEGO_USB_TOWER_PRODUCT_ID) },
196 { } /* Terminating entry */
199 MODULE_DEVICE_TABLE (usb, tower_table);
201 #define LEGO_USB_TOWER_MINOR_BASE 160
204 /* Structure to hold all of our device specific stuff */
205 struct lego_usb_tower {
206 struct semaphore sem; /* locks this structure */
207 struct usb_device* udev; /* save off the usb device pointer */
208 unsigned char minor; /* the starting minor number for this device */
210 int open_count; /* number of times this port has been opened */
213 size_t read_buffer_length; /* this much came in */
214 size_t read_packet_length; /* this much will be returned on read */
215 spinlock_t read_buffer_lock;
216 int packet_timeout_jiffies;
217 unsigned long read_last_arrival;
219 wait_queue_head_t read_wait;
220 wait_queue_head_t write_wait;
222 char* interrupt_in_buffer;
223 struct usb_endpoint_descriptor* interrupt_in_endpoint;
224 struct urb* interrupt_in_urb;
225 int interrupt_in_interval;
226 int interrupt_in_running;
227 int interrupt_in_done;
229 char* interrupt_out_buffer;
230 struct usb_endpoint_descriptor* interrupt_out_endpoint;
231 struct urb* interrupt_out_urb;
232 int interrupt_out_interval;
233 int interrupt_out_busy;
238 /* local function prototypes */
239 static ssize_t tower_read (struct file *file, char *buffer, size_t count, loff_t *ppos);
240 static ssize_t tower_write (struct file *file, const char *buffer, size_t count, loff_t *ppos);
241 static inline void tower_delete (struct lego_usb_tower *dev);
242 static int tower_open (struct inode *inode, struct file *file);
243 static int tower_release (struct inode *inode, struct file *file);
244 static unsigned int tower_poll (struct file *file, poll_table *wait);
245 static loff_t tower_llseek (struct file *file, loff_t off, int whence);
247 static void tower_abort_transfers (struct lego_usb_tower *dev);
248 static void tower_check_for_read_packet (struct lego_usb_tower *dev);
249 static void tower_interrupt_in_callback (struct urb *urb, struct pt_regs *regs);
250 static void tower_interrupt_out_callback (struct urb *urb, struct pt_regs *regs);
252 static int tower_probe (struct usb_interface *interface, const struct usb_device_id *id);
253 static void tower_disconnect (struct usb_interface *interface);
256 /* prevent races between open() and disconnect */
257 static DECLARE_MUTEX (disconnect_sem);
259 /* file operations needed when we register this driver */
260 static struct file_operations tower_fops = {
261 .owner = THIS_MODULE,
263 .write = tower_write,
265 .release = tower_release,
267 .llseek = tower_llseek,
271 * usb class driver info in order to get a minor number from the usb core,
272 * and to have the device registered with devfs and the driver core
274 static struct usb_class_driver tower_class = {
275 .name = "usb/legousbtower%d",
277 .mode = S_IFCHR | S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH,
278 .minor_base = LEGO_USB_TOWER_MINOR_BASE,
282 /* usb specific object needed to register this driver with the usb subsystem */
283 static struct usb_driver tower_driver = {
284 .owner = THIS_MODULE,
285 .name = "legousbtower",
286 .probe = tower_probe,
287 .disconnect = tower_disconnect,
288 .id_table = tower_table,
293 * lego_usb_tower_debug_data
295 static inline void lego_usb_tower_debug_data (int level, const char *function, int size, const unsigned char *data)
302 printk (KERN_DEBUG __FILE__": %s - length = %d, data = ", function, size);
303 for (i = 0; i < size; ++i) {
304 printk ("%.2x ", data[i]);
313 static inline void tower_delete (struct lego_usb_tower *dev)
315 dbg(2, "%s: enter", __FUNCTION__);
317 tower_abort_transfers (dev);
319 /* free data structures */
320 if (dev->interrupt_in_urb != NULL) {
321 usb_free_urb (dev->interrupt_in_urb);
323 if (dev->interrupt_out_urb != NULL) {
324 usb_free_urb (dev->interrupt_out_urb);
326 kfree (dev->read_buffer);
327 kfree (dev->interrupt_in_buffer);
328 kfree (dev->interrupt_out_buffer);
331 dbg(2, "%s: leave", __FUNCTION__);
338 static int tower_open (struct inode *inode, struct file *file)
340 struct lego_usb_tower *dev = NULL;
343 struct usb_interface *interface;
345 dbg(2, "%s: enter", __FUNCTION__);
347 subminor = iminor(inode);
349 down (&disconnect_sem);
351 interface = usb_find_interface (&tower_driver, subminor);
354 err ("%s - error, can't find device for minor %d",
355 __FUNCTION__, subminor);
357 goto unlock_disconnect_exit;
360 dev = usb_get_intfdata(interface);
364 goto unlock_disconnect_exit;
367 /* lock this device */
368 if (down_interruptible (&dev->sem)) {
369 retval = -ERESTARTSYS;
370 goto unlock_disconnect_exit;
373 /* allow opening only once */
374 if (dev->open_count) {
380 /* initialize in direction */
381 dev->read_buffer_length = 0;
382 dev->read_packet_length = 0;
383 usb_fill_int_urb (dev->interrupt_in_urb,
385 usb_rcvintpipe(dev->udev, dev->interrupt_in_endpoint->bEndpointAddress),
386 dev->interrupt_in_buffer,
387 dev->interrupt_in_endpoint->wMaxPacketSize,
388 tower_interrupt_in_callback,
390 dev->interrupt_in_interval);
392 dev->interrupt_in_running = 1;
393 dev->interrupt_in_done = 0;
396 retval = usb_submit_urb (dev->interrupt_in_urb, GFP_KERNEL);
398 err("Couldn't submit interrupt_in_urb %d", retval);
399 dev->interrupt_in_running = 0;
404 /* save device in the file's private structure */
405 file->private_data = dev;
410 unlock_disconnect_exit:
411 up (&disconnect_sem);
413 dbg(2, "%s: leave, return value %d ", __FUNCTION__, retval);
421 static int tower_release (struct inode *inode, struct file *file)
423 struct lego_usb_tower *dev;
426 dbg(2, "%s: enter", __FUNCTION__);
428 dev = (struct lego_usb_tower *)file->private_data;
431 dbg(1, "%s: object is NULL", __FUNCTION__);
436 if (down_interruptible (&dev->sem)) {
437 retval = -ERESTARTSYS;
441 if (dev->open_count != 1) {
442 dbg(1, "%s: device not opened exactly once", __FUNCTION__);
446 if (dev->udev == NULL) {
447 /* the device was unplugged before the file was released */
448 up (&dev->sem); /* unlock here as tower_delete frees dev */
453 /* wait until write transfer is finished */
454 if (dev->interrupt_out_busy) {
455 wait_event_interruptible_timeout (dev->write_wait, !dev->interrupt_out_busy, 2 * HZ);
457 tower_abort_transfers (dev);
464 dbg(2, "%s: leave, return value %d", __FUNCTION__, retval);
470 * tower_abort_transfers
471 * aborts transfers and frees associated data structures
473 static void tower_abort_transfers (struct lego_usb_tower *dev)
475 dbg(2, "%s: enter", __FUNCTION__);
478 dbg(1, "%s: dev is null", __FUNCTION__);
482 /* shutdown transfer */
483 if (dev->interrupt_in_running) {
484 dev->interrupt_in_running = 0;
486 if (dev->interrupt_in_urb != NULL && dev->udev) {
487 usb_unlink_urb (dev->interrupt_in_urb);
490 if (dev->interrupt_out_busy) {
491 if (dev->interrupt_out_urb != NULL && dev->udev) {
492 usb_unlink_urb (dev->interrupt_out_urb);
497 dbg(2, "%s: leave", __FUNCTION__);
502 * tower_check_for_read_packet
504 * To get correct semantics for signals and non-blocking I/O
505 * with packetizing we pretend not to see any data in the read buffer
506 * until it has been there unchanged for at least
507 * dev->packet_timeout_jiffies, or until the buffer is full.
509 static void tower_check_for_read_packet (struct lego_usb_tower *dev)
511 spin_lock_irq (&dev->read_buffer_lock);
513 || time_after(jiffies, dev->read_last_arrival + dev->packet_timeout_jiffies)
514 || dev->read_buffer_length == read_buffer_size) {
515 dev->read_packet_length = dev->read_buffer_length;
517 dev->interrupt_in_done = 0;
518 spin_unlock_irq (&dev->read_buffer_lock);
525 static unsigned int tower_poll (struct file *file, poll_table *wait)
527 struct lego_usb_tower *dev;
528 unsigned int mask = 0;
530 dbg(2, "%s: enter", __FUNCTION__);
532 dev = file->private_data;
534 poll_wait(file, &dev->read_wait, wait);
535 poll_wait(file, &dev->write_wait, wait);
537 tower_check_for_read_packet(dev);
538 if (dev->read_packet_length > 0) {
539 mask |= POLLIN | POLLRDNORM;
541 if (!dev->interrupt_out_busy) {
542 mask |= POLLOUT | POLLWRNORM;
545 dbg(2, "%s: leave, mask = %d", __FUNCTION__, mask);
554 static loff_t tower_llseek (struct file *file, loff_t off, int whence)
556 return -ESPIPE; /* unseekable */
563 static ssize_t tower_read (struct file *file, char *buffer, size_t count, loff_t *ppos)
565 struct lego_usb_tower *dev;
566 size_t bytes_to_read;
569 unsigned long timeout = 0;
571 dbg(2, "%s: enter, count = %Zd", __FUNCTION__, count);
573 dev = (struct lego_usb_tower *)file->private_data;
575 /* lock this object */
576 if (down_interruptible (&dev->sem)) {
577 retval = -ERESTARTSYS;
581 /* verify that the device wasn't unplugged */
582 if (dev->udev == NULL) {
584 err("No device or device unplugged %d", retval);
588 /* verify that we actually have some data to read */
590 dbg(1, "%s: read request of 0 bytes", __FUNCTION__);
595 timeout = jiffies + read_timeout * HZ / 1000;
599 tower_check_for_read_packet (dev);
600 while (dev->read_packet_length == 0) {
601 if (file->f_flags & O_NONBLOCK) {
605 retval = wait_event_interruptible_timeout(dev->read_wait, dev->interrupt_in_done, dev->packet_timeout_jiffies);
610 /* reset read timeout during read or write activity */
612 && (dev->read_buffer_length || dev->interrupt_out_busy)) {
613 timeout = jiffies + read_timeout * HZ / 1000;
615 /* check for read timeout */
616 if (read_timeout && time_after (jiffies, timeout)) {
620 tower_check_for_read_packet (dev);
623 /* copy the data from read_buffer into userspace */
624 bytes_to_read = min(count, dev->read_packet_length);
626 if (copy_to_user (buffer, dev->read_buffer, bytes_to_read)) {
631 spin_lock_irq (&dev->read_buffer_lock);
632 dev->read_buffer_length -= bytes_to_read;
633 dev->read_packet_length -= bytes_to_read;
634 for (i=0; i<dev->read_buffer_length; i++) {
635 dev->read_buffer[i] = dev->read_buffer[i+bytes_to_read];
637 spin_unlock_irq (&dev->read_buffer_lock);
639 retval = bytes_to_read;
642 /* unlock the device */
646 dbg(2, "%s: leave, return value %d", __FUNCTION__, retval);
654 static ssize_t tower_write (struct file *file, const char *buffer, size_t count, loff_t *ppos)
656 struct lego_usb_tower *dev;
657 size_t bytes_to_write;
660 dbg(2, "%s: enter, count = %Zd", __FUNCTION__, count);
662 dev = (struct lego_usb_tower *)file->private_data;
664 /* lock this object */
665 if (down_interruptible (&dev->sem)) {
666 retval = -ERESTARTSYS;
670 /* verify that the device wasn't unplugged */
671 if (dev->udev == NULL) {
673 err("No device or device unplugged %d", retval);
677 /* verify that we actually have some data to write */
679 dbg(1, "%s: write request of 0 bytes", __FUNCTION__);
683 /* wait until previous transfer is finished */
684 while (dev->interrupt_out_busy) {
685 if (file->f_flags & O_NONBLOCK) {
689 retval = wait_event_interruptible (dev->write_wait, !dev->interrupt_out_busy);
695 /* write the data into interrupt_out_buffer from userspace */
696 bytes_to_write = min(count, write_buffer_size);
697 dbg(4, "%s: count = %Zd, bytes_to_write = %Zd", __FUNCTION__, count, bytes_to_write);
699 if (copy_from_user (dev->interrupt_out_buffer, buffer, bytes_to_write)) {
704 /* send off the urb */
705 usb_fill_int_urb(dev->interrupt_out_urb,
707 usb_sndintpipe(dev->udev, dev->interrupt_out_endpoint->bEndpointAddress),
708 dev->interrupt_out_buffer,
710 tower_interrupt_out_callback,
712 dev->interrupt_out_interval);
714 dev->interrupt_out_busy = 1;
717 retval = usb_submit_urb (dev->interrupt_out_urb, GFP_KERNEL);
719 dev->interrupt_out_busy = 0;
720 err("Couldn't submit interrupt_out_urb %d", retval);
723 retval = bytes_to_write;
726 /* unlock the device */
730 dbg(2, "%s: leave, return value %d", __FUNCTION__, retval);
737 * tower_interrupt_in_callback
739 static void tower_interrupt_in_callback (struct urb *urb, struct pt_regs *regs)
741 struct lego_usb_tower *dev = (struct lego_usb_tower *)urb->context;
744 dbg(4, "%s: enter, status %d", __FUNCTION__, urb->status);
746 lego_usb_tower_debug_data(5, __FUNCTION__, urb->actual_length, urb->transfer_buffer);
749 if (urb->status == -ENOENT ||
750 urb->status == -ECONNRESET ||
751 urb->status == -ESHUTDOWN) {
754 dbg(1, "%s: nonzero status received: %d", __FUNCTION__, urb->status);
755 goto resubmit; /* maybe we can recover */
759 if (urb->actual_length > 0) {
760 spin_lock (&dev->read_buffer_lock);
761 if (dev->read_buffer_length + urb->actual_length < read_buffer_size) {
762 memcpy (dev->read_buffer + dev->read_buffer_length,
763 dev->interrupt_in_buffer,
765 dev->read_buffer_length += urb->actual_length;
766 dev->read_last_arrival = jiffies;
767 dbg(3, "%s: received %d bytes", __FUNCTION__, urb->actual_length);
769 printk(KERN_WARNING "%s: read_buffer overflow, %d bytes dropped", __FUNCTION__, urb->actual_length);
771 spin_unlock (&dev->read_buffer_lock);
775 /* resubmit if we're still running */
776 if (dev->interrupt_in_running && dev->udev) {
777 retval = usb_submit_urb (dev->interrupt_in_urb, GFP_ATOMIC);
779 err("%s: usb_submit_urb failed (%d)", __FUNCTION__, retval);
784 dev->interrupt_in_done = 1;
785 wake_up_interruptible (&dev->read_wait);
787 lego_usb_tower_debug_data(5, __FUNCTION__, urb->actual_length, urb->transfer_buffer);
788 dbg(4, "%s: leave, status %d", __FUNCTION__, urb->status);
793 * tower_interrupt_out_callback
795 static void tower_interrupt_out_callback (struct urb *urb, struct pt_regs *regs)
797 struct lego_usb_tower *dev = (struct lego_usb_tower *)urb->context;
799 dbg(4, "%s: enter, status %d", __FUNCTION__, urb->status);
800 lego_usb_tower_debug_data(5, __FUNCTION__, urb->actual_length, urb->transfer_buffer);
802 /* sync/async unlink faults aren't errors */
803 if (urb->status && !(urb->status == -ENOENT ||
804 urb->status == -ECONNRESET ||
805 urb->status == -ESHUTDOWN)) {
806 dbg(1, "%s - nonzero write bulk status received: %d",
807 __FUNCTION__, urb->status);
810 dev->interrupt_out_busy = 0;
811 wake_up_interruptible(&dev->write_wait);
813 lego_usb_tower_debug_data(5, __FUNCTION__, urb->actual_length, urb->transfer_buffer);
814 dbg(4, "%s: leave, status %d", __FUNCTION__, urb->status);
821 * Called by the usb core when a new device is connected that it thinks
822 * this driver might be interested in.
824 static int tower_probe (struct usb_interface *interface, const struct usb_device_id *id)
826 struct usb_device *udev = interface_to_usbdev(interface);
827 struct lego_usb_tower *dev = NULL;
828 struct usb_host_interface *iface_desc;
829 struct usb_endpoint_descriptor* endpoint;
830 struct tower_reset_reply reset_reply;
831 struct tower_get_version_reply get_version_reply;
833 int retval = -ENOMEM;
836 dbg(2, "%s: enter", __FUNCTION__);
839 info ("udev is NULL.");
842 /* See if the device offered us matches what we can accept */
843 if ((udev->descriptor.idVendor != LEGO_USB_TOWER_VENDOR_ID) ||
844 (udev->descriptor.idProduct != LEGO_USB_TOWER_PRODUCT_ID)) {
849 /* allocate memory for our device state and intialize it */
851 dev = kmalloc (sizeof(struct lego_usb_tower), GFP_KERNEL);
854 err ("Out of memory");
858 init_MUTEX (&dev->sem);
863 dev->read_buffer = NULL;
864 dev->read_buffer_length = 0;
865 dev->read_packet_length = 0;
866 spin_lock_init (&dev->read_buffer_lock);
867 dev->packet_timeout_jiffies = packet_timeout * HZ / 1000;
868 dev->read_last_arrival = jiffies;
870 init_waitqueue_head (&dev->read_wait);
871 init_waitqueue_head (&dev->write_wait);
873 dev->interrupt_in_buffer = NULL;
874 dev->interrupt_in_endpoint = NULL;
875 dev->interrupt_in_urb = NULL;
876 dev->interrupt_in_running = 0;
877 dev->interrupt_in_done = 0;
879 dev->interrupt_out_buffer = NULL;
880 dev->interrupt_out_endpoint = NULL;
881 dev->interrupt_out_urb = NULL;
882 dev->interrupt_out_busy = 0;
884 iface_desc = interface->cur_altsetting;
886 /* set up the endpoint information */
887 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
888 endpoint = &iface_desc->endpoint[i].desc;
890 if (((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN) &&
891 ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)) {
892 dev->interrupt_in_endpoint = endpoint;
895 if (((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT) &&
896 ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)) {
897 dev->interrupt_out_endpoint = endpoint;
900 if(dev->interrupt_in_endpoint == NULL) {
901 err("interrupt in endpoint not found");
904 if (dev->interrupt_out_endpoint == NULL) {
905 err("interrupt out endpoint not found");
909 dev->read_buffer = kmalloc (read_buffer_size, GFP_KERNEL);
910 if (!dev->read_buffer) {
911 err("Couldn't allocate read_buffer");
914 dev->interrupt_in_buffer = kmalloc (dev->interrupt_in_endpoint->wMaxPacketSize, GFP_KERNEL);
915 if (!dev->interrupt_in_buffer) {
916 err("Couldn't allocate interrupt_in_buffer");
919 dev->interrupt_in_urb = usb_alloc_urb(0, GFP_KERNEL);
920 if (!dev->interrupt_in_urb) {
921 err("Couldn't allocate interrupt_in_urb");
924 dev->interrupt_out_buffer = kmalloc (write_buffer_size, GFP_KERNEL);
925 if (!dev->interrupt_out_buffer) {
926 err("Couldn't allocate interrupt_out_buffer");
929 dev->interrupt_out_urb = usb_alloc_urb(0, GFP_KERNEL);
930 if (!dev->interrupt_out_urb) {
931 err("Couldn't allocate interrupt_out_urb");
934 dev->interrupt_in_interval = interrupt_in_interval ? interrupt_in_interval : dev->interrupt_in_endpoint->bInterval;
935 dev->interrupt_out_interval = interrupt_out_interval ? interrupt_out_interval : dev->interrupt_out_endpoint->bInterval;
937 /* we can register the device now, as it is ready */
938 usb_set_intfdata (interface, dev);
940 retval = usb_register_dev (interface, &tower_class);
943 /* something prevented us from registering this driver */
944 err ("Not able to get a minor for this device.");
945 usb_set_intfdata (interface, NULL);
948 dev->minor = interface->minor;
950 /* let the user know what node this device is now attached to */
951 info ("LEGO USB Tower #%d now attached to major %d minor %d", (dev->minor - LEGO_USB_TOWER_MINOR_BASE), USB_MAJOR, dev->minor);
953 /* reset the tower */
954 result = usb_control_msg (udev,
955 usb_rcvctrlpipe(udev, 0),
956 LEGO_USB_TOWER_REQUEST_RESET,
957 USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE,
964 err("LEGO USB Tower reset control request failed");
969 /* get the firmware version and log it */
970 result = usb_control_msg (udev,
971 usb_rcvctrlpipe(udev, 0),
972 LEGO_USB_TOWER_REQUEST_GET_VERSION,
973 USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE,
977 sizeof(get_version_reply),
980 err("LEGO USB Tower get version control request failed");
984 info("LEGO USB Tower firmware version is %d.%d build %d",
985 get_version_reply.major,
986 get_version_reply.minor,
987 le16_to_cpu(get_version_reply.build_no));
991 dbg(2, "%s: leave, return value 0x%.8lx (dev)", __FUNCTION__, (long) dev);
1004 * Called by the usb core when the device is removed from the system.
1006 static void tower_disconnect (struct usb_interface *interface)
1008 struct lego_usb_tower *dev;
1011 dbg(2, "%s: enter", __FUNCTION__);
1013 down (&disconnect_sem);
1015 dev = usb_get_intfdata (interface);
1016 usb_set_intfdata (interface, NULL);
1023 /* give back our minor */
1024 usb_deregister_dev (interface, &tower_class);
1026 /* if the device is not opened, then we clean up right now */
1027 if (!dev->open_count) {
1035 up (&disconnect_sem);
1037 info("LEGO USB Tower #%d now disconnected", (minor - LEGO_USB_TOWER_MINOR_BASE));
1039 dbg(2, "%s: leave", __FUNCTION__);
1045 * lego_usb_tower_init
1047 static int __init lego_usb_tower_init(void)
1052 dbg(2, "%s: enter", __FUNCTION__);
1054 /* register this driver with the USB subsystem */
1055 result = usb_register(&tower_driver);
1057 err("usb_register failed for the "__FILE__" driver. Error number %d", result);
1062 info(DRIVER_DESC " " DRIVER_VERSION);
1065 dbg(2, "%s: leave, return value %d", __FUNCTION__, retval);
1072 * lego_usb_tower_exit
1074 static void __exit lego_usb_tower_exit(void)
1076 dbg(2, "%s: enter", __FUNCTION__);
1078 /* deregister this driver with the USB subsystem */
1079 usb_deregister (&tower_driver);
1081 dbg(2, "%s: leave", __FUNCTION__);
1084 module_init (lego_usb_tower_init);
1085 module_exit (lego_usb_tower_exit);
1087 MODULE_AUTHOR(DRIVER_AUTHOR);
1088 MODULE_DESCRIPTION(DRIVER_DESC);
1089 #ifdef MODULE_LICENSE
1090 MODULE_LICENSE("GPL");