2 * acpi_utils.c - ACPI Utility Functions ($Revision: 10 $)
4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
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.
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.
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/slab.h>
29 #include <linux/init.h>
30 #include <linux/types.h>
31 #include <acpi/acpi_bus.h>
32 #include <acpi/acpi_drivers.h>
36 #define _COMPONENT ACPI_BUS_COMPONENT
37 ACPI_MODULE_NAME("utils");
39 /* --------------------------------------------------------------------------
40 Object Evaluation Helpers
41 -------------------------------------------------------------------------- */
43 acpi_util_eval_error(acpi_handle h, acpi_string p, acpi_status s)
45 #ifdef ACPI_DEBUG_OUTPUT
46 char prefix[80] = {'\0'};
47 struct acpi_buffer buffer = {sizeof(prefix), prefix};
48 acpi_get_name(h, ACPI_FULL_PATHNAME, &buffer);
49 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluate [%s.%s]: %s\n",
50 (char *) prefix, p, acpi_format_exception(s)));
57 acpi_extract_package(union acpi_object *package,
58 struct acpi_buffer *format, struct acpi_buffer *buffer)
60 u32 size_required = 0;
62 char *format_string = NULL;
69 if (!package || (package->type != ACPI_TYPE_PACKAGE)
70 || (package->package.count < 1)) {
71 printk(KERN_WARNING PREFIX "Invalid package argument\n");
72 return AE_BAD_PARAMETER;
75 if (!format || !format->pointer || (format->length < 1)) {
76 printk(KERN_WARNING PREFIX "Invalid format argument\n");
77 return AE_BAD_PARAMETER;
81 printk(KERN_WARNING PREFIX "Invalid buffer argument\n");
82 return AE_BAD_PARAMETER;
85 format_count = (format->length / sizeof(char)) - 1;
86 if (format_count > package->package.count) {
87 printk(KERN_WARNING PREFIX "Format specifies more objects [%d]"
88 " than exist in package [%d].\n",
89 format_count, package->package.count);
93 format_string = format->pointer;
96 * Calculate size_required.
98 for (i = 0; i < format_count; i++) {
100 union acpi_object *element = &(package->package.elements[i]);
106 switch (element->type) {
108 case ACPI_TYPE_INTEGER:
109 switch (format_string[i]) {
111 size_required += sizeof(u64);
112 tail_offset += sizeof(u64);
116 sizeof(char *) + sizeof(u64) +
118 tail_offset += sizeof(char *);
121 printk(KERN_WARNING PREFIX "Invalid package element"
122 " [%d]: got number, expecing"
124 i, format_string[i]);
130 case ACPI_TYPE_STRING:
131 case ACPI_TYPE_BUFFER:
132 switch (format_string[i]) {
136 (element->string.length * sizeof(char)) +
138 tail_offset += sizeof(char *);
143 (element->buffer.length * sizeof(u8));
144 tail_offset += sizeof(u8 *);
147 printk(KERN_WARNING PREFIX "Invalid package element"
148 " [%d] got string/buffer,"
150 i, format_string[i]);
156 case ACPI_TYPE_PACKAGE:
158 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
159 "Found unsupported element at index=%d\n",
161 /* TBD: handle nested packages... */
168 * Validate output buffer.
170 if (buffer->length < size_required) {
171 buffer->length = size_required;
172 return AE_BUFFER_OVERFLOW;
173 } else if (buffer->length != size_required || !buffer->pointer) {
174 return AE_BAD_PARAMETER;
177 head = buffer->pointer;
178 tail = buffer->pointer + tail_offset;
181 * Extract package data.
183 for (i = 0; i < format_count; i++) {
186 union acpi_object *element = &(package->package.elements[i]);
192 switch (element->type) {
194 case ACPI_TYPE_INTEGER:
195 switch (format_string[i]) {
198 element->integer.value;
202 pointer = (u8 **) head;
205 element->integer.value;
206 head += sizeof(u64 *);
208 /* NULL terminate string */
210 tail += sizeof(char);
213 /* Should never get here */
218 case ACPI_TYPE_STRING:
219 case ACPI_TYPE_BUFFER:
220 switch (format_string[i]) {
222 pointer = (u8 **) head;
224 memcpy(tail, element->string.pointer,
225 element->string.length);
226 head += sizeof(char *);
227 tail += element->string.length * sizeof(char);
228 /* NULL terminate string */
230 tail += sizeof(char);
233 pointer = (u8 **) head;
235 memcpy(tail, element->buffer.pointer,
236 element->buffer.length);
237 head += sizeof(u8 *);
238 tail += element->buffer.length * sizeof(u8);
241 /* Should never get here */
246 case ACPI_TYPE_PACKAGE:
247 /* TBD: handle nested packages... */
249 /* Should never get here */
257 EXPORT_SYMBOL(acpi_extract_package);
260 acpi_evaluate_integer(acpi_handle handle,
261 acpi_string pathname,
262 struct acpi_object_list *arguments, unsigned long long *data)
264 acpi_status status = AE_OK;
265 union acpi_object element;
266 struct acpi_buffer buffer = { 0, NULL };
269 return AE_BAD_PARAMETER;
271 buffer.length = sizeof(union acpi_object);
272 buffer.pointer = &element;
273 status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
274 if (ACPI_FAILURE(status)) {
275 acpi_util_eval_error(handle, pathname, status);
279 if (element.type != ACPI_TYPE_INTEGER) {
280 acpi_util_eval_error(handle, pathname, AE_BAD_DATA);
284 *data = element.integer.value;
286 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Return value [%llu]\n", *data));
291 EXPORT_SYMBOL(acpi_evaluate_integer);
294 acpi_evaluate_reference(acpi_handle handle,
295 acpi_string pathname,
296 struct acpi_object_list *arguments,
297 struct acpi_handle_list *list)
299 acpi_status status = AE_OK;
300 union acpi_object *package = NULL;
301 union acpi_object *element = NULL;
302 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
307 return AE_BAD_PARAMETER;
310 /* Evaluate object. */
312 status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
313 if (ACPI_FAILURE(status))
316 package = buffer.pointer;
318 if ((buffer.length == 0) || !package) {
319 printk(KERN_ERR PREFIX "No return object (len %X ptr %p)\n",
320 (unsigned)buffer.length, package);
321 status = AE_BAD_DATA;
322 acpi_util_eval_error(handle, pathname, status);
325 if (package->type != ACPI_TYPE_PACKAGE) {
326 printk(KERN_ERR PREFIX "Expecting a [Package], found type %X\n",
328 status = AE_BAD_DATA;
329 acpi_util_eval_error(handle, pathname, status);
332 if (!package->package.count) {
333 printk(KERN_ERR PREFIX "[Package] has zero elements (%p)\n",
335 status = AE_BAD_DATA;
336 acpi_util_eval_error(handle, pathname, status);
340 if (package->package.count > ACPI_MAX_HANDLES) {
343 list->count = package->package.count;
345 /* Extract package data. */
347 for (i = 0; i < list->count; i++) {
349 element = &(package->package.elements[i]);
351 if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
352 status = AE_BAD_DATA;
353 printk(KERN_ERR PREFIX
354 "Expecting a [Reference] package element, found type %X\n",
356 acpi_util_eval_error(handle, pathname, status);
360 if (!element->reference.handle) {
361 printk(KERN_WARNING PREFIX "Invalid reference in"
362 " package %s\n", pathname);
363 status = AE_NULL_ENTRY;
366 /* Get the acpi_handle. */
368 list->handles[i] = element->reference.handle;
369 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found reference [%p]\n",
374 if (ACPI_FAILURE(status)) {
376 //kfree(list->handles);
379 kfree(buffer.pointer);
384 EXPORT_SYMBOL(acpi_evaluate_reference);
387 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld *pld)
390 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
391 union acpi_object *output;
393 status = acpi_evaluate_object(handle, "_PLD", NULL, &buffer);
395 if (ACPI_FAILURE(status))
398 output = buffer.pointer;
400 if (!output || output->type != ACPI_TYPE_PACKAGE
401 || !output->package.count
402 || output->package.elements[0].type != ACPI_TYPE_BUFFER
403 || output->package.elements[0].buffer.length > sizeof(*pld)) {
408 memcpy(pld, output->package.elements[0].buffer.pointer,
409 output->package.elements[0].buffer.length);
411 kfree(buffer.pointer);
414 EXPORT_SYMBOL(acpi_get_physical_device_location);
417 * acpi_evaluate_hotplug_ost: Evaluate _OST for hotplug operations
418 * @handle: ACPI device handle
419 * @source_event: source event code
420 * @status_code: status code
421 * @status_buf: optional detailed information (NULL if none)
423 * Evaluate _OST for hotplug operations. All ACPI hotplug handlers
424 * must call this function when evaluating _OST for hotplug operations.
425 * When the platform does not support _OST, this function has no effect.
428 acpi_evaluate_hotplug_ost(acpi_handle handle, u32 source_event,
429 u32 status_code, struct acpi_buffer *status_buf)
431 #ifdef ACPI_HOTPLUG_OST
432 union acpi_object params[3] = {
433 {.type = ACPI_TYPE_INTEGER,},
434 {.type = ACPI_TYPE_INTEGER,},
435 {.type = ACPI_TYPE_BUFFER,}
437 struct acpi_object_list arg_list = {3, params};
440 params[0].integer.value = source_event;
441 params[1].integer.value = status_code;
442 if (status_buf != NULL) {
443 params[2].buffer.pointer = status_buf->pointer;
444 params[2].buffer.length = status_buf->length;
446 params[2].buffer.pointer = NULL;
447 params[2].buffer.length = 0;
450 status = acpi_evaluate_object(handle, "_OST", &arg_list, NULL);
456 EXPORT_SYMBOL(acpi_evaluate_hotplug_ost);