MdePkg/Include/Protocol/AcpiTable.h

   1 /** @file
   2   The file provides the protocol to install or remove an ACPI
   3   table from a platform.
   4
   5   Copyright (c) 2006 - 2007, Intel Corporation
   6   All rights reserved. This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14   Module Name: AcpiTable.h
  15
  16 **/
  17
  18 #ifndef __ACPI_TABLE_H___
  19 #define __ACPI_TABLE_H___
  20
  21 #define EFI_ACPI_TABLE_PROTOCOL_GUID \
  22   { 0xffe06bdd, 0x6107, 0x46a6, { 0x7b, 0xb2, 0x5a, 0x9c, 0x7e, 0xc5, 0x27, 0x5c }}
  23
  24
  25 typedef struct _EFI_ACPI_TABLE_PROTOCOL EFI_ACPI_TABLE_PROTOCOL;
  26
  27 /**
  28
  29   The InstallAcpiTable() function allows a caller to install an
  30   ACPI table. When successful, the table will be linked by the
  31   RSDT/XSDT. AcpiTableBuffer specifies the table to be installed.
  32   InstallAcpiTable() will make a copy of the table and insert the
  33   copy into the RSDT/XSDT. InstallAcpiTable() must insert the new
  34   table at the end of the RSDT/XSDT. To prevent namespace
  35   collision, ACPI tables may be created using UEFI ACPI table
  36   format. See Appendix O. On successful output, TableKey is
  37   initialized with a unique key. Its value may be used in a
  38   subsequent call to UninstallAcpiTable to remove an ACPI table.
  39   If an EFI application is running at the time of this call, the
  40   relevant EFI_CONFIGURATION_TABLE pointer to the RSDT is no
  41   longer considered valid.
  42
  43
  44   @param This A pointer to a EFI_ACPI_TABLE_PROTOCOL.
  45
  46   @param AcpiTableBuffer  A pointer to a buffer containing the
  47                           ACPI table to be installed.
  48
  49   @param AcpiTableBufferSize  Specifies the size, in bytes, of
  50                               the AcpiTableBuffer buffer.
  51
  52
  53   @param TableKey   Returns a key to refer to the ACPI table.
  54
  55   @retval EFI_SUCCESS The table was successfully inserted
  56
  57   @retval EFI_INVALID_PARAMETER Either AcpiTableBuffer is NULL,
  58                                 TableKey is NULL, or
  59                                 AcpiTableBufferSize and the size
  60                                 field embedded in the ACPI table
  61                                 pointed to by AcpiTableBuffer
  62                                 are not in sync.
  63
  64   @retval EFI_OUT_OF_RESOURCES  Insufficient resources exist to
  65                                 complete the request.
  66
  67 **/
  68 typedef
  69 EFI_STATUS
  70 (EFIAPI *EFI_ACPI_TABLE_INSTALL_ACPI_TABLE) (
  71   IN CONST  EFI_ACPI_TABLE_PROTOCOL *This,
  72   IN CONST  VOID                    *AcpiTableBuffer,
  73   IN CONST  UINTN                   AcpiTableBufferSize,
  74   OUT       UINTN                   *TableKey
  75 );
  76
  77
  78 /**
  79
  80   The UninstallAcpiTable() function allows a caller to remove an
  81   ACPI table. The routine will remove its reference from the
  82   RSDT/XSDT. A table is referenced by the TableKey parameter
  83   returned from a prior call to InstallAcpiTable(). If an EFI
  84   application is running at the time of this call, the relevant
  85   EFI_CONFIGURATION_TABLE pointer to the RSDT is no longer
  86   considered valid.
  87
  88   @param This A pointer to a EFI_ACPI_TABLE_PROTOCOL.
  89
  90   @param TableKey Specifies the table to uninstall. The key was
  91                   returned from InstallAcpiTable().
  92
  93   @retval EFI_SUCCESS The table was successfully inserted
  94
  95   @retval EFI_NOT_FOUND TableKey does not refer to a valid key
  96                         for a table entry.
  97
  98   @retval EFI_OUT_OF_RESOURCES  Insufficient resources exist to
  99                                 complete the request.
 100
 101 **/
 102 typedef
 103 EFI_STATUS
 104 (EFIAPI *EFI_ACPI_TABLE_UNINSTALL_ACPI_TABLE) (
 105   IN CONST  EFI_ACPI_TABLE_PROTOCOL *This,
 106   IN CONST  UINTN                   TableKey
 107 );
 108
 109 /**
 110   The EFI_ACPI_TABLE_PROTOCOL provides the ability for a component
 111   to install and uninstall ACPI tables from a platform.
 112
 113
 114   @param InstallAcpiTable Installs an ACPI table into the
 115                           system.
 116
 117   @param UninstallAcpiTable Removes a previously installed ACPI
 118                             table from the system.
 119
 120 **/
 121 struct _EFI_ACPI_TABLE_PROTOCOL {
 122   EFI_ACPI_TABLE_INSTALL_ACPI_TABLE   InstallAcpiTable;
 123   EFI_ACPI_TABLE_UNINSTALL_ACPI_TABLE UninstallAcpiTable;
 124 };
 125
 126 extern EFI_GUID gEfiAcpiTableProtocolGuid;
 127
 128 #endif
 129