acpica/dispatcher/dsinit.c

0001 /******************************************************************************
0002  *
0003  * Module Name: dsinit - Object initialization namespace walk
0004  *
0005  *****************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #include "acpi.h"
0153 #include "accommon.h"
0154 #include "acdispat.h"
0155 #include "acnamesp.h"
0156 #include "actables.h"
0157 #include "acinterp.h"
0158
0159 #define _COMPONENT          ACPI_DISPATCHER
0160         ACPI_MODULE_NAME    ("dsinit")
0161
0162
0163 /* Local prototypes */
0164
0165 static ACPI_STATUS
0166 AcpiDsInitOneObject (
0167     ACPI_HANDLE             ObjHandle,
0168     UINT32                  Level,
0169     void                    *Context,
0170     void                    **ReturnValue);
0171
0172
0173 /*******************************************************************************
0174  *
0175  * FUNCTION:    AcpiDsInitOneObject
0176  *
0177  * PARAMETERS:  ObjHandle       - Node for the object
0178  *              Level           - Current nesting level
0179  *              Context         - Points to a init info struct
0180  *              ReturnValue     - Not used
0181  *
0182  * RETURN:      Status
0183  *
0184  * DESCRIPTION: Callback from AcpiWalkNamespace. Invoked for every object
0185  *              within the namespace.
0186  *
0187  *              Currently, the only objects that require initialization are:
0188  *              1) Methods
0189  *              2) Operation Regions
0190  *
0191  ******************************************************************************/
0192
0193 static ACPI_STATUS
0194 AcpiDsInitOneObject (
0195     ACPI_HANDLE             ObjHandle,
0196     UINT32                  Level,
0197     void                    *Context,
0198     void                    **ReturnValue)
0199 {
0200     ACPI_INIT_WALK_INFO     *Info = (ACPI_INIT_WALK_INFO *) Context;
0201     ACPI_NAMESPACE_NODE     *Node = (ACPI_NAMESPACE_NODE *) ObjHandle;
0202     ACPI_STATUS             Status;
0203     ACPI_OPERAND_OBJECT     *ObjDesc;
0204
0205
0206     ACPI_FUNCTION_ENTRY ();
0207
0208
0209     /*
0210      * We are only interested in NS nodes owned by the table that
0211      * was just loaded
0212      */
0213     if (Node->OwnerId != Info->OwnerId)
0214     {
0215         return (AE_OK);
0216     }
0217
0218     Info->ObjectCount++;
0219
0220     /* And even then, we are only interested in a few object types */
0221
0222     switch (AcpiNsGetType (ObjHandle))
0223     {
0224     case ACPI_TYPE_REGION:
0225
0226         Status = AcpiDsInitializeRegion (ObjHandle);
0227         if (ACPI_FAILURE (Status))
0228         {
0229             ACPI_EXCEPTION ((AE_INFO, Status,
0230                 "During Region initialization %p [%4.4s]",
0231                 ObjHandle, AcpiUtGetNodeName (ObjHandle)));
0232         }
0233
0234         Info->OpRegionCount++;
0235         break;
0236
0237     case ACPI_TYPE_METHOD:
0238         /*
0239          * Auto-serialization support. We will examine each method that is
0240          * NotSerialized to determine if it creates any Named objects. If
0241          * it does, it will be marked serialized to prevent problems if
0242          * the method is entered by two or more threads and an attempt is
0243          * made to create the same named object twice -- which results in
0244          * an AE_ALREADY_EXISTS exception and method abort.
0245          */
0246         Info->MethodCount++;
0247         ObjDesc = AcpiNsGetAttachedObject (Node);
0248         if (!ObjDesc)
0249         {
0250             break;
0251         }
0252
0253         /* Ignore if already serialized */
0254
0255         if (ObjDesc->Method.InfoFlags & ACPI_METHOD_SERIALIZED)
0256         {
0257             Info->SerialMethodCount++;
0258             break;
0259         }
0260
0261         if (AcpiGbl_AutoSerializeMethods)
0262         {
0263             /* Parse/scan method and serialize it if necessary */
0264
0265             AcpiDsAutoSerializeMethod (Node, ObjDesc);
0266             if (ObjDesc->Method.InfoFlags & ACPI_METHOD_SERIALIZED)
0267             {
0268                 /* Method was just converted to Serialized */
0269
0270                 Info->SerialMethodCount++;
0271                 Info->SerializedMethodCount++;
0272                 break;
0273             }
0274         }
0275
0276         Info->NonSerialMethodCount++;
0277         break;
0278
0279     case ACPI_TYPE_DEVICE:
0280
0281         Info->DeviceCount++;
0282         break;
0283
0284     default:
0285
0286         break;
0287     }
0288
0289     /*
0290      * We ignore errors from above, and always return OK, since
0291      * we don't want to abort the walk on a single error.
0292      */
0293     return (AE_OK);
0294 }
0295
0296
0297 /*******************************************************************************
0298  *
0299  * FUNCTION:    AcpiDsInitializeObjects
0300  *
0301  * PARAMETERS:  TableDesc       - Descriptor for parent ACPI table
0302  *              StartNode       - Root of subtree to be initialized.
0303  *
0304  * RETURN:      Status
0305  *
0306  * DESCRIPTION: Walk the namespace starting at "StartNode" and perform any
0307  *              necessary initialization on the objects found therein
0308  *
0309  ******************************************************************************/
0310
0311 ACPI_STATUS
0312 AcpiDsInitializeObjects (
0313     UINT32                  TableIndex,
0314     ACPI_NAMESPACE_NODE     *StartNode)
0315 {
0316     ACPI_STATUS             Status;
0317     ACPI_INIT_WALK_INFO     Info;
0318     ACPI_TABLE_HEADER       *Table;
0319     ACPI_OWNER_ID           OwnerId;
0320
0321
0322     ACPI_FUNCTION_TRACE (DsInitializeObjects);
0323
0324
0325     Status = AcpiTbGetOwnerId (TableIndex, &OwnerId);
0326     if (ACPI_FAILURE (Status))
0327     {
0328         return_ACPI_STATUS (Status);
0329     }
0330
0331     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
0332         "**** Starting initialization of namespace objects ****\n"));
0333
0334     /* Set all init info to zero */
0335
0336     memset (&Info, 0, sizeof (ACPI_INIT_WALK_INFO));
0337
0338     Info.OwnerId = OwnerId;
0339     Info.TableIndex = TableIndex;
0340
0341     /* Walk entire namespace from the supplied root */
0342
0343     /*
0344      * We don't use AcpiWalkNamespace since we do not want to acquire
0345      * the namespace reader lock.
0346      */
0347     Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, StartNode, ACPI_UINT32_MAX,
0348         ACPI_NS_WALK_NO_UNLOCK, AcpiDsInitOneObject, NULL, &Info, NULL);
0349     if (ACPI_FAILURE (Status))
0350     {
0351         ACPI_EXCEPTION ((AE_INFO, Status, "During WalkNamespace"));
0352     }
0353
0354     Status = AcpiGetTableByIndex (TableIndex, &Table);
0355     if (ACPI_FAILURE (Status))
0356     {
0357         return_ACPI_STATUS (Status);
0358     }
0359
0360     /* DSDT is always the first AML table */
0361
0362     if (ACPI_COMPARE_NAMESEG (Table->Signature, ACPI_SIG_DSDT))
0363     {
0364         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
0365             "\nACPI table initialization:\n"));
0366     }
0367
0368     /* Summary of objects initialized */
0369
0370     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
0371         "Table [%4.4s: %-8.8s] (id %.2X) - %4u Objects with %3u Devices, "
0372         "%3u Regions, %4u Methods (%u/%u/%u Serial/Non/Cvt)\n",
0373         Table->Signature, Table->OemTableId, OwnerId, Info.ObjectCount,
0374         Info.DeviceCount,Info.OpRegionCount, Info.MethodCount,
0375         Info.SerialMethodCount, Info.NonSerialMethodCount,
0376         Info.SerializedMethodCount));
0377
0378     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "%u Methods, %u Regions\n",
0379         Info.MethodCount, Info.OpRegionCount));
0380
0381     return_ACPI_STATUS (AE_OK);
0382 }