From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from NAM11-DM6-obe.outbound.protection.outlook.com (NAM11-DM6-obe.outbound.protection.outlook.com [40.107.223.67]) by mx.groups.io with SMTP id smtpd.web11.33209.1681895361640436909 for ; Wed, 19 Apr 2023 02:09:21 -0700 Authentication-Results: mx.groups.io; dkim=fail reason="body hash did not verify" header.i=@nvidia.com header.s=selector2 header.b=diyIjVVL; spf=permerror, err=parse error for token &{10 18 %{i}._ip.%{h}._ehlo.%{d}._spf.vali.email}: invalid domain name (domain: nvidia.com, ip: 40.107.223.67, mailfrom: nicklew@nvidia.com) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=HBd3kxNTkI75F2yj26rP8hxQ4F9T6ubWyJXBV37Waa7T0IyUJmnnmoQEwVnEEwVX6NoA3Cwesnfi5/UBAUIK9MeMtOAB1Diqi2CiviwJSlFOgljDtC/JrAXeYrc1dV9dqQP7nM9M4V/qDdxUj1e3ph2yziA4zLPENf4oMpi9540657Gi9M2kwtggfoJLUoHd6u6Gp8qzPJFu+SZAhTEmV2J1qTV5kkRE1l90trHImzr1P0CEnPwDyTvuMfXhAsQRvkMeJIH3wJGNhBx9pB8yrW1w1KpLXKzOC+vIOWJMK5ZJmqUR3nEC7YWVSNg4FWR7FYy9uMVc7mfmWBEmq098Cw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=cSUm7YgQ31+kfOj6T4QB5gcCRtB6+DrsGYpWL+0zsPc=; b=jFgD9mVwt5vpS56UuzeT/r67+ffHA3ukeNlKjPWQUC8jC6PjSQitNozVlnchNwdzWozsNqKI4BNrx0BvGKwLyMkpzw1dCj4Kdro/1p67gJ0yjwmBX1ysXgPTL+6orMYtLqj0xF6gvMmOPfGhfiMeChuwAZZC7I9hOIcLIXJa4qeHdVE0y8kQuC5mDytJxxbhXdtipI6PxKfdoQ+tIt8n25bPUIDP7NOT6nMIVIZ8VCJ0ZlNbg0B65gGMRcM4uvX708ipiiU2XpT+KJKmA2xm0FHj4TN+gYIk0OoIPCjy/FRO8PTxoZUJ9OaW3bZED/CpGRXBg7gZl0JsWxbDQ48P8w== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 216.228.118.233) smtp.rcpttodomain=edk2.groups.io smtp.mailfrom=nvidia.com; dmarc=pass (p=reject sp=reject pct=100) action=none header.from=nvidia.com; dkim=none (message not signed); arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=Nvidia.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=cSUm7YgQ31+kfOj6T4QB5gcCRtB6+DrsGYpWL+0zsPc=; b=diyIjVVLoHGjZIJ0M8g+iVymRxtH5C5sG7apD5XcpTTBPj1ShXKWgToAENW7LQtscxUaYwGgsxdWmHS45ox4efs6se0zw3NXGIlPzjI6/oCs2k8hY6jQa/Z4y/sieJkSF3u6MNXgXEywNN1US4cEuYTuFUinKfgtlmXvzExokYm236wm6Mx1+H3iXmmateV/UTkTg/VDvbruLxv6Mp6WZBPEPOahqgcwE/NSNnvvJ3mLdEIxXIdkLGWNNXNrmnO9p+YyphL3KkbFpVzXHpQRKzNKmTlbtxX2YvUZMr9D5KT21wOV9RDIgSZbxZ8yQ71jJVF2xo5KAVj0CUCxvD4c8Q== Received: from MW4PR03CA0247.namprd03.prod.outlook.com (2603:10b6:303:b4::12) by DS0PR12MB6464.namprd12.prod.outlook.com (2603:10b6:8:c4::5) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6298.45; Wed, 19 Apr 2023 09:09:19 +0000 Received: from CO1NAM11FT040.eop-nam11.prod.protection.outlook.com (2603:10b6:303:b4:cafe::8b) by MW4PR03CA0247.outlook.office365.com (2603:10b6:303:b4::12) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6298.47 via Frontend Transport; Wed, 19 Apr 2023 09:09:19 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 216.228.118.233) smtp.mailfrom=nvidia.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=nvidia.com; Received-SPF: Pass (protection.outlook.com: domain of nvidia.com designates 216.228.118.233 as permitted sender) receiver=protection.outlook.com; client-ip=216.228.118.233; helo=mail.nvidia.com; pr=C Received: from mail.nvidia.com (216.228.118.233) by CO1NAM11FT040.mail.protection.outlook.com (10.13.174.140) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6319.21 via Frontend Transport; Wed, 19 Apr 2023 09:09:19 +0000 Received: from drhqmail201.nvidia.com (10.126.190.180) by mail.nvidia.com (10.127.129.6) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.5; Wed, 19 Apr 2023 02:09:17 -0700 Received: from drhqmail201.nvidia.com (10.126.190.180) by drhqmail201.nvidia.com (10.126.190.180) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.37; Wed, 19 Apr 2023 02:09:16 -0700 Received: from NV-CL38DL3.nvidia.com (10.127.8.14) by mail.nvidia.com (10.126.190.180) with Microsoft SMTP Server id 15.2.986.37 via Frontend Transport; Wed, 19 Apr 2023 02:09:16 -0700 From: "Nickle Wang" To: CC: Abner Chang , Igor Kulchytskyy , "Nick Ramirez" Subject: [PATCH v3 1/5] RedfishPkg: introduce EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL Date: Wed, 19 Apr 2023 17:09:15 +0800 Message-ID: <20230419090915.97-1-nicklew@nvidia.com> X-Mailer: git-send-email 2.17.1 MIME-Version: 1.0 Return-Path: nicklew@nvidia.com X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CO1NAM11FT040:EE_|DS0PR12MB6464:EE_ X-MS-Office365-Filtering-Correlation-Id: c189c872-0c36-4820-4553-08db40b5c216 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: 9Sd/JqDKECn1A76OfJlAauT66ZlSp3N15t/JTnJbB53R5zWF6+tnmsK/MZHhPwho/yI2gxaIWt1PrmiMgPEAkWscD1PXhZ+RCq4hVrdJlSSR4YvnVXDH82LjMRSSn8fwDmJaw64xK2bqZkhpfyx9N3vd5Yce5tbkqL1VfCTuxcFHOVE5EHkeq4nMYQdw3y7DsUbYJbtHkfvJ2V74JKQx6IEwa7ehNi/MfANG7lrgoAYKo3+jwu4YfRbIMCjgWqJ3aJ1GC5E6+5IK9W+sIezsJXB6o70morPznECnBuxm2VGN5CmmQRhEUA5Qx+MXAlRAC8V5Wq6TH9XvBn9AENiyLd260pOhAo4vMAU2Jtk61wB3CtHxcvdAvrHZDioKRhm2lDYCIV3z0g5IZ7jWUVYLf8qWZJlRaBH1lyena/jD8SSxtM8g/lU9d0MA5UYN+4rjBBFGeqbeKgaNjF0v/8B5Q9ZHLLwPzqOAtsf3dYhuQscvmWCVJuDM93ar1xc9FIoCu2dklKNFOIdXy8c8HgrQbOsCRhbRT/Dkd5AsYxg+ji9ouk7PCGo7ShCS3k6S39pfOAYywhvXWtyRJ8KeDCrSMaDI3oRs8DyRFLEzVCR5E/4QDeb1gc2ToTxz93TychBSUPbZz4AjkmM7X1MYqqzsoENNULVa47v73ErhLL1fh/4N8n3Q1hgC5n89JDGW29A16+fB595jl5Dml44NSVF43XmwA0bUCQnMXY9DjbcyrPgwAvf628N4Y3Bqo+WZ2oNW6ynkl0MPQ1hNusbPFI/zFx9JmhRDUpwj+UsLrdsN8rM= X-Forefront-Antispam-Report: CIP:216.228.118.233;CTRY:US;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:mail.nvidia.com;PTR:dc7edge2.nvidia.com;CAT:NONE;SFS:(13230028)(4636009)(376002)(39860400002)(396003)(136003)(346002)(451199021)(46966006)(36840700001)(40470700004)(478600001)(8936002)(34070700002)(8676002)(316002)(82740400003)(41300700001)(6916009)(4326008)(70586007)(70206006)(40480700001)(54906003)(7636003)(356005)(19627235002)(186003)(40460700003)(107886003)(2906002)(36756003)(1076003)(26005)(83380400001)(426003)(86362001)(336012)(47076005)(82310400005)(2616005)(5660300002)(36860700001)(7696005);DIR:OUT;SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Apr 2023 09:09:19.1617 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: c189c872-0c36-4820-4553-08db40b5c216 X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=43083d15-7273-40c1-b7db-39efd9ccc17a;Ip=[216.228.118.233];Helo=[mail.nvidia.com] X-MS-Exchange-CrossTenant-AuthSource: CO1NAM11FT040.eop-nam11.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: DS0PR12MB6464 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain EDKII Redfish Platform Config Protocol defines the protocol interfaces that abstracts the platform configuration format and storage from EDK2 Redfish Feature driver. This protocol provides the interfaces to get and set platform configuration with the format and configuration storage agnostic to the Redfish feature driver. Signed-off-by: Nickle Wang Cc: Abner Chang Cc: Igor Kulchytskyy Cc: Nick Ramirez --- RedfishPkg/RedfishPkg.dec | 3 + .../Protocol/EdkIIRedfishPlatformConfig.h | 257 ++++++++++++++++++ 2 files changed, 260 insertions(+) create mode 100644 RedfishPkg/Include/Protocol/EdkIIRedfishPlatformConfig.= h diff --git a/RedfishPkg/RedfishPkg.dec b/RedfishPkg/RedfishPkg.dec index f171053aec10..904630ae4be6 100644 --- a/RedfishPkg/RedfishPkg.dec +++ b/RedfishPkg/RedfishPkg.dec @@ -78,6 +78,9 @@ ## Include/Protocol/Edk2RedfishConfigHandler.h gEdkIIRedfishConfigHandlerProtocolGuid =3D { 0xbc0fe6bb, 0x2cc9, 0x463e,= { 0x90, 0x82, 0xfa, 0x11, 0x76, 0xfc, 0x67, 0xde } } =20 + ## Include/Protocol/EdkIIRedfishPlatformConfig.h + gEdkIIRedfishPlatformConfigProtocolGuid =3D { 0X4D94A7C7, 0X4CE4, 0X4A84= , { 0X88, 0XC1, 0X33, 0X0C, 0XD4, 0XA3, 0X47, 0X67 } } + [Guids] gEfiRedfishPkgTokenSpaceGuid =3D { 0x4fdbccb7, 0xe829, 0x4b4c, { 0x= 88, 0x87, 0xb2, 0x3f, 0xd7, 0x25, 0x4b, 0x85 }} =20 diff --git a/RedfishPkg/Include/Protocol/EdkIIRedfishPlatformConfig.h b/Red= fishPkg/Include/Protocol/EdkIIRedfishPlatformConfig.h new file mode 100644 index 000000000000..d20b2c980e5a --- /dev/null +++ b/RedfishPkg/Include/Protocol/EdkIIRedfishPlatformConfig.h @@ -0,0 +1,257 @@ +/** @file + This file defines the EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL interface. + + (C) Copyright 2021-2022 Hewlett Packard Enterprise Development LP
+ Copyright (c) 2022-2023, NVIDIA CORPORATION & AFFILIATES. All rights res= erved. + + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef EDKII_REDFISH_PLATFORM_CONFIG_H_ +#define EDKII_REDFISH_PLATFORM_CONFIG_H_ + +typedef struct _EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL EDKII_REDFISH_PLATF= ORM_CONFIG_PROTOCOL; + +/// +/// Definition of EDKII_REDFISH_TYPE_VALUE +/// +typedef union { + INT64 Integer; + BOOLEAN Boolean; + CHAR8 *Buffer; + CHAR8 **StringArray; + INT64 *IntegerArray; + BOOLEAN *BooleanArray; +} EDKII_REDFISH_TYPE_VALUE; + +/// +/// Definition of EDKII_REDFISH_VALUE_TYPES +/// +typedef enum { + RedfishValueTypeUnknown =3D 0, + RedfishValueTypeInteger, + RedfishValueTypeBoolean, + RedfishValueTypeString, + RedfishValueTypeStringArray, + RedfishValueTypeIntegerArray, + RedfishValueTypeBooleanArray, + RedfishValueTypeMax +} EDKII_REDFISH_VALUE_TYPES; + +/// +/// Definition of EDKII_REDFISH_ATTRIBUTE_TYPES +/// +typedef enum { + RedfishAttributeTypeUnknown =3D 0, + RedfishAttributeTypeEnumeration, + RedfishAttributeTypeString, + RedfishAttributeTypeInteger, + RedfishAttributeTypeBoolean, + RedfishAttributeTypePassword +} EDKII_REDFISH_ATTRIBUTE_TYPES; + +/// +/// Definition of EDKII_REDFISH_VALUE +/// +typedef struct { + EDKII_REDFISH_VALUE_TYPES Type; + EDKII_REDFISH_TYPE_VALUE Value; + UINTN ArrayCount; +} EDKII_REDFISH_VALUE; + +/// +/// Definition of EDKII_REDFISH_ATTRIBUTE_VALUE +/// +typedef struct { + CHAR8 *ValueName; + CHAR8 *ValueDisplayName; +} EDKII_REDFISH_ATTRIBUTE_VALUE; + +/// +/// Definition of EDKII_REDFISH_POSSIBLE_VALUES +/// +typedef struct { + UINTN ValueCount; + EDKII_REDFISH_ATTRIBUTE_VALUE *ValueArray; +} EDKII_REDFISH_POSSIBLE_VALUES; + +/// +/// Definition of EDKII_REDFISH_ATTRIBUTE +/// +typedef struct { + CHAR8 *AttributeName; + CHAR8 *DisplayName; + CHAR8 *HelpText; + CHAR8 *MenuPath; + EDKII_REDFISH_ATTRIBUTE_TYPES Type; + BOOLEAN ResetRequired; + BOOLEAN ReadOnly; + BOOLEAN GrayedOut; + BOOLEAN Suppress; + UINT64 NumMaximum; + UINT64 NumMinimum; + UINT64 NumStep; + UINT8 StrMaxSize; + UINT8 StrMinSize; + EDKII_REDFISH_POSSIBLE_VALUES Values; +} EDKII_REDFISH_ATTRIBUTE; + +/** + Get Redfish value with the given Schema and Configure Language. + + @param[in] This Pointer to EDKII_REDFISH_PLATFORM_CONFI= G_PROTOCOL instance. + @param[in] Schema The Redfish schema to query. + @param[in] Version The Redfish version to query. + @param[in] ConfigureLang The target value which match this confi= gure Language. + @param[out] Value The returned value. + + @retval EFI_SUCCESS Value is returned successfully. + @retval Others Some error happened. + +**/ +typedef +EFI_STATUS +(EFIAPI *EDKII_REDFISH_PLATFORM_CONFIG_GET_VALUE)( + IN EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL *This, + IN CHAR8 *Schema, + IN CHAR8 *Version, + IN EFI_STRING ConfigureLang, + OUT EDKII_REDFISH_VALUE *Value + ); + +// +// Default class standard +// +#define EDKII_REDFISH_DEFAULT_CLASS_STANDARD EFI_HII_DEFAULT_CLASS_STANDA= RD + +/** + Get Redfish default value with the given Schema and Configure Language. + + @param[in] This Pointer to EDKII_REDFISH_PLATFORM_CONFI= G_PROTOCOL instance. + @param[in] Schema The Redfish schema to query. + @param[in] Version The Redfish version to query. + @param[in] ConfigureLang The target value which match this confi= gure Language. + @param[in] DefaultClass The UEFI defined default class. + Please refer to UEFI spec. 33.2.5.8 "de= faults" for details. + @param[out] Value The returned value. + + @retval EFI_SUCCESS Value is returned successfully. + @retval Others Some error happened. + +**/ +typedef +EFI_STATUS +(EFIAPI *EDKII_REDFISH_PLATFORM_CONFIG_GET_DEFAULT_VALUE)( + IN EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL *This, + IN CHAR8 *Schema, + IN CHAR8 *Version, + IN EFI_STRING ConfigureLang, + IN UINT16 DefaultClass, + OUT EDKII_REDFISH_VALUE *Value + ); + +/** + Set Redfish value with the given Schema and Configure Language. + + @param[in] This Pointer to EDKII_REDFISH_PLATFORM_CONFI= G_PROTOCOL instance. + @param[in] Schema The Redfish schema to query. + @param[in] Version The Redfish version to query. + @param[in] ConfigureLang The target value which match this confi= gure Language. + @param[in] Value The value to set. + + @retval EFI_SUCCESS Value is returned successfully. + @retval Others Some error happened. + +**/ +typedef +EFI_STATUS +(EFIAPI *EDKII_REDFISH_PLATFORM_CONFIG_SET_VALUE)( + IN EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL *This, + IN CHAR8 *Schema, + IN CHAR8 *Version, + IN EFI_STRING ConfigureLang, + IN EDKII_REDFISH_VALUE Value + ); + +/** + Get Redfish attribute value with the given Schema and Configure Language= . + + @param[in] This Pointer to EDKII_REDFISH_PLATFORM_CONFI= G_PROTOCOL instance. + @param[in] Schema The Redfish schema to query. + @param[in] Version The Redfish version to query. + @param[in] ConfigureLang The target value which match this confi= gure Language. + @param[out] AttributeValue The attribute value. + + @retval EFI_SUCCESS Value is returned successfully. + @retval Others Some error happened. + +**/ +typedef +EFI_STATUS +(EFIAPI *EDKII_REDFISH_PLATFORM_CONFIG_GET_ATTRIBUTE)( + IN EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL *This, + IN CHAR8 *Schema, + IN CHAR8 *Version, + IN EFI_STRING ConfigureLang, + OUT EDKII_REDFISH_ATTRIBUTE *AttributeValue + ); + +/** + Get the list of Configure Language from platform configuration by the gi= ven Schema and RegexPattern. + + @param[in] This Pointer to EDKII_REDFISH_PLATFORM_CONFI= G_PROTOCOL instance. + @param[in] Schema The Redfish schema to query. + @param[in] Version The Redfish version to query. + @param[in] RegexPattern The target Configure Language pattern. = This is used for regular expression matching. + @param[out] ConfigureLangList The list of Configure Language. + @param[out] Count The number of Configure Language in Con= figureLangList. + + @retval EFI_SUCCESS ConfigureLangList is returned successfu= lly. + @retval Others Some error happened. + +**/ +typedef +EFI_STATUS +(EFIAPI *EDKII_REDFISH_PLATFORM_CONFIG_GET_CONFIG_LANG)( + IN EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL *This, + IN CHAR8 *Schema, + IN CHAR8 *Version, + IN EFI_STRING RegexPattern, + OUT EFI_STRING **ConfigureLangList, + OUT UINTN *Count + ); + +/** + Get the list of supported Redfish schema from platform configuration. + + @param[in] This Pointer to EDKII_REDFISH_PLATFORM_CONFI= G_PROTOCOL instance. + @param[out] SupportedSchema The supported schema list which is sepa= rated by ';'. + For example: "x-uefi-redfish-Memory.v1_= 7_1;x-uefi-redfish-Boot.v1_0_1" + The SupportedSchema is allocated by the= callee. It's caller's + responsibility to free this buffer usin= g FreePool(). + + @retval EFI_SUCCESS Schema is returned successfully. + @retval Others Some error happened. + +**/ +typedef +EFI_STATUS +(EFIAPI *EDKII_REDFISH_PLATFORM_CONFIG_GET_SUPPORTED_SCHEMA)( + IN EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL *This, + OUT CHAR8 **SupportedSchema + ); + +struct _EDKII_REDFISH_PLATFORM_CONFIG_PROTOCOL { + UINT64 Revision; + EDKII_REDFISH_PLATFORM_CONFIG_GET_VALUE GetValue; + EDKII_REDFISH_PLATFORM_CONFIG_SET_VALUE SetValue; + EDKII_REDFISH_PLATFORM_CONFIG_GET_DEFAULT_VALUE GetDefaultValue; + EDKII_REDFISH_PLATFORM_CONFIG_GET_ATTRIBUTE GetAttribute; + EDKII_REDFISH_PLATFORM_CONFIG_GET_CONFIG_LANG GetConfigureLang; + EDKII_REDFISH_PLATFORM_CONFIG_GET_SUPPORTED_SCHEMA GetSupportedSchema= ; +}; + +extern EFI_GUID gEdkIIRedfishPlatformConfigProtocolGuid; + +#endif --=20 2.17.1