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