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_MAX,
  87 };
  88
  89 #ifdef CONFIG_IOMMU_API
  90
  91 /**
  92  * struct iommu_ops - iommu ops and capabilities
  93  * @domain_init: init iommu domain
  94  * @domain_destroy: destroy iommu domain
  95  * @attach_dev: attach device to an iommu domain
  96  * @detach_dev: detach device from an iommu domain
  97  * @map: map a physically contiguous memory region to an iommu domain
  98  * @unmap: unmap a physically contiguous memory region from an iommu domain
  99  * @iova_to_phys: translate iova to physical address
 100  * @domain_has_cap: domain capabilities query
 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  */
 107 struct iommu_ops {
 108         bool (*capable)(enum iommu_cap);
 109         int (*domain_init)(struct iommu_domain *domain);
 110         void (*domain_destroy)(struct iommu_domain *domain);
 111         int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
 112         void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
 113         int (*map)(struct iommu_domain *domain, unsigned long iova,
 114                    phys_addr_t paddr, size_t size, int prot);
 115         size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
 116                      size_t size);
 117         phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
 118         int (*domain_has_cap)(struct iommu_domain *domain,
 119                               unsigned long cap);
 120         int (*add_device)(struct device *dev);
 121         void (*remove_device)(struct device *dev);
 122         int (*device_group)(struct device *dev, unsigned int *groupid);
 123         int (*domain_get_attr)(struct iommu_domain *domain,
 124                                enum iommu_attr attr, void *data);
 125         int (*domain_set_attr)(struct iommu_domain *domain,
 126                                enum iommu_attr attr, void *data);
 127
 128         /* Window handling functions */
 129         int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
 130                                     phys_addr_t paddr, u64 size, int prot);
 131         void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
 132         /* Set the numer of window per domain */
 133         int (*domain_set_windows)(struct iommu_domain *domain, u32 w_count);
 134         /* Get the numer of window per domain */
 135         u32 (*domain_get_windows)(struct iommu_domain *domain);
 136
 137         unsigned long pgsize_bitmap;
 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 int iommu_domain_has_cap(struct iommu_domain *domain,
 163                                 enum iommu_cap cap);
 164 extern void iommu_set_fault_handler(struct iommu_domain *domain,
 165                         iommu_fault_handler_t handler, void *token);
 166
 167 extern int iommu_attach_group(struct iommu_domain *domain,
 168                               struct iommu_group *group);
 169 extern void iommu_detach_group(struct iommu_domain *domain,
 170                                struct iommu_group *group);
 171 extern struct iommu_group *iommu_group_alloc(void);
 172 extern void *iommu_group_get_iommudata(struct iommu_group *group);
 173 extern void iommu_group_set_iommudata(struct iommu_group *group,
 174                                       void *iommu_data,
 175                                       void (*release)(void *iommu_data));
 176 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
 177 extern int iommu_group_add_device(struct iommu_group *group,
 178                                   struct device *dev);
 179 extern void iommu_group_remove_device(struct device *dev);
 180 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
 181                                     int (*fn)(struct device *, void *));
 182 extern struct iommu_group *iommu_group_get(struct device *dev);
 183 extern void iommu_group_put(struct iommu_group *group);
 184 extern int iommu_group_register_notifier(struct iommu_group *group,
 185                                          struct notifier_block *nb);
 186 extern int iommu_group_unregister_notifier(struct iommu_group *group,
 187                                            struct notifier_block *nb);
 188 extern int iommu_group_id(struct iommu_group *group);
 189 extern struct iommu_group *iommu_group_get_for_dev(struct device *dev);
 190
 191 extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
 192                                  void *data);
 193 extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
 194                                  void *data);
 195 struct device *iommu_device_create(struct device *parent, void *drvdata,
 196                                    const struct attribute_group **groups,
 197                                    const char *fmt, ...);
 198 void iommu_device_destroy(struct device *dev);
 199 int iommu_device_link(struct device *dev, struct device *link);
 200 void iommu_device_unlink(struct device *dev, struct device *link);
 201
 202 /* Window handling function prototypes */
 203 extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
 204                                       phys_addr_t offset, u64 size,
 205                                       int prot);
 206 extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
 207 /**
 208  * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
 209  * @domain: the iommu domain where the fault has happened
 210  * @dev: the device where the fault has happened
 211  * @iova: the faulting address
 212  * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
 213  *
 214  * This function should be called by the low-level IOMMU implementations
 215  * whenever IOMMU faults happen, to allow high-level users, that are
 216  * interested in such events, to know about them.
 217  *
 218  * This event may be useful for several possible use cases:
 219  * - mere logging of the event
 220  * - dynamic TLB/PTE loading
 221  * - if restarting of the faulting device is required
 222  *
 223  * Returns 0 on success and an appropriate error code otherwise (if dynamic
 224  * PTE/TLB loading will one day be supported, implementations will be able
 225  * to tell whether it succeeded or not according to this return value).
 226  *
 227  * Specifically, -ENOSYS is returned if a fault handler isn't installed
 228  * (though fault handlers can also return -ENOSYS, in case they want to
 229  * elicit the default behavior of the IOMMU drivers).
 230  */
 231 static inline int report_iommu_fault(struct iommu_domain *domain,
 232                 struct device *dev, unsigned long iova, int flags)
 233 {
 234         int ret = -ENOSYS;
 235
 236         /*
 237          * if upper layers showed interest and installed a fault handler,
 238          * invoke it.
 239          */
 240         if (domain->handler)
 241                 ret = domain->handler(domain, dev, iova, flags,
 242                                                 domain->handler_token);
 243
 244         trace_io_page_fault(dev, iova, flags);
 245         return ret;
 246 }
 247
 248 #else /* CONFIG_IOMMU_API */
 249
 250 struct iommu_ops {};
 251 struct iommu_group {};
 252
 253 static inline bool iommu_present(struct bus_type *bus)
 254 {
 255         return false;
 256 }
 257
 258 static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
 259 {
 260         return false;
 261 }
 262
 263 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
 264 {
 265         return NULL;
 266 }
 267
 268 static inline struct iommu_group *iommu_group_get_by_id(int id)
 269 {
 270         return NULL;
 271 }
 272
 273 static inline void iommu_domain_free(struct iommu_domain *domain)
 274 {
 275 }
 276
 277 static inline int iommu_attach_device(struct iommu_domain *domain,
 278                                       struct device *dev)
 279 {
 280         return -ENODEV;
 281 }
 282
 283 static inline void iommu_detach_device(struct iommu_domain *domain,
 284                                        struct device *dev)
 285 {
 286 }
 287
 288 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
 289                             phys_addr_t paddr, int gfp_order, int prot)
 290 {
 291         return -ENODEV;
 292 }
 293
 294 static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
 295                               int gfp_order)
 296 {
 297         return -ENODEV;
 298 }
 299
 300 static inline int iommu_domain_window_enable(struct iommu_domain *domain,
 301                                              u32 wnd_nr, phys_addr_t paddr,
 302                                              u64 size, int prot)
 303 {
 304         return -ENODEV;
 305 }
 306
 307 static inline void iommu_domain_window_disable(struct iommu_domain *domain,
 308                                                u32 wnd_nr)
 309 {
 310 }
 311
 312 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
 313 {
 314         return 0;
 315 }
 316
 317 static inline int iommu_domain_has_cap(struct iommu_domain *domain,
 318                                        enum iommu_cap cap)
 319 {
 320         return 0;
 321 }
 322
 323 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
 324                                 iommu_fault_handler_t handler, void *token)
 325 {
 326 }
 327
 328 static inline int iommu_attach_group(struct iommu_domain *domain,
 329                                      struct iommu_group *group)
 330 {
 331         return -ENODEV;
 332 }
 333
 334 static inline void iommu_detach_group(struct iommu_domain *domain,
 335                                       struct iommu_group *group)
 336 {
 337 }
 338
 339 static inline struct iommu_group *iommu_group_alloc(void)
 340 {
 341         return ERR_PTR(-ENODEV);
 342 }
 343
 344 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
 345 {
 346         return NULL;
 347 }
 348
 349 static inline void iommu_group_set_iommudata(struct iommu_group *group,
 350                                              void *iommu_data,
 351                                              void (*release)(void *iommu_data))
 352 {
 353 }
 354
 355 static inline int iommu_group_set_name(struct iommu_group *group,
 356                                        const char *name)
 357 {
 358         return -ENODEV;
 359 }
 360
 361 static inline int iommu_group_add_device(struct iommu_group *group,
 362                                          struct device *dev)
 363 {
 364         return -ENODEV;
 365 }
 366
 367 static inline void iommu_group_remove_device(struct device *dev)
 368 {
 369 }
 370
 371 static inline int iommu_group_for_each_dev(struct iommu_group *group,
 372                                            void *data,
 373                                            int (*fn)(struct device *, void *))
 374 {
 375         return -ENODEV;
 376 }
 377
 378 static inline struct iommu_group *iommu_group_get(struct device *dev)
 379 {
 380         return NULL;
 381 }
 382
 383 static inline void iommu_group_put(struct iommu_group *group)
 384 {
 385 }
 386
 387 static inline int iommu_group_register_notifier(struct iommu_group *group,
 388                                                 struct notifier_block *nb)
 389 {
 390         return -ENODEV;
 391 }
 392
 393 static inline int iommu_group_unregister_notifier(struct iommu_group *group,
 394                                                   struct notifier_block *nb)
 395 {
 396         return 0;
 397 }
 398
 399 static inline int iommu_group_id(struct iommu_group *group)
 400 {
 401         return -ENODEV;
 402 }
 403
 404 static inline int iommu_domain_get_attr(struct iommu_domain *domain,
 405                                         enum iommu_attr attr, void *data)
 406 {
 407         return -EINVAL;
 408 }
 409
 410 static inline int iommu_domain_set_attr(struct iommu_domain *domain,
 411                                         enum iommu_attr attr, void *data)
 412 {
 413         return -EINVAL;
 414 }
 415
 416 static inline struct device *iommu_device_create(struct device *parent,
 417                                         void *drvdata,
 418                                         const struct attribute_group **groups,
 419                                         const char *fmt, ...)
 420 {
 421         return ERR_PTR(-ENODEV);
 422 }
 423
 424 static inline void iommu_device_destroy(struct device *dev)
 425 {
 426 }
 427
 428 static inline int iommu_device_link(struct device *dev, struct device *link)
 429 {
 430         return -EINVAL;
 431 }
 432
 433 static inline void iommu_device_unlink(struct device *dev, struct device *link)
 434 {
 435 }
 436
 437 #endif /* CONFIG_IOMMU_API */
 438
 439 #endif /* __LINUX_IOMMU_H */