xref: /linux/drivers/acpi/bus.c (revision 36808d5e983985bbda87e01059cccc071fe3ec8d)
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 #define pr_fmt(fmt) "ACPI: " fmt
9 
10 #include <linux/module.h>
11 #include <linux/init.h>
12 #include <linux/ioport.h>
13 #include <linux/kernel.h>
14 #include <linux/list.h>
15 #include <linux/sched.h>
16 #include <linux/pm.h>
17 #include <linux/device.h>
18 #include <linux/proc_fs.h>
19 #include <linux/acpi.h>
20 #include <linux/slab.h>
21 #include <linux/regulator/machine.h>
22 #include <linux/workqueue.h>
23 #include <linux/reboot.h>
24 #include <linux/delay.h>
25 #ifdef CONFIG_X86
26 #include <asm/mpspec.h>
27 #include <linux/dmi.h>
28 #endif
29 #include <linux/acpi_viot.h>
30 #include <linux/pci.h>
31 #include <acpi/apei.h>
32 #include <linux/suspend.h>
33 #include <linux/prmt.h>
34 
35 #include "internal.h"
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 	pr_notice("%s detected - force copy of DSDT to local memory\n", id->ident);
51 	acpi_gbl_copy_dsdt_locally = 1;
52 	return 0;
53 }
54 #endif
55 
56 static const struct dmi_system_id dsdt_dmi_table[] __initconst = {
57 	/*
58 	 * Invoke DSDT corruption work-around on all Toshiba Satellite.
59 	 * https://bugzilla.kernel.org/show_bug.cgi?id=14679
60 	 */
61 	{
62 	 .callback = set_copy_dsdt,
63 	 .ident = "TOSHIBA Satellite",
64 	 .matches = {
65 		DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
66 		DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
67 		},
68 	},
69 	{}
70 };
71 #endif
72 
73 /* --------------------------------------------------------------------------
74                                 Device Management
75    -------------------------------------------------------------------------- */
76 
77 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
78 				       unsigned long long *sta)
79 {
80 	acpi_status status;
81 
82 	status = acpi_evaluate_integer(handle, "_STA", NULL, sta);
83 	if (ACPI_SUCCESS(status))
84 		return AE_OK;
85 
86 	if (status == AE_NOT_FOUND) {
87 		*sta = ACPI_STA_DEVICE_PRESENT | ACPI_STA_DEVICE_ENABLED |
88 		       ACPI_STA_DEVICE_UI      | ACPI_STA_DEVICE_FUNCTIONING;
89 		return AE_OK;
90 	}
91 	return status;
92 }
93 EXPORT_SYMBOL_GPL(acpi_bus_get_status_handle);
94 
95 int acpi_bus_get_status(struct acpi_device *device)
96 {
97 	acpi_status status;
98 	unsigned long long sta;
99 
100 	if (acpi_device_override_status(device, &sta)) {
101 		acpi_set_device_status(device, sta);
102 		return 0;
103 	}
104 
105 	/* Battery devices must have their deps met before calling _STA */
106 	if (acpi_device_is_battery(device) && device->dep_unmet) {
107 		acpi_set_device_status(device, 0);
108 		return 0;
109 	}
110 
111 	status = acpi_bus_get_status_handle(device->handle, &sta);
112 	if (ACPI_FAILURE(status))
113 		return -ENODEV;
114 
115 	if (!device->status.present && device->status.enabled) {
116 		pr_info(FW_BUG "Device [%s] status [%08x]: not present and enabled\n",
117 			device->pnp.bus_id, (u32)sta);
118 		device->status.enabled = 0;
119 		/*
120 		 * The status is clearly invalid, so clear the functional bit as
121 		 * well to avoid attempting to use the device.
122 		 */
123 		device->status.functional = 0;
124 	}
125 
126 	acpi_set_device_status(device, sta);
127 
128 	if (device->status.functional && !device->status.present) {
129 		pr_debug("Device [%s] status [%08x]: functional but not present\n",
130 			 device->pnp.bus_id, (u32)sta);
131 	}
132 
133 	pr_debug("Device [%s] status [%08x]\n", device->pnp.bus_id, (u32)sta);
134 	return 0;
135 }
136 EXPORT_SYMBOL(acpi_bus_get_status);
137 
138 void acpi_bus_private_data_handler(acpi_handle handle,
139 				   void *context)
140 {
141 	return;
142 }
143 EXPORT_SYMBOL(acpi_bus_private_data_handler);
144 
145 int acpi_bus_attach_private_data(acpi_handle handle, void *data)
146 {
147 	acpi_status status;
148 
149 	status = acpi_attach_data(handle,
150 			acpi_bus_private_data_handler, data);
151 	if (ACPI_FAILURE(status)) {
152 		acpi_handle_debug(handle, "Error attaching device data\n");
153 		return -ENODEV;
154 	}
155 
156 	return 0;
157 }
158 EXPORT_SYMBOL_GPL(acpi_bus_attach_private_data);
159 
160 int acpi_bus_get_private_data(acpi_handle handle, void **data)
161 {
162 	acpi_status status;
163 
164 	if (!data)
165 		return -EINVAL;
166 
167 	status = acpi_get_data(handle, acpi_bus_private_data_handler, data);
168 	if (ACPI_FAILURE(status)) {
169 		acpi_handle_debug(handle, "No context for object\n");
170 		return -ENODEV;
171 	}
172 
173 	return 0;
174 }
175 EXPORT_SYMBOL_GPL(acpi_bus_get_private_data);
176 
177 void acpi_bus_detach_private_data(acpi_handle handle)
178 {
179 	acpi_detach_data(handle, acpi_bus_private_data_handler);
180 }
181 EXPORT_SYMBOL_GPL(acpi_bus_detach_private_data);
182 
183 static void acpi_dump_osc_data(acpi_handle handle, const guid_t *guid, int rev,
184 			       struct acpi_buffer *cap)
185 {
186 	u32 *capbuf = cap->pointer;
187 	int i;
188 
189 	acpi_handle_debug(handle, "_OSC: UUID: %pUL, rev: %d\n", guid, rev);
190 	for (i = 0; i < cap->length / sizeof(u32); i++)
191 		acpi_handle_debug(handle, "_OSC: capabilities DWORD %i: [%08x]\n",
192 				  i, capbuf[i]);
193 }
194 
195 #define OSC_ERROR_MASK 	(OSC_REQUEST_ERROR | OSC_INVALID_UUID_ERROR | \
196 			 OSC_INVALID_REVISION_ERROR | \
197 			 OSC_CAPABILITIES_MASK_ERROR)
198 
199 static int acpi_eval_osc(acpi_handle handle, guid_t *guid, int rev,
200 			 struct acpi_buffer *cap,
201 			 union acpi_object in_params[at_least 4],
202 			 struct acpi_buffer *output)
203 {
204 	struct acpi_object_list input;
205 	union acpi_object *out_obj;
206 	acpi_status status;
207 
208 	in_params[0].type = ACPI_TYPE_BUFFER;
209 	in_params[0].buffer.length = sizeof(*guid);
210 	in_params[0].buffer.pointer = (u8 *)guid;
211 	in_params[1].type = ACPI_TYPE_INTEGER;
212 	in_params[1].integer.value = rev;
213 	in_params[2].type = ACPI_TYPE_INTEGER;
214 	in_params[2].integer.value = cap->length / sizeof(u32);
215 	in_params[3].type = ACPI_TYPE_BUFFER;
216 	in_params[3].buffer.length = cap->length;
217 	in_params[3].buffer.pointer = cap->pointer;
218 	input.pointer = in_params;
219 	input.count = 4;
220 
221 	output->length = ACPI_ALLOCATE_BUFFER;
222 	output->pointer = NULL;
223 
224 	status = acpi_evaluate_object(handle, "_OSC", &input, output);
225 	if (ACPI_FAILURE(status) || !output->length)
226 		return -ENODATA;
227 
228 	out_obj = output->pointer;
229 	if (out_obj->type != ACPI_TYPE_BUFFER ||
230 	    out_obj->buffer.length != cap->length) {
231 		acpi_handle_debug(handle, "Invalid _OSC return buffer\n");
232 		acpi_dump_osc_data(handle, guid, rev, cap);
233 		ACPI_FREE(out_obj);
234 		return -ENODATA;
235 	}
236 
237 	return 0;
238 }
239 
240 static bool acpi_osc_error_check(acpi_handle handle, guid_t *guid, int rev,
241 				 struct acpi_buffer *cap, u32 *retbuf)
242 {
243 	/* Only take defined error bits into account. */
244 	u32 errors = retbuf[OSC_QUERY_DWORD] & OSC_ERROR_MASK;
245 	u32 *capbuf = cap->pointer;
246 	bool fail;
247 
248 	/*
249 	 * If OSC_QUERY_ENABLE is set, ignore the "capabilities masked"
250 	 * bit because it merely means that some features have not been
251 	 * acknowledged which is not unexpected.
252 	 */
253 	if (capbuf[OSC_QUERY_DWORD] & OSC_QUERY_ENABLE)
254 		errors &= ~OSC_CAPABILITIES_MASK_ERROR;
255 
256 	if (!errors)
257 		return false;
258 
259 	acpi_dump_osc_data(handle, guid, rev, cap);
260 	/*
261 	 * As a rule, fail only if OSC_QUERY_ENABLE is set because otherwise the
262 	 * acknowledged features need to be controlled.
263 	 */
264 	fail = !!(capbuf[OSC_QUERY_DWORD] & OSC_QUERY_ENABLE);
265 
266 	if (errors & OSC_REQUEST_ERROR)
267 		acpi_handle_debug(handle, "_OSC: request failed\n");
268 
269 	if (errors & OSC_INVALID_UUID_ERROR) {
270 		acpi_handle_debug(handle, "_OSC: invalid UUID\n");
271 		/*
272 		 * Always fail if this bit is set because it means that the
273 		 * request could not be processed.
274 		 */
275 		fail = true;
276 	}
277 
278 	if (errors & OSC_INVALID_REVISION_ERROR)
279 		acpi_handle_debug(handle, "_OSC: invalid revision\n");
280 
281 	if (errors & OSC_CAPABILITIES_MASK_ERROR)
282 		acpi_handle_debug(handle, "_OSC: capability bits masked\n");
283 
284 	return fail;
285 }
286 
287 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context)
288 {
289 	union acpi_object in_params[4], *out_obj;
290 	struct acpi_buffer output;
291 	acpi_status status = AE_OK;
292 	guid_t guid;
293 	u32 *retbuf;
294 	int ret;
295 
296 	if (!context || !context->cap.pointer ||
297 	    context->cap.length < 2 * sizeof(u32) ||
298 	    guid_parse(context->uuid_str, &guid))
299 		return AE_BAD_PARAMETER;
300 
301 	ret = acpi_eval_osc(handle, &guid, context->rev, &context->cap,
302 			    in_params, &output);
303 	if (ret)
304 		return AE_ERROR;
305 
306 	out_obj = output.pointer;
307 	retbuf = (u32 *)out_obj->buffer.pointer;
308 
309 	if (acpi_osc_error_check(handle, &guid, context->rev, &context->cap, retbuf)) {
310 		status = AE_ERROR;
311 		goto out;
312 	}
313 
314 	context->ret.length = out_obj->buffer.length;
315 	context->ret.pointer = kmemdup(retbuf, context->ret.length, GFP_KERNEL);
316 	if (!context->ret.pointer) {
317 		status =  AE_NO_MEMORY;
318 		goto out;
319 	}
320 	status =  AE_OK;
321 
322 out:
323 	ACPI_FREE(out_obj);
324 	return status;
325 }
326 EXPORT_SYMBOL(acpi_run_osc);
327 
328 static int acpi_osc_handshake(acpi_handle handle, const char *uuid_str,
329 			      int rev, u32 *capbuf, size_t bufsize)
330 {
331 	union acpi_object in_params[4], *out_obj;
332 	struct acpi_object_list input;
333 	struct acpi_buffer cap = {
334 		.pointer = capbuf,
335 		.length = bufsize * sizeof(u32),
336 	};
337 	struct acpi_buffer output;
338 	u32 *retbuf, test;
339 	guid_t guid;
340 	int ret, i;
341 
342 	if (!capbuf || bufsize < 2 || guid_parse(uuid_str, &guid))
343 		return -EINVAL;
344 
345 	/* First evaluate _OSC with OSC_QUERY_ENABLE set. */
346 	capbuf[OSC_QUERY_DWORD] = OSC_QUERY_ENABLE;
347 
348 	ret = acpi_eval_osc(handle, &guid, rev, &cap, in_params, &output);
349 	if (ret)
350 		return ret;
351 
352 	out_obj = output.pointer;
353 	retbuf = (u32 *)out_obj->buffer.pointer;
354 
355 	if (acpi_osc_error_check(handle, &guid, rev, &cap, retbuf)) {
356 		ret = -ENODATA;
357 		goto out;
358 	}
359 
360 	/*
361 	 * Clear the feature bits in the capabilities buffer that have not been
362 	 * acknowledged and clear the return buffer.
363 	 */
364 	for (i = OSC_QUERY_DWORD + 1, test = 0; i < bufsize; i++) {
365 		capbuf[i] &= retbuf[i];
366 		test |= capbuf[i];
367 		retbuf[i] = 0;
368 	}
369 	/*
370 	 * If none of the feature bits have been acknowledged, there's nothing
371 	 * more to do.  capbuf[] contains a feature mask of all zeros.
372 	 */
373 	if (!test)
374 		goto out;
375 
376 	retbuf[OSC_QUERY_DWORD] = 0;
377 	/*
378 	 * Now evaluate _OSC again (directly) with OSC_QUERY_ENABLE clear and
379 	 * the updated input and output buffers used before.  Since the feature
380 	 * bits that were clear in the return buffer from the previous _OSC
381 	 * evaluation are also clear in the capabilities buffer now, this _OSC
382 	 * evaluation is not expected to fail.
383 	 */
384 	capbuf[OSC_QUERY_DWORD] = 0;
385 	/* Reuse in_params[] populated by acpi_eval_osc(). */
386 	input.pointer = in_params;
387 	input.count = 4;
388 
389 	if (ACPI_FAILURE(acpi_evaluate_object(handle, "_OSC", &input, &output))) {
390 		ret = -ENODATA;
391 		goto out;
392 	}
393 
394 	/*
395 	 * Clear the feature bits in capbuf[] that have not been acknowledged.
396 	 * After that, capbuf[] contains the resultant feature mask.
397 	 */
398 	for (i = OSC_QUERY_DWORD + 1; i < bufsize; i++)
399 		capbuf[i] &= retbuf[i];
400 
401 	if (retbuf[OSC_QUERY_DWORD] & OSC_ERROR_MASK) {
402 		/*
403 		 * Complain about the unexpected errors and print diagnostic
404 		 * information related to them.
405 		 */
406 		acpi_handle_err(handle, "_OSC: errors while processing control request\n");
407 		acpi_handle_err(handle, "_OSC: some features may be missing\n");
408 		acpi_osc_error_check(handle, &guid, rev, &cap, retbuf);
409 	}
410 
411 out:
412 	ACPI_FREE(out_obj);
413 	return ret;
414 }
415 
416 bool osc_sb_apei_support_acked;
417 
418 /*
419  * ACPI 6.0 Section 8.4.4.2 Idle State Coordination
420  * OSPM supports platform coordinated low power idle(LPI) states
421  */
422 bool osc_pc_lpi_support_confirmed;
423 EXPORT_SYMBOL_GPL(osc_pc_lpi_support_confirmed);
424 
425 /*
426  * ACPI 6.2 Section 6.2.11.2 'Platform-Wide OSPM Capabilities':
427  *   Starting with ACPI Specification 6.2, all _CPC registers can be in
428  *   PCC, System Memory, System IO, or Functional Fixed Hardware address
429  *   spaces. OSPM support for this more flexible register space scheme is
430  *   indicated by the “Flexible Address Space for CPPC Registers” _OSC bit.
431  *
432  * Otherwise (cf ACPI 6.1, s8.4.7.1.1.X), _CPC registers must be in:
433  * - PCC or Functional Fixed Hardware address space if defined
434  * - SystemMemory address space (NULL register) if not defined
435  */
436 bool osc_cpc_flexible_adr_space_confirmed;
437 EXPORT_SYMBOL_GPL(osc_cpc_flexible_adr_space_confirmed);
438 
439 /*
440  * ACPI 6.4 Operating System Capabilities for USB.
441  */
442 bool osc_sb_native_usb4_support_confirmed;
443 EXPORT_SYMBOL_GPL(osc_sb_native_usb4_support_confirmed);
444 
445 bool osc_sb_cppc2_support_acked;
446 
447 static void acpi_bus_osc_negotiate_platform_control(void)
448 {
449 	static const u8 sb_uuid_str[] = "0811B06E-4A27-44F9-8D60-3CBBC22E7B48";
450 	u32 capbuf[2], feature_mask;
451 	acpi_handle handle;
452 
453 	feature_mask = OSC_SB_PR3_SUPPORT | OSC_SB_HOTPLUG_OST_SUPPORT |
454 			OSC_SB_PCLPI_SUPPORT | OSC_SB_OVER_16_PSTATES_SUPPORT |
455 			OSC_SB_GED_SUPPORT | OSC_SB_IRQ_RESOURCE_SOURCE_SUPPORT;
456 
457 	if (IS_ENABLED(CONFIG_ARM64) || IS_ENABLED(CONFIG_X86))
458 		feature_mask |= OSC_SB_GENERIC_INITIATOR_SUPPORT;
459 
460 	if (IS_ENABLED(CONFIG_ACPI_CPPC_LIB)) {
461 		feature_mask |= OSC_SB_CPC_SUPPORT | OSC_SB_CPCV2_SUPPORT |
462 				OSC_SB_CPC_FLEXIBLE_ADR_SPACE;
463 		if (IS_ENABLED(CONFIG_SCHED_MC_PRIO))
464 			feature_mask |= OSC_SB_CPC_DIVERSE_HIGH_SUPPORT;
465 	}
466 
467 	if (IS_ENABLED(CONFIG_ACPI_PROCESSOR_AGGREGATOR))
468 		feature_mask |= OSC_SB_PAD_SUPPORT;
469 
470 	if (IS_ENABLED(CONFIG_ACPI_PROCESSOR))
471 		feature_mask |= OSC_SB_PPC_OST_SUPPORT;
472 
473 	if (IS_ENABLED(CONFIG_ACPI_THERMAL))
474 		feature_mask |= OSC_SB_FAST_THERMAL_SAMPLING_SUPPORT;
475 
476 	if (IS_ENABLED(CONFIG_ACPI_BATTERY))
477 		feature_mask |= OSC_SB_BATTERY_CHARGE_LIMITING_SUPPORT;
478 
479 	if (IS_ENABLED(CONFIG_ACPI_PRMT))
480 		feature_mask |= OSC_SB_PRM_SUPPORT;
481 
482 	if (IS_ENABLED(CONFIG_ACPI_FFH))
483 		feature_mask |= OSC_SB_FFH_OPR_SUPPORT;
484 
485 	if (IS_ENABLED(CONFIG_USB4))
486 		feature_mask |= OSC_SB_NATIVE_USB4_SUPPORT;
487 
488 	if (!ghes_disable)
489 		feature_mask |= OSC_SB_APEI_SUPPORT;
490 
491 	if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &handle)))
492 		return;
493 
494 	capbuf[OSC_SUPPORT_DWORD] = feature_mask;
495 
496 	acpi_handle_info(handle, "platform _OSC: OS support mask [%08x]\n", feature_mask);
497 
498 	if (acpi_osc_handshake(handle, sb_uuid_str, 1, capbuf, ARRAY_SIZE(capbuf)))
499 		return;
500 
501 	feature_mask = capbuf[OSC_SUPPORT_DWORD];
502 
503 	acpi_handle_info(handle, "platform _OSC: OS control mask [%08x]\n", feature_mask);
504 
505 	osc_sb_cppc2_support_acked = feature_mask & OSC_SB_CPCV2_SUPPORT;
506 	osc_sb_apei_support_acked = feature_mask & OSC_SB_APEI_SUPPORT;
507 	osc_pc_lpi_support_confirmed = feature_mask & OSC_SB_PCLPI_SUPPORT;
508 	osc_sb_native_usb4_support_confirmed = feature_mask & OSC_SB_NATIVE_USB4_SUPPORT;
509 	osc_cpc_flexible_adr_space_confirmed = feature_mask & OSC_SB_CPC_FLEXIBLE_ADR_SPACE;
510 }
511 
512 /*
513  * Native control of USB4 capabilities. If any of the tunneling bits is
514  * set it means OS is in control and we use software based connection
515  * manager.
516  */
517 u32 osc_sb_native_usb4_control;
518 EXPORT_SYMBOL_GPL(osc_sb_native_usb4_control);
519 
520 static void acpi_bus_decode_usb_osc(const char *msg, u32 bits)
521 {
522 	pr_info("%s USB3%c DisplayPort%c PCIe%c XDomain%c\n", msg,
523 	       (bits & OSC_USB_USB3_TUNNELING) ? '+' : '-',
524 	       (bits & OSC_USB_DP_TUNNELING) ? '+' : '-',
525 	       (bits & OSC_USB_PCIE_TUNNELING) ? '+' : '-',
526 	       (bits & OSC_USB_XDOMAIN) ? '+' : '-');
527 }
528 
529 static void acpi_bus_osc_negotiate_usb_control(void)
530 {
531 	static const u8 sb_usb_uuid_str[] = "23A0D13A-26AB-486C-9C5F-0FFA525A575A";
532 	u32 capbuf[3], control;
533 	acpi_handle handle;
534 
535 	if (!osc_sb_native_usb4_support_confirmed)
536 		return;
537 
538 	if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &handle)))
539 		return;
540 
541 	control = OSC_USB_USB3_TUNNELING | OSC_USB_DP_TUNNELING |
542 		  OSC_USB_PCIE_TUNNELING | OSC_USB_XDOMAIN;
543 
544 	capbuf[OSC_SUPPORT_DWORD] = 0;
545 	capbuf[OSC_CONTROL_DWORD] = control;
546 
547 	if (acpi_osc_handshake(handle, sb_usb_uuid_str, 1, capbuf, ARRAY_SIZE(capbuf)))
548 		return;
549 
550 	osc_sb_native_usb4_control = capbuf[OSC_CONTROL_DWORD];
551 
552 	acpi_bus_decode_usb_osc("USB4 _OSC: OS supports", control);
553 	acpi_bus_decode_usb_osc("USB4 _OSC: OS controls", osc_sb_native_usb4_control);
554 }
555 
556 /* --------------------------------------------------------------------------
557                              Notification Handling
558    -------------------------------------------------------------------------- */
559 
560 /**
561  * acpi_bus_notify - Global system-level (0x00-0x7F) notifications handler
562  * @handle: Target ACPI object.
563  * @type: Notification type.
564  * @data: Ignored.
565  *
566  * This only handles notifications related to device hotplug.
567  */
568 static void acpi_bus_notify(acpi_handle handle, u32 type, void *data)
569 {
570 	struct acpi_device *adev;
571 
572 	switch (type) {
573 	case ACPI_NOTIFY_BUS_CHECK:
574 		acpi_handle_debug(handle, "ACPI_NOTIFY_BUS_CHECK event\n");
575 		break;
576 
577 	case ACPI_NOTIFY_DEVICE_CHECK:
578 		acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_CHECK event\n");
579 		break;
580 
581 	case ACPI_NOTIFY_DEVICE_WAKE:
582 		acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_WAKE event\n");
583 		return;
584 
585 	case ACPI_NOTIFY_EJECT_REQUEST:
586 		acpi_handle_debug(handle, "ACPI_NOTIFY_EJECT_REQUEST event\n");
587 		break;
588 
589 	case ACPI_NOTIFY_DEVICE_CHECK_LIGHT:
590 		acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_CHECK_LIGHT event\n");
591 		/* TBD: Exactly what does 'light' mean? */
592 		return;
593 
594 	case ACPI_NOTIFY_FREQUENCY_MISMATCH:
595 		acpi_handle_err(handle, "Device cannot be configured due "
596 				"to a frequency mismatch\n");
597 		return;
598 
599 	case ACPI_NOTIFY_BUS_MODE_MISMATCH:
600 		acpi_handle_err(handle, "Device cannot be configured due "
601 				"to a bus mode mismatch\n");
602 		return;
603 
604 	case ACPI_NOTIFY_POWER_FAULT:
605 		acpi_handle_err(handle, "Device has suffered a power fault\n");
606 		return;
607 
608 	default:
609 		acpi_handle_debug(handle, "Unknown event type 0x%x\n", type);
610 		return;
611 	}
612 
613 	adev = acpi_get_acpi_dev(handle);
614 
615 	if (adev && ACPI_SUCCESS(acpi_hotplug_schedule(adev, type)))
616 		return;
617 
618 	acpi_put_acpi_dev(adev);
619 
620 	acpi_evaluate_ost(handle, type, ACPI_OST_SC_NON_SPECIFIC_FAILURE, NULL);
621 }
622 
623 static void acpi_notify_device(acpi_handle handle, u32 event, void *data)
624 {
625 	struct acpi_device *device = data;
626 	struct acpi_driver *acpi_drv = to_acpi_driver(device->dev.driver);
627 
628 	acpi_drv->ops.notify(device, event);
629 }
630 
631 static int acpi_device_install_notify_handler(struct acpi_device *device,
632 					      struct acpi_driver *acpi_drv)
633 {
634 	u32 type = acpi_drv->flags & ACPI_DRIVER_ALL_NOTIFY_EVENTS ?
635 				ACPI_ALL_NOTIFY : ACPI_DEVICE_NOTIFY;
636 	acpi_status status;
637 
638 	status = acpi_install_notify_handler(device->handle, type,
639 					     acpi_notify_device, device);
640 	if (ACPI_FAILURE(status))
641 		return -EINVAL;
642 
643 	return 0;
644 }
645 
646 static void acpi_device_remove_notify_handler(struct acpi_device *device,
647 					      struct acpi_driver *acpi_drv)
648 {
649 	u32 type = acpi_drv->flags & ACPI_DRIVER_ALL_NOTIFY_EVENTS ?
650 				ACPI_ALL_NOTIFY : ACPI_DEVICE_NOTIFY;
651 
652 	acpi_remove_notify_handler(device->handle, type,
653 				   acpi_notify_device);
654 
655 	acpi_os_wait_events_complete();
656 }
657 
658 int acpi_dev_install_notify_handler(struct acpi_device *adev,
659 				    u32 handler_type,
660 				    acpi_notify_handler handler, void *context)
661 {
662 	acpi_status status;
663 
664 	status = acpi_install_notify_handler(adev->handle, handler_type,
665 					     handler, context);
666 	if (ACPI_FAILURE(status))
667 		return -ENODEV;
668 
669 	return 0;
670 }
671 EXPORT_SYMBOL_GPL(acpi_dev_install_notify_handler);
672 
673 void acpi_dev_remove_notify_handler(struct acpi_device *adev,
674 				    u32 handler_type,
675 				    acpi_notify_handler handler)
676 {
677 	acpi_remove_notify_handler(adev->handle, handler_type, handler);
678 	acpi_os_wait_events_complete();
679 }
680 EXPORT_SYMBOL_GPL(acpi_dev_remove_notify_handler);
681 
682 struct acpi_notify_handler_devres {
683 	struct acpi_device *adev;
684 	acpi_notify_handler handler;
685 	u32 handler_type;
686 };
687 
688 static void devm_acpi_notify_handler_release(struct device *dev, void *res)
689 {
690 	struct acpi_notify_handler_devres *dr = res;
691 
692 	acpi_dev_remove_notify_handler(dr->adev, dr->handler_type, dr->handler);
693 }
694 
695 /**
696  * devm_acpi_install_notify_handler - Install an ACPI notify handler for a
697  *				      managed device
698  * @dev: Device to install a notify handler for
699  * @handler_type: Type of the notify handler
700  * @handler: Handler function to install
701  * @context: Data passed back to the handler function
702  *
703  * This function performs the same function as acpi_dev_install_notify_handler()
704  * called for the ACPI companion of @dev with the same @handler_type, @handler,
705  * and @context arguments, but the ACPI notify handler installed by it will be
706  * automatically removed on driver detach.
707  *
708  * Callers should ensure that all resources used by @handler have been allocated
709  * prior to invoking this function, in which case those resources should be
710  * devres-managed so that they won't be released before the notify handler
711  * removal.  Otherwise, special synchronization between @handler and the
712  * management of those resources is required.
713  *
714  * When the request fails, an error message is printed.  Don't add extra error
715  * messages at the call sites.
716  *
717  * Return: 0 on success or a negative error number.
718  */
719 int devm_acpi_install_notify_handler(struct device *dev, u32 handler_type,
720 				     acpi_notify_handler handler, void *context)
721 {
722 	struct acpi_notify_handler_devres *dr;
723 	struct acpi_device *adev;
724 	int ret;
725 
726 	adev = ACPI_COMPANION(dev);
727 	if (!adev)
728 		return dev_err_probe(dev, -ENODEV, "No ACPI companion\n");
729 
730 	dr = devres_alloc(devm_acpi_notify_handler_release, sizeof(*dr), GFP_KERNEL);
731 	if (!dr)
732 		return -ENOMEM;
733 
734 	ret = acpi_dev_install_notify_handler(adev, handler_type, handler, context);
735 	if (ret) {
736 		devres_free(dr);
737 		return dev_err_probe(dev, ret, "Failed to install an ACPI notify handler\n");
738 	}
739 
740 	dr->adev = adev;
741 	dr->handler = handler;
742 	dr->handler_type = handler_type;
743 	devres_add(dev, dr);
744 
745 	return 0;
746 }
747 EXPORT_SYMBOL_GPL(devm_acpi_install_notify_handler);
748 
749 /* Handle events targeting \_SB device (at present only graceful shutdown) */
750 
751 #define ACPI_SB_NOTIFY_SHUTDOWN_REQUEST 0x81
752 #define ACPI_SB_INDICATE_INTERVAL	10000
753 
754 static void sb_notify_work(struct work_struct *dummy)
755 {
756 	acpi_handle sb_handle;
757 
758 	orderly_poweroff(true);
759 
760 	/*
761 	 * After initiating graceful shutdown, the ACPI spec requires OSPM
762 	 * to evaluate _OST method once every 10seconds to indicate that
763 	 * the shutdown is in progress
764 	 */
765 	acpi_get_handle(NULL, "\\_SB", &sb_handle);
766 	while (1) {
767 		pr_info("Graceful shutdown in progress.\n");
768 		acpi_evaluate_ost(sb_handle, ACPI_OST_EC_OSPM_SHUTDOWN,
769 				ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS, NULL);
770 		msleep(ACPI_SB_INDICATE_INTERVAL);
771 	}
772 }
773 
774 static void acpi_sb_notify(acpi_handle handle, u32 event, void *data)
775 {
776 	static DECLARE_WORK(acpi_sb_work, sb_notify_work);
777 
778 	if (event == ACPI_SB_NOTIFY_SHUTDOWN_REQUEST) {
779 		if (!work_busy(&acpi_sb_work))
780 			schedule_work(&acpi_sb_work);
781 	} else {
782 		pr_warn("event %x is not supported by \\_SB device\n", event);
783 	}
784 }
785 
786 static int __init acpi_setup_sb_notify_handler(void)
787 {
788 	acpi_handle sb_handle;
789 
790 	if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &sb_handle)))
791 		return -ENXIO;
792 
793 	if (ACPI_FAILURE(acpi_install_notify_handler(sb_handle, ACPI_DEVICE_NOTIFY,
794 						acpi_sb_notify, NULL)))
795 		return -EINVAL;
796 
797 	return 0;
798 }
799 
800 /* --------------------------------------------------------------------------
801                              Device Matching
802    -------------------------------------------------------------------------- */
803 
804 /**
805  * acpi_get_first_physical_node - Get first physical node of an ACPI device
806  * @adev:	ACPI device in question
807  *
808  * Return: First physical node of ACPI device @adev
809  */
810 struct device *acpi_get_first_physical_node(struct acpi_device *adev)
811 {
812 	struct mutex *physical_node_lock = &adev->physical_node_lock;
813 	struct device *phys_dev;
814 
815 	mutex_lock(physical_node_lock);
816 	if (list_empty(&adev->physical_node_list)) {
817 		phys_dev = NULL;
818 	} else {
819 		const struct acpi_device_physical_node *node;
820 
821 		node = list_first_entry(&adev->physical_node_list,
822 					struct acpi_device_physical_node, node);
823 
824 		phys_dev = node->dev;
825 	}
826 	mutex_unlock(physical_node_lock);
827 	return phys_dev;
828 }
829 EXPORT_SYMBOL_GPL(acpi_get_first_physical_node);
830 
831 static struct acpi_device *acpi_primary_dev_companion(struct acpi_device *adev,
832 						      const struct device *dev)
833 {
834 	const struct device *phys_dev = acpi_get_first_physical_node(adev);
835 
836 	return phys_dev && phys_dev == dev ? adev : NULL;
837 }
838 
839 /**
840  * acpi_device_is_first_physical_node - Is given dev first physical node
841  * @adev: ACPI companion device
842  * @dev: Physical device to check
843  *
844  * Function checks if given @dev is the first physical devices attached to
845  * the ACPI companion device. This distinction is needed in some cases
846  * where the same companion device is shared between many physical devices.
847  *
848  * Note that the caller have to provide valid @adev pointer.
849  */
850 bool acpi_device_is_first_physical_node(struct acpi_device *adev,
851 					const struct device *dev)
852 {
853 	return !!acpi_primary_dev_companion(adev, dev);
854 }
855 
856 /*
857  * acpi_companion_match() - Can we match via ACPI companion device
858  * @dev: Device in question
859  *
860  * Check if the given device has an ACPI companion and if that companion has
861  * a valid list of PNP IDs, and if the device is the first (primary) physical
862  * device associated with it.  Return the companion pointer if that's the case
863  * or NULL otherwise.
864  *
865  * If multiple physical devices are attached to a single ACPI companion, we need
866  * to be careful.  The usage scenario for this kind of relationship is that all
867  * of the physical devices in question use resources provided by the ACPI
868  * companion.  A typical case is an MFD device where all the sub-devices share
869  * the parent's ACPI companion.  In such cases we can only allow the primary
870  * (first) physical device to be matched with the help of the companion's PNP
871  * IDs.
872  *
873  * Additional physical devices sharing the ACPI companion can still use
874  * resources available from it but they will be matched normally using functions
875  * provided by their bus types (and analogously for their modalias).
876  */
877 const struct acpi_device *acpi_companion_match(const struct device *dev)
878 {
879 	struct acpi_device *adev;
880 
881 	adev = ACPI_COMPANION(dev);
882 	if (!adev)
883 		return NULL;
884 
885 	if (list_empty(&adev->pnp.ids))
886 		return NULL;
887 
888 	return acpi_primary_dev_companion(adev, dev);
889 }
890 
891 /**
892  * acpi_of_match_device - Match device object using the "compatible" property.
893  * @adev: ACPI device object to match.
894  * @of_match_table: List of device IDs to match against.
895  * @of_id: OF ID if matched
896  *
897  * If @dev has an ACPI companion which has ACPI_DT_NAMESPACE_HID in its list of
898  * identifiers and a _DSD object with the "compatible" property, use that
899  * property to match against the given list of identifiers.
900  */
901 bool acpi_of_match_device(const struct acpi_device *adev,
902 			  const struct of_device_id *of_match_table,
903 			  const struct of_device_id **of_id)
904 {
905 	const union acpi_object *of_compatible, *obj;
906 	int i, nval;
907 
908 	if (!adev)
909 		return false;
910 
911 	of_compatible = adev->data.of_compatible;
912 	if (!of_match_table || !of_compatible)
913 		return false;
914 
915 	if (of_compatible->type == ACPI_TYPE_PACKAGE) {
916 		nval = of_compatible->package.count;
917 		obj = of_compatible->package.elements;
918 	} else { /* Must be ACPI_TYPE_STRING. */
919 		nval = 1;
920 		obj = of_compatible;
921 	}
922 	/* Now we can look for the driver DT compatible strings */
923 	for (i = 0; i < nval; i++, obj++) {
924 		const struct of_device_id *id;
925 
926 		for (id = of_match_table; id->compatible[0]; id++)
927 			if (!strcasecmp(obj->string.pointer, id->compatible)) {
928 				if (of_id)
929 					*of_id = id;
930 				return true;
931 			}
932 	}
933 
934 	return false;
935 }
936 
937 static bool acpi_of_modalias(struct acpi_device *adev,
938 			     char *modalias, size_t len)
939 {
940 	const union acpi_object *of_compatible;
941 	const union acpi_object *obj;
942 	const char *str, *chr;
943 
944 	of_compatible = adev->data.of_compatible;
945 	if (!of_compatible)
946 		return false;
947 
948 	if (of_compatible->type == ACPI_TYPE_PACKAGE)
949 		obj = of_compatible->package.elements;
950 	else /* Must be ACPI_TYPE_STRING. */
951 		obj = of_compatible;
952 
953 	str = obj->string.pointer;
954 	chr = strchr(str, ',');
955 	strscpy(modalias, chr ? chr + 1 : str, len);
956 
957 	return true;
958 }
959 
960 /**
961  * acpi_set_modalias - Set modalias using "compatible" property or supplied ID
962  * @adev:	ACPI device object to match
963  * @default_id:	ID string to use as default if no compatible string found
964  * @modalias:   Pointer to buffer that modalias value will be copied into
965  * @len:	Length of modalias buffer
966  *
967  * This is a counterpart of of_alias_from_compatible() for struct acpi_device
968  * objects. If there is a compatible string for @adev, it will be copied to
969  * @modalias with the vendor prefix stripped; otherwise, @default_id will be
970  * used.
971  */
972 void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
973 		       char *modalias, size_t len)
974 {
975 	if (!acpi_of_modalias(adev, modalias, len))
976 		strscpy(modalias, default_id, len);
977 }
978 EXPORT_SYMBOL_GPL(acpi_set_modalias);
979 
980 static bool __acpi_match_device_cls(const struct acpi_device_id *id,
981 				    struct acpi_hardware_id *hwid)
982 {
983 	int i, msk, byte_shift;
984 	char buf[3];
985 
986 	if (!id->cls)
987 		return false;
988 
989 	/* Apply class-code bitmask, before checking each class-code byte */
990 	for (i = 1; i <= 3; i++) {
991 		byte_shift = 8 * (3 - i);
992 		msk = (id->cls_msk >> byte_shift) & 0xFF;
993 		if (!msk)
994 			continue;
995 
996 		sprintf(buf, "%02x", (id->cls >> byte_shift) & msk);
997 		if (strncmp(buf, &hwid->id[(i - 1) * 2], 2))
998 			return false;
999 	}
1000 	return true;
1001 }
1002 
1003 static bool __acpi_match_device(const struct acpi_device *device,
1004 				const struct acpi_device_id *acpi_ids,
1005 				const struct of_device_id *of_ids,
1006 				const struct acpi_device_id **acpi_id,
1007 				const struct of_device_id **of_id)
1008 {
1009 	const struct acpi_device_id *id;
1010 	struct acpi_hardware_id *hwid;
1011 
1012 	/*
1013 	 * If the device is not present, it is unnecessary to load device
1014 	 * driver for it.
1015 	 */
1016 	if (!device || !device->status.present)
1017 		return false;
1018 
1019 	list_for_each_entry(hwid, &device->pnp.ids, list) {
1020 		/* First, check the ACPI/PNP IDs provided by the caller. */
1021 		if (acpi_ids) {
1022 			for (id = acpi_ids; id->id[0] || id->cls; id++) {
1023 				if (id->id[0] && !strcmp((char *)id->id, hwid->id))
1024 					goto out_acpi_match;
1025 				if (id->cls && __acpi_match_device_cls(id, hwid))
1026 					goto out_acpi_match;
1027 			}
1028 		}
1029 
1030 		/*
1031 		 * Next, check ACPI_DT_NAMESPACE_HID and try to match the
1032 		 * "compatible" property if found.
1033 		 */
1034 		if (!strcmp(ACPI_DT_NAMESPACE_HID, hwid->id))
1035 			return acpi_of_match_device(device, of_ids, of_id);
1036 	}
1037 	return false;
1038 
1039 out_acpi_match:
1040 	if (acpi_id)
1041 		*acpi_id = id;
1042 	return true;
1043 }
1044 
1045 /**
1046  * acpi_match_acpi_device - Match an ACPI device against a given list of ACPI IDs
1047  * @ids: Array of struct acpi_device_id objects to match against.
1048  * @adev: The ACPI device pointer to match.
1049  *
1050  * Match the ACPI device @adev against a given list of ACPI IDs @ids.
1051  *
1052  * Return:
1053  * a pointer to the first matching ACPI ID on success or %NULL on failure.
1054  */
1055 const struct acpi_device_id *acpi_match_acpi_device(const struct acpi_device_id *ids,
1056 						    const struct acpi_device *adev)
1057 {
1058 	const struct acpi_device_id *id = NULL;
1059 
1060 	__acpi_match_device(adev, ids, NULL, &id, NULL);
1061 	return id;
1062 }
1063 EXPORT_SYMBOL_GPL(acpi_match_acpi_device);
1064 
1065 /**
1066  * acpi_match_device - Match a struct device against a given list of ACPI IDs
1067  * @ids: Array of struct acpi_device_id object to match against.
1068  * @dev: The device structure to match.
1069  *
1070  * Check if @dev has a valid ACPI handle and if there is a struct acpi_device
1071  * object for that handle and use that object to match against a given list of
1072  * device IDs.
1073  *
1074  * Return a pointer to the first matching ID on success or %NULL on failure.
1075  */
1076 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
1077 					       const struct device *dev)
1078 {
1079 	return acpi_match_acpi_device(ids, acpi_companion_match(dev));
1080 }
1081 EXPORT_SYMBOL_GPL(acpi_match_device);
1082 
1083 const void *acpi_device_get_match_data(const struct device *dev)
1084 {
1085 	const struct acpi_device_id *acpi_ids = dev->driver->acpi_match_table;
1086 	const struct of_device_id *of_ids = dev->driver->of_match_table;
1087 	const struct acpi_device *adev = acpi_companion_match(dev);
1088 	const struct acpi_device_id *acpi_id = NULL;
1089 	const struct of_device_id *of_id = NULL;
1090 
1091 	if (!__acpi_match_device(adev, acpi_ids, of_ids, &acpi_id, &of_id))
1092 		return NULL;
1093 
1094 	if (acpi_id)
1095 		return (const void *)acpi_id->driver_data;
1096 
1097 	if (of_id)
1098 		return of_id->data;
1099 
1100 	return NULL;
1101 }
1102 EXPORT_SYMBOL_GPL(acpi_device_get_match_data);
1103 
1104 int acpi_match_device_ids(struct acpi_device *device,
1105 			  const struct acpi_device_id *ids)
1106 {
1107 	return __acpi_match_device(device, ids, NULL, NULL, NULL) ? 0 : -ENOENT;
1108 }
1109 EXPORT_SYMBOL(acpi_match_device_ids);
1110 
1111 bool acpi_driver_match_device(struct device *dev,
1112 			      const struct device_driver *drv)
1113 {
1114 	const struct acpi_device_id *acpi_ids = drv->acpi_match_table;
1115 	const struct of_device_id *of_ids = drv->of_match_table;
1116 
1117 	if (!acpi_ids)
1118 		return acpi_of_match_device(ACPI_COMPANION(dev), of_ids, NULL);
1119 
1120 	return __acpi_match_device(acpi_companion_match(dev), acpi_ids, of_ids, NULL, NULL);
1121 }
1122 EXPORT_SYMBOL_GPL(acpi_driver_match_device);
1123 
1124 /* --------------------------------------------------------------------------
1125                               ACPI Driver Management
1126    -------------------------------------------------------------------------- */
1127 
1128 /**
1129  * __acpi_bus_register_driver - register a driver with the ACPI bus
1130  * @driver: driver being registered
1131  * @owner: owning module/driver
1132  *
1133  * Registers a driver with the ACPI bus.  Searches the namespace for all
1134  * devices that match the driver's criteria and binds.  Returns zero for
1135  * success or a negative error status for failure.
1136  */
1137 int __acpi_bus_register_driver(struct acpi_driver *driver, struct module *owner)
1138 {
1139 	if (acpi_disabled)
1140 		return -ENODEV;
1141 	driver->drv.name = driver->name;
1142 	driver->drv.bus = &acpi_bus_type;
1143 	driver->drv.owner = owner;
1144 
1145 	return driver_register(&driver->drv);
1146 }
1147 
1148 EXPORT_SYMBOL(__acpi_bus_register_driver);
1149 
1150 /**
1151  * acpi_bus_unregister_driver - unregisters a driver with the ACPI bus
1152  * @driver: driver to unregister
1153  *
1154  * Unregisters a driver with the ACPI bus.  Searches the namespace for all
1155  * devices that match the driver's criteria and unbinds.
1156  */
1157 void acpi_bus_unregister_driver(struct acpi_driver *driver)
1158 {
1159 	driver_unregister(&driver->drv);
1160 }
1161 
1162 EXPORT_SYMBOL(acpi_bus_unregister_driver);
1163 
1164 /* --------------------------------------------------------------------------
1165                               ACPI Bus operations
1166    -------------------------------------------------------------------------- */
1167 
1168 static int acpi_bus_match(struct device *dev, const struct device_driver *drv)
1169 {
1170 	struct acpi_device *acpi_dev = to_acpi_device(dev);
1171 	const struct acpi_driver *acpi_drv = to_acpi_driver(drv);
1172 
1173 	return acpi_dev->flags.match_driver
1174 		&& !acpi_match_device_ids(acpi_dev, acpi_drv->ids);
1175 }
1176 
1177 static int acpi_device_uevent(const struct device *dev, struct kobj_uevent_env *env)
1178 {
1179 	return __acpi_device_uevent_modalias(to_acpi_device(dev), env);
1180 }
1181 
1182 static int acpi_device_probe(struct device *dev)
1183 {
1184 	struct acpi_device *acpi_dev = to_acpi_device(dev);
1185 	struct acpi_driver *acpi_drv = to_acpi_driver(dev->driver);
1186 	int ret;
1187 
1188 	if (acpi_dev->handler && !acpi_is_pnp_device(acpi_dev))
1189 		return -EINVAL;
1190 
1191 	if (!acpi_drv->ops.add)
1192 		return -ENOSYS;
1193 
1194 	ret = acpi_drv->ops.add(acpi_dev);
1195 	if (ret) {
1196 		acpi_dev->driver_data = NULL;
1197 		return ret;
1198 	}
1199 
1200 	pr_debug("Driver [%s] successfully bound to device [%s]\n",
1201 		 acpi_drv->name, acpi_dev->pnp.bus_id);
1202 
1203 	if (acpi_drv->ops.notify) {
1204 		ret = acpi_device_install_notify_handler(acpi_dev, acpi_drv);
1205 		if (ret) {
1206 			if (acpi_drv->ops.remove)
1207 				acpi_drv->ops.remove(acpi_dev);
1208 
1209 			acpi_dev->driver_data = NULL;
1210 			return ret;
1211 		}
1212 	}
1213 
1214 	pr_debug("Found driver [%s] for device [%s]\n", acpi_drv->name,
1215 		 acpi_dev->pnp.bus_id);
1216 
1217 	get_device(dev);
1218 	return 0;
1219 }
1220 
1221 static void acpi_device_remove(struct device *dev)
1222 {
1223 	struct acpi_device *acpi_dev = to_acpi_device(dev);
1224 	struct acpi_driver *acpi_drv = to_acpi_driver(dev->driver);
1225 
1226 	if (acpi_drv->ops.notify)
1227 		acpi_device_remove_notify_handler(acpi_dev, acpi_drv);
1228 
1229 	if (acpi_drv->ops.remove)
1230 		acpi_drv->ops.remove(acpi_dev);
1231 
1232 	acpi_dev->driver_data = NULL;
1233 
1234 	put_device(dev);
1235 }
1236 
1237 const struct bus_type acpi_bus_type = {
1238 	.name		= "acpi",
1239 	.match		= acpi_bus_match,
1240 	.probe		= acpi_device_probe,
1241 	.remove		= acpi_device_remove,
1242 	.uevent		= acpi_device_uevent,
1243 };
1244 
1245 int acpi_bus_for_each_dev(int (*fn)(struct device *, void *), void *data)
1246 {
1247 	return bus_for_each_dev(&acpi_bus_type, NULL, data, fn);
1248 }
1249 EXPORT_SYMBOL_GPL(acpi_bus_for_each_dev);
1250 
1251 struct acpi_dev_walk_context {
1252 	int (*fn)(struct acpi_device *, void *);
1253 	void *data;
1254 };
1255 
1256 static int acpi_dev_for_one_check(struct device *dev, void *context)
1257 {
1258 	struct acpi_dev_walk_context *adwc = context;
1259 
1260 	if (dev->bus != &acpi_bus_type)
1261 		return 0;
1262 
1263 	return adwc->fn(to_acpi_device(dev), adwc->data);
1264 }
1265 EXPORT_SYMBOL_GPL(acpi_dev_for_each_child);
1266 
1267 int acpi_dev_for_each_child(struct acpi_device *adev,
1268 			    int (*fn)(struct acpi_device *, void *), void *data)
1269 {
1270 	struct acpi_dev_walk_context adwc = {
1271 		.fn = fn,
1272 		.data = data,
1273 	};
1274 
1275 	return device_for_each_child(&adev->dev, &adwc, acpi_dev_for_one_check);
1276 }
1277 
1278 int acpi_dev_for_each_child_reverse(struct acpi_device *adev,
1279 				    int (*fn)(struct acpi_device *, void *),
1280 				    void *data)
1281 {
1282 	struct acpi_dev_walk_context adwc = {
1283 		.fn = fn,
1284 		.data = data,
1285 	};
1286 
1287 	return device_for_each_child_reverse(&adev->dev, &adwc, acpi_dev_for_one_check);
1288 }
1289 
1290 /* --------------------------------------------------------------------------
1291                              Initialization/Cleanup
1292    -------------------------------------------------------------------------- */
1293 
1294 static int __init acpi_bus_init_irq(void)
1295 {
1296 	acpi_status status;
1297 	char *message = NULL;
1298 
1299 
1300 	/*
1301 	 * Let the system know what interrupt model we are using by
1302 	 * evaluating the \_PIC object, if exists.
1303 	 */
1304 
1305 	switch (acpi_irq_model) {
1306 	case ACPI_IRQ_MODEL_PIC:
1307 		message = "PIC";
1308 		break;
1309 	case ACPI_IRQ_MODEL_IOAPIC:
1310 		message = "IOAPIC";
1311 		break;
1312 	case ACPI_IRQ_MODEL_IOSAPIC:
1313 		message = "IOSAPIC";
1314 		break;
1315 	case ACPI_IRQ_MODEL_GIC:
1316 		message = "GIC";
1317 		break;
1318 	case ACPI_IRQ_MODEL_GIC_V5:
1319 		message = "GICv5";
1320 		break;
1321 	case ACPI_IRQ_MODEL_PLATFORM:
1322 		message = "platform specific model";
1323 		break;
1324 	case ACPI_IRQ_MODEL_LPIC:
1325 		message = "LPIC";
1326 		break;
1327 	case ACPI_IRQ_MODEL_RINTC:
1328 		message = "RINTC";
1329 		break;
1330 	default:
1331 		pr_info("Unknown interrupt routing model\n");
1332 		return -ENODEV;
1333 	}
1334 
1335 	pr_info("Using %s for interrupt routing\n", message);
1336 
1337 	status = acpi_execute_simple_method(NULL, "\\_PIC", acpi_irq_model);
1338 	if (ACPI_FAILURE(status) && (status != AE_NOT_FOUND)) {
1339 		pr_info("_PIC evaluation failed: %s\n", acpi_format_exception(status));
1340 		return -ENODEV;
1341 	}
1342 
1343 	return 0;
1344 }
1345 
1346 /**
1347  * acpi_early_init - Initialize ACPICA and populate the ACPI namespace.
1348  *
1349  * The ACPI tables are accessible after this, but the handling of events has not
1350  * been initialized and the global lock is not available yet, so AML should not
1351  * be executed at this point.
1352  *
1353  * Doing this before switching the EFI runtime services to virtual mode allows
1354  * the EfiBootServices memory to be freed slightly earlier on boot.
1355  */
1356 void __init acpi_early_init(void)
1357 {
1358 	acpi_status status;
1359 
1360 	if (acpi_disabled)
1361 		return;
1362 
1363 	pr_info("Core revision %08x\n", ACPI_CA_VERSION);
1364 
1365 	/* enable workarounds, unless strict ACPI spec. compliance */
1366 	if (!acpi_strict)
1367 		acpi_gbl_enable_interpreter_slack = TRUE;
1368 
1369 	acpi_permanent_mmap = true;
1370 
1371 #ifdef CONFIG_X86
1372 	/*
1373 	 * If the machine falls into the DMI check table,
1374 	 * DSDT will be copied to memory.
1375 	 * Note that calling dmi_check_system() here on other architectures
1376 	 * would not be OK because only x86 initializes dmi early enough.
1377 	 * Thankfully only x86 systems need such quirks for now.
1378 	 */
1379 	dmi_check_system(dsdt_dmi_table);
1380 #endif
1381 
1382 	status = acpi_reallocate_root_table();
1383 	if (ACPI_FAILURE(status)) {
1384 		pr_err("Unable to reallocate ACPI tables\n");
1385 		goto error0;
1386 	}
1387 
1388 	status = acpi_initialize_subsystem();
1389 	if (ACPI_FAILURE(status)) {
1390 		pr_err("Unable to initialize the ACPI Interpreter\n");
1391 		goto error0;
1392 	}
1393 
1394 #ifdef CONFIG_X86
1395 	if (!acpi_ioapic) {
1396 		/* compatible (0) means level (3) */
1397 		if (!(acpi_sci_flags & ACPI_MADT_TRIGGER_MASK)) {
1398 			acpi_sci_flags &= ~ACPI_MADT_TRIGGER_MASK;
1399 			acpi_sci_flags |= ACPI_MADT_TRIGGER_LEVEL;
1400 		}
1401 		/* Set PIC-mode SCI trigger type */
1402 		acpi_pic_sci_set_trigger(acpi_gbl_FADT.sci_interrupt,
1403 					 (acpi_sci_flags & ACPI_MADT_TRIGGER_MASK) >> 2);
1404 	} else {
1405 		/*
1406 		 * now that acpi_gbl_FADT is initialized,
1407 		 * update it with result from INT_SRC_OVR parsing
1408 		 */
1409 		acpi_gbl_FADT.sci_interrupt = acpi_sci_override_gsi;
1410 	}
1411 #endif
1412 	return;
1413 
1414  error0:
1415 	disable_acpi();
1416 }
1417 
1418 /**
1419  * acpi_subsystem_init - Finalize the early initialization of ACPI.
1420  *
1421  * Switch over the platform to the ACPI mode (if possible).
1422  *
1423  * Doing this too early is generally unsafe, but at the same time it needs to be
1424  * done before all things that really depend on ACPI.  The right spot appears to
1425  * be before finalizing the EFI initialization.
1426  */
1427 void __init acpi_subsystem_init(void)
1428 {
1429 	acpi_status status;
1430 
1431 	if (acpi_disabled)
1432 		return;
1433 
1434 	status = acpi_enable_subsystem(~ACPI_NO_ACPI_ENABLE);
1435 	if (ACPI_FAILURE(status)) {
1436 		pr_err("Unable to enable ACPI\n");
1437 		disable_acpi();
1438 	} else {
1439 		/*
1440 		 * If the system is using ACPI then we can be reasonably
1441 		 * confident that any regulators are managed by the firmware
1442 		 * so tell the regulator core it has everything it needs to
1443 		 * know.
1444 		 */
1445 		regulator_has_full_constraints();
1446 	}
1447 }
1448 
1449 static acpi_status acpi_bus_table_handler(u32 event, void *table, void *context)
1450 {
1451 	if (event == ACPI_TABLE_EVENT_LOAD)
1452 		acpi_scan_table_notify();
1453 
1454 	return acpi_sysfs_table_handler(event, table, context);
1455 }
1456 
1457 static int __init acpi_bus_init(void)
1458 {
1459 	int result;
1460 	acpi_status status;
1461 
1462 	acpi_os_initialize1();
1463 
1464 	status = acpi_load_tables();
1465 	if (ACPI_FAILURE(status)) {
1466 		pr_err("Unable to load the System Description Tables\n");
1467 		goto error1;
1468 	}
1469 
1470 	/*
1471 	 * ACPI 2.0 requires the EC driver to be loaded and work before the EC
1472 	 * device is found in the namespace.
1473 	 *
1474 	 * This is accomplished by looking for the ECDT table and getting the EC
1475 	 * parameters out of that.
1476 	 *
1477 	 * Do that before calling acpi_initialize_objects() which may trigger EC
1478 	 * address space accesses.
1479 	 */
1480 	acpi_ec_ecdt_probe();
1481 
1482 	status = acpi_enable_subsystem(ACPI_NO_ACPI_ENABLE);
1483 	if (ACPI_FAILURE(status)) {
1484 		pr_err("Unable to start the ACPI Interpreter\n");
1485 		goto error1;
1486 	}
1487 
1488 	status = acpi_initialize_objects(ACPI_FULL_INITIALIZATION);
1489 	if (ACPI_FAILURE(status)) {
1490 		pr_err("Unable to initialize ACPI objects\n");
1491 		goto error1;
1492 	}
1493 
1494 	/*
1495 	 * _OSC method may exist in module level code,
1496 	 * so it must be run after ACPI_FULL_INITIALIZATION
1497 	 */
1498 	acpi_bus_osc_negotiate_platform_control();
1499 	acpi_bus_osc_negotiate_usb_control();
1500 
1501 	/*
1502 	 * _PDC control method may load dynamic SSDT tables,
1503 	 * and we need to install the table handler before that.
1504 	 */
1505 	status = acpi_install_table_handler(acpi_bus_table_handler, NULL);
1506 
1507 	acpi_sysfs_init();
1508 
1509 	acpi_early_processor_control_setup();
1510 
1511 	/*
1512 	 * Maybe EC region is required at bus_scan/acpi_get_devices. So it
1513 	 * is necessary to enable it as early as possible.
1514 	 */
1515 	acpi_ec_dsdt_probe();
1516 
1517 	pr_info("Interpreter enabled\n");
1518 
1519 	/* Initialize sleep structures */
1520 	acpi_sleep_init();
1521 
1522 	/*
1523 	 * Get the system interrupt model and evaluate \_PIC.
1524 	 */
1525 	result = acpi_bus_init_irq();
1526 	if (result)
1527 		goto error1;
1528 
1529 	/*
1530 	 * Register for all standard device notifications.
1531 	 */
1532 	status =
1533 	    acpi_install_notify_handler(ACPI_ROOT_OBJECT, ACPI_SYSTEM_NOTIFY,
1534 					&acpi_bus_notify, NULL);
1535 	if (ACPI_FAILURE(status)) {
1536 		pr_err("Unable to register for system notifications\n");
1537 		goto error1;
1538 	}
1539 
1540 	/*
1541 	 * Create the top ACPI proc directory
1542 	 */
1543 	acpi_root_dir = proc_mkdir(ACPI_BUS_FILE_ROOT, NULL);
1544 
1545 	result = bus_register(&acpi_bus_type);
1546 	if (!result)
1547 		return 0;
1548 
1549 	/* Mimic structured exception handling */
1550       error1:
1551 	acpi_terminate();
1552 	return -ENODEV;
1553 }
1554 
1555 struct kobject *acpi_kobj;
1556 EXPORT_SYMBOL_GPL(acpi_kobj);
1557 
1558 void __weak __init acpi_arch_init(void) { }
1559 
1560 static int __init acpi_init(void)
1561 {
1562 	int result;
1563 
1564 	if (acpi_disabled) {
1565 		pr_info("Interpreter disabled.\n");
1566 		return -ENODEV;
1567 	}
1568 
1569 	acpi_kobj = kobject_create_and_add("acpi", firmware_kobj);
1570 	if (!acpi_kobj) {
1571 		pr_err("Failed to register kobject\n");
1572 		return -ENOMEM;
1573 	}
1574 
1575 	init_prmt();
1576 	acpi_init_pcc();
1577 	result = acpi_bus_init();
1578 	if (result) {
1579 		kobject_put(acpi_kobj);
1580 		disable_acpi();
1581 		return result;
1582 	}
1583 	acpi_init_ffh();
1584 
1585 	pci_mmcfg_late_init();
1586 	acpi_viot_early_init();
1587 	acpi_hest_init();
1588 	acpi_ghes_init();
1589 	acpi_arch_init();
1590 	acpi_scan_init();
1591 	acpi_ec_init();
1592 	acpi_debugfs_init();
1593 	acpi_sleep_proc_init();
1594 	acpi_wakeup_device_init();
1595 	acpi_debugger_init();
1596 	acpi_setup_sb_notify_handler();
1597 	acpi_viot_init();
1598 	return 0;
1599 }
1600 
1601 subsys_initcall(acpi_init);
1602