TianoCore EDK2 master
Cpu.h File Reference

Go to the source code of this file.

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 } }
 

Typedefs

typedef struct _EFI_CPU_ARCH_PROTOCOL EFI_CPU_ARCH_PROTOCOL
 
typedef VOID(EFIAPIEFI_CPU_INTERRUPT_HANDLER) (IN CONST EFI_EXCEPTION_TYPE InterruptType, IN CONST EFI_SYSTEM_CONTEXT SystemContext)
 
typedef EFI_STATUS(EFIAPIEFI_CPU_FLUSH_DATA_CACHE) (IN EFI_CPU_ARCH_PROTOCOL *This, IN EFI_PHYSICAL_ADDRESS Start, IN UINT64 Length, IN EFI_CPU_FLUSH_TYPE FlushType)
 
typedef EFI_STATUS(EFIAPIEFI_CPU_ENABLE_INTERRUPT) (IN EFI_CPU_ARCH_PROTOCOL *This)
 
typedef EFI_STATUS(EFIAPIEFI_CPU_DISABLE_INTERRUPT) (IN EFI_CPU_ARCH_PROTOCOL *This)
 
typedef EFI_STATUS(EFIAPIEFI_CPU_GET_INTERRUPT_STATE) (IN EFI_CPU_ARCH_PROTOCOL *This, OUT BOOLEAN *State)
 
typedef EFI_STATUS(EFIAPIEFI_CPU_INIT) (IN EFI_CPU_ARCH_PROTOCOL *This, IN EFI_CPU_INIT_TYPE InitType)
 
typedef EFI_STATUS(EFIAPIEFI_CPU_REGISTER_INTERRUPT_HANDLER) (IN EFI_CPU_ARCH_PROTOCOL *This, IN EFI_EXCEPTION_TYPE InterruptType, IN EFI_CPU_INTERRUPT_HANDLER InterruptHandler)
 
typedef EFI_STATUS(EFIAPIEFI_CPU_GET_TIMER_VALUE) (IN EFI_CPU_ARCH_PROTOCOL *This, IN UINT32 TimerIndex, OUT UINT64 *TimerValue, OUT UINT64 *TimerPeriod OPTIONAL)
 
typedef EFI_STATUS(EFIAPIEFI_CPU_SET_MEMORY_ATTRIBUTES) (IN EFI_CPU_ARCH_PROTOCOL *This, IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN UINT64 Attributes)
 

Enumerations

enum  EFI_CPU_FLUSH_TYPE { EfiCpuFlushTypeWriteBackInvalidate , EfiCpuFlushTypeWriteBack , EfiCpuFlushTypeInvalidate , EfiCpuMaxFlushType }
 
enum  EFI_CPU_INIT_TYPE { EfiCpuInit , EfiCpuMaxInitType }
 

Variables

EFI_GUID gEfiCpuArchProtocolGuid
 

Detailed Description

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

Definition in file Cpu.h.

Macro Definition Documentation

◆ EFI_CPU_ARCH_PROTOCOL_GUID

#define EFI_CPU_ARCH_PROTOCOL_GUID    { 0x26baccb1, 0x6f42, 0x11d4, {0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } }

Definition at line 16 of file Cpu.h.

Typedef Documentation

◆ EFI_CPU_ARCH_PROTOCOL

Definition at line 19 of file Cpu.h.

◆ EFI_CPU_DISABLE_INTERRUPT

typedef EFI_STATUS(EFIAPI * EFI_CPU_DISABLE_INTERRUPT) (IN EFI_CPU_ARCH_PROTOCOL *This)

This function disables interrupt processing by the processor.

Parameters
ThisThe EFI_CPU_ARCH_PROTOCOL instance.
Return values
EFI_SUCCESSInterrupts are disabled on the processor.
EFI_DEVICE_ERRORInterrupts could not be disabled on the processor.

Definition at line 118 of file Cpu.h.

◆ EFI_CPU_ENABLE_INTERRUPT

typedef EFI_STATUS(EFIAPI * EFI_CPU_ENABLE_INTERRUPT) (IN EFI_CPU_ARCH_PROTOCOL *This)

This function enables interrupt processing by the processor.

Parameters
ThisThe EFI_CPU_ARCH_PROTOCOL instance.
Return values
EFI_SUCCESSInterrupts are enabled on the processor.
EFI_DEVICE_ERRORInterrupts could not be enabled on the processor.

Definition at line 103 of file Cpu.h.

◆ EFI_CPU_FLUSH_DATA_CACHE

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.

Parameters
ThisThe EFI_CPU_ARCH_PROTOCOL instance.
StartThe beginning physical address to flush from the processor's data cache.
LengthThe 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.
FlushTypeSpecifies the type of flush operation to perform.
Return values
EFI_SUCCESSThe address range from Start to Start+Length was flushed from the processor's data cache.
EFI_UNSUPPORTEDThe processor does not support the cache flush type specified by FlushType.
EFI_DEVICE_ERRORThe address range from Start to Start+Length could not be flushed from the processor's data cache.

Definition at line 85 of file Cpu.h.

◆ EFI_CPU_GET_INTERRUPT_STATE

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.

Parameters
ThisThe EFI_CPU_ARCH_PROTOCOL instance.
StateA pointer to the processor's current interrupt state. Set to TRUE if interrupts are enabled and FALSE if interrupts are disabled.
Return values
EFI_SUCCESSThe processor's current interrupt state was returned in State.
EFI_INVALID_PARAMETERState is NULL.

Definition at line 137 of file Cpu.h.

◆ EFI_CPU_GET_TIMER_VALUE

typedef EFI_STATUS(EFIAPI * EFI_CPU_GET_TIMER_VALUE) (IN EFI_CPU_ARCH_PROTOCOL *This, IN UINT32 TimerIndex, OUT UINT64 *TimerValue, OUT UINT64 *TimerPeriod OPTIONAL)

This function reads the processor timer specified by TimerIndex and returns it in TimerValue.

Parameters
ThisThe EFI_CPU_ARCH_PROTOCOL instance.
TimerIndexSpecifies which processor timer is to be returned in TimerValue. This parameter must be between 0 and NumberOfTimers-1.
TimerValuePointer to the returned timer value.
TimerPeriodA 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.
Return values
EFI_SUCCESSThe processor timer value specified by TimerIndex was returned in TimerValue.
EFI_DEVICE_ERRORAn error occurred attempting to read one of the processor's timers.
EFI_INVALID_PARAMETERTimerValue is NULL or TimerIndex is not valid.
EFI_UNSUPPORTEDThe processor does not have any readable timers.

Definition at line 213 of file Cpu.h.

◆ EFI_CPU_INIT

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.

Parameters
ThisThe EFI_CPU_ARCH_PROTOCOL instance.
InitTypeThe type of processor INIT to perform.
Return values
EFI_SUCCESSThe processor INIT was performed. This return code should never be seen.
EFI_UNSUPPORTEDThe processor INIT operation specified by InitType is not supported by this processor.
EFI_DEVICE_ERRORThe processor INIT failed.

Definition at line 160 of file Cpu.h.

◆ EFI_CPU_INTERRUPT_HANDLER

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.

Parameters
InterruptTypeDefines the type of interrupt or exception that occurred on the processor.This parameter is processor architecture specific.
SystemContextA pointer to the processor context when the interrupt occurred on the processor.
Returns
None

Definition at line 51 of file Cpu.h.

◆ EFI_CPU_REGISTER_INTERRUPT_HANDLER

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.

Parameters
ThisThe EFI_CPU_ARCH_PROTOCOL instance.
InterruptTypeA pointer to the processor's current interrupt state. Set to TRUE if interrupts are enabled and FALSE if interrupts are disabled.
InterruptHandlerA 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.
Return values
EFI_SUCCESSThe handler for the processor interrupt was successfully installed or uninstalled.
EFI_ALREADY_STARTEDInterruptHandler is not NULL, and a handler for InterruptType was previously installed.
EFI_INVALID_PARAMETERInterruptHandler is NULL, and a handler for InterruptType was not previously installed.
EFI_UNSUPPORTEDThe interrupt specified by InterruptType is not supported.

Definition at line 188 of file Cpu.h.

◆ EFI_CPU_SET_MEMORY_ATTRIBUTES

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.

Parameters
ThisThe EFI_CPU_ARCH_PROTOCOL instance.
BaseAddressThe physical address that is the start address of a memory region.
LengthThe size in bytes of the memory region.
AttributesThe bit mask of attributes to set for the memory region.
Return values
EFI_SUCCESSThe attributes were set for the memory region.
EFI_ACCESS_DENIEDThe attributes for the memory resource range specified by BaseAddress and Length cannot be modified.
EFI_INVALID_PARAMETERLength is zero. Attributes specified an illegal combination of attributes that cannot be set together.
EFI_OUT_OF_RESOURCESThere are not enough system resources to modify the attributes of the memory resource range.
EFI_UNSUPPORTEDThe 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.

Definition at line 245 of file Cpu.h.

Enumeration Type Documentation

◆ EFI_CPU_FLUSH_TYPE

The type of flush operation

Definition at line 24 of file Cpu.h.

◆ EFI_CPU_INIT_TYPE

The type of processor INIT.

Definition at line 34 of file Cpu.h.