drivers/acpi/namespace/nsxfobj.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: nsxfobj - Public interfaces to the ACPI subsystem
   4  *                         ACPI Object oriented interfaces
   5  *
   6  ******************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2010, 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
 118 #define __NSXFOBJ_C__
 119
 120 #include "acpi.h"
 121 #include "accommon.h"
 122 #include "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
 141 ACPI_STATUS
 142 AcpiGetType (
 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 = AcpiNsValidateHandle (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
 189 ACPI_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
 206 ACPI_STATUS
 207 AcpiGetParent (
 208     ACPI_HANDLE             Handle,
 209     ACPI_HANDLE             *RetHandle)
 210 {
 211     ACPI_NAMESPACE_NODE     *Node;
 212     ACPI_NAMESPACE_NODE     *ParentNode;
 213     ACPI_STATUS             Status;
 214
 215
 216     if (!RetHandle)
 217     {
 218         return (AE_BAD_PARAMETER);
 219     }
 220
 221     /* Special case for the predefined Root Node (no parent) */
 222
 223     if (Handle == ACPI_ROOT_OBJECT)
 224     {
 225         return (AE_NULL_ENTRY);
 226     }
 227
 228     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 229     if (ACPI_FAILURE (Status))
 230     {
 231         return (Status);
 232     }
 233
 234     /* Convert and validate the handle */
 235
 236     Node = AcpiNsValidateHandle (Handle);
 237     if (!Node)
 238     {
 239         Status = AE_BAD_PARAMETER;
 240         goto UnlockAndExit;
 241     }
 242
 243     /* Get the parent entry */
 244
 245     ParentNode = Node->Parent;
 246     *RetHandle = ACPI_CAST_PTR (ACPI_HANDLE, ParentNode);
 247
 248     /* Return exception if parent is null */
 249
 250     if (!ParentNode)
 251     {
 252         Status = AE_NULL_ENTRY;
 253     }
 254
 255
 256 UnlockAndExit:
 257
 258     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 259     return (Status);
 260 }
 261
 262 ACPI_EXPORT_SYMBOL (AcpiGetParent)
 263
 264
 265 /*******************************************************************************
 266  *
 267  * FUNCTION:    AcpiGetNextObject
 268  *
 269  * PARAMETERS:  Type            - Type of object to be searched for
 270  *              Parent          - Parent object whose children we are getting
 271  *              LastChild       - Previous child that was found.
 272  *                                The NEXT child will be returned
 273  *              RetHandle       - Where handle to the next object is placed
 274  *
 275  * RETURN:      Status
 276  *
 277  * DESCRIPTION: Return the next peer object within the namespace.  If Handle is
 278  *              valid, Scope is ignored.  Otherwise, the first object within
 279  *              Scope is returned.
 280  *
 281  ******************************************************************************/
 282
 283 ACPI_STATUS
 284 AcpiGetNextObject (
 285     ACPI_OBJECT_TYPE        Type,
 286     ACPI_HANDLE             Parent,
 287     ACPI_HANDLE             Child,
 288     ACPI_HANDLE             *RetHandle)
 289 {
 290     ACPI_STATUS             Status;
 291     ACPI_NAMESPACE_NODE     *Node;
 292     ACPI_NAMESPACE_NODE     *ParentNode = NULL;
 293     ACPI_NAMESPACE_NODE     *ChildNode = NULL;
 294
 295
 296     /* Parameter validation */
 297
 298     if (Type > ACPI_TYPE_EXTERNAL_MAX)
 299     {
 300         return (AE_BAD_PARAMETER);
 301     }
 302
 303     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 304     if (ACPI_FAILURE (Status))
 305     {
 306         return (Status);
 307     }
 308
 309     /* If null handle, use the parent */
 310
 311     if (!Child)
 312     {
 313         /* Start search at the beginning of the specified scope */
 314
 315         ParentNode = AcpiNsValidateHandle (Parent);
 316         if (!ParentNode)
 317         {
 318             Status = AE_BAD_PARAMETER;
 319             goto UnlockAndExit;
 320         }
 321     }
 322     else
 323     {
 324         /* Non-null handle, ignore the parent */
 325         /* Convert and validate the handle */
 326
 327         ChildNode = AcpiNsValidateHandle (Child);
 328         if (!ChildNode)
 329         {
 330             Status = AE_BAD_PARAMETER;
 331             goto UnlockAndExit;
 332         }
 333     }
 334
 335     /* Internal function does the real work */
 336
 337     Node = AcpiNsGetNextNodeTyped (Type, ParentNode, ChildNode);
 338     if (!Node)
 339     {
 340         Status = AE_NOT_FOUND;
 341         goto UnlockAndExit;
 342     }
 343
 344     if (RetHandle)
 345     {
 346         *RetHandle = ACPI_CAST_PTR (ACPI_HANDLE, Node);
 347     }
 348
 349
 350 UnlockAndExit:
 351
 352     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 353     return (Status);
 354 }
 355
 356 ACPI_EXPORT_SYMBOL (AcpiGetNextObject)
 357