ReactOS 0.4.17-dev-1371-g303d27d
classlib.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: KMDF class library registration and client binding
5 * COPYRIGHT: Copyright 2026 Justin Miller <justin.miller@reactos.org>
6 */
7
8#include "ucx01000.h"
9
10#define NDEBUG
11#include <debug.h>
12
13extern "C"
14{
16{
17 sizeof(UcxClassLibraryInfo),
19 UcxOnClassLoad,
20 UcxOnClassUnload,
21 UcxOnClientBind,
22 UcxOnClientUnbind
23};
24}
25
26static
31{
32 if (Minor >= 4)
34
35 /* SetIdStrings arrived in 1.3 */
36 if (Minor == 3)
38
40}
41
45UcxOnClassLoad(VOID)
46{
47 PAGED_CODE();
48
49 DPRINT("Class library initialize\n");
51 return STATUS_SUCCESS;
52}
53
55VOID
57UcxOnClassUnload(VOID)
58{
59 PAGED_CODE();
60
61 DPRINT("Class library deinitialize\n");
62}
63
67UcxOnClientBind(
68 _In_ PWDF_CLASS_BIND_INFO ClassBindInfo,
70{
74
76
77 ClientGlobals = (PUCX_DRIVER_GLOBALS *)ClassBindInfo->ClassBindInfo;
79 {
80 DPRINT1("Client bind info %p has no globals slot\n", ClassBindInfo);
82 }
83
84 /* KMDF unbinds even after a failed bind, so clear the slot up front */
86
87 Minor = ClassBindInfo->Version.Minor;
88 if (ClassBindInfo->Version.Major != UCX_CLASS_MAJOR_VERSION || Minor > UCX_CLASS_MINOR_VERSION)
89 {
90 DPRINT1("Client wants UCX %lu.%lu, have %u.%u\n",
91 ClassBindInfo->Version.Major, Minor, UCX_CLASS_MAJOR_VERSION, UCX_CLASS_MINOR_VERSION);
93 }
94
95 if (ClassBindInfo->FunctionTableCount != UcxTableEntriesForMinor(Minor))
96 {
97 DPRINT1("UCX 1.%lu client has %lu table slots\n", Minor, ClassBindInfo->FunctionTableCount);
99 }
100
101 /* Filled even if the allocation below fails */
102 RtlCopyMemory(ClassBindInfo->FunctionTable,
104 ClassBindInfo->FunctionTableCount * sizeof(UcxExportTable[0]));
105
107 if (Globals == NULL)
108 {
109 DPRINT1("Client globals allocation failed\n");
111 }
112
113 Globals->Size = sizeof(*Globals);
115
116 DPRINT("Bound UCX 1.%lu client, globals %p\n", Minor, Globals);
119}
120
122VOID
123NTAPI
124UcxOnClientUnbind(
125 _In_ PWDF_CLASS_BIND_INFO ClassBindInfo,
127{
129
130 PAGED_CODE();
132
133 ClientGlobals = (PUCX_DRIVER_GLOBALS *)ClassBindInfo->ClassBindInfo;
135 return;
136
137 DPRINT("Unbinding client globals %p\n", *ClientGlobals);
140}
LONG NTSTATUS
Definition: precomp.h:26
#define DPRINT1
Definition: precomp.h:8
ULONG Minor
Definition: classlib.cpp:73
ClientGlobals
Definition: classlib.cpp:77
PUCX_DRIVER_GLOBALS Globals
Definition: classlib.cpp:72
_Outptr_ PWDF_COMPONENT_GLOBALS * ComponentGlobals
Definition: classlib.cpp:70
PAGED_CODE()
WDF_CLASS_LIBRARY_INFO UcxClassLibraryInfo
Definition: classlib.cpp:15
return STATUS_SUCCESS
Definition: classlib.cpp:118
static ULONG NTAPI UcxTableEntriesForMinor(_In_ ULONG Minor)
Definition: classlib.cpp:29
#define NULL
Definition: types.h:112
#define _IRQL_requires_(irql)
Definition: driverspecs.h:229
#define PASSIVE_LEVEL
Definition: env_spec_w32.h:693
#define NonPagedPool
Definition: env_spec_w32.h:307
VOID NTAPI UcxBuildExportTable(VOID)
Definition: exports.cpp:353
PFN_UCXFUNC UcxExportTable[UcxFunctionTableNumEntries]
Definition: exports.cpp:19
if(dx< 0)
Definition: linetemp.h:194
#define ExFreePoolWithTag(_P, _T)
Definition: module.h:1109
static PVOID ExAllocatePoolZero(ULONG PoolType, SIZE_T NumberOfBytes, ULONG Tag)
Definition: precomp.h:45
#define _Outptr_
Definition: no_sal2.h:262
#define _In_
Definition: no_sal2.h:158
#define UNREFERENCED_PARAMETER(P)
Definition: ntbasedef.h:329
#define DPRINT
Definition: sndvol32.h:73
#define NTAPI
Definition: typedefs.h:36
#define RtlCopyMemory(Destination, Source, Length)
Definition: typedefs.h:263
uint32_t ULONG
Definition: typedefs.h:59
#define UCX_CLASS_MAJOR_VERSION
Definition: ucx01000.h:43
#define UCX_CLASS_MINOR_VERSION
Definition: ucx01000.h:44
@ UcxControllerSetIdStringsTableIndex
Definition: ucxfuncenum.h:35
@ UcxFunctionTableNumEntries
Definition: ucxfuncenum.h:37
@ UcxInitializeDeviceInitTableIndex
Definition: ucxfuncenum.h:34
WDF_EXTERN_C_START struct _UCX_DRIVER_GLOBALS * PUCX_DRIVER_GLOBALS
#define UCX_POOL_TAG
Definition: ucxutil.h:11
#define STATUS_INVALID_PARAMETER
Definition: udferr_usr.h:135
#define STATUS_INSUFFICIENT_RESOURCES
Definition: udferr_usr.h:158
struct _WDF_DRIVER_GLOBALS * PWDF_DRIVER_GLOBALS