acpica/namespace/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 - 2024, 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  * Alternatively, you may choose to be licensed under the terms of the
0118  * following license:
0119  *
0120  * Redistribution and use in source and binary forms, with or without
0121  * modification, are permitted provided that the following conditions
0122  * are met:
0123  * 1. Redistributions of source code must retain the above copyright
0124  *    notice, this list of conditions, and the following disclaimer,
0125  *    without modification.
0126  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0127  *    substantially similar to the "NO WARRANTY" disclaimer below
0128  *    ("Disclaimer") and any redistribution must be conditioned upon
0129  *    including a substantially similar Disclaimer requirement for further
0130  *    binary redistribution.
0131  * 3. Neither the names of the above-listed copyright holders nor the names
0132  *    of any contributors may be used to endorse or promote products derived
0133  *    from this software without specific prior written permission.
0134  *
0135  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0136  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0137  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0138  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0139  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0140  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0141  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0142  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0143  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0144  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0145  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0146  *
0147  * Alternatively, you may choose to be licensed under the terms of the
0148  * GNU General Public License ("GPL") version 2 as published by the Free
0149  * Software Foundation.
0150  *
0151  *****************************************************************************/
0152
0153 #define EXPORT_ACPI_INTERFACES
0154
0155 #include "acpi.h"
0156 #include "accommon.h"
0157 #include "acnamesp.h"
0158
0159
0160 #define _COMPONENT          ACPI_NAMESPACE
0161         ACPI_MODULE_NAME    ("nsxfobj")
0162
0163 /*******************************************************************************
0164  *
0165  * FUNCTION:    AcpiGetType
0166  *
0167  * PARAMETERS:  Handle          - Handle of object whose type is desired
0168  *              RetType         - Where the type will be placed
0169  *
0170  * RETURN:      Status
0171  *
0172  * DESCRIPTION: This routine returns the type associated with a particular
0173  *              handle
0174  *
0175  ******************************************************************************/
0176
0177 ACPI_STATUS
0178 AcpiGetType (
0179     ACPI_HANDLE             Handle,
0180     ACPI_OBJECT_TYPE        *RetType)
0181 {
0182     ACPI_NAMESPACE_NODE     *Node;
0183     ACPI_STATUS             Status;
0184
0185
0186     /* Parameter Validation */
0187
0188     if (!RetType)
0189     {
0190         return (AE_BAD_PARAMETER);
0191     }
0192
0193     /* Special case for the predefined Root Node (return type ANY) */
0194
0195     if (Handle == ACPI_ROOT_OBJECT)
0196     {
0197         *RetType = ACPI_TYPE_ANY;
0198         return (AE_OK);
0199     }
0200
0201     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
0202     if (ACPI_FAILURE (Status))
0203     {
0204         return (Status);
0205     }
0206
0207     /* Convert and validate the handle */
0208
0209     Node = AcpiNsValidateHandle (Handle);
0210     if (!Node)
0211     {
0212         (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
0213         return (AE_BAD_PARAMETER);
0214     }
0215
0216     *RetType = Node->Type;
0217
0218     Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
0219     return (Status);
0220 }
0221
0222 ACPI_EXPORT_SYMBOL (AcpiGetType)
0223
0224
0225 /*******************************************************************************
0226  *
0227  * FUNCTION:    AcpiGetParent
0228  *
0229  * PARAMETERS:  Handle          - Handle of object whose parent is desired
0230  *              RetHandle       - Where the parent handle will be placed
0231  *
0232  * RETURN:      Status
0233  *
0234  * DESCRIPTION: Returns a handle to the parent of the object represented by
0235  *              Handle.
0236  *
0237  ******************************************************************************/
0238
0239 ACPI_STATUS
0240 AcpiGetParent (
0241     ACPI_HANDLE             Handle,
0242     ACPI_HANDLE             *RetHandle)
0243 {
0244     ACPI_NAMESPACE_NODE     *Node;
0245     ACPI_NAMESPACE_NODE     *ParentNode;
0246     ACPI_STATUS             Status;
0247
0248
0249     if (!RetHandle)
0250     {
0251         return (AE_BAD_PARAMETER);
0252     }
0253
0254     /* Special case for the predefined Root Node (no parent) */
0255
0256     if (Handle == ACPI_ROOT_OBJECT)
0257     {
0258         return (AE_NULL_ENTRY);
0259     }
0260
0261     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
0262     if (ACPI_FAILURE (Status))
0263     {
0264         return (Status);
0265     }
0266
0267     /* Convert and validate the handle */
0268
0269     Node = AcpiNsValidateHandle (Handle);
0270     if (!Node)
0271     {
0272         Status = AE_BAD_PARAMETER;
0273         goto UnlockAndExit;
0274     }
0275
0276     /* Get the parent entry */
0277
0278     ParentNode = Node->Parent;
0279     *RetHandle = ACPI_CAST_PTR (ACPI_HANDLE, ParentNode);
0280
0281     /* Return exception if parent is null */
0282
0283     if (!ParentNode)
0284     {
0285         Status = AE_NULL_ENTRY;
0286     }
0287
0288
0289 UnlockAndExit:
0290
0291     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
0292     return (Status);
0293 }
0294
0295 ACPI_EXPORT_SYMBOL (AcpiGetParent)
0296
0297
0298 /*******************************************************************************
0299  *
0300  * FUNCTION:    AcpiGetNextObject
0301  *
0302  * PARAMETERS:  Type            - Type of object to be searched for
0303  *              Parent          - Parent object whose children we are getting
0304  *              LastChild       - Previous child that was found.
0305  *                                The NEXT child will be returned
0306  *              RetHandle       - Where handle to the next object is placed
0307  *
0308  * RETURN:      Status
0309  *
0310  * DESCRIPTION: Return the next peer object within the namespace. If Handle is
0311  *              valid, Scope is ignored. Otherwise, the first object within
0312  *              Scope is returned.
0313  *
0314  ******************************************************************************/
0315
0316 ACPI_STATUS
0317 AcpiGetNextObject (
0318     ACPI_OBJECT_TYPE        Type,
0319     ACPI_HANDLE             Parent,
0320     ACPI_HANDLE             Child,
0321     ACPI_HANDLE             *RetHandle)
0322 {
0323     ACPI_STATUS             Status;
0324     ACPI_NAMESPACE_NODE     *Node;
0325     ACPI_NAMESPACE_NODE     *ParentNode = NULL;
0326     ACPI_NAMESPACE_NODE     *ChildNode = NULL;
0327
0328
0329     /* Parameter validation */
0330
0331     if (Type > ACPI_TYPE_EXTERNAL_MAX)
0332     {
0333         return (AE_BAD_PARAMETER);
0334     }
0335
0336     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
0337     if (ACPI_FAILURE (Status))
0338     {
0339         return (Status);
0340     }
0341
0342     /* If null handle, use the parent */
0343
0344     if (!Child)
0345     {
0346         /* Start search at the beginning of the specified scope */
0347
0348         ParentNode = AcpiNsValidateHandle (Parent);
0349         if (!ParentNode)
0350         {
0351             Status = AE_BAD_PARAMETER;
0352             goto UnlockAndExit;
0353         }
0354     }
0355     else
0356     {
0357         /* Non-null handle, ignore the parent */
0358         /* Convert and validate the handle */
0359
0360         ChildNode = AcpiNsValidateHandle (Child);
0361         if (!ChildNode)
0362         {
0363             Status = AE_BAD_PARAMETER;
0364             goto UnlockAndExit;
0365         }
0366     }
0367
0368     /* Internal function does the real work */
0369
0370     Node = AcpiNsGetNextNodeTyped (Type, ParentNode, ChildNode);
0371     if (!Node)
0372     {
0373         Status = AE_NOT_FOUND;
0374         goto UnlockAndExit;
0375     }
0376
0377     if (RetHandle)
0378     {
0379         *RetHandle = ACPI_CAST_PTR (ACPI_HANDLE, Node);
0380     }
0381
0382
0383 UnlockAndExit:
0384
0385     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
0386     return (Status);
0387 }
0388
0389 ACPI_EXPORT_SYMBOL (AcpiGetNextObject)