1 /******************************************************************************
3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, 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 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
152 #ifndef __ACNAMESP_H__
153 #define __ACNAMESP_H__
156 /* To search the entire name space, pass this as SearchBase */
158 #define ACPI_NS_ALL ((ACPI_HANDLE)0)
161 * Elements of AcpiNsProperties are bit significant
162 * and should be one-to-one with values of ACPI_OBJECT_TYPE
164 #define ACPI_NS_NORMAL 0
165 #define ACPI_NS_NEWSCOPE 1 /* a definition of this type opens a name scope */
166 #define ACPI_NS_LOCAL 2 /* suppress search of enclosing scopes */
168 /* Flags for AcpiNsLookup, AcpiNsSearchAndEnter */
170 #define ACPI_NS_NO_UPSEARCH 0
171 #define ACPI_NS_SEARCH_PARENT 0x01
172 #define ACPI_NS_DONT_OPEN_SCOPE 0x02
173 #define ACPI_NS_NO_PEER_SEARCH 0x04
174 #define ACPI_NS_ERROR_IF_FOUND 0x08
175 #define ACPI_NS_PREFIX_IS_SCOPE 0x10
176 #define ACPI_NS_EXTERNAL 0x20
177 #define ACPI_NS_TEMPORARY 0x40
178 #define ACPI_NS_OVERRIDE_IF_FOUND 0x80
180 /* Flags for AcpiNsWalkNamespace */
182 #define ACPI_NS_WALK_NO_UNLOCK 0
183 #define ACPI_NS_WALK_UNLOCK 0x01
184 #define ACPI_NS_WALK_TEMP_NODES 0x02
186 /* Object is not a package element */
188 #define ACPI_NOT_PACKAGE_ELEMENT ACPI_UINT32_MAX
189 #define ACPI_ALL_PACKAGE_ELEMENTS (ACPI_UINT32_MAX-1)
191 /* Always emit warning message, not dependent on node flags */
193 #define ACPI_WARN_ALWAYS 0
197 * nsinit - Namespace initialization
200 AcpiNsInitializeObjects (
204 AcpiNsInitializeDevices (
209 * nsload - Namespace loading
212 AcpiNsLoadNamespace (
218 ACPI_NAMESPACE_NODE *Node);
222 * nswalk - walk the namespace
225 AcpiNsWalkNamespace (
226 ACPI_OBJECT_TYPE Type,
227 ACPI_HANDLE StartObject,
230 ACPI_WALK_CALLBACK DescendingCallback,
231 ACPI_WALK_CALLBACK AscendingCallback,
235 ACPI_NAMESPACE_NODE *
237 ACPI_NAMESPACE_NODE *Parent,
238 ACPI_NAMESPACE_NODE *Child);
240 ACPI_NAMESPACE_NODE *
241 AcpiNsGetNextNodeTyped (
242 ACPI_OBJECT_TYPE Type,
243 ACPI_NAMESPACE_NODE *Parent,
244 ACPI_NAMESPACE_NODE *Child);
247 * nsparse - table parsing
252 ACPI_NAMESPACE_NODE *StartNode);
257 ACPI_NAMESPACE_NODE *StartNode);
260 AcpiNsOneCompleteParse (
263 ACPI_NAMESPACE_NODE *StartNode);
267 * nsaccess - Top-level namespace access
270 AcpiNsRootInitialize (
275 ACPI_GENERIC_STATE *ScopeInfo,
277 ACPI_OBJECT_TYPE Type,
278 ACPI_INTERPRETER_MODE InterpreterMode,
280 ACPI_WALK_STATE *WalkState,
281 ACPI_NAMESPACE_NODE **RetNode);
285 * nsalloc - Named object allocation/deallocation
287 ACPI_NAMESPACE_NODE *
293 ACPI_NAMESPACE_NODE *Node);
297 ACPI_NAMESPACE_NODE *Node);
300 AcpiNsDeleteNamespaceSubtree (
301 ACPI_NAMESPACE_NODE *ParentHandle);
304 AcpiNsDeleteNamespaceByOwner (
305 ACPI_OWNER_ID OwnerId);
309 ACPI_NAMESPACE_NODE *Node);
312 AcpiNsDeleteChildren (
313 ACPI_NAMESPACE_NODE *Parent);
322 * nsconvert - Dynamic object conversion routines
325 AcpiNsConvertToInteger (
326 ACPI_OPERAND_OBJECT *OriginalObject,
327 ACPI_OPERAND_OBJECT **ReturnObject);
330 AcpiNsConvertToString (
331 ACPI_OPERAND_OBJECT *OriginalObject,
332 ACPI_OPERAND_OBJECT **ReturnObject);
335 AcpiNsConvertToBuffer (
336 ACPI_OPERAND_OBJECT *OriginalObject,
337 ACPI_OPERAND_OBJECT **ReturnObject);
340 AcpiNsConvertToUnicode (
341 ACPI_NAMESPACE_NODE *Scope,
342 ACPI_OPERAND_OBJECT *OriginalObject,
343 ACPI_OPERAND_OBJECT **ReturnObject);
346 AcpiNsConvertToResource (
347 ACPI_NAMESPACE_NODE *Scope,
348 ACPI_OPERAND_OBJECT *OriginalObject,
349 ACPI_OPERAND_OBJECT **ReturnObject);
352 AcpiNsConvertToReference (
353 ACPI_NAMESPACE_NODE *Scope,
354 ACPI_OPERAND_OBJECT *OriginalObject,
355 ACPI_OPERAND_OBJECT **ReturnObject);
359 * nsdump - Namespace dump/print utilities
363 ACPI_HANDLE SearchBase,
379 AcpiNsPrintPathname (
381 const char *Pathname);
384 AcpiNsDumpOneObject (
385 ACPI_HANDLE ObjHandle,
392 ACPI_OBJECT_TYPE Type,
395 ACPI_OWNER_ID OwnerId,
396 ACPI_HANDLE StartHandle);
399 AcpiNsDumpObjectPaths (
400 ACPI_OBJECT_TYPE Type,
403 ACPI_OWNER_ID OwnerId,
404 ACPI_HANDLE StartHandle);
408 * nseval - Namespace evaluation functions
412 ACPI_EVALUATE_INFO *Info);
415 AcpiNsExecModuleCodeList (
420 * nsarguments - Argument count/type checking for predefined/reserved names
423 AcpiNsCheckArgumentCount (
425 ACPI_NAMESPACE_NODE *Node,
426 UINT32 UserParamCount,
427 const ACPI_PREDEFINED_INFO *Info);
430 AcpiNsCheckAcpiCompliance (
432 ACPI_NAMESPACE_NODE *Node,
433 const ACPI_PREDEFINED_INFO *Predefined);
436 AcpiNsCheckArgumentTypes (
437 ACPI_EVALUATE_INFO *Info);
441 * nspredef - Return value checking for predefined/reserved names
444 AcpiNsCheckReturnValue (
445 ACPI_NAMESPACE_NODE *Node,
446 ACPI_EVALUATE_INFO *Info,
447 UINT32 UserParamCount,
448 ACPI_STATUS ReturnStatus,
449 ACPI_OPERAND_OBJECT **ReturnObject);
452 AcpiNsCheckObjectType (
453 ACPI_EVALUATE_INFO *Info,
454 ACPI_OPERAND_OBJECT **ReturnObjectPtr,
455 UINT32 ExpectedBtypes,
456 UINT32 PackageIndex);
460 * nsprepkg - Validation of predefined name packages
464 ACPI_EVALUATE_INFO *Info,
465 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
469 * nsnames - Name and Scope manipulation
473 ACPI_OBJECT_TYPE Type);
476 AcpiNsGetExternalPathname (
477 ACPI_NAMESPACE_NODE *Node);
480 AcpiNsBuildNormalizedPath (
481 ACPI_NAMESPACE_NODE *Node,
487 AcpiNsGetNormalizedPathname (
488 ACPI_NAMESPACE_NODE *Node,
492 AcpiNsNameOfCurrentScope (
493 ACPI_WALK_STATE *WalkState);
497 ACPI_HANDLE TargetHandle,
498 ACPI_BUFFER *Buffer);
501 AcpiNsHandleToPathname (
502 ACPI_HANDLE TargetHandle,
508 ACPI_NAMESPACE_NODE *ObjNode,
512 AcpiNsGetNodeUnlocked (
513 ACPI_NAMESPACE_NODE *PrefixNode,
514 const char *ExternalPathname,
516 ACPI_NAMESPACE_NODE **OutNode);
520 ACPI_NAMESPACE_NODE *PrefixNode,
521 const char *ExternalPathname,
523 ACPI_NAMESPACE_NODE **OutNode);
526 AcpiNsGetPathnameLength (
527 ACPI_NAMESPACE_NODE *Node);
531 * nsobject - Object management for namespace nodes
535 ACPI_NAMESPACE_NODE *Node,
536 ACPI_OPERAND_OBJECT *Object,
537 ACPI_OBJECT_TYPE Type);
539 ACPI_OPERAND_OBJECT *
540 AcpiNsGetAttachedObject (
541 ACPI_NAMESPACE_NODE *Node);
543 ACPI_OPERAND_OBJECT *
544 AcpiNsGetSecondaryObject (
545 ACPI_OPERAND_OBJECT *ObjDesc);
549 ACPI_NAMESPACE_NODE *Node,
550 ACPI_OBJECT_HANDLER Handler,
555 ACPI_NAMESPACE_NODE *Node,
556 ACPI_OBJECT_HANDLER Handler);
559 AcpiNsGetAttachedData (
560 ACPI_NAMESPACE_NODE *Node,
561 ACPI_OBJECT_HANDLER Handler,
566 * nsrepair - General return object repair for all
567 * predefined methods/objects
571 ACPI_EVALUATE_INFO *Info,
572 UINT32 ExpectedBtypes,
574 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
577 AcpiNsWrapWithPackage (
578 ACPI_EVALUATE_INFO *Info,
579 ACPI_OPERAND_OBJECT *OriginalObject,
580 ACPI_OPERAND_OBJECT **ObjDescPtr);
583 AcpiNsRepairNullElement (
584 ACPI_EVALUATE_INFO *Info,
585 UINT32 ExpectedBtypes,
587 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
590 AcpiNsRemoveNullElements (
591 ACPI_EVALUATE_INFO *Info,
593 ACPI_OPERAND_OBJECT *ObjDesc);
597 * nsrepair2 - Return object repair for specific
598 * predefined methods/objects
601 AcpiNsComplexRepairs (
602 ACPI_EVALUATE_INFO *Info,
603 ACPI_NAMESPACE_NODE *Node,
604 ACPI_STATUS ValidateStatus,
605 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
609 * nssearch - Namespace searching and entry
612 AcpiNsSearchAndEnter (
614 ACPI_WALK_STATE *WalkState,
615 ACPI_NAMESPACE_NODE *Node,
616 ACPI_INTERPRETER_MODE InterpreterMode,
617 ACPI_OBJECT_TYPE Type,
619 ACPI_NAMESPACE_NODE **RetNode);
622 AcpiNsSearchOneScope (
624 ACPI_NAMESPACE_NODE *Node,
625 ACPI_OBJECT_TYPE Type,
626 ACPI_NAMESPACE_NODE **RetNode);
630 ACPI_WALK_STATE *WalkState,
631 ACPI_NAMESPACE_NODE *ParentNode,
632 ACPI_NAMESPACE_NODE *Node,
633 ACPI_OBJECT_TYPE Type);
637 * nsutils - Utility functions
641 ACPI_NAMESPACE_NODE *Node);
645 ACPI_OBJECT_TYPE Type);
648 AcpiNsPrintNodePathname (
649 ACPI_NAMESPACE_NODE *Node,
653 AcpiNsBuildInternalName (
654 ACPI_NAMESTRING_INFO *Info);
657 AcpiNsGetInternalNameLength (
658 ACPI_NAMESTRING_INFO *Info);
661 AcpiNsInternalizeName (
662 const char *DottedName,
663 char **ConvertedName);
666 AcpiNsExternalizeName (
667 UINT32 InternalNameLength,
668 const char *InternalName,
669 UINT32 *ConvertedNameLength,
670 char **ConvertedName);
672 ACPI_NAMESPACE_NODE *
673 AcpiNsValidateHandle (
680 #endif /* __ACNAMESP_H__ */