DynamicTablesPkg: Apply uncrustify changes

[mirror_edk2.git] / DynamicTablesPkg / Drivers / DynamicTableFactoryDxe / DeviceTreeTableFactory / DeviceTreeTableFactory.c

/** @file\r
  Device Tree Table Factory\r
\r
  Copyright (c) 2017 - 2019, ARM Limited. All rights reserved.\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Glossary:\r
    - Std - Standard\r
**/\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
\r
// Module specific include files.\r
#include <DeviceTreeTableGenerator.h>\r
#include <ConfigurationManagerObject.h>\r
#include <Protocol/ConfigurationManagerProtocol.h>\r
#include <Protocol/DynamicTableFactoryProtocol.h>\r
\r
#include "DynamicTableFactory.h"\r
\r
extern EDKII_DYNAMIC_TABLE_FACTORY_INFO  TableFactoryInfo;\r
\r
/** Return a pointer to the DT table generator.\r
\r
  @param [in]  This         Pointer to the Dynamic Table Factory Protocol.\r
  @param [in]  GeneratorId  The DT table generator ID for the\r
                            requested generator.\r
  @param [out] Generator    Pointer to the requested DT table\r
                            generator.\r
\r
  @retval EFI_SUCCESS           Success.\r
  @retval EFI_INVALID_PARAMETER A parameter is invalid.\r
  @retval EFI_NOT_FOUND         The requested generator is not found\r
                                in the list of registered generators.\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetDtTableGenerator (\r
  IN  CONST EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL  *CONST  This,\r
  IN  CONST DT_TABLE_GENERATOR_ID                         GeneratorId,\r
  OUT CONST DT_TABLE_GENERATOR                   **CONST  Generator\r
  )\r
{\r
  UINT16                            TableId;\r
  EDKII_DYNAMIC_TABLE_FACTORY_INFO  *FactoryInfo;\r
\r
  ASSERT (This != NULL);\r
\r
  FactoryInfo = This->TableFactoryInfo;\r
\r
  if (Generator == NULL) {\r
    DEBUG ((DEBUG_ERROR, "ERROR: Invalid Generator pointer\n"));\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (!IS_GENERATOR_TYPE_DT (GeneratorId)) {\r
    DEBUG ((DEBUG_ERROR, "ERROR: Generator Type is not DT\n"));\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  *Generator = NULL;\r
  TableId    = GET_TABLE_ID (GeneratorId);\r
  if (IS_GENERATOR_NAMESPACE_STD (GeneratorId)) {\r
    if (TableId >= EStdDtTableIdMax) {\r
      ASSERT (TableId < EStdDtTableIdMax);\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    if (FactoryInfo->StdDtTableGeneratorList[TableId] != NULL) {\r
      *Generator = FactoryInfo->StdDtTableGeneratorList[TableId];\r
    } else {\r
      return EFI_NOT_FOUND;\r
    }\r
  } else {\r
    if (TableId > FixedPcdGet16 (PcdMaxCustomDTGenerators)) {\r
      ASSERT (TableId <= FixedPcdGet16 (PcdMaxCustomDTGenerators));\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    if (FactoryInfo->CustomDtTableGeneratorList[TableId] != NULL) {\r
      *Generator = FactoryInfo->CustomDtTableGeneratorList[TableId];\r
    } else {\r
      return EFI_NOT_FOUND;\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/** Register DT table factory generator.\r
\r
  The DT table factory maintains a list of the Standard and OEM DT\r
  table generators.\r
\r
  @param [in]  Generator       Pointer to the DT table generator.\r
\r
  @retval EFI_SUCCESS           The Generator was registered\r
                                successfully.\r
  @retval EFI_INVALID_PARAMETER The Generator ID is invalid or\r
                                the Generator pointer is NULL.\r
  @retval EFI_ALREADY_STARTED   The Generator for the Table ID is\r
                                already registered.\r
**/\r
EFI_STATUS\r
EFIAPI\r
RegisterDtTableGenerator (\r
  IN  CONST DT_TABLE_GENERATOR                *CONST  Generator\r
  )\r
{\r
  UINT16  TableId;\r
\r
  if (Generator == NULL) {\r
    DEBUG ((DEBUG_ERROR, "ERROR: DT register - Invalid Generator\n"));\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (!IS_GENERATOR_TYPE_DT (Generator->GeneratorID)) {\r
    DEBUG ((\r
      DEBUG_ERROR,\r
      "ERROR: DT register - Generator" \\r
      " Type is not DT\n"\r
      ));\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "Registering %s\n", Generator->Description));\r
\r
  TableId = GET_TABLE_ID (Generator->GeneratorID);\r
  if (IS_GENERATOR_NAMESPACE_STD (Generator->GeneratorID)) {\r
    if (TableId >= EStdDtTableIdMax) {\r
      ASSERT (TableId < EStdDtTableIdMax);\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    if (TableFactoryInfo.StdDtTableGeneratorList[TableId] == NULL) {\r
      TableFactoryInfo.StdDtTableGeneratorList[TableId] = Generator;\r
    } else {\r
      return EFI_ALREADY_STARTED;\r
    }\r
  } else {\r
    if (TableId > FixedPcdGet16 (PcdMaxCustomDTGenerators)) {\r
      ASSERT (TableId <= FixedPcdGet16 (PcdMaxCustomDTGenerators));\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    if (TableFactoryInfo.CustomDtTableGeneratorList[TableId] == NULL) {\r
      TableFactoryInfo.CustomDtTableGeneratorList[TableId] = Generator;\r
    } else {\r
      return EFI_ALREADY_STARTED;\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/** Deregister DT generator.\r
\r
  This function is called by the DT table generator to deregister itself\r
  from the DT table factory.\r
\r
  @param [in]  Generator       Pointer to the DT table generator.\r
\r
  @retval EFI_SUCCESS           Success.\r
  @retval EFI_INVALID_PARAMETER The generator is invalid.\r
  @retval EFI_NOT_FOUND         The requested generator is not found\r
                                in the list of registered generators.\r
**/\r
EFI_STATUS\r
EFIAPI\r
DeregisterDtTableGenerator (\r
  IN  CONST DT_TABLE_GENERATOR                *CONST  Generator\r
  )\r
{\r
  UINT16  TableId;\r
\r
  if (Generator == NULL) {\r
    DEBUG ((DEBUG_ERROR, "ERROR: DT deregister - Invalid Generator\n"));\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (!IS_GENERATOR_TYPE_DT (Generator->GeneratorID)) {\r
    DEBUG ((\r
      DEBUG_ERROR,\r
      "ERROR: DT deregister - Generator" \\r
      " Type is not DT\n"\r
      ));\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  TableId = GET_TABLE_ID (Generator->GeneratorID);\r
  if (IS_GENERATOR_NAMESPACE_STD (Generator->GeneratorID)) {\r
    if (TableId >= EStdDtTableIdMax) {\r
      ASSERT (TableId < EStdDtTableIdMax);\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    if (TableFactoryInfo.StdDtTableGeneratorList[TableId] != NULL) {\r
      if (Generator != TableFactoryInfo.StdDtTableGeneratorList[TableId]) {\r
        return EFI_INVALID_PARAMETER;\r
      }\r
\r
      TableFactoryInfo.StdDtTableGeneratorList[TableId] = NULL;\r
    } else {\r
      return EFI_NOT_FOUND;\r
    }\r
  } else {\r
    if (TableId > FixedPcdGet16 (PcdMaxCustomDTGenerators)) {\r
      ASSERT (TableId <= FixedPcdGet16 (PcdMaxCustomDTGenerators));\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    if (TableFactoryInfo.CustomDtTableGeneratorList[TableId] != NULL) {\r
      if (Generator !=\r
          TableFactoryInfo.CustomDtTableGeneratorList[TableId])\r
      {\r
        return EFI_INVALID_PARAMETER;\r
      }\r
\r
      TableFactoryInfo.CustomDtTableGeneratorList[TableId] = NULL;\r
    } else {\r
      return EFI_NOT_FOUND;\r
    }\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "Deregistering %s\n", Generator->Description));\r
  return EFI_SUCCESS;\r
}\r