2 Guid & data structure used for EFI System Resource Table (ESRT)
4 Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
7 @par Revision Reference:
8 GUIDs defined in UEFI 2.5 spec.
13 #ifndef _SYSTEM_RESOURCE_TABLE_H__
14 #define _SYSTEM_RESOURCE_TABLE_H__
16 #define EFI_SYSTEM_RESOURCE_TABLE_GUID \
18 0xb122a263, 0x3661, 0x4f68, {0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80 } \
22 /// Current Entry Version
24 #define EFI_SYSTEM_RESOURCE_TABLE_FIRMWARE_RESOURCE_VERSION 1
27 /// Firmware Type Definitions
29 #define ESRT_FW_TYPE_UNKNOWN 0x00000000
30 #define ESRT_FW_TYPE_SYSTEMFIRMWARE 0x00000001
31 #define ESRT_FW_TYPE_DEVICEFIRMWARE 0x00000002
32 #define ESRT_FW_TYPE_UEFIDRIVER 0x00000003
35 /// Last Attempt Status Values
37 #define LAST_ATTEMPT_STATUS_SUCCESS 0x00000000
38 #define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL 0x00000001
39 #define LAST_ATTEMPT_STATUS_ERROR_INSUFFICIENT_RESOURCES 0x00000002
40 #define LAST_ATTEMPT_STATUS_ERROR_INCORRECT_VERSION 0x00000003
41 #define LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT 0x00000004
42 #define LAST_ATTEMPT_STATUS_ERROR_AUTH_ERROR 0x00000005
43 #define LAST_ATTEMPT_STATUS_ERROR_PWR_EVT_AC 0x00000006
44 #define LAST_ATTEMPT_STATUS_ERROR_PWR_EVT_BATT 0x00000007
48 /// The firmware class field contains a GUID that identifies a firmware component
49 /// that can be updated via UpdateCapsule(). This GUID must be unique within all
50 /// entries of the ESRT.
54 /// Identifies the type of firmware resource.
58 /// The firmware version field represents the current version of the firmware
59 /// resource, value must always increase as a larger number represents a newer
64 /// The lowest firmware resource version to which a firmware resource can be
65 /// rolled back for the given system/device. Generally this is used to protect
66 /// against known and fixed security issues.
68 UINT32 LowestSupportedFwVersion
;
70 /// The capsule flags field contains the CapsuleGuid flags (bits 0- 15) as defined
71 /// in the EFI_CAPSULE_HEADER that will be set in the capsule header.
75 /// The last attempt version field describes the last firmware version for which
76 /// an update was attempted (uses the same format as Firmware Version).
77 /// Last Attempt Version is updated each time an UpdateCapsule() is attempted for
78 /// an ESRT entry and is preserved across reboots (non-volatile). However, in
79 /// cases where the attempt version is not recorded due to limitations in the
80 /// update process, the field shall set to zero after a failed update. Similarly,
81 /// in the case of a removable device, this value is set to 0 in cases where the
82 /// device has not been updated since being added to the system.
84 UINT32 LastAttemptVersion
;
86 /// The last attempt status field describes the result of the last firmware update
87 /// attempt for the firmware resource entry.
88 /// LastAttemptStatus is updated each time an UpdateCapsule() is attempted for an
89 /// ESRT entry and is preserved across reboots (non-volatile).
90 /// If a firmware update has never been attempted or is unknown, for example after
91 /// fresh insertion of a removable device, LastAttemptStatus must be set to Success.
93 UINT32 LastAttemptStatus
;
94 } EFI_SYSTEM_RESOURCE_ENTRY
;
98 /// The number of firmware resources in the table, must not be zero.
100 UINT32 FwResourceCount
;
102 /// The maximum number of resource array entries that can be within the table
103 /// without reallocating the table, must not be zero.
105 UINT32 FwResourceCountMax
;
107 /// The version of the EFI_SYSTEM_RESOURCE_ENTRY entities used in this table.
108 /// This field should be set to 1.
110 UINT64 FwResourceVersion
;
112 /// Array of EFI_SYSTEM_RESOURCE_ENTRY
114 //EFI_SYSTEM_RESOURCE_ENTRY Entries[];
115 } EFI_SYSTEM_RESOURCE_TABLE
;
117 extern EFI_GUID gEfiSystemResourceTableGuid
;