xref: /freebsd/sys/contrib/dev/acpica/components/dispatcher/dsinit.c (revision 722b16673c40aedf280895f2f2f676bb494518d7)
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 - 2023, 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  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acdispat.h>
155 #include <contrib/dev/acpica/include/acnamesp.h>
156 #include <contrib/dev/acpica/include/actables.h>
157 #include <contrib/dev/acpica/include/acinterp.h>
158 
159 #define _COMPONENT          ACPI_DISPATCHER
160         ACPI_MODULE_NAME    ("dsinit")
161 
162 
163 /* Local prototypes */
164 
165 static ACPI_STATUS
166 AcpiDsInitOneObject (
167     ACPI_HANDLE             ObjHandle,
168     UINT32                  Level,
169     void                    *Context,
170     void                    **ReturnValue);
171 
172 
173 /*******************************************************************************
174  *
175  * FUNCTION:    AcpiDsInitOneObject
176  *
177  * PARAMETERS:  ObjHandle       - Node for the object
178  *              Level           - Current nesting level
179  *              Context         - Points to a init info struct
180  *              ReturnValue     - Not used
181  *
182  * RETURN:      Status
183  *
184  * DESCRIPTION: Callback from AcpiWalkNamespace. Invoked for every object
185  *              within the namespace.
186  *
187  *              Currently, the only objects that require initialization are:
188  *              1) Methods
189  *              2) Operation Regions
190  *
191  ******************************************************************************/
192 
193 static ACPI_STATUS
AcpiDsInitOneObject(ACPI_HANDLE ObjHandle,UINT32 Level,void * Context,void ** ReturnValue)194 AcpiDsInitOneObject (
195     ACPI_HANDLE             ObjHandle,
196     UINT32                  Level,
197     void                    *Context,
198     void                    **ReturnValue)
199 {
200     ACPI_INIT_WALK_INFO     *Info = (ACPI_INIT_WALK_INFO *) Context;
201     ACPI_NAMESPACE_NODE     *Node = (ACPI_NAMESPACE_NODE *) ObjHandle;
202     ACPI_STATUS             Status;
203     ACPI_OPERAND_OBJECT     *ObjDesc;
204 
205 
206     ACPI_FUNCTION_ENTRY ();
207 
208 
209     /*
210      * We are only interested in NS nodes owned by the table that
211      * was just loaded
212      */
213     if (Node->OwnerId != Info->OwnerId)
214     {
215         return (AE_OK);
216     }
217 
218     Info->ObjectCount++;
219 
220     /* And even then, we are only interested in a few object types */
221 
222     switch (AcpiNsGetType (ObjHandle))
223     {
224     case ACPI_TYPE_REGION:
225 
226         Status = AcpiDsInitializeRegion (ObjHandle);
227         if (ACPI_FAILURE (Status))
228         {
229             ACPI_EXCEPTION ((AE_INFO, Status,
230                 "During Region initialization %p [%4.4s]",
231                 ObjHandle, AcpiUtGetNodeName (ObjHandle)));
232         }
233 
234         Info->OpRegionCount++;
235         break;
236 
237     case ACPI_TYPE_METHOD:
238         /*
239          * Auto-serialization support. We will examine each method that is
240          * NotSerialized to determine if it creates any Named objects. If
241          * it does, it will be marked serialized to prevent problems if
242          * the method is entered by two or more threads and an attempt is
243          * made to create the same named object twice -- which results in
244          * an AE_ALREADY_EXISTS exception and method abort.
245          */
246         Info->MethodCount++;
247         ObjDesc = AcpiNsGetAttachedObject (Node);
248         if (!ObjDesc)
249         {
250             break;
251         }
252 
253         /* Ignore if already serialized */
254 
255         if (ObjDesc->Method.InfoFlags & ACPI_METHOD_SERIALIZED)
256         {
257             Info->SerialMethodCount++;
258             break;
259         }
260 
261         if (AcpiGbl_AutoSerializeMethods)
262         {
263             /* Parse/scan method and serialize it if necessary */
264 
265             AcpiDsAutoSerializeMethod (Node, ObjDesc);
266             if (ObjDesc->Method.InfoFlags & ACPI_METHOD_SERIALIZED)
267             {
268                 /* Method was just converted to Serialized */
269 
270                 Info->SerialMethodCount++;
271                 Info->SerializedMethodCount++;
272                 break;
273             }
274         }
275 
276         Info->NonSerialMethodCount++;
277         break;
278 
279     case ACPI_TYPE_DEVICE:
280 
281         Info->DeviceCount++;
282         break;
283 
284     default:
285 
286         break;
287     }
288 
289     /*
290      * We ignore errors from above, and always return OK, since
291      * we don't want to abort the walk on a single error.
292      */
293     return (AE_OK);
294 }
295 
296 
297 /*******************************************************************************
298  *
299  * FUNCTION:    AcpiDsInitializeObjects
300  *
301  * PARAMETERS:  TableDesc       - Descriptor for parent ACPI table
302  *              StartNode       - Root of subtree to be initialized.
303  *
304  * RETURN:      Status
305  *
306  * DESCRIPTION: Walk the namespace starting at "StartNode" and perform any
307  *              necessary initialization on the objects found therein
308  *
309  ******************************************************************************/
310 
311 ACPI_STATUS
AcpiDsInitializeObjects(UINT32 TableIndex,ACPI_NAMESPACE_NODE * StartNode)312 AcpiDsInitializeObjects (
313     UINT32                  TableIndex,
314     ACPI_NAMESPACE_NODE     *StartNode)
315 {
316     ACPI_STATUS             Status;
317     ACPI_INIT_WALK_INFO     Info;
318     ACPI_TABLE_HEADER       *Table;
319     ACPI_OWNER_ID           OwnerId;
320 
321 
322     ACPI_FUNCTION_TRACE (DsInitializeObjects);
323 
324 
325     Status = AcpiTbGetOwnerId (TableIndex, &OwnerId);
326     if (ACPI_FAILURE (Status))
327     {
328         return_ACPI_STATUS (Status);
329     }
330 
331     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
332         "**** Starting initialization of namespace objects ****\n"));
333 
334     /* Set all init info to zero */
335 
336     memset (&Info, 0, sizeof (ACPI_INIT_WALK_INFO));
337 
338     Info.OwnerId = OwnerId;
339     Info.TableIndex = TableIndex;
340 
341     /* Walk entire namespace from the supplied root */
342 
343     /*
344      * We don't use AcpiWalkNamespace since we do not want to acquire
345      * the namespace reader lock.
346      */
347     Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, StartNode, ACPI_UINT32_MAX,
348         ACPI_NS_WALK_NO_UNLOCK, AcpiDsInitOneObject, NULL, &Info, NULL);
349     if (ACPI_FAILURE (Status))
350     {
351         ACPI_EXCEPTION ((AE_INFO, Status, "During WalkNamespace"));
352     }
353 
354     Status = AcpiGetTableByIndex (TableIndex, &Table);
355     if (ACPI_FAILURE (Status))
356     {
357         return_ACPI_STATUS (Status);
358     }
359 
360     /* DSDT is always the first AML table */
361 
362     if (ACPI_COMPARE_NAMESEG (Table->Signature, ACPI_SIG_DSDT))
363     {
364         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
365             "\nACPI table initialization:\n"));
366     }
367 
368     /* Summary of objects initialized */
369 
370     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
371         "Table [%4.4s: %-8.8s] (id %.2X) - %4u Objects with %3u Devices, "
372         "%3u Regions, %4u Methods (%u/%u/%u Serial/Non/Cvt)\n",
373         Table->Signature, Table->OemTableId, OwnerId, Info.ObjectCount,
374         Info.DeviceCount,Info.OpRegionCount, Info.MethodCount,
375         Info.SerialMethodCount, Info.NonSerialMethodCount,
376         Info.SerializedMethodCount));
377 
378     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "%u Methods, %u Regions\n",
379         Info.MethodCount, Info.OpRegionCount));
380 
381     return_ACPI_STATUS (AE_OK);
382 }
383