xref: /linux/drivers/acpi/utils.c (revision e7b07d3e)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *  acpi_utils.c - ACPI Utility Functions ($Revision: 10 $)
4  *
5  *  Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
6  *  Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
7  */
8 
9 #define pr_fmt(fmt) "ACPI: utils: " fmt
10 
11 #include <linux/kernel.h>
12 #include <linux/module.h>
13 #include <linux/slab.h>
14 #include <linux/init.h>
15 #include <linux/types.h>
16 #include <linux/hardirq.h>
17 #include <linux/acpi.h>
18 #include <linux/dynamic_debug.h>
19 
20 #include "internal.h"
21 #include "sleep.h"
22 
23 /* --------------------------------------------------------------------------
24                             Object Evaluation Helpers
25    -------------------------------------------------------------------------- */
26 static void acpi_util_eval_error(acpi_handle h, acpi_string p, acpi_status s)
27 {
28 	acpi_handle_debug(h, "Evaluate [%s]: %s\n", p, acpi_format_exception(s));
29 }
30 
31 acpi_status
32 acpi_extract_package(union acpi_object *package,
33 		     struct acpi_buffer *format, struct acpi_buffer *buffer)
34 {
35 	u32 size_required = 0;
36 	u32 tail_offset = 0;
37 	char *format_string = NULL;
38 	u32 format_count = 0;
39 	u32 i = 0;
40 	u8 *head = NULL;
41 	u8 *tail = NULL;
42 
43 
44 	if (!package || (package->type != ACPI_TYPE_PACKAGE)
45 	    || (package->package.count < 1)) {
46 		pr_debug("Invalid package argument\n");
47 		return AE_BAD_PARAMETER;
48 	}
49 
50 	if (!format || !format->pointer || (format->length < 1)) {
51 		pr_debug("Invalid format argument\n");
52 		return AE_BAD_PARAMETER;
53 	}
54 
55 	if (!buffer) {
56 		pr_debug("Invalid buffer argument\n");
57 		return AE_BAD_PARAMETER;
58 	}
59 
60 	format_count = (format->length / sizeof(char)) - 1;
61 	if (format_count > package->package.count) {
62 		pr_debug("Format specifies more objects [%d] than present [%d]\n",
63 			 format_count, package->package.count);
64 		return AE_BAD_DATA;
65 	}
66 
67 	format_string = format->pointer;
68 
69 	/*
70 	 * Calculate size_required.
71 	 */
72 	for (i = 0; i < format_count; i++) {
73 
74 		union acpi_object *element = &(package->package.elements[i]);
75 
76 		switch (element->type) {
77 
78 		case ACPI_TYPE_INTEGER:
79 			switch (format_string[i]) {
80 			case 'N':
81 				size_required += sizeof(u64);
82 				tail_offset += sizeof(u64);
83 				break;
84 			case 'S':
85 				size_required +=
86 				    sizeof(char *) + sizeof(u64) +
87 				    sizeof(char);
88 				tail_offset += sizeof(char *);
89 				break;
90 			default:
91 				pr_debug("Invalid package element [%d]: got number, expected [%c]\n",
92 					 i, format_string[i]);
93 				return AE_BAD_DATA;
94 			}
95 			break;
96 
97 		case ACPI_TYPE_STRING:
98 		case ACPI_TYPE_BUFFER:
99 			switch (format_string[i]) {
100 			case 'S':
101 				size_required +=
102 				    sizeof(char *) +
103 				    (element->string.length * sizeof(char)) +
104 				    sizeof(char);
105 				tail_offset += sizeof(char *);
106 				break;
107 			case 'B':
108 				size_required +=
109 				    sizeof(u8 *) + element->buffer.length;
110 				tail_offset += sizeof(u8 *);
111 				break;
112 			default:
113 				pr_debug("Invalid package element [%d] got string/buffer, expected [%c]\n",
114 					 i, format_string[i]);
115 				return AE_BAD_DATA;
116 			}
117 			break;
118 		case ACPI_TYPE_LOCAL_REFERENCE:
119 			switch (format_string[i]) {
120 			case 'R':
121 				size_required += sizeof(void *);
122 				tail_offset += sizeof(void *);
123 				break;
124 			default:
125 				pr_debug("Invalid package element [%d] got reference, expected [%c]\n",
126 					 i, format_string[i]);
127 				return AE_BAD_DATA;
128 			}
129 			break;
130 
131 		case ACPI_TYPE_PACKAGE:
132 		default:
133 			pr_debug("Unsupported element at index=%d\n", i);
134 			/* TBD: handle nested packages... */
135 			return AE_SUPPORT;
136 		}
137 	}
138 
139 	/*
140 	 * Validate output buffer.
141 	 */
142 	if (buffer->length == ACPI_ALLOCATE_BUFFER) {
143 		buffer->pointer = ACPI_ALLOCATE_ZEROED(size_required);
144 		if (!buffer->pointer)
145 			return AE_NO_MEMORY;
146 		buffer->length = size_required;
147 	} else {
148 		if (buffer->length < size_required) {
149 			buffer->length = size_required;
150 			return AE_BUFFER_OVERFLOW;
151 		} else if (buffer->length != size_required ||
152 			   !buffer->pointer) {
153 			return AE_BAD_PARAMETER;
154 		}
155 	}
156 
157 	head = buffer->pointer;
158 	tail = buffer->pointer + tail_offset;
159 
160 	/*
161 	 * Extract package data.
162 	 */
163 	for (i = 0; i < format_count; i++) {
164 
165 		u8 **pointer = NULL;
166 		union acpi_object *element = &(package->package.elements[i]);
167 
168 		switch (element->type) {
169 
170 		case ACPI_TYPE_INTEGER:
171 			switch (format_string[i]) {
172 			case 'N':
173 				*((u64 *) head) =
174 				    element->integer.value;
175 				head += sizeof(u64);
176 				break;
177 			case 'S':
178 				pointer = (u8 **) head;
179 				*pointer = tail;
180 				*((u64 *) tail) =
181 				    element->integer.value;
182 				head += sizeof(u64 *);
183 				tail += sizeof(u64);
184 				/* NULL terminate string */
185 				*tail = (char)0;
186 				tail += sizeof(char);
187 				break;
188 			default:
189 				/* Should never get here */
190 				break;
191 			}
192 			break;
193 
194 		case ACPI_TYPE_STRING:
195 		case ACPI_TYPE_BUFFER:
196 			switch (format_string[i]) {
197 			case 'S':
198 				pointer = (u8 **) head;
199 				*pointer = tail;
200 				memcpy(tail, element->string.pointer,
201 				       element->string.length);
202 				head += sizeof(char *);
203 				tail += element->string.length * sizeof(char);
204 				/* NULL terminate string */
205 				*tail = (char)0;
206 				tail += sizeof(char);
207 				break;
208 			case 'B':
209 				pointer = (u8 **) head;
210 				*pointer = tail;
211 				memcpy(tail, element->buffer.pointer,
212 				       element->buffer.length);
213 				head += sizeof(u8 *);
214 				tail += element->buffer.length;
215 				break;
216 			default:
217 				/* Should never get here */
218 				break;
219 			}
220 			break;
221 		case ACPI_TYPE_LOCAL_REFERENCE:
222 			switch (format_string[i]) {
223 			case 'R':
224 				*(void **)head =
225 				    (void *)element->reference.handle;
226 				head += sizeof(void *);
227 				break;
228 			default:
229 				/* Should never get here */
230 				break;
231 			}
232 			break;
233 		case ACPI_TYPE_PACKAGE:
234 			/* TBD: handle nested packages... */
235 		default:
236 			/* Should never get here */
237 			break;
238 		}
239 	}
240 
241 	return AE_OK;
242 }
243 
244 EXPORT_SYMBOL(acpi_extract_package);
245 
246 acpi_status
247 acpi_evaluate_integer(acpi_handle handle,
248 		      acpi_string pathname,
249 		      struct acpi_object_list *arguments, unsigned long long *data)
250 {
251 	acpi_status status = AE_OK;
252 	union acpi_object element;
253 	struct acpi_buffer buffer = { 0, NULL };
254 
255 	if (!data)
256 		return AE_BAD_PARAMETER;
257 
258 	buffer.length = sizeof(union acpi_object);
259 	buffer.pointer = &element;
260 	status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
261 	if (ACPI_FAILURE(status)) {
262 		acpi_util_eval_error(handle, pathname, status);
263 		return status;
264 	}
265 
266 	if (element.type != ACPI_TYPE_INTEGER) {
267 		acpi_util_eval_error(handle, pathname, AE_BAD_DATA);
268 		return AE_BAD_DATA;
269 	}
270 
271 	*data = element.integer.value;
272 
273 	acpi_handle_debug(handle, "Return value [%llu]\n", *data);
274 
275 	return AE_OK;
276 }
277 
278 EXPORT_SYMBOL(acpi_evaluate_integer);
279 
280 acpi_status
281 acpi_evaluate_reference(acpi_handle handle,
282 			acpi_string pathname,
283 			struct acpi_object_list *arguments,
284 			struct acpi_handle_list *list)
285 {
286 	acpi_status status = AE_OK;
287 	union acpi_object *package = NULL;
288 	union acpi_object *element = NULL;
289 	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
290 	u32 i = 0;
291 
292 
293 	if (!list) {
294 		return AE_BAD_PARAMETER;
295 	}
296 
297 	/* Evaluate object. */
298 
299 	status = acpi_evaluate_object(handle, pathname, arguments, &buffer);
300 	if (ACPI_FAILURE(status))
301 		goto end;
302 
303 	package = buffer.pointer;
304 
305 	if ((buffer.length == 0) || !package) {
306 		status = AE_BAD_DATA;
307 		acpi_util_eval_error(handle, pathname, status);
308 		goto end;
309 	}
310 	if (package->type != ACPI_TYPE_PACKAGE) {
311 		status = AE_BAD_DATA;
312 		acpi_util_eval_error(handle, pathname, status);
313 		goto end;
314 	}
315 	if (!package->package.count) {
316 		status = AE_BAD_DATA;
317 		acpi_util_eval_error(handle, pathname, status);
318 		goto end;
319 	}
320 
321 	if (package->package.count > ACPI_MAX_HANDLES) {
322 		kfree(package);
323 		return AE_NO_MEMORY;
324 	}
325 	list->count = package->package.count;
326 
327 	/* Extract package data. */
328 
329 	for (i = 0; i < list->count; i++) {
330 
331 		element = &(package->package.elements[i]);
332 
333 		if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
334 			status = AE_BAD_DATA;
335 			acpi_util_eval_error(handle, pathname, status);
336 			break;
337 		}
338 
339 		if (!element->reference.handle) {
340 			status = AE_NULL_ENTRY;
341 			acpi_util_eval_error(handle, pathname, status);
342 			break;
343 		}
344 		/* Get the  acpi_handle. */
345 
346 		list->handles[i] = element->reference.handle;
347 		acpi_handle_debug(list->handles[i], "Found in reference list\n");
348 	}
349 
350       end:
351 	if (ACPI_FAILURE(status)) {
352 		list->count = 0;
353 		//kfree(list->handles);
354 	}
355 
356 	kfree(buffer.pointer);
357 
358 	return status;
359 }
360 
361 EXPORT_SYMBOL(acpi_evaluate_reference);
362 
363 acpi_status
364 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld)
365 {
366 	acpi_status status;
367 	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
368 	union acpi_object *output;
369 
370 	status = acpi_evaluate_object(handle, "_PLD", NULL, &buffer);
371 
372 	if (ACPI_FAILURE(status))
373 		return status;
374 
375 	output = buffer.pointer;
376 
377 	if (!output || output->type != ACPI_TYPE_PACKAGE
378 	    || !output->package.count
379 	    || output->package.elements[0].type != ACPI_TYPE_BUFFER
380 	    || output->package.elements[0].buffer.length < ACPI_PLD_REV1_BUFFER_SIZE) {
381 		status = AE_TYPE;
382 		goto out;
383 	}
384 
385 	status = acpi_decode_pld_buffer(
386 			output->package.elements[0].buffer.pointer,
387 			output->package.elements[0].buffer.length,
388 			pld);
389 
390 out:
391 	kfree(buffer.pointer);
392 	return status;
393 }
394 EXPORT_SYMBOL(acpi_get_physical_device_location);
395 
396 /**
397  * acpi_evaluate_ost: Evaluate _OST for hotplug operations
398  * @handle: ACPI device handle
399  * @source_event: source event code
400  * @status_code: status code
401  * @status_buf: optional detailed information (NULL if none)
402  *
403  * Evaluate _OST for hotplug operations. All ACPI hotplug handlers
404  * must call this function when evaluating _OST for hotplug operations.
405  * When the platform does not support _OST, this function has no effect.
406  */
407 acpi_status
408 acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code,
409 		  struct acpi_buffer *status_buf)
410 {
411 	union acpi_object params[3] = {
412 		{.type = ACPI_TYPE_INTEGER,},
413 		{.type = ACPI_TYPE_INTEGER,},
414 		{.type = ACPI_TYPE_BUFFER,}
415 	};
416 	struct acpi_object_list arg_list = {3, params};
417 
418 	params[0].integer.value = source_event;
419 	params[1].integer.value = status_code;
420 	if (status_buf != NULL) {
421 		params[2].buffer.pointer = status_buf->pointer;
422 		params[2].buffer.length = status_buf->length;
423 	} else {
424 		params[2].buffer.pointer = NULL;
425 		params[2].buffer.length = 0;
426 	}
427 
428 	return acpi_evaluate_object(handle, "_OST", &arg_list, NULL);
429 }
430 EXPORT_SYMBOL(acpi_evaluate_ost);
431 
432 /**
433  * acpi_handle_path: Return the object path of handle
434  * @handle: ACPI device handle
435  *
436  * Caller must free the returned buffer
437  */
438 static char *acpi_handle_path(acpi_handle handle)
439 {
440 	struct acpi_buffer buffer = {
441 		.length = ACPI_ALLOCATE_BUFFER,
442 		.pointer = NULL
443 	};
444 
445 	if (in_interrupt() ||
446 	    acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer) != AE_OK)
447 		return NULL;
448 	return buffer.pointer;
449 }
450 
451 /**
452  * acpi_handle_printk: Print message with ACPI prefix and object path
453  * @level: log level
454  * @handle: ACPI device handle
455  * @fmt: format string
456  *
457  * This function is called through acpi_handle_<level> macros and prints
458  * a message with ACPI prefix and object path.  This function acquires
459  * the global namespace mutex to obtain an object path.  In interrupt
460  * context, it shows the object path as <n/a>.
461  */
462 void
463 acpi_handle_printk(const char *level, acpi_handle handle, const char *fmt, ...)
464 {
465 	struct va_format vaf;
466 	va_list args;
467 	const char *path;
468 
469 	va_start(args, fmt);
470 	vaf.fmt = fmt;
471 	vaf.va = &args;
472 
473 	path = acpi_handle_path(handle);
474 	printk("%sACPI: %s: %pV", level, path ? path : "<n/a>" , &vaf);
475 
476 	va_end(args);
477 	kfree(path);
478 }
479 EXPORT_SYMBOL(acpi_handle_printk);
480 
481 #if defined(CONFIG_DYNAMIC_DEBUG)
482 /**
483  * __acpi_handle_debug: pr_debug with ACPI prefix and object path
484  * @descriptor: Dynamic Debug descriptor
485  * @handle: ACPI device handle
486  * @fmt: format string
487  *
488  * This function is called through acpi_handle_debug macro and debug
489  * prints a message with ACPI prefix and object path. This function
490  * acquires the global namespace mutex to obtain an object path.  In
491  * interrupt context, it shows the object path as <n/a>.
492  */
493 void
494 __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle,
495 		    const char *fmt, ...)
496 {
497 	struct va_format vaf;
498 	va_list args;
499 	const char *path;
500 
501 	va_start(args, fmt);
502 	vaf.fmt = fmt;
503 	vaf.va = &args;
504 
505 	path = acpi_handle_path(handle);
506 	__dynamic_pr_debug(descriptor, "ACPI: %s: %pV", path ? path : "<n/a>", &vaf);
507 
508 	va_end(args);
509 	kfree(path);
510 }
511 EXPORT_SYMBOL(__acpi_handle_debug);
512 #endif
513 
514 /**
515  * acpi_has_method: Check whether @handle has a method named @name
516  * @handle: ACPI device handle
517  * @name: name of object or method
518  *
519  * Check whether @handle has a method named @name.
520  */
521 bool acpi_has_method(acpi_handle handle, char *name)
522 {
523 	acpi_handle tmp;
524 
525 	return ACPI_SUCCESS(acpi_get_handle(handle, name, &tmp));
526 }
527 EXPORT_SYMBOL(acpi_has_method);
528 
529 acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
530 				       u64 arg)
531 {
532 	union acpi_object obj = { .type = ACPI_TYPE_INTEGER };
533 	struct acpi_object_list arg_list = { .count = 1, .pointer = &obj, };
534 
535 	obj.integer.value = arg;
536 
537 	return acpi_evaluate_object(handle, method, &arg_list, NULL);
538 }
539 EXPORT_SYMBOL(acpi_execute_simple_method);
540 
541 /**
542  * acpi_evaluate_ej0: Evaluate _EJ0 method for hotplug operations
543  * @handle: ACPI device handle
544  *
545  * Evaluate device's _EJ0 method for hotplug operations.
546  */
547 acpi_status acpi_evaluate_ej0(acpi_handle handle)
548 {
549 	acpi_status status;
550 
551 	status = acpi_execute_simple_method(handle, "_EJ0", 1);
552 	if (status == AE_NOT_FOUND)
553 		acpi_handle_warn(handle, "No _EJ0 support for device\n");
554 	else if (ACPI_FAILURE(status))
555 		acpi_handle_warn(handle, "Eject failed (0x%x)\n", status);
556 
557 	return status;
558 }
559 
560 /**
561  * acpi_evaluate_lck: Evaluate _LCK method to lock/unlock device
562  * @handle: ACPI device handle
563  * @lock: lock device if non-zero, otherwise unlock device
564  *
565  * Evaluate device's _LCK method if present to lock/unlock device
566  */
567 acpi_status acpi_evaluate_lck(acpi_handle handle, int lock)
568 {
569 	acpi_status status;
570 
571 	status = acpi_execute_simple_method(handle, "_LCK", !!lock);
572 	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
573 		if (lock)
574 			acpi_handle_warn(handle,
575 				"Locking device failed (0x%x)\n", status);
576 		else
577 			acpi_handle_warn(handle,
578 				"Unlocking device failed (0x%x)\n", status);
579 	}
580 
581 	return status;
582 }
583 
584 /**
585  * acpi_evaluate_reg: Evaluate _REG method to register OpRegion presence
586  * @handle: ACPI device handle
587  * @space_id: ACPI address space id to register OpRegion presence for
588  * @function: Parameter to pass to _REG one of ACPI_REG_CONNECT or
589  *            ACPI_REG_DISCONNECT
590  *
591  * Evaluate device's _REG method to register OpRegion presence.
592  */
593 acpi_status acpi_evaluate_reg(acpi_handle handle, u8 space_id, u32 function)
594 {
595 	struct acpi_object_list arg_list;
596 	union acpi_object params[2];
597 
598 	params[0].type = ACPI_TYPE_INTEGER;
599 	params[0].integer.value = space_id;
600 	params[1].type = ACPI_TYPE_INTEGER;
601 	params[1].integer.value = function;
602 	arg_list.count = 2;
603 	arg_list.pointer = params;
604 
605 	return acpi_evaluate_object(handle, "_REG", &arg_list, NULL);
606 }
607 EXPORT_SYMBOL(acpi_evaluate_reg);
608 
609 /**
610  * acpi_evaluate_dsm - evaluate device's _DSM method
611  * @handle: ACPI device handle
612  * @guid: GUID of requested functions, should be 16 bytes
613  * @rev: revision number of requested function
614  * @func: requested function number
615  * @argv4: the function specific parameter
616  *
617  * Evaluate device's _DSM method with specified GUID, revision id and
618  * function number. Caller needs to free the returned object.
619  *
620  * Though ACPI defines the fourth parameter for _DSM should be a package,
621  * some old BIOSes do expect a buffer or an integer etc.
622  */
623 union acpi_object *
624 acpi_evaluate_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 func,
625 		  union acpi_object *argv4)
626 {
627 	acpi_status ret;
628 	struct acpi_buffer buf = {ACPI_ALLOCATE_BUFFER, NULL};
629 	union acpi_object params[4];
630 	struct acpi_object_list input = {
631 		.count = 4,
632 		.pointer = params,
633 	};
634 
635 	params[0].type = ACPI_TYPE_BUFFER;
636 	params[0].buffer.length = 16;
637 	params[0].buffer.pointer = (u8 *)guid;
638 	params[1].type = ACPI_TYPE_INTEGER;
639 	params[1].integer.value = rev;
640 	params[2].type = ACPI_TYPE_INTEGER;
641 	params[2].integer.value = func;
642 	if (argv4) {
643 		params[3] = *argv4;
644 	} else {
645 		params[3].type = ACPI_TYPE_PACKAGE;
646 		params[3].package.count = 0;
647 		params[3].package.elements = NULL;
648 	}
649 
650 	ret = acpi_evaluate_object(handle, "_DSM", &input, &buf);
651 	if (ACPI_SUCCESS(ret))
652 		return (union acpi_object *)buf.pointer;
653 
654 	if (ret != AE_NOT_FOUND)
655 		acpi_handle_warn(handle,
656 				"failed to evaluate _DSM (0x%x)\n", ret);
657 
658 	return NULL;
659 }
660 EXPORT_SYMBOL(acpi_evaluate_dsm);
661 
662 /**
663  * acpi_check_dsm - check if _DSM method supports requested functions.
664  * @handle: ACPI device handle
665  * @guid: GUID of requested functions, should be 16 bytes at least
666  * @rev: revision number of requested functions
667  * @funcs: bitmap of requested functions
668  *
669  * Evaluate device's _DSM method to check whether it supports requested
670  * functions. Currently only support 64 functions at maximum, should be
671  * enough for now.
672  */
673 bool acpi_check_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 funcs)
674 {
675 	int i;
676 	u64 mask = 0;
677 	union acpi_object *obj;
678 
679 	if (funcs == 0)
680 		return false;
681 
682 	obj = acpi_evaluate_dsm(handle, guid, rev, 0, NULL);
683 	if (!obj)
684 		return false;
685 
686 	/* For compatibility, old BIOSes may return an integer */
687 	if (obj->type == ACPI_TYPE_INTEGER)
688 		mask = obj->integer.value;
689 	else if (obj->type == ACPI_TYPE_BUFFER)
690 		for (i = 0; i < obj->buffer.length && i < 8; i++)
691 			mask |= (((u64)obj->buffer.pointer[i]) << (i * 8));
692 	ACPI_FREE(obj);
693 
694 	/*
695 	 * Bit 0 indicates whether there's support for any functions other than
696 	 * function 0 for the specified GUID and revision.
697 	 */
698 	if ((mask & 0x1) && (mask & funcs) == funcs)
699 		return true;
700 
701 	return false;
702 }
703 EXPORT_SYMBOL(acpi_check_dsm);
704 
705 /**
706  * acpi_dev_hid_uid_match - Match device by supplied HID and UID
707  * @adev: ACPI device to match.
708  * @hid2: Hardware ID of the device.
709  * @uid2: Unique ID of the device, pass NULL to not check _UID.
710  *
711  * Matches HID and UID in @adev with given @hid2 and @uid2.
712  * Returns true if matches.
713  */
714 bool acpi_dev_hid_uid_match(struct acpi_device *adev,
715 			    const char *hid2, const char *uid2)
716 {
717 	const char *hid1 = acpi_device_hid(adev);
718 	const char *uid1 = acpi_device_uid(adev);
719 
720 	if (strcmp(hid1, hid2))
721 		return false;
722 
723 	if (!uid2)
724 		return true;
725 
726 	return uid1 && !strcmp(uid1, uid2);
727 }
728 EXPORT_SYMBOL(acpi_dev_hid_uid_match);
729 
730 /**
731  * acpi_dev_found - Detect presence of a given ACPI device in the namespace.
732  * @hid: Hardware ID of the device.
733  *
734  * Return %true if the device was present at the moment of invocation.
735  * Note that if the device is pluggable, it may since have disappeared.
736  *
737  * For this function to work, acpi_bus_scan() must have been executed
738  * which happens in the subsys_initcall() subsection. Hence, do not
739  * call from a subsys_initcall() or earlier (use acpi_get_devices()
740  * instead). Calling from module_init() is fine (which is synonymous
741  * with device_initcall()).
742  */
743 bool acpi_dev_found(const char *hid)
744 {
745 	struct acpi_device_bus_id *acpi_device_bus_id;
746 	bool found = false;
747 
748 	mutex_lock(&acpi_device_lock);
749 	list_for_each_entry(acpi_device_bus_id, &acpi_bus_id_list, node)
750 		if (!strcmp(acpi_device_bus_id->bus_id, hid)) {
751 			found = true;
752 			break;
753 		}
754 	mutex_unlock(&acpi_device_lock);
755 
756 	return found;
757 }
758 EXPORT_SYMBOL(acpi_dev_found);
759 
760 struct acpi_dev_match_info {
761 	struct acpi_device_id hid[2];
762 	const char *uid;
763 	s64 hrv;
764 };
765 
766 static int acpi_dev_match_cb(struct device *dev, const void *data)
767 {
768 	struct acpi_device *adev = to_acpi_device(dev);
769 	const struct acpi_dev_match_info *match = data;
770 	unsigned long long hrv;
771 	acpi_status status;
772 
773 	if (acpi_match_device_ids(adev, match->hid))
774 		return 0;
775 
776 	if (match->uid && (!adev->pnp.unique_id ||
777 	    strcmp(adev->pnp.unique_id, match->uid)))
778 		return 0;
779 
780 	if (match->hrv == -1)
781 		return 1;
782 
783 	status = acpi_evaluate_integer(adev->handle, "_HRV", NULL, &hrv);
784 	if (ACPI_FAILURE(status))
785 		return 0;
786 
787 	return hrv == match->hrv;
788 }
789 
790 /**
791  * acpi_dev_present - Detect that a given ACPI device is present
792  * @hid: Hardware ID of the device.
793  * @uid: Unique ID of the device, pass NULL to not check _UID
794  * @hrv: Hardware Revision of the device, pass -1 to not check _HRV
795  *
796  * Return %true if a matching device was present at the moment of invocation.
797  * Note that if the device is pluggable, it may since have disappeared.
798  *
799  * Note that unlike acpi_dev_found() this function checks the status
800  * of the device. So for devices which are present in the DSDT, but
801  * which are disabled (their _STA callback returns 0) this function
802  * will return false.
803  *
804  * For this function to work, acpi_bus_scan() must have been executed
805  * which happens in the subsys_initcall() subsection. Hence, do not
806  * call from a subsys_initcall() or earlier (use acpi_get_devices()
807  * instead). Calling from module_init() is fine (which is synonymous
808  * with device_initcall()).
809  */
810 bool acpi_dev_present(const char *hid, const char *uid, s64 hrv)
811 {
812 	struct acpi_dev_match_info match = {};
813 	struct device *dev;
814 
815 	strlcpy(match.hid[0].id, hid, sizeof(match.hid[0].id));
816 	match.uid = uid;
817 	match.hrv = hrv;
818 
819 	dev = bus_find_device(&acpi_bus_type, NULL, &match, acpi_dev_match_cb);
820 	put_device(dev);
821 	return !!dev;
822 }
823 EXPORT_SYMBOL(acpi_dev_present);
824 
825 /**
826  * acpi_dev_get_next_match_dev - Return the next match of ACPI device
827  * @adev: Pointer to the previous ACPI device matching this @hid, @uid and @hrv
828  * @hid: Hardware ID of the device.
829  * @uid: Unique ID of the device, pass NULL to not check _UID
830  * @hrv: Hardware Revision of the device, pass -1 to not check _HRV
831  *
832  * Return the next match of ACPI device if another matching device was present
833  * at the moment of invocation, or NULL otherwise.
834  *
835  * FIXME: The function does not tolerate the sudden disappearance of @adev, e.g.
836  * in the case of a hotplug event. That said, the caller should ensure that
837  * this will never happen.
838  *
839  * The caller is responsible for invoking acpi_dev_put() on the returned device.
840  *
841  * See additional information in acpi_dev_present() as well.
842  */
843 struct acpi_device *
844 acpi_dev_get_next_match_dev(struct acpi_device *adev, const char *hid, const char *uid, s64 hrv)
845 {
846 	struct device *start = adev ? &adev->dev : NULL;
847 	struct acpi_dev_match_info match = {};
848 	struct device *dev;
849 
850 	strlcpy(match.hid[0].id, hid, sizeof(match.hid[0].id));
851 	match.uid = uid;
852 	match.hrv = hrv;
853 
854 	dev = bus_find_device(&acpi_bus_type, start, &match, acpi_dev_match_cb);
855 	return dev ? to_acpi_device(dev) : NULL;
856 }
857 EXPORT_SYMBOL(acpi_dev_get_next_match_dev);
858 
859 /**
860  * acpi_dev_get_first_match_dev - Return the first match of ACPI device
861  * @hid: Hardware ID of the device.
862  * @uid: Unique ID of the device, pass NULL to not check _UID
863  * @hrv: Hardware Revision of the device, pass -1 to not check _HRV
864  *
865  * Return the first match of ACPI device if a matching device was present
866  * at the moment of invocation, or NULL otherwise.
867  *
868  * The caller is responsible for invoking acpi_dev_put() on the returned device.
869  *
870  * See additional information in acpi_dev_present() as well.
871  */
872 struct acpi_device *
873 acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv)
874 {
875 	return acpi_dev_get_next_match_dev(NULL, hid, uid, hrv);
876 }
877 EXPORT_SYMBOL(acpi_dev_get_first_match_dev);
878 
879 /*
880  * acpi_backlight= handling, this is done here rather then in video_detect.c
881  * because __setup cannot be used in modules.
882  */
883 char acpi_video_backlight_string[16];
884 EXPORT_SYMBOL(acpi_video_backlight_string);
885 
886 static int __init acpi_backlight(char *str)
887 {
888 	strlcpy(acpi_video_backlight_string, str,
889 		sizeof(acpi_video_backlight_string));
890 	return 1;
891 }
892 __setup("acpi_backlight=", acpi_backlight);
893 
894 /**
895  * acpi_match_platform_list - Check if the system matches with a given list
896  * @plat: pointer to acpi_platform_list table terminated by a NULL entry
897  *
898  * Return the matched index if the system is found in the platform list.
899  * Otherwise, return a negative error code.
900  */
901 int acpi_match_platform_list(const struct acpi_platform_list *plat)
902 {
903 	struct acpi_table_header hdr;
904 	int idx = 0;
905 
906 	if (acpi_disabled)
907 		return -ENODEV;
908 
909 	for (; plat->oem_id[0]; plat++, idx++) {
910 		if (ACPI_FAILURE(acpi_get_table_header(plat->table, 0, &hdr)))
911 			continue;
912 
913 		if (strncmp(plat->oem_id, hdr.oem_id, ACPI_OEM_ID_SIZE))
914 			continue;
915 
916 		if (strncmp(plat->oem_table_id, hdr.oem_table_id, ACPI_OEM_TABLE_ID_SIZE))
917 			continue;
918 
919 		if ((plat->pred == all_versions) ||
920 		    (plat->pred == less_than_or_equal && hdr.oem_revision <= plat->oem_revision) ||
921 		    (plat->pred == greater_than_or_equal && hdr.oem_revision >= plat->oem_revision) ||
922 		    (plat->pred == equal && hdr.oem_revision == plat->oem_revision))
923 			return idx;
924 	}
925 
926 	return -ENODEV;
927 }
928 EXPORT_SYMBOL(acpi_match_platform_list);
929