2 Guid & data structure used for Capsule process result variables
4 Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
7 @par Revision Reference:
8 GUIDs defined in UEFI 2.4 spec.
13 #ifndef _CAPSULE_REPORT_GUID_H__
14 #define _CAPSULE_REPORT_GUID_H__
17 // This is the GUID for capsule result variable.
19 #define EFI_CAPSULE_REPORT_GUID \
21 0x39b68c46, 0xf7fb, 0x441b, {0xb6, 0xec, 0x16, 0xb0, 0xf6, 0x98, 0x21, 0xf3 } \
28 /// Size in bytes of the variable including any data beyond header as specified by CapsuleGuid
30 UINT32 VariableTotalSize
;
38 /// Guid from EFI_CAPSULE_HEADER
43 /// Timestamp using system time when processing completed
45 EFI_TIME CapsuleProcessed
;
48 /// Result of the capsule processing. Exact interpretation of any error code may depend
49 /// upon type of capsule processed
51 EFI_STATUS CapsuleStatus
;
52 } EFI_CAPSULE_RESULT_VARIABLE_HEADER
;
58 /// Version of this structure, currently 0x00000001
63 /// The index of the payload within the FMP capsule which was processed to generate this report
64 /// Starting from zero
69 /// The UpdateImageIndex from EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER
70 /// (after unsigned conversion from UINT8 to UINT16).
72 UINT8 UpdateImageIndex
;
75 /// The UpdateImageTypeId Guid from EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER.
77 EFI_GUID UpdateImageTypeId
;
80 /// In case of capsule loaded from disk, the zero-terminated array containing file name of capsule that was processed.
81 /// In case of capsule submitted directly to UpdateCapsule() there is no file name, and this field is required to contain a single 16-bit zero character
82 /// which is included in VariableTotalSize.
84 /// CHAR16 CapsuleFileName[];
88 /// This field will contain a zero-terminated CHAR16 string containing the text representation of the device path of device publishing Firmware Management Protocol
89 /// (if present). In case where device path is not present and the target is not otherwise known to firmware, or when payload was blocked by policy, or skipped,
90 /// this field is required to contain a single 16-bit zero character which is included in VariableTotalSize.
92 /// CHAR16 CapsuleTarget[];
94 } EFI_CAPSULE_RESULT_VARIABLE_FMP
;
97 extern EFI_GUID gEfiCapsuleReportGuid
;