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