1 /******************************************************************************
3 * Module Name: pstree - Parser op tree manipulation/traversal/search
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2004, 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 *****************************************************************************/
121 #include "acparser.h"
124 #define _COMPONENT ACPI_PARSER
125 ACPI_MODULE_NAME ("pstree")
128 /*******************************************************************************
130 * FUNCTION: AcpiPsGetArg
132 * PARAMETERS: Op - Get an argument for this op
133 * Argn - Nth argument to get
135 * RETURN: The argument (as an Op object). NULL if argument does not exist
137 * DESCRIPTION: Get the specified op's argument.
139 ******************************************************************************/
143 ACPI_PARSE_OBJECT *Op,
146 ACPI_PARSE_OBJECT *Arg = NULL;
147 const ACPI_OPCODE_INFO *OpInfo;
150 ACPI_FUNCTION_ENTRY ();
153 /* Get the info structure for this opcode */
155 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
156 if (OpInfo->Class == AML_CLASS_UNKNOWN)
158 /* Invalid opcode or ASCII character */
163 /* Check if this opcode requires argument sub-objects */
165 if (!(OpInfo->Flags & AML_HAS_ARGS))
167 /* Has no linked argument objects */
172 /* Get the requested argument object */
174 Arg = Op->Common.Value.Arg;
178 Arg = Arg->Common.Next;
185 /*******************************************************************************
187 * FUNCTION: AcpiPsAppendArg
189 * PARAMETERS: Op - Append an argument to this Op.
190 * Arg - Argument Op to append
194 * DESCRIPTION: Append an argument to an op's argument list (a NULL arg is OK)
196 ******************************************************************************/
200 ACPI_PARSE_OBJECT *Op,
201 ACPI_PARSE_OBJECT *Arg)
203 ACPI_PARSE_OBJECT *PrevArg;
204 const ACPI_OPCODE_INFO *OpInfo;
207 ACPI_FUNCTION_ENTRY ();
215 /* Get the info structure for this opcode */
217 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
218 if (OpInfo->Class == AML_CLASS_UNKNOWN)
222 ACPI_REPORT_ERROR (("PsAppendArg: Invalid AML Opcode: 0x%2.2X\n",
223 Op->Common.AmlOpcode));
227 /* Check if this opcode requires argument sub-objects */
229 if (!(OpInfo->Flags & AML_HAS_ARGS))
231 /* Has no linked argument objects */
237 /* Append the argument to the linked argument list */
239 if (Op->Common.Value.Arg)
241 /* Append to existing argument list */
243 PrevArg = Op->Common.Value.Arg;
244 while (PrevArg->Common.Next)
246 PrevArg = PrevArg->Common.Next;
248 PrevArg->Common.Next = Arg;
253 /* No argument list, this will be the first argument */
255 Op->Common.Value.Arg = Arg;
259 /* Set the parent in this arg and any args linked after it */
263 Arg->Common.Parent = Op;
264 Arg = Arg->Common.Next;
269 /*******************************************************************************
271 * FUNCTION: AcpiPsGetChild
273 * PARAMETERS: Op - Get the child of this Op
275 * RETURN: Child Op, Null if none is found.
277 * DESCRIPTION: Get op's children or NULL if none
279 ******************************************************************************/
283 ACPI_PARSE_OBJECT *Op)
285 ACPI_PARSE_OBJECT *Child = NULL;
288 ACPI_FUNCTION_ENTRY ();
291 switch (Op->Common.AmlOpcode)
296 case AML_THERMAL_ZONE_OP:
297 case AML_INT_METHODCALL_OP:
299 Child = AcpiPsGetArg (Op, 0);
310 Child = AcpiPsGetArg (Op, 1);
314 case AML_POWER_RES_OP:
315 case AML_INDEX_FIELD_OP:
317 Child = AcpiPsGetArg (Op, 2);
321 case AML_PROCESSOR_OP:
322 case AML_BANK_FIELD_OP:
324 Child = AcpiPsGetArg (Op, 3);
329 /* All others have no children */
337 /*******************************************************************************
339 * FUNCTION: AcpiPsGetDepthNext
341 * PARAMETERS: Origin - Root of subtree to search
342 * Op - Last (previous) Op that was found
344 * RETURN: Next Op found in the search.
346 * DESCRIPTION: Get next op in tree (walking the tree in depth-first order)
347 * Return NULL when reaching "origin" or when walking up from root
349 ******************************************************************************/
353 ACPI_PARSE_OBJECT *Origin,
354 ACPI_PARSE_OBJECT *Op)
356 ACPI_PARSE_OBJECT *Next = NULL;
357 ACPI_PARSE_OBJECT *Parent;
358 ACPI_PARSE_OBJECT *Arg;
361 ACPI_FUNCTION_ENTRY ();
369 /* look for an argument or child */
371 Next = AcpiPsGetArg (Op, 0);
377 /* look for a sibling */
379 Next = Op->Common.Next;
385 /* look for a sibling of parent */
387 Parent = Op->Common.Parent;
391 Arg = AcpiPsGetArg (Parent, 0);
392 while (Arg && (Arg != Origin) && (Arg != Op))
394 Arg = Arg->Common.Next;
399 /* reached parent of origin, end search */
404 if (Parent->Common.Next)
406 /* found sibling of parent */
408 return (Parent->Common.Next);
412 Parent = Parent->Common.Parent;