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