4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MTRR setting library
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2008 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// According to IA32 SDM, MTRRs number and msr offset are always consistent
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// for IA32 processor family
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The semantics of below macro is MAX_MTRR_NUMBER_OF_VARIABLE_MTRR, the real number can be read out from MTRR_CAP register.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Firmware need reserve 2 MTRR for OS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Below macro is deprecated, and should not be used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Below macro is deprecated, and should not be used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Structure to describe a fixed MTRR
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Structure to describe a variable MTRR
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Structure to hold base and mask pair for variable MTRR register
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Array for variable MTRRs
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MTRR_VARIABLE_SETTING Mtrr[MTRR_NUMBER_OF_VARIABLE_MTRR];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Array for fixed mtrrs
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Structure to hold all MTRRs
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Memory cache types
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the variable MTRR count for the CPU.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Variable MTRR count
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the firmware usable variable MTRR count for the CPU.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Firmware usable variable MTRR count
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function attempts to set the attributes for a memory range.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BaseAddress The physical address that is the start address of a memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length The size in bytes of the memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attributes The bit mask of attributes to set for the memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS The attributes were set for the memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_INVALID_PARAMETER Length is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_UNSUPPORTED The processor does not support one or more bytes of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync memory resource range specified by BaseAddress and Length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_UNSUPPORTED The bit mask of attributes is not support for the memory resource
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync range specified by BaseAddress and Length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_ACCESS_DENIED The attributes for the memory resource range specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BaseAddress and Length cannot be modified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the memory resource range.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function will get the memory cache type of the specific address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is mainly for debugging purposes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address The specific address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The memory cache type of the specific address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function will get the raw value in variable MTRRs
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VariableSettings A buffer to hold variable MTRRs content.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The buffer point to MTRR_VARIABLE_SETTINGS in which holds the content of the variable mtrr
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function sets fixed MTRRs
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VariableSettings A buffer to hold variable MTRRs content.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer of VariableSettings
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function gets the content in fixed MTRRs
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FixedSettings A buffer to hold fixed MTRRs content.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer of FixedSettings
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function sets fixed MTRRs
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FixedSettings A buffer holding fixed MTRRs content.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer of FixedSettings
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function gets the content in all MTRRs (variable and fixed)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MtrrSetting A buffer to hold all MTRRs content.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer of MtrrSetting
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function sets all MTRRs (variable and fixed)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MtrrSetting A buffer to hold all MTRRs content.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer of MtrrSetting
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get the attribute of variable MTRRs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function shadows the content of variable MTRRs into
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync an internal array: VariableMtrr
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MtrrValidBitsMask The mask for the valid bit of the MTRR
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MtrrValidAddressMask The valid address mask for MTRR since the base address in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MTRR must align to 4K, so valid address mask equal to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MtrrValidBitsMask & 0xfffffffffffff000ULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VariableMtrr The array to shadow variable MTRRs content
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The ruturn value of this paramter indicates the number of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MTRRs which has been used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function prints all MTRRs for debugging.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Checks if MTRR is supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE MTRR is supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE MTRR is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the default MTRR cache type for the system.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The default MTRR cache type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif // _MTRR_LIB_H_