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 iommu_group;
  30 struct bus_type;
  31 struct device;
  32 struct iommu_domain;
  33
  34 /* iommu fault flags */
  35 #define IOMMU_FAULT_READ        0x0
  36 #define IOMMU_FAULT_WRITE       0x1
  37
  38 typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
  39                         struct device *, unsigned long, int, void *);
  40
  41 struct iommu_domain {
  42         struct iommu_ops *ops;
  43         void *priv;
  44         iommu_fault_handler_t handler;
  45         void *handler_token;
  46 };
  47
  48 #define IOMMU_CAP_CACHE_COHERENCY       0x1
  49 #define IOMMU_CAP_INTR_REMAP            0x2     /* isolates device intrs */
  50
  51 #ifdef CONFIG_IOMMU_API
  52
  53 /**
  54  * struct iommu_ops - iommu ops and capabilities
  55  * @domain_init: init iommu domain
  56  * @domain_destroy: destroy iommu domain
  57  * @attach_dev: attach device to an iommu domain
  58  * @detach_dev: detach device from an iommu domain
  59  * @map: map a physically contiguous memory region to an iommu domain
  60  * @unmap: unmap a physically contiguous memory region from an iommu domain
  61  * @iova_to_phys: translate iova to physical address
  62  * @domain_has_cap: domain capabilities query
  63  * @commit: commit iommu domain
  64  * @add_device: add device to iommu grouping
  65  * @remove_device: remove device from iommu grouping
  66  * @pgsize_bitmap: bitmap of supported page sizes
  67  */
  68 struct iommu_ops {
  69         int (*domain_init)(struct iommu_domain *domain);
  70         void (*domain_destroy)(struct iommu_domain *domain);
  71         int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
  72         void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
  73         int (*map)(struct iommu_domain *domain, unsigned long iova,
  74                    phys_addr_t paddr, size_t size, int prot);
  75         size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
  76                      size_t size);
  77         phys_addr_t (*iova_to_phys)(struct iommu_domain *domain,
  78                                     unsigned long iova);
  79         int (*domain_has_cap)(struct iommu_domain *domain,
  80                               unsigned long cap);
  81         int (*add_device)(struct device *dev);
  82         void (*remove_device)(struct device *dev);
  83         unsigned long pgsize_bitmap;
  84 };
  85
  86 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE           1 /* Device added */
  87 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE           2 /* Pre Device removed */
  88 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER          3 /* Pre Driver bind */
  89 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER         4 /* Post Driver bind */
  90 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER        5 /* Pre Driver unbind */
  91 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER       6 /* Post Driver unbind */
  92
  93 extern int bus_set_iommu(struct bus_type *bus, struct iommu_ops *ops);
  94 extern bool iommu_present(struct bus_type *bus);
  95 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
  96 extern void iommu_domain_free(struct iommu_domain *domain);
  97 extern int iommu_attach_device(struct iommu_domain *domain,
  98                                struct device *dev);
  99 extern void iommu_detach_device(struct iommu_domain *domain,
 100                                 struct device *dev);
 101 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
 102                      phys_addr_t paddr, size_t size, int prot);
 103 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
 104                        size_t size);
 105 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain,
 106                                       unsigned long iova);
 107 extern int iommu_domain_has_cap(struct iommu_domain *domain,
 108                                 unsigned long cap);
 109 extern void iommu_set_fault_handler(struct iommu_domain *domain,
 110                         iommu_fault_handler_t handler, void *token);
 111
 112 extern int iommu_attach_group(struct iommu_domain *domain,
 113                               struct iommu_group *group);
 114 extern void iommu_detach_group(struct iommu_domain *domain,
 115                                struct iommu_group *group);
 116 extern struct iommu_group *iommu_group_alloc(void);
 117 extern void *iommu_group_get_iommudata(struct iommu_group *group);
 118 extern void iommu_group_set_iommudata(struct iommu_group *group,
 119                                       void *iommu_data,
 120                                       void (*release)(void *iommu_data));
 121 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
 122 extern int iommu_group_add_device(struct iommu_group *group,
 123                                   struct device *dev);
 124 extern void iommu_group_remove_device(struct device *dev);
 125 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
 126                                     int (*fn)(struct device *, void *));
 127 extern struct iommu_group *iommu_group_get(struct device *dev);
 128 extern void iommu_group_put(struct iommu_group *group);
 129 extern int iommu_group_register_notifier(struct iommu_group *group,
 130                                          struct notifier_block *nb);
 131 extern int iommu_group_unregister_notifier(struct iommu_group *group,
 132                                            struct notifier_block *nb);
 133 extern int iommu_group_id(struct iommu_group *group);
 134
 135 /**
 136  * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
 137  * @domain: the iommu domain where the fault has happened
 138  * @dev: the device where the fault has happened
 139  * @iova: the faulting address
 140  * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
 141  *
 142  * This function should be called by the low-level IOMMU implementations
 143  * whenever IOMMU faults happen, to allow high-level users, that are
 144  * interested in such events, to know about them.
 145  *
 146  * This event may be useful for several possible use cases:
 147  * - mere logging of the event
 148  * - dynamic TLB/PTE loading
 149  * - if restarting of the faulting device is required
 150  *
 151  * Returns 0 on success and an appropriate error code otherwise (if dynamic
 152  * PTE/TLB loading will one day be supported, implementations will be able
 153  * to tell whether it succeeded or not according to this return value).
 154  *
 155  * Specifically, -ENOSYS is returned if a fault handler isn't installed
 156  * (though fault handlers can also return -ENOSYS, in case they want to
 157  * elicit the default behavior of the IOMMU drivers).
 158  */
 159 static inline int report_iommu_fault(struct iommu_domain *domain,
 160                 struct device *dev, unsigned long iova, int flags)
 161 {
 162         int ret = -ENOSYS;
 163
 164         /*
 165          * if upper layers showed interest and installed a fault handler,
 166          * invoke it.
 167          */
 168         if (domain->handler)
 169                 ret = domain->handler(domain, dev, iova, flags,
 170                                                 domain->handler_token);
 171
 172         return ret;
 173 }
 174
 175 #else /* CONFIG_IOMMU_API */
 176
 177 struct iommu_ops {};
 178 struct iommu_group {};
 179
 180 static inline bool iommu_present(struct bus_type *bus)
 181 {
 182         return false;
 183 }
 184
 185 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
 186 {
 187         return NULL;
 188 }
 189
 190 static inline void iommu_domain_free(struct iommu_domain *domain)
 191 {
 192 }
 193
 194 static inline int iommu_attach_device(struct iommu_domain *domain,
 195                                       struct device *dev)
 196 {
 197         return -ENODEV;
 198 }
 199
 200 static inline void iommu_detach_device(struct iommu_domain *domain,
 201                                        struct device *dev)
 202 {
 203 }
 204
 205 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
 206                             phys_addr_t paddr, int gfp_order, int prot)
 207 {
 208         return -ENODEV;
 209 }
 210
 211 static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
 212                               int gfp_order)
 213 {
 214         return -ENODEV;
 215 }
 216
 217 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain,
 218                                              unsigned long iova)
 219 {
 220         return 0;
 221 }
 222
 223 static inline int domain_has_cap(struct iommu_domain *domain,
 224                                  unsigned long cap)
 225 {
 226         return 0;
 227 }
 228
 229 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
 230                                 iommu_fault_handler_t handler, void *token)
 231 {
 232 }
 233
 234 int iommu_attach_group(struct iommu_domain *domain, struct iommu_group *group)
 235 {
 236         return -ENODEV;
 237 }
 238
 239 void iommu_detach_group(struct iommu_domain *domain, struct iommu_group *group)
 240 {
 241 }
 242
 243 struct iommu_group *iommu_group_alloc(void)
 244 {
 245         return ERR_PTR(-ENODEV);
 246 }
 247
 248 void *iommu_group_get_iommudata(struct iommu_group *group)
 249 {
 250         return NULL;
 251 }
 252
 253 void iommu_group_set_iommudata(struct iommu_group *group, void *iommu_data,
 254                                void (*release)(void *iommu_data))
 255 {
 256 }
 257
 258 int iommu_group_set_name(struct iommu_group *group, const char *name)
 259 {
 260         return -ENODEV;
 261 }
 262
 263 int iommu_group_add_device(struct iommu_group *group, struct device *dev)
 264 {
 265         return -ENODEV;
 266 }
 267
 268 void iommu_group_remove_device(struct device *dev)
 269 {
 270 }
 271
 272 int iommu_group_for_each_dev(struct iommu_group *group, void *data,
 273                              int (*fn)(struct device *, void *))
 274 {
 275         return -ENODEV;
 276 }
 277
 278 struct iommu_group *iommu_group_get(struct device *dev)
 279 {
 280         return NULL;
 281 }
 282
 283 void iommu_group_put(struct iommu_group *group)
 284 {
 285 }
 286
 287 int iommu_group_register_notifier(struct iommu_group *group,
 288                                   struct notifier_block *nb)
 289 {
 290         return -ENODEV;
 291 }
 292
 293 int iommu_group_unregister_notifier(struct iommu_group *group,
 294                                     struct notifier_block *nb)
 295 {
 296         return 0;
 297 }
 298
 299 int iommu_group_id(struct iommu_group *group)
 300 {
 301         return -ENODEV;
 302 }
 303 #endif /* CONFIG_IOMMU_API */
 304
 305 #endif /* __LINUX_IOMMU_H */