Update all files to follow doxygen style file header.

[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
// Bugbug: Candidate for a PCD entries\r
//\r
#define MAX_BBS_ENTRIES 0x100\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
EFI_STATUS\r
BdsDeleteAllInvalidLegacyBootOptions (\r
  VOID\r
  );\r
\r
EFI_STATUS\r
BdsAddNonExistingLegacyBootOptions (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Add the legacy boot options from BBS table if they do not exist.\r
\r
Arguments:\r
\r
  None.\r
\r
Returns:\r
\r
  EFI_SUCCESS       - The boot options are added successfully or they are already in boot options.\r
  others            - An error occurred when creating legacy boot options.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
BdsUpdateLegacyDevOrder (\r
  VOID\r
  );\r
\r
EFI_STATUS\r
BdsRefreshBbsTableForBoot (\r
  IN BDS_COMMON_OPTION        *Entry\r
  );\r
\r
#endif\r