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