drivers/acpi/components/parser/pstree.c

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