reactos/drivers/bus/acpi/acpica/namespace/nsload.c

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