classlib.cpp File Reference

#include "ucx01000.h"
#include <debug.h>

Include dependency graph for classlib.cpp:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
static ULONG NTAPI	UcxTableEntriesForMinor (_In_ ULONG Minor)
	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS NTAPI UcxOnClassLoad(VOID)
	Sends a synchronous IOCTL to the specified device object.
	PAGED_CODE ()
	if (ClientGlobals==NULL) return STATUS_INVALID_PARAMETER
	if (ClassBindInfo->Version.Major !=UCX_CLASS_MAJOR_VERSION||Minor > UCX_CLASS_MINOR_VERSION)
	if (ClassBindInfo->FunctionTableCount !=UcxTableEntriesForMinor(Minor))
	if (Globals==NULL) return STATUS_INSUFFICIENT_RESOURCES
	RtlCopyMemory (ClassBindInfo->FunctionTable, UcxExportTable, ClassBindInfo->FunctionTableCount *sizeof(UcxExportTable[0]))
	UNREFERENCED_PARAMETER (ComponentGlobals)

Variables
static PFN_UCXFUNC	UcxExportTable [UcxFunctionTableNumEntries]
WDF_CLASS_LIBRARY_INFO	UcxClassLibraryInfo
_Out_ PWDF_COMPONENT_GLOBALS *	ComponentGlobals
PUCX_DRIVER_GLOBALS	Globals = (PUCX_DRIVER_GLOBALS)ExAllocatePoolZero(NonPagedPool, sizeof(*Globals), UCX_POOL_TAG)
ULONG	Minor = ClassBindInfo->Version.Minor
	ClientGlobals = (PUCX_DRIVER_GLOBALS *)ClassBindInfo->ClassBindInfo
Globals	Size = sizeof(*Globals)
Globals	WdfDriverGlobals = (PWDF_DRIVER_GLOBALS)ComponentGlobals
return	STATUS_SUCCESS

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 10 of file classlib.cpp.

Function Documentation

_IRQL_requires_()

_IRQL_requires_

(

PASSIVE_LEVEL

)

Sends a synchronous IOCTL to the specified device object.

Parameters

[in]	IoControlCode	The IOCTL to send to the device.
[in]	DeviceObject	Pointer to the device object that will handle the IOCTL.
[in]	InputBuffer	Optional pointer to a buffer containing input data for the IOCTL. When specified, the buffer should be at least of InputBufferLength size.
[in]	InputBufferLength	Size in bytes, of the buffer pointed by InputBuffer.
[out]	OutputBuffer	Optional pointer to a buffer that will receive output data from the IOCTL. When specified, the buffer should be at least of OutputBufferLength size.
[in]	OutputBufferLength	Size in bytes, of the buffer pointed by OutputBuffer.
[in]	FileObject	Optional pointer to a file object that may be necessary for the IOCTL.

Returns

An NTSTATUS code indicating success or failure of this function.

Note

Must be called at PASSIVE_LEVEL with all APCs enabled.

Definition at line 44 of file classlib.cpp.

{
    PFN_UCXFUNC *Table = UcxExportTable;
 
    PAGED_CODE();
 
    Table[UcxIoDeviceControlTableIndex] = (PFN_UCXFUNC)UcxApiIoDeviceControl;
    Table[UcxControllerCreateTableIndex] = (PFN_UCXFUNC)UcxApiControllerCreate;
    Table[UcxControllerNeedsResetTableIndex] = (PFN_UCXFUNC)UcxApiControllerNeedsReset;
    Table[UcxControllerResetCompleteTableIndex] = (PFN_UCXFUNC)UcxApiControllerResetComplete;
    Table[UcxControllerSetFailedTableIndex] = (PFN_UCXFUNC)UcxApiControllerSetFailed;
    Table[UcxRootHubCreateTableIndex] = (PFN_UCXFUNC)UcxApiRootHubCreate;
    Table[UcxRootHubPortChangedTableIndex] = (PFN_UCXFUNC)UcxApiRootHubPortChanged;
    Table[UcxUsbDeviceCreateTableIndex] = (PFN_UCXFUNC)UcxApiUsbDeviceCreate;
    Table[UcxUsbDeviceInitSetEventCallbacksTableIndex] = (PFN_UCXFUNC)UcxApiUsbDeviceInitSetEventCallbacks;
    Table[UcxUsbDeviceRemoteWakeNotificationTableIndex] = (PFN_UCXFUNC)UcxApiUsbDeviceRemoteWakeNotification;
    Table[UcxEndpointCreateTableIndex] = (PFN_UCXFUNC)UcxApiEndpointCreate;
    Table[UcxEndpointGetStaticStreamsReferencedTableIndex] = (PFN_UCXFUNC)UcxApiEndpointGetStaticStreamsReferenced;
    Table[UcxEndpointNeedToCancelTransfersTableIndex] = (PFN_UCXFUNC)UcxApiEndpointNeedToCancelTransfers;
    Table[UcxEndpointInitSetEventCallbacksTableIndex] = (PFN_UCXFUNC)UcxApiEndpointInitSetEventCallbacks;
    Table[UcxDefaultEndpointInitSetEventCallbacksTableIndex] = (PFN_UCXFUNC)UcxApiDefaultEndpointInitSetEventCallbacks;
    Table[UcxEndpointSetWdfIoQueueTableIndex] = (PFN_UCXFUNC)UcxApiEndpointSetWdfIoQueue;
    Table[UcxEndpointPurgeCompleteTableIndex] = (PFN_UCXFUNC)UcxApiEndpointPurgeComplete;
    Table[UcxEndpointAbortCompleteTableIndex] = (PFN_UCXFUNC)UcxApiEndpointAbortComplete;
    Table[UcxEndpointNoPingResponseErrorTableIndex] = (PFN_UCXFUNC)UcxApiEndpointNoPingResponseError;
    Table[UcxStaticStreamsSetStreamInfoTableIndex] = (PFN_UCXFUNC)UcxApiStaticStreamsSetStreamInfo;
    Table[UcxStaticStreamsCreateTableIndex] = (PFN_UCXFUNC)UcxApiStaticStreamsCreate;
    Table[UcxInitializeDeviceInitTableIndex] = (PFN_UCXFUNC)UcxApiInitializeDeviceInit;
    Table[UcxControllerSetIdStringsTableIndex] = (PFN_UCXFUNC)UcxApiControllerSetIdStrings;
    Table[UcxControllerNotifyTransportCharacteristicsChangeTableIndex] =
        (PFN_UCXFUNC)UcxApiControllerNotifyTransportCharacteristicsChange;
 
    return STATUS_SUCCESS;
}

if() [1/4]

if

(

ClassBindInfo->FunctionTableCount !

= UcxTableEntriesForMinor(Minor)

)

Definition at line 121 of file classlib.cpp.

    {
        DPRINT1("UCX 1.%lu client has %lu table slots\n", Minor, ClassBindInfo->FunctionTableCount);
        return STATUS_INVALID_PARAMETER;
    }

if() [2/4]

if	(	ClassBindInfo->Version.Major !	= UCX_CLASS_MAJOR_VERSION || Minor,
		UCX_CLASS_MINOR_VERSION
	)

Definition at line 111 of file classlib.cpp.

    {
        DPRINT1("Client wants UCX %lu.%lu, have %u.%u\n",
                ClassBindInfo->Version.Major,
                Minor,
                UCX_CLASS_MAJOR_VERSION,
                UCX_CLASS_MINOR_VERSION);
        return STATUS_REVISION_MISMATCH;
    }

if() [3/4]

if

(

ClientGlobals

= =NULL

)

if() [4/4]

if

(

Globals

= =NULL

)

PAGED_CODE()

PAGED_CODE

(

)

Referenced by _IRQL_requires_().

RtlCopyMemory()

RtlCopyMemory	(	ClassBindInfo->	FunctionTable,
		UcxExportTable	,
		ClassBindInfo->FunctionTableCount *	sizeofUcxExportTable[0]
	)

UcxTableEntriesForMinor()

static ULONG NTAPI UcxTableEntriesForMinor ( _In_ ULONG  Minor )

static

Definition at line 31 of file classlib.cpp.

{
    if (Minor >= 4)
        return UcxFunctionTableNumEntries;
 
    /* SetIdStrings arrived in 1.3 */
    if (Minor == 3)
        return UcxControllerSetIdStringsTableIndex + 1;
 
    return UcxInitializeDeviceInitTableIndex + 1;
}

UNREFERENCED_PARAMETER()

UNREFERENCED_PARAMETER

(

ComponentGlobals

)

Variable Documentation

ClientGlobals

* ClientGlobals = (PUCX_DRIVER_GLOBALS *)ClassBindInfo->ClassBindInfo

Definition at line 103 of file classlib.cpp.

Referenced by WdfVersionBindClass().

ComponentGlobals

_In_ PWDF_COMPONENT_GLOBALS * ComponentGlobals

Initial value:

{
    PUCX_DRIVER_GLOBALS *ClientGlobals

Definition at line 95 of file classlib.cpp.

Referenced by WdfVersionBind(), and WdfVersionUnbind().

Globals

Globals = (PUCX_DRIVER_GLOBALS)ExAllocatePoolZero(NonPagedPool, sizeof(*Globals), UCX_POOL_TAG)

Definition at line 98 of file classlib.cpp.

Minor

Minor = ClassBindInfo->Version.Minor

Definition at line 99 of file classlib.cpp.

Referenced by GetVersionInformationFromInfFile(), HalpDispatchPnp(), if(), IsOsVersionGreaterThanOrEqualTo(), _FX_DRIVER_GLOBALS::IsVerificationEnabled(), _FX_DRIVER_GLOBALS::IsVersionGreaterThanOrEqualTo(), QueryAvailableFileSystemFormat(), RamdiskPnp(), TreeView_Set3StateCheck(), UcxTableEntriesForMinor(), USBH_FdoPnP(), USBH_FdoPower(), USBH_PdoPnP(), USBH_PdoPower(), USBPORT_FdoPnP(), USBPORT_PdoPnP(), VgaInterpretCmdStream(), WdmlibRtlIsNtDdiVersionAvailable(), and WsProcSetVersion().

Size

Globals Size = sizeof(*Globals)

Definition at line 131 of file classlib.cpp.

STATUS_SUCCESS

return STATUS_SUCCESS

Definition at line 139 of file classlib.cpp.

Referenced by _IRQL_requires_().

UcxClassLibraryInfo

WDF_CLASS_LIBRARY_INFO UcxClassLibraryInfo

Initial value:

=
{
    sizeof(UcxClassLibraryInfo),
    { UCX_CLASS_MAJOR_VERSION, UCX_CLASS_MINOR_VERSION, 0 },
    UcxOnClassLoad,
    UcxOnClassUnload,
    UcxOnClientBind,
    UcxOnClientUnbind
}

Definition at line 17 of file classlib.cpp.

Referenced by DriverEntry().

UcxExportTable

PFN_UCXFUNC UcxExportTable[UcxFunctionTableNumEntries]

static

Definition at line 13 of file classlib.cpp.

Referenced by _IRQL_requires_().

WdfDriverGlobals

Globals WdfDriverGlobals = (PWDF_DRIVER_GLOBALS)ComponentGlobals

Definition at line 132 of file classlib.cpp.

Referenced by _IRQL_requires_max_(), _Outptr_opt_result_bytebuffer_(), _Success_(), _When_(), FxLibraryCommonRegisterClient(), FxLibraryCommonUnregisterClient(), WDF_LIBRARY_REGISTER_CLIENT(), WDF_LIBRARY_UNREGISTER_CLIENT(), WdfDriverMiniportUnload(), WdfGetDriver(), WdfGetTriageInfo(), WdfInterruptGetDevice(), WdfInterruptQueueDpcForIsr(), WdfInterruptQueueWorkItemForIsr(), WdfInterruptWdmGetInterrupt(), WdfObjectAllocateContext(), WdfObjectContextGetObject(), WdfObjectDereferenceActual(), WdfObjectGetTypedContextWorker(), WdfObjectReferenceActual(), WdfRequestSend(), WdfVerifierDbgBreakPoint(), WdfVerifierKeBugCheck(), and WdfWaitLockAcquire().