XhciSlotTable Class Reference

#include <slots.h>

Collaboration diagram for XhciSlotTable:

Public Member Functions
NTSTATUS	Create (_In_ XhciController *Controller)
NTSTATUS	Prepare ()
VOID	Release ()
VOID	Program ()
VOID	D0Entry ()
VOID	DisableAll ()
	_IRQL_requires_ (PASSIVE_LEVEL) VOID PreReset()
	_IRQL_requires_ (PASSIVE_LEVEL) VOID PostReset()
VOID	OnHostLost ()
	_IRQL_requires_max_ (DISPATCH_LEVEL) NTSTATUS SetSlot(_In_ ULONG SlotId
	_IRQL_requires_max_ (DISPATCH_LEVEL) PVOID LookupSlot(_In_ ULONG SlotId) const
VOID	OnTransferEvent (_In_ const XHCI_TRB *Event)
VOID	OnDeviceNotificationEvent (_In_ const XHCI_TRB *Event)
VOID	DiscardState ()

Public Attributes
_In_ PVOID	Device
_In_ PVOID _In_ ULONG64	OutputContextAddress

Private Member Functions
VOID	ZeroScratchpads ()
VOID	FreeTables ()
BOOLEAN	IsValidSlot (_In_ ULONG SlotId) const

Private Attributes
XhciController *	m_Controller
ULONG	m_SlotCount
ULONG	m_ScratchpadCount
XhciDmaBuffer *	m_Dcbaa
XhciDmaBuffer *	m_ScratchpadArray
LIST_ENTRY	m_ScratchpadPages
PVOID *	m_SlotMap

Detailed Description

DCBAA, scratchpad buffers and slot id lookup.

Definition at line 13 of file slots.h.

Member Function Documentation

_IRQL_requires_() [1/2]

XhciSlotTable::_IRQL_requires_

(

PASSIVE_LEVEL

)

_IRQL_requires_() [2/2]

XhciSlotTable::_IRQL_requires_

(

PASSIVE_LEVEL

)

_IRQL_requires_max_() [1/2]

XhciSlotTable::_IRQL_requires_max_

(

DISPATCH_LEVEL

)

Sets the DCBAA entry of a slot, or clears it for LogicalAddress 0; STATUS_ACCESS_DENIED if in use.

_IRQL_requires_max_() [2/2]

XhciSlotTable::_IRQL_requires_max_

(

DISPATCH_LEVEL

)

const

Create()

NTSTATUS XhciSlotTable::Create

(

_In_ XhciController *

Controller

)

Definition at line 17 of file slots.cpp.

{
    m_Controller = Controller;
 
    /* Release walks this list even when Prepare never ran */
    InitializeListHead(&m_ScratchpadPages);
    return STATUS_SUCCESS;
}

Referenced by XhciController::Initialize().

D0Entry()

VOID XhciSlotTable::D0Entry

(

)

Definition at line 161 of file slots.cpp.

{
    Program();
}

Referenced by XhciController::RunD0Pass().

DisableAll()

VOID XhciSlotTable::DisableAll

(

)

Definition at line 199 of file slots.cpp.

{
    ULONG SlotId;
 
    for (SlotId = 1; IsValidSlot(SlotId); SlotId++)
    {
        if (m_SlotMap[SlotId] == NULL)
            continue;
 
        DPRINT("Slot %lu lost its device %p\n", SlotId, m_SlotMap[SlotId]);
 
        /* This clears the map entry */
        XhciSlotDevice(m_SlotMap[SlotId])->SetDisabled();
    }
}

Referenced by XhciController::D0Entry(), and DiscardState().

DiscardState()

VOID XhciSlotTable::DiscardState

(

)

State was lost: zero the scratchpad pages, then disable every slot (D0 entry cleanup).

Definition at line 183 of file slots.cpp.

{
    ZeroScratchpads();
    DisableAll();
}

Referenced by XhciController::D0Entry().

FreeTables()

VOID XhciSlotTable::FreeTables ( )

private

Definition at line 104 of file slots.cpp.

{
    XhciCommonBuffer* Pool = &m_Controller->m_Buffers;
 
    if (m_ScratchpadPages.Flink != NULL)
        Pool->FreeList(&m_ScratchpadPages);
 
    if (m_ScratchpadArray != NULL)
    {
        Pool->Free(m_ScratchpadArray);
        m_ScratchpadArray = NULL;
    }
 
    if (m_Dcbaa != NULL)
    {
        Pool->Free(m_Dcbaa);
        m_Dcbaa = NULL;
    }
 
    if (m_SlotMap != NULL)
    {
        ExFreePoolWithTag(m_SlotMap, XHCI_TAG_SLOT);
        m_SlotMap = NULL;
    }
 
    m_SlotCount = 0;
    m_ScratchpadCount = 0;
}

Referenced by _IRQL_requires_().

IsValidSlot()

BOOLEAN XhciSlotTable::IsValidSlot ( _In_ ULONG  SlotId ) const

inlineprivate

Definition at line 63 of file slots.h.

    {
        return m_SlotMap != NULL && SlotId != 0 && SlotId <= m_SlotCount;
    }

Referenced by _IRQL_requires_max_(), DisableAll(), and OnHostLost().

OnDeviceNotificationEvent()

VOID XhciSlotTable::OnDeviceNotificationEvent

(

_In_ const XHCI_TRB *

Event

)

Definition at line 334 of file slots.cpp.

{
    PVOID Device = LookupSlot(XhciTrbSlotId(Event));
 
    if (Device == NULL)
    {
        DPRINT("Device notification for empty slot %lu dropped\n", XhciTrbSlotId(Event));
        return;
    }
 
    XhciSlotDevice(Device)->OnDeviceNotificationEvent(Event);
}

OnHostLost()

VOID XhciSlotTable::OnHostLost

(

)

Definition at line 247 of file slots.cpp.

{
    ULONG SlotId;
 
    DPRINT("Controller gone, %lu slots\n", m_SlotCount);
 
    for (SlotId = 1; IsValidSlot(SlotId); SlotId++)
    {
        if (m_SlotMap[SlotId] != NULL)
            XhciSlotDevice(m_SlotMap[SlotId])->OnHostLost();
    }
}

Referenced by XhciController::RunRecovery().

OnTransferEvent()

VOID XhciSlotTable::OnTransferEvent

(

_In_ const XHCI_TRB *

Event

)

Prepare()

NTSTATUS XhciSlotTable::Prepare

(

)

Referenced by XhciController::PrepareHardware().

Program()

VOID XhciSlotTable::Program

(

)

Writes DCBAAP and CONFIG.MaxSlotsEn; the controller calls it before Run.

Definition at line 148 of file slots.cpp.

{
    if (m_Dcbaa == NULL || !m_Controller->IsAccessible())
        return;
 
    /* CIE stays 0: configuration information is not used */
    m_Controller->m_Registers.WriteOperational32(XHCI_OP_CONFIG,
                                                 m_SlotCount & XHCI_CONFIG_MAX_SLOTS_MASK);
    m_Controller->m_Registers.WriteOperational64(XHCI_OP_DCBAAP,
                                                 m_Dcbaa->LogicalAddress.QuadPart);
}

Referenced by D0Entry().

Release()

VOID XhciSlotTable::Release

(

)

Referenced by XhciController::ReleaseHardware().

ZeroScratchpads()

VOID XhciSlotTable::ZeroScratchpads ( )

private

Definition at line 167 of file slots.cpp.

{
    PLIST_ENTRY Entry;
 
    if (m_ScratchpadPages.Flink == NULL)
        return;
 
    for (Entry = m_ScratchpadPages.Flink; Entry != &m_ScratchpadPages; Entry = Entry->Flink)
    {
        XhciDmaBuffer* Page = CONTAINING_RECORD(Entry, XhciDmaBuffer, Link);
 
        RtlZeroMemory(Page->VirtualAddress, Page->Size);
    }
}

Referenced by DiscardState().

Member Data Documentation

Device

_In_ PVOID XhciSlotTable::Device

Definition at line 38 of file slots.h.

Referenced by _IRQL_requires_max_().

m_Controller

XhciController* XhciSlotTable::m_Controller

private

Definition at line 69 of file slots.h.

Referenced by _IRQL_requires_(), _IRQL_requires_max_(), Create(), FreeTables(), and Program().

m_Dcbaa

XhciDmaBuffer* XhciSlotTable::m_Dcbaa

private

Definition at line 72 of file slots.h.

Referenced by _IRQL_requires_(), _IRQL_requires_max_(), FreeTables(), and Program().

m_ScratchpadArray

XhciDmaBuffer* XhciSlotTable::m_ScratchpadArray

private

Definition at line 73 of file slots.h.

Referenced by _IRQL_requires_(), and FreeTables().

m_ScratchpadCount

ULONG XhciSlotTable::m_ScratchpadCount

private

Definition at line 71 of file slots.h.

Referenced by _IRQL_requires_(), and FreeTables().

m_ScratchpadPages

LIST_ENTRY XhciSlotTable::m_ScratchpadPages

private

Definition at line 74 of file slots.h.

Referenced by _IRQL_requires_(), Create(), FreeTables(), and ZeroScratchpads().

m_SlotCount

ULONG XhciSlotTable::m_SlotCount

private

Definition at line 70 of file slots.h.

Referenced by _IRQL_requires_(), FreeTables(), IsValidSlot(), OnHostLost(), and Program().

m_SlotMap

PVOID* XhciSlotTable::m_SlotMap

private

Definition at line 75 of file slots.h.

Referenced by _IRQL_requires_(), _IRQL_requires_max_(), DisableAll(), FreeTables(), IsValidSlot(), and OnHostLost().

OutputContextAddress

_In_ PVOID _In_ ULONG64 XhciSlotTable::OutputContextAddress

Definition at line 39 of file slots.h.

Referenced by _IRQL_requires_max_().

---

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

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