xref: /illumos-gate/usr/src/uts/intel/sys/acpi/acnamesp.h (revision 7c478bd9)
1 /******************************************************************************
2  *
3  * Name: acnamesp.h - Namespace subcomponent prototypes and defines
4  *       $Revision: 140 $
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2005, 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 /* Flags for AcpiNsLookup, AcpiNsSearchAndEnter */
134 
135 #define ACPI_NS_NO_UPSEARCH         0
136 #define ACPI_NS_SEARCH_PARENT       0x01
137 #define ACPI_NS_DONT_OPEN_SCOPE     0x02
138 #define ACPI_NS_NO_PEER_SEARCH      0x04
139 #define ACPI_NS_ERROR_IF_FOUND      0x08
140 
141 #define ACPI_NS_WALK_UNLOCK         TRUE
142 #define ACPI_NS_WALK_NO_UNLOCK      FALSE
143 
144 
145 /*
146  * nsinit - Namespace initialization
147  */
148 ACPI_STATUS
149 AcpiNsInitializeObjects (
150     void);
151 
152 ACPI_STATUS
153 AcpiNsInitializeDevices (
154     void);
155 
156 
157 /*
158  * nsload -  Namespace loading
159  */
160 ACPI_STATUS
161 AcpiNsLoadNamespace (
162     void);
163 
164 ACPI_STATUS
165 AcpiNsLoadTable (
166     ACPI_TABLE_DESC         *TableDesc,
167     ACPI_NAMESPACE_NODE     *Node);
168 
169 
170 /*
171  * nswalk - walk the namespace
172  */
173 ACPI_STATUS
174 AcpiNsWalkNamespace (
175     ACPI_OBJECT_TYPE        Type,
176     ACPI_HANDLE             StartObject,
177     UINT32                  MaxDepth,
178     BOOLEAN                 UnlockBeforeCallback,
179     ACPI_WALK_CALLBACK      UserFunction,
180     void                    *Context,
181     void                    **ReturnValue);
182 
183 ACPI_NAMESPACE_NODE *
184 AcpiNsGetNextNode (
185     ACPI_OBJECT_TYPE        Type,
186     ACPI_NAMESPACE_NODE     *Parent,
187     ACPI_NAMESPACE_NODE     *Child);
188 
189 
190 /*
191  * nsparse - table parsing
192  */
193 ACPI_STATUS
194 AcpiNsParseTable (
195     ACPI_TABLE_DESC         *TableDesc,
196     ACPI_NAMESPACE_NODE     *Scope);
197 
198 ACPI_STATUS
199 AcpiNsOneCompleteParse (
200     UINT32                  PassNumber,
201     ACPI_TABLE_DESC         *TableDesc);
202 
203 
204 /*
205  * nsaccess - Top-level namespace access
206  */
207 ACPI_STATUS
208 AcpiNsRootInitialize (
209     void);
210 
211 ACPI_STATUS
212 AcpiNsLookup (
213     ACPI_GENERIC_STATE      *ScopeInfo,
214     char                    *Name,
215     ACPI_OBJECT_TYPE        Type,
216     ACPI_INTERPRETER_MODE   InterpreterMode,
217     UINT32                  Flags,
218     ACPI_WALK_STATE         *WalkState,
219     ACPI_NAMESPACE_NODE     **RetNode);
220 
221 
222 /*
223  * nsalloc - Named object allocation/deallocation
224  */
225 ACPI_NAMESPACE_NODE *
226 AcpiNsCreateNode (
227     UINT32                  Name);
228 
229 void
230 AcpiNsDeleteNode (
231     ACPI_NAMESPACE_NODE     *Node);
232 
233 void
234 AcpiNsDeleteNamespaceSubtree (
235     ACPI_NAMESPACE_NODE     *ParentHandle);
236 
237 void
238 AcpiNsDeleteNamespaceByOwner (
239     UINT16                  TableId);
240 
241 void
242 AcpiNsDetachObject (
243     ACPI_NAMESPACE_NODE     *Node);
244 
245 void
246 AcpiNsDeleteChildren (
247     ACPI_NAMESPACE_NODE     *Parent);
248 
249 int
250 AcpiNsCompareNames (
251     char                    *Name1,
252     char                    *Name2);
253 
254 
255 /*
256  * nsdump - Namespace dump/print utilities
257  */
258 void
259 AcpiNsDumpTables (
260     ACPI_HANDLE             SearchBase,
261     UINT32                  MaxDepth);
262 
263 void
264 AcpiNsDumpEntry (
265     ACPI_HANDLE             Handle,
266     UINT32                  DebugLevel);
267 
268 void
269 AcpiNsDumpPathname (
270     ACPI_HANDLE             Handle,
271     char                    *Msg,
272     UINT32                  Level,
273     UINT32                  Component);
274 
275 void
276 AcpiNsPrintPathname (
277     UINT32                  NumSegments,
278     char                    *Pathname);
279 
280 ACPI_STATUS
281 AcpiNsDumpOneObject (
282     ACPI_HANDLE             ObjHandle,
283     UINT32                  Level,
284     void                    *Context,
285     void                    **ReturnValue);
286 
287 void
288 AcpiNsDumpObjects (
289     ACPI_OBJECT_TYPE        Type,
290     UINT8                   DisplayType,
291     UINT32                  MaxDepth,
292     UINT32                  OwnderId,
293     ACPI_HANDLE             StartHandle);
294 
295 
296 /*
297  * nseval - Namespace evaluation functions
298  */
299 ACPI_STATUS
300 AcpiNsEvaluateByHandle (
301     ACPI_PARAMETER_INFO     *Info);
302 
303 ACPI_STATUS
304 AcpiNsEvaluateByName (
305     char                    *Pathname,
306     ACPI_PARAMETER_INFO     *Info);
307 
308 ACPI_STATUS
309 AcpiNsEvaluateRelative (
310     char                    *Pathname,
311     ACPI_PARAMETER_INFO     *Info);
312 
313 
314 /*
315  * nsnames - Name and Scope manipulation
316  */
317 UINT32
318 AcpiNsOpensScope (
319     ACPI_OBJECT_TYPE        Type);
320 
321 char *
322 AcpiNsGetExternalPathname (
323     ACPI_NAMESPACE_NODE     *Node);
324 
325 char *
326 AcpiNsNameOfCurrentScope (
327     ACPI_WALK_STATE         *WalkState);
328 
329 ACPI_STATUS
330 AcpiNsHandleToPathname (
331     ACPI_HANDLE             TargetHandle,
332     ACPI_BUFFER             *Buffer);
333 
334 BOOLEAN
335 AcpiNsPatternMatch (
336     ACPI_NAMESPACE_NODE     *ObjNode,
337     char                    *SearchFor);
338 
339 ACPI_STATUS
340 AcpiNsGetNodeByPath (
341     char                    *ExternalPathname,
342     ACPI_NAMESPACE_NODE     *InPrefixNode,
343     UINT32                  Flags,
344     ACPI_NAMESPACE_NODE     **OutNode);
345 
346 ACPI_SIZE
347 AcpiNsGetPathnameLength (
348     ACPI_NAMESPACE_NODE     *Node);
349 
350 
351 /*
352  * nsobject - Object management for namespace nodes
353  */
354 ACPI_STATUS
355 AcpiNsAttachObject (
356     ACPI_NAMESPACE_NODE     *Node,
357     ACPI_OPERAND_OBJECT     *Object,
358     ACPI_OBJECT_TYPE        Type);
359 
360 ACPI_OPERAND_OBJECT *
361 AcpiNsGetAttachedObject (
362     ACPI_NAMESPACE_NODE     *Node);
363 
364 ACPI_OPERAND_OBJECT *
365 AcpiNsGetSecondaryObject (
366     ACPI_OPERAND_OBJECT     *ObjDesc);
367 
368 ACPI_STATUS
369 AcpiNsAttachData (
370     ACPI_NAMESPACE_NODE     *Node,
371     ACPI_OBJECT_HANDLER     Handler,
372     void                    *Data);
373 
374 ACPI_STATUS
375 AcpiNsDetachData (
376     ACPI_NAMESPACE_NODE     *Node,
377     ACPI_OBJECT_HANDLER     Handler);
378 
379 ACPI_STATUS
380 AcpiNsGetAttachedData (
381     ACPI_NAMESPACE_NODE     *Node,
382     ACPI_OBJECT_HANDLER     Handler,
383     void                    **Data);
384 
385 
386 /*
387  * nssearch - Namespace searching and entry
388  */
389 ACPI_STATUS
390 AcpiNsSearchAndEnter (
391     UINT32                  EntryName,
392     ACPI_WALK_STATE         *WalkState,
393     ACPI_NAMESPACE_NODE     *Node,
394     ACPI_INTERPRETER_MODE   InterpreterMode,
395     ACPI_OBJECT_TYPE        Type,
396     UINT32                  Flags,
397     ACPI_NAMESPACE_NODE     **RetNode);
398 
399 ACPI_STATUS
400 AcpiNsSearchNode (
401     UINT32                  EntryName,
402     ACPI_NAMESPACE_NODE     *Node,
403     ACPI_OBJECT_TYPE        Type,
404     ACPI_NAMESPACE_NODE     **RetNode);
405 
406 void
407 AcpiNsInstallNode (
408     ACPI_WALK_STATE         *WalkState,
409     ACPI_NAMESPACE_NODE     *ParentNode,
410     ACPI_NAMESPACE_NODE     *Node,
411     ACPI_OBJECT_TYPE        Type);
412 
413 
414 /*
415  * nsutils - Utility functions
416  */
417 BOOLEAN
418 AcpiNsValidRootPrefix (
419     char                    Prefix);
420 
421 ACPI_OBJECT_TYPE
422 AcpiNsGetType (
423     ACPI_NAMESPACE_NODE     *Node);
424 
425 UINT32
426 AcpiNsLocal (
427     ACPI_OBJECT_TYPE        Type);
428 
429 void
430 AcpiNsReportError (
431     char                    *ModuleName,
432     UINT32                  LineNumber,
433     UINT32                  ComponentId,
434     char                    *InternalName,
435     ACPI_STATUS             LookupStatus);
436 
437 void
438 AcpiNsReportMethodError (
439     char                    *ModuleName,
440     UINT32                  LineNumber,
441     UINT32                  ComponentId,
442     char                    *Message,
443     ACPI_NAMESPACE_NODE     *Node,
444     char                    *Path,
445     ACPI_STATUS             LookupStatus);
446 
447 void
448 AcpiNsPrintNodePathname (
449     ACPI_NAMESPACE_NODE     *Node,
450     char                    *Msg);
451 
452 ACPI_STATUS
453 AcpiNsBuildInternalName (
454     ACPI_NAMESTRING_INFO    *Info);
455 
456 void
457 AcpiNsGetInternalNameLength (
458     ACPI_NAMESTRING_INFO    *Info);
459 
460 ACPI_STATUS
461 AcpiNsInternalizeName (
462     char                    *DottedName,
463     char                    **ConvertedName);
464 
465 ACPI_STATUS
466 AcpiNsExternalizeName (
467     UINT32                  InternalNameLength,
468     char                    *InternalName,
469     UINT32                  *ConvertedNameLength,
470     char                    **ConvertedName);
471 
472 ACPI_NAMESPACE_NODE *
473 AcpiNsMapHandleToNode (
474     ACPI_HANDLE             Handle);
475 
476 ACPI_HANDLE
477 AcpiNsConvertEntryToHandle(
478     ACPI_NAMESPACE_NODE     *Node);
479 
480 void
481 AcpiNsTerminate (
482     void);
483 
484 ACPI_NAMESPACE_NODE *
485 AcpiNsGetParentNode (
486     ACPI_NAMESPACE_NODE     *Node);
487 
488 
489 ACPI_NAMESPACE_NODE *
490 AcpiNsGetNextValidNode (
491     ACPI_NAMESPACE_NODE     *Node);
492 
493 #endif /* __ACNAMESP_H__ */
494