From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by mx.groups.io with SMTP id smtpd.web11.634.1573861716331902386 for ; Fri, 15 Nov 2019 15:48:36 -0800 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 192.55.52.115, mailfrom: nathaniel.l.desimone@intel.com) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga103.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 15 Nov 2019 15:48:36 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.68,310,1569308400"; d="scan'208";a="203526576" Received: from orsmsx106.amr.corp.intel.com ([10.22.225.133]) by fmsmga008.fm.intel.com with ESMTP; 15 Nov 2019 15:48:35 -0800 Received: from orsmsx152.amr.corp.intel.com (10.22.226.39) by ORSMSX106.amr.corp.intel.com (10.22.225.133) with Microsoft SMTP Server (TLS) id 14.3.439.0; Fri, 15 Nov 2019 15:48:35 -0800 Received: from orsmsx114.amr.corp.intel.com ([169.254.8.67]) by ORSMSX152.amr.corp.intel.com ([169.254.8.219]) with mapi id 14.03.0439.000; Fri, 15 Nov 2019 15:48:35 -0800 From: "Nate DeSimone" To: "devel@edk2.groups.io" , "Kubacki, Michael A" CC: "Chaganty, Rangasai V" , "Gao, Liming" Subject: Re: [edk2-devel] [edk2-platforms][PATCH V1 16/49] Features/Intel/IpmiFeaturePkg: Add initial package Thread-Topic: [edk2-devel] [edk2-platforms][PATCH V1 16/49] Features/Intel/IpmiFeaturePkg: Add initial package Thread-Index: AQHVmdKPYFs/lRtLxE6rhiDHoPX80aeMqwkQ Date: Fri, 15 Nov 2019 23:48:34 +0000 Message-ID: <02A34F284D1DA44BB705E61F7180EF0AB5BDB1D8@ORSMSX114.amr.corp.intel.com> References: <20191113032816.4056-1-michael.a.kubacki@intel.com> <20191113032816.4056-17-michael.a.kubacki@intel.com> In-Reply-To: <20191113032816.4056-17-michael.a.kubacki@intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: dlp-product: dlpe-windows dlp-version: 11.2.0.6 dlp-reaction: no-action x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiOGJlNzEyMTktYjEwOS00MzNlLTkwMzgtZDA2MDg0ZjFmMWNjIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiZURsanhFSFRIMGVCamV3ZmlKeVdVMFdQeTVcL2ZGU1pMMTMwSnRLMGZ2K0hSXC9xSEhld1ZTXC9lVStQN05DZUJOQyJ9 x-ctpclassification: CTP_NT x-originating-ip: [10.22.254.140] MIME-Version: 1.0 Return-Path: nathaniel.l.desimone@intel.com Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Please at least fill in the "Purpose" section of Readme.md, don't leave the= entire file as TODOs. -----Original Message----- From: devel@edk2.groups.io On Behalf Of Kubacki, Mi= chael A Sent: Tuesday, November 12, 2019 7:28 PM To: devel@edk2.groups.io Cc: Chaganty, Rangasai V ; Gao, Liming Subject: [edk2-devel] [edk2-platforms][PATCH V1 16/49] Features/Intel/Ipmi= FeaturePkg: Add initial package Adds a new feature package for the IPMI feature. This change updates the advanced feature package template for IPMI and add= s the updated template to the IpmiFeaturePkg. Cc: Sai Chaganty Cc: Liming Gao Signed-off-by: Michael Kubacki --- Features/Intel/OutOfBandManagement/IpmiFeaturePkg/IpmiFeaturePkg.dec = | 29 +++++++ Features/Intel/OutOfBandManagement/IpmiFeaturePkg/IpmiFeaturePkg.dsc = | 24 ++++++ Features/Intel/OutOfBandManagement/IpmiFeaturePkg/Include/PostMemory.fdf = | 8 ++ Features/Intel/OutOfBandManagement/IpmiFeaturePkg/Include/PreMemor= y.fdf | 8 ++ Features/Intel/OutOfBandManagement/IpmiFeaturePkg/Readme.md = | 86 ++++++++++++++++++++ 5 files changed, 155 insertions(+) diff --git a/Features/Intel/OutOfBandManagement/IpmiFeaturePkg/IpmiFeature= Pkg.dec b/Features/Intel/OutOfBandManagement/IpmiFeaturePkg/IpmiFeaturePkg.= dec new file mode 100644 index 0000000000..dfa8888e88 --- /dev/null +++ b/Features/Intel/OutOfBandManagement/IpmiFeaturePkg/IpmiFeaturePkg.d +++ ec @@ -0,0 +1,29 @@ +## @file +# This package provides advanced feature functionality to enable the #=20 +Intelligent Platform Management Interface (IPMI). +# This package should only depend on EDK II Core packages, IntelSiliconPk= g, and MinPlatformPkg. +# +# The DEC files are used by the utilities that parse DSC and # INF=20 +files to generate AutoGen.c and AutoGen.h files # for the build=20 +infrastructure. +# +# Copyright (c) 2019, Intel Corporation. All rights reserved.
# #=20 +SPDX-License-Identifier: BSD-2-Clause-Patent # ## + +[Defines] + DEC_SPECIFICATION =3D 0x00010017 + PACKAGE_NAME =3D IpmiFeaturePkg + PACKAGE_GUID =3D AE091910-F6C9-4AB5-B8B4-995E2F0D5166 + PACKAGE_VERSION =3D 0.1 + +[Includes] + Include + +[Guids] + gIpmiFeaturePkgTokenSpaceGuid =3D {0xc05283f6, 0xd6a8, 0x48f3, {0x9b,= = =20 +0x59, 0xfb, 0xca, 0x71, 0x32, 0x0f, 0x12}} + +[PcdsFeatureFlag] + +gIpmiFeaturePkgTokenSpaceGuid.PcdIpmiFeatureEnable|FALSE|BOOLEAN|0xA000 +0001 diff --git a/Features/Intel/OutOfBandManagement/IpmiFeaturePkg/IpmiFeature= Pkg.dsc b/Features/Intel/OutOfBandManagement/IpmiFeaturePkg/IpmiFeaturePkg.= dsc new file mode 100644 index 0000000000..1952ba185e --- /dev/null +++ b/Features/Intel/OutOfBandManagement/IpmiFeaturePkg/IpmiFeaturePkg.d +++ sc @@ -0,0 +1,24 @@ +## @file +# This package provides advanced feature functionality to enable the #=20 +Intelligent Platform Management Interface (IPMI). +# This package should only depend on EDK II Core packages, IntelSiliconPk= g, and MinPlatformPkg. +# +# The DEC files are used by the utilities that parse DSC and # INF=20 +files to generate AutoGen.c and AutoGen.h files # for the build=20 +infrastructure. +# +# Copyright (c) 2019, Intel Corporation. All rights reserved.
# #=20 +SPDX-License-Identifier: BSD-2-Clause-Patent # ## + +[Defines] + PLATFORM_NAME =3D IpmiFeaturePkg + PLATFORM_GUID =3D 7B2E74D7-9538-4818-B51A-492F3D33BD20 + PLATFORM_VERSION =3D 0.1 + DSC_SPECIFICATION =3D 0x00010005 + OUTPUT_DIRECTORY =3D Build/$(PLATFORM_NAME) + SUPPORTED_ARCHITECTURES =3D IA32|X64 + BUILD_TARGETS =3D DEBUG|RELEASE|NOOPT + SKUID_IDENTIFIER =3D DEFAULT diff --git a/Features/Intel/OutOfBandManagement/IpmiFeaturePkg/Include/Pos= tMemory.fdf b/Features/Intel/OutOfBandManagement/IpmiFeaturePkg/Include/Pos= tMemory.fdf new file mode 100644 index 0000000000..c3847c54c7 --- /dev/null +++ b/Features/Intel/OutOfBandManagement/IpmiFeaturePkg/Include/PostMemo +++ ry.fdf @@ -0,0 +1,8 @@ +## @file +# FDF file for post-memory modules that enable Intelligent Platform Mana= gement Interface. +# +# Copyright (c) 2019, Intel Corporation. All rights reserved.
# #=20 +SPDX-License-Identifier: BSD-2-Clause-Patent # ## diff --git a/Features/Intel/OutOfBandManagement/IpmiFeaturePkg/Include/Pre= Memory.fdf b/Features/Intel/OutOfBandManagement/IpmiFeaturePkg/Include/PreM= emory.fdf new file mode 100644 index 0000000000..0c82d7eb02 --- /dev/null +++ b/Features/Intel/OutOfBandManagement/IpmiFeaturePkg/Include/PreMemor +++ y.fdf @@ -0,0 +1,8 @@ +## @file +# FDF file for pre-memory modules that enable Intelligent Platform Manag= ement Interface. +# +# Copyright (c) 2019, Intel Corporation. All rights reserved.
# #=20 +SPDX-License-Identifier: BSD-2-Clause-Patent # ## diff --git a/Features/Intel/OutOfBandManagement/IpmiFeaturePkg/Readme.md b= /Features/Intel/OutOfBandManagement/IpmiFeaturePkg/Readme.md new file mode 100644 index 0000000000..eaa56835f5 --- /dev/null +++ b/Features/Intel/OutOfBandManagement/IpmiFeaturePkg/Readme.md @@ -0,0 +1,86 @@ +# Overview +* **Feature Name:** Intelligent Platform Management Interface (IPMI) +* **PI Phase(s) Supported:** PEI, DXE +* **SMM Required?** No + +## Purpose +*_TODO_* +Simple overview that describes the purpose of the feature. In general, th= is should be no longer than one paragraph. + +# High-Level Theory of Operation +*_TODO_* +A description of how the device works at a high-level. + +The description should not be constrained to implementation details but= =20 +provide a simple mental model of how the feature is supposed to work. + +## Firmware Volumes +*_TODO_* +A bulleted list of the firmware volumes that feature module(s) are placed= in. + +## Modules +*_TODO_* +A bulleted list of the modules that make up the feature. + +## +*_TODO_* +Each module in the feature should have a section that describes the=20 +module in a level of detail that is useful to better understand the modul= e source code. + +## +*_TODO_* +Each library in the feature should have a section that describes the=20 +library in a level of detail that is useful to better understand the libr= ary source code. + +## Key Functions +*_TODO_* +A bulleted list of key functions for interacting with the feature. + +Not all features need to be listed. Only functions exposed through=20 +external interfaces that are important for feature users to be aware of. + +## Configuration +*_TODO_* +Information that is useful for configuring the feature. + +Not all configuration options need to be listed. This section is used=20 +to provide more background on configuration options than possible elsewhe= re. + +## Data Flows +*_TODO_* +Architecturally defined data structures and flows for the feature. + +## Control Flows +*_TODO_* +Key control flows for the feature. + +## Build Flows +*_TODO_* +Any special build flows should be described in this section. + +This is particularly useful for features that use custom build tools or= =20 +require non-standard tool configuration. If the standard flow in the feat= ure package template is used, this section may be empty. + +## Test Point Results +*_TODO_* +The test(s) that can verify porting is complete for the feature. + +Each feature must describe at least one test point to verify the=20 +feature is successful. If the test point is not implemented, this should = be stated. + +## Functional Exit Criteria +*_TODO_* +The testable functionality for the feature. + +This section should provide an ordered list of criteria that a board=20 +integrator can reference to ensure the feature is functional on their boa= rd. + +## Feature Enabling Checklist +*_TODO_* +An ordered list of required activities to achieve desired functionality f= or the feature. + +## Common Optimizations +*_TODO_* +Common size or performance tuning options for this feature. + +This section is recommended but not required. If not used, the contents s= hould be left empty. -- 2.16.2.windows.1