From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from mga12.intel.com (mga12.intel.com [192.55.52.136])
 by mx.groups.io with SMTP id smtpd.web09.605.1573861683883853989
 for <devel@edk2.groups.io>;
 Fri, 15 Nov 2019 15:48:03 -0800
Authentication-Results: mx.groups.io;
 dkim=missing; spf=pass (domain: intel.com, ip: 192.55.52.136, mailfrom: nathaniel.l.desimone@intel.com)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from orsmga003.jf.intel.com ([10.7.209.27])
  by fmsmga106.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 15 Nov 2019 15:48:03 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.68,310,1569308400"; 
   d="scan'208";a="208282010"
Received: from orsmsx104.amr.corp.intel.com ([10.22.225.131])
  by orsmga003.jf.intel.com with ESMTP; 15 Nov 2019 15:48:03 -0800
Received: from orsmsx155.amr.corp.intel.com (10.22.240.21) by
 ORSMSX104.amr.corp.intel.com (10.22.225.131) with Microsoft SMTP Server (TLS)
 id 14.3.439.0; Fri, 15 Nov 2019 15:48:03 -0800
Received: from orsmsx114.amr.corp.intel.com ([169.254.8.67]) by
 ORSMSX155.amr.corp.intel.com ([169.254.7.211]) with mapi id 14.03.0439.000;
 Fri, 15 Nov 2019 15:48:02 -0800
From: "Nate DeSimone" <nathaniel.l.desimone@intel.com>
To: "Kubacki, Michael A" <michael.a.kubacki@intel.com>, "devel@edk2.groups.io"
	<devel@edk2.groups.io>
CC: "Chaganty, Rangasai V" <rangasai.v.chaganty@intel.com>, "Gao, Liming"
	<liming.gao@intel.com>
Subject: Re: [edk2-platforms][PATCH V1 11/49] TemplateFeaturePkg: Add initial package
Thread-Topic: [edk2-platforms][PATCH V1 11/49] TemplateFeaturePkg: Add
 initial package
Thread-Index: AQHVmdJ/4aq/1IQQ7UiH0NMxsOUuy6eMquNw
Date: Fri, 15 Nov 2019 23:48:02 +0000
Message-ID: <02A34F284D1DA44BB705E61F7180EF0AB5BDB129@ORSMSX114.amr.corp.intel.com>
References: <20191113032816.4056-1-michael.a.kubacki@intel.com>
 <20191113032816.4056-12-michael.a.kubacki@intel.com>
In-Reply-To: <20191113032816.4056-12-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: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiMzAwMWE3NTYtYzFhMS00Y2RlLWEyMmEtZDhmMzBmNzkyNWIxIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiWTM4S2duWWMyb29MOVNhT1hQMU5RMVJOc0FscEFcL2xZc1lZQlRVdWY2NWRnc1QrYzZFZDdhTFVuS3puWGRVakIifQ==
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

Reviewed-by: Nate DeSimone <nathaniel.l.desimone@intel.com>

-----Original Message-----
From: Kubacki, Michael A <michael.a.kubacki@intel.com>=20
Sent: Tuesday, November 12, 2019 7:28 PM
To: devel@edk2.groups.io
Cc: Chaganty, Rangasai V <rangasai.v.chaganty@intel.com>; Desimone, Nathani=
el L <nathaniel.l.desimone@intel.com>; Gao, Liming <liming.gao@intel.com>
Subject: [edk2-platforms][PATCH V1 11/49] TemplateFeaturePkg: Add initial p=
ackage

This change adds a new package called TemplateFeaturePkg that should be use=
d as a starting point for the creation of new advanced feature packages.

TemplateFeaturePkg is not meant to be built or used directly for functional=
ity. It simply serves as a template to be copied and modified. The advanced=
 feature package creation process is described in detail in Features/Intel/=
Readme.md.

Cc: Sai Chaganty <rangasai.v.chaganty@intel.com>
Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Michael Kubacki <michael.a.kubacki@intel.com>
---
 Features/Intel/TemplateFeaturePkg/TemplateFeaturePkg.dec      |  30 ++++++
 Features/Intel/TemplateFeaturePkg/Include/TemplateFeature.dsc | 113 ++++++=
++++++++++++++
 Features/Intel/TemplateFeaturePkg/TemplateFeaturePkg.dsc      |  30 ++++++
 Features/Intel/TemplateFeaturePkg/Include/PostMemory.fdf      |   8 ++
 Features/Intel/TemplateFeaturePkg/Include/PreMemory.fdf       |   8 ++
 Features/Intel/TemplateFeaturePkg/Readme.md                   |  71 ++++++=
++++++
 6 files changed, 260 insertions(+)

diff --git a/Features/Intel/TemplateFeaturePkg/TemplateFeaturePkg.dec b/Fea=
tures/Intel/TemplateFeaturePkg/TemplateFeaturePkg.dec
new file mode 100644
index 0000000000..b37ce8f34a
--- /dev/null
+++ b/Features/Intel/TemplateFeaturePkg/TemplateFeaturePkg.dec
@@ -0,0 +1,30 @@
+## @file
+# This package provides advanced feature functionality for <TEMPLATE> supp=
ort.
+# This package should only depend on EDK II Core packages, IntelSiliconPkg=
, 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.<BR> # #=20
+SPDX-License-Identifier: BSD-2-Clause-Patent # ##
+
+[Defines]
+  DEC_SPECIFICATION =3D 0x00010017
+  PACKAGE_NAME      =3D TemplateFeaturePkg
+  PACKAGE_GUID      =3D 00000000-0000-0000-0000-000000000000
+  PACKAGE_VERSION   =3D 0.1
+
+[Includes]
+  Include
+
+[LibraryClasses]
+
+[Guids]
+  gTemplateFeaturePkgTokenSpaceGuid  =3D  {0x00000000, 0x0000, 0x0000,=20
+{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}}
+
+[PcdsFeatureFlag]
+ =20
+gTemplateFeaturePkgTokenSpaceGuid.PcdTemplateFeatureEnable|FALSE|BOOLEA
+N|0xA0000001
diff --git a/Features/Intel/TemplateFeaturePkg/Include/TemplateFeature.dsc =
b/Features/Intel/TemplateFeaturePkg/Include/TemplateFeature.dsc
new file mode 100644
index 0000000000..6742eddcf9
--- /dev/null
+++ b/Features/Intel/TemplateFeaturePkg/Include/TemplateFeature.dsc
@@ -0,0 +1,113 @@
+## @file
+# This is a build description file for the <TEMPLATE> advanced feature.
+# This file should be included into another package DSC file to build this=
 feature.
+#
+# 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.<BR> # #=20
+SPDX-License-Identifier: BSD-2-Clause-Patent # ##
+
+#######################################################################
+#########
+#
+# Defines Section - statements that will be processed to create a Makefile=
.
+#
+#######################################################################
+#########
+[Defines]
+!ifndef $(PEI_ARCH)
+  !error "PEI_ARCH must be specified to build this feature!"
+!endif
+!ifndef $(DXE_ARCH)
+  !error "DXE_ARCH must be specified to build this feature!"
+!endif
+
+#######################################################################
+#########
+#
+# Library Class section - list of all Library Classes needed by this featu=
re.
+#
+#######################################################################
+#########
+[LibraryClasses]
+
+  ## Note: This comment block should be removed from the template when the
+  #        template is used.
+  #
+  #  Library classes should have a comment header that describes the=20
+ type of  #  package the library is used from for organization purposes.
+  #
+  #  For an advanced feature, these are typically:
+  #    * Edk2 Packages
+  #    * Silicon Initialization Package
+  #    * Platform Package
+  #    * Feature Package
+  #
+  #  The comment header should follow the format:
+  #
+  #  #######################################
+  #  # Edk2 Packages
+  #  #######################################
+
+#######################################################################
+#########
+#
+# Component section - list of all components that need built for this feat=
ure.
+#
+# Note: The EDK II DSC file is not used to specify how compiled binary ima=
ges get placed
+#       into firmware volume images. This section is just a list of module=
s to compile from
+#       source into UEFI-compliant binaries.
+#       It is the FDF file that contains information on combining binary f=
iles into firmware
+#       volume images, whose concept is beyond UEFI and is described in PI=
 specification.
+#       There may also be modules listed in this section that are not requ=
ired in the FDF file,
+#       When a module listed here is excluded from FDF file, then UEFI-com=
pliant binary will be
+#       generated for it, but the binary will not be put into any firmware=
 volume.
+#
+#######################################################################
+#########
+
+#
+# Feature PEI Components
+#
+
+# @todo: Change below line to [Components.$(PEI_ARCH)] after https://bugzi=
lla.tianocore.org/show_bug.cgi?id=3D2308
+#        is completed.
+[Components.IA32]
+  #####################################
+  # <TEMPALTE> Feature Package
+  #####################################
+
+  # Add library instances here that are not included in package=20
+ components and should be tested  # in the package build.
+
+  # Add components here that should be included in the package build.
+
+#
+# Feature DXE Components
+#
+
+# @todo: Change below line to [Components.$(DXE_ARCH)] after https://bugzi=
lla.tianocore.org/show_bug.cgi?id=3D2308
+#        is completed.
+[Components.X64]
+  #####################################
+  # <TEMPLATE> Feature Package
+  #####################################
+
+  # Add library instances here that are not included in package=20
+ components and should be tested  # in the package build.
+
+  # Add components here that should be included in the package build.
+
+#######################################################################
+############################
+#
+# BuildOptions Section - Define the module specific tool chain flags that =
should be used as
+#                        the default flags for a module. These flags are a=
ppended to any
+#                        standard flags that are defined by the build proc=
ess. They can be
+#                        applied for any modules or only those modules wit=
h the specific
+#                        module style (EDK or EDKII) specified in [Compone=
nts] section.
+#
+#                        For advanced features, it is recommended to enabl=
e [BuildOptions] in
+#                        the applicable INF file so it does not affect the=
 whole board package
+#                        build when this DSC file is active.
+#
+#######################################################################
+############################
+[BuildOptions]
diff --git a/Features/Intel/TemplateFeaturePkg/TemplateFeaturePkg.dsc b/Fea=
tures/Intel/TemplateFeaturePkg/TemplateFeaturePkg.dsc
new file mode 100644
index 0000000000..0ce8debee0
--- /dev/null
+++ b/Features/Intel/TemplateFeaturePkg/TemplateFeaturePkg.dsc
@@ -0,0 +1,30 @@
+## @file
+# This package provides advanced feature functionality for <TEMPLATE> supp=
ort.
+# This package should only depend on EDK II Core packages, IntelSiliconPkg=
, 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.<BR> # #=20
+SPDX-License-Identifier: BSD-2-Clause-Patent # ##
+
+[Defines]
+  PLATFORM_NAME                  =3D TemplateFeaturePkg
+  PLATFORM_GUID                  =3D 00000000-0000-0000-0000-000000000000
+  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
+  PEI_ARCH                       =3D IA32
+  DXE_ARCH                       =3D X64
+
+#
+# This package always builds the feature.
+#
+!include Include/TemplateFeature.dsc
diff --git a/Features/Intel/TemplateFeaturePkg/Include/PostMemory.fdf b/Fea=
tures/Intel/TemplateFeaturePkg/Include/PostMemory.fdf
new file mode 100644
index 0000000000..86225cefbe
--- /dev/null
+++ b/Features/Intel/TemplateFeaturePkg/Include/PostMemory.fdf
@@ -0,0 +1,8 @@
+## @file
+#  FDF file for post-memory <TEMPLATE> advanced feature modules.
+#
+# Copyright (c) 2019, Intel Corporation. All rights reserved.<BR> # #=20
+SPDX-License-Identifier: BSD-2-Clause-Patent # ##
diff --git a/Features/Intel/TemplateFeaturePkg/Include/PreMemory.fdf b/Feat=
ures/Intel/TemplateFeaturePkg/Include/PreMemory.fdf
new file mode 100644
index 0000000000..5ce30af174
--- /dev/null
+++ b/Features/Intel/TemplateFeaturePkg/Include/PreMemory.fdf
@@ -0,0 +1,8 @@
+## @file
+#  FDF file for pre-memory <TEMPLATE> advanced feature modules.
+#
+# Copyright (c) 2019, Intel Corporation. All rights reserved.<BR> # #=20
+SPDX-License-Identifier: BSD-2-Clause-Patent # ##
diff --git a/Features/Intel/TemplateFeaturePkg/Readme.md b/Features/Intel/T=
emplateFeaturePkg/Readme.md
new file mode 100644
index 0000000000..90be279ae3
--- /dev/null
+++ b/Features/Intel/TemplateFeaturePkg/Readme.md
@@ -0,0 +1,71 @@
+# Overview
+* **Feature Name:** <Feature Name>
+* **PI Phase(s) Supported:** <PI Phases Supported>
+* **SMM Required?** <Yes/No>
+
+## Purpose
+Simple overview that describes the purpose of the feature. In general, thi=
s should be no longer than one paragraph.
+
+# High-Level Theory of Operation
+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
+A bulleted list of the firmware volumes that feature module(s) are placed =
in.
+
+## Modules
+A bulleted list of the modules that make up the feature.
+
+## <Module Name>
+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 module=
 source code.
+
+## <Library Name>
+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 libra=
ry source code.
+
+## Key Functions
+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
+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 elsewher=
e.
+
+## Data Flows
+Architecturally defined data structures and flows for the feature.
+
+## Control Flows
+Key control flows for the feature.
+
+## Build Flows
+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 featu=
re package template is used, this section may be empty.
+
+## Test Point Results
+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 b=
e stated.
+
+## Functional Exit Criteria
+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 boar=
d.
+
+## Feature Enabling Checklist
+An ordered list of required activities to achieve desired functionality fo=
r the feature.
+
+## Common Optimizations
+Common size or performance tuning options for this feature.
+
+This section is recommended but not required. If not used, the contents sh=
ould be left empty.
--
2.16.2.windows.1