MdePkg/Include/Protocol/AcpiSystemDescriptionTable.h File Reference
|
Data Structures |
struct | EFI_ACPI_SDT_HEADER |
struct | _EFI_ACPI_SDT_PROTOCOL |
Defines |
#define | EFI_ACPI_SDT_PROTOCOL_GUID { 0xeb97088e, 0xcfdf, 0x49c6, { 0xbe, 0x4b, 0xd9, 0x6, 0xa5, 0xb2, 0xe, 0x86 }} |
#define | EFI_ACPI_TABLE_VERSION_NONE (1 << 0) |
#define | EFI_ACPI_TABLE_VERSION_1_0B (1 << 1) |
#define | EFI_ACPI_TABLE_VERSION_2_0 (1 << 2) |
#define | EFI_ACPI_TABLE_VERSION_3_0 (1 << 3) |
#define | EFI_ACPI_TABLE_VERSION_4_0 (1 << 4) |
#define | EFI_ACPI_TABLE_VERSION_5_0 (1 << 5) |
#define | EFI_ACPI_DATA_TYPE_NONE 0 |
#define | EFI_ACPI_DATA_TYPE_OPCODE 1 |
#define | EFI_ACPI_DATA_TYPE_NAME_STRING 2 |
#define | EFI_ACPI_DATA_TYPE_OP 3 |
#define | EFI_ACPI_DATA_TYPE_UINT 4 |
#define | EFI_ACPI_DATA_TYPE_STRING 5 |
#define | EFI_ACPI_DATA_TYPE_CHILD 6 |
Typedefs |
typedef UINT32 | EFI_ACPI_TABLE_VERSION |
typedef VOID * | EFI_ACPI_HANDLE |
typedef UINT32 | EFI_ACPI_DATA_TYPE |
typedef EFI_STATUS(EFIAPI * | EFI_ACPI_NOTIFICATION_FN )(IN EFI_ACPI_SDT_HEADER *Table, IN EFI_ACPI_TABLE_VERSION Version, IN UINTN TableKey) |
typedef EFI_STATUS(EFIAPI * | EFI_ACPI_GET_ACPI_TABLE2 )(IN UINTN Index, OUT EFI_ACPI_SDT_HEADER **Table, OUT EFI_ACPI_TABLE_VERSION *Version, OUT UINTN *TableKey) |
typedef EFI_STATUS(EFIAPI * | EFI_ACPI_REGISTER_NOTIFY )(IN BOOLEAN Register, IN EFI_ACPI_NOTIFICATION_FN Notification) |
typedef EFI_STATUS(EFIAPI * | EFI_ACPI_OPEN )(IN VOID *Buffer, OUT EFI_ACPI_HANDLE *Handle) |
typedef EFI_STATUS(EFIAPI * | EFI_ACPI_OPEN_SDT )(IN UINTN TableKey, OUT EFI_ACPI_HANDLE *Handle) |
typedef EFI_STATUS(EFIAPI * | EFI_ACPI_CLOSE )(IN EFI_ACPI_HANDLE Handle) |
typedef EFI_STATUS(EFIAPI * | EFI_ACPI_GET_CHILD )(IN EFI_ACPI_HANDLE ParentHandle, IN OUT EFI_ACPI_HANDLE *Handle) |
typedef EFI_STATUS(EFIAPI * | EFI_ACPI_GET_OPTION )(IN EFI_ACPI_HANDLE Handle, IN UINTN Index, OUT EFI_ACPI_DATA_TYPE *DataType, OUT CONST VOID **Data, OUT UINTN *DataSize) |
typedef EFI_STATUS(EFIAPI * | EFI_ACPI_SET_OPTION )(IN EFI_ACPI_HANDLE Handle, IN UINTN Index, IN CONST VOID *Data, IN UINTN DataSize) |
typedef EFI_STATUS(EFIAPI * | EFI_ACPI_FIND_PATH )(IN EFI_ACPI_HANDLE HandleIn, IN VOID *AcpiPath, OUT EFI_ACPI_HANDLE *HandleOut) |
typedef struct
_EFI_ACPI_SDT_PROTOCOL | EFI_ACPI_SDT_PROTOCOL |
Variables |
EFI_GUID | gEfiAcpiSdtProtocolGuid |
Detailed Description
This protocol provides services for creating ACPI system description tables.
Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Define Documentation
#define EFI_ACPI_DATA_TYPE_CHILD 6 |
#define EFI_ACPI_DATA_TYPE_NAME_STRING 2 |
#define EFI_ACPI_DATA_TYPE_NONE 0 |
#define EFI_ACPI_DATA_TYPE_OP 3 |
#define EFI_ACPI_DATA_TYPE_OPCODE 1 |
#define EFI_ACPI_DATA_TYPE_STRING 5 |
#define EFI_ACPI_DATA_TYPE_UINT 4 |
#define EFI_ACPI_SDT_PROTOCOL_GUID { 0xeb97088e, 0xcfdf, 0x49c6, { 0xbe, 0x4b, 0xd9, 0x6, 0xa5, 0xb2, 0xe, 0x86 }} |
#define EFI_ACPI_TABLE_VERSION_1_0B (1 << 1) |
#define EFI_ACPI_TABLE_VERSION_2_0 (1 << 2) |
#define EFI_ACPI_TABLE_VERSION_3_0 (1 << 3) |
#define EFI_ACPI_TABLE_VERSION_4_0 (1 << 4) |
#define EFI_ACPI_TABLE_VERSION_5_0 (1 << 5) |
#define EFI_ACPI_TABLE_VERSION_NONE (1 << 0) |
Typedef Documentation
Close an ACPI handle.
- Parameters:
-
[in] | Handle | Returns the handle. |
- Return values:
-
| EFI_SUCCESS | Success |
| EFI_INVALID_PARAMETER | Handle is NULL or does not refer to a valid ACPI object. |
Returns the handle of the ACPI object representing the specified ACPI path
- Parameters:
-
[in] | HandleIn | Points to the handle of the object representing the starting point for the path search. |
[in] | AcpiPath | Points to the ACPI path, which conforms to the ACPI encoded path format. |
[out] | HandleOut | On return, points to the ACPI object which represents AcpiPath, relative to HandleIn. |
- Return values:
-
| EFI_SUCCESS | Success |
| EFI_INVALID_PARAMETER | HandleIn is NULL or does not refer to a valid ACPI object. |
Returns a requested ACPI table.
The GetAcpiTable() function returns a pointer to a buffer containing the ACPI table associated with the Index that was input. The following structures are not considered elements in the list of ACPI tables:
- Root System Description Pointer (RSD_PTR)
- Root System Description Table (RSDT)
- Extended System Description Table (XSDT) Version is updated with a bit map containing all the versions of ACPI of which the table is a member. For tables installed via the EFI_ACPI_TABLE_PROTOCOL.InstallAcpiTable() interface, the function returns the value of EFI_ACPI_STD_PROTOCOL.AcpiVersion.
- Parameters:
-
[in] | Index | The zero-based index of the table to retrieve. |
[out] | Table | Pointer for returning the table buffer. |
[out] | Version | On return, updated with the ACPI versions to which this table belongs. Type EFI_ACPI_TABLE_VERSION is defined in "Related Definitions" in the EFI_ACPI_SDT_PROTOCOL. |
[out] | TableKey | On return, points to the table key for the specified ACPI system definition table. This is identical to the table key used in the EFI_ACPI_TABLE_PROTOCOL. The TableKey can be passed to EFI_ACPI_TABLE_PROTOCOL.UninstallAcpiTable() to uninstall the table. |
- Return values:
-
| EFI_SUCCESS | The function completed successfully. |
| EFI_NOT_FOUND | The requested index is too large and a table was not found. |
Return the child ACPI objects.
- Parameters:
-
[in] | ParentHandle | Parent handle. |
[in,out] | Handle | On entry, points to the previously returned handle or NULL to start with the first handle. On return, points to the next returned ACPI handle or NULL if there are no child objects. |
- Return values:
-
| EFI_SUCCESS | Success |
| EFI_INVALID_PARAMETER | ParentHandle is NULL or does not refer to a valid ACPI object. |
Retrieve information about an ACPI object.
- Parameters:
-
[in] | Handle | ACPI object handle. |
[in] | Index | Index of the data to retrieve from the object. In general, indexes read from left-to-right in the ACPI encoding, with index 0 always being the ACPI opcode. |
[out] | DataType | Points to the returned data type or EFI_ACPI_DATA_TYPE_NONE if no data exists for the specified index. |
[out] | Data | Upon return, points to the pointer to the data. |
[out] | DataSize | Upon return, points to the size of Data. |
- Return values:
-
Create a handle from an ACPI opcode
- Parameters:
-
[in] | Buffer | Points to the ACPI opcode. |
[out] | Handle | Upon return, holds the handle. |
- Return values:
-
| EFI_SUCCESS | Success |
| EFI_INVALID_PARAMETER | Buffer is NULL or Handle is NULL or Buffer points to an invalid opcode. |
Create a handle for the first ACPI opcode in an ACPI system description table.
- Parameters:
-
[in] | TableKey | The table key for the ACPI table, as returned by GetTable(). |
[out] | Handle | On return, points to the newly created ACPI handle. |
- Return values:
-
| EFI_SUCCESS | Handle created successfully. |
| EFI_NOT_FOUND | TableKey does not refer to a valid ACPI table. |
Register or unregister a callback when an ACPI table is installed.
This function registers or unregisters a function which will be called whenever a new ACPI table is installed.
- Parameters:
-
[in] | Register | If TRUE, then the specified function will be registered. If FALSE, then the specified function will be unregistered. |
[in] | Notification | Points to the callback function to be registered or unregistered. |
- Return values:
-
| EFI_SUCCESS | Callback successfully registered or unregistered. |
| EFI_INVALID_PARAMETER | Notification is NULL |
| EFI_INVALID_PARAMETER | Register is FALSE and Notification does not match a known registration function. |
Change information about an ACPI object.
- Parameters:
-
[in] | Handle | ACPI object handle. |
[in] | Index | Index of the data to retrieve from the object. In general, indexes read from left-to-right in the ACPI encoding, with index 0 always being the ACPI opcode. |
[in] | Data | Points to the data. |
[in] | DataSize | The size of the Data. |
- Return values:
-
| EFI_SUCCESS | Success |
| EFI_INVALID_PARAMETER | Handle is NULL or does not refer to a valid ACPI object. |
| EFI_BAD_BUFFER_SIZE | Data cannot be accommodated in the space occupied by the option. |
Variable Documentation