UefiCpuPkg/Include/Library/MtrrLib.h

   1 /** @file
   2   MTRR setting library
   3
   4   Copyright (c) 2008 - 2018, 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
   9
  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.
  12
  13 **/
  14
  15 #ifndef  _MTRR_LIB_H_
  16 #define  _MTRR_LIB_H_
  17
  18 //
  19 // According to IA32 SDM, MTRRs number and MSR offset are always consistent
  20 // for IA32 processor family
  21 //
  22
  23 //
  24 // The semantics of below macro is MAX_MTRR_NUMBER_OF_VARIABLE_MTRR, the real number can be read out from MTRR_CAP register.
  25 //
  26 #define  MTRR_NUMBER_OF_VARIABLE_MTRR  32
  27 //
  28 // Firmware need reserve 2 MTRR for OS
  29 // Note: It is replaced by PCD PcdCpuNumberOfReservedVariableMtrrs
  30 //
  31 #define  RESERVED_FIRMWARE_VARIABLE_MTRR_NUMBER  2
  32
  33 #define  MTRR_NUMBER_OF_FIXED_MTRR      11
  34
  35 //
  36 // Structure to describe a fixed MTRR
  37 //
  38 typedef struct {
  39   UINT32  Msr;
  40   UINT32  BaseAddress;
  41   UINT32  Length;
  42 } FIXED_MTRR;
  43
  44 //
  45 // Structure to describe a variable MTRR
  46 //
  47 typedef struct {
  48   UINT64  BaseAddress;
  49   UINT64  Length;
  50   UINT64  Type;
  51   UINT32  Msr;
  52   BOOLEAN Valid;
  53   BOOLEAN Used;
  54 } VARIABLE_MTRR;
  55
  56 //
  57 // Structure to hold base and mask pair for variable MTRR register
  58 //
  59 typedef struct _MTRR_VARIABLE_SETTING_ {
  60   UINT64    Base;
  61   UINT64    Mask;
  62 } MTRR_VARIABLE_SETTING;
  63
  64 //
  65 // Array for variable MTRRs
  66 //
  67 typedef struct _MTRR_VARIABLE_SETTINGS_ {
  68   MTRR_VARIABLE_SETTING   Mtrr[MTRR_NUMBER_OF_VARIABLE_MTRR];
  69 } MTRR_VARIABLE_SETTINGS;
  70
  71 //
  72 // Array for fixed MTRRs
  73 //
  74 typedef  struct  _MTRR_FIXED_SETTINGS_ {
  75   UINT64       Mtrr[MTRR_NUMBER_OF_FIXED_MTRR];
  76 } MTRR_FIXED_SETTINGS;
  77
  78 //
  79 // Structure to hold all MTRRs
  80 //
  81 typedef struct _MTRR_SETTINGS_ {
  82   MTRR_FIXED_SETTINGS       Fixed;
  83   MTRR_VARIABLE_SETTINGS    Variables;
  84   UINT64                    MtrrDefType;
  85 } MTRR_SETTINGS;
  86
  87 //
  88 // Memory cache types
  89 //
  90 typedef enum {
  91   CacheUncacheable    = 0,
  92   CacheWriteCombining = 1,
  93   CacheWriteThrough   = 4,
  94   CacheWriteProtected = 5,
  95   CacheWriteBack      = 6,
  96   CacheInvalid        = 7
  97 } MTRR_MEMORY_CACHE_TYPE;
  98
  99 #define  MTRR_CACHE_UNCACHEABLE      0
 100 #define  MTRR_CACHE_WRITE_COMBINING  1
 101 #define  MTRR_CACHE_WRITE_THROUGH    4
 102 #define  MTRR_CACHE_WRITE_PROTECTED  5
 103 #define  MTRR_CACHE_WRITE_BACK       6
 104 #define  MTRR_CACHE_INVALID_TYPE     7
 105
 106 typedef struct {
 107   UINT64                 BaseAddress;
 108   UINT64                 Length;
 109   MTRR_MEMORY_CACHE_TYPE Type;
 110 } MTRR_MEMORY_RANGE;
 111
 112 /**
 113   Returns the variable MTRR count for the CPU.
 114
 115   @return Variable MTRR count
 116
 117 **/
 118 UINT32
 119 EFIAPI
 120 GetVariableMtrrCount (
 121   VOID
 122   );
 123
 124 /**
 125   Returns the firmware usable variable MTRR count for the CPU.
 126
 127   @return Firmware usable variable MTRR count
 128
 129 **/
 130 UINT32
 131 EFIAPI
 132 GetFirmwareVariableMtrrCount (
 133   VOID
 134   );
 135
 136 /**
 137   This function attempts to set the attributes for a memory range.
 138
 139   @param[in]       BaseAddress       The physical address that is the start
 140                                      address of a memory region.
 141   @param[in]       Length            The size in bytes of the memory region.
 142   @param[in]       Attribute         The bit mask of attributes to set for the
 143                                      memory region.
 144
 145   @retval RETURN_SUCCESS            The attributes were set for the memory
 146                                     region.
 147   @retval RETURN_INVALID_PARAMETER  Length is zero.
 148   @retval RETURN_UNSUPPORTED        The processor does not support one or
 149                                     more bytes of the memory resource range
 150                                     specified by BaseAddress and Length.
 151   @retval RETURN_UNSUPPORTED        The bit mask of attributes is not support
 152                                     for the memory resource range specified
 153                                     by BaseAddress and Length.
 154   @retval RETURN_ACCESS_DENIED      The attributes for the memory resource
 155                                     range specified by BaseAddress and Length
 156                                     cannot be modified.
 157   @retval RETURN_OUT_OF_RESOURCES   There are not enough system resources to
 158                                     modify the attributes of the memory
 159                                     resource range.
 160   @retval RETURN_BUFFER_TOO_SMALL   The fixed internal scratch buffer is too small for MTRR calculation.
 161                                     Caller should use MtrrSetMemoryAttributesInMtrrSettings() to specify
 162                                     external scratch buffer.
 163 **/
 164 RETURN_STATUS
 165 EFIAPI
 166 MtrrSetMemoryAttribute (
 167   IN PHYSICAL_ADDRESS        BaseAddress,
 168   IN UINT64                  Length,
 169   IN MTRR_MEMORY_CACHE_TYPE  Attribute
 170   );
 171
 172
 173 /**
 174   This function will get the memory cache type of the specific address.
 175   This function is mainly for debugging purposes.
 176
 177   @param[in]  Address            The specific address
 178
 179   @return The memory cache type of the specific address
 180
 181 **/
 182 MTRR_MEMORY_CACHE_TYPE
 183 EFIAPI
 184 MtrrGetMemoryAttribute (
 185   IN PHYSICAL_ADDRESS   Address
 186   );
 187
 188
 189 /**
 190   This function will get the raw value in variable MTRRs
 191
 192   @param[out]  VariableSettings   A buffer to hold variable MTRRs content.
 193
 194   @return The buffer point to MTRR_VARIABLE_SETTINGS in which holds the content of the variable MTRR
 195
 196 **/
 197 MTRR_VARIABLE_SETTINGS*
 198 EFIAPI
 199 MtrrGetVariableMtrr (
 200   OUT MTRR_VARIABLE_SETTINGS         *VariableSettings
 201   );
 202
 203
 204 /**
 205   This function sets variable MTRRs
 206
 207   @param[in]  VariableSettings   A buffer to hold variable MTRRs content.
 208
 209   @return The pointer of VariableSettings
 210
 211 **/
 212 MTRR_VARIABLE_SETTINGS*
 213 EFIAPI
 214 MtrrSetVariableMtrr (
 215   IN MTRR_VARIABLE_SETTINGS         *VariableSettings
 216   );
 217
 218
 219 /**
 220   This function gets the content in fixed MTRRs
 221
 222   @param[out]  FixedSettings      A buffer to hold fixed MTRRs content.
 223
 224   @return The pointer of FixedSettings
 225
 226 **/
 227 MTRR_FIXED_SETTINGS*
 228 EFIAPI
 229 MtrrGetFixedMtrr (
 230   OUT MTRR_FIXED_SETTINGS         *FixedSettings
 231   );
 232
 233
 234 /**
 235   This function sets fixed MTRRs
 236
 237   @param[in]   FixedSettings      A buffer holding fixed MTRRs content.
 238
 239   @return  The pointer of FixedSettings
 240
 241 **/
 242 MTRR_FIXED_SETTINGS*
 243 EFIAPI
 244 MtrrSetFixedMtrr (
 245   IN MTRR_FIXED_SETTINGS          *FixedSettings
 246   );
 247
 248
 249 /**
 250   This function gets the content in all MTRRs (variable and fixed)
 251
 252   @param[out]  MtrrSetting   A buffer to hold all MTRRs content.
 253
 254   @return The pointer of MtrrSetting
 255
 256 **/
 257 MTRR_SETTINGS *
 258 EFIAPI
 259 MtrrGetAllMtrrs (
 260   OUT MTRR_SETTINGS                *MtrrSetting
 261   );
 262
 263
 264 /**
 265   This function sets all MTRRs (variable and fixed)
 266
 267   @param[in]  MtrrSetting   A buffer to hold all MTRRs content.
 268
 269   @return The pointer of MtrrSetting
 270
 271 **/
 272 MTRR_SETTINGS *
 273 EFIAPI
 274 MtrrSetAllMtrrs (
 275   IN MTRR_SETTINGS                *MtrrSetting
 276   );
 277
 278
 279 /**
 280   Get the attribute of variable MTRRs.
 281
 282   This function shadows the content of variable MTRRs into
 283   an internal array: VariableMtrr
 284
 285   @param[in]   MtrrValidBitsMask    The mask for the valid bit of the MTRR
 286   @param[in]   MtrrValidAddressMask The valid address mask for MTRR since the base address in
 287                                     MTRR must align to 4K, so valid address mask equal to
 288                                     MtrrValidBitsMask & 0xfffffffffffff000ULL
 289   @param[out]  VariableMtrr         The array to shadow variable MTRRs content
 290
 291   @return                       The return value of this parameter indicates the number of
 292                                 MTRRs which has been used.
 293 **/
 294 UINT32
 295 EFIAPI
 296 MtrrGetMemoryAttributeInVariableMtrr (
 297   IN  UINT64                    MtrrValidBitsMask,
 298   IN  UINT64                    MtrrValidAddressMask,
 299   OUT VARIABLE_MTRR             *VariableMtrr
 300   );
 301
 302
 303 /**
 304   This function prints all MTRRs for debugging.
 305 **/
 306 VOID
 307 EFIAPI
 308 MtrrDebugPrintAllMtrrs (
 309   VOID
 310   );
 311
 312 /**
 313   Checks if MTRR is supported.
 314
 315   @retval TRUE  MTRR is supported.
 316   @retval FALSE MTRR is not supported.
 317
 318 **/
 319 BOOLEAN
 320 EFIAPI
 321 IsMtrrSupported (
 322   VOID
 323   );
 324
 325 /**
 326   Returns the default MTRR cache type for the system.
 327
 328   @return  The default MTRR cache type.
 329
 330 **/
 331 MTRR_MEMORY_CACHE_TYPE
 332 EFIAPI
 333 MtrrGetDefaultMemoryType (
 334   VOID
 335   );
 336
 337 /**
 338   This function attempts to set the attributes into MTRR setting buffer for a memory range.
 339
 340   @param[in, out]  MtrrSetting  MTRR setting buffer to be set.
 341   @param[in]       BaseAddress  The physical address that is the start address
 342                                 of a memory region.
 343   @param[in]       Length       The size in bytes of the memory region.
 344   @param[in]       Attribute    The bit mask of attributes to set for the
 345                                 memory region.
 346
 347   @retval RETURN_SUCCESS            The attributes were set for the memory region.
 348   @retval RETURN_INVALID_PARAMETER  Length is zero.
 349   @retval RETURN_UNSUPPORTED        The processor does not support one or more bytes of the
 350                                     memory resource range specified by BaseAddress and Length.
 351   @retval RETURN_UNSUPPORTED        The bit mask of attributes is not support for the memory resource
 352                                     range specified by BaseAddress and Length.
 353   @retval RETURN_ACCESS_DENIED      The attributes for the memory resource range specified by
 354                                     BaseAddress and Length cannot be modified.
 355   @retval RETURN_OUT_OF_RESOURCES   There are not enough system resources to modify the attributes of
 356                                     the memory resource range.
 357   @retval RETURN_BUFFER_TOO_SMALL   The fixed internal scratch buffer is too small for MTRR calculation.
 358                                     Caller should use MtrrSetMemoryAttributesInMtrrSettings() to specify
 359                                     external scratch buffer.
 360 **/
 361 RETURN_STATUS
 362 EFIAPI
 363 MtrrSetMemoryAttributeInMtrrSettings (
 364   IN OUT MTRR_SETTINGS       *MtrrSetting,
 365   IN PHYSICAL_ADDRESS        BaseAddress,
 366   IN UINT64                  Length,
 367   IN MTRR_MEMORY_CACHE_TYPE  Attribute
 368   );
 369
 370 /**
 371   This function attempts to set the attributes into MTRR setting buffer for multiple memory ranges.
 372
 373   @param[in, out]  MtrrSetting  MTRR setting buffer to be set.
 374   @param[in]       Scratch      A temporary scratch buffer that is used to perform the calculation.
 375   @param[in, out]  ScratchSize  Pointer to the size in bytes of the scratch buffer.
 376                                 It may be updated to the actual required size when the calculation
 377                                 needs more scratch buffer.
 378   @param[in]       Ranges       Pointer to an array of MTRR_MEMORY_RANGE.
 379                                 When range overlap happens, the last one takes higher priority.
 380                                 When the function returns, either all the attributes are set successfully,
 381                                 or none of them is set.
 382   @param[in]      RangeCount    Count of MTRR_MEMORY_RANGE.
 383
 384   @retval RETURN_SUCCESS            The attributes were set for all the memory ranges.
 385   @retval RETURN_INVALID_PARAMETER  Length in any range is zero.
 386   @retval RETURN_UNSUPPORTED        The processor does not support one or more bytes of the
 387                                     memory resource range specified by BaseAddress and Length in any range.
 388   @retval RETURN_UNSUPPORTED        The bit mask of attributes is not support for the memory resource
 389                                     range specified by BaseAddress and Length in any range.
 390   @retval RETURN_OUT_OF_RESOURCES   There are not enough system resources to modify the attributes of
 391                                     the memory resource ranges.
 392   @retval RETURN_ACCESS_DENIED      The attributes for the memory resource range specified by
 393                                     BaseAddress and Length cannot be modified.
 394   @retval RETURN_BUFFER_TOO_SMALL   The scratch buffer is too small for MTRR calculation.
 395 **/
 396 RETURN_STATUS
 397 EFIAPI
 398 MtrrSetMemoryAttributesInMtrrSettings (
 399   IN OUT MTRR_SETTINGS           *MtrrSetting,
 400   IN     VOID                    *Scratch,
 401   IN OUT UINTN                   *ScratchSize,
 402   IN     CONST MTRR_MEMORY_RANGE *Ranges,
 403   IN     UINTN                   RangeCount
 404   );
 405 #endif // _MTRR_LIB_H_