[edk2] [Patch] DSC Spec: limit the VOID* PCD max size to UINT16

Yonghong Zhu posted 1 patch 5 years, 6 months ago
Failed in applying to current master (apply log)
2_dsc_overview/29_pcd_sections.md            | 6 +++---
3_edk_ii_dsc_file_format/310_pcd_sections.md | 8 ++++----
2 files changed, 7 insertions(+), 7 deletions(-)
[edk2] [Patch] DSC Spec: limit the VOID* PCD max size to UINT16
Posted by Yonghong Zhu 5 years, 6 months ago
current the max size of VOID* PCD in the spec is a number that doesn't
no limitation, now this patch update to limit the max size to UINT16,
besides, also update some typo to make sure the format in chapter 2
and chapter 3 are align.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Michael Kinney <michael.d.kinney@intel.com>
Cc: Kevin W Shaw <kevin.w.shaw@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Yonghong Zhu <yonghong.zhu@intel.com>
---
 2_dsc_overview/29_pcd_sections.md            | 6 +++---
 3_edk_ii_dsc_file_format/310_pcd_sections.md | 8 ++++----
 2 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/2_dsc_overview/29_pcd_sections.md b/2_dsc_overview/29_pcd_sections.md
index 6547656..b33026c 100644
--- a/2_dsc_overview/29_pcd_sections.md
+++ b/2_dsc_overview/29_pcd_sections.md
@@ -1,9 +1,9 @@
 <!--- @file
   2.9 PCD Sections
 
-  Copyright (c) 2006-2017, Intel Corporation. All rights reserved.<BR>
+  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 met:
 
@@ -112,11 +112,11 @@ The following are typical examples of the `[PcdsFixedAtBuild]` section tag (the
 [PcdsFixedAtBuild.$(arch).$(SkuIdentifier)]
 ```
 
 Format of a point (VOID*) entry in this section is:
 
-`PcdTokenSpaceGuidCName.PcdCName|Value[|DatumType|MaximumDatumSize]]`
+`PcdTokenSpaceGuidCName.PcdCName|Value[|DatumType|MaximumDatumSize]`
 
 Format for Boolean and numeric entries in this section is:
 
 `PcdTokenSpaceGuidCName.PcdCName|Value`
 
@@ -157,11 +157,11 @@ The following are typical examples of the `[PcdsPatchableInModule]` section tag
 [PcdsPatchableInModule.$(arch).$(SkuIdentifier)]
 ```
 
 Format of an entry in this section is:
 
-`PcdTokenSpaceGuidCName.PcdCName|Value[|DatumType[|MaximumDatumSize]]`
+`PcdTokenSpaceGuidCName.PcdCName|Value[|DatumType|MaximumDatumSize]`
 
 #### Example
 
 ```ini
 [PcdsPatchableInModule.common]
diff --git a/3_edk_ii_dsc_file_format/310_pcd_sections.md b/3_edk_ii_dsc_file_format/310_pcd_sections.md
index 607c479..1879923 100644
--- a/3_edk_ii_dsc_file_format/310_pcd_sections.md
+++ b/3_edk_ii_dsc_file_format/310_pcd_sections.md
@@ -233,11 +233,11 @@ fields that are separated by the pipe character, "|".
                       {<NumValUint32>} {<Expression>}
                     elif (pcddatumtype == "UINT64"):
                       {<NumValUint64>} {<Expression>}
                     else:
                       <StringValue> [<MaxSize>]
-<MaxSize>       ::= <FS> "VOID*" <FS> {<Number>} {<Expression>}
+<MaxSize>       ::= <FS> "VOID*" <FS> {<IntNum>} {<UINT16>}
 <StringValue>   ::= {<StringVal>} {<MACROVAL>} {<Expression>}
 ```
 
 #### Parameters
 
@@ -341,11 +341,11 @@ of the DSC file.
                       {<NumValUint32>} {<Expression>}
                     elif (pcddatumtype == "UINT64"):
                       {<NumValUint64>} {<Expression>}
                     else:
                       <StringValue> [<MaxSize>]
-<MaxSize>       ::= <FS> {<Number>} {<Expression>}
+<MaxSize>       ::= <FS> "VOID*" <FS> {<IntNum>} {<UINT16>}
 <StringValue>   ::= {<StringVal>} {<MACROVAL>} {<Expression>}
 ```
 
 #### Parameters
 
@@ -480,11 +480,11 @@ sections of the DSC file.
                      elif (pcddatumtype == "UINT64"):
                        {<NumValUint64>} {<Expression>}
                      else:
                        <StringValue> [<MaxSize>]
 <MaxSize>        ::= <FS> "VOID*" [<FS> <SizeValue>]
-<SizeValue>      ::= {<Number>} {<Expression>}
+<SizeValue>      ::= {<IntNum>} {<UINT16>}
 <StringValue>    ::= {<StringVal>} {<MACROVAL>} {<Expression>}
 <VpdEntry>       ::= <PcdName> <FS> <VpdOffset> [<FS> <VpdData>] <EOL>
 <VpdOffset>      ::= {<Number>} {"*"}
 <VpdData>        ::= if (pcddatumtype == "BOOLEAN"):
                        {<BoolType>} {<Expression>}
@@ -496,11 +496,11 @@ sections of the DSC file.
                        {<NumValUint32>} {<Expression>}
                      elif(pcddatumtype == "UINT64"):
                        {<NumValUint64>} {<Expression>}
                      else:
                        <VpdMaxSize>
-<VpdMaxSize>     ::= {<LongNum>} {<UINT32>} [<FS> <StringValue>]
+<VpdMaxSize>     ::= {<IntNum>} {<UINT16>} [<FS> <StringValue>]
 <HiiEntry>       ::= <PcdName> <FS> <HiiString> <Field2> <EOL>
 <HiiString>      ::= {<CArray>} {<UnicodeString>}
 <Field2>         ::= <FS> <VariableGuid> <FS> <VariableOffset> [<ValueField>]
 <VariableGuid>   ::= <CName>
 <ValueField>     ::= <FS> <DefaultValue> [<FS> <HiiAttrs>]
-- 
2.6.1.windows.1

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Re: [edk2] [Patch] DSC Spec: limit the VOID* PCD max size to UINT16
Posted by Gao, Liming 5 years, 6 months ago
Reviewed-by: Liming Gao <liming.gao@intel.com>

>-----Original Message-----
>From: Zhu, Yonghong
>Sent: Friday, August 03, 2018 2:12 PM
>To: edk2-devel@lists.01.org
>Cc: Gao, Liming <liming.gao@intel.com>; Kinney, Michael D
><michael.d.kinney@intel.com>; Shaw, Kevin W <kevin.w.shaw@intel.com>
>Subject: [Patch] DSC Spec: limit the VOID* PCD max size to UINT16
>
>current the max size of VOID* PCD in the spec is a number that doesn't
>no limitation, now this patch update to limit the max size to UINT16,
>besides, also update some typo to make sure the format in chapter 2
>and chapter 3 are align.
>
>Cc: Liming Gao <liming.gao@intel.com>
>Cc: Michael Kinney <michael.d.kinney@intel.com>
>Cc: Kevin W Shaw <kevin.w.shaw@intel.com>
>Contributed-under: TianoCore Contribution Agreement 1.1
>Signed-off-by: Yonghong Zhu <yonghong.zhu@intel.com>
>---
> 2_dsc_overview/29_pcd_sections.md            | 6 +++---
> 3_edk_ii_dsc_file_format/310_pcd_sections.md | 8 ++++----
> 2 files changed, 7 insertions(+), 7 deletions(-)
>
>diff --git a/2_dsc_overview/29_pcd_sections.md
>b/2_dsc_overview/29_pcd_sections.md
>index 6547656..b33026c 100644
>--- a/2_dsc_overview/29_pcd_sections.md
>+++ b/2_dsc_overview/29_pcd_sections.md
>@@ -1,9 +1,9 @@
> <!--- @file
>   2.9 PCD Sections
>
>-  Copyright (c) 2006-2017, Intel Corporation. All rights reserved.<BR>
>+  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 met:
>
>@@ -112,11 +112,11 @@ The following are typical examples of the
>`[PcdsFixedAtBuild]` section tag (the
> [PcdsFixedAtBuild.$(arch).$(SkuIdentifier)]
> ```
>
> Format of a point (VOID*) entry in this section is:
>
>-
>`PcdTokenSpaceGuidCName.PcdCName|Value[|DatumType|MaximumDatu
>mSize]]`
>+`PcdTokenSpaceGuidCName.PcdCName|Value[|DatumType|MaximumDatu
>mSize]`
>
> Format for Boolean and numeric entries in this section is:
>
> `PcdTokenSpaceGuidCName.PcdCName|Value`
>
>@@ -157,11 +157,11 @@ The following are typical examples of the
>`[PcdsPatchableInModule]` section tag
> [PcdsPatchableInModule.$(arch).$(SkuIdentifier)]
> ```
>
> Format of an entry in this section is:
>
>-
>`PcdTokenSpaceGuidCName.PcdCName|Value[|DatumType[|MaximumDatu
>mSize]]`
>+`PcdTokenSpaceGuidCName.PcdCName|Value[|DatumType|MaximumDatu
>mSize]`
>
> #### Example
>
> ```ini
> [PcdsPatchableInModule.common]
>diff --git a/3_edk_ii_dsc_file_format/310_pcd_sections.md
>b/3_edk_ii_dsc_file_format/310_pcd_sections.md
>index 607c479..1879923 100644
>--- a/3_edk_ii_dsc_file_format/310_pcd_sections.md
>+++ b/3_edk_ii_dsc_file_format/310_pcd_sections.md
>@@ -233,11 +233,11 @@ fields that are separated by the pipe character, "|".
>                       {<NumValUint32>} {<Expression>}
>                     elif (pcddatumtype == "UINT64"):
>                       {<NumValUint64>} {<Expression>}
>                     else:
>                       <StringValue> [<MaxSize>]
>-<MaxSize>       ::= <FS> "VOID*" <FS> {<Number>} {<Expression>}
>+<MaxSize>       ::= <FS> "VOID*" <FS> {<IntNum>} {<UINT16>}
> <StringValue>   ::= {<StringVal>} {<MACROVAL>} {<Expression>}
> ```
>
> #### Parameters
>
>@@ -341,11 +341,11 @@ of the DSC file.
>                       {<NumValUint32>} {<Expression>}
>                     elif (pcddatumtype == "UINT64"):
>                       {<NumValUint64>} {<Expression>}
>                     else:
>                       <StringValue> [<MaxSize>]
>-<MaxSize>       ::= <FS> {<Number>} {<Expression>}
>+<MaxSize>       ::= <FS> "VOID*" <FS> {<IntNum>} {<UINT16>}
> <StringValue>   ::= {<StringVal>} {<MACROVAL>} {<Expression>}
> ```
>
> #### Parameters
>
>@@ -480,11 +480,11 @@ sections of the DSC file.
>                      elif (pcddatumtype == "UINT64"):
>                        {<NumValUint64>} {<Expression>}
>                      else:
>                        <StringValue> [<MaxSize>]
> <MaxSize>        ::= <FS> "VOID*" [<FS> <SizeValue>]
>-<SizeValue>      ::= {<Number>} {<Expression>}
>+<SizeValue>      ::= {<IntNum>} {<UINT16>}
> <StringValue>    ::= {<StringVal>} {<MACROVAL>} {<Expression>}
> <VpdEntry>       ::= <PcdName> <FS> <VpdOffset> [<FS> <VpdData>] <EOL>
> <VpdOffset>      ::= {<Number>} {"*"}
> <VpdData>        ::= if (pcddatumtype == "BOOLEAN"):
>                        {<BoolType>} {<Expression>}
>@@ -496,11 +496,11 @@ sections of the DSC file.
>                        {<NumValUint32>} {<Expression>}
>                      elif(pcddatumtype == "UINT64"):
>                        {<NumValUint64>} {<Expression>}
>                      else:
>                        <VpdMaxSize>
>-<VpdMaxSize>     ::= {<LongNum>} {<UINT32>} [<FS> <StringValue>]
>+<VpdMaxSize>     ::= {<IntNum>} {<UINT16>} [<FS> <StringValue>]
> <HiiEntry>       ::= <PcdName> <FS> <HiiString> <Field2> <EOL>
> <HiiString>      ::= {<CArray>} {<UnicodeString>}
> <Field2>         ::= <FS> <VariableGuid> <FS> <VariableOffset> [<ValueField>]
> <VariableGuid>   ::= <CName>
> <ValueField>     ::= <FS> <DefaultValue> [<FS> <HiiAttrs>]
>--
>2.6.1.windows.1

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