| 1 | /** @file
|
|---|
| 2 | This file provides location and format of a firmware volume.
|
|---|
| 3 |
|
|---|
| 4 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
|---|
| 5 | SPDX-License-Identifier: BSD-2-Clause-Patent
|
|---|
| 6 |
|
|---|
| 7 | @par Revision Reference:
|
|---|
| 8 | This PPI is introduced in PI Version 1.0.
|
|---|
| 9 |
|
|---|
| 10 | **/
|
|---|
| 11 |
|
|---|
| 12 | #ifndef __EFI_PEI_FIRMWARE_VOLUME_INFO_H__
|
|---|
| 13 | #define __EFI_PEI_FIRMWARE_VOLUME_INFO_H__
|
|---|
| 14 |
|
|---|
| 15 |
|
|---|
| 16 |
|
|---|
| 17 | #define EFI_PEI_FIRMWARE_VOLUME_INFO_PPI_GUID \
|
|---|
| 18 | { 0x49edb1c1, 0xbf21, 0x4761, { 0xbb, 0x12, 0xeb, 0x0, 0x31, 0xaa, 0xbb, 0x39 } }
|
|---|
| 19 |
|
|---|
| 20 | typedef struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI EFI_PEI_FIRMWARE_VOLUME_INFO_PPI;
|
|---|
| 21 |
|
|---|
| 22 | ///
|
|---|
| 23 | /// This PPI describes the location and format of a firmware volume.
|
|---|
| 24 | /// The FvFormat can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for
|
|---|
| 25 | /// a user-defined format. The EFI_FIRMWARE_FILE_SYSTEM2_GUID is
|
|---|
| 26 | /// the PI Firmware Volume format.
|
|---|
| 27 | ///
|
|---|
| 28 | struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI {
|
|---|
| 29 | ///
|
|---|
| 30 | /// Unique identifier of the format of the memory-mapped firmware volume.
|
|---|
| 31 | ///
|
|---|
| 32 | EFI_GUID FvFormat;
|
|---|
| 33 | ///
|
|---|
| 34 | /// Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process
|
|---|
| 35 | /// the volume. The format of this buffer is specific to the FvFormat.
|
|---|
| 36 | /// For memory-mapped firmware volumes, this typically points to the first byte
|
|---|
| 37 | /// of the firmware volume.
|
|---|
| 38 | ///
|
|---|
| 39 | VOID *FvInfo;
|
|---|
| 40 | ///
|
|---|
| 41 | /// Size of the data provided by FvInfo. For memory-mapped firmware volumes,
|
|---|
| 42 | /// this is typically the size of the firmware volume.
|
|---|
| 43 | ///
|
|---|
| 44 | UINT32 FvInfoSize;
|
|---|
| 45 | ///
|
|---|
| 46 | /// If the firmware volume originally came from a firmware file, then these
|
|---|
| 47 | /// point to the parent firmware volume name and firmware volume file.
|
|---|
| 48 | /// If it did not originally come from a firmware file, these should be NULL.
|
|---|
| 49 | ///
|
|---|
| 50 | EFI_GUID *ParentFvName;
|
|---|
| 51 | ///
|
|---|
| 52 | /// If the firmware volume originally came from a firmware file, then these
|
|---|
| 53 | /// point to the parent firmware volume name and firmware volume file.
|
|---|
| 54 | /// If it did not originally come from a firmware file, these should be NULL.
|
|---|
| 55 | ///
|
|---|
| 56 | EFI_GUID *ParentFileName;
|
|---|
| 57 | };
|
|---|
| 58 |
|
|---|
| 59 | extern EFI_GUID gEfiPeiFirmwareVolumeInfoPpiGuid;
|
|---|
| 60 |
|
|---|
| 61 | #endif
|
|---|
| 62 |
|
|---|
