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