drivers/acpi/bus.c

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