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