17c478bd9Sstevel@tonic-gate /*******************************************************************************
27c478bd9Sstevel@tonic-gate *
37c478bd9Sstevel@tonic-gate * Module Name: nssearch - Namespace search
47c478bd9Sstevel@tonic-gate *
57c478bd9Sstevel@tonic-gate ******************************************************************************/
67c478bd9Sstevel@tonic-gate
7*35786f68SRobert Mustacchi /******************************************************************************
8*35786f68SRobert Mustacchi *
9*35786f68SRobert Mustacchi * 1. Copyright Notice
10*35786f68SRobert Mustacchi *
11*35786f68SRobert Mustacchi * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
127c478bd9Sstevel@tonic-gate * All rights reserved.
137c478bd9Sstevel@tonic-gate *
14*35786f68SRobert Mustacchi * 2. License
15*35786f68SRobert Mustacchi *
16*35786f68SRobert Mustacchi * 2.1. This is your license from Intel Corp. under its intellectual property
17*35786f68SRobert Mustacchi * rights. You may have additional license terms from the party that provided
18*35786f68SRobert Mustacchi * you this software, covering your right to use that party's intellectual
19*35786f68SRobert Mustacchi * property rights.
20*35786f68SRobert Mustacchi *
21*35786f68SRobert Mustacchi * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22*35786f68SRobert Mustacchi * copy of the source code appearing in this file ("Covered Code") an
23*35786f68SRobert Mustacchi * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24*35786f68SRobert Mustacchi * base code distributed originally by Intel ("Original Intel Code") to copy,
25*35786f68SRobert Mustacchi * make derivatives, distribute, use and display any portion of the Covered
26*35786f68SRobert Mustacchi * Code in any form, with the right to sublicense such rights; and
27*35786f68SRobert Mustacchi *
28*35786f68SRobert Mustacchi * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29*35786f68SRobert Mustacchi * license (with the right to sublicense), under only those claims of Intel
30*35786f68SRobert Mustacchi * patents that are infringed by the Original Intel Code, to make, use, sell,
31*35786f68SRobert Mustacchi * offer to sell, and import the Covered Code and derivative works thereof
32*35786f68SRobert Mustacchi * solely to the minimum extent necessary to exercise the above copyright
33*35786f68SRobert Mustacchi * license, and in no event shall the patent license extend to any additions
34*35786f68SRobert Mustacchi * to or modifications of the Original Intel Code. No other license or right
35*35786f68SRobert Mustacchi * is granted directly or by implication, estoppel or otherwise;
36*35786f68SRobert Mustacchi *
37*35786f68SRobert Mustacchi * The above copyright and patent license is granted only if the following
38*35786f68SRobert Mustacchi * conditions are met:
39*35786f68SRobert Mustacchi *
40*35786f68SRobert Mustacchi * 3. Conditions
41*35786f68SRobert Mustacchi *
42*35786f68SRobert Mustacchi * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered
44*35786f68SRobert Mustacchi * Code or modification with rights to further distribute source must include
45*35786f68SRobert Mustacchi * the above Copyright Notice, the above License, this list of Conditions,
46*35786f68SRobert Mustacchi * and the following Disclaimer and Export Compliance provision. In addition,
47*35786f68SRobert Mustacchi * Licensee must cause all Covered Code to which Licensee contributes to
48*35786f68SRobert Mustacchi * contain a file documenting the changes Licensee made to create that Covered
49*35786f68SRobert Mustacchi * Code and the date of any change. Licensee must include in that file the
50*35786f68SRobert Mustacchi * documentation of any changes made by any predecessor Licensee. Licensee
51*35786f68SRobert Mustacchi * must include a prominent statement that the modification is derived,
52*35786f68SRobert Mustacchi * directly or indirectly, from Original Intel Code.
53*35786f68SRobert Mustacchi *
54*35786f68SRobert Mustacchi * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered
56*35786f68SRobert Mustacchi * Code or modification without rights to further distribute source must
57*35786f68SRobert Mustacchi * include the following Disclaimer and Export Compliance provision in the
58*35786f68SRobert Mustacchi * documentation and/or other materials provided with distribution. In
59*35786f68SRobert Mustacchi * addition, Licensee may not authorize further sublicense of source of any
60*35786f68SRobert Mustacchi * portion of the Covered Code, and must include terms to the effect that the
61*35786f68SRobert Mustacchi * license from Licensee to its licensee is limited to the intellectual
62*35786f68SRobert Mustacchi * property embodied in the software Licensee provides to its licensee, and
63*35786f68SRobert Mustacchi * not to intellectual property embodied in modifications its licensee may
64*35786f68SRobert Mustacchi * make.
65*35786f68SRobert Mustacchi *
66*35786f68SRobert Mustacchi * 3.3. Redistribution of Executable. Redistribution in executable form of any
67*35786f68SRobert Mustacchi * substantial portion of the Covered Code or modification must reproduce the
68*35786f68SRobert Mustacchi * above Copyright Notice, and the following Disclaimer and Export Compliance
69*35786f68SRobert Mustacchi * provision in the documentation and/or other materials provided with the
70*35786f68SRobert Mustacchi * distribution.
71*35786f68SRobert Mustacchi *
72*35786f68SRobert Mustacchi * 3.4. Intel retains all right, title, and interest in and to the Original
73*35786f68SRobert Mustacchi * Intel Code.
74*35786f68SRobert Mustacchi *
75*35786f68SRobert Mustacchi * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76*35786f68SRobert Mustacchi * Intel shall be used in advertising or otherwise to promote the sale, use or
77*35786f68SRobert Mustacchi * other dealings in products derived from or relating to the Covered Code
78*35786f68SRobert Mustacchi * without prior written authorization from Intel.
79*35786f68SRobert Mustacchi *
80*35786f68SRobert Mustacchi * 4. Disclaimer and Export Compliance
81*35786f68SRobert Mustacchi *
82*35786f68SRobert Mustacchi * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83*35786f68SRobert Mustacchi * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84*35786f68SRobert Mustacchi * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85*35786f68SRobert Mustacchi * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86*35786f68SRobert Mustacchi * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87*35786f68SRobert Mustacchi * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88*35786f68SRobert Mustacchi * PARTICULAR PURPOSE.
89*35786f68SRobert Mustacchi *
90*35786f68SRobert Mustacchi * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91*35786f68SRobert Mustacchi * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92*35786f68SRobert Mustacchi * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93*35786f68SRobert Mustacchi * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94*35786f68SRobert Mustacchi * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95*35786f68SRobert Mustacchi * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96*35786f68SRobert Mustacchi * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97*35786f68SRobert Mustacchi * LIMITED REMEDY.
98*35786f68SRobert Mustacchi *
99*35786f68SRobert Mustacchi * 4.3. Licensee shall not export, either directly or indirectly, any of this
100*35786f68SRobert Mustacchi * software or system incorporating such software without first obtaining any
101*35786f68SRobert Mustacchi * required license or other approval from the U. S. Department of Commerce or
102*35786f68SRobert Mustacchi * any other agency or department of the United States Government. In the
103*35786f68SRobert Mustacchi * event Licensee exports any such software from the United States or
104*35786f68SRobert Mustacchi * re-exports any such software from a foreign destination, Licensee shall
105*35786f68SRobert Mustacchi * ensure that the distribution and export/re-export of the software is in
106*35786f68SRobert Mustacchi * compliance with all laws, regulations, orders, or other restrictions of the
107*35786f68SRobert Mustacchi * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108*35786f68SRobert Mustacchi * any of its subsidiaries will export/re-export any technical data, process,
109*35786f68SRobert Mustacchi * software, or service, directly or indirectly, to any country for which the
110*35786f68SRobert Mustacchi * United States government or any agency thereof requires an export license,
111*35786f68SRobert Mustacchi * other governmental approval, or letter of assurance, without first obtaining
112*35786f68SRobert Mustacchi * such license, approval or letter.
113*35786f68SRobert Mustacchi *
114*35786f68SRobert Mustacchi *****************************************************************************
115*35786f68SRobert Mustacchi *
116*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the
117*35786f68SRobert Mustacchi * following license:
118*35786f68SRobert Mustacchi *
11926f3cdf0SGordon Ross * Redistribution and use in source and binary forms, with or without
12026f3cdf0SGordon Ross * modification, are permitted provided that the following conditions
12126f3cdf0SGordon Ross * are met:
12226f3cdf0SGordon Ross * 1. Redistributions of source code must retain the above copyright
12326f3cdf0SGordon Ross * notice, this list of conditions, and the following disclaimer,
12426f3cdf0SGordon Ross * without modification.
12526f3cdf0SGordon Ross * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12626f3cdf0SGordon Ross * substantially similar to the "NO WARRANTY" disclaimer below
12726f3cdf0SGordon Ross * ("Disclaimer") and any redistribution must be conditioned upon
12826f3cdf0SGordon Ross * including a substantially similar Disclaimer requirement for further
12926f3cdf0SGordon Ross * binary redistribution.
13026f3cdf0SGordon Ross * 3. Neither the names of the above-listed copyright holders nor the names
13126f3cdf0SGordon Ross * of any contributors may be used to endorse or promote products derived
13226f3cdf0SGordon Ross * from this software without specific prior written permission.
13326f3cdf0SGordon Ross *
13426f3cdf0SGordon Ross * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13526f3cdf0SGordon Ross * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136*35786f68SRobert Mustacchi * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
13726f3cdf0SGordon Ross * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138*35786f68SRobert Mustacchi * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139*35786f68SRobert Mustacchi * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140*35786f68SRobert Mustacchi * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141*35786f68SRobert Mustacchi * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142*35786f68SRobert Mustacchi * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143*35786f68SRobert Mustacchi * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144*35786f68SRobert Mustacchi * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145*35786f68SRobert Mustacchi *
146*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the
147*35786f68SRobert Mustacchi * GNU General Public License ("GPL") version 2 as published by the Free
148*35786f68SRobert Mustacchi * Software Foundation.
149*35786f68SRobert Mustacchi *
150*35786f68SRobert Mustacchi *****************************************************************************/
1517c478bd9Sstevel@tonic-gate
1527c478bd9Sstevel@tonic-gate #include "acpi.h"
153aa2aa9a6SDana Myers #include "accommon.h"
1547c478bd9Sstevel@tonic-gate #include "acnamesp.h"
1557c478bd9Sstevel@tonic-gate
156aa2aa9a6SDana Myers #ifdef ACPI_ASL_COMPILER
157aa2aa9a6SDana Myers #include "amlcode.h"
158aa2aa9a6SDana Myers #endif
1597c478bd9Sstevel@tonic-gate
1607c478bd9Sstevel@tonic-gate #define _COMPONENT ACPI_NAMESPACE
1617c478bd9Sstevel@tonic-gate ACPI_MODULE_NAME ("nssearch")
1627c478bd9Sstevel@tonic-gate
1637c478bd9Sstevel@tonic-gate /* Local prototypes */
1647c478bd9Sstevel@tonic-gate
1657c478bd9Sstevel@tonic-gate static ACPI_STATUS
1667c478bd9Sstevel@tonic-gate AcpiNsSearchParentTree (
1677c478bd9Sstevel@tonic-gate UINT32 TargetName,
1687c478bd9Sstevel@tonic-gate ACPI_NAMESPACE_NODE *Node,
1697c478bd9Sstevel@tonic-gate ACPI_OBJECT_TYPE Type,
1707c478bd9Sstevel@tonic-gate ACPI_NAMESPACE_NODE **ReturnNode);
1717c478bd9Sstevel@tonic-gate
1727c478bd9Sstevel@tonic-gate
1737c478bd9Sstevel@tonic-gate /*******************************************************************************
1747c478bd9Sstevel@tonic-gate *
17527f7c583Smyers * FUNCTION: AcpiNsSearchOneScope
1767c478bd9Sstevel@tonic-gate *
1777c478bd9Sstevel@tonic-gate * PARAMETERS: TargetName - Ascii ACPI name to search for
17827f7c583Smyers * ParentNode - Starting node where search will begin
1797c478bd9Sstevel@tonic-gate * Type - Object type to match
1807c478bd9Sstevel@tonic-gate * ReturnNode - Where the matched Named obj is returned
1817c478bd9Sstevel@tonic-gate *
1827c478bd9Sstevel@tonic-gate * RETURN: Status
1837c478bd9Sstevel@tonic-gate *
18427f7c583Smyers * DESCRIPTION: Search a single level of the namespace. Performs a
1857c478bd9Sstevel@tonic-gate * simple search of the specified level, and does not add
1867c478bd9Sstevel@tonic-gate * entries or search parents.
1877c478bd9Sstevel@tonic-gate *
1887c478bd9Sstevel@tonic-gate *
1897c478bd9Sstevel@tonic-gate * Named object lists are built (and subsequently dumped) in the
1907c478bd9Sstevel@tonic-gate * order in which the names are encountered during the namespace load;
1917c478bd9Sstevel@tonic-gate *
1927c478bd9Sstevel@tonic-gate * All namespace searching is linear in this implementation, but
1937c478bd9Sstevel@tonic-gate * could be easily modified to support any improved search
19427f7c583Smyers * algorithm. However, the linear search was chosen for simplicity
1957c478bd9Sstevel@tonic-gate * and because the trees are small and the other interpreter
1967c478bd9Sstevel@tonic-gate * execution overhead is relatively high.
1977c478bd9Sstevel@tonic-gate *
19827f7c583Smyers * Note: CPU execution analysis has shown that the AML interpreter spends
19927f7c583Smyers * a very small percentage of its time searching the namespace. Therefore,
20027f7c583Smyers * the linear search seems to be sufficient, as there would seem to be
20127f7c583Smyers * little value in improving the search.
20227f7c583Smyers *
2037c478bd9Sstevel@tonic-gate ******************************************************************************/
2047c478bd9Sstevel@tonic-gate
2057c478bd9Sstevel@tonic-gate ACPI_STATUS
AcpiNsSearchOneScope(UINT32 TargetName,ACPI_NAMESPACE_NODE * ParentNode,ACPI_OBJECT_TYPE Type,ACPI_NAMESPACE_NODE ** ReturnNode)20627f7c583Smyers AcpiNsSearchOneScope (
2077c478bd9Sstevel@tonic-gate UINT32 TargetName,
20827f7c583Smyers ACPI_NAMESPACE_NODE *ParentNode,
2097c478bd9Sstevel@tonic-gate ACPI_OBJECT_TYPE Type,
2107c478bd9Sstevel@tonic-gate ACPI_NAMESPACE_NODE **ReturnNode)
2117c478bd9Sstevel@tonic-gate {
21227f7c583Smyers ACPI_NAMESPACE_NODE *Node;
2137c478bd9Sstevel@tonic-gate
2147c478bd9Sstevel@tonic-gate
21527f7c583Smyers ACPI_FUNCTION_TRACE (NsSearchOneScope);
2167c478bd9Sstevel@tonic-gate
2177c478bd9Sstevel@tonic-gate
2187c478bd9Sstevel@tonic-gate #ifdef ACPI_DEBUG_OUTPUT
2197c478bd9Sstevel@tonic-gate if (ACPI_LV_NAMES & AcpiDbgLevel)
2207c478bd9Sstevel@tonic-gate {
2217c478bd9Sstevel@tonic-gate char *ScopeName;
2227c478bd9Sstevel@tonic-gate
2237b1019a6SJerry Jelinek ScopeName = AcpiNsGetNormalizedPathname (ParentNode, TRUE);
2247c478bd9Sstevel@tonic-gate if (ScopeName)
2257c478bd9Sstevel@tonic-gate {
2267c478bd9Sstevel@tonic-gate ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
2277c478bd9Sstevel@tonic-gate "Searching %s (%p) For [%4.4s] (%s)\n",
22827f7c583Smyers ScopeName, ParentNode, ACPI_CAST_PTR (char, &TargetName),
2297c478bd9Sstevel@tonic-gate AcpiUtGetTypeName (Type)));
2307c478bd9Sstevel@tonic-gate
23127f7c583Smyers ACPI_FREE (ScopeName);
2327c478bd9Sstevel@tonic-gate }
2337c478bd9Sstevel@tonic-gate }
2347c478bd9Sstevel@tonic-gate #endif
2357c478bd9Sstevel@tonic-gate
2367c478bd9Sstevel@tonic-gate /*
2377c478bd9Sstevel@tonic-gate * Search for name at this namespace level, which is to say that we
2387c478bd9Sstevel@tonic-gate * must search for the name among the children of this object
2397c478bd9Sstevel@tonic-gate */
24027f7c583Smyers Node = ParentNode->Child;
24127f7c583Smyers while (Node)
2427c478bd9Sstevel@tonic-gate {
2437c478bd9Sstevel@tonic-gate /* Check for match against the name */
2447c478bd9Sstevel@tonic-gate
24527f7c583Smyers if (Node->Name.Integer == TargetName)
2467c478bd9Sstevel@tonic-gate {
2477c478bd9Sstevel@tonic-gate /* Resolve a control method alias if any */
2487c478bd9Sstevel@tonic-gate
24927f7c583Smyers if (AcpiNsGetType (Node) == ACPI_TYPE_LOCAL_METHOD_ALIAS)
2507c478bd9Sstevel@tonic-gate {
25127f7c583Smyers Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Node->Object);
2527c478bd9Sstevel@tonic-gate }
2537c478bd9Sstevel@tonic-gate
25427f7c583Smyers /* Found matching entry */
25527f7c583Smyers
2567c478bd9Sstevel@tonic-gate ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
2577c478bd9Sstevel@tonic-gate "Name [%4.4s] (%s) %p found in scope [%4.4s] %p\n",
25830082d0cSmyers ACPI_CAST_PTR (char, &TargetName),
25927f7c583Smyers AcpiUtGetTypeName (Node->Type),
26027f7c583Smyers Node, AcpiUtGetNodeName (ParentNode), ParentNode));
2617c478bd9Sstevel@tonic-gate
26227f7c583Smyers *ReturnNode = Node;
2637c478bd9Sstevel@tonic-gate return_ACPI_STATUS (AE_OK);
2647c478bd9Sstevel@tonic-gate }
2657c478bd9Sstevel@tonic-gate
2667c478bd9Sstevel@tonic-gate /* Didn't match name, move on to the next peer object */
2677c478bd9Sstevel@tonic-gate
26827f7c583Smyers Node = Node->Peer;
2697c478bd9Sstevel@tonic-gate }
2707c478bd9Sstevel@tonic-gate
2717c478bd9Sstevel@tonic-gate /* Searched entire namespace level, not found */
2727c478bd9Sstevel@tonic-gate
2737c478bd9Sstevel@tonic-gate ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
274aa2aa9a6SDana Myers "Name [%4.4s] (%s) not found in search in scope [%4.4s] "
275aa2aa9a6SDana Myers "%p first child %p\n",
27630082d0cSmyers ACPI_CAST_PTR (char, &TargetName), AcpiUtGetTypeName (Type),
27727f7c583Smyers AcpiUtGetNodeName (ParentNode), ParentNode, ParentNode->Child));
2787c478bd9Sstevel@tonic-gate
2797c478bd9Sstevel@tonic-gate return_ACPI_STATUS (AE_NOT_FOUND);
2807c478bd9Sstevel@tonic-gate }
2817c478bd9Sstevel@tonic-gate
2827c478bd9Sstevel@tonic-gate
2837c478bd9Sstevel@tonic-gate /*******************************************************************************
2847c478bd9Sstevel@tonic-gate *
2857c478bd9Sstevel@tonic-gate * FUNCTION: AcpiNsSearchParentTree
2867c478bd9Sstevel@tonic-gate *
2877c478bd9Sstevel@tonic-gate * PARAMETERS: TargetName - Ascii ACPI name to search for
2887c478bd9Sstevel@tonic-gate * Node - Starting node where search will begin
2897c478bd9Sstevel@tonic-gate * Type - Object type to match
2907c478bd9Sstevel@tonic-gate * ReturnNode - Where the matched Node is returned
2917c478bd9Sstevel@tonic-gate *
2927c478bd9Sstevel@tonic-gate * RETURN: Status
2937c478bd9Sstevel@tonic-gate *
2947c478bd9Sstevel@tonic-gate * DESCRIPTION: Called when a name has not been found in the current namespace
29527f7c583Smyers * level. Before adding it or giving up, ACPI scope rules require
2967c478bd9Sstevel@tonic-gate * searching enclosing scopes in cases identified by AcpiNsLocal().
2977c478bd9Sstevel@tonic-gate *
2987c478bd9Sstevel@tonic-gate * "A name is located by finding the matching name in the current
2997c478bd9Sstevel@tonic-gate * name space, and then in the parent name space. If the parent
3007c478bd9Sstevel@tonic-gate * name space does not contain the name, the search continues
3017c478bd9Sstevel@tonic-gate * recursively until either the name is found or the name space
30227f7c583Smyers * does not have a parent (the root of the name space). This
3037c478bd9Sstevel@tonic-gate * indicates that the name is not found" (From ACPI Specification,
3047c478bd9Sstevel@tonic-gate * section 5.3)
3057c478bd9Sstevel@tonic-gate *
3067c478bd9Sstevel@tonic-gate ******************************************************************************/
3077c478bd9Sstevel@tonic-gate
3087c478bd9Sstevel@tonic-gate static ACPI_STATUS
AcpiNsSearchParentTree(UINT32 TargetName,ACPI_NAMESPACE_NODE * Node,ACPI_OBJECT_TYPE Type,ACPI_NAMESPACE_NODE ** ReturnNode)3097c478bd9Sstevel@tonic-gate AcpiNsSearchParentTree (
3107c478bd9Sstevel@tonic-gate UINT32 TargetName,
3117c478bd9Sstevel@tonic-gate ACPI_NAMESPACE_NODE *Node,
3127c478bd9Sstevel@tonic-gate ACPI_OBJECT_TYPE Type,
3137c478bd9Sstevel@tonic-gate ACPI_NAMESPACE_NODE **ReturnNode)
3147c478bd9Sstevel@tonic-gate {
3157c478bd9Sstevel@tonic-gate ACPI_STATUS Status;
3167c478bd9Sstevel@tonic-gate ACPI_NAMESPACE_NODE *ParentNode;
3177c478bd9Sstevel@tonic-gate
3187c478bd9Sstevel@tonic-gate
31927f7c583Smyers ACPI_FUNCTION_TRACE (NsSearchParentTree);
3207c478bd9Sstevel@tonic-gate
3217c478bd9Sstevel@tonic-gate
32226f3cdf0SGordon Ross ParentNode = Node->Parent;
3237c478bd9Sstevel@tonic-gate
3247c478bd9Sstevel@tonic-gate /*
3257c478bd9Sstevel@tonic-gate * If there is no parent (i.e., we are at the root) or type is "local",
3267c478bd9Sstevel@tonic-gate * we won't be searching the parent tree.
3277c478bd9Sstevel@tonic-gate */
3287c478bd9Sstevel@tonic-gate if (!ParentNode)
3297c478bd9Sstevel@tonic-gate {
3307c478bd9Sstevel@tonic-gate ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "[%4.4s] has no parent\n",
33130082d0cSmyers ACPI_CAST_PTR (char, &TargetName)));
3327c478bd9Sstevel@tonic-gate return_ACPI_STATUS (AE_NOT_FOUND);
3337c478bd9Sstevel@tonic-gate }
3347c478bd9Sstevel@tonic-gate
3357c478bd9Sstevel@tonic-gate if (AcpiNsLocal (Type))
3367c478bd9Sstevel@tonic-gate {
3377c478bd9Sstevel@tonic-gate ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
3387c478bd9Sstevel@tonic-gate "[%4.4s] type [%s] must be local to this scope (no parent search)\n",
33930082d0cSmyers ACPI_CAST_PTR (char, &TargetName), AcpiUtGetTypeName (Type)));
3407c478bd9Sstevel@tonic-gate return_ACPI_STATUS (AE_NOT_FOUND);
3417c478bd9Sstevel@tonic-gate }
3427c478bd9Sstevel@tonic-gate
3437c478bd9Sstevel@tonic-gate /* Search the parent tree */
3447c478bd9Sstevel@tonic-gate
3457c478bd9Sstevel@tonic-gate ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
3467c478bd9Sstevel@tonic-gate "Searching parent [%4.4s] for [%4.4s]\n",
34730082d0cSmyers AcpiUtGetNodeName (ParentNode), ACPI_CAST_PTR (char, &TargetName)));
3487c478bd9Sstevel@tonic-gate
349aa2aa9a6SDana Myers /* Search parents until target is found or we have backed up to the root */
350aa2aa9a6SDana Myers
3517c478bd9Sstevel@tonic-gate while (ParentNode)
3527c478bd9Sstevel@tonic-gate {
3537c478bd9Sstevel@tonic-gate /*
35427f7c583Smyers * Search parent scope. Use TYPE_ANY because we don't care about the
3557c478bd9Sstevel@tonic-gate * object type at this point, we only care about the existence of
35627f7c583Smyers * the actual name we are searching for. Typechecking comes later.
3577c478bd9Sstevel@tonic-gate */
35827f7c583Smyers Status = AcpiNsSearchOneScope (
3597b1019a6SJerry Jelinek TargetName, ParentNode, ACPI_TYPE_ANY, ReturnNode);
3607c478bd9Sstevel@tonic-gate if (ACPI_SUCCESS (Status))
3617c478bd9Sstevel@tonic-gate {
3627c478bd9Sstevel@tonic-gate return_ACPI_STATUS (Status);
3637c478bd9Sstevel@tonic-gate }
3647c478bd9Sstevel@tonic-gate
36527f7c583Smyers /* Not found here, go up another level (until we reach the root) */
36627f7c583Smyers
36726f3cdf0SGordon Ross ParentNode = ParentNode->Parent;
3687c478bd9Sstevel@tonic-gate }
3697c478bd9Sstevel@tonic-gate
3707c478bd9Sstevel@tonic-gate /* Not found in parent tree */
3717c478bd9Sstevel@tonic-gate
3727c478bd9Sstevel@tonic-gate return_ACPI_STATUS (AE_NOT_FOUND);
3737c478bd9Sstevel@tonic-gate }
3747c478bd9Sstevel@tonic-gate
3757c478bd9Sstevel@tonic-gate
3767c478bd9Sstevel@tonic-gate /*******************************************************************************
3777c478bd9Sstevel@tonic-gate *
3787c478bd9Sstevel@tonic-gate * FUNCTION: AcpiNsSearchAndEnter
3797c478bd9Sstevel@tonic-gate *
3807c478bd9Sstevel@tonic-gate * PARAMETERS: TargetName - Ascii ACPI name to search for (4 chars)
3817c478bd9Sstevel@tonic-gate * WalkState - Current state of the walk
3827c478bd9Sstevel@tonic-gate * Node - Starting node where search will begin
3837c478bd9Sstevel@tonic-gate * InterpreterMode - Add names only in ACPI_MODE_LOAD_PASS_x.
3847c478bd9Sstevel@tonic-gate * Otherwise,search only.
3857c478bd9Sstevel@tonic-gate * Type - Object type to match
3867c478bd9Sstevel@tonic-gate * Flags - Flags describing the search restrictions
3877c478bd9Sstevel@tonic-gate * ReturnNode - Where the Node is returned
3887c478bd9Sstevel@tonic-gate *
3897c478bd9Sstevel@tonic-gate * RETURN: Status
3907c478bd9Sstevel@tonic-gate *
3917c478bd9Sstevel@tonic-gate * DESCRIPTION: Search for a name segment in a single namespace level,
39227f7c583Smyers * optionally adding it if it is not found. If the passed
3937c478bd9Sstevel@tonic-gate * Type is not Any and the type previously stored in the
3947c478bd9Sstevel@tonic-gate * entry was Any (i.e. unknown), update the stored type.
3957c478bd9Sstevel@tonic-gate *
3967c478bd9Sstevel@tonic-gate * In ACPI_IMODE_EXECUTE, search only.
3977c478bd9Sstevel@tonic-gate * In other modes, search and add if not found.
3987c478bd9Sstevel@tonic-gate *
3997c478bd9Sstevel@tonic-gate ******************************************************************************/
4007c478bd9Sstevel@tonic-gate
4017c478bd9Sstevel@tonic-gate ACPI_STATUS
AcpiNsSearchAndEnter(UINT32 TargetName,ACPI_WALK_STATE * WalkState,ACPI_NAMESPACE_NODE * Node,ACPI_INTERPRETER_MODE InterpreterMode,ACPI_OBJECT_TYPE Type,UINT32 Flags,ACPI_NAMESPACE_NODE ** ReturnNode)4027c478bd9Sstevel@tonic-gate AcpiNsSearchAndEnter (
4037c478bd9Sstevel@tonic-gate UINT32 TargetName,
4047c478bd9Sstevel@tonic-gate ACPI_WALK_STATE *WalkState,
4057c478bd9Sstevel@tonic-gate ACPI_NAMESPACE_NODE *Node,
4067c478bd9Sstevel@tonic-gate ACPI_INTERPRETER_MODE InterpreterMode,
4077c478bd9Sstevel@tonic-gate ACPI_OBJECT_TYPE Type,
4087c478bd9Sstevel@tonic-gate UINT32 Flags,
4097c478bd9Sstevel@tonic-gate ACPI_NAMESPACE_NODE **ReturnNode)
4107c478bd9Sstevel@tonic-gate {
4117c478bd9Sstevel@tonic-gate ACPI_STATUS Status;
4127c478bd9Sstevel@tonic-gate ACPI_NAMESPACE_NODE *NewNode;
4137c478bd9Sstevel@tonic-gate
4147c478bd9Sstevel@tonic-gate
41527f7c583Smyers ACPI_FUNCTION_TRACE (NsSearchAndEnter);
4167c478bd9Sstevel@tonic-gate
4177c478bd9Sstevel@tonic-gate
4187c478bd9Sstevel@tonic-gate /* Parameter validation */
4197c478bd9Sstevel@tonic-gate
4207c478bd9Sstevel@tonic-gate if (!Node || !TargetName || !ReturnNode)
4217c478bd9Sstevel@tonic-gate {
42230082d0cSmyers ACPI_ERROR ((AE_INFO,
42326f3cdf0SGordon Ross "Null parameter: Node %p Name 0x%X ReturnNode %p",
4247c478bd9Sstevel@tonic-gate Node, TargetName, ReturnNode));
4257c478bd9Sstevel@tonic-gate return_ACPI_STATUS (AE_BAD_PARAMETER);
4267c478bd9Sstevel@tonic-gate }
4277c478bd9Sstevel@tonic-gate
42827f7c583Smyers /*
42927f7c583Smyers * Name must consist of valid ACPI characters. We will repair the name if
43027f7c583Smyers * necessary because we don't want to abort because of this, but we want
43127f7c583Smyers * all namespace names to be printable. A warning message is appropriate.
43227f7c583Smyers *
43327f7c583Smyers * This issue came up because there are in fact machines that exhibit
43427f7c583Smyers * this problem, and we want to be able to enable ACPI support for them,
43527f7c583Smyers * even though there are a few bad names.
43627f7c583Smyers */
437db2bae30SDana Myers AcpiUtRepairName (ACPI_CAST_PTR (char, &TargetName));
4387c478bd9Sstevel@tonic-gate
4397c478bd9Sstevel@tonic-gate /* Try to find the name in the namespace level specified by the caller */
4407c478bd9Sstevel@tonic-gate
4417c478bd9Sstevel@tonic-gate *ReturnNode = ACPI_ENTRY_NOT_FOUND;
44227f7c583Smyers Status = AcpiNsSearchOneScope (TargetName, Node, Type, ReturnNode);
4437c478bd9Sstevel@tonic-gate if (Status != AE_NOT_FOUND)
4447c478bd9Sstevel@tonic-gate {
4457c478bd9Sstevel@tonic-gate /*
4467c478bd9Sstevel@tonic-gate * If we found it AND the request specifies that a find is an error,
4477c478bd9Sstevel@tonic-gate * return the error
4487c478bd9Sstevel@tonic-gate */
4497b1019a6SJerry Jelinek if (Status == AE_OK)
4507c478bd9Sstevel@tonic-gate {
4517b1019a6SJerry Jelinek /* The node was found in the namespace */
4527b1019a6SJerry Jelinek
4537b1019a6SJerry Jelinek /*
4547b1019a6SJerry Jelinek * If the namespace override feature is enabled for this node,
4557b1019a6SJerry Jelinek * delete any existing attached sub-object and make the node
4567b1019a6SJerry Jelinek * look like a new node that is owned by the override table.
4577b1019a6SJerry Jelinek */
4587b1019a6SJerry Jelinek if (Flags & ACPI_NS_OVERRIDE_IF_FOUND)
4597b1019a6SJerry Jelinek {
4607b1019a6SJerry Jelinek ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
4617b1019a6SJerry Jelinek "Namespace override: %4.4s pass %u type %X Owner %X\n",
4627b1019a6SJerry Jelinek ACPI_CAST_PTR(char, &TargetName), InterpreterMode,
4637b1019a6SJerry Jelinek (*ReturnNode)->Type, WalkState->OwnerId));
4647b1019a6SJerry Jelinek
4657b1019a6SJerry Jelinek AcpiNsDeleteChildren (*ReturnNode);
4667b1019a6SJerry Jelinek if (AcpiGbl_RuntimeNamespaceOverride)
4677b1019a6SJerry Jelinek {
4687b1019a6SJerry Jelinek AcpiUtRemoveReference ((*ReturnNode)->Object);
4697b1019a6SJerry Jelinek (*ReturnNode)->Object = NULL;
4707b1019a6SJerry Jelinek (*ReturnNode)->OwnerId = WalkState->OwnerId;
4717b1019a6SJerry Jelinek }
4727b1019a6SJerry Jelinek else
4737b1019a6SJerry Jelinek {
4747b1019a6SJerry Jelinek AcpiNsRemoveNode (*ReturnNode);
4757b1019a6SJerry Jelinek *ReturnNode = ACPI_ENTRY_NOT_FOUND;
4767b1019a6SJerry Jelinek }
4777b1019a6SJerry Jelinek }
4787b1019a6SJerry Jelinek
4797b1019a6SJerry Jelinek /* Return an error if we don't expect to find the object */
4807b1019a6SJerry Jelinek
4817b1019a6SJerry Jelinek else if (Flags & ACPI_NS_ERROR_IF_FOUND)
4827b1019a6SJerry Jelinek {
4837b1019a6SJerry Jelinek Status = AE_ALREADY_EXISTS;
4847b1019a6SJerry Jelinek }
4857c478bd9Sstevel@tonic-gate }
4867c478bd9Sstevel@tonic-gate
487aa2aa9a6SDana Myers #ifdef ACPI_ASL_COMPILER
488aa2aa9a6SDana Myers if (*ReturnNode && (*ReturnNode)->Type == ACPI_TYPE_ANY)
489aa2aa9a6SDana Myers {
490aa2aa9a6SDana Myers (*ReturnNode)->Flags |= ANOBJ_IS_EXTERNAL;
491aa2aa9a6SDana Myers }
492aa2aa9a6SDana Myers #endif
493aa2aa9a6SDana Myers
49427f7c583Smyers /* Either found it or there was an error: finished either way */
49527f7c583Smyers
4967c478bd9Sstevel@tonic-gate return_ACPI_STATUS (Status);
4977c478bd9Sstevel@tonic-gate }
4987c478bd9Sstevel@tonic-gate
4997c478bd9Sstevel@tonic-gate /*
50027f7c583Smyers * The name was not found. If we are NOT performing the first pass
5017c478bd9Sstevel@tonic-gate * (name entry) of loading the namespace, search the parent tree (all the
5027c478bd9Sstevel@tonic-gate * way to the root if necessary.) We don't want to perform the parent
50327f7c583Smyers * search when the namespace is actually being loaded. We want to perform
5047c478bd9Sstevel@tonic-gate * the search when namespace references are being resolved (load pass 2)
5057c478bd9Sstevel@tonic-gate * and during the execution phase.
5067c478bd9Sstevel@tonic-gate */
5077c478bd9Sstevel@tonic-gate if ((InterpreterMode != ACPI_IMODE_LOAD_PASS1) &&
5087c478bd9Sstevel@tonic-gate (Flags & ACPI_NS_SEARCH_PARENT))
5097c478bd9Sstevel@tonic-gate {
5107c478bd9Sstevel@tonic-gate /*
5117c478bd9Sstevel@tonic-gate * Not found at this level - search parent tree according to the
5127c478bd9Sstevel@tonic-gate * ACPI specification
5137c478bd9Sstevel@tonic-gate */
5147c478bd9Sstevel@tonic-gate Status = AcpiNsSearchParentTree (TargetName, Node, Type, ReturnNode);
5157c478bd9Sstevel@tonic-gate if (ACPI_SUCCESS (Status))
5167c478bd9Sstevel@tonic-gate {
5177c478bd9Sstevel@tonic-gate return_ACPI_STATUS (Status);
5187c478bd9Sstevel@tonic-gate }
5197c478bd9Sstevel@tonic-gate }
5207c478bd9Sstevel@tonic-gate
52127f7c583Smyers /* In execute mode, just search, never add names. Exit now */
52227f7c583Smyers
5237c478bd9Sstevel@tonic-gate if (InterpreterMode == ACPI_IMODE_EXECUTE)
5247c478bd9Sstevel@tonic-gate {
5257c478bd9Sstevel@tonic-gate ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
5267c478bd9Sstevel@tonic-gate "%4.4s Not found in %p [Not adding]\n",
52730082d0cSmyers ACPI_CAST_PTR (char, &TargetName), Node));
5287c478bd9Sstevel@tonic-gate
5297c478bd9Sstevel@tonic-gate return_ACPI_STATUS (AE_NOT_FOUND);
5307c478bd9Sstevel@tonic-gate }
5317c478bd9Sstevel@tonic-gate
5327c478bd9Sstevel@tonic-gate /* Create the new named object */
5337c478bd9Sstevel@tonic-gate
5347c478bd9Sstevel@tonic-gate NewNode = AcpiNsCreateNode (TargetName);
5357c478bd9Sstevel@tonic-gate if (!NewNode)
5367c478bd9Sstevel@tonic-gate {
5377c478bd9Sstevel@tonic-gate return_ACPI_STATUS (AE_NO_MEMORY);
5387c478bd9Sstevel@tonic-gate }
5397c478bd9Sstevel@tonic-gate
54027f7c583Smyers #ifdef ACPI_ASL_COMPILER
541aa2aa9a6SDana Myers
542aa2aa9a6SDana Myers /* Node is an object defined by an External() statement */
543aa2aa9a6SDana Myers
544aa2aa9a6SDana Myers if (Flags & ACPI_NS_EXTERNAL ||
545aa2aa9a6SDana Myers (WalkState && WalkState->Opcode == AML_SCOPE_OP))
54627f7c583Smyers {
54727f7c583Smyers NewNode->Flags |= ANOBJ_IS_EXTERNAL;
54827f7c583Smyers }
54927f7c583Smyers #endif
55027f7c583Smyers
551db2bae30SDana Myers if (Flags & ACPI_NS_TEMPORARY)
552db2bae30SDana Myers {
553db2bae30SDana Myers NewNode->Flags |= ANOBJ_TEMPORARY;
554db2bae30SDana Myers }
555db2bae30SDana Myers
5567c478bd9Sstevel@tonic-gate /* Install the new object into the parent's list of children */
5577c478bd9Sstevel@tonic-gate
5587c478bd9Sstevel@tonic-gate AcpiNsInstallNode (WalkState, Node, NewNode, Type);
5597c478bd9Sstevel@tonic-gate *ReturnNode = NewNode;
5607c478bd9Sstevel@tonic-gate return_ACPI_STATUS (AE_OK);
5617c478bd9Sstevel@tonic-gate }
562