diff options
| author | pkandel <pkandel@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-06-04 16:16:15 +0000 |
|---|---|---|
| committer | pkandel <pkandel@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-06-04 16:16:15 +0000 |
| commit | 1a2f870c9babe077c2d3abea23b6e8e044778341 (patch) | |
| tree | db545c66ef72b32da3dbd2406b256c3430702af0 /MdePkg/Include/Library | |
| parent | 7076244ef4005642712f32591abbd8188d6b6f40 (diff) | |
Second set of changes based on a review of the code comments in the Include directory for typos, grammar issues, and language clarity.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8467 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Library')
21 files changed, 175 insertions, 175 deletions
diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h index 291accc46..32887b18e 100644 --- a/MdePkg/Include/Library/BaseLib.h +++ b/MdePkg/Include/Library/BaseLib.h @@ -1,6 +1,6 @@ /** @file
Provides string functions, linked list functions, math functions, synchronization
- functions, and CPU architecture specific functions.
+ functions, and CPU architecture-specific functions.
Copyright (c) 2006 - 2008, Intel Corporation<BR>
All rights reserved. This program and the accompanying materials
@@ -17,11 +17,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define __BASE_LIB__
//
-// Definitions for architecture specific types
+// Definitions for architecture-specific types
//
#if defined (MDE_CPU_IA32)
///
-/// IA32 context buffer used by SetJump() and LongJump()
+/// IA-32 architecture context buffer used by SetJump() and LongJump()
///
typedef struct {
UINT32 Ebx;
@@ -39,7 +39,7 @@ typedef struct { #if defined (MDE_CPU_IPF)
///
-/// IPF context buffer used by SetJump() and LongJump()
+/// Itanium architecture context buffer used by SetJump() and LongJump()
///
typedef struct {
UINT64 F2[2];
@@ -88,7 +88,7 @@ typedef struct { #if defined (MDE_CPU_X64)
///
-/// x64 context buffer used by SetJump() and LongJump()
+/// x64 architecture context buffer used by SetJump() and LongJump()
///
typedef struct {
UINT64 Rbx;
@@ -3159,7 +3159,7 @@ MemoryFence ( calls to LongJump() cause a non-zero value to be returned by SetJump().
If JumpBuffer is NULL, then ASSERT().
- For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
+ For Itanium processors, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
NOTE: The structure BASE_LIBRARY_JUMP_BUFFER is CPU architecture specific.
The same structure must never be used for more than one CPU architecture context.
@@ -3186,7 +3186,7 @@ SetJump ( the state of JumpBuffer.
If JumpBuffer is NULL, then ASSERT().
- For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
+ For Itanium processors, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
If Value is 0, then ASSERT().
@param JumpBuffer A pointer to CPU context buffer.
@@ -3311,8 +3311,8 @@ CpuPause ( by Context1 and Context2. Context1 and Context2 are optional and may
be NULL. The function EntryPoint must never return. This function
supports a variable number of arguments following the NewStack parameter.
- These additional arguments are ignored on IA-32, x64, and EBC.
- IPF CPUs expect one additional parameter of type VOID * that specifies
+ These additional arguments are ignored on IA-32, x64, and EBC architectures.
+ Itanium processors expect one additional parameter of type VOID * that specifies
the new backing store pointer.
If EntryPoint is NULL, then ASSERT().
@@ -3325,8 +3325,8 @@ CpuPause ( function.
@param NewStack A pointer to the new stack to use for the EntryPoint
function.
- @param ... This variable argument list is ignored for IA32, x64, and EBC.
- For IPF, this variable argument list is expected to contain
+ @param ... This variable argument list is ignored for IA-32, x64, and EBC architectures.
+ For Itanium processors, this variable argument list is expected to contain
a single parameter of type VOID * that specifies the new backing
store pointer.
@@ -3384,7 +3384,7 @@ CpuDeadLoop ( line containing Address + Length - 1 is flushed. This function may choose to flush
the entire cache if that is more efficient than flushing the specified range. If
Length is 0, the no cache lines are flushed. Address is returned.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().
@@ -3410,7 +3410,7 @@ AsmFlushCacheRange ( Executes a FC instruction
Executes a FC instruction on the cache line specified by Address.
The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
- An implementation may flush a larger region. This function is only available on IPF.
+ An implementation may flush a larger region. This function is only available on Itanium processors.
@param Address The Address of cache line to be flushed.
@@ -3428,7 +3428,7 @@ AsmFc ( Executes a FC.I instruction.
Executes a FC.I instruction on the cache line specified by Address.
The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
- An implementation may flush a larger region. This function is only available on IPF.
+ An implementation may flush a larger region. This function is only available on Itanium processors.
@param Address The Address of cache line to be flushed.
@@ -3451,7 +3451,7 @@ AsmFci ( No parameter checking is performed on Index. If the Index value is beyond the
implemented CPUID register range, a Reserved Register/Field fault may occur. The caller
must either guarantee that Index is valid, or the caller must set up fault handlers to
- catch the faults. This function is only available on IPF.
+ catch the faults. This function is only available on Itanium processors.
@param Index The 8-bit Processor Identifier Register index to read.
@@ -3467,7 +3467,7 @@ AsmReadCpuid ( /**
Reads the current value of 64-bit Processor Status Register (PSR).
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@return The current value of PSR.
@@ -3485,7 +3485,7 @@ AsmReadPsr ( No parameter checking is performed on Value. All bits of Value corresponding to
reserved fields of PSR must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must set up
- fault handlers to catch the faults. This function is only available on IPF.
+ fault handlers to catch the faults. This function is only available on Itanium processors.
@param Value The 64-bit value to write to PSR.
@@ -3503,7 +3503,7 @@ AsmWritePsr ( Reads the current value of 64-bit Kernel Register #0 (KR0).
Reads and returns the current value of KR0.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@return The current value of KR0.
@@ -3519,7 +3519,7 @@ AsmReadKr0 ( Reads the current value of 64-bit Kernel Register #1 (KR1).
Reads and returns the current value of KR1.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@return The current value of KR1.
@@ -3535,7 +3535,7 @@ AsmReadKr1 ( Reads the current value of 64-bit Kernel Register #2 (KR2).
Reads and returns the current value of KR2.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@return The current value of KR2.
@@ -3551,7 +3551,7 @@ AsmReadKr2 ( Reads the current value of 64-bit Kernel Register #3 (KR3).
Reads and returns the current value of KR3.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@return The current value of KR3.
@@ -3567,7 +3567,7 @@ AsmReadKr3 ( Reads the current value of 64-bit Kernel Register #4 (KR4).
Reads and returns the current value of KR4.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@return The current value of KR4.
@@ -3583,7 +3583,7 @@ AsmReadKr4 ( Reads the current value of 64-bit Kernel Register #5 (KR5).
Reads and returns the current value of KR5.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@return The current value of KR5.
@@ -3599,7 +3599,7 @@ AsmReadKr5 ( Reads the current value of 64-bit Kernel Register #6 (KR6).
Reads and returns the current value of KR6.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@return The current value of KR6.
@@ -3615,7 +3615,7 @@ AsmReadKr6 ( Reads the current value of 64-bit Kernel Register #7 (KR7).
Reads and returns the current value of KR7.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@return The current value of KR7.
@@ -3631,7 +3631,7 @@ AsmReadKr7 ( Write the current value of 64-bit Kernel Register #0 (KR0).
Writes the current value of KR0. The 64-bit value written to
- the KR0 is returned. This function is only available on IPF.
+ the KR0 is returned. This function is only available on Itanium processors.
@param Value The 64-bit value to write to KR0.
@@ -3649,7 +3649,7 @@ AsmWriteKr0 ( Write the current value of 64-bit Kernel Register #1 (KR1).
Writes the current value of KR1. The 64-bit value written to
- the KR1 is returned. This function is only available on IPF.
+ the KR1 is returned. This function is only available on Itanium processors.
@param Value The 64-bit value to write to KR1.
@@ -3667,7 +3667,7 @@ AsmWriteKr1 ( Write the current value of 64-bit Kernel Register #2 (KR2).
Writes the current value of KR2. The 64-bit value written to
- the KR2 is returned. This function is only available on IPF.
+ the KR2 is returned. This function is only available on Itanium processors.
@param Value The 64-bit value to write to KR2.
@@ -3685,7 +3685,7 @@ AsmWriteKr2 ( Write the current value of 64-bit Kernel Register #3 (KR3).
Writes the current value of KR3. The 64-bit value written to
- the KR3 is returned. This function is only available on IPF.
+ the KR3 is returned. This function is only available on Itanium processors.
@param Value The 64-bit value to write to KR3.
@@ -3703,7 +3703,7 @@ AsmWriteKr3 ( Write the current value of 64-bit Kernel Register #4 (KR4).
Writes the current value of KR4. The 64-bit value written to
- the KR4 is returned. This function is only available on IPF.
+ the KR4 is returned. This function is only available on Itanium processors.
@param Value The 64-bit value to write to KR4.
@@ -3721,7 +3721,7 @@ AsmWriteKr4 ( Write the current value of 64-bit Kernel Register #5 (KR5).
Writes the current value of KR5. The 64-bit value written to
- the KR5 is returned. This function is only available on IPF.
+ the KR5 is returned. This function is only available on Itanium processors.
@param Value The 64-bit value to write to KR5.
@@ -3739,7 +3739,7 @@ AsmWriteKr5 ( Write the current value of 64-bit Kernel Register #6 (KR6).
Writes the current value of KR6. The 64-bit value written to
- the KR6 is returned. This function is only available on IPF.
+ the KR6 is returned. This function is only available on Itanium processors.
@param Value The 64-bit value to write to KR6.
@@ -3757,7 +3757,7 @@ AsmWriteKr6 ( Write the current value of 64-bit Kernel Register #7 (KR7).
Writes the current value of KR7. The 64-bit value written to
- the KR7 is returned. This function is only available on IPF.
+ the KR7 is returned. This function is only available on Itanium processors.
@param Value The 64-bit value to write to KR7.
@@ -3775,7 +3775,7 @@ AsmWriteKr7 ( Reads the current value of Interval Timer Counter Register (ITC).
Reads and returns the current value of ITC.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@return The current value of ITC.
@@ -3791,7 +3791,7 @@ AsmReadItc ( Reads the current value of Interval Timer Vector Register (ITV).
Reads and returns the current value of ITV.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@return The current value of ITV.
@@ -3807,7 +3807,7 @@ AsmReadItv ( Reads the current value of Interval Timer Match Register (ITM).
Reads and returns the current value of ITM.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@return The current value of ITM.
**/
@@ -3822,7 +3822,7 @@ AsmReadItm ( Writes the current value of 64-bit Interval Timer Counter Register (ITC).
Writes the current value of ITC. The 64-bit value written to the ITC is returned.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Value The 64-bit value to write to ITC.
@@ -3840,7 +3840,7 @@ AsmWriteItc ( Writes the current value of 64-bit Interval Timer Match Register (ITM).
Writes the current value of ITM. The 64-bit value written to the ITM is returned.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Value The 64-bit value to write to ITM.
@@ -3862,7 +3862,7 @@ AsmWriteItm ( reserved fields of ITV must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must set up
fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Value The 64-bit value to write to ITV.
@@ -3879,7 +3879,7 @@ AsmWriteItv ( /**
Reads the current value of Default Control Register (DCR).
- Reads and returns the current value of DCR. This function is only available on IPF.
+ Reads and returns the current value of DCR. This function is only available on Itanium processors.
@return The current value of DCR.
@@ -3894,7 +3894,7 @@ AsmReadDcr ( /**
Reads the current value of Interruption Vector Address Register (IVA).
- Reads and returns the current value of IVA. This function is only available on IPF.
+ Reads and returns the current value of IVA. This function is only available on Itanium processors.
@return The current value of IVA.
**/
@@ -3908,7 +3908,7 @@ AsmReadIva ( /**
Reads the current value of Page Table Address Register (PTA).
- Reads and returns the current value of PTA. This function is only available on IPF.
+ Reads and returns the current value of PTA. This function is only available on Itanium processors.
@return The current value of PTA.
@@ -3928,7 +3928,7 @@ AsmReadPta ( reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must set up
fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Value The 64-bit value to write to DCR.
@@ -3948,7 +3948,7 @@ AsmWriteDcr ( Writes the current value of IVA. The 64-bit value written to the IVA is returned.
The size of vector table is 32 K bytes and is 32 K bytes aligned
the low 15 bits of Value is ignored when written.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Value The 64-bit value to write to IVA.
@@ -3970,7 +3970,7 @@ AsmWriteIva ( reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must set up
fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Value The 64-bit value to write to PTA.
@@ -3986,7 +3986,7 @@ AsmWritePta ( /**
Reads the current value of Local Interrupt ID Register (LID).
- Reads and returns the current value of LID. This function is only available on IPF.
+ Reads and returns the current value of LID. This function is only available on Itanium processors.
@return The current value of LID.
@@ -4001,7 +4001,7 @@ AsmReadLid ( /**
Reads the current value of External Interrupt Vector Register (IVR).
- Reads and returns the current value of IVR. This function is only available on IPF.
+ Reads and returns the current value of IVR. This function is only available on Itanium processors.
@return The current value of IVR.
@@ -4016,7 +4016,7 @@ AsmReadIvr ( /**
Reads the current value of Task Priority Register (TPR).
- Reads and returns the current value of TPR. This function is only available on IPF.
+ Reads and returns the current value of TPR. This function is only available on Itanium processors.
@return The current value of TPR.
@@ -4031,7 +4031,7 @@ AsmReadTpr ( /**
Reads the current value of External Interrupt Request Register #0 (IRR0).
- Reads and returns the current value of IRR0. This function is only available on IPF.
+ Reads and returns the current value of IRR0. This function is only available on Itanium processors.
@return The current value of IRR0.
@@ -4046,7 +4046,7 @@ AsmReadIrr0 ( /**
Reads the current value of External Interrupt Request Register #1 (IRR1).
- Reads and returns the current value of IRR1. This function is only available on IPF.
+ Reads and returns the current value of IRR1. This function is only available on Itanium processors.
@return The current value of IRR1.
@@ -4061,7 +4061,7 @@ AsmReadIrr1 ( /**
Reads the current value of External Interrupt Request Register #2 (IRR2).
- Reads and returns the current value of IRR2. This function is only available on IPF.
+ Reads and returns the current value of IRR2. This function is only available on Itanium processors.
@return The current value of IRR2.
@@ -4076,7 +4076,7 @@ AsmReadIrr2 ( /**
Reads the current value of External Interrupt Request Register #3 (IRR3).
- Reads and returns the current value of IRR3. This function is only available on IPF.
+ Reads and returns the current value of IRR3. This function is only available on Itanium processors.
@return The current value of IRR3.
@@ -4091,7 +4091,7 @@ AsmReadIrr3 ( /**
Reads the current value of Performance Monitor Vector Register (PMV).
- Reads and returns the current value of PMV. This function is only available on IPF.
+ Reads and returns the current value of PMV. This function is only available on Itanium processors.
@return The current value of PMV.
@@ -4106,7 +4106,7 @@ AsmReadPmv ( /**
Reads the current value of Corrected Machine Check Vector Register (CMCV).
- Reads and returns the current value of CMCV. This function is only available on IPF.
+ Reads and returns the current value of CMCV. This function is only available on Itanium processors.
@return The current value of CMCV.
@@ -4121,7 +4121,7 @@ AsmReadCmcv ( /**
Reads the current value of Local Redirection Register #0 (LRR0).
- Reads and returns the current value of LRR0. This function is only available on IPF.
+ Reads and returns the current value of LRR0. This function is only available on Itanium processors.
@return The current value of LRR0.
@@ -4136,7 +4136,7 @@ AsmReadLrr0 ( /**
Reads the current value of Local Redirection Register #1 (LRR1).
- Reads and returns the current value of LRR1. This function is only available on IPF.
+ Reads and returns the current value of LRR1. This function is only available on Itanium processors.
@return The current value of LRR1.
@@ -4156,7 +4156,7 @@ AsmReadLrr1 ( reserved fields of LID must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must set up
fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Value The 64-bit value to write to LID.
@@ -4178,7 +4178,7 @@ AsmWriteLid ( reserved fields of TPR must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must set up
fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Value The 64-bit value to write to TPR.
@@ -4195,7 +4195,7 @@ AsmWriteTpr ( /**
Performs a write operation on End OF External Interrupt Register (EOI).
- Writes a value of 0 to the EOI Register. This function is only available on IPF.
+ Writes a value of 0 to the EOI Register. This function is only available on Itanium processors.
**/
VOID
@@ -4213,7 +4213,7 @@ AsmWriteEoi ( to reserved fields of PMV must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must set up
fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Value The 64-bit value to write to PMV.
@@ -4235,7 +4235,7 @@ AsmWritePmv ( to reserved fields of CMCV must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must set up
fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Value The 64-bit value to write to CMCV.
@@ -4257,7 +4257,7 @@ AsmWriteCmcv ( to reserved fields of LRR0 must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must set up
fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Value The 64-bit value to write to LRR0.
@@ -4279,7 +4279,7 @@ AsmWriteLrr0 ( to reserved fields of LRR1 must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must
set up fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Value The 64-bit value to write to LRR1.
@@ -4304,7 +4304,7 @@ AsmWriteLrr1 ( is beyond the implemented IBR register range, a Reserved Register/Field fault may
occur. The caller must either guarantee that Index is valid, or the caller must
set up fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Index The 8-bit Instruction Breakpoint Register index to read.
@@ -4329,7 +4329,7 @@ AsmReadIbr ( the implemented DBR register range, a Reserved Register/Field fault may occur.
The caller must either guarantee that Index is valid, or the caller must set up
fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Index The 8-bit Data Breakpoint Register index to read.
@@ -4354,7 +4354,7 @@ AsmReadDbr ( register set is implementation dependent. No parameter checking is performed
on Index. If the Index value is beyond the implemented PMC register range,
zero value will be returned.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Index The 8-bit Performance Monitor Configuration Register index to read.
@@ -4380,7 +4380,7 @@ AsmReadPmc ( register set is implementation dependent. No parameter checking is performed
on Index. If the Index value is beyond the implemented PMD register range,
zero value will be returned.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Index The 8-bit Performance Monitor Data Register index to read.
@@ -4406,7 +4406,7 @@ AsmReadPmd ( is beyond the implemented IBR register range, a Reserved Register/Field fault may
occur. The caller must either guarantee that Index is valid, or the caller must
set up fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Index The 8-bit Instruction Breakpoint Register index to write.
@param Value The 64-bit value to write to IBR.
@@ -4434,7 +4434,7 @@ AsmWriteIbr ( DBR register range, a Reserved Register/Field fault may occur. The caller must
either guarantee that Index is valid, or the caller must set up fault handlers to
catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Index The 8-bit Data Breakpoint Register index to write.
@param Value The 64-bit value to write to DBR.
@@ -4461,7 +4461,7 @@ AsmWriteDbr ( counters (PMC/PMD pairs). The remainder of PMC and PMD register set is implementation
dependent. No parameter checking is performed on Index. If the Index value is
beyond the implemented PMC register range, the write is ignored.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Index The 8-bit Performance Monitor Configuration Register index to write.
@param Value The 64-bit value to write to PMC.
@@ -4488,7 +4488,7 @@ AsmWritePmc ( performance counters (PMC/PMD pairs). The remainder of PMC and PMD register set
is implementation dependent. No parameter checking is performed on Index. If the
Index value is beyond the implemented PMD register range, the write is ignored.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Index The 8-bit Performance Monitor Data Register index to write.
@param Value The 64-bit value to write to PMD.
@@ -4508,7 +4508,7 @@ AsmWritePmd ( Reads the current value of 64-bit Global Pointer (GP).
Reads and returns the current value of GP.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@return The current value of GP.
@@ -4525,7 +4525,7 @@ AsmReadGp ( Writes the current value of GP. The 64-bit value written to the GP is returned.
No parameter checking is performed on Value.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Value The 64-bit value to write to GP.
@@ -4543,7 +4543,7 @@ AsmWriteGp ( Reads the current value of 64-bit Stack Pointer (SP).
Reads and returns the current value of SP.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@return The current value of SP.
@@ -4590,7 +4590,7 @@ AsmReadSp ( Reads and returns the control register specified by Index. The valid Index valued are defined
above in "Related Definitions".
- If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only available on IPF.
+ If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only available on Itanium processors.
@param Index The index of the control register to read.
@@ -4640,7 +4640,7 @@ AsmReadControlRegister ( Reads and returns the application register specified by Index. The valid Index valued are defined
above in "Related Definitions".
- If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only available on IPF.
+ If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only available on Itanium processors.
@param Index The index of the application register to read.
@@ -4661,7 +4661,7 @@ AsmReadApplicationRegister ( parameter checking is performed on Index, and if the Index value is beyond the implemented MSR
register range, a Reserved Register/Field fault may occur. The caller must either guarantee that
Index is valid, or the caller must set up fault handlers to catch the faults. This function is
- only available on IPF.
+ only available on Itanium processors.
@param Index The 8-bit Machine Specific Register index to read.
@@ -4682,7 +4682,7 @@ AsmReadMsr ( parameter checking is performed on Index, and if the Index value is beyond the implemented MSR
register range, a Reserved Register/Field fault may occur. The caller must either guarantee that
Index is valid, or the caller must set up fault handlers to catch the faults. This function is
- only available on IPF.
+ only available on Itanium processors.
@param Index The 8-bit Machine Specific Register index to write.
@param Value The 64-bit value to write to the Machine Specific Register.
@@ -4706,7 +4706,7 @@ AsmWriteMsr ( If the CPU is in physical mode(PSR.RT=0, PSR.DT=0, PSR.IT=0), then 0 is returned.
If the CPU is not in physical mode or virtual mode, then it is in mixed mode,
and -1 is returned.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@retval 1 The CPU is in virtual mode.
@retval 0 The CPU is in physical mode.
@@ -4740,7 +4740,7 @@ AsmCpuVirtual ( argument return value may be returned or undefined result may occur during the
execution of the procedure. If the PalEntryPoint does not point to a valid
PAL entry point then the system behavior is undefined. This function is only
- available on IPF.
+ available on Itanium processors.
@param PalEntryPoint The PAL procedure calls entry point.
@param Index The PAL procedure Index number.
@@ -4894,7 +4894,7 @@ typedef struct { #if defined (MDE_CPU_IA32)
///
-/// Byte packed structure for an IA32 Interrupt Gate Descriptor
+/// Byte packed structure for an IA-32 Interrupt Gate Descriptor
///
typedef union {
struct {
diff --git a/MdePkg/Include/Library/CacheMaintenanceLib.h b/MdePkg/Include/Library/CacheMaintenanceLib.h index a575ec2fc..eec774512 100644 --- a/MdePkg/Include/Library/CacheMaintenanceLib.h +++ b/MdePkg/Include/Library/CacheMaintenanceLib.h @@ -39,7 +39,7 @@ InvalidateInstructionCache ( aligned on a cache line boundary, then the entire instruction cache line
containing Address + Length -1 is invalidated. This function may choose to
invalidate the entire instruction cache if that is more efficient than
- invalidating the specified range. If Length is 0, the no instruction cache
+ invalidating the specified range. If Length is 0, then no instruction cache
lines are invalidated. Address is returned.
If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().
@@ -88,7 +88,7 @@ WriteBackInvalidateDataCache ( line containing Address + Length -1 is written back and invalidated. This
function may choose to write back and invalidate the entire data cache if
that is more efficient than writing back and invalidating the specified
- range. If Length is 0, the no data cache lines are written back and
+ range. If Length is 0, then no data cache lines are written back and
invalidated. Address is returned.
If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().
@@ -136,7 +136,7 @@ WriteBackDataCache ( cache line boundary, then the entire data cache line containing Address +
Length -1 is written back. This function may choose to write back the entire
data cache if that is more efficient than writing back the specified range.
- If Length is 0, the no data cache lines are written back. This function may
+ If Length is 0, then no data cache lines are written back. This function may
also invalidate all the data cache lines in the specified range of the cache
coherency domain of the calling CPU. Address is returned.
diff --git a/MdePkg/Include/Library/CpuLib.h b/MdePkg/Include/Library/CpuLib.h index b9a186942..629b97265 100644 --- a/MdePkg/Include/Library/CpuLib.h +++ b/MdePkg/Include/Library/CpuLib.h @@ -3,7 +3,7 @@ in the Base Library due to dependencies on the PAL Library
The CPU Library provides services to flush CPU TLBs and place the CPU in a sleep state.
- The implementation of these services on Itanium CPUs requires the use of PAL Calls.
+ The implementation of these services on Itanium processors requires the use of PAL Calls.
PAL Calls require PEI and DXE specific mechanisms to look up PAL Entry Point.
As a result, these services could not be defined in the Base Library.
diff --git a/MdePkg/Include/Library/DebugLib.h b/MdePkg/Include/Library/DebugLib.h index e25713f5c..9cb9027b7 100644 --- a/MdePkg/Include/Library/DebugLib.h +++ b/MdePkg/Include/Library/DebugLib.h @@ -216,10 +216,10 @@ DebugClearMemoryEnabled ( /**
Internal worker macro that calls DebugAssert().
- This macro calls DebugAssert() passing in the filename, line number, and
- expression that evailated to FALSE.
+ This macro calls DebugAssert(), passing in the filename, line number, and an
+ expression that evaluated to FALSE.
- @param Expression Boolean expression that evailated to FALSE
+ @param Expression Boolean expression that evaluated to FALSE
**/
#define _ASSERT(Expression) DebugAssert (__FILE__, __LINE__, #Expression)
@@ -239,7 +239,7 @@ DebugClearMemoryEnabled ( /**
- Macro that calls DebugAssert() if a expression evaluates to FALSE.
+ Macro that calls DebugAssert() if an expression evaluates to FALSE.
If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set,
then this macro evaluates the Boolean expression specified by Expression. If
diff --git a/MdePkg/Include/Library/DxeServicesLib.h b/MdePkg/Include/Library/DxeServicesLib.h index aea99dec3..23a8bed3f 100644 --- a/MdePkg/Include/Library/DxeServicesLib.h +++ b/MdePkg/Include/Library/DxeServicesLib.h @@ -13,14 +13,17 @@ **/
-#ifndef __DXE_SERVICES_LIB_H__
-#define __DXE_SERVICES_LIB_H__
+#ifndef __PI_LIB_H__
+#define __PI_LIB_H__
+
+#include <Pi/PiFirmwareFile.h>
+
/**
- Searches all the availables firmware volumes and returns the first matching FFS section.
+ Searches all the available firmware volumes and returns the first matching FFS section.
This function searches all the firmware volumes for FFS files with an FFS filename specified by NameGuid.
- The order that the firmware volumes is searched is not deterministic. For each FFS file found a search
+ The order in which the firmware volumes are searched is not deterministic. For each FFS file found, a search
is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances
of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer.
Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size.
@@ -42,7 +45,7 @@ @param SectionType Indicates the FFS section type to search for within the FFS file specified by NameGuid.
@param SectionInstance Indicates which section instance within the FFS file specified by NameGuid to retrieve.
@param Buffer On output, a pointer to a callee allocated buffer containing the FFS file section that was found.
- Is it the caller's responsibility to free this buffer using FreePool().
+ It is the caller's responsibility to free this buffer using FreePool().
@param Size On output, a pointer to the size, in bytes, of Buffer.
@retval EFI_SUCCESS The specified FFS section was returned.
@@ -66,7 +69,7 @@ GetSectionFromAnyFv ( Searches the firmware volume that the currently executing module was loaded from and returns the first matching FFS section.
This function searches the firmware volume that the currently executing module was loaded
- from for an FFS file with an FFS filename specified by NameGuid. If the FFS file is found a search
+ from for an FFS file with an FFS filename specified by NameGuid. If the FFS file is found, a search
is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance
instances of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer.
Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size.
@@ -88,7 +91,7 @@ GetSectionFromAnyFv ( @param SectionType Indicates the FFS section type to search for within the FFS file specified by NameGuid.
@param SectionInstance Indicates which section instance within the FFS file specified by NameGuid to retrieve.
@param Buffer On output, a pointer to a callee allocated buffer containing the FFS file section that was found.
- Is it the caller's responsibility to free this buffer using FreePool().
+ It is the caller's responsibility to free this buffer using FreePool().
@param Size On output, a pointer to the size, in bytes, of Buffer.
@@ -134,7 +137,7 @@ GetSectionFromFv ( @param SectionInstance Indicates which section instance to retrieve within the FFS file
that the currently executing module was loaded from.
@param Buffer On output, a pointer to a callee allocated buffer containing the FFS file section that was found.
- Is it the caller's responsibility to free this buffer using FreePool().
+ It is the caller's responsibility to free this buffer using FreePool().
@param Size On output, a pointer to the size, in bytes, of Buffer.
@retval EFI_SUCCESS The specified FFS section was returned.
diff --git a/MdePkg/Include/Library/PalLib.h b/MdePkg/Include/Library/PalLib.h index a113659b0..4f2a6cd8e 100644 --- a/MdePkg/Include/Library/PalLib.h +++ b/MdePkg/Include/Library/PalLib.h @@ -2,12 +2,12 @@ Provides library services to make PAL Calls.
The PAL Library provides a service to make a PAL CALL. This service is identical
- in functionality to AsmPalCall() in the Itanium specific functions of the Base Library.
- The only difference is that the PAL Entry Point is not passed in. Implementations
+ in functionality to AsmPalCall() in the functions of the Base Library specific to Intel Itanium architecture.
+ The only difference is that the PAL Entry Point is not passed in. Implementations
of this library class must manage PAL Entry Point on their own. For example, a PEI
implementation can use a PPI to lookup the PAL Entry Point, and a DXE implementation
can contain a constructor to look up the PAL Entry Point from a HOB. This library class
- is only available on IPF.
+ is only available on Intel Itanium-based platforms.
Copyright (c) 2006 - 2008, Intel Corporation<BR>
All rights reserved. This program and the accompanying materials
@@ -40,7 +40,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. may cause undefined results. For those parameters defined as reserved or some fields
defined as reserved must be zero filled or the invalid argument return value may be
returned or undefined result may occur during the execution of the procedure.
- This function is only available on IPF.
+ This function is only available on Intel Itanium-based platforms.
@param Index The PAL procedure Index number.
@param Arg2 The 2nd parameter for PAL procedure calls.
diff --git a/MdePkg/Include/Library/PcdLib.h b/MdePkg/Include/Library/PcdLib.h index 319c751c6..20c7765f4 100644 --- a/MdePkg/Include/Library/PcdLib.h +++ b/MdePkg/Include/Library/PcdLib.h @@ -1,12 +1,12 @@ /** @file
Provides library services to get and set Platform Configuration Database entries.
- PCD Library Class provides PCD usage macro interface for all PCD types.
- It should be included at any module who use PCD. If module use dynamic/dynamicex
- PCD, module should be linked to PEIM/DXE library instance to access that PCD.
- If module uses PatchableInModule type PCD, also need library instance produce
- LibPatchPcdSetPtr() interface. For FeatureFlag/Fixed PCD, macro interface is
- translated to an variable or macro which is auto-generated by build tool in
+ PCD Library Class provides a PCD usage macro interface for all PCD types.
+ It should be included in any module that uses PCD. If a module uses dynamic/dynamicex
+ PCD, module should be linked to a PEIM/DXE library instance to access that PCD.
+ If a module uses PatchableInModule type PCD, it also needs the library instance to produce
+ LibPatchPcdSetPtr() interface. For FeatureFlag/Fixed PCD, the macro interface is
+ translated to n variable or macro that is auto-generated by build tool in
module's autogen.h/autogen.c.
The PcdGetXX(), PcdSetXX(), PcdToken(), and PcdGetNextTokenSpace() operations are
only available prior to ExitBootServices(). If access to PCD values are required
@@ -785,7 +785,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @param SkuId The SKU value that will be used when the PCD service retrieves and sets values
associated with a PCD token.
- @return Return the SKU ID that just be set.
+ @return Return the SKU ID that was set.
**/
UINTN
@@ -1072,7 +1072,7 @@ LibPcdGetExSize ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT8
@@ -1092,7 +1092,7 @@ LibPcdSet8 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT16
@@ -1112,7 +1112,7 @@ LibPcdSet16 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT32
@@ -1132,7 +1132,7 @@ LibPcdSet32 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT64
@@ -1162,7 +1162,7 @@ LibPcdSet64 ( @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.
@param[in] Buffer A pointer to the buffer to set.
- @return Return the pointer for the buffer been set.
+ @return Return the pointer for the buffer that was set.
**/
VOID *
@@ -1183,7 +1183,7 @@ LibPcdSetPtr ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The boolean value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
BOOLEAN
@@ -1207,7 +1207,7 @@ LibPcdSetBool ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT8
@@ -1232,7 +1232,7 @@ LibPcdSetEx8 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT16
@@ -1257,7 +1257,7 @@ LibPcdSetEx16 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT32
@@ -1281,7 +1281,7 @@ LibPcdSetEx32 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT64
@@ -1312,7 +1312,7 @@ LibPcdSetEx64 ( @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.
@param[in] Buffer A pointer to the buffer to set.
- @return Return the pinter to the buffer been set.
+ @return Return the pointer to the buffer that was set.
**/
VOID *
@@ -1338,7 +1338,7 @@ LibPcdSetExPtr ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The Boolean value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
BOOLEAN
@@ -1353,9 +1353,9 @@ LibPcdSetExBool ( /**
This notification function serves two purposes.
- Firstly, it notifies the module which did the registration that the value of this
+ Firstly, it notifies the module that did the registration that the value of this
PCD token has been set.
- Secondly, it provides a mechanism for the module which did the registration to intercept
+ Secondly, it provides a mechanism for the module that did the registration to intercept
the set operation and override the value been set if necessary. After the invocation of
the callback function, TokenData will be used by PCD service PEIM or driver to modify th
internal data in PCD database.
@@ -1491,7 +1491,7 @@ LibPcdGetNextTokenSpace ( @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.
@param[in] Buffer A pointer to the buffer to used to set the target variable.
- @return Return the pointer to the buffer been set.
+ @return Return the pointer to the buffer that was set.
**/
VOID *
diff --git a/MdePkg/Include/Library/PciCf8Lib.h b/MdePkg/Include/Library/PciCf8Lib.h index 080889d9e..a94c4ffea 100644 --- a/MdePkg/Include/Library/PciCf8Lib.h +++ b/MdePkg/Include/Library/PciCf8Lib.h @@ -2,7 +2,7 @@ Provides services to access PCI Configuration Space using the I/O ports 0xCF8 and 0xCFC.
This library is identical to the PCI Library, except the access method for performing PCI
- configuration cycles must be though I/O ports 0xCF8 and 0xCFC. This library only allows
+ configuration cycles must be through I/O ports 0xCF8 and 0xCFC. This library only allows
access to PCI Segment #0.
Copyright (c) 2006 - 2009, Intel Corporation<BR>
diff --git a/MdePkg/Include/Library/PciExpressLib.h b/MdePkg/Include/Library/PciExpressLib.h index 1ea49c1aa..dd44472cf 100644 --- a/MdePkg/Include/Library/PciExpressLib.h +++ b/MdePkg/Include/Library/PciExpressLib.h @@ -2,7 +2,7 @@ Provides services to access PCI Configuration Space using the MMIO PCI Express window.
This library is identical to the PCI Library, except the access method for performing PCI
- configuration cycles must be though the 256 MB PCI Express MMIO window whose base address
+ configuration cycles must be through the 256 MB PCI Express MMIO window whose base address
is defined by PcdPciExpressBaseAddress.
Copyright (c) 2006 - 2008, Intel Corporation<BR>
diff --git a/MdePkg/Include/Library/PciLib.h b/MdePkg/Include/Library/PciLib.h index d85acf52e..708571bfd 100644 --- a/MdePkg/Include/Library/PciLib.h +++ b/MdePkg/Include/Library/PciLib.h @@ -167,7 +167,7 @@ PciAnd8 ( /**
Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit
- value, followed a bitwise OR with another 8-bit value.
+ value, followed by a bitwise OR with another 8-bit value.
Reads the 8-bit PCI configuration register specified by Address, performs a
bitwise AND between the read result and the value specified by AndData,
diff --git a/MdePkg/Include/Library/PeCoffLib.h b/MdePkg/Include/Library/PeCoffLib.h index ef4a3a4a2..3c7c41cfa 100644 --- a/MdePkg/Include/Library/PeCoffLib.h +++ b/MdePkg/Include/Library/PeCoffLib.h @@ -2,7 +2,7 @@ Provides services to load and relocate a PE/COFF image.
The PE/COFF Loader Library abstracts the implementation of a PE/COFF loader for
- IA-32, x86, IPF, and EBC processor types. The library functions are memory based
+ IA-32, x86, IPF, and EBC processor types. The library functions are memory-based
and can be ported easily to any environment.
Copyright (c) 2006 - 2008, Intel Corporation
@@ -230,7 +230,7 @@ PeCoffLoaderGetImageInfo ( of ImageContext as the relocation base address. The caller must allocate the relocation
fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.
- The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress,
+ The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress,
ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders,
DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of
the ImageContext structure must be valid prior to invoking this service.
@@ -265,7 +265,7 @@ PeCoffLoaderRelocateImage ( specified by the ImageAddress and ImageSize fields of ImageContext. The caller must allocate
the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.
The EntryPoint, FixupDataSize, CodeView, PdbPointer and HiiResourceData fields of ImageContext are computed.
- The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize,
+ The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize,
DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva
fields of the ImageContext structure must be valid prior to invoking this service.
@@ -302,7 +302,7 @@ PeCoffLoaderLoadImage ( This is the default implementation of a PE_COFF_LOADER_READ_FILE function
that assumes FileHandle pointer to the beginning of a PE/COFF image.
This function reads contents of the PE/COFF image that starts at the system memory
- address specified by FileHandle. The read operation copies ReadSize bytes from the
+ address specified by FileHandle. The read operation copies ReadSize bytes from the
PE/COFF image starting at byte offset FileOffset into the buffer specified by Buffer.
The size of the buffer actually read is returned in ReadSize.
@@ -335,7 +335,7 @@ PeCoffLoaderImageReadFromMemory ( This function reapplies relocation fixups to the PE/COFF image specified by ImageBase
and ImageSize so the image will execute correctly when the PE/COFF image is mapped
- to the address specified by VirtualImageBase. RelocationData must be identical
+ to the address specified by VirtualImageBase. RelocationData must be identical
to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure
after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().
diff --git a/MdePkg/Include/Library/PeiCoreEntryPoint.h b/MdePkg/Include/Library/PeiCoreEntryPoint.h index 1eb974c9d..0e0619b0b 100644 --- a/MdePkg/Include/Library/PeiCoreEntryPoint.h +++ b/MdePkg/Include/Library/PeiCoreEntryPoint.h @@ -86,8 +86,8 @@ EfiMain ( module depends on. This include library instances that a module depends on directly and library
instances that a module depends on indirectly through other libraries.
This function is autogenerated by build tools and those build tools are responsible for collecting
- the set of library instances, determine which ones have constructors, and calling the library
- constructors in the proper order based upon each of the library instances own dependencies.
+ the set of library instances, determining which ones have constructors, and calling the library
+ constructors in the proper order based upon the dependencies of each of the library instances.
The PEI Core must call this function with a NULL FileHandle value as soon as the initial PEI
Services Table has been established.
diff --git a/MdePkg/Include/Library/PostCodeLib.h b/MdePkg/Include/Library/PostCodeLib.h index 86ad1c676..c43001d49 100644 --- a/MdePkg/Include/Library/PostCodeLib.h +++ b/MdePkg/Include/Library/PostCodeLib.h @@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED 0x00000010
/**
- Sends an 32-bit value to a POST card.
+ Sends a 32-bit value to a POST card.
Sends the 32-bit value specified by Value to a POST card, and returns Value.
Some implementations of this library function may perform I/O operations
@@ -28,7 +28,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. display the 32-bit value on the status reporting device.
PostCode() must actively prevent recursion. If PostCode() is called while
- processing another any other Post Code Library function, then
+ processing another Post Code Library function, then
PostCode() must return Value immediately.
@param Value The 32-bit value to write to the POST card.
@@ -44,7 +44,7 @@ PostCode ( /**
- Sends an 32-bit value to a POST and associated ASCII string.
+ Sends a 32-bit value to a POST and associated ASCII string.
Sends the 32-bit value specified by Value to a POST card, and returns Value.
If Description is not NULL, then the ASCII string specified by Description is
@@ -114,7 +114,7 @@ PostCodeDescriptionEnabled ( /**
- Sends an 32-bit value to a POST card.
+ Sends a 32-bit value to a POST card.
If POST codes are enabled in PcdPostCodeProperyMask, then call PostCode()
passing in Value. Value is returned.
@@ -127,7 +127,7 @@ PostCodeDescriptionEnabled ( #define POST_CODE(Value) PostCodeEnabled() ? PostCode(Value) : Value
/**
- Sends an 32-bit value to a POST and associated ASCII string.
+ Sends a 32-bit value to a POST and associated ASCII string.
If POST codes and POST code descriptions are enabled in
PcdPostCodeProperyMask, then call PostCodeWithDescription() passing in
diff --git a/MdePkg/Include/Library/SalLib.h b/MdePkg/Include/Library/SalLib.h index c9f2fb33a..312a87341 100644 --- a/MdePkg/Include/Library/SalLib.h +++ b/MdePkg/Include/Library/SalLib.h @@ -29,7 +29,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. defined as reserved or some fields defined as reserved must be
zero filled or the invalid argument return value may be returned
or undefined result may occur during the execution of the procedure.
- This function is only available on IPF.
+ This function is only available on Intel Itanium-based platforms.
@param Index The SAL procedure Index number
@param Arg2 The 2nd parameter for SAL procedure calls
diff --git a/MdePkg/Include/Library/SerialPortLib.h b/MdePkg/Include/Library/SerialPortLib.h index 6fee28924..60d321229 100644 --- a/MdePkg/Include/Library/SerialPortLib.h +++ b/MdePkg/Include/Library/SerialPortLib.h @@ -69,7 +69,7 @@ SerialPortWrite ( @param Buffer Pointer to the data buffer to store the data read from the serial device.
@param NumberOfBytes Number of bytes which will be read.
- @retval 0 Read data failed, No data is to be read.
+ @retval 0 Read data failed, no data is to be read.
@retval >0 Actual number of bytes read from serial device.
**/
diff --git a/MdePkg/Include/Library/SynchronizationLib.h b/MdePkg/Include/Library/SynchronizationLib.h index bf92ca1d7..63bc72b1a 100644 --- a/MdePkg/Include/Library/SynchronizationLib.h +++ b/MdePkg/Include/Library/SynchronizationLib.h @@ -22,7 +22,7 @@ typedef volatile UINTN SPIN_LOCK; /**
- Retrieves the architecture specific spin lock alignment requirements for
+ Retrieves the architecture-specific spin lock alignment requirements for
optimal spin lock performance.
This function retrieves the spin lock alignment requirements for optimal
@@ -34,7 +34,7 @@ typedef volatile UINTN SPIN_LOCK; consumers of the spin lock synchronization functions to obtain optimal spin
lock performance.
- @return The architecture specific spin lock alignment.
+ @return The architecture-specific spin lock alignment.
**/
UINTN
@@ -140,7 +140,7 @@ ReleaseSpinLock ( /**
- Performs an atomic increment of an 32-bit unsigned integer.
+ Performs an atomic increment of a 32-bit unsigned integer.
Performs an atomic increment of the 32-bit unsigned integer specified by
Value and returns the incremented value. The increment operation must be
@@ -162,7 +162,7 @@ InterlockedIncrement ( /**
- Performs an atomic decrement of an 32-bit unsigned integer.
+ Performs an atomic decrement of a 32-bit unsigned integer.
Performs an atomic decrement of the 32-bit unsigned integer specified by
Value and returns the decremented value. The decrement operation must be
diff --git a/MdePkg/Include/Library/UefiDecompressLib.h b/MdePkg/Include/Library/UefiDecompressLib.h index c0357da97..278883b6f 100644 --- a/MdePkg/Include/Library/UefiDecompressLib.h +++ b/MdePkg/Include/Library/UefiDecompressLib.h @@ -45,7 +45,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @param SourceSize The size, in bytes, of the source buffer.
@param DestinationSize A pointer to the size, in bytes, of the uncompressed buffer
that will be generated when the compressed buffer specified
- by Source and SourceSize is decompressed..
+ by Source and SourceSize is decompressed.
@param ScratchSize A pointer to the size, in bytes, of the scratch buffer that
is required to decompress the compressed buffer specified
by Source and SourceSize.
diff --git a/MdePkg/Include/Library/UefiLib.h b/MdePkg/Include/Library/UefiLib.h index e2d53be6e..56352dbf3 100644 --- a/MdePkg/Include/Library/UefiLib.h +++ b/MdePkg/Include/Library/UefiLib.h @@ -113,8 +113,8 @@ typedef struct { based on a specified GUID.
This function searches the list of configuration tables stored in the EFI System Table
- for a table with a GUID that matches TableGuid. If a match is found, then a pointer to
- the configuration table is returned in Table., and EFI_SUCCESS is returned. If a matching GUID
+ for a table with a GUID that matches TableGuid. If a match is found, then a pointer to
+ the configuration table is returned in Table, and EFI_SUCCESS is returned. If a matching GUID
is not found, then EFI_NOT_FOUND is returned.
If TableGuid is NULL, then ASSERT().
If Table is NULL, then ASSERT().
@@ -948,7 +948,7 @@ EfiInitializeFwVolDevicepathNode ( This library function abstracts validating a device path node.
Check the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure to see if it's valid.
If it is valid, then return the GUID file name from the device path node. Otherwise,
- return NULL. This device path changed in the DXE CIS version 0.92 in a non back ward
+ return NULL. This device path changed in the DXE CIS version 0.92 in a non backward
compatible way to not conflict with the UEFI 2.0 specification. This function abstracts
the differences from the caller.
If FvDevicePathNode is NULL, then ASSERT().
@@ -1077,12 +1077,10 @@ AsciiErrorPrint ( Unicode characters displayed, not including partial characters that may be clipped
by the right edge of the display. If the length of the formatted Unicode string is
greater than PcdUefiLibMaxPrintBufferSize, then at most the first
- PcdUefiLibMaxPrintBufferSize characters are printed.The EFI_HII_FONT_PROTOCOL
- StringToImage() service is used to convert the string to a bitmap using the glyphs
- registered with the HII database. No wrapping is performed, so any portions of the
- string the fall outside the active display region will not be displayed. Please see
- Section 27.2.6 of the UEFI Specification for a description of the supported string
- format including the set of control codes supported by the StringToImage() service.
+ PcdUefiLibMaxPrintBufferSize characters are printed. The EFI_HII_FONT_PROTOCOL
+ is used to convert the string to a bitmap using the glyphs registered with the
+ HII database. No wrapping is performed, so any portions of the string the fall
+ outside the active display region will not be displayed.
If a graphics console device is not associated with the ConsoleOutputHandle
defined in the EFI_SYSTEM_TABLE then no string is printed, and 0 is returned.
@@ -1129,12 +1127,10 @@ PrintXY ( ASCII characters displayed, not including partial characters that may be clipped
by the right edge of the display. If the length of the formatted ASCII string is
greater than PcdUefiLibMaxPrintBufferSize, then at most the first
- PcdUefiLibMaxPrintBufferSize characters are printed.The EFI_HII_FONT_PROTOCOL
- StringToImage() service is used to convert the string to a bitmap using the glyphs
- registered with the HII database. No wrapping is performed, so any portions of the
- string the fall outside the active display region will not be displayed. Please see
- Section 27.2.6 of the UEFI Specification for a description of the supported string
- format including the set of control codes supported by the StringToImage() service.
+ PcdUefiLibMaxPrintBufferSize characters are printed. The EFI_HII_FONT_PROTOCOL
+ is used to convert the string to a bitmap using the glyphs registered with the
+ HII database. No wrapping is performed, so any portions of the string the fall
+ outside the active display region will not be displayed.
If a graphics console device is not associated with the ConsoleOutputHandle
defined in the EFI_SYSTEM_TABLE then no string is printed, and 0 is returned.
@@ -1210,7 +1206,7 @@ EfiLibInstallDriverBinding ( Initializes a driver by installing the Driver Binding Protocol together with the
optional Component Name, optional Driver Configure and optional Driver Diagnostic
Protocols onto the driver's DriverBindingHandle. If DriverBindingHandle is NULL,
- then the protocols are installed onto a newly created handle. DriverBindingHandle
+ then the protocols are installed onto a newly created handle. DriverBindingHandle
is typically the same as the driver's ImageHandle, but it can be different if the
driver produces multiple Driver Binding Protocols.
If DriverBinding is NULL, then ASSERT().
diff --git a/MdePkg/Include/Library/UefiRuntimeLib.h b/MdePkg/Include/Library/UefiRuntimeLib.h index 1ea669451..02be8ea5e 100644 --- a/MdePkg/Include/Library/UefiRuntimeLib.h +++ b/MdePkg/Include/Library/UefiRuntimeLib.h @@ -60,7 +60,7 @@ EfiGoneVirtual ( information returned by GetTime() are the values that were last set via SetTime().
The GetTime() function should take approximately the same amount of time to read the time each
time it is called. All reported device capabilities are to be rounded up.
- During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
+ During runtime, if a PC-AT CMOS device is present in the platform, the caller must synchronize
access to the device before calling GetTime().
@param Time A pointer to storage to receive a snapshot of the current time.
@@ -87,7 +87,7 @@ EfiGetTime ( to loop based on the current time. For example, if the device does not support a hardware reset
for the sub-resolution time, the code is not to implement the feature by waiting for the time to
wrap.
- During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
+ During runtime, if a PC-AT CMOS device is present in the platform, the caller must synchronize
access to the device before calling SetTime().
@param Time A pointer to the current time. Type EFI_TIME is defined in the GetTime()
@@ -169,7 +169,7 @@ EfiSetWakeupTime ( This service is a wrapper for the UEFI Runtime Service GetVariable().
Each vendor may create and manage its own variables without the risk of name conflicts by
- using a unique VendorGuid. When a variable is set its Attributes are supplied to indicate
+ using a unique VendorGuid. When a variable is set, its Attributes are supplied to indicate
how the data variable should be stored and maintained by the system. The attributes affect
when the variable may be accessed and volatility of the data. Any attempts to access a variable
that does not have the attribute set for runtime access will yield the EFI_NOT_FOUND error.
@@ -249,7 +249,7 @@ EfiGetNextVariableName ( Variables are stored by the firmware and may maintain their values across power cycles. Each vendor
may create and manage its own variables without the risk of name conflicts by using a unique VendorGuid.
- @param VariableName the name of the vendor's variable, it's a
+ @param VariableName the name of the vendor's variable, as a
Null-Terminated Unicode String
@param VendorGuid Unify identifier for vendor.
@param Attributes Point to memory location to return the attributes of variable. If the point
@@ -443,7 +443,7 @@ EfiSetVirtualAddressMap ( @param ListHead Head of linked list to convert.
@retval EFI_SUCCESS Success to execute the function.
- @retval !EFI_SUCCESS Failed to e3xecute the function.
+ @retval !EFI_SUCCESS Failed to execute the function.
**/
EFI_STATUS
diff --git a/MdePkg/Include/Library/UefiScsiLib.h b/MdePkg/Include/Library/UefiScsiLib.h index cf2a7f983..965af9e4f 100644 --- a/MdePkg/Include/Library/UefiScsiLib.h +++ b/MdePkg/Include/Library/UefiScsiLib.h @@ -1,5 +1,5 @@ /** @file
- Provides the functions to submit Scsi commands defined in SCSI-2 specification for scsi device.
+ Provides the functions to submit Scsi commands defined in SCSI-2 specification for SCSI devices.
This library class provides the functions to submit SCSI commands defined in SCSI-2 specification
for hard drive, CD and DVD devices that are the most common SCSI boot targets used by UEFI platforms.
diff --git a/MdePkg/Include/Library/UefiUsbLib.h b/MdePkg/Include/Library/UefiUsbLib.h index 87b18fc15..9d1557905 100644 --- a/MdePkg/Include/Library/UefiUsbLib.h +++ b/MdePkg/Include/Library/UefiUsbLib.h @@ -1,6 +1,6 @@ /** @file
- Provides most usb APIs to support the Hid requests defined in Usb Hid 1.1 spec
- and the standard requests defined in Usb 1.1 spec.
+ Provides most USB APIs to support the Hid requests defined in USB Hid 1.1 spec
+ and the standard requests defined in USB 1.1 spec.
Copyright (c) 2006 - 2008, Intel Corporation<BR>
All rights reserved. This program and the accompanying materials
@@ -18,12 +18,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define __USB_DXE_LIB_H__
#include <Protocol/UsbIo.h>
+#include <IndustryStandard/Usb.h>
/**
Get the descriptor of the specified USB HID interface.
- Submit a USB get HID descriptor request for the USB device specified by UsbIo
- and Interface and return the HID descriptor in HidDescriptor.
+ Submit a UsbGetHidDescriptor() request for the USB device specified by UsbIo
+ and Interface, and return the HID descriptor in HidDescriptor.
If UsbIo is NULL, then ASSERT().
If HidDescriptor is NULL, then ASSERT().
@@ -51,7 +52,7 @@ UsbGetHidDescriptor ( Get the report descriptor of the specified USB HID interface.
Submit a USB get HID report descriptor request for the USB device specified by
- UsbIo and Interface and return the report descriptor in DescriptorBuffer.
+ UsbIo and Interface, and return the report descriptor in DescriptorBuffer.
If UsbIo is NULL, then ASSERT().
If DescriptorBuffer is NULL, then ASSERT().
@@ -81,7 +82,7 @@ UsbGetReportDescriptor ( Get the HID protocol of the specified USB HID interface.
Submit a USB get HID protocol request for the USB device specified by UsbIo
- and Interface and return the protocol retrieved in Protocol.
+ and Interface, and return the protocol retrieved in Protocol.
If UsbIo is NULL, then ASSERT().
If Protocol is NULL, then ASSERT().
@@ -106,7 +107,7 @@ UsbGetProtocolRequest ( Set the HID protocol of the specified USB HID interface.
Submit a USB set HID protocol request for the USB device specified by UsbIo
- and Interface and set the protocol to the value specified by Protocol.
+ and Interface, and set the protocol to the value specified by Protocol.
If UsbIo is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@@ -501,7 +502,7 @@ UsbClearFeature ( Get the status of the specified device.
Submit a USB device get status request for the USB device specified by UsbIo,
- Recipient, and Target and place the result in the buffer specified by DeviceStatus.
+ Recipient, and Target, and place the result in the buffer specified by DeviceStatus.
The status of the transfer is returned in Status.
If UsbIo is NULL, then ASSERT().
If DeviceStatus is NULL, then ASSERT().
|