IntelFrameworkPkg/Include/Protocol/AcpiSupport.h

   1 /** @file
   2   Definition of the ACPI Support protocol.
   3
   4   Copyright (c) 2007, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13   Module Name:  AcpiSupport.h
  14
  15   @par Revision Reference:
  16   This is defined in the ACPI Specification 0.9.
  17
  18 **/
  19
  20 #ifndef _ACPI_SUPPORT_PROTOCOL_H_
  21 #define _ACPI_SUPPORT_PROTOCOL_H_
  22
  23 typedef struct _EFI_ACPI_SUPPORT_PROTOCOL EFI_ACPI_SUPPORT_PROTOCOL;
  24
  25 //
  26 // ACPI Support Protocol GUID
  27 //
  28 #define EFI_ACPI_SUPPORT_GUID \
  29   { \
  30     0xdbff9d55, 0x89b7, 0x46da, {0xbd, 0xdf, 0x67, 0x7d, 0x3d, 0xc0, 0x24, 0x1d } \
  31   }
  32
  33 //
  34 // Protocol Data Definitions
  35 //
  36 //
  37 // ACPI Version bitmap definition:
  38 //
  39 // EFI_ACPI_TABLE_VERSION_1_0B - ACPI Version 1.0b
  40 // EFI_ACPI_TABLE_VERSION_2_0 - ACPI Version 2.0
  41 // EFI_ACPI_TABLE_VERSION_3_0 - ACPI Version 3.0
  42 // EFI_ACPI_TABLE_VERSION_NONE - No ACPI Versions.  This might be used
  43 //  to create memory-based operation regions or other information
  44 //  that is not part of the ACPI "tree" but must still be found
  45 //  in ACPI memory space and/or managed by the core ACPI driver.
  46 //
  47 // Note that EFI provides discrete GUIDs for each version of ACPI
  48 // that is supported.  It is expected that each EFI GUIDed
  49 // version of ACPI will also have a corresponding bitmap
  50 // definition.  This allows maintenance of separate ACPI trees
  51 // for each distinctly different version of ACPI.
  52 //
  53 #define EFI_ACPI_TABLE_VERSION      UINT32
  54
  55 #define EFI_ACPI_TABLE_VERSION_NONE (1 << 0)
  56 #define EFI_ACPI_TABLE_VERSION_1_0B (1 << 1)
  57 #define EFI_ACPI_TABLE_VERSION_2_0  (1 << 2)
  58 #define EFI_ACPI_TABLE_VERSION_3_0  (1 << 3)
  59
  60 //
  61 // Protocol Member Functions
  62 //
  63
  64 /**
  65   Returns a requested ACPI table.
  66
  67   @param  This                  A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.
  68   @param  Index                 The zero-based index of the table to retrieve.
  69   @param  Table                 Pointer for returning the table buffer.
  70   @param  Version               Updated with the ACPI versions to which this table belongs.
  71   @param  Handle                Pointer for identifying the table.
  72
  73   @retval EFI_SUCCESS           The function completed successfully.
  74   @retval EFI_NOT_FOUND         The requested index is too large and a table was not found.
  75
  76 **/
  77 typedef
  78 EFI_STATUS
  79 (EFIAPI *EFI_ACPI_GET_ACPI_TABLE) (
  80   IN EFI_ACPI_SUPPORT_PROTOCOL            *This,
  81   IN INTN                                 Index,
  82   OUT VOID                                **Table,
  83   OUT EFI_ACPI_TABLE_VERSION              *Version,
  84   OUT UINTN                               *Handle
  85   );
  86
  87 /**
  88   Used to add, remove, or update ACPI tables.
  89
  90   @param  This                  A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.
  91   @param  Table                 Pointer to the new table to add or update.
  92   @param  Checksum              If TRUE, indicates that the checksum should be
  93                                 calculated for this table.
  94   @param  Version               Indicates to which version(s) of ACPI the table should be added.
  95   @param  Pointer               to the handle of the table to remove or update.
  96
  97   @retval EFI_SUCCESS           The function completed successfully.
  98   @retval EFI_INVALID_PARAMETER *Handle was zero and Table was NULL.
  99   @retval EFI_ABORTED           Could not complete the desired action.
 100
 101 **/
 102 typedef
 103 EFI_STATUS
 104 (EFIAPI *EFI_ACPI_SET_ACPI_TABLE) (
 105   IN EFI_ACPI_SUPPORT_PROTOCOL            *This,
 106   IN VOID                                 *Table OPTIONAL,
 107   IN BOOLEAN                              Checksum,
 108   IN EFI_ACPI_TABLE_VERSION               Version,
 109   IN OUT UINTN                            *Handle
 110   );
 111
 112 /**
 113   Causes one or more versions of the ACPI tables to be published in
 114   the EFI system configuration tables.
 115
 116   @param  This                  A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.
 117   @param  Version               Indicates to which version(s) of ACPI that the table should be published.
 118
 119   @retval EFI_SUCCESS           The function completed successfully.
 120   @retval EFI_ABORTED           An error occurred and the function could not complete successfully.
 121
 122 **/
 123 typedef
 124 EFI_STATUS
 125 (EFIAPI *EFI_ACPI_PUBLISH_TABLES) (
 126   IN EFI_ACPI_SUPPORT_PROTOCOL            *This,
 127   IN EFI_ACPI_TABLE_VERSION               Version
 128   );
 129
 130 //
 131 // ACPI Support Protocol
 132 //
 133 /**
 134   @par Protocol Description:
 135   This protocol provides some basic services to support publishing ACPI system
 136   tables. The services handle many of the more mundane tasks that are required
 137   to publish a set of tables.
 138
 139   @param GetAcpiTable
 140   Returns a table specified by an index if it exists.
 141
 142   @param SetAcpiTable
 143   Adds, removes, or updates ACPI tables
 144
 145   @param PublishTables
 146   Publishes the ACPI tables.
 147
 148 **/
 149 struct _EFI_ACPI_SUPPORT_PROTOCOL {
 150   EFI_ACPI_GET_ACPI_TABLE GetAcpiTable;
 151   EFI_ACPI_SET_ACPI_TABLE SetAcpiTable;
 152   EFI_ACPI_PUBLISH_TABLES PublishTables;
 153 };
 154
 155 //
 156 // Extern the GUID for protocol users.
 157 //
 158 extern EFI_GUID gEfiAcpiSupportProtocolGuid;
 159
 160 #endif
 161