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