EmbeddedPkg: introduce NvVarStoreFormattedLib

[mirror_edk2.git] / EmbeddedPkg / Library / NvVarStoreFormattedLib / NvVarStoreFormattedLib.inf

diff --git a/EmbeddedPkg/Library/NvVarStoreFormattedLib/NvVarStoreFormattedLib.inf b/EmbeddedPkg/Library/NvVarStoreFormattedLib/NvVarStoreFormattedLib.inf
new file mode 100644 (file)
index 0000000..b02fc78
--- /dev/null
+++ b/EmbeddedPkg/Library/NvVarStoreFormattedLib/NvVarStoreFormattedLib.inf
@@ -0,0 +1,52 @@
+## @file\r
+# A hook-in library for:\r
+# - MdeModulePkg/Universal/Variable/Pei/VariablePei.inf\r
+# - MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf\r
+# - MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf\r
+#\r
+# Plugging this library instance into one of the above modules makes that\r
+# variable service backend wait for another platform module to dynamically\r
+# initialize or verify EFI_FIRMWARE_VOLUME_HEADER and VARIABLE_STORE_HEADER in\r
+# the non-volatile variable store FVB device. The initialization / verification\r
+# is signaled by installing gEdkiiNvVarStoreFormattedGuid into the\r
+# phase-matching PPI or protocol database, with a NULL interface. (Note that\r
+# installing gEdkiiNvVarStoreFormattedGuid into either the DXE or the MM\r
+# protocol database will unblock VariableSmm -- refer to EFI_SECTION_MM_DEPEX\r
+# in the PI spec.)\r
+#\r
+# Copyright (C) 2018, Red Hat, Inc.\r
+#\r
+# This program and the accompanying materials are licensed and made available\r
+# under the terms and conditions of the BSD License which accompanies this\r
+# 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, WITHOUT\r
+# WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+##\r
+\r
+[Defines]\r
+  INF_VERSION                    = 1.27\r
+  BASE_NAME                      = NvVarStoreFormattedLib\r
+  FILE_GUID                      = 78f76ae8-ae62-4455-8148-c3a7ebaaa3f3\r
+  MODULE_TYPE                    = BASE\r
+  VERSION_STRING                 = 1.0\r
+  LIBRARY_CLASS                  = NvVarStoreFormattedLib|PEIM DXE_RUNTIME_DRIVER DXE_SMM_DRIVER\r
+  CONSTRUCTOR                    = NvVarStoreFormattedInitialize\r
+\r
+[Sources]\r
+  NvVarStoreFormattedLib.c\r
+\r
+[Packages]\r
+  EmbeddedPkg/EmbeddedPkg.dec\r
+  MdeModulePkg/MdeModulePkg.dec\r
+  MdePkg/MdePkg.dec\r
+\r
+#\r
+# The matching DEPEX section below will generate the EFI_SECTION_PEI_DEPEX,\r
+# EFI_SECTION_DXE_DEPEX or EFI_SECTION_MM_DEPEX leaf section for the PEIM\r
+# (EFI_FV_FILETYPE_PEIM), DXE_RUNTIME_DRIVER (EFI_FV_FILETYPE_DRIVER), or\r
+# DXE_SMM_DRIVER (EFI_FV_FILETYPE_MM) module, respectively.\r
+#\r
+[Depex.common.PEIM, Depex.common.DXE_RUNTIME_DRIVER, Depex.common.DXE_SMM_DRIVER]\r
+  gEdkiiNvVarStoreFormattedGuid\r