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 status;
 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                 status = AE_ERROR;
 159                 goto out;
 160         }
 161
 162         status = __acpi_query_osc(flags, osc_data, &dummy);
 163 out:
 164         mutex_unlock(&pci_acpi_lock);
 165         return status;
 166 }
 167
 168 /**
 169  * __pci_osc_support_set - register OS support to Firmware
 170  * @flags: OS support bits
 171  * @hid: hardware ID
 172  *
 173  * Update OS support fields and doing a _OSC Query to obtain an update
 174  * from Firmware on supported control bits.
 175  **/
 176 acpi_status __pci_osc_support_set(u32 flags, const char *hid)
 177 {
 178         if (!(flags & OSC_SUPPORT_MASKS))
 179                 return AE_TYPE;
 180
 181         acpi_get_devices(hid, acpi_query_osc,
 182                          (void *)(unsigned long)flags, NULL);
 183         return AE_OK;
 184 }
 185
 186 /**
 187  * pci_osc_control_set - commit requested control to Firmware
 188  * @handle: acpi_handle for the target ACPI object
 189  * @flags: driver's requested control bits
 190  *
 191  * Attempt to take control from Firmware on requested control bits.
 192  **/
 193 acpi_status pci_osc_control_set(acpi_handle handle, u32 flags)
 194 {
 195         acpi_status status;
 196         u32 ctrlset, control_set, result;
 197         acpi_handle tmp;
 198         struct acpi_osc_data *osc_data;
 199         struct acpi_osc_args osc_args;
 200
 201         status = acpi_get_handle(handle, "_OSC", &tmp);
 202         if (ACPI_FAILURE(status))
 203                 return status;
 204
 205         mutex_lock(&pci_acpi_lock);
 206         osc_data = acpi_get_osc_data(handle);
 207         if (!osc_data) {
 208                 printk(KERN_ERR "acpi osc data array is full\n");
 209                 status = AE_ERROR;
 210                 goto out;
 211         }
 212
 213         ctrlset = (flags & OSC_CONTROL_MASKS);
 214         if (!ctrlset) {
 215                 status = AE_TYPE;
 216                 goto out;
 217         }
 218
 219         status = __acpi_query_osc(osc_data->support_set, osc_data, &result);
 220         if (ACPI_FAILURE(status))
 221                 goto out;
 222
 223         if ((result & ctrlset) != ctrlset) {
 224                 status = AE_SUPPORT;
 225                 goto out;
 226         }
 227
 228         control_set = osc_data->control_set | ctrlset;
 229         osc_args.capbuf[OSC_QUERY_TYPE] = 0;
 230         osc_args.capbuf[OSC_SUPPORT_TYPE] = osc_data->support_set;
 231         osc_args.capbuf[OSC_CONTROL_TYPE] = control_set;
 232         status = acpi_run_osc(handle, &osc_args);
 233         if (ACPI_SUCCESS(status))
 234                 osc_data->control_set = control_set;
 235 out:
 236         mutex_unlock(&pci_acpi_lock);
 237         return status;
 238 }
 239 EXPORT_SYMBOL(pci_osc_control_set);
 240
 241 /*
 242  * _SxD returns the D-state with the highest power
 243  * (lowest D-state number) supported in the S-state "x".
 244  *
 245  * If the devices does not have a _PRW
 246  * (Power Resources for Wake) supporting system wakeup from "x"
 247  * then the OS is free to choose a lower power (higher number
 248  * D-state) than the return value from _SxD.
 249  *
 250  * But if _PRW is enabled at S-state "x", the OS
 251  * must not choose a power lower than _SxD --
 252  * unless the device has an _SxW method specifying
 253  * the lowest power (highest D-state number) the device
 254  * may enter while still able to wake the system.
 255  *
 256  * ie. depending on global OS policy:
 257  *
 258  * if (_PRW at S-state x)
 259  *      choose from highest power _SxD to lowest power _SxW
 260  * else // no _PRW at S-state x
 261  *      choose highest power _SxD or any lower power
 262  */
 263
 264 static pci_power_t acpi_pci_choose_state(struct pci_dev *pdev)
 265 {
 266         int acpi_state;
 267
 268         acpi_state = acpi_pm_device_sleep_state(&pdev->dev, NULL);
 269         if (acpi_state < 0)
 270                 return PCI_POWER_ERROR;
 271
 272         switch (acpi_state) {
 273         case ACPI_STATE_D0:
 274                 return PCI_D0;
 275         case ACPI_STATE_D1:
 276                 return PCI_D1;
 277         case ACPI_STATE_D2:
 278                 return PCI_D2;
 279         case ACPI_STATE_D3:
 280                 return PCI_D3hot;
 281         }
 282         return PCI_POWER_ERROR;
 283 }
 284
 285 static bool acpi_pci_power_manageable(struct pci_dev *dev)
 286 {
 287         acpi_handle handle = DEVICE_ACPI_HANDLE(&dev->dev);
 288
 289         return handle ? acpi_bus_power_manageable(handle) : false;
 290 }
 291
 292 static int acpi_pci_set_power_state(struct pci_dev *dev, pci_power_t state)
 293 {
 294         acpi_handle handle = DEVICE_ACPI_HANDLE(&dev->dev);
 295         acpi_handle tmp;
 296         static const u8 state_conv[] = {
 297                 [PCI_D0] = ACPI_STATE_D0,
 298                 [PCI_D1] = ACPI_STATE_D1,
 299                 [PCI_D2] = ACPI_STATE_D2,
 300                 [PCI_D3hot] = ACPI_STATE_D3,
 301                 [PCI_D3cold] = ACPI_STATE_D3
 302         };
 303         int error = -EINVAL;
 304
 305         /* If the ACPI device has _EJ0, ignore the device */
 306         if (!handle || ACPI_SUCCESS(acpi_get_handle(handle, "_EJ0", &tmp)))
 307                 return -ENODEV;
 308
 309         switch (state) {
 310         case PCI_D0:
 311         case PCI_D1:
 312         case PCI_D2:
 313         case PCI_D3hot:
 314         case PCI_D3cold:
 315                 error = acpi_bus_set_power(handle, state_conv[state]);
 316         }
 317
 318         if (!error)
 319                 dev_printk(KERN_INFO, &dev->dev,
 320                                 "power state changed by ACPI to D%d\n", state);
 321
 322         return error;
 323 }
 324
 325 static bool acpi_pci_can_wakeup(struct pci_dev *dev)
 326 {
 327         acpi_handle handle = DEVICE_ACPI_HANDLE(&dev->dev);
 328
 329         return handle ? acpi_bus_can_wakeup(handle) : false;
 330 }
 331
 332 static int acpi_pci_sleep_wake(struct pci_dev *dev, bool enable)
 333 {
 334         int error = acpi_pm_device_sleep_wake(&dev->dev, enable);
 335
 336         if (!error)
 337                 dev_printk(KERN_INFO, &dev->dev,
 338                                 "wake-up capability %s by ACPI\n",
 339                                 enable ? "enabled" : "disabled");
 340         return error;
 341 }
 342
 343 static struct pci_platform_pm_ops acpi_pci_platform_pm = {
 344         .is_manageable = acpi_pci_power_manageable,
 345         .set_state = acpi_pci_set_power_state,
 346         .choose_state = acpi_pci_choose_state,
 347         .can_wakeup = acpi_pci_can_wakeup,
 348         .sleep_wake = acpi_pci_sleep_wake,
 349 };
 350
 351 /* ACPI bus type */
 352 static int acpi_pci_find_device(struct device *dev, acpi_handle *handle)
 353 {
 354         struct pci_dev * pci_dev;
 355         acpi_integer    addr;
 356
 357         pci_dev = to_pci_dev(dev);
 358         /* Please ref to ACPI spec for the syntax of _ADR */
 359         addr = (PCI_SLOT(pci_dev->devfn) << 16) | PCI_FUNC(pci_dev->devfn);
 360         *handle = acpi_get_child(DEVICE_ACPI_HANDLE(dev->parent), addr);
 361         if (!*handle)
 362                 return -ENODEV;
 363         return 0;
 364 }
 365
 366 static int acpi_pci_find_root_bridge(struct device *dev, acpi_handle *handle)
 367 {
 368         int num;
 369         unsigned int seg, bus;
 370
 371         /*
 372          * The string should be the same as root bridge's name
 373          * Please look at 'pci_scan_bus_parented'
 374          */
 375         num = sscanf(dev->bus_id, "pci%04x:%02x", &seg, &bus);
 376         if (num != 2)
 377                 return -ENODEV;
 378         *handle = acpi_get_pci_rootbridge_handle(seg, bus);
 379         if (!*handle)
 380                 return -ENODEV;
 381         return 0;
 382 }
 383
 384 static struct acpi_bus_type acpi_pci_bus = {
 385         .bus = &pci_bus_type,
 386         .find_device = acpi_pci_find_device,
 387         .find_bridge = acpi_pci_find_root_bridge,
 388 };
 389
 390 static int __init acpi_pci_init(void)
 391 {
 392         int ret;
 393
 394         if (acpi_gbl_FADT.boot_flags & BAF_MSI_NOT_SUPPORTED) {
 395                 printk(KERN_INFO"ACPI FADT declares the system doesn't support MSI, so disable it\n");
 396                 pci_no_msi();
 397         }
 398
 399         if (acpi_gbl_FADT.boot_flags & BAF_PCIE_ASPM_CONTROL) {
 400                 printk(KERN_INFO"ACPI FADT declares the system doesn't support PCIe ASPM, so disable it\n");
 401                 pcie_no_aspm();
 402         }
 403
 404         ret = register_acpi_bus_type(&acpi_pci_bus);
 405         if (ret)
 406                 return 0;
 407         pci_set_platform_pm(&acpi_pci_platform_pm);
 408         return 0;
 409 }
 410 arch_initcall(acpi_pci_init);