MdeModulePkg/Include/Library/VariableFlashInfoLib.h

   1 /** @file
   2   Variable Flash Information Library
   3
   4 Copyright (c) Microsoft Corporation<BR>
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef VARIABLE_FLASH_INFO_LIB_H_
  10 #define VARIABLE_FLASH_INFO_LIB_H_
  11
  12 /**
  13   Get the base address and size for the NV storage area used for UEFI variable storage.
  14
  15   @param[out] BaseAddress    The NV storage base address.
  16   @param[out] Length         The NV storage length in bytes.
  17
  18   @retval EFI_SUCCESS             NV storage information was found successfully.
  19   @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
  20   @retval EFI_NOT_FOUND           NV storage information could not be found.
  21
  22 **/
  23 EFI_STATUS
  24 EFIAPI
  25 GetVariableFlashNvStorageInfo (
  26   OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
  27   OUT UINT64                *Length
  28   );
  29
  30 /**
  31   Get the base address and size for the fault tolerant write (FTW) spare
  32   area used for UEFI variable storage.
  33
  34   @param[out] BaseAddress    The FTW spare base address.
  35   @param[out] Length         The FTW spare length in bytes.
  36
  37   @retval EFI_SUCCESS             FTW spare information was found successfully.
  38   @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
  39   @retval EFI_NOT_FOUND           FTW spare information could not be found.
  40
  41 **/
  42 EFI_STATUS
  43 EFIAPI
  44 GetVariableFlashFtwSpareInfo (
  45   OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
  46   OUT UINT64                *Length
  47   );
  48
  49 /**
  50   Get the base address and size for the fault tolerant write (FTW) working
  51   area used for UEFI variable storage.
  52
  53   @param[out] BaseAddress    The FTW working area base address.
  54   @param[out] Length         The FTW working area length in bytes.
  55
  56   @retval EFI_SUCCESS             FTW working information was found successfully.
  57   @retval EFI_INVALID_PARAMETER   A required pointer parameter is NULL.
  58   @retval EFI_NOT_FOUND           FTW working information could not be found.
  59
  60 **/
  61 EFI_STATUS
  62 EFIAPI
  63 GetVariableFlashFtwWorkingInfo (
  64   OUT EFI_PHYSICAL_ADDRESS  *BaseAddress,
  65   OUT UINT64                *Length
  66   );
  67
  68 #endif