[Design] feature driver OEM or hook support for customized attributes

[nicklela]

A way of giving platform to customize attributes or support OEM attributes.

Some idea:

• Library hook
• Override protocol/callback

Discussion about data structure:

• Use Json C structure
  • The driver or library will have schema dependency
  • platform can only add customization to what schema provided.
• JSON string/object.
  • The function can be coded in single driver / library but platform has to manipulate JSON on their own.
  • Give full freedom for platform to add anything they like. (e.g. some additional control field that BMC requested)

For example (protocol + JSON object version):

EFI_STAUTS 
(EFIAPI *FEATURE_DRIVER_OVERRIDE) (
 IN       PROTOCOL       *This,
 IN       CHAR8          *Uri,
 IN       CHAR8          *Schema,
 IN OUT EDKII_JSON_VALUE *Json
);

typedef struct _FEATURE_DRIVER_OVERRIDE_PROTOCOL {
  UINT64                   Revision;
  FEATURE_DRIVER_OVERRIDE  OverrideCallback;
} FEATURE_DRIVER_OVERRIDE_PROTOCOL;

[nicklela]

EFI_STAUTS 
(EFIAPI *EDKII_REDFISH_RESOURCE_ADDENDUM_PROVISIONING) (
 IN       PROTOCOL                *This,
 IN       CHAR8                      *Uri,
 IN       CHAR8                      *Schema,
 IN OUT EDKII_JSON_VALUE *Json
);

EFI_STAUTS 
(EFIAPI *EDKII_REDFISH_RESOURCE_ADDENDUM_OEM) (
 IN       PROTOCOL                *This,
 IN       CHAR8                      *Uri,
 IN       CHAR8                      *Schema,
 OUT    EDKII_JSON_VALUE  *Json
);

EDKII_REDFISH_RESOURCE_ADDENDUM_PROTOCOL {
  UINT64                                        Revision;
  EDKII_REDFISH_RESOURCE_ADDENDUM_OEM           OemCallback;
  EDKII_REDFISH_RESOURCE_ADDENDUM_PROVISIONING  ProvisioningCallback;
}

Example:

Schema
{
"Attributes": {
}
}

Provisioning BIOS -> USB over lan -> BMC HTTP PUT /redfish/v1/Systems/sys/Bios
{
"control-sku-guid": "aaa-dd-cc",
"Attributes": {
"processornum": {
"value": 16,
"readonly": true,
},
}
}

USER GET /redfish/v1/Systems/sys/Bios
Redfish
{
"Attributes": {
"processornum": 16
}
}

[nicklela]

We need ADDENDUM protocol because there is some data that is required by BMC but the data is came from BIOS. We create this protocol to provide the data for BMC implementation. We can also define addendum items in UEFI specification.

[nicklela]

Code review here:

• https://edk2.groups.io/g/devel/message/97083 [edk2-staging][PATCH 0/3] Introduce resource addendum protocol
• https://edk2.groups.io/g/devel/message/97084 [edk2-staging][PATCH 1/3] edk2-staging/RedfishClientPkg: Add Redfish Resource Addendum Protocol
• https://edk2.groups.io/g/devel/message/97085 [edk2-staging][PATCH 2/3] edk2-staging/RedfishClientPkg: Add Redfish Resource Addendum Library
• https://edk2.groups.io/g/devel/message/97086 [edk2-staging][PATCH 3/3] edk2-staging/RedfishClientPkg: Utilize RedfishAddendumLib