sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

UefiCpuPkg/MtrrLib: Fix some typo and clean up code format

Browse Source 
Fixed some typo. Removed some trailing spaces and TAB key. Clean up code format.

Cc: Feng Tian <feng.tian@intel.com>
Cc: Michael Kinney <michael.d.kinney@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Michael Kinney <michael.d.kinney@intel.com>
Signed-off-by: Jeff Fan <jeff.fan@intel.com>
Reviewed-by: Feng Tian <feng.tian@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@19152 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
Michael Kinney
2015-12-08 05:20:44 +00:00
committed by vanjeff
parent 46309b1101
commit 76b4cae357
2 changed files with 121 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
UefiCpuPkg/Include/Library/MtrrLib.h
View File

@@ -156,20 +156,27 @@ GetFirmwareVariableMtrrCount (
/** /**
This function attempts to set the attributes for a memory range. This function attempts to set the attributes for a memory range.
@param BaseAddress The physical address that is the start address of a memory region. @param[in] BaseAddress The physical address that is the start
@param Length The size in bytes of the memory region. address of a memory region.
@param Attributes The bit mask of attributes to set for the memory region. @param[in] Length The size in bytes of the memory region.
@param[in] Attribute The bit mask of attributes to set for the
memory region.
@retval RETURN_SUCCESS The attributes were set for the memory region. @retval RETURN_SUCCESS The attributes were set for the memory
region.
@retval RETURN_INVALID_PARAMETER Length is zero. @retval RETURN_INVALID_PARAMETER Length is zero.
@retval RETURN_UNSUPPORTED The processor does not support one or more bytes of the @retval RETURN_UNSUPPORTED The processor does not support one or
memory resource range specified by BaseAddress and Length. more bytes of the memory resource range
@retval RETURN_UNSUPPORTED The bit mask of attributes is not support for the memory resource specified by BaseAddress and Length.
range specified by BaseAddress and Length. @retval RETURN_UNSUPPORTED The bit mask of attributes is not support
@retval RETURN_ACCESS_DENIED The attributes for the memory resource range specified by for the memory resource range specified
BaseAddress and Length cannot be modified. by BaseAddress and Length.
@retval RETURN_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of @retval RETURN_ACCESS_DENIED The attributes for the memory resource
the memory resource range. range specified by BaseAddress and Length
cannot be modified.
@retval RETURN_OUT_OF_RESOURCES There are not enough system resources to
modify the attributes of the memory
resource range.
**/ **/
RETURN_STATUS RETURN_STATUS
@@ -185,7 +192,7 @@ MtrrSetMemoryAttribute (
This function will get the memory cache type of the specific address. This function will get the memory cache type of the specific address.
This function is mainly for debugging purposes. This function is mainly for debugging purposes.
@param Address The specific address @param[in] Address The specific address
@return The memory cache type of the specific address @return The memory cache type of the specific address
@@ -200,7 +207,7 @@ MtrrGetMemoryAttribute (
/** /**
This function will get the raw value in variable MTRRs This function will get the raw value in variable MTRRs
@param VariableSettings A buffer to hold variable MTRRs content. @param[out] VariableSettings A buffer to hold variable MTRRs content.
@return The buffer point to MTRR_VARIABLE_SETTINGS in which holds the content of the variable mtrr @return The buffer point to MTRR_VARIABLE_SETTINGS in which holds the content of the variable mtrr
@@ -215,7 +222,7 @@ MtrrGetVariableMtrr (
/** /**
This function sets fixed MTRRs This function sets fixed MTRRs
@param VariableSettings A buffer to hold variable MTRRs content. @param[in] VariableSettings A buffer to hold variable MTRRs content.
@return The pointer of VariableSettings @return The pointer of VariableSettings
@@ -230,7 +237,7 @@ MtrrSetVariableMtrr (
/** /**
This function gets the content in fixed MTRRs This function gets the content in fixed MTRRs
@param FixedSettings A buffer to hold fixed MTRRs content. @param[out] FixedSettings A buffer to hold fixed MTRRs content.
@return The pointer of FixedSettings @return The pointer of FixedSettings
@@ -245,7 +252,7 @@ MtrrGetFixedMtrr (
/** /**
This function sets fixed MTRRs This function sets fixed MTRRs
@param FixedSettings A buffer holding fixed MTRRs content. @param[in] FixedSettings A buffer holding fixed MTRRs content.
@return The pointer of FixedSettings @return The pointer of FixedSettings
@@ -260,7 +267,7 @@ MtrrSetFixedMtrr (
/** /**
This function gets the content in all MTRRs (variable and fixed) This function gets the content in all MTRRs (variable and fixed)
@param MtrrSetting A buffer to hold all MTRRs content. @param[out] MtrrSetting A buffer to hold all MTRRs content.
@return The pointer of MtrrSetting @return The pointer of MtrrSetting
@@ -275,7 +282,7 @@ MtrrGetAllMtrrs (
/** /**
This function sets all MTRRs (variable and fixed) This function sets all MTRRs (variable and fixed)
@param MtrrSetting A buffer to hold all MTRRs content. @param[in] MtrrSetting A buffer to hold all MTRRs content.
@return The pointer of MtrrSetting @return The pointer of MtrrSetting
@@ -293,11 +300,12 @@ MtrrSetAllMtrrs (
This function shadows the content of variable MTRRs into This function shadows the content of variable MTRRs into
an internal array: VariableMtrr an internal array: VariableMtrr
@param MtrrValidBitsMask The mask for the valid bit of the MTRR @param[in] MtrrValidBitsMask The mask for the valid bit of the MTRR
@param MtrrValidAddressMask The valid address mask for MTRR since the base address in @param[in] MtrrValidAddressMask The valid address mask for MTRR since the base address in
MTRR must align to 4K, so valid address mask equal to MTRR must align to 4K, so valid address mask equal to
MtrrValidBitsMask & 0xfffffffffffff000ULL MtrrValidBitsMask & 0xfffffffffffff000ULL
@param VariableMtrr The array to shadow variable MTRRs content @param[out] VariableMtrr The array to shadow variable MTRRs content
@return The ruturn value of this paramter indicates the number of @return The ruturn value of this paramter indicates the number of
MTRRs which has been used. MTRRs which has been used.
**/ **/

134
UefiCpuPkg/Library/MtrrLib/MtrrLib.c
View File

@@ -86,7 +86,7 @@ CONST FIXED_MTRR mMtrrLibFixedMtrrTable[] = {
MTRR_LIB_IA32_MTRR_FIX4K_F8000, MTRR_LIB_IA32_MTRR_FIX4K_F8000,
0xF8000, 0xF8000,
SIZE_4KB SIZE_4KB
}, }
}; };
// //
@@ -206,7 +206,7 @@ PreMtrrChange (
CpuFlushTlb (); CpuFlushTlb ();
// //
// Disable Mtrrs // Disable MTRRs
// //
AsmMsrBitFieldWrite64 (MTRR_LIB_IA32_MTRR_DEF_TYPE, 10, 11, 0); AsmMsrBitFieldWrite64 (MTRR_LIB_IA32_MTRR_DEF_TYPE, 10, 11, 0);
} }
@@ -272,9 +272,9 @@ PostMtrrChange (
/** /**
Programs fixed MTRRs registers. Programs fixed MTRRs registers.
@param MemoryCacheType The memory type to set. @param[in] MemoryCacheType The memory type to set.
@param Base The base address of memory range. @param[in, out] Base The base address of memory range.
@param Length The length of memory range. @param[in, out] Length The length of memory range.
@retval RETURN_SUCCESS The cache type was updated successfully @retval RETURN_SUCCESS The cache type was updated successfully
@retval RETURN_UNSUPPORTED The requested range or cache type was invalid @retval RETURN_UNSUPPORTED The requested range or cache type was invalid
@@ -356,14 +356,14 @@ ProgramFixedMtrr (
/** /**
Get the attribute of variable MTRRs. Gets the attribute of variable MTRRs.
This function shadows the content of variable MTRRs into an This function shadows the content of variable MTRRs into an
internal array: VariableMtrr. internal array: VariableMtrr.
@param MtrrValidBitsMask The mask for the valid bit of the MTRR @param[in] MtrrValidBitsMask The mask for the valid bit of the MTRR
@param MtrrValidAddressMask The valid address mask for MTRR @param[in] MtrrValidAddressMask The valid address mask for MTRR
@param VariableMtrr The array to shadow variable MTRRs content @param[out] VariableMtrr The array to shadow variable MTRRs content
@return The return value of this paramter indicates the @return The return value of this paramter indicates the
number of MTRRs which has been used. number of MTRRs which has been used.
@@ -423,9 +423,9 @@ MtrrGetMemoryAttributeInVariableMtrr (
/** /**
Checks overlap between given memory range and MTRRs. Checks overlap between given memory range and MTRRs.
@param Start The start address of memory range. @param[in] Start The start address of memory range.
@param End The end address of memory range. @param[in] End The end address of memory range.
@param VariableMtrr The array to shadow variable MTRRs content @param[in] VariableMtrr The array to shadow variable MTRRs content
@retval TRUE Overlap exists. @retval TRUE Overlap exists.
@retval FALSE No overlap. @retval FALSE No overlap.
@@ -461,9 +461,9 @@ CheckMemoryAttributeOverlap (
/** /**
Marks a variable MTRR as non-valid. Marks a variable MTRR as non-valid.
@param Index The index of the array VariableMtrr to be invalidated @param[in] Index The index of the array VariableMtrr to be invalidated
@param VariableMtrr The array to shadow variable MTRRs content @param[in] VariableMtrr The array to shadow variable MTRRs content
@param UsedMtrr The number of MTRRs which has already been used @param[out] UsedMtrr The number of MTRRs which has already been used
**/ **/
VOID VOID
@@ -479,16 +479,16 @@ InvalidateShadowMtrr (
/** /**
Combine memory attributes. Combines memory attributes.
If overlap exists between given memory range and MTRRs, try to combine them. If overlap exists between given memory range and MTRRs, try to combine them.
@param Attributes The memory type to set. @param[in] Attributes The memory type to set.
@param Base The base address of memory range. @param[in, out] Base The base address of memory range.
@param Length The length of memory range. @param[in, out] Length The length of memory range.
@param VariableMtrr The array to shadow variable MTRRs content @param[in] VariableMtrr The array to shadow variable MTRRs content
@param UsedMtrr The number of MTRRs which has already been used @param[in, out] UsedMtrr The number of MTRRs which has already been used
@param OverwriteExistingMtrr Returns whether an existing MTRR was used @param[out] OverwriteExistingMtrr Returns whether an existing MTRR was used
@retval EFI_SUCCESS Memory region successfully combined. @retval EFI_SUCCESS Memory region successfully combined.
@retval EFI_ACCESS_DENIED Memory region cannot be combined. @retval EFI_ACCESS_DENIED Memory region cannot be combined.
@@ -536,7 +536,7 @@ CombineMemoryAttribute (
// //
if (Attributes == VariableMtrr[Index].Type) { if (Attributes == VariableMtrr[Index].Type) {
// //
// if the Mtrr range contain the request range, set a flag, then continue to // if the MTRR range contain the request range, set a flag, then continue to
// invalidate any MTRR of the same request range with higher priority cache type. // invalidate any MTRR of the same request range with higher priority cache type.
// //
if (VariableMtrr[Index].BaseAddress <= *Base && MtrrEnd >= EndAddress) { if (VariableMtrr[Index].BaseAddress <= *Base && MtrrEnd >= EndAddress) {
@@ -597,9 +597,10 @@ CombineMemoryAttribute (
/** /**
Calculate the maximum value which is a power of 2, but less the MemoryLength. Calculates the maximum value which is a power of 2, but less the MemoryLength.
@param[in] MemoryLength The number to pass in.
@param MemoryLength The number to pass in.
@return The maximum value which is align to power of 2 and less the MemoryLength @return The maximum value which is align to power of 2 and less the MemoryLength
**/ **/
@@ -626,21 +627,22 @@ Power2MaxMemory (
/** /**
Determine the MTRR numbers used to program a memory range. Determines the MTRR numbers used to program a memory range.
This function first checks the alignment of the base address. If the alignment of the base address <= Length, This function first checks the alignment of the base address.
cover the memory range (BaseAddress, alignment) by a MTRR, then BaseAddress += alignment and Length -= alignment. If the alignment of the base address <= Length, cover the memory range
Repeat the step until alignment > Length. (BaseAddress, alignment) by a MTRR, then BaseAddress += alignment and
Length -= alignment. Repeat the step until alignment > Length.
Then this function determines which direction of programming the variable MTRRs for the remaining length Then this function determines which direction of programming the variable
will use fewer MTRRs. MTRRs for the remaining length will use fewer MTRRs.
@param BaseAddress Length of Memory to program MTRR @param[in] BaseAddress Length of Memory to program MTRR
@param Length Length of Memory to program MTRR @param[in] Length Length of Memory to program MTRR
@param MtrrNumber Pointer to the number of necessary MTRRs @param[in] MtrrNumber Pointer to the number of necessary MTRRs
@retval TRUE Positive direction is better. @retval TRUE Positive direction is better.
FALSE Negtive direction is better. FALSE Negative direction is better.
**/ **/
BOOLEAN BOOLEAN
@@ -709,12 +711,12 @@ GetMtrrNumberAndDirection (
This function programs MTRRs according to the values specified This function programs MTRRs according to the values specified
in the shadow array. in the shadow array.
@param VariableMtrr The array to shadow variable MTRRs content @param[in, out] VariableMtrr Shadow of variable MTRR contents
**/ **/
VOID VOID
InvalidateMtrr ( InvalidateMtrr (
IN VARIABLE_MTRR *VariableMtrr IN OUT VARIABLE_MTRR *VariableMtrr
) )
{ {
UINTN Index; UINTN Index;
@@ -741,11 +743,11 @@ InvalidateMtrr (
This function programs variable MTRRs This function programs variable MTRRs
@param MtrrNumber Index of MTRR to program. @param[in] MtrrNumber Index of MTRR to program.
@param BaseAddress Base address of memory region. @param[in] BaseAddress Base address of memory region.
@param Length Length of memory region. @param[in] Length Length of memory region.
@param MemoryCacheType Memory type to set. @param[in] MemoryCacheType Memory type to set.
@param MtrrValidAddressMask The valid address mask for MTRR @param[in] MtrrValidAddressMask The valid address mask for MTRR
**/ **/
VOID VOID
@@ -782,9 +784,9 @@ ProgramVariableMtrr (
/** /**
Convert the Memory attibute value to MTRR_MEMORY_CACHE_TYPE. Converts the Memory attribute value to MTRR_MEMORY_CACHE_TYPE.
@param MtrrType MTRR memory type @param[in] MtrrType MTRR memory type
@return The enum item in MTRR_MEMORY_CACHE_TYPE @return The enum item in MTRR_MEMORY_CACHE_TYPE
@@ -808,7 +810,7 @@ GetMemoryCacheTypeFromMtrrType (
default: default:
// //
// MtrrType is MTRR_CACHE_INVALID_TYPE, that means // MtrrType is MTRR_CACHE_INVALID_TYPE, that means
// no mtrr covers the range // no MTRR covers the range
// //
return MtrrGetDefaultMemoryType (); return MtrrGetDefaultMemoryType ();
} }
@@ -819,8 +821,8 @@ GetMemoryCacheTypeFromMtrrType (
This function initializes the valid bits mask and valid address mask for MTRRs. This function initializes the valid bits mask and valid address mask for MTRRs.
@param MtrrValidBitsMask The mask for the valid bit of the MTRR @param[out] MtrrValidBitsMask The mask for the valid bit of the MTRR
@param MtrrValidAddressMask The valid address mask for the MTRR @param[out] MtrrValidAddressMask The valid address mask for the MTRR
**/ **/
VOID VOID
@@ -849,21 +851,21 @@ MtrrLibInitializeMtrrMask (
/** /**
Determing the real attribute of a memory range. Determines the real attribute of a memory range.
This function is to arbitrate the real attribute of the memory when This function is to arbitrate the real attribute of the memory when
there are 2 MTRR covers the same memory range. For further details, there are 2 MTRRs covers the same memory range. For further details,
please refer the IA32 Software Developer's Manual, Volume 3, please refer the IA32 Software Developer's Manual, Volume 3,
Section 10.11.4.1. Section 10.11.4.1.
@param MtrrType1 the first kind of Memory type @param[in] MtrrType1 The first kind of Memory type
@param MtrrType2 the second kind of memory type @param[in] MtrrType2 The second kind of memory type
**/ **/
UINT64 UINT64
MtrrPrecedence ( MtrrPrecedence (
UINT64 MtrrType1, IN UINT64 MtrrType1,
UINT64 MtrrType2 IN UINT64 MtrrType2
) )
{ {
UINT64 MtrrType; UINT64 MtrrType;
@@ -923,10 +925,10 @@ MtrrPrecedence (
/** /**
This function attempts to set the attributes for a memory range. This function attempts to set the attributes for a memory range.
@param BaseAddress The physical address that is the start @param[in] BaseAddress The physical address that is the start
address of a memory region. address of a memory region.
@param Length The size in bytes of the memory region. @param[in] Length The size in bytes of the memory region.
@param Attributes The bit mask of attributes to set for the @param[in] Attribute The bit mask of attributes to set for the
memory region. memory region.
@retval RETURN_SUCCESS The attributes were set for the memory @retval RETURN_SUCCESS The attributes were set for the memory
@@ -1198,9 +1200,9 @@ Done:
This function is mainly for debug purpose. This function is mainly for debug purpose.
@param Address The specific address @param[in] Address The specific address
@return Memory cache type of the sepcific address @return Memory cache type of the specific address
**/ **/
MTRR_MEMORY_CACHE_TYPE MTRR_MEMORY_CACHE_TYPE
@@ -1290,7 +1292,7 @@ MtrrGetMemoryAttribute (
/** /**
This function will get the raw value in variable MTRRs This function will get the raw value in variable MTRRs
@param VariableSettings A buffer to hold variable MTRRs content. @param[out] FixedSettings A buffer to hold fixed MTRRs content.
@return The VariableSettings input pointer @return The VariableSettings input pointer
@@ -1325,7 +1327,7 @@ MtrrGetVariableMtrr (
/** /**
Worker function setting variable MTRRs Worker function setting variable MTRRs
@param VariableSettings A buffer to hold variable MTRRs content. @param[in] VariableSettings A buffer to hold variable MTRRs content.
**/ **/
VOID VOID
@@ -1355,7 +1357,7 @@ MtrrSetVariableMtrrWorker (
/** /**
This function sets variable MTRRs This function sets variable MTRRs
@param VariableSettings A buffer to hold variable MTRRs content. @param[in] VariableSettings A buffer to hold variable MTRRs content.
@return The pointer of VariableSettings @return The pointer of VariableSettings
@@ -1382,7 +1384,7 @@ MtrrSetVariableMtrr (
/** /**
This function gets the content in fixed MTRRs This function gets the content in fixed MTRRs
@param FixedSettings A buffer to hold fixed Mtrrs content. @param[out] FixedSettings A buffer to hold fixed Mtrrs content.
@retval The pointer of FixedSettings @retval The pointer of FixedSettings
@@ -1410,7 +1412,7 @@ MtrrGetFixedMtrr (
/** /**
Worker function setting fixed MTRRs Worker function setting fixed MTRRs
@param FixedSettings A buffer to hold fixed Mtrrs content. @param[in] FixedSettings A buffer to hold fixed Mtrrs content.
**/ **/
VOID VOID
@@ -1432,7 +1434,7 @@ MtrrSetFixedMtrrWorker (
/** /**
This function sets fixed MTRRs This function sets fixed MTRRs
@param FixedSettings A buffer to hold fixed Mtrrs content. @param[in] FixedSettings A buffer to hold fixed Mtrrs content.
@retval The pointer of FixedSettings @retval The pointer of FixedSettings
@@ -1460,7 +1462,7 @@ MtrrSetFixedMtrr (
/** /**
This function gets the content in all MTRRs (variable and fixed) This function gets the content in all MTRRs (variable and fixed)
@param MtrrSetting A buffer to hold all Mtrrs content. @param[out] MtrrSetting A buffer to hold all Mtrrs content.
@retval the pointer of MtrrSetting @retval the pointer of MtrrSetting
@@ -1497,7 +1499,7 @@ MtrrGetAllMtrrs (
/** /**
This function sets all MTRRs (variable and fixed) This function sets all MTRRs (variable and fixed)
@param MtrrSetting A buffer holding all MTRRs content. @param[in] MtrrSetting A buffer holding all MTRRs content.
@retval The pointer of MtrrSetting @retval The pointer of MtrrSetting