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