ACPI: ACPICA 20060310
[linux-2.6-block.git] / drivers / acpi / namespace / nsxfname.c
CommitLineData
1da177e4
LT
1/******************************************************************************
2 *
3 * Module Name: nsxfname - Public interfaces to the ACPI subsystem
4 * ACPI Namespace oriented interfaces
5 *
6 *****************************************************************************/
7
8/*
4a90c7e8 9 * Copyright (C) 2000 - 2006, R. Byron Moore
1da177e4
LT
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
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.
26 *
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.
30 *
31 * NO WARRANTY
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.
43 */
44
1da177e4
LT
45#include <acpi/acpi.h>
46#include <acpi/acnamesp.h>
47
1da177e4 48#define _COMPONENT ACPI_NAMESPACE
4be44fcd 49ACPI_MODULE_NAME("nsxfname")
1da177e4
LT
50
51/******************************************************************************
52 *
53 * FUNCTION: acpi_get_handle
54 *
55 * PARAMETERS: Parent - Object to search under (search scope).
44f6c012
RM
56 * Pathname - Pointer to an asciiz string containing the
57 * name
58 * ret_handle - Where the return handle is returned
1da177e4
LT
59 *
60 * RETURN: Status
61 *
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
65 * namespace handle.
66 *
67 ******************************************************************************/
1da177e4 68acpi_status
4be44fcd
LB
69acpi_get_handle(acpi_handle parent,
70 acpi_string pathname, acpi_handle * ret_handle)
1da177e4 71{
4be44fcd
LB
72 acpi_status status;
73 struct acpi_namespace_node *node = NULL;
74 struct acpi_namespace_node *prefix_node = NULL;
1da177e4 75
4be44fcd 76 ACPI_FUNCTION_ENTRY();
1da177e4
LT
77
78 /* Parameter Validation */
79
80 if (!ret_handle || !pathname) {
81 return (AE_BAD_PARAMETER);
82 }
83
84 /* Convert a parent handle to a prefix node */
85
86 if (parent) {
4be44fcd
LB
87 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
88 if (ACPI_FAILURE(status)) {
1da177e4
LT
89 return (status);
90 }
91
4be44fcd 92 prefix_node = acpi_ns_map_handle_to_node(parent);
1da177e4 93 if (!prefix_node) {
4be44fcd 94 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
1da177e4
LT
95 return (AE_BAD_PARAMETER);
96 }
97
4be44fcd
LB
98 status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
99 if (ACPI_FAILURE(status)) {
1da177e4
LT
100 return (status);
101 }
102 }
103
104 /* Special case for root, since we can't search for it */
105
4be44fcd
LB
106 if (ACPI_STRCMP(pathname, ACPI_NS_ROOT_PATH) == 0) {
107 *ret_handle =
108 acpi_ns_convert_entry_to_handle(acpi_gbl_root_node);
1da177e4
LT
109 return (AE_OK);
110 }
111
112 /*
113 * Find the Node and convert to a handle
114 */
4be44fcd
LB
115 status =
116 acpi_ns_get_node_by_path(pathname, prefix_node, ACPI_NS_NO_UPSEARCH,
117 &node);
1da177e4
LT
118
119 *ret_handle = NULL;
4be44fcd
LB
120 if (ACPI_SUCCESS(status)) {
121 *ret_handle = acpi_ns_convert_entry_to_handle(node);
1da177e4
LT
122 }
123
124 return (status);
125}
1da177e4 126
8313524a 127ACPI_EXPORT_SYMBOL(acpi_get_handle)
1da177e4
LT
128
129/******************************************************************************
130 *
131 * FUNCTION: acpi_get_name
132 *
133 * PARAMETERS: Handle - Handle to be converted to a pathname
134 * name_type - Full pathname or single segment
135 * Buffer - Buffer for returned path
136 *
137 * RETURN: Pointer to a string containing the fully qualified Name.
138 *
139 * DESCRIPTION: This routine returns the fully qualified name associated with
140 * the Handle parameter. This and the acpi_pathname_to_handle are
141 * complementary functions.
142 *
143 ******************************************************************************/
1da177e4 144acpi_status
4be44fcd 145acpi_get_name(acpi_handle handle, u32 name_type, struct acpi_buffer * buffer)
1da177e4 146{
4be44fcd
LB
147 acpi_status status;
148 struct acpi_namespace_node *node;
1da177e4
LT
149
150 /* Parameter validation */
151
152 if (name_type > ACPI_NAME_TYPE_MAX) {
153 return (AE_BAD_PARAMETER);
154 }
155
4be44fcd
LB
156 status = acpi_ut_validate_buffer(buffer);
157 if (ACPI_FAILURE(status)) {
1da177e4
LT
158 return (status);
159 }
160
161 if (name_type == ACPI_FULL_PATHNAME) {
52fc0b02 162
1da177e4
LT
163 /* Get the full pathname (From the namespace root) */
164
4be44fcd 165 status = acpi_ns_handle_to_pathname(handle, buffer);
1da177e4
LT
166 return (status);
167 }
168
169 /*
170 * Wants the single segment ACPI name.
171 * Validate handle and convert to a namespace Node
172 */
4be44fcd
LB
173 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
174 if (ACPI_FAILURE(status)) {
1da177e4
LT
175 return (status);
176 }
177
4be44fcd 178 node = acpi_ns_map_handle_to_node(handle);
1da177e4
LT
179 if (!node) {
180 status = AE_BAD_PARAMETER;
181 goto unlock_and_exit;
182 }
183
184 /* Validate/Allocate/Clear caller buffer */
185
4be44fcd
LB
186 status = acpi_ut_initialize_buffer(buffer, ACPI_PATH_SEGMENT_LENGTH);
187 if (ACPI_FAILURE(status)) {
1da177e4
LT
188 goto unlock_and_exit;
189 }
190
191 /* Just copy the ACPI name from the Node and zero terminate it */
192
4be44fcd
LB
193 ACPI_STRNCPY(buffer->pointer, acpi_ut_get_node_name(node),
194 ACPI_NAME_SIZE);
195 ((char *)buffer->pointer)[ACPI_NAME_SIZE] = 0;
1da177e4
LT
196 status = AE_OK;
197
4be44fcd 198 unlock_and_exit:
1da177e4 199
4be44fcd 200 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
1da177e4
LT
201 return (status);
202}
1da177e4 203
8313524a 204ACPI_EXPORT_SYMBOL(acpi_get_name)
1da177e4
LT
205
206/******************************************************************************
207 *
208 * FUNCTION: acpi_get_object_info
209 *
210 * PARAMETERS: Handle - Object Handle
44f6c012 211 * Buffer - Where the info is returned
1da177e4
LT
212 *
213 * RETURN: Status
214 *
215 * DESCRIPTION: Returns information about an object as gleaned from the
216 * namespace node and possibly by running several standard
217 * control methods (Such as in the case of a device.)
218 *
219 ******************************************************************************/
1da177e4 220acpi_status
4be44fcd 221acpi_get_object_info(acpi_handle handle, struct acpi_buffer * buffer)
1da177e4 222{
4be44fcd
LB
223 acpi_status status;
224 struct acpi_namespace_node *node;
225 struct acpi_device_info *info;
226 struct acpi_device_info *return_info;
1da177e4 227 struct acpi_compatible_id_list *cid_list = NULL;
4be44fcd 228 acpi_size size;
1da177e4
LT
229
230 /* Parameter validation */
231
232 if (!handle || !buffer) {
233 return (AE_BAD_PARAMETER);
234 }
235
4be44fcd
LB
236 status = acpi_ut_validate_buffer(buffer);
237 if (ACPI_FAILURE(status)) {
1da177e4
LT
238 return (status);
239 }
240
8313524a 241 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_device_info));
1da177e4
LT
242 if (!info) {
243 return (AE_NO_MEMORY);
244 }
245
4be44fcd
LB
246 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
247 if (ACPI_FAILURE(status)) {
1da177e4
LT
248 goto cleanup;
249 }
250
4be44fcd 251 node = acpi_ns_map_handle_to_node(handle);
1da177e4 252 if (!node) {
4be44fcd 253 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
1da177e4
LT
254 goto cleanup;
255 }
256
257 /* Init return structure */
258
4be44fcd 259 size = sizeof(struct acpi_device_info);
1da177e4 260
4be44fcd
LB
261 info->type = node->type;
262 info->name = node->name.integer;
1da177e4
LT
263 info->valid = 0;
264
4be44fcd
LB
265 status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
266 if (ACPI_FAILURE(status)) {
1da177e4
LT
267 goto cleanup;
268 }
269
270 /* If not a device, we are all done */
271
272 if (info->type == ACPI_TYPE_DEVICE) {
273 /*
274 * Get extra info for ACPI Devices objects only:
275 * Run the Device _HID, _UID, _CID, _STA, _ADR and _sx_d methods.
276 *
277 * Note: none of these methods are required, so they may or may
278 * not be present for this device. The Info->Valid bitfield is used
279 * to indicate which methods were found and ran successfully.
280 */
281
282 /* Execute the Device._HID method */
283
4be44fcd
LB
284 status = acpi_ut_execute_HID(node, &info->hardware_id);
285 if (ACPI_SUCCESS(status)) {
1da177e4
LT
286 info->valid |= ACPI_VALID_HID;
287 }
288
289 /* Execute the Device._UID method */
290
4be44fcd
LB
291 status = acpi_ut_execute_UID(node, &info->unique_id);
292 if (ACPI_SUCCESS(status)) {
1da177e4
LT
293 info->valid |= ACPI_VALID_UID;
294 }
295
296 /* Execute the Device._CID method */
297
4be44fcd
LB
298 status = acpi_ut_execute_CID(node, &cid_list);
299 if (ACPI_SUCCESS(status)) {
b8e4d893 300 size += cid_list->size;
1da177e4
LT
301 info->valid |= ACPI_VALID_CID;
302 }
303
304 /* Execute the Device._STA method */
305
4be44fcd
LB
306 status = acpi_ut_execute_STA(node, &info->current_status);
307 if (ACPI_SUCCESS(status)) {
1da177e4
LT
308 info->valid |= ACPI_VALID_STA;
309 }
310
311 /* Execute the Device._ADR method */
312
4be44fcd
LB
313 status = acpi_ut_evaluate_numeric_object(METHOD_NAME__ADR, node,
314 &info->address);
315 if (ACPI_SUCCESS(status)) {
1da177e4
LT
316 info->valid |= ACPI_VALID_ADR;
317 }
318
319 /* Execute the Device._sx_d methods */
320
4be44fcd
LB
321 status = acpi_ut_execute_sxds(node, info->highest_dstates);
322 if (ACPI_SUCCESS(status)) {
1da177e4
LT
323 info->valid |= ACPI_VALID_SXDS;
324 }
325 }
326
327 /* Validate/Allocate/Clear caller buffer */
328
4be44fcd
LB
329 status = acpi_ut_initialize_buffer(buffer, size);
330 if (ACPI_FAILURE(status)) {
1da177e4
LT
331 goto cleanup;
332 }
333
334 /* Populate the return buffer */
335
336 return_info = buffer->pointer;
4be44fcd 337 ACPI_MEMCPY(return_info, info, sizeof(struct acpi_device_info));
1da177e4
LT
338
339 if (cid_list) {
4be44fcd
LB
340 ACPI_MEMCPY(&return_info->compatibility_id, cid_list,
341 cid_list->size);
1da177e4
LT
342 }
343
4be44fcd 344 cleanup:
8313524a 345 ACPI_FREE(info);
1da177e4 346 if (cid_list) {
8313524a 347 ACPI_FREE(cid_list);
1da177e4
LT
348 }
349 return (status);
350}
1da177e4 351
8313524a 352ACPI_EXPORT_SYMBOL(acpi_get_object_info)