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