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