1 /******************************************************************************
3 * Module Name: nsinit - namespace initialization
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include <contrib/dev/acpica/include/acpi.h>
45 #include <contrib/dev/acpica/include/accommon.h>
46 #include <contrib/dev/acpica/include/acnamesp.h>
47 #include <contrib/dev/acpica/include/acdispat.h>
48 #include <contrib/dev/acpica/include/acinterp.h>
50 #define _COMPONENT ACPI_NAMESPACE
51 ACPI_MODULE_NAME ("nsinit")
53 /* Local prototypes */
57 ACPI_HANDLE ObjHandle,
64 ACPI_HANDLE ObjHandle,
70 AcpiNsFindIniMethods (
71 ACPI_HANDLE ObjHandle,
77 /*******************************************************************************
79 * FUNCTION: AcpiNsInitializeObjects
85 * DESCRIPTION: Walk the entire namespace and perform any necessary
86 * initialization on the objects found therein
88 ******************************************************************************/
91 AcpiNsInitializeObjects (
95 ACPI_INIT_WALK_INFO Info;
98 ACPI_FUNCTION_TRACE (NsInitializeObjects);
101 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
102 "**** Starting initialization of namespace objects ****\n"));
103 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
104 "Completing Region/Field/Buffer/Package initialization:\n"));
106 /* Set all init info to zero */
108 ACPI_MEMSET (&Info, 0, sizeof (ACPI_INIT_WALK_INFO));
110 /* Walk entire namespace from the supplied root */
112 Status = AcpiWalkNamespace (ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
113 ACPI_UINT32_MAX, AcpiNsInitOneObject, NULL,
115 if (ACPI_FAILURE (Status))
117 ACPI_EXCEPTION ((AE_INFO, Status, "During WalkNamespace"));
120 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
121 " Initialized %u/%u Regions %u/%u Fields %u/%u "
122 "Buffers %u/%u Packages (%u nodes)\n",
123 Info.OpRegionInit, Info.OpRegionCount,
124 Info.FieldInit, Info.FieldCount,
125 Info.BufferInit, Info.BufferCount,
126 Info.PackageInit, Info.PackageCount, Info.ObjectCount));
128 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
129 "%u Control Methods found\n%u Op Regions found\n",
130 Info.MethodCount, Info.OpRegionCount));
132 return_ACPI_STATUS (AE_OK);
136 /*******************************************************************************
138 * FUNCTION: AcpiNsInitializeDevices
142 * RETURN: ACPI_STATUS
144 * DESCRIPTION: Walk the entire namespace and initialize all ACPI devices.
145 * This means running _INI on all present devices.
147 * Note: We install PCI config space handler on region access,
150 ******************************************************************************/
153 AcpiNsInitializeDevices (
157 ACPI_DEVICE_WALK_INFO Info;
160 ACPI_FUNCTION_TRACE (NsInitializeDevices);
165 Info.DeviceCount = 0;
169 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
170 "Initializing Device/Processor/Thermal objects "
171 "and executing _INI/_STA methods:\n"));
173 /* Tree analysis: find all subtrees that contain _INI methods */
175 Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
176 ACPI_UINT32_MAX, FALSE, AcpiNsFindIniMethods, NULL, &Info, NULL);
177 if (ACPI_FAILURE (Status))
182 /* Allocate the evaluation information block */
184 Info.EvaluateInfo = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
185 if (!Info.EvaluateInfo)
187 Status = AE_NO_MEMORY;
192 * Execute the "global" _INI method that may appear at the root. This
193 * support is provided for Windows compatibility (Vista+) and is not
194 * part of the ACPI specification.
196 Info.EvaluateInfo->PrefixNode = AcpiGbl_RootNode;
197 Info.EvaluateInfo->RelativePathname = METHOD_NAME__INI;
198 Info.EvaluateInfo->Parameters = NULL;
199 Info.EvaluateInfo->Flags = ACPI_IGNORE_RETURN_VALUE;
201 Status = AcpiNsEvaluate (Info.EvaluateInfo);
202 if (ACPI_SUCCESS (Status))
207 /* Walk namespace to execute all _INIs on present devices */
209 Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
210 ACPI_UINT32_MAX, FALSE, AcpiNsInitOneDevice, NULL, &Info, NULL);
213 * Any _OSI requests should be completed by now. If the BIOS has
214 * requested any Windows OSI strings, we will always truncate
215 * I/O addresses to 16 bits -- for Windows compatibility.
217 if (AcpiGbl_OsiData >= ACPI_OSI_WIN_2000)
219 AcpiGbl_TruncateIoAddresses = TRUE;
222 ACPI_FREE (Info.EvaluateInfo);
223 if (ACPI_FAILURE (Status))
228 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
229 " Executed %u _INI methods requiring %u _STA executions "
230 "(examined %u objects)\n",
231 Info.Num_INI, Info.Num_STA, Info.DeviceCount));
233 return_ACPI_STATUS (Status);
237 ACPI_EXCEPTION ((AE_INFO, Status, "During device initialization"));
238 return_ACPI_STATUS (Status);
242 /*******************************************************************************
244 * FUNCTION: AcpiNsInitOneObject
246 * PARAMETERS: ObjHandle - Node
247 * Level - Current nesting level
248 * Context - Points to a init info struct
249 * ReturnValue - Not used
253 * DESCRIPTION: Callback from AcpiWalkNamespace. Invoked for every object
254 * within the namespace.
256 * Currently, the only objects that require initialization are:
260 ******************************************************************************/
263 AcpiNsInitOneObject (
264 ACPI_HANDLE ObjHandle,
269 ACPI_OBJECT_TYPE Type;
270 ACPI_STATUS Status = AE_OK;
271 ACPI_INIT_WALK_INFO *Info = (ACPI_INIT_WALK_INFO *) Context;
272 ACPI_NAMESPACE_NODE *Node = (ACPI_NAMESPACE_NODE *) ObjHandle;
273 ACPI_OPERAND_OBJECT *ObjDesc;
276 ACPI_FUNCTION_NAME (NsInitOneObject);
281 /* And even then, we are only interested in a few object types */
283 Type = AcpiNsGetType (ObjHandle);
284 ObjDesc = AcpiNsGetAttachedObject (Node);
290 /* Increment counters for object types we are looking for */
294 case ACPI_TYPE_REGION:
296 Info->OpRegionCount++;
299 case ACPI_TYPE_BUFFER_FIELD:
304 case ACPI_TYPE_LOCAL_BANK_FIELD:
309 case ACPI_TYPE_BUFFER:
314 case ACPI_TYPE_PACKAGE:
316 Info->PackageCount++;
321 /* No init required, just exit now */
326 /* If the object is already initialized, nothing else to do */
328 if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
333 /* Must lock the interpreter before executing AML code */
335 AcpiExEnterInterpreter ();
338 * Each of these types can contain executable AML code within the
343 case ACPI_TYPE_REGION:
345 Info->OpRegionInit++;
346 Status = AcpiDsGetRegionArguments (ObjDesc);
349 case ACPI_TYPE_BUFFER_FIELD:
352 Status = AcpiDsGetBufferFieldArguments (ObjDesc);
355 case ACPI_TYPE_LOCAL_BANK_FIELD:
358 Status = AcpiDsGetBankFieldArguments (ObjDesc);
361 case ACPI_TYPE_BUFFER:
364 Status = AcpiDsGetBufferArguments (ObjDesc);
367 case ACPI_TYPE_PACKAGE:
370 Status = AcpiDsGetPackageArguments (ObjDesc);
375 /* No other types can get here */
380 if (ACPI_FAILURE (Status))
382 ACPI_EXCEPTION ((AE_INFO, Status,
383 "Could not execute arguments for [%4.4s] (%s)",
384 AcpiUtGetNodeName (Node), AcpiUtGetTypeName (Type)));
388 * We ignore errors from above, and always return OK, since we don't want
389 * to abort the walk on any single error.
391 AcpiExExitInterpreter ();
396 /*******************************************************************************
398 * FUNCTION: AcpiNsFindIniMethods
400 * PARAMETERS: ACPI_WALK_CALLBACK
402 * RETURN: ACPI_STATUS
404 * DESCRIPTION: Called during namespace walk. Finds objects named _INI under
405 * device/processor/thermal objects, and marks the entire subtree
406 * with a SUBTREE_HAS_INI flag. This flag is used during the
407 * subsequent device initialization walk to avoid entire subtrees
408 * that do not contain an _INI.
410 ******************************************************************************/
413 AcpiNsFindIniMethods (
414 ACPI_HANDLE ObjHandle,
419 ACPI_DEVICE_WALK_INFO *Info = ACPI_CAST_PTR (ACPI_DEVICE_WALK_INFO, Context);
420 ACPI_NAMESPACE_NODE *Node;
421 ACPI_NAMESPACE_NODE *ParentNode;
424 /* Keep count of device/processor/thermal objects */
426 Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjHandle);
427 if ((Node->Type == ACPI_TYPE_DEVICE) ||
428 (Node->Type == ACPI_TYPE_PROCESSOR) ||
429 (Node->Type == ACPI_TYPE_THERMAL))
435 /* We are only looking for methods named _INI */
437 if (!ACPI_COMPARE_NAME (Node->Name.Ascii, METHOD_NAME__INI))
443 * The only _INI methods that we care about are those that are
444 * present under Device, Processor, and Thermal objects.
446 ParentNode = Node->Parent;
447 switch (ParentNode->Type)
449 case ACPI_TYPE_DEVICE:
450 case ACPI_TYPE_PROCESSOR:
451 case ACPI_TYPE_THERMAL:
453 /* Mark parent and bubble up the INI present flag to the root */
457 ParentNode->Flags |= ANOBJ_SUBTREE_HAS_INI;
458 ParentNode = ParentNode->Parent;
471 /*******************************************************************************
473 * FUNCTION: AcpiNsInitOneDevice
475 * PARAMETERS: ACPI_WALK_CALLBACK
477 * RETURN: ACPI_STATUS
479 * DESCRIPTION: This is called once per device soon after ACPI is enabled
480 * to initialize each device. It determines if the device is
481 * present, and if so, calls _INI.
483 ******************************************************************************/
486 AcpiNsInitOneDevice (
487 ACPI_HANDLE ObjHandle,
492 ACPI_DEVICE_WALK_INFO *WalkInfo = ACPI_CAST_PTR (ACPI_DEVICE_WALK_INFO, Context);
493 ACPI_EVALUATE_INFO *Info = WalkInfo->EvaluateInfo;
496 ACPI_NAMESPACE_NODE *DeviceNode;
499 ACPI_FUNCTION_TRACE (NsInitOneDevice);
502 /* We are interested in Devices, Processors and ThermalZones only */
504 DeviceNode = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjHandle);
505 if ((DeviceNode->Type != ACPI_TYPE_DEVICE) &&
506 (DeviceNode->Type != ACPI_TYPE_PROCESSOR) &&
507 (DeviceNode->Type != ACPI_TYPE_THERMAL))
509 return_ACPI_STATUS (AE_OK);
513 * Because of an earlier namespace analysis, all subtrees that contain an
514 * _INI method are tagged.
516 * If this device subtree does not contain any _INI methods, we
517 * can exit now and stop traversing this entire subtree.
519 if (!(DeviceNode->Flags & ANOBJ_SUBTREE_HAS_INI))
521 return_ACPI_STATUS (AE_CTRL_DEPTH);
525 * Run _STA to determine if this device is present and functioning. We
526 * must know this information for two important reasons (from ACPI spec):
528 * 1) We can only run _INI if the device is present.
529 * 2) We must abort the device tree walk on this subtree if the device is
530 * not present and is not functional (we will not examine the children)
532 * The _STA method is not required to be present under the device, we
533 * assume the device is present if _STA does not exist.
535 ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (
536 ACPI_TYPE_METHOD, DeviceNode, METHOD_NAME__STA));
538 Status = AcpiUtExecute_STA (DeviceNode, &Flags);
539 if (ACPI_FAILURE (Status))
541 /* Ignore error and move on to next device */
543 return_ACPI_STATUS (AE_OK);
547 * Flags == -1 means that _STA was not found. In this case, we assume that
548 * the device is both present and functional.
550 * From the ACPI spec, description of _STA:
552 * "If a device object (including the processor object) does not have an
553 * _STA object, then OSPM assumes that all of the above bits are set (in
554 * other words, the device is present, ..., and functioning)"
556 if (Flags != ACPI_UINT32_MAX)
562 * Examine the PRESENT and FUNCTIONING status bits
564 * Note: ACPI spec does not seem to specify behavior for the present but
565 * not functioning case, so we assume functioning if present.
567 if (!(Flags & ACPI_STA_DEVICE_PRESENT))
569 /* Device is not present, we must examine the Functioning bit */
571 if (Flags & ACPI_STA_DEVICE_FUNCTIONING)
574 * Device is not present but is "functioning". In this case,
575 * we will not run _INI, but we continue to examine the children
578 * From the ACPI spec, description of _STA: (Note - no mention
579 * of whether to run _INI or not on the device in question)
581 * "_STA may return bit 0 clear (not present) with bit 3 set
582 * (device is functional). This case is used to indicate a valid
583 * device for which no device driver should be loaded (for example,
584 * a bridge device.) Children of this device may be present and
585 * valid. OSPM should continue enumeration below a device whose
586 * _STA returns this bit combination"
588 return_ACPI_STATUS (AE_OK);
593 * Device is not present and is not functioning. We must abort the
594 * walk of this subtree immediately -- don't look at the children
597 * From the ACPI spec, description of _INI:
599 * "If the _STA method indicates that the device is not present,
600 * OSPM will not run the _INI and will not examine the children
601 * of the device for _INI methods"
603 return_ACPI_STATUS (AE_CTRL_DEPTH);
608 * The device is present or is assumed present if no _STA exists.
609 * Run the _INI if it exists (not required to exist)
611 * Note: We know there is an _INI within this subtree, but it may not be
612 * under this particular device, it may be lower in the branch.
614 ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (
615 ACPI_TYPE_METHOD, DeviceNode, METHOD_NAME__INI));
617 ACPI_MEMSET (Info, 0, sizeof (ACPI_EVALUATE_INFO));
618 Info->PrefixNode = DeviceNode;
619 Info->RelativePathname = METHOD_NAME__INI;
620 Info->Parameters = NULL;
621 Info->Flags = ACPI_IGNORE_RETURN_VALUE;
623 Status = AcpiNsEvaluate (Info);
624 if (ACPI_SUCCESS (Status))
629 #ifdef ACPI_DEBUG_OUTPUT
630 else if (Status != AE_NOT_FOUND)
632 /* Ignore error and move on to next device */
634 char *ScopeName = AcpiNsGetExternalPathname (Info->Node);
636 ACPI_EXCEPTION ((AE_INFO, Status, "during %s._INI execution",
638 ACPI_FREE (ScopeName);
642 /* Ignore errors from above */
647 * The _INI method has been run if present; call the Global Initialization
648 * Handler for this device.
650 if (AcpiGbl_InitHandler)
652 Status = AcpiGbl_InitHandler (DeviceNode, ACPI_INIT_DEVICE_INI);
655 return_ACPI_STATUS (Status);