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/* Object is not a package element */
150
151#define ACPI_NOT_PACKAGE_ELEMENT ACPI_UINT32_MAX
152
153/* Always emit warning message, not dependent on node flags */
154
155#define ACPI_WARN_ALWAYS 0
156
157
158/*
159 * nsinit - Namespace initialization
160 */
161ACPI_STATUS
162AcpiNsInitializeObjects (
163 void);
164
165ACPI_STATUS
166AcpiNsInitializeDevices (
167 void);
168
169
170/*
171 * nsload - Namespace loading
172 */
173ACPI_STATUS
174AcpiNsLoadNamespace (
175 void);
176
177ACPI_STATUS
178AcpiNsLoadTable (
179 UINT32 TableIndex,
180 ACPI_NAMESPACE_NODE *Node);
181
182
183/*
184 * nswalk - walk the namespace
185 */
186ACPI_STATUS
187AcpiNsWalkNamespace (
188 ACPI_OBJECT_TYPE Type,
189 ACPI_HANDLE StartObject,
190 UINT32 MaxDepth,
191 UINT32 Flags,
192 ACPI_WALK_CALLBACK PreOrderVisit,
193 ACPI_WALK_CALLBACK PostOrderVisit,
194 void *Context,
195 void **ReturnValue);
196
197ACPI_NAMESPACE_NODE *
198AcpiNsGetNextNode (
199 ACPI_NAMESPACE_NODE *Parent,
200 ACPI_NAMESPACE_NODE *Child);
201
202ACPI_NAMESPACE_NODE *
203AcpiNsGetNextNodeTyped (
204 ACPI_OBJECT_TYPE Type,
205 ACPI_NAMESPACE_NODE *Parent,
206 ACPI_NAMESPACE_NODE *Child);
207
208/*
209 * nsparse - table parsing
210 */
211ACPI_STATUS
212AcpiNsParseTable (
213 UINT32 TableIndex,
214 ACPI_NAMESPACE_NODE *StartNode);
215
216ACPI_STATUS
217AcpiNsOneCompleteParse (
218 UINT32 PassNumber,
219 UINT32 TableIndex,
220 ACPI_NAMESPACE_NODE *StartNode);
221
222
223/*
224 * nsaccess - Top-level namespace access
225 */
226ACPI_STATUS
227AcpiNsRootInitialize (
228 void);
229
230ACPI_STATUS
231AcpiNsLookup (
232 ACPI_GENERIC_STATE *ScopeInfo,
233 char *Name,
234 ACPI_OBJECT_TYPE Type,
235 ACPI_INTERPRETER_MODE InterpreterMode,
236 UINT32 Flags,
237 ACPI_WALK_STATE *WalkState,
238 ACPI_NAMESPACE_NODE **RetNode);
239
240
241/*
242 * nsalloc - Named object allocation/deallocation
243 */
244ACPI_NAMESPACE_NODE *
245AcpiNsCreateNode (
246 UINT32 Name);
247
248void
249AcpiNsDeleteNode (
250 ACPI_NAMESPACE_NODE *Node);
251
252void
253AcpiNsRemoveNode (
254 ACPI_NAMESPACE_NODE *Node);
255
256void
257AcpiNsDeleteNamespaceSubtree (
258 ACPI_NAMESPACE_NODE *ParentHandle);
259
260void
261AcpiNsDeleteNamespaceByOwner (
262 ACPI_OWNER_ID OwnerId);
263
264void
265AcpiNsDetachObject (
266 ACPI_NAMESPACE_NODE *Node);
267
268void
269AcpiNsDeleteChildren (
270 ACPI_NAMESPACE_NODE *Parent);
271
272int
273AcpiNsCompareNames (
274 char *Name1,
275 char *Name2);
276
277
278/*
279 * nsdump - Namespace dump/print utilities
280 */
281void
282AcpiNsDumpTables (
283 ACPI_HANDLE SearchBase,
284 UINT32 MaxDepth);
285
286void
287AcpiNsDumpEntry (
288 ACPI_HANDLE Handle,
289 UINT32 DebugLevel);
290
291void
292AcpiNsDumpPathname (
293 ACPI_HANDLE Handle,
294 char *Msg,
295 UINT32 Level,
296 UINT32 Component);
297
298void
299AcpiNsPrintPathname (
300 UINT32 NumSegments,
301 char *Pathname);
302
303ACPI_STATUS
304AcpiNsDumpOneObject (
305 ACPI_HANDLE ObjHandle,
306 UINT32 Level,
307 void *Context,
308 void **ReturnValue);
309
310void
311AcpiNsDumpObjects (
312 ACPI_OBJECT_TYPE Type,
313 UINT8 DisplayType,
314 UINT32 MaxDepth,
315 ACPI_OWNER_ID OwnerId,
316 ACPI_HANDLE StartHandle);
317
318
319/*
320 * nseval - Namespace evaluation functions
321 */
322ACPI_STATUS
323AcpiNsEvaluate (
324 ACPI_EVALUATE_INFO *Info);
325
326void
327AcpiNsExecModuleCodeList (
328 void);
329
330
331/*
332 * nspredef - Support for predefined/reserved names
333 */
334ACPI_STATUS
335AcpiNsCheckPredefinedNames (
336 ACPI_NAMESPACE_NODE *Node,
337 UINT32 UserParamCount,
338 ACPI_STATUS ReturnStatus,
339 ACPI_OPERAND_OBJECT **ReturnObject);
340
341const ACPI_PREDEFINED_INFO *
342AcpiNsCheckForPredefinedName (
343 ACPI_NAMESPACE_NODE *Node);
344
345void
346AcpiNsCheckParameterCount (
347 char *Pathname,
348 ACPI_NAMESPACE_NODE *Node,
349 UINT32 UserParamCount,
350 const ACPI_PREDEFINED_INFO *Info);
351
352
353/*
354 * nsnames - Name and Scope manipulation
355 */
356UINT32
357AcpiNsOpensScope (
358 ACPI_OBJECT_TYPE Type);
359
360ACPI_STATUS
361AcpiNsBuildExternalPath (
362 ACPI_NAMESPACE_NODE *Node,
363 ACPI_SIZE Size,
364 char *NameBuffer);
365
366char *
367AcpiNsGetExternalPathname (
368 ACPI_NAMESPACE_NODE *Node);
369
370char *
371AcpiNsNameOfCurrentScope (
372 ACPI_WALK_STATE *WalkState);
373
374ACPI_STATUS
375AcpiNsHandleToPathname (
376 ACPI_HANDLE TargetHandle,
377 ACPI_BUFFER *Buffer);
378
379BOOLEAN
380AcpiNsPatternMatch (
381 ACPI_NAMESPACE_NODE *ObjNode,
382 char *SearchFor);
383
384ACPI_STATUS
385AcpiNsGetNode (
386 ACPI_NAMESPACE_NODE *PrefixNode,
387 const char *ExternalPathname,
388 UINT32 Flags,
389 ACPI_NAMESPACE_NODE **OutNode);
390
391ACPI_SIZE
392AcpiNsGetPathnameLength (
393 ACPI_NAMESPACE_NODE *Node);
394
395
396/*
397 * nsobject - Object management for namespace nodes
398 */
399ACPI_STATUS
400AcpiNsAttachObject (
401 ACPI_NAMESPACE_NODE *Node,
402 ACPI_OPERAND_OBJECT *Object,
403 ACPI_OBJECT_TYPE Type);
404
405ACPI_OPERAND_OBJECT *
406AcpiNsGetAttachedObject (
407 ACPI_NAMESPACE_NODE *Node);
408
409ACPI_OPERAND_OBJECT *
410AcpiNsGetSecondaryObject (
411 ACPI_OPERAND_OBJECT *ObjDesc);
412
413ACPI_STATUS
414AcpiNsAttachData (
415 ACPI_NAMESPACE_NODE *Node,
416 ACPI_OBJECT_HANDLER Handler,
417 void *Data);
418
419ACPI_STATUS
420AcpiNsDetachData (
421 ACPI_NAMESPACE_NODE *Node,
422 ACPI_OBJECT_HANDLER Handler);
423
424ACPI_STATUS
425AcpiNsGetAttachedData (
426 ACPI_NAMESPACE_NODE *Node,
427 ACPI_OBJECT_HANDLER Handler,
428 void **Data);
429
430
431/*
432 * nsrepair - General return object repair for all
433 * predefined methods/objects
434 */
435ACPI_STATUS
436AcpiNsRepairObject (
437 ACPI_PREDEFINED_DATA *Data,
438 UINT32 ExpectedBtypes,
439 UINT32 PackageIndex,
440 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
441
442ACPI_STATUS
443AcpiNsRepairPackageList (
444 ACPI_PREDEFINED_DATA *Data,
445 ACPI_OPERAND_OBJECT **ObjDescPtr);
446
447
448/*
449 * nsrepair2 - Return object repair for specific
450 * predefined methods/objects
451 */
452ACPI_STATUS
453AcpiNsComplexRepairs (
454 ACPI_PREDEFINED_DATA *Data,
455 ACPI_NAMESPACE_NODE *Node,
456 ACPI_STATUS ValidateStatus,
457 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
458
459
460/*
461 * nssearch - Namespace searching and entry
462 */
463ACPI_STATUS
464AcpiNsSearchAndEnter (
465 UINT32 EntryName,
466 ACPI_WALK_STATE *WalkState,
467 ACPI_NAMESPACE_NODE *Node,
468 ACPI_INTERPRETER_MODE InterpreterMode,
469 ACPI_OBJECT_TYPE Type,
470 UINT32 Flags,
471 ACPI_NAMESPACE_NODE **RetNode);
472
473ACPI_STATUS
474AcpiNsSearchOneScope (
475 UINT32 EntryName,
476 ACPI_NAMESPACE_NODE *Node,
477 ACPI_OBJECT_TYPE Type,
478 ACPI_NAMESPACE_NODE **RetNode);
479
480void
481AcpiNsInstallNode (
482 ACPI_WALK_STATE *WalkState,
483 ACPI_NAMESPACE_NODE *ParentNode,
484 ACPI_NAMESPACE_NODE *Node,
485 ACPI_OBJECT_TYPE Type);
486
487
488/*
489 * nsutils - Utility functions
490 */
491BOOLEAN
492AcpiNsValidRootPrefix (
493 char Prefix);
494
495ACPI_OBJECT_TYPE
496AcpiNsGetType (
497 ACPI_NAMESPACE_NODE *Node);
498
499UINT32
500AcpiNsLocal (
501 ACPI_OBJECT_TYPE Type);
502
503void
504AcpiNsReportError (
505 const char *ModuleName,
506 UINT32 LineNumber,
507 const char *InternalName,
508 ACPI_STATUS LookupStatus);
509
510void
511AcpiNsReportMethodError (
512 const char *ModuleName,
513 UINT32 LineNumber,
514 const char *Message,
515 ACPI_NAMESPACE_NODE *Node,
516 const char *Path,
517 ACPI_STATUS LookupStatus);
518
519void
520AcpiNsPrintNodePathname (
521 ACPI_NAMESPACE_NODE *Node,
522 const char *Msg);
523
524ACPI_STATUS
525AcpiNsBuildInternalName (
526 ACPI_NAMESTRING_INFO *Info);
527
528void
529AcpiNsGetInternalNameLength (
530 ACPI_NAMESTRING_INFO *Info);
531
532ACPI_STATUS
533AcpiNsInternalizeName (
534 const char *DottedName,
535 char **ConvertedName);
536
537ACPI_STATUS
538AcpiNsExternalizeName (
539 UINT32 InternalNameLength,
540 const char *InternalName,
541 UINT32 *ConvertedNameLength,
542 char **ConvertedName);
543
544ACPI_NAMESPACE_NODE *
545AcpiNsMapHandleToNode (
546 ACPI_HANDLE Handle);
547
548ACPI_HANDLE
549AcpiNsConvertEntryToHandle(
550 ACPI_NAMESPACE_NODE *Node);
551
552void
553AcpiNsTerminate (
554 void);
555
556ACPI_NAMESPACE_NODE *
557AcpiNsGetParentNode (
558 ACPI_NAMESPACE_NODE *Node);
559
560
561ACPI_NAMESPACE_NODE *
562AcpiNsGetNextValidNode (
563 ACPI_NAMESPACE_NODE *Node);
564
565#endif /* __ACNAMESP_H__ */
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/* Object is not a package element */
150
151#define ACPI_NOT_PACKAGE_ELEMENT ACPI_UINT32_MAX
152
153/* Always emit warning message, not dependent on node flags */
154
155#define ACPI_WARN_ALWAYS 0
156
157
158/*
159 * nsinit - Namespace initialization
160 */
161ACPI_STATUS
162AcpiNsInitializeObjects (
163 void);
164
165ACPI_STATUS
166AcpiNsInitializeDevices (
167 void);
168
169
170/*
171 * nsload - Namespace loading
172 */
173ACPI_STATUS
174AcpiNsLoadNamespace (
175 void);
176
177ACPI_STATUS
178AcpiNsLoadTable (
179 UINT32 TableIndex,
180 ACPI_NAMESPACE_NODE *Node);
181
182
183/*
184 * nswalk - walk the namespace
185 */
186ACPI_STATUS
187AcpiNsWalkNamespace (
188 ACPI_OBJECT_TYPE Type,
189 ACPI_HANDLE StartObject,
190 UINT32 MaxDepth,
191 UINT32 Flags,
192 ACPI_WALK_CALLBACK PreOrderVisit,
193 ACPI_WALK_CALLBACK PostOrderVisit,
194 void *Context,
195 void **ReturnValue);
196
197ACPI_NAMESPACE_NODE *
198AcpiNsGetNextNode (
199 ACPI_NAMESPACE_NODE *Parent,
200 ACPI_NAMESPACE_NODE *Child);
201
202ACPI_NAMESPACE_NODE *
203AcpiNsGetNextNodeTyped (
204 ACPI_OBJECT_TYPE Type,
205 ACPI_NAMESPACE_NODE *Parent,
206 ACPI_NAMESPACE_NODE *Child);
207
208/*
209 * nsparse - table parsing
210 */
211ACPI_STATUS
212AcpiNsParseTable (
213 UINT32 TableIndex,
214 ACPI_NAMESPACE_NODE *StartNode);
215
216ACPI_STATUS
217AcpiNsOneCompleteParse (
218 UINT32 PassNumber,
219 UINT32 TableIndex,
220 ACPI_NAMESPACE_NODE *StartNode);
221
222
223/*
224 * nsaccess - Top-level namespace access
225 */
226ACPI_STATUS
227AcpiNsRootInitialize (
228 void);
229
230ACPI_STATUS
231AcpiNsLookup (
232 ACPI_GENERIC_STATE *ScopeInfo,
233 char *Name,
234 ACPI_OBJECT_TYPE Type,
235 ACPI_INTERPRETER_MODE InterpreterMode,
236 UINT32 Flags,
237 ACPI_WALK_STATE *WalkState,
238 ACPI_NAMESPACE_NODE **RetNode);
239
240
241/*
242 * nsalloc - Named object allocation/deallocation
243 */
244ACPI_NAMESPACE_NODE *
245AcpiNsCreateNode (
246 UINT32 Name);
247
248void
249AcpiNsDeleteNode (
250 ACPI_NAMESPACE_NODE *Node);
251
252void
253AcpiNsRemoveNode (
254 ACPI_NAMESPACE_NODE *Node);
255
256void
257AcpiNsDeleteNamespaceSubtree (
258 ACPI_NAMESPACE_NODE *ParentHandle);
259
260void
261AcpiNsDeleteNamespaceByOwner (
262 ACPI_OWNER_ID OwnerId);
263
264void
265AcpiNsDetachObject (
266 ACPI_NAMESPACE_NODE *Node);
267
268void
269AcpiNsDeleteChildren (
270 ACPI_NAMESPACE_NODE *Parent);
271
272int
273AcpiNsCompareNames (
274 char *Name1,
275 char *Name2);
276
277
278/*
279 * nsdump - Namespace dump/print utilities
280 */
281void
282AcpiNsDumpTables (
283 ACPI_HANDLE SearchBase,
284 UINT32 MaxDepth);
285
286void
287AcpiNsDumpEntry (
288 ACPI_HANDLE Handle,
289 UINT32 DebugLevel);
290
291void
292AcpiNsDumpPathname (
293 ACPI_HANDLE Handle,
294 char *Msg,
295 UINT32 Level,
296 UINT32 Component);
297
298void
299AcpiNsPrintPathname (
300 UINT32 NumSegments,
301 char *Pathname);
302
303ACPI_STATUS
304AcpiNsDumpOneObject (
305 ACPI_HANDLE ObjHandle,
306 UINT32 Level,
307 void *Context,
308 void **ReturnValue);
309
310void
311AcpiNsDumpObjects (
312 ACPI_OBJECT_TYPE Type,
313 UINT8 DisplayType,
314 UINT32 MaxDepth,
315 ACPI_OWNER_ID OwnerId,
316 ACPI_HANDLE StartHandle);
317
318
319/*
320 * nseval - Namespace evaluation functions
321 */
322ACPI_STATUS
323AcpiNsEvaluate (
324 ACPI_EVALUATE_INFO *Info);
325
326void
327AcpiNsExecModuleCodeList (
328 void);
329
330
331/*
332 * nspredef - Support for predefined/reserved names
333 */
334ACPI_STATUS
335AcpiNsCheckPredefinedNames (
336 ACPI_NAMESPACE_NODE *Node,
337 UINT32 UserParamCount,
338 ACPI_STATUS ReturnStatus,
339 ACPI_OPERAND_OBJECT **ReturnObject);
340
341const ACPI_PREDEFINED_INFO *
342AcpiNsCheckForPredefinedName (
343 ACPI_NAMESPACE_NODE *Node);
344
345void
346AcpiNsCheckParameterCount (
347 char *Pathname,
348 ACPI_NAMESPACE_NODE *Node,
349 UINT32 UserParamCount,
350 const ACPI_PREDEFINED_INFO *Info);
351
352
353/*
354 * nsnames - Name and Scope manipulation
355 */
356UINT32
357AcpiNsOpensScope (
358 ACPI_OBJECT_TYPE Type);
359
360ACPI_STATUS
361AcpiNsBuildExternalPath (
362 ACPI_NAMESPACE_NODE *Node,
363 ACPI_SIZE Size,
364 char *NameBuffer);
365
366char *
367AcpiNsGetExternalPathname (
368 ACPI_NAMESPACE_NODE *Node);
369
370char *
371AcpiNsNameOfCurrentScope (
372 ACPI_WALK_STATE *WalkState);
373
374ACPI_STATUS
375AcpiNsHandleToPathname (
376 ACPI_HANDLE TargetHandle,
377 ACPI_BUFFER *Buffer);
378
379BOOLEAN
380AcpiNsPatternMatch (
381 ACPI_NAMESPACE_NODE *ObjNode,
382 char *SearchFor);
383
384ACPI_STATUS
385AcpiNsGetNode (
386 ACPI_NAMESPACE_NODE *PrefixNode,
387 const char *ExternalPathname,
388 UINT32 Flags,
389 ACPI_NAMESPACE_NODE **OutNode);
390
391ACPI_SIZE
392AcpiNsGetPathnameLength (
393 ACPI_NAMESPACE_NODE *Node);
394
395
396/*
397 * nsobject - Object management for namespace nodes
398 */
399ACPI_STATUS
400AcpiNsAttachObject (
401 ACPI_NAMESPACE_NODE *Node,
402 ACPI_OPERAND_OBJECT *Object,
403 ACPI_OBJECT_TYPE Type);
404
405ACPI_OPERAND_OBJECT *
406AcpiNsGetAttachedObject (
407 ACPI_NAMESPACE_NODE *Node);
408
409ACPI_OPERAND_OBJECT *
410AcpiNsGetSecondaryObject (
411 ACPI_OPERAND_OBJECT *ObjDesc);
412
413ACPI_STATUS
414AcpiNsAttachData (
415 ACPI_NAMESPACE_NODE *Node,
416 ACPI_OBJECT_HANDLER Handler,
417 void *Data);
418
419ACPI_STATUS
420AcpiNsDetachData (
421 ACPI_NAMESPACE_NODE *Node,
422 ACPI_OBJECT_HANDLER Handler);
423
424ACPI_STATUS
425AcpiNsGetAttachedData (
426 ACPI_NAMESPACE_NODE *Node,
427 ACPI_OBJECT_HANDLER Handler,
428 void **Data);
429
430
431/*
432 * nsrepair - General return object repair for all
433 * predefined methods/objects
434 */
435ACPI_STATUS
436AcpiNsRepairObject (
437 ACPI_PREDEFINED_DATA *Data,
438 UINT32 ExpectedBtypes,
439 UINT32 PackageIndex,
440 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
441
442ACPI_STATUS
443AcpiNsRepairPackageList (
444 ACPI_PREDEFINED_DATA *Data,
445 ACPI_OPERAND_OBJECT **ObjDescPtr);
446
447
448/*
449 * nsrepair2 - Return object repair for specific
450 * predefined methods/objects
451 */
452ACPI_STATUS
453AcpiNsComplexRepairs (
454 ACPI_PREDEFINED_DATA *Data,
455 ACPI_NAMESPACE_NODE *Node,
456 ACPI_STATUS ValidateStatus,
457 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
458
459
460/*
461 * nssearch - Namespace searching and entry
462 */
463ACPI_STATUS
464AcpiNsSearchAndEnter (
465 UINT32 EntryName,
466 ACPI_WALK_STATE *WalkState,
467 ACPI_NAMESPACE_NODE *Node,
468 ACPI_INTERPRETER_MODE InterpreterMode,
469 ACPI_OBJECT_TYPE Type,
470 UINT32 Flags,
471 ACPI_NAMESPACE_NODE **RetNode);
472
473ACPI_STATUS
474AcpiNsSearchOneScope (
475 UINT32 EntryName,
476 ACPI_NAMESPACE_NODE *Node,
477 ACPI_OBJECT_TYPE Type,
478 ACPI_NAMESPACE_NODE **RetNode);
479
480void
481AcpiNsInstallNode (
482 ACPI_WALK_STATE *WalkState,
483 ACPI_NAMESPACE_NODE *ParentNode,
484 ACPI_NAMESPACE_NODE *Node,
485 ACPI_OBJECT_TYPE Type);
486
487
488/*
489 * nsutils - Utility functions
490 */
491BOOLEAN
492AcpiNsValidRootPrefix (
493 char Prefix);
494
495ACPI_OBJECT_TYPE
496AcpiNsGetType (
497 ACPI_NAMESPACE_NODE *Node);
498
499UINT32
500AcpiNsLocal (
501 ACPI_OBJECT_TYPE Type);
502
503void
504AcpiNsReportError (
505 const char *ModuleName,
506 UINT32 LineNumber,
507 const char *InternalName,
508 ACPI_STATUS LookupStatus);
509
510void
511AcpiNsReportMethodError (
512 const char *ModuleName,
513 UINT32 LineNumber,
514 const char *Message,
515 ACPI_NAMESPACE_NODE *Node,
516 const char *Path,
517 ACPI_STATUS LookupStatus);
518
519void
520AcpiNsPrintNodePathname (
521 ACPI_NAMESPACE_NODE *Node,
522 const char *Msg);
523
524ACPI_STATUS
525AcpiNsBuildInternalName (
526 ACPI_NAMESTRING_INFO *Info);
527
528void
529AcpiNsGetInternalNameLength (
530 ACPI_NAMESTRING_INFO *Info);
531
532ACPI_STATUS
533AcpiNsInternalizeName (
534 const char *DottedName,
535 char **ConvertedName);
536
537ACPI_STATUS
538AcpiNsExternalizeName (
539 UINT32 InternalNameLength,
540 const char *InternalName,
541 UINT32 *ConvertedNameLength,
542 char **ConvertedName);
543
544ACPI_NAMESPACE_NODE *
545AcpiNsMapHandleToNode (
546 ACPI_HANDLE Handle);
547
548ACPI_HANDLE
549AcpiNsConvertEntryToHandle(
550 ACPI_NAMESPACE_NODE *Node);
551
552void
553AcpiNsTerminate (
554 void);
555
556ACPI_NAMESPACE_NODE *
557AcpiNsGetParentNode (
558 ACPI_NAMESPACE_NODE *Node);
559
560
561ACPI_NAMESPACE_NODE *
562AcpiNsGetNextValidNode (
563 ACPI_NAMESPACE_NODE *Node);
564
565#endif /* __ACNAMESP_H__ */