nsxfobj.c revision 107325
167754Smsmith/******************************************************************************* 267754Smsmith * 367754Smsmith * Module Name: nsxfobj - Public interfaces to the ACPI subsystem 467754Smsmith * ACPI Object oriented interfaces 5107325Siwasaki * $Revision: 114 $ 667754Smsmith * 767754Smsmith ******************************************************************************/ 867754Smsmith 967754Smsmith/****************************************************************************** 1067754Smsmith * 1167754Smsmith * 1. Copyright Notice 1267754Smsmith * 1391116Smsmith * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp. 1470243Smsmith * All rights reserved. 1567754Smsmith * 1667754Smsmith * 2. License 1767754Smsmith * 1867754Smsmith * 2.1. This is your license from Intel Corp. under its intellectual property 1967754Smsmith * rights. You may have additional license terms from the party that provided 2067754Smsmith * you this software, covering your right to use that party's intellectual 2167754Smsmith * property rights. 2267754Smsmith * 2367754Smsmith * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 2467754Smsmith * copy of the source code appearing in this file ("Covered Code") an 2567754Smsmith * irrevocable, perpetual, worldwide license under Intel's copyrights in the 2667754Smsmith * base code distributed originally by Intel ("Original Intel Code") to copy, 2767754Smsmith * make derivatives, distribute, use and display any portion of the Covered 2867754Smsmith * Code in any form, with the right to sublicense such rights; and 2967754Smsmith * 3067754Smsmith * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 3167754Smsmith * license (with the right to sublicense), under only those claims of Intel 3267754Smsmith * patents that are infringed by the Original Intel Code, to make, use, sell, 3367754Smsmith * offer to sell, and import the Covered Code and derivative works thereof 3467754Smsmith * solely to the minimum extent necessary to exercise the above copyright 3567754Smsmith * license, and in no event shall the patent license extend to any additions 3667754Smsmith * to or modifications of the Original Intel Code. No other license or right 3767754Smsmith * is granted directly or by implication, estoppel or otherwise; 3867754Smsmith * 3967754Smsmith * The above copyright and patent license is granted only if the following 4067754Smsmith * conditions are met: 4167754Smsmith * 4267754Smsmith * 3. Conditions 4367754Smsmith * 4467754Smsmith * 3.1. Redistribution of Source with Rights to Further Distribute Source. 4567754Smsmith * Redistribution of source code of any substantial portion of the Covered 4667754Smsmith * Code or modification with rights to further distribute source must include 4767754Smsmith * the above Copyright Notice, the above License, this list of Conditions, 4867754Smsmith * and the following Disclaimer and Export Compliance provision. In addition, 4967754Smsmith * Licensee must cause all Covered Code to which Licensee contributes to 5067754Smsmith * contain a file documenting the changes Licensee made to create that Covered 5167754Smsmith * Code and the date of any change. Licensee must include in that file the 5267754Smsmith * documentation of any changes made by any predecessor Licensee. Licensee 5367754Smsmith * must include a prominent statement that the modification is derived, 5467754Smsmith * directly or indirectly, from Original Intel Code. 5567754Smsmith * 5667754Smsmith * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 5767754Smsmith * Redistribution of source code of any substantial portion of the Covered 5867754Smsmith * Code or modification without rights to further distribute source must 5967754Smsmith * include the following Disclaimer and Export Compliance provision in the 6067754Smsmith * documentation and/or other materials provided with distribution. In 6167754Smsmith * addition, Licensee may not authorize further sublicense of source of any 6267754Smsmith * portion of the Covered Code, and must include terms to the effect that the 6367754Smsmith * license from Licensee to its licensee is limited to the intellectual 6467754Smsmith * property embodied in the software Licensee provides to its licensee, and 6567754Smsmith * not to intellectual property embodied in modifications its licensee may 6667754Smsmith * make. 6767754Smsmith * 6867754Smsmith * 3.3. Redistribution of Executable. Redistribution in executable form of any 6967754Smsmith * substantial portion of the Covered Code or modification must reproduce the 7067754Smsmith * above Copyright Notice, and the following Disclaimer and Export Compliance 7167754Smsmith * provision in the documentation and/or other materials provided with the 7267754Smsmith * distribution. 7367754Smsmith * 7467754Smsmith * 3.4. Intel retains all right, title, and interest in and to the Original 7567754Smsmith * Intel Code. 7667754Smsmith * 7767754Smsmith * 3.5. Neither the name Intel nor any other trademark owned or controlled by 7867754Smsmith * Intel shall be used in advertising or otherwise to promote the sale, use or 7967754Smsmith * other dealings in products derived from or relating to the Covered Code 8067754Smsmith * without prior written authorization from Intel. 8167754Smsmith * 8267754Smsmith * 4. Disclaimer and Export Compliance 8367754Smsmith * 8467754Smsmith * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 8567754Smsmith * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 8667754Smsmith * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 8767754Smsmith * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 8867754Smsmith * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 8967754Smsmith * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 9067754Smsmith * PARTICULAR PURPOSE. 9167754Smsmith * 9267754Smsmith * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 9367754Smsmith * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 9467754Smsmith * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 9567754Smsmith * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 9667754Smsmith * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 9767754Smsmith * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 9867754Smsmith * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 9967754Smsmith * LIMITED REMEDY. 10067754Smsmith * 10167754Smsmith * 4.3. Licensee shall not export, either directly or indirectly, any of this 10267754Smsmith * software or system incorporating such software without first obtaining any 10367754Smsmith * required license or other approval from the U. S. Department of Commerce or 10467754Smsmith * any other agency or department of the United States Government. In the 10567754Smsmith * event Licensee exports any such software from the United States or 10667754Smsmith * re-exports any such software from a foreign destination, Licensee shall 10767754Smsmith * ensure that the distribution and export/re-export of the software is in 10867754Smsmith * compliance with all laws, regulations, orders, or other restrictions of the 10967754Smsmith * U.S. Export Administration Regulations. Licensee agrees that neither it nor 11067754Smsmith * any of its subsidiaries will export/re-export any technical data, process, 11167754Smsmith * software, or service, directly or indirectly, to any country for which the 11267754Smsmith * United States government or any agency thereof requires an export license, 11367754Smsmith * other governmental approval, or letter of assurance, without first obtaining 11467754Smsmith * such license, approval or letter. 11567754Smsmith * 11667754Smsmith *****************************************************************************/ 11767754Smsmith 11867754Smsmith 11967754Smsmith#define __NSXFOBJ_C__ 12067754Smsmith 12167754Smsmith#include "acpi.h" 12267754Smsmith#include "acnamesp.h" 12367754Smsmith 12467754Smsmith 12577424Smsmith#define _COMPONENT ACPI_NAMESPACE 12691116Smsmith ACPI_MODULE_NAME ("nsxfobj") 12767754Smsmith 12867754Smsmith/******************************************************************************* 12967754Smsmith * 13067754Smsmith * FUNCTION: AcpiGetType 13167754Smsmith * 13267754Smsmith * PARAMETERS: Handle - Handle of object whose type is desired 13367754Smsmith * *RetType - Where the type will be placed 13467754Smsmith * 13567754Smsmith * RETURN: Status 13667754Smsmith * 13767754Smsmith * DESCRIPTION: This routine returns the type associatd with a particular handle 13867754Smsmith * 13967754Smsmith ******************************************************************************/ 14067754Smsmith 14167754SmsmithACPI_STATUS 14267754SmsmithAcpiGetType ( 14367754Smsmith ACPI_HANDLE Handle, 14467754Smsmith ACPI_OBJECT_TYPE *RetType) 14567754Smsmith{ 14667754Smsmith ACPI_NAMESPACE_NODE *Node; 14791116Smsmith ACPI_STATUS Status; 14867754Smsmith 14967754Smsmith 15067754Smsmith /* Parameter Validation */ 15167754Smsmith 15267754Smsmith if (!RetType) 15367754Smsmith { 15467754Smsmith return (AE_BAD_PARAMETER); 15567754Smsmith } 15667754Smsmith 15767754Smsmith /* 15867754Smsmith * Special case for the predefined Root Node 15967754Smsmith * (return type ANY) 16067754Smsmith */ 16167754Smsmith if (Handle == ACPI_ROOT_OBJECT) 16267754Smsmith { 16367754Smsmith *RetType = ACPI_TYPE_ANY; 16467754Smsmith return (AE_OK); 16567754Smsmith } 16667754Smsmith 16791116Smsmith Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 16891116Smsmith if (ACPI_FAILURE (Status)) 16991116Smsmith { 17091116Smsmith return (Status); 17191116Smsmith } 17267754Smsmith 17367754Smsmith /* Convert and validate the handle */ 17467754Smsmith 17585756Smsmith Node = AcpiNsMapHandleToNode (Handle); 17667754Smsmith if (!Node) 17767754Smsmith { 17891116Smsmith (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 17967754Smsmith return (AE_BAD_PARAMETER); 18067754Smsmith } 18167754Smsmith 18267754Smsmith *RetType = Node->Type; 18367754Smsmith 18467754Smsmith 18591116Smsmith Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 18691116Smsmith return (Status); 18767754Smsmith} 18867754Smsmith 18967754Smsmith 19067754Smsmith/******************************************************************************* 19167754Smsmith * 19267754Smsmith * FUNCTION: AcpiGetParent 19367754Smsmith * 19467754Smsmith * PARAMETERS: Handle - Handle of object whose parent is desired 19567754Smsmith * RetHandle - Where the parent handle will be placed 19667754Smsmith * 19767754Smsmith * RETURN: Status 19867754Smsmith * 19967754Smsmith * DESCRIPTION: Returns a handle to the parent of the object represented by 20067754Smsmith * Handle. 20167754Smsmith * 20267754Smsmith ******************************************************************************/ 20367754Smsmith 20467754SmsmithACPI_STATUS 20567754SmsmithAcpiGetParent ( 20667754Smsmith ACPI_HANDLE Handle, 20767754Smsmith ACPI_HANDLE *RetHandle) 20867754Smsmith{ 20967754Smsmith ACPI_NAMESPACE_NODE *Node; 21091116Smsmith ACPI_STATUS Status; 21167754Smsmith 21267754Smsmith 21367754Smsmith if (!RetHandle) 21467754Smsmith { 21567754Smsmith return (AE_BAD_PARAMETER); 21667754Smsmith } 21767754Smsmith 21867754Smsmith /* Special case for the predefined Root Node (no parent) */ 21967754Smsmith 22067754Smsmith if (Handle == ACPI_ROOT_OBJECT) 22167754Smsmith { 22267754Smsmith return (AE_NULL_ENTRY); 22367754Smsmith } 22467754Smsmith 22591116Smsmith Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 22691116Smsmith if (ACPI_FAILURE (Status)) 22791116Smsmith { 22891116Smsmith return (Status); 22991116Smsmith } 23067754Smsmith 23167754Smsmith /* Convert and validate the handle */ 23267754Smsmith 23385756Smsmith Node = AcpiNsMapHandleToNode (Handle); 23467754Smsmith if (!Node) 23567754Smsmith { 23667754Smsmith Status = AE_BAD_PARAMETER; 23767754Smsmith goto UnlockAndExit; 23867754Smsmith } 23967754Smsmith 24067754Smsmith /* Get the parent entry */ 24167754Smsmith 24267754Smsmith *RetHandle = 24391116Smsmith AcpiNsConvertEntryToHandle (AcpiNsGetParentNode (Node)); 24467754Smsmith 24567754Smsmith /* Return exeption if parent is null */ 24667754Smsmith 24791116Smsmith if (!AcpiNsGetParentNode (Node)) 24867754Smsmith { 24967754Smsmith Status = AE_NULL_ENTRY; 25067754Smsmith } 25167754Smsmith 25267754Smsmith 25367754SmsmithUnlockAndExit: 25467754Smsmith 25591116Smsmith (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 25667754Smsmith return (Status); 25767754Smsmith} 25867754Smsmith 25967754Smsmith 26067754Smsmith/******************************************************************************* 26167754Smsmith * 262100966Siwasaki * FUNCTION: AcpiGetNextObject 26367754Smsmith * 264100966Siwasaki * PARAMETERS: Type - Type of object to be searched for 265100966Siwasaki * Parent - Parent object whose children we are getting 266100966Siwasaki * LastChild - Previous child that was found. 267100966Siwasaki * The NEXT child will be returned 268100966Siwasaki * RetHandle - Where handle to the next object is placed 26967754Smsmith * 270100966Siwasaki * RETURN: Status 27167754Smsmith * 272100966Siwasaki * DESCRIPTION: Return the next peer object within the namespace. If Handle is 273100966Siwasaki * valid, Scope is ignored. Otherwise, the first object within 274100966Siwasaki * Scope is returned. 27567754Smsmith * 27667754Smsmith ******************************************************************************/ 27767754Smsmith 27867754SmsmithACPI_STATUS 279100966SiwasakiAcpiGetNextObject ( 28067754Smsmith ACPI_OBJECT_TYPE Type, 281100966Siwasaki ACPI_HANDLE Parent, 282100966Siwasaki ACPI_HANDLE Child, 283100966Siwasaki ACPI_HANDLE *RetHandle) 28467754Smsmith{ 28567754Smsmith ACPI_STATUS Status; 286100966Siwasaki ACPI_NAMESPACE_NODE *Node; 287100966Siwasaki ACPI_NAMESPACE_NODE *ParentNode = NULL; 288100966Siwasaki ACPI_NAMESPACE_NODE *ChildNode = NULL; 28967754Smsmith 29067754Smsmith 29167754Smsmith /* Parameter validation */ 29267754Smsmith 293107325Siwasaki if (Type > ACPI_TYPE_EXTERNAL_MAX) 29467754Smsmith { 295100966Siwasaki return (AE_BAD_PARAMETER); 29667754Smsmith } 29767754Smsmith 29891116Smsmith Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 29991116Smsmith if (ACPI_FAILURE (Status)) 30091116Smsmith { 30191116Smsmith return (Status); 30291116Smsmith } 30391116Smsmith 304100966Siwasaki /* If null handle, use the parent */ 30573561Smsmith 306100966Siwasaki if (!Child) 30767754Smsmith { 308100966Siwasaki /* Start search at the beginning of the specified scope */ 30967754Smsmith 310100966Siwasaki ParentNode = AcpiNsMapHandleToNode (Parent); 311100966Siwasaki if (!ParentNode) 312100966Siwasaki { 313100966Siwasaki Status = AE_BAD_PARAMETER; 314100966Siwasaki goto UnlockAndExit; 315100966Siwasaki } 31667754Smsmith } 317100966Siwasaki else 31867754Smsmith { 319100966Siwasaki /* Non-null handle, ignore the parent */ 320100966Siwasaki /* Convert and validate the handle */ 32167754Smsmith 322100966Siwasaki ChildNode = AcpiNsMapHandleToNode (Child); 323100966Siwasaki if (!ChildNode) 32467754Smsmith { 325100966Siwasaki Status = AE_BAD_PARAMETER; 326100966Siwasaki goto UnlockAndExit; 32767754Smsmith } 32867754Smsmith } 32967754Smsmith 330100966Siwasaki /* Internal function does the real work */ 33167754Smsmith 332100966Siwasaki Node = AcpiNsGetNextNode (Type, ParentNode, ChildNode); 33387031Smsmith if (!Node) 33487031Smsmith { 335100966Siwasaki Status = AE_NOT_FOUND; 33687031Smsmith goto UnlockAndExit; 33787031Smsmith } 33887031Smsmith 339100966Siwasaki if (RetHandle) 34087031Smsmith { 341100966Siwasaki *RetHandle = AcpiNsConvertEntryToHandle (Node); 34287031Smsmith } 34387031Smsmith 34487031Smsmith 34587031SmsmithUnlockAndExit: 34687031Smsmith 34791116Smsmith (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 34887031Smsmith return (Status); 34987031Smsmith} 35087031Smsmith 35187031Smsmith 352