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