sys/contrib/dev/acpica-unix-20050211/namespace/nsinit.c

   1 /******************************************************************************
   2  *
   3  * Module Name: nsinit - namespace initialization
   4  *              $Revision: 64 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2005, 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
 117
 118 #define __NSXFINIT_C__
 119
 120 #include "acpi.h"
 121 #include "acnamesp.h"
 122 #include "acdispat.h"
 123 #include "acinterp.h"
 124
 125 #define _COMPONENT          ACPI_NAMESPACE
 126         ACPI_MODULE_NAME    ("nsinit")
 127
 128
 129 /*******************************************************************************
 130  *
 131  * FUNCTION:    AcpiNsInitializeObjects
 132  *
 133  * PARAMETERS:  None
 134  *
 135  * RETURN:      Status
 136  *
 137  * DESCRIPTION: Walk the entire namespace and perform any necessary
 138  *              initialization on the objects found therein
 139  *
 140  ******************************************************************************/
 141
 142 ACPI_STATUS
 143 AcpiNsInitializeObjects (
 144     void)
 145 {
 146     ACPI_STATUS             Status;
 147     ACPI_INIT_WALK_INFO     Info;
 148
 149
 150     ACPI_FUNCTION_TRACE ("NsInitializeObjects");
 151
 152
 153     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
 154         "**** Starting initialization of namespace objects ****\n"));
 155     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
 156         "Completing Region/Field/Buffer/Package initialization:"));
 157
 158     /* Set all init info to zero */
 159
 160     ACPI_MEMSET (&Info, 0, sizeof (ACPI_INIT_WALK_INFO));
 161
 162     /* Walk entire namespace from the supplied root */
 163
 164     Status = AcpiWalkNamespace (ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
 165                                 ACPI_UINT32_MAX, AcpiNsInitOneObject,
 166                                 &Info, NULL);
 167     if (ACPI_FAILURE (Status))
 168     {
 169         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "WalkNamespace failed! %s\n",
 170             AcpiFormatException (Status)));
 171     }
 172
 173     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
 174         "\nInitialized %hd/%hd Regions %hd/%hd Fields %hd/%hd Buffers %hd/%hd Packages (%hd nodes)\n",
 175         Info.OpRegionInit,  Info.OpRegionCount,
 176         Info.FieldInit,     Info.FieldCount,
 177         Info.BufferInit,    Info.BufferCount,
 178         Info.PackageInit,   Info.PackageCount, Info.ObjectCount));
 179
 180     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
 181         "%hd Control Methods found\n", Info.MethodCount));
 182     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
 183         "%hd Op Regions found\n", Info.OpRegionCount));
 184
 185     return_ACPI_STATUS (AE_OK);
 186 }
 187
 188
 189 /*******************************************************************************
 190  *
 191  * FUNCTION:    AcpiNsInitializeDevices
 192  *
 193  * PARAMETERS:  None
 194  *
 195  * RETURN:      ACPI_STATUS
 196  *
 197  * DESCRIPTION: Walk the entire namespace and initialize all ACPI devices.
 198  *              This means running _INI on all present devices.
 199  *
 200  *              Note: We install PCI config space handler on region access,
 201  *              not here.
 202  *
 203  ******************************************************************************/
 204
 205 ACPI_STATUS
 206 AcpiNsInitializeDevices (
 207     void)
 208 {
 209     ACPI_STATUS             Status;
 210     ACPI_DEVICE_WALK_INFO   Info;
 211
 212
 213     ACPI_FUNCTION_TRACE ("NsInitializeDevices");
 214
 215
 216     /* Init counters */
 217
 218     Info.DeviceCount = 0;
 219     Info.Num_STA = 0;
 220     Info.Num_INI = 0;
 221
 222     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
 223         "Executing all Device _STA and_INI methods:"));
 224
 225     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 226     if (ACPI_FAILURE (Status))
 227     {
 228         return_ACPI_STATUS (Status);
 229     }
 230
 231     /* Walk namespace for all objects */
 232
 233     Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
 234                     ACPI_UINT32_MAX, TRUE, AcpiNsInitOneDevice, &Info, NULL);
 235
 236     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 237
 238     if (ACPI_FAILURE (Status))
 239     {
 240         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "WalkNamespace failed! %s\n",
 241             AcpiFormatException (Status)));
 242     }
 243
 244     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
 245         "\n%hd Devices found containing: %hd _STA, %hd _INI methods\n",
 246         Info.DeviceCount, Info.Num_STA, Info.Num_INI));
 247
 248     return_ACPI_STATUS (Status);
 249 }
 250
 251
 252 /*******************************************************************************
 253  *
 254  * FUNCTION:    AcpiNsInitOneObject
 255  *
 256  * PARAMETERS:  ObjHandle       - Node
 257  *              Level           - Current nesting level
 258  *              Context         - Points to a init info struct
 259  *              ReturnValue     - Not used
 260  *
 261  * RETURN:      Status
 262  *
 263  * DESCRIPTION: Callback from AcpiWalkNamespace.  Invoked for every object
 264  *              within the  namespace.
 265  *
 266  *              Currently, the only objects that require initialization are:
 267  *              1) Methods
 268  *              2) Op Regions
 269  *
 270  ******************************************************************************/
 271
 272 ACPI_STATUS
 273 AcpiNsInitOneObject (
 274     ACPI_HANDLE             ObjHandle,
 275     UINT32                  Level,
 276     void                    *Context,
 277     void                    **ReturnValue)
 278 {
 279     ACPI_OBJECT_TYPE        Type;
 280     ACPI_STATUS             Status;
 281     ACPI_INIT_WALK_INFO     *Info = (ACPI_INIT_WALK_INFO *) Context;
 282     ACPI_NAMESPACE_NODE     *Node = (ACPI_NAMESPACE_NODE *) ObjHandle;
 283     ACPI_OPERAND_OBJECT     *ObjDesc;
 284
 285
 286     ACPI_FUNCTION_NAME ("NsInitOneObject");
 287
 288
 289     Info->ObjectCount++;
 290
 291     /* And even then, we are only interested in a few object types */
 292
 293     Type = AcpiNsGetType (ObjHandle);
 294     ObjDesc = AcpiNsGetAttachedObject (Node);
 295     if (!ObjDesc)
 296     {
 297         return (AE_OK);
 298     }
 299
 300     /* Increment counters for object types we are looking for */
 301
 302     switch (Type)
 303     {
 304     case ACPI_TYPE_REGION:
 305         Info->OpRegionCount++;
 306         break;
 307
 308     case ACPI_TYPE_BUFFER_FIELD:
 309         Info->FieldCount++;
 310         break;
 311
 312     case ACPI_TYPE_BUFFER:
 313         Info->BufferCount++;
 314         break;
 315
 316     case ACPI_TYPE_PACKAGE:
 317         Info->PackageCount++;
 318         break;
 319
 320     default:
 321
 322         /* No init required, just exit now */
 323         return (AE_OK);
 324     }
 325
 326     /*
 327      * If the object is already initialized, nothing else to do
 328      */
 329     if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
 330     {
 331         return (AE_OK);
 332     }
 333
 334     /*
 335      * Must lock the interpreter before executing AML code
 336      */
 337     Status = AcpiExEnterInterpreter ();
 338     if (ACPI_FAILURE (Status))
 339     {
 340         return (Status);
 341     }
 342
 343     /*
 344      * Each of these types can contain executable AML code within the
 345      * declaration.
 346      */
 347     switch (Type)
 348     {
 349     case ACPI_TYPE_REGION:
 350
 351         Info->OpRegionInit++;
 352         Status = AcpiDsGetRegionArguments (ObjDesc);
 353         break;
 354
 355     case ACPI_TYPE_BUFFER_FIELD:
 356
 357         Info->FieldInit++;
 358         Status = AcpiDsGetBufferFieldArguments (ObjDesc);
 359         break;
 360
 361     case ACPI_TYPE_BUFFER:
 362
 363         Info->BufferInit++;
 364         Status = AcpiDsGetBufferArguments (ObjDesc);
 365         break;
 366
 367     case ACPI_TYPE_PACKAGE:
 368
 369         Info->PackageInit++;
 370         Status = AcpiDsGetPackageArguments (ObjDesc);
 371         break;
 372
 373     default:
 374         /* No other types can get here */
 375         break;
 376     }
 377
 378     if (ACPI_FAILURE (Status))
 379     {
 380         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_ERROR, "\n"));
 381         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
 382                 "Could not execute arguments for [%4.4s] (%s), %s\n",
 383                 AcpiUtGetNodeName (Node), AcpiUtGetTypeName (Type),
 384                 AcpiFormatException (Status)));
 385     }
 386
 387     /*
 388      * Print a dot for each object unless we are going to print the entire
 389      * pathname
 390      */
 391     if (!(AcpiDbgLevel & ACPI_LV_INIT_NAMES))
 392     {
 393         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT, "."));
 394     }
 395
 396     /*
 397      * We ignore errors from above, and always return OK, since we don't want
 398      * to abort the walk on any single error.
 399      */
 400     AcpiExExitInterpreter ();
 401     return (AE_OK);
 402 }
 403
 404
 405 /*******************************************************************************
 406  *
 407  * FUNCTION:    AcpiNsInitOneDevice
 408  *
 409  * PARAMETERS:  ACPI_WALK_CALLBACK
 410  *
 411  * RETURN:      ACPI_STATUS
 412  *
 413  * DESCRIPTION: This is called once per device soon after ACPI is enabled
 414  *              to initialize each device. It determines if the device is
 415  *              present, and if so, calls _INI.
 416  *
 417  ******************************************************************************/
 418
 419 ACPI_STATUS
 420 AcpiNsInitOneDevice (
 421     ACPI_HANDLE             ObjHandle,
 422     UINT32                  NestingLevel,
 423     void                    *Context,
 424     void                    **ReturnValue)
 425 {
 426     ACPI_DEVICE_WALK_INFO  *Info = (ACPI_DEVICE_WALK_INFO *) Context;
 427     ACPI_PARAMETER_INFO     Pinfo;
 428     UINT32                  Flags;
 429     ACPI_STATUS             Status;
 430
 431
 432     ACPI_FUNCTION_TRACE ("NsInitOneDevice");
 433
 434
 435     Pinfo.Parameters = NULL;
 436     Pinfo.ParameterType = ACPI_PARAM_ARGS;
 437
 438     Pinfo.Node = AcpiNsMapHandleToNode (ObjHandle);
 439     if (!Pinfo.Node)
 440     {
 441         return_ACPI_STATUS (AE_BAD_PARAMETER);
 442     }
 443
 444     /*
 445      * We will run _STA/_INI on Devices, Processors and ThermalZones only
 446      */
 447     if ((Pinfo.Node->Type != ACPI_TYPE_DEVICE)      &&
 448         (Pinfo.Node->Type != ACPI_TYPE_PROCESSOR)   &&
 449         (Pinfo.Node->Type != ACPI_TYPE_THERMAL))
 450     {
 451         return_ACPI_STATUS (AE_OK);
 452     }
 453
 454     if ((AcpiDbgLevel <= ACPI_LV_ALL_EXCEPTIONS) &&
 455         (!(AcpiDbgLevel & ACPI_LV_INFO)))
 456     {
 457         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT, "."));
 458     }
 459
 460     Info->DeviceCount++;
 461
 462     /*
 463      * Run _STA to determine if we can run _INI on the device.
 464      */
 465     ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (ACPI_TYPE_METHOD, Pinfo.Node, "_STA"));
 466     Status = AcpiUtExecute_STA (Pinfo.Node, &Flags);
 467
 468     if (ACPI_FAILURE (Status))
 469     {
 470         if (Pinfo.Node->Type == ACPI_TYPE_DEVICE)
 471         {
 472             /* Ignore error and move on to next device */
 473
 474             return_ACPI_STATUS (AE_OK);
 475         }
 476
 477         /* _STA is not required for Processor or ThermalZone objects */
 478     }
 479     else
 480     {
 481         Info->Num_STA++;
 482
 483         if (!(Flags & 0x01))
 484         {
 485             /* Don't look at children of a not present device */
 486
 487             return_ACPI_STATUS(AE_CTRL_DEPTH);
 488         }
 489     }
 490
 491     /*
 492      * The device is present. Run _INI.
 493      */
 494     ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (ACPI_TYPE_METHOD, Pinfo.Node, "_INI"));
 495     Status = AcpiNsEvaluateRelative ("_INI", &Pinfo);
 496     if (ACPI_FAILURE (Status))
 497     {
 498         /* No _INI (AE_NOT_FOUND) means device requires no initialization */
 499
 500         if (Status != AE_NOT_FOUND)
 501         {
 502             /* Ignore error and move on to next device */
 503
 504 #ifdef ACPI_DEBUG_OUTPUT
 505             char        *ScopeName = AcpiNsGetExternalPathname (Pinfo.Node);
 506
 507             ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "%s._INI failed: %s\n",
 508                     ScopeName, AcpiFormatException (Status)));
 509
 510             ACPI_MEM_FREE (ScopeName);
 511 #endif
 512         }
 513
 514         Status = AE_OK;
 515     }
 516     else
 517     {
 518         /* Delete any return object (especially if ImplicitReturn is enabled) */
 519
 520         if (Pinfo.ReturnObject)
 521         {
 522             AcpiUtRemoveReference (Pinfo.ReturnObject);
 523         }
 524
 525         /* Count of successful INIs */
 526
 527         Info->Num_INI++;
 528     }
 529
 530     if (AcpiGbl_InitHandler)
 531     {
 532         /* External initialization handler is present, call it */
 533
 534         Status = AcpiGbl_InitHandler (Pinfo.Node, ACPI_INIT_DEVICE_INI);
 535     }
 536
 537     return_ACPI_STATUS (Status);
 538 }