blob: e09a820ee2945495acbc892d85181c60b6c37aca [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Module Name: psxface - Parser external interfaces
4 *
5 *****************************************************************************/
6
7/*
Bob Moore4a90c7e2006-01-13 16:22:00 -05008 * Copyright (C) 2000 - 2006, R. Byron Moore
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <acpi/acpi.h>
45#include <acpi/acparser.h>
46#include <acpi/acdispat.h>
47#include <acpi/acinterp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
Linus Torvalds1da177e2005-04-16 15:20:36 -070049#define _COMPONENT ACPI_PARSER
Len Brown4be44fc2005-08-05 00:44:28 -040050ACPI_MODULE_NAME("psxface")
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Robert Moore0c9938c2005-07-29 15:15:00 -070052/* Local Prototypes */
Bob Moore50eca3e2005-09-30 19:03:00 -040053static void acpi_ps_start_trace(struct acpi_parameter_info *info);
54
55static void acpi_ps_stop_trace(struct acpi_parameter_info *info);
56
Len Brown4be44fc2005-08-05 00:44:28 -040057static acpi_status acpi_ps_execute_pass(struct acpi_parameter_info *info);
Robert Moore0c9938c2005-07-29 15:15:00 -070058
59static void
Len Brown4be44fc2005-08-05 00:44:28 -040060acpi_ps_update_parameter_list(struct acpi_parameter_info *info, u16 action);
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
62/*******************************************************************************
63 *
Bob Moore50eca3e2005-09-30 19:03:00 -040064 * FUNCTION: acpi_debug_trace
65 *
66 * PARAMETERS: method_name - Valid ACPI name string
67 * debug_level - Optional level mask. 0 to use default
68 * debug_layer - Optional layer mask. 0 to use default
69 * Flags - bit 1: one shot(1) or persistent(0)
70 *
71 * RETURN: Status
72 *
73 * DESCRIPTION: External interface to enable debug tracing during control
74 * method execution
75 *
76 ******************************************************************************/
77
78acpi_status
79acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags)
80{
81 acpi_status status;
82
83 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
84 if (ACPI_FAILURE(status)) {
85 return (status);
86 }
87
88 /* TBDs: Validate name, allow full path or just nameseg */
89
Bob Moorec51a4de2005-11-17 13:07:00 -050090 acpi_gbl_trace_method_name = *ACPI_CAST_PTR(u32, name);
Bob Moore50eca3e2005-09-30 19:03:00 -040091 acpi_gbl_trace_flags = flags;
92
93 if (debug_level) {
94 acpi_gbl_trace_dbg_level = debug_level;
95 }
96 if (debug_layer) {
97 acpi_gbl_trace_dbg_layer = debug_layer;
98 }
99
100 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
101 return (AE_OK);
102}
103
104/*******************************************************************************
105 *
106 * FUNCTION: acpi_ps_start_trace
107 *
108 * PARAMETERS: Info - Method info struct
109 *
110 * RETURN: None
111 *
112 * DESCRIPTION: Start control method execution trace
113 *
114 ******************************************************************************/
115
116static void acpi_ps_start_trace(struct acpi_parameter_info *info)
117{
118 acpi_status status;
119
120 ACPI_FUNCTION_ENTRY();
121
122 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
123 if (ACPI_FAILURE(status)) {
124 return;
125 }
126
127 if ((!acpi_gbl_trace_method_name) ||
128 (acpi_gbl_trace_method_name != info->node->name.integer)) {
129 goto exit;
130 }
131
132 acpi_gbl_original_dbg_level = acpi_dbg_level;
133 acpi_gbl_original_dbg_layer = acpi_dbg_layer;
134
135 acpi_dbg_level = 0x00FFFFFF;
136 acpi_dbg_layer = ACPI_UINT32_MAX;
137
138 if (acpi_gbl_trace_dbg_level) {
139 acpi_dbg_level = acpi_gbl_trace_dbg_level;
140 }
141 if (acpi_gbl_trace_dbg_layer) {
142 acpi_dbg_layer = acpi_gbl_trace_dbg_layer;
143 }
144
145 exit:
146 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
147}
148
149/*******************************************************************************
150 *
151 * FUNCTION: acpi_ps_stop_trace
152 *
153 * PARAMETERS: Info - Method info struct
154 *
155 * RETURN: None
156 *
157 * DESCRIPTION: Stop control method execution trace
158 *
159 ******************************************************************************/
160
161static void acpi_ps_stop_trace(struct acpi_parameter_info *info)
162{
163 acpi_status status;
164
165 ACPI_FUNCTION_ENTRY();
166
167 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
168 if (ACPI_FAILURE(status)) {
169 return;
170 }
171
172 if ((!acpi_gbl_trace_method_name) ||
173 (acpi_gbl_trace_method_name != info->node->name.integer)) {
174 goto exit;
175 }
176
177 /* Disable further tracing if type is one-shot */
178
179 if (acpi_gbl_trace_flags & 1) {
180 acpi_gbl_trace_method_name = 0;
181 acpi_gbl_trace_dbg_level = 0;
182 acpi_gbl_trace_dbg_layer = 0;
183 }
184
185 acpi_dbg_level = acpi_gbl_original_dbg_level;
186 acpi_dbg_layer = acpi_gbl_original_dbg_layer;
187
188 exit:
189 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
190}
191
192/*******************************************************************************
193 *
Robert Moore0c9938c2005-07-29 15:15:00 -0700194 * FUNCTION: acpi_ps_execute_method
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 *
Robert Moore44f6c012005-04-18 22:49:35 -0400196 * PARAMETERS: Info - Method info block, contains:
197 * Node - Method Node to execute
Robert Moore0c9938c2005-07-29 15:15:00 -0700198 * obj_desc - Method object
Robert Moore44f6c012005-04-18 22:49:35 -0400199 * Parameters - List of parameters to pass to the method,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 * terminated by NULL. Params itself may be
201 * NULL if no parameters are being passed.
Robert Moore44f6c012005-04-18 22:49:35 -0400202 * return_object - Where to put method's return value (if
203 * any). If NULL, no value is returned.
204 * parameter_type - Type of Parameter list
205 * return_object - Where to put method's return value (if
206 * any). If NULL, no value is returned.
Robert Moore0c9938c2005-07-29 15:15:00 -0700207 * pass_number - Parse or execute pass
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 *
209 * RETURN: Status
210 *
211 * DESCRIPTION: Execute a control method
212 *
213 ******************************************************************************/
214
Len Brown4be44fc2005-08-05 00:44:28 -0400215acpi_status acpi_ps_execute_method(struct acpi_parameter_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216{
Len Brown4be44fc2005-08-05 00:44:28 -0400217 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Len Brown4be44fc2005-08-05 00:44:28 -0400219 ACPI_FUNCTION_TRACE("ps_execute_method");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
Robert Moore0c9938c2005-07-29 15:15:00 -0700221 /* Validate the Info and method Node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
223 if (!info || !info->node) {
Len Brown4be44fc2005-08-05 00:44:28 -0400224 return_ACPI_STATUS(AE_NULL_ENTRY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 }
226
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 /* Init for new method, wait on concurrency semaphore */
228
Len Brown4be44fc2005-08-05 00:44:28 -0400229 status =
230 acpi_ds_begin_method_execution(info->node, info->obj_desc, NULL);
231 if (ACPI_FAILURE(status)) {
232 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 }
234
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 /*
Robert Moore0c9938c2005-07-29 15:15:00 -0700236 * The caller "owns" the parameters, so give each one an extra
237 * reference
238 */
Len Brown4be44fc2005-08-05 00:44:28 -0400239 acpi_ps_update_parameter_list(info, REF_INCREMENT);
Robert Moore0c9938c2005-07-29 15:15:00 -0700240
Bob Moore50eca3e2005-09-30 19:03:00 -0400241 /* Begin tracing if requested */
242
243 acpi_ps_start_trace(info);
244
Robert Moore0c9938c2005-07-29 15:15:00 -0700245 /*
246 * 1) Perform the first pass parse of the method to enter any
247 * named objects that it creates into the namespace
248 */
Len Brown4be44fc2005-08-05 00:44:28 -0400249 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
250 "**** Begin Method Parse **** Entry=%p obj=%p\n",
251 info->node, info->obj_desc));
Robert Moore0c9938c2005-07-29 15:15:00 -0700252
253 info->pass_number = 1;
Len Brown4be44fc2005-08-05 00:44:28 -0400254 status = acpi_ps_execute_pass(info);
255 if (ACPI_FAILURE(status)) {
Robert Moore0c9938c2005-07-29 15:15:00 -0700256 goto cleanup;
257 }
258
259 /*
260 * 2) Execute the method. Performs second pass parse simultaneously
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 */
Len Brown4be44fc2005-08-05 00:44:28 -0400262 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
263 "**** Begin Method Execution **** Entry=%p obj=%p\n",
264 info->node, info->obj_desc));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
Robert Moore0c9938c2005-07-29 15:15:00 -0700266 info->pass_number = 3;
Len Brown4be44fc2005-08-05 00:44:28 -0400267 status = acpi_ps_execute_pass(info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
Len Brown4be44fc2005-08-05 00:44:28 -0400269 cleanup:
Bob Moore50eca3e2005-09-30 19:03:00 -0400270 /* End optional tracing */
271
272 acpi_ps_stop_trace(info);
273
Robert Moore0c9938c2005-07-29 15:15:00 -0700274 /* Take away the extra reference that we gave the parameters above */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
Len Brown4be44fc2005-08-05 00:44:28 -0400276 acpi_ps_update_parameter_list(info, REF_DECREMENT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
Robert Moore0c9938c2005-07-29 15:15:00 -0700278 /* Exit now if error above */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
Len Brown4be44fc2005-08-05 00:44:28 -0400280 if (ACPI_FAILURE(status)) {
281 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 }
283
284 /*
285 * If the method has returned an object, signal this to the caller with
286 * a control exception code
287 */
288 if (info->return_object) {
Len Brown4be44fc2005-08-05 00:44:28 -0400289 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
290 "Method returned obj_desc=%p\n",
291 info->return_object));
292 ACPI_DUMP_STACK_ENTRY(info->return_object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
294 status = AE_CTRL_RETURN_VALUE;
295 }
296
Len Brown4be44fc2005-08-05 00:44:28 -0400297 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298}
299
Robert Moore0c9938c2005-07-29 15:15:00 -0700300/*******************************************************************************
301 *
302 * FUNCTION: acpi_ps_update_parameter_list
303 *
304 * PARAMETERS: Info - See struct acpi_parameter_info
305 * (Used: parameter_type and Parameters)
306 * Action - Add or Remove reference
307 *
308 * RETURN: Status
309 *
310 * DESCRIPTION: Update reference count on all method parameter objects
311 *
312 ******************************************************************************/
313
314static void
Len Brown4be44fc2005-08-05 00:44:28 -0400315acpi_ps_update_parameter_list(struct acpi_parameter_info *info, u16 action)
Robert Moore0c9938c2005-07-29 15:15:00 -0700316{
Len Brown4be44fc2005-08-05 00:44:28 -0400317 acpi_native_uint i;
Robert Moore0c9938c2005-07-29 15:15:00 -0700318
Len Brown4be44fc2005-08-05 00:44:28 -0400319 if ((info->parameter_type == ACPI_PARAM_ARGS) && (info->parameters)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400320
Robert Moore0c9938c2005-07-29 15:15:00 -0700321 /* Update reference count for each parameter */
322
323 for (i = 0; info->parameters[i]; i++) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400324
Robert Moore0c9938c2005-07-29 15:15:00 -0700325 /* Ignore errors, just do them all */
326
Len Brown4be44fc2005-08-05 00:44:28 -0400327 (void)acpi_ut_update_object_reference(info->
328 parameters[i],
329 action);
Robert Moore0c9938c2005-07-29 15:15:00 -0700330 }
331 }
332}
333
Robert Moore0c9938c2005-07-29 15:15:00 -0700334/*******************************************************************************
335 *
336 * FUNCTION: acpi_ps_execute_pass
337 *
338 * PARAMETERS: Info - See struct acpi_parameter_info
339 * (Used: pass_number, Node, and obj_desc)
340 *
341 * RETURN: Status
342 *
343 * DESCRIPTION: Single AML pass: Parse or Execute a control method
344 *
345 ******************************************************************************/
346
Len Brown4be44fc2005-08-05 00:44:28 -0400347static acpi_status acpi_ps_execute_pass(struct acpi_parameter_info *info)
Robert Moore0c9938c2005-07-29 15:15:00 -0700348{
Len Brown4be44fc2005-08-05 00:44:28 -0400349 acpi_status status;
350 union acpi_parse_object *op;
351 struct acpi_walk_state *walk_state;
Robert Moore0c9938c2005-07-29 15:15:00 -0700352
Len Brown4be44fc2005-08-05 00:44:28 -0400353 ACPI_FUNCTION_TRACE("ps_execute_pass");
Robert Moore0c9938c2005-07-29 15:15:00 -0700354
355 /* Create and init a Root Node */
356
Len Brown4be44fc2005-08-05 00:44:28 -0400357 op = acpi_ps_create_scope_op();
Robert Moore0c9938c2005-07-29 15:15:00 -0700358 if (!op) {
Len Brown4be44fc2005-08-05 00:44:28 -0400359 return_ACPI_STATUS(AE_NO_MEMORY);
Robert Moore0c9938c2005-07-29 15:15:00 -0700360 }
361
362 /* Create and initialize a new walk state */
363
Len Brown4be44fc2005-08-05 00:44:28 -0400364 walk_state =
365 acpi_ds_create_walk_state(info->obj_desc->method.owner_id, NULL,
366 NULL, NULL);
Robert Moore0c9938c2005-07-29 15:15:00 -0700367 if (!walk_state) {
368 status = AE_NO_MEMORY;
369 goto cleanup;
370 }
371
Len Brown4be44fc2005-08-05 00:44:28 -0400372 status = acpi_ds_init_aml_walk(walk_state, op, info->node,
373 info->obj_desc->method.aml_start,
374 info->obj_desc->method.aml_length,
375 info->pass_number == 1 ? NULL : info,
376 info->pass_number);
377 if (ACPI_FAILURE(status)) {
378 acpi_ds_delete_walk_state(walk_state);
Robert Moore0c9938c2005-07-29 15:15:00 -0700379 goto cleanup;
380 }
381
382 /* Parse the AML */
383
Len Brown4be44fc2005-08-05 00:44:28 -0400384 status = acpi_ps_parse_aml(walk_state);
Robert Moore0c9938c2005-07-29 15:15:00 -0700385
386 /* Walk state was deleted by parse_aml */
387
Len Brown4be44fc2005-08-05 00:44:28 -0400388 cleanup:
389 acpi_ps_delete_parse_tree(op);
390 return_ACPI_STATUS(status);
Robert Moore0c9938c2005-07-29 15:15:00 -0700391}