Implement NvVarsFileLib to save and restore non-volatile variables using a file.

[mirror_edk2.git] / OvmfPkg / Include / Library / NvVarsFileLib.h

/** @file\r
  Provides functions to save and restore NV variables in a file.\r
\r
  Copyright (c) 2009, Intel Corporation<BR>\r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __NV_VARS_FILE_LIB__\r
#define __NV_VARS_FILE_LIB__\r
\r
/**\r
  Attempts to connect the NvVarsFileLib to the specified file system.\r
\r
  @param[in]  FsHandle - Handle for a gEfiSimpleFileSystemProtocolGuid instance\r
\r
  @return     The EFI_STATUS while attempting to connect the NvVarsFileLib\r
              to the file system instance.\r
  @retval     EFI_SUCCESS - The given file system was connected successfully\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ConnectNvVarsToFileSystem (\r
  IN EFI_HANDLE    FsHandle\r
  );\r
\r
#endif\r
\r