drivers/acpica/pstree.c

0001 /******************************************************************************
0002  *
0003  * Module Name: pstree - Parser op tree manipulation/traversal/search
0004  *
0005  *****************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights.  You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code.  No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision.  In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change.  Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee.  Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution.  In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government.  In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************/
0115
0116
0117 #define __PSTREE_C__
0118
0119 #include "acpi.h"
0120 #include "accommon.h"
0121 #include "acparser.h"
0122 #include "amlcode.h"
0123
0124 #define _COMPONENT          ACPI_PARSER
0125         ACPI_MODULE_NAME    ("pstree")
0126
0127 /* Local prototypes */
0128
0129 #ifdef ACPI_OBSOLETE_FUNCTIONS
0130 ACPI_PARSE_OBJECT *
0131 AcpiPsGetChild (
0132     ACPI_PARSE_OBJECT       *op);
0133 #endif
0134
0135
0136 /*******************************************************************************
0137  *
0138  * FUNCTION:    AcpiPsGetArg
0139  *
0140  * PARAMETERS:  Op              - Get an argument for this op
0141  *              Argn            - Nth argument to get
0142  *
0143  * RETURN:      The argument (as an Op object). NULL if argument does not exist
0144  *
0145  * DESCRIPTION: Get the specified op's argument.
0146  *
0147  ******************************************************************************/
0148
0149 ACPI_PARSE_OBJECT *
0150 AcpiPsGetArg (
0151     ACPI_PARSE_OBJECT       *Op,
0152     UINT32                  Argn)
0153 {
0154     ACPI_PARSE_OBJECT       *Arg = NULL;
0155     const ACPI_OPCODE_INFO  *OpInfo;
0156
0157
0158     ACPI_FUNCTION_ENTRY ();
0159
0160
0161     /* Get the info structure for this opcode */
0162
0163     OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
0164     if (OpInfo->Class == AML_CLASS_UNKNOWN)
0165     {
0166         /* Invalid opcode or ASCII character */
0167
0168         return (NULL);
0169     }
0170
0171     /* Check if this opcode requires argument sub-objects */
0172
0173     if (!(OpInfo->Flags & AML_HAS_ARGS))
0174     {
0175         /* Has no linked argument objects */
0176
0177         return (NULL);
0178     }
0179
0180     /* Get the requested argument object */
0181
0182     Arg = Op->Common.Value.Arg;
0183     while (Arg && Argn)
0184     {
0185         Argn--;
0186         Arg = Arg->Common.Next;
0187     }
0188
0189     return (Arg);
0190 }
0191
0192
0193 /*******************************************************************************
0194  *
0195  * FUNCTION:    AcpiPsAppendArg
0196  *
0197  * PARAMETERS:  Op              - Append an argument to this Op.
0198  *              Arg             - Argument Op to append
0199  *
0200  * RETURN:      None.
0201  *
0202  * DESCRIPTION: Append an argument to an op's argument list (a NULL arg is OK)
0203  *
0204  ******************************************************************************/
0205
0206 void
0207 AcpiPsAppendArg (
0208     ACPI_PARSE_OBJECT       *Op,
0209     ACPI_PARSE_OBJECT       *Arg)
0210 {
0211     ACPI_PARSE_OBJECT       *PrevArg;
0212     const ACPI_OPCODE_INFO  *OpInfo;
0213
0214
0215     ACPI_FUNCTION_ENTRY ();
0216
0217
0218     if (!Op)
0219     {
0220         return;
0221     }
0222
0223     /* Get the info structure for this opcode */
0224
0225     OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
0226     if (OpInfo->Class == AML_CLASS_UNKNOWN)
0227     {
0228         /* Invalid opcode */
0229
0230         ACPI_ERROR ((AE_INFO, "Invalid AML Opcode: 0x%2.2X",
0231             Op->Common.AmlOpcode));
0232         return;
0233     }
0234
0235     /* Check if this opcode requires argument sub-objects */
0236
0237     if (!(OpInfo->Flags & AML_HAS_ARGS))
0238     {
0239         /* Has no linked argument objects */
0240
0241         return;
0242     }
0243
0244     /* Append the argument to the linked argument list */
0245
0246     if (Op->Common.Value.Arg)
0247     {
0248         /* Append to existing argument list */
0249
0250         PrevArg = Op->Common.Value.Arg;
0251         while (PrevArg->Common.Next)
0252         {
0253             PrevArg = PrevArg->Common.Next;
0254         }
0255         PrevArg->Common.Next = Arg;
0256     }
0257     else
0258     {
0259         /* No argument list, this will be the first argument */
0260
0261         Op->Common.Value.Arg = Arg;
0262     }
0263
0264     /* Set the parent in this arg and any args linked after it */
0265
0266     while (Arg)
0267     {
0268         Arg->Common.Parent = Op;
0269         Arg = Arg->Common.Next;
0270
0271         Op->Common.ArgListLength++;
0272     }
0273 }
0274
0275
0276 /*******************************************************************************
0277  *
0278  * FUNCTION:    AcpiPsGetDepthNext
0279  *
0280  * PARAMETERS:  Origin          - Root of subtree to search
0281  *              Op              - Last (previous) Op that was found
0282  *
0283  * RETURN:      Next Op found in the search.
0284  *
0285  * DESCRIPTION: Get next op in tree (walking the tree in depth-first order)
0286  *              Return NULL when reaching "origin" or when walking up from root
0287  *
0288  ******************************************************************************/
0289
0290 ACPI_PARSE_OBJECT *
0291 AcpiPsGetDepthNext (
0292     ACPI_PARSE_OBJECT       *Origin,
0293     ACPI_PARSE_OBJECT       *Op)
0294 {
0295     ACPI_PARSE_OBJECT       *Next = NULL;
0296     ACPI_PARSE_OBJECT       *Parent;
0297     ACPI_PARSE_OBJECT       *Arg;
0298
0299
0300     ACPI_FUNCTION_ENTRY ();
0301
0302
0303     if (!Op)
0304     {
0305         return (NULL);
0306     }
0307
0308     /* Look for an argument or child */
0309
0310     Next = AcpiPsGetArg (Op, 0);
0311     if (Next)
0312     {
0313         return (Next);
0314     }
0315
0316     /* Look for a sibling */
0317
0318     Next = Op->Common.Next;
0319     if (Next)
0320     {
0321         return (Next);
0322     }
0323
0324     /* Look for a sibling of parent */
0325
0326     Parent = Op->Common.Parent;
0327
0328     while (Parent)
0329     {
0330         Arg = AcpiPsGetArg (Parent, 0);
0331         while (Arg && (Arg != Origin) && (Arg != Op))
0332         {
0333             Arg = Arg->Common.Next;
0334         }
0335
0336         if (Arg == Origin)
0337         {
0338             /* Reached parent of origin, end search */
0339
0340             return (NULL);
0341         }
0342
0343         if (Parent->Common.Next)
0344         {
0345             /* Found sibling of parent */
0346
0347             return (Parent->Common.Next);
0348         }
0349
0350         Op = Parent;
0351         Parent = Parent->Common.Parent;
0352     }
0353
0354     return (Next);
0355 }
0356
0357
0358 #ifdef ACPI_OBSOLETE_FUNCTIONS
0359 /*******************************************************************************
0360  *
0361  * FUNCTION:    AcpiPsGetChild
0362  *
0363  * PARAMETERS:  Op              - Get the child of this Op
0364  *
0365  * RETURN:      Child Op, Null if none is found.
0366  *
0367  * DESCRIPTION: Get op's children or NULL if none
0368  *
0369  ******************************************************************************/
0370
0371 ACPI_PARSE_OBJECT *
0372 AcpiPsGetChild (
0373     ACPI_PARSE_OBJECT       *Op)
0374 {
0375     ACPI_PARSE_OBJECT       *Child = NULL;
0376
0377
0378     ACPI_FUNCTION_ENTRY ();
0379
0380
0381     switch (Op->Common.AmlOpcode)
0382     {
0383     case AML_SCOPE_OP:
0384     case AML_ELSE_OP:
0385     case AML_DEVICE_OP:
0386     case AML_THERMAL_ZONE_OP:
0387     case AML_INT_METHODCALL_OP:
0388
0389         Child = AcpiPsGetArg (Op, 0);
0390         break;
0391
0392
0393     case AML_BUFFER_OP:
0394     case AML_PACKAGE_OP:
0395     case AML_METHOD_OP:
0396     case AML_IF_OP:
0397     case AML_WHILE_OP:
0398     case AML_FIELD_OP:
0399
0400         Child = AcpiPsGetArg (Op, 1);
0401         break;
0402
0403
0404     case AML_POWER_RES_OP:
0405     case AML_INDEX_FIELD_OP:
0406
0407         Child = AcpiPsGetArg (Op, 2);
0408         break;
0409
0410
0411     case AML_PROCESSOR_OP:
0412     case AML_BANK_FIELD_OP:
0413
0414         Child = AcpiPsGetArg (Op, 3);
0415         break;
0416
0417
0418     default:
0419         /* All others have no children */
0420         break;
0421     }
0422
0423     return (Child);
0424 }
0425 #endif
0426
0427