acnamesp.h revision 167802 
1/******************************************************************************
2 *
3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines
4 *       $Revision: 1.152 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
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
20 * property rights.
21 *
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
28 *
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;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
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.
54 *
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
65 * make.
66 *
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
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
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.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
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
89 * PARTICULAR PURPOSE.
90 *
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
98 * LIMITED REMEDY.
99 *
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.
114 *
115 *****************************************************************************/
116
117#ifndef __ACNAMESP_H__
118#define __ACNAMESP_H__
119
120
121/* To search the entire name space, pass this as SearchBase */
122
123#define ACPI_NS_ALL                 ((ACPI_HANDLE)0)
124
125/*
126 * Elements of AcpiNsProperties are bit significant
127 * and should be one-to-one with values of ACPI_OBJECT_TYPE
128 */
129#define ACPI_NS_NORMAL              0
130#define ACPI_NS_NEWSCOPE            1   /* a definition of this type opens a name scope */
131#define ACPI_NS_LOCAL               2   /* suppress search of enclosing scopes */
132
133/* Flags for AcpiNsLookup, AcpiNsSearchAndEnter */
134
135#define ACPI_NS_NO_UPSEARCH         0
136#define ACPI_NS_SEARCH_PARENT       0x01
137#define ACPI_NS_DONT_OPEN_SCOPE     0x02
138#define ACPI_NS_NO_PEER_SEARCH      0x04
139#define ACPI_NS_ERROR_IF_FOUND      0x08
140#define ACPI_NS_PREFIX_IS_SCOPE     0x10
141#define ACPI_NS_EXTERNAL            0x20
142#define ACPI_NS_TEMPORARY           0x40
143
144/* Flags for AcpiNsWalkNamespace */
145
146#define ACPI_NS_WALK_NO_UNLOCK      0
147#define ACPI_NS_WALK_UNLOCK         0x01
148#define ACPI_NS_WALK_TEMP_NODES     0x02
149
150
151/*
152 * nsinit - Namespace initialization
153 */
154ACPI_STATUS
155AcpiNsInitializeObjects (
156    void);
157
158ACPI_STATUS
159AcpiNsInitializeDevices (
160    void);
161
162
163/*
164 * nsload -  Namespace loading
165 */
166ACPI_STATUS
167AcpiNsLoadNamespace (
168    void);
169
170ACPI_STATUS
171AcpiNsLoadTable (
172    ACPI_NATIVE_UINT        TableIndex,
173    ACPI_NAMESPACE_NODE     *Node);
174
175
176/*
177 * nswalk - walk the namespace
178 */
179ACPI_STATUS
180AcpiNsWalkNamespace (
181    ACPI_OBJECT_TYPE        Type,
182    ACPI_HANDLE             StartObject,
183    UINT32                  MaxDepth,
184    UINT32                  Flags,
185    ACPI_WALK_CALLBACK      UserFunction,
186    void                    *Context,
187    void                    **ReturnValue);
188
189ACPI_NAMESPACE_NODE *
190AcpiNsGetNextNode (
191    ACPI_OBJECT_TYPE        Type,
192    ACPI_NAMESPACE_NODE     *Parent,
193    ACPI_NAMESPACE_NODE     *Child);
194
195
196/*
197 * nsparse - table parsing
198 */
199ACPI_STATUS
200AcpiNsParseTable (
201    ACPI_NATIVE_UINT        TableIndex,
202    ACPI_NAMESPACE_NODE     *StartNode);
203
204ACPI_STATUS
205AcpiNsOneCompleteParse (
206    ACPI_NATIVE_UINT        PassNumber,
207    ACPI_NATIVE_UINT        TableIndex);
208
209
210/*
211 * nsaccess - Top-level namespace access
212 */
213ACPI_STATUS
214AcpiNsRootInitialize (
215    void);
216
217ACPI_STATUS
218AcpiNsLookup (
219    ACPI_GENERIC_STATE      *ScopeInfo,
220    char                    *Name,
221    ACPI_OBJECT_TYPE        Type,
222    ACPI_INTERPRETER_MODE   InterpreterMode,
223    UINT32                  Flags,
224    ACPI_WALK_STATE         *WalkState,
225    ACPI_NAMESPACE_NODE     **RetNode);
226
227
228/*
229 * nsalloc - Named object allocation/deallocation
230 */
231ACPI_NAMESPACE_NODE *
232AcpiNsCreateNode (
233    UINT32                  Name);
234
235void
236AcpiNsDeleteNode (
237    ACPI_NAMESPACE_NODE     *Node);
238
239void
240AcpiNsDeleteNamespaceSubtree (
241    ACPI_NAMESPACE_NODE     *ParentHandle);
242
243void
244AcpiNsDeleteNamespaceByOwner (
245    ACPI_OWNER_ID           OwnerId);
246
247void
248AcpiNsDetachObject (
249    ACPI_NAMESPACE_NODE     *Node);
250
251void
252AcpiNsDeleteChildren (
253    ACPI_NAMESPACE_NODE     *Parent);
254
255int
256AcpiNsCompareNames (
257    char                    *Name1,
258    char                    *Name2);
259
260
261/*
262 * nsdump - Namespace dump/print utilities
263 */
264void
265AcpiNsDumpTables (
266    ACPI_HANDLE             SearchBase,
267    UINT32                  MaxDepth);
268
269void
270AcpiNsDumpEntry (
271    ACPI_HANDLE             Handle,
272    UINT32                  DebugLevel);
273
274void
275AcpiNsDumpPathname (
276    ACPI_HANDLE             Handle,
277    char                    *Msg,
278    UINT32                  Level,
279    UINT32                  Component);
280
281void
282AcpiNsPrintPathname (
283    UINT32                  NumSegments,
284    char                    *Pathname);
285
286ACPI_STATUS
287AcpiNsDumpOneObject (
288    ACPI_HANDLE             ObjHandle,
289    UINT32                  Level,
290    void                    *Context,
291    void                    **ReturnValue);
292
293void
294AcpiNsDumpObjects (
295    ACPI_OBJECT_TYPE        Type,
296    UINT8                   DisplayType,
297    UINT32                  MaxDepth,
298    ACPI_OWNER_ID           OwnerId,
299    ACPI_HANDLE             StartHandle);
300
301
302/*
303 * nseval - Namespace evaluation functions
304 */
305ACPI_STATUS
306AcpiNsEvaluate (
307    ACPI_EVALUATE_INFO      *Info);
308
309
310/*
311 * nsnames - Name and Scope manipulation
312 */
313UINT32
314AcpiNsOpensScope (
315    ACPI_OBJECT_TYPE        Type);
316
317void
318AcpiNsBuildExternalPath (
319    ACPI_NAMESPACE_NODE     *Node,
320    ACPI_SIZE               Size,
321    char                    *NameBuffer);
322
323char *
324AcpiNsGetExternalPathname (
325    ACPI_NAMESPACE_NODE     *Node);
326
327char *
328AcpiNsNameOfCurrentScope (
329    ACPI_WALK_STATE         *WalkState);
330
331ACPI_STATUS
332AcpiNsHandleToPathname (
333    ACPI_HANDLE             TargetHandle,
334    ACPI_BUFFER             *Buffer);
335
336BOOLEAN
337AcpiNsPatternMatch (
338    ACPI_NAMESPACE_NODE     *ObjNode,
339    char                    *SearchFor);
340
341ACPI_STATUS
342AcpiNsGetNode (
343    ACPI_NAMESPACE_NODE     *PrefixNode,
344    char                    *ExternalPathname,
345    UINT32                  Flags,
346    ACPI_NAMESPACE_NODE     **OutNode);
347
348ACPI_SIZE
349AcpiNsGetPathnameLength (
350    ACPI_NAMESPACE_NODE     *Node);
351
352
353/*
354 * nsobject - Object management for namespace nodes
355 */
356ACPI_STATUS
357AcpiNsAttachObject (
358    ACPI_NAMESPACE_NODE     *Node,
359    ACPI_OPERAND_OBJECT     *Object,
360    ACPI_OBJECT_TYPE        Type);
361
362ACPI_OPERAND_OBJECT *
363AcpiNsGetAttachedObject (
364    ACPI_NAMESPACE_NODE     *Node);
365
366ACPI_OPERAND_OBJECT *
367AcpiNsGetSecondaryObject (
368    ACPI_OPERAND_OBJECT     *ObjDesc);
369
370ACPI_STATUS
371AcpiNsAttachData (
372    ACPI_NAMESPACE_NODE     *Node,
373    ACPI_OBJECT_HANDLER     Handler,
374    void                    *Data);
375
376ACPI_STATUS
377AcpiNsDetachData (
378    ACPI_NAMESPACE_NODE     *Node,
379    ACPI_OBJECT_HANDLER     Handler);
380
381ACPI_STATUS
382AcpiNsGetAttachedData (
383    ACPI_NAMESPACE_NODE     *Node,
384    ACPI_OBJECT_HANDLER     Handler,
385    void                    **Data);
386
387
388/*
389 * nssearch - Namespace searching and entry
390 */
391ACPI_STATUS
392AcpiNsSearchAndEnter (
393    UINT32                  EntryName,
394    ACPI_WALK_STATE         *WalkState,
395    ACPI_NAMESPACE_NODE     *Node,
396    ACPI_INTERPRETER_MODE   InterpreterMode,
397    ACPI_OBJECT_TYPE        Type,
398    UINT32                  Flags,
399    ACPI_NAMESPACE_NODE     **RetNode);
400
401ACPI_STATUS
402AcpiNsSearchOneScope (
403    UINT32                  EntryName,
404    ACPI_NAMESPACE_NODE     *Node,
405    ACPI_OBJECT_TYPE        Type,
406    ACPI_NAMESPACE_NODE     **RetNode);
407
408void
409AcpiNsInstallNode (
410    ACPI_WALK_STATE         *WalkState,
411    ACPI_NAMESPACE_NODE     *ParentNode,
412    ACPI_NAMESPACE_NODE     *Node,
413    ACPI_OBJECT_TYPE        Type);
414
415
416/*
417 * nsutils - Utility functions
418 */
419BOOLEAN
420AcpiNsValidRootPrefix (
421    char                    Prefix);
422
423ACPI_OBJECT_TYPE
424AcpiNsGetType (
425    ACPI_NAMESPACE_NODE     *Node);
426
427UINT32
428AcpiNsLocal (
429    ACPI_OBJECT_TYPE        Type);
430
431void
432AcpiNsReportError (
433    char                    *ModuleName,
434    UINT32                  LineNumber,
435    char                    *InternalName,
436    ACPI_STATUS             LookupStatus);
437
438void
439AcpiNsReportMethodError (
440    char                    *ModuleName,
441    UINT32                  LineNumber,
442    char                    *Message,
443    ACPI_NAMESPACE_NODE     *Node,
444    char                    *Path,
445    ACPI_STATUS             LookupStatus);
446
447void
448AcpiNsPrintNodePathname (
449    ACPI_NAMESPACE_NODE     *Node,
450    char                    *Msg);
451
452ACPI_STATUS
453AcpiNsBuildInternalName (
454    ACPI_NAMESTRING_INFO    *Info);
455
456void
457AcpiNsGetInternalNameLength (
458    ACPI_NAMESTRING_INFO    *Info);
459
460ACPI_STATUS
461AcpiNsInternalizeName (
462    char                    *DottedName,
463    char                    **ConvertedName);
464
465ACPI_STATUS
466AcpiNsExternalizeName (
467    UINT32                  InternalNameLength,
468    char                    *InternalName,
469    UINT32                  *ConvertedNameLength,
470    char                    **ConvertedName);
471
472ACPI_NAMESPACE_NODE *
473AcpiNsMapHandleToNode (
474    ACPI_HANDLE             Handle);
475
476ACPI_HANDLE
477AcpiNsConvertEntryToHandle(
478    ACPI_NAMESPACE_NODE     *Node);
479
480void
481AcpiNsTerminate (
482    void);
483
484ACPI_NAMESPACE_NODE *
485AcpiNsGetParentNode (
486    ACPI_NAMESPACE_NODE     *Node);
487
488
489ACPI_NAMESPACE_NODE *
490AcpiNsGetNextValidNode (
491    ACPI_NAMESPACE_NODE     *Node);
492
493#endif /* __ACNAMESP_H__ */
494