ArmVirtPkg/Kvmtool: Enable ACPI support

[mirror_edk2.git] / ArmVirtPkg / KvmtoolCfgMgrDxe / ConfigurationManager.h

/** @file\r
\r
  Copyright (c) 2021 - 2022, Arm Limited. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Glossary:\r
    - Cm or CM   - Configuration Manager\r
    - Obj or OBJ - Object\r
**/\r
\r
#ifndef CONFIGURATION_MANAGER_H_\r
#define CONFIGURATION_MANAGER_H_\r
\r
///\r
/// C array containing the compiled AML template.\r
/// This symbol is defined in the auto generated C file\r
/// containing the AML bytecode array.\r
///\r
extern CHAR8  dsdt_aml_code[];\r
\r
///\r
/// The configuration manager version.\r
///\r
#define CONFIGURATION_MANAGER_REVISION  CREATE_REVISION (1, 0)\r
\r
///\r
/// The OEM ID\r
///\r
#define CFG_MGR_OEM_ID  { 'A', 'R', 'M', 'L', 'T', 'D' }\r
\r
///\r
/// Memory address size limit. Assume the whole address space.\r
///\r
#define MEMORY_ADDRESS_SIZE_LIMIT  64\r
\r
/** A function that prepares Configuration Manager Objects for returning.\r
\r
  @param [in]  This        Pointer to the Configuration Manager Protocol.\r
  @param [in]  CmObjectId  The Configuration Manager Object ID.\r
  @param [in]  Token       A token for identifying the object.\r
  @param [out] CmObject    Pointer to the Configuration Manager Object\r
                           descriptor describing the requested Object.\r
\r
  @retval EFI_SUCCESS           Success.\r
  @retval EFI_INVALID_PARAMETER A parameter is invalid.\r
  @retval EFI_NOT_FOUND         The required object information is not found.\r
**/\r
typedef EFI_STATUS (*CM_OBJECT_HANDLER_PROC) (\r
  IN  CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL  *CONST  This,\r
  IN  CONST CM_OBJECT_ID                                  CmObjectId,\r
  IN  CONST CM_OBJECT_TOKEN                               Token,\r
  IN  OUT   CM_OBJ_DESCRIPTOR                     *CONST  CmObject\r
  );\r
\r
///\r
/// A helper macro for mapping a reference token.\r
///\r
#define REFERENCE_TOKEN(Field)                                     \\r
          (CM_OBJECT_TOKEN)((UINT8*)&mKvmtoolPlatRepositoryInfo +  \\r
           OFFSET_OF (EDKII_PLATFORM_REPOSITORY_INFO, Field))\r
\r
///\r
/// The number of ACPI tables to install\r
///\r
#define PLAT_ACPI_TABLE_COUNT  10\r
\r
///\r
/// A structure describing the platform configuration\r
/// manager repository information\r
///\r
typedef struct PlatformRepositoryInfo {\r
  ///\r
  /// Configuration Manager Information.\r
  ///\r
  CM_STD_OBJ_CONFIGURATION_MANAGER_INFO    CmInfo;\r
\r
  ///\r
  /// List of ACPI tables\r
  ///\r
  CM_STD_OBJ_ACPI_TABLE_INFO               CmAcpiTableList[PLAT_ACPI_TABLE_COUNT];\r
\r
  ///\r
  /// Power management profile information\r
  ///\r
  CM_ARM_POWER_MANAGEMENT_PROFILE_INFO     PmProfileInfo;\r
\r
  ///\r
  /// ITS Group node\r
  ///\r
  CM_ARM_ITS_GROUP_NODE                    ItsGroupInfo;\r
\r
  ///\r
  /// ITS Identifier array\r
  ///\r
  CM_ARM_ITS_IDENTIFIER                    ItsIdentifierArray[1];\r
\r
  ///\r
  /// PCI Root complex node\r
  ///\r
  CM_ARM_ROOT_COMPLEX_NODE                 RootComplexInfo;\r
\r
  ///\r
  /// Array of DeviceID mapping\r
  ///\r
  CM_ARM_ID_MAPPING                        DeviceIdMapping[1];\r
\r
  ///\r
  /// Dynamic platform repository.\r
  /// CmObj created by parsing the Kvmtool device tree are stored here.\r
  ///\r
  DYNAMIC_PLATFORM_REPOSITORY_INFO         *DynamicPlatformRepo;\r
\r
  ///\r
  /// Base address of the FDT.\r
  ///\r
  VOID                                     *FdtBase;\r
\r
  ///\r
  /// A handle to the FDT HwInfoParser.\r
  ///\r
  HW_INFO_PARSER_HANDLE                    FdtParserHandle;\r
} EDKII_PLATFORM_REPOSITORY_INFO;\r
\r
#endif // CONFIGURATION_MANAGER_H_\r