AcpiSdt.h

Go to the documentation of this file.

 
#ifndef _ACPI_SDT_H_
#define _ACPI_SDT_H_
 
//
// Privacy data structure
//
 
//
// ACPI Notify Linked List Signature.
//
#define EFI_ACPI_NOTIFY_LIST_SIGNATURE  SIGNATURE_32 ('E', 'A', 'N', 'L')
 
//
// ACPI Notify List Entry definition.
//
//  Signature must be set to EFI_ACPI_NOTIFY_LIST_SIGNATURE
//  Link is the linked list data.
//  Notification is the callback function.
//
typedef struct {
  UINT32                      Signature;
  LIST_ENTRY                  Link;
  EFI_ACPI_NOTIFICATION_FN    Notification;
} EFI_ACPI_NOTIFY_LIST;
 
//
// Containment record for ACPI Notify linked list.
//
#define EFI_ACPI_NOTIFY_LIST_FROM_LINK(_link)  CR (_link, EFI_ACPI_NOTIFY_LIST, Link, EFI_ACPI_NOTIFY_LIST_SIGNATURE)
 
typedef struct _AML_BYTE_ENCODING  AML_BYTE_ENCODING;
typedef struct _EFI_AML_NODE_LIST  EFI_AML_NODE_LIST;
 
//
// AML Node Linked List Signature.
//
#define EFI_AML_NODE_LIST_SIGNATURE  SIGNATURE_32 ('E', 'A', 'M', 'L')
 
//
// AML Node Linked List Entry definition.
//
//  Signature must be set to EFI_AML_NODE_LIST_SIGNATURE
//  Link is the linked list data.
//  Name is the ACPI node name.
//         This is listed for PATH finding.
//  Buffer is the ACPI node buffer pointer, the first/second bytes are opcode.
//         This buffer should not be freed.
//  Size is the total size of this ACPI node buffer.
//  Children is the children linked list of this node.
//
 
struct _EFI_AML_NODE_LIST {
  UINT32               Signature;
  UINT8                Name[AML_NAME_SEG_SIZE];
  UINT8                *Buffer;
  UINTN                Size;
  LIST_ENTRY           Link;
  LIST_ENTRY           Children;
  EFI_AML_NODE_LIST    *Parent;
  AML_BYTE_ENCODING    *AmlByteEncoding;
};
 
//
// Containment record for AML Node linked list.
//
#define EFI_AML_NODE_LIST_FROM_LINK(_link)  CR (_link, EFI_AML_NODE_LIST, Link, EFI_AML_NODE_LIST_SIGNATURE)
 
//
// AML Handle Signature.
//
#define EFI_AML_HANDLE_SIGNATURE       SIGNATURE_32 ('E', 'A', 'H', 'S')
#define EFI_AML_ROOT_HANDLE_SIGNATURE  SIGNATURE_32 ('E', 'A', 'R', 'H')
 
//
// AML Handle Entry definition.
//
//  Signature must be set to EFI_AML_HANDLE_SIGNATURE or EFI_AML_ROOT_HANDLE_SIGNATURE
//  Buffer is the ACPI node buffer pointer, the first/second bytes are opcode.
//         This buffer should not be freed.
//  Size is the total size of this ACPI node buffer.
//
typedef struct {
  UINT32               Signature;
  UINT8                *Buffer;
  UINTN                Size;
  AML_BYTE_ENCODING    *AmlByteEncoding;
  BOOLEAN              Modified;
} EFI_AML_HANDLE;
 
typedef UINT32 AML_OP_PARSE_INDEX;
 
#define AML_OP_PARSE_INDEX_GET_OPCODE  0
#define AML_OP_PARSE_INDEX_GET_TERM1   1
#define AML_OP_PARSE_INDEX_GET_TERM2   2
#define AML_OP_PARSE_INDEX_GET_TERM3   3
#define AML_OP_PARSE_INDEX_GET_TERM4   4
#define AML_OP_PARSE_INDEX_GET_TERM5   5
#define AML_OP_PARSE_INDEX_GET_TERM6   6
#define AML_OP_PARSE_INDEX_GET_SIZE    (AML_OP_PARSE_INDEX)-1
 
typedef UINT32 AML_OP_PARSE_FORMAT;
#define AML_NONE    0
#define AML_OPCODE  1
#define AML_UINT8   2
#define AML_UINT16  3
#define AML_UINT32  4
#define AML_UINT64  5
#define AML_NAME    6
#define AML_STRING  7
#define AML_OBJECT  8
 
typedef UINT32 AML_OP_ATTRIBUTE;
#define AML_HAS_PKG_LENGTH  0x1          // It is ACPI attribute - if OpCode has PkgLength
#define AML_IS_NAME_CHAR    0x2          // It is ACPI attribute - if this is NameChar
#define AML_HAS_CHILD_OBJ   0x4          // it is ACPI attribute - if OpCode has Child Object.
#define AML_IN_NAMESPACE    0x10000      // It is UEFI SDT attribute - if OpCode will be in NameSpace
                                         // NOTE; Not all OBJECT will be in NameSpace
                                         // For example, BankField | CreateBitField | CreateByteField | CreateDWordField |
                                         //   CreateField | CreateQWordField | CreateWordField | Field | IndexField.
 
struct _AML_BYTE_ENCODING {
  UINT8                  OpCode;
  UINT8                  SubOpCode;
  AML_OP_PARSE_INDEX     MaxIndex;
  AML_OP_PARSE_FORMAT    Format[6];
  AML_OP_ATTRIBUTE       Attribute;
};
 
//
// AcpiSdt protocol declaration
//
 
EFI_STATUS
EFIAPI
GetAcpiTable2 (
  IN  UINTN                   Index,
  OUT EFI_ACPI_SDT_HEADER     **Table,
  OUT EFI_ACPI_TABLE_VERSION  *Version,
  OUT UINTN                   *TableKey
  );
 
EFI_STATUS
EFIAPI
RegisterNotify (
  IN BOOLEAN                   Register,
  IN EFI_ACPI_NOTIFICATION_FN  Notification
  );
 
EFI_STATUS
EFIAPI
OpenSdt (
  IN    UINTN            TableKey,
  OUT   EFI_ACPI_HANDLE  *Handle
  );
 
EFI_STATUS
EFIAPI
Open (
  IN    VOID             *Buffer,
  OUT   EFI_ACPI_HANDLE  *Handle
  );
 
EFI_STATUS
EFIAPI
Close (
  IN EFI_ACPI_HANDLE  Handle
  );
 
EFI_STATUS
EFIAPI
GetOption (
  IN        EFI_ACPI_HANDLE     Handle,
  IN        UINTN               Index,
  OUT       EFI_ACPI_DATA_TYPE  *DataType,
  OUT CONST VOID                **Data,
  OUT       UINTN               *DataSize
  );
 
EFI_STATUS
EFIAPI
SetOption (
  IN        EFI_ACPI_HANDLE  Handle,
  IN        UINTN            Index,
  IN CONST  VOID             *Data,
  IN        UINTN            DataSize
  );
 
EFI_STATUS
EFIAPI
GetChild (
  IN EFI_ACPI_HANDLE      ParentHandle,
  IN OUT EFI_ACPI_HANDLE  *Handle
  );
 
EFI_STATUS
EFIAPI
FindPath (
  IN    EFI_ACPI_HANDLE  HandleIn,
  IN    VOID             *AcpiPath,
  OUT   EFI_ACPI_HANDLE  *HandleOut
  );
 
//
// ACPI SDT function
//
 
EFI_STATUS
SdtOpenEx (
  IN    VOID             *Buffer,
  IN    UINTN            BufferSize,
  OUT   EFI_ACPI_HANDLE  *Handle
  );
 
//
// AML support function
//
 
EFI_STATUS
AmlGetNameStringSize (
  IN  UINT8  *Buffer,
  OUT UINTN  *BufferSize
  );
 
UINTN
AmlGetPkgLength (
  IN UINT8   *Buffer,
  OUT UINTN  *PkgLength
  );
 
EFI_ACPI_DATA_TYPE
AmlTypeToAcpiType (
  IN AML_OP_PARSE_FORMAT  AmlType
  );
 
AML_BYTE_ENCODING *
AmlSearchByOpByte (
  IN UINT8  *OpByteBuffer
  );
 
UINTN
AmlGetObjectSize (
  IN AML_BYTE_ENCODING  *AmlByteEncoding,
  IN UINT8              *Buffer,
  IN UINTN              MaxBufferSize
  );
 
CHAR8 *
AmlGetObjectName (
  IN EFI_AML_HANDLE  *AmlHandle
  );
 
EFI_STATUS
AmlParseOptionHandleCommon (
  IN EFI_AML_HANDLE       *AmlHandle,
  IN AML_OP_PARSE_INDEX   Index,
  OUT EFI_ACPI_DATA_TYPE  *DataType,
  OUT VOID                **Data,
  OUT UINTN               *DataSize
  );
 
EFI_STATUS
AmlGetOffsetAfterLastOption (
  IN EFI_AML_HANDLE  *AmlHandle,
  OUT UINT8          **Buffer
  );
 
EFI_STATUS
AmlGetChildFromRoot (
  IN EFI_AML_HANDLE  *AmlParentHandle,
  IN EFI_AML_HANDLE  *AmlHandle,
  OUT VOID           **Buffer
  );
 
EFI_STATUS
AmlGetChildFromNonRoot (
  IN EFI_AML_HANDLE  *AmlParentHandle,
  IN EFI_AML_HANDLE  *AmlHandle,
  OUT VOID           **Buffer
  );
 
UINT8 *
AmlNameFromAslName (
  IN UINT8  *AslPath
  );
 
EFI_STATUS
AmlFindPath (
  IN    EFI_AML_HANDLE  *AmlHandle,
  IN    UINT8           *AmlPath,
  OUT   VOID            **Buffer,
  IN    BOOLEAN         FromRoot
  );
 
VOID
AmlPrintNameString (
  IN UINT8  *Buffer
  );
 
VOID
AmlPrintNameSeg (
  IN UINT8  *Buffer
  );
 
BOOLEAN
AmlIsRootPath (
  IN UINT8  *Buffer
  );
 
#endif