1 /******************************************************************************
3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2018, 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 0x0001
172 #define ACPI_NS_DONT_OPEN_SCOPE 0x0002
173 #define ACPI_NS_NO_PEER_SEARCH 0x0004
174 #define ACPI_NS_ERROR_IF_FOUND 0x0008
175 #define ACPI_NS_PREFIX_IS_SCOPE 0x0010
176 #define ACPI_NS_EXTERNAL 0x0020
177 #define ACPI_NS_TEMPORARY 0x0040
178 #define ACPI_NS_OVERRIDE_IF_FOUND 0x0080
179 #define ACPI_NS_EARLY_INIT 0x0100
181 /* Flags for AcpiNsWalkNamespace */
183 #define ACPI_NS_WALK_NO_UNLOCK 0
184 #define ACPI_NS_WALK_UNLOCK 0x01
185 #define ACPI_NS_WALK_TEMP_NODES 0x02
187 /* Object is not a package element */
189 #define ACPI_NOT_PACKAGE_ELEMENT ACPI_UINT32_MAX
190 #define ACPI_ALL_PACKAGE_ELEMENTS (ACPI_UINT32_MAX-1)
192 /* Always emit warning message, not dependent on node flags */
194 #define ACPI_WARN_ALWAYS 0
198 * nsinit - Namespace initialization
201 AcpiNsInitializeObjects (
205 AcpiNsInitializeDevices (
209 AcpiNsInitOnePackage (
210 ACPI_HANDLE ObjHandle,
216 * nsload - Namespace loading
219 AcpiNsLoadNamespace (
225 ACPI_NAMESPACE_NODE *Node);
229 * nswalk - walk the namespace
232 AcpiNsWalkNamespace (
233 ACPI_OBJECT_TYPE Type,
234 ACPI_HANDLE StartObject,
237 ACPI_WALK_CALLBACK DescendingCallback,
238 ACPI_WALK_CALLBACK AscendingCallback,
242 ACPI_NAMESPACE_NODE *
244 ACPI_NAMESPACE_NODE *Parent,
245 ACPI_NAMESPACE_NODE *Child);
247 ACPI_NAMESPACE_NODE *
248 AcpiNsGetNextNodeTyped (
249 ACPI_OBJECT_TYPE Type,
250 ACPI_NAMESPACE_NODE *Parent,
251 ACPI_NAMESPACE_NODE *Child);
254 * nsparse - table parsing
259 ACPI_NAMESPACE_NODE *StartNode);
264 ACPI_NAMESPACE_NODE *StartNode);
267 AcpiNsOneCompleteParse (
270 ACPI_NAMESPACE_NODE *StartNode);
274 * nsaccess - Top-level namespace access
277 AcpiNsRootInitialize (
282 ACPI_GENERIC_STATE *ScopeInfo,
284 ACPI_OBJECT_TYPE Type,
285 ACPI_INTERPRETER_MODE InterpreterMode,
287 ACPI_WALK_STATE *WalkState,
288 ACPI_NAMESPACE_NODE **RetNode);
292 * nsalloc - Named object allocation/deallocation
294 ACPI_NAMESPACE_NODE *
300 ACPI_NAMESPACE_NODE *Node);
304 ACPI_NAMESPACE_NODE *Node);
307 AcpiNsDeleteNamespaceSubtree (
308 ACPI_NAMESPACE_NODE *ParentHandle);
311 AcpiNsDeleteNamespaceByOwner (
312 ACPI_OWNER_ID OwnerId);
316 ACPI_NAMESPACE_NODE *Node);
319 AcpiNsDeleteChildren (
320 ACPI_NAMESPACE_NODE *Parent);
329 * nsconvert - Dynamic object conversion routines
332 AcpiNsConvertToInteger (
333 ACPI_OPERAND_OBJECT *OriginalObject,
334 ACPI_OPERAND_OBJECT **ReturnObject);
337 AcpiNsConvertToString (
338 ACPI_OPERAND_OBJECT *OriginalObject,
339 ACPI_OPERAND_OBJECT **ReturnObject);
342 AcpiNsConvertToBuffer (
343 ACPI_OPERAND_OBJECT *OriginalObject,
344 ACPI_OPERAND_OBJECT **ReturnObject);
347 AcpiNsConvertToUnicode (
348 ACPI_NAMESPACE_NODE *Scope,
349 ACPI_OPERAND_OBJECT *OriginalObject,
350 ACPI_OPERAND_OBJECT **ReturnObject);
353 AcpiNsConvertToResource (
354 ACPI_NAMESPACE_NODE *Scope,
355 ACPI_OPERAND_OBJECT *OriginalObject,
356 ACPI_OPERAND_OBJECT **ReturnObject);
359 AcpiNsConvertToReference (
360 ACPI_NAMESPACE_NODE *Scope,
361 ACPI_OPERAND_OBJECT *OriginalObject,
362 ACPI_OPERAND_OBJECT **ReturnObject);
366 * nsdump - Namespace dump/print utilities
370 ACPI_HANDLE SearchBase,
386 AcpiNsPrintPathname (
388 const char *Pathname);
391 AcpiNsDumpOneObject (
392 ACPI_HANDLE ObjHandle,
399 ACPI_OBJECT_TYPE Type,
402 ACPI_OWNER_ID OwnerId,
403 ACPI_HANDLE StartHandle);
406 AcpiNsDumpObjectPaths (
407 ACPI_OBJECT_TYPE Type,
410 ACPI_OWNER_ID OwnerId,
411 ACPI_HANDLE StartHandle);
415 * nseval - Namespace evaluation functions
419 ACPI_EVALUATE_INFO *Info);
422 AcpiNsExecModuleCodeList (
427 * nsarguments - Argument count/type checking for predefined/reserved names
430 AcpiNsCheckArgumentCount (
432 ACPI_NAMESPACE_NODE *Node,
433 UINT32 UserParamCount,
434 const ACPI_PREDEFINED_INFO *Info);
437 AcpiNsCheckAcpiCompliance (
439 ACPI_NAMESPACE_NODE *Node,
440 const ACPI_PREDEFINED_INFO *Predefined);
443 AcpiNsCheckArgumentTypes (
444 ACPI_EVALUATE_INFO *Info);
448 * nspredef - Return value checking for predefined/reserved names
451 AcpiNsCheckReturnValue (
452 ACPI_NAMESPACE_NODE *Node,
453 ACPI_EVALUATE_INFO *Info,
454 UINT32 UserParamCount,
455 ACPI_STATUS ReturnStatus,
456 ACPI_OPERAND_OBJECT **ReturnObject);
459 AcpiNsCheckObjectType (
460 ACPI_EVALUATE_INFO *Info,
461 ACPI_OPERAND_OBJECT **ReturnObjectPtr,
462 UINT32 ExpectedBtypes,
463 UINT32 PackageIndex);
467 * nsprepkg - Validation of predefined name packages
471 ACPI_EVALUATE_INFO *Info,
472 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
476 * nsnames - Name and Scope manipulation
480 ACPI_OBJECT_TYPE Type);
483 AcpiNsGetExternalPathname (
484 ACPI_NAMESPACE_NODE *Node);
487 AcpiNsBuildNormalizedPath (
488 ACPI_NAMESPACE_NODE *Node,
494 AcpiNsGetNormalizedPathname (
495 ACPI_NAMESPACE_NODE *Node,
499 AcpiNsBuildPrefixedPathname (
500 ACPI_GENERIC_STATE *PrefixScope,
501 const char *InternalPath);
504 AcpiNsNameOfCurrentScope (
505 ACPI_WALK_STATE *WalkState);
509 ACPI_HANDLE TargetHandle,
510 ACPI_BUFFER *Buffer);
513 AcpiNsHandleToPathname (
514 ACPI_HANDLE TargetHandle,
520 ACPI_NAMESPACE_NODE *ObjNode,
524 AcpiNsGetNodeUnlocked (
525 ACPI_NAMESPACE_NODE *PrefixNode,
526 const char *ExternalPathname,
528 ACPI_NAMESPACE_NODE **OutNode);
532 ACPI_NAMESPACE_NODE *PrefixNode,
533 const char *ExternalPathname,
535 ACPI_NAMESPACE_NODE **OutNode);
538 AcpiNsGetPathnameLength (
539 ACPI_NAMESPACE_NODE *Node);
543 * nsobject - Object management for namespace nodes
547 ACPI_NAMESPACE_NODE *Node,
548 ACPI_OPERAND_OBJECT *Object,
549 ACPI_OBJECT_TYPE Type);
551 ACPI_OPERAND_OBJECT *
552 AcpiNsGetAttachedObject (
553 ACPI_NAMESPACE_NODE *Node);
555 ACPI_OPERAND_OBJECT *
556 AcpiNsGetSecondaryObject (
557 ACPI_OPERAND_OBJECT *ObjDesc);
561 ACPI_NAMESPACE_NODE *Node,
562 ACPI_OBJECT_HANDLER Handler,
567 ACPI_NAMESPACE_NODE *Node,
568 ACPI_OBJECT_HANDLER Handler);
571 AcpiNsGetAttachedData (
572 ACPI_NAMESPACE_NODE *Node,
573 ACPI_OBJECT_HANDLER Handler,
578 * nsrepair - General return object repair for all
579 * predefined methods/objects
583 ACPI_EVALUATE_INFO *Info,
584 UINT32 ExpectedBtypes,
586 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
589 AcpiNsWrapWithPackage (
590 ACPI_EVALUATE_INFO *Info,
591 ACPI_OPERAND_OBJECT *OriginalObject,
592 ACPI_OPERAND_OBJECT **ObjDescPtr);
595 AcpiNsRepairNullElement (
596 ACPI_EVALUATE_INFO *Info,
597 UINT32 ExpectedBtypes,
599 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
602 AcpiNsRemoveNullElements (
603 ACPI_EVALUATE_INFO *Info,
605 ACPI_OPERAND_OBJECT *ObjDesc);
609 * nsrepair2 - Return object repair for specific
610 * predefined methods/objects
613 AcpiNsComplexRepairs (
614 ACPI_EVALUATE_INFO *Info,
615 ACPI_NAMESPACE_NODE *Node,
616 ACPI_STATUS ValidateStatus,
617 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
621 * nssearch - Namespace searching and entry
624 AcpiNsSearchAndEnter (
626 ACPI_WALK_STATE *WalkState,
627 ACPI_NAMESPACE_NODE *Node,
628 ACPI_INTERPRETER_MODE InterpreterMode,
629 ACPI_OBJECT_TYPE Type,
631 ACPI_NAMESPACE_NODE **RetNode);
634 AcpiNsSearchOneScope (
636 ACPI_NAMESPACE_NODE *Node,
637 ACPI_OBJECT_TYPE Type,
638 ACPI_NAMESPACE_NODE **RetNode);
642 ACPI_WALK_STATE *WalkState,
643 ACPI_NAMESPACE_NODE *ParentNode,
644 ACPI_NAMESPACE_NODE *Node,
645 ACPI_OBJECT_TYPE Type);
649 * nsutils - Utility functions
653 ACPI_NAMESPACE_NODE *Node);
657 ACPI_OBJECT_TYPE Type);
660 AcpiNsPrintNodePathname (
661 ACPI_NAMESPACE_NODE *Node,
665 AcpiNsBuildInternalName (
666 ACPI_NAMESTRING_INFO *Info);
669 AcpiNsGetInternalNameLength (
670 ACPI_NAMESTRING_INFO *Info);
673 AcpiNsInternalizeName (
674 const char *DottedName,
675 char **ConvertedName);
678 AcpiNsExternalizeName (
679 UINT32 InternalNameLength,
680 const char *InternalName,
681 UINT32 *ConvertedNameLength,
682 char **ConvertedName);
684 ACPI_NAMESPACE_NODE *
685 AcpiNsValidateHandle (
692 #endif /* __ACNAMESP_H__ */