OvmfPkg/Library/NvVarsFileLib/NvVarsFileLib.h

   1 /** @file
   2   Save Non-Volatile Variables to a file system.
   3
   4   Copyright (c) 2009 - 2011, 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 __NV_VARS_FILE_LIB_INSTANCE__
  16 #define __NV_VARS_FILE_LIB_INSTANCE__
  17
  18 #include <Uefi.h>
  19
  20 #include <Guid/FileInfo.h>
  21
  22 #include <Protocol/SimpleFileSystem.h>
  23
  24 #include <Library/BaseLib.h>
  25 #include <Library/FileHandleLib.h>
  26 #include <Library/SerializeVariablesLib.h>
  27 #include <Library/UefiBootServicesTableLib.h>
  28 #include <Library/UefiRuntimeServicesTableLib.h>
  29 #include <Library/UefiLib.h>
  30
  31 /**
  32   Loads the non-volatile variables from the NvVars file on the
  33   given file system.
  34
  35   @param[in]  FsHandle - Handle for a gEfiSimpleFileSystemProtocolGuid instance
  36
  37   @return     EFI_STATUS based on the success or failure of load operation
  38
  39 **/
  40 EFI_STATUS
  41 LoadNvVarsFromFs (
  42   EFI_HANDLE                            FsHandle
  43   );
  44
  45
  46 /**
  47   Saves the non-volatile variables into the NvVars file on the
  48   given file system.
  49
  50   @param[in]  FsHandle - Handle for a gEfiSimpleFileSystemProtocolGuid instance
  51
  52   @return     EFI_STATUS based on the success or failure of load operation
  53
  54 **/
  55 EFI_STATUS
  56 SaveNvVarsToFs (
  57   EFI_HANDLE                            FsHandle
  58   );
  59
  60 #endif
  61