1
/******************************************************************************
3
* Module Name: psxface - Parser external interfaces
5
*****************************************************************************/
8
* Copyright (C) 2000 - 2011, Intel Corp.
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>
51
#define _COMPONENT ACPI_PARSER
52
ACPI_MODULE_NAME("psxface")
54
/* Local Prototypes */
55
static void acpi_ps_start_trace(struct acpi_evaluate_info *info);
57
static void acpi_ps_stop_trace(struct acpi_evaluate_info *info);
60
acpi_ps_update_parameter_list(struct acpi_evaluate_info *info, u16 action);
62
/*******************************************************************************
64
* FUNCTION: acpi_debug_trace
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)
73
* DESCRIPTION: External interface to enable debug tracing during control
76
******************************************************************************/
79
acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags)
83
status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
84
if (ACPI_FAILURE(status)) {
88
/* TBDs: Validate name, allow full path or just nameseg */
90
acpi_gbl_trace_method_name = *ACPI_CAST_PTR(u32, name);
91
acpi_gbl_trace_flags = flags;
94
acpi_gbl_trace_dbg_level = debug_level;
97
acpi_gbl_trace_dbg_layer = debug_layer;
100
(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
104
/*******************************************************************************
106
* FUNCTION: acpi_ps_start_trace
108
* PARAMETERS: Info - Method info struct
112
* DESCRIPTION: Start control method execution trace
114
******************************************************************************/
116
static void acpi_ps_start_trace(struct acpi_evaluate_info *info)
120
ACPI_FUNCTION_ENTRY();
122
status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
123
if (ACPI_FAILURE(status)) {
127
if ((!acpi_gbl_trace_method_name) ||
128
(acpi_gbl_trace_method_name != info->resolved_node->name.integer)) {
132
acpi_gbl_original_dbg_level = acpi_dbg_level;
133
acpi_gbl_original_dbg_layer = acpi_dbg_layer;
135
acpi_dbg_level = 0x00FFFFFF;
136
acpi_dbg_layer = ACPI_UINT32_MAX;
138
if (acpi_gbl_trace_dbg_level) {
139
acpi_dbg_level = acpi_gbl_trace_dbg_level;
141
if (acpi_gbl_trace_dbg_layer) {
142
acpi_dbg_layer = acpi_gbl_trace_dbg_layer;
146
(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
149
/*******************************************************************************
151
* FUNCTION: acpi_ps_stop_trace
153
* PARAMETERS: Info - Method info struct
157
* DESCRIPTION: Stop control method execution trace
159
******************************************************************************/
161
static void acpi_ps_stop_trace(struct acpi_evaluate_info *info)
165
ACPI_FUNCTION_ENTRY();
167
status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
168
if (ACPI_FAILURE(status)) {
172
if ((!acpi_gbl_trace_method_name) ||
173
(acpi_gbl_trace_method_name != info->resolved_node->name.integer)) {
177
/* Disable further tracing if type is one-shot */
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;
185
acpi_dbg_level = acpi_gbl_original_dbg_level;
186
acpi_dbg_layer = acpi_gbl_original_dbg_layer;
189
(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
192
/*******************************************************************************
194
* FUNCTION: acpi_ps_execute_method
196
* PARAMETERS: Info - Method info block, contains:
197
* Node - Method Node to execute
198
* obj_desc - Method object
199
* Parameters - List of parameters to pass to the method,
200
* terminated by NULL. Params itself may be
201
* NULL if no parameters are being passed.
202
* 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.
207
* pass_number - Parse or execute pass
211
* DESCRIPTION: Execute a control method
213
******************************************************************************/
215
acpi_status acpi_ps_execute_method(struct acpi_evaluate_info *info)
218
union acpi_parse_object *op;
219
struct acpi_walk_state *walk_state;
221
ACPI_FUNCTION_TRACE(ps_execute_method);
223
/* Quick validation of DSDT header */
225
acpi_tb_check_dsdt_header();
227
/* Validate the Info and method Node */
229
if (!info || !info->resolved_node) {
230
return_ACPI_STATUS(AE_NULL_ENTRY);
233
/* Init for new method, wait on concurrency semaphore */
236
acpi_ds_begin_method_execution(info->resolved_node, info->obj_desc,
238
if (ACPI_FAILURE(status)) {
239
return_ACPI_STATUS(status);
243
* The caller "owns" the parameters, so give each one an extra reference
245
acpi_ps_update_parameter_list(info, REF_INCREMENT);
247
/* Begin tracing if requested */
249
acpi_ps_start_trace(info);
252
* Execute the method. Performs parse simultaneously
254
ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
255
"**** Begin Method Parse/Execute [%4.4s] **** Node=%p Obj=%p\n",
256
info->resolved_node->name.ascii, info->resolved_node,
259
/* Create and init a Root Node */
261
op = acpi_ps_create_scope_op();
263
status = AE_NO_MEMORY;
267
/* Create and initialize a new walk state */
269
info->pass_number = ACPI_IMODE_EXECUTE;
271
acpi_ds_create_walk_state(info->obj_desc->method.owner_id, NULL,
274
status = AE_NO_MEMORY;
278
status = acpi_ds_init_aml_walk(walk_state, op, info->resolved_node,
279
info->obj_desc->method.aml_start,
280
info->obj_desc->method.aml_length, info,
282
if (ACPI_FAILURE(status)) {
283
acpi_ds_delete_walk_state(walk_state);
287
if (info->obj_desc->method.info_flags & ACPI_METHOD_MODULE_LEVEL) {
288
walk_state->parse_flags |= ACPI_PARSE_MODULE_LEVEL;
291
/* Invoke an internal method if necessary */
293
if (info->obj_desc->method.info_flags & ACPI_METHOD_INTERNAL_ONLY) {
295
info->obj_desc->method.dispatch.implementation(walk_state);
296
info->return_object = walk_state->return_desc;
300
acpi_ds_scope_stack_clear(walk_state);
301
acpi_ps_cleanup_scope(&walk_state->parser_state);
302
acpi_ds_terminate_control_method(walk_state->method_desc,
304
acpi_ds_delete_walk_state(walk_state);
309
* Start method evaluation with an implicit return of zero.
310
* This is done for Windows compatibility.
312
if (acpi_gbl_enable_interpreter_slack) {
313
walk_state->implicit_return_obj =
314
acpi_ut_create_integer_object((u64) 0);
315
if (!walk_state->implicit_return_obj) {
316
status = AE_NO_MEMORY;
317
acpi_ds_delete_walk_state(walk_state);
324
status = acpi_ps_parse_aml(walk_state);
326
/* walk_state was deleted by parse_aml */
329
acpi_ps_delete_parse_tree(op);
331
/* End optional tracing */
333
acpi_ps_stop_trace(info);
335
/* Take away the extra reference that we gave the parameters above */
337
acpi_ps_update_parameter_list(info, REF_DECREMENT);
339
/* Exit now if error above */
341
if (ACPI_FAILURE(status)) {
342
return_ACPI_STATUS(status);
346
* If the method has returned an object, signal this to the caller with
347
* a control exception code
349
if (info->return_object) {
350
ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "Method returned ObjDesc=%p\n",
351
info->return_object));
352
ACPI_DUMP_STACK_ENTRY(info->return_object);
354
status = AE_CTRL_RETURN_VALUE;
357
return_ACPI_STATUS(status);
360
/*******************************************************************************
362
* FUNCTION: acpi_ps_update_parameter_list
364
* PARAMETERS: Info - See struct acpi_evaluate_info
365
* (Used: parameter_type and Parameters)
366
* Action - Add or Remove reference
370
* DESCRIPTION: Update reference count on all method parameter objects
372
******************************************************************************/
375
acpi_ps_update_parameter_list(struct acpi_evaluate_info *info, u16 action)
379
if (info->parameters) {
381
/* Update reference count for each parameter */
383
for (i = 0; info->parameters[i]; i++) {
385
/* Ignore errors, just do them all */
387
(void)acpi_ut_update_object_reference(info->