nsxfeval.c 24.7 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8
/*******************************************************************************
 *
 * Module Name: nsxfeval - Public interfaces to the ACPI subsystem
 *                         ACPI Object evaluation interfaces
 *
 ******************************************************************************/

/*
L
Len Brown 已提交
9
 * Copyright (C) 2000 - 2008, Intel Corp.
L
Linus Torvalds 已提交
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#include <acpi/acpi.h>
L
Len Brown 已提交
46 47 48
#include "accommon.h"
#include "acnamesp.h"
#include "acinterp.h"
L
Linus Torvalds 已提交
49 50

#define _COMPONENT          ACPI_NAMESPACE
L
Len Brown 已提交
51
ACPI_MODULE_NAME("nsxfeval")
52 53 54 55

/* Local prototypes */
static void acpi_ns_resolve_references(struct acpi_evaluate_info *info);

L
Linus Torvalds 已提交
56 57 58 59 60
/*******************************************************************************
 *
 * FUNCTION:    acpi_evaluate_object_typed
 *
 * PARAMETERS:  Handle              - Object handle (optional)
R
Robert Moore 已提交
61 62
 *              Pathname            - Object pathname (optional)
 *              external_params     - List of parameters to pass to method,
L
Linus Torvalds 已提交
63 64
 *                                    terminated by NULL.  May be NULL
 *                                    if no parameters are being passed.
R
Robert Moore 已提交
65
 *              return_buffer       - Where to put method's return value (if
L
Linus Torvalds 已提交
66 67 68 69 70 71 72 73 74 75
 *                                    any).  If NULL, no value is returned.
 *              return_type         - Expected type of return object
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Find and evaluate the given object, passing the given
 *              parameters if necessary.  One of "Handle" or "Pathname" must
 *              be valid (non-null)
 *
 ******************************************************************************/
76

L
Linus Torvalds 已提交
77
acpi_status
L
Len Brown 已提交
78 79
acpi_evaluate_object_typed(acpi_handle handle,
			   acpi_string pathname,
L
Len Brown 已提交
80 81
			   struct acpi_object_list *external_params,
			   struct acpi_buffer *return_buffer,
L
Len Brown 已提交
82
			   acpi_object_type return_type)
L
Linus Torvalds 已提交
83
{
L
Len Brown 已提交
84 85
	acpi_status status;
	u8 must_free = FALSE;
L
Linus Torvalds 已提交
86

B
Bob Moore 已提交
87
	ACPI_FUNCTION_TRACE(acpi_evaluate_object_typed);
L
Linus Torvalds 已提交
88 89 90 91

	/* Return buffer must be valid */

	if (!return_buffer) {
L
Len Brown 已提交
92
		return_ACPI_STATUS(AE_BAD_PARAMETER);
L
Linus Torvalds 已提交
93 94 95 96 97 98 99 100
	}

	if (return_buffer->length == ACPI_ALLOCATE_BUFFER) {
		must_free = TRUE;
	}

	/* Evaluate the object */

L
Len Brown 已提交
101 102 103 104 105
	status =
	    acpi_evaluate_object(handle, pathname, external_params,
				 return_buffer);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
L
Linus Torvalds 已提交
106 107 108 109 110
	}

	/* Type ANY means "don't care" */

	if (return_type == ACPI_TYPE_ANY) {
L
Len Brown 已提交
111
		return_ACPI_STATUS(AE_OK);
L
Linus Torvalds 已提交
112 113 114
	}

	if (return_buffer->length == 0) {
B
Bob Moore 已提交
115

L
Linus Torvalds 已提交
116 117
		/* Error because caller specifically asked for a return value */

B
Bob Moore 已提交
118
		ACPI_ERROR((AE_INFO, "No return value"));
L
Len Brown 已提交
119
		return_ACPI_STATUS(AE_NULL_OBJECT);
L
Linus Torvalds 已提交
120 121 122 123
	}

	/* Examine the object type returned from evaluate_object */

L
Len Brown 已提交
124 125
	if (((union acpi_object *)return_buffer->pointer)->type == return_type) {
		return_ACPI_STATUS(AE_OK);
L
Linus Torvalds 已提交
126 127 128 129
	}

	/* Return object type does not match requested type */

B
Bob Moore 已提交
130 131 132 133 134
	ACPI_ERROR((AE_INFO,
		    "Incorrect return type [%s] requested [%s]",
		    acpi_ut_get_type_name(((union acpi_object *)return_buffer->
					   pointer)->type),
		    acpi_ut_get_type_name(return_type)));
L
Linus Torvalds 已提交
135 136

	if (must_free) {
B
Bob Moore 已提交
137

L
Linus Torvalds 已提交
138 139
		/* Caller used ACPI_ALLOCATE_BUFFER, free the return buffer */

140
		ACPI_FREE(return_buffer->pointer);
L
Linus Torvalds 已提交
141 142 143 144
		return_buffer->pointer = NULL;
	}

	return_buffer->length = 0;
L
Len Brown 已提交
145
	return_ACPI_STATUS(AE_TYPE);
L
Linus Torvalds 已提交
146
}
B
Bob Moore 已提交
147 148

ACPI_EXPORT_SYMBOL(acpi_evaluate_object_typed)
149

L
Linus Torvalds 已提交
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
/*******************************************************************************
 *
 * FUNCTION:    acpi_evaluate_object
 *
 * PARAMETERS:  Handle              - Object handle (optional)
 *              Pathname            - Object pathname (optional)
 *              external_params     - List of parameters to pass to method,
 *                                    terminated by NULL.  May be NULL
 *                                    if no parameters are being passed.
 *              return_buffer       - Where to put method's return value (if
 *                                    any).  If NULL, no value is returned.
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Find and evaluate the given object, passing the given
 *              parameters if necessary.  One of "Handle" or "Pathname" must
 *              be valid (non-null)
 *
 ******************************************************************************/
acpi_status
L
Len Brown 已提交
170 171 172 173
acpi_evaluate_object(acpi_handle handle,
		     acpi_string pathname,
		     struct acpi_object_list *external_params,
		     struct acpi_buffer *return_buffer)
L
Linus Torvalds 已提交
174
{
L
Len Brown 已提交
175
	acpi_status status;
B
Bob Moore 已提交
176
	struct acpi_evaluate_info *info;
L
Len Brown 已提交
177 178
	acpi_size buffer_space_needed;
	u32 i;
L
Linus Torvalds 已提交
179

B
Bob Moore 已提交
180
	ACPI_FUNCTION_TRACE(acpi_evaluate_object);
L
Linus Torvalds 已提交
181

B
Bob Moore 已提交
182 183 184 185 186 187 188 189 190 191 192
	/* Allocate and initialize the evaluation information block */

	info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
	if (!info) {
		return_ACPI_STATUS(AE_NO_MEMORY);
	}

	info->pathname = pathname;

	/* Convert and validate the device handle */

193
	info->prefix_node = acpi_ns_validate_handle(handle);
B
Bob Moore 已提交
194 195 196 197
	if (!info->prefix_node) {
		status = AE_BAD_PARAMETER;
		goto cleanup;
	}
L
Linus Torvalds 已提交
198 199

	/*
B
Bob Moore 已提交
200 201
	 * If there are parameters to be passed to a control method, the external
	 * objects must all be converted to internal objects
L
Linus Torvalds 已提交
202 203 204 205 206 207
	 */
	if (external_params && external_params->count) {
		/*
		 * Allocate a new parameter block for the internal objects
		 * Add 1 to count to allow for null terminated internal list
		 */
B
Bob Moore 已提交
208 209 210 211 212 213 214
		info->parameters = ACPI_ALLOCATE_ZEROED(((acpi_size)
							 external_params->
							 count +
							 1) * sizeof(void *));
		if (!info->parameters) {
			status = AE_NO_MEMORY;
			goto cleanup;
L
Linus Torvalds 已提交
215 216
		}

B
Bob Moore 已提交
217 218
		/* Convert each external object in the list to an internal object */

L
Linus Torvalds 已提交
219
		for (i = 0; i < external_params->count; i++) {
L
Len Brown 已提交
220 221 222
			status =
			    acpi_ut_copy_eobject_to_iobject(&external_params->
							    pointer[i],
B
Bob Moore 已提交
223
							    &info->
L
Len Brown 已提交
224 225
							    parameters[i]);
			if (ACPI_FAILURE(status)) {
B
Bob Moore 已提交
226
				goto cleanup;
L
Linus Torvalds 已提交
227 228
			}
		}
B
Bob Moore 已提交
229
		info->parameters[external_params->count] = NULL;
L
Linus Torvalds 已提交
230 231 232 233 234 235 236 237
	}

	/*
	 * Three major cases:
	 * 1) Fully qualified pathname
	 * 2) No handle, not fully qualified pathname (error)
	 * 3) Valid handle
	 */
L
Len Brown 已提交
238
	if ((pathname) && (acpi_ns_valid_root_prefix(pathname[0]))) {
B
Bob Moore 已提交
239 240 241

		/* The path is fully qualified, just evaluate by name */

B
Bob Moore 已提交
242 243
		info->prefix_node = NULL;
		status = acpi_ns_evaluate(info);
L
Len Brown 已提交
244
	} else if (!handle) {
L
Linus Torvalds 已提交
245
		/*
B
Bob Moore 已提交
246 247 248
		 * A handle is optional iff a fully qualified pathname is specified.
		 * Since we've already handled fully qualified names above, this is
		 * an error
L
Linus Torvalds 已提交
249 250
		 */
		if (!pathname) {
B
Bob Moore 已提交
251 252
			ACPI_DEBUG_PRINT((ACPI_DB_INFO,
					  "Both Handle and Pathname are NULL"));
L
Len Brown 已提交
253
		} else {
B
Bob Moore 已提交
254 255 256
			ACPI_DEBUG_PRINT((ACPI_DB_INFO,
					  "Null Handle with relative pathname [%s]",
					  pathname));
L
Linus Torvalds 已提交
257 258 259
		}

		status = AE_BAD_PARAMETER;
L
Len Brown 已提交
260
	} else {
B
Bob Moore 已提交
261
		/* We have a namespace a node and a possible relative path */
B
Bob Moore 已提交
262

B
Bob Moore 已提交
263
		status = acpi_ns_evaluate(info);
L
Linus Torvalds 已提交
264 265 266 267 268 269 270
	}

	/*
	 * If we are expecting a return value, and all went well above,
	 * copy the return value to an external object.
	 */
	if (return_buffer) {
B
Bob Moore 已提交
271
		if (!info->return_object) {
L
Linus Torvalds 已提交
272
			return_buffer->length = 0;
L
Len Brown 已提交
273
		} else {
B
Bob Moore 已提交
274
			if (ACPI_GET_DESCRIPTOR_TYPE(info->return_object) ==
L
Len Brown 已提交
275
			    ACPI_DESC_TYPE_NAMED) {
L
Linus Torvalds 已提交
276 277 278 279 280 281 282 283 284
				/*
				 * If we received a NS Node as a return object, this means that
				 * the object we are evaluating has nothing interesting to
				 * return (such as a mutex, etc.)  We return an error because
				 * these types are essentially unsupported by this interface.
				 * We don't check up front because this makes it easier to add
				 * support for various types at a later date if necessary.
				 */
				status = AE_TYPE;
B
Bob Moore 已提交
285
				info->return_object = NULL;	/* No need to delete a NS Node */
L
Linus Torvalds 已提交
286 287 288
				return_buffer->length = 0;
			}

L
Len Brown 已提交
289
			if (ACPI_SUCCESS(status)) {
B
Bob Moore 已提交
290

291 292 293 294
				/* Dereference Index and ref_of references */

				acpi_ns_resolve_references(info);

B
Bob Moore 已提交
295 296
				/* Get the size of the returned object */

L
Len Brown 已提交
297
				status =
B
Bob Moore 已提交
298
				    acpi_ut_get_object_size(info->return_object,
L
Len Brown 已提交
299 300
							    &buffer_space_needed);
				if (ACPI_SUCCESS(status)) {
B
Bob Moore 已提交
301

L
Linus Torvalds 已提交
302 303
					/* Validate/Allocate/Clear caller buffer */

L
Len Brown 已提交
304 305 306 307 308
					status =
					    acpi_ut_initialize_buffer
					    (return_buffer,
					     buffer_space_needed);
					if (ACPI_FAILURE(status)) {
L
Linus Torvalds 已提交
309
						/*
B
Bob Moore 已提交
310 311
						 * Caller's buffer is too small or a new one can't
						 * be allocated
L
Linus Torvalds 已提交
312
						 */
L
Len Brown 已提交
313 314 315 316 317 318 319
						ACPI_DEBUG_PRINT((ACPI_DB_INFO,
								  "Needed buffer size %X, %s\n",
								  (u32)
								  buffer_space_needed,
								  acpi_format_exception
								  (status)));
					} else {
B
Bob Moore 已提交
320 321
						/* We have enough space for the object, build it */

L
Len Brown 已提交
322 323
						status =
						    acpi_ut_copy_iobject_to_eobject
B
Bob Moore 已提交
324
						    (info->return_object,
L
Len Brown 已提交
325
						     return_buffer);
L
Linus Torvalds 已提交
326 327 328 329 330 331
					}
				}
			}
		}
	}

B
Bob Moore 已提交
332
	if (info->return_object) {
L
Linus Torvalds 已提交
333
		/*
B
Bob Moore 已提交
334 335
		 * Delete the internal return object. NOTE: Interpreter must be
		 * locked to avoid race condition.
L
Linus Torvalds 已提交
336
		 */
337
		acpi_ex_enter_interpreter();
B
Bob Moore 已提交
338

339
		/* Remove one reference on the return object (should delete it) */
B
Bob Moore 已提交
340

341 342
		acpi_ut_remove_reference(info->return_object);
		acpi_ex_exit_interpreter();
L
Linus Torvalds 已提交
343 344
	}

B
Bob Moore 已提交
345 346
      cleanup:

B
Bob Moore 已提交
347 348
	/* Free the input parameter list (if we created one) */

B
Bob Moore 已提交
349
	if (info->parameters) {
B
Bob Moore 已提交
350

L
Linus Torvalds 已提交
351 352
		/* Free the allocated parameter block */

B
Bob Moore 已提交
353
		acpi_ut_delete_internal_object_list(info->parameters);
L
Linus Torvalds 已提交
354 355
	}

B
Bob Moore 已提交
356
	ACPI_FREE(info);
L
Len Brown 已提交
357
	return_ACPI_STATUS(status);
L
Linus Torvalds 已提交
358 359
}

B
Bob Moore 已提交
360
ACPI_EXPORT_SYMBOL(acpi_evaluate_object)
L
Linus Torvalds 已提交
361

362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
/*******************************************************************************
 *
 * FUNCTION:    acpi_ns_resolve_references
 *
 * PARAMETERS:  Info                    - Evaluation info block
 *
 * RETURN:      Info->return_object is replaced with the dereferenced object
 *
 * DESCRIPTION: Dereference certain reference objects. Called before an
 *              internal return object is converted to an external union acpi_object.
 *
 * Performs an automatic dereference of Index and ref_of reference objects.
 * These reference objects are not supported by the union acpi_object, so this is a
 * last resort effort to return something useful. Also, provides compatibility
 * with other ACPI implementations.
 *
 * NOTE: does not handle references within returned package objects or nested
 * references, but this support could be added later if found to be necessary.
 *
 ******************************************************************************/
static void acpi_ns_resolve_references(struct acpi_evaluate_info *info)
{
	union acpi_operand_object *obj_desc = NULL;
	struct acpi_namespace_node *node;

	/* We are interested in reference objects only */

389
	if ((info->return_object)->common.type != ACPI_TYPE_LOCAL_REFERENCE) {
390 391 392 393 394 395 396 397 398 399
		return;
	}

	/*
	 * Two types of references are supported - those created by Index and
	 * ref_of operators. A name reference (AML_NAMEPATH_OP) can be converted
	 * to an union acpi_object, so it is not dereferenced here. A ddb_handle
	 * (AML_LOAD_OP) cannot be dereferenced, nor can it be converted to
	 * an union acpi_object.
	 */
400 401
	switch (info->return_object->reference.class) {
	case ACPI_REFCLASS_INDEX:
402 403 404 405

		obj_desc = *(info->return_object->reference.where);
		break;

406
	case ACPI_REFCLASS_REFOF:
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428

		node = info->return_object->reference.object;
		if (node) {
			obj_desc = node->object;
		}
		break;

	default:
		return;
	}

	/* Replace the existing reference object */

	if (obj_desc) {
		acpi_ut_add_reference(obj_desc);
		acpi_ut_remove_reference(info->return_object);
		info->return_object = obj_desc;
	}

	return;
}

L
Linus Torvalds 已提交
429 430 431 432 433 434 435
/*******************************************************************************
 *
 * FUNCTION:    acpi_walk_namespace
 *
 * PARAMETERS:  Type                - acpi_object_type to search for
 *              start_object        - Handle in namespace where search begins
 *              max_depth           - Depth to which search is to reach
436 437 438 439 440
 *              pre_order_visit     - Called during tree pre-order visit
 *                                    when an object of "Type" is found
 *              post_order_visit    - Called during tree post-order visit
 *                                    when an object of "Type" is found
 *              Context             - Passed to user function(s) above
L
Linus Torvalds 已提交
441 442 443 444 445 446 447 448
 *              return_value        - Location where return value of
 *                                    user_function is put if terminated early
 *
 * RETURNS      Return value from the user_function if terminated early.
 *              Otherwise, returns NULL.
 *
 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
 *              starting (and ending) at the object specified by start_handle.
449 450
 *              The callback function is called whenever an object that matches
 *              the type parameter is found. If the callback function returns
L
Linus Torvalds 已提交
451 452 453 454 455
 *              a non-zero value, the search is terminated immediately and this
 *              value is returned to the caller.
 *
 *              The point of this procedure is to provide a generic namespace
 *              walk routine that can be called from multiple places to
456 457 458
 *              provide multiple services; the callback function(s) can be
 *              tailored to each task, whether it is a print function,
 *              a compare function, etc.
L
Linus Torvalds 已提交
459 460
 *
 ******************************************************************************/
461

L
Linus Torvalds 已提交
462
acpi_status
L
Len Brown 已提交
463 464 465
acpi_walk_namespace(acpi_object_type type,
		    acpi_handle start_object,
		    u32 max_depth,
466 467
		    acpi_walk_callback pre_order_visit,
		    acpi_walk_callback post_order_visit,
L
Len Brown 已提交
468
		    void *context, void **return_value)
L
Linus Torvalds 已提交
469
{
L
Len Brown 已提交
470
	acpi_status status;
L
Linus Torvalds 已提交
471

B
Bob Moore 已提交
472
	ACPI_FUNCTION_TRACE(acpi_walk_namespace);
L
Linus Torvalds 已提交
473 474 475

	/* Parameter validation */

476 477
	if ((type > ACPI_TYPE_LOCAL_MAX) ||
	    (!max_depth) || (!pre_order_visit && !post_order_visit)) {
L
Len Brown 已提交
478
		return_ACPI_STATUS(AE_BAD_PARAMETER);
L
Linus Torvalds 已提交
479 480 481
	}

	/*
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
	 * Need to acquire the namespace reader lock to prevent interference
	 * with any concurrent table unloads (which causes the deletion of
	 * namespace objects). We cannot allow the deletion of a namespace node
	 * while the user function is using it. The exception to this are the
	 * nodes created and deleted during control method execution -- these
	 * nodes are marked as temporary nodes and are ignored by the namespace
	 * walk. Thus, control methods can be executed while holding the
	 * namespace deletion lock (and the user function can execute control
	 * methods.)
	 */
	status = acpi_ut_acquire_read_lock(&acpi_gbl_namespace_rw_lock);
	if (ACPI_FAILURE(status)) {
		return status;
	}

	/*
	 * Lock the namespace around the walk. The namespace will be
	 * unlocked/locked around each call to the user function - since the user
	 * function must be allowed to make ACPICA calls itself (for example, it
	 * will typically execute control methods during device enumeration.)
L
Linus Torvalds 已提交
502
	 */
L
Len Brown 已提交
503 504
	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	if (ACPI_FAILURE(status)) {
505
		goto unlock_and_exit;
L
Linus Torvalds 已提交
506 507
	}

L
Len Brown 已提交
508
	status = acpi_ns_walk_namespace(type, start_object, max_depth,
509 510 511
					ACPI_NS_WALK_UNLOCK, pre_order_visit,
					post_order_visit, context,
					return_value);
L
Linus Torvalds 已提交
512

L
Len Brown 已提交
513
	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
514 515 516

      unlock_and_exit:
	(void)acpi_ut_release_read_lock(&acpi_gbl_namespace_rw_lock);
L
Len Brown 已提交
517
	return_ACPI_STATUS(status);
L
Linus Torvalds 已提交
518 519
}

B
Bob Moore 已提交
520
ACPI_EXPORT_SYMBOL(acpi_walk_namespace)
L
Linus Torvalds 已提交
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535

/*******************************************************************************
 *
 * FUNCTION:    acpi_ns_get_device_callback
 *
 * PARAMETERS:  Callback from acpi_get_device
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Takes callbacks from walk_namespace and filters out all non-
 *              present devices, or if they specified a HID, it filters based
 *              on that.
 *
 ******************************************************************************/
static acpi_status
L
Len Brown 已提交
536 537 538
acpi_ns_get_device_callback(acpi_handle obj_handle,
			    u32 nesting_level,
			    void *context, void **return_value)
L
Linus Torvalds 已提交
539
{
L
Len Brown 已提交
540 541 542 543
	struct acpi_get_devices_info *info = context;
	acpi_status status;
	struct acpi_namespace_node *node;
	u32 flags;
544 545
	struct acpica_device_id *hid;
	struct acpica_device_id_list *cid;
546
	u32 i;
547 548
	u8 found;
	int no_match;
L
Linus Torvalds 已提交
549

L
Len Brown 已提交
550 551
	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	if (ACPI_FAILURE(status)) {
L
Linus Torvalds 已提交
552 553 554
		return (status);
	}

555
	node = acpi_ns_validate_handle(obj_handle);
L
Len Brown 已提交
556 557
	status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
	if (ACPI_FAILURE(status)) {
L
Linus Torvalds 已提交
558 559 560 561 562 563 564 565 566
		return (status);
	}

	if (!node) {
		return (AE_BAD_PARAMETER);
	}

	/* Run _STA to determine if device is present */

L
Len Brown 已提交
567 568
	status = acpi_ut_execute_STA(node, &flags);
	if (ACPI_FAILURE(status)) {
L
Linus Torvalds 已提交
569 570 571
		return (AE_CTRL_DEPTH);
	}

572 573 574 575 576 577 578
	if (!(flags & ACPI_STA_DEVICE_PRESENT) &&
	    !(flags & ACPI_STA_DEVICE_FUNCTIONING)) {
		/*
		 * Don't examine the children of the device only when the
		 * device is neither present nor functional. See ACPI spec,
		 * description of _STA for more information.
		 */
L
Linus Torvalds 已提交
579 580 581 582 583 584
		return (AE_CTRL_DEPTH);
	}

	/* Filter based on device HID & CID */

	if (info->hid != NULL) {
L
Len Brown 已提交
585
		status = acpi_ut_execute_HID(node, &hid);
L
Linus Torvalds 已提交
586 587
		if (status == AE_NOT_FOUND) {
			return (AE_OK);
L
Len Brown 已提交
588
		} else if (ACPI_FAILURE(status)) {
L
Linus Torvalds 已提交
589 590 591
			return (AE_CTRL_DEPTH);
		}

592 593
		no_match = ACPI_STRCMP(hid->string, info->hid);
		ACPI_FREE(hid);
L
Linus Torvalds 已提交
594

595 596 597 598 599
		if (no_match) {
			/*
			 * HID does not match, attempt match within the
			 * list of Compatible IDs (CIDs)
			 */
L
Len Brown 已提交
600
			status = acpi_ut_execute_CID(node, &cid);
L
Linus Torvalds 已提交
601 602
			if (status == AE_NOT_FOUND) {
				return (AE_OK);
L
Len Brown 已提交
603
			} else if (ACPI_FAILURE(status)) {
L
Linus Torvalds 已提交
604 605 606 607 608
				return (AE_CTRL_DEPTH);
			}

			/* Walk the CID list */

609
			found = 0;
L
Linus Torvalds 已提交
610
			for (i = 0; i < cid->count; i++) {
611 612
				if (ACPI_STRCMP(cid->ids[i].string, info->hid)
				    == 0) {
613 614
					found = 1;
					break;
L
Linus Torvalds 已提交
615 616
				}
			}
B
Bob Moore 已提交
617
			ACPI_FREE(cid);
618 619
			if (!found)
				return (AE_OK);
L
Linus Torvalds 已提交
620 621 622
		}
	}

L
Len Brown 已提交
623 624
	status = info->user_function(obj_handle, nesting_level, info->context,
				     return_value);
L
Linus Torvalds 已提交
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
	return (status);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_get_devices
 *
 * PARAMETERS:  HID                 - HID to search for. Can be NULL.
 *              user_function       - Called when a matching object is found
 *              Context             - Passed to user function
 *              return_value        - Location where return value of
 *                                    user_function is put if terminated early
 *
 * RETURNS      Return value from the user_function if terminated early.
 *              Otherwise, returns NULL.
 *
 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
 *              starting (and ending) at the object specified by start_handle.
 *              The user_function is called whenever an object of type
 *              Device is found.  If the user function returns
 *              a non-zero value, the search is terminated immediately and this
 *              value is returned to the caller.
 *
 *              This is a wrapper for walk_namespace, but the callback performs
649
 *              additional filtering. Please see acpi_ns_get_device_callback.
L
Linus Torvalds 已提交
650 651 652 653
 *
 ******************************************************************************/

acpi_status
654
acpi_get_devices(const char *HID,
L
Len Brown 已提交
655 656
		 acpi_walk_callback user_function,
		 void *context, void **return_value)
L
Linus Torvalds 已提交
657
{
L
Len Brown 已提交
658 659
	acpi_status status;
	struct acpi_get_devices_info info;
L
Linus Torvalds 已提交
660

B
Bob Moore 已提交
661
	ACPI_FUNCTION_TRACE(acpi_get_devices);
L
Linus Torvalds 已提交
662 663 664 665

	/* Parameter validation */

	if (!user_function) {
L
Len Brown 已提交
666
		return_ACPI_STATUS(AE_BAD_PARAMETER);
L
Linus Torvalds 已提交
667 668 669 670 671 672
	}

	/*
	 * We're going to call their callback from OUR callback, so we need
	 * to know what it is, and their context parameter.
	 */
B
Bob Moore 已提交
673
	info.hid = HID;
L
Len Brown 已提交
674
	info.context = context;
L
Linus Torvalds 已提交
675 676 677 678 679 680 681 682
	info.user_function = user_function;

	/*
	 * Lock the namespace around the walk.
	 * The namespace will be unlocked/locked around each call
	 * to the user function - since this function
	 * must be allowed to make Acpi calls itself.
	 */
L
Len Brown 已提交
683 684 685
	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
L
Linus Torvalds 已提交
686 687
	}

B
Bob Moore 已提交
688 689
	status = acpi_ns_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
					ACPI_UINT32_MAX, ACPI_NS_WALK_UNLOCK,
690 691
					acpi_ns_get_device_callback, NULL,
					&info, return_value);
L
Linus Torvalds 已提交
692

L
Len Brown 已提交
693 694
	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
	return_ACPI_STATUS(status);
L
Linus Torvalds 已提交
695 696
}

B
Bob Moore 已提交
697
ACPI_EXPORT_SYMBOL(acpi_get_devices)
L
Linus Torvalds 已提交
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712

/*******************************************************************************
 *
 * FUNCTION:    acpi_attach_data
 *
 * PARAMETERS:  obj_handle          - Namespace node
 *              Handler             - Handler for this attachment
 *              Data                - Pointer to data to be attached
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Attach arbitrary data and handler to a namespace node.
 *
 ******************************************************************************/
acpi_status
L
Len Brown 已提交
713 714
acpi_attach_data(acpi_handle obj_handle,
		 acpi_object_handler handler, void *data)
L
Linus Torvalds 已提交
715
{
L
Len Brown 已提交
716 717
	struct acpi_namespace_node *node;
	acpi_status status;
L
Linus Torvalds 已提交
718 719 720

	/* Parameter validation */

L
Len Brown 已提交
721
	if (!obj_handle || !handler || !data) {
L
Linus Torvalds 已提交
722 723 724
		return (AE_BAD_PARAMETER);
	}

L
Len Brown 已提交
725 726
	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	if (ACPI_FAILURE(status)) {
L
Linus Torvalds 已提交
727 728 729 730 731
		return (status);
	}

	/* Convert and validate the handle */

732
	node = acpi_ns_validate_handle(obj_handle);
L
Linus Torvalds 已提交
733 734 735 736 737
	if (!node) {
		status = AE_BAD_PARAMETER;
		goto unlock_and_exit;
	}

L
Len Brown 已提交
738
	status = acpi_ns_attach_data(node, handler, data);
L
Linus Torvalds 已提交
739

L
Len Brown 已提交
740 741
      unlock_and_exit:
	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
L
Linus Torvalds 已提交
742 743 744
	return (status);
}

B
Bob Moore 已提交
745 746
ACPI_EXPORT_SYMBOL(acpi_attach_data)

L
Linus Torvalds 已提交
747 748 749 750 751 752 753 754 755 756 757 758 759
/*******************************************************************************
 *
 * FUNCTION:    acpi_detach_data
 *
 * PARAMETERS:  obj_handle          - Namespace node handle
 *              Handler             - Handler used in call to acpi_attach_data
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Remove data that was previously attached to a node.
 *
 ******************************************************************************/
acpi_status
L
Len Brown 已提交
760
acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler)
L
Linus Torvalds 已提交
761
{
L
Len Brown 已提交
762 763
	struct acpi_namespace_node *node;
	acpi_status status;
L
Linus Torvalds 已提交
764 765 766

	/* Parameter validation */

L
Len Brown 已提交
767
	if (!obj_handle || !handler) {
L
Linus Torvalds 已提交
768 769 770
		return (AE_BAD_PARAMETER);
	}

L
Len Brown 已提交
771 772
	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	if (ACPI_FAILURE(status)) {
L
Linus Torvalds 已提交
773 774 775 776 777
		return (status);
	}

	/* Convert and validate the handle */

778
	node = acpi_ns_validate_handle(obj_handle);
L
Linus Torvalds 已提交
779 780 781 782 783
	if (!node) {
		status = AE_BAD_PARAMETER;
		goto unlock_and_exit;
	}

L
Len Brown 已提交
784
	status = acpi_ns_detach_data(node, handler);
L
Linus Torvalds 已提交
785

L
Len Brown 已提交
786 787
      unlock_and_exit:
	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
L
Linus Torvalds 已提交
788 789 790
	return (status);
}

B
Bob Moore 已提交
791 792
ACPI_EXPORT_SYMBOL(acpi_detach_data)

L
Linus Torvalds 已提交
793 794 795 796 797 798 799 800 801 802 803 804 805 806
/*******************************************************************************
 *
 * FUNCTION:    acpi_get_data
 *
 * PARAMETERS:  obj_handle          - Namespace node
 *              Handler             - Handler used in call to attach_data
 *              Data                - Where the data is returned
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Retrieve data that was previously attached to a namespace node.
 *
 ******************************************************************************/
acpi_status
L
Len Brown 已提交
807
acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data)
L
Linus Torvalds 已提交
808
{
L
Len Brown 已提交
809 810
	struct acpi_namespace_node *node;
	acpi_status status;
L
Linus Torvalds 已提交
811 812 813

	/* Parameter validation */

L
Len Brown 已提交
814
	if (!obj_handle || !handler || !data) {
L
Linus Torvalds 已提交
815 816 817
		return (AE_BAD_PARAMETER);
	}

L
Len Brown 已提交
818 819
	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	if (ACPI_FAILURE(status)) {
L
Linus Torvalds 已提交
820 821 822 823 824
		return (status);
	}

	/* Convert and validate the handle */

825
	node = acpi_ns_validate_handle(obj_handle);
L
Linus Torvalds 已提交
826 827 828 829 830
	if (!node) {
		status = AE_BAD_PARAMETER;
		goto unlock_and_exit;
	}

L
Len Brown 已提交
831
	status = acpi_ns_get_attached_data(node, handler, data);
L
Linus Torvalds 已提交
832

L
Len Brown 已提交
833 834
      unlock_and_exit:
	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
L
Linus Torvalds 已提交
835 836
	return (status);
}
B
Bob Moore 已提交
837 838

ACPI_EXPORT_SYMBOL(acpi_get_data)