xref: /kernel/linux/linux-5.10/drivers/acpi/bus.c (revision 8c2ecf20)
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
35ACPI_MODULE_NAME("bus");
36
37struct acpi_device *acpi_root;
38struct proc_dir_entry *acpi_root_dir;
39EXPORT_SYMBOL(acpi_root_dir);
40
41#ifdef CONFIG_X86
42#ifdef CONFIG_ACPI_CUSTOM_DSDT
43static inline int set_copy_dsdt(const struct dmi_system_id *id)
44{
45	return 0;
46}
47#else
48static 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
57static 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
78acpi_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}
94EXPORT_SYMBOL_GPL(acpi_bus_get_status_handle);
95
96int acpi_bus_get_status(struct acpi_device *device)
97{
98	acpi_status status;
99	unsigned long long sta;
100
101	if (acpi_device_override_status(device, &sta)) {
102		acpi_set_device_status(device, sta);
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}
128EXPORT_SYMBOL(acpi_bus_get_status);
129
130void acpi_bus_private_data_handler(acpi_handle handle,
131				   void *context)
132{
133	return;
134}
135EXPORT_SYMBOL(acpi_bus_private_data_handler);
136
137int 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}
150EXPORT_SYMBOL_GPL(acpi_bus_attach_private_data);
151
152int 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}
167EXPORT_SYMBOL_GPL(acpi_bus_get_private_data);
168
169void acpi_bus_detach_private_data(acpi_handle handle)
170{
171	acpi_detach_data(handle, acpi_bus_private_data_handler);
172}
173EXPORT_SYMBOL_GPL(acpi_bus_detach_private_data);
174
175static 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
189acpi_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	}
257out_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
267out_kfree:
268	kfree(output.pointer);
269	if (status != AE_OK)
270		context->ret.pointer = NULL;
271	return status;
272}
273EXPORT_SYMBOL(acpi_run_osc);
274
275bool 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 */
281bool osc_pc_lpi_support_confirmed;
282EXPORT_SYMBOL_GPL(osc_pc_lpi_support_confirmed);
283
284static u8 sb_uuid_str[] = "0811B06E-4A27-44F9-8D60-3CBBC22E7B48";
285static 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 */
346static 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
420static 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
427static 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
435static 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
441static 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
466static 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
484static 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
504static 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
515static 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 */
539struct 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}
558EXPORT_SYMBOL_GPL(acpi_get_first_physical_node);
559
560static struct acpi_device *acpi_primary_dev_companion(struct acpi_device *adev,
561						      const struct device *dev)
562{
563	const struct device *phys_dev = acpi_get_first_physical_node(adev);
564
565	return phys_dev && phys_dev == dev ? adev : NULL;
566}
567
568/**
569 * acpi_device_is_first_physical_node - Is given dev first physical node
570 * @adev: ACPI companion device
571 * @dev: Physical device to check
572 *
573 * Function checks if given @dev is the first physical devices attached to
574 * the ACPI companion device. This distinction is needed in some cases
575 * where the same companion device is shared between many physical devices.
576 *
577 * Note that the caller have to provide valid @adev pointer.
578 */
579bool acpi_device_is_first_physical_node(struct acpi_device *adev,
580					const struct device *dev)
581{
582	return !!acpi_primary_dev_companion(adev, dev);
583}
584
585/*
586 * acpi_companion_match() - Can we match via ACPI companion device
587 * @dev: Device in question
588 *
589 * Check if the given device has an ACPI companion and if that companion has
590 * a valid list of PNP IDs, and if the device is the first (primary) physical
591 * device associated with it.  Return the companion pointer if that's the case
592 * or NULL otherwise.
593 *
594 * If multiple physical devices are attached to a single ACPI companion, we need
595 * to be careful.  The usage scenario for this kind of relationship is that all
596 * of the physical devices in question use resources provided by the ACPI
597 * companion.  A typical case is an MFD device where all the sub-devices share
598 * the parent's ACPI companion.  In such cases we can only allow the primary
599 * (first) physical device to be matched with the help of the companion's PNP
600 * IDs.
601 *
602 * Additional physical devices sharing the ACPI companion can still use
603 * resources available from it but they will be matched normally using functions
604 * provided by their bus types (and analogously for their modalias).
605 */
606struct acpi_device *acpi_companion_match(const struct device *dev)
607{
608	struct acpi_device *adev;
609
610	adev = ACPI_COMPANION(dev);
611	if (!adev)
612		return NULL;
613
614	if (list_empty(&adev->pnp.ids))
615		return NULL;
616
617	return acpi_primary_dev_companion(adev, dev);
618}
619
620/**
621 * acpi_of_match_device - Match device object using the "compatible" property.
622 * @adev: ACPI device object to match.
623 * @of_match_table: List of device IDs to match against.
624 * @of_id: OF ID if matched
625 *
626 * If @dev has an ACPI companion which has ACPI_DT_NAMESPACE_HID in its list of
627 * identifiers and a _DSD object with the "compatible" property, use that
628 * property to match against the given list of identifiers.
629 */
630static bool acpi_of_match_device(struct acpi_device *adev,
631				 const struct of_device_id *of_match_table,
632				 const struct of_device_id **of_id)
633{
634	const union acpi_object *of_compatible, *obj;
635	int i, nval;
636
637	if (!adev)
638		return false;
639
640	of_compatible = adev->data.of_compatible;
641	if (!of_match_table || !of_compatible)
642		return false;
643
644	if (of_compatible->type == ACPI_TYPE_PACKAGE) {
645		nval = of_compatible->package.count;
646		obj = of_compatible->package.elements;
647	} else { /* Must be ACPI_TYPE_STRING. */
648		nval = 1;
649		obj = of_compatible;
650	}
651	/* Now we can look for the driver DT compatible strings */
652	for (i = 0; i < nval; i++, obj++) {
653		const struct of_device_id *id;
654
655		for (id = of_match_table; id->compatible[0]; id++)
656			if (!strcasecmp(obj->string.pointer, id->compatible)) {
657				if (of_id)
658					*of_id = id;
659				return true;
660			}
661	}
662
663	return false;
664}
665
666static bool acpi_of_modalias(struct acpi_device *adev,
667			     char *modalias, size_t len)
668{
669	const union acpi_object *of_compatible;
670	const union acpi_object *obj;
671	const char *str, *chr;
672
673	of_compatible = adev->data.of_compatible;
674	if (!of_compatible)
675		return false;
676
677	if (of_compatible->type == ACPI_TYPE_PACKAGE)
678		obj = of_compatible->package.elements;
679	else /* Must be ACPI_TYPE_STRING. */
680		obj = of_compatible;
681
682	str = obj->string.pointer;
683	chr = strchr(str, ',');
684	strlcpy(modalias, chr ? chr + 1 : str, len);
685
686	return true;
687}
688
689/**
690 * acpi_set_modalias - Set modalias using "compatible" property or supplied ID
691 * @adev:	ACPI device object to match
692 * @default_id:	ID string to use as default if no compatible string found
693 * @modalias:   Pointer to buffer that modalias value will be copied into
694 * @len:	Length of modalias buffer
695 *
696 * This is a counterpart of of_modalias_node() for struct acpi_device objects.
697 * If there is a compatible string for @adev, it will be copied to @modalias
698 * with the vendor prefix stripped; otherwise, @default_id will be used.
699 */
700void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
701		       char *modalias, size_t len)
702{
703	if (!acpi_of_modalias(adev, modalias, len))
704		strlcpy(modalias, default_id, len);
705}
706EXPORT_SYMBOL_GPL(acpi_set_modalias);
707
708static bool __acpi_match_device_cls(const struct acpi_device_id *id,
709				    struct acpi_hardware_id *hwid)
710{
711	int i, msk, byte_shift;
712	char buf[3];
713
714	if (!id->cls)
715		return false;
716
717	/* Apply class-code bitmask, before checking each class-code byte */
718	for (i = 1; i <= 3; i++) {
719		byte_shift = 8 * (3 - i);
720		msk = (id->cls_msk >> byte_shift) & 0xFF;
721		if (!msk)
722			continue;
723
724		sprintf(buf, "%02x", (id->cls >> byte_shift) & msk);
725		if (strncmp(buf, &hwid->id[(i - 1) * 2], 2))
726			return false;
727	}
728	return true;
729}
730
731static bool __acpi_match_device(struct acpi_device *device,
732				const struct acpi_device_id *acpi_ids,
733				const struct of_device_id *of_ids,
734				const struct acpi_device_id **acpi_id,
735				const struct of_device_id **of_id)
736{
737	const struct acpi_device_id *id;
738	struct acpi_hardware_id *hwid;
739
740	/*
741	 * If the device is not present, it is unnecessary to load device
742	 * driver for it.
743	 */
744	if (!device || !device->status.present)
745		return false;
746
747	list_for_each_entry(hwid, &device->pnp.ids, list) {
748		/* First, check the ACPI/PNP IDs provided by the caller. */
749		if (acpi_ids) {
750			for (id = acpi_ids; id->id[0] || id->cls; id++) {
751				if (id->id[0] && !strcmp((char *)id->id, hwid->id))
752					goto out_acpi_match;
753				if (id->cls && __acpi_match_device_cls(id, hwid))
754					goto out_acpi_match;
755			}
756		}
757
758		/*
759		 * Next, check ACPI_DT_NAMESPACE_HID and try to match the
760		 * "compatible" property if found.
761		 */
762		if (!strcmp(ACPI_DT_NAMESPACE_HID, hwid->id))
763			return acpi_of_match_device(device, of_ids, of_id);
764	}
765	return false;
766
767out_acpi_match:
768	if (acpi_id)
769		*acpi_id = id;
770	return true;
771}
772
773/**
774 * acpi_match_device - Match a struct device against a given list of ACPI IDs
775 * @ids: Array of struct acpi_device_id object to match against.
776 * @dev: The device structure to match.
777 *
778 * Check if @dev has a valid ACPI handle and if there is a struct acpi_device
779 * object for that handle and use that object to match against a given list of
780 * device IDs.
781 *
782 * Return a pointer to the first matching ID on success or %NULL on failure.
783 */
784const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
785					       const struct device *dev)
786{
787	const struct acpi_device_id *id = NULL;
788
789	__acpi_match_device(acpi_companion_match(dev), ids, NULL, &id, NULL);
790	return id;
791}
792EXPORT_SYMBOL_GPL(acpi_match_device);
793
794static const void *acpi_of_device_get_match_data(const struct device *dev)
795{
796	struct acpi_device *adev = ACPI_COMPANION(dev);
797	const struct of_device_id *match = NULL;
798
799	if (!acpi_of_match_device(adev, dev->driver->of_match_table, &match))
800		return NULL;
801
802	return match->data;
803}
804
805const void *acpi_device_get_match_data(const struct device *dev)
806{
807	const struct acpi_device_id *match;
808
809	if (!dev->driver->acpi_match_table)
810		return acpi_of_device_get_match_data(dev);
811
812	match = acpi_match_device(dev->driver->acpi_match_table, dev);
813	if (!match)
814		return NULL;
815
816	return (const void *)match->driver_data;
817}
818EXPORT_SYMBOL_GPL(acpi_device_get_match_data);
819
820int acpi_match_device_ids(struct acpi_device *device,
821			  const struct acpi_device_id *ids)
822{
823	return __acpi_match_device(device, ids, NULL, NULL, NULL) ? 0 : -ENOENT;
824}
825EXPORT_SYMBOL(acpi_match_device_ids);
826
827bool acpi_driver_match_device(struct device *dev,
828			      const struct device_driver *drv)
829{
830	if (!drv->acpi_match_table)
831		return acpi_of_match_device(ACPI_COMPANION(dev),
832					    drv->of_match_table,
833					    NULL);
834
835	return __acpi_match_device(acpi_companion_match(dev),
836				   drv->acpi_match_table, drv->of_match_table,
837				   NULL, NULL);
838}
839EXPORT_SYMBOL_GPL(acpi_driver_match_device);
840
841/* --------------------------------------------------------------------------
842                              ACPI Driver Management
843   -------------------------------------------------------------------------- */
844
845/**
846 * acpi_bus_register_driver - register a driver with the ACPI bus
847 * @driver: driver being registered
848 *
849 * Registers a driver with the ACPI bus.  Searches the namespace for all
850 * devices that match the driver's criteria and binds.  Returns zero for
851 * success or a negative error status for failure.
852 */
853int acpi_bus_register_driver(struct acpi_driver *driver)
854{
855	int ret;
856
857	if (acpi_disabled)
858		return -ENODEV;
859	driver->drv.name = driver->name;
860	driver->drv.bus = &acpi_bus_type;
861	driver->drv.owner = driver->owner;
862
863	ret = driver_register(&driver->drv);
864	return ret;
865}
866
867EXPORT_SYMBOL(acpi_bus_register_driver);
868
869/**
870 * acpi_bus_unregister_driver - unregisters a driver with the ACPI bus
871 * @driver: driver to unregister
872 *
873 * Unregisters a driver with the ACPI bus.  Searches the namespace for all
874 * devices that match the driver's criteria and unbinds.
875 */
876void acpi_bus_unregister_driver(struct acpi_driver *driver)
877{
878	driver_unregister(&driver->drv);
879}
880
881EXPORT_SYMBOL(acpi_bus_unregister_driver);
882
883/* --------------------------------------------------------------------------
884                              ACPI Bus operations
885   -------------------------------------------------------------------------- */
886
887static int acpi_bus_match(struct device *dev, struct device_driver *drv)
888{
889	struct acpi_device *acpi_dev = to_acpi_device(dev);
890	struct acpi_driver *acpi_drv = to_acpi_driver(drv);
891
892	return acpi_dev->flags.match_driver
893		&& !acpi_match_device_ids(acpi_dev, acpi_drv->ids);
894}
895
896static int acpi_device_uevent(struct device *dev, struct kobj_uevent_env *env)
897{
898	return __acpi_device_uevent_modalias(to_acpi_device(dev), env);
899}
900
901static int acpi_device_probe(struct device *dev)
902{
903	struct acpi_device *acpi_dev = to_acpi_device(dev);
904	struct acpi_driver *acpi_drv = to_acpi_driver(dev->driver);
905	int ret;
906
907	if (acpi_dev->handler && !acpi_is_pnp_device(acpi_dev))
908		return -EINVAL;
909
910	if (!acpi_drv->ops.add)
911		return -ENOSYS;
912
913	ret = acpi_drv->ops.add(acpi_dev);
914	if (ret)
915		return ret;
916
917	acpi_dev->driver = acpi_drv;
918	ACPI_DEBUG_PRINT((ACPI_DB_INFO,
919			  "Driver [%s] successfully bound to device [%s]\n",
920			  acpi_drv->name, acpi_dev->pnp.bus_id));
921
922	if (acpi_drv->ops.notify) {
923		ret = acpi_device_install_notify_handler(acpi_dev);
924		if (ret) {
925			if (acpi_drv->ops.remove)
926				acpi_drv->ops.remove(acpi_dev);
927
928			acpi_dev->driver = NULL;
929			acpi_dev->driver_data = NULL;
930			return ret;
931		}
932	}
933
934	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found driver [%s] for device [%s]\n",
935			  acpi_drv->name, acpi_dev->pnp.bus_id));
936	get_device(dev);
937	return 0;
938}
939
940static int acpi_device_remove(struct device *dev)
941{
942	struct acpi_device *acpi_dev = to_acpi_device(dev);
943	struct acpi_driver *acpi_drv = acpi_dev->driver;
944
945	if (acpi_drv) {
946		if (acpi_drv->ops.notify)
947			acpi_device_remove_notify_handler(acpi_dev);
948		if (acpi_drv->ops.remove)
949			acpi_drv->ops.remove(acpi_dev);
950	}
951	acpi_dev->driver = NULL;
952	acpi_dev->driver_data = NULL;
953
954	put_device(dev);
955	return 0;
956}
957
958struct bus_type acpi_bus_type = {
959	.name		= "acpi",
960	.match		= acpi_bus_match,
961	.probe		= acpi_device_probe,
962	.remove		= acpi_device_remove,
963	.uevent		= acpi_device_uevent,
964};
965
966/* --------------------------------------------------------------------------
967                             Initialization/Cleanup
968   -------------------------------------------------------------------------- */
969
970static int __init acpi_bus_init_irq(void)
971{
972	acpi_status status;
973	char *message = NULL;
974
975
976	/*
977	 * Let the system know what interrupt model we are using by
978	 * evaluating the \_PIC object, if exists.
979	 */
980
981	switch (acpi_irq_model) {
982	case ACPI_IRQ_MODEL_PIC:
983		message = "PIC";
984		break;
985	case ACPI_IRQ_MODEL_IOAPIC:
986		message = "IOAPIC";
987		break;
988	case ACPI_IRQ_MODEL_IOSAPIC:
989		message = "IOSAPIC";
990		break;
991	case ACPI_IRQ_MODEL_GIC:
992		message = "GIC";
993		break;
994	case ACPI_IRQ_MODEL_PLATFORM:
995		message = "platform specific model";
996		break;
997	case ACPI_IRQ_MODEL_LPIC:
998		message = "LPIC";
999		break;
1000	default:
1001		printk(KERN_WARNING PREFIX "Unknown interrupt routing model\n");
1002		return -ENODEV;
1003	}
1004
1005	printk(KERN_INFO PREFIX "Using %s for interrupt routing\n", message);
1006
1007	status = acpi_execute_simple_method(NULL, "\\_PIC", acpi_irq_model);
1008	if (ACPI_FAILURE(status) && (status != AE_NOT_FOUND)) {
1009		ACPI_EXCEPTION((AE_INFO, status, "Evaluating _PIC"));
1010		return -ENODEV;
1011	}
1012
1013	return 0;
1014}
1015
1016/**
1017 * acpi_early_init - Initialize ACPICA and populate the ACPI namespace.
1018 *
1019 * The ACPI tables are accessible after this, but the handling of events has not
1020 * been initialized and the global lock is not available yet, so AML should not
1021 * be executed at this point.
1022 *
1023 * Doing this before switching the EFI runtime services to virtual mode allows
1024 * the EfiBootServices memory to be freed slightly earlier on boot.
1025 */
1026void __init acpi_early_init(void)
1027{
1028	acpi_status status;
1029
1030	if (acpi_disabled)
1031		return;
1032
1033	printk(KERN_INFO PREFIX "Core revision %08x\n", ACPI_CA_VERSION);
1034
1035	/* enable workarounds, unless strict ACPI spec. compliance */
1036	if (!acpi_strict)
1037		acpi_gbl_enable_interpreter_slack = TRUE;
1038
1039	acpi_permanent_mmap = true;
1040
1041#ifdef CONFIG_X86
1042	/*
1043	 * If the machine falls into the DMI check table,
1044	 * DSDT will be copied to memory.
1045	 * Note that calling dmi_check_system() here on other architectures
1046	 * would not be OK because only x86 initializes dmi early enough.
1047	 * Thankfully only x86 systems need such quirks for now.
1048	 */
1049	dmi_check_system(dsdt_dmi_table);
1050#endif
1051
1052	status = acpi_reallocate_root_table();
1053	if (ACPI_FAILURE(status)) {
1054		printk(KERN_ERR PREFIX
1055		       "Unable to reallocate ACPI tables\n");
1056		goto error0;
1057	}
1058
1059	status = acpi_initialize_subsystem();
1060	if (ACPI_FAILURE(status)) {
1061		printk(KERN_ERR PREFIX
1062		       "Unable to initialize the ACPI Interpreter\n");
1063		goto error0;
1064	}
1065
1066#ifdef CONFIG_X86
1067	if (!acpi_ioapic) {
1068		/* compatible (0) means level (3) */
1069		if (!(acpi_sci_flags & ACPI_MADT_TRIGGER_MASK)) {
1070			acpi_sci_flags &= ~ACPI_MADT_TRIGGER_MASK;
1071			acpi_sci_flags |= ACPI_MADT_TRIGGER_LEVEL;
1072		}
1073		/* Set PIC-mode SCI trigger type */
1074		acpi_pic_sci_set_trigger(acpi_gbl_FADT.sci_interrupt,
1075					 (acpi_sci_flags & ACPI_MADT_TRIGGER_MASK) >> 2);
1076	} else {
1077		/*
1078		 * now that acpi_gbl_FADT is initialized,
1079		 * update it with result from INT_SRC_OVR parsing
1080		 */
1081		acpi_gbl_FADT.sci_interrupt = acpi_sci_override_gsi;
1082	}
1083#endif
1084	return;
1085
1086 error0:
1087	disable_acpi();
1088}
1089
1090/**
1091 * acpi_subsystem_init - Finalize the early initialization of ACPI.
1092 *
1093 * Switch over the platform to the ACPI mode (if possible).
1094 *
1095 * Doing this too early is generally unsafe, but at the same time it needs to be
1096 * done before all things that really depend on ACPI.  The right spot appears to
1097 * be before finalizing the EFI initialization.
1098 */
1099void __init acpi_subsystem_init(void)
1100{
1101	acpi_status status;
1102
1103	if (acpi_disabled)
1104		return;
1105
1106	status = acpi_enable_subsystem(~ACPI_NO_ACPI_ENABLE);
1107	if (ACPI_FAILURE(status)) {
1108		printk(KERN_ERR PREFIX "Unable to enable ACPI\n");
1109		disable_acpi();
1110	} else {
1111		/*
1112		 * If the system is using ACPI then we can be reasonably
1113		 * confident that any regulators are managed by the firmware
1114		 * so tell the regulator core it has everything it needs to
1115		 * know.
1116		 */
1117		regulator_has_full_constraints();
1118	}
1119}
1120
1121static acpi_status acpi_bus_table_handler(u32 event, void *table, void *context)
1122{
1123	acpi_scan_table_handler(event, table, context);
1124
1125	return acpi_sysfs_table_handler(event, table, context);
1126}
1127
1128static int __init acpi_bus_init(void)
1129{
1130	int result;
1131	acpi_status status;
1132
1133	acpi_os_initialize1();
1134
1135	status = acpi_load_tables();
1136	if (ACPI_FAILURE(status)) {
1137		printk(KERN_ERR PREFIX
1138		       "Unable to load the System Description Tables\n");
1139		goto error1;
1140	}
1141
1142	/*
1143	 * ACPI 2.0 requires the EC driver to be loaded and work before the EC
1144	 * device is found in the namespace.
1145	 *
1146	 * This is accomplished by looking for the ECDT table and getting the EC
1147	 * parameters out of that.
1148	 *
1149	 * Do that before calling acpi_initialize_objects() which may trigger EC
1150	 * address space accesses.
1151	 */
1152	acpi_ec_ecdt_probe();
1153
1154	status = acpi_enable_subsystem(ACPI_NO_ACPI_ENABLE);
1155	if (ACPI_FAILURE(status)) {
1156		printk(KERN_ERR PREFIX
1157		       "Unable to start the ACPI Interpreter\n");
1158		goto error1;
1159	}
1160
1161	status = acpi_initialize_objects(ACPI_FULL_INITIALIZATION);
1162	if (ACPI_FAILURE(status)) {
1163		printk(KERN_ERR PREFIX "Unable to initialize ACPI objects\n");
1164		goto error1;
1165	}
1166
1167	/* Set capability bits for _OSC under processor scope */
1168	acpi_early_processor_osc();
1169
1170	/*
1171	 * _OSC method may exist in module level code,
1172	 * so it must be run after ACPI_FULL_INITIALIZATION
1173	 */
1174	acpi_bus_osc_support();
1175
1176	/*
1177	 * _PDC control method may load dynamic SSDT tables,
1178	 * and we need to install the table handler before that.
1179	 */
1180	status = acpi_install_table_handler(acpi_bus_table_handler, NULL);
1181
1182	acpi_sysfs_init();
1183
1184	acpi_early_processor_set_pdc();
1185
1186	/*
1187	 * Maybe EC region is required at bus_scan/acpi_get_devices. So it
1188	 * is necessary to enable it as early as possible.
1189	 */
1190	acpi_ec_dsdt_probe();
1191
1192	printk(KERN_INFO PREFIX "Interpreter enabled\n");
1193
1194	/* Initialize sleep structures */
1195	acpi_sleep_init();
1196
1197	/*
1198	 * Get the system interrupt model and evaluate \_PIC.
1199	 */
1200	result = acpi_bus_init_irq();
1201	if (result)
1202		goto error1;
1203
1204	/*
1205	 * Register the for all standard device notifications.
1206	 */
1207	status =
1208	    acpi_install_notify_handler(ACPI_ROOT_OBJECT, ACPI_SYSTEM_NOTIFY,
1209					&acpi_bus_notify, NULL);
1210	if (ACPI_FAILURE(status)) {
1211		printk(KERN_ERR PREFIX
1212		       "Unable to register for device notifications\n");
1213		goto error1;
1214	}
1215
1216	/*
1217	 * Create the top ACPI proc directory
1218	 */
1219	acpi_root_dir = proc_mkdir(ACPI_BUS_FILE_ROOT, NULL);
1220
1221	result = bus_register(&acpi_bus_type);
1222	if (!result)
1223		return 0;
1224
1225	/* Mimic structured exception handling */
1226      error1:
1227	acpi_terminate();
1228	return -ENODEV;
1229}
1230
1231struct kobject *acpi_kobj;
1232EXPORT_SYMBOL_GPL(acpi_kobj);
1233
1234static int __init acpi_init(void)
1235{
1236	int result;
1237
1238	if (acpi_disabled) {
1239		printk(KERN_INFO PREFIX "Interpreter disabled.\n");
1240		return -ENODEV;
1241	}
1242
1243	acpi_kobj = kobject_create_and_add("acpi", firmware_kobj);
1244	if (!acpi_kobj) {
1245		printk(KERN_WARNING "%s: kset create error\n", __func__);
1246		acpi_kobj = NULL;
1247	}
1248
1249	result = acpi_bus_init();
1250	if (result) {
1251		kobject_put(acpi_kobj);
1252		disable_acpi();
1253		return result;
1254	}
1255
1256	pci_mmcfg_late_init();
1257	acpi_iort_init();
1258	acpi_hest_init();
1259	ghes_init();
1260	acpi_scan_init();
1261	acpi_ec_init();
1262	acpi_debugfs_init();
1263	acpi_sleep_proc_init();
1264	acpi_wakeup_device_init();
1265	acpi_debugger_init();
1266	acpi_setup_sb_notify_handler();
1267	return 0;
1268}
1269
1270subsys_initcall(acpi_init);
1271