AmlResourceDataParser.c

Go to the documentation of this file.

 
#include <Parser/AmlResourceDataParser.h>
 
#include <AmlCoreInterface.h>
#include <AmlDbgPrint/AmlDbgPrint.h>
#include <Tree/AmlNode.h>
#include <Tree/AmlTree.h>
 
UINT32
EFIAPI
AmlRdStreamGetRdSize (
  IN  CONST AML_STREAM  *FStream
  )
{
  CONST AML_RD_HEADER  *CurrRdElement;
 
  if (!IS_STREAM (FStream)        ||
      IS_END_OF_STREAM (FStream)  ||
      !IS_STREAM_FORWARD (FStream))
  {
    ASSERT (0);
    return 0;
  }
 
  CurrRdElement = (CONST AML_RD_HEADER *)AmlStreamGetCurrPos (FStream);
  if (CurrRdElement == NULL) {
    ASSERT (0);
    return 0;
  }
 
  // If the resource data element is of the large type, check for overflow.
  if (AML_RD_IS_LARGE (CurrRdElement) &&
      (AmlStreamGetFreeSpace (FStream) <
       sizeof (ACPI_LARGE_RESOURCE_HEADER)))
  {
    return 0;
  }
 
  return AmlRdGetSize (CurrRdElement);
}
 
STATIC
BOOLEAN
EFIAPI
AmlRdCheckFunctionDescNesting (
  IN      CONST AML_STREAM  *FStream,
  IN  OUT       BOOLEAN     *InFunctionDesc
  )
{
  CONST AML_RD_HEADER  *CurrRdElement;
 
  if (!IS_STREAM (FStream)        ||
      IS_END_OF_STREAM (FStream)  ||
      (InFunctionDesc == NULL))
  {
    ASSERT (0);
    return FALSE;
  }
 
  CurrRdElement = AmlStreamGetCurrPos (FStream);
  if (CurrRdElement == NULL) {
    ASSERT (0);
    return FALSE;
  }
 
  // Starting a dependent function descriptor.
  // It is possible to start one when one has already started.
  if (AmlRdCompareDescId (
        CurrRdElement,
        AML_RD_BUILD_SMALL_DESC_ID (
          ACPI_SMALL_START_DEPENDENT_DESCRIPTOR_NAME
          )
        ))
  {
    *InFunctionDesc = TRUE;
    return TRUE;
  }
 
  // Ending a dependent function descriptor.
  if (AmlRdCompareDescId (
        CurrRdElement,
        AML_RD_BUILD_SMALL_DESC_ID (
          ACPI_SMALL_END_DEPENDENT_DESCRIPTOR_NAME
          )
        ))
  {
    if (*InFunctionDesc) {
      *InFunctionDesc = FALSE;
      return TRUE;
    }
 
    // It should not be possible to end a dependent function descriptor
    // when none started.
    return FALSE;
  }
 
  return TRUE;
}
 
BOOLEAN
EFIAPI
AmlRdIsResourceDataBuffer (
  IN  CONST AML_STREAM  *FStream
  )
{
  EFI_STATUS           Status;
  UINT32               FreeSpace;
  AML_STREAM           SubStream;
  CONST AML_RD_HEADER  *CurrRdElement;
  UINT32               CurrRdElementSize;
  BOOLEAN              InFunctionDesc;
 
  if (!IS_STREAM (FStream)        ||
      IS_END_OF_STREAM (FStream)  ||
      !IS_STREAM_FORWARD (FStream))
  {
    ASSERT (0);
    return FALSE;
  }
 
  // Create a sub-stream from the input stream to leave it untouched.
  Status = AmlStreamInitSubStream (FStream, &SubStream);
  if (EFI_ERROR (Status)) {
    ASSERT (0);
    return FALSE;
  }
 
  CurrRdElement = AmlStreamGetCurrPos (&SubStream);
  if (CurrRdElement == NULL) {
    ASSERT (0);
    return FALSE;
  }
 
  // The first element cannot be an end tag.
  if (AmlRdCompareDescId (
        CurrRdElement,
        AML_RD_BUILD_SMALL_DESC_ID (ACPI_SMALL_END_TAG_DESCRIPTOR_NAME)
        ))
  {
    return FALSE;
  }
 
  InFunctionDesc = FALSE;
  while (TRUE) {
    FreeSpace         = AmlStreamGetFreeSpace (&SubStream);
    CurrRdElement     = AmlStreamGetCurrPos (&SubStream);
    CurrRdElementSize = AmlRdStreamGetRdSize (&SubStream);
    if ((FreeSpace == 0)          ||
        (CurrRdElement == NULL)   ||
        (CurrRdElementSize == 0))
    {
      return FALSE;
    }
 
    if (!AmlRdCheckFunctionDescNesting (&SubStream, &InFunctionDesc)) {
      return FALSE;
    }
 
    if (CurrRdElementSize > FreeSpace) {
      return FALSE;
    } else if (CurrRdElementSize == FreeSpace) {
      return TRUE;
    }
 
    // @todo Might want to check the CRC when available.
    // An end tag resource data element must be the last element of the list.
    // Thus the function should have already returned.
    if (AmlRdCompareDescId (
          CurrRdElement,
          AML_RD_BUILD_SMALL_DESC_ID (ACPI_SMALL_END_TAG_DESCRIPTOR_NAME)
          ))
    {
      return FALSE;
    }
 
    Status = AmlStreamProgress (&SubStream, CurrRdElementSize);
    if (EFI_ERROR (Status)) {
      ASSERT (0);
      return FALSE;
    }
  } // while
 
  return FALSE;
}
 
EFI_STATUS
EFIAPI
AmlParseResourceData (
  IN  AML_OBJECT_NODE  *BufferNode,
  IN  AML_STREAM       *FStream
  )
{
  EFI_STATUS           Status;
  AML_DATA_NODE        *NewNode;
  UINT32               FreeSpace;
  CONST AML_RD_HEADER  *CurrRdElement;
  UINT32               CurrRdElementSize;
 
  // Check that BufferNode is an ObjectNode and has a ByteList.
  if (!AmlNodeHasAttribute (BufferNode, AML_HAS_BYTE_LIST)  ||
      !IS_STREAM (FStream)                                  ||
      IS_END_OF_STREAM (FStream)                            ||
      !IS_STREAM_FORWARD (FStream))
  {
    ASSERT (0);
    return EFI_INVALID_PARAMETER;
  }
 
  // Iterate through the resource data elements and create nodes.
  // We assume the Buffer has already been validated as a list of
  // resource data elements, so less checks are made.
  while (TRUE) {
    FreeSpace = AmlStreamGetFreeSpace (FStream);
    if (FreeSpace == 0) {
      break;
    }
 
    CurrRdElement     = (CONST AML_RD_HEADER *)AmlStreamGetCurrPos (FStream);
    CurrRdElementSize = AmlRdStreamGetRdSize (FStream);
 
    Status = AmlCreateDataNode (
               EAmlNodeDataTypeResourceData,
               (CONST UINT8 *)CurrRdElement,
               CurrRdElementSize,
               &NewNode
               );
    if (EFI_ERROR (Status)) {
      ASSERT (0);
      return Status;
    }
 
    Status = AmlVarListAddTailInternal (
               (AML_NODE_HEADER *)BufferNode,
               (AML_NODE_HEADER *)NewNode
               );
    if (EFI_ERROR (Status)) {
      ASSERT (0);
      AmlDeleteTree ((AML_NODE_HEADER *)NewNode);
      return Status;
    }
 
    Status = AmlStreamProgress (FStream, CurrRdElementSize);
    if (EFI_ERROR (Status)) {
      ASSERT (0);
      return Status;
    }
 
    AMLDBG_DUMP_RAW (CurrRdElement, CurrRdElementSize);
 
    // Exit the loop when finding the resource data end tag.
    if (AmlRdCompareDescId (
          CurrRdElement,
          AML_RD_BUILD_SMALL_DESC_ID (ACPI_SMALL_END_TAG_DESCRIPTOR_NAME)
          ))
    {
      if (FreeSpace != CurrRdElementSize) {
        ASSERT (0);
        return EFI_INVALID_PARAMETER;
      }
 
      break;
    }
  } // while
 
  return EFI_SUCCESS;
}