Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Module Name: psxface - Parser external interfaces | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
75a44ce0 | 8 | * Copyright (C) 2000 - 2008, Intel Corp. |
1da177e4 LT |
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 | ||
1da177e4 LT |
44 | #include <acpi/acpi.h> |
45 | #include <acpi/acparser.h> | |
46 | #include <acpi/acdispat.h> | |
47 | #include <acpi/acinterp.h> | |
a8fadc92 | 48 | #include <acpi/amlcode.h> |
1da177e4 | 49 | |
1da177e4 | 50 | #define _COMPONENT ACPI_PARSER |
4be44fcd | 51 | ACPI_MODULE_NAME("psxface") |
1da177e4 | 52 | |
0c9938cc | 53 | /* Local Prototypes */ |
4119532c | 54 | static void acpi_ps_start_trace(struct acpi_evaluate_info *info); |
50eca3eb | 55 | |
4119532c | 56 | static void acpi_ps_stop_trace(struct acpi_evaluate_info *info); |
50eca3eb | 57 | |
0c9938cc | 58 | static void |
4119532c | 59 | acpi_ps_update_parameter_list(struct acpi_evaluate_info *info, u16 action); |
1da177e4 | 60 | |
50eca3eb BM |
61 | /******************************************************************************* |
62 | * | |
63 | * FUNCTION: acpi_debug_trace | |
64 | * | |
65 | * PARAMETERS: method_name - Valid ACPI name string | |
66 | * debug_level - Optional level mask. 0 to use default | |
67 | * debug_layer - Optional layer mask. 0 to use default | |
68 | * Flags - bit 1: one shot(1) or persistent(0) | |
69 | * | |
70 | * RETURN: Status | |
71 | * | |
72 | * DESCRIPTION: External interface to enable debug tracing during control | |
73 | * method execution | |
74 | * | |
75 | ******************************************************************************/ | |
76 | ||
77 | acpi_status | |
78 | acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags) | |
79 | { | |
80 | acpi_status status; | |
81 | ||
82 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); | |
83 | if (ACPI_FAILURE(status)) { | |
84 | return (status); | |
85 | } | |
86 | ||
87 | /* TBDs: Validate name, allow full path or just nameseg */ | |
88 | ||
c51a4de8 | 89 | acpi_gbl_trace_method_name = *ACPI_CAST_PTR(u32, name); |
50eca3eb BM |
90 | acpi_gbl_trace_flags = flags; |
91 | ||
92 | if (debug_level) { | |
93 | acpi_gbl_trace_dbg_level = debug_level; | |
94 | } | |
95 | if (debug_layer) { | |
96 | acpi_gbl_trace_dbg_layer = debug_layer; | |
97 | } | |
98 | ||
99 | (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); | |
100 | return (AE_OK); | |
101 | } | |
102 | ||
103 | /******************************************************************************* | |
104 | * | |
105 | * FUNCTION: acpi_ps_start_trace | |
106 | * | |
107 | * PARAMETERS: Info - Method info struct | |
108 | * | |
109 | * RETURN: None | |
110 | * | |
111 | * DESCRIPTION: Start control method execution trace | |
112 | * | |
113 | ******************************************************************************/ | |
114 | ||
4119532c | 115 | static void acpi_ps_start_trace(struct acpi_evaluate_info *info) |
50eca3eb BM |
116 | { |
117 | acpi_status status; | |
118 | ||
119 | ACPI_FUNCTION_ENTRY(); | |
120 | ||
121 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); | |
122 | if (ACPI_FAILURE(status)) { | |
123 | return; | |
124 | } | |
125 | ||
126 | if ((!acpi_gbl_trace_method_name) || | |
4119532c | 127 | (acpi_gbl_trace_method_name != info->resolved_node->name.integer)) { |
50eca3eb BM |
128 | goto exit; |
129 | } | |
130 | ||
131 | acpi_gbl_original_dbg_level = acpi_dbg_level; | |
132 | acpi_gbl_original_dbg_layer = acpi_dbg_layer; | |
133 | ||
134 | acpi_dbg_level = 0x00FFFFFF; | |
135 | acpi_dbg_layer = ACPI_UINT32_MAX; | |
136 | ||
137 | if (acpi_gbl_trace_dbg_level) { | |
138 | acpi_dbg_level = acpi_gbl_trace_dbg_level; | |
139 | } | |
140 | if (acpi_gbl_trace_dbg_layer) { | |
141 | acpi_dbg_layer = acpi_gbl_trace_dbg_layer; | |
142 | } | |
143 | ||
144 | exit: | |
145 | (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); | |
146 | } | |
147 | ||
148 | /******************************************************************************* | |
149 | * | |
150 | * FUNCTION: acpi_ps_stop_trace | |
151 | * | |
152 | * PARAMETERS: Info - Method info struct | |
153 | * | |
154 | * RETURN: None | |
155 | * | |
156 | * DESCRIPTION: Stop control method execution trace | |
157 | * | |
158 | ******************************************************************************/ | |
159 | ||
4119532c | 160 | static void acpi_ps_stop_trace(struct acpi_evaluate_info *info) |
50eca3eb BM |
161 | { |
162 | acpi_status status; | |
163 | ||
164 | ACPI_FUNCTION_ENTRY(); | |
165 | ||
166 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); | |
167 | if (ACPI_FAILURE(status)) { | |
168 | return; | |
169 | } | |
170 | ||
171 | if ((!acpi_gbl_trace_method_name) || | |
4119532c | 172 | (acpi_gbl_trace_method_name != info->resolved_node->name.integer)) { |
50eca3eb BM |
173 | goto exit; |
174 | } | |
175 | ||
176 | /* Disable further tracing if type is one-shot */ | |
177 | ||
178 | if (acpi_gbl_trace_flags & 1) { | |
179 | acpi_gbl_trace_method_name = 0; | |
180 | acpi_gbl_trace_dbg_level = 0; | |
181 | acpi_gbl_trace_dbg_layer = 0; | |
182 | } | |
183 | ||
184 | acpi_dbg_level = acpi_gbl_original_dbg_level; | |
185 | acpi_dbg_layer = acpi_gbl_original_dbg_layer; | |
186 | ||
187 | exit: | |
188 | (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); | |
189 | } | |
190 | ||
1da177e4 LT |
191 | /******************************************************************************* |
192 | * | |
0c9938cc | 193 | * FUNCTION: acpi_ps_execute_method |
1da177e4 | 194 | * |
44f6c012 RM |
195 | * PARAMETERS: Info - Method info block, contains: |
196 | * Node - Method Node to execute | |
0c9938cc | 197 | * obj_desc - Method object |
44f6c012 | 198 | * Parameters - List of parameters to pass to the method, |
1da177e4 LT |
199 | * terminated by NULL. Params itself may be |
200 | * NULL if no parameters are being passed. | |
44f6c012 RM |
201 | * return_object - Where to put method's return value (if |
202 | * any). If NULL, no value is returned. | |
203 | * parameter_type - Type of Parameter list | |
204 | * return_object - Where to put method's return value (if | |
205 | * any). If NULL, no value is returned. | |
0c9938cc | 206 | * pass_number - Parse or execute pass |
1da177e4 LT |
207 | * |
208 | * RETURN: Status | |
209 | * | |
210 | * DESCRIPTION: Execute a control method | |
211 | * | |
212 | ******************************************************************************/ | |
213 | ||
4119532c | 214 | acpi_status acpi_ps_execute_method(struct acpi_evaluate_info *info) |
1da177e4 | 215 | { |
4be44fcd | 216 | acpi_status status; |
9bc75cff VP |
217 | union acpi_parse_object *op; |
218 | struct acpi_walk_state *walk_state; | |
1da177e4 | 219 | |
b229cf92 | 220 | ACPI_FUNCTION_TRACE(ps_execute_method); |
1da177e4 | 221 | |
0c9938cc | 222 | /* Validate the Info and method Node */ |
1da177e4 | 223 | |
4119532c | 224 | if (!info || !info->resolved_node) { |
4be44fcd | 225 | return_ACPI_STATUS(AE_NULL_ENTRY); |
1da177e4 LT |
226 | } |
227 | ||
1da177e4 LT |
228 | /* Init for new method, wait on concurrency semaphore */ |
229 | ||
4be44fcd | 230 | status = |
4119532c BM |
231 | acpi_ds_begin_method_execution(info->resolved_node, info->obj_desc, |
232 | NULL); | |
4be44fcd LB |
233 | if (ACPI_FAILURE(status)) { |
234 | return_ACPI_STATUS(status); | |
1da177e4 LT |
235 | } |
236 | ||
0c9938cc | 237 | /* |
9bc75cff | 238 | * The caller "owns" the parameters, so give each one an extra reference |
0c9938cc | 239 | */ |
4be44fcd | 240 | acpi_ps_update_parameter_list(info, REF_INCREMENT); |
1da177e4 | 241 | |
50eca3eb BM |
242 | /* Begin tracing if requested */ |
243 | ||
244 | acpi_ps_start_trace(info); | |
245 | ||
0c9938cc | 246 | /* |
9bc75cff | 247 | * Execute the method. Performs parse simultaneously |
0c9938cc | 248 | */ |
4be44fcd | 249 | ACPI_DEBUG_PRINT((ACPI_DB_PARSE, |
9bc75cff VP |
250 | "**** Begin Method Parse/Execute [%4.4s] **** Node=%p Obj=%p\n", |
251 | info->resolved_node->name.ascii, info->resolved_node, | |
252 | info->obj_desc)); | |
1da177e4 | 253 | |
9bc75cff VP |
254 | /* Create and init a Root Node */ |
255 | ||
256 | op = acpi_ps_create_scope_op(); | |
257 | if (!op) { | |
258 | status = AE_NO_MEMORY; | |
0c9938cc | 259 | goto cleanup; |
1da177e4 LT |
260 | } |
261 | ||
9bc75cff | 262 | /* Create and initialize a new walk state */ |
1da177e4 | 263 | |
ec3153fb | 264 | info->pass_number = ACPI_IMODE_EXECUTE; |
9bc75cff VP |
265 | walk_state = |
266 | acpi_ds_create_walk_state(info->obj_desc->method.owner_id, NULL, | |
267 | NULL, NULL); | |
268 | if (!walk_state) { | |
269 | status = AE_NO_MEMORY; | |
270 | goto cleanup; | |
271 | } | |
272 | ||
273 | status = acpi_ds_init_aml_walk(walk_state, op, info->resolved_node, | |
274 | info->obj_desc->method.aml_start, | |
275 | info->obj_desc->method.aml_length, info, | |
276 | info->pass_number); | |
277 | if (ACPI_FAILURE(status)) { | |
278 | acpi_ds_delete_walk_state(walk_state); | |
279 | goto cleanup; | |
280 | } | |
281 | ||
a8fadc92 BM |
282 | /* Invoke an internal method if necessary */ |
283 | ||
284 | if (info->obj_desc->method.method_flags & AML_METHOD_INTERNAL_ONLY) { | |
285 | status = info->obj_desc->method.implementation(walk_state); | |
286 | info->return_object = walk_state->return_desc; | |
287 | ||
288 | /* Cleanup states */ | |
289 | ||
290 | acpi_ds_scope_stack_clear(walk_state); | |
291 | acpi_ps_cleanup_scope(&walk_state->parser_state); | |
292 | acpi_ds_terminate_control_method(walk_state->method_desc, | |
293 | walk_state); | |
294 | acpi_ds_delete_walk_state(walk_state); | |
295 | goto cleanup; | |
296 | } | |
297 | ||
7a4b8131 LM |
298 | /* |
299 | * Start method evaluation with an implicit return of zero. | |
300 | * This is done for Windows compatibility. | |
301 | */ | |
302 | if (acpi_gbl_enable_interpreter_slack) { | |
303 | walk_state->implicit_return_obj = | |
304 | acpi_ut_create_internal_object(ACPI_TYPE_INTEGER); | |
305 | if (!walk_state->implicit_return_obj) { | |
306 | status = AE_NO_MEMORY; | |
307 | acpi_ds_delete_walk_state(walk_state); | |
308 | goto cleanup; | |
309 | } | |
310 | ||
311 | walk_state->implicit_return_obj->integer.value = 0; | |
312 | } | |
313 | ||
9bc75cff VP |
314 | /* Parse the AML */ |
315 | ||
316 | status = acpi_ps_parse_aml(walk_state); | |
317 | ||
318 | /* walk_state was deleted by parse_aml */ | |
0c9938cc | 319 | |
4be44fcd | 320 | cleanup: |
9bc75cff VP |
321 | acpi_ps_delete_parse_tree(op); |
322 | ||
50eca3eb BM |
323 | /* End optional tracing */ |
324 | ||
325 | acpi_ps_stop_trace(info); | |
326 | ||
0c9938cc | 327 | /* Take away the extra reference that we gave the parameters above */ |
1da177e4 | 328 | |
4be44fcd | 329 | acpi_ps_update_parameter_list(info, REF_DECREMENT); |
1da177e4 | 330 | |
0c9938cc | 331 | /* Exit now if error above */ |
1da177e4 | 332 | |
4be44fcd LB |
333 | if (ACPI_FAILURE(status)) { |
334 | return_ACPI_STATUS(status); | |
1da177e4 LT |
335 | } |
336 | ||
0c9938cc RM |
337 | /* |
338 | * If the method has returned an object, signal this to the caller with | |
339 | * a control exception code | |
340 | */ | |
341 | if (info->return_object) { | |
b229cf92 | 342 | ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "Method returned ObjDesc=%p\n", |
4be44fcd LB |
343 | info->return_object)); |
344 | ACPI_DUMP_STACK_ENTRY(info->return_object); | |
0c9938cc RM |
345 | |
346 | status = AE_CTRL_RETURN_VALUE; | |
1da177e4 LT |
347 | } |
348 | ||
4be44fcd | 349 | return_ACPI_STATUS(status); |
0c9938cc | 350 | } |
44f6c012 | 351 | |
0c9938cc RM |
352 | /******************************************************************************* |
353 | * | |
354 | * FUNCTION: acpi_ps_update_parameter_list | |
355 | * | |
4119532c | 356 | * PARAMETERS: Info - See struct acpi_evaluate_info |
0c9938cc RM |
357 | * (Used: parameter_type and Parameters) |
358 | * Action - Add or Remove reference | |
359 | * | |
360 | * RETURN: Status | |
361 | * | |
362 | * DESCRIPTION: Update reference count on all method parameter objects | |
363 | * | |
364 | ******************************************************************************/ | |
1da177e4 | 365 | |
0c9938cc | 366 | static void |
4119532c | 367 | acpi_ps_update_parameter_list(struct acpi_evaluate_info *info, u16 action) |
0c9938cc | 368 | { |
67a119f9 | 369 | u32 i; |
1da177e4 | 370 | |
c91d924e | 371 | if (info->parameters) { |
52fc0b02 | 372 | |
0c9938cc | 373 | /* Update reference count for each parameter */ |
1da177e4 LT |
374 | |
375 | for (i = 0; info->parameters[i]; i++) { | |
52fc0b02 | 376 | |
1da177e4 LT |
377 | /* Ignore errors, just do them all */ |
378 | ||
4be44fcd LB |
379 | (void)acpi_ut_update_object_reference(info-> |
380 | parameters[i], | |
381 | action); | |
1da177e4 LT |
382 | } |
383 | } | |
0c9938cc | 384 | } |