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

Classes
class	SpinLockGuard

class	DispatchLevelGuard

struct	UcxRequestArgs

struct	UcxDriverState

Macros
#define	UCX_POOL_TAG 'DCHU'

Typedefs
typedef BOOLEAN(NTAPI *	PFN_UCX_IO_TRY_QUEUE_WORKITEM) (_Inout_ PIO_WORKITEM IoWorkItem, _In_ PIO_WORKITEM_ROUTINE_EX WorkerRoutine, _In_ WORK_QUEUE_TYPE QueueType, _In_opt_ PVOID Context)

Functions
PVOID	operator new (_In_ size_t Size, _In_ PVOID Where) noexcept

VOID	operator delete (_In_ PVOID Memory, _In_ PVOID Where) noexcept

FORCEINLINE VOID NTAPI	UcxClearListEntry (_Out_ PLIST_ENTRY Entry)

FORCEINLINE BOOLEAN NTAPI	UcxIsListEntryLinked (_In_ const LIST_ENTRY *Entry)

_Must_inspect_result_ NTSTATUS NTAPI	UcxCreateObjectWithTwoContexts (_In_ PWDF_OBJECT_ATTRIBUTES Primary, _In_opt_ PWDF_OBJECT_ATTRIBUTES Secondary, _Out_ WDFOBJECT *Object)

FORCEINLINE VOID NTAPI	UcxVerifierBreak (_In_ BOOLEAN Verifying)

ULONG NTAPI	UcxRandom (VOID)

BOOLEAN NTAPI	UcxVerifierWantsFailure (_In_ ULONG Setting)

ULONG NTAPI	UcxRandomInRange (_In_ ULONG Max)

NTSTATUS NTAPI	UcxRandomErrorStatus (VOID)

Variables
UcxDriverState	UcxDriver

Macro Definition Documentation

◆ UCX_POOL_TAG

#define UCX_POOL_TAG 'DCHU'

Definition at line 11 of file ucxutil.h.

Typedef Documentation

◆ PFN_UCX_IO_TRY_QUEUE_WORKITEM

typedef BOOLEAN(NTAPI * PFN_UCX_IO_TRY_QUEUE_WORKITEM) (_Inout_ PIO_WORKITEM IoWorkItem, _In_ PIO_WORKITEM_ROUTINE_EX WorkerRoutine, _In_ WORK_QUEUE_TYPE QueueType, _In_opt_ PVOID Context)

Definition at line 133 of file ucxutil.h.

Function Documentation

◆ operator delete()

VOID operator delete	(	_In_ PVOID	Memory,
		_In_ PVOID	Where
	)

inlinenoexcept

Definition at line 26 of file ucxutil.h.

{
    UNREFERENCED_PARAMETER(Memory);
    UNREFERENCED_PARAMETER(Where);
}

◆ operator new()

PVOID operator new	(	_In_ size_t	Size,
		_In_ PVOID	Where
	)

inlinenoexcept

Definition at line 16 of file ucxutil.h.

{
    UNREFERENCED_PARAMETER(Size);
    return Where;
}

◆ UcxClearListEntry()

FORCEINLINE VOID NTAPI UcxClearListEntry ( _Out_ PLIST_ENTRY Entry )

Definition at line 84 of file ucxutil.h.

{
    Entry->Flink = NULL;
    Entry->Blink = NULL;
}

Referenced by EndpointMachine::DeleteEndpoint(), UcxUsbDevice::DeleteFromHub(), UcxController::Destroy(), UcxUsbDevice::DisconnectPort(), UcxUsbDevice::FanOutToEndpoints(), UcxUsbDevice::HandleHubTreePurge(), UcxController::Initialize(), UcxEndpoint::Initialize(), UcxUsbDevice::InitializeLists(), EndpointMachine::ParkAsStale(), UcxClientReleaseUrb(), UcxPostToCollectedEndpoints(), UcxUntrackEndpoint(), and UcxUsbdHandle::Unregister().

◆ UcxCreateObjectWithTwoContexts()

_Must_inspect_result_ NTSTATUS NTAPI UcxCreateObjectWithTwoContexts	(	_In_ PWDF_OBJECT_ATTRIBUTES	Primary,
		_In_opt_ PWDF_OBJECT_ATTRIBUTES	Secondary,
		_Out_ WDFOBJECT *	Object
	)

Creates a WDF object with a primary set of attributes and an optional second context.

Definition at line 19 of file ucxutil.cpp.

{
    WDF_OBJECT_ATTRIBUTES Extra;
    WDFOBJECT Created;
    NTSTATUS Status;
 
    *Object = NULL;
 
    Status = WdfObjectCreate(Primary, &Created);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Object create failed 0x%lx\n", Status);
        return Status;
    }
 
    if (Secondary != NULL && Secondary->ContextTypeInfo != NULL)
    {
        Extra = *Secondary;
        Extra.ParentObject = NULL;
        Extra.ExecutionLevel = WdfExecutionLevelInheritFromParent;
        Extra.SynchronizationScope = WdfSynchronizationScopeInheritFromParent;
 
        Status = WdfObjectAllocateContext(Created, &Extra, NULL);
        if (!NT_SUCCESS(Status))
        {
            DPRINT1("Client context on object %p failed 0x%lx\n", Created, Status);
            WdfObjectDelete(Created);
            return Status;
        }
    }
 
    *Object = Created;
    return STATUS_SUCCESS;
}

Referenced by UcxController::Create(), UcxRootHub::Create(), UcxUsbDevice::Create(), UcxStaticStreams::Create(), and UcxEndpoint::Create().

◆ UcxIsListEntryLinked()

FORCEINLINE BOOLEAN NTAPI UcxIsListEntryLinked ( _In_ const LIST_ENTRY * Entry )

Definition at line 94 of file ucxutil.h.

{
    return Entry->Flink != NULL;
}

Referenced by UcxEndpoint::Create(), UcxController::Destroy(), UcxCollectEndpointsForReset(), and UcxUntrackEndpoint().

◆ UcxRandom()

ULONG NTAPI UcxRandom ( VOID )

Definition at line 61 of file ucxutil.cpp.

{
    UcxDriver.RandomSeed = UcxDriver.RandomSeed * 1103515245 + 12345;
 
    return (UcxDriver.RandomSeed / 65536) % 32768;
}

Referenced by UcxRandomErrorStatus(), UcxRandomInRange(), and UcxVerifierWantsFailure().

◆ UcxRandomErrorStatus()

NTSTATUS NTAPI UcxRandomErrorStatus ( VOID )

Definition at line 93 of file ucxutil.cpp.

{
    return (NTSTATUS)(0xC0000000 | UcxRandom());
}

Referenced by _IRQL_requires_(), UcxEndpoint::OpenStaticStreams(), and UcxQueryUsbCapability().

◆ UcxRandomInRange()

ULONG NTAPI UcxRandomInRange ( _In_ ULONG Max )

Definition at line 85 of file ucxutil.cpp.

{
    return (UcxRandom() % Max) + 1;
}

Referenced by UcxApplyStreamCountOverride().

◆ UcxVerifierBreak()

FORCEINLINE VOID NTAPI UcxVerifierBreak ( _In_ BOOLEAN Verifying )

Stops in the debugger on a controller driver bug, only while verifying and attached.

Definition at line 168 of file ucxutil.h.

{
    if (Verifying && !KdRefreshDebuggerNotPresent())
        DbgBreakPoint();
}

Referenced by UcxEndpoint::CreateThroughHcd(), UcxStaticStreams::SetStreamInfo(), and UcxCreateStaticStreams().

◆ UcxVerifierWantsFailure()

BOOLEAN NTAPI UcxVerifierWantsFailure ( _In_ ULONG Setting )

0 never fails, 1 always fails, N fails about once in N calls.

Definition at line 71 of file ucxutil.cpp.

{
    if (Setting == 0)
        return FALSE;
 
    if (Setting == 1)
        return TRUE;
 
    return (32768 / Setting) > UcxRandom();
}

Referenced by _IRQL_requires_(), UcxEndpoint::OpenStaticStreams(), and UcxQueryUsbCapability().

Variable Documentation

◆ UcxDriver

UcxDriverState UcxDriver

extern

Definition at line 138 of file driver.cpp.

Referenced by _IRQL_requires_(), UcxController::Destroy(), _UCXHUB_WORKITEM::Enqueue(), UcxController::Initialize(), UcxComputeMaxTransferSize(), UcxEvtDriverUnload(), and UcxRandom().

Classes

Macros

Typedefs

Functions

Variables