PRCM: 34XX: Fix wrong shift value used in dpll4_m4x2_ck enable bit
[linux-ginger.git] / drivers / acpi / utilities / utstate.c
blob63a6d3d77d88fc0c4e9de3105904a2a4302c278c
1 /*******************************************************************************
3 * Module Name: utstate - state object support procedures
5 ******************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2008, Intel Corp.
9 * All rights reserved.
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.
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.
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.
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
57 * RETURN: Status
59 * DESCRIPTION: Create a new state and push it
61 ******************************************************************************/
62 acpi_status
63 acpi_ut_create_pkg_state_and_push(void *internal_object,
64 void *external_object,
65 u16 index,
66 union acpi_generic_state **state_list)
68 union acpi_generic_state *state;
70 ACPI_FUNCTION_ENTRY();
72 state =
73 acpi_ut_create_pkg_state(internal_object, external_object, index);
74 if (!state) {
75 return (AE_NO_MEMORY);
78 acpi_ut_push_generic_state(state_list, state);
79 return (AE_OK);
82 /*******************************************************************************
84 * FUNCTION: acpi_ut_push_generic_state
86 * PARAMETERS: list_head - Head of the state stack
87 * State - State object to push
89 * RETURN: None
91 * DESCRIPTION: Push a state object onto a state stack
93 ******************************************************************************/
95 void
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;
104 *list_head = state;
106 return_VOID;
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
122 **list_head)
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) */
130 state = *list_head;
131 if (state) {
133 /* Update the list head */
135 *list_head = state->common.next;
138 return_PTR(state);
141 /*******************************************************************************
143 * FUNCTION: acpi_ut_create_generic_state
145 * PARAMETERS: None
147 * RETURN: The new state object. NULL on failure.
149 * DESCRIPTION: Create a generic state object. Attempt to obtain one from
150 * the global state cache; If none available, create a new one.
152 ******************************************************************************/
154 union acpi_generic_state *acpi_ut_create_generic_state(void)
156 union acpi_generic_state *state;
158 ACPI_FUNCTION_ENTRY();
160 state = acpi_os_acquire_object(acpi_gbl_state_cache);
161 if (state) {
163 /* Initialize */
164 memset(state, 0, sizeof(union acpi_generic_state));
165 state->common.descriptor_type = ACPI_DESC_TYPE_STATE;
168 return (state);
171 /*******************************************************************************
173 * FUNCTION: acpi_ut_create_thread_state
175 * PARAMETERS: None
177 * RETURN: New Thread State. NULL on failure
179 * DESCRIPTION: Create a "Thread State" - a flavor of the generic state used
180 * to track per-thread info during method execution
182 ******************************************************************************/
184 struct acpi_thread_state *acpi_ut_create_thread_state(void)
186 union acpi_generic_state *state;
188 ACPI_FUNCTION_TRACE(ut_create_thread_state);
190 /* Create the generic state object */
192 state = acpi_ut_create_generic_state();
193 if (!state) {
194 return_PTR(NULL);
197 /* Init fields specific to the update struct */
199 state->common.descriptor_type = ACPI_DESC_TYPE_STATE_THREAD;
200 state->thread.thread_id = acpi_os_get_thread_id();
202 /* Check for invalid thread ID - zero is very bad, it will break things */
204 if (!state->thread.thread_id) {
205 ACPI_ERROR((AE_INFO, "Invalid zero ID from AcpiOsGetThreadId"));
206 state->thread.thread_id = (acpi_thread_id) 1;
209 return_PTR((struct acpi_thread_state *)state);
212 /*******************************************************************************
214 * FUNCTION: acpi_ut_create_update_state
216 * PARAMETERS: Object - Initial Object to be installed in the state
217 * Action - Update action to be performed
219 * RETURN: New state object, null on failure
221 * DESCRIPTION: Create an "Update State" - a flavor of the generic state used
222 * to update reference counts and delete complex objects such
223 * as packages.
225 ******************************************************************************/
227 union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
228 *object, u16 action)
230 union acpi_generic_state *state;
232 ACPI_FUNCTION_TRACE_PTR(ut_create_update_state, object);
234 /* Create the generic state object */
236 state = acpi_ut_create_generic_state();
237 if (!state) {
238 return_PTR(NULL);
241 /* Init fields specific to the update struct */
243 state->common.descriptor_type = ACPI_DESC_TYPE_STATE_UPDATE;
244 state->update.object = object;
245 state->update.value = action;
247 return_PTR(state);
250 /*******************************************************************************
252 * FUNCTION: acpi_ut_create_pkg_state
254 * PARAMETERS: Object - Initial Object to be installed in the state
255 * Action - Update action to be performed
257 * RETURN: New state object, null on failure
259 * DESCRIPTION: Create a "Package State"
261 ******************************************************************************/
263 union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
264 void *external_object,
265 u16 index)
267 union acpi_generic_state *state;
269 ACPI_FUNCTION_TRACE_PTR(ut_create_pkg_state, internal_object);
271 /* Create the generic state object */
273 state = acpi_ut_create_generic_state();
274 if (!state) {
275 return_PTR(NULL);
278 /* Init fields specific to the update struct */
280 state->common.descriptor_type = ACPI_DESC_TYPE_STATE_PACKAGE;
281 state->pkg.source_object = (union acpi_operand_object *)internal_object;
282 state->pkg.dest_object = external_object;
283 state->pkg.index = index;
284 state->pkg.num_packages = 1;
286 return_PTR(state);
289 /*******************************************************************************
291 * FUNCTION: acpi_ut_create_control_state
293 * PARAMETERS: None
295 * RETURN: New state object, null on failure
297 * DESCRIPTION: Create a "Control State" - a flavor of the generic state used
298 * to support nested IF/WHILE constructs in the AML.
300 ******************************************************************************/
302 union acpi_generic_state *acpi_ut_create_control_state(void)
304 union acpi_generic_state *state;
306 ACPI_FUNCTION_TRACE(ut_create_control_state);
308 /* Create the generic state object */
310 state = acpi_ut_create_generic_state();
311 if (!state) {
312 return_PTR(NULL);
315 /* Init fields specific to the control struct */
317 state->common.descriptor_type = ACPI_DESC_TYPE_STATE_CONTROL;
318 state->common.state = ACPI_CONTROL_CONDITIONAL_EXECUTING;
320 return_PTR(state);
323 /*******************************************************************************
325 * FUNCTION: acpi_ut_delete_generic_state
327 * PARAMETERS: State - The state object to be deleted
329 * RETURN: None
331 * DESCRIPTION: Release a state object to the state cache. NULL state objects
332 * are ignored.
334 ******************************************************************************/
336 void acpi_ut_delete_generic_state(union acpi_generic_state *state)
338 ACPI_FUNCTION_TRACE(ut_delete_generic_state);
340 /* Ignore null state */
342 if (state) {
343 (void)acpi_os_release_object(acpi_gbl_state_cache, state);
345 return_VOID;