[edk2-devel] [PATCH v1 7/7] MdePkg: UEFI JSON Capsule Support
Rothman, Michael A
michael.a.rothman at intel.com
Thu Apr 23 02:38:07 UTC 2020
As a general rule, there are places in the specification where we have had fields like this:
// UINT8 Field[];
} STRUC_NAME;
This has a history because not all the compilers supported compiling a non-commented version of the above field without a warning.
Today, this isn’t the case and I think it is safe (no warnings) to instead have the final parameter without the comment marker. I talked with Kinney to verify this and we believe this should work without any issues, and in fact brings development benefits like being able to reference the field directly and having a valid offset to that field.
Thanks,
Mike Rothman
(迈克 罗斯曼 / माइकल रोथ्मेन् / Михаил Ротман / משה רוטמן)
רועה עיקרי של חתולים
From: devel at edk2.groups.io <devel at edk2.groups.io> On Behalf Of Zhiguang Liu
Sent: Wednesday, April 22, 2020 7:30 PM
To: Oleksiy Yakovlev <Oleksiyy at ami.com>; devel at edk2.groups.io
Cc: Feng, Bob C <bob.c.feng at intel.com>; Gao, Liming <liming.gao at intel.com>; Kinney, Michael D <michael.d.kinney at intel.com>; Felix Polyudov <Felixp at ami.com>
Subject: Re: [edk2-devel] [PATCH v1 7/7] MdePkg: UEFI JSON Capsule Support
Hi Oleksiy,
I agree with you that your original code change is good.
But I can’t open the link you posted.
Can you send your new code change here, so that everyone can give their comments.
Thanks
Zhiguang
From: Oleksiy Yakovlev <Oleksiyy at ami.com<mailto:Oleksiyy at ami.com>>
Sent: Thursday, April 23, 2020 4:41 AM
To: Liu, Zhiguang <zhiguang.liu at intel.com<mailto:zhiguang.liu at intel.com>>; devel at edk2.groups.io<mailto:devel at edk2.groups.io>
Cc: Feng, Bob C <bob.c.feng at intel.com<mailto:bob.c.feng at intel.com>>; Gao, Liming <liming.gao at intel.com<mailto:liming.gao at intel.com>>; Kinney, Michael D <michael.d.kinney at intel.com<mailto:michael.d.kinney at intel.com>>; Felix Polyudov <Felixp at ami.com<mailto:Felixp at ami.com>>
Subject: RE: [edk2-devel] [PATCH v1 7/7] MdePkg: UEFI JSON Capsule Support
Hi Zhiguang.
Thank you for your feedback.
Using definition from Spec:
typedef struct {
UINT32 ConfigDataLength;
UINT8 ConfigData[ConfigDataLength];
} EFI_JSON_CONFIG_DATA_ITEM;
will result in build error. You can't use structure field to define array size.
I addressed this issue by commenting out ConfigData, because 3 additional structures, introduced by same mantis use this approach for arrays of unknown size.
But discussing it further with my colleagues here at AMI, we decided that commenting out arrays of unknown size in structures make them harder to use.
So I proposed another approach - use UINT8 ConfigData[]; for this structure and for additional 3 structures introduced by this JSON capsule update feature.
See here:
Mantis 2096<https://mantis.uefi.noclick_org/mantis/view.php?id=2096>
Regards, Oleksiy.
-----Original Message-----
From: Liu, Zhiguang [mailto:zhiguang.liu at intel.com]
Sent: Wednesday, April 22, 2020 4:51 AM
To: devel at edk2.groups.io<mailto:devel at edk2.groups.io>; Oleksiy Yakovlev
Cc: Feng, Bob C; Gao, Liming; Kinney, Michael D; Felix Polyudov
Subject: RE: [edk2-devel] [PATCH v1 7/7] MdePkg: UEFI JSON Capsule Support
Hi Oleksiy,
The definition of EFI_JSON_CONFIG_DATA_ITEM doesn't totally follow the spec.
It is as below in spec without commenting ConfigData.
typedef struct {
UINT32 ConfigDataLength;
UINT8 ConfigData[ConfigDataLength];
} EFI_JSON_CONFIG_DATA_ITEM;
Can you explain why?
Thanks
Zhiguang
-----Original Message-----
From: devel at edk2.groups.io<mailto:devel at edk2.groups.io> <devel at edk2.groups.io<mailto:devel at edk2.groups.io>> On Behalf Of Oleksiy Yakovlev
Sent: Friday, April 10, 2020 4:26 AM
To: devel at edk2.groups.io<mailto:devel at edk2.groups.io>
Cc: Feng, Bob C <bob.c.feng at intel.com<mailto:bob.c.feng at intel.com>>; Gao, Liming <liming.gao at intel.com<mailto:liming.gao at intel.com>>; Kinney, Michael D <michael.d.kinney at intel.com<mailto:michael.d.kinney at intel.com>>; Felixp at ami.com<mailto:Felixp at ami.com>; oleksiyy at ami.com<mailto:oleksiyy at ami.com>
Subject: [edk2-devel] [PATCH v1 7/7] MdePkg: UEFI JSON Capsule Support
Added Guids and structures, that defines the work flow to perform capsule
update using JSON objects.
(UEFI 2.8 mantis 1935)
Signed-off-by: Oleksiy Yakovlev <oleksiyy at ami.com<mailto:oleksiyy at ami.com>>
---
MdePkg/Include/Guid/CapsuleReport.h | 32 +++++++++++-
MdePkg/Include/Guid/JsonCapsule.h | 99 +++++++++++++++++++++++++++++++++++++
MdePkg/Include/Uefi/UefiSpec.h | 1 +
MdePkg/MdePkg.dec | 12 +++++
4 files changed, 143 insertions(+), 1 deletion(-)
create mode 100644 MdePkg/Include/Guid/JsonCapsule.h
diff --git a/MdePkg/Include/Guid/CapsuleReport.h b/MdePkg/Include/Guid/CapsuleReport.h
index 93d2bb7..bdaf275 100644
--- a/MdePkg/Include/Guid/CapsuleReport.h
+++ b/MdePkg/Include/Guid/CapsuleReport.h
@@ -93,7 +93,37 @@ typedef struct {
///
} EFI_CAPSULE_RESULT_VARIABLE_FMP;
-
+typedef struct {
+
+ ///
+ /// Version of this structure, currently 0x00000001
+ ///
+ UINT32 Version;
+
+ ///
+ /// The unique identifier of the capsule whose processing result is recorded in this variable.
+ /// 0x00000000 b 0xEFFFFFFF b Implementation Reserved
+ /// 0xF0000000 b 0xFFFFFFFF b Specification Reserved
+ /// #define REDFISH_DEFINED_JSON_SCHEMA 0xF000000
+ /// The JSON payload shall conform to a Redfish-defined JSON schema, see DMTF-Redfish
+ /// Specification.
+ ///
+ UINT32 CapsuleId;
+
+ ///
+ /// The length of Resp in bytes.
+ ///
+ UINT32 RespLength;
+
+ ///
+ /// Variable length buffer containing the replied JSON payload to the caller who delivered JSON
+ /// capsule to system. The definition of the JSON schema used in the replied payload is beyond
+ /// the scope of this specification.
+ ///
+ /// UINT8 Resp[];
+ ///
+ } EFI_CAPSULE_RESULT_VARIABLE_JSON;
+
extern EFI_GUID gEfiCapsuleReportGuid;
#endif
diff --git a/MdePkg/Include/Guid/JsonCapsule.h b/MdePkg/Include/Guid/JsonCapsule.h
new file mode 100644
index 0000000..eaa126f
--- /dev/null
+++ b/MdePkg/Include/Guid/JsonCapsule.h
@@ -0,0 +1,99 @@
+/** @file
+Guid & data structure for tables defined for reporting firmware configuration data to EFI
+Configuration Tables and also for processing JSON payload capsule.
+
+
+Copyright (c) 2020, American Megatrends International LLC. All rights reserved.<BR>
+SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#ifndef _JSON_CAPSULE_GUID_H__
+#define _JSON_CAPSULE_GUID_H__
+
+//
+// The address reported in the table entry identified by EFI_JSON_CAPSULE_DATA_TABLE_GUID will be
+// referenced as physical and will not be fixed up when transition from preboot to runtime phase. The
+// addresses reported in these table entries identified by EFI_JSON_CONFIG_DATA_TABLE_GUID and
+// EFI_JSON_CAPSULE_RESULT_TABLE_GUID will be referenced as virtual and will be fixed up when
+// transition from preboot to runtime phase.
+//
+#define EFI_JSON_CONFIG_DATA_TABLE_GUID \
+ {0x87367f87, 0x1119, 0x41ce, \
+ {0xaa, 0xec, 0x8b, 0xe0, 0x11, 0x1f, 0x55, 0x8a }}
+#define EFI_JSON_CAPSULE_DATA_TABLE_GUID \
+ {0x35e7a725, 0x8dd2, 0x4cac, \
+ {0x80, 0x11, 0x33, 0xcd, 0xa8, 0x10, 0x90, 0x56 }}
+#define EFI_JSON_CAPSULE_RESULT_TABLE_GUID \
+ {0xdbc461c3, 0xb3de, 0x422a,\
+ {0xb9, 0xb4, 0x98, 0x86, 0xfd, 0x49, 0xa1, 0xe5 }}
+#define EFI_JSON_CAPSULE_ID_GUID \
+ {0x67d6f4cd, 0xd6b8, 0x4573, \
+ {0xbf, 0x4a, 0xde, 0x5e, 0x25, 0x2d, 0x61, 0xae }}
+
+
+
+
+#pragma pack(1)
+
+typedef struct {
+ ///
+ /// Version of the structure, initially 0x00000001.
+ ///
+ UINT32 Version;
+
+ ///
+ /// The unique identifier of this capsule.
+ ///
+ UINT32 CapsuleId;
+
+ ///
+ /// The length of the JSON payload immediately following this header, in bytes.
+ ///
+ UINT32 PayloadLength;
+
+ ///
+ /// Variable length buffer containing the JSON payload that should be parsed and applied to the system. The
+ /// definition of the JSON schema used in the payload is beyond the scope of this specification.
+ /// UINT8 Payload[];
+} EFI_JSON_CAPSULE_HEADER;
+
+typedef struct {
+ ///
+ /// The length of the following ConfigData, in bytes.
+ ///
+ UINT32 ConfigDataLength;
+
+ ///
+ /// Variable length buffer containing the JSON payload that describes one group of configuration data within
+ /// current system. The definition of the JSON schema used in this payload is beyond the scope of this specification.
+ ///
+ ///UINT8 ConfigData[ConfigDataLength];
+} EFI_JSON_CONFIG_DATA_ITEM;
+
+typedef struct {
+ ///
+ /// Version of the structure, initially 0x00000001.
+ ///
+ UINT32 Version;
+
+ ///
+ ////The total length of EFI_JSON_CAPSULE_CONFIG_DATA, in bytes.
+ ///
+ UINT32 TotalLength;
+
+ ///
+ /// Array of configuration data groups.
+ ///
+ /// EFI_JSON_CONFIG_DATA_ITEM ConfigDataList[];
+} EFI_JSON_CAPSULE_CONFIG_DATA;
+
+#pragma pack()
+
+extern EFI_GUID gEfiJsonConfigDataTableGuid;
+extern EFI_GUID gEfiJsonCapsuleDataTableGuid;
+extern EFI_GUID gEfiJsonCapsuleResultTableGuid;
+extern EFI_GUID gEfiJsonCapsuleIdGuid;
+
+
+#endif
diff --git a/MdePkg/Include/Uefi/UefiSpec.h b/MdePkg/Include/Uefi/UefiSpec.h
index c6d306d..ce1b624 100644
--- a/MdePkg/Include/Uefi/UefiSpec.h
+++ b/MdePkg/Include/Uefi/UefiSpec.h
@@ -1781,6 +1781,7 @@ EFI_STATUS
#define EFI_OS_INDICATIONS_FMP_CAPSULE_SUPPORTED 0x0000000000000008
#define EFI_OS_INDICATIONS_CAPSULE_RESULT_VAR_SUPPORTED 0x0000000000000010
#define EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY 0x0000000000000040
+#define EFI_OS_INDICATIONS_JSON_CONFIG_DATA_REFRESH 0x0000000000000080
//
// EFI Runtime Services Table
diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
index ac1f533..77c573e 100644
--- a/MdePkg/MdePkg.dec
+++ b/MdePkg/MdePkg.dec
@@ -646,6 +646,18 @@
gEfiBttAbstractionGuid = { 0x18633bfc, 0x1735, 0x4217, { 0x8a, 0xc9, 0x17, 0x23, 0x92, 0x82, 0xd3, 0xf8 }}
#
+ # GUIDs defined in UEFI2.8
+ #
+ ## Include/Guid/JsonCapsule.h
+ gEfiJsonConfigDataTableGuid = { 0x87367f87, 0x1119, 0x41ce, { 0xaa, 0xec, 0x8b, 0xe0, 0x11, 0x1f, 0x55, 0x8a }}
+ gEfiJsonCapsuleDataTableGuid = { 0x35e7a725, 0x8dd2, 0x4cac, { 0x80, 0x11, 0x33, 0xcd, 0xa8, 0x10, 0x90, 0x56 }}
+ gEfiJsonCapsuleResultTableGuid = { 0xdbc461c3, 0xb3de, 0x422a, { 0xb9, 0xb4, 0x98, 0x86, 0xfd, 0x49, 0xa1, 0xe5 }}
+ gEfiJsonCapsuleIdGuid = { 0x67d6f4cd, 0xd6b8, 0x4573, { 0xbf, 0x4a, 0xde, 0x5e, 0x25, 0x2d, 0x61, 0xae }}
+
+ ## Include\Guid\HiiPlatformSetupFormset.h
+ gEfiHiiResetStyleFormsetGuid = { 0x790217bd, 0xbecf, 0x485b, { 0x91, 0x70, 0x5f, 0xf7, 0x11, 0x31, 0x8b, 0x27 }}
+
+ #
# GUID defined in PI1.0
#
## Include/Guid/AprioriFileName.h
--
2.9.0.windows.1
Please consider the environment before printing this email.
The information contained in this message may be confidential and proprietary to American Megatrends (AMI). This communication is intended to be read only by the individual or entity to whom it is addressed or by their designee. If the reader of this message is not the intended recipient, you are on notice that any distribution of this message, in any form, is strictly prohibited. Please promptly notify the sender by reply e-mail or by telephone at 770-246-8600, and then delete or destroy all copies of the transmission.
P Please consider the environment before printing this email
The information contained in this message may be confidential and proprietary to American Megatrends (AMI). This communication is intended to be read only by the individual or entity to whom it is addressed or by their designee. If the reader of this message is not the intended recipient, you are on notice that any distribution of this message, in any form, is strictly prohibited. Please promptly notify the sender by reply e-mail or by telephone at 770-246-8600, and then delete or destroy all copies of the transmission.
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#57895): https://edk2.groups.io/g/devel/message/57895
Mute This Topic: https://groups.io/mt/72906373/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/edk2-devel-archive/attachments/20200423/484f6eae/attachment.htm>
More information about the edk2-devel-archive
mailing list