1 /******************************************************************************
3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines
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 #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 */
133 /* Flags for AcpiNsLookup, AcpiNsSearchAndEnter */
135 #define ACPI_NS_NO_UPSEARCH 0
136 #define ACPI_NS_SEARCH_PARENT 0x01
137 #define ACPI_NS_DONT_OPEN_SCOPE 0x02
138 #define ACPI_NS_NO_PEER_SEARCH 0x04
139 #define ACPI_NS_ERROR_IF_FOUND 0x08
141 #define ACPI_NS_WALK_UNLOCK TRUE
142 #define ACPI_NS_WALK_NO_UNLOCK FALSE
146 * nsinit - Namespace initialization
149 AcpiNsInitializeObjects (
153 AcpiNsInitializeDevices (
158 * nsload - Namespace loading
161 AcpiNsLoadNamespace (
166 ACPI_TABLE_DESC *TableDesc,
167 ACPI_NAMESPACE_NODE *Node);
171 * nswalk - walk the namespace
174 AcpiNsWalkNamespace (
175 ACPI_OBJECT_TYPE Type,
176 ACPI_HANDLE StartObject,
178 BOOLEAN UnlockBeforeCallback,
179 ACPI_WALK_CALLBACK UserFunction,
183 ACPI_NAMESPACE_NODE *
185 ACPI_OBJECT_TYPE Type,
186 ACPI_NAMESPACE_NODE *Parent,
187 ACPI_NAMESPACE_NODE *Child);
191 * nsparse - table parsing
195 ACPI_TABLE_DESC *TableDesc,
196 ACPI_NAMESPACE_NODE *Scope);
199 AcpiNsOneCompleteParse (
201 ACPI_TABLE_DESC *TableDesc);
205 * nsaccess - Top-level namespace access
208 AcpiNsRootInitialize (
213 ACPI_GENERIC_STATE *ScopeInfo,
215 ACPI_OBJECT_TYPE Type,
216 ACPI_INTERPRETER_MODE InterpreterMode,
218 ACPI_WALK_STATE *WalkState,
219 ACPI_NAMESPACE_NODE **RetNode);
223 * nsalloc - Named object allocation/deallocation
225 ACPI_NAMESPACE_NODE *
231 ACPI_NAMESPACE_NODE *Node);
234 AcpiNsDeleteNamespaceSubtree (
235 ACPI_NAMESPACE_NODE *ParentHandle);
238 AcpiNsDeleteNamespaceByOwner (
239 ACPI_OWNER_ID OwnerId);
243 ACPI_NAMESPACE_NODE *Node);
246 AcpiNsDeleteChildren (
247 ACPI_NAMESPACE_NODE *Parent);
256 * nsdump - Namespace dump/print utilities
260 ACPI_HANDLE SearchBase,
276 AcpiNsPrintPathname (
281 AcpiNsDumpOneObject (
282 ACPI_HANDLE ObjHandle,
289 ACPI_OBJECT_TYPE Type,
292 ACPI_OWNER_ID OwnerId,
293 ACPI_HANDLE StartHandle);
297 * nseval - Namespace evaluation functions
300 AcpiNsEvaluateByHandle (
301 ACPI_PARAMETER_INFO *Info);
304 AcpiNsEvaluateByName (
306 ACPI_PARAMETER_INFO *Info);
309 AcpiNsEvaluateRelative (
311 ACPI_PARAMETER_INFO *Info);
315 * nsnames - Name and Scope manipulation
319 ACPI_OBJECT_TYPE Type);
322 AcpiNsGetExternalPathname (
323 ACPI_NAMESPACE_NODE *Node);
326 AcpiNsNameOfCurrentScope (
327 ACPI_WALK_STATE *WalkState);
330 AcpiNsHandleToPathname (
331 ACPI_HANDLE TargetHandle,
332 ACPI_BUFFER *Buffer);
336 ACPI_NAMESPACE_NODE *ObjNode,
340 AcpiNsGetNodeByPath (
341 char *ExternalPathname,
342 ACPI_NAMESPACE_NODE *InPrefixNode,
344 ACPI_NAMESPACE_NODE **OutNode);
347 AcpiNsGetPathnameLength (
348 ACPI_NAMESPACE_NODE *Node);
352 * nsobject - Object management for namespace nodes
356 ACPI_NAMESPACE_NODE *Node,
357 ACPI_OPERAND_OBJECT *Object,
358 ACPI_OBJECT_TYPE Type);
360 ACPI_OPERAND_OBJECT *
361 AcpiNsGetAttachedObject (
362 ACPI_NAMESPACE_NODE *Node);
364 ACPI_OPERAND_OBJECT *
365 AcpiNsGetSecondaryObject (
366 ACPI_OPERAND_OBJECT *ObjDesc);
370 ACPI_NAMESPACE_NODE *Node,
371 ACPI_OBJECT_HANDLER Handler,
376 ACPI_NAMESPACE_NODE *Node,
377 ACPI_OBJECT_HANDLER Handler);
380 AcpiNsGetAttachedData (
381 ACPI_NAMESPACE_NODE *Node,
382 ACPI_OBJECT_HANDLER Handler,
387 * nssearch - Namespace searching and entry
390 AcpiNsSearchAndEnter (
392 ACPI_WALK_STATE *WalkState,
393 ACPI_NAMESPACE_NODE *Node,
394 ACPI_INTERPRETER_MODE InterpreterMode,
395 ACPI_OBJECT_TYPE Type,
397 ACPI_NAMESPACE_NODE **RetNode);
402 ACPI_NAMESPACE_NODE *Node,
403 ACPI_OBJECT_TYPE Type,
404 ACPI_NAMESPACE_NODE **RetNode);
408 ACPI_WALK_STATE *WalkState,
409 ACPI_NAMESPACE_NODE *ParentNode,
410 ACPI_NAMESPACE_NODE *Node,
411 ACPI_OBJECT_TYPE Type);
415 * nsutils - Utility functions
418 AcpiNsValidRootPrefix (
423 ACPI_NAMESPACE_NODE *Node);
427 ACPI_OBJECT_TYPE Type);
435 ACPI_STATUS LookupStatus);
438 AcpiNsReportMethodError (
443 ACPI_NAMESPACE_NODE *Node,
445 ACPI_STATUS LookupStatus);
448 AcpiNsPrintNodePathname (
449 ACPI_NAMESPACE_NODE *Node,
453 AcpiNsBuildInternalName (
454 ACPI_NAMESTRING_INFO *Info);
457 AcpiNsGetInternalNameLength (
458 ACPI_NAMESTRING_INFO *Info);
461 AcpiNsInternalizeName (
463 char **ConvertedName);
466 AcpiNsExternalizeName (
467 UINT32 InternalNameLength,
469 UINT32 *ConvertedNameLength,
470 char **ConvertedName);
472 ACPI_NAMESPACE_NODE *
473 AcpiNsMapHandleToNode (
477 AcpiNsConvertEntryToHandle(
478 ACPI_NAMESPACE_NODE *Node);
484 ACPI_NAMESPACE_NODE *
485 AcpiNsGetParentNode (
486 ACPI_NAMESPACE_NODE *Node);
489 ACPI_NAMESPACE_NODE *
490 AcpiNsGetNextValidNode (
491 ACPI_NAMESPACE_NODE *Node);
493 #endif /* __ACNAMESP_H__ */