acpica/parser/pstree.c

db2bae30SDana Myers/******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * Module Name: pstree - Parser op tree manipulation/traversal/search
db2bae30SDana Myers *
db2bae30SDana Myers *****************************************************************************/
db2bae30SDana Myers
26f3cdf0SGordon Ross/*
*385cc6b4SJerry Jelinek * Copyright (C) 2000 - 2016, Intel Corp.
db2bae30SDana Myers * All rights reserved.
db2bae30SDana Myers *
26f3cdf0SGordon Ross * Redistribution and use in source and binary forms, with or without
26f3cdf0SGordon Ross * modification, are permitted provided that the following conditions
26f3cdf0SGordon Ross * are met:
26f3cdf0SGordon Ross * 1. Redistributions of source code must retain the above copyright
26f3cdf0SGordon Ross *    notice, this list of conditions, and the following disclaimer,
26f3cdf0SGordon Ross *    without modification.
26f3cdf0SGordon Ross * 2. Redistributions in binary form must reproduce at minimum a disclaimer
26f3cdf0SGordon Ross *    substantially similar to the "NO WARRANTY" disclaimer below
26f3cdf0SGordon Ross *    ("Disclaimer") and any redistribution must be conditioned upon
26f3cdf0SGordon Ross *    including a substantially similar Disclaimer requirement for further
26f3cdf0SGordon Ross *    binary redistribution.
26f3cdf0SGordon Ross * 3. Neither the names of the above-listed copyright holders nor the names
26f3cdf0SGordon Ross *    of any contributors may be used to endorse or promote products derived
26f3cdf0SGordon Ross *    from this software without specific prior written permission.
db2bae30SDana Myers *
26f3cdf0SGordon Ross * Alternatively, this software may be distributed under the terms of the
26f3cdf0SGordon Ross * GNU General Public License ("GPL") version 2 as published by the Free
26f3cdf0SGordon Ross * Software Foundation.
db2bae30SDana Myers *
26f3cdf0SGordon Ross * NO WARRANTY
26f3cdf0SGordon Ross * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26f3cdf0SGordon Ross * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26f3cdf0SGordon Ross * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
26f3cdf0SGordon Ross * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26f3cdf0SGordon Ross * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26f3cdf0SGordon Ross * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26f3cdf0SGordon Ross * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26f3cdf0SGordon Ross * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26f3cdf0SGordon Ross * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
26f3cdf0SGordon Ross * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26f3cdf0SGordon Ross * POSSIBILITY OF SUCH DAMAGES.
26f3cdf0SGordon Ross */
db2bae30SDana Myers
db2bae30SDana Myers#include "acpi.h"
aa2aa9a6SDana Myers#include "accommon.h"
db2bae30SDana Myers#include "acparser.h"
db2bae30SDana Myers#include "amlcode.h"
db2bae30SDana Myers
db2bae30SDana Myers#define _COMPONENT          ACPI_PARSER
db2bae30SDana Myers        ACPI_MODULE_NAME    ("pstree")
db2bae30SDana Myers
db2bae30SDana Myers/* Local prototypes */
db2bae30SDana Myers
db2bae30SDana Myers#ifdef ACPI_OBSOLETE_FUNCTIONS
db2bae30SDana MyersACPI_PARSE_OBJECT *
db2bae30SDana MyersAcpiPsGetChild (
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *op);
db2bae30SDana Myers#endif
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsGetArg
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Op              - Get an argument for this op
db2bae30SDana Myers *              Argn            - Nth argument to get
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      The argument (as an Op object). NULL if argument does not exist
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Get the specified op's argument.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_PARSE_OBJECT *
db2bae30SDana MyersAcpiPsGetArg (
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Op,
db2bae30SDana Myers    UINT32                  Argn)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Arg = NULL;
db2bae30SDana Myers    const ACPI_OPCODE_INFO  *OpInfo;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_ENTRY ();
db2bae30SDana Myers
*385cc6b4SJerry Jelinek/*
*385cc6b4SJerry Jelinek    if (Op->Common.AmlOpcode == AML_INT_CONNECTION_OP)
*385cc6b4SJerry Jelinek    {
*385cc6b4SJerry Jelinek        return (Op->Common.Value.Arg);
*385cc6b4SJerry Jelinek    }
*385cc6b4SJerry Jelinek*/
db2bae30SDana Myers    /* Get the info structure for this opcode */
db2bae30SDana Myers
db2bae30SDana Myers    OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
db2bae30SDana Myers    if (OpInfo->Class == AML_CLASS_UNKNOWN)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Invalid opcode or ASCII character */
db2bae30SDana Myers
db2bae30SDana Myers        return (NULL);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Check if this opcode requires argument sub-objects */
db2bae30SDana Myers
db2bae30SDana Myers    if (!(OpInfo->Flags & AML_HAS_ARGS))
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Has no linked argument objects */
db2bae30SDana Myers
db2bae30SDana Myers        return (NULL);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Get the requested argument object */
db2bae30SDana Myers
db2bae30SDana Myers    Arg = Op->Common.Value.Arg;
db2bae30SDana Myers    while (Arg && Argn)
db2bae30SDana Myers    {
db2bae30SDana Myers        Argn--;
db2bae30SDana Myers        Arg = Arg->Common.Next;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return (Arg);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsAppendArg
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Op              - Append an argument to this Op.
db2bae30SDana Myers *              Arg             - Argument Op to append
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      None.
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Append an argument to an op's argument list (a NULL arg is OK)
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersvoid
db2bae30SDana MyersAcpiPsAppendArg (
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Op,
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Arg)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *PrevArg;
db2bae30SDana Myers    const ACPI_OPCODE_INFO  *OpInfo;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_ENTRY ();
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    if (!Op)
db2bae30SDana Myers    {
db2bae30SDana Myers        return;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Get the info structure for this opcode */
db2bae30SDana Myers
db2bae30SDana Myers    OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
db2bae30SDana Myers    if (OpInfo->Class == AML_CLASS_UNKNOWN)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Invalid opcode */
db2bae30SDana Myers
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO, "Invalid AML Opcode: 0x%2.2X",
db2bae30SDana Myers            Op->Common.AmlOpcode));
db2bae30SDana Myers        return;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Check if this opcode requires argument sub-objects */
db2bae30SDana Myers
db2bae30SDana Myers    if (!(OpInfo->Flags & AML_HAS_ARGS))
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Has no linked argument objects */
db2bae30SDana Myers
db2bae30SDana Myers        return;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Append the argument to the linked argument list */
db2bae30SDana Myers
db2bae30SDana Myers    if (Op->Common.Value.Arg)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Append to existing argument list */
db2bae30SDana Myers
db2bae30SDana Myers        PrevArg = Op->Common.Value.Arg;
db2bae30SDana Myers        while (PrevArg->Common.Next)
db2bae30SDana Myers        {
db2bae30SDana Myers            PrevArg = PrevArg->Common.Next;
db2bae30SDana Myers        }
db2bae30SDana Myers        PrevArg->Common.Next = Arg;
db2bae30SDana Myers    }
db2bae30SDana Myers    else
db2bae30SDana Myers    {
db2bae30SDana Myers        /* No argument list, this will be the first argument */
db2bae30SDana Myers
db2bae30SDana Myers        Op->Common.Value.Arg = Arg;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Set the parent in this arg and any args linked after it */
db2bae30SDana Myers
db2bae30SDana Myers    while (Arg)
db2bae30SDana Myers    {
db2bae30SDana Myers        Arg->Common.Parent = Op;
db2bae30SDana Myers        Arg = Arg->Common.Next;
db2bae30SDana Myers
db2bae30SDana Myers        Op->Common.ArgListLength++;
db2bae30SDana Myers    }
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsGetDepthNext
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Origin          - Root of subtree to search
db2bae30SDana Myers *              Op              - Last (previous) Op that was found
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Next Op found in the search.
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Get next op in tree (walking the tree in depth-first order)
db2bae30SDana Myers *              Return NULL when reaching "origin" or when walking up from root
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_PARSE_OBJECT *
db2bae30SDana MyersAcpiPsGetDepthNext (
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Origin,
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Op)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Next = NULL;
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Parent;
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Arg;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_ENTRY ();
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    if (!Op)
db2bae30SDana Myers    {
db2bae30SDana Myers        return (NULL);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Look for an argument or child */
db2bae30SDana Myers
db2bae30SDana Myers    Next = AcpiPsGetArg (Op, 0);
db2bae30SDana Myers    if (Next)
db2bae30SDana Myers    {
db2bae30SDana Myers        return (Next);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Look for a sibling */
db2bae30SDana Myers
db2bae30SDana Myers    Next = Op->Common.Next;
db2bae30SDana Myers    if (Next)
db2bae30SDana Myers    {
db2bae30SDana Myers        return (Next);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Look for a sibling of parent */
db2bae30SDana Myers
db2bae30SDana Myers    Parent = Op->Common.Parent;
db2bae30SDana Myers
db2bae30SDana Myers    while (Parent)
db2bae30SDana Myers    {
db2bae30SDana Myers        Arg = AcpiPsGetArg (Parent, 0);
db2bae30SDana Myers        while (Arg && (Arg != Origin) && (Arg != Op))
db2bae30SDana Myers        {
db2bae30SDana Myers            Arg = Arg->Common.Next;
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        if (Arg == Origin)
db2bae30SDana Myers        {
db2bae30SDana Myers            /* Reached parent of origin, end search */
db2bae30SDana Myers
db2bae30SDana Myers            return (NULL);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        if (Parent->Common.Next)
db2bae30SDana Myers        {
db2bae30SDana Myers            /* Found sibling of parent */
db2bae30SDana Myers
db2bae30SDana Myers            return (Parent->Common.Next);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        Op = Parent;
db2bae30SDana Myers        Parent = Parent->Common.Parent;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return (Next);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers#ifdef ACPI_OBSOLETE_FUNCTIONS
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsGetChild
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Op              - Get the child of this Op
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Child Op, Null if none is found.
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Get op's children or NULL if none
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_PARSE_OBJECT *
db2bae30SDana MyersAcpiPsGetChild (
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Op)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Child = NULL;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_ENTRY ();
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    switch (Op->Common.AmlOpcode)
db2bae30SDana Myers    {
db2bae30SDana Myers    case AML_SCOPE_OP:
db2bae30SDana Myers    case AML_ELSE_OP:
db2bae30SDana Myers    case AML_DEVICE_OP:
db2bae30SDana Myers    case AML_THERMAL_ZONE_OP:
db2bae30SDana Myers    case AML_INT_METHODCALL_OP:
db2bae30SDana Myers
db2bae30SDana Myers        Child = AcpiPsGetArg (Op, 0);
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case AML_BUFFER_OP:
db2bae30SDana Myers    case AML_PACKAGE_OP:
db2bae30SDana Myers    case AML_METHOD_OP:
db2bae30SDana Myers    case AML_IF_OP:
db2bae30SDana Myers    case AML_WHILE_OP:
db2bae30SDana Myers    case AML_FIELD_OP:
db2bae30SDana Myers
db2bae30SDana Myers        Child = AcpiPsGetArg (Op, 1);
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case AML_POWER_RES_OP:
db2bae30SDana Myers    case AML_INDEX_FIELD_OP:
db2bae30SDana Myers
db2bae30SDana Myers        Child = AcpiPsGetArg (Op, 2);
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case AML_PROCESSOR_OP:
db2bae30SDana Myers    case AML_BANK_FIELD_OP:
db2bae30SDana Myers
db2bae30SDana Myers        Child = AcpiPsGetArg (Op, 3);
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    default:
*385cc6b4SJerry Jelinek
db2bae30SDana Myers        /* All others have no children */
*385cc6b4SJerry Jelinek
db2bae30SDana Myers        break;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return (Child);
db2bae30SDana Myers}
db2bae30SDana Myers#endif