nsxfname.c revision 70243
1139778Simp/****************************************************************************** 2190507Slulf * 3130389Sle * Module Name: nsxfname - Public interfaces to the ACPI subsystem 4130389Sle * ACPI Namespace oriented interfaces 5130389Sle * $Revision: 74 $ 6130389Sle * 7130389Sle *****************************************************************************/ 8130389Sle 9130389Sle/****************************************************************************** 10130389Sle * 11130389Sle * 1. Copyright Notice 12130389Sle * 13130389Sle * Some or all of this work - Copyright (c) 1999, 2000, Intel Corp. 14130389Sle * All rights reserved. 15130389Sle * 16130389Sle * 2. License 17130389Sle * 18130389Sle * 2.1. This is your license from Intel Corp. under its intellectual property 19130389Sle * rights. You may have additional license terms from the party that provided 20130389Sle * you this software, covering your right to use that party's intellectual 21130389Sle * property rights. 22130389Sle * 23130389Sle * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 24130389Sle * copy of the source code appearing in this file ("Covered Code") an 25130389Sle * irrevocable, perpetual, worldwide license under Intel's copyrights in the 26130389Sle * base code distributed originally by Intel ("Original Intel Code") to copy, 27130389Sle * make derivatives, distribute, use and display any portion of the Covered 28130389Sle * Code in any form, with the right to sublicense such rights; and 29130389Sle * 30130389Sle * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 31130389Sle * license (with the right to sublicense), under only those claims of Intel 32130389Sle * patents that are infringed by the Original Intel Code, to make, use, sell, 33130389Sle * offer to sell, and import the Covered Code and derivative works thereof 34130389Sle * solely to the minimum extent necessary to exercise the above copyright 35135426Sle * license, and in no event shall the patent license extend to any additions 36130389Sle * to or modifications of the Original Intel Code. No other license or right 37130389Sle * is granted directly or by implication, estoppel or otherwise; 38130389Sle * 39135426Sle * The above copyright and patent license is granted only if the following 40130389Sle * conditions are met: 41130389Sle * 42130389Sle * 3. Conditions 43130389Sle * 44135426Sle * 3.1. Redistribution of Source with Rights to Further Distribute Source. 45135426Sle * Redistribution of source code of any substantial portion of the Covered 46130389Sle * Code or modification with rights to further distribute source must include 47135426Sle * the above Copyright Notice, the above License, this list of Conditions, 48135426Sle * and the following Disclaimer and Export Compliance provision. In addition, 49130389Sle * Licensee must cause all Covered Code to which Licensee contributes to 50130389Sle * contain a file documenting the changes Licensee made to create that Covered 51190507Slulf * Code and the date of any change. Licensee must include in that file the 52190507Slulf * documentation of any changes made by any predecessor Licensee. Licensee 53135426Sle * must include a prominent statement that the modification is derived, 54130389Sle * directly or indirectly, from Original Intel Code. 55130389Sle * 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 = NULL; 159 ACPI_NAMESPACE_NODE *PrefixNode = NULL; 160 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 AcpiCmAcquireMutex (ACPI_MTX_NAMESPACE); 172 173 PrefixNode = AcpiNsConvertHandleToEntry (Parent); 174 if (!PrefixNode) 175 { 176 AcpiCmReleaseMutex (ACPI_MTX_NAMESPACE); 177 return (AE_BAD_PARAMETER); 178 } 179 180 AcpiCmReleaseMutex (ACPI_MTX_NAMESPACE); 181 } 182 183 /* Special case for root, since we can't search for it */ 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 a handle 193 */ 194 Status = AcpiNsGetNode (Pathname, PrefixNode, &Node); 195 196 *RetHandle = NULL; 197 if (ACPI_SUCCESS (Status)) 198 { 199 *RetHandle = AcpiNsConvertEntryToHandle (Node); 200 } 201 202 return (Status); 203} 204 205 206/**************************************************************************** 207 * 208 * FUNCTION: AcpiGetPathname 209 * 210 * PARAMETERS: Handle - Handle to be converted to a pathname 211 * NameType - Full pathname or single segment 212 * RetPathPtr - Buffer for returned path 213 * 214 * RETURN: Pointer to a string containing the fully qualified Name. 215 * 216 * DESCRIPTION: This routine returns the fully qualified name associated with 217 * the Handle parameter. This and the AcpiPathnameToHandle are 218 * complementary functions. 219 * 220 ******************************************************************************/ 221 222ACPI_STATUS 223AcpiGetName ( 224 ACPI_HANDLE Handle, 225 UINT32 NameType, 226 ACPI_BUFFER *RetPathPtr) 227{ 228 ACPI_STATUS Status; 229 ACPI_NAMESPACE_NODE *Node; 230 231 232 /* Buffer pointer must be valid always */ 233 234 if (!RetPathPtr || (NameType > ACPI_NAME_TYPE_MAX)) 235 { 236 return (AE_BAD_PARAMETER); 237 } 238 239 /* Allow length to be zero and ignore the pointer */ 240 241 if ((RetPathPtr->Length) && 242 (!RetPathPtr->Pointer)) 243 { 244 return (AE_BAD_PARAMETER); 245 } 246 247 if (NameType == ACPI_FULL_PATHNAME) 248 { 249 /* Get the full pathname (From the namespace root) */ 250 251 Status = AcpiNsHandleToPathname (Handle, &RetPathPtr->Length, 252 RetPathPtr->Pointer); 253 return (Status); 254 } 255 256 /* 257 * Wants the single segment ACPI name. 258 * Validate handle and convert to an Node 259 */ 260 261 AcpiCmAcquireMutex (ACPI_MTX_NAMESPACE); 262 Node = AcpiNsConvertHandleToEntry (Handle); 263 if (!Node) 264 { 265 Status = AE_BAD_PARAMETER; 266 goto UnlockAndExit; 267 } 268 269 /* Check if name will fit in buffer */ 270 271 if (RetPathPtr->Length < PATH_SEGMENT_LENGTH) 272 { 273 RetPathPtr->Length = PATH_SEGMENT_LENGTH; 274 Status = AE_BUFFER_OVERFLOW; 275 goto UnlockAndExit; 276 } 277 278 /* Just copy the ACPI name from the Node and zero terminate it */ 279 280 STRNCPY (RetPathPtr->Pointer, (NATIVE_CHAR *) &Node->Name, 281 ACPI_NAME_SIZE); 282 ((NATIVE_CHAR *) RetPathPtr->Pointer) [ACPI_NAME_SIZE] = 0; 283 Status = AE_OK; 284 285 286UnlockAndExit: 287 288 AcpiCmReleaseMutex (ACPI_MTX_NAMESPACE); 289 return (Status); 290} 291 292 293/**************************************************************************** 294 * 295 * FUNCTION: AcpiGetObjectInfo 296 * 297 * PARAMETERS: Handle - Object Handle 298 * Info - Where the info is returned 299 * 300 * RETURN: Status 301 * 302 * DESCRIPTION: Returns information about an object as gleaned from the 303 * namespace node and possibly by running several standard 304 * control methods (Such as in the case of a device.) 305 * 306 ******************************************************************************/ 307 308ACPI_STATUS 309AcpiGetObjectInfo ( 310 ACPI_HANDLE Handle, 311 ACPI_DEVICE_INFO *Info) 312{ 313 DEVICE_ID Hid; 314 DEVICE_ID Uid; 315 ACPI_STATUS Status; 316 UINT32 DeviceStatus = 0; 317 ACPI_INTEGER Address = 0; 318 ACPI_NAMESPACE_NODE *Node; 319 320 321 /* Parameter validation */ 322 323 if (!Handle || !Info) 324 { 325 return (AE_BAD_PARAMETER); 326 } 327 328 AcpiCmAcquireMutex (ACPI_MTX_NAMESPACE); 329 330 Node = AcpiNsConvertHandleToEntry (Handle); 331 if (!Node) 332 { 333 AcpiCmReleaseMutex (ACPI_MTX_NAMESPACE); 334 return (AE_BAD_PARAMETER); 335 } 336 337 Info->Type = Node->Type; 338 Info->Name = Node->Name; 339 340 AcpiCmReleaseMutex (ACPI_MTX_NAMESPACE); 341 342 /* 343 * If not a device, we are all done. 344 */ 345 if (Info->Type != ACPI_TYPE_DEVICE) 346 { 347 return (AE_OK); 348 } 349 350 351 /* 352 * Get extra info for ACPI devices only. Run the 353 * _HID, _UID, _STA, and _ADR methods. Note: none 354 * of these methods are required, so they may or may 355 * not be present. The Info->Valid bits are used 356 * to indicate which methods ran successfully. 357 */ 358 359 Info->Valid = 0; 360 361 /* Execute the _HID method and save the result */ 362 363 Status = AcpiCmExecute_HID (Node, &Hid); 364 if (ACPI_SUCCESS (Status)) 365 { 366 STRNCPY (Info->HardwareId, Hid.Buffer, sizeof(Info->HardwareId)); 367 368 Info->Valid |= ACPI_VALID_HID; 369 } 370 371 /* Execute the _UID method and save the result */ 372 373 Status = AcpiCmExecute_UID (Node, &Uid); 374 if (ACPI_SUCCESS (Status)) 375 { 376 STRCPY (Info->UniqueId, Uid.Buffer); 377 378 Info->Valid |= ACPI_VALID_UID; 379 } 380 381 /* 382 * Execute the _STA method and save the result 383 * _STA is not always present 384 */ 385 386 Status = AcpiCmExecute_STA (Node, &DeviceStatus); 387 if (ACPI_SUCCESS (Status)) 388 { 389 Info->CurrentStatus = DeviceStatus; 390 Info->Valid |= ACPI_VALID_STA; 391 } 392 393 /* 394 * Execute the _ADR method and save result if successful 395 * _ADR is not always present 396 */ 397 398 Status = AcpiCmEvaluateNumericObject (METHOD_NAME__ADR, 399 Node, &Address); 400 401 if (ACPI_SUCCESS (Status)) 402 { 403 Info->Address = Address; 404 Info->Valid |= ACPI_VALID_ADR; 405 } 406 407 return (AE_OK); 408} 409 410