IntelFrameworkPkg/Include/Protocol/AcpiSupport.h File Reference


Data Structures

struct  _EFI_ACPI_SUPPORT_PROTOCOL

Defines

#define EFI_ACPI_SUPPORT_GUID

Typedefs

typedef struct
_EFI_ACPI_SUPPORT_PROTOCOL 
EFI_ACPI_SUPPORT_PROTOCOL
typedef EFI_STATUS(EFIAPI * EFI_ACPI_GET_ACPI_TABLE )(IN EFI_ACPI_SUPPORT_PROTOCOL *This, IN INTN Index, OUT VOID **Table, OUT EFI_ACPI_TABLE_VERSION *Version, OUT UINTN *Handle)
typedef EFI_STATUS(EFIAPI * EFI_ACPI_SET_ACPI_TABLE )(IN EFI_ACPI_SUPPORT_PROTOCOL *This, IN VOID *Table, IN BOOLEAN Checksum, IN EFI_ACPI_TABLE_VERSION Version, IN OUT UINTN *Handle)
typedef EFI_STATUS(EFIAPI * EFI_ACPI_PUBLISH_TABLES )(IN EFI_ACPI_SUPPORT_PROTOCOL *This, IN EFI_ACPI_TABLE_VERSION Version)

Variables

EFI_GUID gEfiAcpiSupportProtocolGuid

Detailed Description

This protocol provides some basic services to support publishing ACPI system tables. The services handle many of the more mundane tasks that are required to publish a set of tables. The services will:

Update the table links.

Copyright (c) 2007 - 2010, 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 that 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.

Revision Reference:
This Protocol is defined in Framework ACPI Specification. Version 0.9.

Define Documentation

#define EFI_ACPI_SUPPORT_GUID

Value:

{ \
    0xdbff9d55, 0x89b7, 0x46da, {0xbd, 0xdf, 0x67, 0x7d, 0x3d, 0xc0, 0x24, 0x1d } \
  }


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_ACPI_GET_ACPI_TABLE)(IN EFI_ACPI_SUPPORT_PROTOCOL *This, IN INTN Index, OUT VOID **Table, OUT EFI_ACPI_TABLE_VERSION *Version, OUT UINTN *Handle)

Returns a requested ACPI table.

Parameters:
This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.
Index The zero-based index of the table to retrieve.
Table The pointer for returning the table buffer.
Version Updated with the ACPI versions to which this table belongs.
Handle The pointer for identifying 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.

typedef EFI_STATUS(EFIAPI * EFI_ACPI_PUBLISH_TABLES)(IN EFI_ACPI_SUPPORT_PROTOCOL *This, IN EFI_ACPI_TABLE_VERSION Version)

Causes one or more versions of the ACPI tables to be published in the EFI system configuration tables.

The PublishTables() function installs the ACPI tables for the versions that are specified in Version. No tables are published for Version equal to EFI_ACPI_VERSION_NONE. Once published, tables will continue to be updated as tables are modified with EFI_ACPI_SUPPORT_PROTOCOL.SetAcpiTable().

Parameters:
This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.
Version Indicates to which version(s) of ACPI the table should be published.
Return values:
EFI_SUCCESS The function completed successfully.
EFI_ABORTED An error occurred and the function could not complete successfully.

typedef EFI_STATUS(EFIAPI * EFI_ACPI_SET_ACPI_TABLE)(IN EFI_ACPI_SUPPORT_PROTOCOL *This, IN VOID *Table, IN BOOLEAN Checksum, IN EFI_ACPI_TABLE_VERSION Version, IN OUT UINTN *Handle)

Used to add, remove, or update ACPI tables.

Parameters:
This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.
Table The pointer to the new table to add or update.
Checksum If TRUE, indicates that the checksum should be calculated for this table.
Version Indicates to which version(s) of ACPI the table should be added.
Handle The pointer to the handle of the table to remove or update.
Return values:
EFI_SUCCESS The function completed successfully.
EFI_INVALID_PARAMETER *Handle was zero and Table was NULL.
EFI_ABORTED Could not complete the desired action.


Variable Documentation


Generated on Wed Sep 2 13:08:33 2015 for IntelFrameworkPkg[ALL] by  doxygen 1.5.7.1