EmbeddedPkg: introduce NvVarStoreFormattedLib

[mirror_edk2.git] / EmbeddedPkg / Include / Guid / NvVarStoreFormatted.h

diff --git a/EmbeddedPkg/Include/Guid/NvVarStoreFormatted.h b/EmbeddedPkg/Include/Guid/NvVarStoreFormatted.h
new file mode 100644 (file)
index 0000000..4e057e4
--- /dev/null
+++ b/EmbeddedPkg/Include/Guid/NvVarStoreFormatted.h
@@ -0,0 +1,39 @@
+/** @file\r
+  EDKII NvVarStore Formatted GUID\r
+\r
+  A NULL protocol instance with this GUID in the DXE and/or MM protocol\r
+  databases, and/or a NULL PPI with this GUID in the PPI database, implies that\r
+  a DXE or MM driver, or a PEIM, has verified (or dynamically ensured) that the\r
+  non-volatile variable store has valid and consistent headers\r
+  (EFI_FIRMWARE_VOLUME_HEADER and VARIABLE_STORE_HEADER).\r
+\r
+  Said predicate is required by the read-only variable PEIM, and the read side\r
+  of the runtime variable DXE and MM drivers, immediately after they are\r
+  dispatched. This GUID presents platforms with one way to coordinate between\r
+  their module(s) that format the variable store FVB device and the variable\r
+  service drivers.\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 that 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
+\r
+#ifndef __EDKII_NV_VAR_STORE_FORMATTED_H__\r
+#define __EDKII_NV_VAR_STORE_FORMATTED_H__\r
+\r
+#define EDKII_NV_VAR_STORE_FORMATTED_GUID \\r
+  { \\r
+    0xd1a86e3f, 0x0707, 0x4c35, \\r
+    { 0x83, 0xcd, 0xdc, 0x2c, 0x29, 0xc8, 0x91, 0xa3 } \\r
+  }\r
+\r
+extern EFI_GUID gEdkiiNvVarStoreFormattedGuid;\r
+\r
+#endif\r