diff options
Diffstat (limited to 'IntelFrameworkPkg/Include/Framework')
4 files changed, 19 insertions, 19 deletions
diff --git a/IntelFrameworkPkg/Include/Framework/FirmwareVolumeHeader.h b/IntelFrameworkPkg/Include/Framework/FirmwareVolumeHeader.h index d5d432efaa..7a41d48522 100644 --- a/IntelFrameworkPkg/Include/Framework/FirmwareVolumeHeader.h +++ b/IntelFrameworkPkg/Include/Framework/FirmwareVolumeHeader.h @@ -1,6 +1,6 @@ /** @file Defines data structure that is the volume header found at the beginning of - all firmware volumes that are either memory mapped, or have an + all firmware volumes that are either memory mapped or have an associated FirmwareVolumeBlock protocol. Copyright (c) 2006-2009, Intel Corporation diff --git a/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h b/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h index a00b7cf1d8..925defebf3 100644 --- a/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h +++ b/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h @@ -95,7 +95,7 @@ typedef UINT16 STRING_REF; ///
/// Used to flag dynamically created op-codes. This is meaningful to the IFR Library set
/// and the browser since we need to distinguish between compiled NV map data and created data.
-/// We do not allow new entries to be created in the NV map dynamically however we still need
+/// We do not allow new entries to be created in the NV map dynamically, but we do need
/// to display this information correctly. To dynamically create op-codes and assume that their
/// data will be saved, ensure that the NV starting location they refer to is pre-defined in the
/// NV map.
@@ -222,7 +222,7 @@ typedef struct { //
// There is an interesting twist with regards to Time and Date. This is one of the few items which can accept input
-// from a user, however may or may not need to use storage in the NVRAM space. The decided method for determining
+// from a user, and may or may not need to use storage in the NVRAM space. The decided method for determining
// if NVRAM space will be used (only for a TimeOp or DateOp) is: If .QuestionId == 0 && .Width == 0 (normally an
// impossibility) then use system resources to store the data away and not NV resources. In other words, the setup
// engine will call gRT->SetTime, and gRT->SetDate for the saving of data, and the values displayed will be from the
diff --git a/IntelFrameworkPkg/Include/Framework/PeiCis.h b/IntelFrameworkPkg/Include/Framework/PeiCis.h index db0b185a1f..042ec269fe 100644 --- a/IntelFrameworkPkg/Include/Framework/PeiCis.h +++ b/IntelFrameworkPkg/Include/Framework/PeiCis.h @@ -52,7 +52,7 @@ EFI_STATUS );
/**
- The purpose of the service is to abstract the capability of the PEI
+ This service abstracts the capability of the PEI
Foundation to discover instances of firmware volumes in the system.
Given the input file pointer, this service searches for the next
matching file in the Firmware File System (FFS) volume.
@@ -75,16 +75,16 @@ EFI_STATUS );
/**
- The purpose of the service is to abstract the capability of the PEI
+ This service abstracts the capability of the PEI
Foundation to discover instances of firmware files in the system.
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
+ @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
+ @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.
diff --git a/IntelFrameworkPkg/Include/Framework/SmmCis.h b/IntelFrameworkPkg/Include/Framework/SmmCis.h index b580dbe639..708e4b1c59 100644 --- a/IntelFrameworkPkg/Include/Framework/SmmCis.h +++ b/IntelFrameworkPkg/Include/Framework/SmmCis.h @@ -51,8 +51,8 @@ typedef enum { @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.
+ @param Buffer For read operations, the destination buffer to store the results (out parameter).
+ For write operations, the source buffer from which to write data (in parameter).
@retval EFI_SUCCESS The data was read from or written to the device.
@retval EFI_UNSUPPORTED The Address is not valid for this system.
@@ -94,7 +94,7 @@ 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 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.
@@ -123,8 +123,8 @@ EFI_STATUS @retval EFI_INVALID_PARAMETER Buffer was invalid.
@retval EFI_UNSUPPORTED In runtime.
@note: Inconsistent with specification here:
- In Framework Spec, This definition is naming EFI_SMM_FREE_POOL However,
- To avoid the naming conflict, the definition is renamed.
+ In the Framework Spec, this definition is named EFI_SMM_FREE_POOL.
+ To avoid a naming conflict, the definition here is renamed.
**/
typedef
EFI_STATUS
@@ -148,8 +148,8 @@ EFI_STATUS @retval EFI_INVALID_PARAMETER Type is not AllocateAnyPages or AllocateMaxAddress
or AllocateAddress. Or MemoryType is in the range EfiMaxMemoryType..0x7FFFFFFF.
@note: Inconsistent with specification here:
- In Framework Spec, This definition is naming EFI_SMM_ALLOCATE_PAGES However,
- To avoid the naming conflict, the definition is renamed.
+ In the Framework Spec, this definition is named EFI_SMM_ALLOCATE_PAGES.
+ To avoid a naming conflict, the definition here is renamed.
**/
typedef
EFI_STATUS
@@ -171,8 +171,8 @@ EFI_STATUS @retval EFI_NOT_FOUND The requested memory pages were not allocated with SmmAllocatePages().
@note: Inconsistent with specification here:
- In Framework Spec, This definition is naming EFI_SMM_FREE_PAGES However,
- To avoid the naming conflict, the definition is renamed.
+ In the Framework Spec, this definition is named EFI_SMM_FREE_PAGES.
+ To avoid a naming conflict, the definition here is renamed.
**/
typedef
EFI_STATUS
@@ -197,8 +197,8 @@ EFI_STATUS @retval EFI_INVALID_PARAMETER The CPU cannot support an additional service invocation.
@note: Inconsistent with specification here:
- In Framework Spec, No this definition. This method is introduced in PI1.0 spec for
- implementation needed.
+ In Framework Spec, this definition does not exist. This method is introduced in PI1.0 spec for
+ implementation needs.
**/
typedef
@@ -592,7 +592,7 @@ struct _EFI_SMM_SYSTEM_TABLE { //
///Inconsistent with specification here:
- /// In Framework Spec, No this definition. This method is introduced in PI1.0 spec for
+ /// In Framework Spec, this definition does not exist. This method is introduced in PI1.0 spec for
/// implementation needed.
EFI_SMM_STARTUP_THIS_AP SmmStartupThisAp;
|