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 <linux/hardirq.h>
32 #include <linux/acpi.h>
33 #include <linux/dynamic_debug.h>
37 #define _COMPONENT ACPI_BUS_COMPONENT
38 ACPI_MODULE_NAME("utils");
40 /* --------------------------------------------------------------------------
41 Object Evaluation Helpers
42 -------------------------------------------------------------------------- */
44 acpi_util_eval_error(acpi_handle h, acpi_string p, acpi_status s)
46 #ifdef ACPI_DEBUG_OUTPUT
47 char prefix[80] = {'\0'};
48 struct acpi_buffer buffer = {sizeof(prefix), prefix};
49 acpi_get_name(h, ACPI_FULL_PATHNAME, &buffer);
50 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluate [%s.%s]: %s\n",
51 (char *) prefix, p, acpi_format_exception(s)));
58 acpi_extract_package(union acpi_object *package,
59 struct acpi_buffer *format, struct acpi_buffer *buffer)
61 u32 size_required = 0;
63 char *format_string = NULL;
70 if (!package || (package->type != ACPI_TYPE_PACKAGE)
71 || (package->package.count < 1)) {
72 printk(KERN_WARNING PREFIX "Invalid package argument\n");
73 return AE_BAD_PARAMETER;
76 if (!format || !format->pointer || (format->length < 1)) {
77 printk(KERN_WARNING PREFIX "Invalid format argument\n");
78 return AE_BAD_PARAMETER;
82 printk(KERN_WARNING PREFIX "Invalid buffer argument\n");
83 return AE_BAD_PARAMETER;
86 format_count = (format->length / sizeof(char)) - 1;
87 if (format_count > package->package.count) {
88 printk(KERN_WARNING PREFIX "Format specifies more objects [%d]"
89 " than exist in package [%d].\n",
90 format_count, package->package.count);
94 format_string = format->pointer;
97 * Calculate size_required.
99 for (i = 0; i < format_count; i++) {
101 union acpi_object *element = &(package->package.elements[i]);
103 switch (element->type) {
105 case ACPI_TYPE_INTEGER:
106 switch (format_string[i]) {
108 size_required += sizeof(u64);
109 tail_offset += sizeof(u64);
113 sizeof(char *) + sizeof(u64) +
115 tail_offset += sizeof(char *);
118 printk(KERN_WARNING PREFIX "Invalid package element"
119 " [%d]: got number, expecting"
121 i, format_string[i]);
127 case ACPI_TYPE_STRING:
128 case ACPI_TYPE_BUFFER:
129 switch (format_string[i]) {
133 (element->string.length * sizeof(char)) +
135 tail_offset += sizeof(char *);
140 (element->buffer.length * sizeof(u8));
141 tail_offset += sizeof(u8 *);
144 printk(KERN_WARNING PREFIX "Invalid package element"
145 " [%d] got string/buffer,"
147 i, format_string[i]);
153 case ACPI_TYPE_PACKAGE:
155 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
156 "Found unsupported element at index=%d\n",
158 /* TBD: handle nested packages... */
165 * Validate output buffer.
167 if (buffer->length == ACPI_ALLOCATE_BUFFER) {
168 buffer->pointer = ACPI_ALLOCATE(size_required);
169 if (!buffer->pointer)
171 buffer->length = size_required;
172 memset(buffer->pointer, 0, size_required);
174 if (buffer->length < size_required) {
175 buffer->length = size_required;
176 return AE_BUFFER_OVERFLOW;
177 } else if (buffer->length != size_required ||
179 return AE_BAD_PARAMETER;
183 head = buffer->pointer;
184 tail = buffer->pointer + tail_offset;
187 * Extract package data.
189 for (i = 0; i < format_count; i++) {
192 union acpi_object *element = &(package->package.elements[i]);
198 switch (element->type) {
200 case ACPI_TYPE_INTEGER:
201 switch (format_string[i]) {
204 element->integer.value;
208 pointer = (u8 **) head;
211 element->integer.value;
212 head += sizeof(u64 *);
214 /* NULL terminate string */
216 tail += sizeof(char);
219 /* Should never get here */
224 case ACPI_TYPE_STRING:
225 case ACPI_TYPE_BUFFER:
226 switch (format_string[i]) {
228 pointer = (u8 **) head;
230 memcpy(tail, element->string.pointer,
231 element->string.length);
232 head += sizeof(char *);
233 tail += element->string.length * sizeof(char);
234 /* NULL terminate string */
236 tail += sizeof(char);
239 pointer = (u8 **) head;
241 memcpy(tail, element->buffer.pointer,
242 element->buffer.length);
243 head += sizeof(u8 *);
244 tail += element->buffer.length * sizeof(u8);
247 /* Should never get here */
252 case ACPI_TYPE_PACKAGE:
253 /* TBD: handle nested packages... */
255 /* Should never get here */
263 EXPORT_SYMBOL(acpi_extract_package);
266 acpi_evaluate_integer(acpi_handle handle,
267 acpi_string pathname,
268 struct acpi_object_list *arguments, unsigned long long *data)
270 acpi_status status = AE_OK;
271 union acpi_object element;
272 struct acpi_buffer buffer = { 0, NULL };
275 return AE_BAD_PARAMETER;
277 buffer.length = sizeof(union acpi_object);
278 buffer.pointer = &element;
279 status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
280 if (ACPI_FAILURE(status)) {
281 acpi_util_eval_error(handle, pathname, status);
285 if (element.type != ACPI_TYPE_INTEGER) {
286 acpi_util_eval_error(handle, pathname, AE_BAD_DATA);
290 *data = element.integer.value;
292 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Return value [%llu]\n", *data));
297 EXPORT_SYMBOL(acpi_evaluate_integer);
300 acpi_evaluate_reference(acpi_handle handle,
301 acpi_string pathname,
302 struct acpi_object_list *arguments,
303 struct acpi_handle_list *list)
305 acpi_status status = AE_OK;
306 union acpi_object *package = NULL;
307 union acpi_object *element = NULL;
308 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
313 return AE_BAD_PARAMETER;
316 /* Evaluate object. */
318 status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
319 if (ACPI_FAILURE(status))
322 package = buffer.pointer;
324 if ((buffer.length == 0) || !package) {
325 printk(KERN_ERR PREFIX "No return object (len %X ptr %p)\n",
326 (unsigned)buffer.length, package);
327 status = AE_BAD_DATA;
328 acpi_util_eval_error(handle, pathname, status);
331 if (package->type != ACPI_TYPE_PACKAGE) {
332 printk(KERN_ERR PREFIX "Expecting a [Package], found type %X\n",
334 status = AE_BAD_DATA;
335 acpi_util_eval_error(handle, pathname, status);
338 if (!package->package.count) {
339 printk(KERN_ERR PREFIX "[Package] has zero elements (%p)\n",
341 status = AE_BAD_DATA;
342 acpi_util_eval_error(handle, pathname, status);
346 if (package->package.count > ACPI_MAX_HANDLES) {
349 list->count = package->package.count;
351 /* Extract package data. */
353 for (i = 0; i < list->count; i++) {
355 element = &(package->package.elements[i]);
357 if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
358 status = AE_BAD_DATA;
359 printk(KERN_ERR PREFIX
360 "Expecting a [Reference] package element, found type %X\n",
362 acpi_util_eval_error(handle, pathname, status);
366 if (!element->reference.handle) {
367 printk(KERN_WARNING PREFIX "Invalid reference in"
368 " package %s\n", pathname);
369 status = AE_NULL_ENTRY;
372 /* Get the acpi_handle. */
374 list->handles[i] = element->reference.handle;
375 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found reference [%p]\n",
380 if (ACPI_FAILURE(status)) {
382 //kfree(list->handles);
385 kfree(buffer.pointer);
390 EXPORT_SYMBOL(acpi_evaluate_reference);
393 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld)
396 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
397 union acpi_object *output;
399 status = acpi_evaluate_object(handle, "_PLD", NULL, &buffer);
401 if (ACPI_FAILURE(status))
404 output = buffer.pointer;
406 if (!output || output->type != ACPI_TYPE_PACKAGE
407 || !output->package.count
408 || output->package.elements[0].type != ACPI_TYPE_BUFFER
409 || output->package.elements[0].buffer.length < ACPI_PLD_REV1_BUFFER_SIZE) {
414 status = acpi_decode_pld_buffer(
415 output->package.elements[0].buffer.pointer,
416 output->package.elements[0].buffer.length,
420 kfree(buffer.pointer);
423 EXPORT_SYMBOL(acpi_get_physical_device_location);
426 * acpi_evaluate_hotplug_ost: Evaluate _OST for hotplug operations
427 * @handle: ACPI device handle
428 * @source_event: source event code
429 * @status_code: status code
430 * @status_buf: optional detailed information (NULL if none)
432 * Evaluate _OST for hotplug operations. All ACPI hotplug handlers
433 * must call this function when evaluating _OST for hotplug operations.
434 * When the platform does not support _OST, this function has no effect.
437 acpi_evaluate_hotplug_ost(acpi_handle handle, u32 source_event,
438 u32 status_code, struct acpi_buffer *status_buf)
440 #ifdef ACPI_HOTPLUG_OST
441 union acpi_object params[3] = {
442 {.type = ACPI_TYPE_INTEGER,},
443 {.type = ACPI_TYPE_INTEGER,},
444 {.type = ACPI_TYPE_BUFFER,}
446 struct acpi_object_list arg_list = {3, params};
449 params[0].integer.value = source_event;
450 params[1].integer.value = status_code;
451 if (status_buf != NULL) {
452 params[2].buffer.pointer = status_buf->pointer;
453 params[2].buffer.length = status_buf->length;
455 params[2].buffer.pointer = NULL;
456 params[2].buffer.length = 0;
459 status = acpi_evaluate_object(handle, "_OST", &arg_list, NULL);
465 EXPORT_SYMBOL(acpi_evaluate_hotplug_ost);
468 * acpi_handle_path: Return the object path of handle
470 * Caller must free the returned buffer
472 static char *acpi_handle_path(acpi_handle handle)
474 struct acpi_buffer buffer = {
475 .length = ACPI_ALLOCATE_BUFFER,
479 if (in_interrupt() ||
480 acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer) != AE_OK)
482 return buffer.pointer;
486 * acpi_handle_printk: Print message with ACPI prefix and object path
488 * This function is called through acpi_handle_<level> macros and prints
489 * a message with ACPI prefix and object path. This function acquires
490 * the global namespace mutex to obtain an object path. In interrupt
491 * context, it shows the object path as <n/a>.
494 acpi_handle_printk(const char *level, acpi_handle handle, const char *fmt, ...)
496 struct va_format vaf;
504 path = acpi_handle_path(handle);
505 printk("%sACPI: %s: %pV", level, path ? path : "<n/a>" , &vaf);
510 EXPORT_SYMBOL(acpi_handle_printk);
512 #if defined(CONFIG_DYNAMIC_DEBUG)
514 * __acpi_handle_debug: pr_debug with ACPI prefix and object path
516 * This function is called through acpi_handle_debug macro and debug
517 * prints a message with ACPI prefix and object path. This function
518 * acquires the global namespace mutex to obtain an object path. In
519 * interrupt context, it shows the object path as <n/a>.
522 __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle,
523 const char *fmt, ...)
525 struct va_format vaf;
533 path = acpi_handle_path(handle);
534 __dynamic_pr_debug(descriptor, "ACPI: %s: %pV", path ? path : "<n/a>", &vaf);
539 EXPORT_SYMBOL(__acpi_handle_debug);
543 * acpi_has_method: Check whether @handle has a method named @name
544 * @handle: ACPI device handle
545 * @name: name of object or method
547 * Check whether @handle has a method named @name.
549 bool acpi_has_method(acpi_handle handle, char *name)
553 return ACPI_SUCCESS(acpi_get_handle(handle, name, &tmp));
555 EXPORT_SYMBOL(acpi_has_method);
557 acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
560 union acpi_object obj = { .type = ACPI_TYPE_INTEGER };
561 struct acpi_object_list arg_list = { .count = 1, .pointer = &obj, };
563 obj.integer.value = arg;
565 return acpi_evaluate_object(handle, method, &arg_list, NULL);
567 EXPORT_SYMBOL(acpi_execute_simple_method);
570 * acpi_evaluate_ej0: Evaluate _EJ0 method for hotplug operations
571 * @handle: ACPI device handle
573 * Evaluate device's _EJ0 method for hotplug operations.
575 acpi_status acpi_evaluate_ej0(acpi_handle handle)
579 status = acpi_execute_simple_method(handle, "_EJ0", 1);
580 if (status == AE_NOT_FOUND)
581 acpi_handle_warn(handle, "No _EJ0 support for device\n");
582 else if (ACPI_FAILURE(status))
583 acpi_handle_warn(handle, "Eject failed (0x%x)\n", status);
589 * acpi_evaluate_lck: Evaluate _LCK method to lock/unlock device
590 * @handle: ACPI device handle
591 * @lock: lock device if non-zero, otherwise unlock device
593 * Evaluate device's _LCK method if present to lock/unlock device
595 acpi_status acpi_evaluate_lck(acpi_handle handle, int lock)
599 status = acpi_execute_simple_method(handle, "_LCK", !!lock);
600 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
602 acpi_handle_warn(handle,
603 "Locking device failed (0x%x)\n", status);
605 acpi_handle_warn(handle,
606 "Unlocking device failed (0x%x)\n", status);
613 * acpi_evaluate_dsm - evaluate device's _DSM method
614 * @handle: ACPI device handle
615 * @uuid: UUID of requested functions, should be 16 bytes
616 * @rev: revision number of requested function
617 * @func: requested function number
618 * @argv4: the function specific parameter
620 * Evaluate device's _DSM method with specified UUID, revision id and
621 * function number. Caller needs to free the returned object.
623 * Though ACPI defines the fourth parameter for _DSM should be a package,
624 * some old BIOSes do expect a buffer or an integer etc.
627 acpi_evaluate_dsm(acpi_handle handle, const u8 *uuid, int rev, int func,
628 union acpi_object *argv4)
631 struct acpi_buffer buf = {ACPI_ALLOCATE_BUFFER, NULL};
632 union acpi_object params[4];
633 struct acpi_object_list input = {
638 params[0].type = ACPI_TYPE_BUFFER;
639 params[0].buffer.length = 16;
640 params[0].buffer.pointer = (char *)uuid;
641 params[1].type = ACPI_TYPE_INTEGER;
642 params[1].integer.value = rev;
643 params[2].type = ACPI_TYPE_INTEGER;
644 params[2].integer.value = func;
648 params[3].type = ACPI_TYPE_PACKAGE;
649 params[3].package.count = 0;
650 params[3].package.elements = NULL;
653 ret = acpi_evaluate_object(handle, "_DSM", &input, &buf);
654 if (ACPI_SUCCESS(ret))
655 return (union acpi_object *)buf.pointer;
657 if (ret != AE_NOT_FOUND)
658 acpi_handle_warn(handle,
659 "failed to evaluate _DSM (0x%x)\n", ret);
663 EXPORT_SYMBOL(acpi_evaluate_dsm);
666 * acpi_check_dsm - check if _DSM method supports requested functions.
667 * @handle: ACPI device handle
668 * @uuid: UUID of requested functions, should be 16 bytes at least
669 * @rev: revision number of requested functions
670 * @funcs: bitmap of requested functions
671 * @exclude: excluding special value, used to support i915 and nouveau
673 * Evaluate device's _DSM method to check whether it supports requested
674 * functions. Currently only support 64 functions at maximum, should be
677 bool acpi_check_dsm(acpi_handle handle, const u8 *uuid, int rev, u64 funcs)
681 union acpi_object *obj;
686 obj = acpi_evaluate_dsm(handle, uuid, rev, 0, NULL);
690 /* For compatibility, old BIOSes may return an integer */
691 if (obj->type == ACPI_TYPE_INTEGER)
692 mask = obj->integer.value;
693 else if (obj->type == ACPI_TYPE_BUFFER)
694 for (i = 0; i < obj->buffer.length && i < 8; i++)
695 mask |= (((u8)obj->buffer.pointer[i]) << (i * 8));
699 * Bit 0 indicates whether there's support for any functions other than
700 * function 0 for the specified UUID and revision.
702 if ((mask & 0x1) && (mask & funcs) == funcs)
707 EXPORT_SYMBOL(acpi_check_dsm);