MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.h

   1 /** @file
   2   declares interface functions
   3
   4 Copyright (c) 2004 - 2008, Intel Corporation. <BR>
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _EFI_BDS_BBS_SUPPORT_H
  16 #define _EFI_BDS_BBS_SUPPORT_H
  17
  18 #include "BootMaint.h"
  19 //
  20 // Bugbug: Candidate for a PCD entries
  21 //
  22 #define MAX_BBS_ENTRIES 0x100
  23
  24 /**
  25   EDES_TODO: Add function description.
  26
  27   @param CurBBSEntry     EDES_TODO: Add parameter description
  28   @param Index           EDES_TODO: Add parameter description
  29   @param BufSize         EDES_TODO: Add parameter description
  30   @param BootString      EDES_TODO: Add parameter description
  31
  32   @return EDES_TODO: Add description for return value
  33
  34 **/
  35 VOID
  36 BdsBuildLegacyDevNameString (
  37   IN BBS_TABLE                     *CurBBSEntry,
  38   IN UINTN                         Index,
  39   IN UINTN                         BufSize,
  40   OUT CHAR16                       *BootString
  41   );
  42
  43 /**
  44   EDES_TODO: Add function description.
  45
  46   @param VOID            EDES_TODO: Add parameter description
  47
  48   @return EDES_TODO: Add description for return value
  49
  50 **/
  51 EFI_STATUS
  52 BdsDeleteAllInvalidLegacyBootOptions (
  53   VOID
  54   );
  55
  56 /**
  57
  58   Add the legacy boot options from BBS table if they do not exist.
  59
  60
  61   @param VOID            EDES_TODO: Add parameter description
  62
  63   @retval  EFI_SUCCESS        The boot options are added successfully or they are already in boot options.
  64   @retval  others             An error occurred when creating legacy boot options.
  65
  66 **/
  67 EFI_STATUS
  68 BdsAddNonExistingLegacyBootOptions (
  69   VOID
  70   )
  71 ;
  72
  73 /**
  74   EDES_TODO: Add function description.
  75
  76   @param VOID            EDES_TODO: Add parameter description
  77
  78   @return EDES_TODO: Add description for return value
  79
  80 **/
  81 EFI_STATUS
  82 BdsUpdateLegacyDevOrder (
  83   VOID
  84   );
  85
  86 /**
  87   EDES_TODO: Add function description.
  88
  89   @param Entry           EDES_TODO: Add parameter description
  90
  91   @return EDES_TODO: Add description for return value
  92
  93 **/
  94 EFI_STATUS
  95 BdsRefreshBbsTableForBoot (
  96   IN BDS_COMMON_OPTION        *Entry
  97   );
  98
  99 #endif