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