dmapool.cpp File Reference

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

Include dependency graph for dmapool.cpp:

Go to the source code of this file.

Classes
struct	_XHCI_POOL_PAGE
struct	_XHCI_POOL_OWNER

Macros
#define	NDEBUG
#define	XHCI_POOL_PAGE_BYTES   4096
#define	XHCI_POOL_SMALL_BYTES   512
#define	XHCI_POOL_DMA_LIMIT   0xFFFE00

Typedefs
typedef struct _XHCI_POOL_PAGE	XHCI_POOL_PAGE
typedef struct _XHCI_POOL_PAGE *	PXHCI_POOL_PAGE
typedef struct _XHCI_POOL_OWNER	XHCI_POOL_OWNER
typedef struct _XHCI_POOL_OWNER *	PXHCI_POOL_OWNER

Functions
	WDF_DECLARE_CONTEXT_TYPE_WITH_NAME (XHCI_POOL_PAGE, XhciPoolPageFromBuffer)
	WDF_DECLARE_CONTEXT_TYPE_WITH_NAME (XHCI_POOL_OWNER, XhciPoolOwner)
static VOID NTAPI	XhciPoolGrowthWorkItem (_In_ WDFWORKITEM WorkItem)
static VOID NTAPI	XhciPoolReclaimWorkItem (_In_ WDFWORKITEM WorkItem)
static VOID NTAPI	XhciPoolEnablerCleanup (_In_ WDFOBJECT Object)
static VOID NTAPI	XhciPoolInitClass (_Out_ PLIST_ENTRY FreeList, _Out_ PLIST_ENTRY PageList)
	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS XhciCommonBuffer
	Sends a synchronous IOCTL to the specified device object.
	_IRQL_requires_max_ (DISPATCH_LEVEL) BOOLEAN XhciCommonBuffer
	_Requires_lock_held_ (m_Lock) BOOLEAN XhciCommonBuffer

Variables
static EVT_WDF_WORKITEM	XhciPoolGrowthWorkItem
static EVT_WDF_WORKITEM	XhciPoolReclaimWorkItem
static EVT_WDF_OBJECT_CONTEXT_CLEANUP	XhciPoolEnablerCleanup

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 10 of file dmapool.cpp.

XHCI_POOL_DMA_LIMIT

#define XHCI_POOL_DMA_LIMIT   0xFFFE00

Definition at line 16 of file dmapool.cpp.

XHCI_POOL_PAGE_BYTES

#define XHCI_POOL_PAGE_BYTES   4096

Definition at line 14 of file dmapool.cpp.

XHCI_POOL_SMALL_BYTES

#define XHCI_POOL_SMALL_BYTES   512

Definition at line 15 of file dmapool.cpp.

Typedef Documentation

PXHCI_POOL_OWNER

typedef struct _XHCI_POOL_OWNER * PXHCI_POOL_OWNER

PXHCI_POOL_PAGE

typedef struct _XHCI_POOL_PAGE * PXHCI_POOL_PAGE

XHCI_POOL_OWNER

typedef struct _XHCI_POOL_OWNER XHCI_POOL_OWNER

Context of the enabler and the pool work items.

XHCI_POOL_PAGE

typedef struct _XHCI_POOL_PAGE XHCI_POOL_PAGE

WDFCOMMONBUFFER context: the page header followed by its segments.

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.

Nothing is found unless the PCI bus driver publishes the properties.

The root hub name without its prefix; NULL when the PDO has no name.

Grows a private buffer to what the helper asks for.

Lets KMDF handle the IRP, then hands it back here still uncompleted.

Waits for the device machine to answer a PnP or power event; returns the PnP status.

Deletes the UCX endpoints of the disabled pipes, then the interface record.

One 4 byte value; the registry type is not checked.

Reread whenever user experience settings change; the open status is returned.

Sends a synchronous IOCTL to the specified device object.

STATUS_SUCCESS when the caller's token is an administrator's.

Sends a synchronous IOCTL to the specified device object.

Reads one value of a walk. A missing value only clears Present; FALSE means stop.

Reads up to Size bytes of a value into a zeroed buffer; the type is not checked.

Writes a REG_BINARY value into the device's usbflags subkey.

Sets or clears ExtPropertiesInstalled from ExtPropDescSemaphore in the hardware key.

Fails only when a port cannot be bound to the USB4 host router its ACPI node names.

Assigns device, hardware, compatible, container and instance ids to a new child PDO.

Answers IRP_MN_QUERY_DEVICE_TEXT on a child PDO; always completes the IRP.

Takes the connector map lock, needed around HubConnectorFindCompanion.

Device hardware key values read at PDO prepare hardware.

Saves the MS OS 2.0 set info in usbflags when the set asks for alternate enumeration.

MsOs20Flags and EnumerationRetryCount, written at PDO start.

Rereads the UXD record; UpdateRequired says whether the device id changes.

Replacement PnP id of a UXD reserved device, or an empty String. Always succeeds.

Telemetry values under the device's Ceip subkey.

BootPathSurpriseRemovalCount + 1.

This machine's dual role features for a dual role partner.

Tells UCX the WDM PDO of the device; call right after the child PDO was created.

IOCTL_INTERNAL_USB_GET_CONTROLLER_NAME: Argument1 and its length Argument2.

IOCTL_INTERNAL_USB_GET_BUS_INFO for the device: the 16 byte USB_BUS_NOTIFICATION at Argument1.

Registers the GUID_USB_WMI_NODE_INFO instance of a child PDO (not for hubs or composites).

Registers the boot device surprise removal event on an external, non hub boot PDO.

Fires the boot device surprise removal event, if one is registered.

Sends a synchronous IOCTL to the specified device object.

Publishes "<port>#<host>" for every bound port on the hub's PDO. QUIRK: with no bound port an older value is left in place.

Binds USB 3 ports to the host routers named by the USB4 DVSEC; an earlier ACPI mapping wins.

Waits on a PnP handshake event with no timeout, printing a watchdog line every minute so a stuck machine is visible in the debugger.

Copies up to Size bytes of a device property; a failed query leaves the field zero.

Only the controller name length is real; both bandwidth fields read 0.

The answer overlays a USB_HUB_NAME on TotalSize, so TotalSize comes back as the name length + 4.

Evaluates a method without arguments into Output.

Definition at line 84 of file dmapool.cpp.

{
    if (!m_Initialized)
    {
        m_Controller = Controller;
        KeInitializeSpinLock(&m_Lock);
        InitializeListHead(&m_ReclaimList);
        KeInitializeEvent(&m_GrowthIdle, NotificationEvent, TRUE);
 
        /* Pool sizing policy; the test signing overrides are not supported */
        XhciPoolInitClass(&m_Small.FreeList, &m_Small.PageList);
        m_Small.SegmentSize = XHCI_POOL_SMALL_BYTES;
        m_Small.GrowBelow = 4;
        m_Small.GrowBy = 8;
        m_Small.KeepAtLeast = 16;
 
        XhciPoolInitClass(&m_Large.FreeList, &m_Large.PageList);
        m_Large.SegmentSize = XHCI_POOL_PAGE_BYTES;
        m_Large.GrowBelow = 1;
        m_Large.GrowBy = 1;
        m_Large.KeepAtLeast = 2;
 
        m_Initialized = TRUE;
    }
 
    /* The enabler needs AC64, so it waits for the registers when called early */
    if (m_Enabler == NULL && Controller->IsAccessible())
        return CreateEnabler();
 
    return STATUS_SUCCESS;
}

_IRQL_requires_max_()

_IRQL_requires_max_

(

DISPATCH_LEVEL

)

IOCTL_INTERNAL_USB_SUBMIT_IDLE_NOTIFICATION; the idle machine owns the IRP afterwards.

Records hub over current in the hub hardware key, once per devnode.

First selective suspend of the device; the registry write runs in a work item.

"USB device not recognized" popup for a port.

A hub was attached beyond the allowed tier depth.

The selected configuration draws more power than the port can give.

The controller ran out of bandwidth for the device; fired by the out of bandwidth timer.

Definition at line 357 of file dmapool.cpp.

{
    PLIST_ENTRY Entry;
    BOOLEAN Got = FALSE;
 
    InitializeListHead(Taken);
 
    {
        XhciSpinLockGuard Guard(&m_Lock);
 
        if (Class->Available >= Count)
        {
            ULONG Left;
 
            for (Left = Count; Left != 0; Left--)
            {
                XhciDmaBuffer* Segment;
                PXHCI_POOL_PAGE Page;
 
                Segment = CONTAINING_RECORD(RemoveHeadList(&Class->FreeList), XhciDmaBuffer, Link);
                Segment->Owned = TRUE;
 
                Page = (PXHCI_POOL_PAGE)Segment->Page;
                if (Page->ReleaseQueued)
                {
                    Page->ReleaseQueued = FALSE;
                    m_PagesInUse++;
                }
 
                InsertTailList(Taken, &Segment->Link);
            }
 
            Class->Available -= Count;
            Got = TRUE;
        }
 
        *NeedGrow = (Class->Available < Class->GrowBelow);
    }
 
    /* Nobody else can reach these segments now, so zero them outside the lock */
    for (Entry = Taken->Flink; Entry != Taken; Entry = Entry->Flink)
    {
        XhciDmaBuffer* Segment = CONTAINING_RECORD(Entry, XhciDmaBuffer, Link);
        RtlZeroMemory(Segment->VirtualAddress, Segment->Size);
    }
 
    return Got;
}

_Requires_lock_held_()

_Requires_lock_held_

(

m_Lock

)

Definition at line 505 of file dmapool.cpp.

{
    SizeClass* Class;
 
    if (Buffer->Size == XHCI_POOL_SMALL_BYTES)
        Class = &m_Small;
    else if (Buffer->Size == XHCI_POOL_PAGE_BYTES)
        Class = &m_Large;
    else
        return FALSE;
 
    if (!Buffer->Owned)
    {
        DPRINT1("Common buffer %p freed twice\n", Buffer);
        return TRUE;
    }
 
    /* The most recently used segment goes first so it is reused while still cached */
    Buffer->Owned = FALSE;
    InsertHeadList(&Class->FreeList, &Buffer->Link);
    Class->Available++;
    return TRUE;
}

WDF_DECLARE_CONTEXT_TYPE_WITH_NAME() [1/2]

WDF_DECLARE_CONTEXT_TYPE_WITH_NAME	(	XHCI_POOL_OWNER	,
		XhciPoolOwner
	)

WDF_DECLARE_CONTEXT_TYPE_WITH_NAME() [2/2]

WDF_DECLARE_CONTEXT_TYPE_WITH_NAME	(	XHCI_POOL_PAGE	,
		XhciPoolPageFromBuffer
	)

XhciPoolEnablerCleanup()

static VOID NTAPI XhciPoolEnablerCleanup ( _In_ WDFOBJECT  Object )

static

Definition at line 63 of file dmapool.cpp.

{
    XhciCommonBuffer* Pool = XhciPoolOwner(Object)->Pool;
 
    /* Creation failed before the enabler was handed to the pool */
    if (Pool != NULL)
        Pool->EnablerCleanup();
}

XhciPoolGrowthWorkItem()

static VOID NTAPI XhciPoolGrowthWorkItem ( _In_ WDFWORKITEM  WorkItem )

static

Definition at line 45 of file dmapool.cpp.

{
    XhciPoolOwner(WorkItem)->Pool->GrowthWork();
}

XhciPoolInitClass()

static VOID NTAPI XhciPoolInitClass ( _Out_ PLIST_ENTRY  FreeList, _Out_ PLIST_ENTRY  PageList  )

static

Definition at line 76 of file dmapool.cpp.

{
    InitializeListHead(FreeList);
    InitializeListHead(PageList);
}

Referenced by _IRQL_requires_(), and XhciCommonBuffer::EnablerCleanup().

XhciPoolReclaimWorkItem()

static VOID NTAPI XhciPoolReclaimWorkItem ( _In_ WDFWORKITEM  WorkItem )

static

Definition at line 54 of file dmapool.cpp.

{
    XhciPoolOwner(WorkItem)->Pool->ReclaimWork();
}

Variable Documentation

XhciPoolEnablerCleanup

EVT_WDF_OBJECT_CONTEXT_CLEANUP XhciPoolEnablerCleanup

static

Definition at line 40 of file dmapool.cpp.

XhciPoolGrowthWorkItem

EVT_WDF_WORKITEM XhciPoolGrowthWorkItem

static

Definition at line 38 of file dmapool.cpp.

XhciPoolReclaimWorkItem

EVT_WDF_WORKITEM XhciPoolReclaimWorkItem

static

Definition at line 39 of file dmapool.cpp.