1 /******************************************************************************
3 * Module Name: tbxface - Public interfaces to the ACPI subsystem
4 * ACPI table oriented interfaces
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
117 #define __TBXFACE_C__
119 #include <contrib/dev/acpica/include/acpi.h>
120 #include <contrib/dev/acpica/include/accommon.h>
121 #include <contrib/dev/acpica/include/acnamesp.h>
122 #include <contrib/dev/acpica/include/actables.h>
124 #define _COMPONENT ACPI_TABLES
125 ACPI_MODULE_NAME ("tbxface")
127 /* Local prototypes */
130 AcpiTbLoadNamespace (
134 /*******************************************************************************
136 * FUNCTION: AcpiAllocateRootTable
138 * PARAMETERS: InitialTableCount - Size of InitialTableArray, in number of
139 * ACPI_TABLE_DESC structures
143 * DESCRIPTION: Allocate a root table array. Used by iASL compiler and
144 * AcpiInitializeTables.
146 ******************************************************************************/
149 AcpiAllocateRootTable (
150 UINT32 InitialTableCount)
153 AcpiGbl_RootTableList.Size = InitialTableCount;
154 AcpiGbl_RootTableList.Flags = ACPI_ROOT_ALLOW_RESIZE;
156 return (AcpiTbResizeRootTableList ());
160 /*******************************************************************************
162 * FUNCTION: AcpiInitializeTables
164 * PARAMETERS: InitialTableArray - Pointer to an array of pre-allocated
165 * ACPI_TABLE_DESC structures. If NULL, the
166 * array is dynamically allocated.
167 * InitialTableCount - Size of InitialTableArray, in number of
168 * ACPI_TABLE_DESC structures
169 * AllowRealloc - Flag to tell Table Manager if resize of
170 * pre-allocated array is allowed. Ignored
171 * if InitialTableArray is NULL.
175 * DESCRIPTION: Initialize the table manager, get the RSDP and RSDT/XSDT.
177 * NOTE: Allows static allocation of the initial table array in order
178 * to avoid the use of dynamic memory in confined environments
179 * such as the kernel boot sequence where it may not be available.
181 * If the host OS memory managers are initialized, use NULL for
182 * InitialTableArray, and the table will be dynamically allocated.
184 ******************************************************************************/
187 AcpiInitializeTables (
188 ACPI_TABLE_DESC *InitialTableArray,
189 UINT32 InitialTableCount,
192 ACPI_PHYSICAL_ADDRESS RsdpAddress;
196 ACPI_FUNCTION_TRACE (AcpiInitializeTables);
200 * Set up the Root Table Array
201 * Allocate the table array if requested
203 if (!InitialTableArray)
205 Status = AcpiAllocateRootTable (InitialTableCount);
206 if (ACPI_FAILURE (Status))
208 return_ACPI_STATUS (Status);
213 /* Root Table Array has been statically allocated by the host */
215 ACPI_MEMSET (InitialTableArray, 0,
216 (ACPI_SIZE) InitialTableCount * sizeof (ACPI_TABLE_DESC));
218 AcpiGbl_RootTableList.Tables = InitialTableArray;
219 AcpiGbl_RootTableList.Size = InitialTableCount;
220 AcpiGbl_RootTableList.Flags = ACPI_ROOT_ORIGIN_UNKNOWN;
223 AcpiGbl_RootTableList.Flags |= ACPI_ROOT_ALLOW_RESIZE;
227 /* Get the address of the RSDP */
229 RsdpAddress = AcpiOsGetRootPointer ();
232 return_ACPI_STATUS (AE_NOT_FOUND);
236 * Get the root table (RSDT or XSDT) and extract all entries to the local
237 * Root Table Array. This array contains the information of the RSDT/XSDT
238 * in a common, more useable format.
240 Status = AcpiTbParseRootTable (RsdpAddress);
241 return_ACPI_STATUS (Status);
244 ACPI_EXPORT_SYMBOL (AcpiInitializeTables)
247 /*******************************************************************************
249 * FUNCTION: AcpiReallocateRootTable
255 * DESCRIPTION: Reallocate Root Table List into dynamic memory. Copies the
256 * root list from the previously provided scratch area. Should
257 * be called once dynamic memory allocation is available in the
260 ******************************************************************************/
263 AcpiReallocateRootTable (
266 ACPI_TABLE_DESC *Tables;
270 ACPI_FUNCTION_TRACE (AcpiReallocateRootTable);
274 * Only reallocate the root table if the host provided a static buffer
275 * for the table array in the call to AcpiInitializeTables.
277 if (AcpiGbl_RootTableList.Flags & ACPI_ROOT_ORIGIN_ALLOCATED)
279 return_ACPI_STATUS (AE_SUPPORT);
282 NewSize = ((ACPI_SIZE) AcpiGbl_RootTableList.Count +
283 ACPI_ROOT_TABLE_SIZE_INCREMENT) *
284 sizeof (ACPI_TABLE_DESC);
286 /* Create new array and copy the old array */
288 Tables = ACPI_ALLOCATE_ZEROED (NewSize);
291 return_ACPI_STATUS (AE_NO_MEMORY);
294 ACPI_MEMCPY (Tables, AcpiGbl_RootTableList.Tables, NewSize);
296 AcpiGbl_RootTableList.Size = AcpiGbl_RootTableList.Count;
297 AcpiGbl_RootTableList.Tables = Tables;
298 AcpiGbl_RootTableList.Flags =
299 ACPI_ROOT_ORIGIN_ALLOCATED | ACPI_ROOT_ALLOW_RESIZE;
301 return_ACPI_STATUS (AE_OK);
304 ACPI_EXPORT_SYMBOL (AcpiReallocateRootTable)
307 /*******************************************************************************
309 * FUNCTION: AcpiGetTableHeader
311 * PARAMETERS: Signature - ACPI signature of needed table
312 * Instance - Which instance (for SSDTs)
313 * OutTableHeader - The pointer to the table header to fill
315 * RETURN: Status and pointer to mapped table header
317 * DESCRIPTION: Finds an ACPI table header.
319 * NOTE: Caller is responsible in unmapping the header with
322 ******************************************************************************/
328 ACPI_TABLE_HEADER *OutTableHeader)
332 ACPI_TABLE_HEADER *Header;
335 /* Parameter validation */
337 if (!Signature || !OutTableHeader)
339 return (AE_BAD_PARAMETER);
342 /* Walk the root table list */
344 for (i = 0, j = 0; i < AcpiGbl_RootTableList.Count; i++)
346 if (!ACPI_COMPARE_NAME (&(AcpiGbl_RootTableList.Tables[i].Signature),
357 if (!AcpiGbl_RootTableList.Tables[i].Pointer)
359 if ((AcpiGbl_RootTableList.Tables[i].Flags &
360 ACPI_TABLE_ORIGIN_MASK) ==
361 ACPI_TABLE_ORIGIN_MAPPED)
363 Header = AcpiOsMapMemory (
364 AcpiGbl_RootTableList.Tables[i].Address,
365 sizeof (ACPI_TABLE_HEADER));
371 ACPI_MEMCPY (OutTableHeader, Header, sizeof(ACPI_TABLE_HEADER));
372 AcpiOsUnmapMemory (Header, sizeof(ACPI_TABLE_HEADER));
381 ACPI_MEMCPY (OutTableHeader,
382 AcpiGbl_RootTableList.Tables[i].Pointer,
383 sizeof(ACPI_TABLE_HEADER));
389 return (AE_NOT_FOUND);
392 ACPI_EXPORT_SYMBOL (AcpiGetTableHeader)
395 /*******************************************************************************
397 * FUNCTION: AcpiGetTable
399 * PARAMETERS: Signature - ACPI signature of needed table
400 * Instance - Which instance (for SSDTs)
401 * OutTable - Where the pointer to the table is returned
403 * RETURN: Status and pointer to table
405 * DESCRIPTION: Finds and verifies an ACPI table.
407 ******************************************************************************/
413 ACPI_TABLE_HEADER **OutTable)
420 /* Parameter validation */
422 if (!Signature || !OutTable)
424 return (AE_BAD_PARAMETER);
427 /* Walk the root table list */
429 for (i = 0, j = 0; i < AcpiGbl_RootTableList.Count; i++)
431 if (!ACPI_COMPARE_NAME (&(AcpiGbl_RootTableList.Tables[i].Signature),
442 Status = AcpiTbVerifyTable (&AcpiGbl_RootTableList.Tables[i]);
443 if (ACPI_SUCCESS (Status))
445 *OutTable = AcpiGbl_RootTableList.Tables[i].Pointer;
451 return (AE_NOT_FOUND);
454 ACPI_EXPORT_SYMBOL (AcpiGetTable)
457 /*******************************************************************************
459 * FUNCTION: AcpiGetTableByIndex
461 * PARAMETERS: TableIndex - Table index
462 * Table - Where the pointer to the table is returned
464 * RETURN: Status and pointer to the table
466 * DESCRIPTION: Obtain a table by an index into the global table list.
468 ******************************************************************************/
471 AcpiGetTableByIndex (
473 ACPI_TABLE_HEADER **Table)
478 ACPI_FUNCTION_TRACE (AcpiGetTableByIndex);
481 /* Parameter validation */
485 return_ACPI_STATUS (AE_BAD_PARAMETER);
488 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
492 if (TableIndex >= AcpiGbl_RootTableList.Count)
494 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
495 return_ACPI_STATUS (AE_BAD_PARAMETER);
498 if (!AcpiGbl_RootTableList.Tables[TableIndex].Pointer)
500 /* Table is not mapped, map it */
502 Status = AcpiTbVerifyTable (&AcpiGbl_RootTableList.Tables[TableIndex]);
503 if (ACPI_FAILURE (Status))
505 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
506 return_ACPI_STATUS (Status);
510 *Table = AcpiGbl_RootTableList.Tables[TableIndex].Pointer;
511 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
512 return_ACPI_STATUS (AE_OK);
515 ACPI_EXPORT_SYMBOL (AcpiGetTableByIndex)
518 /*******************************************************************************
520 * FUNCTION: AcpiTbLoadNamespace
526 * DESCRIPTION: Load the namespace from the DSDT and all SSDTs/PSDTs found in
529 ******************************************************************************/
532 AcpiTbLoadNamespace (
539 ACPI_FUNCTION_TRACE (TbLoadNamespace);
542 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
545 * Load the namespace. The DSDT is required, but any SSDT and PSDT tables
548 if (!AcpiGbl_RootTableList.Count ||
550 &(AcpiGbl_RootTableList.Tables[ACPI_TABLE_INDEX_DSDT].Signature),
552 ACPI_FAILURE (AcpiTbVerifyTable (
553 &AcpiGbl_RootTableList.Tables[ACPI_TABLE_INDEX_DSDT])))
555 Status = AE_NO_ACPI_TABLES;
559 /* A valid DSDT is required */
561 Status = AcpiTbVerifyTable (
562 &AcpiGbl_RootTableList.Tables[ACPI_TABLE_INDEX_DSDT]);
563 if (ACPI_FAILURE (Status))
565 Status = AE_NO_ACPI_TABLES;
569 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
571 /* Load and parse tables */
573 Status = AcpiNsLoadTable (ACPI_TABLE_INDEX_DSDT, AcpiGbl_RootNode);
574 if (ACPI_FAILURE (Status))
576 return_ACPI_STATUS (Status);
579 /* Load any SSDT or PSDT tables. Note: Loop leaves tables locked */
581 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
582 for (i = 2; i < AcpiGbl_RootTableList.Count; ++i)
584 if ((!ACPI_COMPARE_NAME (&(AcpiGbl_RootTableList.Tables[i].Signature),
586 !ACPI_COMPARE_NAME (&(AcpiGbl_RootTableList.Tables[i].Signature),
588 ACPI_FAILURE (AcpiTbVerifyTable (
589 &AcpiGbl_RootTableList.Tables[i])))
594 /* Skip SSDT when DSDT is overriden */
596 if (ACPI_COMPARE_NAME (&(AcpiGbl_RootTableList.Tables[i].Signature),
598 (AcpiGbl_RootTableList.Tables[ACPI_TABLE_INDEX_DSDT].Flags &
599 ACPI_TABLE_ORIGIN_OVERRIDE))
604 /* Ignore errors while loading tables, get as many as possible */
606 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
607 (void) AcpiNsLoadTable (i, AcpiGbl_RootNode);
608 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
611 ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "ACPI Tables successfully acquired\n"));
614 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
615 return_ACPI_STATUS (Status);
619 /*******************************************************************************
621 * FUNCTION: AcpiLoadTables
627 * DESCRIPTION: Load the ACPI tables from the RSDT/XSDT
629 ******************************************************************************/
638 ACPI_FUNCTION_TRACE (AcpiLoadTables);
641 /* Load the namespace from the tables */
643 Status = AcpiTbLoadNamespace ();
644 if (ACPI_FAILURE (Status))
646 ACPI_EXCEPTION ((AE_INFO, Status,
647 "While loading namespace from ACPI tables"));
650 return_ACPI_STATUS (Status);
653 ACPI_EXPORT_SYMBOL (AcpiLoadTables)
656 /*******************************************************************************
658 * FUNCTION: AcpiInstallTableHandler
660 * PARAMETERS: Handler - Table event handler
661 * Context - Value passed to the handler on each event
665 * DESCRIPTION: Install table event handler
667 ******************************************************************************/
670 AcpiInstallTableHandler (
671 ACPI_TABLE_HANDLER Handler,
677 ACPI_FUNCTION_TRACE (AcpiInstallTableHandler);
682 return_ACPI_STATUS (AE_BAD_PARAMETER);
685 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
686 if (ACPI_FAILURE (Status))
688 return_ACPI_STATUS (Status);
691 /* Don't allow more than one handler */
693 if (AcpiGbl_TableHandler)
695 Status = AE_ALREADY_EXISTS;
699 /* Install the handler */
701 AcpiGbl_TableHandler = Handler;
702 AcpiGbl_TableHandlerContext = Context;
705 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
706 return_ACPI_STATUS (Status);
709 ACPI_EXPORT_SYMBOL (AcpiInstallTableHandler)
712 /*******************************************************************************
714 * FUNCTION: AcpiRemoveTableHandler
716 * PARAMETERS: Handler - Table event handler that was installed
721 * DESCRIPTION: Remove table event handler
723 ******************************************************************************/
726 AcpiRemoveTableHandler (
727 ACPI_TABLE_HANDLER Handler)
732 ACPI_FUNCTION_TRACE (AcpiRemoveTableHandler);
735 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
736 if (ACPI_FAILURE (Status))
738 return_ACPI_STATUS (Status);
741 /* Make sure that the installed handler is the same */
744 Handler != AcpiGbl_TableHandler)
746 Status = AE_BAD_PARAMETER;
750 /* Remove the handler */
752 AcpiGbl_TableHandler = NULL;
755 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
756 return_ACPI_STATUS (Status);
759 ACPI_EXPORT_SYMBOL (AcpiRemoveTableHandler)