mirror of https://github.com/acidanthera/audk.git
MdePkg/Library/Smm: Fix various typos
Fix various typos in comments and documentation. Cc: Michael D Kinney <michael.d.kinney@intel.com> Cc: Liming Gao <liming.gao@intel.com> Signed-off-by: Antoine Coeur <coeur@gmx.fr> Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com> Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com> Reviewed-by: Liming Gao <liming.gao@intel.com> Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com> Message-Id: <20200207010831.9046-27-philmd@redhat.com>
This commit is contained in:
parent
a8ecf980c0
commit
fae43d06dd
|
@ -45,7 +45,7 @@ TriggerRuntimeSoftwareSmi (
|
|||
it was triggered at boot time, it returns TRUE. Otherwise, it returns FALSE.
|
||||
|
||||
@retval TRUE A software SMI triggered at boot time happened.
|
||||
@retval FLASE No software SMI happened, or the software SMI was triggered at run time.
|
||||
@retval FALSE No software SMI happened, or the software SMI was triggered at run time.
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
|
@ -62,7 +62,7 @@ IsBootServiceSoftwareSmi (
|
|||
it was triggered at run time, it returns TRUE. Otherwise, it returns FALSE.
|
||||
|
||||
@retval TRUE A software SMI triggered at run time happened.
|
||||
@retval FLASE No software SMI happened or the software SMI was triggered at boot time.
|
||||
@retval FALSE No software SMI happened or the software SMI was triggered at boot time.
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
|
|
|
@ -67,7 +67,7 @@ SmmCopyMemToSmram (
|
|||
@param SourceBuffer The pointer to the source buffer of the memory copy.
|
||||
@param Length The number of bytes to copy from SourceBuffer to DestinationBuffer.
|
||||
|
||||
@retval EFI_SECURITY_VIOLATION The DesinationBuffer is invalid per processor architecture or overlap with SMRAM.
|
||||
@retval EFI_SECURITY_VIOLATION The DestinationBuffer is invalid per processor architecture or overlap with SMRAM.
|
||||
@retval EFI_SUCCESS Memory is copied.
|
||||
|
||||
**/
|
||||
|
@ -92,7 +92,7 @@ SmmCopyMemFromSmram (
|
|||
@param SourceBuffer The pointer to the source buffer of the memory copy.
|
||||
@param Length The number of bytes to copy from SourceBuffer to DestinationBuffer.
|
||||
|
||||
@retval EFI_SECURITY_VIOLATION The DesinationBuffer is invalid per processor architecture or overlap with SMRAM.
|
||||
@retval EFI_SECURITY_VIOLATION The DestinationBuffer is invalid per processor architecture or overlap with SMRAM.
|
||||
@retval EFI_SECURITY_VIOLATION The SourceBuffer is invalid per processor architecture or overlap with SMRAM.
|
||||
@retval EFI_SUCCESS Memory is copied.
|
||||
|
||||
|
|
|
@ -64,7 +64,7 @@ PeriodicSmiExit (
|
|||
This function yields control back to the SMM Foundation. When the next
|
||||
periodic SMI for the currently executing handler is triggered, the periodic
|
||||
SMI handler will be resumed and this function will return. Use of this
|
||||
function requires a seperate stack for the periodic SMI handler. A non zero
|
||||
function requires a separate stack for the periodic SMI handler. A non zero
|
||||
stack size must be specified in PeriodicSmiEnable() for this function to be
|
||||
used.
|
||||
|
||||
|
@ -113,7 +113,7 @@ VOID
|
|||
@param[in] DispatchFunction A pointer to a periodic SMI handler function.
|
||||
@param[in] Context Optional content to pass into DispatchFunction.
|
||||
@param[in] TickPeriod The requested tick period in 100ns units that
|
||||
control should be givien to the periodic SMI
|
||||
control should be given to the periodic SMI
|
||||
handler. Must be one of the supported values
|
||||
returned by PeriodicSmiSupportedPickPeriod().
|
||||
@param[in] Cpu Specifies the CPU that is required to execute
|
||||
|
@ -137,7 +137,7 @@ VOID
|
|||
@retval EFI_OUT_OF_RESOURCES There are not enough resources to enable the
|
||||
periodic SMI handler.
|
||||
@retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate the
|
||||
stack speficied by StackSize.
|
||||
stack specified by StackSize.
|
||||
@retval EFI_SUCCESS The periodic SMI handler was enabled.
|
||||
|
||||
**/
|
||||
|
|
|
@ -275,7 +275,7 @@ SmmCopyMemToSmram (
|
|||
@param SourceBuffer The pointer to the source buffer of the memory copy.
|
||||
@param Length The number of bytes to copy from SourceBuffer to DestinationBuffer.
|
||||
|
||||
@retval EFI_SECURITY_VIOLATION The DesinationBuffer is invalid per processor architecture or overlap with SMRAM.
|
||||
@retval EFI_SECURITY_VIOLATION The DestinationBuffer is invalid per processor architecture or overlap with SMRAM.
|
||||
@retval EFI_SUCCESS Memory is copied.
|
||||
|
||||
**/
|
||||
|
@ -308,7 +308,7 @@ SmmCopyMemFromSmram (
|
|||
@param SourceBuffer The pointer to the source buffer of the memory copy.
|
||||
@param Length The number of bytes to copy from SourceBuffer to DestinationBuffer.
|
||||
|
||||
@retval EFI_SECURITY_VIOLATION The DesinationBuffer is invalid per processor architecture or overlap with SMRAM.
|
||||
@retval EFI_SECURITY_VIOLATION The DestinationBuffer is invalid per processor architecture or overlap with SMRAM.
|
||||
@retval EFI_SECURITY_VIOLATION The SourceBuffer is invalid per processor architecture or overlap with SMRAM.
|
||||
@retval EFI_SUCCESS Memory is copied.
|
||||
|
||||
|
|
|
@ -1226,7 +1226,7 @@ PciExpressBitFieldAndThenOr32 (
|
|||
Size into the buffer specified by Buffer. This function only allows the PCI
|
||||
configuration registers from a single PCI function to be read. Size is
|
||||
returned. When possible 32-bit PCI configuration read cycles are used to read
|
||||
from StartAdress to StartAddress + Size. Due to alignment restrictions, 8-bit
|
||||
from StartAddress to StartAddress + Size. Due to alignment restrictions, 8-bit
|
||||
and 16-bit PCI configuration read cycles may be used at the beginning and the
|
||||
end of the range.
|
||||
|
||||
|
@ -1329,7 +1329,7 @@ PciExpressReadBuffer (
|
|||
Size from the buffer specified by Buffer. This function only allows the PCI
|
||||
configuration registers from a single PCI function to be written. Size is
|
||||
returned. When possible 32-bit PCI configuration write cycles are used to
|
||||
write from StartAdress to StartAddress + Size. Due to alignment restrictions,
|
||||
write from StartAddress to StartAddress + Size. Due to alignment restrictions,
|
||||
8-bit and 16-bit PCI configuration write cycles may be used at the beginning
|
||||
and the end of the range.
|
||||
|
||||
|
|
|
@ -35,7 +35,7 @@
|
|||
((((A) << 4) & 0xff000000) | (((A) >> 4) & 0x00000700) | (((A) << 1) & 0x001f0000) | (LShiftU64((A) & 0xfff, 32)))
|
||||
|
||||
//
|
||||
// Global varible to cache pointer to PCI Root Bridge I/O protocol.
|
||||
// Global variable to cache pointer to PCI Root Bridge I/O protocol.
|
||||
//
|
||||
EFI_SMM_PCI_ROOT_BRIDGE_IO_PROTOCOL *mSmmPciRootBridgeIo = NULL;
|
||||
|
||||
|
@ -1238,7 +1238,7 @@ PciBitFieldAndThenOr32 (
|
|||
Size into the buffer specified by Buffer. This function only allows the PCI
|
||||
configuration registers from a single PCI function to be read. Size is
|
||||
returned. When possible 32-bit PCI configuration read cycles are used to read
|
||||
from StartAdress to StartAddress + Size. Due to alignment restrictions, 8-bit
|
||||
from StartAddress to StartAddress + Size. Due to alignment restrictions, 8-bit
|
||||
and 16-bit PCI configuration read cycles may be used at the beginning and the
|
||||
end of the range.
|
||||
|
||||
|
@ -1336,7 +1336,7 @@ PciReadBuffer (
|
|||
Size from the buffer specified by Buffer. This function only allows the PCI
|
||||
configuration registers from a single PCI function to be written. Size is
|
||||
returned. When possible 32-bit PCI configuration write cycles are used to
|
||||
write from StartAdress to StartAddress + Size. Due to alignment restrictions,
|
||||
write from StartAddress to StartAddress + Size. Due to alignment restrictions,
|
||||
8-bit and 16-bit PCI configuration write cycles may be used at the beginning
|
||||
and the end of the range.
|
||||
|
||||
|
|
|
@ -107,8 +107,8 @@ typedef struct {
|
|||
UINT64 DispatchTotalTime;
|
||||
///
|
||||
/// The performance counter value that was captured the last time that the
|
||||
/// periodic SMI handler called PeriodcSmiExecutionTime(). This allows the
|
||||
/// time value returned by PeriodcSmiExecutionTime() to be accurate even when
|
||||
/// periodic SMI handler called PeriodicSmiExecutionTime(). This allows the
|
||||
/// time value returned by PeriodicSmiExecutionTime() to be accurate even when
|
||||
/// the performance counter rolls over.
|
||||
///
|
||||
UINT64 DispatchCheckPointTime;
|
||||
|
@ -127,7 +127,7 @@ typedef struct {
|
|||
///
|
||||
/// Buffer used to save the context when a periodic SMI handler requests to
|
||||
/// yield using PeriodicSmiYield(). This context is used to resume the
|
||||
/// execution of a periodic SMI handler the next time control is transferd
|
||||
/// execution of a periodic SMI handler the next time control is transferred
|
||||
/// to the periodic SMI handler that yielded.
|
||||
///
|
||||
BASE_LIBRARY_JUMP_BUFFER YieldJumpBuffer;
|
||||
|
@ -152,7 +152,7 @@ typedef struct {
|
|||
)
|
||||
|
||||
///
|
||||
/// Pointer to the SMM Periodic Timer Disatch Protocol that was located in the constuctor.
|
||||
/// Pointer to the SMM Periodic Timer Dispatch Protocol that was located in the constructor.
|
||||
///
|
||||
EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL *gSmmPeriodicTimerDispatch2 = NULL;
|
||||
|
||||
|
@ -522,7 +522,7 @@ PeriodicSmiExit (
|
|||
This function yields control back to the SMM Foundation. When the next
|
||||
periodic SMI for the currently executing handler is triggered, the periodic
|
||||
SMI handler will be resumed and this function will return. Use of this
|
||||
function requires a seperate stack for the periodic SMI handler. A non zero
|
||||
function requires a separate stack for the periodic SMI handler. A non zero
|
||||
stack size must be specified in PeriodicSmiEnable() for this function to be
|
||||
used.
|
||||
|
||||
|
@ -572,7 +572,7 @@ PeriodicSmiYield (
|
|||
SetJumpFlag = SetJump (&PeriodicSmiLibraryHandler->YieldJumpBuffer);
|
||||
if (SetJumpFlag == 0) {
|
||||
//
|
||||
// The intial call to SetJump() always returns 0.
|
||||
// The initial call to SetJump() always returns 0.
|
||||
// If this is the initial call, then exit the current periodic SMI handler
|
||||
//
|
||||
PeriodicSmiExit ();
|
||||
|
@ -588,7 +588,7 @@ PeriodicSmiYield (
|
|||
PeriodicSmiLibraryHandler->YieldFlag = FALSE;
|
||||
|
||||
//
|
||||
// Return the amount elapsed time that occured while yielded
|
||||
// Return the amount elapsed time that occurred while yielded
|
||||
//
|
||||
return PeriodicSmiLibraryHandler->ElapsedTime;
|
||||
}
|
||||
|
@ -620,7 +620,7 @@ PeriodicSmiDispatchFunctionSwitchStack (
|
|||
//
|
||||
// Dispatch the registered handler passing in the context that was registered
|
||||
// and the amount of time that has elapsed since the previous time this
|
||||
// periodic SMI handler was dispacthed.
|
||||
// periodic SMI handler was dispatched.
|
||||
//
|
||||
PeriodicSmiLibraryHandler->DispatchFunction (
|
||||
PeriodicSmiLibraryHandler->Context,
|
||||
|
@ -628,16 +628,16 @@ PeriodicSmiDispatchFunctionSwitchStack (
|
|||
);
|
||||
|
||||
//
|
||||
// If this DispatchFunction() returns, then unconditially call PeriodicSmiExit()
|
||||
// If this DispatchFunction() returns, then unconditionally call PeriodicSmiExit()
|
||||
// to perform a LongJump() back to PeriodicSmiDispatchFunctionOnCpu(). The
|
||||
// LongJump() will resume exection on the original stack.
|
||||
// LongJump() will resume execution on the original stack.
|
||||
//
|
||||
PeriodicSmiExit ();
|
||||
}
|
||||
|
||||
/**
|
||||
Internal worker function that transfers control to an enabled periodic SMI
|
||||
handler on the specified logial CPU. This function determines if the periodic
|
||||
handler on the specified logical CPU. This function determines if the periodic
|
||||
SMI handler yielded and needs to be resumed. It also and switches to an
|
||||
allocated stack if one was allocated in PeriodicSmiEnable().
|
||||
|
||||
|
@ -652,9 +652,9 @@ PeriodicSmiDispatchFunctionOnCpu (
|
|||
)
|
||||
{
|
||||
//
|
||||
// Save context in DispatchJumpBuffer. The intial call to SetJump() always
|
||||
// Save context in DispatchJumpBuffer. The initial call to SetJump() always
|
||||
// returns 0. If this is the initial call, then either resume from a prior
|
||||
// call to PeriodicSmiYield() or call the DispatchFunction registerd in
|
||||
// call to PeriodicSmiYield() or call the DispatchFunction registered in
|
||||
// PeriodicSmiEnable() using an allocated stack if one was specified.
|
||||
//
|
||||
if (SetJump (&PeriodicSmiLibraryHandler->DispatchJumpBuffer) != 0) {
|
||||
|
@ -679,7 +679,7 @@ PeriodicSmiDispatchFunctionOnCpu (
|
|||
//
|
||||
// If Stack is NULL then call DispatchFunction using current stack passing
|
||||
// in the context that was registered and the amount of time that has
|
||||
// elapsed since the previous time this periodic SMI handler was dispacthed.
|
||||
// elapsed since the previous time this periodic SMI handler was dispatched.
|
||||
//
|
||||
PeriodicSmiLibraryHandler->DispatchFunction (
|
||||
PeriodicSmiLibraryHandler->Context,
|
||||
|
@ -687,7 +687,7 @@ PeriodicSmiDispatchFunctionOnCpu (
|
|||
);
|
||||
|
||||
//
|
||||
// If this DispatchFunction() returns, then unconditially call PeriodicSmiExit()
|
||||
// If this DispatchFunction() returns, then unconditionally call PeriodicSmiExit()
|
||||
// to perform a LongJump() back to this function.
|
||||
//
|
||||
PeriodicSmiExit ();
|
||||
|
@ -712,7 +712,7 @@ PeriodicSmiDispatchFunctionOnCpu (
|
|||
|
||||
/**
|
||||
Internal worker function that transfers control to an enabled periodic SMI
|
||||
handler on the specified logial CPU. This worker function is only called
|
||||
handler on the specified logical CPU. This worker function is only called
|
||||
using the SMM Services Table function SmmStartupThisAp() to execute the
|
||||
periodic SMI handler on a logical CPU that is different than the one that is
|
||||
running the SMM Foundation. When the periodic SMI handler returns, a lock is
|
||||
|
@ -736,7 +736,7 @@ PeriodicSmiDispatchFunctionWithLock (
|
|||
PeriodicSmiLibraryHandler = (PERIODIC_SMI_LIBRARY_HANDLER_CONTEXT *)Buffer;
|
||||
|
||||
//
|
||||
// Execute dispatch function on the currently excuting logical CPU
|
||||
// Execute dispatch function on the currently executing logical CPU
|
||||
//
|
||||
PeriodicSmiDispatchFunctionOnCpu (PeriodicSmiLibraryHandler);
|
||||
|
||||
|
@ -805,7 +805,7 @@ PeriodicSmiDispatchFunction (
|
|||
(PeriodicSmiLibraryHandler->Cpu == gSmst->CurrentlyExecutingCpu) ) {
|
||||
//
|
||||
// Dispatch on the currently execution CPU if the CPU specified in PeriodicSmiEnable()
|
||||
// was PERIODIC_SMI_LIBARRY_ANY_CPU or the currently executing CPU matches the CPU
|
||||
// was PERIODIC_SMI_LIBRARY_ANY_CPU or the currently executing CPU matches the CPU
|
||||
// that was specified in PeriodicSmiEnable().
|
||||
//
|
||||
PeriodicSmiDispatchFunctionOnCpu (PeriodicSmiLibraryHandler);
|
||||
|
@ -867,7 +867,7 @@ PeriodicSmiDispatchFunction (
|
|||
@param[in] DispatchFunction A pointer to a periodic SMI handler function.
|
||||
@param[in] Context Optional content to pass into DispatchFunction.
|
||||
@param[in] TickPeriod The requested tick period in 100ns units that
|
||||
control should be givien to the periodic SMI
|
||||
control should be given to the periodic SMI
|
||||
handler. Must be one of the supported values
|
||||
returned by PeriodicSmiSupportedPickPeriod().
|
||||
@param[in] Cpu Specifies the CPU that is required to execute
|
||||
|
@ -891,7 +891,7 @@ PeriodicSmiDispatchFunction (
|
|||
@retval EFI_OUT_OF_RESOURCES There are not enough resources to enable the
|
||||
periodic SMI handler.
|
||||
@retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate the
|
||||
stack speficied by StackSize.
|
||||
stack specified by StackSize.
|
||||
@retval EFI_SUCCESS The periodic SMI handler was enabled.
|
||||
|
||||
**/
|
||||
|
@ -1077,7 +1077,7 @@ SmmPeriodicSmiLibConstructor (
|
|||
|
||||
//
|
||||
// Count the number of periodic SMI tick intervals that the SMM Periodic Timer
|
||||
// Dipatch 2 Protocol supports.
|
||||
// Dispatch 2 Protocol supports.
|
||||
//
|
||||
SmiTickInterval = NULL;
|
||||
Count = 0;
|
||||
|
|
|
@ -36,7 +36,7 @@ SmmServicesTableLibConstructor (
|
|||
//
|
||||
// Retrieve SMM Base2 Protocol, Do not use gBS from UefiBootServicesTableLib on purpose
|
||||
// to prevent inclusion of gBS, gST, and gImageHandle from SMM Drivers unless the
|
||||
// SMM driver explicity declares that dependency.
|
||||
// SMM driver explicitly declares that dependency.
|
||||
//
|
||||
Status = SystemTable->BootServices->LocateProtocol (
|
||||
&gEfiSmmBase2ProtocolGuid,
|
||||
|
|
Loading…
Reference in New Issue