libusb/os/darwin_usb.c

   1 /*
   2  * darwin backend for libusb 1.0
   3  * Copyright (C) 2008-2011 Nathan Hjelm <hjelmn@users.sourceforge.net>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  18  */
  19
  20 #include <config.h>
  21 #include <ctype.h>
  22 #include <dirent.h>
  23 #include <errno.h>
  24 #include <fcntl.h>
  25 #include <pthread.h>
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <sys/ioctl.h>
  30 #include <sys/stat.h>
  31 #include <sys/types.h>
  32 #include <unistd.h>
  33 #include <libkern/OSAtomic.h>
  34
  35 #include <mach/clock.h>
  36 #include <mach/clock_types.h>
  37 #include <mach/mach_host.h>
  38 #include <mach/mach_port.h>
  39
  40 #include <AvailabilityMacros.h>
  41 #if MAC_OS_X_VERSION_MIN_REQUIRED >= 1060
  42   #include <objc/objc-auto.h>
  43 #endif
  44
  45 #include <IOKit/IOCFBundle.h>
  46 #include <IOKit/usb/IOUSBLib.h>
  47 #include <IOKit/IOCFPlugIn.h>
  48
  49 #include "darwin_usb.h"
  50
  51 /* async event thread */
  52 static pthread_mutex_t libusb_darwin_at_mutex;
  53 static pthread_cond_t  libusb_darwin_at_cond;
  54
  55 static clock_serv_t clock_realtime;
  56 static clock_serv_t clock_monotonic;
  57
  58 static CFRunLoopRef libusb_darwin_acfl = NULL; /* async cf loop */
  59 static volatile int32_t initCount = 0;
  60
  61 /* async event thread */
  62 static pthread_t libusb_darwin_at;
  63
  64 static int darwin_get_config_descriptor(struct libusb_device *dev, uint8_t config_index, unsigned char *buffer, size_t len, int *host_endian);
  65 static int darwin_claim_interface(struct libusb_device_handle *dev_handle, int iface);
  66 static int darwin_release_interface(struct libusb_device_handle *dev_handle, int iface);
  67 static int darwin_reset_device(struct libusb_device_handle *dev_handle);
  68 static void darwin_async_io_callback (void *refcon, IOReturn result, void *arg0);
  69
  70 static const char *darwin_error_str (int result) {
  71   switch (result) {
  72   case kIOReturnSuccess:
  73     return "no error";
  74   case kIOReturnNotOpen:
  75     return "device not opened for exclusive access";
  76   case kIOReturnNoDevice:
  77     return "no connection to an IOService";
  78   case kIOUSBNoAsyncPortErr:
  79     return "no async port has been opened for interface";
  80   case kIOReturnExclusiveAccess:
  81     return "another process has device opened for exclusive access";
  82   case kIOUSBPipeStalled:
  83     return "pipe is stalled";
  84   case kIOReturnError:
  85     return "could not establish a connection to the Darwin kernel";
  86   case kIOUSBTransactionTimeout:
  87     return "transaction timed out";
  88   case kIOReturnBadArgument:
  89     return "invalid argument";
  90   case kIOReturnAborted:
  91     return "transaction aborted";
  92   case kIOReturnNotResponding:
  93     return "device not responding";
  94   case kIOReturnOverrun:
  95     return "data overrun";
  96   case kIOReturnCannotWire:
  97     return "physical memory can not be wired down";
  98   default:
  99     return "unknown error";
 100   }
 101 }
 102
 103 static int darwin_to_libusb (int result) {
 104   switch (result) {
 105   case kIOReturnUnderrun:
 106   case kIOReturnSuccess:
 107     return LIBUSB_SUCCESS;
 108   case kIOReturnNotOpen:
 109   case kIOReturnNoDevice:
 110     return LIBUSB_ERROR_NO_DEVICE;
 111   case kIOReturnExclusiveAccess:
 112     return LIBUSB_ERROR_ACCESS;
 113   case kIOUSBPipeStalled:
 114     return LIBUSB_ERROR_PIPE;
 115   case kIOReturnBadArgument:
 116     return LIBUSB_ERROR_INVALID_PARAM;
 117   case kIOUSBTransactionTimeout:
 118     return LIBUSB_ERROR_TIMEOUT;
 119   case kIOReturnNotResponding:
 120   case kIOReturnAborted:
 121   case kIOReturnError:
 122   case kIOUSBNoAsyncPortErr:
 123   default:
 124     return LIBUSB_ERROR_OTHER;
 125   }
 126 }
 127
 128
 129 static int ep_to_pipeRef(struct libusb_device_handle *dev_handle, uint8_t ep, uint8_t *pipep, uint8_t *ifcp) {
 130   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)dev_handle->os_priv;
 131
 132   /* current interface */
 133   struct darwin_interface *cInterface;
 134
 135   int8_t i, iface;
 136
 137   usbi_info (HANDLE_CTX(dev_handle), "converting ep address 0x%02x to pipeRef and interface", ep);
 138
 139   for (iface = 0 ; iface < USB_MAXINTERFACES ; iface++) {
 140     cInterface = &priv->interfaces[iface];
 141
 142     if (dev_handle->claimed_interfaces & (1 << iface)) {
 143       for (i = 0 ; i < cInterface->num_endpoints ; i++) {
 144         if (cInterface->endpoint_addrs[i] == ep) {
 145           *pipep = i + 1;
 146           *ifcp = iface;
 147           usbi_info (HANDLE_CTX(dev_handle), "pipe %d on interface %d matches", *pipep, *ifcp);
 148           return 0;
 149         }
 150       }
 151     }
 152   }
 153
 154   /* No pipe found with the correct endpoint address */
 155   usbi_warn (HANDLE_CTX(dev_handle), "no pipeRef found with endpoint address 0x%02x.", ep);
 156
 157   return -1;
 158 }
 159
 160 static int usb_setup_device_iterator (io_iterator_t *deviceIterator, long location) {
 161   CFMutableDictionaryRef matchingDict = IOServiceMatching(kIOUSBDeviceClassName);
 162
 163   if (!matchingDict)
 164     return kIOReturnError;
 165
 166   if (location) {
 167     CFMutableDictionaryRef propertyMatchDict = CFDictionaryCreateMutable(kCFAllocatorDefault, 0,
 168                                                                          &kCFTypeDictionaryKeyCallBacks,
 169                                                                          &kCFTypeDictionaryValueCallBacks);
 170
 171     if (propertyMatchDict) {
 172       CFTypeRef locationCF = CFNumberCreate (NULL, kCFNumberLongType, &location);
 173
 174       CFDictionarySetValue (propertyMatchDict, CFSTR(kUSBDevicePropertyLocationID), locationCF);
 175       /* release our reference to the CFNumber (CFDictionarySetValue retains it) */
 176       CFRelease (locationCF);
 177
 178       CFDictionarySetValue (matchingDict, CFSTR(kIOPropertyMatchKey), propertyMatchDict);
 179       /* release out reference to the CFMutableDictionaryRef (CFDictionarySetValue retains it) */
 180       CFRelease (propertyMatchDict);
 181     }
 182     /* else we can still proceed as long as the caller accounts for the possibility of other devices in the iterator */
 183   }
 184
 185   return IOServiceGetMatchingServices(kIOMasterPortDefault, matchingDict, deviceIterator);
 186 }
 187
 188 static usb_device_t **usb_get_next_device (io_iterator_t deviceIterator, UInt32 *locationp) {
 189   io_cf_plugin_ref_t *plugInInterface = NULL;
 190   usb_device_t **device;
 191   io_service_t usbDevice;
 192   long result;
 193   SInt32 score;
 194
 195   if (!IOIteratorIsValid (deviceIterator))
 196     return NULL;
 197
 198
 199   while ((usbDevice = IOIteratorNext(deviceIterator))) {
 200     result = IOCreatePlugInInterfaceForService(usbDevice, kIOUSBDeviceUserClientTypeID,
 201                                                kIOCFPlugInInterfaceID, &plugInInterface,
 202                                                &score);
 203
 204     /* we are done with the usb_device_t */
 205     (void)IOObjectRelease(usbDevice);
 206     if (kIOReturnSuccess == result && plugInInterface)
 207       break;
 208
 209     usbi_dbg ("libusb/darwin.c usb_get_next_device: could not set up plugin for service: %s\n", darwin_error_str (result));
 210   }
 211
 212   if (!usbDevice)
 213     return NULL;
 214
 215   (void)(*plugInInterface)->QueryInterface(plugInInterface, CFUUIDGetUUIDBytes(DeviceInterfaceID),
 216                                            (LPVOID)&device);
 217
 218   (*plugInInterface)->Stop(plugInInterface);
 219   IODestroyPlugInInterface (plugInInterface);
 220
 221   /* get the location from the device */
 222   if (locationp)
 223     (*(device))->GetLocationID(device, locationp);
 224
 225   return device;
 226 }
 227
 228 static kern_return_t darwin_get_device (uint32_t dev_location, usb_device_t ***darwin_device) {
 229   kern_return_t kresult;
 230   UInt32        location;
 231   io_iterator_t deviceIterator;
 232
 233   kresult = usb_setup_device_iterator (&deviceIterator, dev_location);
 234   if (kresult)
 235     return kresult;
 236
 237   /* This port of libusb uses locations to keep track of devices. */
 238   while ((*darwin_device = usb_get_next_device (deviceIterator, &location)) != NULL) {
 239     if (location == dev_location)
 240       break;
 241
 242     (**darwin_device)->Release(*darwin_device);
 243   }
 244
 245   IOObjectRelease (deviceIterator);
 246
 247   if (!(*darwin_device))
 248     return kIOReturnNoDevice;
 249
 250   return kIOReturnSuccess;
 251 }
 252
 253
 254
 255 static void darwin_devices_detached (void *ptr, io_iterator_t rem_devices) {
 256   struct libusb_context *ctx = (struct libusb_context *)ptr;
 257   struct libusb_device_handle *handle;
 258   struct darwin_device_priv *dpriv;
 259   struct darwin_device_handle_priv *priv;
 260
 261   io_service_t device;
 262   long location;
 263   bool locationValid;
 264   CFTypeRef locationCF;
 265   UInt32 message;
 266
 267   usbi_info (ctx, "a device has been detached");
 268
 269   while ((device = IOIteratorNext (rem_devices)) != 0) {
 270     /* get the location from the i/o registry */
 271     locationCF = IORegistryEntryCreateCFProperty (device, CFSTR(kUSBDevicePropertyLocationID), kCFAllocatorDefault, 0);
 272
 273     IOObjectRelease (device);
 274
 275     if (!locationCF)
 276       continue;
 277
 278     locationValid = CFGetTypeID(locationCF) == CFNumberGetTypeID() &&
 279             CFNumberGetValue(locationCF, kCFNumberLongType, &location);
 280
 281     CFRelease (locationCF);
 282
 283     if (!locationValid)
 284       continue;
 285
 286     usbi_mutex_lock(&ctx->open_devs_lock);
 287     list_for_each_entry(handle, &ctx->open_devs, list, struct libusb_device_handle) {
 288       dpriv = (struct darwin_device_priv *)handle->dev->os_priv;
 289
 290       /* the device may have been opened several times. write to each handle's event descriptor */
 291       if (dpriv->location == location  && handle->os_priv) {
 292         priv  = (struct darwin_device_handle_priv *)handle->os_priv;
 293
 294         message = MESSAGE_DEVICE_GONE;
 295         write (priv->fds[1], &message, sizeof (message));
 296       }
 297     }
 298
 299     usbi_mutex_unlock(&ctx->open_devs_lock);
 300   }
 301 }
 302
 303 static void darwin_clear_iterator (io_iterator_t iter) {
 304   io_service_t device;
 305
 306   while ((device = IOIteratorNext (iter)) != 0)
 307     IOObjectRelease (device);
 308 }
 309
 310 static void *event_thread_main (void *arg0) {
 311   IOReturn kresult;
 312   struct libusb_context *ctx = (struct libusb_context *)arg0;
 313   CFRunLoopRef runloop;
 314
 315   /* Set this thread's name, so it can be seen in the debugger
 316      and crash reports. */
 317 #if MAC_OS_X_VERSION_MIN_REQUIRED >= 1060
 318   pthread_setname_np ("org.libusb.device-detach");
 319 #endif
 320
 321   /* Tell the Objective-C garbage collector about this thread.
 322      This is required because, unlike NSThreads, pthreads are
 323      not automatically registered. Although we don't use
 324      Objective-C, we use CoreFoundation, which does. */
 325 #if MAC_OS_X_VERSION_MIN_REQUIRED >= 1060
 326   objc_registerThreadWithCollector();
 327 #endif
 328
 329   /* hotplug (device removal) source */
 330   CFRunLoopSourceRef     libusb_notification_cfsource;
 331   io_notification_port_t libusb_notification_port;
 332   io_iterator_t          libusb_rem_device_iterator;
 333
 334   usbi_info (ctx, "creating hotplug event source");
 335
 336   runloop = CFRunLoopGetCurrent ();
 337   CFRetain (runloop);
 338
 339   /* add the notification port to the run loop */
 340   libusb_notification_port     = IONotificationPortCreate (kIOMasterPortDefault);
 341   libusb_notification_cfsource = IONotificationPortGetRunLoopSource (libusb_notification_port);
 342   CFRunLoopAddSource(runloop, libusb_notification_cfsource, kCFRunLoopDefaultMode);
 343
 344   /* create notifications for removed devices */
 345   kresult = IOServiceAddMatchingNotification (libusb_notification_port, kIOTerminatedNotification,
 346                                               IOServiceMatching(kIOUSBDeviceClassName),
 347                                               (IOServiceMatchingCallback)darwin_devices_detached,
 348                                               (void *)ctx, &libusb_rem_device_iterator);
 349
 350   if (kresult != kIOReturnSuccess) {
 351     usbi_err (ctx, "could not add hotplug event source: %s", darwin_error_str (kresult));
 352
 353     pthread_exit (NULL);
 354   }
 355
 356   /* arm notifiers */
 357   darwin_clear_iterator (libusb_rem_device_iterator);
 358
 359   usbi_info (ctx, "thread ready to receive events");
 360
 361   /* let the main thread know about the async runloop */
 362   libusb_darwin_acfl = runloop;
 363
 364   /* signal the main thread */
 365   pthread_mutex_lock (&libusb_darwin_at_mutex);
 366   pthread_cond_signal (&libusb_darwin_at_cond);
 367   pthread_mutex_unlock (&libusb_darwin_at_mutex);
 368
 369   /* run the runloop */
 370   CFRunLoopRun();
 371
 372   usbi_info (ctx, "thread exiting");
 373
 374   /* delete notification port */
 375   IONotificationPortDestroy (libusb_notification_port);
 376   IOObjectRelease (libusb_rem_device_iterator);
 377
 378   CFRelease (runloop);
 379
 380   libusb_darwin_acfl = NULL;
 381
 382   pthread_exit (NULL);
 383 }
 384
 385 static int darwin_init(struct libusb_context *ctx) {
 386   host_name_port_t host_self;
 387
 388   if (OSAtomicIncrement32Barrier(&initCount) == 1) {
 389     /* create the clocks that will be used */
 390
 391     host_self = mach_host_self();
 392     host_get_clock_service(host_self, CALENDAR_CLOCK, &clock_realtime);
 393     host_get_clock_service(host_self, SYSTEM_CLOCK, &clock_monotonic);
 394     mach_port_deallocate(mach_task_self(), host_self);
 395
 396     pthread_mutex_init (&libusb_darwin_at_mutex, NULL);
 397     pthread_cond_init (&libusb_darwin_at_cond, NULL);
 398
 399     pthread_create (&libusb_darwin_at, NULL, event_thread_main, (void *)ctx);
 400
 401     pthread_mutex_lock (&libusb_darwin_at_mutex);
 402     while (!libusb_darwin_acfl)
 403       pthread_cond_wait (&libusb_darwin_at_cond, &libusb_darwin_at_mutex);
 404     pthread_mutex_unlock (&libusb_darwin_at_mutex);
 405   }
 406
 407   return 0;
 408 }
 409
 410 static void darwin_exit (void) {
 411   if (OSAtomicDecrement32Barrier(&initCount) == 0) {
 412     mach_port_deallocate(mach_task_self(), clock_realtime);
 413     mach_port_deallocate(mach_task_self(), clock_monotonic);
 414
 415     /* stop the async runloop */
 416     CFRunLoopStop (libusb_darwin_acfl);
 417     pthread_join (libusb_darwin_at, NULL);
 418   }
 419 }
 420
 421 static int darwin_get_device_descriptor(struct libusb_device *dev, unsigned char *buffer, int *host_endian) {
 422   struct darwin_device_priv *priv = (struct darwin_device_priv *)dev->os_priv;
 423
 424   /* return cached copy */
 425   memmove (buffer, &(priv->dev_descriptor), DEVICE_DESC_LENGTH);
 426
 427   *host_endian = 0;
 428
 429   return 0;
 430 }
 431
 432 static int get_configuration_index (struct libusb_device *dev, int config_value) {
 433   struct darwin_device_priv *priv = (struct darwin_device_priv *)dev->os_priv;
 434   UInt8 i, numConfig;
 435   IOUSBConfigurationDescriptorPtr desc;
 436   IOReturn kresult;
 437
 438   /* is there a simpler way to determine the index? */
 439   kresult = (*(priv->device))->GetNumberOfConfigurations (priv->device, &numConfig);
 440   if (kresult != kIOReturnSuccess)
 441     return darwin_to_libusb (kresult);
 442
 443   for (i = 0 ; i < numConfig ; i++) {
 444     (*(priv->device))->GetConfigurationDescriptorPtr (priv->device, i, &desc);
 445
 446     if (desc->bConfigurationValue == config_value)
 447       return i;
 448   }
 449
 450   /* configuration not found */
 451   return LIBUSB_ERROR_OTHER;
 452 }
 453
 454 static int darwin_get_active_config_descriptor(struct libusb_device *dev, unsigned char *buffer, size_t len, int *host_endian) {
 455   struct darwin_device_priv *priv = (struct darwin_device_priv *)dev->os_priv;
 456   int config_index;
 457
 458   if (0 == priv->active_config)
 459     return LIBUSB_ERROR_INVALID_PARAM;
 460
 461   config_index = get_configuration_index (dev, priv->active_config);
 462   if (config_index < 0)
 463     return config_index;
 464
 465   return darwin_get_config_descriptor (dev, config_index, buffer, len, host_endian);
 466 }
 467
 468 static int darwin_get_config_descriptor(struct libusb_device *dev, uint8_t config_index, unsigned char *buffer, size_t len, int *host_endian) {
 469   struct darwin_device_priv *priv = (struct darwin_device_priv *)dev->os_priv;
 470   IOUSBConfigurationDescriptorPtr desc;
 471   IOReturn kresult;
 472   usb_device_t **device = NULL;
 473
 474   if (!priv)
 475     return LIBUSB_ERROR_OTHER;
 476
 477   if (!priv->device) {
 478     kresult = darwin_get_device (priv->location, &device);
 479     if (kresult || !device) {
 480       usbi_err (DEVICE_CTX (dev), "could not find device: %s", darwin_error_str (kresult));
 481
 482       return darwin_to_libusb (kresult);
 483     }
 484
 485     /* don't have to open the device to get a config descriptor */
 486   } else
 487     device = priv->device;
 488
 489   kresult = (*device)->GetConfigurationDescriptorPtr (device, config_index, &desc);
 490   if (kresult == kIOReturnSuccess) {
 491     /* copy descriptor */
 492     if (libusb_le16_to_cpu(desc->wTotalLength) < len)
 493       len = libusb_le16_to_cpu(desc->wTotalLength);
 494
 495     memmove (buffer, desc, len);
 496
 497     /* GetConfigurationDescriptorPtr returns the descriptor in USB bus order */
 498     *host_endian = 0;
 499   }
 500
 501   if (!priv->device)
 502     (*device)->Release (device);
 503
 504   return darwin_to_libusb (kresult);
 505 }
 506
 507 /* check whether the os has configured the device */
 508 static int darwin_check_configuration (struct libusb_context *ctx, struct libusb_device *dev, usb_device_t **darwin_device) {
 509   struct darwin_device_priv *priv = (struct darwin_device_priv *)dev->os_priv;
 510
 511   IOUSBConfigurationDescriptorPtr configDesc;
 512   IOUSBFindInterfaceRequest request;
 513   kern_return_t             kresult;
 514   io_iterator_t             interface_iterator;
 515   io_service_t              firstInterface;
 516
 517   if (priv->dev_descriptor.bNumConfigurations < 1) {
 518     usbi_err (ctx, "device has no configurations");
 519     return LIBUSB_ERROR_OTHER; /* no configurations at this speed so we can't use it */
 520   }
 521
 522   /* find the first configuration */
 523   kresult = (*darwin_device)->GetConfigurationDescriptorPtr (darwin_device, 0, &configDesc);
 524   priv->first_config = (kIOReturnSuccess == kresult) ? configDesc->bConfigurationValue : 1;
 525
 526   /* check if the device is already configured. there is probably a better way than iterating over the
 527      to accomplish this (the trick is we need to avoid a call to GetConfigurations since buggy devices
 528      might lock up on the device request) */
 529
 530   /* Setup the Interface Request */
 531   request.bInterfaceClass    = kIOUSBFindInterfaceDontCare;
 532   request.bInterfaceSubClass = kIOUSBFindInterfaceDontCare;
 533   request.bInterfaceProtocol = kIOUSBFindInterfaceDontCare;
 534   request.bAlternateSetting  = kIOUSBFindInterfaceDontCare;
 535
 536   kresult = (*(darwin_device))->CreateInterfaceIterator(darwin_device, &request, &interface_iterator);
 537   if (kresult)
 538     return darwin_to_libusb (kresult);
 539
 540   /* iterate once */
 541   firstInterface = IOIteratorNext(interface_iterator);
 542
 543   /* done with the interface iterator */
 544   IOObjectRelease(interface_iterator);
 545
 546   if (firstInterface) {
 547     IOObjectRelease (firstInterface);
 548
 549     /* device is configured */
 550     if (priv->dev_descriptor.bNumConfigurations == 1)
 551       /* to avoid problems with some devices get the configurations value from the configuration descriptor */
 552       priv->active_config = priv->first_config;
 553     else
 554       /* devices with more than one configuration should work with GetConfiguration */
 555       (*darwin_device)->GetConfiguration (darwin_device, &priv->active_config);
 556   } else
 557     /* not configured */
 558     priv->active_config = 0;
 559
 560   usbi_info (ctx, "active config: %u, first config: %u", priv->active_config, priv->first_config);
 561
 562   return 0;
 563 }
 564
 565 static int darwin_cache_device_descriptor (struct libusb_context *ctx, struct libusb_device *dev, usb_device_t **device) {
 566   struct darwin_device_priv *priv;
 567   int retries = 5, delay = 30000;
 568   int unsuspended = 0, try_unsuspend = 1, try_reconfigure = 1;
 569   int is_open = 0;
 570   int ret = 0, ret2;
 571   IOUSBDevRequest req;
 572   UInt8 bDeviceClass;
 573   UInt16 idProduct, idVendor;
 574
 575   (*device)->GetDeviceClass (device, &bDeviceClass);
 576   (*device)->GetDeviceProduct (device, &idProduct);
 577   (*device)->GetDeviceVendor (device, &idVendor);
 578
 579   priv = (struct darwin_device_priv *)dev->os_priv;
 580
 581   /* try to open the device (we can usually continue even if this fails) */
 582   is_open = ((*device)->USBDeviceOpenSeize(device) == kIOReturnSuccess);
 583
 584   /**** retrieve device descriptor ****/
 585   do {
 586     /* Set up request for device descriptor */
 587     memset (&(priv->dev_descriptor), 0, sizeof(IOUSBDeviceDescriptor));
 588     req.bmRequestType = USBmakebmRequestType(kUSBIn, kUSBStandard, kUSBDevice);
 589     req.bRequest      = kUSBRqGetDescriptor;
 590     req.wValue        = kUSBDeviceDesc << 8;
 591     req.wIndex        = 0;
 592     req.wLength       = sizeof(priv->dev_descriptor);
 593     req.pData         = &(priv->dev_descriptor);
 594
 595     /* according to Apple's documentation the device must be open for DeviceRequest but we may not be able to open some
 596      * devices and Apple's USB Prober doesn't bother to open the device before issuing a descriptor request.  Still,
 597      * to follow the spec as closely as possible, try opening the device */
 598
 599     ret = (*(device))->DeviceRequest (device, &req);
 600
 601     if (kIOReturnOverrun == ret && kUSBDeviceDesc == priv->dev_descriptor.bDescriptorType)
 602       /* received an overrun error but we still received a device descriptor */
 603       ret = kIOReturnSuccess;
 604
 605     if (kIOReturnSuccess == ret && (0 == priv->dev_descriptor.idProduct ||
 606                                     0 == priv->dev_descriptor.bNumConfigurations ||
 607                                     0 == priv->dev_descriptor.bcdUSB)) {
 608       /* work around for incorrectly configured devices */
 609       if (try_reconfigure && is_open) {
 610         usbi_dbg("descriptor appears to be invalid. resetting configuration before trying again...");
 611
 612         /* set the first configuration */
 613         (*device)->SetConfiguration(device, 1);
 614
 615         /* don't try to reconfigure again */
 616         try_reconfigure = 0;
 617       }
 618
 619       ret = kIOUSBPipeStalled;
 620     }
 621
 622     if (kIOReturnSuccess != ret && is_open && try_unsuspend) {
 623       /* device may be suspended. unsuspend it and try again */
 624 #if DeviceVersion >= 320
 625       UInt32 info;
 626
 627       /* IOUSBFamily 320+ provides a way to detect device suspension but earlier versions do not */
 628       (void)(*device)->GetUSBDeviceInformation (device, &info);
 629
 630       try_unsuspend = info & (1 << kUSBInformationDeviceIsSuspendedBit);
 631 #endif
 632
 633       if (try_unsuspend) {
 634         /* resume the device */
 635         ret2 = (*device)->USBDeviceSuspend (device, 0);
 636         if (kIOReturnSuccess != ret2) {
 637           /* prevent log spew from poorly behaving devices.  this indicates the
 638              os actually had trouble communicating with the device */
 639           usbi_dbg("could not retrieve device descriptor. failed to unsuspend: %s",darwin_error_str(ret2));
 640         } else
 641           unsuspended = 1;
 642
 643         try_unsuspend = 0;
 644       }
 645     }
 646
 647     if (kIOReturnSuccess != ret) {
 648       usbi_dbg("kernel responded with code: 0x%08x. sleeping for %d ms before trying again", ret, delay/1000);
 649       /* sleep for a little while before trying again */
 650       usleep (delay);
 651     }
 652   } while (kIOReturnSuccess != ret && retries--);
 653
 654   if (unsuspended)
 655     /* resuspend the device */
 656     (void)(*device)->USBDeviceSuspend (device, 1);
 657
 658   if (is_open)
 659     (void) (*device)->USBDeviceClose (device);
 660
 661   if (ret != kIOReturnSuccess) {
 662     /* a debug message was already printed out for this error */
 663     if (LIBUSB_CLASS_HUB == bDeviceClass)
 664       usbi_dbg ("could not retrieve device descriptor %.4x:%.4x: %s. skipping device", idVendor, idProduct, darwin_error_str (ret));
 665     else
 666       usbi_warn (ctx, "could not retrieve device descriptor %.4x:%.4x: %s. skipping device", idVendor, idProduct, darwin_error_str (ret));
 667
 668     return -1;
 669   }
 670
 671   usbi_dbg ("device descriptor:");
 672   usbi_dbg (" bDescriptorType:    0x%02x", priv->dev_descriptor.bDescriptorType);
 673   usbi_dbg (" bcdUSB:             0x%04x", priv->dev_descriptor.bcdUSB);
 674   usbi_dbg (" bDeviceClass:       0x%02x", priv->dev_descriptor.bDeviceClass);
 675   usbi_dbg (" bDeviceSubClass:    0x%02x", priv->dev_descriptor.bDeviceSubClass);
 676   usbi_dbg (" bDeviceProtocol:    0x%02x", priv->dev_descriptor.bDeviceProtocol);
 677   usbi_dbg (" bMaxPacketSize0:    0x%02x", priv->dev_descriptor.bMaxPacketSize0);
 678   usbi_dbg (" idVendor:           0x%04x", priv->dev_descriptor.idVendor);
 679   usbi_dbg (" idProduct:          0x%04x", priv->dev_descriptor.idProduct);
 680   usbi_dbg (" bcdDevice:          0x%04x", priv->dev_descriptor.bcdDevice);
 681   usbi_dbg (" iManufacturer:      0x%02x", priv->dev_descriptor.iManufacturer);
 682   usbi_dbg (" iProduct:           0x%02x", priv->dev_descriptor.iProduct);
 683   usbi_dbg (" iSerialNumber:      0x%02x", priv->dev_descriptor.iSerialNumber);
 684   usbi_dbg (" bNumConfigurations: 0x%02x", priv->dev_descriptor.bNumConfigurations);
 685
 686   /* catch buggy hubs (which appear to be virtual). Apple's own USB prober has problems with these devices. */
 687   if (libusb_le16_to_cpu (priv->dev_descriptor.idProduct) != idProduct) {
 688     /* not a valid device */
 689     usbi_warn (ctx, "idProduct from iokit (%04x) does not match idProduct in descriptor (%04x). skipping device",
 690                idProduct, libusb_le16_to_cpu (priv->dev_descriptor.idProduct));
 691     return -1;
 692   }
 693
 694   return 0;
 695 }
 696
 697 static int process_new_device (struct libusb_context *ctx, usb_device_t **device, UInt32 locationID, struct discovered_devs **_discdevs) {
 698   struct darwin_device_priv *priv;
 699   struct libusb_device *dev;
 700   struct discovered_devs *discdevs;
 701   UInt16                address;
 702   UInt8                 devSpeed;
 703   int ret = 0, need_unref = 0;
 704
 705   do {
 706     dev = usbi_get_device_by_session_id(ctx, locationID);
 707     if (!dev) {
 708       usbi_info (ctx, "allocating new device for location 0x%08x", locationID);
 709       dev = usbi_alloc_device(ctx, locationID);
 710       need_unref = 1;
 711     } else
 712       usbi_info (ctx, "using existing device for location 0x%08x", locationID);
 713
 714     if (!dev) {
 715       ret = LIBUSB_ERROR_NO_MEM;
 716       break;
 717     }
 718
 719     priv = (struct darwin_device_priv *)dev->os_priv;
 720
 721     (*device)->GetDeviceAddress (device, (USBDeviceAddress *)&address);
 722
 723     ret = darwin_cache_device_descriptor (ctx, dev, device);
 724     if (ret < 0)
 725       break;
 726
 727     /* check current active configuration (and cache the first configuration value-- which may be used by claim_interface) */
 728     ret = darwin_check_configuration (ctx, dev, device);
 729     if (ret < 0)
 730       break;
 731
 732     dev->bus_number     = locationID >> 24;
 733     dev->device_address = address;
 734
 735     (*device)->GetDeviceSpeed (device, &devSpeed);
 736
 737     switch (devSpeed) {
 738     case kUSBDeviceSpeedLow: dev->speed = LIBUSB_SPEED_LOW; break;
 739     case kUSBDeviceSpeedFull: dev->speed = LIBUSB_SPEED_FULL; break;
 740     case kUSBDeviceSpeedHigh: dev->speed = LIBUSB_SPEED_HIGH; break;
 741     default:
 742       usbi_warn (ctx, "Got unknown device speed %d", devSpeed);
 743     }
 744
 745     /* save our location, we'll need this later */
 746     priv->location = locationID;
 747     snprintf(priv->sys_path, 20, "%03i-%04x-%04x-%02x-%02x", address, priv->dev_descriptor.idVendor, priv->dev_descriptor.idProduct,
 748              priv->dev_descriptor.bDeviceClass, priv->dev_descriptor.bDeviceSubClass);
 749
 750     ret = usbi_sanitize_device (dev);
 751     if (ret < 0)
 752       break;
 753
 754     /* append the device to the list of discovered devices */
 755     discdevs = discovered_devs_append(*_discdevs, dev);
 756     if (!discdevs) {
 757       ret = LIBUSB_ERROR_NO_MEM;
 758       break;
 759     }
 760
 761     *_discdevs = discdevs;
 762
 763     usbi_info (ctx, "found device with address %d at %s", dev->device_address, priv->sys_path);
 764   } while (0);
 765
 766   if (need_unref)
 767     libusb_unref_device(dev);
 768
 769   return ret;
 770 }
 771
 772 static int darwin_get_device_list(struct libusb_context *ctx, struct discovered_devs **_discdevs) {
 773   io_iterator_t        deviceIterator;
 774   usb_device_t         **device;
 775   kern_return_t        kresult;
 776   UInt32               location;
 777
 778   kresult = usb_setup_device_iterator (&deviceIterator, 0);
 779   if (kresult != kIOReturnSuccess)
 780     return darwin_to_libusb (kresult);
 781
 782   while ((device = usb_get_next_device (deviceIterator, &location)) != NULL) {
 783     (void) process_new_device (ctx, device, location, _discdevs);
 784
 785     (*(device))->Release(device);
 786   }
 787
 788   IOObjectRelease(deviceIterator);
 789
 790   return 0;
 791 }
 792
 793 static int darwin_open (struct libusb_device_handle *dev_handle) {
 794   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)dev_handle->os_priv;
 795   struct darwin_device_priv *dpriv = (struct darwin_device_priv *)dev_handle->dev->os_priv;
 796   usb_device_t  **darwin_device;
 797   IOReturn kresult;
 798
 799   if (0 == dpriv->open_count) {
 800     kresult = darwin_get_device (dpriv->location, &darwin_device);
 801     if (kresult) {
 802       usbi_err (HANDLE_CTX (dev_handle), "could not find device: %s", darwin_error_str (kresult));
 803       return darwin_to_libusb (kresult);
 804     }
 805
 806     dpriv->device = darwin_device;
 807
 808     /* try to open the device */
 809     kresult = (*(dpriv->device))->USBDeviceOpenSeize (dpriv->device);
 810
 811     if (kresult != kIOReturnSuccess) {
 812       usbi_err (HANDLE_CTX (dev_handle), "USBDeviceOpen: %s", darwin_error_str(kresult));
 813
 814       switch (kresult) {
 815       case kIOReturnExclusiveAccess:
 816         /* it is possible to perform some actions on a device that is not open so do not return an error */
 817         priv->is_open = 0;
 818
 819         break;
 820       default:
 821         (*(dpriv->device))->Release (dpriv->device);
 822         dpriv->device = NULL;
 823         return darwin_to_libusb (kresult);
 824       }
 825     } else {
 826       /* create async event source */
 827       kresult = (*(dpriv->device))->CreateDeviceAsyncEventSource (dpriv->device, &priv->cfSource);
 828       if (kresult != kIOReturnSuccess) {
 829         usbi_err (HANDLE_CTX (dev_handle), "CreateDeviceAsyncEventSource: %s", darwin_error_str(kresult));
 830
 831         (*(dpriv->device))->USBDeviceClose (dpriv->device);
 832         (*(dpriv->device))->Release (dpriv->device);
 833
 834         dpriv->device = NULL;
 835         return darwin_to_libusb (kresult);
 836       }
 837
 838       priv->is_open = 1;
 839
 840       CFRetain (libusb_darwin_acfl);
 841
 842       /* add the cfSource to the aync run loop */
 843       CFRunLoopAddSource(libusb_darwin_acfl, priv->cfSource, kCFRunLoopCommonModes);
 844     }
 845   }
 846
 847   /* device opened successfully */
 848   dpriv->open_count++;
 849
 850   /* create a file descriptor for notifications */
 851   pipe (priv->fds);
 852
 853   /* set the pipe to be non-blocking */
 854   fcntl (priv->fds[1], F_SETFD, O_NONBLOCK);
 855
 856   usbi_add_pollfd(HANDLE_CTX(dev_handle), priv->fds[0], POLLIN);
 857
 858   usbi_info (HANDLE_CTX (dev_handle), "device open for access");
 859
 860   return 0;
 861 }
 862
 863 static void darwin_close (struct libusb_device_handle *dev_handle) {
 864   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)dev_handle->os_priv;
 865   struct darwin_device_priv *dpriv = (struct darwin_device_priv *)dev_handle->dev->os_priv;
 866   IOReturn kresult;
 867   int i;
 868
 869   if (dpriv->open_count == 0) {
 870     /* something is probably very wrong if this is the case */
 871     usbi_err (HANDLE_CTX (dev_handle), "Close called on a device that was not open!\n");
 872     return;
 873   }
 874
 875   dpriv->open_count--;
 876
 877   /* make sure all interfaces are released */
 878   for (i = 0 ; i < USB_MAXINTERFACES ; i++)
 879     if (dev_handle->claimed_interfaces & (1 << i))
 880       libusb_release_interface (dev_handle, i);
 881
 882   if (0 == dpriv->open_count) {
 883     if (priv->is_open) {
 884       /* delete the device's async event source */
 885       if (priv->cfSource) {
 886         CFRunLoopRemoveSource (libusb_darwin_acfl, priv->cfSource, kCFRunLoopDefaultMode);
 887         CFRelease (priv->cfSource);
 888       }
 889
 890       /* close the device */
 891       kresult = (*(dpriv->device))->USBDeviceClose(dpriv->device);
 892       if (kresult) {
 893         /* Log the fact that we had a problem closing the file, however failing a
 894          * close isn't really an error, so return success anyway */
 895         usbi_err (HANDLE_CTX (dev_handle), "USBDeviceClose: %s", darwin_error_str(kresult));
 896       }
 897     }
 898
 899     kresult = (*(dpriv->device))->Release(dpriv->device);
 900     if (kresult) {
 901       /* Log the fact that we had a problem closing the file, however failing a
 902        * close isn't really an error, so return success anyway */
 903       usbi_err (HANDLE_CTX (dev_handle), "Release: %s", darwin_error_str(kresult));
 904     }
 905
 906     dpriv->device = NULL;
 907   }
 908
 909   /* file descriptors are maintained per-instance */
 910   usbi_remove_pollfd (HANDLE_CTX (dev_handle), priv->fds[0]);
 911   close (priv->fds[1]);
 912   close (priv->fds[0]);
 913
 914   priv->fds[0] = priv->fds[1] = -1;
 915 }
 916
 917 static int darwin_get_configuration(struct libusb_device_handle *dev_handle, int *config) {
 918   struct darwin_device_priv *dpriv = (struct darwin_device_priv *)dev_handle->dev->os_priv;
 919
 920   *config = (int) dpriv->active_config;
 921
 922   return 0;
 923 }
 924
 925 static int darwin_set_configuration(struct libusb_device_handle *dev_handle, int config) {
 926   struct darwin_device_priv *dpriv = (struct darwin_device_priv *)dev_handle->dev->os_priv;
 927   IOReturn kresult;
 928   int i;
 929
 930   /* Setting configuration will invalidate the interface, so we need
 931      to reclaim it. First, dispose of existing interfaces, if any. */
 932   for (i = 0 ; i < USB_MAXINTERFACES ; i++)
 933     if (dev_handle->claimed_interfaces & (1 << i))
 934       darwin_release_interface (dev_handle, i);
 935
 936   kresult = (*(dpriv->device))->SetConfiguration (dpriv->device, config);
 937   if (kresult != kIOReturnSuccess)
 938     return darwin_to_libusb (kresult);
 939
 940   /* Reclaim any interfaces. */
 941   for (i = 0 ; i < USB_MAXINTERFACES ; i++)
 942     if (dev_handle->claimed_interfaces & (1 << i))
 943       darwin_claim_interface (dev_handle, i);
 944
 945   dpriv->active_config = config;
 946
 947   return 0;
 948 }
 949
 950 static int darwin_get_interface (usb_device_t **darwin_device, uint8_t ifc, io_service_t *usbInterfacep) {
 951   IOUSBFindInterfaceRequest request;
 952   uint8_t                   current_interface;
 953   kern_return_t             kresult;
 954   io_iterator_t             interface_iterator;
 955
 956   *usbInterfacep = IO_OBJECT_NULL;
 957
 958   /* Setup the Interface Request */
 959   request.bInterfaceClass    = kIOUSBFindInterfaceDontCare;
 960   request.bInterfaceSubClass = kIOUSBFindInterfaceDontCare;
 961   request.bInterfaceProtocol = kIOUSBFindInterfaceDontCare;
 962   request.bAlternateSetting  = kIOUSBFindInterfaceDontCare;
 963
 964   kresult = (*(darwin_device))->CreateInterfaceIterator(darwin_device, &request, &interface_iterator);
 965   if (kresult)
 966     return kresult;
 967
 968   for ( current_interface = 0 ; current_interface <= ifc ; current_interface++ ) {
 969     *usbInterfacep = IOIteratorNext(interface_iterator);
 970     if (current_interface != ifc)
 971       (void) IOObjectRelease (*usbInterfacep);
 972   }
 973
 974   /* done with the interface iterator */
 975   IOObjectRelease(interface_iterator);
 976
 977   return 0;
 978 }
 979
 980 static int get_endpoints (struct libusb_device_handle *dev_handle, int iface) {
 981   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)dev_handle->os_priv;
 982
 983   /* current interface */
 984   struct darwin_interface *cInterface = &priv->interfaces[iface];
 985
 986   kern_return_t kresult;
 987
 988   u_int8_t numep, direction, number;
 989   u_int8_t dont_care1, dont_care3;
 990   u_int16_t dont_care2;
 991   int i;
 992
 993   usbi_info (HANDLE_CTX (dev_handle), "building table of endpoints.");
 994
 995   /* retrieve the total number of endpoints on this interface */
 996   kresult = (*(cInterface->interface))->GetNumEndpoints(cInterface->interface, &numep);
 997   if (kresult) {
 998     usbi_err (HANDLE_CTX (dev_handle), "can't get number of endpoints for interface: %s", darwin_error_str(kresult));
 999     return darwin_to_libusb (kresult);
1000   }
1001
1002   /* iterate through pipe references */
1003   for (i = 1 ; i <= numep ; i++) {
1004     kresult = (*(cInterface->interface))->GetPipeProperties(cInterface->interface, i, &direction, &number, &dont_care1,
1005                                                             &dont_care2, &dont_care3);
1006
1007     if (kresult != kIOReturnSuccess) {
1008       usbi_err (HANDLE_CTX (dev_handle), "error getting pipe information for pipe %d: %s", i, darwin_error_str(kresult));
1009
1010       return darwin_to_libusb (kresult);
1011     }
1012
1013     usbi_info (HANDLE_CTX (dev_handle), "interface: %i pipe %i: dir: %i number: %i", iface, i, direction, number);
1014
1015     cInterface->endpoint_addrs[i - 1] = ((direction << 7 & LIBUSB_ENDPOINT_DIR_MASK) | (number & LIBUSB_ENDPOINT_ADDRESS_MASK));
1016   }
1017
1018   cInterface->num_endpoints = numep;
1019
1020   return 0;
1021 }
1022
1023 static int darwin_claim_interface(struct libusb_device_handle *dev_handle, int iface) {
1024   struct darwin_device_priv *dpriv = (struct darwin_device_priv *)dev_handle->dev->os_priv;
1025   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)dev_handle->os_priv;
1026   io_service_t          usbInterface = IO_OBJECT_NULL;
1027   IOReturn kresult;
1028   IOCFPlugInInterface **plugInInterface = NULL;
1029   SInt32                score;
1030
1031   /* current interface */
1032   struct darwin_interface *cInterface = &priv->interfaces[iface];
1033
1034   kresult = darwin_get_interface (dpriv->device, iface, &usbInterface);
1035   if (kresult != kIOReturnSuccess)
1036     return darwin_to_libusb (kresult);
1037
1038   /* make sure we have an interface */
1039   if (!usbInterface && dpriv->first_config != 0) {
1040     usbi_info (HANDLE_CTX (dev_handle), "no interface found; setting configuration: %d", dpriv->first_config);
1041
1042     /* set the configuration */
1043     kresult = darwin_set_configuration (dev_handle, dpriv->first_config);
1044     if (kresult != LIBUSB_SUCCESS) {
1045       usbi_err (HANDLE_CTX (dev_handle), "could not set configuration");
1046       return kresult;
1047     }
1048
1049     kresult = darwin_get_interface (dpriv->device, iface, &usbInterface);
1050     if (kresult) {
1051       usbi_err (HANDLE_CTX (dev_handle), "darwin_get_interface: %s", darwin_error_str(kresult));
1052       return darwin_to_libusb (kresult);
1053     }
1054   }
1055
1056   if (!usbInterface) {
1057     usbi_err (HANDLE_CTX (dev_handle), "interface not found");
1058     return LIBUSB_ERROR_NOT_FOUND;
1059   }
1060
1061   /* get an interface to the device's interface */
1062   kresult = IOCreatePlugInInterfaceForService (usbInterface, kIOUSBInterfaceUserClientTypeID,
1063                                                kIOCFPlugInInterfaceID, &plugInInterface, &score);
1064
1065   /* ignore release error */
1066   (void)IOObjectRelease (usbInterface);
1067
1068   if (kresult) {
1069     usbi_err (HANDLE_CTX (dev_handle), "IOCreatePlugInInterfaceForService: %s", darwin_error_str(kresult));
1070     return darwin_to_libusb (kresult);
1071   }
1072
1073   if (!plugInInterface) {
1074     usbi_err (HANDLE_CTX (dev_handle), "plugin interface not found");
1075     return LIBUSB_ERROR_NOT_FOUND;
1076   }
1077
1078   /* Do the actual claim */
1079   kresult = (*plugInInterface)->QueryInterface(plugInInterface,
1080                                                CFUUIDGetUUIDBytes(kIOUSBInterfaceInterfaceID),
1081                                                (LPVOID)&cInterface->interface);
1082   /* We no longer need the intermediate plug-in */
1083   IODestroyPlugInInterface (plugInInterface);
1084   if (kresult || !cInterface->interface) {
1085     usbi_err (HANDLE_CTX (dev_handle), "QueryInterface: %s", darwin_error_str(kresult));
1086     return darwin_to_libusb (kresult);
1087   }
1088
1089   /* claim the interface */
1090   kresult = (*(cInterface->interface))->USBInterfaceOpen(cInterface->interface);
1091   if (kresult) {
1092     usbi_err (HANDLE_CTX (dev_handle), "USBInterfaceOpen: %s", darwin_error_str(kresult));
1093     return darwin_to_libusb (kresult);
1094   }
1095
1096   /* update list of endpoints */
1097   kresult = get_endpoints (dev_handle, iface);
1098   if (kresult) {
1099     /* this should not happen */
1100     darwin_release_interface (dev_handle, iface);
1101     usbi_err (HANDLE_CTX (dev_handle), "could not build endpoint table");
1102     return kresult;
1103   }
1104
1105   cInterface->cfSource = NULL;
1106
1107   /* create async event source */
1108   kresult = (*(cInterface->interface))->CreateInterfaceAsyncEventSource (cInterface->interface, &cInterface->cfSource);
1109   if (kresult != kIOReturnSuccess) {
1110     usbi_err (HANDLE_CTX (dev_handle), "could not create async event source");
1111
1112     /* can't continue without an async event source */
1113     (void)darwin_release_interface (dev_handle, iface);
1114
1115     return darwin_to_libusb (kresult);
1116   }
1117
1118   /* add the cfSource to the async thread's run loop */
1119   CFRunLoopAddSource(libusb_darwin_acfl, cInterface->cfSource, kCFRunLoopDefaultMode);
1120
1121   usbi_info (HANDLE_CTX (dev_handle), "interface opened");
1122
1123   return 0;
1124 }
1125
1126 static int darwin_release_interface(struct libusb_device_handle *dev_handle, int iface) {
1127   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)dev_handle->os_priv;
1128   IOReturn kresult;
1129
1130   /* current interface */
1131   struct darwin_interface *cInterface = &priv->interfaces[iface];
1132
1133   /* Check to see if an interface is open */
1134   if (!cInterface->interface)
1135     return LIBUSB_SUCCESS;
1136
1137   /* clean up endpoint data */
1138   cInterface->num_endpoints = 0;
1139
1140   /* delete the interface's async event source */
1141   if (cInterface->cfSource) {
1142     CFRunLoopRemoveSource (libusb_darwin_acfl, cInterface->cfSource, kCFRunLoopDefaultMode);
1143     CFRelease (cInterface->cfSource);
1144   }
1145
1146   kresult = (*(cInterface->interface))->USBInterfaceClose(cInterface->interface);
1147   if (kresult)
1148     usbi_err (HANDLE_CTX (dev_handle), "USBInterfaceClose: %s", darwin_error_str(kresult));
1149
1150   kresult = (*(cInterface->interface))->Release(cInterface->interface);
1151   if (kresult != kIOReturnSuccess)
1152     usbi_err (HANDLE_CTX (dev_handle), "Release: %s", darwin_error_str(kresult));
1153
1154   cInterface->interface = IO_OBJECT_NULL;
1155
1156   return darwin_to_libusb (kresult);
1157 }
1158
1159 static int darwin_set_interface_altsetting(struct libusb_device_handle *dev_handle, int iface, int altsetting) {
1160   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)dev_handle->os_priv;
1161   IOReturn kresult;
1162
1163   /* current interface */
1164   struct darwin_interface *cInterface = &priv->interfaces[iface];
1165
1166   if (!cInterface->interface)
1167     return LIBUSB_ERROR_NO_DEVICE;
1168
1169   kresult = (*(cInterface->interface))->SetAlternateInterface (cInterface->interface, altsetting);
1170   if (kresult != kIOReturnSuccess)
1171     darwin_reset_device (dev_handle);
1172
1173   /* update list of endpoints */
1174   kresult = get_endpoints (dev_handle, iface);
1175   if (kresult) {
1176     /* this should not happen */
1177     darwin_release_interface (dev_handle, iface);
1178     usbi_err (HANDLE_CTX (dev_handle), "could not build endpoint table");
1179     return kresult;
1180   }
1181
1182   return darwin_to_libusb (kresult);
1183 }
1184
1185 static int darwin_clear_halt(struct libusb_device_handle *dev_handle, unsigned char endpoint) {
1186   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)dev_handle->os_priv;
1187
1188   /* current interface */
1189   struct darwin_interface *cInterface;
1190   uint8_t pipeRef, iface;
1191   IOReturn kresult;
1192
1193   /* determine the interface/endpoint to use */
1194   if (ep_to_pipeRef (dev_handle, endpoint, &pipeRef, &iface) != 0) {
1195     usbi_err (HANDLE_CTX (dev_handle), "endpoint not found on any open interface");
1196
1197     return LIBUSB_ERROR_NOT_FOUND;
1198   }
1199
1200   cInterface = &priv->interfaces[iface];
1201
1202 #if (InterfaceVersion < 190)
1203   kresult = (*(cInterface->interface))->ClearPipeStall(cInterface->interface, pipeRef);
1204 #else
1205   /* newer versions of darwin support clearing additional bits on the device's endpoint */
1206   kresult = (*(cInterface->interface))->ClearPipeStallBothEnds(cInterface->interface, pipeRef);
1207 #endif
1208   if (kresult)
1209     usbi_err (HANDLE_CTX (dev_handle), "ClearPipeStall: %s", darwin_error_str (kresult));
1210
1211   return darwin_to_libusb (kresult);
1212 }
1213
1214 static int darwin_reset_device(struct libusb_device_handle *dev_handle) {
1215   struct darwin_device_priv *dpriv = (struct darwin_device_priv *)dev_handle->dev->os_priv;
1216   IOReturn kresult;
1217
1218   kresult = (*(dpriv->device))->ResetDevice (dpriv->device);
1219   if (kresult)
1220     usbi_err (HANDLE_CTX (dev_handle), "ResetDevice: %s", darwin_error_str (kresult));
1221
1222   return darwin_to_libusb (kresult);
1223 }
1224
1225 static int darwin_kernel_driver_active(struct libusb_device_handle *dev_handle, int interface) {
1226   struct darwin_device_priv *dpriv = (struct darwin_device_priv *)dev_handle->dev->os_priv;
1227   io_service_t usbInterface;
1228   CFTypeRef driver;
1229   IOReturn kresult;
1230
1231   kresult = darwin_get_interface (dpriv->device, interface, &usbInterface);
1232   if (kresult) {
1233     usbi_err (HANDLE_CTX (dev_handle), "darwin_get_interface: %s", darwin_error_str(kresult));
1234
1235     return darwin_to_libusb (kresult);
1236   }
1237
1238   driver = IORegistryEntryCreateCFProperty (usbInterface, kIOBundleIdentifierKey, kCFAllocatorDefault, 0);
1239   IOObjectRelease (usbInterface);
1240
1241   if (driver) {
1242     CFRelease (driver);
1243
1244     return 1;
1245   }
1246
1247   /* no driver */
1248   return 0;
1249 }
1250
1251 /* attaching/detaching kernel drivers is not currently supported (maybe in the future?) */
1252 static int darwin_attach_kernel_driver (struct libusb_device_handle *dev_handle, int interface) {
1253   (void)dev_handle;
1254   (void)interface;
1255   return LIBUSB_ERROR_NOT_SUPPORTED;
1256 }
1257
1258 static int darwin_detach_kernel_driver (struct libusb_device_handle *dev_handle, int interface) {
1259   (void)dev_handle;
1260   (void)interface;
1261   return LIBUSB_ERROR_NOT_SUPPORTED;
1262 }
1263
1264 static void darwin_destroy_device(struct libusb_device *dev) {
1265   (void)dev;
1266 }
1267
1268 static int submit_bulk_transfer(struct usbi_transfer *itransfer) {
1269   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1270   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)transfer->dev_handle->os_priv;
1271
1272   IOReturn               ret;
1273   uint8_t                is_read; /* 0 = we're reading, 1 = we're writing */
1274   uint8_t                transferType;
1275   /* None of the values below are used in libusb for bulk transfers */
1276   uint8_t                direction, number, interval, pipeRef, iface;
1277   uint16_t               maxPacketSize;
1278
1279   struct darwin_interface *cInterface;
1280
1281   /* are we reading or writing? */
1282   is_read = transfer->endpoint & LIBUSB_ENDPOINT_IN;
1283
1284   if (ep_to_pipeRef (transfer->dev_handle, transfer->endpoint, &pipeRef, &iface) != 0) {
1285     usbi_err (TRANSFER_CTX (transfer), "endpoint not found on any open interface");
1286
1287     return LIBUSB_ERROR_NOT_FOUND;
1288   }
1289
1290   cInterface = &priv->interfaces[iface];
1291
1292   (*(cInterface->interface))->GetPipeProperties (cInterface->interface, pipeRef, &direction, &number,
1293                                                  &transferType, &maxPacketSize, &interval);
1294
1295   /* submit the request */
1296   /* timeouts are unavailable on interrupt endpoints */
1297   if (transferType == kUSBInterrupt) {
1298     if (is_read)
1299       ret = (*(cInterface->interface))->ReadPipeAsync(cInterface->interface, pipeRef, transfer->buffer,
1300                                                       transfer->length, darwin_async_io_callback, itransfer);
1301     else
1302       ret = (*(cInterface->interface))->WritePipeAsync(cInterface->interface, pipeRef, transfer->buffer,
1303                                                        transfer->length, darwin_async_io_callback, itransfer);
1304   } else {
1305     itransfer->flags |= USBI_TRANSFER_OS_HANDLES_TIMEOUT;
1306
1307     if (is_read)
1308       ret = (*(cInterface->interface))->ReadPipeAsyncTO(cInterface->interface, pipeRef, transfer->buffer,
1309                                                         transfer->length, transfer->timeout, transfer->timeout,
1310                                                         darwin_async_io_callback, (void *)itransfer);
1311     else
1312       ret = (*(cInterface->interface))->WritePipeAsyncTO(cInterface->interface, pipeRef, transfer->buffer,
1313                                                          transfer->length, transfer->timeout, transfer->timeout,
1314                                                          darwin_async_io_callback, (void *)itransfer);
1315   }
1316
1317   if (ret)
1318     usbi_err (TRANSFER_CTX (transfer), "bulk transfer failed (dir = %s): %s (code = 0x%08x)", is_read ? "In" : "Out",
1319                darwin_error_str(ret), ret);
1320
1321   return darwin_to_libusb (ret);
1322 }
1323
1324 static int submit_iso_transfer(struct usbi_transfer *itransfer) {
1325   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1326   struct darwin_transfer_priv *tpriv = usbi_transfer_get_os_priv(itransfer);
1327   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)transfer->dev_handle->os_priv;
1328
1329   IOReturn                kresult;
1330   uint8_t                 is_read; /* 0 = we're writing, 1 = we're reading */
1331   uint8_t                 pipeRef, iface;
1332   UInt64                  frame;
1333   AbsoluteTime            atTime;
1334   int                     i;
1335
1336   struct darwin_interface *cInterface;
1337
1338   /* are we reading or writing? */
1339   is_read = transfer->endpoint & LIBUSB_ENDPOINT_IN;
1340
1341   /* construct an array of IOUSBIsocFrames, reuse the old one if possible */
1342   if (tpriv->isoc_framelist && tpriv->num_iso_packets != transfer->num_iso_packets) {
1343     free(tpriv->isoc_framelist);
1344     tpriv->isoc_framelist = NULL;
1345   }
1346
1347   if (!tpriv->isoc_framelist) {
1348     tpriv->num_iso_packets = transfer->num_iso_packets;
1349     tpriv->isoc_framelist = (IOUSBIsocFrame*) calloc (transfer->num_iso_packets, sizeof(IOUSBIsocFrame));
1350     if (!tpriv->isoc_framelist)
1351       return LIBUSB_ERROR_NO_MEM;
1352   }
1353
1354   /* copy the frame list from the libusb descriptor (the structures differ only is member order) */
1355   for (i = 0 ; i < transfer->num_iso_packets ; i++)
1356     tpriv->isoc_framelist[i].frReqCount = transfer->iso_packet_desc[i].length;
1357
1358   /* determine the interface/endpoint to use */
1359   if (ep_to_pipeRef (transfer->dev_handle, transfer->endpoint, &pipeRef, &iface) != 0) {
1360     usbi_err (TRANSFER_CTX (transfer), "endpoint not found on any open interface");
1361
1362     return LIBUSB_ERROR_NOT_FOUND;
1363   }
1364
1365   cInterface = &priv->interfaces[iface];
1366
1367   /* Last but not least we need the bus frame number */
1368   kresult = (*(cInterface->interface))->GetBusFrameNumber(cInterface->interface, &frame, &atTime);
1369   if (kresult) {
1370     usbi_err (TRANSFER_CTX (transfer), "failed to get bus frame number: %d", kresult);
1371     free(tpriv->isoc_framelist);
1372     tpriv->isoc_framelist = NULL;
1373
1374     return darwin_to_libusb (kresult);
1375   }
1376
1377   /* schedule for a frame a little in the future */
1378   frame += 4;
1379
1380   if (cInterface->frames[transfer->endpoint] && frame < cInterface->frames[transfer->endpoint])
1381     frame = cInterface->frames[transfer->endpoint];
1382
1383   /* submit the request */
1384   if (is_read)
1385     kresult = (*(cInterface->interface))->ReadIsochPipeAsync(cInterface->interface, pipeRef, transfer->buffer, frame,
1386                                                              transfer->num_iso_packets, tpriv->isoc_framelist, darwin_async_io_callback,
1387                                                              itransfer);
1388   else
1389     kresult = (*(cInterface->interface))->WriteIsochPipeAsync(cInterface->interface, pipeRef, transfer->buffer, frame,
1390                                                               transfer->num_iso_packets, tpriv->isoc_framelist, darwin_async_io_callback,
1391                                                               itransfer);
1392
1393   cInterface->frames[transfer->endpoint] = frame + transfer->num_iso_packets / 8;
1394
1395   if (kresult != kIOReturnSuccess) {
1396     usbi_err (TRANSFER_CTX (transfer), "isochronous transfer failed (dir: %s): %s", is_read ? "In" : "Out",
1397                darwin_error_str(kresult));
1398     free (tpriv->isoc_framelist);
1399     tpriv->isoc_framelist = NULL;
1400   }
1401
1402   return darwin_to_libusb (kresult);
1403 }
1404
1405 static int submit_control_transfer(struct usbi_transfer *itransfer) {
1406   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1407   struct libusb_control_setup *setup = (struct libusb_control_setup *) transfer->buffer;
1408   struct darwin_device_priv *dpriv = (struct darwin_device_priv *)transfer->dev_handle->dev->os_priv;
1409   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)transfer->dev_handle->os_priv;
1410   struct darwin_transfer_priv *tpriv = usbi_transfer_get_os_priv(itransfer);
1411
1412   IOReturn               kresult;
1413
1414   bzero(&tpriv->req, sizeof(tpriv->req));
1415
1416   /* IOUSBDeviceInterface expects the request in cpu endianess */
1417   tpriv->req.bmRequestType     = setup->bmRequestType;
1418   tpriv->req.bRequest          = setup->bRequest;
1419   /* these values should be in bus order from libusb_fill_control_setup */
1420   tpriv->req.wValue            = OSSwapLittleToHostInt16 (setup->wValue);
1421   tpriv->req.wIndex            = OSSwapLittleToHostInt16 (setup->wIndex);
1422   tpriv->req.wLength           = OSSwapLittleToHostInt16 (setup->wLength);
1423   /* data is stored after the libusb control block */
1424   tpriv->req.pData             = transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
1425   tpriv->req.completionTimeout = transfer->timeout;
1426   tpriv->req.noDataTimeout     = transfer->timeout;
1427
1428   itransfer->flags |= USBI_TRANSFER_OS_HANDLES_TIMEOUT;
1429
1430   /* all transfers in libusb-1.0 are async */
1431
1432   if (transfer->endpoint) {
1433     struct darwin_interface *cInterface;
1434     uint8_t                 pipeRef, iface;
1435
1436     if (ep_to_pipeRef (transfer->dev_handle, transfer->endpoint, &pipeRef, &iface) != 0) {
1437       usbi_err (TRANSFER_CTX (transfer), "endpoint not found on any open interface");
1438
1439       return LIBUSB_ERROR_NOT_FOUND;
1440     }
1441
1442     cInterface = &priv->interfaces[iface];
1443
1444     kresult = (*(cInterface->interface))->ControlRequestAsyncTO (cInterface->interface, pipeRef, &(tpriv->req), darwin_async_io_callback, itransfer);
1445   } else
1446     /* control request on endpoint 0 */
1447     kresult = (*(dpriv->device))->DeviceRequestAsyncTO(dpriv->device, &(tpriv->req), darwin_async_io_callback, itransfer);
1448
1449   if (kresult != kIOReturnSuccess)
1450     usbi_err (TRANSFER_CTX (transfer), "control request failed: %s", darwin_error_str(kresult));
1451
1452   return darwin_to_libusb (kresult);
1453 }
1454
1455 static int darwin_submit_transfer(struct usbi_transfer *itransfer) {
1456   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1457
1458   switch (transfer->type) {
1459   case LIBUSB_TRANSFER_TYPE_CONTROL:
1460     return submit_control_transfer(itransfer);
1461   case LIBUSB_TRANSFER_TYPE_BULK:
1462   case LIBUSB_TRANSFER_TYPE_INTERRUPT:
1463     return submit_bulk_transfer(itransfer);
1464   case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
1465     return submit_iso_transfer(itransfer);
1466   default:
1467     usbi_err (TRANSFER_CTX(transfer), "unknown endpoint type %d", transfer->type);
1468     return LIBUSB_ERROR_INVALID_PARAM;
1469   }
1470 }
1471
1472 static int cancel_control_transfer(struct usbi_transfer *itransfer) {
1473   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1474   struct darwin_device_priv *dpriv = (struct darwin_device_priv *)transfer->dev_handle->dev->os_priv;
1475   IOReturn kresult;
1476
1477   usbi_info (ITRANSFER_CTX (itransfer), "WARNING: aborting all transactions control pipe");
1478
1479   if (!dpriv->device)
1480     return LIBUSB_ERROR_NO_DEVICE;
1481
1482   kresult = (*(dpriv->device))->USBDeviceAbortPipeZero (dpriv->device);
1483
1484   return darwin_to_libusb (kresult);
1485 }
1486
1487 static int darwin_abort_transfers (struct usbi_transfer *itransfer) {
1488   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1489   struct darwin_device_priv *dpriv = (struct darwin_device_priv *)transfer->dev_handle->dev->os_priv;
1490   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)transfer->dev_handle->os_priv;
1491   struct darwin_interface *cInterface;
1492   uint8_t pipeRef, iface;
1493   IOReturn kresult;
1494
1495   if (ep_to_pipeRef (transfer->dev_handle, transfer->endpoint, &pipeRef, &iface) != 0) {
1496     usbi_err (TRANSFER_CTX (transfer), "endpoint not found on any open interface");
1497
1498     return LIBUSB_ERROR_NOT_FOUND;
1499   }
1500
1501   cInterface = &priv->interfaces[iface];
1502
1503   if (!dpriv->device)
1504     return LIBUSB_ERROR_NO_DEVICE;
1505
1506   usbi_info (ITRANSFER_CTX (itransfer), "WARNING: aborting all transactions on interface %d pipe %d", iface, pipeRef);
1507
1508   /* abort transactions */
1509   (*(cInterface->interface))->AbortPipe (cInterface->interface, pipeRef);
1510
1511   usbi_info (ITRANSFER_CTX (itransfer), "calling clear pipe stall to clear the data toggle bit");
1512
1513   /* clear the data toggle bit */
1514 #if (InterfaceVersion < 190)
1515   kresult = (*(cInterface->interface))->ClearPipeStall(cInterface->interface, pipeRef);
1516 #else
1517   /* newer versions of darwin support clearing additional bits on the device's endpoint */
1518   kresult = (*(cInterface->interface))->ClearPipeStallBothEnds(cInterface->interface, pipeRef);
1519 #endif
1520
1521   return darwin_to_libusb (kresult);
1522 }
1523
1524 static int darwin_cancel_transfer(struct usbi_transfer *itransfer) {
1525   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1526
1527   switch (transfer->type) {
1528   case LIBUSB_TRANSFER_TYPE_CONTROL:
1529     return cancel_control_transfer(itransfer);
1530   case LIBUSB_TRANSFER_TYPE_BULK:
1531   case LIBUSB_TRANSFER_TYPE_INTERRUPT:
1532   case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
1533     return darwin_abort_transfers (itransfer);
1534   default:
1535     usbi_err (TRANSFER_CTX(transfer), "unknown endpoint type %d", transfer->type);
1536     return LIBUSB_ERROR_INVALID_PARAM;
1537   }
1538 }
1539
1540 static void darwin_clear_transfer_priv (struct usbi_transfer *itransfer) {
1541   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1542   struct darwin_transfer_priv *tpriv = usbi_transfer_get_os_priv(itransfer);
1543
1544   if (transfer->type == LIBUSB_TRANSFER_TYPE_ISOCHRONOUS && tpriv->isoc_framelist) {
1545     free (tpriv->isoc_framelist);
1546     tpriv->isoc_framelist = NULL;
1547   }
1548 }
1549
1550 static void darwin_async_io_callback (void *refcon, IOReturn result, void *arg0) {
1551   struct usbi_transfer *itransfer = (struct usbi_transfer *)refcon;
1552   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1553   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)transfer->dev_handle->os_priv;
1554   UInt32 message, size;
1555
1556   usbi_info (ITRANSFER_CTX (itransfer), "an async io operation has completed");
1557
1558   size = (UInt32) arg0;
1559
1560   /* send a completion message to the device's file descriptor */
1561   message = MESSAGE_ASYNC_IO_COMPLETE;
1562   write (priv->fds[1], &message, sizeof (message));
1563   write (priv->fds[1], &itransfer, sizeof (itransfer));
1564   write (priv->fds[1], &result, sizeof (IOReturn));
1565   write (priv->fds[1], &size, sizeof (size));
1566 }
1567
1568 static int darwin_transfer_status (struct usbi_transfer *itransfer, kern_return_t result) {
1569   if (itransfer->flags & USBI_TRANSFER_TIMED_OUT)
1570     result = kIOUSBTransactionTimeout;
1571
1572   switch (result) {
1573   case kIOReturnUnderrun:
1574   case kIOReturnSuccess:
1575     return LIBUSB_TRANSFER_COMPLETED;
1576   case kIOReturnAborted:
1577     return LIBUSB_TRANSFER_CANCELLED;
1578   case kIOUSBPipeStalled:
1579     usbi_warn (ITRANSFER_CTX (itransfer), "transfer error: pipe is stalled");
1580     return LIBUSB_TRANSFER_STALL;
1581   case kIOReturnOverrun:
1582     usbi_err (ITRANSFER_CTX (itransfer), "transfer error: data overrun");
1583     return LIBUSB_TRANSFER_OVERFLOW;
1584   case kIOUSBTransactionTimeout:
1585     usbi_err (ITRANSFER_CTX (itransfer), "transfer error: timed out");
1586     itransfer->flags |= USBI_TRANSFER_TIMED_OUT;
1587     return LIBUSB_TRANSFER_TIMED_OUT;
1588   default:
1589     usbi_err (ITRANSFER_CTX (itransfer), "transfer error: %s (value = 0x%08x)", darwin_error_str (result), result);
1590     return LIBUSB_TRANSFER_ERROR;
1591   }
1592 }
1593
1594 static void darwin_handle_callback (struct usbi_transfer *itransfer, kern_return_t result, UInt32 io_size) {
1595   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1596   struct darwin_transfer_priv *tpriv = usbi_transfer_get_os_priv(itransfer);
1597   int isIsoc      = LIBUSB_TRANSFER_TYPE_ISOCHRONOUS == transfer->type;
1598   int isBulk      = LIBUSB_TRANSFER_TYPE_BULK == transfer->type;
1599   int isControl   = LIBUSB_TRANSFER_TYPE_CONTROL == transfer->type;
1600   int isInterrupt = LIBUSB_TRANSFER_TYPE_INTERRUPT == transfer->type;
1601   int i;
1602
1603   if (!isIsoc && !isBulk && !isControl && !isInterrupt) {
1604     usbi_err (TRANSFER_CTX(transfer), "unknown endpoint type %d", transfer->type);
1605     return;
1606   }
1607
1608   usbi_info (ITRANSFER_CTX (itransfer), "handling %s completion with kernel status %d",
1609              isControl ? "control" : isBulk ? "bulk" : isIsoc ? "isoc" : "interrupt", result);
1610
1611   if (kIOReturnSuccess == result || kIOReturnUnderrun == result) {
1612     if (isIsoc && tpriv->isoc_framelist) {
1613       /* copy isochronous results back */
1614
1615       for (i = 0; i < transfer->num_iso_packets ; i++) {
1616         struct libusb_iso_packet_descriptor *lib_desc = &transfer->iso_packet_desc[i];
1617         lib_desc->status = darwin_to_libusb (tpriv->isoc_framelist[i].frStatus);
1618         lib_desc->actual_length = tpriv->isoc_framelist[i].frActCount;
1619       }
1620     } else if (!isIsoc)
1621       itransfer->transferred += io_size;
1622   }
1623
1624   /* it is ok to handle cancelled transfers without calling usbi_handle_transfer_cancellation (we catch timeout transfers) */
1625   usbi_handle_transfer_completion (itransfer, darwin_transfer_status (itransfer, result));
1626 }
1627
1628 static int op_handle_events(struct libusb_context *ctx, struct pollfd *fds, POLL_NFDS_TYPE nfds, int num_ready) {
1629   struct usbi_transfer *itransfer;
1630   UInt32 io_size;
1631   IOReturn kresult;
1632   POLL_NFDS_TYPE i = 0;
1633   ssize_t ret;
1634   UInt32 message;
1635
1636   usbi_mutex_lock(&ctx->open_devs_lock);
1637   for (i = 0; i < nfds && num_ready > 0; i++) {
1638     struct pollfd *pollfd = &fds[i];
1639     struct libusb_device_handle *handle;
1640     struct darwin_device_handle_priv *hpriv = NULL;
1641
1642     usbi_info (ctx, "checking fd %i with revents = %x", fds[i], pollfd->revents);
1643
1644     if (!pollfd->revents)
1645       continue;
1646
1647     num_ready--;
1648     list_for_each_entry(handle, &ctx->open_devs, list, struct libusb_device_handle) {
1649       hpriv =  (struct darwin_device_handle_priv *)handle->os_priv;
1650       if (hpriv->fds[0] == pollfd->fd)
1651         break;
1652     }
1653
1654     if (!(pollfd->revents & POLLERR)) {
1655       ret = read (hpriv->fds[0], &message, sizeof (message));
1656       if (ret < (ssize_t)sizeof (message))
1657         continue;
1658     } else
1659       /* could not poll the device-- response is to delete the device (this seems a little heavy-handed) */
1660       message = MESSAGE_DEVICE_GONE;
1661
1662     switch (message) {
1663     case MESSAGE_DEVICE_GONE:
1664       /* remove the device's async port from the runloop */
1665       if (hpriv->cfSource) {
1666         if (libusb_darwin_acfl)
1667           CFRunLoopRemoveSource (libusb_darwin_acfl, hpriv->cfSource, kCFRunLoopDefaultMode);
1668         CFRelease (hpriv->cfSource);
1669         hpriv->cfSource = NULL;
1670       }
1671
1672       usbi_remove_pollfd(HANDLE_CTX(handle), hpriv->fds[0]);
1673       usbi_handle_disconnect(handle);
1674
1675       /* done with this device */
1676       continue;
1677     case MESSAGE_ASYNC_IO_COMPLETE:
1678       read (hpriv->fds[0], &itransfer, sizeof (itransfer));
1679       read (hpriv->fds[0], &kresult, sizeof (IOReturn));
1680       read (hpriv->fds[0], &io_size, sizeof (UInt32));
1681
1682       darwin_handle_callback (itransfer, kresult, io_size);
1683       break;
1684     default:
1685       usbi_err (ctx, "unknown message received from device pipe");
1686     }
1687   }
1688
1689   usbi_mutex_unlock(&ctx->open_devs_lock);
1690
1691   return 0;
1692 }
1693
1694 static int darwin_clock_gettime(int clk_id, struct timespec *tp) {
1695   mach_timespec_t sys_time;
1696   clock_serv_t clock_ref;
1697
1698   switch (clk_id) {
1699   case USBI_CLOCK_REALTIME:
1700     /* CLOCK_REALTIME represents time since the epoch */
1701     clock_ref = clock_realtime;
1702     break;
1703   case USBI_CLOCK_MONOTONIC:
1704     /* use system boot time as reference for the monotonic clock */
1705     clock_ref = clock_monotonic;
1706     break;
1707   default:
1708     return LIBUSB_ERROR_INVALID_PARAM;
1709   }
1710
1711   clock_get_time (clock_ref, &sys_time);
1712
1713   tp->tv_sec  = sys_time.tv_sec;
1714   tp->tv_nsec = sys_time.tv_nsec;
1715
1716   return 0;
1717 }
1718
1719 const struct usbi_os_backend darwin_backend = {
1720         .name = "Darwin",
1721         .init = darwin_init,
1722         .exit = darwin_exit,
1723         .get_device_list = darwin_get_device_list,
1724         .get_device_descriptor = darwin_get_device_descriptor,
1725         .get_active_config_descriptor = darwin_get_active_config_descriptor,
1726         .get_config_descriptor = darwin_get_config_descriptor,
1727
1728         .open = darwin_open,
1729         .close = darwin_close,
1730         .get_configuration = darwin_get_configuration,
1731         .set_configuration = darwin_set_configuration,
1732         .claim_interface = darwin_claim_interface,
1733         .release_interface = darwin_release_interface,
1734
1735         .set_interface_altsetting = darwin_set_interface_altsetting,
1736         .clear_halt = darwin_clear_halt,
1737         .reset_device = darwin_reset_device,
1738
1739         .kernel_driver_active = darwin_kernel_driver_active,
1740         .detach_kernel_driver = darwin_detach_kernel_driver,
1741         .attach_kernel_driver = darwin_attach_kernel_driver,
1742
1743         .destroy_device = darwin_destroy_device,
1744
1745         .submit_transfer = darwin_submit_transfer,
1746         .cancel_transfer = darwin_cancel_transfer,
1747         .clear_transfer_priv = darwin_clear_transfer_priv,
1748
1749         .handle_events = op_handle_events,
1750
1751         .clock_gettime = darwin_clock_gettime,
1752
1753         .device_priv_size = sizeof(struct darwin_device_priv),
1754         .device_handle_priv_size = sizeof(struct darwin_device_handle_priv),
1755         .transfer_priv_size = sizeof(struct darwin_transfer_priv),
1756         .add_iso_packet_size = 0,
1757 };
1758