1 /*******************************************************************************
3 * Module Name: nsaccess - Top-level functions for accessing ACPI namespace
6 ******************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2005, 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 (void)
147 const ACPI_PREDEFINED_NAMES
*InitVal
= NULL
;
148 ACPI_NAMESPACE_NODE
*NewNode
;
149 ACPI_OPERAND_OBJECT
*ObjDesc
;
150 ACPI_STRING Val
= NULL
;
153 ACPI_FUNCTION_TRACE ("NsRootInitialize");
156 Status
= AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE
);
157 if (ACPI_FAILURE (Status
))
159 return_ACPI_STATUS (Status
);
163 * The global root ptr is initially NULL, so a non-NULL value indicates
164 * that AcpiNsRootInitialize() has already been called; just return.
166 if (AcpiGbl_RootNode
)
173 * Tell the rest of the subsystem that the root is initialized
174 * (This is OK because the namespace is locked)
176 AcpiGbl_RootNode
= &AcpiGbl_RootNodeStruct
;
178 /* Enter the pre-defined names in the name table */
180 ACPI_DEBUG_PRINT ((ACPI_DB_INFO
,
181 "Entering predefined entries into namespace\n"));
183 for (InitVal
= AcpiGbl_PreDefinedNames
; InitVal
->Name
; InitVal
++)
185 /* _OSI is optional for now, will be permanent later */
187 if (!ACPI_STRCMP (InitVal
->Name
, "_OSI") && !AcpiGbl_CreateOsiMethod
)
192 Status
= AcpiNsLookup (NULL
, InitVal
->Name
, InitVal
->Type
,
193 ACPI_IMODE_LOAD_PASS2
, ACPI_NS_NO_UPSEARCH
,
196 if (ACPI_FAILURE (Status
) || (!NewNode
)) /* Must be on same line for code converter */
198 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
,
199 "Could not create predefined name %s, %s\n",
200 InitVal
->Name
, AcpiFormatException (Status
)));
204 * Name entered successfully.
205 * If entry in PreDefinedNames[] specifies an
206 * initial value, create the initial value.
210 Status
= AcpiOsPredefinedOverride (InitVal
, &Val
);
211 if (ACPI_FAILURE (Status
))
213 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR
,
214 "Could not override predefined %s\n",
224 * Entry requests an initial value, allocate a
227 ObjDesc
= AcpiUtCreateInternalObject (InitVal
->Type
);
230 Status
= AE_NO_MEMORY
;
235 * Convert value string from table entry to
236 * internal representation. Only types actually
237 * used for initial values are implemented here.
239 switch (InitVal
->Type
)
241 case ACPI_TYPE_METHOD
:
242 ObjDesc
->Method
.ParamCount
= (UINT8
) ACPI_TO_INTEGER (Val
);
243 ObjDesc
->Common
.Flags
|= AOPOBJ_DATA_VALID
;
245 #if defined (_ACPI_ASL_COMPILER) || defined (_ACPI_DUMP_APP)
248 * iASL Compiler cheats by putting parameter count
251 NewNode
->OwnerId
= ObjDesc
->Method
.ParamCount
;
253 /* Mark this as a very SPECIAL method */
255 ObjDesc
->Method
.MethodFlags
= AML_METHOD_INTERNAL_ONLY
;
256 ObjDesc
->Method
.Implementation
= AcpiUtOsiImplementation
;
260 case ACPI_TYPE_INTEGER
:
262 ObjDesc
->Integer
.Value
= ACPI_TO_INTEGER (Val
);
266 case ACPI_TYPE_STRING
:
269 * Build an object around the static string
271 ObjDesc
->String
.Length
= (UINT32
) ACPI_STRLEN (Val
);
272 ObjDesc
->String
.Pointer
= Val
;
273 ObjDesc
->Common
.Flags
|= AOPOBJ_STATIC_POINTER
;
277 case ACPI_TYPE_MUTEX
:
279 ObjDesc
->Mutex
.Node
= NewNode
;
280 ObjDesc
->Mutex
.SyncLevel
= (UINT8
) (ACPI_TO_INTEGER (Val
) - 1);
282 if (ACPI_STRCMP (InitVal
->Name
, "_GL_") == 0)
285 * Create a counting semaphore for the
288 Status
= AcpiOsCreateSemaphore (ACPI_NO_UNIT_LIMIT
,
289 1, &ObjDesc
->Mutex
.Semaphore
);
290 if (ACPI_FAILURE (Status
))
292 AcpiUtRemoveReference (ObjDesc
);
297 * We just created the mutex for the
298 * global lock, save it
300 AcpiGbl_GlobalLockSemaphore
= ObjDesc
->Mutex
.Semaphore
;
306 Status
= AcpiOsCreateSemaphore (1, 1,
307 &ObjDesc
->Mutex
.Semaphore
);
308 if (ACPI_FAILURE (Status
))
310 AcpiUtRemoveReference (ObjDesc
);
319 ACPI_REPORT_ERROR (("Unsupported initial type value %X\n",
321 AcpiUtRemoveReference (ObjDesc
);
326 /* Store pointer to value descriptor in the Node */
328 Status
= AcpiNsAttachObject (NewNode
, ObjDesc
,
329 ACPI_GET_OBJECT_TYPE (ObjDesc
));
331 /* Remove local reference to the object */
333 AcpiUtRemoveReference (ObjDesc
);
339 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE
);
341 /* Save a handle to "_GPE", it is always present */
343 if (ACPI_SUCCESS (Status
))
345 Status
= AcpiNsGetNodeByPath ("\\_GPE", NULL
, ACPI_NS_NO_UPSEARCH
,
346 &AcpiGbl_FadtGpeDevice
);
349 return_ACPI_STATUS (Status
);
353 /*******************************************************************************
355 * FUNCTION: AcpiNsLookup
357 * PARAMETERS: PrefixNode - Search scope if name is not fully qualified
358 * Pathname - Search pathname, in internal format
359 * (as represented in the AML stream)
360 * Type - Type associated with name
361 * InterpreterMode - IMODE_LOAD_PASS2 => add name if not found
362 * Flags - Flags describing the search restrictions
363 * WalkState - Current state of the walk
364 * ReturnNode - Where the Node is placed (if found
365 * or created successfully)
369 * DESCRIPTION: Find or enter the passed name in the name space.
370 * Log an error if name not found in Exec mode.
372 * MUTEX: Assumes namespace is locked.
374 ******************************************************************************/
378 ACPI_GENERIC_STATE
*ScopeInfo
,
380 ACPI_OBJECT_TYPE Type
,
381 ACPI_INTERPRETER_MODE InterpreterMode
,
383 ACPI_WALK_STATE
*WalkState
,
384 ACPI_NAMESPACE_NODE
**ReturnNode
)
387 char *Path
= Pathname
;
388 ACPI_NAMESPACE_NODE
*PrefixNode
;
389 ACPI_NAMESPACE_NODE
*CurrentNode
= NULL
;
390 ACPI_NAMESPACE_NODE
*ThisNode
= NULL
;
393 ACPI_NAME SimpleName
;
394 ACPI_OBJECT_TYPE TypeToCheckFor
;
395 ACPI_OBJECT_TYPE ThisSearchType
;
396 UINT32 SearchParentFlag
= ACPI_NS_SEARCH_PARENT
;
397 UINT32 LocalFlags
= Flags
& ~(ACPI_NS_ERROR_IF_FOUND
|
398 ACPI_NS_SEARCH_PARENT
);
401 ACPI_FUNCTION_TRACE ("NsLookup");
406 return_ACPI_STATUS (AE_BAD_PARAMETER
);
409 AcpiGbl_NsLookupCount
++;
410 *ReturnNode
= ACPI_ENTRY_NOT_FOUND
;
412 if (!AcpiGbl_RootNode
)
414 return_ACPI_STATUS (AE_NO_NAMESPACE
);
418 * Get the prefix scope.
419 * A null scope means use the root scope
422 (!ScopeInfo
->Scope
.Node
))
424 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
425 "Null scope prefix, using root node (%p)\n",
428 PrefixNode
= AcpiGbl_RootNode
;
432 PrefixNode
= ScopeInfo
->Scope
.Node
;
433 if (ACPI_GET_DESCRIPTOR_TYPE (PrefixNode
) != ACPI_DESC_TYPE_NAMED
)
435 ACPI_REPORT_ERROR (("NsLookup: %p is not a namespace node [%s]\n",
436 PrefixNode
, AcpiUtGetDescriptorName (PrefixNode
)));
437 return_ACPI_STATUS (AE_AML_INTERNAL
);
441 * This node might not be a actual "scope" node (such as a
442 * Device/Method, etc.) It could be a Package or other object node.
443 * Backup up the tree to find the containing scope node.
445 while (!AcpiNsOpensScope (PrefixNode
->Type
) &&
446 PrefixNode
->Type
!= ACPI_TYPE_ANY
)
448 PrefixNode
= AcpiNsGetParentNode (PrefixNode
);
452 /* Save type TBD: may be no longer necessary */
454 TypeToCheckFor
= Type
;
457 * Begin examination of the actual pathname
461 /* A Null NamePath is allowed and refers to the root */
464 ThisNode
= AcpiGbl_RootNode
;
467 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
468 "Null Pathname (Zero segments), Flags=%X\n", Flags
));
473 * Name pointer is valid (and must be in internal name format)
475 * Check for scope prefixes:
477 * As represented in the AML stream, a namepath consists of an
478 * optional scope prefix followed by a name segment part.
480 * If present, the scope prefix is either a Root Prefix (in
481 * which case the name is fully qualified), or one or more
482 * Parent Prefixes (in which case the name's scope is relative
483 * to the current scope).
485 if (*Path
== (UINT8
) AML_ROOT_PREFIX
)
487 /* Pathname is fully qualified, start from the root */
489 ThisNode
= AcpiGbl_RootNode
;
490 SearchParentFlag
= ACPI_NS_NO_UPSEARCH
;
492 /* Point to name segment part */
496 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
497 "Path is absolute from root [%p]\n", ThisNode
));
501 /* Pathname is relative to current scope, start there */
503 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
504 "Searching relative to prefix scope [%4.4s] (%p)\n",
505 AcpiUtGetNodeName (PrefixNode
), PrefixNode
));
508 * Handle multiple Parent Prefixes (carat) by just getting
509 * the parent node for each prefix instance.
511 ThisNode
= PrefixNode
;
513 while (*Path
== (UINT8
) AML_PARENT_PREFIX
)
515 /* Name is fully qualified, no search rules apply */
517 SearchParentFlag
= ACPI_NS_NO_UPSEARCH
;
519 * Point past this prefix to the name segment
520 * part or the next Parent Prefix
524 /* Backup to the parent node */
527 ThisNode
= AcpiNsGetParentNode (ThisNode
);
530 /* Current scope has no parent scope */
533 ("ACPI path has too many parent prefixes (^) - reached beyond root node\n"));
534 return_ACPI_STATUS (AE_NOT_FOUND
);
538 if (SearchParentFlag
== ACPI_NS_NO_UPSEARCH
)
540 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
541 "Search scope is [%4.4s], path has %d carat(s)\n",
542 AcpiUtGetNodeName (ThisNode
), NumCarats
));
547 * Determine the number of ACPI name segments in this pathname.
549 * The segment part consists of either:
550 * - A Null name segment (0)
551 * - A DualNamePrefix followed by two 4-byte name segments
552 * - A MultiNamePrefix followed by a byte indicating the
553 * number of segments and the segments themselves.
554 * - A single 4-byte name segment
556 * Examine the name prefix opcode, if any, to determine the number of
563 * Null name after a root or parent prefixes. We already
564 * have the correct target node and there are no name segments.
567 Type
= ThisNode
->Type
;
569 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
570 "Prefix-only Pathname (Zero name segments), Flags=%X\n",
574 case AML_DUAL_NAME_PREFIX
:
576 /* More than one NameSeg, search rules do not apply */
578 SearchParentFlag
= ACPI_NS_NO_UPSEARCH
;
580 /* Two segments, point to first name segment */
585 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
586 "Dual Pathname (2 segments, Flags=%X)\n", Flags
));
589 case AML_MULTI_NAME_PREFIX_OP
:
591 /* More than one NameSeg, search rules do not apply */
593 SearchParentFlag
= ACPI_NS_NO_UPSEARCH
;
595 /* Extract segment count, point to first name segment */
598 NumSegments
= (UINT32
) (UINT8
) *Path
;
601 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
602 "Multi Pathname (%d Segments, Flags=%X) \n",
603 NumSegments
, Flags
));
608 * Not a Null name, no Dual or Multi prefix, hence there is
609 * only one name segment and Pathname is already pointing to it.
613 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
614 "Simple Pathname (1 segment, Flags=%X)\n", Flags
));
618 ACPI_DEBUG_EXEC (AcpiNsPrintPathname (NumSegments
, Path
));
623 * Search namespace for each segment of the name. Loop through and
624 * verify (or add to the namespace) each name segment.
626 * The object type is significant only at the last name
627 * segment. (We don't care about the types along the path, only
628 * the type of the final target object.)
630 ThisSearchType
= ACPI_TYPE_ANY
;
631 CurrentNode
= ThisNode
;
632 while (NumSegments
&& CurrentNode
)
638 * This is the last segment, enable typechecking
640 ThisSearchType
= Type
;
643 * Only allow automatic parent search (search rules) if the caller
644 * requested it AND we have a single, non-fully-qualified NameSeg
646 if ((SearchParentFlag
!= ACPI_NS_NO_UPSEARCH
) &&
647 (Flags
& ACPI_NS_SEARCH_PARENT
))
649 LocalFlags
|= ACPI_NS_SEARCH_PARENT
;
652 /* Set error flag according to caller */
654 if (Flags
& ACPI_NS_ERROR_IF_FOUND
)
656 LocalFlags
|= ACPI_NS_ERROR_IF_FOUND
;
660 /* Extract one ACPI name from the front of the pathname */
662 ACPI_MOVE_32_TO_32 (&SimpleName
, Path
);
664 /* Try to find the single (4 character) ACPI name */
666 Status
= AcpiNsSearchAndEnter (SimpleName
, WalkState
, CurrentNode
,
667 InterpreterMode
, ThisSearchType
, LocalFlags
, &ThisNode
);
668 if (ACPI_FAILURE (Status
))
670 if (Status
== AE_NOT_FOUND
)
672 /* Name not found in ACPI namespace */
674 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
675 "Name [%4.4s] not found in scope [%4.4s] %p\n",
676 (char *) &SimpleName
, (char *) &CurrentNode
->Name
,
680 *ReturnNode
= ThisNode
;
681 return_ACPI_STATUS (Status
);
685 * Sanity typecheck of the target object:
687 * If 1) This is the last segment (NumSegments == 0)
688 * 2) And we are looking for a specific type
689 * (Not checking for TYPE_ANY)
690 * 3) Which is not an alias
691 * 4) Which is not a local type (TYPE_SCOPE)
692 * 5) And the type of target object is known (not TYPE_ANY)
693 * 6) And target object does not match what we are looking for
695 * Then we have a type mismatch. Just warn and ignore it.
697 if ((NumSegments
== 0) &&
698 (TypeToCheckFor
!= ACPI_TYPE_ANY
) &&
699 (TypeToCheckFor
!= ACPI_TYPE_LOCAL_ALIAS
) &&
700 (TypeToCheckFor
!= ACPI_TYPE_LOCAL_METHOD_ALIAS
) &&
701 (TypeToCheckFor
!= ACPI_TYPE_LOCAL_SCOPE
) &&
702 (ThisNode
->Type
!= ACPI_TYPE_ANY
) &&
703 (ThisNode
->Type
!= TypeToCheckFor
))
705 /* Complain about a type mismatch */
707 ACPI_REPORT_WARNING (
708 ("NsLookup: Type mismatch on %4.4s (%s), searching for (%s)\n",
709 (char *) &SimpleName
, AcpiUtGetTypeName (ThisNode
->Type
),
710 AcpiUtGetTypeName (TypeToCheckFor
)));
714 * If this is the last name segment and we are not looking for a
715 * specific type, but the type of found object is known, use that type
716 * to see if it opens a scope.
718 if ((NumSegments
== 0) && (Type
== ACPI_TYPE_ANY
))
720 Type
= ThisNode
->Type
;
723 /* Point to next name segment and make this node current */
725 Path
+= ACPI_NAME_SIZE
;
726 CurrentNode
= ThisNode
;
730 * Always check if we need to open a new scope
732 if (!(Flags
& ACPI_NS_DONT_OPEN_SCOPE
) && (WalkState
))
735 * If entry is a type which opens a scope, push the new scope on the
738 if (AcpiNsOpensScope (Type
))
740 Status
= AcpiDsScopeStackPush (ThisNode
, Type
, WalkState
);
741 if (ACPI_FAILURE (Status
))
743 return_ACPI_STATUS (Status
);
748 *ReturnNode
= ThisNode
;
749 return_ACPI_STATUS (AE_OK
);