drivers/pci/pci-acpi.c

   1 /*
   2  * File:        pci-acpi.c
   3  * Purpose:     Provide PCI support in ACPI
   4  *
   5  * Copyright (C) 2005 David Shaohua Li <shaohua.li@intel.com>
   6  * Copyright (C) 2004 Tom Long Nguyen <tom.l.nguyen@intel.com>
   7  * Copyright (C) 2004 Intel Corp.
   8  */
   9
  10 #include <linux/delay.h>
  11 #include <linux/init.h>
  12 #include <linux/pci.h>
  13 #include <linux/module.h>
  14 #include <linux/pci-aspm.h>
  15 #include <acpi/acpi.h>
  16 #include <acpi/acnamesp.h>
  17 #include <acpi/acresrc.h>
  18 #include <acpi/acpi_bus.h>
  19
  20 #include <linux/pci-acpi.h>
  21 #include "pci.h"
  22
  23 struct acpi_osc_data {
  24         acpi_handle handle;
  25         u32 support_set;
  26         u32 control_set;
  27         int is_queried;
  28         u32 query_result;
  29         struct list_head sibiling;
  30 };
  31 static LIST_HEAD(acpi_osc_data_list);
  32
  33 struct acpi_osc_args {
  34         u32 capbuf[3];
  35         u32 query_result;
  36 };
  37
  38 static DEFINE_MUTEX(pci_acpi_lock);
  39
  40 static struct acpi_osc_data *acpi_get_osc_data(acpi_handle handle)
  41 {
  42         struct acpi_osc_data *data;
  43
  44         list_for_each_entry(data, &acpi_osc_data_list, sibiling) {
  45                 if (data->handle == handle)
  46                         return data;
  47         }
  48         data = kzalloc(sizeof(*data), GFP_KERNEL);
  49         if (!data)
  50                 return NULL;
  51         INIT_LIST_HEAD(&data->sibiling);
  52         data->handle = handle;
  53         list_add_tail(&data->sibiling, &acpi_osc_data_list);
  54         return data;
  55 }
  56
  57 static u8 OSC_UUID[16] = {0x5B, 0x4D, 0xDB, 0x33, 0xF7, 0x1F, 0x1C, 0x40,
  58                           0x96, 0x57, 0x74, 0x41, 0xC0, 0x3D, 0xD7, 0x66};
  59
  60 static acpi_status acpi_run_osc(acpi_handle handle,
  61                                 struct acpi_osc_args *osc_args)
  62 {
  63         acpi_status status;
  64         struct acpi_object_list input;
  65         union acpi_object in_params[4];
  66         struct acpi_buffer output = {ACPI_ALLOCATE_BUFFER, NULL};
  67         union acpi_object *out_obj;
  68         u32 osc_dw0, flags = osc_args->capbuf[OSC_QUERY_TYPE];
  69
  70         /* Setting up input parameters */
  71         input.count = 4;
  72         input.pointer = in_params;
  73         in_params[0].type               = ACPI_TYPE_BUFFER;
  74         in_params[0].buffer.length      = 16;
  75         in_params[0].buffer.pointer     = OSC_UUID;
  76         in_params[1].type               = ACPI_TYPE_INTEGER;
  77         in_params[1].integer.value      = 1;
  78         in_params[2].type               = ACPI_TYPE_INTEGER;
  79         in_params[2].integer.value      = 3;
  80         in_params[3].type               = ACPI_TYPE_BUFFER;
  81         in_params[3].buffer.length      = 12;
  82         in_params[3].buffer.pointer     = (u8 *)osc_args->capbuf;
  83
  84         status = acpi_evaluate_object(handle, "_OSC", &input, &output);
  85         if (ACPI_FAILURE(status))
  86                 return status;
  87
  88         out_obj = output.pointer;
  89         if (out_obj->type != ACPI_TYPE_BUFFER) {
  90                 printk(KERN_DEBUG "Evaluate _OSC returns wrong type\n");
  91                 status = AE_TYPE;
  92                 goto out_kfree;
  93         }
  94         osc_dw0 = *((u32 *)out_obj->buffer.pointer);
  95         if (osc_dw0) {
  96                 if (osc_dw0 & OSC_REQUEST_ERROR)
  97                         printk(KERN_DEBUG "_OSC request fails\n");
  98                 if (osc_dw0 & OSC_INVALID_UUID_ERROR)
  99                         printk(KERN_DEBUG "_OSC invalid UUID\n");
 100                 if (osc_dw0 & OSC_INVALID_REVISION_ERROR)
 101                         printk(KERN_DEBUG "_OSC invalid revision\n");
 102                 if (osc_dw0 & OSC_CAPABILITIES_MASK_ERROR) {
 103                         if (flags & OSC_QUERY_ENABLE)
 104                                 goto out_success;
 105                         printk(KERN_DEBUG "_OSC FW not grant req. control\n");
 106                         status = AE_SUPPORT;
 107                         goto out_kfree;
 108                 }
 109                 status = AE_ERROR;
 110                 goto out_kfree;
 111         }
 112 out_success:
 113         if (flags & OSC_QUERY_ENABLE)
 114                 osc_args->query_result =
 115                         *((u32 *)(out_obj->buffer.pointer + 8));
 116         status = AE_OK;
 117
 118 out_kfree:
 119         kfree(output.pointer);
 120         return status;
 121 }
 122
 123 static acpi_status __acpi_query_osc(u32 flags, struct acpi_osc_data *osc_data)
 124 {
 125         acpi_status status;
 126         u32 support_set;
 127         struct acpi_osc_args osc_args;
 128
 129         /* do _OSC query for all possible controls */
 130         support_set = osc_data->support_set | (flags & OSC_SUPPORT_MASKS);
 131         osc_args.capbuf[OSC_QUERY_TYPE] = OSC_QUERY_ENABLE;
 132         osc_args.capbuf[OSC_SUPPORT_TYPE] = support_set;
 133         osc_args.capbuf[OSC_CONTROL_TYPE] = OSC_CONTROL_MASKS;
 134
 135         status = acpi_run_osc(osc_data->handle, &osc_args);
 136         if (ACPI_SUCCESS(status)) {
 137                 osc_data->support_set = support_set;
 138                 osc_data->query_result = osc_args.query_result;
 139                 osc_data->is_queried = 1;
 140         }
 141
 142         return status;
 143 }
 144
 145 static acpi_status acpi_query_osc(acpi_handle handle,
 146                                   u32 level, void *context, void **retval)
 147 {
 148         acpi_status status;
 149         struct acpi_osc_data *osc_data;
 150         u32 flags = (unsigned long)context;
 151         acpi_handle tmp;
 152
 153         status = acpi_get_handle(handle, "_OSC", &tmp);
 154         if (ACPI_FAILURE(status))
 155                 return status;
 156
 157         mutex_lock(&pci_acpi_lock);
 158         osc_data = acpi_get_osc_data(handle);
 159         if (!osc_data) {
 160                 printk(KERN_ERR "acpi osc data array is full\n");
 161                 status = AE_ERROR;
 162                 goto out;
 163         }
 164
 165         status = __acpi_query_osc(flags, osc_data);
 166 out:
 167         mutex_unlock(&pci_acpi_lock);
 168         return status;
 169 }
 170
 171 /**
 172  * __pci_osc_support_set - register OS support to Firmware
 173  * @flags: OS support bits
 174  * @hid: hardware ID
 175  *
 176  * Update OS support fields and doing a _OSC Query to obtain an update
 177  * from Firmware on supported control bits.
 178  **/
 179 acpi_status __pci_osc_support_set(u32 flags, const char *hid)
 180 {
 181         if (!(flags & OSC_SUPPORT_MASKS))
 182                 return AE_TYPE;
 183
 184         acpi_get_devices(hid, acpi_query_osc,
 185                          (void *)(unsigned long)flags, NULL);
 186         return AE_OK;
 187 }
 188
 189 /**
 190  * pci_osc_control_set - commit requested control to Firmware
 191  * @handle: acpi_handle for the target ACPI object
 192  * @flags: driver's requested control bits
 193  *
 194  * Attempt to take control from Firmware on requested control bits.
 195  **/
 196 acpi_status pci_osc_control_set(acpi_handle handle, u32 flags)
 197 {
 198         acpi_status status;
 199         u32 ctrlset, control_set;
 200         acpi_handle tmp;
 201         struct acpi_osc_data *osc_data;
 202         struct acpi_osc_args osc_args;
 203
 204         status = acpi_get_handle(handle, "_OSC", &tmp);
 205         if (ACPI_FAILURE(status))
 206                 return status;
 207
 208         mutex_lock(&pci_acpi_lock);
 209         osc_data = acpi_get_osc_data(handle);
 210         if (!osc_data) {
 211                 printk(KERN_ERR "acpi osc data array is full\n");
 212                 status = AE_ERROR;
 213                 goto out;
 214         }
 215
 216         ctrlset = (flags & OSC_CONTROL_MASKS);
 217         if (!ctrlset) {
 218                 status = AE_TYPE;
 219                 goto out;
 220         }
 221
 222         if (!osc_data->is_queried) {
 223                 status = __acpi_query_osc(osc_data->support_set, osc_data);
 224                 if (ACPI_FAILURE(status))
 225                         goto out;
 226         }
 227
 228         if ((osc_data->query_result & ctrlset) != ctrlset) {
 229                 status = AE_SUPPORT;
 230                 goto out;
 231         }
 232
 233         control_set = osc_data->control_set | ctrlset;
 234         osc_args.capbuf[OSC_QUERY_TYPE] = 0;
 235         osc_args.capbuf[OSC_SUPPORT_TYPE] = osc_data->support_set;
 236         osc_args.capbuf[OSC_CONTROL_TYPE] = control_set;
 237         status = acpi_run_osc(handle, &osc_args);
 238         if (ACPI_SUCCESS(status))
 239                 osc_data->control_set = control_set;
 240 out:
 241         mutex_unlock(&pci_acpi_lock);
 242         return status;
 243 }
 244 EXPORT_SYMBOL(pci_osc_control_set);
 245
 246 /*
 247  * _SxD returns the D-state with the highest power
 248  * (lowest D-state number) supported in the S-state "x".
 249  *
 250  * If the devices does not have a _PRW
 251  * (Power Resources for Wake) supporting system wakeup from "x"
 252  * then the OS is free to choose a lower power (higher number
 253  * D-state) than the return value from _SxD.
 254  *
 255  * But if _PRW is enabled at S-state "x", the OS
 256  * must not choose a power lower than _SxD --
 257  * unless the device has an _SxW method specifying
 258  * the lowest power (highest D-state number) the device
 259  * may enter while still able to wake the system.
 260  *
 261  * ie. depending on global OS policy:
 262  *
 263  * if (_PRW at S-state x)
 264  *      choose from highest power _SxD to lowest power _SxW
 265  * else // no _PRW at S-state x
 266  *      choose highest power _SxD or any lower power
 267  */
 268
 269 static pci_power_t acpi_pci_choose_state(struct pci_dev *pdev)
 270 {
 271         int acpi_state;
 272
 273         acpi_state = acpi_pm_device_sleep_state(&pdev->dev, NULL);
 274         if (acpi_state < 0)
 275                 return PCI_POWER_ERROR;
 276
 277         switch (acpi_state) {
 278         case ACPI_STATE_D0:
 279                 return PCI_D0;
 280         case ACPI_STATE_D1:
 281                 return PCI_D1;
 282         case ACPI_STATE_D2:
 283                 return PCI_D2;
 284         case ACPI_STATE_D3:
 285                 return PCI_D3hot;
 286         }
 287         return PCI_POWER_ERROR;
 288 }
 289
 290 static bool acpi_pci_power_manageable(struct pci_dev *dev)
 291 {
 292         acpi_handle handle = DEVICE_ACPI_HANDLE(&dev->dev);
 293
 294         return handle ? acpi_bus_power_manageable(handle) : false;
 295 }
 296
 297 static int acpi_pci_set_power_state(struct pci_dev *dev, pci_power_t state)
 298 {
 299         acpi_handle handle = DEVICE_ACPI_HANDLE(&dev->dev);
 300         acpi_handle tmp;
 301         static const u8 state_conv[] = {
 302                 [PCI_D0] = ACPI_STATE_D0,
 303                 [PCI_D1] = ACPI_STATE_D1,
 304                 [PCI_D2] = ACPI_STATE_D2,
 305                 [PCI_D3hot] = ACPI_STATE_D3,
 306                 [PCI_D3cold] = ACPI_STATE_D3
 307         };
 308         int error = -EINVAL;
 309
 310         /* If the ACPI device has _EJ0, ignore the device */
 311         if (!handle || ACPI_SUCCESS(acpi_get_handle(handle, "_EJ0", &tmp)))
 312                 return -ENODEV;
 313
 314         switch (state) {
 315         case PCI_D0:
 316         case PCI_D1:
 317         case PCI_D2:
 318         case PCI_D3hot:
 319         case PCI_D3cold:
 320                 error = acpi_bus_set_power(handle, state_conv[state]);
 321         }
 322
 323         if (!error)
 324                 dev_printk(KERN_INFO, &dev->dev,
 325                                 "power state changed by ACPI to D%d\n", state);
 326
 327         return error;
 328 }
 329
 330 static bool acpi_pci_can_wakeup(struct pci_dev *dev)
 331 {
 332         acpi_handle handle = DEVICE_ACPI_HANDLE(&dev->dev);
 333
 334         return handle ? acpi_bus_can_wakeup(handle) : false;
 335 }
 336
 337 static int acpi_pci_sleep_wake(struct pci_dev *dev, bool enable)
 338 {
 339         int error = acpi_pm_device_sleep_wake(&dev->dev, enable);
 340
 341         if (!error)
 342                 dev_printk(KERN_INFO, &dev->dev,
 343                                 "wake-up capability %s by ACPI\n",
 344                                 enable ? "enabled" : "disabled");
 345         return error;
 346 }
 347
 348 static struct pci_platform_pm_ops acpi_pci_platform_pm = {
 349         .is_manageable = acpi_pci_power_manageable,
 350         .set_state = acpi_pci_set_power_state,
 351         .choose_state = acpi_pci_choose_state,
 352         .can_wakeup = acpi_pci_can_wakeup,
 353         .sleep_wake = acpi_pci_sleep_wake,
 354 };
 355
 356 /* ACPI bus type */
 357 static int acpi_pci_find_device(struct device *dev, acpi_handle *handle)
 358 {
 359         struct pci_dev * pci_dev;
 360         acpi_integer    addr;
 361
 362         pci_dev = to_pci_dev(dev);
 363         /* Please ref to ACPI spec for the syntax of _ADR */
 364         addr = (PCI_SLOT(pci_dev->devfn) << 16) | PCI_FUNC(pci_dev->devfn);
 365         *handle = acpi_get_child(DEVICE_ACPI_HANDLE(dev->parent), addr);
 366         if (!*handle)
 367                 return -ENODEV;
 368         return 0;
 369 }
 370
 371 static int acpi_pci_find_root_bridge(struct device *dev, acpi_handle *handle)
 372 {
 373         int num;
 374         unsigned int seg, bus;
 375
 376         /*
 377          * The string should be the same as root bridge's name
 378          * Please look at 'pci_scan_bus_parented'
 379          */
 380         num = sscanf(dev->bus_id, "pci%04x:%02x", &seg, &bus);
 381         if (num != 2)
 382                 return -ENODEV;
 383         *handle = acpi_get_pci_rootbridge_handle(seg, bus);
 384         if (!*handle)
 385                 return -ENODEV;
 386         return 0;
 387 }
 388
 389 static struct acpi_bus_type acpi_pci_bus = {
 390         .bus = &pci_bus_type,
 391         .find_device = acpi_pci_find_device,
 392         .find_bridge = acpi_pci_find_root_bridge,
 393 };
 394
 395 static int __init acpi_pci_init(void)
 396 {
 397         int ret;
 398
 399         if (acpi_gbl_FADT.boot_flags & BAF_MSI_NOT_SUPPORTED) {
 400                 printk(KERN_INFO"ACPI FADT declares the system doesn't support MSI, so disable it\n");
 401                 pci_no_msi();
 402         }
 403
 404         if (acpi_gbl_FADT.boot_flags & BAF_PCIE_ASPM_CONTROL) {
 405                 printk(KERN_INFO"ACPI FADT declares the system doesn't support PCIe ASPM, so disable it\n");
 406                 pcie_no_aspm();
 407         }
 408
 409         ret = register_acpi_bus_type(&acpi_pci_bus);
 410         if (ret)
 411                 return 0;
 412         pci_set_platform_pm(&acpi_pci_platform_pm);
 413         return 0;
 414 }
 415 arch_initcall(acpi_pci_init);