1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Copyright (C) 2007-2008 Advanced Micro Devices, Inc. 4 * Author: Joerg Roedel <[email protected]> 5 */ 6 7 #ifndef __LINUX_IOMMU_H 8 #define __LINUX_IOMMU_H 9 10 #include <linux/scatterlist.h> 11 #include <linux/device.h> 12 #include <linux/types.h> 13 #include <linux/errno.h> 14 #include <linux/err.h> 15 #include <linux/of.h> 16 #include <linux/ioasid.h> 17 #include <uapi/linux/iommu.h> 18 19 #define IOMMU_READ (1 << 0) 20 #define IOMMU_WRITE (1 << 1) 21 #define IOMMU_CACHE (1 << 2) /* DMA cache coherency */ 22 #define IOMMU_NOEXEC (1 << 3) 23 #define IOMMU_MMIO (1 << 4) /* e.g. things like MSI doorbells */ 24 /* 25 * Where the bus hardware includes a privilege level as part of its access type 26 * markings, and certain devices are capable of issuing transactions marked as 27 * either 'supervisor' or 'user', the IOMMU_PRIV flag requests that the other 28 * given permission flags only apply to accesses at the higher privilege level, 29 * and that unprivileged transactions should have as little access as possible. 30 * This would usually imply the same permissions as kernel mappings on the CPU, 31 * if the IOMMU page table format is equivalent. 32 */ 33 #define IOMMU_PRIV (1 << 5) 34 35 struct iommu_ops; 36 struct iommu_group; 37 struct bus_type; 38 struct device; 39 struct iommu_domain; 40 struct notifier_block; 41 struct iommu_sva; 42 struct iommu_fault_event; 43 44 /* iommu fault flags */ 45 #define IOMMU_FAULT_READ 0x0 46 #define IOMMU_FAULT_WRITE 0x1 47 48 typedef int (*iommu_fault_handler_t)(struct iommu_domain *, 49 struct device *, unsigned long, int, void *); 50 typedef int (*iommu_dev_fault_handler_t)(struct iommu_fault *, void *); 51 52 struct iommu_domain_geometry { 53 dma_addr_t aperture_start; /* First address that can be mapped */ 54 dma_addr_t aperture_end; /* Last address that can be mapped */ 55 bool force_aperture; /* DMA only allowed in mappable range? */ 56 }; 57 58 /* Domain feature flags */ 59 #define __IOMMU_DOMAIN_PAGING (1U << 0) /* Support for iommu_map/unmap */ 60 #define __IOMMU_DOMAIN_DMA_API (1U << 1) /* Domain for use in DMA-API 61 implementation */ 62 #define __IOMMU_DOMAIN_PT (1U << 2) /* Domain is identity mapped */ 63 64 /* 65 * This are the possible domain-types 66 * 67 * IOMMU_DOMAIN_BLOCKED - All DMA is blocked, can be used to isolate 68 * devices 69 * IOMMU_DOMAIN_IDENTITY - DMA addresses are system physical addresses 70 * IOMMU_DOMAIN_UNMANAGED - DMA mappings managed by IOMMU-API user, used 71 * for VMs 72 * IOMMU_DOMAIN_DMA - Internally used for DMA-API implementations. 73 * This flag allows IOMMU drivers to implement 74 * certain optimizations for these domains 75 */ 76 #define IOMMU_DOMAIN_BLOCKED (0U) 77 #define IOMMU_DOMAIN_IDENTITY (__IOMMU_DOMAIN_PT) 78 #define IOMMU_DOMAIN_UNMANAGED (__IOMMU_DOMAIN_PAGING) 79 #define IOMMU_DOMAIN_DMA (__IOMMU_DOMAIN_PAGING | \ 80 __IOMMU_DOMAIN_DMA_API) 81 82 struct iommu_domain { 83 unsigned type; 84 const struct iommu_ops *ops; 85 unsigned long pgsize_bitmap; /* Bitmap of page sizes in use */ 86 iommu_fault_handler_t handler; 87 void *handler_token; 88 struct iommu_domain_geometry geometry; 89 void *iova_cookie; 90 }; 91 92 enum iommu_cap { 93 IOMMU_CAP_CACHE_COHERENCY, /* IOMMU can enforce cache coherent DMA 94 transactions */ 95 IOMMU_CAP_INTR_REMAP, /* IOMMU supports interrupt isolation */ 96 IOMMU_CAP_NOEXEC, /* IOMMU_NOEXEC flag */ 97 }; 98 99 /* 100 * Following constraints are specifc to FSL_PAMUV1: 101 * -aperture must be power of 2, and naturally aligned 102 * -number of windows must be power of 2, and address space size 103 * of each window is determined by aperture size / # of windows 104 * -the actual size of the mapped region of a window must be power 105 * of 2 starting with 4KB and physical address must be naturally 106 * aligned. 107 * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints. 108 * The caller can invoke iommu_domain_get_attr to check if the underlying 109 * iommu implementation supports these constraints. 110 */ 111 112 enum iommu_attr { 113 DOMAIN_ATTR_GEOMETRY, 114 DOMAIN_ATTR_PAGING, 115 DOMAIN_ATTR_WINDOWS, 116 DOMAIN_ATTR_FSL_PAMU_STASH, 117 DOMAIN_ATTR_FSL_PAMU_ENABLE, 118 DOMAIN_ATTR_FSL_PAMUV1, 119 DOMAIN_ATTR_NESTING, /* two stages of translation */ 120 DOMAIN_ATTR_DMA_USE_FLUSH_QUEUE, 121 DOMAIN_ATTR_MAX, 122 }; 123 124 /* These are the possible reserved region types */ 125 enum iommu_resv_type { 126 /* Memory regions which must be mapped 1:1 at all times */ 127 IOMMU_RESV_DIRECT, 128 /* 129 * Memory regions which are advertised to be 1:1 but are 130 * commonly considered relaxable in some conditions, 131 * for instance in device assignment use case (USB, Graphics) 132 */ 133 IOMMU_RESV_DIRECT_RELAXABLE, 134 /* Arbitrary "never map this or give it to a device" address ranges */ 135 IOMMU_RESV_RESERVED, 136 /* Hardware MSI region (untranslated) */ 137 IOMMU_RESV_MSI, 138 /* Software-managed MSI translation window */ 139 IOMMU_RESV_SW_MSI, 140 }; 141 142 /** 143 * struct iommu_resv_region - descriptor for a reserved memory region 144 * @list: Linked list pointers 145 * @start: System physical start address of the region 146 * @length: Length of the region in bytes 147 * @prot: IOMMU Protection flags (READ/WRITE/...) 148 * @type: Type of the reserved region 149 */ 150 struct iommu_resv_region { 151 struct list_head list; 152 phys_addr_t start; 153 size_t length; 154 int prot; 155 enum iommu_resv_type type; 156 }; 157 158 /* Per device IOMMU features */ 159 enum iommu_dev_features { 160 IOMMU_DEV_FEAT_AUX, /* Aux-domain feature */ 161 IOMMU_DEV_FEAT_SVA, /* Shared Virtual Addresses */ 162 }; 163 164 #define IOMMU_PASID_INVALID (-1U) 165 166 #ifdef CONFIG_IOMMU_API 167 168 /** 169 * struct iommu_iotlb_gather - Range information for a pending IOTLB flush 170 * 171 * @start: IOVA representing the start of the range to be flushed 172 * @end: IOVA representing the end of the range to be flushed (exclusive) 173 * @pgsize: The interval at which to perform the flush 174 * 175 * This structure is intended to be updated by multiple calls to the 176 * ->unmap() function in struct iommu_ops before eventually being passed 177 * into ->iotlb_sync(). 178 */ 179 struct iommu_iotlb_gather { 180 unsigned long start; 181 unsigned long end; 182 size_t pgsize; 183 }; 184 185 /** 186 * struct iommu_ops - iommu ops and capabilities 187 * @capable: check capability 188 * @domain_alloc: allocate iommu domain 189 * @domain_free: free iommu domain 190 * @attach_dev: attach device to an iommu domain 191 * @detach_dev: detach device from an iommu domain 192 * @map: map a physically contiguous memory region to an iommu domain 193 * @unmap: unmap a physically contiguous memory region from an iommu domain 194 * @flush_iotlb_all: Synchronously flush all hardware TLBs for this domain 195 * @iotlb_sync_map: Sync mappings created recently using @map to the hardware 196 * @iotlb_sync: Flush all queued ranges from the hardware TLBs and empty flush 197 * queue 198 * @iova_to_phys: translate iova to physical address 199 * @probe_device: Add device to iommu driver handling 200 * @release_device: Remove device from iommu driver handling 201 * @probe_finalize: Do final setup work after the device is added to an IOMMU 202 * group and attached to the groups domain 203 * @device_group: find iommu group for a particular device 204 * @domain_get_attr: Query domain attributes 205 * @domain_set_attr: Change domain attributes 206 * @get_resv_regions: Request list of reserved regions for a device 207 * @put_resv_regions: Free list of reserved regions for a device 208 * @apply_resv_region: Temporary helper call-back for iova reserved ranges 209 * @domain_window_enable: Configure and enable a particular window for a domain 210 * @domain_window_disable: Disable a particular window for a domain 211 * @of_xlate: add OF master IDs to iommu grouping 212 * @is_attach_deferred: Check if domain attach should be deferred from iommu 213 * driver init to device driver init (default no) 214 * @dev_has/enable/disable_feat: per device entries to check/enable/disable 215 * iommu specific features. 216 * @dev_feat_enabled: check enabled feature 217 * @aux_attach/detach_dev: aux-domain specific attach/detach entries. 218 * @aux_get_pasid: get the pasid given an aux-domain 219 * @sva_bind: Bind process address space to device 220 * @sva_unbind: Unbind process address space from device 221 * @sva_get_pasid: Get PASID associated to a SVA handle 222 * @page_response: handle page request response 223 * @cache_invalidate: invalidate translation caches 224 * @sva_bind_gpasid: bind guest pasid and mm 225 * @sva_unbind_gpasid: unbind guest pasid and mm 226 * @def_domain_type: device default domain type, return value: 227 * - IOMMU_DOMAIN_IDENTITY: must use an identity domain 228 * - IOMMU_DOMAIN_DMA: must use a dma domain 229 * - 0: use the default setting 230 * @pgsize_bitmap: bitmap of all possible supported page sizes 231 * @owner: Driver module providing these ops 232 */ 233 struct iommu_ops { 234 bool (*capable)(enum iommu_cap); 235 236 /* Domain allocation and freeing by the iommu driver */ 237 struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type); 238 void (*domain_free)(struct iommu_domain *); 239 240 int (*attach_dev)(struct iommu_domain *domain, struct device *dev); 241 void (*detach_dev)(struct iommu_domain *domain, struct device *dev); 242 int (*map)(struct iommu_domain *domain, unsigned long iova, 243 phys_addr_t paddr, size_t size, int prot, gfp_t gfp); 244 size_t (*unmap)(struct iommu_domain *domain, unsigned long iova, 245 size_t size, struct iommu_iotlb_gather *iotlb_gather); 246 void (*flush_iotlb_all)(struct iommu_domain *domain); 247 void (*iotlb_sync_map)(struct iommu_domain *domain); 248 void (*iotlb_sync)(struct iommu_domain *domain, 249 struct iommu_iotlb_gather *iotlb_gather); 250 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova); 251 struct iommu_device *(*probe_device)(struct device *dev); 252 void (*release_device)(struct device *dev); 253 void (*probe_finalize)(struct device *dev); 254 struct iommu_group *(*device_group)(struct device *dev); 255 int (*domain_get_attr)(struct iommu_domain *domain, 256 enum iommu_attr attr, void *data); 257 int (*domain_set_attr)(struct iommu_domain *domain, 258 enum iommu_attr attr, void *data); 259 260 /* Request/Free a list of reserved regions for a device */ 261 void (*get_resv_regions)(struct device *dev, struct list_head *list); 262 void (*put_resv_regions)(struct device *dev, struct list_head *list); 263 void (*apply_resv_region)(struct device *dev, 264 struct iommu_domain *domain, 265 struct iommu_resv_region *region); 266 267 /* Window handling functions */ 268 int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr, 269 phys_addr_t paddr, u64 size, int prot); 270 void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr); 271 272 int (*of_xlate)(struct device *dev, struct of_phandle_args *args); 273 bool (*is_attach_deferred)(struct iommu_domain *domain, struct device *dev); 274 275 /* Per device IOMMU features */ 276 bool (*dev_has_feat)(struct device *dev, enum iommu_dev_features f); 277 bool (*dev_feat_enabled)(struct device *dev, enum iommu_dev_features f); 278 int (*dev_enable_feat)(struct device *dev, enum iommu_dev_features f); 279 int (*dev_disable_feat)(struct device *dev, enum iommu_dev_features f); 280 281 /* Aux-domain specific attach/detach entries */ 282 int (*aux_attach_dev)(struct iommu_domain *domain, struct device *dev); 283 void (*aux_detach_dev)(struct iommu_domain *domain, struct device *dev); 284 int (*aux_get_pasid)(struct iommu_domain *domain, struct device *dev); 285 286 struct iommu_sva *(*sva_bind)(struct device *dev, struct mm_struct *mm, 287 void *drvdata); 288 void (*sva_unbind)(struct iommu_sva *handle); 289 u32 (*sva_get_pasid)(struct iommu_sva *handle); 290 291 int (*page_response)(struct device *dev, 292 struct iommu_fault_event *evt, 293 struct iommu_page_response *msg); 294 int (*cache_invalidate)(struct iommu_domain *domain, struct device *dev, 295 struct iommu_cache_invalidate_info *inv_info); 296 int (*sva_bind_gpasid)(struct iommu_domain *domain, 297 struct device *dev, struct iommu_gpasid_bind_data *data); 298 299 int (*sva_unbind_gpasid)(struct device *dev, u32 pasid); 300 301 int (*def_domain_type)(struct device *dev); 302 303 unsigned long pgsize_bitmap; 304 struct module *owner; 305 }; 306 307 /** 308 * struct iommu_device - IOMMU core representation of one IOMMU hardware 309 * instance 310 * @list: Used by the iommu-core to keep a list of registered iommus 311 * @ops: iommu-ops for talking to this iommu 312 * @dev: struct device for sysfs handling 313 */ 314 struct iommu_device { 315 struct list_head list; 316 const struct iommu_ops *ops; 317 struct fwnode_handle *fwnode; 318 struct device *dev; 319 }; 320 321 /** 322 * struct iommu_fault_event - Generic fault event 323 * 324 * Can represent recoverable faults such as a page requests or 325 * unrecoverable faults such as DMA or IRQ remapping faults. 326 * 327 * @fault: fault descriptor 328 * @list: pending fault event list, used for tracking responses 329 */ 330 struct iommu_fault_event { 331 struct iommu_fault fault; 332 struct list_head list; 333 }; 334 335 /** 336 * struct iommu_fault_param - per-device IOMMU fault data 337 * @handler: Callback function to handle IOMMU faults at device level 338 * @data: handler private data 339 * @faults: holds the pending faults which needs response 340 * @lock: protect pending faults list 341 */ 342 struct iommu_fault_param { 343 iommu_dev_fault_handler_t handler; 344 void *data; 345 struct list_head faults; 346 struct mutex lock; 347 }; 348 349 /** 350 * struct dev_iommu - Collection of per-device IOMMU data 351 * 352 * @fault_param: IOMMU detected device fault reporting data 353 * @fwspec: IOMMU fwspec data 354 * @iommu_dev: IOMMU device this device is linked to 355 * @priv: IOMMU Driver private data 356 * 357 * TODO: migrate other per device data pointers under iommu_dev_data, e.g. 358 * struct iommu_group *iommu_group; 359 */ 360 struct dev_iommu { 361 struct mutex lock; 362 struct iommu_fault_param *fault_param; 363 struct iommu_fwspec *fwspec; 364 struct iommu_device *iommu_dev; 365 void *priv; 366 }; 367 368 int iommu_device_register(struct iommu_device *iommu); 369 void iommu_device_unregister(struct iommu_device *iommu); 370 int iommu_device_sysfs_add(struct iommu_device *iommu, 371 struct device *parent, 372 const struct attribute_group **groups, 373 const char *fmt, ...) __printf(4, 5); 374 void iommu_device_sysfs_remove(struct iommu_device *iommu); 375 int iommu_device_link(struct iommu_device *iommu, struct device *link); 376 void iommu_device_unlink(struct iommu_device *iommu, struct device *link); 377 378 static inline void __iommu_device_set_ops(struct iommu_device *iommu, 379 const struct iommu_ops *ops) 380 { 381 iommu->ops = ops; 382 } 383 384 #define iommu_device_set_ops(iommu, ops) \ 385 do { \ 386 struct iommu_ops *__ops = (struct iommu_ops *)(ops); \ 387 __ops->owner = THIS_MODULE; \ 388 __iommu_device_set_ops(iommu, __ops); \ 389 } while (0) 390 391 static inline void iommu_device_set_fwnode(struct iommu_device *iommu, 392 struct fwnode_handle *fwnode) 393 { 394 iommu->fwnode = fwnode; 395 } 396 397 static inline struct iommu_device *dev_to_iommu_device(struct device *dev) 398 { 399 return (struct iommu_device *)dev_get_drvdata(dev); 400 } 401 402 static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather) 403 { 404 *gather = (struct iommu_iotlb_gather) { 405 .start = ULONG_MAX, 406 }; 407 } 408 409 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */ 410 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */ 411 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */ 412 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */ 413 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */ 414 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */ 415 416 extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops); 417 extern int bus_iommu_probe(struct bus_type *bus); 418 extern bool iommu_present(struct bus_type *bus); 419 extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap); 420 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus); 421 extern struct iommu_group *iommu_group_get_by_id(int id); 422 extern void iommu_domain_free(struct iommu_domain *domain); 423 extern int iommu_attach_device(struct iommu_domain *domain, 424 struct device *dev); 425 extern void iommu_detach_device(struct iommu_domain *domain, 426 struct device *dev); 427 extern int iommu_uapi_cache_invalidate(struct iommu_domain *domain, 428 struct device *dev, 429 void __user *uinfo); 430 431 extern int iommu_uapi_sva_bind_gpasid(struct iommu_domain *domain, 432 struct device *dev, void __user *udata); 433 extern int iommu_uapi_sva_unbind_gpasid(struct iommu_domain *domain, 434 struct device *dev, void __user *udata); 435 extern int iommu_sva_unbind_gpasid(struct iommu_domain *domain, 436 struct device *dev, ioasid_t pasid); 437 extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev); 438 extern struct iommu_domain *iommu_get_dma_domain(struct device *dev); 439 extern int iommu_map(struct iommu_domain *domain, unsigned long iova, 440 phys_addr_t paddr, size_t size, int prot); 441 extern int iommu_map_atomic(struct iommu_domain *domain, unsigned long iova, 442 phys_addr_t paddr, size_t size, int prot); 443 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova, 444 size_t size); 445 extern size_t iommu_unmap_fast(struct iommu_domain *domain, 446 unsigned long iova, size_t size, 447 struct iommu_iotlb_gather *iotlb_gather); 448 extern size_t iommu_map_sg(struct iommu_domain *domain, unsigned long iova, 449 struct scatterlist *sg,unsigned int nents, int prot); 450 extern size_t iommu_map_sg_atomic(struct iommu_domain *domain, 451 unsigned long iova, struct scatterlist *sg, 452 unsigned int nents, int prot); 453 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova); 454 extern void iommu_set_fault_handler(struct iommu_domain *domain, 455 iommu_fault_handler_t handler, void *token); 456 457 extern void iommu_get_resv_regions(struct device *dev, struct list_head *list); 458 extern void iommu_put_resv_regions(struct device *dev, struct list_head *list); 459 extern void generic_iommu_put_resv_regions(struct device *dev, 460 struct list_head *list); 461 extern void iommu_set_default_passthrough(bool cmd_line); 462 extern void iommu_set_default_translated(bool cmd_line); 463 extern bool iommu_default_passthrough(void); 464 extern struct iommu_resv_region * 465 iommu_alloc_resv_region(phys_addr_t start, size_t length, int prot, 466 enum iommu_resv_type type); 467 extern int iommu_get_group_resv_regions(struct iommu_group *group, 468 struct list_head *head); 469 470 extern int iommu_attach_group(struct iommu_domain *domain, 471 struct iommu_group *group); 472 extern void iommu_detach_group(struct iommu_domain *domain, 473 struct iommu_group *group); 474 extern struct iommu_group *iommu_group_alloc(void); 475 extern void *iommu_group_get_iommudata(struct iommu_group *group); 476 extern void iommu_group_set_iommudata(struct iommu_group *group, 477 void *iommu_data, 478 void (*release)(void *iommu_data)); 479 extern int iommu_group_set_name(struct iommu_group *group, const char *name); 480 extern int iommu_group_add_device(struct iommu_group *group, 481 struct device *dev); 482 extern void iommu_group_remove_device(struct device *dev); 483 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data, 484 int (*fn)(struct device *, void *)); 485 extern struct iommu_group *iommu_group_get(struct device *dev); 486 extern struct iommu_group *iommu_group_ref_get(struct iommu_group *group); 487 extern void iommu_group_put(struct iommu_group *group); 488 extern int iommu_group_register_notifier(struct iommu_group *group, 489 struct notifier_block *nb); 490 extern int iommu_group_unregister_notifier(struct iommu_group *group, 491 struct notifier_block *nb); 492 extern int iommu_register_device_fault_handler(struct device *dev, 493 iommu_dev_fault_handler_t handler, 494 void *data); 495 496 extern int iommu_unregister_device_fault_handler(struct device *dev); 497 498 extern int iommu_report_device_fault(struct device *dev, 499 struct iommu_fault_event *evt); 500 extern int iommu_page_response(struct device *dev, 501 struct iommu_page_response *msg); 502 503 extern int iommu_group_id(struct iommu_group *group); 504 extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *); 505 506 extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr, 507 void *data); 508 extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr, 509 void *data); 510 511 /* Window handling function prototypes */ 512 extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr, 513 phys_addr_t offset, u64 size, 514 int prot); 515 extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr); 516 517 extern int report_iommu_fault(struct iommu_domain *domain, struct device *dev, 518 unsigned long iova, int flags); 519 520 static inline void iommu_flush_iotlb_all(struct iommu_domain *domain) 521 { 522 if (domain->ops->flush_iotlb_all) 523 domain->ops->flush_iotlb_all(domain); 524 } 525 526 static inline void iommu_iotlb_sync(struct iommu_domain *domain, 527 struct iommu_iotlb_gather *iotlb_gather) 528 { 529 if (domain->ops->iotlb_sync) 530 domain->ops->iotlb_sync(domain, iotlb_gather); 531 532 iommu_iotlb_gather_init(iotlb_gather); 533 } 534 535 static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain, 536 struct iommu_iotlb_gather *gather, 537 unsigned long iova, size_t size) 538 { 539 unsigned long start = iova, end = start + size; 540 541 /* 542 * If the new page is disjoint from the current range or is mapped at 543 * a different granularity, then sync the TLB so that the gather 544 * structure can be rewritten. 545 */ 546 if (gather->pgsize != size || 547 end < gather->start || start > gather->end) { 548 if (gather->pgsize) 549 iommu_iotlb_sync(domain, gather); 550 gather->pgsize = size; 551 } 552 553 if (gather->end < end) 554 gather->end = end; 555 556 if (gather->start > start) 557 gather->start = start; 558 } 559 560 /* PCI device grouping function */ 561 extern struct iommu_group *pci_device_group(struct device *dev); 562 /* Generic device grouping function */ 563 extern struct iommu_group *generic_device_group(struct device *dev); 564 /* FSL-MC device grouping function */ 565 struct iommu_group *fsl_mc_device_group(struct device *dev); 566 567 /** 568 * struct iommu_fwspec - per-device IOMMU instance data 569 * @ops: ops for this device's IOMMU 570 * @iommu_fwnode: firmware handle for this device's IOMMU 571 * @iommu_priv: IOMMU driver private data for this device 572 * @num_pasid_bits: number of PASID bits supported by this device 573 * @num_ids: number of associated device IDs 574 * @ids: IDs which this device may present to the IOMMU 575 */ 576 struct iommu_fwspec { 577 const struct iommu_ops *ops; 578 struct fwnode_handle *iommu_fwnode; 579 u32 flags; 580 u32 num_pasid_bits; 581 unsigned int num_ids; 582 u32 ids[]; 583 }; 584 585 /* ATS is supported */ 586 #define IOMMU_FWSPEC_PCI_RC_ATS (1 << 0) 587 588 /** 589 * struct iommu_sva - handle to a device-mm bond 590 */ 591 struct iommu_sva { 592 struct device *dev; 593 }; 594 595 int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode, 596 const struct iommu_ops *ops); 597 void iommu_fwspec_free(struct device *dev); 598 int iommu_fwspec_add_ids(struct device *dev, u32 *ids, int num_ids); 599 const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode); 600 601 static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev) 602 { 603 if (dev->iommu) 604 return dev->iommu->fwspec; 605 else 606 return NULL; 607 } 608 609 static inline void dev_iommu_fwspec_set(struct device *dev, 610 struct iommu_fwspec *fwspec) 611 { 612 dev->iommu->fwspec = fwspec; 613 } 614 615 static inline void *dev_iommu_priv_get(struct device *dev) 616 { 617 return dev->iommu->priv; 618 } 619 620 static inline void dev_iommu_priv_set(struct device *dev, void *priv) 621 { 622 dev->iommu->priv = priv; 623 } 624 625 int iommu_probe_device(struct device *dev); 626 void iommu_release_device(struct device *dev); 627 628 bool iommu_dev_has_feature(struct device *dev, enum iommu_dev_features f); 629 int iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features f); 630 int iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features f); 631 bool iommu_dev_feature_enabled(struct device *dev, enum iommu_dev_features f); 632 int iommu_aux_attach_device(struct iommu_domain *domain, struct device *dev); 633 void iommu_aux_detach_device(struct iommu_domain *domain, struct device *dev); 634 int iommu_aux_get_pasid(struct iommu_domain *domain, struct device *dev); 635 636 struct iommu_sva *iommu_sva_bind_device(struct device *dev, 637 struct mm_struct *mm, 638 void *drvdata); 639 void iommu_sva_unbind_device(struct iommu_sva *handle); 640 u32 iommu_sva_get_pasid(struct iommu_sva *handle); 641 642 #else /* CONFIG_IOMMU_API */ 643 644 struct iommu_ops {}; 645 struct iommu_group {}; 646 struct iommu_fwspec {}; 647 struct iommu_device {}; 648 struct iommu_fault_param {}; 649 struct iommu_iotlb_gather {}; 650 651 static inline bool iommu_present(struct bus_type *bus) 652 { 653 return false; 654 } 655 656 static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap) 657 { 658 return false; 659 } 660 661 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus) 662 { 663 return NULL; 664 } 665 666 static inline struct iommu_group *iommu_group_get_by_id(int id) 667 { 668 return NULL; 669 } 670 671 static inline void iommu_domain_free(struct iommu_domain *domain) 672 { 673 } 674 675 static inline int iommu_attach_device(struct iommu_domain *domain, 676 struct device *dev) 677 { 678 return -ENODEV; 679 } 680 681 static inline void iommu_detach_device(struct iommu_domain *domain, 682 struct device *dev) 683 { 684 } 685 686 static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev) 687 { 688 return NULL; 689 } 690 691 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova, 692 phys_addr_t paddr, size_t size, int prot) 693 { 694 return -ENODEV; 695 } 696 697 static inline int iommu_map_atomic(struct iommu_domain *domain, 698 unsigned long iova, phys_addr_t paddr, 699 size_t size, int prot) 700 { 701 return -ENODEV; 702 } 703 704 static inline size_t iommu_unmap(struct iommu_domain *domain, 705 unsigned long iova, size_t size) 706 { 707 return 0; 708 } 709 710 static inline size_t iommu_unmap_fast(struct iommu_domain *domain, 711 unsigned long iova, int gfp_order, 712 struct iommu_iotlb_gather *iotlb_gather) 713 { 714 return 0; 715 } 716 717 static inline size_t iommu_map_sg(struct iommu_domain *domain, 718 unsigned long iova, struct scatterlist *sg, 719 unsigned int nents, int prot) 720 { 721 return 0; 722 } 723 724 static inline size_t iommu_map_sg_atomic(struct iommu_domain *domain, 725 unsigned long iova, struct scatterlist *sg, 726 unsigned int nents, int prot) 727 { 728 return 0; 729 } 730 731 static inline void iommu_flush_iotlb_all(struct iommu_domain *domain) 732 { 733 } 734 735 static inline void iommu_iotlb_sync(struct iommu_domain *domain, 736 struct iommu_iotlb_gather *iotlb_gather) 737 { 738 } 739 740 static inline int iommu_domain_window_enable(struct iommu_domain *domain, 741 u32 wnd_nr, phys_addr_t paddr, 742 u64 size, int prot) 743 { 744 return -ENODEV; 745 } 746 747 static inline void iommu_domain_window_disable(struct iommu_domain *domain, 748 u32 wnd_nr) 749 { 750 } 751 752 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova) 753 { 754 return 0; 755 } 756 757 static inline void iommu_set_fault_handler(struct iommu_domain *domain, 758 iommu_fault_handler_t handler, void *token) 759 { 760 } 761 762 static inline void iommu_get_resv_regions(struct device *dev, 763 struct list_head *list) 764 { 765 } 766 767 static inline void iommu_put_resv_regions(struct device *dev, 768 struct list_head *list) 769 { 770 } 771 772 static inline int iommu_get_group_resv_regions(struct iommu_group *group, 773 struct list_head *head) 774 { 775 return -ENODEV; 776 } 777 778 static inline void iommu_set_default_passthrough(bool cmd_line) 779 { 780 } 781 782 static inline void iommu_set_default_translated(bool cmd_line) 783 { 784 } 785 786 static inline bool iommu_default_passthrough(void) 787 { 788 return true; 789 } 790 791 static inline int iommu_attach_group(struct iommu_domain *domain, 792 struct iommu_group *group) 793 { 794 return -ENODEV; 795 } 796 797 static inline void iommu_detach_group(struct iommu_domain *domain, 798 struct iommu_group *group) 799 { 800 } 801 802 static inline struct iommu_group *iommu_group_alloc(void) 803 { 804 return ERR_PTR(-ENODEV); 805 } 806 807 static inline void *iommu_group_get_iommudata(struct iommu_group *group) 808 { 809 return NULL; 810 } 811 812 static inline void iommu_group_set_iommudata(struct iommu_group *group, 813 void *iommu_data, 814 void (*release)(void *iommu_data)) 815 { 816 } 817 818 static inline int iommu_group_set_name(struct iommu_group *group, 819 const char *name) 820 { 821 return -ENODEV; 822 } 823 824 static inline int iommu_group_add_device(struct iommu_group *group, 825 struct device *dev) 826 { 827 return -ENODEV; 828 } 829 830 static inline void iommu_group_remove_device(struct device *dev) 831 { 832 } 833 834 static inline int iommu_group_for_each_dev(struct iommu_group *group, 835 void *data, 836 int (*fn)(struct device *, void *)) 837 { 838 return -ENODEV; 839 } 840 841 static inline struct iommu_group *iommu_group_get(struct device *dev) 842 { 843 return NULL; 844 } 845 846 static inline void iommu_group_put(struct iommu_group *group) 847 { 848 } 849 850 static inline int iommu_group_register_notifier(struct iommu_group *group, 851 struct notifier_block *nb) 852 { 853 return -ENODEV; 854 } 855 856 static inline int iommu_group_unregister_notifier(struct iommu_group *group, 857 struct notifier_block *nb) 858 { 859 return 0; 860 } 861 862 static inline 863 int iommu_register_device_fault_handler(struct device *dev, 864 iommu_dev_fault_handler_t handler, 865 void *data) 866 { 867 return -ENODEV; 868 } 869 870 static inline int iommu_unregister_device_fault_handler(struct device *dev) 871 { 872 return 0; 873 } 874 875 static inline 876 int iommu_report_device_fault(struct device *dev, struct iommu_fault_event *evt) 877 { 878 return -ENODEV; 879 } 880 881 static inline int iommu_page_response(struct device *dev, 882 struct iommu_page_response *msg) 883 { 884 return -ENODEV; 885 } 886 887 static inline int iommu_group_id(struct iommu_group *group) 888 { 889 return -ENODEV; 890 } 891 892 static inline int iommu_domain_get_attr(struct iommu_domain *domain, 893 enum iommu_attr attr, void *data) 894 { 895 return -EINVAL; 896 } 897 898 static inline int iommu_domain_set_attr(struct iommu_domain *domain, 899 enum iommu_attr attr, void *data) 900 { 901 return -EINVAL; 902 } 903 904 static inline int iommu_device_register(struct iommu_device *iommu) 905 { 906 return -ENODEV; 907 } 908 909 static inline void iommu_device_set_ops(struct iommu_device *iommu, 910 const struct iommu_ops *ops) 911 { 912 } 913 914 static inline void iommu_device_set_fwnode(struct iommu_device *iommu, 915 struct fwnode_handle *fwnode) 916 { 917 } 918 919 static inline struct iommu_device *dev_to_iommu_device(struct device *dev) 920 { 921 return NULL; 922 } 923 924 static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather) 925 { 926 } 927 928 static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain, 929 struct iommu_iotlb_gather *gather, 930 unsigned long iova, size_t size) 931 { 932 } 933 934 static inline void iommu_device_unregister(struct iommu_device *iommu) 935 { 936 } 937 938 static inline int iommu_device_sysfs_add(struct iommu_device *iommu, 939 struct device *parent, 940 const struct attribute_group **groups, 941 const char *fmt, ...) 942 { 943 return -ENODEV; 944 } 945 946 static inline void iommu_device_sysfs_remove(struct iommu_device *iommu) 947 { 948 } 949 950 static inline int iommu_device_link(struct device *dev, struct device *link) 951 { 952 return -EINVAL; 953 } 954 955 static inline void iommu_device_unlink(struct device *dev, struct device *link) 956 { 957 } 958 959 static inline int iommu_fwspec_init(struct device *dev, 960 struct fwnode_handle *iommu_fwnode, 961 const struct iommu_ops *ops) 962 { 963 return -ENODEV; 964 } 965 966 static inline void iommu_fwspec_free(struct device *dev) 967 { 968 } 969 970 static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids, 971 int num_ids) 972 { 973 return -ENODEV; 974 } 975 976 static inline 977 const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode) 978 { 979 return NULL; 980 } 981 982 static inline bool 983 iommu_dev_has_feature(struct device *dev, enum iommu_dev_features feat) 984 { 985 return false; 986 } 987 988 static inline bool 989 iommu_dev_feature_enabled(struct device *dev, enum iommu_dev_features feat) 990 { 991 return false; 992 } 993 994 static inline int 995 iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features feat) 996 { 997 return -ENODEV; 998 } 999 1000 static inline int 1001 iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features feat) 1002 { 1003 return -ENODEV; 1004 } 1005 1006 static inline int 1007 iommu_aux_attach_device(struct iommu_domain *domain, struct device *dev) 1008 { 1009 return -ENODEV; 1010 } 1011 1012 static inline void 1013 iommu_aux_detach_device(struct iommu_domain *domain, struct device *dev) 1014 { 1015 } 1016 1017 static inline int 1018 iommu_aux_get_pasid(struct iommu_domain *domain, struct device *dev) 1019 { 1020 return -ENODEV; 1021 } 1022 1023 static inline struct iommu_sva * 1024 iommu_sva_bind_device(struct device *dev, struct mm_struct *mm, void *drvdata) 1025 { 1026 return NULL; 1027 } 1028 1029 static inline void iommu_sva_unbind_device(struct iommu_sva *handle) 1030 { 1031 } 1032 1033 static inline u32 iommu_sva_get_pasid(struct iommu_sva *handle) 1034 { 1035 return IOMMU_PASID_INVALID; 1036 } 1037 1038 static inline int 1039 iommu_uapi_cache_invalidate(struct iommu_domain *domain, 1040 struct device *dev, 1041 struct iommu_cache_invalidate_info *inv_info) 1042 { 1043 return -ENODEV; 1044 } 1045 1046 static inline int iommu_uapi_sva_bind_gpasid(struct iommu_domain *domain, 1047 struct device *dev, void __user *udata) 1048 { 1049 return -ENODEV; 1050 } 1051 1052 static inline int iommu_uapi_sva_unbind_gpasid(struct iommu_domain *domain, 1053 struct device *dev, void __user *udata) 1054 { 1055 return -ENODEV; 1056 } 1057 1058 static inline int iommu_sva_unbind_gpasid(struct iommu_domain *domain, 1059 struct device *dev, 1060 ioasid_t pasid) 1061 { 1062 return -ENODEV; 1063 } 1064 1065 static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev) 1066 { 1067 return NULL; 1068 } 1069 #endif /* CONFIG_IOMMU_API */ 1070 1071 /** 1072 * iommu_map_sgtable - Map the given buffer to the IOMMU domain 1073 * @domain: The IOMMU domain to perform the mapping 1074 * @iova: The start address to map the buffer 1075 * @sgt: The sg_table object describing the buffer 1076 * @prot: IOMMU protection bits 1077 * 1078 * Creates a mapping at @iova for the buffer described by a scatterlist 1079 * stored in the given sg_table object in the provided IOMMU domain. 1080 */ 1081 static inline size_t iommu_map_sgtable(struct iommu_domain *domain, 1082 unsigned long iova, struct sg_table *sgt, int prot) 1083 { 1084 return iommu_map_sg(domain, iova, sgt->sgl, sgt->orig_nents, prot); 1085 } 1086 1087 #ifdef CONFIG_IOMMU_DEBUGFS 1088 extern struct dentry *iommu_debugfs_dir; 1089 void iommu_debugfs_setup(void); 1090 #else 1091 static inline void iommu_debugfs_setup(void) {} 1092 #endif 1093 1094 #endif /* __LINUX_IOMMU_H */ 1095