arch/powerpc/platforms/pseries/eeh_cache.c

   1 /*
   2  * eeh_cache.c
   3  * PCI address cache; allows the lookup of PCI devices based on I/O address
   4  *
   5  * Copyright (C) 2004 Linas Vepstas <linas@austin.ibm.com> IBM Corporation
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  20  */
  21
  22 #include <linux/list.h>
  23 #include <linux/pci.h>
  24 #include <linux/rbtree.h>
  25 #include <linux/spinlock.h>
  26 #include <asm/atomic.h>
  27 #include <asm/pci-bridge.h>
  28 #include <asm/ppc-pci.h>
  29
  30 #undef DEBUG
  31
  32 /**
  33  * The pci address cache subsystem.  This subsystem places
  34  * PCI device address resources into a red-black tree, sorted
  35  * according to the address range, so that given only an i/o
  36  * address, the corresponding PCI device can be **quickly**
  37  * found. It is safe to perform an address lookup in an interrupt
  38  * context; this ability is an important feature.
  39  *
  40  * Currently, the only customer of this code is the EEH subsystem;
  41  * thus, this code has been somewhat tailored to suit EEH better.
  42  * In particular, the cache does *not* hold the addresses of devices
  43  * for which EEH is not enabled.
  44  *
  45  * (Implementation Note: The RB tree seems to be better/faster
  46  * than any hash algo I could think of for this problem, even
  47  * with the penalty of slow pointer chases for d-cache misses).
  48  */
  49 struct pci_io_addr_range
  50 {
  51         struct rb_node rb_node;
  52         unsigned long addr_lo;
  53         unsigned long addr_hi;
  54         struct pci_dev *pcidev;
  55         unsigned int flags;
  56 };
  57
  58 static struct pci_io_addr_cache
  59 {
  60         struct rb_root rb_root;
  61         spinlock_t piar_lock;
  62 } pci_io_addr_cache_root;
  63
  64 static inline struct pci_dev *__pci_get_device_by_addr(unsigned long addr)
  65 {
  66         struct rb_node *n = pci_io_addr_cache_root.rb_root.rb_node;
  67
  68         while (n) {
  69                 struct pci_io_addr_range *piar;
  70                 piar = rb_entry(n, struct pci_io_addr_range, rb_node);
  71
  72                 if (addr < piar->addr_lo) {
  73                         n = n->rb_left;
  74                 } else {
  75                         if (addr > piar->addr_hi) {
  76                                 n = n->rb_right;
  77                         } else {
  78                                 pci_dev_get(piar->pcidev);
  79                                 return piar->pcidev;
  80                         }
  81                 }
  82         }
  83
  84         return NULL;
  85 }
  86
  87 /**
  88  * pci_get_device_by_addr - Get device, given only address
  89  * @addr: mmio (PIO) phys address or i/o port number
  90  *
  91  * Given an mmio phys address, or a port number, find a pci device
  92  * that implements this address.  Be sure to pci_dev_put the device
  93  * when finished.  I/O port numbers are assumed to be offset
  94  * from zero (that is, they do *not* have pci_io_addr added in).
  95  * It is safe to call this function within an interrupt.
  96  */
  97 struct pci_dev *pci_get_device_by_addr(unsigned long addr)
  98 {
  99         struct pci_dev *dev;
 100         unsigned long flags;
 101
 102         spin_lock_irqsave(&pci_io_addr_cache_root.piar_lock, flags);
 103         dev = __pci_get_device_by_addr(addr);
 104         spin_unlock_irqrestore(&pci_io_addr_cache_root.piar_lock, flags);
 105         return dev;
 106 }
 107
 108 #ifdef DEBUG
 109 /*
 110  * Handy-dandy debug print routine, does nothing more
 111  * than print out the contents of our addr cache.
 112  */
 113 static void pci_addr_cache_print(struct pci_io_addr_cache *cache)
 114 {
 115         struct rb_node *n;
 116         int cnt = 0;
 117
 118         n = rb_first(&cache->rb_root);
 119         while (n) {
 120                 struct pci_io_addr_range *piar;
 121                 piar = rb_entry(n, struct pci_io_addr_range, rb_node);
 122                 printk(KERN_DEBUG "PCI: %s addr range %d [%lx-%lx]: %s\n",
 123                        (piar->flags & IORESOURCE_IO) ? "i/o" : "mem", cnt,
 124                        piar->addr_lo, piar->addr_hi, pci_name(piar->pcidev));
 125                 cnt++;
 126                 n = rb_next(n);
 127         }
 128 }
 129 #endif
 130
 131 /* Insert address range into the rb tree. */
 132 static struct pci_io_addr_range *
 133 pci_addr_cache_insert(struct pci_dev *dev, unsigned long alo,
 134                       unsigned long ahi, unsigned int flags)
 135 {
 136         struct rb_node **p = &pci_io_addr_cache_root.rb_root.rb_node;
 137         struct rb_node *parent = NULL;
 138         struct pci_io_addr_range *piar;
 139
 140         /* Walk tree, find a place to insert into tree */
 141         while (*p) {
 142                 parent = *p;
 143                 piar = rb_entry(parent, struct pci_io_addr_range, rb_node);
 144                 if (ahi < piar->addr_lo) {
 145                         p = &parent->rb_left;
 146                 } else if (alo > piar->addr_hi) {
 147                         p = &parent->rb_right;
 148                 } else {
 149                         if (dev != piar->pcidev ||
 150                             alo != piar->addr_lo || ahi != piar->addr_hi) {
 151                                 printk(KERN_WARNING "PIAR: overlapping address range\n");
 152                         }
 153                         return piar;
 154                 }
 155         }
 156         piar = (struct pci_io_addr_range *)kmalloc(sizeof(struct pci_io_addr_range), GFP_ATOMIC);
 157         if (!piar)
 158                 return NULL;
 159
 160         piar->addr_lo = alo;
 161         piar->addr_hi = ahi;
 162         piar->pcidev = dev;
 163         piar->flags = flags;
 164
 165 #ifdef DEBUG
 166         printk(KERN_DEBUG "PIAR: insert range=[%lx:%lx] dev=%s\n",
 167                           alo, ahi, pci_name (dev));
 168 #endif
 169
 170         rb_link_node(&piar->rb_node, parent, p);
 171         rb_insert_color(&piar->rb_node, &pci_io_addr_cache_root.rb_root);
 172
 173         return piar;
 174 }
 175
 176 static void __pci_addr_cache_insert_device(struct pci_dev *dev)
 177 {
 178         struct device_node *dn;
 179         struct pci_dn *pdn;
 180         int i;
 181         int inserted = 0;
 182
 183         dn = pci_device_to_OF_node(dev);
 184         if (!dn) {
 185                 printk(KERN_WARNING "PCI: no pci dn found for dev=%s\n", pci_name(dev));
 186                 return;
 187         }
 188
 189         /* Skip any devices for which EEH is not enabled. */
 190         pdn = PCI_DN(dn);
 191         if (!(pdn->eeh_mode & EEH_MODE_SUPPORTED) ||
 192             pdn->eeh_mode & EEH_MODE_NOCHECK) {
 193 #ifdef DEBUG
 194                 printk(KERN_INFO "PCI: skip building address cache for=%s - %s\n",
 195                        pci_name(dev), pdn->node->full_name);
 196 #endif
 197                 return;
 198         }
 199
 200         /* The cache holds a reference to the device... */
 201         pci_dev_get(dev);
 202
 203         /* Walk resources on this device, poke them into the tree */
 204         for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
 205                 unsigned long start = pci_resource_start(dev,i);
 206                 unsigned long end = pci_resource_end(dev,i);
 207                 unsigned int flags = pci_resource_flags(dev,i);
 208
 209                 /* We are interested only bus addresses, not dma or other stuff */
 210                 if (0 == (flags & (IORESOURCE_IO | IORESOURCE_MEM)))
 211                         continue;
 212                 if (start == 0 || ~start == 0 || end == 0 || ~end == 0)
 213                          continue;
 214                 pci_addr_cache_insert(dev, start, end, flags);
 215                 inserted = 1;
 216         }
 217
 218         /* If there was nothing to add, the cache has no reference... */
 219         if (!inserted)
 220                 pci_dev_put(dev);
 221 }
 222
 223 /**
 224  * pci_addr_cache_insert_device - Add a device to the address cache
 225  * @dev: PCI device whose I/O addresses we are interested in.
 226  *
 227  * In order to support the fast lookup of devices based on addresses,
 228  * we maintain a cache of devices that can be quickly searched.
 229  * This routine adds a device to that cache.
 230  */
 231 void pci_addr_cache_insert_device(struct pci_dev *dev)
 232 {
 233         unsigned long flags;
 234
 235         spin_lock_irqsave(&pci_io_addr_cache_root.piar_lock, flags);
 236         __pci_addr_cache_insert_device(dev);
 237         spin_unlock_irqrestore(&pci_io_addr_cache_root.piar_lock, flags);
 238 }
 239
 240 static inline void __pci_addr_cache_remove_device(struct pci_dev *dev)
 241 {
 242         struct rb_node *n;
 243         int removed = 0;
 244
 245 restart:
 246         n = rb_first(&pci_io_addr_cache_root.rb_root);
 247         while (n) {
 248                 struct pci_io_addr_range *piar;
 249                 piar = rb_entry(n, struct pci_io_addr_range, rb_node);
 250
 251                 if (piar->pcidev == dev) {
 252                         rb_erase(n, &pci_io_addr_cache_root.rb_root);
 253                         removed = 1;
 254                         kfree(piar);
 255                         goto restart;
 256                 }
 257                 n = rb_next(n);
 258         }
 259
 260         /* The cache no longer holds its reference to this device... */
 261         if (removed)
 262                 pci_dev_put(dev);
 263 }
 264
 265 /**
 266  * pci_addr_cache_remove_device - remove pci device from addr cache
 267  * @dev: device to remove
 268  *
 269  * Remove a device from the addr-cache tree.
 270  * This is potentially expensive, since it will walk
 271  * the tree multiple times (once per resource).
 272  * But so what; device removal doesn't need to be that fast.
 273  */
 274 void pci_addr_cache_remove_device(struct pci_dev *dev)
 275 {
 276         unsigned long flags;
 277
 278         spin_lock_irqsave(&pci_io_addr_cache_root.piar_lock, flags);
 279         __pci_addr_cache_remove_device(dev);
 280         spin_unlock_irqrestore(&pci_io_addr_cache_root.piar_lock, flags);
 281 }
 282
 283 /**
 284  * pci_addr_cache_build - Build a cache of I/O addresses
 285  *
 286  * Build a cache of pci i/o addresses.  This cache will be used to
 287  * find the pci device that corresponds to a given address.
 288  * This routine scans all pci busses to build the cache.
 289  * Must be run late in boot process, after the pci controllers
 290  * have been scaned for devices (after all device resources are known).
 291  */
 292 void __init pci_addr_cache_build(void)
 293 {
 294         struct device_node *dn;
 295         struct pci_dev *dev = NULL;
 296
 297         spin_lock_init(&pci_io_addr_cache_root.piar_lock);
 298
 299         while ((dev = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, dev)) != NULL) {
 300                 /* Ignore PCI bridges */
 301                 if ((dev->class >> 16) == PCI_BASE_CLASS_BRIDGE)
 302                         continue;
 303
 304                 pci_addr_cache_insert_device(dev);
 305
 306                 dn = pci_device_to_OF_node(dev);
 307                 pci_dev_get (dev);  /* matching put is in eeh_remove_device() */
 308                 PCI_DN(dn)->pcidev = dev;
 309         }
 310
 311 #ifdef DEBUG
 312         /* Verify tree built up above, echo back the list of addrs. */
 313         pci_addr_cache_print(&pci_io_addr_cache_root);
 314 #endif
 315 }
 316