wdfusb.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
union	_WDF_USB_CONTROL_SETUP_PACKET
struct	_WDF_USB_REQUEST_COMPLETION_PARAMS
struct	_WDF_USB_CONTINUOUS_READER_CONFIG
struct	_WDF_USB_DEVICE_INFORMATION
struct	_WDF_USB_INTERFACE_SETTING_PAIR
struct	_WDF_USB_DEVICE_SELECT_CONFIG_PARAMS
struct	_WDF_USB_INTERFACE_SELECT_SETTING_PARAMS
struct	_WDF_USB_PIPE_INFORMATION
struct	_WDF_USB_DEVICE_CREATE_CONFIG

Macros
#define	WDF_EXTERN_C
#define	WDF_EXTERN_C_START
#define	WDF_EXTERN_C_END
#define	BMREQUEST_HOST_TO_DEVICE   0
#define	BMREQUEST_DEVICE_TO_HOST   1
#define	BMREQUEST_STANDARD   0
#define	BMREQUEST_CLASS   1
#define	BMREQUEST_VENDOR   2
#define	BMREQUEST_TO_DEVICE   0
#define	BMREQUEST_TO_INTERFACE   1
#define	BMREQUEST_TO_ENDPOINT   2
#define	BMREQUEST_TO_OTHER   3

Typedefs
typedef enum _WDF_USB_REQUEST_TYPE	WDF_USB_REQUEST_TYPE
typedef enum _WDF_USB_REQUEST_TYPE *	PWDF_USB_REQUEST_TYPE
typedef enum _WDF_USB_BMREQUEST_DIRECTION	WDF_USB_BMREQUEST_DIRECTION
typedef enum _WDF_USB_BMREQUEST_TYPE	WDF_USB_BMREQUEST_TYPE
typedef enum _WDF_USB_BMREQUEST_RECIPIENT	WDF_USB_BMREQUEST_RECIPIENT
typedef enum _WDF_USB_PIPE_TYPE	WDF_USB_PIPE_TYPE
typedef enum _WdfUsbTargetDeviceSelectConfigType	WdfUsbTargetDeviceSelectConfigType
typedef enum _WdfUsbTargetDeviceSelectSettingType	WdfUsbTargetDeviceSelectSettingType
typedef enum _WDF_USB_DEVICE_TRAITS	WDF_USB_DEVICE_TRAITS
typedef union _WDF_USB_CONTROL_SETUP_PACKET	WDF_USB_CONTROL_SETUP_PACKET
typedef union _WDF_USB_CONTROL_SETUP_PACKET *	PWDF_USB_CONTROL_SETUP_PACKET
typedef struct _WDF_USB_REQUEST_COMPLETION_PARAMS	WDF_USB_REQUEST_COMPLETION_PARAMS
typedef struct _WDF_USB_REQUEST_COMPLETION_PARAMS *	PWDF_USB_REQUEST_COMPLETION_PARAMS
typedef _In_ WDFMEMORY	Buffer
typedef _In_ WDFMEMORY _In_ size_t	NumBytesTransferred
typedef _In_ WDFMEMORY _In_ size_t _In_ WDFCONTEXT	Context
typedef EVT_WDF_USB_READER_COMPLETION_ROUTINE *	PFN_WDF_USB_READER_COMPLETION_ROUTINE
typedef _In_ NTSTATUS	Status
typedef _In_ NTSTATUS _In_ USBD_STATUS	UsbdStatus
typedef EVT_WDF_USB_READERS_FAILED *	PFN_WDF_USB_READERS_FAILED
typedef struct _WDF_USB_CONTINUOUS_READER_CONFIG	WDF_USB_CONTINUOUS_READER_CONFIG
typedef struct _WDF_USB_CONTINUOUS_READER_CONFIG *	PWDF_USB_CONTINUOUS_READER_CONFIG
typedef struct _WDF_USB_DEVICE_INFORMATION	WDF_USB_DEVICE_INFORMATION
typedef struct _WDF_USB_DEVICE_INFORMATION *	PWDF_USB_DEVICE_INFORMATION
typedef struct _WDF_USB_INTERFACE_SETTING_PAIR	WDF_USB_INTERFACE_SETTING_PAIR
typedef struct _WDF_USB_INTERFACE_SETTING_PAIR *	PWDF_USB_INTERFACE_SETTING_PAIR
typedef struct _WDF_USB_DEVICE_SELECT_CONFIG_PARAMS	WDF_USB_DEVICE_SELECT_CONFIG_PARAMS
typedef struct _WDF_USB_DEVICE_SELECT_CONFIG_PARAMS *	PWDF_USB_DEVICE_SELECT_CONFIG_PARAMS
typedef struct _WDF_USB_INTERFACE_SELECT_SETTING_PARAMS	WDF_USB_INTERFACE_SELECT_SETTING_PARAMS
typedef struct _WDF_USB_INTERFACE_SELECT_SETTING_PARAMS *	PWDF_USB_INTERFACE_SELECT_SETTING_PARAMS
typedef struct _WDF_USB_PIPE_INFORMATION	WDF_USB_PIPE_INFORMATION
typedef struct _WDF_USB_PIPE_INFORMATION *	PWDF_USB_PIPE_INFORMATION
typedef struct _WDF_USB_DEVICE_CREATE_CONFIG	WDF_USB_DEVICE_CREATE_CONFIG
typedef struct _WDF_USB_DEVICE_CREATE_CONFIG *	PWDF_USB_DEVICE_CREATE_CONFIG
typedef _Must_inspect_result_	_IRQL_requires_max_(PASSIVE_LEVEL) WDFAPI NTSTATUS(STDCALL *PFN_WDFUSBTARGETDEVICECREATE) (_In_ PWDF_DRIVER_GLOBALS DriverGlobals
typedef _Must_inspect_result_ _In_ WDFDEVICE	Device
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_opt_ PWDF_OBJECT_ATTRIBUTES	Attributes
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFUSBDEVICE *	UsbDevice
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_USB_DEVICE_CREATE_CONFIG	Config
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _Out_ PWDF_USB_DEVICE_INFORMATION	Information
typedef _In_ WDFUSBDEVICE _Out_ PUSB_DEVICE_DESCRIPTOR	UsbDeviceDescriptor
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _Out_writes_bytes_to_opt_ ConfigDescriptorLength PVOID	ConfigDescriptor
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _Out_writes_bytes_to_opt_ ConfigDescriptorLength PVOID _Inout_ PUSHORT	ConfigDescriptorLength
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ WDFREQUEST	Request
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS	RequestOptions
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS _Out_writes_opt_ NumCharacters PUSHORT	String
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS _Out_writes_opt_ NumCharacters PUSHORT _Inout_ PUSHORT	NumCharacters
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS _Out_writes_opt_ NumCharacters PUSHORT _Inout_ PUSHORT _In_ UCHAR	StringIndex
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS _Out_writes_opt_ NumCharacters PUSHORT _Inout_ PUSHORT _In_ UCHAR _In_opt_ USHORT	LangID
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ PWDF_OBJECT_ATTRIBUTES	StringMemoryAttributes
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFMEMORY *	StringMemory = NULL
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_ WDFREQUEST _In_ WDFMEMORY	Memory
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_ WDFREQUEST _In_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET	Offset
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ PWDF_OBJECT_ATTRIBUTES	PipeAttributes
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ PWDF_OBJECT_ATTRIBUTES _Inout_ PWDF_USB_DEVICE_SELECT_CONFIG_PARAMS	Params
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _Out_ PULONG	CurrentFrameNumber
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS _In_ PWDF_USB_CONTROL_SETUP_PACKET	SetupPacket
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS _In_ PWDF_USB_CONTROL_SETUP_PACKET _In_opt_ PWDF_MEMORY_DESCRIPTOR	MemoryDescriptor
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS _In_ PWDF_USB_CONTROL_SETUP_PACKET _In_opt_ PWDF_MEMORY_DESCRIPTOR _Out_opt_ PULONG	BytesTransferred
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_ WDFREQUEST _In_ PWDF_USB_CONTROL_SETUP_PACKET _In_opt_ WDFMEMORY	TransferMemory
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_ WDFREQUEST _In_ PWDF_USB_CONTROL_SETUP_PACKET _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET	TransferOffset
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS	_In_reads_(_Inexpressible_("union bug in SAL")) PURB Urb)
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_ WDFREQUEST _In_ WDFMEMORY	UrbMemory
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_ WDFREQUEST _In_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET	UrbMemoryOffset
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_ CONST GUID *	CapabilityType
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_ CONST GUID _In_ ULONG	CapabilityBufferLength
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_ CONST GUID _In_ ULONG	_When_(CapabilityBufferLength==0, _Out_opt_) _When_(CapabilityBufferLength !=0 &&ResultLength == NULL
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_ CONST GUID _In_ ULONG	_Out_writes_bytes_(CapabilityBufferLength)) _When_(CapabilityBufferLength !=0 &&ResultLength ! = NULL
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_ CONST GUID _In_ ULONG	_Out_writes_bytes_to_opt_(CapabilityBufferLength, *ResultLength)) PVOID CapabilityBuffer
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFMEMORY	_Outptr_opt_result_bytebuffer_(sizeof(URB)) PURB *Urb)
typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ ULONG	NumberOfIsochPackets
typedef _In_ WDFUSBPIPE	Pipe
typedef _In_ WDFUSBPIPE _Out_ PWDF_USB_PIPE_INFORMATION	PipeInformation
typedef _Must_inspect_result_ _In_ WDFUSBPIPE _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS _In_opt_ PWDF_MEMORY_DESCRIPTOR _Out_opt_ PULONG	BytesWritten
typedef _Must_inspect_result_ _In_ WDFUSBPIPE _In_ WDFREQUEST _In_opt_ WDFMEMORY	WriteMemory
typedef _Must_inspect_result_ _In_ WDFUSBPIPE _In_ WDFREQUEST _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET	WriteOffset
typedef _Must_inspect_result_ _In_ WDFUSBPIPE _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS _In_opt_ PWDF_MEMORY_DESCRIPTOR _Out_opt_ PULONG	BytesRead
typedef _Must_inspect_result_ _In_ WDFUSBPIPE _In_ WDFREQUEST _In_opt_ WDFMEMORY	ReadMemory
typedef _Must_inspect_result_ _In_ WDFUSBPIPE _In_ WDFREQUEST _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET	ReadOffset
typedef _Must_inspect_result_ _In_ WDFUSBPIPE	PIPE
typedef _In_ WDFUSBINTERFACE	UsbInterface
typedef _In_ WDFUSBINTERFACE _In_ UCHAR	SettingIndex
typedef _In_ WDFUSBINTERFACE _In_ UCHAR _Out_ PUSB_INTERFACE_DESCRIPTOR	InterfaceDescriptor
typedef _Must_inspect_result_ _In_ WDFUSBINTERFACE _In_opt_ PWDF_OBJECT_ATTRIBUTES	PipesAttributes
typedef _In_ WDFUSBINTERFACE _In_ UCHAR _In_ UCHAR	EndpointIndex
typedef _In_ WDFUSBINTERFACE _In_ UCHAR _In_ UCHAR _Out_ PWDF_USB_PIPE_INFORMATION	EndpointInfo
typedef _In_ WDFUSBDEVICE _In_ UCHAR	InterfaceIndex
typedef _In_ WDFUSBINTERFACE	Interface
typedef _In_ WDFUSBINTERFACE _In_ UCHAR	PipeIndex
typedef _In_ WDFUSBINTERFACE _In_ UCHAR _Out_opt_ PWDF_USB_PIPE_INFORMATION	PipeInfo
typedef _In_ WDFUSBPIPE	UsbPipe

Enumerations
enum	_WDF_USB_REQUEST_TYPE {   WdfUsbRequestTypeInvalid = 0 , WdfUsbRequestTypeNoFormat , WdfUsbRequestTypeDeviceString , WdfUsbRequestTypeDeviceControlTransfer ,   WdfUsbRequestTypeDeviceUrb , WdfUsbRequestTypePipeWrite , WdfUsbRequestTypePipeRead , WdfUsbRequestTypePipeAbort ,   WdfUsbRequestTypePipeReset , WdfUsbRequestTypePipeUrb }
enum	_WDF_USB_BMREQUEST_DIRECTION { BmRequestHostToDevice = BMREQUEST_HOST_TO_DEVICE , BmRequestDeviceToHost = BMREQUEST_DEVICE_TO_HOST }
enum	_WDF_USB_BMREQUEST_TYPE { BmRequestStandard = BMREQUEST_STANDARD , BmRequestClass = BMREQUEST_CLASS , BmRequestVendor = BMREQUEST_VENDOR }
enum	_WDF_USB_BMREQUEST_RECIPIENT { BmRequestToDevice = BMREQUEST_TO_DEVICE , BmRequestToInterface = BMREQUEST_TO_INTERFACE , BmRequestToEndpoint = BMREQUEST_TO_ENDPOINT , BmRequestToOther = BMREQUEST_TO_OTHER }
enum	_WDF_USB_PIPE_TYPE {   WdfUsbPipeTypeInvalid = 0 , WdfUsbPipeTypeControl , WdfUsbPipeTypeIsochronous , WdfUsbPipeTypeBulk ,   WdfUsbPipeTypeInterrupt }
enum	_WdfUsbTargetDeviceSelectConfigType {   WdfUsbTargetDeviceSelectConfigTypeInvalid = 0 , WdfUsbTargetDeviceSelectConfigTypeDeconfig = 1 , WdfUsbTargetDeviceSelectConfigTypeSingleInterface = 2 , WdfUsbTargetDeviceSelectConfigTypeMultiInterface = 3 ,   WdfUsbTargetDeviceSelectConfigTypeInterfacesPairs = 4 , WdfUsbTargetDeviceSelectConfigTypeInterfacesDescriptor = 5 , WdfUsbTargetDeviceSelectConfigTypeUrb = 6 }
enum	_WdfUsbTargetDeviceSelectSettingType { WdfUsbInterfaceSelectSettingTypeDescriptor = 0x10 , WdfUsbInterfaceSelectSettingTypeSetting = 0x11 , WdfUsbInterfaceSelectSettingTypeUrb = 0x12 }
enum	_WDF_USB_DEVICE_TRAITS { WDF_USB_DEVICE_TRAIT_SELF_POWERED = 0x00000001 , WDF_USB_DEVICE_TRAIT_REMOTE_WAKE_CAPABLE = 0x00000002 , WDF_USB_DEVICE_TRAIT_AT_HIGH_SPEED = 0x00000004 }

Functions
FORCEINLINE VOID	WDF_USB_CONTROL_SETUP_PACKET_INIT (_Out_ PWDF_USB_CONTROL_SETUP_PACKET Packet, _In_ WDF_USB_BMREQUEST_DIRECTION Direction, _In_ WDF_USB_BMREQUEST_RECIPIENT Recipient, _In_ BYTE Request, _In_ USHORT Value, _In_ USHORT Index)
FORCEINLINE VOID	WDF_USB_CONTROL_SETUP_PACKET_INIT_CLASS (_Out_ PWDF_USB_CONTROL_SETUP_PACKET Packet, _In_ WDF_USB_BMREQUEST_DIRECTION Direction, _In_ WDF_USB_BMREQUEST_RECIPIENT Recipient, _In_ BYTE Request, _In_ USHORT Value, _In_ USHORT Index)
FORCEINLINE VOID	WDF_USB_CONTROL_SETUP_PACKET_INIT_VENDOR (_Out_ PWDF_USB_CONTROL_SETUP_PACKET Packet, _In_ WDF_USB_BMREQUEST_DIRECTION Direction, _In_ WDF_USB_BMREQUEST_RECIPIENT Recipient, _In_ BYTE Request, _In_ USHORT Value, _In_ USHORT Index)
FORCEINLINE VOID	WDF_USB_CONTROL_SETUP_PACKET_INIT_FEATURE (_Out_ PWDF_USB_CONTROL_SETUP_PACKET Packet, _In_ WDF_USB_BMREQUEST_RECIPIENT BmRequestRecipient, _In_ USHORT FeatureSelector, _In_ USHORT Index, _In_ BOOLEAN SetFeature)
FORCEINLINE VOID	WDF_USB_CONTROL_SETUP_PACKET_INIT_GET_STATUS (_Out_ PWDF_USB_CONTROL_SETUP_PACKET Packet, _In_ WDF_USB_BMREQUEST_RECIPIENT BmRequestRecipient, _In_ USHORT Index)
typedef	_Function_class_ (EVT_WDF_USB_READER_COMPLETION_ROUTINE) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID STDCALL EVT_WDF_USB_READER_COMPLETION_ROUTINE(_In_ WDFUSBPIPE Pipe
typedef	_Function_class_ (EVT_WDF_USB_READERS_FAILED) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) BOOLEAN STDCALL EVT_WDF_USB_READERS_FAILED(_In_ WDFUSBPIPE Pipe
FORCEINLINE VOID	WDF_USB_CONTINUOUS_READER_CONFIG_INIT (_Out_ PWDF_USB_CONTINUOUS_READER_CONFIG Config, _In_ PFN_WDF_USB_READER_COMPLETION_ROUTINE EvtUsbTargetPipeReadComplete, _In_ WDFCONTEXT EvtUsbTargetPipeReadCompleteContext, _In_ size_t TransferLength)
FORCEINLINE WDFIOTARGET	WdfUsbTargetDeviceGetIoTarget (_In_ WDFUSBDEVICE UsbDevice)
FORCEINLINE VOID	WDF_USB_DEVICE_INFORMATION_INIT (_Out_ PWDF_USB_DEVICE_INFORMATION Udi)
FORCEINLINE VOID	WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_SINGLE_INTERFACE (_Out_ PWDF_USB_DEVICE_SELECT_CONFIG_PARAMS Params)
FORCEINLINE VOID	WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_MULTIPLE_INTERFACES (_Out_ PWDF_USB_DEVICE_SELECT_CONFIG_PARAMS Params, _In_opt_ UCHAR NumberInterfaces, _In_opt_ PWDF_USB_INTERFACE_SETTING_PAIR SettingPairs)
FORCEINLINE VOID	WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_INTERFACES_DESCRIPTORS (_Out_ PWDF_USB_DEVICE_SELECT_CONFIG_PARAMS Params, _In_ PUSB_CONFIGURATION_DESCRIPTOR ConfigDescriptor, _In_ PUSB_INTERFACE_DESCRIPTOR *InterfaceDescriptors, _In_ ULONG NumInterfaceDescriptors)
FORCEINLINE VOID	WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_URB (_Out_ PWDF_USB_DEVICE_SELECT_CONFIG_PARAMS Params, _In_ PURB Urb)
VOID FORCEINLINE	WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_DECONFIG (_Out_ PWDF_USB_DEVICE_SELECT_CONFIG_PARAMS Params)
FORCEINLINE VOID	WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_DESCRIPTOR (_Out_ PWDF_USB_INTERFACE_SELECT_SETTING_PARAMS Params, _In_ PUSB_INTERFACE_DESCRIPTOR Interface)
FORCEINLINE VOID	WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_URB (_Out_ PWDF_USB_INTERFACE_SELECT_SETTING_PARAMS Params, _In_ PURB Urb)
FORCEINLINE VOID	WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_SETTING (_Out_ PWDF_USB_INTERFACE_SELECT_SETTING_PARAMS Params, _In_ UCHAR SettingIndex)
FORCEINLINE WDFIOTARGET	WdfUsbTargetPipeGetIoTarget (_In_ WDFUSBPIPE Pipe)
FORCEINLINE VOID	WDF_USB_PIPE_INFORMATION_INIT (_Out_ PWDF_USB_PIPE_INFORMATION Info)
FORCEINLINE BOOLEAN	WDF_USB_PIPE_DIRECTION_IN (_In_ UCHAR EndpointAddress)
FORCEINLINE BOOLEAN	WDF_USB_PIPE_DIRECTION_OUT (_In_ UCHAR EndpointAddress)
FORCEINLINE VOID	WDF_USB_DEVICE_CREATE_CONFIG_INIT (_Out_ PWDF_USB_DEVICE_CREATE_CONFIG Config, _In_ ULONG USBDClientContractVersion)
_Must_inspect_result_	_IRQL_requires_max_ (DISPATCH_LEVEL) FORCEINLINE NTSTATUS WdfUsbTargetDeviceRetrieveInformation(_In_ WDFUSBDEVICE UsbDevice
_Must_inspect_result_ _In_ CONST GUID _In_ ULONG _Out_opt_	_When_ (ResultLength !=NULL, _Deref_out_range_(<=, CapabilityBufferLength)) PULONG ResultLength)
_Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ ULONG _Out_ WDFMEMORY	_Outptr_opt_result_bytebuffer_ (GET_ISO_URB_SIZE(NumberOfIsochPackets)) PURB *Urb)

Macro Definition Documentation

BMREQUEST_CLASS

#define BMREQUEST_CLASS   1

Definition at line 63 of file wdfusb.h.

BMREQUEST_DEVICE_TO_HOST

#define BMREQUEST_DEVICE_TO_HOST   1

Definition at line 55 of file wdfusb.h.

BMREQUEST_HOST_TO_DEVICE

#define BMREQUEST_HOST_TO_DEVICE   0

Definition at line 51 of file wdfusb.h.

BMREQUEST_STANDARD

#define BMREQUEST_STANDARD   0

Definition at line 59 of file wdfusb.h.

BMREQUEST_TO_DEVICE

#define BMREQUEST_TO_DEVICE   0

Definition at line 71 of file wdfusb.h.

BMREQUEST_TO_ENDPOINT

#define BMREQUEST_TO_ENDPOINT   2

Definition at line 79 of file wdfusb.h.

BMREQUEST_TO_INTERFACE

#define BMREQUEST_TO_INTERFACE   1

Definition at line 75 of file wdfusb.h.

BMREQUEST_TO_OTHER

#define BMREQUEST_TO_OTHER   3

Definition at line 83 of file wdfusb.h.

BMREQUEST_VENDOR

#define BMREQUEST_VENDOR   2

Definition at line 67 of file wdfusb.h.

WDF_EXTERN_C

#define WDF_EXTERN_C

Definition at line 38 of file wdfusb.h.

WDF_EXTERN_C_END

#define WDF_EXTERN_C_END

Definition at line 40 of file wdfusb.h.

WDF_EXTERN_C_START

#define WDF_EXTERN_C_START

Definition at line 39 of file wdfusb.h.

Typedef Documentation

_In_reads_

typedef _Must_inspect_result_ _In_ WDFUSBPIPE _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS _In_reads_(_Inexpressible_("union bug in SAL")) PURB Urb)

Definition at line 1538 of file wdfusb.h.

_IRQL_requires_max_

typedef _Must_inspect_result_ _IRQL_requires_max_(PASSIVE_LEVEL) WDFAPI NTSTATUS(STDCALL *PFN_WDFUSBINTERFACESELECTSETTING)(_In_ PWDF_DRIVER_GLOBALS DriverGlobals

Definition at line 894 of file wdfusb.h.

_Out_writes_bytes_

typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_ CONST GUID _In_ ULONG _Out_writes_bytes_(CapabilityBufferLength)) _When_(CapabilityBufferLength !=0 &&ResultLength ! = NULL

Definition at line 1617 of file wdfusb.h.

_Out_writes_bytes_to_opt_

_Must_inspect_result_ _In_ CONST GUID _In_ ULONG _Out_writes_bytes_to_opt_

Definition at line 1618 of file wdfusb.h.

_Outptr_opt_result_bytebuffer_

typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ ULONG _Out_ WDFMEMORY _Outptr_opt_result_bytebuffer_(GET_ISO_URB_SIZE(NumberOfIsochPackets)) PURB *Urb)

Definition at line 1665 of file wdfusb.h.

_When_

typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_ CONST GUID _In_ ULONG _Out_opt_ _When_(ResultLength !=NULL, _Deref_out_range_(<=, CapabilityBufferLength)) PULONG ResultLength) == NULL

Definition at line 1616 of file wdfusb.h.

Attributes

_Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES Attributes

Definition at line 903 of file wdfusb.h.

Buffer

typedef _In_ WDFMEMORY Buffer

Definition at line 381 of file wdfusb.h.

BytesRead

_Must_inspect_result_ _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS _In_opt_ PWDF_MEMORY_DESCRIPTOR _Out_opt_ PULONG BytesRead

Initial value:

{
    return ((PFN_WDFUSBTARGETPIPEREADSYNCHRONOUSLY) WdfFunctions[WdfUsbTargetPipeReadSynchronouslyTableIndex])(WdfDriverGlobals, Pipe, Request, RequestOptions, MemoryDescriptor, BytesRead)

Definition at line 1961 of file wdfusb.h.

BytesTransferred

_Must_inspect_result_ _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS _In_ PWDF_USB_CONTROL_SETUP_PACKET _In_opt_ PWDF_MEMORY_DESCRIPTOR _Out_opt_ PULONG BytesTransferred

Initial value:

{
    return ((PFN_WDFUSBTARGETDEVICESENDCONTROLTRANSFERSYNCHRONOUSLY) WdfFunctions[WdfUsbTargetDeviceSendControlTransferSynchronouslyTableIndex])(WdfDriverGlobals, UsbDevice, Request, RequestOptions, SetupPacket, MemoryDescriptor, BytesTransferred)

Definition at line 1341 of file wdfusb.h.

BytesWritten

_Must_inspect_result_ _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS _In_opt_ PWDF_MEMORY_DESCRIPTOR _Out_opt_ PULONG BytesWritten

Initial value:

{
    return ((PFN_WDFUSBTARGETPIPEWRITESYNCHRONOUSLY) WdfFunctions[WdfUsbTargetPipeWriteSynchronouslyTableIndex])(WdfDriverGlobals, Pipe, Request, RequestOptions, MemoryDescriptor, BytesWritten)

Definition at line 1879 of file wdfusb.h.

CapabilityBufferLength

_Must_inspect_result_ _In_ CONST GUID _In_ ULONG CapabilityBufferLength

Definition at line 1615 of file wdfusb.h.

CapabilityType

_Must_inspect_result_ _In_ CONST GUID * CapabilityType

Definition at line 1613 of file wdfusb.h.

Config

_Must_inspect_result_ _In_ PWDF_USB_CONTINUOUS_READER_CONFIG Config

Initial value:

{
    return ((PFN_WDFUSBTARGETPIPECONFIGCONTINUOUSREADER) WdfFunctions[WdfUsbTargetPipeConfigContinuousReaderTableIndex])(WdfDriverGlobals, Pipe, Config)

Definition at line 938 of file wdfusb.h.

ConfigDescriptor

_Must_inspect_result_ _Out_writes_bytes_to_opt_ ConfigDescriptorLength PVOID ConfigDescriptor

Definition at line 1037 of file wdfusb.h.

ConfigDescriptorLength

_Must_inspect_result_ _Out_writes_bytes_to_opt_ ConfigDescriptorLength PVOID _Inout_ PUSHORT ConfigDescriptorLength

Initial value:

{
    return ((PFN_WDFUSBTARGETDEVICERETRIEVECONFIGDESCRIPTOR) WdfFunctions[WdfUsbTargetDeviceRetrieveConfigDescriptorTableIndex])(WdfDriverGlobals, UsbDevice, ConfigDescriptor, ConfigDescriptorLength)

Definition at line 1039 of file wdfusb.h.

Context

typedef _In_ WDFMEMORY _In_ size_t _In_ WDFCONTEXT Context

Definition at line 385 of file wdfusb.h.

CurrentFrameNumber

_Must_inspect_result_ _Out_ PULONG CurrentFrameNumber

Initial value:

{
    return ((PFN_WDFUSBTARGETDEVICERETRIEVECURRENTFRAMENUMBER) WdfFunctions[WdfUsbTargetDeviceRetrieveCurrentFrameNumberTableIndex])(WdfDriverGlobals, UsbDevice, CurrentFrameNumber)

Definition at line 1302 of file wdfusb.h.

Device

typedef _Must_inspect_result_ _In_ WDFDEVICE Device

Definition at line 901 of file wdfusb.h.

EndpointIndex

_In_ UCHAR _In_ UCHAR EndpointIndex

Definition at line 2426 of file wdfusb.h.

EndpointInfo

_In_ UCHAR _In_ UCHAR _Out_ PWDF_USB_PIPE_INFORMATION EndpointInfo

Initial value:

{
    ((PFN_WDFUSBINTERFACEGETENDPOINTINFORMATION) WdfFunctions[WdfUsbInterfaceGetEndpointInformationTableIndex])(WdfDriverGlobals, UsbInterface, SettingIndex, EndpointIndex, EndpointInfo)

Definition at line 2428 of file wdfusb.h.

Information

_Must_inspect_result_ _Out_ PWDF_USB_DEVICE_INFORMATION Information

Initial value:

{
    return ((PFN_WDFUSBTARGETDEVICERETRIEVEINFORMATION) WdfFunctions[WdfUsbTargetDeviceRetrieveInformationTableIndex])(WdfDriverGlobals, UsbDevice, Information)

Definition at line 977 of file wdfusb.h.

Interface

typedef _In_ WDFUSBINTERFACE Interface

Definition at line 2488 of file wdfusb.h.

InterfaceDescriptor

_In_ UCHAR _Out_ PUSB_INTERFACE_DESCRIPTOR InterfaceDescriptor

Initial value:

{
    ((PFN_WDFUSBINTERFACEGETDESCRIPTOR) WdfFunctions[WdfUsbInterfaceGetDescriptorTableIndex])(WdfDriverGlobals, UsbInterface, SettingIndex, InterfaceDescriptor)

Definition at line 2333 of file wdfusb.h.

InterfaceIndex

_In_ UCHAR InterfaceIndex

Initial value:

{
    return ((PFN_WDFUSBTARGETDEVICEGETINTERFACE) WdfFunctions[WdfUsbTargetDeviceGetInterfaceTableIndex])(WdfDriverGlobals, UsbDevice, InterfaceIndex)

Definition at line 2461 of file wdfusb.h.

LangID

_Must_inspect_result_ _In_ WDFUSBDEVICE _In_ WDFREQUEST _In_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET _In_ UCHAR _In_opt_ USHORT LangID

Initial value:

{
    return ((PFN_WDFUSBTARGETDEVICEQUERYSTRING) WdfFunctions[WdfUsbTargetDeviceQueryStringTableIndex])(WdfDriverGlobals, UsbDevice, Request, RequestOptions, String, NumCharacters, StringIndex, LangID)

Definition at line 1082 of file wdfusb.h.

Memory

_Must_inspect_result_ _In_ WDFREQUEST _In_ WDFMEMORY Memory

Definition at line 1172 of file wdfusb.h.

MemoryDescriptor

_Must_inspect_result_ _In_ WDFUSBPIPE _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS _In_opt_ PWDF_MEMORY_DESCRIPTOR MemoryDescriptor

Definition at line 1339 of file wdfusb.h.

NumberOfIsochPackets

_Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ ULONG NumberOfIsochPackets

Definition at line 1703 of file wdfusb.h.

NumBytesTransferred

typedef _In_ WDFMEMORY _In_ size_t NumBytesTransferred

Definition at line 383 of file wdfusb.h.

NumCharacters

_Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFMEMORY _Out_opt_ PUSHORT NumCharacters

Definition at line 1078 of file wdfusb.h.

Offset

_Must_inspect_result_ _In_ WDFREQUEST _In_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET Offset

Definition at line 1174 of file wdfusb.h.

Params

_Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ PWDF_USB_INTERFACE_SELECT_SETTING_PARAMS Params

Initial value:

{
    return ((PFN_WDFUSBTARGETDEVICESELECTCONFIG) WdfFunctions[WdfUsbTargetDeviceSelectConfigTableIndex])(WdfDriverGlobals, UsbDevice, PipeAttributes, Params)

Definition at line 1244 of file wdfusb.h.

PFN_WDF_USB_READER_COMPLETION_ROUTINE

typedef EVT_WDF_USB_READER_COMPLETION_ROUTINE* PFN_WDF_USB_READER_COMPLETION_ROUTINE

Definition at line 388 of file wdfusb.h.

PFN_WDF_USB_READERS_FAILED

typedef EVT_WDF_USB_READERS_FAILED* PFN_WDF_USB_READERS_FAILED

Definition at line 405 of file wdfusb.h.

Pipe

_Must_inspect_result_ _In_ WDFUSBPIPE Pipe

Initial value:

{
    PAGED_CODE_LOCKED()

Definition at line 1741 of file wdfusb.h.

PIPE

typedef _Must_inspect_result_ _In_ WDFUSBPIPE PIPE

Definition at line 2237 of file wdfusb.h.

PipeAttributes

_Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES PipeAttributes

Definition at line 1242 of file wdfusb.h.

PipeIndex

_In_ UCHAR PipeIndex

Definition at line 2540 of file wdfusb.h.

PipeInfo

_In_ UCHAR _Out_opt_ PWDF_USB_PIPE_INFORMATION PipeInfo

Initial value:

{
    return ((PFN_WDFUSBINTERFACEGETCONFIGUREDPIPE) WdfFunctions[WdfUsbInterfaceGetConfiguredPipeTableIndex])(WdfDriverGlobals, UsbInterface, PipeIndex, PipeInfo)

Definition at line 2542 of file wdfusb.h.

PipeInformation

_Out_ PWDF_USB_PIPE_INFORMATION PipeInformation

Initial value:

{
    ((PFN_WDFUSBTARGETPIPEGETINFORMATION) WdfFunctions[WdfUsbTargetPipeGetInformationTableIndex])(WdfDriverGlobals, Pipe, PipeInformation)

Definition at line 1743 of file wdfusb.h.

PipesAttributes

_Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES PipesAttributes

Definition at line 2390 of file wdfusb.h.

PWDF_USB_CONTINUOUS_READER_CONFIG

typedef struct _WDF_USB_CONTINUOUS_READER_CONFIG * PWDF_USB_CONTINUOUS_READER_CONFIG

PWDF_USB_CONTROL_SETUP_PACKET

typedef union _WDF_USB_CONTROL_SETUP_PACKET * PWDF_USB_CONTROL_SETUP_PACKET

PWDF_USB_DEVICE_CREATE_CONFIG

typedef struct _WDF_USB_DEVICE_CREATE_CONFIG * PWDF_USB_DEVICE_CREATE_CONFIG

PWDF_USB_DEVICE_INFORMATION

typedef struct _WDF_USB_DEVICE_INFORMATION * PWDF_USB_DEVICE_INFORMATION

PWDF_USB_DEVICE_SELECT_CONFIG_PARAMS

typedef struct _WDF_USB_DEVICE_SELECT_CONFIG_PARAMS * PWDF_USB_DEVICE_SELECT_CONFIG_PARAMS

PWDF_USB_INTERFACE_SELECT_SETTING_PARAMS

typedef struct _WDF_USB_INTERFACE_SELECT_SETTING_PARAMS * PWDF_USB_INTERFACE_SELECT_SETTING_PARAMS

PWDF_USB_INTERFACE_SETTING_PAIR

typedef struct _WDF_USB_INTERFACE_SETTING_PAIR * PWDF_USB_INTERFACE_SETTING_PAIR

PWDF_USB_PIPE_INFORMATION

typedef struct _WDF_USB_PIPE_INFORMATION * PWDF_USB_PIPE_INFORMATION

PWDF_USB_REQUEST_COMPLETION_PARAMS

typedef struct _WDF_USB_REQUEST_COMPLETION_PARAMS * PWDF_USB_REQUEST_COMPLETION_PARAMS

PWDF_USB_REQUEST_TYPE

typedef enum _WDF_USB_REQUEST_TYPE * PWDF_USB_REQUEST_TYPE

ReadMemory

_Must_inspect_result_ _In_ WDFREQUEST _In_opt_ WDFMEMORY ReadMemory

Definition at line 2000 of file wdfusb.h.

ReadOffset

_Must_inspect_result_ _In_ WDFREQUEST _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET ReadOffset

Initial value:

{
    return ((PFN_WDFUSBTARGETPIPEFORMATREQUESTFORREAD) WdfFunctions[WdfUsbTargetPipeFormatRequestForReadTableIndex])(WdfDriverGlobals, Pipe, Request, ReadMemory, ReadOffset)

Definition at line 2002 of file wdfusb.h.

Request

_Must_inspect_result_ _In_ WDFREQUEST Request

Initial value:

{
    return ((PFN_WDFUSBTARGETDEVICEFORMATREQUESTFORCYCLEPORT) WdfFunctions[WdfUsbTargetDeviceFormatRequestForCyclePortTableIndex])(WdfDriverGlobals, UsbDevice, Request)

Definition at line 1072 of file wdfusb.h.

RequestOptions

_Must_inspect_result_ _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS RequestOptions

Initial value:

{
    return ((PFN_WDFUSBTARGETPIPEABORTSYNCHRONOUSLY) WdfFunctions[WdfUsbTargetPipeAbortSynchronouslyTableIndex])(WdfDriverGlobals, Pipe, Request, RequestOptions)

Definition at line 1074 of file wdfusb.h.

SettingIndex

_In_ WDFUSBINTERFACE _In_ UCHAR SettingIndex

Initial value:

{
    return ((PFN_WDFUSBINTERFACEGETNUMENDPOINTS) WdfFunctions[WdfUsbInterfaceGetNumEndpointsTableIndex])(WdfDriverGlobals, UsbInterface, SettingIndex)

Definition at line 2302 of file wdfusb.h.

SetupPacket

_Must_inspect_result_ _In_ WDFUSBDEVICE _In_ WDFREQUEST _In_ PWDF_USB_CONTROL_SETUP_PACKET SetupPacket

Definition at line 1337 of file wdfusb.h.

Status

typedef _In_ NTSTATUS Status

Definition at line 400 of file wdfusb.h.

String

_Must_inspect_result_ _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS _Out_writes_opt_ NumCharacters PUSHORT String

Definition at line 1076 of file wdfusb.h.

StringIndex

_Must_inspect_result_ _In_ WDFUSBDEVICE _In_ WDFREQUEST _In_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET _In_ UCHAR StringIndex

Definition at line 1080 of file wdfusb.h.

StringMemory

* StringMemory = NULL

Definition at line 1125 of file wdfusb.h.

StringMemoryAttributes

_Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES StringMemoryAttributes

Definition at line 1123 of file wdfusb.h.

TransferMemory

_Must_inspect_result_ _In_ WDFREQUEST _In_ PWDF_USB_CONTROL_SETUP_PACKET _In_opt_ WDFMEMORY TransferMemory

Definition at line 1384 of file wdfusb.h.

TransferOffset

_Must_inspect_result_ _In_ WDFREQUEST _In_ PWDF_USB_CONTROL_SETUP_PACKET _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET TransferOffset

Initial value:

{
    return ((PFN_WDFUSBTARGETDEVICEFORMATREQUESTFORCONTROLTRANSFER) WdfFunctions[WdfUsbTargetDeviceFormatRequestForControlTransferTableIndex])(WdfDriverGlobals, UsbDevice, Request, SetupPacket, TransferMemory, TransferOffset)

Definition at line 1386 of file wdfusb.h.

UrbMemory

__checkReturn __in WDFUSBDEVICE __in_opt PWDF_OBJECT_ATTRIBUTES __out WDFMEMORY * UrbMemory

Definition at line 1576 of file wdfusb.h.

UrbMemoryOffset

_Must_inspect_result_ _In_ WDFUSBPIPE _In_ WDFREQUEST _In_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET UrbMemoryOffset

Initial value:

{
    return ((PFN_WDFUSBTARGETDEVICEFORMATREQUESTFORURB) WdfFunctions[WdfUsbTargetDeviceFormatRequestForUrbTableIndex])(WdfDriverGlobals, UsbDevice, Request, UrbMemory, UrbMemoryOffset)

Definition at line 1578 of file wdfusb.h.

UsbDevice

_In_ WDFUSBDEVICE UsbDevice

Initial value:

{
    return ((PFN_WDFUSBTARGETDEVICECREATE) WdfFunctions[WdfUsbTargetDeviceCreateTableIndex])(WdfDriverGlobals, Device, Attributes, UsbDevice)

Definition at line 905 of file wdfusb.h.

UsbDeviceDescriptor

_Out_ PUSB_DEVICE_DESCRIPTOR UsbDeviceDescriptor

Initial value:

{
    ((PFN_WDFUSBTARGETDEVICEGETDEVICEDESCRIPTOR) WdfFunctions[WdfUsbTargetDeviceGetDeviceDescriptorTableIndex])(WdfDriverGlobals, UsbDevice, UsbDeviceDescriptor)

Definition at line 1007 of file wdfusb.h.

UsbdStatus

typedef _In_ NTSTATUS _In_ USBD_STATUS UsbdStatus

Definition at line 402 of file wdfusb.h.

UsbInterface

_In_ WDFUSBINTERFACE UsbInterface

Initial value:

{
    PAGED_CODE_LOCKED()

Definition at line 2275 of file wdfusb.h.

UsbPipe

typedef _In_ WDFUSBPIPE UsbPipe

Definition at line 2571 of file wdfusb.h.

WDF_USB_BMREQUEST_DIRECTION

typedef enum _WDF_USB_BMREQUEST_DIRECTION WDF_USB_BMREQUEST_DIRECTION

WDF_USB_BMREQUEST_RECIPIENT

typedef enum _WDF_USB_BMREQUEST_RECIPIENT WDF_USB_BMREQUEST_RECIPIENT

WDF_USB_BMREQUEST_TYPE

typedef enum _WDF_USB_BMREQUEST_TYPE WDF_USB_BMREQUEST_TYPE

WDF_USB_CONTINUOUS_READER_CONFIG

typedef struct _WDF_USB_CONTINUOUS_READER_CONFIG WDF_USB_CONTINUOUS_READER_CONFIG

WDF_USB_CONTROL_SETUP_PACKET

typedef union _WDF_USB_CONTROL_SETUP_PACKET WDF_USB_CONTROL_SETUP_PACKET

WDF_USB_DEVICE_CREATE_CONFIG

typedef struct _WDF_USB_DEVICE_CREATE_CONFIG WDF_USB_DEVICE_CREATE_CONFIG

WDF_USB_DEVICE_INFORMATION

typedef struct _WDF_USB_DEVICE_INFORMATION WDF_USB_DEVICE_INFORMATION

WDF_USB_DEVICE_SELECT_CONFIG_PARAMS

typedef struct _WDF_USB_DEVICE_SELECT_CONFIG_PARAMS WDF_USB_DEVICE_SELECT_CONFIG_PARAMS

WDF_USB_DEVICE_TRAITS

typedef enum _WDF_USB_DEVICE_TRAITS WDF_USB_DEVICE_TRAITS

WDF_USB_INTERFACE_SELECT_SETTING_PARAMS

typedef struct _WDF_USB_INTERFACE_SELECT_SETTING_PARAMS WDF_USB_INTERFACE_SELECT_SETTING_PARAMS

WDF_USB_INTERFACE_SETTING_PAIR

typedef struct _WDF_USB_INTERFACE_SETTING_PAIR WDF_USB_INTERFACE_SETTING_PAIR

WDF_USB_PIPE_INFORMATION

typedef struct _WDF_USB_PIPE_INFORMATION WDF_USB_PIPE_INFORMATION

WDF_USB_PIPE_TYPE

typedef enum _WDF_USB_PIPE_TYPE WDF_USB_PIPE_TYPE

WDF_USB_REQUEST_COMPLETION_PARAMS

typedef struct _WDF_USB_REQUEST_COMPLETION_PARAMS WDF_USB_REQUEST_COMPLETION_PARAMS

WDF_USB_REQUEST_TYPE

typedef enum _WDF_USB_REQUEST_TYPE WDF_USB_REQUEST_TYPE

WdfUsbTargetDeviceSelectConfigType

typedef enum _WdfUsbTargetDeviceSelectConfigType WdfUsbTargetDeviceSelectConfigType

WdfUsbTargetDeviceSelectSettingType

typedef enum _WdfUsbTargetDeviceSelectSettingType WdfUsbTargetDeviceSelectSettingType

WriteMemory

_Must_inspect_result_ _In_ WDFREQUEST _In_opt_ WDFMEMORY WriteMemory

Definition at line 1918 of file wdfusb.h.

WriteOffset

_Must_inspect_result_ _In_ WDFREQUEST _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET WriteOffset

Initial value:

{
    return ((PFN_WDFUSBTARGETPIPEFORMATREQUESTFORWRITE) WdfFunctions[WdfUsbTargetPipeFormatRequestForWriteTableIndex])(WdfDriverGlobals, Pipe, Request, WriteMemory, WriteOffset)

Definition at line 1920 of file wdfusb.h.

Enumeration Type Documentation

_WDF_USB_BMREQUEST_DIRECTION

enum _WDF_USB_BMREQUEST_DIRECTION

Enumerator
BmRequestHostToDevice
BmRequestDeviceToHost

Definition at line 99 of file wdfusb.h.

                                          {
    BmRequestHostToDevice = BMREQUEST_HOST_TO_DEVICE,
    BmRequestDeviceToHost = BMREQUEST_DEVICE_TO_HOST,
} WDF_USB_BMREQUEST_DIRECTION;

_WDF_USB_BMREQUEST_RECIPIENT

enum _WDF_USB_BMREQUEST_RECIPIENT

Enumerator
BmRequestToDevice
BmRequestToInterface
BmRequestToEndpoint
BmRequestToOther

Definition at line 110 of file wdfusb.h.

                                          {
    BmRequestToDevice = BMREQUEST_TO_DEVICE,
    BmRequestToInterface = BMREQUEST_TO_INTERFACE,
    BmRequestToEndpoint = BMREQUEST_TO_ENDPOINT,
    BmRequestToOther = BMREQUEST_TO_OTHER,
} WDF_USB_BMREQUEST_RECIPIENT;

_WDF_USB_BMREQUEST_TYPE

enum _WDF_USB_BMREQUEST_TYPE

Enumerator
BmRequestStandard
BmRequestClass
BmRequestVendor

Definition at line 104 of file wdfusb.h.

                                     {
    BmRequestStandard = BMREQUEST_STANDARD,
    BmRequestClass = BMREQUEST_CLASS,
    BmRequestVendor = BMREQUEST_VENDOR,
} WDF_USB_BMREQUEST_TYPE;

_WDF_USB_DEVICE_TRAITS

enum _WDF_USB_DEVICE_TRAITS

Enumerator
WDF_USB_DEVICE_TRAIT_SELF_POWERED
WDF_USB_DEVICE_TRAIT_REMOTE_WAKE_CAPABLE
WDF_USB_DEVICE_TRAIT_AT_HIGH_SPEED

Definition at line 141 of file wdfusb.h.

                                    {
    WDF_USB_DEVICE_TRAIT_SELF_POWERED =        0x00000001,
    WDF_USB_DEVICE_TRAIT_REMOTE_WAKE_CAPABLE = 0x00000002,
    WDF_USB_DEVICE_TRAIT_AT_HIGH_SPEED =       0x00000004,
} WDF_USB_DEVICE_TRAITS;

_WDF_USB_PIPE_TYPE

enum _WDF_USB_PIPE_TYPE

Enumerator
WdfUsbPipeTypeInvalid
WdfUsbPipeTypeControl
WdfUsbPipeTypeIsochronous
WdfUsbPipeTypeBulk
WdfUsbPipeTypeInterrupt

Definition at line 117 of file wdfusb.h.

                                {
    WdfUsbPipeTypeInvalid = 0,
    WdfUsbPipeTypeControl,
    WdfUsbPipeTypeIsochronous,
    WdfUsbPipeTypeBulk,
    WdfUsbPipeTypeInterrupt,
} WDF_USB_PIPE_TYPE;

_WDF_USB_REQUEST_TYPE

enum _WDF_USB_REQUEST_TYPE

Enumerator
WdfUsbRequestTypeInvalid
WdfUsbRequestTypeNoFormat
WdfUsbRequestTypeDeviceString
WdfUsbRequestTypeDeviceControlTransfer
WdfUsbRequestTypeDeviceUrb
WdfUsbRequestTypePipeWrite
WdfUsbRequestTypePipeRead
WdfUsbRequestTypePipeAbort
WdfUsbRequestTypePipeReset
WdfUsbRequestTypePipeUrb

Definition at line 86 of file wdfusb.h.

                                   {
    WdfUsbRequestTypeInvalid = 0,
    WdfUsbRequestTypeNoFormat,
    WdfUsbRequestTypeDeviceString,
    WdfUsbRequestTypeDeviceControlTransfer,
    WdfUsbRequestTypeDeviceUrb,
    WdfUsbRequestTypePipeWrite,
    WdfUsbRequestTypePipeRead,
    WdfUsbRequestTypePipeAbort,
    WdfUsbRequestTypePipeReset,
    WdfUsbRequestTypePipeUrb,
} WDF_USB_REQUEST_TYPE, *PWDF_USB_REQUEST_TYPE;

_WdfUsbTargetDeviceSelectConfigType

enum _WdfUsbTargetDeviceSelectConfigType

Enumerator
WdfUsbTargetDeviceSelectConfigTypeInvalid
WdfUsbTargetDeviceSelectConfigTypeDeconfig
WdfUsbTargetDeviceSelectConfigTypeSingleInterface
WdfUsbTargetDeviceSelectConfigTypeMultiInterface
WdfUsbTargetDeviceSelectConfigTypeInterfacesPairs
WdfUsbTargetDeviceSelectConfigTypeInterfacesDescriptor
WdfUsbTargetDeviceSelectConfigTypeUrb

Definition at line 125 of file wdfusb.h.

                                                 {
    WdfUsbTargetDeviceSelectConfigTypeInvalid = 0,
    WdfUsbTargetDeviceSelectConfigTypeDeconfig = 1,
    WdfUsbTargetDeviceSelectConfigTypeSingleInterface = 2,
    WdfUsbTargetDeviceSelectConfigTypeMultiInterface = 3,
    WdfUsbTargetDeviceSelectConfigTypeInterfacesPairs = 4,
    WdfUsbTargetDeviceSelectConfigTypeInterfacesDescriptor = 5,
    WdfUsbTargetDeviceSelectConfigTypeUrb = 6,
} WdfUsbTargetDeviceSelectConfigType;

_WdfUsbTargetDeviceSelectSettingType

enum _WdfUsbTargetDeviceSelectSettingType

Enumerator
WdfUsbInterfaceSelectSettingTypeDescriptor
WdfUsbInterfaceSelectSettingTypeSetting
WdfUsbInterfaceSelectSettingTypeUrb

Definition at line 135 of file wdfusb.h.

                                                  {
    WdfUsbInterfaceSelectSettingTypeDescriptor = 0x10,
    WdfUsbInterfaceSelectSettingTypeSetting = 0x11,
    WdfUsbInterfaceSelectSettingTypeUrb = 0x12,
} WdfUsbTargetDeviceSelectSettingType;

Function Documentation

_Function_class_() [1/2]

typedef _Function_class_

(

EVT_WDF_USB_READER_COMPLETION_ROUTINE

)

_Function_class_() [2/2]

typedef _Function_class_

(

EVT_WDF_USB_READERS_FAILED

)

_IRQL_requires_max_()

_Must_inspect_result_ _IRQL_requires_max_

(

DISPATCH_LEVEL

)

Definition at line 1217 of file wdfusb.h.

{
    return ((PFN_WDFUSBTARGETDEVICEGETNUMINTERFACES) WdfFunctions[WdfUsbTargetDeviceGetNumInterfacesTableIndex])(WdfDriverGlobals, UsbDevice);
}

_Outptr_opt_result_bytebuffer_()

_Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ ULONG _Out_ WDFMEMORY _Outptr_opt_result_bytebuffer_

(

GET_ISO_URB_SIZE(NumberOfIsochPackets)

)

Definition at line 1723 of file wdfusb.h.

{
    return ((PFN_WDFUSBTARGETDEVICECREATEISOCHURB) WdfFunctions[WdfUsbTargetDeviceCreateIsochUrbTableIndex])(WdfDriverGlobals, UsbDevice, Attributes, NumberOfIsochPackets, UrbMemory, Urb);
}

_When_()

_Must_inspect_result_ _In_ CONST GUID _In_ ULONG _Out_opt_ _When_	(	ResultLength !	= NULL,
		_Deref_out_range_(<=, CapabilityBufferLength)
	)

Definition at line 1641 of file wdfusb.h.

{
    return ((PFN_WDFUSBTARGETDEVICEQUERYUSBCAPABILITY) WdfFunctions[WdfUsbTargetDeviceQueryUsbCapabilityTableIndex])(WdfDriverGlobals, UsbDevice, CapabilityType, CapabilityBufferLength, CapabilityBuffer, ResultLength);
}

WDF_USB_CONTINUOUS_READER_CONFIG_INIT()

FORCEINLINE VOID WDF_USB_CONTINUOUS_READER_CONFIG_INIT	(	_Out_ PWDF_USB_CONTINUOUS_READER_CONFIG	Config,
		_In_ PFN_WDF_USB_READER_COMPLETION_ROUTINE	EvtUsbTargetPipeReadComplete,
		_In_ WDFCONTEXT	EvtUsbTargetPipeReadCompleteContext,
		_In_ size_t	TransferLength
	)

Definition at line 460 of file wdfusb.h.

{
    RtlZeroMemory(Config, sizeof(WDF_USB_CONTINUOUS_READER_CONFIG));
    Config->Size = sizeof(WDF_USB_CONTINUOUS_READER_CONFIG);
 
    Config->EvtUsbTargetPipeReadComplete = EvtUsbTargetPipeReadComplete;
    Config->EvtUsbTargetPipeReadCompleteContext = EvtUsbTargetPipeReadCompleteContext;
    Config->TransferLength = TransferLength;
}

WDF_USB_CONTROL_SETUP_PACKET_INIT()

FORCEINLINE VOID WDF_USB_CONTROL_SETUP_PACKET_INIT	(	_Out_ PWDF_USB_CONTROL_SETUP_PACKET	Packet,
		_In_ WDF_USB_BMREQUEST_DIRECTION	Direction,
		_In_ WDF_USB_BMREQUEST_RECIPIENT	Recipient,
		_In_ BYTE	Request,
		_In_ USHORT	Value,
		_In_ USHORT	Index
	)

Definition at line 204 of file wdfusb.h.

{
    RtlZeroMemory(Packet, sizeof(WDF_USB_CONTROL_SETUP_PACKET));
 
    Packet->Packet.bm.Request.Dir = (BYTE) Direction;
    Packet->Packet.bm.Request.Type = (BYTE) BmRequestStandard;
    Packet->Packet.bm.Request.Recipient = (BYTE) Recipient;
 
    Packet->Packet.bRequest = Request;
    Packet->Packet.wValue.Value = Value;
    Packet->Packet.wIndex.Value = Index;
 
    // Packet->Packet.wLength will be set by the formatting function
}

WDF_USB_CONTROL_SETUP_PACKET_INIT_CLASS()

FORCEINLINE VOID WDF_USB_CONTROL_SETUP_PACKET_INIT_CLASS	(	_Out_ PWDF_USB_CONTROL_SETUP_PACKET	Packet,
		_In_ WDF_USB_BMREQUEST_DIRECTION	Direction,
		_In_ WDF_USB_BMREQUEST_RECIPIENT	Recipient,
		_In_ BYTE	Request,
		_In_ USHORT	Value,
		_In_ USHORT	Index
	)

Definition at line 228 of file wdfusb.h.

{
    RtlZeroMemory(Packet, sizeof(WDF_USB_CONTROL_SETUP_PACKET));
 
    Packet->Packet.bm.Request.Dir = (BYTE) Direction;
    Packet->Packet.bm.Request.Type = (BYTE) BmRequestClass;
    Packet->Packet.bm.Request.Recipient = (BYTE) Recipient;
 
    Packet->Packet.bRequest = Request;
    Packet->Packet.wValue.Value = Value;
    Packet->Packet.wIndex.Value = Index;
 
    // Packet->Packet.wLength will be set by the formatting function
}

WDF_USB_CONTROL_SETUP_PACKET_INIT_FEATURE()

FORCEINLINE VOID WDF_USB_CONTROL_SETUP_PACKET_INIT_FEATURE	(	_Out_ PWDF_USB_CONTROL_SETUP_PACKET	Packet,
		_In_ WDF_USB_BMREQUEST_RECIPIENT	BmRequestRecipient,
		_In_ USHORT	FeatureSelector,
		_In_ USHORT	Index,
		_In_ BOOLEAN	SetFeature
	)

Definition at line 276 of file wdfusb.h.

{
    RtlZeroMemory(Packet, sizeof(WDF_USB_CONTROL_SETUP_PACKET));
 
    Packet->Packet.bm.Request.Dir = (BYTE) BmRequestHostToDevice;
    Packet->Packet.bm.Request.Type = (BYTE) BmRequestStandard;
    Packet->Packet.bm.Request.Recipient = (BYTE) BmRequestRecipient;
 
    if (SetFeature) {
        Packet->Packet.bRequest = USB_REQUEST_SET_FEATURE;
    }
    else {
        Packet->Packet.bRequest = USB_REQUEST_CLEAR_FEATURE;
    }
 
    Packet->Packet.wValue.Value = FeatureSelector;
    Packet->Packet.wIndex.Value = Index;
 
    // Packet->Packet.wLength will be set by the formatting function
}

WDF_USB_CONTROL_SETUP_PACKET_INIT_GET_STATUS()

FORCEINLINE VOID WDF_USB_CONTROL_SETUP_PACKET_INIT_GET_STATUS	(	_Out_ PWDF_USB_CONTROL_SETUP_PACKET	Packet,
		_In_ WDF_USB_BMREQUEST_RECIPIENT	BmRequestRecipient,
		_In_ USHORT	Index
	)

Definition at line 305 of file wdfusb.h.

{
    RtlZeroMemory(Packet, sizeof(WDF_USB_CONTROL_SETUP_PACKET));
 
    Packet->Packet.bm.Request.Dir = (BYTE) BmRequestDeviceToHost;
    Packet->Packet.bm.Request.Type = (BYTE) BmRequestStandard;
    Packet->Packet.bm.Request.Recipient = (BYTE) BmRequestRecipient;
 
    Packet->Packet.bRequest = USB_REQUEST_GET_STATUS;
    Packet->Packet.wIndex.Value = Index;
    Packet->Packet.wValue.Value = 0;
 
    // Packet->Packet.wLength will be set by the formatting function
}

WDF_USB_CONTROL_SETUP_PACKET_INIT_VENDOR()

FORCEINLINE VOID WDF_USB_CONTROL_SETUP_PACKET_INIT_VENDOR	(	_Out_ PWDF_USB_CONTROL_SETUP_PACKET	Packet,
		_In_ WDF_USB_BMREQUEST_DIRECTION	Direction,
		_In_ WDF_USB_BMREQUEST_RECIPIENT	Recipient,
		_In_ BYTE	Request,
		_In_ USHORT	Value,
		_In_ USHORT	Index
	)

Definition at line 252 of file wdfusb.h.

{
    RtlZeroMemory(Packet, sizeof(WDF_USB_CONTROL_SETUP_PACKET));
 
    Packet->Packet.bm.Request.Dir = (BYTE) Direction;
    Packet->Packet.bm.Request.Type = (BYTE) BmRequestVendor;
    Packet->Packet.bm.Request.Recipient = (BYTE) Recipient;
 
    Packet->Packet.bRequest = Request;
    Packet->Packet.wValue.Value = Value;
    Packet->Packet.wIndex.Value = Index;
 
    // Packet->Packet.wLength will be set by the formatting function
}

WDF_USB_DEVICE_CREATE_CONFIG_INIT()

FORCEINLINE VOID WDF_USB_DEVICE_CREATE_CONFIG_INIT	(	_Out_ PWDF_USB_DEVICE_CREATE_CONFIG	Config,
		_In_ ULONG	USBDClientContractVersion
	)

Definition at line 871 of file wdfusb.h.

{
    RtlZeroMemory(Config, sizeof(WDF_USB_DEVICE_CREATE_CONFIG));
 
    Config->Size = sizeof(WDF_USB_DEVICE_CREATE_CONFIG);
    Config->USBDClientContractVersion = USBDClientContractVersion;
}

WDF_USB_DEVICE_INFORMATION_INIT()

FORCEINLINE VOID WDF_USB_DEVICE_INFORMATION_INIT

(

_Out_ PWDF_USB_DEVICE_INFORMATION

Udi

)

Definition at line 510 of file wdfusb.h.

{
    RtlZeroMemory(Udi, sizeof(WDF_USB_DEVICE_INFORMATION));
    Udi->Size = sizeof(WDF_USB_DEVICE_INFORMATION);
}

WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_DECONFIG()

VOID FORCEINLINE WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_DECONFIG

(

_Out_ PWDF_USB_DEVICE_SELECT_CONFIG_PARAMS

Params

)

Definition at line 680 of file wdfusb.h.

{
    RtlZeroMemory(Params, sizeof(WDF_USB_DEVICE_SELECT_CONFIG_PARAMS));
 
    Params->Size = sizeof(WDF_USB_DEVICE_SELECT_CONFIG_PARAMS);
    Params->Type = WdfUsbTargetDeviceSelectConfigTypeDeconfig;
}

WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_INTERFACES_DESCRIPTORS()

FORCEINLINE VOID WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_INTERFACES_DESCRIPTORS	(	_Out_ PWDF_USB_DEVICE_SELECT_CONFIG_PARAMS	Params,
		_In_ PUSB_CONFIGURATION_DESCRIPTOR	ConfigDescriptor,
		_In_ PUSB_INTERFACE_DESCRIPTOR *	InterfaceDescriptors,
		_In_ ULONG	NumInterfaceDescriptors
	)

Definition at line 647 of file wdfusb.h.

{
    RtlZeroMemory(Params, sizeof(WDF_USB_DEVICE_SELECT_CONFIG_PARAMS));
 
    Params->Size = sizeof(WDF_USB_DEVICE_SELECT_CONFIG_PARAMS);
    Params->Type = WdfUsbTargetDeviceSelectConfigTypeInterfacesDescriptor;
    Params->Types.Descriptor.ConfigurationDescriptor = ConfigDescriptor;
    Params->Types.Descriptor.InterfaceDescriptors = InterfaceDescriptors;
    Params->Types.Descriptor.NumInterfaceDescriptors = NumInterfaceDescriptors;
}

WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_MULTIPLE_INTERFACES()

FORCEINLINE VOID WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_MULTIPLE_INTERFACES	(	_Out_ PWDF_USB_DEVICE_SELECT_CONFIG_PARAMS	Params,
		_In_opt_ UCHAR	NumberInterfaces,
		_In_opt_ PWDF_USB_INTERFACE_SETTING_PAIR	SettingPairs
	)

Definition at line 624 of file wdfusb.h.

{
    RtlZeroMemory(Params, sizeof(WDF_USB_DEVICE_SELECT_CONFIG_PARAMS));
 
    Params->Size = sizeof(WDF_USB_DEVICE_SELECT_CONFIG_PARAMS);
 
    if (SettingPairs != NULL && NumberInterfaces != 0) {
        Params->Type = WdfUsbTargetDeviceSelectConfigTypeInterfacesPairs;
 
        Params->Types.MultiInterface.NumberInterfaces = NumberInterfaces;
        Params->Types.MultiInterface.Pairs = SettingPairs;
    }
    else {
        Params->Type = WdfUsbTargetDeviceSelectConfigTypeMultiInterface;
    }
}

WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_SINGLE_INTERFACE()

FORCEINLINE VOID WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_SINGLE_INTERFACE

(

_Out_ PWDF_USB_DEVICE_SELECT_CONFIG_PARAMS

Params

)

Definition at line 612 of file wdfusb.h.

{
    RtlZeroMemory(Params, sizeof(WDF_USB_DEVICE_SELECT_CONFIG_PARAMS));
 
    Params->Size = sizeof(WDF_USB_DEVICE_SELECT_CONFIG_PARAMS);
    Params->Type = WdfUsbTargetDeviceSelectConfigTypeSingleInterface;
}

WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_URB()

FORCEINLINE VOID WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_URB	(	_Out_ PWDF_USB_DEVICE_SELECT_CONFIG_PARAMS	Params,
		_In_ PURB	Urb
	)

Definition at line 665 of file wdfusb.h.

{
    RtlZeroMemory(Params, sizeof(WDF_USB_DEVICE_SELECT_CONFIG_PARAMS));
 
    Params->Size = sizeof(WDF_USB_DEVICE_SELECT_CONFIG_PARAMS);
    Params->Type = WdfUsbTargetDeviceSelectConfigTypeUrb;
    Params->Types.Urb.Urb = Urb;
}

WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_DESCRIPTOR()

FORCEINLINE VOID WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_DESCRIPTOR	(	_Out_ PWDF_USB_INTERFACE_SELECT_SETTING_PARAMS	Params,
		_In_ PUSB_INTERFACE_DESCRIPTOR	Interface
	)

Definition at line 735 of file wdfusb.h.

{
    RtlZeroMemory(Params, sizeof(WDF_USB_INTERFACE_SELECT_SETTING_PARAMS));
 
    Params->Size = sizeof(WDF_USB_INTERFACE_SELECT_SETTING_PARAMS);
    Params->Type = WdfUsbInterfaceSelectSettingTypeDescriptor;
    Params->Types.Descriptor.InterfaceDescriptor = Interface;
}

WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_SETTING()

FORCEINLINE VOID WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_SETTING	(	_Out_ PWDF_USB_INTERFACE_SELECT_SETTING_PARAMS	Params,
		_In_ UCHAR	SettingIndex
	)

Definition at line 763 of file wdfusb.h.

{
    RtlZeroMemory(Params, sizeof(WDF_USB_INTERFACE_SELECT_SETTING_PARAMS));
 
    Params->Size = sizeof(WDF_USB_INTERFACE_SELECT_SETTING_PARAMS);
    Params->Type = WdfUsbInterfaceSelectSettingTypeSetting;
    Params->Types.Interface.SettingIndex = SettingIndex;
}

WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_URB()

FORCEINLINE VOID WDF_USB_INTERFACE_SELECT_SETTING_PARAMS_INIT_URB	(	_Out_ PWDF_USB_INTERFACE_SELECT_SETTING_PARAMS	Params,
		_In_ PURB	Urb
	)

Definition at line 749 of file wdfusb.h.

{
    RtlZeroMemory(Params, sizeof(WDF_USB_INTERFACE_SELECT_SETTING_PARAMS));
 
    Params->Size = sizeof(WDF_USB_INTERFACE_SELECT_SETTING_PARAMS);
    Params->Type = WdfUsbInterfaceSelectSettingTypeUrb;
    Params->Types.Urb.Urb = Urb;
}

WDF_USB_PIPE_DIRECTION_IN()

FORCEINLINE BOOLEAN WDF_USB_PIPE_DIRECTION_IN

(

_In_ UCHAR

EndpointAddress

)

Definition at line 834 of file wdfusb.h.

{
    //
    // If the high bit is set, we have an IN pipe
    //
    return (EndpointAddress & USB_ENDPOINT_DIRECTION_MASK) ? TRUE : FALSE;
}

WDF_USB_PIPE_DIRECTION_OUT()

FORCEINLINE BOOLEAN WDF_USB_PIPE_DIRECTION_OUT

(

_In_ UCHAR

EndpointAddress

)

Definition at line 846 of file wdfusb.h.

{
    //
    // If the high bit is clear, we have an OUT pipe
    //
    return (EndpointAddress & USB_ENDPOINT_DIRECTION_MASK) == 0x00 ? TRUE : FALSE;
}

WDF_USB_PIPE_INFORMATION_INIT()

FORCEINLINE VOID WDF_USB_PIPE_INFORMATION_INIT

(

_Out_ PWDF_USB_PIPE_INFORMATION

Info

)

Definition at line 823 of file wdfusb.h.

{
    RtlZeroMemory(Info, sizeof(WDF_USB_PIPE_INFORMATION));
 
    Info->Size = sizeof(WDF_USB_PIPE_INFORMATION);
}

WdfUsbTargetDeviceGetIoTarget()

FORCEINLINE WDFIOTARGET WdfUsbTargetDeviceGetIoTarget

(

_In_ WDFUSBDEVICE

UsbDevice

)

Definition at line 478 of file wdfusb.h.

{
    return (WDFIOTARGET) UsbDevice;
}

WdfUsbTargetPipeGetIoTarget()

FORCEINLINE WDFIOTARGET WdfUsbTargetPipeGetIoTarget

(

_In_ WDFUSBPIPE

Pipe

)

Definition at line 777 of file wdfusb.h.

{
    return (WDFIOTARGET) Pipe;
}