|
MdePkg[all]
1.08
|
|
MdePkg[all]
1.08
|
Data Structures | |
| struct | _EFI_CPU_ARCH_PROTOCOL |
Macros | |
| #define | EFI_CPU_ARCH_PROTOCOL_GUID { 0x26baccb1, 0x6f42, 0x11d4, {0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } } |
Enumerations | |
| enum | EFI_CPU_FLUSH_TYPE { EfiCpuFlushTypeWriteBackInvalidate, EfiCpuFlushTypeWriteBack, EfiCpuFlushTypeInvalidate, EfiCpuMaxFlushType } |
| enum | EFI_CPU_INIT_TYPE { EfiCpuInit, EfiCpuMaxInitType } |
Variables | |
| EFI_GUID | gEfiCpuArchProtocolGuid |
CPU Architectural Protocol as defined in PI spec Volume 2 DXE
This code abstracts the DXE core from processor implementation details.
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
| #define EFI_CPU_ARCH_PROTOCOL_GUID { 0x26baccb1, 0x6f42, 0x11d4, {0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } } |
| typedef struct _EFI_CPU_ARCH_PROTOCOL EFI_CPU_ARCH_PROTOCOL |
| typedef EFI_STATUS(EFIAPI * EFI_CPU_DISABLE_INTERRUPT)(IN EFI_CPU_ARCH_PROTOCOL *This) |
This function disables interrupt processing by the processor.
| This | The EFI_CPU_ARCH_PROTOCOL instance. |
| EFI_SUCCESS | Interrupts are disabled on the processor. |
| EFI_DEVICE_ERROR | Interrupts could not be disabled on the processor. |
| typedef EFI_STATUS(EFIAPI * EFI_CPU_ENABLE_INTERRUPT)(IN EFI_CPU_ARCH_PROTOCOL *This) |
This function enables interrupt processing by the processor.
| This | The EFI_CPU_ARCH_PROTOCOL instance. |
| EFI_SUCCESS | Interrupts are enabled on the processor. |
| EFI_DEVICE_ERROR | Interrupts could not be enabled on the processor. |
| typedef EFI_STATUS(EFIAPI * EFI_CPU_FLUSH_DATA_CACHE)(IN EFI_CPU_ARCH_PROTOCOL *This, IN EFI_PHYSICAL_ADDRESS Start, IN UINT64 Length, IN EFI_CPU_FLUSH_TYPE FlushType) |
This function flushes the range of addresses from Start to Start+Length from the processor's data cache. If Start is not aligned to a cache line boundary, then the bytes before Start to the preceding cache line boundary are also flushed. If Start+Length is not aligned to a cache line boundary, then the bytes past Start+Length to the end of the next cache line boundary are also flushed. The FlushType of EfiCpuFlushTypeWriteBackInvalidate must be supported. If the data cache is fully coherent with all DMA operations, then this function can just return EFI_SUCCESS. If the processor does not support flushing a range of the data cache, then the entire data cache can be flushed.
| This | The EFI_CPU_ARCH_PROTOCOL instance. |
| Start | The beginning physical address to flush from the processor's data cache. |
| Length | The number of bytes to flush from the processor's data cache. This function may flush more bytes than Length specifies depending upon the granularity of the flush operation that the processor supports. |
| FlushType | Specifies the type of flush operation to perform. |
| EFI_SUCCESS | The address range from Start to Start+Length was flushed from the processor's data cache. |
| EFI_UNSUPPORTED | The processor does not support the cache flush type specified by FlushType. |
| EFI_DEVICE_ERROR | The address range from Start to Start+Length could not be flushed from the processor's data cache. |
| typedef EFI_STATUS(EFIAPI * EFI_CPU_GET_INTERRUPT_STATE)(IN EFI_CPU_ARCH_PROTOCOL *This, OUT BOOLEAN *State) |
This function retrieves the processor's current interrupt state a returns it in State. If interrupts are currently enabled, then TRUE is returned. If interrupts are currently disabled, then FALSE is returned.
| This | The EFI_CPU_ARCH_PROTOCOL instance. |
| State | A pointer to the processor's current interrupt state. Set to TRUE if interrupts are enabled and FALSE if interrupts are disabled. |
| EFI_SUCCESS | The processor's current interrupt state was returned in State. |
| EFI_INVALID_PARAMETER | State is NULL. |
| typedef EFI_STATUS(EFIAPI * EFI_CPU_GET_TIMER_VALUE)(IN EFI_CPU_ARCH_PROTOCOL *This, IN UINT32 TimerIndex, OUT UINT64 *TimerValue, OUT UINT64 *TimerPeriod) |
This function reads the processor timer specified by TimerIndex and returns it in TimerValue.
| This | The EFI_CPU_ARCH_PROTOCOL instance. |
| TimerIndex | Specifies which processor timer is to be returned in TimerValue. This parameter must be between 0 and NumberOfTimers-1. |
| TimerValue | Pointer to the returned timer value. |
| TimerPeriod | A pointer to the amount of time that passes in femtoseconds for each increment of TimerValue. If TimerValue does not increment at a predictable rate, then 0 is returned. This parameter is optional and may be NULL. |
| EFI_SUCCESS | The processor timer value specified by TimerIndex was returned in TimerValue. |
| EFI_DEVICE_ERROR | An error occurred attempting to read one of the processor's timers. |
| EFI_INVALID_PARAMETER | TimerValue is NULL or TimerIndex is not valid. |
| EFI_UNSUPPORTED | The processor does not have any readable timers. |
| typedef EFI_STATUS(EFIAPI * EFI_CPU_INIT)(IN EFI_CPU_ARCH_PROTOCOL *This, IN EFI_CPU_INIT_TYPE InitType) |
This function generates an INIT on the processor. If this function succeeds, then the processor will be reset, and control will not be returned to the caller. If InitType is not supported by this processor, or the processor cannot programmatically generate an INIT without help from external hardware, then EFI_UNSUPPORTED is returned. If an error occurs attempting to generate an INIT, then EFI_DEVICE_ERROR is returned.
| This | The EFI_CPU_ARCH_PROTOCOL instance. |
| InitType | The type of processor INIT to perform. |
| EFI_SUCCESS | The processor INIT was performed. This return code should never be seen. |
| EFI_UNSUPPORTED | The processor INIT operation specified by InitType is not supported by this processor. |
| EFI_DEVICE_ERROR | The processor INIT failed. |
| typedef VOID(EFIAPI * EFI_CPU_INTERRUPT_HANDLER)(IN CONST EFI_EXCEPTION_TYPE InterruptType, IN CONST EFI_SYSTEM_CONTEXT SystemContext) |
EFI_CPU_INTERRUPT_HANDLER that is called when a processor interrupt occurs.
| InterruptType | Defines the type of interrupt or exception that occurred on the processor.This parameter is processor architecture specific. |
| SystemContext | A pointer to the processor context when the interrupt occurred on the processor. |
| typedef EFI_STATUS(EFIAPI * EFI_CPU_REGISTER_INTERRUPT_HANDLER)(IN EFI_CPU_ARCH_PROTOCOL *This, IN EFI_EXCEPTION_TYPE InterruptType, IN EFI_CPU_INTERRUPT_HANDLER InterruptHandler) |
This function registers and enables the handler specified by InterruptHandler for a processor interrupt or exception type specified by InterruptType. If InterruptHandler is NULL, then the handler for the processor interrupt or exception type specified by InterruptType is uninstalled. The installed handler is called once for each processor interrupt or exception.
| This | The EFI_CPU_ARCH_PROTOCOL instance. |
| InterruptType | A pointer to the processor's current interrupt state. Set to TRUE if interrupts are enabled and FALSE if interrupts are disabled. |
| InterruptHandler | A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER that is called when a processor interrupt occurs. If this parameter is NULL, then the handler will be uninstalled. |
| EFI_SUCCESS | The handler for the processor interrupt was successfully installed or uninstalled. |
| EFI_ALREADY_STARTED | InterruptHandler is not NULL, and a handler for InterruptType was previously installed. |
| EFI_INVALID_PARAMETER | InterruptHandler is NULL, and a handler for InterruptType was not previously installed. |
| EFI_UNSUPPORTED | The interrupt specified by InterruptType is not supported. |
| typedef EFI_STATUS(EFIAPI * EFI_CPU_SET_MEMORY_ATTRIBUTES)(IN EFI_CPU_ARCH_PROTOCOL *This, IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN UINT64 Attributes) |
This function modifies the attributes for the memory region specified by BaseAddress and Length from their current attributes to the attributes specified by Attributes.
| This | The EFI_CPU_ARCH_PROTOCOL instance. |
| BaseAddress | The physical address that is the start address of a memory region. |
| Length | The size in bytes of the memory region. |
| Attributes | The bit mask of attributes to set for the memory region. |
| EFI_SUCCESS | The attributes were set for the memory region. |
| EFI_ACCESS_DENIED | The attributes for the memory resource range specified by BaseAddress and Length cannot be modified. |
| EFI_INVALID_PARAMETER | Length is zero. Attributes specified an illegal combination of attributes that cannot be set together. |
| EFI_OUT_OF_RESOURCES | There are not enough system resources to modify the attributes of the memory resource range. |
| EFI_UNSUPPORTED | The processor does not support one or more bytes of the memory resource range specified by BaseAddress and Length. The bit mask of attributes is not support for the memory resource range specified by BaseAddress and Length. |
| enum EFI_CPU_FLUSH_TYPE |
| enum EFI_CPU_INIT_TYPE |
| EFI_GUID gEfiCpuArchProtocolGuid |
1.8.6 
