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