1 /******************************************************************************
2 *
3 * Module Name: pstree - Parser op tree manipulation/traversal/search
4 *
5 *****************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2009, 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
117 #define __PSTREE_C__
118
119 #include "acpi.h"
120 #include "accommon.h"
121 #include "acparser.h"
122 #include "amlcode.h"
123
124 #define _COMPONENT ACPI_PARSER
125 ACPI_MODULE_NAME ("pstree")
126
127 /* Local prototypes */
128
129 #ifdef ACPI_OBSOLETE_FUNCTIONS
130 ACPI_PARSE_OBJECT *
131 AcpiPsGetChild (
132 ACPI_PARSE_OBJECT *op);
133 #endif
134
135
136 /*******************************************************************************
137 *
138 * FUNCTION: AcpiPsGetArg
139 *
140 * PARAMETERS: Op - Get an argument for this op
141 * Argn - Nth argument to get
142 *
143 * RETURN: The argument (as an Op object). NULL if argument does not exist
144 *
145 * DESCRIPTION: Get the specified op's argument.
146 *
147 ******************************************************************************/
148
149 ACPI_PARSE_OBJECT *
AcpiPsGetArg(ACPI_PARSE_OBJECT * Op,UINT32 Argn)150 AcpiPsGetArg (
151 ACPI_PARSE_OBJECT *Op,
152 UINT32 Argn)
153 {
154 ACPI_PARSE_OBJECT *Arg = NULL;
155 const ACPI_OPCODE_INFO *OpInfo;
156
157
158 ACPI_FUNCTION_ENTRY ();
159
160
161 /* Get the info structure for this opcode */
162
163 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
164 if (OpInfo->Class == AML_CLASS_UNKNOWN)
165 {
166 /* Invalid opcode or ASCII character */
167
168 return (NULL);
169 }
170
171 /* Check if this opcode requires argument sub-objects */
172
173 if (!(OpInfo->Flags & AML_HAS_ARGS))
174 {
175 /* Has no linked argument objects */
176
177 return (NULL);
178 }
179
180 /* Get the requested argument object */
181
182 Arg = Op->Common.Value.Arg;
183 while (Arg && Argn)
184 {
185 Argn--;
186 Arg = Arg->Common.Next;
187 }
188
189 return (Arg);
190 }
191
192
193 /*******************************************************************************
194 *
195 * FUNCTION: AcpiPsAppendArg
196 *
197 * PARAMETERS: Op - Append an argument to this Op.
198 * Arg - Argument Op to append
199 *
200 * RETURN: None.
201 *
202 * DESCRIPTION: Append an argument to an op's argument list (a NULL arg is OK)
203 *
204 ******************************************************************************/
205
206 void
AcpiPsAppendArg(ACPI_PARSE_OBJECT * Op,ACPI_PARSE_OBJECT * Arg)207 AcpiPsAppendArg (
208 ACPI_PARSE_OBJECT *Op,
209 ACPI_PARSE_OBJECT *Arg)
210 {
211 ACPI_PARSE_OBJECT *PrevArg;
212 const ACPI_OPCODE_INFO *OpInfo;
213
214
215 ACPI_FUNCTION_ENTRY ();
216
217
218 if (!Op)
219 {
220 return;
221 }
222
223 /* Get the info structure for this opcode */
224
225 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
226 if (OpInfo->Class == AML_CLASS_UNKNOWN)
227 {
228 /* Invalid opcode */
229
230 ACPI_ERROR ((AE_INFO, "Invalid AML Opcode: 0x%2.2X",
231 Op->Common.AmlOpcode));
232 return;
233 }
234
235 /* Check if this opcode requires argument sub-objects */
236
237 if (!(OpInfo->Flags & AML_HAS_ARGS))
238 {
239 /* Has no linked argument objects */
240
241 return;
242 }
243
244 /* Append the argument to the linked argument list */
245
246 if (Op->Common.Value.Arg)
247 {
248 /* Append to existing argument list */
249
250 PrevArg = Op->Common.Value.Arg;
251 while (PrevArg->Common.Next)
252 {
253 PrevArg = PrevArg->Common.Next;
254 }
255 PrevArg->Common.Next = Arg;
256 }
257 else
258 {
259 /* No argument list, this will be the first argument */
260
261 Op->Common.Value.Arg = Arg;
262 }
263
264 /* Set the parent in this arg and any args linked after it */
265
266 while (Arg)
267 {
268 Arg->Common.Parent = Op;
269 Arg = Arg->Common.Next;
270
271 Op->Common.ArgListLength++;
272 }
273 }
274
275
276 /*******************************************************************************
277 *
278 * FUNCTION: AcpiPsGetDepthNext
279 *
280 * PARAMETERS: Origin - Root of subtree to search
281 * Op - Last (previous) Op that was found
282 *
283 * RETURN: Next Op found in the search.
284 *
285 * DESCRIPTION: Get next op in tree (walking the tree in depth-first order)
286 * Return NULL when reaching "origin" or when walking up from root
287 *
288 ******************************************************************************/
289
290 ACPI_PARSE_OBJECT *
AcpiPsGetDepthNext(ACPI_PARSE_OBJECT * Origin,ACPI_PARSE_OBJECT * Op)291 AcpiPsGetDepthNext (
292 ACPI_PARSE_OBJECT *Origin,
293 ACPI_PARSE_OBJECT *Op)
294 {
295 ACPI_PARSE_OBJECT *Next = NULL;
296 ACPI_PARSE_OBJECT *Parent;
297 ACPI_PARSE_OBJECT *Arg;
298
299
300 ACPI_FUNCTION_ENTRY ();
301
302
303 if (!Op)
304 {
305 return (NULL);
306 }
307
308 /* Look for an argument or child */
309
310 Next = AcpiPsGetArg (Op, 0);
311 if (Next)
312 {
313 return (Next);
314 }
315
316 /* Look for a sibling */
317
318 Next = Op->Common.Next;
319 if (Next)
320 {
321 return (Next);
322 }
323
324 /* Look for a sibling of parent */
325
326 Parent = Op->Common.Parent;
327
328 while (Parent)
329 {
330 Arg = AcpiPsGetArg (Parent, 0);
331 while (Arg && (Arg != Origin) && (Arg != Op))
332 {
333 Arg = Arg->Common.Next;
334 }
335
336 if (Arg == Origin)
337 {
338 /* Reached parent of origin, end search */
339
340 return (NULL);
341 }
342
343 if (Parent->Common.Next)
344 {
345 /* Found sibling of parent */
346
347 return (Parent->Common.Next);
348 }
349
350 Op = Parent;
351 Parent = Parent->Common.Parent;
352 }
353
354 return (Next);
355 }
356
357
358 #ifdef ACPI_OBSOLETE_FUNCTIONS
359 /*******************************************************************************
360 *
361 * FUNCTION: AcpiPsGetChild
362 *
363 * PARAMETERS: Op - Get the child of this Op
364 *
365 * RETURN: Child Op, Null if none is found.
366 *
367 * DESCRIPTION: Get op's children or NULL if none
368 *
369 ******************************************************************************/
370
371 ACPI_PARSE_OBJECT *
AcpiPsGetChild(ACPI_PARSE_OBJECT * Op)372 AcpiPsGetChild (
373 ACPI_PARSE_OBJECT *Op)
374 {
375 ACPI_PARSE_OBJECT *Child = NULL;
376
377
378 ACPI_FUNCTION_ENTRY ();
379
380
381 switch (Op->Common.AmlOpcode)
382 {
383 case AML_SCOPE_OP:
384 case AML_ELSE_OP:
385 case AML_DEVICE_OP:
386 case AML_THERMAL_ZONE_OP:
387 case AML_INT_METHODCALL_OP:
388
389 Child = AcpiPsGetArg (Op, 0);
390 break;
391
392
393 case AML_BUFFER_OP:
394 case AML_PACKAGE_OP:
395 case AML_METHOD_OP:
396 case AML_IF_OP:
397 case AML_WHILE_OP:
398 case AML_FIELD_OP:
399
400 Child = AcpiPsGetArg (Op, 1);
401 break;
402
403
404 case AML_POWER_RES_OP:
405 case AML_INDEX_FIELD_OP:
406
407 Child = AcpiPsGetArg (Op, 2);
408 break;
409
410
411 case AML_PROCESSOR_OP:
412 case AML_BANK_FIELD_OP:
413
414 Child = AcpiPsGetArg (Op, 3);
415 break;
416
417
418 default:
419 /* All others have no children */
420 break;
421 }
422
423 return (Child);
424 }
425 #endif
426
427
428