/**\r
EFI_CPU_INTERRUPT_HANDLER that is called when a processor interrupt occurs.\r
\r
- @param InterruptType Defines the type of interrupt or exception that \r
- occurred on the processor.This parameter is processor architecture specific.\r
- \r
- @param SystemContext A pointer to the processor context when \r
- the interrupt occurred on the processor.\r
+ @param InterruptType Defines the type of interrupt or exception that\r
+ occurred on the processor.This parameter is processor architecture specific.\r
+ @param SystemContext A pointer to the processor context when\r
+ the interrupt occurred on the processor.\r
\r
@return None\r
\r
this function can just return EFI_SUCCESS. If the processor does not support \r
flushing a range of the data cache, then the entire data cache can be flushed.\r
\r
- @param This The EFI_CPU_ARCH_PROTOCOL instance.\r
- @param Start The beginning physical address to flush from the processor's data\r
- cache.\r
- @param Length The number of bytes to flush from the processor's data cache. This\r
- function may flush more bytes than Length specifies depending upon\r
- the granularity of the flush operation that the processor supports.\r
- @param FlushType Specifies the type of flush operation to perform.\r
-\r
- @retval EFI_SUCCESS The address range from Start to Start+Length was flushed from\r
- the processor's data cache.\r
- @retval EFI_UNSUPPORTEDT The processor does not support the cache flush type specified\r
- by FlushType.\r
- @retval EFI_DEVICE_ERROR The address range from Start to Start+Length could not be flushed\r
- from the processor's data cache.\r
+ @param This The EFI_CPU_ARCH_PROTOCOL instance.\r
+ @param Start The beginning physical address to flush from the processor's data\r
+ cache.\r
+ @param Length The number of bytes to flush from the processor's data cache. This\r
+ function may flush more bytes than Length specifies depending upon\r
+ the granularity of the flush operation that the processor supports.\r
+ @param FlushType Specifies the type of flush operation to perform.\r
+\r
+ @retval EFI_SUCCESS The address range from Start to Start+Length was flushed from\r
+ the processor's data cache.\r
+ @retval EFI_UNSUPPORTEDT The processor does not support the cache flush type specified\r
+ by FlushType.\r
+ @retval EFI_DEVICE_ERROR The address range from Start to Start+Length could not be flushed\r
+ from the processor's data cache.\r
\r
**/\r
typedef\r
/**\r
This function enables interrupt processing by the processor. \r
\r
- @param This The EFI_CPU_ARCH_PROTOCOL instance.\r
+ @param This The EFI_CPU_ARCH_PROTOCOL instance.\r
\r
- @retval EFI_SUCCESS Interrupts are enabled on the processor.\r
- @retval EFI_DEVICE_ERROR Interrupts could not be enabled on the processor.\r
+ @retval EFI_SUCCESS Interrupts are enabled on the processor.\r
+ @retval EFI_DEVICE_ERROR Interrupts could not be enabled on the processor.\r
\r
**/\r
typedef\r
/**\r
This function disables interrupt processing by the processor.\r
\r
- @param This The EFI_CPU_ARCH_PROTOCOL instance.\r
+ @param This The EFI_CPU_ARCH_PROTOCOL instance.\r
\r
- @retval EFI_SUCCESS Interrupts are disabled on the processor.\r
- @retval EFI_DEVICE_ERROR Interrupts could not be disabled on the processor.\r
+ @retval EFI_SUCCESS Interrupts are disabled on the processor.\r
+ @retval EFI_DEVICE_ERROR Interrupts could not be disabled on the processor.\r
\r
**/\r
typedef\r
State. If interrupts are currently enabled, then TRUE is returned. If interrupts \r
are currently disabled, then FALSE is returned.\r
\r
- @param This The EFI_CPU_ARCH_PROTOCOL instance.\r
- @param State A pointer to the processor's current interrupt state. Set to TRUE if\r
- interrupts are enabled and FALSE if interrupts are disabled.\r
+ @param This The EFI_CPU_ARCH_PROTOCOL instance.\r
+ @param State A pointer to the processor's current interrupt state. Set to TRUE if\r
+ interrupts are enabled and FALSE if interrupts are disabled.\r
\r
- @retval EFI_SUCCESS The processor's current interrupt state was returned in State.\r
- @retval EFI_INVALID_PARAMETER State is NULL.\r
+ @retval EFI_SUCCESS The processor's current interrupt state was returned in State.\r
+ @retval EFI_INVALID_PARAMETER State is NULL.\r
\r
**/\r
typedef\r
INIT without help from external hardware, then EFI_UNSUPPORTED is returned. If an error \r
occurs attempting to generate an INIT, then EFI_DEVICE_ERROR is returned.\r
\r
- @param This The EFI_CPU_ARCH_PROTOCOL instance.\r
- @param InitType The type of processor INIT to perform.\r
+ @param This The EFI_CPU_ARCH_PROTOCOL instance.\r
+ @param InitType The type of processor INIT to perform.\r
\r
- @retval EFI_SUCCESS The processor INIT was performed. This return code should never be seen.\r
- @retval EFI_UNSUPPORTED The processor INIT operation specified by InitType is not supported\r
- by this processor.\r
- @retval EFI_DEVICE_ERROR The processor INIT failed.\r
+ @retval EFI_SUCCESS The processor INIT was performed. This return code should never be seen.\r
+ @retval EFI_UNSUPPORTED The processor INIT operation specified by InitType is not supported\r
+ by this processor.\r
+ @retval EFI_DEVICE_ERROR The processor INIT failed.\r
\r
**/\r
typedef\r
handler for the processor interrupt or exception type specified by InterruptType is uninstalled. \r
The installed handler is called once for each processor interrupt or exception.\r
\r
- @param This The EFI_CPU_ARCH_PROTOCOL instance.\r
- @param InterruptType A pointer to the processor's current interrupt state. Set to TRUE if interrupts\r
- are enabled and FALSE if interrupts are disabled.\r
+ @param This The EFI_CPU_ARCH_PROTOCOL instance.\r
+ @param InterruptType A pointer to the processor's current interrupt state. Set to TRUE if interrupts\r
+ are enabled and FALSE if interrupts are disabled.\r
@param InterruptHandler A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER that is called\r
- when a processor interrupt occurs. If this parameter is NULL, then the handler\r
- will be uninstalled.\r
+ when a processor interrupt occurs. If this parameter is NULL, then the handler\r
+ will be uninstalled.\r
\r
- @retval EFI_SUCCESS The handler for the processor interrupt was successfully installed or uninstalled.\r
- @retval EFI_ALREADY_STARTED InterruptHandler is not NULL, and a handler for InterruptType was\r
- previously installed.\r
- @retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not\r
- previously installed.\r
- @retval EFI_UNSUPPORTED The interrupt specified by InterruptType is not supported.\r
+ @retval EFI_SUCCESS The handler for the processor interrupt was successfully installed or uninstalled.\r
+ @retval EFI_ALREADY_STARTED InterruptHandler is not NULL, and a handler for InterruptType was\r
+ previously installed.\r
+ @retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not\r
+ previously installed.\r
+ @retval EFI_UNSUPPORTED The interrupt specified by InterruptType is not supported.\r
\r
**/\r
typedef\r
/**\r
This function reads the processor timer specified by TimerIndex and returns it in TimerValue.\r
\r
- @param This The EFI_CPU_ARCH_PROTOCOL instance.\r
- @param TimerIndex Specifies which processor timer is to be returned in TimerValue. This parameter\r
- must be between 0 and NumberOfTimers-1.\r
- @param TimerValue Pointer to the returned timer value.\r
- @param TimerPeriod A pointer to the amount of time that passes in femtoseconds for each increment\r
- of TimerValue.\r
+ @param This The EFI_CPU_ARCH_PROTOCOL instance.\r
+ @param TimerIndex Specifies which processor timer is to be returned in TimerValue. This parameter\r
+ must be between 0 and NumberOfTimers-1.\r
+ @param TimerValue Pointer to the returned timer value.\r
+ @param TimerPeriod A pointer to the amount of time that passes in femtoseconds for each increment\r
+ of TimerValue.\r
\r
- @retval EFI_SUCCESS The processor timer value specified by TimerIndex was returned in TimerValue.\r
- @retval EFI_DEVICE_ERROR An error occurred attempting to read one of the processor's timers.\r
- @retval EFI_INVALID_PARAMETER TimerValue is NULL or TimerIndex is not valid.\r
- @retval EFI_UNSUPPORTED The processor does not have any readable timers.\r
+ @retval EFI_SUCCESS The processor timer value specified by TimerIndex was returned in TimerValue.\r
+ @retval EFI_DEVICE_ERROR An error occurred attempting to read one of the processor's timers.\r
+ @retval EFI_INVALID_PARAMETER TimerValue is NULL or TimerIndex is not valid.\r
+ @retval EFI_UNSUPPORTED The processor does not have any readable timers.\r
\r
**/\r
typedef\r
This function modifies the attributes for the memory region specified by BaseAddress and\r
Length from their current attributes to the attributes specified by Attributes.\r
\r
- @param This The EFI_CPU_ARCH_PROTOCOL instance.\r
- @param BaseAddress The physical address that is the start address of a memory region.\r
- @param Length The size in bytes of the memory region.\r
- @param Attributes The bit mask of attributes to set for the memory region.\r
-\r
- @retval EFI_SUCCESS The attributes were set for the memory region.\r
- @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by\r
- BaseAddress and Length cannot be modified.\r
- @retval EFI_INVALID_PARAMETER Length is zero.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of\r
- the memory resource range.\r
- @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory\r
- resource range specified by BaseAddress and Length.\r
- The bit mask of attributes is not support for the memory resource\r
- range specified by BaseAddress and Length.\r
+ @param This The EFI_CPU_ARCH_PROTOCOL instance.\r
+ @param BaseAddress The physical address that is the start address of a memory region.\r
+ @param Length The size in bytes of the memory region.\r
+ @param Attributes The bit mask of attributes to set for the memory region.\r
+\r
+ @retval EFI_SUCCESS The attributes were set for the memory region.\r
+ @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by\r
+ BaseAddress and Length cannot be modified.\r
+ @retval EFI_INVALID_PARAMETER Length is zero.\r
+ @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of\r
+ the memory resource range.\r
+ @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory\r
+ resource range specified by BaseAddress and Length.\r
+ The bit mask of attributes is not support for the memory resource\r
+ range specified by BaseAddress and Length.\r
\r
**/\r
typedef\r
flushing a range of addresses from the data cache, then the entire data \r
cache must be flushed. \r
\r
- @param EnableInterrupt Enables interrupt processing by the processor. \r
+ @param EnableInterrupt \r
+ Enables interrupt processing by the processor.\r
\r
- @param DisableInterrupt Disables interrupt processing by the processor.\r
+ @param DisableInterrupt \r
+ Disables interrupt processing by the processor.\r
\r
- @param GetInterruptState Retrieves the processor's current interrupt state.\r
+ @param GetInterruptState \r
+ Retrieves the processor's current interrupt state.\r
\r
@param Init\r
Generates an INIT on the processor. If a processor cannot programmatically \r
hook the timer interrupt in a system. It can also be used by the debugger to \r
hook exception vectors.\r
\r
- @param GetTimerValue Returns the value of one of the processor's internal timers.\r
+ @param GetTimerValue \r
+ Returns the value of one of the processor's internal timers.\r
\r
- @param SetMemoryAttributes Attempts to set the attributes of a memory region.\r
+ @param SetMemoryAttributes \r
+ Attempts to set the attributes of a memory region.\r
\r
@param NumberOfTimers\r
The number of timers that are available in a processor. The value in this \r
projects / mirror_edk2.git / blobdiff