public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: Jiewen Yao <jiewen.yao@intel.com>
To: edk2-devel@lists.01.org
Cc: Feng Tian <feng.tian@intel.com>, Star Zeng <star.zeng@intel.com>,
	Michael D Kinney <michael.d.kinney@intel.com>,
	Liming Gao <liming.gao@intel.com>,
	Chao Zhang <chao.b.zhang@intel.com>
Subject: [PATCH V5 02/12] SignedCapsulePkg/Include: Add EDKII system FMP capsule header.
Date: Thu, 27 Oct 2016 21:42:15 +0800	[thread overview]
Message-ID: <1477575745-3052-3-git-send-email-jiewen.yao@intel.com> (raw)
In-Reply-To: <1477575745-3052-1-git-send-email-jiewen.yao@intel.com>

Add EDKII system FMP capsule header file.
This describes the EDKII system FMP capsule format.

Cc: Feng Tian <feng.tian@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Chao Zhang <chao.b.zhang@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiewen Yao <jiewen.yao@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
---
 SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h | 110 ++++++++++++++++++++
 1 file changed, 110 insertions(+)

diff --git a/SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h b/SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h
new file mode 100644
index 0000000..4d99aee
--- /dev/null
+++ b/SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h
@@ -0,0 +1,110 @@
+/** @file
+  Guid & data structure used for Delivering Capsules Containing Updates to
+  EDKII System Firmware Management Protocol
+
+  Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
+  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__
+
+/**
+
+  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                  |
+  +------------------------------------------+
+
+  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            |  |  |
+  |  |  +------------------------------+  |  |
+  |  +------------------------------------+  |
+  +------------------------------------------+
+
+**/
+
+#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
-- 
2.7.4.windows.1



  parent reply	other threads:[~2016-10-27 13:42 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-10-27 13:42 [PATCH V5 00/12] Add EDKII signed capsule support Jiewen Yao
2016-10-27 13:42 ` [PATCH V5 01/12] SignedCapsulePkg: Add license file Jiewen Yao
2016-10-27 13:42 ` Jiewen Yao [this message]
2016-10-27 13:42 ` [PATCH V5 03/12] SignedCapsulePkg/Include: Add EdkiiSystemCapsuleLib definition Jiewen Yao
2016-10-27 13:42 ` [PATCH V5 04/12] SignedCapsulePkg/Include: Add IniParsingLib header Jiewen Yao
2016-10-27 13:42 ` [PATCH V5 05/12] SignedCapsulePkg/Include: Add PlatformFlashAccessLib header Jiewen Yao
2016-10-27 13:42 ` [PATCH V5 06/12] SignedCapsulePkg/CapsulePkg.dec: Add capsule related definition Jiewen Yao
2016-11-01 21:56   ` Kinney, Michael D
2016-11-02  0:38     ` Gao, Liming
2016-11-02  0:49       ` Yao, Jiewen
2016-11-02  1:03       ` Kinney, Michael D
2016-11-02  0:45     ` Yao, Jiewen
2016-11-02  1:10       ` Kinney, Michael D
2016-11-02  2:04         ` Yao, Jiewen
2016-11-02  3:40           ` Kinney, Michael D
2016-11-02  6:17             ` Kinney, Michael D
2016-11-02  7:01               ` Yao, Jiewen
2016-11-02  8:00               ` Yao, Jiewen
2016-10-27 13:42 ` [PATCH V5 07/12] SignedCapsulePkg/IniParsingLib: Add InitParsingLib instance Jiewen Yao
2016-10-27 13:42 ` [PATCH V5 08/12] SignedCapsulePkg/EdkiiSystemCapsuleLib: Add EdkiiSystemCapsuleLib Jiewen Yao
2016-10-27 13:42 ` [PATCH V5 09/12] SignedCapsulePkg/PlatformFlashAccessLib: Add NULL instance Jiewen Yao
2016-10-27 13:42 ` [PATCH V5 10/12] SignedCapsulePkg/SystemFirmwareUpdate: Add SystemFirmwareUpdate Jiewen Yao
2016-10-27 13:42 ` [PATCH V5 11/12] SignedCapsulePkg/RecoveryModuleLoadPei: Add RecoveryModuleLoadPei Jiewen Yao
2016-10-27 13:42 ` [PATCH V5 12/12] SignedCapsulePkg/CapsulePkg.dsc: Add capsule related component Jiewen Yao

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1477575745-3052-3-git-send-email-jiewen.yao@intel.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox