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