1 /******************************************************************************
3 * Module Name: exconfig - Namespace reconfiguration (Load/Unload opcodes)
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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 __EXCONFIG_C__
120 #include "accommon.h"
121 #include "acinterp.h"
122 #include "acnamesp.h"
123 #include "actables.h"
124 #include "acdispat.h"
125 #include "acevents.h"
128 #define _COMPONENT ACPI_EXECUTER
129 ACPI_MODULE_NAME ("exconfig")
131 /* Local prototypes */
136 ACPI_NAMESPACE_NODE
*ParentNode
,
137 ACPI_OPERAND_OBJECT
**DdbHandle
);
141 ACPI_OPERAND_OBJECT
*ObjDesc
,
146 /*******************************************************************************
148 * FUNCTION: AcpiExAddTable
150 * PARAMETERS: Table - Pointer to raw table
151 * ParentNode - Where to load the table (scope)
152 * DdbHandle - Where to return the table handle.
156 * DESCRIPTION: Common function to Install and Load an ACPI table with a
157 * returned table handle.
159 ******************************************************************************/
164 ACPI_NAMESPACE_NODE
*ParentNode
,
165 ACPI_OPERAND_OBJECT
**DdbHandle
)
167 ACPI_OPERAND_OBJECT
*ObjDesc
;
169 ACPI_OWNER_ID OwnerId
;
172 ACPI_FUNCTION_TRACE (ExAddTable
);
175 /* Create an object to be the table handle */
177 ObjDesc
= AcpiUtCreateInternalObject (ACPI_TYPE_LOCAL_REFERENCE
);
180 return_ACPI_STATUS (AE_NO_MEMORY
);
183 /* Init the table handle */
185 ObjDesc
->Common
.Flags
|= AOPOBJ_DATA_VALID
;
186 ObjDesc
->Reference
.Class
= ACPI_REFCLASS_TABLE
;
187 *DdbHandle
= ObjDesc
;
189 /* Install the new table into the local data structures */
191 ObjDesc
->Reference
.Value
= TableIndex
;
193 /* Add the table to the namespace */
195 Status
= AcpiNsLoadTable (TableIndex
, ParentNode
);
196 if (ACPI_FAILURE (Status
))
198 AcpiUtRemoveReference (ObjDesc
);
200 return_ACPI_STATUS (Status
);
203 /* Execute any module-level code that was found in the table */
205 AcpiExExitInterpreter ();
206 AcpiNsExecModuleCodeList ();
207 AcpiExEnterInterpreter ();
209 /* Update GPEs for any new _PRW or _Lxx/_Exx methods. Ignore errors */
211 Status
= AcpiTbGetOwnerId (TableIndex
, &OwnerId
);
212 if (ACPI_SUCCESS (Status
))
214 AcpiEvUpdateGpes (OwnerId
);
217 return_ACPI_STATUS (AE_OK
);
221 /*******************************************************************************
223 * FUNCTION: AcpiExLoadTableOp
225 * PARAMETERS: WalkState - Current state with operands
226 * ReturnDesc - Where to store the return object
230 * DESCRIPTION: Load an ACPI table from the RSDT/XSDT
232 ******************************************************************************/
236 ACPI_WALK_STATE
*WalkState
,
237 ACPI_OPERAND_OBJECT
**ReturnDesc
)
240 ACPI_OPERAND_OBJECT
**Operand
= &WalkState
->Operands
[0];
241 ACPI_NAMESPACE_NODE
*ParentNode
;
242 ACPI_NAMESPACE_NODE
*StartNode
;
243 ACPI_NAMESPACE_NODE
*ParameterNode
= NULL
;
244 ACPI_OPERAND_OBJECT
*DdbHandle
;
245 ACPI_TABLE_HEADER
*Table
;
249 ACPI_FUNCTION_TRACE (ExLoadTableOp
);
252 /* Validate lengths for the SignatureString, OEMIDString, OEMTableID */
254 if ((Operand
[0]->String
.Length
> ACPI_NAME_SIZE
) ||
255 (Operand
[1]->String
.Length
> ACPI_OEM_ID_SIZE
) ||
256 (Operand
[2]->String
.Length
> ACPI_OEM_TABLE_ID_SIZE
))
258 return_ACPI_STATUS (AE_BAD_PARAMETER
);
261 /* Find the ACPI table in the RSDT/XSDT */
263 Status
= AcpiTbFindTable (Operand
[0]->String
.Pointer
,
264 Operand
[1]->String
.Pointer
,
265 Operand
[2]->String
.Pointer
, &TableIndex
);
266 if (ACPI_FAILURE (Status
))
268 if (Status
!= AE_NOT_FOUND
)
270 return_ACPI_STATUS (Status
);
273 /* Table not found, return an Integer=0 and AE_OK */
275 DdbHandle
= AcpiUtCreateIntegerObject ((UINT64
) 0);
278 return_ACPI_STATUS (AE_NO_MEMORY
);
281 *ReturnDesc
= DdbHandle
;
282 return_ACPI_STATUS (AE_OK
);
287 StartNode
= WalkState
->ScopeInfo
->Scope
.Node
;
288 ParentNode
= AcpiGbl_RootNode
;
290 /* RootPath (optional parameter) */
292 if (Operand
[3]->String
.Length
> 0)
295 * Find the node referenced by the RootPathString. This is the
296 * location within the namespace where the table will be loaded.
298 Status
= AcpiNsGetNode (StartNode
, Operand
[3]->String
.Pointer
,
299 ACPI_NS_SEARCH_PARENT
, &ParentNode
);
300 if (ACPI_FAILURE (Status
))
302 return_ACPI_STATUS (Status
);
306 /* ParameterPath (optional parameter) */
308 if (Operand
[4]->String
.Length
> 0)
310 if ((Operand
[4]->String
.Pointer
[0] != '\\') &&
311 (Operand
[4]->String
.Pointer
[0] != '^'))
314 * Path is not absolute, so it will be relative to the node
315 * referenced by the RootPathString (or the NS root if omitted)
317 StartNode
= ParentNode
;
320 /* Find the node referenced by the ParameterPathString */
322 Status
= AcpiNsGetNode (StartNode
, Operand
[4]->String
.Pointer
,
323 ACPI_NS_SEARCH_PARENT
, &ParameterNode
);
324 if (ACPI_FAILURE (Status
))
326 return_ACPI_STATUS (Status
);
330 /* Load the table into the namespace */
332 Status
= AcpiExAddTable (TableIndex
, ParentNode
, &DdbHandle
);
333 if (ACPI_FAILURE (Status
))
335 return_ACPI_STATUS (Status
);
338 /* Parameter Data (optional) */
342 /* Store the parameter data into the optional parameter object */
344 Status
= AcpiExStore (Operand
[5],
345 ACPI_CAST_PTR (ACPI_OPERAND_OBJECT
, ParameterNode
),
347 if (ACPI_FAILURE (Status
))
349 (void) AcpiExUnloadTable (DdbHandle
);
351 AcpiUtRemoveReference (DdbHandle
);
352 return_ACPI_STATUS (Status
);
356 Status
= AcpiGetTableByIndex (TableIndex
, &Table
);
357 if (ACPI_SUCCESS (Status
))
359 ACPI_INFO ((AE_INFO
, "Dynamic OEM Table Load:"));
360 AcpiTbPrintTableHeader (0, Table
);
363 /* Invoke table handler if present */
365 if (AcpiGbl_TableHandler
)
367 (void) AcpiGbl_TableHandler (ACPI_TABLE_EVENT_LOAD
, Table
,
368 AcpiGbl_TableHandlerContext
);
371 *ReturnDesc
= DdbHandle
;
372 return_ACPI_STATUS (Status
);
376 /*******************************************************************************
378 * FUNCTION: AcpiExRegionRead
380 * PARAMETERS: ObjDesc - Region descriptor
381 * Length - Number of bytes to read
382 * Buffer - Pointer to where to put the data
386 * DESCRIPTION: Read data from an operation region. The read starts from the
387 * beginning of the region.
389 ******************************************************************************/
393 ACPI_OPERAND_OBJECT
*ObjDesc
,
399 UINT32 RegionOffset
= 0;
405 for (i
= 0; i
< Length
; i
++)
407 Status
= AcpiEvAddressSpaceDispatch (ObjDesc
, ACPI_READ
,
408 RegionOffset
, 8, &Value
);
409 if (ACPI_FAILURE (Status
))
414 *Buffer
= (UINT8
) Value
;
423 /*******************************************************************************
425 * FUNCTION: AcpiExLoadOp
427 * PARAMETERS: ObjDesc - Region or Buffer/Field where the table will be
429 * Target - Where a handle to the table will be stored
430 * WalkState - Current state
434 * DESCRIPTION: Load an ACPI table from a field or operation region
436 * NOTE: Region Fields (Field, BankField, IndexFields) are resolved to buffer
437 * objects before this code is reached.
439 * If source is an operation region, it must refer to SystemMemory, as
440 * per the ACPI specification.
442 ******************************************************************************/
446 ACPI_OPERAND_OBJECT
*ObjDesc
,
447 ACPI_OPERAND_OBJECT
*Target
,
448 ACPI_WALK_STATE
*WalkState
)
450 ACPI_OPERAND_OBJECT
*DdbHandle
;
451 ACPI_TABLE_HEADER
*Table
;
452 ACPI_TABLE_DESC TableDesc
;
458 ACPI_FUNCTION_TRACE (ExLoadOp
);
461 ACPI_MEMSET (&TableDesc
, 0, sizeof (ACPI_TABLE_DESC
));
463 /* Source Object can be either an OpRegion or a Buffer/Field */
465 switch (ObjDesc
->Common
.Type
)
467 case ACPI_TYPE_REGION
:
469 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
,
470 "Load table from Region %p\n", ObjDesc
));
472 /* Region must be SystemMemory (from ACPI spec) */
474 if (ObjDesc
->Region
.SpaceId
!= ACPI_ADR_SPACE_SYSTEM_MEMORY
)
476 return_ACPI_STATUS (AE_AML_OPERAND_TYPE
);
480 * If the Region Address and Length have not been previously evaluated,
481 * evaluate them now and save the results.
483 if (!(ObjDesc
->Common
.Flags
& AOPOBJ_DATA_VALID
))
485 Status
= AcpiDsGetRegionArguments (ObjDesc
);
486 if (ACPI_FAILURE (Status
))
488 return_ACPI_STATUS (Status
);
492 /* Get the table header first so we can get the table length */
494 Table
= ACPI_ALLOCATE (sizeof (ACPI_TABLE_HEADER
));
497 return_ACPI_STATUS (AE_NO_MEMORY
);
500 Status
= AcpiExRegionRead (ObjDesc
, sizeof (ACPI_TABLE_HEADER
),
501 ACPI_CAST_PTR (UINT8
, Table
));
502 Length
= Table
->Length
;
505 if (ACPI_FAILURE (Status
))
507 return_ACPI_STATUS (Status
);
510 /* Must have at least an ACPI table header */
512 if (Length
< sizeof (ACPI_TABLE_HEADER
))
514 return_ACPI_STATUS (AE_INVALID_TABLE_LENGTH
);
518 * The original implementation simply mapped the table, with no copy.
519 * However, the memory region is not guaranteed to remain stable and
520 * we must copy the table to a local buffer. For example, the memory
521 * region is corrupted after suspend on some machines. Dynamically
522 * loaded tables are usually small, so this overhead is minimal.
524 * The latest implementation (5/2009) does not use a mapping at all.
525 * We use the low-level operation region interface to read the table
526 * instead of the obvious optimization of using a direct mapping.
527 * This maintains a consistent use of operation regions across the
528 * entire subsystem. This is important if additional processing must
529 * be performed in the (possibly user-installed) operation region
530 * handler. For example, AcpiExec and ASLTS depend on this.
533 /* Allocate a buffer for the table */
535 TableDesc
.Pointer
= ACPI_ALLOCATE (Length
);
536 if (!TableDesc
.Pointer
)
538 return_ACPI_STATUS (AE_NO_MEMORY
);
541 /* Read the entire table */
543 Status
= AcpiExRegionRead (ObjDesc
, Length
,
544 ACPI_CAST_PTR (UINT8
, TableDesc
.Pointer
));
545 if (ACPI_FAILURE (Status
))
547 ACPI_FREE (TableDesc
.Pointer
);
548 return_ACPI_STATUS (Status
);
551 TableDesc
.Address
= ObjDesc
->Region
.Address
;
555 case ACPI_TYPE_BUFFER
: /* Buffer or resolved RegionField */
557 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC
,
558 "Load table from Buffer or Field %p\n", ObjDesc
));
560 /* Must have at least an ACPI table header */
562 if (ObjDesc
->Buffer
.Length
< sizeof (ACPI_TABLE_HEADER
))
564 return_ACPI_STATUS (AE_INVALID_TABLE_LENGTH
);
567 /* Get the actual table length from the table header */
569 Table
= ACPI_CAST_PTR (ACPI_TABLE_HEADER
, ObjDesc
->Buffer
.Pointer
);
570 Length
= Table
->Length
;
572 /* Table cannot extend beyond the buffer */
574 if (Length
> ObjDesc
->Buffer
.Length
)
576 return_ACPI_STATUS (AE_AML_BUFFER_LIMIT
);
578 if (Length
< sizeof (ACPI_TABLE_HEADER
))
580 return_ACPI_STATUS (AE_INVALID_TABLE_LENGTH
);
584 * Copy the table from the buffer because the buffer could be modified
585 * or even deleted in the future
587 TableDesc
.Pointer
= ACPI_ALLOCATE (Length
);
588 if (!TableDesc
.Pointer
)
590 return_ACPI_STATUS (AE_NO_MEMORY
);
593 ACPI_MEMCPY (TableDesc
.Pointer
, Table
, Length
);
594 TableDesc
.Address
= ACPI_TO_INTEGER (TableDesc
.Pointer
);
599 return_ACPI_STATUS (AE_AML_OPERAND_TYPE
);
602 /* Validate table checksum (will not get validated in TbAddTable) */
604 Status
= AcpiTbVerifyChecksum (TableDesc
.Pointer
, Length
);
605 if (ACPI_FAILURE (Status
))
607 ACPI_FREE (TableDesc
.Pointer
);
608 return_ACPI_STATUS (Status
);
611 /* Complete the table descriptor */
613 TableDesc
.Length
= Length
;
614 TableDesc
.Flags
= ACPI_TABLE_ORIGIN_ALLOCATED
;
616 /* Install the new table into the local data structures */
618 Status
= AcpiTbAddTable (&TableDesc
, &TableIndex
);
619 if (ACPI_FAILURE (Status
))
621 /* Delete allocated table buffer */
623 AcpiTbDeleteTable (&TableDesc
);
624 return_ACPI_STATUS (Status
);
628 * Add the table to the namespace.
630 * Note: Load the table objects relative to the root of the namespace.
631 * This appears to go against the ACPI specification, but we do it for
632 * compatibility with other ACPI implementations.
634 Status
= AcpiExAddTable (TableIndex
, AcpiGbl_RootNode
, &DdbHandle
);
635 if (ACPI_FAILURE (Status
))
637 /* On error, TablePtr was deallocated above */
639 return_ACPI_STATUS (Status
);
642 /* Store the DdbHandle into the Target operand */
644 Status
= AcpiExStore (DdbHandle
, Target
, WalkState
);
645 if (ACPI_FAILURE (Status
))
647 (void) AcpiExUnloadTable (DdbHandle
);
649 /* TablePtr was deallocated above */
651 AcpiUtRemoveReference (DdbHandle
);
652 return_ACPI_STATUS (Status
);
655 ACPI_INFO ((AE_INFO
, "Dynamic OEM Table Load:"));
656 AcpiTbPrintTableHeader (0, TableDesc
.Pointer
);
658 /* Remove the reference by added by AcpiExStore above */
660 AcpiUtRemoveReference (DdbHandle
);
662 /* Invoke table handler if present */
664 if (AcpiGbl_TableHandler
)
666 (void) AcpiGbl_TableHandler (ACPI_TABLE_EVENT_LOAD
, TableDesc
.Pointer
,
667 AcpiGbl_TableHandlerContext
);
670 return_ACPI_STATUS (Status
);
674 /*******************************************************************************
676 * FUNCTION: AcpiExUnloadTable
678 * PARAMETERS: DdbHandle - Handle to a previously loaded table
682 * DESCRIPTION: Unload an ACPI table
684 ******************************************************************************/
688 ACPI_OPERAND_OBJECT
*DdbHandle
)
690 ACPI_STATUS Status
= AE_OK
;
691 ACPI_OPERAND_OBJECT
*TableDesc
= DdbHandle
;
693 ACPI_TABLE_HEADER
*Table
;
696 ACPI_FUNCTION_TRACE (ExUnloadTable
);
700 * Validate the handle
701 * Although the handle is partially validated in AcpiExReconfiguration()
702 * when it calls AcpiExResolveOperands(), the handle is more completely
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
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
)))
714 return_ACPI_STATUS (AE_BAD_PARAMETER
);
717 /* Get the table index from the DdbHandle */
719 TableIndex
= TableDesc
->Reference
.Value
;
721 /* Ensure the table is still loaded */
723 if (!AcpiTbIsTableLoaded (TableIndex
))
725 return_ACPI_STATUS (AE_NOT_EXIST
);
728 /* Invoke table handler if present */
730 if (AcpiGbl_TableHandler
)
732 Status
= AcpiGetTableByIndex (TableIndex
, &Table
);
733 if (ACPI_SUCCESS (Status
))
735 (void) AcpiGbl_TableHandler (ACPI_TABLE_EVENT_UNLOAD
, Table
,
736 AcpiGbl_TableHandlerContext
);
740 /* Delete the portion of the namespace owned by this table */
742 Status
= AcpiTbDeleteNamespaceByOwner (TableIndex
);
743 if (ACPI_FAILURE (Status
))
745 return_ACPI_STATUS (Status
);
748 (void) AcpiTbReleaseOwnerId (TableIndex
);
749 AcpiTbSetTableLoadedFlag (TableIndex
, FALSE
);
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.
755 DdbHandle
->Common
.Flags
&= ~AOPOBJ_DATA_VALID
;
756 return_ACPI_STATUS (AE_OK
);