IntelFrameworkModulePkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  declares interface functions\r
\r
Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _EFI_BDS_BBS_SUPPORT_H_\r
#define _EFI_BDS_BBS_SUPPORT_H_\r
\r
#include "BootMaint.h"\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
  Group the legacy boot options in the BootOption.\r
\r
  The routine assumes the boot options in the beginning that covers all the device\r
  types are ordered properly and re-position the following boot options just after\r
  the corresponding boot options with the same device type.\r
  For example:\r
  1. Input  = [Harddisk1 CdRom2 Efi1 Harddisk0 CdRom0 CdRom1 Harddisk2 Efi0]\r
     Assuming [Harddisk1 CdRom2 Efi1] is ordered properly\r
     Output = [Harddisk1 Harddisk0 Harddisk2 CdRom2 CdRom0 CdRom1 Efi1 Efi0]\r
\r
  2. Input  = [Efi1 Efi0 CdRom1 Harddisk0 Harddisk1 Harddisk2 CdRom0 CdRom2]\r
     Assuming [Efi1 Efi0 CdRom1 Harddisk0] is ordered properly\r
     Output = [Efi1 Efi0 CdRom1 CdRom0 CdRom2 Harddisk0 Harddisk1 Harddisk2]\r
**/\r
VOID\r
GroupMultipleLegacyBootOption4SameType (\r
  VOID\r
  );\r
\r
/**\r
  Re-order the Boot Option according to the DevOrder.\r
\r
  The routine re-orders the Boot Option in BootOption array according to\r
  the order specified by DevOrder.\r
\r
  @param DevOrder           Pointer to buffer containing the BBS Index,\r
                            high 8-bit value 0xFF indicating a disabled boot option\r
  @param DevOrderCount      Count of the BBS Index\r
  @param EnBootOption       Callee allocated buffer containing the enabled Boot Option Numbers\r
  @param EnBootOptionCount  Count of the enabled Boot Option Numbers\r
  @param DisBootOption      Callee allocated buffer containing the disabled Boot Option Numbers\r
  @param DisBootOptionCount Count of the disabled Boot Option Numbers\r
**/\r
VOID\r
OrderLegacyBootOption4SameType (\r
  UINT16                   *DevOrder,\r
  UINTN                    DevOrderCount,\r
  UINT16                   **EnBootOption,\r
  UINTN                    *EnBootOptionCount,\r
  UINT16                   **DisBootOption,\r
  UINTN                    *DisBootOptionCount\r
  );\r
#endif\r