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
  24 #define IOMMU_READ      (1)
  25 #define IOMMU_WRITE     (2)
  26 #define IOMMU_CACHE     (4) /* DMA cache coherency */
  27
  28 struct iommu_ops;
  29 struct bus_type;
  30 struct device;
  31 struct iommu_domain;
  32
  33 /* iommu fault flags */
  34 #define IOMMU_FAULT_READ        0x0
  35 #define IOMMU_FAULT_WRITE       0x1
  36
  37 typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
  38                         struct device *, unsigned long, int, void *);
  39
  40 struct iommu_domain {
  41         struct iommu_ops *ops;
  42         void *priv;
  43         iommu_fault_handler_t handler;
  44         void *handler_token;
  45 };
  46
  47 #define IOMMU_CAP_CACHE_COHERENCY       0x1
  48 #define IOMMU_CAP_INTR_REMAP            0x2     /* isolates device intrs */
  49
  50 enum iommu_attr {
  51         DOMAIN_ATTR_MAX,
  52 };
  53
  54 #ifdef CONFIG_IOMMU_API
  55
  56 /**
  57  * struct iommu_ops - iommu ops and capabilities
  58  * @domain_init: init iommu domain
  59  * @domain_destroy: destroy iommu domain
  60  * @attach_dev: attach device to an iommu domain
  61  * @detach_dev: detach device from an iommu domain
  62  * @map: map a physically contiguous memory region to an iommu domain
  63  * @unmap: unmap a physically contiguous memory region from an iommu domain
  64  * @iova_to_phys: translate iova to physical address
  65  * @domain_has_cap: domain capabilities query
  66  * @domain_get_attr: Query domain attributes
  67  * @domain_set_attr: Change domain attributes
  68  * @pgsize_bitmap: bitmap of supported page sizes
  69  */
  70 struct iommu_ops {
  71         int (*domain_init)(struct iommu_domain *domain);
  72         void (*domain_destroy)(struct iommu_domain *domain);
  73         int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
  74         void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
  75         int (*map)(struct iommu_domain *domain, unsigned long iova,
  76                    phys_addr_t paddr, size_t size, int prot);
  77         size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
  78                      size_t size);
  79         phys_addr_t (*iova_to_phys)(struct iommu_domain *domain,
  80                                     unsigned long iova);
  81         int (*domain_has_cap)(struct iommu_domain *domain,
  82                               unsigned long cap);
  83         int (*device_group)(struct device *dev, unsigned int *groupid);
  84         int (*domain_get_attr)(struct iommu_domain *domain,
  85                                enum iommu_attr attr, void *data);
  86         int (*domain_set_attr)(struct iommu_domain *domain,
  87                                enum iommu_attr attr, void *data);
  88         unsigned long pgsize_bitmap;
  89 };
  90
  91 extern int bus_set_iommu(struct bus_type *bus, struct iommu_ops *ops);
  92 extern bool iommu_present(struct bus_type *bus);
  93 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
  94 extern void iommu_domain_free(struct iommu_domain *domain);
  95 extern int iommu_attach_device(struct iommu_domain *domain,
  96                                struct device *dev);
  97 extern void iommu_detach_device(struct iommu_domain *domain,
  98                                 struct device *dev);
  99 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
 100                      phys_addr_t paddr, size_t size, int prot);
 101 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
 102                        size_t size);
 103 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain,
 104                                       unsigned long iova);
 105 extern int iommu_domain_has_cap(struct iommu_domain *domain,
 106                                 unsigned long cap);
 107 extern void iommu_set_fault_handler(struct iommu_domain *domain,
 108                         iommu_fault_handler_t handler, void *token);
 109 extern int iommu_device_group(struct device *dev, unsigned int *groupid);
 110
 111 extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
 112                                  void *data);
 113 extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
 114                                  void *data);
 115
 116 /**
 117  * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
 118  * @domain: the iommu domain where the fault has happened
 119  * @dev: the device where the fault has happened
 120  * @iova: the faulting address
 121  * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
 122  *
 123  * This function should be called by the low-level IOMMU implementations
 124  * whenever IOMMU faults happen, to allow high-level users, that are
 125  * interested in such events, to know about them.
 126  *
 127  * This event may be useful for several possible use cases:
 128  * - mere logging of the event
 129  * - dynamic TLB/PTE loading
 130  * - if restarting of the faulting device is required
 131  *
 132  * Returns 0 on success and an appropriate error code otherwise (if dynamic
 133  * PTE/TLB loading will one day be supported, implementations will be able
 134  * to tell whether it succeeded or not according to this return value).
 135  *
 136  * Specifically, -ENOSYS is returned if a fault handler isn't installed
 137  * (though fault handlers can also return -ENOSYS, in case they want to
 138  * elicit the default behavior of the IOMMU drivers).
 139  */
 140 static inline int report_iommu_fault(struct iommu_domain *domain,
 141                 struct device *dev, unsigned long iova, int flags)
 142 {
 143         int ret = -ENOSYS;
 144
 145         /*
 146          * if upper layers showed interest and installed a fault handler,
 147          * invoke it.
 148          */
 149         if (domain->handler)
 150                 ret = domain->handler(domain, dev, iova, flags,
 151                                                 domain->handler_token);
 152
 153         return ret;
 154 }
 155
 156 #else /* CONFIG_IOMMU_API */
 157
 158 struct iommu_ops {};
 159
 160 static inline bool iommu_present(struct bus_type *bus)
 161 {
 162         return false;
 163 }
 164
 165 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
 166 {
 167         return NULL;
 168 }
 169
 170 static inline void iommu_domain_free(struct iommu_domain *domain)
 171 {
 172 }
 173
 174 static inline int iommu_attach_device(struct iommu_domain *domain,
 175                                       struct device *dev)
 176 {
 177         return -ENODEV;
 178 }
 179
 180 static inline void iommu_detach_device(struct iommu_domain *domain,
 181                                        struct device *dev)
 182 {
 183 }
 184
 185 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
 186                             phys_addr_t paddr, int gfp_order, int prot)
 187 {
 188         return -ENODEV;
 189 }
 190
 191 static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
 192                               int gfp_order)
 193 {
 194         return -ENODEV;
 195 }
 196
 197 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain,
 198                                              unsigned long iova)
 199 {
 200         return 0;
 201 }
 202
 203 static inline int domain_has_cap(struct iommu_domain *domain,
 204                                  unsigned long cap)
 205 {
 206         return 0;
 207 }
 208
 209 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
 210                                 iommu_fault_handler_t handler, void *token)
 211 {
 212 }
 213
 214 static inline int iommu_device_group(struct device *dev, unsigned int *groupid)
 215 {
 216         return -ENODEV;
 217 }
 218
 219 static inline int iommu_domain_get_attr(struct iommu_domain *domain,
 220                                         enum iommu_attr attr, void *data)
 221 {
 222         return -EINVAL;
 223 }
 224
 225 static inline int iommu_domain_set_attr(struct iommu_domain *domain,
 226                                         enum iommu_attr attr, void *data)
 227 {
 228         return -EINVAL;
 229 }
 230
 231 #endif /* CONFIG_IOMMU_API */
 232
 233 #endif /* __LINUX_IOMMU_H */