libusb/os/darwin_usb.c

   1 /* -*- Mode: C; indent-tabs-mode:nil -*- */
   2 /*
   3  * darwin backend for libusb 1.0
   4  * Copyright © 2008-2017 Nathan Hjelm <hjelmn@users.sourceforge.net>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #include "config.h"
  22 #include <time.h>
  23 #include <ctype.h>
  24 #include <errno.h>
  25 #include <pthread.h>
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <sys/types.h>
  30 #include <unistd.h>
  31 #include <fcntl.h>
  32 #include <sys/sysctl.h>
  33
  34 #include <mach/clock.h>
  35 #include <mach/clock_types.h>
  36 #include <mach/mach_host.h>
  37 #include <mach/mach_port.h>
  38
  39 #include <AvailabilityMacros.h>
  40 #if MAC_OS_X_VERSION_MIN_REQUIRED >= 1060 && MAC_OS_X_VERSION_MIN_REQUIRED < 101200
  41   #include <objc/objc-auto.h>
  42 #endif
  43
  44 #if MAC_OS_X_VERSION_MIN_REQUIRED >= 101200
  45 /* Apple deprecated the darwin atomics in 10.12 in favor of C11 atomics */
  46 #include <stdatomic.h>
  47 #define libusb_darwin_atomic_fetch_add(x, y) atomic_fetch_add(x, y)
  48 #define OSX_USE_CLOCK_GETTIME 1
  49
  50 _Atomic int32_t initCount = ATOMIC_VAR_INIT(0);
  51 #else
  52 /* use darwin atomics if the target is older than 10.12 */
  53 #include <libkern/OSAtomic.h>
  54
  55 /* OSAtomicAdd32Barrier returns the new value */
  56 #define libusb_darwin_atomic_fetch_add(x, y) (OSAtomicAdd32Barrier(y, x) - y)
  57
  58 static volatile int32_t initCount = 0;
  59
  60 #define OSX_USE_CLOCK_GETTIME 0
  61 #endif
  62
  63 #include "darwin_usb.h"
  64
  65 /* async event thread */
  66 static pthread_mutex_t libusb_darwin_at_mutex = PTHREAD_MUTEX_INITIALIZER;
  67 static pthread_cond_t  libusb_darwin_at_cond = PTHREAD_COND_INITIALIZER;
  68
  69 static pthread_once_t darwin_init_once = PTHREAD_ONCE_INIT;
  70
  71 #if !OSX_USE_CLOCK_GETTIME
  72 static clock_serv_t clock_realtime;
  73 static clock_serv_t clock_monotonic;
  74 #endif
  75
  76 static CFRunLoopRef libusb_darwin_acfl = NULL; /* event cf loop */
  77 static CFRunLoopSourceRef libusb_darwin_acfls = NULL; /* shutdown signal for event cf loop */
  78
  79 static usbi_mutex_t darwin_cached_devices_lock = PTHREAD_MUTEX_INITIALIZER;
  80 static struct list_head darwin_cached_devices = {&darwin_cached_devices, &darwin_cached_devices};
  81 static char *darwin_device_class = kIOUSBDeviceClassName;
  82
  83 #define DARWIN_CACHED_DEVICE(a) ((struct darwin_cached_device *) (((struct darwin_device_priv *)((a)->os_priv))->dev))
  84
  85 /* async event thread */
  86 static pthread_t libusb_darwin_at;
  87
  88 static int darwin_get_config_descriptor(struct libusb_device *dev, uint8_t config_index, unsigned char *buffer, size_t len, int *host_endian);
  89 static int darwin_claim_interface(struct libusb_device_handle *dev_handle, int iface);
  90 static int darwin_release_interface(struct libusb_device_handle *dev_handle, int iface);
  91 static int darwin_reset_device(struct libusb_device_handle *dev_handle);
  92 static void darwin_async_io_callback (void *refcon, IOReturn result, void *arg0);
  93
  94 static int darwin_scan_devices(struct libusb_context *ctx);
  95 static int process_new_device (struct libusb_context *ctx, io_service_t service);
  96
  97 #if defined(ENABLE_LOGGING)
  98 static const char *darwin_error_str (int result) {
  99   static char string_buffer[50];
 100   switch (result) {
 101   case kIOReturnSuccess:
 102     return "no error";
 103   case kIOReturnNotOpen:
 104     return "device not opened for exclusive access";
 105   case kIOReturnNoDevice:
 106     return "no connection to an IOService";
 107   case kIOUSBNoAsyncPortErr:
 108     return "no async port has been opened for interface";
 109   case kIOReturnExclusiveAccess:
 110     return "another process has device opened for exclusive access";
 111   case kIOUSBPipeStalled:
 112     return "pipe is stalled";
 113   case kIOReturnError:
 114     return "could not establish a connection to the Darwin kernel";
 115   case kIOUSBTransactionTimeout:
 116     return "transaction timed out";
 117   case kIOReturnBadArgument:
 118     return "invalid argument";
 119   case kIOReturnAborted:
 120     return "transaction aborted";
 121   case kIOReturnNotResponding:
 122     return "device not responding";
 123   case kIOReturnOverrun:
 124     return "data overrun";
 125   case kIOReturnCannotWire:
 126     return "physical memory can not be wired down";
 127   case kIOReturnNoResources:
 128     return "out of resources";
 129   case kIOUSBHighSpeedSplitError:
 130     return "high speed split error";
 131   default:
 132     snprintf(string_buffer, sizeof(string_buffer), "unknown error (0x%x)", result);
 133     return string_buffer;
 134   }
 135 }
 136 #endif
 137
 138 static int darwin_to_libusb (int result) {
 139   switch (result) {
 140   case kIOReturnUnderrun:
 141   case kIOReturnSuccess:
 142     return LIBUSB_SUCCESS;
 143   case kIOReturnNotOpen:
 144   case kIOReturnNoDevice:
 145     return LIBUSB_ERROR_NO_DEVICE;
 146   case kIOReturnExclusiveAccess:
 147     return LIBUSB_ERROR_ACCESS;
 148   case kIOUSBPipeStalled:
 149     return LIBUSB_ERROR_PIPE;
 150   case kIOReturnBadArgument:
 151     return LIBUSB_ERROR_INVALID_PARAM;
 152   case kIOUSBTransactionTimeout:
 153     return LIBUSB_ERROR_TIMEOUT;
 154   case kIOReturnNotResponding:
 155   case kIOReturnAborted:
 156   case kIOReturnError:
 157   case kIOUSBNoAsyncPortErr:
 158   default:
 159     return LIBUSB_ERROR_OTHER;
 160   }
 161 }
 162
 163 /* this function must be called with the darwin_cached_devices_lock held */
 164 static void darwin_deref_cached_device(struct darwin_cached_device *cached_dev) {
 165   cached_dev->refcount--;
 166   /* free the device and remove it from the cache */
 167   if (0 == cached_dev->refcount) {
 168     list_del(&cached_dev->list);
 169
 170     (*(cached_dev->device))->Release(cached_dev->device);
 171     free (cached_dev);
 172   }
 173 }
 174
 175 static void darwin_ref_cached_device(struct darwin_cached_device *cached_dev) {
 176   cached_dev->refcount++;
 177 }
 178
 179 static int ep_to_pipeRef(struct libusb_device_handle *dev_handle, uint8_t ep, uint8_t *pipep, uint8_t *ifcp, struct darwin_interface **interface_out) {
 180   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)dev_handle->os_priv;
 181
 182   /* current interface */
 183   struct darwin_interface *cInterface;
 184
 185   int8_t i, iface;
 186
 187   usbi_dbg ("converting ep address 0x%02x to pipeRef and interface", ep);
 188
 189   for (iface = 0 ; iface < USB_MAXINTERFACES ; iface++) {
 190     cInterface = &priv->interfaces[iface];
 191
 192     if (dev_handle->claimed_interfaces & (1 << iface)) {
 193       for (i = 0 ; i < cInterface->num_endpoints ; i++) {
 194         if (cInterface->endpoint_addrs[i] == ep) {
 195           *pipep = i + 1;
 196
 197           if (ifcp)
 198             *ifcp = iface;
 199
 200           if (interface_out)
 201             *interface_out = cInterface;
 202
 203           usbi_dbg ("pipe %d on interface %d matches", *pipep, iface);
 204           return 0;
 205         }
 206       }
 207     }
 208   }
 209
 210   /* No pipe found with the correct endpoint address */
 211   usbi_warn (HANDLE_CTX(dev_handle), "no pipeRef found with endpoint address 0x%02x.", ep);
 212
 213   return LIBUSB_ERROR_NOT_FOUND;
 214 }
 215
 216 static int usb_setup_device_iterator (io_iterator_t *deviceIterator, UInt32 location) {
 217   CFMutableDictionaryRef matchingDict = IOServiceMatching(darwin_device_class);
 218
 219   if (!matchingDict)
 220     return kIOReturnError;
 221
 222   if (location) {
 223     CFMutableDictionaryRef propertyMatchDict = CFDictionaryCreateMutable(kCFAllocatorDefault, 0,
 224                                                                          &kCFTypeDictionaryKeyCallBacks,
 225                                                                          &kCFTypeDictionaryValueCallBacks);
 226
 227     if (propertyMatchDict) {
 228       /* there are no unsigned CFNumber types so treat the value as signed. the os seems to do this
 229          internally (CFNumberType of locationID is 3) */
 230       CFTypeRef locationCF = CFNumberCreate (NULL, kCFNumberSInt32Type, &location);
 231
 232       CFDictionarySetValue (propertyMatchDict, CFSTR(kUSBDevicePropertyLocationID), locationCF);
 233       /* release our reference to the CFNumber (CFDictionarySetValue retains it) */
 234       CFRelease (locationCF);
 235
 236       CFDictionarySetValue (matchingDict, CFSTR(kIOPropertyMatchKey), propertyMatchDict);
 237       /* release out reference to the CFMutableDictionaryRef (CFDictionarySetValue retains it) */
 238       CFRelease (propertyMatchDict);
 239     }
 240     /* else we can still proceed as long as the caller accounts for the possibility of other devices in the iterator */
 241   }
 242
 243   return IOServiceGetMatchingServices(kIOMasterPortDefault, matchingDict, deviceIterator);
 244 }
 245
 246 /* Returns 1 on success, 0 on failure. */
 247 static int get_ioregistry_value_number (io_service_t service, CFStringRef property, CFNumberType type, void *p) {
 248   CFTypeRef cfNumber = IORegistryEntryCreateCFProperty (service, property, kCFAllocatorDefault, 0);
 249   int ret = 0;
 250
 251   if (cfNumber) {
 252     if (CFGetTypeID(cfNumber) == CFNumberGetTypeID()) {
 253       ret = CFNumberGetValue(cfNumber, type, p);
 254     }
 255
 256     CFRelease (cfNumber);
 257   }
 258
 259   return ret;
 260 }
 261
 262 static int get_ioregistry_value_data (io_service_t service, CFStringRef property, ssize_t size, void *p) {
 263   CFTypeRef cfData = IORegistryEntryCreateCFProperty (service, property, kCFAllocatorDefault, 0);
 264   int ret = 0;
 265
 266   if (cfData) {
 267     if (CFGetTypeID (cfData) == CFDataGetTypeID ()) {
 268       CFIndex length = CFDataGetLength (cfData);
 269       if (length < size) {
 270         size = length;
 271       }
 272
 273       CFDataGetBytes (cfData, CFRangeMake(0, size), p);
 274       ret = 1;
 275     }
 276
 277     CFRelease (cfData);
 278   }
 279
 280   return ret;
 281 }
 282
 283 static usb_device_t **darwin_device_from_service (io_service_t service)
 284 {
 285   io_cf_plugin_ref_t *plugInInterface = NULL;
 286   usb_device_t **device;
 287   kern_return_t result;
 288   SInt32 score;
 289
 290   result = IOCreatePlugInInterfaceForService(service, kIOUSBDeviceUserClientTypeID,
 291                                              kIOCFPlugInInterfaceID, &plugInInterface,
 292                                              &score);
 293
 294   if (kIOReturnSuccess != result || !plugInInterface) {
 295     usbi_dbg ("could not set up plugin for service: %s", darwin_error_str (result));
 296     return NULL;
 297   }
 298
 299   (void)(*plugInInterface)->QueryInterface(plugInInterface, CFUUIDGetUUIDBytes(DeviceInterfaceID),
 300                                            (LPVOID)&device);
 301   /* Use release instead of IODestroyPlugInInterface to avoid stopping IOServices associated with this device */
 302   (*plugInInterface)->Release (plugInInterface);
 303
 304   return device;
 305 }
 306
 307 static void darwin_devices_attached (void *ptr, io_iterator_t add_devices) {
 308   struct libusb_context *ctx;
 309   io_service_t service;
 310
 311   usbi_mutex_lock(&active_contexts_lock);
 312
 313   while ((service = IOIteratorNext(add_devices))) {
 314     /* add this device to each active context's device list */
 315     list_for_each_entry(ctx, &active_contexts_list, list, struct libusb_context) {
 316       process_new_device (ctx, service);;
 317     }
 318
 319     IOObjectRelease(service);
 320   }
 321
 322   usbi_mutex_unlock(&active_contexts_lock);
 323 }
 324
 325 static void darwin_devices_detached (void *ptr, io_iterator_t rem_devices) {
 326   struct libusb_device *dev = NULL;
 327   struct libusb_context *ctx;
 328   struct darwin_cached_device *old_device;
 329
 330   io_service_t device;
 331   UInt64 session;
 332   int ret;
 333
 334   usbi_mutex_lock(&active_contexts_lock);
 335
 336   while ((device = IOIteratorNext (rem_devices)) != 0) {
 337     /* get the location from the i/o registry */
 338     ret = get_ioregistry_value_number (device, CFSTR("sessionID"), kCFNumberSInt64Type, &session);
 339     IOObjectRelease (device);
 340     if (!ret)
 341       continue;
 342
 343     /* we need to match darwin_ref_cached_device call made in darwin_get_cached_device function
 344        otherwise no cached device will ever get freed */
 345     usbi_mutex_lock(&darwin_cached_devices_lock);
 346     list_for_each_entry(old_device, &darwin_cached_devices, list, struct darwin_cached_device) {
 347       if (old_device->session == session) {
 348         darwin_deref_cached_device (old_device);
 349         break;
 350       }
 351     }
 352     usbi_mutex_unlock(&darwin_cached_devices_lock);
 353
 354     list_for_each_entry(ctx, &active_contexts_list, list, struct libusb_context) {
 355       usbi_dbg ("notifying context %p of device disconnect", ctx);
 356
 357       dev = usbi_get_device_by_session_id(ctx, (unsigned long) session);
 358       if (dev) {
 359         /* signal the core that this device has been disconnected. the core will tear down this device
 360            when the reference count reaches 0 */
 361         usbi_disconnect_device(dev);
 362         libusb_unref_device(dev);
 363       }
 364     }
 365   }
 366
 367   usbi_mutex_unlock(&active_contexts_lock);
 368 }
 369
 370 static void darwin_hotplug_poll (void)
 371 {
 372   /* not sure if 5 seconds will be too long/short but it should work ok */
 373   mach_timespec_t timeout = {.tv_sec = 5, .tv_nsec = 0};
 374
 375   /* since a kernel thread may nodify the IOInterators used for
 376    * hotplug notidication we can't just clear the iterators.
 377    * instead just wait until all IOService providers are quiet */
 378   (void) IOKitWaitQuiet (kIOMasterPortDefault, &timeout);
 379 }
 380
 381 static void darwin_clear_iterator (io_iterator_t iter) {
 382   io_service_t device;
 383
 384   while ((device = IOIteratorNext (iter)) != 0)
 385     IOObjectRelease (device);
 386 }
 387
 388 static void *darwin_event_thread_main (void *arg0) {
 389   IOReturn kresult;
 390   struct libusb_context *ctx = (struct libusb_context *)arg0;
 391   CFRunLoopRef runloop;
 392
 393 #if MAC_OS_X_VERSION_MIN_REQUIRED >= 1060
 394   /* Set this thread's name, so it can be seen in the debugger
 395      and crash reports. */
 396   pthread_setname_np ("org.libusb.device-hotplug");
 397 #endif
 398
 399 #if MAC_OS_X_VERSION_MIN_REQUIRED >= 1060 && MAC_OS_X_VERSION_MIN_REQUIRED < 101200
 400   /* Tell the Objective-C garbage collector about this thread.
 401      This is required because, unlike NSThreads, pthreads are
 402      not automatically registered. Although we don't use
 403      Objective-C, we use CoreFoundation, which does.
 404      Garbage collection support was entirely removed in 10.12,
 405      so don't bother there. */
 406   objc_registerThreadWithCollector();
 407 #endif
 408
 409   /* hotplug (device arrival/removal) sources */
 410   CFRunLoopSourceContext libusb_shutdown_cfsourcectx;
 411   CFRunLoopSourceRef     libusb_notification_cfsource;
 412   io_notification_port_t libusb_notification_port;
 413   io_iterator_t          libusb_rem_device_iterator;
 414   io_iterator_t          libusb_add_device_iterator;
 415
 416   usbi_dbg ("creating hotplug event source");
 417
 418   runloop = CFRunLoopGetCurrent ();
 419   CFRetain (runloop);
 420
 421   /* add the shutdown cfsource to the run loop */
 422   memset(&libusb_shutdown_cfsourcectx, 0, sizeof(libusb_shutdown_cfsourcectx));
 423   libusb_shutdown_cfsourcectx.info = runloop;
 424   libusb_shutdown_cfsourcectx.perform = (void (*)(void *))CFRunLoopStop;
 425   libusb_darwin_acfls = CFRunLoopSourceCreate(NULL, 0, &libusb_shutdown_cfsourcectx);
 426   CFRunLoopAddSource(runloop, libusb_darwin_acfls, kCFRunLoopDefaultMode);
 427
 428   /* add the notification port to the run loop */
 429   libusb_notification_port     = IONotificationPortCreate (kIOMasterPortDefault);
 430   libusb_notification_cfsource = IONotificationPortGetRunLoopSource (libusb_notification_port);
 431   CFRunLoopAddSource(runloop, libusb_notification_cfsource, kCFRunLoopDefaultMode);
 432
 433   /* create notifications for removed devices */
 434   kresult = IOServiceAddMatchingNotification (libusb_notification_port, kIOTerminatedNotification,
 435                                               IOServiceMatching(darwin_device_class),
 436                                               darwin_devices_detached,
 437                                               ctx, &libusb_rem_device_iterator);
 438
 439   if (kresult != kIOReturnSuccess) {
 440     usbi_err (ctx, "could not add hotplug event source: %s", darwin_error_str (kresult));
 441
 442     pthread_exit (NULL);
 443   }
 444
 445   /* create notifications for attached devices */
 446   kresult = IOServiceAddMatchingNotification(libusb_notification_port, kIOFirstMatchNotification,
 447                                               IOServiceMatching(darwin_device_class),
 448                                               darwin_devices_attached,
 449                                               ctx, &libusb_add_device_iterator);
 450
 451   if (kresult != kIOReturnSuccess) {
 452     usbi_err (ctx, "could not add hotplug event source: %s", darwin_error_str (kresult));
 453
 454     pthread_exit (NULL);
 455   }
 456
 457   /* arm notifiers */
 458   darwin_clear_iterator (libusb_rem_device_iterator);
 459   darwin_clear_iterator (libusb_add_device_iterator);
 460
 461   usbi_dbg ("darwin event thread ready to receive events");
 462
 463   /* signal the main thread that the hotplug runloop has been created. */
 464   pthread_mutex_lock (&libusb_darwin_at_mutex);
 465   libusb_darwin_acfl = runloop;
 466   pthread_cond_signal (&libusb_darwin_at_cond);
 467   pthread_mutex_unlock (&libusb_darwin_at_mutex);
 468
 469   /* run the runloop */
 470   CFRunLoopRun();
 471
 472   usbi_dbg ("darwin event thread exiting");
 473
 474   /* remove the notification cfsource */
 475   CFRunLoopRemoveSource(runloop, libusb_notification_cfsource, kCFRunLoopDefaultMode);
 476
 477   /* remove the shutdown cfsource */
 478   CFRunLoopRemoveSource(runloop, libusb_darwin_acfls, kCFRunLoopDefaultMode);
 479
 480   /* delete notification port */
 481   IONotificationPortDestroy (libusb_notification_port);
 482
 483   /* delete iterators */
 484   IOObjectRelease (libusb_rem_device_iterator);
 485   IOObjectRelease (libusb_add_device_iterator);
 486
 487   CFRelease (libusb_darwin_acfls);
 488   CFRelease (runloop);
 489
 490   libusb_darwin_acfls = NULL;
 491   libusb_darwin_acfl = NULL;
 492
 493   pthread_exit (NULL);
 494 }
 495
 496 /* cleanup function to destroy cached devices */
 497 static void __attribute__((destructor)) _darwin_finalize(void) {
 498   struct darwin_cached_device *dev, *next;
 499
 500   usbi_mutex_lock(&darwin_cached_devices_lock);
 501   list_for_each_entry_safe(dev, next, &darwin_cached_devices, list, struct darwin_cached_device) {
 502     darwin_deref_cached_device(dev);
 503   }
 504   usbi_mutex_unlock(&darwin_cached_devices_lock);
 505 }
 506
 507 static void darwin_check_version (void) {
 508   /* adjust for changes in the USB stack in xnu 15 */
 509   int sysctl_args[] = {CTL_KERN, KERN_OSRELEASE};
 510   long version;
 511   char version_string[256] = {'\0',};
 512   size_t length = 256;
 513
 514   sysctl(sysctl_args, 2, version_string, &length, NULL, 0);
 515
 516   errno = 0;
 517   version = strtol (version_string, NULL, 10);
 518   if (0 == errno && version >= 15) {
 519     darwin_device_class = "IOUSBHostDevice";
 520   }
 521 }
 522
 523 static int darwin_init(struct libusb_context *ctx) {
 524   int rc;
 525
 526   rc = pthread_once (&darwin_init_once, darwin_check_version);
 527   if (rc) {
 528     return LIBUSB_ERROR_OTHER;
 529   }
 530
 531   rc = darwin_scan_devices (ctx);
 532   if (LIBUSB_SUCCESS != rc) {
 533     return rc;
 534   }
 535
 536   if (libusb_darwin_atomic_fetch_add (&initCount, 1) == 0) {
 537 #if !OSX_USE_CLOCK_GETTIME
 538     /* create the clocks that will be used if clock_gettime() is not available */
 539     host_name_port_t host_self;
 540
 541     host_self = mach_host_self();
 542     host_get_clock_service(host_self, CALENDAR_CLOCK, &clock_realtime);
 543     host_get_clock_service(host_self, SYSTEM_CLOCK, &clock_monotonic);
 544     mach_port_deallocate(mach_task_self(), host_self);
 545 #endif
 546
 547     pthread_create (&libusb_darwin_at, NULL, darwin_event_thread_main, ctx);
 548
 549     pthread_mutex_lock (&libusb_darwin_at_mutex);
 550     while (!libusb_darwin_acfl)
 551       pthread_cond_wait (&libusb_darwin_at_cond, &libusb_darwin_at_mutex);
 552     pthread_mutex_unlock (&libusb_darwin_at_mutex);
 553   }
 554
 555   return rc;
 556 }
 557
 558 static void darwin_exit (void) {
 559   if (libusb_darwin_atomic_fetch_add (&initCount, -1) == 1) {
 560 #if !OSX_USE_CLOCK_GETTIME
 561     mach_port_deallocate(mach_task_self(), clock_realtime);
 562     mach_port_deallocate(mach_task_self(), clock_monotonic);
 563 #endif
 564
 565     /* stop the event runloop and wait for the thread to terminate. */
 566     CFRunLoopSourceSignal(libusb_darwin_acfls);
 567     CFRunLoopWakeUp (libusb_darwin_acfl);
 568     pthread_join (libusb_darwin_at, NULL);
 569   }
 570 }
 571
 572 static int darwin_get_device_descriptor(struct libusb_device *dev, unsigned char *buffer, int *host_endian) {
 573   struct darwin_cached_device *priv = DARWIN_CACHED_DEVICE(dev);
 574
 575   /* return cached copy */
 576   memmove (buffer, &(priv->dev_descriptor), DEVICE_DESC_LENGTH);
 577
 578   *host_endian = 0;
 579
 580   return 0;
 581 }
 582
 583 static int get_configuration_index (struct libusb_device *dev, int config_value) {
 584   struct darwin_cached_device *priv = DARWIN_CACHED_DEVICE(dev);
 585   UInt8 i, numConfig;
 586   IOUSBConfigurationDescriptorPtr desc;
 587   IOReturn kresult;
 588
 589   /* is there a simpler way to determine the index? */
 590   kresult = (*(priv->device))->GetNumberOfConfigurations (priv->device, &numConfig);
 591   if (kresult != kIOReturnSuccess)
 592     return darwin_to_libusb (kresult);
 593
 594   for (i = 0 ; i < numConfig ; i++) {
 595     (*(priv->device))->GetConfigurationDescriptorPtr (priv->device, i, &desc);
 596
 597     if (desc->bConfigurationValue == config_value)
 598       return i;
 599   }
 600
 601   /* configuration not found */
 602   return LIBUSB_ERROR_NOT_FOUND;
 603 }
 604
 605 static int darwin_get_active_config_descriptor(struct libusb_device *dev, unsigned char *buffer, size_t len, int *host_endian) {
 606   struct darwin_cached_device *priv = DARWIN_CACHED_DEVICE(dev);
 607   int config_index;
 608
 609   if (0 == priv->active_config)
 610     return LIBUSB_ERROR_NOT_FOUND;
 611
 612   config_index = get_configuration_index (dev, priv->active_config);
 613   if (config_index < 0)
 614     return config_index;
 615
 616   return darwin_get_config_descriptor (dev, config_index, buffer, len, host_endian);
 617 }
 618
 619 static int darwin_get_config_descriptor(struct libusb_device *dev, uint8_t config_index, unsigned char *buffer, size_t len, int *host_endian) {
 620   struct darwin_cached_device *priv = DARWIN_CACHED_DEVICE(dev);
 621   IOUSBConfigurationDescriptorPtr desc;
 622   IOReturn kresult;
 623   int ret;
 624
 625   if (!priv || !priv->device)
 626     return LIBUSB_ERROR_OTHER;
 627
 628   kresult = (*priv->device)->GetConfigurationDescriptorPtr (priv->device, config_index, &desc);
 629   if (kresult == kIOReturnSuccess) {
 630     /* copy descriptor */
 631     if (libusb_le16_to_cpu(desc->wTotalLength) < len)
 632       len = libusb_le16_to_cpu(desc->wTotalLength);
 633
 634     memmove (buffer, desc, len);
 635
 636     /* GetConfigurationDescriptorPtr returns the descriptor in USB bus order */
 637     *host_endian = 0;
 638   }
 639
 640   ret = darwin_to_libusb (kresult);
 641   if (ret != LIBUSB_SUCCESS)
 642     return ret;
 643
 644   return (int) len;
 645 }
 646
 647 /* check whether the os has configured the device */
 648 static int darwin_check_configuration (struct libusb_context *ctx, struct darwin_cached_device *dev) {
 649   usb_device_t **darwin_device = dev->device;
 650
 651   IOUSBConfigurationDescriptorPtr configDesc;
 652   IOUSBFindInterfaceRequest request;
 653   kern_return_t             kresult;
 654   io_iterator_t             interface_iterator;
 655   io_service_t              firstInterface;
 656
 657   if (dev->dev_descriptor.bNumConfigurations < 1) {
 658     usbi_err (ctx, "device has no configurations");
 659     return LIBUSB_ERROR_OTHER; /* no configurations at this speed so we can't use it */
 660   }
 661
 662   /* checking the configuration of a root hub simulation takes ~1 s in 10.11. the device is
 663      not usable anyway */
 664   if (0x05ac == dev->dev_descriptor.idVendor && 0x8005 == dev->dev_descriptor.idProduct) {
 665     usbi_dbg ("ignoring configuration on root hub simulation");
 666     dev->active_config = 0;
 667     return 0;
 668   }
 669
 670   /* find the first configuration */
 671   kresult = (*darwin_device)->GetConfigurationDescriptorPtr (darwin_device, 0, &configDesc);
 672   dev->first_config = (kIOReturnSuccess == kresult) ? configDesc->bConfigurationValue : 1;
 673
 674   /* check if the device is already configured. there is probably a better way than iterating over the
 675      to accomplish this (the trick is we need to avoid a call to GetConfigurations since buggy devices
 676      might lock up on the device request) */
 677
 678   /* Setup the Interface Request */
 679   request.bInterfaceClass    = kIOUSBFindInterfaceDontCare;
 680   request.bInterfaceSubClass = kIOUSBFindInterfaceDontCare;
 681   request.bInterfaceProtocol = kIOUSBFindInterfaceDontCare;
 682   request.bAlternateSetting  = kIOUSBFindInterfaceDontCare;
 683
 684   kresult = (*(darwin_device))->CreateInterfaceIterator(darwin_device, &request, &interface_iterator);
 685   if (kresult)
 686     return darwin_to_libusb (kresult);
 687
 688   /* iterate once */
 689   firstInterface = IOIteratorNext(interface_iterator);
 690
 691   /* done with the interface iterator */
 692   IOObjectRelease(interface_iterator);
 693
 694   if (firstInterface) {
 695     IOObjectRelease (firstInterface);
 696
 697     /* device is configured */
 698     if (dev->dev_descriptor.bNumConfigurations == 1)
 699       /* to avoid problems with some devices get the configurations value from the configuration descriptor */
 700       dev->active_config = dev->first_config;
 701     else
 702       /* devices with more than one configuration should work with GetConfiguration */
 703       (*darwin_device)->GetConfiguration (darwin_device, &dev->active_config);
 704   } else
 705     /* not configured */
 706     dev->active_config = 0;
 707
 708   usbi_dbg ("active config: %u, first config: %u", dev->active_config, dev->first_config);
 709
 710   return 0;
 711 }
 712
 713 static int darwin_request_descriptor (usb_device_t **device, UInt8 desc, UInt8 desc_index, void *buffer, size_t buffer_size) {
 714   IOUSBDevRequestTO req;
 715
 716   memset (buffer, 0, buffer_size);
 717
 718   /* Set up request for descriptor/ */
 719   req.bmRequestType = USBmakebmRequestType(kUSBIn, kUSBStandard, kUSBDevice);
 720   req.bRequest      = kUSBRqGetDescriptor;
 721   req.wValue        = desc << 8;
 722   req.wIndex        = desc_index;
 723   req.wLength       = buffer_size;
 724   req.pData         = buffer;
 725   req.noDataTimeout = 20;
 726   req.completionTimeout = 100;
 727
 728   return (*device)->DeviceRequestTO (device, &req);
 729 }
 730
 731 static int darwin_cache_device_descriptor (struct libusb_context *ctx, struct darwin_cached_device *dev) {
 732   usb_device_t **device = dev->device;
 733   int retries = 1, delay = 30000;
 734   int unsuspended = 0, try_unsuspend = 1, try_reconfigure = 1;
 735   int is_open = 0;
 736   int ret = 0, ret2;
 737   UInt8 bDeviceClass;
 738   UInt16 idProduct, idVendor;
 739
 740   dev->can_enumerate = 0;
 741
 742   (*device)->GetDeviceClass (device, &bDeviceClass);
 743   (*device)->GetDeviceProduct (device, &idProduct);
 744   (*device)->GetDeviceVendor (device, &idVendor);
 745
 746   /* According to Apple's documentation the device must be open for DeviceRequest but we may not be able to open some
 747    * devices and Apple's USB Prober doesn't bother to open the device before issuing a descriptor request.  Still,
 748    * to follow the spec as closely as possible, try opening the device */
 749   is_open = ((*device)->USBDeviceOpenSeize(device) == kIOReturnSuccess);
 750
 751   do {
 752     /**** retrieve device descriptor ****/
 753     ret = darwin_request_descriptor (device, kUSBDeviceDesc, 0, &dev->dev_descriptor, sizeof(dev->dev_descriptor));
 754
 755     if (kIOReturnOverrun == ret && kUSBDeviceDesc == dev->dev_descriptor.bDescriptorType)
 756       /* received an overrun error but we still received a device descriptor */
 757       ret = kIOReturnSuccess;
 758
 759     if (kIOUSBVendorIDAppleComputer == idVendor) {
 760       /* NTH: don't bother retrying or unsuspending Apple devices */
 761       break;
 762     }
 763
 764     if (kIOReturnSuccess == ret && (0 == dev->dev_descriptor.bNumConfigurations ||
 765                                     0 == dev->dev_descriptor.bcdUSB)) {
 766       /* work around for incorrectly configured devices */
 767       if (try_reconfigure && is_open) {
 768         usbi_dbg("descriptor appears to be invalid. resetting configuration before trying again...");
 769
 770         /* set the first configuration */
 771         (*device)->SetConfiguration(device, 1);
 772
 773         /* don't try to reconfigure again */
 774         try_reconfigure = 0;
 775       }
 776
 777       ret = kIOUSBPipeStalled;
 778     }
 779
 780     if (kIOReturnSuccess != ret && is_open && try_unsuspend) {
 781       /* device may be suspended. unsuspend it and try again */
 782 #if DeviceVersion >= 320
 783       UInt32 info = 0;
 784
 785       /* IOUSBFamily 320+ provides a way to detect device suspension but earlier versions do not */
 786       (void)(*device)->GetUSBDeviceInformation (device, &info);
 787
 788       /* note that the device was suspended */
 789       if (info & (1 << kUSBInformationDeviceIsSuspendedBit) || 0 == info)
 790         try_unsuspend = 1;
 791 #endif
 792
 793       if (try_unsuspend) {
 794         /* try to unsuspend the device */
 795         ret2 = (*device)->USBDeviceSuspend (device, 0);
 796         if (kIOReturnSuccess != ret2) {
 797           /* prevent log spew from poorly behaving devices.  this indicates the
 798              os actually had trouble communicating with the device */
 799           usbi_dbg("could not retrieve device descriptor. failed to unsuspend: %s",darwin_error_str(ret2));
 800         } else
 801           unsuspended = 1;
 802
 803         try_unsuspend = 0;
 804       }
 805     }
 806
 807     if (kIOReturnSuccess != ret) {
 808       usbi_dbg("kernel responded with code: 0x%08x. sleeping for %d ms before trying again", ret, delay/1000);
 809       /* sleep for a little while before trying again */
 810       nanosleep(&(struct timespec){delay / 1000000, (delay * 1000) % 1000000000UL}, NULL);
 811     }
 812   } while (kIOReturnSuccess != ret && retries--);
 813
 814   if (unsuspended)
 815     /* resuspend the device */
 816     (void)(*device)->USBDeviceSuspend (device, 1);
 817
 818   if (is_open)
 819     (void) (*device)->USBDeviceClose (device);
 820
 821   if (ret != kIOReturnSuccess) {
 822     /* a debug message was already printed out for this error */
 823     if (LIBUSB_CLASS_HUB == bDeviceClass)
 824       usbi_dbg ("could not retrieve device descriptor %.4x:%.4x: %s (%x). skipping device",
 825                 idVendor, idProduct, darwin_error_str (ret), ret);
 826     else
 827       usbi_warn (ctx, "could not retrieve device descriptor %.4x:%.4x: %s (%x). skipping device",
 828                  idVendor, idProduct, darwin_error_str (ret), ret);
 829     return darwin_to_libusb (ret);
 830   }
 831
 832   /* catch buggy hubs (which appear to be virtual). Apple's own USB prober has problems with these devices. */
 833   if (libusb_le16_to_cpu (dev->dev_descriptor.idProduct) != idProduct) {
 834     /* not a valid device */
 835     usbi_warn (ctx, "idProduct from iokit (%04x) does not match idProduct in descriptor (%04x). skipping device",
 836                idProduct, libusb_le16_to_cpu (dev->dev_descriptor.idProduct));
 837     return LIBUSB_ERROR_NO_DEVICE;
 838   }
 839
 840   usbi_dbg ("cached device descriptor:");
 841   usbi_dbg ("  bDescriptorType:    0x%02x", dev->dev_descriptor.bDescriptorType);
 842   usbi_dbg ("  bcdUSB:             0x%04x", dev->dev_descriptor.bcdUSB);
 843   usbi_dbg ("  bDeviceClass:       0x%02x", dev->dev_descriptor.bDeviceClass);
 844   usbi_dbg ("  bDeviceSubClass:    0x%02x", dev->dev_descriptor.bDeviceSubClass);
 845   usbi_dbg ("  bDeviceProtocol:    0x%02x", dev->dev_descriptor.bDeviceProtocol);
 846   usbi_dbg ("  bMaxPacketSize0:    0x%02x", dev->dev_descriptor.bMaxPacketSize0);
 847   usbi_dbg ("  idVendor:           0x%04x", dev->dev_descriptor.idVendor);
 848   usbi_dbg ("  idProduct:          0x%04x", dev->dev_descriptor.idProduct);
 849   usbi_dbg ("  bcdDevice:          0x%04x", dev->dev_descriptor.bcdDevice);
 850   usbi_dbg ("  iManufacturer:      0x%02x", dev->dev_descriptor.iManufacturer);
 851   usbi_dbg ("  iProduct:           0x%02x", dev->dev_descriptor.iProduct);
 852   usbi_dbg ("  iSerialNumber:      0x%02x", dev->dev_descriptor.iSerialNumber);
 853   usbi_dbg ("  bNumConfigurations: 0x%02x", dev->dev_descriptor.bNumConfigurations);
 854
 855   dev->can_enumerate = 1;
 856
 857   return LIBUSB_SUCCESS;
 858 }
 859
 860 static int get_device_port (io_service_t service, UInt8 *port) {
 861   kern_return_t result;
 862   io_service_t parent;
 863   int ret = 0;
 864
 865   if (get_ioregistry_value_number (service, CFSTR("PortNum"), kCFNumberSInt8Type, port)) {
 866     return 1;
 867   }
 868
 869   result = IORegistryEntryGetParentEntry (service, kIOServicePlane, &parent);
 870   if (kIOReturnSuccess == result) {
 871     ret = get_ioregistry_value_data (parent, CFSTR("port"), 1, port);
 872     IOObjectRelease (parent);
 873   }
 874
 875   return ret;
 876 }
 877
 878 static int get_device_parent_sessionID(io_service_t service, UInt64 *parent_sessionID) {
 879   kern_return_t result;
 880   io_service_t parent;
 881
 882   /* Walk up the tree in the IOService plane until we find a parent that has a sessionID */
 883   parent = service;
 884   while((result = IORegistryEntryGetParentEntry (parent, kIOServicePlane, &parent)) == kIOReturnSuccess) {
 885     if (get_ioregistry_value_number (parent, CFSTR("sessionID"), kCFNumberSInt64Type, parent_sessionID)) {
 886         /* Success */
 887         return 1;
 888     }
 889   }
 890
 891   /* We ran out of parents */
 892   return 0;
 893 }
 894
 895 static int darwin_get_cached_device(struct libusb_context *ctx, io_service_t service,
 896                                     struct darwin_cached_device **cached_out) {
 897   struct darwin_cached_device *new_device;
 898   UInt64 sessionID = 0, parent_sessionID = 0;
 899   int ret = LIBUSB_SUCCESS;
 900   usb_device_t **device;
 901   UInt8 port = 0;
 902
 903   /* get some info from the io registry */
 904   (void) get_ioregistry_value_number (service, CFSTR("sessionID"), kCFNumberSInt64Type, &sessionID);
 905   if (!get_device_port (service, &port)) {
 906     usbi_dbg("could not get connected port number");
 907   }
 908
 909   usbi_dbg("finding cached device for sessionID 0x%" PRIx64, sessionID);
 910
 911   if (get_device_parent_sessionID(service, &parent_sessionID)) {
 912     usbi_dbg("parent sessionID: 0x%" PRIx64, parent_sessionID);
 913   }
 914
 915   usbi_mutex_lock(&darwin_cached_devices_lock);
 916   do {
 917     *cached_out = NULL;
 918
 919     list_for_each_entry(new_device, &darwin_cached_devices, list, struct darwin_cached_device) {
 920       usbi_dbg("matching sessionID 0x%" PRIx64 " against cached device with sessionID 0x%" PRIx64, sessionID, new_device->session);
 921       if (new_device->session == sessionID) {
 922         usbi_dbg("using cached device for device");
 923         *cached_out = new_device;
 924         break;
 925       }
 926     }
 927
 928     if (*cached_out)
 929       break;
 930
 931     usbi_dbg("caching new device with sessionID 0x%" PRIx64, sessionID);
 932
 933     device = darwin_device_from_service (service);
 934     if (!device) {
 935       ret = LIBUSB_ERROR_NO_DEVICE;
 936       break;
 937     }
 938
 939     new_device = calloc (1, sizeof (*new_device));
 940     if (!new_device) {
 941       ret = LIBUSB_ERROR_NO_MEM;
 942       break;
 943     }
 944
 945     /* add this device to the cached device list */
 946     list_add(&new_device->list, &darwin_cached_devices);
 947
 948     (*device)->GetDeviceAddress (device, (USBDeviceAddress *)&new_device->address);
 949
 950     /* keep a reference to this device */
 951     darwin_ref_cached_device(new_device);
 952
 953     new_device->device = device;
 954     new_device->session = sessionID;
 955     (*device)->GetLocationID (device, &new_device->location);
 956     new_device->port = port;
 957     new_device->parent_session = parent_sessionID;
 958
 959     /* cache the device descriptor */
 960     ret = darwin_cache_device_descriptor(ctx, new_device);
 961     if (ret)
 962       break;
 963
 964     if (new_device->can_enumerate) {
 965       snprintf(new_device->sys_path, 20, "%03i-%04x-%04x-%02x-%02x", new_device->address,
 966                new_device->dev_descriptor.idVendor, new_device->dev_descriptor.idProduct,
 967                new_device->dev_descriptor.bDeviceClass, new_device->dev_descriptor.bDeviceSubClass);
 968     }
 969   } while (0);
 970
 971   usbi_mutex_unlock(&darwin_cached_devices_lock);
 972
 973   /* keep track of devices regardless of if we successfully enumerate them to
 974      prevent them from being enumerated multiple times */
 975
 976   *cached_out = new_device;
 977
 978   return ret;
 979 }
 980
 981 static int process_new_device (struct libusb_context *ctx, io_service_t service) {
 982   struct darwin_device_priv *priv;
 983   struct libusb_device *dev = NULL;
 984   struct darwin_cached_device *cached_device;
 985   UInt8 devSpeed;
 986   int ret = 0;
 987
 988   do {
 989     ret = darwin_get_cached_device (ctx, service, &cached_device);
 990
 991     if (ret < 0 || !cached_device->can_enumerate) {
 992       return ret;
 993     }
 994
 995     /* check current active configuration (and cache the first configuration value--
 996        which may be used by claim_interface) */
 997     ret = darwin_check_configuration (ctx, cached_device);
 998     if (ret)
 999       break;
1000
1001     usbi_dbg ("allocating new device in context %p for with session 0x%" PRIx64,
1002               ctx, cached_device->session);
1003
1004     dev = usbi_alloc_device(ctx, (unsigned long) cached_device->session);
1005     if (!dev) {
1006       return LIBUSB_ERROR_NO_MEM;
1007     }
1008
1009     priv = (struct darwin_device_priv *)dev->os_priv;
1010
1011     priv->dev = cached_device;
1012     darwin_ref_cached_device (priv->dev);
1013
1014     if (cached_device->parent_session > 0) {
1015       dev->parent_dev = usbi_get_device_by_session_id (ctx, (unsigned long) cached_device->parent_session);
1016     } else {
1017       dev->parent_dev = NULL;
1018     }
1019     dev->port_number    = cached_device->port;
1020     dev->bus_number     = cached_device->location >> 24;
1021     dev->device_address = cached_device->address;
1022
1023     (*(priv->dev->device))->GetDeviceSpeed (priv->dev->device, &devSpeed);
1024
1025     switch (devSpeed) {
1026     case kUSBDeviceSpeedLow: dev->speed = LIBUSB_SPEED_LOW; break;
1027     case kUSBDeviceSpeedFull: dev->speed = LIBUSB_SPEED_FULL; break;
1028     case kUSBDeviceSpeedHigh: dev->speed = LIBUSB_SPEED_HIGH; break;
1029 #if DeviceVersion >= 500
1030     case kUSBDeviceSpeedSuper: dev->speed = LIBUSB_SPEED_SUPER; break;
1031 #endif
1032     default:
1033       usbi_warn (ctx, "Got unknown device speed %d", devSpeed);
1034     }
1035
1036     ret = usbi_sanitize_device (dev);
1037     if (ret < 0)
1038       break;
1039
1040     usbi_dbg ("found device with address %d port = %d parent = %p at %p", dev->device_address,
1041               dev->port_number, (void *) dev->parent_dev, priv->dev->sys_path);
1042   } while (0);
1043
1044   if (0 == ret) {
1045     usbi_connect_device (dev);
1046   } else {
1047     libusb_unref_device (dev);
1048   }
1049
1050   return ret;
1051 }
1052
1053 static int darwin_scan_devices(struct libusb_context *ctx) {
1054   io_iterator_t deviceIterator;
1055   io_service_t service;
1056   kern_return_t kresult;
1057
1058   kresult = usb_setup_device_iterator (&deviceIterator, 0);
1059   if (kresult != kIOReturnSuccess)
1060     return darwin_to_libusb (kresult);
1061
1062   while ((service = IOIteratorNext (deviceIterator))) {
1063     (void) process_new_device (ctx, service);
1064
1065     IOObjectRelease(service);
1066   }
1067
1068   IOObjectRelease(deviceIterator);
1069
1070   return 0;
1071 }
1072
1073 static int darwin_open (struct libusb_device_handle *dev_handle) {
1074   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)dev_handle->os_priv;
1075   struct darwin_cached_device *dpriv = DARWIN_CACHED_DEVICE(dev_handle->dev);
1076   IOReturn kresult;
1077
1078   if (0 == dpriv->open_count) {
1079     /* try to open the device */
1080     kresult = (*(dpriv->device))->USBDeviceOpenSeize (dpriv->device);
1081     if (kresult != kIOReturnSuccess) {
1082       usbi_warn (HANDLE_CTX (dev_handle), "USBDeviceOpen: %s", darwin_error_str(kresult));
1083
1084       if (kIOReturnExclusiveAccess != kresult) {
1085         return darwin_to_libusb (kresult);
1086       }
1087
1088       /* it is possible to perform some actions on a device that is not open so do not return an error */
1089       priv->is_open = 0;
1090     } else {
1091       priv->is_open = 1;
1092     }
1093
1094     /* create async event source */
1095     kresult = (*(dpriv->device))->CreateDeviceAsyncEventSource (dpriv->device, &priv->cfSource);
1096     if (kresult != kIOReturnSuccess) {
1097       usbi_err (HANDLE_CTX (dev_handle), "CreateDeviceAsyncEventSource: %s", darwin_error_str(kresult));
1098
1099       if (priv->is_open) {
1100         (*(dpriv->device))->USBDeviceClose (dpriv->device);
1101       }
1102
1103       priv->is_open = 0;
1104
1105       return darwin_to_libusb (kresult);
1106     }
1107
1108     CFRetain (libusb_darwin_acfl);
1109
1110     /* add the cfSource to the aync run loop */
1111     CFRunLoopAddSource(libusb_darwin_acfl, priv->cfSource, kCFRunLoopCommonModes);
1112   }
1113
1114   /* device opened successfully */
1115   dpriv->open_count++;
1116
1117   usbi_dbg ("device open for access");
1118
1119   return 0;
1120 }
1121
1122 static void darwin_close (struct libusb_device_handle *dev_handle) {
1123   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)dev_handle->os_priv;
1124   struct darwin_cached_device *dpriv = DARWIN_CACHED_DEVICE(dev_handle->dev);
1125   IOReturn kresult;
1126   int i;
1127
1128   if (dpriv->open_count == 0) {
1129     /* something is probably very wrong if this is the case */
1130     usbi_err (HANDLE_CTX (dev_handle), "Close called on a device that was not open!");
1131     return;
1132   }
1133
1134   dpriv->open_count--;
1135
1136   /* make sure all interfaces are released */
1137   for (i = 0 ; i < USB_MAXINTERFACES ; i++)
1138     if (dev_handle->claimed_interfaces & (1 << i))
1139       libusb_release_interface (dev_handle, i);
1140
1141   if (0 == dpriv->open_count) {
1142     /* delete the device's async event source */
1143     if (priv->cfSource) {
1144       CFRunLoopRemoveSource (libusb_darwin_acfl, priv->cfSource, kCFRunLoopDefaultMode);
1145       CFRelease (priv->cfSource);
1146       priv->cfSource = NULL;
1147       CFRelease (libusb_darwin_acfl);
1148     }
1149
1150     if (priv->is_open) {
1151       /* close the device */
1152       kresult = (*(dpriv->device))->USBDeviceClose(dpriv->device);
1153       if (kresult) {
1154         /* Log the fact that we had a problem closing the file, however failing a
1155          * close isn't really an error, so return success anyway */
1156         usbi_warn (HANDLE_CTX (dev_handle), "USBDeviceClose: %s", darwin_error_str(kresult));
1157       }
1158     }
1159   }
1160 }
1161
1162 static int darwin_get_configuration(struct libusb_device_handle *dev_handle, int *config) {
1163   struct darwin_cached_device *dpriv = DARWIN_CACHED_DEVICE(dev_handle->dev);
1164
1165   *config = (int) dpriv->active_config;
1166
1167   return 0;
1168 }
1169
1170 static int darwin_set_configuration(struct libusb_device_handle *dev_handle, int config) {
1171   struct darwin_cached_device *dpriv = DARWIN_CACHED_DEVICE(dev_handle->dev);
1172   IOReturn kresult;
1173   int i;
1174
1175   /* Setting configuration will invalidate the interface, so we need
1176      to reclaim it. First, dispose of existing interfaces, if any. */
1177   for (i = 0 ; i < USB_MAXINTERFACES ; i++)
1178     if (dev_handle->claimed_interfaces & (1 << i))
1179       darwin_release_interface (dev_handle, i);
1180
1181   kresult = (*(dpriv->device))->SetConfiguration (dpriv->device, config);
1182   if (kresult != kIOReturnSuccess)
1183     return darwin_to_libusb (kresult);
1184
1185   /* Reclaim any interfaces. */
1186   for (i = 0 ; i < USB_MAXINTERFACES ; i++)
1187     if (dev_handle->claimed_interfaces & (1 << i))
1188       darwin_claim_interface (dev_handle, i);
1189
1190   dpriv->active_config = config;
1191
1192   return 0;
1193 }
1194
1195 static int darwin_get_interface (usb_device_t **darwin_device, uint8_t ifc, io_service_t *usbInterfacep) {
1196   IOUSBFindInterfaceRequest request;
1197   kern_return_t             kresult;
1198   io_iterator_t             interface_iterator;
1199   UInt8                     bInterfaceNumber;
1200   int                       ret;
1201
1202   *usbInterfacep = IO_OBJECT_NULL;
1203
1204   /* Setup the Interface Request */
1205   request.bInterfaceClass    = kIOUSBFindInterfaceDontCare;
1206   request.bInterfaceSubClass = kIOUSBFindInterfaceDontCare;
1207   request.bInterfaceProtocol = kIOUSBFindInterfaceDontCare;
1208   request.bAlternateSetting  = kIOUSBFindInterfaceDontCare;
1209
1210   kresult = (*(darwin_device))->CreateInterfaceIterator(darwin_device, &request, &interface_iterator);
1211   if (kresult)
1212     return kresult;
1213
1214   while ((*usbInterfacep = IOIteratorNext(interface_iterator))) {
1215     /* find the interface number */
1216     ret = get_ioregistry_value_number (*usbInterfacep, CFSTR("bInterfaceNumber"), kCFNumberSInt8Type,
1217                                        &bInterfaceNumber);
1218
1219     if (ret && bInterfaceNumber == ifc) {
1220       break;
1221     }
1222
1223     (void) IOObjectRelease (*usbInterfacep);
1224   }
1225
1226   /* done with the interface iterator */
1227   IOObjectRelease(interface_iterator);
1228
1229   return 0;
1230 }
1231
1232 static int get_endpoints (struct libusb_device_handle *dev_handle, int iface) {
1233   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)dev_handle->os_priv;
1234
1235   /* current interface */
1236   struct darwin_interface *cInterface = &priv->interfaces[iface];
1237
1238   kern_return_t kresult;
1239
1240   u_int8_t numep, direction, number;
1241   u_int8_t dont_care1, dont_care3;
1242   u_int16_t dont_care2;
1243   int rc;
1244
1245   usbi_dbg ("building table of endpoints.");
1246
1247   /* retrieve the total number of endpoints on this interface */
1248   kresult = (*(cInterface->interface))->GetNumEndpoints(cInterface->interface, &numep);
1249   if (kresult) {
1250     usbi_err (HANDLE_CTX (dev_handle), "can't get number of endpoints for interface: %s", darwin_error_str(kresult));
1251     return darwin_to_libusb (kresult);
1252   }
1253
1254   /* iterate through pipe references */
1255   for (int i = 1 ; i <= numep ; i++) {
1256     kresult = (*(cInterface->interface))->GetPipeProperties(cInterface->interface, i, &direction, &number, &dont_care1,
1257                                                             &dont_care2, &dont_care3);
1258
1259     if (kresult != kIOReturnSuccess) {
1260       /* probably a buggy device. try to get the endpoint address from the descriptors */
1261       struct libusb_config_descriptor *config;
1262       const struct libusb_endpoint_descriptor *endpoint_desc;
1263       UInt8 alt_setting;
1264
1265       kresult = (*(cInterface->interface))->GetAlternateSetting (cInterface->interface, &alt_setting);
1266       if (kresult) {
1267         usbi_err (HANDLE_CTX (dev_handle), "can't get alternate setting for interface");
1268         return darwin_to_libusb (kresult);
1269       }
1270
1271       rc = libusb_get_active_config_descriptor (dev_handle->dev, &config);
1272       if (LIBUSB_SUCCESS != rc) {
1273         return rc;
1274       }
1275
1276       endpoint_desc = config->interface[iface].altsetting[alt_setting].endpoint + i - 1;
1277
1278       cInterface->endpoint_addrs[i - 1] = endpoint_desc->bEndpointAddress;
1279     } else {
1280       cInterface->endpoint_addrs[i - 1] = (((kUSBIn == direction) << kUSBRqDirnShift) | (number & LIBUSB_ENDPOINT_ADDRESS_MASK));
1281     }
1282
1283     usbi_dbg ("interface: %i pipe %i: dir: %i number: %i", iface, i, cInterface->endpoint_addrs[i - 1] >> kUSBRqDirnShift,
1284               cInterface->endpoint_addrs[i - 1] & LIBUSB_ENDPOINT_ADDRESS_MASK);
1285   }
1286
1287   cInterface->num_endpoints = numep;
1288
1289   return 0;
1290 }
1291
1292 static int darwin_claim_interface(struct libusb_device_handle *dev_handle, int iface) {
1293   struct darwin_cached_device *dpriv = DARWIN_CACHED_DEVICE(dev_handle->dev);
1294   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)dev_handle->os_priv;
1295   io_service_t          usbInterface = IO_OBJECT_NULL;
1296   IOReturn kresult;
1297   IOCFPlugInInterface **plugInInterface = NULL;
1298   SInt32                score;
1299
1300   /* current interface */
1301   struct darwin_interface *cInterface = &priv->interfaces[iface];
1302
1303   kresult = darwin_get_interface (dpriv->device, iface, &usbInterface);
1304   if (kresult != kIOReturnSuccess)
1305     return darwin_to_libusb (kresult);
1306
1307   /* make sure we have an interface */
1308   if (!usbInterface && dpriv->first_config != 0) {
1309     usbi_info (HANDLE_CTX (dev_handle), "no interface found; setting configuration: %d", dpriv->first_config);
1310
1311     /* set the configuration */
1312     kresult = darwin_set_configuration (dev_handle, dpriv->first_config);
1313     if (kresult != LIBUSB_SUCCESS) {
1314       usbi_err (HANDLE_CTX (dev_handle), "could not set configuration");
1315       return kresult;
1316     }
1317
1318     kresult = darwin_get_interface (dpriv->device, iface, &usbInterface);
1319     if (kresult) {
1320       usbi_err (HANDLE_CTX (dev_handle), "darwin_get_interface: %s", darwin_error_str(kresult));
1321       return darwin_to_libusb (kresult);
1322     }
1323   }
1324
1325   if (!usbInterface) {
1326     usbi_err (HANDLE_CTX (dev_handle), "interface not found");
1327     return LIBUSB_ERROR_NOT_FOUND;
1328   }
1329
1330   /* get an interface to the device's interface */
1331   kresult = IOCreatePlugInInterfaceForService (usbInterface, kIOUSBInterfaceUserClientTypeID,
1332                                                kIOCFPlugInInterfaceID, &plugInInterface, &score);
1333
1334   /* ignore release error */
1335   (void)IOObjectRelease (usbInterface);
1336
1337   if (kresult) {
1338     usbi_err (HANDLE_CTX (dev_handle), "IOCreatePlugInInterfaceForService: %s", darwin_error_str(kresult));
1339     return darwin_to_libusb (kresult);
1340   }
1341
1342   if (!plugInInterface) {
1343     usbi_err (HANDLE_CTX (dev_handle), "plugin interface not found");
1344     return LIBUSB_ERROR_NOT_FOUND;
1345   }
1346
1347   /* Do the actual claim */
1348   kresult = (*plugInInterface)->QueryInterface(plugInInterface,
1349                                                CFUUIDGetUUIDBytes(kIOUSBInterfaceInterfaceID),
1350                                                (LPVOID)&cInterface->interface);
1351   /* We no longer need the intermediate plug-in */
1352   /* Use release instead of IODestroyPlugInInterface to avoid stopping IOServices associated with this device */
1353   (*plugInInterface)->Release (plugInInterface);
1354   if (kresult || !cInterface->interface) {
1355     usbi_err (HANDLE_CTX (dev_handle), "QueryInterface: %s", darwin_error_str(kresult));
1356     return darwin_to_libusb (kresult);
1357   }
1358
1359   /* claim the interface */
1360   kresult = (*(cInterface->interface))->USBInterfaceOpen(cInterface->interface);
1361   if (kresult) {
1362     usbi_err (HANDLE_CTX (dev_handle), "USBInterfaceOpen: %s", darwin_error_str(kresult));
1363     return darwin_to_libusb (kresult);
1364   }
1365
1366   /* update list of endpoints */
1367   kresult = get_endpoints (dev_handle, iface);
1368   if (kresult) {
1369     /* this should not happen */
1370     darwin_release_interface (dev_handle, iface);
1371     usbi_err (HANDLE_CTX (dev_handle), "could not build endpoint table");
1372     return kresult;
1373   }
1374
1375   cInterface->cfSource = NULL;
1376
1377   /* create async event source */
1378   kresult = (*(cInterface->interface))->CreateInterfaceAsyncEventSource (cInterface->interface, &cInterface->cfSource);
1379   if (kresult != kIOReturnSuccess) {
1380     usbi_err (HANDLE_CTX (dev_handle), "could not create async event source");
1381
1382     /* can't continue without an async event source */
1383     (void)darwin_release_interface (dev_handle, iface);
1384
1385     return darwin_to_libusb (kresult);
1386   }
1387
1388   /* add the cfSource to the async thread's run loop */
1389   CFRunLoopAddSource(libusb_darwin_acfl, cInterface->cfSource, kCFRunLoopDefaultMode);
1390
1391   usbi_dbg ("interface opened");
1392
1393   return 0;
1394 }
1395
1396 static int darwin_release_interface(struct libusb_device_handle *dev_handle, int iface) {
1397   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)dev_handle->os_priv;
1398   IOReturn kresult;
1399
1400   /* current interface */
1401   struct darwin_interface *cInterface = &priv->interfaces[iface];
1402
1403   /* Check to see if an interface is open */
1404   if (!cInterface->interface)
1405     return LIBUSB_SUCCESS;
1406
1407   /* clean up endpoint data */
1408   cInterface->num_endpoints = 0;
1409
1410   /* delete the interface's async event source */
1411   if (cInterface->cfSource) {
1412     CFRunLoopRemoveSource (libusb_darwin_acfl, cInterface->cfSource, kCFRunLoopDefaultMode);
1413     CFRelease (cInterface->cfSource);
1414   }
1415
1416   kresult = (*(cInterface->interface))->USBInterfaceClose(cInterface->interface);
1417   if (kresult)
1418     usbi_warn (HANDLE_CTX (dev_handle), "USBInterfaceClose: %s", darwin_error_str(kresult));
1419
1420   kresult = (*(cInterface->interface))->Release(cInterface->interface);
1421   if (kresult != kIOReturnSuccess)
1422     usbi_warn (HANDLE_CTX (dev_handle), "Release: %s", darwin_error_str(kresult));
1423
1424   cInterface->interface = (usb_interface_t **) IO_OBJECT_NULL;
1425
1426   return darwin_to_libusb (kresult);
1427 }
1428
1429 static int darwin_set_interface_altsetting(struct libusb_device_handle *dev_handle, int iface, int altsetting) {
1430   struct darwin_device_handle_priv *priv = (struct darwin_device_handle_priv *)dev_handle->os_priv;
1431   IOReturn kresult;
1432
1433   /* current interface */
1434   struct darwin_interface *cInterface = &priv->interfaces[iface];
1435
1436   if (!cInterface->interface)
1437     return LIBUSB_ERROR_NO_DEVICE;
1438
1439   kresult = (*(cInterface->interface))->SetAlternateInterface (cInterface->interface, altsetting);
1440   if (kresult != kIOReturnSuccess)
1441     darwin_reset_device (dev_handle);
1442
1443   /* update list of endpoints */
1444   kresult = get_endpoints (dev_handle, iface);
1445   if (kresult) {
1446     /* this should not happen */
1447     darwin_release_interface (dev_handle, iface);
1448     usbi_err (HANDLE_CTX (dev_handle), "could not build endpoint table");
1449     return kresult;
1450   }
1451
1452   return darwin_to_libusb (kresult);
1453 }
1454
1455 static int darwin_clear_halt(struct libusb_device_handle *dev_handle, unsigned char endpoint) {
1456   /* current interface */
1457   struct darwin_interface *cInterface;
1458   IOReturn kresult;
1459   uint8_t pipeRef;
1460
1461   /* determine the interface/endpoint to use */
1462   if (ep_to_pipeRef (dev_handle, endpoint, &pipeRef, NULL, &cInterface) != 0) {
1463     usbi_err (HANDLE_CTX (dev_handle), "endpoint not found on any open interface");
1464
1465     return LIBUSB_ERROR_NOT_FOUND;
1466   }
1467
1468   /* newer versions of darwin support clearing additional bits on the device's endpoint */
1469   kresult = (*(cInterface->interface))->ClearPipeStallBothEnds(cInterface->interface, pipeRef);
1470   if (kresult)
1471     usbi_warn (HANDLE_CTX (dev_handle), "ClearPipeStall: %s", darwin_error_str (kresult));
1472
1473   return darwin_to_libusb (kresult);
1474 }
1475
1476 static int darwin_reset_device(struct libusb_device_handle *dev_handle) {
1477   struct darwin_cached_device *dpriv = DARWIN_CACHED_DEVICE(dev_handle->dev);
1478   IOUSBDeviceDescriptor descriptor;
1479   IOUSBConfigurationDescriptorPtr cached_configuration;
1480   IOUSBConfigurationDescriptor configuration;
1481   bool reenumerate = false;
1482   IOReturn kresult;
1483   int i;
1484
1485   kresult = (*(dpriv->device))->ResetDevice (dpriv->device);
1486   if (kresult) {
1487     usbi_err (HANDLE_CTX (dev_handle), "ResetDevice: %s", darwin_error_str (kresult));
1488     return darwin_to_libusb (kresult);
1489   }
1490
1491   do {
1492     usbi_dbg ("darwin/reset_device: checking if device descriptor changed");
1493
1494     /* ignore return code. if we can't get a descriptor it might be worthwhile re-enumerating anway */
1495     (void) darwin_request_descriptor (dpriv->device, kUSBDeviceDesc, 0, &descriptor, sizeof (descriptor));
1496
1497     /* check if the device descriptor has changed */
1498     if (0 != memcmp (&dpriv->dev_descriptor, &descriptor, sizeof (descriptor))) {
1499       reenumerate = true;
1500       break;
1501     }
1502
1503     /* check if any configuration descriptor has changed */
1504     for (i = 0 ; i < descriptor.bNumConfigurations ; ++i) {
1505       usbi_dbg ("darwin/reset_device: checking if configuration descriptor %d changed", i);
1506
1507       (void) darwin_request_descriptor (dpriv->device, kUSBConfDesc, i, &configuration, sizeof (configuration));
1508       (*(dpriv->device))->GetConfigurationDescriptorPtr (dpriv->device, i, &cached_configuration);
1509
1510       if (!cached_configuration || 0 != memcmp (cached_configuration, &configuration, sizeof (configuration))) {
1511         reenumerate = true;
1512         break;
1513       }
1514     }
1515   } while (0);
1516
1517   if (reenumerate) {
1518     usbi_dbg ("darwin/reset_device: device requires reenumeration");
1519     (void) (*(dpriv->device))->USBDeviceReEnumerate (dpriv->device, 0);
1520     return LIBUSB_ERROR_NOT_FOUND;
1521   }
1522
1523   usbi_dbg ("darwin/reset_device: device reset complete");
1524
1525   return LIBUSB_SUCCESS;
1526 }
1527
1528 static int darwin_kernel_driver_active(struct libusb_device_handle *dev_handle, int interface) {
1529   struct darwin_cached_device *dpriv = DARWIN_CACHED_DEVICE(dev_handle->dev);
1530   io_service_t usbInterface;
1531   CFTypeRef driver;
1532   IOReturn kresult;
1533
1534   kresult = darwin_get_interface (dpriv->device, interface, &usbInterface);
1535   if (kresult) {
1536     usbi_err (HANDLE_CTX (dev_handle), "darwin_get_interface: %s", darwin_error_str(kresult));
1537
1538     return darwin_to_libusb (kresult);
1539   }
1540
1541   driver = IORegistryEntryCreateCFProperty (usbInterface, kIOBundleIdentifierKey, kCFAllocatorDefault, 0);
1542   IOObjectRelease (usbInterface);
1543
1544   if (driver) {
1545     CFRelease (driver);
1546
1547     return 1;
1548   }
1549
1550   /* no driver */
1551   return 0;
1552 }
1553
1554 /* attaching/detaching kernel drivers is not currently supported (maybe in the future?) */
1555 static int darwin_attach_kernel_driver (struct libusb_device_handle *dev_handle, int interface) {
1556   UNUSED(dev_handle);
1557   UNUSED(interface);
1558   return LIBUSB_ERROR_NOT_SUPPORTED;
1559 }
1560
1561 static int darwin_detach_kernel_driver (struct libusb_device_handle *dev_handle, int interface) {
1562   UNUSED(dev_handle);
1563   UNUSED(interface);
1564   return LIBUSB_ERROR_NOT_SUPPORTED;
1565 }
1566
1567 static void darwin_destroy_device(struct libusb_device *dev) {
1568   struct darwin_device_priv *dpriv = (struct darwin_device_priv *) dev->os_priv;
1569
1570   if (dpriv->dev) {
1571     /* need to hold the lock in case this is the last reference to the device */
1572     usbi_mutex_lock(&darwin_cached_devices_lock);
1573     darwin_deref_cached_device (dpriv->dev);
1574     dpriv->dev = NULL;
1575     usbi_mutex_unlock(&darwin_cached_devices_lock);
1576   }
1577 }
1578
1579 static int submit_bulk_transfer(struct usbi_transfer *itransfer) {
1580   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1581
1582   IOReturn               ret;
1583   uint8_t                transferType;
1584   /* None of the values below are used in libusbx for bulk transfers */
1585   uint8_t                direction, number, interval, pipeRef;
1586   uint16_t               maxPacketSize;
1587
1588   struct darwin_interface *cInterface;
1589
1590   if (ep_to_pipeRef (transfer->dev_handle, transfer->endpoint, &pipeRef, NULL, &cInterface) != 0) {
1591     usbi_err (TRANSFER_CTX (transfer), "endpoint not found on any open interface");
1592
1593     return LIBUSB_ERROR_NOT_FOUND;
1594   }
1595
1596   ret = (*(cInterface->interface))->GetPipeProperties (cInterface->interface, pipeRef, &direction, &number,
1597                                                        &transferType, &maxPacketSize, &interval);
1598
1599   if (ret) {
1600     usbi_err (TRANSFER_CTX (transfer), "bulk transfer failed (dir = %s): %s (code = 0x%08x)", IS_XFERIN(transfer) ? "In" : "Out",
1601               darwin_error_str(ret), ret);
1602     return darwin_to_libusb (ret);
1603   }
1604
1605   if (0 != (transfer->length % maxPacketSize)) {
1606     /* do not need a zero packet */
1607     transfer->flags &= ~LIBUSB_TRANSFER_ADD_ZERO_PACKET;
1608   }
1609
1610   /* submit the request */
1611   /* timeouts are unavailable on interrupt endpoints */
1612   if (transferType == kUSBInterrupt) {
1613     if (IS_XFERIN(transfer))
1614       ret = (*(cInterface->interface))->ReadPipeAsync(cInterface->interface, pipeRef, transfer->buffer,
1615                                                       transfer->length, darwin_async_io_callback, itransfer);
1616     else
1617       ret = (*(cInterface->interface))->WritePipeAsync(cInterface->interface, pipeRef, transfer->buffer,
1618                                                        transfer->length, darwin_async_io_callback, itransfer);
1619   } else {
1620     itransfer->timeout_flags |= USBI_TRANSFER_OS_HANDLES_TIMEOUT;
1621
1622     if (IS_XFERIN(transfer))
1623       ret = (*(cInterface->interface))->ReadPipeAsyncTO(cInterface->interface, pipeRef, transfer->buffer,
1624                                                         transfer->length, transfer->timeout, transfer->timeout,
1625                                                         darwin_async_io_callback, (void *)itransfer);
1626     else
1627       ret = (*(cInterface->interface))->WritePipeAsyncTO(cInterface->interface, pipeRef, transfer->buffer,
1628                                                          transfer->length, transfer->timeout, transfer->timeout,
1629                                                          darwin_async_io_callback, (void *)itransfer);
1630   }
1631
1632   if (ret)
1633     usbi_err (TRANSFER_CTX (transfer), "bulk transfer failed (dir = %s): %s (code = 0x%08x)", IS_XFERIN(transfer) ? "In" : "Out",
1634                darwin_error_str(ret), ret);
1635
1636   return darwin_to_libusb (ret);
1637 }
1638
1639 #if InterfaceVersion >= 550
1640 static int submit_stream_transfer(struct usbi_transfer *itransfer) {
1641   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1642   struct darwin_interface *cInterface;
1643   uint8_t pipeRef;
1644   IOReturn ret;
1645
1646   if (ep_to_pipeRef (transfer->dev_handle, transfer->endpoint, &pipeRef, NULL, &cInterface) != 0) {
1647     usbi_err (TRANSFER_CTX (transfer), "endpoint not found on any open interface");
1648
1649     return LIBUSB_ERROR_NOT_FOUND;
1650   }
1651
1652   itransfer->timeout_flags |= USBI_TRANSFER_OS_HANDLES_TIMEOUT;
1653
1654   if (IS_XFERIN(transfer))
1655     ret = (*(cInterface->interface))->ReadStreamsPipeAsyncTO(cInterface->interface, pipeRef, itransfer->stream_id,
1656                                                              transfer->buffer, transfer->length, transfer->timeout,
1657                                                              transfer->timeout, darwin_async_io_callback, (void *)itransfer);
1658   else
1659     ret = (*(cInterface->interface))->WriteStreamsPipeAsyncTO(cInterface->interface, pipeRef, itransfer->stream_id,
1660                                                               transfer->buffer, transfer->length, transfer->timeout,
1661                                                               transfer->timeout, darwin_async_io_callback, (void *)itransfer);
1662
1663   if (ret)
1664     usbi_err (TRANSFER_CTX (transfer), "bulk stream transfer failed (dir = %s): %s (code = 0x%08x)", IS_XFERIN(transfer) ? "In" : "Out",
1665                darwin_error_str(ret), ret);
1666
1667   return darwin_to_libusb (ret);
1668 }
1669 #endif
1670
1671 static int submit_iso_transfer(struct usbi_transfer *itransfer) {
1672   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1673   struct darwin_transfer_priv *tpriv = usbi_transfer_get_os_priv(itransfer);
1674
1675   IOReturn kresult;
1676   uint8_t direction, number, interval, pipeRef, transferType;
1677   uint16_t maxPacketSize;
1678   UInt64 frame;
1679   AbsoluteTime atTime;
1680   int i;
1681
1682   struct darwin_interface *cInterface;
1683
1684   /* construct an array of IOUSBIsocFrames, reuse the old one if possible */
1685   if (tpriv->isoc_framelist && tpriv->num_iso_packets != transfer->num_iso_packets) {
1686     free(tpriv->isoc_framelist);
1687     tpriv->isoc_framelist = NULL;
1688   }
1689
1690   if (!tpriv->isoc_framelist) {
1691     tpriv->num_iso_packets = transfer->num_iso_packets;
1692     tpriv->isoc_framelist = (IOUSBIsocFrame*) calloc (transfer->num_iso_packets, sizeof(IOUSBIsocFrame));
1693     if (!tpriv->isoc_framelist)
1694       return LIBUSB_ERROR_NO_MEM;
1695   }
1696
1697   /* copy the frame list from the libusb descriptor (the structures differ only is member order) */
1698   for (i = 0 ; i < transfer->num_iso_packets ; i++)
1699     tpriv->isoc_framelist[i].frReqCount = transfer->iso_packet_desc[i].length;
1700
1701   /* determine the interface/endpoint to use */
1702   if (ep_to_pipeRef (transfer->dev_handle, transfer->endpoint, &pipeRef, NULL, &cInterface) != 0) {
1703     usbi_err (TRANSFER_CTX (transfer), "endpoint not found on any open interface");
1704
1705     return LIBUSB_ERROR_NOT_FOUND;
1706   }
1707
1708   /* determine the properties of this endpoint and the speed of the device */
1709   (*(cInterface->interface))->GetPipeProperties (cInterface->interface, pipeRef, &direction, &number,
1710                                                  &transferType, &maxPacketSize, &interval);
1711
1712   /* Last but not least we need the bus frame number */
1713   kresult = (*(cInterface->interface))->GetBusFrameNumber(cInterface->interface, &frame, &atTime);
1714   if (kresult) {
1715     usbi_err (TRANSFER_CTX (transfer), "failed to get bus frame number: %d", kresult);
1716     free(tpriv->isoc_framelist);
1717     tpriv->isoc_framelist = NULL;
1718
1719     return darwin_to_libusb (kresult);
1720   }
1721
1722   (*(cInterface->interface))->GetPipeProperties (cInterface->interface, pipeRef, &direction, &number,
1723                                                  &transferType, &maxPacketSize, &interval);
1724
1725   /* schedule for a frame a little in the future */
1726   frame += 4;
1727
1728   if (cInterface->frames[transfer->endpoint] && frame < cInterface->frames[transfer->endpoint])
1729     frame = cInterface->frames[transfer->endpoint];
1730
1731   /* submit the request */
1732   if (IS_XFERIN(transfer))
1733     kresult = (*(cInterface->interface))->ReadIsochPipeAsync(cInterface->interface, pipeRef, transfer->buffer, frame,
1734                                                              transfer->num_iso_packets, tpriv->isoc_framelist, darwin_async_io_callback,
1735                                                              itransfer);
1736   else
1737     kresult = (*(cInterface->interface))->WriteIsochPipeAsync(cInterface->interface, pipeRef, transfer->buffer, frame,
1738                                                               transfer->num_iso_packets, tpriv->isoc_framelist, darwin_async_io_callback,
1739                                                               itransfer);
1740
1741   if (LIBUSB_SPEED_FULL == transfer->dev_handle->dev->speed)
1742     /* Full speed */
1743     cInterface->frames[transfer->endpoint] = frame + transfer->num_iso_packets * (1 << (interval - 1));
1744   else
1745     /* High/super speed */
1746     cInterface->frames[transfer->endpoint] = frame + transfer->num_iso_packets * (1 << (interval - 1)) / 8;
1747
1748   if (kresult != kIOReturnSuccess) {
1749     usbi_err (TRANSFER_CTX (transfer), "isochronous transfer failed (dir: %s): %s", IS_XFERIN(transfer) ? "In" : "Out",
1750                darwin_error_str(kresult));
1751     free (tpriv->isoc_framelist);
1752     tpriv->isoc_framelist = NULL;
1753   }
1754
1755   return darwin_to_libusb (kresult);
1756 }
1757
1758 static int submit_control_transfer(struct usbi_transfer *itransfer) {
1759   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1760   struct libusb_control_setup *setup = (struct libusb_control_setup *) transfer->buffer;
1761   struct darwin_cached_device *dpriv = DARWIN_CACHED_DEVICE(transfer->dev_handle->dev);
1762   struct darwin_transfer_priv *tpriv = usbi_transfer_get_os_priv(itransfer);
1763
1764   IOReturn               kresult;
1765
1766   memset(&tpriv->req, 0, sizeof(tpriv->req));
1767
1768   /* IOUSBDeviceInterface expects the request in cpu endianness */
1769   tpriv->req.bmRequestType     = setup->bmRequestType;
1770   tpriv->req.bRequest          = setup->bRequest;
1771   /* these values should be in bus order from libusb_fill_control_setup */
1772   tpriv->req.wValue            = OSSwapLittleToHostInt16 (setup->wValue);
1773   tpriv->req.wIndex            = OSSwapLittleToHostInt16 (setup->wIndex);
1774   tpriv->req.wLength           = OSSwapLittleToHostInt16 (setup->wLength);
1775   /* data is stored after the libusb control block */
1776   tpriv->req.pData             = transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
1777   tpriv->req.completionTimeout = transfer->timeout;
1778   tpriv->req.noDataTimeout     = transfer->timeout;
1779
1780   itransfer->timeout_flags |= USBI_TRANSFER_OS_HANDLES_TIMEOUT;
1781
1782   /* all transfers in libusb-1.0 are async */
1783
1784   if (transfer->endpoint) {
1785     struct darwin_interface *cInterface;
1786     uint8_t                 pipeRef;
1787
1788     if (ep_to_pipeRef (transfer->dev_handle, transfer->endpoint, &pipeRef, NULL, &cInterface) != 0) {
1789       usbi_err (TRANSFER_CTX (transfer), "endpoint not found on any open interface");
1790
1791       return LIBUSB_ERROR_NOT_FOUND;
1792     }
1793
1794     kresult = (*(cInterface->interface))->ControlRequestAsyncTO (cInterface->interface, pipeRef, &(tpriv->req), darwin_async_io_callback, itransfer);
1795   } else
1796     /* control request on endpoint 0 */
1797     kresult = (*(dpriv->device))->DeviceRequestAsyncTO(dpriv->device, &(tpriv->req), darwin_async_io_callback, itransfer);
1798
1799   if (kresult != kIOReturnSuccess)
1800     usbi_err (TRANSFER_CTX (transfer), "control request failed: %s", darwin_error_str(kresult));
1801
1802   return darwin_to_libusb (kresult);
1803 }
1804
1805 static int darwin_submit_transfer(struct usbi_transfer *itransfer) {
1806   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1807
1808   switch (transfer->type) {
1809   case LIBUSB_TRANSFER_TYPE_CONTROL:
1810     return submit_control_transfer(itransfer);
1811   case LIBUSB_TRANSFER_TYPE_BULK:
1812   case LIBUSB_TRANSFER_TYPE_INTERRUPT:
1813     return submit_bulk_transfer(itransfer);
1814   case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
1815     return submit_iso_transfer(itransfer);
1816   case LIBUSB_TRANSFER_TYPE_BULK_STREAM:
1817 #if InterfaceVersion >= 550
1818     return submit_stream_transfer(itransfer);
1819 #else
1820     usbi_err (TRANSFER_CTX(transfer), "IOUSBFamily version does not support bulk stream transfers");
1821     return LIBUSB_ERROR_NOT_SUPPORTED;
1822 #endif
1823   default:
1824     usbi_err (TRANSFER_CTX(transfer), "unknown endpoint type %d", transfer->type);
1825     return LIBUSB_ERROR_INVALID_PARAM;
1826   }
1827 }
1828
1829 static int cancel_control_transfer(struct usbi_transfer *itransfer) {
1830   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1831   struct darwin_cached_device *dpriv = DARWIN_CACHED_DEVICE(transfer->dev_handle->dev);
1832   IOReturn kresult;
1833
1834   usbi_warn (ITRANSFER_CTX (itransfer), "aborting all transactions control pipe");
1835
1836   if (!dpriv->device)
1837     return LIBUSB_ERROR_NO_DEVICE;
1838
1839   kresult = (*(dpriv->device))->USBDeviceAbortPipeZero (dpriv->device);
1840
1841   return darwin_to_libusb (kresult);
1842 }
1843
1844 static int darwin_abort_transfers (struct usbi_transfer *itransfer) {
1845   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1846   struct darwin_cached_device *dpriv = DARWIN_CACHED_DEVICE(transfer->dev_handle->dev);
1847   struct darwin_interface *cInterface;
1848   uint8_t pipeRef, iface;
1849   IOReturn kresult;
1850
1851   if (ep_to_pipeRef (transfer->dev_handle, transfer->endpoint, &pipeRef, &iface, &cInterface) != 0) {
1852     usbi_err (TRANSFER_CTX (transfer), "endpoint not found on any open interface");
1853
1854     return LIBUSB_ERROR_NOT_FOUND;
1855   }
1856
1857   if (!dpriv->device)
1858     return LIBUSB_ERROR_NO_DEVICE;
1859
1860   usbi_warn (ITRANSFER_CTX (itransfer), "aborting all transactions on interface %d pipe %d", iface, pipeRef);
1861
1862   /* abort transactions */
1863 #if InterfaceVersion >= 550
1864   if (LIBUSB_TRANSFER_TYPE_BULK_STREAM == transfer->type)
1865     (*(cInterface->interface))->AbortStreamsPipe (cInterface->interface, pipeRef, itransfer->stream_id);
1866   else
1867 #endif
1868     (*(cInterface->interface))->AbortPipe (cInterface->interface, pipeRef);
1869
1870   usbi_dbg ("calling clear pipe stall to clear the data toggle bit");
1871
1872   /* newer versions of darwin support clearing additional bits on the device's endpoint */
1873   kresult = (*(cInterface->interface))->ClearPipeStallBothEnds(cInterface->interface, pipeRef);
1874
1875   return darwin_to_libusb (kresult);
1876 }
1877
1878 static int darwin_cancel_transfer(struct usbi_transfer *itransfer) {
1879   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1880
1881   switch (transfer->type) {
1882   case LIBUSB_TRANSFER_TYPE_CONTROL:
1883     return cancel_control_transfer(itransfer);
1884   case LIBUSB_TRANSFER_TYPE_BULK:
1885   case LIBUSB_TRANSFER_TYPE_INTERRUPT:
1886   case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
1887     return darwin_abort_transfers (itransfer);
1888   default:
1889     usbi_err (TRANSFER_CTX(transfer), "unknown endpoint type %d", transfer->type);
1890     return LIBUSB_ERROR_INVALID_PARAM;
1891   }
1892 }
1893
1894 static void darwin_clear_transfer_priv (struct usbi_transfer *itransfer) {
1895   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1896   struct darwin_transfer_priv *tpriv = usbi_transfer_get_os_priv(itransfer);
1897
1898   if (transfer->type == LIBUSB_TRANSFER_TYPE_ISOCHRONOUS && tpriv->isoc_framelist) {
1899     free (tpriv->isoc_framelist);
1900     tpriv->isoc_framelist = NULL;
1901   }
1902 }
1903
1904 static void darwin_async_io_callback (void *refcon, IOReturn result, void *arg0) {
1905   struct usbi_transfer *itransfer = (struct usbi_transfer *)refcon;
1906   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1907   struct darwin_transfer_priv *tpriv = usbi_transfer_get_os_priv(itransfer);
1908
1909   usbi_dbg ("an async io operation has completed");
1910
1911   /* if requested write a zero packet */
1912   if (kIOReturnSuccess == result && IS_XFEROUT(transfer) && transfer->flags & LIBUSB_TRANSFER_ADD_ZERO_PACKET) {
1913     struct darwin_interface *cInterface;
1914     uint8_t pipeRef;
1915
1916     (void) ep_to_pipeRef (transfer->dev_handle, transfer->endpoint, &pipeRef, NULL, &cInterface);
1917
1918     (*(cInterface->interface))->WritePipe (cInterface->interface, pipeRef, transfer->buffer, 0);
1919   }
1920
1921   tpriv->result = result;
1922   tpriv->size = (UInt32) (uintptr_t) arg0;
1923
1924   /* signal the core that this transfer is complete */
1925   usbi_signal_transfer_completion(itransfer);
1926 }
1927
1928 static int darwin_transfer_status (struct usbi_transfer *itransfer, kern_return_t result) {
1929   if (itransfer->timeout_flags & USBI_TRANSFER_TIMED_OUT)
1930     result = kIOUSBTransactionTimeout;
1931
1932   switch (result) {
1933   case kIOReturnUnderrun:
1934   case kIOReturnSuccess:
1935     return LIBUSB_TRANSFER_COMPLETED;
1936   case kIOReturnAborted:
1937     return LIBUSB_TRANSFER_CANCELLED;
1938   case kIOUSBPipeStalled:
1939     usbi_dbg ("transfer error: pipe is stalled");
1940     return LIBUSB_TRANSFER_STALL;
1941   case kIOReturnOverrun:
1942     usbi_warn (ITRANSFER_CTX (itransfer), "transfer error: data overrun");
1943     return LIBUSB_TRANSFER_OVERFLOW;
1944   case kIOUSBTransactionTimeout:
1945     usbi_warn (ITRANSFER_CTX (itransfer), "transfer error: timed out");
1946     itransfer->timeout_flags |= USBI_TRANSFER_TIMED_OUT;
1947     return LIBUSB_TRANSFER_TIMED_OUT;
1948   default:
1949     usbi_warn (ITRANSFER_CTX (itransfer), "transfer error: %s (value = 0x%08x)", darwin_error_str (result), result);
1950     return LIBUSB_TRANSFER_ERROR;
1951   }
1952 }
1953
1954 static int darwin_handle_transfer_completion (struct usbi_transfer *itransfer) {
1955   struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1956   struct darwin_transfer_priv *tpriv = usbi_transfer_get_os_priv(itransfer);
1957   int isIsoc      = LIBUSB_TRANSFER_TYPE_ISOCHRONOUS == transfer->type;
1958   int isBulk      = LIBUSB_TRANSFER_TYPE_BULK == transfer->type;
1959   int isControl   = LIBUSB_TRANSFER_TYPE_CONTROL == transfer->type;
1960   int isInterrupt = LIBUSB_TRANSFER_TYPE_INTERRUPT == transfer->type;
1961   int i;
1962
1963   if (!isIsoc && !isBulk && !isControl && !isInterrupt) {
1964     usbi_err (TRANSFER_CTX(transfer), "unknown endpoint type %d", transfer->type);
1965     return LIBUSB_ERROR_INVALID_PARAM;
1966   }
1967
1968   usbi_dbg ("handling %s completion with kernel status %d",
1969              isControl ? "control" : isBulk ? "bulk" : isIsoc ? "isoc" : "interrupt", tpriv->result);
1970
1971   if (kIOReturnSuccess == tpriv->result || kIOReturnUnderrun == tpriv->result) {
1972     if (isIsoc && tpriv->isoc_framelist) {
1973       /* copy isochronous results back */
1974
1975       for (i = 0; i < transfer->num_iso_packets ; i++) {
1976         struct libusb_iso_packet_descriptor *lib_desc = &transfer->iso_packet_desc[i];
1977         lib_desc->status = darwin_to_libusb (tpriv->isoc_framelist[i].frStatus);
1978         lib_desc->actual_length = tpriv->isoc_framelist[i].frActCount;
1979       }
1980     } else if (!isIsoc)
1981       itransfer->transferred += tpriv->size;
1982   }
1983
1984   /* it is ok to handle cancelled transfers without calling usbi_handle_transfer_cancellation (we catch timeout transfers) */
1985   return usbi_handle_transfer_completion (itransfer, darwin_transfer_status (itransfer, tpriv->result));
1986 }
1987
1988 static int darwin_clock_gettime(int clk_id, struct timespec *tp) {
1989 #if !OSX_USE_CLOCK_GETTIME
1990   mach_timespec_t sys_time;
1991   clock_serv_t clock_ref;
1992
1993   switch (clk_id) {
1994   case USBI_CLOCK_REALTIME:
1995     /* CLOCK_REALTIME represents time since the epoch */
1996     clock_ref = clock_realtime;
1997     break;
1998   case USBI_CLOCK_MONOTONIC:
1999     /* use system boot time as reference for the monotonic clock */
2000     clock_ref = clock_monotonic;
2001     break;
2002   default:
2003     return LIBUSB_ERROR_INVALID_PARAM;
2004   }
2005
2006   clock_get_time (clock_ref, &sys_time);
2007
2008   tp->tv_sec  = sys_time.tv_sec;
2009   tp->tv_nsec = sys_time.tv_nsec;
2010
2011   return 0;
2012 #else
2013   switch (clk_id) {
2014   case USBI_CLOCK_MONOTONIC:
2015     return clock_gettime(CLOCK_MONOTONIC, tp);
2016   case USBI_CLOCK_REALTIME:
2017     return clock_gettime(CLOCK_REALTIME, tp);
2018   default:
2019     return LIBUSB_ERROR_INVALID_PARAM;
2020   }
2021 #endif
2022 }
2023
2024 #if InterfaceVersion >= 550
2025 static int darwin_alloc_streams (struct libusb_device_handle *dev_handle, uint32_t num_streams, unsigned char *endpoints,
2026                                  int num_endpoints) {
2027   struct darwin_interface *cInterface;
2028   UInt32 supportsStreams;
2029   uint8_t pipeRef;
2030   int rc, i;
2031
2032   /* find the mimimum number of supported streams on the endpoint list */
2033   for (i = 0 ; i < num_endpoints ; ++i) {
2034     if (0 != (rc = ep_to_pipeRef (dev_handle, endpoints[i], &pipeRef, NULL, &cInterface))) {
2035       return rc;
2036     }
2037
2038     (*(cInterface->interface))->SupportsStreams (cInterface->interface, pipeRef, &supportsStreams);
2039     if (num_streams > supportsStreams)
2040       num_streams = supportsStreams;
2041   }
2042
2043   /* it is an error if any endpoint in endpoints does not support streams */
2044   if (0 == num_streams)
2045     return LIBUSB_ERROR_INVALID_PARAM;
2046
2047   /* create the streams */
2048   for (i = 0 ; i < num_endpoints ; ++i) {
2049     (void) ep_to_pipeRef (dev_handle, endpoints[i], &pipeRef, NULL, &cInterface);
2050
2051     rc = (*(cInterface->interface))->CreateStreams (cInterface->interface, pipeRef, num_streams);
2052     if (kIOReturnSuccess != rc)
2053       return darwin_to_libusb(rc);
2054   }
2055
2056   return num_streams;
2057 }
2058
2059 static int darwin_free_streams (struct libusb_device_handle *dev_handle, unsigned char *endpoints, int num_endpoints) {
2060   struct darwin_interface *cInterface;
2061   UInt32 supportsStreams;
2062   uint8_t pipeRef;
2063   int rc;
2064
2065   for (int i = 0 ; i < num_endpoints ; ++i) {
2066     if (0 != (rc = ep_to_pipeRef (dev_handle, endpoints[i], &pipeRef, NULL, &cInterface)))
2067       return rc;
2068
2069     (*(cInterface->interface))->SupportsStreams (cInterface->interface, pipeRef, &supportsStreams);
2070     if (0 == supportsStreams)
2071       return LIBUSB_ERROR_INVALID_PARAM;
2072
2073     rc = (*(cInterface->interface))->CreateStreams (cInterface->interface, pipeRef, 0);
2074     if (kIOReturnSuccess != rc)
2075       return darwin_to_libusb(rc);
2076   }
2077
2078   return LIBUSB_SUCCESS;
2079 }
2080 #endif
2081
2082 const struct usbi_os_backend darwin_backend = {
2083         .name = "Darwin",
2084         .caps = 0,
2085         .init = darwin_init,
2086         .exit = darwin_exit,
2087         .get_device_list = NULL, /* not needed */
2088         .get_device_descriptor = darwin_get_device_descriptor,
2089         .get_active_config_descriptor = darwin_get_active_config_descriptor,
2090         .get_config_descriptor = darwin_get_config_descriptor,
2091         .hotplug_poll = darwin_hotplug_poll,
2092
2093         .open = darwin_open,
2094         .close = darwin_close,
2095         .get_configuration = darwin_get_configuration,
2096         .set_configuration = darwin_set_configuration,
2097         .claim_interface = darwin_claim_interface,
2098         .release_interface = darwin_release_interface,
2099
2100         .set_interface_altsetting = darwin_set_interface_altsetting,
2101         .clear_halt = darwin_clear_halt,
2102         .reset_device = darwin_reset_device,
2103
2104 #if InterfaceVersion >= 550
2105         .alloc_streams = darwin_alloc_streams,
2106         .free_streams = darwin_free_streams,
2107 #endif
2108
2109         .kernel_driver_active = darwin_kernel_driver_active,
2110         .detach_kernel_driver = darwin_detach_kernel_driver,
2111         .attach_kernel_driver = darwin_attach_kernel_driver,
2112
2113         .destroy_device = darwin_destroy_device,
2114
2115         .submit_transfer = darwin_submit_transfer,
2116         .cancel_transfer = darwin_cancel_transfer,
2117         .clear_transfer_priv = darwin_clear_transfer_priv,
2118
2119         .handle_transfer_completion = darwin_handle_transfer_completion,
2120
2121         .clock_gettime = darwin_clock_gettime,
2122
2123         .device_priv_size = sizeof(struct darwin_device_priv),
2124         .device_handle_priv_size = sizeof(struct darwin_device_handle_priv),
2125         .transfer_priv_size = sizeof(struct darwin_transfer_priv),
2126 };