Clean up BootMaint module in BdsDxe.

[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / BootMaint / BBSsupport.h

/** @file\r
  declares interface functions\r
\r
Copyright (c) 2004 - 2008, 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 _EFI_BDS_BBS_SUPPORT_H_\r
#define _EFI_BDS_BBS_SUPPORT_H_\r
\r
#include "BootMaint.h"\r
\r
#define MAX_BBS_ENTRIES 0x100\r
\r
/**\r
  Build Legacy Device Name String according.\r
\r
  @param CurBBSEntry     BBS Table.\r
  @param Index           Index.\r
  @param BufSize         The buffer size.\r
  @param BootString      The output string.\r
\r
  @return VOID           No output.\r
\r
**/\r
VOID\r
BdsBuildLegacyDevNameString (\r
  IN BBS_TABLE                     *CurBBSEntry,\r
  IN UINTN                         Index,\r
  IN UINTN                         BufSize,\r
  OUT CHAR16                       *BootString\r
  );\r
\r
/**\r
  Delete all the invalid legacy boot options.\r
\r
  \r
\r
  @retval EFI_SUCCESS             All invalide legacy boot options are deleted.\r
  @retval EFI_OUT_OF_RESOURCES    Fail to allocate necessary memory.\r
  @retval EFI_NOT_FOUND           Fail to retrive variable of boot order.\r
**/\r
EFI_STATUS\r
BdsDeleteAllInvalidLegacyBootOptions (\r
  VOID\r
  );\r
\r
/**\r
\r
  Add the legacy boot options from BBS table if they do not exist.\r
\r
\r
  \r
\r
  @retval  EFI_SUCCESS        The boot options are added successfully or they are already in boot options.\r
  @retval  others             An error occurred when creating legacy boot options.\r
\r
**/\r
EFI_STATUS\r
BdsAddNonExistingLegacyBootOptions (\r
  VOID\r
  )\r
;\r
\r
/**\r
\r
  Add the legacy boot devices from BBS table into \r
  the legacy device boot order.\r
\r
  @retval EFI_SUCCESS       The boot devices are added successfully.\r
\r
**/\r
EFI_STATUS\r
BdsUpdateLegacyDevOrder (\r
  VOID\r
  );\r
\r
/**\r
\r
  Set the boot priority for BBS entries based on boot option entry and boot order.\r
\r
  @param  Entry             The boot option is to be checked for refresh BBS table.\r
  \r
  @retval EFI_SUCCESS       The boot priority for BBS entries is refreshed successfully.\r
\r
**/\r
EFI_STATUS\r
BdsRefreshBbsTableForBoot (\r
  IN BDS_COMMON_OPTION        *Entry\r
  );\r
\r
#endif\r