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