EmbeddedPkg: introduce NvVarStoreFormattedLib
[mirror_edk2.git] / EmbeddedPkg / Library / NvVarStoreFormattedLib / NvVarStoreFormattedLib.inf
1 ## @file
2 # A hook-in library for:
3 # - MdeModulePkg/Universal/Variable/Pei/VariablePei.inf
4 # - MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
5 # - MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
6 #
7 # Plugging this library instance into one of the above modules makes that
8 # variable service backend wait for another platform module to dynamically
9 # initialize or verify EFI_FIRMWARE_VOLUME_HEADER and VARIABLE_STORE_HEADER in
10 # the non-volatile variable store FVB device. The initialization / verification
11 # is signaled by installing gEdkiiNvVarStoreFormattedGuid into the
12 # phase-matching PPI or protocol database, with a NULL interface. (Note that
13 # installing gEdkiiNvVarStoreFormattedGuid into either the DXE or the MM
14 # protocol database will unblock VariableSmm -- refer to EFI_SECTION_MM_DEPEX
15 # in the PI spec.)
16 #
17 # Copyright (C) 2018, Red Hat, Inc.
18 #
19 # This program and the accompanying materials are licensed and made available
20 # under the terms and conditions of the BSD License which accompanies this
21 # distribution. The full text of the license may be found at
22 # http://opensource.org/licenses/bsd-license.php
23 #
24 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT
25 # WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
26 ##
27
28 [Defines]
29 INF_VERSION = 1.27
30 BASE_NAME = NvVarStoreFormattedLib
31 FILE_GUID = 78f76ae8-ae62-4455-8148-c3a7ebaaa3f3
32 MODULE_TYPE = BASE
33 VERSION_STRING = 1.0
34 LIBRARY_CLASS = NvVarStoreFormattedLib|PEIM DXE_RUNTIME_DRIVER DXE_SMM_DRIVER
35 CONSTRUCTOR = NvVarStoreFormattedInitialize
36
37 [Sources]
38 NvVarStoreFormattedLib.c
39
40 [Packages]
41 EmbeddedPkg/EmbeddedPkg.dec
42 MdeModulePkg/MdeModulePkg.dec
43 MdePkg/MdePkg.dec
44
45 #
46 # The matching DEPEX section below will generate the EFI_SECTION_PEI_DEPEX,
47 # EFI_SECTION_DXE_DEPEX or EFI_SECTION_MM_DEPEX leaf section for the PEIM
48 # (EFI_FV_FILETYPE_PEIM), DXE_RUNTIME_DRIVER (EFI_FV_FILETYPE_DRIVER), or
49 # DXE_SMM_DRIVER (EFI_FV_FILETYPE_MM) module, respectively.
50 #
51 [Depex.common.PEIM, Depex.common.DXE_RUNTIME_DRIVER, Depex.common.DXE_SMM_DRIVER]
52 gEdkiiNvVarStoreFormattedGuid