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