nsaccess.c revision 99146
1/******************************************************************************* 2 * 3 * Module Name: nsaccess - Top-level functions for accessing ACPI namespace 4 * $Revision: 153 $ 5 * 6 ******************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117#define __NSACCESS_C__ 118 119#include "acpi.h" 120#include "amlcode.h" 121#include "acinterp.h" 122#include "acnamesp.h" 123#include "acdispat.h" 124 125 126#define _COMPONENT ACPI_NAMESPACE 127 ACPI_MODULE_NAME ("nsaccess") 128 129 130/******************************************************************************* 131 * 132 * FUNCTION: AcpiNsRootInitialize 133 * 134 * PARAMETERS: None 135 * 136 * RETURN: Status 137 * 138 * DESCRIPTION: Allocate and initialize the default root named objects 139 * 140 * MUTEX: Locks namespace for entire execution 141 * 142 ******************************************************************************/ 143 144ACPI_STATUS 145AcpiNsRootInitialize (void) 146{ 147 ACPI_STATUS Status; 148 const ACPI_PREDEFINED_NAMES *InitVal = NULL; 149 ACPI_NAMESPACE_NODE *NewNode; 150 ACPI_OPERAND_OBJECT *ObjDesc; 151 152 153 ACPI_FUNCTION_TRACE ("NsRootInitialize"); 154 155 156 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 157 if (ACPI_FAILURE (Status)) 158 { 159 return_ACPI_STATUS (Status); 160 } 161 162 /* 163 * The global root ptr is initially NULL, so a non-NULL value indicates 164 * that AcpiNsRootInitialize() has already been called; just return. 165 */ 166 if (AcpiGbl_RootNode) 167 { 168 Status = AE_OK; 169 goto UnlockAndExit; 170 } 171 172 /* 173 * Tell the rest of the subsystem that the root is initialized 174 * (This is OK because the namespace is locked) 175 */ 176 AcpiGbl_RootNode = &AcpiGbl_RootNodeStruct; 177 178 /* Enter the pre-defined names in the name table */ 179 180 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 181 "Entering predefined entries into namespace\n")); 182 183 for (InitVal = AcpiGbl_PreDefinedNames; InitVal->Name; InitVal++) 184 { 185 Status = AcpiNsLookup (NULL, InitVal->Name, InitVal->Type, 186 ACPI_IMODE_LOAD_PASS2, ACPI_NS_NO_UPSEARCH, NULL, &NewNode); 187 188 if (ACPI_FAILURE (Status) || (!NewNode)) /* Must be on same line for code converter */ 189 { 190 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, 191 "Could not create predefined name %s, %s\n", 192 InitVal->Name, AcpiFormatException (Status))); 193 } 194 195 /* 196 * Name entered successfully. 197 * If entry in PreDefinedNames[] specifies an 198 * initial value, create the initial value. 199 */ 200 if (InitVal->Val) 201 { 202 /* 203 * Entry requests an initial value, allocate a 204 * descriptor for it. 205 */ 206 ObjDesc = AcpiUtCreateInternalObject (InitVal->Type); 207 if (!ObjDesc) 208 { 209 Status = AE_NO_MEMORY; 210 goto UnlockAndExit; 211 } 212 213 /* 214 * Convert value string from table entry to 215 * internal representation. Only types actually 216 * used for initial values are implemented here. 217 */ 218 switch (InitVal->Type) 219 { 220 case ACPI_TYPE_INTEGER: 221 222 ObjDesc->Integer.Value = 223 (ACPI_INTEGER) ACPI_STRTOUL (InitVal->Val, NULL, 10); 224 break; 225 226 227 case ACPI_TYPE_STRING: 228 229 /* 230 * Build an object around the static string 231 */ 232 ObjDesc->String.Length = ACPI_STRLEN (InitVal->Val); 233 ObjDesc->String.Pointer = InitVal->Val; 234 ObjDesc->Common.Flags |= AOPOBJ_STATIC_POINTER; 235 break; 236 237 238 case ACPI_TYPE_MUTEX: 239 240 ObjDesc->Mutex.SyncLevel = 241 (UINT16) ACPI_STRTOUL (InitVal->Val, NULL, 10); 242 243 if (ACPI_STRCMP (InitVal->Name, "_GL_") == 0) 244 { 245 /* 246 * Create a counting semaphore for the 247 * global lock 248 */ 249 Status = AcpiOsCreateSemaphore (ACPI_NO_UNIT_LIMIT, 250 1, &ObjDesc->Mutex.Semaphore); 251 if (ACPI_FAILURE (Status)) 252 { 253 goto UnlockAndExit; 254 } 255 256 /* 257 * We just created the mutex for the 258 * global lock, save it 259 */ 260 AcpiGbl_GlobalLockSemaphore = ObjDesc->Mutex.Semaphore; 261 } 262 else 263 { 264 /* Create a mutex */ 265 266 Status = AcpiOsCreateSemaphore (1, 1, 267 &ObjDesc->Mutex.Semaphore); 268 if (ACPI_FAILURE (Status)) 269 { 270 goto UnlockAndExit; 271 } 272 } 273 break; 274 275 276 default: 277 ACPI_REPORT_ERROR (("Unsupported initial type value %X\n", 278 InitVal->Type)); 279 AcpiUtRemoveReference (ObjDesc); 280 ObjDesc = NULL; 281 continue; 282 } 283 284 /* Store pointer to value descriptor in the Node */ 285 286 AcpiNsAttachObject (NewNode, ObjDesc, ObjDesc->Common.Type); 287 288 /* Remove local reference to the object */ 289 290 AcpiUtRemoveReference (ObjDesc); 291 } 292 } 293 294 295UnlockAndExit: 296 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 297 return_ACPI_STATUS (Status); 298} 299 300 301/******************************************************************************* 302 * 303 * FUNCTION: AcpiNsLookup 304 * 305 * PARAMETERS: PrefixNode - Search scope if name is not fully qualified 306 * Pathname - Search pathname, in internal format 307 * (as represented in the AML stream) 308 * Type - Type associated with name 309 * InterpreterMode - IMODE_LOAD_PASS2 => add name if not found 310 * Flags - Flags describing the search restrictions 311 * WalkState - Current state of the walk 312 * ReturnNode - Where the Node is placed (if found 313 * or created successfully) 314 * 315 * RETURN: Status 316 * 317 * DESCRIPTION: Find or enter the passed name in the name space. 318 * Log an error if name not found in Exec mode. 319 * 320 * MUTEX: Assumes namespace is locked. 321 * 322 ******************************************************************************/ 323 324ACPI_STATUS 325AcpiNsLookup ( 326 ACPI_GENERIC_STATE *ScopeInfo, 327 NATIVE_CHAR *Pathname, 328 ACPI_OBJECT_TYPE Type, 329 ACPI_INTERPRETER_MODE InterpreterMode, 330 UINT32 Flags, 331 ACPI_WALK_STATE *WalkState, 332 ACPI_NAMESPACE_NODE **ReturnNode) 333{ 334 ACPI_STATUS Status; 335 ACPI_NAMESPACE_NODE *PrefixNode; 336 ACPI_NAMESPACE_NODE *CurrentNode = NULL; 337 ACPI_NAMESPACE_NODE *ThisNode = NULL; 338 UINT32 NumSegments; 339 ACPI_NAME SimpleName; 340 ACPI_OBJECT_TYPE TypeToCheckFor; 341 ACPI_OBJECT_TYPE ThisSearchType; 342 UINT32 LocalFlags = Flags & ~ACPI_NS_ERROR_IF_FOUND; 343 344 345 ACPI_FUNCTION_TRACE ("NsLookup"); 346 347 348 if (!ReturnNode) 349 { 350 return_ACPI_STATUS (AE_BAD_PARAMETER); 351 } 352 353 AcpiGbl_NsLookupCount++; 354 *ReturnNode = ACPI_ENTRY_NOT_FOUND; 355 356 if (!AcpiGbl_RootNode) 357 { 358 return_ACPI_STATUS (AE_NO_NAMESPACE); 359 } 360 361 /* 362 * Get the prefix scope. 363 * A null scope means use the root scope 364 */ 365 if ((!ScopeInfo) || 366 (!ScopeInfo->Scope.Node)) 367 { 368 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 369 "Null scope prefix, using root node (%p)\n", 370 AcpiGbl_RootNode)); 371 372 PrefixNode = AcpiGbl_RootNode; 373 } 374 else 375 { 376 PrefixNode = ScopeInfo->Scope.Node; 377 } 378 379 /* 380 * This check is explicitly split to relax the TypeToCheckFor 381 * conditions for BankFieldDefn. Originally, both BankFieldDefn and 382 * DefFieldDefn caused TypeToCheckFor to be set to ACPI_TYPE_REGION, 383 * but the BankFieldDefn may also check for a Field definition as well 384 * as an OperationRegion. 385 */ 386 if (INTERNAL_TYPE_FIELD_DEFN == Type) 387 { 388 /* DefFieldDefn defines fields in a Region */ 389 390 TypeToCheckFor = ACPI_TYPE_REGION; 391 } 392 else if (INTERNAL_TYPE_BANK_FIELD_DEFN == Type) 393 { 394 /* BankFieldDefn defines data fields in a Field Object */ 395 396 TypeToCheckFor = ACPI_TYPE_ANY; 397 } 398 else 399 { 400 TypeToCheckFor = Type; 401 } 402 403 /* 404 * Begin examination of the actual pathname 405 */ 406 if (!Pathname) 407 { 408 /* A Null NamePath is allowed and refers to the root */ 409 410 NumSegments = 0; 411 ThisNode = AcpiGbl_RootNode; 412 413 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 414 "Null Pathname (Zero segments), Flags=%x\n", Flags)); 415 } 416 else 417 { 418 /* 419 * Name pointer is valid (and must be in internal name format) 420 * 421 * Check for scope prefixes: 422 * 423 * As represented in the AML stream, a namepath consists of an 424 * optional scope prefix followed by a name segment part. 425 * 426 * If present, the scope prefix is either a Root Prefix (in 427 * which case the name is fully qualified), or one or more 428 * Parent Prefixes (in which case the name's scope is relative 429 * to the current scope). 430 */ 431 if (*Pathname == AML_ROOT_PREFIX) 432 { 433 /* Pathname is fully qualified, start from the root */ 434 435 ThisNode = AcpiGbl_RootNode; 436 437 /* Point to name segment part */ 438 439 Pathname++; 440 441 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Searching from root [%p]\n", 442 ThisNode)); 443 } 444 else 445 { 446 /* Pathname is relative to current scope, start there */ 447 448 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 449 "Searching relative to pfx scope [%p]\n", 450 PrefixNode)); 451 452 /* 453 * Handle multiple Parent Prefixes (carat) by just getting 454 * the parent node for each prefix instance. 455 */ 456 ThisNode = PrefixNode; 457 while (*Pathname == AML_PARENT_PREFIX) 458 { 459 /* 460 * Point past this prefix to the name segment 461 * part or the next Parent Prefix 462 */ 463 Pathname++; 464 465 /* Backup to the parent node */ 466 467 ThisNode = AcpiNsGetParentNode (ThisNode); 468 if (!ThisNode) 469 { 470 /* Current scope has no parent scope */ 471 472 ACPI_REPORT_ERROR ( 473 ("ACPI path has too many parent prefixes (^) - reached beyond root node\n")); 474 return_ACPI_STATUS (AE_NOT_FOUND); 475 } 476 } 477 } 478 479 /* 480 * Determine the number of ACPI name segments in this pathname. 481 * 482 * The segment part consists of either: 483 * - A Null name segment (0) 484 * - A DualNamePrefix followed by two 4-byte name segments 485 * - A MultiNamePrefix followed by a byte indicating the 486 * number of segments and the segments themselves. 487 * - A single 4-byte name segment 488 * 489 * Examine the name prefix opcode, if any, to determine the number of 490 * segments. 491 */ 492 switch (*Pathname) 493 { 494 case 0: 495 /* 496 * Null name after a root or parent prefixes. We already 497 * have the correct target node and there are no name segments. 498 */ 499 NumSegments = 0; 500 501 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 502 "Prefix-only Pathname (Zero name segments), Flags=%x\n", Flags)); 503 break; 504 505 case AML_DUAL_NAME_PREFIX: 506 507 /* Two segments, point to first name segment */ 508 509 NumSegments = 2; 510 Pathname++; 511 512 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 513 "Dual Pathname (2 segments, Flags=%X)\n", Flags)); 514 break; 515 516 case AML_MULTI_NAME_PREFIX_OP: 517 518 /* Extract segment count, point to first name segment */ 519 520 Pathname++; 521 NumSegments = (UINT32) (UINT8) *Pathname; 522 Pathname++; 523 524 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 525 "Multi Pathname (%d Segments, Flags=%X) \n", 526 NumSegments, Flags)); 527 break; 528 529 default: 530 /* 531 * Not a Null name, no Dual or Multi prefix, hence there is 532 * only one name segment and Pathname is already pointing to it. 533 */ 534 NumSegments = 1; 535 536 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 537 "Simple Pathname (1 segment, Flags=%X)\n", Flags)); 538 break; 539 } 540 541 ACPI_DEBUG_EXEC (AcpiNsPrintPathname (NumSegments, Pathname)); 542 } 543 544 /* 545 * Search namespace for each segment of the name. Loop through and 546 * verify/add each name segment. 547 */ 548 CurrentNode = ThisNode; 549 while (NumSegments && CurrentNode) 550 { 551 /* 552 * Search for the current name segment under the current 553 * named object. The Type is significant only at the last name 554 * segment. (We don't care about the types along the path, only 555 * the type of the final target object.) 556 */ 557 ThisSearchType = ACPI_TYPE_ANY; 558 NumSegments--; 559 if (!NumSegments) 560 { 561 ThisSearchType = Type; 562 LocalFlags = Flags; 563 } 564 565 /* Extract one ACPI name from the front of the pathname */ 566 567 ACPI_MOVE_UNALIGNED32_TO_32 (&SimpleName, Pathname); 568 569 /* Try to find the ACPI name */ 570 571 Status = AcpiNsSearchAndEnter (SimpleName, WalkState, CurrentNode, 572 InterpreterMode, ThisSearchType, LocalFlags, &ThisNode); 573 if (ACPI_FAILURE (Status)) 574 { 575 if (Status == AE_NOT_FOUND) 576 { 577 /* Name not found in ACPI namespace */ 578 579 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 580 "Name [%4.4s] not found in scope [%4.4s] %p\n", 581 (char *) &SimpleName, (char *) &CurrentNode->Name, CurrentNode)); 582 } 583 584 return_ACPI_STATUS (Status); 585 } 586 587 /* 588 * Sanity typecheck of the target object: 589 * 590 * If 1) This is the last segment (NumSegments == 0) 591 * 2) And we are looking for a specific type 592 * (Not checking for TYPE_ANY) 593 * 3) Which is not an alias 594 * 4) Which is not a local type (TYPE_DEF_ANY) 595 * 5) Which is not a local type (TYPE_SCOPE) 596 * 6) Which is not a local type (TYPE_INDEX_FIELD_DEFN) 597 * 7) And the type of target object is known (not TYPE_ANY) 598 * 8) And target object does not match what we are looking for 599 * 600 * Then we have a type mismatch. Just warn and ignore it. 601 */ 602 if ((NumSegments == 0) && 603 (TypeToCheckFor != ACPI_TYPE_ANY) && 604 (TypeToCheckFor != INTERNAL_TYPE_ALIAS) && 605 (TypeToCheckFor != INTERNAL_TYPE_DEF_ANY) && 606 (TypeToCheckFor != INTERNAL_TYPE_SCOPE) && 607 (TypeToCheckFor != INTERNAL_TYPE_INDEX_FIELD_DEFN) && 608 (ThisNode->Type != ACPI_TYPE_ANY) && 609 (ThisNode->Type != TypeToCheckFor)) 610 { 611 /* Complain about a type mismatch */ 612 613 ACPI_REPORT_WARNING ( 614 ("NsLookup: %4.4s, type %X, checking for type %X\n", 615 (char *) &SimpleName, ThisNode->Type, TypeToCheckFor)); 616 } 617 618 /* 619 * If this is the last name segment and we are not looking for a 620 * specific type, but the type of found object is known, use that type 621 * to see if it opens a scope. 622 */ 623 if ((NumSegments == 0) && (Type == ACPI_TYPE_ANY)) 624 { 625 Type = ThisNode->Type; 626 } 627 628 /* Point to next name segment and make this node current */ 629 630 Pathname += ACPI_NAME_SIZE; 631 CurrentNode = ThisNode; 632 } 633 634 /* 635 * Always check if we need to open a new scope 636 */ 637 if (!(Flags & ACPI_NS_DONT_OPEN_SCOPE) && (WalkState)) 638 { 639 /* 640 * If entry is a type which opens a scope, push the new scope on the 641 * scope stack. 642 */ 643 if (AcpiNsOpensScope (TypeToCheckFor)) 644 { 645 Status = AcpiDsScopeStackPush (ThisNode, Type, WalkState); 646 if (ACPI_FAILURE (Status)) 647 { 648 return_ACPI_STATUS (Status); 649 } 650 651 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 652 "Setting current scope to [%4.4s] (%p)\n", 653 ThisNode->Name.Ascii, ThisNode)); 654 } 655 } 656 657 *ReturnNode = ThisNode; 658 return_ACPI_STATUS (AE_OK); 659} 660 661