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