[deliverable/linux.git] / drivers / acpi / utils.c

/*
 *  acpi_utils.c - ACPI Utility Functions ($Revision: 10 $)
 *
 *  Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
 *  Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or (at
 *  your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/init.h>
#include <linux/types.h>
#include <linux/hardirq.h>
#include <linux/acpi.h>
#include <acpi/acpi_bus.h>
#include <acpi/acpi_drivers.h>

#include "internal.h"

#define _COMPONENT		ACPI_BUS_COMPONENT
ACPI_MODULE_NAME("utils");

/* --------------------------------------------------------------------------
                            Object Evaluation Helpers
   -------------------------------------------------------------------------- */
static void
acpi_util_eval_error(acpi_handle h, acpi_string p, acpi_status s)
{
#ifdef ACPI_DEBUG_OUTPUT
	char prefix[80] = {'\0'};
	struct acpi_buffer buffer = {sizeof(prefix), prefix};
	acpi_get_name(h, ACPI_FULL_PATHNAME, &buffer);
	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluate [%s.%s]: %s\n",
		(char *) prefix, p, acpi_format_exception(s)));
#else
	return;
#endif
}

acpi_status
acpi_extract_package(union acpi_object *package,
		     struct acpi_buffer *format, struct acpi_buffer *buffer)
{
	u32 size_required = 0;
	u32 tail_offset = 0;
	char *format_string = NULL;
	u32 format_count = 0;
	u32 i = 0;
	u8 *head = NULL;
	u8 *tail = NULL;


	if (!package || (package->type != ACPI_TYPE_PACKAGE)
	    || (package->package.count < 1)) {
		printk(KERN_WARNING PREFIX "Invalid package argument\n");
		return AE_BAD_PARAMETER;
	}

	if (!format || !format->pointer || (format->length < 1)) {
		printk(KERN_WARNING PREFIX "Invalid format argument\n");
		return AE_BAD_PARAMETER;
	}

	if (!buffer) {
		printk(KERN_WARNING PREFIX "Invalid buffer argument\n");
		return AE_BAD_PARAMETER;
	}

	format_count = (format->length / sizeof(char)) - 1;
	if (format_count > package->package.count) {
		printk(KERN_WARNING PREFIX "Format specifies more objects [%d]"
			      " than exist in package [%d].\n",
			      format_count, package->package.count);
		return AE_BAD_DATA;
	}

	format_string = format->pointer;

	/*
	 * Calculate size_required.
	 */
	for (i = 0; i < format_count; i++) {

		union acpi_object *element = &(package->package.elements[i]);

		if (!element) {
			return AE_BAD_DATA;
		}

		switch (element->type) {

		case ACPI_TYPE_INTEGER:
			switch (format_string[i]) {
			case 'N':
				size_required += sizeof(u64);
				tail_offset += sizeof(u64);
				break;
			case 'S':
				size_required +=
				    sizeof(char *) + sizeof(u64) +
				    sizeof(char);
				tail_offset += sizeof(char *);
				break;
			default:
				printk(KERN_WARNING PREFIX "Invalid package element"
					      " [%d]: got number, expecting"
					      " [%c]\n",
					      i, format_string[i]);
				return AE_BAD_DATA;
				break;
			}
			break;

		case ACPI_TYPE_STRING:
		case ACPI_TYPE_BUFFER:
			switch (format_string[i]) {
			case 'S':
				size_required +=
				    sizeof(char *) +
				    (element->string.length * sizeof(char)) +
				    sizeof(char);
				tail_offset += sizeof(char *);
				break;
			case 'B':
				size_required +=
				    sizeof(u8 *) +
				    (element->buffer.length * sizeof(u8));
				tail_offset += sizeof(u8 *);
				break;
			default:
				printk(KERN_WARNING PREFIX "Invalid package element"
					      " [%d] got string/buffer,"
					      " expecting [%c]\n",
					      i, format_string[i]);
				return AE_BAD_DATA;
				break;
			}
			break;

		case ACPI_TYPE_PACKAGE:
		default:
			ACPI_DEBUG_PRINT((ACPI_DB_INFO,
					  "Found unsupported element at index=%d\n",
					  i));
			/* TBD: handle nested packages... */
			return AE_SUPPORT;
			break;
		}
	}

	/*
	 * Validate output buffer.
	 */
	if (buffer->length == ACPI_ALLOCATE_BUFFER) {
		buffer->pointer = ACPI_ALLOCATE(size_required);
		if (!buffer->pointer)
			return AE_NO_MEMORY;
		buffer->length = size_required;
		memset(buffer->pointer, 0, size_required);
	} else {
		if (buffer->length < size_required) {
			buffer->length = size_required;
			return AE_BUFFER_OVERFLOW;
		} else if (buffer->length != size_required ||
			   !buffer->pointer) {
			return AE_BAD_PARAMETER;
		}
	}

	head = buffer->pointer;
	tail = buffer->pointer + tail_offset;

	/*
	 * Extract package data.
	 */
	for (i = 0; i < format_count; i++) {

		u8 **pointer = NULL;
		union acpi_object *element = &(package->package.elements[i]);

		if (!element) {
			return AE_BAD_DATA;
		}

		switch (element->type) {

		case ACPI_TYPE_INTEGER:
			switch (format_string[i]) {
			case 'N':
				*((u64 *) head) =
				    element->integer.value;
				head += sizeof(u64);
				break;
			case 'S':
				pointer = (u8 **) head;
				*pointer = tail;
				*((u64 *) tail) =
				    element->integer.value;
				head += sizeof(u64 *);
				tail += sizeof(u64);
				/* NULL terminate string */
				*tail = (char)0;
				tail += sizeof(char);
				break;
			default:
				/* Should never get here */
				break;
			}
			break;

		case ACPI_TYPE_STRING:
		case ACPI_TYPE_BUFFER:
			switch (format_string[i]) {
			case 'S':
				pointer = (u8 **) head;
				*pointer = tail;
				memcpy(tail, element->string.pointer,
				       element->string.length);
				head += sizeof(char *);
				tail += element->string.length * sizeof(char);
				/* NULL terminate string */
				*tail = (char)0;
				tail += sizeof(char);
				break;
			case 'B':
				pointer = (u8 **) head;
				*pointer = tail;
				memcpy(tail, element->buffer.pointer,
				       element->buffer.length);
				head += sizeof(u8 *);
				tail += element->buffer.length * sizeof(u8);
				break;
			default:
				/* Should never get here */
				break;
			}
			break;

		case ACPI_TYPE_PACKAGE:
			/* TBD: handle nested packages... */
		default:
			/* Should never get here */
			break;
		}
	}

	return AE_OK;
}

EXPORT_SYMBOL(acpi_extract_package);

acpi_status
acpi_evaluate_integer(acpi_handle handle,
		      acpi_string pathname,
		      struct acpi_object_list *arguments, unsigned long long *data)
{
	acpi_status status = AE_OK;
	union acpi_object element;
	struct acpi_buffer buffer = { 0, NULL };

	if (!data)
		return AE_BAD_PARAMETER;

	buffer.length = sizeof(union acpi_object);
	buffer.pointer = &element;
	status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
	if (ACPI_FAILURE(status)) {
		acpi_util_eval_error(handle, pathname, status);
		return status;
	}

	if (element.type != ACPI_TYPE_INTEGER) {
		acpi_util_eval_error(handle, pathname, AE_BAD_DATA);
		return AE_BAD_DATA;
	}

	*data = element.integer.value;

	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Return value [%llu]\n", *data));

	return AE_OK;
}

EXPORT_SYMBOL(acpi_evaluate_integer);

acpi_status
acpi_evaluate_reference(acpi_handle handle,
			acpi_string pathname,
			struct acpi_object_list *arguments,
			struct acpi_handle_list *list)
{
	acpi_status status = AE_OK;
	union acpi_object *package = NULL;
	union acpi_object *element = NULL;
	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
	u32 i = 0;


	if (!list) {
		return AE_BAD_PARAMETER;
	}

	/* Evaluate object. */

	status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
	if (ACPI_FAILURE(status))
		goto end;

	package = buffer.pointer;

	if ((buffer.length == 0) || !package) {
		printk(KERN_ERR PREFIX "No return object (len %X ptr %p)\n",
			    (unsigned)buffer.length, package);
		status = AE_BAD_DATA;
		acpi_util_eval_error(handle, pathname, status);
		goto end;
	}
	if (package->type != ACPI_TYPE_PACKAGE) {
		printk(KERN_ERR PREFIX "Expecting a [Package], found type %X\n",
			    package->type);
		status = AE_BAD_DATA;
		acpi_util_eval_error(handle, pathname, status);
		goto end;
	}
	if (!package->package.count) {
		printk(KERN_ERR PREFIX "[Package] has zero elements (%p)\n",
			    package);
		status = AE_BAD_DATA;
		acpi_util_eval_error(handle, pathname, status);
		goto end;
	}

	if (package->package.count > ACPI_MAX_HANDLES) {
		return AE_NO_MEMORY;
	}
	list->count = package->package.count;

	/* Extract package data. */

	for (i = 0; i < list->count; i++) {

		element = &(package->package.elements[i]);

		if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
			status = AE_BAD_DATA;
			printk(KERN_ERR PREFIX
				    "Expecting a [Reference] package element, found type %X\n",
				    element->type);
			acpi_util_eval_error(handle, pathname, status);
			break;
		}

		if (!element->reference.handle) {
			printk(KERN_WARNING PREFIX "Invalid reference in"
			       " package %s\n", pathname);
			status = AE_NULL_ENTRY;
			break;
		}
		/* Get the  acpi_handle. */

		list->handles[i] = element->reference.handle;
		ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found reference [%p]\n",
				  list->handles[i]));
	}

      end:
	if (ACPI_FAILURE(status)) {
		list->count = 0;
		//kfree(list->handles);
	}

	kfree(buffer.pointer);

	return status;
}

EXPORT_SYMBOL(acpi_evaluate_reference);

acpi_status
acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld)
{
	acpi_status status;
	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
	union acpi_object *output;

	status = acpi_evaluate_object(handle, "_PLD", NULL, &buffer);

	if (ACPI_FAILURE(status))
		return status;

	output = buffer.pointer;

	if (!output || output->type != ACPI_TYPE_PACKAGE
	    || !output->package.count
	    || output->package.elements[0].type != ACPI_TYPE_BUFFER
	    || output->package.elements[0].buffer.length < ACPI_PLD_REV1_BUFFER_SIZE) {
		status = AE_TYPE;
		goto out;
	}

	status = acpi_decode_pld_buffer(
			output->package.elements[0].buffer.pointer,
			output->package.elements[0].buffer.length,
			pld);

out:
	kfree(buffer.pointer);
	return status;
}
EXPORT_SYMBOL(acpi_get_physical_device_location);

/**
 * acpi_evaluate_hotplug_ost: Evaluate _OST for hotplug operations
 * @handle: ACPI device handle
 * @source_event: source event code
 * @status_code: status code
 * @status_buf: optional detailed information (NULL if none)
 *
 * Evaluate _OST for hotplug operations. All ACPI hotplug handlers
 * must call this function when evaluating _OST for hotplug operations.
 * When the platform does not support _OST, this function has no effect.
 */
acpi_status
acpi_evaluate_hotplug_ost(acpi_handle handle, u32 source_event,
		u32 status_code, struct acpi_buffer *status_buf)
{
#ifdef ACPI_HOTPLUG_OST
	union acpi_object params[3] = {
		{.type = ACPI_TYPE_INTEGER,},
		{.type = ACPI_TYPE_INTEGER,},
		{.type = ACPI_TYPE_BUFFER,}
	};
	struct acpi_object_list arg_list = {3, params};
	acpi_status status;

	params[0].integer.value = source_event;
	params[1].integer.value = status_code;
	if (status_buf != NULL) {
		params[2].buffer.pointer = status_buf->pointer;
		params[2].buffer.length = status_buf->length;
	} else {
		params[2].buffer.pointer = NULL;
		params[2].buffer.length = 0;
	}

	status = acpi_evaluate_object(handle, "_OST", &arg_list, NULL);
	return status;
#else
	return AE_OK;
#endif
}
EXPORT_SYMBOL(acpi_evaluate_hotplug_ost);

/**
 * acpi_handle_printk: Print message with ACPI prefix and object path
 *
 * This function is called through acpi_handle_<level> macros and prints
 * a message with ACPI prefix and object path.  This function acquires
 * the global namespace mutex to obtain an object path.  In interrupt
 * context, it shows the object path as <n/a>.
 */
void
acpi_handle_printk(const char *level, acpi_handle handle, const char *fmt, ...)
{
	struct va_format vaf;
	va_list args;
	struct acpi_buffer buffer = {
		.length = ACPI_ALLOCATE_BUFFER,
		.pointer = NULL
	};
	const char *path;

	va_start(args, fmt);
	vaf.fmt = fmt;
	vaf.va = &args;

	if (in_interrupt() ||
	    acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer) != AE_OK)
		path = "<n/a>";
	else
		path = buffer.pointer;

	printk("%sACPI: %s: %pV", level, path, &vaf);

	va_end(args);
	kfree(buffer.pointer);
}
EXPORT_SYMBOL(acpi_handle_printk);

/**
 * acpi_has_method: Check whether @handle has a method named @name
 * @handle: ACPI device handle
 * @name: name of object or method
 *
 * Check whether @handle has a method named @name.
 */
bool acpi_has_method(acpi_handle handle, char *name)
{
	acpi_handle tmp;

	return ACPI_SUCCESS(acpi_get_handle(handle, name, &tmp));
}
EXPORT_SYMBOL(acpi_has_method);

acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
				       u64 arg)
{
	union acpi_object obj = { .type = ACPI_TYPE_INTEGER };
	struct acpi_object_list arg_list = { .count = 1, .pointer = &obj, };

	obj.integer.value = arg;

	return acpi_evaluate_object(handle, method, &arg_list, NULL);
}
EXPORT_SYMBOL(acpi_execute_simple_method);

/**
 * acpi_evaluate_ej0: Evaluate _EJ0 method for hotplug operations
 * @handle: ACPI device handle
 *
 * Evaluate device's _EJ0 method for hotplug operations.
 */
acpi_status acpi_evaluate_ej0(acpi_handle handle)
{
	acpi_status status;

	status = acpi_execute_simple_method(handle, "_EJ0", 1);
	if (status == AE_NOT_FOUND)
		acpi_handle_warn(handle, "No _EJ0 support for device\n");
	else if (ACPI_FAILURE(status))
		acpi_handle_warn(handle, "Eject failed (0x%x)\n", status);

	return status;
}

/**
 * acpi_evaluate_lck: Evaluate _LCK method to lock/unlock device
 * @handle: ACPI device handle
 * @lock: lock device if non-zero, otherwise unlock device
 *
 * Evaluate device's _LCK method if present to lock/unlock device
 */
acpi_status acpi_evaluate_lck(acpi_handle handle, int lock)
{
	acpi_status status;

	status = acpi_execute_simple_method(handle, "_LCK", !!lock);
	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
		if (lock)
			acpi_handle_warn(handle,
				"Locking device failed (0x%x)\n", status);
		else
			acpi_handle_warn(handle,
				"Unlocking device failed (0x%x)\n", status);
	}

	return status;
}
Commit	Line	Data
1da177e4 LT	1	/*
	2	* acpi_utils.c - ACPI Utility Functions ($Revision: 10 $)
	3	*
	4	* Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
	5	* Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
	6	*
	7	* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or (at
	12	* your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful, but
	15	* WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	17	* General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License along
	20	* with this program; if not, write to the Free Software Foundation, Inc.,
	21	* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
	22	*
	23	* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	24	*/
	25
	26	#include <linux/kernel.h>
	27	#include <linux/module.h>
5a0e3ad6	28	#include <linux/slab.h>
1da177e4 LT	29	#include <linux/init.h>
1da177e4 LT	30	#include <linux/types.h>
fbfddae6 TK	31	#include <linux/hardirq.h>
fbfddae6 TK	32	#include <linux/acpi.h>
1da177e4 LT	33	#include <acpi/acpi_bus.h>
	34	#include <acpi/acpi_drivers.h>
	35
a192a958 LB	36	#include "internal.h"
a192a958 LB	37
1da177e4	38	#define _COMPONENT ACPI_BUS_COMPONENT
f52fd66d	39	ACPI_MODULE_NAME("utils");
1da177e4 LT	40
	41	/* --------------------------------------------------------------------------
	42	Object Evaluation Helpers
	43	-------------------------------------------------------------------------- */
4fd7f518 HH	44	static void
	45	acpi_util_eval_error(acpi_handle h, acpi_string p, acpi_status s)
	46	{
1da177e4	47	#ifdef ACPI_DEBUG_OUTPUT
4fd7f518 HH	48	char prefix[80] = {'\0'};
	49	struct acpi_buffer buffer = {sizeof(prefix), prefix};
	50	acpi_get_name(h, ACPI_FULL_PATHNAME, &buffer);
	51	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluate [%s.%s]: %s\n",
	52	(char *) prefix, p, acpi_format_exception(s)));
1da177e4	53	#else
4fd7f518	54	return;
1da177e4	55	#endif
4fd7f518 HH	56	}
4fd7f518 HH	57
1da177e4	58	acpi_status
4be44fcd LB	59	acpi_extract_package(union acpi_object *package,
4be44fcd LB	60	struct acpi_buffer format, struct acpi_buffer buffer)
1da177e4	61	{
4be44fcd LB	62	u32 size_required = 0;
	63	u32 tail_offset = 0;
	64	char *format_string = NULL;
	65	u32 format_count = 0;
	66	u32 i = 0;
	67	u8 *head = NULL;
	68	u8 *tail = NULL;
1da177e4	69
1da177e4	70
4be44fcd LB	71	if (!package \|\| (package->type != ACPI_TYPE_PACKAGE)
4be44fcd LB	72	\|\| (package->package.count < 1)) {
cece9296	73	printk(KERN_WARNING PREFIX "Invalid package argument\n");
d550d98d	74	return AE_BAD_PARAMETER;
1da177e4 LT	75	}
	76
	77	if (!format \|\| !format->pointer \|\| (format->length < 1)) {
cece9296	78	printk(KERN_WARNING PREFIX "Invalid format argument\n");
d550d98d	79	return AE_BAD_PARAMETER;
1da177e4 LT	80	}
	81
	82	if (!buffer) {
cece9296	83	printk(KERN_WARNING PREFIX "Invalid buffer argument\n");
d550d98d	84	return AE_BAD_PARAMETER;
1da177e4 LT	85	}
1da177e4 LT	86
4be44fcd	87	format_count = (format->length / sizeof(char)) - 1;
1da177e4	88	if (format_count > package->package.count) {
cece9296 LB	89	printk(KERN_WARNING PREFIX "Format specifies more objects [%d]"
	90	" than exist in package [%d].\n",
	91	format_count, package->package.count);
d550d98d	92	return AE_BAD_DATA;
1da177e4 LT	93	}
1da177e4 LT	94
50dd0969	95	format_string = format->pointer;
1da177e4 LT	96
	97	/*
	98	* Calculate size_required.
	99	*/
4be44fcd	100	for (i = 0; i < format_count; i++) {
1da177e4 LT	101
	102	union acpi_object *element = &(package->package.elements[i]);
	103
	104	if (!element) {
d550d98d	105	return AE_BAD_DATA;
1da177e4 LT	106	}
	107
	108	switch (element->type) {
	109
	110	case ACPI_TYPE_INTEGER:
	111	switch (format_string[i]) {
	112	case 'N':
439913ff LM	113	size_required += sizeof(u64);
439913ff LM	114	tail_offset += sizeof(u64);
1da177e4 LT	115	break;
1da177e4 LT	116	case 'S':
4be44fcd	117	size_required +=
439913ff	118	sizeof(char *) + sizeof(u64) +
4be44fcd LB	119	sizeof(char);
4be44fcd LB	120	tail_offset += sizeof(char *);
1da177e4 LT	121	break;
1da177e4 LT	122	default:
cece9296	123	printk(KERN_WARNING PREFIX "Invalid package element"
e7e92ec9	124	" [%d]: got number, expecting"
cece9296 LB	125	" [%c]\n",
cece9296 LB	126	i, format_string[i]);
d550d98d	127	return AE_BAD_DATA;
1da177e4 LT	128	break;
	129	}
	130	break;
	131
	132	case ACPI_TYPE_STRING:
	133	case ACPI_TYPE_BUFFER:
	134	switch (format_string[i]) {
	135	case 'S':
4be44fcd LB	136	size_required +=
	137	sizeof(char *) +
	138	(element->string.length * sizeof(char)) +
	139	sizeof(char);
	140	tail_offset += sizeof(char *);
1da177e4 LT	141	break;
1da177e4 LT	142	case 'B':
4be44fcd LB	143	size_required +=
	144	sizeof(u8 *) +
	145	(element->buffer.length * sizeof(u8));
	146	tail_offset += sizeof(u8 *);
1da177e4 LT	147	break;
1da177e4 LT	148	default:
cece9296	149	printk(KERN_WARNING PREFIX "Invalid package element"
a6fc6720	150	" [%d] got string/buffer,"
e7e92ec9	151	" expecting [%c]\n",
cece9296	152	i, format_string[i]);
d550d98d	153	return AE_BAD_DATA;
1da177e4 LT	154	break;
	155	}
	156	break;
	157
	158	case ACPI_TYPE_PACKAGE:
	159	default:
4be44fcd LB	160	ACPI_DEBUG_PRINT((ACPI_DB_INFO,
	161	"Found unsupported element at index=%d\n",
	162	i));
1da177e4	163	/* TBD: handle nested packages... */
d550d98d	164	return AE_SUPPORT;
1da177e4 LT	165	break;
	166	}
	167	}
	168
	169	/*
	170	* Validate output buffer.
	171	*/
e83dda06 AS	172	if (buffer->length == ACPI_ALLOCATE_BUFFER) {
	173	buffer->pointer = ACPI_ALLOCATE(size_required);
	174	if (!buffer->pointer)
	175	return AE_NO_MEMORY;
1da177e4	176	buffer->length = size_required;
e83dda06 AS	177	memset(buffer->pointer, 0, size_required);
	178	} else {
	179	if (buffer->length < size_required) {
	180	buffer->length = size_required;
	181	return AE_BUFFER_OVERFLOW;
	182	} else if (buffer->length != size_required \|\|
	183	!buffer->pointer) {
	184	return AE_BAD_PARAMETER;
	185	}
1da177e4 LT	186	}
	187
	188	head = buffer->pointer;
	189	tail = buffer->pointer + tail_offset;
	190
	191	/*
	192	* Extract package data.
	193	*/
4be44fcd	194	for (i = 0; i < format_count; i++) {
1da177e4 LT	195
	196	u8 **pointer = NULL;
	197	union acpi_object *element = &(package->package.elements[i]);
	198
	199	if (!element) {
d550d98d	200	return AE_BAD_DATA;
1da177e4 LT	201	}
	202
	203	switch (element->type) {
	204
	205	case ACPI_TYPE_INTEGER:
	206	switch (format_string[i]) {
	207	case 'N':
439913ff	208	((u64 ) head) =
4be44fcd	209	element->integer.value;
439913ff	210	head += sizeof(u64);
1da177e4 LT	211	break;
1da177e4 LT	212	case 'S':
4be44fcd	213	pointer = (u8 **) head;
1da177e4	214	*pointer = tail;
439913ff	215	((u64 ) tail) =
4be44fcd	216	element->integer.value;
439913ff LM	217	head += sizeof(u64 *);
439913ff LM	218	tail += sizeof(u64);
1da177e4 LT	219	/* NULL terminate string */
	220	*tail = (char)0;
	221	tail += sizeof(char);
	222	break;
	223	default:
	224	/* Should never get here */
	225	break;
	226	}
	227	break;
	228
	229	case ACPI_TYPE_STRING:
	230	case ACPI_TYPE_BUFFER:
	231	switch (format_string[i]) {
	232	case 'S':
4be44fcd	233	pointer = (u8 **) head;
1da177e4	234	*pointer = tail;
4be44fcd LB	235	memcpy(tail, element->string.pointer,
	236	element->string.length);
	237	head += sizeof(char *);
1da177e4 LT	238	tail += element->string.length * sizeof(char);
	239	/* NULL terminate string */
	240	*tail = (char)0;
	241	tail += sizeof(char);
	242	break;
	243	case 'B':
4be44fcd	244	pointer = (u8 **) head;
1da177e4	245	*pointer = tail;
4be44fcd LB	246	memcpy(tail, element->buffer.pointer,
	247	element->buffer.length);
	248	head += sizeof(u8 *);
1da177e4 LT	249	tail += element->buffer.length * sizeof(u8);
	250	break;
	251	default:
	252	/* Should never get here */
	253	break;
	254	}
	255	break;
	256
	257	case ACPI_TYPE_PACKAGE:
	258	/* TBD: handle nested packages... */
	259	default:
	260	/* Should never get here */
	261	break;
	262	}
	263	}
	264
d550d98d	265	return AE_OK;
1da177e4	266	}
1da177e4	267
4be44fcd	268	EXPORT_SYMBOL(acpi_extract_package);
1da177e4 LT	269
1da177e4 LT	270	acpi_status
4be44fcd LB	271	acpi_evaluate_integer(acpi_handle handle,
4be44fcd LB	272	acpi_string pathname,
27663c58	273	struct acpi_object_list arguments, unsigned long long data)
1da177e4	274	{
4be44fcd	275	acpi_status status = AE_OK;
40599072	276	union acpi_object element;
4be44fcd	277	struct acpi_buffer buffer = { 0, NULL };
1da177e4	278
1da177e4	279	if (!data)
d550d98d	280	return AE_BAD_PARAMETER;
1da177e4	281
1da177e4	282	buffer.length = sizeof(union acpi_object);
40599072	283	buffer.pointer = &element;
1da177e4 LT	284	status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
	285	if (ACPI_FAILURE(status)) {
	286	acpi_util_eval_error(handle, pathname, status);
d550d98d	287	return status;
1da177e4 LT	288	}
1da177e4 LT	289
40599072	290	if (element.type != ACPI_TYPE_INTEGER) {
1da177e4	291	acpi_util_eval_error(handle, pathname, AE_BAD_DATA);
d550d98d	292	return AE_BAD_DATA;
1da177e4 LT	293	}
1da177e4 LT	294
40599072	295	*data = element.integer.value;
1da177e4	296
27663c58	297	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Return value [%llu]\n", *data));
1da177e4	298
d550d98d	299	return AE_OK;
1da177e4	300	}
1da177e4	301
4be44fcd	302	EXPORT_SYMBOL(acpi_evaluate_integer);
1da177e4	303
1da177e4	304	acpi_status
4be44fcd LB	305	acpi_evaluate_reference(acpi_handle handle,
	306	acpi_string pathname,
	307	struct acpi_object_list *arguments,
	308	struct acpi_handle_list *list)
1da177e4	309	{
4be44fcd LB	310	acpi_status status = AE_OK;
	311	union acpi_object *package = NULL;
	312	union acpi_object *element = NULL;
	313	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
	314	u32 i = 0;
1da177e4	315
1da177e4 LT	316
1da177e4 LT	317	if (!list) {
d550d98d	318	return AE_BAD_PARAMETER;
1da177e4 LT	319	}
	320
	321	/* Evaluate object. */
	322
	323	status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
	324	if (ACPI_FAILURE(status))
	325	goto end;
	326
50dd0969	327	package = buffer.pointer;
1da177e4 LT	328
1da177e4 LT	329	if ((buffer.length == 0) \|\| !package) {
6468463a LB	330	printk(KERN_ERR PREFIX "No return object (len %X ptr %p)\n",
6468463a LB	331	(unsigned)buffer.length, package);
1da177e4 LT	332	status = AE_BAD_DATA;
	333	acpi_util_eval_error(handle, pathname, status);
	334	goto end;
	335	}
	336	if (package->type != ACPI_TYPE_PACKAGE) {
6468463a LB	337	printk(KERN_ERR PREFIX "Expecting a [Package], found type %X\n",
6468463a LB	338	package->type);
1da177e4 LT	339	status = AE_BAD_DATA;
	340	acpi_util_eval_error(handle, pathname, status);
	341	goto end;
	342	}
	343	if (!package->package.count) {
6468463a LB	344	printk(KERN_ERR PREFIX "[Package] has zero elements (%p)\n",
6468463a LB	345	package);
1da177e4 LT	346	status = AE_BAD_DATA;
	347	acpi_util_eval_error(handle, pathname, status);
	348	goto end;
	349	}
	350
	351	if (package->package.count > ACPI_MAX_HANDLES) {
d550d98d	352	return AE_NO_MEMORY;
1da177e4 LT	353	}
	354	list->count = package->package.count;
	355
	356	/* Extract package data. */
	357
	358	for (i = 0; i < list->count; i++) {
	359
	360	element = &(package->package.elements[i]);
	361
cd0b2248	362	if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
1da177e4	363	status = AE_BAD_DATA;
6468463a LB	364	printk(KERN_ERR PREFIX
	365	"Expecting a [Reference] package element, found type %X\n",
	366	element->type);
1da177e4 LT	367	acpi_util_eval_error(handle, pathname, status);
	368	break;
	369	}
	370
b6a16387 TR	371	if (!element->reference.handle) {
	372	printk(KERN_WARNING PREFIX "Invalid reference in"
	373	" package %s\n", pathname);
	374	status = AE_NULL_ENTRY;
	375	break;
	376	}
1da177e4 LT	377	/* Get the acpi_handle. */
	378
	379	list->handles[i] = element->reference.handle;
	380	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found reference [%p]\n",
4be44fcd	381	list->handles[i]));
1da177e4 LT	382	}
1da177e4 LT	383
4be44fcd	384	end:
1da177e4 LT	385	if (ACPI_FAILURE(status)) {
	386	list->count = 0;
	387	//kfree(list->handles);
	388	}
	389
02438d87	390	kfree(buffer.pointer);
1da177e4	391
d550d98d	392	return status;
1da177e4	393	}
1da177e4	394
4be44fcd	395	EXPORT_SYMBOL(acpi_evaluate_reference);
38ac0f1b MG	396
38ac0f1b MG	397	acpi_status
8ede06ab	398	acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld)
38ac0f1b MG	399	{
	400	acpi_status status;
	401	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
	402	union acpi_object *output;
	403
	404	status = acpi_evaluate_object(handle, "_PLD", NULL, &buffer);
	405
	406	if (ACPI_FAILURE(status))
	407	return status;
	408
	409	output = buffer.pointer;
	410
	411	if (!output \|\| output->type != ACPI_TYPE_PACKAGE
	412	\|\| !output->package.count
	413	\|\| output->package.elements[0].type != ACPI_TYPE_BUFFER
8ede06ab	414	\|\| output->package.elements[0].buffer.length < ACPI_PLD_REV1_BUFFER_SIZE) {
38ac0f1b MG	415	status = AE_TYPE;
	416	goto out;
	417	}
	418
8ede06ab FT	419	status = acpi_decode_pld_buffer(
	420	output->package.elements[0].buffer.pointer,
	421	output->package.elements[0].buffer.length,
	422	pld);
	423
38ac0f1b MG	424	out:
	425	kfree(buffer.pointer);
	426	return status;
	427	}
	428	EXPORT_SYMBOL(acpi_get_physical_device_location);
275c58d7 TK	429
	430	/**
	431	* acpi_evaluate_hotplug_ost: Evaluate _OST for hotplug operations
	432	* @handle: ACPI device handle
	433	* @source_event: source event code
	434	* @status_code: status code
	435	* @status_buf: optional detailed information (NULL if none)
	436	*
	437	* Evaluate _OST for hotplug operations. All ACPI hotplug handlers
	438	* must call this function when evaluating _OST for hotplug operations.
	439	* When the platform does not support _OST, this function has no effect.
	440	*/
	441	acpi_status
	442	acpi_evaluate_hotplug_ost(acpi_handle handle, u32 source_event,
	443	u32 status_code, struct acpi_buffer *status_buf)
	444	{
	445	#ifdef ACPI_HOTPLUG_OST
	446	union acpi_object params[3] = {
	447	{.type = ACPI_TYPE_INTEGER,},
	448	{.type = ACPI_TYPE_INTEGER,},
	449	{.type = ACPI_TYPE_BUFFER,}
	450	};
	451	struct acpi_object_list arg_list = {3, params};
	452	acpi_status status;
	453
	454	params[0].integer.value = source_event;
	455	params[1].integer.value = status_code;
	456	if (status_buf != NULL) {
	457	params[2].buffer.pointer = status_buf->pointer;
	458	params[2].buffer.length = status_buf->length;
	459	} else {
	460	params[2].buffer.pointer = NULL;
	461	params[2].buffer.length = 0;
	462	}
	463
	464	status = acpi_evaluate_object(handle, "_OST", &arg_list, NULL);
	465	return status;
	466	#else
	467	return AE_OK;
	468	#endif
	469	}
	470	EXPORT_SYMBOL(acpi_evaluate_hotplug_ost);
fbfddae6 TK	471
	472	/**
	473	* acpi_handle_printk: Print message with ACPI prefix and object path
	474	*
	475	* This function is called through acpi_handle_<level> macros and prints
	476	* a message with ACPI prefix and object path. This function acquires
	477	* the global namespace mutex to obtain an object path. In interrupt
	478	* context, it shows the object path as <n/a>.
	479	*/
	480	void
	481	acpi_handle_printk(const char level, acpi_handle handle, const char fmt, ...)
	482	{
	483	struct va_format vaf;
	484	va_list args;
	485	struct acpi_buffer buffer = {
	486	.length = ACPI_ALLOCATE_BUFFER,
	487	.pointer = NULL
	488	};
	489	const char *path;
	490
	491	va_start(args, fmt);
	492	vaf.fmt = fmt;
	493	vaf.va = &args;
	494
	495	if (in_interrupt() \|\|
	496	acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer) != AE_OK)
	497	path = "<n/a>";
	498	else
	499	path = buffer.pointer;
	500
	501	printk("%sACPI: %s: %pV", level, path, &vaf);
	502
	503	va_end(args);
	504	kfree(buffer.pointer);
	505	}
	506	EXPORT_SYMBOL(acpi_handle_printk);
952c63e9 JL	507
	508	/**
	509	* acpi_has_method: Check whether @handle has a method named @name
	510	* @handle: ACPI device handle
	511	* @name: name of object or method
	512	*
	513	* Check whether @handle has a method named @name.
	514	*/
	515	bool acpi_has_method(acpi_handle handle, char *name)
	516	{
	517	acpi_handle tmp;
	518
	519	return ACPI_SUCCESS(acpi_get_handle(handle, name, &tmp));
	520	}
	521	EXPORT_SYMBOL(acpi_has_method);
0db98202 JL	522
	523	acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
	524	u64 arg)
	525	{
	526	union acpi_object obj = { .type = ACPI_TYPE_INTEGER };
	527	struct acpi_object_list arg_list = { .count = 1, .pointer = &obj, };
	528
	529	obj.integer.value = arg;
	530
	531	return acpi_evaluate_object(handle, method, &arg_list, NULL);
	532	}
	533	EXPORT_SYMBOL(acpi_execute_simple_method);
7d2421f8 JL	534
	535	/**
	536	* acpi_evaluate_ej0: Evaluate _EJ0 method for hotplug operations
	537	* @handle: ACPI device handle
	538	*
	539	* Evaluate device's _EJ0 method for hotplug operations.
	540	*/
	541	acpi_status acpi_evaluate_ej0(acpi_handle handle)
	542	{
	543	acpi_status status;
	544
	545	status = acpi_execute_simple_method(handle, "_EJ0", 1);
	546	if (status == AE_NOT_FOUND)
	547	acpi_handle_warn(handle, "No _EJ0 support for device\n");
	548	else if (ACPI_FAILURE(status))
	549	acpi_handle_warn(handle, "Eject failed (0x%x)\n", status);
	550
	551	return status;
	552	}
	553
	554	/**
	555	* acpi_evaluate_lck: Evaluate _LCK method to lock/unlock device
	556	* @handle: ACPI device handle
	557	* @lock: lock device if non-zero, otherwise unlock device
	558	*
	559	* Evaluate device's _LCK method if present to lock/unlock device
	560	*/
	561	acpi_status acpi_evaluate_lck(acpi_handle handle, int lock)
	562	{
	563	acpi_status status;
	564
	565	status = acpi_execute_simple_method(handle, "_LCK", !!lock);
	566	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
	567	if (lock)
	568	acpi_handle_warn(handle,
	569	"Locking device failed (0x%x)\n", status);
	570	else
	571	acpi_handle_warn(handle,
	572	"Unlocking device failed (0x%x)\n", status);
	573	}
	574
	575	return status;
	576	}