wdfusb.h header
This header is used by wdf. For more information, see:
wdfusb.h contains the following programming interfaces:
Functions
| WDF_USB_CONTINUOUS_READER_CONFIG_INIT The WDF_USB_CONTINUOUS_READER_CONFIG_INIT function initializes a WDF_USB_CONTINUOUS_READER_CONFIG structure. |
| WDF_USB_CONTROL_SETUP_PACKET_INIT The WDF_USB_CONTROL_SETUP_PACKET_INIT function initializes a WDF_USB_CONTROL_SETUP_PACKET structure for a standard USB control transfer. |
| WDF_USB_CONTROL_SETUP_PACKET_INIT_CLASS The WDF_USB_CONTROL_SETUP_PACKET_INIT_CLASS function initializes a WDF_USB_CONTROL_SETUP_PACKET structure for a device class-specific USB control transfer. |
| WDF_USB_CONTROL_SETUP_PACKET_INIT_FEATURE The WDF_USB_CONTROL_SETUP_PACKET_INIT_FEATURE function initializes a WDF_USB_CONTROL_SETUP_PACKET structure for a USB control transfer that sets or clears a device feature. |
| WDF_USB_CONTROL_SETUP_PACKET_INIT_GET_STATUS The WDF_USB_CONTROL_SETUP_PACKET_INIT_GET_STATUS function initializes a WDF_USB_CONTROL_SETUP_PACKET structure for a USB control transfer that obtains device status. |
| WDF_USB_CONTROL_SETUP_PACKET_INIT_VENDOR The WDF_USB_CONTROL_SETUP_PACKET_INIT_VENDOR function initializes a WDF_USB_CONTROL_SETUP_PACKET structure for a vendor-specific USB control transfer. |
| WDF_USB_DEVICE_CREATE_CONFIG_INIT The WDF_USB_DEVICE_CREATE_CONFIG_INIT function initializes a WDF_USB_DEVICE_CREATE_CONFIG structure. |
| WDF_USB_DEVICE_INFORMATION_INIT The WDF_USB_DEVICE_INFORMATION_INIT function initializes a driver's WDF_USB_DEVICE_INFORMATION structure. |
| WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_DECONFIG The WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_DECONFIG function initializes a WDF_USB_DEVICE_SELECT_CONFIG_PARAMS structure so that a driver can deconfigure a USB device. |
| WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_INTERFACES_DESCRIPTORS The WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_INTERFACES_DESCRIPTORS function initializes a WDF_USB_DEVICE_SELECT_CONFIG_PARAMS structure so that a driver can specify a configuration by using USB descriptors. |
| WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_MULTIPLE_INTERFACES The WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_MULTIPLE_INTERFACES function initializes a WDF_USB_DEVICE_SELECT_CONFIG_PARAMS structure so that a driver can configure a device to use multiple interfaces. |
| WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_SINGLE_INTERFACE The WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_SINGLE_INTERFACE function initializes a WDF_USB_DEVICE_SELECT_CONFIG_PARAMS structure so that a driver can configure a device to use a single, specified interface. |
| WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_URB The WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_URB function initializes a WDF_USB_DEVICE_SELECT_CONFIG_PARAMS structure so that a driver can specify a configuration by using a URB. |
| WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_DESCRIPTOR The WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_DESCRIPTOR function initializes a WDF_USB_INTERFACE_SELECT_SETTING_PARAMS structure so that a driver can select a USB interface by specifying an interface descriptor. |
| WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_SETTING The WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_SETTING function initializes a WDF_USB_INTERFACE_SELECT_SETTING_PARAMS structure so that a driver can select a USB interface by specifying a handle to an interface object and an alternate setting for the interface. |
| WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_URB The WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_URB function initializes a WDF_USB_INTERFACE_SELECT_SETTING_PARAMS structure so that a driver can select a USB interface by specifying a URB. |
| WDF_USB_PIPE_DIRECTION_IN The WDF_USB_PIPE_DIRECTION_IN function determines whether a specified USB endpoint is an input endpoint. |
| WDF_USB_PIPE_DIRECTION_OUT The WDF_USB_PIPE_DIRECTION_OUT function determines whether a specified USB endpoint is an output endpoint. |
| WDF_USB_PIPE_INFORMATION_INIT The WDF_USB_PIPE_INFORMATION_INIT function initializes a WDF_USB_PIPE_INFORMATION structure. |
| WdfUsbInterfaceGetConfiguredPipe The WdfUsbInterfaceGetConfiguredPipe method returns a handle to the framework pipe object that is associated with a specified USB device interface and pipe index. Optionally, the method also returns information about the pipe. |
| WdfUsbInterfaceGetConfiguredSettingIndex The WdfUsbInterfaceGetConfiguredSettingIndex method returns the alternate setting index that is currently selected for a specified USB device interface. |
| WdfUsbInterfaceGetDescriptor The WdfUsbInterfaceGetDescriptor method retrieves the USB interface descriptor that is associated with a specified alternate setting of a specified USB interface. |
| WdfUsbInterfaceGetEndpointInformation The WdfUsbInterfaceGetEndpointInformation method retrieves information about a specified USB device endpoint and its associated pipe. |
| WdfUsbInterfaceGetInterfaceNumber The WdfUsbInterfaceGetInterfaceNumber method returns the interface number of a specified USB interface object. |
| WdfUsbInterfaceGetNumConfiguredPipes The WdfUsbInterfaceGetNumConfiguredPipes method returns the number of pipes that are configured for a specified USB device interface. |
| WdfUsbInterfaceGetNumEndpoints The WdfUsbInterfaceGetNumEndpoints method returns the number of endpoints that are associated with a specified alternate setting of a specified USB interface. |
| WdfUsbInterfaceGetNumSettings The WdfUsbInterfaceGetNumSettings method returns the number of alternate settings that a specified USB interface supports. |
| WdfUsbInterfaceSelectSetting The WdfUsbInterfaceSelectSetting method selects a specified alternate setting for a specified USB interface. |
| WdfUsbTargetDeviceAllocAndQueryString The WdfUsbTargetDeviceAllocAndQueryString method allocates a buffer, then it retrieves the Unicode string that is associated with a specified USB device and descriptor index value. |
| WdfUsbTargetDeviceCreate The WdfUsbTargetDeviceCreate method creates a framework USB device object for a specified framework device object and opens the USB device for I/O operations. |
| WdfUsbTargetDeviceCreateIsochUrb The WdfUsbTargetDeviceCreateIsochUrb method allocates an isochronous USB request block (URB). |
| WdfUsbTargetDeviceCreateUrb The WdfUsbTargetDeviceCreateUrb method allocates a USB request block (URB). |
| WdfUsbTargetDeviceCreateWithParameters The WdfUsbTargetDeviceCreateWithParameters method creates a framework USB device object for a specified framework device object and opens the USB device for I/O operations. |
| WdfUsbTargetDeviceCyclePortSynchronously The WdfUsbTargetDeviceCyclePortSynchronously method power-cycles the USB port to which a specified device is attached. |
| WdfUsbTargetDeviceFormatRequestForControlTransfer The WdfUsbTargetDeviceFormatRequestForControlTransfer method builds a USB control transfer request, but it does not send the request. |
| WdfUsbTargetDeviceFormatRequestForCyclePort The WdfUsbTargetDeviceFormatRequestForCyclePort method builds a power-cycle request for the port to which a specified device is attached, but it does not send the request. |
| WdfUsbTargetDeviceFormatRequestForString The WdfUsbTargetDeviceFormatRequestForString method builds a request for the USB string descriptor that is associated with a USB device's string index value. |
| WdfUsbTargetDeviceFormatRequestForUrb The WdfUsbTargetDeviceFormatRequestForUrb method builds an USB request for a specified USB device, using request parameters that are described by a URB, but it does not send the request. |
| WdfUsbTargetDeviceGetDeviceDescriptor The WdfUsbTargetDeviceGetDeviceDescriptor method retrieves the USB device descriptor for the USB device that is associated with a specified framework USB device object. |
| WdfUsbTargetDeviceGetInterface The WdfUsbTargetDeviceGetInterface method returns a handle to the framework USB interface object that is associated with a specified interface index. |
| WdfUsbTargetDeviceGetIoTarget The WdfUsbTargetDeviceGetIoTarget method returns a handle to the I/O target object that is associated with a specified USB device. |
| WdfUsbTargetDeviceGetNumInterfaces The WdfUsbTargetDeviceGetNumInterfaces method returns the number of USB device interfaces that are supported by a specified USB device. |
| WdfUsbTargetDeviceIsConnectedSynchronous The WdfUsbTargetDeviceIsConnectedSynchronous method determines if the specified USB device is connected. |
| WdfUsbTargetDeviceQueryString The WdfUsbTargetDeviceQueryString method retrieves the Unicode string that is associated with a specified USB device and descriptor index value. |
| WdfUsbTargetDeviceQueryUsbCapability The WdfUsbTargetDeviceQueryUsbCapability method determines whether the host controller and USB driver stack support a specific capability. |
| WdfUsbTargetDeviceResetPortSynchronously The WdfUsbTargetDeviceResetPortSynchronously method resets the USB port that is associated with the specified USB device. |
| WdfUsbTargetDeviceRetrieveConfigDescriptor The WdfUsbTargetDeviceRetrieveConfigDescriptor method retrieves the USB configuration descriptor for the USB device that is associated with a specified framework USB device object. |
| WdfUsbTargetDeviceRetrieveCurrentFrameNumber The WdfUsbTargetDeviceRetrieveCurrentFrameNumber method retrieves the current USB frame number. |
| WdfUsbTargetDeviceRetrieveInformation The WdfUsbTargetDeviceRetrieveInformation method retrieves information about the USB device that is associated with a specified framework USB device object. |
| WdfUsbTargetDeviceSelectConfig The WdfUsbTargetDeviceSelectConfig method selects a USB configuration for a device, or it deconfigures the device. |
| WdfUsbTargetDeviceSendControlTransferSynchronously The WdfUsbTargetDeviceSendControlTransferSynchronously method builds a USB control transfer request and sends it synchronously to an I/O target. |
| WdfUsbTargetDeviceSendUrbSynchronously The WdfUsbTargetDeviceSendUrbSynchronously method sends a USB request synchronously to a specified USB device, using request parameters that are described by a URB. |
| WdfUsbTargetDeviceWdmGetConfigurationHandle The WdfUsbTargetDeviceWdmGetConfigurationHandle method returns the USBD_CONFIGURATION_HANDLE-typed handle that is associated with the current configuration of a specified USB device. |
| WdfUsbTargetPipeAbortSynchronously The WdfUsbTargetPipeAbortSynchronously method builds an abort request and sends it synchronously to a specified USB pipe. |
| WdfUsbTargetPipeConfigContinuousReader The WdfUsbTargetPipeConfigContinuousReader method configures the framework to continuously read from a specified USB pipe. |
| WdfUsbTargetPipeFormatRequestForAbort The WdfUsbTargetPipeFormatRequestForAbort method builds an abort request for a specified USB pipe, but it does not send the request. |
| WdfUsbTargetPipeFormatRequestForRead The WdfUsbTargetPipeFormatRequestForRead method builds a read request for a USB input pipe, but it does not send the request. |
| WdfUsbTargetPipeFormatRequestForReset The WdfUsbTargetPipeFormatRequestForReset method builds a reset request for a specified USB pipe, but it does not send the request. |
| WdfUsbTargetPipeFormatRequestForUrb The WdfUsbTargetPipeFormatRequestForUrb method builds an USB request for a specified USB pipe, using request parameters that a specified URB describes, but it does not send the request. |
| WdfUsbTargetPipeFormatRequestForWrite The WdfUsbTargetPipeFormatRequestForWrite method builds a write request for a USB output pipe, but it does not send the request. |
| WdfUsbTargetPipeGetInformation The WdfUsbTargetPipeGetInformation method retrieves information about a USB pipe and its endpoint. |
| WdfUsbTargetPipeGetIoTarget The WdfUsbTargetPipeGetIoTarget method returns a handle to the I/O target object that is associated with a specified USB pipe. |
| WdfUsbTargetPipeGetType The WdfUsbTargetPipeGetType method returns the type of a specified USB pipe. |
| WdfUsbTargetPipeIsInEndpoint The WdfUsbTargetPipeIsInEndpoint method determines whether a specified USB pipe is connected to an input endpoint. |
| WdfUsbTargetPipeIsOutEndpoint The WdfUsbTargetPipeIsOutEndpoint method determines whether a specified USB pipe is connected to an output endpoint. |
| WdfUsbTargetPipeReadSynchronously The WdfUsbTargetPipeReadSynchronously method builds a read request and sends it synchronously to a specified USB input pipe. |
| WdfUsbTargetPipeResetSynchronously The WdfUsbTargetPipeResetSynchronously method builds a reset request and sends it synchronously to a specified USB pipe. |
| WdfUsbTargetPipeSendUrbSynchronously The WdfUsbTargetPipeSendUrbSynchronously method builds an USB request for a specified USB pipe, using request parameters that a specified URB describes. |
| WdfUsbTargetPipeSetNoMaximumPacketSizeCheck The WdfUsbTargetPipeSetNoMaximumPacketSizeCheck method disables the framework's test of whether the size of a driver's read buffer is a multiple of a USB pipe's maximum packet size. |
| WdfUsbTargetPipeWdmGetPipeHandle The WdfUsbTargetPipeWdmGetPipeHandle method returns the USBD_PIPE_HANDLE-typed handle that is associated with a specified framework pipe object. |
| WdfUsbTargetPipeWriteSynchronously The WdfUsbTargetPipeWriteSynchronously method builds a write request and sends it synchronously to a specified USB output pipe. |
Callback functions
| EVT_WDF_USB_READER_COMPLETION_ROUTINE A driver's EvtUsbTargetPipeReadComplete event callback function informs the driver that a continuous reader has successfully completed a read request. |
| EVT_WDF_USB_READERS_FAILED A driver's EvtUsbTargetPipeReadersFailed event callback function informs the driver that a continuous reader has reported an error while processing a read request. |
Structures
| WDF_USB_CONTINUOUS_READER_CONFIG The WDF_USB_CONTINUOUS_READER_CONFIG structure contains information that the framework uses to configure a continuous reader for a USB pipe. |
| WDF_USB_CONTROL_SETUP_PACKET The WDF_USB_CONTROL_SETUP_PACKET structure describes a setup packet for a USB control transfer. |
| WDF_USB_DEVICE_CREATE_CONFIG The WDF_USB_DEVICE_CREATE_CONFIG structure contains information that the framework uses to configure a framework USB device object. |
| WDF_USB_DEVICE_INFORMATION The WDF_USB_DEVICE_INFORMATION structure contains version and capability information for a USB device. |
| WDF_USB_DEVICE_SELECT_CONFIG_PARAMS The WDF_USB_DEVICE_SELECT_CONFIG_PARAMS structure specifies USB device configuration parameters. |
| WDF_USB_INTERFACE_SELECT_SETTING_PARAMS The WDF_USB_INTERFACE_SELECT_SETTING_PARAMS structure contains selection information for a USB interface. |
| WDF_USB_INTERFACE_SETTING_PAIR The WDF_USB_INTERFACE_SETTING_PAIR structure specifies an alternate setting for a specified USB interface. |
| WDF_USB_PIPE_INFORMATION The WDF_USB_PIPE_INFORMATION structure contains information about a USB pipe and its endpoint. |
| WDF_USB_REQUEST_COMPLETION_PARAMS The WDF_USB_REQUEST_COMPLETION_PARAMS structure contains parameters that are associated with the completion of an I/O request for a USB device. |
Enumerations
| WDF_USB_BMREQUEST_DIRECTION The WDF_USB_BMREQUEST_DIRECTION enumeration identifies the data transfer direction for a USB control transfer. |
| WDF_USB_BMREQUEST_RECIPIENT The WDF_USB_BMREQUEST_RECIPIENT enumeration identifies the data transfer recipient for a USB control transfer. |
| WDF_USB_BMREQUEST_TYPE The WDF_USB_BMREQUEST_TYPE enumeration identifies the data transfer type for a USB control transfer. |
| WDF_USB_DEVICE_TRAITS The WDF_USB_DEVICE_TRAITS enumeration identifies USB device traits. |
| WDF_USB_PIPE_TYPE The WDF_USB_PIPE_TYPE enumeration identifies the types of USB pipes. |
| WDF_USB_REQUEST_TYPE The WDF_USB_REQUEST_TYPE enumeration identifies the types of USB requests that a framework-based driver can send to a USB I/O target. |
| WdfUsbTargetDeviceSelectConfigType The WdfUsbTargetDeviceSelectConfigType enumeration defines types of configuration operations for USB devices. |
| WdfUsbTargetDeviceSelectSettingType The WdfUsbTargetDeviceSelectSettingType enumeration defines techniques for specifying an alternate setting for a USB interface. |
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