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 #define __DSWLOAD_C__ 45 46 #include <contrib/dev/acpica/include/acpi.h> 47 #include <contrib/dev/acpica/include/accommon.h> 48 #include <contrib/dev/acpica/include/acparser.h> 49 #include <contrib/dev/acpica/include/amlcode.h> 50 #include <contrib/dev/acpica/include/acdispat.h> 51 #include <contrib/dev/acpica/include/acinterp.h> 52 #include <contrib/dev/acpica/include/acnamesp.h> 53 54 #ifdef ACPI_ASL_COMPILER 55 #include <contrib/dev/acpica/include/acdisasm.h> 56 #endif 57 58 #define _COMPONENT ACPI_DISPATCHER 59 ACPI_MODULE_NAME ("dswload") 60 61 62 /******************************************************************************* 63 * 64 * FUNCTION: AcpiDsInitCallbacks 65 * 66 * PARAMETERS: WalkState - Current state of the parse tree walk 67 * PassNumber - 1, 2, or 3 68 * 69 * RETURN: Status 70 * 71 * DESCRIPTION: Init walk state callbacks 72 * 73 ******************************************************************************/ 74 75 ACPI_STATUS 76 AcpiDsInitCallbacks ( 77 ACPI_WALK_STATE *WalkState, 78 UINT32 PassNumber) 79 { 80 81 switch (PassNumber) 82 { 83 case 1: 84 WalkState->ParseFlags = ACPI_PARSE_LOAD_PASS1 | 85 ACPI_PARSE_DELETE_TREE; 86 WalkState->DescendingCallback = AcpiDsLoad1BeginOp; 87 WalkState->AscendingCallback = AcpiDsLoad1EndOp; 88 break; 89 90 case 2: 91 WalkState->ParseFlags = ACPI_PARSE_LOAD_PASS1 | 92 ACPI_PARSE_DELETE_TREE; 93 WalkState->DescendingCallback = AcpiDsLoad2BeginOp; 94 WalkState->AscendingCallback = AcpiDsLoad2EndOp; 95 break; 96 97 case 3: 98 #ifndef ACPI_NO_METHOD_EXECUTION 99 WalkState->ParseFlags |= ACPI_PARSE_EXECUTE | 100 ACPI_PARSE_DELETE_TREE; 101 WalkState->DescendingCallback = AcpiDsExecBeginOp; 102 WalkState->AscendingCallback = AcpiDsExecEndOp; 103 #endif 104 break; 105 106 default: 107 return (AE_BAD_PARAMETER); 108 } 109 110 return (AE_OK); 111 } 112 113 114 /******************************************************************************* 115 * 116 * FUNCTION: AcpiDsLoad1BeginOp 117 * 118 * PARAMETERS: WalkState - Current state of the parse tree walk 119 * OutOp - Where to return op if a new one is created 120 * 121 * RETURN: Status 122 * 123 * DESCRIPTION: Descending callback used during the loading of ACPI tables. 124 * 125 ******************************************************************************/ 126 127 ACPI_STATUS 128 AcpiDsLoad1BeginOp ( 129 ACPI_WALK_STATE *WalkState, 130 ACPI_PARSE_OBJECT **OutOp) 131 { 132 ACPI_PARSE_OBJECT *Op; 133 ACPI_NAMESPACE_NODE *Node; 134 ACPI_STATUS Status; 135 ACPI_OBJECT_TYPE ObjectType; 136 char *Path; 137 UINT32 Flags; 138 139 140 ACPI_FUNCTION_TRACE (DsLoad1BeginOp); 141 142 143 Op = WalkState->Op; 144 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "Op=%p State=%p\n", Op, WalkState)); 145 146 /* We are only interested in opcodes that have an associated name */ 147 148 if (Op) 149 { 150 if (!(WalkState->OpInfo->Flags & AML_NAMED)) 151 { 152 *OutOp = Op; 153 return_ACPI_STATUS (AE_OK); 154 } 155 156 /* Check if this object has already been installed in the namespace */ 157 158 if (Op->Common.Node) 159 { 160 *OutOp = Op; 161 return_ACPI_STATUS (AE_OK); 162 } 163 } 164 165 Path = AcpiPsGetNextNamestring (&WalkState->ParserState); 166 167 /* Map the raw opcode into an internal object type */ 168 169 ObjectType = WalkState->OpInfo->ObjectType; 170 171 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, 172 "State=%p Op=%p [%s]\n", WalkState, Op, AcpiUtGetTypeName (ObjectType))); 173 174 switch (WalkState->Opcode) 175 { 176 case AML_SCOPE_OP: 177 178 /* 179 * The target name of the Scope() operator must exist at this point so 180 * that we can actually open the scope to enter new names underneath it. 181 * Allow search-to-root for single namesegs. 182 */ 183 Status = AcpiNsLookup (WalkState->ScopeInfo, Path, ObjectType, 184 ACPI_IMODE_EXECUTE, ACPI_NS_SEARCH_PARENT, WalkState, &(Node)); 185 #ifdef ACPI_ASL_COMPILER 186 if (Status == AE_NOT_FOUND) 187 { 188 /* 189 * Table disassembly: 190 * Target of Scope() not found. Generate an External for it, and 191 * insert the name into the namespace. 192 */ 193 AcpiDmAddToExternalList (Op, Path, ACPI_TYPE_DEVICE, 0); 194 Status = AcpiNsLookup (WalkState->ScopeInfo, Path, ObjectType, 195 ACPI_IMODE_LOAD_PASS1, ACPI_NS_SEARCH_PARENT, 196 WalkState, &Node); 197 } 198 #endif 199 if (ACPI_FAILURE (Status)) 200 { 201 ACPI_ERROR_NAMESPACE (Path, Status); 202 return_ACPI_STATUS (Status); 203 } 204 205 /* 206 * Check to make sure that the target is 207 * one of the opcodes that actually opens a scope 208 */ 209 switch (Node->Type) 210 { 211 case ACPI_TYPE_ANY: 212 case ACPI_TYPE_LOCAL_SCOPE: /* Scope */ 213 case ACPI_TYPE_DEVICE: 214 case ACPI_TYPE_POWER: 215 case ACPI_TYPE_PROCESSOR: 216 case ACPI_TYPE_THERMAL: 217 218 /* These are acceptable types */ 219 break; 220 221 case ACPI_TYPE_INTEGER: 222 case ACPI_TYPE_STRING: 223 case ACPI_TYPE_BUFFER: 224 225 /* 226 * These types we will allow, but we will change the type. 227 * This enables some existing code of the form: 228 * 229 * Name (DEB, 0) 230 * Scope (DEB) { ... } 231 * 232 * Note: silently change the type here. On the second pass, 233 * we will report a warning 234 */ 235 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 236 "Type override - [%4.4s] had invalid type (%s) " 237 "for Scope operator, changed to type ANY\n", 238 AcpiUtGetNodeName (Node), AcpiUtGetTypeName (Node->Type))); 239 240 Node->Type = ACPI_TYPE_ANY; 241 WalkState->ScopeInfo->Common.Value = ACPI_TYPE_ANY; 242 break; 243 244 case ACPI_TYPE_METHOD: 245 246 /* 247 * Allow scope change to root during execution of module-level 248 * code. Root is typed METHOD during this time. 249 */ 250 if ((Node == AcpiGbl_RootNode) && 251 (WalkState->ParseFlags & ACPI_PARSE_MODULE_LEVEL)) 252 { 253 break; 254 } 255 256 /*lint -fallthrough */ 257 258 default: 259 260 /* All other types are an error */ 261 262 ACPI_ERROR ((AE_INFO, 263 "Invalid type (%s) for target of " 264 "Scope operator [%4.4s] (Cannot override)", 265 AcpiUtGetTypeName (Node->Type), AcpiUtGetNodeName (Node))); 266 267 return_ACPI_STATUS (AE_AML_OPERAND_TYPE); 268 } 269 break; 270 271 272 default: 273 /* 274 * For all other named opcodes, we will enter the name into 275 * the namespace. 276 * 277 * Setup the search flags. 278 * Since we are entering a name into the namespace, we do not want to 279 * enable the search-to-root upsearch. 280 * 281 * There are only two conditions where it is acceptable that the name 282 * already exists: 283 * 1) the Scope() operator can reopen a scoping object that was 284 * previously defined (Scope, Method, Device, etc.) 285 * 2) Whenever we are parsing a deferred opcode (OpRegion, Buffer, 286 * BufferField, or Package), the name of the object is already 287 * in the namespace. 288 */ 289 if (WalkState->DeferredNode) 290 { 291 /* This name is already in the namespace, get the node */ 292 293 Node = WalkState->DeferredNode; 294 Status = AE_OK; 295 break; 296 } 297 298 /* 299 * If we are executing a method, do not create any namespace objects 300 * during the load phase, only during execution. 301 */ 302 if (WalkState->MethodNode) 303 { 304 Node = NULL; 305 Status = AE_OK; 306 break; 307 } 308 309 Flags = ACPI_NS_NO_UPSEARCH; 310 if ((WalkState->Opcode != AML_SCOPE_OP) && 311 (!(WalkState->ParseFlags & ACPI_PARSE_DEFERRED_OP))) 312 { 313 Flags |= ACPI_NS_ERROR_IF_FOUND; 314 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "[%s] Cannot already exist\n", 315 AcpiUtGetTypeName (ObjectType))); 316 } 317 else 318 { 319 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, 320 "[%s] Both Find or Create allowed\n", 321 AcpiUtGetTypeName (ObjectType))); 322 } 323 324 /* 325 * Enter the named type into the internal namespace. We enter the name 326 * as we go downward in the parse tree. Any necessary subobjects that 327 * involve arguments to the opcode must be created as we go back up the 328 * parse tree later. 329 */ 330 Status = AcpiNsLookup (WalkState->ScopeInfo, Path, ObjectType, 331 ACPI_IMODE_LOAD_PASS1, Flags, WalkState, &Node); 332 if (ACPI_FAILURE (Status)) 333 { 334 if (Status == AE_ALREADY_EXISTS) 335 { 336 /* The name already exists in this scope */ 337 338 if (Node->Flags & ANOBJ_IS_EXTERNAL) 339 { 340 /* 341 * Allow one create on an object or segment that was 342 * previously declared External 343 */ 344 Node->Flags &= ~ANOBJ_IS_EXTERNAL; 345 Node->Type = (UINT8) ObjectType; 346 347 /* Just retyped a node, probably will need to open a scope */ 348 349 if (AcpiNsOpensScope (ObjectType)) 350 { 351 Status = AcpiDsScopeStackPush (Node, ObjectType, WalkState); 352 if (ACPI_FAILURE (Status)) 353 { 354 return_ACPI_STATUS (Status); 355 } 356 } 357 358 Status = AE_OK; 359 } 360 } 361 362 if (ACPI_FAILURE (Status)) 363 { 364 ACPI_ERROR_NAMESPACE (Path, Status); 365 return_ACPI_STATUS (Status); 366 } 367 } 368 break; 369 } 370 371 /* Common exit */ 372 373 if (!Op) 374 { 375 /* Create a new op */ 376 377 Op = AcpiPsAllocOp (WalkState->Opcode); 378 if (!Op) 379 { 380 return_ACPI_STATUS (AE_NO_MEMORY); 381 } 382 } 383 384 /* Initialize the op */ 385 386 #if (defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)) 387 Op->Named.Path = ACPI_CAST_PTR (UINT8, Path); 388 #endif 389 390 if (Node) 391 { 392 /* 393 * Put the Node in the "op" object that the parser uses, so we 394 * can get it again quickly when this scope is closed 395 */ 396 Op->Common.Node = Node; 397 Op->Named.Name = Node->Name.Integer; 398 } 399 400 AcpiPsAppendArg (AcpiPsGetParentScope (&WalkState->ParserState), Op); 401 *OutOp = Op; 402 return_ACPI_STATUS (Status); 403 } 404 405 406 /******************************************************************************* 407 * 408 * FUNCTION: AcpiDsLoad1EndOp 409 * 410 * PARAMETERS: WalkState - Current state of the parse tree walk 411 * 412 * RETURN: Status 413 * 414 * DESCRIPTION: Ascending callback used during the loading of the namespace, 415 * both control methods and everything else. 416 * 417 ******************************************************************************/ 418 419 ACPI_STATUS 420 AcpiDsLoad1EndOp ( 421 ACPI_WALK_STATE *WalkState) 422 { 423 ACPI_PARSE_OBJECT *Op; 424 ACPI_OBJECT_TYPE ObjectType; 425 ACPI_STATUS Status = AE_OK; 426 427 428 ACPI_FUNCTION_TRACE (DsLoad1EndOp); 429 430 431 Op = WalkState->Op; 432 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "Op=%p State=%p\n", Op, WalkState)); 433 434 /* We are only interested in opcodes that have an associated name */ 435 436 if (!(WalkState->OpInfo->Flags & (AML_NAMED | AML_FIELD))) 437 { 438 return_ACPI_STATUS (AE_OK); 439 } 440 441 /* Get the object type to determine if we should pop the scope */ 442 443 ObjectType = WalkState->OpInfo->ObjectType; 444 445 #ifndef ACPI_NO_METHOD_EXECUTION 446 if (WalkState->OpInfo->Flags & AML_FIELD) 447 { 448 /* 449 * If we are executing a method, do not create any namespace objects 450 * during the load phase, only during execution. 451 */ 452 if (!WalkState->MethodNode) 453 { 454 if (WalkState->Opcode == AML_FIELD_OP || 455 WalkState->Opcode == AML_BANK_FIELD_OP || 456 WalkState->Opcode == AML_INDEX_FIELD_OP) 457 { 458 Status = AcpiDsInitFieldObjects (Op, WalkState); 459 } 460 } 461 return_ACPI_STATUS (Status); 462 } 463 464 /* 465 * If we are executing a method, do not create any namespace objects 466 * during the load phase, only during execution. 467 */ 468 if (!WalkState->MethodNode) 469 { 470 if (Op->Common.AmlOpcode == AML_REGION_OP) 471 { 472 Status = AcpiExCreateRegion (Op->Named.Data, Op->Named.Length, 473 (ACPI_ADR_SPACE_TYPE) ((Op->Common.Value.Arg)->Common.Value.Integer), 474 WalkState); 475 if (ACPI_FAILURE (Status)) 476 { 477 return_ACPI_STATUS (Status); 478 } 479 } 480 else if (Op->Common.AmlOpcode == AML_DATA_REGION_OP) 481 { 482 Status = AcpiExCreateRegion (Op->Named.Data, Op->Named.Length, 483 ACPI_ADR_SPACE_DATA_TABLE, WalkState); 484 if (ACPI_FAILURE (Status)) 485 { 486 return_ACPI_STATUS (Status); 487 } 488 } 489 } 490 #endif 491 492 if (Op->Common.AmlOpcode == AML_NAME_OP) 493 { 494 /* For Name opcode, get the object type from the argument */ 495 496 if (Op->Common.Value.Arg) 497 { 498 ObjectType = (AcpiPsGetOpcodeInfo ( 499 (Op->Common.Value.Arg)->Common.AmlOpcode))->ObjectType; 500 501 /* Set node type if we have a namespace node */ 502 503 if (Op->Common.Node) 504 { 505 Op->Common.Node->Type = (UINT8) ObjectType; 506 } 507 } 508 } 509 510 /* 511 * If we are executing a method, do not create any namespace objects 512 * during the load phase, only during execution. 513 */ 514 if (!WalkState->MethodNode) 515 { 516 if (Op->Common.AmlOpcode == AML_METHOD_OP) 517 { 518 /* 519 * MethodOp PkgLength NameString MethodFlags TermList 520 * 521 * Note: We must create the method node/object pair as soon as we 522 * see the method declaration. This allows later pass1 parsing 523 * of invocations of the method (need to know the number of 524 * arguments.) 525 */ 526 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, 527 "LOADING-Method: State=%p Op=%p NamedObj=%p\n", 528 WalkState, Op, Op->Named.Node)); 529 530 if (!AcpiNsGetAttachedObject (Op->Named.Node)) 531 { 532 WalkState->Operands[0] = ACPI_CAST_PTR (void, Op->Named.Node); 533 WalkState->NumOperands = 1; 534 535 Status = AcpiDsCreateOperands (WalkState, Op->Common.Value.Arg); 536 if (ACPI_SUCCESS (Status)) 537 { 538 Status = AcpiExCreateMethod (Op->Named.Data, 539 Op->Named.Length, WalkState); 540 } 541 542 WalkState->Operands[0] = NULL; 543 WalkState->NumOperands = 0; 544 545 if (ACPI_FAILURE (Status)) 546 { 547 return_ACPI_STATUS (Status); 548 } 549 } 550 } 551 } 552 553 /* Pop the scope stack (only if loading a table) */ 554 555 if (!WalkState->MethodNode && 556 AcpiNsOpensScope (ObjectType)) 557 { 558 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "(%s): Popping scope for Op %p\n", 559 AcpiUtGetTypeName (ObjectType), Op)); 560 561 Status = AcpiDsScopeStackPop (WalkState); 562 } 563 564 return_ACPI_STATUS (Status); 565 } 566