DynamicTablesPkg: Add AmlSetRdListCheckSum()

[mirror_edk2.git] / DynamicTablesPkg / Library / Common / AmlLib / Utils / AmlUtility.h

/** @file\r
  AML Utility.\r
\r
  Copyright (c) 2019 - 2020, Arm Limited. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#ifndef AML_UTILITY_H_\r
#define AML_UTILITY_H_\r
\r
#include <AmlNodeDefines.h>\r
\r
/** This function computes and updates the ACPI table checksum.\r
\r
  @param  [in]  AcpiTable   Pointer to an Acpi table.\r
\r
  @retval EFI_SUCCESS   The function completed successfully.\r
  @retval EFI_INVALID_PARAMETER   Invalid parameter.\r
**/\r
EFI_STATUS\r
EFIAPI\r
AcpiPlatformChecksum (\r
  IN  EFI_ACPI_DESCRIPTION_HEADER  * AcpiTable\r
  );\r
\r
/** Compute the size of a tree/sub-tree.\r
\r
  @param  [in]      Node      Node to compute the size.\r
  @param  [in, out] Size      Pointer holding the computed size.\r
\r
  @retval EFI_SUCCESS             The function completed successfully.\r
  @retval EFI_INVALID_PARAMETER   Invalid parameter.\r
**/\r
EFI_STATUS\r
EFIAPI\r
AmlComputeSize (\r
  IN      CONST AML_NODE_HEADER   * Node,\r
  IN  OUT       UINT32            * Size\r
  );\r
\r
/** Set the value contained in an integer node.\r
\r
  The OpCode is updated accordingly to the new value\r
  (e.g.: If the original value was a UINT8 value, then the OpCode\r
         would be AML_BYTE_PREFIX. If it the new value is a UINT16\r
         value then the OpCode will be updated to AML_WORD_PREFIX).\r
\r
  @param  [in]  Node            Pointer to an integer node.\r
                                Must be an object node.\r
  @param  [in]  NewValue        New value to write in the integer node.\r
  @param  [out] ValueWidthDiff  Difference in number of bytes used to store\r
                                the new value.\r
                                Can be negative.\r
\r
  @retval EFI_SUCCESS             The function completed successfully.\r
  @retval EFI_INVALID_PARAMETER   Invalid parameter.\r
  @retval EFI_OUT_OF_RESOURCES    Could not allocate memory.\r
**/\r
EFI_STATUS\r
EFIAPI\r
AmlNodeSetIntegerValue (\r
  IN  AML_OBJECT_NODE   * Node,\r
  IN  UINT64              NewValue,\r
  OUT INT8              * ValueWidthDiff\r
  );\r
\r
/** Propagate information up the tree.\r
\r
  The information can be a new size, a new number of arguments.\r
\r
  @param  [in]  Node          Pointer to a node.\r
                              Must be a root node or an object node.\r
  @param  [in]  IsIncrement   Choose the operation to do:\r
                               - TRUE:  Increment the Node's size and\r
                                        the Node's count;\r
                               - FALSE: Decrement the Node's size and\r
                                        the Node's count.\r
  @param  [in]  Diff          Value to add/subtract to the Node's size.\r
  @param  [in]  NodeCount     Number of nodes added/removed.\r
\r
  @retval EFI_SUCCESS             The function completed successfully.\r
  @retval EFI_INVALID_PARAMETER   Invalid parameter.\r
**/\r
EFI_STATUS\r
EFIAPI\r
AmlPropagateInformation (\r
  IN  AML_NODE_HEADER   * Node,\r
  IN  BOOLEAN             IsIncrement,\r
  IN  UINT32              Diff,\r
  IN  UINT8               NodeCount\r
  );\r
\r
/** Find and set the EndTag's Checksum of a list of Resource Data elements.\r
\r
  Lists of Resource Data elements end with an EndTag (most of the time). This\r
  function finds the EndTag (if present) in a list of Resource Data elements\r
  and sets the checksum.\r
\r
  ACPI 6.4, s6.4.2.9 "End Tag":\r
  "This checksum is generated such that adding it to the sum of all the data\r
  bytes will produce a zero sum."\r
  "If the checksum field is zero, the resource data is treated as if the\r
  checksum operation succeeded. Configuration proceeds normally."\r
\r
  To avoid re-computing checksums, if a new resource data elements is\r
  added/removed/modified in a list of resource data elements, the AmlLib\r
  resets the checksum to 0.\r
\r
  @param [in]  BufferOpNode   Node having a list of Resource Data elements.\r
  @param [in]  CheckSum       CheckSum to store in the EndTag.\r
                              To ignore/avoid computing the checksum,\r
                              give 0.\r
\r
  @retval EFI_SUCCESS             The function completed successfully.\r
  @retval EFI_INVALID_PARAMETER   Invalid parameter.\r
  @retval EFI_NOT_FOUND           No EndTag found.\r
**/\r
EFI_STATUS\r
EFIAPI\r
AmlSetRdListCheckSum (\r
  IN  AML_OBJECT_NODE   * BufferOpNode,\r
  IN  UINT8               CheckSum\r
  );\r
\r
#endif // AML_UTILITY_H_\r
\r