reactos/drivers/bus/acpi/acpica/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 - 2015, 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 #define EXPORT_ACPI_INTERFACES
 118
 119 #include "acpi.h"
 120 #include "accommon.h"
 121 #include "acnamesp.h"
 122
 123
 124 #define _COMPONENT          ACPI_NAMESPACE
 125         ACPI_MODULE_NAME    ("nsxfobj")
 126
 127 /*******************************************************************************
 128  *
 129  * FUNCTION:    AcpiGetType
 130  *
 131  * PARAMETERS:  Handle          - Handle of object whose type is desired
 132  *              RetType         - Where the type will be placed
 133  *
 134  * RETURN:      Status
 135  *
 136  * DESCRIPTION: This routine returns the type associatd with a particular handle
 137  *
 138  ******************************************************************************/
 139
 140 ACPI_STATUS
 141 AcpiGetType (
 142     ACPI_HANDLE             Handle,
 143     ACPI_OBJECT_TYPE        *RetType)
 144 {
 145     ACPI_NAMESPACE_NODE     *Node;
 146     ACPI_STATUS             Status;
 147
 148
 149     /* Parameter Validation */
 150
 151     if (!RetType)
 152     {
 153         return (AE_BAD_PARAMETER);
 154     }
 155
 156     /* Special case for the predefined Root Node (return type ANY) */
 157
 158     if (Handle == ACPI_ROOT_OBJECT)
 159     {
 160         *RetType = ACPI_TYPE_ANY;
 161         return (AE_OK);
 162     }
 163
 164     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 165     if (ACPI_FAILURE (Status))
 166     {
 167         return (Status);
 168     }
 169
 170     /* Convert and validate the handle */
 171
 172     Node = AcpiNsValidateHandle (Handle);
 173     if (!Node)
 174     {
 175         (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 176         return (AE_BAD_PARAMETER);
 177     }
 178
 179     *RetType = Node->Type;
 180
 181     Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 182     return (Status);
 183 }
 184
 185 ACPI_EXPORT_SYMBOL (AcpiGetType)
 186
 187
 188 /*******************************************************************************
 189  *
 190  * FUNCTION:    AcpiGetParent
 191  *
 192  * PARAMETERS:  Handle          - Handle of object whose parent is desired
 193  *              RetHandle       - Where the parent handle will be placed
 194  *
 195  * RETURN:      Status
 196  *
 197  * DESCRIPTION: Returns a handle to the parent of the object represented by
 198  *              Handle.
 199  *
 200  ******************************************************************************/
 201
 202 ACPI_STATUS
 203 AcpiGetParent (
 204     ACPI_HANDLE             Handle,
 205     ACPI_HANDLE             *RetHandle)
 206 {
 207     ACPI_NAMESPACE_NODE     *Node;
 208     ACPI_NAMESPACE_NODE     *ParentNode;
 209     ACPI_STATUS             Status;
 210
 211
 212     if (!RetHandle)
 213     {
 214         return (AE_BAD_PARAMETER);
 215     }
 216
 217     /* Special case for the predefined Root Node (no parent) */
 218
 219     if (Handle == ACPI_ROOT_OBJECT)
 220     {
 221         return (AE_NULL_ENTRY);
 222     }
 223
 224     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 225     if (ACPI_FAILURE (Status))
 226     {
 227         return (Status);
 228     }
 229
 230     /* Convert and validate the handle */
 231
 232     Node = AcpiNsValidateHandle (Handle);
 233     if (!Node)
 234     {
 235         Status = AE_BAD_PARAMETER;
 236         goto UnlockAndExit;
 237     }
 238
 239     /* Get the parent entry */
 240
 241     ParentNode = Node->Parent;
 242     *RetHandle = ACPI_CAST_PTR (ACPI_HANDLE, ParentNode);
 243
 244     /* Return exception if parent is null */
 245
 246     if (!ParentNode)
 247     {
 248         Status = AE_NULL_ENTRY;
 249     }
 250
 251
 252 UnlockAndExit:
 253
 254     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 255     return (Status);
 256 }
 257
 258 ACPI_EXPORT_SYMBOL (AcpiGetParent)
 259
 260
 261 /*******************************************************************************
 262  *
 263  * FUNCTION:    AcpiGetNextObject
 264  *
 265  * PARAMETERS:  Type            - Type of object to be searched for
 266  *              Parent          - Parent object whose children we are getting
 267  *              LastChild       - Previous child that was found.
 268  *                                The NEXT child will be returned
 269  *              RetHandle       - Where handle to the next object is placed
 270  *
 271  * RETURN:      Status
 272  *
 273  * DESCRIPTION: Return the next peer object within the namespace. If Handle is
 274  *              valid, Scope is ignored. Otherwise, the first object within
 275  *              Scope is returned.
 276  *
 277  ******************************************************************************/
 278
 279 ACPI_STATUS
 280 AcpiGetNextObject (
 281     ACPI_OBJECT_TYPE        Type,
 282     ACPI_HANDLE             Parent,
 283     ACPI_HANDLE             Child,
 284     ACPI_HANDLE             *RetHandle)
 285 {
 286     ACPI_STATUS             Status;
 287     ACPI_NAMESPACE_NODE     *Node;
 288     ACPI_NAMESPACE_NODE     *ParentNode = NULL;
 289     ACPI_NAMESPACE_NODE     *ChildNode = NULL;
 290
 291
 292     /* Parameter validation */
 293
 294     if (Type > ACPI_TYPE_EXTERNAL_MAX)
 295     {
 296         return (AE_BAD_PARAMETER);
 297     }
 298
 299     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 300     if (ACPI_FAILURE (Status))
 301     {
 302         return (Status);
 303     }
 304
 305     /* If null handle, use the parent */
 306
 307     if (!Child)
 308     {
 309         /* Start search at the beginning of the specified scope */
 310
 311         ParentNode = AcpiNsValidateHandle (Parent);
 312         if (!ParentNode)
 313         {
 314             Status = AE_BAD_PARAMETER;
 315             goto UnlockAndExit;
 316         }
 317     }
 318     else
 319     {
 320         /* Non-null handle, ignore the parent */
 321         /* Convert and validate the handle */
 322
 323         ChildNode = AcpiNsValidateHandle (Child);
 324         if (!ChildNode)
 325         {
 326             Status = AE_BAD_PARAMETER;
 327             goto UnlockAndExit;
 328         }
 329     }
 330
 331     /* Internal function does the real work */
 332
 333     Node = AcpiNsGetNextNodeTyped (Type, ParentNode, ChildNode);
 334     if (!Node)
 335     {
 336         Status = AE_NOT_FOUND;
 337         goto UnlockAndExit;
 338     }
 339
 340     if (RetHandle)
 341     {
 342         *RetHandle = ACPI_CAST_PTR (ACPI_HANDLE, Node);
 343     }
 344
 345
 346 UnlockAndExit:
 347
 348     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 349     return (Status);
 350 }
 351
 352 ACPI_EXPORT_SYMBOL (AcpiGetNextObject)