udecxusbdevice.h header
This header is used by usbref. For more information, see:
udecxusbdevice.h contains the following programming interfaces:
Functions
| UDECX_USB_DEVICE_CALLBACKS_INIT Initializes a UDECX_USB_DEVICE_STATE_CHANGE_CALLBACKS structure before a UdecxUsbDeviceCreate call. |
| UDECX_USB_DEVICE_PLUG_IN_OPTIONS_INIT Initializes a UDECX_USB_DEVICE_PLUG_IN_OPTIONS structure. |
| UdecxUsbDeviceCreate Creates a USB Device Emulation (UDE) device object. |
| UdecxUsbDeviceInitAddDescriptor Adds a USB descriptor to the initialization parameters used to create a virtual USB device. |
| UdecxUsbDeviceInitAddDescriptorWithIndex Learn how the UdecxUsbDeviceInitAddDescriptorWithIndex function adds a USB descriptor to the initialization parameters used to create a virtual USB device. |
| UdecxUsbDeviceInitAddStringDescriptor Adds a USB string descriptor to the initialization parameters used to create a virtual USB device. |
| UdecxUsbDeviceInitAddStringDescriptorRaw Learn how this method adds a USB string descriptor to the initialization parameters used to create a virtual USB device. |
| UdecxUsbDeviceInitAllocate Allocates memory for a UDECXUSBDEVICE_INIT structure that is used to initialize a virtual USB device. |
| UdecxUsbDeviceInitFree Releases the resources that were allocated by the UdecxUsbDeviceInitAllocate call. |
| UdecxUsbDeviceInitSetEndpointsType Indicates the type of endpoint (simple or dynamic) in the initialization parameters that the client driver uses to create the virtual USB device. |
| UdecxUsbDeviceInitSetSpeed Sets the USB speed of the virtual USB device to create. |
| UdecxUsbDeviceInitSetStateChangeCallbacks Initializes a WDF-allocated structure with pointers to callback functions. |
| UdecxUsbDeviceLinkPowerEntryComplete Completes an asynchronous request for bringing the device out of a low power state. |
| UdecxUsbDeviceLinkPowerExitComplete Completes an asynchronous request for sending the device to a low power state. |
| UdecxUsbDevicePlugIn Notifies the USB device emulation class extension (UdeCx) that the USB device has been plugged in the specified port. |
| UdecxUsbDevicePlugOutAndDelete Disconnects the virtual USB device. |
| UdecxUsbDeviceSetFunctionSuspendAndWakeComplete Completes an asynchronous request for changing the power state of a particular function of a virtual USB 3.0 device. |
| UdecxUsbDeviceSignalFunctionWake Initiates wake up of the specified function from a low power state. This applies to virtual USB 3.0 devices. |
| UdecxUsbDeviceSignalWake Initiates wake up from a low link power state for a virtual USB 2.0 device. |
Callback functions
| EVT_UDECX_USB_DEVICE_D0_ENTRY The USB device emulation class extension (UdeCx) invokes this callback function when it gets a request to bring the virtual USB device out of a low power state to working state. |
| EVT_UDECX_USB_DEVICE_D0_EXIT The USB device emulation class extension (UdeCx) invokes this callback function when it gets a request to send the virtual USB device to a low power state. |
| EVT_UDECX_USB_DEVICE_DEFAULT_ENDPOINT_ADD The USB device emulation class extension (UdeCx) invokes this callback function to request the client driver to create the default control endpoint on the virtual USB device. |
| EVT_UDECX_USB_DEVICE_ENDPOINT_ADD The USB device emulation class extension (UdeCx) invokes this callback function to request the client driver to create a dynamic endpoint on the virtual USB device. |
| EVT_UDECX_USB_DEVICE_ENDPOINTS_CONFIGURE The USB device emulation class extension (UdeCx) invokes this callback function to change the configuration by selecting an alternate setting, disabling current endpoints, or adding dynamic endpoints. |
| EVT_UDECX_USB_DEVICE_SET_FUNCTION_SUSPEND_AND_WAKE The USB device emulation class extension (UdeCx) invokes this callback function when it gets a request to change the function state of the specified interface of the virtual USB 3.0 device. |
Structures
| UDECX_ENDPOINTS_CONFIGURE_PARAMS Contains the configuration options specified by USB device emulation class extension (UdeCx) to the client driver when the class extension invokes EVT_UDECX_USB_DEVICE_ENDPOINTS_CONFIGURE. |
| UDECX_USB_DEVICE_PLUG_IN_OPTIONS Contains the port numbers to which a virtual USB device is connected. Initialize this structure by calling the UDECX_USB_DEVICE_PLUG_IN_OPTIONS_INIT method. |
| UDECX_USB_DEVICE_STATE_CHANGE_CALLBACKS Initializes a UDECX_USB_DEVICE_STATE_CHANGE_CALLBACKS structure with pointers to callback functions that are implemented by a UDE client for a virtual USB device. |
| UDECX_USB_ENDPOINT_INIT_AND_METADATA Contains the descriptors supported by an endpoint of a virtual USB device. |
Enumerations
| UDECX_ENDPOINT_TYPE Defines values for endpoint types supported by a virtual USB device. |
| UDECX_ENDPOINTS_CONFIGURE_TYPE Defines values for endpoint configuration options. |
| UDECX_USB_DEVICE_FUNCTION_POWER Defines values for function wake capability of a virtual USB 3.0 device. |
| UDECX_USB_DEVICE_SPEED Defines values for USB device speeds. |
| UDECX_USB_DEVICE_WAKE_SETTING Defines values for remote wake capability of a virtual USB device. |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for