4 Copyright (c) 2008 - 2015, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 // According to IA32 SDM, MTRRs number and msr offset are always consistent
20 // for IA32 processor family
24 // The semantics of below macro is MAX_MTRR_NUMBER_OF_VARIABLE_MTRR, the real number can be read out from MTRR_CAP register.
26 #define MTRR_NUMBER_OF_VARIABLE_MTRR 32
28 // Firmware need reserve 2 MTRR for OS
29 // Note: It is replaced by PCD PcdCpuNumberOfReservedVariableMtrrs
31 #define RESERVED_FIRMWARE_VARIABLE_MTRR_NUMBER 2
33 #define MTRR_NUMBER_OF_FIXED_MTRR 11
35 // Below macro is deprecated, and should not be used.
37 #define FIRMWARE_VARIABLE_MTRR_NUMBER 6
38 #define MTRR_LIB_IA32_MTRR_CAP 0x0FE
39 #define MTRR_LIB_IA32_MTRR_CAP_VCNT_MASK 0x0FF
40 #define MTRR_LIB_IA32_MTRR_FIX64K_00000 0x250
41 #define MTRR_LIB_IA32_MTRR_FIX16K_80000 0x258
42 #define MTRR_LIB_IA32_MTRR_FIX16K_A0000 0x259
43 #define MTRR_LIB_IA32_MTRR_FIX4K_C0000 0x268
44 #define MTRR_LIB_IA32_MTRR_FIX4K_C8000 0x269
45 #define MTRR_LIB_IA32_MTRR_FIX4K_D0000 0x26A
46 #define MTRR_LIB_IA32_MTRR_FIX4K_D8000 0x26B
47 #define MTRR_LIB_IA32_MTRR_FIX4K_E0000 0x26C
48 #define MTRR_LIB_IA32_MTRR_FIX4K_E8000 0x26D
49 #define MTRR_LIB_IA32_MTRR_FIX4K_F0000 0x26E
50 #define MTRR_LIB_IA32_MTRR_FIX4K_F8000 0x26F
51 #define MTRR_LIB_IA32_VARIABLE_MTRR_BASE 0x200
53 // Below macro is deprecated, and should not be used.
55 #define MTRR_LIB_IA32_VARIABLE_MTRR_END 0x20F
56 #define MTRR_LIB_IA32_MTRR_DEF_TYPE 0x2FF
57 #define MTRR_LIB_MSR_VALID_MASK 0xFFFFFFFFFULL
58 #define MTRR_LIB_CACHE_VALID_ADDRESS 0xFFFFFF000ULL
59 #define MTRR_LIB_CACHE_MTRR_ENABLED 0x800
60 #define MTRR_LIB_CACHE_FIXED_MTRR_ENABLED 0x400
63 // Structure to describe a fixed MTRR
72 // Structure to describe a variable MTRR
84 // Structure to hold base and mask pair for variable MTRR register
86 typedef struct _MTRR_VARIABLE_SETTING_
{
89 } MTRR_VARIABLE_SETTING
;
92 // Array for variable MTRRs
94 typedef struct _MTRR_VARIABLE_SETTINGS_
{
95 MTRR_VARIABLE_SETTING Mtrr
[MTRR_NUMBER_OF_VARIABLE_MTRR
];
96 } MTRR_VARIABLE_SETTINGS
;
99 // Array for fixed mtrrs
101 typedef struct _MTRR_FIXED_SETTINGS_
{
102 UINT64 Mtrr
[MTRR_NUMBER_OF_FIXED_MTRR
];
103 } MTRR_FIXED_SETTINGS
;
106 // Structure to hold all MTRRs
108 typedef struct _MTRR_SETTINGS_
{
109 MTRR_FIXED_SETTINGS Fixed
;
110 MTRR_VARIABLE_SETTINGS Variables
;
115 // Memory cache types
118 CacheUncacheable
= 0,
119 CacheWriteCombining
= 1,
120 CacheWriteThrough
= 4,
121 CacheWriteProtected
= 5,
123 } MTRR_MEMORY_CACHE_TYPE
;
125 #define MTRR_CACHE_UNCACHEABLE 0
126 #define MTRR_CACHE_WRITE_COMBINING 1
127 #define MTRR_CACHE_WRITE_THROUGH 4
128 #define MTRR_CACHE_WRITE_PROTECTED 5
129 #define MTRR_CACHE_WRITE_BACK 6
130 #define MTRR_CACHE_INVALID_TYPE 7
133 Returns the variable MTRR count for the CPU.
135 @return Variable MTRR count
140 GetVariableMtrrCount (
145 Returns the firmware usable variable MTRR count for the CPU.
147 @return Firmware usable variable MTRR count
152 GetFirmwareVariableMtrrCount (
157 This function attempts to set the attributes for a memory range.
159 @param[in] BaseAddress The physical address that is the start
160 address of a memory region.
161 @param[in] Length The size in bytes of the memory region.
162 @param[in] Attribute The bit mask of attributes to set for the
165 @retval RETURN_SUCCESS The attributes were set for the memory
167 @retval RETURN_INVALID_PARAMETER Length is zero.
168 @retval RETURN_UNSUPPORTED The processor does not support one or
169 more bytes of the memory resource range
170 specified by BaseAddress and Length.
171 @retval RETURN_UNSUPPORTED The bit mask of attributes is not support
172 for the memory resource range specified
173 by BaseAddress and Length.
174 @retval RETURN_ACCESS_DENIED The attributes for the memory resource
175 range specified by BaseAddress and Length
177 @retval RETURN_OUT_OF_RESOURCES There are not enough system resources to
178 modify the attributes of the memory
184 MtrrSetMemoryAttribute (
185 IN PHYSICAL_ADDRESS BaseAddress
,
187 IN MTRR_MEMORY_CACHE_TYPE Attribute
192 This function will get the memory cache type of the specific address.
193 This function is mainly for debugging purposes.
195 @param[in] Address The specific address
197 @return The memory cache type of the specific address
200 MTRR_MEMORY_CACHE_TYPE
202 MtrrGetMemoryAttribute (
203 IN PHYSICAL_ADDRESS Address
208 This function will get the raw value in variable MTRRs
210 @param[out] VariableSettings A buffer to hold variable MTRRs content.
212 @return The buffer point to MTRR_VARIABLE_SETTINGS in which holds the content of the variable mtrr
215 MTRR_VARIABLE_SETTINGS
*
217 MtrrGetVariableMtrr (
218 OUT MTRR_VARIABLE_SETTINGS
*VariableSettings
223 This function sets fixed MTRRs
225 @param[in] VariableSettings A buffer to hold variable MTRRs content.
227 @return The pointer of VariableSettings
230 MTRR_VARIABLE_SETTINGS
*
232 MtrrSetVariableMtrr (
233 IN MTRR_VARIABLE_SETTINGS
*VariableSettings
238 This function gets the content in fixed MTRRs
240 @param[out] FixedSettings A buffer to hold fixed MTRRs content.
242 @return The pointer of FixedSettings
248 OUT MTRR_FIXED_SETTINGS
*FixedSettings
253 This function sets fixed MTRRs
255 @param[in] FixedSettings A buffer holding fixed MTRRs content.
257 @return The pointer of FixedSettings
263 IN MTRR_FIXED_SETTINGS
*FixedSettings
268 This function gets the content in all MTRRs (variable and fixed)
270 @param[out] MtrrSetting A buffer to hold all MTRRs content.
272 @return The pointer of MtrrSetting
278 OUT MTRR_SETTINGS
*MtrrSetting
283 This function sets all MTRRs (variable and fixed)
285 @param[in] MtrrSetting A buffer to hold all MTRRs content.
287 @return The pointer of MtrrSetting
293 IN MTRR_SETTINGS
*MtrrSetting
298 Get the attribute of variable MTRRs.
300 This function shadows the content of variable MTRRs into
301 an internal array: VariableMtrr
303 @param[in] MtrrValidBitsMask The mask for the valid bit of the MTRR
304 @param[in] MtrrValidAddressMask The valid address mask for MTRR since the base address in
305 MTRR must align to 4K, so valid address mask equal to
306 MtrrValidBitsMask & 0xfffffffffffff000ULL
307 @param[out] VariableMtrr The array to shadow variable MTRRs content
309 @return The ruturn value of this paramter indicates the number of
310 MTRRs which has been used.
314 MtrrGetMemoryAttributeInVariableMtrr (
315 IN UINT64 MtrrValidBitsMask
,
316 IN UINT64 MtrrValidAddressMask
,
317 OUT VARIABLE_MTRR
*VariableMtrr
322 This function prints all MTRRs for debugging.
326 MtrrDebugPrintAllMtrrs (
331 Checks if MTRR is supported.
333 @retval TRUE MTRR is supported.
334 @retval FALSE MTRR is not supported.
344 Returns the default MTRR cache type for the system.
346 @return The default MTRR cache type.
349 MTRR_MEMORY_CACHE_TYPE
351 MtrrGetDefaultMemoryType (
356 This function attempts to set the attributes into MTRR setting buffer for a memory range.
358 @param[in, out] MtrrSetting MTRR setting buffer to be set.
359 @param[in] BaseAddress The physical address that is the start address
361 @param[in] Length The size in bytes of the memory region.
362 @param[in] Attribute The bit mask of attributes to set for the
365 @retval RETURN_SUCCESS The attributes were set for the memory region.
366 @retval RETURN_INVALID_PARAMETER Length is zero.
367 @retval RETURN_UNSUPPORTED The processor does not support one or more bytes of the
368 memory resource range specified by BaseAddress and Length.
369 @retval RETURN_UNSUPPORTED The bit mask of attributes is not support for the memory resource
370 range specified by BaseAddress and Length.
371 @retval RETURN_ACCESS_DENIED The attributes for the memory resource range specified by
372 BaseAddress and Length cannot be modified.
373 @retval RETURN_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
374 the memory resource range.
379 MtrrSetMemoryAttributeInMtrrSettings (
380 IN OUT MTRR_SETTINGS
*MtrrSetting
,
381 IN PHYSICAL_ADDRESS BaseAddress
,
383 IN MTRR_MEMORY_CACHE_TYPE Attribute
386 #endif // _MTRR_LIB_H_