sys/contrib/dev/acpica/nsobject.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: nsobject - Utilities for objects attached to namespace
   4  *                         table entries
   5  *              $Revision: 1.98 $
   6  *
   7  ******************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999 - 2007, 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 <contrib/dev/acpica/acpi.h>
 122 #include <contrib/dev/acpica/acnamesp.h>
 123
 124
 125 #define _COMPONENT          ACPI_NAMESPACE
 126         ACPI_MODULE_NAME    ("nsobject")
 127
 128
 129 /*******************************************************************************
 130  *
 131  * FUNCTION:    AcpiNsAttachObject
 132  *
 133  * PARAMETERS:  Node                - Parent Node
 134  *              Object              - Object to be attached
 135  *              Type                - Type of object, or ACPI_TYPE_ANY if not
 136  *                                    known
 137  *
 138  * RETURN:      Status
 139  *
 140  * DESCRIPTION: Record the given object as the value associated with the
 141  *              name whose ACPI_HANDLE is passed.  If Object is NULL
 142  *              and Type is ACPI_TYPE_ANY, set the name as having no value.
 143  *              Note: Future may require that the Node->Flags field be passed
 144  *              as a parameter.
 145  *
 146  * MUTEX:       Assumes namespace is locked
 147  *
 148  ******************************************************************************/
 149
 150 ACPI_STATUS
 151 AcpiNsAttachObject (
 152     ACPI_NAMESPACE_NODE     *Node,
 153     ACPI_OPERAND_OBJECT     *Object,
 154     ACPI_OBJECT_TYPE        Type)
 155 {
 156     ACPI_OPERAND_OBJECT     *ObjDesc;
 157     ACPI_OPERAND_OBJECT     *LastObjDesc;
 158     ACPI_OBJECT_TYPE        ObjectType = ACPI_TYPE_ANY;
 159
 160
 161     ACPI_FUNCTION_TRACE (NsAttachObject);
 162
 163
 164     /*
 165      * Parameter validation
 166      */
 167     if (!Node)
 168     {
 169         /* Invalid handle */
 170
 171         ACPI_ERROR ((AE_INFO, "Null NamedObj handle"));
 172         return_ACPI_STATUS (AE_BAD_PARAMETER);
 173     }
 174
 175     if (!Object && (ACPI_TYPE_ANY != Type))
 176     {
 177         /* Null object */
 178
 179         ACPI_ERROR ((AE_INFO,
 180             "Null object, but type not ACPI_TYPE_ANY"));
 181         return_ACPI_STATUS (AE_BAD_PARAMETER);
 182     }
 183
 184     if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED)
 185     {
 186         /* Not a name handle */
 187
 188         ACPI_ERROR ((AE_INFO, "Invalid handle %p [%s]",
 189             Node, AcpiUtGetDescriptorName (Node)));
 190         return_ACPI_STATUS (AE_BAD_PARAMETER);
 191     }
 192
 193     /* Check if this object is already attached */
 194
 195     if (Node->Object == Object)
 196     {
 197         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 198             "Obj %p already installed in NameObj %p\n",
 199             Object, Node));
 200
 201         return_ACPI_STATUS (AE_OK);
 202     }
 203
 204     /* If null object, we will just install it */
 205
 206     if (!Object)
 207     {
 208         ObjDesc    = NULL;
 209         ObjectType = ACPI_TYPE_ANY;
 210     }
 211
 212     /*
 213      * If the source object is a namespace Node with an attached object,
 214      * we will use that (attached) object
 215      */
 216     else if ((ACPI_GET_DESCRIPTOR_TYPE (Object) == ACPI_DESC_TYPE_NAMED) &&
 217             ((ACPI_NAMESPACE_NODE *) Object)->Object)
 218     {
 219         /*
 220          * Value passed is a name handle and that name has a
 221          * non-null value.  Use that name's value and type.
 222          */
 223         ObjDesc    = ((ACPI_NAMESPACE_NODE *) Object)->Object;
 224         ObjectType = ((ACPI_NAMESPACE_NODE *) Object)->Type;
 225     }
 226
 227     /*
 228      * Otherwise, we will use the parameter object, but we must type
 229      * it first
 230      */
 231     else
 232     {
 233         ObjDesc = (ACPI_OPERAND_OBJECT  *) Object;
 234
 235         /* Use the given type */
 236
 237         ObjectType = Type;
 238     }
 239
 240     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Installing %p into Node %p [%4.4s]\n",
 241         ObjDesc, Node, AcpiUtGetNodeName (Node)));
 242
 243     /* Detach an existing attached object if present */
 244
 245     if (Node->Object)
 246     {
 247         AcpiNsDetachObject (Node);
 248     }
 249
 250     if (ObjDesc)
 251     {
 252         /*
 253          * Must increment the new value's reference count
 254          * (if it is an internal object)
 255          */
 256         AcpiUtAddReference (ObjDesc);
 257
 258         /*
 259          * Handle objects with multiple descriptors - walk
 260          * to the end of the descriptor list
 261          */
 262         LastObjDesc = ObjDesc;
 263         while (LastObjDesc->Common.NextObject)
 264         {
 265             LastObjDesc = LastObjDesc->Common.NextObject;
 266         }
 267
 268         /* Install the object at the front of the object list */
 269
 270         LastObjDesc->Common.NextObject = Node->Object;
 271     }
 272
 273     Node->Type     = (UINT8) ObjectType;
 274     Node->Object   = ObjDesc;
 275
 276     return_ACPI_STATUS (AE_OK);
 277 }
 278
 279
 280 /*******************************************************************************
 281  *
 282  * FUNCTION:    AcpiNsDetachObject
 283  *
 284  * PARAMETERS:  Node           - A Namespace node whose object will be detached
 285  *
 286  * RETURN:      None.
 287  *
 288  * DESCRIPTION: Detach/delete an object associated with a namespace node.
 289  *              if the object is an allocated object, it is freed.
 290  *              Otherwise, the field is simply cleared.
 291  *
 292  ******************************************************************************/
 293
 294 void
 295 AcpiNsDetachObject (
 296     ACPI_NAMESPACE_NODE     *Node)
 297 {
 298     ACPI_OPERAND_OBJECT     *ObjDesc;
 299
 300
 301     ACPI_FUNCTION_TRACE (NsDetachObject);
 302
 303
 304     ObjDesc = Node->Object;
 305
 306     if (!ObjDesc ||
 307         (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_LOCAL_DATA))
 308     {
 309         return_VOID;
 310     }
 311
 312     /* Clear the entry in all cases */
 313
 314     Node->Object = NULL;
 315     if (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) == ACPI_DESC_TYPE_OPERAND)
 316     {
 317         Node->Object = ObjDesc->Common.NextObject;
 318         if (Node->Object &&
 319            (ACPI_GET_OBJECT_TYPE (Node->Object) != ACPI_TYPE_LOCAL_DATA))
 320         {
 321             Node->Object = Node->Object->Common.NextObject;
 322         }
 323     }
 324
 325     /* Reset the node type to untyped */
 326
 327     Node->Type = ACPI_TYPE_ANY;
 328
 329     ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Node %p [%4.4s] Object %p\n",
 330         Node, AcpiUtGetNodeName (Node), ObjDesc));
 331
 332     /* Remove one reference on the object (and all subobjects) */
 333
 334     AcpiUtRemoveReference (ObjDesc);
 335     return_VOID;
 336 }
 337
 338
 339 /*******************************************************************************
 340  *
 341  * FUNCTION:    AcpiNsGetAttachedObject
 342  *
 343  * PARAMETERS:  Node             - Namespace node
 344  *
 345  * RETURN:      Current value of the object field from the Node whose
 346  *              handle is passed
 347  *
 348  * DESCRIPTION: Obtain the object attached to a namespace node.
 349  *
 350  ******************************************************************************/
 351
 352 ACPI_OPERAND_OBJECT *
 353 AcpiNsGetAttachedObject (
 354     ACPI_NAMESPACE_NODE     *Node)
 355 {
 356     ACPI_FUNCTION_TRACE_PTR (NsGetAttachedObject, Node);
 357
 358
 359     if (!Node)
 360     {
 361         ACPI_WARNING ((AE_INFO, "Null Node ptr"));
 362         return_PTR (NULL);
 363     }
 364
 365     if (!Node->Object ||
 366             ((ACPI_GET_DESCRIPTOR_TYPE (Node->Object) != ACPI_DESC_TYPE_OPERAND) &&
 367              (ACPI_GET_DESCRIPTOR_TYPE (Node->Object) != ACPI_DESC_TYPE_NAMED))  ||
 368         (ACPI_GET_OBJECT_TYPE (Node->Object) == ACPI_TYPE_LOCAL_DATA))
 369     {
 370         return_PTR (NULL);
 371     }
 372
 373     return_PTR (Node->Object);
 374 }
 375
 376
 377 /*******************************************************************************
 378  *
 379  * FUNCTION:    AcpiNsGetSecondaryObject
 380  *
 381  * PARAMETERS:  Node             - Namespace node
 382  *
 383  * RETURN:      Current value of the object field from the Node whose
 384  *              handle is passed.
 385  *
 386  * DESCRIPTION: Obtain a secondary object associated with a namespace node.
 387  *
 388  ******************************************************************************/
 389
 390 ACPI_OPERAND_OBJECT *
 391 AcpiNsGetSecondaryObject (
 392     ACPI_OPERAND_OBJECT     *ObjDesc)
 393 {
 394     ACPI_FUNCTION_TRACE_PTR (NsGetSecondaryObject, ObjDesc);
 395
 396
 397     if ((!ObjDesc)                                                ||
 398         (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_LOCAL_DATA)  ||
 399         (!ObjDesc->Common.NextObject)                             ||
 400         (ACPI_GET_OBJECT_TYPE (ObjDesc->Common.NextObject) == ACPI_TYPE_LOCAL_DATA))
 401     {
 402         return_PTR (NULL);
 403     }
 404
 405     return_PTR (ObjDesc->Common.NextObject);
 406 }
 407
 408
 409 /*******************************************************************************
 410  *
 411  * FUNCTION:    AcpiNsAttachData
 412  *
 413  * PARAMETERS:  Node            - Namespace node
 414  *              Handler         - Handler to be associated with the data
 415  *              Data            - Data to be attached
 416  *
 417  * RETURN:      Status
 418  *
 419  * DESCRIPTION: Low-level attach data.  Create and attach a Data object.
 420  *
 421  ******************************************************************************/
 422
 423 ACPI_STATUS
 424 AcpiNsAttachData (
 425     ACPI_NAMESPACE_NODE     *Node,
 426     ACPI_OBJECT_HANDLER     Handler,
 427     void                    *Data)
 428 {
 429     ACPI_OPERAND_OBJECT     *PrevObjDesc;
 430     ACPI_OPERAND_OBJECT     *ObjDesc;
 431     ACPI_OPERAND_OBJECT     *DataDesc;
 432
 433
 434     /* We only allow one attachment per handler */
 435
 436     PrevObjDesc = NULL;
 437     ObjDesc = Node->Object;
 438     while (ObjDesc)
 439     {
 440         if ((ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_LOCAL_DATA) &&
 441             (ObjDesc->Data.Handler == Handler))
 442         {
 443             return (AE_ALREADY_EXISTS);
 444         }
 445
 446         PrevObjDesc = ObjDesc;
 447         ObjDesc = ObjDesc->Common.NextObject;
 448     }
 449
 450     /* Create an internal object for the data */
 451
 452     DataDesc = AcpiUtCreateInternalObject (ACPI_TYPE_LOCAL_DATA);
 453     if (!DataDesc)
 454     {
 455         return (AE_NO_MEMORY);
 456     }
 457
 458     DataDesc->Data.Handler = Handler;
 459     DataDesc->Data.Pointer = Data;
 460
 461     /* Install the data object */
 462
 463     if (PrevObjDesc)
 464     {
 465         PrevObjDesc->Common.NextObject = DataDesc;
 466     }
 467     else
 468     {
 469         Node->Object = DataDesc;
 470     }
 471
 472     return (AE_OK);
 473 }
 474
 475
 476 /*******************************************************************************
 477  *
 478  * FUNCTION:    AcpiNsDetachData
 479  *
 480  * PARAMETERS:  Node            - Namespace node
 481  *              Handler         - Handler associated with the data
 482  *
 483  * RETURN:      Status
 484  *
 485  * DESCRIPTION: Low-level detach data.  Delete the data node, but the caller
 486  *              is responsible for the actual data.
 487  *
 488  ******************************************************************************/
 489
 490 ACPI_STATUS
 491 AcpiNsDetachData (
 492     ACPI_NAMESPACE_NODE     *Node,
 493     ACPI_OBJECT_HANDLER     Handler)
 494 {
 495     ACPI_OPERAND_OBJECT     *ObjDesc;
 496     ACPI_OPERAND_OBJECT     *PrevObjDesc;
 497
 498
 499     PrevObjDesc = NULL;
 500     ObjDesc = Node->Object;
 501     while (ObjDesc)
 502     {
 503         if ((ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_LOCAL_DATA) &&
 504             (ObjDesc->Data.Handler == Handler))
 505         {
 506             if (PrevObjDesc)
 507             {
 508                 PrevObjDesc->Common.NextObject = ObjDesc->Common.NextObject;
 509             }
 510             else
 511             {
 512                 Node->Object = ObjDesc->Common.NextObject;
 513             }
 514
 515             AcpiUtRemoveReference (ObjDesc);
 516             return (AE_OK);
 517         }
 518
 519         PrevObjDesc = ObjDesc;
 520         ObjDesc = ObjDesc->Common.NextObject;
 521     }
 522
 523     return (AE_NOT_FOUND);
 524 }
 525
 526
 527 /*******************************************************************************
 528  *
 529  * FUNCTION:    AcpiNsGetAttachedData
 530  *
 531  * PARAMETERS:  Node            - Namespace node
 532  *              Handler         - Handler associated with the data
 533  *              Data            - Where the data is returned
 534  *
 535  * RETURN:      Status
 536  *
 537  * DESCRIPTION: Low level interface to obtain data previously associated with
 538  *              a namespace node.
 539  *
 540  ******************************************************************************/
 541
 542 ACPI_STATUS
 543 AcpiNsGetAttachedData (
 544     ACPI_NAMESPACE_NODE     *Node,
 545     ACPI_OBJECT_HANDLER     Handler,
 546     void                    **Data)
 547 {
 548     ACPI_OPERAND_OBJECT     *ObjDesc;
 549
 550
 551     ObjDesc = Node->Object;
 552     while (ObjDesc)
 553     {
 554         if ((ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_LOCAL_DATA) &&
 555             (ObjDesc->Data.Handler == Handler))
 556         {
 557             *Data = ObjDesc->Data.Pointer;
 558             return (AE_OK);
 559         }
 560
 561         ObjDesc = ObjDesc->Common.NextObject;
 562     }
 563
 564     return (AE_NOT_FOUND);
 565 }
 566
 567