1 /******************************************************************************
3 * Module Name: dswload - Dispatcher first pass namespace load callbacks
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, 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 /* Parse only - caller will setup callbacks */
80 walk_state->parse_flags = ACPI_PARSE_LOAD_PASS1 |
81 ACPI_PARSE_DELETE_TREE | ACPI_PARSE_DISASSEMBLE;
82 walk_state->descending_callback = NULL;
83 walk_state->ascending_callback = NULL;
90 walk_state->parse_flags = ACPI_PARSE_LOAD_PASS1 |
91 ACPI_PARSE_DELETE_TREE;
92 walk_state->descending_callback = acpi_ds_load1_begin_op;
93 walk_state->ascending_callback = acpi_ds_load1_end_op;
100 walk_state->parse_flags = ACPI_PARSE_LOAD_PASS1 |
101 ACPI_PARSE_DELETE_TREE;
102 walk_state->descending_callback = acpi_ds_load2_begin_op;
103 walk_state->ascending_callback = acpi_ds_load2_end_op;
110 #ifndef ACPI_NO_METHOD_EXECUTION
111 walk_state->parse_flags |= ACPI_PARSE_EXECUTE |
112 ACPI_PARSE_DELETE_TREE;
113 walk_state->descending_callback = acpi_ds_exec_begin_op;
114 walk_state->ascending_callback = acpi_ds_exec_end_op;
120 return (AE_BAD_PARAMETER);
126 /*******************************************************************************
128 * FUNCTION: acpi_ds_load1_begin_op
130 * PARAMETERS: walk_state - Current state of the parse tree walk
131 * out_op - Where to return op if a new one is created
135 * DESCRIPTION: Descending callback used during the loading of ACPI tables.
137 ******************************************************************************/
140 acpi_ds_load1_begin_op(struct acpi_walk_state * walk_state,
141 union acpi_parse_object ** out_op)
143 union acpi_parse_object *op;
144 struct acpi_namespace_node *node;
146 acpi_object_type object_type;
150 ACPI_FUNCTION_TRACE(ds_load1_begin_op);
153 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, "Op=%p State=%p\n", op,
156 /* We are only interested in opcodes that have an associated name */
159 if (!(walk_state->op_info->flags & AML_NAMED)) {
161 return_ACPI_STATUS(AE_OK);
164 /* Check if this object has already been installed in the namespace */
166 if (op->common.node) {
168 return_ACPI_STATUS(AE_OK);
172 path = acpi_ps_get_next_namestring(&walk_state->parser_state);
174 /* Map the raw opcode into an internal object type */
176 object_type = walk_state->op_info->object_type;
178 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
179 "State=%p Op=%p [%s]\n", walk_state, op,
180 acpi_ut_get_type_name(object_type)));
182 switch (walk_state->opcode) {
185 * The target name of the Scope() operator must exist at this point so
186 * that we can actually open the scope to enter new names underneath it.
187 * Allow search-to-root for single namesegs.
190 acpi_ns_lookup(walk_state->scope_info, path, object_type,
191 ACPI_IMODE_EXECUTE, ACPI_NS_SEARCH_PARENT,
192 walk_state, &(node));
193 #ifdef ACPI_ASL_COMPILER
194 if (status == AE_NOT_FOUND) {
197 * Target of Scope() not found. Generate an External for it, and
198 * insert the name into the namespace.
200 acpi_dm_add_op_to_external_list(op, path,
201 ACPI_TYPE_DEVICE, 0, 0);
203 acpi_ns_lookup(walk_state->scope_info, path,
204 object_type, ACPI_IMODE_LOAD_PASS1,
205 ACPI_NS_SEARCH_PARENT, walk_state,
209 if (ACPI_FAILURE(status)) {
210 ACPI_ERROR_NAMESPACE(path, status);
211 return_ACPI_STATUS(status);
215 * Check to make sure that the target is
216 * one of the opcodes that actually opens a scope
218 switch (node->type) {
220 case ACPI_TYPE_LOCAL_SCOPE: /* Scope */
221 case ACPI_TYPE_DEVICE:
222 case ACPI_TYPE_POWER:
223 case ACPI_TYPE_PROCESSOR:
224 case ACPI_TYPE_THERMAL:
226 /* These are acceptable types */
229 case ACPI_TYPE_INTEGER:
230 case ACPI_TYPE_STRING:
231 case ACPI_TYPE_BUFFER:
233 * These types we will allow, but we will change the type.
234 * This enables some existing code of the form:
237 * Scope (DEB) { ... }
239 * Note: silently change the type here. On the second pass,
240 * we will report a warning
242 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
243 "Type override - [%4.4s] had invalid type (%s) "
244 "for Scope operator, changed to type ANY\n",
245 acpi_ut_get_node_name(node),
246 acpi_ut_get_type_name(node->type)));
248 node->type = ACPI_TYPE_ANY;
249 walk_state->scope_info->common.value = ACPI_TYPE_ANY;
252 case ACPI_TYPE_METHOD:
254 * Allow scope change to root during execution of module-level
255 * code. Root is typed METHOD during this time.
257 if ((node == acpi_gbl_root_node) &&
259 parse_flags & ACPI_PARSE_MODULE_LEVEL)) {
263 /*lint -fallthrough */
267 /* All other types are an error */
270 "Invalid type (%s) for target of "
271 "Scope operator [%4.4s] (Cannot override)",
272 acpi_ut_get_type_name(node->type),
273 acpi_ut_get_node_name(node)));
275 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
281 * For all other named opcodes, we will enter the name into
284 * Setup the search flags.
285 * Since we are entering a name into the namespace, we do not want to
286 * enable the search-to-root upsearch.
288 * There are only two conditions where it is acceptable that the name
290 * 1) the Scope() operator can reopen a scoping object that was
291 * previously defined (Scope, Method, Device, etc.)
292 * 2) Whenever we are parsing a deferred opcode (op_region, Buffer,
293 * buffer_field, or Package), the name of the object is already
296 if (walk_state->deferred_node) {
298 /* This name is already in the namespace, get the node */
300 node = walk_state->deferred_node;
306 * If we are executing a method, do not create any namespace objects
307 * during the load phase, only during execution.
309 if (walk_state->method_node) {
315 flags = ACPI_NS_NO_UPSEARCH;
316 if ((walk_state->opcode != AML_SCOPE_OP) &&
317 (!(walk_state->parse_flags & ACPI_PARSE_DEFERRED_OP))) {
318 if (walk_state->namespace_override) {
319 flags |= ACPI_NS_OVERRIDE_IF_FOUND;
320 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
321 "[%s] Override allowed\n",
322 acpi_ut_get_type_name
325 flags |= ACPI_NS_ERROR_IF_FOUND;
326 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
327 "[%s] Cannot already exist\n",
328 acpi_ut_get_type_name
332 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
333 "[%s] Both Find or Create allowed\n",
334 acpi_ut_get_type_name(object_type)));
338 * Enter the named type into the internal namespace. We enter the name
339 * as we go downward in the parse tree. Any necessary subobjects that
340 * involve arguments to the opcode must be created as we go back up the
344 acpi_ns_lookup(walk_state->scope_info, path, object_type,
345 ACPI_IMODE_LOAD_PASS1, flags, walk_state,
347 if (ACPI_FAILURE(status)) {
348 if (status == AE_ALREADY_EXISTS) {
350 /* The name already exists in this scope */
352 if (node->flags & ANOBJ_IS_EXTERNAL) {
354 * Allow one create on an object or segment that was
355 * previously declared External
357 node->flags &= ~ANOBJ_IS_EXTERNAL;
358 node->type = (u8) object_type;
360 /* Just retyped a node, probably will need to open a scope */
362 if (acpi_ns_opens_scope(object_type)) {
364 acpi_ds_scope_stack_push
367 if (ACPI_FAILURE(status)) {
377 if (ACPI_FAILURE(status)) {
378 ACPI_ERROR_NAMESPACE(path, status);
379 return_ACPI_STATUS(status);
389 /* Create a new op */
391 op = acpi_ps_alloc_op(walk_state->opcode, walk_state->aml);
393 return_ACPI_STATUS(AE_NO_MEMORY);
397 /* Initialize the op */
399 #if (defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY))
400 op->named.path = ACPI_CAST_PTR(u8, path);
405 * Put the Node in the "op" object that the parser uses, so we
406 * can get it again quickly when this scope is closed
408 op->common.node = node;
409 op->named.name = node->name.integer;
412 acpi_ps_append_arg(acpi_ps_get_parent_scope(&walk_state->parser_state),
415 return_ACPI_STATUS(status);
418 /*******************************************************************************
420 * FUNCTION: acpi_ds_load1_end_op
422 * PARAMETERS: walk_state - Current state of the parse tree walk
426 * DESCRIPTION: Ascending callback used during the loading of the namespace,
427 * both control methods and everything else.
429 ******************************************************************************/
431 acpi_status acpi_ds_load1_end_op(struct acpi_walk_state *walk_state)
433 union acpi_parse_object *op;
434 acpi_object_type object_type;
435 acpi_status status = AE_OK;
437 ACPI_FUNCTION_TRACE(ds_load1_end_op);
440 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, "Op=%p State=%p\n", op,
443 /* We are only interested in opcodes that have an associated name */
445 if (!(walk_state->op_info->flags & (AML_NAMED | AML_FIELD))) {
446 return_ACPI_STATUS(AE_OK);
449 /* Get the object type to determine if we should pop the scope */
451 object_type = walk_state->op_info->object_type;
453 #ifndef ACPI_NO_METHOD_EXECUTION
454 if (walk_state->op_info->flags & AML_FIELD) {
456 * If we are executing a method, do not create any namespace objects
457 * during the load phase, only during execution.
459 if (!walk_state->method_node) {
460 if (walk_state->opcode == AML_FIELD_OP ||
461 walk_state->opcode == AML_BANK_FIELD_OP ||
462 walk_state->opcode == AML_INDEX_FIELD_OP) {
464 acpi_ds_init_field_objects(op, walk_state);
467 return_ACPI_STATUS(status);
471 * If we are executing a method, do not create any namespace objects
472 * during the load phase, only during execution.
474 if (!walk_state->method_node) {
475 if (op->common.aml_opcode == AML_REGION_OP) {
477 acpi_ex_create_region(op->named.data,
479 (acpi_adr_space_type) ((op->
487 if (ACPI_FAILURE(status)) {
488 return_ACPI_STATUS(status);
490 } else if (op->common.aml_opcode == AML_DATA_REGION_OP) {
492 acpi_ex_create_region(op->named.data,
494 ACPI_ADR_SPACE_DATA_TABLE,
496 if (ACPI_FAILURE(status)) {
497 return_ACPI_STATUS(status);
503 if (op->common.aml_opcode == AML_NAME_OP) {
505 /* For Name opcode, get the object type from the argument */
507 if (op->common.value.arg) {
508 object_type = (acpi_ps_get_opcode_info((op->common.
514 /* Set node type if we have a namespace node */
516 if (op->common.node) {
517 op->common.node->type = (u8) object_type;
523 * If we are executing a method, do not create any namespace objects
524 * during the load phase, only during execution.
526 if (!walk_state->method_node) {
527 if (op->common.aml_opcode == AML_METHOD_OP) {
529 * method_op pkg_length name_string method_flags term_list
531 * Note: We must create the method node/object pair as soon as we
532 * see the method declaration. This allows later pass1 parsing
533 * of invocations of the method (need to know the number of
536 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
537 "LOADING-Method: State=%p Op=%p NamedObj=%p\n",
538 walk_state, op, op->named.node));
540 if (!acpi_ns_get_attached_object(op->named.node)) {
541 walk_state->operands[0] =
542 ACPI_CAST_PTR(void, op->named.node);
543 walk_state->num_operands = 1;
546 acpi_ds_create_operands(walk_state,
549 if (ACPI_SUCCESS(status)) {
551 acpi_ex_create_method(op->named.
558 walk_state->operands[0] = NULL;
559 walk_state->num_operands = 0;
561 if (ACPI_FAILURE(status)) {
562 return_ACPI_STATUS(status);
568 /* Pop the scope stack (only if loading a table) */
570 if (!walk_state->method_node && acpi_ns_opens_scope(object_type)) {
571 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
572 "(%s): Popping scope for Op %p\n",
573 acpi_ut_get_type_name(object_type), op));
575 status = acpi_ds_scope_stack_pop(walk_state);
578 return_ACPI_STATUS(status);