UefiCpuPkg/Include/Library/MtrrLib.h

   1 /** @file
   2   MTRR setting library
   3
   4   Copyright (c) 2008 - 2017, 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 scratch buffer is too small for MTRR calculation.
 161 **/
 162 RETURN_STATUS
 163 EFIAPI
 164 MtrrSetMemoryAttribute (
 165   IN PHYSICAL_ADDRESS        BaseAddress,
 166   IN UINT64                  Length,
 167   IN MTRR_MEMORY_CACHE_TYPE  Attribute
 168   );
 169
 170
 171 /**
 172   This function will get the memory cache type of the specific address.
 173   This function is mainly for debugging purposes.
 174
 175   @param[in]  Address            The specific address
 176
 177   @return The memory cache type of the specific address
 178
 179 **/
 180 MTRR_MEMORY_CACHE_TYPE
 181 EFIAPI
 182 MtrrGetMemoryAttribute (
 183   IN PHYSICAL_ADDRESS   Address
 184   );
 185
 186
 187 /**
 188   This function will get the raw value in variable MTRRs
 189
 190   @param[out]  VariableSettings   A buffer to hold variable MTRRs content.
 191
 192   @return The buffer point to MTRR_VARIABLE_SETTINGS in which holds the content of the variable MTRR
 193
 194 **/
 195 MTRR_VARIABLE_SETTINGS*
 196 EFIAPI
 197 MtrrGetVariableMtrr (
 198   OUT MTRR_VARIABLE_SETTINGS         *VariableSettings
 199   );
 200
 201
 202 /**
 203   This function sets variable MTRRs
 204
 205   @param[in]  VariableSettings   A buffer to hold variable MTRRs content.
 206
 207   @return The pointer of VariableSettings
 208
 209 **/
 210 MTRR_VARIABLE_SETTINGS*
 211 EFIAPI
 212 MtrrSetVariableMtrr (
 213   IN MTRR_VARIABLE_SETTINGS         *VariableSettings
 214   );
 215
 216
 217 /**
 218   This function gets the content in fixed MTRRs
 219
 220   @param[out]  FixedSettings      A buffer to hold fixed MTRRs content.
 221
 222   @return The pointer of FixedSettings
 223
 224 **/
 225 MTRR_FIXED_SETTINGS*
 226 EFIAPI
 227 MtrrGetFixedMtrr (
 228   OUT MTRR_FIXED_SETTINGS         *FixedSettings
 229   );
 230
 231
 232 /**
 233   This function sets fixed MTRRs
 234
 235   @param[in]   FixedSettings      A buffer holding fixed MTRRs content.
 236
 237   @return  The pointer of FixedSettings
 238
 239 **/
 240 MTRR_FIXED_SETTINGS*
 241 EFIAPI
 242 MtrrSetFixedMtrr (
 243   IN MTRR_FIXED_SETTINGS          *FixedSettings
 244   );
 245
 246
 247 /**
 248   This function gets the content in all MTRRs (variable and fixed)
 249
 250   @param[out]  MtrrSetting   A buffer to hold all MTRRs content.
 251
 252   @return The pointer of MtrrSetting
 253
 254 **/
 255 MTRR_SETTINGS *
 256 EFIAPI
 257 MtrrGetAllMtrrs (
 258   OUT MTRR_SETTINGS                *MtrrSetting
 259   );
 260
 261
 262 /**
 263   This function sets all MTRRs (variable and fixed)
 264
 265   @param[in]  MtrrSetting   A buffer to hold all MTRRs content.
 266
 267   @return The pointer of MtrrSetting
 268
 269 **/
 270 MTRR_SETTINGS *
 271 EFIAPI
 272 MtrrSetAllMtrrs (
 273   IN MTRR_SETTINGS                *MtrrSetting
 274   );
 275
 276
 277 /**
 278   Get the attribute of variable MTRRs.
 279
 280   This function shadows the content of variable MTRRs into
 281   an internal array: VariableMtrr
 282
 283   @param[in]   MtrrValidBitsMask    The mask for the valid bit of the MTRR
 284   @param[in]   MtrrValidAddressMask The valid address mask for MTRR since the base address in
 285                                     MTRR must align to 4K, so valid address mask equal to
 286                                     MtrrValidBitsMask & 0xfffffffffffff000ULL
 287   @param[out]  VariableMtrr         The array to shadow variable MTRRs content
 288
 289   @return                       The return value of this parameter indicates the number of
 290                                 MTRRs which has been used.
 291 **/
 292 UINT32
 293 EFIAPI
 294 MtrrGetMemoryAttributeInVariableMtrr (
 295   IN  UINT64                    MtrrValidBitsMask,
 296   IN  UINT64                    MtrrValidAddressMask,
 297   OUT VARIABLE_MTRR             *VariableMtrr
 298   );
 299
 300
 301 /**
 302   This function prints all MTRRs for debugging.
 303 **/
 304 VOID
 305 EFIAPI
 306 MtrrDebugPrintAllMtrrs (
 307   VOID
 308   );
 309
 310 /**
 311   Checks if MTRR is supported.
 312
 313   @retval TRUE  MTRR is supported.
 314   @retval FALSE MTRR is not supported.
 315
 316 **/
 317 BOOLEAN
 318 EFIAPI
 319 IsMtrrSupported (
 320   VOID
 321   );
 322
 323 /**
 324   Returns the default MTRR cache type for the system.
 325
 326   @return  The default MTRR cache type.
 327
 328 **/
 329 MTRR_MEMORY_CACHE_TYPE
 330 EFIAPI
 331 MtrrGetDefaultMemoryType (
 332   VOID
 333   );
 334
 335 /**
 336   This function attempts to set the attributes into MTRR setting buffer for a memory range.
 337
 338   @param[in, out]  MtrrSetting  MTRR setting buffer to be set.
 339   @param[in]       BaseAddress  The physical address that is the start address
 340                                 of a memory region.
 341   @param[in]       Length       The size in bytes of the memory region.
 342   @param[in]       Attribute    The bit mask of attributes to set for the
 343                                 memory region.
 344
 345   @retval RETURN_SUCCESS            The attributes were set for the memory region.
 346   @retval RETURN_INVALID_PARAMETER  Length is zero.
 347   @retval RETURN_UNSUPPORTED        The processor does not support one or more bytes of the
 348                                     memory resource range specified by BaseAddress and Length.
 349   @retval RETURN_UNSUPPORTED        The bit mask of attributes is not support for the memory resource
 350                                     range specified by BaseAddress and Length.
 351   @retval RETURN_ACCESS_DENIED      The attributes for the memory resource range specified by
 352                                     BaseAddress and Length cannot be modified.
 353   @retval RETURN_OUT_OF_RESOURCES   There are not enough system resources to modify the attributes of
 354                                     the memory resource range.
 355   @retval RETURN_BUFFER_TOO_SMALL   The scratch buffer is too small for MTRR calculation.
 356 **/
 357 RETURN_STATUS
 358 EFIAPI
 359 MtrrSetMemoryAttributeInMtrrSettings (
 360   IN OUT MTRR_SETTINGS       *MtrrSetting,
 361   IN PHYSICAL_ADDRESS        BaseAddress,
 362   IN UINT64                  Length,
 363   IN MTRR_MEMORY_CACHE_TYPE  Attribute
 364   );
 365
 366 /**
 367   This function attempts to set the attributes into MTRR setting buffer for multiple memory ranges.
 368
 369   @param[in, out]  MtrrSetting  MTRR setting buffer to be set.
 370   @param[in]       Scratch      A temporary scratch buffer that is used to perform the calculation.
 371   @param[in, out]  ScratchSize  Pointer to the size in bytes of the scratch buffer.
 372                                 It may be updated to the actual required size when the calculation
 373                                 needs more scratch buffer.
 374   @param[in]       Ranges       Pointer to an array of MTRR_MEMORY_RANGE.
 375                                 When range overlap happens, the last one takes higher priority.
 376                                 When the function returns, either all the attributes are set successfully,
 377                                 or none of them is set.
 378   @param[in]      RangeCount    Count of MTRR_MEMORY_RANGE.
 379
 380   @retval RETURN_SUCCESS            The attributes were set for all the memory ranges.
 381   @retval RETURN_INVALID_PARAMETER  Length in any range is zero.
 382   @retval RETURN_UNSUPPORTED        The processor does not support one or more bytes of the
 383                                     memory resource range specified by BaseAddress and Length in any range.
 384   @retval RETURN_UNSUPPORTED        The bit mask of attributes is not support for the memory resource
 385                                     range specified by BaseAddress and Length in any range.
 386   @retval RETURN_OUT_OF_RESOURCES   There are not enough system resources to modify the attributes of
 387                                     the memory resource ranges.
 388   @retval RETURN_ACCESS_DENIED      The attributes for the memory resource range specified by
 389                                     BaseAddress and Length cannot be modified.
 390   @retval RETURN_BUFFER_TOO_SMALL   The scratch buffer is too small for MTRR calculation.
 391 **/
 392 RETURN_STATUS
 393 EFIAPI
 394 MtrrSetMemoryAttributesInMtrrSettings (
 395   IN OUT MTRR_SETTINGS           *MtrrSetting,
 396   IN     VOID                    *Scratch,
 397   IN OUT UINTN                   *ScratchSize,
 398   IN     CONST MTRR_MEMORY_RANGE *Ranges,
 399   IN     UINTN                   RangeCount
 400   );
 401 #endif // _MTRR_LIB_H_