From 3705cf4281e56a4ac53e84e228d100cbd4abaaef Mon Sep 17 00:00:00 2001 From: Jiewen Yao Date: Wed, 21 Sep 2016 09:21:52 +0800 Subject: SignedCapsulePkg/Include: Add EDKII system FMP capsule header. Add EDKII system FMP capsule header file. This describes the EDKII system FMP capsule format. Cc: Feng Tian Cc: Star Zeng Cc: Michael D Kinney Cc: Liming Gao Cc: Chao Zhang Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Jiewen Yao Reviewed-by: Liming Gao Reviewed-by: Michael Kinney Tested-by: Michael Kinney --- .../Include/Guid/EdkiiSystemFmpCapsule.h | 151 +++++++++++++++++++++ 1 file changed, 151 insertions(+) create mode 100644 SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h (limited to 'SignedCapsulePkg/Include') diff --git a/SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h b/SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h new file mode 100644 index 0000000000..f5cc7ea3b8 --- /dev/null +++ b/SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h @@ -0,0 +1,151 @@ +/** @file + Guid & data structure used for Delivering Capsules Containing Updates to + EDKII System Firmware Management Protocol + + Copyright (c) 2016, Intel Corporation. All rights reserved.
+ This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + +**/ + + +#ifndef __EDKII_SYSTEM_FMP_CAPSULE_GUID_H__ +#define __EDKII_SYSTEM_FMP_CAPSULE_GUID_H__ + +/** + + 1. Capsule Layout is below: + +------------------------------------------+ + | Capsule Header (OPTIONAL, WFU) | <== ESRT.FwClass (Optional) + +------------------------------------------+ + | FMP Capsule Header | <== EFI_FIRMWARE_MANAGEMENT_CAPSULE_ID_GUID + +------------------------------------------+ + | FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER | <== PcdSystemFmpCapsuleImageTypeIdGuid + +------------------------------------------+ + | EFI_FIRMWARE_IMAGE_AUTHENTICATION | + +------------------------------------------+ + | FMP Payload | + +------------------------------------------+ + + 2. System FMP Payload is below: + +------------------------------------------+ + | EFI_FIRMWARE_VOLUME | + | +------------------------------------+ | + | | FFS (Configure File) | | <== gEdkiiSystemFmpCapsuleConfigFileGuid + | +------------------------------------+ | + | | FFS (Driver FV) | | <== gEdkiiSystemFmpCapsuleDriverFvFileGuid + | +------------------------------------+ | + | | FFS (System Firmware Image) | | <== PcdEdkiiSystemFirmwareFileGuid + | | +------------------------------+ | | + | | | FV Recovery | | | + | | |------------------------------| | | + | | | FV Main | | | + | | +------------------------------+ | | + | +------------------------------------+ | + +------------------------------------------+ + + NOTE: There might be multiple FFS (System Firmware Image) exist in the System FMP Capsule. + Only the one, whose FFS GUID matches PcdEdkiiSystemFirmwareFileGuid, takes effect. + The other FFS is ignored. + + 3. The format of the recovery configuration is below: + + [Head] + NumOfRecovery = # Decimal + Recovery0 = # String + Recovery1 = # String + Recovery = # String + + [Name?] + Length = # Fv Length (HEX) + ImageOffset = # Fv offset of this SystemFirmware image (HEX) + FileGuid = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX # PcdEdkiiSystemFirmwareFileGuid + + NOTE: The [Name?] entry may have differnt FileGuid. + Only the one, whose FileGuid matches PcdEdkiiSystemFirmwareFileGuid, takes effect. + The other entry is ignored. + + 4. The format of the capsule update configuration is below: + + [Head] + NumOfUpdate = # Decimal + Update0 = # String + Update1 = # String + Update = # String + + [Name?] + FirmwareType = 0 # 0 - SystemFirmware, 1 - NvRam + AddressType = 0 # 0 - relative address, 1 - absolute address. + BaseAddress = # Base address offset on flash (HEX) + Length = # Image Length (HEX) + ImageOffset = # Image offset of this SystemFirmware image (HEX) + FileGuid = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX # PcdEdkiiSystemFirmwareFileGuid + + NOTE: The [Name?] entry may have differnt FileGuid. + Only the one, whose FileGuid matches PcdEdkiiSystemFirmwareFileGuid, takes effect. + The other entry is ignored. + +**/ + +#define EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR_SIGNATURE SIGNATURE_32('S', 'F', 'I', 'D') + +#pragma pack(1) +typedef struct { + UINT32 Signature; + UINT32 HeaderLength; // Length of EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR, excluding NameString + UINT32 Length; // Length of the data structure, including NameString + // Below structure is similar as UEFI EFI_FIRMWARE_MANAGEMENT_PROTOCOL.GetPackageInfo() + UINT32 PackageVersion; + UINT32 PackageVersionNameStringOffset; // Offset from head, CHAR16 string including NULL terminate char + // Below structure is similar as UEFI EFI_FIRMWARE_IMAGE_DESCRIPTOR + UINT8 ImageIndex; + UINT8 Reserved[3]; + EFI_GUID ImageTypeId; + UINT64 ImageId; + UINT32 ImageIdNameStringOffset; // Offset from head, CHAR16 string including NULL terminate char + UINT32 Version; + UINT32 VersionNameStringOffset; // Offset from head, CHAR16 string including NULL terminate char + UINT8 Reserved2[4]; + UINT64 Size; + UINT64 AttributesSupported; + UINT64 AttributesSetting; + UINT64 Compatibilities; + UINT32 LowestSupportedImageVersion; + UINT32 LastAttemptVersion; + UINT32 LastAttemptStatus; + UINT8 Reserved3[4]; + UINT64 HardwareInstance; + // real string data +//CHAR16 ImageIdNameStr[]; // CHAR16 string including NULL terminate char +//CHAR16 VersionNameStr[]; // CHAR16 string including NULL terminate char +//CHAR16 PackageVersionNameStr[]; // CHAR16 string including NULL terminate char +} EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR; +#pragma pack() + +/** + System Firmware Image Descriptor is below: + +----------------------+ + | System Firmware (FV) | + |+--------------------+| + || FFS (Freeform) || <== gEdkiiSystemFirmwareImageDescriptorFileGuid + ||+------------------+|| + ||| SECTION (RAW) ||| + ||| System Firmware ||| + ||| Image Descriptor ||| + ||+------------------+|| + |+--------------------+| + | | + | | + +----------------------+ +**/ + +extern EFI_GUID gEdkiiSystemFirmwareImageDescriptorFileGuid; +extern EFI_GUID gEdkiiSystemFmpCapsuleConfigFileGuid; +extern EFI_GUID gEdkiiSystemFmpCapsuleDriverFvFileGuid; + +#endif -- cgit v1.2.3