fdo.c File Reference

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

Include dependency graph for fdo.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
static BOOLEAN NTAPI	PciGetRootBusRange (_In_ PCM_RESOURCE_LIST BootConfig, _Out_ PUCHAR FirstBus, _Out_ PUCHAR LastBus)
	Finds the bus number range a root bus decodes in its boot configuration.
static VOID NTAPI	PciDeleteBusChildren (_Inout_ PPCI_FDO_EXTENSION FdoExtension)
	Deletes the PDOs of a bus being removed. Each one already had its own remove.
static VOID NTAPI	PciFreeBusSecondaryExtensions (_Inout_ PPCI_FDO_EXTENSION FdoExtension)
	Destroys the arbiter instances a bus being removed still holds.
NTSTATUS NTAPI	PciFdoIrpStartDevice (IN PIRP Irp, IN PIO_STACK_LOCATION IoStackLocation, IN PPCI_FDO_EXTENSION DeviceExtension)
NTSTATUS NTAPI	PciFdoIrpQueryRemoveDevice (IN PIRP Irp, IN PIO_STACK_LOCATION IoStackLocation, IN PPCI_FDO_EXTENSION DeviceExtension)
NTSTATUS NTAPI	PciFdoIrpRemoveDevice (IN PIRP Irp, IN PIO_STACK_LOCATION IoStackLocation, IN PPCI_FDO_EXTENSION DeviceExtension)
NTSTATUS NTAPI	PciFdoIrpCancelRemoveDevice (IN PIRP Irp, IN PIO_STACK_LOCATION IoStackLocation, IN PPCI_FDO_EXTENSION DeviceExtension)
NTSTATUS NTAPI	PciFdoIrpStopDevice (IN PIRP Irp, IN PIO_STACK_LOCATION IoStackLocation, IN PPCI_FDO_EXTENSION DeviceExtension)
NTSTATUS NTAPI	PciFdoIrpQueryStopDevice (IN PIRP Irp, IN PIO_STACK_LOCATION IoStackLocation, IN PPCI_FDO_EXTENSION DeviceExtension)
NTSTATUS NTAPI	PciFdoIrpCancelStopDevice (IN PIRP Irp, IN PIO_STACK_LOCATION IoStackLocation, IN PPCI_FDO_EXTENSION DeviceExtension)
NTSTATUS NTAPI	PciFdoIrpQueryDeviceRelations (IN PIRP Irp, IN PIO_STACK_LOCATION IoStackLocation, IN PPCI_FDO_EXTENSION DeviceExtension)
NTSTATUS NTAPI	PciFdoIrpQueryInterface (IN PIRP Irp, IN PIO_STACK_LOCATION IoStackLocation, IN PPCI_FDO_EXTENSION DeviceExtension)
NTSTATUS NTAPI	PciFdoIrpQueryCapabilities (IN PIRP Irp, IN PIO_STACK_LOCATION IoStackLocation, IN PPCI_FDO_EXTENSION DeviceExtension)
NTSTATUS NTAPI	PciFdoIrpDeviceUsageNotification (IN PIRP Irp, IN PIO_STACK_LOCATION IoStackLocation, IN PPCI_FDO_EXTENSION DeviceExtension)
NTSTATUS NTAPI	PciFdoIrpSurpriseRemoval (IN PIRP Irp, IN PIO_STACK_LOCATION IoStackLocation, IN PPCI_FDO_EXTENSION DeviceExtension)
NTSTATUS NTAPI	PciFdoIrpQueryLegacyBusInformation (IN PIRP Irp, IN PIO_STACK_LOCATION IoStackLocation, IN PPCI_FDO_EXTENSION DeviceExtension)
VOID NTAPI	PciGetHotPlugParameters (IN PPCI_FDO_EXTENSION FdoExtension)
VOID NTAPI	PciInitializeFdoExtensionCommonFields (PPCI_FDO_EXTENSION FdoExtension, IN PDEVICE_OBJECT DeviceObject, IN PDEVICE_OBJECT PhysicalDeviceObject)
NTSTATUS NTAPI	PciAddDevice (IN PDRIVER_OBJECT DriverObject, IN PDEVICE_OBJECT PhysicalDeviceObject)

Variables
SINGLE_LIST_ENTRY	PciFdoExtensionListHead
BOOLEAN	PciBreakOnDefault
PCI_MN_DISPATCH_TABLE	PciFdoDispatchPowerTable []
PCI_MN_DISPATCH_TABLE	PciFdoDispatchPnpTable []
PCI_MJ_DISPATCH_TABLE	PciFdoDispatchTable

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 13 of file fdo.c.

Function Documentation

PciAddDevice()

NTSTATUS NTAPI PciAddDevice	(	IN PDRIVER_OBJECT	DriverObject,
		IN PDEVICE_OBJECT	PhysicalDeviceObject
	)

Definition at line 707 of file fdo.c.

{
    PCM_RESOURCE_LIST Descriptor;
    PDEVICE_OBJECT AttachedTo;
    PPCI_FDO_EXTENSION FdoExtension;
    PPCI_FDO_EXTENSION ParentExtension;
    PPCI_PDO_EXTENSION PdoExtension;
    PDEVICE_OBJECT DeviceObject;
    UCHAR Buffer[sizeof(KEY_VALUE_PARTIAL_INFORMATION) + sizeof(ULONG)];
    PKEY_VALUE_PARTIAL_INFORMATION ValueInfo = (PKEY_VALUE_PARTIAL_INFORMATION)Buffer;
    NTSTATUS Status;
    HANDLE KeyHandle;
    UNICODE_STRING ValueName;
    ULONG ResultLength;
    PAGED_CODE();
    DPRINT1("PCIX - AddDevice (a new bus). PDO: %p (Driver: %wZ)\n",
            PhysicalDeviceObject, &PhysicalDeviceObject->DriverObject->DriverName);
 
    /* Zero out variables so failure path knows what to do */
    AttachedTo = NULL;
    FdoExtension = NULL;
    PdoExtension = NULL;
    DeviceObject = NULL;
 
    do
    {
        /* Check if there's already a device extension for this bus */
        ParentExtension = PciFindParentPciFdoExtension(PhysicalDeviceObject,
                                                       &PciGlobalLock);
        if (ParentExtension)
        {
            /* Make sure we find a real PDO */
            PdoExtension = PhysicalDeviceObject->DeviceExtension;
            ASSERT_PDO(PdoExtension);
 
            /* Make sure it's a PCI-to-PCI bridge */
            if ((PdoExtension->BaseClass != PCI_CLASS_BRIDGE_DEV) ||
                (PdoExtension->SubClass != PCI_SUBCLASS_BR_PCI_TO_PCI))
            {
                /* This should never happen */
                DPRINT1("PCIX - PciAddDevice for Non-Root/Non-PCI-PCI bridge,\n"
                        "      Class %02x, SubClass %02x, will not add.\n",
                        PdoExtension->BaseClass,
                        PdoExtension->SubClass);
                ASSERT((PdoExtension->BaseClass == PCI_CLASS_BRIDGE_DEV) &&
                       (PdoExtension->SubClass == PCI_SUBCLASS_BR_PCI_TO_PCI));
 
                /* Enter the failure path */
                Status = STATUS_INVALID_DEVICE_REQUEST;
                break;
            }
 
            /* Subordinate bus on the bridge */
            DPRINT1("PCIX - AddDevice (new bus is child of bus 0x%x).\n",
                    ParentExtension->BaseBus);
 
            /* Make sure PCI bus numbers are configured */
            if (!PciAreBusNumbersConfigured(PdoExtension))
            {
                /* This is a critical failure */
                DPRINT1("PCIX - Bus numbers not configured for bridge (0x%x.0x%x.0x%x)\n",
                        ParentExtension->BaseBus,
                        PdoExtension->Slot.u.bits.DeviceNumber,
                        PdoExtension->Slot.u.bits.FunctionNumber);
 
                /* Enter the failure path */
                Status = STATUS_INVALID_DEVICE_REQUEST;
                break;
            }
        }
 
        /* Create the FDO for the bus */
        Status = IoCreateDevice(DriverObject,
                                sizeof(PCI_FDO_EXTENSION),
                                NULL,
                                FILE_DEVICE_BUS_EXTENDER,
                                0,
                                0,
                                &DeviceObject);
        if (!NT_SUCCESS(Status)) break;
 
        /* Initialize the extension for the FDO */
        FdoExtension = DeviceObject->DeviceExtension;
        PciInitializeFdoExtensionCommonFields(DeviceObject->DeviceExtension,
                                              DeviceObject,
                                              PhysicalDeviceObject);
 
        /* Attach to the root PDO */
        Status = STATUS_NO_SUCH_DEVICE;
        AttachedTo = IoAttachDeviceToDeviceStack(DeviceObject,
                                                 PhysicalDeviceObject);
        ASSERT(AttachedTo != NULL);
        if (!AttachedTo) break;
        FdoExtension->AttachedDeviceObject = AttachedTo;
 
        /* Check if this is a child bus, or the root */
        if (ParentExtension)
        {
            /* The child inherits root data */
            FdoExtension->BaseBus = PdoExtension->Dependent.type1.SecondaryBus;
            FdoExtension->BusRootFdoExtension = ParentExtension->BusRootFdoExtension;
            PdoExtension->BridgeFdoExtension = FdoExtension;
            FdoExtension->ParentFdoExtension = ParentExtension;
        }
        else
        {
            /* Query the boot configuration */
            Status = PciGetDeviceProperty(PhysicalDeviceObject,
                                          DevicePropertyBootConfiguration,
                                          (PVOID*)&Descriptor);
            if (!NT_SUCCESS(Status))
            {
                /* No configuration has been set */
                Descriptor = NULL;
            }
 
            /* The firmware reports the bus numbers this root decodes in its boot config */
            if (Descriptor &&
                PciGetRootBusRange(Descriptor,
                                   &FdoExtension->BaseBus,
                                   &FdoExtension->MaxSubordinateBus))
            {
                DPRINT1("PCIX - Root bus range 0x%x to 0x%x.\n",
                        FdoExtension->BaseBus,
                        FdoExtension->MaxSubordinateBus);
            }
            else
            {
                /* Default configuration isn't the normal path on Windows */
                if (PciBreakOnDefault)
                {
                    /* If a second bus is found and there's still no data, crash */
                    KeBugCheckEx(PCI_BUS_DRIVER_INTERNAL,
                                 0xDEAD0010u,
                                 (ULONG_PTR)DeviceObject,
                                 0,
                                 0);
                }
 
                /* Warn that a default configuration will be used, and set bus 0 */
                DPRINT1("PCIX - Will use default configuration.\n");
                PciBreakOnDefault = TRUE;
                FdoExtension->BaseBus = 0;
                FdoExtension->MaxSubordinateBus = 0xFF;
            }
 
            if (Descriptor)
                ExFreePoolWithTag(Descriptor, 0);
 
            /* This is the root bus */
            FdoExtension->BusRootFdoExtension = FdoExtension;
        }
 
        /* Get the HAL or ACPI Bus Handler Callbacks for Configuration Access */
        Status = PciGetConfigHandlers(FdoExtension);
        if (!NT_SUCCESS(Status)) break;
 
        /* Map this bus for extended configuration space access */
        PciInitializeEcam(FdoExtension);
 
        /* Initialize all the supported PCI arbiters */
        Status = PciInitializeArbiters(FdoExtension);
        if (!NT_SUCCESS(Status)) break;
 
        /* This is a real FDO, insert it into the list */
        FdoExtension->Fake = FALSE;
        PciInsertEntryAtTail(&PciFdoExtensionListHead,
                             FdoExtension,
                             &PciGlobalLock);
 
        /* Open the device registry key so that we can query the errata flags */
        IoOpenDeviceRegistryKey(DeviceObject,
                                PLUGPLAY_REGKEY_DEVICE,
                                KEY_ALL_ACCESS,
                                &KeyHandle),
 
        /* Open the value that contains errata flags for this bus instance */
        RtlInitUnicodeString(&ValueName, L"HackFlags");
        Status = ZwQueryValueKey(KeyHandle,
                                 &ValueName,
                                 KeyValuePartialInformation,
                                 ValueInfo,
                                 sizeof(Buffer),
                                 &ResultLength);
        ZwClose(KeyHandle);
        if (NT_SUCCESS(Status))
        {
            /* Make sure the data is of expected type and size */
            if ((ValueInfo->Type == REG_DWORD) &&
                (ValueInfo->DataLength == sizeof(ULONG)))
            {
                /* Read the flags for this bus */
                FdoExtension->BusHackFlags = *(PULONG)&ValueInfo->Data;
            }
        }
 
        /* Query ACPI for PCI HotPlug Support */
        PciGetHotPlugParameters(FdoExtension);
 
        /* The Bus FDO is now initialized */
        DeviceObject->Flags &= ~DO_DEVICE_INITIALIZING;
        return STATUS_SUCCESS;
    } while (FALSE);
 
    /* This is the failure path */
    ASSERT(!NT_SUCCESS(Status));
 
    /* Check if the FDO extension exists */
    if (FdoExtension) DPRINT1("PCIX - Should destroy secondaries\n");
 
    /* Delete device objects */
    if (AttachedTo) IoDetachDevice(AttachedTo);
    if (DeviceObject) IoDeleteDevice(DeviceObject);
    return Status;
}

PciDeleteBusChildren()

static VOID NTAPI PciDeleteBusChildren ( _Inout_ PPCI_FDO_EXTENSION  FdoExtension )

static

Deletes the PDOs of a bus being removed. Each one already had its own remove.

Definition at line 130 of file fdo.c.

{
    PPCI_PDO_EXTENSION PdoExtension, NextExtension;
    PAGED_CODE();
 
    KeEnterCriticalRegion();
    KeWaitForSingleObject(&FdoExtension->ChildListLock, Executive, KernelMode, FALSE, NULL);
 
    PdoExtension = FdoExtension->ChildPdoList;
    FdoExtension->ChildPdoList = NULL;
    FdoExtension->ChildBridgePdoList = NULL;
 
    KeSetEvent(&FdoExtension->ChildListLock, IO_NO_INCREMENT, FALSE);
    KeLeaveCriticalRegion();
 
    while (PdoExtension)
    {
        ASSERT_PDO(PdoExtension);
        ASSERT(PdoExtension->DeviceState != PciStarted);
 
        /* The extension goes away with the device object */
        NextExtension = PdoExtension->Next;
 
        if (PdoExtension->Resources)
            ExFreePoolWithTag(PdoExtension->Resources, PCI_POOL_TAG);
 
        IoDeleteDevice(PdoExtension->PhysicalDeviceObject);
        PdoExtension = NextExtension;
    }
}

Referenced by PciFdoIrpRemoveDevice().

PciFdoIrpCancelRemoveDevice()

NTSTATUS NTAPI PciFdoIrpCancelRemoveDevice	(	IN PIRP	Irp,
		IN PIO_STACK_LOCATION	IoStackLocation,
		IN PPCI_FDO_EXTENSION	DeviceExtension
	)

Definition at line 322 of file fdo.c.

{
    PAGED_CODE();
 
    UNREFERENCED_PARAMETER(Irp);
    UNREFERENCED_PARAMETER(IoStackLocation);
 
    /* The remove is off, so the bus stays where it was */
    PciCancelStateTransition(DeviceExtension, PciDeleted);
    return STATUS_SUCCESS;
}

PciFdoIrpCancelStopDevice()

NTSTATUS NTAPI PciFdoIrpCancelStopDevice	(	IN PIRP	Irp,
		IN PIO_STACK_LOCATION	IoStackLocation,
		IN PPCI_FDO_EXTENSION	DeviceExtension
	)

Definition at line 382 of file fdo.c.

{
    PAGED_CODE();
 
    UNREFERENCED_PARAMETER(Irp);
    UNREFERENCED_PARAMETER(IoStackLocation);
 
    /* The stop is off, so the bus keeps its windows */
    PciCancelStateTransition(DeviceExtension, PciStopped);
    return STATUS_SUCCESS;
}

PciFdoIrpDeviceUsageNotification()

NTSTATUS NTAPI PciFdoIrpDeviceUsageNotification	(	IN PIRP	Irp,
		IN PIO_STACK_LOCATION	IoStackLocation,
		IN PPCI_FDO_EXTENSION	DeviceExtension
	)

Definition at line 527 of file fdo.c.

{
    PAGED_CODE();
 
    /* A failure from below stands, but a lower driver that ignored it does not count */
    if (!NT_SUCCESS(Irp->IoStatus.Status) &&
        (Irp->IoStatus.Status != STATUS_NOT_SUPPORTED))
    {
        return Irp->IoStatus.Status;
    }
 
    return PciUpdateDeviceUsage(&DeviceExtension->PowerState, IoStackLocation);
}

PciFdoIrpQueryCapabilities()

NTSTATUS NTAPI PciFdoIrpQueryCapabilities	(	IN PIRP	Irp,
		IN PIO_STACK_LOCATION	IoStackLocation,
		IN PPCI_FDO_EXTENSION	DeviceExtension
	)

Definition at line 500 of file fdo.c.

{
    PDEVICE_CAPABILITIES Capabilities;
    PAGED_CODE();
    ASSERT_FDO(DeviceExtension);
 
    UNREFERENCED_PARAMETER(Irp);
 
    /* Get the capabilities */
    Capabilities = IoStackLocation->Parameters.DeviceCapabilities.Capabilities;
 
    /* Inherit wake levels and power mappings from the higher-up capabilities */
    DeviceExtension->PowerState.SystemWakeLevel = Capabilities->SystemWake;
    DeviceExtension->PowerState.DeviceWakeLevel = Capabilities->DeviceWake;
    RtlCopyMemory(DeviceExtension->PowerState.SystemStateMapping,
                  Capabilities->DeviceState,
                  sizeof(DeviceExtension->PowerState.SystemStateMapping));
 
    /* Dump the capabilities and return success */
    PciDebugDumpQueryCapabilities(Capabilities);
    return STATUS_SUCCESS;
}

PciFdoIrpQueryDeviceRelations()

NTSTATUS NTAPI PciFdoIrpQueryDeviceRelations	(	IN PIRP	Irp,
		IN PIO_STACK_LOCATION	IoStackLocation,
		IN PPCI_FDO_EXTENSION	DeviceExtension
	)

Definition at line 398 of file fdo.c.

{
    NTSTATUS Status;
    PAGED_CODE();
 
    /* Are bus relations being queried? */
    if (IoStackLocation->Parameters.QueryDeviceRelations.Type != BusRelations)
    {
        /* The FDO is a bus, so only bus relations can be obtained */
        Status = STATUS_NOT_SUPPORTED;
    }
    else
    {
        /* Scan the PCI bus and build the device relations for the caller */
        Status = PciQueryDeviceRelations(DeviceExtension,
                                         (PDEVICE_RELATIONS*)
                                         &Irp->IoStatus.Information);
    }
 
    /* Return the enumeration status back */
    return Status;
}

PciFdoIrpQueryInterface()

NTSTATUS NTAPI PciFdoIrpQueryInterface	(	IN PIRP	Irp,
		IN PIO_STACK_LOCATION	IoStackLocation,
		IN PPCI_FDO_EXTENSION	DeviceExtension
	)

Definition at line 425 of file fdo.c.

{
    NTSTATUS Status;
    PAGED_CODE();
    ASSERT(DeviceExtension->ExtensionType == PciFdoExtensionType);
 
    /* Deleted extensions don't respond to IRPs */
    if (DeviceExtension->DeviceState == PciDeleted)
    {
        /* Hand it back to try to deal with it */
        return PciPassIrpFromFdoToPdo(DeviceExtension, Irp);
    }
 
    /* Query our driver for this interface */
    Status = PciQueryInterface(DeviceExtension,
                               IoStackLocation->Parameters.QueryInterface.
                               InterfaceType,
                               IoStackLocation->Parameters.QueryInterface.
                               Size,
                               IoStackLocation->Parameters.QueryInterface.
                               Version,
                               IoStackLocation->Parameters.QueryInterface.
                               InterfaceSpecificData,
                               IoStackLocation->Parameters.QueryInterface.
                               Interface,
                               FALSE);
    if (NT_SUCCESS(Status))
    {
        /* We found it, let the PDO handle it */
        Irp->IoStatus.Status = Status;
        return PciPassIrpFromFdoToPdo(DeviceExtension, Irp);
    }
    else if (Status == STATUS_NOT_SUPPORTED)
    {
        /* Otherwise, we can't handle it, let someone else down the stack try */
        Status = PciCallDownIrpStack(DeviceExtension, Irp);
        if (Status == STATUS_NOT_SUPPORTED)
        {
            /* They can't either, try a last-resort interface lookup */
            Status = PciQueryInterface(DeviceExtension,
                                       IoStackLocation->Parameters.QueryInterface.
                                       InterfaceType,
                                       IoStackLocation->Parameters.QueryInterface.
                                       Size,
                                       IoStackLocation->Parameters.QueryInterface.
                                       Version,
                                       IoStackLocation->Parameters.QueryInterface.
                                       InterfaceSpecificData,
                                       IoStackLocation->Parameters.QueryInterface.
                                       Interface,
                                       TRUE);
        }
    }
 
    /* Has anyone claimed this interface yet? */
    if (Status == STATUS_NOT_SUPPORTED)
    {
        /* No, return the original IRP status */
        Status = Irp->IoStatus.Status;
    }
    else
    {
        /* Yes, set the new IRP status */
        Irp->IoStatus.Status = Status;
    }
 
    /* Complete this IRP */
    IoCompleteRequest(Irp, IO_NO_INCREMENT);
    return Status;
}

PciFdoIrpQueryLegacyBusInformation()

NTSTATUS NTAPI PciFdoIrpQueryLegacyBusInformation	(	IN PIRP	Irp,
		IN PIO_STACK_LOCATION	IoStackLocation,
		IN PPCI_FDO_EXTENSION	DeviceExtension
	)

Definition at line 567 of file fdo.c.

{
    PLEGACY_BUS_INFORMATION BusInformation;
    PAGED_CODE();
 
    UNREFERENCED_PARAMETER(IoStackLocation);
 
    /* The PnP manager frees this once it has recorded the bus */
    BusInformation = ExAllocatePoolWithTag(PagedPool,
                                           sizeof(*BusInformation),
                                           PCI_POOL_TAG);
    if (!BusInformation)
        return STATUS_INSUFFICIENT_RESOURCES;
 
    BusInformation->BusTypeGuid = GUID_BUS_TYPE_PCI;
    BusInformation->LegacyBusType = PCIBus;
    BusInformation->BusNumber = DeviceExtension->BaseBus;
 
    Irp->IoStatus.Information = (ULONG_PTR)BusInformation;
    return STATUS_SUCCESS;
}

PciFdoIrpQueryRemoveDevice()

NTSTATUS NTAPI PciFdoIrpQueryRemoveDevice	(	IN PIRP	Irp,
		IN PIO_STACK_LOCATION	IoStackLocation,
		IN PPCI_FDO_EXTENSION	DeviceExtension
	)

Definition at line 236 of file fdo.c.

{
    PAGED_CODE();
 
    UNREFERENCED_PARAMETER(Irp);
    UNREFERENCED_PARAMETER(IoStackLocation);
 
    /* Paging, hibernation and dump files behind this bus cannot lose their path */
    if (DeviceExtension->PowerState.Paging ||
        DeviceExtension->PowerState.Hibernate ||
        DeviceExtension->PowerState.CrashDump)
    {
        return STATUS_DEVICE_BUSY;
    }
 
    /* The remove that follows commits this */
    return PciBeginStateTransition(DeviceExtension, PciDeleted);
}

PciFdoIrpQueryStopDevice()

NTSTATUS NTAPI PciFdoIrpQueryStopDevice	(	IN PIRP	Irp,
		IN PIO_STACK_LOCATION	IoStackLocation,
		IN PPCI_FDO_EXTENSION	DeviceExtension
	)

Definition at line 356 of file fdo.c.

{
    PAGED_CODE();
 
    UNREFERENCED_PARAMETER(Irp);
    UNREFERENCED_PARAMETER(IoStackLocation);
 
    /* Paging, hibernation and dump files behind this bus cannot lose their path */
    if (DeviceExtension->PowerState.Paging ||
        DeviceExtension->PowerState.Hibernate ||
        DeviceExtension->PowerState.CrashDump)
    {
        return STATUS_DEVICE_BUSY;
    }
 
    /* Root bus ranges are fixed, and children would sit outside new bridge windows */
    if (PCI_IS_ROOT_FDO(DeviceExtension) || DeviceExtension->ChildPdoList)
        return STATUS_UNSUCCESSFUL;
 
    return PciBeginStateTransition(DeviceExtension, PciStopped);
}

PciFdoIrpRemoveDevice()

NTSTATUS NTAPI PciFdoIrpRemoveDevice	(	IN PIRP	Irp,
		IN PIO_STACK_LOCATION	IoStackLocation,
		IN PPCI_FDO_EXTENSION	DeviceExtension
	)

Definition at line 259 of file fdo.c.

{
    PDEVICE_OBJECT DeviceObject, AttachedDeviceObject;
    PPCI_PDO_EXTENSION BridgeExtension;
    PSINGLE_LIST_ENTRY Entry;
    NTSTATUS Status;
    PAGED_CODE();
 
    UNREFERENCED_PARAMETER(IoStackLocation);
 
    /* A remove with no query before it, such as after a failed start, begins the deletion here */
    if (DeviceExtension->TentativeNextState != PciDeleted)
        PciBeginStateTransition(DeviceExtension, PciDeleted);
 
    PciCommitStateTransition(DeviceExtension, PciDeleted);
 
    /* Unlink the bus first so no lookup can reach it while it comes apart */
    KeEnterCriticalRegion();
    KeWaitForSingleObject(&PciGlobalLock, Executive, KernelMode, FALSE, NULL);
 
    for (Entry = &PciFdoExtensionListHead; Entry->Next; Entry = Entry->Next)
    {
        if (Entry->Next == &DeviceExtension->List)
        {
            Entry->Next = DeviceExtension->List.Next;
            break;
        }
    }
 
    if (!PCI_IS_ROOT_FDO(DeviceExtension))
    {
        BridgeExtension = DeviceExtension->PhysicalDeviceObject->DeviceExtension;
        ASSERT_PDO(BridgeExtension);
 
        if (BridgeExtension->BridgeFdoExtension == DeviceExtension)
            BridgeExtension->BridgeFdoExtension = NULL;
    }
 
    KeSetEvent(&PciGlobalLock, IO_NO_INCREMENT, FALSE);
    KeLeaveCriticalRegion();
 
    PciDeleteBusChildren(DeviceExtension);
    PciFreeBusSecondaryExtensions(DeviceExtension);
 
    if (DeviceExtension->PreservedConfig)
        ExFreePoolWithTag(DeviceExtension->PreservedConfig, TAG_PCI_PRESERVED);
 
    /* The lower drivers see the remove before this device leaves the stack */
    DeviceObject = DeviceExtension->FunctionalDeviceObject;
    AttachedDeviceObject = DeviceExtension->AttachedDeviceObject;
 
    Irp->IoStatus.Status = STATUS_SUCCESS;
    Status = PciPassIrpFromFdoToPdo(DeviceExtension, Irp);
 
    IoDetachDevice(AttachedDeviceObject);
    IoDeleteDevice(DeviceObject);
    return Status;
}

PciFdoIrpStartDevice()

NTSTATUS NTAPI PciFdoIrpStartDevice	(	IN PIRP	Irp,
		IN PIO_STACK_LOCATION	IoStackLocation,
		IN PPCI_FDO_EXTENSION	DeviceExtension
	)

Definition at line 202 of file fdo.c.

{
    NTSTATUS Status;
    PCM_RESOURCE_LIST Resources;
    PAGED_CODE();
 
    /* The device stack must be starting the FDO in a success path */
    if (!NT_SUCCESS(Irp->IoStatus.Status)) return STATUS_NOT_SUPPORTED;
 
    /* Attempt to switch the state machine to the started state */
    Status = PciBeginStateTransition(DeviceExtension, PciStarted);
    if (!NT_SUCCESS(Status)) return Status;
 
    /* Only a root bus seeds its arbiters from these, a bus behind a bridge uses its windows */
    Resources = IoStackLocation->Parameters.StartDevice.AllocatedResources;
 
    /* Initialize the arbiter for this FDO */
    Status = PciInitializeArbiterRanges(DeviceExtension, Resources);
    if (!NT_SUCCESS(Status))
    {
        /* Cancel the transition if this failed */
        PciCancelStateTransition(DeviceExtension, PciStarted);
        return Status;
    }
 
    /* Commit the transition to the started state */
    PciCommitStateTransition(DeviceExtension, PciStarted);
    return STATUS_SUCCESS;
}

PciFdoIrpStopDevice()

NTSTATUS NTAPI PciFdoIrpStopDevice	(	IN PIRP	Irp,
		IN PIO_STACK_LOCATION	IoStackLocation,
		IN PPCI_FDO_EXTENSION	DeviceExtension
	)

Definition at line 338 of file fdo.c.

{
    PAGED_CODE();
 
    UNREFERENCED_PARAMETER(Irp);
    UNREFERENCED_PARAMETER(IoStackLocation);
 
    PciCommitStateTransition(DeviceExtension, PciStopped);
 
    /* The next start seeds the arbiters again from the windows it is given */
    DeviceExtension->ArbitersInitialized = FALSE;
    return STATUS_SUCCESS;
}

PciFdoIrpSurpriseRemoval()

NTSTATUS NTAPI PciFdoIrpSurpriseRemoval	(	IN PIRP	Irp,
		IN PIO_STACK_LOCATION	IoStackLocation,
		IN PPCI_FDO_EXTENSION	DeviceExtension
	)

Definition at line 545 of file fdo.c.

{
    PAGED_CODE();
 
    UNREFERENCED_PARAMETER(Irp);
    UNREFERENCED_PARAMETER(IoStackLocation);
 
    /* Only the remove that follows is left, and it commits the deletion */
    if (NT_SUCCESS(PciBeginStateTransition(DeviceExtension, PciSurpriseRemoved)))
    {
        PciCommitStateTransition(DeviceExtension, PciSurpriseRemoved);
        PciBeginStateTransition(DeviceExtension, PciDeleted);
    }
 
    /* Failing this would keep it from reaching the PDO below */
    return STATUS_SUCCESS;
}

PciFreeBusSecondaryExtensions()

static VOID NTAPI PciFreeBusSecondaryExtensions ( _Inout_ PPCI_FDO_EXTENSION  FdoExtension )

static

Destroys the arbiter instances a bus being removed still holds.

Definition at line 168 of file fdo.c.

{
    VOID (NTAPI *Destructor)(_In_ PVOID Extension);
    PPCI_SECONDARY_EXTENSION Extension;
    PSINGLE_LIST_ENTRY Entry;
    PAGED_CODE();
 
    KeEnterCriticalRegion();
    KeWaitForSingleObject(&FdoExtension->SecondaryExtLock, Executive, KernelMode, FALSE, NULL);
 
    Entry = FdoExtension->SecondaryExtension.Next;
    FdoExtension->SecondaryExtension.Next = NULL;
    FdoExtension->ArbitersInitialized = FALSE;
 
    KeSetEvent(&FdoExtension->SecondaryExtLock, IO_NO_INCREMENT, FALSE);
    KeLeaveCriticalRegion();
 
    while (Entry)
    {
        Extension = CONTAINING_RECORD(Entry, PCI_SECONDARY_EXTENSION, List);
        Entry = Entry->Next;
 
        /* The destructor frees the range lists, the instance itself is freed here */
        Destructor = Extension->Destructor;
        if (Destructor)
            Destructor(Extension);
 
        ExFreePoolWithTag(Extension, PCI_POOL_TAG);
    }
}

Referenced by PciFdoIrpRemoveDevice().

PciGetHotPlugParameters()

VOID NTAPI PciGetHotPlugParameters

(

IN PPCI_FDO_EXTENSION

FdoExtension

)

Definition at line 593 of file fdo.c.

{
    ACPI_EVAL_INPUT_BUFFER InputBuffer;
    PACPI_EVAL_OUTPUT_BUFFER OutputBuffer;
    PACPI_METHOD_ARGUMENT Argument;
    ULONG Length, i;
    NTSTATUS Status;
    PAGED_CODE();
 
    /* We should receive 4 parameters, per the HPP specification */
    Length = sizeof(ACPI_EVAL_OUTPUT_BUFFER) + 4 * sizeof(ACPI_METHOD_ARGUMENT);
 
    /* Allocate the buffer to hold the parameters */
    OutputBuffer = ExAllocatePoolWithTag(PagedPool, Length, PCI_POOL_TAG);
    if (!OutputBuffer) return;
 
    /* Initialize the output and input buffers. The method is _HPP */
    RtlZeroMemory(OutputBuffer, Length);
    *(PULONG)InputBuffer.MethodName = 'PPH_';
    InputBuffer.Signature = ACPI_EVAL_INPUT_BUFFER_SIGNATURE;
    do
    {
        /* Send the IOCTL to the ACPI driver */
        Status = PciSendIoctl(FdoExtension->PhysicalDeviceObject,
                              IOCTL_ACPI_EVAL_METHOD,
                              &InputBuffer,
                              sizeof(InputBuffer),
                              OutputBuffer,
                              Length);
        if (!NT_SUCCESS(Status))
        {
            /* The method failed, check if we can salvage data from parent */
            if (!PCI_IS_ROOT_FDO(FdoExtension))
            {
                /* Copy the root bus' hot plug parameters */
                FdoExtension->HotPlugParameters = FdoExtension->ParentFdoExtension->HotPlugParameters;
            }
 
            /* Nothing more to do on this path */
            break;
        }
 
        /* ACPI sent back some data. 4 parameters are expected in the output */
        if (OutputBuffer->Count != 4) break;
 
        /* Every one of them has to be an integer for the set to mean anything */
        Argument = OutputBuffer->Argument;
        for (i = 0; i < 4; i++)
        {
            if (Argument[i].Type != ACPI_METHOD_ARGUMENT_INTEGER)
                break;
        }
        if (i != 4)
        {
            DPRINT1("PCIX - _HPP returned something other than four integers\n");
            break;
        }
 
        /* Cache line size and latency timer are byte registers, SERR and PERR are flags */
        if ((Argument[0].Argument > MAXUCHAR) ||
            (Argument[1].Argument > MAXUCHAR) ||
            (Argument[2].Argument > 1) ||
            (Argument[3].Argument > 1))
        {
            DPRINT1("PCIX - _HPP returned values out of range, ignoring them\n");
            break;
        }
 
        /* Settings for devices that later appear in a hot plug slot on this bus */
        FdoExtension->HotPlugParameters.CacheLineSize = (UCHAR)Argument[0].Argument;
        FdoExtension->HotPlugParameters.LatencyTimer = (UCHAR)Argument[1].Argument;
        FdoExtension->HotPlugParameters.EnableSERR = (BOOLEAN)Argument[2].Argument;
        FdoExtension->HotPlugParameters.EnablePERR = (BOOLEAN)Argument[3].Argument;
        FdoExtension->HotPlugParameters.Acquired = TRUE;
 
        DPRINT1("PCIX - _HPP for FDO ext 0x%p: cache line %u, latency %u, SERR %u, PERR %u\n",
                FdoExtension,
                FdoExtension->HotPlugParameters.CacheLineSize,
                FdoExtension->HotPlugParameters.LatencyTimer,
                FdoExtension->HotPlugParameters.EnableSERR,
                FdoExtension->HotPlugParameters.EnablePERR);
    } while (FALSE);
 
    /* Free the buffer and return */
    ExFreePoolWithTag(OutputBuffer, 0);
}

Referenced by PciAddDevice().

PciGetRootBusRange()

static BOOLEAN NTAPI PciGetRootBusRange ( _In_ PCM_RESOURCE_LIST  BootConfig, _Out_ PUCHAR  FirstBus, _Out_ PUCHAR  LastBus  )

static

Finds the bus number range a root bus decodes in its boot configuration.

Returns

TRUE if the list has a bus number descriptor, FALSE otherwise.

Definition at line 82 of file fdo.c.

{
    PCM_FULL_RESOURCE_DESCRIPTOR FullDescriptor;
    PCM_PARTIAL_RESOURCE_DESCRIPTOR Partial;
    ULONG FullIndex, PartialIndex;
    ULONG EndBus;
    PAGED_CODE();
 
    FullDescriptor = BootConfig->List;
    for (FullIndex = 0; FullIndex < BootConfig->Count; FullIndex++)
    {
        Partial = FullDescriptor->PartialResourceList.PartialDescriptors;
        for (PartialIndex = 0;
             PartialIndex < FullDescriptor->PartialResourceList.Count;
             PartialIndex++)
        {
            if (Partial->Type != CmResourceTypeBusNumber)
            {
                Partial = CmiGetNextPartialDescriptor(Partial);
                continue;
            }
 
            /* Bus numbers on a single segment never go past 0xFF */
            EndBus = Partial->u.BusNumber.Start + Partial->u.BusNumber.Length - 1;
            ASSERT(Partial->u.BusNumber.Start <= EndBus);
            ASSERT(EndBus <= 0xFF);
 
            *FirstBus = (UCHAR)Partial->u.BusNumber.Start;
            *LastBus = (UCHAR)EndBus;
            return TRUE;
        }
 
        /* The next full descriptor follows the last partial one */
        FullDescriptor = (PCM_FULL_RESOURCE_DESCRIPTOR)Partial;
    }
 
    return FALSE;
}

Referenced by PciAddDevice().

PciInitializeFdoExtensionCommonFields()

VOID NTAPI PciInitializeFdoExtensionCommonFields	(	PPCI_FDO_EXTENSION	FdoExtension,
		IN PDEVICE_OBJECT	DeviceObject,
		IN PDEVICE_OBJECT	PhysicalDeviceObject
	)

Definition at line 682 of file fdo.c.

{
    /* Initialize the extension */
    RtlZeroMemory(FdoExtension, sizeof(PCI_FDO_EXTENSION));
 
    /* Setup the common fields */
    FdoExtension->PhysicalDeviceObject = PhysicalDeviceObject;
    FdoExtension->FunctionalDeviceObject = DeviceObject;
    FdoExtension->ExtensionType = PciFdoExtensionType;
    FdoExtension->PowerState.CurrentSystemState = PowerSystemWorking;
    FdoExtension->PowerState.CurrentDeviceState = PowerDeviceD0;
    FdoExtension->IrpDispatchTable = &PciFdoDispatchTable;
 
    /* Initialize the extension locks */
    KeInitializeEvent(&FdoExtension->SecondaryExtLock, SynchronizationEvent, TRUE);
    KeInitializeEvent(&FdoExtension->ChildListLock, SynchronizationEvent, TRUE);
 
    /* Initialize the default state */
    PciInitializeState(FdoExtension);
}

Referenced by PciAddDevice().

Variable Documentation

PciBreakOnDefault

BOOLEAN PciBreakOnDefault

Definition at line 19 of file fdo.c.

Referenced by PciAddDevice().

PciFdoDispatchPnpTable

PCI_MN_DISPATCH_TABLE PciFdoDispatchPnpTable[]

Initial value:

=
{
    {IRP_UPWARD,   (PCI_DISPATCH_FUNCTION)PciFdoIrpStartDevice},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciFdoIrpQueryRemoveDevice},
    {IRP_DISPATCH, (PCI_DISPATCH_FUNCTION)PciFdoIrpRemoveDevice},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciFdoIrpCancelRemoveDevice},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciFdoIrpStopDevice},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciFdoIrpQueryStopDevice},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciFdoIrpCancelStopDevice},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciFdoIrpQueryDeviceRelations},
    {IRP_DISPATCH, (PCI_DISPATCH_FUNCTION)PciFdoIrpQueryInterface},
    {IRP_UPWARD,   (PCI_DISPATCH_FUNCTION)PciFdoIrpQueryCapabilities},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciIrpNotSupported},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciIrpNotSupported},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciIrpNotSupported},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciIrpNotSupported},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciIrpNotSupported},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciIrpNotSupported},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciIrpNotSupported},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciIrpNotSupported},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciIrpNotSupported},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciIrpNotSupported},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciIrpNotSupported},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciIrpNotSupported},
    {IRP_UPWARD,   (PCI_DISPATCH_FUNCTION)PciFdoIrpDeviceUsageNotification},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciFdoIrpSurpriseRemoval},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciFdoIrpQueryLegacyBusInformation},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciIrpNotSupported}
}

Definition at line 30 of file fdo.c.

PciFdoDispatchPowerTable

PCI_MN_DISPATCH_TABLE PciFdoDispatchPowerTable[]

Initial value:

=
{
    {IRP_DISPATCH, (PCI_DISPATCH_FUNCTION)PciFdoWaitWake},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciIrpNotSupported},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciFdoSetPowerState},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciFdoIrpQueryPower},
    {IRP_DOWNWARD, (PCI_DISPATCH_FUNCTION)PciIrpNotSupported}
}

Definition at line 21 of file fdo.c.

PciFdoDispatchTable

PCI_MJ_DISPATCH_TABLE PciFdoDispatchTable

Initial value:

=
{
    IRP_MN_QUERY_LEGACY_BUS_INFORMATION,
    PciFdoDispatchPnpTable,
    IRP_MN_QUERY_POWER,
    PciFdoDispatchPowerTable,
    IRP_DOWNWARD,
    (PCI_DISPATCH_FUNCTION)PciIrpNotSupported,
    IRP_DOWNWARD,
    (PCI_DISPATCH_FUNCTION)PciIrpNotSupported
}

Definition at line 60 of file fdo.c.

Referenced by PciInitializeFdoExtensionCommonFields().

PciFdoExtensionListHead

SINGLE_LIST_ENTRY PciFdoExtensionListHead

Definition at line 18 of file fdo.c.

Referenced by _Requires_lock_held_(), devpresent_SearchAllBuses(), PciAddDevice(), PciDriverUnload(), PciFdoIrpRemoveDevice(), PciFindParentPciFdoExtension(), and PciVerifierCheckAllBridges().