1 /******************************************************************************
3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2003, 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 *****************************************************************************/
116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/acnamesp.h,v 1.1 2003/09/24 03:32:15 drhodus Exp $ */
118 #ifndef __ACNAMESP_H__
119 #define __ACNAMESP_H__
122 /* To search the entire name space, pass this as SearchBase */
124 #define ACPI_NS_ALL ((ACPI_HANDLE)0)
127 * Elements of AcpiNsProperties are bit significant
128 * and should be one-to-one with values of ACPI_OBJECT_TYPE
130 #define ACPI_NS_NORMAL 0
131 #define ACPI_NS_NEWSCOPE 1 /* a definition of this type opens a name scope */
132 #define ACPI_NS_LOCAL 2 /* suppress search of enclosing scopes */
135 /* Definitions of the predefined namespace names */
137 #define ACPI_UNKNOWN_NAME (UINT32) 0x3F3F3F3F /* Unknown name is "????" */
138 #define ACPI_ROOT_NAME (UINT32) 0x5F5F5F5C /* Root name is "\___" */
139 #define ACPI_SYS_BUS_NAME (UINT32) 0x5F53425F /* Sys bus name is "_SB_" */
141 #define ACPI_NS_ROOT_PATH "\\"
142 #define ACPI_NS_SYSTEM_BUS "_SB_"
145 /* Flags for AcpiNsLookup, AcpiNsSearchAndEnter */
147 #define ACPI_NS_NO_UPSEARCH 0
148 #define ACPI_NS_SEARCH_PARENT 0x01
149 #define ACPI_NS_DONT_OPEN_SCOPE 0x02
150 #define ACPI_NS_NO_PEER_SEARCH 0x04
151 #define ACPI_NS_ERROR_IF_FOUND 0x08
153 #define ACPI_NS_WALK_UNLOCK TRUE
154 #define ACPI_NS_WALK_NO_UNLOCK FALSE
158 AcpiNsLoadNamespace (
162 AcpiNsInitializeObjects (
166 AcpiNsInitializeDevices (
170 /* Namespace init - nsxfinit */
173 AcpiNsInitOneDevice (
174 ACPI_HANDLE ObjHandle,
180 AcpiNsInitOneObject (
181 ACPI_HANDLE ObjHandle,
188 AcpiNsWalkNamespace (
189 ACPI_OBJECT_TYPE Type,
190 ACPI_HANDLE StartObject,
192 BOOLEAN UnlockBeforeCallback,
193 ACPI_WALK_CALLBACK UserFunction,
197 ACPI_NAMESPACE_NODE *
199 ACPI_OBJECT_TYPE Type,
200 ACPI_NAMESPACE_NODE *Parent,
201 ACPI_NAMESPACE_NODE *Child);
204 AcpiNsDeleteNamespaceByOwner (
208 /* Namespace loading - nsload */
211 AcpiNsOneCompleteParse (
213 ACPI_TABLE_DESC *TableDesc);
217 ACPI_TABLE_DESC *TableDesc,
218 ACPI_NAMESPACE_NODE *Scope);
222 ACPI_TABLE_DESC *TableDesc,
223 ACPI_NAMESPACE_NODE *Node);
226 AcpiNsLoadTableByType (
227 ACPI_TABLE_TYPE TableType);
231 * Top-level namespace access - nsaccess
235 AcpiNsRootInitialize (
240 ACPI_GENERIC_STATE *ScopeInfo,
242 ACPI_OBJECT_TYPE Type,
243 ACPI_INTERPRETER_MODE InterpreterMode,
245 ACPI_WALK_STATE *WalkState,
246 ACPI_NAMESPACE_NODE **RetNode);
250 * Named object allocation/deallocation - nsalloc
253 ACPI_NAMESPACE_NODE *
259 ACPI_NAMESPACE_NODE *Node);
262 AcpiNsDeleteNamespaceSubtree (
263 ACPI_NAMESPACE_NODE *ParentHandle);
267 ACPI_NAMESPACE_NODE *Node);
270 AcpiNsDeleteChildren (
271 ACPI_NAMESPACE_NODE *Parent);
279 * Namespace modification - nsmodify
283 AcpiNsUnloadNamespace (
287 AcpiNsDeleteSubtree (
288 ACPI_HANDLE StartHandle);
292 * Namespace dump/print utilities - nsdump
297 ACPI_HANDLE SearchBase,
313 AcpiNsPrintPathname (
318 AcpiNsDumpOneDevice (
319 ACPI_HANDLE ObjHandle,
325 AcpiNsDumpRootDevices (
329 AcpiNsDumpOneObject (
330 ACPI_HANDLE ObjHandle,
337 ACPI_OBJECT_TYPE Type,
341 ACPI_HANDLE StartHandle);
345 * Namespace evaluation functions - nseval
349 AcpiNsEvaluateByHandle (
350 ACPI_NAMESPACE_NODE *PrefixNode,
351 ACPI_OPERAND_OBJECT **Params,
352 ACPI_OPERAND_OBJECT **ReturnObject);
355 AcpiNsEvaluateByName (
357 ACPI_OPERAND_OBJECT **Params,
358 ACPI_OPERAND_OBJECT **ReturnObject);
361 AcpiNsEvaluateRelative (
362 ACPI_NAMESPACE_NODE *PrefixNode,
364 ACPI_OPERAND_OBJECT **Params,
365 ACPI_OPERAND_OBJECT **ReturnObject);
368 AcpiNsExecuteControlMethod (
369 ACPI_NAMESPACE_NODE *MethodNode,
370 ACPI_OPERAND_OBJECT **Params,
371 ACPI_OPERAND_OBJECT **ReturnObjDesc);
374 AcpiNsGetObjectValue (
375 ACPI_NAMESPACE_NODE *ObjectNode,
376 ACPI_OPERAND_OBJECT **ReturnObjDesc);
380 * Parent/Child/Peer utility functions
384 AcpiNsFindParentName (
385 ACPI_NAMESPACE_NODE *NodeToSearch);
389 * Name and Scope manipulation - nsnames
394 ACPI_OBJECT_TYPE Type);
397 AcpiNsBuildExternalPath (
398 ACPI_NAMESPACE_NODE *Node,
403 AcpiNsGetExternalPathname (
404 ACPI_NAMESPACE_NODE *Node);
407 AcpiNsNameOfCurrentScope (
408 ACPI_WALK_STATE *WalkState);
411 AcpiNsHandleToPathname (
412 ACPI_HANDLE TargetHandle,
413 ACPI_BUFFER *Buffer);
417 ACPI_NAMESPACE_NODE *ObjNode,
421 AcpiNsGetNodeByPath (
422 char *ExternalPathname,
423 ACPI_NAMESPACE_NODE *InPrefixNode,
425 ACPI_NAMESPACE_NODE **OutNode);
428 AcpiNsGetPathnameLength (
429 ACPI_NAMESPACE_NODE *Node);
433 * Object management for namespace nodes - nsobject
438 ACPI_NAMESPACE_NODE *Node,
439 ACPI_OPERAND_OBJECT *Object,
440 ACPI_OBJECT_TYPE Type);
442 ACPI_OPERAND_OBJECT *
443 AcpiNsGetAttachedObject (
444 ACPI_NAMESPACE_NODE *Node);
446 ACPI_OPERAND_OBJECT *
447 AcpiNsGetSecondaryObject (
448 ACPI_OPERAND_OBJECT *ObjDesc);
452 ACPI_NAMESPACE_NODE *Node,
453 ACPI_OBJECT_HANDLER Handler,
458 ACPI_NAMESPACE_NODE *Node,
459 ACPI_OBJECT_HANDLER Handler);
462 AcpiNsGetAttachedData (
463 ACPI_NAMESPACE_NODE *Node,
464 ACPI_OBJECT_HANDLER Handler,
469 * Namespace searching and entry - nssearch
473 AcpiNsSearchAndEnter (
475 ACPI_WALK_STATE *WalkState,
476 ACPI_NAMESPACE_NODE *Node,
477 ACPI_INTERPRETER_MODE InterpreterMode,
478 ACPI_OBJECT_TYPE Type,
480 ACPI_NAMESPACE_NODE **RetNode);
485 ACPI_NAMESPACE_NODE *Node,
486 ACPI_OBJECT_TYPE Type,
487 ACPI_NAMESPACE_NODE **RetNode);
491 ACPI_WALK_STATE *WalkState,
492 ACPI_NAMESPACE_NODE *ParentNode,
493 ACPI_NAMESPACE_NODE *Node,
494 ACPI_OBJECT_TYPE Type);
498 * Utility functions - nsutils
502 AcpiNsValidRootPrefix (
506 AcpiNsValidPathSeparator (
511 ACPI_NAMESPACE_NODE *Node);
515 ACPI_OBJECT_TYPE Type);
523 ACPI_STATUS LookupStatus);
526 AcpiNsReportMethodError (
531 ACPI_NAMESPACE_NODE *Node,
533 ACPI_STATUS LookupStatus);
536 AcpiNsPrintNodePathname (
537 ACPI_NAMESPACE_NODE *Node,
541 AcpiNsBuildInternalName (
542 ACPI_NAMESTRING_INFO *Info);
545 AcpiNsGetInternalNameLength (
546 ACPI_NAMESTRING_INFO *Info);
549 AcpiNsInternalizeName (
551 char **ConvertedName);
554 AcpiNsExternalizeName (
555 UINT32 InternalNameLength,
557 UINT32 *ConvertedNameLength,
558 char **ConvertedName);
560 ACPI_NAMESPACE_NODE *
561 AcpiNsMapHandleToNode (
565 AcpiNsConvertEntryToHandle(
566 ACPI_NAMESPACE_NODE *Node);
572 ACPI_NAMESPACE_NODE *
573 AcpiNsGetParentNode (
574 ACPI_NAMESPACE_NODE *Node);
577 ACPI_NAMESPACE_NODE *
578 AcpiNsGetNextValidNode (
579 ACPI_NAMESPACE_NODE *Node);
582 #endif /* __ACNAMESP_H__ */