OvmfPkg/Include/Library/NvVarsFileLib.h

   1 /** @file
   2   Provides functions to save and restore NV variables in a file.
   3
   4   Copyright (c) 2009, 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__
  16 #define __NV_VARS_FILE_LIB__
  17
  18 /**
  19   Attempts to connect the NvVarsFileLib to the specified file system.
  20
  21   @param[in]  FsHandle - Handle for a gEfiSimpleFileSystemProtocolGuid instance
  22
  23   @return     The EFI_STATUS while attempting to connect the NvVarsFileLib
  24               to the file system instance.
  25   @retval     EFI_SUCCESS - The given file system was connected successfully
  26
  27 **/
  28 EFI_STATUS
  29 EFIAPI
  30 ConnectNvVarsToFileSystem (
  31   IN EFI_HANDLE    FsHandle
  32   );
  33
  34
  35 /**
  36   Update non-volatile variables stored on the file system.
  37
  38   @return     The EFI_STATUS while attempting to update the variable on
  39               the connected file system.
  40   @retval     EFI_SUCCESS - The non-volatile variables were saved to the disk
  41   @retval     EFI_NOT_STARTED - A file system has not been connected
  42
  43 **/
  44 EFI_STATUS
  45 EFIAPI
  46 UpdateNvVarsOnFileSystem (
  47   );
  48
  49
  50 #endif
  51