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 struct iommu_domain {
  55         const struct iommu_ops *ops;
  56         void *priv;
  57         iommu_fault_handler_t handler;
  58         void *handler_token;
  59         struct iommu_domain_geometry geometry;
  60 };
  61
  62 enum iommu_cap {
  63         IOMMU_CAP_CACHE_COHERENCY,      /* IOMMU can enforce cache coherent DMA
  64                                            transactions */
  65         IOMMU_CAP_INTR_REMAP,           /* IOMMU supports interrupt isolation */
  66         IOMMU_CAP_NOEXEC,               /* IOMMU_NOEXEC flag */
  67 };
  68
  69 /*
  70  * Following constraints are specifc to FSL_PAMUV1:
  71  *  -aperture must be power of 2, and naturally aligned
  72  *  -number of windows must be power of 2, and address space size
  73  *   of each window is determined by aperture size / # of windows
  74  *  -the actual size of the mapped region of a window must be power
  75  *   of 2 starting with 4KB and physical address must be naturally
  76  *   aligned.
  77  * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
  78  * The caller can invoke iommu_domain_get_attr to check if the underlying
  79  * iommu implementation supports these constraints.
  80  */
  81
  82 enum iommu_attr {
  83         DOMAIN_ATTR_GEOMETRY,
  84         DOMAIN_ATTR_PAGING,
  85         DOMAIN_ATTR_WINDOWS,
  86         DOMAIN_ATTR_FSL_PAMU_STASH,
  87         DOMAIN_ATTR_FSL_PAMU_ENABLE,
  88         DOMAIN_ATTR_FSL_PAMUV1,
  89         DOMAIN_ATTR_NESTING,    /* two stages of translation */
  90         DOMAIN_ATTR_MAX,
  91 };
  92
  93 #ifdef CONFIG_IOMMU_API
  94
  95 /**
  96  * struct iommu_ops - iommu ops and capabilities
  97  * @domain_init: init iommu domain
  98  * @domain_destroy: destroy iommu domain
  99  * @attach_dev: attach device to an iommu domain
 100  * @detach_dev: detach device from an iommu domain
 101  * @map: map a physically contiguous memory region to an iommu domain
 102  * @unmap: unmap a physically contiguous memory region from an iommu domain
 103  * @map_sg: map a scatter-gather list of physically contiguous memory chunks
 104  * to an iommu domain
 105  * @iova_to_phys: translate iova to physical address
 106  * @add_device: add device to iommu grouping
 107  * @remove_device: remove device from iommu grouping
 108  * @domain_get_attr: Query domain attributes
 109  * @domain_set_attr: Change domain attributes
 110  * @of_xlate: add OF master IDs to iommu grouping
 111  * @pgsize_bitmap: bitmap of supported page sizes
 112  * @priv: per-instance data private to the iommu driver
 113  */
 114 struct iommu_ops {
 115         bool (*capable)(enum iommu_cap);
 116         int (*domain_init)(struct iommu_domain *domain);
 117         void (*domain_destroy)(struct iommu_domain *domain);
 118
 119         /* Domain allocation and freeing by the iommu driver */
 120         struct iommu_domain *(*domain_alloc)(void);
 121         void (*domain_free)(struct iommu_domain *);
 122
 123         int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
 124         void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
 125         int (*map)(struct iommu_domain *domain, unsigned long iova,
 126                    phys_addr_t paddr, size_t size, int prot);
 127         size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
 128                      size_t size);
 129         size_t (*map_sg)(struct iommu_domain *domain, unsigned long iova,
 130                          struct scatterlist *sg, unsigned int nents, int prot);
 131         phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
 132         int (*add_device)(struct device *dev);
 133         void (*remove_device)(struct device *dev);
 134         int (*device_group)(struct device *dev, unsigned int *groupid);
 135         int (*domain_get_attr)(struct iommu_domain *domain,
 136                                enum iommu_attr attr, void *data);
 137         int (*domain_set_attr)(struct iommu_domain *domain,
 138                                enum iommu_attr attr, void *data);
 139
 140         /* Window handling functions */
 141         int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
 142                                     phys_addr_t paddr, u64 size, int prot);
 143         void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
 144         /* Set the numer of window per domain */
 145         int (*domain_set_windows)(struct iommu_domain *domain, u32 w_count);
 146         /* Get the numer of window per domain */
 147         u32 (*domain_get_windows)(struct iommu_domain *domain);
 148
 149 #ifdef CONFIG_OF_IOMMU
 150         int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
 151 #endif
 152
 153         unsigned long pgsize_bitmap;
 154         void *priv;
 155 };
 156
 157 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE           1 /* Device added */
 158 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE           2 /* Pre Device removed */
 159 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER          3 /* Pre Driver bind */
 160 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER         4 /* Post Driver bind */
 161 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER        5 /* Pre Driver unbind */
 162 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER       6 /* Post Driver unbind */
 163
 164 extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops);
 165 extern bool iommu_present(struct bus_type *bus);
 166 extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
 167 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
 168 extern struct iommu_group *iommu_group_get_by_id(int id);
 169 extern void iommu_domain_free(struct iommu_domain *domain);
 170 extern int iommu_attach_device(struct iommu_domain *domain,
 171                                struct device *dev);
 172 extern void iommu_detach_device(struct iommu_domain *domain,
 173                                 struct device *dev);
 174 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
 175                      phys_addr_t paddr, size_t size, int prot);
 176 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
 177                        size_t size);
 178 extern size_t default_iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
 179                                 struct scatterlist *sg,unsigned int nents,
 180                                 int prot);
 181 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
 182 extern void iommu_set_fault_handler(struct iommu_domain *domain,
 183                         iommu_fault_handler_t handler, void *token);
 184
 185 extern int iommu_attach_group(struct iommu_domain *domain,
 186                               struct iommu_group *group);
 187 extern void iommu_detach_group(struct iommu_domain *domain,
 188                                struct iommu_group *group);
 189 extern struct iommu_group *iommu_group_alloc(void);
 190 extern void *iommu_group_get_iommudata(struct iommu_group *group);
 191 extern void iommu_group_set_iommudata(struct iommu_group *group,
 192                                       void *iommu_data,
 193                                       void (*release)(void *iommu_data));
 194 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
 195 extern int iommu_group_add_device(struct iommu_group *group,
 196                                   struct device *dev);
 197 extern void iommu_group_remove_device(struct device *dev);
 198 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
 199                                     int (*fn)(struct device *, void *));
 200 extern struct iommu_group *iommu_group_get(struct device *dev);
 201 extern void iommu_group_put(struct iommu_group *group);
 202 extern int iommu_group_register_notifier(struct iommu_group *group,
 203                                          struct notifier_block *nb);
 204 extern int iommu_group_unregister_notifier(struct iommu_group *group,
 205                                            struct notifier_block *nb);
 206 extern int iommu_group_id(struct iommu_group *group);
 207 extern struct iommu_group *iommu_group_get_for_dev(struct device *dev);
 208
 209 extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
 210                                  void *data);
 211 extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
 212                                  void *data);
 213 struct device *iommu_device_create(struct device *parent, void *drvdata,
 214                                    const struct attribute_group **groups,
 215                                    const char *fmt, ...);
 216 void iommu_device_destroy(struct device *dev);
 217 int iommu_device_link(struct device *dev, struct device *link);
 218 void iommu_device_unlink(struct device *dev, struct device *link);
 219
 220 /* Window handling function prototypes */
 221 extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
 222                                       phys_addr_t offset, u64 size,
 223                                       int prot);
 224 extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
 225 /**
 226  * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
 227  * @domain: the iommu domain where the fault has happened
 228  * @dev: the device where the fault has happened
 229  * @iova: the faulting address
 230  * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
 231  *
 232  * This function should be called by the low-level IOMMU implementations
 233  * whenever IOMMU faults happen, to allow high-level users, that are
 234  * interested in such events, to know about them.
 235  *
 236  * This event may be useful for several possible use cases:
 237  * - mere logging of the event
 238  * - dynamic TLB/PTE loading
 239  * - if restarting of the faulting device is required
 240  *
 241  * Returns 0 on success and an appropriate error code otherwise (if dynamic
 242  * PTE/TLB loading will one day be supported, implementations will be able
 243  * to tell whether it succeeded or not according to this return value).
 244  *
 245  * Specifically, -ENOSYS is returned if a fault handler isn't installed
 246  * (though fault handlers can also return -ENOSYS, in case they want to
 247  * elicit the default behavior of the IOMMU drivers).
 248  */
 249 static inline int report_iommu_fault(struct iommu_domain *domain,
 250                 struct device *dev, unsigned long iova, int flags)
 251 {
 252         int ret = -ENOSYS;
 253
 254         /*
 255          * if upper layers showed interest and installed a fault handler,
 256          * invoke it.
 257          */
 258         if (domain->handler)
 259                 ret = domain->handler(domain, dev, iova, flags,
 260                                                 domain->handler_token);
 261
 262         trace_io_page_fault(dev, iova, flags);
 263         return ret;
 264 }
 265
 266 static inline size_t iommu_map_sg(struct iommu_domain *domain,
 267                                   unsigned long iova, struct scatterlist *sg,
 268                                   unsigned int nents, int prot)
 269 {
 270         return domain->ops->map_sg(domain, iova, sg, nents, prot);
 271 }
 272
 273 #else /* CONFIG_IOMMU_API */
 274
 275 struct iommu_ops {};
 276 struct iommu_group {};
 277
 278 static inline bool iommu_present(struct bus_type *bus)
 279 {
 280         return false;
 281 }
 282
 283 static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
 284 {
 285         return false;
 286 }
 287
 288 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
 289 {
 290         return NULL;
 291 }
 292
 293 static inline struct iommu_group *iommu_group_get_by_id(int id)
 294 {
 295         return NULL;
 296 }
 297
 298 static inline void iommu_domain_free(struct iommu_domain *domain)
 299 {
 300 }
 301
 302 static inline int iommu_attach_device(struct iommu_domain *domain,
 303                                       struct device *dev)
 304 {
 305         return -ENODEV;
 306 }
 307
 308 static inline void iommu_detach_device(struct iommu_domain *domain,
 309                                        struct device *dev)
 310 {
 311 }
 312
 313 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
 314                             phys_addr_t paddr, int gfp_order, int prot)
 315 {
 316         return -ENODEV;
 317 }
 318
 319 static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
 320                               int gfp_order)
 321 {
 322         return -ENODEV;
 323 }
 324
 325 static inline size_t iommu_map_sg(struct iommu_domain *domain,
 326                                   unsigned long iova, struct scatterlist *sg,
 327                                   unsigned int nents, int prot)
 328 {
 329         return -ENODEV;
 330 }
 331
 332 static inline int iommu_domain_window_enable(struct iommu_domain *domain,
 333                                              u32 wnd_nr, phys_addr_t paddr,
 334                                              u64 size, int prot)
 335 {
 336         return -ENODEV;
 337 }
 338
 339 static inline void iommu_domain_window_disable(struct iommu_domain *domain,
 340                                                u32 wnd_nr)
 341 {
 342 }
 343
 344 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
 345 {
 346         return 0;
 347 }
 348
 349 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
 350                                 iommu_fault_handler_t handler, void *token)
 351 {
 352 }
 353
 354 static inline int iommu_attach_group(struct iommu_domain *domain,
 355                                      struct iommu_group *group)
 356 {
 357         return -ENODEV;
 358 }
 359
 360 static inline void iommu_detach_group(struct iommu_domain *domain,
 361                                       struct iommu_group *group)
 362 {
 363 }
 364
 365 static inline struct iommu_group *iommu_group_alloc(void)
 366 {
 367         return ERR_PTR(-ENODEV);
 368 }
 369
 370 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
 371 {
 372         return NULL;
 373 }
 374
 375 static inline void iommu_group_set_iommudata(struct iommu_group *group,
 376                                              void *iommu_data,
 377                                              void (*release)(void *iommu_data))
 378 {
 379 }
 380
 381 static inline int iommu_group_set_name(struct iommu_group *group,
 382                                        const char *name)
 383 {
 384         return -ENODEV;
 385 }
 386
 387 static inline int iommu_group_add_device(struct iommu_group *group,
 388                                          struct device *dev)
 389 {
 390         return -ENODEV;
 391 }
 392
 393 static inline void iommu_group_remove_device(struct device *dev)
 394 {
 395 }
 396
 397 static inline int iommu_group_for_each_dev(struct iommu_group *group,
 398                                            void *data,
 399                                            int (*fn)(struct device *, void *))
 400 {
 401         return -ENODEV;
 402 }
 403
 404 static inline struct iommu_group *iommu_group_get(struct device *dev)
 405 {
 406         return NULL;
 407 }
 408
 409 static inline void iommu_group_put(struct iommu_group *group)
 410 {
 411 }
 412
 413 static inline int iommu_group_register_notifier(struct iommu_group *group,
 414                                                 struct notifier_block *nb)
 415 {
 416         return -ENODEV;
 417 }
 418
 419 static inline int iommu_group_unregister_notifier(struct iommu_group *group,
 420                                                   struct notifier_block *nb)
 421 {
 422         return 0;
 423 }
 424
 425 static inline int iommu_group_id(struct iommu_group *group)
 426 {
 427         return -ENODEV;
 428 }
 429
 430 static inline int iommu_domain_get_attr(struct iommu_domain *domain,
 431                                         enum iommu_attr attr, void *data)
 432 {
 433         return -EINVAL;
 434 }
 435
 436 static inline int iommu_domain_set_attr(struct iommu_domain *domain,
 437                                         enum iommu_attr attr, void *data)
 438 {
 439         return -EINVAL;
 440 }
 441
 442 static inline struct device *iommu_device_create(struct device *parent,
 443                                         void *drvdata,
 444                                         const struct attribute_group **groups,
 445                                         const char *fmt, ...)
 446 {
 447         return ERR_PTR(-ENODEV);
 448 }
 449
 450 static inline void iommu_device_destroy(struct device *dev)
 451 {
 452 }
 453
 454 static inline int iommu_device_link(struct device *dev, struct device *link)
 455 {
 456         return -EINVAL;
 457 }
 458
 459 static inline void iommu_device_unlink(struct device *dev, struct device *link)
 460 {
 461 }
 462
 463 #endif /* CONFIG_IOMMU_API */
 464
 465 #endif /* __LINUX_IOMMU_H */