sys/contrib/dev/acpica/executer/exresnte.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: exresnte - AML Interpreter object resolution
   5  *
   6  *****************************************************************************/
   7
   8 /*
   9  * Copyright (C) 2000 - 2011, Intel Corp.
  10  * All rights reserved.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions, and the following disclaimer,
  17  *    without modification.
  18  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  19  *    substantially similar to the "NO WARRANTY" disclaimer below
  20  *    ("Disclaimer") and any redistribution must be conditioned upon
  21  *    including a substantially similar Disclaimer requirement for further
  22  *    binary redistribution.
  23  * 3. Neither the names of the above-listed copyright holders nor the names
  24  *    of any contributors may be used to endorse or promote products derived
  25  *    from this software without specific prior written permission.
  26  *
  27  * Alternatively, this software may be distributed under the terms of the
  28  * GNU General Public License ("GPL") version 2 as published by the Free
  29  * Software Foundation.
  30  *
  31  * NO WARRANTY
  32  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  33  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  34  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  35  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  36  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  37  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  38  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  39  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  40  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  41  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  42  * POSSIBILITY OF SUCH DAMAGES.
  43  */
  44
  45 #define __EXRESNTE_C__
  46
  47 #include <contrib/dev/acpica/include/acpi.h>
  48 #include <contrib/dev/acpica/include/accommon.h>
  49 #include <contrib/dev/acpica/include/acdispat.h>
  50 #include <contrib/dev/acpica/include/acinterp.h>
  51 #include <contrib/dev/acpica/include/acnamesp.h>
  52
  53
  54 #define _COMPONENT          ACPI_EXECUTER
  55         ACPI_MODULE_NAME    ("exresnte")
  56
  57
  58 /*******************************************************************************
  59  *
  60  * FUNCTION:    AcpiExResolveNodeToValue
  61  *
  62  * PARAMETERS:  ObjectPtr       - Pointer to a location that contains
  63  *                                a pointer to a NS node, and will receive a
  64  *                                pointer to the resolved object.
  65  *              WalkState       - Current state.  Valid only if executing AML
  66  *                                code.  NULL if simply resolving an object
  67  *
  68  * RETURN:      Status
  69  *
  70  * DESCRIPTION: Resolve a Namespace node to a valued object
  71  *
  72  * Note: for some of the data types, the pointer attached to the Node
  73  * can be either a pointer to an actual internal object or a pointer into the
  74  * AML stream itself.  These types are currently:
  75  *
  76  *      ACPI_TYPE_INTEGER
  77  *      ACPI_TYPE_STRING
  78  *      ACPI_TYPE_BUFFER
  79  *      ACPI_TYPE_MUTEX
  80  *      ACPI_TYPE_PACKAGE
  81  *
  82  ******************************************************************************/
  83
  84 ACPI_STATUS
  85 AcpiExResolveNodeToValue (
  86     ACPI_NAMESPACE_NODE     **ObjectPtr,
  87     ACPI_WALK_STATE         *WalkState)
  88
  89 {
  90     ACPI_STATUS             Status = AE_OK;
  91     ACPI_OPERAND_OBJECT     *SourceDesc;
  92     ACPI_OPERAND_OBJECT     *ObjDesc = NULL;
  93     ACPI_NAMESPACE_NODE     *Node;
  94     ACPI_OBJECT_TYPE        EntryType;
  95
  96
  97     ACPI_FUNCTION_TRACE (ExResolveNodeToValue);
  98
  99
 100     /*
 101      * The stack pointer points to a ACPI_NAMESPACE_NODE (Node).  Get the
 102      * object that is attached to the Node.
 103      */
 104     Node       = *ObjectPtr;
 105     SourceDesc = AcpiNsGetAttachedObject (Node);
 106     EntryType  = AcpiNsGetType ((ACPI_HANDLE) Node);
 107
 108     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Entry=%p SourceDesc=%p [%s]\n",
 109          Node, SourceDesc, AcpiUtGetTypeName (EntryType)));
 110
 111     if ((EntryType == ACPI_TYPE_LOCAL_ALIAS) ||
 112         (EntryType == ACPI_TYPE_LOCAL_METHOD_ALIAS))
 113     {
 114         /* There is always exactly one level of indirection */
 115
 116         Node       = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Node->Object);
 117         SourceDesc = AcpiNsGetAttachedObject (Node);
 118         EntryType  = AcpiNsGetType ((ACPI_HANDLE) Node);
 119         *ObjectPtr = Node;
 120     }
 121
 122     /*
 123      * Several object types require no further processing:
 124      * 1) Device/Thermal objects don't have a "real" subobject, return the Node
 125      * 2) Method locals and arguments have a pseudo-Node
 126      * 3) 10/2007: Added method type to assist with Package construction.
 127      */
 128     if ((EntryType == ACPI_TYPE_DEVICE)  ||
 129         (EntryType == ACPI_TYPE_THERMAL) ||
 130         (EntryType == ACPI_TYPE_METHOD)  ||
 131         (Node->Flags & (ANOBJ_METHOD_ARG | ANOBJ_METHOD_LOCAL)))
 132     {
 133         return_ACPI_STATUS (AE_OK);
 134     }
 135
 136     if (!SourceDesc)
 137     {
 138         ACPI_ERROR ((AE_INFO, "No object attached to node %p",
 139             Node));
 140         return_ACPI_STATUS (AE_AML_NO_OPERAND);
 141     }
 142
 143     /*
 144      * Action is based on the type of the Node, which indicates the type
 145      * of the attached object or pointer
 146      */
 147     switch (EntryType)
 148     {
 149     case ACPI_TYPE_PACKAGE:
 150
 151         if (SourceDesc->Common.Type != ACPI_TYPE_PACKAGE)
 152         {
 153             ACPI_ERROR ((AE_INFO, "Object not a Package, type %s",
 154                 AcpiUtGetObjectTypeName (SourceDesc)));
 155             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 156         }
 157
 158         Status = AcpiDsGetPackageArguments (SourceDesc);
 159         if (ACPI_SUCCESS (Status))
 160         {
 161             /* Return an additional reference to the object */
 162
 163             ObjDesc = SourceDesc;
 164             AcpiUtAddReference (ObjDesc);
 165         }
 166         break;
 167
 168
 169     case ACPI_TYPE_BUFFER:
 170
 171         if (SourceDesc->Common.Type != ACPI_TYPE_BUFFER)
 172         {
 173             ACPI_ERROR ((AE_INFO, "Object not a Buffer, type %s",
 174                 AcpiUtGetObjectTypeName (SourceDesc)));
 175             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 176         }
 177
 178         Status = AcpiDsGetBufferArguments (SourceDesc);
 179         if (ACPI_SUCCESS (Status))
 180         {
 181             /* Return an additional reference to the object */
 182
 183             ObjDesc = SourceDesc;
 184             AcpiUtAddReference (ObjDesc);
 185         }
 186         break;
 187
 188
 189     case ACPI_TYPE_STRING:
 190
 191         if (SourceDesc->Common.Type != ACPI_TYPE_STRING)
 192         {
 193             ACPI_ERROR ((AE_INFO, "Object not a String, type %s",
 194                 AcpiUtGetObjectTypeName (SourceDesc)));
 195             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 196         }
 197
 198         /* Return an additional reference to the object */
 199
 200         ObjDesc = SourceDesc;
 201         AcpiUtAddReference (ObjDesc);
 202         break;
 203
 204
 205     case ACPI_TYPE_INTEGER:
 206
 207         if (SourceDesc->Common.Type != ACPI_TYPE_INTEGER)
 208         {
 209             ACPI_ERROR ((AE_INFO, "Object not a Integer, type %s",
 210                 AcpiUtGetObjectTypeName (SourceDesc)));
 211             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 212         }
 213
 214         /* Return an additional reference to the object */
 215
 216         ObjDesc = SourceDesc;
 217         AcpiUtAddReference (ObjDesc);
 218         break;
 219
 220
 221     case ACPI_TYPE_BUFFER_FIELD:
 222     case ACPI_TYPE_LOCAL_REGION_FIELD:
 223     case ACPI_TYPE_LOCAL_BANK_FIELD:
 224     case ACPI_TYPE_LOCAL_INDEX_FIELD:
 225
 226         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 227             "FieldRead Node=%p SourceDesc=%p Type=%X\n",
 228             Node, SourceDesc, EntryType));
 229
 230         Status = AcpiExReadDataFromField (WalkState, SourceDesc, &ObjDesc);
 231         break;
 232
 233     /* For these objects, just return the object attached to the Node */
 234
 235     case ACPI_TYPE_MUTEX:
 236     case ACPI_TYPE_POWER:
 237     case ACPI_TYPE_PROCESSOR:
 238     case ACPI_TYPE_EVENT:
 239     case ACPI_TYPE_REGION:
 240
 241         /* Return an additional reference to the object */
 242
 243         ObjDesc = SourceDesc;
 244         AcpiUtAddReference (ObjDesc);
 245         break;
 246
 247     /* TYPE_ANY is untyped, and thus there is no object associated with it */
 248
 249     case ACPI_TYPE_ANY:
 250
 251         ACPI_ERROR ((AE_INFO,
 252             "Untyped entry %p, no attached object!", Node));
 253
 254         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);  /* Cannot be AE_TYPE */
 255
 256
 257     case ACPI_TYPE_LOCAL_REFERENCE:
 258
 259         switch (SourceDesc->Reference.Class)
 260         {
 261         case ACPI_REFCLASS_TABLE:   /* This is a DdbHandle */
 262         case ACPI_REFCLASS_REFOF:
 263         case ACPI_REFCLASS_INDEX:
 264
 265             /* Return an additional reference to the object */
 266
 267             ObjDesc = SourceDesc;
 268             AcpiUtAddReference (ObjDesc);
 269             break;
 270
 271         default:
 272             /* No named references are allowed here */
 273
 274             ACPI_ERROR ((AE_INFO,
 275                 "Unsupported Reference type 0x%X",
 276                 SourceDesc->Reference.Class));
 277
 278             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 279         }
 280         break;
 281
 282
 283     default:
 284
 285         /* Default case is for unknown types */
 286
 287         ACPI_ERROR ((AE_INFO,
 288             "Node %p - Unknown object type 0x%X",
 289             Node, EntryType));
 290
 291         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 292
 293     } /* switch (EntryType) */
 294
 295
 296     /* Return the object descriptor */
 297
 298     *ObjectPtr = (void *) ObjDesc;
 299     return_ACPI_STATUS (Status);
 300 }
 301
 302