1 /******************************************************************************
3 * Module Name: nsxfname - Public interfaces to the ACPI subsystem
4 * ACPI Namespace oriented interfaces
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
14 * All rights reserved.
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
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
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;
39 * The above copyright and patent license is granted only if the following
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.
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
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
74 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
82 * 4. Disclaimer and Export Compliance
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
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
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.
116 *****************************************************************************/
118 #define __NSXFNAME_C__
121 #include "acnamesp.h"
124 #define _COMPONENT ACPI_NAMESPACE
125 ACPI_MODULE_NAME ("nsxfname")
128 /******************************************************************************
130 * FUNCTION: AcpiGetHandle
132 * PARAMETERS: Parent - Object to search under (search scope).
133 * PathName - Pointer to an asciiz string containing the
135 * RetHandle - Where the return handle is placed
139 * DESCRIPTION: This routine will search for a caller specified name in the
140 * name space. The caller can restrict the search region by
141 * specifying a non NULL parent. The parent value is itself a
144 ******************************************************************************/
149 ACPI_STRING Pathname
,
150 ACPI_HANDLE
*RetHandle
)
153 ACPI_NAMESPACE_NODE
*Node
= NULL
;
154 ACPI_NAMESPACE_NODE
*PrefixNode
= NULL
;
157 ACPI_FUNCTION_ENTRY ();
160 /* Parameter Validation */
162 if (!RetHandle
|| !Pathname
)
164 return (AE_BAD_PARAMETER
);
167 /* Convert a parent handle to a prefix node */
171 Status
= AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE
);
172 if (ACPI_FAILURE (Status
))
177 PrefixNode
= AcpiNsMapHandleToNode (Parent
);
180 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE
);
181 return (AE_BAD_PARAMETER
);
184 Status
= AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE
);
185 if (ACPI_FAILURE (Status
))
191 /* Special case for root, since we can't search for it */
193 if (ACPI_STRCMP (Pathname
, ACPI_NS_ROOT_PATH
) == 0)
195 *RetHandle
= AcpiNsConvertEntryToHandle (AcpiGbl_RootNode
);
200 * Find the Node and convert to a handle
202 Status
= AcpiNsGetNodeByPath (Pathname
, PrefixNode
, ACPI_NS_NO_UPSEARCH
,
206 if (ACPI_SUCCESS (Status
))
208 *RetHandle
= AcpiNsConvertEntryToHandle (Node
);
215 /******************************************************************************
217 * FUNCTION: AcpiGetName
219 * PARAMETERS: Handle - Handle to be converted to a pathname
220 * NameType - Full pathname or single segment
221 * Buffer - Buffer for returned path
223 * RETURN: Pointer to a string containing the fully qualified Name.
225 * DESCRIPTION: This routine returns the fully qualified name associated with
226 * the Handle parameter. This and the AcpiPathnameToHandle are
227 * complementary functions.
229 ******************************************************************************/
238 ACPI_NAMESPACE_NODE
*Node
;
241 /* Parameter validation */
243 if (NameType
> ACPI_NAME_TYPE_MAX
)
245 return (AE_BAD_PARAMETER
);
248 Status
= AcpiUtValidateBuffer (Buffer
);
249 if (ACPI_FAILURE (Status
))
254 if (NameType
== ACPI_FULL_PATHNAME
)
256 /* Get the full pathname (From the namespace root) */
258 Status
= AcpiNsHandleToPathname (Handle
, Buffer
);
263 * Wants the single segment ACPI name.
264 * Validate handle and convert to a namespace Node
266 Status
= AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE
);
267 if (ACPI_FAILURE (Status
))
272 Node
= AcpiNsMapHandleToNode (Handle
);
275 Status
= AE_BAD_PARAMETER
;
279 /* Validate/Allocate/Clear caller buffer */
281 Status
= AcpiUtInitializeBuffer (Buffer
, ACPI_PATH_SEGMENT_LENGTH
);
282 if (ACPI_FAILURE (Status
))
287 /* Just copy the ACPI name from the Node and zero terminate it */
289 ACPI_STRNCPY (Buffer
->Pointer
, AcpiUtGetNodeName (Node
),
291 ((char *) Buffer
->Pointer
) [ACPI_NAME_SIZE
] = 0;
297 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE
);
302 /******************************************************************************
304 * FUNCTION: AcpiGetObjectInfo
306 * PARAMETERS: Handle - Object Handle
307 * Info - Where the info is returned
311 * DESCRIPTION: Returns information about an object as gleaned from the
312 * namespace node and possibly by running several standard
313 * control methods (Such as in the case of a device.)
315 ******************************************************************************/
323 ACPI_NAMESPACE_NODE
*Node
;
324 ACPI_DEVICE_INFO
*Info
;
325 ACPI_DEVICE_INFO
*ReturnInfo
;
326 ACPI_COMPATIBLE_ID_LIST
*CidList
= NULL
;
330 /* Parameter validation */
332 if (!Handle
|| !Buffer
)
334 return (AE_BAD_PARAMETER
);
337 Status
= AcpiUtValidateBuffer (Buffer
);
338 if (ACPI_FAILURE (Status
))
343 Info
= ACPI_MEM_CALLOCATE (sizeof (ACPI_DEVICE_INFO
));
346 return (AE_NO_MEMORY
);
349 Status
= AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE
);
350 if (ACPI_FAILURE (Status
))
355 Node
= AcpiNsMapHandleToNode (Handle
);
358 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE
);
362 /* Init return structure */
364 Size
= sizeof (ACPI_DEVICE_INFO
);
366 Info
->Type
= Node
->Type
;
367 Info
->Name
= Node
->Name
.Integer
;
370 Status
= AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE
);
371 if (ACPI_FAILURE (Status
))
376 /* If not a device, we are all done */
378 if (Info
->Type
== ACPI_TYPE_DEVICE
)
381 * Get extra info for ACPI Devices objects only:
382 * Run the Device _HID, _UID, _CID, _STA, _ADR and _SxD methods.
384 * Note: none of these methods are required, so they may or may
385 * not be present for this device. The Info->Valid bitfield is used
386 * to indicate which methods were found and ran successfully.
389 /* Execute the Device._HID method */
391 Status
= AcpiUtExecute_HID (Node
, &Info
->HardwareId
);
392 if (ACPI_SUCCESS (Status
))
394 Info
->Valid
|= ACPI_VALID_HID
;
397 /* Execute the Device._UID method */
399 Status
= AcpiUtExecute_UID (Node
, &Info
->UniqueId
);
400 if (ACPI_SUCCESS (Status
))
402 Info
->Valid
|= ACPI_VALID_UID
;
405 /* Execute the Device._CID method */
407 Status
= AcpiUtExecute_CID (Node
, &CidList
);
408 if (ACPI_SUCCESS (Status
))
410 Size
+= ((ACPI_SIZE
) CidList
->Count
- 1) *
411 sizeof (ACPI_COMPATIBLE_ID
);
412 Info
->Valid
|= ACPI_VALID_CID
;
415 /* Execute the Device._STA method */
417 Status
= AcpiUtExecute_STA (Node
, &Info
->CurrentStatus
);
418 if (ACPI_SUCCESS (Status
))
420 Info
->Valid
|= ACPI_VALID_STA
;
423 /* Execute the Device._ADR method */
425 Status
= AcpiUtEvaluateNumericObject (METHOD_NAME__ADR
, Node
,
427 if (ACPI_SUCCESS (Status
))
429 Info
->Valid
|= ACPI_VALID_ADR
;
432 /* Execute the Device._SxD methods */
434 Status
= AcpiUtExecute_Sxds (Node
, Info
->HighestDstates
);
435 if (ACPI_SUCCESS (Status
))
437 Info
->Valid
|= ACPI_VALID_SXDS
;
441 /* Validate/Allocate/Clear caller buffer */
443 Status
= AcpiUtInitializeBuffer (Buffer
, Size
);
444 if (ACPI_FAILURE (Status
))
449 /* Populate the return buffer */
451 ReturnInfo
= Buffer
->Pointer
;
452 ACPI_MEMCPY (ReturnInfo
, Info
, sizeof (ACPI_DEVICE_INFO
));
456 ACPI_MEMCPY (&ReturnInfo
->CompatibilityId
, CidList
, CidList
->Size
);
461 ACPI_MEM_FREE (Info
);
464 ACPI_MEM_FREE (CidList
);