Add PPI definitions introduced in PI1.0.

[mirror_edk2.git] / MdePkg / Include / Ppi / FirmwareVolumeInfo.h

diff --git a/MdePkg/Include/Ppi/FirmwareVolumeInfo.h b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
new file mode 100644 (file)
index 0000000..7f8698d
--- /dev/null
+++ b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
@@ -0,0 +1,69 @@
+/* @file\r
+  This file provides location and format of a firmware volume.\r
+\r
+  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  All rights reserved. This program and the accompanying materials                          \r
+  are licensed and made available under the terms and conditions of the BSD License         \r
+  which accompanies this 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,                     \r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+\r
+  Module Name:  FirmwareVolumeInfo.h\r
+\r
+  @par Revision Reference:\r
+  This PPI is defined in PI.\r
+  Version 1.00\r
+\r
+**/\r
+\r
+#ifndef __EFI_PEI_FIRMWARE_VOLUME_INFO_H__\r
+#define __EFI_PEI_FIRMWARE_VOLUME_INFO_H__\r
+\r
+\r
+\r
+#define EFI_PEI_FIRMWARE_VOLUME_INFO_PPI_GUID \\r
+{ 0x49edb1c1, 0xbf21, 0x4761, { 0xbb, 0x12, 0xeb, 0x0, 0x31, 0xaa, 0xbb, 0x39 } }\r
+\r
+typedef struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI       EFI_PEI_FIRMWARE_VOLUME_INFO_PPI;\r
+\r
+/**\r
+       This PPI describes the location and format of a firmware volume. \r
+       The FvFormat can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for \r
+       a user-defined format. The      EFI_FIRMWARE_FILE_SYSTEM2_GUID is \r
+       the PI Firmware Volume format.\r
+\r
+       @param  FvFormat                        Unique identifier of the format of the memory-mapped firmware volume.\r
+\r
+       @param  FvInfo                  Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to\r
+                                                                                               process the volume. The format of this buffer is \r
+                                                                                               specific to the FvFormat. For memory-mapped firmware volumes, \r
+                                                                                               this typically points to the first byte of the firmware volume.\r
+\r
+       @param  FvInfoSize      Size of the data provided by FvInfo. For memory-mapped firmware volumes,\r
+                                                                                               this is typically the size of the firmware volume.\r
+\r
+       @param  ParentFvName    If the firmware volume originally came from a firmware file, \r
+                                                                                               then these point to the parent firmware volume\r
+                                                                                               name and firmware volume file. If it did not originally come\r
+                                                                                               from a firmware file, these should be NULL.\r
+\r
+       @param  ParentFileName  If the firmware volume originally came from a firmware file, \r
+                                                                                               then these point to the parent firmware volume\r
+                                                                                               name and firmware volume file. If it did not originally come\r
+                                                                                               from a firmware file, these should be NULL.\r
+\r
+**/\r
+struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI {\r
+       EFI_GUID        FvFormat;\r
+       VOID                    *FvInfo;\r
+       UINT32          FvInfoSize;\r
+       EFI_GUID        *ParentFvName;\r
+       EFI_GUID        *ParentFileName;\r
+};\r
+\r
+extern EFI_GUID        gEfiPeiFirmwareVolumeInfoPpiGuid;\r
+\r
+#endif\r
+\r