sys/contrib/dev/acpica-unix-20050211/interpreter/dispatcher/dsinit.c

   1 /******************************************************************************
   2  *
   3  * Module Name: dsinit - Object initialization namespace walk
   4  *              $Revision: 11 $
   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 #define __DSINIT_C__
 118
 119 #include "acpi.h"
 120 #include "acdispat.h"
 121 #include "acnamesp.h"
 122
 123 #define _COMPONENT          ACPI_DISPATCHER
 124         ACPI_MODULE_NAME    ("dsinit")
 125
 126
 127 /*******************************************************************************
 128  *
 129  * FUNCTION:    AcpiDsInitOneObject
 130  *
 131  * PARAMETERS:  ObjHandle       - Node
 132  *              Level           - Current nesting level
 133  *              Context         - Points to a init info struct
 134  *              ReturnValue     - Not used
 135  *
 136  * RETURN:      Status
 137  *
 138  * DESCRIPTION: Callback from AcpiWalkNamespace.  Invoked for every object
 139  *              within the namespace.
 140  *
 141  *              Currently, the only objects that require initialization are:
 142  *              1) Methods
 143  *              2) Operation Regions
 144  *
 145  ******************************************************************************/
 146
 147 ACPI_STATUS
 148 AcpiDsInitOneObject (
 149     ACPI_HANDLE             ObjHandle,
 150     UINT32                  Level,
 151     void                    *Context,
 152     void                    **ReturnValue)
 153 {
 154     ACPI_OBJECT_TYPE        Type;
 155     ACPI_STATUS             Status;
 156     ACPI_INIT_WALK_INFO     *Info = (ACPI_INIT_WALK_INFO *) Context;
 157
 158
 159     ACPI_FUNCTION_NAME ("DsInitOneObject");
 160
 161
 162     /*
 163      * We are only interested in objects owned by the table that
 164      * was just loaded
 165      */
 166     if (((ACPI_NAMESPACE_NODE *) ObjHandle)->OwnerId !=
 167             Info->TableDesc->TableId)
 168     {
 169         return (AE_OK);
 170     }
 171
 172     Info->ObjectCount++;
 173
 174     /* And even then, we are only interested in a few object types */
 175
 176     Type = AcpiNsGetType (ObjHandle);
 177
 178     switch (Type)
 179     {
 180     case ACPI_TYPE_REGION:
 181
 182         Status = AcpiDsInitializeRegion (ObjHandle);
 183         if (ACPI_FAILURE (Status))
 184         {
 185             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Region %p [%4.4s] - Init failure, %s\n",
 186                 ObjHandle, AcpiUtGetNodeName (ObjHandle),
 187                 AcpiFormatException (Status)));
 188         }
 189
 190         Info->OpRegionCount++;
 191         break;
 192
 193
 194     case ACPI_TYPE_METHOD:
 195
 196         Info->MethodCount++;
 197
 198         /* Print a dot for each method unless we are going to print the entire pathname */
 199
 200         if (!(AcpiDbgLevel & ACPI_LV_INIT_NAMES))
 201         {
 202             ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT, "."));
 203         }
 204
 205         /*
 206          * Set the execution data width (32 or 64) based upon the
 207          * revision number of the parent ACPI table.
 208          * TBD: This is really for possible future support of integer width
 209          * on a per-table basis. Currently, we just use a global for the width.
 210          */
 211         if (Info->TableDesc->Pointer->Revision == 1)
 212         {
 213             ((ACPI_NAMESPACE_NODE *) ObjHandle)->Flags |= ANOBJ_DATA_WIDTH_32;
 214         }
 215
 216         /*
 217          * Always parse methods to detect errors, we will delete
 218          * the parse tree below
 219          */
 220         Status = AcpiDsParseMethod (ObjHandle);
 221         if (ACPI_FAILURE (Status))
 222         {
 223             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Method %p [%4.4s] - parse failure, %s\n",
 224                 ObjHandle, AcpiUtGetNodeName (ObjHandle),
 225                 AcpiFormatException (Status)));
 226
 227             /* This parse failed, but we will continue parsing more methods */
 228
 229             break;
 230         }
 231
 232         /*
 233          * Delete the parse tree.  We simply re-parse the method
 234          * for every execution since there isn't much overhead
 235          */
 236         AcpiNsDeleteNamespaceSubtree (ObjHandle);
 237         AcpiNsDeleteNamespaceByOwner (((ACPI_NAMESPACE_NODE *) ObjHandle)->Object->Method.OwningId);
 238         break;
 239
 240
 241     case ACPI_TYPE_DEVICE:
 242
 243         Info->DeviceCount++;
 244         break;
 245
 246
 247     default:
 248         break;
 249     }
 250
 251     /*
 252      * We ignore errors from above, and always return OK, since
 253      * we don't want to abort the walk on a single error.
 254      */
 255     return (AE_OK);
 256 }
 257
 258
 259 /*******************************************************************************
 260  *
 261  * FUNCTION:    AcpiDsInitializeObjects
 262  *
 263  * PARAMETERS:  TableDesc       - Descriptor for parent ACPI table
 264  *              StartNode       - Root of subtree to be initialized.
 265  *
 266  * RETURN:      Status
 267  *
 268  * DESCRIPTION: Walk the namespace starting at "StartNode" and perform any
 269  *              necessary initialization on the objects found therein
 270  *
 271  ******************************************************************************/
 272
 273 ACPI_STATUS
 274 AcpiDsInitializeObjects (
 275     ACPI_TABLE_DESC         *TableDesc,
 276     ACPI_NAMESPACE_NODE     *StartNode)
 277 {
 278     ACPI_STATUS             Status;
 279     ACPI_INIT_WALK_INFO     Info;
 280
 281
 282     ACPI_FUNCTION_TRACE ("DsInitializeObjects");
 283
 284
 285     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
 286         "**** Starting initialization of namespace objects ****\n"));
 287     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT, "Parsing all Control Methods:"));
 288
 289     Info.MethodCount    = 0;
 290     Info.OpRegionCount  = 0;
 291     Info.ObjectCount    = 0;
 292     Info.DeviceCount    = 0;
 293     Info.TableDesc      = TableDesc;
 294
 295     /* Walk entire namespace from the supplied root */
 296
 297     Status = AcpiWalkNamespace (ACPI_TYPE_ANY, StartNode, ACPI_UINT32_MAX,
 298                     AcpiDsInitOneObject, &Info, NULL);
 299     if (ACPI_FAILURE (Status))
 300     {
 301         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "WalkNamespace failed, %s\n",
 302             AcpiFormatException (Status)));
 303     }
 304
 305     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
 306         "\nTable [%4.4s](id %4.4X) - %hd Objects with %hd Devices %hd Methods %hd Regions\n",
 307         TableDesc->Pointer->Signature, TableDesc->TableId, Info.ObjectCount,
 308         Info.DeviceCount, Info.MethodCount, Info.OpRegionCount));
 309
 310     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
 311         "%hd Methods, %hd Regions\n", Info.MethodCount, Info.OpRegionCount));
 312
 313     return_ACPI_STATUS (AE_OK);
 314 }
 315
 316