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   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef __NV_VARS_FILE_LIB__
  10 #define __NV_VARS_FILE_LIB__
  11
  12 /**
  13   Attempts to connect the NvVarsFileLib to the specified file system.
  14
  15   @param[in]  FsHandle - Handle for a gEfiSimpleFileSystemProtocolGuid instance
  16
  17   @return     The EFI_STATUS while attempting to connect the NvVarsFileLib
  18               to the file system instance.
  19   @retval     EFI_SUCCESS - The given file system was connected successfully
  20
  21 **/
  22 EFI_STATUS
  23 EFIAPI
  24 ConnectNvVarsToFileSystem (
  25   IN EFI_HANDLE  FsHandle
  26   );
  27
  28 /**
  29   Update non-volatile variables stored on the file system.
  30
  31   @return     The EFI_STATUS while attempting to update the variable on
  32               the connected file system.
  33   @retval     EFI_SUCCESS - The non-volatile variables were saved to the disk
  34   @retval     EFI_NOT_STARTED - A file system has not been connected
  35
  36 **/
  37 EFI_STATUS
  38 EFIAPI
  39 UpdateNvVarsOnFileSystem (
  40   );
  41
  42 #endif