[staging/dynamictables PATCH v1] Update Readme.md to reflect ACPICA compiler update

[staging/dynamictables PATCH v1] Update Readme.md to reflect ACPICA compiler update

[Sami Mujawar]

The ACPICA iASL compiler has been enhanced to support the
generation of an AML hex file which is required by the
Dynamic Tables Framework. The patch for this enhancement
has been integrated in the ACPICA repository. Therefore
the Prerequisites section in the Readme has been updated
accordingly.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Sami Mujawar <sami.mujawar@arm.com>
Reviewed-by: Evan Lloyd <evan.lloyd@arm.com>
---
The changes can be seen at
https://github.com/samimujawar/edk2-staging/tree/258_reflect_acpica_compiler_enhancement_v1

Notes:
    v1:
    - Update ACPICA iAsl compiler usage guidelines.                 [SAMI]

 Readme.md | 21 +++++++++++---------
 1 file changed, 12 insertions(+), 9 deletions(-)

diff --git a/Readme.md b/Readme.md
index b72efca18e8ab5de17cab06f0a1a0725991256d4..2300fa6be9f83525e8c0ee21800751d9067b02e0 100644
--- a/Readme.md
+++ b/Readme.md
@@ -87,9 +87,9 @@ contains the Dynamic Tables Framework.
 ### ACPICA iASL compiler
 The RAW table generator, used to process the DSDT/SSDT files depends on
 the iASL compiler to convert the DSDT/SSDT ASL files to a C array containing
-the hex AML code. The current implementation of the iASL compiler does not
-support generation of a C header file suitable for including from a C source
-file.
+the hex AML code. The "-tc" option of the iASL compiler has been enhanced to
+support generation of an AML hex file (C header) with a unique symbol name
+so that it is suitable for inclusion from a C source file.
 
 Related Links
 --------------
@@ -135,16 +135,19 @@ or
 
 Prerequisites
 -------------
-ACPICA iASL compiler with support for generating a C header file.
+ACPICA iASL compiler with the enhanced "-tc" option to support generation of
+AML hex (C header) files with unique symbol names.
 
-A patch ***'Modify hex AML C header file generation'***, to enable
-this support has been submitted to the ACPICA source repository.
-<https://lists.acpica.org/pipermail/devel/2018-March/001755.html>
+A patch ***'[iASL: Enhance the -tc option (create AML hex file in C)](https://github.com/acpica/acpica/commit/f9a88a4c1cd020b6a5475d63b29626852a0b5f37)'***,
+to enable this support has been integrated to the ACPICA source repository.
+
+
+Ensure that the iASL compiler used for building *Dynamic Tables Framework*
+has this feature enabled.
 
 Documentation
 -------------
-A description document is in preparation, and should be available in the
-near future.
+[Dynamic Tables Framework: A Step Towards Automatic Generation of Advanced Configuration and Power Interface (ACPI) & System Management BIOS (SMBIOS) Tables – Sami Mujawar (Arm).](http://www.uefi.org/sites/default/files/resources/Arm_Dynamic%20Tables%20Framework%20A%20Step%20Towards%20Automatic%20Generation%20of%20Advanced%20Configuration%20and%20Power%20Interface%20%28ACPI%29%20%26%20System%20Management%20BIOS%20%28SMBIOS%29%20Tables%20_0.pdf)
 
 Miscellaneous
 -------------
-- 
'Guid(CE165669-3EF3-493F-B85D-6190EE5B9759)'

Re: [staging/dynamictables PATCH v1] Update Readme.md to reflect ACPICA compiler update

[Leif Lindholm]

On Fri, Apr 27, 2018 at 04:24:59PM +0100, Sami Mujawar wrote:
> The ACPICA iASL compiler has been enhanced to support the
> generation of an AML hex file which is required by the
> Dynamic Tables Framework. The patch for this enhancement
> has been integrated in the ACPICA repository. Therefore
> the Prerequisites section in the Readme has been updated
> accordingly.
> 
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Sami Mujawar <sami.mujawar@arm.com>
> Reviewed-by: Evan Lloyd <evan.lloyd@arm.com>
> ---
> The changes can be seen at
> https://github.com/samimujawar/edk2-staging/tree/258_reflect_acpica_compiler_enhancement_v1
> 
> Notes:
>     v1:
>     - Update ACPICA iAsl compiler usage guidelines.                 [SAMI]
> 
>  Readme.md | 21 +++++++++++---------
>  1 file changed, 12 insertions(+), 9 deletions(-)
> 
> diff --git a/Readme.md b/Readme.md
> index b72efca18e8ab5de17cab06f0a1a0725991256d4..2300fa6be9f83525e8c0ee21800751d9067b02e0 100644
> --- a/Readme.md
> +++ b/Readme.md
> @@ -87,9 +87,9 @@ contains the Dynamic Tables Framework.
>  ### ACPICA iASL compiler
>  The RAW table generator, used to process the DSDT/SSDT files depends on
>  the iASL compiler to convert the DSDT/SSDT ASL files to a C array containing
> -the hex AML code. The current implementation of the iASL compiler does not
> -support generation of a C header file suitable for including from a C source
> -file.
> +the hex AML code. The "-tc" option of the iASL compiler has been enhanced to
> +support generation of an AML hex file (C header) with a unique symbol name
> +so that it is suitable for inclusion from a C source file.
>  
>  Related Links
>  --------------
> @@ -135,16 +135,19 @@ or
>  
>  Prerequisites
>  -------------
> -ACPICA iASL compiler with support for generating a C header file.
> +ACPICA iASL compiler with the enhanced "-tc" option to support generation of
> +AML hex (C header) files with unique symbol names.
>  
> -A patch ***'Modify hex AML C header file generation'***, to enable
> -this support has been submitted to the ACPICA source repository.
> -<https://lists.acpica.org/pipermail/devel/2018-March/001755.html>
> +A patch ***'[iASL: Enhance the -tc option (create AML hex file in C)](https://github.com/acpica/acpica/commit/f9a88a4c1cd020b6a5475d63b29626852a0b5f37)'***,
> +to enable this support has been integrated to the ACPICA source repository.

Same comment as the related patches - can you put the commitdate of
that patch in here as well?

> +
> +
> +Ensure that the iASL compiler used for building *Dynamic Tables Framework*
> +has this feature enabled.
>  
>  Documentation
>  -------------
> -A description document is in preparation, and should be available in the
> -near future.
> +[Dynamic Tables Framework: A Step Towards Automatic Generation of Advanced Configuration and Power Interface (ACPI) & System Management BIOS (SMBIOS) Tables – Sami Mujawar (Arm).](http://www.uefi.org/sites/default/files/resources/Arm_Dynamic%20Tables%20Framework%20A%20Step%20Towards%20Automatic%20Generation%20of%20Advanced%20Configuration%20and%20Power%20Interface%20%28ACPI%29%20%26%20System%20Management%20BIOS%20%28SMBIOS%29%20Tables%20_0.pdf)

And can you point out that this was a presentation at UEFI Plugfest
Seattle 2018?

/
    Leif

>  
>  Miscellaneous
>  -------------
> -- 
> 'Guid(CE165669-3EF3-493F-B85D-6190EE5B9759)'
> 
>