acpica/parser/psutils.c

db2bae30SDana Myers/******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * Module Name: psutils - Parser miscellaneous utilities (Parser only)
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    ("psutils")
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsCreateScopeOp
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  None
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      A new Scope object, null on failure
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Create a Scope and associated namepath op with the root name
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_PARSE_OBJECT *
db2bae30SDana MyersAcpiPsCreateScopeOp (
*385cc6b4SJerry Jelinek    UINT8                   *Aml)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *ScopeOp;
db2bae30SDana Myers
db2bae30SDana Myers
*385cc6b4SJerry Jelinek    ScopeOp = AcpiPsAllocOp (AML_SCOPE_OP, Aml);
db2bae30SDana Myers    if (!ScopeOp)
db2bae30SDana Myers    {
db2bae30SDana Myers        return (NULL);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    ScopeOp->Named.Name = ACPI_ROOT_NAME;
db2bae30SDana Myers    return (ScopeOp);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsInitOp
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Op              - A newly allocated Op object
db2bae30SDana Myers *              Opcode          - Opcode to store in the Op
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      None
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Initialize a parse (Op) object
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersvoid
db2bae30SDana MyersAcpiPsInitOp (
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Op,
db2bae30SDana Myers    UINT16                  Opcode)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_FUNCTION_ENTRY ();
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    Op->Common.DescriptorType = ACPI_DESC_TYPE_PARSER;
db2bae30SDana Myers    Op->Common.AmlOpcode = Opcode;
db2bae30SDana Myers
*385cc6b4SJerry Jelinek    ACPI_DISASM_ONLY_MEMBERS (strncpy (Op->Common.AmlOpName,
db2bae30SDana Myers        (AcpiPsGetOpcodeInfo (Opcode))->Name,
db2bae30SDana Myers        sizeof (Op->Common.AmlOpName)));
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsAllocOp
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Opcode          - Opcode that will be stored in the new Op
*385cc6b4SJerry Jelinek *              Aml             - Address of the opcode
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Pointer to the new Op, null on failure
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Allocate an acpi_op, choose op type (and thus size) based on
db2bae30SDana Myers *              opcode. A cache of opcodes is available for the pure
db2bae30SDana Myers *              GENERIC_OP, since this is by far the most commonly used.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_PARSE_OBJECT*
db2bae30SDana MyersAcpiPsAllocOp (
*385cc6b4SJerry Jelinek    UINT16                  Opcode,
*385cc6b4SJerry Jelinek    UINT8                   *Aml)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Op;
db2bae30SDana Myers    const ACPI_OPCODE_INFO  *OpInfo;
db2bae30SDana Myers    UINT8                   Flags = ACPI_PARSEOP_GENERIC;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_ENTRY ();
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    OpInfo = AcpiPsGetOpcodeInfo (Opcode);
db2bae30SDana Myers
db2bae30SDana Myers    /* Determine type of ParseOp required */
db2bae30SDana Myers
db2bae30SDana Myers    if (OpInfo->Flags & AML_DEFER)
db2bae30SDana Myers    {
db2bae30SDana Myers        Flags = ACPI_PARSEOP_DEFERRED;
db2bae30SDana Myers    }
db2bae30SDana Myers    else if (OpInfo->Flags & AML_NAMED)
db2bae30SDana Myers    {
*385cc6b4SJerry Jelinek        Flags = ACPI_PARSEOP_NAMED_OBJECT;
db2bae30SDana Myers    }
db2bae30SDana Myers    else if (Opcode == AML_INT_BYTELIST_OP)
db2bae30SDana Myers    {
db2bae30SDana Myers        Flags = ACPI_PARSEOP_BYTELIST;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Allocate the minimum required size object */
db2bae30SDana Myers
db2bae30SDana Myers    if (Flags == ACPI_PARSEOP_GENERIC)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* The generic op (default) is by far the most common (16 to 1) */
db2bae30SDana Myers
db2bae30SDana Myers        Op = AcpiOsAcquireObject (AcpiGbl_PsNodeCache);
db2bae30SDana Myers    }
db2bae30SDana Myers    else
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Extended parseop */
db2bae30SDana Myers
db2bae30SDana Myers        Op = AcpiOsAcquireObject (AcpiGbl_PsNodeExtCache);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Initialize the Op */
db2bae30SDana Myers
db2bae30SDana Myers    if (Op)
db2bae30SDana Myers    {
db2bae30SDana Myers        AcpiPsInitOp (Op, Opcode);
*385cc6b4SJerry Jelinek        Op->Common.Aml = Aml;
db2bae30SDana Myers        Op->Common.Flags = Flags;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return (Op);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsFreeOp
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Op              - Op to be freed
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      None.
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Free an Op object. Either put it on the GENERIC_OP cache list
db2bae30SDana Myers *              or actually free it.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersvoid
db2bae30SDana MyersAcpiPsFreeOp (
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Op)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_FUNCTION_NAME (PsFreeOp);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    if (Op->Common.AmlOpcode == AML_INT_RETURN_VALUE_OP)
db2bae30SDana Myers    {
*385cc6b4SJerry Jelinek        ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS,
*385cc6b4SJerry Jelinek            "Free retval op: %p\n", Op));
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
db2bae30SDana Myers    {
db2bae30SDana Myers        (void) AcpiOsReleaseObject (AcpiGbl_PsNodeCache, Op);
db2bae30SDana Myers    }
db2bae30SDana Myers    else
db2bae30SDana Myers    {
db2bae30SDana Myers        (void) AcpiOsReleaseObject (AcpiGbl_PsNodeExtCache, Op);
db2bae30SDana Myers    }
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    Utility functions
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Low level character and object functions
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*
db2bae30SDana Myers * Is "c" a namestring lead character?
db2bae30SDana Myers */
db2bae30SDana MyersBOOLEAN
db2bae30SDana MyersAcpiPsIsLeadingChar (
db2bae30SDana Myers    UINT32                  c)
db2bae30SDana Myers{
db2bae30SDana Myers    return ((BOOLEAN) (c == '_' || (c >= 'A' && c <= 'Z')));
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*
db2bae30SDana Myers * Get op's name (4-byte name segment) or 0 if unnamed
db2bae30SDana Myers */
db2bae30SDana MyersUINT32
db2bae30SDana MyersAcpiPsGetName (
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Op)
db2bae30SDana Myers{
db2bae30SDana Myers
db2bae30SDana Myers    /* The "generic" object has no name associated with it */
db2bae30SDana Myers
db2bae30SDana Myers    if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
db2bae30SDana Myers    {
db2bae30SDana Myers        return (0);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Only the "Extended" parse objects have a name */
db2bae30SDana Myers
db2bae30SDana Myers    return (Op->Named.Name);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*
db2bae30SDana Myers * Set op's name
db2bae30SDana Myers */
db2bae30SDana Myersvoid
db2bae30SDana MyersAcpiPsSetName (
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Op,
db2bae30SDana Myers    UINT32                  name)
db2bae30SDana Myers{
db2bae30SDana Myers
db2bae30SDana Myers    /* The "generic" object has no name associated with it */
db2bae30SDana Myers
db2bae30SDana Myers    if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
db2bae30SDana Myers    {
db2bae30SDana Myers        return;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    Op->Named.Name = name;
db2bae30SDana Myers}