1 /*******************************************************************************
3 * Module Name: utstate - state object support procedures
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2005, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
46 #define _COMPONENT ACPI_UTILITIES
47 ACPI_MODULE_NAME("utstate")
49 /*******************************************************************************
51 * FUNCTION: acpi_ut_create_pkg_state_and_push
53 * PARAMETERS: Object - Object to be added to the new state
54 * Action - Increment/Decrement
55 * state_list - List the state will be added to
59 * DESCRIPTION: Create a new state and push it
61 ******************************************************************************/
63 acpi_ut_create_pkg_state_and_push(void *internal_object
,
64 void *external_object
,
66 union acpi_generic_state
** state_list
)
68 union acpi_generic_state
*state
;
70 ACPI_FUNCTION_ENTRY();
73 acpi_ut_create_pkg_state(internal_object
, external_object
, index
);
75 return (AE_NO_MEMORY
);
78 acpi_ut_push_generic_state(state_list
, state
);
82 /*******************************************************************************
84 * FUNCTION: acpi_ut_push_generic_state
86 * PARAMETERS: list_head - Head of the state stack
87 * State - State object to push
91 * DESCRIPTION: Push a state object onto a state stack
93 ******************************************************************************/
96 acpi_ut_push_generic_state(union acpi_generic_state
**list_head
,
97 union acpi_generic_state
*state
)
99 ACPI_FUNCTION_TRACE("ut_push_generic_state");
101 /* Push the state object onto the front of the list (stack) */
103 state
->common
.next
= *list_head
;
109 /*******************************************************************************
111 * FUNCTION: acpi_ut_pop_generic_state
113 * PARAMETERS: list_head - Head of the state stack
115 * RETURN: The popped state object
117 * DESCRIPTION: Pop a state object from a state stack
119 ******************************************************************************/
121 union acpi_generic_state
*acpi_ut_pop_generic_state(union acpi_generic_state
124 union acpi_generic_state
*state
;
126 ACPI_FUNCTION_TRACE("ut_pop_generic_state");
128 /* Remove the state object at the head of the list (stack) */
132 /* Update the list head */
134 *list_head
= state
->common
.next
;
140 /*******************************************************************************
142 * FUNCTION: acpi_ut_create_generic_state
146 * RETURN: The new state object. NULL on failure.
148 * DESCRIPTION: Create a generic state object. Attempt to obtain one from
149 * the global state cache; If none available, create a new one.
151 ******************************************************************************/
153 union acpi_generic_state
*acpi_ut_create_generic_state(void)
155 union acpi_generic_state
*state
;
157 ACPI_FUNCTION_ENTRY();
159 state
= acpi_os_acquire_object(acpi_gbl_state_cache
);
162 memset(state
, 0, sizeof(union acpi_generic_state
));
163 state
->common
.data_type
= ACPI_DESC_TYPE_STATE
;
169 /*******************************************************************************
171 * FUNCTION: acpi_ut_create_thread_state
175 * RETURN: New Thread State. NULL on failure
177 * DESCRIPTION: Create a "Thread State" - a flavor of the generic state used
178 * to track per-thread info during method execution
180 ******************************************************************************/
182 struct acpi_thread_state
*acpi_ut_create_thread_state(void)
184 union acpi_generic_state
*state
;
186 ACPI_FUNCTION_TRACE("ut_create_thread_state");
188 /* Create the generic state object */
190 state
= acpi_ut_create_generic_state();
195 /* Init fields specific to the update struct */
197 state
->common
.data_type
= ACPI_DESC_TYPE_STATE_THREAD
;
198 state
->thread
.thread_id
= acpi_os_get_thread_id();
200 return_PTR((struct acpi_thread_state
*)state
);
203 /*******************************************************************************
205 * FUNCTION: acpi_ut_create_update_state
207 * PARAMETERS: Object - Initial Object to be installed in the state
208 * Action - Update action to be performed
210 * RETURN: New state object, null on failure
212 * DESCRIPTION: Create an "Update State" - a flavor of the generic state used
213 * to update reference counts and delete complex objects such
216 ******************************************************************************/
218 union acpi_generic_state
*acpi_ut_create_update_state(union acpi_operand_object
221 union acpi_generic_state
*state
;
223 ACPI_FUNCTION_TRACE_PTR("ut_create_update_state", object
);
225 /* Create the generic state object */
227 state
= acpi_ut_create_generic_state();
232 /* Init fields specific to the update struct */
234 state
->common
.data_type
= ACPI_DESC_TYPE_STATE_UPDATE
;
235 state
->update
.object
= object
;
236 state
->update
.value
= action
;
241 /*******************************************************************************
243 * FUNCTION: acpi_ut_create_pkg_state
245 * PARAMETERS: Object - Initial Object to be installed in the state
246 * Action - Update action to be performed
248 * RETURN: New state object, null on failure
250 * DESCRIPTION: Create a "Package State"
252 ******************************************************************************/
254 union acpi_generic_state
*acpi_ut_create_pkg_state(void *internal_object
,
255 void *external_object
,
258 union acpi_generic_state
*state
;
260 ACPI_FUNCTION_TRACE_PTR("ut_create_pkg_state", internal_object
);
262 /* Create the generic state object */
264 state
= acpi_ut_create_generic_state();
269 /* Init fields specific to the update struct */
271 state
->common
.data_type
= ACPI_DESC_TYPE_STATE_PACKAGE
;
272 state
->pkg
.source_object
= (union acpi_operand_object
*)internal_object
;
273 state
->pkg
.dest_object
= external_object
;
274 state
->pkg
.index
= index
;
275 state
->pkg
.num_packages
= 1;
280 /*******************************************************************************
282 * FUNCTION: acpi_ut_create_control_state
286 * RETURN: New state object, null on failure
288 * DESCRIPTION: Create a "Control State" - a flavor of the generic state used
289 * to support nested IF/WHILE constructs in the AML.
291 ******************************************************************************/
293 union acpi_generic_state
*acpi_ut_create_control_state(void)
295 union acpi_generic_state
*state
;
297 ACPI_FUNCTION_TRACE("ut_create_control_state");
299 /* Create the generic state object */
301 state
= acpi_ut_create_generic_state();
306 /* Init fields specific to the control struct */
308 state
->common
.data_type
= ACPI_DESC_TYPE_STATE_CONTROL
;
309 state
->common
.state
= ACPI_CONTROL_CONDITIONAL_EXECUTING
;
314 /*******************************************************************************
316 * FUNCTION: acpi_ut_delete_generic_state
318 * PARAMETERS: State - The state object to be deleted
322 * DESCRIPTION: Put a state object back into the global state cache. The object
323 * is not actually freed at this time.
325 ******************************************************************************/
327 void acpi_ut_delete_generic_state(union acpi_generic_state
*state
)
329 ACPI_FUNCTION_TRACE("ut_delete_generic_state");
331 (void)acpi_os_release_object(acpi_gbl_state_cache
, state
);