MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Universal / Acpi / AcpiTableDxe / AmlChild.c

/** @file\r
  ACPI Sdt Protocol Driver\r
\r
  Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved. <BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "AcpiTable.h"\r
\r
/**\r
  Return the child objects buffer from AML Handle's buffer.\r
\r
  @param[in]        AmlParentHandle Parent handle.\r
  @param[in]        CurrentBuffer   The current child buffer.\r
  @param[out]       Buffer          On return, points to the next returned child buffer or NULL if there are no\r
                                    child buffer.\r
\r
  @retval EFI_SUCCESS               Success\r
  @retval EFI_INVALID_PARAMETER     AmlParentHandle does not refer to a valid ACPI object.\r
**/\r
EFI_STATUS\r
AmlGetChildFromObjectBuffer (\r
  IN EFI_AML_HANDLE         *AmlParentHandle,\r
  IN UINT8                  *CurrentBuffer,\r
  OUT VOID                  **Buffer\r
  )\r
{\r
  AML_BYTE_ENCODING   *AmlByteEncoding;\r
  UINTN               DataSize;\r
\r
  //\r
  // Root is considered as SCOPE, which has TermList.\r
  // We need return only Object in TermList.\r
  //\r
  while ((UINTN)CurrentBuffer < (UINTN)(AmlParentHandle->Buffer + AmlParentHandle->Size)) {\r
    AmlByteEncoding = AmlSearchByOpByte (CurrentBuffer);\r
    if (AmlByteEncoding == NULL) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
    //\r
    // NOTE: We need return everything, because user might need parse the returned object.\r
    //\r
    if ((AmlByteEncoding->Attribute & AML_IS_NAME_CHAR) == 0) {\r
      *Buffer = CurrentBuffer;\r
      return EFI_SUCCESS;\r
    }\r
\r
    DataSize = AmlGetObjectSize (\r
                 AmlByteEncoding,\r
                 CurrentBuffer,\r
                 (UINTN)AmlParentHandle->Buffer + AmlParentHandle->Size - (UINTN)CurrentBuffer\r
                 );\r
    if (DataSize == 0) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
    CurrentBuffer += DataSize;\r
  }\r
\r
  //\r
  // No more\r
  //\r
  *Buffer = NULL;\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Return the child ACPI objects from Root Handle.\r
\r
  @param[in]        AmlParentHandle Parent handle. It is Root Handle.\r
  @param[in]        AmlHandle       The previously returned handle or NULL to start with the first handle.\r
  @param[out]       Buffer          On return, points to the next returned ACPI handle or NULL if there are no\r
                                    child objects.\r
\r
  @retval EFI_SUCCESS               Success\r
  @retval EFI_INVALID_PARAMETER     ParentHandle is NULL or does not refer to a valid ACPI object.\r
**/\r
EFI_STATUS\r
AmlGetChildFromRoot (\r
  IN EFI_AML_HANDLE         *AmlParentHandle,\r
  IN EFI_AML_HANDLE         *AmlHandle,\r
  OUT VOID                  **Buffer\r
  )\r
{\r
  UINT8               *CurrentBuffer;\r
\r
  if (AmlHandle == NULL) {\r
    //\r
    // First One\r
    //\r
    CurrentBuffer = (VOID *)AmlParentHandle->Buffer;\r
  } else {\r
    CurrentBuffer = (VOID *)(AmlHandle->Buffer + AmlHandle->Size);\r
  }\r
\r
  return AmlGetChildFromObjectBuffer (AmlParentHandle, CurrentBuffer, Buffer);\r
}\r
\r
/**\r
  Return the child objects buffer from AML Handle's option list.\r
\r
  @param[in]        AmlParentHandle Parent handle.\r
  @param[in]        AmlHandle       The current child handle.\r
  @param[out]       Buffer          On return, points to the next returned child buffer or NULL if there are no\r
                                    child buffer.\r
\r
  @retval EFI_SUCCESS               Success\r
  @retval EFI_INVALID_PARAMETER     AmlParentHandle does not refer to a valid ACPI object.\r
**/\r
EFI_STATUS\r
AmlGetChildFromOptionList (\r
  IN EFI_AML_HANDLE         *AmlParentHandle,\r
  IN EFI_AML_HANDLE         *AmlHandle,\r
  OUT VOID                  **Buffer\r
  )\r
{\r
  EFI_ACPI_DATA_TYPE  DataType;\r
  VOID                *Data;\r
  UINTN               DataSize;\r
  AML_OP_PARSE_INDEX  Index;\r
  EFI_STATUS          Status;\r
  AML_OP_PARSE_INDEX  MaxTerm;\r
\r
  Index = AML_OP_PARSE_INDEX_GET_TERM1;\r
  MaxTerm = AmlParentHandle->AmlByteEncoding->MaxIndex;\r
  while (Index <= MaxTerm) {\r
    Status = AmlParseOptionHandleCommon (\r
               AmlParentHandle,\r
               (AML_OP_PARSE_INDEX)Index,\r
               &DataType,\r
               (VOID **)&Data,\r
               &DataSize\r
               );\r
    if (EFI_ERROR (Status)) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
    if (DataType == EFI_ACPI_DATA_TYPE_NONE) {\r
      //\r
      // Not found\r
      //\r
      break;\r
    }\r
\r
    //\r
    // Find it, and Check Data\r
    //\r
    if ((DataType == EFI_ACPI_DATA_TYPE_CHILD) &&\r
        ((UINTN)AmlHandle->Buffer < (UINTN)Data)) {\r
      //\r
      // Buffer < Data means current node is next one\r
      //\r
      *Buffer = Data;\r
      return EFI_SUCCESS;\r
    }\r
    //\r
    // Not Child\r
    //\r
    Index ++;\r
  }\r
\r
  *Buffer = NULL;\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Return the child objects buffer from AML Handle's object child list.\r
\r
  @param[in]        AmlParentHandle Parent handle.\r
  @param[in]        AmlHandle       The current child handle.\r
  @param[out]       Buffer          On return, points to the next returned child buffer or NULL if there are no\r
                                    child buffer.\r
\r
  @retval EFI_SUCCESS               Success\r
  @retval EFI_INVALID_PARAMETER     AmlParentHandle does not refer to a valid ACPI object.\r
**/\r
EFI_STATUS\r
AmlGetChildFromObjectChildList (\r
  IN EFI_AML_HANDLE         *AmlParentHandle,\r
  IN EFI_AML_HANDLE         *AmlHandle,\r
  OUT VOID                  **Buffer\r
  )\r
{\r
  EFI_STATUS          Status;\r
  UINT8               *CurrentBuffer;\r
\r
  CurrentBuffer = NULL;\r
\r
  if ((AmlParentHandle->AmlByteEncoding->Attribute & AML_HAS_CHILD_OBJ) == 0) {\r
    //\r
    // No ObjectList\r
    //\r
    *Buffer = NULL;\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // Do we need add node within METHOD?\r
  // Yes, just add Object is OK. But we need filter NameString for METHOD invoke.\r
  //\r
\r
  //\r
  // Now, we get the last node.\r
  //\r
  Status = AmlGetOffsetAfterLastOption (AmlParentHandle, &CurrentBuffer);\r
  if (EFI_ERROR (Status)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Go through all the reset buffer.\r
  //\r
  if ((UINTN)AmlHandle->Buffer < (UINTN)CurrentBuffer) {\r
    //\r
    // Buffer < Data means next node is first object\r
    //\r
  } else if ((UINTN)AmlHandle->Buffer + AmlHandle->Size < (UINTN)AmlParentHandle->Buffer + AmlParentHandle->Size) {\r
    //\r
    // There is still more node\r
    //\r
    CurrentBuffer = AmlHandle->Buffer + AmlHandle->Size;\r
  } else {\r
    //\r
    // No more data\r
    //\r
    *Buffer = NULL;\r
    return EFI_SUCCESS;\r
  }\r
\r
  return AmlGetChildFromObjectBuffer (AmlParentHandle, CurrentBuffer, Buffer);\r
}\r
\r
/**\r
  Return the child ACPI objects from Non-Root Handle.\r
\r
  @param[in]        AmlParentHandle Parent handle. It is Non-Root Handle.\r
  @param[in]        AmlHandle       The previously returned handle or NULL to start with the first handle.\r
  @param[out]       Buffer          On return, points to the next returned ACPI handle or NULL if there are no\r
                                    child objects.\r
\r
  @retval EFI_SUCCESS               Success\r
  @retval EFI_INVALID_PARAMETER     ParentHandle is NULL or does not refer to a valid ACPI object.\r
**/\r
EFI_STATUS\r
AmlGetChildFromNonRoot (\r
  IN EFI_AML_HANDLE         *AmlParentHandle,\r
  IN EFI_AML_HANDLE         *AmlHandle,\r
  OUT VOID                  **Buffer\r
  )\r
{\r
  EFI_STATUS          Status;\r
\r
  if (AmlHandle == NULL) {\r
    //\r
    // NULL means first one\r
    //\r
    AmlHandle = AmlParentHandle;\r
  }\r
\r
  //\r
  // 1. Get Option\r
  //\r
  Status = AmlGetChildFromOptionList (AmlParentHandle, AmlHandle, Buffer);\r
  if (EFI_ERROR (Status)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  if (*Buffer != NULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // 2. search ObjectList\r
  //\r
  return AmlGetChildFromObjectChildList (AmlParentHandle, AmlHandle, Buffer);\r
}\r