1 2 3#include <linux/kernel.h> 4#include <linux/errno.h> 5#include <linux/init.h> 6#include <linux/slab.h> 7#include <linux/module.h> 8#include <linux/completion.h> 9#include <linux/mutex.h> 10#include <asm/uaccess.h> 11#include <linux/usb.h> 12#include <linux/poll.h> 13 14 15#ifdef CONFIG_USB_DEBUG 16 static int debug = 4; 17#else 18 static int debug = 0; 19#endif 20 21/* Use our own dbg macro */ 22#undef dbg 23#define dbg(lvl, format, arg...) do { if (debug >= lvl) printk(KERN_DEBUG __FILE__ ": " format "\n", ## arg); } while (0) 24 25 26/* Version Information */ 27#define DRIVER_VERSION "v0.96" 28#define DRIVER_AUTHOR "Juergen Stuber <starblue@sourceforge.net>" 29#define DRIVER_DESC "LEGO USB Tower Driver" 30 31/* Module parameters */ 32module_param(debug, int, S_IRUGO | S_IWUSR); 33MODULE_PARM_DESC(debug, "Debug enabled or not"); 34 35/* The defaults are chosen to work with the latest versions of leJOS and NQC. 36 */ 37 38/* Some legacy software likes to receive packets in one piece. 39 * In this case read_buffer_size should exceed the maximal packet length 40 * (417 for datalog uploads), and packet_timeout should be set. 41 */ 42static int read_buffer_size = 480; 43module_param(read_buffer_size, int, 0); 44MODULE_PARM_DESC(read_buffer_size, "Read buffer size"); 45 46/* Some legacy software likes to send packets in one piece. 47 * In this case write_buffer_size should exceed the maximal packet length 48 * (417 for firmware and program downloads). 49 * A problem with long writes is that the following read may time out 50 * if the software is not prepared to wait long enough. 51 */ 52static int write_buffer_size = 480; 53module_param(write_buffer_size, int, 0); 54MODULE_PARM_DESC(write_buffer_size, "Write buffer size"); 55 56/* Some legacy software expects reads to contain whole LASM packets. 57 * To achieve this, characters which arrive before a packet timeout 58 * occurs will be returned in a single read operation. 59 * A problem with long reads is that the software may time out 60 * if it is not prepared to wait long enough. 61 * The packet timeout should be greater than the time between the 62 * reception of subsequent characters, which should arrive about 63 * every 5ms for the standard 2400 baud. 64 * Set it to 0 to disable. 65 */ 66static int packet_timeout = 50; 67module_param(packet_timeout, int, 0); 68MODULE_PARM_DESC(packet_timeout, "Packet timeout in ms"); 69 70/* Some legacy software expects blocking reads to time out. 71 * Timeout occurs after the specified time of read and write inactivity. 72 * Set it to 0 to disable. 73 */ 74static int read_timeout = 200; 75module_param(read_timeout, int, 0); 76MODULE_PARM_DESC(read_timeout, "Read timeout in ms"); 77 78/* As of kernel version 2.6.4 ehci-hcd uses an 79 * "only one interrupt transfer per frame" shortcut 80 * to simplify the scheduling of periodic transfers. 81 * This conflicts with our standard 1ms intervals for in and out URBs. 82 * We use default intervals of 2ms for in and 8ms for out transfers, 83 * which is fast enough for 2400 baud and allows a small additional load. 84 * Increase the interval to allow more devices that do interrupt transfers, 85 * or set to 0 to use the standard interval from the endpoint descriptors. 86 */ 87static int interrupt_in_interval = 2; 88module_param(interrupt_in_interval, int, 0); 89MODULE_PARM_DESC(interrupt_in_interval, "Interrupt in interval in ms"); 90 91static int interrupt_out_interval = 8; 92module_param(interrupt_out_interval, int, 0); 93MODULE_PARM_DESC(interrupt_out_interval, "Interrupt out interval in ms"); 94 95/* Define these values to match your device */ 96#define LEGO_USB_TOWER_VENDOR_ID 0x0694 97#define LEGO_USB_TOWER_PRODUCT_ID 0x0001 98 99/* Vendor requests */ 100#define LEGO_USB_TOWER_REQUEST_RESET 0x04 101#define LEGO_USB_TOWER_REQUEST_GET_VERSION 0xFD 102 103struct tower_reset_reply { 104 __le16 size; /* little-endian */ 105 __u8 err_code; 106 __u8 spare; 107} __attribute__ ((packed)); 108 109struct tower_get_version_reply { 110 __le16 size; /* little-endian */ 111 __u8 err_code; 112 __u8 spare; 113 __u8 major; 114 __u8 minor; 115 __le16 build_no; /* little-endian */ 116} __attribute__ ((packed)); 117 118 119/* table of devices that work with this driver */ 120static struct usb_device_id tower_table [] = { 121 { USB_DEVICE(LEGO_USB_TOWER_VENDOR_ID, LEGO_USB_TOWER_PRODUCT_ID) }, 122 { } /* Terminating entry */ 123}; 124 125MODULE_DEVICE_TABLE (usb, tower_table); 126 127#define LEGO_USB_TOWER_MINOR_BASE 160 128 129 130/* Structure to hold all of our device specific stuff */ 131struct lego_usb_tower { 132 struct semaphore sem; /* locks this structure */ 133 struct usb_device* udev; /* save off the usb device pointer */ 134 unsigned char minor; /* the starting minor number for this device */ 135 136 int open_count; /* number of times this port has been opened */ 137 138 char* read_buffer; 139 size_t read_buffer_length; /* this much came in */ 140 size_t read_packet_length; /* this much will be returned on read */ 141 spinlock_t read_buffer_lock; 142 int packet_timeout_jiffies; 143 unsigned long read_last_arrival; 144 145 wait_queue_head_t read_wait; 146 wait_queue_head_t write_wait; 147 148 char* interrupt_in_buffer; 149 struct usb_endpoint_descriptor* interrupt_in_endpoint; 150 struct urb* interrupt_in_urb; 151 int interrupt_in_interval; 152 int interrupt_in_running; 153 int interrupt_in_done; 154 155 char* interrupt_out_buffer; 156 struct usb_endpoint_descriptor* interrupt_out_endpoint; 157 struct urb* interrupt_out_urb; 158 int interrupt_out_interval; 159 int interrupt_out_busy; 160 161}; 162 163 164/* local function prototypes */ 165static ssize_t tower_read (struct file *file, char __user *buffer, size_t count, loff_t *ppos); 166static ssize_t tower_write (struct file *file, const char __user *buffer, size_t count, loff_t *ppos); 167static inline void tower_delete (struct lego_usb_tower *dev); 168static int tower_open (struct inode *inode, struct file *file); 169static int tower_release (struct inode *inode, struct file *file); 170static unsigned int tower_poll (struct file *file, poll_table *wait); 171static loff_t tower_llseek (struct file *file, loff_t off, int whence); 172 173static void tower_abort_transfers (struct lego_usb_tower *dev); 174static void tower_check_for_read_packet (struct lego_usb_tower *dev); 175static void tower_interrupt_in_callback (struct urb *urb); 176static void tower_interrupt_out_callback (struct urb *urb); 177 178static int tower_probe (struct usb_interface *interface, const struct usb_device_id *id); 179static void tower_disconnect (struct usb_interface *interface); 180 181 182/* prevent races between open() and disconnect */ 183static DEFINE_MUTEX (disconnect_mutex); 184 185/* file operations needed when we register this driver */ 186static const struct file_operations tower_fops = { 187 .owner = THIS_MODULE, 188 .read = tower_read, 189 .write = tower_write, 190 .open = tower_open, 191 .release = tower_release, 192 .poll = tower_poll, 193 .llseek = tower_llseek, 194}; 195 196/* 197 * usb class driver info in order to get a minor number from the usb core, 198 * and to have the device registered with the driver core 199 */ 200static struct usb_class_driver tower_class = { 201 .name = "legousbtower%d", 202 .fops = &tower_fops, 203 .minor_base = LEGO_USB_TOWER_MINOR_BASE, 204}; 205 206 207/* usb specific object needed to register this driver with the usb subsystem */ 208static struct usb_driver tower_driver = { 209 .name = "legousbtower", 210 .probe = tower_probe, 211 .disconnect = tower_disconnect, 212 .id_table = tower_table, 213}; 214 215 216/** 217 * lego_usb_tower_debug_data 218 */ 219static inline void lego_usb_tower_debug_data (int level, const char *function, int size, const unsigned char *data) 220{ 221 int i; 222 223 if (debug < level) 224 return; 225 226 printk (KERN_DEBUG __FILE__": %s - length = %d, data = ", function, size); 227 for (i = 0; i < size; ++i) { 228 printk ("%.2x ", data[i]); 229 } 230 printk ("\n"); 231} 232 233 234/** 235 * tower_delete 236 */ 237static inline void tower_delete (struct lego_usb_tower *dev) 238{ 239 dbg(2, "%s: enter", __FUNCTION__); 240 241 tower_abort_transfers (dev); 242 243 /* free data structures */ 244 usb_free_urb(dev->interrupt_in_urb); 245 usb_free_urb(dev->interrupt_out_urb); 246 kfree (dev->read_buffer); 247 kfree (dev->interrupt_in_buffer); 248 kfree (dev->interrupt_out_buffer); 249 kfree (dev); 250 251 dbg(2, "%s: leave", __FUNCTION__); 252} 253 254 255/** 256 * tower_open 257 */ 258static int tower_open (struct inode *inode, struct file *file) 259{ 260 struct lego_usb_tower *dev = NULL; 261 int subminor; 262 int retval = 0; 263 struct usb_interface *interface; 264 struct tower_reset_reply reset_reply; 265 int result; 266 267 dbg(2, "%s: enter", __FUNCTION__); 268 269 nonseekable_open(inode, file); 270 subminor = iminor(inode); 271 272 mutex_lock (&disconnect_mutex); 273 274 interface = usb_find_interface (&tower_driver, subminor); 275 276 if (!interface) { 277 err ("%s - error, can't find device for minor %d", 278 __FUNCTION__, subminor); 279 retval = -ENODEV; 280 goto unlock_disconnect_exit; 281 } 282 283 dev = usb_get_intfdata(interface); 284 285 if (!dev) { 286 retval = -ENODEV; 287 goto unlock_disconnect_exit; 288 } 289 290 /* lock this device */ 291 if (down_interruptible (&dev->sem)) { 292 retval = -ERESTARTSYS; 293 goto unlock_disconnect_exit; 294 } 295 296 /* allow opening only once */ 297 if (dev->open_count) { 298 retval = -EBUSY; 299 goto unlock_exit; 300 } 301 dev->open_count = 1; 302 303 /* reset the tower */ 304 result = usb_control_msg (dev->udev, 305 usb_rcvctrlpipe(dev->udev, 0), 306 LEGO_USB_TOWER_REQUEST_RESET, 307 USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE, 308 0, 309 0, 310 &reset_reply, 311 sizeof(reset_reply), 312 1000); 313 if (result < 0) { 314 err("LEGO USB Tower reset control request failed"); 315 retval = result; 316 goto unlock_exit; 317 } 318 319 /* initialize in direction */ 320 dev->read_buffer_length = 0; 321 dev->read_packet_length = 0; 322 usb_fill_int_urb (dev->interrupt_in_urb, 323 dev->udev, 324 usb_rcvintpipe(dev->udev, dev->interrupt_in_endpoint->bEndpointAddress), 325 dev->interrupt_in_buffer, 326 le16_to_cpu(dev->interrupt_in_endpoint->wMaxPacketSize), 327 tower_interrupt_in_callback, 328 dev, 329 dev->interrupt_in_interval); 330 331 dev->interrupt_in_running = 1; 332 dev->interrupt_in_done = 0; 333 mb(); 334 335 retval = usb_submit_urb (dev->interrupt_in_urb, GFP_KERNEL); 336 if (retval) { 337 err("Couldn't submit interrupt_in_urb %d", retval); 338 dev->interrupt_in_running = 0; 339 dev->open_count = 0; 340 goto unlock_exit; 341 } 342 343 /* save device in the file's private structure */ 344 file->private_data = dev; 345 346unlock_exit: 347 up (&dev->sem); 348 349unlock_disconnect_exit: 350 mutex_unlock (&disconnect_mutex); 351 352 dbg(2, "%s: leave, return value %d ", __FUNCTION__, retval); 353 354 return retval; 355} 356 357/** 358 * tower_release 359 */ 360static int tower_release (struct inode *inode, struct file *file) 361{ 362 struct lego_usb_tower *dev; 363 int retval = 0; 364 365 dbg(2, "%s: enter", __FUNCTION__); 366 367 dev = (struct lego_usb_tower *)file->private_data; 368 369 if (dev == NULL) { 370 dbg(1, "%s: object is NULL", __FUNCTION__); 371 retval = -ENODEV; 372 goto exit; 373 } 374 375 if (down_interruptible (&dev->sem)) { 376 retval = -ERESTARTSYS; 377 goto exit; 378 } 379 380 if (dev->open_count != 1) { 381 dbg(1, "%s: device not opened exactly once", __FUNCTION__); 382 retval = -ENODEV; 383 goto unlock_exit; 384 } 385 if (dev->udev == NULL) { 386 /* the device was unplugged before the file was released */ 387 up (&dev->sem); /* unlock here as tower_delete frees dev */ 388 tower_delete (dev); 389 goto exit; 390 } 391 392 /* wait until write transfer is finished */ 393 if (dev->interrupt_out_busy) { 394 wait_event_interruptible_timeout (dev->write_wait, !dev->interrupt_out_busy, 2 * HZ); 395 } 396 tower_abort_transfers (dev); 397 dev->open_count = 0; 398 399unlock_exit: 400 up (&dev->sem); 401 402exit: 403 dbg(2, "%s: leave, return value %d", __FUNCTION__, retval); 404 return retval; 405} 406 407 408/** 409 * tower_abort_transfers 410 * aborts transfers and frees associated data structures 411 */ 412static void tower_abort_transfers (struct lego_usb_tower *dev) 413{ 414 dbg(2, "%s: enter", __FUNCTION__); 415 416 if (dev == NULL) { 417 dbg(1, "%s: dev is null", __FUNCTION__); 418 goto exit; 419 } 420 421 /* shutdown transfer */ 422 if (dev->interrupt_in_running) { 423 dev->interrupt_in_running = 0; 424 mb(); 425 if (dev->udev) 426 usb_kill_urb (dev->interrupt_in_urb); 427 } 428 if (dev->interrupt_out_busy && dev->udev) 429 usb_kill_urb(dev->interrupt_out_urb); 430 431exit: 432 dbg(2, "%s: leave", __FUNCTION__); 433} 434 435 436/** 437 * tower_check_for_read_packet 438 * 439 * To get correct semantics for signals and non-blocking I/O 440 * with packetizing we pretend not to see any data in the read buffer 441 * until it has been there unchanged for at least 442 * dev->packet_timeout_jiffies, or until the buffer is full. 443 */ 444static void tower_check_for_read_packet (struct lego_usb_tower *dev) 445{ 446 spin_lock_irq (&dev->read_buffer_lock); 447 if (!packet_timeout 448 || time_after(jiffies, dev->read_last_arrival + dev->packet_timeout_jiffies) 449 || dev->read_buffer_length == read_buffer_size) { 450 dev->read_packet_length = dev->read_buffer_length; 451 } 452 dev->interrupt_in_done = 0; 453 spin_unlock_irq (&dev->read_buffer_lock); 454} 455 456 457/** 458 * tower_poll 459 */ 460static unsigned int tower_poll (struct file *file, poll_table *wait) 461{ 462 struct lego_usb_tower *dev; 463 unsigned int mask = 0; 464 465 dbg(2, "%s: enter", __FUNCTION__); 466 467 dev = file->private_data; 468 469 poll_wait(file, &dev->read_wait, wait); 470 poll_wait(file, &dev->write_wait, wait); 471 472 tower_check_for_read_packet(dev); 473 if (dev->read_packet_length > 0) { 474 mask |= POLLIN | POLLRDNORM; 475 } 476 if (!dev->interrupt_out_busy) { 477 mask |= POLLOUT | POLLWRNORM; 478 } 479 480 dbg(2, "%s: leave, mask = %d", __FUNCTION__, mask); 481 482 return mask; 483} 484 485 486/** 487 * tower_llseek 488 */ 489static loff_t tower_llseek (struct file *file, loff_t off, int whence) 490{ 491 return -ESPIPE; /* unseekable */ 492} 493 494 495/** 496 * tower_read 497 */ 498static ssize_t tower_read (struct file *file, char __user *buffer, size_t count, loff_t *ppos) 499{ 500 struct lego_usb_tower *dev; 501 size_t bytes_to_read; 502 int i; 503 int retval = 0; 504 unsigned long timeout = 0; 505 506 dbg(2, "%s: enter, count = %Zd", __FUNCTION__, count); 507 508 dev = (struct lego_usb_tower *)file->private_data; 509 510 /* lock this object */ 511 if (down_interruptible (&dev->sem)) { 512 retval = -ERESTARTSYS; 513 goto exit; 514 } 515 516 /* verify that the device wasn't unplugged */ 517 if (dev->udev == NULL) { 518 retval = -ENODEV; 519 err("No device or device unplugged %d", retval); 520 goto unlock_exit; 521 } 522 523 /* verify that we actually have some data to read */ 524 if (count == 0) { 525 dbg(1, "%s: read request of 0 bytes", __FUNCTION__); 526 goto unlock_exit; 527 } 528 529 if (read_timeout) { 530 timeout = jiffies + read_timeout * HZ / 1000; 531 } 532 533 /* wait for data */ 534 tower_check_for_read_packet (dev); 535 while (dev->read_packet_length == 0) { 536 if (file->f_flags & O_NONBLOCK) { 537 retval = -EAGAIN; 538 goto unlock_exit; 539 } 540 retval = wait_event_interruptible_timeout(dev->read_wait, dev->interrupt_in_done, dev->packet_timeout_jiffies); 541 if (retval < 0) { 542 goto unlock_exit; 543 } 544 545 /* reset read timeout during read or write activity */ 546 if (read_timeout 547 && (dev->read_buffer_length || dev->interrupt_out_busy)) { 548 timeout = jiffies + read_timeout * HZ / 1000; 549 } 550 /* check for read timeout */ 551 if (read_timeout && time_after (jiffies, timeout)) { 552 retval = -ETIMEDOUT; 553 goto unlock_exit; 554 } 555 tower_check_for_read_packet (dev); 556 } 557 558 /* copy the data from read_buffer into userspace */ 559 bytes_to_read = min(count, dev->read_packet_length); 560 561 if (copy_to_user (buffer, dev->read_buffer, bytes_to_read)) { 562 retval = -EFAULT; 563 goto unlock_exit; 564 } 565 566 spin_lock_irq (&dev->read_buffer_lock); 567 dev->read_buffer_length -= bytes_to_read; 568 dev->read_packet_length -= bytes_to_read; 569 for (i=0; i<dev->read_buffer_length; i++) { 570 dev->read_buffer[i] = dev->read_buffer[i+bytes_to_read]; 571 } 572 spin_unlock_irq (&dev->read_buffer_lock); 573 574 retval = bytes_to_read; 575 576unlock_exit: 577 /* unlock the device */ 578 up (&dev->sem); 579 580exit: 581 dbg(2, "%s: leave, return value %d", __FUNCTION__, retval); 582 return retval; 583} 584 585 586/** 587 * tower_write 588 */ 589static ssize_t tower_write (struct file *file, const char __user *buffer, size_t count, loff_t *ppos) 590{ 591 struct lego_usb_tower *dev; 592 size_t bytes_to_write; 593 int retval = 0; 594 595 dbg(2, "%s: enter, count = %Zd", __FUNCTION__, count); 596 597 dev = (struct lego_usb_tower *)file->private_data; 598 599 /* lock this object */ 600 if (down_interruptible (&dev->sem)) { 601 retval = -ERESTARTSYS; 602 goto exit; 603 } 604 605 /* verify that the device wasn't unplugged */ 606 if (dev->udev == NULL) { 607 retval = -ENODEV; 608 err("No device or device unplugged %d", retval); 609 goto unlock_exit; 610 } 611 612 /* verify that we actually have some data to write */ 613 if (count == 0) { 614 dbg(1, "%s: write request of 0 bytes", __FUNCTION__); 615 goto unlock_exit; 616 } 617 618 /* wait until previous transfer is finished */ 619 while (dev->interrupt_out_busy) { 620 if (file->f_flags & O_NONBLOCK) { 621 retval = -EAGAIN; 622 goto unlock_exit; 623 } 624 retval = wait_event_interruptible (dev->write_wait, !dev->interrupt_out_busy); 625 if (retval) { 626 goto unlock_exit; 627 } 628 } 629 630 /* write the data into interrupt_out_buffer from userspace */ 631 bytes_to_write = min_t(int, count, write_buffer_size); 632 dbg(4, "%s: count = %Zd, bytes_to_write = %Zd", __FUNCTION__, count, bytes_to_write); 633 634 if (copy_from_user (dev->interrupt_out_buffer, buffer, bytes_to_write)) { 635 retval = -EFAULT; 636 goto unlock_exit; 637 } 638 639 /* send off the urb */ 640 usb_fill_int_urb(dev->interrupt_out_urb, 641 dev->udev, 642 usb_sndintpipe(dev->udev, dev->interrupt_out_endpoint->bEndpointAddress), 643 dev->interrupt_out_buffer, 644 bytes_to_write, 645 tower_interrupt_out_callback, 646 dev, 647 dev->interrupt_out_interval); 648 649 dev->interrupt_out_busy = 1; 650 wmb(); 651 652 retval = usb_submit_urb (dev->interrupt_out_urb, GFP_KERNEL); 653 if (retval) { 654 dev->interrupt_out_busy = 0; 655 err("Couldn't submit interrupt_out_urb %d", retval); 656 goto unlock_exit; 657 } 658 retval = bytes_to_write; 659 660unlock_exit: 661 /* unlock the device */ 662 up (&dev->sem); 663 664exit: 665 dbg(2, "%s: leave, return value %d", __FUNCTION__, retval); 666 667 return retval; 668} 669 670 671/** 672 * tower_interrupt_in_callback 673 */ 674static void tower_interrupt_in_callback (struct urb *urb) 675{ 676 struct lego_usb_tower *dev = (struct lego_usb_tower *)urb->context; 677 int retval; 678 679 dbg(4, "%s: enter, status %d", __FUNCTION__, urb->status); 680 681 lego_usb_tower_debug_data(5, __FUNCTION__, urb->actual_length, urb->transfer_buffer); 682 683 if (urb->status) { 684 if (urb->status == -ENOENT || 685 urb->status == -ECONNRESET || 686 urb->status == -ESHUTDOWN) { 687 goto exit; 688 } else { 689 dbg(1, "%s: nonzero status received: %d", __FUNCTION__, urb->status); 690 goto resubmit; /* maybe we can recover */ 691 } 692 } 693 694 if (urb->actual_length > 0) { 695 spin_lock (&dev->read_buffer_lock); 696 if (dev->read_buffer_length + urb->actual_length < read_buffer_size) { 697 memcpy (dev->read_buffer + dev->read_buffer_length, 698 dev->interrupt_in_buffer, 699 urb->actual_length); 700 dev->read_buffer_length += urb->actual_length; 701 dev->read_last_arrival = jiffies; 702 dbg(3, "%s: received %d bytes", __FUNCTION__, urb->actual_length); 703 } else { 704 printk(KERN_WARNING "%s: read_buffer overflow, %d bytes dropped", __FUNCTION__, urb->actual_length); 705 } 706 spin_unlock (&dev->read_buffer_lock); 707 } 708 709resubmit: 710 /* resubmit if we're still running */ 711 if (dev->interrupt_in_running && dev->udev) { 712 retval = usb_submit_urb (dev->interrupt_in_urb, GFP_ATOMIC); 713 if (retval) { 714 err("%s: usb_submit_urb failed (%d)", __FUNCTION__, retval); 715 } 716 } 717 718exit: 719 dev->interrupt_in_done = 1; 720 wake_up_interruptible (&dev->read_wait); 721 722 lego_usb_tower_debug_data(5, __FUNCTION__, urb->actual_length, urb->transfer_buffer); 723 dbg(4, "%s: leave, status %d", __FUNCTION__, urb->status); 724} 725 726 727/** 728 * tower_interrupt_out_callback 729 */ 730static void tower_interrupt_out_callback (struct urb *urb) 731{ 732 struct lego_usb_tower *dev = (struct lego_usb_tower *)urb->context; 733 734 dbg(4, "%s: enter, status %d", __FUNCTION__, urb->status); 735 lego_usb_tower_debug_data(5, __FUNCTION__, urb->actual_length, urb->transfer_buffer); 736 737 /* sync/async unlink faults aren't errors */ 738 if (urb->status && !(urb->status == -ENOENT || 739 urb->status == -ECONNRESET || 740 urb->status == -ESHUTDOWN)) { 741 dbg(1, "%s - nonzero write bulk status received: %d", 742 __FUNCTION__, urb->status); 743 } 744 745 dev->interrupt_out_busy = 0; 746 wake_up_interruptible(&dev->write_wait); 747 748 lego_usb_tower_debug_data(5, __FUNCTION__, urb->actual_length, urb->transfer_buffer); 749 dbg(4, "%s: leave, status %d", __FUNCTION__, urb->status); 750} 751 752 753/** 754 * tower_probe 755 * 756 * Called by the usb core when a new device is connected that it thinks 757 * this driver might be interested in. 758 */ 759static int tower_probe (struct usb_interface *interface, const struct usb_device_id *id) 760{ 761 struct usb_device *udev = interface_to_usbdev(interface); 762 struct lego_usb_tower *dev = NULL; 763 struct usb_host_interface *iface_desc; 764 struct usb_endpoint_descriptor* endpoint; 765 struct tower_get_version_reply get_version_reply; 766 int i; 767 int retval = -ENOMEM; 768 int result; 769 770 dbg(2, "%s: enter", __FUNCTION__); 771 772 if (udev == NULL) { 773 info ("udev is NULL."); 774 } 775 776 /* allocate memory for our device state and initialize it */ 777 778 dev = kmalloc (sizeof(struct lego_usb_tower), GFP_KERNEL); 779 780 if (dev == NULL) { 781 err ("Out of memory"); 782 goto exit; 783 } 784 785 init_MUTEX (&dev->sem); 786 787 dev->udev = udev; 788 dev->open_count = 0; 789 790 dev->read_buffer = NULL; 791 dev->read_buffer_length = 0; 792 dev->read_packet_length = 0; 793 spin_lock_init (&dev->read_buffer_lock); 794 dev->packet_timeout_jiffies = packet_timeout * HZ / 1000; 795 dev->read_last_arrival = jiffies; 796 797 init_waitqueue_head (&dev->read_wait); 798 init_waitqueue_head (&dev->write_wait); 799 800 dev->interrupt_in_buffer = NULL; 801 dev->interrupt_in_endpoint = NULL; 802 dev->interrupt_in_urb = NULL; 803 dev->interrupt_in_running = 0; 804 dev->interrupt_in_done = 0; 805 806 dev->interrupt_out_buffer = NULL; 807 dev->interrupt_out_endpoint = NULL; 808 dev->interrupt_out_urb = NULL; 809 dev->interrupt_out_busy = 0; 810 811 iface_desc = interface->cur_altsetting; 812 813 /* set up the endpoint information */ 814 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) { 815 endpoint = &iface_desc->endpoint[i].desc; 816 817 if (usb_endpoint_xfer_int(endpoint)) { 818 if (usb_endpoint_dir_in(endpoint)) 819 dev->interrupt_in_endpoint = endpoint; 820 else 821 dev->interrupt_out_endpoint = endpoint; 822 } 823 } 824 if(dev->interrupt_in_endpoint == NULL) { 825 err("interrupt in endpoint not found"); 826 goto error; 827 } 828 if (dev->interrupt_out_endpoint == NULL) { 829 err("interrupt out endpoint not found"); 830 goto error; 831 } 832 833 dev->read_buffer = kmalloc (read_buffer_size, GFP_KERNEL); 834 if (!dev->read_buffer) { 835 err("Couldn't allocate read_buffer"); 836 goto error; 837 } 838 dev->interrupt_in_buffer = kmalloc (le16_to_cpu(dev->interrupt_in_endpoint->wMaxPacketSize), GFP_KERNEL); 839 if (!dev->interrupt_in_buffer) { 840 err("Couldn't allocate interrupt_in_buffer"); 841 goto error; 842 } 843 dev->interrupt_in_urb = usb_alloc_urb(0, GFP_KERNEL); 844 if (!dev->interrupt_in_urb) { 845 err("Couldn't allocate interrupt_in_urb"); 846 goto error; 847 } 848 dev->interrupt_out_buffer = kmalloc (write_buffer_size, GFP_KERNEL); 849 if (!dev->interrupt_out_buffer) { 850 err("Couldn't allocate interrupt_out_buffer"); 851 goto error; 852 } 853 dev->interrupt_out_urb = usb_alloc_urb(0, GFP_KERNEL); 854 if (!dev->interrupt_out_urb) { 855 err("Couldn't allocate interrupt_out_urb"); 856 goto error; 857 } 858 dev->interrupt_in_interval = interrupt_in_interval ? interrupt_in_interval : dev->interrupt_in_endpoint->bInterval; 859 dev->interrupt_out_interval = interrupt_out_interval ? interrupt_out_interval : dev->interrupt_out_endpoint->bInterval; 860 861 /* we can register the device now, as it is ready */ 862 usb_set_intfdata (interface, dev); 863 864 retval = usb_register_dev (interface, &tower_class); 865 866 if (retval) { 867 /* something prevented us from registering this driver */ 868 err ("Not able to get a minor for this device."); 869 usb_set_intfdata (interface, NULL); 870 goto error; 871 } 872 dev->minor = interface->minor; 873 874 /* let the user know what node this device is now attached to */ 875 info ("LEGO USB Tower #%d now attached to major %d minor %d", (dev->minor - LEGO_USB_TOWER_MINOR_BASE), USB_MAJOR, dev->minor); 876 877 /* get the firmware version and log it */ 878 result = usb_control_msg (udev, 879 usb_rcvctrlpipe(udev, 0), 880 LEGO_USB_TOWER_REQUEST_GET_VERSION, 881 USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE, 882 0, 883 0, 884 &get_version_reply, 885 sizeof(get_version_reply), 886 1000); 887 if (result < 0) { 888 err("LEGO USB Tower get version control request failed"); 889 retval = result; 890 goto error; 891 } 892 info("LEGO USB Tower firmware version is %d.%d build %d", 893 get_version_reply.major, 894 get_version_reply.minor, 895 le16_to_cpu(get_version_reply.build_no)); 896 897 898exit: 899 dbg(2, "%s: leave, return value 0x%.8lx (dev)", __FUNCTION__, (long) dev); 900 901 return retval; 902 903error: 904 tower_delete(dev); 905 return retval; 906} 907 908 909/** 910 * tower_disconnect 911 * 912 * Called by the usb core when the device is removed from the system. 913 */ 914static void tower_disconnect (struct usb_interface *interface) 915{ 916 struct lego_usb_tower *dev; 917 int minor; 918 919 dbg(2, "%s: enter", __FUNCTION__); 920 921 mutex_lock (&disconnect_mutex); 922 923 dev = usb_get_intfdata (interface); 924 usb_set_intfdata (interface, NULL); 925 926 927 down (&dev->sem); 928 929 minor = dev->minor; 930 931 /* give back our minor */ 932 usb_deregister_dev (interface, &tower_class); 933 934 /* if the device is not opened, then we clean up right now */ 935 if (!dev->open_count) { 936 up (&dev->sem); 937 tower_delete (dev); 938 } else { 939 dev->udev = NULL; 940 up (&dev->sem); 941 } 942 943 mutex_unlock (&disconnect_mutex); 944 945 info("LEGO USB Tower #%d now disconnected", (minor - LEGO_USB_TOWER_MINOR_BASE)); 946 947 dbg(2, "%s: leave", __FUNCTION__); 948} 949 950 951 952/** 953 * lego_usb_tower_init 954 */ 955static int __init lego_usb_tower_init(void) 956{ 957 int result; 958 int retval = 0; 959 960 dbg(2, "%s: enter", __FUNCTION__); 961 962 /* register this driver with the USB subsystem */ 963 result = usb_register(&tower_driver); 964 if (result < 0) { 965 err("usb_register failed for the "__FILE__" driver. Error number %d", result); 966 retval = -1; 967 goto exit; 968 } 969 970 info(DRIVER_DESC " " DRIVER_VERSION); 971 972exit: 973 dbg(2, "%s: leave, return value %d", __FUNCTION__, retval); 974 975 return retval; 976} 977 978 979/** 980 * lego_usb_tower_exit 981 */ 982static void __exit lego_usb_tower_exit(void) 983{ 984 dbg(2, "%s: enter", __FUNCTION__); 985 986 /* deregister this driver with the USB subsystem */ 987 usb_deregister (&tower_driver); 988 989 dbg(2, "%s: leave", __FUNCTION__); 990} 991 992module_init (lego_usb_tower_init); 993module_exit (lego_usb_tower_exit); 994 995MODULE_AUTHOR(DRIVER_AUTHOR); 996MODULE_DESCRIPTION(DRIVER_DESC); 997#ifdef MODULE_LICENSE 998MODULE_LICENSE("GPL"); 999#endif 1000