ReactOS 0.4.17-dev-1371-g303d27d
exports.cpp
Go to the documentation of this file.
1/*
2 * PROJECT: ReactOS USB Host Controller Extension
3 * LICENSE: MIT (https://spdx.org/licenses/MIT)
4 * PURPOSE: Class functions exported to UCX clients
5 * COPYRIGHT: Copyright 2026 Justin Miller <justin.miller@reactos.org>
6 */
7
8/*
9 * The public names belong to the client side inline thunks, so the
10 * implementations here carry a UcxApi prefix. Each one only finds the object
11 * and forwards; the globals argument is ignored except by controller create.
12 */
13
14#include "ucx01000.h"
15
16#define NDEBUG
17#include <debug.h>
18
20
22static
26 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
27 _In_ WDFDEVICE Device,
28 _In_ WDFREQUEST Request,
32{
33 UNREFERENCED_PARAMETER(DriverGlobals);
34
36}
37
39static
43 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
44 _In_ WDFDEVICE Device,
47 _Out_ UCXCONTROLLER* Controller)
48{
50}
51
52static
53VOID
56 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
57 _In_ UCXCONTROLLER Controller)
58{
59 UNREFERENCED_PARAMETER(DriverGlobals);
60
62}
63
64static
65VOID
68 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
69 _In_ UCXCONTROLLER Controller,
71{
72 UNREFERENCED_PARAMETER(DriverGlobals);
73
75}
76
77static
78VOID
81 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
82 _In_ UCXCONTROLLER Controller)
83{
84 UNREFERENCED_PARAMETER(DriverGlobals);
85
87}
88
90static
94 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
95 _In_ UCXCONTROLLER Controller,
98 _Out_ UCXROOTHUB* RootHub)
99{
100 UNREFERENCED_PARAMETER(DriverGlobals);
101
102 return UcxRootHub::Create(Controller, Config, Attributes, RootHub);
103}
104
105static
106VOID
107NTAPI
109 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
110 _In_ UCXROOTHUB RootHub)
111{
112 UNREFERENCED_PARAMETER(DriverGlobals);
113
114 UcxRootHub::FromHandle(RootHub)->PortChanged();
115}
116
118static
120NTAPI
122 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
123 _In_ UCXCONTROLLER Controller,
126 _Out_ UCXUSBDEVICE* UsbDevice)
127{
128 UNREFERENCED_PARAMETER(DriverGlobals);
129
130 return UcxUsbDevice::Create(Controller, Init, Attributes, UsbDevice);
131}
132
133static
134VOID
135NTAPI
137 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
140{
141 UNREFERENCED_PARAMETER(DriverGlobals);
142
143 UcxUsbDevice::InitSetEventCallbacks(Init, Callbacks);
144}
145
146static
147VOID
148NTAPI
150 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
151 _In_ UCXUSBDEVICE UsbDevice,
153{
154 UNREFERENCED_PARAMETER(DriverGlobals);
155
156 UcxUsbDevice::FromHandle(UsbDevice)->RemoteWakeNotification(Interface);
157}
158
160static
162NTAPI
164 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
165 _In_ UCXUSBDEVICE UsbDevice,
168 _Out_ UCXENDPOINT* Endpoint)
169{
170 UNREFERENCED_PARAMETER(DriverGlobals);
171
172 return UcxEndpoint::Create(UsbDevice, Init, Attributes, Endpoint);
173}
174
176static
177UCXSSTREAMS
178NTAPI
180 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
181 _In_ UCXENDPOINT Endpoint,
182 _In_ PVOID Tag)
183{
184 UNREFERENCED_PARAMETER(DriverGlobals);
185
186 return UcxEndpoint::FromHandle(Endpoint)->GetStaticStreamsReferenced(Tag);
187}
188
189static
190VOID
191NTAPI
193 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
194 _In_ UCXENDPOINT Endpoint)
195{
196 UNREFERENCED_PARAMETER(DriverGlobals);
197
198 UcxEndpoint::FromHandle(Endpoint)->NeedToCancelTransfers();
199}
200
201static
202VOID
203NTAPI
205 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
208{
209 UNREFERENCED_PARAMETER(DriverGlobals);
210
211 UcxEndpoint::InitSetEventCallbacks(Init, Callbacks);
212}
213
214static
215VOID
216NTAPI
218 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
221{
222 UNREFERENCED_PARAMETER(DriverGlobals);
223
224 UcxEndpoint::InitSetDefaultEventCallbacks(Init, Callbacks);
225}
226
227static
228VOID
229NTAPI
231 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
232 _In_ UCXENDPOINT Endpoint,
233 _In_ WDFQUEUE Queue)
234{
235 UNREFERENCED_PARAMETER(DriverGlobals);
236
237 UcxEndpoint::FromHandle(Endpoint)->SetWdfIoQueue(Queue);
238}
239
240/* Valid from inside EvtEndpointPurge */
241static
242VOID
243NTAPI
245 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
246 _In_ UCXENDPOINT Endpoint)
247{
248 UNREFERENCED_PARAMETER(DriverGlobals);
249
250 UcxEndpoint::FromHandle(Endpoint)->Post(EpEvent::PurgeDone);
251}
252
253/* Valid from inside EvtEndpointAbort */
254static
255VOID
256NTAPI
258 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
259 _In_ UCXENDPOINT Endpoint)
260{
261 UNREFERENCED_PARAMETER(DriverGlobals);
262
263 UcxEndpoint::FromHandle(Endpoint)->Post(EpEvent::AbortDone);
264}
265
266/* Consumed by the next failing transfer completion on the device */
267static
268VOID
269NTAPI
271 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
272 _In_ UCXENDPOINT Endpoint)
273{
274 UNREFERENCED_PARAMETER(DriverGlobals);
275
276 UcxEndpoint::FromHandle(Endpoint)->m_Device->m_PendingNoPingResponse = 1;
277}
278
279static
280VOID
281NTAPI
283 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
284 _In_ UCXSSTREAMS StaticStreams,
285 _In_ PSTREAM_INFO StreamInfo)
286{
287 UNREFERENCED_PARAMETER(DriverGlobals);
288
289 UcxStaticStreams::FromHandle(StaticStreams)->SetStreamInfo(StreamInfo);
290}
291
293static
295NTAPI
297 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
298 _In_ UCXENDPOINT Endpoint,
301 _Out_ UCXSSTREAMS* StaticStreams)
302{
303 UNREFERENCED_PARAMETER(DriverGlobals);
304
305 return UcxStaticStreams::Create(Endpoint, Init, Attributes, StaticStreams);
306}
307
308/* Reserved for future preprocess hooks; UCX never touches the HCD's device init */
310static
312NTAPI
314 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
316{
317 UNREFERENCED_PARAMETER(DriverGlobals);
319
320 return STATUS_SUCCESS;
321}
322
323static
325NTAPI
327 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
328 _In_ UCXCONTROLLER Controller,
329 _In_ PUNICODE_STRING Manufacturer,
330 _In_ PUNICODE_STRING ModelName,
331 _In_ PUNICODE_STRING ModelNumber)
332{
333 UNREFERENCED_PARAMETER(DriverGlobals);
334
335 return UcxController::FromHandle(Controller)->SetIdStrings(Manufacturer, ModelName, ModelNumber);
336}
337
338static
339VOID
340NTAPI
342 _In_ PUCX_DRIVER_GLOBALS DriverGlobals,
343 _In_ UCXCONTROLLER Controller,
345{
346 UNREFERENCED_PARAMETER(DriverGlobals);
347
349}
350
351VOID
352NTAPI
354{
356
383}
unsigned char BOOLEAN
Definition: actypes.h:127
LONG NTSTATUS
Definition: precomp.h:26
const struct winhelp_callbacks Callbacks
Definition: callback.c:161
VOID SetFailed()
Definition: hostctl.cpp:439
static _Must_inspect_result_ NTSTATUS Create(_In_ PUCX_DRIVER_GLOBALS Globals, _In_ WDFDEVICE Device, _In_ PUCX_CONTROLLER_CONFIG Config, _In_opt_ PWDF_OBJECT_ATTRIBUTES Attributes, _Out_ UCXCONTROLLER *Controller)
Definition: hostctl.cpp:41
VOID NotifyTransportCharacteristicsChange(_In_ PUCX_CONTROLLER_TRANSPORT_CHARACTERISTICS Characteristics)
Definition: hostctl.cpp:498
NTSTATUS SetIdStrings(_In_ PUNICODE_STRING Manufacturer, _In_ PUNICODE_STRING ModelName, _In_ PUNICODE_STRING ModelNumber)
Definition: hostctl.cpp:453
static UcxController * FromHandle(_In_ UCXCONTROLLER Handle)
Definition: hostctl.cpp:14
VOID NeedsReset()
Definition: hostctl.cpp:415
VOID ResetComplete(_In_ PUCX_CONTROLLER_RESET_COMPLETE_INFO Info)
Definition: hostctl.cpp:422
UCXSSTREAMS GetStaticStreamsReferenced(_In_ PVOID Tag)
Definition: pipe.cpp:370
VOID SetWdfIoQueue(_In_ WDFQUEUE Queue)
Definition: pipe.cpp:313
BOOLEAN Post(_In_ EpEvent Event)
Definition: pipe.h:255
UcxUsbDevice * m_Device
Definition: pipe.h:283
VOID NeedToCancelTransfers()
Definition: pipe.cpp:328
VOID PortChanged()
Definition: rhub.cpp:227
VOID SetStreamInfo(_In_ PSTREAM_INFO StreamInfo)
Definition: pipe.cpp:573
VOID RemoteWakeNotification(_In_ ULONG Interface)
Definition: devobj.cpp:189
LONG m_PendingNoPingResponse
Definition: devobj.h:257
_In_ ULONG Attributes
Definition: dispmprt.h:1077
static VOID NTAPI UcxApiControllerSetFailed(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXCONTROLLER Controller)
Definition: exports.cpp:80
VOID NTAPI UcxBuildExportTable(VOID)
Definition: exports.cpp:353
static VOID NTAPI UcxApiUsbDeviceInitSetEventCallbacks(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _Inout_ PUCXUSBDEVICE_INIT Init, _In_ PUCX_USBDEVICE_EVENT_CALLBACKS Callbacks)
Definition: exports.cpp:136
static _Must_inspect_result_ NTSTATUS NTAPI UcxApiUsbDeviceCreate(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXCONTROLLER Controller, _Inout_ PUCXUSBDEVICE_INIT *Init, _In_opt_ PWDF_OBJECT_ATTRIBUTES Attributes, _Out_ UCXUSBDEVICE *UsbDevice)
Definition: exports.cpp:121
static VOID NTAPI UcxApiControllerNotifyTransportCharacteristicsChange(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXCONTROLLER Controller, _In_ PUCX_CONTROLLER_TRANSPORT_CHARACTERISTICS Characteristics)
Definition: exports.cpp:341
static VOID NTAPI UcxApiEndpointPurgeComplete(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXENDPOINT Endpoint)
Definition: exports.cpp:244
static VOID NTAPI UcxApiControllerResetComplete(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXCONTROLLER Controller, _In_ PUCX_CONTROLLER_RESET_COMPLETE_INFO Info)
Definition: exports.cpp:67
static VOID NTAPI UcxApiControllerNeedsReset(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXCONTROLLER Controller)
Definition: exports.cpp:55
static _Must_inspect_result_ UCXSSTREAMS NTAPI UcxApiEndpointGetStaticStreamsReferenced(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXENDPOINT Endpoint, _In_ PVOID Tag)
Definition: exports.cpp:179
static _Must_inspect_result_ NTSTATUS NTAPI UcxApiStaticStreamsCreate(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXENDPOINT Endpoint, _Inout_ PUCXSSTREAMS_INIT *Init, _In_opt_ PWDF_OBJECT_ATTRIBUTES Attributes, _Out_ UCXSSTREAMS *StaticStreams)
Definition: exports.cpp:296
static _Must_inspect_result_ BOOLEAN NTAPI UcxApiIoDeviceControl(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ WDFDEVICE Device, _In_ WDFREQUEST Request, _In_ size_t OutputBufferLength, _In_ size_t InputBufferLength, _In_ ULONG IoControlCode)
Definition: exports.cpp:25
static VOID NTAPI UcxApiEndpointNeedToCancelTransfers(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXENDPOINT Endpoint)
Definition: exports.cpp:192
static _Must_inspect_result_ NTSTATUS NTAPI UcxApiControllerCreate(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ WDFDEVICE Device, _In_ PUCX_CONTROLLER_CONFIG Config, _In_opt_ PWDF_OBJECT_ATTRIBUTES Attributes, _Out_ UCXCONTROLLER *Controller)
Definition: exports.cpp:42
static _Must_inspect_result_ NTSTATUS NTAPI UcxApiInitializeDeviceInit(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _Inout_ PWDFDEVICE_INIT DeviceInit)
Definition: exports.cpp:313
static NTSTATUS NTAPI UcxApiControllerSetIdStrings(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXCONTROLLER Controller, _In_ PUNICODE_STRING Manufacturer, _In_ PUNICODE_STRING ModelName, _In_ PUNICODE_STRING ModelNumber)
Definition: exports.cpp:326
static _Must_inspect_result_ NTSTATUS NTAPI UcxApiRootHubCreate(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXCONTROLLER Controller, _In_ PUCX_ROOTHUB_CONFIG Config, _In_opt_ PWDF_OBJECT_ATTRIBUTES Attributes, _Out_ UCXROOTHUB *RootHub)
Definition: exports.cpp:93
PFN_UCXFUNC UcxExportTable[UcxFunctionTableNumEntries]
Definition: exports.cpp:19
static VOID NTAPI UcxApiUsbDeviceRemoteWakeNotification(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXUSBDEVICE UsbDevice, _In_ ULONG Interface)
Definition: exports.cpp:149
static VOID NTAPI UcxApiStaticStreamsSetStreamInfo(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXSSTREAMS StaticStreams, _In_ PSTREAM_INFO StreamInfo)
Definition: exports.cpp:282
static VOID NTAPI UcxApiRootHubPortChanged(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXROOTHUB RootHub)
Definition: exports.cpp:108
static _Must_inspect_result_ NTSTATUS NTAPI UcxApiEndpointCreate(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXUSBDEVICE UsbDevice, _Inout_ PUCXENDPOINT_INIT *Init, _In_opt_ PWDF_OBJECT_ATTRIBUTES Attributes, _Out_ UCXENDPOINT *Endpoint)
Definition: exports.cpp:163
static VOID NTAPI UcxApiEndpointAbortComplete(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXENDPOINT Endpoint)
Definition: exports.cpp:257
static VOID NTAPI UcxApiEndpointInitSetEventCallbacks(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _Inout_ PUCXENDPOINT_INIT Init, _In_ PUCX_ENDPOINT_EVENT_CALLBACKS Callbacks)
Definition: exports.cpp:204
static VOID NTAPI UcxApiEndpointNoPingResponseError(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXENDPOINT Endpoint)
Definition: exports.cpp:270
static VOID NTAPI UcxApiDefaultEndpointInitSetEventCallbacks(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _Inout_ PUCXENDPOINT_INIT Init, _In_ PUCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS Callbacks)
Definition: exports.cpp:217
static VOID NTAPI UcxApiEndpointSetWdfIoQueue(_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXENDPOINT Endpoint, _In_ WDFQUEUE Queue)
Definition: exports.cpp:230
ASMGENDATA Table[]
Definition: genincdata.c:61
_In_ UCXUSBDEVICE UsbDevice
Definition: hostctl.h:31
_Must_inspect_result_ _In_ PUCXHUB_DEVICE_CREATE_INFO _Out_ UCXUSBDEVICE * Device
Definition: hubucx.h:258
_In_ UCXHUB_DEVICE_CONTEXT _In_ UCXENDPOINT Endpoint
Definition: hubucx.h:238
#define _Inout_
Definition: no_sal2.h:162
#define _Must_inspect_result_
Definition: no_sal2.h:62
#define _Out_
Definition: no_sal2.h:160
#define _In_
Definition: no_sal2.h:158
#define _In_opt_
Definition: no_sal2.h:212
#define UNREFERENCED_PARAMETER(P)
Definition: ntbasedef.h:329
#define STATUS_SUCCESS
Definition: shellext.h:65
#define NTAPI
Definition: typedefs.h:36
uint32_t ULONG
Definition: typedefs.h:59
_Must_inspect_result_ _In_ WDFDEVICE _In_ WDFREQUEST _In_ size_t _In_ size_t _In_ ULONG IoControlCode
_Must_inspect_result_ _In_ WDFDEVICE _In_ PUCX_CONTROLLER_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ UCXCONTROLLER * Controller
_Must_inspect_result_ _In_ WDFDEVICE _In_ PUCX_CONTROLLER_CONFIG Config
_In_ PGUID _In_ ULONG OutputBufferLength
Definition: ucxcontroller.h:81
_In_ WDFREQUEST _In_ size_t _In_ size_t InputBufferLength
_Must_inspect_result_ _In_ WDFDEVICE _In_ WDFREQUEST Request
_Must_inspect_result_ _In_ UCXENDPOINT _In_ PVOID Tag
Definition: ucxendpoint.h:325
@ UcxIoDeviceControlTableIndex
Definition: ucxfuncenum.h:13
@ UcxControllerSetIdStringsTableIndex
Definition: ucxfuncenum.h:35
@ UcxEndpointInitSetEventCallbacksTableIndex
Definition: ucxfuncenum.h:26
@ UcxEndpointPurgeCompleteTableIndex
Definition: ucxfuncenum.h:29
@ UcxStaticStreamsCreateTableIndex
Definition: ucxfuncenum.h:33
@ UcxEndpointGetStaticStreamsReferencedTableIndex
Definition: ucxfuncenum.h:24
@ UcxRootHubPortChangedTableIndex
Definition: ucxfuncenum.h:19
@ UcxEndpointSetWdfIoQueueTableIndex
Definition: ucxfuncenum.h:28
@ UcxUsbDeviceRemoteWakeNotificationTableIndex
Definition: ucxfuncenum.h:22
@ UcxUsbDeviceCreateTableIndex
Definition: ucxfuncenum.h:20
@ UcxControllerCreateTableIndex
Definition: ucxfuncenum.h:14
@ UcxStaticStreamsSetStreamInfoTableIndex
Definition: ucxfuncenum.h:32
@ UcxEndpointNeedToCancelTransfersTableIndex
Definition: ucxfuncenum.h:25
@ UcxEndpointNoPingResponseErrorTableIndex
Definition: ucxfuncenum.h:31
@ UcxControllerResetCompleteTableIndex
Definition: ucxfuncenum.h:16
@ UcxControllerSetFailedTableIndex
Definition: ucxfuncenum.h:17
@ UcxRootHubCreateTableIndex
Definition: ucxfuncenum.h:18
@ UcxDefaultEndpointInitSetEventCallbacksTableIndex
Definition: ucxfuncenum.h:27
@ UcxEndpointCreateTableIndex
Definition: ucxfuncenum.h:23
@ UcxEndpointAbortCompleteTableIndex
Definition: ucxfuncenum.h:30
@ UcxFunctionTableNumEntries
Definition: ucxfuncenum.h:37
@ UcxUsbDeviceInitSetEventCallbacksTableIndex
Definition: ucxfuncenum.h:21
@ UcxControllerNeedsResetTableIndex
Definition: ucxfuncenum.h:15
@ UcxInitializeDeviceInitTableIndex
Definition: ucxfuncenum.h:34
@ UcxControllerNotifyTransportCharacteristicsChangeTableIndex
Definition: ucxfuncenum.h:36
WDF_EXTERN_C_START struct _UCX_DRIVER_GLOBALS * PUCX_DRIVER_GLOBALS
VOID(NTAPI * PFN_UCXFUNC)(VOID)
Definition: ucxglobals.h:21
_Must_inspect_result_ _In_ UCXCONTROLLER _In_ PUCX_ROOTHUB_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ UCXROOTHUB * RootHub
Definition: ucxroothub.h:299
WDF_EXTERN_C_START struct _STREAM_INFO * PSTREAM_INFO
_Must_inspect_result_ _In_ UCXENDPOINT _Inout_ PUCXSSTREAMS_INIT _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ UCXSSTREAMS * StaticStreams
Definition: ucxsstreams.h:55
_In_ UCXUSBDEVICE _In_ ULONG Interface
Definition: ucxusbdevice.h:428
BOOLEAN NTAPI UcxDispatchUserIoctl(_In_ WDFDEVICE Fdo, _In_ WDFREQUEST Request, _In_ size_t OutputBufferLength, _In_ size_t InputBufferLength, _In_ ULONG IoControlCode)
Definition: userreq.cpp:793
_Must_inspect_result_ _In_ WDFCHILDLIST _In_ PWDF_CHILD_LIST_ITERATOR _Out_ WDFDEVICE _Inout_opt_ PWDF_CHILD_RETRIEVE_INFO Info
Definition: wdfchildlist.h:690
_In_ PWDFDEVICE_INIT DeviceInit
Definition: wdfcontrol.h:113
_Must_inspect_result_ _In_ WDFDEVICE _In_ PIRP _In_ WDFQUEUE Queue
Definition: wdfdevice.h:2231