devhere.c File Reference

#include <pci.h>
#include <debug.h>

Include dependency graph for devhere.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
NTSTATUS NTAPI	devpresent_Initializer (IN PVOID Instance)
static VOID NTAPI	devpresent_Reference (_In_ PVOID Context)
static VOID NTAPI	devpresent_Dereference (_In_ PVOID Context)
static BOOLEAN NTAPI	devpresent_IsMatch (_In_ PPCI_PDO_EXTENSION PdoExtension, _In_ PPCI_DEVICE_PRESENCE_PARAMETERS Parameters)
	Compares one child against the fields selected by the search flags.
static BOOLEAN NTAPI	devpresent_SearchBus (_In_ PPCI_FDO_EXTENSION FdoExtension, _In_opt_ PPCI_SLOT_NUMBER Slot, _In_ PPCI_DEVICE_PRESENCE_PARAMETERS Parameters)
	Searches the children of one bus.
static BOOLEAN NTAPI	devpresent_SearchAllBuses (_In_ PPCI_DEVICE_PRESENCE_PARAMETERS Parameters)
	Searches every PCI bus in the machine.
static BOOLEAN NTAPI	devpresent_IsDevicePresent (_In_ USHORT VendorID, _In_ USHORT DeviceID, _In_ UCHAR RevisionID, _In_ USHORT SubVendorID, _In_ USHORT SubSystemID, _In_ ULONG Flags)
static BOOLEAN NTAPI	devpresent_FlagsValid (_In_ ULONG Flags)
	Checks that the search flags name the device by IDs, class, or both. Subsystem and revision refine an ID match, programming interface refines a class match.
static BOOLEAN NTAPI	devpresent_IsDevicePresentEx (_In_ PVOID Context, _In_ PPCI_DEVICE_PRESENCE_PARAMETERS Parameters)
NTSTATUS NTAPI	devpresent_Constructor (IN PVOID DeviceExtension, IN PVOID Instance, IN PVOID InterfaceData, IN USHORT Version, IN USHORT Size, IN PINTERFACE Interface)

Variables
PCI_INTERFACE	PciDevicePresentInterface

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 13 of file devhere.c.

Function Documentation

devpresent_Constructor()

NTSTATUS NTAPI devpresent_Constructor	(	IN PVOID	DeviceExtension,
		IN PVOID	Instance,
		IN PVOID	InterfaceData,
		IN USHORT	Version,
		IN USHORT	Size,
		IN PINTERFACE	Interface
	)

Definition at line 270 of file devhere.c.

{
    PPCI_DEVICE_PRESENT_INTERFACE PresentInterface = (PPCI_DEVICE_PRESENT_INTERFACE)Interface;
    BOOLEAN HasEx;
    PAGED_CODE();
 
    UNREFERENCED_PARAMETER(Instance);
    UNREFERENCED_PARAMETER(InterfaceData);
    UNREFERENCED_PARAMETER(Version);
 
    /* Callers built before IsDevicePresentEx existed pass the shorter size */
    HasEx = (Size >= sizeof(*PresentInterface));
 
    PresentInterface->IsDevicePresent = devpresent_IsDevicePresent;
    if (HasEx)
        PresentInterface->IsDevicePresentEx = devpresent_IsDevicePresentEx;
 
    PresentInterface->InterfaceReference = devpresent_Reference;
    PresentInterface->InterfaceDereference = devpresent_Dereference;
    PresentInterface->Context = DeviceExtension;
    PresentInterface->Version = PCI_DEVICE_PRESENT_INTERFACE_VERSION;
    PresentInterface->Size = (USHORT)(HasEx ? sizeof(*PresentInterface) :
                                      FIELD_OFFSET(PCI_DEVICE_PRESENT_INTERFACE, IsDevicePresentEx));
 
    return STATUS_SUCCESS;
}

devpresent_Dereference()

static VOID NTAPI devpresent_Dereference ( _In_ PVOID  Context )

static

Definition at line 57 of file devhere.c.

{
    PPCI_PDO_EXTENSION PdoExtension = Context;
 
    InterlockedDecrement(&PdoExtension->BusInterfaceReferenceCount);
}

Referenced by devpresent_Constructor().

devpresent_FlagsValid()

static BOOLEAN NTAPI devpresent_FlagsValid ( _In_ ULONG  Flags )

static

Checks that the search flags name the device by IDs, class, or both. Subsystem and revision refine an ID match, programming interface refines a class match.

Definition at line 215 of file devhere.c.

{
    ULONG Needed = 0;
 
    if (Flags & (PCI_USE_SUBSYSTEM_IDS | PCI_USE_REVISION))
        Needed |= PCI_USE_VENDEV_IDS;
    if (Flags & PCI_USE_PROGIF)
        Needed |= PCI_USE_CLASS_SUBCLASS;
 
    return ((Flags & (PCI_USE_VENDEV_IDS | PCI_USE_CLASS_SUBCLASS)) != 0) &&
           ((Flags & Needed) == Needed);
}

Referenced by devpresent_IsDevicePresentEx().

devpresent_Initializer()

NTSTATUS NTAPI devpresent_Initializer

(

IN PVOID

Instance

)

Definition at line 35 of file devhere.c.

{
    UNREFERENCED_PARAMETER(Instance);
    /* PnP Interfaces don't get Initialized */
    ASSERTMSG("PCI devpresent_Initializer, unexpected call.\n", FALSE);
    return STATUS_UNSUCCESSFUL;
}

devpresent_IsDevicePresent()

static BOOLEAN NTAPI devpresent_IsDevicePresent ( _In_ USHORT  VendorID, _In_ USHORT  DeviceID, _In_ UCHAR  RevisionID, _In_ USHORT  SubVendorID, _In_ USHORT  SubSystemID, _In_ ULONG  Flags  )

static

Definition at line 182 of file devhere.c.

{
    PCI_DEVICE_PRESENCE_PARAMETERS Parameters;
    PAGED_CODE();
 
    RtlZeroMemory(&Parameters, sizeof(Parameters));
    Parameters.Size = sizeof(Parameters);
    Parameters.VendorID = VendorID;
    Parameters.DeviceID = DeviceID;
    Parameters.RevisionID = RevisionID;
    Parameters.SubVendorID = SubVendorID;
    Parameters.SubSystemID = SubSystemID;
 
    /* The first version always matches the IDs and only knows these two flags */
    Parameters.Flags = PCI_USE_VENDEV_IDS |
                       (Flags & (PCI_USE_SUBSYSTEM_IDS | PCI_USE_REVISION));
 
    return devpresent_SearchAllBuses(&Parameters);
}

Referenced by devpresent_Constructor().

devpresent_IsDevicePresentEx()

static BOOLEAN NTAPI devpresent_IsDevicePresentEx ( _In_ PVOID  Context, _In_ PPCI_DEVICE_PRESENCE_PARAMETERS  Parameters  )

static

Definition at line 232 of file devhere.c.

{
    PPCI_PDO_EXTENSION PdoExtension = Context;
    PPCI_SLOT_NUMBER Slot = NULL;
    PAGED_CODE();
 
    if (!Parameters ||
        (Parameters->Size < sizeof(*Parameters)) ||
        !devpresent_FlagsValid(Parameters->Flags))
    {
        return FALSE;
    }
 
    switch (Parameters->Flags & (PCI_USE_LOCAL_BUS | PCI_USE_LOCAL_DEVICE))
    {
        case 0:
            return devpresent_SearchAllBuses(Parameters);
 
        case PCI_USE_LOCAL_BUS:
            break;
 
        default:
            if (PdoExtension)
                Slot = &PdoExtension->Slot;
            break;
    }
 
    /* A local search is relative to the device that was asked */
    if (!PdoExtension)
        return FALSE;
 
    return devpresent_SearchBus(PdoExtension->ParentFdoExtension, Slot, Parameters);
}

Referenced by devpresent_Constructor().

devpresent_IsMatch()

static BOOLEAN NTAPI devpresent_IsMatch ( _In_ PPCI_PDO_EXTENSION  PdoExtension, _In_ PPCI_DEVICE_PRESENCE_PARAMETERS  Parameters  )

static

Compares one child against the fields selected by the search flags.

Definition at line 71 of file devhere.c.

{
    ULONG Flags = Parameters->Flags;
 
    /* The PDO stays on the list after its function leaves the slot */
    if (PdoExtension->ReportedMissing)
        return FALSE;
 
    if ((Flags & PCI_USE_VENDEV_IDS) &&
        ((PdoExtension->VendorId != Parameters->VendorID) ||
         (PdoExtension->DeviceId != Parameters->DeviceID)))
    {
        return FALSE;
    }
 
    if ((Flags & PCI_USE_SUBSYSTEM_IDS) &&
        ((PdoExtension->SubsystemVendorId != Parameters->SubVendorID) ||
         (PdoExtension->SubsystemId != Parameters->SubSystemID)))
    {
        return FALSE;
    }
 
    if ((Flags & PCI_USE_REVISION) &&
        (PdoExtension->RevisionId != Parameters->RevisionID))
    {
        return FALSE;
    }
 
    if ((Flags & PCI_USE_CLASS_SUBCLASS) &&
        ((PdoExtension->BaseClass != Parameters->BaseClass) ||
         (PdoExtension->SubClass != Parameters->SubClass)))
    {
        return FALSE;
    }
 
    if ((Flags & PCI_USE_PROGIF) &&
        (PdoExtension->ProgIf != Parameters->ProgIf))
    {
        return FALSE;
    }
 
    return TRUE;
}

Referenced by devpresent_SearchBus().

devpresent_Reference()

static VOID NTAPI devpresent_Reference ( _In_ PVOID  Context )

static

Definition at line 46 of file devhere.c.

{
    PPCI_PDO_EXTENSION PdoExtension = Context;
 
    InterlockedIncrement(&PdoExtension->BusInterfaceReferenceCount);
}

Referenced by devpresent_Constructor().

devpresent_SearchAllBuses()

static BOOLEAN NTAPI devpresent_SearchAllBuses ( _In_ PPCI_DEVICE_PRESENCE_PARAMETERS  Parameters )

static

Searches every PCI bus in the machine.

Definition at line 156 of file devhere.c.

{
    PPCI_FDO_EXTENSION FdoExtension;
    BOOLEAN Found = FALSE;
    PAGED_CODE();
 
    KeEnterCriticalRegion();
    KeWaitForSingleObject(&PciGlobalLock, Executive, KernelMode, FALSE, NULL);
 
    FdoExtension = (PPCI_FDO_EXTENSION)PciFdoExtensionListHead.Next;
    while (FdoExtension && !Found)
    {
        Found = devpresent_SearchBus(FdoExtension, NULL, Parameters);
        FdoExtension = (PPCI_FDO_EXTENSION)FdoExtension->List.Next;
    }
 
    KeSetEvent(&PciGlobalLock, IO_NO_INCREMENT, FALSE);
    KeLeaveCriticalRegion();
 
    return Found;
}

Referenced by devpresent_IsDevicePresent(), and devpresent_IsDevicePresentEx().

devpresent_SearchBus()

static BOOLEAN NTAPI devpresent_SearchBus ( _In_ PPCI_FDO_EXTENSION  FdoExtension, _In_opt_ PPCI_SLOT_NUMBER  Slot, _In_ PPCI_DEVICE_PRESENCE_PARAMETERS  Parameters  )

static

Searches the children of one bus.

Parameters

Slot	When not NULL, only functions of the device in this slot are checked.

Definition at line 124 of file devhere.c.

{
    PPCI_PDO_EXTENSION Child;
    PAGED_CODE();
 
    KeEnterCriticalRegion();
    KeWaitForSingleObject(&FdoExtension->ChildListLock, Executive, KernelMode, FALSE, NULL);
 
    for (Child = FdoExtension->ChildPdoList; Child; Child = Child->Next)
    {
        if (Slot && (Child->Slot.u.bits.DeviceNumber != Slot->u.bits.DeviceNumber))
            continue;
 
        if (devpresent_IsMatch(Child, Parameters))
            break;
    }
 
    KeSetEvent(&FdoExtension->ChildListLock, IO_NO_INCREMENT, FALSE);
    KeLeaveCriticalRegion();
 
    return (Child != NULL);
}

Referenced by devpresent_IsDevicePresentEx(), and devpresent_SearchAllBuses().

Variable Documentation

PciDevicePresentInterface

PCI_INTERFACE PciDevicePresentInterface

Initial value:

=
{
    &GUID_PCI_DEVICE_PRESENT_INTERFACE,
    (USHORT)FIELD_OFFSET(PCI_DEVICE_PRESENT_INTERFACE, IsDevicePresentEx),
    PCI_DEVICE_PRESENT_INTERFACE_VERSION,
    PCI_DEVICE_PRESENT_INTERFACE_VERSION,
    PCI_INTERFACE_PDO,
    0,
    PciInterface_DevicePresent,
    devpresent_Constructor,
    devpresent_Initializer
}

Definition at line 18 of file devhere.c.

Referenced by PdoQueryInterface(), and VideoPortCheckForDeviceExistence().