nsxfeval.c 25.4 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
 *
 ******************************************************************************/

/*
9
 * Copyright (C) 2000 - 2013, 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
 * 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.
 */

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

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

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

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

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

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

	/* Return buffer must be valid */

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

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

	/* Evaluate the object */

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

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

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

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

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

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

	/* Examine the object type returned from evaluate_object */

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

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

B
Bob Moore 已提交
131 132 133 134 135
	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 已提交
136 137

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

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

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

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

ACPI_EXPORT_SYMBOL(acpi_evaluate_object_typed)
150

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

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

B
Bob Moore 已提交
183 184 185 186 187 188 189 190 191 192 193
	/* 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 */

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

	/*
B
Bob Moore 已提交
201 202
	 * If there are parameters to be passed to a control method, the external
	 * objects must all be converted to internal objects
L
Linus Torvalds 已提交
203 204 205 206 207 208
	 */
	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 已提交
209 210 211 212 213 214 215
		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 已提交
216 217
		}

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

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

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

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

B
Bob Moore 已提交
243 244
		info->prefix_node = NULL;
		status = acpi_ns_evaluate(info);
L
Len Brown 已提交
245
	} else if (!handle) {
L
Linus Torvalds 已提交
246
		/*
B
Bob Moore 已提交
247 248 249
		 * 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 已提交
250 251
		 */
		if (!pathname) {
B
Bob Moore 已提交
252 253
			ACPI_DEBUG_PRINT((ACPI_DB_INFO,
					  "Both Handle and Pathname are NULL"));
L
Len Brown 已提交
254
		} else {
B
Bob Moore 已提交
255 256 257
			ACPI_DEBUG_PRINT((ACPI_DB_INFO,
					  "Null Handle with relative pathname [%s]",
					  pathname));
L
Linus Torvalds 已提交
258 259 260
		}

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

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

	/*
	 * 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 已提交
272
		if (!info->return_object) {
L
Linus Torvalds 已提交
273
			return_buffer->length = 0;
L
Len Brown 已提交
274
		} else {
B
Bob Moore 已提交
275
			if (ACPI_GET_DESCRIPTOR_TYPE(info->return_object) ==
L
Len Brown 已提交
276
			    ACPI_DESC_TYPE_NAMED) {
L
Linus Torvalds 已提交
277 278 279 280 281 282 283 284 285
				/*
				 * 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 已提交
286
				info->return_object = NULL;	/* No need to delete a NS Node */
L
Linus Torvalds 已提交
287 288 289
				return_buffer->length = 0;
			}

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

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

				acpi_ns_resolve_references(info);

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

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

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

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

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

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

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

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

B
Bob Moore 已提交
346 347
      cleanup:

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

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

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

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

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

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

363 364 365 366
/*******************************************************************************
 *
 * FUNCTION:    acpi_ns_resolve_references
 *
367
 * PARAMETERS:  info                    - Evaluation info block
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
 *
 * 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 */

390
	if ((info->return_object)->common.type != ACPI_TYPE_LOCAL_REFERENCE) {
391 392 393 394 395 396 397 398 399 400
		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.
	 */
401 402
	switch (info->return_object->reference.class) {
	case ACPI_REFCLASS_INDEX:
403 404 405 406

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

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

		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 已提交
430 431 432 433
/*******************************************************************************
 *
 * FUNCTION:    acpi_walk_namespace
 *
434
 * PARAMETERS:  type                - acpi_object_type to search for
L
Linus Torvalds 已提交
435 436
 *              start_object        - Handle in namespace where search begins
 *              max_depth           - Depth to which search is to reach
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
441
 *              context             - Passed to user function(s) above
L
Linus Torvalds 已提交
442 443 444 445 446 447 448 449
 *              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.
450 451
 *              The callback function is called whenever an object that matches
 *              the type parameter is found. If the callback function returns
L
Linus Torvalds 已提交
452 453 454 455 456
 *              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
457 458 459
 *              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 已提交
460 461
 *
 ******************************************************************************/
462

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

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

	/* Parameter validation */

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

	/*
483 484 485 486 487 488 489 490 491 492 493 494
	 * 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)) {
495
		return_ACPI_STATUS(status);
496 497 498 499 500 501 502
	}

	/*
	 * 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 已提交
503
	 */
L
Len Brown 已提交
504 505
	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	if (ACPI_FAILURE(status)) {
506
		goto unlock_and_exit;
L
Linus Torvalds 已提交
507 508
	}

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

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

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

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

/*******************************************************************************
 *
 * 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 已提交
537 538 539
acpi_ns_get_device_callback(acpi_handle obj_handle,
			    u32 nesting_level,
			    void *context, void **return_value)
L
Linus Torvalds 已提交
540
{
L
Len Brown 已提交
541 542 543 544
	struct acpi_get_devices_info *info = context;
	acpi_status status;
	struct acpi_namespace_node *node;
	u32 flags;
545 546
	struct acpi_pnp_device_id *hid;
	struct acpi_pnp_device_id_list *cid;
547
	u32 i;
548 549
	u8 found;
	int no_match;
L
Linus Torvalds 已提交
550

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

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

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

566 567 568 569 570 571 572 573 574 575 576 577 578 579
	/*
	 * First, filter based on the device HID and CID.
	 *
	 * 01/2010: For this case where a specific HID is requested, we don't
	 * want to run _STA until we have an actual HID match. Thus, we will
	 * not unnecessarily execute _STA on devices for which the caller
	 * doesn't care about. Previously, _STA was executed unconditionally
	 * on all devices found here.
	 *
	 * A side-effect of this change is that now we will continue to search
	 * for a matching HID even under device trees where the parent device
	 * would have returned a _STA that indicates it is not present or
	 * not functioning (thus aborting the search on that branch).
	 */
L
Linus Torvalds 已提交
580
	if (info->hid != NULL) {
L
Len Brown 已提交
581
		status = acpi_ut_execute_HID(node, &hid);
L
Linus Torvalds 已提交
582 583
		if (status == AE_NOT_FOUND) {
			return (AE_OK);
L
Len Brown 已提交
584
		} else if (ACPI_FAILURE(status)) {
L
Linus Torvalds 已提交
585 586 587
			return (AE_CTRL_DEPTH);
		}

588 589
		no_match = ACPI_STRCMP(hid->string, info->hid);
		ACPI_FREE(hid);
L
Linus Torvalds 已提交
590

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

			/* Walk the CID list */

605
			found = FALSE;
L
Linus Torvalds 已提交
606
			for (i = 0; i < cid->count; i++) {
607 608
				if (ACPI_STRCMP(cid->ids[i].string, info->hid)
				    == 0) {
609

L
Lv Zheng 已提交
610
					/* Found a matching CID */
611

612
					found = TRUE;
613
					break;
L
Linus Torvalds 已提交
614 615
				}
			}
616

B
Bob Moore 已提交
617
			ACPI_FREE(cid);
618
			if (!found) {
619
				return (AE_OK);
620
			}
L
Linus Torvalds 已提交
621 622 623
		}
	}

624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
	/* Run _STA to determine if device is present */

	status = acpi_ut_execute_STA(node, &flags);
	if (ACPI_FAILURE(status)) {
		return (AE_CTRL_DEPTH);
	}

	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.
		 */
		return (AE_CTRL_DEPTH);
	}

	/* We have a valid device, invoke the user function */

L
Len Brown 已提交
643 644
	status = info->user_function(obj_handle, nesting_level, info->context,
				     return_value);
L
Linus Torvalds 已提交
645 646 647 648 649 650 651 652 653
	return (status);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_get_devices
 *
 * PARAMETERS:  HID                 - HID to search for. Can be NULL.
 *              user_function       - Called when a matching object is found
654
 *              context             - Passed to user function
L
Linus Torvalds 已提交
655 656 657 658 659 660 661 662 663
 *              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
664
 *              Device is found. If the user function returns
L
Linus Torvalds 已提交
665 666 667 668
 *              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
669
 *              additional filtering. Please see acpi_ns_get_device_callback.
L
Linus Torvalds 已提交
670 671 672 673
 *
 ******************************************************************************/

acpi_status
674
acpi_get_devices(const char *HID,
L
Len Brown 已提交
675 676
		 acpi_walk_callback user_function,
		 void *context, void **return_value)
L
Linus Torvalds 已提交
677
{
L
Len Brown 已提交
678 679
	acpi_status status;
	struct acpi_get_devices_info info;
L
Linus Torvalds 已提交
680

B
Bob Moore 已提交
681
	ACPI_FUNCTION_TRACE(acpi_get_devices);
L
Linus Torvalds 已提交
682 683 684 685

	/* Parameter validation */

	if (!user_function) {
L
Len Brown 已提交
686
		return_ACPI_STATUS(AE_BAD_PARAMETER);
L
Linus Torvalds 已提交
687 688 689 690 691 692
	}

	/*
	 * 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 已提交
693
	info.hid = HID;
L
Len Brown 已提交
694
	info.context = context;
L
Linus Torvalds 已提交
695 696 697 698 699 700 701 702
	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 已提交
703 704 705
	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
L
Linus Torvalds 已提交
706 707
	}

B
Bob Moore 已提交
708 709
	status = acpi_ns_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
					ACPI_UINT32_MAX, ACPI_NS_WALK_UNLOCK,
710 711
					acpi_ns_get_device_callback, NULL,
					&info, return_value);
L
Linus Torvalds 已提交
712

L
Len Brown 已提交
713 714
	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
	return_ACPI_STATUS(status);
L
Linus Torvalds 已提交
715 716
}

B
Bob Moore 已提交
717
ACPI_EXPORT_SYMBOL(acpi_get_devices)
L
Linus Torvalds 已提交
718 719 720 721 722 723

/*******************************************************************************
 *
 * FUNCTION:    acpi_attach_data
 *
 * PARAMETERS:  obj_handle          - Namespace node
724 725
 *              handler             - Handler for this attachment
 *              data                - Pointer to data to be attached
L
Linus Torvalds 已提交
726 727 728 729 730 731 732
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Attach arbitrary data and handler to a namespace node.
 *
 ******************************************************************************/
acpi_status
L
Len Brown 已提交
733 734
acpi_attach_data(acpi_handle obj_handle,
		 acpi_object_handler handler, void *data)
L
Linus Torvalds 已提交
735
{
L
Len Brown 已提交
736 737
	struct acpi_namespace_node *node;
	acpi_status status;
L
Linus Torvalds 已提交
738 739 740

	/* Parameter validation */

L
Len Brown 已提交
741
	if (!obj_handle || !handler || !data) {
L
Linus Torvalds 已提交
742 743 744
		return (AE_BAD_PARAMETER);
	}

L
Len Brown 已提交
745 746
	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	if (ACPI_FAILURE(status)) {
L
Linus Torvalds 已提交
747 748 749 750 751
		return (status);
	}

	/* Convert and validate the handle */

752
	node = acpi_ns_validate_handle(obj_handle);
L
Linus Torvalds 已提交
753 754 755 756 757
	if (!node) {
		status = AE_BAD_PARAMETER;
		goto unlock_and_exit;
	}

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

L
Len Brown 已提交
760 761
      unlock_and_exit:
	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
L
Linus Torvalds 已提交
762 763 764
	return (status);
}

B
Bob Moore 已提交
765 766
ACPI_EXPORT_SYMBOL(acpi_attach_data)

L
Linus Torvalds 已提交
767 768 769 770 771
/*******************************************************************************
 *
 * FUNCTION:    acpi_detach_data
 *
 * PARAMETERS:  obj_handle          - Namespace node handle
772
 *              handler             - Handler used in call to acpi_attach_data
L
Linus Torvalds 已提交
773 774 775 776 777 778 779
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Remove data that was previously attached to a node.
 *
 ******************************************************************************/
acpi_status
L
Len Brown 已提交
780
acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler)
L
Linus Torvalds 已提交
781
{
L
Len Brown 已提交
782 783
	struct acpi_namespace_node *node;
	acpi_status status;
L
Linus Torvalds 已提交
784 785 786

	/* Parameter validation */

L
Len Brown 已提交
787
	if (!obj_handle || !handler) {
L
Linus Torvalds 已提交
788 789 790
		return (AE_BAD_PARAMETER);
	}

L
Len Brown 已提交
791 792
	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	if (ACPI_FAILURE(status)) {
L
Linus Torvalds 已提交
793 794 795 796 797
		return (status);
	}

	/* Convert and validate the handle */

798
	node = acpi_ns_validate_handle(obj_handle);
L
Linus Torvalds 已提交
799 800 801 802 803
	if (!node) {
		status = AE_BAD_PARAMETER;
		goto unlock_and_exit;
	}

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

L
Len Brown 已提交
806 807
      unlock_and_exit:
	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
L
Linus Torvalds 已提交
808 809 810
	return (status);
}

B
Bob Moore 已提交
811 812
ACPI_EXPORT_SYMBOL(acpi_detach_data)

L
Linus Torvalds 已提交
813 814 815 816 817
/*******************************************************************************
 *
 * FUNCTION:    acpi_get_data
 *
 * PARAMETERS:  obj_handle          - Namespace node
818 819
 *              handler             - Handler used in call to attach_data
 *              data                - Where the data is returned
L
Linus Torvalds 已提交
820 821 822 823 824 825 826
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Retrieve data that was previously attached to a namespace node.
 *
 ******************************************************************************/
acpi_status
L
Len Brown 已提交
827
acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data)
L
Linus Torvalds 已提交
828
{
L
Len Brown 已提交
829 830
	struct acpi_namespace_node *node;
	acpi_status status;
L
Linus Torvalds 已提交
831 832 833

	/* Parameter validation */

L
Len Brown 已提交
834
	if (!obj_handle || !handler || !data) {
L
Linus Torvalds 已提交
835 836 837
		return (AE_BAD_PARAMETER);
	}

L
Len Brown 已提交
838 839
	status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
	if (ACPI_FAILURE(status)) {
L
Linus Torvalds 已提交
840 841 842 843 844
		return (status);
	}

	/* Convert and validate the handle */

845
	node = acpi_ns_validate_handle(obj_handle);
L
Linus Torvalds 已提交
846 847 848 849 850
	if (!node) {
		status = AE_BAD_PARAMETER;
		goto unlock_and_exit;
	}

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

L
Len Brown 已提交
853 854
      unlock_and_exit:
	(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
L
Linus Torvalds 已提交
855 856
	return (status);
}
B
Bob Moore 已提交
857 858

ACPI_EXPORT_SYMBOL(acpi_get_data)