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