#include <Uefi.h>
#include <Library/BaseLib.h>
#include <Library/CacheLib.h>
#include <Library/CacheAsRamLib.h>
#include "CacheLibInternal.h"

Data Structures
struct	EFI_FIXED_MTRR

Functions
EFI_STATUS	SearchForExactMtrr (IN EFI_PHYSICAL_ADDRESS MemoryAddress, IN UINT64 MemoryLength, IN UINT64 ValidMtrrAddressMask, OUT UINT32 UsedMsrNum, OUT EFI_MEMORY_CACHE_TYPE MemoryCacheType)

BOOLEAN	IsDefaultType (IN EFI_MEMORY_CACHE_TYPE MemoryCacheType)

UINT32	CheckMtrrAlignment (IN UINT64 BaseAddress, IN UINT64 Size)

INT8	CheckDirection (IN UINT64 Input)

VOID	EfiDisableCacheMtrr (OUT UINT64 *OldMtrr)

VOID	EfiRecoverCacheMtrr (IN BOOLEAN EnableMtrr, IN UINT64 OldMtrr)

VOID	EfiProgramMtrr (IN UINT32 MtrrNumber, IN EFI_PHYSICAL_ADDRESS MemoryAddress, IN UINT64 MemoryLength, IN EFI_MEMORY_CACHE_TYPE MemoryCacheType, IN UINT64 ValidMtrrAddressMask)

UINT64	Power2MaxMemory (IN UINT64 MemoryAddress, IN UINT64 MemoryLength)

EFI_STATUS	ProgramFixedMtrr (IN EFI_MEMORY_CACHE_TYPE MemoryCacheType, IN UINT64 Base, IN UINT64 Len)

BOOLEAN	CheckMtrrOverlap (IN EFI_PHYSICAL_ADDRESS Start, IN EFI_PHYSICAL_ADDRESS End)

EFI_STATUS EFIAPI	SetCacheAttributes (IN EFI_PHYSICAL_ADDRESS MemoryAddress, IN UINT64 MemoryLength, IN EFI_MEMORY_CACHE_TYPE MemoryCacheType)

EFI_STATUS EFIAPI	ResetCacheAttributes (VOID)

Variables
EFI_FIXED_MTRR	mFixedMtrrTable []

Detailed Description

Copyright (c) 2014 - 2021, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file CacheLib.c.

Function Documentation

◆ CheckDirection()

INT8 CheckDirection ( IN UINT64 Input )

Given the input, check if the number of MTRR is lesser. if positive or subtractive.

Parameters

[in] Input Length of Memory to program MTRR.

Return values

Zero	do positive.
Non-Zero	do subtractive.

Definition at line 96 of file CacheLib.c.

◆ CheckMtrrAlignment()

UINT32 CheckMtrrAlignment	(	IN UINT64	BaseAddress,
		IN UINT64	Size
	)

Return MTRR alignment requirement for base address and size.

Parameters

[in]	BaseAddress	Base address.
[in]	Size	Size.

Return values

Zero	Aligned.
Non-Zero	Not aligned.

Definition at line 255 of file CacheLib.c.

◆ CheckMtrrOverlap()

BOOLEAN CheckMtrrOverlap	(	IN EFI_PHYSICAL_ADDRESS	Start,
		IN EFI_PHYSICAL_ADDRESS	End
	)

Check if there is a valid variable MTRR that overlaps the given range.

Parameters

[in]	Start	Base Address of the range to check.
[in]	End	End address of the range to check.

Return values

TRUE	Mtrr overlap.
FALSE	Mtrr not overlap.

Definition at line 354 of file CacheLib.c.

◆ EfiDisableCacheMtrr()

VOID EfiDisableCacheMtrr ( OUT UINT64 * OldMtrr )

Disable cache and its mtrr.

Parameters

[out] OldMtrr To return the Old MTRR value

Definition at line 110 of file CacheLib.c.

◆ EfiProgramMtrr()

VOID EfiProgramMtrr	(	IN UINT32	MtrrNumber,
		IN EFI_PHYSICAL_ADDRESS	MemoryAddress,
		IN UINT64	MemoryLength,
		IN EFI_MEMORY_CACHE_TYPE	MemoryCacheType,
		IN UINT64	ValidMtrrAddressMask
	)

Programming MTRR according to Memory address, length, and type.

Parameters

[in]	MtrrNumber	the variable MTRR index number
[in]	MemoryAddress	the address of target memory
[in]	MemoryLength	the length of target memory
[in]	MemoryCacheType	the cache type of target memory
[in]	ValidMtrrAddressMask	the MTRR address mask

Definition at line 166 of file CacheLib.c.

◆ EfiRecoverCacheMtrr()

VOID EfiRecoverCacheMtrr	(	IN BOOLEAN	EnableMtrr,
		IN UINT64	OldMtrr
	)

Recover cache MTRR.

Parameters

[in]	EnableMtrr	Whether to enable the MTRR
[in]	OldMtrr	The saved old MTRR value to restore when not to enable the MTRR

Definition at line 133 of file CacheLib.c.

◆ IsDefaultType()

BOOLEAN IsDefaultType ( IN EFI_MEMORY_CACHE_TYPE MemoryCacheType )

Check if CacheType match current default setting.

Parameters

[in] MemoryCacheType input cache type to be checked.

Return values

TRUE	MemoryCacheType is default MTRR setting.
FALSE	MemoryCacheType is NOT default MTRR setting.

Check if CacheType match current default setting.

Parameters

[in] MemoryCacheType input cache type to be checked.

Return values

TRUE	MemoryCacheType is default MTRR setting.
TRUE	MemoryCacheType is NOT default MTRR setting.

Definition at line 698 of file CacheLib.c.

◆ Power2MaxMemory()

UINT64 Power2MaxMemory	(	IN UINT64	MemoryAddress,
		IN UINT64	MemoryLength
	)

Calculate the maximum value which is a power of 2, but less the MemoryLength.

Parameters

[in]	MemoryAddress	Memory address.
[in]	MemoryLength	The number to pass in.

Returns: The maximum value which is align to power of 2 and less the MemoryLength

Definition at line 208 of file CacheLib.c.

◆ ProgramFixedMtrr()

EFI_STATUS ProgramFixedMtrr	(	IN EFI_MEMORY_CACHE_TYPE	MemoryCacheType,
		IN UINT64 *	Base,
		IN UINT64 *	Len
	)

Programs fixed MTRRs registers.

Parameters

[in]	MemoryCacheType	The memory type to set.
[in]	Base	The base address of memory range.
[in]	Length	The length of memory range.

Return values

RETURN_SUCCESS	The cache type was updated successfully
RETURN_UNSUPPORTED	The requested range or cache type was invalid for the fixed MTRRs.

Definition at line 290 of file CacheLib.c.

◆ ResetCacheAttributes()

EFI_STATUS EFIAPI ResetCacheAttributes ( VOID )

Reset all the MTRRs to a known state.

Return values

EFI_SUCCESS All MTRRs have been reset successfully.

Definition at line 582 of file CacheLib.c.

◆ SearchForExactMtrr()

EFI_STATUS SearchForExactMtrr	(	IN EFI_PHYSICAL_ADDRESS	MemoryAddress,
		IN UINT64	MemoryLength,
		IN UINT64	ValidMtrrAddressMask,
		OUT UINT32 *	UsedMsrNum,
		OUT EFI_MEMORY_CACHE_TYPE *	UsedMemoryCacheType
	)

Search the memory cache type for specific memory from MTRR.

Parameters

[in]	MemoryAddress	the address of target memory
[in]	MemoryLength	the length of target memory
[in]	ValidMtrrAddressMask	the MTRR address mask
[out]	UsedMsrNum	the used MSR number
[out]	UsedMemoryCacheType	the cache type for the target memory

Return values

EFI_SUCCESS	The memory is found in MTRR and cache type is returned
EFI_NOT_FOUND	The memory is not found in MTRR

Definition at line 649 of file CacheLib.c.

◆ SetCacheAttributes()

EFI_STATUS EFIAPI SetCacheAttributes	(	IN EFI_PHYSICAL_ADDRESS	MemoryAddress,
		IN UINT64	MemoryLength,
		IN EFI_MEMORY_CACHE_TYPE	MemoryCacheType
	)

Given the memory range and cache type, programs the MTRRs.

Parameters

[in]	MemoryAddress	Base Address of Memory to program MTRR.
[in]	MemoryLength	Length of Memory to program MTRR.
[in]	MemoryCacheType	Cache Type.

Return values

EFI_SUCCESS	Mtrr are set successfully.
EFI_LOAD_ERROR	No empty MTRRs to use.
EFI_INVALID_PARAMETER	The input parameter is not valid.
others	An error occurs when setting MTTR.

Definition at line 377 of file CacheLib.c.

Variable Documentation

◆ mFixedMtrrTable

EFI_FIXED_MTRR mFixedMtrrTable[]

Initial value:

= {
  { EFI_MSR_IA32_MTRR_FIX64K_00000, 0,       0x10000 },
  { EFI_MSR_IA32_MTRR_FIX16K_80000, 0x80000, 0x4000  },
  { EFI_MSR_IA32_MTRR_FIX16K_A0000, 0xA0000, 0x4000  },
  { EFI_MSR_IA32_MTRR_FIX4K_C0000,  0xC0000, 0x1000  },
  { EFI_MSR_IA32_MTRR_FIX4K_C8000,  0xC8000, 0x1000  },
  { EFI_MSR_IA32_MTRR_FIX4K_D0000,  0xD0000, 0x1000  },
  { EFI_MSR_IA32_MTRR_FIX4K_D8000,  0xD8000, 0x1000  },
  { EFI_MSR_IA32_MTRR_FIX4K_E0000,  0xE0000, 0x1000  },
  { EFI_MSR_IA32_MTRR_FIX4K_E8000,  0xE8000, 0x1000  },
  { EFI_MSR_IA32_MTRR_FIX4K_F0000,  0xF0000, 0x1000  },
  { EFI_MSR_IA32_MTRR_FIX4K_F8000,  0xF8000, 0x1000  }
}

Definition at line 71 of file CacheLib.c.

Data Structures

Functions

Variables

Detailed Description

Function Documentation

◆ CheckDirection()

◆ CheckMtrrAlignment()

◆ CheckMtrrOverlap()

◆ EfiDisableCacheMtrr()

◆ EfiProgramMtrr()

◆ EfiRecoverCacheMtrr()

◆ IsDefaultType()

◆ Power2MaxMemory()

◆ ProgramFixedMtrr()

◆ ResetCacheAttributes()

◆ SearchForExactMtrr()

◆ SetCacheAttributes()

Variable Documentation

◆ mFixedMtrrTable