halfuncs.h File Reference

#include <umtypes.h>
#include <haltypes.h>
#include <ketypes.h>
#include <section_attribs.h>

Include dependency graph for halfuncs.h:

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

Go to the source code of this file.

Macros
#define	HalHandlerForBus   HALPRIVATEDISPATCH->HalHandlerForBus
#define	HalHandlerForConfigSpace   HALPRIVATEDISPATCH->HalHandlerForConfigSpace
#define	HalLocateHiberRanges   HALPRIVATEDISPATCH->HalLocateHiberRanges
#define	HalRegisterBusHandler   HALPRIVATEDISPATCH->HalRegisterBusHandler
#define	HalSetWakeEnable   HALPRIVATEDISPATCH->HalSetWakeEnable
#define	HalSetWakeAlarm   HALPRIVATEDISPATCH->HalSetWakeAlarm
#define	HalPciTranslateBusAddress   HALPRIVATEDISPATCH->HalPciTranslateBusAddress
#define	HalPciAssignSlotResources   HALPRIVATEDISPATCH->HalPciAssignSlotResources
#define	HalHaltSystem   HALPRIVATEDISPATCH->HalHaltSystem
#define	HalFindBusAddressTranslation   HALPRIVATEDISPATCH->HalFindBusAddressTranslation
#define	HalResetDisplay   HALPRIVATEDISPATCH->HalResetDisplay
#define	HalAllocateMapRegisters   HALPRIVATEDISPATCH->HalAllocateMapRegisters
#define	KdSetupPciDeviceForDebugging   HALPRIVATEDISPATCH->KdSetupPciDeviceForDebugging
#define	KdReleasePciDeviceforDebugging   HALPRIVATEDISPATCH->KdReleasePciDeviceforDebugging
#define	KdGetAcpiTablePhase0   HALPRIVATEDISPATCH->KdGetAcpiTablePhase0
#define	KdCheckPowerButton   HALPRIVATEDISPATCH->KdCheckPowerButton
#define	HalVectorToIDTEntry   HALPRIVATEDISPATCH->HalVectorToIDTEntry
#define	KdMapPhysicalMemory64   HALPRIVATEDISPATCH->KdMapPhysicalMemory64
#define	KdUnmapVirtualAddress   HALPRIVATEDISPATCH->KdUnmapVirtualAddress

Functions
NTHALAPI VOID NTAPI	HalDisplayString (_In_ PCHAR String)
NTHALAPI BOOLEAN NTAPI	HalAllProcessorsStarted (VOID)
NTHALAPI VOID NTAPI	HalReturnToFirmware (_In_ FIRMWARE_REENTRY Action)
NTHALAPI VOID NTAPI	HalProcessorIdle (VOID)
NTHALAPI BOOLEAN NTAPI	HalBeginSystemInterrupt (_In_ KIRQL Irql, _In_ ULONG Vector, _Out_ PKIRQL OldIrql)
NTHALAPI VOID FASTCALL	HalClearSoftwareInterrupt (_In_ KIRQL Request)
NTHALAPI VOID NTAPI	HalDisableSystemInterrupt (_In_ ULONG Vector, _In_ KIRQL Irql)
NTHALAPI BOOLEAN NTAPI	HalEnableSystemInterrupt (_In_ ULONG Vector, _In_ KIRQL Irql, _In_ KINTERRUPT_MODE InterruptMode)
NTHALAPI VOID NTAPI	HalEndSystemInterrupt (_In_ KIRQL Irql, _In_ UCHAR Vector)
NTHALAPI VOID NTAPI	HalReportResourceUsage (VOID)
NTHALAPI VOID FASTCALL	HalRequestSoftwareInterrupt (_In_ KIRQL SoftwareInterruptRequested)
NTHALAPI VOID NTAPI	HalRequestIpi (_In_ KAFFINITY TargetSet)
NTHALAPI VOID NTAPI	HalHandleNMI (PVOID NmiInfo)
NTHALAPI UCHAR FASTCALL	HalSystemVectorDispatchEntry (_In_ ULONG Vector, _Out_ PKINTERRUPT_ROUTINE **FlatDispatch, _Out_ PKINTERRUPT_ROUTINE *NoConnection)
NTHALAPI NTSTATUS NTAPI	HalAdjustResourceList (_Inout_ PIO_RESOURCE_REQUIREMENTS_LIST *pResourceList)
NTHALAPI VOID NTAPI	HalStartProfileInterrupt (_In_ KPROFILE_SOURCE ProfileSource)
NTHALAPI VOID NTAPI	HalStopProfileInterrupt (_In_ KPROFILE_SOURCE ProfileSource)
NTHALAPI ULONG_PTR NTAPI	HalSetProfileInterval (_In_ ULONG_PTR Interval)
NTHALAPI BOOLEAN NTAPI	HalQueryRealTimeClock (_In_ PTIME_FIELDS RtcTime)
NTHALAPI BOOLEAN NTAPI	HalSetRealTimeClock (_In_ PTIME_FIELDS RtcTime)
NTHALAPI ULONG NTAPI	HalSetTimeIncrement (_In_ ULONG Increment)
NTHALAPI NTSTATUS NTAPI	x86BiosAllocateBuffer (_Inout_ ULONG *Size, _Out_ USHORT *Segment, _Out_ USHORT *Offset)
NTHALAPI NTSTATUS NTAPI	x86BiosFreeBuffer (_In_ USHORT Segment, _In_ USHORT Offset)
NTHALAPI NTSTATUS NTAPI	x86BiosReadMemory (_In_ USHORT Segment, _In_ USHORT Offset, _Out_writes_bytes_(Size) PVOID Buffer, _In_ ULONG Size)
NTHALAPI NTSTATUS NTAPI	x86BiosWriteMemory (_In_ USHORT Segment, _In_ USHORT Offset, _In_reads_bytes_(Size) PVOID Buffer, _In_ ULONG Size)
NTHALAPI BOOLEAN NTAPI	x86BiosCall (_In_ ULONG InterruptNumber, _Inout_ PX86_BIOS_REGISTERS Registers)

Macro Definition Documentation

HalAllocateMapRegisters

#define HalAllocateMapRegisters   HALPRIVATEDISPATCH->HalAllocateMapRegisters

Definition at line 46 of file halfuncs.h.

HalFindBusAddressTranslation

#define HalFindBusAddressTranslation   HALPRIVATEDISPATCH->HalFindBusAddressTranslation

Definition at line 44 of file halfuncs.h.

HalHaltSystem

#define HalHaltSystem   HALPRIVATEDISPATCH->HalHaltSystem

Definition at line 43 of file halfuncs.h.

HalHandlerForBus

#define HalHandlerForBus   HALPRIVATEDISPATCH->HalHandlerForBus

Definition at line 35 of file halfuncs.h.

HalHandlerForConfigSpace

#define HalHandlerForConfigSpace   HALPRIVATEDISPATCH->HalHandlerForConfigSpace

Definition at line 36 of file halfuncs.h.

HalLocateHiberRanges

#define HalLocateHiberRanges   HALPRIVATEDISPATCH->HalLocateHiberRanges

Definition at line 37 of file halfuncs.h.

HalPciAssignSlotResources

#define HalPciAssignSlotResources   HALPRIVATEDISPATCH->HalPciAssignSlotResources

Definition at line 42 of file halfuncs.h.

HalPciTranslateBusAddress

#define HalPciTranslateBusAddress   HALPRIVATEDISPATCH->HalPciTranslateBusAddress

Definition at line 41 of file halfuncs.h.

HalRegisterBusHandler

#define HalRegisterBusHandler   HALPRIVATEDISPATCH->HalRegisterBusHandler

Definition at line 38 of file halfuncs.h.

HalResetDisplay

#define HalResetDisplay   HALPRIVATEDISPATCH->HalResetDisplay

Definition at line 45 of file halfuncs.h.

HalSetWakeAlarm

#define HalSetWakeAlarm   HALPRIVATEDISPATCH->HalSetWakeAlarm

Definition at line 40 of file halfuncs.h.

HalSetWakeEnable

#define HalSetWakeEnable   HALPRIVATEDISPATCH->HalSetWakeEnable

Definition at line 39 of file halfuncs.h.

HalVectorToIDTEntry

#define HalVectorToIDTEntry   HALPRIVATEDISPATCH->HalVectorToIDTEntry

Definition at line 51 of file halfuncs.h.

KdCheckPowerButton

#define KdCheckPowerButton   HALPRIVATEDISPATCH->KdCheckPowerButton

Definition at line 50 of file halfuncs.h.

KdGetAcpiTablePhase0

#define KdGetAcpiTablePhase0   HALPRIVATEDISPATCH->KdGetAcpiTablePhase0

Definition at line 49 of file halfuncs.h.

KdMapPhysicalMemory64

#define KdMapPhysicalMemory64   HALPRIVATEDISPATCH->KdMapPhysicalMemory64

Definition at line 52 of file halfuncs.h.

KdReleasePciDeviceforDebugging

#define KdReleasePciDeviceforDebugging   HALPRIVATEDISPATCH->KdReleasePciDeviceforDebugging

Definition at line 48 of file halfuncs.h.

KdSetupPciDeviceForDebugging

#define KdSetupPciDeviceForDebugging   HALPRIVATEDISPATCH->KdSetupPciDeviceForDebugging

Definition at line 47 of file halfuncs.h.

KdUnmapVirtualAddress

#define KdUnmapVirtualAddress   HALPRIVATEDISPATCH->KdUnmapVirtualAddress

Definition at line 53 of file halfuncs.h.

Function Documentation

HalAdjustResourceList()

NTHALAPI NTSTATUS NTAPI HalAdjustResourceList

(

_Inout_ PIO_RESOURCE_REQUIREMENTS_LIST *

pResourceList

)

HalAllProcessorsStarted()

NTHALAPI BOOLEAN NTAPI HalAllProcessorsStarted

(

VOID

)

Definition at line 60 of file processor.c.

{
    /* Do nothing */
    return TRUE;
}

Referenced by Phase1InitializationDiscard().

HalBeginSystemInterrupt()

NTHALAPI BOOLEAN NTAPI HalBeginSystemInterrupt	(	_In_ KIRQL	Irql,
		_In_ ULONG	Vector,
		_Out_ PKIRQL	OldIrql
	)

HalClearSoftwareInterrupt()

NTHALAPI VOID FASTCALL HalClearSoftwareInterrupt

(

_In_ KIRQL

Request

)

HalDisableSystemInterrupt()

NTHALAPI VOID NTAPI HalDisableSystemInterrupt	(	_In_ ULONG	Vector,
		_In_ KIRQL	Irql
	)

HalDisplayString()

NTHALAPI VOID NTAPI HalDisplayString

(

_In_ PCHAR

String

)

HalEnableSystemInterrupt()

NTHALAPI BOOLEAN NTAPI HalEnableSystemInterrupt	(	_In_ ULONG	Vector,
		_In_ KIRQL	Irql,
		_In_ KINTERRUPT_MODE	InterruptMode
	)

HalEndSystemInterrupt()

NTHALAPI VOID NTAPI HalEndSystemInterrupt	(	_In_ KIRQL	Irql,
		_In_ UCHAR	Vector
	)

HalHandleNMI()

NTHALAPI VOID NTAPI HalHandleNMI

(

PVOID

NmiInfo

)

HalProcessorIdle()

NTHALAPI VOID NTAPI HalProcessorIdle

(

VOID

)

Definition at line 83 of file processor.c.

{
    /* Enable interrupts and halt the processor */
    _enable();
    UNIMPLEMENTED;
    while (TRUE);
}

Referenced by PopIdle0().

HalQueryRealTimeClock()

NTHALAPI BOOLEAN NTAPI HalQueryRealTimeClock

(

_In_ PTIME_FIELDS

RtcTime

)

HalReportResourceUsage()

NTHALAPI VOID NTAPI HalReportResourceUsage

(

VOID

)

Definition at line 67 of file usage.c.

{
    UNICODE_STRING HalString;
 
    /* Build HAL usage */
    RtlInitUnicodeString(&HalString, L"ARM Versatile HAL");
    HalpReportResourceUsage(&HalString, Internal);
}

Referenced by Phase1InitializationDiscard().

HalRequestIpi()

NTHALAPI VOID NTAPI HalRequestIpi

(

_In_ KAFFINITY

TargetSet

)

Definition at line 19 of file up.c.

{
    /* This should never be called in UP mode */
    __debugbreak();
}

HalRequestSoftwareInterrupt()

NTHALAPI VOID FASTCALL HalRequestSoftwareInterrupt

(

_In_ KIRQL

SoftwareInterruptRequested

)

HalReturnToFirmware()

NTHALAPI VOID NTAPI HalReturnToFirmware

(

_In_ FIRMWARE_REENTRY

Action

)

Definition at line 21 of file reboot.c.

{
    /* Check what kind of action this is */
    switch (Action)
    {
        /* All recognized actions */
        case HalHaltRoutine:
        case HalPowerDownRoutine:
        case HalRestartRoutine:
        case HalRebootRoutine:
        {
            /* Acquire the display */
            InbvAcquireDisplayOwnership();
            // TODO: Reboot
        }
 
        /* Anything else */
        default:
        {
            /* Print message and break */
            DbgPrint("HalReturnToFirmware called!\n");
            DbgBreakPoint();
        }
    }
}

Referenced by KdbpCmdReboot(), KdpSendWaitContinue(), KeBugCheckWithTf(), and PopShutdownSystem().

HalSetProfileInterval()

NTHALAPI ULONG_PTR NTAPI HalSetProfileInterval

(

_In_ ULONG_PTR

Interval

)

Definition at line 58 of file profil.c.

{
    /*
     * FIXME:
     * 1) What is the maximum and minimum interrupt frequency for the RTC?
     * 2) Find the maximum possible clock divisor value.
     */
    UNIMPLEMENTED;
 
    /* Update interval */
    if (!HalpProfilingStopped)
       HalStartProfileInterrupt(0);
 
    /* For now... */
    return Interval;
}

HalSetRealTimeClock()

NTHALAPI BOOLEAN NTAPI HalSetRealTimeClock

(

_In_ PTIME_FIELDS

RtcTime

)

Definition at line 288 of file cmos.c.

{
    UCHAR i, j;
    UCHAR SysTime[6];
 
    HalpAcquireCmosSpinLock();
 
    HalpRtcWriteCommand(RTC_CMD_REGISTER_SHIFT);
 
    SysTime[0] = INT_BCD(Time->Second);
    SysTime[1] = INT_BCD(Time->Minute);
    SysTime[2] = INT_BCD(Time->Hour);
    SysTime[3] = INT_BCD(Time->Day);
    SysTime[4] = (Time->Month << 4) | (Time->Weekday & 0x0F);
    SysTime[5] = INT_BCD(Time->Year % 100);
 
    /* Write time fields to RTC */
    for (i = 0; i < 6; i++)
    {
        for (j = 0; j < 8; j++)
            HalpRtcWriteBit(SysTime[i] >> j);
    }
 
    HalpRtcWriteCommand(RTC_CMD_TIME_SET_COUNTER_HOLD);
    HalpRtcWriteCommand(RTC_CMD_REGISTER_HOLD);
 
    HalpReleaseCmosSpinLock();
 
    return TRUE;
}

HalSetTimeIncrement()

NTHALAPI ULONG NTAPI HalSetTimeIncrement

(

_In_ ULONG

Increment

)

HalStartProfileInterrupt()

NTHALAPI VOID NTAPI HalStartProfileInterrupt

(

_In_ KPROFILE_SOURCE

ProfileSource

)

Definition at line 41 of file profil.c.

{
    UNREFERENCED_PARAMETER(ProfileSource);
 
    HalpProfilingStopped = FALSE;
 
    HalpAcquireCmosSpinLock();
 
    /* Configure the clock divisor for generating periodic interrupts */
    __outbyte(RTC_IO_o_INT_CLOCK_DIVISOR, HalpProfileRate | 0x80);
 
    HalpReleaseCmosSpinLock();
}

HalStopProfileInterrupt()

NTHALAPI VOID NTAPI HalStopProfileInterrupt

(

_In_ KPROFILE_SOURCE

ProfileSource

)

Definition at line 24 of file profil.c.

{
    UNREFERENCED_PARAMETER(ProfileSource);
 
    HalpAcquireCmosSpinLock();
 
    /* Clear the interrupt flag */
    (VOID)__inbyte(RTC_IO_i_INTERRUPT_RESET);
 
    HalpProfilingStopped = TRUE;
 
    HalpReleaseCmosSpinLock();
}

HalSystemVectorDispatchEntry()

NTHALAPI UCHAR FASTCALL HalSystemVectorDispatchEntry	(	_In_ ULONG	Vector,
		_Out_ PKINTERRUPT_ROUTINE **	FlatDispatch,
		_Out_ PKINTERRUPT_ROUTINE *	NoConnection
	)

x86BiosAllocateBuffer()

NTHALAPI NTSTATUS NTAPI x86BiosAllocateBuffer	(	_Inout_ ULONG *	Size,
		_Out_ USHORT *	Segment,
		_Out_ USHORT *	Offset
	)

Definition at line 151 of file x86bios.c.

{
    /* Check if the system is initialized and the buffer is large enough */
    if (!x86BiosIsInitialized || (*Size > PAGE_SIZE))
    {
        /* Something was wrong, fail! */
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    /* Check if the buffer is already allocated */
    if (InterlockedBitTestAndSet(&x86BiosBufferIsAllocated, 0))
    {
        /* Buffer was already allocated, fail */
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    /* The buffer is sufficient, return hardcoded address and size */
    *Size = PAGE_SIZE;
    *Segment = x86BiosBufferPhysical / 16;
    *Offset = 0;
 
    return STATUS_SUCCESS;
}

Referenced by IntInitializeX86Emu(), and IntInt10AllocateBufferEmu().

x86BiosCall()

NTHALAPI BOOLEAN NTAPI x86BiosCall	(	_In_ ULONG	InterruptNumber,
		_Inout_ PX86_BIOS_REGISTERS	Registers
	)

Definition at line 410 of file x86bios.c.

{
    const ULONG StackBase = 0x2000;
    FAST486_STATE EmulatorContext;
    ULONG FlatIp;
    PUCHAR InstructionPointer;
 
    /* Initialize the emulator context */
    Fast486Initialize(&EmulatorContext,
                      x86MemRead,
                      x86MemWrite,
                      x86IoRead,
                      x86IoWrite,
                      x86BOP,
                      x86IntAck,
                      NULL,  // FpuCallback,
                      NULL); // Tlb
 
    /* Copy the GP registers */
    EmulatorContext.GeneralRegs[FAST486_REG_EAX].Long = Registers->Eax;
    EmulatorContext.GeneralRegs[FAST486_REG_EBX].Long = Registers->Ebx;
    EmulatorContext.GeneralRegs[FAST486_REG_ECX].Long = Registers->Ecx;
    EmulatorContext.GeneralRegs[FAST486_REG_EDX].Long = Registers->Edx;
    EmulatorContext.GeneralRegs[FAST486_REG_ESI].Long = Registers->Esi;
    EmulatorContext.GeneralRegs[FAST486_REG_EDI].Long = Registers->Edi;
 
    /* Initialize segment registers */
    Fast486SetSegment(&EmulatorContext, FAST486_REG_DS, Registers->SegDs);
    Fast486SetSegment(&EmulatorContext, FAST486_REG_ES, Registers->SegEs);
 
    /* Set Eflags */
    EmulatorContext.Flags.Long = 0;
    EmulatorContext.Flags.AlwaysSet = 1;
    EmulatorContext.Flags.If = 1;
 
    /* Set up the INT stub */
    FlatIp = StackBase - 4;
    InstructionPointer = x86BiosMemoryMapping + FlatIp;
    InstructionPointer[0] = 0xCD; // INT instruction
    InstructionPointer[1] = (UCHAR)InterruptNumber;
    InstructionPointer[2] = 0x90; // NOP. We will stop at this address.
 
    /* Set the stack pointer */
    Fast486SetStack(&EmulatorContext, 0, StackBase - 8);
 
    /* Start execution at the INT stub */
    Fast486ExecuteAt(&EmulatorContext, 0x00, FlatIp);
 
    while (TRUE)
    {
        /* Get the current flat IP */
        FlatIp = (EmulatorContext.SegmentRegs[FAST486_REG_CS].Selector << 4) +
                 EmulatorContext.InstPtr.Long;
 
        /* Make sure we haven't left the allowed memory range */
        if (FlatIp >= 0x100000)
        {
            DPRINT1("x86BiosCall: invalid IP (0x%lx) during BIOS execution\n", FlatIp);
            return FALSE;
        }
 
        /* Check if we returned from our int stub */
        if (FlatIp == (StackBase - 2))
        {
            /* We are done! */
            break;
        }
 
        /* Emulate one instruction */
        Fast486StepInto(&EmulatorContext);
    }
 
    /* Copy the registers back */
    Registers->Eax = EmulatorContext.GeneralRegs[FAST486_REG_EAX].Long;
    Registers->Ebx = EmulatorContext.GeneralRegs[FAST486_REG_EBX].Long;
    Registers->Ecx = EmulatorContext.GeneralRegs[FAST486_REG_ECX].Long;
    Registers->Edx = EmulatorContext.GeneralRegs[FAST486_REG_EDX].Long;
    Registers->Esi = EmulatorContext.GeneralRegs[FAST486_REG_ESI].Long;
    Registers->Edi = EmulatorContext.GeneralRegs[FAST486_REG_EDI].Long;
    Registers->SegDs = EmulatorContext.SegmentRegs[FAST486_REG_DS].Selector;
    Registers->SegEs = EmulatorContext.SegmentRegs[FAST486_REG_ES].Selector;
 
    return TRUE;
}

Referenced by IntInitializeX86Emu(), and IntInt10CallBiosEmu().

x86BiosFreeBuffer()

NTHALAPI NTSTATUS NTAPI x86BiosFreeBuffer	(	_In_ USHORT	Segment,
		_In_ USHORT	Offset
	)

Definition at line 180 of file x86bios.c.

{
    /* Check if the system is initialized and if the address matches */
    if (!x86BiosIsInitialized || (Segment != 0x2000) || (Offset != 0))
    {
        /* Something was wrong, fail */
        return STATUS_INVALID_PARAMETER;
    }
 
    /* Check if the buffer was allocated */
    if (!InterlockedBitTestAndReset(&x86BiosBufferIsAllocated, 0))
    {
        /* It was not, fail */
        return STATUS_INVALID_PARAMETER;
    }
 
    /* Buffer is freed, nothing more to do */
    return STATUS_SUCCESS;
}

Referenced by IntInitializeX86Emu(), and IntInt10FreeBufferEmu().

x86BiosReadMemory()

NTHALAPI NTSTATUS NTAPI x86BiosReadMemory	(	_In_ USHORT	Segment,
		_In_ USHORT	Offset,
		_Out_writes_bytes_(Size) PVOID	Buffer,
		_In_ ULONG	Size
	)

Definition at line 204 of file x86bios.c.

{
    ULONG_PTR Address;
 
    /* Calculate the physical address */
    Address = (Segment << 4) + Offset;
 
    /* Check if it's valid */
    if (!x86BiosIsInitialized || ((Address + Size) > 0x100000))
    {
        /* Invalid */
        return STATUS_INVALID_PARAMETER;
    }
 
    /* Copy the memory to the buffer */
    RtlCopyMemory(Buffer, x86BiosMemoryMapping + Address, Size);
 
    /* Return success */
    return STATUS_SUCCESS;
}

Referenced by IntInitializeX86Emu(), and IntInt10ReadMemoryEmu().

x86BiosWriteMemory()

NTHALAPI NTSTATUS NTAPI x86BiosWriteMemory	(	_In_ USHORT	Segment,
		_In_ USHORT	Offset,
		_In_reads_bytes_(Size) PVOID	Buffer,
		_In_ ULONG	Size
	)

Definition at line 231 of file x86bios.c.

{
    ULONG_PTR Address;
 
    /* Calculate the physical address */
    Address = (Segment << 4) + Offset;
 
    /* Check if it's valid */
    if (!x86BiosIsInitialized || ((Address + Size) > 0x100000))
    {
        /* Invalid */
        return STATUS_INVALID_PARAMETER;
    }
 
    /* Copy the memory from the buffer */
    RtlCopyMemory(x86BiosMemoryMapping + Address, Buffer, Size);
 
    /* Return success */
    return STATUS_SUCCESS;
}

Referenced by IntInitializeX86Emu(), and IntInt10WriteMemoryEmu().