iPXE
Data Structures | Defines | Typedefs | Functions | Variables
AcpiTable.h File Reference

The file provides the protocol to install or remove an ACPI table from a platform. More...

Go to the source code of this file.

Data Structures

struct  _EFI_ACPI_TABLE_PROTOCOL
 The EFI_ACPI_TABLE_PROTOCOL provides the ability for a component to install and uninstall ACPI tables from a platform. More...

Defines

#define EFI_ACPI_TABLE_PROTOCOL_GUID   { 0xffe06bdd, 0x6107, 0x46a6, { 0x7b, 0xb2, 0x5a, 0x9c, 0x7e, 0xc5, 0x27, 0x5c }}

Typedefs

typedef struct
_EFI_ACPI_TABLE_PROTOCOL 
EFI_ACPI_TABLE_PROTOCOL
typedef EFI_STATUS(EFIAPIEFI_ACPI_TABLE_INSTALL_ACPI_TABLE )(IN EFI_ACPI_TABLE_PROTOCOL *This, IN VOID *AcpiTableBuffer, IN UINTN AcpiTableBufferSize, OUT UINTN *TableKey)
 The InstallAcpiTable() function allows a caller to install an ACPI table.
typedef EFI_STATUS(EFIAPIEFI_ACPI_TABLE_UNINSTALL_ACPI_TABLE )(IN EFI_ACPI_TABLE_PROTOCOL *This, IN UINTN TableKey)
 The UninstallAcpiTable() function allows a caller to remove an ACPI table.

Functions

 FILE_LICENCE (BSD3)

Variables

EFI_GUID gEfiAcpiTableProtocolGuid

Detailed Description

The file provides the protocol to install or remove an ACPI table from a platform.

Copyright (c) 2006 - 2014, 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.

Definition in file AcpiTable.h.


Define Documentation

#define EFI_ACPI_TABLE_PROTOCOL_GUID   { 0xffe06bdd, 0x6107, 0x46a6, { 0x7b, 0xb2, 0x5a, 0x9c, 0x7e, 0xc5, 0x27, 0x5c }}

Definition at line 21 of file AcpiTable.h.


Typedef Documentation

Definition at line 25 of file AcpiTable.h.

typedef EFI_STATUS(EFIAPI * EFI_ACPI_TABLE_INSTALL_ACPI_TABLE)(IN EFI_ACPI_TABLE_PROTOCOL *This, IN VOID *AcpiTableBuffer, IN UINTN AcpiTableBufferSize, OUT UINTN *TableKey)

The InstallAcpiTable() function allows a caller to install an ACPI table.

When successful, the table will be linked by the RSDT/XSDT. AcpiTableBuffer specifies the table to be installed. InstallAcpiTable() will make a copy of the table and insert the copy into the RSDT/XSDT. InstallAcpiTable() must insert the new table at the end of the RSDT/XSDT. To prevent namespace collision, ACPI tables may be created using UEFI ACPI table format. If this protocol is used to install a table with a signature already present in the system, the new table will not replace the existing table. It is a platform implementation decision to add a new table with a signature matching an existing table or disallow duplicate table signatures and return EFI_ACCESS_DENIED. On successful output, TableKey is initialized with a unique key. Its value may be used in a subsequent call to UninstallAcpiTable to remove an ACPI table. If an EFI application is running at the time of this call, the relevant EFI_CONFIGURATION_TABLE pointer to the RSDT is no longer considered valid.

Parameters:
ThisA pointer to a EFI_ACPI_TABLE_PROTOCOL.
AcpiTableBufferA pointer to a buffer containing the ACPI table to be installed.
AcpiTableBufferSizeSpecifies the size, in bytes, of the AcpiTableBuffer buffer.
TableKeyReturns a key to refer to the ACPI table.
Return values:
EFI_SUCCESSThe table was successfully inserted
EFI_INVALID_PARAMETEREither AcpiTableBuffer is NULL, TableKey is NULL, or AcpiTableBufferSize and the size field embedded in the ACPI table pointed to by AcpiTableBuffer are not in sync.
EFI_OUT_OF_RESOURCESInsufficient resources exist to complete the request.
EFI_ACCESS_DENIEDThe table signature matches a table already present in the system and platform policy does not allow duplicate tables of this type.

Definition at line 78 of file AcpiTable.h.

The UninstallAcpiTable() function allows a caller to remove an ACPI table.

The routine will remove its reference from the RSDT/XSDT. A table is referenced by the TableKey parameter returned from a prior call to InstallAcpiTable(). If an EFI application is running at the time of this call, the relevant EFI_CONFIGURATION_TABLE pointer to the RSDT is no longer considered valid.

Parameters:
ThisA pointer to a EFI_ACPI_TABLE_PROTOCOL.
TableKeySpecifies the table to uninstall. The key was returned from InstallAcpiTable().
Return values:
EFI_SUCCESSThe table was successfully inserted
EFI_NOT_FOUNDTableKey does not refer to a valid key for a table entry.
EFI_OUT_OF_RESOURCESInsufficient resources exist to complete the request.

Definition at line 112 of file AcpiTable.h.


Function Documentation

FILE_LICENCE ( BSD3  )

Variable Documentation