UcxUsbdHandle Class Reference

#include <clientif.h>

Collaboration diagram for UcxUsbdHandle:

Public Member Functions
	_IRQL_requires_ (PASSIVE_LEVEL) static NTSTATUS CreateFromQuery(_In_ UcxRootHub *RootHub
VOID	Unregister ()
NTSTATUS	AllocateXrb (_In_ ULONG Size, _In_ ULONG Type, _Outptr_ UcxXrbPreamble **Xrb)
VOID	TrackXrb (_In_ UcxXrbPreamble *Xrb)

Static Public Member Functions
static UcxUsbdHandle *	FromClientHandle (_In_ USBD_CLIENT_HANDLE Handle)

Public Attributes
_In_ UcxUsbDevice *	Device
_In_ UcxUsbDevice _Inout_ PUSBD_CLIENT_INTERFACE	Interface
ULONG	m_ContractVersion
PDEVICE_OBJECT	m_ClientDeviceObject
ULONG	m_PoolTag
PVOID	m_ClientContext
UcxUsbDevice *	m_Device
UcxController *	m_Controller
WDFMEMORY	m_Memory
WDFDEVICE	m_RootHubPdo
UcxRootHub *	m_RootHub
LIST_ENTRY	m_DeviceLink
BOOLEAN	m_Orphaned
BOOLEAN	m_Unregistered
BOOLEAN	m_VerifierEnabled
ULONG	m_VerifierFailRegistration
ULONG	m_VerifierFailChainedMdl
ULONG	m_VerifierFailStaticStreamSupport
ULONG	m_VerifierStaticStreamCountOverride
ULONG	m_VerifierFailEnableStaticStreams
ULONG	m_VerifierFailSecureTransfer
ULONG	m_VerifierFailEndpointOffload
BOOLEAN	m_StreamsGranted
BOOLEAN	m_ChainedMdlGranted
ULONG	m_GrantedStreams
BOOLEAN	m_TrackXrbs
KSPIN_LOCK	m_XrbLock
LIST_ENTRY	m_XrbList

Detailed Description

One client's USBD registration; outlives the USB device it was made against.

Definition at line 14 of file clientif.h.

Member Function Documentation

_IRQL_requires_()

UcxUsbdHandle::_IRQL_requires_

(

PASSIVE_LEVEL

)

AllocateXrb()

NTSTATUS UcxUsbdHandle::AllocateXrb	(	_In_ ULONG	Size,
		_In_ ULONG	Type,
		_Outptr_ UcxXrbPreamble **	Xrb
	)

Definition at line 663 of file clientif.cpp.

{
    WDF_OBJECT_ATTRIBUTES Attributes;
    UcxXrbPreamble* Xrb;
    WDFMEMORY Memory;
    PVOID Buffer;
    NTSTATUS Status;
 
    *XrbOut = NULL;
 
    WDF_OBJECT_ATTRIBUTES_INIT(&Attributes);
    Attributes.ParentObject = m_Memory;
 
    Status = WdfMemoryCreate(&Attributes, NonPagedPool, m_PoolTag, Size, &Memory, &Buffer);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("XRB allocation of %lu bytes for handle %p failed 0x%lx\n", Size, this, Status);
        return Status;
    }
 
    /* Both released by the free call, which may come after unregister */
    WdfObjectReference(Memory);
    WdfObjectReference(m_Memory);
    RtlZeroMemory(Buffer, Size);
 
    Xrb = (UcxXrbPreamble*)Buffer;
    Xrb->Signature = UCX_XRB_SIGNATURE;
    Xrb->TotalSize = Size;
    Xrb->ContractVersion = m_ContractVersion;
    Xrb->Handle = this;
    Xrb->State = UCX_XRB_IDLE;
    Xrb->Type = Type;
    Xrb->Memory = Memory;
 
    *XrbOut = Xrb;
    return STATUS_SUCCESS;
}

FromClientHandle()

static UcxUsbdHandle * UcxUsbdHandle::FromClientHandle ( _In_ USBD_CLIENT_HANDLE  Handle )

inlinestatic

Definition at line 30 of file clientif.h.

    {
        return (UcxUsbdHandle*)Handle;
    }

Referenced by UcxClientAllocIsochUrb(), UcxClientAllocUrb(), UcxClientSelectConfigXrbBuild(), UcxClientSelectInterfaceXrbBuild(), and UcxClientUnregister().

TrackXrb()

VOID UcxUsbdHandle::TrackXrb

(

_In_ UcxXrbPreamble *

Xrb

)

Definition at line 724 of file clientif.cpp.

{
    if (!m_TrackXrbs)
        return;
 
    SpinLockGuard Guard(&m_XrbLock);
    InsertTailList(&m_XrbList, &Xrb->TrackingLink);
}

Unregister()

VOID UcxUsbdHandle::Unregister

(

)

Definition at line 589 of file clientif.cpp.

{
    WDFMEMORY Memory = m_Memory;
 
    if (!m_Orphaned)
    {
        {
            SpinLockGuard Guard(&m_Device->m_UsbdHandleLock);
 
            RemoveEntryList(&m_DeviceLink);
            UcxClearListEntry(&m_DeviceLink);
        }
 
        ObDereferenceObject(m_ClientDeviceObject);
    }
 
    InterlockedDecrement(&m_Controller->m_UsbdInterfaceCount);
 
    /* Deleting the storage deletes every XRB still allocated under it */
    m_Unregistered = TRUE;
    WdfObjectDelete(Memory);
    WdfObjectDereference(Memory);
}

Referenced by UcxClientUnregister().

Member Data Documentation

Device

_In_ UcxUsbDevice* UcxUsbdHandle::Device

Definition at line 22 of file clientif.h.

Referenced by _IRQL_requires_().

Interface

_In_ UcxUsbDevice _Inout_ PUSBD_CLIENT_INTERFACE UcxUsbdHandle::Interface

Definition at line 23 of file clientif.h.

m_ChainedMdlGranted

BOOLEAN UcxUsbdHandle::m_ChainedMdlGranted

Definition at line 81 of file clientif.h.

m_ClientContext

PVOID UcxUsbdHandle::m_ClientContext

Definition at line 52 of file clientif.h.

m_ClientDeviceObject

PDEVICE_OBJECT UcxUsbdHandle::m_ClientDeviceObject

Definition at line 50 of file clientif.h.

Referenced by UcxXrbCheckOnSubmit(), and Unregister().

m_ContractVersion

ULONG UcxUsbdHandle::m_ContractVersion

Definition at line 49 of file clientif.h.

Referenced by AllocateXrb().

m_Controller

UcxController* UcxUsbdHandle::m_Controller

Definition at line 56 of file clientif.h.

Referenced by Unregister().

m_Device

UcxUsbDevice* UcxUsbdHandle::m_Device

Definition at line 53 of file clientif.h.

Referenced by Unregister().

m_DeviceLink

LIST_ENTRY UcxUsbdHandle::m_DeviceLink

Definition at line 62 of file clientif.h.

Referenced by Unregister().

m_GrantedStreams

ULONG UcxUsbdHandle::m_GrantedStreams

Definition at line 82 of file clientif.h.

m_Memory

WDFMEMORY UcxUsbdHandle::m_Memory

Definition at line 57 of file clientif.h.

Referenced by AllocateXrb(), and Unregister().

m_Orphaned

BOOLEAN UcxUsbdHandle::m_Orphaned

Definition at line 65 of file clientif.h.

Referenced by Unregister().

m_PoolTag

ULONG UcxUsbdHandle::m_PoolTag

Definition at line 51 of file clientif.h.

Referenced by AllocateXrb().

m_RootHub

UcxRootHub* UcxUsbdHandle::m_RootHub

Definition at line 59 of file clientif.h.

m_RootHubPdo

WDFDEVICE UcxUsbdHandle::m_RootHubPdo

Definition at line 58 of file clientif.h.

m_StreamsGranted

BOOLEAN UcxUsbdHandle::m_StreamsGranted

Definition at line 80 of file clientif.h.

m_TrackXrbs

BOOLEAN UcxUsbdHandle::m_TrackXrbs

Definition at line 85 of file clientif.h.

Referenced by TrackXrb().

m_Unregistered

BOOLEAN UcxUsbdHandle::m_Unregistered

Definition at line 68 of file clientif.h.

Referenced by Unregister().

m_VerifierEnabled

BOOLEAN UcxUsbdHandle::m_VerifierEnabled

Definition at line 70 of file clientif.h.

m_VerifierFailChainedMdl

ULONG UcxUsbdHandle::m_VerifierFailChainedMdl

Definition at line 72 of file clientif.h.

m_VerifierFailEnableStaticStreams

ULONG UcxUsbdHandle::m_VerifierFailEnableStaticStreams

Definition at line 75 of file clientif.h.

m_VerifierFailEndpointOffload

ULONG UcxUsbdHandle::m_VerifierFailEndpointOffload

Definition at line 77 of file clientif.h.

m_VerifierFailRegistration

ULONG UcxUsbdHandle::m_VerifierFailRegistration

Definition at line 71 of file clientif.h.

m_VerifierFailSecureTransfer

ULONG UcxUsbdHandle::m_VerifierFailSecureTransfer

Definition at line 76 of file clientif.h.

m_VerifierFailStaticStreamSupport

ULONG UcxUsbdHandle::m_VerifierFailStaticStreamSupport

Definition at line 73 of file clientif.h.

m_VerifierStaticStreamCountOverride

ULONG UcxUsbdHandle::m_VerifierStaticStreamCountOverride

Definition at line 74 of file clientif.h.

m_XrbList

LIST_ENTRY UcxUsbdHandle::m_XrbList

Definition at line 87 of file clientif.h.

Referenced by TrackXrb().

m_XrbLock

KSPIN_LOCK UcxUsbdHandle::m_XrbLock

Definition at line 86 of file clientif.h.

Referenced by TrackXrb().

---

The documentation for this class was generated from the following files:

• drivers/usb/ucx01000/clientif.h
• drivers/usb/ucx01000/clientif.cpp