1 /******************************************************************************
3 * Module Name: nsinit - namespace initialization
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2006, 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 *****************************************************************************/
118 #define __NSXFINIT_C__
121 #include "acnamesp.h"
122 #include "acdispat.h"
123 #include "acinterp.h"
125 #define _COMPONENT ACPI_NAMESPACE
126 ACPI_MODULE_NAME ("nsinit")
128 /* Local prototypes */
131 AcpiNsInitOneObject (
132 ACPI_HANDLE ObjHandle,
138 AcpiNsInitOneDevice (
139 ACPI_HANDLE ObjHandle,
145 AcpiNsFindIniMethods (
146 ACPI_HANDLE ObjHandle,
152 /*******************************************************************************
154 * FUNCTION: AcpiNsInitializeObjects
160 * DESCRIPTION: Walk the entire namespace and perform any necessary
161 * initialization on the objects found therein
163 ******************************************************************************/
166 AcpiNsInitializeObjects (
170 ACPI_INIT_WALK_INFO Info;
173 ACPI_FUNCTION_TRACE (NsInitializeObjects);
176 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
177 "**** Starting initialization of namespace objects ****\n"));
178 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
179 "Completing Region/Field/Buffer/Package initialization:"));
181 /* Set all init info to zero */
183 ACPI_MEMSET (&Info, 0, sizeof (ACPI_INIT_WALK_INFO));
185 /* Walk entire namespace from the supplied root */
187 Status = AcpiWalkNamespace (ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
188 ACPI_UINT32_MAX, AcpiNsInitOneObject,
190 if (ACPI_FAILURE (Status))
192 ACPI_EXCEPTION ((AE_INFO, Status, "During WalkNamespace"));
195 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
196 "\nInitialized %hd/%hd Regions %hd/%hd Fields %hd/%hd Buffers %hd/%hd Packages (%hd nodes)\n",
197 Info.OpRegionInit, Info.OpRegionCount,
198 Info.FieldInit, Info.FieldCount,
199 Info.BufferInit, Info.BufferCount,
200 Info.PackageInit, Info.PackageCount, Info.ObjectCount));
202 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
203 "%hd Control Methods found\n", Info.MethodCount));
204 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
205 "%hd Op Regions found\n", Info.OpRegionCount));
207 return_ACPI_STATUS (AE_OK);
211 /*******************************************************************************
213 * FUNCTION: AcpiNsInitializeDevices
217 * RETURN: ACPI_STATUS
219 * DESCRIPTION: Walk the entire namespace and initialize all ACPI devices.
220 * This means running _INI on all present devices.
222 * Note: We install PCI config space handler on region access,
225 ******************************************************************************/
228 AcpiNsInitializeDevices (
232 ACPI_DEVICE_WALK_INFO Info;
235 ACPI_FUNCTION_TRACE (NsInitializeDevices);
240 Info.DeviceCount = 0;
244 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
245 "Initializing Device/Processor/Thermal objects by executing _INI methods:"));
247 /* Tree analysis: find all subtrees that contain _INI methods */
249 Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
250 ACPI_UINT32_MAX, FALSE, AcpiNsFindIniMethods, &Info, NULL);
251 if (ACPI_FAILURE (Status))
256 /* Allocate the evaluation information block */
258 Info.EvaluateInfo = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
259 if (!Info.EvaluateInfo)
261 Status = AE_NO_MEMORY;
265 /* Walk namespace to execute all _INIs on present devices */
267 Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
268 ACPI_UINT32_MAX, FALSE, AcpiNsInitOneDevice, &Info, NULL);
270 ACPI_FREE (Info.EvaluateInfo);
271 if (ACPI_FAILURE (Status))
276 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
277 "\nExecuted %hd _INI methods requiring %hd _STA executions (examined %hd objects)\n",
278 Info.Num_INI, Info.Num_STA, Info.DeviceCount));
280 return_ACPI_STATUS (Status);
284 ACPI_EXCEPTION ((AE_INFO, Status, "During device initialization"));
285 return_ACPI_STATUS (Status);
289 /*******************************************************************************
291 * FUNCTION: AcpiNsInitOneObject
293 * PARAMETERS: ObjHandle - Node
294 * Level - Current nesting level
295 * Context - Points to a init info struct
296 * ReturnValue - Not used
300 * DESCRIPTION: Callback from AcpiWalkNamespace. Invoked for every object
301 * within the namespace.
303 * Currently, the only objects that require initialization are:
307 ******************************************************************************/
310 AcpiNsInitOneObject (
311 ACPI_HANDLE ObjHandle,
316 ACPI_OBJECT_TYPE Type;
317 ACPI_STATUS Status = AE_OK;
318 ACPI_INIT_WALK_INFO *Info = (ACPI_INIT_WALK_INFO *) Context;
319 ACPI_NAMESPACE_NODE *Node = (ACPI_NAMESPACE_NODE *) ObjHandle;
320 ACPI_OPERAND_OBJECT *ObjDesc;
323 ACPI_FUNCTION_NAME (NsInitOneObject);
328 /* And even then, we are only interested in a few object types */
330 Type = AcpiNsGetType (ObjHandle);
331 ObjDesc = AcpiNsGetAttachedObject (Node);
337 /* Increment counters for object types we are looking for */
341 case ACPI_TYPE_REGION:
342 Info->OpRegionCount++;
345 case ACPI_TYPE_BUFFER_FIELD:
349 case ACPI_TYPE_BUFFER:
353 case ACPI_TYPE_PACKAGE:
354 Info->PackageCount++;
359 /* No init required, just exit now */
364 * If the object is already initialized, nothing else to do
366 if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
372 * Must lock the interpreter before executing AML code
374 AcpiExEnterInterpreter ();
377 * Each of these types can contain executable AML code within the
382 case ACPI_TYPE_REGION:
384 Info->OpRegionInit++;
385 Status = AcpiDsGetRegionArguments (ObjDesc);
388 case ACPI_TYPE_BUFFER_FIELD:
391 Status = AcpiDsGetBufferFieldArguments (ObjDesc);
394 case ACPI_TYPE_BUFFER:
397 Status = AcpiDsGetBufferArguments (ObjDesc);
400 case ACPI_TYPE_PACKAGE:
403 Status = AcpiDsGetPackageArguments (ObjDesc);
407 /* No other types can get here */
411 if (ACPI_FAILURE (Status))
413 ACPI_EXCEPTION ((AE_INFO, Status,
414 "Could not execute arguments for [%4.4s] (%s)",
415 AcpiUtGetNodeName (Node), AcpiUtGetTypeName (Type)));
419 * Print a dot for each object unless we are going to print the entire
422 if (!(AcpiDbgLevel & ACPI_LV_INIT_NAMES))
424 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT, "."));
428 * We ignore errors from above, and always return OK, since we don't want
429 * to abort the walk on any single error.
431 AcpiExExitInterpreter ();
436 /*******************************************************************************
438 * FUNCTION: AcpiNsFindIniMethods
440 * PARAMETERS: ACPI_WALK_CALLBACK
442 * RETURN: ACPI_STATUS
444 * DESCRIPTION: Called during namespace walk. Finds objects named _INI under
445 * device/processor/thermal objects, and marks the entire subtree
446 * with a SUBTREE_HAS_INI flag. This flag is used during the
447 * subsequent device initialization walk to avoid entire subtrees
448 * that do not contain an _INI.
450 ******************************************************************************/
453 AcpiNsFindIniMethods (
454 ACPI_HANDLE ObjHandle,
459 ACPI_DEVICE_WALK_INFO *Info = ACPI_CAST_PTR (ACPI_DEVICE_WALK_INFO, Context);
460 ACPI_NAMESPACE_NODE *Node;
461 ACPI_NAMESPACE_NODE *ParentNode;
464 /* Keep count of device/processor/thermal objects */
466 Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjHandle);
467 if ((Node->Type == ACPI_TYPE_DEVICE) ||
468 (Node->Type == ACPI_TYPE_PROCESSOR) ||
469 (Node->Type == ACPI_TYPE_THERMAL))
475 /* We are only looking for methods named _INI */
477 if (!ACPI_COMPARE_NAME (Node->Name.Ascii, METHOD_NAME__INI))
483 * The only _INI methods that we care about are those that are
484 * present under Device, Processor, and Thermal objects.
486 ParentNode = AcpiNsGetParentNode (Node);
487 switch (ParentNode->Type)
489 case ACPI_TYPE_DEVICE:
490 case ACPI_TYPE_PROCESSOR:
491 case ACPI_TYPE_THERMAL:
493 /* Mark parent and bubble up the INI present flag to the root */
497 ParentNode->Flags |= ANOBJ_SUBTREE_HAS_INI;
498 ParentNode = AcpiNsGetParentNode (ParentNode);
510 /*******************************************************************************
512 * FUNCTION: AcpiNsInitOneDevice
514 * PARAMETERS: ACPI_WALK_CALLBACK
516 * RETURN: ACPI_STATUS
518 * DESCRIPTION: This is called once per device soon after ACPI is enabled
519 * to initialize each device. It determines if the device is
520 * present, and if so, calls _INI.
522 ******************************************************************************/
525 AcpiNsInitOneDevice (
526 ACPI_HANDLE ObjHandle,
531 ACPI_DEVICE_WALK_INFO *WalkInfo = ACPI_CAST_PTR (ACPI_DEVICE_WALK_INFO, Context);
532 ACPI_EVALUATE_INFO *Info = WalkInfo->EvaluateInfo;
535 ACPI_NAMESPACE_NODE *DeviceNode;
538 ACPI_FUNCTION_TRACE (NsInitOneDevice);
541 /* We are interested in Devices, Processors and ThermalZones only */
543 DeviceNode = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjHandle);
544 if ((DeviceNode->Type != ACPI_TYPE_DEVICE) &&
545 (DeviceNode->Type != ACPI_TYPE_PROCESSOR) &&
546 (DeviceNode->Type != ACPI_TYPE_THERMAL))
548 return_ACPI_STATUS (AE_OK);
552 * Because of an earlier namespace analysis, all subtrees that contain an
553 * _INI method are tagged.
555 * If this device subtree does not contain any _INI methods, we
556 * can exit now and stop traversing this entire subtree.
558 if (!(DeviceNode->Flags & ANOBJ_SUBTREE_HAS_INI))
560 return_ACPI_STATUS (AE_CTRL_DEPTH);
564 * Run _STA to determine if this device is present and functioning. We
565 * must know this information for two important reasons (from ACPI spec):
567 * 1) We can only run _INI if the device is present.
568 * 2) We must abort the device tree walk on this subtree if the device is
569 * not present and is not functional (we will not examine the children)
571 * The _STA method is not required to be present under the device, we
572 * assume the device is present if _STA does not exist.
574 ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (
575 ACPI_TYPE_METHOD, DeviceNode, METHOD_NAME__STA));
577 Status = AcpiUtExecute_STA (DeviceNode, &Flags);
578 if (ACPI_FAILURE (Status))
580 /* Ignore error and move on to next device */
582 return_ACPI_STATUS (AE_OK);
586 * Flags == -1 means that _STA was not found. In this case, we assume that
587 * the device is both present and functional.
589 * From the ACPI spec, description of _STA:
591 * "If a device object (including the processor object) does not have an
592 * _STA object, then OSPM assumes that all of the above bits are set (in
593 * other words, the device is present, ..., and functioning)"
595 if (Flags != ACPI_UINT32_MAX)
601 * Examine the PRESENT and FUNCTIONING status bits
603 * Note: ACPI spec does not seem to specify behavior for the present but
604 * not functioning case, so we assume functioning if present.
606 if (!(Flags & ACPI_STA_DEVICE_PRESENT))
608 /* Device is not present, we must examine the Functioning bit */
610 if (Flags & ACPI_STA_DEVICE_FUNCTIONING)
613 * Device is not present but is "functioning". In this case,
614 * we will not run _INI, but we continue to examine the children
617 * From the ACPI spec, description of _STA: (Note - no mention
618 * of whether to run _INI or not on the device in question)
620 * "_STA may return bit 0 clear (not present) with bit 3 set
621 * (device is functional). This case is used to indicate a valid
622 * device for which no device driver should be loaded (for example,
623 * a bridge device.) Children of this device may be present and
624 * valid. OSPM should continue enumeration below a device whose
625 * _STA returns this bit combination"
627 return_ACPI_STATUS (AE_OK);
632 * Device is not present and is not functioning. We must abort the
633 * walk of this subtree immediately -- don't look at the children
636 * From the ACPI spec, description of _INI:
638 * "If the _STA method indicates that the device is not present,
639 * OSPM will not run the _INI and will not examine the children
640 * of the device for _INI methods"
642 return_ACPI_STATUS (AE_CTRL_DEPTH);
647 * The device is present or is assumed present if no _STA exists.
648 * Run the _INI if it exists (not required to exist)
650 * Note: We know there is an _INI within this subtree, but it may not be
651 * under this particular device, it may be lower in the branch.
653 ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (
654 ACPI_TYPE_METHOD, DeviceNode, METHOD_NAME__INI));
656 Info->PrefixNode = DeviceNode;
657 Info->Pathname = METHOD_NAME__INI;
658 Info->Parameters = NULL;
659 Info->ParameterType = ACPI_PARAM_ARGS;
660 Info->Flags = ACPI_IGNORE_RETURN_VALUE;
662 Status = AcpiNsEvaluate (Info);
663 if (ACPI_SUCCESS (Status))
667 if ((AcpiDbgLevel <= ACPI_LV_ALL_EXCEPTIONS) &&
668 (!(AcpiDbgLevel & ACPI_LV_INFO)))
670 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT, "."));
674 #ifdef ACPI_DEBUG_OUTPUT
675 else if (Status != AE_NOT_FOUND)
677 /* Ignore error and move on to next device */
679 char *ScopeName = AcpiNsGetExternalPathname (Info->ResolvedNode);
681 ACPI_EXCEPTION ((AE_INFO, Status, "during %s._INI execution",
683 ACPI_FREE (ScopeName);
687 /* Ignore errors from above */
692 * The _INI method has been run if present; call the Global Initialization
693 * Handler for this device.
695 if (AcpiGbl_InitHandler)
697 Status = AcpiGbl_InitHandler (DeviceNode, ACPI_INIT_DEVICE_INI);
700 return_ACPI_STATUS (Status);