From nobody Mon Dec 23 04:15:42 2024
Delivered-To: importer@patchew.org
Authentication-Results: mx.zohomail.com;
	spf=none (zoho.com: 198.145.21.10 is neither permitted nor denied by domain
 of lists.01.org)  smtp.mailfrom=edk2-devel-bounces@lists.01.org
Return-Path: <edk2-devel-bounces@lists.01.org>
Received: from ml01.01.org (ml01.01.org [198.145.21.10]) by mx.zohomail.com
	with SMTPS id 152117534094912.267906730881009;
 Thu, 15 Mar 2018 21:42:20 -0700 (PDT)
Received: from [127.0.0.1] (localhost [IPv6:::1])
	by ml01.01.org (Postfix) with ESMTP id 10A502264D230;
	Thu, 15 Mar 2018 21:35:53 -0700 (PDT)
Received: from mga05.intel.com (mga05.intel.com [192.55.52.43])
 (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 314A1226462FC
 for <edk2-devel@lists.01.org>; Thu, 15 Mar 2018 21:35:49 -0700 (PDT)
Received: from fmsmga006.fm.intel.com ([10.253.24.20])
 by fmsmga105.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
 15 Mar 2018 21:42:14 -0700
Received: from shwde7172.ccr.corp.intel.com ([10.239.9.15])
 by fmsmga006.fm.intel.com with ESMTP; 15 Mar 2018 21:42:13 -0700
X-Original-To: edk2-devel@lists.01.org
Received-SPF: none (zoho.com: 198.145.21.10 is neither permitted nor denied by
 domain of lists.01.org) client-ip=198.145.21.10;
 envelope-from=edk2-devel-bounces@lists.01.org; helo=ml01.01.org;
Received-SPF: Pass (sender SPF authorized) identity=mailfrom;
 client-ip=192.55.52.43; helo=mga05.intel.com;
 envelope-from=liming.gao@intel.com; receiver=edk2-devel@lists.01.org
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.48,313,1517904000"; d="scan'208";a="211830229"
From: Liming Gao <liming.gao@intel.com>
To: edk2-devel@lists.01.org
Date: Fri, 16 Mar 2018 12:41:53 +0800
Message-Id: <1521175314-6672-3-git-send-email-liming.gao@intel.com>
X-Mailer: git-send-email 2.8.0.windows.1
In-Reply-To: <1521175314-6672-1-git-send-email-liming.gao@intel.com>
References: <1521175314-6672-1-git-send-email-liming.gao@intel.com>
Subject: [edk2] [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>
Cc: Michael Kinney <michael.d.kinney@intel.com>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Errors-To: edk2-devel-bounces@lists.01.org
Sender: "edk2-devel" <edk2-devel-bounces@lists.01.org>
X-ZohoMail: RSF_4  Z_629925259 SPT_0
Content-Type: text/plain; charset="utf-8"

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>
Reviewed-by: Yonghong Zhu <yonghong.zhu@intel.com>=20
---
 .../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_dsc_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 without
+  modification, are permitted provided that the following conditions are m=
et:
+
+  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 EXPR=
ESS OR
+  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIE=
S OF
+  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN =
NO
+  EVENT SHALL TIANOCORE PROJECT  BE LIABLE FOR ANY DIRECT, INDIRECT, INCID=
ENTAL,
+  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED=
 TO,
+  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFI=
TS;
+  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 DOCUMENTATION, 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. Defau=
lt=20
+store is UEFI HII concept. It is used to define HII default setting for th=
e=20
+different store, such as standard default, manufacturing default. Platform=20
+can define the supported default store for DynamicHii/DynamicExHii PCD in =
this=20
+section, tag name to be used. This section is optional. By default, standa=
rd=20
+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 DynamicHii/DynamicExHii =
PCD=20
+value as the default EFI variable for which default store. It is only vali=
d in=20
+DynamicHii/DynamicExHii section. If it is not specified, DynamicHii/Dynami=
cExHii=20
+PCD value will be used as the standard default EFI variable. For the diffe=
rent=20
+combination of SKU and 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 same=20
+DefaultStore in its parent SKU, then inherit other DefaultStore in the sam=
e SKU.=20
+DefaultStore with the big default store ID will inherit the setting from o=
ne with=20
+the small default store ID. If there are more than one small default store=
 ID,=20
+it will use the biggest one to be inherit. Here is the example. Four PcdsD=
ynamicHii
+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
+[PcdsDynamicHii.common.Default.Standard]
+[PcdsDynamicHii.common.Default.Manufacturing]
+
+# SKU1 Standard setting based on two sections
+[PcdsDynamicHii.common.Default.Standard]
+[PcdsDynamicHii.common.Sku1.Standard]
+
+# SKU1 Manufacturing setting based on four sections
+[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 these att=
ributes.
   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 DynamicHii/DynamicExHii =
PCD=20
+value as the default EFI variable for which default store. It is only vali=
d in=20
+DynamicHii/DynamicExHii section. If it is not specified, DynamicHii/Dynami=
cExHii=20
+PCD value will be used as the standard default EFI variable. For the diffe=
rent=20
+combination of SKU and 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 same=20
+DefaultStore in its parent SKU, then inherit other DefaultStore in the sam=
e SKU.=20
+DefaultStore with the big default store ID will inherit the setting from o=
ne with=20
+the small default store ID. If there are more than one small default store=
 ID,=20
+it will use the biggest one to be inherit. Here is the example. Four PcdsD=
ynamicExHii
+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
+[PcdsDynamicExHii.common.Default.Standard]
+[PcdsDynamicExHii.common.Default.Manufacturing]
+
+# SKU1 Standard setting based on two sections
+[PcdsDynamicExHii.common.Default.Standard]
+[PcdsDynamicExHii.common.Sku1.Standard]
+
+# SKU1 Manufacturing setting based on four sections
+[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 att=
ributes.
   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 without
+  modification, are permitted provided that the following conditions are m=
et:
+
+  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 EXPR=
ESS OR
+  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIE=
S OF
+  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN =
NO
+  EVENT SHALL TIANOCORE PROJECT  BE LIABLE FOR ANY DIRECT, INDIRECT, INCID=
ENTAL,
+  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED=
 TO,
+  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFI=
TS;
+  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 DOCUMENTATION, 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 th=
e=20
+Default Store User Interface Name, only valid values from this list can be=20
+specified in the PcdsDynamicHii/PcdsDynamicExHii section.
+
+If this section is not specified, the parsing tools will assume standard d=
efault
+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
+```
--=20
2.8.0.windows.1

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel