1 /******************************************************************************
3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************/
116 #ifndef __ACNAMESP_H__
117 #define __ACNAMESP_H__
120 /* To search the entire name space, pass this as SearchBase */
122 #define ACPI_NS_ALL ((ACPI_HANDLE)0)
125 * Elements of AcpiNsProperties are bit significant
126 * and should be one-to-one with values of ACPI_OBJECT_TYPE
128 #define ACPI_NS_NORMAL 0
129 #define ACPI_NS_NEWSCOPE 1 /* a definition of this type opens a name scope */
130 #define ACPI_NS_LOCAL 2 /* suppress search of enclosing scopes */
132 /* Flags for AcpiNsLookup, AcpiNsSearchAndEnter */
134 #define ACPI_NS_NO_UPSEARCH 0
135 #define ACPI_NS_SEARCH_PARENT 0x01
136 #define ACPI_NS_DONT_OPEN_SCOPE 0x02
137 #define ACPI_NS_NO_PEER_SEARCH 0x04
138 #define ACPI_NS_ERROR_IF_FOUND 0x08
139 #define ACPI_NS_PREFIX_IS_SCOPE 0x10
140 #define ACPI_NS_EXTERNAL 0x20
141 #define ACPI_NS_TEMPORARY 0x40
143 /* Flags for AcpiNsWalkNamespace */
145 #define ACPI_NS_WALK_NO_UNLOCK 0
146 #define ACPI_NS_WALK_UNLOCK 0x01
147 #define ACPI_NS_WALK_TEMP_NODES 0x02
149 /* Object is not a package element */
151 #define ACPI_NOT_PACKAGE_ELEMENT ACPI_UINT32_MAX
153 /* Always emit warning message, not dependent on node flags */
155 #define ACPI_WARN_ALWAYS 0
159 * nsinit - Namespace initialization
162 AcpiNsInitializeObjects (
166 AcpiNsInitializeDevices (
171 * nsload - Namespace loading
174 AcpiNsLoadNamespace (
180 ACPI_NAMESPACE_NODE *Node);
184 * nswalk - walk the namespace
187 AcpiNsWalkNamespace (
188 ACPI_OBJECT_TYPE Type,
189 ACPI_HANDLE StartObject,
192 ACPI_WALK_CALLBACK PreOrderVisit,
193 ACPI_WALK_CALLBACK PostOrderVisit,
197 ACPI_NAMESPACE_NODE *
199 ACPI_NAMESPACE_NODE *Parent,
200 ACPI_NAMESPACE_NODE *Child);
202 ACPI_NAMESPACE_NODE *
203 AcpiNsGetNextNodeTyped (
204 ACPI_OBJECT_TYPE Type,
205 ACPI_NAMESPACE_NODE *Parent,
206 ACPI_NAMESPACE_NODE *Child);
209 * nsparse - table parsing
214 ACPI_NAMESPACE_NODE *StartNode);
217 AcpiNsOneCompleteParse (
220 ACPI_NAMESPACE_NODE *StartNode);
224 * nsaccess - Top-level namespace access
227 AcpiNsRootInitialize (
232 ACPI_GENERIC_STATE *ScopeInfo,
234 ACPI_OBJECT_TYPE Type,
235 ACPI_INTERPRETER_MODE InterpreterMode,
237 ACPI_WALK_STATE *WalkState,
238 ACPI_NAMESPACE_NODE **RetNode);
242 * nsalloc - Named object allocation/deallocation
244 ACPI_NAMESPACE_NODE *
250 ACPI_NAMESPACE_NODE *Node);
254 ACPI_NAMESPACE_NODE *Node);
257 AcpiNsDeleteNamespaceSubtree (
258 ACPI_NAMESPACE_NODE *ParentHandle);
261 AcpiNsDeleteNamespaceByOwner (
262 ACPI_OWNER_ID OwnerId);
266 ACPI_NAMESPACE_NODE *Node);
269 AcpiNsDeleteChildren (
270 ACPI_NAMESPACE_NODE *Parent);
279 * nsdump - Namespace dump/print utilities
283 ACPI_HANDLE SearchBase,
299 AcpiNsPrintPathname (
304 AcpiNsDumpOneObject (
305 ACPI_HANDLE ObjHandle,
312 ACPI_OBJECT_TYPE Type,
315 ACPI_OWNER_ID OwnerId,
316 ACPI_HANDLE StartHandle);
320 * nseval - Namespace evaluation functions
324 ACPI_EVALUATE_INFO *Info);
327 AcpiNsExecModuleCodeList (
332 * nspredef - Support for predefined/reserved names
335 AcpiNsCheckPredefinedNames (
336 ACPI_NAMESPACE_NODE *Node,
337 UINT32 UserParamCount,
338 ACPI_STATUS ReturnStatus,
339 ACPI_OPERAND_OBJECT **ReturnObject);
341 const ACPI_PREDEFINED_INFO *
342 AcpiNsCheckForPredefinedName (
343 ACPI_NAMESPACE_NODE *Node);
346 AcpiNsCheckParameterCount (
348 ACPI_NAMESPACE_NODE *Node,
349 UINT32 UserParamCount,
350 const ACPI_PREDEFINED_INFO *Info);
354 * nsnames - Name and Scope manipulation
358 ACPI_OBJECT_TYPE Type);
361 AcpiNsBuildExternalPath (
362 ACPI_NAMESPACE_NODE *Node,
367 AcpiNsGetExternalPathname (
368 ACPI_NAMESPACE_NODE *Node);
371 AcpiNsNameOfCurrentScope (
372 ACPI_WALK_STATE *WalkState);
375 AcpiNsHandleToPathname (
376 ACPI_HANDLE TargetHandle,
377 ACPI_BUFFER *Buffer);
381 ACPI_NAMESPACE_NODE *ObjNode,
386 ACPI_NAMESPACE_NODE *PrefixNode,
387 const char *ExternalPathname,
389 ACPI_NAMESPACE_NODE **OutNode);
392 AcpiNsGetPathnameLength (
393 ACPI_NAMESPACE_NODE *Node);
397 * nsobject - Object management for namespace nodes
401 ACPI_NAMESPACE_NODE *Node,
402 ACPI_OPERAND_OBJECT *Object,
403 ACPI_OBJECT_TYPE Type);
405 ACPI_OPERAND_OBJECT *
406 AcpiNsGetAttachedObject (
407 ACPI_NAMESPACE_NODE *Node);
409 ACPI_OPERAND_OBJECT *
410 AcpiNsGetSecondaryObject (
411 ACPI_OPERAND_OBJECT *ObjDesc);
415 ACPI_NAMESPACE_NODE *Node,
416 ACPI_OBJECT_HANDLER Handler,
421 ACPI_NAMESPACE_NODE *Node,
422 ACPI_OBJECT_HANDLER Handler);
425 AcpiNsGetAttachedData (
426 ACPI_NAMESPACE_NODE *Node,
427 ACPI_OBJECT_HANDLER Handler,
432 * nsrepair - General return object repair for all
433 * predefined methods/objects
437 ACPI_PREDEFINED_DATA *Data,
438 UINT32 ExpectedBtypes,
440 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
443 AcpiNsRepairPackageList (
444 ACPI_PREDEFINED_DATA *Data,
445 ACPI_OPERAND_OBJECT **ObjDescPtr);
448 AcpiNsRepairNullElement (
449 ACPI_PREDEFINED_DATA *Data,
450 UINT32 ExpectedBtypes,
452 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
455 AcpiNsRemoveNullElements (
456 ACPI_PREDEFINED_DATA *Data,
458 ACPI_OPERAND_OBJECT *ObjDesc);
462 * nsrepair2 - Return object repair for specific
463 * predefined methods/objects
466 AcpiNsComplexRepairs (
467 ACPI_PREDEFINED_DATA *Data,
468 ACPI_NAMESPACE_NODE *Node,
469 ACPI_STATUS ValidateStatus,
470 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
474 * nssearch - Namespace searching and entry
477 AcpiNsSearchAndEnter (
479 ACPI_WALK_STATE *WalkState,
480 ACPI_NAMESPACE_NODE *Node,
481 ACPI_INTERPRETER_MODE InterpreterMode,
482 ACPI_OBJECT_TYPE Type,
484 ACPI_NAMESPACE_NODE **RetNode);
487 AcpiNsSearchOneScope (
489 ACPI_NAMESPACE_NODE *Node,
490 ACPI_OBJECT_TYPE Type,
491 ACPI_NAMESPACE_NODE **RetNode);
495 ACPI_WALK_STATE *WalkState,
496 ACPI_NAMESPACE_NODE *ParentNode,
497 ACPI_NAMESPACE_NODE *Node,
498 ACPI_OBJECT_TYPE Type);
502 * nsutils - Utility functions
505 AcpiNsValidRootPrefix (
510 ACPI_NAMESPACE_NODE *Node);
514 ACPI_OBJECT_TYPE Type);
517 AcpiNsPrintNodePathname (
518 ACPI_NAMESPACE_NODE *Node,
522 AcpiNsBuildInternalName (
523 ACPI_NAMESTRING_INFO *Info);
526 AcpiNsGetInternalNameLength (
527 ACPI_NAMESTRING_INFO *Info);
530 AcpiNsInternalizeName (
531 const char *DottedName,
532 char **ConvertedName);
535 AcpiNsExternalizeName (
536 UINT32 InternalNameLength,
537 const char *InternalName,
538 UINT32 *ConvertedNameLength,
539 char **ConvertedName);
541 ACPI_NAMESPACE_NODE *
542 AcpiNsValidateHandle (
549 #endif /* __ACNAMESP_H__ */