nsxfobj.c revision 167802
1/*******************************************************************************
2 *
3 * Module Name: nsxfobj - Public interfaces to the ACPI subsystem
4 *                         ACPI Object oriented interfaces
5 *              $Revision: 1.122 $
6 *
7 ******************************************************************************/
8
9/******************************************************************************
10 *
11 * 1. Copyright Notice
12 *
13 * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
14 * All rights reserved.
15 *
16 * 2. License
17 *
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights.  You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
21 * property rights.
22 *
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
29 *
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code.  No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
38 *
39 * The above copyright and patent license is granted only if the following
40 * conditions are met:
41 *
42 * 3. Conditions
43 *
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision.  In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change.  Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee.  Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
55 *
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution.  In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
66 * make.
67 *
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
72 * distribution.
73 *
74 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * Intel Code.
76 *
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
81 *
82 * 4. Disclaimer and Export Compliance
83 *
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * PARTICULAR PURPOSE.
91 *
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * LIMITED REMEDY.
100 *
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government.  In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
115 *
116 *****************************************************************************/
117
118
119#define __NSXFOBJ_C__
120
121#include <contrib/dev/acpica/acpi.h>
122#include <contrib/dev/acpica/acnamesp.h>
123
124
125#define _COMPONENT          ACPI_NAMESPACE
126        ACPI_MODULE_NAME    ("nsxfobj")
127
128/*******************************************************************************
129 *
130 * FUNCTION:    AcpiGetType
131 *
132 * PARAMETERS:  Handle          - Handle of object whose type is desired
133 *              RetType         - Where the type will be placed
134 *
135 * RETURN:      Status
136 *
137 * DESCRIPTION: This routine returns the type associatd with a particular handle
138 *
139 ******************************************************************************/
140
141ACPI_STATUS
142AcpiGetType (
143    ACPI_HANDLE             Handle,
144    ACPI_OBJECT_TYPE        *RetType)
145{
146    ACPI_NAMESPACE_NODE     *Node;
147    ACPI_STATUS             Status;
148
149
150    /* Parameter Validation */
151
152    if (!RetType)
153    {
154        return (AE_BAD_PARAMETER);
155    }
156
157    /*
158     * Special case for the predefined Root Node
159     * (return type ANY)
160     */
161    if (Handle == ACPI_ROOT_OBJECT)
162    {
163        *RetType = ACPI_TYPE_ANY;
164        return (AE_OK);
165    }
166
167    Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
168    if (ACPI_FAILURE (Status))
169    {
170        return (Status);
171    }
172
173    /* Convert and validate the handle */
174
175    Node = AcpiNsMapHandleToNode (Handle);
176    if (!Node)
177    {
178        (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
179        return (AE_BAD_PARAMETER);
180    }
181
182    *RetType = Node->Type;
183
184
185    Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
186    return (Status);
187}
188
189ACPI_EXPORT_SYMBOL (AcpiGetType)
190
191
192/*******************************************************************************
193 *
194 * FUNCTION:    AcpiGetParent
195 *
196 * PARAMETERS:  Handle          - Handle of object whose parent is desired
197 *              RetHandle       - Where the parent handle will be placed
198 *
199 * RETURN:      Status
200 *
201 * DESCRIPTION: Returns a handle to the parent of the object represented by
202 *              Handle.
203 *
204 ******************************************************************************/
205
206ACPI_STATUS
207AcpiGetParent (
208    ACPI_HANDLE             Handle,
209    ACPI_HANDLE             *RetHandle)
210{
211    ACPI_NAMESPACE_NODE     *Node;
212    ACPI_STATUS             Status;
213
214
215    if (!RetHandle)
216    {
217        return (AE_BAD_PARAMETER);
218    }
219
220    /* Special case for the predefined Root Node (no parent) */
221
222    if (Handle == ACPI_ROOT_OBJECT)
223    {
224        return (AE_NULL_ENTRY);
225    }
226
227    Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
228    if (ACPI_FAILURE (Status))
229    {
230        return (Status);
231    }
232
233    /* Convert and validate the handle */
234
235    Node = AcpiNsMapHandleToNode (Handle);
236    if (!Node)
237    {
238        Status = AE_BAD_PARAMETER;
239        goto UnlockAndExit;
240    }
241
242    /* Get the parent entry */
243
244    *RetHandle =
245        AcpiNsConvertEntryToHandle (AcpiNsGetParentNode (Node));
246
247    /* Return exception if parent is null */
248
249    if (!AcpiNsGetParentNode (Node))
250    {
251        Status = AE_NULL_ENTRY;
252    }
253
254
255UnlockAndExit:
256
257    (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
258    return (Status);
259}
260
261ACPI_EXPORT_SYMBOL (AcpiGetParent)
262
263
264/*******************************************************************************
265 *
266 * FUNCTION:    AcpiGetNextObject
267 *
268 * PARAMETERS:  Type            - Type of object to be searched for
269 *              Parent          - Parent object whose children we are getting
270 *              LastChild       - Previous child that was found.
271 *                                The NEXT child will be returned
272 *              RetHandle       - Where handle to the next object is placed
273 *
274 * RETURN:      Status
275 *
276 * DESCRIPTION: Return the next peer object within the namespace.  If Handle is
277 *              valid, Scope is ignored.  Otherwise, the first object within
278 *              Scope is returned.
279 *
280 ******************************************************************************/
281
282ACPI_STATUS
283AcpiGetNextObject (
284    ACPI_OBJECT_TYPE        Type,
285    ACPI_HANDLE             Parent,
286    ACPI_HANDLE             Child,
287    ACPI_HANDLE             *RetHandle)
288{
289    ACPI_STATUS             Status;
290    ACPI_NAMESPACE_NODE     *Node;
291    ACPI_NAMESPACE_NODE     *ParentNode = NULL;
292    ACPI_NAMESPACE_NODE     *ChildNode = NULL;
293
294
295    /* Parameter validation */
296
297    if (Type > ACPI_TYPE_EXTERNAL_MAX)
298    {
299        return (AE_BAD_PARAMETER);
300    }
301
302    Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
303    if (ACPI_FAILURE (Status))
304    {
305        return (Status);
306    }
307
308    /* If null handle, use the parent */
309
310    if (!Child)
311    {
312        /* Start search at the beginning of the specified scope */
313
314        ParentNode = AcpiNsMapHandleToNode (Parent);
315        if (!ParentNode)
316        {
317            Status = AE_BAD_PARAMETER;
318            goto UnlockAndExit;
319        }
320    }
321    else
322    {
323        /* Non-null handle, ignore the parent */
324        /* Convert and validate the handle */
325
326        ChildNode = AcpiNsMapHandleToNode (Child);
327        if (!ChildNode)
328        {
329            Status = AE_BAD_PARAMETER;
330            goto UnlockAndExit;
331        }
332    }
333
334    /* Internal function does the real work */
335
336    Node = AcpiNsGetNextNode (Type, ParentNode, ChildNode);
337    if (!Node)
338    {
339        Status = AE_NOT_FOUND;
340        goto UnlockAndExit;
341    }
342
343    if (RetHandle)
344    {
345        *RetHandle = AcpiNsConvertEntryToHandle (Node);
346    }
347
348
349UnlockAndExit:
350
351    (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
352    return (Status);
353}
354
355ACPI_EXPORT_SYMBOL (AcpiGetNextObject)
356
357