ReactOS 0.4.17-dev-1371-g303d27d
usbdclient.h
Go to the documentation of this file.
1/*
2 * PROJECT: ReactOS USB 3 stack
3 * LICENSE: MIT (https://spdx.org/licenses/MIT)
4 * PURPOSE: Client handle interface between usbd and the USB controller extension
5 * COPYRIGHT: Copyright 2026 Justin Miller <justin.miller@reactos.org>
6 */
7
8#pragma once
9
10#ifdef __cplusplus
11extern "C" {
12#endif
13
14/* {DEEE98EA-C0A1-42C3-9738-A04606C84E93} */
15DEFINE_GUID(GUID_USBD_CLIENT_INTERFACE,
16 0xdeee98ea, 0xc0a1, 0x42c3, 0x97, 0x38, 0xa0, 0x46, 0x06, 0xc8, 0x4e, 0x93);
17
18#define USBD_CLIENT_INTERFACE_VERSION 0x602
19
20DECLARE_HANDLE(USBD_CLIENT_HANDLE);
21
22typedef
25 _In_ USBD_CLIENT_HANDLE Handle);
26
27typedef
31 _In_ USBD_CLIENT_HANDLE Handle,
33
34typedef
38 _In_ USBD_CLIENT_HANDLE Handle,
41
42typedef
46 _In_ USBD_CLIENT_HANDLE Handle,
50
51typedef
55 _In_ USBD_CLIENT_HANDLE Handle,
59
60typedef
63 _In_ PURB Urb);
64
66{
68
69 /* Filled by the requester */
71 USBD_CLIENT_HANDLE Handle;
82
83 /* Filled by the controller extension */
91
92#ifdef _WIN64
93C_ASSERT(sizeof(USBD_CLIENT_INTERFACE) == 0x98);
94#else
96#endif
97
98/* Version 0x603 appends secure isoch and endpoint offload entries */
99
100#define USBD_CLIENT_INTERFACE_VERSION_603 0x603
101
102typedef
106 _In_ USBD_CLIENT_HANDLE Handle,
109 _In_ ULONG OffloadedEndpoints,
110 _Outptr_ PURB* Urb);
111
112typedef
116 _In_ USBD_CLIENT_HANDLE Handle,
117 _In_ USBD_PIPE_HANDLE PipeHandle,
119 _Outptr_ PURB* Urb);
120
122{
124
125 /* Present from size USBD_CLIENT_INTERFACE_603_SIZE_SECURE */
128
129 /* Present from sizeof(USBD_CLIENT_INTERFACE_603) */
135
136#define USBD_CLIENT_INTERFACE_603_SIZE_SECURE \
137 (FIELD_OFFSET(USBD_CLIENT_INTERFACE_603, OffloadSelectInterfaceXrbAllocate))
138
139#ifdef _WIN64
141C_ASSERT(sizeof(USBD_CLIENT_INTERFACE_603) == 0xC8);
142#else
145#endif
146
147#ifdef __cplusplus
148}
149#endif
#define VOID
Definition: acefi.h:82
_In_ D3DDDI_VIDEO_PRESENT_TARGET_ID _In_ ULONG _In_ ULONG Flags
Definition: dispmprt.h:245
#define NTSTATUS
Definition: precomp.h:19
ULONG Handle
Definition: gdb_input.c:15
#define C_ASSERT(e)
Definition: intsafe.h:73
#define DECLARE_HANDLE(name)
Definition: mimeole.idl:23
_Must_inspect_result_ _Out_ PNDIS_STATUS _Out_ PNDIS_HANDLE ConfigurationHandle
Definition: ndis.h:3947
#define _Inout_
Definition: no_sal2.h:162
#define _Outptr_
Definition: no_sal2.h:262
#define _Must_inspect_result_
Definition: no_sal2.h:62
#define _In_
Definition: no_sal2.h:158
#define DEFINE_GUID(name, l, w1, w2, b1, b2, b3, b4, b5, b6, b7, b8)
Definition: guiddef.h:68
Definition: usb.h:565
PFN_USBD_CLIENT_OFFLOAD_SELECT_XRB_ALLOCATE OffloadSelectInterfaceXrbAllocate
Definition: usbdclient.h:130
USBD_CLIENT_INTERFACE Base
Definition: usbdclient.h:123
PFN_USBD_CLIENT_OFFLOAD_NOTIFY_XRB_ALLOCATE OffloadNotificationXrbAllocate
Definition: usbdclient.h:132
PFN_USBD_CLIENT_ISOCH_XRB_ALLOCATE SecureIsochXrbAllocate
Definition: usbdclient.h:126
ULONG VerifierStaticStreamCountOverride
Definition: usbdclient.h:79
PFN_USBD_CLIENT_XRB_FREE ReleaseUrb
Definition: usbdclient.h:89
ULONG VerifierFailStaticStreamSupport
Definition: usbdclient.h:78
PFN_USBD_CLIENT_ISOCH_XRB_ALLOCATE AllocIsochUrb
Definition: usbdclient.h:86
PFN_USBD_CLIENT_UNREGISTER Unregister
Definition: usbdclient.h:84
PFN_USBD_CLIENT_XRB_ALLOCATE AllocUrb
Definition: usbdclient.h:85
PDEVICE_OBJECT DeviceObject
Definition: usbdclient.h:72
USBD_CLIENT_HANDLE Handle
Definition: usbdclient.h:71
PFN_USBD_CLIENT_SELECT_INTERFACE_XRB_BUILD AllocSelectInterfaceUrb
Definition: usbdclient.h:88
ULONG VerifierFailEnableStaticStreams
Definition: usbdclient.h:80
ULONG VerifierFailChainedMdlSupport
Definition: usbdclient.h:77
ULONG VerifierFailRegistration
Definition: usbdclient.h:76
PFN_USBD_CLIENT_SELECT_XRB_BUILD AllocSelectConfigUrb
Definition: usbdclient.h:87
Definition: usbdlib.h:7
#define NTAPI
Definition: typedefs.h:36
uint32_t ULONG
Definition: typedefs.h:59
struct _USBD_CLIENT_INTERFACE USBD_CLIENT_INTERFACE
_Must_inspect_result_ NTSTATUS(NTAPI * PFN_USBD_CLIENT_SELECT_INTERFACE_XRB_BUILD)(_In_ USBD_CLIENT_HANDLE Handle, _In_ USBD_CONFIGURATION_HANDLE ConfigurationHandle, _In_ PUSBD_INTERFACE_LIST_ENTRY InterfaceListEntry, _Outptr_ PURB *Urb)
Definition: usbdclient.h:54
_Must_inspect_result_ NTSTATUS(NTAPI * PFN_USBD_CLIENT_ISOCH_XRB_ALLOCATE)(_In_ USBD_CLIENT_HANDLE Handle, _In_ ULONG NumberOfIsochPackets, _Outptr_ PURB *Urb)
Definition: usbdclient.h:37
_Must_inspect_result_ NTSTATUS(NTAPI * PFN_USBD_CLIENT_OFFLOAD_NOTIFY_XRB_ALLOCATE)(_In_ USBD_CLIENT_HANDLE Handle, _In_ USBD_PIPE_HANDLE PipeHandle, _In_ ULONG Flags, _Outptr_ PURB *Urb)
Definition: usbdclient.h:115
VOID(NTAPI * PFN_USBD_CLIENT_XRB_FREE)(_In_ PURB Urb)
Definition: usbdclient.h:62
_Must_inspect_result_ NTSTATUS(NTAPI * PFN_USBD_CLIENT_SELECT_XRB_BUILD)(_In_ USBD_CLIENT_HANDLE Handle, _In_ PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor, _In_ PUSBD_INTERFACE_LIST_ENTRY InterfaceList, _Outptr_ PURB *Urb)
Definition: usbdclient.h:45
_Must_inspect_result_ NTSTATUS(NTAPI * PFN_USBD_CLIENT_XRB_ALLOCATE)(_In_ USBD_CLIENT_HANDLE Handle, _Outptr_ PURB *Urb)
Definition: usbdclient.h:30
struct _USBD_CLIENT_INTERFACE_603 * PUSBD_CLIENT_INTERFACE_603
struct _USBD_CLIENT_INTERFACE * PUSBD_CLIENT_INTERFACE
_Must_inspect_result_ NTSTATUS(NTAPI * PFN_USBD_CLIENT_OFFLOAD_SELECT_XRB_ALLOCATE)(_In_ USBD_CLIENT_HANDLE Handle, _In_ USBD_CONFIGURATION_HANDLE ConfigurationHandle, _Inout_ PUSBD_INTERFACE_LIST_ENTRY InterfaceListEntry, _In_ ULONG OffloadedEndpoints, _Outptr_ PURB *Urb)
Definition: usbdclient.h:105
struct _USBD_CLIENT_INTERFACE_603 USBD_CLIENT_INTERFACE_603
#define USBD_CLIENT_INTERFACE_603_SIZE_SECURE
Definition: usbdclient.h:136
VOID(NTAPI * PFN_USBD_CLIENT_UNREGISTER)(_In_ USBD_CLIENT_HANDLE Handle)
Definition: usbdclient.h:24
_In_opt_ PUSB_CONFIGURATION_DESCRIPTOR ConfigurationDescriptor
Definition: usbdlib.h:331
_In_ PUSBD_INTERFACE_LIST_ENTRY InterfaceList
Definition: usbdlib.h:208
_In_ USBD_CONFIGURATION_HANDLE _Inout_ PUSBD_INTERFACE_LIST_ENTRY InterfaceListEntry
Definition: usbdlib.h:342
_In_opt_ PUSB_CONFIGURATION_DESCRIPTOR _Inout_ PUSBD_INTERFACE_LIST_ENTRY _Outptr_ PURB * Urb
Definition: usbdlib.h:333
_Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ ULONG NumberOfIsochPackets
Definition: wdfusb.h:1703