/*

 * darwin backend for libusb 1.0

 * Copyright © 2008-2019 Nathan Hjelm <hjelmn@users.sourceforge.net>

 * Copyright © 2019      Google LLC. All rights reserved.

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Lesser General Public

 * License as published by the Free Software Foundation; either

 * version 2.1 of the License, or (at your option) any later version.

 *

 * This library is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

 * Lesser General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General Public

 * License along with this library; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

 */

#if !defined(LIBUSB_DARWIN_H)

#define LIBUSB_DARWIN_H

#include <stdbool.h>

#include "libusbi.h"

#include <IOKit/IOTypes.h>

#include <IOKit/IOCFBundle.h>

#include <IOKit/usb/IOUSBLib.h>

#include <IOKit/IOCFPlugIn.h>

/* IOUSBInterfaceInferface */

/* New in OS 10.12.0. */

#if defined (kIOUSBInterfaceInterfaceID800) && (MAC_OS_X_VERSION_MIN_REQUIRED >= 101200)

#define usb_interface_t IOUSBInterfaceInterface800

#define InterfaceInterfaceID kIOUSBInterfaceInterfaceID800

#define InterfaceVersion 800

/* New in OS 10.10.0. */

#elif defined (kIOUSBInterfaceInterfaceID700) && (MAC_OS_X_VERSION_MIN_REQUIRED >= 101000)

#define usb_interface_t IOUSBInterfaceInterface700

#define InterfaceInterfaceID kIOUSBInterfaceInterfaceID700

#define InterfaceVersion 700

/* New in OS 10.9.0. */

#elif defined (kIOUSBInterfaceInterfaceID650) && (MAC_OS_X_VERSION_MIN_REQUIRED >= 1090)

#define usb_interface_t IOUSBInterfaceInterface650

#define InterfaceInterfaceID kIOUSBInterfaceInterfaceID650

#define InterfaceVersion 650

/* New in OS 10.8.2 but can't test deployment target to that granularity, so round up. */

#elif defined (kIOUSBInterfaceInterfaceID550) && (MAC_OS_X_VERSION_MIN_REQUIRED >= 1090)

#define usb_interface_t IOUSBInterfaceInterface550

#define InterfaceInterfaceID kIOUSBInterfaceInterfaceID550

#define InterfaceVersion 550

/* New in OS 10.7.3 but can't test deployment target to that granularity, so round up. */

#elif defined (kIOUSBInterfaceInterfaceID500) && (MAC_OS_X_VERSION_MIN_REQUIRED >= 1080)

#define usb_interface_t IOUSBInterfaceInterface500

#define InterfaceInterfaceID kIOUSBInterfaceInterfaceID500

#define InterfaceVersion 500

/* New in OS 10.5.0. */

#elif defined (kIOUSBInterfaceInterfaceID300) && (MAC_OS_X_VERSION_MIN_REQUIRED >= 1050)

#define usb_interface_t IOUSBInterfaceInterface300

#define InterfaceInterfaceID kIOUSBInterfaceInterfaceID300

#define InterfaceVersion 300

/* New in OS 10.4.5 (or 10.4.6?) but can't test deployment target to that granularity, so round up. */

#elif defined (kIOUSBInterfaceInterfaceID245) && (MAC_OS_X_VERSION_MIN_REQUIRED >= 1050)

#define usb_interface_t IOUSBInterfaceInterface245

#define InterfaceInterfaceID kIOUSBInterfaceInterfaceID245

#define InterfaceVersion 245

/* New in OS 10.4.0. */

#elif defined (kIOUSBInterfaceInterfaceID220) && (MAC_OS_X_VERSION_MIN_REQUIRED >= 1040)

#define usb_interface_t IOUSBInterfaceInterface220

#define InterfaceInterfaceID kIOUSBInterfaceInterfaceID220

#define InterfaceVersion 220

#else

#error "IOUSBFamily is too old. Please upgrade your SDK and/or deployment target"

#endif

/* IOUSBDeviceInterface */

/* New in OS 10.9.0. */

#if defined (kIOUSBDeviceInterfaceID650) && (MAC_OS_X_VERSION_MIN_REQUIRED >= 1090)

#define usb_device_t    IOUSBDeviceInterface650

#define DeviceInterfaceID kIOUSBDeviceInterfaceID650

#define DeviceVersion 650

/* New in OS 10.7.3 but can't test deployment target to that granularity, so round up. */

#elif defined (kIOUSBDeviceInterfaceID500) && (MAC_OS_X_VERSION_MIN_REQUIRED >= 1080)

#define usb_device_t    IOUSBDeviceInterface500

#define DeviceInterfaceID kIOUSBDeviceInterfaceID500

#define DeviceVersion 500

/* New in OS 10.5.4 but can't test deployment target to that granularity, so round up. */

#elif defined (kIOUSBDeviceInterfaceID320) && (MAC_OS_X_VERSION_MIN_REQUIRED >= 1060)

#define usb_device_t    IOUSBDeviceInterface320

#define DeviceInterfaceID kIOUSBDeviceInterfaceID320

#define DeviceVersion 320

/* New in OS 10.5.0. */

#elif defined (kIOUSBDeviceInterfaceID300) && (MAC_OS_X_VERSION_MIN_REQUIRED >= 1050)

#define usb_device_t    IOUSBDeviceInterface300

#define DeviceInterfaceID kIOUSBDeviceInterfaceID300

#define DeviceVersion 300

/* New in OS 10.4.5 (or 10.4.6?) but can't test deployment target to that granularity, so round up. */

#elif defined (kIOUSBDeviceInterfaceID245) && (MAC_OS_X_VERSION_MIN_REQUIRED >= 1050)

#define usb_device_t    IOUSBDeviceInterface245

#define DeviceInterfaceID kIOUSBDeviceInterfaceID245

#define DeviceVersion 245

/* New in OS 10.2.3 but can't test deployment target to that granularity, so round up. */

#elif defined (kIOUSBDeviceInterfaceID197) && (MAC_OS_X_VERSION_MIN_REQUIRED >= 1030)

#define usb_device_t    IOUSBDeviceInterface197

#define DeviceInterfaceID kIOUSBDeviceInterfaceID197

#define DeviceVersion 197

#else

#error "IOUSBFamily is too old. Please upgrade your SDK and/or deployment target"

#endif

#if !defined(IO_OBJECT_NULL)

#define IO_OBJECT_NULL ((io_object_t) 0)

#endif

typedef IOCFPlugInInterface *io_cf_plugin_ref_t;

typedef IONotificationPortRef io_notification_port_t;

/* private structures */

struct darwin_cached_device {

  struct list_head      list;

  IOUSBDeviceDescriptor dev_descriptor;

  UInt32                location;

  UInt64                parent_session;

  UInt64                session;

  USBDeviceAddress      address;

  char                  sys_path[21];

  usb_device_t        **device;

  int                   open_count;

  UInt8                 first_config, active_config, port;  

  int                   can_enumerate;

  int                   refcount;

  bool                  in_reenumerate;

};

struct darwin_device_priv {

  struct darwin_cached_device *dev;

};

struct darwin_device_handle_priv {

  bool                 is_open;

  CFRunLoopSourceRef   cfSource;

  struct darwin_interface {

    usb_interface_t    **interface;

    uint8_t              num_endpoints;

    CFRunLoopSourceRef   cfSource;

    uint64_t             frames[256];

    uint8_t              endpoint_addrs[USB_MAXENDPOINTS];

  } interfaces[USB_MAXINTERFACES];

};

struct darwin_transfer_priv {

  /* Isoc */

  IOUSBIsocFrame *isoc_framelist;

  int num_iso_packets;

  /* Control */

  IOUSBDevRequestTO req;

  /* Bulk */

  /* Completion status */

  IOReturn result;

  UInt32 size;

};

#endif