isapnp.h File Reference

#include <wdm.h>
#include <ntstrsafe.h>
#include <isapnphw.h>

Include dependency graph for isapnp.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_ISAPNP_IO
struct	_ISAPNP_IRQ
struct	_ISAPNP_DMA
struct	_ISAPNP_LOGICAL_DEVICE
struct	_ISAPNP_COMMON_EXTENSION
struct	_ISAPNP_FDO_EXTENSION
struct	_ISAPNP_PDO_EXTENSION

Macros
#define	TAG_ISAPNP   'PNPI'
#define	RTL_DUPLICATE_UNICODE_STRING_NULL_TERMINATE   1
#define	RTL_DUPLICATE_UNICODE_STRING_ALLOCATE_NULL_STRING   2

Typedefs
typedef struct _ISAPNP_IO	ISAPNP_IO
typedef struct _ISAPNP_IO	PISAPNP_IO
typedef struct _ISAPNP_IRQ	ISAPNP_IRQ
typedef struct _ISAPNP_IRQ *	PISAPNP_IRQ
typedef struct _ISAPNP_DMA	ISAPNP_DMA
typedef struct _ISAPNP_DMA *	PISAPNP_DMA
typedef struct _ISAPNP_LOGICAL_DEVICE	ISAPNP_LOGICAL_DEVICE
typedef struct _ISAPNP_LOGICAL_DEVICE *	PISAPNP_LOGICAL_DEVICE
typedef struct _ISAPNP_COMMON_EXTENSION	ISAPNP_COMMON_EXTENSION
typedef struct _ISAPNP_COMMON_EXTENSION *	PISAPNP_COMMON_EXTENSION
typedef struct _ISAPNP_FDO_EXTENSION	ISAPNP_FDO_EXTENSION
typedef struct _ISAPNP_FDO_EXTENSION *	PISAPNP_FDO_EXTENSION
typedef struct _ISAPNP_PDO_EXTENSION	ISAPNP_PDO_EXTENSION
typedef struct _ISAPNP_PDO_EXTENSION *	PISAPNP_PDO_EXTENSION

Enumerations
enum	ISAPNP_DEVICE_STATE { dsStopped, dsStarted }

Functions
NTSTATUS NTAPI	IsaPnpDuplicateUnicodeString (IN ULONG Flags, IN PCUNICODE_STRING SourceString, OUT PUNICODE_STRING DestinationString)
NTSTATUS NTAPI	IsaPnpFillDeviceRelations (IN PISAPNP_FDO_EXTENSION FdoExt, IN PIRP Irp, IN BOOLEAN IncludeDataPort)
NTSTATUS NTAPI	DriverEntry (IN PDRIVER_OBJECT DriverObject, IN PUNICODE_STRING RegistryPath)
NTSTATUS NTAPI	IsaForwardIrpSynchronous (IN PISAPNP_FDO_EXTENSION FdoExt, IN PIRP Irp)
NTSTATUS NTAPI	IsaFdoPnp (IN PISAPNP_FDO_EXTENSION FdoExt, IN PIRP Irp, IN PIO_STACK_LOCATION IrpSp)
NTSTATUS NTAPI	IsaPdoPnp (IN PISAPNP_PDO_EXTENSION PdoDeviceExtension, IN PIRP Irp, IN PIO_STACK_LOCATION IrpSp)
NTSTATUS NTAPI	IsaHwTryReadDataPort (IN PUCHAR ReadDataPort)
NTSTATUS NTAPI	IsaHwFillDeviceList (IN PISAPNP_FDO_EXTENSION FdoExt)
NTSTATUS NTAPI	IsaHwDeactivateDevice (IN PISAPNP_LOGICAL_DEVICE LogicalDevice)
NTSTATUS NTAPI	IsaHwActivateDevice (IN PISAPNP_LOGICAL_DEVICE LogicalDevice)

Variables
DRIVER_INITIALIZE	DriverEntry

Macro Definition Documentation

RTL_DUPLICATE_UNICODE_STRING_ALLOCATE_NULL_STRING

#define RTL_DUPLICATE_UNICODE_STRING_ALLOCATE_NULL_STRING   2

Definition at line 83 of file isapnp.h.

RTL_DUPLICATE_UNICODE_STRING_NULL_TERMINATE

#define RTL_DUPLICATE_UNICODE_STRING_NULL_TERMINATE   1

Definition at line 82 of file isapnp.h.

TAG_ISAPNP

#define TAG_ISAPNP   'PNPI'

Definition at line 12 of file isapnp.h.

Typedef Documentation

ISAPNP_COMMON_EXTENSION

typedef struct _ISAPNP_COMMON_EXTENSION ISAPNP_COMMON_EXTENSION

ISAPNP_DMA

typedef struct _ISAPNP_DMA ISAPNP_DMA

ISAPNP_FDO_EXTENSION

typedef struct _ISAPNP_FDO_EXTENSION ISAPNP_FDO_EXTENSION

ISAPNP_IO

typedef struct _ISAPNP_IO ISAPNP_IO

ISAPNP_IRQ

typedef struct _ISAPNP_IRQ ISAPNP_IRQ

ISAPNP_LOGICAL_DEVICE

typedef struct _ISAPNP_LOGICAL_DEVICE ISAPNP_LOGICAL_DEVICE

ISAPNP_PDO_EXTENSION

typedef struct _ISAPNP_PDO_EXTENSION ISAPNP_PDO_EXTENSION

PISAPNP_COMMON_EXTENSION

typedef struct _ISAPNP_COMMON_EXTENSION * PISAPNP_COMMON_EXTENSION

PISAPNP_DMA

typedef struct _ISAPNP_DMA * PISAPNP_DMA

PISAPNP_FDO_EXTENSION

typedef struct _ISAPNP_FDO_EXTENSION * PISAPNP_FDO_EXTENSION

PISAPNP_IO

typedef struct _ISAPNP_IO PISAPNP_IO

PISAPNP_IRQ

typedef struct _ISAPNP_IRQ * PISAPNP_IRQ

PISAPNP_LOGICAL_DEVICE

typedef struct _ISAPNP_LOGICAL_DEVICE * PISAPNP_LOGICAL_DEVICE

PISAPNP_PDO_EXTENSION

typedef struct _ISAPNP_PDO_EXTENSION * PISAPNP_PDO_EXTENSION

Enumeration Type Documentation

ISAPNP_DEVICE_STATE

enum ISAPNP_DEVICE_STATE

Enumerator
dsStopped
dsStarted

Definition at line 14 of file isapnp.h.

             {
    dsStopped,
    dsStarted
} ISAPNP_DEVICE_STATE;

Function Documentation

DriverEntry()

NTSTATUS NTAPI DriverEntry	(	IN PDRIVER_OBJECT	DriverObject,
		IN PUNICODE_STRING	RegistryPath
	)

Definition at line 367 of file beep.c.

{
    PDEVICE_EXTENSION DeviceExtension;
    PDEVICE_OBJECT DeviceObject;
    UNICODE_STRING DeviceName = RTL_CONSTANT_STRING(L"\\Device\\Beep");
    NTSTATUS Status;

    UNREFERENCED_PARAMETER(RegistryPath);

    /* Create the device */
    Status = IoCreateDevice(DriverObject,
                            sizeof(DEVICE_EXTENSION),
                            &DeviceName,
                            FILE_DEVICE_BEEP,
                            0,
                            FALSE,
                            &DeviceObject);
    if (!NT_SUCCESS(Status)) return Status;

    /* Make it use buffered I/O */
    DeviceObject->Flags |= DO_BUFFERED_IO;

    /* Setup the Driver Object */
    DriverObject->MajorFunction[IRP_MJ_CREATE] = BeepCreate;
    DriverObject->MajorFunction[IRP_MJ_CLOSE] = BeepClose;
    DriverObject->MajorFunction[IRP_MJ_CLEANUP] = BeepCleanup;
    DriverObject->MajorFunction[IRP_MJ_DEVICE_CONTROL] = BeepDeviceControl;
    DriverObject->DriverUnload = BeepUnload;
    DriverObject->DriverStartIo = BeepStartIo;

    /* Set up device extension */
    DeviceExtension = DeviceObject->DeviceExtension;
    DeviceExtension->ReferenceCount = 0;
    DeviceExtension->TimerActive = FALSE;
    IoInitializeDpcRequest(DeviceObject, (PIO_DPC_ROUTINE)BeepDPC);
    KeInitializeTimer(&DeviceExtension->Timer);
    ExInitializeFastMutex(&DeviceExtension->Mutex);

    /* Page the entire driver */
    MmPageEntireDriver(DriverEntry);
    return STATUS_SUCCESS;
}

IsaFdoPnp()

NTSTATUS NTAPI IsaFdoPnp	(	IN PISAPNP_FDO_EXTENSION	FdoExt,
		IN PIRP	Irp,
		IN PIO_STACK_LOCATION	IrpSp
	)

Definition at line 44 of file fdo.c.

{
    NTSTATUS Status = Irp->IoStatus.Status;

    switch (IrpSp->MinorFunction)
    {
        case IRP_MN_START_DEVICE:
            Status = IsaForwardIrpSynchronous(FdoExt, Irp);

            if (NT_SUCCESS(Status))
                Status = IsaFdoStartDevice(FdoExt, Irp, IrpSp);

            Irp->IoStatus.Status = Status;

            IoCompleteRequest(Irp, IO_NO_INCREMENT);
            return Status;

        case IRP_MN_STOP_DEVICE:
            FdoExt->Common.State = dsStopped;

            Status = STATUS_SUCCESS;
            break;

        case IRP_MN_QUERY_DEVICE_RELATIONS:
            Status = IsaFdoQueryDeviceRelations(FdoExt, Irp, IrpSp);

            Irp->IoStatus.Status = Status;

            IoCompleteRequest(Irp, IO_NO_INCREMENT);
            return Status;

        case IRP_MN_FILTER_RESOURCE_REQUIREMENTS:
            DPRINT("IRP_MN_FILTER_RESOURCE_REQUIREMENTS\n");
            break;

        default:
            DPRINT1("Unknown PnP code: %x\n", IrpSp->MinorFunction);
            break;
    }

    IoSkipCurrentIrpStackLocation(Irp);

    return IoCallDriver(FdoExt->Ldo, Irp);
}

Referenced by IsaPnp().

IsaForwardIrpSynchronous()

NTSTATUS NTAPI IsaForwardIrpSynchronous	(	IN PISAPNP_FDO_EXTENSION	FdoExt,
		IN PIRP	Irp
	)

Definition at line 519 of file isapnp.c.

{
    KEVENT Event;
    NTSTATUS Status;

    KeInitializeEvent(&Event, NotificationEvent, FALSE);
    IoCopyCurrentIrpStackLocationToNext(Irp);

    IoSetCompletionRoutine(Irp, ForwardIrpCompletion, &Event, TRUE, TRUE, TRUE);

    Status = IoCallDriver(FdoExt->Ldo, Irp);
    if (Status == STATUS_PENDING)
    {
        Status = KeWaitForSingleObject(&Event, Suspended, KernelMode, FALSE, NULL);
        if (NT_SUCCESS(Status))
            Status = Irp->IoStatus.Status;
    }

    return Status;
}

Referenced by IsaFdoPnp().

IsaHwActivateDevice()

NTSTATUS NTAPI IsaHwActivateDevice

(

IN PISAPNP_LOGICAL_DEVICE

LogicalDevice

)

Definition at line 599 of file hardware.c.

{
    DeviceActivation(LogicalDevice,
                     TRUE);

    return STATUS_SUCCESS;
}

Referenced by IsaPdoPnp().

IsaHwDeactivateDevice()

NTSTATUS NTAPI IsaHwDeactivateDevice

(

IN PISAPNP_LOGICAL_DEVICE

LogicalDevice

)

Definition at line 610 of file hardware.c.

{
    DeviceActivation(LogicalDevice,
                     FALSE);

    return STATUS_SUCCESS;
}

Referenced by IsaPdoPnp().

IsaHwFillDeviceList()

NTSTATUS NTAPI IsaHwFillDeviceList

(

IN PISAPNP_FDO_EXTENSION

FdoExt

)

Definition at line 621 of file hardware.c.

{
    return ProbeIsaPnpBus(FdoExt);
}

Referenced by IsaPdoStartReadPort().

IsaHwTryReadDataPort()

NTSTATUS NTAPI IsaHwTryReadDataPort

(

IN PUCHAR

ReadDataPort

)

Definition at line 591 of file hardware.c.

{
    return TryIsolate(ReadDataPort) > 0 ? STATUS_SUCCESS : STATUS_INSUFFICIENT_RESOURCES;
}

Referenced by IsaPdoStartReadPort().

IsaPdoPnp()

NTSTATUS NTAPI IsaPdoPnp	(	IN PISAPNP_PDO_EXTENSION	PdoDeviceExtension,
		IN PIRP	Irp,
		IN PIO_STACK_LOCATION	IrpSp
	)

Definition at line 298 of file pdo.c.

{
    NTSTATUS Status = Irp->IoStatus.Status;

    switch (IrpSp->MinorFunction)
    {
        case IRP_MN_START_DEVICE:
            if (PdoExt->IsaPnpDevice)
                Status = IsaHwActivateDevice(PdoExt->IsaPnpDevice);
            else
                Status = IsaPdoStartReadPort(PdoExt->FdoExt, IrpSp);

            if (NT_SUCCESS(Status))
                PdoExt->Common.State = dsStarted;
            break;

        case IRP_MN_STOP_DEVICE:
            if (PdoExt->IsaPnpDevice)
                Status = IsaHwDeactivateDevice(PdoExt->IsaPnpDevice);
            else
                Status = STATUS_SUCCESS;

            if (NT_SUCCESS(Status))
                PdoExt->Common.State = dsStopped;
            break;

        case IRP_MN_QUERY_DEVICE_RELATIONS:
            Status = IsaPdoQueryDeviceRelations(PdoExt, Irp, IrpSp);
            break;

        case IRP_MN_QUERY_CAPABILITIES:
            Status = IsaPdoQueryCapabilities(PdoExt, Irp, IrpSp);
            break;

        case IRP_MN_QUERY_PNP_DEVICE_STATE:
            if (PdoExt->Common.Self == PdoExt->FdoExt->DataPortPdo)
                Status = IsaPdoQueryPnpDeviceState(PdoExt, Irp, IrpSp);
            break;

        case IRP_MN_QUERY_RESOURCES:
            Status = IsaPdoQueryResources(PdoExt, Irp, IrpSp);
            break;

        case IRP_MN_QUERY_RESOURCE_REQUIREMENTS:
            Status = IsaPdoQueryResourceRequirements(PdoExt, Irp, IrpSp);
            break;

        case IRP_MN_QUERY_ID:
            Status = IsaPdoQueryId(PdoExt, Irp, IrpSp);
            break;

        case IRP_MN_QUERY_REMOVE_DEVICE:
        case IRP_MN_REMOVE_DEVICE:
        case IRP_MN_CANCEL_REMOVE_DEVICE:
        case IRP_MN_QUERY_STOP_DEVICE:
        case IRP_MN_CANCEL_STOP_DEVICE:
        case IRP_MN_QUERY_DEVICE_TEXT:
        case IRP_MN_FILTER_RESOURCE_REQUIREMENTS:
        case IRP_MN_SURPRISE_REMOVAL:
            Status = STATUS_SUCCESS;
            break;

        case IRP_MN_READ_CONFIG:
        case IRP_MN_WRITE_CONFIG:
        case IRP_MN_EJECT:
        case IRP_MN_SET_LOCK:
        case IRP_MN_QUERY_BUS_INFORMATION:
        case IRP_MN_DEVICE_USAGE_NOTIFICATION:
            return IsaPdoRepeatRequest(PdoExt, Irp, TRUE);

        default:
            DPRINT1("Unknown PnP code: %x\n", IrpSp->MinorFunction);
            break;
    }

    Irp->IoStatus.Status = Status;
    IoCompleteRequest(Irp, IO_NO_INCREMENT);

    return Status;
}

Referenced by IsaPnp().

IsaPnpDuplicateUnicodeString()

NTSTATUS NTAPI IsaPnpDuplicateUnicodeString	(	IN ULONG	Flags,
		IN PCUNICODE_STRING	SourceString,
		OUT PUNICODE_STRING	DestinationString
	)

Definition at line 16 of file isapnp.c.

{
    if (SourceString == NULL ||
        DestinationString == NULL ||
        SourceString->Length > SourceString->MaximumLength ||
        (SourceString->Length == 0 && SourceString->MaximumLength > 0 && SourceString->Buffer == NULL) ||
        Flags == RTL_DUPLICATE_UNICODE_STRING_ALLOCATE_NULL_STRING ||
        Flags >= 4)
    {
        return STATUS_INVALID_PARAMETER;
    }

    if ((SourceString->Length == 0) &&
        (Flags != (RTL_DUPLICATE_UNICODE_STRING_NULL_TERMINATE |
                   RTL_DUPLICATE_UNICODE_STRING_ALLOCATE_NULL_STRING)))
    {
        DestinationString->Length = 0;
        DestinationString->MaximumLength = 0;
        DestinationString->Buffer = NULL;
    }
    else
    {
        USHORT DestMaxLength = SourceString->Length;

        if (Flags & RTL_DUPLICATE_UNICODE_STRING_NULL_TERMINATE)
            DestMaxLength += sizeof(UNICODE_NULL);

        DestinationString->Buffer = ExAllocatePool(PagedPool, DestMaxLength);
        if (DestinationString->Buffer == NULL)
            return STATUS_NO_MEMORY;

        RtlCopyMemory(DestinationString->Buffer, SourceString->Buffer, SourceString->Length);
        DestinationString->Length = SourceString->Length;
        DestinationString->MaximumLength = DestMaxLength;

        if (Flags & RTL_DUPLICATE_UNICODE_STRING_NULL_TERMINATE)
            DestinationString->Buffer[DestinationString->Length / sizeof(WCHAR)] = 0;
    }

    return STATUS_SUCCESS;
}

Referenced by IsaFdoCreateDeviceIDs(), and IsaPnpCreateReadPortDO().

IsaPnpFillDeviceRelations()

NTSTATUS NTAPI IsaPnpFillDeviceRelations	(	IN PISAPNP_FDO_EXTENSION	FdoExt,
		IN PIRP	Irp,
		IN BOOLEAN	IncludeDataPort
	)

Definition at line 411 of file isapnp.c.

{
    PISAPNP_PDO_EXTENSION PdoExt;
    NTSTATUS Status = STATUS_SUCCESS;
    PLIST_ENTRY CurrentEntry;
    PISAPNP_LOGICAL_DEVICE IsaDevice;
    PDEVICE_RELATIONS DeviceRelations;
    ULONG i = 0;

    DeviceRelations = ExAllocatePool(NonPagedPool,
                                     sizeof(DEVICE_RELATIONS) + sizeof(DEVICE_OBJECT) * FdoExt->DeviceCount);
    if (!DeviceRelations)
    {
        return STATUS_NO_MEMORY;
    }

    if (IncludeDataPort)
    {
        DeviceRelations->Objects[i++] = FdoExt->DataPortPdo;
        ObReferenceObject(FdoExt->DataPortPdo);
    }

    CurrentEntry = FdoExt->DeviceListHead.Flink;
    while (CurrentEntry != &FdoExt->DeviceListHead)
    {
       IsaDevice = CONTAINING_RECORD(CurrentEntry, ISAPNP_LOGICAL_DEVICE, ListEntry);

       if (!IsaDevice->Pdo)
       {
           Status = IoCreateDevice(FdoExt->DriverObject,
                                   sizeof(ISAPNP_PDO_EXTENSION),
                                   NULL,
                                   FILE_DEVICE_CONTROLLER,
                                   FILE_DEVICE_SECURE_OPEN | FILE_AUTOGENERATED_DEVICE_NAME,
                                   FALSE,
                                   &IsaDevice->Pdo);
           if (!NT_SUCCESS(Status))
           {
              break;
           }

           IsaDevice->Pdo->Flags &= ~DO_DEVICE_INITIALIZING;

           //Device->Pdo->Flags |= DO_POWER_PAGABLE;

           PdoExt = (PISAPNP_PDO_EXTENSION)IsaDevice->Pdo->DeviceExtension;

           RtlZeroMemory(PdoExt, sizeof(ISAPNP_PDO_EXTENSION));

           PdoExt->Common.IsFdo = FALSE;
           PdoExt->Common.Self = IsaDevice->Pdo;
           PdoExt->Common.State = dsStopped;
           PdoExt->IsaPnpDevice = IsaDevice;
           PdoExt->FdoExt = FdoExt;

           Status = IsaFdoCreateDeviceIDs(PdoExt);

           if (NT_SUCCESS(Status))
              Status = IsaFdoCreateRequirements(PdoExt);

           if (NT_SUCCESS(Status))
              Status = IsaFdoCreateResources(PdoExt);

           if (!NT_SUCCESS(Status))
           {
               IoDeleteDevice(IsaDevice->Pdo);
               IsaDevice->Pdo = NULL;
               break;
           }
       }
       DeviceRelations->Objects[i++] = IsaDevice->Pdo;

       ObReferenceObject(IsaDevice->Pdo);

       CurrentEntry = CurrentEntry->Flink;
    }

    DeviceRelations->Count = i;

    Irp->IoStatus.Information = (ULONG_PTR)DeviceRelations;

    return Status;
}

Referenced by IsaFdoQueryDeviceRelations(), and IsaPdoQueryDeviceRelations().

Variable Documentation

DriverEntry

DRIVER_INITIALIZE DriverEntry

Definition at line 99 of file isapnp.h.