#include "acpi.h"
#include "accommon.h"
#include "acnamesp.h"
#include "acpredef.h"

Include dependency graph for nspredef.c:

Macros
#define	ACPI_CREATE_PREDEFINED_TABLE

#define	_COMPONENT ACPI_NAMESPACE

Functions
static ACPI_STATUS	AcpiNsCheckReference (ACPI_EVALUATE_INFO Info, ACPI_OPERAND_OBJECT ReturnObject)

static UINT32	AcpiNsGetBitmappedType (ACPI_OPERAND_OBJECT *ReturnObject)

ACPI_STATUS	AcpiNsCheckReturnValue (ACPI_NAMESPACE_NODE Node, ACPI_EVALUATE_INFO Info, UINT32 UserParamCount, ACPI_STATUS ReturnStatus, ACPI_OPERAND_OBJECT **ReturnObjectPtr)

ACPI_STATUS	AcpiNsCheckObjectType (ACPI_EVALUATE_INFO Info, ACPI_OPERAND_OBJECT *ReturnObjectPtr, UINT32 ExpectedBtypes, UINT32 PackageIndex)

Macro Definition Documentation

◆ _COMPONENT

#define _COMPONENT ACPI_NAMESPACE

Definition at line 52 of file nspredef.c.

◆ ACPI_CREATE_PREDEFINED_TABLE

#define ACPI_CREATE_PREDEFINED_TABLE

Definition at line 44 of file nspredef.c.

Function Documentation

◆ AcpiNsCheckObjectType()

ACPI_STATUS AcpiNsCheckObjectType	(	ACPI_EVALUATE_INFO *	Info,
		ACPI_OPERAND_OBJECT **	ReturnObjectPtr,
		UINT32	ExpectedBtypes,
		UINT32	PackageIndex
	)

Definition at line 245 of file nspredef.c.

{
    ACPI_OPERAND_OBJECT         *ReturnObject = *ReturnObjectPtr;
    ACPI_STATUS                 Status = AE_OK;
    char                        TypeBuffer[96]; /* Room for 10 types */
 
 
    /* A Namespace node should not get here, but make sure */
 
    if (ReturnObject &&
        ACPI_GET_DESCRIPTOR_TYPE (ReturnObject) == ACPI_DESC_TYPE_NAMED)
    {
        ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
            "Invalid return type - Found a Namespace node [%4.4s] type %s",
            ReturnObject->Node.Name.Ascii,
            AcpiUtGetTypeName (ReturnObject->Node.Type)));
        return (AE_AML_OPERAND_TYPE);
    }
 
    /*
     * Convert the object type (ACPI_TYPE_xxx) to a bitmapped object type.
     * The bitmapped type allows multiple possible return types.
     *
     * Note, the cases below must handle all of the possible types returned
     * from all of the predefined names (including elements of returned
     * packages)
     */
    Info->ReturnBtype = AcpiNsGetBitmappedType (ReturnObject);
    if (Info->ReturnBtype == ACPI_RTYPE_ANY)
    {
        /* Not one of the supported objects, must be incorrect */
        goto TypeErrorExit;
    }
 
    /* For reference objects, check that the reference type is correct */
 
    if ((Info->ReturnBtype & ExpectedBtypes) == ACPI_RTYPE_REFERENCE)
    {
        Status = AcpiNsCheckReference (Info, ReturnObject);
        return (Status);
    }
 
    /* Attempt simple repair of the returned object if necessary */
 
    Status = AcpiNsSimpleRepair (Info, ExpectedBtypes,
        PackageIndex, ReturnObjectPtr);
    if (ACPI_SUCCESS (Status))
    {
        return (AE_OK); /* Successful repair */
    }
 
 
TypeErrorExit:
 
    /* Create a string with all expected types for this predefined object */
 
    AcpiUtGetExpectedReturnTypes (TypeBuffer, ExpectedBtypes);
 
    if (!ReturnObject)
    {
        ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
            "Expected return object of type %s",
            TypeBuffer));
    }
    else if (PackageIndex == ACPI_NOT_PACKAGE_ELEMENT)
    {
        ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
            "Return type mismatch - found %s, expected %s",
            AcpiUtGetObjectTypeName (ReturnObject), TypeBuffer));
    }
    else
    {
        ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
            "Return Package type mismatch at index %u - "
            "found %s, expected %s", PackageIndex,
            AcpiUtGetObjectTypeName (ReturnObject), TypeBuffer));
    }
 
    return (AE_AML_OPERAND_TYPE);
}

Referenced by AcpiNsCheckPackage(), AcpiNsCheckPackageElements(), AcpiNsCheckPackageList(), and AcpiNsCheckReturnValue().

◆ AcpiNsCheckReference()

static ACPI_STATUS AcpiNsCheckReference	(	ACPI_EVALUATE_INFO *	Info,
		ACPI_OPERAND_OBJECT *	ReturnObject
	)

static

Definition at line 348 of file nspredef.c.

{
 
    /*
     * Check the reference object for the correct reference type (opcode).
     * The only type of reference that can be converted to an ACPI_OBJECT is
     * a reference to a named object (reference class: NAME)
     */
    if (ReturnObject->Reference.Class == ACPI_REFCLASS_NAME)
    {
        return (AE_OK);
    }
 
    ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
        "Return type mismatch - unexpected reference object type [%s] %2.2X",
        AcpiUtGetReferenceName (ReturnObject),
        ReturnObject->Reference.Class));
 
    return (AE_AML_OPERAND_TYPE);
}

Referenced by AcpiNsCheckObjectType().

◆ AcpiNsCheckReturnValue()

ACPI_STATUS AcpiNsCheckReturnValue	(	ACPI_NAMESPACE_NODE *	Node,
		ACPI_EVALUATE_INFO *	Info,
		UINT32	UserParamCount,
		ACPI_STATUS	ReturnStatus,
		ACPI_OPERAND_OBJECT **	ReturnObjectPtr
	)

Definition at line 108 of file nspredef.c.

{
    ACPI_STATUS                 Status;
    const ACPI_PREDEFINED_INFO  *Predefined;
 
    ACPI_FUNCTION_TRACE (NsCheckReturnValue);
 
    /* If not a predefined name, we cannot validate the return object */
 
    Predefined = Info->Predefined;
    if (!Predefined)
    {
        return_ACPI_STATUS (AE_OK);
    }
 
    /*
     * If the method failed or did not actually return an object, we cannot
     * validate the return object
     */
    if ((ReturnStatus != AE_OK) &&
        (ReturnStatus != AE_CTRL_RETURN_VALUE))
    {
        return_ACPI_STATUS (AE_OK);
    }
 
    /*
     * Return value validation and possible repair.
     *
     * 1) Don't perform return value validation/repair if this feature
     * has been disabled via a global option.
     *
     * 2) We have a return value, but if one wasn't expected, just exit,
     * this is not a problem. For example, if the "Implicit Return"
     * feature is enabled, methods will always return a value.
     *
     * 3) If the return value can be of any type, then we cannot perform
     * any validation, just exit.
     */
    if (AcpiGbl_DisableAutoRepair ||
        (!Predefined->Info.ExpectedBtypes) ||
        (Predefined->Info.ExpectedBtypes == ACPI_RTYPE_ALL))
    {
        return_ACPI_STATUS (AE_OK);
    }
 
    /*
     * Check that the type of the main return object is what is expected
     * for this predefined name
     */
    Status = AcpiNsCheckObjectType (Info, ReturnObjectPtr,
        Predefined->Info.ExpectedBtypes, ACPI_NOT_PACKAGE_ELEMENT);
    if (ACPI_FAILURE (Status))
    {
        goto Exit;
    }
 
    /*
     *
     * 4) If there is no return value and it is optional, just return
     * AE_OK (_WAK).
     */
    if (!(*ReturnObjectPtr))
    {
        goto Exit;
    }
 
    /*
     * For returned Package objects, check the type of all sub-objects.
     * Note: Package may have been newly created by call above.
     */
    if ((*ReturnObjectPtr)->Common.Type == ACPI_TYPE_PACKAGE)
    {
        Info->ParentPackage = *ReturnObjectPtr;
        Status = AcpiNsCheckPackage (Info, ReturnObjectPtr);
        if (ACPI_FAILURE (Status))
        {
            /* We might be able to fix some errors */
 
            if ((Status != AE_AML_OPERAND_TYPE) &&
                (Status != AE_AML_OPERAND_VALUE))
            {
                goto Exit;
            }
        }
    }
 
    /*
     * The return object was OK, or it was successfully repaired above.
     * Now make some additional checks such as verifying that package
     * objects are sorted correctly (if required) or buffer objects have
     * the correct data width (bytes vs. dwords). These repairs are
     * performed on a per-name basis, i.e., the code is specific to
     * particular predefined names.
     */
    Status = AcpiNsComplexRepairs (Info, Node, Status, ReturnObjectPtr);
 
Exit:
    /*
     * If the object validation failed or if we successfully repaired one
     * or more objects, mark the parent node to suppress further warning
     * messages during the next evaluation of the same method/object.
     */
    if (ACPI_FAILURE (Status) ||
       (Info->ReturnFlags & ACPI_OBJECT_REPAIRED))
    {
        Node->Flags |= ANOBJ_EVALUATED;
    }
 
    return_ACPI_STATUS (Status);
}

Referenced by AcpiNsEvaluate().

◆ AcpiNsGetBitmappedType()

static UINT32 AcpiNsGetBitmappedType ( ACPI_OPERAND_OBJECT * ReturnObject )