1 /****************************************************************************** 2 * 3 * Module Name: dswload - Dispatcher first pass namespace load callbacks 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2013, Intel Corp. 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 44 #include <acpi/acpi.h> 45 #include "accommon.h" 46 #include "acparser.h" 47 #include "amlcode.h" 48 #include "acdispat.h" 49 #include "acinterp.h" 50 #include "acnamesp.h" 51 52 #ifdef ACPI_ASL_COMPILER 53 #include "acdisasm.h" 54 #endif 55 56 #define _COMPONENT ACPI_DISPATCHER 57 ACPI_MODULE_NAME("dswload") 58 59 /******************************************************************************* 60 * 61 * FUNCTION: acpi_ds_init_callbacks 62 * 63 * PARAMETERS: walk_state - Current state of the parse tree walk 64 * pass_number - 1, 2, or 3 65 * 66 * RETURN: Status 67 * 68 * DESCRIPTION: Init walk state callbacks 69 * 70 ******************************************************************************/ 71 acpi_status 72 acpi_ds_init_callbacks(struct acpi_walk_state *walk_state, u32 pass_number) 73 { 74 75 switch (pass_number) { 76 case 1: 77 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; 82 break; 83 84 case 2: 85 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; 90 break; 91 92 case 3: 93 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; 99 #endif 100 break; 101 102 default: 103 104 return (AE_BAD_PARAMETER); 105 } 106 107 return (AE_OK); 108 } 109 110 /******************************************************************************* 111 * 112 * FUNCTION: acpi_ds_load1_begin_op 113 * 114 * PARAMETERS: walk_state - Current state of the parse tree walk 115 * out_op - Where to return op if a new one is created 116 * 117 * RETURN: Status 118 * 119 * DESCRIPTION: Descending callback used during the loading of ACPI tables. 120 * 121 ******************************************************************************/ 122 123 acpi_status 124 acpi_ds_load1_begin_op(struct acpi_walk_state * walk_state, 125 union acpi_parse_object ** out_op) 126 { 127 union acpi_parse_object *op; 128 struct acpi_namespace_node *node; 129 acpi_status status; 130 acpi_object_type object_type; 131 char *path; 132 u32 flags; 133 134 ACPI_FUNCTION_TRACE(ds_load1_begin_op); 135 136 op = walk_state->op; 137 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, "Op=%p State=%p\n", op, 138 walk_state)); 139 140 /* We are only interested in opcodes that have an associated name */ 141 142 if (op) { 143 if (!(walk_state->op_info->flags & AML_NAMED)) { 144 *out_op = op; 145 return_ACPI_STATUS(AE_OK); 146 } 147 148 /* Check if this object has already been installed in the namespace */ 149 150 if (op->common.node) { 151 *out_op = op; 152 return_ACPI_STATUS(AE_OK); 153 } 154 } 155 156 path = acpi_ps_get_next_namestring(&walk_state->parser_state); 157 158 /* Map the raw opcode into an internal object type */ 159 160 object_type = walk_state->op_info->object_type; 161 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))); 165 166 switch (walk_state->opcode) { 167 case AML_SCOPE_OP: 168 /* 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. 172 */ 173 status = 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) { 179 /* 180 * Table disassembly: 181 * Target of Scope() not found. Generate an External for it, and 182 * insert the name into the namespace. 183 */ 184 acpi_dm_add_op_to_external_list(op, path, 185 ACPI_TYPE_DEVICE, 0, 0); 186 status = 187 acpi_ns_lookup(walk_state->scope_info, path, 188 object_type, ACPI_IMODE_LOAD_PASS1, 189 ACPI_NS_SEARCH_PARENT, walk_state, 190 &node); 191 } 192 #endif 193 if (ACPI_FAILURE(status)) { 194 ACPI_ERROR_NAMESPACE(path, status); 195 return_ACPI_STATUS(status); 196 } 197 198 /* 199 * Check to make sure that the target is 200 * one of the opcodes that actually opens a scope 201 */ 202 switch (node->type) { 203 case ACPI_TYPE_ANY: 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: 209 210 /* These are acceptable types */ 211 break; 212 213 case ACPI_TYPE_INTEGER: 214 case ACPI_TYPE_STRING: 215 case ACPI_TYPE_BUFFER: 216 /* 217 * These types we will allow, but we will change the type. 218 * This enables some existing code of the form: 219 * 220 * Name (DEB, 0) 221 * Scope (DEB) { ... } 222 * 223 * Note: silently change the type here. On the second pass, 224 * we will report a warning 225 */ 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))); 231 232 node->type = ACPI_TYPE_ANY; 233 walk_state->scope_info->common.value = ACPI_TYPE_ANY; 234 break; 235 236 case ACPI_TYPE_METHOD: 237 /* 238 * Allow scope change to root during execution of module-level 239 * code. Root is typed METHOD during this time. 240 */ 241 if ((node == acpi_gbl_root_node) && 242 (walk_state-> 243 parse_flags & ACPI_PARSE_MODULE_LEVEL)) { 244 break; 245 } 246 247 /*lint -fallthrough */ 248 249 default: 250 251 /* All other types are an error */ 252 253 ACPI_ERROR((AE_INFO, 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))); 258 259 return_ACPI_STATUS(AE_AML_OPERAND_TYPE); 260 } 261 break; 262 263 default: 264 /* 265 * For all other named opcodes, we will enter the name into 266 * the namespace. 267 * 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. 271 * 272 * There are only two conditions where it is acceptable that the name 273 * already exists: 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 278 * in the namespace. 279 */ 280 if (walk_state->deferred_node) { 281 282 /* This name is already in the namespace, get the node */ 283 284 node = walk_state->deferred_node; 285 status = AE_OK; 286 break; 287 } 288 289 /* 290 * If we are executing a method, do not create any namespace objects 291 * during the load phase, only during execution. 292 */ 293 if (walk_state->method_node) { 294 node = NULL; 295 status = AE_OK; 296 break; 297 } 298 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))); 306 } else { 307 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, 308 "[%s] Both Find or Create allowed\n", 309 acpi_ut_get_type_name(object_type))); 310 } 311 312 /* 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 316 * parse tree later. 317 */ 318 status = 319 acpi_ns_lookup(walk_state->scope_info, path, object_type, 320 ACPI_IMODE_LOAD_PASS1, flags, walk_state, 321 &node); 322 if (ACPI_FAILURE(status)) { 323 if (status == AE_ALREADY_EXISTS) { 324 325 /* The name already exists in this scope */ 326 327 if (node->flags & ANOBJ_IS_EXTERNAL) { 328 /* 329 * Allow one create on an object or segment that was 330 * previously declared External 331 */ 332 node->flags &= ~ANOBJ_IS_EXTERNAL; 333 node->type = (u8) object_type; 334 335 /* Just retyped a node, probably will need to open a scope */ 336 337 if (acpi_ns_opens_scope(object_type)) { 338 status = 339 acpi_ds_scope_stack_push 340 (node, object_type, 341 walk_state); 342 if (ACPI_FAILURE(status)) { 343 return_ACPI_STATUS 344 (status); 345 } 346 } 347 348 status = AE_OK; 349 } 350 } 351 352 if (ACPI_FAILURE(status)) { 353 ACPI_ERROR_NAMESPACE(path, status); 354 return_ACPI_STATUS(status); 355 } 356 } 357 break; 358 } 359 360 /* Common exit */ 361 362 if (!op) { 363 364 /* Create a new op */ 365 366 op = acpi_ps_alloc_op(walk_state->opcode); 367 if (!op) { 368 return_ACPI_STATUS(AE_NO_MEMORY); 369 } 370 } 371 372 /* Initialize the op */ 373 374 #if (defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)) 375 op->named.path = ACPI_CAST_PTR(u8, path); 376 #endif 377 378 if (node) { 379 /* 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 382 */ 383 op->common.node = node; 384 op->named.name = node->name.integer; 385 } 386 387 acpi_ps_append_arg(acpi_ps_get_parent_scope(&walk_state->parser_state), 388 op); 389 *out_op = op; 390 return_ACPI_STATUS(status); 391 } 392 393 /******************************************************************************* 394 * 395 * FUNCTION: acpi_ds_load1_end_op 396 * 397 * PARAMETERS: walk_state - Current state of the parse tree walk 398 * 399 * RETURN: Status 400 * 401 * DESCRIPTION: Ascending callback used during the loading of the namespace, 402 * both control methods and everything else. 403 * 404 ******************************************************************************/ 405 406 acpi_status acpi_ds_load1_end_op(struct acpi_walk_state *walk_state) 407 { 408 union acpi_parse_object *op; 409 acpi_object_type object_type; 410 acpi_status status = AE_OK; 411 412 ACPI_FUNCTION_TRACE(ds_load1_end_op); 413 414 op = walk_state->op; 415 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, "Op=%p State=%p\n", op, 416 walk_state)); 417 418 /* We are only interested in opcodes that have an associated name */ 419 420 if (!(walk_state->op_info->flags & (AML_NAMED | AML_FIELD))) { 421 return_ACPI_STATUS(AE_OK); 422 } 423 424 /* Get the object type to determine if we should pop the scope */ 425 426 object_type = walk_state->op_info->object_type; 427 428 #ifndef ACPI_NO_METHOD_EXECUTION 429 if (walk_state->op_info->flags & AML_FIELD) { 430 /* 431 * If we are executing a method, do not create any namespace objects 432 * during the load phase, only during execution. 433 */ 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) { 438 status = 439 acpi_ds_init_field_objects(op, walk_state); 440 } 441 } 442 return_ACPI_STATUS(status); 443 } 444 445 /* 446 * If we are executing a method, do not create any namespace objects 447 * during the load phase, only during execution. 448 */ 449 if (!walk_state->method_node) { 450 if (op->common.aml_opcode == AML_REGION_OP) { 451 status = 452 acpi_ex_create_region(op->named.data, 453 op->named.length, 454 (acpi_adr_space_type) ((op-> 455 common. 456 value. 457 arg)-> 458 common. 459 value. 460 integer), 461 walk_state); 462 if (ACPI_FAILURE(status)) { 463 return_ACPI_STATUS(status); 464 } 465 } else if (op->common.aml_opcode == AML_DATA_REGION_OP) { 466 status = 467 acpi_ex_create_region(op->named.data, 468 op->named.length, 469 ACPI_ADR_SPACE_DATA_TABLE, 470 walk_state); 471 if (ACPI_FAILURE(status)) { 472 return_ACPI_STATUS(status); 473 } 474 } 475 } 476 #endif 477 478 if (op->common.aml_opcode == AML_NAME_OP) { 479 480 /* For Name opcode, get the object type from the argument */ 481 482 if (op->common.value.arg) { 483 object_type = (acpi_ps_get_opcode_info((op->common. 484 value.arg)-> 485 common. 486 aml_opcode))-> 487 object_type; 488 489 /* Set node type if we have a namespace node */ 490 491 if (op->common.node) { 492 op->common.node->type = (u8) object_type; 493 } 494 } 495 } 496 497 /* 498 * If we are executing a method, do not create any namespace objects 499 * during the load phase, only during execution. 500 */ 501 if (!walk_state->method_node) { 502 if (op->common.aml_opcode == AML_METHOD_OP) { 503 /* 504 * method_op pkg_length name_string method_flags term_list 505 * 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 509 * arguments.) 510 */ 511 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, 512 "LOADING-Method: State=%p Op=%p NamedObj=%p\n", 513 walk_state, op, op->named.node)); 514 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; 519 520 status = 521 acpi_ds_create_operands(walk_state, 522 op->common.value. 523 arg); 524 if (ACPI_SUCCESS(status)) { 525 status = 526 acpi_ex_create_method(op->named. 527 data, 528 op->named. 529 length, 530 walk_state); 531 } 532 533 walk_state->operands[0] = NULL; 534 walk_state->num_operands = 0; 535 536 if (ACPI_FAILURE(status)) { 537 return_ACPI_STATUS(status); 538 } 539 } 540 } 541 } 542 543 /* Pop the scope stack (only if loading a table) */ 544 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)); 549 550 status = acpi_ds_scope_stack_pop(walk_state); 551 } 552 553 return_ACPI_STATUS(status); 554 } 555