nsxfname.c revision 83174
1/****************************************************************************** 2 * 3 * Module Name: nsxfname - Public interfaces to the ACPI subsystem 4 * ACPI Namespace oriented interfaces 5 * $Revision: 80 $ 6 * 7 *****************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999, 2000, 2001, 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 "acinterp.h" 122#include "acnamesp.h" 123#include "amlcode.h" 124#include "acparser.h" 125#include "acdispat.h" 126#include "acevents.h" 127 128 129#define _COMPONENT ACPI_NAMESPACE 130 MODULE_NAME ("nsxfname") 131 132 133/**************************************************************************** 134 * 135 * FUNCTION: AcpiGetHandle 136 * 137 * PARAMETERS: Parent - Object to search under (search scope). 138 * PathName - Pointer to an asciiz string containing the 139 * name 140 * RetHandle - Where the return handle is placed 141 * 142 * RETURN: Status 143 * 144 * DESCRIPTION: This routine will search for a caller specified name in the 145 * name space. The caller can restrict the search region by 146 * specifying a non NULL parent. The parent value is itself a 147 * namespace handle. 148 * 149 ******************************************************************************/ 150 151ACPI_STATUS 152AcpiGetHandle ( 153 ACPI_HANDLE Parent, 154 ACPI_STRING Pathname, 155 ACPI_HANDLE *RetHandle) 156{ 157 ACPI_STATUS Status; 158 ACPI_NAMESPACE_NODE *Node = NULL; 159 ACPI_NAMESPACE_NODE *PrefixNode = NULL; 160 161 162 FUNCTION_ENTRY (); 163 164 165 /* Ensure that ACPI has been initialized */ 166 167 ACPI_IS_INITIALIZATION_COMPLETE (Status); 168 if (ACPI_FAILURE (Status)) 169 { 170 return (Status); 171 } 172 173 /* Parameter Validation */ 174 175 if (!RetHandle || !Pathname) 176 { 177 return (AE_BAD_PARAMETER); 178 } 179 180 /* Convert a parent handle to a prefix node */ 181 182 if (Parent) 183 { 184 AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 185 186 PrefixNode = AcpiNsConvertHandleToEntry (Parent); 187 if (!PrefixNode) 188 { 189 AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 190 return (AE_BAD_PARAMETER); 191 } 192 193 AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 194 } 195 196 /* Special case for root, since we can't search for it */ 197 198 if (STRCMP (Pathname, NS_ROOT_PATH) == 0) 199 { 200 *RetHandle = AcpiNsConvertEntryToHandle (AcpiGbl_RootNode); 201 return (AE_OK); 202 } 203 204 /* 205 * Find the Node and convert to a handle 206 */ 207 Status = AcpiNsGetNode (Pathname, PrefixNode, &Node); 208 209 *RetHandle = NULL; 210 if (ACPI_SUCCESS (Status)) 211 { 212 *RetHandle = AcpiNsConvertEntryToHandle (Node); 213 } 214 215 return (Status); 216} 217 218 219/**************************************************************************** 220 * 221 * FUNCTION: AcpiGetName 222 * 223 * PARAMETERS: Handle - Handle to be converted to a pathname 224 * NameType - Full pathname or single segment 225 * RetPathPtr - Buffer for returned path 226 * 227 * RETURN: Pointer to a string containing the fully qualified Name. 228 * 229 * DESCRIPTION: This routine returns the fully qualified name associated with 230 * the Handle parameter. This and the AcpiPathnameToHandle are 231 * complementary functions. 232 * 233 ******************************************************************************/ 234 235ACPI_STATUS 236AcpiGetName ( 237 ACPI_HANDLE Handle, 238 UINT32 NameType, 239 ACPI_BUFFER *RetPathPtr) 240{ 241 ACPI_STATUS Status; 242 ACPI_NAMESPACE_NODE *Node; 243 244 245 /* Ensure that ACPI has been initialized */ 246 247 ACPI_IS_INITIALIZATION_COMPLETE (Status); 248 if (ACPI_FAILURE (Status)) 249 { 250 return (Status); 251 } 252 253 /* Buffer pointer must be valid always */ 254 255 if (!RetPathPtr || (NameType > ACPI_NAME_TYPE_MAX)) 256 { 257 return (AE_BAD_PARAMETER); 258 } 259 260 /* Allow length to be zero and ignore the pointer */ 261 262 if ((RetPathPtr->Length) && 263 (!RetPathPtr->Pointer)) 264 { 265 return (AE_BAD_PARAMETER); 266 } 267 268 if (NameType == ACPI_FULL_PATHNAME) 269 { 270 /* Get the full pathname (From the namespace root) */ 271 272 Status = AcpiNsHandleToPathname (Handle, &RetPathPtr->Length, 273 RetPathPtr->Pointer); 274 return (Status); 275 } 276 277 /* 278 * Wants the single segment ACPI name. 279 * Validate handle and convert to an Node 280 */ 281 AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 282 Node = AcpiNsConvertHandleToEntry (Handle); 283 if (!Node) 284 { 285 Status = AE_BAD_PARAMETER; 286 goto UnlockAndExit; 287 } 288 289 /* Check if name will fit in buffer */ 290 291 if (RetPathPtr->Length < PATH_SEGMENT_LENGTH) 292 { 293 RetPathPtr->Length = PATH_SEGMENT_LENGTH; 294 Status = AE_BUFFER_OVERFLOW; 295 goto UnlockAndExit; 296 } 297 298 /* Just copy the ACPI name from the Node and zero terminate it */ 299 300 STRNCPY (RetPathPtr->Pointer, (NATIVE_CHAR *) &Node->Name, 301 ACPI_NAME_SIZE); 302 ((NATIVE_CHAR *) RetPathPtr->Pointer) [ACPI_NAME_SIZE] = 0; 303 Status = AE_OK; 304 305 306UnlockAndExit: 307 308 AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 309 return (Status); 310} 311 312 313/**************************************************************************** 314 * 315 * FUNCTION: AcpiGetObjectInfo 316 * 317 * PARAMETERS: Handle - Object Handle 318 * Info - Where the info is returned 319 * 320 * RETURN: Status 321 * 322 * DESCRIPTION: Returns information about an object as gleaned from the 323 * namespace node and possibly by running several standard 324 * control methods (Such as in the case of a device.) 325 * 326 ******************************************************************************/ 327 328ACPI_STATUS 329AcpiGetObjectInfo ( 330 ACPI_HANDLE Handle, 331 ACPI_DEVICE_INFO *Info) 332{ 333 ACPI_DEVICE_ID Hid; 334 ACPI_DEVICE_ID Uid; 335 ACPI_STATUS Status; 336 UINT32 DeviceStatus = 0; 337 ACPI_INTEGER Address = 0; 338 ACPI_NAMESPACE_NODE *Node; 339 340 341 /* Ensure that ACPI has been initialized */ 342 343 ACPI_IS_INITIALIZATION_COMPLETE (Status); 344 if (ACPI_FAILURE (Status)) 345 { 346 return (Status); 347 } 348 349 /* Parameter validation */ 350 351 if (!Handle || !Info) 352 { 353 return (AE_BAD_PARAMETER); 354 } 355 356 AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 357 358 Node = AcpiNsConvertHandleToEntry (Handle); 359 if (!Node) 360 { 361 AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 362 return (AE_BAD_PARAMETER); 363 } 364 365 Info->Type = Node->Type; 366 Info->Name = Node->Name; 367 368 AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 369 370 /* 371 * If not a device, we are all done. 372 */ 373 if (Info->Type != ACPI_TYPE_DEVICE) 374 { 375 return (AE_OK); 376 } 377 378 379 /* 380 * Get extra info for ACPI devices only. Run the 381 * _HID, _UID, _STA, and _ADR methods. Note: none 382 * of these methods are required, so they may or may 383 * not be present. The Info->Valid bits are used 384 * to indicate which methods ran successfully. 385 */ 386 Info->Valid = 0; 387 388 /* Execute the _HID method and save the result */ 389 390 Status = AcpiUtExecute_HID (Node, &Hid); 391 if (ACPI_SUCCESS (Status)) 392 { 393 STRNCPY (Info->HardwareId, Hid.Buffer, sizeof(Info->HardwareId)); 394 395 Info->Valid |= ACPI_VALID_HID; 396 } 397 398 /* Execute the _UID method and save the result */ 399 400 Status = AcpiUtExecute_UID (Node, &Uid); 401 if (ACPI_SUCCESS (Status)) 402 { 403 STRCPY (Info->UniqueId, Uid.Buffer); 404 405 Info->Valid |= ACPI_VALID_UID; 406 } 407 408 /* 409 * Execute the _STA method and save the result 410 * _STA is not always present 411 */ 412 Status = AcpiUtExecute_STA (Node, &DeviceStatus); 413 if (ACPI_SUCCESS (Status)) 414 { 415 Info->CurrentStatus = DeviceStatus; 416 Info->Valid |= ACPI_VALID_STA; 417 } 418 419 /* 420 * Execute the _ADR method and save result if successful 421 * _ADR is not always present 422 */ 423 Status = AcpiUtEvaluateNumericObject (METHOD_NAME__ADR, 424 Node, &Address); 425 426 if (ACPI_SUCCESS (Status)) 427 { 428 Info->Address = Address; 429 Info->Valid |= ACPI_VALID_ADR; 430 } 431 432 return (AE_OK); 433} 434 435