1 /*******************************************************************************
3 * Module Name: nsaccess - Top-level functions for accessing ACPI namespace
6 ******************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp.
13 * All rights reserved.
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
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
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;
38 * The above copyright and patent license is granted only if the following
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.
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
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
73 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
81 * 4. Disclaimer and Export Compliance
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
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
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.
115 *****************************************************************************/
117 #define __NSACCESS_C__
121 #include "acnamesp.h"
122 #include "acdispat.h"
125 #define _COMPONENT ACPI_NAMESPACE
126 ACPI_MODULE_NAME ("nsaccess")
129 /*******************************************************************************
131 * FUNCTION: AcpiNsRootInitialize
137 * DESCRIPTION: Allocate and initialize the default root named objects
139 * MUTEX: Locks namespace for entire execution
141 ******************************************************************************/
144 AcpiNsRootInitialize (
148 const ACPI_PREDEFINED_NAMES
*InitVal
= NULL
;
149 ACPI_NAMESPACE_NODE
*NewNode
;
150 ACPI_OPERAND_OBJECT
*ObjDesc
;
151 ACPI_STRING Val
= NULL
;
154 ACPI_FUNCTION_TRACE (NsRootInitialize
);
157 Status
= AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE
);
158 if (ACPI_FAILURE (Status
))
160 return_ACPI_STATUS (Status
);
164 * The global root ptr is initially NULL, so a non-NULL value indicates
165 * that AcpiNsRootInitialize() has already been called; just return.
167 if (AcpiGbl_RootNode
)
174 * Tell the rest of the subsystem that the root is initialized
175 * (This is OK because the namespace is locked)
177 AcpiGbl_RootNode
= &AcpiGbl_RootNodeStruct
;
179 /* Enter the pre-defined names in the name table */
181 ACPI_DEBUG_PRINT ((ACPI_DB_INFO
,
182 "Entering predefined entries into namespace\n"));
184 for (InitVal
= AcpiGbl_PreDefinedNames
; InitVal
->Name
; InitVal
++)
186 /* _OSI is optional for now, will be permanent later */
188 if (!ACPI_STRCMP (InitVal
->Name
, "_OSI") && !AcpiGbl_CreateOsiMethod
)
193 Status
= AcpiNsLookup (NULL
, InitVal
->Name
, InitVal
->Type
,
194 ACPI_IMODE_LOAD_PASS2
, ACPI_NS_NO_UPSEARCH
,
197 if (ACPI_FAILURE (Status
) || (!NewNode
)) /* Must be on same line for code converter */
199 ACPI_EXCEPTION ((AE_INFO
, Status
,
200 "Could not create predefined name %s",
205 * Name entered successfully.
206 * If entry in PreDefinedNames[] specifies an
207 * initial value, create the initial value.
211 Status
= AcpiOsPredefinedOverride (InitVal
, &Val
);
212 if (ACPI_FAILURE (Status
))
214 ACPI_ERROR ((AE_INFO
,
215 "Could not override predefined %s",
225 * Entry requests an initial value, allocate a
228 ObjDesc
= AcpiUtCreateInternalObject (InitVal
->Type
);
231 Status
= AE_NO_MEMORY
;
236 * Convert value string from table entry to
237 * internal representation. Only types actually
238 * used for initial values are implemented here.
240 switch (InitVal
->Type
)
242 case ACPI_TYPE_METHOD
:
243 ObjDesc
->Method
.ParamCount
= (UINT8
) ACPI_TO_INTEGER (Val
);
244 ObjDesc
->Common
.Flags
|= AOPOBJ_DATA_VALID
;
246 #if defined (ACPI_ASL_COMPILER)
248 /* Save the parameter count for the iASL compiler */
250 NewNode
->Value
= ObjDesc
->Method
.ParamCount
;
252 /* Mark this as a very SPECIAL method */
254 ObjDesc
->Method
.MethodFlags
= AML_METHOD_INTERNAL_ONLY
;
256 #ifndef ACPI_DUMP_APP
257 ObjDesc
->Method
.Implementation
= AcpiUtOsiImplementation
;
262 case ACPI_TYPE_INTEGER
:
264 ObjDesc
->Integer
.Value
= ACPI_TO_INTEGER (Val
);
268 case ACPI_TYPE_STRING
:
271 * Build an object around the static string
273 ObjDesc
->String
.Length
= (UINT32
) ACPI_STRLEN (Val
);
274 ObjDesc
->String
.Pointer
= Val
;
275 ObjDesc
->Common
.Flags
|= AOPOBJ_STATIC_POINTER
;
279 case ACPI_TYPE_MUTEX
:
281 ObjDesc
->Mutex
.Node
= NewNode
;
282 ObjDesc
->Mutex
.SyncLevel
= (UINT8
) (ACPI_TO_INTEGER (Val
) - 1);
286 Status
= AcpiOsCreateMutex (&ObjDesc
->Mutex
.OsMutex
);
287 if (ACPI_FAILURE (Status
))
289 AcpiUtRemoveReference (ObjDesc
);
293 /* Special case for ACPI Global Lock */
295 if (ACPI_STRCMP (InitVal
->Name
, "_GL_") == 0)
297 AcpiGbl_GlobalLockMutex
= ObjDesc
->Mutex
.OsMutex
;
299 /* Create additional counting semaphore for global lock */
301 Status
= AcpiOsCreateSemaphore (
302 1, 0, &AcpiGbl_GlobalLockSemaphore
);
303 if (ACPI_FAILURE (Status
))
305 AcpiUtRemoveReference (ObjDesc
);
314 ACPI_ERROR ((AE_INFO
, "Unsupported initial type value %X",
316 AcpiUtRemoveReference (ObjDesc
);
321 /* Store pointer to value descriptor in the Node */
323 Status
= AcpiNsAttachObject (NewNode
, ObjDesc
,
324 ACPI_GET_OBJECT_TYPE (ObjDesc
));
326 /* Remove local reference to the object */
328 AcpiUtRemoveReference (ObjDesc
);
334 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE
);
336 /* Save a handle to "_GPE", it is always present */
338 if (ACPI_SUCCESS (Status
))
340 Status
= AcpiNsGetNode (NULL
, "\\_GPE", ACPI_NS_NO_UPSEARCH
,
341 &AcpiGbl_FadtGpeDevice
);
344 return_ACPI_STATUS (Status
);
348 /*******************************************************************************
350 * FUNCTION: AcpiNsLookup
352 * PARAMETERS: ScopeInfo - Current scope info block
353 * Pathname - Search pathname, in internal format
354 * (as represented in the AML stream)
355 * Type - Type associated with name
356 * InterpreterMode - IMODE_LOAD_PASS2 => add name if not found
357 * Flags - Flags describing the search restrictions
358 * WalkState - Current state of the walk
359 * ReturnNode - Where the Node is placed (if found
360 * or created successfully)
364 * DESCRIPTION: Find or enter the passed name in the name space.
365 * Log an error if name not found in Exec mode.
367 * MUTEX: Assumes namespace is locked.
369 ******************************************************************************/
373 ACPI_GENERIC_STATE
*ScopeInfo
,
375 ACPI_OBJECT_TYPE Type
,
376 ACPI_INTERPRETER_MODE InterpreterMode
,
378 ACPI_WALK_STATE
*WalkState
,
379 ACPI_NAMESPACE_NODE
**ReturnNode
)
382 char *Path
= Pathname
;
383 ACPI_NAMESPACE_NODE
*PrefixNode
;
384 ACPI_NAMESPACE_NODE
*CurrentNode
= NULL
;
385 ACPI_NAMESPACE_NODE
*ThisNode
= NULL
;
388 ACPI_NAME SimpleName
;
389 ACPI_OBJECT_TYPE TypeToCheckFor
;
390 ACPI_OBJECT_TYPE ThisSearchType
;
391 UINT32 SearchParentFlag
= ACPI_NS_SEARCH_PARENT
;
395 ACPI_FUNCTION_TRACE (NsLookup
);
400 return_ACPI_STATUS (AE_BAD_PARAMETER
);
403 LocalFlags
= Flags
& ~(ACPI_NS_ERROR_IF_FOUND
| ACPI_NS_SEARCH_PARENT
);
404 *ReturnNode
= ACPI_ENTRY_NOT_FOUND
;
405 AcpiGbl_NsLookupCount
++;
407 if (!AcpiGbl_RootNode
)
409 return_ACPI_STATUS (AE_NO_NAMESPACE
);
413 * Get the prefix scope.
414 * A null scope means use the root scope
417 (!ScopeInfo
->Scope
.Node
))
419 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
420 "Null scope prefix, using root node (%p)\n",
423 PrefixNode
= AcpiGbl_RootNode
;
427 PrefixNode
= ScopeInfo
->Scope
.Node
;
428 if (ACPI_GET_DESCRIPTOR_TYPE (PrefixNode
) != ACPI_DESC_TYPE_NAMED
)
430 ACPI_ERROR ((AE_INFO
, "%p is not a namespace node [%s]",
431 PrefixNode
, AcpiUtGetDescriptorName (PrefixNode
)));
432 return_ACPI_STATUS (AE_AML_INTERNAL
);
435 if (!(Flags
& ACPI_NS_PREFIX_IS_SCOPE
))
438 * This node might not be a actual "scope" node (such as a
439 * Device/Method, etc.) It could be a Package or other object node.
440 * Backup up the tree to find the containing scope node.
442 while (!AcpiNsOpensScope (PrefixNode
->Type
) &&
443 PrefixNode
->Type
!= ACPI_TYPE_ANY
)
445 PrefixNode
= AcpiNsGetParentNode (PrefixNode
);
450 /* Save type TBD: may be no longer necessary */
452 TypeToCheckFor
= Type
;
455 * Begin examination of the actual pathname
459 /* A Null NamePath is allowed and refers to the root */
462 ThisNode
= AcpiGbl_RootNode
;
465 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
466 "Null Pathname (Zero segments), Flags=%X\n", Flags
));
471 * Name pointer is valid (and must be in internal name format)
473 * Check for scope prefixes:
475 * As represented in the AML stream, a namepath consists of an
476 * optional scope prefix followed by a name segment part.
478 * If present, the scope prefix is either a Root Prefix (in
479 * which case the name is fully qualified), or one or more
480 * Parent Prefixes (in which case the name's scope is relative
481 * to the current scope).
483 if (*Path
== (UINT8
) AML_ROOT_PREFIX
)
485 /* Pathname is fully qualified, start from the root */
487 ThisNode
= AcpiGbl_RootNode
;
488 SearchParentFlag
= ACPI_NS_NO_UPSEARCH
;
490 /* Point to name segment part */
494 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
495 "Path is absolute from root [%p]\n", ThisNode
));
499 /* Pathname is relative to current scope, start there */
501 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
502 "Searching relative to prefix scope [%4.4s] (%p)\n",
503 AcpiUtGetNodeName (PrefixNode
), PrefixNode
));
506 * Handle multiple Parent Prefixes (carat) by just getting
507 * the parent node for each prefix instance.
509 ThisNode
= PrefixNode
;
511 while (*Path
== (UINT8
) AML_PARENT_PREFIX
)
513 /* Name is fully qualified, no search rules apply */
515 SearchParentFlag
= ACPI_NS_NO_UPSEARCH
;
517 * Point past this prefix to the name segment
518 * part or the next Parent Prefix
522 /* Backup to the parent node */
525 ThisNode
= AcpiNsGetParentNode (ThisNode
);
528 /* Current scope has no parent scope */
530 ACPI_ERROR ((AE_INFO
,
531 "ACPI path has too many parent prefixes (^) - reached beyond root node"));
532 return_ACPI_STATUS (AE_NOT_FOUND
);
536 if (SearchParentFlag
== ACPI_NS_NO_UPSEARCH
)
538 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
539 "Search scope is [%4.4s], path has %d carat(s)\n",
540 AcpiUtGetNodeName (ThisNode
), NumCarats
));
545 * Determine the number of ACPI name segments in this pathname.
547 * The segment part consists of either:
548 * - A Null name segment (0)
549 * - A DualNamePrefix followed by two 4-byte name segments
550 * - A MultiNamePrefix followed by a byte indicating the
551 * number of segments and the segments themselves.
552 * - A single 4-byte name segment
554 * Examine the name prefix opcode, if any, to determine the number of
561 * Null name after a root or parent prefixes. We already
562 * have the correct target node and there are no name segments.
565 Type
= ThisNode
->Type
;
567 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
568 "Prefix-only Pathname (Zero name segments), Flags=%X\n",
572 case AML_DUAL_NAME_PREFIX
:
574 /* More than one NameSeg, search rules do not apply */
576 SearchParentFlag
= ACPI_NS_NO_UPSEARCH
;
578 /* Two segments, point to first name segment */
583 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
584 "Dual Pathname (2 segments, Flags=%X)\n", Flags
));
587 case AML_MULTI_NAME_PREFIX_OP
:
589 /* More than one NameSeg, search rules do not apply */
591 SearchParentFlag
= ACPI_NS_NO_UPSEARCH
;
593 /* Extract segment count, point to first name segment */
596 NumSegments
= (UINT32
) (UINT8
) *Path
;
599 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
600 "Multi Pathname (%d Segments, Flags=%X)\n",
601 NumSegments
, Flags
));
606 * Not a Null name, no Dual or Multi prefix, hence there is
607 * only one name segment and Pathname is already pointing to it.
611 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
612 "Simple Pathname (1 segment, Flags=%X)\n", Flags
));
616 ACPI_DEBUG_EXEC (AcpiNsPrintPathname (NumSegments
, Path
));
621 * Search namespace for each segment of the name. Loop through and
622 * verify (or add to the namespace) each name segment.
624 * The object type is significant only at the last name
625 * segment. (We don't care about the types along the path, only
626 * the type of the final target object.)
628 ThisSearchType
= ACPI_TYPE_ANY
;
629 CurrentNode
= ThisNode
;
630 while (NumSegments
&& CurrentNode
)
636 * This is the last segment, enable typechecking
638 ThisSearchType
= Type
;
641 * Only allow automatic parent search (search rules) if the caller
642 * requested it AND we have a single, non-fully-qualified NameSeg
644 if ((SearchParentFlag
!= ACPI_NS_NO_UPSEARCH
) &&
645 (Flags
& ACPI_NS_SEARCH_PARENT
))
647 LocalFlags
|= ACPI_NS_SEARCH_PARENT
;
650 /* Set error flag according to caller */
652 if (Flags
& ACPI_NS_ERROR_IF_FOUND
)
654 LocalFlags
|= ACPI_NS_ERROR_IF_FOUND
;
658 /* Extract one ACPI name from the front of the pathname */
660 ACPI_MOVE_32_TO_32 (&SimpleName
, Path
);
662 /* Try to find the single (4 character) ACPI name */
664 Status
= AcpiNsSearchAndEnter (SimpleName
, WalkState
, CurrentNode
,
665 InterpreterMode
, ThisSearchType
, LocalFlags
, &ThisNode
);
666 if (ACPI_FAILURE (Status
))
668 if (Status
== AE_NOT_FOUND
)
670 /* Name not found in ACPI namespace */
672 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
673 "Name [%4.4s] not found in scope [%4.4s] %p\n",
674 (char *) &SimpleName
, (char *) &CurrentNode
->Name
,
678 *ReturnNode
= ThisNode
;
679 return_ACPI_STATUS (Status
);
683 * Sanity typecheck of the target object:
685 * If 1) This is the last segment (NumSegments == 0)
686 * 2) And we are looking for a specific type
687 * (Not checking for TYPE_ANY)
688 * 3) Which is not an alias
689 * 4) Which is not a local type (TYPE_SCOPE)
690 * 5) And the type of target object is known (not TYPE_ANY)
691 * 6) And target object does not match what we are looking for
693 * Then we have a type mismatch. Just warn and ignore it.
695 if ((NumSegments
== 0) &&
696 (TypeToCheckFor
!= ACPI_TYPE_ANY
) &&
697 (TypeToCheckFor
!= ACPI_TYPE_LOCAL_ALIAS
) &&
698 (TypeToCheckFor
!= ACPI_TYPE_LOCAL_METHOD_ALIAS
) &&
699 (TypeToCheckFor
!= ACPI_TYPE_LOCAL_SCOPE
) &&
700 (ThisNode
->Type
!= ACPI_TYPE_ANY
) &&
701 (ThisNode
->Type
!= TypeToCheckFor
))
703 /* Complain about a type mismatch */
705 ACPI_WARNING ((AE_INFO
,
706 "NsLookup: Type mismatch on %4.4s (%s), searching for (%s)",
707 ACPI_CAST_PTR (char, &SimpleName
),
708 AcpiUtGetTypeName (ThisNode
->Type
),
709 AcpiUtGetTypeName (TypeToCheckFor
)));
713 * If this is the last name segment and we are not looking for a
714 * specific type, but the type of found object is known, use that type
715 * to see if it opens a scope.
717 if ((NumSegments
== 0) && (Type
== ACPI_TYPE_ANY
))
719 Type
= ThisNode
->Type
;
722 /* Point to next name segment and make this node current */
724 Path
+= ACPI_NAME_SIZE
;
725 CurrentNode
= ThisNode
;
729 * Always check if we need to open a new scope
731 if (!(Flags
& ACPI_NS_DONT_OPEN_SCOPE
) && (WalkState
))
734 * If entry is a type which opens a scope, push the new scope on the
737 if (AcpiNsOpensScope (Type
))
739 Status
= AcpiDsScopeStackPush (ThisNode
, Type
, WalkState
);
740 if (ACPI_FAILURE (Status
))
742 return_ACPI_STATUS (Status
);
747 *ReturnNode
= ThisNode
;
748 return_ACPI_STATUS (AE_OK
);