acnamesp.h revision 100966 
1/******************************************************************************
2 *
3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines
4 *       $Revision: 126 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2002, 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
134/* Definitions of the predefined namespace names  */
135
136#define ACPI_UNKNOWN_NAME           (UINT32) 0x3F3F3F3F     /* Unknown name is  "????" */
137#define ACPI_ROOT_NAME              (UINT32) 0x5F5F5F5C     /* Root name is     "\___" */
138#define ACPI_SYS_BUS_NAME           (UINT32) 0x5F53425F     /* Sys bus name is  "_SB_" */
139
140#define ACPI_NS_ROOT_PATH           "\\"
141#define ACPI_NS_SYSTEM_BUS          "_SB_"
142
143
144/* Flags for AcpiNsLookup, AcpiNsSearchAndEnter */
145
146#define ACPI_NS_NO_UPSEARCH         0
147#define ACPI_NS_SEARCH_PARENT       0x01
148#define ACPI_NS_DONT_OPEN_SCOPE     0x02
149#define ACPI_NS_NO_PEER_SEARCH      0x04
150#define ACPI_NS_ERROR_IF_FOUND      0x08
151
152#define ACPI_NS_WALK_UNLOCK         TRUE
153#define ACPI_NS_WALK_NO_UNLOCK      FALSE
154
155
156ACPI_STATUS
157AcpiNsLoadNamespace (
158    void);
159
160ACPI_STATUS
161AcpiNsInitializeObjects (
162    void);
163
164ACPI_STATUS
165AcpiNsInitializeDevices (
166    void);
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    ACPI_OBJECT_TYPE        Type,
189    ACPI_HANDLE             StartObject,
190    UINT32                  MaxDepth,
191    BOOLEAN                 UnlockBeforeCallback,
192    ACPI_WALK_CALLBACK      UserFunction,
193    void                    *Context,
194    void                    **ReturnValue);
195
196ACPI_NAMESPACE_NODE *
197AcpiNsGetNextNode (
198    ACPI_OBJECT_TYPE        Type,
199    ACPI_NAMESPACE_NODE     *Parent,
200    ACPI_NAMESPACE_NODE     *Child);
201
202void
203AcpiNsDeleteNamespaceByOwner (
204    UINT16                  TableId);
205
206
207/* Namespace loading - nsload */
208
209ACPI_STATUS
210AcpiNsOneCompleteParse (
211    UINT32                  PassNumber,
212    ACPI_TABLE_DESC         *TableDesc);
213
214ACPI_STATUS
215AcpiNsParseTable (
216    ACPI_TABLE_DESC         *TableDesc,
217    ACPI_NAMESPACE_NODE     *Scope);
218
219ACPI_STATUS
220AcpiNsLoadTable (
221    ACPI_TABLE_DESC         *TableDesc,
222    ACPI_NAMESPACE_NODE     *Node);
223
224ACPI_STATUS
225AcpiNsLoadTableByType (
226    ACPI_TABLE_TYPE         TableType);
227
228
229/*
230 * Top-level namespace access - nsaccess
231 */
232
233ACPI_STATUS
234AcpiNsRootInitialize (
235    void);
236
237ACPI_STATUS
238AcpiNsLookup (
239    ACPI_GENERIC_STATE      *ScopeInfo,
240    NATIVE_CHAR             *Name,
241    ACPI_OBJECT_TYPE        Type,
242    ACPI_INTERPRETER_MODE   InterpreterMode,
243    UINT32                  Flags,
244    ACPI_WALK_STATE         *WalkState,
245    ACPI_NAMESPACE_NODE     **RetNode);
246
247
248/*
249 * Named object allocation/deallocation - nsalloc
250 */
251
252ACPI_NAMESPACE_NODE *
253AcpiNsCreateNode (
254    UINT32                  Name);
255
256void
257AcpiNsDeleteNode (
258    ACPI_NAMESPACE_NODE     *Node);
259
260void
261AcpiNsDeleteNamespaceSubtree (
262    ACPI_NAMESPACE_NODE     *ParentHandle);
263
264void
265AcpiNsDetachObject (
266    ACPI_NAMESPACE_NODE     *Node);
267
268void
269AcpiNsDeleteChildren (
270    ACPI_NAMESPACE_NODE     *Parent);
271
272
273/*
274 * Namespace modification - nsmodify
275 */
276
277ACPI_STATUS
278AcpiNsUnloadNamespace (
279    ACPI_HANDLE             Handle);
280
281ACPI_STATUS
282AcpiNsDeleteSubtree (
283    ACPI_HANDLE             StartHandle);
284
285
286/*
287 * Namespace dump/print utilities - nsdump
288 */
289
290void
291AcpiNsDumpTables (
292    ACPI_HANDLE             SearchBase,
293    UINT32                  MaxDepth);
294
295void
296AcpiNsDumpEntry (
297    ACPI_HANDLE             Handle,
298    UINT32                  DebugLevel);
299
300ACPI_STATUS
301AcpiNsDumpPathname (
302    ACPI_HANDLE             Handle,
303    NATIVE_CHAR             *Msg,
304    UINT32                  Level,
305    UINT32                  Component);
306
307void
308AcpiNsPrintPathname (
309    UINT32                  NumSegments,
310    char                    *Pathname);
311
312ACPI_STATUS
313AcpiNsDumpOneDevice (
314    ACPI_HANDLE             ObjHandle,
315    UINT32                  Level,
316    void                    *Context,
317    void                    **ReturnValue);
318
319void
320AcpiNsDumpRootDevices (
321    void);
322
323ACPI_STATUS
324AcpiNsDumpOneObject (
325    ACPI_HANDLE             ObjHandle,
326    UINT32                  Level,
327    void                    *Context,
328    void                    **ReturnValue);
329
330void
331AcpiNsDumpObjects (
332    ACPI_OBJECT_TYPE        Type,
333    UINT8                   DisplayType,
334    UINT32                  MaxDepth,
335    UINT32                  OwnderId,
336    ACPI_HANDLE             StartHandle);
337
338
339/*
340 * Namespace evaluation functions - nseval
341 */
342
343ACPI_STATUS
344AcpiNsEvaluateByHandle (
345    ACPI_NAMESPACE_NODE     *PrefixNode,
346    ACPI_OPERAND_OBJECT     **Params,
347    ACPI_OPERAND_OBJECT     **ReturnObject);
348
349ACPI_STATUS
350AcpiNsEvaluateByName (
351    NATIVE_CHAR             *Pathname,
352    ACPI_OPERAND_OBJECT     **Params,
353    ACPI_OPERAND_OBJECT     **ReturnObject);
354
355ACPI_STATUS
356AcpiNsEvaluateRelative (
357    ACPI_NAMESPACE_NODE     *PrefixNode,
358    NATIVE_CHAR             *Pathname,
359    ACPI_OPERAND_OBJECT     **Params,
360    ACPI_OPERAND_OBJECT     **ReturnObject);
361
362ACPI_STATUS
363AcpiNsExecuteControlMethod (
364    ACPI_NAMESPACE_NODE     *MethodNode,
365    ACPI_OPERAND_OBJECT     **Params,
366    ACPI_OPERAND_OBJECT     **ReturnObjDesc);
367
368ACPI_STATUS
369AcpiNsGetObjectValue (
370    ACPI_NAMESPACE_NODE     *ObjectNode,
371    ACPI_OPERAND_OBJECT     **ReturnObjDesc);
372
373
374/*
375 * Parent/Child/Peer utility functions - nsfamily
376 */
377
378ACPI_NAME
379AcpiNsFindParentName (
380    ACPI_NAMESPACE_NODE     *NodeToSearch);
381
382BOOLEAN
383AcpiNsExistDownstreamSibling (
384    ACPI_NAMESPACE_NODE     *ThisNode);
385
386
387/*
388 * Name and Scope manipulation - nsnames
389 */
390
391UINT32
392AcpiNsOpensScope (
393    ACPI_OBJECT_TYPE        Type);
394
395void
396AcpiNsBuildExternalPath (
397    ACPI_NAMESPACE_NODE     *Node,
398    ACPI_SIZE               Size,
399    NATIVE_CHAR             *NameBuffer);
400
401NATIVE_CHAR *
402AcpiNsGetExternalPathname (
403    ACPI_NAMESPACE_NODE     *Node);
404
405NATIVE_CHAR *
406AcpiNsNameOfCurrentScope (
407    ACPI_WALK_STATE         *WalkState);
408
409ACPI_STATUS
410AcpiNsHandleToPathname (
411    ACPI_HANDLE             TargetHandle,
412    ACPI_BUFFER             *Buffer);
413
414BOOLEAN
415AcpiNsPatternMatch (
416    ACPI_NAMESPACE_NODE     *ObjNode,
417    NATIVE_CHAR             *SearchFor);
418
419ACPI_STATUS
420AcpiNsGetNodeByPath (
421    NATIVE_CHAR             *ExternalPathname,
422    ACPI_NAMESPACE_NODE     *InPrefixNode,
423    UINT32                  Flags,
424    ACPI_NAMESPACE_NODE     **OutNode);
425
426ACPI_SIZE
427AcpiNsGetPathnameLength (
428    ACPI_NAMESPACE_NODE     *Node);
429
430
431/*
432 * Object management for namespace nodes - nsobject
433 */
434
435ACPI_STATUS
436AcpiNsAttachObject (
437    ACPI_NAMESPACE_NODE     *Node,
438    ACPI_OPERAND_OBJECT     *Object,
439    ACPI_OBJECT_TYPE        Type);
440
441ACPI_OPERAND_OBJECT *
442AcpiNsGetAttachedObject (
443    ACPI_NAMESPACE_NODE     *Node);
444
445ACPI_OPERAND_OBJECT *
446AcpiNsGetSecondaryObject (
447    ACPI_OPERAND_OBJECT     *ObjDesc);
448
449ACPI_STATUS
450AcpiNsAttachData (
451    ACPI_NAMESPACE_NODE     *Node,
452    ACPI_OBJECT_HANDLER     Handler,
453    void                    *Data);
454
455ACPI_STATUS
456AcpiNsDetachData (
457    ACPI_NAMESPACE_NODE     *Node,
458    ACPI_OBJECT_HANDLER     Handler);
459
460ACPI_STATUS
461AcpiNsGetAttachedData (
462    ACPI_NAMESPACE_NODE     *Node,
463    ACPI_OBJECT_HANDLER     Handler,
464    void                    **Data);
465
466
467/*
468 * Namespace searching and entry - nssearch
469 */
470
471ACPI_STATUS
472AcpiNsSearchAndEnter (
473    UINT32                  EntryName,
474    ACPI_WALK_STATE         *WalkState,
475    ACPI_NAMESPACE_NODE     *Node,
476    ACPI_INTERPRETER_MODE   InterpreterMode,
477    ACPI_OBJECT_TYPE        Type,
478    UINT32                  Flags,
479    ACPI_NAMESPACE_NODE     **RetNode);
480
481ACPI_STATUS
482AcpiNsSearchNode (
483    UINT32                  EntryName,
484    ACPI_NAMESPACE_NODE     *Node,
485    ACPI_OBJECT_TYPE        Type,
486    ACPI_NAMESPACE_NODE     **RetNode);
487
488void
489AcpiNsInstallNode (
490    ACPI_WALK_STATE         *WalkState,
491    ACPI_NAMESPACE_NODE     *ParentNode,    /* Parent */
492    ACPI_NAMESPACE_NODE     *Node,      /* New Child*/
493    ACPI_OBJECT_TYPE        Type);
494
495
496/*
497 * Utility functions - nsutils
498 */
499
500BOOLEAN
501AcpiNsValidRootPrefix (
502    NATIVE_CHAR             Prefix);
503
504BOOLEAN
505AcpiNsValidPathSeparator (
506    NATIVE_CHAR             Sep);
507
508ACPI_OBJECT_TYPE
509AcpiNsGetType (
510    ACPI_NAMESPACE_NODE     *Node);
511
512UINT32
513AcpiNsLocal (
514    ACPI_OBJECT_TYPE        Type);
515
516ACPI_STATUS
517AcpiNsBuildInternalName (
518    ACPI_NAMESTRING_INFO    *Info);
519
520void
521AcpiNsGetInternalNameLength (
522    ACPI_NAMESTRING_INFO    *Info);
523
524ACPI_STATUS
525AcpiNsInternalizeName (
526    NATIVE_CHAR             *DottedName,
527    NATIVE_CHAR             **ConvertedName);
528
529ACPI_STATUS
530AcpiNsExternalizeName (
531    UINT32                  InternalNameLength,
532    NATIVE_CHAR             *InternalName,
533    UINT32                  *ConvertedNameLength,
534    NATIVE_CHAR             **ConvertedName);
535
536ACPI_NAMESPACE_NODE *
537AcpiNsMapHandleToNode (
538    ACPI_HANDLE             Handle);
539
540ACPI_HANDLE
541AcpiNsConvertEntryToHandle(
542    ACPI_NAMESPACE_NODE     *Node);
543
544void
545AcpiNsTerminate (
546    void);
547
548ACPI_NAMESPACE_NODE *
549AcpiNsGetParentNode (
550    ACPI_NAMESPACE_NODE     *Node);
551
552
553ACPI_NAMESPACE_NODE *
554AcpiNsGetNextValidNode (
555    ACPI_NAMESPACE_NODE     *Node);
556
557
558#endif /* __ACNAMESP_H__ */
559