]>
Commit | Line | Data |
---|---|---|
3cbfba02 DW |
1 | /*++\r |
2 | \r | |
3 | Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>\r | |
4 | \r\r | |
9dc8036d MK |
5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
6 | \r | |
3cbfba02 DW |
7 | \r\r |
8 | \r | |
9 | Module Name:\r | |
10 | \r | |
11 | AcpiPlatformHooksLib.h\r | |
12 | \r | |
13 | Abstract:\r | |
14 | \r | |
15 | This is an implementation of the ACPI platform driver. Requirements for\r | |
16 | this driver are defined in the Tiano ACPI External Product Specification,\r | |
17 | revision 0.3.6.\r | |
18 | \r | |
19 | --*/\r | |
20 | \r | |
21 | #ifndef _ACPI_PLATFORM_HOOKS_LIB_H_\r | |
22 | #define _ACPI_PLATFORM_HOOKS_LIB_H_\r | |
23 | \r | |
24 | //\r | |
25 | // Statements that include other header files.\r | |
26 | //\r | |
27 | #include <IndustryStandard/Acpi.h>\r | |
28 | \r | |
29 | /**\r | |
30 | Returns the ACPI table version that the platform wants.\r | |
31 | \r | |
32 | @param[in] None\r | |
33 | \r | |
34 | @retval EFI_ACPI_TABLE_VERSION_NONE if ACPI is to be disabled.\r | |
35 | @retval EFI_ACPI_TABLE_VERSION_1_0B if 1.0b.\r | |
36 | @retval EFI_ACPI_TABLE_VERSION_2_00 if 2.00.\r | |
37 | **/\r | |
38 | EFI_ACPI_TABLE_VERSION\r | |
39 | AcpiPlatformHooksGetAcpiTableVersion (\r | |
40 | VOID\r | |
41 | );\r | |
42 | \r | |
43 | /**\r | |
44 | Returns the OEMID, OEM Table ID, OEM Revision.\r | |
45 | \r | |
46 | @param[in] None\r | |
47 | \r | |
48 | @retval OemId OEM ID string for ACPI tables, maximum 6 ASCII characters.\r | |
49 | This is an OEM-supplied string that identifies the OEM.\r | |
50 | @retval OemTableId An OEM-supplied string that the OEM uses to identify\r | |
51 | the particular data table. This field is particularly useful\r | |
52 | when defining a definition block to distinguish definition block\r | |
53 | functions. The OEM assigns each dissimilar table a new OEM Table ID.\r | |
54 | @retval OemRevision An OEM-supplied revision number for ACPI tables.\r | |
55 | Larger numbers are assumed to be newer revisions.\r | |
56 | \r | |
57 | **/\r | |
58 | EFI_STATUS\r | |
59 | AcpiPlatformHooksGetOemFields (\r | |
60 | OUT UINT8 *OemId,\r | |
61 | OUT UINT64 *OemTableId,\r | |
62 | OUT UINT32 *OemRevision\r | |
63 | );\r | |
64 | \r | |
65 | /**\r | |
66 | Called for every ACPI table found in the BIOS flash.\r | |
67 | Returns whether a table is active or not. Inactive tables\r | |
68 | are not published in the ACPI table list. This hook can be\r | |
69 | used to implement optional SSDT tables or enabling/disabling\r | |
70 | specific functionality (e.g. SPCR table) based on a setup\r | |
71 | switch or platform preference. In case of optional SSDT tables,\r | |
72 | the platform flash will include all the SSDT tables but will\r | |
73 | return EFI_SUCCESS only for those tables that need to be\r | |
74 | published.\r | |
75 | This hook can also be used to update the table data. The header\r | |
76 | is updated by the common code. For example, if a platform wants\r | |
77 | to use an SSDT table to export some platform settings to the\r | |
78 | ACPI code, it needs to update the data inside that SSDT based\r | |
79 | on platform preferences in this hook.\r | |
80 | \r | |
81 | @param[in] None\r | |
82 | \r | |
83 | @retval EFI_SUCCESS if the table is active.\r | |
84 | @retval EFI_UNSUPPORTED if the table is not active.\r | |
85 | **/\r | |
86 | EFI_STATUS\r | |
87 | AcpiPlatformHooksIsActiveTable (\r | |
88 | IN OUT EFI_ACPI_COMMON_HEADER *Table\r | |
89 | );\r | |
90 | \r | |
91 | #endif\r |