MdePkg: Apply uncrustify changes

[mirror_edk2.git] / MdePkg / Include / Guid / CapsuleReport.h

/** @file\r
  Guid & data structure used for Capsule process result variables\r
\r
  Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
  GUIDs defined in UEFI 2.4 spec.\r
\r
**/\r
\r
#ifndef _CAPSULE_REPORT_GUID_H__\r
#define _CAPSULE_REPORT_GUID_H__\r
\r
//\r
// This is the GUID for capsule result variable.\r
//\r
#define EFI_CAPSULE_REPORT_GUID \\r
  { \\r
    0x39b68c46, 0xf7fb, 0x441b, {0xb6, 0xec, 0x16, 0xb0, 0xf6, 0x98, 0x21, 0xf3 } \\r
  }\r
\r
typedef struct {\r
  ///\r
  /// Size in bytes of the variable including any data beyond header as specified by CapsuleGuid\r
  ///\r
  UINT32        VariableTotalSize;\r
\r
  ///\r
  /// For alignment\r
  ///\r
  UINT32        Reserved;\r
\r
  ///\r
  /// Guid from EFI_CAPSULE_HEADER\r
  ///\r
  EFI_GUID      CapsuleGuid;\r
\r
  ///\r
  /// Timestamp using system time when processing completed\r
  ///\r
  EFI_TIME      CapsuleProcessed;\r
\r
  ///\r
  /// Result of the capsule processing. Exact interpretation of any error code may depend\r
  /// upon type of capsule processed\r
  ///\r
  EFI_STATUS    CapsuleStatus;\r
} EFI_CAPSULE_RESULT_VARIABLE_HEADER;\r
\r
typedef struct {\r
  ///\r
  /// Version of this structure, currently 0x00000001\r
  ///\r
  UINT16      Version;\r
\r
  ///\r
  /// The index of the payload within the FMP capsule which was processed to generate this report\r
  /// Starting from zero\r
  ///\r
  UINT8       PayloadIndex;\r
\r
  ///\r
  /// The UpdateImageIndex from EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER\r
  /// (after unsigned conversion from UINT8 to UINT16).\r
  ///\r
  UINT8       UpdateImageIndex;\r
\r
  ///\r
  /// The UpdateImageTypeId Guid from EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER.\r
  ///\r
  EFI_GUID    UpdateImageTypeId;\r
\r
  ///\r
  /// In case of capsule loaded from disk, the zero-terminated array containing file name of capsule that was processed.\r
  /// 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\r
  ///  which is included in VariableTotalSize.\r
  ///\r
  /// CHAR16 CapsuleFileName[];\r
  ///\r
\r
  ///\r
  /// This field will contain a zero-terminated CHAR16 string containing the text representation of the device path of device publishing Firmware Management Protocol\r
  /// (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,\r
  /// this field is required to contain a single 16-bit zero character which is included in VariableTotalSize.\r
  ///\r
  /// CHAR16 CapsuleTarget[];\r
  ///\r
} EFI_CAPSULE_RESULT_VARIABLE_FMP;\r
\r
typedef struct {\r
  ///\r
  /// Version of this structure, currently 0x00000001\r
  ///\r
  UINT32    Version;\r
\r
  ///\r
  /// The unique identifier of the capsule whose processing result is recorded in this variable.\r
  /// 0x00000000 - 0xEFFFFFFF - Implementation Reserved\r
  /// 0xF0000000 - 0xFFFFFFFF - Specification Reserved\r
  /// #define REDFISH_DEFINED_JSON_SCHEMA 0xF000000\r
  /// The JSON payload shall conform to a Redfish-defined JSON schema, see DMTF-Redfish\r
  /// Specification.\r
  ///\r
  UINT32    CapsuleId;\r
\r
  ///\r
  /// The length of Resp in bytes.\r
  ///\r
  UINT32    RespLength;\r
\r
  ///\r
  /// Variable length buffer containing the replied JSON payload to the caller who delivered JSON\r
  /// capsule to system. The definition of the JSON schema used in the replied payload is beyond\r
  /// the scope of this specification.\r
  ///\r
  UINT8     Resp[];\r
} EFI_CAPSULE_RESULT_VARIABLE_JSON;\r
\r
extern EFI_GUID  gEfiCapsuleReportGuid;\r
\r
#endif\r