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