1 /******************************************************************************
3 * Module Name: pstree - Parser op tree manipulation/traversal/search
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2014, 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.
49 #define _COMPONENT ACPI_PARSER
50 ACPI_MODULE_NAME ("pstree")
52 /* Local prototypes */
54 #ifdef ACPI_OBSOLETE_FUNCTIONS
57 ACPI_PARSE_OBJECT *op);
61 /*******************************************************************************
63 * FUNCTION: AcpiPsGetArg
65 * PARAMETERS: Op - Get an argument for this op
66 * Argn - Nth argument to get
68 * RETURN: The argument (as an Op object). NULL if argument does not exist
70 * DESCRIPTION: Get the specified op's argument.
72 ******************************************************************************/
76 ACPI_PARSE_OBJECT *Op,
79 ACPI_PARSE_OBJECT *Arg = NULL;
80 const ACPI_OPCODE_INFO *OpInfo;
83 ACPI_FUNCTION_ENTRY ();
86 if (Op->Common.AmlOpcode == AML_INT_CONNECTION_OP)
88 return (Op->Common.Value.Arg);
91 /* Get the info structure for this opcode */
93 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
94 if (OpInfo->Class == AML_CLASS_UNKNOWN)
96 /* Invalid opcode or ASCII character */
101 /* Check if this opcode requires argument sub-objects */
103 if (!(OpInfo->Flags & AML_HAS_ARGS))
105 /* Has no linked argument objects */
110 /* Get the requested argument object */
112 Arg = Op->Common.Value.Arg;
116 Arg = Arg->Common.Next;
123 /*******************************************************************************
125 * FUNCTION: AcpiPsAppendArg
127 * PARAMETERS: Op - Append an argument to this Op.
128 * Arg - Argument Op to append
132 * DESCRIPTION: Append an argument to an op's argument list (a NULL arg is OK)
134 ******************************************************************************/
138 ACPI_PARSE_OBJECT *Op,
139 ACPI_PARSE_OBJECT *Arg)
141 ACPI_PARSE_OBJECT *PrevArg;
142 const ACPI_OPCODE_INFO *OpInfo;
145 ACPI_FUNCTION_ENTRY ();
153 /* Get the info structure for this opcode */
155 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
156 if (OpInfo->Class == AML_CLASS_UNKNOWN)
160 ACPI_ERROR ((AE_INFO, "Invalid AML Opcode: 0x%2.2X",
161 Op->Common.AmlOpcode));
165 /* Check if this opcode requires argument sub-objects */
167 if (!(OpInfo->Flags & AML_HAS_ARGS))
169 /* Has no linked argument objects */
174 /* Append the argument to the linked argument list */
176 if (Op->Common.Value.Arg)
178 /* Append to existing argument list */
180 PrevArg = Op->Common.Value.Arg;
181 while (PrevArg->Common.Next)
183 PrevArg = PrevArg->Common.Next;
185 PrevArg->Common.Next = Arg;
189 /* No argument list, this will be the first argument */
191 Op->Common.Value.Arg = Arg;
194 /* Set the parent in this arg and any args linked after it */
198 Arg->Common.Parent = Op;
199 Arg = Arg->Common.Next;
201 Op->Common.ArgListLength++;
206 /*******************************************************************************
208 * FUNCTION: AcpiPsGetDepthNext
210 * PARAMETERS: Origin - Root of subtree to search
211 * Op - Last (previous) Op that was found
213 * RETURN: Next Op found in the search.
215 * DESCRIPTION: Get next op in tree (walking the tree in depth-first order)
216 * Return NULL when reaching "origin" or when walking up from root
218 ******************************************************************************/
222 ACPI_PARSE_OBJECT *Origin,
223 ACPI_PARSE_OBJECT *Op)
225 ACPI_PARSE_OBJECT *Next = NULL;
226 ACPI_PARSE_OBJECT *Parent;
227 ACPI_PARSE_OBJECT *Arg;
230 ACPI_FUNCTION_ENTRY ();
238 /* Look for an argument or child */
240 Next = AcpiPsGetArg (Op, 0);
246 /* Look for a sibling */
248 Next = Op->Common.Next;
254 /* Look for a sibling of parent */
256 Parent = Op->Common.Parent;
260 Arg = AcpiPsGetArg (Parent, 0);
261 while (Arg && (Arg != Origin) && (Arg != Op))
263 Arg = Arg->Common.Next;
268 /* Reached parent of origin, end search */
273 if (Parent->Common.Next)
275 /* Found sibling of parent */
277 return (Parent->Common.Next);
281 Parent = Parent->Common.Parent;
288 #ifdef ACPI_OBSOLETE_FUNCTIONS
289 /*******************************************************************************
291 * FUNCTION: AcpiPsGetChild
293 * PARAMETERS: Op - Get the child of this Op
295 * RETURN: Child Op, Null if none is found.
297 * DESCRIPTION: Get op's children or NULL if none
299 ******************************************************************************/
303 ACPI_PARSE_OBJECT *Op)
305 ACPI_PARSE_OBJECT *Child = NULL;
308 ACPI_FUNCTION_ENTRY ();
311 switch (Op->Common.AmlOpcode)
316 case AML_THERMAL_ZONE_OP:
317 case AML_INT_METHODCALL_OP:
319 Child = AcpiPsGetArg (Op, 0);
329 Child = AcpiPsGetArg (Op, 1);
332 case AML_POWER_RES_OP:
333 case AML_INDEX_FIELD_OP:
335 Child = AcpiPsGetArg (Op, 2);
338 case AML_PROCESSOR_OP:
339 case AML_BANK_FIELD_OP:
341 Child = AcpiPsGetArg (Op, 3);
346 /* All others have no children */