Add EFI System Resource Table (ESRT) interface (API only).
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Hao Wu <hao.a...@intel.com>
Reviewed-by: Liming Gao <liming....@intel.com>
Reviewed-by: Chao Zhang <chao.b.zh...@intel.com>
---
MdePkg/Include/Guid/FmpCapsule.h | 19 ++--
MdePkg/Include/Guid/SystemResourceTable.h | 125 +++++++++++++++++++++++++++
MdePkg/Include/Protocol/FirmwareManagement.h | 34 +++++++-
MdePkg/MdePkg.dec | 6 ++
4 files changed, 175 insertions(+), 9 deletions(-)
create mode 100644 MdePkg/Include/Guid/SystemResourceTable.h
diff --git a/MdePkg/Include/Guid/FmpCapsule.h b/MdePkg/Include/Guid/FmpCapsule.h
index 4c358b8..8c9ae6b 100644
--- a/MdePkg/Include/Guid/FmpCapsule.h
+++ b/MdePkg/Include/Guid/FmpCapsule.h
@@ -2,7 +2,7 @@
Guid & data structure used for Delivering Capsules Containing Updates to
Firmware
Management Protocol
- Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2013 - 2015, 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
@@ -56,7 +56,7 @@ typedef struct {
UINT32 Version;
///
- /// Used to identifiy device firmware targeted by this update. This guid is
matched by
+ /// Used to identify device firmware targeted by this update. This guid is
matched by
/// system firmware against ImageTypeId field within a
EFI_FIRMWARE_IMAGE_DESCRIPTOR
///
EFI_GUID UpdateImageTypeId;
@@ -73,16 +73,25 @@ typedef struct {
UINT32 UpdateImageSize;
///
- ///Size of the VendorCode bytes which optionally immediately follow binary
update image in the capsule
+ /// Size of the VendorCode bytes which optionally immediately follow binary
update image in the capsule
///
UINT32 UpdateVendorCodeSize;
+
+ ///
+ /// The HardwareInstance to target with this update. If value is zero it
means match all
+ /// HardwareInstances. This field allows update software to target only a
single device in
+ /// cases where there are more than one device with the same ImageTypeId
GUID.
+ /// This header is outside the signed data of the Authentication Info
structure and
+ /// therefore can be modified without changing the Auth data.
+ ///
+ UINT64 UpdateHardwareInstance;
} EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER;
#pragma pack()
-#define EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER_INIT_VERSION 0x00000001
-#define EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER_INIT_VERSION 0x00000001
+#define EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER_INIT_VERSION 0x00000001
+#define EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER_INIT_VERSION 0x00000002
extern EFI_GUID gEfiFmpCapsuleGuid;
diff --git a/MdePkg/Include/Guid/SystemResourceTable.h
b/MdePkg/Include/Guid/SystemResourceTable.h
new file mode 100644
index 0000000..a77cb92
--- /dev/null
+++ b/MdePkg/Include/Guid/SystemResourceTable.h
@@ -0,0 +1,125 @@
+/** @file
+ Guid & data structure used for EFI System Resource Table (ESRT)
+
+ Copyright (c) 2015, 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.
+
+ @par Revision Reference:
+ GUIDs defined in UEFI 2.5 spec.
+
+**/
+
+
+#ifndef _SYSTEM_RESOURCE_TABLE_H__
+#define _SYSTEM_RESOURCE_TABLE_H__
+
+#define EFI_SYSTEM_RESOURCE_TABLE_GUID \
+ { \
+ 0xb122a263, 0x3661, 0x4f68, {0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21,
0x80 } \
+ }
+
+///
+/// Current Entry Version
+///
+#define EFI_SYSTEM_RESOURCE_TABLE_FIRMWARE_RESOURCE_VERSION 1
+
+///
+/// Firmware Type Definitions
+///
+#define ESRT_FW_TYPE_UNKNOWN 0x00000000
+#define ESRT_FW_TYPE_SYSTEMFIRMWARE 0x00000001
+#define ESRT_FW_TYPE_DEVICEFIRMWARE 0x00000002
+#define ESRT_FW_TYPE_UEFIDRIVER 0x00000003
+
+///
+/// Last Attempt Status Values
+///
+#define LAST_ATTEMPT_STATUS_SUCCESS 0x00000000
+#define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL 0x00000001
+#define LAST_ATTEMPT_STATUS_ERROR_INSUFFICIENT_RESOURCES 0x00000002
+#define LAST_ATTEMPT_STATUS_ERROR_INCORRECT_VERSION 0x00000003
+#define LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT 0x00000004
+#define LAST_ATTEMPT_STATUS_ERROR_AUTH_ERROR 0x00000005
+#define LAST_ATTEMPT_STATUS_ERROR_PWR_EVT_AC 0x00000006
+#define LAST_ATTEMPT_STATUS_ERROR_PWR_EVT_BATT 0x00000007
+
+typedef struct {
+ ///
+ /// The firmware class field contains a GUID that identifies a firmware
component
+ /// that can be updated via UpdateCapsule(). This GUID must be unique within
all
+ /// entries of the ESRT.
+ ///
+ EFI_GUID FwClass;
+ ///
+ /// Identifies the type of firmware resource.
+ ///
+ UINT32 FwType;
+ ///
+ /// The firmware version field represents the current version of the firmware
+ /// resource, value must always increase as a larger number represents a
newer
+ /// version.
+ ///
+ UINT32 FwVersion;
+ ///
+ /// The lowest firmware resource version to which a firmware resource can be
+ /// rolled back for the given system/device. Generally this is used to
protect
+ /// against known and fixed security issues.
+ ///
+ UINT32 LowestSupportedFwVersion;
+ ///
+ /// The capsule flags field contains the CapsuleGuid flags (bits 0- 15) as
defined
+ /// in the EFI_CAPSULE_HEADER that will be set in the capsule header.
+ ///
+ UINT32 CapsuleFlags;
+ ///
+ /// The last attempt version field describes the last firmware version for
which
+ /// an update was attempted (uses the same format as Firmware Version).
+ /// Last Attempt Version is updated each time an UpdateCapsule() is
attempted for
+ /// an ESRT entry and is preserved across reboots (non-volatile). However, in
+ /// cases where the attempt version is not recorded due to limitations in the
+ /// update process, the field shall set to zero after a failed update.
Similarly,
+ /// in the case of a removable device, this value is set to 0 in cases where
the
+ /// device has not been updated since being added to the system.
+ ///
+ UINT32 LastAttemptVersion;
+ ///
+ /// The last attempt status field describes the result of the last firmware
update
+ /// attempt for the firmware resource entry.
+ /// LastAttemptStatus is updated each time an UpdateCapsule() is attempted
for an
+ /// ESRT entry and is preserved across reboots (non-volatile).
+ /// If a firmware update has never been attempted or is unknown, for example
after
+ /// fresh insertion of a removable device, LastAttemptStatus must be set to
Success.
+ ///
+ UINT32 LastAttemptStatus;
+} EFI_SYSTEM_RESOURCE_ENTRY;
+
+typedef struct {
+ ///
+ /// The number of firmware resources in the table, must not be zero.
+ ///
+ UINT32 FwResourceCount;
+ ///
+ /// The maximum number of resource array entries that can be within the table
+ /// without reallocating the table, must not be zero.
+ ///
+ UINT32 FwResourceCountMax;
+ ///
+ /// The version of the EFI_SYSTEM_RESOURCE_ENTRY entities used in this table.
+ /// This field should be set to 1.
+ ///
+ UINT64 FwResourceVersion;
+ ///
+ /// Array of EFI_SYSTEM_RESOURCE_ENTRY
+ ///
+ //EFI_SYSTEM_RESOURCE_ENTRY Entries[];
+} EFI_SYSTEM_RESOURCE_TABLE;
+
+extern EFI_GUID gEfiSystemResourceTableGuid;
+
+#endif
diff --git a/MdePkg/Include/Protocol/FirmwareManagement.h
b/MdePkg/Include/Protocol/FirmwareManagement.h
index 7ba6a7a..c4191a9 100644
--- a/MdePkg/Include/Protocol/FirmwareManagement.h
+++ b/MdePkg/Include/Protocol/FirmwareManagement.h
@@ -8,7 +8,7 @@
CheckImage(), GetPackageInfo(), and SetPackageInfo() shall return
EFI_UNSUPPORTED if not supported by the driver.
- Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2013 - 2014, Hewlett-Packard Development Company, L.P.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD
License
@@ -44,8 +44,8 @@ typedef struct {
///
UINT8 ImageIndex;
///
- /// A unique number identifying the firmware image type.
- ///
+ /// A unique GUID identifying the firmware image type.
+ ///
EFI_GUID ImageTypeId;
///
/// A unique number identifying the firmware image.
@@ -91,6 +91,32 @@ typedef struct {
/// present in version 2 or higher.
///
UINT32 LowestSupportedImageVersion;
+ ///
+ /// Describes the version that was last attempted to update. If no update
attempted the
+ /// value will be 0. If the update attempted was improperly formatted and no
version
+ /// number was available then the value will be zero. Only present in
version 3 or higher.
+ UINT32 LastAttemptVersion;
+ ///
+ /// Describes the status that was last attempted to update. If no update has
been attempted
+ /// the value will be LAST_ATTEMPT_STATUS_SUCCESS. Only present in version 3
or higher.
+ ///
+ UINT32 LastAttemptStatus;
+ ///
+ /// An optional number to identify the unique hardware instance within the
system for
+ /// devices that may have multiple instances (Example: a plug in pci network
card). This
+ /// number must be unique within the namespace of the ImageTypeId GUID and
+ /// ImageIndex. For FMP instances that have multiple descriptors for a single
+ /// hardware instance, all descriptors must have the same HardwareInstance
value.
+ /// This number must be consistent between boots and should be based on some
sort of
+ /// hardware identified unique id (serial number, etc) whenever possible. If
a hardware
+ /// based number is not available the FMP provider may use some other
characteristic
+ /// such as device path, bus/dev/function, slot num, etc for generating the
+ /// HardwareInstance. For implementations that will never have more than one
+ /// instance a zero can be used. A zero means the FMP provider is not able
to determine a
+ /// unique hardware instance number or a hardware instance number is not
needed. Only
+ /// present in version 3 or higher.
+ ///
+ UINT64 HardwareInstance;
} EFI_FIRMWARE_IMAGE_DESCRIPTOR;
@@ -137,7 +163,7 @@ typedef struct {
///
/// Descriptor Version exposed by GetImageInfo() function
///
-#define EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION 2
+#define EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION 3
///
diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
index c36d4f5..04c285b 100644
--- a/MdePkg/MdePkg.dec
+++ b/MdePkg/MdePkg.dec
@@ -555,6 +555,12 @@
gEfiAdapterInfoSanMacAddressGuid = { 0x114da5ef, 0x2cf1, 0x4e12, {0x9b,
0xbb, 0xc4, 0x70, 0xb5, 0x52, 0x5, 0xd9 }}
#
+ # GUIDs defined in UEFI2.5
+ #
+ ## Include/Guid/SystemResourceTable.h
+ gEfiSystemResourceTableGuid = { 0xb122a263, 0x3661, 0x4f68, {0x99, 0x29,
0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80 }}
+
+ #
# GUID defined in PI1.0
#
## Include/Guid/AprioriFileName.h
--
1.9.5.msysgit.0
------------------------------------------------------------------------------
One dashboard for servers and applications across Physical-Virtual-Cloud
Widest out-of-the-box monitoring support with 50+ applications
Performance metrics, stats and reports that give you Actionable Insights
Deep dive visibility with transaction tracing using APM Insight.
http://ad.doubleclick.net/ddm/clk/290420510;117567292;y
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/edk2-devel
