11238a28dSRuslan Bukin /*- 24d846d26SWarner Losh * SPDX-License-Identifier: BSD-2-Clause 31238a28dSRuslan Bukin * 41238a28dSRuslan Bukin * Copyright (c) 2013 The FreeBSD Foundation 51238a28dSRuslan Bukin * 61238a28dSRuslan Bukin * This software was developed by Konstantin Belousov <kib@FreeBSD.org> 71238a28dSRuslan Bukin * under sponsorship from the FreeBSD Foundation. 81238a28dSRuslan Bukin * 91238a28dSRuslan Bukin * Redistribution and use in source and binary forms, with or without 101238a28dSRuslan Bukin * modification, are permitted provided that the following conditions 111238a28dSRuslan Bukin * are met: 121238a28dSRuslan Bukin * 1. Redistributions of source code must retain the above copyright 131238a28dSRuslan Bukin * notice, this list of conditions and the following disclaimer. 141238a28dSRuslan Bukin * 2. Redistributions in binary form must reproduce the above copyright 151238a28dSRuslan Bukin * notice, this list of conditions and the following disclaimer in the 161238a28dSRuslan Bukin * documentation and/or other materials provided with the distribution. 171238a28dSRuslan Bukin * 181238a28dSRuslan Bukin * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 191238a28dSRuslan Bukin * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 201238a28dSRuslan Bukin * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 211238a28dSRuslan Bukin * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 221238a28dSRuslan Bukin * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 231238a28dSRuslan Bukin * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 241238a28dSRuslan Bukin * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 251238a28dSRuslan Bukin * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 261238a28dSRuslan Bukin * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 271238a28dSRuslan Bukin * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 281238a28dSRuslan Bukin * SUCH DAMAGE. 291238a28dSRuslan Bukin */ 301238a28dSRuslan Bukin 31066e1d1aSRuslan Bukin #ifndef _DEV_IOMMU_IOMMU_H_ 32066e1d1aSRuslan Bukin #define _DEV_IOMMU_IOMMU_H_ 331238a28dSRuslan Bukin 34e12686ecSRuslan Bukin #include <dev/iommu/iommu_types.h> 351238a28dSRuslan Bukin 361238a28dSRuslan Bukin struct bus_dma_tag_common; 371238a28dSRuslan Bukin struct iommu_map_entry; 381238a28dSRuslan Bukin TAILQ_HEAD(iommu_map_entries_tailq, iommu_map_entry); 391238a28dSRuslan Bukin 4062ad310cSRuslan Bukin RB_HEAD(iommu_gas_entries_tree, iommu_map_entry); 4162ad310cSRuslan Bukin RB_PROTOTYPE(iommu_gas_entries_tree, iommu_map_entry, rb_entry, 4262ad310cSRuslan Bukin iommu_gas_cmp_entries); 4362ad310cSRuslan Bukin 441238a28dSRuslan Bukin struct iommu_qi_genseq { 451238a28dSRuslan Bukin u_int gen; 461238a28dSRuslan Bukin uint32_t seq; 471238a28dSRuslan Bukin }; 481238a28dSRuslan Bukin 491238a28dSRuslan Bukin struct iommu_map_entry { 501238a28dSRuslan Bukin iommu_gaddr_t start; 511238a28dSRuslan Bukin iommu_gaddr_t end; 521238a28dSRuslan Bukin iommu_gaddr_t first; /* Least start in subtree */ 531238a28dSRuslan Bukin iommu_gaddr_t last; /* Greatest end in subtree */ 541238a28dSRuslan Bukin iommu_gaddr_t free_down; /* Max free space below the 551238a28dSRuslan Bukin current R/B tree node */ 561238a28dSRuslan Bukin u_int flags; 5742736dc4SAlan Cox union { 5842736dc4SAlan Cox TAILQ_ENTRY(iommu_map_entry) dmamap_link; /* DMA map entries */ 5942736dc4SAlan Cox struct iommu_map_entry *tlb_flush_next; 6042736dc4SAlan Cox }; 611238a28dSRuslan Bukin RB_ENTRY(iommu_map_entry) rb_entry; /* Links for domain entries */ 621238a28dSRuslan Bukin struct iommu_domain *domain; 631238a28dSRuslan Bukin struct iommu_qi_genseq gseq; 641238a28dSRuslan Bukin }; 651238a28dSRuslan Bukin 661238a28dSRuslan Bukin struct iommu_unit { 671238a28dSRuslan Bukin struct mtx lock; 68f5931169SRuslan Bukin device_t dev; 691238a28dSRuslan Bukin int unit; 701238a28dSRuslan Bukin 711238a28dSRuslan Bukin int dma_enabled; 721238a28dSRuslan Bukin 731238a28dSRuslan Bukin /* Busdma delayed map load */ 741238a28dSRuslan Bukin struct task dmamap_load_task; 751238a28dSRuslan Bukin TAILQ_HEAD(, bus_dmamap_iommu) delayed_maps; 761238a28dSRuslan Bukin struct taskqueue *delayed_taskqueue; 77ea4c0115SRuslan Bukin 78ea4c0115SRuslan Bukin /* 79ea4c0115SRuslan Bukin * Bitmap of buses for which context must ignore slot:func, 80ea4c0115SRuslan Bukin * duplicating the page table pointer into all context table 81ea4c0115SRuslan Bukin * entries. This is a client-controlled quirk to support some 82ea4c0115SRuslan Bukin * NTBs. 83ea4c0115SRuslan Bukin */ 84ea4c0115SRuslan Bukin uint32_t buswide_ctxs[(PCI_BUSMAX + 1) / NBBY / sizeof(uint32_t)]; 851238a28dSRuslan Bukin }; 861238a28dSRuslan Bukin 870eed04c8SRuslan Bukin struct iommu_domain_map_ops { 880eed04c8SRuslan Bukin int (*map)(struct iommu_domain *domain, iommu_gaddr_t base, 890eed04c8SRuslan Bukin iommu_gaddr_t size, vm_page_t *ma, uint64_t pflags, int flags); 900eed04c8SRuslan Bukin int (*unmap)(struct iommu_domain *domain, iommu_gaddr_t base, 910eed04c8SRuslan Bukin iommu_gaddr_t size, int flags); 920eed04c8SRuslan Bukin }; 930eed04c8SRuslan Bukin 941238a28dSRuslan Bukin /* 951238a28dSRuslan Bukin * Locking annotations: 961238a28dSRuslan Bukin * (u) - Protected by iommu unit lock 971238a28dSRuslan Bukin * (d) - Protected by domain lock 981238a28dSRuslan Bukin * (c) - Immutable after initialization 991238a28dSRuslan Bukin */ 1001238a28dSRuslan Bukin 1011238a28dSRuslan Bukin struct iommu_domain { 1021238a28dSRuslan Bukin struct iommu_unit *iommu; /* (c) */ 1030eed04c8SRuslan Bukin const struct iommu_domain_map_ops *ops; 1041238a28dSRuslan Bukin struct mtx lock; /* (c) */ 1051238a28dSRuslan Bukin struct task unload_task; /* (c) */ 1061238a28dSRuslan Bukin u_int entries_cnt; /* (d) */ 1071238a28dSRuslan Bukin struct iommu_map_entries_tailq unload_entries; /* (d) Entries to 1081238a28dSRuslan Bukin unload */ 10962ad310cSRuslan Bukin struct iommu_gas_entries_tree rb_root; /* (d) */ 1108b221ca6SDoug Moore struct iommu_map_entry *start_gap; /* (d) */ 11162ad310cSRuslan Bukin iommu_gaddr_t end; /* (c) Highest address + 1 in 11262ad310cSRuslan Bukin the guest AS */ 11362ad310cSRuslan Bukin struct iommu_map_entry *first_place, *last_place; /* (d) */ 114e707c8beSRuslan Bukin struct iommu_map_entry *msi_entry; /* (d) Arch-specific */ 115e707c8beSRuslan Bukin iommu_gaddr_t msi_base; /* (d) Arch-specific */ 116e707c8beSRuslan Bukin vm_paddr_t msi_phys; /* (d) Arch-specific */ 11762ad310cSRuslan Bukin u_int flags; /* (u) */ 1181238a28dSRuslan Bukin }; 1191238a28dSRuslan Bukin 1201238a28dSRuslan Bukin struct iommu_ctx { 1211238a28dSRuslan Bukin struct iommu_domain *domain; /* (c) */ 1221238a28dSRuslan Bukin struct bus_dma_tag_iommu *tag; /* (c) Root tag */ 1231238a28dSRuslan Bukin u_long loads; /* atomic updates, for stat only */ 1241238a28dSRuslan Bukin u_long unloads; /* same */ 1251238a28dSRuslan Bukin u_int flags; /* (u) */ 126cb9050ddSRuslan Bukin uint16_t rid; /* (c) pci RID */ 1271238a28dSRuslan Bukin }; 1281238a28dSRuslan Bukin 1291238a28dSRuslan Bukin /* struct iommu_ctx flags */ 1301238a28dSRuslan Bukin #define IOMMU_CTX_FAULTED 0x0001 /* Fault was reported, 1311238a28dSRuslan Bukin last_fault_rec is valid */ 1321238a28dSRuslan Bukin #define IOMMU_CTX_DISABLED 0x0002 /* Device is disabled, the 1331238a28dSRuslan Bukin ephemeral reference is kept 1341238a28dSRuslan Bukin to prevent context destruction */ 1351238a28dSRuslan Bukin 13615f6baf4SRuslan Bukin #define IOMMU_DOMAIN_GAS_INITED 0x0001 13715f6baf4SRuslan Bukin #define IOMMU_DOMAIN_PGTBL_INITED 0x0002 13815f6baf4SRuslan Bukin #define IOMMU_DOMAIN_IDMAP 0x0010 /* Domain uses identity 1399c843a40SRuslan Bukin page table */ 14015f6baf4SRuslan Bukin #define IOMMU_DOMAIN_RMRR 0x0020 /* Domain contains RMRR entry, 1419c843a40SRuslan Bukin cannot be turned off */ 1429c843a40SRuslan Bukin 1431238a28dSRuslan Bukin #define IOMMU_LOCK(unit) mtx_lock(&(unit)->lock) 1441238a28dSRuslan Bukin #define IOMMU_UNLOCK(unit) mtx_unlock(&(unit)->lock) 1451238a28dSRuslan Bukin #define IOMMU_ASSERT_LOCKED(unit) mtx_assert(&(unit)->lock, MA_OWNED) 1461238a28dSRuslan Bukin 1471238a28dSRuslan Bukin #define IOMMU_DOMAIN_LOCK(dom) mtx_lock(&(dom)->lock) 1481238a28dSRuslan Bukin #define IOMMU_DOMAIN_UNLOCK(dom) mtx_unlock(&(dom)->lock) 1491238a28dSRuslan Bukin #define IOMMU_DOMAIN_ASSERT_LOCKED(dom) mtx_assert(&(dom)->lock, MA_OWNED) 1501238a28dSRuslan Bukin 1511238a28dSRuslan Bukin void iommu_free_ctx(struct iommu_ctx *ctx); 1521238a28dSRuslan Bukin void iommu_free_ctx_locked(struct iommu_unit *iommu, struct iommu_ctx *ctx); 1531238a28dSRuslan Bukin struct iommu_ctx *iommu_get_ctx(struct iommu_unit *, device_t dev, 1541238a28dSRuslan Bukin uint16_t rid, bool id_mapped, bool rmrr_init); 1551238a28dSRuslan Bukin struct iommu_unit *iommu_find(device_t dev, bool verbose); 1568bc36738SAlan Cox void iommu_domain_unload_entry(struct iommu_map_entry *entry, bool free, 1578bc36738SAlan Cox bool cansleep); 1581238a28dSRuslan Bukin void iommu_domain_unload(struct iommu_domain *domain, 1591238a28dSRuslan Bukin struct iommu_map_entries_tailq *entries, bool cansleep); 1601238a28dSRuslan Bukin 1611238a28dSRuslan Bukin struct iommu_ctx *iommu_instantiate_ctx(struct iommu_unit *iommu, 1621238a28dSRuslan Bukin device_t dev, bool rmrr); 1631238a28dSRuslan Bukin device_t iommu_get_requester(device_t dev, uint16_t *rid); 1641238a28dSRuslan Bukin int iommu_init_busdma(struct iommu_unit *unit); 1651238a28dSRuslan Bukin void iommu_fini_busdma(struct iommu_unit *unit); 1661238a28dSRuslan Bukin 1679c843a40SRuslan Bukin void iommu_gas_init_domain(struct iommu_domain *domain); 1689c843a40SRuslan Bukin void iommu_gas_fini_domain(struct iommu_domain *domain); 1699c843a40SRuslan Bukin struct iommu_map_entry *iommu_gas_alloc_entry(struct iommu_domain *domain, 1709c843a40SRuslan Bukin u_int flags); 1714670f908SAlan Cox void iommu_gas_free_entry(struct iommu_map_entry *entry); 1724670f908SAlan Cox void iommu_gas_free_space(struct iommu_map_entry *entry); 173c9e4d250SKonstantin Belousov void iommu_gas_remove(struct iommu_domain *domain, iommu_gaddr_t start, 174c9e4d250SKonstantin Belousov iommu_gaddr_t size); 1759c843a40SRuslan Bukin int iommu_gas_map(struct iommu_domain *domain, 1769c843a40SRuslan Bukin const struct bus_dma_tag_common *common, iommu_gaddr_t size, int offset, 1779c843a40SRuslan Bukin u_int eflags, u_int flags, vm_page_t *ma, struct iommu_map_entry **res); 1784670f908SAlan Cox void iommu_gas_free_region(struct iommu_map_entry *entry); 1799c843a40SRuslan Bukin int iommu_gas_map_region(struct iommu_domain *domain, 1809c843a40SRuslan Bukin struct iommu_map_entry *entry, u_int eflags, u_int flags, vm_page_t *ma); 1819c843a40SRuslan Bukin int iommu_gas_reserve_region(struct iommu_domain *domain, iommu_gaddr_t start, 18294dfb28eSRuslan Bukin iommu_gaddr_t end, struct iommu_map_entry **entry0); 183ee47a12aSRyan Libby int iommu_gas_reserve_region_extend(struct iommu_domain *domain, 184ee47a12aSRyan Libby iommu_gaddr_t start, iommu_gaddr_t end); 1859c843a40SRuslan Bukin 1861b0c9c21SRuslan Bukin void iommu_set_buswide_ctx(struct iommu_unit *unit, u_int busno); 1871b0c9c21SRuslan Bukin bool iommu_is_buswide_ctx(struct iommu_unit *unit, u_int busno); 18816696f60SRuslan Bukin void iommu_domain_init(struct iommu_unit *unit, struct iommu_domain *domain, 18916696f60SRuslan Bukin const struct iommu_domain_map_ops *ops); 19016696f60SRuslan Bukin void iommu_domain_fini(struct iommu_domain *domain); 1911b0c9c21SRuslan Bukin 1921b0c9c21SRuslan Bukin bool bus_dma_iommu_set_buswide(device_t dev); 1931b0c9c21SRuslan Bukin int bus_dma_iommu_load_ident(bus_dma_tag_t dmat, bus_dmamap_t map, 1941b0c9c21SRuslan Bukin vm_paddr_t start, vm_size_t length, int flags); 1951b0c9c21SRuslan Bukin 196025730aaSRuslan Bukin bus_dma_tag_t iommu_get_dma_tag(device_t dev, device_t child); 19772479f6bSRuslan Bukin struct iommu_ctx *iommu_get_dev_ctx(device_t dev); 198f5cafae1SRuslan Bukin struct iommu_domain *iommu_get_ctx_domain(struct iommu_ctx *ctx); 199025730aaSRuslan Bukin 200357149f0SRuslan Bukin SYSCTL_DECL(_hw_iommu); 201357149f0SRuslan Bukin 202066e1d1aSRuslan Bukin #endif /* !_DEV_IOMMU_IOMMU_H_ */ 203