1/******************************************************************************
2 *
3 * Module Name: dswscope - Scope stack manipulation
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2007, R. Byron Moore
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions, and the following disclaimer,
16 *    without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 *    substantially similar to the "NO WARRANTY" disclaimer below
19 *    ("Disclaimer") and any redistribution must be conditioned upon
20 *    including a substantially similar Disclaimer requirement for further
21 *    binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 *    of any contributors may be used to endorse or promote products derived
24 *    from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
44#include <acpi/acpi.h>
45#include <acpi/acdispat.h>
46
47#define _COMPONENT          ACPI_DISPATCHER
48ACPI_MODULE_NAME("dswscope")
49
50/****************************************************************************
51 *
52 * FUNCTION:    acpi_ds_scope_stack_clear
53 *
54 * PARAMETERS:  walk_state      - Current state
55 *
56 * RETURN:      None
57 *
58 * DESCRIPTION: Pop (and free) everything on the scope stack except the
59 *              root scope object (which remains at the stack top.)
60 *
61 ***************************************************************************/
62void acpi_ds_scope_stack_clear(struct acpi_walk_state *walk_state)
63{
64	union acpi_generic_state *scope_info;
65
66	ACPI_FUNCTION_NAME(ds_scope_stack_clear);
67
68	while (walk_state->scope_info) {
69
70		/* Pop a scope off the stack */
71
72		scope_info = walk_state->scope_info;
73		walk_state->scope_info = scope_info->scope.next;
74
75		ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
76				  "Popped object type (%s)\n",
77				  acpi_ut_get_type_name(scope_info->common.
78							value)));
79		acpi_ut_delete_generic_state(scope_info);
80	}
81}
82
83/****************************************************************************
84 *
85 * FUNCTION:    acpi_ds_scope_stack_push
86 *
87 * PARAMETERS:  Node            - Name to be made current
88 *              Type            - Type of frame being pushed
89 *              walk_state      - Current state
90 *
91 * RETURN:      Status
92 *
93 * DESCRIPTION: Push the current scope on the scope stack, and make the
94 *              passed Node current.
95 *
96 ***************************************************************************/
97
98acpi_status
99acpi_ds_scope_stack_push(struct acpi_namespace_node *node,
100			 acpi_object_type type,
101			 struct acpi_walk_state *walk_state)
102{
103	union acpi_generic_state *scope_info;
104	union acpi_generic_state *old_scope_info;
105
106	ACPI_FUNCTION_TRACE(ds_scope_stack_push);
107
108	if (!node) {
109
110		/* Invalid scope   */
111
112		ACPI_ERROR((AE_INFO, "Null scope parameter"));
113		return_ACPI_STATUS(AE_BAD_PARAMETER);
114	}
115
116	/* Make sure object type is valid */
117
118	if (!acpi_ut_valid_object_type(type)) {
119		ACPI_WARNING((AE_INFO, "Invalid object type: 0x%X", type));
120	}
121
122	/* Allocate a new scope object */
123
124	scope_info = acpi_ut_create_generic_state();
125	if (!scope_info) {
126		return_ACPI_STATUS(AE_NO_MEMORY);
127	}
128
129	/* Init new scope object */
130
131	scope_info->common.descriptor_type = ACPI_DESC_TYPE_STATE_WSCOPE;
132	scope_info->scope.node = node;
133	scope_info->common.value = (u16) type;
134
135	walk_state->scope_depth++;
136
137	ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
138			  "[%.2d] Pushed scope ",
139			  (u32) walk_state->scope_depth));
140
141	old_scope_info = walk_state->scope_info;
142	if (old_scope_info) {
143		ACPI_DEBUG_PRINT_RAW((ACPI_DB_EXEC,
144				      "[%4.4s] (%s)",
145				      acpi_ut_get_node_name(old_scope_info->
146							    scope.node),
147				      acpi_ut_get_type_name(old_scope_info->
148							    common.value)));
149	} else {
150		ACPI_DEBUG_PRINT_RAW((ACPI_DB_EXEC, "[\\___] (%s)", "ROOT"));
151	}
152
153	ACPI_DEBUG_PRINT_RAW((ACPI_DB_EXEC,
154			      ", New scope -> [%4.4s] (%s)\n",
155			      acpi_ut_get_node_name(scope_info->scope.node),
156			      acpi_ut_get_type_name(scope_info->common.value)));
157
158	/* Push new scope object onto stack */
159
160	acpi_ut_push_generic_state(&walk_state->scope_info, scope_info);
161	return_ACPI_STATUS(AE_OK);
162}
163
164/****************************************************************************
165 *
166 * FUNCTION:    acpi_ds_scope_stack_pop
167 *
168 * PARAMETERS:  walk_state      - Current state
169 *
170 * RETURN:      Status
171 *
172 * DESCRIPTION: Pop the scope stack once.
173 *
174 ***************************************************************************/
175
176acpi_status acpi_ds_scope_stack_pop(struct acpi_walk_state *walk_state)
177{
178	union acpi_generic_state *scope_info;
179	union acpi_generic_state *new_scope_info;
180
181	ACPI_FUNCTION_TRACE(ds_scope_stack_pop);
182
183	/*
184	 * Pop scope info object off the stack.
185	 */
186	scope_info = acpi_ut_pop_generic_state(&walk_state->scope_info);
187	if (!scope_info) {
188		return_ACPI_STATUS(AE_STACK_UNDERFLOW);
189	}
190
191	walk_state->scope_depth--;
192
193	ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
194			  "[%.2d] Popped scope [%4.4s] (%s), New scope -> ",
195			  (u32) walk_state->scope_depth,
196			  acpi_ut_get_node_name(scope_info->scope.node),
197			  acpi_ut_get_type_name(scope_info->common.value)));
198
199	new_scope_info = walk_state->scope_info;
200	if (new_scope_info) {
201		ACPI_DEBUG_PRINT_RAW((ACPI_DB_EXEC,
202				      "[%4.4s] (%s)\n",
203				      acpi_ut_get_node_name(new_scope_info->
204							    scope.node),
205				      acpi_ut_get_type_name(new_scope_info->
206							    common.value)));
207	} else {
208		ACPI_DEBUG_PRINT_RAW((ACPI_DB_EXEC, "[\\___] (ROOT)\n"));
209	}
210
211	acpi_ut_delete_generic_state(scope_info);
212	return_ACPI_STATUS(AE_OK);
213}
214