sys/contrib/dev/acpica/nsinit.c

   1 /******************************************************************************
   2  *
   3  * Module Name: nsinit - namespace initialization
   4  *              $Revision: 55 $
   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/nsinit.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $                                                               */
 117
 118
 119 #define __NSXFINIT_C__
 120
 121 #include "acpi.h"
 122 #include "acnamesp.h"
 123 #include "acdispat.h"
 124 #include "acinterp.h"
 125
 126 #define _COMPONENT          ACPI_NAMESPACE
 127         ACPI_MODULE_NAME    ("nsinit")
 128
 129
 130 /*******************************************************************************
 131  *
 132  * FUNCTION:    AcpiNsInitializeObjects
 133  *
 134  * PARAMETERS:  None
 135  *
 136  * RETURN:      Status
 137  *
 138  * DESCRIPTION: Walk the entire namespace and perform any necessary
 139  *              initialization on the objects found therein
 140  *
 141  ******************************************************************************/
 142
 143 ACPI_STATUS
 144 AcpiNsInitializeObjects (
 145     void)
 146 {
 147     ACPI_STATUS             Status;
 148     ACPI_INIT_WALK_INFO     Info;
 149
 150
 151     ACPI_FUNCTION_TRACE ("NsInitializeObjects");
 152
 153
 154     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
 155         "**** Starting initialization of namespace objects ****\n"));
 156     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT, "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, "Executing all Device _STA and_INI methods:"));
 223
 224     /* Walk namespace for all objects of type Device */
 225
 226     Status = AcpiNsWalkNamespace (ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
 227                     ACPI_UINT32_MAX, FALSE, AcpiNsInitOneDevice, &Info, NULL);
 228
 229     if (ACPI_FAILURE (Status))
 230     {
 231         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "WalkNamespace failed! %s\n",
 232             AcpiFormatException (Status)));
 233     }
 234
 235     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
 236         "\n%hd Devices found containing: %hd _STA, %hd _INI methods\n",
 237         Info.DeviceCount, Info.Num_STA, Info.Num_INI));
 238
 239     return_ACPI_STATUS (Status);
 240 }
 241
 242
 243 /*******************************************************************************
 244  *
 245  * FUNCTION:    AcpiNsInitOneObject
 246  *
 247  * PARAMETERS:  ObjHandle       - Node
 248  *              Level           - Current nesting level
 249  *              Context         - Points to a init info struct
 250  *              ReturnValue     - Not used
 251  *
 252  * RETURN:      Status
 253  *
 254  * DESCRIPTION: Callback from AcpiWalkNamespace.  Invoked for every object
 255  *              within the  namespace.
 256  *
 257  *              Currently, the only objects that require initialization are:
 258  *              1) Methods
 259  *              2) Op Regions
 260  *
 261  ******************************************************************************/
 262
 263 ACPI_STATUS
 264 AcpiNsInitOneObject (
 265     ACPI_HANDLE             ObjHandle,
 266     UINT32                  Level,
 267     void                    *Context,
 268     void                    **ReturnValue)
 269 {
 270     ACPI_OBJECT_TYPE        Type;
 271     ACPI_STATUS             Status;
 272     ACPI_INIT_WALK_INFO     *Info = (ACPI_INIT_WALK_INFO *) Context;
 273     ACPI_NAMESPACE_NODE     *Node = (ACPI_NAMESPACE_NODE *) ObjHandle;
 274     ACPI_OPERAND_OBJECT     *ObjDesc;
 275
 276
 277     ACPI_FUNCTION_NAME ("NsInitOneObject");
 278
 279
 280     Info->ObjectCount++;
 281
 282     /* And even then, we are only interested in a few object types */
 283
 284     Type = AcpiNsGetType (ObjHandle);
 285     ObjDesc = AcpiNsGetAttachedObject (Node);
 286     if (!ObjDesc)
 287     {
 288         return (AE_OK);
 289     }
 290
 291     /* Increment counters for object types we are looking for */
 292
 293     switch (Type)
 294     {
 295     case ACPI_TYPE_REGION:
 296         Info->OpRegionCount++;
 297         break;
 298
 299     case ACPI_TYPE_BUFFER_FIELD:
 300         Info->FieldCount++;
 301         break;
 302
 303     case ACPI_TYPE_BUFFER:
 304         Info->BufferCount++;
 305         break;
 306
 307     case ACPI_TYPE_PACKAGE:
 308         Info->PackageCount++;
 309         break;
 310
 311     default:
 312
 313         /* No init required, just exit now */
 314         return (AE_OK);
 315     }
 316
 317     /*
 318      * If the object is already initialized, nothing else to do
 319      */
 320     if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
 321     {
 322         return (AE_OK);
 323     }
 324
 325     /*
 326      * Must lock the interpreter before executing AML code
 327      */
 328     Status = AcpiExEnterInterpreter ();
 329     if (ACPI_FAILURE (Status))
 330     {
 331         return (Status);
 332     }
 333
 334     /*
 335      * Each of these types can contain executable AML code within
 336      * the declaration.
 337      */
 338     switch (Type)
 339     {
 340     case ACPI_TYPE_REGION:
 341
 342         Info->OpRegionInit++;
 343         Status = AcpiDsGetRegionArguments (ObjDesc);
 344         break;
 345
 346
 347     case ACPI_TYPE_BUFFER_FIELD:
 348
 349         Info->FieldInit++;
 350         Status = AcpiDsGetBufferFieldArguments (ObjDesc);
 351         break;
 352
 353
 354     case ACPI_TYPE_BUFFER:
 355
 356         Info->BufferInit++;
 357         Status = AcpiDsGetBufferArguments (ObjDesc);
 358         break;
 359
 360
 361     case ACPI_TYPE_PACKAGE:
 362
 363         Info->PackageInit++;
 364         Status = AcpiDsGetPackageArguments (ObjDesc);
 365         break;
 366
 367     default:
 368         /* No other types can get here */
 369         break;
 370     }
 371
 372     if (ACPI_FAILURE (Status))
 373     {
 374         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_ERROR, "\n"));
 375         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
 376                 "Could not execute arguments for [%4.4s] (%s), %s\n",
 377                 Node->Name.Ascii, AcpiUtGetTypeName (Type), AcpiFormatException (Status)));
 378     }
 379
 380     /* Print a dot for each object unless we are going to print the entire pathname */
 381
 382     if (!(AcpiDbgLevel & ACPI_LV_INIT_NAMES))
 383     {
 384         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT, "."));
 385     }
 386
 387     /*
 388      * We ignore errors from above, and always return OK, since
 389      * we don't want to abort the walk on any single error.
 390      */
 391     AcpiExExitInterpreter ();
 392     return (AE_OK);
 393 }
 394
 395
 396 /*******************************************************************************
 397  *
 398  * FUNCTION:    AcpiNsInitOneDevice
 399  *
 400  * PARAMETERS:  ACPI_WALK_CALLBACK
 401  *
 402  * RETURN:      ACPI_STATUS
 403  *
 404  * DESCRIPTION: This is called once per device soon after ACPI is enabled
 405  *              to initialize each device. It determines if the device is
 406  *              present, and if so, calls _INI.
 407  *
 408  ******************************************************************************/
 409
 410 ACPI_STATUS
 411 AcpiNsInitOneDevice (
 412     ACPI_HANDLE             ObjHandle,
 413     UINT32                  NestingLevel,
 414     void                    *Context,
 415     void                    **ReturnValue)
 416 {
 417     ACPI_STATUS             Status;
 418     ACPI_NAMESPACE_NODE    *Node;
 419     UINT32                  Flags;
 420     ACPI_DEVICE_WALK_INFO  *Info = (ACPI_DEVICE_WALK_INFO *) Context;
 421
 422
 423     ACPI_FUNCTION_TRACE ("NsInitOneDevice");
 424
 425
 426     if ((AcpiDbgLevel <= ACPI_LV_ALL_EXCEPTIONS) && (!(AcpiDbgLevel & ACPI_LV_INFO)))
 427     {
 428         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT, "."));
 429     }
 430
 431     Info->DeviceCount++;
 432
 433     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 434     if (ACPI_FAILURE (Status))
 435     {
 436         return_ACPI_STATUS (Status);
 437     }
 438
 439     Node = AcpiNsMapHandleToNode (ObjHandle);
 440     if (!Node)
 441     {
 442         (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 443         return_ACPI_STATUS (AE_BAD_PARAMETER);
 444     }
 445
 446     Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 447     if (ACPI_FAILURE (Status))
 448     {
 449         return_ACPI_STATUS (Status);
 450     }
 451
 452     /*
 453      * Run _STA to determine if we can run _INI on the device.
 454      */
 455     ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (ACPI_TYPE_METHOD, Node, "_STA"));
 456     Status = AcpiUtExecute_STA (Node, &Flags);
 457     if (ACPI_FAILURE (Status))
 458     {
 459         /* Ignore error and move on to next device */
 460
 461         return_ACPI_STATUS (AE_OK);
 462     }
 463
 464     Info->Num_STA++;
 465
 466     if (!(Flags & 0x01))
 467     {
 468         /* don't look at children of a not present device */
 469
 470         return_ACPI_STATUS(AE_CTRL_DEPTH);
 471     }
 472
 473     /*
 474      * The device is present. Run _INI.
 475      */
 476     ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (ACPI_TYPE_METHOD, ObjHandle, "_INI"));
 477     Status = AcpiNsEvaluateRelative (ObjHandle, "_INI", NULL, NULL);
 478     if (ACPI_FAILURE (Status))
 479     {
 480         /* No _INI (AE_NOT_FOUND) means device requires no initialization */
 481
 482         if (Status != AE_NOT_FOUND)
 483         {
 484             /* Ignore error and move on to next device */
 485
 486     #ifdef ACPI_DEBUG_OUTPUT
 487             char        *ScopeName = AcpiNsGetExternalPathname (ObjHandle);
 488
 489             ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "%s._INI failed: %s\n",
 490                     ScopeName, AcpiFormatException (Status)));
 491
 492             ACPI_MEM_FREE (ScopeName);
 493     #endif
 494         }
 495
 496         Status = AE_OK;
 497     }
 498     else
 499     {
 500         /* Count of successful INIs */
 501
 502         Info->Num_INI++;
 503     }
 504
 505     if (AcpiGbl_InitHandler)
 506     {
 507         /* External initialization handler is present, call it */
 508
 509         Status = AcpiGbl_InitHandler (ObjHandle, ACPI_INIT_DEVICE_INI);
 510     }
 511
 512
 513     return_ACPI_STATUS (Status);
 514 }