Index: third_party/libusb/src/libusb/os/windows_usb.c |
diff --git a/third_party/libusb/src/libusb/os/windows_usb.c b/third_party/libusb/src/libusb/os/windows_usb.c |
index 0739c1924265e0a17ef49ec1bcc48946cf935e97..51ce55d47608607ebedbc41f2d7abac53accf81b 100644 |
--- a/third_party/libusb/src/libusb/os/windows_usb.c |
+++ b/third_party/libusb/src/libusb/os/windows_usb.c |
@@ -1,8 +1,9 @@ |
/* |
- * windows backend for libusb 1.0 |
- * Copyright (c) 2009-2010 Pete Batard <pbatard@gmail.com> |
+ * windows backend for libusbx 1.0 |
+ * Copyright © 2009-2012 Pete Batard <pete@akeo.ie> |
* With contributions from Michael Plante, Orin Eman et al. |
* Parts of this code adapted from libusb-win32-v1 by Stephan Meyer |
+ * HID Reports IOCTLs inspired from HIDAPI by Alan Ott, Signal 11 Software |
* Hash table functions adapted from glibc, by Ulrich Drepper et al. |
* Major code testing contribution by Xiaofan Chen |
* |
@@ -33,57 +34,67 @@ |
#include <objbase.h> |
#include <winioctl.h> |
-#include <libusbi.h> |
+#include "libusbi.h" |
#include "poll_windows.h" |
#include "windows_usb.h" |
-// The following prevents "banned API" errors when using the MS's WDK OACR/Prefast |
-#if defined(_PREFAST_) |
-#pragma warning(disable:28719) |
-#endif |
- |
// The 2 macros below are used in conjunction with safe loops. |
#define LOOP_CHECK(fcall) { r=fcall; if (r != LIBUSB_SUCCESS) continue; } |
#define LOOP_BREAK(err) { r=err; continue; } |
-extern void usbi_fd_notification(struct libusb_context *ctx); |
- |
// Helper prototypes |
static int windows_get_active_config_descriptor(struct libusb_device *dev, unsigned char *buffer, size_t len, int *host_endian); |
static int windows_clock_gettime(int clk_id, struct timespec *tp); |
unsigned __stdcall windows_clock_gettime_threaded(void* param); |
-// WinUSB API prototypes |
-static int winusb_init(struct libusb_context *ctx); |
-static int winusb_exit(void); |
-static int winusb_open(struct libusb_device_handle *dev_handle); |
-static void winusb_close(struct libusb_device_handle *dev_handle); |
-static int winusb_configure_endpoints(struct libusb_device_handle *dev_handle, int iface); |
-static int winusb_claim_interface(struct libusb_device_handle *dev_handle, int iface); |
-static int winusb_release_interface(struct libusb_device_handle *dev_handle, int iface); |
-static int winusb_submit_control_transfer(struct usbi_transfer *itransfer); |
-static int winusb_set_interface_altsetting(struct libusb_device_handle *dev_handle, int iface, int altsetting); |
-static int winusb_submit_bulk_transfer(struct usbi_transfer *itransfer); |
-static int winusb_clear_halt(struct libusb_device_handle *dev_handle, unsigned char endpoint); |
-static int winusb_abort_transfers(struct usbi_transfer *itransfer); |
-static int winusb_abort_control(struct usbi_transfer *itransfer); |
-static int winusb_reset_device(struct libusb_device_handle *dev_handle); |
-static int winusb_copy_transfer_data(struct usbi_transfer *itransfer, uint32_t io_size); |
+// Common calls |
+static int common_configure_endpoints(int sub_api, struct libusb_device_handle *dev_handle, int iface); |
+ |
+// WinUSB-like API prototypes |
+static int winusbx_init(int sub_api, struct libusb_context *ctx); |
+static int winusbx_exit(int sub_api); |
+static int winusbx_open(int sub_api, struct libusb_device_handle *dev_handle); |
+static void winusbx_close(int sub_api, struct libusb_device_handle *dev_handle); |
+static int winusbx_configure_endpoints(int sub_api, struct libusb_device_handle *dev_handle, int iface); |
+static int winusbx_claim_interface(int sub_api, struct libusb_device_handle *dev_handle, int iface); |
+static int winusbx_release_interface(int sub_api, struct libusb_device_handle *dev_handle, int iface); |
+static int winusbx_submit_control_transfer(int sub_api, struct usbi_transfer *itransfer); |
+static int winusbx_set_interface_altsetting(int sub_api, struct libusb_device_handle *dev_handle, int iface, int altsetting); |
+static int winusbx_submit_bulk_transfer(int sub_api, struct usbi_transfer *itransfer); |
+static int winusbx_clear_halt(int sub_api, struct libusb_device_handle *dev_handle, unsigned char endpoint); |
+static int winusbx_abort_transfers(int sub_api, struct usbi_transfer *itransfer); |
+static int winusbx_abort_control(int sub_api, struct usbi_transfer *itransfer); |
+static int winusbx_reset_device(int sub_api, struct libusb_device_handle *dev_handle); |
+static int winusbx_copy_transfer_data(int sub_api, struct usbi_transfer *itransfer, uint32_t io_size); |
+// HID API prototypes |
+static int hid_init(int sub_api, struct libusb_context *ctx); |
+static int hid_exit(int sub_api); |
+static int hid_open(int sub_api, struct libusb_device_handle *dev_handle); |
+static void hid_close(int sub_api, struct libusb_device_handle *dev_handle); |
+static int hid_claim_interface(int sub_api, struct libusb_device_handle *dev_handle, int iface); |
+static int hid_release_interface(int sub_api, struct libusb_device_handle *dev_handle, int iface); |
+static int hid_set_interface_altsetting(int sub_api, struct libusb_device_handle *dev_handle, int iface, int altsetting); |
+static int hid_submit_control_transfer(int sub_api, struct usbi_transfer *itransfer); |
+static int hid_submit_bulk_transfer(int sub_api, struct usbi_transfer *itransfer); |
+static int hid_clear_halt(int sub_api, struct libusb_device_handle *dev_handle, unsigned char endpoint); |
+static int hid_abort_transfers(int sub_api, struct usbi_transfer *itransfer); |
+static int hid_reset_device(int sub_api, struct libusb_device_handle *dev_handle); |
+static int hid_copy_transfer_data(int sub_api, struct usbi_transfer *itransfer, uint32_t io_size); |
// Composite API prototypes |
-static int composite_init(struct libusb_context *ctx); |
-static int composite_exit(void); |
-static int composite_open(struct libusb_device_handle *dev_handle); |
-static void composite_close(struct libusb_device_handle *dev_handle); |
-static int composite_claim_interface(struct libusb_device_handle *dev_handle, int iface); |
-static int composite_set_interface_altsetting(struct libusb_device_handle *dev_handle, int iface, int altsetting); |
-static int composite_release_interface(struct libusb_device_handle *dev_handle, int iface); |
-static int composite_submit_control_transfer(struct usbi_transfer *itransfer); |
-static int composite_submit_bulk_transfer(struct usbi_transfer *itransfer); |
-static int composite_submit_iso_transfer(struct usbi_transfer *itransfer); |
-static int composite_clear_halt(struct libusb_device_handle *dev_handle, unsigned char endpoint); |
-static int composite_abort_transfers(struct usbi_transfer *itransfer); |
-static int composite_abort_control(struct usbi_transfer *itransfer); |
-static int composite_reset_device(struct libusb_device_handle *dev_handle); |
-static int composite_copy_transfer_data(struct usbi_transfer *itransfer, uint32_t io_size); |
+static int composite_init(int sub_api, struct libusb_context *ctx); |
+static int composite_exit(int sub_api); |
+static int composite_open(int sub_api, struct libusb_device_handle *dev_handle); |
+static void composite_close(int sub_api, struct libusb_device_handle *dev_handle); |
+static int composite_claim_interface(int sub_api, struct libusb_device_handle *dev_handle, int iface); |
+static int composite_set_interface_altsetting(int sub_api, struct libusb_device_handle *dev_handle, int iface, int altsetting); |
+static int composite_release_interface(int sub_api, struct libusb_device_handle *dev_handle, int iface); |
+static int composite_submit_control_transfer(int sub_api, struct usbi_transfer *itransfer); |
+static int composite_submit_bulk_transfer(int sub_api, struct usbi_transfer *itransfer); |
+static int composite_submit_iso_transfer(int sub_api, struct usbi_transfer *itransfer); |
+static int composite_clear_halt(int sub_api, struct libusb_device_handle *dev_handle, unsigned char endpoint); |
+static int composite_abort_transfers(int sub_api, struct usbi_transfer *itransfer); |
+static int composite_abort_control(int sub_api, struct usbi_transfer *itransfer); |
+static int composite_reset_device(int sub_api, struct libusb_device_handle *dev_handle); |
+static int composite_copy_transfer_data(int sub_api, struct usbi_transfer *itransfer, uint32_t io_size); |
// Global variables |
@@ -102,8 +113,12 @@ volatile LONG request_count[2] = {0, 1}; // last one must be > 0 |
HANDLE timer_request[2] = { NULL, NULL }; |
HANDLE timer_response = NULL; |
// API globals |
-bool api_winusb_available = false; |
-#define CHECK_WINUSB_AVAILABLE do { if (!api_winusb_available) return LIBUSB_ERROR_ACCESS; } while (0) |
+#define CHECK_WINUSBX_AVAILABLE(sub_api) do { if (sub_api == SUB_API_NOTSET) sub_api = priv->sub_api; \ |
+ if (!WinUSBX[sub_api].initialized) return LIBUSB_ERROR_ACCESS; } while(0) |
+static struct winusb_interface WinUSBX[SUB_API_MAX]; |
+const char* sub_api_name[SUB_API_MAX] = WINUSBX_DRV_NAMES; |
+bool api_hid_available = false; |
+#define CHECK_HID_AVAILABLE do { if (!api_hid_available) return LIBUSB_ERROR_ACCESS; } while (0) |
static inline BOOLEAN guid_eq(const GUID *guid1, const GUID *guid2) { |
if ((guid1 != NULL) && (guid2 != NULL)) { |
@@ -112,7 +127,7 @@ static inline BOOLEAN guid_eq(const GUID *guid1, const GUID *guid2) { |
return false; |
} |
-#if defined(ENABLE_DEBUG_LOGGING) || (defined(_MSC_VER) && _MSC_VER < 1400) |
+#if defined(ENABLE_LOGGING) |
static char* guid_to_string(const GUID* guid) |
{ |
static char guid_string[MAX_GUID_STRING_LENGTH]; |
@@ -130,17 +145,18 @@ static char* guid_to_string(const GUID* guid) |
* Converts a windows error to human readable string |
* uses retval as errorcode, or, if 0, use GetLastError() |
*/ |
+#if defined(ENABLE_LOGGING) |
static char *windows_error_str(uint32_t retval) |
{ |
static char err_string[ERR_BUFFER_SIZE]; |
DWORD size; |
- size_t i; |
+ ssize_t i; |
uint32_t error_code, format_error; |
error_code = retval?retval:GetLastError(); |
- safe_sprintf(err_string, ERR_BUFFER_SIZE, "[%d] ", error_code); |
+ safe_sprintf(err_string, ERR_BUFFER_SIZE, "[%u] ", error_code); |
size = FormatMessageA(FORMAT_MESSAGE_FROM_SYSTEM, NULL, error_code, |
MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), &err_string[safe_strlen(err_string)], |
@@ -154,12 +170,13 @@ static char err_string[ERR_BUFFER_SIZE]; |
safe_sprintf(err_string, ERR_BUFFER_SIZE, "Unknown error code %u", error_code); |
} else { |
// Remove CR/LF terminators |
- for (i=safe_strlen(err_string)-1; ((err_string[i]==0x0A) || (err_string[i]==0x0D)); i--) { |
+ for (i=safe_strlen(err_string)-1; (i>=0) && ((err_string[i]==0x0A) || (err_string[i]==0x0D)); i--) { |
err_string[i] = 0; |
} |
} |
return err_string; |
} |
+#endif |
/* |
* Sanitize Microsoft's paths: convert to uppercase, add prefix and fix backslashes. |
@@ -185,7 +202,7 @@ static char* sanitize_path(const char* path) |
size += add_root; |
} |
- if ((ret_path = (char*)calloc(size, 1)) == NULL) |
+ if ((ret_path = (char*) calloc(size, 1)) == NULL) |
return NULL; |
safe_strcpy(&ret_path[add_root], size-add_root, path); |
@@ -222,6 +239,7 @@ static int init_dlls(void) |
DLL_LOAD_PREFIXED(SetupAPI.dll, p, SetupDiDestroyDeviceInfoList, TRUE); |
DLL_LOAD_PREFIXED(SetupAPI.dll, p, SetupDiOpenDevRegKey, TRUE); |
DLL_LOAD_PREFIXED(SetupAPI.dll, p, SetupDiGetDeviceRegistryPropertyA, TRUE); |
+ DLL_LOAD_PREFIXED(SetupAPI.dll, p, SetupDiOpenDeviceInterfaceRegKey, TRUE); |
DLL_LOAD_PREFIXED(AdvAPI32.dll, p, RegQueryValueExW, TRUE); |
DLL_LOAD_PREFIXED(AdvAPI32.dll, p, RegCloseKey, TRUE); |
return LIBUSB_SUCCESS; |
@@ -241,7 +259,7 @@ static int init_dlls(void) |
* incremented index starting at zero) until all interfaces have been returned. |
*/ |
static bool get_devinfo_data(struct libusb_context *ctx, |
- HDEVINFO *dev_info, SP_DEVINFO_DATA *dev_info_data, char* usb_class, unsigned _index) |
+ HDEVINFO *dev_info, SP_DEVINFO_DATA *dev_info_data, const char* usb_class, unsigned _index) |
{ |
if (_index <= 0) { |
*dev_info = pSetupDiGetClassDevsA(NULL, usb_class, NULL, DIGCF_PRESENT|DIGCF_ALLCLASSES); |
@@ -344,6 +362,88 @@ err_exit: |
return NULL; |
} |
+/* For libusb0 filter */ |
+static SP_DEVICE_INTERFACE_DETAIL_DATA_A *get_interface_details_filter(struct libusb_context *ctx, |
+ HDEVINFO *dev_info, SP_DEVINFO_DATA *dev_info_data, const GUID* guid, unsigned _index, char* filter_path){ |
+ SP_DEVICE_INTERFACE_DATA dev_interface_data; |
+ SP_DEVICE_INTERFACE_DETAIL_DATA_A *dev_interface_details = NULL; |
+ DWORD size; |
+ if (_index <= 0) { |
+ *dev_info = pSetupDiGetClassDevsA(guid, NULL, NULL, DIGCF_PRESENT|DIGCF_DEVICEINTERFACE); |
+ } |
+ if (dev_info_data != NULL) { |
+ dev_info_data->cbSize = sizeof(SP_DEVINFO_DATA); |
+ if (!pSetupDiEnumDeviceInfo(*dev_info, _index, dev_info_data)) { |
+ if (GetLastError() != ERROR_NO_MORE_ITEMS) { |
+ usbi_err(ctx, "Could not obtain device info data for index %u: %s", |
+ _index, windows_error_str(0)); |
+ } |
+ pSetupDiDestroyDeviceInfoList(*dev_info); |
+ *dev_info = INVALID_HANDLE_VALUE; |
+ return NULL; |
+ } |
+ } |
+ dev_interface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA); |
+ if (!pSetupDiEnumDeviceInterfaces(*dev_info, NULL, guid, _index, &dev_interface_data)) { |
+ if (GetLastError() != ERROR_NO_MORE_ITEMS) { |
+ usbi_err(ctx, "Could not obtain interface data for index %u: %s", |
+ _index, windows_error_str(0)); |
+ } |
+ pSetupDiDestroyDeviceInfoList(*dev_info); |
+ *dev_info = INVALID_HANDLE_VALUE; |
+ return NULL; |
+ } |
+ // Read interface data (dummy + actual) to access the device path |
+ if (!pSetupDiGetDeviceInterfaceDetailA(*dev_info, &dev_interface_data, NULL, 0, &size, NULL)) { |
+ // The dummy call should fail with ERROR_INSUFFICIENT_BUFFER |
+ if (GetLastError() != ERROR_INSUFFICIENT_BUFFER) { |
+ usbi_err(ctx, "could not access interface data (dummy) for index %u: %s", |
+ _index, windows_error_str(0)); |
+ goto err_exit; |
+ } |
+ } else { |
+ usbi_err(ctx, "program assertion failed - http://msdn.microsoft.com/en-us/library/ms792901.aspx is wrong."); |
+ goto err_exit; |
+ } |
+ if ((dev_interface_details = malloc(size)) == NULL) { |
+ usbi_err(ctx, "could not allocate interface data for index %u.", _index); |
+ goto err_exit; |
+ } |
+ dev_interface_details->cbSize = sizeof(SP_DEVICE_INTERFACE_DETAIL_DATA_A); |
+ if (!pSetupDiGetDeviceInterfaceDetailA(*dev_info, &dev_interface_data, |
+ dev_interface_details, size, &size, NULL)) { |
+ usbi_err(ctx, "could not access interface data (actual) for index %u: %s", |
+ _index, windows_error_str(0)); |
+ } |
+ // [trobinso] lookup the libusb0 symbolic index. |
+ if (dev_interface_details) { |
+ HKEY hkey_device_interface=pSetupDiOpenDeviceInterfaceRegKey(*dev_info,&dev_interface_data,0,KEY_READ); |
+ if (hkey_device_interface != INVALID_HANDLE_VALUE) { |
+ DWORD libusb0_symboliclink_index=0; |
+ DWORD value_length=sizeof(DWORD); |
+ DWORD value_type=0; |
+ LONG status; |
+ status = pRegQueryValueExW(hkey_device_interface, L"LUsb0", NULL, &value_type, |
+ (LPBYTE) &libusb0_symboliclink_index, &value_length); |
+ if (status == ERROR_SUCCESS) { |
+ if (libusb0_symboliclink_index < 256) { |
+ // libusb0.sys is connected to this device instance. |
+ // If the the device interface guid is {F9F3FF14-AE21-48A0-8A25-8011A7A931D9} then it's a filter. |
+ safe_sprintf(filter_path, sizeof("\\\\.\\libusb0-0000"), "\\\\.\\libusb0-%04d", libusb0_symboliclink_index); |
+ usbi_dbg("assigned libusb0 symbolic link %s", filter_path); |
+ } else { |
+ // libusb0.sys was connected to this device instance at one time; but not anymore. |
+ } |
+ } |
+ pRegCloseKey(hkey_device_interface); |
+ } |
+ } |
+ return dev_interface_details; |
+err_exit: |
+ pSetupDiDestroyDeviceInfoList(*dev_info); |
+ *dev_info = INVALID_HANDLE_VALUE; |
+ return NULL;} |
+ |
/* Hash table functions - modified From glibc 2.3.2: |
[Aho,Sethi,Ullman] Compilers: Principles, Techniques and Tools, 1986 |
[Knuth] The Art of Computer Programming, part 3 (6.4) */ |
@@ -393,7 +493,7 @@ static int htab_create(struct libusb_context *ctx, unsigned long nel) |
htab_filled = 0; |
// allocate memory and zero out. |
- htab_table = (htab_entry*)calloc(htab_size + 1, sizeof(htab_entry)); |
+ htab_table = (htab_entry*) calloc(htab_size + 1, sizeof(htab_entry)); |
if (htab_table == NULL) { |
usbi_err(ctx, "could not allocate space for hash table"); |
return 0; |
@@ -435,8 +535,11 @@ static unsigned long htab_hash(char* str) |
int c; |
char* sz = str; |
+ if (str == NULL) |
+ return 0; |
+ |
// Compute main hash value (algorithm suggested by Nokia) |
- while ((c = *sz++)) |
+ while ((c = *sz++) != 0) |
r = ((r << 5) + r) + c; |
if (r == 0) |
++r; |
@@ -498,7 +601,7 @@ static unsigned long htab_hash(char* str) |
// string (same hash, different string) at the same time is extremely low |
safe_free(htab_table[idx].str); |
htab_table[idx].used = hval; |
- htab_table[idx].str = (char*) calloc(1, safe_strlen(str)+1); |
+ htab_table[idx].str = (char*) malloc(safe_strlen(str)+1); |
if (htab_table[idx].str == NULL) { |
usbi_err(NULL, "could not duplicate string for hash table"); |
usbi_mutex_unlock(&htab_write_mutex); |
@@ -533,7 +636,7 @@ static unsigned long get_ancestor_session_id(DWORD devinst, unsigned level) |
if (CM_Get_Device_IDA(devinst, path, MAX_PATH_LENGTH, 0) != CR_SUCCESS) { |
return 0; |
} |
- // TODO (post hotplug): try without sanitizing |
+ // TODO: (post hotplug): try without sanitizing |
sanitized_path = sanitize_path(path); |
if (sanitized_path == NULL) { |
return 0; |
@@ -568,7 +671,7 @@ static int windows_assign_endpoints(struct libusb_device_handle *dev_handle, int |
return LIBUSB_SUCCESS; |
} |
- priv->usb_interface[iface].endpoint = (uint8_t*) calloc(1, if_desc->bNumEndpoints); |
+ priv->usb_interface[iface].endpoint = (uint8_t*) malloc(if_desc->bNumEndpoints); |
if (priv->usb_interface[iface].endpoint == NULL) { |
return LIBUSB_ERROR_NO_MEM; |
} |
@@ -580,38 +683,34 @@ static int windows_assign_endpoints(struct libusb_device_handle *dev_handle, int |
} |
libusb_free_config_descriptor(conf_desc); |
- // Extra init is required for WinUSB endpoints |
- if (priv->apib->id == USB_API_WINUSB) { |
- return winusb_configure_endpoints(dev_handle, iface); |
- } |
- |
- return LIBUSB_SUCCESS; |
+ // Extra init may be required to configure endpoints |
+ return priv->apib->configure_endpoints(SUB_API_NOTSET, dev_handle, iface); |
} |
// Lookup for a match in the list of API driver names |
-static bool is_api_driver(char* driver, uint8_t api) |
-{ |
- uint8_t i; |
+// return -1 if not found, driver match number otherwise |
+static int get_sub_api(char* driver, int api){ |
+ int i; |
const char sep_str[2] = {LIST_SEPARATOR, 0}; |
char *tok, *tmp_str; |
size_t len = safe_strlen(driver); |
- if (len == 0) return false; |
- tmp_str = (char*) calloc(1, len+1); |
- if (tmp_str == NULL) return false; |
+ if (len == 0) return SUB_API_NOTSET; |
+ tmp_str = (char*) calloc(len+1, 1); |
+ if (tmp_str == NULL) return SUB_API_NOTSET; |
memcpy(tmp_str, driver, len+1); |
tok = strtok(tmp_str, sep_str); |
while (tok != NULL) { |
for (i=0; i<usb_api_backend[api].nb_driver_names; i++) { |
- if (safe_strcmp(tok, usb_api_backend[api].driver_name_list[i]) == 0) { |
+ if (safe_stricmp(tok, usb_api_backend[api].driver_name_list[i]) == 0) { |
free(tmp_str); |
- return true; |
+ return i; |
} |
} |
tok = strtok(NULL, sep_str); |
} |
free (tmp_str); |
- return false; |
+ return SUB_API_NOTSET; |
} |
/* |
@@ -626,6 +725,14 @@ static int auto_claim(struct libusb_transfer *transfer, int *interface_number, i |
int current_interface = *interface_number; |
int r = LIBUSB_SUCCESS; |
+ switch(api_type) { |
+ case USB_API_WINUSBX: |
+ case USB_API_HID: |
+ break; |
+ default: |
+ return LIBUSB_ERROR_INVALID_PARAM; |
+ } |
+ |
usbi_mutex_lock(&autoclaim_lock); |
if (current_interface < 0) // No serviceable interface was found |
{ |
@@ -684,10 +791,10 @@ static void auto_release(struct usbi_transfer *itransfer) |
} |
/* |
- * init: libusb backend init function |
+ * init: libusbx backend init function |
* |
* This function enumerates the HCDs (Host Controller Drivers) and populates our private HCD list |
- * In our implementation, we equate Windows' "HCD" to LibUSB's "bus". Note that bus is zero indexed. |
+ * In our implementation, we equate Windows' "HCD" to libusbx's "bus". Note that bus is zero indexed. |
* HCDs are not expected to change after init (might not hold true for hot pluggable USB PCI card?) |
*/ |
static int windows_init(struct libusb_context *ctx) |
@@ -748,7 +855,7 @@ static int windows_init(struct libusb_context *ctx) |
// Initialize the low level APIs (we don't care about errors at this stage) |
for (i=0; i<USB_API_MAX; i++) { |
- usb_api_backend[i].init(ctx); |
+ usb_api_backend[i].init(SUB_API_NOTSET, ctx); |
} |
// Because QueryPerformanceCounter might report different values when |
@@ -874,7 +981,7 @@ static int cache_config_descriptors(struct libusb_device *dev, HANDLE hub_handle |
if (dev->num_configurations == 0) |
return LIBUSB_ERROR_INVALID_PARAM; |
- priv->config_descriptor = (unsigned char**) calloc(dev->num_configurations, sizeof(PUSB_CONFIGURATION_DESCRIPTOR)); |
+ priv->config_descriptor = (unsigned char**) calloc(dev->num_configurations, sizeof(unsigned char*)); |
if (priv->config_descriptor == NULL) |
return LIBUSB_ERROR_NO_MEM; |
for (i=0; i<dev->num_configurations; i++) |
@@ -899,15 +1006,16 @@ static int cache_config_descriptors(struct libusb_device *dev, HANDLE hub_handle |
cd_buf_short.req.SetupPacket.wIndex = i; |
cd_buf_short.req.SetupPacket.wLength = (USHORT)(size - sizeof(USB_DESCRIPTOR_REQUEST)); |
- // Dummy call to get the required data size |
+ // Dummy call to get the required data size. Initial failures are reported as info rather |
+ // than error as they can occur for non-penalizing situations, such as with some hubs. |
if (!DeviceIoControl(hub_handle, IOCTL_USB_GET_DESCRIPTOR_FROM_NODE_CONNECTION, &cd_buf_short, size, |
&cd_buf_short, size, &ret_size, NULL)) { |
- usbi_err(ctx, "could not access configuration descriptor (dummy) for '%s': %s", device_id, windows_error_str(0)); |
+ usbi_info(ctx, "could not access configuration descriptor (dummy) for '%s': %s", device_id, windows_error_str(0)); |
LOOP_BREAK(LIBUSB_ERROR_IO); |
} |
if ((ret_size != size) || (cd_buf_short.data.wTotalLength < sizeof(USB_CONFIGURATION_DESCRIPTOR))) { |
- usbi_err(ctx, "unexpected configuration descriptor size (dummy) for '%s'.", device_id); |
+ usbi_info(ctx, "unexpected configuration descriptor size (dummy) for '%s'.", device_id); |
LOOP_BREAK(LIBUSB_ERROR_IO); |
} |
@@ -948,7 +1056,7 @@ static int cache_config_descriptors(struct libusb_device *dev, HANDLE hub_handle |
i, cd_data->bConfigurationValue, cd_data->wTotalLength); |
// Cache the descriptor |
- priv->config_descriptor[i] = (unsigned char*) calloc(1, cd_data->wTotalLength); |
+ priv->config_descriptor[i] = (unsigned char*) malloc(cd_data->wTotalLength); |
if (priv->config_descriptor[i] == NULL) |
return LIBUSB_ERROR_NO_MEM; |
memcpy(priv->config_descriptor[i], cd_data, cd_data->wTotalLength); |
@@ -957,7 +1065,7 @@ static int cache_config_descriptors(struct libusb_device *dev, HANDLE hub_handle |
} |
/* |
- * Populate a libusb device structure |
+ * Populate a libusbx device structure |
*/ |
static int init_device(struct libusb_device* dev, struct libusb_device* parent_dev, |
uint8_t port_number, char* device_id, DWORD devinst) |
@@ -999,8 +1107,10 @@ static int init_device(struct libusb_device* dev, struct libusb_device* parent_d |
} |
dev->bus_number = parent_dev->bus_number; |
priv->port = port_number; |
+ dev->port_number = port_number; |
priv->depth = parent_priv->depth + 1; |
priv->parent_dev = parent_dev; |
+ dev->parent_dev = libusb_ref_device(parent_dev); |
// If the device address is already set, we can stop here |
if (dev->device_address != 0) { |
@@ -1042,7 +1152,10 @@ static int init_device(struct libusb_device* dev, struct libusb_device* parent_d |
if (conn_info.DeviceAddress > UINT8_MAX) { |
usbi_err(ctx, "program assertion failed: device address overflow"); |
} |
- dev->device_address = (uint8_t)conn_info.DeviceAddress; |
+ dev->device_address = (uint8_t)conn_info.DeviceAddress + 1; |
+ if (dev->device_address == 1) { |
+ usbi_err(ctx, "program assertion failed: device address collision with root hub"); |
+ } |
switch (conn_info.Speed) { |
case 0: dev->speed = LIBUSB_SPEED_LOW; break; |
case 1: dev->speed = LIBUSB_SPEED_FULL; break; |
@@ -1053,10 +1166,12 @@ static int init_device(struct libusb_device* dev, struct libusb_device* parent_d |
break; |
} |
} else { |
- dev->device_address = UINT8_MAX; // Hubs from HCD have a devaddr of 255 |
+ dev->device_address = 1; // root hubs are set to use device number 1 |
force_hcd_device_descriptor(dev); |
} |
+ usbi_sanitize_device(dev); |
+ |
usbi_dbg("(bus: %d, addr: %d, depth: %d, port: %d): '%s'", |
dev->bus_number, dev->device_address, priv->depth, priv->port, device_id); |
@@ -1064,8 +1179,8 @@ static int init_device(struct libusb_device* dev, struct libusb_device* parent_d |
} |
// Returns the api type, or 0 if not found/unsupported |
-static uint8_t get_api_type(struct libusb_context *ctx, |
- HDEVINFO *dev_info, SP_DEVINFO_DATA *dev_info_data) |
+static void get_api_type(struct libusb_context *ctx, HDEVINFO *dev_info, |
+ SP_DEVINFO_DATA *dev_info_data, int *api, int *sub_api) |
{ |
// Precedence for filter drivers vs driver is in the order of this array |
struct driver_lookup lookup[3] = { |
@@ -1075,8 +1190,10 @@ static uint8_t get_api_type(struct libusb_context *ctx, |
}; |
DWORD size, reg_type; |
unsigned k, l; |
- uint8_t api; |
+ int i, j; |
+ *api = USB_API_UNSUPPORTED; |
+ *sub_api = SUB_API_NOTSET; |
// Check the service & filter names to know the API we should use |
for (k=0; k<3; k++) { |
if (pSetupDiGetDeviceRegistryPropertyA(*dev_info, dev_info_data, lookup[k].reg_prop, |
@@ -1094,7 +1211,6 @@ static uint8_t get_api_type(struct libusb_context *ctx, |
lookup[k].list[l] = LIST_SEPARATOR; |
} |
} |
- upperize(lookup[k].list); |
usbi_dbg("%s(s): %s", lookup[k].designation, lookup[k].list); |
} else { |
if (GetLastError() != ERROR_INVALID_DATA) { |
@@ -1104,21 +1220,22 @@ static uint8_t get_api_type(struct libusb_context *ctx, |
} |
} |
- for (api=1; api<USB_API_MAX; api++) { |
+ for (i=1; i<USB_API_MAX; i++) { |
for (k=0; k<3; k++) { |
- if (is_api_driver(lookup[k].list, api)) { |
- usbi_dbg("matched %s name against %s", lookup[k].designation, usb_api_backend[api].designation); |
- break; |
+ j = get_sub_api(lookup[k].list, i); |
+ if (j >= 0) { |
+ usbi_dbg("matched %s name against %s API", |
+ lookup[k].designation, (i!=USB_API_WINUSBX)?usb_api_backend[i].designation:sub_api_name[j]); |
+ *api = i; |
+ *sub_api = j; |
+ return; |
} |
} |
- if (k >= 3) continue; |
- return api; |
} |
- return 0; |
} |
static int set_composite_interface(struct libusb_context* ctx, struct libusb_device* dev, |
- char* dev_interface_path, char* device_id, uint8_t api) |
+ char* dev_interface_path, char* device_id, int api, int sub_api) |
{ |
unsigned i; |
struct windows_device_priv *priv = _device_priv(dev); |
@@ -1148,36 +1265,78 @@ static int set_composite_interface(struct libusb_context* ctx, struct libusb_dev |
} |
if (priv->usb_interface[interface_number].path != NULL) { |
- usbi_warn(ctx, "interface[%d] already set - ignoring: %s", interface_number, device_id); |
- return LIBUSB_ERROR_ACCESS; |
+ if (api == USB_API_HID) { |
+ // HID devices can have multiple collections (COL##) for each MI_## interface |
+ usbi_dbg("interface[%d] already set - ignoring HID collection: %s", |
+ interface_number, device_id); |
+ return LIBUSB_ERROR_ACCESS; |
+ } |
+ // In other cases, just use the latest data |
+ safe_free(priv->usb_interface[interface_number].path); |
} |
usbi_dbg("interface[%d] = %s", interface_number, dev_interface_path); |
priv->usb_interface[interface_number].path = dev_interface_path; |
priv->usb_interface[interface_number].apib = &usb_api_backend[api]; |
- priv->composite_api_flags |= 1<<api; |
+ priv->usb_interface[interface_number].sub_api = sub_api; |
+ if ((api == USB_API_HID) && (priv->hid == NULL)) { |
+ priv->hid = (struct hid_device_priv*) calloc(1, sizeof(struct hid_device_priv)); |
+ if (priv->hid == NULL) |
+ return LIBUSB_ERROR_NO_MEM; |
+ } |
+ |
+ return LIBUSB_SUCCESS; |
+} |
+ |
+static int set_hid_interface(struct libusb_context* ctx, struct libusb_device* dev, |
+ char* dev_interface_path) |
+{ |
+ int i; |
+ struct windows_device_priv *priv = _device_priv(dev); |
+ |
+ if (priv->hid == NULL) { |
+ usbi_err(ctx, "program assertion failed: parent is not HID"); |
+ return LIBUSB_ERROR_NO_DEVICE; |
+ } |
+ if (priv->hid->nb_interfaces == USB_MAXINTERFACES) { |
+ usbi_err(ctx, "program assertion failed: max USB interfaces reached for HID device"); |
+ return LIBUSB_ERROR_NO_DEVICE; |
+ } |
+ for (i=0; i<priv->hid->nb_interfaces; i++) { |
+ if (safe_strcmp(priv->usb_interface[i].path, dev_interface_path) == 0) { |
+ usbi_dbg("interface[%d] already set to %s", i, dev_interface_path); |
+ return LIBUSB_SUCCESS; |
+ } |
+ } |
+ priv->usb_interface[priv->hid->nb_interfaces].path = dev_interface_path; |
+ priv->usb_interface[priv->hid->nb_interfaces].apib = &usb_api_backend[USB_API_HID]; |
+ usbi_dbg("interface[%d] = %s", priv->hid->nb_interfaces, dev_interface_path); |
+ priv->hid->nb_interfaces++; |
return LIBUSB_SUCCESS; |
} |
/* |
- * get_device_list: libusb backend device enumeration function |
+ * get_device_list: libusbx backend device enumeration function |
*/ |
static int windows_get_device_list(struct libusb_context *ctx, struct discovered_devs **_discdevs) |
{ |
struct discovered_devs *discdevs; |
HDEVINFO dev_info = { 0 }; |
- char* usb_class[2] = {"USB", "NUSB3"}; |
- SP_DEVINFO_DATA dev_info_data; |
+ const char* usb_class[] = {"USB", "NUSB3", "IUSB3"}; |
+ SP_DEVINFO_DATA dev_info_data = { 0 }; |
SP_DEVICE_INTERFACE_DETAIL_DATA_A *dev_interface_details = NULL; |
+ GUID hid_guid; |
#define MAX_ENUM_GUIDS 64 |
const GUID* guid[MAX_ENUM_GUIDS]; |
#define HCD_PASS 0 |
#define HUB_PASS 1 |
#define GEN_PASS 2 |
#define DEV_PASS 3 |
+#define HID_PASS 4 |
int r = LIBUSB_SUCCESS; |
- int class_index = 0; |
+ int api, sub_api; |
+ size_t class_index = 0; |
unsigned int nb_guids, pass, i, j, ancestor; |
char path[MAX_PATH_LENGTH]; |
char strbuf[MAX_PATH_LENGTH]; |
@@ -1187,12 +1346,10 @@ static int windows_get_device_list(struct libusb_context *ctx, struct discovered |
char* dev_id_path = NULL; |
unsigned long session_id; |
DWORD size, reg_type, port_nr, install_state; |
- BOOL b = FALSE; |
HKEY key; |
WCHAR guid_string_w[MAX_GUID_STRING_LENGTH]; |
GUID* if_guid; |
LONG s; |
- uint8_t api; |
// Keep a list of newly allocated devs to unref |
libusb_device** unref_list; |
unsigned int unref_size = 64; |
@@ -1203,14 +1360,17 @@ static int windows_get_device_list(struct libusb_context *ctx, struct discovered |
// PASS 3 : (re)enumerate generic USB devices (including driverless) |
// and list additional USB device interface GUIDs to explore |
// PASS 4 : (re)enumerate master USB devices that have a device interface |
- // PASS 5+: (re)enumerate device interfaced GUIDs and set the device interfaces. |
+ // PASS 5+: (re)enumerate device interfaced GUIDs (including HID) and |
+ // set the device interfaces. |
// Init the GUID table |
guid[HCD_PASS] = &GUID_DEVINTERFACE_USB_HOST_CONTROLLER; |
guid[HUB_PASS] = &GUID_DEVINTERFACE_USB_HUB; |
guid[GEN_PASS] = NULL; |
guid[DEV_PASS] = &GUID_DEVINTERFACE_USB_DEVICE; |
- nb_guids = DEV_PASS+1; |
+ HidD_GetHidGuid(&hid_guid); |
+ guid[HID_PASS] = &hid_guid; |
+ nb_guids = HID_PASS+1; |
unref_list = (libusb_device**) calloc(unref_size, sizeof(libusb_device*)); |
if (unref_list == NULL) { |
@@ -1220,23 +1380,9 @@ static int windows_get_device_list(struct libusb_context *ctx, struct discovered |
for (pass = 0; ((pass < nb_guids) && (r == LIBUSB_SUCCESS)); pass++) { |
//#define ENUM_DEBUG |
#ifdef ENUM_DEBUG |
- switch(pass) { |
- case HCD_PASS: |
- usbi_dbg("PROCESSING HCDs %s", guid_to_string(guid[pass])); |
- break; |
- case HUB_PASS: |
- usbi_dbg("PROCESSING HUBs %s", guid_to_string(guid[pass])); |
- break; |
- case DEV_PASS: |
- usbi_dbg("PROCESSING DEVs %s", guid_to_string(guid[pass])); |
- break; |
- case GEN_PASS: |
- usbi_dbg("PROCESSING GENs"); |
- break; |
- default: |
- usbi_dbg("PROCESSING EXTs %s", guid_to_string(guid[pass])); |
- break; |
- } |
+ const char *passname[] = { "HCD", "HUB", "GEN", "DEV", "HID", "EXT" }; |
+ usbi_dbg("\n#### PROCESSING %ss %s", passname[(pass<=HID_PASS)?pass:HID_PASS+1], |
+ (pass!=GEN_PASS)?guid_to_string(guid[pass]):""); |
#endif |
for (i = 0; ; i++) { |
// safe loop: free up any (unprotected) dynamic resource |
@@ -1269,13 +1415,15 @@ static int windows_get_device_list(struct libusb_context *ctx, struct discovered |
} |
} else { |
// Workaround for a Nec/Renesas USB 3.0 driver bug where root hubs are |
- // being listed under the "NUSB3" PnP Symbolic Name rather than "USB" |
- while ( (class_index < 2) && |
- (!(b = get_devinfo_data(ctx, &dev_info, &dev_info_data, usb_class[class_index], i))) ) { |
- class_index++; |
- i = 0; |
+ // being listed under the "NUSB3" PnP Symbolic Name rather than "USB". |
+ // The Intel USB 3.0 driver behaves similar, but uses "IUSB3" |
+ for (; class_index < ARRAYSIZE(usb_class); class_index++) { |
+ if (get_devinfo_data(ctx, &dev_info, &dev_info_data, usb_class[class_index], i)) |
+ break; |
+ i = 0; |
} |
- if (!b) break; |
+ if (class_index >= ARRAYSIZE(usb_class)) |
+ break; |
} |
// Read the Device ID path. This is what we'll use as UID |
@@ -1309,6 +1457,7 @@ static int windows_get_device_list(struct libusb_context *ctx, struct discovered |
// Set API to use or get additional data from generic pass |
api = USB_API_UNSUPPORTED; |
+ sub_api = SUB_API_NOTSET; |
switch (pass) { |
case HCD_PASS: |
break; |
@@ -1318,7 +1467,7 @@ static int windows_get_device_list(struct libusb_context *ctx, struct discovered |
if (!pSetupDiGetDeviceRegistryPropertyA(dev_info, &dev_info_data, SPDRP_DRIVER, |
®_type, (BYTE*)strbuf, size, &size)) { |
usbi_info(ctx, "The following device has no driver: '%s'", dev_id_path); |
- usbi_info(ctx, "libusb will not be able to access it."); |
+ usbi_info(ctx, "libusbx will not be able to access it."); |
} |
// ...and to add the additional device interface GUIDs |
key = pSetupDiOpenDevRegKey(dev_info, &dev_info_data, DICS_FLAG_GLOBAL, 0, DIREG_DEV, KEY_READ); |
@@ -1340,6 +1489,9 @@ static int windows_get_device_list(struct libusb_context *ctx, struct discovered |
} |
} |
break; |
+ case HID_PASS: |
+ api = USB_API_HID; |
+ break; |
default: |
// Get the API type (after checking that the driver installation is OK) |
if ( (!pSetupDiGetDeviceRegistryPropertyA(dev_info, &dev_info_data, SPDRP_INSTALL_STATE, |
@@ -1352,7 +1504,7 @@ static int windows_get_device_list(struct libusb_context *ctx, struct discovered |
dev_id_path, install_state); |
continue; |
} |
- api = get_api_type(ctx, &dev_info, &dev_info_data); |
+ get_api_type(ctx, &dev_info, &dev_info_data, &api, &sub_api); |
break; |
} |
@@ -1373,7 +1525,7 @@ static int windows_get_device_list(struct libusb_context *ctx, struct discovered |
parent_dev = usbi_get_device_by_session_id(ctx, session_id); |
} |
if (parent_dev == NULL) { |
- usbi_dbg("unlisted ancestor for '%s' (newly connected, etc.) - ignoring", dev_id_path); |
+ usbi_dbg("unlisted ancestor for '%s' (non USB HID, newly connected, etc.) - ignoring", dev_id_path); |
continue; |
} |
parent_priv = _device_priv(parent_dev); |
@@ -1405,7 +1557,7 @@ static int windows_get_device_list(struct libusb_context *ctx, struct discovered |
unref_list[unref_cur++] = dev; |
if (unref_cur >= unref_size) { |
unref_size += 64; |
- unref_list = realloc(unref_list, unref_size*sizeof(libusb_device*)); |
+ unref_list = usbi_reallocf(unref_list, unref_size*sizeof(libusb_device*)); |
if (unref_list == NULL) { |
usbi_err(ctx, "could not realloc list for unref - aborting."); |
LOOP_BREAK(LIBUSB_ERROR_NO_MEM); |
@@ -1425,6 +1577,7 @@ static int windows_get_device_list(struct libusb_context *ctx, struct discovered |
dev->device_address = 0; |
dev->num_configurations = 0; |
priv->apib = &usb_api_backend[USB_API_HUB]; |
+ priv->sub_api = SUB_API_NOTSET; |
priv->depth = UINT8_MAX; // Overflow to 0 for HCD Hubs |
priv->path = dev_interface_path; dev_interface_path = NULL; |
break; |
@@ -1436,10 +1589,18 @@ static int windows_get_device_list(struct libusb_context *ctx, struct discovered |
// Take care of API initialization |
priv->path = dev_interface_path; dev_interface_path = NULL; |
priv->apib = &usb_api_backend[api]; |
+ priv->sub_api = sub_api; |
switch(api) { |
case USB_API_COMPOSITE: |
case USB_API_HUB: |
break; |
+ case USB_API_HID: |
+ priv->hid = calloc(1, sizeof(struct hid_device_priv)); |
+ if (priv->hid == NULL) { |
+ LOOP_BREAK(LIBUSB_ERROR_NO_MEM); |
+ } |
+ priv->hid->nb_interfaces = 0; |
+ break; |
default: |
// For other devices, the first interface is the same as the device |
priv->usb_interface[0].path = (char*) calloc(safe_strlen(priv->path)+1, 1); |
@@ -1471,10 +1632,15 @@ static int windows_get_device_list(struct libusb_context *ctx, struct discovered |
r = LIBUSB_SUCCESS; |
} |
break; |
- default: // later passes |
- if (parent_priv->apib->id == USB_API_COMPOSITE) { |
+ default: // HID_PASS and later |
+ if (parent_priv->apib->id == USB_API_HID) { |
+ usbi_dbg("setting HID interface for [%lX]:", parent_dev->session_data); |
+ r = set_hid_interface(ctx, parent_dev, dev_interface_path); |
+ if (r != LIBUSB_SUCCESS) LOOP_BREAK(r); |
+ dev_interface_path = NULL; |
+ } else if (parent_priv->apib->id == USB_API_COMPOSITE) { |
usbi_dbg("setting composite interface for [%lX]:", parent_dev->session_data); |
- switch (set_composite_interface(ctx, parent_dev, dev_interface_path, dev_id_path, api)) { |
+ switch (set_composite_interface(ctx, parent_dev, dev_interface_path, dev_id_path, api, sub_api)) { |
case LIBUSB_SUCCESS: |
dev_interface_path = NULL; |
break; |
@@ -1492,7 +1658,7 @@ static int windows_get_device_list(struct libusb_context *ctx, struct discovered |
} |
// Free any additional GUIDs |
- for (pass = DEV_PASS+1; pass < nb_guids; pass++) { |
+ for (pass = HID_PASS+1; pass < nb_guids; pass++) { |
safe_free(guid[pass]); |
} |
@@ -1506,7 +1672,7 @@ static int windows_get_device_list(struct libusb_context *ctx, struct discovered |
} |
/* |
- * exit: libusb backend deinitialization function |
+ * exit: libusbx backend deinitialization function |
*/ |
static void windows_exit(void) |
{ |
@@ -1530,7 +1696,7 @@ static void windows_exit(void) |
// Only works if exits and inits are balanced exactly |
if (--concurrent_usage < 0) { // Last exit |
for (i=0; i<USB_API_MAX; i++) { |
- usb_api_backend[i].exit(); |
+ usb_api_backend[i].exit(SUB_API_NOTSET); |
} |
exit_polling(); |
@@ -1591,8 +1757,9 @@ static int windows_get_config_descriptor(struct libusb_device *dev, uint8_t conf |
size = min(config_header->wTotalLength, len); |
memcpy(buffer, priv->config_descriptor[config_index], size); |
+ *host_endian = 0; |
- return LIBUSB_SUCCESS; |
+ return size; |
} |
/* |
@@ -1619,14 +1786,14 @@ static int windows_open(struct libusb_device_handle *dev_handle) |
return LIBUSB_ERROR_NO_DEVICE; |
} |
- return priv->apib->open(dev_handle); |
+ return priv->apib->open(SUB_API_NOTSET, dev_handle); |
} |
static void windows_close(struct libusb_device_handle *dev_handle) |
{ |
struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
- priv->apib->close(dev_handle); |
+ priv->apib->close(SUB_API_NOTSET, dev_handle); |
} |
static int windows_get_configuration(struct libusb_device_handle *dev_handle, int *config) |
@@ -1677,7 +1844,7 @@ static int windows_claim_interface(struct libusb_device_handle *dev_handle, int |
safe_free(priv->usb_interface[iface].endpoint); |
priv->usb_interface[iface].nb_endpoints= 0; |
- r = priv->apib->claim_interface(dev_handle, iface); |
+ r = priv->apib->claim_interface(SUB_API_NOTSET, dev_handle, iface); |
if (r == LIBUSB_SUCCESS) { |
r = windows_assign_endpoints(dev_handle, iface, 0); |
@@ -1694,7 +1861,7 @@ static int windows_set_interface_altsetting(struct libusb_device_handle *dev_han |
safe_free(priv->usb_interface[iface].endpoint); |
priv->usb_interface[iface].nb_endpoints= 0; |
- r = priv->apib->set_interface_altsetting(dev_handle, iface, altsetting); |
+ r = priv->apib->set_interface_altsetting(SUB_API_NOTSET, dev_handle, iface, altsetting); |
if (r == LIBUSB_SUCCESS) { |
r = windows_assign_endpoints(dev_handle, iface, altsetting); |
@@ -1707,19 +1874,19 @@ static int windows_release_interface(struct libusb_device_handle *dev_handle, in |
{ |
struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
- return priv->apib->release_interface(dev_handle, iface); |
+ return priv->apib->release_interface(SUB_API_NOTSET, dev_handle, iface); |
} |
static int windows_clear_halt(struct libusb_device_handle *dev_handle, unsigned char endpoint) |
{ |
struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
- return priv->apib->clear_halt(dev_handle, endpoint); |
+ return priv->apib->clear_halt(SUB_API_NOTSET, dev_handle, endpoint); |
} |
static int windows_reset_device(struct libusb_device_handle *dev_handle) |
{ |
struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
- return priv->apib->reset_device(dev_handle); |
+ return priv->apib->reset_device(SUB_API_NOTSET, dev_handle); |
} |
// The 3 functions below are unlikely to ever get supported on Windows |
@@ -1747,7 +1914,8 @@ static void windows_clear_transfer_priv(struct usbi_transfer *itransfer) |
{ |
struct windows_transfer_priv *transfer_priv = (struct windows_transfer_priv*)usbi_transfer_get_os_priv(itransfer); |
- usbi_free_fd(transfer_priv->pollable_fd.fd); |
+ usbi_free_fd(&transfer_priv->pollable_fd); |
+ safe_free(transfer_priv->hid_buffer); |
// When auto claim is in use, attempt to release the auto-claimed interface |
auto_release(itransfer); |
} |
@@ -1760,7 +1928,7 @@ static int submit_bulk_transfer(struct usbi_transfer *itransfer) |
struct windows_device_priv *priv = _device_priv(transfer->dev_handle->dev); |
int r; |
- r = priv->apib->submit_bulk_transfer(itransfer); |
+ r = priv->apib->submit_bulk_transfer(SUB_API_NOTSET, itransfer); |
if (r != LIBUSB_SUCCESS) { |
return r; |
} |
@@ -1768,6 +1936,7 @@ static int submit_bulk_transfer(struct usbi_transfer *itransfer) |
usbi_add_pollfd(ctx, transfer_priv->pollable_fd.fd, |
(short)(IS_XFERIN(transfer) ? POLLIN : POLLOUT)); |
+ itransfer->flags |= USBI_TRANSFER_UPDATED_FDS; |
return LIBUSB_SUCCESS; |
} |
@@ -1779,7 +1948,7 @@ static int submit_iso_transfer(struct usbi_transfer *itransfer) |
struct windows_device_priv *priv = _device_priv(transfer->dev_handle->dev); |
int r; |
- r = priv->apib->submit_iso_transfer(itransfer); |
+ r = priv->apib->submit_iso_transfer(SUB_API_NOTSET, itransfer); |
if (r != LIBUSB_SUCCESS) { |
return r; |
} |
@@ -1787,6 +1956,7 @@ static int submit_iso_transfer(struct usbi_transfer *itransfer) |
usbi_add_pollfd(ctx, transfer_priv->pollable_fd.fd, |
(short)(IS_XFERIN(transfer) ? POLLIN : POLLOUT)); |
+ itransfer->flags |= USBI_TRANSFER_UPDATED_FDS; |
return LIBUSB_SUCCESS; |
} |
@@ -1798,13 +1968,14 @@ static int submit_control_transfer(struct usbi_transfer *itransfer) |
struct windows_device_priv *priv = _device_priv(transfer->dev_handle->dev); |
int r; |
- r = priv->apib->submit_control_transfer(itransfer); |
+ r = priv->apib->submit_control_transfer(SUB_API_NOTSET, itransfer); |
if (r != LIBUSB_SUCCESS) { |
return r; |
} |
usbi_add_pollfd(ctx, transfer_priv->pollable_fd.fd, POLLIN); |
+ itransfer->flags |= USBI_TRANSFER_UPDATED_FDS; |
return LIBUSB_SUCCESS; |
} |
@@ -1835,7 +2006,7 @@ static int windows_abort_control(struct usbi_transfer *itransfer) |
struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
struct windows_device_priv *priv = _device_priv(transfer->dev_handle->dev); |
- return priv->apib->abort_control(itransfer); |
+ return priv->apib->abort_control(SUB_API_NOTSET, itransfer); |
} |
static int windows_abort_transfers(struct usbi_transfer *itransfer) |
@@ -1843,7 +2014,7 @@ static int windows_abort_transfers(struct usbi_transfer *itransfer) |
struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
struct windows_device_priv *priv = _device_priv(transfer->dev_handle->dev); |
- return priv->apib->abort_transfers(itransfer); |
+ return priv->apib->abort_transfers(SUB_API_NOTSET, itransfer); |
} |
static int windows_cancel_transfer(struct usbi_transfer *itransfer) |
@@ -1867,13 +2038,13 @@ static void windows_transfer_callback(struct usbi_transfer *itransfer, uint32_t |
{ |
struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
struct windows_device_priv *priv = _device_priv(transfer->dev_handle->dev); |
- int status; |
+ int status, istatus; |
- usbi_dbg("handling I/O completion with errcode %d", io_result); |
+ usbi_dbg("handling I/O completion with errcode %d, size %d", io_result, io_size); |
switch(io_result) { |
case NO_ERROR: |
- status = priv->apib->copy_transfer_data(itransfer, io_size); |
+ status = priv->apib->copy_transfer_data(SUB_API_NOTSET, itransfer, io_size); |
break; |
case ERROR_GEN_FAILURE: |
usbi_dbg("detected endpoint stall"); |
@@ -1884,6 +2055,10 @@ static void windows_transfer_callback(struct usbi_transfer *itransfer, uint32_t |
status = LIBUSB_TRANSFER_TIMED_OUT; |
break; |
case ERROR_OPERATION_ABORTED: |
+ istatus = priv->apib->copy_transfer_data(SUB_API_NOTSET, itransfer, io_size); |
+ if (istatus != LIBUSB_TRANSFER_COMPLETED) { |
+ usbi_dbg("Failed to copy partial data in aborted operation: %d", istatus); |
+ } |
if (itransfer->flags & USBI_TRANSFER_TIMED_OUT) { |
usbi_dbg("detected timeout"); |
status = LIBUSB_TRANSFER_TIMED_OUT; |
@@ -1893,7 +2068,7 @@ static void windows_transfer_callback(struct usbi_transfer *itransfer, uint32_t |
} |
break; |
default: |
- usbi_err(ITRANSFER_CTX(itransfer), "detected I/O error: %s", windows_error_str(0)); |
+ usbi_err(ITRANSFER_CTX(itransfer), "detected I/O error %d: %s", io_result, windows_error_str(0)); |
status = LIBUSB_TRANSFER_ERROR; |
break; |
} |
@@ -1967,6 +2142,7 @@ static int windows_handle_events(struct libusb_context *ctx, struct pollfd *fds, |
windows_handle_callback(transfer, io_result, io_size); |
} else { |
usbi_err(ctx, "could not find a matching transfer for fd %x", fds[i]); |
+ usbi_mutex_unlock(&ctx->open_devs_lock); |
return LIBUSB_ERROR_NOT_FOUND; |
} |
} |
@@ -2039,8 +2215,6 @@ unsigned __stdcall windows_clock_gettime_threaded(void* param) |
return 0; |
} |
} |
- usbi_dbg("ERROR: broken timer thread"); |
- return 1; |
} |
static int windows_clock_gettime(int clk_id, struct timespec *tp) |
@@ -2092,16 +2266,19 @@ static int windows_clock_gettime(int clk_id, struct timespec *tp) |
// NB: MSVC6 does not support named initializers. |
const struct usbi_os_backend windows_backend = { |
"Windows", |
+ USBI_CAP_HAS_HID_ACCESS, |
windows_init, |
windows_exit, |
windows_get_device_list, |
+ NULL, /* hotplug_poll */ |
windows_open, |
windows_close, |
windows_get_device_descriptor, |
windows_get_active_config_descriptor, |
windows_get_config_descriptor, |
+ NULL, /* get_config_descriptor_by_value() */ |
windows_get_configuration, |
windows_set_configuration, |
@@ -2138,67 +2315,73 @@ const struct usbi_os_backend windows_backend = { |
/* |
* USB API backends |
*/ |
-static int unsupported_init(struct libusb_context *ctx) { |
+static int unsupported_init(int sub_api, struct libusb_context *ctx) { |
return LIBUSB_SUCCESS; |
} |
-static int unsupported_exit(void) { |
+static int unsupported_exit(int sub_api) { |
return LIBUSB_SUCCESS; |
} |
-static int unsupported_open(struct libusb_device_handle *dev_handle) { |
+static int unsupported_open(int sub_api, struct libusb_device_handle *dev_handle) { |
PRINT_UNSUPPORTED_API(open); |
} |
-static void unsupported_close(struct libusb_device_handle *dev_handle) { |
+static void unsupported_close(int sub_api, struct libusb_device_handle *dev_handle) { |
usbi_dbg("unsupported API call for 'close'"); |
} |
-static int unsupported_claim_interface(struct libusb_device_handle *dev_handle, int iface) { |
+static int unsupported_configure_endpoints(int sub_api, struct libusb_device_handle *dev_handle, int iface) { |
+ PRINT_UNSUPPORTED_API(configure_endpoints); |
+} |
+static int unsupported_claim_interface(int sub_api, struct libusb_device_handle *dev_handle, int iface) { |
PRINT_UNSUPPORTED_API(claim_interface); |
} |
-static int unsupported_set_interface_altsetting(struct libusb_device_handle *dev_handle, int iface, int altsetting) { |
+static int unsupported_set_interface_altsetting(int sub_api, struct libusb_device_handle *dev_handle, int iface, int altsetting) { |
PRINT_UNSUPPORTED_API(set_interface_altsetting); |
} |
-static int unsupported_release_interface(struct libusb_device_handle *dev_handle, int iface) { |
+static int unsupported_release_interface(int sub_api, struct libusb_device_handle *dev_handle, int iface) { |
PRINT_UNSUPPORTED_API(release_interface); |
} |
-static int unsupported_clear_halt(struct libusb_device_handle *dev_handle, unsigned char endpoint) { |
+static int unsupported_clear_halt(int sub_api, struct libusb_device_handle *dev_handle, unsigned char endpoint) { |
PRINT_UNSUPPORTED_API(clear_halt); |
} |
-static int unsupported_reset_device(struct libusb_device_handle *dev_handle) { |
+static int unsupported_reset_device(int sub_api, struct libusb_device_handle *dev_handle) { |
PRINT_UNSUPPORTED_API(reset_device); |
} |
-static int unsupported_submit_bulk_transfer(struct usbi_transfer *itransfer) { |
+static int unsupported_submit_bulk_transfer(int sub_api, struct usbi_transfer *itransfer) { |
PRINT_UNSUPPORTED_API(submit_bulk_transfer); |
} |
-static int unsupported_submit_iso_transfer(struct usbi_transfer *itransfer) { |
+static int unsupported_submit_iso_transfer(int sub_api, struct usbi_transfer *itransfer) { |
PRINT_UNSUPPORTED_API(submit_iso_transfer); |
} |
-static int unsupported_submit_control_transfer(struct usbi_transfer *itransfer) { |
+static int unsupported_submit_control_transfer(int sub_api, struct usbi_transfer *itransfer) { |
PRINT_UNSUPPORTED_API(submit_control_transfer); |
} |
-static int unsupported_abort_control(struct usbi_transfer *itransfer) { |
+static int unsupported_abort_control(int sub_api, struct usbi_transfer *itransfer) { |
PRINT_UNSUPPORTED_API(abort_control); |
} |
-static int unsupported_abort_transfers(struct usbi_transfer *itransfer) { |
+static int unsupported_abort_transfers(int sub_api, struct usbi_transfer *itransfer) { |
PRINT_UNSUPPORTED_API(abort_transfers); |
} |
-static int unsupported_copy_transfer_data(struct usbi_transfer *itransfer, uint32_t io_size) { |
+static int unsupported_copy_transfer_data(int sub_api, struct usbi_transfer *itransfer, uint32_t io_size) { |
PRINT_UNSUPPORTED_API(copy_transfer_data); |
} |
- |
+static int common_configure_endpoints(int sub_api, struct libusb_device_handle *dev_handle, int iface) { |
+ return LIBUSB_SUCCESS; |
+} |
// These names must be uppercase |
-const char* hub_driver_names[] = {"USBHUB", "USBHUB3", "NUSB3HUB", "FLXHCIH", "TIHUB3", "ETRONHUB3", "VIAHUB3", "ASMTHUB3"}; |
+const char* hub_driver_names[] = {"USBHUB", "USBHUB3", "NUSB3HUB", "RUSB3HUB", "FLXHCIH", "TIHUB3", "ETRONHUB3", "VIAHUB3", "ASMTHUB3", "IUSB3HUB"}; |
const char* composite_driver_names[] = {"USBCCGP"}; |
-const char* winusb_driver_names[] = {"WINUSB"}; |
+const char* winusbx_driver_names[] = WINUSBX_DRV_NAMES; |
+const char* hid_driver_names[] = {"HIDUSB", "MOUHID", "KBDHID"}; |
const struct windows_usb_api_backend usb_api_backend[USB_API_MAX] = { |
{ |
USB_API_UNSUPPORTED, |
"Unsupported API", |
- &CLASS_GUID_UNSUPPORTED, |
NULL, |
0, |
unsupported_init, |
unsupported_exit, |
unsupported_open, |
unsupported_close, |
+ unsupported_configure_endpoints, |
unsupported_claim_interface, |
unsupported_set_interface_altsetting, |
unsupported_release_interface, |
@@ -2213,13 +2396,13 @@ const struct windows_usb_api_backend usb_api_backend[USB_API_MAX] = { |
}, { |
USB_API_HUB, |
"HUB API", |
- &CLASS_GUID_UNSUPPORTED, |
hub_driver_names, |
- sizeof(hub_driver_names)/sizeof(hub_driver_names[0]), |
+ ARRAYSIZE(hub_driver_names), |
unsupported_init, |
unsupported_exit, |
unsupported_open, |
unsupported_close, |
+ unsupported_configure_endpoints, |
unsupported_claim_interface, |
unsupported_set_interface_altsetting, |
unsupported_release_interface, |
@@ -2234,13 +2417,13 @@ const struct windows_usb_api_backend usb_api_backend[USB_API_MAX] = { |
}, { |
USB_API_COMPOSITE, |
"Composite API", |
- &CLASS_GUID_COMPOSITE, |
composite_driver_names, |
- sizeof(composite_driver_names)/sizeof(composite_driver_names[0]), |
+ ARRAYSIZE(composite_driver_names), |
composite_init, |
composite_exit, |
composite_open, |
composite_close, |
+ common_configure_endpoints, |
composite_claim_interface, |
composite_set_interface_altsetting, |
composite_release_interface, |
@@ -2253,58 +2436,131 @@ const struct windows_usb_api_backend usb_api_backend[USB_API_MAX] = { |
composite_abort_transfers, |
composite_copy_transfer_data, |
}, { |
- USB_API_WINUSB, |
- "WinUSB API", |
- &CLASS_GUID_LIBUSB_WINUSB, |
- winusb_driver_names, |
- sizeof(winusb_driver_names)/sizeof(winusb_driver_names[0]), |
- winusb_init, |
- winusb_exit, |
- winusb_open, |
- winusb_close, |
- winusb_claim_interface, |
- winusb_set_interface_altsetting, |
- winusb_release_interface, |
- winusb_clear_halt, |
- winusb_reset_device, |
- winusb_submit_bulk_transfer, |
+ USB_API_WINUSBX, |
+ "WinUSB-like APIs", |
+ winusbx_driver_names, |
+ ARRAYSIZE(winusbx_driver_names), |
+ winusbx_init, |
+ winusbx_exit, |
+ winusbx_open, |
+ winusbx_close, |
+ winusbx_configure_endpoints, |
+ winusbx_claim_interface, |
+ winusbx_set_interface_altsetting, |
+ winusbx_release_interface, |
+ winusbx_clear_halt, |
+ winusbx_reset_device, |
+ winusbx_submit_bulk_transfer, |
+ unsupported_submit_iso_transfer, |
+ winusbx_submit_control_transfer, |
+ winusbx_abort_control, |
+ winusbx_abort_transfers, |
+ winusbx_copy_transfer_data, |
+ }, { |
+ USB_API_HID, |
+ "HID API", |
+ hid_driver_names, |
+ ARRAYSIZE(hid_driver_names), |
+ hid_init, |
+ hid_exit, |
+ hid_open, |
+ hid_close, |
+ common_configure_endpoints, |
+ hid_claim_interface, |
+ hid_set_interface_altsetting, |
+ hid_release_interface, |
+ hid_clear_halt, |
+ hid_reset_device, |
+ hid_submit_bulk_transfer, |
unsupported_submit_iso_transfer, |
- winusb_submit_control_transfer, |
- winusb_abort_control, |
- winusb_abort_transfers, |
- winusb_copy_transfer_data, |
+ hid_submit_control_transfer, |
+ hid_abort_transfers, |
+ hid_abort_transfers, |
+ hid_copy_transfer_data, |
}, |
}; |
/* |
- * WinUSB API functions |
+ * WinUSB-like (WinUSB, libusb0/libusbK through libusbk DLL) API functions |
*/ |
-static int winusb_init(struct libusb_context *ctx) |
-{ |
- DLL_LOAD(winusb.dll, WinUsb_Initialize, TRUE); |
- DLL_LOAD(winusb.dll, WinUsb_Free, TRUE); |
- DLL_LOAD(winusb.dll, WinUsb_GetAssociatedInterface, TRUE); |
- DLL_LOAD(winusb.dll, WinUsb_GetDescriptor, TRUE); |
- DLL_LOAD(winusb.dll, WinUsb_QueryInterfaceSettings, TRUE); |
- DLL_LOAD(winusb.dll, WinUsb_QueryDeviceInformation, TRUE); |
- DLL_LOAD(winusb.dll, WinUsb_SetCurrentAlternateSetting, TRUE); |
- DLL_LOAD(winusb.dll, WinUsb_GetCurrentAlternateSetting, TRUE); |
- DLL_LOAD(winusb.dll, WinUsb_QueryPipe, TRUE); |
- DLL_LOAD(winusb.dll, WinUsb_SetPipePolicy, TRUE); |
- DLL_LOAD(winusb.dll, WinUsb_GetPipePolicy, TRUE); |
- DLL_LOAD(winusb.dll, WinUsb_ReadPipe, TRUE); |
- DLL_LOAD(winusb.dll, WinUsb_WritePipe, TRUE); |
- DLL_LOAD(winusb.dll, WinUsb_ControlTransfer, TRUE); |
- DLL_LOAD(winusb.dll, WinUsb_ResetPipe, TRUE); |
- DLL_LOAD(winusb.dll, WinUsb_AbortPipe, TRUE); |
- DLL_LOAD(winusb.dll, WinUsb_FlushPipe, TRUE); |
- |
- api_winusb_available = true; |
+#define WinUSBX_Set(fn) do { if (native_winusb) WinUSBX[i].fn = (WinUsb_##fn##_t) GetProcAddress(h, "WinUsb_" #fn); \ |
+ else pLibK_GetProcAddress((PVOID*)&WinUSBX[i].fn, i, KUSB_FNID_##fn); } while (0) |
+ |
+static int winusbx_init(int sub_api, struct libusb_context *ctx) |
+{ |
+ HMODULE h = NULL; |
+ bool native_winusb = false; |
+ int i; |
+ KLIB_VERSION LibK_Version; |
+ LibK_GetProcAddress_t pLibK_GetProcAddress = NULL; |
+ LibK_GetVersion_t pLibK_GetVersion = NULL; |
+ |
+ h = GetModuleHandleA("libusbK"); |
+ if (h == NULL) { |
+ h = LoadLibraryA("libusbK"); |
+ } |
+ if (h == NULL) { |
+ usbi_info(ctx, "libusbK DLL is not available, will use native WinUSB"); |
+ h = GetModuleHandleA("WinUSB"); |
+ if (h == NULL) { |
+ h = LoadLibraryA("WinUSB"); |
+ } if (h == NULL) { |
+ usbi_warn(ctx, "WinUSB DLL is not available either,\n" |
+ "you will not be able to access devices outside of enumeration"); |
+ return LIBUSB_ERROR_NOT_FOUND; |
+ } |
+ } else { |
+ usbi_dbg("using libusbK DLL for universal access"); |
+ pLibK_GetVersion = (LibK_GetVersion_t) GetProcAddress(h, "LibK_GetVersion"); |
+ if (pLibK_GetVersion != NULL) { |
+ pLibK_GetVersion(&LibK_Version); |
+ usbi_dbg("libusbK version: %d.%d.%d.%d", LibK_Version.Major, LibK_Version.Minor, |
+ LibK_Version.Micro, LibK_Version.Nano); |
+ } |
+ pLibK_GetProcAddress = (LibK_GetProcAddress_t) GetProcAddress(h, "LibK_GetProcAddress"); |
+ if (pLibK_GetProcAddress == NULL) { |
+ usbi_err(ctx, "LibK_GetProcAddress() not found in libusbK DLL"); |
+ return LIBUSB_ERROR_NOT_FOUND; |
+ } |
+ } |
+ native_winusb = (pLibK_GetProcAddress == NULL); |
+ for (i=SUB_API_LIBUSBK; i<SUB_API_MAX; i++) { |
+ WinUSBX_Set(AbortPipe); |
+ WinUSBX_Set(ControlTransfer); |
+ WinUSBX_Set(FlushPipe); |
+ WinUSBX_Set(Free); |
+ WinUSBX_Set(GetAssociatedInterface); |
+ WinUSBX_Set(GetCurrentAlternateSetting); |
+ WinUSBX_Set(GetDescriptor); |
+ WinUSBX_Set(GetOverlappedResult); |
+ WinUSBX_Set(GetPipePolicy); |
+ WinUSBX_Set(GetPowerPolicy); |
+ WinUSBX_Set(Initialize); |
+ WinUSBX_Set(QueryDeviceInformation); |
+ WinUSBX_Set(QueryInterfaceSettings); |
+ WinUSBX_Set(QueryPipe); |
+ WinUSBX_Set(ReadPipe); |
+ WinUSBX_Set(ResetPipe); |
+ WinUSBX_Set(SetCurrentAlternateSetting); |
+ WinUSBX_Set(SetPipePolicy); |
+ WinUSBX_Set(SetPowerPolicy); |
+ WinUSBX_Set(WritePipe); |
+ if (!native_winusb) { |
+ WinUSBX_Set(ResetDevice); |
+ } |
+ if (WinUSBX[i].Initialize != NULL) { |
+ WinUSBX[i].initialized = true; |
+ usbi_dbg("initalized sub API %s", sub_api_name[i]); |
+ } else { |
+ usbi_warn(ctx, "Failed to initalize sub API %s", sub_api_name[i]); |
+ WinUSBX[i].initialized = false; |
+ } |
+ } |
return LIBUSB_SUCCESS; |
} |
-static int winusb_exit(void) |
+static int winusbx_exit(int sub_api) |
{ |
return LIBUSB_SUCCESS; |
} |
@@ -2312,7 +2568,7 @@ static int winusb_exit(void) |
// NB: open and close must ensure that they only handle interface of |
// the right API type, as these functions can be called wholesale from |
// composite_open(), with interfaces belonging to different APIs |
-static int winusb_open(struct libusb_device_handle *dev_handle) |
+static int winusbx_open(int sub_api, struct libusb_device_handle *dev_handle) |
{ |
struct libusb_context *ctx = DEVICE_CTX(dev_handle->dev); |
struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
@@ -2321,12 +2577,12 @@ static int winusb_open(struct libusb_device_handle *dev_handle) |
HANDLE file_handle; |
int i; |
- CHECK_WINUSB_AVAILABLE; |
+ CHECK_WINUSBX_AVAILABLE(sub_api); |
// WinUSB requires a seperate handle for each interface |
for (i = 0; i < USB_MAXINTERFACES; i++) { |
if ( (priv->usb_interface[i].path != NULL) |
- && (priv->usb_interface[i].apib->id == USB_API_WINUSB) ) { |
+ && (priv->usb_interface[i].apib->id == USB_API_WINUSBX) ) { |
file_handle = CreateFileA(priv->usb_interface[i].path, GENERIC_WRITE | GENERIC_READ, FILE_SHARE_WRITE | FILE_SHARE_READ, |
NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED, NULL); |
if (file_handle == INVALID_HANDLE_VALUE) { |
@@ -2347,18 +2603,20 @@ static int winusb_open(struct libusb_device_handle *dev_handle) |
return LIBUSB_SUCCESS; |
} |
-static void winusb_close(struct libusb_device_handle *dev_handle) |
+static void winusbx_close(int sub_api, struct libusb_device_handle *dev_handle) |
{ |
struct windows_device_handle_priv *handle_priv = _device_handle_priv(dev_handle); |
struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
HANDLE file_handle; |
int i; |
- if (!api_winusb_available) |
+ if (sub_api == SUB_API_NOTSET) |
+ sub_api = priv->sub_api; |
+ if (!WinUSBX[sub_api].initialized) |
return; |
for (i = 0; i < USB_MAXINTERFACES; i++) { |
- if (priv->usb_interface[i].apib->id == USB_API_WINUSB) { |
+ if (priv->usb_interface[i].apib->id == USB_API_WINUSBX) { |
file_handle = handle_priv->interface_handle[i].dev_handle; |
if ( (file_handle != 0) && (file_handle != INVALID_HANDLE_VALUE)) { |
CloseHandle(file_handle); |
@@ -2367,7 +2625,7 @@ static void winusb_close(struct libusb_device_handle *dev_handle) |
} |
} |
-static int winusb_configure_endpoints(struct libusb_device_handle *dev_handle, int iface) |
+static int winusbx_configure_endpoints(int sub_api, struct libusb_device_handle *dev_handle, int iface) |
{ |
struct windows_device_handle_priv *handle_priv = _device_handle_priv(dev_handle); |
struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
@@ -2377,32 +2635,36 @@ static int winusb_configure_endpoints(struct libusb_device_handle *dev_handle, i |
uint8_t endpoint_address; |
int i; |
- CHECK_WINUSB_AVAILABLE; |
+ CHECK_WINUSBX_AVAILABLE(sub_api); |
// With handle and enpoints set (in parent), we can setup the default pipe properties |
// see http://download.microsoft.com/download/D/1/D/D1DD7745-426B-4CC3-A269-ABBBE427C0EF/DVC-T705_DDC08.pptx |
for (i=-1; i<priv->usb_interface[iface].nb_endpoints; i++) { |
endpoint_address =(i==-1)?0:priv->usb_interface[iface].endpoint[i]; |
- if (!WinUsb_SetPipePolicy(winusb_handle, endpoint_address, |
+ if (!WinUSBX[sub_api].SetPipePolicy(winusb_handle, endpoint_address, |
PIPE_TRANSFER_TIMEOUT, sizeof(ULONG), &timeout)) { |
usbi_dbg("failed to set PIPE_TRANSFER_TIMEOUT for control endpoint %02X", endpoint_address); |
} |
- if (i == -1) continue; // Other policies don't apply to control endpoint |
+ if ((i == -1) || (sub_api == SUB_API_LIBUSB0)) { |
+ continue; // Other policies don't apply to control endpoint or libusb0 |
+ } |
policy = false; |
- if (!WinUsb_SetPipePolicy(winusb_handle, endpoint_address, |
+ if (!WinUSBX[sub_api].SetPipePolicy(winusb_handle, endpoint_address, |
SHORT_PACKET_TERMINATE, sizeof(UCHAR), &policy)) { |
usbi_dbg("failed to disable SHORT_PACKET_TERMINATE for endpoint %02X", endpoint_address); |
} |
- if (!WinUsb_SetPipePolicy(winusb_handle, endpoint_address, |
+ if (!WinUSBX[sub_api].SetPipePolicy(winusb_handle, endpoint_address, |
IGNORE_SHORT_PACKETS, sizeof(UCHAR), &policy)) { |
usbi_dbg("failed to disable IGNORE_SHORT_PACKETS for endpoint %02X", endpoint_address); |
} |
- if (!WinUsb_SetPipePolicy(winusb_handle, endpoint_address, |
+ policy = true; |
+ /* ALLOW_PARTIAL_READS must be enabled due to likely libusbK bug. See: |
+ https://sourceforge.net/mailarchive/message.php?msg_id=29736015 */ |
+ if (!WinUSBX[sub_api].SetPipePolicy(winusb_handle, endpoint_address, |
ALLOW_PARTIAL_READS, sizeof(UCHAR), &policy)) { |
- usbi_dbg("failed to disable ALLOW_PARTIAL_READS for endpoint %02X", endpoint_address); |
+ usbi_dbg("failed to enable ALLOW_PARTIAL_READS for endpoint %02X", endpoint_address); |
} |
- policy = true; |
- if (!WinUsb_SetPipePolicy(winusb_handle, endpoint_address, |
+ if (!WinUSBX[sub_api].SetPipePolicy(winusb_handle, endpoint_address, |
AUTO_CLEAR_STALL, sizeof(UCHAR), &policy)) { |
usbi_dbg("failed to enable AUTO_CLEAR_STALL for endpoint %02X", endpoint_address); |
} |
@@ -2411,18 +2673,26 @@ static int winusb_configure_endpoints(struct libusb_device_handle *dev_handle, i |
return LIBUSB_SUCCESS; |
} |
-static int winusb_claim_interface(struct libusb_device_handle *dev_handle, int iface) |
+static int winusbx_claim_interface(int sub_api, struct libusb_device_handle *dev_handle, int iface) |
{ |
struct libusb_context *ctx = DEVICE_CTX(dev_handle->dev); |
struct windows_device_handle_priv *handle_priv = _device_handle_priv(dev_handle); |
struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
bool is_using_usbccgp = (priv->apib->id == USB_API_COMPOSITE); |
HANDLE file_handle, winusb_handle; |
+ DWORD err; |
+ int i; |
+ SP_DEVICE_INTERFACE_DETAIL_DATA_A *dev_interface_details = NULL; |
+ HDEVINFO dev_info = INVALID_HANDLE_VALUE; |
+ SP_DEVINFO_DATA dev_info_data; |
+ char* dev_path_no_guid = NULL; |
+ char filter_path[] = "\\\\.\\libusb0-0000"; |
+ bool found_filter = false; |
- CHECK_WINUSB_AVAILABLE; |
+ CHECK_WINUSBX_AVAILABLE(sub_api); |
// If the device is composite, but using the default Windows composite parent driver (usbccgp) |
- // or if it's the first WinUSB interface, we get a handle through WinUsb_Initialize(). |
+ // or if it's the first WinUSB-like interface, we get a handle through Initialize(). |
if ((is_using_usbccgp) || (iface == 0)) { |
// composite device (independent interfaces) or interface 0 |
file_handle = handle_priv->interface_handle[iface].dev_handle; |
@@ -2430,35 +2700,64 @@ static int winusb_claim_interface(struct libusb_device_handle *dev_handle, int i |
return LIBUSB_ERROR_NOT_FOUND; |
} |
- if (!WinUsb_Initialize(file_handle, &winusb_handle)) { |
- usbi_err(ctx, "could not access interface %d: %s", iface, windows_error_str(0)); |
+ if (!WinUSBX[sub_api].Initialize(file_handle, &winusb_handle)) { |
handle_priv->interface_handle[iface].api_handle = INVALID_HANDLE_VALUE; |
- |
- switch(GetLastError()) { |
- case ERROR_BAD_COMMAND: // The device was disconnected |
+ err = GetLastError(); |
+ switch(err) { |
+ case ERROR_BAD_COMMAND: |
+ // The device was disconnected |
+ usbi_err(ctx, "could not access interface %d: %s", iface, windows_error_str(0)); |
return LIBUSB_ERROR_NO_DEVICE; |
default: |
- usbi_err(ctx, "could not claim interface %d: %s", iface, windows_error_str(0)); |
- return LIBUSB_ERROR_ACCESS; |
+ // it may be that we're using the libusb0 filter driver. |
+ // TODO: can we move this whole business into the K/0 DLL? |
+ for (i = 0; ; i++) { |
+ safe_free(dev_interface_details); |
+ safe_free(dev_path_no_guid); |
+ dev_interface_details = get_interface_details_filter(ctx, &dev_info, &dev_info_data, &GUID_DEVINTERFACE_LIBUSB0_FILTER, i, filter_path); |
+ if ((found_filter) || (dev_interface_details == NULL)) { |
+ break; |
+ } |
+ // ignore GUID part |
+ dev_path_no_guid = sanitize_path(strtok(dev_interface_details->DevicePath, "{")); |
+ if (safe_strncmp(dev_path_no_guid, priv->usb_interface[iface].path, safe_strlen(dev_path_no_guid)) == 0) { |
+ file_handle = CreateFileA(filter_path, GENERIC_WRITE | GENERIC_READ, FILE_SHARE_WRITE | FILE_SHARE_READ, |
+ NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED, NULL); |
+ if (file_handle == INVALID_HANDLE_VALUE) { |
+ usbi_err(ctx, "could not open device %s: %s", filter_path, windows_error_str(0)); |
+ } else { |
+ WinUSBX[sub_api].Free(winusb_handle); |
+ if (!WinUSBX[sub_api].Initialize(file_handle, &winusb_handle)) { |
+ continue; |
+ } |
+ found_filter = true; |
+ break; |
+ } |
+ } |
+ } |
+ if (!found_filter) { |
+ usbi_err(ctx, "could not access interface %d: %s", iface, windows_error_str(err)); |
+ return LIBUSB_ERROR_ACCESS; |
+ } |
} |
} |
handle_priv->interface_handle[iface].api_handle = winusb_handle; |
} else { |
- // For all other interfaces, use WinUsb_GetAssociatedInterface() |
+ // For all other interfaces, use GetAssociatedInterface() |
winusb_handle = handle_priv->interface_handle[0].api_handle; |
- // It is a requirement for multiple interface devices using WinUSB that you |
- // must first claim the first interface before you claim any other |
+ // It is a requirement for multiple interface devices on Windows that, to you |
+ // must first claim the first interface before you claim the others |
if ((winusb_handle == 0) || (winusb_handle == INVALID_HANDLE_VALUE)) { |
file_handle = handle_priv->interface_handle[0].dev_handle; |
- if (WinUsb_Initialize(file_handle, &winusb_handle)) { |
+ if (WinUSBX[sub_api].Initialize(file_handle, &winusb_handle)) { |
handle_priv->interface_handle[0].api_handle = winusb_handle; |
usbi_warn(ctx, "auto-claimed interface 0 (required to claim %d with WinUSB)", iface); |
} else { |
- usbi_warn(ctx, "failed to auto-claim interface 0 (required to claim %d with WinUSB)", iface); |
+ usbi_warn(ctx, "failed to auto-claim interface 0 (required to claim %d with WinUSB): %s", iface, windows_error_str(0)); |
return LIBUSB_ERROR_ACCESS; |
} |
} |
- if (!WinUsb_GetAssociatedInterface(winusb_handle, (UCHAR)(iface-1), |
+ if (!WinUSBX[sub_api].GetAssociatedInterface(winusb_handle, (UCHAR)(iface-1), |
&handle_priv->interface_handle[iface].api_handle)) { |
handle_priv->interface_handle[iface].api_handle = INVALID_HANDLE_VALUE; |
switch(GetLastError()) { |
@@ -2480,19 +2779,20 @@ static int winusb_claim_interface(struct libusb_device_handle *dev_handle, int i |
return LIBUSB_SUCCESS; |
} |
-static int winusb_release_interface(struct libusb_device_handle *dev_handle, int iface) |
+static int winusbx_release_interface(int sub_api, struct libusb_device_handle *dev_handle, int iface) |
{ |
struct windows_device_handle_priv *handle_priv = _device_handle_priv(dev_handle); |
+ struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
HANDLE winusb_handle; |
- CHECK_WINUSB_AVAILABLE; |
+ CHECK_WINUSBX_AVAILABLE(sub_api); |
winusb_handle = handle_priv->interface_handle[iface].api_handle; |
if ((winusb_handle == 0) || (winusb_handle == INVALID_HANDLE_VALUE)) { |
return LIBUSB_ERROR_NOT_FOUND; |
} |
- WinUsb_Free(winusb_handle); |
+ WinUSBX[sub_api].Free(winusb_handle); |
handle_priv->interface_handle[iface].api_handle = INVALID_HANDLE_VALUE; |
return LIBUSB_SUCCESS; |
@@ -2501,16 +2801,23 @@ static int winusb_release_interface(struct libusb_device_handle *dev_handle, int |
/* |
* Return the first valid interface (of the same API type), for control transfers |
*/ |
-static int winusb_get_valid_interface(struct libusb_device_handle *dev_handle) |
+static int get_valid_interface(struct libusb_device_handle *dev_handle, int api_id) |
{ |
struct windows_device_handle_priv *handle_priv = _device_handle_priv(dev_handle); |
+ struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
int i; |
+ if ((api_id < USB_API_WINUSBX) || (api_id > USB_API_HID)) { |
+ usbi_dbg("unsupported API ID"); |
+ return -1; |
+ } |
+ |
for (i=0; i<USB_MAXINTERFACES; i++) { |
if ( (handle_priv->interface_handle[i].dev_handle != 0) |
&& (handle_priv->interface_handle[i].dev_handle != INVALID_HANDLE_VALUE) |
&& (handle_priv->interface_handle[i].api_handle != 0) |
- && (handle_priv->interface_handle[i].api_handle != INVALID_HANDLE_VALUE) ) { |
+ && (handle_priv->interface_handle[i].api_handle != INVALID_HANDLE_VALUE) |
+ && (priv->usb_interface[i].apib->id == api_id) ) { |
return i; |
} |
} |
@@ -2540,7 +2847,7 @@ static int interface_by_endpoint(struct windows_device_priv *priv, |
return -1; |
} |
-static int winusb_submit_control_transfer(struct usbi_transfer *itransfer) |
+static int winusbx_submit_control_transfer(int sub_api, struct usbi_transfer *itransfer) |
{ |
struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
struct libusb_context *ctx = DEVICE_CTX(transfer->dev_handle->dev); |
@@ -2554,7 +2861,7 @@ static int winusb_submit_control_transfer(struct usbi_transfer *itransfer) |
int current_interface; |
struct winfd wfd; |
- CHECK_WINUSB_AVAILABLE; |
+ CHECK_WINUSBX_AVAILABLE(sub_api); |
transfer_priv->pollable_fd = INVALID_WINFD; |
size = transfer->length - LIBUSB_CONTROL_SETUP_SIZE; |
@@ -2562,9 +2869,9 @@ static int winusb_submit_control_transfer(struct usbi_transfer *itransfer) |
if (size > MAX_CTRL_BUFFER_LENGTH) |
return LIBUSB_ERROR_INVALID_PARAM; |
- current_interface = winusb_get_valid_interface(transfer->dev_handle); |
+ current_interface = get_valid_interface(transfer->dev_handle, USB_API_WINUSBX); |
if (current_interface < 0) { |
- if (auto_claim(transfer, ¤t_interface, USB_API_WINUSB) != LIBUSB_SUCCESS) { |
+ if (auto_claim(transfer, ¤t_interface, USB_API_WINUSBX) != LIBUSB_SUCCESS) { |
return LIBUSB_ERROR_NOT_FOUND; |
} |
} |
@@ -2572,7 +2879,7 @@ static int winusb_submit_control_transfer(struct usbi_transfer *itransfer) |
usbi_dbg("will use interface %d", current_interface); |
winusb_handle = handle_priv->interface_handle[current_interface].api_handle; |
- wfd = usbi_create_fd(winusb_handle, _O_RDONLY); |
+ wfd = usbi_create_fd(winusb_handle, RW_READ, NULL, NULL); |
// Always use the handle returned from usbi_create_fd (wfd.handle) |
if (wfd.fd < 0) { |
return LIBUSB_ERROR_NO_MEM; |
@@ -2583,16 +2890,16 @@ static int winusb_submit_control_transfer(struct usbi_transfer *itransfer) |
&& (setup->request == LIBUSB_REQUEST_SET_CONFIGURATION) ) { |
if (setup->value != priv->active_config) { |
usbi_warn(ctx, "cannot set configuration other than the default one"); |
- usbi_free_fd(wfd.fd); |
+ usbi_free_fd(&wfd); |
return LIBUSB_ERROR_INVALID_PARAM; |
} |
wfd.overlapped->Internal = STATUS_COMPLETED_SYNCHRONOUSLY; |
wfd.overlapped->InternalHigh = 0; |
} else { |
- if (!WinUsb_ControlTransfer(wfd.handle, *setup, transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE, size, NULL, wfd.overlapped)) { |
+ if (!WinUSBX[sub_api].ControlTransfer(wfd.handle, *setup, transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE, size, NULL, wfd.overlapped)) { |
if(GetLastError() != ERROR_IO_PENDING) { |
- usbi_err(ctx, "WinUsb_ControlTransfer failed: %s", windows_error_str(0)); |
- usbi_free_fd(wfd.fd); |
+ usbi_warn(ctx, "ControlTransfer failed: %s", windows_error_str(0)); |
+ usbi_free_fd(&wfd); |
return LIBUSB_ERROR_IO; |
} |
} else { |
@@ -2608,13 +2915,14 @@ static int winusb_submit_control_transfer(struct usbi_transfer *itransfer) |
return LIBUSB_SUCCESS; |
} |
-static int winusb_set_interface_altsetting(struct libusb_device_handle *dev_handle, int iface, int altsetting) |
+static int winusbx_set_interface_altsetting(int sub_api, struct libusb_device_handle *dev_handle, int iface, int altsetting) |
{ |
struct libusb_context *ctx = DEVICE_CTX(dev_handle->dev); |
struct windows_device_handle_priv *handle_priv = _device_handle_priv(dev_handle); |
+ struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
HANDLE winusb_handle; |
- CHECK_WINUSB_AVAILABLE; |
+ CHECK_WINUSBX_AVAILABLE(sub_api); |
if (altsetting > 255) { |
return LIBUSB_ERROR_INVALID_PARAM; |
@@ -2626,15 +2934,15 @@ static int winusb_set_interface_altsetting(struct libusb_device_handle *dev_hand |
return LIBUSB_ERROR_NOT_FOUND; |
} |
- if (!WinUsb_SetCurrentAlternateSetting(winusb_handle, (UCHAR)altsetting)) { |
- usbi_err(ctx, "WinUsb_SetCurrentAlternateSetting failed: %s", windows_error_str(0)); |
+ if (!WinUSBX[sub_api].SetCurrentAlternateSetting(winusb_handle, (UCHAR)altsetting)) { |
+ usbi_err(ctx, "SetCurrentAlternateSetting failed: %s", windows_error_str(0)); |
return LIBUSB_ERROR_IO; |
} |
return LIBUSB_SUCCESS; |
} |
-static int winusb_submit_bulk_transfer(struct usbi_transfer *itransfer) |
+static int winusbx_submit_bulk_transfer(int sub_api, struct usbi_transfer *itransfer) |
{ |
struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
struct libusb_context *ctx = DEVICE_CTX(transfer->dev_handle->dev); |
@@ -2646,7 +2954,7 @@ static int winusb_submit_bulk_transfer(struct usbi_transfer *itransfer) |
int current_interface; |
struct winfd wfd; |
- CHECK_WINUSB_AVAILABLE; |
+ CHECK_WINUSBX_AVAILABLE(sub_api); |
transfer_priv->pollable_fd = INVALID_WINFD; |
@@ -2660,7 +2968,7 @@ static int winusb_submit_bulk_transfer(struct usbi_transfer *itransfer) |
winusb_handle = handle_priv->interface_handle[current_interface].api_handle; |
- wfd = usbi_create_fd(winusb_handle, IS_XFERIN(transfer) ? _O_RDONLY : _O_WRONLY); |
+ wfd = usbi_create_fd(winusb_handle, IS_XFERIN(transfer) ? RW_READ : RW_WRITE, NULL, NULL); |
// Always use the handle returned from usbi_create_fd (wfd.handle) |
if (wfd.fd < 0) { |
return LIBUSB_ERROR_NO_MEM; |
@@ -2668,15 +2976,15 @@ static int winusb_submit_bulk_transfer(struct usbi_transfer *itransfer) |
if (IS_XFERIN(transfer)) { |
usbi_dbg("reading %d bytes", transfer->length); |
- ret = WinUsb_ReadPipe(wfd.handle, transfer->endpoint, transfer->buffer, transfer->length, NULL, wfd.overlapped); |
+ ret = WinUSBX[sub_api].ReadPipe(wfd.handle, transfer->endpoint, transfer->buffer, transfer->length, NULL, wfd.overlapped); |
} else { |
usbi_dbg("writing %d bytes", transfer->length); |
- ret = WinUsb_WritePipe(wfd.handle, transfer->endpoint, transfer->buffer, transfer->length, NULL, wfd.overlapped); |
+ ret = WinUSBX[sub_api].WritePipe(wfd.handle, transfer->endpoint, transfer->buffer, transfer->length, NULL, wfd.overlapped); |
} |
if (!ret) { |
if(GetLastError() != ERROR_IO_PENDING) { |
- usbi_err(ctx, "WinUsb_Pipe Transfer failed: %s", windows_error_str(0)); |
- usbi_free_fd(wfd.fd); |
+ usbi_err(ctx, "ReadPipe/WritePipe failed: %s", windows_error_str(0)); |
+ usbi_free_fd(&wfd); |
return LIBUSB_ERROR_IO; |
} |
} else { |
@@ -2690,7 +2998,7 @@ static int winusb_submit_bulk_transfer(struct usbi_transfer *itransfer) |
return LIBUSB_SUCCESS; |
} |
-static int winusb_clear_halt(struct libusb_device_handle *dev_handle, unsigned char endpoint) |
+static int winusbx_clear_halt(int sub_api, struct libusb_device_handle *dev_handle, unsigned char endpoint) |
{ |
struct libusb_context *ctx = DEVICE_CTX(dev_handle->dev); |
struct windows_device_handle_priv *handle_priv = _device_handle_priv(dev_handle); |
@@ -2698,7 +3006,7 @@ static int winusb_clear_halt(struct libusb_device_handle *dev_handle, unsigned c |
HANDLE winusb_handle; |
int current_interface; |
- CHECK_WINUSB_AVAILABLE; |
+ CHECK_WINUSBX_AVAILABLE(sub_api); |
current_interface = interface_by_endpoint(priv, handle_priv, endpoint); |
if (current_interface < 0) { |
@@ -2709,8 +3017,8 @@ static int winusb_clear_halt(struct libusb_device_handle *dev_handle, unsigned c |
usbi_dbg("matched endpoint %02X with interface %d", endpoint, current_interface); |
winusb_handle = handle_priv->interface_handle[current_interface].api_handle; |
- if (!WinUsb_ResetPipe(winusb_handle, endpoint)) { |
- usbi_err(ctx, "WinUsb_ResetPipe failed: %s", windows_error_str(0)); |
+ if (!WinUSBX[sub_api].ResetPipe(winusb_handle, endpoint)) { |
+ usbi_err(ctx, "ResetPipe failed: %s", windows_error_str(0)); |
return LIBUSB_ERROR_NO_DEVICE; |
} |
@@ -2723,22 +3031,23 @@ static int winusb_clear_halt(struct libusb_device_handle *dev_handle, unsigned c |
* "You can not call WinUsb_AbortPipe on control pipe. You can possibly cancel |
* the control transfer using CancelIo" |
*/ |
-static int winusb_abort_control(struct usbi_transfer *itransfer) |
+static int winusbx_abort_control(int sub_api, struct usbi_transfer *itransfer) |
{ |
// Cancelling of the I/O is done in the parent |
return LIBUSB_SUCCESS; |
} |
-static int winusb_abort_transfers(struct usbi_transfer *itransfer) |
+static int winusbx_abort_transfers(int sub_api, struct usbi_transfer *itransfer) |
{ |
struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
struct libusb_context *ctx = DEVICE_CTX(transfer->dev_handle->dev); |
struct windows_device_handle_priv *handle_priv = _device_handle_priv(transfer->dev_handle); |
- struct windows_transfer_priv *transfer_priv = usbi_transfer_get_os_priv(itransfer); |
+ struct windows_transfer_priv *transfer_priv = (struct windows_transfer_priv*)usbi_transfer_get_os_priv(itransfer); |
+ struct windows_device_priv *priv = _device_priv(transfer->dev_handle->dev); |
HANDLE winusb_handle; |
int current_interface; |
- CHECK_WINUSB_AVAILABLE; |
+ CHECK_WINUSBX_AVAILABLE(sub_api); |
current_interface = transfer_priv->interface_number; |
if ((current_interface < 0) || (current_interface >= USB_MAXINTERFACES)) { |
@@ -2749,8 +3058,8 @@ static int winusb_abort_transfers(struct usbi_transfer *itransfer) |
winusb_handle = handle_priv->interface_handle[current_interface].api_handle; |
- if (!WinUsb_AbortPipe(winusb_handle, transfer->endpoint)) { |
- usbi_err(ctx, "WinUsb_AbortPipe failed: %s", windows_error_str(0)); |
+ if (!WinUSBX[sub_api].AbortPipe(winusb_handle, transfer->endpoint)) { |
+ usbi_err(ctx, "AbortPipe failed: %s", windows_error_str(0)); |
return LIBUSB_ERROR_NO_DEVICE; |
} |
@@ -2765,8 +3074,8 @@ static int winusb_abort_transfers(struct usbi_transfer *itransfer) |
* IOCTL_USB_HUB_CYCLE_PORT ioctl was removed from Vista => the best we can do is |
* cycle the pipes (and even then, the control pipe can not be reset using WinUSB) |
*/ |
-// TODO (post hotplug): see if we can force eject the device and redetect it (reuse hotplug?) |
-static int winusb_reset_device(struct libusb_device_handle *dev_handle) |
+// TODO: (post hotplug): see if we can force eject the device and redetect it (reuse hotplug?) |
+static int winusbx_reset_device(int sub_api, struct libusb_device_handle *dev_handle) |
{ |
struct libusb_context *ctx = DEVICE_CTX(dev_handle->dev); |
struct windows_device_handle_priv *handle_priv = _device_handle_priv(dev_handle); |
@@ -2775,7 +3084,7 @@ static int winusb_reset_device(struct libusb_device_handle *dev_handle) |
HANDLE winusb_handle; |
int i, j; |
- CHECK_WINUSB_AVAILABLE; |
+ CHECK_WINUSBX_AVAILABLE(sub_api); |
// Reset any available pipe (except control) |
for (i=0; i<USB_MAXINTERFACES; i++) { |
@@ -2784,213 +3093,1302 @@ static int winusb_reset_device(struct libusb_device_handle *dev_handle) |
{ |
// Cancel any pollable I/O |
usbi_remove_pollfd(ctx, wfd.fd); |
- usbi_free_fd(wfd.fd); |
+ usbi_free_fd(&wfd); |
wfd = handle_to_winfd(winusb_handle); |
} |
if ( (winusb_handle != 0) && (winusb_handle != INVALID_HANDLE_VALUE)) { |
for (j=0; j<priv->usb_interface[i].nb_endpoints; j++) { |
usbi_dbg("resetting ep %02X", priv->usb_interface[i].endpoint[j]); |
- if (!WinUsb_AbortPipe(winusb_handle, priv->usb_interface[i].endpoint[j])) { |
- usbi_err(ctx, "WinUsb_AbortPipe (pipe address %02X) failed: %s", |
+ if (!WinUSBX[sub_api].AbortPipe(winusb_handle, priv->usb_interface[i].endpoint[j])) { |
+ usbi_err(ctx, "AbortPipe (pipe address %02X) failed: %s", |
priv->usb_interface[i].endpoint[j], windows_error_str(0)); |
} |
// FlushPipe seems to fail on OUT pipes |
if (IS_EPIN(priv->usb_interface[i].endpoint[j]) |
- && (!WinUsb_FlushPipe(winusb_handle, priv->usb_interface[i].endpoint[j])) ) { |
- usbi_err(ctx, "WinUsb_FlushPipe (pipe address %02X) failed: %s", |
+ && (!WinUSBX[sub_api].FlushPipe(winusb_handle, priv->usb_interface[i].endpoint[j])) ) { |
+ usbi_err(ctx, "FlushPipe (pipe address %02X) failed: %s", |
priv->usb_interface[i].endpoint[j], windows_error_str(0)); |
} |
- if (!WinUsb_ResetPipe(winusb_handle, priv->usb_interface[i].endpoint[j])) { |
- usbi_err(ctx, "WinUsb_ResetPipe (pipe address %02X) failed: %s", |
+ if (!WinUSBX[sub_api].ResetPipe(winusb_handle, priv->usb_interface[i].endpoint[j])) { |
+ usbi_err(ctx, "ResetPipe (pipe address %02X) failed: %s", |
priv->usb_interface[i].endpoint[j], windows_error_str(0)); |
} |
} |
} |
} |
+ // libusbK & libusb0 have the ability to issue an actual device reset |
+ if (WinUSBX[sub_api].ResetDevice != NULL) { |
+ winusb_handle = handle_priv->interface_handle[0].api_handle; |
+ if ( (winusb_handle != 0) && (winusb_handle != INVALID_HANDLE_VALUE)) { |
+ WinUSBX[sub_api].ResetDevice(winusb_handle); |
+ } |
+ } |
return LIBUSB_SUCCESS; |
} |
-static int winusb_copy_transfer_data(struct usbi_transfer *itransfer, uint32_t io_size) |
+static int winusbx_copy_transfer_data(int sub_api, struct usbi_transfer *itransfer, uint32_t io_size) |
{ |
itransfer->transferred += io_size; |
return LIBUSB_TRANSFER_COMPLETED; |
} |
- |
/* |
- * Composite API functions |
+ * Internal HID Support functions (from libusb-win32) |
+ * Note that functions that complete data transfer synchronously must return |
+ * LIBUSB_COMPLETED instead of LIBUSB_SUCCESS |
*/ |
-static int composite_init(struct libusb_context *ctx) |
+static int _hid_get_hid_descriptor(struct hid_device_priv* dev, void *data, size_t *size); |
+static int _hid_get_report_descriptor(struct hid_device_priv* dev, void *data, size_t *size); |
+ |
+static int _hid_wcslen(WCHAR *str) |
{ |
- return LIBUSB_SUCCESS; |
+ int i = 0; |
+ while (str[i] && (str[i] != 0x409)) { |
+ i++; |
+ } |
+ return i; |
} |
-static int composite_exit(void) |
+static int _hid_get_device_descriptor(struct hid_device_priv* dev, void *data, size_t *size) |
{ |
- return LIBUSB_SUCCESS; |
+ struct libusb_device_descriptor d; |
+ |
+ d.bLength = LIBUSB_DT_DEVICE_SIZE; |
+ d.bDescriptorType = LIBUSB_DT_DEVICE; |
+ d.bcdUSB = 0x0200; /* 2.00 */ |
+ d.bDeviceClass = 0; |
+ d.bDeviceSubClass = 0; |
+ d.bDeviceProtocol = 0; |
+ d.bMaxPacketSize0 = 64; /* fix this! */ |
+ d.idVendor = (uint16_t)dev->vid; |
+ d.idProduct = (uint16_t)dev->pid; |
+ d.bcdDevice = 0x0100; |
+ d.iManufacturer = dev->string_index[0]; |
+ d.iProduct = dev->string_index[1]; |
+ d.iSerialNumber = dev->string_index[2]; |
+ d.bNumConfigurations = 1; |
+ |
+ if (*size > LIBUSB_DT_DEVICE_SIZE) |
+ *size = LIBUSB_DT_DEVICE_SIZE; |
+ memcpy(data, &d, *size); |
+ return LIBUSB_COMPLETED; |
} |
-static int composite_open(struct libusb_device_handle *dev_handle) |
+static int _hid_get_config_descriptor(struct hid_device_priv* dev, void *data, size_t *size) |
{ |
- struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
- unsigned api; |
- int r; |
- uint8_t flag = 1<<USB_API_WINUSB; |
+ char num_endpoints = 0; |
+ size_t config_total_len = 0; |
+ char tmp[HID_MAX_CONFIG_DESC_SIZE]; |
+ struct libusb_config_descriptor *cd; |
+ struct libusb_interface_descriptor *id; |
+ struct libusb_hid_descriptor *hd; |
+ struct libusb_endpoint_descriptor *ed; |
+ size_t tmp_size; |
+ |
+ if (dev->input_report_size) |
+ num_endpoints++; |
+ if (dev->output_report_size) |
+ num_endpoints++; |
+ |
+ config_total_len = LIBUSB_DT_CONFIG_SIZE + LIBUSB_DT_INTERFACE_SIZE |
+ + LIBUSB_DT_HID_SIZE + num_endpoints * LIBUSB_DT_ENDPOINT_SIZE; |
+ |
+ |
+ cd = (struct libusb_config_descriptor *)tmp; |
+ id = (struct libusb_interface_descriptor *)(tmp + LIBUSB_DT_CONFIG_SIZE); |
+ hd = (struct libusb_hid_descriptor *)(tmp + LIBUSB_DT_CONFIG_SIZE |
+ + LIBUSB_DT_INTERFACE_SIZE); |
+ ed = (struct libusb_endpoint_descriptor *)(tmp + LIBUSB_DT_CONFIG_SIZE |
+ + LIBUSB_DT_INTERFACE_SIZE |
+ + LIBUSB_DT_HID_SIZE); |
+ |
+ cd->bLength = LIBUSB_DT_CONFIG_SIZE; |
+ cd->bDescriptorType = LIBUSB_DT_CONFIG; |
+ cd->wTotalLength = (uint16_t) config_total_len; |
+ cd->bNumInterfaces = 1; |
+ cd->bConfigurationValue = 1; |
+ cd->iConfiguration = 0; |
+ cd->bmAttributes = 1 << 7; /* bus powered */ |
+ cd->MaxPower = 50; |
+ |
+ id->bLength = LIBUSB_DT_INTERFACE_SIZE; |
+ id->bDescriptorType = LIBUSB_DT_INTERFACE; |
+ id->bInterfaceNumber = 0; |
+ id->bAlternateSetting = 0; |
+ id->bNumEndpoints = num_endpoints; |
+ id->bInterfaceClass = 3; |
+ id->bInterfaceSubClass = 0; |
+ id->bInterfaceProtocol = 0; |
+ id->iInterface = 0; |
+ |
+ tmp_size = LIBUSB_DT_HID_SIZE; |
+ _hid_get_hid_descriptor(dev, hd, &tmp_size); |
+ |
+ if (dev->input_report_size) { |
+ ed->bLength = LIBUSB_DT_ENDPOINT_SIZE; |
+ ed->bDescriptorType = LIBUSB_DT_ENDPOINT; |
+ ed->bEndpointAddress = HID_IN_EP; |
+ ed->bmAttributes = 3; |
+ ed->wMaxPacketSize = dev->input_report_size - 1; |
+ ed->bInterval = 10; |
+ ed = (struct libusb_endpoint_descriptor *)((char*)ed + LIBUSB_DT_ENDPOINT_SIZE); |
+ } |
- for (api=USB_API_WINUSB; api<USB_API_MAX; api++) { |
- if (priv->composite_api_flags & flag) { |
- r = usb_api_backend[api].open(dev_handle); |
- if (r != LIBUSB_SUCCESS) { |
- return r; |
- } |
- } |
- flag <<= 1; |
+ if (dev->output_report_size) { |
+ ed->bLength = LIBUSB_DT_ENDPOINT_SIZE; |
+ ed->bDescriptorType = LIBUSB_DT_ENDPOINT; |
+ ed->bEndpointAddress = HID_OUT_EP; |
+ ed->bmAttributes = 3; |
+ ed->wMaxPacketSize = dev->output_report_size - 1; |
+ ed->bInterval = 10; |
} |
- return LIBUSB_SUCCESS; |
+ |
+ if (*size > config_total_len) |
+ *size = config_total_len; |
+ memcpy(data, tmp, *size); |
+ return LIBUSB_COMPLETED; |
} |
-static void composite_close(struct libusb_device_handle *dev_handle) |
+static int _hid_get_string_descriptor(struct hid_device_priv* dev, int _index, |
+ void *data, size_t *size) |
{ |
- struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
- unsigned api; |
- uint8_t flag = 1<<USB_API_WINUSB; |
+ void *tmp = NULL; |
+ size_t tmp_size = 0; |
+ int i; |
+ |
+ /* language ID, EN-US */ |
+ char string_langid[] = { |
+ 0x09, |
+ 0x04 |
+ }; |
+ |
+ if ((*size < 2) || (*size > 255)) { |
+ return LIBUSB_ERROR_OVERFLOW; |
+ } |
- for (api=USB_API_WINUSB; api<USB_API_MAX; api++) { |
- if (priv->composite_api_flags & flag) { |
- usb_api_backend[api].close(dev_handle); |
+ if (_index == 0) { |
+ tmp = string_langid; |
+ tmp_size = sizeof(string_langid)+2; |
+ } else { |
+ for (i=0; i<3; i++) { |
+ if (_index == (dev->string_index[i])) { |
+ tmp = dev->string[i]; |
+ tmp_size = (_hid_wcslen(dev->string[i])+1) * sizeof(WCHAR); |
+ break; |
+ } |
+ } |
+ if (i == 3) { // not found |
+ return LIBUSB_ERROR_INVALID_PARAM; |
} |
- flag <<= 1; |
} |
-} |
-static int composite_claim_interface(struct libusb_device_handle *dev_handle, int iface) |
-{ |
- struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
- return priv->usb_interface[iface].apib->claim_interface(dev_handle, iface); |
-} |
+ if(!tmp_size) { |
+ return LIBUSB_ERROR_INVALID_PARAM; |
+ } |
-static int composite_set_interface_altsetting(struct libusb_device_handle *dev_handle, int iface, int altsetting) |
-{ |
- struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
- return priv->usb_interface[iface].apib->set_interface_altsetting(dev_handle, iface, altsetting); |
+ if (tmp_size < *size) { |
+ *size = tmp_size; |
+ } |
+ // 2 byte header |
+ ((uint8_t*)data)[0] = (uint8_t)*size; |
+ ((uint8_t*)data)[1] = LIBUSB_DT_STRING; |
+ memcpy((uint8_t*)data+2, tmp, *size-2); |
+ return LIBUSB_COMPLETED; |
} |
-static int composite_release_interface(struct libusb_device_handle *dev_handle, int iface) |
+static int _hid_get_hid_descriptor(struct hid_device_priv* dev, void *data, size_t *size) |
{ |
- struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
- return priv->usb_interface[iface].apib->release_interface(dev_handle, iface); |
+ struct libusb_hid_descriptor d; |
+ uint8_t tmp[MAX_HID_DESCRIPTOR_SIZE]; |
+ size_t report_len = MAX_HID_DESCRIPTOR_SIZE; |
+ |
+ _hid_get_report_descriptor(dev, tmp, &report_len); |
+ |
+ d.bLength = LIBUSB_DT_HID_SIZE; |
+ d.bDescriptorType = LIBUSB_DT_HID; |
+ d.bcdHID = 0x0110; /* 1.10 */ |
+ d.bCountryCode = 0; |
+ d.bNumDescriptors = 1; |
+ d.bClassDescriptorType = LIBUSB_DT_REPORT; |
+ d.wClassDescriptorLength = (uint16_t)report_len; |
+ |
+ if (*size > LIBUSB_DT_HID_SIZE) |
+ *size = LIBUSB_DT_HID_SIZE; |
+ memcpy(data, &d, *size); |
+ return LIBUSB_COMPLETED; |
} |
-static int composite_submit_control_transfer(struct usbi_transfer *itransfer) |
+static int _hid_get_report_descriptor(struct hid_device_priv* dev, void *data, size_t *size) |
{ |
- struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
- struct libusb_context *ctx = DEVICE_CTX(transfer->dev_handle->dev); |
- struct windows_device_priv *priv = _device_priv(transfer->dev_handle->dev); |
- int i; |
- |
- for (i=0; i<USB_MAXINTERFACES; i++) { |
- if (priv->usb_interface[i].path != NULL) { |
- usbi_dbg("using interface %d", i); |
- return priv->usb_interface[i].apib->submit_control_transfer(itransfer); |
- } |
+ uint8_t d[MAX_HID_DESCRIPTOR_SIZE]; |
+ size_t i = 0; |
+ |
+ /* usage page (0xFFA0 == vendor defined) */ |
+ d[i++] = 0x06; d[i++] = 0xA0; d[i++] = 0xFF; |
+ /* usage (vendor defined) */ |
+ d[i++] = 0x09; d[i++] = 0x01; |
+ /* start collection (application) */ |
+ d[i++] = 0xA1; d[i++] = 0x01; |
+ /* input report */ |
+ if (dev->input_report_size) { |
+ /* usage (vendor defined) */ |
+ d[i++] = 0x09; d[i++] = 0x01; |
+ /* logical minimum (0) */ |
+ d[i++] = 0x15; d[i++] = 0x00; |
+ /* logical maximum (255) */ |
+ d[i++] = 0x25; d[i++] = 0xFF; |
+ /* report size (8 bits) */ |
+ d[i++] = 0x75; d[i++] = 0x08; |
+ /* report count */ |
+ d[i++] = 0x95; d[i++] = (uint8_t)dev->input_report_size - 1; |
+ /* input (data, variable, absolute) */ |
+ d[i++] = 0x81; d[i++] = 0x00; |
} |
- |
- usbi_err(ctx, "no libusb supported interfaces to complete request"); |
- return LIBUSB_ERROR_NOT_FOUND; |
-} |
- |
-static int composite_submit_bulk_transfer(struct usbi_transfer *itransfer) { |
- struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
- struct libusb_context *ctx = DEVICE_CTX(transfer->dev_handle->dev); |
- struct windows_device_handle_priv *handle_priv = _device_handle_priv(transfer->dev_handle); |
- struct windows_device_priv *priv = _device_priv(transfer->dev_handle->dev); |
- int current_interface; |
- |
- current_interface = interface_by_endpoint(priv, handle_priv, transfer->endpoint); |
- if (current_interface < 0) { |
- usbi_err(ctx, "unable to match endpoint to an open interface - cancelling transfer"); |
- return LIBUSB_ERROR_NOT_FOUND; |
+ /* output report */ |
+ if (dev->output_report_size) { |
+ /* usage (vendor defined) */ |
+ d[i++] = 0x09; d[i++] = 0x02; |
+ /* logical minimum (0) */ |
+ d[i++] = 0x15; d[i++] = 0x00; |
+ /* logical maximum (255) */ |
+ d[i++] = 0x25; d[i++] = 0xFF; |
+ /* report size (8 bits) */ |
+ d[i++] = 0x75; d[i++] = 0x08; |
+ /* report count */ |
+ d[i++] = 0x95; d[i++] = (uint8_t)dev->output_report_size - 1; |
+ /* output (data, variable, absolute) */ |
+ d[i++] = 0x91; d[i++] = 0x00; |
+ } |
+ /* feature report */ |
+ if (dev->feature_report_size) { |
+ /* usage (vendor defined) */ |
+ d[i++] = 0x09; d[i++] = 0x03; |
+ /* logical minimum (0) */ |
+ d[i++] = 0x15; d[i++] = 0x00; |
+ /* logical maximum (255) */ |
+ d[i++] = 0x25; d[i++] = 0xFF; |
+ /* report size (8 bits) */ |
+ d[i++] = 0x75; d[i++] = 0x08; |
+ /* report count */ |
+ d[i++] = 0x95; d[i++] = (uint8_t)dev->feature_report_size - 1; |
+ /* feature (data, variable, absolute) */ |
+ d[i++] = 0xb2; d[i++] = 0x02; d[i++] = 0x01; |
} |
- return priv->usb_interface[current_interface].apib->submit_bulk_transfer(itransfer); |
-} |
+ /* end collection */ |
+ d[i++] = 0xC0; |
-static int composite_submit_iso_transfer(struct usbi_transfer *itransfer) { |
- struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
- struct libusb_context *ctx = DEVICE_CTX(transfer->dev_handle->dev); |
- struct windows_device_handle_priv *handle_priv = _device_handle_priv(transfer->dev_handle); |
- struct windows_device_priv *priv = _device_priv(transfer->dev_handle->dev); |
- int current_interface; |
+ if (*size > i) |
+ *size = i; |
+ memcpy(data, d, *size); |
+ return LIBUSB_COMPLETED; |
+} |
- current_interface = interface_by_endpoint(priv, handle_priv, transfer->endpoint); |
- if (current_interface < 0) { |
- usbi_err(ctx, "unable to match endpoint to an open interface - cancelling transfer"); |
- return LIBUSB_ERROR_NOT_FOUND; |
+static int _hid_get_descriptor(struct hid_device_priv* dev, HANDLE hid_handle, int recipient, |
+ int type, int _index, void *data, size_t *size) |
+{ |
+ switch(type) { |
+ case LIBUSB_DT_DEVICE: |
+ usbi_dbg("LIBUSB_DT_DEVICE"); |
+ return _hid_get_device_descriptor(dev, data, size); |
+ case LIBUSB_DT_CONFIG: |
+ usbi_dbg("LIBUSB_DT_CONFIG"); |
+ if (!_index) |
+ return _hid_get_config_descriptor(dev, data, size); |
+ return LIBUSB_ERROR_INVALID_PARAM; |
+ case LIBUSB_DT_STRING: |
+ usbi_dbg("LIBUSB_DT_STRING"); |
+ return _hid_get_string_descriptor(dev, _index, data, size); |
+ case LIBUSB_DT_HID: |
+ usbi_dbg("LIBUSB_DT_HID"); |
+ if (!_index) |
+ return _hid_get_hid_descriptor(dev, data, size); |
+ return LIBUSB_ERROR_INVALID_PARAM; |
+ case LIBUSB_DT_REPORT: |
+ usbi_dbg("LIBUSB_DT_REPORT"); |
+ if (!_index) |
+ return _hid_get_report_descriptor(dev, data, size); |
+ return LIBUSB_ERROR_INVALID_PARAM; |
+ case LIBUSB_DT_PHYSICAL: |
+ usbi_dbg("LIBUSB_DT_PHYSICAL"); |
+ if (HidD_GetPhysicalDescriptor(hid_handle, data, (ULONG)*size)) |
+ return LIBUSB_COMPLETED; |
+ return LIBUSB_ERROR_OTHER; |
} |
- |
- return priv->usb_interface[current_interface].apib->submit_iso_transfer(itransfer); |
+ usbi_dbg("unsupported"); |
+ return LIBUSB_ERROR_INVALID_PARAM; |
} |
-static int composite_clear_halt(struct libusb_device_handle *dev_handle, unsigned char endpoint) |
+static int _hid_get_report(struct hid_device_priv* dev, HANDLE hid_handle, int id, void *data, |
+ struct windows_transfer_priv *tp, size_t *size, OVERLAPPED* overlapped, |
+ int report_type) |
{ |
- struct libusb_context *ctx = DEVICE_CTX(dev_handle->dev); |
- struct windows_device_handle_priv *handle_priv = _device_handle_priv(dev_handle); |
- struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
- int current_interface; |
+ uint8_t *buf; |
+ DWORD ioctl_code, read_size, expected_size = (DWORD)*size; |
+ int r = LIBUSB_SUCCESS; |
- current_interface = interface_by_endpoint(priv, handle_priv, endpoint); |
- if (current_interface < 0) { |
- usbi_err(ctx, "unable to match endpoint to an open interface - cannot clear"); |
- return LIBUSB_ERROR_NOT_FOUND; |
+ if (tp->hid_buffer != NULL) { |
+ usbi_dbg("program assertion failed: hid_buffer is not NULL"); |
} |
- return priv->usb_interface[current_interface].apib->clear_halt(dev_handle, endpoint); |
-} |
+ if ((*size == 0) || (*size > MAX_HID_REPORT_SIZE)) { |
+ usbi_dbg("invalid size (%d)", *size); |
+ return LIBUSB_ERROR_INVALID_PARAM; |
+ } |
-static int composite_abort_control(struct usbi_transfer *itransfer) |
+ switch (report_type) { |
+ case HID_REPORT_TYPE_INPUT: |
+ ioctl_code = IOCTL_HID_GET_INPUT_REPORT; |
+ break; |
+ case HID_REPORT_TYPE_FEATURE: |
+ ioctl_code = IOCTL_HID_GET_FEATURE; |
+ break; |
+ default: |
+ usbi_dbg("unknown HID report type %d", report_type); |
+ return LIBUSB_ERROR_INVALID_PARAM; |
+ } |
+ |
+ // Add a trailing byte to detect overflows |
+ buf = (uint8_t*)calloc(expected_size+1, 1); |
+ if (buf == NULL) { |
+ return LIBUSB_ERROR_NO_MEM; |
+ } |
+ buf[0] = (uint8_t)id; // Must be set always |
+ usbi_dbg("report ID: 0x%02X", buf[0]); |
+ |
+ tp->hid_expected_size = expected_size; |
+ read_size = expected_size; |
+ |
+ // NB: The size returned by DeviceIoControl doesn't include report IDs when not in use (0) |
+ if (!DeviceIoControl(hid_handle, ioctl_code, buf, expected_size+1, |
+ buf, expected_size+1, &read_size, overlapped)) { |
+ if (GetLastError() != ERROR_IO_PENDING) { |
+ usbi_dbg("Failed to Read HID Report: %s", windows_error_str(0)); |
+ safe_free(buf); |
+ return LIBUSB_ERROR_IO; |
+ } |
+ // Asynchronous wait |
+ tp->hid_buffer = buf; |
+ tp->hid_dest = (uint8_t*)data; // copy dest, as not necessarily the start of the transfer buffer |
+ return LIBUSB_SUCCESS; |
+ } |
+ |
+ // Transfer completed synchronously => copy and discard extra buffer |
+ if (read_size == 0) { |
+ usbi_warn(NULL, "program assertion failed - read completed synchronously, but no data was read"); |
+ *size = 0; |
+ } else { |
+ if (buf[0] != id) { |
+ usbi_warn(NULL, "mismatched report ID (data is %02X, parameter is %02X)", buf[0], id); |
+ } |
+ if ((size_t)read_size > expected_size) { |
+ r = LIBUSB_ERROR_OVERFLOW; |
+ usbi_dbg("OVERFLOW!"); |
+ } else { |
+ r = LIBUSB_COMPLETED; |
+ } |
+ |
+ *size = MIN((size_t)read_size, *size); |
+ if (id == 0) { |
+ // Discard report ID |
+ memcpy(data, buf+1, *size); |
+ } else { |
+ memcpy(data, buf, *size); |
+ } |
+ } |
+ safe_free(buf); |
+ return r; |
+} |
+ |
+static int _hid_set_report(struct hid_device_priv* dev, HANDLE hid_handle, int id, void *data, |
+ struct windows_transfer_priv *tp, size_t *size, OVERLAPPED* overlapped, |
+ int report_type) |
+{ |
+ uint8_t *buf = NULL; |
+ DWORD ioctl_code, write_size= (DWORD)*size; |
+ |
+ if (tp->hid_buffer != NULL) { |
+ usbi_dbg("program assertion failed: hid_buffer is not NULL"); |
+ } |
+ |
+ if ((*size == 0) || (*size > MAX_HID_REPORT_SIZE)) { |
+ usbi_dbg("invalid size (%d)", *size); |
+ return LIBUSB_ERROR_INVALID_PARAM; |
+ } |
+ |
+ switch (report_type) { |
+ case HID_REPORT_TYPE_OUTPUT: |
+ ioctl_code = IOCTL_HID_SET_OUTPUT_REPORT; |
+ break; |
+ case HID_REPORT_TYPE_FEATURE: |
+ ioctl_code = IOCTL_HID_SET_FEATURE; |
+ break; |
+ default: |
+ usbi_dbg("unknown HID report type %d", report_type); |
+ return LIBUSB_ERROR_INVALID_PARAM; |
+ } |
+ |
+ usbi_dbg("report ID: 0x%02X", id); |
+ // When report IDs are not used (i.e. when id == 0), we must add |
+ // a null report ID. Otherwise, we just use original data buffer |
+ if (id == 0) { |
+ write_size++; |
+ } |
+ buf = (uint8_t*) malloc(write_size); |
+ if (buf == NULL) { |
+ return LIBUSB_ERROR_NO_MEM; |
+ } |
+ if (id == 0) { |
+ buf[0] = 0; |
+ memcpy(buf + 1, data, *size); |
+ } else { |
+ // This seems like a waste, but if we don't duplicate the |
+ // data, we'll get issues when freeing hid_buffer |
+ memcpy(buf, data, *size); |
+ if (buf[0] != id) { |
+ usbi_warn(NULL, "mismatched report ID (data is %02X, parameter is %02X)", buf[0], id); |
+ } |
+ } |
+ |
+ // NB: The size returned by DeviceIoControl doesn't include report IDs when not in use (0) |
+ if (!DeviceIoControl(hid_handle, ioctl_code, buf, write_size, |
+ buf, write_size, &write_size, overlapped)) { |
+ if (GetLastError() != ERROR_IO_PENDING) { |
+ usbi_dbg("Failed to Write HID Output Report: %s", windows_error_str(0)); |
+ safe_free(buf); |
+ return LIBUSB_ERROR_IO; |
+ } |
+ tp->hid_buffer = buf; |
+ tp->hid_dest = NULL; |
+ return LIBUSB_SUCCESS; |
+ } |
+ |
+ // Transfer completed synchronously |
+ *size = write_size; |
+ if (write_size == 0) { |
+ usbi_dbg("program assertion failed - write completed synchronously, but no data was written"); |
+ } |
+ safe_free(buf); |
+ return LIBUSB_COMPLETED; |
+} |
+ |
+static int _hid_class_request(struct hid_device_priv* dev, HANDLE hid_handle, int request_type, |
+ int request, int value, int _index, void *data, struct windows_transfer_priv *tp, |
+ size_t *size, OVERLAPPED* overlapped) |
+{ |
+ int report_type = (value >> 8) & 0xFF; |
+ int report_id = value & 0xFF; |
+ |
+ if ( (LIBUSB_REQ_RECIPIENT(request_type) != LIBUSB_RECIPIENT_INTERFACE) |
+ && (LIBUSB_REQ_RECIPIENT(request_type) != LIBUSB_RECIPIENT_DEVICE) ) |
+ return LIBUSB_ERROR_INVALID_PARAM; |
+ |
+ if (LIBUSB_REQ_OUT(request_type) && request == HID_REQ_SET_REPORT) |
+ return _hid_set_report(dev, hid_handle, report_id, data, tp, size, overlapped, report_type); |
+ |
+ if (LIBUSB_REQ_IN(request_type) && request == HID_REQ_GET_REPORT) |
+ return _hid_get_report(dev, hid_handle, report_id, data, tp, size, overlapped, report_type); |
+ |
+ return LIBUSB_ERROR_INVALID_PARAM; |
+} |
+ |
+ |
+/* |
+ * HID API functions |
+ */ |
+static int hid_init(int sub_api, struct libusb_context *ctx) |
+{ |
+ DLL_LOAD(hid.dll, HidD_GetAttributes, TRUE); |
+ DLL_LOAD(hid.dll, HidD_GetHidGuid, TRUE); |
+ DLL_LOAD(hid.dll, HidD_GetPreparsedData, TRUE); |
+ DLL_LOAD(hid.dll, HidD_FreePreparsedData, TRUE); |
+ DLL_LOAD(hid.dll, HidD_GetManufacturerString, TRUE); |
+ DLL_LOAD(hid.dll, HidD_GetProductString, TRUE); |
+ DLL_LOAD(hid.dll, HidD_GetSerialNumberString, TRUE); |
+ DLL_LOAD(hid.dll, HidP_GetCaps, TRUE); |
+ DLL_LOAD(hid.dll, HidD_SetNumInputBuffers, TRUE); |
+ DLL_LOAD(hid.dll, HidD_SetFeature, TRUE); |
+ DLL_LOAD(hid.dll, HidD_GetFeature, TRUE); |
+ DLL_LOAD(hid.dll, HidD_GetPhysicalDescriptor, TRUE); |
+ DLL_LOAD(hid.dll, HidD_GetInputReport, FALSE); |
+ DLL_LOAD(hid.dll, HidD_SetOutputReport, FALSE); |
+ DLL_LOAD(hid.dll, HidD_FlushQueue, TRUE); |
+ DLL_LOAD(hid.dll, HidP_GetValueCaps, TRUE); |
+ |
+ api_hid_available = true; |
+ return LIBUSB_SUCCESS; |
+} |
+ |
+static int hid_exit(int sub_api) |
+{ |
+ return LIBUSB_SUCCESS; |
+} |
+ |
+// NB: open and close must ensure that they only handle interface of |
+// the right API type, as these functions can be called wholesale from |
+// composite_open(), with interfaces belonging to different APIs |
+static int hid_open(int sub_api, struct libusb_device_handle *dev_handle) |
+{ |
+ struct libusb_context *ctx = DEVICE_CTX(dev_handle->dev); |
+ struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
+ struct windows_device_handle_priv *handle_priv = _device_handle_priv(dev_handle); |
+ |
+ HIDD_ATTRIBUTES hid_attributes; |
+ PHIDP_PREPARSED_DATA preparsed_data = NULL; |
+ HIDP_CAPS capabilities; |
+ HIDP_VALUE_CAPS *value_caps; |
+ |
+ HANDLE hid_handle = INVALID_HANDLE_VALUE; |
+ int i, j; |
+ // report IDs handling |
+ ULONG size[3]; |
+ const char* type[3] = {"input", "output", "feature"}; |
+ int nb_ids[2]; // zero and nonzero report IDs |
+ |
+ CHECK_HID_AVAILABLE; |
+ if (priv->hid == NULL) { |
+ usbi_err(ctx, "program assertion failed - private HID structure is unitialized"); |
+ return LIBUSB_ERROR_NOT_FOUND; |
+ } |
+ |
+ for (i = 0; i < USB_MAXINTERFACES; i++) { |
+ if ( (priv->usb_interface[i].path != NULL) |
+ && (priv->usb_interface[i].apib->id == USB_API_HID) ) { |
+ hid_handle = CreateFileA(priv->usb_interface[i].path, GENERIC_WRITE | GENERIC_READ, FILE_SHARE_WRITE | FILE_SHARE_READ, |
+ NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED, NULL); |
+ /* |
+ * http://www.lvr.com/hidfaq.htm: Why do I receive "Access denied" when attempting to access my HID? |
+ * "Windows 2000 and later have exclusive read/write access to HIDs that are configured as a system |
+ * keyboards or mice. An application can obtain a handle to a system keyboard or mouse by not |
+ * requesting READ or WRITE access with CreateFile. Applications can then use HidD_SetFeature and |
+ * HidD_GetFeature (if the device supports Feature reports)." |
+ */ |
+ if (hid_handle == INVALID_HANDLE_VALUE) { |
+ usbi_warn(ctx, "could not open HID device in R/W mode (keyboard or mouse?) - trying without"); |
+ hid_handle = CreateFileA(priv->usb_interface[i].path, 0, FILE_SHARE_WRITE | FILE_SHARE_READ, |
+ NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED, NULL); |
+ if (hid_handle == INVALID_HANDLE_VALUE) { |
+ usbi_err(ctx, "could not open device %s (interface %d): %s", priv->path, i, windows_error_str(0)); |
+ switch(GetLastError()) { |
+ case ERROR_FILE_NOT_FOUND: // The device was disconnected |
+ return LIBUSB_ERROR_NO_DEVICE; |
+ case ERROR_ACCESS_DENIED: |
+ return LIBUSB_ERROR_ACCESS; |
+ default: |
+ return LIBUSB_ERROR_IO; |
+ } |
+ } |
+ priv->usb_interface[i].restricted_functionality = true; |
+ } |
+ handle_priv->interface_handle[i].api_handle = hid_handle; |
+ } |
+ } |
+ |
+ hid_attributes.Size = sizeof(hid_attributes); |
+ do { |
+ if (!HidD_GetAttributes(hid_handle, &hid_attributes)) { |
+ usbi_err(ctx, "could not gain access to HID top collection (HidD_GetAttributes)"); |
+ break; |
+ } |
+ |
+ priv->hid->vid = hid_attributes.VendorID; |
+ priv->hid->pid = hid_attributes.ProductID; |
+ |
+ // Set the maximum available input buffer size |
+ for (i=32; HidD_SetNumInputBuffers(hid_handle, i); i*=2); |
+ usbi_dbg("set maximum input buffer size to %d", i/2); |
+ |
+ // Get the maximum input and output report size |
+ if (!HidD_GetPreparsedData(hid_handle, &preparsed_data) || !preparsed_data) { |
+ usbi_err(ctx, "could not read HID preparsed data (HidD_GetPreparsedData)"); |
+ break; |
+ } |
+ if (HidP_GetCaps(preparsed_data, &capabilities) != HIDP_STATUS_SUCCESS) { |
+ usbi_err(ctx, "could not parse HID capabilities (HidP_GetCaps)"); |
+ break; |
+ } |
+ |
+ // Find out if interrupt will need report IDs |
+ size[0] = capabilities.NumberInputValueCaps; |
+ size[1] = capabilities.NumberOutputValueCaps; |
+ size[2] = capabilities.NumberFeatureValueCaps; |
+ for (j=HidP_Input; j<=HidP_Feature; j++) { |
+ usbi_dbg("%d HID %s report value(s) found", size[j], type[j]); |
+ priv->hid->uses_report_ids[j] = false; |
+ if (size[j] > 0) { |
+ value_caps = (HIDP_VALUE_CAPS*) calloc(size[j], sizeof(HIDP_VALUE_CAPS)); |
+ if ( (value_caps != NULL) |
+ && (HidP_GetValueCaps((HIDP_REPORT_TYPE)j, value_caps, &size[j], preparsed_data) == HIDP_STATUS_SUCCESS) |
+ && (size[j] >= 1) ) { |
+ nb_ids[0] = 0; |
+ nb_ids[1] = 0; |
+ for (i=0; i<(int)size[j]; i++) { |
+ usbi_dbg(" Report ID: 0x%02X", value_caps[i].ReportID); |
+ if (value_caps[i].ReportID != 0) { |
+ nb_ids[1]++; |
+ } else { |
+ nb_ids[0]++; |
+ } |
+ } |
+ if (nb_ids[1] != 0) { |
+ if (nb_ids[0] != 0) { |
+ usbi_warn(ctx, "program assertion failed: zero and nonzero report IDs used for %s", |
+ type[j]); |
+ } |
+ priv->hid->uses_report_ids[j] = true; |
+ } |
+ } else { |
+ usbi_warn(ctx, " could not process %s report IDs", type[j]); |
+ } |
+ safe_free(value_caps); |
+ } |
+ } |
+ |
+ // Set the report sizes |
+ priv->hid->input_report_size = capabilities.InputReportByteLength; |
+ priv->hid->output_report_size = capabilities.OutputReportByteLength; |
+ priv->hid->feature_report_size = capabilities.FeatureReportByteLength; |
+ |
+ // Fetch string descriptors |
+ priv->hid->string_index[0] = priv->dev_descriptor.iManufacturer; |
+ if (priv->hid->string_index[0] != 0) { |
+ HidD_GetManufacturerString(hid_handle, priv->hid->string[0], |
+ sizeof(priv->hid->string[0])); |
+ } else { |
+ priv->hid->string[0][0] = 0; |
+ } |
+ priv->hid->string_index[1] = priv->dev_descriptor.iProduct; |
+ if (priv->hid->string_index[1] != 0) { |
+ HidD_GetProductString(hid_handle, priv->hid->string[1], |
+ sizeof(priv->hid->string[1])); |
+ } else { |
+ priv->hid->string[1][0] = 0; |
+ } |
+ priv->hid->string_index[2] = priv->dev_descriptor.iSerialNumber; |
+ if (priv->hid->string_index[2] != 0) { |
+ HidD_GetSerialNumberString(hid_handle, priv->hid->string[2], |
+ sizeof(priv->hid->string[2])); |
+ } else { |
+ priv->hid->string[2][0] = 0; |
+ } |
+ } while(0); |
+ |
+ if (preparsed_data) { |
+ HidD_FreePreparsedData(preparsed_data); |
+ } |
+ |
+ return LIBUSB_SUCCESS; |
+} |
+ |
+static void hid_close(int sub_api, struct libusb_device_handle *dev_handle) |
+{ |
+ struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
+ struct windows_device_handle_priv *handle_priv = _device_handle_priv(dev_handle); |
+ HANDLE file_handle; |
+ int i; |
+ |
+ if (!api_hid_available) |
+ return; |
+ |
+ for (i = 0; i < USB_MAXINTERFACES; i++) { |
+ if (priv->usb_interface[i].apib->id == USB_API_HID) { |
+ file_handle = handle_priv->interface_handle[i].api_handle; |
+ if ( (file_handle != 0) && (file_handle != INVALID_HANDLE_VALUE)) { |
+ CloseHandle(file_handle); |
+ } |
+ } |
+ } |
+} |
+ |
+static int hid_claim_interface(int sub_api, struct libusb_device_handle *dev_handle, int iface) |
+{ |
+ struct windows_device_handle_priv *handle_priv = _device_handle_priv(dev_handle); |
+ struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
+ |
+ CHECK_HID_AVAILABLE; |
+ |
+ // NB: Disconnection detection is not possible in this function |
+ if (priv->usb_interface[iface].path == NULL) { |
+ return LIBUSB_ERROR_NOT_FOUND; // invalid iface |
+ } |
+ |
+ // We use dev_handle as a flag for interface claimed |
+ if (handle_priv->interface_handle[iface].dev_handle == INTERFACE_CLAIMED) { |
+ return LIBUSB_ERROR_BUSY; // already claimed |
+ } |
+ |
+ handle_priv->interface_handle[iface].dev_handle = INTERFACE_CLAIMED; |
+ |
+ usbi_dbg("claimed interface %d", iface); |
+ handle_priv->active_interface = iface; |
+ |
+ return LIBUSB_SUCCESS; |
+} |
+ |
+static int hid_release_interface(int sub_api, struct libusb_device_handle *dev_handle, int iface) |
+{ |
+ struct windows_device_handle_priv *handle_priv = _device_handle_priv(dev_handle); |
+ struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
+ |
+ CHECK_HID_AVAILABLE; |
+ |
+ if (priv->usb_interface[iface].path == NULL) { |
+ return LIBUSB_ERROR_NOT_FOUND; // invalid iface |
+ } |
+ |
+ if (handle_priv->interface_handle[iface].dev_handle != INTERFACE_CLAIMED) { |
+ return LIBUSB_ERROR_NOT_FOUND; // invalid iface |
+ } |
+ |
+ handle_priv->interface_handle[iface].dev_handle = INVALID_HANDLE_VALUE; |
+ |
+ return LIBUSB_SUCCESS; |
+} |
+ |
+static int hid_set_interface_altsetting(int sub_api, struct libusb_device_handle *dev_handle, int iface, int altsetting) |
+{ |
+ struct libusb_context *ctx = DEVICE_CTX(dev_handle->dev); |
+ |
+ CHECK_HID_AVAILABLE; |
+ |
+ if (altsetting > 255) { |
+ return LIBUSB_ERROR_INVALID_PARAM; |
+ } |
+ |
+ if (altsetting != 0) { |
+ usbi_err(ctx, "set interface altsetting not supported for altsetting >0"); |
+ return LIBUSB_ERROR_NOT_SUPPORTED; |
+ } |
+ |
+ return LIBUSB_SUCCESS; |
+} |
+ |
+static int hid_submit_control_transfer(int sub_api, struct usbi_transfer *itransfer) |
{ |
struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
- struct windows_transfer_priv *transfer_priv = usbi_transfer_get_os_priv(itransfer); |
+ struct windows_transfer_priv *transfer_priv = (struct windows_transfer_priv*)usbi_transfer_get_os_priv(itransfer); |
+ struct windows_device_handle_priv *handle_priv = _device_handle_priv(transfer->dev_handle); |
+ struct windows_device_priv *priv = _device_priv(transfer->dev_handle->dev); |
+ struct libusb_context *ctx = DEVICE_CTX(transfer->dev_handle->dev); |
+ WINUSB_SETUP_PACKET *setup = (WINUSB_SETUP_PACKET *) transfer->buffer; |
+ HANDLE hid_handle; |
+ struct winfd wfd; |
+ int current_interface, config; |
+ size_t size; |
+ int r = LIBUSB_ERROR_INVALID_PARAM; |
+ |
+ CHECK_HID_AVAILABLE; |
+ |
+ transfer_priv->pollable_fd = INVALID_WINFD; |
+ safe_free(transfer_priv->hid_buffer); |
+ transfer_priv->hid_dest = NULL; |
+ size = transfer->length - LIBUSB_CONTROL_SETUP_SIZE; |
+ |
+ if (size > MAX_CTRL_BUFFER_LENGTH) { |
+ return LIBUSB_ERROR_INVALID_PARAM; |
+ } |
+ |
+ current_interface = get_valid_interface(transfer->dev_handle, USB_API_HID); |
+ if (current_interface < 0) { |
+ if (auto_claim(transfer, ¤t_interface, USB_API_HID) != LIBUSB_SUCCESS) { |
+ return LIBUSB_ERROR_NOT_FOUND; |
+ } |
+ } |
+ |
+ usbi_dbg("will use interface %d", current_interface); |
+ hid_handle = handle_priv->interface_handle[current_interface].api_handle; |
+ // Always use the handle returned from usbi_create_fd (wfd.handle) |
+ wfd = usbi_create_fd(hid_handle, RW_READ, NULL, NULL); |
+ if (wfd.fd < 0) { |
+ return LIBUSB_ERROR_NOT_FOUND; |
+ } |
+ |
+ switch(LIBUSB_REQ_TYPE(setup->request_type)) { |
+ case LIBUSB_REQUEST_TYPE_STANDARD: |
+ switch(setup->request) { |
+ case LIBUSB_REQUEST_GET_DESCRIPTOR: |
+ r = _hid_get_descriptor(priv->hid, wfd.handle, LIBUSB_REQ_RECIPIENT(setup->request_type), |
+ (setup->value >> 8) & 0xFF, setup->value & 0xFF, transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE, &size); |
+ break; |
+ case LIBUSB_REQUEST_GET_CONFIGURATION: |
+ r = windows_get_configuration(transfer->dev_handle, &config); |
+ if (r == LIBUSB_SUCCESS) { |
+ size = 1; |
+ ((uint8_t*)transfer->buffer)[LIBUSB_CONTROL_SETUP_SIZE] = (uint8_t)config; |
+ r = LIBUSB_COMPLETED; |
+ } |
+ break; |
+ case LIBUSB_REQUEST_SET_CONFIGURATION: |
+ if (setup->value == priv->active_config) { |
+ r = LIBUSB_COMPLETED; |
+ } else { |
+ usbi_warn(ctx, "cannot set configuration other than the default one"); |
+ r = LIBUSB_ERROR_INVALID_PARAM; |
+ } |
+ break; |
+ case LIBUSB_REQUEST_GET_INTERFACE: |
+ size = 1; |
+ ((uint8_t*)transfer->buffer)[LIBUSB_CONTROL_SETUP_SIZE] = 0; |
+ r = LIBUSB_COMPLETED; |
+ break; |
+ case LIBUSB_REQUEST_SET_INTERFACE: |
+ r = hid_set_interface_altsetting(0, transfer->dev_handle, setup->index, setup->value); |
+ if (r == LIBUSB_SUCCESS) { |
+ r = LIBUSB_COMPLETED; |
+ } |
+ break; |
+ default: |
+ usbi_warn(ctx, "unsupported HID control request"); |
+ r = LIBUSB_ERROR_INVALID_PARAM; |
+ break; |
+ } |
+ break; |
+ case LIBUSB_REQUEST_TYPE_CLASS: |
+ r =_hid_class_request(priv->hid, wfd.handle, setup->request_type, setup->request, setup->value, |
+ setup->index, transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE, transfer_priv, |
+ &size, wfd.overlapped); |
+ break; |
+ default: |
+ usbi_warn(ctx, "unsupported HID control request"); |
+ r = LIBUSB_ERROR_INVALID_PARAM; |
+ break; |
+ } |
+ |
+ if (r == LIBUSB_COMPLETED) { |
+ // Force request to be completed synchronously. Transferred size has been set by previous call |
+ wfd.overlapped->Internal = STATUS_COMPLETED_SYNCHRONOUSLY; |
+ // http://msdn.microsoft.com/en-us/library/ms684342%28VS.85%29.aspx |
+ // set InternalHigh to the number of bytes transferred |
+ wfd.overlapped->InternalHigh = (DWORD)size; |
+ r = LIBUSB_SUCCESS; |
+ } |
+ |
+ if (r == LIBUSB_SUCCESS) { |
+ // Use priv_transfer to store data needed for async polling |
+ transfer_priv->pollable_fd = wfd; |
+ transfer_priv->interface_number = (uint8_t)current_interface; |
+ } else { |
+ usbi_free_fd(&wfd); |
+ } |
+ |
+ return r; |
+} |
+ |
+static int hid_submit_bulk_transfer(int sub_api, struct usbi_transfer *itransfer) { |
+ struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
+ struct windows_transfer_priv *transfer_priv = (struct windows_transfer_priv*)usbi_transfer_get_os_priv(itransfer); |
+ struct libusb_context *ctx = DEVICE_CTX(transfer->dev_handle->dev); |
+ struct windows_device_handle_priv *handle_priv = _device_handle_priv(transfer->dev_handle); |
struct windows_device_priv *priv = _device_priv(transfer->dev_handle->dev); |
+ struct winfd wfd; |
+ HANDLE hid_handle; |
+ bool direction_in, ret; |
+ int current_interface, length; |
+ DWORD size; |
+ int r = LIBUSB_SUCCESS; |
+ |
+ CHECK_HID_AVAILABLE; |
+ |
+ transfer_priv->pollable_fd = INVALID_WINFD; |
+ transfer_priv->hid_dest = NULL; |
+ safe_free(transfer_priv->hid_buffer); |
+ |
+ current_interface = interface_by_endpoint(priv, handle_priv, transfer->endpoint); |
+ if (current_interface < 0) { |
+ usbi_err(ctx, "unable to match endpoint to an open interface - cancelling transfer"); |
+ return LIBUSB_ERROR_NOT_FOUND; |
+ } |
+ |
+ usbi_dbg("matched endpoint %02X with interface %d", transfer->endpoint, current_interface); |
+ |
+ hid_handle = handle_priv->interface_handle[current_interface].api_handle; |
+ direction_in = transfer->endpoint & LIBUSB_ENDPOINT_IN; |
+ |
+ wfd = usbi_create_fd(hid_handle, direction_in?RW_READ:RW_WRITE, NULL, NULL); |
+ // Always use the handle returned from usbi_create_fd (wfd.handle) |
+ if (wfd.fd < 0) { |
+ return LIBUSB_ERROR_NO_MEM; |
+ } |
+ |
+ // If report IDs are not in use, an extra prefix byte must be added |
+ if ( ((direction_in) && (!priv->hid->uses_report_ids[0])) |
+ || ((!direction_in) && (!priv->hid->uses_report_ids[1])) ) { |
+ length = transfer->length+1; |
+ } else { |
+ length = transfer->length; |
+ } |
+ // Add a trailing byte to detect overflows on input |
+ transfer_priv->hid_buffer = (uint8_t*)calloc(length+1, 1); |
+ if (transfer_priv->hid_buffer == NULL) { |
+ return LIBUSB_ERROR_NO_MEM; |
+ } |
+ transfer_priv->hid_expected_size = length; |
+ |
+ if (direction_in) { |
+ transfer_priv->hid_dest = transfer->buffer; |
+ usbi_dbg("reading %d bytes (report ID: 0x00)", length); |
+ ret = ReadFile(wfd.handle, transfer_priv->hid_buffer, length+1, &size, wfd.overlapped); |
+ } else { |
+ if (!priv->hid->uses_report_ids[1]) { |
+ memcpy(transfer_priv->hid_buffer+1, transfer->buffer, transfer->length); |
+ } else { |
+ // We could actually do without the calloc and memcpy in this case |
+ memcpy(transfer_priv->hid_buffer, transfer->buffer, transfer->length); |
+ } |
+ usbi_dbg("writing %d bytes (report ID: 0x%02X)", length, transfer_priv->hid_buffer[0]); |
+ ret = WriteFile(wfd.handle, transfer_priv->hid_buffer, length, &size, wfd.overlapped); |
+ } |
+ if (!ret) { |
+ if (GetLastError() != ERROR_IO_PENDING) { |
+ usbi_err(ctx, "HID transfer failed: %s", windows_error_str(0)); |
+ usbi_free_fd(&wfd); |
+ safe_free(transfer_priv->hid_buffer); |
+ return LIBUSB_ERROR_IO; |
+ } |
+ } else { |
+ // Only write operations that completed synchronously need to free up |
+ // hid_buffer. For reads, copy_transfer_data() handles that process. |
+ if (!direction_in) { |
+ safe_free(transfer_priv->hid_buffer); |
+ } |
+ if (size == 0) { |
+ usbi_err(ctx, "program assertion failed - no data was transferred"); |
+ size = 1; |
+ } |
+ if (size > (size_t)length) { |
+ usbi_err(ctx, "OVERFLOW!"); |
+ r = LIBUSB_ERROR_OVERFLOW; |
+ } |
+ wfd.overlapped->Internal = STATUS_COMPLETED_SYNCHRONOUSLY; |
+ wfd.overlapped->InternalHigh = size; |
+ } |
+ |
+ transfer_priv->pollable_fd = wfd; |
+ transfer_priv->interface_number = (uint8_t)current_interface; |
+ |
+ return r; |
+} |
- return priv->usb_interface[transfer_priv->interface_number].apib->abort_control(itransfer); |
+static int hid_abort_transfers(int sub_api, struct usbi_transfer *itransfer) |
+{ |
+ struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
+ struct windows_transfer_priv *transfer_priv = (struct windows_transfer_priv*)usbi_transfer_get_os_priv(itransfer); |
+ struct windows_device_handle_priv *handle_priv = _device_handle_priv(transfer->dev_handle); |
+ HANDLE hid_handle; |
+ int current_interface; |
+ |
+ CHECK_HID_AVAILABLE; |
+ |
+ current_interface = transfer_priv->interface_number; |
+ hid_handle = handle_priv->interface_handle[current_interface].api_handle; |
+ CancelIo(hid_handle); |
+ |
+ return LIBUSB_SUCCESS; |
} |
-static int composite_abort_transfers(struct usbi_transfer *itransfer) |
+static int hid_reset_device(int sub_api, struct libusb_device_handle *dev_handle) |
{ |
+ struct windows_device_handle_priv *handle_priv = _device_handle_priv(dev_handle); |
+ HANDLE hid_handle; |
+ int current_interface; |
+ |
+ CHECK_HID_AVAILABLE; |
+ |
+ // Flushing the queues on all interfaces is the best we can achieve |
+ for (current_interface = 0; current_interface < USB_MAXINTERFACES; current_interface++) { |
+ hid_handle = handle_priv->interface_handle[current_interface].api_handle; |
+ if ((hid_handle != 0) && (hid_handle != INVALID_HANDLE_VALUE)) { |
+ HidD_FlushQueue(hid_handle); |
+ } |
+ } |
+ return LIBUSB_SUCCESS; |
+} |
+ |
+static int hid_clear_halt(int sub_api, struct libusb_device_handle *dev_handle, unsigned char endpoint) |
+{ |
+ struct libusb_context *ctx = DEVICE_CTX(dev_handle->dev); |
+ struct windows_device_handle_priv *handle_priv = _device_handle_priv(dev_handle); |
+ struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
+ HANDLE hid_handle; |
+ int current_interface; |
+ |
+ CHECK_HID_AVAILABLE; |
+ |
+ current_interface = interface_by_endpoint(priv, handle_priv, endpoint); |
+ if (current_interface < 0) { |
+ usbi_err(ctx, "unable to match endpoint to an open interface - cannot clear"); |
+ return LIBUSB_ERROR_NOT_FOUND; |
+ } |
+ |
+ usbi_dbg("matched endpoint %02X with interface %d", endpoint, current_interface); |
+ hid_handle = handle_priv->interface_handle[current_interface].api_handle; |
+ |
+ // No endpoint selection with Microsoft's implementation, so we try to flush the |
+ // whole interface. Should be OK for most case scenarios |
+ if (!HidD_FlushQueue(hid_handle)) { |
+ usbi_err(ctx, "Flushing of HID queue failed: %s", windows_error_str(0)); |
+ // Device was probably disconnected |
+ return LIBUSB_ERROR_NO_DEVICE; |
+ } |
+ |
+ return LIBUSB_SUCCESS; |
+} |
+ |
+// This extra function is only needed for HID |
+static int hid_copy_transfer_data(int sub_api, struct usbi_transfer *itransfer, uint32_t io_size) { |
struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
+ struct libusb_context *ctx = DEVICE_CTX(transfer->dev_handle->dev); |
struct windows_transfer_priv *transfer_priv = usbi_transfer_get_os_priv(itransfer); |
+ int r = LIBUSB_TRANSFER_COMPLETED; |
+ uint32_t corrected_size = io_size; |
+ |
+ if (transfer_priv->hid_buffer != NULL) { |
+ // If we have a valid hid_buffer, it means the transfer was async |
+ if (transfer_priv->hid_dest != NULL) { // Data readout |
+ // First, check for overflow |
+ if (corrected_size > transfer_priv->hid_expected_size) { |
+ usbi_err(ctx, "OVERFLOW!"); |
+ corrected_size = (uint32_t)transfer_priv->hid_expected_size; |
+ r = LIBUSB_TRANSFER_OVERFLOW; |
+ } |
+ |
+ if (transfer_priv->hid_buffer[0] == 0) { |
+ // Discard the 1 byte report ID prefix |
+ corrected_size--; |
+ memcpy(transfer_priv->hid_dest, transfer_priv->hid_buffer+1, corrected_size); |
+ } else { |
+ memcpy(transfer_priv->hid_dest, transfer_priv->hid_buffer, corrected_size); |
+ } |
+ transfer_priv->hid_dest = NULL; |
+ } |
+ // For write, we just need to free the hid buffer |
+ safe_free(transfer_priv->hid_buffer); |
+ } |
+ itransfer->transferred += corrected_size; |
+ return r; |
+} |
+ |
+ |
+/* |
+ * Composite API functions |
+ */ |
+static int composite_init(int sub_api, struct libusb_context *ctx) |
+{ |
+ return LIBUSB_SUCCESS; |
+} |
+ |
+static int composite_exit(int sub_api) |
+{ |
+ return LIBUSB_SUCCESS; |
+} |
+ |
+static int composite_open(int sub_api, struct libusb_device_handle *dev_handle) |
+{ |
+ struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
+ int r = LIBUSB_ERROR_NOT_FOUND; |
+ uint8_t i; |
+ // SUB_API_MAX+1 as the SUB_API_MAX pos is used to indicate availability of HID |
+ bool available[SUB_API_MAX+1] = {0}; |
+ |
+ for (i=0; i<USB_MAXINTERFACES; i++) { |
+ switch (priv->usb_interface[i].apib->id) { |
+ case USB_API_WINUSBX: |
+ if (priv->usb_interface[i].sub_api != SUB_API_NOTSET) |
+ available[priv->usb_interface[i].sub_api] = true; |
+ break; |
+ case USB_API_HID: |
+ available[SUB_API_MAX] = true; |
+ break; |
+ default: |
+ break; |
+ } |
+ } |
+ |
+ for (i=0; i<SUB_API_MAX; i++) { // WinUSB-like drivers |
+ if (available[i]) { |
+ r = usb_api_backend[USB_API_WINUSBX].open(i, dev_handle); |
+ if (r != LIBUSB_SUCCESS) { |
+ return r; |
+ } |
+ } |
+ } |
+ if (available[SUB_API_MAX]) { // HID driver |
+ r = hid_open(SUB_API_NOTSET, dev_handle); |
+ } |
+ return r; |
+} |
+ |
+static void composite_close(int sub_api, struct libusb_device_handle *dev_handle) |
+{ |
+ struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
+ uint8_t i; |
+ bool available[SUB_API_MAX]; |
+ |
+ for (i = 0; i<SUB_API_MAX; i++) { |
+ available[i] = false; |
+ } |
+ |
+ for (i=0; i<USB_MAXINTERFACES; i++) { |
+ if ( (priv->usb_interface[i].apib->id == USB_API_WINUSBX) |
+ && (priv->usb_interface[i].sub_api != SUB_API_NOTSET) ) { |
+ available[priv->usb_interface[i].sub_api] = true; |
+ } |
+ } |
+ |
+ for (i=0; i<SUB_API_MAX; i++) { |
+ if (available[i]) { |
+ usb_api_backend[USB_API_WINUSBX].close(i, dev_handle); |
+ } |
+ } |
+} |
+ |
+static int composite_claim_interface(int sub_api, struct libusb_device_handle *dev_handle, int iface) |
+{ |
+ struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
+ return priv->usb_interface[iface].apib-> |
+ claim_interface(priv->usb_interface[iface].sub_api, dev_handle, iface); |
+} |
+ |
+static int composite_set_interface_altsetting(int sub_api, struct libusb_device_handle *dev_handle, int iface, int altsetting) |
+{ |
+ struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
+ return priv->usb_interface[iface].apib-> |
+ set_interface_altsetting(priv->usb_interface[iface].sub_api, dev_handle, iface, altsetting); |
+} |
+ |
+static int composite_release_interface(int sub_api, struct libusb_device_handle *dev_handle, int iface) |
+{ |
+ struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
+ return priv->usb_interface[iface].apib-> |
+ release_interface(priv->usb_interface[iface].sub_api, dev_handle, iface); |
+} |
+ |
+static int composite_submit_control_transfer(int sub_api, struct usbi_transfer *itransfer) |
+{ |
+ struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
+ struct libusb_context *ctx = DEVICE_CTX(transfer->dev_handle->dev); |
struct windows_device_priv *priv = _device_priv(transfer->dev_handle->dev); |
+ int i, pass; |
+ |
+ // Interface shouldn't matter for control, but it does in practice, with Windows' |
+ // restrictions with regards to accessing HID keyboards and mice. Try a 2 pass approach |
+ for (pass = 0; pass < 2; pass++) { |
+ for (i=0; i<USB_MAXINTERFACES; i++) { |
+ if (priv->usb_interface[i].path != NULL) { |
+ if ((pass == 0) && (priv->usb_interface[i].restricted_functionality)) { |
+ usbi_dbg("trying to skip restricted interface #%d (HID keyboard or mouse?)", i); |
+ continue; |
+ } |
+ usbi_dbg("using interface %d", i); |
+ return priv->usb_interface[i].apib->submit_control_transfer(priv->usb_interface[i].sub_api, itransfer); |
+ } |
+ } |
+ } |
- return priv->usb_interface[transfer_priv->interface_number].apib->abort_transfers(itransfer); |
+ usbi_err(ctx, "no libusbx supported interfaces to complete request"); |
+ return LIBUSB_ERROR_NOT_FOUND; |
} |
-static int composite_reset_device(struct libusb_device_handle *dev_handle) |
+static int composite_submit_bulk_transfer(int sub_api, struct usbi_transfer *itransfer) { |
+ struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
+ struct libusb_context *ctx = DEVICE_CTX(transfer->dev_handle->dev); |
+ struct windows_device_handle_priv *handle_priv = _device_handle_priv(transfer->dev_handle); |
+ struct windows_device_priv *priv = _device_priv(transfer->dev_handle->dev); |
+ int current_interface; |
+ |
+ current_interface = interface_by_endpoint(priv, handle_priv, transfer->endpoint); |
+ if (current_interface < 0) { |
+ usbi_err(ctx, "unable to match endpoint to an open interface - cancelling transfer"); |
+ return LIBUSB_ERROR_NOT_FOUND; |
+ } |
+ |
+ return priv->usb_interface[current_interface].apib-> |
+ submit_bulk_transfer(priv->usb_interface[current_interface].sub_api, itransfer);} |
+ |
+static int composite_submit_iso_transfer(int sub_api, struct usbi_transfer *itransfer) { |
+ struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
+ struct libusb_context *ctx = DEVICE_CTX(transfer->dev_handle->dev); |
+ struct windows_device_handle_priv *handle_priv = _device_handle_priv(transfer->dev_handle); |
+ struct windows_device_priv *priv = _device_priv(transfer->dev_handle->dev); |
+ int current_interface; |
+ |
+ current_interface = interface_by_endpoint(priv, handle_priv, transfer->endpoint); |
+ if (current_interface < 0) { |
+ usbi_err(ctx, "unable to match endpoint to an open interface - cancelling transfer"); |
+ return LIBUSB_ERROR_NOT_FOUND; |
+ } |
+ |
+ return priv->usb_interface[current_interface].apib-> |
+ submit_iso_transfer(priv->usb_interface[current_interface].sub_api, itransfer);} |
+ |
+static int composite_clear_halt(int sub_api, struct libusb_device_handle *dev_handle, unsigned char endpoint) |
+{ |
+ struct libusb_context *ctx = DEVICE_CTX(dev_handle->dev); |
+ struct windows_device_handle_priv *handle_priv = _device_handle_priv(dev_handle); |
+ struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
+ int current_interface; |
+ |
+ current_interface = interface_by_endpoint(priv, handle_priv, endpoint); |
+ if (current_interface < 0) { |
+ usbi_err(ctx, "unable to match endpoint to an open interface - cannot clear"); |
+ return LIBUSB_ERROR_NOT_FOUND; |
+ } |
+ |
+ return priv->usb_interface[current_interface].apib-> |
+ clear_halt(priv->usb_interface[current_interface].sub_api, dev_handle, endpoint);} |
+ |
+static int composite_abort_control(int sub_api, struct usbi_transfer *itransfer) |
+{ |
+ struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
+ struct windows_transfer_priv *transfer_priv = usbi_transfer_get_os_priv(itransfer); |
+ struct windows_device_priv *priv = _device_priv(transfer->dev_handle->dev); |
+ |
+ return priv->usb_interface[transfer_priv->interface_number].apib-> |
+ abort_control(priv->usb_interface[transfer_priv->interface_number].sub_api, itransfer);} |
+ |
+static int composite_abort_transfers(int sub_api, struct usbi_transfer *itransfer) |
+{ |
+ struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
+ struct windows_transfer_priv *transfer_priv = usbi_transfer_get_os_priv(itransfer); |
+ struct windows_device_priv *priv = _device_priv(transfer->dev_handle->dev); |
+ |
+ return priv->usb_interface[transfer_priv->interface_number].apib-> |
+ abort_transfers(priv->usb_interface[transfer_priv->interface_number].sub_api, itransfer);} |
+ |
+static int composite_reset_device(int sub_api, struct libusb_device_handle *dev_handle) |
{ |
struct windows_device_priv *priv = _device_priv(dev_handle->dev); |
- unsigned api; |
int r; |
- uint8_t flag = 1<<USB_API_WINUSB; |
- |
- for (api=USB_API_WINUSB; api<USB_API_MAX; api++) { |
- if (priv->composite_api_flags & flag) { |
- r = usb_api_backend[api].reset_device(dev_handle); |
+ uint8_t i; |
+ bool available[SUB_API_MAX]; |
+ for (i = 0; i<SUB_API_MAX; i++) { |
+ available[i] = false; |
+ } |
+ for (i=0; i<USB_MAXINTERFACES; i++) { |
+ if ( (priv->usb_interface[i].apib->id == USB_API_WINUSBX) |
+ && (priv->usb_interface[i].sub_api != SUB_API_NOTSET) ) { |
+ available[priv->usb_interface[i].sub_api] = true; |
+ } |
+ } |
+ for (i=0; i<SUB_API_MAX; i++) { |
+ if (available[i]) { |
+ r = usb_api_backend[USB_API_WINUSBX].reset_device(i, dev_handle); |
if (r != LIBUSB_SUCCESS) { |
return r; |
} |
} |
- flag <<= 1; |
} |
return LIBUSB_SUCCESS; |
} |
-static int composite_copy_transfer_data(struct usbi_transfer *itransfer, uint32_t io_size) |
+static int composite_copy_transfer_data(int sub_api, struct usbi_transfer *itransfer, uint32_t io_size) |
{ |
struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer); |
struct windows_transfer_priv *transfer_priv = usbi_transfer_get_os_priv(itransfer); |
struct windows_device_priv *priv = _device_priv(transfer->dev_handle->dev); |
- return priv->usb_interface[transfer_priv->interface_number].apib->copy_transfer_data(itransfer, io_size); |
+ return priv->usb_interface[transfer_priv->interface_number].apib-> |
+ copy_transfer_data(priv->usb_interface[transfer_priv->interface_number].sub_api, itransfer, io_size); |
} |