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
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.
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.
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
34 #include "windows_winusb.h"
36 #define HANDLE_VALID(h) (((h) != NULL) && ((h) != INVALID_HANDLE_VALUE))
38 // The below macro is used in conjunction with safe loops.
39 #define LOOP_BREAK(err) \
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);
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);
88 static usbi_mutex_t autoclaim_lock;
91 static struct winusb_interface WinUSBX[SUB_API_MAX];
92 #define CHECK_WINUSBX_AVAILABLE(sub_api) \
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; \
100 #define CHECK_HID_AVAILABLE \
102 if (DLL_HANDLE_NAME(hid) == NULL) \
103 return LIBUSB_ERROR_ACCESS; \
106 #if defined(ENABLE_LOGGING)
107 static const char *guid_to_string(const GUID *guid, char guid_string[MAX_GUID_STRING_LENGTH])
110 guid_string[0] = '\0';
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]);
123 static bool string_to_guid(const char guid_string[MAX_GUID_STRING_LENGTH], GUID *guid)
125 unsigned short tmp[4];
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);
138 if ((r != 7) || (num_chars != 38))
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);
155 * Normalize Microsoft's paths: return a duplicate of the given path
156 * with all characters converted to uppercase
158 static char *normalize_path(const char *path)
160 char *ret_path = _strdup(path);
163 if (ret_path == NULL)
166 for (p = ret_path; *p != '\0'; p++)
167 *p = (char)toupper((unsigned char)*p);
173 * Cfgmgr32, AdvAPI32, OLE32 and SetupAPI DLL functions
175 static bool init_dlls(struct libusb_context *ctx)
177 DLL_GET_HANDLE(ctx, Cfgmgr32);
178 DLL_LOAD_FUNC(Cfgmgr32, CM_Get_Parent, true);
179 DLL_LOAD_FUNC(Cfgmgr32, CM_Get_Child, true);
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);
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);
200 static void exit_dlls(void)
202 DLL_FREE_HANDLE(SetupAPI);
203 DLL_FREE_HANDLE(AdvAPI32);
204 DLL_FREE_HANDLE(Cfgmgr32);
208 * enumerate interfaces for the whole USB class
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
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.
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)
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));
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));
238 pSetupDiDestroyDeviceInfoList(*dev_info);
239 *dev_info = INVALID_HANDLE_VALUE;
246 * enumerate interfaces for a specific GUID
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
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.
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)
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];
266 dev_info_data->cbSize = sizeof(SP_DEVINFO_DATA);
267 dev_interface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
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;
277 return LIBUSB_SUCCESS;
280 // Always advance the index for the next iteration
283 if (pSetupDiEnumDeviceInterfaces(dev_info, dev_info_data, guid, 0, &dev_interface_data))
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;
292 // Device does not have an interface matching this GUID, skip
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;
304 usbi_err(ctx, "program assertion failed - http://msdn.microsoft.com/en-us/library/ms792901.aspx is wrong");
305 return LIBUSB_ERROR_OTHER;
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;
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;
324 *dev_interface_path = normalize_path(dev_interface_details->DevicePath);
325 free(dev_interface_details);
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;
333 return LIBUSB_SUCCESS;
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)
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;
345 int err = LIBUSB_ERROR_OTHER;
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;
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));
363 pSetupDiDestroyDeviceInfoList(*dev_info);
364 *dev_info = INVALID_HANDLE_VALUE;
365 return LIBUSB_SUCCESS;
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));
377 usbi_err(ctx, "program assertion failed - http://msdn.microsoft.com/en-us/library/ms792901.aspx is wrong");
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;
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);
396 *dev_interface_path = normalize_path(dev_interface_details->DevicePath);
397 free(dev_interface_details);
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;
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);
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);
421 // libusb0.sys was connected to this device instance at one time; but not anymore.
424 pRegCloseKey(hkey_dev_interface);
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?
431 return LIBUSB_SUCCESS;
434 pSetupDiDestroyDeviceInfoList(*dev_info);
435 *dev_info = INVALID_HANDLE_VALUE;
440 * Returns the first known ancestor of a device
442 static struct libusb_device *get_ancestor(struct libusb_context *ctx,
443 DEVINST devinst, PDEVINST _parent_devinst)
445 struct libusb_device *dev = NULL;
446 DEVINST parent_devinst;
448 while (dev == NULL) {
449 if (CM_Get_Parent(&parent_devinst, devinst, 0) != CR_SUCCESS)
451 devinst = parent_devinst;
452 dev = usbi_get_device_by_session_id(ctx, (unsigned long)devinst);
455 if ((dev != NULL) && (_parent_devinst != NULL))
456 *_parent_devinst = devinst;
462 * Determine which interface the given endpoint address belongs to
464 static int get_interface_by_endpoint(struct libusb_config_descriptor *conf_desc, uint8_t ep)
466 const struct libusb_interface *intf;
467 const struct libusb_interface_descriptor *intf_desc;
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;
484 usbi_dbg("endpoint %02X not found on any interface", ep);
485 return LIBUSB_ERROR_NOT_FOUND;
489 * Open a device and associate the HANDLE with the context's I/O completion port
491 static HANDLE windows_open(struct libusb_device_handle *dev_handle, const char *path, DWORD access)
493 struct libusb_context *ctx = HANDLE_CTX(dev_handle);
494 struct windows_context_priv *priv = usbi_get_context_priv(ctx);
497 handle = CreateFileA(path, access, FILE_SHARE_READ | FILE_SHARE_WRITE, NULL, OPEN_EXISTING, FILE_FLAG_OVERLAPPED, NULL);
498 if (handle == INVALID_HANDLE_VALUE)
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));
504 return INVALID_HANDLE_VALUE;
511 * Populate the endpoints addresses of the device_priv interface helper structs
513 static int windows_assign_endpoints(struct libusb_device_handle *dev_handle, uint8_t iface, uint8_t altsetting)
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;
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);
526 if_desc = &conf_desc->interface[iface].altsetting[altsetting];
527 safe_free(priv->usb_interface[iface].endpoint);
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;
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;
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);
547 libusb_free_config_descriptor(conf_desc);
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);
553 if (r == LIBUSB_SUCCESS)
554 priv->usb_interface[iface].current_altsetting = altsetting;
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)
563 const char sep_str[2] = {LIST_SEPARATOR, 0};
565 size_t len = strlen(driver);
569 return SUB_API_NOTSET;
571 tmp_str = _strdup(driver);
573 return SUB_API_NOTSET;
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) {
583 tok = strtok(NULL, sep_str);
587 return SUB_API_NOTSET;
591 * auto-claiming and auto-release helper functions
593 static int auto_claim(struct libusb_transfer *transfer, int *interface_number, int api_type)
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;
602 case USB_API_WINUSBX:
606 return LIBUSB_ERROR_INVALID_PARAM;
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]++;
622 if (current_interface == USB_MAXINTERFACES) {
623 usbi_err(TRANSFER_CTX(transfer), "could not auto-claim any interface");
624 r = LIBUSB_ERROR_NOT_FOUND;
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]++;
632 usbi_mutex_unlock(&autoclaim_lock);
634 *interface_number = current_interface;
638 static void auto_release(struct usbi_transfer *itransfer)
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);
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);
654 usbi_dbg("failed to auto-release interface %d (%s)",
655 transfer_priv->interface_number, libusb_error_name((enum libusb_error)r));
658 usbi_mutex_unlock(&autoclaim_lock);
662 * init: libusb backend init function
664 static int winusb_init(struct libusb_context *ctx)
669 if (!init_dlls(ctx)) {
670 usbi_err(ctx, "could not resolve DLL functions");
671 return LIBUSB_ERROR_OTHER;
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);
681 // We need a lock for proper auto-release
682 usbi_mutex_init(&autoclaim_lock);
684 return LIBUSB_SUCCESS;
688 * exit: libusb backend deinitialization function
690 static void winusb_exit(struct libusb_context *ctx)
696 usbi_mutex_destroy(&autoclaim_lock);
698 for (i = 0; i < USB_API_MAX; i++) {
699 if (usb_api_backend[i].exit)
700 usb_api_backend[i].exit();
707 * fetch and cache all the config descriptors through I/O
709 static void cache_config_descriptors(struct libusb_device *dev, HANDLE hub_handle)
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;
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;
720 num_configurations = dev->device_descriptor.bNumConfigurations;
721 if (num_configurations == 0)
724 assert(sizeof(USB_DESCRIPTOR_REQUEST) == USB_DESCRIPTOR_REQUEST_SIZE);
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);
732 for (i = 0; i <= num_configurations; i++) {
733 safe_free(cd_buf_actual);
735 if (i == num_configurations)
738 size = sizeof(cd_buf_short);
739 memset(&cd_buf_short.desc, 0, sizeof(cd_buf_short.desc));
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);
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));
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);
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);
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;
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));
783 cd_data = (PUSB_CONFIGURATION_DESCRIPTOR)((UCHAR *)cd_buf_actual + USB_DESCRIPTOR_REQUEST_SIZE);
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);
790 if (cd_data->bDescriptorType != LIBUSB_DT_CONFIG) {
791 usbi_err(ctx, "descriptor %u not a configuration descriptor for '%s'", i, priv->dev_id);
795 usbi_dbg("cached config descriptor %u (bConfigurationValue=%u, %u bytes)",
796 i, cd_data->bConfigurationValue, cd_data->wTotalLength);
798 // Cache the descriptor
799 priv->config_descriptor[i] = cd_data;
800 cd_buf_actual = NULL;
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
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)
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
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
842 0x00, // bmAttributes
843 0x02, 0x00 // wBytesPerInterval
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)
849 struct winusb_device_priv *priv = usbi_get_device_priv(dev);
852 priv->config_descriptor = malloc(sizeof(*priv->config_descriptor));
853 if (priv->config_descriptor == NULL)
854 return LIBUSB_ERROR_NO_MEM;
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);
864 return LIBUSB_ERROR_NO_MEM;
866 ptr += USB_DESCRIPTOR_REQUEST_SIZE;
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;
873 priv->config_descriptor[0] = (PUSB_CONFIGURATION_DESCRIPTOR)ptr;
874 priv->active_config = 1;
879 static int init_root_hub(struct libusb_device *dev)
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;
890 ULONG port_number, num_ports;
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;
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));
908 return LIBUSB_ERROR_ACCESS;
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));
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));
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);
937 speed = MAX(speed, LIBUSB_SPEED_FULL);
940 if (speed != LIBUSB_SPEED_UNKNOWN)
941 goto make_descriptors;
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;
955 if (speed != LIBUSB_SPEED_UNKNOWN)
956 goto make_descriptors;
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));
970 if (conn_info.ConnectionStatus != DeviceConnected)
973 if (conn_info.Speed == UsbHighSpeed) {
974 speed = LIBUSB_SPEED_HIGH;
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;
989 dev->device_descriptor.bcdDevice = 0x0100;
990 dev->device_descriptor.bNumConfigurations = 1;
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
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
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
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;
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
1020 default: // Impossible, buts keeps compiler happy
1021 usbi_err(ctx, "program assertion failed - unknown root hub speed");
1022 return LIBUSB_ERROR_INVALID_PARAM;
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
1029 dev->device_descriptor.bMaxPacketSize0 = 0x40; // 64 bytes
1034 r = alloc_root_hub_config_desc(dev, num_ports, config_desc_length, ep_interval);
1036 usbi_err(ctx, "could not allocate config descriptor for root hub '%s'", priv->dev_id);
1042 * Populate a libusb device structure
1044 static int init_device(struct libusb_device *dev, struct libusb_device *parent_dev,
1045 uint8_t port_number, DEVINST devinst)
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;
1054 uint8_t bus_number, depth;
1058 priv = usbi_get_device_priv(dev);
1060 // If the device is already initialized, we can stop here
1061 if (priv->initialized)
1062 return LIBUSB_SUCCESS;
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;
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;
1080 libusb_unref_device(tmp_dev);
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;
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;
1093 libusb_unref_device(tmp_dev);
1096 depth = parent_priv->depth + 1;
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;
1104 dev->bus_number = bus_number;
1105 dev->port_number = port_number;
1106 dev->parent_dev = parent_dev;
1107 priv->depth = depth;
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;
1115 conn_info.ConnectionIndex = (ULONG)port_number;
1116 // coverity[tainted_data_argument]
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;
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;
1133 if ((conn_info.DeviceDescriptor.bLength != LIBUSB_DT_DEVICE_SIZE)
1134 || (conn_info.DeviceDescriptor.bDescriptorType != LIBUSB_DT_DEVICE)) {
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);
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);
1152 } while (priv->active_config == 0 && --ginfotimeout >= 0);
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;
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;
1169 usbi_dbg("found %u configurations (current config: %u)", dev->device_descriptor.bNumConfigurations, priv->active_config);
1172 // Cache as many config descriptors as we can
1173 cache_config_descriptors(dev, hub_handle);
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;
1191 CloseHandle(hub_handle);
1193 if (conn_info.DeviceAddress > UINT8_MAX)
1194 usbi_err(ctx, "program assertion failed - device address overflow");
1196 dev->device_address = (uint8_t)conn_info.DeviceAddress;
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;
1205 usbi_warn(ctx, "unknown device speed %u", conn_info.Speed);
1209 r = init_root_hub(dev);
1214 r = usbi_sanitize_device(dev);
1218 priv->initialized = true;
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);
1223 return LIBUSB_SUCCESS;
1226 static bool get_dev_port_number(HDEVINFO dev_info, SP_DEVINFO_DATA *dev_info_data, DWORD *port_nr)
1228 char buffer[MAX_KEY_LENGTH];
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);
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);
1255 // Shorten the string and try again.
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));
1267 static int enumerate_hcd_root_hub(struct libusb_context *ctx, const char *dev_id,
1268 uint8_t bus_number, DEVINST devinst)
1270 struct libusb_device *dev;
1271 struct winusb_device_priv *priv;
1272 unsigned long session_id;
1273 DEVINST child_devinst;
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;
1280 session_id = (unsigned long)child_devinst;
1281 dev = usbi_get_device_by_session_id(ctx, session_id);
1283 usbi_err(ctx, "program assertion failed - HCD '%s' child not found", dev_id);
1284 return LIBUSB_SUCCESS;
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;
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);
1295 priv = usbi_get_device_priv(dev);
1296 priv->root_hub = true;
1299 libusb_unref_device(dev);
1300 return LIBUSB_SUCCESS;
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)
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"}
1313 DWORD size, reg_type;
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 ®_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;
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;
1333 usbi_dbg("%s(s): %s", lookup[k].designation, lookup[k].list);
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;
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);
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]);
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)
1358 struct winusb_device_priv *priv = usbi_get_device_priv(dev);
1359 int interface_number;
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');
1369 usbi_warn(ctx, "failure to read interface number for %s, using default value", device_id);
1370 interface_number = 0;
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;
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;
1385 // In other cases, just use the latest data
1386 safe_free(priv->usb_interface[interface_number].path);
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;
1399 return LIBUSB_SUCCESS;
1402 static int set_hid_interface(struct libusb_context *ctx, struct libusb_device *dev,
1403 char *dev_interface_path)
1405 struct winusb_device_priv *priv = usbi_get_device_priv(dev);
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;
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;
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;
1431 * get_device_list: libusb backend device enumeration function
1433 static int winusb_get_device_list(struct libusb_context *ctx, struct discovered_devs **_discdevs)
1435 struct discovered_devs *discdevs;
1436 HDEVINFO *dev_info, dev_info_intf, dev_info_enum;
1437 SP_DEVINFO_DATA dev_info_data;
1440 int r = LIBUSB_SUCCESS;
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;
1451 char guid_string[MAX_GUID_STRING_LENGTH];
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;
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.
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;
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;
1498 guid_list[HID_PASS] = NULL;
1500 nb_guids = EXT_PASS;
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;
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));
1513 free((void *)guid_list);
1514 return LIBUSB_ERROR_OTHER;
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));
1523 if ((pass == HID_PASS) && (guid_list[HID_PASS] == NULL))
1526 dev_info = (pass != GEN_PASS) ? &dev_info_intf : &dev_info_enum;
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;
1535 // Safe loop: end of loop conditions
1536 if (r != LIBUSB_SUCCESS)
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);
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)) {
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))
1561 if (usb_enum_index == nb_usb_enumerators)
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));
1573 usbi_dbg("PRO: %s", dev_id);
1576 // Set API to use or get additional data from generic pass
1577 api = USB_API_UNSUPPORTED;
1578 sub_api = SUB_API_NOTSET;
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);
1591 for (j = 0; j < nb_usb_enumerators; j++) {
1592 if (strcmp(usb_enumerator[j], enumerator) == 0)
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++;
1602 usbi_err(ctx, "could not allocate enumerator string '%s'", enumerator);
1603 LOOP_BREAK(LIBUSB_ERROR_NO_MEM);
1606 usbi_warn(ctx, "too many enumerator strings, some devices may not be accessible");
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");
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)
1621 // Look for both DeviceInterfaceGUIDs *and* DeviceInterfaceGUID, in that order
1622 size = sizeof(guid_string);
1623 s = pRegQueryValueExA(key, "DeviceInterfaceGUIDs", NULL, ®_type,
1624 (LPBYTE)guid_string, &size);
1625 if (s == ERROR_FILE_NOT_FOUND)
1626 s = pRegQueryValueExA(key, "DeviceInterfaceGUID", NULL, ®_type,
1627 (LPBYTE)guid_string, &size);
1629 if ((s == ERROR_SUCCESS) &&
1630 (((reg_type == REG_SZ) && (size == (sizeof(guid_string) - sizeof(char)))) ||
1631 ((reg_type == REG_MULTI_SZ) && (size == sizeof(guid_string))))) {
1632 if (nb_guids == guid_size) {
1633 new_guid_list = realloc((void *)guid_list, (guid_size + GUID_SIZE_STEP) * sizeof(void *));
1634 if (new_guid_list == NULL) {
1635 usbi_err(ctx, "failed to realloc guid list");
1636 LOOP_BREAK(LIBUSB_ERROR_NO_MEM);
1638 guid_list = new_guid_list;
1639 guid_size += GUID_SIZE_STEP;
1641 if_guid = malloc(sizeof(*if_guid));
1642 if (if_guid == NULL) {
1643 usbi_err(ctx, "failed to alloc if_guid");
1644 LOOP_BREAK(LIBUSB_ERROR_NO_MEM);
1646 if (!string_to_guid(guid_string, if_guid)) {
1647 usbi_warn(ctx, "device '%s' has malformed DeviceInterfaceGUID string '%s', skipping", dev_id, guid_string);
1650 // Check if we've already seen this GUID
1651 for (j = EXT_PASS; j < nb_guids; j++) {
1652 if (memcmp(guid_list[j], if_guid, sizeof(*if_guid)) == 0)
1655 if (j == nb_guids) {
1656 usbi_dbg("extra GUID: %s", guid_string);
1657 guid_list[nb_guids++] = if_guid;
1659 // Duplicate, ignore
1663 } else if (s == ERROR_SUCCESS) {
1664 usbi_warn(ctx, "unexpected type/size of DeviceInterfaceGUID for '%s'", dev_id);
1671 // Get the API type (after checking that the driver installation is OK)
1672 if ((!pSetupDiGetDeviceRegistryPropertyA(*dev_info, &dev_info_data, SPDRP_INSTALL_STATE,
1673 NULL, (PBYTE)&install_state, sizeof(install_state), &size)) || (size != sizeof(install_state))) {
1674 usbi_warn(ctx, "could not detect installation state of driver for '%s': %s",
1675 dev_id, windows_error_str(0));
1676 } else if (install_state != 0) {
1677 usbi_warn(ctx, "driver for device '%s' is reporting an issue (code: %lu) - skipping",
1678 dev_id, ULONG_CAST(install_state));
1681 get_api_type(dev_info, &dev_info_data, &api, &sub_api);
1685 // Find parent device (for the passes that need it)
1686 if (pass >= GEN_PASS) {
1687 parent_dev = get_ancestor(ctx, dev_info_data.DevInst, NULL);
1688 if (parent_dev == NULL) {
1689 // Root hubs will not have a parent
1690 dev = usbi_get_device_by_session_id(ctx, (unsigned long)dev_info_data.DevInst);
1692 priv = usbi_get_device_priv(dev);
1695 libusb_unref_device(dev);
1698 usbi_dbg("unlisted ancestor for '%s' (non USB HID, newly connected, etc.) - ignoring", dev_id);
1702 parent_priv = usbi_get_device_priv(parent_dev);
1703 // virtual USB devices are also listed during GEN - don't process these yet
1704 if ((pass == GEN_PASS) && (parent_priv->apib->id != USB_API_HUB)) {
1705 libusb_unref_device(parent_dev);
1710 // Create new or match existing device, using the devInst as session id
1711 if ((pass <= GEN_PASS) && (pass != HCD_PASS)) { // For subsequent passes, we'll lookup the parent
1712 // These are the passes that create "new" devices
1713 session_id = (unsigned long)dev_info_data.DevInst;
1714 dev = usbi_get_device_by_session_id(ctx, session_id);
1717 usbi_dbg("allocating new device for session [%lX]", session_id);
1718 dev = usbi_alloc_device(ctx, session_id);
1720 LOOP_BREAK(LIBUSB_ERROR_NO_MEM);
1722 priv = winusb_device_priv_init(dev);
1723 priv->dev_id = _strdup(dev_id);
1724 priv->class_guid = dev_info_data.ClassGuid;
1725 if (priv->dev_id == NULL) {
1726 libusb_unref_device(dev);
1727 LOOP_BREAK(LIBUSB_ERROR_NO_MEM);
1730 usbi_dbg("found existing device for session [%lX]", session_id);
1732 priv = usbi_get_device_priv(dev);
1733 if (strcmp(priv->dev_id, dev_id) != 0) {
1734 usbi_dbg("device instance ID for session [%lX] changed", session_id);
1735 usbi_disconnect_device(dev);
1736 libusb_unref_device(dev);
1739 if (!IsEqualGUID(&priv->class_guid, &dev_info_data.ClassGuid)) {
1740 usbi_dbg("device class GUID for session [%lX] changed", session_id);
1741 usbi_disconnect_device(dev);
1742 libusb_unref_device(dev);
1748 // Keep track of devices that need unref
1749 if (unref_cur == unref_size) {
1750 new_unref_list = realloc(unref_list, (unref_size + UNREF_SIZE_STEP) * sizeof(void *));
1751 if (new_unref_list == NULL) {
1752 usbi_err(ctx, "could not realloc list for unref - aborting");
1753 LOOP_BREAK(LIBUSB_ERROR_NO_MEM);
1755 unref_list = new_unref_list;
1756 unref_size += UNREF_SIZE_STEP;
1758 unref_list[unref_cur++] = dev;
1765 // If the device has already been setup, don't do it again
1766 if (priv->path != NULL)
1768 // Take care of API initialization
1769 priv->path = dev_interface_path;
1770 dev_interface_path = NULL;
1771 priv->apib = &usb_api_backend[api];
1772 priv->sub_api = sub_api;
1774 case USB_API_COMPOSITE:
1778 priv->hid = calloc(1, sizeof(struct hid_device_priv));
1779 if (priv->hid == NULL)
1780 LOOP_BREAK(LIBUSB_ERROR_NO_MEM);
1783 // For other devices, the first interface is the same as the device
1784 priv->usb_interface[0].path = _strdup(priv->path);
1785 if (priv->usb_interface[0].path == NULL)
1786 LOOP_BREAK(LIBUSB_ERROR_NO_MEM);
1787 // The following is needed if we want API calls to work for both simple
1788 // and composite devices.
1789 for (j = 0; j < USB_MAXINTERFACES; j++)
1790 priv->usb_interface[j].apib = &usb_api_backend[api];
1795 r = enumerate_hcd_root_hub(ctx, dev_id, (uint8_t)(i + 1), dev_info_data.DevInst);
1799 if (!get_dev_port_number(*dev_info, &dev_info_data, &port_nr))
1800 usbi_warn(ctx, "could not retrieve port number for device '%s': %s", dev_id, windows_error_str(0));
1801 r = init_device(dev, parent_dev, (uint8_t)port_nr, dev_info_data.DevInst);
1802 if (r == LIBUSB_SUCCESS) {
1803 // Append device to the list of discovered devices
1804 discdevs = discovered_devs_append(*_discdevs, dev);
1806 LOOP_BREAK(LIBUSB_ERROR_NO_MEM);
1808 *_discdevs = discdevs;
1810 // Failed to initialize a single device doesn't stop us from enumerating all other devices,
1811 // but we skip it (don't add to list of discovered devices)
1812 usbi_warn(ctx, "failed to initialize device '%s'", priv->dev_id);
1816 default: // HID_PASS and later
1817 if (parent_priv->apib->id == USB_API_HID || parent_priv->apib->id == USB_API_COMPOSITE) {
1818 if (parent_priv->apib->id == USB_API_HID) {
1819 usbi_dbg("setting HID interface for [%lX]:", parent_dev->session_data);
1820 r = set_hid_interface(ctx, parent_dev, dev_interface_path);
1822 usbi_dbg("setting composite interface for [%lX]:", parent_dev->session_data);
1823 r = set_composite_interface(ctx, parent_dev, dev_interface_path, dev_id, api, sub_api);
1826 case LIBUSB_SUCCESS:
1827 dev_interface_path = NULL;
1829 case LIBUSB_ERROR_ACCESS:
1830 // interface has already been set => make sure dev_interface_path is freed then
1838 libusb_unref_device(parent_dev);
1844 pSetupDiDestroyDeviceInfoList(dev_info_intf);
1846 // Free any additional GUIDs
1847 for (pass = EXT_PASS; pass < nb_guids; pass++)
1848 free((void *)guid_list[pass]);
1849 free((void *)guid_list);
1851 // Free any PnP enumerator strings
1852 for (i = 1; i < nb_usb_enumerators; i++)
1853 free((void *)usb_enumerator[i]);
1855 // Unref newly allocated devs
1856 for (i = 0; i < unref_cur; i++)
1857 libusb_unref_device(unref_list[i]);
1863 static int winusb_get_config_descriptor(struct libusb_device *dev, uint8_t config_index, void *buffer, size_t len)
1865 struct winusb_device_priv *priv = usbi_get_device_priv(dev);
1866 PUSB_CONFIGURATION_DESCRIPTOR config_header;
1868 if ((priv->config_descriptor == NULL) || (priv->config_descriptor[config_index] == NULL))
1869 return LIBUSB_ERROR_NOT_FOUND;
1871 config_header = priv->config_descriptor[config_index];
1873 len = MIN(len, config_header->wTotalLength);
1874 memcpy(buffer, config_header, len);
1878 static int winusb_get_config_descriptor_by_value(struct libusb_device *dev, uint8_t bConfigurationValue,
1881 struct winusb_device_priv *priv = usbi_get_device_priv(dev);
1882 PUSB_CONFIGURATION_DESCRIPTOR config_header;
1885 if (priv->config_descriptor == NULL)
1886 return LIBUSB_ERROR_NOT_FOUND;
1888 for (index = 0; index < dev->device_descriptor.bNumConfigurations; index++) {
1889 config_header = priv->config_descriptor[index];
1890 if (config_header == NULL)
1892 if (config_header->bConfigurationValue == bConfigurationValue) {
1893 *buffer = config_header;
1894 return (int)config_header->wTotalLength;
1898 return LIBUSB_ERROR_NOT_FOUND;
1902 * return the cached copy of the active config descriptor
1904 static int winusb_get_active_config_descriptor(struct libusb_device *dev, void *buffer, size_t len)
1906 struct winusb_device_priv *priv = usbi_get_device_priv(dev);
1910 if (priv->active_config == 0)
1911 return LIBUSB_ERROR_NOT_FOUND;
1913 r = winusb_get_config_descriptor_by_value(dev, priv->active_config, &config_desc);
1917 len = MIN(len, (size_t)r);
1918 memcpy(buffer, config_desc, len);
1922 static int winusb_open(struct libusb_device_handle *dev_handle)
1924 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
1926 CHECK_SUPPORTED_API(priv->apib, open);
1928 return priv->apib->open(SUB_API_NOTSET, dev_handle);
1931 static void winusb_close(struct libusb_device_handle *dev_handle)
1933 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
1935 if (priv->apib->close)
1936 priv->apib->close(SUB_API_NOTSET, dev_handle);
1939 static int winusb_get_configuration(struct libusb_device_handle *dev_handle, uint8_t *config)
1941 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
1943 *config = priv->active_config;
1944 return LIBUSB_SUCCESS;
1948 * from http://msdn.microsoft.com/en-us/library/ms793522.aspx: "The port driver
1949 * does not currently expose a service that allows higher-level drivers to set
1950 * the configuration."
1952 static int winusb_set_configuration(struct libusb_device_handle *dev_handle, uint8_t config)
1954 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
1955 int r = LIBUSB_SUCCESS;
1957 r = libusb_control_transfer(dev_handle, LIBUSB_ENDPOINT_OUT |
1958 LIBUSB_REQUEST_TYPE_STANDARD | LIBUSB_RECIPIENT_DEVICE,
1959 LIBUSB_REQUEST_SET_CONFIGURATION, config,
1962 if (r == LIBUSB_SUCCESS)
1963 priv->active_config = config;
1968 static int winusb_claim_interface(struct libusb_device_handle *dev_handle, uint8_t iface)
1970 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
1973 CHECK_SUPPORTED_API(priv->apib, claim_interface);
1975 safe_free(priv->usb_interface[iface].endpoint);
1976 priv->usb_interface[iface].nb_endpoints = 0;
1978 r = priv->apib->claim_interface(SUB_API_NOTSET, dev_handle, iface);
1980 if (r == LIBUSB_SUCCESS)
1981 r = windows_assign_endpoints(dev_handle, iface, 0);
1986 static int winusb_set_interface_altsetting(struct libusb_device_handle *dev_handle, uint8_t iface, uint8_t altsetting)
1988 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
1991 CHECK_SUPPORTED_API(priv->apib, set_interface_altsetting);
1993 safe_free(priv->usb_interface[iface].endpoint);
1994 priv->usb_interface[iface].nb_endpoints = 0;
1996 r = priv->apib->set_interface_altsetting(SUB_API_NOTSET, dev_handle, iface, altsetting);
1998 if (r == LIBUSB_SUCCESS)
1999 r = windows_assign_endpoints(dev_handle, iface, altsetting);
2004 static int winusb_release_interface(struct libusb_device_handle *dev_handle, uint8_t iface)
2006 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2008 CHECK_SUPPORTED_API(priv->apib, release_interface);
2010 return priv->apib->release_interface(SUB_API_NOTSET, dev_handle, iface);
2013 static int winusb_clear_halt(struct libusb_device_handle *dev_handle, unsigned char endpoint)
2015 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2017 CHECK_SUPPORTED_API(priv->apib, clear_halt);
2019 return priv->apib->clear_halt(SUB_API_NOTSET, dev_handle, endpoint);
2022 static int winusb_reset_device(struct libusb_device_handle *dev_handle)
2024 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2026 CHECK_SUPPORTED_API(priv->apib, reset_device);
2028 return priv->apib->reset_device(SUB_API_NOTSET, dev_handle);
2031 static void winusb_destroy_device(struct libusb_device *dev)
2033 winusb_device_priv_release(dev);
2036 static void winusb_clear_transfer_priv(struct usbi_transfer *itransfer)
2038 struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
2039 struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2040 struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
2041 int sub_api = priv->sub_api;
2043 safe_free(transfer_priv->hid_buffer);
2045 if (transfer->type == LIBUSB_TRANSFER_TYPE_ISOCHRONOUS && sub_api == SUB_API_WINUSB) {
2046 if (transfer_priv->isoch_buffer_handle != NULL) {
2047 if (WinUSBX[sub_api].UnregisterIsochBuffer(transfer_priv->isoch_buffer_handle)) {
2048 transfer_priv->isoch_buffer_handle = NULL;
2050 usbi_warn(TRANSFER_CTX(transfer), "failed to unregister WinUSB isoch buffer: %s", windows_error_str(0));
2055 safe_free(transfer_priv->iso_context);
2057 // When auto claim is in use, attempt to release the auto-claimed interface
2058 auto_release(itransfer);
2061 static int winusb_submit_transfer(struct usbi_transfer *itransfer)
2063 struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2064 struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
2065 int (*transfer_fn)(int, struct usbi_transfer *);
2067 switch (transfer->type) {
2068 case LIBUSB_TRANSFER_TYPE_CONTROL:
2069 transfer_fn = priv->apib->submit_control_transfer;
2071 case LIBUSB_TRANSFER_TYPE_BULK:
2072 case LIBUSB_TRANSFER_TYPE_INTERRUPT:
2073 transfer_fn = priv->apib->submit_bulk_transfer;
2075 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
2076 transfer_fn = priv->apib->submit_iso_transfer;
2079 // Should not get here since windows_submit_transfer() validates
2080 // the transfer->type field
2081 usbi_err(TRANSFER_CTX(transfer), "unknown endpoint type %d", transfer->type);
2082 return LIBUSB_ERROR_INVALID_PARAM;
2085 if (transfer_fn == NULL) {
2086 usbi_warn(TRANSFER_CTX(transfer),
2087 "unsupported transfer type %d (unrecognized device driver)",
2089 return LIBUSB_ERROR_NOT_SUPPORTED;
2092 return transfer_fn(SUB_API_NOTSET, itransfer);
2095 static int winusb_cancel_transfer(struct usbi_transfer *itransfer)
2097 struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2098 struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
2100 CHECK_SUPPORTED_API(priv->apib, cancel_transfer);
2102 return priv->apib->cancel_transfer(SUB_API_NOTSET, itransfer);
2105 static enum libusb_transfer_status winusb_copy_transfer_data(struct usbi_transfer *itransfer, DWORD length)
2107 struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2108 struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
2110 if (priv->apib->copy_transfer_data == NULL) {
2111 usbi_err(TRANSFER_CTX(transfer), "program assertion failed - no function to copy transfer data");
2112 return LIBUSB_TRANSFER_ERROR;
2115 return priv->apib->copy_transfer_data(SUB_API_NOTSET, itransfer, length);
2118 // NB: MSVC6 does not support named initializers.
2119 const struct windows_backend winusb_backend = {
2122 winusb_get_device_list,
2125 winusb_get_active_config_descriptor,
2126 winusb_get_config_descriptor,
2127 winusb_get_config_descriptor_by_value,
2128 winusb_get_configuration,
2129 winusb_set_configuration,
2130 winusb_claim_interface,
2131 winusb_release_interface,
2132 winusb_set_interface_altsetting,
2134 winusb_reset_device,
2135 winusb_destroy_device,
2136 winusb_submit_transfer,
2137 winusb_cancel_transfer,
2138 winusb_clear_transfer_priv,
2139 winusb_copy_transfer_data,
2146 static const char * const composite_driver_names[] = {"USBCCGP"};
2147 static const char * const winusbx_driver_names[] = {"libusbK", "libusb0", "WinUSB"};
2148 static const char * const hid_driver_names[] = {"HIDUSB", "MOUHID", "KBDHID"};
2149 const struct windows_usb_api_backend usb_api_backend[USB_API_MAX] = {
2151 USB_API_UNSUPPORTED,
2153 NULL, /* driver_name_list */
2154 0, /* nb_driver_names */
2159 NULL, /* configure_endpoints */
2160 NULL, /* claim_interface */
2161 NULL, /* set_interface_altsetting */
2162 NULL, /* release_interface */
2163 NULL, /* clear_halt */
2164 NULL, /* reset_device */
2165 NULL, /* submit_bulk_transfer */
2166 NULL, /* submit_iso_transfer */
2167 NULL, /* submit_control_transfer */
2168 NULL, /* cancel_transfer */
2169 NULL, /* copy_transfer_data */
2174 NULL, /* driver_name_list */
2175 0, /* nb_driver_names */
2180 NULL, /* configure_endpoints */
2181 NULL, /* claim_interface */
2182 NULL, /* set_interface_altsetting */
2183 NULL, /* release_interface */
2184 NULL, /* clear_halt */
2185 NULL, /* reset_device */
2186 NULL, /* submit_bulk_transfer */
2187 NULL, /* submit_iso_transfer */
2188 NULL, /* submit_control_transfer */
2189 NULL, /* cancel_transfer */
2190 NULL, /* copy_transfer_data */
2195 composite_driver_names,
2196 ARRAYSIZE(composite_driver_names),
2201 NULL, /* configure_endpoints */
2202 composite_claim_interface,
2203 composite_set_interface_altsetting,
2204 composite_release_interface,
2205 composite_clear_halt,
2206 composite_reset_device,
2207 composite_submit_bulk_transfer,
2208 composite_submit_iso_transfer,
2209 composite_submit_control_transfer,
2210 composite_cancel_transfer,
2211 composite_copy_transfer_data,
2216 winusbx_driver_names,
2217 ARRAYSIZE(winusbx_driver_names),
2222 winusbx_configure_endpoints,
2223 winusbx_claim_interface,
2224 winusbx_set_interface_altsetting,
2225 winusbx_release_interface,
2227 winusbx_reset_device,
2228 winusbx_submit_bulk_transfer,
2229 winusbx_submit_iso_transfer,
2230 winusbx_submit_control_transfer,
2231 winusbx_cancel_transfer,
2232 winusbx_copy_transfer_data,
2238 ARRAYSIZE(hid_driver_names),
2243 NULL, /* configure_endpoints */
2244 hid_claim_interface,
2245 hid_set_interface_altsetting,
2246 hid_release_interface,
2249 hid_submit_bulk_transfer,
2250 NULL, /* submit_iso_transfer */
2251 hid_submit_control_transfer,
2252 NULL, /* cancel_transfer */
2253 hid_copy_transfer_data,
2259 * WinUSB-like (WinUSB, libusb0/libusbK through libusbk DLL) API functions
2261 #define WinUSB_Set(h, fn, required) \
2263 WinUSBX[SUB_API_WINUSB].fn = (WinUsb_##fn##_t)GetProcAddress(h, "WinUsb_" #fn); \
2264 if (required && (WinUSBX[SUB_API_WINUSB].fn == NULL)) { \
2265 usbi_err(ctx, "GetProcAddress() failed for WinUsb_%s", #fn); \
2266 goto cleanup_winusb; \
2270 #define libusbK_Set(sub_api, fn, required) \
2272 pLibK_GetProcAddress((PVOID *)&WinUSBX[sub_api].fn, sub_api, KUSB_FNID_##fn); \
2273 if (required && (WinUSBX[sub_api].fn == NULL)) { \
2274 usbi_err(ctx, "LibK_GetProcAddress() failed for LibK_%s", #fn); \
2275 goto cleanup_libusbk; \
2279 static bool winusbx_init(struct libusb_context *ctx)
2281 HMODULE hWinUSB, hlibusbK;
2283 hWinUSB = load_system_library(ctx, "WinUSB");
2284 if (hWinUSB != NULL) {
2285 WinUSB_Set(hWinUSB, AbortPipe, true);
2286 WinUSB_Set(hWinUSB, ControlTransfer, true);
2287 WinUSB_Set(hWinUSB, FlushPipe, true);
2288 WinUSB_Set(hWinUSB, Free, true);
2289 WinUSB_Set(hWinUSB, GetAssociatedInterface, true);
2290 WinUSB_Set(hWinUSB, Initialize, true);
2291 WinUSB_Set(hWinUSB, ReadPipe, true);
2292 WinUSB_Set(hWinUSB, ResetPipe, true);
2293 WinUSB_Set(hWinUSB, SetCurrentAlternateSetting, true);
2294 WinUSB_Set(hWinUSB, SetPipePolicy, true);
2295 WinUSB_Set(hWinUSB, WritePipe, true);
2297 // Check for isochronous transfers support (available starting with Windows 8.1)
2298 WinUSB_Set(hWinUSB, ReadIsochPipeAsap, false);
2299 if (WinUSBX[SUB_API_WINUSB].ReadIsochPipeAsap != NULL) {
2300 WinUSB_Set(hWinUSB, QueryPipeEx, true);
2301 WinUSB_Set(hWinUSB, RegisterIsochBuffer, true);
2302 WinUSB_Set(hWinUSB, UnregisterIsochBuffer, true);
2303 WinUSB_Set(hWinUSB, WriteIsochPipeAsap, true);
2306 WinUSBX[SUB_API_WINUSB].hDll = hWinUSB;
2308 usbi_info(ctx, "WinUSB DLL available (%s isoch support)",
2309 (WinUSBX[SUB_API_WINUSB].ReadIsochPipeAsap != NULL) ? "with" : "without");
2312 if (WinUSBX[SUB_API_WINUSB].hDll == NULL) {
2313 usbi_err(ctx, "failed to initialize WinUSB");
2314 memset(&WinUSBX[SUB_API_WINUSB], 0, sizeof(WinUSBX[SUB_API_WINUSB]));
2315 FreeLibrary(hWinUSB);
2319 usbi_info(ctx, "WinUSB DLL is not available");
2322 hlibusbK = load_system_library(ctx, "libusbK");
2323 if (hlibusbK != NULL) {
2324 LibK_GetVersion_t pLibK_GetVersion;
2325 LibK_GetProcAddress_t pLibK_GetProcAddress;
2328 pLibK_GetVersion = (LibK_GetVersion_t)GetProcAddress(hlibusbK, "LibK_GetVersion");
2329 if (pLibK_GetVersion != NULL) {
2330 KLIB_VERSION LibK_Version;
2332 pLibK_GetVersion(&LibK_Version);
2333 usbi_dbg("libusbK DLL found, version: %d.%d.%d.%d", LibK_Version.Major, LibK_Version.Minor,
2334 LibK_Version.Micro, LibK_Version.Nano);
2336 usbi_dbg("libusbK DLL found, version unknown");
2339 pLibK_GetProcAddress = (LibK_GetProcAddress_t)GetProcAddress(hlibusbK, "LibK_GetProcAddress");
2340 if (pLibK_GetProcAddress == NULL) {
2341 usbi_err(ctx, "LibK_GetProcAddress() not found in libusbK DLL");
2342 goto cleanup_libusbk;
2345 // NB: The below for loop works because the sub_api value for WinUSB
2346 // is a higher value than that of libusbK and libusb0
2347 for (; sub_api < SUB_API_WINUSB; sub_api++) {
2348 libusbK_Set(sub_api, AbortPipe, true);
2349 libusbK_Set(sub_api, ControlTransfer, true);
2350 libusbK_Set(sub_api, FlushPipe, true);
2351 libusbK_Set(sub_api, Free, true);
2352 libusbK_Set(sub_api, GetAssociatedInterface, true);
2353 libusbK_Set(sub_api, Initialize, true);
2354 libusbK_Set(sub_api, ReadPipe, true);
2355 libusbK_Set(sub_api, ResetPipe, true);
2356 libusbK_Set(sub_api, SetCurrentAlternateSetting, true);
2357 libusbK_Set(sub_api, SetPipePolicy, true);
2358 libusbK_Set(sub_api, WritePipe, true);
2360 // Optional isochronous support
2361 libusbK_Set(sub_api, IsoReadPipe, false);
2362 if (WinUSBX[sub_api].IsoReadPipe != NULL)
2363 libusbK_Set(sub_api, IsoWritePipe, true);
2365 // Optional device reset support
2366 libusbK_Set(sub_api, ResetDevice, false);
2368 WinUSBX[sub_api].hDll = hlibusbK;
2372 if (sub_api < SUB_API_WINUSB) {
2373 usbi_err(ctx, "failed to initialize libusbK");
2374 while (sub_api >= 0) {
2375 memset(&WinUSBX[sub_api], 0, sizeof(WinUSBX[sub_api]));
2378 FreeLibrary(hlibusbK);
2382 usbi_info(ctx, "libusbK DLL is not available");
2385 if ((hWinUSB == NULL) && (hlibusbK == NULL)) {
2386 usbi_warn(ctx, "neither WinUSB nor libusbK DLLs were found, "
2387 "you will not be able to access devices outside of enumeration");
2394 static void winusbx_exit(void)
2396 bool loaded = false;
2399 hDll = WinUSBX[SUB_API_LIBUSBK].hDll;
2405 hDll = WinUSBX[SUB_API_WINUSB].hDll;
2411 // Reset the WinUSBX API structures if something was loaded
2413 memset(&WinUSBX, 0, sizeof(WinUSBX));
2416 // NB: open and close must ensure that they only handle interface of
2417 // the right API type, as these functions can be called wholesale from
2418 // composite_open(), with interfaces belonging to different APIs
2419 static int winusbx_open(int sub_api, struct libusb_device_handle *dev_handle)
2421 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2422 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
2426 CHECK_WINUSBX_AVAILABLE(sub_api);
2428 // WinUSB requires a separate handle for each interface
2429 for (i = 0; i < USB_MAXINTERFACES; i++) {
2430 if ((priv->usb_interface[i].path != NULL)
2431 && (priv->usb_interface[i].apib->id == USB_API_WINUSBX)) {
2432 file_handle = windows_open(dev_handle, priv->usb_interface[i].path, GENERIC_READ | GENERIC_WRITE);
2433 if (file_handle == INVALID_HANDLE_VALUE) {
2434 usbi_err(HANDLE_CTX(dev_handle), "could not open device %s (interface %d): %s", priv->usb_interface[i].path, i, windows_error_str(0));
2435 switch (GetLastError()) {
2436 case ERROR_FILE_NOT_FOUND: // The device was disconnected
2437 return LIBUSB_ERROR_NO_DEVICE;
2438 case ERROR_ACCESS_DENIED:
2439 return LIBUSB_ERROR_ACCESS;
2441 return LIBUSB_ERROR_IO;
2445 handle_priv->interface_handle[i].dev_handle = file_handle;
2449 return LIBUSB_SUCCESS;
2452 static void winusbx_close(int sub_api, struct libusb_device_handle *dev_handle)
2454 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
2455 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2459 if (sub_api == SUB_API_NOTSET)
2460 sub_api = priv->sub_api;
2462 if (WinUSBX[sub_api].hDll == NULL)
2465 if (priv->apib->id == USB_API_COMPOSITE) {
2466 // If this is a composite device, just free and close all WinUSB-like
2467 // interfaces directly (each is independent and not associated with another)
2468 for (i = 0; i < USB_MAXINTERFACES; i++) {
2469 if (priv->usb_interface[i].apib->id == USB_API_WINUSBX) {
2470 handle = handle_priv->interface_handle[i].api_handle;
2471 if (HANDLE_VALID(handle))
2472 WinUSBX[sub_api].Free(handle);
2474 handle = handle_priv->interface_handle[i].dev_handle;
2475 if (HANDLE_VALID(handle))
2476 CloseHandle(handle);
2480 // If this is a WinUSB device, free all interfaces above interface 0,
2481 // then free and close interface 0 last
2482 for (i = 1; i < USB_MAXINTERFACES; i++) {
2483 handle = handle_priv->interface_handle[i].api_handle;
2484 if (HANDLE_VALID(handle))
2485 WinUSBX[sub_api].Free(handle);
2487 handle = handle_priv->interface_handle[0].api_handle;
2488 if (HANDLE_VALID(handle))
2489 WinUSBX[sub_api].Free(handle);
2491 handle = handle_priv->interface_handle[0].dev_handle;
2492 if (HANDLE_VALID(handle))
2493 CloseHandle(handle);
2497 static int winusbx_configure_endpoints(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface)
2499 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
2500 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2501 HANDLE winusb_handle = handle_priv->interface_handle[iface].api_handle;
2504 uint8_t endpoint_address;
2507 CHECK_WINUSBX_AVAILABLE(sub_api);
2509 // With handle and endpoints set (in parent), we can setup the default pipe properties
2510 // see http://download.microsoft.com/download/D/1/D/D1DD7745-426B-4CC3-A269-ABBBE427C0EF/DVC-T705_DDC08.pptx
2511 for (i = -1; i < priv->usb_interface[iface].nb_endpoints; i++) {
2512 endpoint_address = (i == -1) ? 0 : priv->usb_interface[iface].endpoint[i];
2513 if (!WinUSBX[sub_api].SetPipePolicy(winusb_handle, endpoint_address,
2514 PIPE_TRANSFER_TIMEOUT, sizeof(ULONG), &timeout))
2515 usbi_dbg("failed to set PIPE_TRANSFER_TIMEOUT for control endpoint %02X", endpoint_address);
2517 if ((i == -1) || (sub_api == SUB_API_LIBUSB0))
2518 continue; // Other policies don't apply to control endpoint or libusb0
2521 handle_priv->interface_handle[iface].zlp[endpoint_address] = WINUSB_ZLP_UNSET;
2522 if (!WinUSBX[sub_api].SetPipePolicy(winusb_handle, endpoint_address,
2523 SHORT_PACKET_TERMINATE, sizeof(UCHAR), &policy))
2524 usbi_dbg("failed to disable SHORT_PACKET_TERMINATE for endpoint %02X", endpoint_address);
2526 if (!WinUSBX[sub_api].SetPipePolicy(winusb_handle, endpoint_address,
2527 IGNORE_SHORT_PACKETS, sizeof(UCHAR), &policy))
2528 usbi_dbg("failed to disable IGNORE_SHORT_PACKETS for endpoint %02X", endpoint_address);
2531 /* ALLOW_PARTIAL_READS must be enabled due to likely libusbK bug. See:
2532 https://sourceforge.net/mailarchive/message.php?msg_id=29736015 */
2533 if (!WinUSBX[sub_api].SetPipePolicy(winusb_handle, endpoint_address,
2534 ALLOW_PARTIAL_READS, sizeof(UCHAR), &policy))
2535 usbi_dbg("failed to enable ALLOW_PARTIAL_READS for endpoint %02X", endpoint_address);
2537 if (!WinUSBX[sub_api].SetPipePolicy(winusb_handle, endpoint_address,
2538 AUTO_CLEAR_STALL, sizeof(UCHAR), &policy))
2539 usbi_dbg("failed to enable AUTO_CLEAR_STALL for endpoint %02X", endpoint_address);
2541 if (sub_api == SUB_API_LIBUSBK) {
2542 if (!WinUSBX[sub_api].SetPipePolicy(winusb_handle, endpoint_address,
2543 ISO_ALWAYS_START_ASAP, sizeof(UCHAR), &policy))
2544 usbi_dbg("failed to enable ISO_ALWAYS_START_ASAP for endpoint %02X", endpoint_address);
2548 return LIBUSB_SUCCESS;
2551 static int winusbx_claim_interface(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface)
2553 struct libusb_context *ctx = HANDLE_CTX(dev_handle);
2554 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
2555 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2556 bool is_using_usbccgp = (priv->apib->id == USB_API_COMPOSITE);
2558 char *dev_interface_path = NULL;
2559 char *dev_interface_path_guid_start;
2560 char filter_path[] = "\\\\.\\libusb0-0000";
2561 bool found_filter = false;
2562 HANDLE file_handle, winusb_handle;
2566 CHECK_WINUSBX_AVAILABLE(sub_api);
2568 // If the device is composite, but using the default Windows composite parent driver (usbccgp)
2569 // or if it's the first WinUSB-like interface, we get a handle through Initialize().
2570 if ((is_using_usbccgp) || (iface == 0)) {
2571 // composite device (independent interfaces) or interface 0
2572 file_handle = handle_priv->interface_handle[iface].dev_handle;
2573 if (!HANDLE_VALID(file_handle))
2574 return LIBUSB_ERROR_NOT_FOUND;
2576 if (!WinUSBX[sub_api].Initialize(file_handle, &winusb_handle)) {
2577 handle_priv->interface_handle[iface].api_handle = INVALID_HANDLE_VALUE;
2578 err = GetLastError();
2580 case ERROR_BAD_COMMAND:
2581 // The device was disconnected
2582 usbi_err(ctx, "could not access interface %u: %s", iface, windows_error_str(0));
2583 return LIBUSB_ERROR_NO_DEVICE;
2585 // it may be that we're using the libusb0 filter driver.
2586 // TODO: can we move this whole business into the K/0 DLL?
2588 for (_index = 0; ; _index++) {
2589 safe_free(dev_interface_path);
2594 r = get_interface_details_filter(ctx, &dev_info, _index, filter_path, &dev_interface_path);
2595 if ((r != LIBUSB_SUCCESS) || (dev_interface_path == NULL))
2599 dev_interface_path_guid_start = strchr(dev_interface_path, '{');
2600 if (dev_interface_path_guid_start == NULL)
2602 *dev_interface_path_guid_start = '\0';
2604 if (strncmp(dev_interface_path, priv->usb_interface[iface].path, strlen(dev_interface_path)) == 0) {
2605 file_handle = windows_open(dev_handle, filter_path, GENERIC_READ | GENERIC_WRITE);
2606 if (file_handle != INVALID_HANDLE_VALUE) {
2607 if (WinUSBX[sub_api].Initialize(file_handle, &winusb_handle)) {
2608 // Replace the existing file handle with the working one
2609 CloseHandle(handle_priv->interface_handle[iface].dev_handle);
2610 handle_priv->interface_handle[iface].dev_handle = file_handle;
2611 found_filter = true;
2613 usbi_err(ctx, "could not initialize filter driver for %s", filter_path);
2614 CloseHandle(file_handle);
2617 usbi_err(ctx, "could not open device %s: %s", filter_path, windows_error_str(0));
2621 if (r != LIBUSB_SUCCESS)
2623 if (!found_filter) {
2624 usbi_err(ctx, "could not access interface %u: %s", iface, windows_error_str(err));
2625 return LIBUSB_ERROR_ACCESS;
2629 handle_priv->interface_handle[iface].api_handle = winusb_handle;
2631 // For all other interfaces, use GetAssociatedInterface()
2632 winusb_handle = handle_priv->interface_handle[0].api_handle;
2633 // It is a requirement for multiple interface devices on Windows that, to you
2634 // must first claim the first interface before you claim the others
2635 if (!HANDLE_VALID(winusb_handle)) {
2636 file_handle = handle_priv->interface_handle[0].dev_handle;
2637 if (WinUSBX[sub_api].Initialize(file_handle, &winusb_handle)) {
2638 handle_priv->interface_handle[0].api_handle = winusb_handle;
2639 usbi_warn(ctx, "auto-claimed interface 0 (required to claim %u with WinUSB)", iface);
2641 usbi_warn(ctx, "failed to auto-claim interface 0 (required to claim %u with WinUSB): %s", iface, windows_error_str(0));
2642 return LIBUSB_ERROR_ACCESS;
2645 if (!WinUSBX[sub_api].GetAssociatedInterface(winusb_handle, (UCHAR)(iface - 1),
2646 &handle_priv->interface_handle[iface].api_handle)) {
2647 handle_priv->interface_handle[iface].api_handle = INVALID_HANDLE_VALUE;
2648 switch (GetLastError()) {
2649 case ERROR_NO_MORE_ITEMS: // invalid iface
2650 return LIBUSB_ERROR_NOT_FOUND;
2651 case ERROR_BAD_COMMAND: // The device was disconnected
2652 return LIBUSB_ERROR_NO_DEVICE;
2653 case ERROR_ALREADY_EXISTS: // already claimed
2654 return LIBUSB_ERROR_BUSY;
2656 usbi_err(ctx, "could not claim interface %u: %s", iface, windows_error_str(0));
2657 return LIBUSB_ERROR_ACCESS;
2660 handle_priv->interface_handle[iface].dev_handle = handle_priv->interface_handle[0].dev_handle;
2662 usbi_dbg("claimed interface %u", iface);
2663 handle_priv->active_interface = iface;
2665 return LIBUSB_SUCCESS;
2668 static int winusbx_release_interface(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface)
2670 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
2671 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2672 HANDLE winusb_handle;
2674 CHECK_WINUSBX_AVAILABLE(sub_api);
2676 winusb_handle = handle_priv->interface_handle[iface].api_handle;
2677 if (!HANDLE_VALID(winusb_handle))
2678 return LIBUSB_ERROR_NOT_FOUND;
2680 WinUSBX[sub_api].Free(winusb_handle);
2681 handle_priv->interface_handle[iface].api_handle = INVALID_HANDLE_VALUE;
2683 return LIBUSB_SUCCESS;
2687 * Return the first valid interface (of the same API type), for control transfers
2689 static int get_valid_interface(struct libusb_device_handle *dev_handle, int api_id)
2691 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
2692 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2695 if ((api_id < USB_API_WINUSBX) || (api_id > USB_API_HID)) {
2696 usbi_dbg("unsupported API ID");
2700 for (i = 0; i < USB_MAXINTERFACES; i++) {
2701 if (HANDLE_VALID(handle_priv->interface_handle[i].dev_handle)
2702 && HANDLE_VALID(handle_priv->interface_handle[i].api_handle)
2703 && (priv->usb_interface[i].apib->id == api_id))
2711 * Check a specific interface is valid (of the same API type), for control transfers
2713 static int check_valid_interface(struct libusb_device_handle *dev_handle, unsigned short interface, int api_id)
2715 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
2716 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2718 if (interface >= USB_MAXINTERFACES)
2721 if ((api_id < USB_API_WINUSBX) || (api_id > USB_API_HID)) {
2722 usbi_dbg("unsupported API ID");
2726 // try the requested interface
2727 if (HANDLE_VALID(handle_priv->interface_handle[interface].dev_handle)
2728 && HANDLE_VALID(handle_priv->interface_handle[interface].api_handle)
2729 && (priv->usb_interface[interface].apib->id == api_id))
2736 * Lookup interface by endpoint address. -1 if not found
2738 static int interface_by_endpoint(struct winusb_device_priv *priv,
2739 struct winusb_device_handle_priv *handle_priv, uint8_t endpoint_address)
2743 for (i = 0; i < USB_MAXINTERFACES; i++) {
2744 if (!HANDLE_VALID(handle_priv->interface_handle[i].api_handle))
2746 if (priv->usb_interface[i].endpoint == NULL)
2748 for (j = 0; j < priv->usb_interface[i].nb_endpoints; j++) {
2749 if (priv->usb_interface[i].endpoint[j] == endpoint_address)
2757 static int winusbx_submit_control_transfer(int sub_api, struct usbi_transfer *itransfer)
2759 struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2760 struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
2761 struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
2762 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(transfer->dev_handle);
2763 PWINUSB_SETUP_PACKET setup = (PWINUSB_SETUP_PACKET)transfer->buffer;
2765 HANDLE winusb_handle;
2766 OVERLAPPED *overlapped;
2767 int current_interface;
2769 CHECK_WINUSBX_AVAILABLE(sub_api);
2771 size = transfer->length - LIBUSB_CONTROL_SETUP_SIZE;
2773 // Windows places upper limits on the control transfer size
2774 // See: https://docs.microsoft.com/en-us/windows-hardware/drivers/usbcon/usb-bandwidth-allocation#maximum-transfer-size
2775 if (size > MAX_CTRL_BUFFER_LENGTH)
2776 return LIBUSB_ERROR_INVALID_PARAM;
2778 if ((setup->RequestType & 0x1F) == LIBUSB_RECIPIENT_INTERFACE)
2779 current_interface = check_valid_interface(transfer->dev_handle, setup->Index & 0xff, USB_API_WINUSBX);
2781 current_interface = get_valid_interface(transfer->dev_handle, USB_API_WINUSBX);
2782 if (current_interface < 0) {
2783 if (auto_claim(transfer, ¤t_interface, USB_API_WINUSBX) != LIBUSB_SUCCESS)
2784 return LIBUSB_ERROR_NOT_FOUND;
2787 usbi_dbg("will use interface %d", current_interface);
2789 winusb_handle = handle_priv->interface_handle[current_interface].api_handle;
2790 set_transfer_priv_handle(itransfer, handle_priv->interface_handle[current_interface].dev_handle);
2791 overlapped = get_transfer_priv_overlapped(itransfer);
2793 // Sending of set configuration control requests from WinUSB creates issues, except when using libusb0.sys
2794 if (sub_api != SUB_API_LIBUSB0
2795 && (LIBUSB_REQ_TYPE(setup->RequestType) == LIBUSB_REQUEST_TYPE_STANDARD)
2796 && (setup->Request == LIBUSB_REQUEST_SET_CONFIGURATION)) {
2797 if (setup->Value != priv->active_config) {
2798 usbi_warn(TRANSFER_CTX(transfer), "cannot set configuration other than the default one");
2799 return LIBUSB_ERROR_NOT_SUPPORTED;
2801 windows_force_sync_completion(itransfer, 0);
2803 if (!WinUSBX[sub_api].ControlTransfer(winusb_handle, *setup, transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE, size, NULL, overlapped)) {
2804 if (GetLastError() != ERROR_IO_PENDING) {
2805 usbi_warn(TRANSFER_CTX(transfer), "ControlTransfer failed: %s", windows_error_str(0));
2806 return LIBUSB_ERROR_IO;
2811 transfer_priv->interface_number = (uint8_t)current_interface;
2813 return LIBUSB_SUCCESS;
2816 static int winusbx_set_interface_altsetting(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface, uint8_t altsetting)
2818 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
2819 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
2820 HANDLE winusb_handle;
2822 CHECK_WINUSBX_AVAILABLE(sub_api);
2824 winusb_handle = handle_priv->interface_handle[iface].api_handle;
2825 if (!HANDLE_VALID(winusb_handle)) {
2826 usbi_err(HANDLE_CTX(dev_handle), "interface must be claimed first");
2827 return LIBUSB_ERROR_NOT_FOUND;
2830 if (!WinUSBX[sub_api].SetCurrentAlternateSetting(winusb_handle, altsetting)) {
2831 usbi_err(HANDLE_CTX(dev_handle), "SetCurrentAlternateSetting failed: %s", windows_error_str(0));
2832 return LIBUSB_ERROR_IO;
2835 return LIBUSB_SUCCESS;
2839 static void WINAPI winusbx_native_iso_transfer_continue_stream_callback(struct libusb_transfer *transfer)
2841 // If this callback is invoked, this means that we attempted to set ContinueStream
2842 // to TRUE when calling Read/WriteIsochPipeAsap in winusbx_do_iso_transfer.
2843 // The role of this callback is to fallback to ContinueStream = FALSE if the transfer
2846 struct winusb_transfer_priv *transfer_priv =
2847 get_winusb_transfer_priv(LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer));
2848 bool fallback = (transfer->status != LIBUSB_TRANSFER_COMPLETED);
2851 // Restore the user callback
2852 transfer->callback = transfer_priv->iso_user_callback;
2854 for (idx = 0; idx < transfer->num_iso_packets && !fallback; idx++) {
2855 if (transfer->iso_packet_desc[idx].status != LIBUSB_TRANSFER_COMPLETED)
2860 // If the transfer was successful, we restore the user callback and call it.
2861 if (transfer->callback)
2862 transfer->callback(transfer);
2864 // If the transfer wasn't successful we reschedule the transfer while forcing it
2865 // not to continue the stream. This might results in a 5-ms delay.
2866 transfer_priv->iso_break_stream = TRUE;
2867 libusb_submit_transfer(transfer);
2870 static int winusbx_submit_iso_transfer(int sub_api, struct usbi_transfer *itransfer)
2872 struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2873 struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
2874 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(transfer->dev_handle);
2875 struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
2876 HANDLE winusb_handle;
2877 OVERLAPPED *overlapped;
2879 int current_interface;
2881 CHECK_WINUSBX_AVAILABLE(sub_api);
2883 current_interface = interface_by_endpoint(priv, handle_priv, transfer->endpoint);
2884 if (current_interface < 0) {
2885 usbi_err(TRANSFER_CTX(transfer), "unable to match endpoint to an open interface - cancelling transfer");
2886 return LIBUSB_ERROR_NOT_FOUND;
2889 usbi_dbg("matched endpoint %02X with interface %d", transfer->endpoint, current_interface);
2891 winusb_handle = handle_priv->interface_handle[current_interface].api_handle;
2892 set_transfer_priv_handle(itransfer, handle_priv->interface_handle[current_interface].dev_handle);
2893 overlapped = get_transfer_priv_overlapped(itransfer);
2895 if ((sub_api == SUB_API_LIBUSBK) || (sub_api == SUB_API_LIBUSB0)) {
2898 size_t iso_ctx_size;
2899 PKISO_CONTEXT iso_context;
2901 if (WinUSBX[sub_api].IsoReadPipe == NULL) {
2902 usbi_warn(TRANSFER_CTX(transfer), "libusbK DLL does not support isoch transfers");
2903 return LIBUSB_ERROR_NOT_SUPPORTED;
2906 iso_ctx_size = sizeof(KISO_CONTEXT) + (transfer->num_iso_packets * sizeof(KISO_PACKET));
2907 transfer_priv->iso_context = iso_context = calloc(1, iso_ctx_size);
2908 if (transfer_priv->iso_context == NULL)
2909 return LIBUSB_ERROR_NO_MEM;
2912 iso_context->StartFrame = 0;
2913 iso_context->NumberOfPackets = (SHORT)transfer->num_iso_packets;
2915 // convert the transfer packet lengths to iso_packet offsets
2917 for (i = 0; i < transfer->num_iso_packets; i++) {
2918 iso_context->IsoPackets[i].offset = offset;
2919 offset += transfer->iso_packet_desc[i].length;
2922 if (IS_XFERIN(transfer)) {
2923 usbi_dbg("reading %d iso packets", transfer->num_iso_packets);
2924 ret = WinUSBX[sub_api].IsoReadPipe(winusb_handle, transfer->endpoint, transfer->buffer, transfer->length, overlapped, iso_context);
2926 usbi_dbg("writing %d iso packets", transfer->num_iso_packets);
2927 ret = WinUSBX[sub_api].IsoWritePipe(winusb_handle, transfer->endpoint, transfer->buffer, transfer->length, overlapped, iso_context);
2930 if (!ret && GetLastError() != ERROR_IO_PENDING) {
2931 usbi_err(TRANSFER_CTX(transfer), "IsoReadPipe/IsoWritePipe failed: %s", windows_error_str(0));
2932 return LIBUSB_ERROR_IO;
2935 transfer_priv->interface_number = (uint8_t)current_interface;
2937 return LIBUSB_SUCCESS;
2938 } else if (sub_api == SUB_API_WINUSB) {
2939 WINUSB_PIPE_INFORMATION_EX pipe_info_ex = { 0 };
2940 WINUSB_ISOCH_BUFFER_HANDLE buffer_handle;
2941 ULONG iso_transfer_size_multiple;
2942 int out_transfer_length = 0;
2945 // Depending on the version of Microsoft WinUSB, isochronous transfers may not be supported.
2946 if (WinUSBX[sub_api].ReadIsochPipeAsap == NULL) {
2947 usbi_warn(TRANSFER_CTX(transfer), "WinUSB DLL does not support isoch transfers");
2948 return LIBUSB_ERROR_NOT_SUPPORTED;
2951 if (sizeof(struct libusb_iso_packet_descriptor) != sizeof(USBD_ISO_PACKET_DESCRIPTOR)) {
2952 usbi_err(TRANSFER_CTX(transfer), "size of WinUsb and libusb isoch packet descriptors don't match");
2953 return LIBUSB_ERROR_NOT_SUPPORTED;
2956 // Query the pipe extended information to find the pipe index corresponding to the endpoint.
2957 for (idx = 0; idx < priv->usb_interface[current_interface].nb_endpoints; ++idx) {
2958 ret = WinUSBX[sub_api].QueryPipeEx(winusb_handle, (UINT8)priv->usb_interface[current_interface].current_altsetting, (UCHAR)idx, &pipe_info_ex);
2960 usbi_err(TRANSFER_CTX(transfer), "couldn't query interface settings for USB pipe with index %d. Error: %s", idx, windows_error_str(0));
2961 return LIBUSB_ERROR_NOT_FOUND;
2964 if (pipe_info_ex.PipeId == transfer->endpoint && pipe_info_ex.PipeType == UsbdPipeTypeIsochronous)
2968 // Make sure we found the index.
2969 if (idx == priv->usb_interface[current_interface].nb_endpoints) {
2970 usbi_err(TRANSFER_CTX(transfer), "couldn't find isoch endpoint 0x%02x", transfer->endpoint);
2971 return LIBUSB_ERROR_NOT_FOUND;
2974 if (IS_XFERIN(transfer)) {
2975 int interval = pipe_info_ex.Interval;
2977 // For high-speed and SuperSpeed device, the interval is 2**(bInterval-1).
2978 if (transfer->dev_handle->dev->speed >= LIBUSB_SPEED_HIGH)
2979 interval = (1 << (pipe_info_ex.Interval - 1));
2981 // WinUSB only supports isoch transfers spanning a full USB frames. Later, we might be smarter about this
2982 // and allocate a temporary buffer. However, this is harder than it seems as its destruction would depend on overlapped
2984 iso_transfer_size_multiple = (pipe_info_ex.MaximumBytesPerInterval * 8) / interval;
2985 if (transfer->length % iso_transfer_size_multiple != 0) {
2986 usbi_err(TRANSFER_CTX(transfer), "length of isoch buffer must be a multiple of the MaximumBytesPerInterval * 8 / Interval");
2987 return LIBUSB_ERROR_INVALID_PARAM;
2990 // If this is an OUT transfer, we make sure the isoch packets are contiguous as this isn't supported otherwise.
2991 bool size_should_be_zero = false;
2993 for (idx = 0; idx < transfer->num_iso_packets; ++idx) {
2994 if ((size_should_be_zero && transfer->iso_packet_desc[idx].length != 0) ||
2995 (transfer->iso_packet_desc[idx].length != pipe_info_ex.MaximumBytesPerInterval && idx + 1 < transfer->num_iso_packets && transfer->iso_packet_desc[idx + 1].length > 0)) {
2996 usbi_err(TRANSFER_CTX(transfer), "isoch packets for OUT transfer with WinUSB must be contiguous in memory");
2997 return LIBUSB_ERROR_INVALID_PARAM;
3000 size_should_be_zero = (transfer->iso_packet_desc[idx].length == 0);
3001 out_transfer_length += transfer->iso_packet_desc[idx].length;
3005 if (transfer_priv->isoch_buffer_handle != NULL) {
3006 if (WinUSBX[sub_api].UnregisterIsochBuffer(transfer_priv->isoch_buffer_handle)) {
3007 transfer_priv->isoch_buffer_handle = NULL;
3009 usbi_err(TRANSFER_CTX(transfer), "failed to unregister WinUSB isoch buffer: %s", windows_error_str(0));
3010 return LIBUSB_ERROR_OTHER;
3014 // Register the isoch buffer to the operating system.
3015 ret = WinUSBX[sub_api].RegisterIsochBuffer(winusb_handle, transfer->endpoint, transfer->buffer, transfer->length, &buffer_handle);
3017 usbi_err(TRANSFER_CTX(transfer), "failed to register WinUSB isoch buffer: %s", windows_error_str(0));
3018 return LIBUSB_ERROR_NO_MEM;
3021 // Important note: the WinUSB_Read/WriteIsochPipeAsap API requires a ContinueStream parameter that tells whether the isochronous
3022 // stream must be continued or if the WinUSB driver can schedule the transfer at its convenience. Profiling subsequent transfers
3023 // with ContinueStream = FALSE showed that 5 frames, i.e. about 5 milliseconds, were left empty between each transfer. This
3024 // is critical as this greatly diminish the achievable isochronous bandwidth. We solved the problem using the following strategy:
3025 // - Transfers are first scheduled with ContinueStream = TRUE and with winusbx_iso_transfer_continue_stream_callback as user callback.
3026 // - If the transfer succeeds, winusbx_iso_transfer_continue_stream_callback restore the user callback and calls its.
3027 // - If the transfer fails, winusbx_iso_transfer_continue_stream_callback reschedule the transfer and force ContinueStream = FALSE.
3028 if (!transfer_priv->iso_break_stream) {
3029 transfer_priv->iso_user_callback = transfer->callback;
3030 transfer->callback = winusbx_native_iso_transfer_continue_stream_callback;
3033 // Initiate the transfers.
3034 if (IS_XFERIN(transfer))
3035 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);
3037 ret = WinUSBX[sub_api].WriteIsochPipeAsap(buffer_handle, 0, out_transfer_length, !transfer_priv->iso_break_stream, overlapped);
3039 if (!ret && GetLastError() != ERROR_IO_PENDING) {
3040 usbi_err(TRANSFER_CTX(transfer), "ReadIsochPipeAsap/WriteIsochPipeAsap failed: %s", windows_error_str(0));
3041 if (!WinUSBX[sub_api].UnregisterIsochBuffer(buffer_handle))
3042 usbi_warn(TRANSFER_CTX(transfer), "failed to unregister WinUSB isoch buffer: %s", windows_error_str(0));
3043 return LIBUSB_ERROR_IO;
3046 // Restore the ContinueStream parameter to TRUE.
3047 transfer_priv->iso_break_stream = FALSE;
3049 transfer_priv->isoch_buffer_handle = buffer_handle;
3051 transfer_priv->interface_number = (uint8_t)current_interface;
3053 return LIBUSB_SUCCESS;
3055 PRINT_UNSUPPORTED_API(winusbx_submit_iso_transfer);
3056 return LIBUSB_ERROR_NOT_SUPPORTED;
3060 static int winusbx_submit_bulk_transfer(int sub_api, struct usbi_transfer *itransfer)
3062 struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
3063 struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
3064 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(transfer->dev_handle);
3065 struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
3066 HANDLE winusb_handle;
3067 OVERLAPPED *overlapped;
3069 int current_interface;
3071 CHECK_WINUSBX_AVAILABLE(sub_api);
3073 current_interface = interface_by_endpoint(priv, handle_priv, transfer->endpoint);
3074 if (current_interface < 0) {
3075 usbi_err(TRANSFER_CTX(transfer), "unable to match endpoint to an open interface - cancelling transfer");
3076 return LIBUSB_ERROR_NOT_FOUND;
3079 usbi_dbg("matched endpoint %02X with interface %d", transfer->endpoint, current_interface);
3081 winusb_handle = handle_priv->interface_handle[current_interface].api_handle;
3082 set_transfer_priv_handle(itransfer, handle_priv->interface_handle[current_interface].dev_handle);
3083 overlapped = get_transfer_priv_overlapped(itransfer);
3085 if (IS_XFERIN(transfer)) {
3086 usbi_dbg("reading %d bytes", transfer->length);
3087 ret = WinUSBX[sub_api].ReadPipe(winusb_handle, transfer->endpoint, transfer->buffer, transfer->length, NULL, overlapped);
3089 // Set SHORT_PACKET_TERMINATE if ZLP requested.
3090 // Changing this can be a problem with packets in flight, so only allow on the first transfer.
3091 UCHAR policy = (transfer->flags & LIBUSB_TRANSFER_ADD_ZERO_PACKET) != 0;
3092 uint8_t* current_zlp = &handle_priv->interface_handle[current_interface].zlp[transfer->endpoint];
3093 if (*current_zlp == WINUSB_ZLP_UNSET) {
3095 !WinUSBX[sub_api].SetPipePolicy(winusb_handle, transfer->endpoint,
3096 SHORT_PACKET_TERMINATE, sizeof(UCHAR), &policy)) {
3097 usbi_err(TRANSFER_CTX(transfer), "failed to set SHORT_PACKET_TERMINATE for endpoint %02X", transfer->endpoint);
3098 return LIBUSB_ERROR_NOT_SUPPORTED;
3100 *current_zlp = policy ? WINUSB_ZLP_ON : WINUSB_ZLP_OFF;
3101 } else if (policy != (*current_zlp == WINUSB_ZLP_ON)) {
3102 usbi_err(TRANSFER_CTX(transfer), "cannot change ZERO_PACKET for endpoint %02X on Windows", transfer->endpoint);
3103 return LIBUSB_ERROR_NOT_SUPPORTED;
3106 usbi_dbg("writing %d bytes", transfer->length);
3107 ret = WinUSBX[sub_api].WritePipe(winusb_handle, transfer->endpoint, transfer->buffer, transfer->length, NULL, overlapped);
3110 if (!ret && GetLastError() != ERROR_IO_PENDING) {
3111 usbi_err(TRANSFER_CTX(transfer), "ReadPipe/WritePipe failed: %s", windows_error_str(0));
3112 return LIBUSB_ERROR_IO;
3115 transfer_priv->interface_number = (uint8_t)current_interface;
3117 return LIBUSB_SUCCESS;
3120 static int winusbx_clear_halt(int sub_api, struct libusb_device_handle *dev_handle, unsigned char endpoint)
3122 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
3123 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
3124 HANDLE winusb_handle;
3125 int current_interface;
3127 CHECK_WINUSBX_AVAILABLE(sub_api);
3129 current_interface = interface_by_endpoint(priv, handle_priv, endpoint);
3130 if (current_interface < 0) {
3131 usbi_err(HANDLE_CTX(dev_handle), "unable to match endpoint to an open interface - cannot clear");
3132 return LIBUSB_ERROR_NOT_FOUND;
3135 usbi_dbg("matched endpoint %02X with interface %d", endpoint, current_interface);
3136 winusb_handle = handle_priv->interface_handle[current_interface].api_handle;
3138 if (!WinUSBX[sub_api].ResetPipe(winusb_handle, endpoint)) {
3139 usbi_err(HANDLE_CTX(dev_handle), "ResetPipe failed: %s", windows_error_str(0));
3140 return LIBUSB_ERROR_NO_DEVICE;
3143 return LIBUSB_SUCCESS;
3146 static int winusbx_cancel_transfer(int sub_api, struct usbi_transfer *itransfer)
3148 struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
3149 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(transfer->dev_handle);
3150 struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
3151 struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
3152 int current_interface = transfer_priv->interface_number;
3155 CHECK_WINUSBX_AVAILABLE(sub_api);
3157 usbi_dbg("will use interface %d", current_interface);
3159 handle = handle_priv->interface_handle[current_interface].api_handle;
3160 if (!WinUSBX[sub_api].AbortPipe(handle, transfer->endpoint)) {
3161 usbi_err(TRANSFER_CTX(transfer), "AbortPipe failed: %s", windows_error_str(0));
3162 return LIBUSB_ERROR_NO_DEVICE;
3165 return LIBUSB_SUCCESS;
3169 * from the "How to Use WinUSB to Communicate with a USB Device" Microsoft white paper
3170 * (http://www.microsoft.com/whdc/connect/usb/winusb_howto.mspx):
3171 * "WinUSB does not support host-initiated reset port and cycle port operations" and
3172 * IOCTL_INTERNAL_USB_CYCLE_PORT is only available in kernel mode and the
3173 * IOCTL_USB_HUB_CYCLE_PORT ioctl was removed from Vista => the best we can do is
3174 * cycle the pipes (and even then, the control pipe can not be reset using WinUSB)
3176 // TODO: (post hotplug): see if we can force eject the device and redetect it (reuse hotplug?)
3177 static int winusbx_reset_device(int sub_api, struct libusb_device_handle *dev_handle)
3179 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
3180 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
3181 HANDLE winusb_handle;
3184 CHECK_WINUSBX_AVAILABLE(sub_api);
3186 // Reset any available pipe (except control)
3187 for (i = 0; i < USB_MAXINTERFACES; i++) {
3188 winusb_handle = handle_priv->interface_handle[i].api_handle;
3189 if (HANDLE_VALID(winusb_handle)) {
3190 for (j = 0; j < priv->usb_interface[i].nb_endpoints; j++) {
3191 usbi_dbg("resetting ep %02X", priv->usb_interface[i].endpoint[j]);
3192 if (!WinUSBX[sub_api].AbortPipe(winusb_handle, priv->usb_interface[i].endpoint[j]))
3193 usbi_err(HANDLE_CTX(dev_handle), "AbortPipe (pipe address %02X) failed: %s",
3194 priv->usb_interface[i].endpoint[j], windows_error_str(0));
3196 // FlushPipe seems to fail on OUT pipes
3197 if (IS_EPIN(priv->usb_interface[i].endpoint[j])
3198 && (!WinUSBX[sub_api].FlushPipe(winusb_handle, priv->usb_interface[i].endpoint[j])))
3199 usbi_err(HANDLE_CTX(dev_handle), "FlushPipe (pipe address %02X) failed: %s",
3200 priv->usb_interface[i].endpoint[j], windows_error_str(0));
3202 if (!WinUSBX[sub_api].ResetPipe(winusb_handle, priv->usb_interface[i].endpoint[j]))
3203 usbi_err(HANDLE_CTX(dev_handle), "ResetPipe (pipe address %02X) failed: %s",
3204 priv->usb_interface[i].endpoint[j], windows_error_str(0));
3209 // libusbK & libusb0 have the ability to issue an actual device reset
3210 if ((sub_api != SUB_API_WINUSB) && (WinUSBX[sub_api].ResetDevice != NULL)) {
3211 winusb_handle = handle_priv->interface_handle[0].api_handle;
3212 if (HANDLE_VALID(winusb_handle))
3213 WinUSBX[sub_api].ResetDevice(winusb_handle);
3216 return LIBUSB_SUCCESS;
3219 static enum libusb_transfer_status winusbx_copy_transfer_data(int sub_api, struct usbi_transfer *itransfer, DWORD length)
3221 struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
3222 struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
3225 if (transfer->type == LIBUSB_TRANSFER_TYPE_ISOCHRONOUS) {
3226 // for isochronous, need to copy the individual iso packet actual_lengths and statuses
3227 if ((sub_api == SUB_API_LIBUSBK) || (sub_api == SUB_API_LIBUSB0)) {
3228 // iso only supported on libusbk-based backends for now
3229 PKISO_CONTEXT iso_context = transfer_priv->iso_context;
3230 for (i = 0; i < transfer->num_iso_packets; i++) {
3231 transfer->iso_packet_desc[i].actual_length = iso_context->IsoPackets[i].actual_length;
3232 // TODO translate USDB_STATUS codes http://msdn.microsoft.com/en-us/library/ff539136(VS.85).aspx to libusb_transfer_status
3233 //transfer->iso_packet_desc[i].status = transfer_priv->iso_context->IsoPackets[i].status;
3235 } else if (sub_api == SUB_API_WINUSB) {
3236 if (IS_XFERIN(transfer)) {
3237 /* Convert isochronous packet descriptor between Windows and libusb representation.
3238 * Both representation are guaranteed to have the same length in bytes.*/
3239 PUSBD_ISO_PACKET_DESCRIPTOR usbd_iso_packet_desc = (PUSBD_ISO_PACKET_DESCRIPTOR)transfer->iso_packet_desc;
3240 for (i = 0; i < transfer->num_iso_packets; i++) {
3241 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;
3242 unsigned int actual_length = usbd_iso_packet_desc[i].Length;
3243 USBD_STATUS status = usbd_iso_packet_desc[i].Status;
3245 transfer->iso_packet_desc[i].length = packet_length;
3246 transfer->iso_packet_desc[i].actual_length = actual_length;
3247 transfer->iso_packet_desc[i].status = usbd_status_to_libusb_transfer_status(status);
3250 for (i = 0; i < transfer->num_iso_packets; i++) {
3251 transfer->iso_packet_desc[i].status = LIBUSB_TRANSFER_COMPLETED;
3255 // This should only occur if backend is not set correctly or other backend isoc is partially implemented
3256 PRINT_UNSUPPORTED_API(copy_transfer_data);
3257 return LIBUSB_TRANSFER_ERROR;
3261 itransfer->transferred += (int)length;
3262 return LIBUSB_TRANSFER_COMPLETED;
3266 * Internal HID Support functions (from libusb-win32)
3267 * Note that functions that complete data transfer synchronously must return
3268 * LIBUSB_COMPLETED instead of LIBUSB_SUCCESS
3270 static int _hid_get_hid_descriptor(struct hid_device_priv *dev, void *data, size_t *size);
3271 static int _hid_get_report_descriptor(struct hid_device_priv *dev, void *data, size_t *size);
3273 static int _hid_wcslen(WCHAR *str)
3277 while (str[i] && (str[i] != 0x409))
3283 static int _hid_get_device_descriptor(struct hid_device_priv *hid_priv, void *data, size_t *size)
3285 struct libusb_device_descriptor d;
3287 d.bLength = LIBUSB_DT_DEVICE_SIZE;
3288 d.bDescriptorType = LIBUSB_DT_DEVICE;
3289 d.bcdUSB = 0x0200; /* 2.00 */
3291 d.bDeviceSubClass = 0;
3292 d.bDeviceProtocol = 0;
3293 d.bMaxPacketSize0 = 64; /* fix this! */
3294 d.idVendor = (uint16_t)hid_priv->vid;
3295 d.idProduct = (uint16_t)hid_priv->pid;
3296 d.bcdDevice = 0x0100;
3297 d.iManufacturer = hid_priv->string_index[0];
3298 d.iProduct = hid_priv->string_index[1];
3299 d.iSerialNumber = hid_priv->string_index[2];
3300 d.bNumConfigurations = 1;
3302 if (*size > LIBUSB_DT_DEVICE_SIZE)
3303 *size = LIBUSB_DT_DEVICE_SIZE;
3304 memcpy(data, &d, *size);
3306 return LIBUSB_COMPLETED;
3309 static int _hid_get_config_descriptor(struct hid_device_priv *hid_priv, void *data, size_t *size)
3311 char num_endpoints = 0;
3312 size_t config_total_len = 0;
3313 char tmp[HID_MAX_CONFIG_DESC_SIZE];
3314 struct libusb_config_descriptor *cd;
3315 struct libusb_interface_descriptor *id;
3316 struct libusb_hid_descriptor *hd;
3317 struct libusb_endpoint_descriptor *ed;
3320 if (hid_priv->input_report_size)
3322 if (hid_priv->output_report_size)
3325 config_total_len = LIBUSB_DT_CONFIG_SIZE + LIBUSB_DT_INTERFACE_SIZE
3326 + LIBUSB_DT_HID_SIZE + num_endpoints * LIBUSB_DT_ENDPOINT_SIZE;
3328 cd = (struct libusb_config_descriptor *)tmp;
3329 id = (struct libusb_interface_descriptor *)(tmp + LIBUSB_DT_CONFIG_SIZE);
3330 hd = (struct libusb_hid_descriptor *)(tmp + LIBUSB_DT_CONFIG_SIZE
3331 + LIBUSB_DT_INTERFACE_SIZE);
3332 ed = (struct libusb_endpoint_descriptor *)(tmp + LIBUSB_DT_CONFIG_SIZE
3333 + LIBUSB_DT_INTERFACE_SIZE
3334 + LIBUSB_DT_HID_SIZE);
3336 cd->bLength = LIBUSB_DT_CONFIG_SIZE;
3337 cd->bDescriptorType = LIBUSB_DT_CONFIG;
3338 cd->wTotalLength = (uint16_t)config_total_len;
3339 cd->bNumInterfaces = 1;
3340 cd->bConfigurationValue = 1;
3341 cd->iConfiguration = 0;
3342 cd->bmAttributes = 1 << 7; /* bus powered */
3345 id->bLength = LIBUSB_DT_INTERFACE_SIZE;
3346 id->bDescriptorType = LIBUSB_DT_INTERFACE;
3347 id->bInterfaceNumber = 0;
3348 id->bAlternateSetting = 0;
3349 id->bNumEndpoints = num_endpoints;
3350 id->bInterfaceClass = 3;
3351 id->bInterfaceSubClass = 0;
3352 id->bInterfaceProtocol = 0;
3355 tmp_size = LIBUSB_DT_HID_SIZE;
3356 _hid_get_hid_descriptor(hid_priv, hd, &tmp_size);
3358 if (hid_priv->input_report_size) {
3359 ed->bLength = LIBUSB_DT_ENDPOINT_SIZE;
3360 ed->bDescriptorType = LIBUSB_DT_ENDPOINT;
3361 ed->bEndpointAddress = HID_IN_EP;
3362 ed->bmAttributes = 3;
3363 ed->wMaxPacketSize = hid_priv->input_report_size - 1;
3365 ed = (struct libusb_endpoint_descriptor *)((char *)ed + LIBUSB_DT_ENDPOINT_SIZE);
3368 if (hid_priv->output_report_size) {
3369 ed->bLength = LIBUSB_DT_ENDPOINT_SIZE;
3370 ed->bDescriptorType = LIBUSB_DT_ENDPOINT;
3371 ed->bEndpointAddress = HID_OUT_EP;
3372 ed->bmAttributes = 3;
3373 ed->wMaxPacketSize = hid_priv->output_report_size - 1;
3377 if (*size > config_total_len)
3378 *size = config_total_len;
3379 memcpy(data, tmp, *size);
3381 return LIBUSB_COMPLETED;
3384 static int _hid_get_string_descriptor(struct hid_device_priv *hid_priv, int _index,
3385 void *data, size_t *size, HANDLE hid_handle)
3388 WCHAR string[MAX_USB_STRING_LENGTH];
3389 size_t tmp_size = 0;
3392 /* language ID, EN-US */
3393 char string_langid[] = {0x09, 0x04};
3396 tmp = string_langid;
3397 tmp_size = sizeof(string_langid) + 2;
3399 for (i = 0; i < 3; i++) {
3400 if (_index == (hid_priv->string_index[i])) {
3401 tmp = hid_priv->string[i];
3402 tmp_size = (_hid_wcslen(hid_priv->string[i]) + 1) * sizeof(WCHAR);
3408 if (!HidD_GetIndexedString(hid_handle, _index, string, sizeof(string)))
3409 return LIBUSB_ERROR_INVALID_PARAM;
3411 tmp_size = (_hid_wcslen(string) + 1) * sizeof(WCHAR);
3416 return LIBUSB_ERROR_INVALID_PARAM;
3418 if (tmp_size < *size)
3422 ((uint8_t *)data)[0] = (uint8_t)*size;
3423 ((uint8_t *)data)[1] = LIBUSB_DT_STRING;
3424 memcpy((uint8_t *)data + 2, tmp, *size - 2);
3426 return LIBUSB_COMPLETED;
3429 static int _hid_get_hid_descriptor(struct hid_device_priv *hid_priv, void *data, size_t *size)
3431 struct libusb_hid_descriptor d;
3432 uint8_t tmp[MAX_HID_DESCRIPTOR_SIZE];
3433 size_t report_len = MAX_HID_DESCRIPTOR_SIZE;
3435 _hid_get_report_descriptor(hid_priv, tmp, &report_len);
3437 d.bLength = LIBUSB_DT_HID_SIZE;
3438 d.bDescriptorType = LIBUSB_DT_HID;
3439 d.bcdHID = 0x0110; /* 1.10 */
3441 d.bNumDescriptors = 1;
3442 d.bClassDescriptorType = LIBUSB_DT_REPORT;
3443 d.wClassDescriptorLength = (uint16_t)report_len;
3445 if (*size > LIBUSB_DT_HID_SIZE)
3446 *size = LIBUSB_DT_HID_SIZE;
3447 memcpy(data, &d, *size);
3449 return LIBUSB_COMPLETED;
3452 static int _hid_get_report_descriptor(struct hid_device_priv *hid_priv, void *data, size_t *size)
3454 uint8_t d[MAX_HID_DESCRIPTOR_SIZE];
3458 d[i++] = 0x06; d[i++] = hid_priv->usagePage & 0xFF; d[i++] = hid_priv->usagePage >> 8;
3460 d[i++] = 0x09; d[i++] = (uint8_t)hid_priv->usage;
3461 /* start collection (application) */
3462 d[i++] = 0xA1; d[i++] = 0x01;
3464 if (hid_priv->input_report_size) {
3465 /* usage (vendor defined) */
3466 d[i++] = 0x09; d[i++] = 0x01;
3467 /* logical minimum (0) */
3468 d[i++] = 0x15; d[i++] = 0x00;
3469 /* logical maximum (255) */
3470 d[i++] = 0x25; d[i++] = 0xFF;
3471 /* report size (8 bits) */
3472 d[i++] = 0x75; d[i++] = 0x08;
3474 d[i++] = 0x95; d[i++] = (uint8_t)hid_priv->input_report_size - 1;
3475 /* input (data, variable, absolute) */
3476 d[i++] = 0x81; d[i++] = 0x00;
3479 if (hid_priv->output_report_size) {
3480 /* usage (vendor defined) */
3481 d[i++] = 0x09; d[i++] = 0x02;
3482 /* logical minimum (0) */
3483 d[i++] = 0x15; d[i++] = 0x00;
3484 /* logical maximum (255) */
3485 d[i++] = 0x25; d[i++] = 0xFF;
3486 /* report size (8 bits) */
3487 d[i++] = 0x75; d[i++] = 0x08;
3489 d[i++] = 0x95; d[i++] = (uint8_t)hid_priv->output_report_size - 1;
3490 /* output (data, variable, absolute) */
3491 d[i++] = 0x91; d[i++] = 0x00;
3493 /* feature report */
3494 if (hid_priv->feature_report_size) {
3495 /* usage (vendor defined) */
3496 d[i++] = 0x09; d[i++] = 0x03;
3497 /* logical minimum (0) */
3498 d[i++] = 0x15; d[i++] = 0x00;
3499 /* logical maximum (255) */
3500 d[i++] = 0x25; d[i++] = 0xFF;
3501 /* report size (8 bits) */
3502 d[i++] = 0x75; d[i++] = 0x08;
3504 d[i++] = 0x95; d[i++] = (uint8_t)hid_priv->feature_report_size - 1;
3505 /* feature (data, variable, absolute) */
3506 d[i++] = 0xb2; d[i++] = 0x02; d[i++] = 0x01;
3509 /* end collection */
3514 memcpy(data, d, *size);
3516 return LIBUSB_COMPLETED;
3519 static int _hid_get_descriptor(struct libusb_device *dev, HANDLE hid_handle, int recipient,
3520 int type, int _index, void *data, size_t *size)
3522 struct winusb_device_priv *priv = usbi_get_device_priv(dev);
3526 case LIBUSB_DT_DEVICE:
3527 usbi_dbg("LIBUSB_DT_DEVICE");
3528 return _hid_get_device_descriptor(priv->hid, data, size);
3529 case LIBUSB_DT_CONFIG:
3530 usbi_dbg("LIBUSB_DT_CONFIG");
3532 return _hid_get_config_descriptor(priv->hid, data, size);
3533 return LIBUSB_ERROR_INVALID_PARAM;
3534 case LIBUSB_DT_STRING:
3535 usbi_dbg("LIBUSB_DT_STRING");
3536 return _hid_get_string_descriptor(priv->hid, _index, data, size, hid_handle);
3538 usbi_dbg("LIBUSB_DT_HID");
3540 return _hid_get_hid_descriptor(priv->hid, data, size);
3541 return LIBUSB_ERROR_INVALID_PARAM;
3542 case LIBUSB_DT_REPORT:
3543 usbi_dbg("LIBUSB_DT_REPORT");
3545 return _hid_get_report_descriptor(priv->hid, data, size);
3546 return LIBUSB_ERROR_INVALID_PARAM;
3547 case LIBUSB_DT_PHYSICAL:
3548 usbi_dbg("LIBUSB_DT_PHYSICAL");
3549 if (HidD_GetPhysicalDescriptor(hid_handle, data, (ULONG)*size))
3550 return LIBUSB_COMPLETED;
3551 return LIBUSB_ERROR_OTHER;
3554 usbi_warn(DEVICE_CTX(dev), "unsupported");
3555 return LIBUSB_ERROR_NOT_SUPPORTED;
3558 static int _hid_get_report(struct libusb_device *dev, HANDLE hid_handle, int id, void *data,
3559 struct winusb_transfer_priv *tp, size_t size, OVERLAPPED *overlapped, int report_type)
3561 DWORD ioctl_code, expected_size = (DWORD)size;
3564 if (tp->hid_buffer != NULL)
3565 usbi_err(DEVICE_CTX(dev), "program assertion failed - hid_buffer is not NULL");
3567 if ((size == 0) || (size > MAX_HID_REPORT_SIZE)) {
3568 usbi_warn(DEVICE_CTX(dev), "invalid size (%"PRIuPTR")", (uintptr_t)size);
3569 return LIBUSB_ERROR_INVALID_PARAM;
3572 switch (report_type) {
3573 case HID_REPORT_TYPE_INPUT:
3574 ioctl_code = IOCTL_HID_GET_INPUT_REPORT;
3576 case HID_REPORT_TYPE_FEATURE:
3577 ioctl_code = IOCTL_HID_GET_FEATURE;
3580 usbi_warn(DEVICE_CTX(dev), "unknown HID report type %d", report_type);
3581 return LIBUSB_ERROR_INVALID_PARAM;
3584 // Add a trailing byte to detect overflows
3585 buf = calloc(1, expected_size + 1);
3587 return LIBUSB_ERROR_NO_MEM;
3589 buf[0] = (uint8_t)id; // Must be set always
3590 usbi_dbg("report ID: 0x%02X", buf[0]);
3592 // NB: The size returned by DeviceIoControl doesn't include report IDs when not in use (0)
3593 if (!DeviceIoControl(hid_handle, ioctl_code, buf, expected_size + 1,
3594 buf, expected_size + 1, NULL, overlapped)) {
3595 if (GetLastError() != ERROR_IO_PENDING) {
3596 usbi_err(DEVICE_CTX(dev), "failed to read HID Report: %s", windows_error_str(0));
3598 return LIBUSB_ERROR_IO;
3602 // Asynchronous wait
3603 tp->hid_buffer = buf;
3604 tp->hid_dest = data; // copy dest, as not necessarily the start of the transfer buffer
3605 tp->hid_expected_size = expected_size;
3607 return LIBUSB_SUCCESS;
3610 static int _hid_set_report(struct libusb_device *dev, HANDLE hid_handle, int id, void *data,
3611 struct winusb_transfer_priv *tp, size_t size, OVERLAPPED *overlapped, int report_type)
3613 DWORD ioctl_code, write_size = (DWORD)size;
3614 // If an id is reported, we must allow MAX_HID_REPORT_SIZE + 1
3615 size_t max_report_size = MAX_HID_REPORT_SIZE + (id ? 1 : 0);
3618 if (tp->hid_buffer != NULL)
3619 usbi_err(DEVICE_CTX(dev), "program assertion failed - hid_buffer is not NULL");
3621 if ((size == 0) || (size > max_report_size)) {
3622 usbi_warn(DEVICE_CTX(dev), "invalid size (%"PRIuPTR")", (uintptr_t)size);
3623 return LIBUSB_ERROR_INVALID_PARAM;
3626 switch (report_type) {
3627 case HID_REPORT_TYPE_OUTPUT:
3628 ioctl_code = IOCTL_HID_SET_OUTPUT_REPORT;
3630 case HID_REPORT_TYPE_FEATURE:
3631 ioctl_code = IOCTL_HID_SET_FEATURE;
3634 usbi_warn(DEVICE_CTX(dev), "unknown HID report type %d", report_type);
3635 return LIBUSB_ERROR_INVALID_PARAM;
3638 usbi_dbg("report ID: 0x%02X", id);
3639 // When report IDs are not used (i.e. when id == 0), we must add
3640 // a null report ID. Otherwise, we just use original data buffer
3644 buf = malloc(write_size);
3646 return LIBUSB_ERROR_NO_MEM;
3650 memcpy(buf + 1, data, size);
3652 // This seems like a waste, but if we don't duplicate the
3653 // data, we'll get issues when freeing hid_buffer
3654 memcpy(buf, data, size);
3656 usbi_warn(DEVICE_CTX(dev), "mismatched report ID (data is %02X, parameter is %02X)", buf[0], id);
3659 // NB: The size returned by DeviceIoControl doesn't include report IDs when not in use (0)
3660 if (!DeviceIoControl(hid_handle, ioctl_code, buf, write_size,
3661 buf, write_size, NULL, overlapped)) {
3662 if (GetLastError() != ERROR_IO_PENDING) {
3663 usbi_err(DEVICE_CTX(dev), "failed to write HID Output Report: %s", windows_error_str(0));
3665 return LIBUSB_ERROR_IO;
3669 tp->hid_buffer = buf;
3670 tp->hid_dest = NULL;
3671 return LIBUSB_SUCCESS;
3674 static int _hid_class_request(struct libusb_device *dev, HANDLE hid_handle, int request_type,
3675 int request, int value, int _index, void *data, struct winusb_transfer_priv *tp,
3676 size_t size, OVERLAPPED *overlapped)
3678 int report_type = (value >> 8) & 0xFF;
3679 int report_id = value & 0xFF;
3683 if ((LIBUSB_REQ_RECIPIENT(request_type) != LIBUSB_RECIPIENT_INTERFACE)
3684 && (LIBUSB_REQ_RECIPIENT(request_type) != LIBUSB_RECIPIENT_DEVICE))
3685 return LIBUSB_ERROR_INVALID_PARAM;
3687 if (LIBUSB_REQ_OUT(request_type) && request == HID_REQ_SET_REPORT)
3688 return _hid_set_report(dev, hid_handle, report_id, data, tp, size, overlapped, report_type);
3690 if (LIBUSB_REQ_IN(request_type) && request == HID_REQ_GET_REPORT)
3691 return _hid_get_report(dev, hid_handle, report_id, data, tp, size, overlapped, report_type);
3693 return LIBUSB_ERROR_INVALID_PARAM;
3699 static bool hid_init(struct libusb_context *ctx)
3701 DLL_GET_HANDLE(ctx, hid);
3703 DLL_LOAD_FUNC(hid, HidD_GetAttributes, true);
3704 DLL_LOAD_FUNC(hid, HidD_GetHidGuid, true);
3705 DLL_LOAD_FUNC(hid, HidD_GetPreparsedData, true);
3706 DLL_LOAD_FUNC(hid, HidD_FreePreparsedData, true);
3707 DLL_LOAD_FUNC(hid, HidD_GetManufacturerString, true);
3708 DLL_LOAD_FUNC(hid, HidD_GetProductString, true);
3709 DLL_LOAD_FUNC(hid, HidD_GetSerialNumberString, true);
3710 DLL_LOAD_FUNC(hid, HidD_GetIndexedString, true);
3711 DLL_LOAD_FUNC(hid, HidP_GetCaps, true);
3712 DLL_LOAD_FUNC(hid, HidD_SetNumInputBuffers, true);
3713 DLL_LOAD_FUNC(hid, HidD_GetPhysicalDescriptor, true);
3714 DLL_LOAD_FUNC(hid, HidD_FlushQueue, true);
3715 DLL_LOAD_FUNC(hid, HidP_GetValueCaps, true);
3720 static void hid_exit(void)
3722 DLL_FREE_HANDLE(hid);
3725 // NB: open and close must ensure that they only handle interface of
3726 // the right API type, as these functions can be called wholesale from
3727 // composite_open(), with interfaces belonging to different APIs
3728 static int hid_open(int sub_api, struct libusb_device_handle *dev_handle)
3730 struct libusb_device *dev = dev_handle->dev;
3731 struct winusb_device_priv *priv = usbi_get_device_priv(dev);
3732 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
3733 HIDD_ATTRIBUTES hid_attributes;
3734 PHIDP_PREPARSED_DATA preparsed_data = NULL;
3735 HIDP_CAPS capabilities;
3736 HIDP_VALUE_CAPS *value_caps;
3737 HANDLE hid_handle = INVALID_HANDLE_VALUE;
3739 // report IDs handling
3741 int nb_ids[2]; // zero and nonzero report IDs
3742 #if defined(ENABLE_LOGGING)
3743 const char * const type[3] = {"input", "output", "feature"};
3747 CHECK_HID_AVAILABLE;
3749 if (priv->hid == NULL) {
3750 usbi_err(HANDLE_CTX(dev_handle), "program assertion failed - private HID structure is uninitialized");
3751 return LIBUSB_ERROR_NOT_FOUND;
3754 for (i = 0; i < USB_MAXINTERFACES; i++) {
3755 if ((priv->usb_interface[i].path != NULL)
3756 && (priv->usb_interface[i].apib->id == USB_API_HID)) {
3757 hid_handle = windows_open(dev_handle, priv->usb_interface[i].path, GENERIC_READ | GENERIC_WRITE);
3759 * http://www.lvr.com/hidfaq.htm: Why do I receive "Access denied" when attempting to access my HID?
3760 * "Windows 2000 and later have exclusive read/write access to HIDs that are configured as a system
3761 * keyboards or mice. An application can obtain a handle to a system keyboard or mouse by not
3762 * requesting READ or WRITE access with CreateFile. Applications can then use HidD_SetFeature and
3763 * HidD_GetFeature (if the device supports Feature reports)."
3765 if (hid_handle == INVALID_HANDLE_VALUE) {
3766 usbi_warn(HANDLE_CTX(dev_handle), "could not open HID device in R/W mode (keyboard or mouse?) - trying without");
3767 hid_handle = windows_open(dev_handle, priv->usb_interface[i].path, 0);
3768 if (hid_handle == INVALID_HANDLE_VALUE) {
3769 usbi_err(HANDLE_CTX(dev_handle), "could not open device %s (interface %d): %s", priv->path, i, windows_error_str(0));
3770 switch (GetLastError()) {
3771 case ERROR_FILE_NOT_FOUND: // The device was disconnected
3772 return LIBUSB_ERROR_NO_DEVICE;
3773 case ERROR_ACCESS_DENIED:
3774 return LIBUSB_ERROR_ACCESS;
3776 return LIBUSB_ERROR_IO;
3779 priv->usb_interface[i].restricted_functionality = true;
3781 handle_priv->interface_handle[i].api_handle = hid_handle;
3785 hid_attributes.Size = sizeof(hid_attributes);
3787 if (!HidD_GetAttributes(hid_handle, &hid_attributes)) {
3788 usbi_err(HANDLE_CTX(dev_handle), "could not gain access to HID top collection (HidD_GetAttributes)");
3792 priv->hid->vid = hid_attributes.VendorID;
3793 priv->hid->pid = hid_attributes.ProductID;
3795 // Set the maximum available input buffer size
3796 for (i = 32; HidD_SetNumInputBuffers(hid_handle, i); i *= 2);
3797 usbi_dbg("set maximum input buffer size to %d", i / 2);
3799 // Get the maximum input and output report size
3800 if (!HidD_GetPreparsedData(hid_handle, &preparsed_data) || !preparsed_data) {
3801 usbi_err(HANDLE_CTX(dev_handle), "could not read HID preparsed data (HidD_GetPreparsedData)");
3804 if (HidP_GetCaps(preparsed_data, &capabilities) != HIDP_STATUS_SUCCESS) {
3805 usbi_err(HANDLE_CTX(dev_handle), "could not parse HID capabilities (HidP_GetCaps)");
3809 // Find out if interrupt will need report IDs
3810 size[0] = capabilities.NumberInputValueCaps;
3811 size[1] = capabilities.NumberOutputValueCaps;
3812 size[2] = capabilities.NumberFeatureValueCaps;
3813 for (j = HidP_Input; j <= HidP_Feature; j++) {
3814 usbi_dbg("%lu HID %s report value(s) found", ULONG_CAST(size[j]), type[j]);
3815 priv->hid->uses_report_ids[j] = false;
3817 value_caps = calloc(size[j], sizeof(HIDP_VALUE_CAPS));
3818 if ((value_caps != NULL)
3819 && (HidP_GetValueCaps((HIDP_REPORT_TYPE)j, value_caps, &size[j], preparsed_data) == HIDP_STATUS_SUCCESS)
3820 && (size[j] >= 1)) {
3823 for (i = 0; i < (int)size[j]; i++) {
3824 usbi_dbg(" Report ID: 0x%02X", value_caps[i].ReportID);
3825 if (value_caps[i].ReportID != 0)
3830 if (nb_ids[1] != 0) {
3832 usbi_warn(HANDLE_CTX(dev_handle), "program assertion failed - zero and nonzero report IDs used for %s",
3834 priv->hid->uses_report_ids[j] = true;
3837 usbi_warn(HANDLE_CTX(dev_handle), " could not process %s report IDs", type[j]);
3843 // Set the report sizes
3844 priv->hid->input_report_size = capabilities.InputReportByteLength;
3845 priv->hid->output_report_size = capabilities.OutputReportByteLength;
3846 priv->hid->feature_report_size = capabilities.FeatureReportByteLength;
3848 // Store usage and usagePage values
3849 priv->hid->usage = capabilities.Usage;
3850 priv->hid->usagePage = capabilities.UsagePage;
3852 // Fetch string descriptors
3853 priv->hid->string_index[0] = dev->device_descriptor.iManufacturer;
3854 if (priv->hid->string_index[0] != 0)
3855 HidD_GetManufacturerString(hid_handle, priv->hid->string[0], sizeof(priv->hid->string[0]));
3857 priv->hid->string[0][0] = 0;
3859 priv->hid->string_index[1] = dev->device_descriptor.iProduct;
3860 if (priv->hid->string_index[1] != 0)
3861 HidD_GetProductString(hid_handle, priv->hid->string[1], sizeof(priv->hid->string[1]));
3863 priv->hid->string[1][0] = 0;
3865 priv->hid->string_index[2] = dev->device_descriptor.iSerialNumber;
3866 if (priv->hid->string_index[2] != 0)
3867 HidD_GetSerialNumberString(hid_handle, priv->hid->string[2], sizeof(priv->hid->string[2]));
3869 priv->hid->string[2][0] = 0;
3873 HidD_FreePreparsedData(preparsed_data);
3875 return LIBUSB_SUCCESS;
3878 static void hid_close(int sub_api, struct libusb_device_handle *dev_handle)
3880 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
3881 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
3887 if (DLL_HANDLE_NAME(hid) == NULL)
3890 for (i = 0; i < USB_MAXINTERFACES; i++) {
3891 if (priv->usb_interface[i].apib->id == USB_API_HID) {
3892 file_handle = handle_priv->interface_handle[i].api_handle;
3893 if (HANDLE_VALID(file_handle))
3894 CloseHandle(file_handle);
3899 static int hid_claim_interface(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface)
3901 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
3902 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
3905 CHECK_HID_AVAILABLE;
3907 // NB: Disconnection detection is not possible in this function
3908 if (priv->usb_interface[iface].path == NULL)
3909 return LIBUSB_ERROR_NOT_FOUND; // invalid iface
3911 // We use dev_handle as a flag for interface claimed
3912 if (handle_priv->interface_handle[iface].dev_handle == INTERFACE_CLAIMED)
3913 return LIBUSB_ERROR_BUSY; // already claimed
3915 handle_priv->interface_handle[iface].dev_handle = INTERFACE_CLAIMED;
3917 usbi_dbg("claimed interface %u", iface);
3918 handle_priv->active_interface = iface;
3920 return LIBUSB_SUCCESS;
3923 static int hid_release_interface(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface)
3925 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
3926 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
3929 CHECK_HID_AVAILABLE;
3931 if (priv->usb_interface[iface].path == NULL)
3932 return LIBUSB_ERROR_NOT_FOUND; // invalid iface
3934 if (handle_priv->interface_handle[iface].dev_handle != INTERFACE_CLAIMED)
3935 return LIBUSB_ERROR_NOT_FOUND; // invalid iface
3937 handle_priv->interface_handle[iface].dev_handle = INVALID_HANDLE_VALUE;
3939 return LIBUSB_SUCCESS;
3942 static int hid_set_interface_altsetting(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface, uint8_t altsetting)
3947 CHECK_HID_AVAILABLE;
3949 if (altsetting != 0) {
3950 usbi_err(HANDLE_CTX(dev_handle), "set interface altsetting not supported for altsetting >0");
3951 return LIBUSB_ERROR_NOT_SUPPORTED;
3954 return LIBUSB_SUCCESS;
3957 static int hid_submit_control_transfer(int sub_api, struct usbi_transfer *itransfer)
3959 struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
3960 struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
3961 struct libusb_device_handle *dev_handle = transfer->dev_handle;
3962 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
3963 struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
3964 WINUSB_SETUP_PACKET *setup = (WINUSB_SETUP_PACKET *)transfer->buffer;
3966 OVERLAPPED *overlapped;
3967 int current_interface;
3973 CHECK_HID_AVAILABLE;
3975 safe_free(transfer_priv->hid_buffer);
3976 transfer_priv->hid_dest = NULL;
3977 size = transfer->length - LIBUSB_CONTROL_SETUP_SIZE;
3979 if (size > MAX_CTRL_BUFFER_LENGTH)
3980 return LIBUSB_ERROR_INVALID_PARAM;
3982 current_interface = get_valid_interface(dev_handle, USB_API_HID);
3983 if (current_interface < 0) {
3984 if (auto_claim(transfer, ¤t_interface, USB_API_HID) != LIBUSB_SUCCESS)
3985 return LIBUSB_ERROR_NOT_FOUND;
3988 usbi_dbg("will use interface %d", current_interface);
3990 hid_handle = handle_priv->interface_handle[current_interface].api_handle;
3991 set_transfer_priv_handle(itransfer, hid_handle);
3992 overlapped = get_transfer_priv_overlapped(itransfer);
3994 switch (LIBUSB_REQ_TYPE(setup->RequestType)) {
3995 case LIBUSB_REQUEST_TYPE_STANDARD:
3996 switch (setup->Request) {
3997 case LIBUSB_REQUEST_GET_DESCRIPTOR:
3998 r = _hid_get_descriptor(dev_handle->dev, hid_handle, LIBUSB_REQ_RECIPIENT(setup->RequestType),
3999 (setup->Value >> 8) & 0xFF, setup->Value & 0xFF, transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE, &size);
4001 case LIBUSB_REQUEST_GET_CONFIGURATION:
4002 r = winusb_get_configuration(dev_handle, &config);
4003 if (r == LIBUSB_SUCCESS) {
4005 ((uint8_t *)transfer->buffer)[LIBUSB_CONTROL_SETUP_SIZE] = config;
4006 r = LIBUSB_COMPLETED;
4009 case LIBUSB_REQUEST_SET_CONFIGURATION:
4010 if (setup->Value == priv->active_config) {
4011 r = LIBUSB_COMPLETED;
4013 usbi_warn(TRANSFER_CTX(transfer), "cannot set configuration other than the default one");
4014 r = LIBUSB_ERROR_NOT_SUPPORTED;
4017 case LIBUSB_REQUEST_GET_INTERFACE:
4019 ((uint8_t *)transfer->buffer)[LIBUSB_CONTROL_SETUP_SIZE] = 0;
4020 r = LIBUSB_COMPLETED;
4022 case LIBUSB_REQUEST_SET_INTERFACE:
4023 r = hid_set_interface_altsetting(0, dev_handle, (uint8_t)setup->Index, (uint8_t)setup->Value);
4024 if (r == LIBUSB_SUCCESS)
4025 r = LIBUSB_COMPLETED;
4028 usbi_warn(TRANSFER_CTX(transfer), "unsupported HID control request");
4029 return LIBUSB_ERROR_NOT_SUPPORTED;
4032 case LIBUSB_REQUEST_TYPE_CLASS:
4033 r = _hid_class_request(dev_handle->dev, hid_handle, setup->RequestType, setup->Request, setup->Value,
4034 setup->Index, transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE, transfer_priv,
4038 usbi_warn(TRANSFER_CTX(transfer), "unsupported HID control request");
4039 return LIBUSB_ERROR_NOT_SUPPORTED;
4045 if (r == LIBUSB_COMPLETED) {
4046 // Force request to be completed synchronously. Transferred size has been set by previous call
4047 windows_force_sync_completion(itransfer, (ULONG)size);
4051 transfer_priv->interface_number = (uint8_t)current_interface;
4053 return LIBUSB_SUCCESS;
4056 static int hid_submit_bulk_transfer(int sub_api, struct usbi_transfer *itransfer)
4058 struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
4059 struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
4060 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(transfer->dev_handle);
4061 struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
4063 OVERLAPPED *overlapped;
4066 int current_interface, length;
4069 CHECK_HID_AVAILABLE;
4071 if (IS_XFEROUT(transfer) && (transfer->flags & LIBUSB_TRANSFER_ADD_ZERO_PACKET))
4072 return LIBUSB_ERROR_NOT_SUPPORTED;
4074 transfer_priv->hid_dest = NULL;
4075 safe_free(transfer_priv->hid_buffer);
4077 current_interface = interface_by_endpoint(priv, handle_priv, transfer->endpoint);
4078 if (current_interface < 0) {
4079 usbi_err(TRANSFER_CTX(transfer), "unable to match endpoint to an open interface - cancelling transfer");
4080 return LIBUSB_ERROR_NOT_FOUND;
4083 usbi_dbg("matched endpoint %02X with interface %d", transfer->endpoint, current_interface);
4085 hid_handle = handle_priv->interface_handle[current_interface].api_handle;
4086 set_transfer_priv_handle(itransfer, hid_handle);
4087 overlapped = get_transfer_priv_overlapped(itransfer);
4088 direction_in = IS_XFERIN(transfer);
4090 // If report IDs are not in use, an extra prefix byte must be added
4091 if (((direction_in) && (!priv->hid->uses_report_ids[0]))
4092 || ((!direction_in) && (!priv->hid->uses_report_ids[1])))
4093 length = transfer->length + 1;
4095 length = transfer->length;
4097 // Add a trailing byte to detect overflows on input
4098 transfer_priv->hid_buffer = calloc(1, length + 1);
4099 if (transfer_priv->hid_buffer == NULL)
4100 return LIBUSB_ERROR_NO_MEM;
4102 transfer_priv->hid_expected_size = length;
4105 transfer_priv->hid_dest = transfer->buffer;
4106 usbi_dbg("reading %d bytes (report ID: 0x00)", length);
4107 ret = ReadFile(hid_handle, transfer_priv->hid_buffer, length + 1, NULL, overlapped);
4109 if (!priv->hid->uses_report_ids[1])
4110 memcpy(transfer_priv->hid_buffer + 1, transfer->buffer, transfer->length);
4112 // We could actually do without the calloc and memcpy in this case
4113 memcpy(transfer_priv->hid_buffer, transfer->buffer, transfer->length);
4115 usbi_dbg("writing %d bytes (report ID: 0x%02X)", length, transfer_priv->hid_buffer[0]);
4116 ret = WriteFile(hid_handle, transfer_priv->hid_buffer, length, NULL, overlapped);
4119 if (!ret && GetLastError() != ERROR_IO_PENDING) {
4120 usbi_err(TRANSFER_CTX(transfer), "HID transfer failed: %s", windows_error_str(0));
4121 safe_free(transfer_priv->hid_buffer);
4122 return LIBUSB_ERROR_IO;
4125 transfer_priv->interface_number = (uint8_t)current_interface;
4127 return LIBUSB_SUCCESS;
4130 static int hid_reset_device(int sub_api, struct libusb_device_handle *dev_handle)
4132 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
4134 int current_interface;
4137 CHECK_HID_AVAILABLE;
4139 // Flushing the queues on all interfaces is the best we can achieve
4140 for (current_interface = 0; current_interface < USB_MAXINTERFACES; current_interface++) {
4141 hid_handle = handle_priv->interface_handle[current_interface].api_handle;
4142 if (HANDLE_VALID(hid_handle))
4143 HidD_FlushQueue(hid_handle);
4146 return LIBUSB_SUCCESS;
4149 static int hid_clear_halt(int sub_api, struct libusb_device_handle *dev_handle, unsigned char endpoint)
4151 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
4152 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
4154 int current_interface;
4157 CHECK_HID_AVAILABLE;
4159 current_interface = interface_by_endpoint(priv, handle_priv, endpoint);
4160 if (current_interface < 0) {
4161 usbi_err(HANDLE_CTX(dev_handle), "unable to match endpoint to an open interface - cannot clear");
4162 return LIBUSB_ERROR_NOT_FOUND;
4165 usbi_dbg("matched endpoint %02X with interface %d", endpoint, current_interface);
4166 hid_handle = handle_priv->interface_handle[current_interface].api_handle;
4168 // No endpoint selection with Microsoft's implementation, so we try to flush the
4169 // whole interface. Should be OK for most case scenarios
4170 if (!HidD_FlushQueue(hid_handle)) {
4171 usbi_err(HANDLE_CTX(dev_handle), "Flushing of HID queue failed: %s", windows_error_str(0));
4172 // Device was probably disconnected
4173 return LIBUSB_ERROR_NO_DEVICE;
4176 return LIBUSB_SUCCESS;
4179 // This extra function is only needed for HID
4180 static enum libusb_transfer_status hid_copy_transfer_data(int sub_api, struct usbi_transfer *itransfer, DWORD length)
4182 struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
4183 struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
4184 enum libusb_transfer_status r = LIBUSB_TRANSFER_COMPLETED;
4188 if (transfer_priv->hid_buffer != NULL) {
4189 // If we have a valid hid_buffer, it means the transfer was async
4190 if (transfer_priv->hid_dest != NULL) { // Data readout
4192 // First, check for overflow
4193 if ((size_t)length > transfer_priv->hid_expected_size) {
4194 usbi_err(TRANSFER_CTX(transfer), "OVERFLOW!");
4195 length = (DWORD)transfer_priv->hid_expected_size;
4196 r = LIBUSB_TRANSFER_OVERFLOW;
4199 if (transfer_priv->hid_buffer[0] == 0) {
4200 // Discard the 1 byte report ID prefix
4202 memcpy(transfer_priv->hid_dest, transfer_priv->hid_buffer + 1, length);
4204 memcpy(transfer_priv->hid_dest, transfer_priv->hid_buffer, length);
4207 transfer_priv->hid_dest = NULL;
4209 // For write, we just need to free the hid buffer
4210 safe_free(transfer_priv->hid_buffer);
4213 itransfer->transferred += (int)length;
4219 * Composite API functions
4221 static int composite_open(int sub_api, struct libusb_device_handle *dev_handle)
4223 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
4224 int i, r = LIBUSB_ERROR_NOT_FOUND;
4225 // SUB_API_MAX + 1 as the SUB_API_MAX pos is used to indicate availability of HID
4226 bool available[SUB_API_MAX + 1];
4230 for (i = 0; i < SUB_API_MAX + 1; i++)
4231 available[i] = false;
4233 for (i = 0; i < USB_MAXINTERFACES; i++) {
4234 switch (priv->usb_interface[i].apib->id) {
4235 case USB_API_WINUSBX:
4236 if (priv->usb_interface[i].sub_api != SUB_API_NOTSET)
4237 available[priv->usb_interface[i].sub_api] = true;
4240 available[SUB_API_MAX] = true;
4247 for (i = 0; i < SUB_API_MAX; i++) { // WinUSB-like drivers
4249 r = usb_api_backend[USB_API_WINUSBX].open(i, dev_handle);
4250 if (r != LIBUSB_SUCCESS)
4255 if (available[SUB_API_MAX]) { // HID driver
4256 r = hid_open(SUB_API_NOTSET, dev_handle);
4258 // On Windows 10 version 1903 (OS Build 18362) and later Windows blocks attempts to
4259 // open HID devices with a U2F usage unless running as administrator. We ignore this
4260 // failure and proceed without the HID device opened.
4261 if (r == LIBUSB_ERROR_ACCESS) {
4262 usbi_dbg("ignoring access denied error while opening HID interface of composite device");
4270 static void composite_close(int sub_api, struct libusb_device_handle *dev_handle)
4272 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
4274 // SUB_API_MAX + 1 as the SUB_API_MAX pos is used to indicate availability of HID
4275 bool available[SUB_API_MAX + 1];
4279 for (i = 0; i < SUB_API_MAX + 1; i++)
4280 available[i] = false;
4282 for (i = 0; i < USB_MAXINTERFACES; i++) {
4283 switch (priv->usb_interface[i].apib->id) {
4284 case USB_API_WINUSBX:
4285 if (priv->usb_interface[i].sub_api != SUB_API_NOTSET)
4286 available[priv->usb_interface[i].sub_api] = true;
4289 available[SUB_API_MAX] = true;
4296 for (i = 0; i < SUB_API_MAX; i++) { // WinUSB-like drivers
4298 usb_api_backend[USB_API_WINUSBX].close(i, dev_handle);
4301 if (available[SUB_API_MAX]) // HID driver
4302 hid_close(SUB_API_NOTSET, dev_handle);
4305 static int composite_claim_interface(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface)
4307 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
4310 CHECK_SUPPORTED_API(priv->usb_interface[iface].apib, claim_interface);
4312 return priv->usb_interface[iface].apib->
4313 claim_interface(priv->usb_interface[iface].sub_api, dev_handle, iface);
4316 static int composite_set_interface_altsetting(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface, uint8_t altsetting)
4318 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
4321 CHECK_SUPPORTED_API(priv->usb_interface[iface].apib, set_interface_altsetting);
4323 return priv->usb_interface[iface].apib->
4324 set_interface_altsetting(priv->usb_interface[iface].sub_api, dev_handle, iface, altsetting);
4327 static int composite_release_interface(int sub_api, struct libusb_device_handle *dev_handle, uint8_t iface)
4329 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
4332 CHECK_SUPPORTED_API(priv->usb_interface[iface].apib, release_interface);
4334 return priv->usb_interface[iface].apib->
4335 release_interface(priv->usb_interface[iface].sub_api, dev_handle, iface);
4338 static int composite_submit_control_transfer(int sub_api, struct usbi_transfer *itransfer)
4340 struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
4341 struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
4342 struct libusb_config_descriptor *conf_desc;
4343 WINUSB_SETUP_PACKET *setup = (WINUSB_SETUP_PACKET *)transfer->buffer;
4348 // Interface shouldn't matter for control, but it does in practice, with Windows'
4349 // restrictions with regards to accessing HID keyboards and mice. Try to target
4350 // a specific interface first, if possible.
4351 switch (LIBUSB_REQ_RECIPIENT(setup->RequestType)) {
4352 case LIBUSB_RECIPIENT_INTERFACE:
4353 iface = setup->Index & 0xFF;
4355 case LIBUSB_RECIPIENT_ENDPOINT:
4356 r = libusb_get_active_config_descriptor(transfer->dev_handle->dev, &conf_desc);
4357 if (r == LIBUSB_SUCCESS) {
4358 iface = get_interface_by_endpoint(conf_desc, (setup->Index & 0xFF));
4359 libusb_free_config_descriptor(conf_desc);
4362 // No break if not able to determine interface
4369 // Try and target a specific interface if the control setup indicates such
4370 if ((iface >= 0) && (iface < USB_MAXINTERFACES)) {
4371 usbi_dbg("attempting control transfer targeted to interface %d", iface);
4372 if ((priv->usb_interface[iface].path != NULL)
4373 && (priv->usb_interface[iface].apib->submit_control_transfer != NULL)) {
4374 r = priv->usb_interface[iface].apib->submit_control_transfer(priv->usb_interface[iface].sub_api, itransfer);
4375 if (r == LIBUSB_SUCCESS)
4380 // Either not targeted to a specific interface or no luck in doing so.
4381 // Try a 2 pass approach with all interfaces.
4382 for (pass = 0; pass < 2; pass++) {
4383 for (iface = 0; iface < USB_MAXINTERFACES; iface++) {
4384 if ((priv->usb_interface[iface].path != NULL)
4385 && (priv->usb_interface[iface].apib->submit_control_transfer != NULL)) {
4386 if ((pass == 0) && (priv->usb_interface[iface].restricted_functionality)) {
4387 usbi_dbg("trying to skip restricted interface #%d (HID keyboard or mouse?)", iface);
4390 usbi_dbg("using interface %d", iface);
4391 r = priv->usb_interface[iface].apib->submit_control_transfer(priv->usb_interface[iface].sub_api, itransfer);
4392 // If not supported on this API, it may be supported on another, so don't give up yet!!
4393 if (r == LIBUSB_ERROR_NOT_SUPPORTED)
4400 usbi_err(TRANSFER_CTX(transfer), "no libusb supported interfaces to complete request");
4401 return LIBUSB_ERROR_NOT_FOUND;
4404 static int composite_submit_bulk_transfer(int sub_api, struct usbi_transfer *itransfer)
4406 struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
4407 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(transfer->dev_handle);
4408 struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
4409 int current_interface;
4413 current_interface = interface_by_endpoint(priv, handle_priv, transfer->endpoint);
4414 if (current_interface < 0) {
4415 usbi_err(TRANSFER_CTX(transfer), "unable to match endpoint to an open interface - cancelling transfer");
4416 return LIBUSB_ERROR_NOT_FOUND;
4419 CHECK_SUPPORTED_API(priv->usb_interface[current_interface].apib, submit_bulk_transfer);
4421 return priv->usb_interface[current_interface].apib->
4422 submit_bulk_transfer(priv->usb_interface[current_interface].sub_api, itransfer);
4425 static int composite_submit_iso_transfer(int sub_api, struct usbi_transfer *itransfer)
4427 struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
4428 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(transfer->dev_handle);
4429 struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
4430 int current_interface;
4434 current_interface = interface_by_endpoint(priv, handle_priv, transfer->endpoint);
4435 if (current_interface < 0) {
4436 usbi_err(TRANSFER_CTX(transfer), "unable to match endpoint to an open interface - cancelling transfer");
4437 return LIBUSB_ERROR_NOT_FOUND;
4440 CHECK_SUPPORTED_API(priv->usb_interface[current_interface].apib, submit_iso_transfer);
4442 return priv->usb_interface[current_interface].apib->
4443 submit_iso_transfer(priv->usb_interface[current_interface].sub_api, itransfer);
4446 static int composite_clear_halt(int sub_api, struct libusb_device_handle *dev_handle, unsigned char endpoint)
4448 struct winusb_device_handle_priv *handle_priv = get_winusb_device_handle_priv(dev_handle);
4449 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
4450 int current_interface;
4454 current_interface = interface_by_endpoint(priv, handle_priv, endpoint);
4455 if (current_interface < 0) {
4456 usbi_err(HANDLE_CTX(dev_handle), "unable to match endpoint to an open interface - cannot clear");
4457 return LIBUSB_ERROR_NOT_FOUND;
4460 CHECK_SUPPORTED_API(priv->usb_interface[current_interface].apib, clear_halt);
4462 return priv->usb_interface[current_interface].apib->
4463 clear_halt(priv->usb_interface[current_interface].sub_api, dev_handle, endpoint);
4466 static int composite_cancel_transfer(int sub_api, struct usbi_transfer *itransfer)
4468 struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
4469 struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
4470 struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
4471 int current_interface = transfer_priv->interface_number;
4475 if ((current_interface < 0) || (current_interface >= USB_MAXINTERFACES)) {
4476 usbi_err(TRANSFER_CTX(transfer), "program assertion failed - invalid interface_number");
4477 return LIBUSB_ERROR_NOT_FOUND;
4480 CHECK_SUPPORTED_API(priv->usb_interface[current_interface].apib, cancel_transfer);
4482 return priv->usb_interface[current_interface].apib->
4483 cancel_transfer(priv->usb_interface[current_interface].sub_api, itransfer);
4486 static int composite_reset_device(int sub_api, struct libusb_device_handle *dev_handle)
4488 struct winusb_device_priv *priv = usbi_get_device_priv(dev_handle->dev);
4490 bool available[SUB_API_MAX];
4494 for (i = 0; i < SUB_API_MAX; i++)
4495 available[i] = false;
4497 for (i = 0; i < USB_MAXINTERFACES; i++) {
4498 if ((priv->usb_interface[i].apib->id == USB_API_WINUSBX)
4499 && (priv->usb_interface[i].sub_api != SUB_API_NOTSET))
4500 available[priv->usb_interface[i].sub_api] = true;
4503 for (i = 0; i < SUB_API_MAX; i++) {
4505 r = usb_api_backend[USB_API_WINUSBX].reset_device(i, dev_handle);
4506 if (r != LIBUSB_SUCCESS)
4511 return LIBUSB_SUCCESS;
4514 static enum libusb_transfer_status composite_copy_transfer_data(int sub_api, struct usbi_transfer *itransfer, DWORD length)
4516 struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
4517 struct winusb_transfer_priv *transfer_priv = get_winusb_transfer_priv(itransfer);
4518 struct winusb_device_priv *priv = usbi_get_device_priv(transfer->dev_handle->dev);
4519 int current_interface = transfer_priv->interface_number;
4522 if (priv->usb_interface[current_interface].apib->copy_transfer_data == NULL) {
4523 usbi_err(TRANSFER_CTX(transfer), "program assertion failed - no function to copy transfer data");
4524 return LIBUSB_TRANSFER_ERROR;
4527 return priv->usb_interface[current_interface].apib->
4528 copy_transfer_data(priv->usb_interface[current_interface].sub_api, itransfer, length);