drivers/acpica/nsxfobj.c

0001 /*******************************************************************************
0002  *
0003  * Module Name: nsxfobj - Public interfaces to the ACPI subsystem
0004  *                         ACPI Object oriented interfaces
0005  *
0006  ******************************************************************************/
0007
0008 /******************************************************************************
0009  *
0010  * 1. Copyright Notice
0011  *
0012  * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
0013  * All rights reserved.
0014  *
0015  * 2. License
0016  *
0017  * 2.1. This is your license from Intel Corp. under its intellectual property
0018  * rights.  You may have additional license terms from the party that provided
0019  * you this software, covering your right to use that party's intellectual
0020  * property rights.
0021  *
0022  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0023  * copy of the source code appearing in this file ("Covered Code") an
0024  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0025  * base code distributed originally by Intel ("Original Intel Code") to copy,
0026  * make derivatives, distribute, use and display any portion of the Covered
0027  * Code in any form, with the right to sublicense such rights; and
0028  *
0029  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0030  * license (with the right to sublicense), under only those claims of Intel
0031  * patents that are infringed by the Original Intel Code, to make, use, sell,
0032  * offer to sell, and import the Covered Code and derivative works thereof
0033  * solely to the minimum extent necessary to exercise the above copyright
0034  * license, and in no event shall the patent license extend to any additions
0035  * to or modifications of the Original Intel Code.  No other license or right
0036  * is granted directly or by implication, estoppel or otherwise;
0037  *
0038  * The above copyright and patent license is granted only if the following
0039  * conditions are met:
0040  *
0041  * 3. Conditions
0042  *
0043  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0044  * Redistribution of source code of any substantial portion of the Covered
0045  * Code or modification with rights to further distribute source must include
0046  * the above Copyright Notice, the above License, this list of Conditions,
0047  * and the following Disclaimer and Export Compliance provision.  In addition,
0048  * Licensee must cause all Covered Code to which Licensee contributes to
0049  * contain a file documenting the changes Licensee made to create that Covered
0050  * Code and the date of any change.  Licensee must include in that file the
0051  * documentation of any changes made by any predecessor Licensee.  Licensee
0052  * must include a prominent statement that the modification is derived,
0053  * directly or indirectly, from Original Intel Code.
0054  *
0055  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0056  * Redistribution of source code of any substantial portion of the Covered
0057  * Code or modification without rights to further distribute source must
0058  * include the following Disclaimer and Export Compliance provision in the
0059  * documentation and/or other materials provided with distribution.  In
0060  * addition, Licensee may not authorize further sublicense of source of any
0061  * portion of the Covered Code, and must include terms to the effect that the
0062  * license from Licensee to its licensee is limited to the intellectual
0063  * property embodied in the software Licensee provides to its licensee, and
0064  * not to intellectual property embodied in modifications its licensee may
0065  * make.
0066  *
0067  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0068  * substantial portion of the Covered Code or modification must reproduce the
0069  * above Copyright Notice, and the following Disclaimer and Export Compliance
0070  * provision in the documentation and/or other materials provided with the
0071  * distribution.
0072  *
0073  * 3.4. Intel retains all right, title, and interest in and to the Original
0074  * Intel Code.
0075  *
0076  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0077  * Intel shall be used in advertising or otherwise to promote the sale, use or
0078  * other dealings in products derived from or relating to the Covered Code
0079  * without prior written authorization from Intel.
0080  *
0081  * 4. Disclaimer and Export Compliance
0082  *
0083  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0084  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0085  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
0086  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
0087  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
0088  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0089  * PARTICULAR PURPOSE.
0090  *
0091  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0092  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0093  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0094  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0095  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0096  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
0097  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0098  * LIMITED REMEDY.
0099  *
0100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0101  * software or system incorporating such software without first obtaining any
0102  * required license or other approval from the U. S. Department of Commerce or
0103  * any other agency or department of the United States Government.  In the
0104  * event Licensee exports any such software from the United States or
0105  * re-exports any such software from a foreign destination, Licensee shall
0106  * ensure that the distribution and export/re-export of the software is in
0107  * compliance with all laws, regulations, orders, or other restrictions of the
0108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0109  * any of its subsidiaries will export/re-export any technical data, process,
0110  * software, or service, directly or indirectly, to any country for which the
0111  * United States government or any agency thereof requires an export license,
0112  * other governmental approval, or letter of assurance, without first obtaining
0113  * such license, approval or letter.
0114  *
0115  *****************************************************************************/
0116
0117
0118 #define __NSXFOBJ_C__
0119
0120 #include "acpi.h"
0121 #include "accommon.h"
0122 #include "acnamesp.h"
0123
0124
0125 #define _COMPONENT          ACPI_NAMESPACE
0126         ACPI_MODULE_NAME    ("nsxfobj")
0127
0128 /*******************************************************************************
0129  *
0130  * FUNCTION:    AcpiGetType
0131  *
0132  * PARAMETERS:  Handle          - Handle of object whose type is desired
0133  *              RetType         - Where the type will be placed
0134  *
0135  * RETURN:      Status
0136  *
0137  * DESCRIPTION: This routine returns the type associatd with a particular handle
0138  *
0139  ******************************************************************************/
0140
0141 ACPI_STATUS
0142 AcpiGetType (
0143     ACPI_HANDLE             Handle,
0144     ACPI_OBJECT_TYPE        *RetType)
0145 {
0146     ACPI_NAMESPACE_NODE     *Node;
0147     ACPI_STATUS             Status;
0148
0149
0150     /* Parameter Validation */
0151
0152     if (!RetType)
0153     {
0154         return (AE_BAD_PARAMETER);
0155     }
0156
0157     /*
0158      * Special case for the predefined Root Node
0159      * (return type ANY)
0160      */
0161     if (Handle == ACPI_ROOT_OBJECT)
0162     {
0163         *RetType = ACPI_TYPE_ANY;
0164         return (AE_OK);
0165     }
0166
0167     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
0168     if (ACPI_FAILURE (Status))
0169     {
0170         return (Status);
0171     }
0172
0173     /* Convert and validate the handle */
0174
0175     Node = AcpiNsMapHandleToNode (Handle);
0176     if (!Node)
0177     {
0178         (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
0179         return (AE_BAD_PARAMETER);
0180     }
0181
0182     *RetType = Node->Type;
0183
0184
0185     Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
0186     return (Status);
0187 }
0188
0189 ACPI_EXPORT_SYMBOL (AcpiGetType)
0190
0191
0192 /*******************************************************************************
0193  *
0194  * FUNCTION:    AcpiGetParent
0195  *
0196  * PARAMETERS:  Handle          - Handle of object whose parent is desired
0197  *              RetHandle       - Where the parent handle will be placed
0198  *
0199  * RETURN:      Status
0200  *
0201  * DESCRIPTION: Returns a handle to the parent of the object represented by
0202  *              Handle.
0203  *
0204  ******************************************************************************/
0205
0206 ACPI_STATUS
0207 AcpiGetParent (
0208     ACPI_HANDLE             Handle,
0209     ACPI_HANDLE             *RetHandle)
0210 {
0211     ACPI_NAMESPACE_NODE     *Node;
0212     ACPI_NAMESPACE_NODE     *ParentNode;
0213     ACPI_STATUS             Status;
0214
0215
0216     if (!RetHandle)
0217     {
0218         return (AE_BAD_PARAMETER);
0219     }
0220
0221     /* Special case for the predefined Root Node (no parent) */
0222
0223     if (Handle == ACPI_ROOT_OBJECT)
0224     {
0225         return (AE_NULL_ENTRY);
0226     }
0227
0228     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
0229     if (ACPI_FAILURE (Status))
0230     {
0231         return (Status);
0232     }
0233
0234     /* Convert and validate the handle */
0235
0236     Node = AcpiNsMapHandleToNode (Handle);
0237     if (!Node)
0238     {
0239         Status = AE_BAD_PARAMETER;
0240         goto UnlockAndExit;
0241     }
0242
0243     /* Get the parent entry */
0244
0245     ParentNode = AcpiNsGetParentNode (Node);
0246     *RetHandle = AcpiNsConvertEntryToHandle (ParentNode);
0247
0248     /* Return exception if parent is null */
0249
0250     if (!ParentNode)
0251     {
0252         Status = AE_NULL_ENTRY;
0253     }
0254
0255
0256 UnlockAndExit:
0257
0258     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
0259     return (Status);
0260 }
0261
0262 ACPI_EXPORT_SYMBOL (AcpiGetParent)
0263
0264
0265 /*******************************************************************************
0266  *
0267  * FUNCTION:    AcpiGetNextObject
0268  *
0269  * PARAMETERS:  Type            - Type of object to be searched for
0270  *              Parent          - Parent object whose children we are getting
0271  *              LastChild       - Previous child that was found.
0272  *                                The NEXT child will be returned
0273  *              RetHandle       - Where handle to the next object is placed
0274  *
0275  * RETURN:      Status
0276  *
0277  * DESCRIPTION: Return the next peer object within the namespace.  If Handle is
0278  *              valid, Scope is ignored.  Otherwise, the first object within
0279  *              Scope is returned.
0280  *
0281  ******************************************************************************/
0282
0283 ACPI_STATUS
0284 AcpiGetNextObject (
0285     ACPI_OBJECT_TYPE        Type,
0286     ACPI_HANDLE             Parent,
0287     ACPI_HANDLE             Child,
0288     ACPI_HANDLE             *RetHandle)
0289 {
0290     ACPI_STATUS             Status;
0291     ACPI_NAMESPACE_NODE     *Node;
0292     ACPI_NAMESPACE_NODE     *ParentNode = NULL;
0293     ACPI_NAMESPACE_NODE     *ChildNode = NULL;
0294
0295
0296     /* Parameter validation */
0297
0298     if (Type > ACPI_TYPE_EXTERNAL_MAX)
0299     {
0300         return (AE_BAD_PARAMETER);
0301     }
0302
0303     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
0304     if (ACPI_FAILURE (Status))
0305     {
0306         return (Status);
0307     }
0308
0309     /* If null handle, use the parent */
0310
0311     if (!Child)
0312     {
0313         /* Start search at the beginning of the specified scope */
0314
0315         ParentNode = AcpiNsMapHandleToNode (Parent);
0316         if (!ParentNode)
0317         {
0318             Status = AE_BAD_PARAMETER;
0319             goto UnlockAndExit;
0320         }
0321     }
0322     else
0323     {
0324         /* Non-null handle, ignore the parent */
0325         /* Convert and validate the handle */
0326
0327         ChildNode = AcpiNsMapHandleToNode (Child);
0328         if (!ChildNode)
0329         {
0330             Status = AE_BAD_PARAMETER;
0331             goto UnlockAndExit;
0332         }
0333     }
0334
0335     /* Internal function does the real work */
0336
0337     Node = AcpiNsGetNextNodeTyped (Type, ParentNode, ChildNode);
0338     if (!Node)
0339     {
0340         Status = AE_NOT_FOUND;
0341         goto UnlockAndExit;
0342     }
0343
0344     if (RetHandle)
0345     {
0346         *RetHandle = AcpiNsConvertEntryToHandle (Node);
0347     }
0348
0349
0350 UnlockAndExit:
0351
0352     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
0353     return (Status);
0354 }
0355
0356 ACPI_EXPORT_SYMBOL (AcpiGetNextObject)
0357