xref: /linux/drivers/acpi/bus.c (revision 612e7a4c1645f09449355cf08b6fd3de80b4f8cc)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *  acpi_bus.c - ACPI Bus Driver ($Revision: 80 $)
4  *
5  *  Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
6  */
7 
8 #include <linux/module.h>
9 #include <linux/init.h>
10 #include <linux/ioport.h>
11 #include <linux/kernel.h>
12 #include <linux/list.h>
13 #include <linux/sched.h>
14 #include <linux/pm.h>
15 #include <linux/device.h>
16 #include <linux/proc_fs.h>
17 #include <linux/acpi.h>
18 #include <linux/slab.h>
19 #include <linux/regulator/machine.h>
20 #include <linux/workqueue.h>
21 #include <linux/reboot.h>
22 #include <linux/delay.h>
23 #ifdef CONFIG_X86
24 #include <asm/mpspec.h>
25 #include <linux/dmi.h>
26 #endif
27 #include <linux/acpi_iort.h>
28 #include <linux/pci.h>
29 #include <acpi/apei.h>
30 #include <linux/suspend.h>
31 
32 #include "internal.h"
33 
34 #define _COMPONENT		ACPI_BUS_COMPONENT
35 ACPI_MODULE_NAME("bus");
36 
37 struct acpi_device *acpi_root;
38 struct proc_dir_entry *acpi_root_dir;
39 EXPORT_SYMBOL(acpi_root_dir);
40 
41 #ifdef CONFIG_X86
42 #ifdef CONFIG_ACPI_CUSTOM_DSDT
43 static inline int set_copy_dsdt(const struct dmi_system_id *id)
44 {
45 	return 0;
46 }
47 #else
48 static int set_copy_dsdt(const struct dmi_system_id *id)
49 {
50 	printk(KERN_NOTICE "%s detected - "
51 		"force copy of DSDT to local memory\n", id->ident);
52 	acpi_gbl_copy_dsdt_locally = 1;
53 	return 0;
54 }
55 #endif
56 
57 static const struct dmi_system_id dsdt_dmi_table[] __initconst = {
58 	/*
59 	 * Invoke DSDT corruption work-around on all Toshiba Satellite.
60 	 * https://bugzilla.kernel.org/show_bug.cgi?id=14679
61 	 */
62 	{
63 	 .callback = set_copy_dsdt,
64 	 .ident = "TOSHIBA Satellite",
65 	 .matches = {
66 		DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
67 		DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
68 		},
69 	},
70 	{}
71 };
72 #endif
73 
74 /* --------------------------------------------------------------------------
75                                 Device Management
76    -------------------------------------------------------------------------- */
77 
78 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
79 				       unsigned long long *sta)
80 {
81 	acpi_status status;
82 
83 	status = acpi_evaluate_integer(handle, "_STA", NULL, sta);
84 	if (ACPI_SUCCESS(status))
85 		return AE_OK;
86 
87 	if (status == AE_NOT_FOUND) {
88 		*sta = ACPI_STA_DEVICE_PRESENT | ACPI_STA_DEVICE_ENABLED |
89 		       ACPI_STA_DEVICE_UI      | ACPI_STA_DEVICE_FUNCTIONING;
90 		return AE_OK;
91 	}
92 	return status;
93 }
94 EXPORT_SYMBOL_GPL(acpi_bus_get_status_handle);
95 
96 int acpi_bus_get_status(struct acpi_device *device)
97 {
98 	acpi_status status;
99 	unsigned long long sta;
100 
101 	if (acpi_device_always_present(device)) {
102 		acpi_set_device_status(device, ACPI_STA_DEFAULT);
103 		return 0;
104 	}
105 
106 	/* Battery devices must have their deps met before calling _STA */
107 	if (acpi_device_is_battery(device) && device->dep_unmet) {
108 		acpi_set_device_status(device, 0);
109 		return 0;
110 	}
111 
112 	status = acpi_bus_get_status_handle(device->handle, &sta);
113 	if (ACPI_FAILURE(status))
114 		return -ENODEV;
115 
116 	acpi_set_device_status(device, sta);
117 
118 	if (device->status.functional && !device->status.present) {
119 		ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device [%s] status [%08x]: "
120 		       "functional but not present;\n",
121 			device->pnp.bus_id, (u32)sta));
122 	}
123 
124 	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device [%s] status [%08x]\n",
125 			  device->pnp.bus_id, (u32)sta));
126 	return 0;
127 }
128 EXPORT_SYMBOL(acpi_bus_get_status);
129 
130 void acpi_bus_private_data_handler(acpi_handle handle,
131 				   void *context)
132 {
133 	return;
134 }
135 EXPORT_SYMBOL(acpi_bus_private_data_handler);
136 
137 int acpi_bus_attach_private_data(acpi_handle handle, void *data)
138 {
139 	acpi_status status;
140 
141 	status = acpi_attach_data(handle,
142 			acpi_bus_private_data_handler, data);
143 	if (ACPI_FAILURE(status)) {
144 		acpi_handle_debug(handle, "Error attaching device data\n");
145 		return -ENODEV;
146 	}
147 
148 	return 0;
149 }
150 EXPORT_SYMBOL_GPL(acpi_bus_attach_private_data);
151 
152 int acpi_bus_get_private_data(acpi_handle handle, void **data)
153 {
154 	acpi_status status;
155 
156 	if (!data)
157 		return -EINVAL;
158 
159 	status = acpi_get_data(handle, acpi_bus_private_data_handler, data);
160 	if (ACPI_FAILURE(status)) {
161 		acpi_handle_debug(handle, "No context for object\n");
162 		return -ENODEV;
163 	}
164 
165 	return 0;
166 }
167 EXPORT_SYMBOL_GPL(acpi_bus_get_private_data);
168 
169 void acpi_bus_detach_private_data(acpi_handle handle)
170 {
171 	acpi_detach_data(handle, acpi_bus_private_data_handler);
172 }
173 EXPORT_SYMBOL_GPL(acpi_bus_detach_private_data);
174 
175 static void acpi_print_osc_error(acpi_handle handle,
176 				 struct acpi_osc_context *context, char *error)
177 {
178 	int i;
179 
180 	acpi_handle_debug(handle, "(%s): %s\n", context->uuid_str, error);
181 
182 	pr_debug("_OSC request data:");
183 	for (i = 0; i < context->cap.length; i += sizeof(u32))
184 		pr_debug(" %x", *((u32 *)(context->cap.pointer + i)));
185 
186 	pr_debug("\n");
187 }
188 
189 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context)
190 {
191 	acpi_status status;
192 	struct acpi_object_list input;
193 	union acpi_object in_params[4];
194 	union acpi_object *out_obj;
195 	guid_t guid;
196 	u32 errors;
197 	struct acpi_buffer output = {ACPI_ALLOCATE_BUFFER, NULL};
198 
199 	if (!context)
200 		return AE_ERROR;
201 	if (guid_parse(context->uuid_str, &guid))
202 		return AE_ERROR;
203 	context->ret.length = ACPI_ALLOCATE_BUFFER;
204 	context->ret.pointer = NULL;
205 
206 	/* Setting up input parameters */
207 	input.count = 4;
208 	input.pointer = in_params;
209 	in_params[0].type 		= ACPI_TYPE_BUFFER;
210 	in_params[0].buffer.length 	= 16;
211 	in_params[0].buffer.pointer	= (u8 *)&guid;
212 	in_params[1].type 		= ACPI_TYPE_INTEGER;
213 	in_params[1].integer.value 	= context->rev;
214 	in_params[2].type 		= ACPI_TYPE_INTEGER;
215 	in_params[2].integer.value	= context->cap.length/sizeof(u32);
216 	in_params[3].type		= ACPI_TYPE_BUFFER;
217 	in_params[3].buffer.length 	= context->cap.length;
218 	in_params[3].buffer.pointer 	= context->cap.pointer;
219 
220 	status = acpi_evaluate_object(handle, "_OSC", &input, &output);
221 	if (ACPI_FAILURE(status))
222 		return status;
223 
224 	if (!output.length)
225 		return AE_NULL_OBJECT;
226 
227 	out_obj = output.pointer;
228 	if (out_obj->type != ACPI_TYPE_BUFFER
229 		|| out_obj->buffer.length != context->cap.length) {
230 		acpi_print_osc_error(handle, context,
231 			"_OSC evaluation returned wrong type");
232 		status = AE_TYPE;
233 		goto out_kfree;
234 	}
235 	/* Need to ignore the bit0 in result code */
236 	errors = *((u32 *)out_obj->buffer.pointer) & ~(1 << 0);
237 	if (errors) {
238 		if (errors & OSC_REQUEST_ERROR)
239 			acpi_print_osc_error(handle, context,
240 				"_OSC request failed");
241 		if (errors & OSC_INVALID_UUID_ERROR)
242 			acpi_print_osc_error(handle, context,
243 				"_OSC invalid UUID");
244 		if (errors & OSC_INVALID_REVISION_ERROR)
245 			acpi_print_osc_error(handle, context,
246 				"_OSC invalid revision");
247 		if (errors & OSC_CAPABILITIES_MASK_ERROR) {
248 			if (((u32 *)context->cap.pointer)[OSC_QUERY_DWORD]
249 			    & OSC_QUERY_ENABLE)
250 				goto out_success;
251 			status = AE_SUPPORT;
252 			goto out_kfree;
253 		}
254 		status = AE_ERROR;
255 		goto out_kfree;
256 	}
257 out_success:
258 	context->ret.length = out_obj->buffer.length;
259 	context->ret.pointer = kmemdup(out_obj->buffer.pointer,
260 				       context->ret.length, GFP_KERNEL);
261 	if (!context->ret.pointer) {
262 		status =  AE_NO_MEMORY;
263 		goto out_kfree;
264 	}
265 	status =  AE_OK;
266 
267 out_kfree:
268 	kfree(output.pointer);
269 	if (status != AE_OK)
270 		context->ret.pointer = NULL;
271 	return status;
272 }
273 EXPORT_SYMBOL(acpi_run_osc);
274 
275 bool osc_sb_apei_support_acked;
276 
277 /*
278  * ACPI 6.0 Section 8.4.4.2 Idle State Coordination
279  * OSPM supports platform coordinated low power idle(LPI) states
280  */
281 bool osc_pc_lpi_support_confirmed;
282 EXPORT_SYMBOL_GPL(osc_pc_lpi_support_confirmed);
283 
284 static u8 sb_uuid_str[] = "0811B06E-4A27-44F9-8D60-3CBBC22E7B48";
285 static void acpi_bus_osc_support(void)
286 {
287 	u32 capbuf[2];
288 	struct acpi_osc_context context = {
289 		.uuid_str = sb_uuid_str,
290 		.rev = 1,
291 		.cap.length = 8,
292 		.cap.pointer = capbuf,
293 	};
294 	acpi_handle handle;
295 
296 	capbuf[OSC_QUERY_DWORD] = OSC_QUERY_ENABLE;
297 	capbuf[OSC_SUPPORT_DWORD] = OSC_SB_PR3_SUPPORT; /* _PR3 is in use */
298 	if (IS_ENABLED(CONFIG_ACPI_PROCESSOR_AGGREGATOR))
299 		capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PAD_SUPPORT;
300 	if (IS_ENABLED(CONFIG_ACPI_PROCESSOR))
301 		capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PPC_OST_SUPPORT;
302 
303 	capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_HOTPLUG_OST_SUPPORT;
304 	capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PCLPI_SUPPORT;
305 
306 #ifdef CONFIG_ARM64
307 	capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_GENERIC_INITIATOR_SUPPORT;
308 #endif
309 #ifdef CONFIG_X86
310 	capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_GENERIC_INITIATOR_SUPPORT;
311 	if (boot_cpu_has(X86_FEATURE_HWP)) {
312 		capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_CPC_SUPPORT;
313 		capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_CPCV2_SUPPORT;
314 	}
315 #endif
316 
317 	if (IS_ENABLED(CONFIG_SCHED_MC_PRIO))
318 		capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_CPC_DIVERSE_HIGH_SUPPORT;
319 
320 	if (!ghes_disable)
321 		capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_APEI_SUPPORT;
322 	if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &handle)))
323 		return;
324 	if (ACPI_SUCCESS(acpi_run_osc(handle, &context))) {
325 		u32 *capbuf_ret = context.ret.pointer;
326 		if (context.ret.length > OSC_SUPPORT_DWORD) {
327 			osc_sb_apei_support_acked =
328 				capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_APEI_SUPPORT;
329 			osc_pc_lpi_support_confirmed =
330 				capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_PCLPI_SUPPORT;
331 		}
332 		kfree(context.ret.pointer);
333 	}
334 	/* do we need to check other returned cap? Sounds no */
335 }
336 
337 /* --------------------------------------------------------------------------
338                              Notification Handling
339    -------------------------------------------------------------------------- */
340 
341 /**
342  * acpi_bus_notify
343  * ---------------
344  * Callback for all 'system-level' device notifications (values 0x00-0x7F).
345  */
346 static void acpi_bus_notify(acpi_handle handle, u32 type, void *data)
347 {
348 	struct acpi_device *adev;
349 	struct acpi_driver *driver;
350 	u32 ost_code = ACPI_OST_SC_NON_SPECIFIC_FAILURE;
351 	bool hotplug_event = false;
352 
353 	switch (type) {
354 	case ACPI_NOTIFY_BUS_CHECK:
355 		acpi_handle_debug(handle, "ACPI_NOTIFY_BUS_CHECK event\n");
356 		hotplug_event = true;
357 		break;
358 
359 	case ACPI_NOTIFY_DEVICE_CHECK:
360 		acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_CHECK event\n");
361 		hotplug_event = true;
362 		break;
363 
364 	case ACPI_NOTIFY_DEVICE_WAKE:
365 		acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_WAKE event\n");
366 		break;
367 
368 	case ACPI_NOTIFY_EJECT_REQUEST:
369 		acpi_handle_debug(handle, "ACPI_NOTIFY_EJECT_REQUEST event\n");
370 		hotplug_event = true;
371 		break;
372 
373 	case ACPI_NOTIFY_DEVICE_CHECK_LIGHT:
374 		acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_CHECK_LIGHT event\n");
375 		/* TBD: Exactly what does 'light' mean? */
376 		break;
377 
378 	case ACPI_NOTIFY_FREQUENCY_MISMATCH:
379 		acpi_handle_err(handle, "Device cannot be configured due "
380 				"to a frequency mismatch\n");
381 		break;
382 
383 	case ACPI_NOTIFY_BUS_MODE_MISMATCH:
384 		acpi_handle_err(handle, "Device cannot be configured due "
385 				"to a bus mode mismatch\n");
386 		break;
387 
388 	case ACPI_NOTIFY_POWER_FAULT:
389 		acpi_handle_err(handle, "Device has suffered a power fault\n");
390 		break;
391 
392 	default:
393 		acpi_handle_debug(handle, "Unknown event type 0x%x\n", type);
394 		break;
395 	}
396 
397 	adev = acpi_bus_get_acpi_device(handle);
398 	if (!adev)
399 		goto err;
400 
401 	driver = adev->driver;
402 	if (driver && driver->ops.notify &&
403 	    (driver->flags & ACPI_DRIVER_ALL_NOTIFY_EVENTS))
404 		driver->ops.notify(adev, type);
405 
406 	if (!hotplug_event) {
407 		acpi_bus_put_acpi_device(adev);
408 		return;
409 	}
410 
411 	if (ACPI_SUCCESS(acpi_hotplug_schedule(adev, type)))
412 		return;
413 
414 	acpi_bus_put_acpi_device(adev);
415 
416  err:
417 	acpi_evaluate_ost(handle, type, ost_code, NULL);
418 }
419 
420 static void acpi_device_notify(acpi_handle handle, u32 event, void *data)
421 {
422 	struct acpi_device *device = data;
423 
424 	device->driver->ops.notify(device, event);
425 }
426 
427 static void acpi_device_notify_fixed(void *data)
428 {
429 	struct acpi_device *device = data;
430 
431 	/* Fixed hardware devices have no handles */
432 	acpi_device_notify(NULL, ACPI_FIXED_HARDWARE_EVENT, device);
433 }
434 
435 static u32 acpi_device_fixed_event(void *data)
436 {
437 	acpi_os_execute(OSL_NOTIFY_HANDLER, acpi_device_notify_fixed, data);
438 	return ACPI_INTERRUPT_HANDLED;
439 }
440 
441 static int acpi_device_install_notify_handler(struct acpi_device *device)
442 {
443 	acpi_status status;
444 
445 	if (device->device_type == ACPI_BUS_TYPE_POWER_BUTTON)
446 		status =
447 		    acpi_install_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
448 						     acpi_device_fixed_event,
449 						     device);
450 	else if (device->device_type == ACPI_BUS_TYPE_SLEEP_BUTTON)
451 		status =
452 		    acpi_install_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
453 						     acpi_device_fixed_event,
454 						     device);
455 	else
456 		status = acpi_install_notify_handler(device->handle,
457 						     ACPI_DEVICE_NOTIFY,
458 						     acpi_device_notify,
459 						     device);
460 
461 	if (ACPI_FAILURE(status))
462 		return -EINVAL;
463 	return 0;
464 }
465 
466 static void acpi_device_remove_notify_handler(struct acpi_device *device)
467 {
468 	if (device->device_type == ACPI_BUS_TYPE_POWER_BUTTON)
469 		acpi_remove_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
470 						acpi_device_fixed_event);
471 	else if (device->device_type == ACPI_BUS_TYPE_SLEEP_BUTTON)
472 		acpi_remove_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
473 						acpi_device_fixed_event);
474 	else
475 		acpi_remove_notify_handler(device->handle, ACPI_DEVICE_NOTIFY,
476 					   acpi_device_notify);
477 }
478 
479 /* Handle events targeting \_SB device (at present only graceful shutdown) */
480 
481 #define ACPI_SB_NOTIFY_SHUTDOWN_REQUEST 0x81
482 #define ACPI_SB_INDICATE_INTERVAL	10000
483 
484 static void sb_notify_work(struct work_struct *dummy)
485 {
486 	acpi_handle sb_handle;
487 
488 	orderly_poweroff(true);
489 
490 	/*
491 	 * After initiating graceful shutdown, the ACPI spec requires OSPM
492 	 * to evaluate _OST method once every 10seconds to indicate that
493 	 * the shutdown is in progress
494 	 */
495 	acpi_get_handle(NULL, "\\_SB", &sb_handle);
496 	while (1) {
497 		pr_info("Graceful shutdown in progress.\n");
498 		acpi_evaluate_ost(sb_handle, ACPI_OST_EC_OSPM_SHUTDOWN,
499 				ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS, NULL);
500 		msleep(ACPI_SB_INDICATE_INTERVAL);
501 	}
502 }
503 
504 static void acpi_sb_notify(acpi_handle handle, u32 event, void *data)
505 {
506 	static DECLARE_WORK(acpi_sb_work, sb_notify_work);
507 
508 	if (event == ACPI_SB_NOTIFY_SHUTDOWN_REQUEST) {
509 		if (!work_busy(&acpi_sb_work))
510 			schedule_work(&acpi_sb_work);
511 	} else
512 		pr_warn("event %x is not supported by \\_SB device\n", event);
513 }
514 
515 static int __init acpi_setup_sb_notify_handler(void)
516 {
517 	acpi_handle sb_handle;
518 
519 	if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &sb_handle)))
520 		return -ENXIO;
521 
522 	if (ACPI_FAILURE(acpi_install_notify_handler(sb_handle, ACPI_DEVICE_NOTIFY,
523 						acpi_sb_notify, NULL)))
524 		return -EINVAL;
525 
526 	return 0;
527 }
528 
529 /* --------------------------------------------------------------------------
530                              Device Matching
531    -------------------------------------------------------------------------- */
532 
533 /**
534  * acpi_get_first_physical_node - Get first physical node of an ACPI device
535  * @adev:	ACPI device in question
536  *
537  * Return: First physical node of ACPI device @adev
538  */
539 struct device *acpi_get_first_physical_node(struct acpi_device *adev)
540 {
541 	struct mutex *physical_node_lock = &adev->physical_node_lock;
542 	struct device *phys_dev;
543 
544 	mutex_lock(physical_node_lock);
545 	if (list_empty(&adev->physical_node_list)) {
546 		phys_dev = NULL;
547 	} else {
548 		const struct acpi_device_physical_node *node;
549 
550 		node = list_first_entry(&adev->physical_node_list,
551 					struct acpi_device_physical_node, node);
552 
553 		phys_dev = node->dev;
554 	}
555 	mutex_unlock(physical_node_lock);
556 	return phys_dev;
557 }
558 
559 static struct acpi_device *acpi_primary_dev_companion(struct acpi_device *adev,
560 						      const struct device *dev)
561 {
562 	const struct device *phys_dev = acpi_get_first_physical_node(adev);
563 
564 	return phys_dev && phys_dev == dev ? adev : NULL;
565 }
566 
567 /**
568  * acpi_device_is_first_physical_node - Is given dev first physical node
569  * @adev: ACPI companion device
570  * @dev: Physical device to check
571  *
572  * Function checks if given @dev is the first physical devices attached to
573  * the ACPI companion device. This distinction is needed in some cases
574  * where the same companion device is shared between many physical devices.
575  *
576  * Note that the caller have to provide valid @adev pointer.
577  */
578 bool acpi_device_is_first_physical_node(struct acpi_device *adev,
579 					const struct device *dev)
580 {
581 	return !!acpi_primary_dev_companion(adev, dev);
582 }
583 
584 /*
585  * acpi_companion_match() - Can we match via ACPI companion device
586  * @dev: Device in question
587  *
588  * Check if the given device has an ACPI companion and if that companion has
589  * a valid list of PNP IDs, and if the device is the first (primary) physical
590  * device associated with it.  Return the companion pointer if that's the case
591  * or NULL otherwise.
592  *
593  * If multiple physical devices are attached to a single ACPI companion, we need
594  * to be careful.  The usage scenario for this kind of relationship is that all
595  * of the physical devices in question use resources provided by the ACPI
596  * companion.  A typical case is an MFD device where all the sub-devices share
597  * the parent's ACPI companion.  In such cases we can only allow the primary
598  * (first) physical device to be matched with the help of the companion's PNP
599  * IDs.
600  *
601  * Additional physical devices sharing the ACPI companion can still use
602  * resources available from it but they will be matched normally using functions
603  * provided by their bus types (and analogously for their modalias).
604  */
605 struct acpi_device *acpi_companion_match(const struct device *dev)
606 {
607 	struct acpi_device *adev;
608 
609 	adev = ACPI_COMPANION(dev);
610 	if (!adev)
611 		return NULL;
612 
613 	if (list_empty(&adev->pnp.ids))
614 		return NULL;
615 
616 	return acpi_primary_dev_companion(adev, dev);
617 }
618 
619 /**
620  * acpi_of_match_device - Match device object using the "compatible" property.
621  * @adev: ACPI device object to match.
622  * @of_match_table: List of device IDs to match against.
623  * @of_id: OF ID if matched
624  *
625  * If @dev has an ACPI companion which has ACPI_DT_NAMESPACE_HID in its list of
626  * identifiers and a _DSD object with the "compatible" property, use that
627  * property to match against the given list of identifiers.
628  */
629 static bool acpi_of_match_device(struct acpi_device *adev,
630 				 const struct of_device_id *of_match_table,
631 				 const struct of_device_id **of_id)
632 {
633 	const union acpi_object *of_compatible, *obj;
634 	int i, nval;
635 
636 	if (!adev)
637 		return false;
638 
639 	of_compatible = adev->data.of_compatible;
640 	if (!of_match_table || !of_compatible)
641 		return false;
642 
643 	if (of_compatible->type == ACPI_TYPE_PACKAGE) {
644 		nval = of_compatible->package.count;
645 		obj = of_compatible->package.elements;
646 	} else { /* Must be ACPI_TYPE_STRING. */
647 		nval = 1;
648 		obj = of_compatible;
649 	}
650 	/* Now we can look for the driver DT compatible strings */
651 	for (i = 0; i < nval; i++, obj++) {
652 		const struct of_device_id *id;
653 
654 		for (id = of_match_table; id->compatible[0]; id++)
655 			if (!strcasecmp(obj->string.pointer, id->compatible)) {
656 				if (of_id)
657 					*of_id = id;
658 				return true;
659 			}
660 	}
661 
662 	return false;
663 }
664 
665 static bool acpi_of_modalias(struct acpi_device *adev,
666 			     char *modalias, size_t len)
667 {
668 	const union acpi_object *of_compatible;
669 	const union acpi_object *obj;
670 	const char *str, *chr;
671 
672 	of_compatible = adev->data.of_compatible;
673 	if (!of_compatible)
674 		return false;
675 
676 	if (of_compatible->type == ACPI_TYPE_PACKAGE)
677 		obj = of_compatible->package.elements;
678 	else /* Must be ACPI_TYPE_STRING. */
679 		obj = of_compatible;
680 
681 	str = obj->string.pointer;
682 	chr = strchr(str, ',');
683 	strlcpy(modalias, chr ? chr + 1 : str, len);
684 
685 	return true;
686 }
687 
688 /**
689  * acpi_set_modalias - Set modalias using "compatible" property or supplied ID
690  * @adev:	ACPI device object to match
691  * @default_id:	ID string to use as default if no compatible string found
692  * @modalias:   Pointer to buffer that modalias value will be copied into
693  * @len:	Length of modalias buffer
694  *
695  * This is a counterpart of of_modalias_node() for struct acpi_device objects.
696  * If there is a compatible string for @adev, it will be copied to @modalias
697  * with the vendor prefix stripped; otherwise, @default_id will be used.
698  */
699 void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
700 		       char *modalias, size_t len)
701 {
702 	if (!acpi_of_modalias(adev, modalias, len))
703 		strlcpy(modalias, default_id, len);
704 }
705 EXPORT_SYMBOL_GPL(acpi_set_modalias);
706 
707 static bool __acpi_match_device_cls(const struct acpi_device_id *id,
708 				    struct acpi_hardware_id *hwid)
709 {
710 	int i, msk, byte_shift;
711 	char buf[3];
712 
713 	if (!id->cls)
714 		return false;
715 
716 	/* Apply class-code bitmask, before checking each class-code byte */
717 	for (i = 1; i <= 3; i++) {
718 		byte_shift = 8 * (3 - i);
719 		msk = (id->cls_msk >> byte_shift) & 0xFF;
720 		if (!msk)
721 			continue;
722 
723 		sprintf(buf, "%02x", (id->cls >> byte_shift) & msk);
724 		if (strncmp(buf, &hwid->id[(i - 1) * 2], 2))
725 			return false;
726 	}
727 	return true;
728 }
729 
730 static bool __acpi_match_device(struct acpi_device *device,
731 				const struct acpi_device_id *acpi_ids,
732 				const struct of_device_id *of_ids,
733 				const struct acpi_device_id **acpi_id,
734 				const struct of_device_id **of_id)
735 {
736 	const struct acpi_device_id *id;
737 	struct acpi_hardware_id *hwid;
738 
739 	/*
740 	 * If the device is not present, it is unnecessary to load device
741 	 * driver for it.
742 	 */
743 	if (!device || !device->status.present)
744 		return false;
745 
746 	list_for_each_entry(hwid, &device->pnp.ids, list) {
747 		/* First, check the ACPI/PNP IDs provided by the caller. */
748 		if (acpi_ids) {
749 			for (id = acpi_ids; id->id[0] || id->cls; id++) {
750 				if (id->id[0] && !strcmp((char *)id->id, hwid->id))
751 					goto out_acpi_match;
752 				if (id->cls && __acpi_match_device_cls(id, hwid))
753 					goto out_acpi_match;
754 			}
755 		}
756 
757 		/*
758 		 * Next, check ACPI_DT_NAMESPACE_HID and try to match the
759 		 * "compatible" property if found.
760 		 */
761 		if (!strcmp(ACPI_DT_NAMESPACE_HID, hwid->id))
762 			return acpi_of_match_device(device, of_ids, of_id);
763 	}
764 	return false;
765 
766 out_acpi_match:
767 	if (acpi_id)
768 		*acpi_id = id;
769 	return true;
770 }
771 
772 /**
773  * acpi_match_device - Match a struct device against a given list of ACPI IDs
774  * @ids: Array of struct acpi_device_id object to match against.
775  * @dev: The device structure to match.
776  *
777  * Check if @dev has a valid ACPI handle and if there is a struct acpi_device
778  * object for that handle and use that object to match against a given list of
779  * device IDs.
780  *
781  * Return a pointer to the first matching ID on success or %NULL on failure.
782  */
783 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
784 					       const struct device *dev)
785 {
786 	const struct acpi_device_id *id = NULL;
787 
788 	__acpi_match_device(acpi_companion_match(dev), ids, NULL, &id, NULL);
789 	return id;
790 }
791 EXPORT_SYMBOL_GPL(acpi_match_device);
792 
793 static const void *acpi_of_device_get_match_data(const struct device *dev)
794 {
795 	struct acpi_device *adev = ACPI_COMPANION(dev);
796 	const struct of_device_id *match = NULL;
797 
798 	if (!acpi_of_match_device(adev, dev->driver->of_match_table, &match))
799 		return NULL;
800 
801 	return match->data;
802 }
803 
804 const void *acpi_device_get_match_data(const struct device *dev)
805 {
806 	const struct acpi_device_id *match;
807 
808 	if (!dev->driver->acpi_match_table)
809 		return acpi_of_device_get_match_data(dev);
810 
811 	match = acpi_match_device(dev->driver->acpi_match_table, dev);
812 	if (!match)
813 		return NULL;
814 
815 	return (const void *)match->driver_data;
816 }
817 EXPORT_SYMBOL_GPL(acpi_device_get_match_data);
818 
819 int acpi_match_device_ids(struct acpi_device *device,
820 			  const struct acpi_device_id *ids)
821 {
822 	return __acpi_match_device(device, ids, NULL, NULL, NULL) ? 0 : -ENOENT;
823 }
824 EXPORT_SYMBOL(acpi_match_device_ids);
825 
826 bool acpi_driver_match_device(struct device *dev,
827 			      const struct device_driver *drv)
828 {
829 	if (!drv->acpi_match_table)
830 		return acpi_of_match_device(ACPI_COMPANION(dev),
831 					    drv->of_match_table,
832 					    NULL);
833 
834 	return __acpi_match_device(acpi_companion_match(dev),
835 				   drv->acpi_match_table, drv->of_match_table,
836 				   NULL, NULL);
837 }
838 EXPORT_SYMBOL_GPL(acpi_driver_match_device);
839 
840 /* --------------------------------------------------------------------------
841                               ACPI Driver Management
842    -------------------------------------------------------------------------- */
843 
844 /**
845  * acpi_bus_register_driver - register a driver with the ACPI bus
846  * @driver: driver being registered
847  *
848  * Registers a driver with the ACPI bus.  Searches the namespace for all
849  * devices that match the driver's criteria and binds.  Returns zero for
850  * success or a negative error status for failure.
851  */
852 int acpi_bus_register_driver(struct acpi_driver *driver)
853 {
854 	int ret;
855 
856 	if (acpi_disabled)
857 		return -ENODEV;
858 	driver->drv.name = driver->name;
859 	driver->drv.bus = &acpi_bus_type;
860 	driver->drv.owner = driver->owner;
861 
862 	ret = driver_register(&driver->drv);
863 	return ret;
864 }
865 
866 EXPORT_SYMBOL(acpi_bus_register_driver);
867 
868 /**
869  * acpi_bus_unregister_driver - unregisters a driver with the ACPI bus
870  * @driver: driver to unregister
871  *
872  * Unregisters a driver with the ACPI bus.  Searches the namespace for all
873  * devices that match the driver's criteria and unbinds.
874  */
875 void acpi_bus_unregister_driver(struct acpi_driver *driver)
876 {
877 	driver_unregister(&driver->drv);
878 }
879 
880 EXPORT_SYMBOL(acpi_bus_unregister_driver);
881 
882 /* --------------------------------------------------------------------------
883                               ACPI Bus operations
884    -------------------------------------------------------------------------- */
885 
886 static int acpi_bus_match(struct device *dev, struct device_driver *drv)
887 {
888 	struct acpi_device *acpi_dev = to_acpi_device(dev);
889 	struct acpi_driver *acpi_drv = to_acpi_driver(drv);
890 
891 	return acpi_dev->flags.match_driver
892 		&& !acpi_match_device_ids(acpi_dev, acpi_drv->ids);
893 }
894 
895 static int acpi_device_uevent(struct device *dev, struct kobj_uevent_env *env)
896 {
897 	return __acpi_device_uevent_modalias(to_acpi_device(dev), env);
898 }
899 
900 static int acpi_device_probe(struct device *dev)
901 {
902 	struct acpi_device *acpi_dev = to_acpi_device(dev);
903 	struct acpi_driver *acpi_drv = to_acpi_driver(dev->driver);
904 	int ret;
905 
906 	if (acpi_dev->handler && !acpi_is_pnp_device(acpi_dev))
907 		return -EINVAL;
908 
909 	if (!acpi_drv->ops.add)
910 		return -ENOSYS;
911 
912 	ret = acpi_drv->ops.add(acpi_dev);
913 	if (ret)
914 		return ret;
915 
916 	acpi_dev->driver = acpi_drv;
917 	ACPI_DEBUG_PRINT((ACPI_DB_INFO,
918 			  "Driver [%s] successfully bound to device [%s]\n",
919 			  acpi_drv->name, acpi_dev->pnp.bus_id));
920 
921 	if (acpi_drv->ops.notify) {
922 		ret = acpi_device_install_notify_handler(acpi_dev);
923 		if (ret) {
924 			if (acpi_drv->ops.remove)
925 				acpi_drv->ops.remove(acpi_dev);
926 
927 			acpi_dev->driver = NULL;
928 			acpi_dev->driver_data = NULL;
929 			return ret;
930 		}
931 	}
932 
933 	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found driver [%s] for device [%s]\n",
934 			  acpi_drv->name, acpi_dev->pnp.bus_id));
935 	get_device(dev);
936 	return 0;
937 }
938 
939 static int acpi_device_remove(struct device *dev)
940 {
941 	struct acpi_device *acpi_dev = to_acpi_device(dev);
942 	struct acpi_driver *acpi_drv = acpi_dev->driver;
943 
944 	if (acpi_drv) {
945 		if (acpi_drv->ops.notify)
946 			acpi_device_remove_notify_handler(acpi_dev);
947 		if (acpi_drv->ops.remove)
948 			acpi_drv->ops.remove(acpi_dev);
949 	}
950 	acpi_dev->driver = NULL;
951 	acpi_dev->driver_data = NULL;
952 
953 	put_device(dev);
954 	return 0;
955 }
956 
957 struct bus_type acpi_bus_type = {
958 	.name		= "acpi",
959 	.match		= acpi_bus_match,
960 	.probe		= acpi_device_probe,
961 	.remove		= acpi_device_remove,
962 	.uevent		= acpi_device_uevent,
963 };
964 
965 /* --------------------------------------------------------------------------
966                              Initialization/Cleanup
967    -------------------------------------------------------------------------- */
968 
969 static int __init acpi_bus_init_irq(void)
970 {
971 	acpi_status status;
972 	char *message = NULL;
973 
974 
975 	/*
976 	 * Let the system know what interrupt model we are using by
977 	 * evaluating the \_PIC object, if exists.
978 	 */
979 
980 	switch (acpi_irq_model) {
981 	case ACPI_IRQ_MODEL_PIC:
982 		message = "PIC";
983 		break;
984 	case ACPI_IRQ_MODEL_IOAPIC:
985 		message = "IOAPIC";
986 		break;
987 	case ACPI_IRQ_MODEL_IOSAPIC:
988 		message = "IOSAPIC";
989 		break;
990 	case ACPI_IRQ_MODEL_GIC:
991 		message = "GIC";
992 		break;
993 	case ACPI_IRQ_MODEL_PLATFORM:
994 		message = "platform specific model";
995 		break;
996 	default:
997 		printk(KERN_WARNING PREFIX "Unknown interrupt routing model\n");
998 		return -ENODEV;
999 	}
1000 
1001 	printk(KERN_INFO PREFIX "Using %s for interrupt routing\n", message);
1002 
1003 	status = acpi_execute_simple_method(NULL, "\\_PIC", acpi_irq_model);
1004 	if (ACPI_FAILURE(status) && (status != AE_NOT_FOUND)) {
1005 		ACPI_EXCEPTION((AE_INFO, status, "Evaluating _PIC"));
1006 		return -ENODEV;
1007 	}
1008 
1009 	return 0;
1010 }
1011 
1012 /**
1013  * acpi_early_init - Initialize ACPICA and populate the ACPI namespace.
1014  *
1015  * The ACPI tables are accessible after this, but the handling of events has not
1016  * been initialized and the global lock is not available yet, so AML should not
1017  * be executed at this point.
1018  *
1019  * Doing this before switching the EFI runtime services to virtual mode allows
1020  * the EfiBootServices memory to be freed slightly earlier on boot.
1021  */
1022 void __init acpi_early_init(void)
1023 {
1024 	acpi_status status;
1025 
1026 	if (acpi_disabled)
1027 		return;
1028 
1029 	printk(KERN_INFO PREFIX "Core revision %08x\n", ACPI_CA_VERSION);
1030 
1031 	/* enable workarounds, unless strict ACPI spec. compliance */
1032 	if (!acpi_strict)
1033 		acpi_gbl_enable_interpreter_slack = TRUE;
1034 
1035 	acpi_permanent_mmap = true;
1036 
1037 #ifdef CONFIG_X86
1038 	/*
1039 	 * If the machine falls into the DMI check table,
1040 	 * DSDT will be copied to memory.
1041 	 * Note that calling dmi_check_system() here on other architectures
1042 	 * would not be OK because only x86 initializes dmi early enough.
1043 	 * Thankfully only x86 systems need such quirks for now.
1044 	 */
1045 	dmi_check_system(dsdt_dmi_table);
1046 #endif
1047 
1048 	status = acpi_reallocate_root_table();
1049 	if (ACPI_FAILURE(status)) {
1050 		printk(KERN_ERR PREFIX
1051 		       "Unable to reallocate ACPI tables\n");
1052 		goto error0;
1053 	}
1054 
1055 	status = acpi_initialize_subsystem();
1056 	if (ACPI_FAILURE(status)) {
1057 		printk(KERN_ERR PREFIX
1058 		       "Unable to initialize the ACPI Interpreter\n");
1059 		goto error0;
1060 	}
1061 
1062 #ifdef CONFIG_X86
1063 	if (!acpi_ioapic) {
1064 		/* compatible (0) means level (3) */
1065 		if (!(acpi_sci_flags & ACPI_MADT_TRIGGER_MASK)) {
1066 			acpi_sci_flags &= ~ACPI_MADT_TRIGGER_MASK;
1067 			acpi_sci_flags |= ACPI_MADT_TRIGGER_LEVEL;
1068 		}
1069 		/* Set PIC-mode SCI trigger type */
1070 		acpi_pic_sci_set_trigger(acpi_gbl_FADT.sci_interrupt,
1071 					 (acpi_sci_flags & ACPI_MADT_TRIGGER_MASK) >> 2);
1072 	} else {
1073 		/*
1074 		 * now that acpi_gbl_FADT is initialized,
1075 		 * update it with result from INT_SRC_OVR parsing
1076 		 */
1077 		acpi_gbl_FADT.sci_interrupt = acpi_sci_override_gsi;
1078 	}
1079 #endif
1080 	return;
1081 
1082  error0:
1083 	disable_acpi();
1084 }
1085 
1086 /**
1087  * acpi_subsystem_init - Finalize the early initialization of ACPI.
1088  *
1089  * Switch over the platform to the ACPI mode (if possible).
1090  *
1091  * Doing this too early is generally unsafe, but at the same time it needs to be
1092  * done before all things that really depend on ACPI.  The right spot appears to
1093  * be before finalizing the EFI initialization.
1094  */
1095 void __init acpi_subsystem_init(void)
1096 {
1097 	acpi_status status;
1098 
1099 	if (acpi_disabled)
1100 		return;
1101 
1102 	status = acpi_enable_subsystem(~ACPI_NO_ACPI_ENABLE);
1103 	if (ACPI_FAILURE(status)) {
1104 		printk(KERN_ERR PREFIX "Unable to enable ACPI\n");
1105 		disable_acpi();
1106 	} else {
1107 		/*
1108 		 * If the system is using ACPI then we can be reasonably
1109 		 * confident that any regulators are managed by the firmware
1110 		 * so tell the regulator core it has everything it needs to
1111 		 * know.
1112 		 */
1113 		regulator_has_full_constraints();
1114 	}
1115 }
1116 
1117 static acpi_status acpi_bus_table_handler(u32 event, void *table, void *context)
1118 {
1119 	acpi_scan_table_handler(event, table, context);
1120 
1121 	return acpi_sysfs_table_handler(event, table, context);
1122 }
1123 
1124 static int __init acpi_bus_init(void)
1125 {
1126 	int result;
1127 	acpi_status status;
1128 
1129 	acpi_os_initialize1();
1130 
1131 	status = acpi_load_tables();
1132 	if (ACPI_FAILURE(status)) {
1133 		printk(KERN_ERR PREFIX
1134 		       "Unable to load the System Description Tables\n");
1135 		goto error1;
1136 	}
1137 
1138 	/*
1139 	 * ACPI 2.0 requires the EC driver to be loaded and work before the EC
1140 	 * device is found in the namespace.
1141 	 *
1142 	 * This is accomplished by looking for the ECDT table and getting the EC
1143 	 * parameters out of that.
1144 	 *
1145 	 * Do that before calling acpi_initialize_objects() which may trigger EC
1146 	 * address space accesses.
1147 	 */
1148 	acpi_ec_ecdt_probe();
1149 
1150 	status = acpi_enable_subsystem(ACPI_NO_ACPI_ENABLE);
1151 	if (ACPI_FAILURE(status)) {
1152 		printk(KERN_ERR PREFIX
1153 		       "Unable to start the ACPI Interpreter\n");
1154 		goto error1;
1155 	}
1156 
1157 	status = acpi_initialize_objects(ACPI_FULL_INITIALIZATION);
1158 	if (ACPI_FAILURE(status)) {
1159 		printk(KERN_ERR PREFIX "Unable to initialize ACPI objects\n");
1160 		goto error1;
1161 	}
1162 
1163 	/* Set capability bits for _OSC under processor scope */
1164 	acpi_early_processor_osc();
1165 
1166 	/*
1167 	 * _OSC method may exist in module level code,
1168 	 * so it must be run after ACPI_FULL_INITIALIZATION
1169 	 */
1170 	acpi_bus_osc_support();
1171 
1172 	/*
1173 	 * _PDC control method may load dynamic SSDT tables,
1174 	 * and we need to install the table handler before that.
1175 	 */
1176 	status = acpi_install_table_handler(acpi_bus_table_handler, NULL);
1177 
1178 	acpi_sysfs_init();
1179 
1180 	acpi_early_processor_set_pdc();
1181 
1182 	/*
1183 	 * Maybe EC region is required at bus_scan/acpi_get_devices. So it
1184 	 * is necessary to enable it as early as possible.
1185 	 */
1186 	acpi_ec_dsdt_probe();
1187 
1188 	printk(KERN_INFO PREFIX "Interpreter enabled\n");
1189 
1190 	/* Initialize sleep structures */
1191 	acpi_sleep_init();
1192 
1193 	/*
1194 	 * Get the system interrupt model and evaluate \_PIC.
1195 	 */
1196 	result = acpi_bus_init_irq();
1197 	if (result)
1198 		goto error1;
1199 
1200 	/*
1201 	 * Register the for all standard device notifications.
1202 	 */
1203 	status =
1204 	    acpi_install_notify_handler(ACPI_ROOT_OBJECT, ACPI_SYSTEM_NOTIFY,
1205 					&acpi_bus_notify, NULL);
1206 	if (ACPI_FAILURE(status)) {
1207 		printk(KERN_ERR PREFIX
1208 		       "Unable to register for device notifications\n");
1209 		goto error1;
1210 	}
1211 
1212 	/*
1213 	 * Create the top ACPI proc directory
1214 	 */
1215 	acpi_root_dir = proc_mkdir(ACPI_BUS_FILE_ROOT, NULL);
1216 
1217 	result = bus_register(&acpi_bus_type);
1218 	if (!result)
1219 		return 0;
1220 
1221 	/* Mimic structured exception handling */
1222       error1:
1223 	acpi_terminate();
1224 	return -ENODEV;
1225 }
1226 
1227 struct kobject *acpi_kobj;
1228 EXPORT_SYMBOL_GPL(acpi_kobj);
1229 
1230 static int __init acpi_init(void)
1231 {
1232 	int result;
1233 
1234 	if (acpi_disabled) {
1235 		printk(KERN_INFO PREFIX "Interpreter disabled.\n");
1236 		return -ENODEV;
1237 	}
1238 
1239 	acpi_kobj = kobject_create_and_add("acpi", firmware_kobj);
1240 	if (!acpi_kobj) {
1241 		printk(KERN_WARNING "%s: kset create error\n", __func__);
1242 		acpi_kobj = NULL;
1243 	}
1244 
1245 	result = acpi_bus_init();
1246 	if (result) {
1247 		disable_acpi();
1248 		return result;
1249 	}
1250 
1251 	pci_mmcfg_late_init();
1252 	acpi_iort_init();
1253 	acpi_scan_init();
1254 	acpi_ec_init();
1255 	acpi_debugfs_init();
1256 	acpi_sleep_proc_init();
1257 	acpi_wakeup_device_init();
1258 	acpi_debugger_init();
1259 	acpi_setup_sb_notify_handler();
1260 	return 0;
1261 }
1262 
1263 subsys_initcall(acpi_init);
1264