xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/tables/tbxfload.c (revision 820dca4df6c7bf955c46e8f6521b9408f50b2900)
1 /******************************************************************************
2  *
3  * Module Name: tbxfload - Table load/unload external interfaces
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2012, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************/
115 
116 #define __TBXFLOAD_C__
117 
118 #include "acpi.h"
119 #include "accommon.h"
120 #include "acnamesp.h"
121 #include "actables.h"
122 
123 #define _COMPONENT          ACPI_TABLES
124         ACPI_MODULE_NAME    ("tbxfload")
125 
126 /* Local prototypes */
127 
128 static ACPI_STATUS
129 AcpiTbLoadNamespace (
130     void);
131 
132 
133 /*******************************************************************************
134  *
135  * FUNCTION:    AcpiLoadTables
136  *
137  * PARAMETERS:  None
138  *
139  * RETURN:      Status
140  *
141  * DESCRIPTION: Load the ACPI tables from the RSDT/XSDT
142  *
143  ******************************************************************************/
144 
145 ACPI_STATUS
146 AcpiLoadTables (
147     void)
148 {
149     ACPI_STATUS             Status;
150 
151 
152     ACPI_FUNCTION_TRACE (AcpiLoadTables);
153 
154 
155     /* Load the namespace from the tables */
156 
157     Status = AcpiTbLoadNamespace ();
158     if (ACPI_FAILURE (Status))
159     {
160         ACPI_EXCEPTION ((AE_INFO, Status,
161             "While loading namespace from ACPI tables"));
162     }
163 
164     return_ACPI_STATUS (Status);
165 }
166 
167 ACPI_EXPORT_SYMBOL (AcpiLoadTables)
168 
169 
170 /*******************************************************************************
171  *
172  * FUNCTION:    AcpiTbLoadNamespace
173  *
174  * PARAMETERS:  None
175  *
176  * RETURN:      Status
177  *
178  * DESCRIPTION: Load the namespace from the DSDT and all SSDTs/PSDTs found in
179  *              the RSDT/XSDT.
180  *
181  ******************************************************************************/
182 
183 static ACPI_STATUS
184 AcpiTbLoadNamespace (
185     void)
186 {
187     ACPI_STATUS             Status;
188     UINT32                  i;
189     ACPI_TABLE_HEADER       *NewDsdt;
190 
191 
192     ACPI_FUNCTION_TRACE (TbLoadNamespace);
193 
194 
195     (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
196 
197     /*
198      * Load the namespace. The DSDT is required, but any SSDT and
199      * PSDT tables are optional. Verify the DSDT.
200      */
201     if (!AcpiGbl_RootTableList.CurrentTableCount ||
202         !ACPI_COMPARE_NAME (
203             &(AcpiGbl_RootTableList.Tables[ACPI_TABLE_INDEX_DSDT].Signature),
204             ACPI_SIG_DSDT) ||
205          ACPI_FAILURE (AcpiTbVerifyTable (
206             &AcpiGbl_RootTableList.Tables[ACPI_TABLE_INDEX_DSDT])))
207     {
208         Status = AE_NO_ACPI_TABLES;
209         goto UnlockAndExit;
210     }
211 
212     /*
213      * Save the DSDT pointer for simple access. This is the mapped memory
214      * address. We must take care here because the address of the .Tables
215      * array can change dynamically as tables are loaded at run-time. Note:
216      * .Pointer field is not validated until after call to AcpiTbVerifyTable.
217      */
218     AcpiGbl_DSDT = AcpiGbl_RootTableList.Tables[ACPI_TABLE_INDEX_DSDT].Pointer;
219 
220     /*
221      * Optionally copy the entire DSDT to local memory (instead of simply
222      * mapping it.) There are some BIOSs that corrupt or replace the original
223      * DSDT, creating the need for this option. Default is FALSE, do not copy
224      * the DSDT.
225      */
226     if (AcpiGbl_CopyDsdtLocally)
227     {
228         NewDsdt = AcpiTbCopyDsdt (ACPI_TABLE_INDEX_DSDT);
229         if (NewDsdt)
230         {
231             AcpiGbl_DSDT = NewDsdt;
232         }
233     }
234 
235     /*
236      * Save the original DSDT header for detection of table corruption
237      * and/or replacement of the DSDT from outside the OS.
238      */
239     ACPI_MEMCPY (&AcpiGbl_OriginalDsdtHeader, AcpiGbl_DSDT,
240         sizeof (ACPI_TABLE_HEADER));
241 
242     (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
243 
244     /* Load and parse tables */
245 
246     Status = AcpiNsLoadTable (ACPI_TABLE_INDEX_DSDT, AcpiGbl_RootNode);
247     if (ACPI_FAILURE (Status))
248     {
249         return_ACPI_STATUS (Status);
250     }
251 
252     /* Load any SSDT or PSDT tables. Note: Loop leaves tables locked */
253 
254     (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
255     for (i = 0; i < AcpiGbl_RootTableList.CurrentTableCount; ++i)
256     {
257         if ((!ACPI_COMPARE_NAME (&(AcpiGbl_RootTableList.Tables[i].Signature),
258                     ACPI_SIG_SSDT) &&
259              !ACPI_COMPARE_NAME (&(AcpiGbl_RootTableList.Tables[i].Signature),
260                     ACPI_SIG_PSDT)) ||
261              ACPI_FAILURE (AcpiTbVerifyTable (
262                 &AcpiGbl_RootTableList.Tables[i])))
263         {
264             continue;
265         }
266 
267         /* Ignore errors while loading tables, get as many as possible */
268 
269         (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
270         (void) AcpiNsLoadTable (i, AcpiGbl_RootNode);
271         (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
272     }
273 
274     ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "ACPI Tables successfully acquired\n"));
275 
276 UnlockAndExit:
277     (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
278     return_ACPI_STATUS (Status);
279 }
280 
281 
282 /*******************************************************************************
283  *
284  * FUNCTION:    AcpiLoadTable
285  *
286  * PARAMETERS:  Table               - Pointer to a buffer containing the ACPI
287  *                                    table to be loaded.
288  *
289  * RETURN:      Status
290  *
291  * DESCRIPTION: Dynamically load an ACPI table from the caller's buffer. Must
292  *              be a valid ACPI table with a valid ACPI table header.
293  *              Note1: Mainly intended to support hotplug addition of SSDTs.
294  *              Note2: Does not copy the incoming table. User is responsible
295  *              to ensure that the table is not deleted or unmapped.
296  *
297  ******************************************************************************/
298 
299 ACPI_STATUS
300 AcpiLoadTable (
301     ACPI_TABLE_HEADER       *Table)
302 {
303     ACPI_STATUS             Status;
304     ACPI_TABLE_DESC         TableDesc;
305     UINT32                  TableIndex;
306 
307 
308     ACPI_FUNCTION_TRACE (AcpiLoadTable);
309 
310 
311     /* Parameter validation */
312 
313     if (!Table)
314     {
315         return_ACPI_STATUS (AE_BAD_PARAMETER);
316     }
317 
318     /* Init local table descriptor */
319 
320     ACPI_MEMSET (&TableDesc, 0, sizeof (ACPI_TABLE_DESC));
321     TableDesc.Address = ACPI_PTR_TO_PHYSADDR (Table);
322     TableDesc.Pointer = Table;
323     TableDesc.Length = Table->Length;
324     TableDesc.Flags = ACPI_TABLE_ORIGIN_UNKNOWN;
325 
326     /* Must acquire the interpreter lock during this operation */
327 
328     Status = AcpiUtAcquireMutex (ACPI_MTX_INTERPRETER);
329     if (ACPI_FAILURE (Status))
330     {
331         return_ACPI_STATUS (Status);
332     }
333 
334     /* Install the table and load it into the namespace */
335 
336     ACPI_INFO ((AE_INFO, "Host-directed Dynamic ACPI Table Load:"));
337     Status = AcpiTbAddTable (&TableDesc, &TableIndex);
338     if (ACPI_FAILURE (Status))
339     {
340         goto UnlockAndExit;
341     }
342 
343     Status = AcpiNsLoadTable (TableIndex, AcpiGbl_RootNode);
344 
345     /* Invoke table handler if present */
346 
347     if (AcpiGbl_TableHandler)
348     {
349         (void) AcpiGbl_TableHandler (ACPI_TABLE_EVENT_LOAD, Table,
350                     AcpiGbl_TableHandlerContext);
351     }
352 
353 UnlockAndExit:
354     (void) AcpiUtReleaseMutex (ACPI_MTX_INTERPRETER);
355     return_ACPI_STATUS (Status);
356 }
357 
358 ACPI_EXPORT_SYMBOL (AcpiLoadTable)
359 
360 
361 /*******************************************************************************
362  *
363  * FUNCTION:    AcpiUnloadParentTable
364  *
365  * PARAMETERS:  Object              - Handle to any namespace object owned by
366  *                                    the table to be unloaded
367  *
368  * RETURN:      Status
369  *
370  * DESCRIPTION: Via any namespace object within an SSDT or OEMx table, unloads
371  *              the table and deletes all namespace objects associated with
372  *              that table. Unloading of the DSDT is not allowed.
373  *              Note: Mainly intended to support hotplug removal of SSDTs.
374  *
375  ******************************************************************************/
376 
377 ACPI_STATUS
378 AcpiUnloadParentTable (
379     ACPI_HANDLE             Object)
380 {
381     ACPI_NAMESPACE_NODE     *Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Object);
382     ACPI_STATUS             Status = AE_NOT_EXIST;
383     ACPI_OWNER_ID           OwnerId;
384     UINT32                  i;
385 
386 
387     ACPI_FUNCTION_TRACE (AcpiUnloadParentTable);
388 
389 
390     /* Parameter validation */
391 
392     if (!Object)
393     {
394         return_ACPI_STATUS (AE_BAD_PARAMETER);
395     }
396 
397     /*
398      * The node OwnerId is currently the same as the parent table ID.
399      * However, this could change in the future.
400      */
401     OwnerId = Node->OwnerId;
402     if (!OwnerId)
403     {
404         /* OwnerId==0 means DSDT is the owner. DSDT cannot be unloaded */
405 
406         return_ACPI_STATUS (AE_TYPE);
407     }
408 
409     /* Must acquire the interpreter lock during this operation */
410 
411     Status = AcpiUtAcquireMutex (ACPI_MTX_INTERPRETER);
412     if (ACPI_FAILURE (Status))
413     {
414         return_ACPI_STATUS (Status);
415     }
416 
417     /* Find the table in the global table list */
418 
419     for (i = 0; i < AcpiGbl_RootTableList.CurrentTableCount; i++)
420     {
421         if (OwnerId != AcpiGbl_RootTableList.Tables[i].OwnerId)
422         {
423             continue;
424         }
425 
426         /*
427          * Allow unload of SSDT and OEMx tables only. Do not allow unload
428          * of the DSDT. No other types of tables should get here, since
429          * only these types can contain AML and thus are the only types
430          * that can create namespace objects.
431          */
432         if (ACPI_COMPARE_NAME (
433             AcpiGbl_RootTableList.Tables[i].Signature.Ascii,
434             ACPI_SIG_DSDT))
435         {
436             Status = AE_TYPE;
437             break;
438         }
439 
440         /* Ensure the table is actually loaded */
441 
442         if (!AcpiTbIsTableLoaded (i))
443         {
444             Status = AE_NOT_EXIST;
445             break;
446         }
447 
448         /* Invoke table handler if present */
449 
450         if (AcpiGbl_TableHandler)
451         {
452             (void) AcpiGbl_TableHandler (ACPI_TABLE_EVENT_UNLOAD,
453                         AcpiGbl_RootTableList.Tables[i].Pointer,
454                         AcpiGbl_TableHandlerContext);
455         }
456 
457         /*
458          * Delete all namespace objects owned by this table. Note that
459          * these objects can appear anywhere in the namespace by virtue
460          * of the AML "Scope" operator. Thus, we need to track ownership
461          * by an ID, not simply a position within the hierarchy.
462          */
463         Status = AcpiTbDeleteNamespaceByOwner (i);
464         if (ACPI_FAILURE (Status))
465         {
466             break;
467         }
468 
469         Status = AcpiTbReleaseOwnerId (i);
470         AcpiTbSetTableLoadedFlag (i, FALSE);
471         break;
472     }
473 
474     (void) AcpiUtReleaseMutex (ACPI_MTX_INTERPRETER);
475     return_ACPI_STATUS (Status);
476 }
477 
478 ACPI_EXPORT_SYMBOL (AcpiUnloadParentTable)
479