Reviewed-by: Liming Gao <liming....@intel.com>
>-----Original Message----- >From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of >Yonghong Zhu >Sent: Tuesday, April 03, 2018 3:18 PM >To: edk2-devel@lists.01.org >Cc: Kinney, Michael D <michael.d.kin...@intel.com>; Shaw, Kevin W ><kevin.w.s...@intel.com>; Gao, Liming <liming....@intel.com> >Subject: [edk2] [Patch] INF spec: Update version to 1.27 > >Cc: Liming Gao <liming....@intel.com> >Cc: Michael Kinney <michael.d.kin...@intel.com> >Cc: Kevin W Shaw <kevin.w.s...@intel.com> >Contributed-under: TianoCore Contribution Agreement 1.1 >Signed-off-by: Yonghong Zhu <yonghong....@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_[defines]_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 > >- Copyright (c) 2007-2017, Intel Corporation. All rights reserved.<BR> >+ Copyright (c) 2007-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: > >@@ -56,11 +56,11 @@ The format for entries in this section is: > > The following is an example of a driver's `[Defines]` section. > > ```ini > [Defines] >- INF_VERSION = 0x00010019 >+ INF_VERSION = 0x0001001B > BASE_NAME = DxeIpl > FILE_GUID = 86D70125-BAA3-4296-A62F-602BEBBB9081 > VERSION_STRING = 1.0 > MODULE_TYPE = PEIM > ENTRY_POINT = PeimInitializeDxeIpl >@@ -69,11 +69,11 @@ The following is an example of a driver's `[Defines]` >section. > > The following is an example of a library's `[Defines]` section. > > ```ini > [Defines] >- INF_VERSION = 1.25 >+ INF_VERSION = 1.27 > BASE_NAME = BaseMemoryLib > FILE_GUID = fd44e603-002a-4b29-9f5f-529e815b6165 > MODULE_TYPE = BASE > VERSION_STRING = 1.0 > LIBRARY_CLASS = BaseMemoryLib >@@ -108,11 +108,11 @@ dispatch instance. > > ###### Table 1 EDK II [Defines] Section Elements > > | Tag | Required > | Value >| Notes >| > | ---------------------------- | > -------------------------------------------------------------- >---------- | --------------------------------------------- | >----------------------------------- >----------------------------------------------------------------------------------------------- >----------------------------------------------------------------------------------------------- >----------------------------------------------------------------------------------------------- >----------------------------------------------------------------------------------------------- >-------------------- | >-| `INF_VERSION` | REQUIRED > | 1.25 or >0x00010019 | This identifies the INF spec. version. >Tools use this >value to handle parsing of previous releases of the specification if there are >incompatible changes. >| >+| `INF_VERSION` | REQUIRED > | 1.27 >or 0x0001001B | This identifies the INF spec. >version. It is decimal >value with fraction or two-nibble hexadecimal representation of the same, for >example: 1.27. Tools use this value to handle parsing of previous releases of >the specification 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 libraries. If a revision value is not declared in >the >module or any of the dependent libraries, then the tool may use the value of >0, which disables checking. >| > | `PI_SPECIFICATION_VERSION` | Not required >| Decimal or special format of hex | The minimum revision value >across >the module and all its dependent libraries. If a revision value is not >declared in >the module or any of the dependent libraries, then tools may use the value of >0, which disables checking. >| > | | > | >| The `PI_SPECIFICATION_VERSION` must only be set in the INF file if the >module depends on services or system table fields or PI core behaviors that >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_VERSION` >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 libraries. If a revision value is not >declared in >the module or any of the dependent libraries, then tools may use the value of >0, which disables checking. >| >diff --git a/3_edk_ii_inf_file_format/34_[defines]_section.md >b/3_edk_ii_inf_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 > >- Copyright (c) 2007-2017, Intel Corporation. All rights reserved.<BR> >+ Copyright (c) 2007-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: > >@@ -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 the > developer and is an input to the new build tool parsing utilities. Elements > may > appear in any order within this section. > >-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 >specified >-as a decimal value, 1.25. >+as a decimal value, 1.27. > > 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 >generated C > files. >@@ -54,13 +54,13 @@ files. > The `FILE_GUID` is required for all EDK II modules. This GUID is used to build > 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. > > All new EDK II INF files must include one of the following statements: >-`INF_VERSION = 0x00010019` or `INF_VERSION = 1.25` in this section, where >the >+`INF_VERSION = 0x0001001B` or `INF_VERSION = 1.27` in this section, where >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. > >@@ -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 >cases > where the module type is not a member of `<Edk2ModuleType>`. > > **_INF_VERSION_** > >-For new INF files, the version value must be set to `0x00010019`. Tools that >+For new INF files, the version value must be set to `0x0001001B`. Tools that > process this version of the INF file can successfully process earlier versions > of the INF file (this is a backward compatible update). There is no >requirement > to change the value in existing INF files if no other content changes. This > may >-also be specified as decimal value, 1.25. >+also be specified as decimal value, 1.27. > > **_EDK_RELEASE_VERSION_** > > This optional value may be set to the major/minor number of the EDK II >release > required for modules to function correctly. >@@ -300,11 +300,11 @@ Writer's Guide for more information. > > #### Example (EDK II Driver) > > ```ini > [Defines] >- INF_VERSION = 1.25 >+ INF_VERSION = 1.27 > BASE_NAME = PlatformAcpiTable > FILE_GUID = 7E374E25-8E01-4FEE-87F2-390C23C606CD > MODULE_TYPE = DXE_DRIVER > VERSION_STRING = 1.0 > EDK_RELEASE_VERSION = 0x00020000 >@@ -313,11 +313,11 @@ Writer's Guide for more information. > > #### Example (UEFI Driver) > > ```ini > [Defines] >- INF_VERSION = 0x00010019 >+ INF_VERSION = 0x0001001B > BASE_NAME = Abc > FILE_GUID = DA87D340-15C0-4824-9BF3-D52286674BEF > MODULE_TYPE = UEFI_DRIVER > VERSION_STRING = 1.0 > ENTRY_POINT = AbcDriverEntryPoint >@@ -326,11 +326,11 @@ Writer's Guide for more information. > > #### Example (EDK II Library) > > ```ini > [Defines] >- INF_VERSION = 1.25 >+ INF_VERSION = 1.27 > BASE_NAME = LzmaCustomDecompressLib > FILE_GUID = 22f8406f-43ee-492f-82f5-4e8a1a58e6d2 > MODULE_TYPE = BASE > VERSION_STRING = 1.0 > LIBRARY_CLASS = 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 > >- Copyright (c) 2007-2017, Intel Corporation. All rights reserved.<BR> >+ Copyright (c) 2007-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: > >@@ -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). | January >2016 | > | 1.26 | Convert to GitBooks >| May 2017 | > | | [#463](https://bugzilla.tianocore.org/show_bug.cgi?id=463) INF > spec: >document the LIB file type under the [Binaries] Section >| | > | | [#548](https://bugzilla.tianocore.org/show_bug.cgi?id=548) [INF >spec] INF [LibraryClasses] section should not support ModuleType >| | > | | [#522](https://bugzilla.tianocore.org/show_bug.cgi?id=522) 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_driver_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 > >- Copyright (c) 2007-2017, Intel Corporation. All rights reserved.<BR> >+ Copyright (c) 2007-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: > >@@ -61,11 +61,11 @@ driver modules. > # IMPLIED. > # > ## > > [Defines] >- INF_VERSION = 0x00010019 >+ INF_VERSION = 0x0001001B > BASE_NAME = DiskIoDxe > MODULE_UNI_FILE = DiskIoDxe.uni > FILE_GUID = 6B38F7B4-AD98-40e9-9093-ACA2B5A253C4 > MODULE_TYPE = UEFI_DRIVER > VERSION_STRING = 1.0 >@@ -121,11 +121,11 @@ driver modules. > # IMPLIED. > # > ## > > [Defines] >- INF_VERSION = 0x00010019 >+ INF_VERSION = 0x0001001B > BASE_NAME = StatusCodeRuntimeDxe > MODULE_UNI_FILE = StatusCodeRuntimeDxe.uni > FILE_GUID = FEDE0A1B-BCA2-4A9F-BB2B-D9FD7DEC2E9F > MODULE_TYPE = DXE_RUNTIME_DRIVER > VERSION_STRING = 1.0 >diff --git a/appendix_e_sample_library_inf_files.md >b/appendix_e_sample_library_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 > >- Copyright (c) 2007-2017, Intel Corporation. All rights reserved.<BR> >+ Copyright (c) 2007-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: > >@@ -57,11 +57,11 @@ DxeCoreMemoryAllocationLib.inf and >SmmCorePerformanceLib.inf. > # IMPLIED. > # > ## > > [Defines] >- INF_VERSION = 0x00010019 >+ INF_VERSION = 0x0001001B > BASE_NAME = PeiServicesTablePointerLib > MODULE_UNI_FILE = PeiServicesTablePointerLib.uni > FILE_GUID = 1c747f6b-0a58-49ae-8ea3-0327a4fa10e3 > MODULE_TYPE = PEIM > VERSION_STRING = 1.0 >@@ -107,11 +107,11 @@ DxeCoreMemoryAllocationLib.inf and >SmmCorePerformanceLib.inf. > # IMPLIED. > # > ## > > [Defines] >- INF_VERSION = 0x00010019 >+ INF_VERSION = 0x0001001B > BASE_NAME = DxeCoreMemoryAllocationLib > FILE_GUID = 632F3FAC-1CA4-4725-BAA2-BDECCF9A111C > MODULE_TYPE = DXE_CORE > VERSION_STRING = 1.0 > LIBRARY_CLASS = MemoryAllocationLib|DXE_CORE >@@ -163,11 +163,11 @@ DxeCoreMemoryAllocationLib.inf and >SmmCorePerformanceLib.inf. > # IMPLIED. > # > ## > > [Defines] >- INF_VERSION = 0x00010019 >+ INF_VERSION = 0x0001001B > BASE_NAME = SmmCorePerformanceLib > FILE_GUID = 36290D10-0F47-42c1-BBCE-E191C7928DCF > MODULE_TYPE = SMM_CORE > VERSION_STRING = 1.0 > PI_SPECIFICATION_VERSION = 0x0001000A >diff --git a/appendix_f_sample_binary_inf_files.md >b/appendix_f_sample_binary_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 > >- Copyright (c) 2007-2017, Intel Corporation. All rights reserved.<BR> >+ Copyright (c) 2007-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: > >@@ -111,11 +111,11 @@ RuntimeDxe driver in the MdeModulePkg. > # IMPLIED. > # > ## > > [Defines] >- INF_VERSION = 0x00010019 >+ INF_VERSION = 0x0001001B > BASE_NAME = RuntimeDxe > FILE_GUID = B601F8C4-43B7-4784-95B1-F4226CB40CEE > MODULE_TYPE = DXE_RUNTIME_DRIVER > VERSION_STRING = 1.0 > >-- >2.6.1.windows.1 > >_______________________________________________ >edk2-devel mailing list >edk2-devel@lists.01.org >https://lists.01.org/mailman/listinfo/edk2-devel _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
