4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CPU Architectural Protocol as defined in PI spec Volume 2 DXE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This code abstracts the DXE core from processor implementation details.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { 0x26baccb1, 0x6f42, 0x11d4, {0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_CPU_ARCH_PROTOCOL EFI_CPU_ARCH_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The type of flush operation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The type of processor INIT.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_CPU_INTERRUPT_HANDLER that is called when a processor interrupt occurs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param InterruptType Defines the type of interrupt or exception that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync occurred on the processor.This parameter is processor architecture specific.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SystemContext A pointer to the processor context when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the interrupt occurred on the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return None
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function flushes the range of addresses from Start to Start+Length
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from the processor's data cache. If Start is not aligned to a cache line
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync boundary, then the bytes before Start to the preceding cache line boundary
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are also flushed. If Start+Length is not aligned to a cache line boundary,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then the bytes past Start+Length to the end of the next cache line boundary
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are also flushed. The FlushType of EfiCpuFlushTypeWriteBackInvalidate must be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync supported. If the data cache is fully coherent with all DMA operations, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this function can just return EFI_SUCCESS. If the processor does not support
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync flushing a range of the data cache, then the entire data cache can be flushed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The EFI_CPU_ARCH_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Start The beginning physical address to flush from the processor's data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length The number of bytes to flush from the processor's data cache. This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function may flush more bytes than Length specifies depending upon
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the granularity of the flush operation that the processor supports.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FlushType Specifies the type of flush operation to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The address range from Start to Start+Length was flushed from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the processor's data cache.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTEDT The processor does not support the cache flush type specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by FlushType.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The address range from Start to Start+Length could not be flushed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from the processor's data cache.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function enables interrupt processing by the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The EFI_CPU_ARCH_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Interrupts are enabled on the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Interrupts could not be enabled on the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function disables interrupt processing by the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The EFI_CPU_ARCH_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Interrupts are disabled on the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Interrupts could not be disabled on the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function retrieves the processor's current interrupt state a returns it in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync State. If interrupts are currently enabled, then TRUE is returned. If interrupts
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are currently disabled, then FALSE is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The EFI_CPU_ARCH_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param State A pointer to the processor's current interrupt state. Set to TRUE if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync interrupts are enabled and FALSE if interrupts are disabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The processor's current interrupt state was returned in State.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER State is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function generates an INIT on the processor. If this function succeeds, then the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync processor will be reset, and control will not be returned to the caller. If InitType is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not supported by this processor, or the processor cannot programmatically generate an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync INIT without help from external hardware, then EFI_UNSUPPORTED is returned. If an error
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync occurs attempting to generate an INIT, then EFI_DEVICE_ERROR is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The EFI_CPU_ARCH_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param InitType The type of processor INIT to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The processor INIT was performed. This return code should never be seen.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The processor INIT operation specified by InitType is not supported
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by this processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The processor INIT failed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function registers and enables the handler specified by InterruptHandler for a processor
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync interrupt or exception type specified by InterruptType. If InterruptHandler is NULL, then the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handler for the processor interrupt or exception type specified by InterruptType is uninstalled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The installed handler is called once for each processor interrupt or exception.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The EFI_CPU_ARCH_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param InterruptType A pointer to the processor's current interrupt state. Set to TRUE if interrupts
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are enabled and FALSE if interrupts are disabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param InterruptHandler A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER that is called
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync when a processor interrupt occurs. If this parameter is NULL, then the handler
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be uninstalled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The handler for the processor interrupt was successfully installed or uninstalled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED InterruptHandler is not NULL, and a handler for InterruptType was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync previously installed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync previously installed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The interrupt specified by InterruptType is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function reads the processor timer specified by TimerIndex and returns it in TimerValue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The EFI_CPU_ARCH_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TimerIndex Specifies which processor timer is to be returned in TimerValue. This parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync must be between 0 and NumberOfTimers-1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TimerValue Pointer to the returned timer value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TimerPeriod A pointer to the amount of time that passes in femtoseconds for each increment
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of TimerValue. If TimerValue does not increment at a predictable rate, then 0 is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned. This parameter is optional and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The processor timer value specified by TimerIndex was returned in TimerValue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An error occurred attempting to read one of the processor's timers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER TimerValue is NULL or TimerIndex is not valid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The processor does not have any readable timers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function modifies the attributes for the memory region specified by BaseAddress and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length from their current attributes to the attributes specified by Attributes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The EFI_CPU_ARCH_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BaseAddress The physical address that is the start address of a memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length The size in bytes of the memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attributes The bit mask of attributes to set for the memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The attributes were set for the memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BaseAddress and Length cannot be modified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Length is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Attributes specified an illegal combination of attributes that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cannot be set together.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the memory resource range.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resource range specified by BaseAddress and Length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The bit mask of attributes is not support for the memory resource
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync range specified by BaseAddress and Length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The EFI_CPU_ARCH_PROTOCOL is used to abstract processor-specific functions from the DXE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Foundation. This includes flushing caches, enabling and disabling interrupts, hooking interrupt
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// vectors and exception vectors, reading internal processor timers, resetting the processor, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// determining the processor frequency.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_CPU_REGISTER_INTERRUPT_HANDLER RegisterInterruptHandler;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The number of timers that are available in a processor. The value in this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// field is a constant that must not be modified after the CPU Architectural
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Protocol is installed. All consumers must treat this as a read-only field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The size, in bytes, of the alignment required for DMA buffer allocations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This is typically the size of the largest data cache line in the platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The value in this field is a constant that must not be modified after the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// CPU Architectural Protocol is installed. All consumers must treat this as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// a read-only field.