1 /******************************************************************************
3 * Module Name: dswload - Dispatcher first pass namespace load callbacks
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, 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>
52 #ifdef ACPI_ASL_COMPILER
56 #define _COMPONENT ACPI_DISPATCHER
57 ACPI_MODULE_NAME("dswload")
59 /*******************************************************************************
61 * FUNCTION: acpi_ds_init_callbacks
63 * PARAMETERS: walk_state - Current state of the parse tree walk
64 * pass_number - 1, 2, or 3
68 * DESCRIPTION: Init walk state callbacks
70 ******************************************************************************/
72 acpi_ds_init_callbacks(struct acpi_walk_state
*walk_state
, u32 pass_number
)
75 switch (pass_number
) {
78 walk_state
->parse_flags
= ACPI_PARSE_LOAD_PASS1
|
79 ACPI_PARSE_DELETE_TREE
;
80 walk_state
->descending_callback
= acpi_ds_load1_begin_op
;
81 walk_state
->ascending_callback
= acpi_ds_load1_end_op
;
86 walk_state
->parse_flags
= ACPI_PARSE_LOAD_PASS1
|
87 ACPI_PARSE_DELETE_TREE
;
88 walk_state
->descending_callback
= acpi_ds_load2_begin_op
;
89 walk_state
->ascending_callback
= acpi_ds_load2_end_op
;
94 #ifndef ACPI_NO_METHOD_EXECUTION
95 walk_state
->parse_flags
|= ACPI_PARSE_EXECUTE
|
96 ACPI_PARSE_DELETE_TREE
;
97 walk_state
->descending_callback
= acpi_ds_exec_begin_op
;
98 walk_state
->ascending_callback
= acpi_ds_exec_end_op
;
104 return (AE_BAD_PARAMETER
);
110 /*******************************************************************************
112 * FUNCTION: acpi_ds_load1_begin_op
114 * PARAMETERS: walk_state - Current state of the parse tree walk
115 * out_op - Where to return op if a new one is created
119 * DESCRIPTION: Descending callback used during the loading of ACPI tables.
121 ******************************************************************************/
124 acpi_ds_load1_begin_op(struct acpi_walk_state
* walk_state
,
125 union acpi_parse_object
** out_op
)
127 union acpi_parse_object
*op
;
128 struct acpi_namespace_node
*node
;
130 acpi_object_type object_type
;
134 ACPI_FUNCTION_TRACE(ds_load1_begin_op
);
137 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
, "Op=%p State=%p\n", op
,
140 /* We are only interested in opcodes that have an associated name */
143 if (!(walk_state
->op_info
->flags
& AML_NAMED
)) {
145 return_ACPI_STATUS(AE_OK
);
148 /* Check if this object has already been installed in the namespace */
150 if (op
->common
.node
) {
152 return_ACPI_STATUS(AE_OK
);
156 path
= acpi_ps_get_next_namestring(&walk_state
->parser_state
);
158 /* Map the raw opcode into an internal object type */
160 object_type
= walk_state
->op_info
->object_type
;
162 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
163 "State=%p Op=%p [%s]\n", walk_state
, op
,
164 acpi_ut_get_type_name(object_type
)));
166 switch (walk_state
->opcode
) {
169 * The target name of the Scope() operator must exist at this point so
170 * that we can actually open the scope to enter new names underneath it.
171 * Allow search-to-root for single namesegs.
174 acpi_ns_lookup(walk_state
->scope_info
, path
, object_type
,
175 ACPI_IMODE_EXECUTE
, ACPI_NS_SEARCH_PARENT
,
176 walk_state
, &(node
));
177 #ifdef ACPI_ASL_COMPILER
178 if (status
== AE_NOT_FOUND
) {
181 * Target of Scope() not found. Generate an External for it, and
182 * insert the name into the namespace.
184 acpi_dm_add_to_external_list(op
, path
, ACPI_TYPE_DEVICE
,
187 acpi_ns_lookup(walk_state
->scope_info
, path
,
188 object_type
, ACPI_IMODE_LOAD_PASS1
,
189 ACPI_NS_SEARCH_PARENT
, walk_state
,
193 if (ACPI_FAILURE(status
)) {
194 ACPI_ERROR_NAMESPACE(path
, status
);
195 return_ACPI_STATUS(status
);
199 * Check to make sure that the target is
200 * one of the opcodes that actually opens a scope
202 switch (node
->type
) {
204 case ACPI_TYPE_LOCAL_SCOPE
: /* Scope */
205 case ACPI_TYPE_DEVICE
:
206 case ACPI_TYPE_POWER
:
207 case ACPI_TYPE_PROCESSOR
:
208 case ACPI_TYPE_THERMAL
:
210 /* These are acceptable types */
213 case ACPI_TYPE_INTEGER
:
214 case ACPI_TYPE_STRING
:
215 case ACPI_TYPE_BUFFER
:
217 * These types we will allow, but we will change the type.
218 * This enables some existing code of the form:
221 * Scope (DEB) { ... }
223 * Note: silently change the type here. On the second pass,
224 * we will report a warning
226 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
227 "Type override - [%4.4s] had invalid type (%s) "
228 "for Scope operator, changed to type ANY\n",
229 acpi_ut_get_node_name(node
),
230 acpi_ut_get_type_name(node
->type
)));
232 node
->type
= ACPI_TYPE_ANY
;
233 walk_state
->scope_info
->common
.value
= ACPI_TYPE_ANY
;
236 case ACPI_TYPE_METHOD
:
238 * Allow scope change to root during execution of module-level
239 * code. Root is typed METHOD during this time.
241 if ((node
== acpi_gbl_root_node
) &&
243 parse_flags
& ACPI_PARSE_MODULE_LEVEL
)) {
247 /*lint -fallthrough */
251 /* All other types are an error */
254 "Invalid type (%s) for target of "
255 "Scope operator [%4.4s] (Cannot override)",
256 acpi_ut_get_type_name(node
->type
),
257 acpi_ut_get_node_name(node
)));
259 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
265 * For all other named opcodes, we will enter the name into
268 * Setup the search flags.
269 * Since we are entering a name into the namespace, we do not want to
270 * enable the search-to-root upsearch.
272 * There are only two conditions where it is acceptable that the name
274 * 1) the Scope() operator can reopen a scoping object that was
275 * previously defined (Scope, Method, Device, etc.)
276 * 2) Whenever we are parsing a deferred opcode (op_region, Buffer,
277 * buffer_field, or Package), the name of the object is already
280 if (walk_state
->deferred_node
) {
282 /* This name is already in the namespace, get the node */
284 node
= walk_state
->deferred_node
;
290 * If we are executing a method, do not create any namespace objects
291 * during the load phase, only during execution.
293 if (walk_state
->method_node
) {
299 flags
= ACPI_NS_NO_UPSEARCH
;
300 if ((walk_state
->opcode
!= AML_SCOPE_OP
) &&
301 (!(walk_state
->parse_flags
& ACPI_PARSE_DEFERRED_OP
))) {
302 flags
|= ACPI_NS_ERROR_IF_FOUND
;
303 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
304 "[%s] Cannot already exist\n",
305 acpi_ut_get_type_name(object_type
)));
307 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
308 "[%s] Both Find or Create allowed\n",
309 acpi_ut_get_type_name(object_type
)));
313 * Enter the named type into the internal namespace. We enter the name
314 * as we go downward in the parse tree. Any necessary subobjects that
315 * involve arguments to the opcode must be created as we go back up the
319 acpi_ns_lookup(walk_state
->scope_info
, path
, object_type
,
320 ACPI_IMODE_LOAD_PASS1
, flags
, walk_state
,
322 if (ACPI_FAILURE(status
)) {
323 if (status
== AE_ALREADY_EXISTS
) {
325 /* The name already exists in this scope */
327 if (node
->flags
& ANOBJ_IS_EXTERNAL
) {
329 * Allow one create on an object or segment that was
330 * previously declared External
332 node
->flags
&= ~ANOBJ_IS_EXTERNAL
;
333 node
->type
= (u8
) object_type
;
335 /* Just retyped a node, probably will need to open a scope */
337 if (acpi_ns_opens_scope(object_type
)) {
339 acpi_ds_scope_stack_push
342 if (ACPI_FAILURE(status
)) {
352 if (ACPI_FAILURE(status
)) {
353 ACPI_ERROR_NAMESPACE(path
, status
);
354 return_ACPI_STATUS(status
);
364 /* Create a new op */
366 op
= acpi_ps_alloc_op(walk_state
->opcode
);
368 return_ACPI_STATUS(AE_NO_MEMORY
);
372 /* Initialize the op */
374 #if (defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY))
375 op
->named
.path
= ACPI_CAST_PTR(u8
, path
);
380 * Put the Node in the "op" object that the parser uses, so we
381 * can get it again quickly when this scope is closed
383 op
->common
.node
= node
;
384 op
->named
.name
= node
->name
.integer
;
387 acpi_ps_append_arg(acpi_ps_get_parent_scope(&walk_state
->parser_state
),
390 return_ACPI_STATUS(status
);
393 /*******************************************************************************
395 * FUNCTION: acpi_ds_load1_end_op
397 * PARAMETERS: walk_state - Current state of the parse tree walk
401 * DESCRIPTION: Ascending callback used during the loading of the namespace,
402 * both control methods and everything else.
404 ******************************************************************************/
406 acpi_status
acpi_ds_load1_end_op(struct acpi_walk_state
*walk_state
)
408 union acpi_parse_object
*op
;
409 acpi_object_type object_type
;
410 acpi_status status
= AE_OK
;
412 ACPI_FUNCTION_TRACE(ds_load1_end_op
);
415 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
, "Op=%p State=%p\n", op
,
418 /* We are only interested in opcodes that have an associated name */
420 if (!(walk_state
->op_info
->flags
& (AML_NAMED
| AML_FIELD
))) {
421 return_ACPI_STATUS(AE_OK
);
424 /* Get the object type to determine if we should pop the scope */
426 object_type
= walk_state
->op_info
->object_type
;
428 #ifndef ACPI_NO_METHOD_EXECUTION
429 if (walk_state
->op_info
->flags
& AML_FIELD
) {
431 * If we are executing a method, do not create any namespace objects
432 * during the load phase, only during execution.
434 if (!walk_state
->method_node
) {
435 if (walk_state
->opcode
== AML_FIELD_OP
||
436 walk_state
->opcode
== AML_BANK_FIELD_OP
||
437 walk_state
->opcode
== AML_INDEX_FIELD_OP
) {
439 acpi_ds_init_field_objects(op
, walk_state
);
442 return_ACPI_STATUS(status
);
446 * If we are executing a method, do not create any namespace objects
447 * during the load phase, only during execution.
449 if (!walk_state
->method_node
) {
450 if (op
->common
.aml_opcode
== AML_REGION_OP
) {
452 acpi_ex_create_region(op
->named
.data
,
454 (acpi_adr_space_type
) ((op
->
462 if (ACPI_FAILURE(status
)) {
463 return_ACPI_STATUS(status
);
465 } else if (op
->common
.aml_opcode
== AML_DATA_REGION_OP
) {
467 acpi_ex_create_region(op
->named
.data
,
469 ACPI_ADR_SPACE_DATA_TABLE
,
471 if (ACPI_FAILURE(status
)) {
472 return_ACPI_STATUS(status
);
478 if (op
->common
.aml_opcode
== AML_NAME_OP
) {
480 /* For Name opcode, get the object type from the argument */
482 if (op
->common
.value
.arg
) {
483 object_type
= (acpi_ps_get_opcode_info((op
->common
.
489 /* Set node type if we have a namespace node */
491 if (op
->common
.node
) {
492 op
->common
.node
->type
= (u8
) object_type
;
498 * If we are executing a method, do not create any namespace objects
499 * during the load phase, only during execution.
501 if (!walk_state
->method_node
) {
502 if (op
->common
.aml_opcode
== AML_METHOD_OP
) {
504 * method_op pkg_length name_string method_flags term_list
506 * Note: We must create the method node/object pair as soon as we
507 * see the method declaration. This allows later pass1 parsing
508 * of invocations of the method (need to know the number of
511 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
512 "LOADING-Method: State=%p Op=%p NamedObj=%p\n",
513 walk_state
, op
, op
->named
.node
));
515 if (!acpi_ns_get_attached_object(op
->named
.node
)) {
516 walk_state
->operands
[0] =
517 ACPI_CAST_PTR(void, op
->named
.node
);
518 walk_state
->num_operands
= 1;
521 acpi_ds_create_operands(walk_state
,
524 if (ACPI_SUCCESS(status
)) {
526 acpi_ex_create_method(op
->named
.
533 walk_state
->operands
[0] = NULL
;
534 walk_state
->num_operands
= 0;
536 if (ACPI_FAILURE(status
)) {
537 return_ACPI_STATUS(status
);
543 /* Pop the scope stack (only if loading a table) */
545 if (!walk_state
->method_node
&& acpi_ns_opens_scope(object_type
)) {
546 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
547 "(%s): Popping scope for Op %p\n",
548 acpi_ut_get_type_name(object_type
), op
));
550 status
= acpi_ds_scope_stack_pop(walk_state
);
553 return_ACPI_STATUS(status
);