sys/contrib/dev/acpica/Subsystem/Namespace/nsobject.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: nsobject - Utilities for objects attached to namespace
   4  *                         table entries
   5  *              $Revision: 49 $
   6  *
   7  ******************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp.
  14  * All rights reserved.
  15  *
  16  * 2. License
  17  *
  18  * 2.1. This is your license from Intel Corp. under its intellectual property
  19  * rights.  You may have additional license terms from the party that provided
  20  * you this software, covering your right to use that party's intellectual
  21  * property rights.
  22  *
  23  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  24  * copy of the source code appearing in this file ("Covered Code") an
  25  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  26  * base code distributed originally by Intel ("Original Intel Code") to copy,
  27  * make derivatives, distribute, use and display any portion of the Covered
  28  * Code in any form, with the right to sublicense such rights; and
  29  *
  30  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  31  * license (with the right to sublicense), under only those claims of Intel
  32  * patents that are infringed by the Original Intel Code, to make, use, sell,
  33  * offer to sell, and import the Covered Code and derivative works thereof
  34  * solely to the minimum extent necessary to exercise the above copyright
  35  * license, and in no event shall the patent license extend to any additions
  36  * to or modifications of the Original Intel Code.  No other license or right
  37  * is granted directly or by implication, estoppel or otherwise;
  38  *
  39  * The above copyright and patent license is granted only if the following
  40  * conditions are met:
  41  *
  42  * 3. Conditions
  43  *
  44  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  45  * Redistribution of source code of any substantial portion of the Covered
  46  * Code or modification with rights to further distribute source must include
  47  * the above Copyright Notice, the above License, this list of Conditions,
  48  * and the following Disclaimer and Export Compliance provision.  In addition,
  49  * Licensee must cause all Covered Code to which Licensee contributes to
  50  * contain a file documenting the changes Licensee made to create that Covered
  51  * Code and the date of any change.  Licensee must include in that file the
  52  * documentation of any changes made by any predecessor Licensee.  Licensee
  53  * must include a prominent statement that the modification is derived,
  54  * directly or indirectly, from Original Intel Code.
  55  *
  56  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  57  * Redistribution of source code of any substantial portion of the Covered
  58  * Code or modification without rights to further distribute source must
  59  * include the following Disclaimer and Export Compliance provision in the
  60  * documentation and/or other materials provided with distribution.  In
  61  * addition, Licensee may not authorize further sublicense of source of any
  62  * portion of the Covered Code, and must include terms to the effect that the
  63  * license from Licensee to its licensee is limited to the intellectual
  64  * property embodied in the software Licensee provides to its licensee, and
  65  * not to intellectual property embodied in modifications its licensee may
  66  * make.
  67  *
  68  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  69  * substantial portion of the Covered Code or modification must reproduce the
  70  * above Copyright Notice, and the following Disclaimer and Export Compliance
  71  * provision in the documentation and/or other materials provided with the
  72  * distribution.
  73  *
  74  * 3.4. Intel retains all right, title, and interest in and to the Original
  75  * Intel Code.
  76  *
  77  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  78  * Intel shall be used in advertising or otherwise to promote the sale, use or
  79  * other dealings in products derived from or relating to the Covered Code
  80  * without prior written authorization from Intel.
  81  *
  82  * 4. Disclaimer and Export Compliance
  83  *
  84  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  85  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  86  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  87  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  88  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  89  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  90  * PARTICULAR PURPOSE.
  91  *
  92  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  93  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  94  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  95  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  96  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  97  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  98  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  99  * LIMITED REMEDY.
 100  *
 101  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 102  * software or system incorporating such software without first obtaining any
 103  * required license or other approval from the U. S. Department of Commerce or
 104  * any other agency or department of the United States Government.  In the
 105  * event Licensee exports any such software from the United States or
 106  * re-exports any such software from a foreign destination, Licensee shall
 107  * ensure that the distribution and export/re-export of the software is in
 108  * compliance with all laws, regulations, orders, or other restrictions of the
 109  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 110  * any of its subsidiaries will export/re-export any technical data, process,
 111  * software, or service, directly or indirectly, to any country for which the
 112  * United States government or any agency thereof requires an export license,
 113  * other governmental approval, or letter of assurance, without first obtaining
 114  * such license, approval or letter.
 115  *
 116  *****************************************************************************/
 117
 118
 119 #define __NSOBJECT_C__
 120
 121 #include "acpi.h"
 122 #include "amlcode.h"
 123 #include "acnamesp.h"
 124 #include "acinterp.h"
 125 #include "actables.h"
 126
 127
 128 #define _COMPONENT          NAMESPACE
 129         MODULE_NAME         ("nsobject")
 130
 131
 132 /*******************************************************************************
 133  *
 134  * FUNCTION:    AcpiNsAttachObject
 135  *
 136  * PARAMETERS:  Node            - Parent Node
 137  *              Object              - Object to be attached
 138  *              Type                - Type of object, or ACPI_TYPE_ANY if not
 139  *                                      known
 140  *
 141  * DESCRIPTION: Record the given object as the value associated with the
 142  *              name whose ACPI_HANDLE is passed.  If Object is NULL
 143  *              and Type is ACPI_TYPE_ANY, set the name as having no value.
 144  *
 145  * MUTEX:       Assumes namespace is locked
 146  *
 147  ******************************************************************************/
 148
 149 ACPI_STATUS
 150 AcpiNsAttachObject (
 151     ACPI_NAMESPACE_NODE     *Node,
 152     ACPI_OPERAND_OBJECT     *Object,
 153     OBJECT_TYPE_INTERNAL    Type)
 154 {
 155     ACPI_OPERAND_OBJECT     *ObjDesc;
 156     ACPI_OPERAND_OBJECT     *PreviousObjDesc;
 157     OBJECT_TYPE_INTERNAL    ObjType = ACPI_TYPE_ANY;
 158     UINT8                   Flags;
 159     UINT16                  Opcode;
 160
 161
 162     FUNCTION_TRACE ("NsAttachObject");
 163
 164
 165     /*
 166      * Parameter validation
 167      */
 168
 169     if (!AcpiGbl_RootNode)
 170     {
 171         /* Name space not initialized  */
 172
 173         REPORT_ERROR (("NsAttachObject: Namespace not initialized\n"));
 174         return_ACPI_STATUS (AE_NO_NAMESPACE);
 175     }
 176
 177     if (!Node)
 178     {
 179         /* Invalid handle */
 180
 181         REPORT_ERROR (("NsAttachObject: Null NamedObj handle\n"));
 182         return_ACPI_STATUS (AE_BAD_PARAMETER);
 183     }
 184
 185     if (!Object && (ACPI_TYPE_ANY != Type))
 186     {
 187         /* Null object */
 188
 189         REPORT_ERROR (("NsAttachObject: Null object, but type not ACPI_TYPE_ANY\n"));
 190         return_ACPI_STATUS (AE_BAD_PARAMETER);
 191     }
 192
 193     if (!VALID_DESCRIPTOR_TYPE (Node, ACPI_DESC_TYPE_NAMED))
 194     {
 195         /* Not a name handle */
 196
 197         REPORT_ERROR (("NsAttachObject: Invalid handle\n"));
 198         return_ACPI_STATUS (AE_BAD_PARAMETER);
 199     }
 200
 201     /* Check if this object is already attached */
 202
 203     if (Node->Object == Object)
 204     {
 205         DEBUG_PRINT (TRACE_EXEC,
 206             ("NsAttachObject: Obj %p already installed in NameObj %p\n",
 207             Object, Node));
 208
 209         return_ACPI_STATUS (AE_OK);
 210     }
 211
 212
 213     /* Get the current flags field of the Node */
 214
 215     Flags = Node->Flags;
 216     Flags &= ~ANOBJ_AML_ATTACHMENT;
 217
 218
 219     /* If null object, we will just install it */
 220
 221     if (!Object)
 222     {
 223         ObjDesc = NULL;
 224         ObjType = ACPI_TYPE_ANY;
 225     }
 226
 227     /*
 228      * If the object is an Node with an attached object,
 229      * we will use that (attached) object
 230      */
 231
 232     else if (VALID_DESCRIPTOR_TYPE (Object, ACPI_DESC_TYPE_NAMED) &&
 233             ((ACPI_NAMESPACE_NODE *) Object)->Object)
 234     {
 235         /*
 236          * Value passed is a name handle and that name has a
 237          * non-null value.  Use that name's value and type.
 238          */
 239
 240         ObjDesc = ((ACPI_NAMESPACE_NODE *) Object)->Object;
 241         ObjType = ((ACPI_NAMESPACE_NODE *) Object)->Type;
 242
 243         /*
 244          * Copy appropriate flags
 245          */
 246
 247         if (((ACPI_NAMESPACE_NODE *) Object)->Flags & ANOBJ_AML_ATTACHMENT)
 248         {
 249             Flags |= ANOBJ_AML_ATTACHMENT;
 250         }
 251     }
 252
 253
 254     /*
 255      * Otherwise, we will use the parameter object, but we must type
 256      * it first
 257      */
 258
 259     else
 260     {
 261         ObjDesc = (ACPI_OPERAND_OBJECT  *) Object;
 262
 263
 264         /* If a valid type (non-ANY) was given, just use it */
 265
 266         if (ACPI_TYPE_ANY != Type)
 267         {
 268             ObjType = Type;
 269         }
 270
 271
 272         /*
 273          * Type is TYPE_Any, we must try to determinte the
 274          * actual type of the object
 275          */
 276
 277         /*
 278          * Check if value points into the AML code
 279          */
 280         else if (AcpiTbSystemTablePointer (Object))
 281         {
 282             /*
 283              * Object points into the AML stream.
 284              * Set a flag bit in the Node to indicate this
 285              */
 286
 287             Flags |= ANOBJ_AML_ATTACHMENT;
 288
 289             /*
 290              * The next byte (perhaps the next two bytes)
 291              * will be the AML opcode
 292              */
 293
 294             MOVE_UNALIGNED16_TO_16 (&Opcode, Object);
 295
 296             /* Check for a recognized OpCode */
 297
 298             switch ((UINT8) Opcode)
 299             {
 300
 301             case AML_OP_PREFIX:
 302
 303                 if (Opcode != AML_REVISION_OP)
 304                 {
 305                     /*
 306                      * OpPrefix is unrecognized unless part
 307                      * of RevisionOp
 308                      */
 309
 310                     break;
 311                 }
 312
 313                 /* Else fall through to set type as Number */
 314
 315
 316             case AML_ZERO_OP: case AML_ONES_OP: case AML_ONE_OP:
 317             case AML_BYTE_OP: case AML_WORD_OP: case AML_DWORD_OP:
 318
 319                 ObjType = ACPI_TYPE_INTEGER;
 320                 break;
 321
 322
 323             case AML_STRING_OP:
 324
 325                 ObjType = ACPI_TYPE_STRING;
 326                 break;
 327
 328
 329             case AML_BUFFER_OP:
 330
 331                 ObjType = ACPI_TYPE_BUFFER;
 332                 break;
 333
 334
 335             case AML_MUTEX_OP:
 336
 337                 ObjType = ACPI_TYPE_MUTEX;
 338                 break;
 339
 340
 341             case AML_PACKAGE_OP:
 342
 343                 ObjType = ACPI_TYPE_PACKAGE;
 344                 break;
 345
 346
 347             default:
 348
 349                 DEBUG_PRINT (ACPI_ERROR,
 350                     ("AML Opcode/Type [%x] not supported in attach\n",
 351                     (UINT8) Opcode));
 352
 353                 return_ACPI_STATUS (AE_TYPE);
 354                 break;
 355             }
 356         }
 357
 358         else
 359         {
 360             /*
 361              * Cannot figure out the type -- set to DefAny which
 362              * will print as an error in the name table dump
 363              */
 364
 365             if (GetDebugLevel () > 0)
 366             {
 367                 DUMP_PATHNAME (Node,
 368                     "NsAttachObject confused: setting bogus type for  ",
 369                     ACPI_INFO, _COMPONENT);
 370
 371                 if (AcpiTbSystemTablePointer (Object))
 372                 {
 373                     DEBUG_PRINT (ACPI_INFO,
 374                         ("AML-stream code %02x\n", *(UINT8 *) Object));
 375                 }
 376
 377                 else if (VALID_DESCRIPTOR_TYPE (Object, ACPI_DESC_TYPE_NAMED))
 378                 {
 379                     DUMP_PATHNAME (Object,
 380                                     "name ", ACPI_INFO,
 381                                     _COMPONENT);
 382                 }
 383
 384                 else
 385                 {
 386                     DUMP_PATHNAME (Object, "object ",
 387                                     ACPI_INFO, _COMPONENT);
 388                     DUMP_STACK_ENTRY (Object);
 389                 }
 390             }
 391
 392             ObjType = INTERNAL_TYPE_DEF_ANY;
 393         }
 394     }
 395
 396
 397     DEBUG_PRINT (TRACE_EXEC,
 398         ("NsAttachObject: Installing obj %p into NameObj %p [%4.4s]\n",
 399         ObjDesc, Node, &Node->Name));
 400
 401
 402     /*
 403      * Must increment the new value's reference count
 404      * (if it is an internal object)
 405      */
 406
 407     AcpiCmAddReference (ObjDesc);
 408
 409     /* Save the existing object (if any) for deletion later */
 410
 411     PreviousObjDesc = Node->Object;
 412
 413     /* Install the object and set the type, flags */
 414
 415     Node->Object   = ObjDesc;
 416     Node->Type     = (UINT8) ObjType;
 417     Node->Flags    |= Flags;
 418
 419
 420     /*
 421      * Delete an existing attached object.
 422      */
 423
 424     if (PreviousObjDesc)
 425     {
 426         /* One for the attach to the Node */
 427
 428         AcpiCmRemoveReference (PreviousObjDesc);
 429
 430         /* Now delete */
 431
 432         AcpiCmRemoveReference (PreviousObjDesc);
 433     }
 434
 435     return_ACPI_STATUS (AE_OK);
 436 }
 437
 438
 439 /*******************************************************************************
 440  *
 441  * FUNCTION:    AcpiNsDetachObject
 442  *
 443  * PARAMETERS:  Node           - An object whose Value will be deleted
 444  *
 445  * RETURN:      None.
 446  *
 447  * DESCRIPTION: Delete the Value associated with a namespace object.  If the
 448  *              Value is an allocated object, it is freed.  Otherwise, the
 449  *              field is simply cleared.
 450  *
 451  ******************************************************************************/
 452
 453 void
 454 AcpiNsDetachObject (
 455     ACPI_NAMESPACE_NODE     *Node)
 456 {
 457     ACPI_OPERAND_OBJECT     *ObjDesc;
 458
 459
 460     FUNCTION_TRACE ("NsDetachObject");
 461
 462     ObjDesc = Node->Object;
 463     if (!ObjDesc)
 464     {
 465         return_VOID;
 466     }
 467
 468     /* Clear the entry in all cases */
 469
 470     Node->Object = NULL;
 471
 472     /* Found a valid value */
 473
 474     DEBUG_PRINT (ACPI_INFO,
 475         ("NsDetachObject: Object=%p Value=%p Name %4.4s\n",
 476         Node, ObjDesc, &Node->Name));
 477
 478     /*
 479      * Not every value is an object allocated via AcpiCmCallocate,
 480      * - must check
 481      */
 482
 483     if (!AcpiTbSystemTablePointer (ObjDesc))
 484     {
 485         /* Attempt to delete the object (and all subobjects) */
 486
 487         AcpiCmRemoveReference (ObjDesc);
 488     }
 489
 490     return_VOID;
 491 }
 492
 493
 494 /*******************************************************************************
 495  *
 496  * FUNCTION:    AcpiNsGetAttachedObject
 497  *
 498  * PARAMETERS:  Handle              - Parent Node to be examined
 499  *
 500  * RETURN:      Current value of the object field from the Node whose
 501  *              handle is passed
 502  *
 503  ******************************************************************************/
 504
 505 void *
 506 AcpiNsGetAttachedObject (
 507     ACPI_HANDLE             Handle)
 508 {
 509     FUNCTION_TRACE_PTR ("NsGetAttachedObject", Handle);
 510
 511
 512     if (!Handle)
 513     {
 514         /* handle invalid */
 515
 516         DEBUG_PRINT (ACPI_WARN, ("NsGetAttachedObject: Null handle\n"));
 517         return_PTR (NULL);
 518     }
 519
 520     return_PTR (((ACPI_NAMESPACE_NODE *) Handle)->Object);
 521 }
 522
 523