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