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 | |
| parent | 151c1ccdcd6960c550fa491bd0ed467416bb2b74 (diff) | |
| download | edk2-platforms-0647c9adf92c6a8712091607a73b2768327a865d.tar.xz | |
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')
76 files changed, 2152 insertions, 2790 deletions
diff --git a/MdePkg/Include/Common/BaseTypes.h b/MdePkg/Include/Common/BaseTypes.h index 86c3c71fb3..3935919300 100644 --- a/MdePkg/Include/Common/BaseTypes.h +++ b/MdePkg/Include/Common/BaseTypes.h @@ -62,7 +62,7 @@ typedef struct { //
#ifndef TRUE
//
-// BugBug: UEFI specification claims 1 and 0. We are concerned about the
+// UEFI specification claims 1 and 0. We are concerned about the
// complier portability so we did it this way.
//
#define TRUE ((BOOLEAN)(1==1))
diff --git a/MdePkg/Include/Common/DataHubRecords.h b/MdePkg/Include/Common/DataHubRecords.h index 0bc8f23d75..dc8d29110c 100644 --- a/MdePkg/Include/Common/DataHubRecords.h +++ b/MdePkg/Include/Common/DataHubRecords.h @@ -1,10 +1,7 @@ /** @file
- This file defines GUIDs and associated data structures for records
- posted to the Data Hub.
- The producers of these records use these definitions to construct
- records.
- The consumers of these records use these definitions to retrieve,
- filter and parse records.
+ This file defines GUIDs and associated data structures for records posted to the Data Hub.
+ The producers of these records use these definitions to construct records.
+ The consumers of these records use these definitions to retrieve, filter and parse records.
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
diff --git a/MdePkg/Include/Common/Dependency.h b/MdePkg/Include/Common/Dependency.h index 744027d2f3..d82cefd958 100644 --- a/MdePkg/Include/Common/Dependency.h +++ b/MdePkg/Include/Common/Dependency.h @@ -1,6 +1,5 @@ /** @file
- This module contains data specific to dependency expressions
- and local function prototypes.
+ This module contains data specific to dependency expressions.
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
diff --git a/MdePkg/Include/Common/MultiPhase.h b/MdePkg/Include/Common/MultiPhase.h index 93867a5e8a..d9b72a4695 100644 --- a/MdePkg/Include/Common/MultiPhase.h +++ b/MdePkg/Include/Common/MultiPhase.h @@ -18,8 +18,6 @@ #define __MULTI_PHASE_H__
//
-//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-//
// Needed EFI defines for PEI
//
typedef UINT64 EFI_PHYSICAL_ADDRESS;
diff --git a/MdePkg/Include/Dxe/ArchProtocol/Bds.h b/MdePkg/Include/Dxe/ArchProtocol/Bds.h index f6b72d2b00..d060eb9f57 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 975a816356..ac1b43b807 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 a07003e5cc..c4a1f71925 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 bbd4c1a699..feb2d8f294 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 3598199b84..ec981b4a02 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 6440dc3388..6bfaeaedd2 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 330f4cfd68..302ae1428a 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 a8d84b18da..8e31a36bc5 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 a36481c817..d048014462 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 35a1a64682..d2f2e17de5 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
diff --git a/MdePkg/Include/Guid/Acpi.h b/MdePkg/Include/Guid/Acpi.h index a64f1b7ea0..14b2b9fcd4 100644 --- a/MdePkg/Include/Guid/Acpi.h +++ b/MdePkg/Include/Guid/Acpi.h @@ -1,5 +1,5 @@ /** @file
- GUIDs used for ACPI entries in the EFI 1.0 system table
+ GUIDs used for ACPI entries in the EFI system table
These GUIDs point the ACPI tables as defined in the ACPI specifications.
ACPI 2.0 specification defines the ACPI 2.0 GUID. UEFI 2.0 defines the
diff --git a/MdePkg/Include/Guid/EventGroup.h b/MdePkg/Include/Guid/EventGroup.h index f86abd4788..cf681888be 100644 --- a/MdePkg/Include/Guid/EventGroup.h +++ b/MdePkg/Include/Guid/EventGroup.h @@ -1,5 +1,5 @@ /** @file
- GUIDs for gBS->CreateEventEx Event Groups. Defined in EFI 2.0.
+ GUIDs for gBS->CreateEventEx Event Groups. Defined in UEFI spec 2.0.
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
diff --git a/MdePkg/Include/Guid/EventLegacyBios.h b/MdePkg/Include/Guid/EventLegacyBios.h index 6700a2d767..d38b427d46 100644 --- a/MdePkg/Include/Guid/EventLegacyBios.h +++ b/MdePkg/Include/Guid/EventLegacyBios.h @@ -1,5 +1,7 @@ /** @file
- GUID is the name of events used with CreateEventEx in order to be notified when the EFI boot manager is about to boot a legacy boot option. Events of this type are notificated just before Int19h is invoked.
+ GUID is the name of events used with CreateEventEx in order to be notified
+ when the EFI boot manager is about to boot a legacy boot option.
+ Events of this type are notificated just before Int19h is invoked.
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
diff --git a/MdePkg/Include/Ia32/ProcessorBind.h b/MdePkg/Include/Ia32/ProcessorBind.h index 587d8a69ab..2ed3a02ee3 100644 --- a/MdePkg/Include/Ia32/ProcessorBind.h +++ b/MdePkg/Include/Ia32/ProcessorBind.h @@ -86,7 +86,7 @@ //
// Assume standard IA-32 alignment.
- // BugBug: Need to check portability of long long
+ // Need to check portability of long long
//
typedef unsigned long long UINT64;
typedef long long INT64;
diff --git a/MdePkg/Include/IndustryStandard/scsi.h b/MdePkg/Include/IndustryStandard/scsi.h index 41023094f5..f3112ae7d0 100644 --- a/MdePkg/Include/IndustryStandard/scsi.h +++ b/MdePkg/Include/IndustryStandard/scsi.h @@ -1,5 +1,5 @@ /** @file
- support for SCSI standard
+ support for SCSI-2 standard
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
diff --git a/MdePkg/Include/Library/HobLib.h b/MdePkg/Include/Library/HobLib.h index 4b2745dcef..b367b02cd4 100644 --- a/MdePkg/Include/Library/HobLib.h +++ b/MdePkg/Include/Library/HobLib.h @@ -134,7 +134,7 @@ GetFirstGuidHob ( @param ModuleName The GUID File Name of the module.
@param MemoryAllocationModule The 64 bit physical address of the module.
@param ModuleLength The length of the module in bytes.
- @param EntryPoint The 64 bit physical address of the module’s entry point.
+ @param EntryPoint The 64 bit physical address of the module entry point.
**/
VOID
diff --git a/MdePkg/Include/Peim/PeiCis.h b/MdePkg/Include/Peim/PeiCis.h index 513138be3f..bb7847df70 100644 --- a/MdePkg/Include/Peim/PeiCis.h +++ b/MdePkg/Include/Peim/PeiCis.h @@ -63,9 +63,8 @@ typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR; The PEI Dispatcher will invoke each PEIM one time. During this pass, the PEI
Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header.
- @param FfsHeader Pointer to the FFS file header.
-
- @param PeiServices Describes the list of possible PEI Services.
+ @param FfsHeader Pointer to the FFS file header.
+ @param PeiServices Describes the list of possible PEI Services.
@return Status code
@@ -80,11 +79,9 @@ EFI_STATUS /**
Entry point of the notification callback function itself within the PEIM.
- @param PeiServices Indirect reference to the PEI Services Table.
-
+ @param PeiServices Indirect reference to the PEI Services Table.
@param NotifyDescriptor Address of the notification descriptor data structure.
-
- @param Ppi Address of the PPI that was installed.
+ @param Ppi Address of the PPI that was installed.
@return Status code
@@ -125,16 +122,13 @@ struct _EFI_PEI_NOTIFY_DESCRIPTOR { service is to publish an interface that other parties can use to call
additional PEIMs.
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table
- published by the PEI Foundation.
-
- @param PpiList A pointer to the list of interfaces that the caller shall install.
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table
+ published by the PEI Foundation.
+ @param PpiList A pointer to the list of interfaces that the caller shall install.
- @retval EFI_SUCCESS The interface was successfully installed.
-
- @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
-
- @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
+ @retval EFI_SUCCESS The interface was successfully installed.
+ @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
+ @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
**/
typedef
@@ -150,20 +144,16 @@ EFI_STATUS can use to replace a same-named interface in the protocol database
with a different interface.
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table
- published by the PEI Foundation.
-
- @param OldPpi A pointer to the former PPI in the database.
-
- @param NewPpi A pointer to the new interfaces that the caller shall install.
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table
+ published by the PEI Foundation.
+ @param OldPpi A pointer to the former PPI in the database.
+ @param NewPpi A pointer to the new interfaces that the caller shall install.
- @retval EFI_SUCCESS The interface was successfully installed.
-
- @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
-
- @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
-
- @retval EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been installed.
+ @retval EFI_SUCCESS The interface was successfully installed.
+ @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the
+ list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
+ @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
+ @retval EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been installed.
**/
typedef
@@ -177,19 +167,14 @@ EFI_STATUS /**
This function locates an interface in the PEI PPI database by GUID.
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.
-
- @param Guid A pointer to the GUID whose corresponding interface needs to be found.
-
- @param Instance The N-th instance of the interface that is required.
-
- @param PpiDescriptor A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.
-
- @param Ppi A pointer to the instance of the interface.
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.
+ @param Guid A pointer to the GUID whose corresponding interface needs to be found.
+ @param Instance The N-th instance of the interface that is required.
+ @param PpiDescriptor A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.
+ @param Ppi A pointer to the instance of the interface.
- @retval EFI_SUCCESS The interface was successfully returned.
-
- @retval EFI_NOT_FOUND The PPI descriptor is not found in the database.
+ @retval EFI_SUCCESS The interface was successfully returned.
+ @retval EFI_NOT_FOUND The PPI descriptor is not found in the database.
**/
typedef
@@ -208,15 +193,13 @@ EFI_STATUS is to publish an interface that other parties can use to call additional PPIs
that may materialize later.
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
-
- @param NotifyList A pointer to the list of notification interfaces that the caller shall install.
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
+ @param NotifyList A pointer to the list of notification interfaces that the caller shall install.
- @retval EFI_SUCCESS The interface was successfully installed.
-
- @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
-
- @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
+ @retval EFI_SUCCESS The interface was successfully installed.
+ @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the
+ list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
+ @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
**/
typedef
@@ -229,11 +212,10 @@ EFI_STATUS /**
This function returns the present value of the boot mode.
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
-
- @param BootMode A pointer to contain the value of the boot mode.
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
+ @param BootMode A pointer to contain the value of the boot mode.
- @retval EFI_SUCCESS The boot mode was returned successfully.
+ @retval EFI_SUCCESS The boot mode was returned successfully.
**/
typedef
@@ -246,11 +228,10 @@ EFI_STATUS /**
This function sets the value of the boot mode.
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
-
- @param BootMode The value of the boot mode to set.
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
+ @param BootMode The value of the boot mode to set.
- @retval EFI_SUCCESS The boot mode was returned successfully.
+ @retval EFI_SUCCESS The boot mode was returned successfully.
**/
typedef
@@ -263,12 +244,10 @@ EFI_STATUS /**
This function returns the pointer to the list of Hand-Off Blocks (HOBs) in memory.
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
-
- @param HobList A pointer to the list of HOBs that the PEI Foundation will initialize
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
+ @param HobList A pointer to the list of HOBs that the PEI Foundation will initialize
- @retval EFI_SUCCESS The list was successfully returned.
-
+ @retval EFI_SUCCESS The list was successfully returned.
@retval EFI_NOT_AVAILABLE_YET The HOB list is not yet published.
**/
@@ -282,17 +261,13 @@ EFI_STATUS /**
This service published by the PEI Foundation abstracts the creation of a Hand-Off Block's (HOB¡¯s) headers.
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
-
- @param Type The type of HOB to be installed.
-
- @param Length The length of the HOB to be added.
-
- @param Hob The address of a pointer that will contain the HOB header.
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
+ @param Type The type of HOB to be installed.
+ @param Length The length of the HOB to be added.
+ @param Hob The address of a pointer that will contain the HOB header.
- @retval EFI_SUCCESS The HOB was successfully created.
-
- @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.
+ @retval EFI_SUCCESS The HOB was successfully created.
+ @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.
**/
typedef
@@ -310,16 +285,12 @@ EFI_STATUS Given the input file pointer, this service searches for the next
matching file in the Firmware File System (FFS) volume.
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
-
- @param Instance This instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV).
-
- @param FwVolHeader Pointer to the firmware volume header of the volume to return.
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
+ @param Instance This instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV).
+ @param FwVolHeader Pointer to the firmware volume header of the volume to return.
- @retval EFI_SUCCESS The volume was found.
-
- @retval EFI_NOT_FOUND The volume was not found.
-
+ @retval EFI_SUCCESS The volume was found.
+ @retval EFI_NOT_FOUND The volume was not found.
@retval EFI_INVALID_PARAMETER FwVolHeader is NULL
**/
@@ -337,19 +308,16 @@ EFI_STATUS Given the input file pointer, this service searches for the next matching
file in the Firmware File System (FFS) volume.
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
-
- @param SearchType A filter to find files only of this type.
-
- @param FwVolHeader Pointer to the firmware volume header of the volume to search.This parameter must point to a valid FFS volume.
-
- @param FileHeader Pointer to the current file from which to begin searching.This pointer will be updated upon return to reflect the file found.
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
+ @param SearchType A filter to find files only of this type.
+ @param FwVolHeader Pointer to the firmware volume header of the volume to search.This parameter
+ must point to a valid FFS volume.
+ @param FileHeader Pointer to the current file from which to begin searching.This pointer will be
+ updated upon return to reflect the file found.
- @retval EFI_SUCCESS The file was found.
-
- @retval EFI_NOT_FOUND The file was not found.
-
- @retval EFI_NOT_FOUND The header checksum was not zero.
+ @retval EFI_SUCCESS The file was found.
+ @retval EFI_NOT_FOUND The file was not found.
+ @retval EFI_NOT_FOUND The header checksum was not zero.
**/
typedef
@@ -365,17 +333,13 @@ EFI_STATUS Given the input file pointer, this service searches for the next
matching file in the Firmware File System (FFS) volume.
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
-
- @param SectionType The value of the section type to find.
-
- @param FfsFileHeader A pointer to the file header that contains the set of sections to be searched.
-
- @param SectionData A pointer to the discovered section, if successful.
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
+ @param SectionType The value of the section type to find.
+ @param FfsFileHeader A pointer to the file header that contains the set of sections to be searched.
+ @param SectionData A pointer to the discovered section, if successful.
- @retval EFI_SUCCESS The section was found.
-
- @retval EFI_NOT_FOUND The section was not found.
+ @retval EFI_SUCCESS The section was found.
+ @retval EFI_NOT_FOUND The section was not found.
**/
typedef
@@ -390,17 +354,13 @@ EFI_STATUS /**
This function registers the found memory configuration with the PEI Foundation.
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
-
- @param MemoryBegin The value of a region of installed memory
-
- @param MemoryLength The corresponding length of a region of installed memory.
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
+ @param MemoryBegin The value of a region of installed memory
+ @param MemoryLength The corresponding length of a region of installed memory.
- @retval EFI_SUCCESS The region was successfully installed in a HOB.
-
+ @retval EFI_SUCCESS The region was successfully installed in a HOB.
@retval EFI_INVALID_PARAMETER MemoryBegin and MemoryLength are illegal for this system.
-
- @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.
+ @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.
**/
typedef
@@ -415,18 +375,14 @@ EFI_STATUS The purpose of the service is to publish an interface that allows
PEIMs to allocate memory ranges that are managed by the PEI Foundation.
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
-
- @param MemoryType The type of memory to allocate.
-
- @param Pages The number of contiguous 4 KB pages to allocate.
-
- @param Memory Pointer to a physical address. On output, the address is set to the base of the page range that was allocated.
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
+ @param MemoryType The type of memory to allocate.
+ @param Pages The number of contiguous 4 KB pages to allocate.
+ @param Memory Pointer to a physical address. On output, the address is set to the base
+ of the page range that was allocated.
- @retval EFI_SUCCESS The memory range was successfully allocated.
-
+ @retval EFI_SUCCESS The memory range was successfully allocated.
@retval EFI_OUT_OF_RESOURCES The pages could not be allocated.
-
@retval EFI_INVALID_PARAMETER Type is not equal to AllocateAnyPages.
**/
@@ -443,15 +399,12 @@ EFI_STATUS The purpose of this service is to publish an interface that
allows PEIMs to allocate memory ranges that are managed by the PEI Foundation.
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
-
- @param Size The number of bytes to allocate from the pool.
-
- @param Buffer If the call succeeds, a pointer to a pointer to the allocated buffer; undefined otherwise.
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
+ @param Size The number of bytes to allocate from the pool.
+ @param Buffer If the call succeeds, a pointer to a pointer to the allocated buffer; undefined otherwise.
- @retval EFI_SUCCESS The allocation was successful.
-
- @retval EFI_OUT_OF_RESOURCES There is not enough heap to allocate the requested size.
+ @retval EFI_SUCCESS The allocation was successful.
+ @retval EFI_OUT_OF_RESOURCES There is not enough heap to allocate the requested size.
**/
typedef
@@ -465,11 +418,9 @@ EFI_STATUS /**
This service copies the contents of one buffer to another buffer.
- @param Destination Pointer to the destination buffer of the memory copy.
-
- @param Source Pointer to the source buffer of the memory copy
-
- @param Length Number of bytes to copy from Source to Destination.
+ @param Destination Pointer to the destination buffer of the memory copy.
+ @param Source Pointer to the source buffer of the memory copy
+ @param Length Number of bytes to copy from Source to Destination.
@return None
@@ -485,11 +436,9 @@ VOID /**
The service fills a buffer with a specified value.
- @param Buffer Pointer to the buffer to fill.
-
- @param Size Number of bytes in Buffer to fill.
-
- @param Value Value to fill Buffer with
+ @param Buffer Pointer to the buffer to fill.
+ @param Size Number of bytes in Buffer to fill.
+ @param Value Value to fill Buffer with
@return None
@@ -505,30 +454,24 @@ VOID /**
This service publishes an interface that allows PEIMs to report status codes.
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
-
- @param Type Indicates the type of status code being reported.
-
- @param Value Describes the current status of a hardware or
- software entity. This includes information about the class and
- subclass that is used to classify the entity as well as an operation.
- For progress codes, the operation is the current activity.
- For error codes, it is the exception.For debug codes,it is not defined at this time.
-
- @param Instance The enumeration of a hardware or software entity within
- the system. A system may contain multiple entities that match a class/subclass
- pairing. The instance differentiates between them. An instance of 0 indicates
- that instance information is unavailable, not meaningful, or not relevant.
- 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.
-
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
+ @param Type Indicates the type of status code being reported.
+ @param Value Describes the current status of a hardware or
+ software entity. This includes information about the class and
+ subclass that is used to classify the entity as well as an operation.
+ For progress codes, the operation is the current activity.
+ For error codes, it is the exception.For debug codes,it is not defined at this time.
+ @param Instance The enumeration of a hardware or software entity within
+ the system. A system may contain multiple entities that match a class/subclass
+ pairing. The instance differentiates between them. An instance of 0 indicates
+ that instance information is unavailable, not meaningful, or not relevant.
+ 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_NOT_AVAILABLE_YET No progress code provider has installed an interface in the system.
**/
@@ -546,11 +489,10 @@ EFI_STATUS /**
Resets the entire platform.
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES
- table published by the PEI Foundation.
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES
+ table published by the PEI Foundation.
- @retval EFI_SUCCESS The function completed successfully.
-
+ @retval EFI_SUCCESS The function completed successfully.
@retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.
**/
diff --git a/MdePkg/Include/Ppi/BlockIo.h b/MdePkg/Include/Ppi/BlockIo.h index debcc0c8e4..4bb029ff43 100644 --- a/MdePkg/Include/Ppi/BlockIo.h +++ b/MdePkg/Include/Ppi/BlockIo.h @@ -48,10 +48,8 @@ typedef struct { /**
Gets the count of block I/O devices that one specific block driver detects.
- @param PeiServices General-purpose services that are available to every PEIM.
-
- @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
-
+ @param PeiServices General-purpose services that are available to every PEIM.
+ @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
@param NumberBlockDevices The number of block I/O devices discovered.
@return Status code
@@ -68,21 +66,17 @@ EFI_STATUS /**
Gets a block device¡¯s media information.
- @param PeiServices General-purpose services that are available to every PEIM
-
- @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
-
- @param DeviceIndex Specifies the block device to which the function
- wants to talk. Because the driver that implements Block I/O PPIs
- will manage multiple block devices, the PPIs that want to talk to a single
- device must specify the device index that was assigned during the enumeration
- process. This index is a number from one to NumberBlockDevices.
-
- @param MediaInfo The media information of the specified block media.
-
- @retval EFI_SUCCESS Media information about the specified block device was obtained successfully.
-
- @retval EFI_DEVICE_ERROR Cannot get the media information due to a hardware error.
+ @param PeiServices General-purpose services that are available to every PEIM
+ @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
+ @param DeviceIndex Specifies the block device to which the function
+ wants to talk. Because the driver that implements Block I/O PPIs
+ will manage multiple block devices, the PPIs that want to talk to a single
+ device must specify the device index that was assigned during the enumeration
+ process. This index is a number from one to NumberBlockDevices.
+ @param MediaInfo The media information of the specified block media.
+
+ @retval EFI_SUCCESS Media information about the specified block device was obtained successfully.
+ @retval EFI_DEVICE_ERROR Cannot get the media information due to a hardware error.
**/
typedef
@@ -97,31 +91,22 @@ EFI_STATUS /**
Reads the requested number of blocks from the specified block device.
- @param PeiServices General-purpose services that are available to every PEIM.
-
- @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
-
- @param DeviceIndex Specifies the block device to which the function wants to talk.
-
- @param StartLBA The starting logical block address (LBA) to read from on the device
-
- @param BufferSize The size of the Buffer in bytes. This number must
- be a multiple of the intrinsic block size of the device.
-
- @param Buffer A pointer to the destination buffer for the data.
- The caller is responsible for the ownership of the buffer.
-
- @retval EFI_SUCCESS The data was read correctly from the device.
-
- @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation.
-
+ @param PeiServices General-purpose services that are available to every PEIM.
+ @param This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
+ @param DeviceIndex Specifies the block device to which the function wants to talk.
+ @param StartLBA The starting logical block address (LBA) to read from on the device
+ @param BufferSize The size of the Buffer in bytes. This number must
+ be a multiple of the intrinsic block size of the device.
+ @param Buffer A pointer to the destination buffer for the data.
+ The caller is responsible for the ownership of the buffer.
+
+ @retval EFI_SUCCESS The data was read correctly from the device.
+ @retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation.
@retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,
- or the buffer is not properly aligned.
-
- @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of
- the intrinsic block size of the device.
-
- @retval EFI_NO_MEDIA There is no media in the device.
+ or the buffer is not properly aligned.
+ @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of
+ the intrinsic block size of the device.
+ @retval EFI_NO_MEDIA There is no media in the device.
**/
typedef
diff --git a/MdePkg/Include/Ppi/BootScriptExecuter.h b/MdePkg/Include/Ppi/BootScriptExecuter.h index b73396d7fa..5b10292dff 100644 --- a/MdePkg/Include/Ppi/BootScriptExecuter.h +++ b/MdePkg/Include/Ppi/BootScriptExecuter.h @@ -31,25 +31,19 @@ typedef struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI EFI_PEI_BOOT_SCRIPT_EXECUTER_PP /**
Executes the Framework boot script table.
- @param PeiServices A pointer to the system PEI Services Table.
-
- @param This A pointer to the EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI instance.
-
- @param Address The physical memory address where the table is stored.
- It must be zero if the table to be executed is stored in a firmware volume file.
-
- @param FvFile The firmware volume file name that contains the table to
- be executed. It must be NULL if the table to be executed is stored in physical memory.
-
- @retval EFI_SUCCESS The boot script table was executed successfully.
-
+ @param PeiServices A pointer to the system PEI Services Table.
+ @param This A pointer to the EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI instance.
+ @param Address The physical memory address where the table is stored.
+ It must be zero if the table to be executed is stored in a firmware volume file.
+ @param FvFile The firmware volume file name that contains the table to
+ be executed. It must be NULL if the table to be executed is stored in physical memory.
+
+ @retval EFI_SUCCESS The boot script table was executed successfully.
@retval EFI_INVALID_PARAMETER Address is zero and FvFile is NULL.
-
- @retval EFI_NOT_FOUND The file name specified in FvFile cannot be found.
-
- @retval EFI_UNSUPPORTED The format of the boot script table is invalid.
- Or An unsupported opcode occurred in the table.
- Or There were opcode execution errors, such as an insufficient dependency.
+ @retval EFI_NOT_FOUND The file name specified in FvFile cannot be found.
+ @retval EFI_UNSUPPORTED The format of the boot script table is invalid.
+ Or An unsupported opcode occurred in the table.
+ Or There were opcode execution errors, such as an insufficient dependency.
**/
typedef
diff --git a/MdePkg/Include/Ppi/CpuIo.h b/MdePkg/Include/Ppi/CpuIo.h index 038703386d..791348d3f9 100644 --- a/MdePkg/Include/Ppi/CpuIo.h +++ b/MdePkg/Include/Ppi/CpuIo.h @@ -52,21 +52,15 @@ typedef enum { /**
Memory-based access services and I/O-based access services.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Width The width of the access. Enumerated in bytes.
-
- @param Address The physical address of the access.
-
- @param Count The number of accesses to perform.
-
- @param Buffer A pointer to the buffer of data.
-
- @retval EFI_SUCCESS The function completed successfully.
-
- @retval EFI_NOT_YET_AVAILABLE The service has not been installed.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Width The width of the access. Enumerated in bytes.
+ @param Address The physical address of the access.
+ @param Count The number of accesses to perform.
+ @param Buffer A pointer to the buffer of data.
+
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_NOT_YET_AVAILABLE The service has not been installed.
**/
typedef
@@ -93,11 +87,9 @@ typedef struct { /**
8-bit I/O read operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
@return UINT8
@@ -113,11 +105,9 @@ UINT8 /**
16-bit I/O read operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
@return UINT16
@@ -133,11 +123,9 @@ UINT16 /**
32-bit I/O read operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
@return UINT32
@@ -153,11 +141,9 @@ UINT32 /**
64-bit I/O read operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
@return UINT64
@@ -173,13 +159,10 @@ UINT64 /**
8-bit I/O write operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
-
- @param Data The data to write.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
+ @param Data The data to write.
@return None
@@ -196,13 +179,10 @@ VOID /**
16-bit I/O write operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
-
- @param Data The data to write.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
+ @param Data The data to write.
@return None
@@ -219,13 +199,10 @@ VOID /**
32-bit I/O write operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
-
- @param Data The data to write.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
+ @param Data The data to write.
@return None
@@ -242,13 +219,10 @@ VOID /**
64-bit I/O write operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
-
- @param Data The data to write.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
+ @param Data The data to write.
@return None
@@ -265,11 +239,9 @@ VOID /**
8-bit Memory read operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
@return UINT8
@@ -285,11 +257,9 @@ UINT8 /**
16-bit Memory read operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
@return UINT16
@@ -305,11 +275,9 @@ UINT16 /**
32-bit Memory read operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
@return UINT32
@@ -325,11 +293,9 @@ UINT32 /**
64-bit Memory read operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
@return UINT64
@@ -345,13 +311,10 @@ UINT64 /**
8-bit Memory write operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
-
- @param Data The data to write.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
+ @param Data The data to write.
@return None
@@ -368,13 +331,10 @@ VOID /**
16-bit Memory write operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
-
- @param Data The data to write.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
+ @param Data The data to write.
@return None
@@ -391,13 +351,10 @@ VOID /**
32-bit Memory write operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
-
- @param Data The data to write.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
+ @param Data The data to write.
@return None
@@ -414,13 +371,10 @@ VOID /**
64-bit Memory write operations.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Address The physical address of the access.
-
- @param Data The data to write.
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Address The physical address of the access.
+ @param Data The data to write.
@return None
diff --git a/MdePkg/Include/Ppi/DeviceRecoveryModule.h b/MdePkg/Include/Ppi/DeviceRecoveryModule.h index 3847686b04..46c5cdeaae 100644 --- a/MdePkg/Include/Ppi/DeviceRecoveryModule.h +++ b/MdePkg/Include/Ppi/DeviceRecoveryModule.h @@ -34,19 +34,15 @@ typedef struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI EFI_PEI_DEVICE_RECOVERY_MODUL the capsules discovered. Entry 1 is assumed to be the highest load priority
and entry N is assumed to be the lowest priority.
- @param PeiServices General-purpose services that are available to every PEIM
-
- @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
-
- @param NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On output,
- *NumberRecoveryCapsules contains the number of recovery capsule images available
- for retrieval from this PEIM instance.
-
- @retval EFI_SUCCESS One or more capsules were discovered.
-
- @retval EFI_DEVICE_ERROR A device error occurred.
-
- @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
+ @param PeiServices General-purpose services that are available to every PEIM
+ @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
+ @param NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On output,
+ *NumberRecoveryCapsules contains the number of recovery capsule
+ images available for retrieval from this PEIM instance.
+
+ @retval EFI_SUCCESS One or more capsules were discovered.
+ @retval EFI_DEVICE_ERROR A device error occurred.
+ @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
**/
typedef
@@ -60,23 +56,17 @@ EFI_STATUS /**
This function gets the size and type of the requested recovery capsule.
- @param PeiServices General-purpose services that are available to every PEIM
-
- @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
-
+ @param PeiServices General-purpose services that are available to every PEIM
+ @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
@param CapsuleInstance Specifies for which capsule instance to retrieve the information.
-
- @param Size A pointer to a caller-allocated UINTN in which the size of
- the requested recovery module is returned.
-
- @param CapsuleType A pointer to a caller-allocated EFI_GUID in
- which the type of the requested recovery capsule is returned.
-
- @retval EFI_SUCCESS One or more capsules were discovered.
-
- @retval EFI_DEVICE_ERROR A device error occurred.
-
- @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
+ @param Size A pointer to a caller-allocated UINTN in which the size of
+ the requested recovery module is returned.
+ @param CapsuleType A pointer to a caller-allocated EFI_GUID in
+ which the type of the requested recovery capsule is returned.
+
+ @retval EFI_SUCCESS One or more capsules were discovered.
+ @retval EFI_DEVICE_ERROR A device error occurred.
+ @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
**/
typedef
@@ -93,19 +83,15 @@ EFI_STATUS This function, by whatever mechanism, retrieves a DXE capsule from some device
and loads it into memory. Note that the published interface is device neutral.
- @param PeiServices General-purpose services that are available to every PEIM
-
- @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
-
+ @param PeiServices General-purpose services that are available to every PEIM
+ @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
@param CapsuleInstance Specifies which capsule instance to retrieve.
-
- @param Buffer Specifies a caller-allocated buffer in which the requested recovery capsule will be returned.
-
- @retval EFI_SUCCESS One or more capsules were discovered.
-
- @retval EFI_DEVICE_ERROR A device error occurred.
-
- @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
+ @param Buffer Specifies a caller-allocated buffer in which the requested
+ recovery capsule will be returned.
+
+ @retval EFI_SUCCESS One or more capsules were discovered.
+ @retval EFI_DEVICE_ERROR A device error occurred.
+ @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
**/
typedef
diff --git a/MdePkg/Include/Ppi/DxeIpl.h b/MdePkg/Include/Ppi/DxeIpl.h index bed579522c..3a92135651 100644 --- a/MdePkg/Include/Ppi/DxeIpl.h +++ b/MdePkg/Include/Ppi/DxeIpl.h @@ -33,14 +33,12 @@ typedef struct _EFI_DXE_IPL_PPI EFI_DXE_IPL_PPI; The architectural PPI that the PEI Foundation invokes when
there are no additional PEIMs to invoke.
- @param This Pointer to the DXE IPL PPI instance
-
- @param PeiServices Pointer to the PEI Services Table.
-
- @param HobList Pointer to the list of Hand-Off Block (HOB) entries.
-
- @retval EFI_SUCCESS Upon this return code, the PEI Foundation should enter
- some exception handling.Under normal circumstances, the DXE IPL PPI should not return.
+ @param This Pointer to the DXE IPL PPI instance
+ @param PeiServices Pointer to the PEI Services Table.
+ @param HobList Pointer to the list of Hand-Off Block (HOB) entries.
+
+ @retval EFI_SUCCESS Upon this return code, the PEI Foundation should enter
+ some exception handling.Under normal circumstances, the DXE IPL PPI should not return.
**/
typedef
diff --git a/MdePkg/Include/Ppi/FindFv.h b/MdePkg/Include/Ppi/FindFv.h index 971512558b..9a3e173742 100644 --- a/MdePkg/Include/Ppi/FindFv.h +++ b/MdePkg/Include/Ppi/FindFv.h @@ -33,18 +33,13 @@ typedef struct _EFI_PEI_FIND_FV_PPI EFI_PEI_FIND_FV_PPI; was passed in FvNumber.Once this function reports a firmware volume
index/base address pair, that index/address pairing must continue throughout PEI.
- @param PeiServices Pointer to the PEI Services Table.
-
- @param This Interface pointer that implements the Find FV service.
-
- @param FvNumber The index of the firmware volume to locate.
-
- @param FvAddress The address of the volume to discover.
-
- @retval EFI_SUCCESS An additional firmware volume was found.
-
- @retval EFI_OUT_OF_RESOURCES There are no firmware volumes for the given FvNumber.
-
+ @param PeiServices Pointer to the PEI Services Table.
+ @param This Interface pointer that implements the Find FV service.
+ @param FvNumber The index of the firmware volume to locate.
+ @param FvAddress The address of the volume to discover.
+
+ @retval EFI_SUCCESS An additional firmware volume was found.
+ @retval EFI_OUT_OF_RESOURCES There are no firmware volumes for the given FvNumber.
@retval EFI_INVALID_PARAMETER *FvAddress is NULL.
**/
diff --git a/MdePkg/Include/Ppi/LoadFile.h b/MdePkg/Include/Ppi/LoadFile.h index af02be7c9e..f6d8a704ee 100644 --- a/MdePkg/Include/Ppi/LoadFile.h +++ b/MdePkg/Include/Ppi/LoadFile.h @@ -30,22 +30,16 @@ typedef struct _EFI_PEI_FV_FILE_LOADER_PPI EFI_PEI_FV_FILE_LOADER_PPI; /**
Loads a PEIM into memory for subsequent execution.
- @param This Interface pointer that implements the Load File PPI instance.
-
- @param FfsHeader Pointer to the FFS header of the file to load.
-
- @param ImageAddress Pointer to the address of the loaded Image
-
- @param ImageSize Pointer to the size of the loaded image.
-
- @param EntryPoint Pointer to the entry point of the image.
-
- @retval EFI_SUCCESS The image was loaded successfully.
-
- @retval EFI_OUT_OF_RESOURCES There was not enough memory.
-
- @retval EFI_INVALID_PARAMETER The contents of the FFS file did not
- contain a valid PE/COFF image that could be loaded.
+ @param This Interface pointer that implements the Load File PPI instance.
+ @param FfsHeader Pointer to the FFS header of the file to load.
+ @param ImageAddress Pointer to the address of the loaded Image
+ @param ImageSize Pointer to the size of the loaded image.
+ @param EntryPoint Pointer to the entry point of the image.
+
+ @retval EFI_SUCCESS The image was loaded successfully.
+ @retval EFI_OUT_OF_RESOURCES There was not enough memory.
+ @retval EFI_INVALID_PARAMETER The contents of the FFS file did not
+ contain a valid PE/COFF image that could be loaded.
**/
typedef
diff --git a/MdePkg/Include/Ppi/PciCfg.h b/MdePkg/Include/Ppi/PciCfg.h index b38a0db3ce..987f54ed43 100644 --- a/MdePkg/Include/Ppi/PciCfg.h +++ b/MdePkg/Include/Ppi/PciCfg.h @@ -51,19 +51,14 @@ typedef struct { /**
PCI read and write operation.
- @param PeiServices An indirect pointer to the PEI Services Table
- published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Width The width of the access. Enumerated in bytes.
-
- @param Address The physical address of the access.
-
- @param Buffer A pointer to the buffer of data.
-
- @retval EFI_SUCCESS The function completed successfully.
-
+ @param PeiServices An indirect pointer to the PEI Services Table
+ published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Width The width of the access. Enumerated in bytes.
+ @param Address The physical address of the access.
+ @param Buffer A pointer to the buffer of data.
+
+ @retval EFI_SUCCESS The function completed successfully.
@retval EFI_NOT_YET_AVAILABLE The service has not been installed.
**/
@@ -80,20 +75,15 @@ EFI_STATUS /**
PCI read-modify-write operation.
- @param PeiServices An indirect pointer to the PEI Services Table
- published by the PEI Foundation.
-
- @param This Pointer to local data for the interface.
-
- @param Width The width of the access. Enumerated in bytes.
-
- @param Address The physical address of the access.
-
- @param SetBits Value of the bits to set.
-
- @param ClearBits Value of the bits to clear.
-
- @retval EFI_SUCCESS The function completed successfully.
+ @param PeiServices An indirect pointer to the PEI Services Table
+ published by the PEI Foundation.
+ @param This Pointer to local data for the interface.
+ @param Width The width of the access. Enumerated in bytes.
+ @param Address The physical address of the access.
+ @param SetBits Value of the bits to set.
+ @param ClearBits Value of the bits to clear.
+
+ @retval EFI_SUCCESS The function completed successfully.
**/
typedef
@@ -119,7 +109,7 @@ EFI_STATUS PCI write services. See the Write() function description.
@param Modify
-PCI read-modify-write services. See the Modify() function description.
+ PCI read-modify-write services. See the Modify() function description.
**/
struct _EFI_PEI_PCI_CFG_PPI {
diff --git a/MdePkg/Include/Ppi/ReadOnlyVariable.h b/MdePkg/Include/Ppi/ReadOnlyVariable.h index 3ea3c77535..e730ce8493 100644 --- a/MdePkg/Include/Ppi/ReadOnlyVariable.h +++ b/MdePkg/Include/Ppi/ReadOnlyVariable.h @@ -39,29 +39,20 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI EFI_PEI_READ_ONLY_VARIABLE_PPI; /**
Get Variable value by Name and GUID pair
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
- @param VariableName A NULL-terminated Unicode string that is the name of the vendor¡¯s variable.
-
- @param VendorGuid A unique identifier for the vendor.
-
- @param Attributes If not NULL, a pointer to the memory location to return
- the attributes bitmask for the variable.
-
- @param DataSize On input, the size in bytes of the return Data buffer.
- On output, the size of data returned in Data.
-
- @param Data The buffer to return the contents of the variable.
-
- @retval EFI_SUCCESS The function completed successfully.
-
- @retval EFI_NOT_FOUND The variable was not found.
-
- @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.
-
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
+ @param VariableName A NULL-terminated Unicode string that is the name of the vendor¡¯s variable.
+ @param VendorGuid A unique identifier for the vendor.
+ @param Attributes If not NULL, a pointer to the memory location to return
+ the attributes bitmask for the variable.
+ @param DataSize On input, the size in bytes of the return Data buffer.
+ On output, the size of data returned in Data.
+ @param Data The buffer to return the contents of the variable.
+
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_NOT_FOUND The variable was not found.
+ @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
-
- @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
+ @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
**/
typedef
@@ -82,27 +73,20 @@ EFI_STATUS and on output the interface returns the next variable name data. When the
entire variable list has been returned, the error EFI_NOT_FOUND is returned.
- @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
-
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
@param VariableNameSize The size of the VariableName buffer.
-
- @param VariableName On input, supplies the last VariableName that was
- returned by GetNextVariableName(). On output, returns the Null-terminated
- Unicode string of the current variable.
-
- @param VendorGuid On input, supplies the last VendorGuid that was
- returned by GetNextVariableName(). On output, returns the VendorGuid
- of the current variable.
-
- @retval EFI_SUCCESS The function completed successfully.
-
- @retval EFI_NOT_FOUND The next variable was not found.
-
- @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
-
+ @param VariableName On input, supplies the last VariableName that was
+ returned by GetNextVariableName(). On output, returns the Null-terminated
+ Unicode string of the current variable.
+ @param VendorGuid On input, supplies the last VendorGuid that was
+ returned by GetNextVariableName(). On output, returns the VendorGuid
+ of the current variable.
+
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_NOT_FOUND The next variable was not found.
+ @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
-
- @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to a hardware error.
+ @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to a hardware error.
**/
typedef
diff --git a/MdePkg/Include/Ppi/RecoveryModule.h b/MdePkg/Include/Ppi/RecoveryModule.h index 044a68aa72..8dbb951df5 100644 --- a/MdePkg/Include/Ppi/RecoveryModule.h +++ b/MdePkg/Include/Ppi/RecoveryModule.h @@ -32,15 +32,12 @@ typedef struct _EFI_PEI_RECOVERY_MODULE_PPI EFI_PEI_RECOVERY_MODULE_PPI; Loads a DXE capsule from some media into memory and updates the HOB table
with the DXE firmware volume information.
- @param PeiServices General-purpose services that are available to every PEIM.
-
- @param This Indicates the EFI_PEI_RECOVERY_MODULE_PPI instance.
-
- @retval EFI_SUCCESS The capsule was loaded correctly.
-
- @retval EFI_DEVICE_ERROR A device error occurred.
-
- @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
+ @param PeiServices General-purpose services that are available to every PEIM.
+ @param This Indicates the EFI_PEI_RECOVERY_MODULE_PPI instance.
+
+ @retval EFI_SUCCESS The capsule was loaded correctly.
+ @retval EFI_DEVICE_ERROR A device error occurred.
+ @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
**/
typedef
diff --git a/MdePkg/Include/Ppi/S3Resume.h b/MdePkg/Include/Ppi/S3Resume.h index c458430b98..c5c02595f7 100644 --- a/MdePkg/Include/Ppi/S3Resume.h +++ b/MdePkg/Include/Ppi/S3Resume.h @@ -32,12 +32,11 @@ typedef struct _EFI_PEI_S3_RESUME_PPI EFI_PEI_S3_RESUME_PPI; Restores the platform to its preboot configuration for an S3 resume and
jumps to the OS waking vector.
- @param PeiServices Pointer to the PEI Services Table
+ @param PeiServices Pointer to the PEI Services Table
- @retval EFI_ABORTED Execution of the S3 resume boot script table failed.
-
- @retval EFI_NOT_FOUND Some necessary information that is used for
- the S3 resume boot path could not be located.
+ @retval EFI_ABORTED Execution of the S3 resume boot script table failed.
+ @retval EFI_NOT_FOUND Some necessary information that is used for
+ the S3 resume boot path could not be located.
**/
typedef
diff --git a/MdePkg/Include/Ppi/SecPlatformInformation.h b/MdePkg/Include/Ppi/SecPlatformInformation.h index 1e9625923c..b7dd03e6ce 100644 --- a/MdePkg/Include/Ppi/SecPlatformInformation.h +++ b/MdePkg/Include/Ppi/SecPlatformInformation.h @@ -54,15 +54,12 @@ typedef struct { /**
This interface conveys state information out of the Security (SEC) phase into PEI.
- @param PeiServices Pointer to the PEI Services Table.
-
- @param StructureSize Pointer to the variable describing size of the input buffer.
-
- @param PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.
-
- @retval EFI_SUCCESS The data was successfully returned.
-
- @retval EFI_BUFFER_TOO_SMALL The buffer was too small.
+ @param PeiServices Pointer to the PEI Services Table.
+ @param StructureSize Pointer to the variable describing size of the input buffer.
+ @param PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.
+
+ @retval EFI_SUCCESS The data was successfully returned.
+ @retval EFI_BUFFER_TOO_SMALL The buffer was too small.
**/
typedef
diff --git a/MdePkg/Include/Ppi/SectionExtraction.h b/MdePkg/Include/Ppi/SectionExtraction.h index afa473d9ef..fb95f6065a 100644 --- a/MdePkg/Include/Ppi/SectionExtraction.h +++ b/MdePkg/Include/Ppi/SectionExtraction.h @@ -41,50 +41,40 @@ typedef struct _EFI_PEI_SECTION_EXTRACTION_PPI EFI_PEI_SECTION_EXTRACTION_PPI; It will retrieve both encapsulation sections and leaf sections in their entirety,
exclusive of the section header.
- @param PeiServices Pointer to the PEI Services Table.
-
- @param This Indicates the calling context
-
- @param SectionType Pointer to an EFI_SECTION_TYPE. If SectionType == NULL,
- the contents of the entire section are returned in Buffer. If SectionType
- is not NULL, only the requested section is returned.
-
- @param SectionDefinitionGuid Pointer to an EFI_GUID.
- If SectionType == EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid
- indicates for which section GUID to search.
- If SectionType != EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid
- is unused and is ignored.
-
- @param SectionInstance If SectionType is not NULL, indicates which
- instance of the requested section type to return.
-
- @param Buffer Pointer to a pointer to a buffer in which the section
- contents are returned.
-
- @param BufferSize A pointer to a caller-allocated UINT32.On input, *BufferSize
- indicates the size in bytes of the memory region pointed to by Buffer.On output,
- *BufferSize contains the number of bytes required to read the section.
-
- @param AuthenticationStatus A pointer to a caller-allocated UINT32 in
- which any metadata from encapsulating GUID-defined sections is returned.
-
- @retval EFI_SUCCESS The section was successfully processed and the section
- contents were returned in Buffer.
-
- @retval EFI_PROTOCOL_ERROR A GUID-defined section was encountered in
- the file with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set, but
- there was no corresponding GUIDed Section Extraction Protocol in the
- handle database.*Buffer is unmodified.
-
- @retval EFI_NOT_FOUND The requested section does not exist.*Buffer is unmodified.
-
- @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process the request.
-
+ @param PeiServices Pointer to the PEI Services Table.
+ @param This Indicates the calling context
+ @param SectionType Pointer to an EFI_SECTION_TYPE. If SectionType == NULL,
+ the contents of the entire section are returned in Buffer. If SectionType
+ is not NULL, only the requested section is returned.
+ @param SectionDefinitionGuid
+ Pointer to an EFI_GUID.
+ If SectionType == EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid
+ indicates for which section GUID to search.
+ If SectionType != EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid
+ is unused and is ignored.
+ @param SectionInstance If SectionType is not NULL, indicates which
+ instance of the requested section type to return.
+ @param Buffer Pointer to a pointer to a buffer in which the section
+ contents are returned.
+ @param BufferSize A pointer to a caller-allocated UINT32.On input, *BufferSize
+ indicates the size in bytes of the memory region pointed to by Buffer.On output,
+ *BufferSize contains the number of bytes required to read the section.
+ @param AuthenticationStatus
+ A pointer to a caller-allocated UINT32 in
+ which any metadata from encapsulating GUID-defined sections is returned.
+
+ @retval EFI_SUCCESS The section was successfully processed and the section
+ contents were returned in Buffer.
+ @retval EFI_PROTOCOL_ERROR A GUID-defined section was encountered in
+ the file with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set, but
+ there was no corresponding GUIDed Section Extraction Protocol in the
+ handle database.*Buffer is unmodified.
+ @retval EFI_NOT_FOUND The requested section does not exist.*Buffer is unmodified.
+ @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process the request.
@retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.
-
- @retval EFI_WARN_TOO_SMALL The size of the input buffer is insufficient to
- contain the requested section. The input buffer is filled and contents are
- section contents are truncated.
+ @retval EFI_WARN_TOO_SMALL The size of the input buffer is insufficient to
+ contain the requested section. The input buffer is filled and contents are
+ section contents are truncated.
**/
typedef
diff --git a/MdePkg/Include/Ppi/Security.h b/MdePkg/Include/Ppi/Security.h index cc59023bf5..b0f0626406 100644 --- a/MdePkg/Include/Ppi/Security.h +++ b/MdePkg/Include/Ppi/Security.h @@ -32,18 +32,14 @@ typedef struct _EFI_PEI_SECURITY_PPI EFI_PEI_SECURITY_PPI; Allows the platform builder to implement a security policy in response
to varying file authentication states.
- @param PeiServices Pointer to the PEI Services Table.
-
- @param This Interface pointer that implements the particular EFI_PEI_SECURITY_PPI instance.
-
- @param AuthenticationStatus Status returned by the verification service as part of section extraction.
-
- @param FfsFileHeader Pointer to the file under review.
-
+ @param PeiServices Pointer to the PEI Services Table.
+ @param This Interface pointer that implements the particular EFI_PEI_SECURITY_PPI instance.
+ @param AuthenticationStatus
+ Status returned by the verification service as part of section extraction.
+ @param FfsFileHeader Pointer to the file under review.
@param DeferExecution Pointer to a variable that alerts the PEI Foundation to defer execution of a PEIM.
- @retval EFI_SUCCESS The service performed its action successfully.
-
+ @retval EFI_SUCCESS The service performed its action successfully.
@retval EFI_SECURITY_VIOLATION The object cannot be trusted
**/
diff --git a/MdePkg/Include/Ppi/Smbus.h b/MdePkg/Include/Ppi/Smbus.h index 7360e5b12f..c0e1d9022d 100644 --- a/MdePkg/Include/Ppi/Smbus.h +++ b/MdePkg/Include/Ppi/Smbus.h @@ -31,48 +31,34 @@ typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI; /**
Executes an SMBus operation to an SMBus controller.
- @param PeiServices A pointer to the system PEI Services Table.
-
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
-
- @param SlaveAddress The SMBUS hardware address to which the SMBUS
- device is preassigned or allocated.
-
- @param Command This command is transmitted by the SMBus host
- controller to the SMBus slave device and the interpretation is
- SMBus slave device specific.
-
- @param Operation Signifies which particular SMBus hardware protocol
- instance that it will use to execute the SMBus transactions.
-
- @param PecCheck Defines if Packet Error Code (PEC) checking is required
- for this operation.
-
- @param Length Signifies the number of bytes that this operation will do.
-
- @param Buffer Contains the value of data to execute to the SMBus slave device.
-
- @retval EFI_SUCCESS The last data that was returned from the access
- matched the poll exit criteria.
-
- @retval EFI_CRC_ERROR The checksum is not correct (PEC is incorrect)
-
- @retval EFI_TIMEOUT Timeout expired before the operation was completed.
- Timeout is determined by the SMBus host controller device.
-
- @retval EFI_OUT_OF_RESOURCES The request could not be completed
- due to a lack of resources.
-
- @retval EFI_DEVICE_ERROR The request was not completed because
- a failure reflected in the Host Status Register bit.
-
+ @param PeiServices A pointer to the system PEI Services Table.
+ @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
+ @param SlaveAddress The SMBUS hardware address to which the SMBUS
+ device is preassigned or allocated.
+ @param Command This command is transmitted by the SMBus host
+ controller to the SMBus slave device and the interpretation is
+ SMBus slave device specific.
+ @param Operation Signifies which particular SMBus hardware protocol
+ instance that it will use to execute the SMBus transactions.
+ @param PecCheck Defines if Packet Error Code (PEC) checking is required
+ for this operation.
+ @param Length Signifies the number of bytes that this operation will do.
+ @param Buffer Contains the value of data to execute to the SMBus slave device.
+
+ @retval EFI_SUCCESS The last data that was returned from the access
+ matched the poll exit criteria.
+ @retval EFI_CRC_ERROR The checksum is not correct (PEC is incorrect)
+ @retval EFI_TIMEOUT Timeout expired before the operation was completed.
+ Timeout is determined by the SMBus host controller device.
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed
+ due to a lack of resources.
+ @retval EFI_DEVICE_ERROR The request was not completed because
+ a failure reflected in the Host Status Register bit.
@retval EFI_INVALID_PARAMETER Operation is not defined in EFI_SMBUS_OPERATION.
- Or Length/Buffer is NULL for operations except for EfiSmbusQuickRead and
- EfiSmbusQuickWrite. Length is outside the range of valid values.
-
- @retval EFI_UNSUPPORTED The SMBus operation or PEC is not supported.
-
- @retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation.
+ Or Length/Buffer is NULL for operations except for EfiSmbusQuickRead and
+ EfiSmbusQuickWrite. Length is outside the range of valid values.
+ @retval EFI_UNSUPPORTED The SMBus operation or PEC is not supported.
+ @retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation.
**/
typedef
@@ -102,15 +88,12 @@ typedef struct { /**
CallBack function can be registered in EFI_PEI_SMBUS_PPI_NOTIFY.
- @param PeiServices A pointer to the system PEI Services Table.
-
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
-
- @param SlaveAddress The SMBUS hardware address to which the SMBUS
- device is preassigned or allocated.
-
- @param Data Data of the SMBus host notify command that
- the caller wants to be called.
+ @param PeiServices A pointer to the system PEI Services Table.
+ @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
+ @param SlaveAddress The SMBUS hardware address to which the SMBUS
+ device is preassigned or allocated.
+ @param Data Data of the SMBus host notify command that
+ the caller wants to be called.
@return Status Code
@@ -128,32 +111,24 @@ EFI_STATUS The ArpDevice() function enumerates the entire bus or enumerates a specific
device that is identified by SmbusUdid.
- @param PeiServices A pointer to the system PEI Services Table.
-
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
-
- @param ArpAll A Boolean expression that indicates if the host drivers need
- to enumerate all the devices or enumerate only the device that is identified
- by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional.
- If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address
- will be at SlaveAddress.
-
- @param SmbusUdid The targeted SMBus Unique Device Identifier (UDID).
- The UDID may not exist for SMBus devices with fixed addresses.
-
- @param SlaveAddress The new SMBus address for the slave device for
- which the operation is targeted.
-
- @retval EFI_SUCCESS The SMBus slave device address was set.
-
+ @param PeiServices A pointer to the system PEI Services Table.
+ @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
+ @param ArpAll A Boolean expression that indicates if the host drivers need
+ to enumerate all the devices or enumerate only the device that is identified
+ by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional.
+ If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address
+ will be at SlaveAddress.
+ @param SmbusUdid The targeted SMBus Unique Device Identifier (UDID).
+ The UDID may not exist for SMBus devices with fixed addresses.
+ @param SlaveAddress The new SMBus address for the slave device for
+ which the operation is targeted.
+
+ @retval EFI_SUCCESS The SMBus slave device address was set.
@retval EFI_INVALID_PARAMETER SlaveAddress is NULL.
-
- @retval EFI_OUT_OF_RESOURCES The request could not be completed
- due to a lack of resources.
-
- @retval EFI_TIMEOUT The SMBus slave device did not respond.
-
- @retval EFI_DEVICE_ERROR The request was not completed because the transaction failed.
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed
+ due to a lack of resources.
+ @retval EFI_TIMEOUT The SMBus slave device did not respond.
+ @retval EFI_DEVICE_ERROR The request was not completed because the transaction failed.
**/
typedef
@@ -175,16 +150,13 @@ typedef struct { The GetArpMap() function returns the mapping of all the SMBus devices
that are enumerated by the SMBus host driver.
- @param PeiServices A pointer to the system PEI Services Table.
-
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
-
- @param Length Size of the buffer that contains the SMBus device map.
-
- @param SmbusDeviceMap The pointer to the device map as enumerated
- by the SMBus controller driver.
+ @param PeiServices A pointer to the system PEI Services Table.
+ @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
+ @param Length Size of the buffer that contains the SMBus device map.
+ @param SmbusDeviceMap The pointer to the device map as enumerated
+ by the SMBus controller driver.
- @retval EFI_SUCCESS The device map was returned correctly in the buffer.
+ @retval EFI_SUCCESS The device map was returned correctly in the buffer.
**/
typedef
@@ -200,20 +172,16 @@ EFI_STATUS The Notify() function registers all the callback functions to allow the
bus driver to call these functions when the SlaveAddress/Data pair happens.
- @param PeiServices A pointer to the system PEI Services Table.
-
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
-
- @param SlaveAddress Address that the host controller detects as
- sending a message and calls all the registered functions.
-
- @param Data Data that the host controller detects as sending a message
- and calls all the registered functions.
-
- @param NotifyFunction The function to call when the bus driver
- detects the SlaveAddress and Data pair.
-
- @retval EFI_SUCCESS NotifyFunction has been registered.
+ @param PeiServices A pointer to the system PEI Services Table.
+ @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
+ @param SlaveAddress Address that the host controller detects as
+ sending a message and calls all the registered functions.
+ @param Data Data that the host controller detects as sending a message
+ and calls all the registered functions.
+ @param NotifyFunction The function to call when the bus driver
+ detects the SlaveAddress and Data pair.
+
+ @retval EFI_SUCCESS NotifyFunction has been registered.
**/
typedef
diff --git a/MdePkg/Include/Ppi/Stall.h b/MdePkg/Include/Ppi/Stall.h index 363baa6d39..a54e7ce640 100644 --- a/MdePkg/Include/Ppi/Stall.h +++ b/MdePkg/Include/Ppi/Stall.h @@ -34,14 +34,12 @@ typedef struct _EFI_PEI_STALL_PPI EFI_PEI_STALL_PPI; The Stall() function provides a blocking stall for at least the number
of microseconds stipulated in the final argument of the API.
- @param PeiServices An indirect pointer to the PEI Services Table
- published by the PEI Foundation.
-
- @param This Pointer to the local data for the interface.
-
- @param Microseconds Number of microseconds for which to stall.
-
- @retval EFI_SUCCESS The service provided at least the required delay.
+ @param PeiServices An indirect pointer to the PEI Services Table
+ published by the PEI Foundation.
+ @param This Pointer to the local data for the interface.
+ @param Microseconds Number of microseconds for which to stall.
+
+ @retval EFI_SUCCESS The service provided at least the required delay.
**/
typedef
diff --git a/MdePkg/Include/Protocol/AcpiSupport.h b/MdePkg/Include/Protocol/AcpiSupport.h index 790cdf2b3e..5702cb4d65 100644 --- a/MdePkg/Include/Protocol/AcpiSupport.h +++ b/MdePkg/Include/Protocol/AcpiSupport.h @@ -64,19 +64,14 @@ typedef struct _EFI_ACPI_SUPPORT_PROTOCOL EFI_ACPI_SUPPORT_PROTOCOL; /**
Returns a requested ACPI table.
- @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.
-
- @param Index The zero-based index of the table to retrieve.
-
- @param Table Pointer for returning the table buffer.
-
- @param Version Updated with the ACPI versions to which this table belongs.
-
- @param Handle Pointer for identifying the table.
+ @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.
+ @param Index The zero-based index of the table to retrieve.
+ @param Table Pointer for returning the table buffer.
+ @param Version Updated with the ACPI versions to which this table belongs.
+ @param Handle Pointer for identifying the table.
- @retval EFI_SUCCESS The function completed successfully.
-
- @retval EFI_NOT_FOUND The requested index is too large and a table was not found.
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_NOT_FOUND The requested index is too large and a table was not found.
**/
typedef
@@ -92,22 +87,16 @@ EFI_STATUS /**
Used to add, remove, or update ACPI tables.
- @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.
-
- @param Table Pointer to the new table to add or update.
-
- @param Checksum If TRUE, indicates that the checksum should be
- calculated for this table.
-
- @param Version Indicates to which version(s) of ACPI the table should be added.
-
- @param Pointer to the handle of the table to remove or update.
+ @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.
+ @param Table Pointer to the new table to add or update.
+ @param Checksum If TRUE, indicates that the checksum should be
+ calculated for this table.
+ @param Version Indicates to which version(s) of ACPI the table should be added.
+ @param Pointer to the handle of the table to remove or update.
- @retval EFI_SUCCESS The function completed successfully.
-
+ @retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER *Handle was zero and Table was NULL.
-
- @retval EFI_ABORTED Could not complete the desired action.
+ @retval EFI_ABORTED Could not complete the desired action.
**/
typedef
@@ -124,13 +113,11 @@ EFI_STATUS Causes one or more versions of the ACPI tables to be published in
the EFI system configuration tables.
- @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.
-
- @param Version Indicates to which version(s) of ACPI that the table should be published.
+ @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.
+ @param Version Indicates to which version(s) of ACPI that the table should be published.
- @retval EFI_SUCCESS The function completed successfully.
-
- @retval EFI_ABORTED An error occurred and the function could not complete successfully.
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_ABORTED An error occurred and the function could not complete successfully.
**/
typedef
diff --git a/MdePkg/Include/Protocol/Bis.h b/MdePkg/Include/Protocol/Bis.h index ffc66f622a..138a3270fa 100644 --- a/MdePkg/Include/Protocol/Bis.h +++ b/MdePkg/Include/Protocol/Bis.h @@ -136,7 +136,7 @@ typedef struct { version numbers are updated with the major and minor version
numbers of the interface
@param TargetAddress Indicates a network or device address of the BIS platform to connect to.
-
+
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INCOMPATIBLE_VERSION The InterfaceVersion.Major requested by the
caller was not compatible with the interface version of the
@@ -164,7 +164,7 @@ EFI_STATUS @param AppHandle An opaque handle that identifies the caller¡¯s instance of initialization
of the BIS service.
@param ToFree An EFI_BIS_DATA* and associated memory block to be freed.
-
+
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid
application instance handle associated with the EFI_BIS protocol.
@@ -186,7 +186,7 @@ EFI_STATUS @param AppHandle An opaque handle that identifies the caller¡¯s instance of initialization
of the BIS service.
-
+
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid
application instance handle associated with the EFI_BIS protocol.
@@ -208,7 +208,7 @@ EFI_STATUS of the BIS service.
@param Certificate The function writes an allocated EFI_BIS_DATA* containing the Boot
Object Authorization Certificate object.
-
+
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid
application instance handle associated with the EFI_BIS protocol.
diff --git a/MdePkg/Include/Protocol/BootScriptSave.h b/MdePkg/Include/Protocol/BootScriptSave.h index 4dff3a9b0a..ae4d862cc4 100644 --- a/MdePkg/Include/Protocol/BootScriptSave.h +++ b/MdePkg/Include/Protocol/BootScriptSave.h @@ -36,20 +36,15 @@ typedef struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL EFI_BOOT_SCRIPT_SAVE_PROTOCOL; /**
Adds a record into a specified Framework boot script table.
- @param This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.
-
- @param TableName Name of the script table.Currently, the only meaningful
- value is EFI_ACPI_S3_RESUME_SCRIPT_TABLE.
-
- @param OpCode The operation code (opcode) number.
-
- @param ... Argument list that is specific to each opcode.
-
- @retval EFI_SUCCESS The operation succeeded. A record was added into the specified script table.
-
+ @param This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.
+ @param TableName Name of the script table.Currently, the only meaningful
+ value is EFI_ACPI_S3_RESUME_SCRIPT_TABLE.
+ @param OpCode The operation code (opcode) number.
+ @param ... Argument list that is specific to each opcode.
+
+ @retval EFI_SUCCESS The operation succeeded. A record was added into the specified script table.
@retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported.
-
- @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.
+ @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.
**/
typedef
@@ -64,17 +59,13 @@ EFI_STATUS /**
Closes the specified script table.
- @param This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.
-
- @param TableName Name of the script table.
-
- @param Address A pointer to the physical address where the table begins.
-
- @retval EFI_SUCCESS The table was successfully returned.
-
- @retval EFI_NOT_FOUND The specified table was not created previously.
-
- @retval EFI_OUT_OF_RESOURCES Memory is insufficient to hold the reorganized boot script table.
+ @param This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.
+ @param TableName Name of the script table.
+ @param Address A pointer to the physical address where the table begins.
+
+ @retval EFI_SUCCESS The table was successfully returned.
+ @retval EFI_NOT_FOUND The specified table was not created previously.
+ @retval EFI_OUT_OF_RESOURCES Memory is insufficient to hold the reorganized boot script table.
**/
typedef
diff --git a/MdePkg/Include/Protocol/CpuIo.h b/MdePkg/Include/Protocol/CpuIo.h index 619878c042..d7fce60415 100644 --- a/MdePkg/Include/Protocol/CpuIo.h +++ b/MdePkg/Include/Protocol/CpuIo.h @@ -58,24 +58,18 @@ typedef enum { Enables a driver to access memory-mapped registers in the EFI system memory space.
Or, Enables a driver to access registers in the EFI CPU I/O space.
- @param This A pointer to the EFI_CPU_IO_PROTOCOL instance.
-
- @param Width Signifies the width of the I/O or Memory operation.
-
- @param Address The base address of the I/O or Memoryoperation.
-
- @param Count The number of I/O or Memory operations to perform.
- The number of bytes moved is Width size * Count, starting at Address.
-
- @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 EFI system.
-
+ @param This A pointer to the EFI_CPU_IO_PROTOCOL instance.
+ @param Width Signifies the width of the I/O or Memory operation.
+ @param Address The base address of the I/O or Memoryoperation.
+ @param Count The number of I/O or Memory operations to perform.
+ The number of bytes moved is Width size * Count, starting at Address.
+ @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 EFI system.
@retval EFI_INVALID_PARAMETER Width is invalid for this EFI system.Or Buffer is NULL.
-
- @retval EFI_UNSUPPORTED The Buffer is not aligned for the given Width.
- Or,The address range specified by Address, Width, and Count is not valid for this EFI system.
+ @retval EFI_UNSUPPORTED The Buffer is not aligned for the given Width.
+ Or,The address range specified by Address, Width, and Count is not valid for this EFI system.
**/
typedef
diff --git a/MdePkg/Include/Protocol/DataHub.h b/MdePkg/Include/Protocol/DataHub.h index 15d3cc618e..affe4b870a 100644 --- a/MdePkg/Include/Protocol/DataHub.h +++ b/MdePkg/Include/Protocol/DataHub.h @@ -78,22 +78,15 @@ typedef struct _EFI_DATA_HUB_PROTOCOL EFI_DATA_HUB_PROTOCOL; /**
Logs a data record to the system event log.
- @param This The EFI_DATA_HUB_PROTOCOL instance.
-
+ @param This The EFI_DATA_HUB_PROTOCOL instance.
@param description
-
- @param DataRecordGuid A GUID that indicates the format of the data passed into RawData.
-
- @param ProducerName A GUID that indicates the identity of the caller to this API.
-
- @param DataRecordClass This class indicates the generic type of the data record.
-
- @param RawData The DataRecordGuid-defined data to be logged.
-
- @param RawDataSize The size in bytes of RawData.
-
- @retval EFI_SUCCESS Data was logged.
-
+ @param DataRecordGuid A GUID that indicates the format of the data passed into RawData.
+ @param ProducerName A GUID that indicates the identity of the caller to this API.
+ @param DataRecordClass This class indicates the generic type of the data record.
+ @param RawData The DataRecordGuid-defined data to be logged.
+ @param RawDataSize The size in bytes of RawData.
+
+ @retval EFI_SUCCESS Data was logged.
@retval EFI_OUT_OF_RESOURCES Data was not logged due to lack of system resources.
**/
@@ -111,29 +104,23 @@ EFI_STATUS /**
Allows the system data log to be searched.
- @param This The EFI_DATA_HUB_PROTOCOL instance.
-
- @param MonotonicCount On input, it specifies the Record to return.
- An input of zero means to return the first record.
-
- @param FilterDriver If FilterDriver is not passed in a MonotonicCount of zero,
- it means to return the first data record. If FilterDriver is passed in,
- then a MonotonicCount of zero means to return the first data not yet read
- by FilterDriver.
-
- @param Record Returns a dynamically allocated memory buffer with a data
- record that matches MonotonicCount.
-
- @retval EFI_SUCCESS Data was returned in Record.
-
- @retval EFI_INVALID_PARAMETER FilterDriver was passed in but does not exist.
-
- @retval EFI_NOT_FOUND MonotonicCount does not match any data record
- in the system. If a MonotonicCount of zero was passed in, then no
- data records exist in the system.
-
- @retval EFI_OUT_OF_RESOURCES Record was not returned due to lack
- of system resources.
+ @param This The EFI_DATA_HUB_PROTOCOL instance.
+ @param MonotonicCount On input, it specifies the Record to return.
+ An input of zero means to return the first record.
+ @param FilterDriver If FilterDriver is not passed in a MonotonicCount of zero,
+ it means to return the first data record. If FilterDriver is passed in,
+ then a MonotonicCount of zero means to return the first data not yet read
+ by FilterDriver.
+ @param Record Returns a dynamically allocated memory buffer with a data
+ record that matches MonotonicCount.
+
+ @retval EFI_SUCCESS Data was returned in Record.
+ @retval EFI_INVALID_PARAMETER FilterDriver was passed in but does not exist.
+ @retval EFI_NOT_FOUND MonotonicCount does not match any data record
+ in the system. If a MonotonicCount of zero was passed in, then no
+ data records exist in the system.
+ @retval EFI_OUT_OF_RESOURCES Record was not returned due to lack
+ of system resources.
**/
typedef
@@ -148,28 +135,22 @@ EFI_STATUS /**
Registers an event to be signaled every time a data record is logged in the system.
- @param This The EFI_DATA_HUB_PROTOCOL instance.
-
- @param FilterEvent The EFI_EVENT to signal whenever data that matches
- FilterClass is logged in the system.
-
- @param FilterTpl The maximum EFI_TPL at which FilterEvent can be signaled.
- It is strongly recommended that you use the lowest EFI_TPL possible.
-
- @param FilterClass FilterEvent will be signaled whenever a bit
- in EFI_DATA_RECORD_HEADER.DataRecordClass is also set in FilterClass.
- If FilterClass is zero, no class-based filtering will be performed.
-
- @param FilterDataRecordGuid FilterEvent will be signaled whenever
- FilterDataRecordGuid matches EFI_DATA_RECORD_HEADER.DataRecordGuid.
- If FilterDataRecordGuid is NULL, then no GUID-based filtering will be performed.
-
- @retval EFI_SUCCESS The filter driver event was registered
-
- @retval EFI_ALREADY_STARTED FilterEvent was previously registered and cannot be registered again.
-
+ @param This The EFI_DATA_HUB_PROTOCOL instance.
+ @param FilterEvent The EFI_EVENT to signal whenever data that matches
+ FilterClass is logged in the system.
+ @param FilterTpl The maximum EFI_TPL at which FilterEvent can be signaled.
+ It is strongly recommended that you use the lowest EFI_TPL possible.
+ @param FilterClass FilterEvent will be signaled whenever a bit
+ in EFI_DATA_RECORD_HEADER.DataRecordClass is also set in FilterClass.
+ If FilterClass is zero, no class-based filtering will be performed.
+ @param FilterDataRecordGuid FilterEvent will be signaled whenever
+ FilterDataRecordGuid matches EFI_DATA_RECORD_HEADER.DataRecordGuid.
+ If FilterDataRecordGuid is NULL, then no GUID-based filtering will be performed.
+
+ @retval EFI_SUCCESS The filter driver event was registered
+ @retval EFI_ALREADY_STARTED FilterEvent was previously registered and cannot be registered again.
@retval EFI_OUT_OF_RESOURCES The filter driver event was not registered
- due to lack of system resources.
+ due to lack of system resources.
**/
typedef
@@ -185,14 +166,12 @@ EFI_STATUS /**
Stops a filter driver from being notified when data records are logged.
- @param This The EFI_DATA_HUB_PROTOCOL instance.
-
- @param FilterEvent The EFI_EVENT to remove from the list of events to be
- signaled every time errors are logged.
+ @param This The EFI_DATA_HUB_PROTOCOL instance.
+ @param FilterEvent The EFI_EVENT to remove from the list of events to be
+ signaled every time errors are logged.
- @retval EFI_SUCCESS The filter driver represented by FilterEvent was shut off.
-
- @retval EFI_NOT_FOUND FilterEvent did not exist.
+ @retval EFI_SUCCESS The filter driver represented by FilterEvent was shut off.
+ @retval EFI_NOT_FOUND FilterEvent did not exist.
**/
typedef
diff --git a/MdePkg/Include/Protocol/DeviceIo.h b/MdePkg/Include/Protocol/DeviceIo.h index 0d70632fd9..643c810a34 100644 --- a/MdePkg/Include/Protocol/DeviceIo.h +++ b/MdePkg/Include/Protocol/DeviceIo.h @@ -47,7 +47,7 @@ typedef enum { @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 to write data from.
-
+
@retval EFI_SUCCESS The data was read from or written to the device.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
@retval EFI_INVALID_PARAMETER Width is invalid.
@@ -76,7 +76,7 @@ typedef struct { is going to be returned.
@param PciDevicePath A pointer to the pointer for the EFI Device Path for PciAddress.
Memory for the Device Path is allocated from the pool.
-
+
@retval EFI_SUCCESS The PciDevicePath returns a pointer to a valid EFI Device Path.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
@retval EFI_UNSUPPORTED The PciAddress does not map to a valid EFI Device Path.
@@ -106,7 +106,7 @@ typedef enum { @param DeviceAddress The resulting map address for the bus master device to use to access the
hosts HostAddress.
@param Mapping A resulting value to pass to Unmap().
-
+
@retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
@retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer.
@@ -130,7 +130,7 @@ EFI_STATUS @param This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
@param Mapping A resulting value to pass to Unmap().
-
+
@retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.
@retval EFI_DEVICE_ERROR The system hardware could not map the requested address.
@@ -151,7 +151,7 @@ EFI_STATUS EfiRuntimeServicesData.
@param Pages The number of pages to allocate.
@param HostAddress A pointer to store the base address of the allocated range.
-
+
@retval EFI_SUCCESS The requested memory pages were allocated.
@retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.
@retval EFI_INVALID_PARAMETER The requested memory type is invalid.
@@ -173,7 +173,7 @@ EFI_STATUS Flushes any posted write data to the device.
@param This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
-
+
@retval EFI_SUCCESS The buffers were flushed.
@retval EFI_DEVICE_ERROR The buffers were not flushed due to a hardware error.
@@ -190,7 +190,7 @@ EFI_STATUS @param This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
@param Pages The number of pages to free.
@param HostAddress The base address of the range to free.
-
+
@retval EFI_SUCCESS The requested memory pages were allocated.
@retval EFI_NOT_FOUND The requested memory pages were not allocated with
AllocateBuffer().
diff --git a/MdePkg/Include/Protocol/FirmwareVolume.h b/MdePkg/Include/Protocol/FirmwareVolume.h index 7f86dbb853..310ea83138 100644 --- a/MdePkg/Include/Protocol/FirmwareVolume.h +++ b/MdePkg/Include/Protocol/FirmwareVolume.h @@ -82,8 +82,8 @@ typedef UINT64 EFI_FV_ATTRIBUTES; Retrieves attributes, insures positive polarity of attribute bits, returns
resulting attributes in output parameter
- @param This Calling context
- @param Attributes output buffer which contains attributes
+ @param This Calling context
+ @param Attributes output buffer which contains attributes
@retval EFI_INVALID_PARAMETER
@retval EFI_SUCCESS
@@ -99,8 +99,8 @@ EFI_STATUS /**
Sets volume attributes
- @param This Calling context
- @param Attributes Buffer which contains attributes
+ @param This Calling context
+ @param Attributes Buffer which contains attributes
@retval EFI_INVALID_PARAMETER
@retval EFI_DEVICE_ERROR
@@ -121,24 +121,23 @@ typedef UINT32 EFI_FV_FILE_ATTRIBUTES; /**
Read the requested file (NameGuid) and returns data in Buffer.
- @param This Calling context
- @param NameGuid Filename identifying which file to read
- @param Buffer Pointer to pointer to buffer in which contents of file are returned.
- <br>
- If Buffer is NULL, only type, attributes, and size are returned as
- there is no output buffer.
- <br>
- If Buffer != NULL and *Buffer == NULL, the output buffer is allocated
- from BS pool by ReadFile
- <br>
- If Buffer != NULL and *Buffer != NULL, the output buffer has been
- allocated by the caller and is being passed in.
-
- @param BufferSize Indicates the buffer size passed in, and on output the size
- required to complete the read
- @param FoundType Indicates the type of the file who's data is returned
- @param FileAttributes Indicates the attributes of the file who's data is resturned
- @param AuthenticationStatus Indicates the authentication status of the data
+ @param This Calling context
+ @param NameGuid Filename identifying which file to read
+ @param Buffer Pointer to pointer to buffer in which contents of file are returned.
+ <br>
+ If Buffer is NULL, only type, attributes, and size are returned as
+ there is no output buffer.
+ <br>
+ If Buffer != NULL and *Buffer == NULL, the output buffer is allocated
+ from BS pool by ReadFile
+ <br>
+ If Buffer != NULL and *Buffer != NULL, the output buffer has been
+ allocated by the caller and is being passed in.
+ @param BufferSize Indicates the buffer size passed in, and on output the size
+ required to complete the read
+ @param FoundType Indicates the type of the file who's data is returned
+ @param FileAttributes Indicates the attributes of the file who's data is resturned
+ @param AuthenticationStatus Indicates the authentication status of the data
@retval EFI_SUCCESS
@retval EFI_WARN_BUFFER_TOO_SMALL
@@ -162,24 +161,23 @@ EFI_STATUS /**
Read the requested section from the specified file and returns data in Buffer.
- @param This Calling context
- @param NameGuid Filename identifying the file from which to read
- @param SectionType Indicates what section type to retrieve
- @param SectionInstance Indicates which instance of SectionType to retrieve
- @param Buffer Pointer to pointer to buffer in which contents of file are returned.
- <br>
- If Buffer is NULL, only type, attributes, and size are returned as
- there is no output buffer.
- <br>
- If Buffer != NULL and *Buffer == NULL, the output buffer is allocated
- from BS pool by ReadFile
- <br>
- If Buffer != NULL and *Buffer != NULL, the output buffer has been
- allocated by the caller and is being passed in.
-
- @param BufferSize Indicates the buffer size passed in, and on output the size
- required to complete the read
- @param AuthenticationStatus Indicates the authentication status of the data
+ @param This Calling context
+ @param NameGuid Filename identifying the file from which to read
+ @param SectionType Indicates what section type to retrieve
+ @param SectionInstance Indicates which instance of SectionType to retrieve
+ @param Buffer Pointer to pointer to buffer in which contents of file are returned.
+ <br>
+ If Buffer is NULL, only type, attributes, and size are returned as
+ there is no output buffer.
+ <br>
+ If Buffer != NULL and *Buffer == NULL, the output buffer is allocated
+ from BS pool by ReadFile
+ <br>
+ If Buffer != NULL and *Buffer != NULL, the output buffer has been
+ allocated by the caller and is being passed in.
+ @param BufferSize Indicates the buffer size passed in, and on output the size
+ required to complete the read
+ @param AuthenticationStatus Indicates the authentication status of the data
@retval EFI_SUCCESS
@retval EFI_WARN_BUFFER_TOO_SMALL
@@ -217,13 +215,13 @@ typedef struct { /**
Write the supplied file (NameGuid) to the FV.
- @param This Calling context
- @param NumberOfFiles Indicates the number of file records pointed to by FileData
- @param WritePolicy Indicates the level of reliability of the write with respect to
- things like power failure events.
- @param FileData A pointer to an array of EFI_FV_WRITE_FILE_DATA structures. Each
- element in the array indicates a file to write, and there are
- NumberOfFiles elements in the input array.
+ @param This Calling context
+ @param NumberOfFiles Indicates the number of file records pointed to by FileData
+ @param WritePolicy Indicates the level of reliability of the write with respect to
+ things like power failure events.
+ @param FileData A pointer to an array of EFI_FV_WRITE_FILE_DATA structures. Each
+ element in the array indicates a file to write, and there are
+ NumberOfFiles elements in the input array.
@retval EFI_SUCCESS
@retval EFI_OUT_OF_RESOURCES
@@ -245,14 +243,14 @@ EFI_STATUS /**
Given the input key, search for the next matching file in the volume.
- @param This Calling context
- @param Key Pointer to a caller allocated buffer that contains an implementation
- specific key that is used to track where to begin searching on
- successive calls.
- @param FileType Indicates the file type to filter for
- @param NameGuid Guid filename of the file found
- @param Attributes Attributes of the file found
- @param Size Size in bytes of the file found
+ @param This Calling context
+ @param Key Pointer to a caller allocated buffer that contains an implementation
+ specific key that is used to track where to begin searching on
+ successive calls.
+ @param FileType Indicates the file type to filter for
+ @param NameGuid Guid filename of the file found
+ @param Attributes Attributes of the file found
+ @param Size Size in bytes of the file found
@retval EFI_SUCCESS
@retval EFI_NOT_FOUND
diff --git a/MdePkg/Include/Protocol/FirmwareVolumeBlock.h b/MdePkg/Include/Protocol/FirmwareVolumeBlock.h index ee849a141e..0c3d03276b 100644 --- a/MdePkg/Include/Protocol/FirmwareVolumeBlock.h +++ b/MdePkg/Include/Protocol/FirmwareVolumeBlock.h @@ -35,8 +35,8 @@ typedef struct _EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL EFI_FIRMWARE_VOLUME_BLOCK_PR /**
Retrieves Volume attributes. No polarity translations are done.
- @param This Calling context
- @param Attributes output buffer which contains attributes
+ @param This Calling context
+ @param Attributes output buffer which contains attributes
@retval EFI_INVALID_PARAMETER
@retval EFI_SUCCESS
@@ -53,9 +53,9 @@ EFI_STATUS /**
Sets Volume attributes. No polarity translations are done.
- @param This Calling context
- @param Attributes On input: contains new attributes
- On output: contains current attributes of FV
+ @param This Calling context
+ @param Attributes On input: contains new attributes
+ On output: contains current attributes of FV
@retval EFI_INVALID_PARAMETER
@retval EFI_SUCCESS
@@ -72,10 +72,10 @@ EFI_STATUS /**
Retrieves the physical address of a memory mapped FV.
- @param This Calling context
- @param Attributes Address is a pointer to a caller allocated EFI_PHYSICAL_ADDRESS
- that on successful return from GetPhysicalAddress() contains the
- base address of the firmware volume.
+ @param This Calling context
+ @param Attributes Address is a pointer to a caller allocated EFI_PHYSICAL_ADDRESS
+ that on successful return from GetPhysicalAddress() contains the
+ base address of the firmware volume.
@retval EFI_UNSUPPORTED
@retval EFI_SUCCESS
@@ -92,14 +92,14 @@ EFI_STATUS /**
Retrieves the size in bytes of a specific block within an FV.
- @param This Calling context.
- @param Lba Indicates which block to return the size for.
- @param BlockSize BlockSize is a pointer to a caller allocated
- UINTN in which the size of the block is returned.
- @param NumberOfBlocks NumberOfBlocks is a pointer to a caller allocated
- UINTN in which the number of consecutive blocks
- starting with Lba is returned. All blocks in this
- range have a size of BlockSize.
+ @param This Calling context.
+ @param Lba Indicates which block to return the size for.
+ @param BlockSize BlockSize is a pointer to a caller allocated
+ UINTN in which the size of the block is returned.
+ @param NumberOfBlocks NumberOfBlocks is a pointer to a caller allocated
+ UINTN in which the number of consecutive blocks
+ starting with Lba is returned. All blocks in this
+ range have a size of BlockSize.
@retval EFI_INVALID_PARAMETER
@retval EFI_SUCCESS
@@ -121,12 +121,12 @@ EFI_STATUS a block boundary is reached. *NumBytes is updated to reflect the actual
number of bytes read.
- @param This Calling context
- @param Lba Block in which to begin read
- @param Offset Offset in the block at which to begin read
- @param NumBytes At input, indicates the requested read size. At output, indicates
- the actual number of bytes read.
- @param Buffer Data buffer in which to place data read.
+ @param This Calling context
+ @param Lba Block in which to begin read
+ @param Offset Offset in the block at which to begin read
+ @param NumBytes At input, indicates the requested read size. At output, indicates
+ the actual number of bytes read.
+ @param Buffer Data buffer in which to place data read.
@retval EFI_INVALID_PARAMETER
@retval EFI_NOT_FOUND
@@ -151,12 +151,12 @@ EFI_STATUS reached. *NumBytes is updated to reflect the actual number of bytes
written.
- @param This Calling context
- @param Lba Block in which to begin write
- @param Offset Offset in the block at which to begin write
- @param NumBytes At input, indicates the requested write size. At output, indicates
- the actual number of bytes written.
- @param Buffer Buffer containing source data for the write.
+ @param This Calling context
+ @param Lba Block in which to begin write
+ @param Offset Offset in the block at which to begin write
+ @param NumBytes At input, indicates the requested write size. At output, indicates
+ the actual number of bytes written.
+ @param Buffer Buffer containing source data for the write.
@retval EFI_INVALID_PARAMETER
@retval EFI_NOT_FOUND
@@ -185,9 +185,9 @@ EFI_STATUS block of the firmware volume), the EraseBlock() function must return
EFI_INVALID_PARAMETER without modifying the contents of the firmware volume.
- @param This Calling context
- @param ... Starting LBA followed by Number of Lba to erase. a -1 to terminate
- the list.
+ @param This Calling context
+ @param ... Starting LBA followed by Number of Lba to erase. a -1 to terminate
+ the list.
@retval EFI_INVALID_PARAMETER
@retval EFI_DEVICE_ERROR
diff --git a/MdePkg/Include/Protocol/FormBrowser.h b/MdePkg/Include/Protocol/FormBrowser.h index c0ee94ad65..0e52f1edaa 100644 --- a/MdePkg/Include/Protocol/FormBrowser.h +++ b/MdePkg/Include/Protocol/FormBrowser.h @@ -55,48 +55,36 @@ typedef struct { database or a passed-in set of data. This function also establishes a
pointer to the calling driver¡¯s callback interface.
- @param This A pointer to the EFI_FORM_BROWSER_PROTOCOL instance.
-
- @param UseDatabase Determines whether the HII database is to be
- used to gather information. If the value is FALSE, the configuration
- driver will get the information provided in the passed-in Packet parameters.
-
- @param Handle A pointer to an array of HII handles to display. This value
- should correspond to the value of the HII form package that is required to
- be displayed.
-
- @param HandleCount The number of handles in the array specified by Handle.
-
- @param Packet A pointer to a set of data containing pointers to IFR
- and/or string data.
-
- @param CallbackHandle The handle to the driver¡¯s callback interface.
- This parameter is used only when the UseDatabase parameter is FALSE
- and an application wants to register a callback with the browser
-
- @param NvMapOverride This buffer is used only when there is no NV variable
- to define the current settings and the caller needs to provide to the browser
- the current settings for the "fake" NV variable.
-
- @param ScreenDimensions Allows the browser to be called so that it occupies
- a portion of the physical screen instead of dynamically determining the
- screen dimensions.
-
- @param ResetRequired This BOOLEAN value will tell the caller if a reset
- is required based on the data that might have been changed. The ResetRequired
- parameter is primarily applicable for configuration applications, and is an
- optional parameter.
-
- @retval EFI_SUCCESS The function completed successfully
-
- @retval EFI_NOT_FOUND The variable was not found.
-
- @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
- DataSize has been updated with the size needed to complete the request.
-
+ @param This A pointer to the EFI_FORM_BROWSER_PROTOCOL instance.
+ @param UseDatabase Determines whether the HII database is to be
+ used to gather information. If the value is FALSE, the configuration
+ driver will get the information provided in the passed-in Packet parameters.
+ @param Handle A pointer to an array of HII handles to display. This value
+ should correspond to the value of the HII form package that is required to
+ be displayed.
+ @param HandleCount The number of handles in the array specified by Handle.
+ @param Packet A pointer to a set of data containing pointers to IFR
+ and/or string data.
+ @param CallbackHandle The handle to the driver¡¯s callback interface.
+ This parameter is used only when the UseDatabase parameter is FALSE
+ and an application wants to register a callback with the browser
+ @param NvMapOverride This buffer is used only when there is no NV variable
+ to define the current settings and the caller needs to provide to the browser
+ the current settings for the "fake" NV variable.
+ @param ScreenDimensions Allows the browser to be called so that it occupies
+ a portion of the physical screen instead of dynamically determining the
+ screen dimensions.
+ @param ResetRequired This BOOLEAN value will tell the caller if a reset
+ is required based on the data that might have been changed. The ResetRequired
+ parameter is primarily applicable for configuration applications, and is an
+ optional parameter.
+
+ @retval EFI_SUCCESS The function completed successfully
+ @retval EFI_NOT_FOUND The variable was not found.
+ @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
+ DataSize has been updated with the size needed to complete the request.
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
-
- @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
+ @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
**/
typedef
@@ -117,29 +105,21 @@ EFI_STATUS Routine used to abstract a generic dialog interface and return the selected
key or string.
- @param NumberOfLines The number of lines for the dialog box.
-
- @param HotKey Defines whether a single character is parsed (TRUE)
- and returned in KeyValue or if a string is returned in StringBuffer.
-
- @param MaximumStringSize The maximum size in bytes of a typed-in string.
- Because each character is a CHAR16, the minimum string returned is two bytes.
-
- @param StringBuffer The passed-in pointer to the buffer that will hold
- the typed in string if HotKey is FALSE.
-
- @param KeyValue The EFI_INPUT_KEY value returned if HotKey is TRUE.
-
- @param String The pointer to the first string in the list of strings
- that comprise the dialog box.
-
- @param ... A series of NumberOfLines text strings that will be used
- to construct the dialog box.
-
- @retval EFI_SUCCESS The dialog was displayed and user interaction was received.
-
- @retval EFI_DEVICE_ERROR The user typed in an ESC character to exit the routine.
-
+ @param NumberOfLines The number of lines for the dialog box.
+ @param HotKey Defines whether a single character is parsed (TRUE)
+ and returned in KeyValue or if a string is returned in StringBuffer.
+ @param MaximumStringSize The maximum size in bytes of a typed-in string.
+ Because each character is a CHAR16, the minimum string returned is two bytes.
+ @param StringBuffer The passed-in pointer to the buffer that will hold
+ the typed in string if HotKey is FALSE.
+ @param KeyValue The EFI_INPUT_KEY value returned if HotKey is TRUE.
+ @param String The pointer to the first string in the list of strings
+ that comprise the dialog box.
+ @param ... A series of NumberOfLines text strings that will be used
+ to construct the dialog box.
+
+ @retval EFI_SUCCESS The dialog was displayed and user interaction was received.
+ @retval EFI_DEVICE_ERROR The user typed in an ESC character to exit the routine.
@retval EFI_INVALID_PARAMETER One of the parameters was invalid
**/
diff --git a/MdePkg/Include/Protocol/FormCallback.h b/MdePkg/Include/Protocol/FormCallback.h index 7a1c5398b8..2f3a527873 100644 --- a/MdePkg/Include/Protocol/FormCallback.h +++ b/MdePkg/Include/Protocol/FormCallback.h @@ -88,31 +88,22 @@ typedef struct { /**
Returns the value of a variable.
- @param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.
-
- @param VariableName A NULL-terminated Unicode string that is the
- name of the vendor¡¯s variable.
-
- @param VendorGuid A unique identifier for the vendor.
-
- @param Attributes If not NULL, a pointer to the memory location to
- return the attribute's bit-mask for the variable.
-
- @param DataSize The size in bytes of the Buffer. A size of zero causes
- the variable to be deleted.
-
- @param Buffer The buffer to return the contents of the variable.
-
- @retval EFI_SUCCESS The function completed successfully.
-
- @retval EFI_NOT_FOUND The variable was not found.
-
- @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
- DataSize has been updated with the size needed to complete the request.
-
- @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
-
- @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
+ @param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.
+ @param VariableName A NULL-terminated Unicode string that is the
+ name of the vendor¡¯s variable.
+ @param VendorGuid A unique identifier for the vendor.
+ @param Attributes If not NULL, a pointer to the memory location to
+ return the attribute's bit-mask for the variable.
+ @param DataSize The size in bytes of the Buffer. A size of zero causes
+ the variable to be deleted.
+ @param Buffer The buffer to return the contents of the variable.
+
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_NOT_FOUND The variable was not found.
+ @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
+ DataSize has been updated with the size needed to complete the request.
+ @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
+ @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
**/
typedef
@@ -129,35 +120,26 @@ EFI_STATUS /**
Sets the value of a variable.
- @param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.
-
- @param VariableName A NULL-terminated Unicode string that is the
- name of the vendor's variable. Each VariableName is unique for each VendorGuid.
-
- @param VendorGuid A unique identifier for the vendor.
-
- @param Attributes Attributes bit-mask to set for the variable.
-
- @param DataSize The size in bytes of the Buffer. A size of zero causes
- the variable to be deleted.
-
- @param Buffer The buffer containing the contents of the variable.
-
- @param ResetRequired Returns a value from the driver that abstracts
- this information and will enable a system to know if a system reset
- is required to achieve the configuration changes being enabled through
- this function.
-
- @retval EFI_SUCCESS The firmware has successfully stored the variable and
- its data as defined by the Attributes.
-
- @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold
- the variable and its data.
-
- @retval EFI_INVALID_PARAMETER An invalid combination of Attributes bits
- was supplied, or the DataSize exceeds the maximum allowed.
-
- @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
+ @param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.
+ @param VariableName A NULL-terminated Unicode string that is the
+ name of the vendor's variable. Each VariableName is unique for each VendorGuid.
+ @param VendorGuid A unique identifier for the vendor.
+ @param Attributes Attributes bit-mask to set for the variable.
+ @param DataSize The size in bytes of the Buffer. A size of zero causes
+ the variable to be deleted.
+ @param Buffer The buffer containing the contents of the variable.
+ @param ResetRequired Returns a value from the driver that abstracts
+ this information and will enable a system to know if a system reset
+ is required to achieve the configuration changes being enabled through
+ this function.
+
+ @retval EFI_SUCCESS The firmware has successfully stored the variable and
+ its data as defined by the Attributes.
+ @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold
+ the variable and its data.
+ @retval EFI_INVALID_PARAMETER An invalid combination of Attributes bits
+ was supplied, or the DataSize exceeds the maximum allowed.
+ @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
**/
typedef
@@ -175,16 +157,13 @@ EFI_STATUS /**
This function is called to provide results data to the driver.
- @param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.
-
- @param KeyValue A unique value which is sent to the original exporting
- driver so that it can identify the type of data to expect. The format of
- the data tends to vary based on the opcode that generated the callback.
-
- @param Data A pointer to the data being sent to the original exporting driver.
-
- @param Packet A pointer to a packet of information which a driver passes
- back to the browser.
+ @param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.
+ @param KeyValue A unique value which is sent to the original exporting
+ driver so that it can identify the type of data to expect. The format of
+ the data tends to vary based on the opcode that generated the callback.
+ @param Data A pointer to the data being sent to the original exporting driver.
+ @param Packet A pointer to a packet of information which a driver passes
+ back to the browser.
@return Status Code
diff --git a/MdePkg/Include/Protocol/GuidedSectionExtraction.h b/MdePkg/Include/Protocol/GuidedSectionExtraction.h index d98c56a7bc..8368e281a8 100644 --- a/MdePkg/Include/Protocol/GuidedSectionExtraction.h +++ b/MdePkg/Include/Protocol/GuidedSectionExtraction.h @@ -49,20 +49,20 @@ typedef struct _EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL EFI_GUIDED_SECTION_EXTRA Processes the input section and returns the data contained therein along
with the authentication status.
- @param This Indicates the EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL instance.
- @param InputSection Buffer containing the input GUIDed section to be processed.
- @param OutputBuffer *OutputBuffer is allocated from boot services pool memory
- and contains the new section stream.
- @param OutputSize A pointer to a caller-allocated UINTN in which the size
- of *OutputBuffer allocation is stored.
- @param AuthenticationStatus A pointer to a caller-allocated UINT32 that
+ @param This Indicates the EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL instance.
+ @param InputSection Buffer containing the input GUIDed section to be processed.
+ @param OutputBuffer *OutputBuffer is allocated from boot services pool memory
+ and contains the new section stream.
+ @param OutputSize A pointer to a caller-allocated UINTN in which the size
+ of *OutputBuffer allocation is stored.
+ @param AuthenticationStatus A pointer to a caller-allocated UINT32 that
indicates the authentication status of the output buffer.
- @retval EFI_SUCCESS The InputSection was successfully processed and the
+ @retval EFI_SUCCESS The InputSection was successfully processed and the
section contents were returned.
- @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to
+ @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to
process the request.
- @retval EFI_INVALID_PARAMETER The GUID in InputSection does not match
+ @retval EFI_INVALID_PARAMETER The GUID in InputSection does not match
this instance of the GUIDed Section Extraction Protocol.
**/
diff --git a/MdePkg/Include/Protocol/Hii.h b/MdePkg/Include/Protocol/Hii.h index ceeba1c7fb..bb213d8d57 100644 --- a/MdePkg/Include/Protocol/Hii.h +++ b/MdePkg/Include/Protocol/Hii.h @@ -412,16 +412,13 @@ typedef struct _EFI_HII_VARIABLE_PACK_LIST { /**
Registers the various packs that are passed in via the Packages parameter.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Packages A pointer to an EFI_HII_PACKAGES package instance.
-
- @param Handle A pointer to the EFI_HII_HANDLE instance.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Packages A pointer to an EFI_HII_PACKAGES package instance.
+ @param Handle A pointer to the EFI_HII_HANDLE instance.
- @retval EFI_SUCCESS Data was extracted from Packages, the database
- was updated with the data, and Handle returned successfully.
-
- @retval EFI_INVALID_PARAMETER The content of Packages was invalid.
+ @retval EFI_SUCCESS Data was extracted from Packages, the database
+ was updated with the data, and Handle returned successfully.
+ @retval EFI_INVALID_PARAMETER The content of Packages was invalid.
**/
typedef
@@ -435,15 +432,13 @@ EFI_STATUS /**
Removes a package from the HII database.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle The handle that was registered to the data that is requested
- for removal.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle The handle that was registered to the data that is requested
+ for removal.
- @retval EFI_SUCCESS The data associated with the Handle was removed
- from the HII database.
-
- @retval EFI_INVALID_PARAMETER The Handle was not valid.
+ @retval EFI_SUCCESS The data associated with the Handle was removed
+ from the HII database.
+ @retval EFI_INVALID_PARAMETER The Handle was not valid.
**/
typedef
@@ -456,18 +451,15 @@ EFI_STATUS /**
Determines the handles that are currently active in the database.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param HandleBufferLength On input, a pointer to the length of the handle
- buffer. On output, the length of the handle buffer that is required
- for the handles found.
-
- @param Handle An array of EFI_HII_HANDLE instances returned.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param HandleBufferLength On input, a pointer to the length of the handle
+ buffer. On output, the length of the handle buffer that is required
+ for the handles found.
+ @param Handle An array of EFI_HII_HANDLE instances returned.
- @retval EFI_SUCCESS Handle was updated successfully.
-
- @retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter indicates
- that Handle is too small to support the number of handles.
+ @retval EFI_SUCCESS Handle was updated successfully.
+ @retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter indicates
+ that Handle is too small to support the number of handles.
**/
typedef
@@ -481,22 +473,18 @@ EFI_STATUS /**
Exports the contents of the database into a buffer.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle An EFI_HII_HANDLE that corresponds to the desired
- handle to export. If the value is 0, the entire database will be exported.
- In either case, the data will be exported in a format described by the
- structure definition of EFI_HII_EXPORT_TABLE.
-
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle An EFI_HII_HANDLE that corresponds to the desired
+ handle to export. If the value is 0, the entire database will be exported.
+ In either case, the data will be exported in a format described by the
+ structure definition of EFI_HII_EXPORT_TABLE.
@param BufferSize
On input, a pointer to the length of the buffer. On output, the length
of the buffer that is required for the export data.
-
- @param Buffer A pointer to a buffer that will contain the results of the export function.
+ @param Buffer A pointer to a buffer that will contain the results of the export function.
- @retval EFI_SUCCESS The buffer was successfully filled with BufferSize amount of data.
-
- @retval EFI_BUFFER_TOO_SMALL The value in BufferSize was too small to contain the export data.
+ @retval EFI_SUCCESS The buffer was successfully filled with BufferSize amount of data.
+ @retval EFI_BUFFER_TOO_SMALL The value in BufferSize was too small to contain the export data.
**/
typedef
@@ -512,12 +500,10 @@ EFI_STATUS Remove any new strings that were added after the initial string export
for this handle.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle The handle on which the string resides.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle The handle on which the string resides.
- @retval EFI_SUCCESS Remove strings from the handle successfully.
-
+ @retval EFI_SUCCESS Remove strings from the handle successfully.
@retval EFI_INVALID_PARAMETER The Handle was unknown.
**/
@@ -531,24 +517,20 @@ EFI_STATUS /**
Tests if all of the characters in a string have corresponding font characters.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param StringToTest A pointer to a Unicode string.
-
- @param FirstMissing A pointer to an index into the string. On input,
- the index of the first character in the StringToTest to examine. On exit,
- the index of the first character encountered for which a glyph is unavailable.
- If all glyphs in the string are available, the index is the index of the
- terminator of the string.
-
- @param GlyphBufferSize A pointer to a value. On output, if the function
- returns EFI_SUCCESS, it contains the amount of memory that is required to
- store the string¡¯s glyph equivalent.
-
- @retval EFI_SUCCESS All glyphs are available. Note that an empty string
- always returns this value.
-
- @retval EFI_NOT_FOUND A glyph was not found for a character.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param StringToTest A pointer to a Unicode string.
+ @param FirstMissing A pointer to an index into the string. On input,
+ the index of the first character in the StringToTest to examine. On exit,
+ the index of the first character encountered for which a glyph is unavailable.
+ If all glyphs in the string are available, the index is the index of the
+ terminator of the string.
+ @param GlyphBufferSize A pointer to a value. On output, if the function
+ returns EFI_SUCCESS, it contains the amount of memory that is required to
+ store the string¡¯s glyph equivalent.
+
+ @retval EFI_SUCCESS All glyphs are available. Note that an empty string
+ always returns this value.
+ @retval EFI_NOT_FOUND A glyph was not found for a character.
**/
typedef
@@ -563,28 +545,22 @@ EFI_STATUS /**
Translates a Unicode character into the corresponding font glyph.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Source A pointer to a Unicode string.
-
- @param Index On input, the offset into the string from which to fetch
- the character.On successful completion, the index is updated to the first
- character past the character(s) making up the just extracted glyph.
-
- @param GlyphBuffer Pointer to an array where the glyphs corresponding
- to the characters in the source may be stored. GlyphBuffer is assumed
- to be wide enough to accept a wide glyph character.
-
- @param BitWidth If EFI_SUCCESS was returned, the UINT16 pointed to by
- this value is filled with the length of the glyph in pixels. It is unchanged
- if the call was unsuccessful.
-
- @param InternalStatus The cell pointed to by this parameter must be
- initialized to zero prior to invoking the call the first time for any string.
-
- @retval EFI_SUCCESS It worked.
-
- @retval EFI_NOT_FOUND A glyph for a character was not found.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Source A pointer to a Unicode string.
+ @param Index On input, the offset into the string from which to fetch
+ the character.On successful completion, the index is updated to the first
+ character past the character(s) making up the just extracted glyph.
+ @param GlyphBuffer Pointer to an array where the glyphs corresponding
+ to the characters in the source may be stored. GlyphBuffer is assumed
+ to be wide enough to accept a wide glyph character.
+ @param BitWidth If EFI_SUCCESS was returned, the UINT16 pointed to by
+ this value is filled with the length of the glyph in pixels. It is unchanged
+ if the call was unsuccessful.
+ @param InternalStatus The cell pointed to by this parameter must be
+ initialized to zero prior to invoking the call the first time for any string.
+
+ @retval EFI_SUCCESS It worked.
+ @retval EFI_NOT_FOUND A glyph for a character was not found.
**/
typedef
@@ -602,28 +578,20 @@ EFI_STATUS Translates a glyph into the format required for input to the Universal
Graphics Adapter (UGA) Block Transfer (BLT) routines.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param GlyphBuffer A pointer to the buffer that contains glyph data.
-
- @param Foreground The foreground setting requested to be used for the
- generated BltBuffer data.
-
- @param Background The background setting requested to be used for the
- generated BltBuffer data.
-
- @param Count The entry in the BltBuffer upon which to act.
-
- @param Width The width in bits of the glyph being converted.
-
- @param Height The height in bits of the glyph being converted
-
- @param BltBuffer A pointer to the buffer that contains the data that is
- ready to be used by the UGA BLT routines.
-
- @retval EFI_SUCCESS It worked.
-
- @retval EFI_NOT_FOUND A glyph for a character was not found.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param GlyphBuffer A pointer to the buffer that contains glyph data.
+ @param Foreground The foreground setting requested to be used for the
+ generated BltBuffer data.
+ @param Background The background setting requested to be used for the
+ generated BltBuffer data.
+ @param Count The entry in the BltBuffer upon which to act.
+ @param Width The width in bits of the glyph being converted.
+ @param Height The height in bits of the glyph being converted
+ @param BltBuffer A pointer to the buffer that contains the data that is
+ ready to be used by the UGA BLT routines.
+
+ @retval EFI_SUCCESS It worked.
+ @retval EFI_NOT_FOUND A glyph for a character was not found.
**/
typedef
@@ -642,22 +610,17 @@ EFI_STATUS /**
Allows a new string to be added to an already existing string package.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Pointer to a NULL-terminated string containing a single ISO 639-2
- language identifier, indicating the language in which the string is translated.
-
- @param Handle The handle of the language pack to which the string is to be added.
-
- @param Reference The identifier of the string to be added. If the reference
- value is zero, then the string will be assigned a new identifier on that
- handle for the language specified. Otherwise, the string will be updated
- with the NewString Value.
-
- @param NewString The string to be added.
-
- @retval EFI_SUCCESS The string was effectively registered.
-
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Pointer to a NULL-terminated string containing a single ISO 639-2
+ language identifier, indicating the language in which the string is translated.
+ @param Handle The handle of the language pack to which the string is to be added.
+ @param Reference The identifier of the string to be added. If the reference
+ value is zero, then the string will be assigned a new identifier on that
+ handle for the language specified. Otherwise, the string will be updated
+ with the NewString Value.
+ @param NewString The string to be added.
+
+ @retval EFI_SUCCESS The string was effectively registered.
@retval EFI_INVALID_PARAMETER The Handle was unknown.
**/
@@ -675,15 +638,12 @@ EFI_STATUS Allows a program to determine the primary languages that are supported
on a given handle.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle The handle on which the strings reside.
-
- @param LanguageString A string allocated by GetPrimaryLanguages() that
- contains a list of all primary languages registered on the handle.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle The handle on which the strings reside.
+ @param LanguageString A string allocated by GetPrimaryLanguages() that
+ contains a list of all primary languages registered on the handle.
- @retval EFI_SUCCESS LanguageString was correctly returned.
-
+ @retval EFI_SUCCESS LanguageString was correctly returned.
@retval EFI_INVALID_PARAMETER The Handle was unknown.
**/
@@ -699,18 +659,14 @@ EFI_STATUS Allows a program to determine which secondary languages are supported
on a given handle for a given primary language.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle The handle on which the strings reside.
-
- @param PrimaryLanguage Pointer to a NULL-terminated string containing a single
- ISO 639-2 language identifier, indicating the primary language.
-
- @param LanguageString A string allocated by GetSecondaryLanguages()
- containing a list of all secondary languages registered on the handle.
-
- @retval EFI_SUCCESS LanguageString was correctly returned.
-
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle The handle on which the strings reside.
+ @param PrimaryLanguage Pointer to a NULL-terminated string containing a single
+ ISO 639-2 language identifier, indicating the primary language.
+ @param LanguageString A string allocated by GetSecondaryLanguages()
+ containing a list of all secondary languages registered on the handle.
+
+ @retval EFI_SUCCESS LanguageString was correctly returned.
@retval EFI_INVALID_PARAMETER The Handle was unknown.
**/
@@ -726,32 +682,24 @@ EFI_STATUS /**
Extracts a string from a package already registered with the EFI HII database.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle The handle on which the string resides.
-
- @param Token The string token assigned to the string.
-
- @param Raw If TRUE, the string is returned unedited in the internal
- storage format described above. If false, the string returned is edited
- by replacing <cr> with <space> and by removing special characters such
- as the <wide> prefix.
-
- @param LanguageString Pointer to a NULL-terminated string containing a
- single ISO 639-2 language identifier, indicating the language to print.
- If the LanguageString is empty (starts with a NULL), the default system
- language will be used to determine the language.
-
- @param BufferLength Length of the StringBuffer.
-
- @param StringBuffer The buffer designed to receive the characters in the string.
-
- @retval EFI_SUCCESS StringBuffer is filled with a NULL-terminated string.
-
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle The handle on which the string resides.
+ @param Token The string token assigned to the string.
+ @param Raw If TRUE, the string is returned unedited in the internal
+ storage format described above. If false, the string returned is edited
+ by replacing <cr> with <space> and by removing special characters such
+ as the <wide> prefix.
+ @param LanguageString Pointer to a NULL-terminated string containing a
+ single ISO 639-2 language identifier, indicating the language to print.
+ If the LanguageString is empty (starts with a NULL), the default system
+ language will be used to determine the language.
+ @param BufferLength Length of the StringBuffer.
+ @param StringBuffer The buffer designed to receive the characters in the string.
+
+ @retval EFI_SUCCESS StringBuffer is filled with a NULL-terminated string.
@retval EFI_INVALID_PARAMETER The handle or string token is unknown.
-
- @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough to
- allow the entire string to be stored.
+ @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough to
+ allow the entire string to be stored.
**/
typedef
@@ -769,32 +717,23 @@ EFI_STATUS /**
Allows a program to extract a part of a string of not more than a given width.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle The handle on which the string resides.
-
- @param Token The string token assigned to the string.
-
- @param Index On input, the offset into the string where the line is to start.
- On output, the index is updated to point to beyond the last character returned
- in the call.
-
- @param LineWidth The maximum width of the line in units of narrow glyphs.
-
- @param LanguageString Pointer to a NULL-terminated string containing a
- single ISO 639-2 language identifier, indicating the language to print.
-
- @param BufferLength Pointer to the length of the StringBuffer.
-
- @param StringBuffer The buffer designed to receive the characters in the string.
-
- @retval EFI_SUCCESS StringBuffer filled with characters that will fit on the line.
-
- @retval EFI_NOT_FOUND The font glyph for at least one of the characters in
- the string is not in the font database.
-
- @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
- to allow the entire string to be stored.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle The handle on which the string resides.
+ @param Token The string token assigned to the string.
+ @param Index On input, the offset into the string where the line is to start.
+ On output, the index is updated to point to beyond the last character returned
+ in the call.
+ @param LineWidth The maximum width of the line in units of narrow glyphs.
+ @param LanguageString Pointer to a NULL-terminated string containing a
+ single ISO 639-2 language identifier, indicating the language to print.
+ @param BufferLength Pointer to the length of the StringBuffer.
+ @param StringBuffer The buffer designed to receive the characters in the string.
+
+ @retval EFI_SUCCESS StringBuffer filled with characters that will fit on the line.
+ @retval EFI_NOT_FOUND The font glyph for at least one of the characters in
+ the string is not in the font database.
+ @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
+ to allow the entire string to be stored.
**/
typedef
@@ -814,28 +753,21 @@ EFI_STATUS Allows a program to extract a form or form package that has previously
been registered with the HII database.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle Handle on which the form resides.
-
- @param FormId The ID of the form to return. If the ID is zero,
- the entire form package is returned.
-
- @param BufferLength On input, the length of the Buffer. On output,
- the length of the returned buffer,
-
- @param Buffer The buffer designed to receive the form(s).
-
- @retval EFI_SUCCESS Buffer filled with the requested forms. BufferLength
- was updated.
-
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle Handle on which the form resides.
+ @param FormId The ID of the form to return. If the ID is zero,
+ the entire form package is returned.
+ @param BufferLength On input, the length of the Buffer. On output,
+ the length of the returned buffer,
+ @param Buffer The buffer designed to receive the form(s).
+
+ @retval EFI_SUCCESS Buffer filled with the requested forms. BufferLength
+ was updated.
@retval EFI_INVALID_PARAMETER The handle is unknown.
-
- @retval EFI_NOT_FOUND A form on the requested handle cannot be found with
- the requested FormId.
-
- @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
- to allow the form to be stored.
+ @retval EFI_NOT_FOUND A form on the requested handle cannot be found with
+ the requested FormId.
+ @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
+ to allow the form to be stored.
**/
typedef
@@ -851,23 +783,18 @@ EFI_STATUS /**
Extracts the defaults that are associated with a given handle in the HII database.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle The HII handle from which will have default data retrieved.
-
- @param DefaultMask The mask used to specify some type of default override when extracting
- the default image data.
-
- @param VariablePackList A indirect pointer to the first entry of a link list with
- type EFI_HII_VARIABLE_PACK_LIST.
-
- @retval EFI_SUCCESS The VariablePackList was populated with the appropriate
- default setting data.
-
- @retval EFI_NOT_FOUND The IFR does not have any explicit or default map(s).
-
- @retval EFI_INVALID_PARAMETER The HII database entry associated with Handle
- contain invalid data.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle The HII handle from which will have default data retrieved.
+ @param DefaultMask The mask used to specify some type of default override when extracting
+ the default image data.
+ @param VariablePackList A indirect pointer to the first entry of a link list with
+ type EFI_HII_VARIABLE_PACK_LIST.
+
+ @retval EFI_SUCCESS The VariablePackList was populated with the appropriate
+ default setting data.
+ @retval EFI_NOT_FOUND The IFR does not have any explicit or default map(s).
+ @retval EFI_INVALID_PARAMETER The HII database entry associated with Handle
+ contain invalid data.
**/
typedef
@@ -883,23 +810,17 @@ EFI_STATUS Allows the caller to update a form or form package that has previously been
registered with the EFI HII database.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle Handle of the package where the form to be updated resides.
-
- @param Label The label inside the form package where the update is to take place.
-
- @param AddData If TRUE, adding data at a given Label; otherwise,
- if FALSE, removing data at a given Label.
-
- @param Data The buffer containing the new tags to insert after the Label
-
- @retval EFI_SUCCESS The form was updated with the new tags.
-
- @retval EFI_INVALID_PARAMETER The buffer for the buffer length does not
- contain an integral number of tags.
-
- @retval EFI_NOT_FOUND The Handle, Label, or FormId was not found.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle Handle of the package where the form to be updated resides.
+ @param Label The label inside the form package where the update is to take place.
+ @param AddData If TRUE, adding data at a given Label; otherwise,
+ if FALSE, removing data at a given Label.
+ @param Data The buffer containing the new tags to insert after the Label
+
+ @retval EFI_SUCCESS The form was updated with the new tags.
+ @retval EFI_INVALID_PARAMETER The buffer for the buffer length does not
+ contain an integral number of tags.
+ @retval EFI_NOT_FOUND The Handle, Label, or FormId was not found.
**/
typedef
@@ -915,15 +836,13 @@ EFI_STATUS /**
Retrieves the current keyboard layout.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param DescriptorCount A pointer to the number of Descriptor entries being
- described in the keyboard layout being retrieved.
-
- @param Descriptor A pointer to a buffer containing an array of EFI_KEY_DESCRIPTOR
- entries. Each entry will reflect the definition of a specific physical key.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param DescriptorCount A pointer to the number of Descriptor entries being
+ described in the keyboard layout being retrieved.
+ @param Descriptor A pointer to a buffer containing an array of EFI_KEY_DESCRIPTOR
+ entries. Each entry will reflect the definition of a specific physical key.
- @retval EFI_SUCCESS The keyboard layout was retrieved successfully.
+ @retval EFI_SUCCESS The keyboard layout was retrieved successfully.
**/
typedef
diff --git a/MdePkg/Include/Protocol/IdeControllerInit.h b/MdePkg/Include/Protocol/IdeControllerInit.h index beaac30e5f..0249055bc5 100644 --- a/MdePkg/Include/Protocol/IdeControllerInit.h +++ b/MdePkg/Include/Protocol/IdeControllerInit.h @@ -263,18 +263,14 @@ typedef union { /**
Returns the information about the specified IDE channel.
- @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
-
- @param Channel Zero-based channel number.
-
- @param Enabled TRUE if this channel is enabled. Disabled channels are not scanned
- to see if any devices are present.
-
- @param MaxDevices The maximum number of IDE devices that the bus driver
- can expect on this channel.
-
- @retval EFI_SUCCESS Information was returned without any errors.
-
+ @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
+ @param Channel Zero-based channel number.
+ @param Enabled TRUE if this channel is enabled. Disabled channels are not scanned
+ to see if any devices are present.
+ @param MaxDevices The maximum number of IDE devices that the bus driver
+ can expect on this channel.
+
+ @retval EFI_SUCCESS Information was returned without any errors.
@retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
**/
@@ -291,19 +287,14 @@ EFI_STATUS The notifications from the IDE bus driver that it is about to enter a certain
phase of the IDE channel enumeration process.
- @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
-
- @param Phase The phase during enumeration.
-
- @param Channel Zero-based channel number.
+ @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
+ @param Phase The phase during enumeration.
+ @param Channel Zero-based channel number.
- @retval EFI_SUCCESS The notification was accepted without any errors.
-
- @retval EFI_NOT_SUPPORTED Phase is not supported.
-
+ @retval EFI_SUCCESS The notification was accepted without any errors.
+ @retval EFI_NOT_SUPPORTED Phase is not supported.
@retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
-
- @retval EFI_NOT_READY This phase cannot be entered at this time.
+ @retval EFI_NOT_READY This phase cannot be entered at this time.
**/
typedef
@@ -317,18 +308,14 @@ EFI_STATUS /**
Submits the device information to the IDE controller driver.
- @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
-
- @param Channel Zero-based channel number.
-
- @param Device Zero-based device number on the Channel.
-
- @param IdentifyData The device¡¯s response to the ATA IDENTIFY_DEVICE command.
+ @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
+ @param Channel Zero-based channel number.
+ @param Device Zero-based device number on the Channel.
+ @param IdentifyData The device¡¯s response to the ATA IDENTIFY_DEVICE command.
- @retval EFI_SUCCESS The information was accepted without any errors.
-
+ @retval EFI_SUCCESS The information was accepted without any errors.
@retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
- Or Device is invalid.
+ Or Device is invalid.
**/
typedef
@@ -343,19 +330,15 @@ EFI_STATUS /**
Disqualifies specific modes for an IDE device.
- @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
-
- @param Channel Zero-based channel number.
-
- @param Device Zero-based device number on the Channel.
-
- @param BadModes The modes that the device does not support and that
- should be disqualified.
-
- @retval EFI_SUCCESS The modes were accepted without any errors.
-
+ @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
+ @param Channel Zero-based channel number.
+ @param Device Zero-based device number on the Channel.
+ @param BadModes The modes that the device does not support and that
+ should be disqualified.
+
+ @retval EFI_SUCCESS The modes were accepted without any errors.
@retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
- Or Device is invalid.
+ Or Device is invalid.
**/
typedef
@@ -370,20 +353,15 @@ EFI_STATUS /**
Returns the information about the optimum modes for the specified IDE device.
- @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
-
- @param Channel Zero-based channel number.
-
- @param Device Zero-based device number on the Channel.
-
- @param SupportedModes The optimum modes for the device.
+ @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
+ @param Channel Zero-based channel number.
+ @param Device Zero-based device number on the Channel.
+ @param SupportedModes The optimum modes for the device.
- @retval EFI_SUCCESS SupportedModes was returned.
-
+ @retval EFI_SUCCESS SupportedModes was returned.
@retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
- Or Device is invalid. Or SupportedModes is NULL.
-
- @retval EFI_NOT_READY Modes cannot be calculated due to a lack of data.
+ Or Device is invalid. Or SupportedModes is NULL.
+ @retval EFI_NOT_READY Modes cannot be calculated due to a lack of data.
**/
typedef
@@ -399,23 +377,17 @@ EFI_STATUS Commands the IDE controller driver to program the IDE controller hardware
so that the specified device can operate at the specified mode.
- @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
-
- @param Channel Zero-based channel number.
-
- @param Device Zero-based device number on the Channel.
-
- @param Modes The modes to set.
+ @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
+ @param Channel Zero-based channel number.
+ @param Device Zero-based device number on the Channel.
+ @param Modes The modes to set.
- @retval EFI_SUCCESS The command was accepted without any errors.
-
+ @retval EFI_SUCCESS The command was accepted without any errors.
@retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
- Or Device is invalid.
-
- @retval EFI_NOT_READY Modes cannot be set at this time due to lack of data.
-
- @retval EFI_DEVICE_ERROR Modes cannot be set due to hardware failure.
- The IDE bus driver should not use this device.
+ Or Device is invalid.
+ @retval EFI_NOT_READY Modes cannot be set at this time due to lack of data.
+ @retval EFI_DEVICE_ERROR Modes cannot be set due to hardware failure.
+ The IDE bus driver should not use this device.
**/
typedef
diff --git a/MdePkg/Include/Protocol/IncompatiblePciDeviceSupport.h b/MdePkg/Include/Protocol/IncompatiblePciDeviceSupport.h index 03a5b2ec08..7357212664 100644 --- a/MdePkg/Include/Protocol/IncompatiblePciDeviceSupport.h +++ b/MdePkg/Include/Protocol/IncompatiblePciDeviceSupport.h @@ -30,22 +30,16 @@ typedef struct _EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL EFI_INCOMPATIBLE_PC Returns a list of ACPI resource descriptors that detail the special
resource configuration requirements for an incompatible PCI device.
- @param This Pointer to the EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL instance.
-
- @param VendorID A unique ID to identify the manufacturer of the PCI device.
-
- @param DeviceID A unique ID to identify the particular PCI device.
-
- @param RevisionID A PCI device-specific revision identifier.
-
- @param SubsystemVendorId Specifies the subsystem vendor ID.
-
- @param SubsystemDeviceId Specifies the subsystem device ID.
-
- @param Configuration A list of ACPI resource descriptors that detail
- the configuration requirement.
-
- @retval EFI_SUCCESS The function always returns EFI_SUCCESS.
+ @param This Pointer to the EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL instance.
+ @param VendorID A unique ID to identify the manufacturer of the PCI device.
+ @param DeviceID A unique ID to identify the particular PCI device.
+ @param RevisionID A PCI device-specific revision identifier.
+ @param SubsystemVendorId Specifies the subsystem vendor ID.
+ @param SubsystemDeviceId Specifies the subsystem device ID.
+ @param Configuration A list of ACPI resource descriptors that detail
+ the configuration requirement.
+
+ @retval EFI_SUCCESS The function always returns EFI_SUCCESS.
**/
typedef
diff --git a/MdePkg/Include/Protocol/Legacy8259.h b/MdePkg/Include/Protocol/Legacy8259.h index c30a5e519c..6be8f89d5b 100644 --- a/MdePkg/Include/Protocol/Legacy8259.h +++ b/MdePkg/Include/Protocol/Legacy8259.h @@ -60,12 +60,12 @@ typedef enum { the legacy mode mask and the protected mode mask. The base address for the 8259
is different for legacy and protected mode, so two masks are required.
- @param This Protocol instance pointer.
- @param MasterBase The base vector for the Master PIC in the 8259 controller
- @param Slavebase The base vector for the Master PIC in the 8259 controller
+ @param This Protocol instance pointer.
+ @param MasterBase The base vector for the Master PIC in the 8259 controller
+ @param Slavebase The base vector for the Master PIC in the 8259 controller
- @retval EFI_SUCCESS The new bases were programmed
- @retval EFI_DEVICE_ERROR A device erro occured programming the vector bases
+ @retval EFI_SUCCESS The new bases were programmed
+ @retval EFI_DEVICE_ERROR A device erro occured programming the vector bases
**/
typedef
@@ -82,14 +82,14 @@ EFI_STATUS the legacy mode mask and the protected mode mask. The base address for the 8259
is different for legacy and protected mode, so two masks are required.
- @param This Protocol instance pointer.
- @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15
- @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
- @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15
- @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
+ @param This Protocol instance pointer.
+ @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15
+ @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
+ @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15
+ @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
- @retval EFI_SUCCESS 8259 status returned
- @retval EFI_DEVICE_ERROR Error reading 8259
+ @retval EFI_SUCCESS 8259 status returned
+ @retval EFI_DEVICE_ERROR Error reading 8259
**/
typedef
@@ -109,14 +109,14 @@ EFI_STATUS is different for legacy and protected mode, so two masks are required.
Also set the edge/level masks.
- @param This Protocol instance pointer.
- @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15
- @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
- @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15
- @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
+ @param This Protocol instance pointer.
+ @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15
+ @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
+ @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15
+ @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
- @retval EFI_SUCCESS 8259 status returned
- @retval EFI_DEVICE_ERROR Error reading 8259
+ @retval EFI_SUCCESS 8259 status returned
+ @retval EFI_DEVICE_ERROR Error reading 8259
**/
typedef
@@ -139,13 +139,13 @@ EFI_STATUS mask for the new mode is Mask, or if Mask does not exist the previously saved
mask is used.
- @param This Protocol instance pointer.
- @param Mode Mode of operation. i.e. real mode or protected mode
- @param Mask Optional interupt mask for the new mode.
- @param EdgeLevel Optional trigger mask for the new mode.
+ @param This Protocol instance pointer.
+ @param Mode Mode of operation. i.e. real mode or protected mode
+ @param Mask Optional interupt mask for the new mode.
+ @param EdgeLevel Optional trigger mask for the new mode.
- @retval EFI_SUCCESS 8259 programmed
- @retval EFI_DEVICE_ERROR Error writting to 8259
+ @retval EFI_SUCCESS 8259 programmed
+ @retval EFI_DEVICE_ERROR Error writting to 8259
**/
typedef
@@ -161,12 +161,12 @@ EFI_STATUS /**
Convert from IRQ to processor interrupt vector number.
- @param This Protocol instance pointer.
- @param Irq 8259 IRQ0 - IRQ15
- @param Vector Processor vector number that matches Irq
+ @param This Protocol instance pointer.
+ @param Irq 8259 IRQ0 - IRQ15
+ @param Vector Processor vector number that matches Irq
- @retval EFI_SUCCESS The Vector matching Irq is returned
- @retval EFI_INVALID_PARAMETER Irq not valid
+ @retval EFI_SUCCESS The Vector matching Irq is returned
+ @retval EFI_INVALID_PARAMETER Irq not valid
**/
typedef
@@ -181,12 +181,12 @@ EFI_STATUS /**
Enable Irq by unmasking interrupt in 8259
- @param This Protocol instance pointer.
- @param Irq 8259 IRQ0 - IRQ15
- @param LevelTriggered TRUE if level triggered. FALSE if edge triggered.
+ @param This Protocol instance pointer.
+ @param Irq 8259 IRQ0 - IRQ15
+ @param LevelTriggered TRUE if level triggered. FALSE if edge triggered.
- @retval EFI_SUCCESS Irq enabled on 8259
- @retval EFI_INVALID_PARAMETER Irq not valid
+ @retval EFI_SUCCESS Irq enabled on 8259
+ @retval EFI_INVALID_PARAMETER Irq not valid
**/
typedef
@@ -201,11 +201,11 @@ EFI_STATUS /**
Disable Irq by masking interrupt in 8259
- @param This Protocol instance pointer.
- @param Irq 8259 IRQ0 - IRQ15
+ @param This Protocol instance pointer.
+ @param Irq 8259 IRQ0 - IRQ15
- @retval EFI_SUCCESS Irq disabled on 8259
- @retval EFI_INVALID_PARAMETER Irq not valid
+ @retval EFI_SUCCESS Irq disabled on 8259
+ @retval EFI_INVALID_PARAMETER Irq not valid
**/
typedef
@@ -222,12 +222,12 @@ EFI_STATUS that is programmed into the Interrupt Line (from the PCI config space)
register.
- @param This Protocol instance pointer.
- @param PciHandle PCI function to return vector for
- @param Vector Vector for fucntion that matches
+ @param This Protocol instance pointer.
+ @param PciHandle PCI function to return vector for
+ @param Vector Vector for fucntion that matches
- @retval EFI_SUCCESS A valid Vector is returned
- @retval EFI_INVALID_PARAMETER PciHandle not valid
+ @retval EFI_SUCCESS A valid Vector is returned
+ @retval EFI_INVALID_PARAMETER PciHandle not valid
**/
typedef
@@ -242,11 +242,11 @@ EFI_STATUS /**
Send an EOI to 8259
- @param This Protocol instance pointer.
- @param Irq 8259 IRQ0 - IRQ15
+ @param This Protocol instance pointer.
+ @param Irq 8259 IRQ0 - IRQ15
- @retval EFI_SUCCESS EOI successfully sent to 8259
- @retval EFI_INVALID_PARAMETER Irq not valid
+ @retval EFI_SUCCESS EOI successfully sent to 8259
+ @retval EFI_INVALID_PARAMETER Irq not valid
**/
typedef
diff --git a/MdePkg/Include/Protocol/LegacyBios.h b/MdePkg/Include/Protocol/LegacyBios.h index aa94cfb74f..c508009b9b 100644 --- a/MdePkg/Include/Protocol/LegacyBios.h +++ b/MdePkg/Include/Protocol/LegacyBios.h @@ -343,14 +343,14 @@ typedef struct { of BiosInt. Regs will contain the 16-bit register context on entry and
exit.
- @param This Protocol instance pointer.
- @param BiosInt Processor interrupt vector to invoke
- @param Reg Register contexted passed into (and returned) from thunk to
- 16-bit mode
+ @param This Protocol instance pointer.
+ @param BiosInt Processor interrupt vector to invoke
+ @param Reg Register contexted passed into (and returned) from thunk to
+ 16-bit mode
- @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
- See Regs for status.
- @retval TRUE There was a BIOS erro in the target code.
+ @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
+ See Regs for status.
+ @retval TRUE There was a BIOS erro in the target code.
**/
typedef
@@ -367,17 +367,17 @@ BOOLEAN 16-bit register context on entry and exit. Arguments can be passed on
the Stack argument
- @param This Protocol instance pointer.
- @param Segment Segemnt of 16-bit mode call
- @param Offset Offset of 16-bit mdoe call
- @param Reg Register contexted passed into (and returned) from thunk to
- 16-bit mode
- @param Stack Caller allocated stack used to pass arguments
- @param StackSize Size of Stack in bytes
+ @param This Protocol instance pointer.
+ @param Segment Segemnt of 16-bit mode call
+ @param Offset Offset of 16-bit mdoe call
+ @param Reg Register contexted passed into (and returned) from thunk to
+ 16-bit mode
+ @param Stack Caller allocated stack used to pass arguments
+ @param StackSize Size of Stack in bytes
- @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
- See Regs for status.
- @retval TRUE There was a BIOS erro in the target code.
+ @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
+ See Regs for status.
+ @retval TRUE There was a BIOS erro in the target code.
**/
typedef
@@ -405,14 +405,14 @@ EFI_STATUS Test to see if a legacy PCI ROM exists for this device. Optionally return
the Legacy ROM instance for this PCI device.
- @param This Protocol instance pointer.
- @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded
- @param RomImage Return the legacy PCI ROM for this device
- @param RomSize Size of ROM Image
- @param Flags Indicates if ROM found and if PC-AT.
+ @param This Protocol instance pointer.
+ @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded
+ @param RomImage Return the legacy PCI ROM for this device
+ @param RomSize Size of ROM Image
+ @param Flags Indicates if ROM found and if PC-AT.
- @retval EFI_SUCCESS Legacy Option ROM availible for this device
- @retval EFI_UNSUPPORTED Legacy Option ROM not supported.
+ @retval EFI_SUCCESS Legacy Option ROM availible for this device
+ @retval EFI_UNSUPPORTED Legacy Option ROM not supported.
**/
)
@@ -423,23 +423,23 @@ EFI_STATUS about how many disks were added by the OPROM and the shadow address and
size. DiskStart & DiskEnd are INT 13h drive letters. Thus 0x80 is C:
- @param This Protocol instance pointer.
- @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded.
- This value is NULL if RomImage is non-NULL. This is the normal
- case.
- @param RomImage A PCI PC-AT ROM image. This argument is non-NULL if there is
- no hardware associated with the ROM and thus no PciHandle,
- otherwise is must be NULL.
- Example is PXE base code.
- @param Flags Return Status if ROM was found and if was Legacy OPROM.
- @param DiskStart Disk number of first device hooked by the ROM. If DiskStart
- is the same as DiskEnd no disked were hooked.
- @param DiskEnd Disk number of the last device hooked by the ROM.
- @param RomShadowAddress Shadow address of PC-AT ROM
- @param RomShadowSize Size of RomShadowAddress in bytes
-
- @retval EFI_SUCCESS Thunk completed, see Regs for status.
- @retval EFI_INVALID_PARAMETER PciHandle not found
+ @param This Protocol instance pointer.
+ @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded.
+ This value is NULL if RomImage is non-NULL. This is the normal
+ case.
+ @param RomImage A PCI PC-AT ROM image. This argument is non-NULL if there is
+ no hardware associated with the ROM and thus no PciHandle,
+ otherwise is must be NULL.
+ Example is PXE base code.
+ @param Flags Return Status if ROM was found and if was Legacy OPROM.
+ @param DiskStart Disk number of first device hooked by the ROM. If DiskStart
+ is the same as DiskEnd no disked were hooked.
+ @param DiskEnd Disk number of the last device hooked by the ROM.
+ @param RomShadowAddress Shadow address of PC-AT ROM
+ @param RomShadowSize Size of RomShadowAddress in bytes
+
+ @retval EFI_SUCCESS Thunk completed, see Regs for status.
+ @retval EFI_INVALID_PARAMETER PciHandle not found
**/
typedef
@@ -460,24 +460,24 @@ EFI_STATUS Attempt to legacy boot the BootOption. If the EFI contexted has been
compromised this function will not return.
- @param This Protocol instance pointer.
- @param BootOption EFI Device Path from BootXXXX variable.
- @param LoadOptionSize Size of LoadOption in size.
- @param LoadOption LoadOption from BootXXXX variable
+ @param This Protocol instance pointer.
+ @param BootOption EFI Device Path from BootXXXX variable.
+ @param LoadOptionSize Size of LoadOption in size.
+ @param LoadOption LoadOption from BootXXXX variable
- @retval EFI_SUCCESS Removable media not present
+ @retval EFI_SUCCESS Removable media not present
**/
/**
Update BDA with current Scroll, Num & Cap lock LEDS
- @param This Protocol instance pointer.
- @param Leds Status of current Scroll, Num & Cap lock LEDS
- Bit 0 is Scroll Lock 0 = Not locked
- Bit 1 is Num Lock
- Bit 2 is Caps Lock
+ @param This Protocol instance pointer.
+ @param Leds Status of current Scroll, Num & Cap lock LEDS
+ Bit 0 is Scroll Lock 0 = Not locked
+ Bit 1 is Num Lock
+ Bit 2 is Caps Lock
- @retval EFI_SUCCESS Removable media not present
+ @retval EFI_SUCCESS Removable media not present
**/
typedef
@@ -500,13 +500,13 @@ EFI_STATUS /**
Retrieve legacy BBS info and assign boot priority.
- @param This Protocol instance pointer.
- @param HddCount Number of HDD_INFO structures
- @param HddInfo Onboard IDE controller information
- @param BbsCount Number of BBS_TABLE structures
- @param BbsTable List BBS entries
+ @param This Protocol instance pointer.
+ @param HddCount Number of HDD_INFO structures
+ @param HddInfo Onboard IDE controller information
+ @param BbsCount Number of BBS_TABLE structures
+ @param BbsTable List BBS entries
- @retval EFI_SUCCESS Tables returned
+ @retval EFI_SUCCESS Tables returned
**/
typedef
@@ -524,11 +524,11 @@ EFI_STATUS Assign drive number to legacy HDD drives prior to booting an EFI
aware OS so the OS can access drives without an EFI driver.
- @param This Protocol instance pointer.
- @param BbsCount Number of BBS_TABLE structures
- @param BbsTable List BBS entries
+ @param This Protocol instance pointer.
+ @param BbsCount Number of BBS_TABLE structures
+ @param BbsTable List BBS entries
- @retval EFI_SUCCESS Drive numbers assigned
+ @retval EFI_SUCCESS Drive numbers assigned
**/
typedef
@@ -544,14 +544,14 @@ EFI_STATUS To boot from an unconventional device like parties and/or execute
HDD diagnostics.
- @param This Protocol instance pointer.
- @param Attributes How to interpret the other input parameters
- @param BbsEntry The 0-based index into the BbsTable for the parent
- device.
- @param BeerData Pointer to the 128 bytes of ram BEER data.
- @param ServiceAreaData Pointer to the 64 bytes of raw Service Area data. The
- caller must provide a pointer to the specific Service
- Area and not the start all Service Areas.
+ @param This Protocol instance pointer.
+ @param Attributes How to interpret the other input parameters
+ @param BbsEntry The 0-based index into the BbsTable for the parent
+ device.
+ @param BeerData Pointer to the 128 bytes of ram BEER data.
+ @param ServiceAreaData Pointer to the 64 bytes of raw Service Area data. The
+ caller must provide a pointer to the specific Service
+ Area and not the start all Service Areas.
EFI_INVALID_PARAMETER if error. Does NOT return if no error.
@@ -573,7 +573,7 @@ EFI_STATUS drivers. If used externally then caller must re-connect EFI
drivers.
- @retval EFI_SUCCESS OPROMs shadowed
+ @retval EFI_SUCCESS OPROMs shadowed
**/
typedef
@@ -586,19 +586,18 @@ EFI_STATUS /**
Get a region from the LegacyBios for S3 usage.
- @param This Protocol instance pointer.
- @param LegacyMemorySize Size of required region
- @param Region Region to use.
- 00 = Either 0xE0000 or 0xF0000 block
- Bit0 = 1 0xF0000 block
- Bit1 = 1 0xE0000 block
- @param Alignment Address alignment. Bit mapped. First non-zero
- bit from right is alignment.
- @param LegacyMemoryAddress Region Assigned
+ @param This Protocol instance pointer.
+ @param LegacyMemorySize Size of required region
+ @param Region Region to use.
+ 00 = Either 0xE0000 or 0xF0000 block
+ Bit0 = 1 0xF0000 block
+ Bit1 = 1 0xE0000 block
+ @param Alignment Address alignment. Bit mapped. First non-zero
+ bit from right is alignment.
+ @param LegacyMemoryAddress Region Assigned
- @retval EFI_SUCCESS Region assigned
-
- @retval Other Region not assigned
+ @retval EFI_SUCCESS Region assigned
+ @retval Other Region not assigned
**/
typedef
@@ -615,15 +614,16 @@ EFI_STATUS /**
Get a region from the LegacyBios for Tiano usage. Can only be invoked once.
- @param This Protocol instance pointer.
- @param LegacyMemorySize Size of data to copy
- @param LegacyMemoryAddress Legacy Region destination address
- Note: must be in region assigned by
- LegacyBiosGetLegacyRegion
- @param LegacyMemorySourceAddress Source of data
+ @param This Protocol instance pointer.
+ @param LegacyMemorySize Size of data to copy
+ @param LegacyMemoryAddress Legacy Region destination address
+ Note: must be in region assigned by
+ LegacyBiosGetLegacyRegion
+ @param LegacyMemorySourceAddress
+ Source of data
- @retval EFI_SUCCESS Region assigned
- @retval EFI_ACCESS_DENIED Destination outside assigned region
+ @retval EFI_SUCCESS Region assigned
+ @retval EFI_ACCESS_DENIED Destination outside assigned region
**/
typedef
diff --git a/MdePkg/Include/Protocol/LegacyBiosPlatform.h b/MdePkg/Include/Protocol/LegacyBiosPlatform.h index 56d6724180..8a0604f5d0 100644 --- a/MdePkg/Include/Protocol/LegacyBiosPlatform.h +++ b/MdePkg/Include/Protocol/LegacyBiosPlatform.h @@ -79,24 +79,24 @@ typedef enum { /**
Finds the binary data or other platform information.
- @param This Protocol instance pointer.
- @param Mode Specifies what data to return
- @param Table Pointer to MP table.
- @param TableSize Size in bytes of table.
- @param Location Legacy region requested
- 0x00 = Any location
- Bit 0 = 0xF0000 region
- Bit 1 = 0xE0000 region
- Multiple bits can be set
- @param Alignment Address alignment for allocation.
- Bit mapped. First non-zero bit from right
- is alignment.
- @param LegacySegment Segment in LegacyBios where Table is stored
- @param LegacyOffset Offset in LegacyBios where Table is stored
-
- @retval EFI_SUCCESS Data was returned successfully.
- @retval EFI_UNSUPPORTED Mode is not supported on the platform.
- @retval EFI_NOT_FOUND Binary image or table not found.
+ @param This Protocol instance pointer.
+ @param Mode Specifies what data to return
+ @param Table Pointer to MP table.
+ @param TableSize Size in bytes of table.
+ @param Location Legacy region requested
+ 0x00 = Any location
+ Bit 0 = 0xF0000 region
+ Bit 1 = 0xE0000 region
+ Multiple bits can be set
+ @param Alignment Address alignment for allocation.
+ Bit mapped. First non-zero bit from right
+ is alignment.
+ @param LegacySegment Segment in LegacyBios where Table is stored
+ @param LegacyOffset Offset in LegacyBios where Table is stored
+
+ @retval EFI_SUCCESS Data was returned successfully.
+ @retval EFI_UNSUPPORTED Mode is not supported on the platform.
+ @retval EFI_NOT_FOUND Binary image or table not found.
**/
typedef
@@ -116,17 +116,17 @@ EFI_STATUS /**
Returns a buffer of handles for the requested sub-function.
- @param This Protocol instance pointer.
- @param Mode Specifies what handle to return.
- @param Type Type from Device Path for Handle to represent.
- @param HandleBuffer Handles of the device/controller in priority order
- with HandleBuffer[0] highest priority.
- @param HandleCount Number of handles in the buffer.
- @param AdditionalData Mode specific.
+ @param This Protocol instance pointer.
+ @param Mode Specifies what handle to return.
+ @param Type Type from Device Path for Handle to represent.
+ @param HandleBuffer Handles of the device/controller in priority order
+ with HandleBuffer[0] highest priority.
+ @param HandleCount Number of handles in the buffer.
+ @param AdditionalData Mode specific.
- @retval EFI_SUCCESS Handle is valid
- @retval EFI_UNSUPPORTED Mode is not supported on the platform.
- @retval EFI_NOT_FOUND Handle is not known
+ @retval EFI_SUCCESS Handle is valid
+ @retval EFI_UNSUPPORTED Mode is not supported on the platform.
+ @retval EFI_NOT_FOUND Handle is not known
**/
typedef
@@ -144,11 +144,11 @@ EFI_STATUS /**
Load and initialize the Legacy BIOS SMM handler.
- @param This Protocol instance pointer.
+ @param This Protocol instance pointer.
@param EfiToLegacy16BootTable Pointer to Legacy16 boot table.
- @retval EFI_SUCCESS SMM code loaded.
- @retval EFI_DEVICE_ERROR SMM code failed to load
+ @retval EFI_SUCCESS SMM code loaded.
+ @retval EFI_DEVICE_ERROR SMM code failed to load
**/
typedef
@@ -162,16 +162,16 @@ EFI_STATUS /**
Allows platform to perform any required action after a LegacyBios operation.
- @param This Protocol instance pointer.
- @param Mode Specifies what handle to return.
- @param Type Mode specific.
- @param DeviceHandle List of PCI devices in the system.
- @param ShadowAddress First free OpROM area, after other OpROMs have been dispatched.
- @param Compatibility16Table Pointer to Compatibility16Table.
- @param AdditionalData Mode specific Pointer to additional data returned ¨C mode specific.
+ @param This Protocol instance pointer.
+ @param Mode Specifies what handle to return.
+ @param Type Mode specific.
+ @param DeviceHandle List of PCI devices in the system.
+ @param ShadowAddress First free OpROM area, after other OpROMs have been dispatched.
+ @param Compatibility16Table Pointer to Compatibility16Table.
+ @param AdditionalData Mode specific Pointer to additional data returned ¨C mode specific.
- @retval EFI_SUCCESS RomImage is valid
- @retval EFI_UNSUPPORTED Mode is not supported on the platform.
+ @retval EFI_SUCCESS RomImage is valid
+ @retval EFI_UNSUPPORTED Mode is not supported on the platform.
**/
typedef
@@ -190,15 +190,15 @@ EFI_STATUS /**
Returns information associated with PCI IRQ routing.
- @param This Protocol instance pointer.
- @param RoutingTable Pointer to PCI IRQ Routing table.
- @param RoutingTableEntries Number of entries in table.
- @param LocalPirqTable $PIR table
- @param PirqTableSize $PIR table size
- @param LocalIrqPriorityTable List of interrupts in priority order to assign
- @param IrqPriorityTableEntries- Number of entries in priority table
+ @param This Protocol instance pointer.
+ @param RoutingTable Pointer to PCI IRQ Routing table.
+ @param RoutingTableEntries Number of entries in table.
+ @param LocalPirqTable $PIR table
+ @param PirqTableSize $PIR table size
+ @param LocalIrqPriorityTable List of interrupts in priority order to assign
+ @param IrqPriorityTableEntries Number of entries in priority table
- @retval EFI_SUCCESS Data was successfully returned.
+ @retval EFI_SUCCESS Data was successfully returned.
**/
typedef
@@ -217,15 +217,15 @@ EFI_STATUS /**
Translates the given PIRQ accounting for bridge
- @param This Protocol instance pointer.
- @param PciBus PCI bus number for this device.
- @param PciDevice PCI device number for this device.
- @param PciFunction PCI function number for this device.
- @param Pirq Input is PIRQ reported by device, output is true PIRQ.
- @param PciIrq The IRQ already assigned to the PIRQ or the IRQ to be
- assigned to the PIRQ.
+ @param This Protocol instance pointer.
+ @param PciBus PCI bus number for this device.
+ @param PciDevice PCI device number for this device.
+ @param PciFunction PCI function number for this device.
+ @param Pirq Input is PIRQ reported by device, output is true PIRQ.
+ @param PciIrq The IRQ already assigned to the PIRQ or the IRQ to be
+ assigned to the PIRQ.
- @retval EFI_SUCCESS The PIRQ was translated.
+ @retval EFI_SUCCESS The PIRQ was translated.
**/
typedef
@@ -244,14 +244,14 @@ EFI_STATUS Attempt to legacy boot the BootOption. If the EFI contexted has been
compromised this function will not return.
- @param This Protocol instance pointer.
- @param BbsDevicePath EFI Device Path from BootXXXX variable.
- @param BbsTable Internal BBS table.
- @param LoadOptionSize Size of LoadOption in size.
- @param LoadOption LoadOption from BootXXXX variable
+ @param This Protocol instance pointer.
+ @param BbsDevicePath EFI Device Path from BootXXXX variable.
+ @param BbsTable Internal BBS table.
+ @param LoadOptionSize Size of LoadOption in size.
+ @param LoadOption LoadOption from BootXXXX variable
@param EfiToLegacy16BootTable Pointer to BootTable structure
- @retval EFI_SUCCESS Ready to boot.
+ @retval EFI_SUCCESS Ready to boot.
**/
typedef
diff --git a/MdePkg/Include/Protocol/LegacyInterrupt.h b/MdePkg/Include/Protocol/LegacyInterrupt.h index 54dc9aaa9b..9f69808bd7 100644 --- a/MdePkg/Include/Protocol/LegacyInterrupt.h +++ b/MdePkg/Include/Protocol/LegacyInterrupt.h @@ -31,10 +31,10 @@ typedef struct _EFI_LEGACY_INTERRUPT_PROTOCOL EFI_LEGACY_INTERRUPT_PROTOCOL; /**
Get the number of PIRQs this hardware supports.
- @param This Protocol instance pointer.
- @param NumberPirsq Number of PIRQs.
+ @param This Protocol instance pointer.
+ @param NumberPirsq Number of PIRQs.
- @retval EFI_SUCCESS Number of PIRQs returned.
+ @retval EFI_SUCCESS Number of PIRQs returned.
**/
typedef
@@ -47,12 +47,12 @@ EFI_STATUS /**
Gets the PCI location associated with this protocol.
- @param This Protocol instance pointer.
- @param Bus PCI Bus
- @param Device PCI Device
- @param Function PCI Function
+ @param This Protocol instance pointer.
+ @param Bus PCI Bus
+ @param Device PCI Device
+ @param Function PCI Function
- @retval EFI_SUCCESS Bus/Device/Function returned
+ @retval EFI_SUCCESS Bus/Device/Function returned
**/
typedef
@@ -67,12 +67,12 @@ EFI_STATUS /**
Read the PIRQ register and return the data
- @param This Protocol instance pointer.
- @param PirqNumber PIRQ register to read
- @param PirqData Data read
+ @param This Protocol instance pointer.
+ @param PirqNumber PIRQ register to read
+ @param PirqData Data read
- @retval EFI_SUCCESS Data was read
- @retval EFI_INVALID_PARAMETER Invalid PIRQ number
+ @retval EFI_SUCCESS Data was read
+ @retval EFI_INVALID_PARAMETER Invalid PIRQ number
**/
typedef
@@ -86,12 +86,12 @@ EFI_STATUS /**
Write the specified PIRQ register with the given data.
- @param This Protocol instance pointer.
- @param PirqNumber PIRQ register to read.
- @param PirqData Data written.
+ @param This Protocol instance pointer.
+ @param PirqNumber PIRQ register to read.
+ @param PirqData Data written.
- @retval EFI_SUCCESS Table pointer returned
- @retval EFI_INVALID_PARAMETER Invalid PIRQ number
+ @retval EFI_SUCCESS Table pointer returned
+ @retval EFI_INVALID_PARAMETER Invalid PIRQ number
**/
typedef
diff --git a/MdePkg/Include/Protocol/LegacyRegion.h b/MdePkg/Include/Protocol/LegacyRegion.h index db7d346186..9016ecbf32 100644 --- a/MdePkg/Include/Protocol/LegacyRegion.h +++ b/MdePkg/Include/Protocol/LegacyRegion.h @@ -31,15 +31,12 @@ typedef struct _EFI_LEGACY_REGION_PROTOCOL EFI_LEGACY_REGION_PROTOCOL; /**
Sets hardware to decode or not decode a region.
- @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
-
- @param Start Start of region to decode.
-
- @param Length Size in bytes of the region.
-
- @param On Decode/nondecode flag.
+ @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
+ @param Start Start of region to decode.
+ @param Length Size in bytes of the region.
+ @param On Decode/nondecode flag.
- @retval EFI_SUCCESS Decode range successfully changed.
+ @retval EFI_SUCCESS Decode range successfully changed.
**/
typedef
@@ -54,15 +51,12 @@ EFI_STATUS /**
Sets a region to read only.
- @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
-
- @param Start Start of region to lock.
-
- @param Length Size in bytes of the region.
-
- @param Granularity Lock attribute affects this granularity in bytes.
+ @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
+ @param Start Start of region to lock.
+ @param Length Size in bytes of the region.
+ @param Granularity Lock attribute affects this granularity in bytes.
- @retval EFI_SUCCESS The region was made read only.
+ @retval EFI_SUCCESS The region was made read only.
**/
typedef
@@ -78,15 +72,12 @@ EFI_STATUS Sets a region to read only and ensures that flash is locked from being
inadvertently modified.
- @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
-
- @param Start Start of region to lock.
-
- @param Length Size in bytes of the region.
-
- @param Granularity Lock attribute affects this granularity in bytes.
+ @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
+ @param Start Start of region to lock.
+ @param Length Size in bytes of the region.
+ @param Granularity Lock attribute affects this granularity in bytes.
- @retval EFI_SUCCESS The region was made read only and flash is locked.
+ @retval EFI_SUCCESS The region was made read only and flash is locked.
**/
typedef
@@ -101,15 +92,12 @@ EFI_STATUS /**
Sets a region to read-write.
- @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
-
- @param Start Start of region to lock.
-
- @param Length Size in bytes of the region.
-
- @param Granularity Lock attribute affects this granularity in bytes.
+ @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
+ @param Start Start of region to lock.
+ @param Length Size in bytes of the region.
+ @param Granularity Lock attribute affects this granularity in bytes.
- @retval EFI_SUCCESS The region was successfully made read-write.
+ @retval EFI_SUCCESS The region was successfully made read-write.
**/
typedef
diff --git a/MdePkg/Include/Protocol/Mtftp4.h b/MdePkg/Include/Protocol/Mtftp4.h index 840e04b4f3..cb2f3f5451 100644 --- a/MdePkg/Include/Protocol/Mtftp4.h +++ b/MdePkg/Include/Protocol/Mtftp4.h @@ -303,7 +303,6 @@ EFI_STATUS @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
@retval EFI_UNSUPPORTED One or more options in the OptionList are in the
unsupported list of structure EFI_MTFTP4_MODE_DATA.
-
@retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started.
@retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
RARP, etc.) has not finished yet.
@@ -395,9 +394,9 @@ EFI_STATUS /**
Sends a file to an MTFTPv4 server.
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.
+ @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.
@param Token Pointer to the token structure to provide the parameters that are
- used in this operation.
+ used in this operation.
@retval EFI_SUCCESS The upload session has started.
@retval EFI_UNSUPPORTED The operation is not supported by this implementation.
diff --git a/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h b/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h index 9d83c5aedb..147d07c8f7 100644 --- a/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h +++ b/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h @@ -128,13 +128,13 @@ typedef enum { /**
Enter a certain phase of the PCI enumeration process
- @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance
- @param Phase The phase during enumeration
+ @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance
+ @param Phase The phase during enumeration
- @retval EFI_SUCCESS Success
- @retval EFI_OUT_OF_RESOURCES If SubmitResources ( ) could not allocate resources
- @retval EFI_NOT_READY This phase cannot be entered at this time
- @retval EFI_DEVICE_ERROR SetResources failed due to HW error.
+ @retval EFI_SUCCESS Success
+ @retval EFI_OUT_OF_RESOURCES If SubmitResources ( ) could not allocate resources
+ @retval EFI_NOT_READY This phase cannot be entered at this time
+ @retval EFI_DEVICE_ERROR SetResources failed due to HW error.
**/
typedef
@@ -149,14 +149,14 @@ EFI_STATUS Return the device handle of the next PCI root bridge that is associated with
this Host Bridge
- @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
- @param RootBridgeHandle Returns the device handle of the next PCI Root Bridge.
- On input, it holds the RootBridgeHandle returned by the most
- recent call to GetNextRootBridge().The handle for the first
- PCI Root Bridge is returned if RootBridgeHandle is NULL on input
+ @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
+ @param RootBridgeHandle Returns the device handle of the next PCI Root Bridge.
+ On input, it holds the RootBridgeHandle returned by the most
+ recent call to GetNextRootBridge().The handle for the first
+ PCI Root Bridge is returned if RootBridgeHandle is NULL on input
- @retval EFI_SUCCESS Success
- @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
+ @retval EFI_SUCCESS Success
+ @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
**/
typedef
@@ -170,14 +170,14 @@ EFI_STATUS /**
Returns the attributes of a PCI Root Bridge.
- @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
- @param RootBridgeHandle The device handle of the PCI Root Bridge
- that the caller is interested in
- @param Attribute The pointer to attributes of the PCI Root Bridge
+ @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
+ @param RootBridgeHandle The device handle of the PCI Root Bridge
+ that the caller is interested in
+ @param Attribute The pointer to attributes of the PCI Root Bridge
- @retval EFI_SUCCESS Success
- @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
- @retval EFI_INVALID_PARAMETER Attributes is NULL
+ @retval EFI_SUCCESS Success
+ @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
+ @retval EFI_INVALID_PARAMETER Attributes is NULL
**/
typedef
@@ -193,14 +193,14 @@ EFI_STATUS This is the request from the PCI enumerator to set up
the specified PCI Root Bridge for bus enumeration process.
- @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
- @param RootBridgeHandle The PCI Root Bridge to be set up
- @param Configuration Pointer to the pointer to the PCI bus resource descriptor
+ @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
+ @param RootBridgeHandle The PCI Root Bridge to be set up
+ @param Configuration Pointer to the pointer to the PCI bus resource descriptor
- @retval EFI_SUCCESS Success
- @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
- @retval EFI_DEVICE_ERROR Request failed due to hardware error
- @retval EFI_OUT_OF_RESOURCES Request failed due to lack of resources
+ @retval EFI_SUCCESS Success
+ @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
+ @retval EFI_DEVICE_ERROR Request failed due to hardware error
+ @retval EFI_OUT_OF_RESOURCES Request failed due to lack of resources
**/
typedef
@@ -216,20 +216,20 @@ EFI_STATUS This function programs the PCI Root Bridge hardware so that
it decodes the specified PCI bus range
- @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
- @param RootBridgeHandle The PCI Root Bridge whose bus range is to be programmed
- @param Configuration The pointer to the PCI bus resource descriptor
-
- @retval EFI_SUCCESS Success
- @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
- @retval EFI_INVALID_PARAMETER Configuration is NULL
- @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI resource descriptor
- @retval EFI_INVALID_PARAMETER Configuration contains one or more memory or IO ACPI resource descriptor
- @retval EFI_INVALID_PARAMETER Address Range Minimum or Address Range Length fields in Configuration
- are invalid for this Root Bridge.
- @retval EFI_INVALID_PARAMETER Configuration contains one or more invalid ACPI resource descriptor
- @retval EFI_DEVICE_ERROR Request failed due to hardware error
- @retval EFI_OUT_OF_RESOURCES Request failed due to lack of resources
+ @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
+ @param RootBridgeHandle The PCI Root Bridge whose bus range is to be programmed
+ @param Configuration The pointer to the PCI bus resource descriptor
+
+ @retval EFI_SUCCESS Success
+ @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
+ @retval EFI_INVALID_PARAMETER Configuration is NULL
+ @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI resource descriptor
+ @retval EFI_INVALID_PARAMETER Configuration contains one or more memory or IO ACPI resource descriptor
+ @retval EFI_INVALID_PARAMETER Address Range Minimum or Address Range Length fields in Configuration
+ are invalid for this Root Bridge.
+ @retval EFI_INVALID_PARAMETER Configuration contains one or more invalid ACPI resource descriptor
+ @retval EFI_DEVICE_ERROR Request failed due to hardware error
+ @retval EFI_OUT_OF_RESOURCES Request failed due to lack of resources
**/
typedef
@@ -244,16 +244,16 @@ EFI_STATUS /**
Submits the I/O and memory resource requirements for the specified PCI Root Bridge
- @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
- @param RootBridgeHandle The PCI Root Bridge whose I/O and memory resource requirements
- are being submitted
- @param Configuration The pointer to the PCI I/O and PCI memory resource descriptor
+ @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
+ @param RootBridgeHandle The PCI Root Bridge whose I/O and memory resource requirements
+ are being submitted
+ @param Configuration The pointer to the PCI I/O and PCI memory resource descriptor
- @retval EFI_SUCCESS Success
- @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
- @retval EFI_INVALID_PARAMETER Configuration is NULL
- @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI resource descriptor
- @retval EFI_INVALID_PARAMETER Configuration includes a resource descriptor of unsupported type
+ @retval EFI_SUCCESS Success
+ @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
+ @retval EFI_INVALID_PARAMETER Configuration is NULL
+ @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI resource descriptor
+ @retval EFI_INVALID_PARAMETER Configuration includes a resource descriptor of unsupported type
**/
typedef
@@ -269,15 +269,15 @@ EFI_STATUS This function returns the proposed resource settings for the specified
PCI Root Bridge
- @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
- @param RootBridgeHandle The PCI Root Bridge handle
- @param Configuration The pointer to the pointer to the PCI I/O
- and memory resource descriptor
+ @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
+ @param RootBridgeHandle The PCI Root Bridge handle
+ @param Configuration The pointer to the pointer to the PCI I/O
+ and memory resource descriptor
- @retval EFI_SUCCESS Success
- @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
- @retval EFI_DEVICE_ERROR Request failed due to hardware error
- @retval EFI_OUT_OF_RESOURCES Request failed due to lack of resources
+ @retval EFI_SUCCESS Success
+ @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
+ @retval EFI_DEVICE_ERROR Request failed due to hardware error
+ @retval EFI_OUT_OF_RESOURCES Request failed due to lack of resources
**/
typedef
@@ -294,14 +294,14 @@ EFI_STATUS This function is called for all the PCI controllers that the PCI
bus driver finds. Can be used to Preprogram the controller.
- @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
- @param RootBridgeHandle The PCI Root Bridge handle
- @param PciBusAddress Address of the controller on the PCI bus
- @param Phase The Phase during resource allocation
+ @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
+ @param RootBridgeHandle The PCI Root Bridge handle
+ @param PciBusAddress Address of the controller on the PCI bus
+ @param Phase The Phase during resource allocation
- @retval EFI_SUCCESS Success
- @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
- @retval EFI_DEVICE_ERROR Device pre-initialization failed due to hardware error.
+ @retval EFI_SUCCESS Success
+ @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
+ @retval EFI_DEVICE_ERROR Device pre-initialization failed due to hardware error.
**/
typedef
diff --git a/MdePkg/Include/Protocol/PciHotPlugInit.h b/MdePkg/Include/Protocol/PciHotPlugInit.h index b4b5a3d4b9..efd4c454a6 100644 --- a/MdePkg/Include/Protocol/PciHotPlugInit.h +++ b/MdePkg/Include/Protocol/PciHotPlugInit.h @@ -51,17 +51,13 @@ typedef enum{ Returns a list of root Hot Plug Controllers (HPCs) that require initialization
during the boot process.
- @param This Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance.
-
- @param HpcCount The number of root HPCs that were returned.
-
- @param HpcList The list of root HPCs. HpcCount defines the number of
- elements in this list.
+ @param This Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance.
+ @param HpcCount The number of root HPCs that were returned.
+ @param HpcList The list of root HPCs. HpcCount defines the number of
+ elements in this list.
- @retval EFI_SUCCESS HpcList was returned.
-
- @retval EFI_OUT_OF_RESOURCES HpcList was not returned due to insufficient resources.
-
+ @retval EFI_SUCCESS HpcList was returned.
+ @retval EFI_OUT_OF_RESOURCES HpcList was not returned due to insufficient resources.
@retval EFI_INVALID_PARAMETER HpcCount is NULL or HpcList is NULL.
**/
@@ -77,27 +73,20 @@ EFI_STATUS Initializes one root Hot Plug Controller (HPC). This process may causes
initialization of its subordinate buses.
- @param This Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance.
-
- @param HpcDevicePath The device path to the HPC that is being initialized.
-
- @param HpcPciAddress The address of the HPC function on the PCI bus.
-
- @param Event The event that should be signaled when the HPC initialization
- is complete.
-
- @param HpcState The state of the HPC hardware.
-
- @retval EFI_SUCCESS If Event is NULL, the specific HPC was successfully
- initialized. If Event is not NULL, Event will be signaled at a later time
- when initialization is complete.
-
- @retval EFI_UNSUPPORTED This instance of EFI_PCI_HOT_PLUG_INIT_PROTOCOL
- does not support the specified HPC.
-
- @retval EFI_OUT_OF_RESOURCES Initialization failed due to insufficient
- resources.
-
+ @param This Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance.
+ @param HpcDevicePath The device path to the HPC that is being initialized.
+ @param HpcPciAddress The address of the HPC function on the PCI bus.
+ @param Event The event that should be signaled when the HPC initialization
+ is complete.
+ @param HpcState The state of the HPC hardware.
+
+ @retval EFI_SUCCESS If Event is NULL, the specific HPC was successfully
+ initialized. If Event is not NULL, Event will be signaled at a later time
+ when initialization is complete.
+ @retval EFI_UNSUPPORTED This instance of EFI_PCI_HOT_PLUG_INIT_PROTOCOL
+ does not support the specified HPC.
+ @retval EFI_OUT_OF_RESOURCES Initialization failed due to insufficient
+ resources.
@retval EFI_INVALID_PARAMETER HpcState is NULL.
**/
@@ -115,31 +104,22 @@ EFI_STATUS Returns the resource padding that is required by the PCI bus that is controlled
by the specified Hot Plug Controller (HPC).
- @param This Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance.
-
- @param HpcDevicePath The device path to the HPC.
-
- @param HpcPciAddress The address of the HPC function on the PCI bus.
-
- @param HpcState The state of the HPC hardware.
-
- @param Padding The amount of resource padding that is required by the
- PCI bus under the control of the specified HPC.
-
- @param Attributes Describes how padding is accounted for. The padding
- is returned in the form of ACPI 2.0 resource descriptors.
-
- @retval EFI_SUCCESS The resource padding was successfully returned.
-
- @retval EFI_UNSUPPORTED This instance of the EFI_PCI_HOT_PLUG_INIT_PROTOCOL
- does not support the specified HPC.
-
- @retval EFI_NOT_READY This function was called before HPC initialization is complete.
-
- @retval EFI_INVALID_PARAMETER HpcState or Padding or Attributes is NULL.
-
- @retval EFI_OUT_OF_RESOURCES ACPI 2.0 resource descriptors for Padding
- cannot be allocated due to insufficient resources.
+ @param This Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance.
+ @param HpcDevicePath The device path to the HPC.
+ @param HpcPciAddress The address of the HPC function on the PCI bus.
+ @param HpcState The state of the HPC hardware.
+ @param Padding The amount of resource padding that is required by the
+ PCI bus under the control of the specified HPC.
+ @param Attributes Describes how padding is accounted for. The padding
+ is returned in the form of ACPI 2.0 resource descriptors.
+
+ @retval EFI_SUCCESS The resource padding was successfully returned.
+ @retval EFI_UNSUPPORTED This instance of the EFI_PCI_HOT_PLUG_INIT_PROTOCOL
+ does not support the specified HPC.
+ @retval EFI_NOT_READY This function was called before HPC initialization is complete.
+ @retval EFI_INVALID_PARAMETER HpcState or Padding or Attributes is NULL.
+ @retval EFI_OUT_OF_RESOURCES ACPI 2.0 resource descriptors for Padding
+ cannot be allocated due to insufficient resources.
**/
typedef
diff --git a/MdePkg/Include/Protocol/PciPlatform.h b/MdePkg/Include/Protocol/PciPlatform.h index 5b0add1ea7..c9491097e3 100644 --- a/MdePkg/Include/Protocol/PciPlatform.h +++ b/MdePkg/Include/Protocol/PciPlatform.h @@ -60,12 +60,12 @@ typedef enum { it needs to handle those errors on its own because there is no way to surface any
errors to the caller.
- @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
- @param HostBridge The handle of the host bridge controller.
- @param Phase The phase of the PCI bus enumeration.
- @param ChipsetPhase Defines the execution phase of the PCI chipset driver.
+ @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
+ @param HostBridge The handle of the host bridge controller.
+ @param Phase The phase of the PCI bus enumeration.
+ @param ChipsetPhase Defines the execution phase of the PCI chipset driver.
- @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_SUCCESS The function completed successfully.
**/
typedef
@@ -92,14 +92,14 @@ EFI_STATUS needs to handle those errors on its own because there is no way to surface any errors to
the caller.
- @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
- @param HostBridge The associated PCI host bridge handle.
- @param RootBridge The associated PCI root bridge handle.
- @param PciAddress The address of the PCI device on the PCI bus.
- @param Phase The phase of the PCI controller enumeration.
- @param ChipsetPhase Defines the execution phase of the PCI chipset driver.
+ @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
+ @param HostBridge The associated PCI host bridge handle.
+ @param RootBridge The associated PCI root bridge handle.
+ @param PciAddress The address of the PCI device on the PCI bus.
+ @param Phase The phase of the PCI controller enumeration.
+ @param ChipsetPhase Defines the execution phase of the PCI chipset driver.
- @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_SUCCESS The function completed successfully.
**/
typedef
@@ -120,11 +120,11 @@ EFI_STATUS enumeration. The PCI bus driver and the PCI Host Bridge Resource Allocation Protocol
driver can call this member function to retrieve the policy.
- @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
- @param PciPolicy The platform policy with respect to VGA and ISA aliasing.
+ @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
+ @param PciPolicy The platform policy with respect to VGA and ISA aliasing.
- @retval EFI_SUCCESS The function completed successfully.
- @retval EFI_INVALID_PARAMETER PciPolicy is NULL.
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_INVALID_PARAMETER PciPolicy is NULL.
**/
typedef
@@ -147,20 +147,20 @@ EFI_STATUS scanning the ROM that is attached to any controller, which allows a platform to specify a ROM
image that is different from the ROM image on a PCI card.
- @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
- @param PciHandle The handle of the PCI device.
- @param RomImage If the call succeeds, the pointer to the pointer to the option ROM image.
- Otherwise, this field is undefined. The memory for RomImage is allocated
- by EFI_PCI_PLATFORM_PROTOCOL.GetPciRom() using the EFI Boot Service AllocatePool().
- It is the caller's responsibility to free the memory using the EFI Boot Service
- FreePool(), when the caller is done with the option ROM.
- @param RomSize If the call succeeds, a pointer to the size of the option ROM size. Otherwise,
- this field is undefined.
-
- @retval EFI_SUCCESS The option ROM was available for this device and loaded into memory.
- @retval EFI_NOT_FOUND No option ROM was available for this device.
- @retval EFI_OUT_OF_RESOURCES No memory was available to load the option ROM.
- @retval EFI_DEVICE_ERROR An error occurred in getting the option ROM.
+ @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
+ @param PciHandle The handle of the PCI device.
+ @param RomImage If the call succeeds, the pointer to the pointer to the option ROM image.
+ Otherwise, this field is undefined. The memory for RomImage is allocated
+ by EFI_PCI_PLATFORM_PROTOCOL.GetPciRom() using the EFI Boot Service AllocatePool().
+ It is the caller's responsibility to free the memory using the EFI Boot Service
+ FreePool(), when the caller is done with the option ROM.
+ @param RomSize If the call succeeds, a pointer to the size of the option ROM size. Otherwise,
+ this field is undefined.
+
+ @retval EFI_SUCCESS The option ROM was available for this device and loaded into memory.
+ @retval EFI_NOT_FOUND No option ROM was available for this device.
+ @retval EFI_OUT_OF_RESOURCES No memory was available to load the option ROM.
+ @retval EFI_DEVICE_ERROR An error occurred in getting the option ROM.
**/
typedef
diff --git a/MdePkg/Include/Protocol/ScsiPassThruExt.h b/MdePkg/Include/Protocol/ScsiPassThruExt.h index b522792848..a59b61ec17 100644 --- a/MdePkg/Include/Protocol/ScsiPassThruExt.h +++ b/MdePkg/Include/Protocol/ScsiPassThruExt.h @@ -185,7 +185,6 @@ EFI_STATUS FC target.
@param Lun The LUN of the SCSI device for which a device path node is to be
allocated and built.
-
@param DevicePath A pointer to a single device path node that describes the SCSI device
specified by Target and Lun. This function is responsible for
allocating the buffer DevicePath with the boot service
diff --git a/MdePkg/Include/Protocol/SectionExtraction.h b/MdePkg/Include/Protocol/SectionExtraction.h index 9200f8a444..adc03f5985 100644 --- a/MdePkg/Include/Protocol/SectionExtraction.h +++ b/MdePkg/Include/Protocol/SectionExtraction.h @@ -41,17 +41,17 @@ typedef struct _EFI_SECTION_EXTRACTION_PROTOCOL EFI_SECTION_EXTRACTION_PROTOCOL; /**
Creates and returns a new section stream handle to represent the new section stream.
- @param This Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.
- @param SectionStreamLength Size in bytes of the section stream.
- @param SectionStream Buffer containing the new section stream.
- @param SectionStreamHandle A pointer to a caller-allocated UINTN that,
+ @param This Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.
+ @param SectionStreamLength Size in bytes of the section stream.
+ @param SectionStream Buffer containing the new section stream.
+ @param SectionStreamHandle A pointer to a caller-allocated UINTN that,
on output, contains the new section stream handle.
- @retval EFI_SUCCESS The SectionStream was successfully processed and
- the section stream handle was returned.
- @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to
- process the request.
- @retval EFI_INVALID_PARAMETER The section stream may be corrupt or the value
+ @retval EFI_SUCCESS The SectionStream was successfully processed and
+ the section stream handle was returned.
+ @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to
+ process the request.
+ @retval EFI_INVALID_PARAMETER The section stream may be corrupt or the value
of SectionStreamLength may be incorrect.
**/
@@ -67,36 +67,36 @@ EFI_STATUS /**
Reads and returns a single section from a section stream.
- @param This Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.
- @param SectionStreamHandle Indicates from which section stream to read.
- @param SectionType Pointer to an EFI_SECTION_TYPE.
- @param SectionDefinitionGuid Pointer to an EFI_GUID.If SectionType ==
- EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid indicates what section GUID
- to search for.If SectionType !=EFI_SECTION_GUID_DEFINED, then
- SectionDefinitionGuid is unused and is ignored.
- @param SectionInstance Indicates which instance of the requested section
- type to return when SectionType is not NULL.
+ @param This Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.
+ @param SectionStreamHandle Indicates from which section stream to read.
+ @param SectionType Pointer to an EFI_SECTION_TYPE.
+ @param SectionDefinitionGuid Pointer to an EFI_GUID.If SectionType ==
+ EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid indicates what section GUID
+ to search for.If SectionType !=EFI_SECTION_GUID_DEFINED, then
+ SectionDefinitionGuid is unused and is ignored.
+ @param SectionInstance Indicates which instance of the requested section
+ type to return when SectionType is not NULL.
@param SectionStreamHandle A pointer to a caller-allocated UINTN that, on output,
- contains the new section stream handle.
- @param Buffer Pointer to a pointer to a buffer in which the section
- contents are returned.
- @param BufferSize Pointer to a caller-allocated UINTN.
- @param AuthenticationStatus Pointer to a caller-allocated UINT32 in
+ contains the new section stream handle.
+ @param Buffer Pointer to a pointer to a buffer in which the section
+ contents are returned.
+ @param BufferSize Pointer to a caller-allocated UINTN.
+ @param AuthenticationStatus Pointer to a caller-allocated UINT32 in
which any meta-data from encapsulation GUID-defined sections is returned.
- @retval EFI_SUCCESS The SectionStream was successfully processed and
- the section contents were returned in Buffer.
- @retval EFI_PROTOCOL_ERROR A GUID-defined section was encountered in
- the section stream with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set,
- but there was no corresponding GUIDed Section Extraction Protocol in
- the handle database.
- @retval EFI_NOT_FOUND An error was encountered when parsing the SectionStream,
+ @retval EFI_SUCCESS The SectionStream was successfully processed and
+ the section contents were returned in Buffer.
+ @retval EFI_PROTOCOL_ERROR A GUID-defined section was encountered in
+ the section stream with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set,
+ but there was no corresponding GUIDed Section Extraction Protocol in
+ the handle database.
+ @retval EFI_NOT_FOUND An error was encountered when parsing the SectionStream,
which indicates that the SectionStream is not correctly formatted.
- Or The requested section does not exist.
- @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process
- the request.
- @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.
- @retval EFI_BUFFER_TOO_SMALL The size of the input buffer is insufficient to
+ Or The requested section does not exist.
+ @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process
+ the request.
+ @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.
+ @retval EFI_BUFFER_TOO_SMALL The size of the input buffer is insufficient to
contain the requested section.
**/
@@ -116,12 +116,10 @@ EFI_STATUS /**
Deletes a section stream handle and returns all associated resources to the system.
- @param This Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.
+ @param This Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.
@param SectionStreamHandle Indicates the section stream to close.
-
- @retval EFI_SUCCESS The SectionStream was successfully processed and
+ @retval EFI_SUCCESS The SectionStream was successfully processed and
the section stream handle was returned.
-
@retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.
**/
diff --git a/MdePkg/Include/Protocol/Smbus.h b/MdePkg/Include/Protocol/Smbus.h index 8fe37b17d3..1150933541 100644 --- a/MdePkg/Include/Protocol/Smbus.h +++ b/MdePkg/Include/Protocol/Smbus.h @@ -31,45 +31,32 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL; /**
Executes an SMBus operation to an SMBus controller.
- @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
-
- @param SlaveAddress The SMBus slave address of the device with which to communicate.
-
- @param Command This command is transmitted by the SMBus host
- controller to the SMBus slave device and the interpretation is
- SMBus slave device specific.
-
- @param Operation Signifies which particular SMBus hardware protocol
- instance that it will use to execute the SMBus transactions.
-
- @param PecCheck Defines if Packet Error Code (PEC) checking is required
- for this operation.
-
- @param Length Signifies the number of bytes that this operation will do.
-
- @param Buffer Contains the value of data to execute to the SMBus slave device.
-
- @retval EFI_SUCCESS The last data that was returned from the access
- matched the poll exit criteria.
-
- @retval EFI_CRC_ERROR The checksum is not correct (PEC is incorrect)
-
- @retval EFI_TIMEOUT Timeout expired before the operation was completed.
- Timeout is determined by the SMBus host controller device.
-
- @retval EFI_OUT_OF_RESOURCES The request could not be completed
- due to a lack of resources.
-
- @retval EFI_DEVICE_ERROR The request was not completed because
- a failure reflected in the Host Status Register bit.
-
+ @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
+ @param SlaveAddress The SMBus slave address of the device with which to communicate.
+ @param Command This command is transmitted by the SMBus host
+ controller to the SMBus slave device and the interpretation is
+ SMBus slave device specific.
+ @param Operation Signifies which particular SMBus hardware protocol
+ instance that it will use to execute the SMBus transactions.
+ @param PecCheck Defines if Packet Error Code (PEC) checking is required
+ for this operation.
+ @param Length Signifies the number of bytes that this operation will do.
+ @param Buffer Contains the value of data to execute to the SMBus slave device.
+
+ @retval EFI_SUCCESS The last data that was returned from the access
+ matched the poll exit criteria.
+ @retval EFI_CRC_ERROR The checksum is not correct (PEC is incorrect)
+ @retval EFI_TIMEOUT Timeout expired before the operation was completed.
+ Timeout is determined by the SMBus host controller device.
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed
+ due to a lack of resources.
+ @retval EFI_DEVICE_ERROR The request was not completed because
+ a failure reflected in the Host Status Register bit.
@retval EFI_INVALID_PARAMETER Operation is not defined in EFI_SMBUS_OPERATION.
- Or Length/Buffer is NULL for operations except for EfiSmbusQuickRead and
- EfiSmbusQuickWrite. Length is outside the range of valid values.
-
- @retval EFI_UNSUPPORTED The SMBus operation or PEC is not supported.
-
- @retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation.
+ Or Length/Buffer is NULL for operations except for EfiSmbusQuickRead and
+ EfiSmbusQuickWrite. Length is outside the range of valid values.
+ @retval EFI_UNSUPPORTED The SMBus operation or PEC is not supported.
+ @retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation.
**/
typedef
@@ -98,11 +85,10 @@ typedef struct { /**
CallBack function can be registered in EFI_SMBUS_HC_PROTOCOL_NOTIFY.
- @param SlaveAddress The SMBUS hardware address to which the SMBUS
- device is preassigned or allocated.
-
- @param Data Data of the SMBus host notify command that
- the caller wants to be called.
+ @param SlaveAddress The SMBUS hardware address to which the SMBUS
+ device is preassigned or allocated.
+ @param Data Data of the SMBus host notify command that
+ the caller wants to be called.
@return Status Code
@@ -118,29 +104,22 @@ EFI_STATUS Sets the SMBus slave device addresses for the device with a given unique ID
or enumerates the entire bus.
- @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
-
- @param ArpAll A Boolean expression that indicates if the host drivers need
- to enumerate all the devices or enumerate only the device that is identified
- by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional.
- If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address
- will be at SlaveAddress.
-
- @param SmbusUdid The Unique Device Identifier (UDID) that is associated
- with this device.
-
- @param SlaveAddress The SMBus slave address that is associated with an SMBus UDID.
-
- @retval EFI_SUCCESS The SMBus slave device address was set.
-
+ @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
+ @param ArpAll A Boolean expression that indicates if the host drivers need
+ to enumerate all the devices or enumerate only the device that is identified
+ by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional.
+ If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address
+ will be at SlaveAddress.
+ @param SmbusUdid The Unique Device Identifier (UDID) that is associated
+ with this device.
+ @param SlaveAddress The SMBus slave address that is associated with an SMBus UDID.
+
+ @retval EFI_SUCCESS The SMBus slave device address was set.
@retval EFI_INVALID_PARAMETER SlaveAddress is NULL.
-
- @retval EFI_OUT_OF_RESOURCES The request could not be completed
- due to a lack of resources.
-
- @retval EFI_TIMEOUT The SMBus slave device did not respond.
-
- @retval EFI_DEVICE_ERROR The request was not completed because the transaction failed.
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed
+ due to a lack of resources.
+ @retval EFI_TIMEOUT The SMBus slave device did not respond.
+ @retval EFI_DEVICE_ERROR The request was not completed because the transaction failed.
**/
typedef
@@ -161,14 +140,12 @@ typedef struct { The GetArpMap() function returns the mapping of all the SMBus devices
that are enumerated by the SMBus host driver.
- @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
-
- @param Length Size of the buffer that contains the SMBus device map.
-
- @param SmbusDeviceMap The pointer to the device map as enumerated
- by the SMBus controller driver.
+ @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
+ @param Length Size of the buffer that contains the SMBus device map.
+ @param SmbusDeviceMap The pointer to the device map as enumerated
+ by the SMBus controller driver.
- @retval EFI_SUCCESS The device map was returned correctly in the buffer.
+ @retval EFI_SUCCESS The device map was returned correctly in the buffer.
**/
typedef
@@ -183,18 +160,15 @@ EFI_STATUS The Notify() function registers all the callback functions to allow the
bus driver to call these functions when the SlaveAddress/Data pair happens.
- @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
-
- @param SlaveAddress Address that the host controller detects as
- sending a message and calls all the registered functions.
-
- @param Data Data that the host controller detects as sending a message
- and calls all the registered functions.
-
- @param NotifyFunction The function to call when the bus driver
- detects the SlaveAddress and Data pair.
-
- @retval EFI_SUCCESS NotifyFunction was registered.
+ @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
+ @param SlaveAddress Address that the host controller detects as
+ sending a message and calls all the registered functions.
+ @param Data Data that the host controller detects as sending a message
+ and calls all the registered functions.
+ @param NotifyFunction The function to call when the bus driver
+ detects the SlaveAddress and Data pair.
+
+ @retval EFI_SUCCESS NotifyFunction was registered.
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmAccess.h b/MdePkg/Include/Protocol/SmmAccess.h index f405c8f13f..3f17787539 100644 --- a/MdePkg/Include/Protocol/SmmAccess.h +++ b/MdePkg/Include/Protocol/SmmAccess.h @@ -46,16 +46,13 @@ typedef struct _EFI_SMM_ACCESS_PROTOCOL EFI_SMM_ACCESS_PROTOCOL; /**
Opens the SMRAM area to be accessible by a boot-service driver.
- @param This The EFI_SMM_ACCESS_PROTOCOL instance.
-
- @param DescriptorIndex Indicates that the driver wishes to open
- the memory tagged by this index.
+ @param This The EFI_SMM_ACCESS_PROTOCOL instance.
+ @param DescriptorIndex Indicates that the driver wishes to open
+ the memory tagged by this index.
- @retval EFI_SUCCESS The operation was successful.
-
+ @retval EFI_SUCCESS The operation was successful.
@retval EFI_INVALID_PARAMETER The given DescriptorIndex is not supported.
-
- @retval EFI_NOT_STARTED The SMM base service has not been initialized.
+ @retval EFI_NOT_STARTED The SMM base service has not been initialized.
**/
typedef
@@ -68,18 +65,14 @@ EFI_STATUS /**
Inhibits access to the SMRAM.
- @param This The EFI_SMM_ACCESS_PROTOCOL instance.
-
- @param DescriptorIndex Indicates that the driver wishes to open
- the memory tagged by this index.
+ @param This The EFI_SMM_ACCESS_PROTOCOL instance.
+ @param DescriptorIndex Indicates that the driver wishes to open
+ the memory tagged by this index.
- @retval EFI_SUCCESS The operation was successful.
-
- @retval EFI_DEVICE_ERROR The given DescriptorIndex is not open.
-
+ @retval EFI_SUCCESS The operation was successful.
+ @retval EFI_DEVICE_ERROR The given DescriptorIndex is not open.
@retval EFI_INVALID_PARAMETER The given DescriptorIndex is not supported.
-
- @retval EFI_NOT_STARTED The SMM base service has not been initialized.
+ @retval EFI_NOT_STARTED The SMM base service has not been initialized.
**/
typedef
@@ -91,19 +84,14 @@ EFI_STATUS /**
Inhibits access to the SMRAM.
-
- @param This The EFI_SMM_ACCESS_PROTOCOL instance.
-
- @param DescriptorIndex Indicates that the driver wishes to open
- the memory tagged by this index.
-
- @retval EFI_SUCCESS The operation was successful.
-
- @retval EFI_DEVICE_ERROR The given DescriptorIndex is not open.
-
+ @param This The EFI_SMM_ACCESS_PROTOCOL instance.
+ @param DescriptorIndex Indicates that the driver wishes to open
+ the memory tagged by this index.
+
+ @retval EFI_SUCCESS The operation was successful.
+ @retval EFI_DEVICE_ERROR The given DescriptorIndex is not open.
@retval EFI_INVALID_PARAMETER The given DescriptorIndex is not supported.
-
- @retval EFI_NOT_STARTED The SMM base service has not been initialized.
+ @retval EFI_NOT_STARTED The SMM base service has not been initialized.
**/
typedef
@@ -116,15 +104,12 @@ EFI_STATUS /**
Queries the memory controller for the possible regions that will support SMRAM.
- @param This The EFI_SMM_ACCESS_PROTOCOL instance.
-
- @param SmramMapSize A pointer to the size, in bytes, of the SmramMemoryMap buffer.
-
- @param SmramMap A pointer to the buffer in which firmware places the current memory map.
+ @param This The EFI_SMM_ACCESS_PROTOCOL instance.
+ @param SmramMapSize A pointer to the size, in bytes, of the SmramMemoryMap buffer.
+ @param SmramMap A pointer to the buffer in which firmware places the current memory map.
- @retval EFI_SUCCESS The chipset supported the given resource.
-
- @retval EFI_BUFFER_TOO_SMALL The SmramMap parameter was too small.
+ @retval EFI_SUCCESS The chipset supported the given resource.
+ @retval EFI_BUFFER_TOO_SMALL The SmramMap parameter was too small.
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmBase.h b/MdePkg/Include/Protocol/SmmBase.h index 6dd3a5dd57..664e34c9e6 100644 --- a/MdePkg/Include/Protocol/SmmBase.h +++ b/MdePkg/Include/Protocol/SmmBase.h @@ -40,14 +40,12 @@ typedef struct _EFI_SMM_BASE_PROTOCOL EFI_SMM_BASE_PROTOCOL; /**
Entry Point to Callback service
- @param SmmImageHandle A handle allocated by the SMM infrastructure code
- to uniquely designate a specific DXE SMM driver.
-
- @param CommunicationBuffer A pointer to a collection of data in memory
- that will be conveyed from a non-SMM environment into an SMM environment.
- The buffer must be contiguous, physically mapped, and be a physical address.
-
- @param SourceSize The size of the CommunicationBuffer.
+ @param SmmImageHandle A handle allocated by the SMM infrastructure code
+ to uniquely designate a specific DXE SMM driver.
+ @param CommunicationBuffer A pointer to a collection of data in memory
+ that will be conveyed from a non-SMM environment into an SMM environment.
+ The buffer must be contiguous, physically mapped, and be a physical address.
+ @param SourceSize The size of the CommunicationBuffer.
@return Status code
@@ -67,20 +65,20 @@ EFI_STATUS Register a given driver into SMRAM.This is the equivalent of performing
the LoadImage/StartImage into System Management Mode.
- @param This Protocol instance pointer.
- @param FilePath Location of the image to be installed as the handler.
- @param SourceBuffer Optional source buffer in case of the image file
- being in memory.
- @param SourceSize Size of the source image file, if in memory.
- @param ImageHandle Pointer to the handle that reflects the driver
- loaded into SMM.
- @param LegacyIA32Binary The binary image to load is legacy 16 bit code.
-
- @retval EFI_SUCCESS The operation was successful.
- @retval EFI_OUT_OF_RESOURCES There were no additional SMRAM resources to load the handler
- @retval EFI_UNSUPPORTED This platform does not support 16-bit handlers.
- @retval EFI_UNSUPPORTED In runtime.
- @retval EFI_INVALID_PARAMETER The handlers was not the correct image type
+ @param This Protocol instance pointer.
+ @param FilePath Location of the image to be installed as the handler.
+ @param SourceBuffer Optional source buffer in case of the image file
+ being in memory.
+ @param SourceSize Size of the source image file, if in memory.
+ @param ImageHandle Pointer to the handle that reflects the driver
+ loaded into SMM.
+ @param LegacyIA32Binary The binary image to load is legacy 16 bit code.
+
+ @retval EFI_SUCCESS The operation was successful.
+ @retval EFI_OUT_OF_RESOURCES There were no additional SMRAM resources to load the handler
+ @retval EFI_UNSUPPORTED This platform does not support 16-bit handlers.
+ @retval EFI_UNSUPPORTED In runtime.
+ @retval EFI_INVALID_PARAMETER The handlers was not the correct image type
**/
typedef
@@ -99,13 +97,13 @@ EFI_STATUS Remove a given driver SMRAM. This is the equivalent of performing
the UnloadImage System Management Mode.
- @param This Protocol instance pointer.
- @param ImageHandle Pointer to the handle that reflects the driver
- loaded into SMM.
+ @param This Protocol instance pointer.
+ @param ImageHandle Pointer to the handle that reflects the driver
+ loaded into SMM.
- @retval EFI_SUCCESS The operation was successful
- @retval EFI_INVALID_PARAMETER The handler did not exist
- @retval EFI_UNSUPPORTED In runtime.
+ @retval EFI_SUCCESS The operation was successful
+ @retval EFI_INVALID_PARAMETER The handler did not exist
+ @retval EFI_UNSUPPORTED In runtime.
**/
typedef
@@ -122,14 +120,14 @@ EFI_STATUS EFI service. The BASE protocol driver is responsible for doing
any of the copies such that the data lives in boot-service accessible RAM.
- @param This Protocol instance pointer.
- @param ImageHandle Pointer to the handle that reflects the driver
- loaded into SMM.
- @param CommunicationBuffer Pointer to the buffer to convey into SMRAM.
- @param SourceSize Size of the contents of buffer..
+ @param This Protocol instance pointer.
+ @param ImageHandle Pointer to the handle that reflects the driver
+ loaded into SMM.
+ @param CommunicationBuffer Pointer to the buffer to convey into SMRAM.
+ @param SourceSize Size of the contents of buffer..
- @retval EFI_SUCCESS The message was successfully posted
- @retval EFI_INVALID_PARAMETER The buffer was NULL
+ @retval EFI_SUCCESS The message was successfully posted
+ @retval EFI_INVALID_PARAMETER The buffer was NULL
**/
typedef
@@ -146,21 +144,21 @@ EFI_STATUS Register a callback to execute within SMM.
This allows receipt of messages created with the Boot Service COMMUNICATE.
- @param This Protocol instance pointer.
- @param CallbackAddress Address of the callback service
- @param MakeFirst If present, will stipulate that the handler is posted
- to be the first module executed in the dispatch table.
- @param MakeLast If present, will stipulate that the handler is posted
- to be last executed in the dispatch table.
- @param FloatingPointSave This is an optional parameter which informs the
- EFI_SMM_ACCESS_PROTOCOL Driver core if it needs to save
- the floating point register state. If any of the handlers
- require this, then the state will be saved for all of the handlers.
-
- @retval EFI_SUCCESS The operation was successful
- @retval EFI_OUT_OF_RESOURCES Not enough space in the dispatch queue
- @retval EFI_UNSUPPORTED In runtime.
- @retval EFI_UNSUPPORTED Not in SMM.
+ @param This Protocol instance pointer.
+ @param CallbackAddress Address of the callback service
+ @param MakeFirst If present, will stipulate that the handler is posted
+ to be the first module executed in the dispatch table.
+ @param MakeLast If present, will stipulate that the handler is posted
+ to be last executed in the dispatch table.
+ @param FloatingPointSave This is an optional parameter which informs the
+ EFI_SMM_ACCESS_PROTOCOL Driver core if it needs to save
+ the floating point register state. If any of the handlers
+ require this, then the state will be saved for all of the handlers.
+
+ @retval EFI_SUCCESS The operation was successful
+ @retval EFI_OUT_OF_RESOURCES Not enough space in the dispatch queue
+ @retval EFI_UNSUPPORTED In runtime.
+ @retval EFI_UNSUPPORTED Not in SMM.
**/
typedef
@@ -180,18 +178,18 @@ EFI_STATUS by Buffer. This function allocates pages from EFI SMRAM Memory as needed to grow the
requested pool type. All allocations are eight-byte aligned.
- @param This Protocol instance pointer.
- @param PoolType The type of pool to allocate.
- The only supported type is EfiRuntimeServicesData;
- the interface will internally map this runtime request to SMRAM.
- @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 This Protocol instance pointer.
+ @param PoolType The type of pool to allocate.
+ The only supported type is EfiRuntimeServicesData;
+ the interface will internally map this runtime request to SMRAM.
+ @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_OUT_OF_RESOURCES The pool requested could not be allocated.
- @retval EFI_INVALID_PARAMETER PoolType was invalid.
- @retval EFI_UNSUPPORTED In runtime.
+ @retval EFI_SUCCESS The requested number of bytes was allocated.
+ @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
+ @retval EFI_INVALID_PARAMETER PoolType was invalid.
+ @retval EFI_UNSUPPORTED In runtime.
**/
typedef
@@ -209,12 +207,12 @@ EFI_STATUS On return, the memory's type is EFI SMRAM Memory. The Buffer that is freed must
have been allocated by SmmAllocatePool().
- @param This Protocol instance pointer.
- @param Buffer Pointer to the buffer allocation.
+ @param This Protocol instance pointer.
+ @param Buffer Pointer to the buffer allocation.
- @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
@@ -228,10 +226,10 @@ EFI_STATUS /**
This routine tells caller if execution context is SMM or not.
- @param This Protocol instance pointer.
- @param InSmm Whether the caller is inside SMM for IA-32 or servicing a PMI for the Itanium processor family.
+ @param This Protocol instance pointer.
+ @param InSmm Whether the caller is inside SMM for IA-32 or servicing a PMI for the Itanium processor family.
- @retval EFI_SUCCESS The operation was successful
+ @retval EFI_SUCCESS The operation was successful
**/
typedef
@@ -248,12 +246,12 @@ EFI_STATUS location of the SMST in its entry point and then cache it in some driver
global variable so that the SMST can be invoked in subsequent callbacks.
- @param This Protocol instance pointer.
- @param Smst Pointer to the SMST.
+ @param This Protocol instance pointer.
+ @param Smst Pointer to the SMST.
- @retval EFI_SUCCESS The operation was successful
- @retval EFI_INVALID_PARAMETER Smst was invalid.
- @retval EFI_UNSUPPORTED Not in SMM.
+ @retval EFI_SUCCESS The operation was successful
+ @retval EFI_INVALID_PARAMETER Smst was invalid.
+ @retval EFI_UNSUPPORTED Not in SMM.
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmControl.h b/MdePkg/Include/Protocol/SmmControl.h index 3bcd0f772e..a83d25bf85 100644 --- a/MdePkg/Include/Protocol/SmmControl.h +++ b/MdePkg/Include/Protocol/SmmControl.h @@ -41,24 +41,17 @@ typedef struct { /**
Invokes SMI activation from either the preboot or runtime environment.
- @param This The EFI_SMM_CONTROL_PROTOCOL instance.
-
- @param ArgumentBuffer Optional sized data to pass into the protocol activation.
-
- @param ArgumentBufferSize Optional size of the data.
-
- @param Periodic Optional mechanism to engender a periodic stream.
-
- @param ActivationInterval Optional parameter to repeat at this period one
- time or, if the Periodic Boolean is set, periodically.
-
- @retval EFI_SUCCESS The SMI/PMI has been engendered.
-
- @retval EFI_DEVICE_ERROR The timing is unsupported.
-
- @retval EFI_INVALID_PARAMETER The activation period is unsupported.
-
- @retval EFI_NOT_STARTED The SMM base service has not been initialized.
+ @param This The EFI_SMM_CONTROL_PROTOCOL instance.
+ @param ArgumentBuffer Optional sized data to pass into the protocol activation.
+ @param ArgumentBufferSize Optional size of the data.
+ @param Periodic Optional mechanism to engender a periodic stream.
+ @param ActivationInterval Optional parameter to repeat at this period one
+ time or, if the Periodic Boolean is set, periodically.
+
+ @retval EFI_SUCCESS The SMI/PMI has been engendered.
+ @retval EFI_DEVICE_ERROR The timing is unsupported.
+ @retval EFI_INVALID_PARAMETER The activation period is unsupported.
+ @retval EFI_NOT_STARTED The SMM base service has not been initialized.
**/
typedef
@@ -74,15 +67,12 @@ EFI_STATUS /**
Clears any system state that was created in response to the Active call.
- @param This The EFI_SMM_CONTROL_PROTOCOL instance.
-
- @param Periodic Optional parameter to repeat at this period one time
+ @param This The EFI_SMM_CONTROL_PROTOCOL instance.
+ @param Periodic Optional parameter to repeat at this period one time
- @retval EFI_SUCCESS The SMI/PMI has been engendered.
-
- @retval EFI_DEVICE_ERROR The source could not be cleared.
-
- @retval EFI_INVALID_PARAMETER The service did not support the Periodic input argument.
+ @retval EFI_SUCCESS The SMI/PMI has been engendered.
+ @retval EFI_DEVICE_ERROR The source could not be cleared.
+ @retval EFI_INVALID_PARAMETER The service did not support the Periodic input argument.
**/
typedef
@@ -95,11 +85,10 @@ EFI_STATUS /**
Provides information on the source register used to generate the SMI.
- @param This The EFI_SMM_CONTROL_PROTOCOL instance.
-
- @param SmiRegister Pointer to the SMI register description structure
+ @param This The EFI_SMM_CONTROL_PROTOCOL instance.
+ @param SmiRegister Pointer to the SMI register description structure
- @retval EFI_SUCCESS The register structure has been returned.
+ @retval EFI_SUCCESS The register structure has been returned.
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmGpiDispatch.h b/MdePkg/Include/Protocol/SmmGpiDispatch.h index b472e92c5a..8173fe540f 100644 --- a/MdePkg/Include/Protocol/SmmGpiDispatch.h +++ b/MdePkg/Include/Protocol/SmmGpiDispatch.h @@ -52,10 +52,10 @@ typedef struct { /**
Dispatch function for a GPI SMI handler.
- @param DispatchHandle Handle of this dispatch function.
- @param DispatchContext Pointer to the dispatch function's context.
- The DispatchContext fields are filled in by the dispatching driver prior to
- invoking this dispatch function.
+ @param DispatchHandle Handle of this dispatch function.
+ @param DispatchContext Pointer to the dispatch function's context.
+ The DispatchContext fields are filled in by the dispatching driver prior to
+ invoking this dispatch function.
@return None
@@ -70,24 +70,24 @@ VOID /**
Register a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchFunction Pointer to dispatch function to be invoked for
- this SMI source
- @param DispatchContext Pointer to the dispatch function's context.
- The caller fills this context in before calling
- the register function to indicate to the register
- function the GPI(s) for which the dispatch function
- should be invoked.
- @param DispatchHandle Handle of dispatch function, for when interfacing
- with the parent Sx state SMM driver.
-
- @retval EFI_SUCCESS The dispatch function has been successfully
- registered and the SMI source has been enabled.
- @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
- @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
- child.
- @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The GPI input value
- is not within valid range.
+ @param This Protocol instance pointer.
+ @param DispatchFunction Pointer to dispatch function to be invoked for
+ this SMI source
+ @param DispatchContext Pointer to the dispatch function's context.
+ The caller fills this context in before calling
+ the register function to indicate to the register
+ function the GPI(s) for which the dispatch function
+ should be invoked.
+ @param DispatchHandle Handle of dispatch function, for when interfacing
+ with the parent Sx state SMM driver.
+
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ registered and the SMI source has been enabled.
+ @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
+ @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
+ child.
+ @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The GPI input value
+ is not within valid range.
**/
typedef
@@ -102,15 +102,15 @@ EFI_STATUS /**
Unregister a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Protocol instance pointer.
+ @param DispatchHandle Handle of dispatch function to deregister.
- @retval EFI_SUCCESS The dispatch function has been successfully
- unregistered and the SMI source has been disabled
- if there are no other registered child dispatch
- functions for this SMI source.
- @retval EFI_INVALID_PARAMETER Handle is invalid.
- @retval other TBD
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ unregistered and the SMI source has been disabled
+ if there are no other registered child dispatch
+ functions for this SMI source.
+ @retval EFI_INVALID_PARAMETER Handle is invalid.
+ @retval other TBD
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmIchnDispatch.h b/MdePkg/Include/Protocol/SmmIchnDispatch.h index 8829f85489..a2bc84c341 100644 --- a/MdePkg/Include/Protocol/SmmIchnDispatch.h +++ b/MdePkg/Include/Protocol/SmmIchnDispatch.h @@ -100,11 +100,11 @@ typedef struct { /**
Dispatch function for a ICH n specific SMI handler.
- @param DispatchHandle Handle of this dispatch function.
- @param DispatchContext Pointer to the dispatch function's context.
- The DispatchContext fields are filled in
- by the dispatching driver prior to
- invoking this dispatch function.
+ @param DispatchHandle Handle of this dispatch function.
+ @param DispatchContext Pointer to the dispatch function's context.
+ The DispatchContext fields are filled in
+ by the dispatching driver prior to
+ invoking this dispatch function.
Nothing
@@ -119,24 +119,24 @@ VOID /**
Register a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchFunction Pointer to dispatch function to be invoked for
- this SMI source
- @param DispatchContext Pointer to the dispatch function's context.
- The caller fills this context in before calling
- the register function to indicate to the register
- function the ICHN SMI source for which the dispatch
- function should be invoked.
- @param DispatchHandle Handle of dispatch function, for when interfacing
- with the parent Sx state SMM driver.
-
- @retval EFI_SUCCESS The dispatch function has been successfully
- registered and the SMI source has been enabled.
- @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
- @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
- child.
- @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The ICHN input value
- is not within valid range.
+ @param This Protocol instance pointer.
+ @param DispatchFunction Pointer to dispatch function to be invoked for
+ this SMI source
+ @param DispatchContext Pointer to the dispatch function's context.
+ The caller fills this context in before calling
+ the register function to indicate to the register
+ function the ICHN SMI source for which the dispatch
+ function should be invoked.
+ @param DispatchHandle Handle of dispatch function, for when interfacing
+ with the parent Sx state SMM driver.
+
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ registered and the SMI source has been enabled.
+ @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
+ @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
+ child.
+ @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The ICHN input value
+ is not within valid range.
**/
typedef
@@ -151,15 +151,15 @@ EFI_STATUS /**
Unregister a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Protocol instance pointer.
+ @param DispatchHandle Handle of dispatch function to deregister.
- @retval EFI_SUCCESS The dispatch function has been successfully
- unregistered and the SMI source has been disabled
- if there are no other registered child dispatch
- functions for this SMI source.
- @retval EFI_INVALID_PARAMETER Handle is invalid.
- @retval other TBD
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ unregistered and the SMI source has been disabled
+ if there are no other registered child dispatch
+ functions for this SMI source.
+ @retval EFI_INVALID_PARAMETER Handle is invalid.
+ @retval other TBD
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch.h b/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch.h index c94843fcca..75f3e80b9c 100644 --- a/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch.h +++ b/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch.h @@ -76,11 +76,11 @@ typedef struct { /**
Dispatch function for a Periodic Timer SMI handler.
- @param DispatchHandle Handle of this dispatch function.
- @param DispatchContext Pointer to the dispatch function's context.
- The DispatchContext fields are filled in
- by the dispatching driver prior to
- invoking this dispatch function.
+ @param DispatchHandle Handle of this dispatch function.
+ @param DispatchContext Pointer to the dispatch function's context.
+ The DispatchContext fields are filled in
+ by the dispatching driver prior to
+ invoking this dispatch function.
Nothing
@@ -96,15 +96,15 @@ VOID Returns the next SMI tick period supported by the chipset. The order
returned is from longest to shortest interval period.
- @param This Protocol instance pointer.
- @param SmiTickInterval Pointer to pointer of next shorter SMI interval
- period supported by the child. This parameter works as a get-first,
- get-next field.The first time this function is called, *SmiTickInterval
- should be set to NULL to get the longest SMI interval.The returned
- *SmiTickInterval should be passed in on subsequent calls to get the
- next shorter interval period until *SmiTickInterval = NULL.
+ @param This Protocol instance pointer.
+ @param SmiTickInterval Pointer to pointer of next shorter SMI interval
+ period supported by the child. This parameter works as a get-first,
+ get-next field.The first time this function is called, *SmiTickInterval
+ should be set to NULL to get the longest SMI interval.The returned
+ *SmiTickInterval should be passed in on subsequent calls to get the
+ next shorter interval period until *SmiTickInterval = NULL.
- @retval EFI_SUCCESS The service returned successfully.
+ @retval EFI_SUCCESS The service returned successfully.
**/
typedef
@@ -117,24 +117,24 @@ EFI_STATUS /**
Register a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchFunction Pointer to dispatch function to be invoked for
- this SMI source
- @param DispatchContext Pointer to the dispatch function's context.
- The caller fills this context in before calling
- the register function to indicate to the register
- function the period at which the dispatch function
- should be invoked.
- @param DispatchHandle Handle of dispatch function, for when interfacing
- with the parent Sx state SMM driver.
-
- @retval EFI_SUCCESS The dispatch function has been successfully
- registered and the SMI source has been enabled.
- @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
- @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
- child.
- @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The period input value
- is not within valid range.
+ @param This Protocol instance pointer.
+ @param DispatchFunction Pointer to dispatch function to be invoked for
+ this SMI source
+ @param DispatchContext Pointer to the dispatch function's context.
+ The caller fills this context in before calling
+ the register function to indicate to the register
+ function the period at which the dispatch function
+ should be invoked.
+ @param DispatchHandle Handle of dispatch function, for when interfacing
+ with the parent Sx state SMM driver.
+
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ registered and the SMI source has been enabled.
+ @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
+ @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
+ child.
+ @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The period input value
+ is not within valid range.
**/
typedef
@@ -149,14 +149,14 @@ EFI_STATUS /**
Unregister a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Protocol instance pointer.
+ @param DispatchHandle Handle of dispatch function to deregister.
- @retval EFI_SUCCESS The dispatch function has been successfully
- unregistered and the SMI source has been disabled
- if there are no other registered child dispatch
- functions for this SMI source.
- @retval EFI_INVALID_PARAMETER Handle is invalid.
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ unregistered and the SMI source has been disabled
+ if there are no other registered child dispatch
+ functions for this SMI source.
+ @retval EFI_INVALID_PARAMETER Handle is invalid.
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmPowerButtonDispatch.h b/MdePkg/Include/Protocol/SmmPowerButtonDispatch.h index 065d85f09e..891a1fd2b3 100644 --- a/MdePkg/Include/Protocol/SmmPowerButtonDispatch.h +++ b/MdePkg/Include/Protocol/SmmPowerButtonDispatch.h @@ -54,11 +54,11 @@ typedef struct { /**
Dispatch function for a Power Button SMI handler.
- @param DispatchHandle Handle of this dispatch function.
- @param DispatchContext Pointer to the dispatch function's context.
- The DispatchContext fields are filled in
- by the dispatching driver prior to
- invoking this dispatch function.
+ @param DispatchHandle Handle of this dispatch function.
+ @param DispatchContext Pointer to the dispatch function's context.
+ The DispatchContext fields are filled in
+ by the dispatching driver prior to
+ invoking this dispatch function.
Nothing
@@ -73,24 +73,24 @@ VOID /**
Register a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchFunction Pointer to dispatch function to be invoked for
- this SMI source
- @param DispatchContext Pointer to the dispatch function's context.
- The caller fills this context in before calling
- the register function to indicate to the register
- function the Power Button SMI phase for which the dispatch
- function should be invoked.
- @param DispatchHandle Handle of dispatch function, for when interfacing
- with the parent Sx state SMM driver.
-
- @retval EFI_SUCCESS The dispatch function has been successfully
- registered and the SMI source has been enabled.
- @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
- @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
- child.
- @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The Power Button SMI
- phase is not within valid range.
+ @param This Protocol instance pointer.
+ @param DispatchFunction Pointer to dispatch function to be invoked for
+ this SMI source
+ @param DispatchContext Pointer to the dispatch function's context.
+ The caller fills this context in before calling
+ the register function to indicate to the register
+ function the Power Button SMI phase for which the dispatch
+ function should be invoked.
+ @param DispatchHandle Handle of dispatch function, for when interfacing
+ with the parent Sx state SMM driver.
+
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ registered and the SMI source has been enabled.
+ @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
+ @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
+ child.
+ @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The Power Button SMI
+ phase is not within valid range.
**/
typedef
@@ -105,15 +105,15 @@ EFI_STATUS /**
Unregister a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Protocol instance pointer.
+ @param DispatchHandle Handle of dispatch function to deregister.
- @retval EFI_SUCCESS The dispatch function has been successfully
- unregistered and the SMI source has been disabled
- if there are no other registered child dispatch
- functions for this SMI source.
- @retval EFI_INVALID_PARAMETER Handle is invalid.
- @retval other TBD
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ unregistered and the SMI source has been disabled
+ if there are no other registered child dispatch
+ functions for this SMI source.
+ @retval EFI_INVALID_PARAMETER Handle is invalid.
+ @retval other TBD
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmStandbyButtonDispatch.h b/MdePkg/Include/Protocol/SmmStandbyButtonDispatch.h index 7c52eb1808..79b0602a03 100644 --- a/MdePkg/Include/Protocol/SmmStandbyButtonDispatch.h +++ b/MdePkg/Include/Protocol/SmmStandbyButtonDispatch.h @@ -54,11 +54,11 @@ typedef struct { /**
Dispatch function for a Standby Button SMI handler.
- @param DispatchHandle Handle of this dispatch function.
- @param DispatchContext Pointer to the dispatch function's context.
- The DispatchContext fields are filled in
- by the dispatching driver prior to
- invoking this dispatch function.
+ @param DispatchHandle Handle of this dispatch function.
+ @param DispatchContext Pointer to the dispatch function's context.
+ The DispatchContext fields are filled in
+ by the dispatching driver prior to
+ invoking this dispatch function.
@return Nothing
@@ -73,24 +73,24 @@ VOID /**
Register a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchFunction Pointer to dispatch function to be invoked for
- this SMI source
- @param DispatchContext Pointer to the dispatch function's context.
- The caller fills this context in before calling
- the register function to indicate to the register
- function the Standby Button SMI phase for which the dispatch
- function should be invoked.
- @param DispatchHandle Handle of dispatch function, for when interfacing
- with the parent Sx state SMM driver.
-
- @retval EFI_SUCCESS The dispatch function has been successfully
- registered and the SMI source has been enabled.
- @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
- @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
- child.
- @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The Standby Button SMI
- phase is not within valid range.
+ @param This Protocol instance pointer.
+ @param DispatchFunction Pointer to dispatch function to be invoked for
+ this SMI source
+ @param DispatchContext Pointer to the dispatch function's context.
+ The caller fills this context in before calling
+ the register function to indicate to the register
+ function the Standby Button SMI phase for which the dispatch
+ function should be invoked.
+ @param DispatchHandle Handle of dispatch function, for when interfacing
+ with the parent Sx state SMM driver.
+
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ registered and the SMI source has been enabled.
+ @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
+ @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
+ child.
+ @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The Standby Button SMI
+ phase is not within valid range.
**/
typedef
@@ -105,15 +105,15 @@ EFI_STATUS /**
Unregister a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Protocol instance pointer.
+ @param DispatchHandle Handle of dispatch function to deregister.
- @retval EFI_SUCCESS The dispatch function has been successfully
- unregistered and the SMI source has been disabled
- if there are no other registered child dispatch
- functions for this SMI source.
- @retval EFI_INVALID_PARAMETER Handle is invalid.
- @retval other TBD
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ unregistered and the SMI source has been disabled
+ if there are no other registered child dispatch
+ functions for this SMI source.
+ @retval EFI_INVALID_PARAMETER Handle is invalid.
+ @retval other TBD
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmStatusCode.h b/MdePkg/Include/Protocol/SmmStatusCode.h index 660871548b..73f26d4c76 100644 --- a/MdePkg/Include/Protocol/SmmStatusCode.h +++ b/MdePkg/Include/Protocol/SmmStatusCode.h @@ -36,26 +36,20 @@ typedef struct _EFI_SMM_STATUS_CODE_PROTOCOL EFI_SMM_STATUS_CODE_PROTOCOL; /**
Service to emit the status code in SMM.
- @param This Pointer to EFI_SMM_STATUS_CODE_PROTOCOL instance.
-
- @param CodeType 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 This Pointer to EFI_SMM_STATUS_CODE_PROTOCOL instance.
+ @param CodeType 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
diff --git a/MdePkg/Include/Protocol/SmmSwDispatch.h b/MdePkg/Include/Protocol/SmmSwDispatch.h index bc456cb5f2..2f4fecffb0 100644 --- a/MdePkg/Include/Protocol/SmmSwDispatch.h +++ b/MdePkg/Include/Protocol/SmmSwDispatch.h @@ -49,13 +49,13 @@ typedef struct { /**
Dispatch function for a Software SMI handler.
- @param DispatchHandle Handle of this dispatch function.
- @param DispatchContext Pointer to the dispatch function's context.
- The SwSmiInputValue field is filled in
- by the software dispatch driver prior to
- invoking this dispatch function.
- The dispatch function will only be called
- for input values for which it is registered.
+ @param DispatchHandle Handle of this dispatch function.
+ @param DispatchContext Pointer to the dispatch function's context.
+ The SwSmiInputValue field is filled in
+ by the software dispatch driver prior to
+ invoking this dispatch function.
+ The dispatch function will only be called
+ for input values for which it is registered.
Nothing
@@ -70,24 +70,24 @@ VOID /**
Register a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchFunction Pointer to dispatch function to be invoked for
- this SMI source
- @param DispatchContext Pointer to the dispatch function's context.
- The caller fills this context in before calling
- the register function to indicate to the register
- function which Software SMI input value the
- dispatch function should be invoked for.
- @param DispatchHandle Handle of dispatch function, for when interfacing
- with the parent Sx state SMM driver.
-
- @retval EFI_SUCCESS The dispatch function has been successfully
- registered and the SMI source has been enabled.
- @retval EFI_DEVICE_ERROR The SW driver was unable to enable the SMI source.
- @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
- child.
- @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The SW SMI input value
- is not within valid range.
+ @param This Protocol instance pointer.
+ @param DispatchFunction Pointer to dispatch function to be invoked for
+ this SMI source
+ @param DispatchContext Pointer to the dispatch function's context.
+ The caller fills this context in before calling
+ the register function to indicate to the register
+ function which Software SMI input value the
+ dispatch function should be invoked for.
+ @param DispatchHandle Handle of dispatch function, for when interfacing
+ with the parent Sx state SMM driver.
+
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ registered and the SMI source has been enabled.
+ @retval EFI_DEVICE_ERROR The SW driver was unable to enable the SMI source.
+ @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
+ child.
+ @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The SW SMI input value
+ is not within valid range.
**/
typedef
@@ -102,15 +102,15 @@ EFI_STATUS /**
Unregister a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Protocol instance pointer.
+ @param DispatchHandle Handle of dispatch function to deregister.
- @retval EFI_SUCCESS The dispatch function has been successfully
- unregistered and the SMI source has been disabled
- if there are no other registered child dispatch
- functions for this SMI source.
- @retval EFI_INVALID_PARAMETER Handle is invalid.
- @retval other TBD
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ unregistered and the SMI source has been disabled
+ if there are no other registered child dispatch
+ functions for this SMI source.
+ @retval EFI_INVALID_PARAMETER Handle is invalid.
+ @retval other TBD
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmSxDispatch.h b/MdePkg/Include/Protocol/SmmSxDispatch.h index dcbc6a9b98..4d6811f3fc 100644 --- a/MdePkg/Include/Protocol/SmmSxDispatch.h +++ b/MdePkg/Include/Protocol/SmmSxDispatch.h @@ -60,13 +60,13 @@ typedef struct { /**
Dispatch function for a Sx state SMI handler.
- @param DispatchHandle Handle of this dispatch function.
- @param DispatchContext Pointer to the dispatch function¡¯s context.
- The Type and Phase fields are filled in by the Sx dispatch driver
- prior to invoking this dispatch function. For this interface,
- the Sx driver will call the dispatch function for all Sx type
- and phases, so the Sx state handler(s) must check the Type and
- Phase field of EFI_SMM_SX_DISPATCH_CONTEXT and act accordingly.
+ @param DispatchHandle Handle of this dispatch function.
+ @param DispatchContext Pointer to the dispatch function¡¯s context.
+ The Type and Phase fields are filled in by the Sx dispatch driver
+ prior to invoking this dispatch function. For this interface,
+ the Sx driver will call the dispatch function for all Sx type
+ and phases, so the Sx state handler(s) must check the Type and
+ Phase field of EFI_SMM_SX_DISPATCH_CONTEXT and act accordingly.
Nothing
@@ -81,30 +81,30 @@ VOID /**
Register a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchFunction Pointer to dispatch function to be invoked for
- this SMI source
- @param DispatchContext Pointer to the dispatch function's context.
- The caller fills this context in before calling
- the register function to indicate to the register
- function which Sx state type and phase the caller
- wishes to be called back on. For this intertace,
- the Sx driver will call the registered handlers for
- all Sx type and phases, so the Sx state handler(s)
- must check the Type and Phase field of the Dispatch
- context and act accordingly.
- @param DispatchHandle Handle of dispatch function, for when interfacing
- with the parent Sx state SMM driver.
-
- @retval EFI_SUCCESS The dispatch function has been successfully
- registered and the SMI source has been enabled.
- @retval EFI_UNSUPPORTED The Sx driver or hardware does not support that
- Sx Type/Phase.
- @retval EFI_DEVICE_ERROR The Sx driver was unable to enable the SMI source.
- @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
- child.
- @retval EFI_INVALID_PARAMETER DispatchContext is invalid. Type & Phase are not
- within valid range.
+ @param This Protocol instance pointer.
+ @param DispatchFunction Pointer to dispatch function to be invoked for
+ this SMI source
+ @param DispatchContext Pointer to the dispatch function's context.
+ The caller fills this context in before calling
+ the register function to indicate to the register
+ function which Sx state type and phase the caller
+ wishes to be called back on. For this intertace,
+ the Sx driver will call the registered handlers for
+ all Sx type and phases, so the Sx state handler(s)
+ must check the Type and Phase field of the Dispatch
+ context and act accordingly.
+ @param DispatchHandle Handle of dispatch function, for when interfacing
+ with the parent Sx state SMM driver.
+
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ registered and the SMI source has been enabled.
+ @retval EFI_UNSUPPORTED The Sx driver or hardware does not support that
+ Sx Type/Phase.
+ @retval EFI_DEVICE_ERROR The Sx driver was unable to enable the SMI source.
+ @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
+ child.
+ @retval EFI_INVALID_PARAMETER DispatchContext is invalid. Type & Phase are not
+ within valid range.
**/
typedef
@@ -119,14 +119,14 @@ EFI_STATUS /**
Unregister a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Protocol instance pointer.
+ @param DispatchHandle Handle of dispatch function to deregister.
- @retval EFI_SUCCESS The dispatch function has been successfully unregistered and the
- SMI source has been disabled if there are no other registered child
- dispatch functions for this SMI source.
- @retval EFI_INVALID_PARAMETER Handle is invalid.
- @retval other TBD
+ @retval EFI_SUCCESS The dispatch function has been successfully unregistered and the
+ SMI source has been disabled if there are no other registered child
+ dispatch functions for this SMI source.
+ @retval EFI_INVALID_PARAMETER Handle is invalid.
+ @retval other TBD
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmUsbDispatch.h b/MdePkg/Include/Protocol/SmmUsbDispatch.h index f036171c49..de48f941f0 100644 --- a/MdePkg/Include/Protocol/SmmUsbDispatch.h +++ b/MdePkg/Include/Protocol/SmmUsbDispatch.h @@ -49,11 +49,11 @@ typedef struct { /**
Dispatch function for a USB SMI handler.
- @param DispatchHandle Handle of this dispatch function.
- @param DispatchContext Pointer to the dispatch function's context.
- The DispatchContext fields are filled in
- by the dispatching driver prior to
- invoking this dispatch function.
+ @param DispatchHandle Handle of this dispatch function.
+ @param DispatchContext Pointer to the dispatch function's context.
+ The DispatchContext fields are filled in
+ by the dispatching driver prior to
+ invoking this dispatch function.
Nothing
@@ -68,24 +68,24 @@ VOID /**
Register a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchFunction Pointer to dispatch function to be invoked for
- this SMI source
- @param DispatchContext Pointer to the dispatch function's context.
- The caller fills this context in before calling
- the register function to indicate to the register
- function the USB SMI types for which the dispatch
- function should be invoked.
- @param DispatchHandle Handle of dispatch function, for when interfacing
- with the parent Sx state SMM driver.
-
- @retval EFI_SUCCESS The dispatch function has been successfully
- registered and the SMI source has been enabled.
- @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
- @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
- child.
- @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The USB SMI type
- is not within valid range.
+ @param This Protocol instance pointer.
+ @param DispatchFunction Pointer to dispatch function to be invoked for
+ this SMI source
+ @param DispatchContext Pointer to the dispatch function's context.
+ The caller fills this context in before calling
+ the register function to indicate to the register
+ function the USB SMI types for which the dispatch
+ function should be invoked.
+ @param DispatchHandle Handle of dispatch function, for when interfacing
+ with the parent Sx state SMM driver.
+
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ registered and the SMI source has been enabled.
+ @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
+ @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
+ child.
+ @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The USB SMI type
+ is not within valid range.
**/
typedef
@@ -100,14 +100,14 @@ EFI_STATUS /**
Unregister a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Protocol instance pointer.
+ @param DispatchHandle Handle of dispatch function to deregister.
- @retval EFI_SUCCESS The dispatch function has been successfully
- unregistered and the SMI source has been disabled
- if there are no other registered child dispatch
- functions for this SMI source.
- @retval EFI_INVALID_PARAMETER Handle is invalid.
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ unregistered and the SMI source has been disabled
+ if there are no other registered child dispatch
+ functions for this SMI source.
+ @retval EFI_INVALID_PARAMETER Handle is invalid.
**/
typedef
diff --git a/MdePkg/Include/Protocol/UsbHostController.h b/MdePkg/Include/Protocol/UsbHostController.h index f816d73002..cab9bcdd45 100644 --- a/MdePkg/Include/Protocol/UsbHostController.h +++ b/MdePkg/Include/Protocol/UsbHostController.h @@ -190,7 +190,6 @@ EFI_STATUS transfer endpoint is capable of sending or receiving.
@param IsNewTransfer If TRUE, an asynchronous interrupt pipe is built between the host
and the target interrupt endpoint. If FALSE, the specified
-
@param DataToggle A pointer to the data toggle value.
@param PollingInterval Indicates the interval, in milliseconds, that the asynchronous
interrupt transfer is polled. asynchronous interrupt pipe is canceled.
|