acnamesp.h revision 71867 
1/******************************************************************************
2 *
3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines
4 *       $Revision: 101 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999, 2000, 2001, 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 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 NSP_NORMAL              0
130#define NSP_NEWSCOPE            1   /* a definition of this type opens a name scope */
131#define NSP_LOCAL               2   /* suppress search of enclosing scopes */
132
133
134/* Definitions of the predefined namespace names  */
135
136#define ACPI_UNKNOWN_NAME       (UINT32) 0x3F3F3F3F     /* Unknown name is  "????" */
137#define ACPI_ROOT_NAME          (UINT32) 0x2F202020     /* Root name is     "/   " */
138#define ACPI_SYS_BUS_NAME       (UINT32) 0x5F53425F     /* Sys bus name is  "_SB_" */
139
140#define NS_ROOT_PATH            "/"
141#define NS_SYSTEM_BUS           "_SB_"
142
143
144/* Flags for AcpiNsLookup, AcpiNsSearchAndEnter */
145
146#define NS_NO_UPSEARCH          0
147#define NS_SEARCH_PARENT        0x01
148#define NS_DONT_OPEN_SCOPE      0x02
149#define NS_NO_PEER_SEARCH       0x04
150#define NS_ERROR_IF_FOUND       0x08
151
152#define NS_WALK_UNLOCK          TRUE
153#define NS_WALK_NO_UNLOCK       FALSE
154
155
156ACPI_STATUS
157AcpiNsLoadNamespace (
158    void);
159
160ACPI_STATUS
161AcpiNsInitializeObjects (
162    void);
163
164ACPI_STATUS
165AcpiNsInitializeDevices (
166    UINT32                  Flags);
167
168
169/* Namespace init - nsxfinit */
170
171ACPI_STATUS
172AcpiNsInitOneDevice (
173    ACPI_HANDLE             ObjHandle,
174    UINT32                  NestingLevel,
175    void                    *Context,
176    void                    **ReturnValue);
177
178ACPI_STATUS
179AcpiNsInitOneObject (
180    ACPI_HANDLE             ObjHandle,
181    UINT32                  Level,
182    void                    *Context,
183    void                    **ReturnValue);
184
185
186ACPI_STATUS
187AcpiNsWalkNamespace (
188    OBJECT_TYPE_INTERNAL    Type,
189    ACPI_HANDLE             StartObject,
190    UINT32                  MaxDepth,
191    BOOLEAN                 UnlockBeforeCallback,
192    WALK_CALLBACK           UserFunction,
193    void                    *Context,
194    void                    **ReturnValue);
195
196
197ACPI_NAMESPACE_NODE *
198AcpiNsGetNextObject (
199    OBJECT_TYPE_INTERNAL    Type,
200    ACPI_NAMESPACE_NODE     *Parent,
201    ACPI_NAMESPACE_NODE     *Child);
202
203
204ACPI_STATUS
205AcpiNsDeleteNamespaceByOwner (
206    UINT16                  TableId);
207
208
209/* Namespace loading - nsload */
210
211ACPI_STATUS
212AcpiNsOneCompleteParse (
213    UINT32                  PassNumber,
214    ACPI_TABLE_DESC         *TableDesc);
215
216ACPI_STATUS
217AcpiNsParseTable (
218    ACPI_TABLE_DESC         *TableDesc,
219    ACPI_NAMESPACE_NODE     *Scope);
220
221ACPI_STATUS
222AcpiNsLoadTable (
223    ACPI_TABLE_DESC         *TableDesc,
224    ACPI_NAMESPACE_NODE     *Node);
225
226ACPI_STATUS
227AcpiNsLoadTableByType (
228    ACPI_TABLE_TYPE         TableType);
229
230
231/*
232 * Top-level namespace access - nsaccess
233 */
234
235
236ACPI_STATUS
237AcpiNsRootInitialize (
238    void);
239
240ACPI_STATUS
241AcpiNsLookup (
242    ACPI_GENERIC_STATE      *ScopeInfo,
243    NATIVE_CHAR             *Name,
244    OBJECT_TYPE_INTERNAL    Type,
245    OPERATING_MODE          InterpreterMode,
246    UINT32                  Flags,
247    ACPI_WALK_STATE         *WalkState,
248    ACPI_NAMESPACE_NODE     **RetNode);
249
250
251/*
252 * Named object allocation/deallocation - nsalloc
253 */
254
255
256ACPI_NAMESPACE_NODE *
257AcpiNsCreateNode (
258    UINT32                  AcpiName);
259
260void
261AcpiNsDeleteNode (
262    ACPI_NAMESPACE_NODE     *Node);
263
264ACPI_STATUS
265AcpiNsDeleteNamespaceSubtree (
266    ACPI_NAMESPACE_NODE     *ParentHandle);
267
268void
269AcpiNsDetachObject (
270    ACPI_NAMESPACE_NODE     *Node);
271
272void
273AcpiNsDeleteChildren (
274    ACPI_NAMESPACE_NODE     *Parent);
275
276
277/*
278 * Namespace modification - nsmodify
279 */
280
281ACPI_STATUS
282AcpiNsUnloadNamespace (
283    ACPI_HANDLE             Handle);
284
285ACPI_STATUS
286AcpiNsDeleteSubtree (
287    ACPI_HANDLE             StartHandle);
288
289
290/*
291 * Namespace dump/print utilities - nsdump
292 */
293
294void
295AcpiNsDumpTables (
296    ACPI_HANDLE             SearchBase,
297    UINT32                  MaxDepth);
298
299void
300AcpiNsDumpEntry (
301    ACPI_HANDLE             Handle,
302    UINT32                  DebugLevel);
303
304ACPI_STATUS
305AcpiNsDumpPathname (
306    ACPI_HANDLE             Handle,
307    NATIVE_CHAR             *Msg,
308    UINT32                  Level,
309    UINT32                  Component);
310
311void
312AcpiNsDumpRootDevices (
313    void);
314
315void
316AcpiNsDumpObjects (
317    OBJECT_TYPE_INTERNAL    Type,
318    UINT32                  MaxDepth,
319    UINT32                  OwnderId,
320    ACPI_HANDLE             StartHandle);
321
322
323/*
324 * Namespace evaluation functions - nseval
325 */
326
327ACPI_STATUS
328AcpiNsEvaluateByHandle (
329    ACPI_NAMESPACE_NODE     *PrefixNode,
330    ACPI_OPERAND_OBJECT     **Params,
331    ACPI_OPERAND_OBJECT     **ReturnObject);
332
333ACPI_STATUS
334AcpiNsEvaluateByName (
335    NATIVE_CHAR             *Pathname,
336    ACPI_OPERAND_OBJECT     **Params,
337    ACPI_OPERAND_OBJECT     **ReturnObject);
338
339ACPI_STATUS
340AcpiNsEvaluateRelative (
341    ACPI_NAMESPACE_NODE     *PrefixNode,
342    NATIVE_CHAR             *Pathname,
343    ACPI_OPERAND_OBJECT     **Params,
344    ACPI_OPERAND_OBJECT     **ReturnObject);
345
346ACPI_STATUS
347AcpiNsExecuteControlMethod (
348    ACPI_NAMESPACE_NODE     *MethodNode,
349    ACPI_OPERAND_OBJECT     **Params,
350    ACPI_OPERAND_OBJECT     **ReturnObjDesc);
351
352ACPI_STATUS
353AcpiNsGetObjectValue (
354    ACPI_NAMESPACE_NODE     *ObjectNode,
355    ACPI_OPERAND_OBJECT     **ReturnObjDesc);
356
357
358/*
359 * Parent/Child/Peer utility functions - nsfamily
360 */
361
362ACPI_NAME
363AcpiNsFindParentName (
364    ACPI_NAMESPACE_NODE     *NodeToSearch);
365
366BOOLEAN
367AcpiNsExistDownstreamSibling (
368    ACPI_NAMESPACE_NODE     *ThisNode);
369
370
371/*
372 * Scope manipulation - nsscope
373 */
374
375UINT32
376AcpiNsOpensScope (
377    OBJECT_TYPE_INTERNAL    Type);
378
379NATIVE_CHAR *
380AcpiNsGetTablePathname (
381    ACPI_NAMESPACE_NODE     *Node);
382
383NATIVE_CHAR *
384AcpiNsNameOfCurrentScope (
385    ACPI_WALK_STATE         *WalkState);
386
387ACPI_STATUS
388AcpiNsHandleToPathname (
389    ACPI_HANDLE             ObjHandle,
390    UINT32                  *BufSize,
391    NATIVE_CHAR             *UserBuffer);
392
393BOOLEAN
394AcpiNsPatternMatch (
395    ACPI_NAMESPACE_NODE     *ObjNode,
396    NATIVE_CHAR             *SearchFor);
397
398ACPI_STATUS
399AcpiNsNameCompare (
400    ACPI_HANDLE             ObjHandle,
401    UINT32                  Level,
402    void                    *Context,
403    void                    **ReturnValue);
404
405ACPI_STATUS
406AcpiNsGetNode (
407    NATIVE_CHAR             *Pathname,
408    ACPI_NAMESPACE_NODE     *InPrefixNode,
409    ACPI_NAMESPACE_NODE     **OutNode);
410
411/*
412 * Object management for NTEs - nsobject
413 */
414
415ACPI_STATUS
416AcpiNsAttachObject (
417    ACPI_NAMESPACE_NODE     *Node,
418    ACPI_OPERAND_OBJECT     *Object,
419    OBJECT_TYPE_INTERNAL    Type);
420
421
422void *
423AcpiNsCompareValue (
424    ACPI_HANDLE             ObjHandle,
425    UINT32                  Level,
426    void                    *ObjDesc);
427
428
429/*
430 * Namespace searching and entry - nssearch
431 */
432
433ACPI_STATUS
434AcpiNsSearchAndEnter (
435    UINT32                  EntryName,
436    ACPI_WALK_STATE         *WalkState,
437    ACPI_NAMESPACE_NODE     *Node,
438    OPERATING_MODE          InterpreterMode,
439    OBJECT_TYPE_INTERNAL    Type,
440    UINT32                  Flags,
441    ACPI_NAMESPACE_NODE     **RetNode);
442
443ACPI_STATUS
444AcpiNsSearchNode (
445    UINT32                  EntryName,
446    ACPI_NAMESPACE_NODE     *Node,
447    OBJECT_TYPE_INTERNAL    Type,
448    ACPI_NAMESPACE_NODE     **RetNode);
449
450void
451AcpiNsInstallNode (
452    ACPI_WALK_STATE         *WalkState,
453    ACPI_NAMESPACE_NODE     *ParentNode,    /* Parent */
454    ACPI_NAMESPACE_NODE     *Node,      /* New Child*/
455    OBJECT_TYPE_INTERNAL    Type);
456
457
458/*
459 * Utility functions - nsutils
460 */
461
462BOOLEAN
463AcpiNsValidRootPrefix (
464    NATIVE_CHAR             Prefix);
465
466BOOLEAN
467AcpiNsValidPathSeparator (
468    NATIVE_CHAR             Sep);
469
470OBJECT_TYPE_INTERNAL
471AcpiNsGetType (
472    ACPI_HANDLE             ObjHandle);
473
474void *
475AcpiNsGetAttachedObject (
476    ACPI_HANDLE             ObjHandle);
477
478UINT32
479AcpiNsLocal (
480    OBJECT_TYPE_INTERNAL    Type);
481
482ACPI_STATUS
483AcpiNsInternalizeName (
484    NATIVE_CHAR             *DottedName,
485    NATIVE_CHAR             **ConvertedName);
486
487ACPI_STATUS
488AcpiNsExternalizeName (
489    UINT32                  InternalNameLength,
490    NATIVE_CHAR             *InternalName,
491    UINT32                  *ConvertedNameLength,
492    NATIVE_CHAR             **ConvertedName);
493
494ACPI_NAMESPACE_NODE *
495AcpiNsConvertHandleToEntry (
496    ACPI_HANDLE             Handle);
497
498ACPI_HANDLE
499AcpiNsConvertEntryToHandle(
500    ACPI_NAMESPACE_NODE     *Node);
501
502void
503AcpiNsTerminate (
504    void);
505
506ACPI_NAMESPACE_NODE *
507AcpiNsGetParentObject (
508    ACPI_NAMESPACE_NODE     *Node);
509
510
511ACPI_NAMESPACE_NODE *
512AcpiNsGetNextValidObject (
513    ACPI_NAMESPACE_NODE     *Node);
514
515
516#endif /* __ACNAMESP_H__ */
517