xref: /freebsd/sys/contrib/dev/acpica/components/namespace/nsinit.c (revision 13464e4a44fc58490a03bb8bfc7e3c972e9c30b2)
1 /******************************************************************************
2  *
3  * Module Name: nsinit - namespace initialization
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2017, 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  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acnamesp.h>
155 #include <contrib/dev/acpica/include/acdispat.h>
156 #include <contrib/dev/acpica/include/acinterp.h>
157 #include <contrib/dev/acpica/include/acevents.h>
158 
159 #define _COMPONENT          ACPI_NAMESPACE
160         ACPI_MODULE_NAME    ("nsinit")
161 
162 /* Local prototypes */
163 
164 static ACPI_STATUS
165 AcpiNsInitOneObject (
166     ACPI_HANDLE             ObjHandle,
167     UINT32                  Level,
168     void                    *Context,
169     void                    **ReturnValue);
170 
171 static ACPI_STATUS
172 AcpiNsInitOneDevice (
173     ACPI_HANDLE             ObjHandle,
174     UINT32                  NestingLevel,
175     void                    *Context,
176     void                    **ReturnValue);
177 
178 static ACPI_STATUS
179 AcpiNsFindIniMethods (
180     ACPI_HANDLE             ObjHandle,
181     UINT32                  NestingLevel,
182     void                    *Context,
183     void                    **ReturnValue);
184 
185 
186 /*******************************************************************************
187  *
188  * FUNCTION:    AcpiNsInitializeObjects
189  *
190  * PARAMETERS:  None
191  *
192  * RETURN:      Status
193  *
194  * DESCRIPTION: Walk the entire namespace and perform any necessary
195  *              initialization on the objects found therein
196  *
197  ******************************************************************************/
198 
199 ACPI_STATUS
200 AcpiNsInitializeObjects (
201     void)
202 {
203     ACPI_STATUS             Status;
204     ACPI_INIT_WALK_INFO     Info;
205 
206 
207     ACPI_FUNCTION_TRACE (NsInitializeObjects);
208 
209 
210     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
211         "[Init] Completing Initialization of ACPI Objects\n"));
212     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
213         "**** Starting initialization of namespace objects ****\n"));
214     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
215         "Completing Region/Field/Buffer/Package initialization:\n"));
216 
217     /* Set all init info to zero */
218 
219     memset (&Info, 0, sizeof (ACPI_INIT_WALK_INFO));
220 
221     /* Walk entire namespace from the supplied root */
222 
223     Status = AcpiWalkNamespace (ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
224         ACPI_UINT32_MAX, AcpiNsInitOneObject, NULL,
225         &Info, NULL);
226     if (ACPI_FAILURE (Status))
227     {
228         ACPI_EXCEPTION ((AE_INFO, Status, "During WalkNamespace"));
229     }
230 
231     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
232         "    Initialized %u/%u Regions %u/%u Fields %u/%u "
233         "Buffers %u/%u Packages (%u nodes)\n",
234         Info.OpRegionInit,  Info.OpRegionCount,
235         Info.FieldInit,     Info.FieldCount,
236         Info.BufferInit,    Info.BufferCount,
237         Info.PackageInit,   Info.PackageCount, Info.ObjectCount));
238 
239     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
240         "%u Control Methods found\n%u Op Regions found\n",
241         Info.MethodCount, Info.OpRegionCount));
242 
243     return_ACPI_STATUS (AE_OK);
244 }
245 
246 
247 /*******************************************************************************
248  *
249  * FUNCTION:    AcpiNsInitializeDevices
250  *
251  * PARAMETERS:  None
252  *
253  * RETURN:      ACPI_STATUS
254  *
255  * DESCRIPTION: Walk the entire namespace and initialize all ACPI devices.
256  *              This means running _INI on all present devices.
257  *
258  *              Note: We install PCI config space handler on region access,
259  *              not here.
260  *
261  ******************************************************************************/
262 
263 ACPI_STATUS
264 AcpiNsInitializeDevices (
265     UINT32                  Flags)
266 {
267     ACPI_STATUS             Status = AE_OK;
268     ACPI_DEVICE_WALK_INFO   Info;
269     ACPI_HANDLE             Handle;
270 
271 
272     ACPI_FUNCTION_TRACE (NsInitializeDevices);
273 
274 
275     if (!(Flags & ACPI_NO_DEVICE_INIT))
276     {
277         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
278             "[Init] Initializing ACPI Devices\n"));
279 
280         /* Init counters */
281 
282         Info.DeviceCount = 0;
283         Info.Num_STA = 0;
284         Info.Num_INI = 0;
285 
286         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
287             "Initializing Device/Processor/Thermal objects "
288             "and executing _INI/_STA methods:\n"));
289 
290         /* Tree analysis: find all subtrees that contain _INI methods */
291 
292         Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
293             ACPI_UINT32_MAX, FALSE, AcpiNsFindIniMethods, NULL, &Info, NULL);
294         if (ACPI_FAILURE (Status))
295         {
296             goto ErrorExit;
297         }
298 
299         /* Allocate the evaluation information block */
300 
301         Info.EvaluateInfo = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
302         if (!Info.EvaluateInfo)
303         {
304             Status = AE_NO_MEMORY;
305             goto ErrorExit;
306         }
307 
308         /*
309          * Execute the "global" _INI method that may appear at the root.
310          * This support is provided for Windows compatibility (Vista+) and
311          * is not part of the ACPI specification.
312          */
313         Info.EvaluateInfo->PrefixNode = AcpiGbl_RootNode;
314         Info.EvaluateInfo->RelativePathname = METHOD_NAME__INI;
315         Info.EvaluateInfo->Parameters = NULL;
316         Info.EvaluateInfo->Flags = ACPI_IGNORE_RETURN_VALUE;
317 
318         Status = AcpiNsEvaluate (Info.EvaluateInfo);
319         if (ACPI_SUCCESS (Status))
320         {
321             Info.Num_INI++;
322         }
323 
324         /*
325          * Execute \_SB._INI.
326          * There appears to be a strict order requirement for \_SB._INI,
327          * which should be evaluated before any _REG evaluations.
328          */
329         Status = AcpiGetHandle (NULL, "\\_SB", &Handle);
330         if (ACPI_SUCCESS (Status))
331         {
332             memset (Info.EvaluateInfo, 0, sizeof (ACPI_EVALUATE_INFO));
333             Info.EvaluateInfo->PrefixNode = Handle;
334             Info.EvaluateInfo->RelativePathname = METHOD_NAME__INI;
335             Info.EvaluateInfo->Parameters = NULL;
336             Info.EvaluateInfo->Flags = ACPI_IGNORE_RETURN_VALUE;
337 
338             Status = AcpiNsEvaluate (Info.EvaluateInfo);
339             if (ACPI_SUCCESS (Status))
340             {
341                 Info.Num_INI++;
342             }
343         }
344     }
345 
346     /*
347      * Run all _REG methods
348      *
349      * Note: Any objects accessed by the _REG methods will be automatically
350      * initialized, even if they contain executable AML (see the call to
351      * AcpiNsInitializeObjects below).
352      *
353      * Note: According to the ACPI specification, we actually needn't execute
354      * _REG for SystemMemory/SystemIo operation regions, but for PCI_Config
355      * operation regions, it is required to evaluate _REG for those on a PCI
356      * root bus that doesn't contain _BBN object. So this code is kept here
357      * in order not to break things.
358      */
359     if (!(Flags & ACPI_NO_ADDRESS_SPACE_INIT))
360     {
361         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
362             "[Init] Executing _REG OpRegion methods\n"));
363 
364         Status = AcpiEvInitializeOpRegions ();
365         if (ACPI_FAILURE (Status))
366         {
367             goto ErrorExit;
368         }
369     }
370 
371     if (!(Flags & ACPI_NO_DEVICE_INIT))
372     {
373         /* Walk namespace to execute all _INIs on present devices */
374 
375         Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
376             ACPI_UINT32_MAX, FALSE, AcpiNsInitOneDevice, NULL, &Info, NULL);
377 
378         /*
379          * Any _OSI requests should be completed by now. If the BIOS has
380          * requested any Windows OSI strings, we will always truncate
381          * I/O addresses to 16 bits -- for Windows compatibility.
382          */
383         if (AcpiGbl_OsiData >= ACPI_OSI_WIN_2000)
384         {
385             AcpiGbl_TruncateIoAddresses = TRUE;
386         }
387 
388         ACPI_FREE (Info.EvaluateInfo);
389         if (ACPI_FAILURE (Status))
390         {
391             goto ErrorExit;
392         }
393 
394         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
395             "    Executed %u _INI methods requiring %u _STA executions "
396             "(examined %u objects)\n",
397             Info.Num_INI, Info.Num_STA, Info.DeviceCount));
398     }
399 
400     return_ACPI_STATUS (Status);
401 
402 
403 ErrorExit:
404     ACPI_EXCEPTION ((AE_INFO, Status, "During device initialization"));
405     return_ACPI_STATUS (Status);
406 }
407 
408 
409 /*******************************************************************************
410  *
411  * FUNCTION:    AcpiNsInitOneObject
412  *
413  * PARAMETERS:  ObjHandle       - Node
414  *              Level           - Current nesting level
415  *              Context         - Points to a init info struct
416  *              ReturnValue     - Not used
417  *
418  * RETURN:      Status
419  *
420  * DESCRIPTION: Callback from AcpiWalkNamespace. Invoked for every object
421  *              within the  namespace.
422  *
423  *              Currently, the only objects that require initialization are:
424  *              1) Methods
425  *              2) Op Regions
426  *
427  ******************************************************************************/
428 
429 static ACPI_STATUS
430 AcpiNsInitOneObject (
431     ACPI_HANDLE             ObjHandle,
432     UINT32                  Level,
433     void                    *Context,
434     void                    **ReturnValue)
435 {
436     ACPI_OBJECT_TYPE        Type;
437     ACPI_STATUS             Status = AE_OK;
438     ACPI_INIT_WALK_INFO     *Info = (ACPI_INIT_WALK_INFO *) Context;
439     ACPI_NAMESPACE_NODE     *Node = (ACPI_NAMESPACE_NODE *) ObjHandle;
440     ACPI_OPERAND_OBJECT     *ObjDesc;
441 
442 
443     ACPI_FUNCTION_NAME (NsInitOneObject);
444 
445 
446     Info->ObjectCount++;
447 
448     /* And even then, we are only interested in a few object types */
449 
450     Type = AcpiNsGetType (ObjHandle);
451     ObjDesc = AcpiNsGetAttachedObject (Node);
452     if (!ObjDesc)
453     {
454         return (AE_OK);
455     }
456 
457     /* Increment counters for object types we are looking for */
458 
459     switch (Type)
460     {
461     case ACPI_TYPE_REGION:
462 
463         Info->OpRegionCount++;
464         break;
465 
466     case ACPI_TYPE_BUFFER_FIELD:
467 
468         Info->FieldCount++;
469         break;
470 
471     case ACPI_TYPE_LOCAL_BANK_FIELD:
472 
473         Info->FieldCount++;
474         break;
475 
476     case ACPI_TYPE_BUFFER:
477 
478         Info->BufferCount++;
479         break;
480 
481     case ACPI_TYPE_PACKAGE:
482 
483         Info->PackageCount++;
484         break;
485 
486     default:
487 
488         /* No init required, just exit now */
489 
490         return (AE_OK);
491     }
492 
493     /* If the object is already initialized, nothing else to do */
494 
495     if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
496     {
497         return (AE_OK);
498     }
499 
500     /* Must lock the interpreter before executing AML code */
501 
502     AcpiExEnterInterpreter ();
503 
504     /*
505      * Each of these types can contain executable AML code within the
506      * declaration.
507      */
508     switch (Type)
509     {
510     case ACPI_TYPE_REGION:
511 
512         Info->OpRegionInit++;
513         Status = AcpiDsGetRegionArguments (ObjDesc);
514         break;
515 
516     case ACPI_TYPE_BUFFER_FIELD:
517 
518         Info->FieldInit++;
519         Status = AcpiDsGetBufferFieldArguments (ObjDesc);
520         break;
521 
522     case ACPI_TYPE_LOCAL_BANK_FIELD:
523 
524         Info->FieldInit++;
525         Status = AcpiDsGetBankFieldArguments (ObjDesc);
526         break;
527 
528     case ACPI_TYPE_BUFFER:
529 
530         Info->BufferInit++;
531         Status = AcpiDsGetBufferArguments (ObjDesc);
532         break;
533 
534     case ACPI_TYPE_PACKAGE:
535 
536         Info->PackageInit++;
537         Status = AcpiDsGetPackageArguments (ObjDesc);
538         break;
539 
540     default:
541 
542         /* No other types can get here */
543 
544         break;
545     }
546 
547     if (ACPI_FAILURE (Status))
548     {
549         ACPI_EXCEPTION ((AE_INFO, Status,
550             "Could not execute arguments for [%4.4s] (%s)",
551             AcpiUtGetNodeName (Node), AcpiUtGetTypeName (Type)));
552     }
553 
554     /*
555      * We ignore errors from above, and always return OK, since we don't want
556      * to abort the walk on any single error.
557      */
558     AcpiExExitInterpreter ();
559     return (AE_OK);
560 }
561 
562 
563 /*******************************************************************************
564  *
565  * FUNCTION:    AcpiNsFindIniMethods
566  *
567  * PARAMETERS:  ACPI_WALK_CALLBACK
568  *
569  * RETURN:      ACPI_STATUS
570  *
571  * DESCRIPTION: Called during namespace walk. Finds objects named _INI under
572  *              device/processor/thermal objects, and marks the entire subtree
573  *              with a SUBTREE_HAS_INI flag. This flag is used during the
574  *              subsequent device initialization walk to avoid entire subtrees
575  *              that do not contain an _INI.
576  *
577  ******************************************************************************/
578 
579 static ACPI_STATUS
580 AcpiNsFindIniMethods (
581     ACPI_HANDLE             ObjHandle,
582     UINT32                  NestingLevel,
583     void                    *Context,
584     void                    **ReturnValue)
585 {
586     ACPI_DEVICE_WALK_INFO   *Info = ACPI_CAST_PTR (ACPI_DEVICE_WALK_INFO, Context);
587     ACPI_NAMESPACE_NODE     *Node;
588     ACPI_NAMESPACE_NODE     *ParentNode;
589 
590 
591     /* Keep count of device/processor/thermal objects */
592 
593     Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjHandle);
594     if ((Node->Type == ACPI_TYPE_DEVICE)    ||
595         (Node->Type == ACPI_TYPE_PROCESSOR) ||
596         (Node->Type == ACPI_TYPE_THERMAL))
597     {
598         Info->DeviceCount++;
599         return (AE_OK);
600     }
601 
602     /* We are only looking for methods named _INI */
603 
604     if (!ACPI_COMPARE_NAME (Node->Name.Ascii, METHOD_NAME__INI))
605     {
606         return (AE_OK);
607     }
608 
609     /*
610      * The only _INI methods that we care about are those that are
611      * present under Device, Processor, and Thermal objects.
612      */
613     ParentNode = Node->Parent;
614     switch (ParentNode->Type)
615     {
616     case ACPI_TYPE_DEVICE:
617     case ACPI_TYPE_PROCESSOR:
618     case ACPI_TYPE_THERMAL:
619 
620         /* Mark parent and bubble up the INI present flag to the root */
621 
622         while (ParentNode)
623         {
624             ParentNode->Flags |= ANOBJ_SUBTREE_HAS_INI;
625             ParentNode = ParentNode->Parent;
626         }
627         break;
628 
629     default:
630 
631         break;
632     }
633 
634     return (AE_OK);
635 }
636 
637 
638 /*******************************************************************************
639  *
640  * FUNCTION:    AcpiNsInitOneDevice
641  *
642  * PARAMETERS:  ACPI_WALK_CALLBACK
643  *
644  * RETURN:      ACPI_STATUS
645  *
646  * DESCRIPTION: This is called once per device soon after ACPI is enabled
647  *              to initialize each device. It determines if the device is
648  *              present, and if so, calls _INI.
649  *
650  ******************************************************************************/
651 
652 static ACPI_STATUS
653 AcpiNsInitOneDevice (
654     ACPI_HANDLE             ObjHandle,
655     UINT32                  NestingLevel,
656     void                    *Context,
657     void                    **ReturnValue)
658 {
659     ACPI_DEVICE_WALK_INFO   *WalkInfo = ACPI_CAST_PTR (ACPI_DEVICE_WALK_INFO, Context);
660     ACPI_EVALUATE_INFO      *Info = WalkInfo->EvaluateInfo;
661     UINT32                  Flags;
662     ACPI_STATUS             Status;
663     ACPI_NAMESPACE_NODE     *DeviceNode;
664 
665 
666     ACPI_FUNCTION_TRACE (NsInitOneDevice);
667 
668 
669     /* We are interested in Devices, Processors and ThermalZones only */
670 
671     DeviceNode = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjHandle);
672     if ((DeviceNode->Type != ACPI_TYPE_DEVICE)    &&
673         (DeviceNode->Type != ACPI_TYPE_PROCESSOR) &&
674         (DeviceNode->Type != ACPI_TYPE_THERMAL))
675     {
676         return_ACPI_STATUS (AE_OK);
677     }
678 
679     /*
680      * Because of an earlier namespace analysis, all subtrees that contain an
681      * _INI method are tagged.
682      *
683      * If this device subtree does not contain any _INI methods, we
684      * can exit now and stop traversing this entire subtree.
685      */
686     if (!(DeviceNode->Flags & ANOBJ_SUBTREE_HAS_INI))
687     {
688         return_ACPI_STATUS (AE_CTRL_DEPTH);
689     }
690 
691     /*
692      * Run _STA to determine if this device is present and functioning. We
693      * must know this information for two important reasons (from ACPI spec):
694      *
695      * 1) We can only run _INI if the device is present.
696      * 2) We must abort the device tree walk on this subtree if the device is
697      *    not present and is not functional (we will not examine the children)
698      *
699      * The _STA method is not required to be present under the device, we
700      * assume the device is present if _STA does not exist.
701      */
702     ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (
703         ACPI_TYPE_METHOD, DeviceNode, METHOD_NAME__STA));
704 
705     Status = AcpiUtExecute_STA (DeviceNode, &Flags);
706     if (ACPI_FAILURE (Status))
707     {
708         /* Ignore error and move on to next device */
709 
710         return_ACPI_STATUS (AE_OK);
711     }
712 
713     /*
714      * Flags == -1 means that _STA was not found. In this case, we assume that
715      * the device is both present and functional.
716      *
717      * From the ACPI spec, description of _STA:
718      *
719      * "If a device object (including the processor object) does not have an
720      * _STA object, then OSPM assumes that all of the above bits are set (in
721      * other words, the device is present, ..., and functioning)"
722      */
723     if (Flags != ACPI_UINT32_MAX)
724     {
725         WalkInfo->Num_STA++;
726     }
727 
728     /*
729      * Examine the PRESENT and FUNCTIONING status bits
730      *
731      * Note: ACPI spec does not seem to specify behavior for the present but
732      * not functioning case, so we assume functioning if present.
733      */
734     if (!(Flags & ACPI_STA_DEVICE_PRESENT))
735     {
736         /* Device is not present, we must examine the Functioning bit */
737 
738         if (Flags & ACPI_STA_DEVICE_FUNCTIONING)
739         {
740             /*
741              * Device is not present but is "functioning". In this case,
742              * we will not run _INI, but we continue to examine the children
743              * of this device.
744              *
745              * From the ACPI spec, description of _STA: (Note - no mention
746              * of whether to run _INI or not on the device in question)
747              *
748              * "_STA may return bit 0 clear (not present) with bit 3 set
749              * (device is functional). This case is used to indicate a valid
750              * device for which no device driver should be loaded (for example,
751              * a bridge device.) Children of this device may be present and
752              * valid. OSPM should continue enumeration below a device whose
753              * _STA returns this bit combination"
754              */
755             return_ACPI_STATUS (AE_OK);
756         }
757         else
758         {
759             /*
760              * Device is not present and is not functioning. We must abort the
761              * walk of this subtree immediately -- don't look at the children
762              * of such a device.
763              *
764              * From the ACPI spec, description of _INI:
765              *
766              * "If the _STA method indicates that the device is not present,
767              * OSPM will not run the _INI and will not examine the children
768              * of the device for _INI methods"
769              */
770             return_ACPI_STATUS (AE_CTRL_DEPTH);
771         }
772     }
773 
774     /*
775      * The device is present or is assumed present if no _STA exists.
776      * Run the _INI if it exists (not required to exist)
777      *
778      * Note: We know there is an _INI within this subtree, but it may not be
779      * under this particular device, it may be lower in the branch.
780      */
781     if (!ACPI_COMPARE_NAME (DeviceNode->Name.Ascii, "_SB_") ||
782         DeviceNode->Parent != AcpiGbl_RootNode)
783     {
784         ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (
785             ACPI_TYPE_METHOD, DeviceNode, METHOD_NAME__INI));
786 
787         memset (Info, 0, sizeof (ACPI_EVALUATE_INFO));
788         Info->PrefixNode = DeviceNode;
789         Info->RelativePathname = METHOD_NAME__INI;
790         Info->Parameters = NULL;
791         Info->Flags = ACPI_IGNORE_RETURN_VALUE;
792 
793         Status = AcpiNsEvaluate (Info);
794         if (ACPI_SUCCESS (Status))
795         {
796             WalkInfo->Num_INI++;
797         }
798 
799 #ifdef ACPI_DEBUG_OUTPUT
800         else if (Status != AE_NOT_FOUND)
801         {
802             /* Ignore error and move on to next device */
803 
804             char *ScopeName = AcpiNsGetNormalizedPathname (DeviceNode, TRUE);
805 
806             ACPI_EXCEPTION ((AE_INFO, Status, "during %s._INI execution",
807                 ScopeName));
808             ACPI_FREE (ScopeName);
809         }
810 #endif
811     }
812 
813     /* Ignore errors from above */
814 
815     Status = AE_OK;
816 
817     /*
818      * The _INI method has been run if present; call the Global Initialization
819      * Handler for this device.
820      */
821     if (AcpiGbl_InitHandler)
822     {
823         Status = AcpiGbl_InitHandler (DeviceNode, ACPI_INIT_DEVICE_INI);
824     }
825 
826     return_ACPI_STATUS (Status);
827 }
828