src/add-ons/kernel/bus_managers/acpi/acpica/components/dispatcher/dsinit.c

   1 /******************************************************************************
   2  *
   3  * Module Name: dsinit - Object initialization namespace walk
   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 #define __DSINIT_C__
 117
 118 #include "acpi.h"
 119 #include "accommon.h"
 120 #include "acdispat.h"
 121 #include "acnamesp.h"
 122 #include "actables.h"
 123
 124 #define _COMPONENT          ACPI_DISPATCHER
 125         ACPI_MODULE_NAME    ("dsinit")
 126
 127
 128 /* Local prototypes */
 129
 130 static ACPI_STATUS
 131 AcpiDsInitOneObject (
 132     ACPI_HANDLE             ObjHandle,
 133     UINT32                  Level,
 134     void                    *Context,
 135     void                    **ReturnValue);
 136
 137
 138 /*******************************************************************************
 139  *
 140  * FUNCTION:    AcpiDsInitOneObject
 141  *
 142  * PARAMETERS:  ObjHandle       - Node for the object
 143  *              Level           - Current nesting level
 144  *              Context         - Points to a init info struct
 145  *              ReturnValue     - Not used
 146  *
 147  * RETURN:      Status
 148  *
 149  * DESCRIPTION: Callback from AcpiWalkNamespace. Invoked for every object
 150  *              within the namespace.
 151  *
 152  *              Currently, the only objects that require initialization are:
 153  *              1) Methods
 154  *              2) Operation Regions
 155  *
 156  ******************************************************************************/
 157
 158 static ACPI_STATUS
 159 AcpiDsInitOneObject (
 160     ACPI_HANDLE             ObjHandle,
 161     UINT32                  Level,
 162     void                    *Context,
 163     void                    **ReturnValue)
 164 {
 165     ACPI_INIT_WALK_INFO     *Info = (ACPI_INIT_WALK_INFO *) Context;
 166     ACPI_NAMESPACE_NODE     *Node = (ACPI_NAMESPACE_NODE *) ObjHandle;
 167     ACPI_STATUS             Status;
 168     ACPI_OPERAND_OBJECT     *ObjDesc;
 169
 170
 171     ACPI_FUNCTION_ENTRY ();
 172
 173
 174     /*
 175      * We are only interested in NS nodes owned by the table that
 176      * was just loaded
 177      */
 178     if (Node->OwnerId != Info->OwnerId)
 179     {
 180         return (AE_OK);
 181     }
 182
 183     Info->ObjectCount++;
 184
 185     /* And even then, we are only interested in a few object types */
 186
 187     switch (AcpiNsGetType (ObjHandle))
 188     {
 189     case ACPI_TYPE_REGION:
 190
 191         Status = AcpiDsInitializeRegion (ObjHandle);
 192         if (ACPI_FAILURE (Status))
 193         {
 194             ACPI_EXCEPTION ((AE_INFO, Status,
 195                 "During Region initialization %p [%4.4s]",
 196                 ObjHandle, AcpiUtGetNodeName (ObjHandle)));
 197         }
 198
 199         Info->OpRegionCount++;
 200         break;
 201
 202     case ACPI_TYPE_METHOD:
 203         /*
 204          * Auto-serialization support. We will examine each method that is
 205          * NotSerialized to determine if it creates any Named objects. If
 206          * it does, it will be marked serialized to prevent problems if
 207          * the method is entered by two or more threads and an attempt is
 208          * made to create the same named object twice -- which results in
 209          * an AE_ALREADY_EXISTS exception and method abort.
 210          */
 211         Info->MethodCount++;
 212         ObjDesc = AcpiNsGetAttachedObject (Node);
 213         if (!ObjDesc)
 214         {
 215             break;
 216         }
 217
 218         /* Ignore if already serialized */
 219
 220         if (ObjDesc->Method.InfoFlags & ACPI_METHOD_SERIALIZED)
 221         {
 222             Info->SerialMethodCount++;
 223             break;
 224         }
 225
 226         if (AcpiGbl_AutoSerializeMethods)
 227         {
 228             /* Parse/scan method and serialize it if necessary */
 229
 230             AcpiDsAutoSerializeMethod (Node, ObjDesc);
 231             if (ObjDesc->Method.InfoFlags & ACPI_METHOD_SERIALIZED)
 232             {
 233                 /* Method was just converted to Serialized */
 234
 235                 Info->SerialMethodCount++;
 236                 Info->SerializedMethodCount++;
 237                 break;
 238             }
 239         }
 240
 241         Info->NonSerialMethodCount++;
 242         break;
 243
 244     case ACPI_TYPE_DEVICE:
 245
 246         Info->DeviceCount++;
 247         break;
 248
 249     default:
 250
 251         break;
 252     }
 253
 254     /*
 255      * We ignore errors from above, and always return OK, since
 256      * we don't want to abort the walk on a single error.
 257      */
 258     return (AE_OK);
 259 }
 260
 261
 262 /*******************************************************************************
 263  *
 264  * FUNCTION:    AcpiDsInitializeObjects
 265  *
 266  * PARAMETERS:  TableDesc       - Descriptor for parent ACPI table
 267  *              StartNode       - Root of subtree to be initialized.
 268  *
 269  * RETURN:      Status
 270  *
 271  * DESCRIPTION: Walk the namespace starting at "StartNode" and perform any
 272  *              necessary initialization on the objects found therein
 273  *
 274  ******************************************************************************/
 275
 276 ACPI_STATUS
 277 AcpiDsInitializeObjects (
 278     UINT32                  TableIndex,
 279     ACPI_NAMESPACE_NODE     *StartNode)
 280 {
 281     ACPI_STATUS             Status;
 282     ACPI_INIT_WALK_INFO     Info;
 283     ACPI_TABLE_HEADER       *Table;
 284     ACPI_OWNER_ID           OwnerId;
 285
 286
 287     ACPI_FUNCTION_TRACE (DsInitializeObjects);
 288
 289
 290     Status = AcpiTbGetOwnerId (TableIndex, &OwnerId);
 291     if (ACPI_FAILURE (Status))
 292     {
 293         return_ACPI_STATUS (Status);
 294     }
 295
 296     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
 297         "**** Starting initialization of namespace objects ****\n"));
 298
 299     /* Set all init info to zero */
 300
 301     ACPI_MEMSET (&Info, 0, sizeof (ACPI_INIT_WALK_INFO));
 302
 303     Info.OwnerId = OwnerId;
 304     Info.TableIndex = TableIndex;
 305
 306     /* Walk entire namespace from the supplied root */
 307
 308     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 309     if (ACPI_FAILURE (Status))
 310     {
 311         return_ACPI_STATUS (Status);
 312     }
 313
 314     /*
 315      * We don't use AcpiWalkNamespace since we do not want to acquire
 316      * the namespace reader lock.
 317      */
 318     Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, StartNode, ACPI_UINT32_MAX,
 319                 ACPI_NS_WALK_UNLOCK, AcpiDsInitOneObject, NULL, &Info, NULL);
 320     if (ACPI_FAILURE (Status))
 321     {
 322         ACPI_EXCEPTION ((AE_INFO, Status, "During WalkNamespace"));
 323     }
 324     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 325
 326     Status = AcpiGetTableByIndex (TableIndex, &Table);
 327     if (ACPI_FAILURE (Status))
 328     {
 329         return_ACPI_STATUS (Status);
 330     }
 331
 332     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
 333         "Table [%4.4s] (id %4.4X) - %4u Objects with %3u Devices, "
 334         "%3u Regions, %3u Methods (%u/%u/%u Serial/Non/Cvt)\n",
 335         Table->Signature, OwnerId, Info.ObjectCount, Info.DeviceCount,
 336         Info.OpRegionCount, Info.MethodCount, Info.SerialMethodCount,
 337         Info.NonSerialMethodCount, Info.SerializedMethodCount));
 338
 339     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "%u Methods, %u Regions\n",
 340         Info.MethodCount, Info.OpRegionCount));
 341
 342     return_ACPI_STATUS (AE_OK);
 343 }