xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/executer/exconfig.c (revision 2cad94c1c30b6223ad8c08710b26e071d32e9979)
1 /******************************************************************************
2  *
3  * Module Name: exconfig - Namespace reconfiguration (Load/Unload opcodes)
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2016, 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 
87  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89  * PARTICULAR PURPOSE.
90  *
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
98  * LIMITED REMEDY.
99  *
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.
114  *
115  *****************************************************************************/
116 
117 #include "acpi.h"
118 #include "accommon.h"
119 #include "acinterp.h"
120 #include "acnamesp.h"
121 #include "actables.h"
122 #include "acdispat.h"
123 #include "acevents.h"
124 #include "amlcode.h"
125 
126 
127 #define _COMPONENT          ACPI_EXECUTER
128         ACPI_MODULE_NAME    ("exconfig")
129 
130 /* Local prototypes */
131 
132 static ACPI_STATUS
133 AcpiExAddTable (
134     UINT32                  TableIndex,
135     ACPI_NAMESPACE_NODE     *ParentNode,
136     ACPI_OPERAND_OBJECT     **DdbHandle);
137 
138 static ACPI_STATUS
139 AcpiExRegionRead (
140     ACPI_OPERAND_OBJECT     *ObjDesc,
141     UINT32                  Length,
142     UINT8                   *Buffer);
143 
144 
145 /*******************************************************************************
146  *
147  * FUNCTION:    AcpiExAddTable
148  *
149  * PARAMETERS:  Table               - Pointer to raw table
150  *              ParentNode          - Where to load the table (scope)
151  *              DdbHandle           - Where to return the table handle.
152  *
153  * RETURN:      Status
154  *
155  * DESCRIPTION: Common function to Install and Load an ACPI table with a
156  *              returned table handle.
157  *
158  ******************************************************************************/
159 
160 static ACPI_STATUS
161 AcpiExAddTable (
162     UINT32                  TableIndex,
163     ACPI_NAMESPACE_NODE     *ParentNode,
164     ACPI_OPERAND_OBJECT     **DdbHandle)
165 {
166     ACPI_OPERAND_OBJECT     *ObjDesc;
167     ACPI_STATUS             Status;
168     ACPI_OWNER_ID           OwnerId;
169 
170 
171     ACPI_FUNCTION_TRACE (ExAddTable);
172 
173 
174     /* Create an object to be the table handle */
175 
176     ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_LOCAL_REFERENCE);
177     if (!ObjDesc)
178     {
179         return_ACPI_STATUS (AE_NO_MEMORY);
180     }
181 
182     /* Init the table handle */
183 
184     ObjDesc->Common.Flags |= AOPOBJ_DATA_VALID;
185     ObjDesc->Reference.Class = ACPI_REFCLASS_TABLE;
186     *DdbHandle = ObjDesc;
187 
188     /* Install the new table into the local data structures */
189 
190     ObjDesc->Reference.Value = TableIndex;
191 
192     /* Add the table to the namespace */
193 
194     Status = AcpiNsLoadTable (TableIndex, ParentNode);
195     if (ACPI_FAILURE (Status))
196     {
197         AcpiUtRemoveReference (ObjDesc);
198         *DdbHandle = NULL;
199         return_ACPI_STATUS (Status);
200     }
201 
202     /* Execute any module-level code that was found in the table */
203 
204     AcpiExExitInterpreter ();
205     if (AcpiGbl_GroupModuleLevelCode)
206     {
207         AcpiNsExecModuleCodeList ();
208     }
209     AcpiExEnterInterpreter ();
210 
211     /*
212      * Update GPEs for any new _Lxx/_Exx methods. Ignore errors. The host is
213      * responsible for discovering any new wake GPEs by running _PRW methods
214      * that may have been loaded by this table.
215      */
216     Status = AcpiTbGetOwnerId (TableIndex, &OwnerId);
217     if (ACPI_SUCCESS (Status))
218     {
219         AcpiEvUpdateGpes (OwnerId);
220     }
221 
222     return_ACPI_STATUS (AE_OK);
223 }
224 
225 
226 /*******************************************************************************
227  *
228  * FUNCTION:    AcpiExLoadTableOp
229  *
230  * PARAMETERS:  WalkState           - Current state with operands
231  *              ReturnDesc          - Where to store the return object
232  *
233  * RETURN:      Status
234  *
235  * DESCRIPTION: Load an ACPI table from the RSDT/XSDT
236  *
237  ******************************************************************************/
238 
239 ACPI_STATUS
240 AcpiExLoadTableOp (
241     ACPI_WALK_STATE         *WalkState,
242     ACPI_OPERAND_OBJECT     **ReturnDesc)
243 {
244     ACPI_STATUS             Status;
245     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
246     ACPI_NAMESPACE_NODE     *ParentNode;
247     ACPI_NAMESPACE_NODE     *StartNode;
248     ACPI_NAMESPACE_NODE     *ParameterNode = NULL;
249     ACPI_OPERAND_OBJECT     *DdbHandle;
250     ACPI_TABLE_HEADER       *Table;
251     UINT32                  TableIndex;
252 
253 
254     ACPI_FUNCTION_TRACE (ExLoadTableOp);
255 
256 
257     /* Find the ACPI table in the RSDT/XSDT */
258 
259     Status = AcpiTbFindTable (
260         Operand[0]->String.Pointer,
261         Operand[1]->String.Pointer,
262         Operand[2]->String.Pointer, &TableIndex);
263     if (ACPI_FAILURE (Status))
264     {
265         if (Status != AE_NOT_FOUND)
266         {
267             return_ACPI_STATUS (Status);
268         }
269 
270         /* Table not found, return an Integer=0 and AE_OK */
271 
272         DdbHandle = AcpiUtCreateIntegerObject ((UINT64) 0);
273         if (!DdbHandle)
274         {
275             return_ACPI_STATUS (AE_NO_MEMORY);
276         }
277 
278         *ReturnDesc = DdbHandle;
279         return_ACPI_STATUS (AE_OK);
280     }
281 
282     /* Default nodes */
283 
284     StartNode = WalkState->ScopeInfo->Scope.Node;
285     ParentNode = AcpiGbl_RootNode;
286 
287     /* RootPath (optional parameter) */
288 
289     if (Operand[3]->String.Length > 0)
290     {
291         /*
292          * Find the node referenced by the RootPathString. This is the
293          * location within the namespace where the table will be loaded.
294          */
295         Status = AcpiNsGetNode (StartNode, Operand[3]->String.Pointer,
296             ACPI_NS_SEARCH_PARENT, &ParentNode);
297         if (ACPI_FAILURE (Status))
298         {
299             return_ACPI_STATUS (Status);
300         }
301     }
302 
303     /* ParameterPath (optional parameter) */
304 
305     if (Operand[4]->String.Length > 0)
306     {
307         if ((Operand[4]->String.Pointer[0] != AML_ROOT_PREFIX) &&
308             (Operand[4]->String.Pointer[0] != AML_PARENT_PREFIX))
309         {
310             /*
311              * Path is not absolute, so it will be relative to the node
312              * referenced by the RootPathString (or the NS root if omitted)
313              */
314             StartNode = ParentNode;
315         }
316 
317         /* Find the node referenced by the ParameterPathString */
318 
319         Status = AcpiNsGetNode (StartNode, Operand[4]->String.Pointer,
320             ACPI_NS_SEARCH_PARENT, &ParameterNode);
321         if (ACPI_FAILURE (Status))
322         {
323             return_ACPI_STATUS (Status);
324         }
325     }
326 
327     /* Load the table into the namespace */
328 
329     Status = AcpiExAddTable (TableIndex, ParentNode, &DdbHandle);
330     if (ACPI_FAILURE (Status))
331     {
332         return_ACPI_STATUS (Status);
333     }
334 
335     /* Parameter Data (optional) */
336 
337     if (ParameterNode)
338     {
339         /* Store the parameter data into the optional parameter object */
340 
341         Status = AcpiExStore (Operand[5],
342             ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, ParameterNode), WalkState);
343         if (ACPI_FAILURE (Status))
344         {
345             (void) AcpiExUnloadTable (DdbHandle);
346 
347             AcpiUtRemoveReference (DdbHandle);
348             return_ACPI_STATUS (Status);
349         }
350     }
351 
352     Status = AcpiGetTableByIndex (TableIndex, &Table);
353     if (ACPI_SUCCESS (Status))
354     {
355         ACPI_INFO (("Dynamic OEM Table Load:"));
356         AcpiTbPrintTableHeader (0, Table);
357     }
358 
359     /* Invoke table handler if present */
360 
361     if (AcpiGbl_TableHandler)
362     {
363         (void) AcpiGbl_TableHandler (ACPI_TABLE_EVENT_LOAD, Table,
364             AcpiGbl_TableHandlerContext);
365     }
366 
367     *ReturnDesc = DdbHandle;
368     return_ACPI_STATUS (Status);
369 }
370 
371 
372 /*******************************************************************************
373  *
374  * FUNCTION:    AcpiExRegionRead
375  *
376  * PARAMETERS:  ObjDesc         - Region descriptor
377  *              Length          - Number of bytes to read
378  *              Buffer          - Pointer to where to put the data
379  *
380  * RETURN:      Status
381  *
382  * DESCRIPTION: Read data from an operation region. The read starts from the
383  *              beginning of the region.
384  *
385  ******************************************************************************/
386 
387 static ACPI_STATUS
388 AcpiExRegionRead (
389     ACPI_OPERAND_OBJECT     *ObjDesc,
390     UINT32                  Length,
391     UINT8                   *Buffer)
392 {
393     ACPI_STATUS             Status;
394     UINT64                  Value;
395     UINT32                  RegionOffset = 0;
396     UINT32                  i;
397 
398 
399     /* Bytewise reads */
400 
401     for (i = 0; i < Length; i++)
402     {
403         Status = AcpiEvAddressSpaceDispatch (ObjDesc, NULL, ACPI_READ,
404             RegionOffset, 8, &Value);
405         if (ACPI_FAILURE (Status))
406         {
407             return (Status);
408         }
409 
410         *Buffer = (UINT8) Value;
411         Buffer++;
412         RegionOffset++;
413     }
414 
415     return (AE_OK);
416 }
417 
418 
419 /*******************************************************************************
420  *
421  * FUNCTION:    AcpiExLoadOp
422  *
423  * PARAMETERS:  ObjDesc         - Region or Buffer/Field where the table will be
424  *                                obtained
425  *              Target          - Where a handle to the table will be stored
426  *              WalkState       - Current state
427  *
428  * RETURN:      Status
429  *
430  * DESCRIPTION: Load an ACPI table from a field or operation region
431  *
432  * NOTE: Region Fields (Field, BankField, IndexFields) are resolved to buffer
433  *       objects before this code is reached.
434  *
435  *       If source is an operation region, it must refer to SystemMemory, as
436  *       per the ACPI specification.
437  *
438  ******************************************************************************/
439 
440 ACPI_STATUS
441 AcpiExLoadOp (
442     ACPI_OPERAND_OBJECT     *ObjDesc,
443     ACPI_OPERAND_OBJECT     *Target,
444     ACPI_WALK_STATE         *WalkState)
445 {
446     ACPI_OPERAND_OBJECT     *DdbHandle;
447     ACPI_TABLE_HEADER       *TableHeader;
448     ACPI_TABLE_HEADER       *Table;
449     UINT32                  TableIndex;
450     ACPI_STATUS             Status;
451     UINT32                  Length;
452 
453 
454     ACPI_FUNCTION_TRACE (ExLoadOp);
455 
456 
457     /* Source Object can be either an OpRegion or a Buffer/Field */
458 
459     switch (ObjDesc->Common.Type)
460     {
461     case ACPI_TYPE_REGION:
462 
463         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
464             "Load table from Region %p\n", ObjDesc));
465 
466         /* Region must be SystemMemory (from ACPI spec) */
467 
468         if (ObjDesc->Region.SpaceId != ACPI_ADR_SPACE_SYSTEM_MEMORY)
469         {
470             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
471         }
472 
473         /*
474          * If the Region Address and Length have not been previously
475          * evaluated, evaluate them now and save the results.
476          */
477         if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID))
478         {
479             Status = AcpiDsGetRegionArguments (ObjDesc);
480             if (ACPI_FAILURE (Status))
481             {
482                 return_ACPI_STATUS (Status);
483             }
484         }
485 
486         /* Get the table header first so we can get the table length */
487 
488         TableHeader = ACPI_ALLOCATE (sizeof (ACPI_TABLE_HEADER));
489         if (!TableHeader)
490         {
491             return_ACPI_STATUS (AE_NO_MEMORY);
492         }
493 
494         Status = AcpiExRegionRead (ObjDesc, sizeof (ACPI_TABLE_HEADER),
495             ACPI_CAST_PTR (UINT8, TableHeader));
496         Length = TableHeader->Length;
497         ACPI_FREE (TableHeader);
498 
499         if (ACPI_FAILURE (Status))
500         {
501             return_ACPI_STATUS (Status);
502         }
503 
504         /* Must have at least an ACPI table header */
505 
506         if (Length < sizeof (ACPI_TABLE_HEADER))
507         {
508             return_ACPI_STATUS (AE_INVALID_TABLE_LENGTH);
509         }
510 
511         /*
512          * The original implementation simply mapped the table, with no copy.
513          * However, the memory region is not guaranteed to remain stable and
514          * we must copy the table to a local buffer. For example, the memory
515          * region is corrupted after suspend on some machines. Dynamically
516          * loaded tables are usually small, so this overhead is minimal.
517          *
518          * The latest implementation (5/2009) does not use a mapping at all.
519          * We use the low-level operation region interface to read the table
520          * instead of the obvious optimization of using a direct mapping.
521          * This maintains a consistent use of operation regions across the
522          * entire subsystem. This is important if additional processing must
523          * be performed in the (possibly user-installed) operation region
524          * handler. For example, AcpiExec and ASLTS depend on this.
525          */
526 
527         /* Allocate a buffer for the table */
528 
529         Table = ACPI_ALLOCATE (Length);
530         if (!Table)
531         {
532             return_ACPI_STATUS (AE_NO_MEMORY);
533         }
534 
535         /* Read the entire table */
536 
537         Status = AcpiExRegionRead (ObjDesc, Length,
538             ACPI_CAST_PTR (UINT8, Table));
539         if (ACPI_FAILURE (Status))
540         {
541             ACPI_FREE (Table);
542             return_ACPI_STATUS (Status);
543         }
544         break;
545 
546     case ACPI_TYPE_BUFFER: /* Buffer or resolved RegionField */
547 
548         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
549             "Load table from Buffer or Field %p\n", ObjDesc));
550 
551         /* Must have at least an ACPI table header */
552 
553         if (ObjDesc->Buffer.Length < sizeof (ACPI_TABLE_HEADER))
554         {
555             return_ACPI_STATUS (AE_INVALID_TABLE_LENGTH);
556         }
557 
558         /* Get the actual table length from the table header */
559 
560         TableHeader = ACPI_CAST_PTR (
561             ACPI_TABLE_HEADER, ObjDesc->Buffer.Pointer);
562         Length = TableHeader->Length;
563 
564         /* Table cannot extend beyond the buffer */
565 
566         if (Length > ObjDesc->Buffer.Length)
567         {
568             return_ACPI_STATUS (AE_AML_BUFFER_LIMIT);
569         }
570         if (Length < sizeof (ACPI_TABLE_HEADER))
571         {
572             return_ACPI_STATUS (AE_INVALID_TABLE_LENGTH);
573         }
574 
575         /*
576          * Copy the table from the buffer because the buffer could be
577          * modified or even deleted in the future
578          */
579         Table = ACPI_ALLOCATE (Length);
580         if (!Table)
581         {
582             return_ACPI_STATUS (AE_NO_MEMORY);
583         }
584 
585         memcpy (Table, TableHeader, Length);
586         break;
587 
588     default:
589 
590         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
591     }
592 
593     /* Install the new table into the local data structures */
594 
595     ACPI_INFO (("Dynamic OEM Table Load:"));
596     (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
597 
598     Status = AcpiTbInstallStandardTable (ACPI_PTR_TO_PHYSADDR (Table),
599         ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL, TRUE, TRUE,
600         &TableIndex);
601 
602     (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
603     if (ACPI_FAILURE (Status))
604     {
605         /* Delete allocated table buffer */
606 
607         ACPI_FREE (Table);
608         return_ACPI_STATUS (Status);
609     }
610 
611     /*
612      * Note: Now table is "INSTALLED", it must be validated before
613      * loading.
614      */
615     Status = AcpiTbValidateTable (
616         &AcpiGbl_RootTableList.Tables[TableIndex]);
617     if (ACPI_FAILURE (Status))
618     {
619         return_ACPI_STATUS (Status);
620     }
621 
622     /*
623      * Add the table to the namespace.
624      *
625      * Note: Load the table objects relative to the root of the namespace.
626      * This appears to go against the ACPI specification, but we do it for
627      * compatibility with other ACPI implementations.
628      */
629     Status = AcpiExAddTable (TableIndex, AcpiGbl_RootNode, &DdbHandle);
630     if (ACPI_FAILURE (Status))
631     {
632         /* On error, TablePtr was deallocated above */
633 
634         return_ACPI_STATUS (Status);
635     }
636 
637     /* Store the DdbHandle into the Target operand */
638 
639     Status = AcpiExStore (DdbHandle, Target, WalkState);
640     if (ACPI_FAILURE (Status))
641     {
642         (void) AcpiExUnloadTable (DdbHandle);
643 
644         /* TablePtr was deallocated above */
645 
646         AcpiUtRemoveReference (DdbHandle);
647         return_ACPI_STATUS (Status);
648     }
649 
650     /* Remove the reference by added by AcpiExStore above */
651 
652     AcpiUtRemoveReference (DdbHandle);
653 
654     /* Invoke table handler if present */
655 
656     if (AcpiGbl_TableHandler)
657     {
658         (void) AcpiGbl_TableHandler (ACPI_TABLE_EVENT_LOAD, Table,
659             AcpiGbl_TableHandlerContext);
660     }
661 
662     return_ACPI_STATUS (Status);
663 }
664 
665 
666 /*******************************************************************************
667  *
668  * FUNCTION:    AcpiExUnloadTable
669  *
670  * PARAMETERS:  DdbHandle           - Handle to a previously loaded table
671  *
672  * RETURN:      Status
673  *
674  * DESCRIPTION: Unload an ACPI table
675  *
676  ******************************************************************************/
677 
678 ACPI_STATUS
679 AcpiExUnloadTable (
680     ACPI_OPERAND_OBJECT     *DdbHandle)
681 {
682     ACPI_STATUS             Status = AE_OK;
683     ACPI_OPERAND_OBJECT     *TableDesc = DdbHandle;
684     UINT32                  TableIndex;
685     ACPI_TABLE_HEADER       *Table;
686 
687 
688     ACPI_FUNCTION_TRACE (ExUnloadTable);
689 
690 
691     /*
692      * Temporarily emit a warning so that the ASL for the machine can be
693      * hopefully obtained. This is to say that the Unload() operator is
694      * extremely rare if not completely unused.
695      */
696     ACPI_WARNING ((AE_INFO,
697         "Received request to unload an ACPI table"));
698 
699     /*
700      * Validate the handle
701      * Although the handle is partially validated in AcpiExReconfiguration()
702      * when it calls AcpiExResolveOperands(), the handle is more completely
703      * validated here.
704      *
705      * Handle must be a valid operand object of type reference. Also, the
706      * DdbHandle must still be marked valid (table has not been previously
707      * unloaded)
708      */
709     if ((!DdbHandle) ||
710         (ACPI_GET_DESCRIPTOR_TYPE (DdbHandle) != ACPI_DESC_TYPE_OPERAND) ||
711         (DdbHandle->Common.Type != ACPI_TYPE_LOCAL_REFERENCE) ||
712         (!(DdbHandle->Common.Flags & AOPOBJ_DATA_VALID)))
713     {
714         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
715     }
716 
717     /* Get the table index from the DdbHandle */
718 
719     TableIndex = TableDesc->Reference.Value;
720 
721     /* Ensure the table is still loaded */
722 
723     if (!AcpiTbIsTableLoaded (TableIndex))
724     {
725         return_ACPI_STATUS (AE_NOT_EXIST);
726     }
727 
728     /* Invoke table handler if present */
729 
730     if (AcpiGbl_TableHandler)
731     {
732         Status = AcpiGetTableByIndex (TableIndex, &Table);
733         if (ACPI_SUCCESS (Status))
734         {
735             (void) AcpiGbl_TableHandler (ACPI_TABLE_EVENT_UNLOAD, Table,
736                 AcpiGbl_TableHandlerContext);
737         }
738     }
739 
740     /* Delete the portion of the namespace owned by this table */
741 
742     Status = AcpiTbDeleteNamespaceByOwner (TableIndex);
743     if (ACPI_FAILURE (Status))
744     {
745         return_ACPI_STATUS (Status);
746     }
747 
748     (void) AcpiTbReleaseOwnerId (TableIndex);
749     AcpiTbSetTableLoadedFlag (TableIndex, FALSE);
750 
751     /*
752      * Invalidate the handle. We do this because the handle may be stored
753      * in a named object and may not be actually deleted until much later.
754      */
755     DdbHandle->Common.Flags &= ~AOPOBJ_DATA_VALID;
756     return_ACPI_STATUS (AE_OK);
757 }
758