libusb/os/windows_winusb.c

   1 /*
   2  * windows backend for libusb 1.0
   3  * Copyright © 2009-2012 Pete Batard <pete@akeo.ie>
   4  * Copyright © 2016-2018 Chris Dickens <christopher.a.dickens@gmail.com>
   5  * With contributions from Michael Plante, Orin Eman et al.
   6  * Parts of this code adapted from libusb-win32-v1 by Stephan Meyer
   7  * HID Reports IOCTLs inspired from HIDAPI by Alan Ott, Signal 11 Software
   8  * Hash table functions adapted from glibc, by Ulrich Drepper et al.
   9  * Major code testing contribution by Xiaofan Chen
  10  *
  11  * This library is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public
  13  * License as published by the Free Software Foundation; either
  14  * version 2.1 of the License, or (at your option) any later version.
  15  *
  16  * This library is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with this library; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  24  */
  25
  26 #include <config.h>
  27
  28 #include <windows.h>
  29 #include <setupapi.h>
  30 #include <ctype.h>
  31 #include <stdio.h>
  32
  33 #include "libusbi.h"
  34 #include "windows_winusb.h"
  35
  36 #define HANDLE_VALID(h) (((h) != NULL) && ((h) != INVALID_HANDLE_VALUE))
  37
  38 // The below macro is used in conjunction with safe loops.
  39 #define LOOP_BREAK(err)                         \
  40         {                                       \
  41                 r = err;                        \
  42                 continue;                       \
  43         }
  44
  45 // WinUSB-like API prototypes
  46 static bool winusbx_init(struct libusb_context *ctx);
  47 static void winusbx_exit(void);
  48 static int winusbx_open(int sub_api, struct libusb_device_handle *dev_handle);
  49 static void winusbx_close(int sub_api, struct libusb_device_handle *dev_handle);
  50 static int winusbx_configure_endpoints(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface);
  51 static int winusbx_claim_interface(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface);
  52 static int winusbx_release_interface(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface);
  53 static int winusbx_submit_control_transfer(int sub_api, struct usbi_transfer *itransfer);
  54 static int winusbx_set_interface_altsetting(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface, uint8_t altsetting);
  55 static int winusbx_submit_iso_transfer(int sub_api, struct usbi_transfer *itransfer);
  56 static int winusbx_submit_bulk_transfer(int sub_api, struct usbi_transfer *itransfer);
  57 static int winusbx_clear_halt(int sub_api, struct libusb_device_handle *dev_handle, unsigned char endpoint);
  58 static int winusbx_cancel_transfer(int sub_api, struct usbi_transfer *itransfer);
  59 static int winusbx_reset_device(int sub_api, struct libusb_device_handle *dev_handle);
  60 static enum libusb_transfer_status winusbx_copy_transfer_data(int sub_api, struct usbi_transfer *itransfer, DWORD length);
  61 // HID API prototypes
  62 static bool hid_init(struct libusb_context *ctx);
  63 static void hid_exit(void);
  64 static int hid_open(int sub_api, struct libusb_device_handle *dev_handle);
  65 static void hid_close(int sub_api, struct libusb_device_handle *dev_handle);
  66 static int hid_claim_interface(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface);
  67 static int hid_release_interface(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface);
  68 static int hid_set_interface_altsetting(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface, uint8_t altsetting);
  69 static int hid_submit_control_transfer(int sub_api, struct usbi_transfer *itransfer);
  70 static int hid_submit_bulk_transfer(int sub_api, struct usbi_transfer *itransfer);
  71 static int hid_clear_halt(int sub_api, struct libusb_device_handle *dev_handle, unsigned char endpoint);
  72 static int hid_reset_device(int sub_api, struct libusb_device_handle *dev_handle);
  73 static enum libusb_transfer_status hid_copy_transfer_data(int sub_api, struct usbi_transfer *itransfer, DWORD length);
  74 // Composite API prototypes
  75 static int composite_open(int sub_api, struct libusb_device_handle *dev_handle);
  76 static void composite_close(int sub_api, struct libusb_device_handle *dev_handle);
  77 static int composite_claim_interface(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface);
  78 static int composite_set_interface_altsetting(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface, uint8_t altsetting);
  79 static int composite_release_interface(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface);
  80 static int composite_submit_control_transfer(int sub_api, struct usbi_transfer *itransfer);
  81 static int composite_submit_bulk_transfer(int sub_api, struct usbi_transfer *itransfer);
  82 static int composite_submit_iso_transfer(int sub_api, struct usbi_transfer *itransfer);
  83 static int composite_clear_halt(int sub_api, struct libusb_device_handle *dev_handle, unsigned char endpoint);
  84 static int composite_cancel_transfer(int sub_api, struct usbi_transfer *itransfer);
  85 static int composite_reset_device(int sub_api, struct libusb_device_handle *dev_handle);
  86 static enum libusb_transfer_status composite_copy_transfer_data(int sub_api, struct usbi_transfer *itransfer, DWORD length);
  87
  88 static usbi_mutex_t autoclaim_lock;
  89
  90 // API globals
  91 static struct winusb_interface WinUSBX[SUB_API_MAX];
  92 #define CHECK_WINUSBX_AVAILABLE(sub_api)                \
  93         do {                                            \
  94                 if (sub_api == SUB_API_NOTSET)          \
  95                         sub_api = priv->sub_api;        \
  96                 if (WinUSBX[sub_api].hDll == NULL)      \
  97                         return LIBUSB_ERROR_ACCESS;     \
  98         } while (0)
  99
 100 #define CHECK_HID_AVAILABLE                             \
 101         do {                                            \
 102                 if (DLL_HANDLE_NAME(hid) == NULL)       \
 103                         return LIBUSB_ERROR_ACCESS;     \
 104         } while (0)
 105
 106 #if defined(ENABLE_LOGGING)
 107 static const char *guid_to_string(const GUID *guid, char guid_string[MAX_GUID_STRING_LENGTH])
 108 {
 109         if (guid == NULL) {
 110                 guid_string[0] = '\0';
 111                 return guid_string;
 112         }
 113
 114         sprintf(guid_string, "{%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X}",
 115                 (unsigned int)guid->Data1, guid->Data2, guid->Data3,
 116                 guid->Data4[0], guid->Data4[1], guid->Data4[2], guid->Data4[3],
 117                 guid->Data4[4], guid->Data4[5], guid->Data4[6], guid->Data4[7]);
 118
 119         return guid_string;
 120 }
 121 #endif
 122
 123 static bool string_to_guid(const char guid_string[MAX_GUID_STRING_LENGTH], GUID *guid)
 124 {
 125         unsigned short tmp[4];
 126         int num_chars = -1;
 127         char extra;
 128         int r;
 129
 130         // Unfortunately MinGW complains that '%hhx' is not a valid format specifier,
 131         // even though Visual Studio 2013 and later support it. Rather than complicating
 132         // the logic in this function with '#ifdef's, use a temporary array on the stack
 133         // to store the conversions.
 134         r = sscanf(guid_string, "{%8x-%4hx-%4hx-%4hx-%4hx%4hx%4hx}%n%c",
 135                 (unsigned int *)&guid->Data1, &guid->Data2, &guid->Data3,
 136                 &tmp[0], &tmp[1], &tmp[2], &tmp[3], &num_chars, &extra);
 137
 138         if ((r != 7) || (num_chars != 38))
 139                 return false;
 140
 141         // Extract the bytes from the 2-byte shorts
 142         guid->Data4[0] = (unsigned char)((tmp[0] >> 8) & 0xFF);
 143         guid->Data4[1] = (unsigned char)(tmp[0] & 0xFF);
 144         guid->Data4[2] = (unsigned char)((tmp[1] >> 8) & 0xFF);
 145         guid->Data4[3] = (unsigned char)(tmp[1] & 0xFF);
 146         guid->Data4[4] = (unsigned char)((tmp[2] >> 8) & 0xFF);
 147         guid->Data4[5] = (unsigned char)(tmp[2] & 0xFF);
 148         guid->Data4[6] = (unsigned char)((tmp[3] >> 8) & 0xFF);
 149         guid->Data4[7] = (unsigned char)(tmp[3] & 0xFF);
 150
 151         return true;
 152 }
 153
 154 /*
 155  * Normalize Microsoft's paths: return a duplicate of the given path
 156  * with all characters converted to uppercase
 157  */
 158 static char *normalize_path(const char *path)
 159 {
 160         char *ret_path = _strdup(path);
 161         char *p;
 162
 163         if (ret_path == NULL)
 164                 return NULL;
 165
 166         for (p = ret_path; *p != '\0'; p++)
 167                 *p = (char)toupper((unsigned char)*p);
 168
 169         return ret_path;
 170 }
 171
 172 /*
 173  * Cfgmgr32, AdvAPI32, OLE32 and SetupAPI DLL functions
 174  */
 175 static bool init_dlls(struct libusb_context *ctx)
 176 {
 177         DLL_GET_HANDLE(ctx, Cfgmgr32);
 178         DLL_LOAD_FUNC(Cfgmgr32, CM_Get_Parent, true);
 179         DLL_LOAD_FUNC(Cfgmgr32, CM_Get_Child, true);
 180
 181         // Prefixed to avoid conflict with header files
 182         DLL_GET_HANDLE(ctx, AdvAPI32);
 183         DLL_LOAD_FUNC_PREFIXED(AdvAPI32, p, RegQueryValueExA, true);
 184         DLL_LOAD_FUNC_PREFIXED(AdvAPI32, p, RegCloseKey, true);
 185
 186         DLL_GET_HANDLE(ctx, SetupAPI);
 187         DLL_LOAD_FUNC_PREFIXED(SetupAPI, p, SetupDiGetClassDevsA, true);
 188         DLL_LOAD_FUNC_PREFIXED(SetupAPI, p, SetupDiEnumDeviceInfo, true);
 189         DLL_LOAD_FUNC_PREFIXED(SetupAPI, p, SetupDiEnumDeviceInterfaces, true);
 190         DLL_LOAD_FUNC_PREFIXED(SetupAPI, p, SetupDiGetDeviceInstanceIdA, true);
 191         DLL_LOAD_FUNC_PREFIXED(SetupAPI, p, SetupDiGetDeviceInterfaceDetailA, true);
 192         DLL_LOAD_FUNC_PREFIXED(SetupAPI, p, SetupDiGetDeviceRegistryPropertyA, true);
 193         DLL_LOAD_FUNC_PREFIXED(SetupAPI, p, SetupDiDestroyDeviceInfoList, true);
 194         DLL_LOAD_FUNC_PREFIXED(SetupAPI, p, SetupDiOpenDevRegKey, true);
 195         DLL_LOAD_FUNC_PREFIXED(SetupAPI, p, SetupDiOpenDeviceInterfaceRegKey, true);
 196
 197         return true;
 198 }
 199
 200 static void exit_dlls(void)
 201 {
 202         DLL_FREE_HANDLE(SetupAPI);
 203         DLL_FREE_HANDLE(AdvAPI32);
 204         DLL_FREE_HANDLE(Cfgmgr32);
 205 }
 206
 207 /*
 208  * enumerate interfaces for the whole USB class
 209  *
 210  * Parameters:
 211  * dev_info: a pointer to a dev_info list
 212  * dev_info_data: a pointer to an SP_DEVINFO_DATA to be filled (or NULL if not needed)
 213  * enumerator: the generic USB class for which to retrieve interface details
 214  * index: zero based index of the interface in the device info list
 215  *
 216  * Note: it is the responsibility of the caller to free the DEVICE_INTERFACE_DETAIL_DATA
 217  * structure returned and call this function repeatedly using the same guid (with an
 218  * incremented index starting at zero) until all interfaces have been returned.
 219  */
 220 static bool get_devinfo_data(struct libusb_context *ctx,
 221         HDEVINFO *dev_info, SP_DEVINFO_DATA *dev_info_data, const char *enumerator, unsigned _index)
 222 {
 223         if (_index == 0) {
 224                 *dev_info = pSetupDiGetClassDevsA(NULL, enumerator, NULL, DIGCF_PRESENT|DIGCF_ALLCLASSES);
 225                 if (*dev_info == INVALID_HANDLE_VALUE) {
 226                         usbi_err(ctx, "could not obtain device info set for PnP enumerator '%s': %s",
 227                                 enumerator, windows_error_str(0));
 228                         return false;
 229                 }
 230         }
 231
 232         dev_info_data->cbSize = sizeof(SP_DEVINFO_DATA);
 233         if (!pSetupDiEnumDeviceInfo(*dev_info, _index, dev_info_data)) {
 234                 if (GetLastError() != ERROR_NO_MORE_ITEMS)
 235                         usbi_err(ctx, "could not obtain device info data for PnP enumerator '%s' index %u: %s",
 236                                 enumerator, _index, windows_error_str(0));
 237
 238                 pSetupDiDestroyDeviceInfoList(*dev_info);
 239                 *dev_info = INVALID_HANDLE_VALUE;
 240                 return false;
 241         }
 242         return true;
 243 }
 244
 245 /*
 246  * enumerate interfaces for a specific GUID
 247  *
 248  * Parameters:
 249  * dev_info: a pointer to a dev_info list
 250  * dev_info_data: a pointer to an SP_DEVINFO_DATA to be filled (or NULL if not needed)
 251  * guid: the GUID for which to retrieve interface details
 252  * index: zero based index of the interface in the device info list
 253  *
 254  * Note: it is the responsibility of the caller to free the DEVICE_INTERFACE_DETAIL_DATA
 255  * structure returned and call this function repeatedly using the same guid (with an
 256  * incremented index starting at zero) until all interfaces have been returned.
 257  */
 258 static int get_interface_details(struct libusb_context *ctx, HDEVINFO dev_info,
 259         PSP_DEVINFO_DATA dev_info_data, LPCGUID guid, DWORD *_index, char **dev_interface_path)
 260 {
 261         SP_DEVICE_INTERFACE_DATA dev_interface_data;
 262         PSP_DEVICE_INTERFACE_DETAIL_DATA_A dev_interface_details;
 263         char guid_string[MAX_GUID_STRING_LENGTH];
 264         DWORD size;
 265
 266         dev_info_data->cbSize = sizeof(SP_DEVINFO_DATA);
 267         dev_interface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
 268         for (;;) {
 269                 if (!pSetupDiEnumDeviceInfo(dev_info, *_index, dev_info_data)) {
 270                         if (GetLastError() != ERROR_NO_MORE_ITEMS) {
 271                                 usbi_err(ctx, "Could not obtain device info data for %s index %lu: %s",
 272                                         guid_to_string(guid, guid_string), ULONG_CAST(*_index), windows_error_str(0));
 273                                 return LIBUSB_ERROR_OTHER;
 274                         }
 275
 276                         // No more devices
 277                         return LIBUSB_SUCCESS;
 278                 }
 279
 280                 // Always advance the index for the next iteration
 281                 (*_index)++;
 282
 283                 if (pSetupDiEnumDeviceInterfaces(dev_info, dev_info_data, guid, 0, &dev_interface_data))
 284                         break;
 285
 286                 if (GetLastError() != ERROR_NO_MORE_ITEMS) {
 287                         usbi_err(ctx, "Could not obtain interface data for %s devInst %lX: %s",
 288                                 guid_to_string(guid, guid_string), ULONG_CAST(dev_info_data->DevInst), windows_error_str(0));
 289                         return LIBUSB_ERROR_OTHER;
 290                 }
 291
 292                 // Device does not have an interface matching this GUID, skip
 293         }
 294
 295         // Read interface data (dummy + actual) to access the device path
 296         if (!pSetupDiGetDeviceInterfaceDetailA(dev_info, &dev_interface_data, NULL, 0, &size, NULL)) {
 297                 // The dummy call should fail with ERROR_INSUFFICIENT_BUFFER
 298                 if (GetLastError() != ERROR_INSUFFICIENT_BUFFER) {
 299                         usbi_err(ctx, "could not access interface data (dummy) for %s devInst %lX: %s",
 300                                 guid_to_string(guid, guid_string), ULONG_CAST(dev_info_data->DevInst), windows_error_str(0));
 301                         return LIBUSB_ERROR_OTHER;
 302                 }
 303         } else {
 304                 usbi_err(ctx, "program assertion failed - http://msdn.microsoft.com/en-us/library/ms792901.aspx is wrong");
 305                 return LIBUSB_ERROR_OTHER;
 306         }
 307
 308         dev_interface_details = malloc(size);
 309         if (dev_interface_details == NULL) {
 310                 usbi_err(ctx, "could not allocate interface data for %s devInst %lX",
 311                         guid_to_string(guid, guid_string), ULONG_CAST(dev_info_data->DevInst));
 312                 return LIBUSB_ERROR_NO_MEM;
 313         }
 314
 315         dev_interface_details->cbSize = sizeof(SP_DEVICE_INTERFACE_DETAIL_DATA_A);
 316         if (!pSetupDiGetDeviceInterfaceDetailA(dev_info, &dev_interface_data,
 317                 dev_interface_details, size, NULL, NULL)) {
 318                 usbi_err(ctx, "could not access interface data (actual) for %s devInst %lX: %s",
 319                         guid_to_string(guid, guid_string), ULONG_CAST(dev_info_data->DevInst), windows_error_str(0));
 320                 free(dev_interface_details);
 321                 return LIBUSB_ERROR_OTHER;
 322         }
 323
 324         *dev_interface_path = normalize_path(dev_interface_details->DevicePath);
 325         free(dev_interface_details);
 326
 327         if (*dev_interface_path == NULL) {
 328                 usbi_err(ctx, "could not allocate interface path for %s devInst %lX",
 329                         guid_to_string(guid, guid_string), ULONG_CAST(dev_info_data->DevInst));
 330                 return LIBUSB_ERROR_NO_MEM;
 331         }
 332
 333         return LIBUSB_SUCCESS;
 334 }
 335
 336 /* For libusb0 filter */
 337 static int get_interface_details_filter(struct libusb_context *ctx, HDEVINFO *dev_info,
 338         DWORD _index, char *filter_path, char **dev_interface_path)
 339 {
 340         const GUID *libusb0_guid = &GUID_DEVINTERFACE_LIBUSB0_FILTER;
 341         SP_DEVICE_INTERFACE_DATA dev_interface_data;
 342         PSP_DEVICE_INTERFACE_DETAIL_DATA_A dev_interface_details;
 343         HKEY hkey_dev_interface;
 344         DWORD size;
 345         int err = LIBUSB_ERROR_OTHER;
 346
 347         if (_index == 0) {
 348                 *dev_info = pSetupDiGetClassDevsA(libusb0_guid, NULL, NULL, DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
 349                 if (*dev_info == INVALID_HANDLE_VALUE) {
 350                         usbi_err(ctx, "could not obtain device info set: %s", windows_error_str(0));
 351                         return LIBUSB_ERROR_OTHER;
 352                 }
 353         }
 354
 355         dev_interface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
 356         if (!pSetupDiEnumDeviceInterfaces(*dev_info, NULL, libusb0_guid, _index, &dev_interface_data)) {
 357                 if (GetLastError() != ERROR_NO_MORE_ITEMS) {
 358                         usbi_err(ctx, "Could not obtain interface data for index %lu: %s",
 359                                 ULONG_CAST(_index), windows_error_str(0));
 360                         goto err_exit;
 361                 }
 362
 363                 pSetupDiDestroyDeviceInfoList(*dev_info);
 364                 *dev_info = INVALID_HANDLE_VALUE;
 365                 return LIBUSB_SUCCESS;
 366         }
 367
 368         // Read interface data (dummy + actual) to access the device path
 369         if (!pSetupDiGetDeviceInterfaceDetailA(*dev_info, &dev_interface_data, NULL, 0, &size, NULL)) {
 370                 // The dummy call should fail with ERROR_INSUFFICIENT_BUFFER
 371                 if (GetLastError() != ERROR_INSUFFICIENT_BUFFER) {
 372                         usbi_err(ctx, "could not access interface data (dummy) for index %lu: %s",
 373                                 ULONG_CAST(_index), windows_error_str(0));
 374                         goto err_exit;
 375                 }
 376         } else {
 377                 usbi_err(ctx, "program assertion failed - http://msdn.microsoft.com/en-us/library/ms792901.aspx is wrong");
 378                 goto err_exit;
 379         }
 380
 381         dev_interface_details = malloc(size);
 382         if (dev_interface_details == NULL) {
 383                 usbi_err(ctx, "could not allocate interface data for index %lu", ULONG_CAST(_index));
 384                 err = LIBUSB_ERROR_NO_MEM;
 385                 goto err_exit;
 386         }
 387
 388         dev_interface_details->cbSize = sizeof(SP_DEVICE_INTERFACE_DETAIL_DATA_A);
 389         if (!pSetupDiGetDeviceInterfaceDetailA(*dev_info, &dev_interface_data, dev_interface_details, size, NULL, NULL)) {
 390                 usbi_err(ctx, "could not access interface data (actual) for index %lu: %s",
 391                         ULONG_CAST(_index), windows_error_str(0));
 392                 free(dev_interface_details);
 393                 goto err_exit;
 394         }
 395
 396         *dev_interface_path = normalize_path(dev_interface_details->DevicePath);
 397         free(dev_interface_details);
 398
 399         if (*dev_interface_path == NULL) {
 400                 usbi_err(ctx, "could not allocate interface path for index %lu", ULONG_CAST(_index));
 401                 err = LIBUSB_ERROR_NO_MEM;
 402                 goto err_exit;
 403         }
 404
 405         // [trobinso] lookup the libusb0 symbolic index.
 406         hkey_dev_interface = pSetupDiOpenDeviceInterfaceRegKey(*dev_info, &dev_interface_data, 0, KEY_READ);
 407         if (hkey_dev_interface != INVALID_HANDLE_VALUE) {
 408                 DWORD libusb0_symboliclink_index = 0;
 409                 DWORD value_length = sizeof(DWORD);
 410                 LONG status;
 411
 412                 status = pRegQueryValueExA(hkey_dev_interface, "LUsb0", NULL, NULL,
 413                         (LPBYTE)&libusb0_symboliclink_index, &value_length);
 414                 if (status == ERROR_SUCCESS) {
 415                         if (libusb0_symboliclink_index < 256) {
 416                                 // libusb0.sys is connected to this device instance.
 417                                 // If the the device interface guid is {F9F3FF14-AE21-48A0-8A25-8011A7A931D9} then it's a filter.
 418                                 sprintf(filter_path, "\\\\.\\libusb0-%04u", (unsigned int)libusb0_symboliclink_index);
 419                                 usbi_dbg("assigned libusb0 symbolic link %s", filter_path);
 420                         } else {
 421                                 // libusb0.sys was connected to this device instance at one time; but not anymore.
 422                         }
 423                 }
 424                 pRegCloseKey(hkey_dev_interface);
 425         } else {
 426                 usbi_warn(ctx, "could not open device interface registry key for index %lu: %s",
 427                         ULONG_CAST(_index), windows_error_str(0));
 428                 // TODO: should this be an error?
 429         }
 430
 431         return LIBUSB_SUCCESS;
 432
 433 err_exit:
 434         pSetupDiDestroyDeviceInfoList(*dev_info);
 435         *dev_info = INVALID_HANDLE_VALUE;
 436         return err;
 437 }
 438
 439 /*
 440  * Returns the first known ancestor of a device
 441  */
 442 static struct libusb_device *get_ancestor(struct libusb_context *ctx,
 443         DEVINST devinst, PDEVINST _parent_devinst)
 444 {
 445         struct libusb_device *dev = NULL;
 446         DEVINST parent_devinst;
 447
 448         while (dev == NULL) {
 449                 if (CM_Get_Parent(&parent_devinst, devinst, 0) != CR_SUCCESS)
 450                         break;
 451                 devinst = parent_devinst;
 452                 dev = usbi_get_device_by_session_id(ctx, (unsigned long)devinst);
 453         }
 454
 455         if ((dev != NULL) && (_parent_devinst != NULL))
 456                 *_parent_devinst = devinst;
 457
 458         return dev;
 459 }
 460
 461 /*
 462  * Determine which interface the given endpoint address belongs to
 463  */
 464 static int get_interface_by_endpoint(struct libusb_config_descriptor *conf_desc, uint8_t ep)
 465 {
 466         const struct libusb_interface *intf;
 467         const struct libusb_interface_descriptor *intf_desc;
 468         uint8_t i, k;
 469         int j;
 470
 471         for (i = 0; i < conf_desc->bNumInterfaces; i++) {
 472                 intf = &conf_desc->interface[i];
 473                 for (j = 0; j < intf->num_altsetting; j++) {
 474                         intf_desc = &intf->altsetting[j];
 475                         for (k = 0; k < intf_desc->bNumEndpoints; k++) {
 476                                 if (intf_desc->endpoint[k].bEndpointAddress == ep) {
 477                                         usbi_dbg("found endpoint %02X on interface %d", intf_desc->bInterfaceNumber, i);
 478                                         return intf_desc->bInterfaceNumber;
 479                                 }
 480                         }
 481                 }
 482         }
 483
 484         usbi_dbg("endpoint %02X not found on any interface", ep);
 485         return LIBUSB_ERROR_NOT_FOUND;
 486 }
 487
 488 /*
 489  * Open a device and associate the HANDLE with the context's I/O completion port
 490  */
 491 static HANDLE windows_open(struct libusb_device_handle *dev_handle, const char *path, DWORD access)
 492 {
 493         struct libusb_context *ctx = HANDLE_CTX(dev_handle);
 494         struct windows_context_priv *priv = usbi_get_context_priv(ctx);
 495         HANDLE handle;
 496
 497         handle = CreateFileA(path, access, FILE_SHARE_READ | FILE_SHARE_WRITE, NULL, OPEN_EXISTING, FILE_FLAG_OVERLAPPED, NULL);
 498         if (handle == INVALID_HANDLE_VALUE)
 499                 return handle;
 500
 501         if (CreateIoCompletionPort(handle, priv->completion_port, (ULONG_PTR)dev_handle, 0) == NULL) {
 502                 usbi_err(ctx, "failed to associate handle to I/O completion port: %s", windows_error_str(0));
 503                 CloseHandle(handle);
 504                 return INVALID_HANDLE_VALUE;
 505         }
 506
 507         return handle;
 508 }
 509
 510 /*
 511  * Populate the endpoints addresses of the device_priv interface helper structs
 512  */
 513 static int windows_assign_endpoints(struct libusb_device_handle *dev_handle, uint8_t iface, uint8_t altsetting)
 514 {
 515         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
 516         struct libusb_config_descriptor *conf_desc;
 517         const struct libusb_interface_descriptor *if_desc;
 518         int i, r;
 519
 520         r = libusb_get_active_config_descriptor(dev_handle->dev, &conf_desc);
 521         if (r != LIBUSB_SUCCESS) {
 522                 usbi_warn(HANDLE_CTX(dev_handle), "could not read config descriptor: error %d", r);
 523                 return r;
 524         }
 525
 526         if_desc = &conf_desc->interface[iface].altsetting[altsetting];
 527         safe_free(priv->usb_interface[iface].endpoint);
 528
 529         if (if_desc->bNumEndpoints == 0) {
 530                 usbi_dbg("no endpoints found for interface %u", iface);
 531                 libusb_free_config_descriptor(conf_desc);
 532                 priv->usb_interface[iface].current_altsetting = altsetting;
 533                 return LIBUSB_SUCCESS;
 534         }
 535
 536         priv->usb_interface[iface].endpoint = malloc(if_desc->bNumEndpoints);
 537         if (priv->usb_interface[iface].endpoint == NULL) {
 538                 libusb_free_config_descriptor(conf_desc);
 539                 return LIBUSB_ERROR_NO_MEM;
 540         }
 541
 542         priv->usb_interface[iface].nb_endpoints = if_desc->bNumEndpoints;
 543         for (i = 0; i < if_desc->bNumEndpoints; i++) {
 544                 priv->usb_interface[iface].endpoint[i] = if_desc->endpoint[i].bEndpointAddress;
 545                 usbi_dbg("(re)assigned endpoint %02X to interface %u", priv->usb_interface[iface].endpoint[i], iface);
 546         }
 547         libusb_free_config_descriptor(conf_desc);
 548
 549         // Extra init may be required to configure endpoints
 550         if (priv->apib->configure_endpoints)
 551                 r = priv->apib->configure_endpoints(SUB_API_NOTSET, dev_handle, iface);
 552
 553         if (r == LIBUSB_SUCCESS)
 554                 priv->usb_interface[iface].current_altsetting = altsetting;
 555
 556         return r;
 557 }
 558
 559 // Lookup for a match in the list of API driver names
 560 // return -1 if not found, driver match number otherwise
 561 static int get_sub_api(char *driver, int api)
 562 {
 563         const char sep_str[2] = {LIST_SEPARATOR, 0};
 564         char *tok, *tmp_str;
 565         size_t len = strlen(driver);
 566         int i;
 567
 568         if (len == 0)
 569                 return SUB_API_NOTSET;
 570
 571         tmp_str = _strdup(driver);
 572         if (tmp_str == NULL)
 573                 return SUB_API_NOTSET;
 574
 575         tok = strtok(tmp_str, sep_str);
 576         while (tok != NULL) {
 577                 for (i = 0; i < usb_api_backend[api].nb_driver_names; i++) {
 578                         if (_stricmp(tok, usb_api_backend[api].driver_name_list[i]) == 0) {
 579                                 free(tmp_str);
 580                                 return i;
 581                         }
 582                 }
 583                 tok = strtok(NULL, sep_str);
 584         }
 585
 586         free(tmp_str);
 587         return SUB_API_NOTSET;
 588 }
 589
 590 /*
 591  * auto-claiming and auto-release helper functions
 592  */
 593 static int auto_claim(struct libusb_transfer *transfer, int *interface_number, int api_type)
 594 {
 595         struct winusb_device_handle_priv *handle_priv =
 596                 get_winusb_device_handle_priv(transfer->dev_handle);
 597         struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
 598         int current_interface = *interface_number;
 599         int r = LIBUSB_SUCCESS;
 600
 601         switch (api_type) {
 602         case USB_API_WINUSBX:
 603         case USB_API_HID:
 604                 break;
 605         default:
 606                 return LIBUSB_ERROR_INVALID_PARAM;
 607         }
 608
 609         usbi_mutex_lock(&autoclaim_lock);
 610         if (current_interface < 0) { // No serviceable interface was found
 611                 for (current_interface = 0; current_interface < USB_MAXINTERFACES; current_interface++) {
 612                         // Must claim an interface of the same API type
 613                         if ((priv->usb_interface[current_interface].apib->id == api_type)
 614                                         && (libusb_claim_interface(transfer->dev_handle, current_interface) == LIBUSB_SUCCESS)) {
 615                                 usbi_dbg("auto-claimed interface %d for control request", current_interface);
 616                                 if (handle_priv->autoclaim_count[current_interface] != 0)
 617                                         usbi_err(TRANSFER_CTX(transfer), "program assertion failed - autoclaim_count was nonzero");
 618                                 handle_priv->autoclaim_count[current_interface]++;
 619                                 break;
 620                         }
 621                 }
 622                 if (current_interface == USB_MAXINTERFACES) {
 623                         usbi_err(TRANSFER_CTX(transfer), "could not auto-claim any interface");
 624                         r = LIBUSB_ERROR_NOT_FOUND;
 625                 }
 626         } else {
 627                 // If we have a valid interface that was autoclaimed, we must increment
 628                 // its autoclaim count so that we can prevent an early release.
 629                 if (handle_priv->autoclaim_count[current_interface] != 0)
 630                         handle_priv->autoclaim_count[current_interface]++;
 631         }
 632         usbi_mutex_unlock(&autoclaim_lock);
 633
 634         *interface_number = current_interface;
 635         return r;
 636 }
 637
 638 static void auto_release(struct usbi_transfer *itransfer)
 639 {
 640         struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
 641         struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
 642         libusb_device_handle *dev_handle = transfer->dev_handle;
 643         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
 644         int r;
 645
 646         usbi_mutex_lock(&autoclaim_lock);
 647         if (handle_priv->autoclaim_count[transfer_priv->interface_number] > 0) {
 648                 handle_priv->autoclaim_count[transfer_priv->interface_number]--;
 649                 if (handle_priv->autoclaim_count[transfer_priv->interface_number] == 0) {
 650                         r = libusb_release_interface(dev_handle, transfer_priv->interface_number);
 651                         if (r == LIBUSB_SUCCESS)
 652                                 usbi_dbg("auto-released interface %d", transfer_priv->interface_number);
 653                         else
 654                                 usbi_dbg("failed to auto-release interface %d (%s)",
 655                                         transfer_priv->interface_number, libusb_error_name((enum libusb_error)r));
 656                 }
 657         }
 658         usbi_mutex_unlock(&autoclaim_lock);
 659 }
 660
 661 /*
 662  * init: libusb backend init function
 663  */
 664 static int winusb_init(struct libusb_context *ctx)
 665 {
 666         int i;
 667
 668         // Load DLL imports
 669         if (!init_dlls(ctx)) {
 670                 usbi_err(ctx, "could not resolve DLL functions");
 671                 return LIBUSB_ERROR_OTHER;
 672         }
 673
 674         // Initialize the low level APIs (we don't care about errors at this stage)
 675         for (i = 0; i < USB_API_MAX; i++) {
 676                 if (usb_api_backend[i].init && !usb_api_backend[i].init(ctx))
 677                         usbi_warn(ctx, "error initializing %s backend",
 678                                 usb_api_backend[i].designation);
 679         }
 680
 681         // We need a lock for proper auto-release
 682         usbi_mutex_init(&autoclaim_lock);
 683
 684         return LIBUSB_SUCCESS;
 685 }
 686
 687 /*
 688 * exit: libusb backend deinitialization function
 689 */
 690 static void winusb_exit(struct libusb_context *ctx)
 691 {
 692         int i;
 693
 694         UNUSED(ctx);
 695
 696         usbi_mutex_destroy(&autoclaim_lock);
 697
 698         for (i = 0; i < USB_API_MAX; i++) {
 699                 if (usb_api_backend[i].exit)
 700                         usb_api_backend[i].exit();
 701         }
 702
 703         exit_dlls();
 704 }
 705
 706 /*
 707  * fetch and cache all the config descriptors through I/O
 708  */
 709 static void cache_config_descriptors(struct libusb_device *dev, HANDLE hub_handle)
 710 {
 711         struct libusb_context *ctx = DEVICE_CTX(dev);
 712         struct winusb_device_priv *priv = usbi_get_device_priv(dev);
 713         DWORD size, ret_size;
 714         uint8_t i, num_configurations;
 715
 716         USB_CONFIGURATION_DESCRIPTOR_SHORT cd_buf_short; // dummy request
 717         PUSB_DESCRIPTOR_REQUEST cd_buf_actual = NULL;    // actual request
 718         PUSB_CONFIGURATION_DESCRIPTOR cd_data;
 719
 720         num_configurations = dev->device_descriptor.bNumConfigurations;
 721         if (num_configurations == 0)
 722                 return;
 723
 724         assert(sizeof(USB_DESCRIPTOR_REQUEST) == USB_DESCRIPTOR_REQUEST_SIZE);
 725
 726         priv->config_descriptor = calloc(num_configurations, sizeof(PUSB_CONFIGURATION_DESCRIPTOR));
 727         if (priv->config_descriptor == NULL) {
 728                 usbi_err(ctx, "could not allocate configuration descriptor array for '%s'", priv->dev_id);
 729                 return;
 730         }
 731
 732         for (i = 0; i <= num_configurations; i++) {
 733                 safe_free(cd_buf_actual);
 734
 735                 if (i == num_configurations)
 736                         break;
 737
 738                 size = sizeof(cd_buf_short);
 739                 memset(&cd_buf_short.desc, 0, sizeof(cd_buf_short.desc));
 740
 741                 cd_buf_short.req.ConnectionIndex = (ULONG)dev->port_number;
 742                 cd_buf_short.req.SetupPacket.bmRequest = LIBUSB_ENDPOINT_IN;
 743                 cd_buf_short.req.SetupPacket.bRequest = LIBUSB_REQUEST_GET_DESCRIPTOR;
 744                 cd_buf_short.req.SetupPacket.wValue = (LIBUSB_DT_CONFIG << 8) | i;
 745                 cd_buf_short.req.SetupPacket.wIndex = 0;
 746                 cd_buf_short.req.SetupPacket.wLength = (USHORT)sizeof(USB_CONFIGURATION_DESCRIPTOR);
 747
 748                 // Dummy call to get the required data size. Initial failures are reported as info rather
 749                 // than error as they can occur for non-penalizing situations, such as with some hubs.
 750                 // coverity[tainted_data_argument]
 751                 if (!DeviceIoControl(hub_handle, IOCTL_USB_GET_DESCRIPTOR_FROM_NODE_CONNECTION, &cd_buf_short, size,
 752                         &cd_buf_short, size, &ret_size, NULL)) {
 753                         usbi_info(ctx, "could not access configuration descriptor %u (dummy) for '%s': %s", i, priv->dev_id, windows_error_str(0));
 754                         continue;
 755                 }
 756
 757                 if ((ret_size != size) || (cd_buf_short.desc.wTotalLength < sizeof(USB_CONFIGURATION_DESCRIPTOR))) {
 758                         usbi_info(ctx, "unexpected configuration descriptor %u size (dummy) for '%s'", i, priv->dev_id);
 759                         continue;
 760                 }
 761
 762                 size = sizeof(USB_DESCRIPTOR_REQUEST) + cd_buf_short.desc.wTotalLength;
 763                 cd_buf_actual = malloc(size);
 764                 if (cd_buf_actual == NULL) {
 765                         usbi_err(ctx, "could not allocate configuration descriptor %u buffer for '%s'", i, priv->dev_id);
 766                         continue;
 767                 }
 768
 769                 // Actual call
 770                 cd_buf_actual->ConnectionIndex = (ULONG)dev->port_number;
 771                 cd_buf_actual->SetupPacket.bmRequest = LIBUSB_ENDPOINT_IN;
 772                 cd_buf_actual->SetupPacket.bRequest = LIBUSB_REQUEST_GET_DESCRIPTOR;
 773                 cd_buf_actual->SetupPacket.wValue = (LIBUSB_DT_CONFIG << 8) | i;
 774                 cd_buf_actual->SetupPacket.wIndex = 0;
 775                 cd_buf_actual->SetupPacket.wLength = cd_buf_short.desc.wTotalLength;
 776
 777                 if (!DeviceIoControl(hub_handle, IOCTL_USB_GET_DESCRIPTOR_FROM_NODE_CONNECTION, cd_buf_actual, size,
 778                         cd_buf_actual, size, &ret_size, NULL)) {
 779                         usbi_err(ctx, "could not access configuration descriptor %u (actual) for '%s': %s", i, priv->dev_id, windows_error_str(0));
 780                         continue;
 781                 }
 782
 783                 cd_data = (PUSB_CONFIGURATION_DESCRIPTOR)((UCHAR *)cd_buf_actual + USB_DESCRIPTOR_REQUEST_SIZE);
 784
 785                 if ((size != ret_size) || (cd_data->wTotalLength != cd_buf_short.desc.wTotalLength)) {
 786                         usbi_err(ctx, "unexpected configuration descriptor %u size (actual) for '%s'", i, priv->dev_id);
 787                         continue;
 788                 }
 789
 790                 if (cd_data->bDescriptorType != LIBUSB_DT_CONFIG) {
 791                         usbi_err(ctx, "descriptor %u not a configuration descriptor for '%s'", i, priv->dev_id);
 792                         continue;
 793                 }
 794
 795                 usbi_dbg("cached config descriptor %u (bConfigurationValue=%u, %u bytes)",
 796                         i, cd_data->bConfigurationValue, cd_data->wTotalLength);
 797
 798                 // Cache the descriptor
 799                 priv->config_descriptor[i] = cd_data;
 800                 cd_buf_actual = NULL;
 801         }
 802 }
 803
 804 #define ROOT_HUB_FS_CONFIG_DESC_LENGTH          0x19
 805 #define ROOT_HUB_HS_CONFIG_DESC_LENGTH          0x19
 806 #define ROOT_HUB_SS_CONFIG_DESC_LENGTH          0x1f
 807 #define CONFIG_DESC_WTOTAL_LENGTH_OFFSET        0x02
 808 #define CONFIG_DESC_EP_MAX_PACKET_OFFSET        0x16
 809 #define CONFIG_DESC_EP_BINTERVAL_OFFSET         0x18
 810
 811 static const uint8_t root_hub_config_descriptor_template[] = {
 812         // Configuration Descriptor
 813         LIBUSB_DT_CONFIG_SIZE,          // bLength
 814         LIBUSB_DT_CONFIG,               // bDescriptorType
 815         0x00, 0x00,                     // wTotalLength (filled in)
 816         0x01,                           // bNumInterfaces
 817         0x01,                           // bConfigurationValue
 818         0x00,                           // iConfiguration
 819         0xc0,                           // bmAttributes (reserved + self-powered)
 820         0x00,                           // bMaxPower
 821         // Interface Descriptor
 822         LIBUSB_DT_INTERFACE_SIZE,       // bLength
 823         LIBUSB_DT_INTERFACE,            // bDescriptorType
 824         0x00,                           // bInterfaceNumber
 825         0x00,                           // bAlternateSetting
 826         0x01,                           // bNumEndpoints
 827         LIBUSB_CLASS_HUB,               // bInterfaceClass
 828         0x00,                           // bInterfaceSubClass
 829         0x00,                           // bInterfaceProtocol
 830         0x00,                           // iInterface
 831         // Endpoint Descriptor
 832         LIBUSB_DT_ENDPOINT_SIZE,        // bLength
 833         LIBUSB_DT_ENDPOINT,             // bDescriptorType
 834         0x81,                           // bEndpointAddress
 835         0x03,                           // bmAttributes (Interrupt)
 836         0x00, 0x00,                     // wMaxPacketSize (filled in)
 837         0x00,                           // bInterval (filled in)
 838         // SuperSpeed Endpoint Companion Descriptor
 839         LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE,   // bLength
 840         LIBUSB_DT_SS_ENDPOINT_COMPANION,        // bDescriptorType
 841         0x00,                                   // bMaxBurst
 842         0x00,                                   // bmAttributes
 843         0x02, 0x00                              // wBytesPerInterval
 844 };
 845
 846 static int alloc_root_hub_config_desc(struct libusb_device *dev, ULONG num_ports,
 847         uint8_t config_desc_length, uint8_t ep_interval)
 848 {
 849         struct winusb_device_priv *priv = usbi_get_device_priv(dev);
 850         uint8_t *ptr;
 851
 852         priv->config_descriptor = malloc(sizeof(*priv->config_descriptor));
 853         if (priv->config_descriptor == NULL)
 854                 return LIBUSB_ERROR_NO_MEM;
 855
 856         // Most config descriptors come from cache_config_descriptors() which obtains the
 857         // descriptors from the hub using an allocated USB_DESCRIPTOR_REQUEST structure.
 858         // To avoid an extra malloc + memcpy we just hold on to the USB_DESCRIPTOR_REQUEST
 859         // structure we already have and back up the pointer in windows_device_priv_release()
 860         // when freeing the descriptors. To keep a single execution path, we need to offset
 861         // the pointer here by the same amount.
 862         ptr = malloc(USB_DESCRIPTOR_REQUEST_SIZE + config_desc_length);
 863         if (ptr == NULL)
 864                 return LIBUSB_ERROR_NO_MEM;
 865
 866         ptr += USB_DESCRIPTOR_REQUEST_SIZE;
 867
 868         memcpy(ptr, root_hub_config_descriptor_template, config_desc_length);
 869         ptr[CONFIG_DESC_WTOTAL_LENGTH_OFFSET] = config_desc_length;
 870         ptr[CONFIG_DESC_EP_MAX_PACKET_OFFSET] = (uint8_t)((num_ports + 7) / 8);
 871         ptr[CONFIG_DESC_EP_BINTERVAL_OFFSET] = ep_interval;
 872
 873         priv->config_descriptor[0] = (PUSB_CONFIGURATION_DESCRIPTOR)ptr;
 874         priv->active_config = 1;
 875
 876         return 0;
 877 }
 878
 879 static int init_root_hub(struct libusb_device *dev)
 880 {
 881         struct libusb_context *ctx = DEVICE_CTX(dev);
 882         struct winusb_device_priv *priv = usbi_get_device_priv(dev);
 883         USB_NODE_CONNECTION_INFORMATION_EX conn_info;
 884         USB_NODE_CONNECTION_INFORMATION_EX_V2 conn_info_v2;
 885         USB_NODE_INFORMATION hub_info;
 886         enum libusb_speed speed = LIBUSB_SPEED_UNKNOWN;
 887         uint8_t config_desc_length;
 888         uint8_t ep_interval;
 889         HANDLE handle;
 890         ULONG port_number, num_ports;
 891         DWORD size;
 892         int r;
 893
 894         // Determining the speed of a root hub is painful. Microsoft does not directly report the speed
 895         // capabilities of the root hub itself, only its ports and/or connected devices. Therefore we
 896         // are forced to query each individual port of the root hub to try and infer the root hub's
 897         // speed. Note that we have to query all ports because the presence of a device on that port
 898         // changes if/how Windows returns any useful speed information.
 899         handle = CreateFileA(priv->path, GENERIC_WRITE, FILE_SHARE_WRITE, NULL, OPEN_EXISTING, 0, NULL);
 900         if (handle == INVALID_HANDLE_VALUE) {
 901                 usbi_err(ctx, "could not open root hub %s: %s", priv->path, windows_error_str(0));
 902                 return LIBUSB_ERROR_ACCESS;
 903         }
 904
 905         if (!DeviceIoControl(handle, IOCTL_USB_GET_NODE_INFORMATION, NULL, 0, &hub_info, sizeof(hub_info), &size, NULL)) {
 906                 usbi_warn(ctx, "could not get root hub info for '%s': %s", priv->dev_id, windows_error_str(0));
 907                 CloseHandle(handle);
 908                 return LIBUSB_ERROR_ACCESS;
 909         }
 910
 911         num_ports = hub_info.u.HubInformation.HubDescriptor.bNumberOfPorts;
 912         usbi_dbg("root hub '%s' reports %lu ports", priv->dev_id, ULONG_CAST(num_ports));
 913
 914         if (windows_version >= WINDOWS_8) {
 915                 // Windows 8 and later is better at reporting the speed capabilities of the root hub,
 916                 // but it is not perfect. If no device is attached to the port being queried, the
 917                 // returned information will only indicate whether that port supports USB 3.0 signalling.
 918                 // That is not enough information to distinguish between SuperSpeed and SuperSpeed Plus.
 919                 for (port_number = 1; port_number <= num_ports; port_number++) {
 920                         conn_info_v2.ConnectionIndex = port_number;
 921                         conn_info_v2.Length = sizeof(conn_info_v2);
 922                         conn_info_v2.SupportedUsbProtocols.Usb300 = 1;
 923                         if (!DeviceIoControl(handle, IOCTL_USB_GET_NODE_CONNECTION_INFORMATION_EX_V2,
 924                                 &conn_info_v2, sizeof(conn_info_v2), &conn_info_v2, sizeof(conn_info_v2), &size, NULL)) {
 925                                 usbi_warn(ctx, "could not get node connection information (V2) for root hub '%s' port %lu: %s",
 926                                         priv->dev_id, ULONG_CAST(port_number), windows_error_str(0));
 927                                 break;
 928                         }
 929
 930                         if (conn_info_v2.Flags.DeviceIsSuperSpeedPlusCapableOrHigher)
 931                                 speed = MAX(speed, LIBUSB_SPEED_SUPER_PLUS);
 932                         else if (conn_info_v2.Flags.DeviceIsSuperSpeedCapableOrHigher || conn_info_v2.SupportedUsbProtocols.Usb300)
 933                                 speed = MAX(speed, LIBUSB_SPEED_SUPER);
 934                         else if (conn_info_v2.SupportedUsbProtocols.Usb200)
 935                                 speed = MAX(speed, LIBUSB_SPEED_HIGH);
 936                         else
 937                                 speed = MAX(speed, LIBUSB_SPEED_FULL);
 938                 }
 939
 940                 if (speed != LIBUSB_SPEED_UNKNOWN)
 941                         goto make_descriptors;
 942         }
 943
 944         // At this point the speed is still not known, most likely because we are executing on
 945         // Windows 7 or earlier. The following hackery peeks into the root hub's Device ID and
 946         // tries to extract speed information from it, based on observed naming conventions.
 947         // If this does not work, we will query individual ports of the root hub.
 948         if (strstr(priv->dev_id, "ROOT_HUB31") != NULL)
 949                 speed = LIBUSB_SPEED_SUPER_PLUS;
 950         else if (strstr(priv->dev_id, "ROOT_HUB30") != NULL)
 951                 speed = LIBUSB_SPEED_SUPER;
 952         else if (strstr(priv->dev_id, "ROOT_HUB20") != NULL)
 953                 speed = LIBUSB_SPEED_HIGH;
 954
 955         if (speed != LIBUSB_SPEED_UNKNOWN)
 956                 goto make_descriptors;
 957
 958         // Windows only reports speed information about a connected device. This means that a root
 959         // hub with no connected devices or devices that are all operating at a speed less than the
 960         // highest speed that the root hub supports will not give us the correct speed.
 961         for (port_number = 1; port_number <= num_ports; port_number++) {
 962                 conn_info.ConnectionIndex = port_number;
 963                 if (!DeviceIoControl(handle, IOCTL_USB_GET_NODE_CONNECTION_INFORMATION_EX, &conn_info, sizeof(conn_info),
 964                         &conn_info, sizeof(conn_info), &size, NULL)) {
 965                         usbi_warn(ctx, "could not get node connection information for root hub '%s' port %lu: %s",
 966                                 priv->dev_id, ULONG_CAST(port_number), windows_error_str(0));
 967                         continue;
 968                 }
 969
 970                 if (conn_info.ConnectionStatus != DeviceConnected)
 971                         continue;
 972
 973                 if (conn_info.Speed == UsbHighSpeed) {
 974                         speed = LIBUSB_SPEED_HIGH;
 975                         break;
 976                 }
 977         }
 978
 979 make_descriptors:
 980         CloseHandle(handle);
 981
 982         dev->device_descriptor.bLength = LIBUSB_DT_DEVICE_SIZE;
 983         dev->device_descriptor.bDescriptorType = LIBUSB_DT_DEVICE;
 984         dev->device_descriptor.bDeviceClass = LIBUSB_CLASS_HUB;
 985         if ((dev->device_descriptor.idVendor == 0) && (dev->device_descriptor.idProduct == 0)) {
 986                 dev->device_descriptor.idVendor = 0x1d6b;       // Linux Foundation
 987                 dev->device_descriptor.idProduct = (uint16_t)speed;
 988         }
 989         dev->device_descriptor.bcdDevice = 0x0100;
 990         dev->device_descriptor.bNumConfigurations = 1;
 991
 992         switch (speed) {
 993         case LIBUSB_SPEED_SUPER_PLUS:
 994                 dev->device_descriptor.bcdUSB = 0x0310;
 995                 config_desc_length = ROOT_HUB_SS_CONFIG_DESC_LENGTH;
 996                 ep_interval = 0x0c;     // 256ms
 997                 break;
 998         case LIBUSB_SPEED_SUPER:
 999                 dev->device_descriptor.bcdUSB = 0x0300;
1000                 config_desc_length = ROOT_HUB_SS_CONFIG_DESC_LENGTH;
1001                 ep_interval = 0x0c;     // 256ms
1002                 break;
1003         case LIBUSB_SPEED_HIGH:
1004                 dev->device_descriptor.bcdUSB = 0x0200;
1005                 config_desc_length = ROOT_HUB_HS_CONFIG_DESC_LENGTH;
1006                 ep_interval = 0x0c;     // 256ms
1007                 break;
1008         case LIBUSB_SPEED_LOW:          // Not used, but keeps compiler happy
1009         case LIBUSB_SPEED_UNKNOWN:
1010                 // This case means absolutely no information about this root hub was determined.
1011                 // There is not much choice than to be pessimistic and label this as a
1012                 // full-speed device.
1013                 speed = LIBUSB_SPEED_FULL;
1014                 // fallthrough
1015         case LIBUSB_SPEED_FULL:
1016                 dev->device_descriptor.bcdUSB = 0x0110;
1017                 config_desc_length = ROOT_HUB_FS_CONFIG_DESC_LENGTH;
1018                 ep_interval = 0xff;     // 255ms
1019                 break;
1020         default:                        // Impossible, buts keeps compiler happy
1021                 usbi_err(ctx, "program assertion failed - unknown root hub speed");
1022                 return LIBUSB_ERROR_INVALID_PARAM;
1023         }
1024
1025         if (speed >= LIBUSB_SPEED_SUPER) {
1026                 dev->device_descriptor.bDeviceProtocol = 0x03;  // USB 3.0 Hub
1027                 dev->device_descriptor.bMaxPacketSize0 = 0x09;  // 2^9 bytes
1028         } else {
1029                 dev->device_descriptor.bMaxPacketSize0 = 0x40;  // 64 bytes
1030         }
1031
1032         dev->speed = speed;
1033
1034         r = alloc_root_hub_config_desc(dev, num_ports, config_desc_length, ep_interval);
1035         if (r)
1036                 usbi_err(ctx, "could not allocate config descriptor for root hub '%s'", priv->dev_id);
1037
1038         return r;
1039 }
1040
1041 /*
1042  * Populate a libusb device structure
1043  */
1044 static int init_device(struct libusb_device *dev, struct libusb_device *parent_dev,
1045         uint8_t port_number, DEVINST devinst)
1046 {
1047         struct libusb_context *ctx;
1048         struct libusb_device *tmp_dev;
1049         struct winusb_device_priv *priv, *parent_priv, *tmp_priv;
1050         USB_NODE_CONNECTION_INFORMATION_EX conn_info;
1051         USB_NODE_CONNECTION_INFORMATION_EX_V2 conn_info_v2;
1052         HANDLE hub_handle;
1053         DWORD size;
1054         uint8_t bus_number, depth;
1055         int r;
1056         int ginfotimeout;
1057
1058         priv = usbi_get_device_priv(dev);
1059
1060         // If the device is already initialized, we can stop here
1061         if (priv->initialized)
1062                 return LIBUSB_SUCCESS;
1063
1064         if (parent_dev != NULL) { // Not a HCD root hub
1065                 ctx = DEVICE_CTX(dev);
1066                 parent_priv = usbi_get_device_priv(parent_dev);
1067                 if (parent_priv->apib->id != USB_API_HUB) {
1068                         usbi_warn(ctx, "parent for device '%s' is not a hub", priv->dev_id);
1069                         return LIBUSB_ERROR_NOT_FOUND;
1070                 }
1071
1072                 // Calculate depth and fetch bus number
1073                 bus_number = parent_dev->bus_number;
1074                 if (bus_number == 0) {
1075                         tmp_dev = get_ancestor(ctx, devinst, &devinst);
1076                         if (tmp_dev != parent_dev) {
1077                                 usbi_err(ctx, "program assertion failed - first ancestor is not parent");
1078                                 return LIBUSB_ERROR_NOT_FOUND;
1079                         }
1080                         libusb_unref_device(tmp_dev);
1081
1082                         for (depth = 1; bus_number == 0; depth++) {
1083                                 tmp_dev = get_ancestor(ctx, devinst, &devinst);
1084                                 if (tmp_dev == NULL) {
1085                                         usbi_warn(ctx, "ancestor for device '%s' not found at depth %u", priv->dev_id, depth);
1086                                         return LIBUSB_ERROR_NO_DEVICE;
1087                                 }
1088                                 if (tmp_dev->bus_number != 0) {
1089                                         bus_number = tmp_dev->bus_number;
1090                                         tmp_priv = usbi_get_device_priv(tmp_dev);
1091                                         depth += tmp_priv->depth;
1092                                 }
1093                                 libusb_unref_device(tmp_dev);
1094                         }
1095                 } else {
1096                         depth = parent_priv->depth + 1;
1097                 }
1098
1099                 if (bus_number == 0) {
1100                         usbi_err(ctx, "program assertion failed - bus number not found for '%s'", priv->dev_id);
1101                         return LIBUSB_ERROR_NOT_FOUND;
1102                 }
1103
1104                 dev->bus_number = bus_number;
1105                 dev->port_number = port_number;
1106                 dev->parent_dev = parent_dev;
1107                 priv->depth = depth;
1108
1109                 hub_handle = CreateFileA(parent_priv->path, GENERIC_WRITE, FILE_SHARE_WRITE, NULL, OPEN_EXISTING, 0, NULL);
1110                 if (hub_handle == INVALID_HANDLE_VALUE) {
1111                         usbi_warn(ctx, "could not open hub %s: %s", parent_priv->path, windows_error_str(0));
1112                         return LIBUSB_ERROR_ACCESS;
1113                 }
1114
1115                 conn_info.ConnectionIndex = (ULONG)port_number;
1116                 // coverity[tainted_data_argument]
1117                 ginfotimeout = 20;
1118                 do {
1119                         if (!DeviceIoControl(hub_handle, IOCTL_USB_GET_NODE_CONNECTION_INFORMATION_EX, &conn_info, sizeof(conn_info),
1120                                 &conn_info, sizeof(conn_info), &size, NULL)) {
1121                                 usbi_warn(ctx, "could not get node connection information for device '%s': %s",
1122                                         priv->dev_id, windows_error_str(0));
1123                                 CloseHandle(hub_handle);
1124                                 return LIBUSB_ERROR_NO_DEVICE;
1125                         }
1126
1127                         if (conn_info.ConnectionStatus == NoDeviceConnected) {
1128                                 usbi_err(ctx, "device '%s' is no longer connected!", priv->dev_id);
1129                                 CloseHandle(hub_handle);
1130                                 return LIBUSB_ERROR_NO_DEVICE;
1131                         }
1132
1133                         if ((conn_info.DeviceDescriptor.bLength != LIBUSB_DT_DEVICE_SIZE)
1134                                  || (conn_info.DeviceDescriptor.bDescriptorType != LIBUSB_DT_DEVICE)) {
1135                                 SleepEx(50, TRUE);
1136                                 continue;
1137                         }
1138
1139                         static_assert(sizeof(dev->device_descriptor) == sizeof(conn_info.DeviceDescriptor),
1140                                       "mismatch between libusb and OS device descriptor sizes");
1141                         memcpy(&dev->device_descriptor, &conn_info.DeviceDescriptor, LIBUSB_DT_DEVICE_SIZE);
1142                         usbi_localize_device_descriptor(&dev->device_descriptor);
1143
1144                         priv->active_config = conn_info.CurrentConfigurationValue;
1145                         if (priv->active_config == 0) {
1146                                 usbi_dbg("0x%x:0x%x found %u configurations (not configured)",
1147                                         dev->device_descriptor.idVendor,
1148                                         dev->device_descriptor.idProduct,
1149                                         dev->device_descriptor.bNumConfigurations);
1150                                 SleepEx(50, TRUE);
1151                         }
1152                 } while (priv->active_config == 0 && --ginfotimeout >= 0);
1153
1154                 if ((conn_info.DeviceDescriptor.bLength != LIBUSB_DT_DEVICE_SIZE)
1155                          || (conn_info.DeviceDescriptor.bDescriptorType != LIBUSB_DT_DEVICE)) {
1156                         usbi_err(ctx, "device '%s' has invalid descriptor!", priv->dev_id);
1157                         CloseHandle(hub_handle);
1158                         return LIBUSB_ERROR_OTHER;
1159                 }
1160
1161                 if (priv->active_config == 0) {
1162                         usbi_info(ctx, "0x%x:0x%x found %u configurations but device isn't configured, "
1163                                 "forcing current configuration to 1",
1164                                 dev->device_descriptor.idVendor,
1165                                 dev->device_descriptor.idProduct,
1166                                 dev->device_descriptor.bNumConfigurations);
1167                         priv->active_config = 1;
1168                 } else {
1169                         usbi_dbg("found %u configurations (current config: %u)", dev->device_descriptor.bNumConfigurations, priv->active_config);
1170                 }
1171
1172                 // Cache as many config descriptors as we can
1173                 cache_config_descriptors(dev, hub_handle);
1174
1175                 // In their great wisdom, Microsoft decided to BREAK the USB speed report between Windows 7 and Windows 8
1176                 if (windows_version >= WINDOWS_8) {
1177                         conn_info_v2.ConnectionIndex = (ULONG)port_number;
1178                         conn_info_v2.Length = sizeof(USB_NODE_CONNECTION_INFORMATION_EX_V2);
1179                         conn_info_v2.SupportedUsbProtocols.Usb300 = 1;
1180                         if (!DeviceIoControl(hub_handle, IOCTL_USB_GET_NODE_CONNECTION_INFORMATION_EX_V2,
1181                                 &conn_info_v2, sizeof(conn_info_v2), &conn_info_v2, sizeof(conn_info_v2), &size, NULL)) {
1182                                 usbi_warn(ctx, "could not get node connection information (V2) for device '%s': %s",
1183                                         priv->dev_id,  windows_error_str(0));
1184                         } else if (conn_info_v2.Flags.DeviceIsOperatingAtSuperSpeedPlusOrHigher) {
1185                                 conn_info.Speed = UsbSuperSpeedPlus;
1186                         } else if (conn_info_v2.Flags.DeviceIsOperatingAtSuperSpeedOrHigher) {
1187                                 conn_info.Speed = UsbSuperSpeed;
1188                         }
1189                 }
1190
1191                 CloseHandle(hub_handle);
1192
1193                 if (conn_info.DeviceAddress > UINT8_MAX)
1194                         usbi_err(ctx, "program assertion failed - device address overflow");
1195
1196                 dev->device_address = (uint8_t)conn_info.DeviceAddress;
1197
1198                 switch (conn_info.Speed) {
1199                 case UsbLowSpeed: dev->speed = LIBUSB_SPEED_LOW; break;
1200                 case UsbFullSpeed: dev->speed = LIBUSB_SPEED_FULL; break;
1201                 case UsbHighSpeed: dev->speed = LIBUSB_SPEED_HIGH; break;
1202                 case UsbSuperSpeed: dev->speed = LIBUSB_SPEED_SUPER; break;
1203                 case UsbSuperSpeedPlus: dev->speed = LIBUSB_SPEED_SUPER_PLUS; break;
1204                 default:
1205                         usbi_warn(ctx, "unknown device speed %u", conn_info.Speed);
1206                         break;
1207                 }
1208         } else {
1209                 r = init_root_hub(dev);
1210                 if (r)
1211                         return r;
1212         }
1213
1214         r = usbi_sanitize_device(dev);
1215         if (r)
1216                 return r;
1217
1218         priv->initialized = true;
1219
1220         usbi_dbg("(bus: %u, addr: %u, depth: %u, port: %u): '%s'",
1221                 dev->bus_number, dev->device_address, priv->depth, dev->port_number, priv->dev_id);
1222
1223         return LIBUSB_SUCCESS;
1224 }
1225
1226 static bool get_dev_port_number(HDEVINFO dev_info, SP_DEVINFO_DATA *dev_info_data, DWORD *port_nr)
1227 {
1228         char buffer[MAX_KEY_LENGTH];
1229         DWORD size;
1230
1231         // First try SPDRP_LOCATION_INFORMATION, which returns a REG_SZ. The string *may* have a format
1232         // similar to "Port_#0002.Hub_#000D", in which case we can extract the port number. However, we
1233         // cannot extract the port if the returned string does not follow this format.
1234         if (pSetupDiGetDeviceRegistryPropertyA(dev_info, dev_info_data, SPDRP_LOCATION_INFORMATION,
1235                         NULL, (PBYTE)buffer, sizeof(buffer), NULL)) {
1236                 // Check for the required format.
1237                 if (strncmp(buffer, "Port_#", 6) == 0) {
1238                         *port_nr = atoi(buffer + 6);
1239                         return true;
1240                 }
1241         }
1242
1243         // Next try SPDRP_LOCATION_PATHS, which returns a REG_MULTI_SZ (but we only examine the first
1244         // string in it). Each path has a format similar to,
1245         // "PCIROOT(B2)#PCI(0300)#PCI(0000)#USBROOT(0)#USB(1)#USB(2)#USBMI(3)", and the port number is
1246         // the number within the last "USB(x)" token.
1247         if (pSetupDiGetDeviceRegistryPropertyA(dev_info, dev_info_data, SPDRP_LOCATION_PATHS,
1248                         NULL, (PBYTE)buffer, sizeof(buffer), NULL)) {
1249                 // Find the last "#USB(x)" substring
1250                 for (char *token = strrchr(buffer, '#'); token != NULL; token = strrchr(buffer, '#')) {
1251                         if (strncmp(token, "#USB(", 5) == 0) {
1252                                 *port_nr = atoi(token + 5);
1253                                 return true;
1254                         }
1255                         // Shorten the string and try again.
1256                         *token = '\0';
1257                 }
1258         }
1259
1260         // Lastly, try SPDRP_ADDRESS, which returns a REG_DWORD. The address *may* be the port number,
1261         // which is true for the Microsoft driver but may not be true for other drivers. However, we
1262         // have no other options here but to accept what it returns.
1263         return pSetupDiGetDeviceRegistryPropertyA(dev_info, dev_info_data, SPDRP_ADDRESS,
1264                         NULL, (PBYTE)port_nr, sizeof(*port_nr), &size) && (size == sizeof(*port_nr));
1265 }
1266
1267 static int enumerate_hcd_root_hub(struct libusb_context *ctx, const char *dev_id,
1268         uint8_t bus_number, DEVINST devinst)
1269 {
1270         struct libusb_device *dev;
1271         struct winusb_device_priv *priv;
1272         unsigned long session_id;
1273         DEVINST child_devinst;
1274
1275         if (CM_Get_Child(&child_devinst, devinst, 0) != CR_SUCCESS) {
1276                 usbi_warn(ctx, "could not get child devinst for '%s'", dev_id);
1277                 return LIBUSB_SUCCESS;
1278         }
1279
1280         session_id = (unsigned long)child_devinst;
1281         dev = usbi_get_device_by_session_id(ctx, session_id);
1282         if (dev == NULL) {
1283                 usbi_err(ctx, "program assertion failed - HCD '%s' child not found", dev_id);
1284                 return LIBUSB_SUCCESS;
1285         }
1286
1287         if (dev->bus_number == 0) {
1288                 // Only do this once
1289                 usbi_dbg("assigning HCD '%s' bus number %u", dev_id, bus_number);
1290                 dev->bus_number = bus_number;
1291
1292                 if (sscanf(dev_id, "PCI\\VEN_%04hx&DEV_%04hx%*s", &dev->device_descriptor.idVendor, &dev->device_descriptor.idProduct) != 2)
1293                         usbi_warn(ctx, "could not infer VID/PID of HCD root hub from '%s'", dev_id);
1294
1295                 priv = usbi_get_device_priv(dev);
1296                 priv->root_hub = true;
1297         }
1298
1299         libusb_unref_device(dev);
1300         return LIBUSB_SUCCESS;
1301 }
1302
1303 // Returns the api type, or 0 if not found/unsupported
1304 static void get_api_type(HDEVINFO *dev_info, SP_DEVINFO_DATA *dev_info_data,
1305         int *api, int *sub_api)
1306 {
1307         // Precedence for filter drivers vs driver is in the order of this array
1308         struct driver_lookup lookup[3] = {
1309                 {"\0\0", SPDRP_SERVICE, "driver"},
1310                 {"\0\0", SPDRP_UPPERFILTERS, "upper filter driver"},
1311                 {"\0\0", SPDRP_LOWERFILTERS, "lower filter driver"}
1312         };
1313         DWORD size, reg_type;
1314         unsigned k, l;
1315         int i, j;
1316
1317         // Check the service & filter names to know the API we should use
1318         for (k = 0; k < 3; k++) {
1319                 if (pSetupDiGetDeviceRegistryPropertyA(*dev_info, dev_info_data, lookup[k].reg_prop,
1320                         &reg_type, (PBYTE)lookup[k].list, MAX_KEY_LENGTH, &size)) {
1321                         // Turn the REG_SZ SPDRP_SERVICE into REG_MULTI_SZ
1322                         if (lookup[k].reg_prop == SPDRP_SERVICE)
1323                                 // our buffers are MAX_KEY_LENGTH + 1 so we can overflow if needed
1324                                 lookup[k].list[strlen(lookup[k].list) + 1] = 0;
1325
1326                         // MULTI_SZ is a pain to work with. Turn it into something much more manageable
1327                         // NB: none of the driver names we check against contain LIST_SEPARATOR,
1328                         // (currently ';'), so even if an unsupported one does, it's not an issue
1329                         for (l = 0; (lookup[k].list[l] != 0) || (lookup[k].list[l + 1] != 0); l++) {
1330                                 if (lookup[k].list[l] == 0)
1331                                         lookup[k].list[l] = LIST_SEPARATOR;
1332                         }
1333                         usbi_dbg("%s(s): %s", lookup[k].designation, lookup[k].list);
1334                 } else {
1335                         if (GetLastError() != ERROR_INVALID_DATA)
1336                                 usbi_dbg("could not access %s: %s", lookup[k].designation, windows_error_str(0));
1337                         lookup[k].list[0] = 0;
1338                 }
1339         }
1340
1341         for (i = 2; i < USB_API_MAX; i++) {
1342                 for (k = 0; k < 3; k++) {
1343                         j = get_sub_api(lookup[k].list, i);
1344                         if (j >= 0) {
1345                                 usbi_dbg("matched %s name against %s", lookup[k].designation,
1346                                         (i != USB_API_WINUSBX) ? usb_api_backend[i].designation : usb_api_backend[i].driver_name_list[j]);
1347                                 *api = i;
1348                                 *sub_api = j;
1349                                 return;
1350                         }
1351                 }
1352         }
1353 }
1354
1355 static int set_composite_interface(struct libusb_context *ctx, struct libusb_device *dev,
1356         char *dev_interface_path, char *device_id, int api, int sub_api)
1357 {
1358         struct winusb_device_priv *priv = usbi_get_device_priv(dev);
1359         int interface_number;
1360         const char *mi_str;
1361
1362         // Because MI_## are not necessarily in sequential order (some composite
1363         // devices will have only MI_00 & MI_03 for instance), we retrieve the actual
1364         // interface number from the path's MI value
1365         mi_str = strstr(device_id, "MI_");
1366         if ((mi_str != NULL) && isdigit((unsigned char)mi_str[3]) && isdigit((unsigned char)mi_str[4])) {
1367                 interface_number = ((mi_str[3] - '0') * 10) + (mi_str[4] - '0');
1368         } else {
1369                 usbi_warn(ctx, "failure to read interface number for %s, using default value", device_id);
1370                 interface_number = 0;
1371         }
1372
1373         if (interface_number >= USB_MAXINTERFACES) {
1374                 usbi_warn(ctx, "interface %d too large - ignoring interface path %s", interface_number, dev_interface_path);
1375                 return LIBUSB_ERROR_ACCESS;
1376         }
1377
1378         if (priv->usb_interface[interface_number].path != NULL) {
1379                 if (api == USB_API_HID) {
1380                         // HID devices can have multiple collections (COL##) for each MI_## interface
1381                         usbi_dbg("interface[%d] already set - ignoring HID collection: %s",
1382                                 interface_number, device_id);
1383                         return LIBUSB_ERROR_ACCESS;
1384                 }
1385                 // In other cases, just use the latest data
1386                 safe_free(priv->usb_interface[interface_number].path);
1387         }
1388
1389         usbi_dbg("interface[%d] = %s", interface_number, dev_interface_path);
1390         priv->usb_interface[interface_number].path = dev_interface_path;
1391         priv->usb_interface[interface_number].apib = &usb_api_backend[api];
1392         priv->usb_interface[interface_number].sub_api = sub_api;
1393         if ((api == USB_API_HID) && (priv->hid == NULL)) {
1394                 priv->hid = calloc(1, sizeof(struct hid_device_priv));
1395                 if (priv->hid == NULL)
1396                         return LIBUSB_ERROR_NO_MEM;
1397         }
1398
1399         return LIBUSB_SUCCESS;
1400 }
1401
1402 static int set_hid_interface(struct libusb_context *ctx, struct libusb_device *dev,
1403         char *dev_interface_path)
1404 {
1405         struct winusb_device_priv *priv = usbi_get_device_priv(dev);
1406         uint8_t i;
1407
1408         if (priv->hid == NULL) {
1409                 usbi_err(ctx, "program assertion failed - parent is not HID");
1410                 return LIBUSB_ERROR_NO_DEVICE;
1411         } else if (priv->hid->nb_interfaces == USB_MAXINTERFACES) {
1412                 usbi_err(ctx, "program assertion failed - max USB interfaces reached for HID device");
1413                 return LIBUSB_ERROR_NO_DEVICE;
1414         }
1415
1416         for (i = 0; i < priv->hid->nb_interfaces; i++) {
1417                 if ((priv->usb_interface[i].path != NULL) && strcmp(priv->usb_interface[i].path, dev_interface_path) == 0) {
1418                         usbi_dbg("interface[%u] already set to %s", i, dev_interface_path);
1419                         return LIBUSB_ERROR_ACCESS;
1420                 }
1421         }
1422
1423         priv->usb_interface[priv->hid->nb_interfaces].path = dev_interface_path;
1424         priv->usb_interface[priv->hid->nb_interfaces].apib = &usb_api_backend[USB_API_HID];
1425         usbi_dbg("interface[%u] = %s", priv->hid->nb_interfaces, dev_interface_path);
1426         priv->hid->nb_interfaces++;
1427         return LIBUSB_SUCCESS;
1428 }
1429
1430 /*
1431  * get_device_list: libusb backend device enumeration function
1432  */
1433 static int winusb_get_device_list(struct libusb_context *ctx, struct discovered_devs **_discdevs)
1434 {
1435         struct discovered_devs *discdevs;
1436         HDEVINFO *dev_info, dev_info_intf, dev_info_enum;
1437         SP_DEVINFO_DATA dev_info_data;
1438         DWORD _index = 0;
1439         GUID hid_guid;
1440         int r = LIBUSB_SUCCESS;
1441         int api, sub_api;
1442         unsigned int pass, i, j;
1443         char enumerator[16];
1444         char dev_id[MAX_PATH_LENGTH];
1445         struct libusb_device *dev, *parent_dev;
1446         struct winusb_device_priv *priv, *parent_priv;
1447         char *dev_interface_path = NULL;
1448         unsigned long session_id;
1449         DWORD size, port_nr, reg_type, install_state;
1450         HKEY key;
1451         char guid_string[MAX_GUID_STRING_LENGTH];
1452         GUID *if_guid;
1453         LONG s;
1454 #define HUB_PASS 0
1455 #define DEV_PASS 1
1456 #define HCD_PASS 2
1457 #define GEN_PASS 3
1458 #define HID_PASS 4
1459 #define EXT_PASS 5
1460         // Keep a list of guids that will be enumerated
1461 #define GUID_SIZE_STEP 8
1462         const GUID **guid_list, **new_guid_list;
1463         unsigned int guid_size = GUID_SIZE_STEP;
1464         unsigned int nb_guids;
1465         // Keep a list of PnP enumerator strings that are found
1466         const char *usb_enumerator[8] = { "USB" };
1467         unsigned int nb_usb_enumerators = 1;
1468         unsigned int usb_enum_index = 0;
1469         // Keep a list of newly allocated devs to unref
1470 #define UNREF_SIZE_STEP 16
1471         libusb_device **unref_list, **new_unref_list;
1472         unsigned int unref_size = UNREF_SIZE_STEP;
1473         unsigned int unref_cur = 0;
1474
1475         // PASS 1 : (re)enumerate HCDs (allows for HCD hotplug)
1476         // PASS 2 : (re)enumerate HUBS
1477         // PASS 3 : (re)enumerate generic USB devices (including driverless)
1478         //           and list additional USB device interface GUIDs to explore
1479         // PASS 4 : (re)enumerate master USB devices that have a device interface
1480         // PASS 5+: (re)enumerate device interfaced GUIDs (including HID) and
1481         //           set the device interfaces.
1482
1483         // Init the GUID table
1484         guid_list = malloc(guid_size * sizeof(void *));
1485         if (guid_list == NULL) {
1486                 usbi_err(ctx, "failed to alloc guid list");
1487                 return LIBUSB_ERROR_NO_MEM;
1488         }
1489
1490         guid_list[HUB_PASS] = &GUID_DEVINTERFACE_USB_HUB;
1491         guid_list[DEV_PASS] = &GUID_DEVINTERFACE_USB_DEVICE;
1492         guid_list[HCD_PASS] = &GUID_DEVINTERFACE_USB_HOST_CONTROLLER;
1493         guid_list[GEN_PASS] = NULL;
1494         if (HidD_GetHidGuid != NULL) {
1495                 HidD_GetHidGuid(&hid_guid);
1496                 guid_list[HID_PASS] = &hid_guid;
1497         } else {
1498                 guid_list[HID_PASS] = NULL;
1499         }
1500         nb_guids = EXT_PASS;
1501
1502         unref_list = malloc(unref_size * sizeof(void *));
1503         if (unref_list == NULL) {
1504                 usbi_err(ctx, "failed to alloc unref list");
1505                 free((void *)guid_list);
1506                 return LIBUSB_ERROR_NO_MEM;
1507         }
1508
1509         dev_info_intf = pSetupDiGetClassDevsA(NULL, NULL, NULL, DIGCF_ALLCLASSES | DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
1510         if (dev_info_intf == INVALID_HANDLE_VALUE) {
1511                 usbi_err(ctx, "failed to obtain device info list: %s", windows_error_str(0));
1512                 free(unref_list);
1513                 free((void *)guid_list);
1514                 return LIBUSB_ERROR_OTHER;
1515         }
1516
1517         for (pass = 0; ((pass < nb_guids) && (r == LIBUSB_SUCCESS)); pass++) {
1518 //#define ENUM_DEBUG
1519 #if defined(ENABLE_LOGGING) && defined(ENUM_DEBUG)
1520                 const char * const passname[] = {"HUB", "DEV", "HCD", "GEN", "HID", "EXT"};
1521                 usbi_dbg("#### PROCESSING %ss %s", passname[MIN(pass, EXT_PASS)], guid_to_string(guid_list[pass], guid_string));
1522 #endif
1523                 if ((pass == HID_PASS) && (guid_list[HID_PASS] == NULL))
1524                         continue;
1525
1526                 dev_info = (pass != GEN_PASS) ? &dev_info_intf : &dev_info_enum;
1527
1528                 for (i = 0; ; i++) {
1529                         // safe loop: free up any (unprotected) dynamic resource
1530                         // NB: this is always executed before breaking the loop
1531                         safe_free(dev_interface_path);
1532                         priv = parent_priv = NULL;
1533                         dev = parent_dev = NULL;
1534
1535                         // Safe loop: end of loop conditions
1536                         if (r != LIBUSB_SUCCESS)
1537                                 break;
1538
1539                         if ((pass == HCD_PASS) && (i == UINT8_MAX)) {
1540                                 usbi_warn(ctx, "program assertion failed - found more than %u buses, skipping the rest", UINT8_MAX);
1541                                 break;
1542                         }
1543
1544                         if (pass != GEN_PASS) {
1545                                 // Except for GEN, all passes deal with device interfaces
1546                                 r = get_interface_details(ctx, *dev_info, &dev_info_data, guid_list[pass], &_index, &dev_interface_path);
1547                                 if ((r != LIBUSB_SUCCESS) || (dev_interface_path == NULL)) {
1548                                         _index = 0;
1549                                         break;
1550                                 }
1551                         } else {
1552                                 // Workaround for a Nec/Renesas USB 3.0 driver bug where root hubs are
1553                                 // being listed under the "NUSB3" PnP Symbolic Name rather than "USB".
1554                                 // The Intel USB 3.0 driver behaves similar, but uses "IUSB3"
1555                                 // The Intel Alpine Ridge USB 3.1 driver uses "IARUSB3"
1556                                 for (; usb_enum_index < nb_usb_enumerators; usb_enum_index++) {
1557                                         if (get_devinfo_data(ctx, dev_info, &dev_info_data, usb_enumerator[usb_enum_index], i))
1558                                                 break;
1559                                         i = 0;
1560                                 }
1561                                 if (usb_enum_index == nb_usb_enumerators)
1562                                         break;
1563                         }
1564
1565                         // Read the Device ID path
1566                         if (!pSetupDiGetDeviceInstanceIdA(*dev_info, &dev_info_data, dev_id, sizeof(dev_id), NULL)) {
1567                                 usbi_warn(ctx, "could not read the device instance ID for devInst %lX, skipping",
1568                                           ULONG_CAST(dev_info_data.DevInst));
1569                                 continue;
1570                         }
1571
1572 #ifdef ENUM_DEBUG
1573                         usbi_dbg("PRO: %s", dev_id);
1574 #endif
1575
1576                         // Set API to use or get additional data from generic pass
1577                         api = USB_API_UNSUPPORTED;
1578                         sub_api = SUB_API_NOTSET;
1579                         switch (pass) {
1580                         case HCD_PASS:
1581                                 break;
1582                         case HUB_PASS:
1583                                 api = USB_API_HUB;
1584                                 // Fetch the PnP enumerator class for this hub
1585                                 // This will allow us to enumerate all classes during the GEN pass
1586                                 if (!pSetupDiGetDeviceRegistryPropertyA(*dev_info, &dev_info_data, SPDRP_ENUMERATOR_NAME,
1587                                         NULL, (PBYTE)enumerator, sizeof(enumerator), NULL)) {
1588                                         usbi_err(ctx, "could not read enumerator string for device '%s': %s", dev_id, windows_error_str(0));
1589                                         LOOP_BREAK(LIBUSB_ERROR_OTHER);
1590                                 }
1591                                 for (j = 0; j < nb_usb_enumerators; j++) {
1592                                         if (strcmp(usb_enumerator[j], enumerator) == 0)
1593                                                 break;
1594                                 }
1595                                 if (j == nb_usb_enumerators) {
1596                                         usbi_dbg("found new PnP enumerator string '%s'", enumerator);
1597                                         if (nb_usb_enumerators < ARRAYSIZE(usb_enumerator)) {
1598                                                 usb_enumerator[nb_usb_enumerators] = _strdup(enumerator);
1599                                                 if (usb_enumerator[nb_usb_enumerators] != NULL) {
1600                                                         nb_usb_enumerators++;
1601                                                 } else {
1602                                                         usbi_err(ctx, "could not allocate enumerator string '%s'", enumerator);
1603                                                         LOOP_BREAK(LIBUSB_ERROR_NO_MEM);
1604                                                 }
1605                                         } else {
1606                                                 usbi_warn(ctx, "too many enumerator strings, some devices may not be accessible");
1607                                         }
1608                                 }
1609                                 break;
1610                         case GEN_PASS:
1611                                 // We use the GEN pass to detect driverless devices...
1612                                 if (!pSetupDiGetDeviceRegistryPropertyA(*dev_info, &dev_info_data, SPDRP_DRIVER,
1613                                         NULL, NULL, 0, NULL) && (GetLastError() != ERROR_INSUFFICIENT_BUFFER)) {
1614                                         usbi_info(ctx, "The following device has no driver: '%s'", dev_id);
1615                                         usbi_info(ctx, "libusb will not be able to access it");
1616                                 }
1617                                 // ...and to add the additional device interface GUIDs
1618                                 key = pSetupDiOpenDevRegKey(*dev_info, &dev_info_data, DICS_FLAG_GLOBAL, 0, DIREG_DEV, KEY_READ);
1619                                 if (key == INVALID_HANDLE_VALUE)
1620                                         break;
1621                                 // Look for both DeviceInterfaceGUIDs *and* DeviceInterfaceGUID, in that order
1622                                 size = sizeof(guid_string);
1623                                 s = pRegQueryValueExA(key, "DeviceInterfaceGUIDs", NULL, &reg_type,
1624                                         (LPBYTE)guid_string, &size);
1625                                 if (s == ERROR_FILE_NOT_FOUND)
1626                                         s = pRegQueryValueExA(key, "DeviceInterfaceGUID", NULL, &reg_type,
1627                                                 (LPBYTE)guid_string, &size);
1628                                 pRegCloseKey(key);
1629                                 if (s == ERROR_FILE_NOT_FOUND) {
1630                                         break; /* no DeviceInterfaceGUID registered */
1631                                 } else if (s != ERROR_SUCCESS) {
1632                                         usbi_warn(ctx, "unexpected error from pRegQueryValueExA for '%s'", dev_id);
1633                                         break;
1634                                 }
1635                                 // https://docs.microsoft.com/en-us/windows/win32/api/winreg/nf-winreg-regqueryvalueexa#remarks
1636                                 // - "string may not have been stored with the proper terminating null characters"
1637                                 // - "Note that REG_MULTI_SZ strings could have two terminating null characters"
1638                                 if ((reg_type == REG_SZ && size >= sizeof(guid_string) - sizeof(char))
1639                                     || (reg_type == REG_MULTI_SZ && size >= sizeof(guid_string) - 2 * sizeof(char))) {
1640                                         if (nb_guids == guid_size) {
1641                                                 new_guid_list = realloc((void *)guid_list, (guid_size + GUID_SIZE_STEP) * sizeof(void *));
1642                                                 if (new_guid_list == NULL) {
1643                                                         usbi_err(ctx, "failed to realloc guid list");
1644                                                         LOOP_BREAK(LIBUSB_ERROR_NO_MEM);
1645                                                 }
1646                                                 guid_list = new_guid_list;
1647                                                 guid_size += GUID_SIZE_STEP;
1648                                         }
1649                                         if_guid = malloc(sizeof(*if_guid));
1650                                         if (if_guid == NULL) {
1651                                                 usbi_err(ctx, "failed to alloc if_guid");
1652                                                 LOOP_BREAK(LIBUSB_ERROR_NO_MEM);
1653                                         }
1654                                         if (!string_to_guid(guid_string, if_guid)) {
1655                                                 usbi_warn(ctx, "device '%s' has malformed DeviceInterfaceGUID string '%s', skipping", dev_id, guid_string);
1656                                                 free(if_guid);
1657                                         } else {
1658                                                 // Check if we've already seen this GUID
1659                                                 for (j = EXT_PASS; j < nb_guids; j++) {
1660                                                         if (memcmp(guid_list[j], if_guid, sizeof(*if_guid)) == 0)
1661                                                                 break;
1662                                                 }
1663                                                 if (j == nb_guids) {
1664                                                         usbi_dbg("extra GUID: %s", guid_string);
1665                                                         guid_list[nb_guids++] = if_guid;
1666                                                 } else {
1667                                                         // Duplicate, ignore
1668                                                         free(if_guid);
1669                                                 }
1670                                         }
1671                                 } else {
1672                                         usbi_warn(ctx, "unexpected type/size of DeviceInterfaceGUID for '%s'", dev_id);
1673                                 }
1674                                 break;
1675                         case HID_PASS:
1676                                 api = USB_API_HID;
1677                                 break;
1678                         default:
1679                                 // Get the API type (after checking that the driver installation is OK)
1680                                 if ((!pSetupDiGetDeviceRegistryPropertyA(*dev_info, &dev_info_data, SPDRP_INSTALL_STATE,
1681                                         NULL, (PBYTE)&install_state, sizeof(install_state), &size)) || (size != sizeof(install_state))) {
1682                                         usbi_warn(ctx, "could not detect installation state of driver for '%s': %s",
1683                                                 dev_id, windows_error_str(0));
1684                                 } else if (install_state != 0) {
1685                                         usbi_warn(ctx, "driver for device '%s' is reporting an issue (code: %lu) - skipping",
1686                                                 dev_id, ULONG_CAST(install_state));
1687                                         continue;
1688                                 }
1689                                 get_api_type(dev_info, &dev_info_data, &api, &sub_api);
1690                                 break;
1691                         }
1692
1693                         // Find parent device (for the passes that need it)
1694                         if (pass >= GEN_PASS) {
1695                                 parent_dev = get_ancestor(ctx, dev_info_data.DevInst, NULL);
1696                                 if (parent_dev == NULL) {
1697                                         // Root hubs will not have a parent
1698                                         dev = usbi_get_device_by_session_id(ctx, (unsigned long)dev_info_data.DevInst);
1699                                         if (dev != NULL) {
1700                                                 priv = usbi_get_device_priv(dev);
1701                                                 if (priv->root_hub)
1702                                                         goto track_unref;
1703                                                 libusb_unref_device(dev);
1704                                         }
1705
1706                                         usbi_dbg("unlisted ancestor for '%s' (non USB HID, newly connected, etc.) - ignoring", dev_id);
1707                                         continue;
1708                                 }
1709
1710                                 parent_priv = usbi_get_device_priv(parent_dev);
1711                                 // virtual USB devices are also listed during GEN - don't process these yet
1712                                 if ((pass == GEN_PASS) && (parent_priv->apib->id != USB_API_HUB)) {
1713                                         libusb_unref_device(parent_dev);
1714                                         continue;
1715                                 }
1716                         }
1717
1718                         // Create new or match existing device, using the devInst as session id
1719                         if ((pass <= GEN_PASS) && (pass != HCD_PASS)) { // For subsequent passes, we'll lookup the parent
1720                                 // These are the passes that create "new" devices
1721                                 session_id = (unsigned long)dev_info_data.DevInst;
1722                                 dev = usbi_get_device_by_session_id(ctx, session_id);
1723                                 if (dev == NULL) {
1724                                 alloc_device:
1725                                         usbi_dbg("allocating new device for session [%lX]", session_id);
1726                                         dev = usbi_alloc_device(ctx, session_id);
1727                                         if (dev == NULL)
1728                                                 LOOP_BREAK(LIBUSB_ERROR_NO_MEM);
1729
1730                                         priv = winusb_device_priv_init(dev);
1731                                         priv->dev_id = _strdup(dev_id);
1732                                         priv->class_guid = dev_info_data.ClassGuid;
1733                                         if (priv->dev_id == NULL) {
1734                                                 libusb_unref_device(dev);
1735                                                 LOOP_BREAK(LIBUSB_ERROR_NO_MEM);
1736                                         }
1737                                 } else {
1738                                         usbi_dbg("found existing device for session [%lX]", session_id);
1739
1740                                         priv = usbi_get_device_priv(dev);
1741                                         if (strcmp(priv->dev_id, dev_id) != 0) {
1742                                                 usbi_dbg("device instance ID for session [%lX] changed", session_id);
1743                                                 usbi_disconnect_device(dev);
1744                                                 libusb_unref_device(dev);
1745                                                 goto alloc_device;
1746                                         }
1747                                         if (!IsEqualGUID(&priv->class_guid, &dev_info_data.ClassGuid)) {
1748                                                 usbi_dbg("device class GUID for session [%lX] changed", session_id);
1749                                                 usbi_disconnect_device(dev);
1750                                                 libusb_unref_device(dev);
1751                                                 goto alloc_device;
1752                                         }
1753                                 }
1754
1755                         track_unref:
1756                                 // Keep track of devices that need unref
1757                                 if (unref_cur == unref_size) {
1758                                         new_unref_list = realloc(unref_list, (unref_size + UNREF_SIZE_STEP) * sizeof(void *));
1759                                         if (new_unref_list == NULL) {
1760                                                 usbi_err(ctx, "could not realloc list for unref - aborting");
1761                                                 LOOP_BREAK(LIBUSB_ERROR_NO_MEM);
1762                                         }
1763                                         unref_list = new_unref_list;
1764                                         unref_size += UNREF_SIZE_STEP;
1765                                 }
1766                                 unref_list[unref_cur++] = dev;
1767                         }
1768
1769                         // Setup device
1770                         switch (pass) {
1771                         case HUB_PASS:
1772                         case DEV_PASS:
1773                                 // If the device has already been setup, don't do it again
1774                                 if (priv->path != NULL)
1775                                         break;
1776                                 // Take care of API initialization
1777                                 priv->path = dev_interface_path;
1778                                 dev_interface_path = NULL;
1779                                 priv->apib = &usb_api_backend[api];
1780                                 priv->sub_api = sub_api;
1781                                 switch (api) {
1782                                 case USB_API_COMPOSITE:
1783                                 case USB_API_HUB:
1784                                         break;
1785                                 case USB_API_HID:
1786                                         priv->hid = calloc(1, sizeof(struct hid_device_priv));
1787                                         if (priv->hid == NULL)
1788                                                 LOOP_BREAK(LIBUSB_ERROR_NO_MEM);
1789                                         break;
1790                                 default:
1791                                         // For other devices, the first interface is the same as the device
1792                                         priv->usb_interface[0].path = _strdup(priv->path);
1793                                         if (priv->usb_interface[0].path == NULL)
1794                                                 LOOP_BREAK(LIBUSB_ERROR_NO_MEM);
1795                                         // The following is needed if we want API calls to work for both simple
1796                                         // and composite devices.
1797                                         for (j = 0; j < USB_MAXINTERFACES; j++)
1798                                                 priv->usb_interface[j].apib = &usb_api_backend[api];
1799                                         break;
1800                                 }
1801                                 break;
1802                         case HCD_PASS:
1803                                 r = enumerate_hcd_root_hub(ctx, dev_id, (uint8_t)(i + 1), dev_info_data.DevInst);
1804                                 break;
1805                         case GEN_PASS:
1806                                 port_nr = 0;
1807                                 if (!get_dev_port_number(*dev_info, &dev_info_data, &port_nr))
1808                                         usbi_warn(ctx, "could not retrieve port number for device '%s': %s", dev_id, windows_error_str(0));
1809                                 r = init_device(dev, parent_dev, (uint8_t)port_nr, dev_info_data.DevInst);
1810                                 if (r == LIBUSB_SUCCESS) {
1811                                         // Append device to the list of discovered devices
1812                                         discdevs = discovered_devs_append(*_discdevs, dev);
1813                                         if (!discdevs)
1814                                                 LOOP_BREAK(LIBUSB_ERROR_NO_MEM);
1815
1816                                         *_discdevs = discdevs;
1817                                 } else {
1818                                         // Failed to initialize a single device doesn't stop us from enumerating all other devices,
1819                                         // but we skip it (don't add to list of discovered devices)
1820                                         usbi_warn(ctx, "failed to initialize device '%s'", priv->dev_id);
1821                                         r = LIBUSB_SUCCESS;
1822                                 }
1823                                 break;
1824                         default: // HID_PASS and later
1825                                 if (parent_priv->apib->id == USB_API_HID || parent_priv->apib->id == USB_API_COMPOSITE) {
1826                                         if (parent_priv->apib->id == USB_API_HID) {
1827                                                 usbi_dbg("setting HID interface for [%lX]:", parent_dev->session_data);
1828                                                 r = set_hid_interface(ctx, parent_dev, dev_interface_path);
1829                                         } else {
1830                                                 usbi_dbg("setting composite interface for [%lX]:", parent_dev->session_data);
1831                                                 r = set_composite_interface(ctx, parent_dev, dev_interface_path, dev_id, api, sub_api);
1832                                         }
1833                                         switch (r) {
1834                                         case LIBUSB_SUCCESS:
1835                                                 dev_interface_path = NULL;
1836                                                 break;
1837                                         case LIBUSB_ERROR_ACCESS:
1838                                                 // interface has already been set => make sure dev_interface_path is freed then
1839                                                 r = LIBUSB_SUCCESS;
1840                                                 break;
1841                                         default:
1842                                                 LOOP_BREAK(r);
1843                                                 break;
1844                                         }
1845                                 }
1846                                 libusb_unref_device(parent_dev);
1847                                 break;
1848                         }
1849                 }
1850         }
1851
1852         pSetupDiDestroyDeviceInfoList(dev_info_intf);
1853
1854         // Free any additional GUIDs
1855         for (pass = EXT_PASS; pass < nb_guids; pass++)
1856                 free((void *)guid_list[pass]);
1857         free((void *)guid_list);
1858
1859         // Free any PnP enumerator strings
1860         for (i = 1; i < nb_usb_enumerators; i++)
1861                 free((void *)usb_enumerator[i]);
1862
1863         // Unref newly allocated devs
1864         for (i = 0; i < unref_cur; i++)
1865                 libusb_unref_device(unref_list[i]);
1866         free(unref_list);
1867
1868         return r;
1869 }
1870
1871 static int winusb_get_config_descriptor(struct libusb_device *dev, uint8_t config_index, void *buffer, size_t len)
1872 {
1873         struct winusb_device_priv *priv = usbi_get_device_priv(dev);
1874         PUSB_CONFIGURATION_DESCRIPTOR config_header;
1875
1876         if ((priv->config_descriptor == NULL) || (priv->config_descriptor[config_index] == NULL))
1877                 return LIBUSB_ERROR_NOT_FOUND;
1878
1879         config_header = priv->config_descriptor[config_index];
1880
1881         len = MIN(len, config_header->wTotalLength);
1882         memcpy(buffer, config_header, len);
1883         return (int)len;
1884 }
1885
1886 static int winusb_get_config_descriptor_by_value(struct libusb_device *dev, uint8_t bConfigurationValue,
1887         void **buffer)
1888 {
1889         struct winusb_device_priv *priv = usbi_get_device_priv(dev);
1890         PUSB_CONFIGURATION_DESCRIPTOR config_header;
1891         uint8_t index;
1892
1893         if (priv->config_descriptor == NULL)
1894                 return LIBUSB_ERROR_NOT_FOUND;
1895
1896         for (index = 0; index < dev->device_descriptor.bNumConfigurations; index++) {
1897                 config_header = priv->config_descriptor[index];
1898                 if (config_header == NULL)
1899                         continue;
1900                 if (config_header->bConfigurationValue == bConfigurationValue) {
1901                         *buffer = config_header;
1902                         return (int)config_header->wTotalLength;
1903                 }
1904         }
1905
1906         return LIBUSB_ERROR_NOT_FOUND;
1907 }
1908
1909 /*
1910  * return the cached copy of the active config descriptor
1911  */
1912 static int winusb_get_active_config_descriptor(struct libusb_device *dev, void *buffer, size_t len)
1913 {
1914         struct winusb_device_priv *priv = usbi_get_device_priv(dev);
1915         void *config_desc;
1916         int r;
1917
1918         if (priv->active_config == 0)
1919                 return LIBUSB_ERROR_NOT_FOUND;
1920
1921         r = winusb_get_config_descriptor_by_value(dev, priv->active_config, &config_desc);
1922         if (r < 0)
1923                 return r;
1924
1925         len = MIN(len, (size_t)r);
1926         memcpy(buffer, config_desc, len);
1927         return (int)len;
1928 }
1929
1930 static int winusb_open(struct libusb_device_handle *dev_handle)
1931 {
1932         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
1933
1934         CHECK_SUPPORTED_API(priv->apib, open);
1935
1936         return priv->apib->open(SUB_API_NOTSET, dev_handle);
1937 }
1938
1939 static void winusb_close(struct libusb_device_handle *dev_handle)
1940 {
1941         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
1942
1943         if (priv->apib->close)
1944                 priv->apib->close(SUB_API_NOTSET, dev_handle);
1945 }
1946
1947 static int winusb_get_configuration(struct libusb_device_handle *dev_handle, uint8_t *config)
1948 {
1949         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
1950
1951         *config = priv->active_config;
1952         return LIBUSB_SUCCESS;
1953 }
1954
1955 /*
1956  * from http://msdn.microsoft.com/en-us/library/ms793522.aspx: "The port driver
1957  * does not currently expose a service that allows higher-level drivers to set
1958  * the configuration."
1959  */
1960 static int winusb_set_configuration(struct libusb_device_handle *dev_handle, uint8_t config)
1961 {
1962         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
1963         int r = LIBUSB_SUCCESS;
1964
1965         r = libusb_control_transfer(dev_handle, LIBUSB_ENDPOINT_OUT |
1966                 LIBUSB_REQUEST_TYPE_STANDARD | LIBUSB_RECIPIENT_DEVICE,
1967                 LIBUSB_REQUEST_SET_CONFIGURATION, config,
1968                 0, NULL, 0, 1000);
1969
1970         if (r == LIBUSB_SUCCESS)
1971                 priv->active_config = config;
1972
1973         return r;
1974 }
1975
1976 static int winusb_claim_interface(struct libusb_device_handle *dev_handle, uint8_t iface)
1977 {
1978         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
1979         int r;
1980
1981         CHECK_SUPPORTED_API(priv->apib, claim_interface);
1982
1983         safe_free(priv->usb_interface[iface].endpoint);
1984         priv->usb_interface[iface].nb_endpoints = 0;
1985
1986         r = priv->apib->claim_interface(SUB_API_NOTSET, dev_handle, iface);
1987
1988         if (r == LIBUSB_SUCCESS)
1989                 r = windows_assign_endpoints(dev_handle, iface, 0);
1990
1991         return r;
1992 }
1993
1994 static int winusb_set_interface_altsetting(struct libusb_device_handle *dev_handle, uint8_t iface, uint8_t altsetting)
1995 {
1996         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
1997         int r;
1998
1999         CHECK_SUPPORTED_API(priv->apib, set_interface_altsetting);
2000
2001         safe_free(priv->usb_interface[iface].endpoint);
2002         priv->usb_interface[iface].nb_endpoints = 0;
2003
2004         r = priv->apib->set_interface_altsetting(SUB_API_NOTSET, dev_handle, iface, altsetting);
2005
2006         if (r == LIBUSB_SUCCESS)
2007                 r = windows_assign_endpoints(dev_handle, iface, altsetting);
2008
2009         return r;
2010 }
2011
2012 static int winusb_release_interface(struct libusb_device_handle *dev_handle, uint8_t iface)
2013 {
2014         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2015
2016         CHECK_SUPPORTED_API(priv->apib, release_interface);
2017
2018         return priv->apib->release_interface(SUB_API_NOTSET, dev_handle, iface);
2019 }
2020
2021 static int winusb_clear_halt(struct libusb_device_handle *dev_handle, unsigned char endpoint)
2022 {
2023         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2024
2025         CHECK_SUPPORTED_API(priv->apib, clear_halt);
2026
2027         return priv->apib->clear_halt(SUB_API_NOTSET, dev_handle, endpoint);
2028 }
2029
2030 static int winusb_reset_device(struct libusb_device_handle *dev_handle)
2031 {
2032         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2033
2034         CHECK_SUPPORTED_API(priv->apib, reset_device);
2035
2036         return priv->apib->reset_device(SUB_API_NOTSET, dev_handle);
2037 }
2038
2039 static void winusb_destroy_device(struct libusb_device *dev)
2040 {
2041         winusb_device_priv_release(dev);
2042 }
2043
2044 static void winusb_clear_transfer_priv(struct usbi_transfer *itransfer)
2045 {
2046         struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
2047         struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2048         struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
2049         int sub_api = priv->sub_api;
2050
2051         safe_free(transfer_priv->hid_buffer);
2052
2053         if (transfer->type == LIBUSB_TRANSFER_TYPE_ISOCHRONOUS && sub_api == SUB_API_WINUSB) {
2054                 if (transfer_priv->isoch_buffer_handle != NULL) {
2055                         if (WinUSBX[sub_api].UnregisterIsochBuffer(transfer_priv->isoch_buffer_handle)) {
2056                                 transfer_priv->isoch_buffer_handle = NULL;
2057                         } else {
2058                                 usbi_warn(TRANSFER_CTX(transfer), "failed to unregister WinUSB isoch buffer: %s", windows_error_str(0));
2059                         }
2060                 }
2061         }
2062
2063         safe_free(transfer_priv->iso_context);
2064
2065         // When auto claim is in use, attempt to release the auto-claimed interface
2066         auto_release(itransfer);
2067 }
2068
2069 static int winusb_submit_transfer(struct usbi_transfer *itransfer)
2070 {
2071         struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2072         struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
2073         int (*transfer_fn)(int, struct usbi_transfer *);
2074
2075         switch (transfer->type) {
2076         case LIBUSB_TRANSFER_TYPE_CONTROL:
2077                 transfer_fn = priv->apib->submit_control_transfer;
2078                 break;
2079         case LIBUSB_TRANSFER_TYPE_BULK:
2080         case LIBUSB_TRANSFER_TYPE_INTERRUPT:
2081                 transfer_fn = priv->apib->submit_bulk_transfer;
2082                 break;
2083         case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
2084                 transfer_fn = priv->apib->submit_iso_transfer;
2085                 break;
2086         default:
2087                 // Should not get here since windows_submit_transfer() validates
2088                 // the transfer->type field
2089                 usbi_err(TRANSFER_CTX(transfer), "unknown endpoint type %d", transfer->type);
2090                 return LIBUSB_ERROR_INVALID_PARAM;
2091         }
2092
2093         if (transfer_fn == NULL) {
2094                 usbi_warn(TRANSFER_CTX(transfer),
2095                         "unsupported transfer type %d (unrecognized device driver)",
2096                         transfer->type);
2097                 return LIBUSB_ERROR_NOT_SUPPORTED;
2098         }
2099
2100         return transfer_fn(SUB_API_NOTSET, itransfer);
2101 }
2102
2103 static int winusb_cancel_transfer(struct usbi_transfer *itransfer)
2104 {
2105         struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2106         struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
2107
2108         CHECK_SUPPORTED_API(priv->apib, cancel_transfer);
2109
2110         return priv->apib->cancel_transfer(SUB_API_NOTSET, itransfer);
2111 }
2112
2113 static enum libusb_transfer_status winusb_copy_transfer_data(struct usbi_transfer *itransfer, DWORD length)
2114 {
2115         struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2116         struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
2117
2118         if (priv->apib->copy_transfer_data == NULL) {
2119                 usbi_err(TRANSFER_CTX(transfer), "program assertion failed - no function to copy transfer data");
2120                 return LIBUSB_TRANSFER_ERROR;
2121         }
2122
2123         return priv->apib->copy_transfer_data(SUB_API_NOTSET, itransfer, length);
2124 }
2125
2126 // NB: MSVC6 does not support named initializers.
2127 const struct windows_backend winusb_backend = {
2128         winusb_init,
2129         winusb_exit,
2130         winusb_get_device_list,
2131         winusb_open,
2132         winusb_close,
2133         winusb_get_active_config_descriptor,
2134         winusb_get_config_descriptor,
2135         winusb_get_config_descriptor_by_value,
2136         winusb_get_configuration,
2137         winusb_set_configuration,
2138         winusb_claim_interface,
2139         winusb_release_interface,
2140         winusb_set_interface_altsetting,
2141         winusb_clear_halt,
2142         winusb_reset_device,
2143         winusb_destroy_device,
2144         winusb_submit_transfer,
2145         winusb_cancel_transfer,
2146         winusb_clear_transfer_priv,
2147         winusb_copy_transfer_data,
2148 };
2149
2150 /*
2151  * USB API backends
2152  */
2153
2154 static const char * const composite_driver_names[] = {"USBCCGP"};
2155 static const char * const winusbx_driver_names[] = {"libusbK", "libusb0", "WinUSB"};
2156 static const char * const hid_driver_names[] = {"HIDUSB", "MOUHID", "KBDHID"};
2157 const struct windows_usb_api_backend usb_api_backend[USB_API_MAX] = {
2158         {
2159                 USB_API_UNSUPPORTED,
2160                 "Unsupported API",
2161                 NULL,   /* driver_name_list */
2162                 0,      /* nb_driver_names */
2163                 NULL,   /* init */
2164                 NULL,   /* exit */
2165                 NULL,   /* open */
2166                 NULL,   /* close */
2167                 NULL,   /* configure_endpoints */
2168                 NULL,   /* claim_interface */
2169                 NULL,   /* set_interface_altsetting */
2170                 NULL,   /* release_interface */
2171                 NULL,   /* clear_halt */
2172                 NULL,   /* reset_device */
2173                 NULL,   /* submit_bulk_transfer */
2174                 NULL,   /* submit_iso_transfer */
2175                 NULL,   /* submit_control_transfer */
2176                 NULL,   /* cancel_transfer */
2177                 NULL,   /* copy_transfer_data */
2178         },
2179         {
2180                 USB_API_HUB,
2181                 "HUB API",
2182                 NULL,   /* driver_name_list */
2183                 0,      /* nb_driver_names */
2184                 NULL,   /* init */
2185                 NULL,   /* exit */
2186                 NULL,   /* open */
2187                 NULL,   /* close */
2188                 NULL,   /* configure_endpoints */
2189                 NULL,   /* claim_interface */
2190                 NULL,   /* set_interface_altsetting */
2191                 NULL,   /* release_interface */
2192                 NULL,   /* clear_halt */
2193                 NULL,   /* reset_device */
2194                 NULL,   /* submit_bulk_transfer */
2195                 NULL,   /* submit_iso_transfer */
2196                 NULL,   /* submit_control_transfer */
2197                 NULL,   /* cancel_transfer */
2198                 NULL,   /* copy_transfer_data */
2199         },
2200         {
2201                 USB_API_COMPOSITE,
2202                 "Composite API",
2203                 composite_driver_names,
2204                 ARRAYSIZE(composite_driver_names),
2205                 NULL,   /* init */
2206                 NULL,   /* exit */
2207                 composite_open,
2208                 composite_close,
2209                 NULL,   /* configure_endpoints */
2210                 composite_claim_interface,
2211                 composite_set_interface_altsetting,
2212                 composite_release_interface,
2213                 composite_clear_halt,
2214                 composite_reset_device,
2215                 composite_submit_bulk_transfer,
2216                 composite_submit_iso_transfer,
2217                 composite_submit_control_transfer,
2218                 composite_cancel_transfer,
2219                 composite_copy_transfer_data,
2220         },
2221         {
2222                 USB_API_WINUSBX,
2223                 "WinUSB-like APIs",
2224                 winusbx_driver_names,
2225                 ARRAYSIZE(winusbx_driver_names),
2226                 winusbx_init,
2227                 winusbx_exit,
2228                 winusbx_open,
2229                 winusbx_close,
2230                 winusbx_configure_endpoints,
2231                 winusbx_claim_interface,
2232                 winusbx_set_interface_altsetting,
2233                 winusbx_release_interface,
2234                 winusbx_clear_halt,
2235                 winusbx_reset_device,
2236                 winusbx_submit_bulk_transfer,
2237                 winusbx_submit_iso_transfer,
2238                 winusbx_submit_control_transfer,
2239                 winusbx_cancel_transfer,
2240                 winusbx_copy_transfer_data,
2241         },
2242         {
2243                 USB_API_HID,
2244                 "HID API",
2245                 hid_driver_names,
2246                 ARRAYSIZE(hid_driver_names),
2247                 hid_init,
2248                 hid_exit,
2249                 hid_open,
2250                 hid_close,
2251                 NULL,   /* configure_endpoints */
2252                 hid_claim_interface,
2253                 hid_set_interface_altsetting,
2254                 hid_release_interface,
2255                 hid_clear_halt,
2256                 hid_reset_device,
2257                 hid_submit_bulk_transfer,
2258                 NULL,   /* submit_iso_transfer */
2259                 hid_submit_control_transfer,
2260                 NULL,   /* cancel_transfer */
2261                 hid_copy_transfer_data,
2262         },
2263 };
2264
2265
2266 /*
2267  * WinUSB-like (WinUSB, libusb0/libusbK through libusbk DLL) API functions
2268  */
2269 #define WinUSB_Set(h, fn, required)                                                                             \
2270         do {                                                                                    \
2271                 WinUSBX[SUB_API_WINUSB].fn = (WinUsb_##fn##_t)GetProcAddress(h, "WinUsb_" #fn); \
2272                 if (required && (WinUSBX[SUB_API_WINUSB].fn == NULL)) {                         \
2273                         usbi_err(ctx, "GetProcAddress() failed for WinUsb_%s", #fn);            \
2274                         goto cleanup_winusb;                                                    \
2275                 }                                                                               \
2276         } while (0)
2277
2278 #define libusbK_Set(sub_api, fn, required)                                                              \
2279         do {                                                                                    \
2280                 pLibK_GetProcAddress((PVOID *)&WinUSBX[sub_api].fn, sub_api, KUSB_FNID_##fn);   \
2281                 if (required && (WinUSBX[sub_api].fn == NULL)) {                                \
2282                         usbi_err(ctx, "LibK_GetProcAddress() failed for LibK_%s", #fn);         \
2283                         goto cleanup_libusbk;                                                   \
2284                 }                                                                               \
2285         } while (0)
2286
2287 static bool winusbx_init(struct libusb_context *ctx)
2288 {
2289         HMODULE hWinUSB, hlibusbK;
2290
2291         hWinUSB = load_system_library(ctx, "WinUSB");
2292         if (hWinUSB != NULL) {
2293                 WinUSB_Set(hWinUSB, AbortPipe, true);
2294                 WinUSB_Set(hWinUSB, ControlTransfer, true);
2295                 WinUSB_Set(hWinUSB, FlushPipe, true);
2296                 WinUSB_Set(hWinUSB, Free, true);
2297                 WinUSB_Set(hWinUSB, GetAssociatedInterface, true);
2298                 WinUSB_Set(hWinUSB, Initialize, true);
2299                 WinUSB_Set(hWinUSB, ReadPipe, true);
2300                 WinUSB_Set(hWinUSB, ResetPipe, true);
2301                 WinUSB_Set(hWinUSB, SetCurrentAlternateSetting, true);
2302                 WinUSB_Set(hWinUSB, SetPipePolicy, true);
2303                 WinUSB_Set(hWinUSB, WritePipe, true);
2304
2305                 // Check for isochronous transfers support (available starting with Windows 8.1)
2306                 WinUSB_Set(hWinUSB, ReadIsochPipeAsap, false);
2307                 if (WinUSBX[SUB_API_WINUSB].ReadIsochPipeAsap != NULL) {
2308                         WinUSB_Set(hWinUSB, QueryPipeEx, true);
2309                         WinUSB_Set(hWinUSB, RegisterIsochBuffer, true);
2310                         WinUSB_Set(hWinUSB, UnregisterIsochBuffer, true);
2311                         WinUSB_Set(hWinUSB, WriteIsochPipeAsap, true);
2312                 }
2313
2314                 WinUSBX[SUB_API_WINUSB].hDll = hWinUSB;
2315
2316                 usbi_info(ctx, "WinUSB DLL available (%s isoch support)",
2317                         (WinUSBX[SUB_API_WINUSB].ReadIsochPipeAsap != NULL) ? "with" : "without");
2318
2319 cleanup_winusb:
2320                 if (WinUSBX[SUB_API_WINUSB].hDll == NULL) {
2321                         usbi_err(ctx, "failed to initialize WinUSB");
2322                         memset(&WinUSBX[SUB_API_WINUSB], 0, sizeof(WinUSBX[SUB_API_WINUSB]));
2323                         FreeLibrary(hWinUSB);
2324                         hWinUSB = NULL;
2325                 }
2326         } else {
2327                 usbi_info(ctx, "WinUSB DLL is not available");
2328         }
2329
2330         hlibusbK = load_system_library(ctx, "libusbK");
2331         if (hlibusbK != NULL) {
2332                 LibK_GetVersion_t pLibK_GetVersion;
2333                 LibK_GetProcAddress_t pLibK_GetProcAddress;
2334                 int sub_api = 0;
2335
2336                 pLibK_GetVersion = (LibK_GetVersion_t)GetProcAddress(hlibusbK, "LibK_GetVersion");
2337                 if (pLibK_GetVersion != NULL) {
2338                         KLIB_VERSION LibK_Version;
2339
2340                         pLibK_GetVersion(&LibK_Version);
2341                         usbi_dbg("libusbK DLL found, version: %d.%d.%d.%d", LibK_Version.Major, LibK_Version.Minor,
2342                                 LibK_Version.Micro, LibK_Version.Nano);
2343                 } else {
2344                         usbi_dbg("libusbK DLL found, version unknown");
2345                 }
2346
2347                 pLibK_GetProcAddress = (LibK_GetProcAddress_t)GetProcAddress(hlibusbK, "LibK_GetProcAddress");
2348                 if (pLibK_GetProcAddress == NULL) {
2349                         usbi_err(ctx, "LibK_GetProcAddress() not found in libusbK DLL");
2350                         goto cleanup_libusbk;
2351                 }
2352
2353                 // NB: The below for loop works because the sub_api value for WinUSB
2354                 // is a higher value than that of libusbK and libusb0
2355                 for (; sub_api < SUB_API_WINUSB; sub_api++) {
2356                         libusbK_Set(sub_api, AbortPipe, true);
2357                         libusbK_Set(sub_api, ControlTransfer, true);
2358                         libusbK_Set(sub_api, FlushPipe, true);
2359                         libusbK_Set(sub_api, Free, true);
2360                         libusbK_Set(sub_api, GetAssociatedInterface, true);
2361                         libusbK_Set(sub_api, Initialize, true);
2362                         libusbK_Set(sub_api, ReadPipe, true);
2363                         libusbK_Set(sub_api, ResetPipe, true);
2364                         libusbK_Set(sub_api, SetCurrentAlternateSetting, true);
2365                         libusbK_Set(sub_api, SetPipePolicy, true);
2366                         libusbK_Set(sub_api, WritePipe, true);
2367
2368                         // Optional isochronous support
2369                         libusbK_Set(sub_api, IsoReadPipe, false);
2370                         if (WinUSBX[sub_api].IsoReadPipe != NULL)
2371                                 libusbK_Set(sub_api, IsoWritePipe, true);
2372
2373                         // Optional device reset support
2374                         libusbK_Set(sub_api, ResetDevice, false);
2375
2376                         WinUSBX[sub_api].hDll = hlibusbK;
2377                 }
2378
2379 cleanup_libusbk:
2380                 if (sub_api < SUB_API_WINUSB) {
2381                         usbi_err(ctx, "failed to initialize libusbK");
2382                         while (sub_api >= 0) {
2383                                 memset(&WinUSBX[sub_api], 0, sizeof(WinUSBX[sub_api]));
2384                                 sub_api--;
2385                         }
2386                         FreeLibrary(hlibusbK);
2387                         hlibusbK = NULL;
2388                 }
2389         } else {
2390                 usbi_info(ctx, "libusbK DLL is not available");
2391         }
2392
2393         if ((hWinUSB == NULL) && (hlibusbK == NULL)) {
2394                 usbi_warn(ctx, "neither WinUSB nor libusbK DLLs were found, "
2395                         "you will not be able to access devices outside of enumeration");
2396                 return false;
2397         }
2398
2399         return true;
2400 }
2401
2402 static void winusbx_exit(void)
2403 {
2404         bool loaded = false;
2405         HMODULE hDll;
2406
2407         hDll = WinUSBX[SUB_API_LIBUSBK].hDll;
2408         if (hDll != NULL) {
2409                 FreeLibrary(hDll);
2410                 loaded = true;
2411         }
2412
2413         hDll = WinUSBX[SUB_API_WINUSB].hDll;
2414         if (hDll != NULL) {
2415                 FreeLibrary(hDll);
2416                 loaded = true;
2417         }
2418
2419         // Reset the WinUSBX API structures if something was loaded
2420         if (loaded)
2421                 memset(&WinUSBX, 0, sizeof(WinUSBX));
2422 }
2423
2424 // NB: open and close must ensure that they only handle interface of
2425 // the right API type, as these functions can be called wholesale from
2426 // composite_open(), with interfaces belonging to different APIs
2427 static int winusbx_open(int sub_api, struct libusb_device_handle *dev_handle)
2428 {
2429         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2430         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
2431         HANDLE file_handle;
2432         int i;
2433
2434         CHECK_WINUSBX_AVAILABLE(sub_api);
2435
2436         // WinUSB requires a separate handle for each interface
2437         for (i = 0; i < USB_MAXINTERFACES; i++) {
2438                 if ((priv->usb_interface[i].path != NULL)
2439                                 && (priv->usb_interface[i].apib->id == USB_API_WINUSBX)) {
2440                         file_handle = windows_open(dev_handle, priv->usb_interface[i].path, GENERIC_READ | GENERIC_WRITE);
2441                         if (file_handle == INVALID_HANDLE_VALUE) {
2442                                 usbi_err(HANDLE_CTX(dev_handle), "could not open device %s (interface %d): %s", priv->usb_interface[i].path, i, windows_error_str(0));
2443                                 switch (GetLastError()) {
2444                                 case ERROR_FILE_NOT_FOUND: // The device was disconnected
2445                                         return LIBUSB_ERROR_NO_DEVICE;
2446                                 case ERROR_ACCESS_DENIED:
2447                                         return LIBUSB_ERROR_ACCESS;
2448                                 default:
2449                                         return LIBUSB_ERROR_IO;
2450                                 }
2451                         }
2452
2453                         handle_priv->interface_handle[i].dev_handle = file_handle;
2454                 }
2455         }
2456
2457         return LIBUSB_SUCCESS;
2458 }
2459
2460 static void winusbx_close(int sub_api, struct libusb_device_handle *dev_handle)
2461 {
2462         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
2463         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2464         HANDLE handle;
2465         int i;
2466
2467         if (sub_api == SUB_API_NOTSET)
2468                 sub_api = priv->sub_api;
2469
2470         if (WinUSBX[sub_api].hDll == NULL)
2471                 return;
2472
2473         if (priv->apib->id == USB_API_COMPOSITE) {
2474                 // If this is a composite device, just free and close all WinUSB-like
2475                 // interfaces directly (each is independent and not associated with another)
2476                 for (i = 0; i < USB_MAXINTERFACES; i++) {
2477                         if (priv->usb_interface[i].apib->id == USB_API_WINUSBX) {
2478                                 handle = handle_priv->interface_handle[i].api_handle;
2479                                 if (HANDLE_VALID(handle))
2480                                         WinUSBX[sub_api].Free(handle);
2481
2482                                 handle = handle_priv->interface_handle[i].dev_handle;
2483                                 if (HANDLE_VALID(handle))
2484                                         CloseHandle(handle);
2485                         }
2486                 }
2487         } else {
2488                 // If this is a WinUSB device, free all interfaces above interface 0,
2489                 // then free and close interface 0 last
2490                 for (i = 1; i < USB_MAXINTERFACES; i++) {
2491                         handle = handle_priv->interface_handle[i].api_handle;
2492                         if (HANDLE_VALID(handle))
2493                                 WinUSBX[sub_api].Free(handle);
2494                 }
2495                 handle = handle_priv->interface_handle[0].api_handle;
2496                 if (HANDLE_VALID(handle))
2497                         WinUSBX[sub_api].Free(handle);
2498
2499                 handle = handle_priv->interface_handle[0].dev_handle;
2500                 if (HANDLE_VALID(handle))
2501                         CloseHandle(handle);
2502         }
2503 }
2504
2505 static int winusbx_configure_endpoints(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface)
2506 {
2507         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
2508         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2509         HANDLE winusb_handle = handle_priv->interface_handle[iface].api_handle;
2510         UCHAR policy;
2511         ULONG timeout = 0;
2512         uint8_t endpoint_address;
2513         int i;
2514
2515         CHECK_WINUSBX_AVAILABLE(sub_api);
2516
2517         // With handle and endpoints set (in parent), we can setup the default pipe properties
2518         // see http://download.microsoft.com/download/D/1/D/D1DD7745-426B-4CC3-A269-ABBBE427C0EF/DVC-T705_DDC08.pptx
2519         for (i = -1; i < priv->usb_interface[iface].nb_endpoints; i++) {
2520                 endpoint_address = (i == -1) ? 0 : priv->usb_interface[iface].endpoint[i];
2521                 if (!WinUSBX[sub_api].SetPipePolicy(winusb_handle, endpoint_address,
2522                         PIPE_TRANSFER_TIMEOUT, sizeof(ULONG), &timeout))
2523                         usbi_dbg("failed to set PIPE_TRANSFER_TIMEOUT for control endpoint %02X", endpoint_address);
2524
2525                 if ((i == -1) || (sub_api == SUB_API_LIBUSB0))
2526                         continue; // Other policies don't apply to control endpoint or libusb0
2527
2528                 policy = false;
2529                 handle_priv->interface_handle[iface].zlp[endpoint_address] = WINUSB_ZLP_UNSET;
2530                 if (!WinUSBX[sub_api].SetPipePolicy(winusb_handle, endpoint_address,
2531                         SHORT_PACKET_TERMINATE, sizeof(UCHAR), &policy))
2532                         usbi_dbg("failed to disable SHORT_PACKET_TERMINATE for endpoint %02X", endpoint_address);
2533
2534                 if (!WinUSBX[sub_api].SetPipePolicy(winusb_handle, endpoint_address,
2535                         IGNORE_SHORT_PACKETS, sizeof(UCHAR), &policy))
2536                         usbi_dbg("failed to disable IGNORE_SHORT_PACKETS for endpoint %02X", endpoint_address);
2537
2538                 policy = true;
2539                 /* ALLOW_PARTIAL_READS must be enabled due to likely libusbK bug. See:
2540                    https://sourceforge.net/mailarchive/message.php?msg_id=29736015 */
2541                 if (!WinUSBX[sub_api].SetPipePolicy(winusb_handle, endpoint_address,
2542                         ALLOW_PARTIAL_READS, sizeof(UCHAR), &policy))
2543                         usbi_dbg("failed to enable ALLOW_PARTIAL_READS for endpoint %02X", endpoint_address);
2544
2545                 if (!WinUSBX[sub_api].SetPipePolicy(winusb_handle, endpoint_address,
2546                         AUTO_CLEAR_STALL, sizeof(UCHAR), &policy))
2547                         usbi_dbg("failed to enable AUTO_CLEAR_STALL for endpoint %02X", endpoint_address);
2548
2549                 if (sub_api == SUB_API_LIBUSBK) {
2550                         if (!WinUSBX[sub_api].SetPipePolicy(winusb_handle, endpoint_address,
2551                                 ISO_ALWAYS_START_ASAP, sizeof(UCHAR), &policy))
2552                                 usbi_dbg("failed to enable ISO_ALWAYS_START_ASAP for endpoint %02X", endpoint_address);
2553                 }
2554         }
2555
2556         return LIBUSB_SUCCESS;
2557 }
2558
2559 static int winusbx_claim_interface(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface)
2560 {
2561         struct libusb_context *ctx = HANDLE_CTX(dev_handle);
2562         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
2563         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2564         bool is_using_usbccgp = (priv->apib->id == USB_API_COMPOSITE);
2565         HDEVINFO dev_info;
2566         char *dev_interface_path = NULL;
2567         char *dev_interface_path_guid_start;
2568         char filter_path[] = "\\\\.\\libusb0-0000";
2569         bool found_filter = false;
2570         HANDLE file_handle, winusb_handle;
2571         DWORD err, _index;
2572         int r;
2573
2574         CHECK_WINUSBX_AVAILABLE(sub_api);
2575
2576         // If the device is composite, but using the default Windows composite parent driver (usbccgp)
2577         // or if it's the first WinUSB-like interface, we get a handle through Initialize().
2578         if ((is_using_usbccgp) || (iface == 0)) {
2579                 // composite device (independent interfaces) or interface 0
2580                 file_handle = handle_priv->interface_handle[iface].dev_handle;
2581                 if (!HANDLE_VALID(file_handle))
2582                         return LIBUSB_ERROR_NOT_FOUND;
2583
2584                 if (!WinUSBX[sub_api].Initialize(file_handle, &winusb_handle)) {
2585                         handle_priv->interface_handle[iface].api_handle = INVALID_HANDLE_VALUE;
2586                         err = GetLastError();
2587                         switch (err) {
2588                         case ERROR_BAD_COMMAND:
2589                                 // The device was disconnected
2590                                 usbi_err(ctx, "could not access interface %u: %s", iface, windows_error_str(0));
2591                                 return LIBUSB_ERROR_NO_DEVICE;
2592                         default:
2593                                 // it may be that we're using the libusb0 filter driver.
2594                                 // TODO: can we move this whole business into the K/0 DLL?
2595                                 r = LIBUSB_SUCCESS;
2596                                 for (_index = 0; ; _index++) {
2597                                         safe_free(dev_interface_path);
2598
2599                                         if (found_filter)
2600                                                 break;
2601
2602                                         r = get_interface_details_filter(ctx, &dev_info, _index, filter_path, &dev_interface_path);
2603                                         if ((r != LIBUSB_SUCCESS) || (dev_interface_path == NULL))
2604                                                 break;
2605
2606                                         // ignore GUID part
2607                                         dev_interface_path_guid_start = strchr(dev_interface_path, '{');
2608                                         if (dev_interface_path_guid_start == NULL)
2609                                                 continue;
2610                                         *dev_interface_path_guid_start = '\0';
2611
2612                                         if (strncmp(dev_interface_path, priv->usb_interface[iface].path, strlen(dev_interface_path)) == 0) {
2613                                                 file_handle = windows_open(dev_handle, filter_path, GENERIC_READ | GENERIC_WRITE);
2614                                                 if (file_handle != INVALID_HANDLE_VALUE) {
2615                                                         if (WinUSBX[sub_api].Initialize(file_handle, &winusb_handle)) {
2616                                                                 // Replace the existing file handle with the working one
2617                                                                 CloseHandle(handle_priv->interface_handle[iface].dev_handle);
2618                                                                 handle_priv->interface_handle[iface].dev_handle = file_handle;
2619                                                                 found_filter = true;
2620                                                         } else {
2621                                                                 usbi_err(ctx, "could not initialize filter driver for %s", filter_path);
2622                                                                 CloseHandle(file_handle);
2623                                                         }
2624                                                 } else {
2625                                                         usbi_err(ctx, "could not open device %s: %s", filter_path, windows_error_str(0));
2626                                                 }
2627                                         }
2628                                 }
2629                                 if (r != LIBUSB_SUCCESS)
2630                                         return r;
2631                                 if (!found_filter) {
2632                                         usbi_err(ctx, "could not access interface %u: %s", iface, windows_error_str(err));
2633                                         return LIBUSB_ERROR_ACCESS;
2634                                 }
2635                         }
2636                 }
2637                 handle_priv->interface_handle[iface].api_handle = winusb_handle;
2638         } else {
2639                 // For all other interfaces, use GetAssociatedInterface()
2640                 winusb_handle = handle_priv->interface_handle[0].api_handle;
2641                 // It is a requirement for multiple interface devices on Windows that, to you
2642                 // must first claim the first interface before you claim the others
2643                 if (!HANDLE_VALID(winusb_handle)) {
2644                         file_handle = handle_priv->interface_handle[0].dev_handle;
2645                         if (WinUSBX[sub_api].Initialize(file_handle, &winusb_handle)) {
2646                                 handle_priv->interface_handle[0].api_handle = winusb_handle;
2647                                 usbi_warn(ctx, "auto-claimed interface 0 (required to claim %u with WinUSB)", iface);
2648                         } else {
2649                                 usbi_warn(ctx, "failed to auto-claim interface 0 (required to claim %u with WinUSB): %s", iface, windows_error_str(0));
2650                                 return LIBUSB_ERROR_ACCESS;
2651                         }
2652                 }
2653                 if (!WinUSBX[sub_api].GetAssociatedInterface(winusb_handle, (UCHAR)(iface - 1),
2654                         &handle_priv->interface_handle[iface].api_handle)) {
2655                         handle_priv->interface_handle[iface].api_handle = INVALID_HANDLE_VALUE;
2656                         switch (GetLastError()) {
2657                         case ERROR_NO_MORE_ITEMS:   // invalid iface
2658                                 return LIBUSB_ERROR_NOT_FOUND;
2659                         case ERROR_BAD_COMMAND:     // The device was disconnected
2660                                 return LIBUSB_ERROR_NO_DEVICE;
2661                         case ERROR_ALREADY_EXISTS:  // already claimed
2662                                 return LIBUSB_ERROR_BUSY;
2663                         default:
2664                                 usbi_err(ctx, "could not claim interface %u: %s", iface, windows_error_str(0));
2665                                 return LIBUSB_ERROR_ACCESS;
2666                         }
2667                 }
2668                 handle_priv->interface_handle[iface].dev_handle = handle_priv->interface_handle[0].dev_handle;
2669         }
2670         usbi_dbg("claimed interface %u", iface);
2671         handle_priv->active_interface = iface;
2672
2673         return LIBUSB_SUCCESS;
2674 }
2675
2676 static int winusbx_release_interface(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface)
2677 {
2678         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
2679         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2680         HANDLE winusb_handle;
2681
2682         CHECK_WINUSBX_AVAILABLE(sub_api);
2683
2684         winusb_handle = handle_priv->interface_handle[iface].api_handle;
2685         if (!HANDLE_VALID(winusb_handle))
2686                 return LIBUSB_ERROR_NOT_FOUND;
2687
2688         WinUSBX[sub_api].Free(winusb_handle);
2689         handle_priv->interface_handle[iface].api_handle = INVALID_HANDLE_VALUE;
2690
2691         return LIBUSB_SUCCESS;
2692 }
2693
2694 /*
2695  * Return the first valid interface (of the same API type), for control transfers
2696  */
2697 static int get_valid_interface(struct libusb_device_handle *dev_handle, int api_id)
2698 {
2699         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
2700         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2701         int i;
2702
2703         if ((api_id < USB_API_WINUSBX) || (api_id > USB_API_HID)) {
2704                 usbi_dbg("unsupported API ID");
2705                 return -1;
2706         }
2707
2708         for (i = 0; i < USB_MAXINTERFACES; i++) {
2709         if (HANDLE_VALID(handle_priv->interface_handle[i].dev_handle)
2710                         && HANDLE_VALID(handle_priv->interface_handle[i].api_handle)
2711                         && (priv->usb_interface[i].apib->id == api_id))
2712                 return i;
2713         }
2714
2715         return -1;
2716 }
2717
2718 /*
2719 * Check a specific interface is valid (of the same API type), for control transfers
2720 */
2721 static int check_valid_interface(struct libusb_device_handle *dev_handle, unsigned short interface, int api_id)
2722 {
2723         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
2724         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2725
2726         if (interface >= USB_MAXINTERFACES)
2727                 return -1;
2728
2729         if ((api_id < USB_API_WINUSBX) || (api_id > USB_API_HID)) {
2730                 usbi_dbg("unsupported API ID");
2731                 return -1;
2732         }
2733
2734         // try the requested interface
2735         if (HANDLE_VALID(handle_priv->interface_handle[interface].dev_handle)
2736                 && HANDLE_VALID(handle_priv->interface_handle[interface].api_handle)
2737                 && (priv->usb_interface[interface].apib->id == api_id))
2738                 return interface;
2739
2740         return -1;
2741 }
2742
2743 /*
2744  * Lookup interface by endpoint address. -1 if not found
2745  */
2746 static int interface_by_endpoint(struct winusb_device_priv *priv,
2747         struct winusb_device_handle_priv *handle_priv, uint8_t endpoint_address)
2748 {
2749         int i, j;
2750
2751         for (i = 0; i < USB_MAXINTERFACES; i++) {
2752                 if (!HANDLE_VALID(handle_priv->interface_handle[i].api_handle))
2753                         continue;
2754                 if (priv->usb_interface[i].endpoint == NULL)
2755                         continue;
2756                 for (j = 0; j < priv->usb_interface[i].nb_endpoints; j++) {
2757                         if (priv->usb_interface[i].endpoint[j] == endpoint_address)
2758                                 return i;
2759                 }
2760         }
2761
2762         return -1;
2763 }
2764
2765 static int winusbx_submit_control_transfer(int sub_api, struct usbi_transfer *itransfer)
2766 {
2767         struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2768         struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
2769         struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
2770         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(transfer->dev_handle);
2771         PWINUSB_SETUP_PACKET setup = (PWINUSB_SETUP_PACKET)transfer->buffer;
2772         ULONG size;
2773         HANDLE winusb_handle;
2774         OVERLAPPED *overlapped;
2775         int current_interface;
2776
2777         CHECK_WINUSBX_AVAILABLE(sub_api);
2778
2779         size = transfer->length - LIBUSB_CONTROL_SETUP_SIZE;
2780
2781         // Windows places upper limits on the control transfer size
2782         // See: https://docs.microsoft.com/en-us/windows-hardware/drivers/usbcon/usb-bandwidth-allocation#maximum-transfer-size
2783         if (size > MAX_CTRL_BUFFER_LENGTH)
2784                 return LIBUSB_ERROR_INVALID_PARAM;
2785
2786         if ((setup->RequestType & 0x1F) == LIBUSB_RECIPIENT_INTERFACE)
2787                 current_interface = check_valid_interface(transfer->dev_handle, setup->Index & 0xff, USB_API_WINUSBX);
2788         else
2789                 current_interface = get_valid_interface(transfer->dev_handle, USB_API_WINUSBX);
2790         if (current_interface < 0) {
2791                 if (auto_claim(transfer, &current_interface, USB_API_WINUSBX) != LIBUSB_SUCCESS)
2792                         return LIBUSB_ERROR_NOT_FOUND;
2793         }
2794
2795         usbi_dbg("will use interface %d", current_interface);
2796
2797         winusb_handle = handle_priv->interface_handle[current_interface].api_handle;
2798         set_transfer_priv_handle(itransfer, handle_priv->interface_handle[current_interface].dev_handle);
2799         overlapped = get_transfer_priv_overlapped(itransfer);
2800
2801         // Sending of set configuration control requests from WinUSB creates issues, except when using libusb0.sys
2802         if (sub_api != SUB_API_LIBUSB0
2803                         && (LIBUSB_REQ_TYPE(setup->RequestType) == LIBUSB_REQUEST_TYPE_STANDARD)
2804                         && (setup->Request == LIBUSB_REQUEST_SET_CONFIGURATION)) {
2805                 if (setup->Value != priv->active_config) {
2806                         usbi_warn(TRANSFER_CTX(transfer), "cannot set configuration other than the default one");
2807                         return LIBUSB_ERROR_NOT_SUPPORTED;
2808                 }
2809                 windows_force_sync_completion(itransfer, 0);
2810         } else {
2811                 if (!WinUSBX[sub_api].ControlTransfer(winusb_handle, *setup, transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE, size, NULL, overlapped)) {
2812                         if (GetLastError() != ERROR_IO_PENDING) {
2813                                 usbi_warn(TRANSFER_CTX(transfer), "ControlTransfer failed: %s", windows_error_str(0));
2814                                 return LIBUSB_ERROR_IO;
2815                         }
2816                 }
2817         }
2818
2819         transfer_priv->interface_number = (uint8_t)current_interface;
2820
2821         return LIBUSB_SUCCESS;
2822 }
2823
2824 static int winusbx_set_interface_altsetting(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface, uint8_t altsetting)
2825 {
2826         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
2827         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2828         HANDLE winusb_handle;
2829
2830         CHECK_WINUSBX_AVAILABLE(sub_api);
2831
2832         winusb_handle = handle_priv->interface_handle[iface].api_handle;
2833         if (!HANDLE_VALID(winusb_handle)) {
2834                 usbi_err(HANDLE_CTX(dev_handle), "interface must be claimed first");
2835                 return LIBUSB_ERROR_NOT_FOUND;
2836         }
2837
2838         if (!WinUSBX[sub_api].SetCurrentAlternateSetting(winusb_handle, altsetting)) {
2839                 usbi_err(HANDLE_CTX(dev_handle), "SetCurrentAlternateSetting failed: %s", windows_error_str(0));
2840                 return LIBUSB_ERROR_IO;
2841         }
2842
2843         return LIBUSB_SUCCESS;
2844 }
2845
2846
2847 static void WINAPI winusbx_native_iso_transfer_continue_stream_callback(struct libusb_transfer *transfer)
2848 {
2849         // If this callback is invoked, this means that we attempted to set ContinueStream
2850         // to TRUE when calling Read/WriteIsochPipeAsap in winusbx_do_iso_transfer.
2851         // The role of this callback is to fallback to ContinueStream = FALSE if the transfer
2852         // did not succeed.
2853
2854         struct winusb_transfer_priv *transfer_priv =
2855                 get_winusb_transfer_priv(LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer));
2856         bool fallback = (transfer->status != LIBUSB_TRANSFER_COMPLETED);
2857         int idx;
2858
2859         // Restore the user callback
2860         transfer->callback = transfer_priv->iso_user_callback;
2861
2862         for (idx = 0; idx < transfer->num_iso_packets && !fallback; idx++) {
2863                 if (transfer->iso_packet_desc[idx].status != LIBUSB_TRANSFER_COMPLETED)
2864                         fallback = true;
2865         }
2866
2867         if (!fallback) {
2868                 // If the transfer was successful, we restore the user callback and call it.
2869                 if (transfer->callback)
2870                         transfer->callback(transfer);
2871         } else {
2872                 // If the transfer wasn't successful we reschedule the transfer while forcing it
2873                 // not to continue the stream. This might results in a 5-ms delay.
2874                 transfer_priv->iso_break_stream = TRUE;
2875                 libusb_submit_transfer(transfer);
2876         }
2877 }
2878 static int winusbx_submit_iso_transfer(int sub_api, struct usbi_transfer *itransfer)
2879 {
2880         struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2881         struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
2882         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(transfer->dev_handle);
2883         struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
2884         HANDLE winusb_handle;
2885         OVERLAPPED *overlapped;
2886         BOOL ret;
2887         int current_interface;
2888
2889         CHECK_WINUSBX_AVAILABLE(sub_api);
2890
2891         current_interface = interface_by_endpoint(priv, handle_priv, transfer->endpoint);
2892         if (current_interface < 0) {
2893                 usbi_err(TRANSFER_CTX(transfer), "unable to match endpoint to an open interface - cancelling transfer");
2894                 return LIBUSB_ERROR_NOT_FOUND;
2895         }
2896
2897         usbi_dbg("matched endpoint %02X with interface %d", transfer->endpoint, current_interface);
2898
2899         winusb_handle = handle_priv->interface_handle[current_interface].api_handle;
2900         set_transfer_priv_handle(itransfer, handle_priv->interface_handle[current_interface].dev_handle);
2901         overlapped = get_transfer_priv_overlapped(itransfer);
2902
2903         if ((sub_api == SUB_API_LIBUSBK) || (sub_api == SUB_API_LIBUSB0)) {
2904                 int i;
2905                 UINT offset;
2906                 size_t iso_ctx_size;
2907                 PKISO_CONTEXT iso_context;
2908
2909                 if (WinUSBX[sub_api].IsoReadPipe == NULL) {
2910                         usbi_warn(TRANSFER_CTX(transfer), "libusbK DLL does not support isoch transfers");
2911                         return LIBUSB_ERROR_NOT_SUPPORTED;
2912                 }
2913
2914                 iso_ctx_size = sizeof(KISO_CONTEXT) + (transfer->num_iso_packets * sizeof(KISO_PACKET));
2915                 transfer_priv->iso_context = iso_context = calloc(1, iso_ctx_size);
2916                 if (transfer_priv->iso_context == NULL)
2917                         return LIBUSB_ERROR_NO_MEM;
2918
2919                 // start ASAP
2920                 iso_context->StartFrame = 0;
2921                 iso_context->NumberOfPackets = (SHORT)transfer->num_iso_packets;
2922
2923                 // convert the transfer packet lengths to iso_packet offsets
2924                 offset = 0;
2925                 for (i = 0; i < transfer->num_iso_packets; i++) {
2926                         iso_context->IsoPackets[i].offset = offset;
2927                         offset += transfer->iso_packet_desc[i].length;
2928                 }
2929
2930                 if (IS_XFERIN(transfer)) {
2931                         usbi_dbg("reading %d iso packets", transfer->num_iso_packets);
2932                         ret = WinUSBX[sub_api].IsoReadPipe(winusb_handle, transfer->endpoint, transfer->buffer, transfer->length, overlapped, iso_context);
2933                 } else {
2934                         usbi_dbg("writing %d iso packets", transfer->num_iso_packets);
2935                         ret = WinUSBX[sub_api].IsoWritePipe(winusb_handle, transfer->endpoint, transfer->buffer, transfer->length, overlapped, iso_context);
2936                 }
2937
2938                 if (!ret && GetLastError() != ERROR_IO_PENDING) {
2939                         usbi_err(TRANSFER_CTX(transfer), "IsoReadPipe/IsoWritePipe failed: %s", windows_error_str(0));
2940                         return LIBUSB_ERROR_IO;
2941                 }
2942
2943                 transfer_priv->interface_number = (uint8_t)current_interface;
2944
2945                 return LIBUSB_SUCCESS;
2946         } else if (sub_api == SUB_API_WINUSB) {
2947                 WINUSB_PIPE_INFORMATION_EX pipe_info_ex = { 0 };
2948                 WINUSB_ISOCH_BUFFER_HANDLE buffer_handle;
2949                 ULONG iso_transfer_size_multiple;
2950                 int out_transfer_length = 0;
2951                 int idx;
2952
2953                 // Depending on the version of Microsoft WinUSB, isochronous transfers may not be supported.
2954                 if (WinUSBX[sub_api].ReadIsochPipeAsap == NULL) {
2955                         usbi_warn(TRANSFER_CTX(transfer), "WinUSB DLL does not support isoch transfers");
2956                         return LIBUSB_ERROR_NOT_SUPPORTED;
2957                 }
2958
2959                 if (sizeof(struct libusb_iso_packet_descriptor) != sizeof(USBD_ISO_PACKET_DESCRIPTOR)) {
2960                         usbi_err(TRANSFER_CTX(transfer), "size of WinUsb and libusb isoch packet descriptors don't match");
2961                         return LIBUSB_ERROR_NOT_SUPPORTED;
2962                 }
2963
2964                 // Query the pipe extended information to find the pipe index corresponding to the endpoint.
2965                 for (idx = 0; idx < priv->usb_interface[current_interface].nb_endpoints; ++idx) {
2966                         ret = WinUSBX[sub_api].QueryPipeEx(winusb_handle, (UINT8)priv->usb_interface[current_interface].current_altsetting, (UCHAR)idx, &pipe_info_ex);
2967                         if (!ret) {
2968                                 usbi_err(TRANSFER_CTX(transfer), "couldn't query interface settings for USB pipe with index %d. Error: %s", idx, windows_error_str(0));
2969                                 return LIBUSB_ERROR_NOT_FOUND;
2970                         }
2971
2972                         if (pipe_info_ex.PipeId == transfer->endpoint && pipe_info_ex.PipeType == UsbdPipeTypeIsochronous)
2973                                 break;
2974                 }
2975
2976                 // Make sure we found the index.
2977                 if (idx == priv->usb_interface[current_interface].nb_endpoints) {
2978                         usbi_err(TRANSFER_CTX(transfer), "couldn't find isoch endpoint 0x%02x", transfer->endpoint);
2979                         return LIBUSB_ERROR_NOT_FOUND;
2980                 }
2981
2982                 if (IS_XFERIN(transfer)) {
2983                         int interval = pipe_info_ex.Interval;
2984
2985                         // For high-speed and SuperSpeed device, the interval is 2**(bInterval-1).
2986                         if (transfer->dev_handle->dev->speed >= LIBUSB_SPEED_HIGH)
2987                                 interval = (1 << (pipe_info_ex.Interval - 1));
2988
2989                         // WinUSB only supports isoch transfers spanning a full USB frames. Later, we might be smarter about this
2990                         // and allocate a temporary buffer. However, this is harder than it seems as its destruction would depend on overlapped
2991                         // IO...
2992                         iso_transfer_size_multiple = (pipe_info_ex.MaximumBytesPerInterval * 8) / interval;
2993                         if (transfer->length % iso_transfer_size_multiple != 0) {
2994                                 usbi_err(TRANSFER_CTX(transfer), "length of isoch buffer must be a multiple of the MaximumBytesPerInterval * 8 / Interval");
2995                                 return LIBUSB_ERROR_INVALID_PARAM;
2996                         }
2997                 } else {
2998                         // If this is an OUT transfer, we make sure the isoch packets are contiguous as this isn't supported otherwise.
2999                         bool size_should_be_zero = false;
3000
3001                         for (idx = 0; idx < transfer->num_iso_packets; ++idx) {
3002                                 if ((size_should_be_zero && transfer->iso_packet_desc[idx].length != 0) ||
3003                                         (transfer->iso_packet_desc[idx].length != pipe_info_ex.MaximumBytesPerInterval && idx + 1 < transfer->num_iso_packets && transfer->iso_packet_desc[idx + 1].length > 0)) {
3004                                         usbi_err(TRANSFER_CTX(transfer), "isoch packets for OUT transfer with WinUSB must be contiguous in memory");
3005                                         return LIBUSB_ERROR_INVALID_PARAM;
3006                                 }
3007
3008                                 size_should_be_zero = (transfer->iso_packet_desc[idx].length == 0);
3009                                 out_transfer_length += transfer->iso_packet_desc[idx].length;
3010                         }
3011                 }
3012
3013                 if (transfer_priv->isoch_buffer_handle != NULL) {
3014                         if (WinUSBX[sub_api].UnregisterIsochBuffer(transfer_priv->isoch_buffer_handle)) {
3015                                 transfer_priv->isoch_buffer_handle = NULL;
3016                         } else {
3017                                 usbi_err(TRANSFER_CTX(transfer), "failed to unregister WinUSB isoch buffer: %s", windows_error_str(0));
3018                                 return LIBUSB_ERROR_OTHER;
3019                         }
3020                 }
3021
3022                 // Register the isoch buffer to the operating system.
3023                 ret = WinUSBX[sub_api].RegisterIsochBuffer(winusb_handle, transfer->endpoint, transfer->buffer, transfer->length, &buffer_handle);
3024                 if (!ret) {
3025                         usbi_err(TRANSFER_CTX(transfer), "failed to register WinUSB isoch buffer: %s", windows_error_str(0));
3026                         return LIBUSB_ERROR_NO_MEM;
3027                 }
3028
3029                 // Important note: the WinUSB_Read/WriteIsochPipeAsap API requires a ContinueStream parameter that tells whether the isochronous
3030                 // stream must be continued or if the WinUSB driver can schedule the transfer at its convenience. Profiling subsequent transfers
3031                 // with ContinueStream = FALSE showed that 5 frames, i.e. about 5 milliseconds, were left empty between each transfer. This
3032                 // is critical as this greatly diminish the achievable isochronous bandwidth. We solved the problem using the following strategy:
3033                 // - Transfers are first scheduled with ContinueStream = TRUE and with winusbx_iso_transfer_continue_stream_callback as user callback.
3034                 // - If the transfer succeeds, winusbx_iso_transfer_continue_stream_callback restore the user callback and calls its.
3035                 // - If the transfer fails, winusbx_iso_transfer_continue_stream_callback reschedule the transfer and force ContinueStream = FALSE.
3036                 if (!transfer_priv->iso_break_stream) {
3037                         transfer_priv->iso_user_callback = transfer->callback;
3038                         transfer->callback = winusbx_native_iso_transfer_continue_stream_callback;
3039                 }
3040
3041                 // Initiate the transfers.
3042                 if (IS_XFERIN(transfer))
3043                         ret = WinUSBX[sub_api].ReadIsochPipeAsap(buffer_handle, 0, transfer->length, !transfer_priv->iso_break_stream, transfer->num_iso_packets, (PUSBD_ISO_PACKET_DESCRIPTOR)transfer->iso_packet_desc, overlapped);
3044                 else
3045                         ret = WinUSBX[sub_api].WriteIsochPipeAsap(buffer_handle, 0, out_transfer_length, !transfer_priv->iso_break_stream, overlapped);
3046
3047                 if (!ret && GetLastError() != ERROR_IO_PENDING) {
3048                         usbi_err(TRANSFER_CTX(transfer), "ReadIsochPipeAsap/WriteIsochPipeAsap failed: %s", windows_error_str(0));
3049                         if (!WinUSBX[sub_api].UnregisterIsochBuffer(buffer_handle))
3050                                 usbi_warn(TRANSFER_CTX(transfer), "failed to unregister WinUSB isoch buffer: %s", windows_error_str(0));
3051                         return LIBUSB_ERROR_IO;
3052                 }
3053
3054                 // Restore the ContinueStream parameter to TRUE.
3055                 transfer_priv->iso_break_stream = FALSE;
3056
3057                 transfer_priv->isoch_buffer_handle = buffer_handle;
3058
3059                 transfer_priv->interface_number = (uint8_t)current_interface;
3060
3061                 return LIBUSB_SUCCESS;
3062         } else {
3063                 PRINT_UNSUPPORTED_API(winusbx_submit_iso_transfer);
3064                 return LIBUSB_ERROR_NOT_SUPPORTED;
3065         }
3066 }
3067
3068 static int winusbx_submit_bulk_transfer(int sub_api, struct usbi_transfer *itransfer)
3069 {
3070         struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
3071         struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
3072         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(transfer->dev_handle);
3073         struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
3074         HANDLE winusb_handle;
3075         OVERLAPPED *overlapped;
3076         BOOL ret;
3077         int current_interface;
3078
3079         CHECK_WINUSBX_AVAILABLE(sub_api);
3080
3081         current_interface = interface_by_endpoint(priv, handle_priv, transfer->endpoint);
3082         if (current_interface < 0) {
3083                 usbi_err(TRANSFER_CTX(transfer), "unable to match endpoint to an open interface - cancelling transfer");
3084                 return LIBUSB_ERROR_NOT_FOUND;
3085         }
3086
3087         usbi_dbg("matched endpoint %02X with interface %d", transfer->endpoint, current_interface);
3088
3089         winusb_handle = handle_priv->interface_handle[current_interface].api_handle;
3090         set_transfer_priv_handle(itransfer, handle_priv->interface_handle[current_interface].dev_handle);
3091         overlapped = get_transfer_priv_overlapped(itransfer);
3092
3093         if (IS_XFERIN(transfer)) {
3094                 usbi_dbg("reading %d bytes", transfer->length);
3095                 ret = WinUSBX[sub_api].ReadPipe(winusb_handle, transfer->endpoint, transfer->buffer, transfer->length, NULL, overlapped);
3096         } else {
3097                 // Set SHORT_PACKET_TERMINATE if ZLP requested.
3098                 // Changing this can be a problem with packets in flight, so only allow on the first transfer.
3099                 UCHAR policy = (transfer->flags & LIBUSB_TRANSFER_ADD_ZERO_PACKET) != 0;
3100                 uint8_t* current_zlp = &handle_priv->interface_handle[current_interface].zlp[transfer->endpoint];
3101                 if (*current_zlp == WINUSB_ZLP_UNSET) {
3102                         if (policy &&
3103                                 !WinUSBX[sub_api].SetPipePolicy(winusb_handle, transfer->endpoint,
3104                                 SHORT_PACKET_TERMINATE, sizeof(UCHAR), &policy)) {
3105                                 usbi_err(TRANSFER_CTX(transfer), "failed to set SHORT_PACKET_TERMINATE for endpoint %02X", transfer->endpoint);
3106                                 return LIBUSB_ERROR_NOT_SUPPORTED;
3107                         }
3108                         *current_zlp = policy ? WINUSB_ZLP_ON : WINUSB_ZLP_OFF;
3109                 } else if (policy != (*current_zlp == WINUSB_ZLP_ON)) {
3110                         usbi_err(TRANSFER_CTX(transfer), "cannot change ZERO_PACKET for endpoint %02X on Windows", transfer->endpoint);
3111                         return LIBUSB_ERROR_NOT_SUPPORTED;
3112                 }
3113
3114                 usbi_dbg("writing %d bytes", transfer->length);
3115                 ret = WinUSBX[sub_api].WritePipe(winusb_handle, transfer->endpoint, transfer->buffer, transfer->length, NULL, overlapped);
3116         }
3117
3118         if (!ret && GetLastError() != ERROR_IO_PENDING) {
3119                 usbi_err(TRANSFER_CTX(transfer), "ReadPipe/WritePipe failed: %s", windows_error_str(0));
3120                 return LIBUSB_ERROR_IO;
3121         }
3122
3123         transfer_priv->interface_number = (uint8_t)current_interface;
3124
3125         return LIBUSB_SUCCESS;
3126 }
3127
3128 static int winusbx_clear_halt(int sub_api, struct libusb_device_handle *dev_handle, unsigned char endpoint)
3129 {
3130         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
3131         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
3132         HANDLE winusb_handle;
3133         int current_interface;
3134
3135         CHECK_WINUSBX_AVAILABLE(sub_api);
3136
3137         current_interface = interface_by_endpoint(priv, handle_priv, endpoint);
3138         if (current_interface < 0) {
3139                 usbi_err(HANDLE_CTX(dev_handle), "unable to match endpoint to an open interface - cannot clear");
3140                 return LIBUSB_ERROR_NOT_FOUND;
3141         }
3142
3143         usbi_dbg("matched endpoint %02X with interface %d", endpoint, current_interface);
3144         winusb_handle = handle_priv->interface_handle[current_interface].api_handle;
3145
3146         if (!WinUSBX[sub_api].ResetPipe(winusb_handle, endpoint)) {
3147                 usbi_err(HANDLE_CTX(dev_handle), "ResetPipe failed: %s", windows_error_str(0));
3148                 return LIBUSB_ERROR_NO_DEVICE;
3149         }
3150
3151         return LIBUSB_SUCCESS;
3152 }
3153
3154 static int winusbx_cancel_transfer(int sub_api, struct usbi_transfer *itransfer)
3155 {
3156         struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
3157         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(transfer->dev_handle);
3158         struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
3159         struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
3160         int current_interface = transfer_priv->interface_number;
3161         HANDLE handle;
3162
3163         CHECK_WINUSBX_AVAILABLE(sub_api);
3164
3165         usbi_dbg("will use interface %d", current_interface);
3166
3167         handle = handle_priv->interface_handle[current_interface].api_handle;
3168         if (!WinUSBX[sub_api].AbortPipe(handle, transfer->endpoint)) {
3169                 usbi_err(TRANSFER_CTX(transfer), "AbortPipe failed: %s", windows_error_str(0));
3170                 return LIBUSB_ERROR_NO_DEVICE;
3171         }
3172
3173         return LIBUSB_SUCCESS;
3174 }
3175
3176 /*
3177  * from the "How to Use WinUSB to Communicate with a USB Device" Microsoft white paper
3178  * (http://www.microsoft.com/whdc/connect/usb/winusb_howto.mspx):
3179  * "WinUSB does not support host-initiated reset port and cycle port operations" and
3180  * IOCTL_INTERNAL_USB_CYCLE_PORT is only available in kernel mode and the
3181  * IOCTL_USB_HUB_CYCLE_PORT ioctl was removed from Vista => the best we can do is
3182  * cycle the pipes (and even then, the control pipe can not be reset using WinUSB)
3183  */
3184 // TODO: (post hotplug): see if we can force eject the device and redetect it (reuse hotplug?)
3185 static int winusbx_reset_device(int sub_api, struct libusb_device_handle *dev_handle)
3186 {
3187         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
3188         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
3189         HANDLE winusb_handle;
3190         int i, j;
3191
3192         CHECK_WINUSBX_AVAILABLE(sub_api);
3193
3194         // Reset any available pipe (except control)
3195         for (i = 0; i < USB_MAXINTERFACES; i++) {
3196                 winusb_handle = handle_priv->interface_handle[i].api_handle;
3197                 if (HANDLE_VALID(winusb_handle)) {
3198                         for (j = 0; j < priv->usb_interface[i].nb_endpoints; j++) {
3199                                 usbi_dbg("resetting ep %02X", priv->usb_interface[i].endpoint[j]);
3200                                 if (!WinUSBX[sub_api].AbortPipe(winusb_handle, priv->usb_interface[i].endpoint[j]))
3201                                         usbi_err(HANDLE_CTX(dev_handle), "AbortPipe (pipe address %02X) failed: %s",
3202                                                 priv->usb_interface[i].endpoint[j], windows_error_str(0));
3203
3204                                 // FlushPipe seems to fail on OUT pipes
3205                                 if (IS_EPIN(priv->usb_interface[i].endpoint[j])
3206                                                 && (!WinUSBX[sub_api].FlushPipe(winusb_handle, priv->usb_interface[i].endpoint[j])))
3207                                         usbi_err(HANDLE_CTX(dev_handle), "FlushPipe (pipe address %02X) failed: %s",
3208                                                 priv->usb_interface[i].endpoint[j], windows_error_str(0));
3209
3210                                 if (!WinUSBX[sub_api].ResetPipe(winusb_handle, priv->usb_interface[i].endpoint[j]))
3211                                         usbi_err(HANDLE_CTX(dev_handle), "ResetPipe (pipe address %02X) failed: %s",
3212                                                 priv->usb_interface[i].endpoint[j], windows_error_str(0));
3213                         }
3214                 }
3215         }
3216
3217         // libusbK & libusb0 have the ability to issue an actual device reset
3218         if ((sub_api != SUB_API_WINUSB) && (WinUSBX[sub_api].ResetDevice != NULL)) {
3219                 winusb_handle = handle_priv->interface_handle[0].api_handle;
3220                 if (HANDLE_VALID(winusb_handle))
3221                         WinUSBX[sub_api].ResetDevice(winusb_handle);
3222         }
3223
3224         return LIBUSB_SUCCESS;
3225 }
3226
3227 static enum libusb_transfer_status winusbx_copy_transfer_data(int sub_api, struct usbi_transfer *itransfer, DWORD length)
3228 {
3229         struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
3230         struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
3231         int i;
3232
3233         if (transfer->type == LIBUSB_TRANSFER_TYPE_ISOCHRONOUS) {
3234                 // for isochronous, need to copy the individual iso packet actual_lengths and statuses
3235                 if ((sub_api == SUB_API_LIBUSBK) || (sub_api == SUB_API_LIBUSB0)) {
3236                         // iso only supported on libusbk-based backends for now
3237                         PKISO_CONTEXT iso_context = transfer_priv->iso_context;
3238                         for (i = 0; i < transfer->num_iso_packets; i++) {
3239                                 transfer->iso_packet_desc[i].actual_length = iso_context->IsoPackets[i].actual_length;
3240                                 // TODO translate USDB_STATUS codes http://msdn.microsoft.com/en-us/library/ff539136(VS.85).aspx to libusb_transfer_status
3241                                 //transfer->iso_packet_desc[i].status = transfer_priv->iso_context->IsoPackets[i].status;
3242                         }
3243                 } else if (sub_api == SUB_API_WINUSB) {
3244                         if (IS_XFERIN(transfer)) {
3245                                 /* Convert isochronous packet descriptor between Windows and libusb representation.
3246                                  * Both representation are guaranteed to have the same length in bytes.*/
3247                                 PUSBD_ISO_PACKET_DESCRIPTOR usbd_iso_packet_desc = (PUSBD_ISO_PACKET_DESCRIPTOR)transfer->iso_packet_desc;
3248                                 for (i = 0; i < transfer->num_iso_packets; i++) {
3249                                         unsigned int packet_length = (i < transfer->num_iso_packets - 1) ? (usbd_iso_packet_desc[i + 1].Offset - usbd_iso_packet_desc[i].Offset) : usbd_iso_packet_desc[i].Length;
3250                                         unsigned int actual_length = usbd_iso_packet_desc[i].Length;
3251                                         USBD_STATUS status = usbd_iso_packet_desc[i].Status;
3252
3253                                         transfer->iso_packet_desc[i].length = packet_length;
3254                                         transfer->iso_packet_desc[i].actual_length = actual_length;
3255                                         transfer->iso_packet_desc[i].status = usbd_status_to_libusb_transfer_status(status);
3256                                 }
3257                         } else {
3258                                 for (i = 0; i < transfer->num_iso_packets; i++) {
3259                                         transfer->iso_packet_desc[i].status = LIBUSB_TRANSFER_COMPLETED;
3260                                 }
3261                         }
3262                 } else {
3263                         // This should only occur if backend is not set correctly or other backend isoc is partially implemented
3264                         PRINT_UNSUPPORTED_API(copy_transfer_data);
3265                         return LIBUSB_TRANSFER_ERROR;
3266                 }
3267         }
3268
3269         itransfer->transferred += (int)length;
3270         return LIBUSB_TRANSFER_COMPLETED;
3271 }
3272
3273 /*
3274  * Internal HID Support functions (from libusb-win32)
3275  * Note that functions that complete data transfer synchronously must return
3276  * LIBUSB_COMPLETED instead of LIBUSB_SUCCESS
3277  */
3278 static int _hid_get_hid_descriptor(struct hid_device_priv *dev, void *data, size_t *size);
3279 static int _hid_get_report_descriptor(struct hid_device_priv *dev, void *data, size_t *size);
3280
3281 static int _hid_wcslen(WCHAR *str)
3282 {
3283         int i = 0;
3284
3285         while (str[i] && (str[i] != 0x409))
3286                 i++;
3287
3288         return i;
3289 }
3290
3291 static int _hid_get_device_descriptor(struct hid_device_priv *hid_priv, void *data, size_t *size)
3292 {
3293         struct libusb_device_descriptor d;
3294
3295         d.bLength = LIBUSB_DT_DEVICE_SIZE;
3296         d.bDescriptorType = LIBUSB_DT_DEVICE;
3297         d.bcdUSB = 0x0200; /* 2.00 */
3298         d.bDeviceClass = 0;
3299         d.bDeviceSubClass = 0;
3300         d.bDeviceProtocol = 0;
3301         d.bMaxPacketSize0 = 64; /* fix this! */
3302         d.idVendor = (uint16_t)hid_priv->vid;
3303         d.idProduct = (uint16_t)hid_priv->pid;
3304         d.bcdDevice = 0x0100;
3305         d.iManufacturer = hid_priv->string_index[0];
3306         d.iProduct = hid_priv->string_index[1];
3307         d.iSerialNumber = hid_priv->string_index[2];
3308         d.bNumConfigurations = 1;
3309
3310         if (*size > LIBUSB_DT_DEVICE_SIZE)
3311                 *size = LIBUSB_DT_DEVICE_SIZE;
3312         memcpy(data, &d, *size);
3313
3314         return LIBUSB_COMPLETED;
3315 }
3316
3317 static int _hid_get_config_descriptor(struct hid_device_priv *hid_priv, void *data, size_t *size)
3318 {
3319         char num_endpoints = 0;
3320         size_t config_total_len = 0;
3321         char tmp[HID_MAX_CONFIG_DESC_SIZE];
3322         struct libusb_config_descriptor *cd;
3323         struct libusb_interface_descriptor *id;
3324         struct libusb_hid_descriptor *hd;
3325         struct libusb_endpoint_descriptor *ed;
3326         size_t tmp_size;
3327
3328         if (hid_priv->input_report_size)
3329                 num_endpoints++;
3330         if (hid_priv->output_report_size)
3331                 num_endpoints++;
3332
3333         config_total_len = LIBUSB_DT_CONFIG_SIZE + LIBUSB_DT_INTERFACE_SIZE
3334                 + LIBUSB_DT_HID_SIZE + num_endpoints * LIBUSB_DT_ENDPOINT_SIZE;
3335
3336         cd = (struct libusb_config_descriptor *)tmp;
3337         id = (struct libusb_interface_descriptor *)(tmp + LIBUSB_DT_CONFIG_SIZE);
3338         hd = (struct libusb_hid_descriptor *)(tmp + LIBUSB_DT_CONFIG_SIZE
3339                 + LIBUSB_DT_INTERFACE_SIZE);
3340         ed = (struct libusb_endpoint_descriptor *)(tmp + LIBUSB_DT_CONFIG_SIZE
3341                 + LIBUSB_DT_INTERFACE_SIZE
3342                 + LIBUSB_DT_HID_SIZE);
3343
3344         cd->bLength = LIBUSB_DT_CONFIG_SIZE;
3345         cd->bDescriptorType = LIBUSB_DT_CONFIG;
3346         cd->wTotalLength = (uint16_t)config_total_len;
3347         cd->bNumInterfaces = 1;
3348         cd->bConfigurationValue = 1;
3349         cd->iConfiguration = 0;
3350         cd->bmAttributes = 1 << 7; /* bus powered */
3351         cd->MaxPower = 50;
3352
3353         id->bLength = LIBUSB_DT_INTERFACE_SIZE;
3354         id->bDescriptorType = LIBUSB_DT_INTERFACE;
3355         id->bInterfaceNumber = 0;
3356         id->bAlternateSetting = 0;
3357         id->bNumEndpoints = num_endpoints;
3358         id->bInterfaceClass = 3;
3359         id->bInterfaceSubClass = 0;
3360         id->bInterfaceProtocol = 0;
3361         id->iInterface = 0;
3362
3363         tmp_size = LIBUSB_DT_HID_SIZE;
3364         _hid_get_hid_descriptor(hid_priv, hd, &tmp_size);
3365
3366         if (hid_priv->input_report_size) {
3367                 ed->bLength = LIBUSB_DT_ENDPOINT_SIZE;
3368                 ed->bDescriptorType = LIBUSB_DT_ENDPOINT;
3369                 ed->bEndpointAddress = HID_IN_EP;
3370                 ed->bmAttributes = 3;
3371                 ed->wMaxPacketSize = hid_priv->input_report_size - 1;
3372                 ed->bInterval = 10;
3373                 ed = (struct libusb_endpoint_descriptor *)((char *)ed + LIBUSB_DT_ENDPOINT_SIZE);
3374         }
3375
3376         if (hid_priv->output_report_size) {
3377                 ed->bLength = LIBUSB_DT_ENDPOINT_SIZE;
3378                 ed->bDescriptorType = LIBUSB_DT_ENDPOINT;
3379                 ed->bEndpointAddress = HID_OUT_EP;
3380                 ed->bmAttributes = 3;
3381                 ed->wMaxPacketSize = hid_priv->output_report_size - 1;
3382                 ed->bInterval = 10;
3383         }
3384
3385         if (*size > config_total_len)
3386                 *size = config_total_len;
3387         memcpy(data, tmp, *size);
3388
3389         return LIBUSB_COMPLETED;
3390 }
3391
3392 static int _hid_get_string_descriptor(struct hid_device_priv *hid_priv, int _index,
3393         void *data, size_t *size, HANDLE hid_handle)
3394 {
3395         void *tmp = NULL;
3396         WCHAR string[MAX_USB_STRING_LENGTH];
3397         size_t tmp_size = 0;
3398         int i;
3399
3400         /* language ID, EN-US */
3401         char string_langid[] = {0x09, 0x04};
3402
3403         if (_index == 0) {
3404                 tmp = string_langid;
3405                 tmp_size = sizeof(string_langid) + 2;
3406         } else {
3407                 for (i = 0; i < 3; i++) {
3408                         if (_index == (hid_priv->string_index[i])) {
3409                                 tmp = hid_priv->string[i];
3410                                 tmp_size = (_hid_wcslen(hid_priv->string[i]) + 1) * sizeof(WCHAR);
3411                                 break;
3412                         }
3413                 }
3414
3415                 if (i == 3) {
3416                         if (!HidD_GetIndexedString(hid_handle, _index, string, sizeof(string)))
3417                                 return LIBUSB_ERROR_INVALID_PARAM;
3418                         tmp = string;
3419                         tmp_size = (_hid_wcslen(string) + 1) * sizeof(WCHAR);
3420                 }
3421         }
3422
3423         if (!tmp_size)
3424                 return LIBUSB_ERROR_INVALID_PARAM;
3425
3426         if (tmp_size < *size)
3427                 *size = tmp_size;
3428
3429         // 2 byte header
3430         ((uint8_t *)data)[0] = (uint8_t)*size;
3431         ((uint8_t *)data)[1] = LIBUSB_DT_STRING;
3432         memcpy((uint8_t *)data + 2, tmp, *size - 2);
3433
3434         return LIBUSB_COMPLETED;
3435 }
3436
3437 static int _hid_get_hid_descriptor(struct hid_device_priv *hid_priv, void *data, size_t *size)
3438 {
3439         struct libusb_hid_descriptor d;
3440         uint8_t tmp[MAX_HID_DESCRIPTOR_SIZE];
3441         size_t report_len = MAX_HID_DESCRIPTOR_SIZE;
3442
3443         _hid_get_report_descriptor(hid_priv, tmp, &report_len);
3444
3445         d.bLength = LIBUSB_DT_HID_SIZE;
3446         d.bDescriptorType = LIBUSB_DT_HID;
3447         d.bcdHID = 0x0110; /* 1.10 */
3448         d.bCountryCode = 0;
3449         d.bNumDescriptors = 1;
3450         d.bClassDescriptorType = LIBUSB_DT_REPORT;
3451         d.wClassDescriptorLength = (uint16_t)report_len;
3452
3453         if (*size > LIBUSB_DT_HID_SIZE)
3454                 *size = LIBUSB_DT_HID_SIZE;
3455         memcpy(data, &d, *size);
3456
3457         return LIBUSB_COMPLETED;
3458 }
3459
3460 static int _hid_get_report_descriptor(struct hid_device_priv *hid_priv, void *data, size_t *size)
3461 {
3462         uint8_t d[MAX_HID_DESCRIPTOR_SIZE];
3463         size_t i = 0;
3464
3465         /* usage page */
3466         d[i++] = 0x06; d[i++] = hid_priv->usagePage & 0xFF; d[i++] = hid_priv->usagePage >> 8;
3467         /* usage */
3468         d[i++] = 0x09; d[i++] = (uint8_t)hid_priv->usage;
3469         /* start collection (application) */
3470         d[i++] = 0xA1; d[i++] = 0x01;
3471         /* input report */
3472         if (hid_priv->input_report_size) {
3473                 /* usage (vendor defined) */
3474                 d[i++] = 0x09; d[i++] = 0x01;
3475                 /* logical minimum (0) */
3476                 d[i++] = 0x15; d[i++] = 0x00;
3477                 /* logical maximum (255) */
3478                 d[i++] = 0x25; d[i++] = 0xFF;
3479                 /* report size (8 bits) */
3480                 d[i++] = 0x75; d[i++] = 0x08;
3481                 /* report count */
3482                 d[i++] = 0x95; d[i++] = (uint8_t)hid_priv->input_report_size - 1;
3483                 /* input (data, variable, absolute) */
3484                 d[i++] = 0x81; d[i++] = 0x00;
3485         }
3486         /* output report */
3487         if (hid_priv->output_report_size) {
3488                 /* usage (vendor defined) */
3489                 d[i++] = 0x09; d[i++] = 0x02;
3490                 /* logical minimum (0) */
3491                 d[i++] = 0x15; d[i++] = 0x00;
3492                 /* logical maximum (255) */
3493                 d[i++] = 0x25; d[i++] = 0xFF;
3494                 /* report size (8 bits) */
3495                 d[i++] = 0x75; d[i++] = 0x08;
3496                 /* report count */
3497                 d[i++] = 0x95; d[i++] = (uint8_t)hid_priv->output_report_size - 1;
3498                 /* output (data, variable, absolute) */
3499                 d[i++] = 0x91; d[i++] = 0x00;
3500         }
3501         /* feature report */
3502         if (hid_priv->feature_report_size) {
3503                 /* usage (vendor defined) */
3504                 d[i++] = 0x09; d[i++] = 0x03;
3505                 /* logical minimum (0) */
3506                 d[i++] = 0x15; d[i++] = 0x00;
3507                 /* logical maximum (255) */
3508                 d[i++] = 0x25; d[i++] = 0xFF;
3509                 /* report size (8 bits) */
3510                 d[i++] = 0x75; d[i++] = 0x08;
3511                 /* report count */
3512                 d[i++] = 0x95; d[i++] = (uint8_t)hid_priv->feature_report_size - 1;
3513                 /* feature (data, variable, absolute) */
3514                 d[i++] = 0xb2; d[i++] = 0x02; d[i++] = 0x01;
3515         }
3516
3517         /* end collection */
3518         d[i++] = 0xC0;
3519
3520         if (*size > i)
3521                 *size = i;
3522         memcpy(data, d, *size);
3523
3524         return LIBUSB_COMPLETED;
3525 }
3526
3527 static int _hid_get_descriptor(struct libusb_device *dev, HANDLE hid_handle, int recipient,
3528         int type, int _index, void *data, size_t *size)
3529 {
3530         struct winusb_device_priv *priv = usbi_get_device_priv(dev);
3531         UNUSED(recipient);
3532
3533         switch (type) {
3534         case LIBUSB_DT_DEVICE:
3535                 usbi_dbg("LIBUSB_DT_DEVICE");
3536                 return _hid_get_device_descriptor(priv->hid, data, size);
3537         case LIBUSB_DT_CONFIG:
3538                 usbi_dbg("LIBUSB_DT_CONFIG");
3539                 if (!_index)
3540                         return _hid_get_config_descriptor(priv->hid, data, size);
3541                 return LIBUSB_ERROR_INVALID_PARAM;
3542         case LIBUSB_DT_STRING:
3543                 usbi_dbg("LIBUSB_DT_STRING");
3544                 return _hid_get_string_descriptor(priv->hid, _index, data, size, hid_handle);
3545         case LIBUSB_DT_HID:
3546                 usbi_dbg("LIBUSB_DT_HID");
3547                 if (!_index)
3548                         return _hid_get_hid_descriptor(priv->hid, data, size);
3549                 return LIBUSB_ERROR_INVALID_PARAM;
3550         case LIBUSB_DT_REPORT:
3551                 usbi_dbg("LIBUSB_DT_REPORT");
3552                 if (!_index)
3553                         return _hid_get_report_descriptor(priv->hid, data, size);
3554                 return LIBUSB_ERROR_INVALID_PARAM;
3555         case LIBUSB_DT_PHYSICAL:
3556                 usbi_dbg("LIBUSB_DT_PHYSICAL");
3557                 if (HidD_GetPhysicalDescriptor(hid_handle, data, (ULONG)*size))
3558                         return LIBUSB_COMPLETED;
3559                 return LIBUSB_ERROR_OTHER;
3560         }
3561
3562         usbi_warn(DEVICE_CTX(dev), "unsupported");
3563         return LIBUSB_ERROR_NOT_SUPPORTED;
3564 }
3565
3566 static int _hid_get_report(struct libusb_device *dev, HANDLE hid_handle, int id, void *data,
3567         struct winusb_transfer_priv *tp, size_t size, OVERLAPPED *overlapped, int report_type)
3568 {
3569         DWORD ioctl_code, expected_size = (DWORD)size;
3570         uint8_t *buf;
3571
3572         if (tp->hid_buffer != NULL)
3573                 usbi_err(DEVICE_CTX(dev), "program assertion failed - hid_buffer is not NULL");
3574
3575         if ((size == 0) || (size > MAX_HID_REPORT_SIZE)) {
3576                 usbi_warn(DEVICE_CTX(dev), "invalid size (%"PRIuPTR")", (uintptr_t)size);
3577                 return LIBUSB_ERROR_INVALID_PARAM;
3578         }
3579
3580         switch (report_type) {
3581         case HID_REPORT_TYPE_INPUT:
3582                 ioctl_code = IOCTL_HID_GET_INPUT_REPORT;
3583                 break;
3584         case HID_REPORT_TYPE_FEATURE:
3585                 ioctl_code = IOCTL_HID_GET_FEATURE;
3586                 break;
3587         default:
3588                 usbi_warn(DEVICE_CTX(dev), "unknown HID report type %d", report_type);
3589                 return LIBUSB_ERROR_INVALID_PARAM;
3590         }
3591
3592         // Add a trailing byte to detect overflows
3593         buf = calloc(1, expected_size + 1);
3594         if (buf == NULL)
3595                 return LIBUSB_ERROR_NO_MEM;
3596
3597         buf[0] = (uint8_t)id; // Must be set always
3598         usbi_dbg("report ID: 0x%02X", buf[0]);
3599
3600         // NB: The size returned by DeviceIoControl doesn't include report IDs when not in use (0)
3601         if (!DeviceIoControl(hid_handle, ioctl_code, buf, expected_size + 1,
3602                 buf, expected_size + 1, NULL, overlapped)) {
3603                 if (GetLastError() != ERROR_IO_PENDING) {
3604                         usbi_err(DEVICE_CTX(dev), "failed to read HID Report: %s", windows_error_str(0));
3605                         free(buf);
3606                         return LIBUSB_ERROR_IO;
3607                 }
3608         }
3609
3610         // Asynchronous wait
3611         tp->hid_buffer = buf;
3612         tp->hid_dest = data; // copy dest, as not necessarily the start of the transfer buffer
3613         tp->hid_expected_size = expected_size;
3614
3615         return LIBUSB_SUCCESS;
3616 }
3617
3618 static int _hid_set_report(struct libusb_device *dev, HANDLE hid_handle, int id, void *data,
3619         struct winusb_transfer_priv *tp, size_t size, OVERLAPPED *overlapped, int report_type)
3620 {
3621         DWORD ioctl_code, write_size = (DWORD)size;
3622         // If an id is reported, we must allow MAX_HID_REPORT_SIZE + 1
3623         size_t max_report_size = MAX_HID_REPORT_SIZE + (id ? 1 : 0);
3624         uint8_t *buf;
3625
3626         if (tp->hid_buffer != NULL)
3627                 usbi_err(DEVICE_CTX(dev), "program assertion failed - hid_buffer is not NULL");
3628
3629         if ((size == 0) || (size > max_report_size)) {
3630                 usbi_warn(DEVICE_CTX(dev), "invalid size (%"PRIuPTR")", (uintptr_t)size);
3631                 return LIBUSB_ERROR_INVALID_PARAM;
3632         }
3633
3634         switch (report_type) {
3635         case HID_REPORT_TYPE_OUTPUT:
3636                 ioctl_code = IOCTL_HID_SET_OUTPUT_REPORT;
3637                 break;
3638         case HID_REPORT_TYPE_FEATURE:
3639                 ioctl_code = IOCTL_HID_SET_FEATURE;
3640                 break;
3641         default:
3642                 usbi_warn(DEVICE_CTX(dev), "unknown HID report type %d", report_type);
3643                 return LIBUSB_ERROR_INVALID_PARAM;
3644         }
3645
3646         usbi_dbg("report ID: 0x%02X", id);
3647         // When report IDs are not used (i.e. when id == 0), we must add
3648         // a null report ID. Otherwise, we just use original data buffer
3649         if (id == 0)
3650                 write_size++;
3651
3652         buf = malloc(write_size);
3653         if (buf == NULL)
3654                 return LIBUSB_ERROR_NO_MEM;
3655
3656         if (id == 0) {
3657                 buf[0] = 0;
3658                 memcpy(buf + 1, data, size);
3659         } else {
3660                 // This seems like a waste, but if we don't duplicate the
3661                 // data, we'll get issues when freeing hid_buffer
3662                 memcpy(buf, data, size);
3663                 if (buf[0] != id)
3664                         usbi_warn(DEVICE_CTX(dev), "mismatched report ID (data is %02X, parameter is %02X)", buf[0], id);
3665         }
3666
3667         // NB: The size returned by DeviceIoControl doesn't include report IDs when not in use (0)
3668         if (!DeviceIoControl(hid_handle, ioctl_code, buf, write_size,
3669                 buf, write_size, NULL, overlapped)) {
3670                 if (GetLastError() != ERROR_IO_PENDING) {
3671                         usbi_err(DEVICE_CTX(dev), "failed to write HID Output Report: %s", windows_error_str(0));
3672                         free(buf);
3673                         return LIBUSB_ERROR_IO;
3674                 }
3675         }
3676
3677         tp->hid_buffer = buf;
3678         tp->hid_dest = NULL;
3679         return LIBUSB_SUCCESS;
3680 }
3681
3682 static int _hid_class_request(struct libusb_device *dev, HANDLE hid_handle, int request_type,
3683         int request, int value, int _index, void *data, struct winusb_transfer_priv *tp,
3684         size_t size, OVERLAPPED *overlapped)
3685 {
3686         int report_type = (value >> 8) & 0xFF;
3687         int report_id = value & 0xFF;
3688
3689         UNUSED(_index);
3690
3691         if ((LIBUSB_REQ_RECIPIENT(request_type) != LIBUSB_RECIPIENT_INTERFACE)
3692                         && (LIBUSB_REQ_RECIPIENT(request_type) != LIBUSB_RECIPIENT_DEVICE))
3693                 return LIBUSB_ERROR_INVALID_PARAM;
3694
3695         if (LIBUSB_REQ_OUT(request_type) && request == HID_REQ_SET_REPORT)
3696                 return _hid_set_report(dev, hid_handle, report_id, data, tp, size, overlapped, report_type);
3697
3698         if (LIBUSB_REQ_IN(request_type) && request == HID_REQ_GET_REPORT)
3699                 return _hid_get_report(dev, hid_handle, report_id, data, tp, size, overlapped, report_type);
3700
3701         return LIBUSB_ERROR_INVALID_PARAM;
3702 }
3703
3704 /*
3705  * HID API functions
3706  */
3707 static bool hid_init(struct libusb_context *ctx)
3708 {
3709         DLL_GET_HANDLE(ctx, hid);
3710
3711         DLL_LOAD_FUNC(hid, HidD_GetAttributes, true);
3712         DLL_LOAD_FUNC(hid, HidD_GetHidGuid, true);
3713         DLL_LOAD_FUNC(hid, HidD_GetPreparsedData, true);
3714         DLL_LOAD_FUNC(hid, HidD_FreePreparsedData, true);
3715         DLL_LOAD_FUNC(hid, HidD_GetManufacturerString, true);
3716         DLL_LOAD_FUNC(hid, HidD_GetProductString, true);
3717         DLL_LOAD_FUNC(hid, HidD_GetSerialNumberString, true);
3718         DLL_LOAD_FUNC(hid, HidD_GetIndexedString, true);
3719         DLL_LOAD_FUNC(hid, HidP_GetCaps, true);
3720         DLL_LOAD_FUNC(hid, HidD_SetNumInputBuffers, true);
3721         DLL_LOAD_FUNC(hid, HidD_GetPhysicalDescriptor, true);
3722         DLL_LOAD_FUNC(hid, HidD_FlushQueue, true);
3723         DLL_LOAD_FUNC(hid, HidP_GetValueCaps, true);
3724
3725         return true;
3726 }
3727
3728 static void hid_exit(void)
3729 {
3730         DLL_FREE_HANDLE(hid);
3731 }
3732
3733 // NB: open and close must ensure that they only handle interface of
3734 // the right API type, as these functions can be called wholesale from
3735 // composite_open(), with interfaces belonging to different APIs
3736 static int hid_open(int sub_api, struct libusb_device_handle *dev_handle)
3737 {
3738         struct libusb_device *dev = dev_handle->dev;
3739         struct winusb_device_priv *priv = usbi_get_device_priv(dev);
3740         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
3741         HIDD_ATTRIBUTES hid_attributes;
3742         PHIDP_PREPARSED_DATA preparsed_data = NULL;
3743         HIDP_CAPS capabilities;
3744         HIDP_VALUE_CAPS *value_caps;
3745         HANDLE hid_handle = INVALID_HANDLE_VALUE;
3746         int i, j;
3747         // report IDs handling
3748         ULONG size[3];
3749         int nb_ids[2]; // zero and nonzero report IDs
3750 #if defined(ENABLE_LOGGING)
3751         const char * const type[3] = {"input", "output", "feature"};
3752 #endif
3753
3754         UNUSED(sub_api);
3755         CHECK_HID_AVAILABLE;
3756
3757         if (priv->hid == NULL) {
3758                 usbi_err(HANDLE_CTX(dev_handle), "program assertion failed - private HID structure is uninitialized");
3759                 return LIBUSB_ERROR_NOT_FOUND;
3760         }
3761
3762         for (i = 0; i < USB_MAXINTERFACES; i++) {
3763                 if ((priv->usb_interface[i].path != NULL)
3764                                 && (priv->usb_interface[i].apib->id == USB_API_HID)) {
3765                         hid_handle = windows_open(dev_handle, priv->usb_interface[i].path, GENERIC_READ | GENERIC_WRITE);
3766                         /*
3767                          * http://www.lvr.com/hidfaq.htm: Why do I receive "Access denied" when attempting to access my HID?
3768                          * "Windows 2000 and later have exclusive read/write access to HIDs that are configured as a system
3769                          * keyboards or mice. An application can obtain a handle to a system keyboard or mouse by not
3770                          * requesting READ or WRITE access with CreateFile. Applications can then use HidD_SetFeature and
3771                          * HidD_GetFeature (if the device supports Feature reports)."
3772                          */
3773                         if (hid_handle == INVALID_HANDLE_VALUE) {
3774                                 usbi_warn(HANDLE_CTX(dev_handle), "could not open HID device in R/W mode (keyboard or mouse?) - trying without");
3775                                 hid_handle = windows_open(dev_handle, priv->usb_interface[i].path, 0);
3776                                 if (hid_handle == INVALID_HANDLE_VALUE) {
3777                                         usbi_err(HANDLE_CTX(dev_handle), "could not open device %s (interface %d): %s", priv->path, i, windows_error_str(0));
3778                                         switch (GetLastError()) {
3779                                         case ERROR_FILE_NOT_FOUND: // The device was disconnected
3780                                                 return LIBUSB_ERROR_NO_DEVICE;
3781                                         case ERROR_ACCESS_DENIED:
3782                                                 return LIBUSB_ERROR_ACCESS;
3783                                         default:
3784                                                 return LIBUSB_ERROR_IO;
3785                                         }
3786                                 }
3787                                 priv->usb_interface[i].restricted_functionality = true;
3788                         }
3789                         handle_priv->interface_handle[i].api_handle = hid_handle;
3790                 }
3791         }
3792
3793         hid_attributes.Size = sizeof(hid_attributes);
3794         do {
3795                 if (!HidD_GetAttributes(hid_handle, &hid_attributes)) {
3796                         usbi_err(HANDLE_CTX(dev_handle), "could not gain access to HID top collection (HidD_GetAttributes)");
3797                         break;
3798                 }
3799
3800                 priv->hid->vid = hid_attributes.VendorID;
3801                 priv->hid->pid = hid_attributes.ProductID;
3802
3803                 // Set the maximum available input buffer size
3804                 for (i = 32; HidD_SetNumInputBuffers(hid_handle, i); i *= 2);
3805                 usbi_dbg("set maximum input buffer size to %d", i / 2);
3806
3807                 // Get the maximum input and output report size
3808                 if (!HidD_GetPreparsedData(hid_handle, &preparsed_data) || !preparsed_data) {
3809                         usbi_err(HANDLE_CTX(dev_handle), "could not read HID preparsed data (HidD_GetPreparsedData)");
3810                         break;
3811                 }
3812                 if (HidP_GetCaps(preparsed_data, &capabilities) != HIDP_STATUS_SUCCESS) {
3813                         usbi_err(HANDLE_CTX(dev_handle), "could not parse HID capabilities (HidP_GetCaps)");
3814                         break;
3815                 }
3816
3817                 // Find out if interrupt will need report IDs
3818                 size[0] = capabilities.NumberInputValueCaps;
3819                 size[1] = capabilities.NumberOutputValueCaps;
3820                 size[2] = capabilities.NumberFeatureValueCaps;
3821                 for (j = HidP_Input; j <= HidP_Feature; j++) {
3822                         usbi_dbg("%lu HID %s report value(s) found", ULONG_CAST(size[j]), type[j]);
3823                         priv->hid->uses_report_ids[j] = false;
3824                         if (size[j] > 0) {
3825                                 value_caps = calloc(size[j], sizeof(HIDP_VALUE_CAPS));
3826                                 if ((value_caps != NULL)
3827                                                 && (HidP_GetValueCaps((HIDP_REPORT_TYPE)j, value_caps, &size[j], preparsed_data) == HIDP_STATUS_SUCCESS)
3828                                                 && (size[j] >= 1)) {
3829                                         nb_ids[0] = 0;
3830                                         nb_ids[1] = 0;
3831                                         for (i = 0; i < (int)size[j]; i++) {
3832                                                 usbi_dbg("  Report ID: 0x%02X", value_caps[i].ReportID);
3833                                                 if (value_caps[i].ReportID != 0)
3834                                                         nb_ids[1]++;
3835                                                 else
3836                                                         nb_ids[0]++;
3837                                         }
3838                                         if (nb_ids[1] != 0) {
3839                                                 if (nb_ids[0] != 0)
3840                                                         usbi_warn(HANDLE_CTX(dev_handle), "program assertion failed - zero and nonzero report IDs used for %s",
3841                                                                 type[j]);
3842                                                 priv->hid->uses_report_ids[j] = true;
3843                                         }
3844                                 } else {
3845                                         usbi_warn(HANDLE_CTX(dev_handle), "  could not process %s report IDs", type[j]);
3846                                 }
3847                                 free(value_caps);
3848                         }
3849                 }
3850
3851                 // Set the report sizes
3852                 priv->hid->input_report_size = capabilities.InputReportByteLength;
3853                 priv->hid->output_report_size = capabilities.OutputReportByteLength;
3854                 priv->hid->feature_report_size = capabilities.FeatureReportByteLength;
3855
3856                 // Store usage and usagePage values
3857                 priv->hid->usage = capabilities.Usage;
3858                 priv->hid->usagePage = capabilities.UsagePage;
3859
3860                 // Fetch string descriptors
3861                 priv->hid->string_index[0] = dev->device_descriptor.iManufacturer;
3862                 if (priv->hid->string_index[0] != 0)
3863                         HidD_GetManufacturerString(hid_handle, priv->hid->string[0], sizeof(priv->hid->string[0]));
3864                 else
3865                         priv->hid->string[0][0] = 0;
3866
3867                 priv->hid->string_index[1] = dev->device_descriptor.iProduct;
3868                 if (priv->hid->string_index[1] != 0)
3869                         HidD_GetProductString(hid_handle, priv->hid->string[1], sizeof(priv->hid->string[1]));
3870                 else
3871                         priv->hid->string[1][0] = 0;
3872
3873                 priv->hid->string_index[2] = dev->device_descriptor.iSerialNumber;
3874                 if (priv->hid->string_index[2] != 0)
3875                         HidD_GetSerialNumberString(hid_handle, priv->hid->string[2], sizeof(priv->hid->string[2]));
3876                 else
3877                         priv->hid->string[2][0] = 0;
3878         } while (0);
3879
3880         if (preparsed_data)
3881                 HidD_FreePreparsedData(preparsed_data);
3882
3883         return LIBUSB_SUCCESS;
3884 }
3885
3886 static void hid_close(int sub_api, struct libusb_device_handle *dev_handle)
3887 {
3888         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
3889         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
3890         HANDLE file_handle;
3891         int i;
3892
3893         UNUSED(sub_api);
3894
3895         if (DLL_HANDLE_NAME(hid) == NULL)
3896                 return;
3897
3898         for (i = 0; i < USB_MAXINTERFACES; i++) {
3899                 if (priv->usb_interface[i].apib->id == USB_API_HID) {
3900                         file_handle = handle_priv->interface_handle[i].api_handle;
3901                         if (HANDLE_VALID(file_handle))
3902                                 CloseHandle(file_handle);
3903                 }
3904         }
3905 }
3906
3907 static int hid_claim_interface(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface)
3908 {
3909         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
3910         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
3911
3912         UNUSED(sub_api);
3913         CHECK_HID_AVAILABLE;
3914
3915         // NB: Disconnection detection is not possible in this function
3916         if (priv->usb_interface[iface].path == NULL)
3917                 return LIBUSB_ERROR_NOT_FOUND; // invalid iface
3918
3919         // We use dev_handle as a flag for interface claimed
3920         if (handle_priv->interface_handle[iface].dev_handle == INTERFACE_CLAIMED)
3921                 return LIBUSB_ERROR_BUSY; // already claimed
3922
3923         handle_priv->interface_handle[iface].dev_handle = INTERFACE_CLAIMED;
3924
3925         usbi_dbg("claimed interface %u", iface);
3926         handle_priv->active_interface = iface;
3927
3928         return LIBUSB_SUCCESS;
3929 }
3930
3931 static int hid_release_interface(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface)
3932 {
3933         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
3934         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
3935
3936         UNUSED(sub_api);
3937         CHECK_HID_AVAILABLE;
3938
3939         if (priv->usb_interface[iface].path == NULL)
3940                 return LIBUSB_ERROR_NOT_FOUND; // invalid iface
3941
3942         if (handle_priv->interface_handle[iface].dev_handle != INTERFACE_CLAIMED)
3943                 return LIBUSB_ERROR_NOT_FOUND; // invalid iface
3944
3945         handle_priv->interface_handle[iface].dev_handle = INVALID_HANDLE_VALUE;
3946
3947         return LIBUSB_SUCCESS;
3948 }
3949
3950 static int hid_set_interface_altsetting(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface, uint8_t altsetting)
3951 {
3952         UNUSED(sub_api);
3953         UNUSED(iface);
3954
3955         CHECK_HID_AVAILABLE;
3956
3957         if (altsetting != 0) {
3958                 usbi_err(HANDLE_CTX(dev_handle), "set interface altsetting not supported for altsetting >0");
3959                 return LIBUSB_ERROR_NOT_SUPPORTED;
3960         }
3961
3962         return LIBUSB_SUCCESS;
3963 }
3964
3965 static int hid_submit_control_transfer(int sub_api, struct usbi_transfer *itransfer)
3966 {
3967         struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
3968         struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
3969         struct libusb_device_handle *dev_handle = transfer->dev_handle;
3970         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
3971         struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
3972         WINUSB_SETUP_PACKET *setup = (WINUSB_SETUP_PACKET *)transfer->buffer;
3973         HANDLE hid_handle;
3974         OVERLAPPED *overlapped;
3975         int current_interface;
3976         uint8_t config;
3977         size_t size;
3978         int r;
3979
3980         UNUSED(sub_api);
3981         CHECK_HID_AVAILABLE;
3982
3983         safe_free(transfer_priv->hid_buffer);
3984         transfer_priv->hid_dest = NULL;
3985         size = transfer->length - LIBUSB_CONTROL_SETUP_SIZE;
3986
3987         if (size > MAX_CTRL_BUFFER_LENGTH)
3988                 return LIBUSB_ERROR_INVALID_PARAM;
3989
3990         current_interface = get_valid_interface(dev_handle, USB_API_HID);
3991         if (current_interface < 0) {
3992                 if (auto_claim(transfer, &current_interface, USB_API_HID) != LIBUSB_SUCCESS)
3993                         return LIBUSB_ERROR_NOT_FOUND;
3994         }
3995
3996         usbi_dbg("will use interface %d", current_interface);
3997
3998         hid_handle = handle_priv->interface_handle[current_interface].api_handle;
3999         set_transfer_priv_handle(itransfer, hid_handle);
4000         overlapped = get_transfer_priv_overlapped(itransfer);
4001
4002         switch (LIBUSB_REQ_TYPE(setup->RequestType)) {
4003         case LIBUSB_REQUEST_TYPE_STANDARD:
4004                 switch (setup->Request) {
4005                 case LIBUSB_REQUEST_GET_DESCRIPTOR:
4006                         r = _hid_get_descriptor(dev_handle->dev, hid_handle, LIBUSB_REQ_RECIPIENT(setup->RequestType),
4007                                 (setup->Value >> 8) & 0xFF, setup->Value & 0xFF, transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE, &size);
4008                         break;
4009                 case LIBUSB_REQUEST_GET_CONFIGURATION:
4010                         r = winusb_get_configuration(dev_handle, &config);
4011                         if (r == LIBUSB_SUCCESS) {
4012                                 size = 1;
4013                                 ((uint8_t *)transfer->buffer)[LIBUSB_CONTROL_SETUP_SIZE] = config;
4014                                 r = LIBUSB_COMPLETED;
4015                         }
4016                         break;
4017                 case LIBUSB_REQUEST_SET_CONFIGURATION:
4018                         if (setup->Value == priv->active_config) {
4019                                 r = LIBUSB_COMPLETED;
4020                         } else {
4021                                 usbi_warn(TRANSFER_CTX(transfer), "cannot set configuration other than the default one");
4022                                 r = LIBUSB_ERROR_NOT_SUPPORTED;
4023                         }
4024                         break;
4025                 case LIBUSB_REQUEST_GET_INTERFACE:
4026                         size = 1;
4027                         ((uint8_t *)transfer->buffer)[LIBUSB_CONTROL_SETUP_SIZE] = 0;
4028                         r = LIBUSB_COMPLETED;
4029                         break;
4030                 case LIBUSB_REQUEST_SET_INTERFACE:
4031                         r = hid_set_interface_altsetting(0, dev_handle, (uint8_t)setup->Index, (uint8_t)setup->Value);
4032                         if (r == LIBUSB_SUCCESS)
4033                                 r = LIBUSB_COMPLETED;
4034                         break;
4035                 default:
4036                         usbi_warn(TRANSFER_CTX(transfer), "unsupported HID control request");
4037                         return LIBUSB_ERROR_NOT_SUPPORTED;
4038                 }
4039                 break;
4040         case LIBUSB_REQUEST_TYPE_CLASS:
4041                 r = _hid_class_request(dev_handle->dev, hid_handle, setup->RequestType, setup->Request, setup->Value,
4042                         setup->Index, transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE, transfer_priv,
4043                         size, overlapped);
4044                 break;
4045         default:
4046                 usbi_warn(TRANSFER_CTX(transfer), "unsupported HID control request");
4047                 return LIBUSB_ERROR_NOT_SUPPORTED;
4048         }
4049
4050         if (r < 0)
4051                 return r;
4052
4053         if (r == LIBUSB_COMPLETED) {
4054                 // Force request to be completed synchronously. Transferred size has been set by previous call
4055                 windows_force_sync_completion(itransfer, (ULONG)size);
4056                 r = LIBUSB_SUCCESS;
4057         }
4058
4059         transfer_priv->interface_number = (uint8_t)current_interface;
4060
4061         return LIBUSB_SUCCESS;
4062 }
4063
4064 static int hid_submit_bulk_transfer(int sub_api, struct usbi_transfer *itransfer)
4065 {
4066         struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
4067         struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
4068         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(transfer->dev_handle);
4069         struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
4070         HANDLE hid_handle;
4071         OVERLAPPED *overlapped;
4072         bool direction_in;
4073         BOOL ret;
4074         int current_interface, length;
4075
4076         UNUSED(sub_api);
4077         CHECK_HID_AVAILABLE;
4078
4079         if (IS_XFEROUT(transfer) && (transfer->flags & LIBUSB_TRANSFER_ADD_ZERO_PACKET))
4080                 return LIBUSB_ERROR_NOT_SUPPORTED;
4081
4082         transfer_priv->hid_dest = NULL;
4083         safe_free(transfer_priv->hid_buffer);
4084
4085         current_interface = interface_by_endpoint(priv, handle_priv, transfer->endpoint);
4086         if (current_interface < 0) {
4087                 usbi_err(TRANSFER_CTX(transfer), "unable to match endpoint to an open interface - cancelling transfer");
4088                 return LIBUSB_ERROR_NOT_FOUND;
4089         }
4090
4091         usbi_dbg("matched endpoint %02X with interface %d", transfer->endpoint, current_interface);
4092
4093         hid_handle = handle_priv->interface_handle[current_interface].api_handle;
4094         set_transfer_priv_handle(itransfer, hid_handle);
4095         overlapped = get_transfer_priv_overlapped(itransfer);
4096         direction_in = IS_XFERIN(transfer);
4097
4098         // If report IDs are not in use, an extra prefix byte must be added
4099         if (((direction_in) && (!priv->hid->uses_report_ids[0]))
4100                         || ((!direction_in) && (!priv->hid->uses_report_ids[1])))
4101                 length = transfer->length + 1;
4102         else
4103                 length = transfer->length;
4104
4105         // Add a trailing byte to detect overflows on input
4106         transfer_priv->hid_buffer = calloc(1, length + 1);
4107         if (transfer_priv->hid_buffer == NULL)
4108                 return LIBUSB_ERROR_NO_MEM;
4109
4110         transfer_priv->hid_expected_size = length;
4111
4112         if (direction_in) {
4113                 transfer_priv->hid_dest = transfer->buffer;
4114                 usbi_dbg("reading %d bytes (report ID: 0x00)", length);
4115                 ret = ReadFile(hid_handle, transfer_priv->hid_buffer, length + 1, NULL, overlapped);
4116         } else {
4117                 if (!priv->hid->uses_report_ids[1])
4118                         memcpy(transfer_priv->hid_buffer + 1, transfer->buffer, transfer->length);
4119                 else
4120                         // We could actually do without the calloc and memcpy in this case
4121                         memcpy(transfer_priv->hid_buffer, transfer->buffer, transfer->length);
4122
4123                 usbi_dbg("writing %d bytes (report ID: 0x%02X)", length, transfer_priv->hid_buffer[0]);
4124                 ret = WriteFile(hid_handle, transfer_priv->hid_buffer, length, NULL, overlapped);
4125         }
4126
4127         if (!ret && GetLastError() != ERROR_IO_PENDING) {
4128                 usbi_err(TRANSFER_CTX(transfer), "HID transfer failed: %s", windows_error_str(0));
4129                 safe_free(transfer_priv->hid_buffer);
4130                 return LIBUSB_ERROR_IO;
4131         }
4132
4133         transfer_priv->interface_number = (uint8_t)current_interface;
4134
4135         return LIBUSB_SUCCESS;
4136 }
4137
4138 static int hid_reset_device(int sub_api, struct libusb_device_handle *dev_handle)
4139 {
4140         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
4141         HANDLE hid_handle;
4142         int current_interface;
4143
4144         UNUSED(sub_api);
4145         CHECK_HID_AVAILABLE;
4146
4147         // Flushing the queues on all interfaces is the best we can achieve
4148         for (current_interface = 0; current_interface < USB_MAXINTERFACES; current_interface++) {
4149                 hid_handle = handle_priv->interface_handle[current_interface].api_handle;
4150                 if (HANDLE_VALID(hid_handle))
4151                         HidD_FlushQueue(hid_handle);
4152         }
4153
4154         return LIBUSB_SUCCESS;
4155 }
4156
4157 static int hid_clear_halt(int sub_api, struct libusb_device_handle *dev_handle, unsigned char endpoint)
4158 {
4159         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
4160         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
4161         HANDLE hid_handle;
4162         int current_interface;
4163
4164         UNUSED(sub_api);
4165         CHECK_HID_AVAILABLE;
4166
4167         current_interface = interface_by_endpoint(priv, handle_priv, endpoint);
4168         if (current_interface < 0) {
4169                 usbi_err(HANDLE_CTX(dev_handle), "unable to match endpoint to an open interface - cannot clear");
4170                 return LIBUSB_ERROR_NOT_FOUND;
4171         }
4172
4173         usbi_dbg("matched endpoint %02X with interface %d", endpoint, current_interface);
4174         hid_handle = handle_priv->interface_handle[current_interface].api_handle;
4175
4176         // No endpoint selection with Microsoft's implementation, so we try to flush the
4177         // whole interface. Should be OK for most case scenarios
4178         if (!HidD_FlushQueue(hid_handle)) {
4179                 usbi_err(HANDLE_CTX(dev_handle), "Flushing of HID queue failed: %s", windows_error_str(0));
4180                 // Device was probably disconnected
4181                 return LIBUSB_ERROR_NO_DEVICE;
4182         }
4183
4184         return LIBUSB_SUCCESS;
4185 }
4186
4187 // This extra function is only needed for HID
4188 static enum libusb_transfer_status hid_copy_transfer_data(int sub_api, struct usbi_transfer *itransfer, DWORD length)
4189 {
4190         struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
4191         struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
4192         enum libusb_transfer_status r = LIBUSB_TRANSFER_COMPLETED;
4193
4194         UNUSED(sub_api);
4195
4196         if (transfer_priv->hid_buffer != NULL) {
4197                 // If we have a valid hid_buffer, it means the transfer was async
4198                 if (transfer_priv->hid_dest != NULL) { // Data readout
4199                         if (length > 0) {
4200                                 // First, check for overflow
4201                                 if ((size_t)length > transfer_priv->hid_expected_size) {
4202                                         usbi_err(TRANSFER_CTX(transfer), "OVERFLOW!");
4203                                         length = (DWORD)transfer_priv->hid_expected_size;
4204                                         r = LIBUSB_TRANSFER_OVERFLOW;
4205                                 }
4206
4207                                 if (transfer_priv->hid_buffer[0] == 0) {
4208                                         // Discard the 1 byte report ID prefix
4209                                         length--;
4210                                         memcpy(transfer_priv->hid_dest, transfer_priv->hid_buffer + 1, length);
4211                                 } else {
4212                                         memcpy(transfer_priv->hid_dest, transfer_priv->hid_buffer, length);
4213                                 }
4214                         }
4215                         transfer_priv->hid_dest = NULL;
4216                 }
4217                 // For write, we just need to free the hid buffer
4218                 safe_free(transfer_priv->hid_buffer);
4219         }
4220
4221         itransfer->transferred += (int)length;
4222         return r;
4223 }
4224
4225
4226 /*
4227  * Composite API functions
4228  */
4229 static int composite_open(int sub_api, struct libusb_device_handle *dev_handle)
4230 {
4231         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
4232         int i, r = LIBUSB_ERROR_NOT_FOUND;
4233         // SUB_API_MAX + 1 as the SUB_API_MAX pos is used to indicate availability of HID
4234         bool available[SUB_API_MAX + 1];
4235
4236         UNUSED(sub_api);
4237
4238         for (i = 0; i < SUB_API_MAX + 1; i++)
4239                 available[i] = false;
4240
4241         for (i = 0; i < USB_MAXINTERFACES; i++) {
4242                 switch (priv->usb_interface[i].apib->id) {
4243                 case USB_API_WINUSBX:
4244                         if (priv->usb_interface[i].sub_api != SUB_API_NOTSET)
4245                                 available[priv->usb_interface[i].sub_api] = true;
4246                         break;
4247                 case USB_API_HID:
4248                         available[SUB_API_MAX] = true;
4249                         break;
4250                 default:
4251                         break;
4252                 }
4253         }
4254
4255         for (i = 0; i < SUB_API_MAX; i++) { // WinUSB-like drivers
4256                 if (available[i]) {
4257                         r = usb_api_backend[USB_API_WINUSBX].open(i, dev_handle);
4258                         if (r != LIBUSB_SUCCESS)
4259                                 return r;
4260                 }
4261         }
4262
4263         if (available[SUB_API_MAX]) { // HID driver
4264                 r = hid_open(SUB_API_NOTSET, dev_handle);
4265
4266                 // On Windows 10 version 1903 (OS Build 18362) and later Windows blocks attempts to
4267                 // open HID devices with a U2F usage unless running as administrator. We ignore this
4268                 // failure and proceed without the HID device opened.
4269                 if (r == LIBUSB_ERROR_ACCESS) {
4270                         usbi_dbg("ignoring access denied error while opening HID interface of composite device");
4271                         r = LIBUSB_SUCCESS;
4272                 }
4273         }
4274
4275         return r;
4276 }
4277
4278 static void composite_close(int sub_api, struct libusb_device_handle *dev_handle)
4279 {
4280         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
4281         int i;
4282         // SUB_API_MAX + 1 as the SUB_API_MAX pos is used to indicate availability of HID
4283         bool available[SUB_API_MAX + 1];
4284
4285         UNUSED(sub_api);
4286
4287         for (i = 0; i < SUB_API_MAX + 1; i++)
4288                 available[i] = false;
4289
4290         for (i = 0; i < USB_MAXINTERFACES; i++) {
4291                 switch (priv->usb_interface[i].apib->id) {
4292                 case USB_API_WINUSBX:
4293                         if (priv->usb_interface[i].sub_api != SUB_API_NOTSET)
4294                                 available[priv->usb_interface[i].sub_api] = true;
4295                         break;
4296                 case USB_API_HID:
4297                         available[SUB_API_MAX] = true;
4298                         break;
4299                 default:
4300                         break;
4301                 }
4302         }
4303
4304         for (i = 0; i < SUB_API_MAX; i++) { // WinUSB-like drivers
4305                 if (available[i])
4306                         usb_api_backend[USB_API_WINUSBX].close(i, dev_handle);
4307         }
4308
4309         if (available[SUB_API_MAX]) // HID driver
4310                 hid_close(SUB_API_NOTSET, dev_handle);
4311 }
4312
4313 static int composite_claim_interface(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface)
4314 {
4315         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
4316
4317         UNUSED(sub_api);
4318         CHECK_SUPPORTED_API(priv->usb_interface[iface].apib, claim_interface);
4319
4320         return priv->usb_interface[iface].apib->
4321                 claim_interface(priv->usb_interface[iface].sub_api, dev_handle, iface);
4322 }
4323
4324 static int composite_set_interface_altsetting(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface, uint8_t altsetting)
4325 {
4326         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
4327
4328         UNUSED(sub_api);
4329         CHECK_SUPPORTED_API(priv->usb_interface[iface].apib, set_interface_altsetting);
4330
4331         return priv->usb_interface[iface].apib->
4332                 set_interface_altsetting(priv->usb_interface[iface].sub_api, dev_handle, iface, altsetting);
4333 }
4334
4335 static int composite_release_interface(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface)
4336 {
4337         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
4338
4339         UNUSED(sub_api);
4340         CHECK_SUPPORTED_API(priv->usb_interface[iface].apib, release_interface);
4341
4342         return priv->usb_interface[iface].apib->
4343                 release_interface(priv->usb_interface[iface].sub_api, dev_handle, iface);
4344 }
4345
4346 static int composite_submit_control_transfer(int sub_api, struct usbi_transfer *itransfer)
4347 {
4348         struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
4349         struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
4350         struct libusb_config_descriptor *conf_desc;
4351         WINUSB_SETUP_PACKET *setup = (WINUSB_SETUP_PACKET *)transfer->buffer;
4352         int iface, pass, r;
4353
4354         UNUSED(sub_api);
4355
4356         // Interface shouldn't matter for control, but it does in practice, with Windows'
4357         // restrictions with regards to accessing HID keyboards and mice. Try to target
4358         // a specific interface first, if possible.
4359         switch (LIBUSB_REQ_RECIPIENT(setup->RequestType)) {
4360         case LIBUSB_RECIPIENT_INTERFACE:
4361                 iface = setup->Index & 0xFF;
4362                 break;
4363         case LIBUSB_RECIPIENT_ENDPOINT:
4364                 r = libusb_get_active_config_descriptor(transfer->dev_handle->dev, &conf_desc);
4365                 if (r == LIBUSB_SUCCESS) {
4366                         iface = get_interface_by_endpoint(conf_desc, (setup->Index & 0xFF));
4367                         libusb_free_config_descriptor(conf_desc);
4368                         break;
4369                 }
4370                 // No break if not able to determine interface
4371                 // Fall through
4372         default:
4373                 iface = -1;
4374                 break;
4375         }
4376
4377         // Try and target a specific interface if the control setup indicates such
4378         if ((iface >= 0) && (iface < USB_MAXINTERFACES)) {
4379                 usbi_dbg("attempting control transfer targeted to interface %d", iface);
4380                 if ((priv->usb_interface[iface].path != NULL)
4381                                 && (priv->usb_interface[iface].apib->submit_control_transfer != NULL)) {
4382                         r = priv->usb_interface[iface].apib->submit_control_transfer(priv->usb_interface[iface].sub_api, itransfer);
4383                         if (r == LIBUSB_SUCCESS)
4384                                 return r;
4385                 }
4386         }
4387
4388         // Either not targeted to a specific interface or no luck in doing so.
4389         // Try a 2 pass approach with all interfaces.
4390         for (pass = 0; pass < 2; pass++) {
4391                 for (iface = 0; iface < USB_MAXINTERFACES; iface++) {
4392                         if ((priv->usb_interface[iface].path != NULL)
4393                                         && (priv->usb_interface[iface].apib->submit_control_transfer != NULL)) {
4394                                 if ((pass == 0) && (priv->usb_interface[iface].restricted_functionality)) {
4395                                         usbi_dbg("trying to skip restricted interface #%d (HID keyboard or mouse?)", iface);
4396                                         continue;
4397                                 }
4398                                 usbi_dbg("using interface %d", iface);
4399                                 r = priv->usb_interface[iface].apib->submit_control_transfer(priv->usb_interface[iface].sub_api, itransfer);
4400                                 // If not supported on this API, it may be supported on another, so don't give up yet!!
4401                                 if (r == LIBUSB_ERROR_NOT_SUPPORTED)
4402                                         continue;
4403                                 return r;
4404                         }
4405                 }
4406         }
4407
4408         usbi_err(TRANSFER_CTX(transfer), "no libusb supported interfaces to complete request");
4409         return LIBUSB_ERROR_NOT_FOUND;
4410 }
4411
4412 static int composite_submit_bulk_transfer(int sub_api, struct usbi_transfer *itransfer)
4413 {
4414         struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
4415         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(transfer->dev_handle);
4416         struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
4417         int current_interface;
4418
4419         UNUSED(sub_api);
4420
4421         current_interface = interface_by_endpoint(priv, handle_priv, transfer->endpoint);
4422         if (current_interface < 0) {
4423                 usbi_err(TRANSFER_CTX(transfer), "unable to match endpoint to an open interface - cancelling transfer");
4424                 return LIBUSB_ERROR_NOT_FOUND;
4425         }
4426
4427         CHECK_SUPPORTED_API(priv->usb_interface[current_interface].apib, submit_bulk_transfer);
4428
4429         return priv->usb_interface[current_interface].apib->
4430                 submit_bulk_transfer(priv->usb_interface[current_interface].sub_api, itransfer);
4431 }
4432
4433 static int composite_submit_iso_transfer(int sub_api, struct usbi_transfer *itransfer)
4434 {
4435         struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
4436         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(transfer->dev_handle);
4437         struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
4438         int current_interface;
4439
4440         UNUSED(sub_api);
4441
4442         current_interface = interface_by_endpoint(priv, handle_priv, transfer->endpoint);
4443         if (current_interface < 0) {
4444                 usbi_err(TRANSFER_CTX(transfer), "unable to match endpoint to an open interface - cancelling transfer");
4445                 return LIBUSB_ERROR_NOT_FOUND;
4446         }
4447
4448         CHECK_SUPPORTED_API(priv->usb_interface[current_interface].apib, submit_iso_transfer);
4449
4450         return priv->usb_interface[current_interface].apib->
4451                 submit_iso_transfer(priv->usb_interface[current_interface].sub_api, itransfer);
4452 }
4453
4454 static int composite_clear_halt(int sub_api, struct libusb_device_handle *dev_handle, unsigned char endpoint)
4455 {
4456         struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
4457         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
4458         int current_interface;
4459
4460         UNUSED(sub_api);
4461
4462         current_interface = interface_by_endpoint(priv, handle_priv, endpoint);
4463         if (current_interface < 0) {
4464                 usbi_err(HANDLE_CTX(dev_handle), "unable to match endpoint to an open interface - cannot clear");
4465                 return LIBUSB_ERROR_NOT_FOUND;
4466         }
4467
4468         CHECK_SUPPORTED_API(priv->usb_interface[current_interface].apib, clear_halt);
4469
4470         return priv->usb_interface[current_interface].apib->
4471                 clear_halt(priv->usb_interface[current_interface].sub_api, dev_handle, endpoint);
4472 }
4473
4474 static int composite_cancel_transfer(int sub_api, struct usbi_transfer *itransfer)
4475 {
4476         struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
4477         struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
4478         struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
4479         int current_interface = transfer_priv->interface_number;
4480
4481         UNUSED(sub_api);
4482
4483         if ((current_interface < 0) || (current_interface >= USB_MAXINTERFACES)) {
4484                 usbi_err(TRANSFER_CTX(transfer), "program assertion failed - invalid interface_number");
4485                 return LIBUSB_ERROR_NOT_FOUND;
4486         }
4487
4488         CHECK_SUPPORTED_API(priv->usb_interface[current_interface].apib, cancel_transfer);
4489
4490         return priv->usb_interface[current_interface].apib->
4491                 cancel_transfer(priv->usb_interface[current_interface].sub_api, itransfer);
4492 }
4493
4494 static int composite_reset_device(int sub_api, struct libusb_device_handle *dev_handle)
4495 {
4496         struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
4497         int i, r;
4498         bool available[SUB_API_MAX];
4499
4500         UNUSED(sub_api);
4501
4502         for (i = 0; i < SUB_API_MAX; i++)
4503                 available[i] = false;
4504
4505         for (i = 0; i < USB_MAXINTERFACES; i++) {
4506                 if ((priv->usb_interface[i].apib->id == USB_API_WINUSBX)
4507                                 && (priv->usb_interface[i].sub_api != SUB_API_NOTSET))
4508                         available[priv->usb_interface[i].sub_api] = true;
4509         }
4510
4511         for (i = 0; i < SUB_API_MAX; i++) {
4512                 if (available[i]) {
4513                         r = usb_api_backend[USB_API_WINUSBX].reset_device(i, dev_handle);
4514                         if (r != LIBUSB_SUCCESS)
4515                                 return r;
4516                 }
4517         }
4518
4519         return LIBUSB_SUCCESS;
4520 }
4521
4522 static enum libusb_transfer_status composite_copy_transfer_data(int sub_api, struct usbi_transfer *itransfer, DWORD length)
4523 {
4524         struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
4525         struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
4526         struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
4527         int current_interface = transfer_priv->interface_number;
4528
4529         UNUSED(sub_api);
4530         if (priv->usb_interface[current_interface].apib->copy_transfer_data == NULL) {
4531                 usbi_err(TRANSFER_CTX(transfer), "program assertion failed - no function to copy transfer data");
4532                 return LIBUSB_TRANSFER_ERROR;
4533         }
4534
4535         return priv->usb_interface[current_interface].apib->
4536                 copy_transfer_data(priv->usb_interface[current_interface].sub_api, itransfer, length);
4537 }