Typedefs
typedef struct _WHEA_ERROR_SOURCE_DESCRIPTOR *	PWHEA_ERROR_SOURCE_DESCRIPTOR

typedef struct _WHEA_ERROR_RECORD *	PWHEA_ERROR_RECORD

Functions
NTHALAPI VOID NTAPI	IoFreeAdapterChannel (_In_ PADAPTER_OBJECT AdapterObject)

NTHALAPI BOOLEAN NTAPI	IoFlushAdapterBuffers (_In_ PADAPTER_OBJECT AdapterObject, _In_ PMDL Mdl, _In_ PVOID MapRegisterBase, _In_ PVOID CurrentVa, _In_ ULONG Length, _In_ BOOLEAN WriteToDevice)

NTHALAPI VOID NTAPI	IoFreeMapRegisters (_In_ PADAPTER_OBJECT AdapterObject, _In_ PVOID MapRegisterBase, _In_ ULONG NumberOfMapRegisters)

NTHALAPI PVOID NTAPI	HalAllocateCommonBuffer (_In_ PADAPTER_OBJECT AdapterObject, _In_ ULONG Length, _Out_ PPHYSICAL_ADDRESS LogicalAddress, _In_ BOOLEAN CacheEnabled)

NTHALAPI VOID NTAPI	HalFreeCommonBuffer (_In_ PADAPTER_OBJECT AdapterObject, _In_ ULONG Length, _In_ PHYSICAL_ADDRESS LogicalAddress, _In_ PVOID VirtualAddress, _In_ BOOLEAN CacheEnabled)

NTHALAPI ULONG NTAPI	HalReadDmaCounter (_In_ PADAPTER_OBJECT AdapterObject)

NTHALAPI NTSTATUS NTAPI	HalAllocateAdapterChannel (_In_ PADAPTER_OBJECT AdapterObject, _In_ PWAIT_CONTEXT_BLOCK Wcb, _In_ ULONG NumberOfMapRegisters, _In_ PDRIVER_CONTROL ExecutionRoutine)

	$endif (_NTDDK_) $if(_NTDDK_) NTHALAPI NTSTATUS NTAPI HalAssignSlotResources(_In_ PUNICODE_STRING RegistryPath

	_IRQL_requires_max_ (PASSIVE_LEVEL) NTHALAPI ULONG NTAPI HalGetInterruptVector(_In_ INTERFACE_TYPE InterfaceType
	Queries information details about a security descriptor.

NTHALAPI ULONG NTAPI	HalSetBusData (_In_ BUS_DATA_TYPE BusDataType, _In_ ULONG BusNumber, _In_ ULONG SlotNumber, _In_reads_bytes_(Length) PVOID Buffer, _In_ ULONG Length)

NTHALAPI ULONG NTAPI	HalGetBusData (_In_ BUS_DATA_TYPE BusDataType, _In_ ULONG BusNumber, _In_ ULONG SlotNumber, _Out_writes_bytes_(Length) PVOID Buffer, _In_ ULONG Length)

NTHALAPI BOOLEAN NTAPI	HalMakeBeep (_In_ ULONG Frequency)

VOID NTAPI	HalPutDmaAdapter (_In_ PADAPTER_OBJECT DmaAdapter)

NTHALAPI VOID NTAPI	HalAcquireDisplayOwnership (_In_ PHAL_RESET_DISPLAY_PARAMETERS ResetDisplayParameters)

NTHALAPI ULONG NTAPI	HalGetBusDataByOffset (_In_ BUS_DATA_TYPE BusDataType, _In_ ULONG BusNumber, _In_ ULONG SlotNumber, _Out_writes_bytes_(Length) PVOID Buffer, _In_ ULONG Offset, _In_ ULONG Length)

NTHALAPI ULONG NTAPI	HalSetBusDataByOffset (_In_ BUS_DATA_TYPE BusDataType, _In_ ULONG BusNumber, _In_ ULONG SlotNumber, _In_reads_bytes_(Length) PVOID Buffer, _In_ ULONG Offset, _In_ ULONG Length)

NTHALAPI BOOLEAN NTAPI	HalTranslateBusAddress (_In_ INTERFACE_TYPE InterfaceType, _In_ ULONG BusNumber, _In_ PHYSICAL_ADDRESS BusAddress, _Inout_ PULONG AddressSpace, _Out_ PPHYSICAL_ADDRESS TranslatedAddress)

NTHALAPI PVOID NTAPI	HalAllocateCrashDumpRegisters (_In_ PADAPTER_OBJECT AdapterObject, _Inout_ PULONG NumberOfMapRegisters)

NTSTATUS NTAPI	HalGetScatterGatherList (_In_ PADAPTER_OBJECT DmaAdapter, _In_ PDEVICE_OBJECT DeviceObject, _In_ PMDL Mdl, _In_ PVOID CurrentVa, _In_ ULONG Length, _In_ PDRIVER_LIST_CONTROL ExecutionRoutine, _In_ PVOID Context, _In_ BOOLEAN WriteToDevice)

VOID NTAPI	HalPutScatterGatherList (_In_ PADAPTER_OBJECT DmaAdapter, _In_ PSCATTER_GATHER_LIST ScatterGather, _In_ BOOLEAN WriteToDevice)

NTSTATUS NTAPI	HalAllocateHardwareCounters (_In_reads_(GroupCount) PGROUP_AFFINITY GroupAffinty, _In_ ULONG GroupCount, _In_ PPHYSICAL_COUNTER_RESOURCE_LIST ResourceList, _Out_ PHANDLE CounterSetHandle)

NTSTATUS NTAPI	HalFreeHardwareCounters (_In_ HANDLE CounterSetHandle)

NTHALAPI VOID NTAPI	HalBugCheckSystem (_In_ PWHEA_ERROR_SOURCE_DESCRIPTOR ErrorSource, _In_ PWHEA_ERROR_RECORD ErrorRecord)

Variables
_In_opt_ PUNICODE_STRING	DriverClassName

_In_opt_ PUNICODE_STRING _In_ PDRIVER_OBJECT	DriverObject

_In_opt_ PUNICODE_STRING _In_ PDRIVER_OBJECT _In_ PDEVICE_OBJECT	DeviceObject

_In_opt_ PUNICODE_STRING _In_ PDRIVER_OBJECT _In_ PDEVICE_OBJECT _In_ INTERFACE_TYPE	BusType

_In_opt_ PUNICODE_STRING _In_ PDRIVER_OBJECT _In_ PDEVICE_OBJECT _In_ INTERFACE_TYPE _In_ ULONG	BusNumber

_In_opt_ PUNICODE_STRING _In_ PDRIVER_OBJECT _In_ PDEVICE_OBJECT _In_ INTERFACE_TYPE _In_ ULONG _In_ ULONG	SlotNumber

_In_opt_ PUNICODE_STRING _In_ PDRIVER_OBJECT _In_ PDEVICE_OBJECT _In_ INTERFACE_TYPE _In_ ULONG _In_ ULONG _Inout_ PCM_RESOURCE_LIST *	AllocatedResources

_In_ ULONG _In_ ULONG	BusInterruptLevel

_In_ ULONG _In_ ULONG _In_ ULONG	BusInterruptVector

_In_ ULONG _In_ ULONG _In_ ULONG _Out_ PKIRQL	Irql

_In_ ULONG _In_ ULONG _In_ ULONG _Out_ PKIRQL _Out_ PKAFFINITY	Affinity

_Out_ PULONG	NumberOfMapRegisters

_In_ ULONG	SectorSize

_In_ ULONG _In_ ULONG	MBRTypeIdentifier

_In_ ULONG _In_ ULONG _Out_ PVOID *	Buffer

Typedef Documentation

◆ PWHEA_ERROR_RECORD

typedef struct _WHEA_ERROR_RECORD* PWHEA_ERROR_RECORD

Definition at line 329 of file halfuncs.h.

◆ PWHEA_ERROR_SOURCE_DESCRIPTOR

typedef struct _WHEA_ERROR_SOURCE_DESCRIPTOR* PWHEA_ERROR_SOURCE_DESCRIPTOR

Definition at line 328 of file halfuncs.h.

Function Documentation

◆ $endif()

$endif ( _NTDDK_ )

Definition at line 540 of file iofuncs.h.

{
    PriorityInfo->Size = sizeof(IO_PRIORITY_INFO);
    PriorityInfo->ThreadPriority = 0xffff;
    PriorityInfo->IoPriority = IoPriorityNormal;
    PriorityInfo->PagePriority = 0;
}

◆ _IRQL_requires_max_()

_IRQL_requires_max_ ( PASSIVE_LEVEL )

Queries information details about a security descriptor.

Computes the quota size of a security descriptor.

Assigns a security descriptor for a new object.

An extended function that assigns a security descriptor for a new object.

Frees a security descriptor.

An extended function that sets new information data to a security descriptor.

Modifies some information data about a security descriptor.

Parameters

[in]	SecurityInformation	Security information details to be queried from a security descriptor.
[out]	SecurityDescriptor	The returned security descriptor with security information data.
[in,out]	Length	The returned length of a security descriptor.
[in,out]	ObjectsSecurityDescriptor	The returned object security descriptor.

Returns: Returns STATUS_SUCCESS if the operations have been completed successfully and that the specific information about the security descriptor has been queried. STATUS_BUFFER_TOO_SMALL is returned if the buffer size is too small to contain the queried info about the security descriptor.

Parameters

[in]	Object	If specified, the function will use this arbitrary object that points to an object security descriptor.
[in]	SecurityInformation	Security information details to be set.
[in]	SecurityDescriptor	A security descriptor where its info is to be changed.
[in,out]	ObjectsSecurityDescriptor	The returned pointer to security descriptor objects.
[in]	PoolType	Pool type for the new security descriptor to allocate.
[in]	GenericMapping	The generic mapping of access rights masks.

Returns: See SeSetSecurityDescriptorInfoEx.

Parameters

[in]	Object	If specified, the function will use this arbitrary object that points to an object security descriptor.
[in]	SecurityInformation	Security information details to be set.
[in]	SecurityDescriptor	A security descriptor where its info is to be changed.
[in,out]	ObjectsSecurityDescriptor	The returned pointer to security descriptor objects.
[in]	AutoInheritFlags	Flags bitmask inheritation, influencing how the security descriptor can be inherited and if it can be in the first place.
[in]	PoolType	Pool type for the new security descriptor to allocate.
[in]	GenericMapping	The generic mapping of access rights masks.

Returns: Returns STATUS_SUCCESS if the operations have been completed without problems and that new info has been set to the security descriptor. STATUS_NO_SECURITY_ON_OBJECT is returned if the object does not have a security descriptor. STATUS_INSUFFICIENT_RESOURCES is returned if memory pool allocation for the new security descriptor with new info set has failed.

Parameters

[in] SecurityDescriptor A security descriptor to be freed from memory.

Returns: Returns STATUS_SUCCESS.

Parameters

[in]	_ParentDescriptor	A security descriptor of the parent object that is being created.
[in]	_ExplicitDescriptor	An explicit security descriptor that is applied to a new object.
[out]	NewDescriptor	The new allocated security descriptor.
[in]	ObjectType	The type of the new object.
[in]	IsDirectoryObject	Set this to TRUE if the newly created object is a directory object, otherwise set this to FALSE.
[in]	AutoInheritFlags	Automatic inheritance flags that influence how access control entries within ACLs from security descriptors are inherited.
[in]	SubjectContext	Security subject context of the new object.
[in]	GenericMapping	Generic mapping of access mask rights.
[in]	PoolType	This parameter is unused.

Returns: Returns STATUS_SUCCESS if the operations have been completed successfully and that the security descriptor has been assigned to the new object. STATUS_NO_TOKEN is returned if the caller hasn't supplied a valid argument to a security subject context. STATUS_INVALID_OWNER is returned if the caller hasn't supplied a parent descriptor that belongs to the main user (owner). STATUS_INVALID_PRIMARY_GROUP is returned by the same reason as with the previous NTSTATUS code. The two NTSTATUS codes are returned if the calling thread stated that the owner and/or group is defaulted to the parent descriptor (SEF_DEFAULT_OWNER_FROM_PARENT and/or SEF_DEFAULT_GROUP_FROM_PARENT respectively). STATUS_INSUFFICIENT_RESOURCES is returned if memory pool allocation for the descriptor buffer has failed. A failure NTSTATUS is returned otherwise.

Parameters

[in]	ParentDescriptor	A security descriptor of the parent object that is being created.
[in]	ExplicitDescriptor	An explicit security descriptor that is applied to a new object.
[out]	NewDescriptor	The new allocated security descriptor.
[in]	IsDirectoryObject	Set this to TRUE if the newly created object is a directory object, otherwise set this to FALSE.
[in]	SubjectContext	Security subject context of the new object.
[in]	GenericMapping	Generic mapping of access mask rights.
[in]	PoolType	This parameter is unused.

Returns: See SeAssignSecurityEx.

Parameters

[in]	SecurityDescriptor	A security descriptor.
[out]	QuotaInfoSize	The returned quota size of the given security descriptor to the caller. The function may return 0 to this parameter if the descriptor doesn't have a group or a discretionary access control list (DACL) even.

Returns: Returns STATUS_SUCCESS if the quota size of a security descriptor has been computed successfully. STATUS_UNKNOWN_REVISION is returned if the security descriptor has an invalid revision.

Definition at line 923 of file Messaging.c.

{
    PFLT_SERVER_PORT_OBJECT PortObject;
    NTSTATUS Status;
 
    /* The caller must allow at least one connection */
    if (MaxConnections == 0)
    {
        return STATUS_INVALID_PARAMETER;
    }
 
    /* The request must be for a kernel handle */
    if (!(ObjectAttributes->Attributes & OBJ_KERNEL_HANDLE))
    {
        return STATUS_INVALID_PARAMETER;
    }
 
    /*
     * Get rundown protection on the target to stop the owner
     * from unloading whilst this port object is open. It gets
     * removed in the FltpServerPortClose callback
     */
    Status = FltObjectReference(Filter);
    if (!NT_SUCCESS(Status))
    {
        return Status;
    }
 
    /* Create the server port object for this filter */
    Status = ObCreateObject(KernelMode,
                            ServerPortObjectType,
                            ObjectAttributes,
                            KernelMode,
                            NULL,
                            sizeof(FLT_SERVER_PORT_OBJECT),
                            0,
                            0,
                            (PVOID *)&PortObject);
    if (NT_SUCCESS(Status))
    {
        /* Zero out the struct */
        RtlZeroMemory(PortObject, sizeof(FLT_SERVER_PORT_OBJECT));
 
        /* Increment the ref count on the target filter */
        FltpObjectPointerReference((PFLT_OBJECT)Filter);
 
        /* Setup the filter port object */
        PortObject->Filter = Filter;
        PortObject->ConnectNotify = ConnectNotifyCallback;
        PortObject->DisconnectNotify = DisconnectNotifyCallback;
        PortObject->MessageNotify = MessageNotifyCallback;
        PortObject->Cookie = ServerPortCookie;
        PortObject->MaxConnections = MaxConnections;
 
        /* Insert the object */
        Status = ObInsertObject(PortObject,
                                NULL,
                                STANDARD_RIGHTS_ALL | FILE_READ_DATA,
                                0,
                                NULL,
                                (PHANDLE)ServerPort);
        if (NT_SUCCESS(Status))
        {
            /* Lock the connection list */
            ExAcquireFastMutex(&Filter->ConnectionList.mLock);
 
            /* Add the new port object to the connection list and increment the count */
            InsertTailList(&Filter->ConnectionList.mList, &PortObject->FilterLink);
            Filter->ConnectionList.mCount++;
 
            /* Unlock the connection list*/
            ExReleaseFastMutex(&Filter->ConnectionList.mLock);
        }
    }
 
    if (!NT_SUCCESS(Status))
    {
        /* Allow the filter to be cleaned up */
        FltObjectDereference(Filter);
    }
 
    return Status;
}

◆ HalAcquireDisplayOwnership()

NTHALAPI VOID NTAPI HalAcquireDisplayOwnership ( _In_ PHAL_RESET_DISPLAY_PARAMETERS ResetDisplayParameters )

◆ HalAllocateAdapterChannel()

NTHALAPI NTSTATUS NTAPI HalAllocateAdapterChannel	(	_In_ PADAPTER_OBJECT	AdapterObject,
		_In_ PWAIT_CONTEXT_BLOCK	Wcb,
		_In_ ULONG	NumberOfMapRegisters,
		_In_ PDRIVER_CONTROL	ExecutionRoutine
	)

◆ HalAllocateCommonBuffer()

NTHALAPI PVOID NTAPI HalAllocateCommonBuffer	(	_In_ PADAPTER_OBJECT	AdapterObject,
		_In_ ULONG	Length,
		_Out_ PPHYSICAL_ADDRESS	LogicalAddress,
		_In_ BOOLEAN	CacheEnabled
	)

◆ HalAllocateCrashDumpRegisters()

NTHALAPI PVOID NTAPI HalAllocateCrashDumpRegisters	(	_In_ PADAPTER_OBJECT	AdapterObject,
		_Inout_ PULONG	NumberOfMapRegisters
	)

◆ HalAllocateHardwareCounters()

NTSTATUS NTAPI HalAllocateHardwareCounters	(	_In_reads_(GroupCount) PGROUP_AFFINITY	GroupAffinty,
		_In_ ULONG	GroupCount,
		_In_ PPHYSICAL_COUNTER_RESOURCE_LIST	ResourceList,
		_Out_ PHANDLE	CounterSetHandle
	)

◆ HalBugCheckSystem()

NTHALAPI VOID NTAPI HalBugCheckSystem	(	_In_ PWHEA_ERROR_SOURCE_DESCRIPTOR	ErrorSource,
		_In_ PWHEA_ERROR_RECORD	ErrorRecord
	)

◆ HalFreeCommonBuffer()

NTHALAPI VOID NTAPI HalFreeCommonBuffer	(	_In_ PADAPTER_OBJECT	AdapterObject,
		_In_ ULONG	Length,
		_In_ PHYSICAL_ADDRESS	LogicalAddress,
		_In_ PVOID	VirtualAddress,
		_In_ BOOLEAN	CacheEnabled
	)

◆ HalFreeHardwareCounters()

NTSTATUS NTAPI HalFreeHardwareCounters ( _In_ HANDLE CounterSetHandle )

◆ HalGetBusData()

NTHALAPI ULONG NTAPI HalGetBusData	(	_In_ BUS_DATA_TYPE	BusDataType,
		_In_ ULONG	BusNumber,
		_In_ ULONG	SlotNumber,
		_Out_writes_bytes_(Length) PVOID	Buffer,
		_In_ ULONG	Length
	)

◆ HalGetBusDataByOffset()

NTHALAPI ULONG NTAPI HalGetBusDataByOffset	(	_In_ BUS_DATA_TYPE	BusDataType,
		_In_ ULONG	BusNumber,
		_In_ ULONG	SlotNumber,
		_Out_writes_bytes_(Length) PVOID	Buffer,
		_In_ ULONG	Offset,
		_In_ ULONG	Length
	)

◆ HalGetScatterGatherList()

NTSTATUS NTAPI HalGetScatterGatherList	(	_In_ PADAPTER_OBJECT	DmaAdapter,
		_In_ PDEVICE_OBJECT	DeviceObject,
		_In_ PMDL	Mdl,
		_In_ PVOID	CurrentVa,
		_In_ ULONG	Length,
		_In_ PDRIVER_LIST_CONTROL	ExecutionRoutine,
		_In_ PVOID	Context,
		_In_ BOOLEAN	WriteToDevice
	)

◆ HalMakeBeep()

NTHALAPI BOOLEAN NTAPI HalMakeBeep ( _In_ ULONG Frequency )

Definition at line 19 of file beep.c.

{
    TIMER_CONTROL_PORT_REGISTER TimerControl;
    ULONG Divider;
    BOOLEAN Success = FALSE;
 
    HalpAcquireCmosSpinLock();
 
    __outbyte(PPI_IO_o_CONTROL, PPI_TIMER_1_UNGATE_TO_SPEAKER);
 
    if (Frequency)
    {
        Divider = PIT_FREQUENCY / Frequency;
 
        if (Divider <= 0x10000)
        {
            TimerControl.BcdMode = FALSE;
            TimerControl.OperatingMode = PitOperatingMode3;
            TimerControl.Channel = PitChannel1;
            TimerControl.AccessMode = PitAccessModeLowHigh;
            __outbyte(TIMER_CONTROL_PORT, TimerControl.Bits);
            __outbyte(TIMER_CHANNEL1_DATA_PORT, FIRSTBYTE(Divider));
            __outbyte(TIMER_CHANNEL1_DATA_PORT, SECONDBYTE(Divider));
 
            __outbyte(PPI_IO_o_CONTROL, PPI_TIMER_1_GATE_TO_SPEAKER);
 
            Success = TRUE;
        }
    }
 
    HalpReleaseCmosSpinLock();
 
    return Success;
}

◆ HalPutDmaAdapter()

VOID NTAPI HalPutDmaAdapter ( _In_ PADAPTER_OBJECT DmaAdapter )

◆ HalPutScatterGatherList()

VOID NTAPI HalPutScatterGatherList	(	_In_ PADAPTER_OBJECT	DmaAdapter,
		_In_ PSCATTER_GATHER_LIST	ScatterGather,
		_In_ BOOLEAN	WriteToDevice
	)

◆ HalReadDmaCounter()

NTHALAPI ULONG NTAPI HalReadDmaCounter ( _In_ PADAPTER_OBJECT AdapterObject )

◆ HalSetBusData()

NTHALAPI ULONG NTAPI HalSetBusData	(	_In_ BUS_DATA_TYPE	BusDataType,
		_In_ ULONG	BusNumber,
		_In_ ULONG	SlotNumber,
		_In_reads_bytes_(Length) PVOID	Buffer,
		_In_ ULONG	Length
	)

◆ HalSetBusDataByOffset()

NTHALAPI ULONG NTAPI HalSetBusDataByOffset	(	_In_ BUS_DATA_TYPE	BusDataType,
		_In_ ULONG	BusNumber,
		_In_ ULONG	SlotNumber,
		_In_reads_bytes_(Length) PVOID	Buffer,
		_In_ ULONG	Offset,
		_In_ ULONG	Length
	)

◆ HalTranslateBusAddress()

NTHALAPI BOOLEAN NTAPI HalTranslateBusAddress	(	_In_ INTERFACE_TYPE	InterfaceType,
		_In_ ULONG	BusNumber,
		_In_ PHYSICAL_ADDRESS	BusAddress,
		_Inout_ PULONG	AddressSpace,
		_Out_ PPHYSICAL_ADDRESS	TranslatedAddress
	)

◆ IoFlushAdapterBuffers()

NTHALAPI BOOLEAN NTAPI IoFlushAdapterBuffers	(	_In_ PADAPTER_OBJECT	AdapterObject,
		_In_ PMDL	Mdl,
		_In_ PVOID	MapRegisterBase,
		_In_ PVOID	CurrentVa,
		_In_ ULONG	Length,
		_In_ BOOLEAN	WriteToDevice
	)