ACPI / Button: Avoid disabling wakeup unnecessarily on remove
[linux-2.6.git] / drivers / acpi / pci_root.c
1 /*
2  *  pci_root.c - ACPI PCI Root Bridge Driver ($Revision: 40 $)
3  *
4  *  Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5  *  Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
6  *
7  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8  *
9  *  This program is free software; you can redistribute it and/or modify
10  *  it under the terms of the GNU General Public License as published by
11  *  the Free Software Foundation; either version 2 of the License, or (at
12  *  your option) any later version.
13  *
14  *  This program is distributed in the hope that it will be useful, but
15  *  WITHOUT ANY WARRANTY; without even the implied warranty of
16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  *  General Public License for more details.
18  *
19  *  You should have received a copy of the GNU General Public License along
20  *  with this program; if not, write to the Free Software Foundation, Inc.,
21  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
22  *
23  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24  */
25
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/init.h>
29 #include <linux/types.h>
30 #include <linux/spinlock.h>
31 #include <linux/pm.h>
32 #include <linux/pm_runtime.h>
33 #include <linux/pci.h>
34 #include <linux/pci-acpi.h>
35 #include <linux/acpi.h>
36 #include <linux/slab.h>
37 #include <acpi/acpi_bus.h>
38 #include <acpi/acpi_drivers.h>
39 #include <acpi/apei.h>
40
41 #define PREFIX "ACPI: "
42
43 #define _COMPONENT              ACPI_PCI_COMPONENT
44 ACPI_MODULE_NAME("pci_root");
45 #define ACPI_PCI_ROOT_CLASS             "pci_bridge"
46 #define ACPI_PCI_ROOT_DEVICE_NAME       "PCI Root Bridge"
47 static int acpi_pci_root_add(struct acpi_device *device);
48 static int acpi_pci_root_remove(struct acpi_device *device, int type);
49 static int acpi_pci_root_start(struct acpi_device *device);
50
51 #define ACPI_PCIE_REQ_SUPPORT (OSC_EXT_PCI_CONFIG_SUPPORT \
52                                 | OSC_ACTIVE_STATE_PWR_SUPPORT \
53                                 | OSC_CLOCK_PWR_CAPABILITY_SUPPORT \
54                                 | OSC_MSI_SUPPORT)
55
56 static const struct acpi_device_id root_device_ids[] = {
57         {"PNP0A03", 0},
58         {"", 0},
59 };
60 MODULE_DEVICE_TABLE(acpi, root_device_ids);
61
62 static struct acpi_driver acpi_pci_root_driver = {
63         .name = "pci_root",
64         .class = ACPI_PCI_ROOT_CLASS,
65         .ids = root_device_ids,
66         .ops = {
67                 .add = acpi_pci_root_add,
68                 .remove = acpi_pci_root_remove,
69                 .start = acpi_pci_root_start,
70                 },
71 };
72
73 static LIST_HEAD(acpi_pci_roots);
74
75 static struct acpi_pci_driver *sub_driver;
76 static DEFINE_MUTEX(osc_lock);
77
78 int acpi_pci_register_driver(struct acpi_pci_driver *driver)
79 {
80         int n = 0;
81         struct acpi_pci_root *root;
82
83         struct acpi_pci_driver **pptr = &sub_driver;
84         while (*pptr)
85                 pptr = &(*pptr)->next;
86         *pptr = driver;
87
88         if (!driver->add)
89                 return 0;
90
91         list_for_each_entry(root, &acpi_pci_roots, node) {
92                 driver->add(root->device->handle);
93                 n++;
94         }
95
96         return n;
97 }
98
99 EXPORT_SYMBOL(acpi_pci_register_driver);
100
101 void acpi_pci_unregister_driver(struct acpi_pci_driver *driver)
102 {
103         struct acpi_pci_root *root;
104
105         struct acpi_pci_driver **pptr = &sub_driver;
106         while (*pptr) {
107                 if (*pptr == driver)
108                         break;
109                 pptr = &(*pptr)->next;
110         }
111         BUG_ON(!*pptr);
112         *pptr = (*pptr)->next;
113
114         if (!driver->remove)
115                 return;
116
117         list_for_each_entry(root, &acpi_pci_roots, node)
118                 driver->remove(root->device->handle);
119 }
120
121 EXPORT_SYMBOL(acpi_pci_unregister_driver);
122
123 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int seg, unsigned int bus)
124 {
125         struct acpi_pci_root *root;
126         
127         list_for_each_entry(root, &acpi_pci_roots, node)
128                 if ((root->segment == (u16) seg) &&
129                     (root->secondary.start == (u16) bus))
130                         return root->device->handle;
131         return NULL;            
132 }
133
134 EXPORT_SYMBOL_GPL(acpi_get_pci_rootbridge_handle);
135
136 /**
137  * acpi_is_root_bridge - determine whether an ACPI CA node is a PCI root bridge
138  * @handle - the ACPI CA node in question.
139  *
140  * Note: we could make this API take a struct acpi_device * instead, but
141  * for now, it's more convenient to operate on an acpi_handle.
142  */
143 int acpi_is_root_bridge(acpi_handle handle)
144 {
145         int ret;
146         struct acpi_device *device;
147
148         ret = acpi_bus_get_device(handle, &device);
149         if (ret)
150                 return 0;
151
152         ret = acpi_match_device_ids(device, root_device_ids);
153         if (ret)
154                 return 0;
155         else
156                 return 1;
157 }
158 EXPORT_SYMBOL_GPL(acpi_is_root_bridge);
159
160 static acpi_status
161 get_root_bridge_busnr_callback(struct acpi_resource *resource, void *data)
162 {
163         struct resource *res = data;
164         struct acpi_resource_address64 address;
165
166         if (resource->type != ACPI_RESOURCE_TYPE_ADDRESS16 &&
167             resource->type != ACPI_RESOURCE_TYPE_ADDRESS32 &&
168             resource->type != ACPI_RESOURCE_TYPE_ADDRESS64)
169                 return AE_OK;
170
171         acpi_resource_to_address64(resource, &address);
172         if ((address.address_length > 0) &&
173             (address.resource_type == ACPI_BUS_NUMBER_RANGE)) {
174                 res->start = address.minimum;
175                 res->end = address.minimum + address.address_length - 1;
176         }
177
178         return AE_OK;
179 }
180
181 static acpi_status try_get_root_bridge_busnr(acpi_handle handle,
182                                              struct resource *res)
183 {
184         acpi_status status;
185
186         res->start = -1;
187         status =
188             acpi_walk_resources(handle, METHOD_NAME__CRS,
189                                 get_root_bridge_busnr_callback, res);
190         if (ACPI_FAILURE(status))
191                 return status;
192         if (res->start == -1)
193                 return AE_ERROR;
194         return AE_OK;
195 }
196
197 static void acpi_pci_bridge_scan(struct acpi_device *device)
198 {
199         int status;
200         struct acpi_device *child = NULL;
201
202         if (device->flags.bus_address)
203                 if (device->parent && device->parent->ops.bind) {
204                         status = device->parent->ops.bind(device);
205                         if (!status) {
206                                 list_for_each_entry(child, &device->children, node)
207                                         acpi_pci_bridge_scan(child);
208                         }
209                 }
210 }
211
212 static u8 pci_osc_uuid_str[] = "33DB4D5B-1FF7-401C-9657-7441C03DD766";
213
214 static acpi_status acpi_pci_run_osc(acpi_handle handle,
215                                     const u32 *capbuf, u32 *retval)
216 {
217         struct acpi_osc_context context = {
218                 .uuid_str = pci_osc_uuid_str,
219                 .rev = 1,
220                 .cap.length = 12,
221                 .cap.pointer = (void *)capbuf,
222         };
223         acpi_status status;
224
225         status = acpi_run_osc(handle, &context);
226         if (ACPI_SUCCESS(status)) {
227                 *retval = *((u32 *)(context.ret.pointer + 8));
228                 kfree(context.ret.pointer);
229         }
230         return status;
231 }
232
233 static acpi_status acpi_pci_query_osc(struct acpi_pci_root *root,
234                                         u32 support,
235                                         u32 *control)
236 {
237         acpi_status status;
238         u32 result, capbuf[3];
239
240         support &= OSC_PCI_SUPPORT_MASKS;
241         support |= root->osc_support_set;
242
243         capbuf[OSC_QUERY_TYPE] = OSC_QUERY_ENABLE;
244         capbuf[OSC_SUPPORT_TYPE] = support;
245         if (control) {
246                 *control &= OSC_PCI_CONTROL_MASKS;
247                 capbuf[OSC_CONTROL_TYPE] = *control | root->osc_control_set;
248         } else {
249                 /* Run _OSC query for all possible controls. */
250                 capbuf[OSC_CONTROL_TYPE] = OSC_PCI_CONTROL_MASKS;
251         }
252
253         status = acpi_pci_run_osc(root->device->handle, capbuf, &result);
254         if (ACPI_SUCCESS(status)) {
255                 root->osc_support_set = support;
256                 if (control)
257                         *control = result;
258         }
259         return status;
260 }
261
262 static acpi_status acpi_pci_osc_support(struct acpi_pci_root *root, u32 flags)
263 {
264         acpi_status status;
265         acpi_handle tmp;
266
267         status = acpi_get_handle(root->device->handle, "_OSC", &tmp);
268         if (ACPI_FAILURE(status))
269                 return status;
270         mutex_lock(&osc_lock);
271         status = acpi_pci_query_osc(root, flags, NULL);
272         mutex_unlock(&osc_lock);
273         return status;
274 }
275
276 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle)
277 {
278         struct acpi_pci_root *root;
279
280         list_for_each_entry(root, &acpi_pci_roots, node) {
281                 if (root->device->handle == handle)
282                         return root;
283         }
284         return NULL;
285 }
286 EXPORT_SYMBOL_GPL(acpi_pci_find_root);
287
288 struct acpi_handle_node {
289         struct list_head node;
290         acpi_handle handle;
291 };
292
293 /**
294  * acpi_get_pci_dev - convert ACPI CA handle to struct pci_dev
295  * @handle: the handle in question
296  *
297  * Given an ACPI CA handle, the desired PCI device is located in the
298  * list of PCI devices.
299  *
300  * If the device is found, its reference count is increased and this
301  * function returns a pointer to its data structure.  The caller must
302  * decrement the reference count by calling pci_dev_put().
303  * If no device is found, %NULL is returned.
304  */
305 struct pci_dev *acpi_get_pci_dev(acpi_handle handle)
306 {
307         int dev, fn;
308         unsigned long long adr;
309         acpi_status status;
310         acpi_handle phandle;
311         struct pci_bus *pbus;
312         struct pci_dev *pdev = NULL;
313         struct acpi_handle_node *node, *tmp;
314         struct acpi_pci_root *root;
315         LIST_HEAD(device_list);
316
317         /*
318          * Walk up the ACPI CA namespace until we reach a PCI root bridge.
319          */
320         phandle = handle;
321         while (!acpi_is_root_bridge(phandle)) {
322                 node = kzalloc(sizeof(struct acpi_handle_node), GFP_KERNEL);
323                 if (!node)
324                         goto out;
325
326                 INIT_LIST_HEAD(&node->node);
327                 node->handle = phandle;
328                 list_add(&node->node, &device_list);
329
330                 status = acpi_get_parent(phandle, &phandle);
331                 if (ACPI_FAILURE(status))
332                         goto out;
333         }
334
335         root = acpi_pci_find_root(phandle);
336         if (!root)
337                 goto out;
338
339         pbus = root->bus;
340
341         /*
342          * Now, walk back down the PCI device tree until we return to our
343          * original handle. Assumes that everything between the PCI root
344          * bridge and the device we're looking for must be a P2P bridge.
345          */
346         list_for_each_entry(node, &device_list, node) {
347                 acpi_handle hnd = node->handle;
348                 status = acpi_evaluate_integer(hnd, "_ADR", NULL, &adr);
349                 if (ACPI_FAILURE(status))
350                         goto out;
351                 dev = (adr >> 16) & 0xffff;
352                 fn  = adr & 0xffff;
353
354                 pdev = pci_get_slot(pbus, PCI_DEVFN(dev, fn));
355                 if (!pdev || hnd == handle)
356                         break;
357
358                 pbus = pdev->subordinate;
359                 pci_dev_put(pdev);
360
361                 /*
362                  * This function may be called for a non-PCI device that has a
363                  * PCI parent (eg. a disk under a PCI SATA controller).  In that
364                  * case pdev->subordinate will be NULL for the parent.
365                  */
366                 if (!pbus) {
367                         dev_dbg(&pdev->dev, "Not a PCI-to-PCI bridge\n");
368                         pdev = NULL;
369                         break;
370                 }
371         }
372 out:
373         list_for_each_entry_safe(node, tmp, &device_list, node)
374                 kfree(node);
375
376         return pdev;
377 }
378 EXPORT_SYMBOL_GPL(acpi_get_pci_dev);
379
380 /**
381  * acpi_pci_osc_control_set - Request control of PCI root _OSC features.
382  * @handle: ACPI handle of a PCI root bridge (or PCIe Root Complex).
383  * @mask: Mask of _OSC bits to request control of, place to store control mask.
384  * @req: Mask of _OSC bits the control of is essential to the caller.
385  *
386  * Run _OSC query for @mask and if that is successful, compare the returned
387  * mask of control bits with @req.  If all of the @req bits are set in the
388  * returned mask, run _OSC request for it.
389  *
390  * The variable at the @mask address may be modified regardless of whether or
391  * not the function returns success.  On success it will contain the mask of
392  * _OSC bits the BIOS has granted control of, but its contents are meaningless
393  * on failure.
394  **/
395 acpi_status acpi_pci_osc_control_set(acpi_handle handle, u32 *mask, u32 req)
396 {
397         struct acpi_pci_root *root;
398         acpi_status status;
399         u32 ctrl, capbuf[3];
400         acpi_handle tmp;
401
402         if (!mask)
403                 return AE_BAD_PARAMETER;
404
405         ctrl = *mask & OSC_PCI_CONTROL_MASKS;
406         if ((ctrl & req) != req)
407                 return AE_TYPE;
408
409         root = acpi_pci_find_root(handle);
410         if (!root)
411                 return AE_NOT_EXIST;
412
413         status = acpi_get_handle(handle, "_OSC", &tmp);
414         if (ACPI_FAILURE(status))
415                 return status;
416
417         mutex_lock(&osc_lock);
418
419         *mask = ctrl | root->osc_control_set;
420         /* No need to evaluate _OSC if the control was already granted. */
421         if ((root->osc_control_set & ctrl) == ctrl)
422                 goto out;
423
424         /* Need to check the available controls bits before requesting them. */
425         while (*mask) {
426                 status = acpi_pci_query_osc(root, root->osc_support_set, mask);
427                 if (ACPI_FAILURE(status))
428                         goto out;
429                 if (ctrl == *mask)
430                         break;
431                 ctrl = *mask;
432         }
433
434         if ((ctrl & req) != req) {
435                 status = AE_SUPPORT;
436                 goto out;
437         }
438
439         capbuf[OSC_QUERY_TYPE] = 0;
440         capbuf[OSC_SUPPORT_TYPE] = root->osc_support_set;
441         capbuf[OSC_CONTROL_TYPE] = ctrl;
442         status = acpi_pci_run_osc(handle, capbuf, mask);
443         if (ACPI_SUCCESS(status))
444                 root->osc_control_set = *mask;
445 out:
446         mutex_unlock(&osc_lock);
447         return status;
448 }
449 EXPORT_SYMBOL(acpi_pci_osc_control_set);
450
451 static int __devinit acpi_pci_root_add(struct acpi_device *device)
452 {
453         unsigned long long segment, bus;
454         acpi_status status;
455         int result;
456         struct acpi_pci_root *root;
457         acpi_handle handle;
458         struct acpi_device *child;
459         u32 flags, base_flags;
460
461         root = kzalloc(sizeof(struct acpi_pci_root), GFP_KERNEL);
462         if (!root)
463                 return -ENOMEM;
464
465         segment = 0;
466         status = acpi_evaluate_integer(device->handle, METHOD_NAME__SEG, NULL,
467                                        &segment);
468         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
469                 printk(KERN_ERR PREFIX "can't evaluate _SEG\n");
470                 result = -ENODEV;
471                 goto end;
472         }
473
474         /* Check _CRS first, then _BBN.  If no _BBN, default to zero. */
475         root->secondary.flags = IORESOURCE_BUS;
476         status = try_get_root_bridge_busnr(device->handle, &root->secondary);
477         if (ACPI_FAILURE(status)) {
478                 /*
479                  * We need both the start and end of the downstream bus range
480                  * to interpret _CBA (MMCONFIG base address), so it really is
481                  * supposed to be in _CRS.  If we don't find it there, all we
482                  * can do is assume [_BBN-0xFF] or [0-0xFF].
483                  */
484                 root->secondary.end = 0xFF;
485                 printk(KERN_WARNING FW_BUG PREFIX
486                        "no secondary bus range in _CRS\n");
487                 status = acpi_evaluate_integer(device->handle, METHOD_NAME__BBN,                                               NULL, &bus);
488                 if (ACPI_SUCCESS(status))
489                         root->secondary.start = bus;
490                 else if (status == AE_NOT_FOUND)
491                         root->secondary.start = 0;
492                 else {
493                         printk(KERN_ERR PREFIX "can't evaluate _BBN\n");
494                         result = -ENODEV;
495                         goto end;
496                 }
497         }
498
499         INIT_LIST_HEAD(&root->node);
500         root->device = device;
501         root->segment = segment & 0xFFFF;
502         strcpy(acpi_device_name(device), ACPI_PCI_ROOT_DEVICE_NAME);
503         strcpy(acpi_device_class(device), ACPI_PCI_ROOT_CLASS);
504         device->driver_data = root;
505
506         /*
507          * All supported architectures that use ACPI have support for
508          * PCI domains, so we indicate this in _OSC support capabilities.
509          */
510         flags = base_flags = OSC_PCI_SEGMENT_GROUPS_SUPPORT;
511         acpi_pci_osc_support(root, flags);
512
513         /*
514          * TBD: Need PCI interface for enumeration/configuration of roots.
515          */
516
517         /* TBD: Locking */
518         list_add_tail(&root->node, &acpi_pci_roots);
519
520         printk(KERN_INFO PREFIX "%s [%s] (domain %04x %pR)\n",
521                acpi_device_name(device), acpi_device_bid(device),
522                root->segment, &root->secondary);
523
524         /*
525          * Scan the Root Bridge
526          * --------------------
527          * Must do this prior to any attempt to bind the root device, as the
528          * PCI namespace does not get created until this call is made (and 
529          * thus the root bridge's pci_dev does not exist).
530          */
531         root->bus = pci_acpi_scan_root(root);
532         if (!root->bus) {
533                 printk(KERN_ERR PREFIX
534                             "Bus %04x:%02x not present in PCI namespace\n",
535                             root->segment, (unsigned int)root->secondary.start);
536                 result = -ENODEV;
537                 goto end;
538         }
539
540         /*
541          * Attach ACPI-PCI Context
542          * -----------------------
543          * Thus binding the ACPI and PCI devices.
544          */
545         result = acpi_pci_bind_root(device);
546         if (result)
547                 goto end;
548
549         /*
550          * PCI Routing Table
551          * -----------------
552          * Evaluate and parse _PRT, if exists.
553          */
554         status = acpi_get_handle(device->handle, METHOD_NAME__PRT, &handle);
555         if (ACPI_SUCCESS(status))
556                 result = acpi_pci_irq_add_prt(device->handle, root->bus);
557
558         /*
559          * Scan and bind all _ADR-Based Devices
560          */
561         list_for_each_entry(child, &device->children, node)
562                 acpi_pci_bridge_scan(child);
563
564         /* Indicate support for various _OSC capabilities. */
565         if (pci_ext_cfg_avail(root->bus->self))
566                 flags |= OSC_EXT_PCI_CONFIG_SUPPORT;
567         if (pcie_aspm_enabled())
568                 flags |= OSC_ACTIVE_STATE_PWR_SUPPORT |
569                         OSC_CLOCK_PWR_CAPABILITY_SUPPORT;
570         if (pci_msi_enabled())
571                 flags |= OSC_MSI_SUPPORT;
572         if (flags != base_flags)
573                 acpi_pci_osc_support(root, flags);
574
575         if (!pcie_ports_disabled
576             && (flags & ACPI_PCIE_REQ_SUPPORT) == ACPI_PCIE_REQ_SUPPORT) {
577                 flags = OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL
578                         | OSC_PCI_EXPRESS_NATIVE_HP_CONTROL
579                         | OSC_PCI_EXPRESS_PME_CONTROL;
580
581                 if (pci_aer_available()) {
582                         if (aer_acpi_firmware_first())
583                                 dev_dbg(root->bus->bridge,
584                                         "PCIe errors handled by BIOS.\n");
585                         else
586                                 flags |= OSC_PCI_EXPRESS_AER_CONTROL;
587                 }
588
589                 dev_info(root->bus->bridge,
590                         "Requesting ACPI _OSC control (0x%02x)\n", flags);
591
592                 status = acpi_pci_osc_control_set(device->handle, &flags,
593                                         OSC_PCI_EXPRESS_CAP_STRUCTURE_CONTROL);
594                 if (ACPI_SUCCESS(status))
595                         dev_info(root->bus->bridge,
596                                 "ACPI _OSC control (0x%02x) granted\n", flags);
597                 else
598                         dev_dbg(root->bus->bridge,
599                                 "ACPI _OSC request failed (code %d)\n", status);
600         }
601
602         pci_acpi_add_bus_pm_notifier(device, root->bus);
603         if (device->wakeup.flags.run_wake)
604                 device_set_run_wake(root->bus->bridge, true);
605
606         return 0;
607
608 end:
609         if (!list_empty(&root->node))
610                 list_del(&root->node);
611         kfree(root);
612         return result;
613 }
614
615 static int acpi_pci_root_start(struct acpi_device *device)
616 {
617         struct acpi_pci_root *root = acpi_driver_data(device);
618
619         pci_bus_add_devices(root->bus);
620         return 0;
621 }
622
623 static int acpi_pci_root_remove(struct acpi_device *device, int type)
624 {
625         struct acpi_pci_root *root = acpi_driver_data(device);
626
627         device_set_run_wake(root->bus->bridge, false);
628         pci_acpi_remove_bus_pm_notifier(device);
629
630         kfree(root);
631         return 0;
632 }
633
634 static int __init acpi_pci_root_init(void)
635 {
636         acpi_hest_init();
637
638         if (acpi_pci_disabled)
639                 return 0;
640
641         pci_acpi_crs_quirks();
642         if (acpi_bus_register_driver(&acpi_pci_root_driver) < 0)
643                 return -ENODEV;
644
645         return 0;
646 }
647
648 subsys_initcall(acpi_pci_root_init);