From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=134.134.136.126; helo=mga18.intel.com; envelope-from=yonghong.zhu@intel.com; receiver=edk2-devel@lists.01.org Received: from mga18.intel.com (mga18.intel.com [134.134.136.126]) (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 E7BAD21F0DA6F for ; Wed, 7 Feb 2018 04:30:21 -0800 (PST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga004.fm.intel.com ([10.253.24.48]) by orsmga106.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 07 Feb 2018 04:36:05 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.46,473,1511856000"; d="scan'208";a="28111872" Received: from shwdeopenpsi168.ccr.corp.intel.com ([10.239.158.129]) by fmsmga004.fm.intel.com with ESMTP; 07 Feb 2018 04:36:04 -0800 From: Yonghong Zhu To: edk2-devel@lists.01.org Cc: Liming Gao , Michael Kinney , Kevin W Shaw Date: Wed, 7 Feb 2018 20:35:56 +0800 Message-Id: <1518006956-2284-5-git-send-email-yonghong.zhu@intel.com> X-Mailer: git-send-email 2.6.1.windows.1 In-Reply-To: <1518006956-2284-1-git-send-email-yonghong.zhu@intel.com> References: <1518006956-2284-1-git-send-email-yonghong.zhu@intel.com> Subject: [Patch V2] INF 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: , X-List-Received-Date: Wed, 07 Feb 2018 12:30:22 -0000 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 --- .../32_component_inf_definition.md | 75 +++++++++++++++++----- 3_edk_ii_inf_file_format/38_pcd_sections.md | 39 ++++++----- 2 files changed, 83 insertions(+), 31 deletions(-) diff --git a/3_edk_ii_inf_file_format/32_component_inf_definition.md b/3_edk_ii_inf_file_format/32_component_inf_definition.md index 72bcf2c..ef70927 100644 --- a/3_edk_ii_inf_file_format/32_component_inf_definition.md +++ b/3_edk_ii_inf_file_format/32_component_inf_definition.md @@ -111,15 +111,16 @@ The following are common definitions used by multiple section types. ::= (0-9) ::= (a-zA-Z_) ::= * ::= # A valid C variable name. ::= (0x21 - 0x7E) - ::= [{0x21} {(0x23 - 0x5B)} {(0x5D - 0x7E)} - {}]* + ::= [{0x21} {(0x23 - 0x26)} {(0x28 - 0x5B)} + {(0x5D - 0x7E)} {}]* ::= 0x22 + ::= 0x27 ::= "\" {"n"} {"t"} {"f"} {"r"} {"b"} {"0"} {"\"} - {} + {} {} ::= {} {} ::= * ::= + ::= 0x09 ::= 0x20 @@ -137,15 +138,16 @@ The following are common definitions used by multiple section types. ::= [ * * ]* ::= ::= ::= {} {} ::= * - ::= ["L"] + ::= * + ::= {} {} ::= [{} {}]+ ::= "#" [] + ::= "#" + - ::= "L" + ::= "L" {} {} ::= (a-fA-F0-9) ::= {"0x"} {"0X"} ::= {"0x"} {"0X"} * ::= "0x" ::= ? ? ? @@ -181,14 +183,14 @@ The following are common definitions used by multiple section types. ::= {} {} ::= (\x1 - \xFFFFFFFFFFFFFFFF) ::= (1-18446744073709551615) ::= {} {} ::= {"TRUE"} {"true"} {"True"} {"0x1"} {"0x01"} {"1"} - {} ::= {"FALSE"} {"false"} {"False"} {"0x0"} {"0x00"} {"0"} - ::= {} {} + ::= {} {} + ::= {} {"{""}"} ::= (A-Z)(A-Z0-9_)* ::= "$(" ")" ::= "." ::= ::= @@ -209,14 +211,49 @@ The following are common definitions used by multiple section types. ::= (0-255) ::= (0-65535) ::= (0-4294967295) ::= (0-18446744073709551615) - ::= {} {} - ::= {} {} - ::= {} {} - ::= {} {} + ::= {} {} {} + {} {} + ::= {} {} {} + {} {} + ::= {} {} {} + {} {} + ::= {} {} {} + {} {} + ::= {} {"{""}"} + ::= {} + {"{" [ ]*"}"} + ::= {} + {"{" [ ]*"}"} + ::= {} + {"{" [ ]*"}"} + ::= {} {} {} + ::= "{" {} {[] + [ [] ]* } "}" + ::= {} {} {} + ::= {} {} {} + {} {} + ::= {} {} {} + ::= {} {} {} + ::= {} {} {} + ::= {} {} {} + ::= "GUID(" ")" + ::= { } + {} {} + ::= "DEVICE_PATH(" ")" + ::= A double quoted string that follow the device path + as string format defined in UEFI Specification 2.6 + Section 9.6 + ::= {} {} {} {} + ::= "UINT8(" ")" + ::= "UINT16(" ")" + ::= "UINT32(" ")" + ::= "UINT64(" ")" + ::= "LABEL(" ")" + ::= "OFFSET_OF(" ")" ::= {"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"} @@ -233,10 +270,18 @@ The following are common definitions used by multiple section types. {"SMM_CORE"} {"DXE_SMM_DRIVER"} {"UEFI_DRIVER"} {"UEFI_APPLICATION"} ``` ********** +**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 INF file, provided they follow the rules that a comment may not be enclosed within Section headers, and that @@ -252,14 +297,14 @@ in line comments must appear at the end of a statement. Expression syntax is defined the _EDK II Expression Syntax Specification_. **_Unicode String_** 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 string -between the quotation marks into a valid UCS-2 character encoded string. The -build tools parser must treat all content between the field separators +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 expand +the ASCII string between the quotation marks into a valid UCS-2 character encoded +string. The build tools parser must treat all content between the field separators (excluding white space characters around the field separators) as ASCII literal content when generating the `AutoGen.c` and `AutoGen.h` files. **_Comments_** diff --git a/3_edk_ii_inf_file_format/38_pcd_sections.md b/3_edk_ii_inf_file_format/38_pcd_sections.md index cef87a8..82636d5 100644 --- a/3_edk_ii_inf_file_format/38_pcd_sections.md +++ b/3_edk_ii_inf_file_format/38_pcd_sections.md @@ -124,34 +124,41 @@ content. ::= ::= ::= [] ::= - ::= + ::= {} {} ::= "{" "}" ::= if (pcddatumtype == "BOOLEAN"): - {"0x00"} {"0x01"} elif (pcddatumtype == "UINT8"): - elif (pcddatumtype == "UINT16"): - elif (pcddatumtype == "UINT32"): + {"0x00"} {"0x01"} + elif (pcddatumtype == "UINT8"): + + elif (pcddatumtype == "UINT16"): + + elif (pcddatumtype == "UINT32"): + elif (pcddatumtype == "UINT64"): - else: - + + else: + ::= [] [] ::= [] [] ::= if (pcddatumtype == "BOOLEAN"): - elif (pcddatumtype == "UINT8"): - elif (pcddatumtype == "UINT16"): - elif (pcddatumtype == "UINT32"): - elif (pcddatumtype == "UINT64"): - else: - - ::= {} {} - ::= {} {} + + elif (pcddatumtype == "UINT8"): + {} {} + elif (pcddatumtype == "UINT16"): + {} {} + elif (pcddatumtype == "UINT32"): + {} {} + elif (pcddatumtype == "UINT64"): + {} {} + else: + {} {} ::= - <1 -UsageBlock> ::= +<1UsageBlock> ::= ::= + ::= ::= ["##" ] ::= {} {} ::= {"CONSUMES"} {"SOMETIMES_CONSUMES"} -- 2.6.1.windows.1