1 /****************************************************************************** 2 * 3 * Module Name: dswload - Dispatcher first pass namespace load callbacks 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2012, 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 <acpi/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 walk_state->parse_flags = ACPI_PARSE_LOAD_PASS1 | 78 ACPI_PARSE_DELETE_TREE; 79 walk_state->descending_callback = acpi_ds_load1_begin_op; 80 walk_state->ascending_callback = acpi_ds_load1_end_op; 81 break; 82 83 case 2: 84 walk_state->parse_flags = ACPI_PARSE_LOAD_PASS1 | 85 ACPI_PARSE_DELETE_TREE; 86 walk_state->descending_callback = acpi_ds_load2_begin_op; 87 walk_state->ascending_callback = acpi_ds_load2_end_op; 88 break; 89 90 case 3: 91 #ifndef ACPI_NO_METHOD_EXECUTION 92 walk_state->parse_flags |= ACPI_PARSE_EXECUTE | 93 ACPI_PARSE_DELETE_TREE; 94 walk_state->descending_callback = acpi_ds_exec_begin_op; 95 walk_state->ascending_callback = acpi_ds_exec_end_op; 96 #endif 97 break; 98 99 default: 100 return (AE_BAD_PARAMETER); 101 } 102 103 return (AE_OK); 104 } 105 106 /******************************************************************************* 107 * 108 * FUNCTION: acpi_ds_load1_begin_op 109 * 110 * PARAMETERS: walk_state - Current state of the parse tree walk 111 * out_op - Where to return op if a new one is created 112 * 113 * RETURN: Status 114 * 115 * DESCRIPTION: Descending callback used during the loading of ACPI tables. 116 * 117 ******************************************************************************/ 118 119 acpi_status 120 acpi_ds_load1_begin_op(struct acpi_walk_state * walk_state, 121 union acpi_parse_object ** out_op) 122 { 123 union acpi_parse_object *op; 124 struct acpi_namespace_node *node; 125 acpi_status status; 126 acpi_object_type object_type; 127 char *path; 128 u32 flags; 129 130 ACPI_FUNCTION_TRACE(ds_load1_begin_op); 131 132 op = walk_state->op; 133 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, "Op=%p State=%p\n", op, 134 walk_state)); 135 136 /* We are only interested in opcodes that have an associated name */ 137 138 if (op) { 139 if (!(walk_state->op_info->flags & AML_NAMED)) { 140 *out_op = op; 141 return_ACPI_STATUS(AE_OK); 142 } 143 144 /* Check if this object has already been installed in the namespace */ 145 146 if (op->common.node) { 147 *out_op = op; 148 return_ACPI_STATUS(AE_OK); 149 } 150 } 151 152 path = acpi_ps_get_next_namestring(&walk_state->parser_state); 153 154 /* Map the raw opcode into an internal object type */ 155 156 object_type = walk_state->op_info->object_type; 157 158 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, 159 "State=%p Op=%p [%s]\n", walk_state, op, 160 acpi_ut_get_type_name(object_type))); 161 162 switch (walk_state->opcode) { 163 case AML_SCOPE_OP: 164 165 /* 166 * The target name of the Scope() operator must exist at this point so 167 * that we can actually open the scope to enter new names underneath it. 168 * Allow search-to-root for single namesegs. 169 */ 170 status = 171 acpi_ns_lookup(walk_state->scope_info, path, object_type, 172 ACPI_IMODE_EXECUTE, ACPI_NS_SEARCH_PARENT, 173 walk_state, &(node)); 174 #ifdef ACPI_ASL_COMPILER 175 if (status == AE_NOT_FOUND) { 176 /* 177 * Table disassembly: 178 * Target of Scope() not found. Generate an External for it, and 179 * insert the name into the namespace. 180 */ 181 acpi_dm_add_to_external_list(path, ACPI_TYPE_DEVICE, 0); 182 status = 183 acpi_ns_lookup(walk_state->scope_info, path, 184 object_type, ACPI_IMODE_LOAD_PASS1, 185 ACPI_NS_SEARCH_PARENT, walk_state, 186 &node); 187 } 188 #endif 189 if (ACPI_FAILURE(status)) { 190 ACPI_ERROR_NAMESPACE(path, status); 191 return_ACPI_STATUS(status); 192 } 193 194 /* 195 * Check to make sure that the target is 196 * one of the opcodes that actually opens a scope 197 */ 198 switch (node->type) { 199 case ACPI_TYPE_ANY: 200 case ACPI_TYPE_LOCAL_SCOPE: /* Scope */ 201 case ACPI_TYPE_DEVICE: 202 case ACPI_TYPE_POWER: 203 case ACPI_TYPE_PROCESSOR: 204 case ACPI_TYPE_THERMAL: 205 206 /* These are acceptable types */ 207 break; 208 209 case ACPI_TYPE_INTEGER: 210 case ACPI_TYPE_STRING: 211 case ACPI_TYPE_BUFFER: 212 213 /* 214 * These types we will allow, but we will change the type. 215 * This enables some existing code of the form: 216 * 217 * Name (DEB, 0) 218 * Scope (DEB) { ... } 219 * 220 * Note: silently change the type here. On the second pass, 221 * we will report a warning 222 */ 223 ACPI_DEBUG_PRINT((ACPI_DB_INFO, 224 "Type override - [%4.4s] had invalid type (%s) " 225 "for Scope operator, changed to type ANY\n", 226 acpi_ut_get_node_name(node), 227 acpi_ut_get_type_name(node->type))); 228 229 node->type = ACPI_TYPE_ANY; 230 walk_state->scope_info->common.value = ACPI_TYPE_ANY; 231 break; 232 233 case ACPI_TYPE_METHOD: 234 235 /* 236 * Allow scope change to root during execution of module-level 237 * code. Root is typed METHOD during this time. 238 */ 239 if ((node == acpi_gbl_root_node) && 240 (walk_state-> 241 parse_flags & ACPI_PARSE_MODULE_LEVEL)) { 242 break; 243 } 244 245 /*lint -fallthrough */ 246 247 default: 248 249 /* All other types are an error */ 250 251 ACPI_ERROR((AE_INFO, 252 "Invalid type (%s) for target of " 253 "Scope operator [%4.4s] (Cannot override)", 254 acpi_ut_get_type_name(node->type), 255 acpi_ut_get_node_name(node))); 256 257 return_ACPI_STATUS(AE_AML_OPERAND_TYPE); 258 } 259 break; 260 261 default: 262 /* 263 * For all other named opcodes, we will enter the name into 264 * the namespace. 265 * 266 * Setup the search flags. 267 * Since we are entering a name into the namespace, we do not want to 268 * enable the search-to-root upsearch. 269 * 270 * There are only two conditions where it is acceptable that the name 271 * already exists: 272 * 1) the Scope() operator can reopen a scoping object that was 273 * previously defined (Scope, Method, Device, etc.) 274 * 2) Whenever we are parsing a deferred opcode (op_region, Buffer, 275 * buffer_field, or Package), the name of the object is already 276 * in the namespace. 277 */ 278 if (walk_state->deferred_node) { 279 280 /* This name is already in the namespace, get the node */ 281 282 node = walk_state->deferred_node; 283 status = AE_OK; 284 break; 285 } 286 287 /* 288 * If we are executing a method, do not create any namespace objects 289 * during the load phase, only during execution. 290 */ 291 if (walk_state->method_node) { 292 node = NULL; 293 status = AE_OK; 294 break; 295 } 296 297 flags = ACPI_NS_NO_UPSEARCH; 298 if ((walk_state->opcode != AML_SCOPE_OP) && 299 (!(walk_state->parse_flags & ACPI_PARSE_DEFERRED_OP))) { 300 flags |= ACPI_NS_ERROR_IF_FOUND; 301 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, 302 "[%s] Cannot already exist\n", 303 acpi_ut_get_type_name(object_type))); 304 } else { 305 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, 306 "[%s] Both Find or Create allowed\n", 307 acpi_ut_get_type_name(object_type))); 308 } 309 310 /* 311 * Enter the named type into the internal namespace. We enter the name 312 * as we go downward in the parse tree. Any necessary subobjects that 313 * involve arguments to the opcode must be created as we go back up the 314 * parse tree later. 315 */ 316 status = 317 acpi_ns_lookup(walk_state->scope_info, path, object_type, 318 ACPI_IMODE_LOAD_PASS1, flags, walk_state, 319 &node); 320 if (ACPI_FAILURE(status)) { 321 if (status == AE_ALREADY_EXISTS) { 322 323 /* The name already exists in this scope */ 324 325 if (node->flags & ANOBJ_IS_EXTERNAL) { 326 /* 327 * Allow one create on an object or segment that was 328 * previously declared External 329 */ 330 node->flags &= ~ANOBJ_IS_EXTERNAL; 331 node->type = (u8) object_type; 332 333 /* Just retyped a node, probably will need to open a scope */ 334 335 if (acpi_ns_opens_scope(object_type)) { 336 status = 337 acpi_ds_scope_stack_push 338 (node, object_type, 339 walk_state); 340 if (ACPI_FAILURE(status)) { 341 return_ACPI_STATUS 342 (status); 343 } 344 } 345 346 status = AE_OK; 347 } 348 } 349 350 if (ACPI_FAILURE(status)) { 351 ACPI_ERROR_NAMESPACE(path, status); 352 return_ACPI_STATUS(status); 353 } 354 } 355 break; 356 } 357 358 /* Common exit */ 359 360 if (!op) { 361 362 /* Create a new op */ 363 364 op = acpi_ps_alloc_op(walk_state->opcode); 365 if (!op) { 366 return_ACPI_STATUS(AE_NO_MEMORY); 367 } 368 } 369 370 /* Initialize the op */ 371 372 #if (defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)) 373 op->named.path = ACPI_CAST_PTR(u8, path); 374 #endif 375 376 if (node) { 377 /* 378 * Put the Node in the "op" object that the parser uses, so we 379 * can get it again quickly when this scope is closed 380 */ 381 op->common.node = node; 382 op->named.name = node->name.integer; 383 } 384 385 acpi_ps_append_arg(acpi_ps_get_parent_scope(&walk_state->parser_state), 386 op); 387 *out_op = op; 388 return_ACPI_STATUS(status); 389 } 390 391 /******************************************************************************* 392 * 393 * FUNCTION: acpi_ds_load1_end_op 394 * 395 * PARAMETERS: walk_state - Current state of the parse tree walk 396 * 397 * RETURN: Status 398 * 399 * DESCRIPTION: Ascending callback used during the loading of the namespace, 400 * both control methods and everything else. 401 * 402 ******************************************************************************/ 403 404 acpi_status acpi_ds_load1_end_op(struct acpi_walk_state *walk_state) 405 { 406 union acpi_parse_object *op; 407 acpi_object_type object_type; 408 acpi_status status = AE_OK; 409 410 ACPI_FUNCTION_TRACE(ds_load1_end_op); 411 412 op = walk_state->op; 413 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, "Op=%p State=%p\n", op, 414 walk_state)); 415 416 /* We are only interested in opcodes that have an associated name */ 417 418 if (!(walk_state->op_info->flags & (AML_NAMED | AML_FIELD))) { 419 return_ACPI_STATUS(AE_OK); 420 } 421 422 /* Get the object type to determine if we should pop the scope */ 423 424 object_type = walk_state->op_info->object_type; 425 426 #ifndef ACPI_NO_METHOD_EXECUTION 427 if (walk_state->op_info->flags & AML_FIELD) { 428 /* 429 * If we are executing a method, do not create any namespace objects 430 * during the load phase, only during execution. 431 */ 432 if (!walk_state->method_node) { 433 if (walk_state->opcode == AML_FIELD_OP || 434 walk_state->opcode == AML_BANK_FIELD_OP || 435 walk_state->opcode == AML_INDEX_FIELD_OP) { 436 status = 437 acpi_ds_init_field_objects(op, walk_state); 438 } 439 } 440 return_ACPI_STATUS(status); 441 } 442 443 /* 444 * If we are executing a method, do not create any namespace objects 445 * during the load phase, only during execution. 446 */ 447 if (!walk_state->method_node) { 448 if (op->common.aml_opcode == AML_REGION_OP) { 449 status = 450 acpi_ex_create_region(op->named.data, 451 op->named.length, 452 (acpi_adr_space_type) ((op-> 453 common. 454 value. 455 arg)-> 456 common. 457 value. 458 integer), 459 walk_state); 460 if (ACPI_FAILURE(status)) { 461 return_ACPI_STATUS(status); 462 } 463 } else if (op->common.aml_opcode == AML_DATA_REGION_OP) { 464 status = 465 acpi_ex_create_region(op->named.data, 466 op->named.length, 467 ACPI_ADR_SPACE_DATA_TABLE, 468 walk_state); 469 if (ACPI_FAILURE(status)) { 470 return_ACPI_STATUS(status); 471 } 472 } 473 } 474 #endif 475 476 if (op->common.aml_opcode == AML_NAME_OP) { 477 478 /* For Name opcode, get the object type from the argument */ 479 480 if (op->common.value.arg) { 481 object_type = (acpi_ps_get_opcode_info((op->common. 482 value.arg)-> 483 common. 484 aml_opcode))-> 485 object_type; 486 487 /* Set node type if we have a namespace node */ 488 489 if (op->common.node) { 490 op->common.node->type = (u8) object_type; 491 } 492 } 493 } 494 495 /* 496 * If we are executing a method, do not create any namespace objects 497 * during the load phase, only during execution. 498 */ 499 if (!walk_state->method_node) { 500 if (op->common.aml_opcode == AML_METHOD_OP) { 501 /* 502 * method_op pkg_length name_string method_flags term_list 503 * 504 * Note: We must create the method node/object pair as soon as we 505 * see the method declaration. This allows later pass1 parsing 506 * of invocations of the method (need to know the number of 507 * arguments.) 508 */ 509 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, 510 "LOADING-Method: State=%p Op=%p NamedObj=%p\n", 511 walk_state, op, op->named.node)); 512 513 if (!acpi_ns_get_attached_object(op->named.node)) { 514 walk_state->operands[0] = 515 ACPI_CAST_PTR(void, op->named.node); 516 walk_state->num_operands = 1; 517 518 status = 519 acpi_ds_create_operands(walk_state, 520 op->common.value. 521 arg); 522 if (ACPI_SUCCESS(status)) { 523 status = 524 acpi_ex_create_method(op->named. 525 data, 526 op->named. 527 length, 528 walk_state); 529 } 530 531 walk_state->operands[0] = NULL; 532 walk_state->num_operands = 0; 533 534 if (ACPI_FAILURE(status)) { 535 return_ACPI_STATUS(status); 536 } 537 } 538 } 539 } 540 541 /* Pop the scope stack (only if loading a table) */ 542 543 if (!walk_state->method_node && acpi_ns_opens_scope(object_type)) { 544 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, 545 "(%s): Popping scope for Op %p\n", 546 acpi_ut_get_type_name(object_type), op)); 547 548 status = acpi_ds_scope_stack_pop(walk_state); 549 } 550 551 return_ACPI_STATUS(status); 552 } 553