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