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