1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * acpi_utils.c - ACPI Utility Functions ($Revision: 10 $)
9 #include <linux/kernel.h>
10 #include <linux/module.h>
11 #include <linux/slab.h>
12 #include <linux/init.h>
13 #include <linux/types.h>
14 #include <linux/hardirq.h>
15 #include <linux/acpi.h>
16 #include <linux/dynamic_debug.h>
21 #define _COMPONENT ACPI_BUS_COMPONENT
22 ACPI_MODULE_NAME("utils");
24 /* --------------------------------------------------------------------------
25 Object Evaluation Helpers
26 -------------------------------------------------------------------------- */
28 acpi_util_eval_error(acpi_handle h, acpi_string p, acpi_status s)
30 #ifdef ACPI_DEBUG_OUTPUT
31 char prefix[80] = {'\0'};
32 struct acpi_buffer buffer = {sizeof(prefix), prefix};
33 acpi_get_name(h, ACPI_FULL_PATHNAME, &buffer);
34 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluate [%s.%s]: %s\n",
35 (char *) prefix, p, acpi_format_exception(s)));
42 acpi_extract_package(union acpi_object *package,
43 struct acpi_buffer *format, struct acpi_buffer *buffer)
45 u32 size_required = 0;
47 char *format_string = NULL;
54 if (!package || (package->type != ACPI_TYPE_PACKAGE)
55 || (package->package.count < 1)) {
56 printk(KERN_WARNING PREFIX "Invalid package argument\n");
57 return AE_BAD_PARAMETER;
60 if (!format || !format->pointer || (format->length < 1)) {
61 printk(KERN_WARNING PREFIX "Invalid format argument\n");
62 return AE_BAD_PARAMETER;
66 printk(KERN_WARNING PREFIX "Invalid buffer argument\n");
67 return AE_BAD_PARAMETER;
70 format_count = (format->length / sizeof(char)) - 1;
71 if (format_count > package->package.count) {
72 printk(KERN_WARNING PREFIX "Format specifies more objects [%d]"
73 " than exist in package [%d].\n",
74 format_count, package->package.count);
78 format_string = format->pointer;
81 * Calculate size_required.
83 for (i = 0; i < format_count; i++) {
85 union acpi_object *element = &(package->package.elements[i]);
87 switch (element->type) {
89 case ACPI_TYPE_INTEGER:
90 switch (format_string[i]) {
92 size_required += sizeof(u64);
93 tail_offset += sizeof(u64);
97 sizeof(char *) + sizeof(u64) +
99 tail_offset += sizeof(char *);
102 printk(KERN_WARNING PREFIX "Invalid package element"
103 " [%d]: got number, expecting"
105 i, format_string[i]);
111 case ACPI_TYPE_STRING:
112 case ACPI_TYPE_BUFFER:
113 switch (format_string[i]) {
117 (element->string.length * sizeof(char)) +
119 tail_offset += sizeof(char *);
123 sizeof(u8 *) + element->buffer.length;
124 tail_offset += sizeof(u8 *);
127 printk(KERN_WARNING PREFIX "Invalid package element"
128 " [%d] got string/buffer,"
130 i, format_string[i]);
135 case ACPI_TYPE_LOCAL_REFERENCE:
136 switch (format_string[i]) {
138 size_required += sizeof(void *);
139 tail_offset += sizeof(void *);
142 printk(KERN_WARNING PREFIX "Invalid package element"
143 " [%d] got reference,"
145 i, format_string[i]);
151 case ACPI_TYPE_PACKAGE:
153 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
154 "Found unsupported element at index=%d\n",
156 /* TBD: handle nested packages... */
163 * Validate output buffer.
165 if (buffer->length == ACPI_ALLOCATE_BUFFER) {
166 buffer->pointer = ACPI_ALLOCATE_ZEROED(size_required);
167 if (!buffer->pointer)
169 buffer->length = size_required;
171 if (buffer->length < size_required) {
172 buffer->length = size_required;
173 return AE_BUFFER_OVERFLOW;
174 } else if (buffer->length != size_required ||
176 return AE_BAD_PARAMETER;
180 head = buffer->pointer;
181 tail = buffer->pointer + tail_offset;
184 * Extract package data.
186 for (i = 0; i < format_count; i++) {
189 union acpi_object *element = &(package->package.elements[i]);
191 switch (element->type) {
193 case ACPI_TYPE_INTEGER:
194 switch (format_string[i]) {
197 element->integer.value;
201 pointer = (u8 **) head;
204 element->integer.value;
205 head += sizeof(u64 *);
207 /* NULL terminate string */
209 tail += sizeof(char);
212 /* Should never get here */
217 case ACPI_TYPE_STRING:
218 case ACPI_TYPE_BUFFER:
219 switch (format_string[i]) {
221 pointer = (u8 **) head;
223 memcpy(tail, element->string.pointer,
224 element->string.length);
225 head += sizeof(char *);
226 tail += element->string.length * sizeof(char);
227 /* NULL terminate string */
229 tail += sizeof(char);
232 pointer = (u8 **) head;
234 memcpy(tail, element->buffer.pointer,
235 element->buffer.length);
236 head += sizeof(u8 *);
237 tail += element->buffer.length;
240 /* Should never get here */
244 case ACPI_TYPE_LOCAL_REFERENCE:
245 switch (format_string[i]) {
248 (void *)element->reference.handle;
249 head += sizeof(void *);
252 /* Should never get here */
256 case ACPI_TYPE_PACKAGE:
257 /* TBD: handle nested packages... */
259 /* Should never get here */
267 EXPORT_SYMBOL(acpi_extract_package);
270 acpi_evaluate_integer(acpi_handle handle,
271 acpi_string pathname,
272 struct acpi_object_list *arguments, unsigned long long *data)
274 acpi_status status = AE_OK;
275 union acpi_object element;
276 struct acpi_buffer buffer = { 0, NULL };
279 return AE_BAD_PARAMETER;
281 buffer.length = sizeof(union acpi_object);
282 buffer.pointer = &element;
283 status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
284 if (ACPI_FAILURE(status)) {
285 acpi_util_eval_error(handle, pathname, status);
289 if (element.type != ACPI_TYPE_INTEGER) {
290 acpi_util_eval_error(handle, pathname, AE_BAD_DATA);
294 *data = element.integer.value;
296 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Return value [%llu]\n", *data));
301 EXPORT_SYMBOL(acpi_evaluate_integer);
304 acpi_evaluate_reference(acpi_handle handle,
305 acpi_string pathname,
306 struct acpi_object_list *arguments,
307 struct acpi_handle_list *list)
309 acpi_status status = AE_OK;
310 union acpi_object *package = NULL;
311 union acpi_object *element = NULL;
312 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
317 return AE_BAD_PARAMETER;
320 /* Evaluate object. */
322 status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
323 if (ACPI_FAILURE(status))
326 package = buffer.pointer;
328 if ((buffer.length == 0) || !package) {
329 status = AE_BAD_DATA;
330 acpi_util_eval_error(handle, pathname, status);
333 if (package->type != ACPI_TYPE_PACKAGE) {
334 status = AE_BAD_DATA;
335 acpi_util_eval_error(handle, pathname, status);
338 if (!package->package.count) {
339 status = AE_BAD_DATA;
340 acpi_util_eval_error(handle, pathname, status);
344 if (package->package.count > ACPI_MAX_HANDLES) {
348 list->count = package->package.count;
350 /* Extract package data. */
352 for (i = 0; i < list->count; i++) {
354 element = &(package->package.elements[i]);
356 if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
357 status = AE_BAD_DATA;
358 acpi_util_eval_error(handle, pathname, status);
362 if (!element->reference.handle) {
363 status = AE_NULL_ENTRY;
364 acpi_util_eval_error(handle, pathname, status);
367 /* Get the acpi_handle. */
369 list->handles[i] = element->reference.handle;
370 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found reference [%p]\n",
375 if (ACPI_FAILURE(status)) {
377 //kfree(list->handles);
380 kfree(buffer.pointer);
385 EXPORT_SYMBOL(acpi_evaluate_reference);
388 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld)
391 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
392 union acpi_object *output;
394 status = acpi_evaluate_object(handle, "_PLD", NULL, &buffer);
396 if (ACPI_FAILURE(status))
399 output = buffer.pointer;
401 if (!output || output->type != ACPI_TYPE_PACKAGE
402 || !output->package.count
403 || output->package.elements[0].type != ACPI_TYPE_BUFFER
404 || output->package.elements[0].buffer.length < ACPI_PLD_REV1_BUFFER_SIZE) {
409 status = acpi_decode_pld_buffer(
410 output->package.elements[0].buffer.pointer,
411 output->package.elements[0].buffer.length,
415 kfree(buffer.pointer);
418 EXPORT_SYMBOL(acpi_get_physical_device_location);
421 * acpi_evaluate_ost: Evaluate _OST for hotplug operations
422 * @handle: ACPI device handle
423 * @source_event: source event code
424 * @status_code: status code
425 * @status_buf: optional detailed information (NULL if none)
427 * Evaluate _OST for hotplug operations. All ACPI hotplug handlers
428 * must call this function when evaluating _OST for hotplug operations.
429 * When the platform does not support _OST, this function has no effect.
432 acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code,
433 struct acpi_buffer *status_buf)
435 union acpi_object params[3] = {
436 {.type = ACPI_TYPE_INTEGER,},
437 {.type = ACPI_TYPE_INTEGER,},
438 {.type = ACPI_TYPE_BUFFER,}
440 struct acpi_object_list arg_list = {3, params};
442 params[0].integer.value = source_event;
443 params[1].integer.value = status_code;
444 if (status_buf != NULL) {
445 params[2].buffer.pointer = status_buf->pointer;
446 params[2].buffer.length = status_buf->length;
448 params[2].buffer.pointer = NULL;
449 params[2].buffer.length = 0;
452 return acpi_evaluate_object(handle, "_OST", &arg_list, NULL);
454 EXPORT_SYMBOL(acpi_evaluate_ost);
457 * acpi_handle_path: Return the object path of handle
459 * Caller must free the returned buffer
461 static char *acpi_handle_path(acpi_handle handle)
463 struct acpi_buffer buffer = {
464 .length = ACPI_ALLOCATE_BUFFER,
468 if (in_interrupt() ||
469 acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer) != AE_OK)
471 return buffer.pointer;
475 * acpi_handle_printk: Print message with ACPI prefix and object path
477 * This function is called through acpi_handle_<level> macros and prints
478 * a message with ACPI prefix and object path. This function acquires
479 * the global namespace mutex to obtain an object path. In interrupt
480 * context, it shows the object path as <n/a>.
483 acpi_handle_printk(const char *level, acpi_handle handle, const char *fmt, ...)
485 struct va_format vaf;
493 path = acpi_handle_path(handle);
494 printk("%sACPI: %s: %pV", level, path ? path : "<n/a>" , &vaf);
499 EXPORT_SYMBOL(acpi_handle_printk);
501 #if defined(CONFIG_DYNAMIC_DEBUG)
503 * __acpi_handle_debug: pr_debug with ACPI prefix and object path
505 * This function is called through acpi_handle_debug macro and debug
506 * prints a message with ACPI prefix and object path. This function
507 * acquires the global namespace mutex to obtain an object path. In
508 * interrupt context, it shows the object path as <n/a>.
511 __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle,
512 const char *fmt, ...)
514 struct va_format vaf;
522 path = acpi_handle_path(handle);
523 __dynamic_pr_debug(descriptor, "ACPI: %s: %pV", path ? path : "<n/a>", &vaf);
528 EXPORT_SYMBOL(__acpi_handle_debug);
532 * acpi_has_method: Check whether @handle has a method named @name
533 * @handle: ACPI device handle
534 * @name: name of object or method
536 * Check whether @handle has a method named @name.
538 bool acpi_has_method(acpi_handle handle, char *name)
542 return ACPI_SUCCESS(acpi_get_handle(handle, name, &tmp));
544 EXPORT_SYMBOL(acpi_has_method);
546 acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
549 union acpi_object obj = { .type = ACPI_TYPE_INTEGER };
550 struct acpi_object_list arg_list = { .count = 1, .pointer = &obj, };
552 obj.integer.value = arg;
554 return acpi_evaluate_object(handle, method, &arg_list, NULL);
556 EXPORT_SYMBOL(acpi_execute_simple_method);
559 * acpi_evaluate_ej0: Evaluate _EJ0 method for hotplug operations
560 * @handle: ACPI device handle
562 * Evaluate device's _EJ0 method for hotplug operations.
564 acpi_status acpi_evaluate_ej0(acpi_handle handle)
568 status = acpi_execute_simple_method(handle, "_EJ0", 1);
569 if (status == AE_NOT_FOUND)
570 acpi_handle_warn(handle, "No _EJ0 support for device\n");
571 else if (ACPI_FAILURE(status))
572 acpi_handle_warn(handle, "Eject failed (0x%x)\n", status);
578 * acpi_evaluate_lck: Evaluate _LCK method to lock/unlock device
579 * @handle: ACPI device handle
580 * @lock: lock device if non-zero, otherwise unlock device
582 * Evaluate device's _LCK method if present to lock/unlock device
584 acpi_status acpi_evaluate_lck(acpi_handle handle, int lock)
588 status = acpi_execute_simple_method(handle, "_LCK", !!lock);
589 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
591 acpi_handle_warn(handle,
592 "Locking device failed (0x%x)\n", status);
594 acpi_handle_warn(handle,
595 "Unlocking device failed (0x%x)\n", status);
602 * acpi_evaluate_dsm - evaluate device's _DSM method
603 * @handle: ACPI device handle
604 * @guid: GUID of requested functions, should be 16 bytes
605 * @rev: revision number of requested function
606 * @func: requested function number
607 * @argv4: the function specific parameter
609 * Evaluate device's _DSM method with specified GUID, revision id and
610 * function number. Caller needs to free the returned object.
612 * Though ACPI defines the fourth parameter for _DSM should be a package,
613 * some old BIOSes do expect a buffer or an integer etc.
616 acpi_evaluate_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 func,
617 union acpi_object *argv4)
620 struct acpi_buffer buf = {ACPI_ALLOCATE_BUFFER, NULL};
621 union acpi_object params[4];
622 struct acpi_object_list input = {
627 params[0].type = ACPI_TYPE_BUFFER;
628 params[0].buffer.length = 16;
629 params[0].buffer.pointer = (u8 *)guid;
630 params[1].type = ACPI_TYPE_INTEGER;
631 params[1].integer.value = rev;
632 params[2].type = ACPI_TYPE_INTEGER;
633 params[2].integer.value = func;
637 params[3].type = ACPI_TYPE_PACKAGE;
638 params[3].package.count = 0;
639 params[3].package.elements = NULL;
642 ret = acpi_evaluate_object(handle, "_DSM", &input, &buf);
643 if (ACPI_SUCCESS(ret))
644 return (union acpi_object *)buf.pointer;
646 if (ret != AE_NOT_FOUND)
647 acpi_handle_warn(handle,
648 "failed to evaluate _DSM (0x%x)\n", ret);
652 EXPORT_SYMBOL(acpi_evaluate_dsm);
655 * acpi_check_dsm - check if _DSM method supports requested functions.
656 * @handle: ACPI device handle
657 * @guid: GUID of requested functions, should be 16 bytes at least
658 * @rev: revision number of requested functions
659 * @funcs: bitmap of requested functions
661 * Evaluate device's _DSM method to check whether it supports requested
662 * functions. Currently only support 64 functions at maximum, should be
665 bool acpi_check_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 funcs)
669 union acpi_object *obj;
674 obj = acpi_evaluate_dsm(handle, guid, rev, 0, NULL);
678 /* For compatibility, old BIOSes may return an integer */
679 if (obj->type == ACPI_TYPE_INTEGER)
680 mask = obj->integer.value;
681 else if (obj->type == ACPI_TYPE_BUFFER)
682 for (i = 0; i < obj->buffer.length && i < 8; i++)
683 mask |= (((u64)obj->buffer.pointer[i]) << (i * 8));
687 * Bit 0 indicates whether there's support for any functions other than
688 * function 0 for the specified GUID and revision.
690 if ((mask & 0x1) && (mask & funcs) == funcs)
695 EXPORT_SYMBOL(acpi_check_dsm);
698 * acpi_dev_found - Detect presence of a given ACPI device in the namespace.
699 * @hid: Hardware ID of the device.
701 * Return %true if the device was present at the moment of invocation.
702 * Note that if the device is pluggable, it may since have disappeared.
704 * For this function to work, acpi_bus_scan() must have been executed
705 * which happens in the subsys_initcall() subsection. Hence, do not
706 * call from a subsys_initcall() or earlier (use acpi_get_devices()
707 * instead). Calling from module_init() is fine (which is synonymous
708 * with device_initcall()).
710 bool acpi_dev_found(const char *hid)
712 struct acpi_device_bus_id *acpi_device_bus_id;
715 mutex_lock(&acpi_device_lock);
716 list_for_each_entry(acpi_device_bus_id, &acpi_bus_id_list, node)
717 if (!strcmp(acpi_device_bus_id->bus_id, hid)) {
721 mutex_unlock(&acpi_device_lock);
725 EXPORT_SYMBOL(acpi_dev_found);
727 struct acpi_dev_match_info {
728 struct acpi_device_id hid[2];
733 static int acpi_dev_match_cb(struct device *dev, const void *data)
735 struct acpi_device *adev = to_acpi_device(dev);
736 const struct acpi_dev_match_info *match = data;
737 unsigned long long hrv;
740 if (acpi_match_device_ids(adev, match->hid))
743 if (match->uid && (!adev->pnp.unique_id ||
744 strcmp(adev->pnp.unique_id, match->uid)))
747 if (match->hrv == -1)
750 status = acpi_evaluate_integer(adev->handle, "_HRV", NULL, &hrv);
751 if (ACPI_FAILURE(status))
754 return hrv == match->hrv;
758 * acpi_dev_present - Detect that a given ACPI device is present
759 * @hid: Hardware ID of the device.
760 * @uid: Unique ID of the device, pass NULL to not check _UID
761 * @hrv: Hardware Revision of the device, pass -1 to not check _HRV
763 * Return %true if a matching device was present at the moment of invocation.
764 * Note that if the device is pluggable, it may since have disappeared.
766 * Note that unlike acpi_dev_found() this function checks the status
767 * of the device. So for devices which are present in the dsdt, but
768 * which are disabled (their _STA callback returns 0) this function
771 * For this function to work, acpi_bus_scan() must have been executed
772 * which happens in the subsys_initcall() subsection. Hence, do not
773 * call from a subsys_initcall() or earlier (use acpi_get_devices()
774 * instead). Calling from module_init() is fine (which is synonymous
775 * with device_initcall()).
777 bool acpi_dev_present(const char *hid, const char *uid, s64 hrv)
779 struct acpi_dev_match_info match = {};
782 strlcpy(match.hid[0].id, hid, sizeof(match.hid[0].id));
786 dev = bus_find_device(&acpi_bus_type, NULL, &match, acpi_dev_match_cb);
790 EXPORT_SYMBOL(acpi_dev_present);
793 * acpi_dev_get_first_match_dev - Return the first match of ACPI device
794 * @hid: Hardware ID of the device.
795 * @uid: Unique ID of the device, pass NULL to not check _UID
796 * @hrv: Hardware Revision of the device, pass -1 to not check _HRV
798 * Return the first match of ACPI device if a matching device was present
799 * at the moment of invocation, or NULL otherwise.
801 * The caller is responsible to call put_device() on the returned device.
803 * See additional information in acpi_dev_present() as well.
806 acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv)
808 struct acpi_dev_match_info match = {};
811 strlcpy(match.hid[0].id, hid, sizeof(match.hid[0].id));
815 dev = bus_find_device(&acpi_bus_type, NULL, &match, acpi_dev_match_cb);
816 return dev ? to_acpi_device(dev) : NULL;
818 EXPORT_SYMBOL(acpi_dev_get_first_match_dev);
821 * acpi_backlight= handling, this is done here rather then in video_detect.c
822 * because __setup cannot be used in modules.
824 char acpi_video_backlight_string[16];
825 EXPORT_SYMBOL(acpi_video_backlight_string);
827 static int __init acpi_backlight(char *str)
829 strlcpy(acpi_video_backlight_string, str,
830 sizeof(acpi_video_backlight_string));
833 __setup("acpi_backlight=", acpi_backlight);
836 * acpi_match_platform_list - Check if the system matches with a given list
837 * @plat: pointer to acpi_platform_list table terminated by a NULL entry
839 * Return the matched index if the system is found in the platform list.
840 * Otherwise, return a negative error code.
842 int acpi_match_platform_list(const struct acpi_platform_list *plat)
844 struct acpi_table_header hdr;
850 for (; plat->oem_id[0]; plat++, idx++) {
851 if (ACPI_FAILURE(acpi_get_table_header(plat->table, 0, &hdr)))
854 if (strncmp(plat->oem_id, hdr.oem_id, ACPI_OEM_ID_SIZE))
857 if (strncmp(plat->oem_table_id, hdr.oem_table_id, ACPI_OEM_TABLE_ID_SIZE))
860 if ((plat->pred == all_versions) ||
861 (plat->pred == less_than_or_equal && hdr.oem_revision <= plat->oem_revision) ||
862 (plat->pred == greater_than_or_equal && hdr.oem_revision >= plat->oem_revision) ||
863 (plat->pred == equal && hdr.oem_revision == plat->oem_revision))
869 EXPORT_SYMBOL(acpi_match_platform_list);