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