1 /******************************************************************************
3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2002, 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 #ifndef __ACNAMESP_H__
118 #define __ACNAMESP_H__
121 /* To search the entire name space, pass this as SearchBase */
123 #define ACPI_NS_ALL ((ACPI_HANDLE)0)
126 * Elements of AcpiNsProperties are bit significant
127 * and should be one-to-one with values of ACPI_OBJECT_TYPE
129 #define ACPI_NS_NORMAL 0
130 #define ACPI_NS_NEWSCOPE 1 /* a definition of this type opens a name scope */
131 #define ACPI_NS_LOCAL 2 /* suppress search of enclosing scopes */
134 /* Definitions of the predefined namespace names */
136 #define ACPI_UNKNOWN_NAME (UINT32) 0x3F3F3F3F /* Unknown name is "????" */
137 #define ACPI_ROOT_NAME (UINT32) 0x5F5F5F5C /* Root name is "\___" */
138 #define ACPI_SYS_BUS_NAME (UINT32) 0x5F53425F /* Sys bus name is "_SB_" */
140 #define ACPI_NS_ROOT_PATH "\\"
141 #define ACPI_NS_SYSTEM_BUS "_SB_"
144 /* Flags for AcpiNsLookup, AcpiNsSearchAndEnter */
146 #define ACPI_NS_NO_UPSEARCH 0
147 #define ACPI_NS_SEARCH_PARENT 0x01
148 #define ACPI_NS_DONT_OPEN_SCOPE 0x02
149 #define ACPI_NS_NO_PEER_SEARCH 0x04
150 #define ACPI_NS_ERROR_IF_FOUND 0x08
152 #define ACPI_NS_WALK_UNLOCK TRUE
153 #define ACPI_NS_WALK_NO_UNLOCK FALSE
157 AcpiNsLoadNamespace (
161 AcpiNsInitializeObjects (
165 AcpiNsInitializeDevices (
169 /* Namespace init - nsxfinit */
172 AcpiNsInitOneDevice (
173 ACPI_HANDLE ObjHandle,
179 AcpiNsInitOneObject (
180 ACPI_HANDLE ObjHandle,
187 AcpiNsWalkNamespace (
188 ACPI_OBJECT_TYPE Type,
189 ACPI_HANDLE StartObject,
191 BOOLEAN UnlockBeforeCallback,
192 ACPI_WALK_CALLBACK UserFunction,
196 ACPI_NAMESPACE_NODE *
198 ACPI_OBJECT_TYPE Type,
199 ACPI_NAMESPACE_NODE *Parent,
200 ACPI_NAMESPACE_NODE *Child);
203 AcpiNsDeleteNamespaceByOwner (
207 /* Namespace loading - nsload */
210 AcpiNsOneCompleteParse (
212 ACPI_TABLE_DESC *TableDesc);
216 ACPI_TABLE_DESC *TableDesc,
217 ACPI_NAMESPACE_NODE *Scope);
221 ACPI_TABLE_DESC *TableDesc,
222 ACPI_NAMESPACE_NODE *Node);
225 AcpiNsLoadTableByType (
226 ACPI_TABLE_TYPE TableType);
230 * Top-level namespace access - nsaccess
234 AcpiNsRootInitialize (
239 ACPI_GENERIC_STATE *ScopeInfo,
241 ACPI_OBJECT_TYPE Type,
242 ACPI_INTERPRETER_MODE InterpreterMode,
244 ACPI_WALK_STATE *WalkState,
245 ACPI_NAMESPACE_NODE **RetNode);
249 * Named object allocation/deallocation - nsalloc
252 ACPI_NAMESPACE_NODE *
258 ACPI_NAMESPACE_NODE *Node);
261 AcpiNsDeleteNamespaceSubtree (
262 ACPI_NAMESPACE_NODE *ParentHandle);
266 ACPI_NAMESPACE_NODE *Node);
269 AcpiNsDeleteChildren (
270 ACPI_NAMESPACE_NODE *Parent);
274 * Namespace modification - nsmodify
278 AcpiNsUnloadNamespace (
282 AcpiNsDeleteSubtree (
283 ACPI_HANDLE StartHandle);
287 * Namespace dump/print utilities - nsdump
292 ACPI_HANDLE SearchBase,
308 AcpiNsPrintPathname (
313 AcpiNsDumpOneDevice (
314 ACPI_HANDLE ObjHandle,
320 AcpiNsDumpRootDevices (
324 AcpiNsDumpOneObject (
325 ACPI_HANDLE ObjHandle,
332 ACPI_OBJECT_TYPE Type,
336 ACPI_HANDLE StartHandle);
340 * Namespace evaluation functions - nseval
344 AcpiNsEvaluateByHandle (
345 ACPI_NAMESPACE_NODE *PrefixNode,
346 ACPI_OPERAND_OBJECT **Params,
347 ACPI_OPERAND_OBJECT **ReturnObject);
350 AcpiNsEvaluateByName (
351 NATIVE_CHAR *Pathname,
352 ACPI_OPERAND_OBJECT **Params,
353 ACPI_OPERAND_OBJECT **ReturnObject);
356 AcpiNsEvaluateRelative (
357 ACPI_NAMESPACE_NODE *PrefixNode,
358 NATIVE_CHAR *Pathname,
359 ACPI_OPERAND_OBJECT **Params,
360 ACPI_OPERAND_OBJECT **ReturnObject);
363 AcpiNsExecuteControlMethod (
364 ACPI_NAMESPACE_NODE *MethodNode,
365 ACPI_OPERAND_OBJECT **Params,
366 ACPI_OPERAND_OBJECT **ReturnObjDesc);
369 AcpiNsGetObjectValue (
370 ACPI_NAMESPACE_NODE *ObjectNode,
371 ACPI_OPERAND_OBJECT **ReturnObjDesc);
375 * Parent/Child/Peer utility functions - nsfamily
379 AcpiNsFindParentName (
380 ACPI_NAMESPACE_NODE *NodeToSearch);
383 AcpiNsExistDownstreamSibling (
384 ACPI_NAMESPACE_NODE *ThisNode);
388 * Name and Scope manipulation - nsnames
393 ACPI_OBJECT_TYPE Type);
396 AcpiNsBuildExternalPath (
397 ACPI_NAMESPACE_NODE *Node,
399 NATIVE_CHAR *NameBuffer);
402 AcpiNsGetExternalPathname (
403 ACPI_NAMESPACE_NODE *Node);
406 AcpiNsNameOfCurrentScope (
407 ACPI_WALK_STATE *WalkState);
410 AcpiNsHandleToPathname (
411 ACPI_HANDLE TargetHandle,
412 ACPI_BUFFER *Buffer);
416 ACPI_NAMESPACE_NODE *ObjNode,
417 NATIVE_CHAR *SearchFor);
420 AcpiNsGetNodeByPath (
421 NATIVE_CHAR *ExternalPathname,
422 ACPI_NAMESPACE_NODE *InPrefixNode,
424 ACPI_NAMESPACE_NODE **OutNode);
427 AcpiNsGetPathnameLength (
428 ACPI_NAMESPACE_NODE *Node);
432 * Object management for namespace nodes - nsobject
437 ACPI_NAMESPACE_NODE *Node,
438 ACPI_OPERAND_OBJECT *Object,
439 ACPI_OBJECT_TYPE Type);
441 ACPI_OPERAND_OBJECT *
442 AcpiNsGetAttachedObject (
443 ACPI_NAMESPACE_NODE *Node);
445 ACPI_OPERAND_OBJECT *
446 AcpiNsGetSecondaryObject (
447 ACPI_OPERAND_OBJECT *ObjDesc);
451 ACPI_NAMESPACE_NODE *Node,
452 ACPI_OBJECT_HANDLER Handler,
457 ACPI_NAMESPACE_NODE *Node,
458 ACPI_OBJECT_HANDLER Handler);
461 AcpiNsGetAttachedData (
462 ACPI_NAMESPACE_NODE *Node,
463 ACPI_OBJECT_HANDLER Handler,
468 * Namespace searching and entry - nssearch
472 AcpiNsSearchAndEnter (
474 ACPI_WALK_STATE *WalkState,
475 ACPI_NAMESPACE_NODE *Node,
476 ACPI_INTERPRETER_MODE InterpreterMode,
477 ACPI_OBJECT_TYPE Type,
479 ACPI_NAMESPACE_NODE **RetNode);
484 ACPI_NAMESPACE_NODE *Node,
485 ACPI_OBJECT_TYPE Type,
486 ACPI_NAMESPACE_NODE **RetNode);
490 ACPI_WALK_STATE *WalkState,
491 ACPI_NAMESPACE_NODE *ParentNode, /* Parent */
492 ACPI_NAMESPACE_NODE *Node, /* New Child*/
493 ACPI_OBJECT_TYPE Type);
497 * Utility functions - nsutils
501 AcpiNsValidRootPrefix (
505 AcpiNsValidPathSeparator (
510 ACPI_NAMESPACE_NODE *Node);
514 ACPI_OBJECT_TYPE Type);
517 AcpiNsBuildInternalName (
518 ACPI_NAMESTRING_INFO *Info);
521 AcpiNsGetInternalNameLength (
522 ACPI_NAMESTRING_INFO *Info);
525 AcpiNsInternalizeName (
526 NATIVE_CHAR *DottedName,
527 NATIVE_CHAR **ConvertedName);
530 AcpiNsExternalizeName (
531 UINT32 InternalNameLength,
532 NATIVE_CHAR *InternalName,
533 UINT32 *ConvertedNameLength,
534 NATIVE_CHAR **ConvertedName);
536 ACPI_NAMESPACE_NODE *
537 AcpiNsMapHandleToNode (
541 AcpiNsConvertEntryToHandle(
542 ACPI_NAMESPACE_NODE *Node);
548 ACPI_NAMESPACE_NODE *
549 AcpiNsGetParentNode (
550 ACPI_NAMESPACE_NODE *Node);
553 ACPI_NAMESPACE_NODE *
554 AcpiNsGetNextValidNode (
555 ACPI_NAMESPACE_NODE *Node);
558 #endif /* __ACNAMESP_H__ */