slots.cpp File Reference

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

Include dependency graph for slots.cpp:

Go to the source code of this file.

Macros
#define	NDEBUG
#define	XHCI_SCRATCHPAD_BYTES   4096

Functions
	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS XhciSlotTable
	Sends a synchronous IOCTL to the specified device object.
static XhciUsbDevice *NTAPI	XhciSlotDevice (_In_ PVOID Entry)
	_IRQL_requires_max_ (DISPATCH_LEVEL) NTSTATUS XhciSlotTable

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 10 of file slots.cpp.

XHCI_SCRATCHPAD_BYTES

#define XHCI_SCRATCHPAD_BYTES   4096

Definition at line 14 of file slots.cpp.

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.

Drops every MSI descriptor and keeps only lists that still offer a line interrupt.

Picks the list with the best MSI offer: MSI-X first, then the most messages.

Keeps message descriptors covering Wanted messages and removes the others.

Evaluates _DSM on the controller ACPI object with a buffer as Arg3; returns up to 8 result bytes, 0 on failure.

Definition at line 27 of file slots.cpp.

{
    XhciCommonBuffer* Pool = &m_Controller->m_Buffers;
    volatile ULONG64* Entries;
    PULONG64 Array;
    PLIST_ENTRY Entry;
    SIZE_T MapBytes;
    ULONG Index;
    NTSTATUS Status;
 
    InitializeListHead(&m_ScratchpadPages);
 
    m_Dcbaa = Pool->Acquire(XHCI_DCBAA_ENTRIES * sizeof(ULONG64));
    if (m_Dcbaa == NULL)
    {
        DPRINT1("No common buffer for the DCBAA\n");
        Status = STATUS_INSUFFICIENT_RESOURCES;
        goto Fail;
    }
 
    Entries = (volatile ULONG64*)m_Dcbaa->VirtualAddress;
 
    m_ScratchpadCount = m_Controller->m_Registers.ScratchpadCount();
    if (m_ScratchpadCount != 0)
    {
        /* QUIRK: above 512 scratchpads the array no longer fits a pool page and this fails */
        m_ScratchpadArray = Pool->Acquire(m_ScratchpadCount * sizeof(ULONG64));
        if (m_ScratchpadArray == NULL)
        {
            DPRINT1("No common buffer for the array of %lu scratchpads\n", m_ScratchpadCount);
            Status = STATUS_INSUFFICIENT_RESOURCES;
            goto Fail;
        }
 
        Status = Pool->AcquireList(XHCI_SCRATCHPAD_BYTES, m_ScratchpadCount, &m_ScratchpadPages);
        if (!NT_SUCCESS(Status))
        {
            DPRINT1("Acquiring %lu scratchpad pages failed 0x%lx\n", m_ScratchpadCount, Status);
            goto Fail;
        }
 
        Array = (PULONG64)m_ScratchpadArray->VirtualAddress;
        Index = 0;
        for (Entry = m_ScratchpadPages.Flink; Entry != &m_ScratchpadPages; Entry = Entry->Flink)
        {
            XhciDmaBuffer* Page = CONTAINING_RECORD(Entry, XhciDmaBuffer, Link);
 
            Array[Index++] = Page->LogicalAddress.QuadPart;
        }
 
        Entries[0] = m_ScratchpadArray->LogicalAddress.QuadPart;
    }
 
    m_SlotCount = m_Controller->m_Registers.MaxSlots();
 
    /* Index 0 is never a slot id; keeping it makes the slot id the index */
    MapBytes = (m_SlotCount + 1) * sizeof(*m_SlotMap);
    m_SlotMap = (PVOID*)ExAllocatePoolZero(NonPagedPool, MapBytes, XHCI_TAG_SLOT);
    if (m_SlotMap == NULL)
    {
        DPRINT1("No pool for the map of %lu slots\n", m_SlotCount);
        Status = STATUS_INSUFFICIENT_RESOURCES;
        goto Fail;
    }
 
    DPRINT("Slot table: %lu slots, %lu scratchpads, DCBAA at 0x%I64x\n",
           m_SlotCount, m_ScratchpadCount, m_Dcbaa->LogicalAddress.QuadPart);
    return STATUS_SUCCESS;
 
Fail:
    FreeTables();
    return Status;
}

_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 260 of file slots.cpp.

{
    volatile ULONG64* Entries;
 
    if (!IsValidSlot(SlotId) || m_Dcbaa == NULL)
    {
        DPRINT1("Slot id %lu is outside the slot table\n", SlotId);
        return STATUS_INVALID_PARAMETER;
    }
 
    Entries = (volatile ULONG64*)m_Dcbaa->VirtualAddress;
 
    /* Software clears the entry once the slot is disabled (xHCI 4.6.4) */
    if (OutputContextAddress == 0)
    {
        ASSERT(Device == NULL || m_SlotMap[SlotId] == Device);
        m_SlotMap[SlotId] = NULL;
        Entries[SlotId] = 0;
        return STATUS_SUCCESS;
    }
 
    /* QUIRK: nothing is recorded while the controller is inaccessible */
    if (!m_Controller->IsAccessible())
        return STATUS_SUCCESS;
 
    if (Entries[SlotId] != 0)
    {
        DPRINT1("DCBAA entry of slot %lu is already 0x%I64x\n", SlotId, (ULONG64)Entries[SlotId]);
        return STATUS_ACCESS_DENIED;
    }
 
    m_SlotMap[SlotId] = Device;
    Entries[SlotId] = OutputContextAddress;
    return STATUS_SUCCESS;
}

XhciSlotDevice()

static XhciUsbDevice *NTAPI XhciSlotDevice ( _In_ PVOID  Entry )

static

Definition at line 192 of file slots.cpp.

{
    return static_cast<XhciUsbDevice*>(Entry);
}

Referenced by XhciSlotTable::DisableAll(), XhciSlotTable::OnDeviceNotificationEvent(), and XhciSlotTable::OnHostLost().