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