MdePkg: UEFI JSON Capsule Support

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

/** @file\r
Guid & data structure for tables defined for reporting firmware configuration data to EFI\r
Configuration Tables and also for processing JSON payload capsule.\r
\r
\r
Copyright (c) 2020, American Megatrends International LLC. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __JSON_CAPSULE_GUID_H__\r
#define __JSON_CAPSULE_GUID_H__\r
\r
//\r
// The address reported in the table entry identified by EFI_JSON_CAPSULE_DATA_TABLE_GUID will be\r
// referenced as physical and will not be fixed up when transition from preboot to runtime phase. The\r
// addresses reported in these table entries identified by EFI_JSON_CONFIG_DATA_TABLE_GUID and\r
// EFI_JSON_CAPSULE_RESULT_TABLE_GUID will be referenced as virtual and will be fixed up when\r
// transition from preboot to runtime phase.\r
//\r
#define EFI_JSON_CONFIG_DATA_TABLE_GUID \\r
    {0x87367f87, 0x1119, 0x41ce, \\r
    {0xaa, 0xec, 0x8b, 0xe0, 0x11, 0x1f, 0x55, 0x8a }}\r
#define EFI_JSON_CAPSULE_DATA_TABLE_GUID \\r
    {0x35e7a725, 0x8dd2, 0x4cac, \\r
    {0x80, 0x11, 0x33, 0xcd, 0xa8, 0x10, 0x90, 0x56 }}\r
#define EFI_JSON_CAPSULE_RESULT_TABLE_GUID \\r
    {0xdbc461c3, 0xb3de, 0x422a,\\r
    {0xb9, 0xb4, 0x98, 0x86, 0xfd, 0x49, 0xa1, 0xe5 }}\r
#define EFI_JSON_CAPSULE_ID_GUID \\r
    {0x67d6f4cd, 0xd6b8,  0x4573, \\r
    {0xbf, 0x4a, 0xde, 0x5e, 0x25, 0x2d, 0x61, 0xae }}\r
\r
\r
#pragma pack(1)\r
\r
typedef struct {\r
  ///\r
  /// Version of the structure, initially 0x00000001.\r
  ///\r
  UINT32 Version;\r
\r
  ///\r
  /// The unique identifier of this capsule.\r
  ///\r
  UINT32 CapsuleId;\r
\r
  ///\r
  /// The length of the JSON payload immediately following this header, in bytes.\r
  ///\r
  UINT32 PayloadLength;\r
\r
  ///\r
  /// Variable length buffer containing the JSON payload that should be parsed and applied to the system. The\r
  /// definition of the JSON schema used in the payload is beyond the scope of this specification.\r
  ///\r
  UINT8 Payload[];\r
} EFI_JSON_CAPSULE_HEADER;\r
\r
typedef struct {\r
  ///\r
  /// The length of the following ConfigData, in bytes.\r
  ///\r
  UINT32 ConfigDataLength;\r
\r
  ///\r
  /// Variable length buffer containing the JSON payload that describes one group of configuration data within\r
  /// current system. The definition of the JSON schema used in this payload is beyond the scope of this specification.\r
  ///\r
  UINT8 ConfigData[];\r
} EFI_JSON_CONFIG_DATA_ITEM;\r
\r
typedef struct {\r
  ///\r
  /// Version of the structure, initially 0x00000001.\r
  ///\r
  UINT32 Version;\r
\r
  ///\r
  ////The total length of EFI_JSON_CAPSULE_CONFIG_DATA, in bytes.\r
  ///\r
  UINT32 TotalLength;\r
\r
  ///\r
  /// Array of configuration data groups.\r
  ///\r
  EFI_JSON_CONFIG_DATA_ITEM ConfigDataList[];\r
} EFI_JSON_CAPSULE_CONFIG_DATA;\r
\r
#pragma pack()\r
\r
extern EFI_GUID gEfiJsonConfigDataTableGuid;\r
extern EFI_GUID gEfiJsonCapsuleDataTableGuid;\r
extern EFI_GUID gEfiJsonCapsuleResultTableGuid;\r
extern EFI_GUID gEfiJsonCapsuleIdGuid;\r
\r
\r
#endif\r