Configuring Usbccgp.sys to select a non-default USB configuration
This article provides information about registry settings that configure the way Usbccgp.sys selects a USB configuration. The topic also describes how Usbccgp.sys handles select-configuration requests sent by a client driver that controls one of functions of a composite device.
A USB composite device consists of multiple functions (functional devices) within a single USB device. If Windows loads Microsoft-provided USB Generic Parent Driver (Usbccgp.sys) for a composite device, from that point forward, Usbccgp.sys is responsible for selecting the configuration of the device. Each interface or interface collection of a composite device is, in many respects, like a separate device that has its own physical device object (PDO). Resetting the configuration of the device changes the configuration for all of the device's interfaces, not just the one that the client driver controls. The operating system does not allow this. Therefore, a client driver that controls a set of interfaces or an interface collection of the composite device cannot change the configuration that is initially set by Usbccgp.sys.
However, in Windows Vista and later versions of Windows, you can add the following registry values to specify the configuration to select:
| Registry Key | Type | Value | Default Value |
|---|---|---|---|
| OriginalConfigurationValue | REG_DWORD | USB configuration index. Usbccgp.sys uses OriginalConfigurationValue first for a select-configuration request. | 0 |
| AltConfigurationValue | REG_DWORD | The configuration index to use if the select-configuration request with OriginalConfigurationValue fails. | 0 |
Note
The preceding registry settings are not present, by default. They must be added under the hardware (aka "device") key of the USB device.
The registry setting allows the CCGP driver to select an alternate configuration.
Registry values described in the preceding table correspond to the USB-defined configuration index, indicated by the bConfigurationValue member of the configuration descriptor (USB_CONFIGURATION_DESCRIPTOR) and not by the bConfigurationNum values reported in the device's configuration descriptor. First, Usbccgp.sys sends a select-configuration request to the parent USB bus driver (Usbhub.sys) by using the USB configuration index specified by OriginalConfigurationValue. If that request fails, Usbccgp.sys attempts to use the value specified in AlternateConfigurationValue. Usbccgp.sys uses default values if AlternateConfigurationValue or OriginalConfigurationValue are invalid.
A select-configuration request can fail for many reasons. The most common failure occurs when the device does not respond properly to the request or when the bMaxPower value (power required by the requested configuration) exceeds the power value supported by the hub port. For example, bMaxPower for a particular configuration (specified by OriginalConfigurationValue) is 100 milliamperes but the hub port is only able to provide 50 milliamperes. When Usbccgp.sys sends a select-configuration request for that configuration, the USB driver stack (specifically, the USB port driver) fails the request. Usbccgp.sys then sends another select-configuration request by specifying the configuration indicated by AltConfigurationValue. If the alternate configuration requires 50 milliamperes or less and no other problems occur, the select-configuration request completes successfully.
Compatibility feature
Even though a client driver for a function in the composite device is not able to select the configuration of a composite device, the client driver can still send a select-configuration request to Usbccgp.sys. For information about how to build that request, see How to Select a Configuration for a USB Device. Usbccgp.sys performs the following tasks after receiving a select-configuration request from a client driver:
- Validates the received request by using the same criteria used by the USB port driver to validate any select-configuration requests.
- If the request specifies interface or pipe settings that are different from the current settings, Usbccgp.sys issues a select-interface request by sending an URB of the type URB_FUNCTION_SELECT_INTERFACE to change the existing settings to the new interface and pipe settings.
- Copies the cached contents of the USBD_INTERFACE_INFORMATION and USBD_PIPE_INFORMATION structures into the URB.
- Completes the URB.