nsxfname.c revision 114237
1/****************************************************************************** 2 * 3 * Module Name: nsxfname - Public interfaces to the ACPI subsystem 4 * ACPI Namespace oriented interfaces 5 * $Revision: 94 $ 6 * 7 *****************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999 - 2003, 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 placed 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 146ACPI_STATUS 147AcpiGetHandle ( 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 = AcpiNsGetNodeByPath (Pathname, PrefixNode, ACPI_NS_NO_UPSEARCH, &Node); 203 204 *RetHandle = NULL; 205 if (ACPI_SUCCESS (Status)) 206 { 207 *RetHandle = AcpiNsConvertEntryToHandle (Node); 208 } 209 210 return (Status); 211} 212 213 214/**************************************************************************** 215 * 216 * FUNCTION: AcpiGetName 217 * 218 * PARAMETERS: Handle - Handle to be converted to a pathname 219 * NameType - Full pathname or single segment 220 * Buffer - Buffer for returned path 221 * 222 * RETURN: Pointer to a string containing the fully qualified Name. 223 * 224 * DESCRIPTION: This routine returns the fully qualified name associated with 225 * the Handle parameter. This and the AcpiPathnameToHandle are 226 * complementary functions. 227 * 228 ******************************************************************************/ 229 230ACPI_STATUS 231AcpiGetName ( 232 ACPI_HANDLE Handle, 233 UINT32 NameType, 234 ACPI_BUFFER *Buffer) 235{ 236 ACPI_STATUS Status; 237 ACPI_NAMESPACE_NODE *Node; 238 239 240 /* Parameter validation */ 241 242 if (NameType > ACPI_NAME_TYPE_MAX) 243 { 244 return (AE_BAD_PARAMETER); 245 } 246 247 Status = AcpiUtValidateBuffer (Buffer); 248 if (ACPI_FAILURE (Status)) 249 { 250 return (Status); 251 } 252 253 if (NameType == ACPI_FULL_PATHNAME) 254 { 255 /* Get the full pathname (From the namespace root) */ 256 257 Status = AcpiNsHandleToPathname (Handle, Buffer); 258 return (Status); 259 } 260 261 /* 262 * Wants the single segment ACPI name. 263 * Validate handle and convert to a namespace Node 264 */ 265 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 266 if (ACPI_FAILURE (Status)) 267 { 268 return (Status); 269 } 270 271 Node = AcpiNsMapHandleToNode (Handle); 272 if (!Node) 273 { 274 Status = AE_BAD_PARAMETER; 275 goto UnlockAndExit; 276 } 277 278 /* Validate/Allocate/Clear caller buffer */ 279 280 Status = AcpiUtInitializeBuffer (Buffer, ACPI_PATH_SEGMENT_LENGTH); 281 if (ACPI_FAILURE (Status)) 282 { 283 goto UnlockAndExit; 284 } 285 286 /* Just copy the ACPI name from the Node and zero terminate it */ 287 288 ACPI_STRNCPY (Buffer->Pointer, Node->Name.Ascii, 289 ACPI_NAME_SIZE); 290 ((char *) Buffer->Pointer) [ACPI_NAME_SIZE] = 0; 291 Status = AE_OK; 292 293 294UnlockAndExit: 295 296 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 297 return (Status); 298} 299 300 301/**************************************************************************** 302 * 303 * FUNCTION: AcpiGetObjectInfo 304 * 305 * PARAMETERS: Handle - Object Handle 306 * Info - Where the info is returned 307 * 308 * RETURN: Status 309 * 310 * DESCRIPTION: Returns information about an object as gleaned from the 311 * namespace node and possibly by running several standard 312 * control methods (Such as in the case of a device.) 313 * 314 ******************************************************************************/ 315 316ACPI_STATUS 317AcpiGetObjectInfo ( 318 ACPI_HANDLE Handle, 319 ACPI_DEVICE_INFO *Info) 320{ 321 ACPI_DEVICE_ID Hid; 322 ACPI_DEVICE_ID Uid; 323 ACPI_STATUS Status; 324 UINT32 DeviceStatus = 0; 325 ACPI_INTEGER Address = 0; 326 ACPI_NAMESPACE_NODE *Node; 327 328 329 /* Parameter validation */ 330 331 if (!Handle || !Info) 332 { 333 return (AE_BAD_PARAMETER); 334 } 335 336 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 337 if (ACPI_FAILURE (Status)) 338 { 339 return (Status); 340 } 341 342 Node = AcpiNsMapHandleToNode (Handle); 343 if (!Node) 344 { 345 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 346 return (AE_BAD_PARAMETER); 347 } 348 349 Info->Type = Node->Type; 350 Info->Name = Node->Name.Integer; 351 352 Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 353 if (ACPI_FAILURE (Status)) 354 { 355 return (Status); 356 } 357 358 /* 359 * If not a device, we are all done. 360 */ 361 if (Info->Type != ACPI_TYPE_DEVICE) 362 { 363 return (AE_OK); 364 } 365 366 367 /* 368 * Get extra info for ACPI devices only. Run the 369 * _HID, _UID, _STA, and _ADR methods. Note: none 370 * of these methods are required, so they may or may 371 * not be present. The Info->Valid bits are used 372 * to indicate which methods ran successfully. 373 */ 374 Info->Valid = 0; 375 376 /* Execute the _HID method and save the result */ 377 378 Status = AcpiUtExecute_HID (Node, &Hid); 379 if (ACPI_SUCCESS (Status)) 380 { 381 ACPI_STRNCPY (Info->HardwareId, Hid.Buffer, sizeof(Info->HardwareId)); 382 Info->Valid |= ACPI_VALID_HID; 383 } 384 385 /* Execute the _UID method and save the result */ 386 387 Status = AcpiUtExecute_UID (Node, &Uid); 388 if (ACPI_SUCCESS (Status)) 389 { 390 ACPI_STRCPY (Info->UniqueId, Uid.Buffer); 391 Info->Valid |= ACPI_VALID_UID; 392 } 393 394 /* 395 * Execute the _STA method and save the result 396 * _STA is not always present 397 */ 398 Status = AcpiUtExecute_STA (Node, &DeviceStatus); 399 if (ACPI_SUCCESS (Status)) 400 { 401 Info->CurrentStatus = DeviceStatus; 402 Info->Valid |= ACPI_VALID_STA; 403 } 404 405 /* 406 * Execute the _ADR method and save result if successful 407 * _ADR is not always present 408 */ 409 Status = AcpiUtEvaluateNumericObject (METHOD_NAME__ADR, 410 Node, &Address); 411 412 if (ACPI_SUCCESS (Status)) 413 { 414 Info->Address = Address; 415 Info->Valid |= ACPI_VALID_ADR; 416 } 417 418 return (AE_OK); 419} 420 421