From nobody Mon May  6 10:38:16 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 1522739892764941.8762229088862;
 Tue, 3 Apr 2018 00:18:12 -0700 (PDT)
Received: from [127.0.0.1] (localhost [IPv6:::1])
	by ml01.01.org (Postfix) with ESMTP id AA06F22106DE4;
	Tue,  3 Apr 2018 00:18:10 -0700 (PDT)
Received: from mga04.intel.com (mga04.intel.com [192.55.52.120])
 (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 B6EB721FB7D5D
 for <edk2-devel@lists.01.org>; Tue,  3 Apr 2018 00:18:09 -0700 (PDT)
Received: from fmsmga005.fm.intel.com ([10.253.24.32])
 by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
 03 Apr 2018 00:18:09 -0700
Received: from shwdeopenpsi168.ccr.corp.intel.com ([10.239.158.129])
 by fmsmga005.fm.intel.com with ESMTP; 03 Apr 2018 00:18:08 -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.120; helo=mga04.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.48,398,1517904000"; d="scan'208";a="217168659"
From: Yonghong Zhu <yonghong.zhu@intel.com>
To: edk2-devel@lists.01.org
Date: Tue,  3 Apr 2018 15:17:49 +0800
Message-Id: <1522739869-18508-7-git-send-email-yonghong.zhu@intel.com>
X-Mailer: git-send-email 2.6.1.windows.1
In-Reply-To: <1522739869-18508-1-git-send-email-yonghong.zhu@intel.com>
References: <1522739869-18508-1-git-send-email-yonghong.zhu@intel.com>
Subject: [edk2] [Patch] INF spec: Update version to 1.27
X-BeenThere: edk2-devel@lists.01.org
X-Mailman-Version: 2.1.26
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>,
 Kevin W Shaw <kevin.w.shaw@intel.com>, Liming Gao <liming.gao@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"

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>
Reviewed-by: Liming Gao <liming.gao@intel.com>
---
 2_inf_overview/24_[defines]_section.md           |  8 ++++----
 3_edk_ii_inf_file_format/34_[defines]_section.md | 22 +++++++++++---------=
--
 README.md                                        |  4 +++-
 appendix_d_sample_driver_inf_files.md            |  6 +++---
 appendix_e_sample_library_inf_files.md           |  8 ++++----
 appendix_f_sample_binary_inf_files.md            |  4 ++--
 6 files changed, 27 insertions(+), 25 deletions(-)

diff --git a/2_inf_overview/24_[defines]_section.md b/2_inf_overview/24_[de=
fines]_section.md
index 3aab498..37b0135 100644
--- a/2_inf_overview/24_[defines]_section.md
+++ b/2_inf_overview/24_[defines]_section.md
@@ -1,9 +1,9 @@
 <!--- @file
   2.4 [Defines] Section
=20
-  Copyright (c) 2007-2017, Intel Corporation. All rights reserved.<BR>
+  Copyright (c) 2007-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
   modification, are permitted provided that the following conditions are m=
et:
=20
@@ -56,11 +56,11 @@ The format for entries in this section is:
=20
 The following is an example of a driver's `[Defines]` section.
=20
 ```ini
 [Defines]
-  INF_VERSION     =3D 0x00010019
+  INF_VERSION     =3D 0x0001001B
   BASE_NAME       =3D DxeIpl
   FILE_GUID       =3D 86D70125-BAA3-4296-A62F-602BEBBB9081
   VERSION_STRING  =3D 1.0
   MODULE_TYPE     =3D PEIM
   ENTRY_POINT     =3D PeimInitializeDxeIpl
@@ -69,11 +69,11 @@ The following is an example of a driver's `[Defines]` s=
ection.
=20
 The following is an example of a library's `[Defines]` section.
=20
 ```ini
 [Defines]
-  INF_VERSION    =3D 1.25
+  INF_VERSION    =3D 1.27
   BASE_NAME      =3D BaseMemoryLib
   FILE_GUID      =3D fd44e603-002a-4b29-9f5f-529e815b6165
   MODULE_TYPE    =3D BASE
   VERSION_STRING =3D 1.0
   LIBRARY_CLASS  =3D BaseMemoryLib
@@ -108,11 +108,11 @@ dispatch instance.
=20
 ###### Table 1 EDK II [Defines] Section Elements
=20
 | Tag                          | Required                                 =
                                | Value                                    =
     | Notes                                                               =
                                                                           =
                                                                           =
                                                                           =
                                                                           =
                                                                    |
 | ---------------------------- | -----------------------------------------=
------------------------------- | -----------------------------------------=
---- | --------------------------------------------------------------------=
---------------------------------------------------------------------------=
---------------------------------------------------------------------------=
---------------------------------------------------------------------------=
---------------------------------------------------------------------------=
------------------------------------------------------------------- |
-| `INF_VERSION`                | REQUIRED                                 =
                                | 1.25 or 0x00010019                       =
     | This identifies the INF spec. version. Tools use this value to handl=
e parsing of previous releases of the specification if there are incompatib=
le changes.                                                                =
                                                                           =
                                                                           =
                                                                    |
+| `INF_VERSION`                | REQUIRED                                 =
                                | 1.27 or 0x0001001B                       =
     | This identifies the INF spec. version. It is decimal value with frac=
tion or two-nibble hexadecimal representation of the same, for example: 1.2=
7. Tools use this value to handle parsing of previous releases of the speci=
fication if there are incompatible changes.                                =
                                                                           =
                                                                           =
                                                                           =
                         |
 | `BASE_NAME`                  | REQUIRED                                 =
                                | A single word                            =
     | This is a single word identifier that will be used for the component=
 name.                                                                     =
                                                                           =
                                                                           =
                                                                           =
                                                                    |
 | `EDK_RELEASE_VERSION`        | Not required                             =
                                | Hex Double Word                          =
     | The minimum revision value across the module and all its dependent l=
ibraries. If a revision value is not declared in the module or any of the d=
ependent libraries, then the tool may use the value of 0, which disables ch=
ecking.                                                                    =
                                                                           =
                                                                    |
 | `PI_SPECIFICATION_VERSION`   | Not required                             =
                                | Decimal or special format of hex         =
     | The minimum revision value across the module and all its dependent l=
ibraries. If a revision value is not declared in the module or any of the d=
ependent libraries, then tools may use the value of 0, which disables check=
ing.                                                                       =
                                                                           =
                                                                    |
 |                              |                                          =
                                |                                          =
     | The `PI_SPECIFICATION_VERSION` must only be set in the INF file if t=
he module depends on services or system table fields or PI core behaviors t=
hat are not present in the PI 1.0 version. For example, if a module depends=
 on definitions in PI 1.1 that are not in PI 1.0, then `PI_SPECIFICATION_VE=
RSION` must be 0x0001000A                                                  =
                                                                    |
 | `UEFI_SPECIFICATION_VERSION` | Not required                             =
                                | Decimal or special format of hex         =
     | The minimum revision value across the module and all its dependent l=
ibraries. If a revision value is not declared in the module or any of the d=
ependent libraries, then tools may use the value of 0, which disables check=
ing.                                                                       =
                                                                           =
                                                                    |
diff --git a/3_edk_ii_inf_file_format/34_[defines]_section.md b/3_edk_ii_in=
f_file_format/34_[defines]_section.md
index c121331..494b77d 100644
--- a/3_edk_ii_inf_file_format/34_[defines]_section.md
+++ b/3_edk_ii_inf_file_format/34_[defines]_section.md
@@ -1,9 +1,9 @@
 <!--- @file
   3.4 [Defines] Section
=20
-  Copyright (c) 2007-2017, Intel Corporation. All rights reserved.<BR>
+  Copyright (c) 2007-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
   modification, are permitted provided that the following conditions are m=
et:
=20
@@ -38,15 +38,15 @@ This is a required section.
 This describes the required `[Defines]` section used in EDK II INF files. =
This
 file is created during installation of a UEFI distribution package or by t=
he
 developer and is an input to the new build tool parsing utilities. Element=
s may
 appear in any order within this section.
=20
-The version for this specification is "0x00010019" and new versions of this
-specification must increment the minor (0019) portion of the specification=
 code
+The version for this specification is "0x0001001B" and new versions of this
+specification must increment the minor (001B) portion of the specification=
 code
 for backward compatible changes, and increment the major number for
 non-backward compatible specification changes. This value may also be spec=
ified
-as a decimal value, 1.25.
+as a decimal value, 1.27.
=20
 The `[Defines]` section assigns values to the symbols that describe the
 component. Some items are emitted to the output makefile, others are used =
to
 create filenames during the build. Some symbols are emitted to the generat=
ed C
 files.
@@ -54,13 +54,13 @@ files.
 The `FILE_GUID` is required for all EDK II modules. This GUID is used to b=
uild
 the FW volume file list used by build tools to generate the final firmware
 volume, as well as processed in some SMM, PEI or DXE `DEPEX` statements.
=20
 All new EDK II INF files must include one of the following statements:
-`INF_VERSION =3D 0x00010019` or `INF_VERSION =3D 1.25` in this section, wh=
ere the
+`INF_VERSION =3D 0x0001001B` or `INF_VERSION =3D 1.27` in this section, wh=
ere the
 number varies according to the release of this specification. It is a
-HexVersion type, where the 0x0001 is the major number, and the 0019 is the
+HexVersion type, where the 0x0001 is the major number, and the 001B is the
 minor number. This version of the specification provides full backward
 compatibility to all previous versions. This means that tools that process
 this version of the specification can also process earlier versions of
 EDK II INF files.
=20
@@ -198,15 +198,15 @@ can be used to specify other binary files types, such=
 as logo images or
 legacy16 option ROMs. The `USER_DEFINED` module type must be used in all c=
ases
 where the module type is not a member of `<Edk2ModuleType>`.
=20
 **_INF_VERSION_**
=20
-For new INF files, the version value must be set to `0x00010019`. Tools th=
at
+For new INF files, the version value must be set to `0x0001001B`. Tools th=
at
 process this version of the INF file can successfully process earlier vers=
ions
 of the INF file (this is a backward compatible update). There is no requir=
ement
 to change the value in existing INF files if no other content changes. Thi=
s may
-also be specified as decimal value, 1.25.
+also be specified as decimal value, 1.27.
=20
 **_EDK_RELEASE_VERSION_**
=20
 This optional value may be set to the major/minor number of the EDK II rel=
ease
 required for modules to function correctly.
@@ -300,11 +300,11 @@ Writer's Guide for more information.
=20
 #### Example (EDK II Driver)
=20
 ```ini
 [Defines]
-  INF_VERSION                =3D 1.25
+  INF_VERSION                =3D 1.27
   BASE_NAME                  =3D PlatformAcpiTable
   FILE_GUID                  =3D 7E374E25-8E01-4FEE-87F2-390C23C606CD
   MODULE_TYPE                =3D DXE_DRIVER
   VERSION_STRING             =3D 1.0
   EDK_RELEASE_VERSION        =3D 0x00020000
@@ -313,11 +313,11 @@ Writer's Guide for more information.
=20
 #### Example (UEFI Driver)
=20
 ```ini
 [Defines]
-  INF_VERSION    =3D 0x00010019
+  INF_VERSION    =3D 0x0001001B
   BASE_NAME      =3D Abc
   FILE_GUID      =3D DA87D340-15C0-4824-9BF3-D52286674BEF
   MODULE_TYPE    =3D UEFI_DRIVER
   VERSION_STRING =3D 1.0
   ENTRY_POINT    =3D AbcDriverEntryPoint
@@ -326,11 +326,11 @@ Writer's Guide for more information.
=20
 #### Example (EDK II Library)
=20
 ```ini
 [Defines]
-  INF_VERSION    =3D 1.25
+  INF_VERSION    =3D 1.27
   BASE_NAME      =3D LzmaCustomDecompressLib
   FILE_GUID      =3D 22f8406f-43ee-492f-82f5-4e8a1a58e6d2
   MODULE_TYPE    =3D BASE
   VERSION_STRING =3D 1.0
   LIBRARY_CLASS  =3D CustomDecompressLib
diff --git a/README.md b/README.md
index 02a7532..194d3e3 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
 <!--- @file
   README.md for EDK II Module Information (INF) File Specification
=20
-  Copyright (c) 2007-2017, Intel Corporation. All rights reserved.<BR>
+  Copyright (c) 2007-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
   modification, are permitted provided that the following conditions are m=
et:
=20
@@ -194,5 +194,7 @@ Copyright (c) 2007-2017, Intel Corporation. All rights =
reserved.
 | 1.25       | Revised WORKSPACE wording for updated build system that can=
 handle packages located outside of the WORKSPACE directory tree (refer to =
the TianoCore.org/EDKII website for additional instructions on setting up a=
 development environment).                                         | Januar=
y 2016  |
 | 1.26       | Convert to GitBooks                                        =
                                                                           =
                                                                           =
                                                                   | May 20=
17      |
 |            | [#463](https://bugzilla.tianocore.org/show_bug.cgi?id=3D463=
) INF spec: document the LIB file type under the [Binaries] Section        =
                                                                           =
                                                                     |     =
          |
 |            | [#548](https://bugzilla.tianocore.org/show_bug.cgi?id=3D548=
) [INF spec] INF [LibraryClasses] section should not support ModuleType    =
                                                                           =
                                                                     |     =
          |
 |            | [#522](https://bugzilla.tianocore.org/show_bug.cgi?id=3D522=
) INF spec: add the clarification that PCD value may from build command    =
                                                                           =
                                                                     |     =
          |
+| 1.27       | Update version to 1.27                                     =
                                                                           =
                                                                           =
                                                                   | March =
2018    |
+|            | Add Flexible PCD value format support                      =
                                                                           =
                                                                           =
                                                                   |       =
        |
diff --git a/appendix_d_sample_driver_inf_files.md b/appendix_d_sample_driv=
er_inf_files.md
index 8fee082..0efcb63 100644
--- a/appendix_d_sample_driver_inf_files.md
+++ b/appendix_d_sample_driver_inf_files.md
@@ -1,9 +1,9 @@
 <!--- @file
   Appendix D Sample Driver INF Files
=20
-  Copyright (c) 2007-2017, Intel Corporation. All rights reserved.<BR>
+  Copyright (c) 2007-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
   modification, are permitted provided that the following conditions are m=
et:
=20
@@ -61,11 +61,11 @@ driver modules.
 # IMPLIED.
 #
 ##
=20
 [Defines]
-  INF_VERSION     =3D 0x00010019
+  INF_VERSION     =3D 0x0001001B
   BASE_NAME       =3D DiskIoDxe
   MODULE_UNI_FILE =3D DiskIoDxe.uni
   FILE_GUID       =3D 6B38F7B4-AD98-40e9-9093-ACA2B5A253C4
   MODULE_TYPE     =3D UEFI_DRIVER
   VERSION_STRING  =3D 1.0
@@ -121,11 +121,11 @@ driver modules.
 # IMPLIED.
 #
 ##
=20
 [Defines]
-  INF_VERSION     =3D 0x00010019
+  INF_VERSION     =3D 0x0001001B
   BASE_NAME       =3D StatusCodeRuntimeDxe
   MODULE_UNI_FILE =3D StatusCodeRuntimeDxe.uni
   FILE_GUID       =3D FEDE0A1B-BCA2-4A9F-BB2B-D9FD7DEC2E9F
   MODULE_TYPE     =3D DXE_RUNTIME_DRIVER
   VERSION_STRING  =3D 1.0
diff --git a/appendix_e_sample_library_inf_files.md b/appendix_e_sample_lib=
rary_inf_files.md
index 59757ed..bf4a6fd 100644
--- a/appendix_e_sample_library_inf_files.md
+++ b/appendix_e_sample_library_inf_files.md
@@ -1,9 +1,9 @@
 <!--- @file
   Appendix E Sample Library INF Files
=20
-  Copyright (c) 2007-2017, Intel Corporation. All rights reserved.<BR>
+  Copyright (c) 2007-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
   modification, are permitted provided that the following conditions are m=
et:
=20
@@ -57,11 +57,11 @@ DxeCoreMemoryAllocationLib.inf and SmmCorePerformanceLi=
b.inf.
 # IMPLIED.
 #
 ##
=20
 [Defines]
-  INF_VERSION     =3D 0x00010019
+  INF_VERSION     =3D 0x0001001B
   BASE_NAME       =3D PeiServicesTablePointerLib
   MODULE_UNI_FILE =3D PeiServicesTablePointerLib.uni
   FILE_GUID       =3D 1c747f6b-0a58-49ae-8ea3-0327a4fa10e3
   MODULE_TYPE     =3D PEIM
   VERSION_STRING  =3D 1.0
@@ -107,11 +107,11 @@ DxeCoreMemoryAllocationLib.inf and SmmCorePerformance=
Lib.inf.
 # IMPLIED.
 #
 ##
=20
 [Defines]
-  INF_VERSION    =3D 0x00010019
+  INF_VERSION    =3D 0x0001001B
   BASE_NAME      =3D DxeCoreMemoryAllocationLib
   FILE_GUID      =3D 632F3FAC-1CA4-4725-BAA2-BDECCF9A111C
   MODULE_TYPE    =3D DXE_CORE
   VERSION_STRING =3D 1.0
   LIBRARY_CLASS  =3D MemoryAllocationLib|DXE_CORE
@@ -163,11 +163,11 @@ DxeCoreMemoryAllocationLib.inf and SmmCorePerformance=
Lib.inf.
 # IMPLIED.
 #
 ##
=20
 [Defines]
-  INF_VERSION              =3D 0x00010019
+  INF_VERSION              =3D 0x0001001B
   BASE_NAME                =3D SmmCorePerformanceLib
   FILE_GUID                =3D 36290D10-0F47-42c1-BBCE-E191C7928DCF
   MODULE_TYPE              =3D SMM_CORE
   VERSION_STRING           =3D 1.0
   PI_SPECIFICATION_VERSION =3D 0x0001000A
diff --git a/appendix_f_sample_binary_inf_files.md b/appendix_f_sample_bina=
ry_inf_files.md
index 5825505..e6d06d7 100644
--- a/appendix_f_sample_binary_inf_files.md
+++ b/appendix_f_sample_binary_inf_files.md
@@ -1,9 +1,9 @@
 <!--- @file
   Appendix F Sample Binary INF Files
=20
-  Copyright (c) 2007-2017, Intel Corporation. All rights reserved.<BR>
+  Copyright (c) 2007-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
   modification, are permitted provided that the following conditions are m=
et:
=20
@@ -111,11 +111,11 @@ RuntimeDxe driver in the MdeModulePkg.
 # IMPLIED.
 #
 ##
=20
 [Defines]
-  INF_VERSION    =3D 0x00010019
+  INF_VERSION    =3D 0x0001001B
   BASE_NAME      =3D RuntimeDxe
   FILE_GUID      =3D B601F8C4-43B7-4784-95B1-F4226CB40CEE
   MODULE_TYPE    =3D DXE_RUNTIME_DRIVER
   VERSION_STRING =3D 1.0
=20
--=20
2.6.1.windows.1

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