arch/powerpc/kernel/vio.c

   1 /*
   2  * IBM PowerPC Virtual I/O Infrastructure Support.
   3  *
   4  *    Copyright (c) 2003,2008 IBM Corp.
   5  *     Dave Engebretsen engebret@us.ibm.com
   6  *     Santiago Leon santil@us.ibm.com
   7  *     Hollis Blanchard <hollisb@us.ibm.com>
   8  *     Stephen Rothwell
   9  *     Robert Jennings <rcjenn@us.ibm.com>
  10  *
  11  *      This program is free software; you can redistribute it and/or
  12  *      modify it under the terms of the GNU General Public License
  13  *      as published by the Free Software Foundation; either version
  14  *      2 of the License, or (at your option) any later version.
  15  */
  16
  17 #include <linux/cpu.h>
  18 #include <linux/types.h>
  19 #include <linux/delay.h>
  20 #include <linux/stat.h>
  21 #include <linux/device.h>
  22 #include <linux/init.h>
  23 #include <linux/slab.h>
  24 #include <linux/console.h>
  25 #include <linux/export.h>
  26 #include <linux/mm.h>
  27 #include <linux/dma-mapping.h>
  28 #include <linux/kobject.h>
  29
  30 #include <asm/iommu.h>
  31 #include <asm/dma.h>
  32 #include <asm/vio.h>
  33 #include <asm/prom.h>
  34 #include <asm/firmware.h>
  35 #include <asm/tce.h>
  36 #include <asm/abs_addr.h>
  37 #include <asm/page.h>
  38 #include <asm/hvcall.h>
  39
  40 static struct vio_dev vio_bus_device  = { /* fake "parent" device */
  41         .name = "vio",
  42         .type = "",
  43         .dev.init_name = "vio",
  44         .dev.bus = &vio_bus_type,
  45 };
  46
  47 #ifdef CONFIG_PPC_SMLPAR
  48 /**
  49  * vio_cmo_pool - A pool of IO memory for CMO use
  50  *
  51  * @size: The size of the pool in bytes
  52  * @free: The amount of free memory in the pool
  53  */
  54 struct vio_cmo_pool {
  55         size_t size;
  56         size_t free;
  57 };
  58
  59 /* How many ms to delay queued balance work */
  60 #define VIO_CMO_BALANCE_DELAY 100
  61
  62 /* Portion out IO memory to CMO devices by this chunk size */
  63 #define VIO_CMO_BALANCE_CHUNK 131072
  64
  65 /**
  66  * vio_cmo_dev_entry - A device that is CMO-enabled and requires entitlement
  67  *
  68  * @vio_dev: struct vio_dev pointer
  69  * @list: pointer to other devices on bus that are being tracked
  70  */
  71 struct vio_cmo_dev_entry {
  72         struct vio_dev *viodev;
  73         struct list_head list;
  74 };
  75
  76 /**
  77  * vio_cmo - VIO bus accounting structure for CMO entitlement
  78  *
  79  * @lock: spinlock for entire structure
  80  * @balance_q: work queue for balancing system entitlement
  81  * @device_list: list of CMO-enabled devices requiring entitlement
  82  * @entitled: total system entitlement in bytes
  83  * @reserve: pool of memory from which devices reserve entitlement, incl. spare
  84  * @excess: pool of excess entitlement not needed for device reserves or spare
  85  * @spare: IO memory for device hotplug functionality
  86  * @min: minimum necessary for system operation
  87  * @desired: desired memory for system operation
  88  * @curr: bytes currently allocated
  89  * @high: high water mark for IO data usage
  90  */
  91 struct vio_cmo {
  92         spinlock_t lock;
  93         struct delayed_work balance_q;
  94         struct list_head device_list;
  95         size_t entitled;
  96         struct vio_cmo_pool reserve;
  97         struct vio_cmo_pool excess;
  98         size_t spare;
  99         size_t min;
 100         size_t desired;
 101         size_t curr;
 102         size_t high;
 103 } vio_cmo;
 104
 105 /**
 106  * vio_cmo_OF_devices - Count the number of OF devices that have DMA windows
 107  */
 108 static int vio_cmo_num_OF_devs(void)
 109 {
 110         struct device_node *node_vroot;
 111         int count = 0;
 112
 113         /*
 114          * Count the number of vdevice entries with an
 115          * ibm,my-dma-window OF property
 116          */
 117         node_vroot = of_find_node_by_name(NULL, "vdevice");
 118         if (node_vroot) {
 119                 struct device_node *of_node;
 120                 struct property *prop;
 121
 122                 for_each_child_of_node(node_vroot, of_node) {
 123                         prop = of_find_property(of_node, "ibm,my-dma-window",
 124                                                NULL);
 125                         if (prop)
 126                                 count++;
 127                 }
 128         }
 129         of_node_put(node_vroot);
 130         return count;
 131 }
 132
 133 /**
 134  * vio_cmo_alloc - allocate IO memory for CMO-enable devices
 135  *
 136  * @viodev: VIO device requesting IO memory
 137  * @size: size of allocation requested
 138  *
 139  * Allocations come from memory reserved for the devices and any excess
 140  * IO memory available to all devices.  The spare pool used to service
 141  * hotplug must be equal to %VIO_CMO_MIN_ENT for the excess pool to be
 142  * made available.
 143  *
 144  * Return codes:
 145  *  0 for successful allocation and -ENOMEM for a failure
 146  */
 147 static inline int vio_cmo_alloc(struct vio_dev *viodev, size_t size)
 148 {
 149         unsigned long flags;
 150         size_t reserve_free = 0;
 151         size_t excess_free = 0;
 152         int ret = -ENOMEM;
 153
 154         spin_lock_irqsave(&vio_cmo.lock, flags);
 155
 156         /* Determine the amount of free entitlement available in reserve */
 157         if (viodev->cmo.entitled > viodev->cmo.allocated)
 158                 reserve_free = viodev->cmo.entitled - viodev->cmo.allocated;
 159
 160         /* If spare is not fulfilled, the excess pool can not be used. */
 161         if (vio_cmo.spare >= VIO_CMO_MIN_ENT)
 162                 excess_free = vio_cmo.excess.free;
 163
 164         /* The request can be satisfied */
 165         if ((reserve_free + excess_free) >= size) {
 166                 vio_cmo.curr += size;
 167                 if (vio_cmo.curr > vio_cmo.high)
 168                         vio_cmo.high = vio_cmo.curr;
 169                 viodev->cmo.allocated += size;
 170                 size -= min(reserve_free, size);
 171                 vio_cmo.excess.free -= size;
 172                 ret = 0;
 173         }
 174
 175         spin_unlock_irqrestore(&vio_cmo.lock, flags);
 176         return ret;
 177 }
 178
 179 /**
 180  * vio_cmo_dealloc - deallocate IO memory from CMO-enable devices
 181  * @viodev: VIO device freeing IO memory
 182  * @size: size of deallocation
 183  *
 184  * IO memory is freed by the device back to the correct memory pools.
 185  * The spare pool is replenished first from either memory pool, then
 186  * the reserve pool is used to reduce device entitlement, the excess
 187  * pool is used to increase the reserve pool toward the desired entitlement
 188  * target, and then the remaining memory is returned to the pools.
 189  *
 190  */
 191 static inline void vio_cmo_dealloc(struct vio_dev *viodev, size_t size)
 192 {
 193         unsigned long flags;
 194         size_t spare_needed = 0;
 195         size_t excess_freed = 0;
 196         size_t reserve_freed = size;
 197         size_t tmp;
 198         int balance = 0;
 199
 200         spin_lock_irqsave(&vio_cmo.lock, flags);
 201         vio_cmo.curr -= size;
 202
 203         /* Amount of memory freed from the excess pool */
 204         if (viodev->cmo.allocated > viodev->cmo.entitled) {
 205                 excess_freed = min(reserve_freed, (viodev->cmo.allocated -
 206                                                    viodev->cmo.entitled));
 207                 reserve_freed -= excess_freed;
 208         }
 209
 210         /* Remove allocation from device */
 211         viodev->cmo.allocated -= (reserve_freed + excess_freed);
 212
 213         /* Spare is a subset of the reserve pool, replenish it first. */
 214         spare_needed = VIO_CMO_MIN_ENT - vio_cmo.spare;
 215
 216         /*
 217          * Replenish the spare in the reserve pool from the excess pool.
 218          * This moves entitlement into the reserve pool.
 219          */
 220         if (spare_needed && excess_freed) {
 221                 tmp = min(excess_freed, spare_needed);
 222                 vio_cmo.excess.size -= tmp;
 223                 vio_cmo.reserve.size += tmp;
 224                 vio_cmo.spare += tmp;
 225                 excess_freed -= tmp;
 226                 spare_needed -= tmp;
 227                 balance = 1;
 228         }
 229
 230         /*
 231          * Replenish the spare in the reserve pool from the reserve pool.
 232          * This removes entitlement from the device down to VIO_CMO_MIN_ENT,
 233          * if needed, and gives it to the spare pool. The amount of used
 234          * memory in this pool does not change.
 235          */
 236         if (spare_needed && reserve_freed) {
 237                 tmp = min3(spare_needed, reserve_freed, (viodev->cmo.entitled - VIO_CMO_MIN_ENT));
 238
 239                 vio_cmo.spare += tmp;
 240                 viodev->cmo.entitled -= tmp;
 241                 reserve_freed -= tmp;
 242                 spare_needed -= tmp;
 243                 balance = 1;
 244         }
 245
 246         /*
 247          * Increase the reserve pool until the desired allocation is met.
 248          * Move an allocation freed from the excess pool into the reserve
 249          * pool and schedule a balance operation.
 250          */
 251         if (excess_freed && (vio_cmo.desired > vio_cmo.reserve.size)) {
 252                 tmp = min(excess_freed, (vio_cmo.desired - vio_cmo.reserve.size));
 253
 254                 vio_cmo.excess.size -= tmp;
 255                 vio_cmo.reserve.size += tmp;
 256                 excess_freed -= tmp;
 257                 balance = 1;
 258         }
 259
 260         /* Return memory from the excess pool to that pool */
 261         if (excess_freed)
 262                 vio_cmo.excess.free += excess_freed;
 263
 264         if (balance)
 265                 schedule_delayed_work(&vio_cmo.balance_q, VIO_CMO_BALANCE_DELAY);
 266         spin_unlock_irqrestore(&vio_cmo.lock, flags);
 267 }
 268
 269 /**
 270  * vio_cmo_entitlement_update - Manage system entitlement changes
 271  *
 272  * @new_entitlement: new system entitlement to attempt to accommodate
 273  *
 274  * Increases in entitlement will be used to fulfill the spare entitlement
 275  * and the rest is given to the excess pool.  Decreases, if they are
 276  * possible, come from the excess pool and from unused device entitlement
 277  *
 278  * Returns: 0 on success, -ENOMEM when change can not be made
 279  */
 280 int vio_cmo_entitlement_update(size_t new_entitlement)
 281 {
 282         struct vio_dev *viodev;
 283         struct vio_cmo_dev_entry *dev_ent;
 284         unsigned long flags;
 285         size_t avail, delta, tmp;
 286
 287         spin_lock_irqsave(&vio_cmo.lock, flags);
 288
 289         /* Entitlement increases */
 290         if (new_entitlement > vio_cmo.entitled) {
 291                 delta = new_entitlement - vio_cmo.entitled;
 292
 293                 /* Fulfill spare allocation */
 294                 if (vio_cmo.spare < VIO_CMO_MIN_ENT) {
 295                         tmp = min(delta, (VIO_CMO_MIN_ENT - vio_cmo.spare));
 296                         vio_cmo.spare += tmp;
 297                         vio_cmo.reserve.size += tmp;
 298                         delta -= tmp;
 299                 }
 300
 301                 /* Remaining new allocation goes to the excess pool */
 302                 vio_cmo.entitled += delta;
 303                 vio_cmo.excess.size += delta;
 304                 vio_cmo.excess.free += delta;
 305
 306                 goto out;
 307         }
 308
 309         /* Entitlement decreases */
 310         delta = vio_cmo.entitled - new_entitlement;
 311         avail = vio_cmo.excess.free;
 312
 313         /*
 314          * Need to check how much unused entitlement each device can
 315          * sacrifice to fulfill entitlement change.
 316          */
 317         list_for_each_entry(dev_ent, &vio_cmo.device_list, list) {
 318                 if (avail >= delta)
 319                         break;
 320
 321                 viodev = dev_ent->viodev;
 322                 if ((viodev->cmo.entitled > viodev->cmo.allocated) &&
 323                     (viodev->cmo.entitled > VIO_CMO_MIN_ENT))
 324                                 avail += viodev->cmo.entitled -
 325                                          max_t(size_t, viodev->cmo.allocated,
 326                                                VIO_CMO_MIN_ENT);
 327         }
 328
 329         if (delta <= avail) {
 330                 vio_cmo.entitled -= delta;
 331
 332                 /* Take entitlement from the excess pool first */
 333                 tmp = min(vio_cmo.excess.free, delta);
 334                 vio_cmo.excess.size -= tmp;
 335                 vio_cmo.excess.free -= tmp;
 336                 delta -= tmp;
 337
 338                 /*
 339                  * Remove all but VIO_CMO_MIN_ENT bytes from devices
 340                  * until entitlement change is served
 341                  */
 342                 list_for_each_entry(dev_ent, &vio_cmo.device_list, list) {
 343                         if (!delta)
 344                                 break;
 345
 346                         viodev = dev_ent->viodev;
 347                         tmp = 0;
 348                         if ((viodev->cmo.entitled > viodev->cmo.allocated) &&
 349                             (viodev->cmo.entitled > VIO_CMO_MIN_ENT))
 350                                 tmp = viodev->cmo.entitled -
 351                                       max_t(size_t, viodev->cmo.allocated,
 352                                             VIO_CMO_MIN_ENT);
 353                         viodev->cmo.entitled -= min(tmp, delta);
 354                         delta -= min(tmp, delta);
 355                 }
 356         } else {
 357                 spin_unlock_irqrestore(&vio_cmo.lock, flags);
 358                 return -ENOMEM;
 359         }
 360
 361 out:
 362         schedule_delayed_work(&vio_cmo.balance_q, 0);
 363         spin_unlock_irqrestore(&vio_cmo.lock, flags);
 364         return 0;
 365 }
 366
 367 /**
 368  * vio_cmo_balance - Balance entitlement among devices
 369  *
 370  * @work: work queue structure for this operation
 371  *
 372  * Any system entitlement above the minimum needed for devices, or
 373  * already allocated to devices, can be distributed to the devices.
 374  * The list of devices is iterated through to recalculate the desired
 375  * entitlement level and to determine how much entitlement above the
 376  * minimum entitlement is allocated to devices.
 377  *
 378  * Small chunks of the available entitlement are given to devices until
 379  * their requirements are fulfilled or there is no entitlement left to give.
 380  * Upon completion sizes of the reserve and excess pools are calculated.
 381  *
 382  * The system minimum entitlement level is also recalculated here.
 383  * Entitlement will be reserved for devices even after vio_bus_remove to
 384  * accommodate reloading the driver.  The OF tree is walked to count the
 385  * number of devices present and this will remove entitlement for devices
 386  * that have actually left the system after having vio_bus_remove called.
 387  */
 388 static void vio_cmo_balance(struct work_struct *work)
 389 {
 390         struct vio_cmo *cmo;
 391         struct vio_dev *viodev;
 392         struct vio_cmo_dev_entry *dev_ent;
 393         unsigned long flags;
 394         size_t avail = 0, level, chunk, need;
 395         int devcount = 0, fulfilled;
 396
 397         cmo = container_of(work, struct vio_cmo, balance_q.work);
 398
 399         spin_lock_irqsave(&vio_cmo.lock, flags);
 400
 401         /* Calculate minimum entitlement and fulfill spare */
 402         cmo->min = vio_cmo_num_OF_devs() * VIO_CMO_MIN_ENT;
 403         BUG_ON(cmo->min > cmo->entitled);
 404         cmo->spare = min_t(size_t, VIO_CMO_MIN_ENT, (cmo->entitled - cmo->min));
 405         cmo->min += cmo->spare;
 406         cmo->desired = cmo->min;
 407
 408         /*
 409          * Determine how much entitlement is available and reset device
 410          * entitlements
 411          */
 412         avail = cmo->entitled - cmo->spare;
 413         list_for_each_entry(dev_ent, &vio_cmo.device_list, list) {
 414                 viodev = dev_ent->viodev;
 415                 devcount++;
 416                 viodev->cmo.entitled = VIO_CMO_MIN_ENT;
 417                 cmo->desired += (viodev->cmo.desired - VIO_CMO_MIN_ENT);
 418                 avail -= max_t(size_t, viodev->cmo.allocated, VIO_CMO_MIN_ENT);
 419         }
 420
 421         /*
 422          * Having provided each device with the minimum entitlement, loop
 423          * over the devices portioning out the remaining entitlement
 424          * until there is nothing left.
 425          */
 426         level = VIO_CMO_MIN_ENT;
 427         while (avail) {
 428                 fulfilled = 0;
 429                 list_for_each_entry(dev_ent, &vio_cmo.device_list, list) {
 430                         viodev = dev_ent->viodev;
 431
 432                         if (viodev->cmo.desired <= level) {
 433                                 fulfilled++;
 434                                 continue;
 435                         }
 436
 437                         /*
 438                          * Give the device up to VIO_CMO_BALANCE_CHUNK
 439                          * bytes of entitlement, but do not exceed the
 440                          * desired level of entitlement for the device.
 441                          */
 442                         chunk = min_t(size_t, avail, VIO_CMO_BALANCE_CHUNK);
 443                         chunk = min(chunk, (viodev->cmo.desired -
 444                                             viodev->cmo.entitled));
 445                         viodev->cmo.entitled += chunk;
 446
 447                         /*
 448                          * If the memory for this entitlement increase was
 449                          * already allocated to the device it does not come
 450                          * from the available pool being portioned out.
 451                          */
 452                         need = max(viodev->cmo.allocated, viodev->cmo.entitled)-
 453                                max(viodev->cmo.allocated, level);
 454                         avail -= need;
 455
 456                 }
 457                 if (fulfilled == devcount)
 458                         break;
 459                 level += VIO_CMO_BALANCE_CHUNK;
 460         }
 461
 462         /* Calculate new reserve and excess pool sizes */
 463         cmo->reserve.size = cmo->min;
 464         cmo->excess.free = 0;
 465         cmo->excess.size = 0;
 466         need = 0;
 467         list_for_each_entry(dev_ent, &vio_cmo.device_list, list) {
 468                 viodev = dev_ent->viodev;
 469                 /* Calculated reserve size above the minimum entitlement */
 470                 if (viodev->cmo.entitled)
 471                         cmo->reserve.size += (viodev->cmo.entitled -
 472                                               VIO_CMO_MIN_ENT);
 473                 /* Calculated used excess entitlement */
 474                 if (viodev->cmo.allocated > viodev->cmo.entitled)
 475                         need += viodev->cmo.allocated - viodev->cmo.entitled;
 476         }
 477         cmo->excess.size = cmo->entitled - cmo->reserve.size;
 478         cmo->excess.free = cmo->excess.size - need;
 479
 480         cancel_delayed_work(to_delayed_work(work));
 481         spin_unlock_irqrestore(&vio_cmo.lock, flags);
 482 }
 483
 484 static void *vio_dma_iommu_alloc_coherent(struct device *dev, size_t size,
 485                                           dma_addr_t *dma_handle, gfp_t flag,
 486                                           struct dma_attrs *attrs)
 487 {
 488         struct vio_dev *viodev = to_vio_dev(dev);
 489         void *ret;
 490
 491         if (vio_cmo_alloc(viodev, roundup(size, PAGE_SIZE))) {
 492                 atomic_inc(&viodev->cmo.allocs_failed);
 493                 return NULL;
 494         }
 495
 496         ret = dma_iommu_ops.alloc(dev, size, dma_handle, flag, attrs);
 497         if (unlikely(ret == NULL)) {
 498                 vio_cmo_dealloc(viodev, roundup(size, PAGE_SIZE));
 499                 atomic_inc(&viodev->cmo.allocs_failed);
 500         }
 501
 502         return ret;
 503 }
 504
 505 static void vio_dma_iommu_free_coherent(struct device *dev, size_t size,
 506                                         void *vaddr, dma_addr_t dma_handle,
 507                                         struct dma_attrs *attrs)
 508 {
 509         struct vio_dev *viodev = to_vio_dev(dev);
 510
 511         dma_iommu_ops.free(dev, size, vaddr, dma_handle, attrs);
 512
 513         vio_cmo_dealloc(viodev, roundup(size, PAGE_SIZE));
 514 }
 515
 516 static dma_addr_t vio_dma_iommu_map_page(struct device *dev, struct page *page,
 517                                          unsigned long offset, size_t size,
 518                                          enum dma_data_direction direction,
 519                                          struct dma_attrs *attrs)
 520 {
 521         struct vio_dev *viodev = to_vio_dev(dev);
 522         dma_addr_t ret = DMA_ERROR_CODE;
 523
 524         if (vio_cmo_alloc(viodev, roundup(size, IOMMU_PAGE_SIZE))) {
 525                 atomic_inc(&viodev->cmo.allocs_failed);
 526                 return ret;
 527         }
 528
 529         ret = dma_iommu_ops.map_page(dev, page, offset, size, direction, attrs);
 530         if (unlikely(dma_mapping_error(dev, ret))) {
 531                 vio_cmo_dealloc(viodev, roundup(size, IOMMU_PAGE_SIZE));
 532                 atomic_inc(&viodev->cmo.allocs_failed);
 533         }
 534
 535         return ret;
 536 }
 537
 538 static void vio_dma_iommu_unmap_page(struct device *dev, dma_addr_t dma_handle,
 539                                      size_t size,
 540                                      enum dma_data_direction direction,
 541                                      struct dma_attrs *attrs)
 542 {
 543         struct vio_dev *viodev = to_vio_dev(dev);
 544
 545         dma_iommu_ops.unmap_page(dev, dma_handle, size, direction, attrs);
 546
 547         vio_cmo_dealloc(viodev, roundup(size, IOMMU_PAGE_SIZE));
 548 }
 549
 550 static int vio_dma_iommu_map_sg(struct device *dev, struct scatterlist *sglist,
 551                                 int nelems, enum dma_data_direction direction,
 552                                 struct dma_attrs *attrs)
 553 {
 554         struct vio_dev *viodev = to_vio_dev(dev);
 555         struct scatterlist *sgl;
 556         int ret, count = 0;
 557         size_t alloc_size = 0;
 558
 559         for (sgl = sglist; count < nelems; count++, sgl++)
 560                 alloc_size += roundup(sgl->length, IOMMU_PAGE_SIZE);
 561
 562         if (vio_cmo_alloc(viodev, alloc_size)) {
 563                 atomic_inc(&viodev->cmo.allocs_failed);
 564                 return 0;
 565         }
 566
 567         ret = dma_iommu_ops.map_sg(dev, sglist, nelems, direction, attrs);
 568
 569         if (unlikely(!ret)) {
 570                 vio_cmo_dealloc(viodev, alloc_size);
 571                 atomic_inc(&viodev->cmo.allocs_failed);
 572                 return ret;
 573         }
 574
 575         for (sgl = sglist, count = 0; count < ret; count++, sgl++)
 576                 alloc_size -= roundup(sgl->dma_length, IOMMU_PAGE_SIZE);
 577         if (alloc_size)
 578                 vio_cmo_dealloc(viodev, alloc_size);
 579
 580         return ret;
 581 }
 582
 583 static void vio_dma_iommu_unmap_sg(struct device *dev,
 584                 struct scatterlist *sglist, int nelems,
 585                 enum dma_data_direction direction,
 586                 struct dma_attrs *attrs)
 587 {
 588         struct vio_dev *viodev = to_vio_dev(dev);
 589         struct scatterlist *sgl;
 590         size_t alloc_size = 0;
 591         int count = 0;
 592
 593         for (sgl = sglist; count < nelems; count++, sgl++)
 594                 alloc_size += roundup(sgl->dma_length, IOMMU_PAGE_SIZE);
 595
 596         dma_iommu_ops.unmap_sg(dev, sglist, nelems, direction, attrs);
 597
 598         vio_cmo_dealloc(viodev, alloc_size);
 599 }
 600
 601 static int vio_dma_iommu_dma_supported(struct device *dev, u64 mask)
 602 {
 603         return dma_iommu_ops.dma_supported(dev, mask);
 604 }
 605
 606 static u64 vio_dma_get_required_mask(struct device *dev)
 607 {
 608         return dma_iommu_ops.get_required_mask(dev);
 609 }
 610
 611 struct dma_map_ops vio_dma_mapping_ops = {
 612         .alloc             = vio_dma_iommu_alloc_coherent,
 613         .free              = vio_dma_iommu_free_coherent,
 614         .map_sg            = vio_dma_iommu_map_sg,
 615         .unmap_sg          = vio_dma_iommu_unmap_sg,
 616         .map_page          = vio_dma_iommu_map_page,
 617         .unmap_page        = vio_dma_iommu_unmap_page,
 618         .dma_supported     = vio_dma_iommu_dma_supported,
 619         .get_required_mask = vio_dma_get_required_mask,
 620 };
 621
 622 /**
 623  * vio_cmo_set_dev_desired - Set desired entitlement for a device
 624  *
 625  * @viodev: struct vio_dev for device to alter
 626  * @desired: new desired entitlement level in bytes
 627  *
 628  * For use by devices to request a change to their entitlement at runtime or
 629  * through sysfs.  The desired entitlement level is changed and a balancing
 630  * of system resources is scheduled to run in the future.
 631  */
 632 void vio_cmo_set_dev_desired(struct vio_dev *viodev, size_t desired)
 633 {
 634         unsigned long flags;
 635         struct vio_cmo_dev_entry *dev_ent;
 636         int found = 0;
 637
 638         if (!firmware_has_feature(FW_FEATURE_CMO))
 639                 return;
 640
 641         spin_lock_irqsave(&vio_cmo.lock, flags);
 642         if (desired < VIO_CMO_MIN_ENT)
 643                 desired = VIO_CMO_MIN_ENT;
 644
 645         /*
 646          * Changes will not be made for devices not in the device list.
 647          * If it is not in the device list, then no driver is loaded
 648          * for the device and it can not receive entitlement.
 649          */
 650         list_for_each_entry(dev_ent, &vio_cmo.device_list, list)
 651                 if (viodev == dev_ent->viodev) {
 652                         found = 1;
 653                         break;
 654                 }
 655         if (!found) {
 656                 spin_unlock_irqrestore(&vio_cmo.lock, flags);
 657                 return;
 658         }
 659
 660         /* Increase/decrease in desired device entitlement */
 661         if (desired >= viodev->cmo.desired) {
 662                 /* Just bump the bus and device values prior to a balance*/
 663                 vio_cmo.desired += desired - viodev->cmo.desired;
 664                 viodev->cmo.desired = desired;
 665         } else {
 666                 /* Decrease bus and device values for desired entitlement */
 667                 vio_cmo.desired -= viodev->cmo.desired - desired;
 668                 viodev->cmo.desired = desired;
 669                 /*
 670                  * If less entitlement is desired than current entitlement, move
 671                  * any reserve memory in the change region to the excess pool.
 672                  */
 673                 if (viodev->cmo.entitled > desired) {
 674                         vio_cmo.reserve.size -= viodev->cmo.entitled - desired;
 675                         vio_cmo.excess.size += viodev->cmo.entitled - desired;
 676                         /*
 677                          * If entitlement moving from the reserve pool to the
 678                          * excess pool is currently unused, add to the excess
 679                          * free counter.
 680                          */
 681                         if (viodev->cmo.allocated < viodev->cmo.entitled)
 682                                 vio_cmo.excess.free += viodev->cmo.entitled -
 683                                                        max(viodev->cmo.allocated, desired);
 684                         viodev->cmo.entitled = desired;
 685                 }
 686         }
 687         schedule_delayed_work(&vio_cmo.balance_q, 0);
 688         spin_unlock_irqrestore(&vio_cmo.lock, flags);
 689 }
 690
 691 /**
 692  * vio_cmo_bus_probe - Handle CMO specific bus probe activities
 693  *
 694  * @viodev - Pointer to struct vio_dev for device
 695  *
 696  * Determine the devices IO memory entitlement needs, attempting
 697  * to satisfy the system minimum entitlement at first and scheduling
 698  * a balance operation to take care of the rest at a later time.
 699  *
 700  * Returns: 0 on success, -EINVAL when device doesn't support CMO, and
 701  *          -ENOMEM when entitlement is not available for device or
 702  *          device entry.
 703  *
 704  */
 705 static int vio_cmo_bus_probe(struct vio_dev *viodev)
 706 {
 707         struct vio_cmo_dev_entry *dev_ent;
 708         struct device *dev = &viodev->dev;
 709         struct vio_driver *viodrv = to_vio_driver(dev->driver);
 710         unsigned long flags;
 711         size_t size;
 712         bool dma_capable = false;
 713
 714         /* A device requires entitlement if it has a DMA window property */
 715         switch (viodev->family) {
 716         case VDEVICE:
 717                 if (of_get_property(viodev->dev.of_node,
 718                                         "ibm,my-dma-window", NULL))
 719                         dma_capable = true;
 720                 break;
 721         case PFO:
 722                 dma_capable = false;
 723                 break;
 724         default:
 725                 dev_warn(dev, "unknown device family: %d\n", viodev->family);
 726                 BUG();
 727                 break;
 728         }
 729
 730         /* Configure entitlement for the device. */
 731         if (dma_capable) {
 732                 /* Check that the driver is CMO enabled and get desired DMA */
 733                 if (!viodrv->get_desired_dma) {
 734                         dev_err(dev, "%s: device driver does not support CMO\n",
 735                                 __func__);
 736                         return -EINVAL;
 737                 }
 738
 739                 viodev->cmo.desired = IOMMU_PAGE_ALIGN(viodrv->get_desired_dma(viodev));
 740                 if (viodev->cmo.desired < VIO_CMO_MIN_ENT)
 741                         viodev->cmo.desired = VIO_CMO_MIN_ENT;
 742                 size = VIO_CMO_MIN_ENT;
 743
 744                 dev_ent = kmalloc(sizeof(struct vio_cmo_dev_entry),
 745                                   GFP_KERNEL);
 746                 if (!dev_ent)
 747                         return -ENOMEM;
 748
 749                 dev_ent->viodev = viodev;
 750                 spin_lock_irqsave(&vio_cmo.lock, flags);
 751                 list_add(&dev_ent->list, &vio_cmo.device_list);
 752         } else {
 753                 viodev->cmo.desired = 0;
 754                 size = 0;
 755                 spin_lock_irqsave(&vio_cmo.lock, flags);
 756         }
 757
 758         /*
 759          * If the needs for vio_cmo.min have not changed since they
 760          * were last set, the number of devices in the OF tree has
 761          * been constant and the IO memory for this is already in
 762          * the reserve pool.
 763          */
 764         if (vio_cmo.min == ((vio_cmo_num_OF_devs() + 1) *
 765                             VIO_CMO_MIN_ENT)) {
 766                 /* Updated desired entitlement if device requires it */
 767                 if (size)
 768                         vio_cmo.desired += (viodev->cmo.desired -
 769                                         VIO_CMO_MIN_ENT);
 770         } else {
 771                 size_t tmp;
 772
 773                 tmp = vio_cmo.spare + vio_cmo.excess.free;
 774                 if (tmp < size) {
 775                         dev_err(dev, "%s: insufficient free "
 776                                 "entitlement to add device. "
 777                                 "Need %lu, have %lu\n", __func__,
 778                                 size, (vio_cmo.spare + tmp));
 779                         spin_unlock_irqrestore(&vio_cmo.lock, flags);
 780                         return -ENOMEM;
 781                 }
 782
 783                 /* Use excess pool first to fulfill request */
 784                 tmp = min(size, vio_cmo.excess.free);
 785                 vio_cmo.excess.free -= tmp;
 786                 vio_cmo.excess.size -= tmp;
 787                 vio_cmo.reserve.size += tmp;
 788
 789                 /* Use spare if excess pool was insufficient */
 790                 vio_cmo.spare -= size - tmp;
 791
 792                 /* Update bus accounting */
 793                 vio_cmo.min += size;
 794                 vio_cmo.desired += viodev->cmo.desired;
 795         }
 796         spin_unlock_irqrestore(&vio_cmo.lock, flags);
 797         return 0;
 798 }
 799
 800 /**
 801  * vio_cmo_bus_remove - Handle CMO specific bus removal activities
 802  *
 803  * @viodev - Pointer to struct vio_dev for device
 804  *
 805  * Remove the device from the cmo device list.  The minimum entitlement
 806  * will be reserved for the device as long as it is in the system.  The
 807  * rest of the entitlement the device had been allocated will be returned
 808  * to the system.
 809  */
 810 static void vio_cmo_bus_remove(struct vio_dev *viodev)
 811 {
 812         struct vio_cmo_dev_entry *dev_ent;
 813         unsigned long flags;
 814         size_t tmp;
 815
 816         spin_lock_irqsave(&vio_cmo.lock, flags);
 817         if (viodev->cmo.allocated) {
 818                 dev_err(&viodev->dev, "%s: device had %lu bytes of IO "
 819                         "allocated after remove operation.\n",
 820                         __func__, viodev->cmo.allocated);
 821                 BUG();
 822         }
 823
 824         /*
 825          * Remove the device from the device list being maintained for
 826          * CMO enabled devices.
 827          */
 828         list_for_each_entry(dev_ent, &vio_cmo.device_list, list)
 829                 if (viodev == dev_ent->viodev) {
 830                         list_del(&dev_ent->list);
 831                         kfree(dev_ent);
 832                         break;
 833                 }
 834
 835         /*
 836          * Devices may not require any entitlement and they do not need
 837          * to be processed.  Otherwise, return the device's entitlement
 838          * back to the pools.
 839          */
 840         if (viodev->cmo.entitled) {
 841                 /*
 842                  * This device has not yet left the OF tree, it's
 843                  * minimum entitlement remains in vio_cmo.min and
 844                  * vio_cmo.desired
 845                  */
 846                 vio_cmo.desired -= (viodev->cmo.desired - VIO_CMO_MIN_ENT);
 847
 848                 /*
 849                  * Save min allocation for device in reserve as long
 850                  * as it exists in OF tree as determined by later
 851                  * balance operation
 852                  */
 853                 viodev->cmo.entitled -= VIO_CMO_MIN_ENT;
 854
 855                 /* Replenish spare from freed reserve pool */
 856                 if (viodev->cmo.entitled && (vio_cmo.spare < VIO_CMO_MIN_ENT)) {
 857                         tmp = min(viodev->cmo.entitled, (VIO_CMO_MIN_ENT -
 858                                                          vio_cmo.spare));
 859                         vio_cmo.spare += tmp;
 860                         viodev->cmo.entitled -= tmp;
 861                 }
 862
 863                 /* Remaining reserve goes to excess pool */
 864                 vio_cmo.excess.size += viodev->cmo.entitled;
 865                 vio_cmo.excess.free += viodev->cmo.entitled;
 866                 vio_cmo.reserve.size -= viodev->cmo.entitled;
 867
 868                 /*
 869                  * Until the device is removed it will keep a
 870                  * minimum entitlement; this will guarantee that
 871                  * a module unload/load will result in a success.
 872                  */
 873                 viodev->cmo.entitled = VIO_CMO_MIN_ENT;
 874                 viodev->cmo.desired = VIO_CMO_MIN_ENT;
 875                 atomic_set(&viodev->cmo.allocs_failed, 0);
 876         }
 877
 878         spin_unlock_irqrestore(&vio_cmo.lock, flags);
 879 }
 880
 881 static void vio_cmo_set_dma_ops(struct vio_dev *viodev)
 882 {
 883         set_dma_ops(&viodev->dev, &vio_dma_mapping_ops);
 884 }
 885
 886 /**
 887  * vio_cmo_bus_init - CMO entitlement initialization at bus init time
 888  *
 889  * Set up the reserve and excess entitlement pools based on available
 890  * system entitlement and the number of devices in the OF tree that
 891  * require entitlement in the reserve pool.
 892  */
 893 static void vio_cmo_bus_init(void)
 894 {
 895         struct hvcall_mpp_data mpp_data;
 896         int err;
 897
 898         memset(&vio_cmo, 0, sizeof(struct vio_cmo));
 899         spin_lock_init(&vio_cmo.lock);
 900         INIT_LIST_HEAD(&vio_cmo.device_list);
 901         INIT_DELAYED_WORK(&vio_cmo.balance_q, vio_cmo_balance);
 902
 903         /* Get current system entitlement */
 904         err = h_get_mpp(&mpp_data);
 905
 906         /*
 907          * On failure, continue with entitlement set to 0, will panic()
 908          * later when spare is reserved.
 909          */
 910         if (err != H_SUCCESS) {
 911                 printk(KERN_ERR "%s: unable to determine system IO "\
 912                        "entitlement. (%d)\n", __func__, err);
 913                 vio_cmo.entitled = 0;
 914         } else {
 915                 vio_cmo.entitled = mpp_data.entitled_mem;
 916         }
 917
 918         /* Set reservation and check against entitlement */
 919         vio_cmo.spare = VIO_CMO_MIN_ENT;
 920         vio_cmo.reserve.size = vio_cmo.spare;
 921         vio_cmo.reserve.size += (vio_cmo_num_OF_devs() *
 922                                  VIO_CMO_MIN_ENT);
 923         if (vio_cmo.reserve.size > vio_cmo.entitled) {
 924                 printk(KERN_ERR "%s: insufficient system entitlement\n",
 925                        __func__);
 926                 panic("%s: Insufficient system entitlement", __func__);
 927         }
 928
 929         /* Set the remaining accounting variables */
 930         vio_cmo.excess.size = vio_cmo.entitled - vio_cmo.reserve.size;
 931         vio_cmo.excess.free = vio_cmo.excess.size;
 932         vio_cmo.min = vio_cmo.reserve.size;
 933         vio_cmo.desired = vio_cmo.reserve.size;
 934 }
 935
 936 /* sysfs device functions and data structures for CMO */
 937
 938 #define viodev_cmo_rd_attr(name)                                        \
 939 static ssize_t viodev_cmo_##name##_show(struct device *dev,             \
 940                                         struct device_attribute *attr,  \
 941                                          char *buf)                     \
 942 {                                                                       \
 943         return sprintf(buf, "%lu\n", to_vio_dev(dev)->cmo.name);        \
 944 }
 945
 946 static ssize_t viodev_cmo_allocs_failed_show(struct device *dev,
 947                 struct device_attribute *attr, char *buf)
 948 {
 949         struct vio_dev *viodev = to_vio_dev(dev);
 950         return sprintf(buf, "%d\n", atomic_read(&viodev->cmo.allocs_failed));
 951 }
 952
 953 static ssize_t viodev_cmo_allocs_failed_reset(struct device *dev,
 954                 struct device_attribute *attr, const char *buf, size_t count)
 955 {
 956         struct vio_dev *viodev = to_vio_dev(dev);
 957         atomic_set(&viodev->cmo.allocs_failed, 0);
 958         return count;
 959 }
 960
 961 static ssize_t viodev_cmo_desired_set(struct device *dev,
 962                 struct device_attribute *attr, const char *buf, size_t count)
 963 {
 964         struct vio_dev *viodev = to_vio_dev(dev);
 965         size_t new_desired;
 966         int ret;
 967
 968         ret = strict_strtoul(buf, 10, &new_desired);
 969         if (ret)
 970                 return ret;
 971
 972         vio_cmo_set_dev_desired(viodev, new_desired);
 973         return count;
 974 }
 975
 976 viodev_cmo_rd_attr(desired);
 977 viodev_cmo_rd_attr(entitled);
 978 viodev_cmo_rd_attr(allocated);
 979
 980 static ssize_t name_show(struct device *, struct device_attribute *, char *);
 981 static ssize_t devspec_show(struct device *, struct device_attribute *, char *);
 982 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
 983                              char *buf);
 984 static struct device_attribute vio_cmo_dev_attrs[] = {
 985         __ATTR_RO(name),
 986         __ATTR_RO(devspec),
 987         __ATTR_RO(modalias),
 988         __ATTR(cmo_desired,       S_IWUSR|S_IRUSR|S_IWGRP|S_IRGRP|S_IROTH,
 989                viodev_cmo_desired_show, viodev_cmo_desired_set),
 990         __ATTR(cmo_entitled,      S_IRUGO, viodev_cmo_entitled_show,      NULL),
 991         __ATTR(cmo_allocated,     S_IRUGO, viodev_cmo_allocated_show,     NULL),
 992         __ATTR(cmo_allocs_failed, S_IWUSR|S_IRUSR|S_IWGRP|S_IRGRP|S_IROTH,
 993                viodev_cmo_allocs_failed_show, viodev_cmo_allocs_failed_reset),
 994         __ATTR_NULL
 995 };
 996
 997 /* sysfs bus functions and data structures for CMO */
 998
 999 #define viobus_cmo_rd_attr(name)                                        \
1000 static ssize_t                                                          \
1001 viobus_cmo_##name##_show(struct bus_type *bt, char *buf)                \
1002 {                                                                       \
1003         return sprintf(buf, "%lu\n", vio_cmo.name);                     \
1004 }
1005
1006 #define viobus_cmo_pool_rd_attr(name, var)                              \
1007 static ssize_t                                                          \
1008 viobus_cmo_##name##_pool_show_##var(struct bus_type *bt, char *buf)     \
1009 {                                                                       \
1010         return sprintf(buf, "%lu\n", vio_cmo.name.var);                 \
1011 }
1012
1013 static ssize_t viobus_cmo_high_reset(struct bus_type *bt, const char *buf,
1014                                      size_t count)
1015 {
1016         unsigned long flags;
1017
1018         spin_lock_irqsave(&vio_cmo.lock, flags);
1019         vio_cmo.high = vio_cmo.curr;
1020         spin_unlock_irqrestore(&vio_cmo.lock, flags);
1021
1022         return count;
1023 }
1024
1025 viobus_cmo_rd_attr(entitled);
1026 viobus_cmo_pool_rd_attr(reserve, size);
1027 viobus_cmo_pool_rd_attr(excess, size);
1028 viobus_cmo_pool_rd_attr(excess, free);
1029 viobus_cmo_rd_attr(spare);
1030 viobus_cmo_rd_attr(min);
1031 viobus_cmo_rd_attr(desired);
1032 viobus_cmo_rd_attr(curr);
1033 viobus_cmo_rd_attr(high);
1034
1035 static struct bus_attribute vio_cmo_bus_attrs[] = {
1036         __ATTR(cmo_entitled, S_IRUGO, viobus_cmo_entitled_show, NULL),
1037         __ATTR(cmo_reserve_size, S_IRUGO, viobus_cmo_reserve_pool_show_size, NULL),
1038         __ATTR(cmo_excess_size, S_IRUGO, viobus_cmo_excess_pool_show_size, NULL),
1039         __ATTR(cmo_excess_free, S_IRUGO, viobus_cmo_excess_pool_show_free, NULL),
1040         __ATTR(cmo_spare,   S_IRUGO, viobus_cmo_spare_show,   NULL),
1041         __ATTR(cmo_min,     S_IRUGO, viobus_cmo_min_show,     NULL),
1042         __ATTR(cmo_desired, S_IRUGO, viobus_cmo_desired_show, NULL),
1043         __ATTR(cmo_curr,    S_IRUGO, viobus_cmo_curr_show,    NULL),
1044         __ATTR(cmo_high,    S_IWUSR|S_IRUSR|S_IWGRP|S_IRGRP|S_IROTH,
1045                viobus_cmo_high_show, viobus_cmo_high_reset),
1046         __ATTR_NULL
1047 };
1048
1049 static void vio_cmo_sysfs_init(void)
1050 {
1051         vio_bus_type.dev_attrs = vio_cmo_dev_attrs;
1052         vio_bus_type.bus_attrs = vio_cmo_bus_attrs;
1053 }
1054 #else /* CONFIG_PPC_SMLPAR */
1055 int vio_cmo_entitlement_update(size_t new_entitlement) { return 0; }
1056 void vio_cmo_set_dev_desired(struct vio_dev *viodev, size_t desired) {}
1057 static int vio_cmo_bus_probe(struct vio_dev *viodev) { return 0; }
1058 static void vio_cmo_bus_remove(struct vio_dev *viodev) {}
1059 static void vio_cmo_set_dma_ops(struct vio_dev *viodev) {}
1060 static void vio_cmo_bus_init(void) {}
1061 static void vio_cmo_sysfs_init(void) { }
1062 #endif /* CONFIG_PPC_SMLPAR */
1063 EXPORT_SYMBOL(vio_cmo_entitlement_update);
1064 EXPORT_SYMBOL(vio_cmo_set_dev_desired);
1065
1066
1067 /*
1068  * Platform Facilities Option (PFO) support
1069  */
1070
1071 /**
1072  * vio_h_cop_sync - Perform a synchronous PFO co-processor operation
1073  *
1074  * @vdev - Pointer to a struct vio_dev for device
1075  * @op - Pointer to a struct vio_pfo_op for the operation parameters
1076  *
1077  * Calls the hypervisor to synchronously perform the PFO operation
1078  * described in @op.  In the case of a busy response from the hypervisor,
1079  * the operation will be re-submitted indefinitely unless a non-zero timeout
1080  * is specified or an error occurs. The timeout places a limit on when to
1081  * stop re-submitting a operation, the total time can be exceeded if an
1082  * operation is in progress.
1083  *
1084  * If op->hcall_ret is not NULL, this will be set to the return from the
1085  * last h_cop_op call or it will be 0 if an error not involving the h_call
1086  * was encountered.
1087  *
1088  * Returns:
1089  *      0 on success,
1090  *      -EINVAL if the h_call fails due to an invalid parameter,
1091  *      -E2BIG if the h_call can not be performed synchronously,
1092  *      -EBUSY if a timeout is specified and has elapsed,
1093  *      -EACCES if the memory area for data/status has been rescinded, or
1094  *      -EPERM if a hardware fault has been indicated
1095  */
1096 int vio_h_cop_sync(struct vio_dev *vdev, struct vio_pfo_op *op)
1097 {
1098         struct device *dev = &vdev->dev;
1099         unsigned long deadline = 0;
1100         long hret = 0;
1101         int ret = 0;
1102
1103         if (op->timeout)
1104                 deadline = jiffies + msecs_to_jiffies(op->timeout);
1105
1106         while (true) {
1107                 hret = plpar_hcall_norets(H_COP, op->flags,
1108                                 vdev->resource_id,
1109                                 op->in, op->inlen, op->out,
1110                                 op->outlen, op->csbcpb);
1111
1112                 if (hret == H_SUCCESS ||
1113                     (hret != H_NOT_ENOUGH_RESOURCES &&
1114                      hret != H_BUSY && hret != H_RESOURCE) ||
1115                     (op->timeout && time_after(deadline, jiffies)))
1116                         break;
1117
1118                 dev_dbg(dev, "%s: hcall ret(%ld), retrying.\n", __func__, hret);
1119         }
1120
1121         switch (hret) {
1122         case H_SUCCESS:
1123                 ret = 0;
1124                 break;
1125         case H_OP_MODE:
1126         case H_TOO_BIG:
1127                 ret = -E2BIG;
1128                 break;
1129         case H_RESCINDED:
1130                 ret = -EACCES;
1131                 break;
1132         case H_HARDWARE:
1133                 ret = -EPERM;
1134                 break;
1135         case H_NOT_ENOUGH_RESOURCES:
1136         case H_RESOURCE:
1137         case H_BUSY:
1138                 ret = -EBUSY;
1139                 break;
1140         default:
1141                 ret = -EINVAL;
1142                 break;
1143         }
1144
1145         if (ret)
1146                 dev_dbg(dev, "%s: Sync h_cop_op failure (ret:%d) (hret:%ld)\n",
1147                                 __func__, ret, hret);
1148
1149         op->hcall_err = hret;
1150         return ret;
1151 }
1152 EXPORT_SYMBOL(vio_h_cop_sync);
1153
1154 static struct iommu_table *vio_build_iommu_table(struct vio_dev *dev)
1155 {
1156         const unsigned char *dma_window;
1157         struct iommu_table *tbl;
1158         unsigned long offset, size;
1159
1160         dma_window = of_get_property(dev->dev.of_node,
1161                                   "ibm,my-dma-window", NULL);
1162         if (!dma_window)
1163                 return NULL;
1164
1165         tbl = kzalloc(sizeof(*tbl), GFP_KERNEL);
1166         if (tbl == NULL)
1167                 return NULL;
1168
1169         of_parse_dma_window(dev->dev.of_node, dma_window,
1170                             &tbl->it_index, &offset, &size);
1171
1172         /* TCE table size - measured in tce entries */
1173         tbl->it_size = size >> IOMMU_PAGE_SHIFT;
1174         /* offset for VIO should always be 0 */
1175         tbl->it_offset = offset >> IOMMU_PAGE_SHIFT;
1176         tbl->it_busno = 0;
1177         tbl->it_type = TCE_VB;
1178         tbl->it_blocksize = 16;
1179
1180         return iommu_init_table(tbl, -1);
1181 }
1182
1183 /**
1184  * vio_match_device: - Tell if a VIO device has a matching
1185  *                      VIO device id structure.
1186  * @ids:        array of VIO device id structures to search in
1187  * @dev:        the VIO device structure to match against
1188  *
1189  * Used by a driver to check whether a VIO device present in the
1190  * system is in its list of supported devices. Returns the matching
1191  * vio_device_id structure or NULL if there is no match.
1192  */
1193 static const struct vio_device_id *vio_match_device(
1194                 const struct vio_device_id *ids, const struct vio_dev *dev)
1195 {
1196         while (ids->type[0] != '\0') {
1197                 if ((strncmp(dev->type, ids->type, strlen(ids->type)) == 0) &&
1198                     of_device_is_compatible(dev->dev.of_node,
1199                                          ids->compat))
1200                         return ids;
1201                 ids++;
1202         }
1203         return NULL;
1204 }
1205
1206 /*
1207  * Convert from struct device to struct vio_dev and pass to driver.
1208  * dev->driver has already been set by generic code because vio_bus_match
1209  * succeeded.
1210  */
1211 static int vio_bus_probe(struct device *dev)
1212 {
1213         struct vio_dev *viodev = to_vio_dev(dev);
1214         struct vio_driver *viodrv = to_vio_driver(dev->driver);
1215         const struct vio_device_id *id;
1216         int error = -ENODEV;
1217
1218         if (!viodrv->probe)
1219                 return error;
1220
1221         id = vio_match_device(viodrv->id_table, viodev);
1222         if (id) {
1223                 memset(&viodev->cmo, 0, sizeof(viodev->cmo));
1224                 if (firmware_has_feature(FW_FEATURE_CMO)) {
1225                         error = vio_cmo_bus_probe(viodev);
1226                         if (error)
1227                                 return error;
1228                 }
1229                 error = viodrv->probe(viodev, id);
1230                 if (error && firmware_has_feature(FW_FEATURE_CMO))
1231                         vio_cmo_bus_remove(viodev);
1232         }
1233
1234         return error;
1235 }
1236
1237 /* convert from struct device to struct vio_dev and pass to driver. */
1238 static int vio_bus_remove(struct device *dev)
1239 {
1240         struct vio_dev *viodev = to_vio_dev(dev);
1241         struct vio_driver *viodrv = to_vio_driver(dev->driver);
1242         struct device *devptr;
1243         int ret = 1;
1244
1245         /*
1246          * Hold a reference to the device after the remove function is called
1247          * to allow for CMO accounting cleanup for the device.
1248          */
1249         devptr = get_device(dev);
1250
1251         if (viodrv->remove)
1252                 ret = viodrv->remove(viodev);
1253
1254         if (!ret && firmware_has_feature(FW_FEATURE_CMO))
1255                 vio_cmo_bus_remove(viodev);
1256
1257         put_device(devptr);
1258         return ret;
1259 }
1260
1261 /**
1262  * vio_register_driver: - Register a new vio driver
1263  * @viodrv:     The vio_driver structure to be registered.
1264  */
1265 int __vio_register_driver(struct vio_driver *viodrv, struct module *owner,
1266                           const char *mod_name)
1267 {
1268         pr_debug("%s: driver %s registering\n", __func__, viodrv->name);
1269
1270         /* fill in 'struct driver' fields */
1271         viodrv->driver.name = viodrv->name;
1272         viodrv->driver.pm = viodrv->pm;
1273         viodrv->driver.bus = &vio_bus_type;
1274         viodrv->driver.owner = owner;
1275         viodrv->driver.mod_name = mod_name;
1276
1277         return driver_register(&viodrv->driver);
1278 }
1279 EXPORT_SYMBOL(__vio_register_driver);
1280
1281 /**
1282  * vio_unregister_driver - Remove registration of vio driver.
1283  * @viodrv:     The vio_driver struct to be removed form registration
1284  */
1285 void vio_unregister_driver(struct vio_driver *viodrv)
1286 {
1287         driver_unregister(&viodrv->driver);
1288 }
1289 EXPORT_SYMBOL(vio_unregister_driver);
1290
1291 /* vio_dev refcount hit 0 */
1292 static void __devinit vio_dev_release(struct device *dev)
1293 {
1294         struct iommu_table *tbl = get_iommu_table_base(dev);
1295
1296         if (tbl)
1297                 iommu_free_table(tbl, of_node_full_name(dev->of_node));
1298         of_node_put(dev->of_node);
1299         kfree(to_vio_dev(dev));
1300 }
1301
1302 /**
1303  * vio_register_device_node: - Register a new vio device.
1304  * @of_node:    The OF node for this device.
1305  *
1306  * Creates and initializes a vio_dev structure from the data in
1307  * of_node and adds it to the list of virtual devices.
1308  * Returns a pointer to the created vio_dev or NULL if node has
1309  * NULL device_type or compatible fields.
1310  */
1311 struct vio_dev *vio_register_device_node(struct device_node *of_node)
1312 {
1313         struct vio_dev *viodev;
1314         struct device_node *parent_node;
1315         const unsigned int *unit_address;
1316         const unsigned int *pfo_resid = NULL;
1317         enum vio_dev_family family;
1318         const char *of_node_name = of_node->name ? of_node->name : "<unknown>";
1319
1320         /*
1321          * Determine if this node is a under the /vdevice node or under the
1322          * /ibm,platform-facilities node.  This decides the device's family.
1323          */
1324         parent_node = of_get_parent(of_node);
1325         if (parent_node) {
1326                 if (!strcmp(parent_node->full_name, "/ibm,platform-facilities"))
1327                         family = PFO;
1328                 else if (!strcmp(parent_node->full_name, "/vdevice"))
1329                         family = VDEVICE;
1330                 else {
1331                         pr_warn("%s: parent(%s) of %s not recognized.\n",
1332                                         __func__,
1333                                         parent_node->full_name,
1334                                         of_node_name);
1335                         of_node_put(parent_node);
1336                         return NULL;
1337                 }
1338                 of_node_put(parent_node);
1339         } else {
1340                 pr_warn("%s: could not determine the parent of node %s.\n",
1341                                 __func__, of_node_name);
1342                 return NULL;
1343         }
1344
1345         if (family == PFO) {
1346                 if (of_get_property(of_node, "interrupt-controller", NULL)) {
1347                         pr_debug("%s: Skipping the interrupt controller %s.\n",
1348                                         __func__, of_node_name);
1349                         return NULL;
1350                 }
1351         }
1352
1353         /* allocate a vio_dev for this node */
1354         viodev = kzalloc(sizeof(struct vio_dev), GFP_KERNEL);
1355         if (viodev == NULL) {
1356                 pr_warn("%s: allocation failure for VIO device.\n", __func__);
1357                 return NULL;
1358         }
1359
1360         /* we need the 'device_type' property, in order to match with drivers */
1361         viodev->family = family;
1362         if (viodev->family == VDEVICE) {
1363                 if (of_node->type != NULL)
1364                         viodev->type = of_node->type;
1365                 else {
1366                         pr_warn("%s: node %s is missing the 'device_type' "
1367                                         "property.\n", __func__, of_node_name);
1368                         goto out;
1369                 }
1370
1371                 unit_address = of_get_property(of_node, "reg", NULL);
1372                 if (unit_address == NULL) {
1373                         pr_warn("%s: node %s missing 'reg'\n",
1374                                         __func__, of_node_name);
1375                         goto out;
1376                 }
1377                 dev_set_name(&viodev->dev, "%x", *unit_address);
1378                 viodev->irq = irq_of_parse_and_map(of_node, 0);
1379                 viodev->unit_address = *unit_address;
1380         } else {
1381                 /* PFO devices need their resource_id for submitting COP_OPs
1382                  * This is an optional field for devices, but is required when
1383                  * performing synchronous ops */
1384                 pfo_resid = of_get_property(of_node, "ibm,resource-id", NULL);
1385                 if (pfo_resid != NULL)
1386                         viodev->resource_id = *pfo_resid;
1387
1388                 unit_address = NULL;
1389                 dev_set_name(&viodev->dev, "%s", of_node_name);
1390                 viodev->type = of_node_name;
1391                 viodev->irq = 0;
1392         }
1393
1394         viodev->name = of_node->name;
1395         viodev->dev.of_node = of_node_get(of_node);
1396
1397         set_dev_node(&viodev->dev, of_node_to_nid(of_node));
1398
1399         /* init generic 'struct device' fields: */
1400         viodev->dev.parent = &vio_bus_device.dev;
1401         viodev->dev.bus = &vio_bus_type;
1402         viodev->dev.release = vio_dev_release;
1403
1404         if (of_get_property(viodev->dev.of_node, "ibm,my-dma-window", NULL)) {
1405                 if (firmware_has_feature(FW_FEATURE_CMO))
1406                         vio_cmo_set_dma_ops(viodev);
1407                 else
1408                         set_dma_ops(&viodev->dev, &dma_iommu_ops);
1409
1410                 set_iommu_table_base(&viodev->dev,
1411                                      vio_build_iommu_table(viodev));
1412
1413                 /* needed to ensure proper operation of coherent allocations
1414                  * later, in case driver doesn't set it explicitly */
1415                 dma_set_mask(&viodev->dev, DMA_BIT_MASK(64));
1416                 dma_set_coherent_mask(&viodev->dev, DMA_BIT_MASK(64));
1417         }
1418
1419         /* register with generic device framework */
1420         if (device_register(&viodev->dev)) {
1421                 printk(KERN_ERR "%s: failed to register device %s\n",
1422                                 __func__, dev_name(&viodev->dev));
1423                 put_device(&viodev->dev);
1424                 return NULL;
1425         }
1426
1427         return viodev;
1428
1429 out:    /* Use this exit point for any return prior to device_register */
1430         kfree(viodev);
1431
1432         return NULL;
1433 }
1434 EXPORT_SYMBOL(vio_register_device_node);
1435
1436 /*
1437  * vio_bus_scan_for_devices - Scan OF and register each child device
1438  * @root_name - OF node name for the root of the subtree to search.
1439  *              This must be non-NULL
1440  *
1441  * Starting from the root node provide, register the device node for
1442  * each child beneath the root.
1443  */
1444 static void vio_bus_scan_register_devices(char *root_name)
1445 {
1446         struct device_node *node_root, *node_child;
1447
1448         if (!root_name)
1449                 return;
1450
1451         node_root = of_find_node_by_name(NULL, root_name);
1452         if (node_root) {
1453
1454                 /*
1455                  * Create struct vio_devices for each virtual device in
1456                  * the device tree. Drivers will associate with them later.
1457                  */
1458                 node_child = of_get_next_child(node_root, NULL);
1459                 while (node_child) {
1460                         vio_register_device_node(node_child);
1461                         node_child = of_get_next_child(node_root, node_child);
1462                 }
1463                 of_node_put(node_root);
1464         }
1465 }
1466
1467 /**
1468  * vio_bus_init: - Initialize the virtual IO bus
1469  */
1470 static int __init vio_bus_init(void)
1471 {
1472         int err;
1473
1474         if (firmware_has_feature(FW_FEATURE_CMO))
1475                 vio_cmo_sysfs_init();
1476
1477         err = bus_register(&vio_bus_type);
1478         if (err) {
1479                 printk(KERN_ERR "failed to register VIO bus\n");
1480                 return err;
1481         }
1482
1483         /*
1484          * The fake parent of all vio devices, just to give us
1485          * a nice directory
1486          */
1487         err = device_register(&vio_bus_device.dev);
1488         if (err) {
1489                 printk(KERN_WARNING "%s: device_register returned %i\n",
1490                                 __func__, err);
1491                 return err;
1492         }
1493
1494         if (firmware_has_feature(FW_FEATURE_CMO))
1495                 vio_cmo_bus_init();
1496
1497         return 0;
1498 }
1499 postcore_initcall(vio_bus_init);
1500
1501 static int __init vio_device_init(void)
1502 {
1503         vio_bus_scan_register_devices("vdevice");
1504         vio_bus_scan_register_devices("ibm,platform-facilities");
1505
1506         return 0;
1507 }
1508 device_initcall(vio_device_init);
1509
1510 static ssize_t name_show(struct device *dev,
1511                 struct device_attribute *attr, char *buf)
1512 {
1513         return sprintf(buf, "%s\n", to_vio_dev(dev)->name);
1514 }
1515
1516 static ssize_t devspec_show(struct device *dev,
1517                 struct device_attribute *attr, char *buf)
1518 {
1519         struct device_node *of_node = dev->of_node;
1520
1521         return sprintf(buf, "%s\n", of_node_full_name(of_node));
1522 }
1523
1524 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
1525                              char *buf)
1526 {
1527         const struct vio_dev *vio_dev = to_vio_dev(dev);
1528         struct device_node *dn;
1529         const char *cp;
1530
1531         dn = dev->of_node;
1532         if (!dn)
1533                 return -ENODEV;
1534         cp = of_get_property(dn, "compatible", NULL);
1535         if (!cp)
1536                 return -ENODEV;
1537
1538         return sprintf(buf, "vio:T%sS%s\n", vio_dev->type, cp);
1539 }
1540
1541 static struct device_attribute vio_dev_attrs[] = {
1542         __ATTR_RO(name),
1543         __ATTR_RO(devspec),
1544         __ATTR_RO(modalias),
1545         __ATTR_NULL
1546 };
1547
1548 void __devinit vio_unregister_device(struct vio_dev *viodev)
1549 {
1550         device_unregister(&viodev->dev);
1551 }
1552 EXPORT_SYMBOL(vio_unregister_device);
1553
1554 static int vio_bus_match(struct device *dev, struct device_driver *drv)
1555 {
1556         const struct vio_dev *vio_dev = to_vio_dev(dev);
1557         struct vio_driver *vio_drv = to_vio_driver(drv);
1558         const struct vio_device_id *ids = vio_drv->id_table;
1559
1560         return (ids != NULL) && (vio_match_device(ids, vio_dev) != NULL);
1561 }
1562
1563 static int vio_hotplug(struct device *dev, struct kobj_uevent_env *env)
1564 {
1565         const struct vio_dev *vio_dev = to_vio_dev(dev);
1566         struct device_node *dn;
1567         const char *cp;
1568
1569         dn = dev->of_node;
1570         if (!dn)
1571                 return -ENODEV;
1572         cp = of_get_property(dn, "compatible", NULL);
1573         if (!cp)
1574                 return -ENODEV;
1575
1576         add_uevent_var(env, "MODALIAS=vio:T%sS%s", vio_dev->type, cp);
1577         return 0;
1578 }
1579
1580 struct bus_type vio_bus_type = {
1581         .name = "vio",
1582         .dev_attrs = vio_dev_attrs,
1583         .uevent = vio_hotplug,
1584         .match = vio_bus_match,
1585         .probe = vio_bus_probe,
1586         .remove = vio_bus_remove,
1587 };
1588
1589 /**
1590  * vio_get_attribute: - get attribute for virtual device
1591  * @vdev:       The vio device to get property.
1592  * @which:      The property/attribute to be extracted.
1593  * @length:     Pointer to length of returned data size (unused if NULL).
1594  *
1595  * Calls prom.c's of_get_property() to return the value of the
1596  * attribute specified by @which
1597 */
1598 const void *vio_get_attribute(struct vio_dev *vdev, char *which, int *length)
1599 {
1600         return of_get_property(vdev->dev.of_node, which, length);
1601 }
1602 EXPORT_SYMBOL(vio_get_attribute);
1603
1604 #ifdef CONFIG_PPC_PSERIES
1605 /* vio_find_name() - internal because only vio.c knows how we formatted the
1606  * kobject name
1607  */
1608 static struct vio_dev *vio_find_name(const char *name)
1609 {
1610         struct device *found;
1611
1612         found = bus_find_device_by_name(&vio_bus_type, NULL, name);
1613         if (!found)
1614                 return NULL;
1615
1616         return to_vio_dev(found);
1617 }
1618
1619 /**
1620  * vio_find_node - find an already-registered vio_dev
1621  * @vnode: device_node of the virtual device we're looking for
1622  */
1623 struct vio_dev *vio_find_node(struct device_node *vnode)
1624 {
1625         const uint32_t *unit_address;
1626         char kobj_name[20];
1627         struct device_node *vnode_parent;
1628         const char *dev_type;
1629
1630         vnode_parent = of_get_parent(vnode);
1631         if (!vnode_parent)
1632                 return NULL;
1633
1634         dev_type = of_get_property(vnode_parent, "device_type", NULL);
1635         of_node_put(vnode_parent);
1636         if (!dev_type)
1637                 return NULL;
1638
1639         /* construct the kobject name from the device node */
1640         if (!strcmp(dev_type, "vdevice")) {
1641                 unit_address = of_get_property(vnode, "reg", NULL);
1642                 if (!unit_address)
1643                         return NULL;
1644                 snprintf(kobj_name, sizeof(kobj_name), "%x", *unit_address);
1645         } else if (!strcmp(dev_type, "ibm,platform-facilities"))
1646                 snprintf(kobj_name, sizeof(kobj_name), "%s", vnode->name);
1647         else
1648                 return NULL;
1649
1650         return vio_find_name(kobj_name);
1651 }
1652 EXPORT_SYMBOL(vio_find_node);
1653
1654 int vio_enable_interrupts(struct vio_dev *dev)
1655 {
1656         int rc = h_vio_signal(dev->unit_address, VIO_IRQ_ENABLE);
1657         if (rc != H_SUCCESS)
1658                 printk(KERN_ERR "vio: Error 0x%x enabling interrupts\n", rc);
1659         return rc;
1660 }
1661 EXPORT_SYMBOL(vio_enable_interrupts);
1662
1663 int vio_disable_interrupts(struct vio_dev *dev)
1664 {
1665         int rc = h_vio_signal(dev->unit_address, VIO_IRQ_DISABLE);
1666         if (rc != H_SUCCESS)
1667                 printk(KERN_ERR "vio: Error 0x%x disabling interrupts\n", rc);
1668         return rc;
1669 }
1670 EXPORT_SYMBOL(vio_disable_interrupts);
1671 #endif /* CONFIG_PPC_PSERIES */