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