Libusbk Bluetooth

Module for USB device discovery and enumeration. More...

1. Libusbk Usb Devices Bluetooth
2. Libusbk Bluetooth Windows 10

What does the part 'already using libusbk, installation aborted.' I'm using Windows 10 and connected a DS3 controller by USB. Also trying to use it. (, 04:57 PM) mstreurman Wrote: As soon as you install libusbk (this is the dummy driver) as the driver with Zadig to your Bluetooth adapter and put Dolphin into Passthrough mode it should pick it up correctly. Unless you are using the ASUS BT-400, I still haven't gotten Windows/Dolphin to detect it as a Passthrough device.

Detailed Description

Module for USB device discovery and enumeration.

Typedef Documentation

Device list enumeration function callback typedef.

Use this typedef as a prototype for an enumeration function with LstK_Enumerate.

Enumeration Type Documentation

Device list sync flags.

These sync flags are also use by the hot plug module to indicate device arrival/removal notifications:

• DeviceArrival = KLST_SYNC_FLAG_ADDED
• DeviceRemoval = KLST_SYNC_FLAG_REMOVED

Device list initialization flags.

Function Documentation

Initializes a new usb device list containing all supported devices.

Returns:

On success, TRUE. Otherwise FALSE. Use GetLastError() to get extended error information.

LstK_Init populates DeviceList with connected usb devices that can be used by libusbK.

Note:

if LstK_Init returns TRUE, the device list must be freed with LstK_Free when it is no longer needed.

Examples:

show-device.c.

Initializes a new usb device list containing only devices matching a specific class GUID.

Returns:

On success, TRUE. Otherwise FALSE. Use GetLastError() to get extended error information.

LstK_InitEx populates DeviceList with usb devices that can be used by libusbK. Only device matching the KLST_PATTERN_MATCH string are included in the list.

Note:

This function significantly improves performance when used with a device interface guid pattern patch.

if LstK_InitEx returns TRUE, the device list must be freed with LstK_Free when it it's no longer needed.

Frees a usb device list.

Note:

if LstK_Init returns TRUE, the device list must be freed with LstK_Free when it is no longer needed.

Returns:

NONE

Frees all resources that were allocated to DeviceList by LstK_Init.

Examples:

config-interface.c, load-driver-api.c, open-device.c, pipe-policy-other.c, pipe-policy-timeout.c, power-policy-suspend.c, show-device.c, xfer-async-loop.c, xfer-async.c, xfer-control.c, xfer-iso-read.c, xfer-iso.c, xfer-stream.c, and xfer-sync.c.

Enumerates KLST_DEVINFO elements of a KLST_HANDLE.

Returns:

On success, TRUE. Otherwise FALSE. Use GetLastError() to get extended error information.

Calls EnumDevListCB for each element in the device list or until EnumDevListCB returns FALSE.

Examples:

show-device.c.

Gets the KLST_DEVINFO element for the current position.

Returns:

On success, TRUE. Otherwise FALSE. Use GetLastError() to get extended error information.

After a DeviceList is created or after the LstK_MoveReset method is called, the LstK_MoveNext method must be called to advance the device list enumerator to the first element of the DeviceList before calling LstK_Current otherwise, DeviceInfo is undefined.

LstK_Current returns FALSE and sets last error to ERROR_NO_MORE_ITEMS if the last call to LstK_MoveNext returned FALSE, which indicates the end of the DeviceList.

LstK_Current does not move the position of the device list enumerator, and consecutive calls to LstK_Current return the same object until either LstK_MoveNext or LstK_MoveReset is called.

Advances the device list current KLST_DEVINFO position.

Returns:

On success, TRUE. Otherwise FALSE. Use GetLastError() to get extended error information.

Libusbk Usb Devices Bluetooth

After a DeviceList is created or after LstK_MoveReset is called, an enumerator is positioned before the first element of the DeviceList and the first call to LstK_MoveNext moves the enumerator over the first element of the DeviceList.

If LstK_MoveNext passes the end of the DeviceList, the enumerator is positioned after the last element in the DeviceList and LstK_MoveNext returns FALSE. When the enumerator is at this position, a subsequent call to LstK_MoveNext will reset the enumerator and it continues from the beginning.

Examples:

show-device.c.

Sets the device list to its initial position, which is before the first element in the list.

Returns:

On success, TRUE. Otherwise FALSE. Use GetLastError() to get extended error information.

Examples:

show-device.c.

Libusbk Bluetooth Windows 10

Find a device by vendor and product id.

• TRUE if the device was found
• FALSE if the device was not found or an error occurred.
  • Sets last error to ERROR_NO_MORE_ITEMS if the device was not found.

Searches all elements in DeviceList for usb device matching the specified.

Examples:

show-device.c.

Counts the number of device info elements in a device list.

Returns:

On success, TRUE. Otherwise FALSE. Use GetLastError() to get extended error information.

Examples:

show-device.c.

These sync flags are also use by the hot plug module to indicate device arrival/removal notifications:

• DeviceArrival = KLST_SYNC_FLAG_ADDED
• DeviceRemoval = KLST_SYNC_FLAG_REMOVED

Device list initialization flags.

Function Documentation

Initializes a new usb device list containing all supported devices.

Returns:

On success, TRUE. Otherwise FALSE. Use GetLastError() to get extended error information.

LstK_Init populates DeviceList with connected usb devices that can be used by libusbK.

Note:

if LstK_Init returns TRUE, the device list must be freed with LstK_Free when it is no longer needed.

Examples:

show-device.c.

Initializes a new usb device list containing only devices matching a specific class GUID.

Returns:

On success, TRUE. Otherwise FALSE. Use GetLastError() to get extended error information.

LstK_InitEx populates DeviceList with usb devices that can be used by libusbK. Only device matching the KLST_PATTERN_MATCH string are included in the list.

Note:

This function significantly improves performance when used with a device interface guid pattern patch.

if LstK_InitEx returns TRUE, the device list must be freed with LstK_Free when it it's no longer needed.

Frees a usb device list.

Note:

if LstK_Init returns TRUE, the device list must be freed with LstK_Free when it is no longer needed.

Returns:

NONE

Frees all resources that were allocated to DeviceList by LstK_Init.

Examples:

config-interface.c, load-driver-api.c, open-device.c, pipe-policy-other.c, pipe-policy-timeout.c, power-policy-suspend.c, show-device.c, xfer-async-loop.c, xfer-async.c, xfer-control.c, xfer-iso-read.c, xfer-iso.c, xfer-stream.c, and xfer-sync.c.

Enumerates KLST_DEVINFO elements of a KLST_HANDLE.

Returns:

On success, TRUE. Otherwise FALSE. Use GetLastError() to get extended error information.

Calls EnumDevListCB for each element in the device list or until EnumDevListCB returns FALSE.

Examples:

show-device.c.

Gets the KLST_DEVINFO element for the current position.

Returns:

On success, TRUE. Otherwise FALSE. Use GetLastError() to get extended error information.

After a DeviceList is created or after the LstK_MoveReset method is called, the LstK_MoveNext method must be called to advance the device list enumerator to the first element of the DeviceList before calling LstK_Current otherwise, DeviceInfo is undefined.

LstK_Current returns FALSE and sets last error to ERROR_NO_MORE_ITEMS if the last call to LstK_MoveNext returned FALSE, which indicates the end of the DeviceList.

LstK_Current does not move the position of the device list enumerator, and consecutive calls to LstK_Current return the same object until either LstK_MoveNext or LstK_MoveReset is called.

Advances the device list current KLST_DEVINFO position.

Returns:

On success, TRUE. Otherwise FALSE. Use GetLastError() to get extended error information.

Libusbk Usb Devices Bluetooth

After a DeviceList is created or after LstK_MoveReset is called, an enumerator is positioned before the first element of the DeviceList and the first call to LstK_MoveNext moves the enumerator over the first element of the DeviceList.

If LstK_MoveNext passes the end of the DeviceList, the enumerator is positioned after the last element in the DeviceList and LstK_MoveNext returns FALSE. When the enumerator is at this position, a subsequent call to LstK_MoveNext will reset the enumerator and it continues from the beginning.

Examples:

show-device.c.

Sets the device list to its initial position, which is before the first element in the list.

Returns:

On success, TRUE. Otherwise FALSE. Use GetLastError() to get extended error information.

Examples:

show-device.c.

Libusbk Bluetooth Windows 10

Find a device by vendor and product id.

• TRUE if the device was found
• FALSE if the device was not found or an error occurred.
  • Sets last error to ERROR_NO_MORE_ITEMS if the device was not found.

Searches all elements in DeviceList for usb device matching the specified.

Examples:

show-device.c.

Counts the number of device info elements in a device list.

Returns:

On success, TRUE. Otherwise FALSE. Use GetLastError() to get extended error information.

Examples:

show-device.c.

In this topic, you will learn about how a WinUSB device is recognized in Windows 8.

The information in this topic applies to you if you are an OEM or independent hardware vendor (IHV) developing a device for which you want to use Winusb.sys as the function driver and want to load the driver automatically without having to provide a custom INF.

• WinUSB Device
  • WinUSB device installation by using the in-box Winusb.inf

What is a WinUSB device

A WinUSB device is a Universal Serial Bus (USB) device whose firmware defines certain Microsoft operating system (OS) feature descriptors that report the compatible ID as 'WINUSB'.

The purpose of a WinUSB device is to enable Windows to load Winusb.sys as the device's function driver without a custom INF file. For a WinUSB device, you are not required to distribute INF files for your device, making the driver installation process simple for end users. Conversely, if you need to provide a custom INF, you should not define your device as a WinUSB device and specify the hardware ID of the device in the INF.

Microsoft provides Winusb.inf that contains information required by to install Winusb.sys as the device driver for a USB device.

Before Windows 8, to load Winusb.sys as the function driver, you needed to provide a custom INF. The custom INF specifies the device-specific hardware ID and also includes sections from the in-box Winusb.inf. Those sections are required for instantiating the service, copying inbox binaries, and registering a device interface GUID that applications required to find the device and talk to it. For information about writing a custom INF, see WinUSB (Winusb.sys) Installation.

In Windows 8, the in-box Winusb.inf file has been updated to enable Windows to automatically match the INF with a WinUSB device.

WinUSB device installation by using the in-box Winusb.inf

In Windows 8, the in-box Winusb.inf file has been updated. The INF includes an install section that references a compatible ID called 'USBMS_COMP_WINUSB'.

The updated INF also includes a new setup class called 'USBDevice'.

The 'USBDevice' setup class is available for those devices for which Microsoft does not provide an in-box driver. Typically, such devices do not belong to well-defined USB classes such as Audio, Bluetooth, and so on, and require a custom driver. If your device is a WinUSB device, most likely, the device does not belong to a USB class. Therefore, your device must be installed under 'USBDevice' setup class. The updated Winusb.inf facilitates that requirement.

About using the USBDevice class:

Do not use the 'USB' setup class for unclassified devices. That class is reserved for installing controllers, hubs, and composite devices. Misusing the 'USB' class can lead to significant reliability and performance issues. For unclassified devices, use 'USBDevice'.

In Windows 8, to use 'USBDevice' device class, simply add this to your INF:

In Device Manager you will see a new node USB Universal Serial Bus devices and your device appears under that node.

In Windows 7, in addition to the preceding lines, you need to create these registry settings in the INF:

In Device Manager, you will see your device appear under USB Universal Serial Bus devices. However, the device class description is derived from the registry setting specified in your INF.

-Eliyas Yakub, Microsoft Windows USB Core Team

Note that the 'USBDevice' class is not limited to WinUSB. If you have a custom driver for your device, you can use the 'USBDevice' setup class in the custom INF.

During device enumeration, the USB driver stack reads the compatible ID from the device. If the compatible ID is 'WINUSB', Windows uses it as the device identifier and finds a match in the updated in-box Winusb.inf, and then loads Winusb.sys as the device's function driver.

This image is for a single interface MUTT device that is defined as a WinUSB device and as a result Winusb.sys gets loaded as the function driver for the device.

For versions of Windows earlier than Windows 8, the updated Winusb.inf is available through Windows Update. If your computer is configured to get driver update automatically, WinUSB driver will get installed without any user intervention by using the new INF package.

How to change the device description for a WinUSB device

For a WinUSB device, Device Manager shows 'WinUsb Device' as the device description. That string is derived from Winusb.inf. If there are multiple WinUSB devices, all devices get the same device description.

To uniquely identify and differentiate the device in Device Manager, Windows 8 provides a new property on a device class that instructs the system to give precedence to the device description reported by the device (in its iProduct string descriptor) over the description in the INF. The 'USBDevice' class defined in Windows 8 sets this property. In other words, when a device is installed under 'USBDevice' class, system queries the device for a device description and sets the Device Manager string to whatever is retrieved in the query. In that case, the device description provided in the INF is ignored. Notice the device description strings: 'MUTT' in the preceding image. The string is provided by the USB device in its product string descriptor.

The new class property is not supported on earlier versions of Windows. To have a customized device description on an earlier version of Windows, you have to write your own custom INF.

How to configure a WinUSB device

To identify a USB device as a WinUSB device, the device firmware must have Microsoft OS Descriptors. For information about the descriptors, see the specifications described here: Microsoft OS Descriptors.

Supporting extended feature descriptors

In order for the USB driver stack to know that the device supports extended feature descriptors, the device must define an OS string descriptor that is stored at string index 0xEE. During enumeration, the driver stack queries for the string descriptor. If the descriptor is present, the driver stack assumes that the device contains one or more OS feature descriptors and the data that is required to retrieve those feature descriptors.

The retrieved string descriptor has a bMS_VendorCode field value. The value indicates the vendor code that the USB driver stack must use to retrieve the extended feature descriptor.

For information about how to define an OS string descriptor, see 'The OS String Descriptor' in the specifications described here: Microsoft OS Descriptors.

Setting the compatible ID

An extended compat ID OS feature descriptor that is required to match the in-box Winusb.inf and load the WinUSB driver module.

The extended compat ID OS feature descriptor includes a header section followed by one or more function sections depending on whether the device is a composite or non-composite device. The header section specifies the length of the entire descriptor, number of function sections, and version number. For a non-composite device, the header is followed by one function section associated with the device's only interface. The compatibleID field of that section must specify 'WINUSB' as the field value. For a composite device, there are multiple function sections. The compatibleID field of each function section must specify 'WINUSB'.

Registering a device interface GUID

An extended properties OS feature descriptor that is required to register its device interface GUID. The GUID is required to find the device from an application or service, configure the device, and perform I/O operations.

In previous versions of Windows, device interface GUID registration is done through the custom INF. Starting in Windows 8, your device should report the interface GUID by using extended properties OS feature descriptor.

The extended properties OS feature descriptor includes a header section that is followed by one or more custom property sections. The header section describes the entire extended properties descriptor, including its total length, the version number, and the number of custom property sections. To register the device interface GUID, add a custom property section that sets the bPropertyName field to 'DeviceInterfaceGUID' and wPropertyNameLength to 40 bytes. Generate a unique device interface GUID by using a GUID generator and set the bPropertyData field to that GUID, such as '{8FE6D4D7-49DD-41E7-9486-49AFC6BFE475}'. Note that the GUID is specified as a Unicode string and the length of the string is 78 bytes (including the null terminator).

During device enumeration, The USB driver stack then retrieves the DeviceInterfaceGUID value from the extended properties OS feature descriptor and registers the device in the device's hardware key. An application can retrieve the value by using SetupDiXxx APIs (See SetupDiOpenDevRegKey). For more information, see How to Access a USB Device by Using WinUSB Functions.

Enabling or disabling WinUSB power management features

Before Windows 8, to configure power management features of WinUSB, you had to write registry entry values in the HW.AddReg section of your custom INF.

In Windows 8, you can specify power settings in device. You can report values through the extended properties OS feature descriptor that enable or disable features in WinUSB for that device. There are two features that we can be configured: selective suspend and system wake. Selective suspend allows the device to enter low-power state when it is idle. System wake refers to the ability to a device to wake up a system when the system is in low-power state.

For information about power management features of WinUSB, see WinUSB Power Management.

For example, to enable selective suspend on the device, add a custom property section that sets the bPropertyName field to a Unicode string, 'DeviceIdleEnabled' and wPropertyNameLength to 36 bytes. Set the bPropertyData field to '0x00000001'. The property values are stored as little-endian 32-bit integers.

During enumeration, the USB driver stack reads the extended properties feature descriptors and creates registry entries under this key:

HKEY_LOCAL_MACHINESystemCurrentControlSetEnumUSBDevice Parameters

This image shows sample settings for a WinUSB device.

For additional examples, see the specifications on Microsoft OS Descriptors.

Related topics