diff options
author | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2006-07-20 09:08:37 +0000 |
---|---|---|
committer | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2006-07-20 09:08:37 +0000 |
commit | 0647c9adf92c6a8712091607a73b2768327a865d (patch) | |
tree | 41c00f087dea23a35388100f5b9895753555ac3c /MdePkg/Include/Dxe | |
parent | 151c1ccdcd6960c550fa491bd0ed467416bb2b74 (diff) | |
download | edk2-0647c9adf92c6a8712091607a73b2768327a865d.zip edk2-0647c9adf92c6a8712091607a73b2768327a865d.tar.gz edk2-0647c9adf92c6a8712091607a73b2768327a865d.tar.bz2 |
Remove BugBug in comments and adjust function header according to code style doc.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@1055 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Dxe')
-rw-r--r-- | MdePkg/Include/Dxe/ArchProtocol/Bds.h | 2 | ||||
-rw-r--r-- | MdePkg/Include/Dxe/ArchProtocol/Cpu.h | 158 | ||||
-rw-r--r-- | MdePkg/Include/Dxe/ArchProtocol/Metronome.h | 14 | ||||
-rw-r--r-- | MdePkg/Include/Dxe/ArchProtocol/Runtime.h | 56 | ||||
-rw-r--r-- | MdePkg/Include/Dxe/ArchProtocol/Security.h | 42 | ||||
-rw-r--r-- | MdePkg/Include/Dxe/ArchProtocol/StatusCode.h | 33 | ||||
-rw-r--r-- | MdePkg/Include/Dxe/ArchProtocol/Timer.h | 85 | ||||
-rw-r--r-- | MdePkg/Include/Dxe/ArchProtocol/WatchdogTimer.h | 77 | ||||
-rw-r--r-- | MdePkg/Include/Dxe/DxeCis.h | 173 | ||||
-rw-r--r-- | MdePkg/Include/Dxe/SmmCis.h | 125 |
10 files changed, 334 insertions, 431 deletions
diff --git a/MdePkg/Include/Dxe/ArchProtocol/Bds.h b/MdePkg/Include/Dxe/ArchProtocol/Bds.h index f6b72d2..d060eb9 100644 --- a/MdePkg/Include/Dxe/ArchProtocol/Bds.h +++ b/MdePkg/Include/Dxe/ArchProtocol/Bds.h @@ -49,7 +49,7 @@ typedef struct _EFI_BDS_ARCH_PROTOCOL EFI_BDS_ARCH_PROTOCOL; device connection operation fails twice in a row, then that boot device has
failed, and should be skipped. This function should never return.
- @param This The EFI_BDS_ARCH_PROTOCOL instance.
+ @param This The EFI_BDS_ARCH_PROTOCOL instance.
@return None.
diff --git a/MdePkg/Include/Dxe/ArchProtocol/Cpu.h b/MdePkg/Include/Dxe/ArchProtocol/Cpu.h index 975a816..ac1b43b 100644 --- a/MdePkg/Include/Dxe/ArchProtocol/Cpu.h +++ b/MdePkg/Include/Dxe/ArchProtocol/Cpu.h @@ -43,11 +43,10 @@ typedef enum { /**
EFI_CPU_INTERRUPT_HANDLER that is called when a processor interrupt occurs.
- @param InterruptType Defines the type of interrupt or exception that
- occurred on the processor.This parameter is processor architecture specific.
-
- @param SystemContext A pointer to the processor context when
- the interrupt occurred on the processor.
+ @param InterruptType Defines the type of interrupt or exception that
+ occurred on the processor.This parameter is processor architecture specific.
+ @param SystemContext A pointer to the processor context when
+ the interrupt occurred on the processor.
@return None
@@ -70,20 +69,20 @@ VOID 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.
- @param This The EFI_CPU_ARCH_PROTOCOL instance.
- @param Start The beginning physical address to flush from the processor's data
- cache.
- @param 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.
- @param FlushType Specifies the type of flush operation to perform.
-
- @retval EFI_SUCCESS The address range from Start to Start+Length was flushed from
- the processor's data cache.
- @retval EFI_UNSUPPORTEDT The processor does not support the cache flush type specified
- by FlushType.
- @retval EFI_DEVICE_ERROR The address range from Start to Start+Length could not be flushed
- from the processor's data cache.
+ @param This The EFI_CPU_ARCH_PROTOCOL instance.
+ @param Start The beginning physical address to flush from the processor's data
+ cache.
+ @param 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.
+ @param FlushType Specifies the type of flush operation to perform.
+
+ @retval EFI_SUCCESS The address range from Start to Start+Length was flushed from
+ the processor's data cache.
+ @retval EFI_UNSUPPORTEDT The processor does not support the cache flush type specified
+ by FlushType.
+ @retval EFI_DEVICE_ERROR The address range from Start to Start+Length could not be flushed
+ from the processor's data cache.
**/
typedef
@@ -99,10 +98,10 @@ EFI_STATUS /**
This function enables interrupt processing by the processor.
- @param This The EFI_CPU_ARCH_PROTOCOL instance.
+ @param This The EFI_CPU_ARCH_PROTOCOL instance.
- @retval EFI_SUCCESS Interrupts are enabled on the processor.
- @retval EFI_DEVICE_ERROR Interrupts could not be enabled on the processor.
+ @retval EFI_SUCCESS Interrupts are enabled on the processor.
+ @retval EFI_DEVICE_ERROR Interrupts could not be enabled on the processor.
**/
typedef
@@ -115,10 +114,10 @@ EFI_STATUS /**
This function disables interrupt processing by the processor.
- @param This The EFI_CPU_ARCH_PROTOCOL instance.
+ @param This The EFI_CPU_ARCH_PROTOCOL instance.
- @retval EFI_SUCCESS Interrupts are disabled on the processor.
- @retval EFI_DEVICE_ERROR Interrupts could not be disabled on the processor.
+ @retval EFI_SUCCESS Interrupts are disabled on the processor.
+ @retval EFI_DEVICE_ERROR Interrupts could not be disabled on the processor.
**/
typedef
@@ -133,12 +132,12 @@ EFI_STATUS State. If interrupts are currently enabled, then TRUE is returned. If interrupts
are currently disabled, then FALSE is returned.
- @param This The EFI_CPU_ARCH_PROTOCOL instance.
- @param State A pointer to the processor's current interrupt state. Set to TRUE if
- interrupts are enabled and FALSE if interrupts are disabled.
+ @param This The EFI_CPU_ARCH_PROTOCOL instance.
+ @param State A pointer to the processor's current interrupt state. Set to TRUE if
+ interrupts are enabled and FALSE if interrupts are disabled.
- @retval EFI_SUCCESS The processor's current interrupt state was returned in State.
- @retval EFI_INVALID_PARAMETER State is NULL.
+ @retval EFI_SUCCESS The processor's current interrupt state was returned in State.
+ @retval EFI_INVALID_PARAMETER State is NULL.
**/
typedef
@@ -156,13 +155,13 @@ EFI_STATUS 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.
- @param This The EFI_CPU_ARCH_PROTOCOL instance.
- @param InitType The type of processor INIT to perform.
+ @param This The EFI_CPU_ARCH_PROTOCOL instance.
+ @param InitType The type of processor INIT to perform.
- @retval EFI_SUCCESS The processor INIT was performed. This return code should never be seen.
- @retval EFI_UNSUPPORTED The processor INIT operation specified by InitType is not supported
- by this processor.
- @retval EFI_DEVICE_ERROR The processor INIT failed.
+ @retval EFI_SUCCESS The processor INIT was performed. This return code should never be seen.
+ @retval EFI_UNSUPPORTED The processor INIT operation specified by InitType is not supported
+ by this processor.
+ @retval EFI_DEVICE_ERROR The processor INIT failed.
**/
typedef
@@ -179,19 +178,19 @@ EFI_STATUS 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.
- @param This The EFI_CPU_ARCH_PROTOCOL instance.
- @param InterruptType A pointer to the processor's current interrupt state. Set to TRUE if interrupts
- are enabled and FALSE if interrupts are disabled.
+ @param This The EFI_CPU_ARCH_PROTOCOL instance.
+ @param InterruptType A pointer to the processor's current interrupt state. Set to TRUE if interrupts
+ are enabled and FALSE if interrupts are disabled.
@param 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.
+ when a processor interrupt occurs. If this parameter is NULL, then the handler
+ will be uninstalled.
- @retval EFI_SUCCESS The handler for the processor interrupt was successfully installed or uninstalled.
- @retval EFI_ALREADY_STARTED InterruptHandler is not NULL, and a handler for InterruptType was
- previously installed.
- @retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not
- previously installed.
- @retval EFI_UNSUPPORTED The interrupt specified by InterruptType is not supported.
+ @retval EFI_SUCCESS The handler for the processor interrupt was successfully installed or uninstalled.
+ @retval EFI_ALREADY_STARTED InterruptHandler is not NULL, and a handler for InterruptType was
+ previously installed.
+ @retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not
+ previously installed.
+ @retval EFI_UNSUPPORTED The interrupt specified by InterruptType is not supported.
**/
typedef
@@ -206,17 +205,17 @@ EFI_STATUS /**
This function reads the processor timer specified by TimerIndex and returns it in TimerValue.
- @param This The EFI_CPU_ARCH_PROTOCOL instance.
- @param TimerIndex Specifies which processor timer is to be returned in TimerValue. This parameter
- must be between 0 and NumberOfTimers-1.
- @param TimerValue Pointer to the returned timer value.
- @param TimerPeriod A pointer to the amount of time that passes in femtoseconds for each increment
- of TimerValue.
+ @param This The EFI_CPU_ARCH_PROTOCOL instance.
+ @param TimerIndex Specifies which processor timer is to be returned in TimerValue. This parameter
+ must be between 0 and NumberOfTimers-1.
+ @param TimerValue Pointer to the returned timer value.
+ @param TimerPeriod A pointer to the amount of time that passes in femtoseconds for each increment
+ of TimerValue.
- @retval EFI_SUCCESS The processor timer value specified by TimerIndex was returned in TimerValue.
- @retval EFI_DEVICE_ERROR An error occurred attempting to read one of the processor's timers.
- @retval EFI_INVALID_PARAMETER TimerValue is NULL or TimerIndex is not valid.
- @retval EFI_UNSUPPORTED The processor does not have any readable timers.
+ @retval EFI_SUCCESS The processor timer value specified by TimerIndex was returned in TimerValue.
+ @retval EFI_DEVICE_ERROR An error occurred attempting to read one of the processor's timers.
+ @retval EFI_INVALID_PARAMETER TimerValue is NULL or TimerIndex is not valid.
+ @retval EFI_UNSUPPORTED The processor does not have any readable timers.
**/
typedef
@@ -233,21 +232,21 @@ EFI_STATUS This function modifies the attributes for the memory region specified by BaseAddress and
Length from their current attributes to the attributes specified by Attributes.
- @param This The EFI_CPU_ARCH_PROTOCOL instance.
- @param BaseAddress The physical address that is the start address of a memory region.
- @param Length The size in bytes of the memory region.
- @param Attributes The bit mask of attributes to set for the memory region.
-
- @retval EFI_SUCCESS The attributes were set for the memory region.
- @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
- BaseAddress and Length cannot be modified.
- @retval EFI_INVALID_PARAMETER Length is zero.
- @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
- the memory resource range.
- @retval 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.
+ @param This The EFI_CPU_ARCH_PROTOCOL instance.
+ @param BaseAddress The physical address that is the start address of a memory region.
+ @param Length The size in bytes of the memory region.
+ @param Attributes The bit mask of attributes to set for the memory region.
+
+ @retval EFI_SUCCESS The attributes were set for the memory region.
+ @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
+ BaseAddress and Length cannot be modified.
+ @retval EFI_INVALID_PARAMETER Length is zero.
+ @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
+ the memory resource range.
+ @retval 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.
**/
typedef
@@ -274,11 +273,14 @@ EFI_STATUS flushing a range of addresses from the data cache, then the entire data
cache must be flushed.
- @param EnableInterrupt Enables interrupt processing by the processor.
+ @param EnableInterrupt
+ Enables interrupt processing by the processor.
- @param DisableInterrupt Disables interrupt processing by the processor.
+ @param DisableInterrupt
+ Disables interrupt processing by the processor.
- @param GetInterruptState Retrieves the processor's current interrupt state.
+ @param GetInterruptState
+ Retrieves the processor's current interrupt state.
@param Init
Generates an INIT on the processor. If a processor cannot programmatically
@@ -291,9 +293,11 @@ EFI_STATUS hook the timer interrupt in a system. It can also be used by the debugger to
hook exception vectors.
- @param GetTimerValue Returns the value of one of the processor's internal timers.
+ @param GetTimerValue
+ Returns the value of one of the processor's internal timers.
- @param SetMemoryAttributes Attempts to set the attributes of a memory region.
+ @param SetMemoryAttributes
+ Attempts to set the attributes of a memory region.
@param NumberOfTimers
The number of timers that are available in a processor. The value in this
diff --git a/MdePkg/Include/Dxe/ArchProtocol/Metronome.h b/MdePkg/Include/Dxe/ArchProtocol/Metronome.h index a07003e..c4a1f71 100644 --- a/MdePkg/Include/Dxe/ArchProtocol/Metronome.h +++ b/MdePkg/Include/Dxe/ArchProtocol/Metronome.h @@ -47,14 +47,12 @@ typedef struct _EFI_METRONOME_ARCH_PROTOCOL EFI_METRONOME_ARCH_PROTOCOL; ticks will not be missed. If a timeout occurs waiting for the specified
number of ticks, then EFI_TIMEOUT is returned.
- @param This The EFI_METRONOME_ARCH_PROTOCOL instance.
-
- @param TickNumber Number of ticks to wait.
-
- @retval EFI_SUCCESS The wait for the number of ticks specified by TickNumber
- succeeded.
-
- @retval EFI_TIMEOUT A timeout occurred waiting for the specified number of ticks.
+ @param This The EFI_METRONOME_ARCH_PROTOCOL instance.
+ @param TickNumber Number of ticks to wait.
+
+ @retval EFI_SUCCESS The wait for the number of ticks specified by TickNumber
+ succeeded.
+ @retval EFI_TIMEOUT A timeout occurred waiting for the specified number of ticks.
**/
typedef
diff --git a/MdePkg/Include/Dxe/ArchProtocol/Runtime.h b/MdePkg/Include/Dxe/ArchProtocol/Runtime.h index bbd4c1a..feb2d8f 100644 --- a/MdePkg/Include/Dxe/ArchProtocol/Runtime.h +++ b/MdePkg/Include/Dxe/ArchProtocol/Runtime.h @@ -50,23 +50,19 @@ typedef struct _EFI_RUNTIME_ARCH_PROTOCOL EFI_RUNTIME_ARCH_PROTOCOL; loaded into memory with the Boot Service LoadImage(). As a result, no
parameter checking needs to be performed.
- @param This The EFI_RUNTIME_ARCH_PROTOCOL instance.
-
- @param ImageBase Start of image that has been loaded in memory. It is either
- a pointer to the DOS or PE header of the image.
-
- @param ImageSize Size of the image in bytes.
-
- @param RelocationData Information about the fixups that were performed on ImageBase
- when it was loaded into memory. This information is needed
- when the virtual mode fix-ups are reapplied so that data that
- has been programmatically updated will not be fixed up. If
- code updates a global variable the code is responsible for
- fixing up the variable for virtual mode.
-
- @retval EFI_SUCCESS The ImageBase has been registered.
-
- @retval EFI_OUT_OF_RESOURCES There are not enough resources to register ImageBase.
+ @param This The EFI_RUNTIME_ARCH_PROTOCOL instance.
+ @param ImageBase Start of image that has been loaded in memory. It is either
+ a pointer to the DOS or PE header of the image.
+ @param ImageSize Size of the image in bytes.
+ @param RelocationData Information about the fixups that were performed on ImageBase
+ when it was loaded into memory. This information is needed
+ when the virtual mode fix-ups are reapplied so that data that
+ has been programmatically updated will not be fixed up. If
+ code updates a global variable the code is responsible for
+ fixing up the variable for virtual mode.
+
+ @retval EFI_SUCCESS The ImageBase has been registered.
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources to register ImageBase.
**/
typedef
@@ -88,22 +84,16 @@ EFI_STATUS with the Boot Service CreateEvent(). As a result, no parameter checking needs
to be performed.
- @param This The EFI_RUNTIME_ARCH_PROTOCOL instance.
-
- @param Type The same as Type passed into CreateEvent().
-
- @param NotifyTpl The same as NotifyTpl passed into CreateEvent().
-
- @param NotifyFunction The same as NotifyFunction passed into CreateEvent().
-
- @param NotifyContext The same as NotifyContext passed into CreateEvent().
-
- @param Event The EFI_EVENT returned by CreateEvent(). Event must be in
- runtime memory.
-
- @retval EFI_SUCCESS The Event has been registered.
-
- @retval EFI_OUT_OF_RESOURCES There are not enough resources to register Event.
+ @param This The EFI_RUNTIME_ARCH_PROTOCOL instance.
+ @param Type The same as Type passed into CreateEvent().
+ @param NotifyTpl The same as NotifyTpl passed into CreateEvent().
+ @param NotifyFunction The same as NotifyFunction passed into CreateEvent().
+ @param NotifyContext The same as NotifyContext passed into CreateEvent().
+ @param Event The EFI_EVENT returned by CreateEvent(). Event must be in
+ runtime memory.
+
+ @retval EFI_SUCCESS The Event has been registered.
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources to register Event.
**/
typedef
diff --git a/MdePkg/Include/Dxe/ArchProtocol/Security.h b/MdePkg/Include/Dxe/ArchProtocol/Security.h index 3598199..ec981b4 100644 --- a/MdePkg/Include/Dxe/ArchProtocol/Security.h +++ b/MdePkg/Include/Dxe/ArchProtocol/Security.h @@ -65,29 +65,25 @@ typedef struct _EFI_SECURITY_ARCH_PROTOCOL EFI_SECURITY_ARCH_PROTOCOL; might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is
returned.
- @param This The EFI_SECURITY_ARCH_PROTOCOL instance.
-
- @param AuthenticationStatus This is the authentication type returned from the Section
- Extraction protocol. See the Section Extraction Protocol
- Specification for details on this type.
-
- @param File This is a pointer to the device path of the file that is
- being dispatched. This will optionally be used for logging.
-
- @retval EFI_SUCCESS The file specified by File did authenticate, and the
- platform policy dictates that the DXE Core may use File.
-
- @retval EFI_INVALID_PARAMETER Driver is NULL.
-
- @retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and
- the platform policy dictates that File should be placed
- in the untrusted state. A file may be promoted from
- the untrusted to the trusted state at a future time
- with a call to the Trust() DXE Service.
-
- @retval EFI_ACCESS_DENIED The file specified by File did not authenticate, and
- the platform policy dictates that File should not be
- used for any purpose.
+ @param This The EFI_SECURITY_ARCH_PROTOCOL instance.
+ @param AuthenticationStatus
+ This is the authentication type returned from the Section
+ Extraction protocol. See the Section Extraction Protocol
+ Specification for details on this type.
+ @param File This is a pointer to the device path of the file that is
+ being dispatched. This will optionally be used for logging.
+
+ @retval EFI_SUCCESS The file specified by File did authenticate, and the
+ platform policy dictates that the DXE Core may use File.
+ @retval EFI_INVALID_PARAMETER Driver is NULL.
+ @retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and
+ the platform policy dictates that File should be placed
+ in the untrusted state. A file may be promoted from
+ the untrusted to the trusted state at a future time
+ with a call to the Trust() DXE Service.
+ @retval EFI_ACCESS_DENIED The file specified by File did not authenticate, and
+ the platform policy dictates that File should not be
+ used for any purpose.
**/
typedef
diff --git a/MdePkg/Include/Dxe/ArchProtocol/StatusCode.h b/MdePkg/Include/Dxe/ArchProtocol/StatusCode.h index 6440dc3..6bfaeae 100644 --- a/MdePkg/Include/Dxe/ArchProtocol/StatusCode.h +++ b/MdePkg/Include/Dxe/ArchProtocol/StatusCode.h @@ -34,24 +34,19 @@ /**
Provides an interface that a software module can call to report a status code.
- @param Type Indicates the type of status code being reported.
-
- @param Value Describes the current status of a hardware or software entity.
- This included information about the class and subclass that is used to
- classify the entity as well as an operation.
-
- @param Instance The enumeration of a hardware or software entity within
- the system. Valid instance numbers start with 1.
-
- @param CallerId This optional parameter may be used to identify the caller.
- This parameter allows the status code driver to apply different rules to
- different callers.
-
- @param Data This optional parameter may be used to pass additional data.
-
- @retval EFI_SUCCESS The function completed successfully
-
- @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.
+ @param Type Indicates the type of status code being reported.
+ @param Value Describes the current status of a hardware or software entity.
+ This included information about the class and subclass that is used to
+ classify the entity as well as an operation.
+ @param Instance The enumeration of a hardware or software entity within
+ the system. Valid instance numbers start with 1.
+ @param CallerId This optional parameter may be used to identify the caller.
+ This parameter allows the status code driver to apply different rules to
+ different callers.
+ @param Data This optional parameter may be used to pass additional data.
+
+ @retval EFI_SUCCESS The function completed successfully
+ @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.
**/
typedef
@@ -70,7 +65,7 @@ EFI_STATUS This protocol must be produced by a runtime DXE driver and may be consumed
only by the DXE Foundation.
- @param ReportStatusCode Emit a status code.
+ @param ReportStatusCode Emit a status code.
**/
typedef struct _EFI_STATUS_CODE_PROTOCOL {
diff --git a/MdePkg/Include/Dxe/ArchProtocol/Timer.h b/MdePkg/Include/Dxe/ArchProtocol/Timer.h index 330f4cf..302ae14 100644 --- a/MdePkg/Include/Dxe/ArchProtocol/Timer.h +++ b/MdePkg/Include/Dxe/ArchProtocol/Timer.h @@ -39,10 +39,10 @@ typedef struct _EFI_TIMER_ARCH_PROTOCOL EFI_TIMER_ARCH_PROTOCOL; of tyis type to be called for the timer interrupt, so it can know how much
time has passed. This information is used to signal timer based events.
- @param Time Time since the last timer interrupt in 100 ns units. This will
- typically be TimerPeriod, but if a timer interrupt is missed, and the
- EFI_TIMER_ARCH_PROTOCOL driver can detect missed interrupts, then Time
- will contain the actual amount of time since the last interrupt.
+ @param Time Time since the last timer interrupt in 100 ns units. This will
+ typically be TimerPeriod, but if a timer interrupt is missed, and the
+ EFI_TIMER_ARCH_PROTOCOL driver can detect missed interrupts, then Time
+ will contain the actual amount of time since the last interrupt.
None.
@@ -66,25 +66,20 @@ VOID register the NotifyFunction with the timer interrupt, then EFI_DEVICE_ERROR
is returned.
- @param This The EFI_TIMER_ARCH_PROTOCOL instance.
-
- @param NotifyFunction The function to call when a timer interrupt fires. This
- function executes at TPL_HIGH_LEVEL. The DXE Core will
- register a handler for the timer interrupt, so it can know
- how much time has passed. This information is used to
- signal timer based events. NULL will unregister the handler.
-
- @retval EFI_SUCCESS The timer handler was registered.
-
- @retval EFI_UNSUPPORTED The platform does not support timer interrupts.
-
- @retval EFI_ALREADY_STARTED NotifyFunction is not NULL, and a handler is already
- registered.
-
- @retval EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not
- previously registered.
-
- @retval EFI_DEVICE_ERROR The timer handler could not be registered.
+ @param This The EFI_TIMER_ARCH_PROTOCOL instance.
+ @param NotifyFunction The function to call when a timer interrupt fires. This
+ function executes at TPL_HIGH_LEVEL. The DXE Core will
+ register a handler for the timer interrupt, so it can know
+ how much time has passed. This information is used to
+ signal timer based events. NULL will unregister the handler.
+
+ @retval EFI_SUCCESS The timer handler was registered.
+ @retval EFI_UNSUPPORTED The platform does not support timer interrupts.
+ @retval EFI_ALREADY_STARTED NotifyFunction is not NULL, and a handler is already
+ registered.
+ @retval EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not
+ previously registered.
+ @retval EFI_DEVICE_ERROR The timer handler could not be registered.
**/
typedef
@@ -107,20 +102,17 @@ EFI_STATUS interrupt controller so that a CPU interrupt is not generated when the timer
interrupt fires.
- @param This The EFI_TIMER_ARCH_PROTOCOL instance.
-
- @param TimerPeriod The rate to program the timer interrupt in 100 nS units. If
- the timer hardware is not programmable, then EFI_UNSUPPORTED is
- returned. If the timer is programmable, then the timer period
- will be rounded up to the nearest timer period that is supported
- by the timer hardware. If TimerPeriod is set to 0, then the
- timer interrupts will be disabled.
-
- @retval EFI_SUCCESS The timer period was changed.
-
- @retval EFI_UNSUPPORTED The platform cannot change the period of the timer interrupt.
-
- @retval EFI_DEVICE_ERROR The timer period could not be changed due to a device error.
+ @param This The EFI_TIMER_ARCH_PROTOCOL instance.
+ @param TimerPeriod The rate to program the timer interrupt in 100 nS units. If
+ the timer hardware is not programmable, then EFI_UNSUPPORTED is
+ returned. If the timer is programmable, then the timer period
+ will be rounded up to the nearest timer period that is supported
+ by the timer hardware. If TimerPeriod is set to 0, then the
+ timer interrupts will be disabled.
+
+ @retval EFI_SUCCESS The timer period was changed.
+ @retval EFI_UNSUPPORTED The platform cannot change the period of the timer interrupt.
+ @retval EFI_DEVICE_ERROR The timer period could not be changed due to a device error.
**/
typedef
@@ -136,14 +128,12 @@ EFI_STATUS is NULL, then EFI_INVALID_PARAMETER is returned. If a TimerPeriod of 0 is
returned, then the timer is currently disabled.
- @param This The EFI_TIMER_ARCH_PROTOCOL instance.
-
- @param TimerPeriod A pointer to the timer period to retrieve in 100 ns units. If
- 0 is returned, then the timer is currently disabled.
+ @param This The EFI_TIMER_ARCH_PROTOCOL instance.
+ @param TimerPeriod A pointer to the timer period to retrieve in 100 ns units. If
+ 0 is returned, then the timer is currently disabled.
- @retval EFI_SUCCESS The timer period was returned in TimerPeriod.
-
- @retval EFI_INVALID_PARAMETER TimerPeriod is NULL.
+ @retval EFI_SUCCESS The timer period was returned in TimerPeriod.
+ @retval EFI_INVALID_PARAMETER TimerPeriod is NULL.
**/
typedef
@@ -162,11 +152,10 @@ EFI_STATUS registered handler should not be able to distinguish a hardware-generated timer
interrupt from a software-generated timer interrupt.
- @param This The EFI_TIMER_ARCH_PROTOCOL instance.
+ @param This The EFI_TIMER_ARCH_PROTOCOL instance.
- @retval EFI_SUCCESS The soft timer interrupt was generated.
-
- @retval EFI_UNSUPPORTEDT The platform does not support the generation of soft timer interrupts.
+ @retval EFI_SUCCESS The soft timer interrupt was generated.
+ @retval EFI_UNSUPPORTEDT The platform does not support the generation of soft timer interrupts.
**/
typedef
diff --git a/MdePkg/Include/Dxe/ArchProtocol/WatchdogTimer.h b/MdePkg/Include/Dxe/ArchProtocol/WatchdogTimer.h index a8d84b1..8e31a36 100644 --- a/MdePkg/Include/Dxe/ArchProtocol/WatchdogTimer.h +++ b/MdePkg/Include/Dxe/ArchProtocol/WatchdogTimer.h @@ -37,9 +37,9 @@ typedef struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL EFI_WATCHDOG_TIMER_ARCH_PROTOC A function of this type is called when the watchdog timer fires if a
handler has been registered.
- @param Time The time in 100 ns units that has passed since the watchdog
- timer was armed. For the notify function to be called, this
- must be greater than TimerPeriod.
+ @param Time The time in 100 ns units that has passed since the watchdog
+ timer was armed. For the notify function to be called, this
+ must be greater than TimerPeriod.
@return None.
@@ -62,19 +62,16 @@ VOID If an attempt is made to uninstall a handler when a handler is not installed,
then return EFI_INVALID_PARAMETER.
- @param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.
-
- @param NotifyFunction The function to call when the watchdog timer fires. If this
- is NULL, then the handler will be unregistered.
+ @param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.
+ @param NotifyFunction The function to call when the watchdog timer fires. If this
+ is NULL, then the handler will be unregistered.
- @retval EFI_SUCCESS The watchdog timer handler was registered or
- unregistered.
-
- @retval EFI_ALREADY_STARTED NotifyFunction is not NULL, and a handler is already
- registered.
-
- @retval EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not
- previously registered.
+ @retval EFI_SUCCESS The watchdog timer handler was registered or
+ unregistered.
+ @retval EFI_ALREADY_STARTED NotifyFunction is not NULL, and a handler is already
+ registered.
+ @retval EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not
+ previously registered.
**/
typedef
@@ -89,17 +86,15 @@ EFI_STATUS timer to TimerPeriod 100 nS units. If TimerPeriod is 0, then the watchdog
timer is disabled.
- @param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.
-
- @param TimerPeriod The amount of time in 100 nS units to wait before the watchdog
- timer is fired. If TimerPeriod is zero, then the watchdog
- timer is disabled.
+ @param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.
+ @param TimerPeriod The amount of time in 100 nS units to wait before the watchdog
+ timer is fired. If TimerPeriod is zero, then the watchdog
+ timer is disabled.
- @retval EFI_SUCCESS The watchdog timer has been programmed to fire in Time
- 100 nS units.
-
- @retval EFI_DEVICE_ERROR A watchdog timer could not be programmed due to a device
- error.
+ @retval EFI_SUCCESS The watchdog timer has been programmed to fire in Time
+ 100 nS units.
+ @retval EFI_DEVICE_ERROR A watchdog timer could not be programmed due to a device
+ error.
**/
typedef
@@ -114,16 +109,14 @@ EFI_STATUS the watchdog timer. This period is returned in TimerPeriod, and EFI_SUCCESS
is returned. If TimerPeriod is NULL, then EFI_INVALID_PARAMETER is returned.
- @param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.
-
- @param TimerPeriod A pointer to the amount of time in 100 nS units that the system
- will wait before the watchdog timer is fired. If TimerPeriod of
- zero is returned, then the watchdog timer is disabled.
+ @param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.
+ @param TimerPeriod A pointer to the amount of time in 100 nS units that the system
+ will wait before the watchdog timer is fired. If TimerPeriod of
+ zero is returned, then the watchdog timer is disabled.
- @retval EFI_SUCCESS The amount of time that the system will wait before
- firing the watchdog timer was returned in TimerPeriod.
-
- @retval EFI_INVALID_PARAMETER TimerPeriod is NULL.
+ @retval EFI_SUCCESS The amount of time that the system will wait before
+ firing the watchdog timer was returned in TimerPeriod.
+ @retval EFI_INVALID_PARAMETER TimerPeriod is NULL.
**/
typedef
@@ -148,16 +141,16 @@ EFI_STATUS been registered, or the registered handler returns, then the system will be
reset by calling the Runtime Service ResetSystem().
- @param RegisterHandler - Registers a handler that is invoked when the watchdog
- timer fires.
+ @param RegisterHandler Registers a handler that is invoked when the watchdog
+ timer fires.
- @param SetTimerPeriod - Sets the amount of time in 100 ns units to wait before the
- watchdog timer is fired. If this function is supported,
- then the watchdog timer period will be rounded up to the
- nearest supported watchdog timer period.
+ @param SetTimerPeriod Sets the amount of time in 100 ns units to wait before the
+ watchdog timer is fired. If this function is supported,
+ then the watchdog timer period will be rounded up to the
+ nearest supported watchdog timer period.
- @param GetTimerPeriod - Retrieves the amount of time in 100 ns units that the
- system will wait before the watchdog timer is fired.
+ @param GetTimerPeriod Retrieves the amount of time in 100 ns units that the
+ system will wait before the watchdog timer is fired.
**/
struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL {
diff --git a/MdePkg/Include/Dxe/DxeCis.h b/MdePkg/Include/Dxe/DxeCis.h index a36481c..d048014 100644 --- a/MdePkg/Include/Dxe/DxeCis.h +++ b/MdePkg/Include/Dxe/DxeCis.h @@ -39,7 +39,7 @@ #endif
//
-// BugBug: Implementation contamination of UEFI 2.0
+// Implementation contamination of UEFI 2.0
// Pointer to internal runtime pointer
//
#define EFI_IPF_GP_POINTER 0x00000008
@@ -116,15 +116,12 @@ typedef struct { Adds reserved memory, system memory, or memory-mapped I/O resources to the
global coherency domain of the processor.
- @param GcdMemoryType Memory type of the memory space.
-
- @param BaseAddress Base address of the memory space.
-
- @param Length Length of the memory space.
-
- @param Capabilities alterable attributes of the memory space.
+ @param GcdMemoryType Memory type of the memory space.
+ @param BaseAddress Base address of the memory space.
+ @param Length Length of the memory space.
+ @param Capabilities alterable attributes of the memory space.
- @retval EFI_SUCCESS Merged this memory space into GCD map.
+ @retval EFI_SUCCESS Merged this memory space into GCD map.
**/
typedef
@@ -141,25 +138,17 @@ EFI_STATUS Allocates nonexistent memory, reserved memory, system memory, or memorymapped
I/O resources from the global coherency domain of the processor.
- @param GcdAllocateType The type of allocate operation
-
- @param GcdMemoryType The desired memory type
-
- @param Alignment Align with 2^Alignment
-
- @param Length Length to allocate
-
- @param BaseAddress Base address to allocate
-
- @param Imagehandle The image handle consume the allocated space.
-
- @param DeviceHandle The device handle consume the allocated space.
-
- @retval EFI_INVALID_PARAMETER Invalid parameter.
-
- @retval EFI_NOT_FOUND No descriptor contains the desired space.
-
- @retval EFI_SUCCESS Memory space successfully allocated.
+ @param GcdAllocateType The type of allocate operation
+ @param GcdMemoryType The desired memory type
+ @param Alignment Align with 2^Alignment
+ @param Length Length to allocate
+ @param BaseAddress Base address to allocate
+ @param Imagehandle The image handle consume the allocated space.
+ @param DeviceHandle The device handle consume the allocated space.
+
+ @retval EFI_INVALID_PARAMETER Invalid parameter.
+ @retval EFI_NOT_FOUND No descriptor contains the desired space.
+ @retval EFI_SUCCESS Memory space successfully allocated.
**/
typedef
@@ -179,11 +168,10 @@ EFI_STATUS Frees nonexistent memory, reserved memory, system memory, or memory-mapped
I/O resources from the global coherency domain of the processor.
- @param BaseAddress Base address of the segment.
-
- @param Length Length of the segment.
+ @param BaseAddress Base address of the segment.
+ @param Length Length of the segment.
- @retval EFI_SUCCESS Space successfully freed.
+ @retval EFI_SUCCESS Space successfully freed.
**/
typedef
@@ -198,11 +186,10 @@ EFI_STATUS Removes reserved memory, system memory, or memory-mapped I/O resources from
the global coherency domain of the processor.
- @param BaseAddress Base address of the memory space.
-
- @param Length Length of the memory space.
+ @param BaseAddress Base address of the memory space.
+ @param Length Length of the memory space.
- @retval EFI_SUCCESS Successfully remove a segment of memory space.
+ @retval EFI_SUCCESS Successfully remove a segment of memory space.
**/
typedef
@@ -216,13 +203,11 @@ EFI_STATUS /**
Retrieves the descriptor for a memory region containing a specified address.
- @param BaseAddress Specified start address
-
- @param Descriptor Specified length
+ @param BaseAddress Specified start address
+ @param Descriptor Specified length
- @retval EFI_INVALID_PARAMETER Invalid parameter
-
- @retval EFI_SUCCESS Successfully get memory space descriptor.
+ @retval EFI_INVALID_PARAMETER Invalid parameter
+ @retval EFI_SUCCESS Successfully get memory space descriptor.
**/
typedef
@@ -237,13 +222,11 @@ EFI_STATUS Modifies the attributes for a memory region in the global coherency domain of the
processor.
- @param BaseAddress Specified start address
-
- @param Length Specified length
-
- @param Attributes Specified attributes
+ @param BaseAddress Specified start address
+ @param Length Specified length
+ @param Attributes Specified attributes
- @retval EFI_SUCCESS Successfully set attribute of a segment of memory space.
+ @retval EFI_SUCCESS Successfully set attribute of a segment of memory space.
**/
typedef
@@ -261,14 +244,11 @@ EFI_STATUS processor.
@param NumberOfDescriptors Number of descriptors.
-
- @param MemorySpaceMap Descriptor array
+ @param MemorySpaceMap Descriptor array
- @retval EFI_INVALID_PARAMETER Invalid parameter
-
- @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
-
- @retval EFI_SUCCESS Successfully get memory space map.
+ @retval EFI_INVALID_PARAMETER Invalid parameter
+ @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
+ @retval EFI_SUCCESS Successfully get memory space map.
**/
typedef
@@ -282,13 +262,11 @@ EFI_STATUS /**
Adds reserved I/O or I/O resources to the global coherency domain of the processor.
- @param GcdIoType IO type of the segment.
-
- @param BaseAddress Base address of the segment.
-
- @param Length Length of the segment.
+ @param GcdIoType IO type of the segment.
+ @param BaseAddress Base address of the segment.
+ @param Length Length of the segment.
- @retval EFI_SUCCESS Merged this segment into GCD map.
+ @retval EFI_SUCCESS Merged this segment into GCD map.
**/
typedef
@@ -304,25 +282,17 @@ EFI_STATUS Allocates nonexistent I/O, reserved I/O, or I/O resources from the global coherency
domain of the processor.
- @param GcdAllocateType The type of allocate operation
-
- @param GcdIoType The desired IO type
-
- @param Alignment Align with 2^Alignment
-
- @param Length Length to allocate
-
- @param BaseAddress Base address to allocate
-
- @param Imagehandle The image handle consume the allocated space.
-
- @param DeviceHandle The device handle consume the allocated space.
-
- @retval EFI_INVALID_PARAMETER Invalid parameter.
-
- @retval EFI_NOT_FOUND No descriptor contains the desired space.
-
- @retval EFI_SUCCESS IO space successfully allocated.
+ @param GcdAllocateType The type of allocate operation
+ @param GcdIoType The desired IO type
+ @param Alignment Align with 2^Alignment
+ @param Length Length to allocate
+ @param BaseAddress Base address to allocate
+ @param Imagehandle The image handle consume the allocated space.
+ @param DeviceHandle The device handle consume the allocated space.
+
+ @retval EFI_INVALID_PARAMETER Invalid parameter.
+ @retval EFI_NOT_FOUND No descriptor contains the desired space.
+ @retval EFI_SUCCESS IO space successfully allocated.
**/
typedef
@@ -342,11 +312,10 @@ EFI_STATUS Frees nonexistent I/O, reserved I/O, or I/O resources from the global coherency
domain of the processor.
- @param BaseAddress Base address of the segment.
-
- @param Length Length of the segment.
+ @param BaseAddress Base address of the segment.
+ @param Length Length of the segment.
- @retval EFI_SUCCESS Space successfully freed.
+ @retval EFI_SUCCESS Space successfully freed.
**/
typedef
@@ -361,11 +330,10 @@ EFI_STATUS Removes reserved I/O or I/O resources from the global coherency domain of the
processor.
- @param BaseAddress Base address of the segment.
-
- @param Length Length of the segment.
+ @param BaseAddress Base address of the segment.
+ @param Length Length of the segment.
- @retval EFI_SUCCESS Successfully removed a segment of IO space.
+ @retval EFI_SUCCESS Successfully removed a segment of IO space.
**/
typedef
@@ -379,13 +347,11 @@ EFI_STATUS /**
Retrieves the descriptor for an I/O region containing a specified address.
- @param BaseAddress Specified start address
-
- @param Descriptor Specified length
+ @param BaseAddress Specified start address
+ @param Descriptor Specified length
- @retval EFI_INVALID_PARAMETER Descriptor is NULL.
-
- @retval EFI_SUCCESS Successfully get the IO space descriptor.
+ @retval EFI_INVALID_PARAMETER Descriptor is NULL.
+ @retval EFI_SUCCESS Successfully get the IO space descriptor.
**/
typedef
@@ -400,14 +366,11 @@ EFI_STATUS Returns a map of the I/O resources in the global coherency domain of the processor.
@param NumberOfDescriptors Number of descriptors.
-
- @param MemorySpaceMap Descriptor array
+ @param MemorySpaceMap Descriptor array
- @retval EFI_INVALID_PARAMETER Invalid parameter
-
- @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
-
- @retval EFI_SUCCESS Successfully get IO space map.
+ @retval EFI_INVALID_PARAMETER Invalid parameter
+ @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
+ @retval EFI_SUCCESS Successfully get IO space map.
**/
typedef
@@ -433,8 +396,7 @@ EFI_STATUS Clears the Schedule on Request (SOR) flag for a component that is stored in a firmware volume.
@param FirmwareVolumeHandle The handle of the firmware volume that contains the file specified by FileName.
-
- @param DriverName A pointer to the name of the file in a firmware volume.
+ @param DriverName A pointer to the name of the file in a firmware volume.
@return Status code
@@ -451,8 +413,7 @@ EFI_STATUS Promotes a file stored in a firmware volume from the untrusted to the trusted state.
@param FirmwareVolumeHandle The handle of the firmware volume that contains the file specified by FileName.
-
- @param DriverName A pointer to the name of the file in a firmware volume.
+ @param DriverName A pointer to the name of the file in a firmware volume.
@return Status code
@@ -469,7 +430,7 @@ EFI_STATUS Creates a firmware volume handle for a firmware volume that is present in system memory.
@param FirmwareVolumeHeader A pointer to the header of the firmware volume.
- @param Size The size, in bytes, of the firmware volume.
+ @param Size The size, in bytes, of the firmware volume.
@param FirmwareVolumeHandle On output, a pointer to the created handle.
@return Status code
diff --git a/MdePkg/Include/Dxe/SmmCis.h b/MdePkg/Include/Dxe/SmmCis.h index 35a1a64..d2f2e17 100644 --- a/MdePkg/Include/Dxe/SmmCis.h +++ b/MdePkg/Include/Dxe/SmmCis.h @@ -51,24 +51,17 @@ typedef enum { Provides the basic memory and I/O interfaces that are used to
abstract accesses to devices.
- @param This The EFI_SMM_CPU_IO_INTERFACE instance.
-
- @param Width Signifies the width of the I/O operations.
-
- @param Address The base address of the I/O operations.
-
- @param Count The number of I/O operations to perform.
-
- @param Buffer For read operations, the destination buffer to store the results.
- For write operations, the source buffer from which to write data.
-
- @retval EFI_SUCCESS The data was read from or written to the device.
-
- @retval EFI_UNSUPPORTED The Address is not valid for this system.
-
+ @param This The EFI_SMM_CPU_IO_INTERFACE instance.
+ @param Width Signifies the width of the I/O operations.
+ @param Address The base address of the I/O operations.
+ @param Count The number of I/O operations to perform.
+ @param Buffer For read operations, the destination buffer to store the results.
+ For write operations, the source buffer from which to write data.
+
+ @retval EFI_SUCCESS The data was read from or written to the device.
+ @retval EFI_UNSUPPORTED The Address is not valid for this system.
@retval EFI_INVALID_PARAMETER Width or Count, or both, were invalid.
-
- @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
**/
typedef
@@ -95,18 +88,14 @@ struct _EFI_SMM_CPU_IO_INTERFACE { Allocates pool memory from SMRAM for IA-32 or runtime memory for
the Itanium processor family.
- @param PoolType The type of pool to allocate.The only supported type is EfiRuntimeServicesData
-
- @param Size The number of bytes to allocate from the pool.
-
- @param Buffer A pointer to a pointer to the allocated buffer if the call
- succeeds; undefined otherwise.
+ @param PoolType The type of pool to allocate.The only supported type is EfiRuntimeServicesData
+ @param Size The number of bytes to allocate from the pool.
+ @param Buffer A pointer to a pointer to the allocated buffer if the call
+ succeeds; undefined otherwise.
- @retval EFI_SUCCESS The requested number of bytes was allocated.
-
+ @retval EFI_SUCCESS The requested number of bytes was allocated.
@retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
-
- @retval EFI_UNSUPPORTED In runtime.
+ @retval EFI_UNSUPPORTED In runtime.
**/
typedef
@@ -120,13 +109,11 @@ EFI_STATUS /**
Returns pool memory to the system.
- @param Buffer Pointer to the buffer to free.
+ @param Buffer Pointer to the buffer to free.
- @retval EFI_SUCCESS The memory was returned to the system.
-
- @retval EFI_INVALID_PARAMETER Buffer was invalid.
-
- @retval EFI_UNSUPPORTED In runtime.
+ @retval EFI_SUCCESS The memory was returned to the system.
+ @retval EFI_INVALID_PARAMETER Buffer was invalid.
+ @retval EFI_UNSUPPORTED In runtime.
**/
typedef
@@ -138,24 +125,18 @@ EFI_STATUS /**
Allocates memory pages from the system.
- @param Type The type of allocation to perform.
-
- @param MemoryType The only supported type is EfiRuntimeServicesData
-
- @param NumberofPages The number of contiguous 4 KB pages to allocate
-
- @param Memory Pointer to a physical address. On input, the way in which
- the address is used depends on the value of Type. On output, the address
- is set to the base of the page range that was allocated.
-
- @retval EFI_SUCCESS The requested pages were allocated.
-
+ @param Type The type of allocation to perform.
+ @param MemoryType The only supported type is EfiRuntimeServicesData
+ @param NumberofPages The number of contiguous 4 KB pages to allocate
+ @param Memory Pointer to a physical address. On input, the way in which
+ the address is used depends on the value of Type. On output, the address
+ is set to the base of the page range that was allocated.
+
+ @retval EFI_SUCCESS The requested pages were allocated.
@retval EFI_OUT_OF_RESOURCES The pages requested could not be allocated.
-
- @retval EFI_NOT_FOUND The requested pages could not be found.
-
- @retval EFI_INVALID_PARAMETER Type is not AllocateAnyPages or AllocateMaxAddress
- or AllocateAddress. Or MemoryType is in the range EfiMaxMemoryType..0x7FFFFFFF.
+ @retval EFI_NOT_FOUND The requested pages could not be found.
+ @retval EFI_INVALID_PARAMETER Type is not AllocateAnyPages or AllocateMaxAddress
+ or AllocateAddress. Or MemoryType is in the range EfiMaxMemoryType..0x7FFFFFFF.
**/
typedef
@@ -170,15 +151,12 @@ EFI_STATUS /**
Frees memory pages for the system.
- @param Memory The base physical address of the pages to be freed
-
- @param NumberOfPages The number of contiguous 4 KB pages to free.
+ @param Memory The base physical address of the pages to be freed
+ @param NumberOfPages The number of contiguous 4 KB pages to free.
- @retval EFI_SUCCESS The requested memory pages were freed.
-
- @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or NumberOfPages is invalid.
-
- @retval EFI_NOT_FOUND The requested memory pages were not allocated with SmmAllocatePages().
+ @retval EFI_SUCCESS The requested memory pages were freed.
+ @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or NumberOfPages is invalid.
+ @retval EFI_NOT_FOUND The requested memory pages were not allocated with SmmAllocatePages().
**/
typedef
@@ -412,15 +390,14 @@ typedef union { This function is the main entry point for an SMM handler dispatch
or communicate-based callback.
- @param SmmImageHandle A unique value returned by the SMM infrastructure
- in response to registration for a communicate-based callback or dispatch.
-
- @param CommunicationBuffer An optional buffer that will be populated
- by the SMM infrastructure in response to a non-SMM agent (preboot or runtime)
- invoking the EFI_SMM_BASE_PROTOCOL.Communicate() service.
-
- @param SourceSize If CommunicationBuffer is non-NULL, this field
- indicates the size of the data payload in this buffer.
+ @param SmmImageHandle A unique value returned by the SMM infrastructure
+ in response to registration for a communicate-based callback or dispatch.
+ @param CommunicationBuffer
+ An optional buffer that will be populated
+ by the SMM infrastructure in response to a non-SMM agent (preboot or runtime)
+ invoking the EFI_SMM_BASE_PROTOCOL.Communicate() service.
+ @param SourceSize If CommunicationBuffer is non-NULL, this field
+ indicates the size of the data payload in this buffer.
@return Status Code
@@ -439,15 +416,15 @@ EFI_STATUS Table. The list is stored as an array of (GUID, Pointer) pairs. The list
must be allocated from pool memory with PoolType set to EfiRuntimeServicesData.
- @param SystemTable A pointer to the SMM System Table.
- @param Guid A pointer to the GUID for the entry to add, update, or remove.
- @param Table A pointer to the buffer of the table to add.
- @param TableSize The size of the table to install.
+ @param SystemTable A pointer to the SMM System Table.
+ @param Guid A pointer to the GUID for the entry to add, update, or remove.
+ @param Table A pointer to the buffer of the table to add.
+ @param TableSize The size of the table to install.
- @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.
+ @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.
@retval EFI_INVALID_PARAMETER Guid is not valid.
- @retval EFI_NOT_FOUND An attempt was made to delete a non-existent entry.
- @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.
+ @retval EFI_NOT_FOUND An attempt was made to delete a non-existent entry.
+ @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.
**/
typedef
|