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

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