drivers/iommu/iommu.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Copyright (C) 2007-2008 Advanced Micro Devices, Inc.
   4  * Author: Joerg Roedel <jroedel@suse.de>
   5  */
   6
   7 #define pr_fmt(fmt)    "iommu: " fmt
   8
   9 #include <linux/device.h>
  10 #include <linux/kernel.h>
  11 #include <linux/bug.h>
  12 #include <linux/types.h>
  13 #include <linux/init.h>
  14 #include <linux/export.h>
  15 #include <linux/slab.h>
  16 #include <linux/errno.h>
  17 #include <linux/iommu.h>
  18 #include <linux/idr.h>
  19 #include <linux/notifier.h>
  20 #include <linux/err.h>
  21 #include <linux/pci.h>
  22 #include <linux/bitops.h>
  23 #include <linux/property.h>
  24 #include <linux/fsl/mc.h>
  25 #include <trace/events/iommu.h>
  26
  27 static struct kset *iommu_group_kset;
  28 static DEFINE_IDA(iommu_group_ida);
  29
  30 static unsigned int iommu_def_domain_type __read_mostly;
  31 static bool iommu_dma_strict __read_mostly = true;
  32 static u32 iommu_cmd_line __read_mostly;
  33
  34 struct iommu_group {
  35         struct kobject kobj;
  36         struct kobject *devices_kobj;
  37         struct list_head devices;
  38         struct mutex mutex;
  39         struct blocking_notifier_head notifier;
  40         void *iommu_data;
  41         void (*iommu_data_release)(void *iommu_data);
  42         char *name;
  43         int id;
  44         struct iommu_domain *default_domain;
  45         struct iommu_domain *domain;
  46 };
  47
  48 struct group_device {
  49         struct list_head list;
  50         struct device *dev;
  51         char *name;
  52 };
  53
  54 struct iommu_group_attribute {
  55         struct attribute attr;
  56         ssize_t (*show)(struct iommu_group *group, char *buf);
  57         ssize_t (*store)(struct iommu_group *group,
  58                          const char *buf, size_t count);
  59 };
  60
  61 static const char * const iommu_group_resv_type_string[] = {
  62         [IOMMU_RESV_DIRECT]                     = "direct",
  63         [IOMMU_RESV_DIRECT_RELAXABLE]           = "direct-relaxable",
  64         [IOMMU_RESV_RESERVED]                   = "reserved",
  65         [IOMMU_RESV_MSI]                        = "msi",
  66         [IOMMU_RESV_SW_MSI]                     = "msi",
  67 };
  68
  69 #define IOMMU_CMD_LINE_DMA_API          BIT(0)
  70
  71 static void iommu_set_cmd_line_dma_api(void)
  72 {
  73         iommu_cmd_line |= IOMMU_CMD_LINE_DMA_API;
  74 }
  75
  76 static bool iommu_cmd_line_dma_api(void)
  77 {
  78         return !!(iommu_cmd_line & IOMMU_CMD_LINE_DMA_API);
  79 }
  80
  81 #define IOMMU_GROUP_ATTR(_name, _mode, _show, _store)           \
  82 struct iommu_group_attribute iommu_group_attr_##_name =         \
  83         __ATTR(_name, _mode, _show, _store)
  84
  85 #define to_iommu_group_attr(_attr)      \
  86         container_of(_attr, struct iommu_group_attribute, attr)
  87 #define to_iommu_group(_kobj)           \
  88         container_of(_kobj, struct iommu_group, kobj)
  89
  90 static LIST_HEAD(iommu_device_list);
  91 static DEFINE_SPINLOCK(iommu_device_lock);
  92
  93 /*
  94  * Use a function instead of an array here because the domain-type is a
  95  * bit-field, so an array would waste memory.
  96  */
  97 static const char *iommu_domain_type_str(unsigned int t)
  98 {
  99         switch (t) {
 100         case IOMMU_DOMAIN_BLOCKED:
 101                 return "Blocked";
 102         case IOMMU_DOMAIN_IDENTITY:
 103                 return "Passthrough";
 104         case IOMMU_DOMAIN_UNMANAGED:
 105                 return "Unmanaged";
 106         case IOMMU_DOMAIN_DMA:
 107                 return "Translated";
 108         default:
 109                 return "Unknown";
 110         }
 111 }
 112
 113 static int __init iommu_subsys_init(void)
 114 {
 115         bool cmd_line = iommu_cmd_line_dma_api();
 116
 117         if (!cmd_line) {
 118                 if (IS_ENABLED(CONFIG_IOMMU_DEFAULT_PASSTHROUGH))
 119                         iommu_set_default_passthrough(false);
 120                 else
 121                         iommu_set_default_translated(false);
 122
 123                 if (iommu_default_passthrough() && mem_encrypt_active()) {
 124                         pr_info("Memory encryption detected - Disabling default IOMMU Passthrough\n");
 125                         iommu_set_default_translated(false);
 126                 }
 127         }
 128
 129         pr_info("Default domain type: %s %s\n",
 130                 iommu_domain_type_str(iommu_def_domain_type),
 131                 cmd_line ? "(set via kernel command line)" : "");
 132
 133         return 0;
 134 }
 135 subsys_initcall(iommu_subsys_init);
 136
 137 int iommu_device_register(struct iommu_device *iommu)
 138 {
 139         spin_lock(&iommu_device_lock);
 140         list_add_tail(&iommu->list, &iommu_device_list);
 141         spin_unlock(&iommu_device_lock);
 142         return 0;
 143 }
 144
 145 void iommu_device_unregister(struct iommu_device *iommu)
 146 {
 147         spin_lock(&iommu_device_lock);
 148         list_del(&iommu->list);
 149         spin_unlock(&iommu_device_lock);
 150 }
 151
 152 static struct iommu_param *iommu_get_dev_param(struct device *dev)
 153 {
 154         struct iommu_param *param = dev->iommu_param;
 155
 156         if (param)
 157                 return param;
 158
 159         param = kzalloc(sizeof(*param), GFP_KERNEL);
 160         if (!param)
 161                 return NULL;
 162
 163         mutex_init(&param->lock);
 164         dev->iommu_param = param;
 165         return param;
 166 }
 167
 168 static void iommu_free_dev_param(struct device *dev)
 169 {
 170         kfree(dev->iommu_param);
 171         dev->iommu_param = NULL;
 172 }
 173
 174 int iommu_probe_device(struct device *dev)
 175 {
 176         const struct iommu_ops *ops = dev->bus->iommu_ops;
 177         int ret;
 178
 179         WARN_ON(dev->iommu_group);
 180         if (!ops)
 181                 return -EINVAL;
 182
 183         if (!iommu_get_dev_param(dev))
 184                 return -ENOMEM;
 185
 186         ret = ops->add_device(dev);
 187         if (ret)
 188                 iommu_free_dev_param(dev);
 189
 190         return ret;
 191 }
 192
 193 void iommu_release_device(struct device *dev)
 194 {
 195         const struct iommu_ops *ops = dev->bus->iommu_ops;
 196
 197         if (dev->iommu_group)
 198                 ops->remove_device(dev);
 199
 200         iommu_free_dev_param(dev);
 201 }
 202
 203 static struct iommu_domain *__iommu_domain_alloc(struct bus_type *bus,
 204                                                  unsigned type);
 205 static int __iommu_attach_device(struct iommu_domain *domain,
 206                                  struct device *dev);
 207 static int __iommu_attach_group(struct iommu_domain *domain,
 208                                 struct iommu_group *group);
 209 static void __iommu_detach_group(struct iommu_domain *domain,
 210                                  struct iommu_group *group);
 211
 212 static int __init iommu_set_def_domain_type(char *str)
 213 {
 214         bool pt;
 215         int ret;
 216
 217         ret = kstrtobool(str, &pt);
 218         if (ret)
 219                 return ret;
 220
 221         if (pt)
 222                 iommu_set_default_passthrough(true);
 223         else
 224                 iommu_set_default_translated(true);
 225
 226         return 0;
 227 }
 228 early_param("iommu.passthrough", iommu_set_def_domain_type);
 229
 230 static int __init iommu_dma_setup(char *str)
 231 {
 232         return kstrtobool(str, &iommu_dma_strict);
 233 }
 234 early_param("iommu.strict", iommu_dma_setup);
 235
 236 static ssize_t iommu_group_attr_show(struct kobject *kobj,
 237                                      struct attribute *__attr, char *buf)
 238 {
 239         struct iommu_group_attribute *attr = to_iommu_group_attr(__attr);
 240         struct iommu_group *group = to_iommu_group(kobj);
 241         ssize_t ret = -EIO;
 242
 243         if (attr->show)
 244                 ret = attr->show(group, buf);
 245         return ret;
 246 }
 247
 248 static ssize_t iommu_group_attr_store(struct kobject *kobj,
 249                                       struct attribute *__attr,
 250                                       const char *buf, size_t count)
 251 {
 252         struct iommu_group_attribute *attr = to_iommu_group_attr(__attr);
 253         struct iommu_group *group = to_iommu_group(kobj);
 254         ssize_t ret = -EIO;
 255
 256         if (attr->store)
 257                 ret = attr->store(group, buf, count);
 258         return ret;
 259 }
 260
 261 static const struct sysfs_ops iommu_group_sysfs_ops = {
 262         .show = iommu_group_attr_show,
 263         .store = iommu_group_attr_store,
 264 };
 265
 266 static int iommu_group_create_file(struct iommu_group *group,
 267                                    struct iommu_group_attribute *attr)
 268 {
 269         return sysfs_create_file(&group->kobj, &attr->attr);
 270 }
 271
 272 static void iommu_group_remove_file(struct iommu_group *group,
 273                                     struct iommu_group_attribute *attr)
 274 {
 275         sysfs_remove_file(&group->kobj, &attr->attr);
 276 }
 277
 278 static ssize_t iommu_group_show_name(struct iommu_group *group, char *buf)
 279 {
 280         return sprintf(buf, "%s\n", group->name);
 281 }
 282
 283 /**
 284  * iommu_insert_resv_region - Insert a new region in the
 285  * list of reserved regions.
 286  * @new: new region to insert
 287  * @regions: list of regions
 288  *
 289  * Elements are sorted by start address and overlapping segments
 290  * of the same type are merged.
 291  */
 292 int iommu_insert_resv_region(struct iommu_resv_region *new,
 293                              struct list_head *regions)
 294 {
 295         struct iommu_resv_region *iter, *tmp, *nr, *top;
 296         LIST_HEAD(stack);
 297
 298         nr = iommu_alloc_resv_region(new->start, new->length,
 299                                      new->prot, new->type);
 300         if (!nr)
 301                 return -ENOMEM;
 302
 303         /* First add the new element based on start address sorting */
 304         list_for_each_entry(iter, regions, list) {
 305                 if (nr->start < iter->start ||
 306                     (nr->start == iter->start && nr->type <= iter->type))
 307                         break;
 308         }
 309         list_add_tail(&nr->list, &iter->list);
 310
 311         /* Merge overlapping segments of type nr->type in @regions, if any */
 312         list_for_each_entry_safe(iter, tmp, regions, list) {
 313                 phys_addr_t top_end, iter_end = iter->start + iter->length - 1;
 314
 315                 /* no merge needed on elements of different types than @new */
 316                 if (iter->type != new->type) {
 317                         list_move_tail(&iter->list, &stack);
 318                         continue;
 319                 }
 320
 321                 /* look for the last stack element of same type as @iter */
 322                 list_for_each_entry_reverse(top, &stack, list)
 323                         if (top->type == iter->type)
 324                                 goto check_overlap;
 325
 326                 list_move_tail(&iter->list, &stack);
 327                 continue;
 328
 329 check_overlap:
 330                 top_end = top->start + top->length - 1;
 331
 332                 if (iter->start > top_end + 1) {
 333                         list_move_tail(&iter->list, &stack);
 334                 } else {
 335                         top->length = max(top_end, iter_end) - top->start + 1;
 336                         list_del(&iter->list);
 337                         kfree(iter);
 338                 }
 339         }
 340         list_splice(&stack, regions);
 341         return 0;
 342 }
 343
 344 static int
 345 iommu_insert_device_resv_regions(struct list_head *dev_resv_regions,
 346                                  struct list_head *group_resv_regions)
 347 {
 348         struct iommu_resv_region *entry;
 349         int ret = 0;
 350
 351         list_for_each_entry(entry, dev_resv_regions, list) {
 352                 ret = iommu_insert_resv_region(entry, group_resv_regions);
 353                 if (ret)
 354                         break;
 355         }
 356         return ret;
 357 }
 358
 359 int iommu_get_group_resv_regions(struct iommu_group *group,
 360                                  struct list_head *head)
 361 {
 362         struct group_device *device;
 363         int ret = 0;
 364
 365         mutex_lock(&group->mutex);
 366         list_for_each_entry(device, &group->devices, list) {
 367                 struct list_head dev_resv_regions;
 368
 369                 INIT_LIST_HEAD(&dev_resv_regions);
 370                 iommu_get_resv_regions(device->dev, &dev_resv_regions);
 371                 ret = iommu_insert_device_resv_regions(&dev_resv_regions, head);
 372                 iommu_put_resv_regions(device->dev, &dev_resv_regions);
 373                 if (ret)
 374                         break;
 375         }
 376         mutex_unlock(&group->mutex);
 377         return ret;
 378 }
 379 EXPORT_SYMBOL_GPL(iommu_get_group_resv_regions);
 380
 381 static ssize_t iommu_group_show_resv_regions(struct iommu_group *group,
 382                                              char *buf)
 383 {
 384         struct iommu_resv_region *region, *next;
 385         struct list_head group_resv_regions;
 386         char *str = buf;
 387
 388         INIT_LIST_HEAD(&group_resv_regions);
 389         iommu_get_group_resv_regions(group, &group_resv_regions);
 390
 391         list_for_each_entry_safe(region, next, &group_resv_regions, list) {
 392                 str += sprintf(str, "0x%016llx 0x%016llx %s\n",
 393                                (long long int)region->start,
 394                                (long long int)(region->start +
 395                                                 region->length - 1),
 396                                iommu_group_resv_type_string[region->type]);
 397                 kfree(region);
 398         }
 399
 400         return (str - buf);
 401 }
 402
 403 static ssize_t iommu_group_show_type(struct iommu_group *group,
 404                                      char *buf)
 405 {
 406         char *type = "unknown\n";
 407
 408         if (group->default_domain) {
 409                 switch (group->default_domain->type) {
 410                 case IOMMU_DOMAIN_BLOCKED:
 411                         type = "blocked\n";
 412                         break;
 413                 case IOMMU_DOMAIN_IDENTITY:
 414                         type = "identity\n";
 415                         break;
 416                 case IOMMU_DOMAIN_UNMANAGED:
 417                         type = "unmanaged\n";
 418                         break;
 419                 case IOMMU_DOMAIN_DMA:
 420                         type = "DMA\n";
 421                         break;
 422                 }
 423         }
 424         strcpy(buf, type);
 425
 426         return strlen(type);
 427 }
 428
 429 static IOMMU_GROUP_ATTR(name, S_IRUGO, iommu_group_show_name, NULL);
 430
 431 static IOMMU_GROUP_ATTR(reserved_regions, 0444,
 432                         iommu_group_show_resv_regions, NULL);
 433
 434 static IOMMU_GROUP_ATTR(type, 0444, iommu_group_show_type, NULL);
 435
 436 static void iommu_group_release(struct kobject *kobj)
 437 {
 438         struct iommu_group *group = to_iommu_group(kobj);
 439
 440         pr_debug("Releasing group %d\n", group->id);
 441
 442         if (group->iommu_data_release)
 443                 group->iommu_data_release(group->iommu_data);
 444
 445         ida_simple_remove(&iommu_group_ida, group->id);
 446
 447         if (group->default_domain)
 448                 iommu_domain_free(group->default_domain);
 449
 450         kfree(group->name);
 451         kfree(group);
 452 }
 453
 454 static struct kobj_type iommu_group_ktype = {
 455         .sysfs_ops = &iommu_group_sysfs_ops,
 456         .release = iommu_group_release,
 457 };
 458
 459 /**
 460  * iommu_group_alloc - Allocate a new group
 461  *
 462  * This function is called by an iommu driver to allocate a new iommu
 463  * group.  The iommu group represents the minimum granularity of the iommu.
 464  * Upon successful return, the caller holds a reference to the supplied
 465  * group in order to hold the group until devices are added.  Use
 466  * iommu_group_put() to release this extra reference count, allowing the
 467  * group to be automatically reclaimed once it has no devices or external
 468  * references.
 469  */
 470 struct iommu_group *iommu_group_alloc(void)
 471 {
 472         struct iommu_group *group;
 473         int ret;
 474
 475         group = kzalloc(sizeof(*group), GFP_KERNEL);
 476         if (!group)
 477                 return ERR_PTR(-ENOMEM);
 478
 479         group->kobj.kset = iommu_group_kset;
 480         mutex_init(&group->mutex);
 481         INIT_LIST_HEAD(&group->devices);
 482         BLOCKING_INIT_NOTIFIER_HEAD(&group->notifier);
 483
 484         ret = ida_simple_get(&iommu_group_ida, 0, 0, GFP_KERNEL);
 485         if (ret < 0) {
 486                 kfree(group);
 487                 return ERR_PTR(ret);
 488         }
 489         group->id = ret;
 490
 491         ret = kobject_init_and_add(&group->kobj, &iommu_group_ktype,
 492                                    NULL, "%d", group->id);
 493         if (ret) {
 494                 ida_simple_remove(&iommu_group_ida, group->id);
 495                 kobject_put(&group->kobj);
 496                 return ERR_PTR(ret);
 497         }
 498
 499         group->devices_kobj = kobject_create_and_add("devices", &group->kobj);
 500         if (!group->devices_kobj) {
 501                 kobject_put(&group->kobj); /* triggers .release & free */
 502                 return ERR_PTR(-ENOMEM);
 503         }
 504
 505         /*
 506          * The devices_kobj holds a reference on the group kobject, so
 507          * as long as that exists so will the group.  We can therefore
 508          * use the devices_kobj for reference counting.
 509          */
 510         kobject_put(&group->kobj);
 511
 512         ret = iommu_group_create_file(group,
 513                                       &iommu_group_attr_reserved_regions);
 514         if (ret)
 515                 return ERR_PTR(ret);
 516
 517         ret = iommu_group_create_file(group, &iommu_group_attr_type);
 518         if (ret)
 519                 return ERR_PTR(ret);
 520
 521         pr_debug("Allocated group %d\n", group->id);
 522
 523         return group;
 524 }
 525 EXPORT_SYMBOL_GPL(iommu_group_alloc);
 526
 527 struct iommu_group *iommu_group_get_by_id(int id)
 528 {
 529         struct kobject *group_kobj;
 530         struct iommu_group *group;
 531         const char *name;
 532
 533         if (!iommu_group_kset)
 534                 return NULL;
 535
 536         name = kasprintf(GFP_KERNEL, "%d", id);
 537         if (!name)
 538                 return NULL;
 539
 540         group_kobj = kset_find_obj(iommu_group_kset, name);
 541         kfree(name);
 542
 543         if (!group_kobj)
 544                 return NULL;
 545
 546         group = container_of(group_kobj, struct iommu_group, kobj);
 547         BUG_ON(group->id != id);
 548
 549         kobject_get(group->devices_kobj);
 550         kobject_put(&group->kobj);
 551
 552         return group;
 553 }
 554 EXPORT_SYMBOL_GPL(iommu_group_get_by_id);
 555
 556 /**
 557  * iommu_group_get_iommudata - retrieve iommu_data registered for a group
 558  * @group: the group
 559  *
 560  * iommu drivers can store data in the group for use when doing iommu
 561  * operations.  This function provides a way to retrieve it.  Caller
 562  * should hold a group reference.
 563  */
 564 void *iommu_group_get_iommudata(struct iommu_group *group)
 565 {
 566         return group->iommu_data;
 567 }
 568 EXPORT_SYMBOL_GPL(iommu_group_get_iommudata);
 569
 570 /**
 571  * iommu_group_set_iommudata - set iommu_data for a group
 572  * @group: the group
 573  * @iommu_data: new data
 574  * @release: release function for iommu_data
 575  *
 576  * iommu drivers can store data in the group for use when doing iommu
 577  * operations.  This function provides a way to set the data after
 578  * the group has been allocated.  Caller should hold a group reference.
 579  */
 580 void iommu_group_set_iommudata(struct iommu_group *group, void *iommu_data,
 581                                void (*release)(void *iommu_data))
 582 {
 583         group->iommu_data = iommu_data;
 584         group->iommu_data_release = release;
 585 }
 586 EXPORT_SYMBOL_GPL(iommu_group_set_iommudata);
 587
 588 /**
 589  * iommu_group_set_name - set name for a group
 590  * @group: the group
 591  * @name: name
 592  *
 593  * Allow iommu driver to set a name for a group.  When set it will
 594  * appear in a name attribute file under the group in sysfs.
 595  */
 596 int iommu_group_set_name(struct iommu_group *group, const char *name)
 597 {
 598         int ret;
 599
 600         if (group->name) {
 601                 iommu_group_remove_file(group, &iommu_group_attr_name);
 602                 kfree(group->name);
 603                 group->name = NULL;
 604                 if (!name)
 605                         return 0;
 606         }
 607
 608         group->name = kstrdup(name, GFP_KERNEL);
 609         if (!group->name)
 610                 return -ENOMEM;
 611
 612         ret = iommu_group_create_file(group, &iommu_group_attr_name);
 613         if (ret) {
 614                 kfree(group->name);
 615                 group->name = NULL;
 616                 return ret;
 617         }
 618
 619         return 0;
 620 }
 621 EXPORT_SYMBOL_GPL(iommu_group_set_name);
 622
 623 static int iommu_group_create_direct_mappings(struct iommu_group *group,
 624                                               struct device *dev)
 625 {
 626         struct iommu_domain *domain = group->default_domain;
 627         struct iommu_resv_region *entry;
 628         struct list_head mappings;
 629         unsigned long pg_size;
 630         int ret = 0;
 631
 632         if (!domain || domain->type != IOMMU_DOMAIN_DMA)
 633                 return 0;
 634
 635         BUG_ON(!domain->pgsize_bitmap);
 636
 637         pg_size = 1UL << __ffs(domain->pgsize_bitmap);
 638         INIT_LIST_HEAD(&mappings);
 639
 640         iommu_get_resv_regions(dev, &mappings);
 641
 642         /* We need to consider overlapping regions for different devices */
 643         list_for_each_entry(entry, &mappings, list) {
 644                 dma_addr_t start, end, addr;
 645
 646                 if (domain->ops->apply_resv_region)
 647                         domain->ops->apply_resv_region(dev, domain, entry);
 648
 649                 start = ALIGN(entry->start, pg_size);
 650                 end   = ALIGN(entry->start + entry->length, pg_size);
 651
 652                 if (entry->type != IOMMU_RESV_DIRECT &&
 653                     entry->type != IOMMU_RESV_DIRECT_RELAXABLE)
 654                         continue;
 655
 656                 for (addr = start; addr < end; addr += pg_size) {
 657                         phys_addr_t phys_addr;
 658
 659                         phys_addr = iommu_iova_to_phys(domain, addr);
 660                         if (phys_addr)
 661                                 continue;
 662
 663                         ret = iommu_map(domain, addr, addr, pg_size, entry->prot);
 664                         if (ret)
 665                                 goto out;
 666                 }
 667
 668         }
 669
 670         iommu_flush_tlb_all(domain);
 671
 672 out:
 673         iommu_put_resv_regions(dev, &mappings);
 674
 675         return ret;
 676 }
 677
 678 /**
 679  * iommu_group_add_device - add a device to an iommu group
 680  * @group: the group into which to add the device (reference should be held)
 681  * @dev: the device
 682  *
 683  * This function is called by an iommu driver to add a device into a
 684  * group.  Adding a device increments the group reference count.
 685  */
 686 int iommu_group_add_device(struct iommu_group *group, struct device *dev)
 687 {
 688         int ret, i = 0;
 689         struct group_device *device;
 690
 691         device = kzalloc(sizeof(*device), GFP_KERNEL);
 692         if (!device)
 693                 return -ENOMEM;
 694
 695         device->dev = dev;
 696
 697         ret = sysfs_create_link(&dev->kobj, &group->kobj, "iommu_group");
 698         if (ret)
 699                 goto err_free_device;
 700
 701         device->name = kasprintf(GFP_KERNEL, "%s", kobject_name(&dev->kobj));
 702 rename:
 703         if (!device->name) {
 704                 ret = -ENOMEM;
 705                 goto err_remove_link;
 706         }
 707
 708         ret = sysfs_create_link_nowarn(group->devices_kobj,
 709                                        &dev->kobj, device->name);
 710         if (ret) {
 711                 if (ret == -EEXIST && i >= 0) {
 712                         /*
 713                          * Account for the slim chance of collision
 714                          * and append an instance to the name.
 715                          */
 716                         kfree(device->name);
 717                         device->name = kasprintf(GFP_KERNEL, "%s.%d",
 718                                                  kobject_name(&dev->kobj), i++);
 719                         goto rename;
 720                 }
 721                 goto err_free_name;
 722         }
 723
 724         kobject_get(group->devices_kobj);
 725
 726         dev->iommu_group = group;
 727
 728         iommu_group_create_direct_mappings(group, dev);
 729
 730         mutex_lock(&group->mutex);
 731         list_add_tail(&device->list, &group->devices);
 732         if (group->domain)
 733                 ret = __iommu_attach_device(group->domain, dev);
 734         mutex_unlock(&group->mutex);
 735         if (ret)
 736                 goto err_put_group;
 737
 738         /* Notify any listeners about change to group. */
 739         blocking_notifier_call_chain(&group->notifier,
 740                                      IOMMU_GROUP_NOTIFY_ADD_DEVICE, dev);
 741
 742         trace_add_device_to_group(group->id, dev);
 743
 744         dev_info(dev, "Adding to iommu group %d\n", group->id);
 745
 746         return 0;
 747
 748 err_put_group:
 749         mutex_lock(&group->mutex);
 750         list_del(&device->list);
 751         mutex_unlock(&group->mutex);
 752         dev->iommu_group = NULL;
 753         kobject_put(group->devices_kobj);
 754         sysfs_remove_link(group->devices_kobj, device->name);
 755 err_free_name:
 756         kfree(device->name);
 757 err_remove_link:
 758         sysfs_remove_link(&dev->kobj, "iommu_group");
 759 err_free_device:
 760         kfree(device);
 761         dev_err(dev, "Failed to add to iommu group %d: %d\n", group->id, ret);
 762         return ret;
 763 }
 764 EXPORT_SYMBOL_GPL(iommu_group_add_device);
 765
 766 /**
 767  * iommu_group_remove_device - remove a device from it's current group
 768  * @dev: device to be removed
 769  *
 770  * This function is called by an iommu driver to remove the device from
 771  * it's current group.  This decrements the iommu group reference count.
 772  */
 773 void iommu_group_remove_device(struct device *dev)
 774 {
 775         struct iommu_group *group = dev->iommu_group;
 776         struct group_device *tmp_device, *device = NULL;
 777
 778         if (!group)
 779                 return;
 780
 781         dev_info(dev, "Removing from iommu group %d\n", group->id);
 782
 783         /* Pre-notify listeners that a device is being removed. */
 784         blocking_notifier_call_chain(&group->notifier,
 785                                      IOMMU_GROUP_NOTIFY_DEL_DEVICE, dev);
 786
 787         mutex_lock(&group->mutex);
 788         list_for_each_entry(tmp_device, &group->devices, list) {
 789                 if (tmp_device->dev == dev) {
 790                         device = tmp_device;
 791                         list_del(&device->list);
 792                         break;
 793                 }
 794         }
 795         mutex_unlock(&group->mutex);
 796
 797         if (!device)
 798                 return;
 799
 800         sysfs_remove_link(group->devices_kobj, device->name);
 801         sysfs_remove_link(&dev->kobj, "iommu_group");
 802
 803         trace_remove_device_from_group(group->id, dev);
 804
 805         kfree(device->name);
 806         kfree(device);
 807         dev->iommu_group = NULL;
 808         kobject_put(group->devices_kobj);
 809 }
 810 EXPORT_SYMBOL_GPL(iommu_group_remove_device);
 811
 812 static int iommu_group_device_count(struct iommu_group *group)
 813 {
 814         struct group_device *entry;
 815         int ret = 0;
 816
 817         list_for_each_entry(entry, &group->devices, list)
 818                 ret++;
 819
 820         return ret;
 821 }
 822
 823 /**
 824  * iommu_group_for_each_dev - iterate over each device in the group
 825  * @group: the group
 826  * @data: caller opaque data to be passed to callback function
 827  * @fn: caller supplied callback function
 828  *
 829  * This function is called by group users to iterate over group devices.
 830  * Callers should hold a reference count to the group during callback.
 831  * The group->mutex is held across callbacks, which will block calls to
 832  * iommu_group_add/remove_device.
 833  */
 834 static int __iommu_group_for_each_dev(struct iommu_group *group, void *data,
 835                                       int (*fn)(struct device *, void *))
 836 {
 837         struct group_device *device;
 838         int ret = 0;
 839
 840         list_for_each_entry(device, &group->devices, list) {
 841                 ret = fn(device->dev, data);
 842                 if (ret)
 843                         break;
 844         }
 845         return ret;
 846 }
 847
 848
 849 int iommu_group_for_each_dev(struct iommu_group *group, void *data,
 850                              int (*fn)(struct device *, void *))
 851 {
 852         int ret;
 853
 854         mutex_lock(&group->mutex);
 855         ret = __iommu_group_for_each_dev(group, data, fn);
 856         mutex_unlock(&group->mutex);
 857
 858         return ret;
 859 }
 860 EXPORT_SYMBOL_GPL(iommu_group_for_each_dev);
 861
 862 /**
 863  * iommu_group_get - Return the group for a device and increment reference
 864  * @dev: get the group that this device belongs to
 865  *
 866  * This function is called by iommu drivers and users to get the group
 867  * for the specified device.  If found, the group is returned and the group
 868  * reference in incremented, else NULL.
 869  */
 870 struct iommu_group *iommu_group_get(struct device *dev)
 871 {
 872         struct iommu_group *group = dev->iommu_group;
 873
 874         if (group)
 875                 kobject_get(group->devices_kobj);
 876
 877         return group;
 878 }
 879 EXPORT_SYMBOL_GPL(iommu_group_get);
 880
 881 /**
 882  * iommu_group_ref_get - Increment reference on a group
 883  * @group: the group to use, must not be NULL
 884  *
 885  * This function is called by iommu drivers to take additional references on an
 886  * existing group.  Returns the given group for convenience.
 887  */
 888 struct iommu_group *iommu_group_ref_get(struct iommu_group *group)
 889 {
 890         kobject_get(group->devices_kobj);
 891         return group;
 892 }
 893
 894 /**
 895  * iommu_group_put - Decrement group reference
 896  * @group: the group to use
 897  *
 898  * This function is called by iommu drivers and users to release the
 899  * iommu group.  Once the reference count is zero, the group is released.
 900  */
 901 void iommu_group_put(struct iommu_group *group)
 902 {
 903         if (group)
 904                 kobject_put(group->devices_kobj);
 905 }
 906 EXPORT_SYMBOL_GPL(iommu_group_put);
 907
 908 /**
 909  * iommu_group_register_notifier - Register a notifier for group changes
 910  * @group: the group to watch
 911  * @nb: notifier block to signal
 912  *
 913  * This function allows iommu group users to track changes in a group.
 914  * See include/linux/iommu.h for actions sent via this notifier.  Caller
 915  * should hold a reference to the group throughout notifier registration.
 916  */
 917 int iommu_group_register_notifier(struct iommu_group *group,
 918                                   struct notifier_block *nb)
 919 {
 920         return blocking_notifier_chain_register(&group->notifier, nb);
 921 }
 922 EXPORT_SYMBOL_GPL(iommu_group_register_notifier);
 923
 924 /**
 925  * iommu_group_unregister_notifier - Unregister a notifier
 926  * @group: the group to watch
 927  * @nb: notifier block to signal
 928  *
 929  * Unregister a previously registered group notifier block.
 930  */
 931 int iommu_group_unregister_notifier(struct iommu_group *group,
 932                                     struct notifier_block *nb)
 933 {
 934         return blocking_notifier_chain_unregister(&group->notifier, nb);
 935 }
 936 EXPORT_SYMBOL_GPL(iommu_group_unregister_notifier);
 937
 938 /**
 939  * iommu_register_device_fault_handler() - Register a device fault handler
 940  * @dev: the device
 941  * @handler: the fault handler
 942  * @data: private data passed as argument to the handler
 943  *
 944  * When an IOMMU fault event is received, this handler gets called with the
 945  * fault event and data as argument. The handler should return 0 on success. If
 946  * the fault is recoverable (IOMMU_FAULT_PAGE_REQ), the consumer should also
 947  * complete the fault by calling iommu_page_response() with one of the following
 948  * response code:
 949  * - IOMMU_PAGE_RESP_SUCCESS: retry the translation
 950  * - IOMMU_PAGE_RESP_INVALID: terminate the fault
 951  * - IOMMU_PAGE_RESP_FAILURE: terminate the fault and stop reporting
 952  *   page faults if possible.
 953  *
 954  * Return 0 if the fault handler was installed successfully, or an error.
 955  */
 956 int iommu_register_device_fault_handler(struct device *dev,
 957                                         iommu_dev_fault_handler_t handler,
 958                                         void *data)
 959 {
 960         struct iommu_param *param = dev->iommu_param;
 961         int ret = 0;
 962
 963         if (!param)
 964                 return -EINVAL;
 965
 966         mutex_lock(&param->lock);
 967         /* Only allow one fault handler registered for each device */
 968         if (param->fault_param) {
 969                 ret = -EBUSY;
 970                 goto done_unlock;
 971         }
 972
 973         get_device(dev);
 974         param->fault_param = kzalloc(sizeof(*param->fault_param), GFP_KERNEL);
 975         if (!param->fault_param) {
 976                 put_device(dev);
 977                 ret = -ENOMEM;
 978                 goto done_unlock;
 979         }
 980         param->fault_param->handler = handler;
 981         param->fault_param->data = data;
 982         mutex_init(&param->fault_param->lock);
 983         INIT_LIST_HEAD(&param->fault_param->faults);
 984
 985 done_unlock:
 986         mutex_unlock(&param->lock);
 987
 988         return ret;
 989 }
 990 EXPORT_SYMBOL_GPL(iommu_register_device_fault_handler);
 991
 992 /**
 993  * iommu_unregister_device_fault_handler() - Unregister the device fault handler
 994  * @dev: the device
 995  *
 996  * Remove the device fault handler installed with
 997  * iommu_register_device_fault_handler().
 998  *
 999  * Return 0 on success, or an error.
1000  */
1001 int iommu_unregister_device_fault_handler(struct device *dev)
1002 {
1003         struct iommu_param *param = dev->iommu_param;
1004         int ret = 0;
1005
1006         if (!param)
1007                 return -EINVAL;
1008
1009         mutex_lock(&param->lock);
1010
1011         if (!param->fault_param)
1012                 goto unlock;
1013
1014         /* we cannot unregister handler if there are pending faults */
1015         if (!list_empty(&param->fault_param->faults)) {
1016                 ret = -EBUSY;
1017                 goto unlock;
1018         }
1019
1020         kfree(param->fault_param);
1021         param->fault_param = NULL;
1022         put_device(dev);
1023 unlock:
1024         mutex_unlock(&param->lock);
1025
1026         return ret;
1027 }
1028 EXPORT_SYMBOL_GPL(iommu_unregister_device_fault_handler);
1029
1030 /**
1031  * iommu_report_device_fault() - Report fault event to device driver
1032  * @dev: the device
1033  * @evt: fault event data
1034  *
1035  * Called by IOMMU drivers when a fault is detected, typically in a threaded IRQ
1036  * handler. When this function fails and the fault is recoverable, it is the
1037  * caller's responsibility to complete the fault.
1038  *
1039  * Return 0 on success, or an error.
1040  */
1041 int iommu_report_device_fault(struct device *dev, struct iommu_fault_event *evt)
1042 {
1043         struct iommu_param *param = dev->iommu_param;
1044         struct iommu_fault_event *evt_pending = NULL;
1045         struct iommu_fault_param *fparam;
1046         int ret = 0;
1047
1048         if (!param || !evt)
1049                 return -EINVAL;
1050
1051         /* we only report device fault if there is a handler registered */
1052         mutex_lock(&param->lock);
1053         fparam = param->fault_param;
1054         if (!fparam || !fparam->handler) {
1055                 ret = -EINVAL;
1056                 goto done_unlock;
1057         }
1058
1059         if (evt->fault.type == IOMMU_FAULT_PAGE_REQ &&
1060             (evt->fault.prm.flags & IOMMU_FAULT_PAGE_REQUEST_LAST_PAGE)) {
1061                 evt_pending = kmemdup(evt, sizeof(struct iommu_fault_event),
1062                                       GFP_KERNEL);
1063                 if (!evt_pending) {
1064                         ret = -ENOMEM;
1065                         goto done_unlock;
1066                 }
1067                 mutex_lock(&fparam->lock);
1068                 list_add_tail(&evt_pending->list, &fparam->faults);
1069                 mutex_unlock(&fparam->lock);
1070         }
1071
1072         ret = fparam->handler(&evt->fault, fparam->data);
1073         if (ret && evt_pending) {
1074                 mutex_lock(&fparam->lock);
1075                 list_del(&evt_pending->list);
1076                 mutex_unlock(&fparam->lock);
1077                 kfree(evt_pending);
1078         }
1079 done_unlock:
1080         mutex_unlock(&param->lock);
1081         return ret;
1082 }
1083 EXPORT_SYMBOL_GPL(iommu_report_device_fault);
1084
1085 int iommu_page_response(struct device *dev,
1086                         struct iommu_page_response *msg)
1087 {
1088         bool pasid_valid;
1089         int ret = -EINVAL;
1090         struct iommu_fault_event *evt;
1091         struct iommu_fault_page_request *prm;
1092         struct iommu_param *param = dev->iommu_param;
1093         struct iommu_domain *domain = iommu_get_domain_for_dev(dev);
1094
1095         if (!domain || !domain->ops->page_response)
1096                 return -ENODEV;
1097
1098         if (!param || !param->fault_param)
1099                 return -EINVAL;
1100
1101         if (msg->version != IOMMU_PAGE_RESP_VERSION_1 ||
1102             msg->flags & ~IOMMU_PAGE_RESP_PASID_VALID)
1103                 return -EINVAL;
1104
1105         /* Only send response if there is a fault report pending */
1106         mutex_lock(&param->fault_param->lock);
1107         if (list_empty(&param->fault_param->faults)) {
1108                 dev_warn_ratelimited(dev, "no pending PRQ, drop response\n");
1109                 goto done_unlock;
1110         }
1111         /*
1112          * Check if we have a matching page request pending to respond,
1113          * otherwise return -EINVAL
1114          */
1115         list_for_each_entry(evt, &param->fault_param->faults, list) {
1116                 prm = &evt->fault.prm;
1117                 pasid_valid = prm->flags & IOMMU_FAULT_PAGE_REQUEST_PASID_VALID;
1118
1119                 if ((pasid_valid && prm->pasid != msg->pasid) ||
1120                     prm->grpid != msg->grpid)
1121                         continue;
1122
1123                 /* Sanitize the reply */
1124                 msg->flags = pasid_valid ? IOMMU_PAGE_RESP_PASID_VALID : 0;
1125
1126                 ret = domain->ops->page_response(dev, evt, msg);
1127                 list_del(&evt->list);
1128                 kfree(evt);
1129                 break;
1130         }
1131
1132 done_unlock:
1133         mutex_unlock(&param->fault_param->lock);
1134         return ret;
1135 }
1136 EXPORT_SYMBOL_GPL(iommu_page_response);
1137
1138 /**
1139  * iommu_group_id - Return ID for a group
1140  * @group: the group to ID
1141  *
1142  * Return the unique ID for the group matching the sysfs group number.
1143  */
1144 int iommu_group_id(struct iommu_group *group)
1145 {
1146         return group->id;
1147 }
1148 EXPORT_SYMBOL_GPL(iommu_group_id);
1149
1150 static struct iommu_group *get_pci_alias_group(struct pci_dev *pdev,
1151                                                unsigned long *devfns);
1152
1153 /*
1154  * To consider a PCI device isolated, we require ACS to support Source
1155  * Validation, Request Redirection, Completer Redirection, and Upstream
1156  * Forwarding.  This effectively means that devices cannot spoof their
1157  * requester ID, requests and completions cannot be redirected, and all
1158  * transactions are forwarded upstream, even as it passes through a
1159  * bridge where the target device is downstream.
1160  */
1161 #define REQ_ACS_FLAGS   (PCI_ACS_SV | PCI_ACS_RR | PCI_ACS_CR | PCI_ACS_UF)
1162
1163 /*
1164  * For multifunction devices which are not isolated from each other, find
1165  * all the other non-isolated functions and look for existing groups.  For
1166  * each function, we also need to look for aliases to or from other devices
1167  * that may already have a group.
1168  */
1169 static struct iommu_group *get_pci_function_alias_group(struct pci_dev *pdev,
1170                                                         unsigned long *devfns)
1171 {
1172         struct pci_dev *tmp = NULL;
1173         struct iommu_group *group;
1174
1175         if (!pdev->multifunction || pci_acs_enabled(pdev, REQ_ACS_FLAGS))
1176                 return NULL;
1177
1178         for_each_pci_dev(tmp) {
1179                 if (tmp == pdev || tmp->bus != pdev->bus ||
1180                     PCI_SLOT(tmp->devfn) != PCI_SLOT(pdev->devfn) ||
1181                     pci_acs_enabled(tmp, REQ_ACS_FLAGS))
1182                         continue;
1183
1184                 group = get_pci_alias_group(tmp, devfns);
1185                 if (group) {
1186                         pci_dev_put(tmp);
1187                         return group;
1188                 }
1189         }
1190
1191         return NULL;
1192 }
1193
1194 /*
1195  * Look for aliases to or from the given device for existing groups. DMA
1196  * aliases are only supported on the same bus, therefore the search
1197  * space is quite small (especially since we're really only looking at pcie
1198  * device, and therefore only expect multiple slots on the root complex or
1199  * downstream switch ports).  It's conceivable though that a pair of
1200  * multifunction devices could have aliases between them that would cause a
1201  * loop.  To prevent this, we use a bitmap to track where we've been.
1202  */
1203 static struct iommu_group *get_pci_alias_group(struct pci_dev *pdev,
1204                                                unsigned long *devfns)
1205 {
1206         struct pci_dev *tmp = NULL;
1207         struct iommu_group *group;
1208
1209         if (test_and_set_bit(pdev->devfn & 0xff, devfns))
1210                 return NULL;
1211
1212         group = iommu_group_get(&pdev->dev);
1213         if (group)
1214                 return group;
1215
1216         for_each_pci_dev(tmp) {
1217                 if (tmp == pdev || tmp->bus != pdev->bus)
1218                         continue;
1219
1220                 /* We alias them or they alias us */
1221                 if (pci_devs_are_dma_aliases(pdev, tmp)) {
1222                         group = get_pci_alias_group(tmp, devfns);
1223                         if (group) {
1224                                 pci_dev_put(tmp);
1225                                 return group;
1226                         }
1227
1228                         group = get_pci_function_alias_group(tmp, devfns);
1229                         if (group) {
1230                                 pci_dev_put(tmp);
1231                                 return group;
1232                         }
1233                 }
1234         }
1235
1236         return NULL;
1237 }
1238
1239 struct group_for_pci_data {
1240         struct pci_dev *pdev;
1241         struct iommu_group *group;
1242 };
1243
1244 /*
1245  * DMA alias iterator callback, return the last seen device.  Stop and return
1246  * the IOMMU group if we find one along the way.
1247  */
1248 static int get_pci_alias_or_group(struct pci_dev *pdev, u16 alias, void *opaque)
1249 {
1250         struct group_for_pci_data *data = opaque;
1251
1252         data->pdev = pdev;
1253         data->group = iommu_group_get(&pdev->dev);
1254
1255         return data->group != NULL;
1256 }
1257
1258 /*
1259  * Generic device_group call-back function. It just allocates one
1260  * iommu-group per device.
1261  */
1262 struct iommu_group *generic_device_group(struct device *dev)
1263 {
1264         return iommu_group_alloc();
1265 }
1266
1267 /*
1268  * Use standard PCI bus topology, isolation features, and DMA alias quirks
1269  * to find or create an IOMMU group for a device.
1270  */
1271 struct iommu_group *pci_device_group(struct device *dev)
1272 {
1273         struct pci_dev *pdev = to_pci_dev(dev);
1274         struct group_for_pci_data data;
1275         struct pci_bus *bus;
1276         struct iommu_group *group = NULL;
1277         u64 devfns[4] = { 0 };
1278
1279         if (WARN_ON(!dev_is_pci(dev)))
1280                 return ERR_PTR(-EINVAL);
1281
1282         /*
1283          * Find the upstream DMA alias for the device.  A device must not
1284          * be aliased due to topology in order to have its own IOMMU group.
1285          * If we find an alias along the way that already belongs to a
1286          * group, use it.
1287          */
1288         if (pci_for_each_dma_alias(pdev, get_pci_alias_or_group, &data))
1289                 return data.group;
1290
1291         pdev = data.pdev;
1292
1293         /*
1294          * Continue upstream from the point of minimum IOMMU granularity
1295          * due to aliases to the point where devices are protected from
1296          * peer-to-peer DMA by PCI ACS.  Again, if we find an existing
1297          * group, use it.
1298          */
1299         for (bus = pdev->bus; !pci_is_root_bus(bus); bus = bus->parent) {
1300                 if (!bus->self)
1301                         continue;
1302
1303                 if (pci_acs_path_enabled(bus->self, NULL, REQ_ACS_FLAGS))
1304                         break;
1305
1306                 pdev = bus->self;
1307
1308                 group = iommu_group_get(&pdev->dev);
1309                 if (group)
1310                         return group;
1311         }
1312
1313         /*
1314          * Look for existing groups on device aliases.  If we alias another
1315          * device or another device aliases us, use the same group.
1316          */
1317         group = get_pci_alias_group(pdev, (unsigned long *)devfns);
1318         if (group)
1319                 return group;
1320
1321         /*
1322          * Look for existing groups on non-isolated functions on the same
1323          * slot and aliases of those funcions, if any.  No need to clear
1324          * the search bitmap, the tested devfns are still valid.
1325          */
1326         group = get_pci_function_alias_group(pdev, (unsigned long *)devfns);
1327         if (group)
1328                 return group;
1329
1330         /* No shared group found, allocate new */
1331         return iommu_group_alloc();
1332 }
1333
1334 /* Get the IOMMU group for device on fsl-mc bus */
1335 struct iommu_group *fsl_mc_device_group(struct device *dev)
1336 {
1337         struct device *cont_dev = fsl_mc_cont_dev(dev);
1338         struct iommu_group *group;
1339
1340         group = iommu_group_get(cont_dev);
1341         if (!group)
1342                 group = iommu_group_alloc();
1343         return group;
1344 }
1345
1346 /**
1347  * iommu_group_get_for_dev - Find or create the IOMMU group for a device
1348  * @dev: target device
1349  *
1350  * This function is intended to be called by IOMMU drivers and extended to
1351  * support common, bus-defined algorithms when determining or creating the
1352  * IOMMU group for a device.  On success, the caller will hold a reference
1353  * to the returned IOMMU group, which will already include the provided
1354  * device.  The reference should be released with iommu_group_put().
1355  */
1356 struct iommu_group *iommu_group_get_for_dev(struct device *dev)
1357 {
1358         const struct iommu_ops *ops = dev->bus->iommu_ops;
1359         struct iommu_group *group;
1360         int ret;
1361
1362         group = iommu_group_get(dev);
1363         if (group)
1364                 return group;
1365
1366         if (!ops)
1367                 return ERR_PTR(-EINVAL);
1368
1369         group = ops->device_group(dev);
1370         if (WARN_ON_ONCE(group == NULL))
1371                 return ERR_PTR(-EINVAL);
1372
1373         if (IS_ERR(group))
1374                 return group;
1375
1376         /*
1377          * Try to allocate a default domain - needs support from the
1378          * IOMMU driver.
1379          */
1380         if (!group->default_domain) {
1381                 struct iommu_domain *dom;
1382
1383                 dom = __iommu_domain_alloc(dev->bus, iommu_def_domain_type);
1384                 if (!dom && iommu_def_domain_type != IOMMU_DOMAIN_DMA) {
1385                         dom = __iommu_domain_alloc(dev->bus, IOMMU_DOMAIN_DMA);
1386                         if (dom) {
1387                                 dev_warn(dev,
1388                                          "failed to allocate default IOMMU domain of type %u; falling back to IOMMU_DOMAIN_DMA",
1389                                          iommu_def_domain_type);
1390                         }
1391                 }
1392
1393                 group->default_domain = dom;
1394                 if (!group->domain)
1395                         group->domain = dom;
1396
1397                 if (dom && !iommu_dma_strict) {
1398                         int attr = 1;
1399                         iommu_domain_set_attr(dom,
1400                                               DOMAIN_ATTR_DMA_USE_FLUSH_QUEUE,
1401                                               &attr);
1402                 }
1403         }
1404
1405         ret = iommu_group_add_device(group, dev);
1406         if (ret) {
1407                 iommu_group_put(group);
1408                 return ERR_PTR(ret);
1409         }
1410
1411         return group;
1412 }
1413
1414 struct iommu_domain *iommu_group_default_domain(struct iommu_group *group)
1415 {
1416         return group->default_domain;
1417 }
1418
1419 static int add_iommu_group(struct device *dev, void *data)
1420 {
1421         int ret = iommu_probe_device(dev);
1422
1423         /*
1424          * We ignore -ENODEV errors for now, as they just mean that the
1425          * device is not translated by an IOMMU. We still care about
1426          * other errors and fail to initialize when they happen.
1427          */
1428         if (ret == -ENODEV)
1429                 ret = 0;
1430
1431         return ret;
1432 }
1433
1434 static int remove_iommu_group(struct device *dev, void *data)
1435 {
1436         iommu_release_device(dev);
1437
1438         return 0;
1439 }
1440
1441 static int iommu_bus_notifier(struct notifier_block *nb,
1442                               unsigned long action, void *data)
1443 {
1444         unsigned long group_action = 0;
1445         struct device *dev = data;
1446         struct iommu_group *group;
1447
1448         /*
1449          * ADD/DEL call into iommu driver ops if provided, which may
1450          * result in ADD/DEL notifiers to group->notifier
1451          */
1452         if (action == BUS_NOTIFY_ADD_DEVICE) {
1453                 int ret;
1454
1455                 ret = iommu_probe_device(dev);
1456                 return (ret) ? NOTIFY_DONE : NOTIFY_OK;
1457         } else if (action == BUS_NOTIFY_REMOVED_DEVICE) {
1458                 iommu_release_device(dev);
1459                 return NOTIFY_OK;
1460         }
1461
1462         /*
1463          * Remaining BUS_NOTIFYs get filtered and republished to the
1464          * group, if anyone is listening
1465          */
1466         group = iommu_group_get(dev);
1467         if (!group)
1468                 return 0;
1469
1470         switch (action) {
1471         case BUS_NOTIFY_BIND_DRIVER:
1472                 group_action = IOMMU_GROUP_NOTIFY_BIND_DRIVER;
1473                 break;
1474         case BUS_NOTIFY_BOUND_DRIVER:
1475                 group_action = IOMMU_GROUP_NOTIFY_BOUND_DRIVER;
1476                 break;
1477         case BUS_NOTIFY_UNBIND_DRIVER:
1478                 group_action = IOMMU_GROUP_NOTIFY_UNBIND_DRIVER;
1479                 break;
1480         case BUS_NOTIFY_UNBOUND_DRIVER:
1481                 group_action = IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER;
1482                 break;
1483         }
1484
1485         if (group_action)
1486                 blocking_notifier_call_chain(&group->notifier,
1487                                              group_action, dev);
1488
1489         iommu_group_put(group);
1490         return 0;
1491 }
1492
1493 static int iommu_bus_init(struct bus_type *bus, const struct iommu_ops *ops)
1494 {
1495         int err;
1496         struct notifier_block *nb;
1497
1498         nb = kzalloc(sizeof(struct notifier_block), GFP_KERNEL);
1499         if (!nb)
1500                 return -ENOMEM;
1501
1502         nb->notifier_call = iommu_bus_notifier;
1503
1504         err = bus_register_notifier(bus, nb);
1505         if (err)
1506                 goto out_free;
1507
1508         err = bus_for_each_dev(bus, NULL, NULL, add_iommu_group);
1509         if (err)
1510                 goto out_err;
1511
1512
1513         return 0;
1514
1515 out_err:
1516         /* Clean up */
1517         bus_for_each_dev(bus, NULL, NULL, remove_iommu_group);
1518         bus_unregister_notifier(bus, nb);
1519
1520 out_free:
1521         kfree(nb);
1522
1523         return err;
1524 }
1525
1526 /**
1527  * bus_set_iommu - set iommu-callbacks for the bus
1528  * @bus: bus.
1529  * @ops: the callbacks provided by the iommu-driver
1530  *
1531  * This function is called by an iommu driver to set the iommu methods
1532  * used for a particular bus. Drivers for devices on that bus can use
1533  * the iommu-api after these ops are registered.
1534  * This special function is needed because IOMMUs are usually devices on
1535  * the bus itself, so the iommu drivers are not initialized when the bus
1536  * is set up. With this function the iommu-driver can set the iommu-ops
1537  * afterwards.
1538  */
1539 int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops)
1540 {
1541         int err;
1542
1543         if (bus->iommu_ops != NULL)
1544                 return -EBUSY;
1545
1546         bus->iommu_ops = ops;
1547
1548         /* Do IOMMU specific setup for this bus-type */
1549         err = iommu_bus_init(bus, ops);
1550         if (err)
1551                 bus->iommu_ops = NULL;
1552
1553         return err;
1554 }
1555 EXPORT_SYMBOL_GPL(bus_set_iommu);
1556
1557 bool iommu_present(struct bus_type *bus)
1558 {
1559         return bus->iommu_ops != NULL;
1560 }
1561 EXPORT_SYMBOL_GPL(iommu_present);
1562
1563 bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
1564 {
1565         if (!bus->iommu_ops || !bus->iommu_ops->capable)
1566                 return false;
1567
1568         return bus->iommu_ops->capable(cap);
1569 }
1570 EXPORT_SYMBOL_GPL(iommu_capable);
1571
1572 /**
1573  * iommu_set_fault_handler() - set a fault handler for an iommu domain
1574  * @domain: iommu domain
1575  * @handler: fault handler
1576  * @token: user data, will be passed back to the fault handler
1577  *
1578  * This function should be used by IOMMU users which want to be notified
1579  * whenever an IOMMU fault happens.
1580  *
1581  * The fault handler itself should return 0 on success, and an appropriate
1582  * error code otherwise.
1583  */
1584 void iommu_set_fault_handler(struct iommu_domain *domain,
1585                                         iommu_fault_handler_t handler,
1586                                         void *token)
1587 {
1588         BUG_ON(!domain);
1589
1590         domain->handler = handler;
1591         domain->handler_token = token;
1592 }
1593 EXPORT_SYMBOL_GPL(iommu_set_fault_handler);
1594
1595 static struct iommu_domain *__iommu_domain_alloc(struct bus_type *bus,
1596                                                  unsigned type)
1597 {
1598         struct iommu_domain *domain;
1599
1600         if (bus == NULL || bus->iommu_ops == NULL)
1601                 return NULL;
1602
1603         domain = bus->iommu_ops->domain_alloc(type);
1604         if (!domain)
1605                 return NULL;
1606
1607         domain->ops  = bus->iommu_ops;
1608         domain->type = type;
1609         /* Assume all sizes by default; the driver may override this later */
1610         domain->pgsize_bitmap  = bus->iommu_ops->pgsize_bitmap;
1611
1612         return domain;
1613 }
1614
1615 struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
1616 {
1617         return __iommu_domain_alloc(bus, IOMMU_DOMAIN_UNMANAGED);
1618 }
1619 EXPORT_SYMBOL_GPL(iommu_domain_alloc);
1620
1621 void iommu_domain_free(struct iommu_domain *domain)
1622 {
1623         domain->ops->domain_free(domain);
1624 }
1625 EXPORT_SYMBOL_GPL(iommu_domain_free);
1626
1627 static int __iommu_attach_device(struct iommu_domain *domain,
1628                                  struct device *dev)
1629 {
1630         int ret;
1631         if ((domain->ops->is_attach_deferred != NULL) &&
1632             domain->ops->is_attach_deferred(domain, dev))
1633                 return 0;
1634
1635         if (unlikely(domain->ops->attach_dev == NULL))
1636                 return -ENODEV;
1637
1638         ret = domain->ops->attach_dev(domain, dev);
1639         if (!ret)
1640                 trace_attach_device_to_domain(dev);
1641         return ret;
1642 }
1643
1644 int iommu_attach_device(struct iommu_domain *domain, struct device *dev)
1645 {
1646         struct iommu_group *group;
1647         int ret;
1648
1649         group = iommu_group_get(dev);
1650         if (!group)
1651                 return -ENODEV;
1652
1653         /*
1654          * Lock the group to make sure the device-count doesn't
1655          * change while we are attaching
1656          */
1657         mutex_lock(&group->mutex);
1658         ret = -EINVAL;
1659         if (iommu_group_device_count(group) != 1)
1660                 goto out_unlock;
1661
1662         ret = __iommu_attach_group(domain, group);
1663
1664 out_unlock:
1665         mutex_unlock(&group->mutex);
1666         iommu_group_put(group);
1667
1668         return ret;
1669 }
1670 EXPORT_SYMBOL_GPL(iommu_attach_device);
1671
1672 static void __iommu_detach_device(struct iommu_domain *domain,
1673                                   struct device *dev)
1674 {
1675         if ((domain->ops->is_attach_deferred != NULL) &&
1676             domain->ops->is_attach_deferred(domain, dev))
1677                 return;
1678
1679         if (unlikely(domain->ops->detach_dev == NULL))
1680                 return;
1681
1682         domain->ops->detach_dev(domain, dev);
1683         trace_detach_device_from_domain(dev);
1684 }
1685
1686 void iommu_detach_device(struct iommu_domain *domain, struct device *dev)
1687 {
1688         struct iommu_group *group;
1689
1690         group = iommu_group_get(dev);
1691         if (!group)
1692                 return;
1693
1694         mutex_lock(&group->mutex);
1695         if (iommu_group_device_count(group) != 1) {
1696                 WARN_ON(1);
1697                 goto out_unlock;
1698         }
1699
1700         __iommu_detach_group(domain, group);
1701
1702 out_unlock:
1703         mutex_unlock(&group->mutex);
1704         iommu_group_put(group);
1705 }
1706 EXPORT_SYMBOL_GPL(iommu_detach_device);
1707
1708 struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
1709 {
1710         struct iommu_domain *domain;
1711         struct iommu_group *group;
1712
1713         group = iommu_group_get(dev);
1714         if (!group)
1715                 return NULL;
1716
1717         domain = group->domain;
1718
1719         iommu_group_put(group);
1720
1721         return domain;
1722 }
1723 EXPORT_SYMBOL_GPL(iommu_get_domain_for_dev);
1724
1725 /*
1726  * For IOMMU_DOMAIN_DMA implementations which already provide their own
1727  * guarantees that the group and its default domain are valid and correct.
1728  */
1729 struct iommu_domain *iommu_get_dma_domain(struct device *dev)
1730 {
1731         return dev->iommu_group->default_domain;
1732 }
1733
1734 /*
1735  * IOMMU groups are really the natural working unit of the IOMMU, but
1736  * the IOMMU API works on domains and devices.  Bridge that gap by
1737  * iterating over the devices in a group.  Ideally we'd have a single
1738  * device which represents the requestor ID of the group, but we also
1739  * allow IOMMU drivers to create policy defined minimum sets, where
1740  * the physical hardware may be able to distiguish members, but we
1741  * wish to group them at a higher level (ex. untrusted multi-function
1742  * PCI devices).  Thus we attach each device.
1743  */
1744 static int iommu_group_do_attach_device(struct device *dev, void *data)
1745 {
1746         struct iommu_domain *domain = data;
1747
1748         return __iommu_attach_device(domain, dev);
1749 }
1750
1751 static int __iommu_attach_group(struct iommu_domain *domain,
1752                                 struct iommu_group *group)
1753 {
1754         int ret;
1755
1756         if (group->default_domain && group->domain != group->default_domain)
1757                 return -EBUSY;
1758
1759         ret = __iommu_group_for_each_dev(group, domain,
1760                                          iommu_group_do_attach_device);
1761         if (ret == 0)
1762                 group->domain = domain;
1763
1764         return ret;
1765 }
1766
1767 int iommu_attach_group(struct iommu_domain *domain, struct iommu_group *group)
1768 {
1769         int ret;
1770
1771         mutex_lock(&group->mutex);
1772         ret = __iommu_attach_group(domain, group);
1773         mutex_unlock(&group->mutex);
1774
1775         return ret;
1776 }
1777 EXPORT_SYMBOL_GPL(iommu_attach_group);
1778
1779 static int iommu_group_do_detach_device(struct device *dev, void *data)
1780 {
1781         struct iommu_domain *domain = data;
1782
1783         __iommu_detach_device(domain, dev);
1784
1785         return 0;
1786 }
1787
1788 static void __iommu_detach_group(struct iommu_domain *domain,
1789                                  struct iommu_group *group)
1790 {
1791         int ret;
1792
1793         if (!group->default_domain) {
1794                 __iommu_group_for_each_dev(group, domain,
1795                                            iommu_group_do_detach_device);
1796                 group->domain = NULL;
1797                 return;
1798         }
1799
1800         if (group->domain == group->default_domain)
1801                 return;
1802
1803         /* Detach by re-attaching to the default domain */
1804         ret = __iommu_group_for_each_dev(group, group->default_domain,
1805                                          iommu_group_do_attach_device);
1806         if (ret != 0)
1807                 WARN_ON(1);
1808         else
1809                 group->domain = group->default_domain;
1810 }
1811
1812 void iommu_detach_group(struct iommu_domain *domain, struct iommu_group *group)
1813 {
1814         mutex_lock(&group->mutex);
1815         __iommu_detach_group(domain, group);
1816         mutex_unlock(&group->mutex);
1817 }
1818 EXPORT_SYMBOL_GPL(iommu_detach_group);
1819
1820 phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
1821 {
1822         if (unlikely(domain->ops->iova_to_phys == NULL))
1823                 return 0;
1824
1825         return domain->ops->iova_to_phys(domain, iova);
1826 }
1827 EXPORT_SYMBOL_GPL(iommu_iova_to_phys);
1828
1829 static size_t iommu_pgsize(struct iommu_domain *domain,
1830                            unsigned long addr_merge, size_t size)
1831 {
1832         unsigned int pgsize_idx;
1833         size_t pgsize;
1834
1835         /* Max page size that still fits into 'size' */
1836         pgsize_idx = __fls(size);
1837
1838         /* need to consider alignment requirements ? */
1839         if (likely(addr_merge)) {
1840                 /* Max page size allowed by address */
1841                 unsigned int align_pgsize_idx = __ffs(addr_merge);
1842                 pgsize_idx = min(pgsize_idx, align_pgsize_idx);
1843         }
1844
1845         /* build a mask of acceptable page sizes */
1846         pgsize = (1UL << (pgsize_idx + 1)) - 1;
1847
1848         /* throw away page sizes not supported by the hardware */
1849         pgsize &= domain->pgsize_bitmap;
1850
1851         /* make sure we're still sane */
1852         BUG_ON(!pgsize);
1853
1854         /* pick the biggest page */
1855         pgsize_idx = __fls(pgsize);
1856         pgsize = 1UL << pgsize_idx;
1857
1858         return pgsize;
1859 }
1860
1861 int __iommu_map(struct iommu_domain *domain, unsigned long iova,
1862               phys_addr_t paddr, size_t size, int prot, gfp_t gfp)
1863 {
1864         const struct iommu_ops *ops = domain->ops;
1865         unsigned long orig_iova = iova;
1866         unsigned int min_pagesz;
1867         size_t orig_size = size;
1868         phys_addr_t orig_paddr = paddr;
1869         int ret = 0;
1870
1871         if (unlikely(ops->map == NULL ||
1872                      domain->pgsize_bitmap == 0UL))
1873                 return -ENODEV;
1874
1875         if (unlikely(!(domain->type & __IOMMU_DOMAIN_PAGING)))
1876                 return -EINVAL;
1877
1878         /* find out the minimum page size supported */
1879         min_pagesz = 1 << __ffs(domain->pgsize_bitmap);
1880
1881         /*
1882          * both the virtual address and the physical one, as well as
1883          * the size of the mapping, must be aligned (at least) to the
1884          * size of the smallest page supported by the hardware
1885          */
1886         if (!IS_ALIGNED(iova | paddr | size, min_pagesz)) {
1887                 pr_err("unaligned: iova 0x%lx pa %pa size 0x%zx min_pagesz 0x%x\n",
1888                        iova, &paddr, size, min_pagesz);
1889                 return -EINVAL;
1890         }
1891
1892         pr_debug("map: iova 0x%lx pa %pa size 0x%zx\n", iova, &paddr, size);
1893
1894         while (size) {
1895                 size_t pgsize = iommu_pgsize(domain, iova | paddr, size);
1896
1897                 pr_debug("mapping: iova 0x%lx pa %pa pgsize 0x%zx\n",
1898                          iova, &paddr, pgsize);
1899                 ret = ops->map(domain, iova, paddr, pgsize, prot, gfp);
1900
1901                 if (ret)
1902                         break;
1903
1904                 iova += pgsize;
1905                 paddr += pgsize;
1906                 size -= pgsize;
1907         }
1908
1909         if (ops->iotlb_sync_map)
1910                 ops->iotlb_sync_map(domain);
1911
1912         /* unroll mapping in case something went wrong */
1913         if (ret)
1914                 iommu_unmap(domain, orig_iova, orig_size - size);
1915         else
1916                 trace_map(orig_iova, orig_paddr, orig_size);
1917
1918         return ret;
1919 }
1920
1921 int iommu_map(struct iommu_domain *domain, unsigned long iova,
1922               phys_addr_t paddr, size_t size, int prot)
1923 {
1924         might_sleep();
1925         return __iommu_map(domain, iova, paddr, size, prot, GFP_KERNEL);
1926 }
1927 EXPORT_SYMBOL_GPL(iommu_map);
1928
1929 int iommu_map_atomic(struct iommu_domain *domain, unsigned long iova,
1930               phys_addr_t paddr, size_t size, int prot)
1931 {
1932         return __iommu_map(domain, iova, paddr, size, prot, GFP_ATOMIC);
1933 }
1934 EXPORT_SYMBOL_GPL(iommu_map_atomic);
1935
1936 static size_t __iommu_unmap(struct iommu_domain *domain,
1937                             unsigned long iova, size_t size,
1938                             struct iommu_iotlb_gather *iotlb_gather)
1939 {
1940         const struct iommu_ops *ops = domain->ops;
1941         size_t unmapped_page, unmapped = 0;
1942         unsigned long orig_iova = iova;
1943         unsigned int min_pagesz;
1944
1945         if (unlikely(ops->unmap == NULL ||
1946                      domain->pgsize_bitmap == 0UL))
1947                 return 0;
1948
1949         if (unlikely(!(domain->type & __IOMMU_DOMAIN_PAGING)))
1950                 return 0;
1951
1952         /* find out the minimum page size supported */
1953         min_pagesz = 1 << __ffs(domain->pgsize_bitmap);
1954
1955         /*
1956          * The virtual address, as well as the size of the mapping, must be
1957          * aligned (at least) to the size of the smallest page supported
1958          * by the hardware
1959          */
1960         if (!IS_ALIGNED(iova | size, min_pagesz)) {
1961                 pr_err("unaligned: iova 0x%lx size 0x%zx min_pagesz 0x%x\n",
1962                        iova, size, min_pagesz);
1963                 return 0;
1964         }
1965
1966         pr_debug("unmap this: iova 0x%lx size 0x%zx\n", iova, size);
1967
1968         /*
1969          * Keep iterating until we either unmap 'size' bytes (or more)
1970          * or we hit an area that isn't mapped.
1971          */
1972         while (unmapped < size) {
1973                 size_t pgsize = iommu_pgsize(domain, iova, size - unmapped);
1974
1975                 unmapped_page = ops->unmap(domain, iova, pgsize, iotlb_gather);
1976                 if (!unmapped_page)
1977                         break;
1978
1979                 pr_debug("unmapped: iova 0x%lx size 0x%zx\n",
1980                          iova, unmapped_page);
1981
1982                 iova += unmapped_page;
1983                 unmapped += unmapped_page;
1984         }
1985
1986         trace_unmap(orig_iova, size, unmapped);
1987         return unmapped;
1988 }
1989
1990 size_t iommu_unmap(struct iommu_domain *domain,
1991                    unsigned long iova, size_t size)
1992 {
1993         struct iommu_iotlb_gather iotlb_gather;
1994         size_t ret;
1995
1996         iommu_iotlb_gather_init(&iotlb_gather);
1997         ret = __iommu_unmap(domain, iova, size, &iotlb_gather);
1998         iommu_tlb_sync(domain, &iotlb_gather);
1999
2000         return ret;
2001 }
2002 EXPORT_SYMBOL_GPL(iommu_unmap);
2003
2004 size_t iommu_unmap_fast(struct iommu_domain *domain,
2005                         unsigned long iova, size_t size,
2006                         struct iommu_iotlb_gather *iotlb_gather)
2007 {
2008         return __iommu_unmap(domain, iova, size, iotlb_gather);
2009 }
2010 EXPORT_SYMBOL_GPL(iommu_unmap_fast);
2011
2012 size_t __iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
2013                     struct scatterlist *sg, unsigned int nents, int prot,
2014                     gfp_t gfp)
2015 {
2016         size_t len = 0, mapped = 0;
2017         phys_addr_t start;
2018         unsigned int i = 0;
2019         int ret;
2020
2021         while (i <= nents) {
2022                 phys_addr_t s_phys = sg_phys(sg);
2023
2024                 if (len && s_phys != start + len) {
2025                         ret = __iommu_map(domain, iova + mapped, start,
2026                                         len, prot, gfp);
2027
2028                         if (ret)
2029                                 goto out_err;
2030
2031                         mapped += len;
2032                         len = 0;
2033                 }
2034
2035                 if (len) {
2036                         len += sg->length;
2037                 } else {
2038                         len = sg->length;
2039                         start = s_phys;
2040                 }
2041
2042                 if (++i < nents)
2043                         sg = sg_next(sg);
2044         }
2045
2046         return mapped;
2047
2048 out_err:
2049         /* undo mappings already done */
2050         iommu_unmap(domain, iova, mapped);
2051
2052         return 0;
2053
2054 }
2055
2056 size_t iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
2057                     struct scatterlist *sg, unsigned int nents, int prot)
2058 {
2059         might_sleep();
2060         return __iommu_map_sg(domain, iova, sg, nents, prot, GFP_KERNEL);
2061 }
2062 EXPORT_SYMBOL_GPL(iommu_map_sg);
2063
2064 size_t iommu_map_sg_atomic(struct iommu_domain *domain, unsigned long iova,
2065                     struct scatterlist *sg, unsigned int nents, int prot)
2066 {
2067         return __iommu_map_sg(domain, iova, sg, nents, prot, GFP_ATOMIC);
2068 }
2069 EXPORT_SYMBOL_GPL(iommu_map_sg_atomic);
2070
2071 int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
2072                                phys_addr_t paddr, u64 size, int prot)
2073 {
2074         if (unlikely(domain->ops->domain_window_enable == NULL))
2075                 return -ENODEV;
2076
2077         return domain->ops->domain_window_enable(domain, wnd_nr, paddr, size,
2078                                                  prot);
2079 }
2080 EXPORT_SYMBOL_GPL(iommu_domain_window_enable);
2081
2082 void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr)
2083 {
2084         if (unlikely(domain->ops->domain_window_disable == NULL))
2085                 return;
2086
2087         return domain->ops->domain_window_disable(domain, wnd_nr);
2088 }
2089 EXPORT_SYMBOL_GPL(iommu_domain_window_disable);
2090
2091 /**
2092  * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
2093  * @domain: the iommu domain where the fault has happened
2094  * @dev: the device where the fault has happened
2095  * @iova: the faulting address
2096  * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
2097  *
2098  * This function should be called by the low-level IOMMU implementations
2099  * whenever IOMMU faults happen, to allow high-level users, that are
2100  * interested in such events, to know about them.
2101  *
2102  * This event may be useful for several possible use cases:
2103  * - mere logging of the event
2104  * - dynamic TLB/PTE loading
2105  * - if restarting of the faulting device is required
2106  *
2107  * Returns 0 on success and an appropriate error code otherwise (if dynamic
2108  * PTE/TLB loading will one day be supported, implementations will be able
2109  * to tell whether it succeeded or not according to this return value).
2110  *
2111  * Specifically, -ENOSYS is returned if a fault handler isn't installed
2112  * (though fault handlers can also return -ENOSYS, in case they want to
2113  * elicit the default behavior of the IOMMU drivers).
2114  */
2115 int report_iommu_fault(struct iommu_domain *domain, struct device *dev,
2116                        unsigned long iova, int flags)
2117 {
2118         int ret = -ENOSYS;
2119
2120         /*
2121          * if upper layers showed interest and installed a fault handler,
2122          * invoke it.
2123          */
2124         if (domain->handler)
2125                 ret = domain->handler(domain, dev, iova, flags,
2126                                                 domain->handler_token);
2127
2128         trace_io_page_fault(dev, iova, flags);
2129         return ret;
2130 }
2131 EXPORT_SYMBOL_GPL(report_iommu_fault);
2132
2133 static int __init iommu_init(void)
2134 {
2135         iommu_group_kset = kset_create_and_add("iommu_groups",
2136                                                NULL, kernel_kobj);
2137         BUG_ON(!iommu_group_kset);
2138
2139         iommu_debugfs_setup();
2140
2141         return 0;
2142 }
2143 core_initcall(iommu_init);
2144
2145 int iommu_domain_get_attr(struct iommu_domain *domain,
2146                           enum iommu_attr attr, void *data)
2147 {
2148         struct iommu_domain_geometry *geometry;
2149         bool *paging;
2150         int ret = 0;
2151
2152         switch (attr) {
2153         case DOMAIN_ATTR_GEOMETRY:
2154                 geometry  = data;
2155                 *geometry = domain->geometry;
2156
2157                 break;
2158         case DOMAIN_ATTR_PAGING:
2159                 paging  = data;
2160                 *paging = (domain->pgsize_bitmap != 0UL);
2161                 break;
2162         default:
2163                 if (!domain->ops->domain_get_attr)
2164                         return -EINVAL;
2165
2166                 ret = domain->ops->domain_get_attr(domain, attr, data);
2167         }
2168
2169         return ret;
2170 }
2171 EXPORT_SYMBOL_GPL(iommu_domain_get_attr);
2172
2173 int iommu_domain_set_attr(struct iommu_domain *domain,
2174                           enum iommu_attr attr, void *data)
2175 {
2176         int ret = 0;
2177
2178         switch (attr) {
2179         default:
2180                 if (domain->ops->domain_set_attr == NULL)
2181                         return -EINVAL;
2182
2183                 ret = domain->ops->domain_set_attr(domain, attr, data);
2184         }
2185
2186         return ret;
2187 }
2188 EXPORT_SYMBOL_GPL(iommu_domain_set_attr);
2189
2190 void iommu_get_resv_regions(struct device *dev, struct list_head *list)
2191 {
2192         const struct iommu_ops *ops = dev->bus->iommu_ops;
2193
2194         if (ops && ops->get_resv_regions)
2195                 ops->get_resv_regions(dev, list);
2196 }
2197
2198 void iommu_put_resv_regions(struct device *dev, struct list_head *list)
2199 {
2200         const struct iommu_ops *ops = dev->bus->iommu_ops;
2201
2202         if (ops && ops->put_resv_regions)
2203                 ops->put_resv_regions(dev, list);
2204 }
2205
2206 struct iommu_resv_region *iommu_alloc_resv_region(phys_addr_t start,
2207                                                   size_t length, int prot,
2208                                                   enum iommu_resv_type type)
2209 {
2210         struct iommu_resv_region *region;
2211
2212         region = kzalloc(sizeof(*region), GFP_KERNEL);
2213         if (!region)
2214                 return NULL;
2215
2216         INIT_LIST_HEAD(&region->list);
2217         region->start = start;
2218         region->length = length;
2219         region->prot = prot;
2220         region->type = type;
2221         return region;
2222 }
2223
2224 static int
2225 request_default_domain_for_dev(struct device *dev, unsigned long type)
2226 {
2227         struct iommu_domain *domain;
2228         struct iommu_group *group;
2229         int ret;
2230
2231         /* Device must already be in a group before calling this function */
2232         group = iommu_group_get(dev);
2233         if (!group)
2234                 return -EINVAL;
2235
2236         mutex_lock(&group->mutex);
2237
2238         ret = 0;
2239         if (group->default_domain && group->default_domain->type == type)
2240                 goto out;
2241
2242         /* Don't change mappings of existing devices */
2243         ret = -EBUSY;
2244         if (iommu_group_device_count(group) != 1)
2245                 goto out;
2246
2247         ret = -ENOMEM;
2248         domain = __iommu_domain_alloc(dev->bus, type);
2249         if (!domain)
2250                 goto out;
2251
2252         /* Attach the device to the domain */
2253         ret = __iommu_attach_group(domain, group);
2254         if (ret) {
2255                 iommu_domain_free(domain);
2256                 goto out;
2257         }
2258
2259         /* Make the domain the default for this group */
2260         if (group->default_domain)
2261                 iommu_domain_free(group->default_domain);
2262         group->default_domain = domain;
2263
2264         iommu_group_create_direct_mappings(group, dev);
2265
2266         dev_info(dev, "Using iommu %s mapping\n",
2267                  type == IOMMU_DOMAIN_DMA ? "dma" : "direct");
2268
2269         ret = 0;
2270 out:
2271         mutex_unlock(&group->mutex);
2272         iommu_group_put(group);
2273
2274         return ret;
2275 }
2276
2277 /* Request that a device is direct mapped by the IOMMU */
2278 int iommu_request_dm_for_dev(struct device *dev)
2279 {
2280         return request_default_domain_for_dev(dev, IOMMU_DOMAIN_IDENTITY);
2281 }
2282
2283 /* Request that a device can't be direct mapped by the IOMMU */
2284 int iommu_request_dma_domain_for_dev(struct device *dev)
2285 {
2286         return request_default_domain_for_dev(dev, IOMMU_DOMAIN_DMA);
2287 }
2288
2289 void iommu_set_default_passthrough(bool cmd_line)
2290 {
2291         if (cmd_line)
2292                 iommu_set_cmd_line_dma_api();
2293
2294         iommu_def_domain_type = IOMMU_DOMAIN_IDENTITY;
2295 }
2296
2297 void iommu_set_default_translated(bool cmd_line)
2298 {
2299         if (cmd_line)
2300                 iommu_set_cmd_line_dma_api();
2301
2302         iommu_def_domain_type = IOMMU_DOMAIN_DMA;
2303 }
2304
2305 bool iommu_default_passthrough(void)
2306 {
2307         return iommu_def_domain_type == IOMMU_DOMAIN_IDENTITY;
2308 }
2309 EXPORT_SYMBOL_GPL(iommu_default_passthrough);
2310
2311 const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode)
2312 {
2313         const struct iommu_ops *ops = NULL;
2314         struct iommu_device *iommu;
2315
2316         spin_lock(&iommu_device_lock);
2317         list_for_each_entry(iommu, &iommu_device_list, list)
2318                 if (iommu->fwnode == fwnode) {
2319                         ops = iommu->ops;
2320                         break;
2321                 }
2322         spin_unlock(&iommu_device_lock);
2323         return ops;
2324 }
2325
2326 int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode,
2327                       const struct iommu_ops *ops)
2328 {
2329         struct iommu_fwspec *fwspec = dev_iommu_fwspec_get(dev);
2330
2331         if (fwspec)
2332                 return ops == fwspec->ops ? 0 : -EINVAL;
2333
2334         fwspec = kzalloc(sizeof(*fwspec), GFP_KERNEL);
2335         if (!fwspec)
2336                 return -ENOMEM;
2337
2338         of_node_get(to_of_node(iommu_fwnode));
2339         fwspec->iommu_fwnode = iommu_fwnode;
2340         fwspec->ops = ops;
2341         dev_iommu_fwspec_set(dev, fwspec);
2342         return 0;
2343 }
2344 EXPORT_SYMBOL_GPL(iommu_fwspec_init);
2345
2346 void iommu_fwspec_free(struct device *dev)
2347 {
2348         struct iommu_fwspec *fwspec = dev_iommu_fwspec_get(dev);
2349
2350         if (fwspec) {
2351                 fwnode_handle_put(fwspec->iommu_fwnode);
2352                 kfree(fwspec);
2353                 dev_iommu_fwspec_set(dev, NULL);
2354         }
2355 }
2356 EXPORT_SYMBOL_GPL(iommu_fwspec_free);
2357
2358 int iommu_fwspec_add_ids(struct device *dev, u32 *ids, int num_ids)
2359 {
2360         struct iommu_fwspec *fwspec = dev_iommu_fwspec_get(dev);
2361         size_t size;
2362         int i;
2363
2364         if (!fwspec)
2365                 return -EINVAL;
2366
2367         size = offsetof(struct iommu_fwspec, ids[fwspec->num_ids + num_ids]);
2368         if (size > sizeof(*fwspec)) {
2369                 fwspec = krealloc(fwspec, size, GFP_KERNEL);
2370                 if (!fwspec)
2371                         return -ENOMEM;
2372
2373                 dev_iommu_fwspec_set(dev, fwspec);
2374         }
2375
2376         for (i = 0; i < num_ids; i++)
2377                 fwspec->ids[fwspec->num_ids + i] = ids[i];
2378
2379         fwspec->num_ids += num_ids;
2380         return 0;
2381 }
2382 EXPORT_SYMBOL_GPL(iommu_fwspec_add_ids);
2383
2384 /*
2385  * Per device IOMMU features.
2386  */
2387 bool iommu_dev_has_feature(struct device *dev, enum iommu_dev_features feat)
2388 {
2389         const struct iommu_ops *ops = dev->bus->iommu_ops;
2390
2391         if (ops && ops->dev_has_feat)
2392                 return ops->dev_has_feat(dev, feat);
2393
2394         return false;
2395 }
2396 EXPORT_SYMBOL_GPL(iommu_dev_has_feature);
2397
2398 int iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features feat)
2399 {
2400         const struct iommu_ops *ops = dev->bus->iommu_ops;
2401
2402         if (ops && ops->dev_enable_feat)
2403                 return ops->dev_enable_feat(dev, feat);
2404
2405         return -ENODEV;
2406 }
2407 EXPORT_SYMBOL_GPL(iommu_dev_enable_feature);
2408
2409 /*
2410  * The device drivers should do the necessary cleanups before calling this.
2411  * For example, before disabling the aux-domain feature, the device driver
2412  * should detach all aux-domains. Otherwise, this will return -EBUSY.
2413  */
2414 int iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features feat)
2415 {
2416         const struct iommu_ops *ops = dev->bus->iommu_ops;
2417
2418         if (ops && ops->dev_disable_feat)
2419                 return ops->dev_disable_feat(dev, feat);
2420
2421         return -EBUSY;
2422 }
2423 EXPORT_SYMBOL_GPL(iommu_dev_disable_feature);
2424
2425 bool iommu_dev_feature_enabled(struct device *dev, enum iommu_dev_features feat)
2426 {
2427         const struct iommu_ops *ops = dev->bus->iommu_ops;
2428
2429         if (ops && ops->dev_feat_enabled)
2430                 return ops->dev_feat_enabled(dev, feat);
2431
2432         return false;
2433 }
2434 EXPORT_SYMBOL_GPL(iommu_dev_feature_enabled);
2435
2436 /*
2437  * Aux-domain specific attach/detach.
2438  *
2439  * Only works if iommu_dev_feature_enabled(dev, IOMMU_DEV_FEAT_AUX) returns
2440  * true. Also, as long as domains are attached to a device through this
2441  * interface, any tries to call iommu_attach_device() should fail
2442  * (iommu_detach_device() can't fail, so we fail when trying to re-attach).
2443  * This should make us safe against a device being attached to a guest as a
2444  * whole while there are still pasid users on it (aux and sva).
2445  */
2446 int iommu_aux_attach_device(struct iommu_domain *domain, struct device *dev)
2447 {
2448         int ret = -ENODEV;
2449
2450         if (domain->ops->aux_attach_dev)
2451                 ret = domain->ops->aux_attach_dev(domain, dev);
2452
2453         if (!ret)
2454                 trace_attach_device_to_domain(dev);
2455
2456         return ret;
2457 }
2458 EXPORT_SYMBOL_GPL(iommu_aux_attach_device);
2459
2460 void iommu_aux_detach_device(struct iommu_domain *domain, struct device *dev)
2461 {
2462         if (domain->ops->aux_detach_dev) {
2463                 domain->ops->aux_detach_dev(domain, dev);
2464                 trace_detach_device_from_domain(dev);
2465         }
2466 }
2467 EXPORT_SYMBOL_GPL(iommu_aux_detach_device);
2468
2469 int iommu_aux_get_pasid(struct iommu_domain *domain, struct device *dev)
2470 {
2471         int ret = -ENODEV;
2472
2473         if (domain->ops->aux_get_pasid)
2474                 ret = domain->ops->aux_get_pasid(domain, dev);
2475
2476         return ret;
2477 }
2478 EXPORT_SYMBOL_GPL(iommu_aux_get_pasid);
2479
2480 /**
2481  * iommu_sva_bind_device() - Bind a process address space to a device
2482  * @dev: the device
2483  * @mm: the mm to bind, caller must hold a reference to it
2484  *
2485  * Create a bond between device and address space, allowing the device to access
2486  * the mm using the returned PASID. If a bond already exists between @device and
2487  * @mm, it is returned and an additional reference is taken. Caller must call
2488  * iommu_sva_unbind_device() to release each reference.
2489  *
2490  * iommu_dev_enable_feature(dev, IOMMU_DEV_FEAT_SVA) must be called first, to
2491  * initialize the required SVA features.
2492  *
2493  * On error, returns an ERR_PTR value.
2494  */
2495 struct iommu_sva *
2496 iommu_sva_bind_device(struct device *dev, struct mm_struct *mm, void *drvdata)
2497 {
2498         struct iommu_group *group;
2499         struct iommu_sva *handle = ERR_PTR(-EINVAL);
2500         const struct iommu_ops *ops = dev->bus->iommu_ops;
2501
2502         if (!ops || !ops->sva_bind)
2503                 return ERR_PTR(-ENODEV);
2504
2505         group = iommu_group_get(dev);
2506         if (!group)
2507                 return ERR_PTR(-ENODEV);
2508
2509         /* Ensure device count and domain don't change while we're binding */
2510         mutex_lock(&group->mutex);
2511
2512         /*
2513          * To keep things simple, SVA currently doesn't support IOMMU groups
2514          * with more than one device. Existing SVA-capable systems are not
2515          * affected by the problems that required IOMMU groups (lack of ACS
2516          * isolation, device ID aliasing and other hardware issues).
2517          */
2518         if (iommu_group_device_count(group) != 1)
2519                 goto out_unlock;
2520
2521         handle = ops->sva_bind(dev, mm, drvdata);
2522
2523 out_unlock:
2524         mutex_unlock(&group->mutex);
2525         iommu_group_put(group);
2526
2527         return handle;
2528 }
2529 EXPORT_SYMBOL_GPL(iommu_sva_bind_device);
2530
2531 /**
2532  * iommu_sva_unbind_device() - Remove a bond created with iommu_sva_bind_device
2533  * @handle: the handle returned by iommu_sva_bind_device()
2534  *
2535  * Put reference to a bond between device and address space. The device should
2536  * not be issuing any more transaction for this PASID. All outstanding page
2537  * requests for this PASID must have been flushed to the IOMMU.
2538  *
2539  * Returns 0 on success, or an error value
2540  */
2541 void iommu_sva_unbind_device(struct iommu_sva *handle)
2542 {
2543         struct iommu_group *group;
2544         struct device *dev = handle->dev;
2545         const struct iommu_ops *ops = dev->bus->iommu_ops;
2546
2547         if (!ops || !ops->sva_unbind)
2548                 return;
2549
2550         group = iommu_group_get(dev);
2551         if (!group)
2552                 return;
2553
2554         mutex_lock(&group->mutex);
2555         ops->sva_unbind(handle);
2556         mutex_unlock(&group->mutex);
2557
2558         iommu_group_put(group);
2559 }
2560 EXPORT_SYMBOL_GPL(iommu_sva_unbind_device);
2561
2562 int iommu_sva_set_ops(struct iommu_sva *handle,
2563                       const struct iommu_sva_ops *sva_ops)
2564 {
2565         if (handle->ops && handle->ops != sva_ops)
2566                 return -EEXIST;
2567
2568         handle->ops = sva_ops;
2569         return 0;
2570 }
2571 EXPORT_SYMBOL_GPL(iommu_sva_set_ops);
2572
2573 int iommu_sva_get_pasid(struct iommu_sva *handle)
2574 {
2575         const struct iommu_ops *ops = handle->dev->bus->iommu_ops;
2576
2577         if (!ops || !ops->sva_get_pasid)
2578                 return IOMMU_PASID_INVALID;
2579
2580         return ops->sva_get_pasid(handle);
2581 }
2582 EXPORT_SYMBOL_GPL(iommu_sva_get_pasid);