OvmfPkg/PlatformBootManagerLib: rejuvenate old-style function comments

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

/** @file\r
  Save Non-Volatile Variables to a file system.\r
\r
  Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
  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_INSTANCE__\r
#define __NV_VARS_FILE_LIB_INSTANCE__\r
\r
#include <Uefi.h>\r
\r
#include <Guid/FileInfo.h>\r
\r
#include <Protocol/SimpleFileSystem.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/FileHandleLib.h>\r
#include <Library/SerializeVariablesLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
\r
/**\r
  Loads the non-volatile variables from the NvVars file on the\r
  given file system.\r
\r
  @param[in]  FsHandle - Handle for a gEfiSimpleFileSystemProtocolGuid instance\r
\r
  @return     EFI_STATUS based on the success or failure of load operation\r
\r
**/\r
EFI_STATUS\r
LoadNvVarsFromFs (\r
  EFI_HANDLE                            FsHandle\r
  );\r
\r
\r
/**\r
  Saves the non-volatile variables into the NvVars file on the\r
  given file system.\r
\r
  @param[in]  FsHandle - Handle for a gEfiSimpleFileSystemProtocolGuid instance\r
\r
  @return     EFI_STATUS based on the success or failure of load operation\r
\r
**/\r
EFI_STATUS\r
SaveNvVarsToFs (\r
  EFI_HANDLE                            FsHandle\r
  );\r
\r
#endif\r
\r