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