From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from NAM10-MW2-obe.outbound.protection.outlook.com (NAM10-MW2-obe.outbound.protection.outlook.com [40.107.94.59]) by mx.groups.io with SMTP id smtpd.web10.3834.1682047549399963044 for ; Thu, 20 Apr 2023 20:25:49 -0700 Authentication-Results: mx.groups.io; dkim=fail reason="body hash did not verify" header.i=@nvidia.com header.s=selector2 header.b=teEvEjia; 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.94.59, mailfrom: nicklew@nvidia.com) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=Gbg/8rt/5KF0+LfuUvu4bkvEdCyXDHbVPlS4faV7juHMIeNh0R44zH3E7uUUnegZrYTYBCEuRSIO6anY4mZCPkMoYd/AzRpkZ70ZdaxstFaZvfiRI/BQc93j1qpO7PF0/Jzfl8XWQF1MoSi3rS9L+ynu8Oho+UxCFas/v2QsmIOP7iu4omsm51hk8k1hJ4PIFXsIAAJZq+EGh2bgkPvd4bdsK6S27yJCfv/efSwBORcultegFwl0O+PQCJaP2sJ2rgQcd3FCBSnGswnzBTbsAraPsZEmKGRGleg4PD/g38kUHYwcLaQPrNnfTvMoTkgSaKc+Ep8zsjxs5d6O7tMaEQ== 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=JlsA/UbGsHzvnfaP+IYcpEJs07EL1ndHkVNKG6mctq4=; b=B/P2fVlkIlxmQBjNGvYlIAPqGv/YS22JXkj9GV8s+/z7RW8+i9mXZYk4xOBpungjzUY0L78qgR1BxsN+ILntINgbJrfkMTlj20lzY9BX+dy0hivPf0fY6wc+P4vJWb7YpTlAEB6lnjMwZkyph1cyE8O9MUJXSkrNGrW1f6eYvVQZUpVIHnB2v3AQfHfk0iklhre3YekxCXQNi2+4aTsYS+2zjKePgS0kVOKLm2Mwb3qEM/F3MkAGcZ8zexg30utGH58UEMVMa/xK1CluQYd2ZSgh5YTSPT3oGm8d3wiGROpL4vkCHPJ7KXgwOxkqqBClb20GEOD2c2aM9guKlL/meg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 216.228.118.232) 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=JlsA/UbGsHzvnfaP+IYcpEJs07EL1ndHkVNKG6mctq4=; b=teEvEjiao4LXPg+I75OfAa2mKiSM370aEEsHBrzjlwqDnAMEiNnKPi/+yPLbIDwRMkA0y/6ZzDI/4DiOhDGUeCRdgkg+vOlVAx7D+4RUYWiBNfbgOQN55rNScaNIZGF8HV4lW2Lx3eW+gplM8qMSUyRG+pMtVaKuK69bKtsdyNu/wjngG9Vw+j4sfWhdrA6AVNEZ6sTVzSJ157DAFocXkYf746vVMN7BBSDe2kti21euIT3bCyVc54iIw18CNyfuGRt7emOIT+8E2jHvqw2XfOd4VNxCuuAbMFbWNF8UbTj6oNCD3l7tVfm0UW3LJ1hVOqDB/WtzSHt7XHM4qO2yvw== Received: from DM6PR11CA0025.namprd11.prod.outlook.com (2603:10b6:5:190::38) by DS7PR12MB8252.namprd12.prod.outlook.com (2603:10b6:8:ee::7) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6319.22; Fri, 21 Apr 2023 03:25:46 +0000 Received: from DM6NAM11FT049.eop-nam11.prod.protection.outlook.com (2603:10b6:5:190:cafe::9) by DM6PR11CA0025.outlook.office365.com (2603:10b6:5:190::38) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6319.27 via Frontend Transport; Fri, 21 Apr 2023 03:25:46 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 216.228.118.232) 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.232 as permitted sender) receiver=protection.outlook.com; client-ip=216.228.118.232; helo=mail.nvidia.com; pr=C Received: from mail.nvidia.com (216.228.118.232) by DM6NAM11FT049.mail.protection.outlook.com (10.13.172.188) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6319.25 via Frontend Transport; Fri, 21 Apr 2023 03:25:46 +0000 Received: from drhqmail201.nvidia.com (10.126.190.180) by mail.nvidia.com (10.127.129.5) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.5; Thu, 20 Apr 2023 20:25:37 -0700 Received: from drhqmail202.nvidia.com (10.126.190.181) 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; Thu, 20 Apr 2023 20:25:37 -0700 Received: from NV-CL38DL3.nvidia.com (10.127.8.14) by mail.nvidia.com (10.126.190.181) with Microsoft SMTP Server id 15.2.986.37 via Frontend Transport; Thu, 20 Apr 2023 20:25:36 -0700 From: "Nickle Wang" To: CC: Abner Chang , Igor Kulchytskyy , Michael D Kinney Subject: [edk2-redfish-client][PATCH] Initial edk2 redfish client repository Date: Fri, 21 Apr 2023 11:25:36 +0800 Message-ID: <20230421032536.6878-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: DM6NAM11FT049:EE_|DS7PR12MB8252:EE_ X-MS-Office365-Filtering-Correlation-Id: 464b1a19-3399-4129-dcc3-08db421818fb X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: Rk3F9LuhfENmnuo3CSN/MG3nAPjye38twmNS5ymRT1gFmV83xJbf3vV7pI6NSRQm1hjzJn4C/YLFa5CCr6H0jECSPweKhEqKDqkmAcNUjKz0Ub0QEiuWHUPamAZbJKg0YmUHYyjutEPgo/q6mSRVRnA88PHCfL6g4+yrfi3T2s3C752AdVg1qXWc75M/PWbp4XjHzqZOyf8odGBoGxoD0DMgP5ZMO5W7GGGpEh7eFtyjEC5rGCLjbU+U48n24WC1CcFyX89Cbc78K6D/7WWxjwt0H3gs2ovlUT9wOoz+dHkKR5OOfVPgA+X8FjlxU3sKF0iwbWHtfMXk9LfWfv3V3yUoGmTCpTTKS78VFynBy6JuFmwYbuzIvNoscZv5l6gvmlkz0/kPVhDyr05VTgR5R78SWMD0QAJQ4qP8V5cqsaXfYQdaioztyGflZFSk/bpyVph0dnGUZoyJ7DfWCWP62vAaO0EDgIhsF/1QTedjNVGZFrglV4YBDNAvoBL0iWuh8AB4gUiURQG9uZ+iMDIqOCdJeF/ZXhw+Cbnp6jBYHGfxkBbhIZ/71uJe5BIzhvQjFMGhGSkeua4yolKNWFn3pYn51CCOEx1FVsDsVS3SlrNnumJZt0KhPBgPn+YBG4eyMOIbEUrcnLBhtTLfTWO/i4duPjRz/OC3/UZ7t7F+lVhr6uRyMugwmdiU+K+Xs5bKwselJoV/8Av5xEB3isAOhQKF7sdRbToemDV8JCOaMx8QCfS2/aCg8WR+e/k0cGz91jlu8UwZmV1mhwN7Qb8YvA4veFrDebcbBvWKh7blLsc7e2b42xeGzqHyJ/DSX0iEeH/ClebLxcSHDlIGTniITdUsuBzD5waufKfm6Z1fWvI= X-Forefront-Antispam-Report: CIP:216.228.118.232;CTRY:US;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:mail.nvidia.com;PTR:dc7edge1.nvidia.com;CAT:NONE;SFS:(13230028)(4636009)(346002)(39860400002)(396003)(136003)(376002)(451199021)(40470700004)(46966006)(36840700001)(2906002)(40460700003)(8936002)(8676002)(41300700001)(356005)(7636003)(66899021)(5660300002)(82310400005)(36756003)(86362001)(40480700001)(7696005)(966005)(26005)(1076003)(54906003)(34020700004)(478600001)(36860700001)(2616005)(83380400001)(47076005)(426003)(336012)(186003)(70586007)(70206006)(4326008)(6916009)(316002)(82740400003);DIR:OUT;SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 21 Apr 2023 03:25:46.7614 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 464b1a19-3399-4129-dcc3-08db421818fb 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.232];Helo=[mail.nvidia.com] X-MS-Exchange-CrossTenant-AuthSource: DM6NAM11FT049.eop-nam11.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: DS7PR12MB8252 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain Add required files to initial edk2 redfish client repository. Signed-off-by: Nickle Wang Cc: Abner Chang Cc: Igor Kulchytskyy Cc: Michael D Kinney --- .gitignore | 6 +++++ CONTRIBUTING.md | 3 +++ LICENSE | 51 ++++++++++++++++++++++++++++++++++++++ Maintainers.txt | 48 +++++++++++++++++++++++++++++++++++ README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 174 insertions(+) create mode 100644 .gitignore create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 Maintainers.txt create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..df38443 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +.DS_Store +*_extdep/ +*.pyc +__pycache__/ +tags/ +.vscode/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..39a1732 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# Contributing to EDK Redfish Client + +Contributor documentation is maintained on the wiki: https://github.com/ti= anocore/tianocore.github.io/wiki/EDK-II-Development-Process diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..fd0e199 --- /dev/null +++ b/LICENSE @@ -0,0 +1,51 @@ +Copyright (c) 2021, TianoCore and contributors. All rights reserved. + +SPDX-License-Identifier: BSD-2-Clause-Patent + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met= : + +1. Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notic= e, + this list of conditions and the following disclaimer in the documentati= on + and/or other materials provided with the distribution. + +Subject to the terms and conditions of this license, each copyright holder +and contributor hereby grants to those receiving rights under this license +a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocabl= e +(except for failure to satisfy the conditions of this license) patent +license to make, have made, use, offer to sell, sell, import, and otherwis= e +transfer this software, where such license applies only to those patent +claims, already acquired or hereafter acquired, licensable by such copyrig= ht +holder or contributor that are necessarily infringed by: + +(a) their Contribution(s) (the licensed copyrights of copyright holders an= d + non-copyrightable additions of contributors, in source or binary form) + alone; or + +(b) combination of their Contribution(s) with the work of authorship to + which such Contribution(s) was added by such copyright holder or + contributor, if, at the time the Contribution is added, such addition + causes such combination to be necessarily infringed. The patent licens= e + shall not apply to any other combinations which include the + Contribution. + +Except as expressly stated above, no rights or licenses from any copyright +holder or contributor is granted under this license, whether expressly, by +implication, estoppel or otherwise. + +DISCLAIMER + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS= " +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. diff --git a/Maintainers.txt b/Maintainers.txt new file mode 100644 index 0000000..88fd03a --- /dev/null +++ b/Maintainers.txt @@ -0,0 +1,48 @@ +EDK Redfish Client Maintainers +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +This file provides information about the primary maintainers for +EDK Redfish Client. + +In general, you should not privately email the maintainer. You should +email the edk2-devel list, and Cc the package maintainers and +reviewers. + +If the package maintainer wants to hand over the role to other people, +the package maintainer should send the patch to update Maintainers.txt +with new maintainer, and the new maintainer should follow up with +an Acked-by or a Reviewed-by. + +Descriptions of section entries: + + L: Mailing list that is relevant to this area (default is edk2-devel) + Patches and questions should be sent to the email list. + M: Package Maintainer: Cc address for patches and questions. Responsible + for reviewing and pushing package changes to source control. + R: Package Reviewer: Cc address for patches and questions. Reviewers hel= p + maintainers review code, but don't have push access. A designated Pac= kage + Reviewer is reasonably familiar with the Package (or some modules + thereof), and/or provides testing or regression testing for the Packa= ge + (or some modules thereof), in certain platforms and environments. + F: Files and directories with wildcard patterns. + A trailing slash includes all files and subdirectory files. + F: MdeModulePkg/ all files in and below MdeModulePkg + F: MdeModulePkg/* all files in MdeModulePkg, but not below + F: */Pci/* all files in a directory called Pci, at any dept= h in + the hierarchy, but not below + One pattern per line. Multiple F: lines per section acceptable. + + Filenames not caught by any F: rule get matched as being located in the = top- + level directory. (Internally, the script looks for a match called '', + so please don't add a file called that in the top-level directory.) + +EDK Redfish Client +------ +L: https://edk2.groups.io/g/devel/ +T: git - https://github.com/tianocore/edk2-redfish-client.git + +RedfishClientPkg: Redfish client related modules +F: RedfishClientPkg/ +M: Abner Chang [changab] +M: Nickle Wang [nicklela] +R: Igor Kulchytskyy [igorkulchytskyy] diff --git a/README.md b/README.md new file mode 100644 index 0000000..4dfa2c6 --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +# Tianocore Redfish Client +This repository holds EDKII Redfish client libraries, drivers and applicat= ions. +EDKII Redfish client work with EDKII [RedfishPkg](https://github.com/tiano= core/edk2/tree/master/RedfishPkg), +and provides the functionality to support Redfish service hosted by Board = Management Controller (BMC) in server. +Please check [Readme.md](https://github.com/tianocore/edk2/blob/master/Red= fishPkg/Readme.md) for the design of +UEFI Redfish EDK2 implementation. + +# License +The majority of the content in the EDK Redfish Client open source project = uses a +[BSD-2-Clause Plus Patent License](LICENSE). + +# Maintainers + +See [Maintainers.txt](Maintainers.txt). + +# Contributing + +The patch review process would be the same as edk2, and adding prefix **[e= dk2-redfish-client]** +specifically for the patches against edk2-redfish-client repository. For m= ore details, please +see [CONTRIBUTING.md](CONTRIBUTING.md). + +# How to build (Ubuntu Environment) +## Prerequisite +### Install packages +``` +apt-get update; apt-get install install gcc g++ make uuid-dev nasm +``` +If the `nasm` installed above shows build error during build process, we n= eed to install +newer version of `nasm` manually: +- Download `nasm` + ``` + wget https://www.nasm.us/pub/nasm/releasebuilds/2.15rc12/nasm-2.15rc12.t= ar.gz" + ``` +- Extract file + ``` + tar zxvf nasm-2.15rc12.tar.gz" + ``` +- Build and install `nasm` + ``` + cd nasm-2.15rc12 + ./configure --prefix=3D/usr + sudo make install + ``` +- Check to see if `nasm` reports desired version or not + ``` + nasm -v + ``` +### Build EDKII base tools +- Initial submodule (skip this if you already did this) + ``` + git submodule update --init + ``` +- Build base tools + ``` + cd BaseTools + make + ``` +## Build RedfishClientPkg +In order to reference RedfishClientPkg, we need to set `PACKAGES_PATH` and= specify the location +of edk2-redfish-client repository. +``` +export PACKAGES_PATH=3D$PWD/edk2:$PWD/edk2-redfish-client +cd $PWD/edk2 +. ./edksetup.sh +build -p RedfishClientPkg/RedfishClientPkg.dsc -t GCC5 -a X64 +``` --=20 2.17.1