mirror of
https://github.com/reactos/reactos.git
synced 2024-08-20 18:35:32 +00:00
410 lines
9.3 KiB
C
410 lines
9.3 KiB
C
/*
|
|
* PROJECT: ReactOS ISA PnP Bus driver
|
|
* LICENSE: GPL-2.0-or-later (https://spdx.org/licenses/GPL-2.0-or-later)
|
|
* PURPOSE: Common header file
|
|
* COPYRIGHT: Copyright 2010 Cameron Gutman <cameron.gutman@reactos.org>
|
|
* Copyright 2020 Hervé Poussineau <hpoussin@reactos.org>
|
|
*/
|
|
|
|
#ifndef _ISAPNP_PCH_
|
|
#define _ISAPNP_PCH_
|
|
|
|
#include <ntddk.h>
|
|
#include <ntstrsafe.h>
|
|
#include <section_attribs.h>
|
|
#include "isapnphw.h"
|
|
|
|
#include <initguid.h>
|
|
#include <wdmguid.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#define TAG_ISAPNP 'pasI'
|
|
|
|
/** @brief Maximum size of resource data structure supported by the driver. */
|
|
#define ISAPNP_MAX_RESOURCEDATA 0x1000
|
|
|
|
/** @brief Maximum number of Start DF tags supported by the driver. */
|
|
#define ISAPNP_MAX_ALTERNATIVES 8
|
|
|
|
typedef enum
|
|
{
|
|
dsStopped,
|
|
dsStarted
|
|
} ISAPNP_DEVICE_STATE;
|
|
|
|
typedef struct _ISAPNP_IO
|
|
{
|
|
USHORT CurrentBase;
|
|
ISAPNP_IO_DESCRIPTION Description;
|
|
UCHAR Index;
|
|
} ISAPNP_IO, *PISAPNP_IO;
|
|
|
|
typedef struct _ISAPNP_IRQ
|
|
{
|
|
UCHAR CurrentNo;
|
|
UCHAR CurrentType;
|
|
ISAPNP_IRQ_DESCRIPTION Description;
|
|
UCHAR Index;
|
|
} ISAPNP_IRQ, *PISAPNP_IRQ;
|
|
|
|
typedef struct _ISAPNP_DMA
|
|
{
|
|
UCHAR CurrentChannel;
|
|
ISAPNP_DMA_DESCRIPTION Description;
|
|
UCHAR Index;
|
|
} ISAPNP_DMA, *PISAPNP_DMA;
|
|
|
|
typedef struct _ISAPNP_MEMRANGE
|
|
{
|
|
ULONG CurrentBase;
|
|
ULONG CurrentLength;
|
|
ISAPNP_MEMRANGE_DESCRIPTION Description;
|
|
UCHAR Index;
|
|
} ISAPNP_MEMRANGE, *PISAPNP_MEMRANGE;
|
|
|
|
typedef struct _ISAPNP_MEMRANGE32
|
|
{
|
|
ULONG CurrentBase;
|
|
ULONG CurrentLength;
|
|
ISAPNP_MEMRANGE32_DESCRIPTION Description;
|
|
UCHAR Index;
|
|
} ISAPNP_MEMRANGE32, *PISAPNP_MEMRANGE32;
|
|
|
|
typedef struct _ISAPNP_COMPATIBLE_ID_ENTRY
|
|
{
|
|
UCHAR VendorId[3];
|
|
USHORT ProdId;
|
|
LIST_ENTRY IdLink;
|
|
} ISAPNP_COMPATIBLE_ID_ENTRY, *PISAPNP_COMPATIBLE_ID_ENTRY;
|
|
|
|
typedef struct _ISAPNP_ALTERNATIVES
|
|
{
|
|
ISAPNP_IO_DESCRIPTION Io[ISAPNP_MAX_ALTERNATIVES];
|
|
ISAPNP_IRQ_DESCRIPTION Irq[ISAPNP_MAX_ALTERNATIVES];
|
|
ISAPNP_DMA_DESCRIPTION Dma[ISAPNP_MAX_ALTERNATIVES];
|
|
ISAPNP_MEMRANGE_DESCRIPTION MemRange[ISAPNP_MAX_ALTERNATIVES];
|
|
ISAPNP_MEMRANGE32_DESCRIPTION MemRange32[ISAPNP_MAX_ALTERNATIVES];
|
|
UCHAR Priority[ISAPNP_MAX_ALTERNATIVES];
|
|
UCHAR IoIndex;
|
|
UCHAR IrqIndex;
|
|
UCHAR DmaIndex;
|
|
UCHAR MemRangeIndex;
|
|
UCHAR MemRange32Index;
|
|
|
|
_Field_range_(0, ISAPNP_MAX_ALTERNATIVES)
|
|
UCHAR Count;
|
|
} ISAPNP_ALTERNATIVES, *PISAPNP_ALTERNATIVES;
|
|
|
|
typedef struct _ISAPNP_LOGICAL_DEVICE
|
|
{
|
|
PDEVICE_OBJECT Pdo;
|
|
|
|
/**
|
|
* @name The card data.
|
|
* @{
|
|
*/
|
|
UCHAR CSN;
|
|
UCHAR VendorId[3];
|
|
USHORT ProdId;
|
|
ULONG SerialNumber;
|
|
/**@}*/
|
|
|
|
/**
|
|
* @name The logical device data.
|
|
* @{
|
|
*/
|
|
UCHAR LDN;
|
|
UCHAR LogVendorId[3];
|
|
USHORT LogProdId;
|
|
LIST_ENTRY CompatibleIdList;
|
|
PSTR FriendlyName;
|
|
PISAPNP_ALTERNATIVES Alternatives;
|
|
|
|
ISAPNP_IO Io[8];
|
|
ISAPNP_IRQ Irq[2];
|
|
ISAPNP_DMA Dma[2];
|
|
ISAPNP_MEMRANGE MemRange[4];
|
|
ISAPNP_MEMRANGE32 MemRange32[4];
|
|
/**@}*/
|
|
|
|
ULONG Flags;
|
|
#define ISAPNP_PRESENT 0x00000001 /**< @brief Cleared when the device is physically removed. */
|
|
#define ISAPNP_HAS_MULTIPLE_LOGDEVS 0x00000002 /**< @brief Indicates if the parent card has multiple logical devices. */
|
|
#define ISAPNP_HAS_RESOURCES 0x00000004 /**< @brief Cleared when the device has no boot resources. */
|
|
|
|
LIST_ENTRY DeviceLink;
|
|
} ISAPNP_LOGICAL_DEVICE, *PISAPNP_LOGICAL_DEVICE;
|
|
|
|
typedef enum _ISAPNP_SIGNATURE
|
|
{
|
|
IsaPnpBus = 'odFI',
|
|
IsaPnpLogicalDevice = 'veDI',
|
|
IsaPnpReadDataPort = 'pdRI'
|
|
} ISAPNP_SIGNATURE;
|
|
|
|
typedef struct _ISAPNP_COMMON_EXTENSION
|
|
{
|
|
ISAPNP_SIGNATURE Signature;
|
|
PDEVICE_OBJECT Self;
|
|
ISAPNP_DEVICE_STATE State;
|
|
} ISAPNP_COMMON_EXTENSION, *PISAPNP_COMMON_EXTENSION;
|
|
|
|
typedef struct _ISAPNP_FDO_EXTENSION
|
|
{
|
|
ISAPNP_COMMON_EXTENSION Common;
|
|
PDEVICE_OBJECT Ldo;
|
|
PDEVICE_OBJECT Pdo;
|
|
PDEVICE_OBJECT ReadPortPdo; /**< @remarks The pointer is NULL for all inactive FDOs. */
|
|
ULONG BusNumber;
|
|
KEVENT DeviceSyncEvent;
|
|
|
|
_Guarded_by_(DeviceSyncEvent)
|
|
LIST_ENTRY DeviceListHead;
|
|
|
|
_Guarded_by_(DeviceSyncEvent)
|
|
ULONG DeviceCount;
|
|
|
|
PDRIVER_OBJECT DriverObject;
|
|
PUCHAR ReadDataPort;
|
|
ULONG Cards;
|
|
LIST_ENTRY BusLink;
|
|
} ISAPNP_FDO_EXTENSION, *PISAPNP_FDO_EXTENSION;
|
|
|
|
typedef struct _ISAPNP_PDO_EXTENSION
|
|
{
|
|
ISAPNP_COMMON_EXTENSION Common;
|
|
PISAPNP_LOGICAL_DEVICE IsaPnpDevice;
|
|
PISAPNP_FDO_EXTENSION FdoExt;
|
|
PIO_RESOURCE_REQUIREMENTS_LIST RequirementsList;
|
|
|
|
PCM_RESOURCE_LIST ResourceList;
|
|
ULONG ResourceListSize;
|
|
|
|
ULONG Flags;
|
|
#define ISAPNP_ENUMERATED 0x00000001 /**< @brief Whether the device has been reported to the PnP manager. */
|
|
#define ISAPNP_SCANNED_BY_READ_PORT 0x00000002 /**< @brief The bus has been scanned by Read Port PDO. */
|
|
#define ISAPNP_READ_PORT_ALLOW_FDO_SCAN 0x00000004 /**< @brief Allows the active FDO to scan the bus. */
|
|
#define ISAPNP_READ_PORT_NEED_REBALANCE 0x00000008 /**< @brief The I/O resource requirements have changed. */
|
|
|
|
_Write_guarded_by_(_Global_interlock_)
|
|
volatile LONG SpecialFiles;
|
|
} ISAPNP_PDO_EXTENSION, *PISAPNP_PDO_EXTENSION;
|
|
|
|
extern KEVENT BusSyncEvent;
|
|
|
|
_Guarded_by_(BusSyncEvent)
|
|
extern BOOLEAN ReadPortCreated;
|
|
|
|
_Guarded_by_(BusSyncEvent)
|
|
extern LIST_ENTRY BusListHead;
|
|
|
|
_Requires_lock_not_held_(BusSyncEvent)
|
|
_Acquires_lock_(BusSyncEvent)
|
|
FORCEINLINE
|
|
VOID
|
|
IsaPnpAcquireBusDataLock(VOID)
|
|
{
|
|
KeWaitForSingleObject(&BusSyncEvent, Executive, KernelMode, FALSE, NULL);
|
|
}
|
|
|
|
_Releases_lock_(BusSyncEvent)
|
|
FORCEINLINE
|
|
VOID
|
|
IsaPnpReleaseBusDataLock(VOID)
|
|
{
|
|
KeSetEvent(&BusSyncEvent, IO_NO_INCREMENT, FALSE);
|
|
}
|
|
|
|
_Requires_lock_not_held_(FdoExt->DeviceSyncEvent)
|
|
_Acquires_lock_(FdoExt->DeviceSyncEvent)
|
|
FORCEINLINE
|
|
VOID
|
|
IsaPnpAcquireDeviceDataLock(
|
|
_In_ PISAPNP_FDO_EXTENSION FdoExt)
|
|
{
|
|
KeWaitForSingleObject(&FdoExt->DeviceSyncEvent, Executive, KernelMode, FALSE, NULL);
|
|
}
|
|
|
|
_Releases_lock_(FdoExt->DeviceSyncEvent)
|
|
FORCEINLINE
|
|
VOID
|
|
IsaPnpReleaseDeviceDataLock(
|
|
_In_ PISAPNP_FDO_EXTENSION FdoExt)
|
|
{
|
|
KeSetEvent(&FdoExt->DeviceSyncEvent, IO_NO_INCREMENT, FALSE);
|
|
}
|
|
|
|
FORCEINLINE
|
|
BOOLEAN
|
|
HasIoAlternatives(
|
|
_In_ PISAPNP_ALTERNATIVES Alternatives)
|
|
{
|
|
return (Alternatives->Io[0].Length != 0);
|
|
}
|
|
|
|
FORCEINLINE
|
|
BOOLEAN
|
|
HasIrqAlternatives(
|
|
_In_ PISAPNP_ALTERNATIVES Alternatives)
|
|
{
|
|
return (Alternatives->Irq[0].Mask != 0);
|
|
}
|
|
|
|
FORCEINLINE
|
|
BOOLEAN
|
|
HasDmaAlternatives(
|
|
_In_ PISAPNP_ALTERNATIVES Alternatives)
|
|
{
|
|
return (Alternatives->Dma[0].Mask != 0);
|
|
}
|
|
|
|
FORCEINLINE
|
|
BOOLEAN
|
|
HasMemoryAlternatives(
|
|
_In_ PISAPNP_ALTERNATIVES Alternatives)
|
|
{
|
|
return (Alternatives->MemRange[0].Length != 0);
|
|
}
|
|
|
|
FORCEINLINE
|
|
BOOLEAN
|
|
HasMemory32Alternatives(
|
|
_In_ PISAPNP_ALTERNATIVES Alternatives)
|
|
{
|
|
return (Alternatives->MemRange32[0].Length != 0);
|
|
}
|
|
|
|
/* isapnp.c */
|
|
|
|
CODE_SEG("PAGE")
|
|
BOOLEAN
|
|
FindIoDescriptor(
|
|
_In_ PISAPNP_LOGICAL_DEVICE LogDevice,
|
|
_In_opt_ ULONG Base,
|
|
_In_ ULONG RangeStart,
|
|
_In_ ULONG RangeEnd,
|
|
_Out_opt_ PUCHAR Information,
|
|
_Out_opt_ PULONG Length,
|
|
_Out_opt_ PUCHAR WriteOrder);
|
|
|
|
CODE_SEG("PAGE")
|
|
BOOLEAN
|
|
FindIrqDescriptor(
|
|
_In_ PISAPNP_LOGICAL_DEVICE LogDevice,
|
|
_In_ ULONG Vector,
|
|
_Out_opt_ PUCHAR WriteOrder);
|
|
|
|
CODE_SEG("PAGE")
|
|
BOOLEAN
|
|
FindDmaDescriptor(
|
|
_In_ PISAPNP_LOGICAL_DEVICE LogDevice,
|
|
_In_ ULONG Channel,
|
|
_Out_opt_ PUCHAR WriteOrder);
|
|
|
|
CODE_SEG("PAGE")
|
|
BOOLEAN
|
|
FindMemoryDescriptor(
|
|
_In_ PISAPNP_LOGICAL_DEVICE LogDevice,
|
|
_In_ ULONG RangeStart,
|
|
_In_ ULONG RangeEnd,
|
|
_Out_opt_ PBOOLEAN Memory32,
|
|
_Out_opt_ PUCHAR Information,
|
|
_Out_opt_ PUCHAR WriteOrder);
|
|
|
|
CODE_SEG("PAGE")
|
|
NTSTATUS
|
|
IsaPnpCreateReadPortDORequirements(
|
|
_In_ PISAPNP_PDO_EXTENSION PdoExt,
|
|
_In_opt_ ULONG SelectedReadPort);
|
|
|
|
CODE_SEG("PAGE")
|
|
VOID
|
|
IsaPnpRemoveReadPortDO(
|
|
_In_ PDEVICE_OBJECT Pdo);
|
|
|
|
CODE_SEG("PAGE")
|
|
NTSTATUS
|
|
IsaPnpFillDeviceRelations(
|
|
_In_ PISAPNP_FDO_EXTENSION FdoExt,
|
|
_Inout_ PIRP Irp,
|
|
_In_ BOOLEAN IncludeDataPort);
|
|
|
|
CODE_SEG("INIT")
|
|
DRIVER_INITIALIZE DriverEntry;
|
|
|
|
/* fdo.c */
|
|
CODE_SEG("PAGE")
|
|
NTSTATUS
|
|
IsaFdoPnp(
|
|
_In_ PISAPNP_FDO_EXTENSION FdoExt,
|
|
_Inout_ PIRP Irp,
|
|
_In_ PIO_STACK_LOCATION IrpSp);
|
|
|
|
/* interface.c */
|
|
CODE_SEG("PAGE")
|
|
NTSTATUS
|
|
IsaFdoQueryInterface(
|
|
_In_ PISAPNP_FDO_EXTENSION FdoExt,
|
|
_In_ PIO_STACK_LOCATION IrpSp);
|
|
|
|
/* pdo.c */
|
|
CODE_SEG("PAGE")
|
|
NTSTATUS
|
|
IsaPdoPnp(
|
|
_In_ PISAPNP_PDO_EXTENSION PdoDeviceExtension,
|
|
_Inout_ PIRP Irp,
|
|
_In_ PIO_STACK_LOCATION IrpSp);
|
|
|
|
CODE_SEG("PAGE")
|
|
VOID
|
|
IsaPnpRemoveLogicalDeviceDO(
|
|
_In_ PDEVICE_OBJECT Pdo);
|
|
|
|
/* hardware.c */
|
|
CODE_SEG("PAGE")
|
|
UCHAR
|
|
IsaHwTryReadDataPort(
|
|
_In_ PUCHAR ReadDataPort);
|
|
|
|
_Requires_lock_held_(FdoExt->DeviceSyncEvent)
|
|
CODE_SEG("PAGE")
|
|
NTSTATUS
|
|
IsaHwFillDeviceList(
|
|
_In_ PISAPNP_FDO_EXTENSION FdoExt);
|
|
|
|
CODE_SEG("PAGE")
|
|
NTSTATUS
|
|
IsaHwConfigureDevice(
|
|
_In_ PISAPNP_FDO_EXTENSION FdoExt,
|
|
_In_ PISAPNP_LOGICAL_DEVICE LogicalDevice,
|
|
_In_ PCM_RESOURCE_LIST Resources);
|
|
|
|
_IRQL_requires_max_(DISPATCH_LEVEL)
|
|
VOID
|
|
IsaHwWakeDevice(
|
|
_In_ PISAPNP_LOGICAL_DEVICE LogicalDevice);
|
|
|
|
_IRQL_requires_max_(DISPATCH_LEVEL)
|
|
VOID
|
|
IsaHwDeactivateDevice(
|
|
_In_ PISAPNP_LOGICAL_DEVICE LogicalDevice);
|
|
|
|
_IRQL_requires_max_(DISPATCH_LEVEL)
|
|
VOID
|
|
IsaHwActivateDevice(
|
|
_In_ PISAPNP_FDO_EXTENSION FdoExt,
|
|
_In_ PISAPNP_LOGICAL_DEVICE LogicalDevice);
|
|
|
|
_IRQL_requires_max_(DISPATCH_LEVEL)
|
|
VOID
|
|
IsaHwWaitForKey(VOID);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _ISAPNP_PCH_ */
|