From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <yonghong.zhu@intel.com>
Received-SPF: Pass (sender SPF authorized) identity=mailfrom;
 client-ip=134.134.136.31; helo=mga06.intel.com;
 envelope-from=yonghong.zhu@intel.com; receiver=edk2-devel@lists.01.org 
Received: from mga06.intel.com (mga06.intel.com [134.134.136.31])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (No client certificate requested)
 by ml01.01.org (Postfix) with ESMTPS id 605CB22487290
 for <edk2-devel@lists.01.org>; Tue, 20 Mar 2018 01:21:18 -0700 (PDT)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from fmsmga002.fm.intel.com ([10.253.24.26])
 by orsmga104.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
 20 Mar 2018 01:27:47 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.48,334,1517904000"; d="scan'208";a="29541233"
Received: from fmsmsx103.amr.corp.intel.com ([10.18.124.201])
 by fmsmga002.fm.intel.com with ESMTP; 20 Mar 2018 01:27:47 -0700
Received: from fmsmsx117.amr.corp.intel.com (10.18.116.17) by
 FMSMSX103.amr.corp.intel.com (10.18.124.201) with Microsoft SMTP Server (TLS)
 id 14.3.319.2; Tue, 20 Mar 2018 01:27:47 -0700
Received: from shsmsx152.ccr.corp.intel.com (10.239.6.52) by
 fmsmsx117.amr.corp.intel.com (10.18.116.17) with Microsoft SMTP Server (TLS)
 id 14.3.319.2; Tue, 20 Mar 2018 01:27:46 -0700
Received: from shsmsx103.ccr.corp.intel.com ([169.254.4.235]) by
 SHSMSX152.ccr.corp.intel.com ([169.254.6.129]) with mapi id 14.03.0319.002;
 Tue, 20 Mar 2018 16:27:44 +0800
From: "Zhu, Yonghong" <yonghong.zhu@intel.com>
To: "Gao, Liming" <liming.gao@intel.com>, "edk2-devel@lists.01.org"
 <edk2-devel@lists.01.org>
CC: "Kinney, Michael D" <michael.d.kinney@intel.com>, "Zhu, Yonghong"
 <yonghong.zhu@intel.com>
Thread-Topic: [Patch 2/3] DscSpecification: Add DefaultStores section to
 describe the default setting
Thread-Index: AQHTvOFQW8gY8p3m+kencsPc8RE1hqPY0N1g
Date: Tue, 20 Mar 2018 08:27:44 +0000
Message-ID: <B9726D6DCCFB8B4CA276A9169B02216D51FBA4CC@SHSMSX103.ccr.corp.intel.com>
References: <1521175314-6672-1-git-send-email-liming.gao@intel.com>
 <1521175314-6672-3-git-send-email-liming.gao@intel.com>
In-Reply-To: <1521175314-6672-3-git-send-email-liming.gao@intel.com>
Accept-Language: en-US
X-MS-Has-Attach: 
X-MS-TNEF-Correlator: 
x-originating-ip: [10.239.127.40]
MIME-Version: 1.0
Subject: Re: [Patch 2/3] DscSpecification: Add DefaultStores section to describe the default setting
X-BeenThere: edk2-devel@lists.01.org
X-Mailman-Version: 2.1.23
Precedence: list
List-Id: EDK II Development  <edk2-devel.lists.01.org>
List-Unsubscribe: <https://lists.01.org/mailman/options/edk2-devel>,
 <mailto:edk2-devel-request@lists.01.org?subject=unsubscribe>
List-Archive: <http://lists.01.org/pipermail/edk2-devel/>
List-Post: <mailto:edk2-devel@lists.01.org>
List-Help: <mailto:edk2-devel-request@lists.01.org?subject=help>
List-Subscribe: <https://lists.01.org/mailman/listinfo/edk2-devel>,
 <mailto:edk2-devel-request@lists.01.org?subject=subscribe>
X-List-Received-Date: Tue, 20 Mar 2018 08:21:18 -0000
Content-Language: en-US
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable

Reviewed-by: Yonghong Zhu <yonghong.zhu@intel.com>=20

Best Regards,
Zhu Yonghong


-----Original Message-----
From: Gao, Liming=20
Sent: Friday, March 16, 2018 12:42 PM
To: edk2-devel@lists.01.org
Cc: Kinney, Michael D <michael.d.kinney@intel.com>; Zhu, Yonghong <yonghong=
.zhu@intel.com>
Subject: [Patch 2/3] DscSpecification: Add DefaultStores section to describ=
e the default setting

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Liming Gao <liming.gao@intel.com>
Cc: Michael Kinney <michael.d.kinney@intel.com>
Cc: Yonghong Zhu <yonghong.zhu@intel.com>
---
 .../213_[defaultstores]_section_processing.md      | 49 ++++++++++++
 3_edk_ii_dsc_file_format/310_pcd_sections.md       | 86 ++++++++++++++++++=
++--
 .../313_[defaultstores]_section.md                 | 60 +++++++++++++++
 3 files changed, 190 insertions(+), 5 deletions(-)  create mode 100644 2_d=
sc_overview/213_[defaultstores]_section_processing.md
 create mode 100644 3_edk_ii_dsc_file_format/313_[defaultstores]_section.md

diff --git a/2_dsc_overview/213_[defaultstores]_section_processing.md b/2_d=
sc_overview/213_[defaultstores]_section_processing.md
new file mode 100644
index 0000000..88a7ad2
--- /dev/null
+++ b/2_dsc_overview/213_[defaultstores]_section_processing.md
@@ -0,0 +1,49 @@
+<!--- @file
+  2.13 [DefaultStores] Section Processing
+
+  Copyright (c) 2006-2018, Intel Corporation. All rights reserved.<BR>
+
+  Redistribution and use in source (original document form) and 'compiled'
+  forms (converted to PDF, epub, HTML and other formats) with or=20
+ without  modification, are permitted provided that the following conditio=
ns are met:
+
+  1) Redistributions of source code (original document form) must retain t=
he
+     above copyright notice, this list of conditions and the following
+     disclaimer as the first lines of this file unmodified.
+
+  2) Redistributions in compiled form (transformed to other DTDs, converte=
d to
+     PDF, epub, HTML and other formats) must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in the
+     documentation and/or other materials provided with the distribution.
+
+  THIS DOCUMENTATION IS PROVIDED BY TIANOCORE PROJECT "AS IS" AND ANY=20
+ EXPRESS OR  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE=20
+ IMPLIED WARRANTIES OF  MERCHANTABILITY AND FITNESS FOR A PARTICULAR=20
+ PURPOSE ARE DISCLAIMED. IN NO  EVENT SHALL TIANOCORE PROJECT  BE=20
+ LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,  SPECIAL, EXEMPLARY, OR=20
+ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,  PROCUREMENT OF=20
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;  OR=20
+ BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, =20
+ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE=20
+ OR
+  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION,=20
+ EVEN IF  ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+-->
+
+## 2.13 [DefaultStores] Section Processing
+
+The contents of this section are used to define DefaultStores names.=20
+Default store is UEFI HII concept. It is used to define HII default=20
+setting for the different store, such as standard default,=20
+manufacturing default. Platform can define the supported default store=20
+for DynamicHii/DynamicExHii PCD in this section, tag name to be used.=20
+This section is optional. By default, standard default will be used. Each =
entry below the section header is of the form:
+
+`Number | word`
+
+The following is an example of a `[DefaultStores]` section:
+
+```
+[DefaultStores]
+  0 | Standard        # UEFI Standard default
+  1 | Manufacturing   # UEFI Manufacturing default
+```
diff --git a/3_edk_ii_dsc_file_format/310_pcd_sections.md b/3_edk_ii_dsc_fi=
le_format/310_pcd_sections.md
index 18a243d..f79a0fd 100644
--- a/3_edk_ii_dsc_file_format/310_pcd_sections.md
+++ b/3_edk_ii_dsc_file_format/310_pcd_sections.md
@@ -1,7 +1,7 @@
 <!--- @file
   3.10 PCD Sections
=20
-  Copyright (c) 2006-2017, Intel Corporation. All rights reserved.<BR>
+  Copyright (c) 2006-2018, Intel Corporation. All rights reserved.<BR>
=20
   Redistribution and use in source (original document form) and 'compiled'
   forms (converted to PDF, epub, HTML and other formats) with or without @=
@ -457,10 +457,12 @@ sections of the DSC file.
 <PdvEntries>     ::=3D {<MacroDefinition>} {<IncludeStatement>} {<TS> <Vpd=
Entry>}
 <PcdsHii>        ::=3D "[PcdsDynamicHii" [<PdhAttribs>] "]" <EOL>
                      <PcdHiiEntries>*
-<PdhAttribs>     ::=3D <attrs> ["," <TS> "PcdsDynamicHii <attrs>]* <PdvEnt=
ries>*
+<PdhAttribs>     ::=3D <phattrs> ["," <TS> "PcdsDynamicHii <phattrs>]* <Pd=
vEntries>*
 <PcdHiiEntries>  ::=3D {<MacroDefinition>} {<IncludeStatement>} {<TS> <Hii=
Entry>}
 <attrs>          ::=3D "." <arch> ["." <SkuIds>]
+<phattrs>        ::=3D "." <arch> ["." <SkuIds>]["." <DefaultStore>]
 <SkuIdS>         ::=3D <Keyword> [<FS> <Keyword>]*
+<DefaultStore>   ::=3D <Keyword>
 <Keyword>        ::=3D <UiName>
 <UiName>         ::=3D <Word>
 <MinEntry>       ::=3D <PcdName> [<FS> <PcdValue>] <EOL>
@@ -555,6 +557,42 @@ the `[Defines]` section. Use of the `SkuId` modifier f=
or the `[PcdsDynamic*]`  section tag can be used as a conditional modifier =
or to groups sets of PCDs  according to the `SkuId` identifier.
=20
+**_DefaultStore_**
+
+`DefaultStore` in the DSC file is used to specify=20
+DynamicHii/DynamicExHii PCD value as the default EFI variable for which=20
+default store. It is only valid in DynamicHii/DynamicExHii section. If=20
+it is not specified, DynamicHii/DynamicExHii PCD value will be used as=20
+the standard default EFI variable. For the different combination of SKU an=
d DefaultStore, their inheritance is described as the below.
+
+SKU will inherit its parent SKU setting. DEFAULT SKU is the default parent=
 SKU.
+DefaultStore is the subsection of SKU. It will first inherit from the=20
+same DefaultStore in its parent SKU, then inherit other DefaultStore in th=
e same SKU.
+DefaultStore with the big default store ID will inherit the setting=20
+from one with the small default store ID. If there are more than one=20
+small default store ID, it will use the biggest one to be inherit. Here=20
+is the example. Four PcdsDynamicHii sections are defined.
+
+# Four PcdsDynamicHii section
+[PcdsDynamicHii.common.Default.Standard]
+[PcdsDynamicHii.common.Default.Manufacturing]
+[PcdsDynamicHii.common.Sku1.Standard]
+[PcdsDynamicHii.common.Sku1.Manufacturing]
+
+# DEFAULT Manufacturing setting based on two sections=20
+[PcdsDynamicHii.common.Default.Standard]
+[PcdsDynamicHii.common.Default.Manufacturing]
+
+# SKU1 Standard setting based on two sections=20
+[PcdsDynamicHii.common.Default.Standard]
+[PcdsDynamicHii.common.Sku1.Standard]
+
+# SKU1 Manufacturing setting based on four sections=20
+[PcdsDynamicHii.common.Default.Standard]
+[PcdsDynamicHii.common.Default.Manufacturing]
+[PcdsDynamicHii.common.Sku1.Standard]
+[PcdsDynamicHii.common.Sku1.Manufacturing]
+
 **_PcdValues_**
=20
 PCD values are optional for `[PcdsDynamicDefault]` sections. The PCD value=
s for @@ -584,7 +622,7 @@ the _UEFI Specification_ for a description of the=
se attributes.
   gNoSuchTokenSpaceGuid.PcdOemBootOptionPath|0x2338|100|" "             # =
VOID*
   gNoSuchTokenSpaceGuid.PcdEnableFastBoot   |0x239C|1  |FALSE           # =
BOOLEAN
=20
-[PcdsDynamicHii.IA32, PcdsDynamicHii.X64.Sku1]
+[PcdsDynamicHii.IA32, PcdsDynamicHii.X64.Sku1.Standard]
   gEfiMyModulePkgTokenSpaceGuid.PcdChassisIntrution|0x0053 0x0065 0x0074 0=
x0075 0x0070|gSysConfigGuid|0x83|0x0
   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPlatformBootTimeOut|L"Timeo=
ut"|gEfiGlobalVariableGuid|0x0|10  # Variable: L"Timeout"
 ```
@@ -633,11 +671,13 @@ sections of the DSC file.
                      {<TS> <VpdEntry>}
 <PcdsExHii>      ::=3D "[PcdsDynamicExHii" [<PdhAttribs>] "]" <EOL>
                      <PcdHiiEntries>*
-<PdhAttribs>     ::=3D <attrs> ["," <TS> "PcdsDynamicExHii <attrs>]*
+<PdhAttribs>     ::=3D <phattrs> ["," <TS> "PcdsDynamicExHii <phattrs>]*
                      <PdvEntries>*
 <PcdHiiEntries>  ::=3D {<MacroDefinition>} {<IncludeStatement>} {<TS> <Hii=
Entry>}
 <attrs>          ::=3D "." <arch> ["." <SkuIds>]
+<phattrs>        ::=3D "." <arch> ["." <SkuIds>]["." <DefaultStore>]
 <SkuIdS>         ::=3D <Keyword> [<FS> <Keyword>]*
+<DefaultStore>   ::=3D <Keyword>
 <Keyword>        ::=3D <UiName>
 <UiName>         ::=3D <Word>
 <MinEntry>       ::=3D <PcdName> [<FS> <PcdValue>] <EOL>
@@ -732,6 +772,42 @@ the `[Defines]` section. Use of the `SkuId` modifier f=
or the `[PcdsDynamic*]`  section tag can be used as a conditional modifier =
or to groups sets of PCDs  according to the `SkuId` identifier.
=20
+**_DefaultStore_**
+
+`DefaultStore` in the DSC file is used to specify=20
+DynamicHii/DynamicExHii PCD value as the default EFI variable for which=20
+default store. It is only valid in DynamicHii/DynamicExHii section. If=20
+it is not specified, DynamicHii/DynamicExHii PCD value will be used as=20
+the standard default EFI variable. For the different combination of SKU an=
d DefaultStore, their inheritance is described as the below.
+
+SKU will inherit its parent SKU setting. DEFAULT SKU is the default parent=
 SKU.
+DefaultStore is the subsection of SKU. It will first inherit from the=20
+same DefaultStore in its parent SKU, then inherit other DefaultStore in th=
e same SKU.
+DefaultStore with the big default store ID will inherit the setting=20
+from one with the small default store ID. If there are more than one=20
+small default store ID, it will use the biggest one to be inherit. Here=20
+is the example. Four PcdsDynamicExHii sections are defined.
+
+# Four PcdsDynamicExHii section
+[PcdsDynamicExHii.common.Default.Standard]
+[PcdsDynamicExHii.common.Default.Manufacturing]
+[PcdsDynamicExHii.common.Sku1.Standard]
+[PcdsDynamicExHii.common.Sku1.Manufacturing]
+
+# DEFAULT Manufacturing setting based on two sections=20
+[PcdsDynamicExHii.common.Default.Standard]
+[PcdsDynamicExHii.common.Default.Manufacturing]
+
+# SKU1 Standard setting based on two sections=20
+[PcdsDynamicExHii.common.Default.Standard]
+[PcdsDynamicExHii.common.Sku1.Standard]
+
+# SKU1 Manufacturing setting based on four sections=20
+[PcdsDynamicExHii.common.Default.Standard]
+[PcdsDynamicExHii.common.Default.Manufacturing]
+[PcdsDynamicExHii.common.Sku1.Standard]
+[PcdsDynamicExHii.common.Sku1.Manufacturing]
+
 **_PcdValues_**
=20
 PCD values are optional for `[PcdsDynamicExDefault]` sections. The PCD val=
ues @@ -761,7 +837,7 @@ the _UEFI Specification_ for a description of these=
 attributes.
   gNoSuchTokenSpaceGuid.PcdOemBootOptionPath|0x2338|100|" "              #=
 VOID*
   gNoSuchTokenSpaceGuid.PcdEnableFastBoot   |0x239C|FALSE                #=
 BOOLEAN
=20
-[PcdsDynamicExHii.IA32, PcdsDynamicExHii.X64.Sku1]
+[PcdsDynamicExHii.IA32, PcdsDynamicExHii.X64.Sku1.Standard]
   gEfiMyModulePkgTokenSpaceGuid.PcdChassisIntrution|0x0053 0x0065 0x0074 0=
x0075 0x0070|gSysConfigGuid|0x83|0x0
   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPlatformBootTimeOut|L"Timeo=
ut"|gEfiGlobalVariableGuid|0x0  # Variable: L"Timeout"
 ```
diff --git a/3_edk_ii_dsc_file_format/313_[defaultstores]_section.md b/3_ed=
k_ii_dsc_file_format/313_[defaultstores]_section.md
new file mode 100644
index 0000000..614ed01
--- /dev/null
+++ b/3_edk_ii_dsc_file_format/313_[defaultstores]_section.md
@@ -0,0 +1,60 @@
+<!--- @file
+  3.13 [DefaultStores] Section
+
+  Copyright (c) 2006-2018, Intel Corporation. All rights reserved.<BR>
+
+  Redistribution and use in source (original document form) and 'compiled'
+  forms (converted to PDF, epub, HTML and other formats) with or=20
+ without  modification, are permitted provided that the following conditio=
ns are met:
+
+  1) Redistributions of source code (original document form) must retain t=
he
+     above copyright notice, this list of conditions and the following
+     disclaimer as the first lines of this file unmodified.
+
+  2) Redistributions in compiled form (transformed to other DTDs, converte=
d to
+     PDF, epub, HTML and other formats) must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in the
+     documentation and/or other materials provided with the distribution.
+
+  THIS DOCUMENTATION IS PROVIDED BY TIANOCORE PROJECT "AS IS" AND ANY=20
+ EXPRESS OR  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE=20
+ IMPLIED WARRANTIES OF  MERCHANTABILITY AND FITNESS FOR A PARTICULAR=20
+ PURPOSE ARE DISCLAIMED. IN NO  EVENT SHALL TIANOCORE PROJECT  BE=20
+ LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,  SPECIAL, EXEMPLARY, OR=20
+ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,  PROCUREMENT OF=20
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;  OR=20
+ BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, =20
+ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE=20
+ OR
+  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION,=20
+ EVEN IF  ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+-->
+
+## 3.13 [DefaultStores] Section
+
+The `[DefaultStores]` section is optional in all EDK II DSC files.
+
+#### Summary
+
+Entries may appear in any order. This section lists numeric mappings to=20
+the Default Store User Interface Name, only valid values from this list=20
+can be specified in the PcdsDynamicHii/PcdsDynamicExHii section.
+
+If this section is not specified, the parsing tools will assume=20
+standard default be applied in PcdsDynamicHii/PcdsDynamicExHii section.
+
+#### Prototype
+
+```c
+<DefaultStore>     ::=3D "[DefaultStores]" <EOL>
+                {<Statement>*}
+<Statement> ::=3D <TS> <Number> <FS> <UiName> <EOL>
+<UiName>    ::=3D <Word>
+```
+
+#### Example
+
+```ini
+[DefaultStores]
+  0 | Standard        # UEFI Standard default
+  1 | Manufacturing   # UEFI Manufacturing default
+```
--
2.8.0.windows.1