XhciCommonBuffer Class Reference

#include <dmapool.h>

Collaboration diagram for XhciCommonBuffer:

Classes
struct	SizeClass

Public Member Functions
NTSTATUS	Create (_In_ XhciController *Controller)
NTSTATUS	Prepare ()
VOID	Release ()
VOID	D0Exit ()
VOID	PostResetFlush ()
VOID	OnHostLost ()
VOID	Rebalance ()
	_IRQL_requires_max_ (DISPATCH_LEVEL) XhciDmaBuffer *Acquire(_In_ ULONG Size)
	_IRQL_requires_max_ (DISPATCH_LEVEL) NTSTATUS AcquireList(_In_ ULONG Size
	_IRQL_requires_max_ (DISPATCH_LEVEL) VOID Free(_In_ XhciDmaBuffer *Buffer)
	_IRQL_requires_max_ (DISPATCH_LEVEL) VOID FreeList(_Inout_ PLIST_ENTRY List)
WDFDMAENABLER	DmaEnabler () const
PDMA_ADAPTER	DmaAdapter () const
ULONG	MaxDmaSize () const
ULONG	MapRegisterCount () const
	_IRQL_requires_ (PASSIVE_LEVEL) VOID GrowthWork()
	_IRQL_requires_ (PASSIVE_LEVEL) VOID ReclaimWork()
VOID	EnablerCleanup ()

Public Attributes
_In_ ULONG	Count
_In_ ULONG _Inout_ PLIST_ENTRY	List

Private Member Functions
	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS CreateEnabler()
SizeClass *	ClassForSize (_In_ ULONG Size)
	_IRQL_requires_ (PASSIVE_LEVEL) VOID AddSegments(_Inout_ SizeClass *Class
	_IRQL_requires_max_ (DISPATCH_LEVEL) BOOLEAN Grab(_Inout_ SizeClass *Class
	_Requires_lock_held_ (m_Lock) BOOLEAN ReturnFree(_Inout_ XhciDmaBuffer *Buffer)
	_Requires_lock_held_ (m_Lock) VOID ShrinkClass(_Inout_ SizeClass *Class)
	_IRQL_requires_max_ (DISPATCH_LEVEL) VOID QueueGrowth()
	_IRQL_requires_ (PASSIVE_LEVEL) VOID Flush()

Private Attributes
_In_ ULONG _Out_ PLIST_ENTRY	Taken
_In_ ULONG _Out_ PLIST_ENTRY _Out_ PBOOLEAN	NeedGrow
XhciController *	m_Controller
WDFDMAENABLER	m_Enabler
PDMA_ADAPTER	m_Adapter
ULONG	m_MaxDmaSize
ULONG	m_MapRegisters
BOOLEAN	m_Initialized
BOOLEAN	m_HoldsUcxReference
KSPIN_LOCK	m_Lock
SizeClass	m_Small
SizeClass	m_Large
ULONG	m_PagesTotal
ULONG	m_PagesInUse
LIST_ENTRY	m_ReclaimList
ULONG	m_ReclaimPages
WDFWORKITEM	m_ReclaimItem
WDFWORKITEM	m_GrowthItem
BOOLEAN	m_GrowthQueued
ULONG	m_GrowthOutstanding
KEVENT	m_GrowthIdle

Detailed Description

DMA enabler and buffer pool.

Definition at line 24 of file dmapool.h.

Member Function Documentation

_IRQL_requires_() [1/5]

XhciCommonBuffer::_IRQL_requires_ ( PASSIVE_LEVEL  )

private

_IRQL_requires_() [2/5]

XhciCommonBuffer::_IRQL_requires_ ( PASSIVE_LEVEL  )

private

_IRQL_requires_() [3/5]

XhciCommonBuffer::_IRQL_requires_ ( PASSIVE_LEVEL  )

private

_IRQL_requires_() [4/5]

XhciCommonBuffer::_IRQL_requires_

(

PASSIVE_LEVEL

)

_IRQL_requires_() [5/5]

XhciCommonBuffer::_IRQL_requires_

(

PASSIVE_LEVEL

)

_IRQL_requires_max_() [1/6]

XhciCommonBuffer::_IRQL_requires_max_ ( DISPATCH_LEVEL  )

private

_IRQL_requires_max_() [2/6]

XhciCommonBuffer::_IRQL_requires_max_

(

DISPATCH_LEVEL

)

Count zeroed buffers onto List (linked through Link); all or nothing.

_IRQL_requires_max_() [3/6]

XhciCommonBuffer::_IRQL_requires_max_

(

DISPATCH_LEVEL

)

_IRQL_requires_max_() [4/6]

XhciCommonBuffer::_IRQL_requires_max_

(

DISPATCH_LEVEL

)

_IRQL_requires_max_() [5/6]

XhciCommonBuffer::_IRQL_requires_max_ ( DISPATCH_LEVEL  )

private

_IRQL_requires_max_() [6/6]

XhciCommonBuffer::_IRQL_requires_max_

(

DISPATCH_LEVEL

)

Zeroed buffer of at least Size bytes, Size <= PAGE_SIZE. NULL when none can be had.

_Requires_lock_held_() [1/2]

XhciCommonBuffer::_Requires_lock_held_ ( m_Lock  )

private

_Requires_lock_held_() [2/2]

XhciCommonBuffer::_Requires_lock_held_ ( m_Lock  )

private

ClassForSize()

XhciCommonBuffer::SizeClass * XhciCommonBuffer::ClassForSize ( _In_ ULONG  Size )

private

Definition at line 273 of file dmapool.cpp.

{
    if (Size <= XHCI_POOL_SMALL_BYTES)
        return &m_Small;
    if (Size <= XHCI_POOL_PAGE_BYTES)
        return &m_Large;
    return NULL;
}

Create()

NTSTATUS XhciCommonBuffer::Create

(

_In_ XhciController *

Controller

)

Referenced by XhciController::Initialize().

D0Exit()

VOID XhciCommonBuffer::D0Exit

(

)

Referenced by XhciController::D0Exit().

DmaAdapter()

PDMA_ADAPTER XhciCommonBuffer::DmaAdapter

(

)

const

ReadFromDevice adapter, used for both directions.

Definition at line 738 of file dmapool.cpp.

{
    return m_Adapter;
}

Referenced by XhciControlRing::BuildControlTd(), and XhciControlRing::ReleaseResources().

DmaEnabler()

WDFDMAENABLER XhciCommonBuffer::DmaEnabler

(

)

const

Definition at line 732 of file dmapool.cpp.

{
    return m_Enabler;
}

EnablerCleanup()

VOID XhciCommonBuffer::EnablerCleanup

(

)

Definition at line 702 of file dmapool.cpp.

{
    if (m_Small.Total != m_Small.Available || m_Large.Total != m_Large.Available)
    {
        DPRINT1("DMA pool torn down with buffers still owned: small %lu of %lu, large %lu of %lu\n",
                m_Small.Total - m_Small.Available, m_Small.Total,
                m_Large.Total - m_Large.Available, m_Large.Total);
        ASSERT(FALSE);
    }
 
    /* KMDF frees the pages and work items as children of the enabler */
    m_Enabler = NULL;
    m_Adapter = NULL;
    m_ReclaimItem = NULL;
    m_GrowthItem = NULL;
    XhciPoolInitClass(&m_Small.FreeList, &m_Small.PageList);
    XhciPoolInitClass(&m_Large.FreeList, &m_Large.PageList);
    InitializeListHead(&m_ReclaimList);
    m_Small.Total = m_Small.Available = 0;
    m_Large.Total = m_Large.Available = 0;
 
    /* Last touch of this object; the controller context may go away right after */
    if (m_HoldsUcxReference)
    {
        m_HoldsUcxReference = FALSE;
        WdfObjectDereference(m_Controller->m_Ucx);
    }
}

MapRegisterCount()

ULONG XhciCommonBuffer::MapRegisterCount

(

)

const

Definition at line 750 of file dmapool.cpp.

{
    return m_MapRegisters;
}

MaxDmaSize()

ULONG XhciCommonBuffer::MaxDmaSize

(

)

const

Definition at line 744 of file dmapool.cpp.

{
    return m_MaxDmaSize;
}

OnHostLost()

VOID XhciCommonBuffer::OnHostLost

(

)

Referenced by XhciController::RunRecovery().

PostResetFlush()

VOID XhciCommonBuffer::PostResetFlush

(

)

Referenced by XhciController::InternalReset().

Prepare()

NTSTATUS XhciCommonBuffer::Prepare

(

)

Referenced by XhciController::PrepareHardware().

Rebalance()

VOID XhciCommonBuffer::Rebalance

(

)

Driven by the controller watchdog.

Definition at line 655 of file dmapool.cpp.

{
    BOOLEAN Reclaim;
 
    if (m_ReclaimItem == NULL)
        return;
 
    {
        XhciSpinLockGuard Guard(&m_Lock);
 
        ShrinkClass(&m_Small);
        ShrinkClass(&m_Large);
        Reclaim = !IsListEmpty(&m_ReclaimList);
    }
 
    if (Reclaim)
        WdfWorkItemEnqueue(m_ReclaimItem);
}

Referenced by XhciController::WatchdogTick().

Release()

VOID XhciCommonBuffer::Release

(

)

Definition at line 227 of file dmapool.cpp.

{
    /* Nothing to do: the pool survives ReleaseHardware and dies with the enabler */
}

Referenced by XhciController::ReleaseHardware().

Member Data Documentation

Count

_In_ ULONG XhciCommonBuffer::Count

Definition at line 50 of file dmapool.h.

Referenced by _IRQL_requires_max_().

List

_In_ ULONG _Inout_ PLIST_ENTRY XhciCommonBuffer::List

Definition at line 51 of file dmapool.h.

m_Adapter

PDMA_ADAPTER XhciCommonBuffer::m_Adapter

private

Definition at line 132 of file dmapool.h.

Referenced by DmaAdapter(), and EnablerCleanup().

m_Controller

XhciController* XhciCommonBuffer::m_Controller

private

Definition at line 130 of file dmapool.h.

Referenced by _IRQL_requires_(), and EnablerCleanup().

m_Enabler

WDFDMAENABLER XhciCommonBuffer::m_Enabler

private

Definition at line 131 of file dmapool.h.

Referenced by _IRQL_requires_(), DmaEnabler(), and EnablerCleanup().

m_GrowthIdle

KEVENT XhciCommonBuffer::m_GrowthIdle

private

Definition at line 151 of file dmapool.h.

Referenced by _IRQL_requires_().

m_GrowthItem

WDFWORKITEM XhciCommonBuffer::m_GrowthItem

private

Definition at line 148 of file dmapool.h.

Referenced by EnablerCleanup().

m_GrowthOutstanding

ULONG XhciCommonBuffer::m_GrowthOutstanding

private

Definition at line 150 of file dmapool.h.

m_GrowthQueued

BOOLEAN XhciCommonBuffer::m_GrowthQueued

private

Definition at line 149 of file dmapool.h.

m_HoldsUcxReference

BOOLEAN XhciCommonBuffer::m_HoldsUcxReference

private

Definition at line 136 of file dmapool.h.

Referenced by EnablerCleanup().

m_Initialized

BOOLEAN XhciCommonBuffer::m_Initialized

private

Definition at line 135 of file dmapool.h.

Referenced by _IRQL_requires_().

m_Large

SizeClass XhciCommonBuffer::m_Large

private

Definition at line 140 of file dmapool.h.

Referenced by _IRQL_requires_(), _Requires_lock_held_(), ClassForSize(), EnablerCleanup(), and Rebalance().

m_Lock

KSPIN_LOCK XhciCommonBuffer::m_Lock

private

Definition at line 138 of file dmapool.h.

Referenced by _IRQL_requires_(), _IRQL_requires_max_(), and Rebalance().

m_MapRegisters

ULONG XhciCommonBuffer::m_MapRegisters

private

Definition at line 134 of file dmapool.h.

Referenced by MapRegisterCount().

m_MaxDmaSize

ULONG XhciCommonBuffer::m_MaxDmaSize

private

Definition at line 133 of file dmapool.h.

Referenced by MaxDmaSize().

m_PagesInUse

ULONG XhciCommonBuffer::m_PagesInUse

private

Definition at line 142 of file dmapool.h.

Referenced by _IRQL_requires_max_().

m_PagesTotal

ULONG XhciCommonBuffer::m_PagesTotal

private

Definition at line 141 of file dmapool.h.

m_ReclaimItem

WDFWORKITEM XhciCommonBuffer::m_ReclaimItem

private

Definition at line 146 of file dmapool.h.

Referenced by EnablerCleanup(), and Rebalance().

m_ReclaimList

LIST_ENTRY XhciCommonBuffer::m_ReclaimList

private

Definition at line 144 of file dmapool.h.

Referenced by _IRQL_requires_(), EnablerCleanup(), and Rebalance().

m_ReclaimPages

ULONG XhciCommonBuffer::m_ReclaimPages

private

Definition at line 145 of file dmapool.h.

m_Small

SizeClass XhciCommonBuffer::m_Small

private

Definition at line 139 of file dmapool.h.

Referenced by _IRQL_requires_(), _Requires_lock_held_(), ClassForSize(), EnablerCleanup(), and Rebalance().

NeedGrow

_In_ ULONG _Out_ PLIST_ENTRY _Out_ PBOOLEAN XhciCommonBuffer::NeedGrow

private

Definition at line 112 of file dmapool.h.

Referenced by _IRQL_requires_max_().

Taken

_In_ ULONG _Out_ PLIST_ENTRY XhciCommonBuffer::Taken

private

Definition at line 111 of file dmapool.h.

Referenced by _IRQL_requires_max_().

---

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

• drivers/usb/usbxhci/dmapool.h
• drivers/usb/usbxhci/dmapool.cpp