Aml.h

Go to the documentation of this file.

 
#ifndef AML_H_
#define AML_H_
 
#include <AmlDefines.h>
#include <AmlInclude.h>
#include <IndustryStandard/AcpiAml.h>
 
#if !defined (MDEPKG_NDEBUG)
#define AML_OPCODE_DEF(str, OpCode)  str, OpCode
#else
#define AML_OPCODE_DEF(str, OpCode)  OpCode
#endif // MDEPKG_NDEBUG
 
typedef enum EAmlParseFormat {
  EAmlNone = 0,       
  EAmlUInt8,          
  EAmlUInt16,         
  EAmlUInt32,         
  EAmlUInt64,         
  EAmlObject,         
  EAmlName,           
  EAmlString,         
  EAmlFieldPkgLen,    
  EAmlParseFormatMax  
} AML_PARSE_FORMAT;
 
typedef UINT32 AML_OP_ATTRIBUTE;
 
#define AML_HAS_PKG_LENGTH  0x00001U
 
#define AML_IS_NAME_CHAR  0x00002U
 
#define AML_HAS_CHILD_OBJ  0x00004U
 
#define AML_HAS_BYTE_LIST  0x00008U
 
#define AML_HAS_FIELD_LIST  0x00010U
 
#define AML_IS_FIELD_ELEMENT  0x00020U
 
#define AML_IN_NAMESPACE  0x10000U
 
#define AML_IS_PSEUDO_OPCODE  0x20000U
 
typedef struct _AML_BYTE_ENCODING {
  // Enable this field for debug.
 #if !defined (MDEPKG_NDEBUG)
  CONST CHAR8         *Str;
 #endif // MDEPKG_NDEBUG
 
  UINT8               OpCode;
 
  UINT8               SubOpCode;
 
  EAML_PARSE_INDEX    MaxIndex;
 
  EAML_PARSE_INDEX    NameIndex;
 
  AML_PARSE_FORMAT    Format[EAmlParseIndexMax];
 
  AML_OP_ATTRIBUTE    Attribute;
} AML_BYTE_ENCODING;
 
CONST
AML_BYTE_ENCODING *
EFIAPI
AmlGetByteEncoding (
  IN  CONST UINT8  *Buffer
  );
 
CONST
AML_BYTE_ENCODING *
EFIAPI
AmlGetByteEncodingByOpCode (
  IN  UINT8  OpCode,
  IN  UINT8  SubOpCode
  );
 
CONST
AML_BYTE_ENCODING *
EFIAPI
AmlGetFieldEncoding (
  IN  CONST UINT8  *Buffer
  );
 
CONST
AML_BYTE_ENCODING *
EFIAPI
AmlGetFieldEncodingByOpCode (
  IN  UINT8  OpCode,
  IN  UINT8  SubOpCode
  );
 
// Enable this function for debug.
#if !defined (MDEPKG_NDEBUG)
 
CONST
CHAR8 *
AmlGetOpCodeStr (
  IN  UINT8  OpCode,
  IN  UINT8  SubOpCode
  );
 
CONST
CHAR8 *
AmlGetFieldOpCodeStr (
  IN  UINT8  OpCode,
  IN  UINT8  SubOpCode
  );
 
#endif // MDEPKG_NDEBUG
 
BOOLEAN
EFIAPI
AmlIsOpCodeValid (
  IN  UINT8  OpCode,
  IN  UINT8  SubOpCode
  );
 
EAML_NODE_DATA_TYPE
EFIAPI
AmlTypeToNodeDataType (
  IN  AML_PARSE_FORMAT  AmlType
  );
 
UINT32
EFIAPI
AmlGetPkgLength (
  IN  CONST UINT8   *Buffer,
  OUT       UINT32  *PkgLength
  );
 
UINT8
EFIAPI
AmlSetPkgLength (
  IN  UINT32  Length,
  OUT UINT8   *Buffer
  );
 
UINT8
EFIAPI
AmlComputePkgLengthWidth (
  IN  UINT32  Length
  );
 
EFI_STATUS
EFIAPI
AmlComputePkgLength (
  IN  UINT32  Length,
  OUT UINT32  *PkgLen
  );
 
#endif // AML_H_