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
 105         /* Window handling functions */
 106         int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
 107                                     phys_addr_t paddr, u64 size);
 108         void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
 109
 110         unsigned long pgsize_bitmap;
 111 };
 112
 113 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE           1 /* Device added */
 114 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE           2 /* Pre Device removed */
 115 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER          3 /* Pre Driver bind */
 116 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER         4 /* Post Driver bind */
 117 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER        5 /* Pre Driver unbind */
 118 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER       6 /* Post Driver unbind */
 119
 120 extern int bus_set_iommu(struct bus_type *bus, struct iommu_ops *ops);
 121 extern bool iommu_present(struct bus_type *bus);
 122 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
 123 extern void iommu_domain_free(struct iommu_domain *domain);
 124 extern int iommu_attach_device(struct iommu_domain *domain,
 125                                struct device *dev);
 126 extern void iommu_detach_device(struct iommu_domain *domain,
 127                                 struct device *dev);
 128 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
 129                      phys_addr_t paddr, size_t size, int prot);
 130 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
 131                        size_t size);
 132 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain,
 133                                       unsigned long iova);
 134 extern int iommu_domain_has_cap(struct iommu_domain *domain,
 135                                 unsigned long cap);
 136 extern void iommu_set_fault_handler(struct iommu_domain *domain,
 137                         iommu_fault_handler_t handler, void *token);
 138
 139 extern int iommu_attach_group(struct iommu_domain *domain,
 140                               struct iommu_group *group);
 141 extern void iommu_detach_group(struct iommu_domain *domain,
 142                                struct iommu_group *group);
 143 extern struct iommu_group *iommu_group_alloc(void);
 144 extern void *iommu_group_get_iommudata(struct iommu_group *group);
 145 extern void iommu_group_set_iommudata(struct iommu_group *group,
 146                                       void *iommu_data,
 147                                       void (*release)(void *iommu_data));
 148 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
 149 extern int iommu_group_add_device(struct iommu_group *group,
 150                                   struct device *dev);
 151 extern void iommu_group_remove_device(struct device *dev);
 152 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
 153                                     int (*fn)(struct device *, void *));
 154 extern struct iommu_group *iommu_group_get(struct device *dev);
 155 extern void iommu_group_put(struct iommu_group *group);
 156 extern int iommu_group_register_notifier(struct iommu_group *group,
 157                                          struct notifier_block *nb);
 158 extern int iommu_group_unregister_notifier(struct iommu_group *group,
 159                                            struct notifier_block *nb);
 160 extern int iommu_group_id(struct iommu_group *group);
 161
 162 extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
 163                                  void *data);
 164 extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
 165                                  void *data);
 166
 167 /* Window handling function prototypes */
 168 extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
 169                                       phys_addr_t offset, u64 size);
 170 extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
 171 /**
 172  * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
 173  * @domain: the iommu domain where the fault has happened
 174  * @dev: the device where the fault has happened
 175  * @iova: the faulting address
 176  * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
 177  *
 178  * This function should be called by the low-level IOMMU implementations
 179  * whenever IOMMU faults happen, to allow high-level users, that are
 180  * interested in such events, to know about them.
 181  *
 182  * This event may be useful for several possible use cases:
 183  * - mere logging of the event
 184  * - dynamic TLB/PTE loading
 185  * - if restarting of the faulting device is required
 186  *
 187  * Returns 0 on success and an appropriate error code otherwise (if dynamic
 188  * PTE/TLB loading will one day be supported, implementations will be able
 189  * to tell whether it succeeded or not according to this return value).
 190  *
 191  * Specifically, -ENOSYS is returned if a fault handler isn't installed
 192  * (though fault handlers can also return -ENOSYS, in case they want to
 193  * elicit the default behavior of the IOMMU drivers).
 194  */
 195 static inline int report_iommu_fault(struct iommu_domain *domain,
 196                 struct device *dev, unsigned long iova, int flags)
 197 {
 198         int ret = -ENOSYS;
 199
 200         /*
 201          * if upper layers showed interest and installed a fault handler,
 202          * invoke it.
 203          */
 204         if (domain->handler)
 205                 ret = domain->handler(domain, dev, iova, flags,
 206                                                 domain->handler_token);
 207
 208         return ret;
 209 }
 210
 211 #else /* CONFIG_IOMMU_API */
 212
 213 struct iommu_ops {};
 214 struct iommu_group {};
 215
 216 static inline bool iommu_present(struct bus_type *bus)
 217 {
 218         return false;
 219 }
 220
 221 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
 222 {
 223         return NULL;
 224 }
 225
 226 static inline void iommu_domain_free(struct iommu_domain *domain)
 227 {
 228 }
 229
 230 static inline int iommu_attach_device(struct iommu_domain *domain,
 231                                       struct device *dev)
 232 {
 233         return -ENODEV;
 234 }
 235
 236 static inline void iommu_detach_device(struct iommu_domain *domain,
 237                                        struct device *dev)
 238 {
 239 }
 240
 241 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
 242                             phys_addr_t paddr, int gfp_order, int prot)
 243 {
 244         return -ENODEV;
 245 }
 246
 247 static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
 248                               int gfp_order)
 249 {
 250         return -ENODEV;
 251 }
 252
 253 static inline int iommu_domain_window_enable(struct iommu_domain *domain,
 254                                              u32 wnd_nr, phys_addr_t paddr,
 255                                              u64 size)
 256 {
 257         return -ENODEV;
 258 }
 259
 260 static inline void iommu_domain_window_disable(struct iommu_domain *domain,
 261                                                u32 wnd_nr)
 262 {
 263 }
 264
 265 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain,
 266                                              unsigned long iova)
 267 {
 268         return 0;
 269 }
 270
 271 static inline int domain_has_cap(struct iommu_domain *domain,
 272                                  unsigned long cap)
 273 {
 274         return 0;
 275 }
 276
 277 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
 278                                 iommu_fault_handler_t handler, void *token)
 279 {
 280 }
 281
 282 static inline int iommu_attach_group(struct iommu_domain *domain,
 283                                      struct iommu_group *group)
 284 {
 285         return -ENODEV;
 286 }
 287
 288 static inline void iommu_detach_group(struct iommu_domain *domain,
 289                                       struct iommu_group *group)
 290 {
 291 }
 292
 293 static inline struct iommu_group *iommu_group_alloc(void)
 294 {
 295         return ERR_PTR(-ENODEV);
 296 }
 297
 298 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
 299 {
 300         return NULL;
 301 }
 302
 303 static inline void iommu_group_set_iommudata(struct iommu_group *group,
 304                                              void *iommu_data,
 305                                              void (*release)(void *iommu_data))
 306 {
 307 }
 308
 309 static inline int iommu_group_set_name(struct iommu_group *group,
 310                                        const char *name)
 311 {
 312         return -ENODEV;
 313 }
 314
 315 static inline int iommu_group_add_device(struct iommu_group *group,
 316                                          struct device *dev)
 317 {
 318         return -ENODEV;
 319 }
 320
 321 static inline void iommu_group_remove_device(struct device *dev)
 322 {
 323 }
 324
 325 static inline int iommu_group_for_each_dev(struct iommu_group *group,
 326                                            void *data,
 327                                            int (*fn)(struct device *, void *))
 328 {
 329         return -ENODEV;
 330 }
 331
 332 static inline struct iommu_group *iommu_group_get(struct device *dev)
 333 {
 334         return NULL;
 335 }
 336
 337 static inline void iommu_group_put(struct iommu_group *group)
 338 {
 339 }
 340
 341 static inline int iommu_group_register_notifier(struct iommu_group *group,
 342                                                 struct notifier_block *nb)
 343 {
 344         return -ENODEV;
 345 }
 346
 347 static inline int iommu_group_unregister_notifier(struct iommu_group *group,
 348                                                   struct notifier_block *nb)
 349 {
 350         return 0;
 351 }
 352
 353 static inline int iommu_group_id(struct iommu_group *group)
 354 {
 355         return -ENODEV;
 356 }
 357
 358 static inline int iommu_domain_get_attr(struct iommu_domain *domain,
 359                                         enum iommu_attr attr, void *data)
 360 {
 361         return -EINVAL;
 362 }
 363
 364 static inline int iommu_domain_set_attr(struct iommu_domain *domain,
 365                                         enum iommu_attr attr, void *data)
 366 {
 367         return -EINVAL;
 368 }
 369
 370 #endif /* CONFIG_IOMMU_API */
 371
 372 #endif /* __LINUX_IOMMU_H */