code.delx.au - refind/blob - EfiLib/legacy.h

   1 /*
   2  * EfiLib/legacy.h
   3  * CSM/legacy boot support functions
   4  *
   5  * Taken from Tianocore source code (mostly IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c)
   6  *
   7  * Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>
   8  * This program and the accompanying materials
   9  * are licensed and made available under the terms and conditions of the BSD License
  10  * which accompanies this distribution.  The full text of the license may be found at
  11  * http://opensource.org/licenses/bsd-license.php
  12  *
  13  * THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15  *
  16  */
  17
  18 #ifndef __LEGACY_H_
  19 #define __LEGACY_H_
  20
  21 typedef UINT8 BBS_TYPE;
  22
  23 #define VAR_FLAG  EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE
  24
  25 #pragma pack(1)
  26 ///
  27 /// For each legacy boot option in BBS table, a corresponding Boot#### variables is created.
  28 /// The structure saves the mapping relationship between #### and the index in the BBS table.
  29 ///
  30 typedef struct {
  31    UINT16    BootOptionNumber;
  32    UINT16    BbsIndex;
  33    UINT16    BbsType;
  34 } BOOT_OPTION_BBS_MAPPING;
  35 #pragma pack()
  36
  37 #pragma pack(1)
  38 typedef struct {
  39    BBS_TYPE  BbsType;
  40    ///
  41    /// Length = sizeof (UINT16) + sizeof (Data)
  42    ///
  43    UINT16    Length;
  44    UINT16    Data[1];
  45 } LEGACY_DEV_ORDER_ENTRY;
  46 #pragma pack()
  47
  48 EFI_STATUS
  49 EFIAPI
  50 BdsAddNonExistingLegacyBootOptions (
  51    VOID
  52 );
  53
  54 /**
  55   Delete all the invalid legacy boot options.
  56
  57   @retval EFI_SUCCESS             All invalide legacy boot options are deleted.
  58   @retval EFI_OUT_OF_RESOURCES    Fail to allocate necessary memory.
  59   @retval EFI_NOT_FOUND           Fail to retrive variable of boot order.
  60 **/
  61 EFI_STATUS
  62 EFIAPI
  63 BdsDeleteAllInvalidLegacyBootOptions (
  64   VOID
  65   );
  66
  67 /**
  68   Add the legacy boot devices from BBS table into
  69   the legacy device boot order.
  70
  71   @retval EFI_SUCCESS           The boot devices are added successfully.
  72   @retval EFI_NOT_FOUND         The legacy boot devices are not found.
  73   @retval EFI_OUT_OF_RESOURCES  Memmory or storage is not enough.
  74   @retval EFI_DEVICE_ERROR      Fail to add the legacy device boot order into EFI variable
  75                                 because of hardware error.
  76 **/
  77 EFI_STATUS
  78 EFIAPI
  79 BdsUpdateLegacyDevOrder (
  80   VOID
  81   );
  82
  83 #endif