New CSM/BIOS/legacy support code for UEFI PCs.

[refind] / EfiLib / legacy.h

diff --git a/EfiLib/legacy.h b/EfiLib/legacy.h
new file mode 100644 (file)
index 0000000..61dba38
--- /dev/null
+++ b/EfiLib/legacy.h
@@ -0,0 +1,70 @@
+/*
+ * EfiLib/legacy.h
+ * CSM/legacy boot support functions
+ * 
+ * Taken from Tianocore source code (mostly IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.c)
+ *
+ * Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>
+ * This program and the accompanying materials
+ * are licensed and made available under the terms and conditions of the BSD License
+ * which accompanies this distribution.  The full text of the license may be found at
+ * http://opensource.org/licenses/bsd-license.php
+ * 
+ * THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+ *
+ */
+
+#ifndef __LEGACY_H_
+#define __LEGACY_H_
+
+#define VAR_FLAG  EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE
+
+#pragma pack(1)
+///
+/// For each legacy boot option in BBS table, a corresponding Boot#### variables is created.
+/// The structure saves the mapping relationship between #### and the index in the BBS table.
+///
+typedef struct {
+   UINT16    BootOptionNumber;
+   UINT16    BbsIndex;
+   UINT16    BbsType;
+} BOOT_OPTION_BBS_MAPPING;
+#pragma pack()
+
+EFI_STATUS
+EFIAPI
+BdsAddNonExistingLegacyBootOptions (
+   VOID
+);
+
+/**
+  Delete all the invalid legacy boot options.
+
+  @retval EFI_SUCCESS             All invalide legacy boot options are deleted.
+  @retval EFI_OUT_OF_RESOURCES    Fail to allocate necessary memory.
+  @retval EFI_NOT_FOUND           Fail to retrive variable of boot order.
+**/
+EFI_STATUS
+EFIAPI
+BdsDeleteAllInvalidLegacyBootOptions (
+  VOID
+  );
+
+/**
+  Add the legacy boot devices from BBS table into 
+  the legacy device boot order.
+
+  @retval EFI_SUCCESS           The boot devices are added successfully.
+  @retval EFI_NOT_FOUND         The legacy boot devices are not found.
+  @retval EFI_OUT_OF_RESOURCES  Memmory or storage is not enough.
+  @retval EFI_DEVICE_ERROR      Fail to add the legacy device boot order into EFI variable
+                                because of hardware error.
+**/
+// EFI_STATUS
+// EFIAPI
+// BdsUpdateLegacyDevOrder (
+//   VOID
+//   );
+
+#endif
\ No newline at end of file