From nobody Sat May 4 13:02:57 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: Received: from ml01.01.org (ml01.01.org [198.145.21.10]) by mx.zohomail.com with SMTPS id 1519632330593385.8367340666565; Mon, 26 Feb 2018 00:05:30 -0800 (PST) Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id 9D24222436942; Sun, 25 Feb 2018 23:59:19 -0800 (PST) Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) (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 89AEC222630A3 for ; Sun, 25 Feb 2018 23:59:17 -0800 (PST) Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by orsmga102.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 26 Feb 2018 00:05:21 -0800 Received: from shwdeopenpsi168.ccr.corp.intel.com ([10.239.158.129]) by fmsmga005.fm.intel.com with ESMTP; 26 Feb 2018 00:05:20 -0800 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=134.134.136.24; helo=mga09.intel.com; envelope-from=yonghong.zhu@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.47,396,1515484800"; d="scan'208";a="206973834" From: Yonghong Zhu To: edk2-devel@lists.01.org Date: Mon, 26 Feb 2018 16:05:16 +0800 Message-Id: <1519632316-2368-1-git-send-email-yonghong.zhu@intel.com> X-Mailer: git-send-email 2.6.1.windows.1 Subject: [edk2] [Patch V3] DSC spec: Add flexible PCD value format into spec X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Michael Kinney , Kevin W Shaw , Liming Gao MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Errors-To: edk2-devel-bounces@lists.01.org Sender: "edk2-devel" X-ZohoMail: RSF_4 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" V3: Update the Pcd value format in [Components] section V2: update EBNF for Array format. Cc: Liming Gao Cc: Michael Kinney Cc: Kevin W Shaw Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Yonghong Zhu Reviewed-by: Liming Gao --- 3_edk_ii_dsc_file_format/310_pcd_sections.md | 160 +++++++++++++----= ---- .../311_[components]_sections.md | 23 +-- .../33_platform_dsc_definition.md | 78 +++++++--- 3 files changed, 174 insertions(+), 87 deletions(-) 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 2af42cc..18a243d 100644 --- a/3_edk_ii_dsc_file_format/310_pcd_sections.md +++ b/3_edk_ii_dsc_file_format/310_pcd_sections.md @@ -98,13 +98,11 @@ is permissible to list multiple architectures in a sing= le method section as in: It is permissible to list a PCD in a common architecture section and also = list it in an architecturally modified section. In this case, the value in the architectural section overrides the value specified in the common section. =20 The PCD values must match the datum type declared for a given PCD in the D= EC -file. While a PCD of datum type `BOOLEAN` is permitted to have a `1` or a = `0` -(instead of TRUE or FALSE) in the value field, a PCD of type UINT* cannot = use -`TRUE` or `FALSE` for values. +file. =20 PCDs with a data type of `VOID`* can optionally provide the maximum size o= f the value. If not provided, the maximum length will be calculated as the large= st of the size of the data in the DSC file, the size of the data in the INF file= or the size of the data in the DEC file that declares the PCD. @@ -220,21 +218,24 @@ fields that are separated by the pipe character, "|". ::=3D [ ]* ::=3D ::=3D ::=3D {} {} {} ::=3D [ ] - ::=3D if (pcddatumtype =3D=3D "BOOLEAN"): {} {} - elif (pcddatumtype =3D=3D "UINT8"): {} - {} elif (pcddatumtype =3D=3D "UINT16"): - {} {} elif (pcddatumtype =3D= =3D - "UINT32"): {} {} elif - (pcddatumtype =3D=3D "UINT64"): {} {} + ::=3D if (pcddatumtype =3D=3D "BOOLEAN"): + {} {} + elif (pcddatumtype =3D=3D "UINT8"): + {} {} + elif (pcddatumtype =3D=3D "UINT16"): + {} {} + elif (pcddatumtype =3D=3D "UINT32"): + {} {} + elif (pcddatumtype =3D=3D "UINT64"): + {} {} else: - [] + [] ::=3D "VOID*" {} {} - ::=3D {} {} {} - {} {} + ::=3D {} {} {} ``` =20 #### Parameters =20 **_Expression_** @@ -325,21 +326,24 @@ of the DSC file. ::=3D [ ]* ::=3D ::=3D ::=3D {} {} {} ::=3D [ ] - ::=3D if (pcddatumtype =3D=3D "BOOLEAN"): {} {} - elif (pcddatumtype =3D=3D "UINT8"): {} - {} elif (pcddatumtype =3D=3D "UINT16"): - {} {} elif (pcddatumtype =3D= =3D - "UINT32"): {} {} elif - (pcddatumtype =3D=3D "UINT64"): {} {} + ::=3D if (pcddatumtype =3D=3D "BOOLEAN"): + {} {} + elif (pcddatumtype =3D=3D "UINT8"): + {} {} + elif (pcddatumtype =3D=3D "UINT16"): + {} {} + elif (pcddatumtype =3D=3D "UINT32"): + {} {} + elif (pcddatumtype =3D=3D "UINT64"): + {} {} else: - [] + [] ::=3D {} {} - ::=3D {} {} {} - {} {} + ::=3D {} {} {} ``` =20 #### Parameters =20 **_Expression_** @@ -458,41 +462,58 @@ sections of the DSC file. ::=3D "." ["." ] ::=3D [ ]* ::=3D ::=3D ::=3D [ ] - ::=3D if (pcddatumtype =3D=3D "BOOLEAN"): {} {} - elif (pcddatumtype =3D=3D "UINT8"): {} - {} elif (pcddatumtype =3D=3D "UINT16"): - {} {} elif (pcddatumtype = =3D=3D - "UINT32"): {} {} elif - (pcddatumtype =3D=3D "UINT64"): {} - {} else: - [] + ::=3D if (pcddatumtype =3D=3D "BOOLEAN"): + {} {} + elif (pcddatumtype =3D=3D "UINT8"): + {} {} + elif (pcddatumtype =3D=3D "UINT16"): + {} {} + elif (pcddatumtype =3D=3D "UINT32"): + {} {} + elif (pcddatumtype =3D=3D "UINT64"): + {} {} + else: + [] ::=3D "VOID*" [ ] ::=3D {} {} - ::=3D {} {} {} {} - {} + ::=3D {} {} {} ::=3D [ ] ::=3D {} {"*"} - ::=3D if (pcddatumtype =3D=3D "BOOLEAN"): {} {} - elif (pcddatumtype =3D=3D "UINT8"): {} - {} elif (pcddatumtype =3D=3D "UINT16"): - {} {} elif (pcddatumtype = =3D=3D - "UINT32"): {} {} elif - (pcddatumtype =3D=3D "UINT64"): {} - {} else: - + ::=3D if (pcddatumtype =3D=3D "BOOLEAN"): + {} {} + elif (pcddatumtype =3D=3D "UINT8"): + {} {} + elif (pcddatumtype =3D=3D "UINT16"): + {} {} + elif (pcddatumtype =3D=3D "UINT32"): + {} {} + elif(pcddatumtype =3D=3D "UINT64"): + {} {} + else: + ::=3D [ ] ::=3D ::=3D {} {} ::=3D [] ::=3D ::=3D [ ] ::=3D - ::=3D {} {} {} {} - {} {} + ::=3D if (pcddatumtype =3D=3D "BOOLEAN"): + {} {} + elif (pcddatumtype =3D=3D "UINT8"): + {} {} + elif (pcddatumtype =3D=3D "UINT16"): + {} {} + elif (pcddatumtype =3D=3D "UINT32"): + {} {} + elif (pcddatumtype =3D=3D "UINT64"): + {} {} + else: + ::=3D [ ]* ::=3D {"NV"} {"BS"} {"RT"} {"RO"} ``` =20 #### Parameters @@ -618,41 +639,58 @@ sections of the DSC file. ::=3D "." ["." ] ::=3D [ ]* ::=3D ::=3D ::=3D [ ] - ::=3D if (pcddatumtype =3D=3D "BOOLEAN"): {} {} - elif (pcddatumtype =3D=3D "UINT8"): {} - {} elif (pcddatumtype =3D=3D "UINT16"): - {} {} elif (pcddatumtype = =3D=3D - "UINT32"): {} {} elif - (pcddatumtype =3D=3D "UINT64"): {} - {} else: - [] + ::=3D if (pcddatumtype =3D=3D "BOOLEAN"): + {} {} + elif (pcddatumtype =3D=3D "UINT8"): + {} {} + elif (pcddatumtype =3D=3D "UINT16"): + {} {} + elif (pcddatumtype =3D=3D "UINT32"): + {} {} + elif (pcddatumtype =3D=3D "UINT64"): + {} {} + else: + [] ::=3D "VOID*" [ ] ::=3D {} {} - ::=3D {} {} {} {} - {} + ::=3D {} {} {} ::=3D [ ] ::=3D {} {"*"} - ::=3D if (pcddatumtype =3D=3D "BOOLEAN"): {} {} - elif (pcddatumtype =3D=3D "UINT8"): {} - {} elif (pcddatumtype =3D=3D "UINT16"): - {} {} elif (pcddatumtype = =3D=3D - "UINT32"): {} {} elif - (pcddatumtype =3D=3D "UINT64"): {} - {} else: - + ::=3D if (pcddatumtype =3D=3D "BOOLEAN"): + {} {} + elif (pcddatumtype =3D=3D "UINT8"): + {} {} + elif (pcddatumtype =3D=3D "UINT16"): + {} {} + elif (pcddatumtype =3D=3D "UINT32"): + {} {} + elif (pcddatumtype =3D=3D "UINT64"): + {} {} + else: + ::=3D [ ] ::=3D ::=3D {} {} ::=3D [] ::=3D ::=3D [ ] ::=3D - ::=3D {} {} {} {} - {} {} + ::=3D if (pcddatumtype =3D=3D "BOOLEAN"): + {} {} + elif (pcddatumtype =3D=3D "UINT8"): + {} {} + elif (pcddatumtype =3D=3D "UINT16"): + {} {} + elif (pcddatumtype =3D=3D "UINT32"): + {} {} + elif(pcddatumtype =3D=3D "UINT64"): + {} {} + else: + ::=3D [ ]* ::=3D {"NV"} {"BS"} {"RT"} {"RO"} ``` =20 #### Parameters diff --git a/3_edk_ii_dsc_file_format/311_[components]_sections.md b/3_edk_= ii_dsc_file_format/311_[components]_sections.md index 119d17b..5a3594a 100644 --- a/3_edk_ii_dsc_file_format/311_[components]_sections.md +++ b/3_edk_ii_dsc_file_format/311_[components]_sections.md @@ -165,22 +165,25 @@ modules in a binary image (the FDF file describes tha= t ordering). ::=3D {} {} { } ::=3D "" * ::=3D [ ] - ::=3D if (pcddatumtype =3D=3D "BOOLEAN"): {} - {} elif (pcddatumtype =3D=3D "UINT8"): - {} {} elif (pcddatumtype = =3D=3D - "UINT16"): {} {} elif - (pcddatumtype =3D=3D "UINT32"): {} - {} elif (pcddatumtype =3D=3D "UINT64"): - {} {} else: - [] + ::=3D if (pcddatumtype =3D=3D "BOOLEAN"): + {} {} + elif (pcddatumtype =3D=3D "UINT8"): + {} {} + elif (pcddatumtype =3D=3D "UINT16"):=20 + {} {} + elif (pcddatumtype =3D=3D "UINT32"): + {} {} + elif (pcddatumtype =3D=3D "UINT64"): + {} {} + else: + [] ::=3D "VOID*" [ ] ::=3D {} {} - ::=3D {} {} {} - {} + ::=3D {} {} {} ::=3D "" []* [ ]+ [ ]* [ ]* diff --git a/3_edk_ii_dsc_file_format/33_platform_dsc_definition.md b/3_edk= _ii_dsc_file_format/33_platform_dsc_definition.md index bfe730c..bbe6b10 100644 --- a/3_edk_ii_dsc_file_format/33_platform_dsc_definition.md +++ b/3_edk_ii_dsc_file_format/33_platform_dsc_definition.md @@ -112,15 +112,16 @@ The following are common definitions used by multiple= section types. ::=3D (0-9) ::=3D (a-zA-Z_) ::=3D [ ]* ::=3D # A valid C variable name. ::=3D (0x21 - 0x7E) - ::=3D [{0x21} {(0x23 - 0x5B)} {(0x5D - 0x7E)} - {}]* + ::=3D [{0x21} {(0x23 - 0x26)} {(0x28 - 0x5B)} + {(0x5D - 0x7E)} {}]* ::=3D 0x22 + ::=3D 0x27 ::=3D "\" {"n"} {"t"} {"f"} {"r"} {"b"} {"0"} {"\"} - {} + {} {} ::=3D {} {} ::=3D * ::=3D + ::=3D 0x09 ::=3D 0x20 @@ -138,15 +139,16 @@ The following are common definitions used by multiple= section types. ::=3D [ * * ]* ::=3D ::=3D ::=3D {} {} ::=3D * - ::=3D ["L"] + ::=3D * + ::=3D {} {} ::=3D [{} {}]+ ::=3D "#" [] + ::=3D "#" + - ::=3D "L" + ::=3D "L" {} {} ::=3D (a-fA-F0-9) ::=3D {"0x"} {"0X"} [] ::=3D {"0x"} {"0X"} + ::=3D "0x" [0]* ::=3D ? ? ? @@ -184,11 +186,12 @@ The following are common definitions used by multiple= section types. ::=3D (\x1 - \xFFFFFFFFFFFFFFFF) ::=3D (1-18446744073709551615) ::=3D {} {} ::=3D {"TRUE"} {"true"} {"True"} {"0x1"} {"0x01"} {= "1"} ::=3D {"FALSE"} {"false"} {"False"} {"0x0"} {"0x00"= } {"0"} - ::=3D {} {} + ::=3D {} {} + ::=3D {} {"{""}"} ::=3D (A-Z)(A-Z0-9_)* ::=3D "$(" ")" ::=3D "." ::=3D ::=3D @@ -210,14 +213,49 @@ The following are common definitions used by multiple= section types. ::=3D (0-255) ::=3D (0-65535) ::=3D (0-4294967295) ::=3D (0-18446744073709551615) - ::=3D {} {} - ::=3D {} {} - ::=3D {} {} - ::=3D {} {} + ::=3D {} {} {} + {} {} + ::=3D {} {} {} + {} {} + ::=3D {} {} {} + {} {} + ::=3D {} {} {} + {} {} + ::=3D {} {"{""}"} + ::=3D {} + {"{" [ ]*"}"} + ::=3D {} + {"{" [ ]*"}"} + ::=3D {} + {"{" [ ]*"}"} + ::=3D {} {} {} + ::=3D "{" {} {[] + [ [] ]* } "}" + ::=3D {} {} {} + ::=3D {} {} {} + {} {} + ::=3D "GUID(" ")" + ::=3D { } + {} {} + ::=3D "DEVICE_PATH(" ")" + ::=3D A double quoted string that follow the device= path + as string format defined in UEFI Specification = 2.6 + Section 9.6 + ::=3D {} {} {} + ::=3D {} {} {} + ::=3D {} {} {} + ::=3D {} {} {} + ::=3D {} {} {} {} + ::=3D "UINT8(" ")" + ::=3D "UINT16(" ")" + ::=3D "UINT32(" ")" + ::=3D "UINT64(" ")" + ::=3D "LABEL(" ")" + ::=3D "OFFSET_OF(" ")" ::=3D {"BASE"} {"SEC"} {"PEI_CORE"} {"PEIM"} {"DXE_CORE"} {"DXE_DRIVER"} {"SMM_CORE"} {"DXE_RUNTIME_DRIVER"} {"DXE_SAL_DRIVER"} {"DXE_SMM_DRIVER"} {"UEFI_DRIVER"} {"UEFI_APPLICATION"} {"USER_DEFINED"} @@ -244,10 +282,18 @@ The following are common definitions used by multiple= section types. {"SMM_CORE"} {"DXE_SMM_DRIVER"} {"UEFI_DRIVER"} {"UEFI_APPLICATION"} ``` =20 ********** +**Note:** When using CString, UnicodeString or byte array format as +UINT8/UINT16/UINT32/UINT64 values, please make sure they fit in the +target type's size, otherwise tool would report failure. +********** +**Note:** LABEL() macro in byte arrays to tag the byte offset of a +location in a byte array. OFFSET_OF() macro in byte arrays that returns +the byte offset of a LABEL() declared in a byte array. +********** **Note:** When using the characters "|" or "||" in an expression, the expression must be encapsulated in open "(" and close ")" parenthesis. ********** **Note:** Comments may appear anywhere within a DSC file, provided they fo= llow the rules that a comment may not be enclosed within Section headers, and t= hat @@ -265,16 +311,16 @@ chain tag names that are being built. Refer to the ED= K II Expression Syntax Specification for additional information. =20 **_UnicodeString_** =20 When the `` element (these characters are string literals as -defined by the C99 specification: L"string", not actual Unicode characters= ) is -included in a value, the build tools may be required to expand the ASCII s= tring -between the quotation marks into a valid UCS-2 character string. The build -tools parser must treat all content between the field separators (excluding -white space characters around the field separators) as ASCII literal conte= nt -when generating the AutoGen.c and AutoGen.h files. +defined by the C99 specification: L"string"/L'string', not actual Unicode +characters) is included in a value, the build tools may be required to exp= and +the ASCII string between the quotation marks into a valid UCS-2 character = string. +The build tools parser must treat all content between the field separators +(excluding white space characters around the field separators) as ASCII li= teral +content when generating the AutoGen.c and AutoGen.h files. =20 **_Comments_** =20 Strings that appear in comments may be ignored by the build tools. An ASCII string matching the format of the ASCII string defined by `` --=20 2.6.1.windows.1 _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel