X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=UefiCpuPkg%2FLibrary%2FMtrrLib%2FMtrrLib.c;h=9d1927262a4edee650bd18621fac69cba7f73738;hp=fca9258ed7aef8142f484813969c8fd433a9f841;hb=c9b449213337172d629197a75390a151eba65eb6;hpb=a48caeebbab99e22bfd4072829ecaf553cc92c9c diff --git a/UefiCpuPkg/Library/MtrrLib/MtrrLib.c b/UefiCpuPkg/Library/MtrrLib/MtrrLib.c index fca9258ed7..9d1927262a 100644 --- a/UefiCpuPkg/Library/MtrrLib/MtrrLib.c +++ b/UefiCpuPkg/Library/MtrrLib/MtrrLib.c @@ -1,7 +1,11 @@ /** @file MTRR setting library - Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.
+ @par Note: + Most of services in this library instance are suggested to be invoked by BSP only, + except for MtrrSetAllMtrrs() which is used to sync BSP's MTRR setting to APs. + + Copyright (c) 2008 - 2017, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -14,73 +18,126 @@ #include +#include +#include + #include #include #include #include #include +#define OR_SEED 0x0101010101010101ull +#define CLEAR_SEED 0xFFFFFFFFFFFFFFFFull + +#define MTRR_LIB_ASSERT_ALIGNED(B, L) ASSERT ((B & ~(L - 1)) == B); +// +// Context to save and restore when MTRRs are programmed +// +typedef struct { + UINTN Cr4; + BOOLEAN InterruptState; +} MTRR_CONTEXT; + +typedef struct { + UINT64 BaseAddress; + UINT64 Length; + MTRR_MEMORY_CACHE_TYPE Type; +} MEMORY_RANGE; + // // This table defines the offset, base and length of the fixed MTRRs // -FIXED_MTRR MtrrLibFixedMtrrTable[] = { +CONST FIXED_MTRR mMtrrLibFixedMtrrTable[] = { { - MTRR_LIB_IA32_MTRR_FIX64K_00000, + MSR_IA32_MTRR_FIX64K_00000, 0, SIZE_64KB }, { - MTRR_LIB_IA32_MTRR_FIX16K_80000, + MSR_IA32_MTRR_FIX16K_80000, 0x80000, SIZE_16KB }, { - MTRR_LIB_IA32_MTRR_FIX16K_A0000, + MSR_IA32_MTRR_FIX16K_A0000, 0xA0000, SIZE_16KB }, { - MTRR_LIB_IA32_MTRR_FIX4K_C0000, + MSR_IA32_MTRR_FIX4K_C0000, 0xC0000, SIZE_4KB }, { - MTRR_LIB_IA32_MTRR_FIX4K_C8000, + MSR_IA32_MTRR_FIX4K_C8000, 0xC8000, SIZE_4KB }, { - MTRR_LIB_IA32_MTRR_FIX4K_D0000, + MSR_IA32_MTRR_FIX4K_D0000, 0xD0000, SIZE_4KB }, { - MTRR_LIB_IA32_MTRR_FIX4K_D8000, + MSR_IA32_MTRR_FIX4K_D8000, 0xD8000, SIZE_4KB }, { - MTRR_LIB_IA32_MTRR_FIX4K_E0000, + MSR_IA32_MTRR_FIX4K_E0000, 0xE0000, SIZE_4KB }, { - MTRR_LIB_IA32_MTRR_FIX4K_E8000, + MSR_IA32_MTRR_FIX4K_E8000, 0xE8000, SIZE_4KB }, { - MTRR_LIB_IA32_MTRR_FIX4K_F0000, + MSR_IA32_MTRR_FIX4K_F0000, 0xF0000, SIZE_4KB }, { - MTRR_LIB_IA32_MTRR_FIX4K_F8000, + MSR_IA32_MTRR_FIX4K_F8000, 0xF8000, SIZE_4KB - }, + } +}; + +// +// Lookup table used to print MTRRs +// +GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 *mMtrrMemoryCacheTypeShortName[] = { + "UC", // CacheUncacheable + "WC", // CacheWriteCombining + "R*", // Invalid + "R*", // Invalid + "WT", // CacheWriteThrough + "WP", // CacheWriteProtected + "WB", // CacheWriteBack + "R*" // Invalid }; +/** + Worker function returns the variable MTRR count for the CPU. + + @return Variable MTRR count + +**/ +UINT32 +GetVariableMtrrCountWorker ( + VOID + ) +{ + MSR_IA32_MTRRCAP_REGISTER MtrrCap; + + MtrrCap.Uint64 = AsmReadMsr64 (MSR_IA32_MTRRCAP); + ASSERT (MtrrCap.Bits.VCNT <= MTRR_NUMBER_OF_VARIABLE_MTRR); + return MtrrCap.Bits.VCNT; +} + /** Returns the variable MTRR count for the CPU. @@ -93,16 +150,33 @@ GetVariableMtrrCount ( VOID ) { - UINT32 VariableMtrrCount; - if (!IsMtrrSupported ()) { return 0; } + return GetVariableMtrrCountWorker (); +} - VariableMtrrCount = (UINT32)(AsmReadMsr64 (MTRR_LIB_IA32_MTRR_CAP) & MTRR_LIB_IA32_MTRR_CAP_VCNT_MASK); - ASSERT (VariableMtrrCount <= MTRR_NUMBER_OF_VARIABLE_MTRR); +/** + Worker function returns the firmware usable variable MTRR count for the CPU. + + @return Firmware usable variable MTRR count - return VariableMtrrCount; +**/ +UINT32 +GetFirmwareVariableMtrrCountWorker ( + VOID + ) +{ + UINT32 VariableMtrrCount; + UINT32 ReservedMtrrNumber; + + VariableMtrrCount = GetVariableMtrrCountWorker (); + ReservedMtrrNumber = PcdGet32 (PcdCpuNumberOfReservedVariableMtrrs); + if (VariableMtrrCount < ReservedMtrrNumber) { + return 0; + } + + return VariableMtrrCount - ReservedMtrrNumber; } /** @@ -117,46 +191,78 @@ GetFirmwareVariableMtrrCount ( VOID ) { - UINT32 VariableMtrrCount; - - VariableMtrrCount = GetVariableMtrrCount (); - if (VariableMtrrCount < RESERVED_FIRMWARE_VARIABLE_MTRR_NUMBER) { + if (!IsMtrrSupported ()) { return 0; } + return GetFirmwareVariableMtrrCountWorker (); +} + +/** + Worker function returns the default MTRR cache type for the system. + + If MtrrSetting is not NULL, returns the default MTRR cache type from input + MTRR settings buffer. + If MtrrSetting is NULL, returns the default MTRR cache type from MSR. + + @param[in] MtrrSetting A buffer holding all MTRRs content. + + @return The default MTRR cache type. + +**/ +MTRR_MEMORY_CACHE_TYPE +MtrrGetDefaultMemoryTypeWorker ( + IN MTRR_SETTINGS *MtrrSetting + ) +{ + MSR_IA32_MTRR_DEF_TYPE_REGISTER DefType; + + if (MtrrSetting == NULL) { + DefType.Uint64 = AsmReadMsr64 (MSR_IA32_MTRR_DEF_TYPE); + } else { + DefType.Uint64 = MtrrSetting->MtrrDefType; + } - return VariableMtrrCount - RESERVED_FIRMWARE_VARIABLE_MTRR_NUMBER; + return (MTRR_MEMORY_CACHE_TYPE) DefType.Bits.Type; } + /** Returns the default MTRR cache type for the system. - @return MTRR default type + @return The default MTRR cache type. **/ -UINT64 -GetMtrrDefaultMemoryType ( +MTRR_MEMORY_CACHE_TYPE +EFIAPI +MtrrGetDefaultMemoryType ( VOID -) + ) { - return (AsmReadMsr64 (MTRR_LIB_IA32_MTRR_DEF_TYPE) & 0xff); + if (!IsMtrrSupported ()) { + return CacheUncacheable; + } + return MtrrGetDefaultMemoryTypeWorker (NULL); } - /** Preparation before programming MTRR. This function will do some preparation for programming MTRRs: disable cache, invalid cache and disable MTRR caching functionality - @return CR4 value before changing. + @param[out] MtrrContext Pointer to context to save **/ -UINTN -PreMtrrChange ( - VOID +VOID +MtrrLibPreMtrrChange ( + OUT MTRR_CONTEXT *MtrrContext ) { - UINTN Value; + MSR_IA32_MTRR_DEF_TYPE_REGISTER DefType; + // + // Disable interrupts and save current interrupt state + // + MtrrContext->InterruptState = SaveAndDisableInterrupts(); // // Enter no fill cache mode, CD=1(Bit30), NW=0 (Bit29) @@ -166,8 +272,8 @@ PreMtrrChange ( // // Save original CR4 value and clear PGE flag (Bit 7) // - Value = AsmReadCr4 (); - AsmWriteCr4 (Value & (~BIT7)); + MtrrContext->Cr4 = AsmReadCr4 (); + AsmWriteCr4 (MtrrContext->Cr4 & (~BIT7)); // // Flush all TLBs @@ -175,38 +281,29 @@ PreMtrrChange ( CpuFlushTlb (); // - // Disable Mtrrs - // - AsmMsrBitFieldWrite64 (MTRR_LIB_IA32_MTRR_DEF_TYPE, 10, 11, 0); - - // - // Return original CR4 value + // Disable MTRRs // - return Value; + DefType.Uint64 = AsmReadMsr64 (MSR_IA32_MTRR_DEF_TYPE); + DefType.Bits.E = 0; + AsmWriteMsr64 (MSR_IA32_MTRR_DEF_TYPE, DefType.Uint64); } - /** Cleaning up after programming MTRRs. This function will do some clean up after programming MTRRs: - enable MTRR caching functionality, and enable cache + Flush all TLBs, re-enable caching, restore CR4. - @param Cr4 CR4 value to restore + @param[in] MtrrContext Pointer to context to restore **/ VOID -PostMtrrChange ( - UINTN Cr4 +MtrrLibPostMtrrChangeEnableCache ( + IN MTRR_CONTEXT *MtrrContext ) { // - // Enable Cache MTRR - // - AsmMsrBitFieldWrite64 (MTRR_LIB_IA32_MTRR_DEF_TYPE, 10, 11, 3); - - // - // Flush all TLBs + // Flush all TLBs // CpuFlushTlb (); @@ -218,16 +315,161 @@ PostMtrrChange ( // // Restore original CR4 value // - AsmWriteCr4 (Cr4); + AsmWriteCr4 (MtrrContext->Cr4); + + // + // Restore original interrupt state + // + SetInterruptState (MtrrContext->InterruptState); +} + +/** + Cleaning up after programming MTRRs. + + This function will do some clean up after programming MTRRs: + enable MTRR caching functionality, and enable cache + + @param[in] MtrrContext Pointer to context to restore + +**/ +VOID +MtrrLibPostMtrrChange ( + IN MTRR_CONTEXT *MtrrContext + ) +{ + MSR_IA32_MTRR_DEF_TYPE_REGISTER DefType; + // + // Enable Cache MTRR + // + DefType.Uint64 = AsmReadMsr64 (MSR_IA32_MTRR_DEF_TYPE); + DefType.Bits.E = 1; + DefType.Bits.FE = 1; + AsmWriteMsr64 (MSR_IA32_MTRR_DEF_TYPE, DefType.Uint64); + + MtrrLibPostMtrrChangeEnableCache (MtrrContext); +} + +/** + Worker function gets the content in fixed MTRRs + + @param[out] FixedSettings A buffer to hold fixed MTRRs content. + + @retval The pointer of FixedSettings + +**/ +MTRR_FIXED_SETTINGS* +MtrrGetFixedMtrrWorker ( + OUT MTRR_FIXED_SETTINGS *FixedSettings + ) +{ + UINT32 Index; + + for (Index = 0; Index < MTRR_NUMBER_OF_FIXED_MTRR; Index++) { + FixedSettings->Mtrr[Index] = + AsmReadMsr64 (mMtrrLibFixedMtrrTable[Index].Msr); + } + + return FixedSettings; +} + + +/** + This function gets the content in fixed MTRRs + + @param[out] FixedSettings A buffer to hold fixed MTRRs content. + + @retval The pointer of FixedSettings + +**/ +MTRR_FIXED_SETTINGS* +EFIAPI +MtrrGetFixedMtrr ( + OUT MTRR_FIXED_SETTINGS *FixedSettings + ) +{ + if (!IsMtrrSupported ()) { + return FixedSettings; + } + + return MtrrGetFixedMtrrWorker (FixedSettings); +} + + +/** + Worker function will get the raw value in variable MTRRs + + If MtrrSetting is not NULL, gets the variable MTRRs raw value from input + MTRR settings buffer. + If MtrrSetting is NULL, gets the variable MTRRs raw value from MTRRs. + + @param[in] MtrrSetting A buffer holding all MTRRs content. + @param[in] VariableMtrrCount Number of variable MTRRs. + @param[out] VariableSettings A buffer to hold variable MTRRs content. + + @return The VariableSettings input pointer + +**/ +MTRR_VARIABLE_SETTINGS* +MtrrGetVariableMtrrWorker ( + IN MTRR_SETTINGS *MtrrSetting, + IN UINT32 VariableMtrrCount, + OUT MTRR_VARIABLE_SETTINGS *VariableSettings + ) +{ + UINT32 Index; + + ASSERT (VariableMtrrCount <= MTRR_NUMBER_OF_VARIABLE_MTRR); + + for (Index = 0; Index < VariableMtrrCount; Index++) { + if (MtrrSetting == NULL) { + VariableSettings->Mtrr[Index].Base = + AsmReadMsr64 (MSR_IA32_MTRR_PHYSBASE0 + (Index << 1)); + VariableSettings->Mtrr[Index].Mask = + AsmReadMsr64 (MSR_IA32_MTRR_PHYSMASK0 + (Index << 1)); + } else { + VariableSettings->Mtrr[Index].Base = MtrrSetting->Variables.Mtrr[Index].Base; + VariableSettings->Mtrr[Index].Mask = MtrrSetting->Variables.Mtrr[Index].Mask; + } + } + + return VariableSettings; } +/** + This function will get the raw value in variable MTRRs + + @param[out] VariableSettings A buffer to hold variable MTRRs content. + + @return The VariableSettings input pointer + +**/ +MTRR_VARIABLE_SETTINGS* +EFIAPI +MtrrGetVariableMtrr ( + OUT MTRR_VARIABLE_SETTINGS *VariableSettings + ) +{ + if (!IsMtrrSupported ()) { + return VariableSettings; + } + + return MtrrGetVariableMtrrWorker ( + NULL, + GetVariableMtrrCountWorker (), + VariableSettings + ); +} /** Programs fixed MTRRs registers. - @param MemoryCacheType The memory type to set. - @param Base The base address of memory range. - @param Length The length of memory range. + @param[in] Type The memory type to set. + @param[in, out] Base The base address of memory range. + @param[in, out] Length The length of memory range. + @param[in, out] LastMsrNum On input, the last index of the fixed MTRR MSR to program. + On return, the current index of the fixed MTRR MSR to program. + @param[out] ReturnClearMask The bits to clear in the fixed MTRR MSR. + @param[out] ReturnOrMask The bits to set in the fixed MTRR MSR. @retval RETURN_SUCCESS The cache type was updated successfully @retval RETURN_UNSUPPORTED The requested range or cache type was invalid @@ -235,28 +477,31 @@ PostMtrrChange ( **/ RETURN_STATUS -ProgramFixedMtrr ( - IN UINT64 MemoryCacheType, - IN OUT UINT64 *Base, - IN OUT UINT64 *Length +MtrrLibProgramFixedMtrr ( + IN MTRR_MEMORY_CACHE_TYPE Type, + IN OUT UINT64 *Base, + IN OUT UINT64 *Length, + IN OUT UINT32 *LastMsrNum, + OUT UINT64 *ReturnClearMask, + OUT UINT64 *ReturnOrMask ) { UINT32 MsrNum; - UINT32 ByteShift; - UINT64 TempQword; + UINT32 LeftByteShift; + UINT32 RightByteShift; UINT64 OrMask; UINT64 ClearMask; + UINT64 SubLength; - TempQword = 0; - OrMask = 0; - ClearMask = 0; - - for (MsrNum = 0; MsrNum < MTRR_NUMBER_OF_FIXED_MTRR; MsrNum++) { - if ((*Base >= MtrrLibFixedMtrrTable[MsrNum].BaseAddress) && + // + // Find the fixed MTRR index to be programmed + // + for (MsrNum = *LastMsrNum + 1; MsrNum < MTRR_NUMBER_OF_FIXED_MTRR; MsrNum++) { + if ((*Base >= mMtrrLibFixedMtrrTable[MsrNum].BaseAddress) && (*Base < ( - MtrrLibFixedMtrrTable[MsrNum].BaseAddress + - (8 * MtrrLibFixedMtrrTable[MsrNum].Length) + mMtrrLibFixedMtrrTable[MsrNum].BaseAddress + + (8 * mMtrrLibFixedMtrrTable[MsrNum].Length) ) ) ) { @@ -269,104 +514,102 @@ ProgramFixedMtrr ( } // - // We found the fixed MTRR to be programmed + // Find the begin offset in fixed MTRR and calculate byte offset of left shift // - for (ByteShift = 0; ByteShift < 8; ByteShift++) { - if (*Base == - ( - MtrrLibFixedMtrrTable[MsrNum].BaseAddress + - (ByteShift * MtrrLibFixedMtrrTable[MsrNum].Length) - ) - ) { - break; - } - } + LeftByteShift = ((UINT32)*Base - mMtrrLibFixedMtrrTable[MsrNum].BaseAddress) + / mMtrrLibFixedMtrrTable[MsrNum].Length; - if (ByteShift == 8) { + if (LeftByteShift >= 8) { return RETURN_UNSUPPORTED; } - for ( - ; - ((ByteShift < 8) && (*Length >= MtrrLibFixedMtrrTable[MsrNum].Length)); - ByteShift++ - ) { - OrMask |= LShiftU64 ((UINT64) MemoryCacheType, (UINT32) (ByteShift * 8)); - ClearMask |= LShiftU64 ((UINT64) 0xFF, (UINT32) (ByteShift * 8)); - *Length -= MtrrLibFixedMtrrTable[MsrNum].Length; - *Base += MtrrLibFixedMtrrTable[MsrNum].Length; + // + // Find the end offset in fixed MTRR and calculate byte offset of right shift + // + SubLength = mMtrrLibFixedMtrrTable[MsrNum].Length * (8 - LeftByteShift); + if (*Length >= SubLength) { + RightByteShift = 0; + } else { + RightByteShift = 8 - LeftByteShift - + (UINT32)(*Length) / mMtrrLibFixedMtrrTable[MsrNum].Length; + if ((LeftByteShift >= 8) || + (((UINT32)(*Length) % mMtrrLibFixedMtrrTable[MsrNum].Length) != 0) + ) { + return RETURN_UNSUPPORTED; + } + // + // Update SubLength by actual length + // + SubLength = *Length; + } + + ClearMask = CLEAR_SEED; + OrMask = MultU64x32 (OR_SEED, (UINT32) Type); + + if (LeftByteShift != 0) { + // + // Clear the low bits by LeftByteShift + // + ClearMask &= LShiftU64 (ClearMask, LeftByteShift * 8); + OrMask &= LShiftU64 (OrMask, LeftByteShift * 8); } - if (ByteShift < 8 && (*Length != 0)) { - return RETURN_UNSUPPORTED; + if (RightByteShift != 0) { + // + // Clear the high bits by RightByteShift + // + ClearMask &= RShiftU64 (ClearMask, RightByteShift * 8); + OrMask &= RShiftU64 (OrMask, RightByteShift * 8); } - TempQword = - (AsmReadMsr64 (MtrrLibFixedMtrrTable[MsrNum].Msr) & ~ClearMask) | OrMask; - AsmWriteMsr64 (MtrrLibFixedMtrrTable[MsrNum].Msr, TempQword); + *Length -= SubLength; + *Base += SubLength; + + *LastMsrNum = MsrNum; + *ReturnClearMask = ClearMask; + *ReturnOrMask = OrMask; + return RETURN_SUCCESS; } /** - Get the attribute of variable MTRRs. + Worker function gets the attribute of variable MTRRs. This function shadows the content of variable MTRRs into an internal array: VariableMtrr. - @param MtrrValidBitsMask The mask for the valid bit of the MTRR - @param MtrrValidAddressMask The valid address mask for MTRR - @param VariableMtrr The array to shadow variable MTRRs content + @param[in] VariableSettings The variable MTRR values to shadow + @param[in] VariableMtrrCount The number of variable MTRRs + @param[in] MtrrValidBitsMask The mask for the valid bit of the MTRR + @param[in] MtrrValidAddressMask The valid address mask for MTRR + @param[out] VariableMtrr The array to shadow variable MTRRs content - @return The return value of this paramter indicates the - number of MTRRs which has been used. + @return Number of MTRRs which has been used. **/ UINT32 -EFIAPI -MtrrGetMemoryAttributeInVariableMtrr ( - IN UINT64 MtrrValidBitsMask, - IN UINT64 MtrrValidAddressMask, - OUT VARIABLE_MTRR *VariableMtrr +MtrrGetMemoryAttributeInVariableMtrrWorker ( + IN MTRR_VARIABLE_SETTINGS *VariableSettings, + IN UINTN VariableMtrrCount, + IN UINT64 MtrrValidBitsMask, + IN UINT64 MtrrValidAddressMask, + OUT VARIABLE_MTRR *VariableMtrr ) { UINTN Index; - UINT32 MsrNum; UINT32 UsedMtrr; - UINT32 FirmwareVariableMtrrCount; - UINT32 VariableMtrrEnd; - - if (!IsMtrrSupported ()) { - return 0; - } - - FirmwareVariableMtrrCount = GetFirmwareVariableMtrrCount (); - VariableMtrrEnd = MTRR_LIB_IA32_VARIABLE_MTRR_BASE + (2 * GetVariableMtrrCount ()) - 1; ZeroMem (VariableMtrr, sizeof (VARIABLE_MTRR) * MTRR_NUMBER_OF_VARIABLE_MTRR); - UsedMtrr = 0; - - for (MsrNum = MTRR_LIB_IA32_VARIABLE_MTRR_BASE, Index = 0; - ( - (MsrNum < VariableMtrrEnd) && - (Index < FirmwareVariableMtrrCount) - ); - MsrNum += 2 - ) { - if ((AsmReadMsr64 (MsrNum + 1) & MTRR_LIB_CACHE_MTRR_ENABLED) != 0) { - VariableMtrr[Index].Msr = MsrNum; - VariableMtrr[Index].BaseAddress = (AsmReadMsr64 (MsrNum) & - MtrrValidAddressMask); - VariableMtrr[Index].Length = ((~(AsmReadMsr64 (MsrNum + 1) & - MtrrValidAddressMask) - ) & - MtrrValidBitsMask - ) + 1; - VariableMtrr[Index].Type = (AsmReadMsr64 (MsrNum) & 0x0ff); - VariableMtrr[Index].Valid = TRUE; - VariableMtrr[Index].Used = TRUE; - UsedMtrr = UsedMtrr + 1; - Index++; + for (Index = 0, UsedMtrr = 0; Index < VariableMtrrCount; Index++) { + if (((MSR_IA32_MTRR_PHYSMASK_REGISTER *) &VariableSettings->Mtrr[Index].Mask)->Bits.V != 0) { + VariableMtrr[Index].Msr = (UINT32)Index; + VariableMtrr[Index].BaseAddress = (VariableSettings->Mtrr[Index].Base & MtrrValidAddressMask); + VariableMtrr[Index].Length = ((~(VariableSettings->Mtrr[Index].Mask & MtrrValidAddressMask)) & MtrrValidBitsMask) + 1; + VariableMtrr[Index].Type = (VariableSettings->Mtrr[Index].Base & 0x0ff); + VariableMtrr[Index].Valid = TRUE; + VariableMtrr[Index].Used = TRUE; + UsedMtrr++; } } return UsedMtrr; @@ -374,869 +617,1606 @@ MtrrGetMemoryAttributeInVariableMtrr ( /** - Checks overlap between given memory range and MTRRs. + Gets the attribute of variable MTRRs. - @param Start The start address of memory range. - @param End The end address of memory range. - @param VariableMtrr The array to shadow variable MTRRs content + This function shadows the content of variable MTRRs into an + internal array: VariableMtrr. - @retval TRUE Overlap exists. - @retval FALSE No overlap. + @param[in] MtrrValidBitsMask The mask for the valid bit of the MTRR + @param[in] MtrrValidAddressMask The valid address mask for MTRR + @param[out] VariableMtrr The array to shadow variable MTRRs content + + @return The return value of this parameter indicates the + number of MTRRs which has been used. **/ -BOOLEAN -CheckMemoryAttributeOverlap ( - IN PHYSICAL_ADDRESS Start, - IN PHYSICAL_ADDRESS End, - IN VARIABLE_MTRR *VariableMtrr +UINT32 +EFIAPI +MtrrGetMemoryAttributeInVariableMtrr ( + IN UINT64 MtrrValidBitsMask, + IN UINT64 MtrrValidAddressMask, + OUT VARIABLE_MTRR *VariableMtrr ) { - UINT32 Index; + MTRR_VARIABLE_SETTINGS VariableSettings; - for (Index = 0; Index < 6; Index++) { - if ( - VariableMtrr[Index].Valid && - !( - (Start > (VariableMtrr[Index].BaseAddress + - VariableMtrr[Index].Length - 1) - ) || - (End < VariableMtrr[Index].BaseAddress) - ) - ) { - return TRUE; - } + if (!IsMtrrSupported ()) { + return 0; } - return FALSE; -} + MtrrGetVariableMtrrWorker ( + NULL, + GetVariableMtrrCountWorker (), + &VariableSettings + ); + return MtrrGetMemoryAttributeInVariableMtrrWorker ( + &VariableSettings, + GetFirmwareVariableMtrrCountWorker (), + MtrrValidBitsMask, + MtrrValidAddressMask, + VariableMtrr + ); +} /** - Marks a variable MTRR as non-valid. + Return the least alignment of address. - @param Index The index of the array VariableMtrr to be invalidated - @param VariableMtrr The array to shadow variable MTRRs content - @param UsedMtrr The number of MTRRs which has already been used + @param Address The address to return the alignment. + @param Alignment0 The alignment to return when Address is 0. + @return The least alignment of the Address. **/ -VOID -InvalidateShadowMtrr ( - IN UINTN Index, - IN VARIABLE_MTRR *VariableMtrr, - OUT UINT32 *UsedMtrr - ) +UINT64 +MtrrLibLeastAlignment ( + UINT64 Address, + UINT64 Alignment0 +) { - VariableMtrr[Index].Valid = FALSE; - *UsedMtrr = *UsedMtrr - 1; -} + if (Address == 0) { + return Alignment0; + } + return LShiftU64 (1, (UINTN) LowBitSet64 (Address)); +} /** - Combine memory attributes. - - If overlap exists between given memory range and MTRRs, try to combine them. - - @param Attributes The memory type to set. - @param Base The base address of memory range. - @param Length The length of memory range. - @param VariableMtrr The array to shadow variable MTRRs content - @param UsedMtrr The number of MTRRs which has already been used - @param OverwriteExistingMtrr Returns whether an existing MTRR was used + Return the number of required variable MTRRs to positively cover the + specified range. - @retval EFI_SUCCESS Memory region successfully combined. - @retval EFI_ACCESS_DENIED Memory region cannot be combined. + @param BaseAddress Base address of the range. + @param Length Length of the range. + @param Alignment0 Alignment of 0. + @return The number of the required variable MTRRs. **/ -RETURN_STATUS -CombineMemoryAttribute ( - IN UINT64 Attributes, - IN OUT UINT64 *Base, - IN OUT UINT64 *Length, - IN VARIABLE_MTRR *VariableMtrr, - IN OUT UINT32 *UsedMtrr, - OUT BOOLEAN *OverwriteExistingMtrr - ) +UINT32 +MtrrLibGetPositiveMtrrNumber ( + IN UINT64 BaseAddress, + IN UINT64 Length, + IN UINT64 Alignment0 +) { - UINT32 Index; - UINT64 CombineStart; - UINT64 CombineEnd; - UINT64 MtrrEnd; - UINT64 EndAddress; - UINT32 FirmwareVariableMtrrCount; - - FirmwareVariableMtrrCount = GetFirmwareVariableMtrrCount (); - - *OverwriteExistingMtrr = FALSE; - EndAddress = *Base +*Length - 1; - - for (Index = 0; Index < FirmwareVariableMtrrCount; Index++) { - - MtrrEnd = VariableMtrr[Index].BaseAddress + VariableMtrr[Index].Length - 1; - if ( - !VariableMtrr[Index].Valid || - ( - *Base > (MtrrEnd) || - (EndAddress < VariableMtrr[Index].BaseAddress) - ) - ) { - continue; - } + UINT64 SubLength; + UINT32 MtrrNumber; + BOOLEAN UseLeastAlignment; + + UseLeastAlignment = TRUE; + SubLength = 0; + + // + // Calculate the alignment of the base address. + // + for (MtrrNumber = 0; Length != 0; MtrrNumber++) { + if (UseLeastAlignment) { + SubLength = MtrrLibLeastAlignment (BaseAddress, Alignment0); + + if (SubLength > Length) { + // + // Set a flag when remaining length is too small + // so that MtrrLibLeastAlignment() is not called in following loops. + // + UseLeastAlignment = FALSE; + } + } + + if (!UseLeastAlignment) { + SubLength = GetPowerOfTwo64 (Length); + } + + BaseAddress += SubLength; + Length -= SubLength; + } + + return MtrrNumber; +} + +/** + Return whether the left MTRR type precedes the right MTRR type. + + The MTRR type precedence rules are: + 1. UC precedes any other type + 2. WT precedes WB + For further details, please refer the IA32 Software Developer's Manual, + Volume 3, Section "MTRR Precedences". + + @param Left The left MTRR type. + @param Right The right MTRR type. + + @retval TRUE Left precedes Right. + @retval FALSE Left doesn't precede Right. +**/ +BOOLEAN +MtrrLibTypeLeftPrecedeRight ( + IN MTRR_MEMORY_CACHE_TYPE Left, + IN MTRR_MEMORY_CACHE_TYPE Right +) +{ + return (BOOLEAN) (Left == CacheUncacheable || (Left == CacheWriteThrough && Right == CacheWriteBack)); +} + + +/** + Return whether the type of the specified range can precede the specified type. + + @param Ranges Memory range array holding memory type settings for all + the memory address. + @param RangeCount Count of memory ranges. + @param Type Type to check precedence. + @param SubBase Base address of the specified range. + @param SubLength Length of the specified range. + + @retval TRUE The type of the specified range can precede the Type. + @retval FALSE The type of the specified range cannot precede the Type. + So the subtraction is not applicable. +**/ +BOOLEAN +MtrrLibSubstractable ( + IN CONST MEMORY_RANGE *Ranges, + IN UINT32 RangeCount, + IN MTRR_MEMORY_CACHE_TYPE Type, + IN UINT64 SubBase, + IN UINT64 SubLength +) +{ + UINT32 Index; + UINT64 Length; + // WT > WB + // UC > * + for (Index = 0; Index < RangeCount; Index++) { + if (Ranges[Index].BaseAddress <= SubBase && SubBase < Ranges[Index].BaseAddress + Ranges[Index].Length) { + + if (Ranges[Index].BaseAddress + Ranges[Index].Length >= SubBase + SubLength) { + return MtrrLibTypeLeftPrecedeRight (Ranges[Index].Type, Type); + + } else { + if (!MtrrLibTypeLeftPrecedeRight (Ranges[Index].Type, Type)) { + return FALSE; + } + + Length = Ranges[Index].BaseAddress + Ranges[Index].Length - SubBase; + SubBase += Length; + SubLength -= Length; + } + } + } + + ASSERT (FALSE); + return FALSE; +} + +/** + Return the number of required variable MTRRs to cover the specified range. + + The routine considers subtraction in the both side of the range to find out + the most optimal solution (which uses the least MTRRs). + + @param Ranges Array holding memory type settings of all memory + address. + @param RangeCount Count of memory ranges. + @param VariableMtrr Array holding allocated variable MTRRs. + @param VariableMtrrCount Count of allocated variable MTRRs. + @param BaseAddress Base address of the specified range. + @param Length Length of the specified range. + @param Type MTRR type of the specified range. + @param Alignment0 Alignment of 0. + @param SubLeft Return the count of left subtraction. + @param SubRight Return the count of right subtraction. + + @return Number of required variable MTRRs. +**/ +UINT32 +MtrrLibGetMtrrNumber ( + IN CONST MEMORY_RANGE *Ranges, + IN UINT32 RangeCount, + IN CONST VARIABLE_MTRR *VariableMtrr, + IN UINT32 VariableMtrrCount, + IN UINT64 BaseAddress, + IN UINT64 Length, + IN MTRR_MEMORY_CACHE_TYPE Type, + IN UINT64 Alignment0, + OUT UINT32 *SubLeft, // subtractive from BaseAddress to get more aligned address, to save MTRR + OUT UINT32 *SubRight // subtractive from BaseAddress + Length, to save MTRR + ) +{ + UINT64 Alignment; + UINT32 LeastLeftMtrrNumber; + UINT32 MiddleMtrrNumber; + UINT32 LeastRightMtrrNumber; + UINT32 CurrentMtrrNumber; + UINT32 SubtractiveCount; + UINT32 SubtractiveMtrrNumber; + UINT32 LeastSubtractiveMtrrNumber; + UINT64 SubtractiveBaseAddress; + UINT64 SubtractiveLength; + UINT64 BaseAlignment; + UINT32 Index; + + *SubLeft = 0; + *SubRight = 0; + LeastSubtractiveMtrrNumber = 0; + BaseAlignment = 0; + + // + // Get the optimal left subtraction solution. + // + if (BaseAddress != 0) { + SubtractiveBaseAddress = 0; + SubtractiveLength = 0; + // + // Get the MTRR number needed without left subtraction. + // + LeastLeftMtrrNumber = MtrrLibGetPositiveMtrrNumber (BaseAddress, Length, Alignment0); // - // Combine same attribute MTRR range - // - if (Attributes == VariableMtrr[Index].Type) { + // Left subtraction bit by bit, to find the optimal left subtraction solution. + // + for (SubtractiveMtrrNumber = 0, SubtractiveCount = 1; BaseAddress != 0; SubtractiveCount++) { + Alignment = MtrrLibLeastAlignment (BaseAddress, Alignment0); + // - // if the Mtrr range contain the request range, return RETURN_SUCCESS + // Check whether the memory type of [BaseAddress - Alignment, BaseAddress) can override Type. + // IA32 Manual defines the following override rules: + // WT > WB + // UC > * (any) // - if (VariableMtrr[Index].BaseAddress <= *Base && MtrrEnd >= EndAddress) { - *Length = 0; - return RETURN_SUCCESS; + if (!MtrrLibSubstractable (Ranges, RangeCount, Type, BaseAddress - Alignment, Alignment)) { + break; } - // - // invalid this MTRR, and program the combine range - // - CombineStart = - (*Base) < VariableMtrr[Index].BaseAddress ? - (*Base) : - VariableMtrr[Index].BaseAddress; - CombineEnd = EndAddress > MtrrEnd ? EndAddress : MtrrEnd; - // - // Record the MTRR usage status in VariableMtrr array. - // - InvalidateShadowMtrr (Index, VariableMtrr, UsedMtrr); - *Base = CombineStart; - *Length = CombineEnd - CombineStart + 1; - EndAddress = CombineEnd; - *OverwriteExistingMtrr = TRUE; - continue; - } else { - // - // The cache type is different, but the range is convered by one MTRR - // - if (VariableMtrr[Index].BaseAddress == *Base && MtrrEnd == EndAddress) { - InvalidateShadowMtrr (Index, VariableMtrr, UsedMtrr); - continue; + for (Index = 0; Index < VariableMtrrCount; Index++) { + if ((VariableMtrr[Index].BaseAddress == BaseAddress - Alignment) && + (VariableMtrr[Index].Length == Alignment)) { + break; + } + } + if (Index == VariableMtrrCount) { + // + // Increment SubtractiveMtrrNumber when [BaseAddress - Alignment, BaseAddress) is not be planed as a MTRR + // + SubtractiveMtrrNumber++; + } + + BaseAddress -= Alignment; + Length += Alignment; + + CurrentMtrrNumber = SubtractiveMtrrNumber + MtrrLibGetPositiveMtrrNumber (BaseAddress, Length, Alignment0); + if (CurrentMtrrNumber <= LeastLeftMtrrNumber) { + LeastLeftMtrrNumber = CurrentMtrrNumber; + LeastSubtractiveMtrrNumber = SubtractiveMtrrNumber; + *SubLeft = SubtractiveCount; + SubtractiveBaseAddress = BaseAddress; + SubtractiveLength = Length; } + } + // + // If left subtraction is better, subtract BaseAddress to left, and enlarge Length + // + if (*SubLeft != 0) { + BaseAddress = SubtractiveBaseAddress; + Length = SubtractiveLength; } + } - if ((Attributes== MTRR_CACHE_WRITE_THROUGH && - VariableMtrr[Index].Type == MTRR_CACHE_WRITE_BACK) || - (Attributes == MTRR_CACHE_WRITE_BACK && - VariableMtrr[Index].Type == MTRR_CACHE_WRITE_THROUGH) || - (Attributes == MTRR_CACHE_UNCACHEABLE) || - (VariableMtrr[Index].Type == MTRR_CACHE_UNCACHEABLE) - ) { - *OverwriteExistingMtrr = TRUE; - continue; + // + // Increment BaseAddress greedily until (BaseAddress + Alignment) exceeds (BaseAddress + Length) + // + MiddleMtrrNumber = 0; + while (Length != 0) { + BaseAlignment = MtrrLibLeastAlignment (BaseAddress, Alignment0); + if (BaseAlignment > Length) { + break; + } + BaseAddress += BaseAlignment; + Length -= BaseAlignment; + MiddleMtrrNumber++; + } + + + if (Length == 0) { + return LeastSubtractiveMtrrNumber + MiddleMtrrNumber; + } + + + // + // Get the optimal right subtraction solution. + // + + // + // Get the MTRR number needed without right subtraction. + // + LeastRightMtrrNumber = MtrrLibGetPositiveMtrrNumber (BaseAddress, Length, Alignment0); + + for (SubtractiveCount = 1; Length < BaseAlignment; SubtractiveCount++) { + Alignment = MtrrLibLeastAlignment (BaseAddress + Length, Alignment0); + if (!MtrrLibSubstractable (Ranges, RangeCount, Type, BaseAddress + Length, Alignment)) { + break; } + + Length += Alignment; + // - // Other type memory overlap is invalid + // SubtractiveCount = Number of MTRRs used for subtraction // - return RETURN_ACCESS_DENIED; + CurrentMtrrNumber = SubtractiveCount + MtrrLibGetPositiveMtrrNumber (BaseAddress, Length, Alignment0); + if (CurrentMtrrNumber <= LeastRightMtrrNumber) { + LeastRightMtrrNumber = CurrentMtrrNumber; + *SubRight = SubtractiveCount; + SubtractiveLength = Length; + } } - return RETURN_SUCCESS; + return LeastSubtractiveMtrrNumber + MiddleMtrrNumber + LeastRightMtrrNumber; } - /** - Calculate the maximum value which is a power of 2, but less the MemoryLength. + 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 MemoryLength The number to pass in. - @return The maximum value which is align to power of 2 and less the MemoryLength + @param[out] MtrrValidBitsMask The mask for the valid bit of the MTRR + @param[out] MtrrValidAddressMask The valid address mask for the MTRR **/ -UINT64 -Power2MaxMemory ( - IN UINT64 MemoryLength +VOID +MtrrLibInitializeMtrrMask ( + OUT UINT64 *MtrrValidBitsMask, + OUT UINT64 *MtrrValidAddressMask ) { - UINT64 Result; - - if (RShiftU64 (MemoryLength, 32) != 0) { - Result = LShiftU64 ( - (UINT64) GetPowerOfTwo32 ( - (UINT32) RShiftU64 (MemoryLength, 32) - ), - 32 - ); + UINT32 MaxExtendedFunction; + CPUID_VIR_PHY_ADDRESS_SIZE_EAX VirPhyAddressSize; + + + AsmCpuid (CPUID_EXTENDED_FUNCTION, &MaxExtendedFunction, NULL, NULL, NULL); + + if (MaxExtendedFunction >= CPUID_VIR_PHY_ADDRESS_SIZE) { + AsmCpuid (CPUID_VIR_PHY_ADDRESS_SIZE, &VirPhyAddressSize.Uint32, NULL, NULL, NULL); } else { - Result = (UINT64) GetPowerOfTwo32 ((UINT32) MemoryLength); + VirPhyAddressSize.Bits.PhysicalAddressBits = 36; } - return Result; + *MtrrValidBitsMask = LShiftU64 (1, VirPhyAddressSize.Bits.PhysicalAddressBits) - 1; + *MtrrValidAddressMask = *MtrrValidBitsMask & 0xfffffffffffff000ULL; } /** - Check the direction to program variable MTRRs. - - This function determines which direction of programming the variable - MTRRs will use fewer MTRRs. + Determines the real attribute of a memory range. - @param Input Length of Memory to program MTRR - @param MtrrNumber Pointer to the number of necessary MTRRs + This function is to arbitrate the real attribute of the memory when + there are 2 MTRRs covers the same memory range. For further details, + please refer the IA32 Software Developer's Manual, Volume 3, + Section "MTRR Precedences". - @retval TRUE Positive direction is better. - FALSE Negtive direction is better. + @param[in] MtrrType1 The first kind of Memory type + @param[in] MtrrType2 The second kind of memory type **/ -BOOLEAN -GetDirection ( - IN UINT64 Input, - IN UINTN *MtrrNumber +MTRR_MEMORY_CACHE_TYPE +MtrrLibPrecedence ( + IN MTRR_MEMORY_CACHE_TYPE MtrrType1, + IN MTRR_MEMORY_CACHE_TYPE MtrrType2 ) { - UINT64 TempQword; - UINT32 Positive; - UINT32 Subtractive; - - TempQword = Input; - Positive = 0; - Subtractive = 0; - - do { - TempQword -= Power2MaxMemory (TempQword); - Positive++; - } while (TempQword != 0); - - TempQword = Power2MaxMemory (LShiftU64 (Input, 1)) - Input; - Subtractive++; - do { - TempQword -= Power2MaxMemory (TempQword); - Subtractive++; - } while (TempQword != 0); - - if (Positive <= Subtractive) { - *MtrrNumber = Positive; - return TRUE; + if (MtrrType1 == MtrrType2) { + return MtrrType1; + } + + ASSERT ( + MtrrLibTypeLeftPrecedeRight (MtrrType1, MtrrType2) || + MtrrLibTypeLeftPrecedeRight (MtrrType2, MtrrType1) + ); + + if (MtrrLibTypeLeftPrecedeRight (MtrrType1, MtrrType2)) { + return MtrrType1; } else { - *MtrrNumber = Subtractive; - return FALSE; + return MtrrType2; } } /** - Invalid variable MTRRs according to the value in the shadow array. + Worker function will get the memory cache type of the specific address. + + If MtrrSetting is not NULL, gets the memory cache type from input + MTRR settings buffer. + If MtrrSetting is NULL, gets the memory cache type from MTRRs. - This function programs MTRRs according to the values specified - in the shadow array. + @param[in] MtrrSetting A buffer holding all MTRRs content. + @param[in] Address The specific address - @param VariableMtrr The array to shadow variable MTRRs content + @return Memory cache type of the specific address **/ -VOID -InvalidateMtrr ( - IN VARIABLE_MTRR *VariableMtrr - ) +MTRR_MEMORY_CACHE_TYPE +MtrrGetMemoryAttributeByAddressWorker ( + IN MTRR_SETTINGS *MtrrSetting, + IN PHYSICAL_ADDRESS Address + ) { - UINTN Index; - UINTN Cr4; - UINTN VariableMtrrCount; - - Cr4 = PreMtrrChange (); - Index = 0; - VariableMtrrCount = GetVariableMtrrCount (); - while (Index < VariableMtrrCount) { - if (!VariableMtrr[Index].Valid && VariableMtrr[Index].Used) { - AsmWriteMsr64 (VariableMtrr[Index].Msr, 0); - AsmWriteMsr64 (VariableMtrr[Index].Msr + 1, 0); - VariableMtrr[Index].Used = FALSE; - } - Index ++; - } - PostMtrrChange (Cr4); -} - + MSR_IA32_MTRR_DEF_TYPE_REGISTER DefType; + UINT64 FixedMtrr; + UINTN Index; + UINTN SubIndex; + MTRR_MEMORY_CACHE_TYPE MtrrType; + VARIABLE_MTRR VariableMtrr[MTRR_NUMBER_OF_VARIABLE_MTRR]; + UINT64 MtrrValidBitsMask; + UINT64 MtrrValidAddressMask; + UINT32 VariableMtrrCount; + MTRR_VARIABLE_SETTINGS VariableSettings; -/** - Programs variable MTRRs + // + // Check if MTRR is enabled, if not, return UC as attribute + // + if (MtrrSetting == NULL) { + DefType.Uint64 = AsmReadMsr64 (MSR_IA32_MTRR_DEF_TYPE); + } else { + DefType.Uint64 = MtrrSetting->MtrrDefType; + } - This function programs variable MTRRs + if (DefType.Bits.E == 0) { + return CacheUncacheable; + } - @param MtrrNumber Index of MTRR to program. - @param BaseAddress Base address of memory region. - @param Length Length of memory region. - @param MemoryCacheType Memory type to set. - @param MtrrValidAddressMask The valid address mask for MTRR + // + // If address is less than 1M, then try to go through the fixed MTRR + // + if (Address < BASE_1MB) { + if (DefType.Bits.FE != 0) { + // + // Go through the fixed MTRR + // + for (Index = 0; Index < MTRR_NUMBER_OF_FIXED_MTRR; Index++) { + if (Address >= mMtrrLibFixedMtrrTable[Index].BaseAddress && + Address < mMtrrLibFixedMtrrTable[Index].BaseAddress + + (mMtrrLibFixedMtrrTable[Index].Length * 8)) { + SubIndex = + ((UINTN) Address - mMtrrLibFixedMtrrTable[Index].BaseAddress) / + mMtrrLibFixedMtrrTable[Index].Length; + if (MtrrSetting == NULL) { + FixedMtrr = AsmReadMsr64 (mMtrrLibFixedMtrrTable[Index].Msr); + } else { + FixedMtrr = MtrrSetting->Fixed.Mtrr[Index]; + } + return (MTRR_MEMORY_CACHE_TYPE) (RShiftU64 (FixedMtrr, SubIndex * 8) & 0xFF); + } + } + } + } -**/ -VOID -ProgramVariableMtrr ( - IN UINTN MtrrNumber, - IN PHYSICAL_ADDRESS BaseAddress, - IN UINT64 Length, - IN UINT64 MemoryCacheType, - IN UINT64 MtrrValidAddressMask - ) -{ - UINT64 TempQword; - UINTN Cr4; + VariableMtrrCount = GetVariableMtrrCountWorker (); + ASSERT (VariableMtrrCount <= MTRR_NUMBER_OF_VARIABLE_MTRR); + MtrrGetVariableMtrrWorker (MtrrSetting, VariableMtrrCount, &VariableSettings); - Cr4 = PreMtrrChange (); + MtrrLibInitializeMtrrMask (&MtrrValidBitsMask, &MtrrValidAddressMask); + MtrrGetMemoryAttributeInVariableMtrrWorker ( + &VariableSettings, + VariableMtrrCount, + MtrrValidBitsMask, + MtrrValidAddressMask, + VariableMtrr + ); // - // MTRR Physical Base + // Go through the variable MTRR // - TempQword = (BaseAddress & MtrrValidAddressMask) | MemoryCacheType; - AsmWriteMsr64 ((UINT32) MtrrNumber, TempQword); + MtrrType = CacheInvalid; + for (Index = 0; Index < VariableMtrrCount; Index++) { + if (VariableMtrr[Index].Valid) { + if (Address >= VariableMtrr[Index].BaseAddress && + Address < VariableMtrr[Index].BaseAddress + VariableMtrr[Index].Length) { + if (MtrrType == CacheInvalid) { + MtrrType = (MTRR_MEMORY_CACHE_TYPE) VariableMtrr[Index].Type; + } else { + MtrrType = MtrrLibPrecedence (MtrrType, (MTRR_MEMORY_CACHE_TYPE) VariableMtrr[Index].Type); + } + } + } + } // - // MTRR Physical Mask + // If there is no MTRR which covers the Address, use the default MTRR type. // - TempQword = ~(Length - 1); - AsmWriteMsr64 ( - (UINT32) (MtrrNumber + 1), - (TempQword & MtrrValidAddressMask) | MTRR_LIB_CACHE_MTRR_ENABLED - ); + if (MtrrType == CacheInvalid) { + MtrrType = (MTRR_MEMORY_CACHE_TYPE) DefType.Bits.Type; + } - PostMtrrChange (Cr4); + return MtrrType; } /** - Convert the Memory attibute value to MTRR_MEMORY_CACHE_TYPE. + This function will get the memory cache type of the specific address. + + This function is mainly for debug purpose. - @param MtrrType MTRR memory type + @param[in] Address The specific address - @return The enum item in MTRR_MEMORY_CACHE_TYPE + @return Memory cache type of the specific address **/ MTRR_MEMORY_CACHE_TYPE -GetMemoryCacheTypeFromMtrrType ( - IN UINT64 MtrrType +EFIAPI +MtrrGetMemoryAttribute ( + IN PHYSICAL_ADDRESS Address ) { - switch (MtrrType) { - case MTRR_CACHE_UNCACHEABLE: - return CacheUncacheable; - case MTRR_CACHE_WRITE_COMBINING: - return CacheWriteCombining; - case MTRR_CACHE_WRITE_THROUGH: - return CacheWriteThrough; - case MTRR_CACHE_WRITE_PROTECTED: - return CacheWriteProtected; - case MTRR_CACHE_WRITE_BACK: - return CacheWriteBack; - default: - // - // MtrrType is MTRR_CACHE_INVALID_TYPE, that means - // no mtrr covers the range - // + if (!IsMtrrSupported ()) { return CacheUncacheable; } + + return MtrrGetMemoryAttributeByAddressWorker (NULL, Address); } /** - Initializes the valid bits mask and valid address mask for MTRRs. - - This function initializes the valid bits mask and valid address mask for MTRRs. + Worker function prints all MTRRs for debugging. - @param MtrrValidBitsMask The mask for the valid bit of the MTRR - @param MtrrValidAddressMask The valid address mask for the MTRR + If MtrrSetting is not NULL, print MTRR settings from input MTRR + settings buffer. + If MtrrSetting is NULL, print MTRR settings from MTRRs. + @param MtrrSetting A buffer holding all MTRRs content. **/ VOID -MtrrLibInitializeMtrrMask ( - OUT UINT64 *MtrrValidBitsMask, - OUT UINT64 *MtrrValidAddressMask +MtrrDebugPrintAllMtrrsWorker ( + IN MTRR_SETTINGS *MtrrSetting ) { - UINT32 RegEax; - UINT8 PhysicalAddressBits; + DEBUG_CODE ( + MTRR_SETTINGS LocalMtrrs; + MTRR_SETTINGS *Mtrrs; + UINTN Index; + UINTN Index1; + UINTN VariableMtrrCount; + UINT64 Base; + UINT64 Limit; + UINT64 MtrrBase; + UINT64 MtrrLimit; + UINT64 RangeBase; + UINT64 RangeLimit; + UINT64 NoRangeBase; + UINT64 NoRangeLimit; + UINT32 RegEax; + UINTN MemoryType; + UINTN PreviousMemoryType; + BOOLEAN Found; + + if (!IsMtrrSupported ()) { + return; + } + + DEBUG((DEBUG_CACHE, "MTRR Settings\n")); + DEBUG((DEBUG_CACHE, "=============\n")); + + if (MtrrSetting != NULL) { + Mtrrs = MtrrSetting; + } else { + MtrrGetAllMtrrs (&LocalMtrrs); + Mtrrs = &LocalMtrrs; + } - AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL); + DEBUG((DEBUG_CACHE, "MTRR Default Type: %016lx\n", Mtrrs->MtrrDefType)); + for (Index = 0; Index < MTRR_NUMBER_OF_FIXED_MTRR; Index++) { + DEBUG((DEBUG_CACHE, "Fixed MTRR[%02d] : %016lx\n", Index, Mtrrs->Fixed.Mtrr[Index])); + } - if (RegEax >= 0x80000008) { - AsmCpuid (0x80000008, &RegEax, NULL, NULL, NULL); + VariableMtrrCount = GetVariableMtrrCount (); + for (Index = 0; Index < VariableMtrrCount; Index++) { + DEBUG((DEBUG_CACHE, "Variable MTRR[%02d]: Base=%016lx Mask=%016lx\n", + Index, + Mtrrs->Variables.Mtrr[Index].Base, + Mtrrs->Variables.Mtrr[Index].Mask + )); + } + DEBUG((DEBUG_CACHE, "\n")); + DEBUG((DEBUG_CACHE, "MTRR Ranges\n")); + DEBUG((DEBUG_CACHE, "====================================\n")); + + Base = 0; + PreviousMemoryType = MTRR_CACHE_INVALID_TYPE; + for (Index = 0; Index < MTRR_NUMBER_OF_FIXED_MTRR; Index++) { + Base = mMtrrLibFixedMtrrTable[Index].BaseAddress; + for (Index1 = 0; Index1 < 8; Index1++) { + MemoryType = (UINTN)(RShiftU64 (Mtrrs->Fixed.Mtrr[Index], Index1 * 8) & 0xff); + if (MemoryType > CacheWriteBack) { + MemoryType = MTRR_CACHE_INVALID_TYPE; + } + if (MemoryType != PreviousMemoryType) { + if (PreviousMemoryType != MTRR_CACHE_INVALID_TYPE) { + DEBUG((DEBUG_CACHE, "%016lx\n", Base - 1)); + } + PreviousMemoryType = MemoryType; + DEBUG((DEBUG_CACHE, "%a:%016lx-", mMtrrMemoryCacheTypeShortName[MemoryType], Base)); + } + Base += mMtrrLibFixedMtrrTable[Index].Length; + } + } + DEBUG((DEBUG_CACHE, "%016lx\n", Base - 1)); - PhysicalAddressBits = (UINT8) RegEax; + VariableMtrrCount = GetVariableMtrrCount (); - *MtrrValidBitsMask = LShiftU64 (1, PhysicalAddressBits) - 1; - *MtrrValidAddressMask = *MtrrValidBitsMask & 0xfffffffffffff000ULL; - } else { - *MtrrValidBitsMask = MTRR_LIB_CACHE_VALID_ADDRESS; - *MtrrValidAddressMask = 0xFFFFFFFF; - } + Limit = BIT36 - 1; + AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL); + if (RegEax >= 0x80000008) { + AsmCpuid (0x80000008, &RegEax, NULL, NULL, NULL); + Limit = LShiftU64 (1, RegEax & 0xff) - 1; + } + Base = BASE_1MB; + PreviousMemoryType = MTRR_CACHE_INVALID_TYPE; + do { + MemoryType = MtrrGetMemoryAttributeByAddressWorker (Mtrrs, Base); + if (MemoryType > CacheWriteBack) { + MemoryType = MTRR_CACHE_INVALID_TYPE; + } + + if (MemoryType != PreviousMemoryType) { + if (PreviousMemoryType != MTRR_CACHE_INVALID_TYPE) { + DEBUG((DEBUG_CACHE, "%016lx\n", Base - 1)); + } + PreviousMemoryType = MemoryType; + DEBUG((DEBUG_CACHE, "%a:%016lx-", mMtrrMemoryCacheTypeShortName[MemoryType], Base)); + } + + RangeBase = BASE_1MB; + NoRangeBase = BASE_1MB; + RangeLimit = Limit; + NoRangeLimit = Limit; + + for (Index = 0, Found = FALSE; Index < VariableMtrrCount; Index++) { + if ((Mtrrs->Variables.Mtrr[Index].Mask & BIT11) == 0) { + // + // If mask is not valid, then do not display range + // + continue; + } + MtrrBase = (Mtrrs->Variables.Mtrr[Index].Base & (~(SIZE_4KB - 1))); + MtrrLimit = MtrrBase + ((~(Mtrrs->Variables.Mtrr[Index].Mask & (~(SIZE_4KB - 1)))) & Limit); + + if (Base >= MtrrBase && Base < MtrrLimit) { + Found = TRUE; + } + + if (Base >= MtrrBase && MtrrBase > RangeBase) { + RangeBase = MtrrBase; + } + if (Base > MtrrLimit && MtrrLimit > RangeBase) { + RangeBase = MtrrLimit + 1; + } + if (Base < MtrrBase && MtrrBase < RangeLimit) { + RangeLimit = MtrrBase - 1; + } + if (Base < MtrrLimit && MtrrLimit <= RangeLimit) { + RangeLimit = MtrrLimit; + } + + if (Base > MtrrLimit && NoRangeBase < MtrrLimit) { + NoRangeBase = MtrrLimit + 1; + } + if (Base < MtrrBase && NoRangeLimit > MtrrBase) { + NoRangeLimit = MtrrBase - 1; + } + } + + if (Found) { + Base = RangeLimit + 1; + } else { + Base = NoRangeLimit + 1; + } + } while (Base < Limit); + DEBUG((DEBUG_CACHE, "%016lx\n\n", Base - 1)); + ); } /** - Determing the real attribute of a memory range. + This function prints all MTRRs for debugging. +**/ +VOID +EFIAPI +MtrrDebugPrintAllMtrrs ( + VOID + ) +{ + MtrrDebugPrintAllMtrrsWorker (NULL); +} + +/** + Update the Ranges array to change the specified range identified by + BaseAddress and Length to Type. + + @param Ranges Array holding memory type settings for all memory regions. + @param Capacity The maximum count of memory ranges the array can hold. + @param Count Return the new memory range count in the array. + @param BaseAddress The base address of the memory range to change type. + @param Length The length of the memory range to change type. + @param Type The new type of the specified memory range. + + @retval RETURN_SUCCESS The type of the specified memory range is + changed successfully. + @retval RETURN_OUT_OF_RESOURCES The new type set causes the count of memory + range exceeds capacity. +**/ +RETURN_STATUS +MtrrLibSetMemoryType ( + IN MEMORY_RANGE *Ranges, + IN UINT32 Capacity, + IN OUT UINT32 *Count, + IN UINT64 BaseAddress, + IN UINT64 Length, + IN MTRR_MEMORY_CACHE_TYPE Type + ) +{ + UINT32 Index; + UINT64 Limit; + UINT64 LengthLeft; + UINT64 LengthRight; + UINT32 StartIndex; + UINT32 EndIndex; + UINT32 DeltaCount; + + LengthRight = 0; + LengthLeft = 0; + Limit = BaseAddress + Length; + StartIndex = *Count; + EndIndex = *Count; + for (Index = 0; Index < *Count; Index++) { + if ((StartIndex == *Count) && + (Ranges[Index].BaseAddress <= BaseAddress) && + (BaseAddress < Ranges[Index].BaseAddress + Ranges[Index].Length)) { + StartIndex = Index; + LengthLeft = BaseAddress - Ranges[Index].BaseAddress; + } - This function is to arbitrate the real attribute of the memory when - there are 2 MTRR covers the same memory range. For further details, - please refer the IA32 Software Developer's Manual, Volume 3, - Section 10.11.4.1. + if ((EndIndex == *Count) && + (Ranges[Index].BaseAddress < Limit) && + (Limit <= Ranges[Index].BaseAddress + Ranges[Index].Length)) { + EndIndex = Index; + LengthRight = Ranges[Index].BaseAddress + Ranges[Index].Length - Limit; + break; + } + } + + ASSERT (StartIndex != *Count && EndIndex != *Count); + if (StartIndex == EndIndex && Ranges[StartIndex].Type == Type) { + return RETURN_SUCCESS; + } + + // + // The type change may cause merging with previous range or next range. + // Update the StartIndex, EndIndex, BaseAddress, Length so that following + // logic doesn't need to consider merging. + // + if (StartIndex != 0) { + if (LengthLeft == 0 && Ranges[StartIndex - 1].Type == Type) { + StartIndex--; + Length += Ranges[StartIndex].Length; + BaseAddress -= Ranges[StartIndex].Length; + } + } + if (EndIndex != (*Count) - 1) { + if (LengthRight == 0 && Ranges[EndIndex + 1].Type == Type) { + EndIndex++; + Length += Ranges[EndIndex].Length; + } + } + + // + // |- 0 -|- 1 -|- 2 -|- 3 -| StartIndex EndIndex DeltaCount Count (Count = 4) + // |++++++++++++++++++| 0 3 1=3-0-2 3 + // |+++++++| 0 1 -1=1-0-2 5 + // |+| 0 0 -2=0-0-2 6 + // |+++| 0 0 -1=0-0-2+1 5 + // + // + DeltaCount = EndIndex - StartIndex - 2; + if (LengthLeft == 0) { + DeltaCount++; + } + if (LengthRight == 0) { + DeltaCount++; + } + if (*Count - DeltaCount > Capacity) { + return RETURN_OUT_OF_RESOURCES; + } + + // + // Reserve (-DeltaCount) space + // + CopyMem (&Ranges[EndIndex + 1 - DeltaCount], &Ranges[EndIndex + 1], (*Count - EndIndex - 1) * sizeof (Ranges[0])); + *Count -= DeltaCount; + + if (LengthLeft != 0) { + Ranges[StartIndex].Length = LengthLeft; + StartIndex++; + } + if (LengthRight != 0) { + Ranges[EndIndex - DeltaCount].BaseAddress = BaseAddress + Length; + Ranges[EndIndex - DeltaCount].Length = LengthRight; + Ranges[EndIndex - DeltaCount].Type = Ranges[EndIndex].Type; + } + Ranges[StartIndex].BaseAddress = BaseAddress; + Ranges[StartIndex].Length = Length; + Ranges[StartIndex].Type = Type; + return RETURN_SUCCESS; +} - @param MtrrType1 the first kind of Memory type - @param MtrrType2 the second kind of memory type +/** + Allocate one or more variable MTRR to cover the range identified by + BaseAddress and Length. + + @param Ranges Memory range array holding the memory type + settings for all memory address. + @param RangeCount Count of memory ranges. + @param VariableMtrr Variable MTRR array. + @param VariableMtrrCapacity Capacity of variable MTRR array. + @param VariableMtrrCount Count of variable MTRR. + @param BaseAddress Base address of the memory range. + @param Length Length of the memory range. + @param Type MTRR type of the memory range. + @param Alignment0 Alignment of 0. + + @retval RETURN_SUCCESS Variable MTRRs are allocated successfully. + @retval RETURN_OUT_OF_RESOURCES Count of variable MTRRs exceeds capacity. +**/ +RETURN_STATUS +MtrrLibSetMemoryAttributeInVariableMtrr ( + IN CONST MEMORY_RANGE *Ranges, + IN UINT32 RangeCount, + IN OUT VARIABLE_MTRR *VariableMtrr, + IN UINT32 VariableMtrrCapacity, + IN OUT UINT32 *VariableMtrrCount, + IN UINT64 BaseAddress, + IN UINT64 Length, + IN MTRR_MEMORY_CACHE_TYPE Type, + IN UINT64 Alignment0 + ); +/** + Allocate one or more variable MTRR to cover the range identified by + BaseAddress and Length. + + The routine recursively calls MtrrLibSetMemoryAttributeInVariableMtrr() + to allocate variable MTRRs when the range contains several sub-ranges + with different attributes. + + @param Ranges Memory range array holding the memory type + settings for all memory address. + @param RangeCount Count of memory ranges. + @param VariableMtrr Variable MTRR array. + @param VariableMtrrCapacity Capacity of variable MTRR array. + @param VariableMtrrCount Count of variable MTRR. + @param BaseAddress Base address of the memory range. + @param Length Length of the memory range. + @param Type MTRR type of the range. + If it's CacheInvalid, the memory range may + contains several sub-ranges with different + attributes. + @param Alignment0 Alignment of 0. + + @retval RETURN_SUCCESS Variable MTRRs are allocated successfully. + @retval RETURN_OUT_OF_RESOURCES Count of variable MTRRs exceeds capacity. **/ -UINT64 -MtrrPrecedence ( - UINT64 MtrrType1, - UINT64 MtrrType2 - ) +RETURN_STATUS +MtrrLibAddVariableMtrr ( + IN CONST MEMORY_RANGE *Ranges, + IN UINT32 RangeCount, + IN OUT VARIABLE_MTRR *VariableMtrr, + IN UINT32 VariableMtrrCapacity, + IN OUT UINT32 *VariableMtrrCount, + IN PHYSICAL_ADDRESS BaseAddress, + IN UINT64 Length, + IN MTRR_MEMORY_CACHE_TYPE Type, + IN UINT64 Alignment0 +) { - UINT64 MtrrType; - - MtrrType = MTRR_CACHE_INVALID_TYPE; - switch (MtrrType1) { - case MTRR_CACHE_UNCACHEABLE: - MtrrType = MTRR_CACHE_UNCACHEABLE; - break; - case MTRR_CACHE_WRITE_COMBINING: - if ( - MtrrType2==MTRR_CACHE_WRITE_COMBINING || - MtrrType2==MTRR_CACHE_UNCACHEABLE - ) { - MtrrType = MtrrType2; + RETURN_STATUS Status; + UINT32 Index; + UINT64 SubLength; + + MTRR_LIB_ASSERT_ALIGNED (BaseAddress, Length); + if (Type == CacheInvalid) { + ASSERT (Ranges != NULL); + for (Index = 0; Index < RangeCount; Index++) { + if (Ranges[Index].BaseAddress <= BaseAddress && BaseAddress < Ranges[Index].BaseAddress + Ranges[Index].Length) { + + // + // Because the Length may not be aligned to BaseAddress, below code calls + // MtrrLibSetMemoryAttributeInVariableMtrr() instead of itself. + // MtrrLibSetMemoryAttributeInVariableMtrr() splits the range to several + // aligned ranges. + // + if (Ranges[Index].BaseAddress + Ranges[Index].Length >= BaseAddress + Length) { + return MtrrLibSetMemoryAttributeInVariableMtrr ( + Ranges, RangeCount, VariableMtrr, VariableMtrrCapacity, VariableMtrrCount, + BaseAddress, Length, Ranges[Index].Type, Alignment0 + ); + } else { + SubLength = Ranges[Index].BaseAddress + Ranges[Index].Length - BaseAddress; + Status = MtrrLibSetMemoryAttributeInVariableMtrr ( + Ranges, RangeCount, VariableMtrr, VariableMtrrCapacity, VariableMtrrCount, + BaseAddress, SubLength, Ranges[Index].Type, Alignment0 + ); + if (RETURN_ERROR (Status)) { + return Status; + } + BaseAddress += SubLength; + Length -= SubLength; + } + } } - break; - case MTRR_CACHE_WRITE_THROUGH: - if ( - MtrrType2==MTRR_CACHE_WRITE_THROUGH || - MtrrType2==MTRR_CACHE_WRITE_BACK - ) { - MtrrType = MTRR_CACHE_WRITE_THROUGH; - } else if(MtrrType2==MTRR_CACHE_UNCACHEABLE) { - MtrrType = MTRR_CACHE_UNCACHEABLE; + + // + // Because memory ranges cover all the memory addresses, it's impossible to be here. + // + ASSERT (FALSE); + return RETURN_DEVICE_ERROR; + } else { + for (Index = 0; Index < *VariableMtrrCount; Index++) { + if (VariableMtrr[Index].BaseAddress == BaseAddress && VariableMtrr[Index].Length == Length) { + ASSERT (VariableMtrr[Index].Type == Type); + break; + } } - break; - case MTRR_CACHE_WRITE_PROTECTED: - if (MtrrType2 == MTRR_CACHE_WRITE_PROTECTED || - MtrrType2 == MTRR_CACHE_UNCACHEABLE) { - MtrrType = MtrrType2; + if (Index == *VariableMtrrCount) { + if (*VariableMtrrCount == VariableMtrrCapacity) { + return RETURN_OUT_OF_RESOURCES; + } + VariableMtrr[Index].BaseAddress = BaseAddress; + VariableMtrr[Index].Length = Length; + VariableMtrr[Index].Type = Type; + VariableMtrr[Index].Valid = TRUE; + VariableMtrr[Index].Used = TRUE; + (*VariableMtrrCount)++; } - break; - case MTRR_CACHE_WRITE_BACK: - if ( - MtrrType2== MTRR_CACHE_UNCACHEABLE || - MtrrType2==MTRR_CACHE_WRITE_THROUGH || - MtrrType2== MTRR_CACHE_WRITE_BACK - ) { - MtrrType = MtrrType2; + return RETURN_SUCCESS; + } +} + +/** + Allocate one or more variable MTRR to cover the range identified by + BaseAddress and Length. + + @param Ranges Memory range array holding the memory type + settings for all memory address. + @param RangeCount Count of memory ranges. + @param VariableMtrr Variable MTRR array. + @param VariableMtrrCapacity Capacity of variable MTRR array. + @param VariableMtrrCount Count of variable MTRR. + @param BaseAddress Base address of the memory range. + @param Length Length of the memory range. + @param Type MTRR type of the memory range. + @param Alignment0 Alignment of 0. + + @retval RETURN_SUCCESS Variable MTRRs are allocated successfully. + @retval RETURN_OUT_OF_RESOURCES Count of variable MTRRs exceeds capacity. +**/ +RETURN_STATUS +MtrrLibSetMemoryAttributeInVariableMtrr ( + IN CONST MEMORY_RANGE *Ranges, + IN UINT32 RangeCount, + IN OUT VARIABLE_MTRR *VariableMtrr, + IN UINT32 VariableMtrrCapacity, + IN OUT UINT32 *VariableMtrrCount, + IN UINT64 BaseAddress, + IN UINT64 Length, + IN MTRR_MEMORY_CACHE_TYPE Type, + IN UINT64 Alignment0 +) +{ + UINT64 Alignment; + UINT32 MtrrNumber; + UINT32 SubtractiveLeft; + UINT32 SubtractiveRight; + BOOLEAN UseLeastAlignment; + + Alignment = 0; + + MtrrNumber = MtrrLibGetMtrrNumber (Ranges, RangeCount, VariableMtrr, *VariableMtrrCount, + BaseAddress, Length, Type, Alignment0, &SubtractiveLeft, &SubtractiveRight); + + if (MtrrNumber + *VariableMtrrCount > VariableMtrrCapacity) { + return RETURN_OUT_OF_RESOURCES; + } + + while (SubtractiveLeft-- != 0) { + Alignment = MtrrLibLeastAlignment (BaseAddress, Alignment0); + ASSERT (Alignment <= Length); + + MtrrLibAddVariableMtrr (Ranges, RangeCount, VariableMtrr, VariableMtrrCapacity, VariableMtrrCount, + BaseAddress - Alignment, Alignment, CacheInvalid, Alignment0); + BaseAddress -= Alignment; + Length += Alignment; + } + + while (Length != 0) { + Alignment = MtrrLibLeastAlignment (BaseAddress, Alignment0); + if (Alignment > Length) { + break; } - break; - case MTRR_CACHE_INVALID_TYPE: - MtrrType = MtrrType2; - break; - default: - break; + MtrrLibAddVariableMtrr (NULL, 0, VariableMtrr, VariableMtrrCapacity, VariableMtrrCount, + BaseAddress, Alignment, Type, Alignment0); + BaseAddress += Alignment; + Length -= Alignment; } - if (MtrrType2 == MTRR_CACHE_INVALID_TYPE) { - MtrrType = MtrrType1; + while (SubtractiveRight-- != 0) { + Alignment = MtrrLibLeastAlignment (BaseAddress + Length, Alignment0); + MtrrLibAddVariableMtrr (Ranges, RangeCount, VariableMtrr, VariableMtrrCapacity, VariableMtrrCount, + BaseAddress + Length, Alignment, CacheInvalid, Alignment0); + Length += Alignment; } - return MtrrType; + + UseLeastAlignment = TRUE; + while (Length != 0) { + if (UseLeastAlignment) { + Alignment = MtrrLibLeastAlignment (BaseAddress, Alignment0); + if (Alignment > Length) { + UseLeastAlignment = FALSE; + } + } + + if (!UseLeastAlignment) { + Alignment = GetPowerOfTwo64 (Length); + } + + MtrrLibAddVariableMtrr (NULL, 0, VariableMtrr, VariableMtrrCapacity, VariableMtrrCount, + BaseAddress, Alignment, Type, Alignment0); + BaseAddress += Alignment; + Length -= Alignment; + } + return RETURN_SUCCESS; } +/** + Return an array of memory ranges holding memory type settings for all memory + address. + + @param DefaultType The default memory type. + @param TotalLength The total length of the memory. + @param VariableMtrr The variable MTRR array. + @param VariableMtrrCount The count of variable MTRRs. + @param Ranges Return the memory range array holding memory type + settings for all memory address. + @param RangeCapacity The capacity of memory range array. + @param RangeCount Return the count of memory range. + + @retval RETURN_SUCCESS The memory range array is returned successfully. + @retval RETURN_OUT_OF_RESOURCES The count of memory ranges exceeds capacity. +**/ +RETURN_STATUS +MtrrLibGetMemoryTypes ( + IN MTRR_MEMORY_CACHE_TYPE DefaultType, + IN UINT64 TotalLength, + IN CONST VARIABLE_MTRR *VariableMtrr, + IN UINT32 VariableMtrrCount, + OUT MEMORY_RANGE *Ranges, + IN UINT32 RangeCapacity, + OUT UINT32 *RangeCount +) +{ + RETURN_STATUS Status; + UINTN Index; + + // + // WT > WB + // UC > * + // UC > * (except WB, UC) > WB + // + + // + // 0. Set whole range as DefaultType + // + *RangeCount = 1; + Ranges[0].BaseAddress = 0; + Ranges[0].Length = TotalLength; + Ranges[0].Type = DefaultType; + + // + // 1. Set WB + // + for (Index = 0; Index < VariableMtrrCount; Index++) { + if (VariableMtrr[Index].Valid && VariableMtrr[Index].Type == CacheWriteBack) { + Status = MtrrLibSetMemoryType ( + Ranges, RangeCapacity, RangeCount, + VariableMtrr[Index].BaseAddress, VariableMtrr[Index].Length, (MTRR_MEMORY_CACHE_TYPE) VariableMtrr[Index].Type + ); + if (RETURN_ERROR (Status)) { + return Status; + } + } + } + + // + // 2. Set other types than WB or UC + // + for (Index = 0; Index < VariableMtrrCount; Index++) { + if (VariableMtrr[Index].Valid && VariableMtrr[Index].Type != CacheWriteBack && VariableMtrr[Index].Type != CacheUncacheable) { + Status = MtrrLibSetMemoryType ( + Ranges, RangeCapacity, RangeCount, + VariableMtrr[Index].BaseAddress, VariableMtrr[Index].Length, (MTRR_MEMORY_CACHE_TYPE) VariableMtrr[Index].Type + ); + if (RETURN_ERROR (Status)) { + return Status; + } + } + } + + // + // 3. Set UC + // + for (Index = 0; Index < VariableMtrrCount; Index++) { + if (VariableMtrr[Index].Valid && VariableMtrr[Index].Type == CacheUncacheable) { + Status = MtrrLibSetMemoryType ( + Ranges, RangeCapacity, RangeCount, + VariableMtrr[Index].BaseAddress, VariableMtrr[Index].Length, (MTRR_MEMORY_CACHE_TYPE) VariableMtrr[Index].Type + ); + if (RETURN_ERROR (Status)) { + return Status; + } + } + } + return RETURN_SUCCESS; +} /** - This function attempts to set the attributes for a memory range. + Worker function attempts to set the attributes for a memory range. + + If MtrrSetting is not NULL, set the attributes into the input MTRR + settings buffer. + If MtrrSetting is NULL, set the attributes into MTRRs registers. - @param BaseAddress The physical address that is the start - address of a memory region. - @param Length The size in bytes of the memory region. - @param Attributes The bit mask of attributes to set for the - memory region. + @param[in, out] MtrrSetting A buffer holding all MTRRs content. + @param[in] BaseAddress The physical address that is the start + address of a memory range. + @param[in] Length The size in bytes of the memory range. + @param[in] Type The MTRR type to set for the memory range. @retval RETURN_SUCCESS The attributes were set for the memory - region. + range. @retval RETURN_INVALID_PARAMETER Length is zero. @retval RETURN_UNSUPPORTED The processor does not support one or more bytes of the memory resource range specified by BaseAddress and Length. - @retval RETURN_UNSUPPORTED The bit mask of attributes is not support - for the memory resource range specified + @retval RETURN_UNSUPPORTED The MTRR type is not support for the + memory resource range specified by BaseAddress and Length. - @retval RETURN_ACCESS_DENIED The attributes for the memory resource - 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 -EFIAPI -MtrrSetMemoryAttribute ( - IN PHYSICAL_ADDRESS BaseAddress, - IN UINT64 Length, - IN MTRR_MEMORY_CACHE_TYPE Attribute +MtrrSetMemoryAttributeWorker ( + IN OUT MTRR_SETTINGS *MtrrSetting, + IN PHYSICAL_ADDRESS BaseAddress, + IN UINT64 Length, + IN MTRR_MEMORY_CACHE_TYPE Type ) { - UINT64 TempQword; RETURN_STATUS Status; - UINT64 MemoryType; - UINT64 Remainder; - BOOLEAN OverLap; - BOOLEAN Positive; - UINT32 MsrNum; - UINTN MtrrNumber; - VARIABLE_MTRR VariableMtrr[MTRR_NUMBER_OF_VARIABLE_MTRR]; - UINT32 UsedMtrr; + UINT32 Index; + UINT32 WorkingIndex; + // + // N variable MTRRs can maximumly separate (2N + 1) Ranges, plus 1 range for [0, 1M). + // + MEMORY_RANGE Ranges[MTRR_NUMBER_OF_VARIABLE_MTRR * 2 + 2]; + UINT32 RangeCount; UINT64 MtrrValidBitsMask; UINT64 MtrrValidAddressMask; - UINTN Cr4; - BOOLEAN OverwriteExistingMtrr; - UINT32 FirmwareVariableMtrrCount; - UINT32 VariableMtrrEnd; + UINT64 Alignment0; + MTRR_CONTEXT MtrrContext; + BOOLEAN MtrrContextValid; - if (!IsMtrrSupported ()) { - return RETURN_UNSUPPORTED; - } - - FirmwareVariableMtrrCount = GetFirmwareVariableMtrrCount (); - VariableMtrrEnd = MTRR_LIB_IA32_VARIABLE_MTRR_BASE + (2 * GetVariableMtrrCount ()) - 1; + MTRR_MEMORY_CACHE_TYPE DefaultType; - MtrrLibInitializeMtrrMask(&MtrrValidBitsMask, &MtrrValidAddressMask); + UINT32 MsrIndex; + UINT64 ClearMask; + UINT64 OrMask; + UINT64 NewValue; + BOOLEAN FixedSettingsValid[MTRR_NUMBER_OF_FIXED_MTRR]; + BOOLEAN FixedSettingsModified[MTRR_NUMBER_OF_FIXED_MTRR]; + MTRR_FIXED_SETTINGS WorkingFixedSettings; - TempQword = 0; - MemoryType = (UINT64)Attribute; - OverwriteExistingMtrr = FALSE; + UINT32 FirmwareVariableMtrrCount; + MTRR_VARIABLE_SETTINGS *VariableSettings; + MTRR_VARIABLE_SETTINGS OriginalVariableSettings; + UINT32 OriginalVariableMtrrCount; + VARIABLE_MTRR OriginalVariableMtrr[MTRR_NUMBER_OF_VARIABLE_MTRR]; + UINT32 WorkingVariableMtrrCount; + VARIABLE_MTRR WorkingVariableMtrr[MTRR_NUMBER_OF_VARIABLE_MTRR]; + BOOLEAN VariableSettingModified[MTRR_NUMBER_OF_VARIABLE_MTRR]; + UINTN FreeVariableMtrrCount; - // - // Check for an invalid parameter - // if (Length == 0) { return RETURN_INVALID_PARAMETER; } - if ( - (BaseAddress &~MtrrValidAddressMask) != 0 || - (Length &~MtrrValidAddressMask) != 0 - ) { + MtrrLibInitializeMtrrMask (&MtrrValidBitsMask, &MtrrValidAddressMask); + if (((BaseAddress & ~MtrrValidAddressMask) != 0) || (Length & ~MtrrValidAddressMask) != 0) { return RETURN_UNSUPPORTED; } + OriginalVariableMtrrCount = 0; + VariableSettings = NULL; + + ZeroMem (&WorkingFixedSettings, sizeof (WorkingFixedSettings)); + for (Index = 0; Index < MTRR_NUMBER_OF_FIXED_MTRR; Index++) { + FixedSettingsValid[Index] = FALSE; + FixedSettingsModified[Index] = FALSE; + } // // Check if Fixed MTRR // - Status = RETURN_SUCCESS; - while ((BaseAddress < BASE_1MB) && (Length > 0) && Status == RETURN_SUCCESS) { - Cr4 = PreMtrrChange (); - Status = ProgramFixedMtrr (MemoryType, &BaseAddress, &Length); - PostMtrrChange (Cr4); - if (RETURN_ERROR (Status)) { - return Status; + if (BaseAddress < BASE_1MB) { + MsrIndex = (UINT32)-1; + while ((BaseAddress < BASE_1MB) && (Length != 0)) { + Status = MtrrLibProgramFixedMtrr (Type, &BaseAddress, &Length, &MsrIndex, &ClearMask, &OrMask); + if (RETURN_ERROR (Status)) { + return Status; + } + if (MtrrSetting != NULL) { + MtrrSetting->Fixed.Mtrr[MsrIndex] = (MtrrSetting->Fixed.Mtrr[MsrIndex] & ~ClearMask) | OrMask; + ((MSR_IA32_MTRR_DEF_TYPE_REGISTER *) &MtrrSetting->MtrrDefType)->Bits.FE = 1; + } else { + if (!FixedSettingsValid[MsrIndex]) { + WorkingFixedSettings.Mtrr[MsrIndex] = AsmReadMsr64 (mMtrrLibFixedMtrrTable[MsrIndex].Msr); + FixedSettingsValid[MsrIndex] = TRUE; + } + NewValue = (WorkingFixedSettings.Mtrr[MsrIndex] & ~ClearMask) | OrMask; + if (WorkingFixedSettings.Mtrr[MsrIndex] != NewValue) { + WorkingFixedSettings.Mtrr[MsrIndex] = NewValue; + FixedSettingsModified[MsrIndex] = TRUE; + } + } } - } - if (Length == 0) { - // - // A Length of 0 can only make sense for fixed MTTR ranges. - // Since we just handled the fixed MTRRs, we can skip the - // variable MTRR section. - // - goto Done; + if (Length == 0) { + // + // A Length of 0 can only make sense for fixed MTTR ranges. + // Since we just handled the fixed MTRRs, we can skip the + // variable MTRR section. + // + goto Done; + } } // - // Since memory ranges below 1MB will be overridden by the fixed MTRRs, - // we can set the bade to 0 to save variable MTRRs. + // Read the default MTRR type // - if (BaseAddress == BASE_1MB) { - BaseAddress = 0; - Length += SIZE_1MB; - } + DefaultType = MtrrGetDefaultMemoryTypeWorker (MtrrSetting); // - // Check memory base address alignment + // Read all variable MTRRs and convert to Ranges. // - DivU64x64Remainder (BaseAddress, Power2MaxMemory (LShiftU64 (Length, 1)), &Remainder); - if (Remainder != 0) { - DivU64x64Remainder (BaseAddress, Power2MaxMemory (Length), &Remainder); - if (Remainder != 0) { - Status = RETURN_UNSUPPORTED; - goto Done; - } + OriginalVariableMtrrCount = GetVariableMtrrCountWorker (); + if (MtrrSetting == NULL) { + ZeroMem (&OriginalVariableSettings, sizeof (OriginalVariableSettings)); + MtrrGetVariableMtrrWorker (NULL, OriginalVariableMtrrCount, &OriginalVariableSettings); + VariableSettings = &OriginalVariableSettings; + } else { + VariableSettings = &MtrrSetting->Variables; } + MtrrGetMemoryAttributeInVariableMtrrWorker (VariableSettings, OriginalVariableMtrrCount, MtrrValidBitsMask, MtrrValidAddressMask, OriginalVariableMtrr); + + Status = MtrrLibGetMemoryTypes ( + DefaultType, MtrrValidBitsMask + 1, OriginalVariableMtrr, OriginalVariableMtrrCount, + Ranges, 2 * OriginalVariableMtrrCount + 1, &RangeCount + ); + ASSERT (Status == RETURN_SUCCESS); + + FirmwareVariableMtrrCount = GetFirmwareVariableMtrrCountWorker (); + ASSERT (RangeCount <= 2 * FirmwareVariableMtrrCount + 1); // - // Check for overlap + // Force [0, 1M) to UC, so that it doesn't impact left subtraction algorithm. // - UsedMtrr = MtrrGetMemoryAttributeInVariableMtrr (MtrrValidBitsMask, MtrrValidAddressMask, VariableMtrr); - OverLap = CheckMemoryAttributeOverlap (BaseAddress, BaseAddress + Length - 1, VariableMtrr); - if (OverLap) { - Status = CombineMemoryAttribute (MemoryType, &BaseAddress, &Length, VariableMtrr, &UsedMtrr, &OverwriteExistingMtrr); - if (RETURN_ERROR (Status)) { - goto Done; - } + Status = MtrrLibSetMemoryType (Ranges, 2 * FirmwareVariableMtrrCount + 2, &RangeCount, 0, SIZE_1MB, CacheUncacheable); + ASSERT (Status == RETURN_SUCCESS); + // + // Apply Type to [BaseAddress, BaseAddress + Length) + // + Status = MtrrLibSetMemoryType (Ranges, 2 * FirmwareVariableMtrrCount + 2, &RangeCount, BaseAddress, Length, Type); + if (RETURN_ERROR (Status)) { + return Status; + } - if (Length == 0) { + Alignment0 = LShiftU64 (1, (UINTN) HighBitSet64 (MtrrValidBitsMask)); + WorkingVariableMtrrCount = 0; + ZeroMem (&WorkingVariableMtrr, sizeof (WorkingVariableMtrr)); + for (Index = 0; Index < RangeCount; Index++) { + if (Ranges[Index].Type != DefaultType) { // - // Combined successfully + // Maximum allowed MTRR count is (FirmwareVariableMtrrCount + 1) + // Because potentially the range [0, 1MB) is not merged, but can be ignored because fixed MTRR covers that // - Status = RETURN_SUCCESS; - goto Done; + Status = MtrrLibSetMemoryAttributeInVariableMtrr ( + Ranges, RangeCount, + WorkingVariableMtrr, FirmwareVariableMtrrCount + 1, &WorkingVariableMtrrCount, + Ranges[Index].BaseAddress, Ranges[Index].Length, + Ranges[Index].Type, Alignment0 + ); + if (RETURN_ERROR (Status)) { + return Status; + } } } // - // Program Variable MTRRs - // - // Avoid hardcode here and read data dynamically + // Remove the [0, 1MB) MTRR if it still exists (not merged with other range) // - if (UsedMtrr >= FirmwareVariableMtrrCount) { - Status = RETURN_OUT_OF_RESOURCES; - goto Done; + if (WorkingVariableMtrr[0].BaseAddress == 0 && WorkingVariableMtrr[0].Length == SIZE_1MB) { + ASSERT (WorkingVariableMtrr[0].Type == CacheUncacheable); + WorkingVariableMtrrCount--; + CopyMem (&WorkingVariableMtrr[0], &WorkingVariableMtrr[1], WorkingVariableMtrrCount * sizeof (VARIABLE_MTRR)); } - // - // The memory type is the same with the type specified by - // MTRR_LIB_IA32_MTRR_DEF_TYPE. - // - if ((!OverwriteExistingMtrr) && (Attribute == GetMtrrDefaultMemoryType ())) { - // - // Invalidate the now-unused MTRRs - // - InvalidateMtrr(VariableMtrr); - goto Done; + if (WorkingVariableMtrrCount > FirmwareVariableMtrrCount) { + return RETURN_OUT_OF_RESOURCES; } - TempQword = Length; - - - if (TempQword == Power2MaxMemory (TempQword)) { - // - // Invalidate the now-unused MTRRs - // - InvalidateMtrr(VariableMtrr); + for (Index = 0; Index < OriginalVariableMtrrCount; Index++) { + VariableSettingModified[Index] = FALSE; - // - // Find first unused MTRR - // - for (MsrNum = MTRR_LIB_IA32_VARIABLE_MTRR_BASE; - MsrNum < VariableMtrrEnd; - MsrNum += 2 - ) { - if ((AsmReadMsr64 (MsrNum + 1) & MTRR_LIB_CACHE_MTRR_ENABLED) == 0) { + if (!OriginalVariableMtrr[Index].Valid) { + continue; + } + for (WorkingIndex = 0; WorkingIndex < WorkingVariableMtrrCount; WorkingIndex++) { + if (OriginalVariableMtrr[Index].BaseAddress == WorkingVariableMtrr[WorkingIndex].BaseAddress && + OriginalVariableMtrr[Index].Length == WorkingVariableMtrr[WorkingIndex].Length && + OriginalVariableMtrr[Index].Type == WorkingVariableMtrr[WorkingIndex].Type) { break; } } - ProgramVariableMtrr ( - MsrNum, - BaseAddress, - Length, - MemoryType, - MtrrValidAddressMask - ); - } else { - - Positive = GetDirection (TempQword, &MtrrNumber); - - if ((UsedMtrr + MtrrNumber) > FirmwareVariableMtrrCount) { - Status = RETURN_OUT_OF_RESOURCES; - goto Done; + if (WorkingIndex == WorkingVariableMtrrCount) { + // + // Remove the one from OriginalVariableMtrr which is not in WorkingVariableMtrr + // + OriginalVariableMtrr[Index].Valid = FALSE; + VariableSettingModified[Index] = TRUE; + } else { + // + // Remove the one from WorkingVariableMtrr which is also in OriginalVariableMtrr + // + WorkingVariableMtrr[WorkingIndex].Valid = FALSE; } - // - // Invalidate the now-unused MTRRs + // The above two operations cause that valid MTRR only exists in either OriginalVariableMtrr or WorkingVariableMtrr. // - InvalidateMtrr(VariableMtrr); - - // - // Find first unused MTRR - // - for (MsrNum = MTRR_LIB_IA32_VARIABLE_MTRR_BASE; - MsrNum < VariableMtrrEnd; - MsrNum += 2 - ) { - if ((AsmReadMsr64 (MsrNum + 1) & MTRR_LIB_CACHE_MTRR_ENABLED) == 0) { - break; - } - } - - if (!Positive) { - Length = Power2MaxMemory (LShiftU64 (TempQword, 1)); - ProgramVariableMtrr ( - MsrNum, - BaseAddress, - Length, - MemoryType, - MtrrValidAddressMask - ); - BaseAddress += Length; - TempQword = Length - TempQword; - MemoryType = MTRR_CACHE_UNCACHEABLE; - } + } - do { - // - // Find unused MTRR - // - for (; MsrNum < VariableMtrrEnd; MsrNum += 2) { - if ((AsmReadMsr64 (MsrNum + 1) & MTRR_LIB_CACHE_MTRR_ENABLED) == 0) { + // + // Merge remaining MTRRs from WorkingVariableMtrr to OriginalVariableMtrr + // + for (FreeVariableMtrrCount = 0, WorkingIndex = 0, Index = 0; Index < OriginalVariableMtrrCount; Index++) { + if (!OriginalVariableMtrr[Index].Valid) { + for (; WorkingIndex < WorkingVariableMtrrCount; WorkingIndex++) { + if (WorkingVariableMtrr[WorkingIndex].Valid) { break; } } - - Length = Power2MaxMemory (TempQword); - if (!Positive) { - BaseAddress -= Length; - } - - ProgramVariableMtrr ( - MsrNum, - BaseAddress, - Length, - MemoryType, - MtrrValidAddressMask - ); - - if (Positive) { - BaseAddress += Length; + if (WorkingIndex == WorkingVariableMtrrCount) { + FreeVariableMtrrCount++; + } else { + CopyMem (&OriginalVariableMtrr[Index], &WorkingVariableMtrr[WorkingIndex], sizeof (VARIABLE_MTRR)); + VariableSettingModified[Index] = TRUE; + WorkingIndex++; } - TempQword -= Length; - - } while (TempQword > 0); + } } + ASSERT (OriginalVariableMtrrCount - FreeVariableMtrrCount <= FirmwareVariableMtrrCount); -Done: - return Status; - -} - - -/** - This function will get the memory cache type of the specific address. - - This function is mainly for debug purpose. - - @param Address The specific address - - @return Memory cache type of the sepcific address - -**/ -MTRR_MEMORY_CACHE_TYPE -EFIAPI -MtrrGetMemoryAttribute ( - IN PHYSICAL_ADDRESS Address - ) -{ - UINT64 TempQword; - UINTN Index; - UINTN SubIndex; - UINT64 MtrrType; - UINT64 TempMtrrType; - MTRR_MEMORY_CACHE_TYPE CacheType; - VARIABLE_MTRR VariableMtrr[MTRR_NUMBER_OF_VARIABLE_MTRR]; - UINT64 MtrrValidBitsMask; - UINT64 MtrrValidAddressMask; - UINTN VariableMtrrCount; + // + // Move MTRRs after the FirmwareVariableMtrrCount position to beginning + // + if (FirmwareVariableMtrrCount < OriginalVariableMtrrCount) { + WorkingIndex = FirmwareVariableMtrrCount; + for (Index = 0; Index < FirmwareVariableMtrrCount; Index++) { + if (!OriginalVariableMtrr[Index].Valid) { + // + // Found an empty MTRR in WorkingIndex position + // + for (; WorkingIndex < OriginalVariableMtrrCount; WorkingIndex++) { + if (OriginalVariableMtrr[WorkingIndex].Valid) { + break; + } + } - if (!IsMtrrSupported ()) { - return CacheUncacheable; + if (WorkingIndex != OriginalVariableMtrrCount) { + CopyMem (&OriginalVariableMtrr[Index], &OriginalVariableMtrr[WorkingIndex], sizeof (VARIABLE_MTRR)); + VariableSettingModified[Index] = TRUE; + VariableSettingModified[WorkingIndex] = TRUE; + OriginalVariableMtrr[WorkingIndex].Valid = FALSE; + } + } + } } // - // Check if MTRR is enabled, if not, return UC as attribute + // Convert OriginalVariableMtrr to VariableSettings + // NOTE: MTRR from FirmwareVariableMtrr to OriginalVariableMtrr need to update as well. // - TempQword = AsmReadMsr64 (MTRR_LIB_IA32_MTRR_DEF_TYPE); - MtrrType = MTRR_CACHE_INVALID_TYPE; + for (Index = 0; Index < OriginalVariableMtrrCount; Index++) { + if (VariableSettingModified[Index]) { + if (OriginalVariableMtrr[Index].Valid) { + VariableSettings->Mtrr[Index].Base = (OriginalVariableMtrr[Index].BaseAddress & MtrrValidAddressMask) | (UINT8) OriginalVariableMtrr[Index].Type; + VariableSettings->Mtrr[Index].Mask = ((~(OriginalVariableMtrr[Index].Length - 1)) & MtrrValidAddressMask) | BIT11; + } else { + VariableSettings->Mtrr[Index].Base = 0; + VariableSettings->Mtrr[Index].Mask = 0; + } + } + } - if ((TempQword & MTRR_LIB_CACHE_MTRR_ENABLED) == 0) { - return CacheUncacheable; +Done: + if (MtrrSetting != NULL) { + ((MSR_IA32_MTRR_DEF_TYPE_REGISTER *) &MtrrSetting->MtrrDefType)->Bits.E = 1; + return RETURN_SUCCESS; } + MtrrContextValid = FALSE; // - // If address is less than 1M, then try to go through the fixed MTRR + // Write fixed MTRRs that have been modified // - if (Address < BASE_1MB) { - if ((TempQword & MTRR_LIB_CACHE_FIXED_MTRR_ENABLED) != 0) { - // - // Go through the fixed MTRR - // - for (Index = 0; Index < MTRR_NUMBER_OF_FIXED_MTRR; Index++) { - if (Address >= MtrrLibFixedMtrrTable[Index].BaseAddress && - Address < ( - MtrrLibFixedMtrrTable[Index].BaseAddress + - (MtrrLibFixedMtrrTable[Index].Length * 8) - ) - ) { - SubIndex = - ((UINTN)Address - MtrrLibFixedMtrrTable[Index].BaseAddress) / - MtrrLibFixedMtrrTable[Index].Length; - TempQword = AsmReadMsr64 (MtrrLibFixedMtrrTable[Index].Msr); - MtrrType = RShiftU64 (TempQword, SubIndex * 8) & 0xFF; - return GetMemoryCacheTypeFromMtrrType (MtrrType); - } + for (Index = 0; Index < MTRR_NUMBER_OF_FIXED_MTRR; Index++) { + if (FixedSettingsModified[Index]) { + if (!MtrrContextValid) { + MtrrLibPreMtrrChange (&MtrrContext); + MtrrContextValid = TRUE; } + AsmWriteMsr64 ( + mMtrrLibFixedMtrrTable[Index].Msr, + WorkingFixedSettings.Mtrr[Index] + ); } } - MtrrLibInitializeMtrrMask(&MtrrValidBitsMask, &MtrrValidAddressMask); - MtrrGetMemoryAttributeInVariableMtrr( - MtrrValidBitsMask, - MtrrValidAddressMask, - VariableMtrr - ); // - // Go through the variable MTRR + // Write variable MTRRs + // When only fixed MTRRs were changed, below loop doesn't run + // because OriginalVariableMtrrCount equals to 0. // - VariableMtrrCount = GetVariableMtrrCount (); - ASSERT (VariableMtrrCount <= MTRR_NUMBER_OF_VARIABLE_MTRR); - - for (Index = 0; Index < VariableMtrrCount; Index++) { - if (VariableMtrr[Index].Valid) { - if (Address >= VariableMtrr[Index].BaseAddress && - Address < VariableMtrr[Index].BaseAddress+VariableMtrr[Index].Length) { - TempMtrrType = VariableMtrr[Index].Type; - MtrrType = MtrrPrecedence (MtrrType, TempMtrrType); + for (Index = 0; Index < OriginalVariableMtrrCount; Index++) { + if (VariableSettingModified[Index]) { + if (!MtrrContextValid) { + MtrrLibPreMtrrChange (&MtrrContext); + MtrrContextValid = TRUE; } + AsmWriteMsr64 ( + MSR_IA32_MTRR_PHYSBASE0 + (Index << 1), + VariableSettings->Mtrr[Index].Base + ); + AsmWriteMsr64 ( + MSR_IA32_MTRR_PHYSMASK0 + (Index << 1), + VariableSettings->Mtrr[Index].Mask + ); } } - CacheType = GetMemoryCacheTypeFromMtrrType (MtrrType); + if (MtrrContextValid) { + MtrrLibPostMtrrChange (&MtrrContext); + } - return CacheType; + return RETURN_SUCCESS; } - /** - This function will get the raw value in variable MTRRs + This function attempts to set the attributes for a memory range. - @param VariableSettings A buffer to hold variable MTRRs content. + @param[in] BaseAddress The physical address that is the start + address of a memory range. + @param[in] Length The size in bytes of the memory range. + @param[in] Attributes The bit mask of attributes to set for the + memory range. - @return The VariableSettings input pointer + @retval RETURN_SUCCESS The attributes were set for the memory + range. + @retval RETURN_INVALID_PARAMETER Length is zero. + @retval RETURN_UNSUPPORTED The processor does not support one or + more bytes of the memory resource range + specified by BaseAddress and Length. + @retval RETURN_UNSUPPORTED The bit mask of attributes is not support + for the memory resource range specified + by BaseAddress and Length. + @retval RETURN_ACCESS_DENIED The attributes for the memory resource + 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. **/ -MTRR_VARIABLE_SETTINGS* +RETURN_STATUS EFIAPI -MtrrGetVariableMtrr ( - OUT MTRR_VARIABLE_SETTINGS *VariableSettings +MtrrSetMemoryAttribute ( + IN PHYSICAL_ADDRESS BaseAddress, + IN UINT64 Length, + IN MTRR_MEMORY_CACHE_TYPE Attribute ) { - UINT32 Index; - UINT32 VariableMtrrCount; + RETURN_STATUS Status; if (!IsMtrrSupported ()) { - return VariableSettings; + return RETURN_UNSUPPORTED; } - VariableMtrrCount = GetVariableMtrrCount (); - ASSERT (VariableMtrrCount <= MTRR_NUMBER_OF_VARIABLE_MTRR); + Status = MtrrSetMemoryAttributeWorker (NULL, BaseAddress, Length, Attribute); + DEBUG ((DEBUG_CACHE, "MtrrSetMemoryAttribute() %a: [%016lx, %016lx) - %r\n", + mMtrrMemoryCacheTypeShortName[Attribute], BaseAddress, BaseAddress + Length, Status)); - for (Index = 0; Index < VariableMtrrCount; Index++) { - VariableSettings->Mtrr[Index].Base = - AsmReadMsr64 (MTRR_LIB_IA32_VARIABLE_MTRR_BASE + (Index << 1)); - VariableSettings->Mtrr[Index].Mask = - AsmReadMsr64 (MTRR_LIB_IA32_VARIABLE_MTRR_BASE + (Index << 1) + 1); + if (!RETURN_ERROR (Status)) { + MtrrDebugPrintAllMtrrsWorker (NULL); } - - return VariableSettings; + return Status; } +/** + This function attempts to set the attributes into MTRR setting buffer for a memory range. + + @param[in, out] MtrrSetting MTRR setting buffer to be set. + @param[in] BaseAddress The physical address that is the start address + of a memory range. + @param[in] Length The size in bytes of the memory range. + @param[in] Attribute The bit mask of attributes to set for the + memory range. + + @retval RETURN_SUCCESS The attributes were set for the memory range. + @retval RETURN_INVALID_PARAMETER Length is zero. + @retval RETURN_UNSUPPORTED The processor does not support one or more bytes of the + memory resource range specified by BaseAddress and Length. + @retval RETURN_UNSUPPORTED The bit mask of attributes is not support for the memory resource + range specified by BaseAddress and Length. + @retval RETURN_ACCESS_DENIED The attributes for the memory resource 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 +EFIAPI +MtrrSetMemoryAttributeInMtrrSettings ( + IN OUT MTRR_SETTINGS *MtrrSetting, + IN PHYSICAL_ADDRESS BaseAddress, + IN UINT64 Length, + IN MTRR_MEMORY_CACHE_TYPE Attribute + ) +{ + RETURN_STATUS Status; + Status = MtrrSetMemoryAttributeWorker (MtrrSetting, BaseAddress, Length, Attribute); + DEBUG((DEBUG_CACHE, "MtrrSetMemoryAttributeMtrrSettings(%p) %a: [%016lx, %016lx) - %r\n", + MtrrSetting, mMtrrMemoryCacheTypeShortName[Attribute], BaseAddress, BaseAddress + Length, Status)); + + if (!RETURN_ERROR (Status)) { + MtrrDebugPrintAllMtrrsWorker (MtrrSetting); + } + + return Status; +} /** 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 @@ -1247,16 +2227,16 @@ MtrrSetVariableMtrrWorker ( UINT32 Index; UINT32 VariableMtrrCount; - VariableMtrrCount = GetVariableMtrrCount (); + VariableMtrrCount = GetVariableMtrrCountWorker (); ASSERT (VariableMtrrCount <= MTRR_NUMBER_OF_VARIABLE_MTRR); for (Index = 0; Index < VariableMtrrCount; Index++) { AsmWriteMsr64 ( - MTRR_LIB_IA32_VARIABLE_MTRR_BASE + (Index << 1), + MSR_IA32_MTRR_PHYSBASE0 + (Index << 1), VariableSettings->Mtrr[Index].Base ); AsmWriteMsr64 ( - MTRR_LIB_IA32_VARIABLE_MTRR_BASE + (Index << 1) + 1, + MSR_IA32_MTRR_PHYSMASK0 + (Index << 1), VariableSettings->Mtrr[Index].Mask ); } @@ -1266,7 +2246,7 @@ MtrrSetVariableMtrrWorker ( /** 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 @@ -1277,51 +2257,24 @@ MtrrSetVariableMtrr ( IN MTRR_VARIABLE_SETTINGS *VariableSettings ) { - UINTN Cr4; + MTRR_CONTEXT MtrrContext; if (!IsMtrrSupported ()) { return VariableSettings; } - Cr4 = PreMtrrChange (); + MtrrLibPreMtrrChange (&MtrrContext); MtrrSetVariableMtrrWorker (VariableSettings); - PostMtrrChange (Cr4); - return VariableSettings; -} - - -/** - This function gets the content in fixed MTRRs - - @param FixedSettings A buffer to hold fixed Mtrrs content. - - @retval The pointer of FixedSettings - -**/ -MTRR_FIXED_SETTINGS* -EFIAPI -MtrrGetFixedMtrr ( - OUT MTRR_FIXED_SETTINGS *FixedSettings - ) -{ - UINT32 Index; - - if (!IsMtrrSupported ()) { - return FixedSettings; - } - - for (Index = 0; Index < MTRR_NUMBER_OF_FIXED_MTRR; Index++) { - FixedSettings->Mtrr[Index] = - AsmReadMsr64 (MtrrLibFixedMtrrTable[Index].Msr); - }; + MtrrLibPostMtrrChange (&MtrrContext); + MtrrDebugPrintAllMtrrs (); - return FixedSettings; + return VariableSettings; } /** 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 @@ -1333,7 +2286,7 @@ MtrrSetFixedMtrrWorker ( for (Index = 0; Index < MTRR_NUMBER_OF_FIXED_MTRR; Index++) { AsmWriteMsr64 ( - MtrrLibFixedMtrrTable[Index].Msr, + mMtrrLibFixedMtrrTable[Index].Msr, FixedSettings->Mtrr[Index] ); } @@ -1343,7 +2296,7 @@ MtrrSetFixedMtrrWorker ( /** 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 @@ -1354,15 +2307,16 @@ MtrrSetFixedMtrr ( IN MTRR_FIXED_SETTINGS *FixedSettings ) { - UINTN Cr4; + MTRR_CONTEXT MtrrContext; if (!IsMtrrSupported ()) { return FixedSettings; } - Cr4 = PreMtrrChange (); + MtrrLibPreMtrrChange (&MtrrContext); MtrrSetFixedMtrrWorker (FixedSettings); - PostMtrrChange (Cr4); + MtrrLibPostMtrrChange (&MtrrContext); + MtrrDebugPrintAllMtrrs (); return FixedSettings; } @@ -1371,7 +2325,7 @@ MtrrSetFixedMtrr ( /** 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 @@ -1389,17 +2343,21 @@ MtrrGetAllMtrrs ( // // Get fixed MTRRs // - MtrrGetFixedMtrr (&MtrrSetting->Fixed); + MtrrGetFixedMtrrWorker (&MtrrSetting->Fixed); // // Get variable MTRRs // - MtrrGetVariableMtrr (&MtrrSetting->Variables); + MtrrGetVariableMtrrWorker ( + NULL, + GetVariableMtrrCountWorker (), + &MtrrSetting->Variables + ); // // Get MTRR_DEF_TYPE value // - MtrrSetting->MtrrDefType = AsmReadMsr64 (MTRR_LIB_IA32_MTRR_DEF_TYPE); + MtrrSetting->MtrrDefType = AsmReadMsr64 (MSR_IA32_MTRR_DEF_TYPE); return MtrrSetting; } @@ -1408,7 +2366,7 @@ MtrrGetAllMtrrs ( /** 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 @@ -1419,13 +2377,13 @@ MtrrSetAllMtrrs ( IN MTRR_SETTINGS *MtrrSetting ) { - UINTN Cr4; + MTRR_CONTEXT MtrrContext; if (!IsMtrrSupported ()) { return MtrrSetting; } - Cr4 = PreMtrrChange (); + MtrrLibPreMtrrChange (&MtrrContext); // // Set fixed MTRRs @@ -1440,56 +2398,14 @@ MtrrSetAllMtrrs ( // // Set MTRR_DEF_TYPE value // - AsmWriteMsr64 (MTRR_LIB_IA32_MTRR_DEF_TYPE, MtrrSetting->MtrrDefType); + AsmWriteMsr64 (MSR_IA32_MTRR_DEF_TYPE, MtrrSetting->MtrrDefType); - PostMtrrChange (Cr4); + MtrrLibPostMtrrChangeEnableCache (&MtrrContext); return MtrrSetting; } -/** - This function prints all MTRRs for debugging. -**/ -VOID -EFIAPI -MtrrDebugPrintAllMtrrs ( - VOID - ) -{ - DEBUG_CODE ( - { - MTRR_SETTINGS MtrrSettings; - UINTN Index; - UINTN VariableMtrrCount; - - if (!IsMtrrSupported ()) { - return; - } - - MtrrGetAllMtrrs (&MtrrSettings); - DEBUG((EFI_D_ERROR, "DefaultType = %016lx\n", MtrrSettings.MtrrDefType)); - for (Index = 0; Index < MTRR_NUMBER_OF_FIXED_MTRR; Index++) { - DEBUG(( - EFI_D_ERROR, "Fixed[%02d] = %016lx\n", - Index, - MtrrSettings.Fixed.Mtrr[Index] - )); - } - - VariableMtrrCount = GetVariableMtrrCount (); - for (Index = 0; Index < VariableMtrrCount; Index++) { - DEBUG(( - EFI_D_ERROR, "Variable[%02d] = %016lx, %016lx\n", - Index, - MtrrSettings.Variables.Mtrr[Index].Base, - MtrrSettings.Variables.Mtrr[Index].Mask - )); - } - } - ); -} - /** Checks if MTRR is supported. @@ -1503,26 +2419,26 @@ IsMtrrSupported ( VOID ) { - UINT32 RegEdx; - UINT64 MtrrCap; + CPUID_VERSION_INFO_EDX Edx; + MSR_IA32_MTRRCAP_REGISTER MtrrCap; // // Check CPUID(1).EDX[12] for MTRR capability // - AsmCpuid (1, NULL, NULL, NULL, &RegEdx); - if (BitFieldRead32 (RegEdx, 12, 12) == 0) { + AsmCpuid (CPUID_VERSION_INFO, NULL, NULL, NULL, &Edx.Uint32); + if (Edx.Bits.MTRR == 0) { return FALSE; } // - // Check IA32_MTRRCAP.[0..7] for number of variable MTRRs and IA32_MTRRCAP[8] for - // fixed MTRRs existence. If number of variable MTRRs is zero, or fixed MTRRs do not + // Check number of variable MTRRs and fixed MTRRs existence. + // If number of variable MTRRs is zero, or fixed MTRRs do not // exist, return false. // - MtrrCap = AsmReadMsr64 (MTRR_LIB_IA32_MTRR_CAP); - if ((BitFieldRead64 (MtrrCap, 0, 7) == 0) || (BitFieldRead64 (MtrrCap, 8, 8) == 0)) { + MtrrCap.Uint64 = AsmReadMsr64 (MSR_IA32_MTRRCAP); + if ((MtrrCap.Bits.VCNT == 0) || (MtrrCap.Bits.FIX == 0)) { return FALSE; } - return TRUE; } +