include/linux/iommu.h

   1 /*
   2  * Copyright (C) 2007-2008 Advanced Micro Devices, Inc.
   3  * Author: Joerg Roedel <joerg.roedel@amd.com>
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 as published
   7  * by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17  */
  18
  19 #ifndef __LINUX_IOMMU_H
  20 #define __LINUX_IOMMU_H
  21
  22 #include <linux/errno.h>
  23 #include <linux/err.h>
  24 #include <linux/of.h>
  25 #include <linux/types.h>
  26 #include <linux/scatterlist.h>
  27 #include <trace/events/iommu.h>
  28
  29 #define IOMMU_READ      (1 << 0)
  30 #define IOMMU_WRITE     (1 << 1)
  31 #define IOMMU_CACHE     (1 << 2) /* DMA cache coherency */
  32 #define IOMMU_NOEXEC    (1 << 3)
  33
  34 struct iommu_ops;
  35 struct iommu_group;
  36 struct bus_type;
  37 struct device;
  38 struct iommu_domain;
  39 struct notifier_block;
  40
  41 /* iommu fault flags */
  42 #define IOMMU_FAULT_READ        0x0
  43 #define IOMMU_FAULT_WRITE       0x1
  44
  45 typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
  46                         struct device *, unsigned long, int, void *);
  47
  48 struct iommu_domain_geometry {
  49         dma_addr_t aperture_start; /* First address that can be mapped    */
  50         dma_addr_t aperture_end;   /* Last address that can be mapped     */
  51         bool force_aperture;       /* DMA only allowed in mappable range? */
  52 };
  53
  54 /* Domain feature flags */
  55 #define __IOMMU_DOMAIN_PAGING   (1U << 0)  /* Support for iommu_map/unmap */
  56 #define __IOMMU_DOMAIN_DMA_API  (1U << 1)  /* Domain for use in DMA-API
  57                                               implementation              */
  58 #define __IOMMU_DOMAIN_PT       (1U << 2)  /* Domain is identity mapped   */
  59
  60 /*
  61  * This are the possible domain-types
  62  *
  63  *      IOMMU_DOMAIN_BLOCKED    - All DMA is blocked, can be used to isolate
  64  *                                devices
  65  *      IOMMU_DOMAIN_IDENTITY   - DMA addresses are system physical addresses
  66  *      IOMMU_DOMAIN_UNMANAGED  - DMA mappings managed by IOMMU-API user, used
  67  *                                for VMs
  68  *      IOMMU_DOMAIN_DMA        - Internally used for DMA-API implementations.
  69  *                                This flag allows IOMMU drivers to implement
  70  *                                certain optimizations for these domains
  71  */
  72 #define IOMMU_DOMAIN_BLOCKED    (0U)
  73 #define IOMMU_DOMAIN_IDENTITY   (__IOMMU_DOMAIN_PT)
  74 #define IOMMU_DOMAIN_UNMANAGED  (__IOMMU_DOMAIN_PAGING)
  75 #define IOMMU_DOMAIN_DMA        (__IOMMU_DOMAIN_PAGING |        \
  76                                  __IOMMU_DOMAIN_DMA_API)
  77
  78 struct iommu_domain {
  79         unsigned type;
  80         const struct iommu_ops *ops;
  81         iommu_fault_handler_t handler;
  82         void *handler_token;
  83         struct iommu_domain_geometry geometry;
  84         void *iova_cookie;
  85 };
  86
  87 enum iommu_cap {
  88         IOMMU_CAP_CACHE_COHERENCY,      /* IOMMU can enforce cache coherent DMA
  89                                            transactions */
  90         IOMMU_CAP_INTR_REMAP,           /* IOMMU supports interrupt isolation */
  91         IOMMU_CAP_NOEXEC,               /* IOMMU_NOEXEC flag */
  92 };
  93
  94 /*
  95  * Following constraints are specifc to FSL_PAMUV1:
  96  *  -aperture must be power of 2, and naturally aligned
  97  *  -number of windows must be power of 2, and address space size
  98  *   of each window is determined by aperture size / # of windows
  99  *  -the actual size of the mapped region of a window must be power
 100  *   of 2 starting with 4KB and physical address must be naturally
 101  *   aligned.
 102  * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
 103  * The caller can invoke iommu_domain_get_attr to check if the underlying
 104  * iommu implementation supports these constraints.
 105  */
 106
 107 enum iommu_attr {
 108         DOMAIN_ATTR_GEOMETRY,
 109         DOMAIN_ATTR_PAGING,
 110         DOMAIN_ATTR_WINDOWS,
 111         DOMAIN_ATTR_FSL_PAMU_STASH,
 112         DOMAIN_ATTR_FSL_PAMU_ENABLE,
 113         DOMAIN_ATTR_FSL_PAMUV1,
 114         DOMAIN_ATTR_NESTING,    /* two stages of translation */
 115         DOMAIN_ATTR_MAX,
 116 };
 117
 118 /**
 119  * struct iommu_dm_region - descriptor for a direct mapped memory region
 120  * @list: Linked list pointers
 121  * @start: System physical start address of the region
 122  * @length: Length of the region in bytes
 123  * @prot: IOMMU Protection flags (READ/WRITE/...)
 124  */
 125 struct iommu_dm_region {
 126         struct list_head        list;
 127         phys_addr_t             start;
 128         size_t                  length;
 129         int                     prot;
 130 };
 131
 132 #ifdef CONFIG_IOMMU_API
 133
 134 /**
 135  * struct iommu_ops - iommu ops and capabilities
 136  * @domain_init: init iommu domain
 137  * @domain_destroy: destroy iommu domain
 138  * @attach_dev: attach device to an iommu domain
 139  * @detach_dev: detach device from an iommu domain
 140  * @map: map a physically contiguous memory region to an iommu domain
 141  * @unmap: unmap a physically contiguous memory region from an iommu domain
 142  * @map_sg: map a scatter-gather list of physically contiguous memory chunks
 143  * to an iommu domain
 144  * @iova_to_phys: translate iova to physical address
 145  * @add_device: add device to iommu grouping
 146  * @remove_device: remove device from iommu grouping
 147  * @domain_get_attr: Query domain attributes
 148  * @domain_set_attr: Change domain attributes
 149  * @of_xlate: add OF master IDs to iommu grouping
 150  * @pgsize_bitmap: bitmap of supported page sizes
 151  * @priv: per-instance data private to the iommu driver
 152  */
 153 struct iommu_ops {
 154         bool (*capable)(enum iommu_cap);
 155
 156         /* Domain allocation and freeing by the iommu driver */
 157         struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type);
 158         void (*domain_free)(struct iommu_domain *);
 159
 160         int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
 161         void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
 162         int (*map)(struct iommu_domain *domain, unsigned long iova,
 163                    phys_addr_t paddr, size_t size, int prot);
 164         size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
 165                      size_t size);
 166         size_t (*map_sg)(struct iommu_domain *domain, unsigned long iova,
 167                          struct scatterlist *sg, unsigned int nents, int prot);
 168         phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
 169         int (*add_device)(struct device *dev);
 170         void (*remove_device)(struct device *dev);
 171         struct iommu_group *(*device_group)(struct device *dev);
 172         int (*domain_get_attr)(struct iommu_domain *domain,
 173                                enum iommu_attr attr, void *data);
 174         int (*domain_set_attr)(struct iommu_domain *domain,
 175                                enum iommu_attr attr, void *data);
 176
 177         /* Request/Free a list of direct mapping requirements for a device */
 178         void (*get_dm_regions)(struct device *dev, struct list_head *list);
 179         void (*put_dm_regions)(struct device *dev, struct list_head *list);
 180
 181         /* Window handling functions */
 182         int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
 183                                     phys_addr_t paddr, u64 size, int prot);
 184         void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
 185         /* Set the numer of window per domain */
 186         int (*domain_set_windows)(struct iommu_domain *domain, u32 w_count);
 187         /* Get the numer of window per domain */
 188         u32 (*domain_get_windows)(struct iommu_domain *domain);
 189
 190 #ifdef CONFIG_OF_IOMMU
 191         int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
 192 #endif
 193
 194         unsigned long pgsize_bitmap;
 195         void *priv;
 196 };
 197
 198 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE           1 /* Device added */
 199 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE           2 /* Pre Device removed */
 200 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER          3 /* Pre Driver bind */
 201 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER         4 /* Post Driver bind */
 202 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER        5 /* Pre Driver unbind */
 203 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER       6 /* Post Driver unbind */
 204
 205 extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops);
 206 extern bool iommu_present(struct bus_type *bus);
 207 extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
 208 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
 209 extern struct iommu_group *iommu_group_get_by_id(int id);
 210 extern void iommu_domain_free(struct iommu_domain *domain);
 211 extern int iommu_attach_device(struct iommu_domain *domain,
 212                                struct device *dev);
 213 extern void iommu_detach_device(struct iommu_domain *domain,
 214                                 struct device *dev);
 215 extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
 216 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
 217                      phys_addr_t paddr, size_t size, int prot);
 218 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
 219                        size_t size);
 220 extern size_t default_iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
 221                                 struct scatterlist *sg,unsigned int nents,
 222                                 int prot);
 223 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
 224 extern void iommu_set_fault_handler(struct iommu_domain *domain,
 225                         iommu_fault_handler_t handler, void *token);
 226
 227 extern void iommu_get_dm_regions(struct device *dev, struct list_head *list);
 228 extern void iommu_put_dm_regions(struct device *dev, struct list_head *list);
 229 extern int iommu_request_dm_for_dev(struct device *dev);
 230
 231 extern int iommu_attach_group(struct iommu_domain *domain,
 232                               struct iommu_group *group);
 233 extern void iommu_detach_group(struct iommu_domain *domain,
 234                                struct iommu_group *group);
 235 extern struct iommu_group *iommu_group_alloc(void);
 236 extern void *iommu_group_get_iommudata(struct iommu_group *group);
 237 extern void iommu_group_set_iommudata(struct iommu_group *group,
 238                                       void *iommu_data,
 239                                       void (*release)(void *iommu_data));
 240 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
 241 extern int iommu_group_add_device(struct iommu_group *group,
 242                                   struct device *dev);
 243 extern void iommu_group_remove_device(struct device *dev);
 244 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
 245                                     int (*fn)(struct device *, void *));
 246 extern struct iommu_group *iommu_group_get(struct device *dev);
 247 extern void iommu_group_put(struct iommu_group *group);
 248 extern int iommu_group_register_notifier(struct iommu_group *group,
 249                                          struct notifier_block *nb);
 250 extern int iommu_group_unregister_notifier(struct iommu_group *group,
 251                                            struct notifier_block *nb);
 252 extern int iommu_group_id(struct iommu_group *group);
 253 extern struct iommu_group *iommu_group_get_for_dev(struct device *dev);
 254 extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
 255
 256 extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
 257                                  void *data);
 258 extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
 259                                  void *data);
 260 struct device *iommu_device_create(struct device *parent, void *drvdata,
 261                                    const struct attribute_group **groups,
 262                                    const char *fmt, ...) __printf(4, 5);
 263 void iommu_device_destroy(struct device *dev);
 264 int iommu_device_link(struct device *dev, struct device *link);
 265 void iommu_device_unlink(struct device *dev, struct device *link);
 266
 267 /* Window handling function prototypes */
 268 extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
 269                                       phys_addr_t offset, u64 size,
 270                                       int prot);
 271 extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
 272 /**
 273  * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
 274  * @domain: the iommu domain where the fault has happened
 275  * @dev: the device where the fault has happened
 276  * @iova: the faulting address
 277  * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
 278  *
 279  * This function should be called by the low-level IOMMU implementations
 280  * whenever IOMMU faults happen, to allow high-level users, that are
 281  * interested in such events, to know about them.
 282  *
 283  * This event may be useful for several possible use cases:
 284  * - mere logging of the event
 285  * - dynamic TLB/PTE loading
 286  * - if restarting of the faulting device is required
 287  *
 288  * Returns 0 on success and an appropriate error code otherwise (if dynamic
 289  * PTE/TLB loading will one day be supported, implementations will be able
 290  * to tell whether it succeeded or not according to this return value).
 291  *
 292  * Specifically, -ENOSYS is returned if a fault handler isn't installed
 293  * (though fault handlers can also return -ENOSYS, in case they want to
 294  * elicit the default behavior of the IOMMU drivers).
 295  */
 296 static inline int report_iommu_fault(struct iommu_domain *domain,
 297                 struct device *dev, unsigned long iova, int flags)
 298 {
 299         int ret = -ENOSYS;
 300
 301         /*
 302          * if upper layers showed interest and installed a fault handler,
 303          * invoke it.
 304          */
 305         if (domain->handler)
 306                 ret = domain->handler(domain, dev, iova, flags,
 307                                                 domain->handler_token);
 308
 309         trace_io_page_fault(dev, iova, flags);
 310         return ret;
 311 }
 312
 313 static inline size_t iommu_map_sg(struct iommu_domain *domain,
 314                                   unsigned long iova, struct scatterlist *sg,
 315                                   unsigned int nents, int prot)
 316 {
 317         return domain->ops->map_sg(domain, iova, sg, nents, prot);
 318 }
 319
 320 /* PCI device grouping function */
 321 extern struct iommu_group *pci_device_group(struct device *dev);
 322 /* Generic device grouping function */
 323 extern struct iommu_group *generic_device_group(struct device *dev);
 324
 325 #else /* CONFIG_IOMMU_API */
 326
 327 struct iommu_ops {};
 328 struct iommu_group {};
 329
 330 static inline bool iommu_present(struct bus_type *bus)
 331 {
 332         return false;
 333 }
 334
 335 static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
 336 {
 337         return false;
 338 }
 339
 340 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
 341 {
 342         return NULL;
 343 }
 344
 345 static inline struct iommu_group *iommu_group_get_by_id(int id)
 346 {
 347         return NULL;
 348 }
 349
 350 static inline void iommu_domain_free(struct iommu_domain *domain)
 351 {
 352 }
 353
 354 static inline int iommu_attach_device(struct iommu_domain *domain,
 355                                       struct device *dev)
 356 {
 357         return -ENODEV;
 358 }
 359
 360 static inline void iommu_detach_device(struct iommu_domain *domain,
 361                                        struct device *dev)
 362 {
 363 }
 364
 365 static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
 366 {
 367         return NULL;
 368 }
 369
 370 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
 371                             phys_addr_t paddr, int gfp_order, int prot)
 372 {
 373         return -ENODEV;
 374 }
 375
 376 static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
 377                               int gfp_order)
 378 {
 379         return -ENODEV;
 380 }
 381
 382 static inline size_t iommu_map_sg(struct iommu_domain *domain,
 383                                   unsigned long iova, struct scatterlist *sg,
 384                                   unsigned int nents, int prot)
 385 {
 386         return -ENODEV;
 387 }
 388
 389 static inline int iommu_domain_window_enable(struct iommu_domain *domain,
 390                                              u32 wnd_nr, phys_addr_t paddr,
 391                                              u64 size, int prot)
 392 {
 393         return -ENODEV;
 394 }
 395
 396 static inline void iommu_domain_window_disable(struct iommu_domain *domain,
 397                                                u32 wnd_nr)
 398 {
 399 }
 400
 401 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
 402 {
 403         return 0;
 404 }
 405
 406 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
 407                                 iommu_fault_handler_t handler, void *token)
 408 {
 409 }
 410
 411 static inline void iommu_get_dm_regions(struct device *dev,
 412                                         struct list_head *list)
 413 {
 414 }
 415
 416 static inline void iommu_put_dm_regions(struct device *dev,
 417                                         struct list_head *list)
 418 {
 419 }
 420
 421 static inline int iommu_request_dm_for_dev(struct device *dev)
 422 {
 423         return -ENODEV;
 424 }
 425
 426 static inline int iommu_attach_group(struct iommu_domain *domain,
 427                                      struct iommu_group *group)
 428 {
 429         return -ENODEV;
 430 }
 431
 432 static inline void iommu_detach_group(struct iommu_domain *domain,
 433                                       struct iommu_group *group)
 434 {
 435 }
 436
 437 static inline struct iommu_group *iommu_group_alloc(void)
 438 {
 439         return ERR_PTR(-ENODEV);
 440 }
 441
 442 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
 443 {
 444         return NULL;
 445 }
 446
 447 static inline void iommu_group_set_iommudata(struct iommu_group *group,
 448                                              void *iommu_data,
 449                                              void (*release)(void *iommu_data))
 450 {
 451 }
 452
 453 static inline int iommu_group_set_name(struct iommu_group *group,
 454                                        const char *name)
 455 {
 456         return -ENODEV;
 457 }
 458
 459 static inline int iommu_group_add_device(struct iommu_group *group,
 460                                          struct device *dev)
 461 {
 462         return -ENODEV;
 463 }
 464
 465 static inline void iommu_group_remove_device(struct device *dev)
 466 {
 467 }
 468
 469 static inline int iommu_group_for_each_dev(struct iommu_group *group,
 470                                            void *data,
 471                                            int (*fn)(struct device *, void *))
 472 {
 473         return -ENODEV;
 474 }
 475
 476 static inline struct iommu_group *iommu_group_get(struct device *dev)
 477 {
 478         return NULL;
 479 }
 480
 481 static inline void iommu_group_put(struct iommu_group *group)
 482 {
 483 }
 484
 485 static inline int iommu_group_register_notifier(struct iommu_group *group,
 486                                                 struct notifier_block *nb)
 487 {
 488         return -ENODEV;
 489 }
 490
 491 static inline int iommu_group_unregister_notifier(struct iommu_group *group,
 492                                                   struct notifier_block *nb)
 493 {
 494         return 0;
 495 }
 496
 497 static inline int iommu_group_id(struct iommu_group *group)
 498 {
 499         return -ENODEV;
 500 }
 501
 502 static inline int iommu_domain_get_attr(struct iommu_domain *domain,
 503                                         enum iommu_attr attr, void *data)
 504 {
 505         return -EINVAL;
 506 }
 507
 508 static inline int iommu_domain_set_attr(struct iommu_domain *domain,
 509                                         enum iommu_attr attr, void *data)
 510 {
 511         return -EINVAL;
 512 }
 513
 514 static inline struct device *iommu_device_create(struct device *parent,
 515                                         void *drvdata,
 516                                         const struct attribute_group **groups,
 517                                         const char *fmt, ...)
 518 {
 519         return ERR_PTR(-ENODEV);
 520 }
 521
 522 static inline void iommu_device_destroy(struct device *dev)
 523 {
 524 }
 525
 526 static inline int iommu_device_link(struct device *dev, struct device *link)
 527 {
 528         return -EINVAL;
 529 }
 530
 531 static inline void iommu_device_unlink(struct device *dev, struct device *link)
 532 {
 533 }
 534
 535 #endif /* CONFIG_IOMMU_API */
 536
 537 #endif /* __LINUX_IOMMU_H */