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 - 2018, 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 * Alternatively, you may choose to be licensed under the terms of the 118 * following license: 119 * 120 * Redistribution and use in source and binary forms, with or without 121 * modification, are permitted provided that the following conditions 122 * are met: 123 * 1. Redistributions of source code must retain the above copyright 124 * notice, this list of conditions, and the following disclaimer, 125 * without modification. 126 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 127 * substantially similar to the "NO WARRANTY" disclaimer below 128 * ("Disclaimer") and any redistribution must be conditioned upon 129 * including a substantially similar Disclaimer requirement for further 130 * binary redistribution. 131 * 3. Neither the names of the above-listed copyright holders nor the names 132 * of any contributors may be used to endorse or promote products derived 133 * from this software without specific prior written permission. 134 * 135 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 136 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 137 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 138 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 139 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 140 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 141 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 142 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 143 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 144 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 145 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 146 * 147 * Alternatively, you may choose to be licensed under the terms of the 148 * GNU General Public License ("GPL") version 2 as published by the Free 149 * Software Foundation. 150 * 151 *****************************************************************************/ 152 153 #define EXPORT_ACPI_INTERFACES 154 155 #include "acpi.h" 156 #include "accommon.h" 157 #include "acnamesp.h" 158 159 160 #define _COMPONENT ACPI_NAMESPACE 161 ACPI_MODULE_NAME ("nsxfobj") 162 163 /******************************************************************************* 164 * 165 * FUNCTION: AcpiGetType 166 * 167 * PARAMETERS: Handle - Handle of object whose type is desired 168 * RetType - Where the type will be placed 169 * 170 * RETURN: Status 171 * 172 * DESCRIPTION: This routine returns the type associatd with a particular handle 173 * 174 ******************************************************************************/ 175 176 ACPI_STATUS 177 AcpiGetType ( 178 ACPI_HANDLE Handle, 179 ACPI_OBJECT_TYPE *RetType) 180 { 181 ACPI_NAMESPACE_NODE *Node; 182 ACPI_STATUS Status; 183 184 185 /* Parameter Validation */ 186 187 if (!RetType) 188 { 189 return (AE_BAD_PARAMETER); 190 } 191 192 /* Special case for the predefined Root Node (return type ANY) */ 193 194 if (Handle == ACPI_ROOT_OBJECT) 195 { 196 *RetType = ACPI_TYPE_ANY; 197 return (AE_OK); 198 } 199 200 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 201 if (ACPI_FAILURE (Status)) 202 { 203 return (Status); 204 } 205 206 /* Convert and validate the handle */ 207 208 Node = AcpiNsValidateHandle (Handle); 209 if (!Node) 210 { 211 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 212 return (AE_BAD_PARAMETER); 213 } 214 215 *RetType = Node->Type; 216 217 Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 218 return (Status); 219 } 220 221 ACPI_EXPORT_SYMBOL (AcpiGetType) 222 223 224 /******************************************************************************* 225 * 226 * FUNCTION: AcpiGetParent 227 * 228 * PARAMETERS: Handle - Handle of object whose parent is desired 229 * RetHandle - Where the parent handle will be placed 230 * 231 * RETURN: Status 232 * 233 * DESCRIPTION: Returns a handle to the parent of the object represented by 234 * Handle. 235 * 236 ******************************************************************************/ 237 238 ACPI_STATUS 239 AcpiGetParent ( 240 ACPI_HANDLE Handle, 241 ACPI_HANDLE *RetHandle) 242 { 243 ACPI_NAMESPACE_NODE *Node; 244 ACPI_NAMESPACE_NODE *ParentNode; 245 ACPI_STATUS Status; 246 247 248 if (!RetHandle) 249 { 250 return (AE_BAD_PARAMETER); 251 } 252 253 /* Special case for the predefined Root Node (no parent) */ 254 255 if (Handle == ACPI_ROOT_OBJECT) 256 { 257 return (AE_NULL_ENTRY); 258 } 259 260 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 261 if (ACPI_FAILURE (Status)) 262 { 263 return (Status); 264 } 265 266 /* Convert and validate the handle */ 267 268 Node = AcpiNsValidateHandle (Handle); 269 if (!Node) 270 { 271 Status = AE_BAD_PARAMETER; 272 goto UnlockAndExit; 273 } 274 275 /* Get the parent entry */ 276 277 ParentNode = Node->Parent; 278 *RetHandle = ACPI_CAST_PTR (ACPI_HANDLE, ParentNode); 279 280 /* Return exception if parent is null */ 281 282 if (!ParentNode) 283 { 284 Status = AE_NULL_ENTRY; 285 } 286 287 288 UnlockAndExit: 289 290 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 291 return (Status); 292 } 293 294 ACPI_EXPORT_SYMBOL (AcpiGetParent) 295 296 297 /******************************************************************************* 298 * 299 * FUNCTION: AcpiGetNextObject 300 * 301 * PARAMETERS: Type - Type of object to be searched for 302 * Parent - Parent object whose children we are getting 303 * LastChild - Previous child that was found. 304 * The NEXT child will be returned 305 * RetHandle - Where handle to the next object is placed 306 * 307 * RETURN: Status 308 * 309 * DESCRIPTION: Return the next peer object within the namespace. If Handle is 310 * valid, Scope is ignored. Otherwise, the first object within 311 * Scope is returned. 312 * 313 ******************************************************************************/ 314 315 ACPI_STATUS 316 AcpiGetNextObject ( 317 ACPI_OBJECT_TYPE Type, 318 ACPI_HANDLE Parent, 319 ACPI_HANDLE Child, 320 ACPI_HANDLE *RetHandle) 321 { 322 ACPI_STATUS Status; 323 ACPI_NAMESPACE_NODE *Node; 324 ACPI_NAMESPACE_NODE *ParentNode = NULL; 325 ACPI_NAMESPACE_NODE *ChildNode = NULL; 326 327 328 /* Parameter validation */ 329 330 if (Type > ACPI_TYPE_EXTERNAL_MAX) 331 { 332 return (AE_BAD_PARAMETER); 333 } 334 335 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 336 if (ACPI_FAILURE (Status)) 337 { 338 return (Status); 339 } 340 341 /* If null handle, use the parent */ 342 343 if (!Child) 344 { 345 /* Start search at the beginning of the specified scope */ 346 347 ParentNode = AcpiNsValidateHandle (Parent); 348 if (!ParentNode) 349 { 350 Status = AE_BAD_PARAMETER; 351 goto UnlockAndExit; 352 } 353 } 354 else 355 { 356 /* Non-null handle, ignore the parent */ 357 /* Convert and validate the handle */ 358 359 ChildNode = AcpiNsValidateHandle (Child); 360 if (!ChildNode) 361 { 362 Status = AE_BAD_PARAMETER; 363 goto UnlockAndExit; 364 } 365 } 366 367 /* Internal function does the real work */ 368 369 Node = AcpiNsGetNextNodeTyped (Type, ParentNode, ChildNode); 370 if (!Node) 371 { 372 Status = AE_NOT_FOUND; 373 goto UnlockAndExit; 374 } 375 376 if (RetHandle) 377 { 378 *RetHandle = ACPI_CAST_PTR (ACPI_HANDLE, Node); 379 } 380 381 382 UnlockAndExit: 383 384 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 385 return (Status); 386 } 387 388 ACPI_EXPORT_SYMBOL (AcpiGetNextObject) 389