diff options
Diffstat (limited to 'MdeModulePkg/Include/UniversalPayload')
| -rw-r--r-- | MdeModulePkg/Include/UniversalPayload/AcpiTable.h | 60 | ||||
| -rw-r--r-- | MdeModulePkg/Include/UniversalPayload/ExtraData.h | 62 | ||||
| -rw-r--r-- | MdeModulePkg/Include/UniversalPayload/PciRootBridges.h | 182 | ||||
| -rw-r--r-- | MdeModulePkg/Include/UniversalPayload/SerialPortInfo.h | 60 | ||||
| -rw-r--r-- | MdeModulePkg/Include/UniversalPayload/SmbiosTable.h | 60 | ||||
| -rw-r--r-- | MdeModulePkg/Include/UniversalPayload/UniversalPayload.h | 118 |
6 files changed, 271 insertions, 271 deletions
diff --git a/MdeModulePkg/Include/UniversalPayload/AcpiTable.h b/MdeModulePkg/Include/UniversalPayload/AcpiTable.h index 6b590b3932..8c9803a1c0 100644 --- a/MdeModulePkg/Include/UniversalPayload/AcpiTable.h +++ b/MdeModulePkg/Include/UniversalPayload/AcpiTable.h @@ -1,30 +1,30 @@ -/** @file
- Define the structure for the Universal Payload APCI table.
-
-Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>
-SPDX-License-Identifier: BSD-2-Clause-Patent
-
- @par Revision Reference:
- - Universal Payload Specification 0.75 (https://universalpayload.github.io/documentation/)
-**/
-
-#ifndef UNIVERSAL_PAYLOAD_ACPI_TABLE_H_
-#define UNIVERSAL_PAYLOAD_ACPI_TABLE_H_
-
-#include <Uefi.h>
-#include <UniversalPayload/UniversalPayload.h>
-
-#pragma pack(1)
-
-typedef struct {
- UNIVERSAL_PAYLOAD_GENERIC_HEADER Header;
- EFI_PHYSICAL_ADDRESS Rsdp;
-} UNIVERSAL_PAYLOAD_ACPI_TABLE;
-
-#pragma pack()
-
-#define UNIVERSAL_PAYLOAD_ACPI_TABLE_REVISION 1
-
-extern GUID gUniversalPayloadAcpiTableGuid;
-
-#endif // UNIVERSAL_PAYLOAD_ACPI_TABLE_H_
+/** @file + Define the structure for the Universal Payload APCI table. + +Copyright (c) 2021, Intel Corporation. All rights reserved.<BR> +SPDX-License-Identifier: BSD-2-Clause-Patent + + @par Revision Reference: + - Universal Payload Specification 0.75 (https://universalpayload.github.io/documentation/) +**/ + +#ifndef UNIVERSAL_PAYLOAD_ACPI_TABLE_H_ +#define UNIVERSAL_PAYLOAD_ACPI_TABLE_H_ + +#include <Uefi.h> +#include <UniversalPayload/UniversalPayload.h> + +#pragma pack(1) + +typedef struct { + UNIVERSAL_PAYLOAD_GENERIC_HEADER Header; + EFI_PHYSICAL_ADDRESS Rsdp; +} UNIVERSAL_PAYLOAD_ACPI_TABLE; + +#pragma pack() + +#define UNIVERSAL_PAYLOAD_ACPI_TABLE_REVISION 1 + +extern GUID gUniversalPayloadAcpiTableGuid; + +#endif // UNIVERSAL_PAYLOAD_ACPI_TABLE_H_ diff --git a/MdeModulePkg/Include/UniversalPayload/ExtraData.h b/MdeModulePkg/Include/UniversalPayload/ExtraData.h index 334dfd2b9e..c79e985f41 100644 --- a/MdeModulePkg/Include/UniversalPayload/ExtraData.h +++ b/MdeModulePkg/Include/UniversalPayload/ExtraData.h @@ -1,31 +1,31 @@ -/** @file
-
- Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>
- SPDX-License-Identifier: BSD-2-Clause-Patent
-
-**/
-
-#ifndef EXTRA_DATA_H_
-#define EXTRA_DATA_H_
-
-extern GUID gUniversalPayloadExtraDataGuid;
-
-#pragma pack(1)
-
-typedef struct {
- CHAR8 Identifier[16];
- EFI_PHYSICAL_ADDRESS Base;
- UINT64 Size;
-} UNIVERSAL_PAYLOAD_EXTRA_DATA_ENTRY;
-
-typedef struct {
- UNIVERSAL_PAYLOAD_GENERIC_HEADER Header;
- UINT32 Count;
- UNIVERSAL_PAYLOAD_EXTRA_DATA_ENTRY Entry[0];
-} UNIVERSAL_PAYLOAD_EXTRA_DATA;
-
-#pragma pack()
-
-#define UNIVERSAL_PAYLOAD_EXTRA_DATA_REVISION 1
-
-#endif
+/** @file + + Copyright (c) 2021, Intel Corporation. All rights reserved.<BR> + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef EXTRA_DATA_H_ +#define EXTRA_DATA_H_ + +extern GUID gUniversalPayloadExtraDataGuid; + +#pragma pack(1) + +typedef struct { + CHAR8 Identifier[16]; + EFI_PHYSICAL_ADDRESS Base; + UINT64 Size; +} UNIVERSAL_PAYLOAD_EXTRA_DATA_ENTRY; + +typedef struct { + UNIVERSAL_PAYLOAD_GENERIC_HEADER Header; + UINT32 Count; + UNIVERSAL_PAYLOAD_EXTRA_DATA_ENTRY Entry[0]; +} UNIVERSAL_PAYLOAD_EXTRA_DATA; + +#pragma pack() + +#define UNIVERSAL_PAYLOAD_EXTRA_DATA_REVISION 1 + +#endif diff --git a/MdeModulePkg/Include/UniversalPayload/PciRootBridges.h b/MdeModulePkg/Include/UniversalPayload/PciRootBridges.h index 37260da3b1..98372b5243 100644 --- a/MdeModulePkg/Include/UniversalPayload/PciRootBridges.h +++ b/MdeModulePkg/Include/UniversalPayload/PciRootBridges.h @@ -1,91 +1,91 @@ -/** @file
- This file defines the structure for the PCI Root Bridges.
-
- Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>
- SPDX-License-Identifier: BSD-2-Clause-Patent
-
- @par Revision Reference:
- - Universal Payload Specification 0.75 (https://universalpayload.github.io/documentation/)
-**/
-
-#ifndef UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGES_H_
-#define UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGES_H_
-
-#include <UniversalPayload/UniversalPayload.h>
-
-#pragma pack(1)
-
-//
-// (Base > Limit) indicates an aperture is not available.
-//
-typedef struct {
- //
- // Base and Limit are the device address instead of host address when
- // Translation is not zero
- //
- UINT64 Base;
- UINT64 Limit;
- //
- // According to UEFI 2.7, Device Address = Host Address + Translation,
- // so Translation = Device Address - Host Address.
- // On platforms where Translation is not zero, the subtraction is probably to
- // be performed with UINT64 wrap-around semantics, for we may translate an
- // above-4G host address into a below-4G device address for legacy PCIe device
- // compatibility.
- //
- // NOTE: The alignment of Translation is required to be larger than any BAR
- // alignment in the same root bridge, so that the same alignment can be
- // applied to both device address and host address, which simplifies the
- // situation and makes the current resource allocation code in generic PCI
- // host bridge driver still work.
- //
- UINT64 Translation;
-} UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE;
-
-///
-/// Payload PCI Root Bridge Information HOB
-///
-typedef struct {
- UINT32 Segment; ///< Segment number.
- UINT64 Supports; ///< Supported attributes.
- ///< Refer to EFI_PCI_ATTRIBUTE_xxx used by GetAttributes()
- ///< and SetAttributes() in EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
- UINT64 Attributes; ///< Initial attributes.
- ///< Refer to EFI_PCI_ATTRIBUTE_xxx used by GetAttributes()
- ///< and SetAttributes() in EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
- BOOLEAN DmaAbove4G; ///< DMA above 4GB memory.
- ///< Set to TRUE when root bridge supports DMA above 4GB memory.
- BOOLEAN NoExtendedConfigSpace; ///< When FALSE, the root bridge supports
- ///< Extended (4096-byte) Configuration Space.
- ///< When TRUE, the root bridge supports
- ///< 256-byte Configuration Space only.
- UINT64 AllocationAttributes; ///< Allocation attributes.
- ///< Refer to EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM and
- ///< EFI_PCI_HOST_BRIDGE_MEM64_DECODE used by GetAllocAttributes()
- ///< in EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.
- UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE Bus; ///< Bus aperture which can be used by the root bridge.
- UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE Io; ///< IO aperture which can be used by the root bridge.
- UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE Mem; ///< MMIO aperture below 4GB which can be used by the root bridge.
- UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE MemAbove4G; ///< MMIO aperture above 4GB which can be used by the root bridge.
- UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE PMem; ///< Prefetchable MMIO aperture below 4GB which can be used by the root bridge.
- UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE PMemAbove4G; ///< Prefetchable MMIO aperture above 4GB which can be used by the root bridge.
- UINT32 HID; ///< PnP hardware ID of the root bridge. This value must match the corresponding
- ///< _HID in the ACPI name space.
- UINT32 UID; ///< Unique ID that is required by ACPI if two devices have the same _HID.
- ///< This value must also match the corresponding _UID/_HID pair in the ACPI name space.
-} UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE;
-
-typedef struct {
- UNIVERSAL_PAYLOAD_GENERIC_HEADER Header;
- BOOLEAN ResourceAssigned;
- UINT8 Count;
- UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE RootBridge[0];
-} UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGES;
-
-#pragma pack()
-
-#define UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGES_REVISION 1
-
-extern GUID gUniversalPayloadPciRootBridgeInfoGuid;
-
-#endif // UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGES_H_
+/** @file + This file defines the structure for the PCI Root Bridges. + + Copyright (c) 2021, Intel Corporation. All rights reserved.<BR> + SPDX-License-Identifier: BSD-2-Clause-Patent + + @par Revision Reference: + - Universal Payload Specification 0.75 (https://universalpayload.github.io/documentation/) +**/ + +#ifndef UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGES_H_ +#define UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGES_H_ + +#include <UniversalPayload/UniversalPayload.h> + +#pragma pack(1) + +// +// (Base > Limit) indicates an aperture is not available. +// +typedef struct { + // + // Base and Limit are the device address instead of host address when + // Translation is not zero + // + UINT64 Base; + UINT64 Limit; + // + // According to UEFI 2.7, Device Address = Host Address + Translation, + // so Translation = Device Address - Host Address. + // On platforms where Translation is not zero, the subtraction is probably to + // be performed with UINT64 wrap-around semantics, for we may translate an + // above-4G host address into a below-4G device address for legacy PCIe device + // compatibility. + // + // NOTE: The alignment of Translation is required to be larger than any BAR + // alignment in the same root bridge, so that the same alignment can be + // applied to both device address and host address, which simplifies the + // situation and makes the current resource allocation code in generic PCI + // host bridge driver still work. + // + UINT64 Translation; +} UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE; + +/// +/// Payload PCI Root Bridge Information HOB +/// +typedef struct { + UINT32 Segment; ///< Segment number. + UINT64 Supports; ///< Supported attributes. + ///< Refer to EFI_PCI_ATTRIBUTE_xxx used by GetAttributes() + ///< and SetAttributes() in EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL. + UINT64 Attributes; ///< Initial attributes. + ///< Refer to EFI_PCI_ATTRIBUTE_xxx used by GetAttributes() + ///< and SetAttributes() in EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL. + BOOLEAN DmaAbove4G; ///< DMA above 4GB memory. + ///< Set to TRUE when root bridge supports DMA above 4GB memory. + BOOLEAN NoExtendedConfigSpace; ///< When FALSE, the root bridge supports + ///< Extended (4096-byte) Configuration Space. + ///< When TRUE, the root bridge supports + ///< 256-byte Configuration Space only. + UINT64 AllocationAttributes; ///< Allocation attributes. + ///< Refer to EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM and + ///< EFI_PCI_HOST_BRIDGE_MEM64_DECODE used by GetAllocAttributes() + ///< in EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL. + UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE Bus; ///< Bus aperture which can be used by the root bridge. + UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE Io; ///< IO aperture which can be used by the root bridge. + UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE Mem; ///< MMIO aperture below 4GB which can be used by the root bridge. + UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE MemAbove4G; ///< MMIO aperture above 4GB which can be used by the root bridge. + UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE PMem; ///< Prefetchable MMIO aperture below 4GB which can be used by the root bridge. + UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE PMemAbove4G; ///< Prefetchable MMIO aperture above 4GB which can be used by the root bridge. + UINT32 HID; ///< PnP hardware ID of the root bridge. This value must match the corresponding + ///< _HID in the ACPI name space. + UINT32 UID; ///< Unique ID that is required by ACPI if two devices have the same _HID. + ///< This value must also match the corresponding _UID/_HID pair in the ACPI name space. +} UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE; + +typedef struct { + UNIVERSAL_PAYLOAD_GENERIC_HEADER Header; + BOOLEAN ResourceAssigned; + UINT8 Count; + UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE RootBridge[0]; +} UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGES; + +#pragma pack() + +#define UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGES_REVISION 1 + +extern GUID gUniversalPayloadPciRootBridgeInfoGuid; + +#endif // UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGES_H_ diff --git a/MdeModulePkg/Include/UniversalPayload/SerialPortInfo.h b/MdeModulePkg/Include/UniversalPayload/SerialPortInfo.h index 3c4459e2c0..9adb0df107 100644 --- a/MdeModulePkg/Include/UniversalPayload/SerialPortInfo.h +++ b/MdeModulePkg/Include/UniversalPayload/SerialPortInfo.h @@ -1,30 +1,30 @@ -/** @file
- This file defines the structure for serial port info.
-
- Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>
- SPDX-License-Identifier: BSD-2-Clause-Patent
-
- @par Revision Reference:
- - Universal Payload Specification 0.75 (https://universalpayload.github.io/documentation/)
-**/
-
-#ifndef UNIVERSAL_PAYLOAD_SERIAL_PORT_INFO_H_
-#define UNIVERSAL_PAYLOAD_SERIAL_PORT_INFO_H_
-
-#include <UniversalPayload/UniversalPayload.h>
-
-#pragma pack(1)
-typedef struct {
- UNIVERSAL_PAYLOAD_GENERIC_HEADER Header;
- BOOLEAN UseMmio;
- UINT8 RegisterStride;
- UINT32 BaudRate;
- EFI_PHYSICAL_ADDRESS RegisterBase;
-} UNIVERSAL_PAYLOAD_SERIAL_PORT_INFO;
-#pragma pack()
-
-#define UNIVERSAL_PAYLOAD_SERIAL_PORT_INFO_REVISION 1
-
-extern GUID gUniversalPayloadSerialPortInfoGuid;
-
-#endif // UNIVERSAL_PAYLOAD_SERIAL_PORT_INFO_H_
+/** @file + This file defines the structure for serial port info. + + Copyright (c) 2021, Intel Corporation. All rights reserved.<BR> + SPDX-License-Identifier: BSD-2-Clause-Patent + + @par Revision Reference: + - Universal Payload Specification 0.75 (https://universalpayload.github.io/documentation/) +**/ + +#ifndef UNIVERSAL_PAYLOAD_SERIAL_PORT_INFO_H_ +#define UNIVERSAL_PAYLOAD_SERIAL_PORT_INFO_H_ + +#include <UniversalPayload/UniversalPayload.h> + +#pragma pack(1) +typedef struct { + UNIVERSAL_PAYLOAD_GENERIC_HEADER Header; + BOOLEAN UseMmio; + UINT8 RegisterStride; + UINT32 BaudRate; + EFI_PHYSICAL_ADDRESS RegisterBase; +} UNIVERSAL_PAYLOAD_SERIAL_PORT_INFO; +#pragma pack() + +#define UNIVERSAL_PAYLOAD_SERIAL_PORT_INFO_REVISION 1 + +extern GUID gUniversalPayloadSerialPortInfoGuid; + +#endif // UNIVERSAL_PAYLOAD_SERIAL_PORT_INFO_H_ diff --git a/MdeModulePkg/Include/UniversalPayload/SmbiosTable.h b/MdeModulePkg/Include/UniversalPayload/SmbiosTable.h index ba5a8696e2..df609f8c61 100644 --- a/MdeModulePkg/Include/UniversalPayload/SmbiosTable.h +++ b/MdeModulePkg/Include/UniversalPayload/SmbiosTable.h @@ -1,30 +1,30 @@ -/** @file
- Define the structure for the Universal Payload SmBios.
-
-Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>
-SPDX-License-Identifier: BSD-2-Clause-Patent
-
- @par Revision Reference:
- - Universal Payload Specification 0.75 (https://universalpayload.github.io/documentation/)
-**/
-
-#ifndef UNIVERSAL_PAYLOAD_SMBIOS_TABLE_H_
-#define UNIVERSAL_PAYLOAD_SMBIOS_TABLE_H_
-
-#include <Uefi.h>
-#include <UniversalPayload/UniversalPayload.h>
-
-#pragma pack (1)
-
-typedef struct {
- UNIVERSAL_PAYLOAD_GENERIC_HEADER Header;
- EFI_PHYSICAL_ADDRESS SmBiosEntryPoint;
-} UNIVERSAL_PAYLOAD_SMBIOS_TABLE;
-
-#pragma pack()
-
-#define UNIVERSAL_PAYLOAD_SMBIOS_TABLE_REVISION 1
-
-extern GUID gUniversalPayloadSmbios3TableGuid;
-extern GUID gUniversalPayloadSmbiosTableGuid;
-#endif // UNIVERSAL_PAYLOAD_SMBIOS_TABLE_H_
+/** @file + Define the structure for the Universal Payload SmBios. + +Copyright (c) 2021, Intel Corporation. All rights reserved.<BR> +SPDX-License-Identifier: BSD-2-Clause-Patent + + @par Revision Reference: + - Universal Payload Specification 0.75 (https://universalpayload.github.io/documentation/) +**/ + +#ifndef UNIVERSAL_PAYLOAD_SMBIOS_TABLE_H_ +#define UNIVERSAL_PAYLOAD_SMBIOS_TABLE_H_ + +#include <Uefi.h> +#include <UniversalPayload/UniversalPayload.h> + +#pragma pack (1) + +typedef struct { + UNIVERSAL_PAYLOAD_GENERIC_HEADER Header; + EFI_PHYSICAL_ADDRESS SmBiosEntryPoint; +} UNIVERSAL_PAYLOAD_SMBIOS_TABLE; + +#pragma pack() + +#define UNIVERSAL_PAYLOAD_SMBIOS_TABLE_REVISION 1 + +extern GUID gUniversalPayloadSmbios3TableGuid; +extern GUID gUniversalPayloadSmbiosTableGuid; +#endif // UNIVERSAL_PAYLOAD_SMBIOS_TABLE_H_ diff --git a/MdeModulePkg/Include/UniversalPayload/UniversalPayload.h b/MdeModulePkg/Include/UniversalPayload/UniversalPayload.h index bb40f240f6..a5c7718172 100644 --- a/MdeModulePkg/Include/UniversalPayload/UniversalPayload.h +++ b/MdeModulePkg/Include/UniversalPayload/UniversalPayload.h @@ -1,59 +1,59 @@ -/** @file
- Universal Payload general definitions.
-
-Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>
-SPDX-License-Identifier: BSD-2-Clause-Patent
-
- @par Revision Reference:
- - Universal Payload Specification 0.75 (https://universalpayload.github.io/documentation/)
-**/
-
-#ifndef UNIVERSAL_PAYLOAD_H_
-#define UNIVERSAL_PAYLOAD_H_
-
-/**
- Main entry point to Universal Payload.
-
- @param HobList Pointer to the beginning of the HOB List from boot loader.
-**/
-typedef VOID (EFIAPI *UNIVERSAL_PAYLOAD_ENTRY)(VOID *HobList);
-
-#define UNIVERSAL_PAYLOAD_IDENTIFIER SIGNATURE_32('P', 'L', 'D', 'H')
-#define UNIVERSAL_PAYLOAD_INFO_SEC_NAME ".upld_info"
-#define UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX ".upld."
-#define UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX_LENGTH (sizeof (UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX) - 1)
-
-#pragma pack(1)
-
-typedef struct {
- UINT32 Identifier;
- UINT32 HeaderLength;
- UINT16 SpecRevision;
- UINT8 Reserved[2];
- UINT32 Revision;
- UINT32 Attribute;
- UINT32 Capability;
- CHAR8 ProducerId[16];
- CHAR8 ImageId[16];
-} UNIVERSAL_PAYLOAD_INFO_HEADER;
-
-typedef struct {
- UINT8 Revision;
- UINT8 Reserved;
- UINT16 Length;
-} UNIVERSAL_PAYLOAD_GENERIC_HEADER;
-
-#pragma pack()
-
-/**
- Returns the size of a structure of known type, up through and including a specified field.
-
- @param TYPE The name of the data structure that contains the field specified by Field.
- @param Field The name of the field in the data structure.
-
- @return size, in bytes.
-
-**/
-#define UNIVERSAL_PAYLOAD_SIZEOF_THROUGH_FIELD(TYPE, Field) (OFFSET_OF(TYPE, Field) + sizeof (((TYPE *) 0)->Field))
-
-#endif // UNIVERSAL_PAYLOAD_H_
+/** @file + Universal Payload general definitions. + +Copyright (c) 2021, Intel Corporation. All rights reserved.<BR> +SPDX-License-Identifier: BSD-2-Clause-Patent + + @par Revision Reference: + - Universal Payload Specification 0.75 (https://universalpayload.github.io/documentation/) +**/ + +#ifndef UNIVERSAL_PAYLOAD_H_ +#define UNIVERSAL_PAYLOAD_H_ + +/** + Main entry point to Universal Payload. + + @param HobList Pointer to the beginning of the HOB List from boot loader. +**/ +typedef VOID (EFIAPI *UNIVERSAL_PAYLOAD_ENTRY)(VOID *HobList); + +#define UNIVERSAL_PAYLOAD_IDENTIFIER SIGNATURE_32('P', 'L', 'D', 'H') +#define UNIVERSAL_PAYLOAD_INFO_SEC_NAME ".upld_info" +#define UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX ".upld." +#define UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX_LENGTH (sizeof (UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX) - 1) + +#pragma pack(1) + +typedef struct { + UINT32 Identifier; + UINT32 HeaderLength; + UINT16 SpecRevision; + UINT8 Reserved[2]; + UINT32 Revision; + UINT32 Attribute; + UINT32 Capability; + CHAR8 ProducerId[16]; + CHAR8 ImageId[16]; +} UNIVERSAL_PAYLOAD_INFO_HEADER; + +typedef struct { + UINT8 Revision; + UINT8 Reserved; + UINT16 Length; +} UNIVERSAL_PAYLOAD_GENERIC_HEADER; + +#pragma pack() + +/** + Returns the size of a structure of known type, up through and including a specified field. + + @param TYPE The name of the data structure that contains the field specified by Field. + @param Field The name of the field in the data structure. + + @return size, in bytes. + +**/ +#define UNIVERSAL_PAYLOAD_SIZEOF_THROUGH_FIELD(TYPE, Field) (OFFSET_OF(TYPE, Field) + sizeof (((TYPE *) 0)->Field)) + +#endif // UNIVERSAL_PAYLOAD_H_ |