sys/contrib/dev/acpica/pstree.c

   1 /******************************************************************************
   2  *
   3  * Module Name: pstree - Parser op tree manipulation/traversal/search
   4  *              $Revision: 41 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/pstree.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $                                                               */
 117
 118
 119 #define __PSTREE_C__
 120
 121 #include "acpi.h"
 122 #include "acparser.h"
 123 #include "amlcode.h"
 124
 125 #define _COMPONENT          ACPI_PARSER
 126         ACPI_MODULE_NAME    ("pstree")
 127
 128
 129 /*******************************************************************************
 130  *
 131  * FUNCTION:    AcpiPsGetArg
 132  *
 133  * PARAMETERS:  Op              - Get an argument for this op
 134  *              Argn            - Nth argument to get
 135  *
 136  * RETURN:      The argument (as an Op object).  NULL if argument does not exist
 137  *
 138  * DESCRIPTION: Get the specified op's argument.
 139  *
 140  ******************************************************************************/
 141
 142 ACPI_PARSE_OBJECT *
 143 AcpiPsGetArg (
 144     ACPI_PARSE_OBJECT       *Op,
 145     UINT32                  Argn)
 146 {
 147     ACPI_PARSE_OBJECT       *Arg = NULL;
 148     const ACPI_OPCODE_INFO  *OpInfo;
 149
 150
 151     ACPI_FUNCTION_ENTRY ();
 152
 153
 154     /* Get the info structure for this opcode */
 155
 156     OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
 157     if (OpInfo->Class == AML_CLASS_UNKNOWN)
 158     {
 159         /* Invalid opcode or ASCII character */
 160
 161         return (NULL);
 162     }
 163
 164     /* Check if this opcode requires argument sub-objects */
 165
 166     if (!(OpInfo->Flags & AML_HAS_ARGS))
 167     {
 168         /* Has no linked argument objects */
 169
 170         return (NULL);
 171     }
 172
 173     /* Get the requested argument object */
 174
 175     Arg = Op->Common.Value.Arg;
 176     while (Arg && Argn)
 177     {
 178         Argn--;
 179         Arg = Arg->Common.Next;
 180     }
 181
 182     return (Arg);
 183 }
 184
 185
 186 /*******************************************************************************
 187  *
 188  * FUNCTION:    AcpiPsAppendArg
 189  *
 190  * PARAMETERS:  Op              - Append an argument to this Op.
 191  *              Arg             - Argument Op to append
 192  *
 193  * RETURN:      None.
 194  *
 195  * DESCRIPTION: Append an argument to an op's argument list (a NULL arg is OK)
 196  *
 197  ******************************************************************************/
 198
 199 void
 200 AcpiPsAppendArg (
 201     ACPI_PARSE_OBJECT       *Op,
 202     ACPI_PARSE_OBJECT       *Arg)
 203 {
 204     ACPI_PARSE_OBJECT       *PrevArg;
 205     const ACPI_OPCODE_INFO  *OpInfo;
 206
 207
 208     ACPI_FUNCTION_ENTRY ();
 209
 210
 211     if (!Op)
 212     {
 213         return;
 214     }
 215
 216     /* Get the info structure for this opcode */
 217
 218     OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
 219     if (OpInfo->Class == AML_CLASS_UNKNOWN)
 220     {
 221         /* Invalid opcode */
 222
 223         ACPI_REPORT_ERROR (("PsAppendArg: Invalid AML Opcode: 0x%2.2X\n",
 224             Op->Common.AmlOpcode));
 225         return;
 226     }
 227
 228     /* Check if this opcode requires argument sub-objects */
 229
 230     if (!(OpInfo->Flags & AML_HAS_ARGS))
 231     {
 232         /* Has no linked argument objects */
 233
 234         return;
 235     }
 236
 237
 238     /* Append the argument to the linked argument list */
 239
 240     if (Op->Common.Value.Arg)
 241     {
 242         /* Append to existing argument list */
 243
 244         PrevArg = Op->Common.Value.Arg;
 245         while (PrevArg->Common.Next)
 246         {
 247             PrevArg = PrevArg->Common.Next;
 248         }
 249         PrevArg->Common.Next = Arg;
 250     }
 251
 252     else
 253     {
 254         /* No argument list, this will be the first argument */
 255
 256         Op->Common.Value.Arg = Arg;
 257     }
 258
 259
 260     /* Set the parent in this arg and any args linked after it */
 261
 262     while (Arg)
 263     {
 264         Arg->Common.Parent = Op;
 265         Arg = Arg->Common.Next;
 266     }
 267 }
 268
 269
 270 /*******************************************************************************
 271  *
 272  * FUNCTION:    AcpiPsGetChild
 273  *
 274  * PARAMETERS:  Op              - Get the child of this Op
 275  *
 276  * RETURN:      Child Op, Null if none is found.
 277  *
 278  * DESCRIPTION: Get op's children or NULL if none
 279  *
 280  ******************************************************************************/
 281
 282 ACPI_PARSE_OBJECT *
 283 AcpiPsGetChild (
 284     ACPI_PARSE_OBJECT       *Op)
 285 {
 286     ACPI_PARSE_OBJECT       *Child = NULL;
 287
 288
 289     ACPI_FUNCTION_ENTRY ();
 290
 291
 292     switch (Op->Common.AmlOpcode)
 293     {
 294     case AML_SCOPE_OP:
 295     case AML_ELSE_OP:
 296     case AML_DEVICE_OP:
 297     case AML_THERMAL_ZONE_OP:
 298     case AML_INT_METHODCALL_OP:
 299
 300         Child = AcpiPsGetArg (Op, 0);
 301         break;
 302
 303
 304     case AML_BUFFER_OP:
 305     case AML_PACKAGE_OP:
 306     case AML_METHOD_OP:
 307     case AML_IF_OP:
 308     case AML_WHILE_OP:
 309     case AML_FIELD_OP:
 310
 311         Child = AcpiPsGetArg (Op, 1);
 312         break;
 313
 314
 315     case AML_POWER_RES_OP:
 316     case AML_INDEX_FIELD_OP:
 317
 318         Child = AcpiPsGetArg (Op, 2);
 319         break;
 320
 321
 322     case AML_PROCESSOR_OP:
 323     case AML_BANK_FIELD_OP:
 324
 325         Child = AcpiPsGetArg (Op, 3);
 326         break;
 327
 328
 329     default:
 330         /* All others have no children */
 331         break;
 332     }
 333
 334     return (Child);
 335 }
 336
 337
 338 /*******************************************************************************
 339  *
 340  * FUNCTION:    AcpiPsGetDepthNext
 341  *
 342  * PARAMETERS:  Origin          - Root of subtree to search
 343  *              Op              - Last (previous) Op that was found
 344  *
 345  * RETURN:      Next Op found in the search.
 346  *
 347  * DESCRIPTION: Get next op in tree (walking the tree in depth-first order)
 348  *              Return NULL when reaching "origin" or when walking up from root
 349  *
 350  ******************************************************************************/
 351
 352 ACPI_PARSE_OBJECT *
 353 AcpiPsGetDepthNext (
 354     ACPI_PARSE_OBJECT       *Origin,
 355     ACPI_PARSE_OBJECT       *Op)
 356 {
 357     ACPI_PARSE_OBJECT       *Next = NULL;
 358     ACPI_PARSE_OBJECT       *Parent;
 359     ACPI_PARSE_OBJECT       *Arg;
 360
 361
 362     ACPI_FUNCTION_ENTRY ();
 363
 364
 365     if (!Op)
 366     {
 367         return (NULL);
 368     }
 369
 370     /* look for an argument or child */
 371
 372     Next = AcpiPsGetArg (Op, 0);
 373     if (Next)
 374     {
 375         return (Next);
 376     }
 377
 378     /* look for a sibling */
 379
 380     Next = Op->Common.Next;
 381     if (Next)
 382     {
 383         return (Next);
 384     }
 385
 386     /* look for a sibling of parent */
 387
 388     Parent = Op->Common.Parent;
 389
 390     while (Parent)
 391     {
 392         Arg = AcpiPsGetArg (Parent, 0);
 393         while (Arg && (Arg != Origin) && (Arg != Op))
 394         {
 395             Arg = Arg->Common.Next;
 396         }
 397
 398         if (Arg == Origin)
 399         {
 400             /* reached parent of origin, end search */
 401
 402             return (NULL);
 403         }
 404
 405         if (Parent->Common.Next)
 406         {
 407             /* found sibling of parent */
 408
 409             return (Parent->Common.Next);
 410         }
 411
 412         Op = Parent;
 413         Parent = Parent->Common.Parent;
 414     }
 415
 416     return (Next);
 417 }
 418
 419