DynamicTablesPkg: SSDT Serial Port Fixup library

According to Arm Server Base Boot Requirements,
Platform Design Document version 1.2 revision D,
September 2, 2019, section '4.2.1.8 SPCR'; The
SPCR console device must be included in the DSDT.

Additionally, it is often desirable to describe the
serial ports available on a platform so that they
are available for use by a rich OS.

To facilitate the description of serial ports on a
platform a common SSDT Serial Port Fixup library is
introduced. It provides interfaces to build a SSDT
serial port definition block table based on the
serial port information.

The SSDT Serial Port Fixup library is used by the
SPCR, DBG2 and SSDT Serial Port generator to describe
the serial port information in a definition block.

  +------------+   +------------+   +------------+
  |  SPCR Gen  |   |  DBG2 Gen  |   | SERIAL Gen |
  +------------+   +------------+   +------------+
        +----------------------------------+
        |  SSDT Serial Port Fixup library  |
        +----------------------------------+

The SSDT Serial Port Fixup library:
  - Parses the SSDT Serial Port template using the
    AmlLib library to generate an AML tree.
  - Updates the _UID, _HID and _CID values.
  - Fixes up the Serial port base address, length
    and the interrupt number in the _CRS descriptor.
  - Fixes up the serial-port name.
  - Serialises the AML Tree to a buffer containing
    the definition block data.
  The definition block data is then installed by the
  corresponding table generator.

Signed-off-by: Pierre Gondois <pierre.gondois@arm.com>
Signed-off-by: Sami Mujawar <sami.mujawar@arm.com>
Reviewed-by: Alexei Fedorov <Alexei.Fedorov@arm.com>

1 files changed, 6 insertions, 1 deletions

diff --git a/DynamicTablesPkg/Include/AcpiTableGenerator.h b/DynamicTablesPkg/Include/AcpiTableGenerator.h
index b55feb4e75..ef5018c312 100644
--- a/DynamicTablesPkg/Include/AcpiTableGenerator.h
+++ b/DynamicTablesPkg/Include/AcpiTableGenerator.h
@@ -1,6 +1,6 @@
 /** @file

 

-  Copyright (c) 2017 - 2019, ARM Limited. All rights reserved.

+  Copyright (c) 2017 - 2020, Arm Limited. All rights reserved.<BR>

 

   SPDX-License-Identifier: BSD-2-Clause-Patent

 

@@ -55,6 +55,10 @@ The Dynamic Tables Framework implements the following ACPI table generators:
             the Configuration Manager and builds the PPTT table.

   - SRAT  : The SRAT generator collates the system resource affinity information

             from the Configuration Manager and builds the SRAT table.

+  - SSDT Serial-Port:

+            The SSDT Serial generator collates the Serial port information

+            from the Configuration Manager and patches the SSDT Serial Port

+            template to build the SSDT Serial port table.

 */

 

 /** The ACPI_TABLE_GENERATOR_ID type describes ACPI table generator ID.

@@ -78,6 +82,7 @@ typedef enum StdAcpiTableId {
   EStdAcpiTableIdIort,                          ///< IORT Generator

   EStdAcpiTableIdPptt,                          ///< PPTT Generator

   EStdAcpiTableIdSrat,                          ///< SRAT Generator

+  EStdAcpiTableIdSsdtSerialPort,                ///< SSDT Serial-Port Generator

   EStdAcpiTableIdMax

 } ESTD_ACPI_TABLE_ID;