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