1 /****************************************************************************** 2 * 3 * Module Name: nsxfname - Public interfaces to the ACPI subsystem 4 * ACPI Namespace oriented interfaces 5 * $Revision: 1.110 $ 6 * 7 *****************************************************************************/ 8 9 /****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp. 14 * All rights reserved. 15 * 16 * 2. License 17 * 18 * 2.1. This is your license from Intel Corp. under its intellectual property 19 * rights. You may have additional license terms from the party that provided 20 * you this software, covering your right to use that party's intellectual 21 * property rights. 22 * 23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 24 * copy of the source code appearing in this file ("Covered Code") an 25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 26 * base code distributed originally by Intel ("Original Intel Code") to copy, 27 * make derivatives, distribute, use and display any portion of the Covered 28 * Code in any form, with the right to sublicense such rights; and 29 * 30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 31 * license (with the right to sublicense), under only those claims of Intel 32 * patents that are infringed by the Original Intel Code, to make, use, sell, 33 * offer to sell, and import the Covered Code and derivative works thereof 34 * solely to the minimum extent necessary to exercise the above copyright 35 * license, and in no event shall the patent license extend to any additions 36 * to or modifications of the Original Intel Code. No other license or right 37 * is granted directly or by implication, estoppel or otherwise; 38 * 39 * The above copyright and patent license is granted only if the following 40 * conditions are met: 41 * 42 * 3. Conditions 43 * 44 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 45 * Redistribution of source code of any substantial portion of the Covered 46 * Code or modification with rights to further distribute source must include 47 * the above Copyright Notice, the above License, this list of Conditions, 48 * and the following Disclaimer and Export Compliance provision. In addition, 49 * Licensee must cause all Covered Code to which Licensee contributes to 50 * contain a file documenting the changes Licensee made to create that Covered 51 * Code and the date of any change. Licensee must include in that file the 52 * documentation of any changes made by any predecessor Licensee. Licensee 53 * must include a prominent statement that the modification is derived, 54 * directly or indirectly, from Original Intel Code. 55 * 56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 57 * Redistribution of source code of any substantial portion of the Covered 58 * Code or modification without rights to further distribute source must 59 * include the following Disclaimer and Export Compliance provision in the 60 * documentation and/or other materials provided with distribution. In 61 * addition, Licensee may not authorize further sublicense of source of any 62 * portion of the Covered Code, and must include terms to the effect that the 63 * license from Licensee to its licensee is limited to the intellectual 64 * property embodied in the software Licensee provides to its licensee, and 65 * not to intellectual property embodied in modifications its licensee may 66 * make. 67 * 68 * 3.3. Redistribution of Executable. Redistribution in executable form of any 69 * substantial portion of the Covered Code or modification must reproduce the 70 * above Copyright Notice, and the following Disclaimer and Export Compliance 71 * provision in the documentation and/or other materials provided with the 72 * distribution. 73 * 74 * 3.4. Intel retains all right, title, and interest in and to the Original 75 * Intel Code. 76 * 77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 78 * Intel shall be used in advertising or otherwise to promote the sale, use or 79 * other dealings in products derived from or relating to the Covered Code 80 * without prior written authorization from Intel. 81 * 82 * 4. Disclaimer and Export Compliance 83 * 84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 90 * PARTICULAR PURPOSE. 91 * 92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 99 * LIMITED REMEDY. 100 * 101 * 4.3. Licensee shall not export, either directly or indirectly, any of this 102 * software or system incorporating such software without first obtaining any 103 * required license or other approval from the U. S. Department of Commerce or 104 * any other agency or department of the United States Government. In the 105 * event Licensee exports any such software from the United States or 106 * re-exports any such software from a foreign destination, Licensee shall 107 * ensure that the distribution and export/re-export of the software is in 108 * compliance with all laws, regulations, orders, or other restrictions of the 109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 110 * any of its subsidiaries will export/re-export any technical data, process, 111 * software, or service, directly or indirectly, to any country for which the 112 * United States government or any agency thereof requires an export license, 113 * other governmental approval, or letter of assurance, without first obtaining 114 * such license, approval or letter. 115 * 116 *****************************************************************************/ 117 118 #define __NSXFNAME_C__ 119 120 #include "acpi.h" 121 #include "acnamesp.h" 122 123 124 #define _COMPONENT ACPI_NAMESPACE 125 ACPI_MODULE_NAME ("nsxfname") 126 127 128 /****************************************************************************** 129 * 130 * FUNCTION: AcpiGetHandle 131 * 132 * PARAMETERS: Parent - Object to search under (search scope). 133 * Pathname - Pointer to an asciiz string containing the 134 * name 135 * RetHandle - Where the return handle is returned 136 * 137 * RETURN: Status 138 * 139 * DESCRIPTION: This routine will search for a caller specified name in the 140 * name space. The caller can restrict the search region by 141 * specifying a non NULL parent. The parent value is itself a 142 * namespace handle. 143 * 144 ******************************************************************************/ 145 146 ACPI_STATUS 147 AcpiGetHandle ( 148 ACPI_HANDLE Parent, 149 ACPI_STRING Pathname, 150 ACPI_HANDLE *RetHandle) 151 { 152 ACPI_STATUS Status; 153 ACPI_NAMESPACE_NODE *Node = NULL; 154 ACPI_NAMESPACE_NODE *PrefixNode = NULL; 155 156 157 ACPI_FUNCTION_ENTRY (); 158 159 160 /* Parameter Validation */ 161 162 if (!RetHandle || !Pathname) 163 { 164 return (AE_BAD_PARAMETER); 165 } 166 167 /* Convert a parent handle to a prefix node */ 168 169 if (Parent) 170 { 171 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 172 if (ACPI_FAILURE (Status)) 173 { 174 return (Status); 175 } 176 177 PrefixNode = AcpiNsMapHandleToNode (Parent); 178 if (!PrefixNode) 179 { 180 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 181 return (AE_BAD_PARAMETER); 182 } 183 184 Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 185 if (ACPI_FAILURE (Status)) 186 { 187 return (Status); 188 } 189 } 190 191 /* Special case for root, since we can't search for it */ 192 193 if (ACPI_STRCMP (Pathname, ACPI_NS_ROOT_PATH) == 0) 194 { 195 *RetHandle = AcpiNsConvertEntryToHandle (AcpiGbl_RootNode); 196 return (AE_OK); 197 } 198 199 /* 200 * Find the Node and convert to a handle 201 */ 202 Status = AcpiNsGetNode (PrefixNode, Pathname, ACPI_NS_NO_UPSEARCH, 203 &Node); 204 205 *RetHandle = NULL; 206 if (ACPI_SUCCESS (Status)) 207 { 208 *RetHandle = AcpiNsConvertEntryToHandle (Node); 209 } 210 211 return (Status); 212 } 213 214 ACPI_EXPORT_SYMBOL (AcpiGetHandle) 215 216 217 /****************************************************************************** 218 * 219 * FUNCTION: AcpiGetName 220 * 221 * PARAMETERS: Handle - Handle to be converted to a pathname 222 * NameType - Full pathname or single segment 223 * Buffer - Buffer for returned path 224 * 225 * RETURN: Pointer to a string containing the fully qualified Name. 226 * 227 * DESCRIPTION: This routine returns the fully qualified name associated with 228 * the Handle parameter. This and the AcpiPathnameToHandle are 229 * complementary functions. 230 * 231 ******************************************************************************/ 232 233 ACPI_STATUS 234 AcpiGetName ( 235 ACPI_HANDLE Handle, 236 UINT32 NameType, 237 ACPI_BUFFER *Buffer) 238 { 239 ACPI_STATUS Status; 240 ACPI_NAMESPACE_NODE *Node; 241 242 243 /* Parameter validation */ 244 245 if (NameType > ACPI_NAME_TYPE_MAX) 246 { 247 return (AE_BAD_PARAMETER); 248 } 249 250 Status = AcpiUtValidateBuffer (Buffer); 251 if (ACPI_FAILURE (Status)) 252 { 253 return (Status); 254 } 255 256 if (NameType == ACPI_FULL_PATHNAME) 257 { 258 /* Get the full pathname (From the namespace root) */ 259 260 Status = AcpiNsHandleToPathname (Handle, Buffer); 261 return (Status); 262 } 263 264 /* 265 * Wants the single segment ACPI name. 266 * Validate handle and convert to a namespace Node 267 */ 268 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 269 if (ACPI_FAILURE (Status)) 270 { 271 return (Status); 272 } 273 274 Node = AcpiNsMapHandleToNode (Handle); 275 if (!Node) 276 { 277 Status = AE_BAD_PARAMETER; 278 goto UnlockAndExit; 279 } 280 281 /* Validate/Allocate/Clear caller buffer */ 282 283 Status = AcpiUtInitializeBuffer (Buffer, ACPI_PATH_SEGMENT_LENGTH); 284 if (ACPI_FAILURE (Status)) 285 { 286 goto UnlockAndExit; 287 } 288 289 /* Just copy the ACPI name from the Node and zero terminate it */ 290 291 ACPI_STRNCPY (Buffer->Pointer, AcpiUtGetNodeName (Node), 292 ACPI_NAME_SIZE); 293 ((char *) Buffer->Pointer) [ACPI_NAME_SIZE] = 0; 294 Status = AE_OK; 295 296 297 UnlockAndExit: 298 299 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 300 return (Status); 301 } 302 303 ACPI_EXPORT_SYMBOL (AcpiGetName) 304 305 306 /****************************************************************************** 307 * 308 * FUNCTION: AcpiGetObjectInfo 309 * 310 * PARAMETERS: Handle - Object Handle 311 * Buffer - Where the info is returned 312 * 313 * RETURN: Status 314 * 315 * DESCRIPTION: Returns information about an object as gleaned from the 316 * namespace node and possibly by running several standard 317 * control methods (Such as in the case of a device.) 318 * 319 ******************************************************************************/ 320 321 ACPI_STATUS 322 AcpiGetObjectInfo ( 323 ACPI_HANDLE Handle, 324 ACPI_BUFFER *Buffer) 325 { 326 ACPI_STATUS Status; 327 ACPI_NAMESPACE_NODE *Node; 328 ACPI_DEVICE_INFO *Info; 329 ACPI_DEVICE_INFO *ReturnInfo; 330 ACPI_COMPATIBLE_ID_LIST *CidList = NULL; 331 ACPI_SIZE Size; 332 333 334 /* Parameter validation */ 335 336 if (!Handle || !Buffer) 337 { 338 return (AE_BAD_PARAMETER); 339 } 340 341 Status = AcpiUtValidateBuffer (Buffer); 342 if (ACPI_FAILURE (Status)) 343 { 344 return (Status); 345 } 346 347 Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_DEVICE_INFO)); 348 if (!Info) 349 { 350 return (AE_NO_MEMORY); 351 } 352 353 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 354 if (ACPI_FAILURE (Status)) 355 { 356 goto Cleanup; 357 } 358 359 Node = AcpiNsMapHandleToNode (Handle); 360 if (!Node) 361 { 362 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 363 goto Cleanup; 364 } 365 366 /* Init return structure */ 367 368 Size = sizeof (ACPI_DEVICE_INFO); 369 370 Info->Type = Node->Type; 371 Info->Name = Node->Name.Integer; 372 Info->Valid = 0; 373 374 Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 375 if (ACPI_FAILURE (Status)) 376 { 377 goto Cleanup; 378 } 379 380 /* If not a device, we are all done */ 381 382 if (Info->Type == ACPI_TYPE_DEVICE) 383 { 384 /* 385 * Get extra info for ACPI Devices objects only: 386 * Run the Device _HID, _UID, _CID, _STA, _ADR and _SxD methods. 387 * 388 * Note: none of these methods are required, so they may or may 389 * not be present for this device. The Info->Valid bitfield is used 390 * to indicate which methods were found and ran successfully. 391 */ 392 393 /* Execute the Device._HID method */ 394 395 Status = AcpiUtExecute_HID (Node, &Info->HardwareId); 396 if (ACPI_SUCCESS (Status)) 397 { 398 Info->Valid |= ACPI_VALID_HID; 399 } 400 401 /* Execute the Device._UID method */ 402 403 Status = AcpiUtExecute_UID (Node, &Info->UniqueId); 404 if (ACPI_SUCCESS (Status)) 405 { 406 Info->Valid |= ACPI_VALID_UID; 407 } 408 409 /* Execute the Device._CID method */ 410 411 Status = AcpiUtExecute_CID (Node, &CidList); 412 if (ACPI_SUCCESS (Status)) 413 { 414 Size += CidList->Size; 415 Info->Valid |= ACPI_VALID_CID; 416 } 417 418 /* Execute the Device._STA method */ 419 420 Status = AcpiUtExecute_STA (Node, &Info->CurrentStatus); 421 if (ACPI_SUCCESS (Status)) 422 { 423 Info->Valid |= ACPI_VALID_STA; 424 } 425 426 /* Execute the Device._ADR method */ 427 428 Status = AcpiUtEvaluateNumericObject (METHOD_NAME__ADR, Node, 429 &Info->Address); 430 if (ACPI_SUCCESS (Status)) 431 { 432 Info->Valid |= ACPI_VALID_ADR; 433 } 434 435 /* Execute the Device._SxD methods */ 436 437 Status = AcpiUtExecute_Sxds (Node, Info->HighestDstates); 438 if (ACPI_SUCCESS (Status)) 439 { 440 Info->Valid |= ACPI_VALID_SXDS; 441 } 442 } 443 444 /* Validate/Allocate/Clear caller buffer */ 445 446 Status = AcpiUtInitializeBuffer (Buffer, Size); 447 if (ACPI_FAILURE (Status)) 448 { 449 goto Cleanup; 450 } 451 452 /* Populate the return buffer */ 453 454 ReturnInfo = Buffer->Pointer; 455 ACPI_MEMCPY (ReturnInfo, Info, sizeof (ACPI_DEVICE_INFO)); 456 457 if (CidList) 458 { 459 ACPI_MEMCPY (&ReturnInfo->CompatibilityId, CidList, CidList->Size); 460 } 461 462 463 Cleanup: 464 ACPI_FREE (Info); 465 if (CidList) 466 { 467 ACPI_FREE (CidList); 468 } 469 return (Status); 470 } 471 472 ACPI_EXPORT_SYMBOL (AcpiGetObjectInfo) 473 474