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
180 #define ACPI_NS_PREFIX_MUST_EXIST 0x0200
182 /* Flags for AcpiNsWalkNamespace */
184 #define ACPI_NS_WALK_NO_UNLOCK 0
185 #define ACPI_NS_WALK_UNLOCK 0x01
186 #define ACPI_NS_WALK_TEMP_NODES 0x02
188 /* Object is not a package element */
190 #define ACPI_NOT_PACKAGE_ELEMENT ACPI_UINT32_MAX
191 #define ACPI_ALL_PACKAGE_ELEMENTS (ACPI_UINT32_MAX-1)
193 /* Always emit warning message, not dependent on node flags */
195 #define ACPI_WARN_ALWAYS 0
199 * nsinit - Namespace initialization
202 AcpiNsInitializeObjects (
206 AcpiNsInitializeDevices (
210 AcpiNsInitOnePackage (
211 ACPI_HANDLE ObjHandle,
217 * nsload - Namespace loading
220 AcpiNsLoadNamespace (
226 ACPI_NAMESPACE_NODE *Node);
230 * nswalk - walk the namespace
233 AcpiNsWalkNamespace (
234 ACPI_OBJECT_TYPE Type,
235 ACPI_HANDLE StartObject,
238 ACPI_WALK_CALLBACK DescendingCallback,
239 ACPI_WALK_CALLBACK AscendingCallback,
243 ACPI_NAMESPACE_NODE *
245 ACPI_NAMESPACE_NODE *Parent,
246 ACPI_NAMESPACE_NODE *Child);
248 ACPI_NAMESPACE_NODE *
249 AcpiNsGetNextNodeTyped (
250 ACPI_OBJECT_TYPE Type,
251 ACPI_NAMESPACE_NODE *Parent,
252 ACPI_NAMESPACE_NODE *Child);
255 * nsparse - table parsing
260 ACPI_NAMESPACE_NODE *StartNode);
265 ACPI_NAMESPACE_NODE *StartNode);
268 AcpiNsOneCompleteParse (
271 ACPI_NAMESPACE_NODE *StartNode);
275 * nsaccess - Top-level namespace access
278 AcpiNsRootInitialize (
283 ACPI_GENERIC_STATE *ScopeInfo,
285 ACPI_OBJECT_TYPE Type,
286 ACPI_INTERPRETER_MODE InterpreterMode,
288 ACPI_WALK_STATE *WalkState,
289 ACPI_NAMESPACE_NODE **RetNode);
293 * nsalloc - Named object allocation/deallocation
295 ACPI_NAMESPACE_NODE *
301 ACPI_NAMESPACE_NODE *Node);
305 ACPI_NAMESPACE_NODE *Node);
308 AcpiNsDeleteNamespaceSubtree (
309 ACPI_NAMESPACE_NODE *ParentHandle);
312 AcpiNsDeleteNamespaceByOwner (
313 ACPI_OWNER_ID OwnerId);
317 ACPI_NAMESPACE_NODE *Node);
320 AcpiNsDeleteChildren (
321 ACPI_NAMESPACE_NODE *Parent);
330 * nsconvert - Dynamic object conversion routines
333 AcpiNsConvertToInteger (
334 ACPI_OPERAND_OBJECT *OriginalObject,
335 ACPI_OPERAND_OBJECT **ReturnObject);
338 AcpiNsConvertToString (
339 ACPI_OPERAND_OBJECT *OriginalObject,
340 ACPI_OPERAND_OBJECT **ReturnObject);
343 AcpiNsConvertToBuffer (
344 ACPI_OPERAND_OBJECT *OriginalObject,
345 ACPI_OPERAND_OBJECT **ReturnObject);
348 AcpiNsConvertToUnicode (
349 ACPI_NAMESPACE_NODE *Scope,
350 ACPI_OPERAND_OBJECT *OriginalObject,
351 ACPI_OPERAND_OBJECT **ReturnObject);
354 AcpiNsConvertToResource (
355 ACPI_NAMESPACE_NODE *Scope,
356 ACPI_OPERAND_OBJECT *OriginalObject,
357 ACPI_OPERAND_OBJECT **ReturnObject);
360 AcpiNsConvertToReference (
361 ACPI_NAMESPACE_NODE *Scope,
362 ACPI_OPERAND_OBJECT *OriginalObject,
363 ACPI_OPERAND_OBJECT **ReturnObject);
367 * nsdump - Namespace dump/print utilities
371 ACPI_HANDLE SearchBase,
387 AcpiNsPrintPathname (
389 const char *Pathname);
392 AcpiNsDumpOneObject (
393 ACPI_HANDLE ObjHandle,
400 ACPI_OBJECT_TYPE Type,
403 ACPI_OWNER_ID OwnerId,
404 ACPI_HANDLE StartHandle);
407 AcpiNsDumpObjectPaths (
408 ACPI_OBJECT_TYPE Type,
411 ACPI_OWNER_ID OwnerId,
412 ACPI_HANDLE StartHandle);
416 * nseval - Namespace evaluation functions
420 ACPI_EVALUATE_INFO *Info);
423 AcpiNsExecModuleCodeList (
428 * nsarguments - Argument count/type checking for predefined/reserved names
431 AcpiNsCheckArgumentCount (
433 ACPI_NAMESPACE_NODE *Node,
434 UINT32 UserParamCount,
435 const ACPI_PREDEFINED_INFO *Info);
438 AcpiNsCheckAcpiCompliance (
440 ACPI_NAMESPACE_NODE *Node,
441 const ACPI_PREDEFINED_INFO *Predefined);
444 AcpiNsCheckArgumentTypes (
445 ACPI_EVALUATE_INFO *Info);
449 * nspredef - Return value checking for predefined/reserved names
452 AcpiNsCheckReturnValue (
453 ACPI_NAMESPACE_NODE *Node,
454 ACPI_EVALUATE_INFO *Info,
455 UINT32 UserParamCount,
456 ACPI_STATUS ReturnStatus,
457 ACPI_OPERAND_OBJECT **ReturnObject);
460 AcpiNsCheckObjectType (
461 ACPI_EVALUATE_INFO *Info,
462 ACPI_OPERAND_OBJECT **ReturnObjectPtr,
463 UINT32 ExpectedBtypes,
464 UINT32 PackageIndex);
468 * nsprepkg - Validation of predefined name packages
472 ACPI_EVALUATE_INFO *Info,
473 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
477 * nsnames - Name and Scope manipulation
481 ACPI_OBJECT_TYPE Type);
484 AcpiNsGetExternalPathname (
485 ACPI_NAMESPACE_NODE *Node);
488 AcpiNsBuildNormalizedPath (
489 ACPI_NAMESPACE_NODE *Node,
495 AcpiNsGetNormalizedPathname (
496 ACPI_NAMESPACE_NODE *Node,
500 AcpiNsBuildPrefixedPathname (
501 ACPI_GENERIC_STATE *PrefixScope,
502 const char *InternalPath);
505 AcpiNsNameOfCurrentScope (
506 ACPI_WALK_STATE *WalkState);
510 ACPI_HANDLE TargetHandle,
511 ACPI_BUFFER *Buffer);
514 AcpiNsHandleToPathname (
515 ACPI_HANDLE TargetHandle,
521 ACPI_NAMESPACE_NODE *ObjNode,
525 AcpiNsGetNodeUnlocked (
526 ACPI_NAMESPACE_NODE *PrefixNode,
527 const char *ExternalPathname,
529 ACPI_NAMESPACE_NODE **OutNode);
533 ACPI_NAMESPACE_NODE *PrefixNode,
534 const char *ExternalPathname,
536 ACPI_NAMESPACE_NODE **OutNode);
539 AcpiNsGetPathnameLength (
540 ACPI_NAMESPACE_NODE *Node);
544 * nsobject - Object management for namespace nodes
548 ACPI_NAMESPACE_NODE *Node,
549 ACPI_OPERAND_OBJECT *Object,
550 ACPI_OBJECT_TYPE Type);
552 ACPI_OPERAND_OBJECT *
553 AcpiNsGetAttachedObject (
554 ACPI_NAMESPACE_NODE *Node);
556 ACPI_OPERAND_OBJECT *
557 AcpiNsGetSecondaryObject (
558 ACPI_OPERAND_OBJECT *ObjDesc);
562 ACPI_NAMESPACE_NODE *Node,
563 ACPI_OBJECT_HANDLER Handler,
568 ACPI_NAMESPACE_NODE *Node,
569 ACPI_OBJECT_HANDLER Handler);
572 AcpiNsGetAttachedData (
573 ACPI_NAMESPACE_NODE *Node,
574 ACPI_OBJECT_HANDLER Handler,
579 * nsrepair - General return object repair for all
580 * predefined methods/objects
584 ACPI_EVALUATE_INFO *Info,
585 UINT32 ExpectedBtypes,
587 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
590 AcpiNsWrapWithPackage (
591 ACPI_EVALUATE_INFO *Info,
592 ACPI_OPERAND_OBJECT *OriginalObject,
593 ACPI_OPERAND_OBJECT **ObjDescPtr);
596 AcpiNsRepairNullElement (
597 ACPI_EVALUATE_INFO *Info,
598 UINT32 ExpectedBtypes,
600 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
603 AcpiNsRemoveNullElements (
604 ACPI_EVALUATE_INFO *Info,
606 ACPI_OPERAND_OBJECT *ObjDesc);
610 * nsrepair2 - Return object repair for specific
611 * predefined methods/objects
614 AcpiNsComplexRepairs (
615 ACPI_EVALUATE_INFO *Info,
616 ACPI_NAMESPACE_NODE *Node,
617 ACPI_STATUS ValidateStatus,
618 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
622 * nssearch - Namespace searching and entry
625 AcpiNsSearchAndEnter (
627 ACPI_WALK_STATE *WalkState,
628 ACPI_NAMESPACE_NODE *Node,
629 ACPI_INTERPRETER_MODE InterpreterMode,
630 ACPI_OBJECT_TYPE Type,
632 ACPI_NAMESPACE_NODE **RetNode);
635 AcpiNsSearchOneScope (
637 ACPI_NAMESPACE_NODE *Node,
638 ACPI_OBJECT_TYPE Type,
639 ACPI_NAMESPACE_NODE **RetNode);
643 ACPI_WALK_STATE *WalkState,
644 ACPI_NAMESPACE_NODE *ParentNode,
645 ACPI_NAMESPACE_NODE *Node,
646 ACPI_OBJECT_TYPE Type);
650 * nsutils - Utility functions
654 ACPI_NAMESPACE_NODE *Node);
658 ACPI_OBJECT_TYPE Type);
661 AcpiNsPrintNodePathname (
662 ACPI_NAMESPACE_NODE *Node,
666 AcpiNsBuildInternalName (
667 ACPI_NAMESTRING_INFO *Info);
670 AcpiNsGetInternalNameLength (
671 ACPI_NAMESTRING_INFO *Info);
674 AcpiNsInternalizeName (
675 const char *DottedName,
676 char **ConvertedName);
679 AcpiNsExternalizeName (
680 UINT32 InternalNameLength,
681 const char *InternalName,
682 UINT32 *ConvertedNameLength,
683 char **ConvertedName);
685 ACPI_NAMESPACE_NODE *
686 AcpiNsValidateHandle (
693 #endif /* __ACNAMESP_H__ */