From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from NAM12-BN8-obe.outbound.protection.outlook.com (NAM12-BN8-obe.outbound.protection.outlook.com [40.107.237.81]) by mx.groups.io with SMTP id smtpd.web12.3568.1660164382989558367 for ; Wed, 10 Aug 2022 13:46:24 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@ami.com header.s=selector1 header.b=H+vfMHhD; spf=pass (domain: ami.com, ip: 40.107.237.81, mailfrom: igork@ami.com) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=KJCtbMMMTZlog4QwxGaIeUGIFXlcexjAOYVtMTg8KXGaDX7RxAgdYMbxsWfq7khYvtnALX1n5KARZYc02Tz90yxa166/6QFKSVLfcN38VwC71wcgqzPI9I/IOm8CeGGNm2RbjEVC//ESa7TQWqRMyE70elfIOPeD4Faluc/f0KjiwyHkP9OK8VjX6ncjp0/BB45/o6SGlbI7kjpYmoqB00yDH30Ac10mpxIqWNYxhkQA70/u8u66UT6QLmJx/uPfbsy4Cuo21djM/hC/VMVb1BQ6ACyAZdWPo5/3S1W/QyiSmWnlpIMdem9J6INjZ1JCeqHaZYeD1XLb/i73Th034Q== 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=ImUBJqbNanLOyZFE0BKUxkR0IlpsN9DElHnDS3euQhE=; b=m/iRfTV8gB87St84IXcuaYB8ZHttQ4weymizYxHrWBL8+SVFSZxLWLguVOEQ1D0Q/q8IHobbVIfAPQeXst3a7KLro9jCvpin3ymYdBVq0vei7dyIeFFawOMvAIctsV0GcoCignefUVjdscqg57yvHuVvYuQaeB02ejiz4F0g/1VIY/ENDxyE2ttP0riSD9FSOUyHUvLDhiByC8pONU1xKSWoHebUGbp4SE5PV9RQGlf/4pPB/oLKSyi3QNE8l9SmTbmRFTj4qb/oMv/gtFtrXdQ09UY02CfD1vlThCwp+mkk3or9qJRRsTQhnZoq4L3LxHXKe4p0fWdNKaVRipfrbQ== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=ami.com; dmarc=pass action=none header.from=ami.com; dkim=pass header.d=ami.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ami.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=ImUBJqbNanLOyZFE0BKUxkR0IlpsN9DElHnDS3euQhE=; b=H+vfMHhDOLrcxNCO8XpQdonyqgrZjPmK4fOLMcg56/RIr6ojSmGFsra70m0iX/OZ2nE6xd+iZ6SLffVc8eJt9iLk0o51yQX51FnKqNqCFXA8a8gqUrjyQizuO0/aJ8zZGsEn+8JIrG8wcIFjmNXJfGhXh7xs9tmJC/81jy1NGmc= Received: from BLAPR10MB5185.namprd10.prod.outlook.com (2603:10b6:208:328::16) by DM5PR1001MB2217.namprd10.prod.outlook.com (2603:10b6:4:2e::23) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5504.20; Wed, 10 Aug 2022 20:46:20 +0000 Received: from BLAPR10MB5185.namprd10.prod.outlook.com ([fe80::3007:4429:73e9:503e]) by BLAPR10MB5185.namprd10.prod.outlook.com ([fe80::3007:4429:73e9:503e%3]) with mapi id 15.20.5525.011; Wed, 10 Aug 2022 20:46:19 +0000 From: "Igor Kulchytskyy" To: "devel@edk2.groups.io" CC: "Abner.Chang@amd.com" , "nickle.wang@hpe.com" , Igor Kulchytskyy , Abner Chang Subject: [PATCH V2] RedfishPkg: Redfish third party modules may need to use the functions tat are currently private Thread-Topic: [PATCH V2] RedfishPkg: Redfish third party modules may need to use the functions tat are currently private Thread-Index: AQHYrPo+WyFrTV4by0GB+wwg5wABgQ== Date: Wed, 10 Aug 2022 20:46:19 +0000 Message-ID: <1660164369-7620-1-git-send-email-igork@ami.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: authentication-results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=ami.com; x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: 2d51537a-9609-4492-92e6-08da7b116105 x-ms-traffictypediagnostic: DM5PR1001MB2217:EE_ x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: 5WJpNQjhJ18PRzgnYJ84zXSUdZ3dTzZY1YXu7MkZel4hNIR9P7KR7g7OEvqyvFKTSGxTfHEU+ymJ/jXfzYweoHIhm4jtKd5Cdfi1yuoVy43/KUv6Hf5RWU2RL3vwI71aM2jPOYuxfspwv1iTzqr0xyHHq11LZ/g5pJ4qf1nCKC/PSJZl1XSM0eUezAZqLBZ4+eulGK9AlJjkv167pANE5SMwzn8aUw3pyv2FB8ccqo315EZAQEUoEgoAUhVbmbb9/iQUR9GBWcnfJhYbs00U9gZhdsICnbCZdFT7i+dwW7WucNdmdjWr5gEhELdsp4WTDwpwxy3vmgxRFCcDjlzvHhRbMJPDxwFa4AX2LT5EkicE9bY9RdhfBmGXtND0p2k9KijyWI9skmefBvSPQv11jdKmEUJ+yoQ+G+D5kZFgDpyiF18KqLHiTkEnx/g198Unapsdz5+nXN7vbMNPOWW1PCks3jhMbIxOuPMfLDngG2x0k30B/ByLmC3JGU39867WXZYXzEoPu0OGGOhpvt05LPSFLZ5s3QSZ5i+U12OgECY4zmpa9OoN1v8+XC+NRdncLYmc5mIi5/HKjVU4b6hLU/xePBGKwEWTUk5okw9ad8UkzDeQ6JGsh7gTyYWIckYbUTisUEunFECiNTtuJqnz0sJTPOsDr6ItxhMSL7sTgDQ1ncBWPdtV+YB0qNJ4FncaMSOtPqfAid4uhc4W7zfUwYbyb7ihFn4sSbTrAFGc2W1S7XNugN5e3KBOM6x9qVKKPQ/AyiWJKB6lo3tw1+/+udp3SUnAMwjQjr7x1XUhg9hPYfs6kVhgc9odYLYSvT4VKXtvVzL+wKl181ZeVD5PxR9ZAYPGBvlWl5K3+zeTtQ8G6q3OyBJoefaErr5CpqQSCz/4l1izWK3kw49Uo8+mSQ== x-forefront-antispam-report: CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:BLAPR10MB5185.namprd10.prod.outlook.com;PTR:;CAT:NONE;SFS:(13230016)(4636009)(376002)(396003)(366004)(346002)(136003)(39850400004)(6512007)(83380400001)(186003)(2616005)(6506007)(91956017)(86362001)(38100700002)(38070700005)(122000001)(66446008)(66556008)(64756008)(76116006)(8676002)(26005)(6916009)(54906003)(40140700001)(4326008)(5660300002)(36756003)(66946007)(8936002)(30864003)(478600001)(66476007)(6486002)(2906002)(71200400001)(41300700001)(316002)(21314003)(579004)(559001);DIR:OUT;SFP:1101; x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?iso-8859-1?Q?lQGBVFOjfOshoM85tLXI/ihhbNvHAk6Y8XWY394m+BaYgmYVkNbOkW2anJ?= =?iso-8859-1?Q?sml601rt00fa0WxWgMcFLVED42I2v+9QAQviYDkYH4JNVkCkX8H4ZNJWar?= =?iso-8859-1?Q?ECbE/BTycSbun9y+cZVfrzidEd2L0eFM0xmY1e1IF3aHmfBt3qvFCUhgQ7?= =?iso-8859-1?Q?Nbm+mYzkedf3v/sXyiXfTiOwHIh7kbVNG/QoCSK3zuByINcGCzukaUt/UH?= =?iso-8859-1?Q?yriCsK6ThEvwMBVwctmmnd/topDYYsL+kLIaIAkgI1bnY586QNk0BPxUIc?= =?iso-8859-1?Q?86euYH+x/xABUtdehsY3IP2rmHF9olvTc/gM2Q2h7cm40R4bzbeva2oeHo?= =?iso-8859-1?Q?NiFu6fVmL7l/TYacxXnpe316r+Dfdm/aIbSE78xHACfdVtuyFFJ9TjNqfs?= =?iso-8859-1?Q?oNtvxlHpMn1rJr110LLSMvJY3UBjN3E2upvCyZT3HGtE95lZvcEjqZjbXZ?= =?iso-8859-1?Q?oIi+Spj6JGkoX4eg9prCqnGNrMGP+3sQq5/g/v+NHioVmDeM/VjDJflyWl?= =?iso-8859-1?Q?gJv+3tvz+UBiWzE9Dehs+YoNhEdPtyvkewbfRaDPs1pBkxTkzMmT3hg0AP?= =?iso-8859-1?Q?m4RrflJS0iefTakp3bCu0+AneiXJzBXNoyCzBUnzpy5PqgtPOZuk7iw04b?= =?iso-8859-1?Q?ea73L0DXRC8yuSEZJhmObLSeuP/FS6YdCG3Jr5+cunsrMgneTjtlZ5YXWT?= =?iso-8859-1?Q?/nL0ICG0ibiSWf6OCGDAc1p+/PJbpdaz4ZnPNUGIC1Q1m6cHdPc1t2X+2Y?= =?iso-8859-1?Q?MYgnjSeHIm2mtsgz/8P5UX4mP6ZvtWxvhrKS+jbcNG0DqfjHa65eEHW57C?= =?iso-8859-1?Q?mEtm0qSdPWruSRHCpD0sDsKnPWBz7bHCf4xOQtVXXPNS8mxyWAngBUfXVf?= =?iso-8859-1?Q?nr/R2TBoNnT2BksJU15jSdV/43jx8mPRViFF/bEOA92P8QXbTwbXByckFY?= =?iso-8859-1?Q?U92IC2nP1xUWm5gU8JuAVuv1FriLYUXSZain+LJZ9PdSnDWMg7D2tQBmAq?= =?iso-8859-1?Q?NX1KIcglOrZW0QLLpLBFf8F/IuFRrQ3hF5glGsdsfm3K3iiwd9/MWGOwOh?= =?iso-8859-1?Q?iGvdJzazxLXxyX2FAT5nHcBvF7EEILG1R2Mme0+f2OLqNHaAia2+6W8LIp?= =?iso-8859-1?Q?9JGJE1Vf1D5AnL8Ed77c1RmuyhA3eotAyPBacNd2ZoJDR7gd+l0DtT1EC+?= =?iso-8859-1?Q?z2lIYP67IItHiNfXmKB7HIQMbrSHhoDl+/VxjvXXcxg8+U0vkaBbeVQ5Pb?= =?iso-8859-1?Q?6Esc2NAn7ATu4ar37aWNrrkr1a1kJ9CCjhKzfXiv7c3Vyk4wDI+8KMoUvf?= =?iso-8859-1?Q?CUMtkqn8ZuZ+BysBT5ynazByPApmRkLmdIvYN9BfkhExvAuwFKauxkZc5V?= =?iso-8859-1?Q?1uPCYn7noSqJlES2XYvL+mhQcCm+G53RjnbWSRxkE6qcURJHLznQrAMJgs?= =?iso-8859-1?Q?Y3D21qhRbtwXpMnwY5jbCzj8YAgdEGk/h9ogRmEq8FLNEoude/wo6dwXKR?= =?iso-8859-1?Q?geQ5AN+35m7NqenPNa/s3qOdNDdf620pF3CxzjSSyF503kh71mTZ3dT2Cg?= =?iso-8859-1?Q?5FlDjqTfLGc9mwfn8glk9dbYX0DJuNxx0DgKZontvoXU7tNyWioHxaBdk+?= =?iso-8859-1?Q?UoDmbVlzaia/k8ktox6BwJQwsqdqdBvZ9h?= MIME-Version: 1.0 X-OriginatorOrg: ami.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: BLAPR10MB5185.namprd10.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 2d51537a-9609-4492-92e6-08da7b116105 X-MS-Exchange-CrossTenant-originalarrivaltime: 10 Aug 2022 20:46:19.8137 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 27e97857-e15f-486c-b58e-86c2b3040f93 X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: LvKTHaNe2WmSBFztKqmOkhKx4KA9JEKlnLfdyG74UjtBgIlCYyxawSFMNOTCLoLl X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR1001MB2217 Content-Language: en-US Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable Definitions of the required functions to send requests to BMC are in the PrivateInclude folder. So, they cannot be used by the other packages. Cc: Abner Chang Cc: Nickle Wang Signed-off-by: Igor Kulchytskyy --- RedfishPkg/Include/Library/RedfishLib.h | 616 ++++++++++++++++++++ RedfishPkg/PrivateInclude/Library/RedfishLib.h | 616 -------------------- RedfishPkg/RedfishPkg.dec | 2 +- 3 files changed, 617 insertions(+), 617 deletions(-) diff --git a/RedfishPkg/Include/Library/RedfishLib.h b/RedfishPkg/Include/L= ibrary/RedfishLib.h new file mode 100644 index 0000000..b2488ab --- /dev/null +++ b/RedfishPkg/Include/Library/RedfishLib.h @@ -0,0 +1,616 @@ +/** @file + This library provides a set of utility APIs that allow to create/read/up= date/delete + (CRUD) Redfish resources and provide basic query abilities by using [URI= /RedPath] + (https://github.com/DMTF/libredfish). + + The query language is based on XPath (https://www.w3.org/TR/1999/REC-xpa= th-19991116/). + This library and query language essentially treat the entire Redfish Ser= vice like it + was a single JSON document. In other words whenever it encounters an oda= ta.id in JSON + document, it will retrieve the new JSON document (if needed). We name th= e path as + RedPath: + + Expression Description + + nodename Selects the JSON entity with the name "nodename". + If the value of nodename is an object with "@odata.id", + it will continue get the value from "@odata.id". + + / Selects from the root node + + [index] Selects the index number JSON entity from an array or + object. If the JSON entity is one collection (has + Members & Members@odata.count), means to get the index + member in "Members". Index number >=3D1, 1 means to ret= urn + the first instance. + + [XXX] Operation on JSON entity. + If the JSON entity is one collection (has Members & + Members@odata.count), means to get all elements in + "Members". If the JSON entity is one array, means to + get all elements in array. Others will match the nodena= me + directly (e.g. JSON_OBJECT, JSON_STRING, JSON_TRUE, + JSON_FALSE, JSON_INTEGER). + + [nodename] Selects all the elements from an JSON entity that + contain a property named "nodename" + + [name=3Dvalue] Selects all the elements from an JSON entity where + the property "name" is equal to "value" + + [name~value] Selects all the elements from an JSON entity where + the string property "name" is equal to "value" using + case insensitive comparison. + + [namevalue] Selects all the elements from an JSON entity where + the property "name" is greater than "value" + + [name>=3Dvalue] Selects all the elements from an JSON entity where + the property "name" is greater than or equal to "value" + + Some examples: + + /v1/Chassis[1] - Will return the first Chassis instance. + /v1/Chassis[SKU=3D1234] - Will return all Chassis instances with a SKU= field equal to 1234. + /v1/Systems[Storage] - Will return all the System instances that have= Storage field populated. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2021 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef REDFISH_LIB_H_ +#define REDFISH_LIB_H_ + +#include + +#include +#include + +#define ODATA_TYPE_NAME_MAX_SIZE 128 +#define ODATA_TYPE_MAX_SIZE 128 + +/// +/// Library class public defines +/// +typedef VOID *REDFISH_SERVICE; +typedef VOID *REDFISH_PAYLOAD; + +/// +/// Library class public structures/unions +/// +typedef struct { + EFI_HTTP_STATUS_CODE *StatusCode; + UINTN HeaderCount; + EFI_HTTP_HEADER *Headers; + REDFISH_PAYLOAD Payload; +} REDFISH_RESPONSE; + +/// +/// Odata type-name mapping structure. +/// +typedef struct { + CONST CHAR8 OdataTypeName[ODATA_TYPE_NAME_MAX_SIZE]; + CONST CHAR8 OdataType[ODATA_TYPE_MAX_SIZE]; +} REDFISH_ODATA_TYPE_MAPPING; + +/** + This function uses REST EX protocol provided in RedfishConfigServiceInfo= . + The service enumerator will also handle the authentication flow automati= cally + if HTTP basic auth or Redfish session login is configured to use. + + Callers are responsible for freeing the returned service by RedfishClean= upService(). + + @param[in] RedfishConfigServiceInfo Redfish service information the EFI= Redfish + feature driver communicates with. + + @return New created Redfish Service, or NULL if error happens. + +**/ +REDFISH_SERVICE +EFIAPI +RedfishCreateService ( + IN REDFISH_CONFIG_SERVICE_INFORMATION *RedfishConfigServiceInfo + ); + +/** + Free the Service and all its related resources. + + @param[in] RedfishService The Service to access the Redfish resou= rces. + +**/ +VOID +EFIAPI +RedfishCleanupService ( + IN REDFISH_SERVICE RedfishService + ); + +/** + Create REDFISH_PAYLOAD instance in local with JSON represented resource = value and + the Redfish Service. + + The returned REDFISH_PAYLOAD can be used to create or update Redfish res= ource in + server side. + + Callers are responsible for freeing the returned payload by RedfishClean= upPayload(). + + @param[in] Value JSON Value of the redfish resource. + @param[in] RedfishService The Service to access the Redfish re= sources. + + @return REDFISH_PAYLOAD instance of the resource, or NULL if error h= appens. + +**/ +REDFISH_PAYLOAD +EFIAPI +RedfishCreatePayload ( + IN EDKII_JSON_VALUE Value, + IN REDFISH_SERVICE RedfishService + ); + +/** + Free the RedfishPayload and all its related resources. + + @param[in] Payload Payload to be freed. + +**/ +VOID +EFIAPI +RedfishCleanupPayload ( + IN REDFISH_PAYLOAD Payload + ); + +/** + This function returns the decoded JSON value of a REDFISH_PAYLOAD. + + Caller doesn't need to free the returned JSON value because it will be r= eleased + in corresponding RedfishCleanupPayload() function. + + @param[in] Payload A REDFISH_PAYLOAD instance. + + @return Decoded JSON value of the payload. + +**/ +EDKII_JSON_VALUE +EFIAPI +RedfishJsonInPayload ( + IN REDFISH_PAYLOAD Payload + ); + +/** + Fill the input RedPath string with system UUID from SMBIOS table or use = the customized + ID if FromSmbios =3D=3D FALSE. + + This is a helper function to build a RedPath string which can be used to= address + a Redfish resource for this computer system. The input PathString must h= ave a Systems + note in format of "Systems[UUID=3D%g]" or "Systems[UUID~%g]" to fill the= UUID value. + + Example: + Use "/v1/Systems[UUID=3D%g]/Bios" to build a RedPath to address the "B= ios" resource + for this computer system. + + @param[in] RedPath RedPath format to be build. + @param[in] FromSmbios Get system UUID from SMBIOS as computer sys= tem instance ID. + @param[in] IdString The computer system instance ID. + + @return Full RedPath with system UUID inside, or NULL if error happe= ns. + +**/ +CHAR8 * +EFIAPI +RedfishBuildPathWithSystemUuid ( + IN CONST CHAR8 *RedPath, + IN BOOLEAN FromSmbios, + IN CHAR8 *IdString OPTIONAL + ); + +/** + Get a redfish response addressed by a RedPath string, including HTTP Sta= tusCode, Headers + and Payload which record any HTTP response messages. + + Callers are responsible for freeing the HTTP StatusCode, Headers and Pay= load returned in + redfish response data. + + @param[in] RedfishService The Service to access the Redfish re= sources. + @param[in] RedPath RedPath string to address a resource= , must start + from the root node. + @param[out] RedResponse Pointer to the Redfish response data= . + + @retval EFI_SUCCESS The opeartion is successful, indicates t= he HTTP StatusCode is not + NULL and the value is 2XX. The correspon= ding redfish resource has + been returned in Payload within RedRespo= nse. + @retval EFI_INVALID_PARAMETER RedfishService, RedPath, or RedResponse = is NULL. + @retval EFI_DEVICE_ERROR An unexpected system or network error oc= curred. Callers can get + more error info from returned HTTP Statu= sCode, Headers and Payload + within RedResponse: + 1. If the returned Payload is NULL, indi= cates any error happen. + 2. If the returned StatusCode is NULL, i= ndicates any error happen. + 3. If the returned StatusCode is not 2XX= , indicates any error happen. +**/ +EFI_STATUS +EFIAPI +RedfishGetByService ( + IN REDFISH_SERVICE RedfishService, + IN CONST CHAR8 *RedPath, + OUT REDFISH_RESPONSE *RedResponse + ); + +/** + Get a redfish response addressed by URI, including HTTP StatusCode, Head= ers + and Payload which record any HTTP response messages. + + Callers are responsible for freeing the HTTP StatusCode, Headers and Pay= load returned in + redfish response data. + + @param[in] RedfishService The Service to access the URI resources. + @param[in] URI String to address a resource. + @param[out] RedResponse Pointer to the Redfish response data. + + @retval EFI_SUCCESS The opeartion is successful, indicates t= he HTTP StatusCode is not + NULL and the value is 2XX. The correspon= ding redfish resource has + been returned in Payload within RedRespo= nse. + @retval EFI_INVALID_PARAMETER RedfishService, RedPath, or RedResponse = is NULL. + @retval EFI_DEVICE_ERROR An unexpected system or network error oc= curred. Callers can get + more error info from returned HTTP Statu= sCode, Headers and Payload + within RedResponse: + 1. If the returned Payload is NULL, indi= cates any error happen. + 2. If the returned StatusCode is NULL, i= ndicates any error happen. + 3. If the returned StatusCode is not 2XX= , indicates any error happen. +**/ +EFI_STATUS +EFIAPI +RedfishGetByUri ( + IN REDFISH_SERVICE RedfishService, + IN CONST CHAR8 *Uri, + OUT REDFISH_RESPONSE *RedResponse + ); + +/** + Get a redfish response addressed by the input Payload and relative RedPa= th string, + including HTTP StatusCode, Headers and Payload which record any HTTP res= ponse messages. + + Callers are responsible for freeing the HTTP StatusCode, Headers and Pay= load returned in + redfish response data. + + @param[in] Payload A existing REDFISH_PAYLOAD instance. + @param[in] RedPath Relative RedPath string to address a res= ource inside Payload. + @param[out] RedResponse Pointer to the Redfish response data. + + @retval EFI_SUCCESS The opeartion is successful: + 1. The HTTP StatusCode is NULL and the r= eturned Payload in + RedResponse is not NULL, indicates the R= edfish resource has + been parsed from the input payload direc= tly. + 2. The HTTP StatusCode is not NULL and t= he value is 2XX, + indicates the corresponding redfish reso= urce has been returned + in Payload within RedResponse. + @retval EFI_INVALID_PARAMETER Payload, RedPath, or RedResponse is NULL= . + @retval EFI_DEVICE_ERROR An unexpected system or network error oc= curred. Callers can get + more error info from returned HTTP Statu= sCode, Headers and Payload + within RedResponse: + 1. If the returned Payload is NULL, indi= cates any error happen. + 2. If StatusCode is not NULL and the ret= urned value of StatusCode + is not 2XX, indicates any error happe= n. +**/ +EFI_STATUS +EFIAPI +RedfishGetByPayload ( + IN REDFISH_PAYLOAD Payload, + IN CONST CHAR8 *RedPath, + OUT REDFISH_RESPONSE *RedResponse + ); + +/** + Use HTTP PATCH to perform updates on pre-existing Redfish resource. + + This function uses the RedfishService to patch a Redfish resource addres= sed by + Uri (only the relative path is required). Changes to one or more propert= ies within + the target resource are represented in the input Content, properties not= specified + in Content won't be changed by this request. The corresponding redfish r= esponse will + returned, including HTTP StatusCode, Headers and Payload which record an= y HTTP response + messages. + + Callers are responsible for freeing the HTTP StatusCode, Headers and Pay= load returned in + redfish response data. + + @param[in] RedfishService The Service to access the Redfish re= sources. + @param[in] Uri Relative path to address the resourc= e. + @param[in] Content JSON represented properties to be up= date. + @param[out] RedResponse Pointer to the Redfish response data= . + + @retval EFI_SUCCESS The opeartion is successful, indicates t= he HTTP StatusCode is not + NULL and the value is 2XX. The Redfish r= esource will be returned + in Payload within RedResponse if server = send it back in the HTTP + response message body. + @retval EFI_INVALID_PARAMETER RedfishService, Uri, Content, or RedResp= onse is NULL. + @retval EFI_DEVICE_ERROR An unexpected system or network error oc= curred. Callers can get + more error info from returned HTTP Statu= sCode, Headers and Payload + within RedResponse: + 1. If the returned StatusCode is NULL, i= ndicates any error happen. + 2. If the returned StatusCode is not NUL= L and the value is not 2XX, + indicates any error happen. +**/ +EFI_STATUS +EFIAPI +RedfishPatchToUri ( + IN REDFISH_SERVICE RedfishService, + IN CONST CHAR8 *Uri, + IN CONST CHAR8 *Content, + OUT REDFISH_RESPONSE *RedResponse + ); + +/** + Use HTTP PATCH to perform updates on target payload. Patch to odata.id i= n Payload directly. + + This function uses the Payload to patch the Target. Changes to one or mo= re properties + within the target resource are represented in the input Payload, propert= ies not specified + in Payload won't be changed by this request. The corresponding redfish r= esponse will + returned, including HTTP StatusCode, Headers and Payload which record an= y HTTP response + messages. + + Callers are responsible for freeing the HTTP StatusCode, Headers and Pay= load returned in + redfish response data. + + @param[in] Target The target payload to be updated. + @param[in] Payload Palyoad with properties to be changed. + @param[out] RedResponse Pointer to the Redfish response data. + + @retval EFI_SUCCESS The opeartion is successful, indicates t= he HTTP StatusCode is not + NULL and the value is 2XX. The Redfish r= esource will be returned + in Payload within RedResponse if server = send it back in the HTTP + response message body. + @retval EFI_INVALID_PARAMETER Target, Payload, or RedResponse is NULL. + @retval EFI_DEVICE_ERROR An unexpected system or network error oc= curred. Callers can get + more error info from returned HTTP Statu= sCode, Headers and Payload + within RedResponse: + 1. If the returned StatusCode is NULL, i= ndicates any error happen. + 2. If the returned StatusCode is not NUL= L and the value is not 2XX, + indicates any error happen. +**/ +EFI_STATUS +EFIAPI +RedfishPatchToPayload ( + IN REDFISH_PAYLOAD Target, + IN REDFISH_PAYLOAD Payload, + OUT REDFISH_RESPONSE *RedResponse + ); + +/** + Use HTTP POST to create a new resource in target payload. + + The POST request should be submitted to the Resource Collection in which= the new resource + is to belong. The Resource Collection is addressed by Target payload. Th= e Redfish may + ignore any service controlled properties. The corresponding redfish resp= onse will returned, + including HTTP StatusCode, Headers and Payload which record any HTTP res= ponse messages. + + Callers are responsible for freeing the HTTP StatusCode, Headers and Pay= load returned in + redfish response data. + + @param[in] Target Target payload of the Resource Collection. + @param[in] Payload The new resource to be created. + @param[out] RedResponse Pointer to the Redfish response data. + + @retval EFI_SUCCESS The opeartion is successful, indicates t= he HTTP StatusCode is not + NULL and the value is 2XX. The Redfish r= esource will be returned + in Payload within RedResponse if server = send it back in the HTTP + response message body. + @retval EFI_INVALID_PARAMETER Target, Payload, or RedResponse is NULL. + @retval EFI_DEVICE_ERROR An unexpected system or network error oc= curred. Callers can get + more error info from returned HTTP Statu= sCode, Headers and Payload + within RedResponse: + 1. If the returned StatusCode is NULL, i= ndicates any error happen. + 2. If the returned StatusCode is not NUL= L and the value is not 2XX, + indicates any error happen. +**/ +EFI_STATUS +EFIAPI +RedfishPostToPayload ( + IN REDFISH_PAYLOAD Target, + IN REDFISH_PAYLOAD Payload, + OUT REDFISH_RESPONSE *RedResponse + ); + +/** + Use HTTP DELETE to remove a resource. + + This function uses the RedfishService to remove a Redfish resource which= is addressed + by input Uri (only the relative path is required). The corresponding red= fish response will + returned, including HTTP StatusCode, Headers and Payload which record an= y HTTP response + messages. + + Callers are responsible for freeing the HTTP StatusCode, Headers and Pay= load returned in + redfish response data. + + @param[in] RedfishService The Service to access the Redfish re= sources. + @param[in] Uri Relative path to address the resourc= e. + @param[out] RedResponse Pointer to the Redfish response data= . + + @retval EFI_SUCCESS The opeartion is successful, indicates t= he HTTP StatusCode is not + NULL and the value is 2XX, the Redfish r= esource has been removed. + If there is any message returned from se= rver, it will be returned + in Payload within RedResponse. + @retval EFI_INVALID_PARAMETER RedfishService, Uri, or RedResponse is N= ULL. + @retval EFI_DEVICE_ERROR An unexpected system or network error oc= curred. Callers can get + more error info from returned HTTP Statu= sCode, Headers and Payload + within RedResponse: + 1. If the returned StatusCode is NULL, i= ndicates any error happen. + 2. If the returned StatusCode is not NUL= L and the value is not 2XX, + indicates any error happen. +**/ +EFI_STATUS +EFIAPI +RedfishDeleteByUri ( + IN REDFISH_SERVICE RedfishService, + IN CONST CHAR8 *Uri, + OUT REDFISH_RESPONSE *RedResponse + ); + +/** + Dump text in fractions. + + @param[in] String ASCII string to dump. + +**/ +VOID +RedfishDumpJsonStringFractions ( + IN CHAR8 *String + ); + +/** + Extract the JSON text content from REDFISH_PAYLOAD and dump to debug con= sole. + + @param[in] Payload The Redfish payload to dump. + +**/ +VOID +RedfishDumpPayload ( + IN REDFISH_PAYLOAD Payload + ); + +/** + Dump text in JSON value. + + @param[in] JsonValue The Redfish JSON value to dump. + +**/ +VOID +RedfishDumpJson ( + IN EDKII_JSON_VALUE JsonValue + ); + +/** + This function will cleanup the HTTP header and Redfish payload resources= . + + @param[in] StatusCode The status code in HTTP response message. + @param[in] HeaderCount Number of HTTP header structures in Header= s list. + @param[in] Headers Array containing list of HTTP headers. + @param[in] Payload The Redfish payload to dump. + +**/ +VOID +RedfishFreeResponse ( + IN EFI_HTTP_STATUS_CODE *StatusCode, + IN UINTN HeaderCount, + IN EFI_HTTP_HEADER *Headers, + IN REDFISH_PAYLOAD Payload + ); + +/** + Check if the "@odata.type" in Payload is valid or not. + + @param[in] Payload The Redfish payload to be checked. + @param[in] OdataTypeName OdataType will be retrived from map= ping list. + @param[in] OdataTypeMappingList The list of OdataType. + @param[in] OdataTypeMappingListSize The number of mapping list + + @return TRUE if the "@odata.type" in Payload is valid, otherwise FALSE. + +**/ +BOOLEAN +RedfishIsValidOdataType ( + IN REDFISH_PAYLOAD Payload, + IN CONST CHAR8 *OdataTypeName, + IN REDFISH_ODATA_TYPE_MAPPING *OdataTypeMappingList, + IN UINTN OdataTypeMappingListSize + ); + +/** + Check if the payload is collection + + @param[in] Payload The Redfish payload to be checked. + + @return TRUE if the payload is collection. + +**/ +BOOLEAN +RedfishIsPayloadCollection ( + IN REDFISH_PAYLOAD Payload + ); + +/** + Get collection size. + + @param[in] Payload The Redfish collection payload + @param[in] CollectionSize Size of this collection + + @return EFI_SUCCESS Coolection size is returned in Collecti= onSize + @return EFI_INVALID_PARAMETER The payload is not a collection. +**/ +EFI_STATUS +RedfishGetCollectionSize ( + IN REDFISH_PAYLOAD Payload, + IN UINTN *CollectionSize + ); + +/** + Get Redfish payload of collection member + + @param[in] Payload The Redfish collection payload + @param[in] Index Index of collection member + + @return NULL Fail to get collection member. + @return Non NULL Payload is returned. +**/ +REDFISH_PAYLOAD +RedfishGetPayloadByIndex ( + IN REDFISH_PAYLOAD Payload, + IN UINTN Index + ); + +/** + Check and return Redfish resource of the given Redpath. + + @param[in] RedfishService Pointer to REDFISH_SERVICE + @param[in] Redpath Redpath of the resource. + @param[in] Response Optional return the resource. + + @return EFI_STATUS +**/ +EFI_STATUS +RedfishCheckIfRedpathExist ( + IN REDFISH_SERVICE RedfishService, + IN CHAR8 *Redpath, + IN REDFISH_RESPONSE *Response OPTIONAL + ); + +/** + This function returns the string of Redfish service version. + + @param[in] RedfishService Redfish service instance. + @param[out] ServiceVersionStr Redfish service string. + + @return EFI_STATUS + +**/ +EFI_STATUS +RedfishGetServiceVersion ( + IN REDFISH_SERVICE RedfishService, + OUT CHAR8 **ServiceVersionStr + ); + +/** + This function returns the string of Redfish service version. + + @param[in] ServiceVerisonStr The string of Redfish service version. + @param[in] Url The URL to build Redpath with ID. + Start with "/", for example "/Registries" + @param[in] Id ID string + @param[out] Redpath Pointer to retrive Redpath, caller has to= free + the memory allocated for this string. + @return EFI_STATUS + +**/ +EFI_STATUS +RedfishBuildRedpathUseId ( + IN CHAR8 *ServiceVerisonStr, + IN CHAR8 *Url, + IN CHAR8 *Id, + OUT CHAR8 **Redpath + ); + +#endif diff --git a/RedfishPkg/PrivateInclude/Library/RedfishLib.h b/RedfishPkg/Pr= ivateInclude/Library/RedfishLib.h deleted file mode 100644 index b2488ab..0000000 --- a/RedfishPkg/PrivateInclude/Library/RedfishLib.h +++ /dev/null @@ -1,616 +0,0 @@ -/** @file - This library provides a set of utility APIs that allow to create/read/up= date/delete - (CRUD) Redfish resources and provide basic query abilities by using [URI= /RedPath] - (https://github.com/DMTF/libredfish). - - The query language is based on XPath (https://www.w3.org/TR/1999/REC-xpa= th-19991116/). - This library and query language essentially treat the entire Redfish Ser= vice like it - was a single JSON document. In other words whenever it encounters an oda= ta.id in JSON - document, it will retrieve the new JSON document (if needed). We name th= e path as - RedPath: - - Expression Description - - nodename Selects the JSON entity with the name "nodename". - If the value of nodename is an object with "@odata.id", - it will continue get the value from "@odata.id". - - / Selects from the root node - - [index] Selects the index number JSON entity from an array or - object. If the JSON entity is one collection (has - Members & Members@odata.count), means to get the index - member in "Members". Index number >=3D1, 1 means to ret= urn - the first instance. - - [XXX] Operation on JSON entity. - If the JSON entity is one collection (has Members & - Members@odata.count), means to get all elements in - "Members". If the JSON entity is one array, means to - get all elements in array. Others will match the nodena= me - directly (e.g. JSON_OBJECT, JSON_STRING, JSON_TRUE, - JSON_FALSE, JSON_INTEGER). - - [nodename] Selects all the elements from an JSON entity that - contain a property named "nodename" - - [name=3Dvalue] Selects all the elements from an JSON entity where - the property "name" is equal to "value" - - [name~value] Selects all the elements from an JSON entity where - the string property "name" is equal to "value" using - case insensitive comparison. - - [namevalue] Selects all the elements from an JSON entity where - the property "name" is greater than "value" - - [name>=3Dvalue] Selects all the elements from an JSON entity where - the property "name" is greater than or equal to "value" - - Some examples: - - /v1/Chassis[1] - Will return the first Chassis instance. - /v1/Chassis[SKU=3D1234] - Will return all Chassis instances with a SKU= field equal to 1234. - /v1/Systems[Storage] - Will return all the System instances that have= Storage field populated. - - Copyright (c) 2019, Intel Corporation. All rights reserved.
- (C) Copyright 2021 Hewlett Packard Enterprise Development LP
- - SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef REDFISH_LIB_H_ -#define REDFISH_LIB_H_ - -#include - -#include -#include - -#define ODATA_TYPE_NAME_MAX_SIZE 128 -#define ODATA_TYPE_MAX_SIZE 128 - -/// -/// Library class public defines -/// -typedef VOID *REDFISH_SERVICE; -typedef VOID *REDFISH_PAYLOAD; - -/// -/// Library class public structures/unions -/// -typedef struct { - EFI_HTTP_STATUS_CODE *StatusCode; - UINTN HeaderCount; - EFI_HTTP_HEADER *Headers; - REDFISH_PAYLOAD Payload; -} REDFISH_RESPONSE; - -/// -/// Odata type-name mapping structure. -/// -typedef struct { - CONST CHAR8 OdataTypeName[ODATA_TYPE_NAME_MAX_SIZE]; - CONST CHAR8 OdataType[ODATA_TYPE_MAX_SIZE]; -} REDFISH_ODATA_TYPE_MAPPING; - -/** - This function uses REST EX protocol provided in RedfishConfigServiceInfo= . - The service enumerator will also handle the authentication flow automati= cally - if HTTP basic auth or Redfish session login is configured to use. - - Callers are responsible for freeing the returned service by RedfishClean= upService(). - - @param[in] RedfishConfigServiceInfo Redfish service information the EFI= Redfish - feature driver communicates with. - - @return New created Redfish Service, or NULL if error happens. - -**/ -REDFISH_SERVICE -EFIAPI -RedfishCreateService ( - IN REDFISH_CONFIG_SERVICE_INFORMATION *RedfishConfigServiceInfo - ); - -/** - Free the Service and all its related resources. - - @param[in] RedfishService The Service to access the Redfish resou= rces. - -**/ -VOID -EFIAPI -RedfishCleanupService ( - IN REDFISH_SERVICE RedfishService - ); - -/** - Create REDFISH_PAYLOAD instance in local with JSON represented resource = value and - the Redfish Service. - - The returned REDFISH_PAYLOAD can be used to create or update Redfish res= ource in - server side. - - Callers are responsible for freeing the returned payload by RedfishClean= upPayload(). - - @param[in] Value JSON Value of the redfish resource. - @param[in] RedfishService The Service to access the Redfish re= sources. - - @return REDFISH_PAYLOAD instance of the resource, or NULL if error h= appens. - -**/ -REDFISH_PAYLOAD -EFIAPI -RedfishCreatePayload ( - IN EDKII_JSON_VALUE Value, - IN REDFISH_SERVICE RedfishService - ); - -/** - Free the RedfishPayload and all its related resources. - - @param[in] Payload Payload to be freed. - -**/ -VOID -EFIAPI -RedfishCleanupPayload ( - IN REDFISH_PAYLOAD Payload - ); - -/** - This function returns the decoded JSON value of a REDFISH_PAYLOAD. - - Caller doesn't need to free the returned JSON value because it will be r= eleased - in corresponding RedfishCleanupPayload() function. - - @param[in] Payload A REDFISH_PAYLOAD instance. - - @return Decoded JSON value of the payload. - -**/ -EDKII_JSON_VALUE -EFIAPI -RedfishJsonInPayload ( - IN REDFISH_PAYLOAD Payload - ); - -/** - Fill the input RedPath string with system UUID from SMBIOS table or use = the customized - ID if FromSmbios =3D=3D FALSE. - - This is a helper function to build a RedPath string which can be used to= address - a Redfish resource for this computer system. The input PathString must h= ave a Systems - note in format of "Systems[UUID=3D%g]" or "Systems[UUID~%g]" to fill the= UUID value. - - Example: - Use "/v1/Systems[UUID=3D%g]/Bios" to build a RedPath to address the "B= ios" resource - for this computer system. - - @param[in] RedPath RedPath format to be build. - @param[in] FromSmbios Get system UUID from SMBIOS as computer sys= tem instance ID. - @param[in] IdString The computer system instance ID. - - @return Full RedPath with system UUID inside, or NULL if error happe= ns. - -**/ -CHAR8 * -EFIAPI -RedfishBuildPathWithSystemUuid ( - IN CONST CHAR8 *RedPath, - IN BOOLEAN FromSmbios, - IN CHAR8 *IdString OPTIONAL - ); - -/** - Get a redfish response addressed by a RedPath string, including HTTP Sta= tusCode, Headers - and Payload which record any HTTP response messages. - - Callers are responsible for freeing the HTTP StatusCode, Headers and Pay= load returned in - redfish response data. - - @param[in] RedfishService The Service to access the Redfish re= sources. - @param[in] RedPath RedPath string to address a resource= , must start - from the root node. - @param[out] RedResponse Pointer to the Redfish response data= . - - @retval EFI_SUCCESS The opeartion is successful, indicates t= he HTTP StatusCode is not - NULL and the value is 2XX. The correspon= ding redfish resource has - been returned in Payload within RedRespo= nse. - @retval EFI_INVALID_PARAMETER RedfishService, RedPath, or RedResponse = is NULL. - @retval EFI_DEVICE_ERROR An unexpected system or network error oc= curred. Callers can get - more error info from returned HTTP Statu= sCode, Headers and Payload - within RedResponse: - 1. If the returned Payload is NULL, indi= cates any error happen. - 2. If the returned StatusCode is NULL, i= ndicates any error happen. - 3. If the returned StatusCode is not 2XX= , indicates any error happen. -**/ -EFI_STATUS -EFIAPI -RedfishGetByService ( - IN REDFISH_SERVICE RedfishService, - IN CONST CHAR8 *RedPath, - OUT REDFISH_RESPONSE *RedResponse - ); - -/** - Get a redfish response addressed by URI, including HTTP StatusCode, Head= ers - and Payload which record any HTTP response messages. - - Callers are responsible for freeing the HTTP StatusCode, Headers and Pay= load returned in - redfish response data. - - @param[in] RedfishService The Service to access the URI resources. - @param[in] URI String to address a resource. - @param[out] RedResponse Pointer to the Redfish response data. - - @retval EFI_SUCCESS The opeartion is successful, indicates t= he HTTP StatusCode is not - NULL and the value is 2XX. The correspon= ding redfish resource has - been returned in Payload within RedRespo= nse. - @retval EFI_INVALID_PARAMETER RedfishService, RedPath, or RedResponse = is NULL. - @retval EFI_DEVICE_ERROR An unexpected system or network error oc= curred. Callers can get - more error info from returned HTTP Statu= sCode, Headers and Payload - within RedResponse: - 1. If the returned Payload is NULL, indi= cates any error happen. - 2. If the returned StatusCode is NULL, i= ndicates any error happen. - 3. If the returned StatusCode is not 2XX= , indicates any error happen. -**/ -EFI_STATUS -EFIAPI -RedfishGetByUri ( - IN REDFISH_SERVICE RedfishService, - IN CONST CHAR8 *Uri, - OUT REDFISH_RESPONSE *RedResponse - ); - -/** - Get a redfish response addressed by the input Payload and relative RedPa= th string, - including HTTP StatusCode, Headers and Payload which record any HTTP res= ponse messages. - - Callers are responsible for freeing the HTTP StatusCode, Headers and Pay= load returned in - redfish response data. - - @param[in] Payload A existing REDFISH_PAYLOAD instance. - @param[in] RedPath Relative RedPath string to address a res= ource inside Payload. - @param[out] RedResponse Pointer to the Redfish response data. - - @retval EFI_SUCCESS The opeartion is successful: - 1. The HTTP StatusCode is NULL and the r= eturned Payload in - RedResponse is not NULL, indicates the R= edfish resource has - been parsed from the input payload direc= tly. - 2. The HTTP StatusCode is not NULL and t= he value is 2XX, - indicates the corresponding redfish reso= urce has been returned - in Payload within RedResponse. - @retval EFI_INVALID_PARAMETER Payload, RedPath, or RedResponse is NULL= . - @retval EFI_DEVICE_ERROR An unexpected system or network error oc= curred. Callers can get - more error info from returned HTTP Statu= sCode, Headers and Payload - within RedResponse: - 1. If the returned Payload is NULL, indi= cates any error happen. - 2. If StatusCode is not NULL and the ret= urned value of StatusCode - is not 2XX, indicates any error happe= n. -**/ -EFI_STATUS -EFIAPI -RedfishGetByPayload ( - IN REDFISH_PAYLOAD Payload, - IN CONST CHAR8 *RedPath, - OUT REDFISH_RESPONSE *RedResponse - ); - -/** - Use HTTP PATCH to perform updates on pre-existing Redfish resource. - - This function uses the RedfishService to patch a Redfish resource addres= sed by - Uri (only the relative path is required). Changes to one or more propert= ies within - the target resource are represented in the input Content, properties not= specified - in Content won't be changed by this request. The corresponding redfish r= esponse will - returned, including HTTP StatusCode, Headers and Payload which record an= y HTTP response - messages. - - Callers are responsible for freeing the HTTP StatusCode, Headers and Pay= load returned in - redfish response data. - - @param[in] RedfishService The Service to access the Redfish re= sources. - @param[in] Uri Relative path to address the resourc= e. - @param[in] Content JSON represented properties to be up= date. - @param[out] RedResponse Pointer to the Redfish response data= . - - @retval EFI_SUCCESS The opeartion is successful, indicates t= he HTTP StatusCode is not - NULL and the value is 2XX. The Redfish r= esource will be returned - in Payload within RedResponse if server = send it back in the HTTP - response message body. - @retval EFI_INVALID_PARAMETER RedfishService, Uri, Content, or RedResp= onse is NULL. - @retval EFI_DEVICE_ERROR An unexpected system or network error oc= curred. Callers can get - more error info from returned HTTP Statu= sCode, Headers and Payload - within RedResponse: - 1. If the returned StatusCode is NULL, i= ndicates any error happen. - 2. If the returned StatusCode is not NUL= L and the value is not 2XX, - indicates any error happen. -**/ -EFI_STATUS -EFIAPI -RedfishPatchToUri ( - IN REDFISH_SERVICE RedfishService, - IN CONST CHAR8 *Uri, - IN CONST CHAR8 *Content, - OUT REDFISH_RESPONSE *RedResponse - ); - -/** - Use HTTP PATCH to perform updates on target payload. Patch to odata.id i= n Payload directly. - - This function uses the Payload to patch the Target. Changes to one or mo= re properties - within the target resource are represented in the input Payload, propert= ies not specified - in Payload won't be changed by this request. The corresponding redfish r= esponse will - returned, including HTTP StatusCode, Headers and Payload which record an= y HTTP response - messages. - - Callers are responsible for freeing the HTTP StatusCode, Headers and Pay= load returned in - redfish response data. - - @param[in] Target The target payload to be updated. - @param[in] Payload Palyoad with properties to be changed. - @param[out] RedResponse Pointer to the Redfish response data. - - @retval EFI_SUCCESS The opeartion is successful, indicates t= he HTTP StatusCode is not - NULL and the value is 2XX. The Redfish r= esource will be returned - in Payload within RedResponse if server = send it back in the HTTP - response message body. - @retval EFI_INVALID_PARAMETER Target, Payload, or RedResponse is NULL. - @retval EFI_DEVICE_ERROR An unexpected system or network error oc= curred. Callers can get - more error info from returned HTTP Statu= sCode, Headers and Payload - within RedResponse: - 1. If the returned StatusCode is NULL, i= ndicates any error happen. - 2. If the returned StatusCode is not NUL= L and the value is not 2XX, - indicates any error happen. -**/ -EFI_STATUS -EFIAPI -RedfishPatchToPayload ( - IN REDFISH_PAYLOAD Target, - IN REDFISH_PAYLOAD Payload, - OUT REDFISH_RESPONSE *RedResponse - ); - -/** - Use HTTP POST to create a new resource in target payload. - - The POST request should be submitted to the Resource Collection in which= the new resource - is to belong. The Resource Collection is addressed by Target payload. Th= e Redfish may - ignore any service controlled properties. The corresponding redfish resp= onse will returned, - including HTTP StatusCode, Headers and Payload which record any HTTP res= ponse messages. - - Callers are responsible for freeing the HTTP StatusCode, Headers and Pay= load returned in - redfish response data. - - @param[in] Target Target payload of the Resource Collection. - @param[in] Payload The new resource to be created. - @param[out] RedResponse Pointer to the Redfish response data. - - @retval EFI_SUCCESS The opeartion is successful, indicates t= he HTTP StatusCode is not - NULL and the value is 2XX. The Redfish r= esource will be returned - in Payload within RedResponse if server = send it back in the HTTP - response message body. - @retval EFI_INVALID_PARAMETER Target, Payload, or RedResponse is NULL. - @retval EFI_DEVICE_ERROR An unexpected system or network error oc= curred. Callers can get - more error info from returned HTTP Statu= sCode, Headers and Payload - within RedResponse: - 1. If the returned StatusCode is NULL, i= ndicates any error happen. - 2. If the returned StatusCode is not NUL= L and the value is not 2XX, - indicates any error happen. -**/ -EFI_STATUS -EFIAPI -RedfishPostToPayload ( - IN REDFISH_PAYLOAD Target, - IN REDFISH_PAYLOAD Payload, - OUT REDFISH_RESPONSE *RedResponse - ); - -/** - Use HTTP DELETE to remove a resource. - - This function uses the RedfishService to remove a Redfish resource which= is addressed - by input Uri (only the relative path is required). The corresponding red= fish response will - returned, including HTTP StatusCode, Headers and Payload which record an= y HTTP response - messages. - - Callers are responsible for freeing the HTTP StatusCode, Headers and Pay= load returned in - redfish response data. - - @param[in] RedfishService The Service to access the Redfish re= sources. - @param[in] Uri Relative path to address the resourc= e. - @param[out] RedResponse Pointer to the Redfish response data= . - - @retval EFI_SUCCESS The opeartion is successful, indicates t= he HTTP StatusCode is not - NULL and the value is 2XX, the Redfish r= esource has been removed. - If there is any message returned from se= rver, it will be returned - in Payload within RedResponse. - @retval EFI_INVALID_PARAMETER RedfishService, Uri, or RedResponse is N= ULL. - @retval EFI_DEVICE_ERROR An unexpected system or network error oc= curred. Callers can get - more error info from returned HTTP Statu= sCode, Headers and Payload - within RedResponse: - 1. If the returned StatusCode is NULL, i= ndicates any error happen. - 2. If the returned StatusCode is not NUL= L and the value is not 2XX, - indicates any error happen. -**/ -EFI_STATUS -EFIAPI -RedfishDeleteByUri ( - IN REDFISH_SERVICE RedfishService, - IN CONST CHAR8 *Uri, - OUT REDFISH_RESPONSE *RedResponse - ); - -/** - Dump text in fractions. - - @param[in] String ASCII string to dump. - -**/ -VOID -RedfishDumpJsonStringFractions ( - IN CHAR8 *String - ); - -/** - Extract the JSON text content from REDFISH_PAYLOAD and dump to debug con= sole. - - @param[in] Payload The Redfish payload to dump. - -**/ -VOID -RedfishDumpPayload ( - IN REDFISH_PAYLOAD Payload - ); - -/** - Dump text in JSON value. - - @param[in] JsonValue The Redfish JSON value to dump. - -**/ -VOID -RedfishDumpJson ( - IN EDKII_JSON_VALUE JsonValue - ); - -/** - This function will cleanup the HTTP header and Redfish payload resources= . - - @param[in] StatusCode The status code in HTTP response message. - @param[in] HeaderCount Number of HTTP header structures in Header= s list. - @param[in] Headers Array containing list of HTTP headers. - @param[in] Payload The Redfish payload to dump. - -**/ -VOID -RedfishFreeResponse ( - IN EFI_HTTP_STATUS_CODE *StatusCode, - IN UINTN HeaderCount, - IN EFI_HTTP_HEADER *Headers, - IN REDFISH_PAYLOAD Payload - ); - -/** - Check if the "@odata.type" in Payload is valid or not. - - @param[in] Payload The Redfish payload to be checked. - @param[in] OdataTypeName OdataType will be retrived from map= ping list. - @param[in] OdataTypeMappingList The list of OdataType. - @param[in] OdataTypeMappingListSize The number of mapping list - - @return TRUE if the "@odata.type" in Payload is valid, otherwise FALSE. - -**/ -BOOLEAN -RedfishIsValidOdataType ( - IN REDFISH_PAYLOAD Payload, - IN CONST CHAR8 *OdataTypeName, - IN REDFISH_ODATA_TYPE_MAPPING *OdataTypeMappingList, - IN UINTN OdataTypeMappingListSize - ); - -/** - Check if the payload is collection - - @param[in] Payload The Redfish payload to be checked. - - @return TRUE if the payload is collection. - -**/ -BOOLEAN -RedfishIsPayloadCollection ( - IN REDFISH_PAYLOAD Payload - ); - -/** - Get collection size. - - @param[in] Payload The Redfish collection payload - @param[in] CollectionSize Size of this collection - - @return EFI_SUCCESS Coolection size is returned in Collecti= onSize - @return EFI_INVALID_PARAMETER The payload is not a collection. -**/ -EFI_STATUS -RedfishGetCollectionSize ( - IN REDFISH_PAYLOAD Payload, - IN UINTN *CollectionSize - ); - -/** - Get Redfish payload of collection member - - @param[in] Payload The Redfish collection payload - @param[in] Index Index of collection member - - @return NULL Fail to get collection member. - @return Non NULL Payload is returned. -**/ -REDFISH_PAYLOAD -RedfishGetPayloadByIndex ( - IN REDFISH_PAYLOAD Payload, - IN UINTN Index - ); - -/** - Check and return Redfish resource of the given Redpath. - - @param[in] RedfishService Pointer to REDFISH_SERVICE - @param[in] Redpath Redpath of the resource. - @param[in] Response Optional return the resource. - - @return EFI_STATUS -**/ -EFI_STATUS -RedfishCheckIfRedpathExist ( - IN REDFISH_SERVICE RedfishService, - IN CHAR8 *Redpath, - IN REDFISH_RESPONSE *Response OPTIONAL - ); - -/** - This function returns the string of Redfish service version. - - @param[in] RedfishService Redfish service instance. - @param[out] ServiceVersionStr Redfish service string. - - @return EFI_STATUS - -**/ -EFI_STATUS -RedfishGetServiceVersion ( - IN REDFISH_SERVICE RedfishService, - OUT CHAR8 **ServiceVersionStr - ); - -/** - This function returns the string of Redfish service version. - - @param[in] ServiceVerisonStr The string of Redfish service version. - @param[in] Url The URL to build Redpath with ID. - Start with "/", for example "/Registries" - @param[in] Id ID string - @param[out] Redpath Pointer to retrive Redpath, caller has to= free - the memory allocated for this string. - @return EFI_STATUS - -**/ -EFI_STATUS -RedfishBuildRedpathUseId ( - IN CHAR8 *ServiceVerisonStr, - IN CHAR8 *Url, - IN CHAR8 *Id, - OUT CHAR8 **Redpath - ); - -#endif diff --git a/RedfishPkg/RedfishPkg.dec b/RedfishPkg/RedfishPkg.dec index 9886502..0aa2688 100644 --- a/RedfishPkg/RedfishPkg.dec +++ b/RedfishPkg/RedfishPkg.dec @@ -64,7 +64,7 @@ ## @libraryclass Redfish Helper Library # Library provides Redfish helper functions. - RedfishLib|PrivateInclude/Library/RedfishLib.h + RedfishLib|Include/Library/RedfishLib.h [Protocols] ## Include/Protocol/EdkIIRedfishCredential.h -- 2.6.1.windows.1 -The information contained in this message may be confidential and propriet= ary 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 desig= nee. If the reader of this message is not the intended recipient, you are o= n notice that any distribution of this message, in any form, is strictly pr= ohibited. 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= .