[mirror_edk2.git] / SignedCapsulePkg / Include / Guid / EdkiiSystemFmpCapsule.h

/** @file\r
  Guid & data structure used for Delivering Capsules Containing Updates to\r
  EDKII System Firmware Management Protocol\r
\r
  Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r
  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
**/\r
\r
\r
#ifndef __EDKII_SYSTEM_FMP_CAPSULE_GUID_H__\r
#define __EDKII_SYSTEM_FMP_CAPSULE_GUID_H__\r
\r
/**\r
\r
  1. Capsule Layout is below:\r
  +------------------------------------------+\r
  |    Capsule Header (OPTIONAL, WFU)        | <== ESRT.FwClass (Optional)\r
  +------------------------------------------+\r
  |          FMP Capsule Header              | <== EFI_FIRMWARE_MANAGEMENT_CAPSULE_ID_GUID\r
  +------------------------------------------+\r
  | FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER | <== PcdSystemFmpCapsuleImageTypeIdGuid\r
  +------------------------------------------+\r
  |     EFI_FIRMWARE_IMAGE_AUTHENTICATION    |\r
  +------------------------------------------+\r
  |             FMP Payload                  |\r
  +------------------------------------------+\r
\r
  2. System FMP Payload is below:\r
  +------------------------------------------+\r
  |            EFI_FIRMWARE_VOLUME           |\r
  |  +------------------------------------+  |\r
  |  |       FFS (Configure File)         |  | <== gEdkiiSystemFmpCapsuleConfigFileGuid\r
  |  +------------------------------------+  |\r
  |  |         FFS (Driver FV)            |  | <== gEdkiiSystemFmpCapsuleDriverFvFileGuid\r
  |  +------------------------------------+  |\r
  |  |    FFS (System Firmware Image)     |  | <== PcdEdkiiSystemFirmwareFileGuid\r
  |  |  +------------------------------+  |  |\r
  |  |  |          FV Recovery         |  |  |\r
  |  |  |------------------------------|  |  |\r
  |  |  |           FV Main            |  |  |\r
  |  |  +------------------------------+  |  |\r
  |  +------------------------------------+  |\r
  +------------------------------------------+\r
\r
  NOTE: There might be multiple FFS (System Firmware Image) exist in the System FMP Capsule.\r
  Only the one, whose FFS GUID matches PcdEdkiiSystemFirmwareFileGuid, takes effect.\r
  The other FFS is ignored.\r
\r
  3. The format of the recovery configuration is below:\r
\r
  [Head]\r
  NumOfRecovery = <Num>     # Decimal\r
  Recovery0 = <Name1>       # String\r
  Recovery1 = <Name2>       # String\r
  Recovery<Num-1> = <NameX> # String\r
\r
  [Name?]\r
  Length      = <Length>         # Fv Length (HEX)\r
  ImageOffset = <ImageOffset>    # Fv offset of this SystemFirmware image (HEX)\r
  FileGuid    = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX  # PcdEdkiiSystemFirmwareFileGuid\r
\r
  NOTE: The [Name?] entry may have differnt FileGuid.\r
  Only the one, whose FileGuid matches PcdEdkiiSystemFirmwareFileGuid, takes effect.\r
  The other entry is ignored.\r
\r
  4. The format of the capsule update configuration is below:\r
\r
  [Head]\r
  NumOfUpdate = <Num>     # Decimal\r
  Update0 = <Name1>       # String\r
  Update1 = <Name2>       # String\r
  Update<Num-1> = <NameX> # String\r
\r
  [Name?]\r
  FirmwareType = 0               # 0 - SystemFirmware, 1 - NvRam\r
  AddressType = 0                # 0 - relative address, 1 - absolute address.\r
  BaseAddress = <BaseAddress>    # Base address offset on flash (HEX)\r
  Length      = <Length>         # Image Length (HEX)\r
  ImageOffset = <ImageOffset>    # Image offset of this SystemFirmware image (HEX)\r
  FileGuid    = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX  # PcdEdkiiSystemFirmwareFileGuid\r
\r
  NOTE: The [Name?] entry may have differnt FileGuid.\r
  Only the one, whose FileGuid matches PcdEdkiiSystemFirmwareFileGuid, takes effect.\r
  The other entry is ignored.\r
\r
**/\r
\r
#define EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR_SIGNATURE  SIGNATURE_32('S', 'F', 'I', 'D')\r
\r
#pragma pack(1)\r
typedef struct {\r
  UINT32                                Signature;\r
  UINT32                                HeaderLength; // Length of EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR, excluding NameString\r
  UINT32                                Length;       // Length of the data structure, including NameString\r
  // Below structure is similar as UEFI EFI_FIRMWARE_MANAGEMENT_PROTOCOL.GetPackageInfo()\r
  UINT32                                PackageVersion;\r
  UINT32                                PackageVersionNameStringOffset; // Offset from head, CHAR16 string including NULL terminate char\r
  // Below structure is similar as UEFI EFI_FIRMWARE_IMAGE_DESCRIPTOR\r
  UINT8                                 ImageIndex;\r
  UINT8                                 Reserved[3];\r
  EFI_GUID                              ImageTypeId;\r
  UINT64                                ImageId;\r
  UINT32                                ImageIdNameStringOffset; // Offset from head, CHAR16 string including NULL terminate char\r
  UINT32                                Version;\r
  UINT32                                VersionNameStringOffset; // Offset from head, CHAR16 string including NULL terminate char\r
  UINT8                                 Reserved2[4];\r
  UINT64                                Size;\r
  UINT64                                AttributesSupported;\r
  UINT64                                AttributesSetting;\r
  UINT64                                Compatibilities;\r
  UINT32                                LowestSupportedImageVersion;\r
  UINT32                                LastAttemptVersion;\r
  UINT32                                LastAttemptStatus;\r
  UINT8                                 Reserved3[4];\r
  UINT64                                HardwareInstance;\r
  // real string data\r
//CHAR16                                ImageIdNameStr[];        // CHAR16 string including NULL terminate char\r
//CHAR16                                VersionNameStr[];        // CHAR16 string including NULL terminate char\r
//CHAR16                                PackageVersionNameStr[]; // CHAR16 string including NULL terminate char\r
} EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR;\r
#pragma pack()\r
\r
/**\r
  System Firmware Image Descriptor is below:\r
            +----------------------+\r
            | System Firmware (FV) |\r
            |+--------------------+|\r
            ||   FFS (Freeform)   || <== gEdkiiSystemFirmwareImageDescriptorFileGuid\r
            ||+------------------+||\r
            |||   SECTION (RAW)  |||\r
            |||  System Firmware |||\r
            ||| Image Descriptor |||\r
            ||+------------------+||\r
            |+--------------------+|\r
            |                      |\r
            |                      |\r
            +----------------------+\r
**/\r
\r
extern EFI_GUID gEdkiiSystemFirmwareImageDescriptorFileGuid;\r
extern EFI_GUID gEdkiiSystemFmpCapsuleConfigFileGuid;\r
extern EFI_GUID gEdkiiSystemFmpCapsuleDriverFvFileGuid;\r
\r
#endif\r
Commit	Line	Data
3705cf42 JY	1	/** @file\r
	2	Guid & data structure used for Delivering Capsules Containing Updates to\r
	3	EDKII System Firmware Management Protocol\r
	4	\r
	5	Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r
	6	This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	\r
	17	#ifndef __EDKII_SYSTEM_FMP_CAPSULE_GUID_H__\r
	18	#define __EDKII_SYSTEM_FMP_CAPSULE_GUID_H__\r
	19	\r
	20	/**\r
	21	\r
	22	1. Capsule Layout is below:\r
	23	+------------------------------------------+\r
	24	\| Capsule Header (OPTIONAL, WFU) \| <== ESRT.FwClass (Optional)\r
	25	+------------------------------------------+\r
	26	\| FMP Capsule Header \| <== EFI_FIRMWARE_MANAGEMENT_CAPSULE_ID_GUID\r
	27	+------------------------------------------+\r
	28	\| FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER \| <== PcdSystemFmpCapsuleImageTypeIdGuid\r
	29	+------------------------------------------+\r
	30	\| EFI_FIRMWARE_IMAGE_AUTHENTICATION \|\r
	31	+------------------------------------------+\r
	32	\| FMP Payload \|\r
	33	+------------------------------------------+\r
	34	\r
	35	2. System FMP Payload is below:\r
	36	+------------------------------------------+\r
	37	\| EFI_FIRMWARE_VOLUME \|\r
	38	\| +------------------------------------+ \|\r
	39	\| \| FFS (Configure File) \| \| <== gEdkiiSystemFmpCapsuleConfigFileGuid\r
	40	\| +------------------------------------+ \|\r
	41	\| \| FFS (Driver FV) \| \| <== gEdkiiSystemFmpCapsuleDriverFvFileGuid\r
	42	\| +------------------------------------+ \|\r
	43	\| \| FFS (System Firmware Image) \| \| <== PcdEdkiiSystemFirmwareFileGuid\r
	44	\| \| +------------------------------+ \| \|\r
	45	\| \| \| FV Recovery \| \| \|\r
	46	\| \| \|------------------------------\| \| \|\r
	47	\| \| \| FV Main \| \| \|\r
	48	\| \| +------------------------------+ \| \|\r
	49	\| +------------------------------------+ \|\r
	50	+------------------------------------------+\r
	51	\r
	52	NOTE: There might be multiple FFS (System Firmware Image) exist in the System FMP Capsule.\r
	53	Only the one, whose FFS GUID matches PcdEdkiiSystemFirmwareFileGuid, takes effect.\r
	54	The other FFS is ignored.\r
	55	\r
	56	3. The format of the recovery configuration is below:\r
	57	\r
	58	[Head]\r
	59	NumOfRecovery = <Num> # Decimal\r
	60	Recovery0 = <Name1> # String\r
	61	Recovery1 = <Name2> # String\r
	62	Recovery<Num-1> = <NameX> # String\r
	63	\r
	64	[Name?]\r
65	Length = <Length> # Fv Length (HEX)\r
66	ImageOffset = <ImageOffset> # Fv offset of this SystemFirmware image (HEX)\r
67	FileGuid = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX # PcdEdkiiSystemFirmwareFileGuid\r
68	\r
69	NOTE: The [Name?] entry may have differnt FileGuid.\r
70	Only the one, whose FileGuid matches PcdEdkiiSystemFirmwareFileGuid, takes effect.\r
71	The other entry is ignored.\r
72	\r
73	4. The format of the capsule update configuration is below:\r
74	\r
75	[Head]\r
76	NumOfUpdate = <Num> # Decimal\r
77	Update0 = <Name1> # String\r
78	Update1 = <Name2> # String\r
79	Update<Num-1> = <NameX> # String\r
80	\r
81	[Name?]\r
82	FirmwareType = 0 # 0 - SystemFirmware, 1 - NvRam\r
83	AddressType = 0 # 0 - relative address, 1 - absolute address.\r
84	BaseAddress = <BaseAddress> # Base address offset on flash (HEX)\r
85	Length = <Length> # Image Length (HEX)\r
86	ImageOffset = <ImageOffset> # Image offset of this SystemFirmware image (HEX)\r
87	FileGuid = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX # PcdEdkiiSystemFirmwareFileGuid\r
88	\r
89	NOTE: The [Name?] entry may have differnt FileGuid.\r
90	Only the one, whose FileGuid matches PcdEdkiiSystemFirmwareFileGuid, takes effect.\r
91	The other entry is ignored.\r
92	\r
93	**/\r
94	\r
95	#define EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR_SIGNATURE SIGNATURE_32('S', 'F', 'I', 'D')\r
96	\r
97	#pragma pack(1)\r
98	typedef struct {\r
99	UINT32 Signature;\r
100	UINT32 HeaderLength; // Length of EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR, excluding NameString\r
101	UINT32 Length; // Length of the data structure, including NameString\r
102	// Below structure is similar as UEFI EFI_FIRMWARE_MANAGEMENT_PROTOCOL.GetPackageInfo()\r
103	UINT32 PackageVersion;\r
104	UINT32 PackageVersionNameStringOffset; // Offset from head, CHAR16 string including NULL terminate char\r
105	// Below structure is similar as UEFI EFI_FIRMWARE_IMAGE_DESCRIPTOR\r
106	UINT8 ImageIndex;\r
107	UINT8 Reserved[3];\r
108	EFI_GUID ImageTypeId;\r
109	UINT64 ImageId;\r
110	UINT32 ImageIdNameStringOffset; // Offset from head, CHAR16 string including NULL terminate char\r
111	UINT32 Version;\r
112	UINT32 VersionNameStringOffset; // Offset from head, CHAR16 string including NULL terminate char\r
113	UINT8 Reserved2[4];\r
114	UINT64 Size;\r
115	UINT64 AttributesSupported;\r
116	UINT64 AttributesSetting;\r
117	UINT64 Compatibilities;\r
118	UINT32 LowestSupportedImageVersion;\r
119	UINT32 LastAttemptVersion;\r
120	UINT32 LastAttemptStatus;\r
121	UINT8 Reserved3[4];\r
122	UINT64 HardwareInstance;\r
123	// real string data\r
124	//CHAR16 ImageIdNameStr[]; // CHAR16 string including NULL terminate char\r
125	//CHAR16 VersionNameStr[]; // CHAR16 string including NULL terminate char\r
126	//CHAR16 PackageVersionNameStr[]; // CHAR16 string including NULL terminate char\r
127	} EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR;\r
128	#pragma pack()\r
129	\r
130	/**\r
131	System Firmware Image Descriptor is below:\r
132	+----------------------+\r
133	\| System Firmware (FV) \|\r
134	\|+--------------------+\|\r
135	\|\| FFS (Freeform) \|\| <== gEdkiiSystemFirmwareImageDescriptorFileGuid\r
136	\|\|+------------------+\|\|\r
137	\|\|\| SECTION (RAW) \|\|\|\r
138	\|\|\| System Firmware \|\|\|\r
139	\|\|\| Image Descriptor \|\|\|\r
140	\|\|+------------------+\|\|\r
141	\|+--------------------+\|\r
142	\| \|\r
143	\| \|\r
144	+----------------------+\r
145	**/\r
146	\r
147	extern EFI_GUID gEdkiiSystemFirmwareImageDescriptorFileGuid;\r
148	extern EFI_GUID gEdkiiSystemFmpCapsuleConfigFileGuid;\r
149	extern EFI_GUID gEdkiiSystemFmpCapsuleDriverFvFileGuid;\r
150	\r
151	#endif\r