misc.c File Reference

#include "ntdef.h"
#include "precomp.h"
#include <debug.h>

Include dependency graph for misc.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
NTSTATUS NTAPI	ForwardIrpAndForget (_In_ PDEVICE_OBJECT LowerDevice, _In_ PIRP Irp)
INTERFACE_TYPE	GetBusInterface (PDEVICE_OBJECT DeviceObject)
static ULONG	GetResourceListSize (PCM_RESOURCE_LIST ResourceList)
PCM_RESOURCE_LIST	CopyResourceList (POOL_TYPE PoolType, PCM_RESOURCE_LIST Source)
NTSTATUS	QueryBusInterface (PDEVICE_OBJECT DeviceObject, PGUID Guid, USHORT Size, USHORT Version, PBUS_INTERFACE_STANDARD Interface, PVOID InterfaceSpecificData)
BOOLEAN	TranslateResourceListAddress (PFDO_DEVICE_EXTENSION DeviceExtension, INTERFACE_TYPE BusType, ULONG SystemIoBusNumber, STOR_PHYSICAL_ADDRESS IoAddress, ULONG NumberOfBytes, BOOLEAN InIoSpace, PPHYSICAL_ADDRESS TranslatedAddress)
NTSTATUS	GetResourceListInterrupt (PFDO_DEVICE_EXTENSION DeviceExtension, PULONG Vector, PKIRQL Irql, KINTERRUPT_MODE *InterruptMode, PBOOLEAN ShareVector, PKAFFINITY Affinity)
NTSTATUS	AllocateAddressMapping (PMAPPED_ADDRESS *MappedAddressList, STOR_PHYSICAL_ADDRESS IoAddress, PVOID MappedAddress, ULONG NumberOfBytes, ULONG BusNumber)
VOID NTAPI	SimpleTimerCallbackDpcRoutine (PKDPC Dpc, PVOID DeferredContext, PVOID SystemArgument1, PVOID SystemArgument2)
VOID NTAPI	TimerCallbackDpcRoutine (PKDPC Dpc, PVOID DeferredContext, PVOID SystemArgument1, PVOID SystemArgument2)
PCSTR	GetDeviceType (_In_ PINQUIRYDATA InquiryData)
PCSTR	GetGenericType (_In_ PINQUIRYDATA InquiryData)

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 13 of file misc.c.

Function Documentation

AllocateAddressMapping()

NTSTATUS AllocateAddressMapping	(	PMAPPED_ADDRESS *	MappedAddressList,
		STOR_PHYSICAL_ADDRESS	IoAddress,
		PVOID	MappedAddress,
		ULONG	NumberOfBytes,
		ULONG	BusNumber
	)

Definition at line 291 of file misc.c.

{
    PMAPPED_ADDRESS Mapping;
 
    DPRINT1("AllocateAddressMapping()\n");
 
    Mapping = ExAllocatePoolWithTag(NonPagedPool,
                                    sizeof(MAPPED_ADDRESS),
                                    TAG_ADDRESS_MAPPING);
    if (Mapping == NULL)
    {
        DPRINT1("No memory!\n");
        return STATUS_NO_MEMORY;
    }
 
    RtlZeroMemory(Mapping, sizeof(MAPPED_ADDRESS));
 
    Mapping->NextMappedAddress = *MappedAddressList;
    *MappedAddressList = Mapping;
 
    Mapping->IoAddress = IoAddress;
    Mapping->MappedAddress = MappedAddress;
    Mapping->NumberOfBytes = NumberOfBytes;
    Mapping->BusNumber = BusNumber;
 
    return STATUS_SUCCESS;
}

Referenced by StorPortGetDeviceBase().

CopyResourceList()

PCM_RESOURCE_LIST CopyResourceList	(	POOL_TYPE	PoolType,
		PCM_RESOURCE_LIST	Source
	)

Definition at line 92 of file misc.c.

{
    PCM_RESOURCE_LIST Destination;
    ULONG Size;
 
    DPRINT1("CopyResourceList(%lu %p)\n",
            PoolType, Source);
 
    /* Get the size of the resource list */
    Size = GetResourceListSize(Source);
 
    /* Allocate a new buffer */
    Destination = ExAllocatePoolWithTag(PoolType,
                                        Size,
                                        TAG_RESOURCE_LIST);
    if (Destination == NULL)
        return NULL;
 
    /* Copy the resource list */
    RtlCopyMemory(Destination,
                  Source,
                  Size);
 
    return Destination;
}

Referenced by PortFdoStartDevice().

ForwardIrpAndForget()

NTSTATUS NTAPI ForwardIrpAndForget	(	_In_ PDEVICE_OBJECT	LowerDevice,
		_In_ PIRP	Irp
	)

Definition at line 21 of file misc.c.

{
    ASSERT(LowerDevice);
 
    IoSkipCurrentIrpStackLocation(Irp);
    return IoCallDriver(LowerDevice, Irp);
}

GetBusInterface()

INTERFACE_TYPE GetBusInterface

(

PDEVICE_OBJECT

DeviceObject

)

Definition at line 33 of file misc.c.

{
    GUID Guid;
    ULONG Length;
    NTSTATUS Status;
 
    Status = IoGetDeviceProperty(DeviceObject,
                                 DevicePropertyBusTypeGuid,
                                 sizeof(Guid),
                                 &Guid,
                                 &Length);
    if (!NT_SUCCESS(Status))
        return InterfaceTypeUndefined;
 
    if (RtlCompareMemory(&Guid, &GUID_BUS_TYPE_PCMCIA, sizeof(GUID)) == sizeof(GUID))
        return PCMCIABus;
    else if (RtlCompareMemory(&Guid, &GUID_BUS_TYPE_PCI, sizeof(GUID)) == sizeof(GUID))
        return PCIBus;
    else if (RtlCompareMemory(&Guid, &GUID_BUS_TYPE_ISAPNP, sizeof(GUID)) == sizeof(GUID))
        return PNPISABus;
 
    return InterfaceTypeUndefined;
}

Referenced by PortFdoStartMiniport().

GetDeviceType()

PCSTR GetDeviceType

(

_In_ PINQUIRYDATA

InquiryData

)

Definition at line 374 of file misc.c.

{
    switch (InquiryData->DeviceType)
    {
        case DIRECT_ACCESS_DEVICE:
            return "Disk";
        case SEQUENTIAL_ACCESS_DEVICE:
            return "Sequential";
        case PRINTER_DEVICE:
            return "Printer";
        case PROCESSOR_DEVICE:
            return "Processor";
        case WRITE_ONCE_READ_MULTIPLE_DEVICE:
            return "Worm";
        case READ_ONLY_DIRECT_ACCESS_DEVICE:
            return "CdRom";
        case SCANNER_DEVICE:
            return "Scanner";
        case OPTICAL_DEVICE:
            return "Optical";
        case MEDIUM_CHANGER:
            return "Changer";
        case COMMUNICATION_DEVICE:
            return "Net";
        case ARRAY_CONTROLLER_DEVICE:
            return "Array";
        case SCSI_ENCLOSURE_DEVICE:
            return "Enclosure";
        case REDUCED_BLOCK_DEVICE:
            return "RBC";
        case OPTICAL_CARD_READER_WRITER_DEVICE:
            return "CardReader";
        case BRIDGE_CONTROLLER_DEVICE:
            return "Bridge";
        default:
            return "Other";
    }
}

GetGenericType()

PCSTR GetGenericType

(

_In_ PINQUIRYDATA

InquiryData

)

Definition at line 416 of file misc.c.

{
    switch (InquiryData->DeviceType)
    {
        case DIRECT_ACCESS_DEVICE:
            return "GenDisk";
        case PRINTER_DEVICE:
            return "GenPrinter";
        case WRITE_ONCE_READ_MULTIPLE_DEVICE:
            return "GenWorm";
        case READ_ONLY_DIRECT_ACCESS_DEVICE:
            return "GenCdRom";
        case SCANNER_DEVICE:
            return "GenScanner";
        case OPTICAL_DEVICE:
            return "GenOptical";
        case MEDIUM_CHANGER:
            return "ScsiChanger";
        case COMMUNICATION_DEVICE:
            return "ScsiNet";
        case ARRAY_CONTROLLER_DEVICE:
            return "ScsiArray";
        case SCSI_ENCLOSURE_DEVICE:
            return "ScsiEnclosure";
        case REDUCED_BLOCK_DEVICE:
            return "ScsiRBC";
        case OPTICAL_CARD_READER_WRITER_DEVICE:
            return "ScsiCardReader";
        case BRIDGE_CONTROLLER_DEVICE:
            return "ScsiBridge";
        default:
            return "ScsiOther";
    }
}

GetResourceListInterrupt()

NTSTATUS GetResourceListInterrupt	(	PFDO_DEVICE_EXTENSION	DeviceExtension,
		PULONG	Vector,
		PKIRQL	Irql,
		KINTERRUPT_MODE *	InterruptMode,
		PBOOLEAN	ShareVector,
		PKAFFINITY	Affinity
	)

Definition at line 242 of file misc.c.

{
    PCM_FULL_RESOURCE_DESCRIPTOR FullDescriptor;
    PCM_PARTIAL_RESOURCE_DESCRIPTOR PartialDescriptor;
    INT i, j;
 
    DPRINT1("GetResourceListInterrupt(%p)\n",
            DeviceExtension);
 
    FullDescriptor = DeviceExtension->TranslatedResources->List;
    for (i = 0; i < DeviceExtension->TranslatedResources->Count; i++)
    {
        for (j = 0; j < FullDescriptor->PartialResourceList.Count; j++)
        {
            PartialDescriptor = FullDescriptor->PartialResourceList.PartialDescriptors + j;
 
            switch (PartialDescriptor->Type)
            {
                case CmResourceTypeInterrupt:
                    DPRINT1("Interrupt: Level %lu  Vector %lu\n",
                            PartialDescriptor->u.Interrupt.Level,
                            PartialDescriptor->u.Interrupt.Vector);
 
                    *Vector = PartialDescriptor->u.Interrupt.Vector;
                    *Irql = (KIRQL)PartialDescriptor->u.Interrupt.Level;
                    *InterruptMode = (PartialDescriptor->Flags & CM_RESOURCE_INTERRUPT_LATCHED) ? Latched : LevelSensitive;
                    *ShareVector = (PartialDescriptor->ShareDisposition == CmResourceShareShared) ? TRUE : FALSE;
                    *Affinity = PartialDescriptor->u.Interrupt.Affinity;
 
                    return STATUS_SUCCESS;
            }
        }
 
        /* Advance to next CM_FULL_RESOURCE_DESCRIPTOR block in memory. */
        FullDescriptor = (PCM_FULL_RESOURCE_DESCRIPTOR)(FullDescriptor->PartialResourceList.PartialDescriptors +
                                                        FullDescriptor->PartialResourceList.Count);
    }
 
    return STATUS_NOT_FOUND;
}

Referenced by PortFdoConnectInterrupt().

GetResourceListSize()

static ULONG GetResourceListSize ( PCM_RESOURCE_LIST  ResourceList )

static

Definition at line 61 of file misc.c.

{
    PCM_FULL_RESOURCE_DESCRIPTOR Descriptor;
    ULONG Size;
 
    DPRINT1("GetResourceListSize(%p)\n", ResourceList);
 
    Size = sizeof(CM_RESOURCE_LIST);
    if (ResourceList->Count == 0)
    {
        DPRINT1("Size: 0x%lx (%u)\n", Size, Size);
        return Size;
    }
 
    DPRINT1("ResourceList->Count: %lu\n", ResourceList->Count);
 
    Descriptor = &ResourceList->List[0];
 
    DPRINT1("PartialResourceList->Count: %lu\n", Descriptor->PartialResourceList.Count);
 
    /* Add the size of the partial descriptors */
    if (Descriptor->PartialResourceList.Count > 1)
        Size += (Descriptor->PartialResourceList.Count - 1) * sizeof(CM_PARTIAL_RESOURCE_DESCRIPTOR);
 
    DPRINT1("Size: 0x%lx (%u)\n", Size, Size);
    return Size;
}

Referenced by CopyResourceList().

QueryBusInterface()

NTSTATUS QueryBusInterface	(	PDEVICE_OBJECT	DeviceObject,
		PGUID	Guid,
		USHORT	Size,
		USHORT	Version,
		PBUS_INTERFACE_STANDARD	Interface,
		PVOID	InterfaceSpecificData
	)

Definition at line 122 of file misc.c.

{
    KEVENT Event;
    NTSTATUS Status;
    PIRP Irp;
    IO_STATUS_BLOCK IoStatus;
    PIO_STACK_LOCATION Stack;
 
    KeInitializeEvent(&Event, NotificationEvent, FALSE);
 
    Irp = IoBuildSynchronousFsdRequest(IRP_MJ_PNP,
                                       DeviceObject,
                                       NULL,
                                       0,
                                       NULL,
                                       &Event,
                                       &IoStatus);
    if (Irp == NULL)
        return STATUS_INSUFFICIENT_RESOURCES;
 
    Stack = IoGetNextIrpStackLocation(Irp);
 
    Stack->MajorFunction = IRP_MJ_PNP;
    Stack->MinorFunction = IRP_MN_QUERY_INTERFACE;
    Stack->Parameters.QueryInterface.InterfaceType = Guid;
    Stack->Parameters.QueryInterface.Size = Size;
    Stack->Parameters.QueryInterface.Version = Version;
    Stack->Parameters.QueryInterface.Interface = (PINTERFACE)Interface;
    Stack->Parameters.QueryInterface.InterfaceSpecificData = InterfaceSpecificData;
 
    Irp->IoStatus.Status = STATUS_NOT_SUPPORTED;
 
    Status = IoCallDriver(DeviceObject, Irp);
    if (Status == STATUS_PENDING)
    {
        KeWaitForSingleObject(&Event, Executive, KernelMode, FALSE, NULL);
 
        Status=IoStatus.Status;
    }
 
    return Status;
}

Referenced by PortFdoStartDevice().

SimpleTimerCallbackDpcRoutine()

VOID NTAPI SimpleTimerCallbackDpcRoutine	(	PKDPC	Dpc,
		PVOID	DeferredContext,
		PVOID	SystemArgument1,
		PVOID	SystemArgument2
	)

Definition at line 327 of file misc.c.

{
    UNREFERENCED_PARAMETER(Dpc);
    UNREFERENCED_PARAMETER(SystemArgument1);
    UNREFERENCED_PARAMETER(SystemArgument2);
 
    PFDO_DEVICE_EXTENSION FdoExtension = (PFDO_DEVICE_EXTENSION)DeferredContext;
 
    NT_ASSERT(FdoExtension);
    NT_ASSERT(FdoExtension->Miniport.MiniportExtension);
 
    FdoExtension->TimerCallback(&FdoExtension->Miniport.MiniportExtension->HwDeviceExtension);
}

Referenced by PortAddDevice().

TimerCallbackDpcRoutine()

VOID NTAPI TimerCallbackDpcRoutine	(	PKDPC	Dpc,
		PVOID	DeferredContext,
		PVOID	SystemArgument1,
		PVOID	SystemArgument2
	)

Definition at line 348 of file misc.c.

{
    UNREFERENCED_PARAMETER(Dpc);
    UNREFERENCED_PARAMETER(SystemArgument1);
    UNREFERENCED_PARAMETER(SystemArgument2);
 
    PTIMER_ENTRY TimerEntry = (PTIMER_ENTRY)DeferredContext;
 
    /*
     * Miniport can schedule a new timer event inside of callback, we should clear timer activated
     * status here to ensure timer can be correctly scheduled
     */
    TimerEntry->TimerAlreadySet = 0;
 
    TimerEntry->TimerCallback(TimerEntry->HwDeviceExtension,
                              TimerEntry->Context);
}

Referenced by StorPortExtendedFunction().

TranslateResourceListAddress()

BOOLEAN TranslateResourceListAddress	(	PFDO_DEVICE_EXTENSION	DeviceExtension,
		INTERFACE_TYPE	BusType,
		ULONG	SystemIoBusNumber,
		STOR_PHYSICAL_ADDRESS	IoAddress,
		ULONG	NumberOfBytes,
		BOOLEAN	InIoSpace,
		PPHYSICAL_ADDRESS	TranslatedAddress
	)

Definition at line 173 of file misc.c.

{
    PCM_FULL_RESOURCE_DESCRIPTOR FullDescriptorA, FullDescriptorT;
    PCM_PARTIAL_RESOURCE_DESCRIPTOR PartialDescriptorA, PartialDescriptorT;
    INT i, j;
 
    DPRINT1("TranslateResourceListAddress(%p)\n", DeviceExtension);
 
    FullDescriptorA = DeviceExtension->AllocatedResources->List;
    FullDescriptorT = DeviceExtension->TranslatedResources->List;
    for (i = 0; i < DeviceExtension->AllocatedResources->Count; i++)
    {
        for (j = 0; j < FullDescriptorA->PartialResourceList.Count; j++)
        {
            PartialDescriptorA = FullDescriptorA->PartialResourceList.PartialDescriptors + j;
            PartialDescriptorT = FullDescriptorT->PartialResourceList.PartialDescriptors + j;
 
            switch (PartialDescriptorA->Type)
            {
                case CmResourceTypePort:
                    DPRINT1("Port: 0x%I64x (0x%lx)\n",
                            PartialDescriptorA->u.Port.Start.QuadPart,
                            PartialDescriptorA->u.Port.Length);
                    if (InIoSpace &&
                        IoAddress.QuadPart >= PartialDescriptorA->u.Port.Start.QuadPart &&
                        IoAddress.QuadPart + NumberOfBytes <= PartialDescriptorA->u.Port.Start.QuadPart + PartialDescriptorA->u.Port.Length)
                    {
                        TranslatedAddress->QuadPart = PartialDescriptorT->u.Port.Start.QuadPart +
                                                      (IoAddress.QuadPart - PartialDescriptorA->u.Port.Start.QuadPart);
                        return TRUE;
                    }
                    break;
 
                case CmResourceTypeMemory:
                    DPRINT1("Memory: 0x%I64x (0x%lx)\n",
                            PartialDescriptorA->u.Memory.Start.QuadPart,
                            PartialDescriptorA->u.Memory.Length);
                    if (!InIoSpace &&
                        IoAddress.QuadPart >= PartialDescriptorA->u.Memory.Start.QuadPart &&
                        IoAddress.QuadPart + NumberOfBytes <= PartialDescriptorA->u.Memory.Start.QuadPart + PartialDescriptorA->u.Memory.Length)
                    {
                        TranslatedAddress->QuadPart = PartialDescriptorT->u.Memory.Start.QuadPart +
                                                      (IoAddress.QuadPart - PartialDescriptorA->u.Memory.Start.QuadPart);
                        return TRUE;
                    }
                    break;
            }
        }
 
        /* Advance to next CM_FULL_RESOURCE_DESCRIPTOR block in memory. */
        FullDescriptorA = (PCM_FULL_RESOURCE_DESCRIPTOR)(FullDescriptorA->PartialResourceList.PartialDescriptors +
                                                         FullDescriptorA->PartialResourceList.Count);
 
        FullDescriptorT = (PCM_FULL_RESOURCE_DESCRIPTOR)(FullDescriptorT->PartialResourceList.PartialDescriptors +
                                                         FullDescriptorT->PartialResourceList.Count);
    }
 
    return FALSE;
}

Referenced by StorPortGetDeviceBase().