sys/contrib/dev/acpica/nsload.c

   1 /******************************************************************************
   2  *
   3  * Module Name: nsload - namespace loading/expanding/contracting procedures
   4  *              $Revision: 64 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/nsload.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $                                                               */
 117
 118 #define __NSLOAD_C__
 119
 120 #include "acpi.h"
 121 #include "acnamesp.h"
 122 #include "acdispat.h"
 123
 124
 125 #define _COMPONENT          ACPI_NAMESPACE
 126         ACPI_MODULE_NAME    ("nsload")
 127
 128
 129 #ifndef ACPI_NO_METHOD_EXECUTION
 130
 131 /*******************************************************************************
 132  *
 133  * FUNCTION:    AcpiNsLoadTable
 134  *
 135  * PARAMETERS:  TableDesc       - Descriptor for table to be loaded
 136  *              Node            - Owning NS node
 137  *
 138  * RETURN:      Status
 139  *
 140  * DESCRIPTION: Load one ACPI table into the namespace
 141  *
 142  ******************************************************************************/
 143
 144 ACPI_STATUS
 145 AcpiNsLoadTable (
 146     ACPI_TABLE_DESC         *TableDesc,
 147     ACPI_NAMESPACE_NODE     *Node)
 148 {
 149     ACPI_STATUS             Status;
 150
 151
 152     ACPI_FUNCTION_TRACE ("NsLoadTable");
 153
 154
 155     /* Check if table contains valid AML (must be DSDT, PSDT, SSDT, etc.) */
 156
 157     if (!(AcpiGbl_AcpiTableData[TableDesc->Type].Flags & ACPI_TABLE_EXECUTABLE))
 158     {
 159         /* Just ignore this table */
 160
 161         return_ACPI_STATUS (AE_OK);
 162     }
 163
 164     /* Check validity of the AML start and length */
 165
 166     if (!TableDesc->AmlStart)
 167     {
 168         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Null AML pointer\n"));
 169         return_ACPI_STATUS (AE_BAD_PARAMETER);
 170     }
 171
 172     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "AML block at %p\n", TableDesc->AmlStart));
 173
 174     /* Ignore table if there is no AML contained within */
 175
 176     if (!TableDesc->AmlLength)
 177     {
 178         ACPI_REPORT_WARNING (("Zero-length AML block in table [%4.4s]\n", TableDesc->Pointer->Signature));
 179         return_ACPI_STATUS (AE_OK);
 180     }
 181
 182     /*
 183      * Parse the table and load the namespace with all named
 184      * objects found within.  Control methods are NOT parsed
 185      * at this time.  In fact, the control methods cannot be
 186      * parsed until the entire namespace is loaded, because
 187      * if a control method makes a forward reference (call)
 188      * to another control method, we can't continue parsing
 189      * because we don't know how many arguments to parse next!
 190      */
 191     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "**** Loading table into namespace ****\n"));
 192
 193     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 194     if (ACPI_FAILURE (Status))
 195     {
 196         return_ACPI_STATUS (Status);
 197     }
 198
 199     Status = AcpiNsParseTable (TableDesc, Node->Child);
 200     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 201
 202     if (ACPI_FAILURE (Status))
 203     {
 204         return_ACPI_STATUS (Status);
 205     }
 206
 207     /*
 208      * Now we can parse the control methods.  We always parse
 209      * them here for a sanity check, and if configured for
 210      * just-in-time parsing, we delete the control method
 211      * parse trees.
 212      */
 213     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 214         "**** Begin Table Method Parsing and Object Initialization ****\n"));
 215
 216     Status = AcpiDsInitializeObjects (TableDesc, Node);
 217
 218     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 219         "**** Completed Table Method Parsing and Object Initialization ****\n"));
 220
 221     return_ACPI_STATUS (Status);
 222 }
 223
 224
 225 /*******************************************************************************
 226  *
 227  * FUNCTION:    AcpiNsLoadTableByType
 228  *
 229  * PARAMETERS:  TableType           - Id of the table type to load
 230  *
 231  * RETURN:      Status
 232  *
 233  * DESCRIPTION: Load an ACPI table or tables into the namespace.  All tables
 234  *              of the given type are loaded.  The mechanism allows this
 235  *              routine to be called repeatedly.
 236  *
 237  ******************************************************************************/
 238
 239 ACPI_STATUS
 240 AcpiNsLoadTableByType (
 241     ACPI_TABLE_TYPE         TableType)
 242 {
 243     UINT32                  i;
 244     ACPI_STATUS             Status;
 245     ACPI_TABLE_DESC         *TableDesc;
 246
 247
 248     ACPI_FUNCTION_TRACE ("NsLoadTableByType");
 249
 250
 251     Status = AcpiUtAcquireMutex (ACPI_MTX_TABLES);
 252     if (ACPI_FAILURE (Status))
 253     {
 254         return_ACPI_STATUS (Status);
 255     }
 256
 257     /*
 258      * Table types supported are:
 259      * DSDT (one), SSDT/PSDT (multiple)
 260      */
 261     switch (TableType)
 262     {
 263     case ACPI_TABLE_DSDT:
 264
 265         ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Loading DSDT\n"));
 266
 267         TableDesc = &AcpiGbl_AcpiTables[ACPI_TABLE_DSDT];
 268
 269         /* If table already loaded into namespace, just return */
 270
 271         if (TableDesc->LoadedIntoNamespace)
 272         {
 273             goto UnlockAndExit;
 274         }
 275
 276         TableDesc->TableId = TABLE_ID_DSDT;
 277
 278         /* Now load the single DSDT */
 279
 280         Status = AcpiNsLoadTable (TableDesc, AcpiGbl_RootNode);
 281         if (ACPI_SUCCESS (Status))
 282         {
 283             TableDesc->LoadedIntoNamespace = TRUE;
 284         }
 285
 286         break;
 287
 288
 289     case ACPI_TABLE_SSDT:
 290
 291         ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Loading %d SSDTs\n",
 292             AcpiGbl_AcpiTables[ACPI_TABLE_SSDT].Count));
 293
 294         /*
 295          * Traverse list of SSDT tables
 296          */
 297         TableDesc = &AcpiGbl_AcpiTables[ACPI_TABLE_SSDT];
 298         for (i = 0; i < AcpiGbl_AcpiTables[ACPI_TABLE_SSDT].Count; i++)
 299         {
 300             /*
 301              * Only attempt to load table if it is not
 302              * already loaded!
 303              */
 304             if (!TableDesc->LoadedIntoNamespace)
 305             {
 306                 Status = AcpiNsLoadTable (TableDesc, AcpiGbl_RootNode);
 307                 if (ACPI_FAILURE (Status))
 308                 {
 309                     break;
 310                 }
 311
 312                 TableDesc->LoadedIntoNamespace = TRUE;
 313             }
 314
 315             TableDesc = TableDesc->Next;
 316         }
 317         break;
 318
 319
 320     case ACPI_TABLE_PSDT:
 321
 322         ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Loading %d PSDTs\n",
 323             AcpiGbl_AcpiTables[ACPI_TABLE_PSDT].Count));
 324
 325         /*
 326          * Traverse list of PSDT tables
 327          */
 328         TableDesc = &AcpiGbl_AcpiTables[ACPI_TABLE_PSDT];
 329
 330         for (i = 0; i < AcpiGbl_AcpiTables[ACPI_TABLE_PSDT].Count; i++)
 331         {
 332             /* Only attempt to load table if it is not already loaded! */
 333
 334             if (!TableDesc->LoadedIntoNamespace)
 335             {
 336                 Status = AcpiNsLoadTable (TableDesc, AcpiGbl_RootNode);
 337                 if (ACPI_FAILURE (Status))
 338                 {
 339                     break;
 340                 }
 341
 342                 TableDesc->LoadedIntoNamespace = TRUE;
 343             }
 344
 345             TableDesc = TableDesc->Next;
 346         }
 347
 348         break;
 349
 350
 351     default:
 352         Status = AE_SUPPORT;
 353         break;
 354     }
 355
 356
 357 UnlockAndExit:
 358     (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
 359     return_ACPI_STATUS (Status);
 360 }
 361
 362
 363 /*******************************************************************************
 364  *
 365  * FUNCTION:    AcpiLoadNamespace
 366  *
 367  * PARAMETERS:  None
 368  *
 369  * RETURN:      Status
 370  *
 371  * DESCRIPTION: Load the name space from what ever is pointed to by DSDT.
 372  *              (DSDT points to either the BIOS or a buffer.)
 373  *
 374  ******************************************************************************/
 375
 376 ACPI_STATUS
 377 AcpiNsLoadNamespace (
 378     void)
 379 {
 380     ACPI_STATUS             Status;
 381
 382
 383     ACPI_FUNCTION_TRACE ("AcpiLoadNameSpace");
 384
 385
 386     /* There must be at least a DSDT installed */
 387
 388     if (AcpiGbl_DSDT == NULL)
 389     {
 390         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "DSDT is not in memory\n"));
 391         return_ACPI_STATUS (AE_NO_ACPI_TABLES);
 392     }
 393
 394     /*
 395      * Load the namespace.  The DSDT is required,
 396      * but the SSDT and PSDT tables are optional.
 397      */
 398     Status = AcpiNsLoadTableByType (ACPI_TABLE_DSDT);
 399     if (ACPI_FAILURE (Status))
 400     {
 401         return_ACPI_STATUS (Status);
 402     }
 403
 404     /* Ignore exceptions from these */
 405
 406     (void) AcpiNsLoadTableByType (ACPI_TABLE_SSDT);
 407     (void) AcpiNsLoadTableByType (ACPI_TABLE_PSDT);
 408
 409     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
 410         "ACPI Namespace successfully loaded at root %p\n",
 411         AcpiGbl_RootNode));
 412
 413     return_ACPI_STATUS (Status);
 414 }
 415
 416
 417 /*******************************************************************************
 418  *
 419  * FUNCTION:    AcpiNsDeleteSubtree
 420  *
 421  * PARAMETERS:  StartHandle         - Handle in namespace where search begins
 422  *
 423  * RETURNS      Status
 424  *
 425  * DESCRIPTION: Walks the namespace starting at the given handle and deletes
 426  *              all objects, entries, and scopes in the entire subtree.
 427  *
 428  *              Namespace/Interpreter should be locked or the subsystem should
 429  *              be in shutdown before this routine is called.
 430  *
 431  ******************************************************************************/
 432
 433 ACPI_STATUS
 434 AcpiNsDeleteSubtree (
 435     ACPI_HANDLE             StartHandle)
 436 {
 437     ACPI_STATUS             Status;
 438     ACPI_HANDLE             ChildHandle;
 439     ACPI_HANDLE             ParentHandle;
 440     ACPI_HANDLE             NextChildHandle;
 441     ACPI_HANDLE             Dummy;
 442     UINT32                  Level;
 443
 444
 445     ACPI_FUNCTION_TRACE ("NsDeleteSubtree");
 446
 447
 448     ParentHandle = StartHandle;
 449     ChildHandle  = 0;
 450     Level        = 1;
 451
 452     /*
 453      * Traverse the tree of objects until we bubble back up
 454      * to where we started.
 455      */
 456     while (Level > 0)
 457     {
 458         /* Attempt to get the next object in this scope */
 459
 460         Status = AcpiGetNextObject (ACPI_TYPE_ANY, ParentHandle,
 461                                     ChildHandle, &NextChildHandle);
 462
 463         ChildHandle = NextChildHandle;
 464
 465         /* Did we get a new object? */
 466
 467         if (ACPI_SUCCESS (Status))
 468         {
 469             /* Check if this object has any children */
 470
 471             if (ACPI_SUCCESS (AcpiGetNextObject (ACPI_TYPE_ANY, ChildHandle,
 472                                     0, &Dummy)))
 473             {
 474                 /*
 475                  * There is at least one child of this object,
 476                  * visit the object
 477                  */
 478                 Level++;
 479                 ParentHandle = ChildHandle;
 480                 ChildHandle  = 0;
 481             }
 482         }
 483         else
 484         {
 485             /*
 486              * No more children in this object, go back up to
 487              * the object's parent
 488              */
 489             Level--;
 490
 491             /* Delete all children now */
 492
 493             AcpiNsDeleteChildren (ChildHandle);
 494
 495             ChildHandle = ParentHandle;
 496             Status = AcpiGetParent (ParentHandle, &ParentHandle);
 497             if (ACPI_FAILURE (Status))
 498             {
 499                 return_ACPI_STATUS (Status);
 500             }
 501         }
 502     }
 503
 504     /* Now delete the starting object, and we are done */
 505
 506     AcpiNsDeleteNode (ChildHandle);
 507
 508     return_ACPI_STATUS (AE_OK);
 509 }
 510
 511
 512 /*******************************************************************************
 513  *
 514  *  FUNCTION:       AcpiNsUnloadNameSpace
 515  *
 516  *  PARAMETERS:     Handle          - Root of namespace subtree to be deleted
 517  *
 518  *  RETURN:         Status
 519  *
 520  *  DESCRIPTION:    Shrinks the namespace, typically in response to an undocking
 521  *                  event.  Deletes an entire subtree starting from (and
 522  *                  including) the given handle.
 523  *
 524  ******************************************************************************/
 525
 526 ACPI_STATUS
 527 AcpiNsUnloadNamespace (
 528     ACPI_HANDLE             Handle)
 529 {
 530     ACPI_STATUS             Status;
 531
 532
 533     ACPI_FUNCTION_TRACE ("NsUnloadNameSpace");
 534
 535
 536     /* Parameter validation */
 537
 538     if (!AcpiGbl_RootNode)
 539     {
 540         return_ACPI_STATUS (AE_NO_NAMESPACE);
 541     }
 542
 543     if (!Handle)
 544     {
 545         return_ACPI_STATUS (AE_BAD_PARAMETER);
 546     }
 547
 548     /* This function does the real work */
 549
 550     Status = AcpiNsDeleteSubtree (Handle);
 551
 552     return_ACPI_STATUS (Status);
 553 }
 554
 555 #endif
 556