1 /******************************************************************************
3 * Module Name: nsxfname - Public interfaces to the ACPI subsystem
4 * ACPI Namespace oriented interfaces
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2008, Intel Corp.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
45 #include <acpi/acpi.h>
46 #include <acpi/acnamesp.h>
48 #define _COMPONENT ACPI_NAMESPACE
49 ACPI_MODULE_NAME("nsxfname")
51 /******************************************************************************
53 * FUNCTION: acpi_get_handle
55 * PARAMETERS: Parent - Object to search under (search scope).
56 * Pathname - Pointer to an asciiz string containing the
58 * ret_handle - Where the return handle is returned
62 * DESCRIPTION: This routine will search for a caller specified name in the
63 * name space. The caller can restrict the search region by
64 * specifying a non NULL parent. The parent value is itself a
67 ******************************************************************************/
69 acpi_get_handle(acpi_handle parent
,
70 acpi_string pathname
, acpi_handle
* ret_handle
)
73 struct acpi_namespace_node
*node
= NULL
;
74 struct acpi_namespace_node
*prefix_node
= NULL
;
76 ACPI_FUNCTION_ENTRY();
78 /* Parameter Validation */
80 if (!ret_handle
|| !pathname
) {
81 return (AE_BAD_PARAMETER
);
84 /* Convert a parent handle to a prefix node */
87 prefix_node
= acpi_ns_map_handle_to_node(parent
);
89 return (AE_BAD_PARAMETER
);
95 * 1) Fully qualified pathname
96 * 2) Parent + Relative pathname
98 * Error for <null Parent + relative path>
100 if (acpi_ns_valid_root_prefix(pathname
[0])) {
102 /* Pathname is fully qualified (starts with '\') */
104 /* Special case for root-only, since we can't search for it */
106 if (!ACPI_STRCMP(pathname
, ACPI_NS_ROOT_PATH
)) {
108 acpi_ns_convert_entry_to_handle(acpi_gbl_root_node
);
111 } else if (!prefix_node
) {
113 /* Relative path with null prefix is disallowed */
115 return (AE_BAD_PARAMETER
);
118 /* Find the Node and convert to a handle */
121 acpi_ns_get_node(prefix_node
, pathname
, ACPI_NS_NO_UPSEARCH
, &node
);
122 if (ACPI_SUCCESS(status
)) {
123 *ret_handle
= acpi_ns_convert_entry_to_handle(node
);
129 ACPI_EXPORT_SYMBOL(acpi_get_handle
)
131 /******************************************************************************
133 * FUNCTION: acpi_get_name
135 * PARAMETERS: Handle - Handle to be converted to a pathname
136 * name_type - Full pathname or single segment
137 * Buffer - Buffer for returned path
139 * RETURN: Pointer to a string containing the fully qualified Name.
141 * DESCRIPTION: This routine returns the fully qualified name associated with
142 * the Handle parameter. This and the acpi_pathname_to_handle are
143 * complementary functions.
145 ******************************************************************************/
147 acpi_get_name(acpi_handle handle
, u32 name_type
, struct acpi_buffer
* buffer
)
150 struct acpi_namespace_node
*node
;
152 /* Parameter validation */
154 if (name_type
> ACPI_NAME_TYPE_MAX
) {
155 return (AE_BAD_PARAMETER
);
158 status
= acpi_ut_validate_buffer(buffer
);
159 if (ACPI_FAILURE(status
)) {
163 if (name_type
== ACPI_FULL_PATHNAME
) {
165 /* Get the full pathname (From the namespace root) */
167 status
= acpi_ns_handle_to_pathname(handle
, buffer
);
172 * Wants the single segment ACPI name.
173 * Validate handle and convert to a namespace Node
175 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
176 if (ACPI_FAILURE(status
)) {
180 node
= acpi_ns_map_handle_to_node(handle
);
182 status
= AE_BAD_PARAMETER
;
183 goto unlock_and_exit
;
186 /* Validate/Allocate/Clear caller buffer */
188 status
= acpi_ut_initialize_buffer(buffer
, ACPI_PATH_SEGMENT_LENGTH
);
189 if (ACPI_FAILURE(status
)) {
190 goto unlock_and_exit
;
193 /* Just copy the ACPI name from the Node and zero terminate it */
195 ACPI_STRNCPY(buffer
->pointer
, acpi_ut_get_node_name(node
),
197 ((char *)buffer
->pointer
)[ACPI_NAME_SIZE
] = 0;
202 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
206 ACPI_EXPORT_SYMBOL(acpi_get_name
)
208 /******************************************************************************
210 * FUNCTION: acpi_get_object_info
212 * PARAMETERS: Handle - Object Handle
213 * Buffer - Where the info is returned
217 * DESCRIPTION: Returns information about an object as gleaned from the
218 * namespace node and possibly by running several standard
219 * control methods (Such as in the case of a device.)
221 ******************************************************************************/
223 acpi_get_object_info(acpi_handle handle
, struct acpi_buffer
* buffer
)
226 struct acpi_namespace_node
*node
;
227 struct acpi_device_info
*info
;
228 struct acpi_device_info
*return_info
;
229 struct acpi_compatible_id_list
*cid_list
= NULL
;
232 /* Parameter validation */
234 if (!handle
|| !buffer
) {
235 return (AE_BAD_PARAMETER
);
238 status
= acpi_ut_validate_buffer(buffer
);
239 if (ACPI_FAILURE(status
)) {
243 info
= ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_device_info
));
245 return (AE_NO_MEMORY
);
248 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
249 if (ACPI_FAILURE(status
)) {
253 node
= acpi_ns_map_handle_to_node(handle
);
255 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
256 status
= AE_BAD_PARAMETER
;
260 /* Init return structure */
262 size
= sizeof(struct acpi_device_info
);
264 info
->type
= node
->type
;
265 info
->name
= node
->name
.integer
;
268 if (node
->type
== ACPI_TYPE_METHOD
) {
269 info
->param_count
= node
->object
->method
.param_count
;
272 status
= acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
273 if (ACPI_FAILURE(status
)) {
277 /* If not a device, we are all done */
279 if (info
->type
== ACPI_TYPE_DEVICE
) {
281 * Get extra info for ACPI Devices objects only:
282 * Run the Device _HID, _UID, _CID, _STA, _ADR and _sx_d methods.
284 * Note: none of these methods are required, so they may or may
285 * not be present for this device. The Info->Valid bitfield is used
286 * to indicate which methods were found and ran successfully.
289 /* Execute the Device._HID method */
291 status
= acpi_ut_execute_HID(node
, &info
->hardware_id
);
292 if (ACPI_SUCCESS(status
)) {
293 info
->valid
|= ACPI_VALID_HID
;
296 /* Execute the Device._UID method */
298 status
= acpi_ut_execute_UID(node
, &info
->unique_id
);
299 if (ACPI_SUCCESS(status
)) {
300 info
->valid
|= ACPI_VALID_UID
;
303 /* Execute the Device._CID method */
305 status
= acpi_ut_execute_CID(node
, &cid_list
);
306 if (ACPI_SUCCESS(status
)) {
307 size
+= cid_list
->size
;
308 info
->valid
|= ACPI_VALID_CID
;
311 /* Execute the Device._STA method */
313 status
= acpi_ut_execute_STA(node
, &info
->current_status
);
314 if (ACPI_SUCCESS(status
)) {
315 info
->valid
|= ACPI_VALID_STA
;
318 /* Execute the Device._ADR method */
320 status
= acpi_ut_evaluate_numeric_object(METHOD_NAME__ADR
, node
,
322 if (ACPI_SUCCESS(status
)) {
323 info
->valid
|= ACPI_VALID_ADR
;
326 /* Execute the Device._sx_d methods */
328 status
= acpi_ut_execute_sxds(node
, info
->highest_dstates
);
329 if (ACPI_SUCCESS(status
)) {
330 info
->valid
|= ACPI_VALID_SXDS
;
334 /* Validate/Allocate/Clear caller buffer */
336 status
= acpi_ut_initialize_buffer(buffer
, size
);
337 if (ACPI_FAILURE(status
)) {
341 /* Populate the return buffer */
343 return_info
= buffer
->pointer
;
344 ACPI_MEMCPY(return_info
, info
, sizeof(struct acpi_device_info
));
347 ACPI_MEMCPY(&return_info
->compatibility_id
, cid_list
,
359 ACPI_EXPORT_SYMBOL(acpi_get_object_info
)