xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/dispatcher/dswscope.c (revision fe2557b6eb55be3c2d36e1ee396e0f10e41bd214)
1 /******************************************************************************
2  *
3  * Module Name: dswscope - Scope stack manipulation
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 
120 
121 #define _COMPONENT          ACPI_DISPATCHER
122         ACPI_MODULE_NAME    ("dswscope")
123 
124 
125 /****************************************************************************
126  *
127  * FUNCTION:    AcpiDsScopeStackClear
128  *
129  * PARAMETERS:  WalkState       - Current state
130  *
131  * RETURN:      None
132  *
133  * DESCRIPTION: Pop (and free) everything on the scope stack except the
134  *              root scope object (which remains at the stack top.)
135  *
136  ***************************************************************************/
137 
138 void
139 AcpiDsScopeStackClear (
140     ACPI_WALK_STATE         *WalkState)
141 {
142     ACPI_GENERIC_STATE      *ScopeInfo;
143 
144     ACPI_FUNCTION_NAME (DsScopeStackClear);
145 
146 
147     while (WalkState->ScopeInfo)
148     {
149         /* Pop a scope off the stack */
150 
151         ScopeInfo = WalkState->ScopeInfo;
152         WalkState->ScopeInfo = ScopeInfo->Scope.Next;
153 
154         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
155             "Popped object type (%s)\n",
156             AcpiUtGetTypeName (ScopeInfo->Common.Value)));
157 
158         AcpiUtDeleteGenericState (ScopeInfo);
159     }
160 }
161 
162 
163 /****************************************************************************
164  *
165  * FUNCTION:    AcpiDsScopeStackPush
166  *
167  * PARAMETERS:  Node            - Name to be made current
168  *              Type            - Type of frame being pushed
169  *              WalkState       - Current state
170  *
171  * RETURN:      Status
172  *
173  * DESCRIPTION: Push the current scope on the scope stack, and make the
174  *              passed Node current.
175  *
176  ***************************************************************************/
177 
178 ACPI_STATUS
179 AcpiDsScopeStackPush (
180     ACPI_NAMESPACE_NODE     *Node,
181     ACPI_OBJECT_TYPE        Type,
182     ACPI_WALK_STATE         *WalkState)
183 {
184     ACPI_GENERIC_STATE      *ScopeInfo;
185     ACPI_GENERIC_STATE      *OldScopeInfo;
186 
187 
188     ACPI_FUNCTION_TRACE (DsScopeStackPush);
189 
190 
191     if (!Node)
192     {
193         /* Invalid scope   */
194 
195         ACPI_ERROR ((AE_INFO, "Null scope parameter"));
196         return_ACPI_STATUS (AE_BAD_PARAMETER);
197     }
198 
199     /* Make sure object type is valid */
200 
201     if (!AcpiUtValidObjectType (Type))
202     {
203         ACPI_WARNING ((AE_INFO,
204             "Invalid object type: 0x%X", Type));
205     }
206 
207     /* Allocate a new scope object */
208 
209     ScopeInfo = AcpiUtCreateGenericState ();
210     if (!ScopeInfo)
211     {
212         return_ACPI_STATUS (AE_NO_MEMORY);
213     }
214 
215     /* Init new scope object */
216 
217     ScopeInfo->Common.DescriptorType = ACPI_DESC_TYPE_STATE_WSCOPE;
218     ScopeInfo->Scope.Node = Node;
219     ScopeInfo->Common.Value = (UINT16) Type;
220 
221     WalkState->ScopeDepth++;
222 
223     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
224         "[%.2d] Pushed scope ", (UINT32) WalkState->ScopeDepth));
225 
226     OldScopeInfo = WalkState->ScopeInfo;
227     if (OldScopeInfo)
228     {
229         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
230             "[%4.4s] (%s)",
231             AcpiUtGetNodeName (OldScopeInfo->Scope.Node),
232             AcpiUtGetTypeName (OldScopeInfo->Common.Value)));
233     }
234     else
235     {
236         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
237             "[\\___] (%s)", "ROOT"));
238     }
239 
240     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
241         ", New scope -> [%4.4s] (%s)\n",
242         AcpiUtGetNodeName (ScopeInfo->Scope.Node),
243         AcpiUtGetTypeName (ScopeInfo->Common.Value)));
244 
245     /* Push new scope object onto stack */
246 
247     AcpiUtPushGenericState (&WalkState->ScopeInfo, ScopeInfo);
248     return_ACPI_STATUS (AE_OK);
249 }
250 
251 
252 /****************************************************************************
253  *
254  * FUNCTION:    AcpiDsScopeStackPop
255  *
256  * PARAMETERS:  WalkState       - Current state
257  *
258  * RETURN:      Status
259  *
260  * DESCRIPTION: Pop the scope stack once.
261  *
262  ***************************************************************************/
263 
264 ACPI_STATUS
265 AcpiDsScopeStackPop (
266     ACPI_WALK_STATE         *WalkState)
267 {
268     ACPI_GENERIC_STATE      *ScopeInfo;
269     ACPI_GENERIC_STATE      *NewScopeInfo;
270 
271 
272     ACPI_FUNCTION_TRACE (DsScopeStackPop);
273 
274 
275     /*
276      * Pop scope info object off the stack.
277      */
278     ScopeInfo = AcpiUtPopGenericState (&WalkState->ScopeInfo);
279     if (!ScopeInfo)
280     {
281         return_ACPI_STATUS (AE_STACK_UNDERFLOW);
282     }
283 
284     WalkState->ScopeDepth--;
285 
286     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
287         "[%.2d] Popped scope [%4.4s] (%s), New scope -> ",
288         (UINT32) WalkState->ScopeDepth,
289         AcpiUtGetNodeName (ScopeInfo->Scope.Node),
290         AcpiUtGetTypeName (ScopeInfo->Common.Value)));
291 
292     NewScopeInfo = WalkState->ScopeInfo;
293     if (NewScopeInfo)
294     {
295         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
296             "[%4.4s] (%s)\n",
297             AcpiUtGetNodeName (NewScopeInfo->Scope.Node),
298             AcpiUtGetTypeName (NewScopeInfo->Common.Value)));
299     }
300     else
301     {
302         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
303             "[\\___] (ROOT)\n"));
304     }
305 
306     AcpiUtDeleteGenericState (ScopeInfo);
307     return_ACPI_STATUS (AE_OK);
308 }
309