11238a28dSRuslan Bukin /*- 21238a28dSRuslan Bukin * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 31238a28dSRuslan Bukin * 41238a28dSRuslan Bukin * Copyright (c) 2013 The FreeBSD Foundation 51238a28dSRuslan Bukin * All rights reserved. 61238a28dSRuslan Bukin * 71238a28dSRuslan Bukin * This software was developed by Konstantin Belousov <kib@FreeBSD.org> 81238a28dSRuslan Bukin * under sponsorship from the FreeBSD Foundation. 91238a28dSRuslan Bukin * 101238a28dSRuslan Bukin * Redistribution and use in source and binary forms, with or without 111238a28dSRuslan Bukin * modification, are permitted provided that the following conditions 121238a28dSRuslan Bukin * are met: 131238a28dSRuslan Bukin * 1. Redistributions of source code must retain the above copyright 141238a28dSRuslan Bukin * notice, this list of conditions and the following disclaimer. 151238a28dSRuslan Bukin * 2. Redistributions in binary form must reproduce the above copyright 161238a28dSRuslan Bukin * notice, this list of conditions and the following disclaimer in the 171238a28dSRuslan Bukin * documentation and/or other materials provided with the distribution. 181238a28dSRuslan Bukin * 191238a28dSRuslan Bukin * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 201238a28dSRuslan Bukin * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 211238a28dSRuslan Bukin * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 221238a28dSRuslan Bukin * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 231238a28dSRuslan Bukin * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 241238a28dSRuslan Bukin * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 251238a28dSRuslan Bukin * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 261238a28dSRuslan Bukin * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 271238a28dSRuslan Bukin * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 281238a28dSRuslan Bukin * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 291238a28dSRuslan Bukin * SUCH DAMAGE. 301238a28dSRuslan Bukin * 311238a28dSRuslan Bukin * $FreeBSD$ 321238a28dSRuslan Bukin */ 331238a28dSRuslan Bukin 34066e1d1aSRuslan Bukin #ifndef _DEV_IOMMU_IOMMU_H_ 35066e1d1aSRuslan Bukin #define _DEV_IOMMU_IOMMU_H_ 361238a28dSRuslan Bukin 37e12686ecSRuslan Bukin #include <dev/iommu/iommu_types.h> 381238a28dSRuslan Bukin 391238a28dSRuslan Bukin struct bus_dma_tag_common; 401238a28dSRuslan Bukin struct iommu_map_entry; 411238a28dSRuslan Bukin TAILQ_HEAD(iommu_map_entries_tailq, iommu_map_entry); 421238a28dSRuslan Bukin 4362ad310cSRuslan Bukin RB_HEAD(iommu_gas_entries_tree, iommu_map_entry); 4462ad310cSRuslan Bukin RB_PROTOTYPE(iommu_gas_entries_tree, iommu_map_entry, rb_entry, 4562ad310cSRuslan Bukin iommu_gas_cmp_entries); 4662ad310cSRuslan Bukin 471238a28dSRuslan Bukin struct iommu_qi_genseq { 481238a28dSRuslan Bukin u_int gen; 491238a28dSRuslan Bukin uint32_t seq; 501238a28dSRuslan Bukin }; 511238a28dSRuslan Bukin 521238a28dSRuslan Bukin struct iommu_map_entry { 531238a28dSRuslan Bukin iommu_gaddr_t start; 541238a28dSRuslan Bukin iommu_gaddr_t end; 551238a28dSRuslan Bukin iommu_gaddr_t first; /* Least start in subtree */ 561238a28dSRuslan Bukin iommu_gaddr_t last; /* Greatest end in subtree */ 571238a28dSRuslan Bukin iommu_gaddr_t free_down; /* Max free space below the 581238a28dSRuslan Bukin current R/B tree node */ 591238a28dSRuslan Bukin u_int flags; 601238a28dSRuslan Bukin TAILQ_ENTRY(iommu_map_entry) dmamap_link; /* Link for dmamap entries */ 611238a28dSRuslan Bukin RB_ENTRY(iommu_map_entry) rb_entry; /* Links for domain entries */ 621238a28dSRuslan Bukin TAILQ_ENTRY(iommu_map_entry) unroll_link; /* Link for unroll after 631238a28dSRuslan Bukin dmamap_load failure */ 641238a28dSRuslan Bukin struct iommu_domain *domain; 651238a28dSRuslan Bukin struct iommu_qi_genseq gseq; 661238a28dSRuslan Bukin }; 671238a28dSRuslan Bukin 681238a28dSRuslan Bukin #define IOMMU_MAP_ENTRY_PLACE 0x0001 /* Fake entry */ 691238a28dSRuslan Bukin #define IOMMU_MAP_ENTRY_RMRR 0x0002 /* Permanent, not linked by 701238a28dSRuslan Bukin dmamap_link */ 711238a28dSRuslan Bukin #define IOMMU_MAP_ENTRY_MAP 0x0004 /* Busdma created, linked by 721238a28dSRuslan Bukin dmamap_link */ 731238a28dSRuslan Bukin #define IOMMU_MAP_ENTRY_UNMAPPED 0x0010 /* No backing pages */ 741238a28dSRuslan Bukin #define IOMMU_MAP_ENTRY_QI_NF 0x0020 /* qi task, do not free entry */ 751238a28dSRuslan Bukin #define IOMMU_MAP_ENTRY_READ 0x1000 /* Read permitted */ 761238a28dSRuslan Bukin #define IOMMU_MAP_ENTRY_WRITE 0x2000 /* Write permitted */ 771238a28dSRuslan Bukin #define IOMMU_MAP_ENTRY_SNOOP 0x4000 /* Snoop */ 781238a28dSRuslan Bukin #define IOMMU_MAP_ENTRY_TM 0x8000 /* Transient */ 791238a28dSRuslan Bukin 801238a28dSRuslan Bukin struct iommu_unit { 811238a28dSRuslan Bukin struct mtx lock; 821238a28dSRuslan Bukin int unit; 831238a28dSRuslan Bukin 841238a28dSRuslan Bukin int dma_enabled; 851238a28dSRuslan Bukin 861238a28dSRuslan Bukin /* Busdma delayed map load */ 871238a28dSRuslan Bukin struct task dmamap_load_task; 881238a28dSRuslan Bukin TAILQ_HEAD(, bus_dmamap_iommu) delayed_maps; 891238a28dSRuslan Bukin struct taskqueue *delayed_taskqueue; 90ea4c0115SRuslan Bukin 91ea4c0115SRuslan Bukin /* 92ea4c0115SRuslan Bukin * Bitmap of buses for which context must ignore slot:func, 93ea4c0115SRuslan Bukin * duplicating the page table pointer into all context table 94ea4c0115SRuslan Bukin * entries. This is a client-controlled quirk to support some 95ea4c0115SRuslan Bukin * NTBs. 96ea4c0115SRuslan Bukin */ 97ea4c0115SRuslan Bukin uint32_t buswide_ctxs[(PCI_BUSMAX + 1) / NBBY / sizeof(uint32_t)]; 981238a28dSRuslan Bukin }; 991238a28dSRuslan Bukin 1000eed04c8SRuslan Bukin struct iommu_domain_map_ops { 1010eed04c8SRuslan Bukin int (*map)(struct iommu_domain *domain, iommu_gaddr_t base, 1020eed04c8SRuslan Bukin iommu_gaddr_t size, vm_page_t *ma, uint64_t pflags, int flags); 1030eed04c8SRuslan Bukin int (*unmap)(struct iommu_domain *domain, iommu_gaddr_t base, 1040eed04c8SRuslan Bukin iommu_gaddr_t size, int flags); 1050eed04c8SRuslan Bukin }; 1060eed04c8SRuslan Bukin 1071238a28dSRuslan Bukin /* 1081238a28dSRuslan Bukin * Locking annotations: 1091238a28dSRuslan Bukin * (u) - Protected by iommu unit lock 1101238a28dSRuslan Bukin * (d) - Protected by domain lock 1111238a28dSRuslan Bukin * (c) - Immutable after initialization 1121238a28dSRuslan Bukin */ 1131238a28dSRuslan Bukin 1141238a28dSRuslan Bukin struct iommu_domain { 1151238a28dSRuslan Bukin struct iommu_unit *iommu; /* (c) */ 1160eed04c8SRuslan Bukin const struct iommu_domain_map_ops *ops; 1171238a28dSRuslan Bukin struct mtx lock; /* (c) */ 1181238a28dSRuslan Bukin struct task unload_task; /* (c) */ 1191238a28dSRuslan Bukin u_int entries_cnt; /* (d) */ 1201238a28dSRuslan Bukin struct iommu_map_entries_tailq unload_entries; /* (d) Entries to 1211238a28dSRuslan Bukin unload */ 12262ad310cSRuslan Bukin struct iommu_gas_entries_tree rb_root; /* (d) */ 12362ad310cSRuslan Bukin iommu_gaddr_t end; /* (c) Highest address + 1 in 12462ad310cSRuslan Bukin the guest AS */ 12562ad310cSRuslan Bukin struct iommu_map_entry *first_place, *last_place; /* (d) */ 12662ad310cSRuslan Bukin u_int flags; /* (u) */ 1271238a28dSRuslan Bukin }; 1281238a28dSRuslan Bukin 1291238a28dSRuslan Bukin struct iommu_ctx { 1301238a28dSRuslan Bukin struct iommu_domain *domain; /* (c) */ 1311238a28dSRuslan Bukin struct bus_dma_tag_iommu *tag; /* (c) Root tag */ 1321238a28dSRuslan Bukin u_long loads; /* atomic updates, for stat only */ 1331238a28dSRuslan Bukin u_long unloads; /* same */ 1341238a28dSRuslan Bukin u_int flags; /* (u) */ 135cb9050ddSRuslan Bukin uint16_t rid; /* (c) pci RID */ 1361238a28dSRuslan Bukin }; 1371238a28dSRuslan Bukin 1381238a28dSRuslan Bukin /* struct iommu_ctx flags */ 1391238a28dSRuslan Bukin #define IOMMU_CTX_FAULTED 0x0001 /* Fault was reported, 1401238a28dSRuslan Bukin last_fault_rec is valid */ 1411238a28dSRuslan Bukin #define IOMMU_CTX_DISABLED 0x0002 /* Device is disabled, the 1421238a28dSRuslan Bukin ephemeral reference is kept 1431238a28dSRuslan Bukin to prevent context destruction */ 1441238a28dSRuslan Bukin 14515f6baf4SRuslan Bukin #define IOMMU_DOMAIN_GAS_INITED 0x0001 14615f6baf4SRuslan Bukin #define IOMMU_DOMAIN_PGTBL_INITED 0x0002 14715f6baf4SRuslan Bukin #define IOMMU_DOMAIN_IDMAP 0x0010 /* Domain uses identity 1489c843a40SRuslan Bukin page table */ 14915f6baf4SRuslan Bukin #define IOMMU_DOMAIN_RMRR 0x0020 /* Domain contains RMRR entry, 1509c843a40SRuslan Bukin cannot be turned off */ 1519c843a40SRuslan Bukin 1529c843a40SRuslan Bukin /* Map flags */ 1539c843a40SRuslan Bukin #define IOMMU_MF_CANWAIT 0x0001 1549c843a40SRuslan Bukin #define IOMMU_MF_CANSPLIT 0x0002 1559c843a40SRuslan Bukin #define IOMMU_MF_RMRR 0x0004 1569c843a40SRuslan Bukin 15715f6baf4SRuslan Bukin #define IOMMU_PGF_WAITOK 0x0001 15815f6baf4SRuslan Bukin #define IOMMU_PGF_ZERO 0x0002 15915f6baf4SRuslan Bukin #define IOMMU_PGF_ALLOC 0x0004 16015f6baf4SRuslan Bukin #define IOMMU_PGF_NOALLOC 0x0008 16115f6baf4SRuslan Bukin #define IOMMU_PGF_OBJL 0x0010 1629c843a40SRuslan Bukin 1631238a28dSRuslan Bukin #define IOMMU_LOCK(unit) mtx_lock(&(unit)->lock) 1641238a28dSRuslan Bukin #define IOMMU_UNLOCK(unit) mtx_unlock(&(unit)->lock) 1651238a28dSRuslan Bukin #define IOMMU_ASSERT_LOCKED(unit) mtx_assert(&(unit)->lock, MA_OWNED) 1661238a28dSRuslan Bukin 1671238a28dSRuslan Bukin #define IOMMU_DOMAIN_LOCK(dom) mtx_lock(&(dom)->lock) 1681238a28dSRuslan Bukin #define IOMMU_DOMAIN_UNLOCK(dom) mtx_unlock(&(dom)->lock) 1691238a28dSRuslan Bukin #define IOMMU_DOMAIN_ASSERT_LOCKED(dom) mtx_assert(&(dom)->lock, MA_OWNED) 1701238a28dSRuslan Bukin 1711238a28dSRuslan Bukin static inline bool 1721238a28dSRuslan Bukin iommu_test_boundary(iommu_gaddr_t start, iommu_gaddr_t size, 1731238a28dSRuslan Bukin iommu_gaddr_t boundary) 1741238a28dSRuslan Bukin { 1751238a28dSRuslan Bukin 1761238a28dSRuslan Bukin if (boundary == 0) 1771238a28dSRuslan Bukin return (true); 1781238a28dSRuslan Bukin return (start + size <= ((start + boundary) & ~(boundary - 1))); 1791238a28dSRuslan Bukin } 1801238a28dSRuslan Bukin 1811238a28dSRuslan Bukin void iommu_free_ctx(struct iommu_ctx *ctx); 1821238a28dSRuslan Bukin void iommu_free_ctx_locked(struct iommu_unit *iommu, struct iommu_ctx *ctx); 1831238a28dSRuslan Bukin struct iommu_ctx *iommu_get_ctx(struct iommu_unit *, device_t dev, 1841238a28dSRuslan Bukin uint16_t rid, bool id_mapped, bool rmrr_init); 1851238a28dSRuslan Bukin struct iommu_unit *iommu_find(device_t dev, bool verbose); 1861238a28dSRuslan Bukin void iommu_domain_unload_entry(struct iommu_map_entry *entry, bool free); 1871238a28dSRuslan Bukin void iommu_domain_unload(struct iommu_domain *domain, 1881238a28dSRuslan Bukin struct iommu_map_entries_tailq *entries, bool cansleep); 1891238a28dSRuslan Bukin 1901238a28dSRuslan Bukin struct iommu_ctx *iommu_instantiate_ctx(struct iommu_unit *iommu, 1911238a28dSRuslan Bukin device_t dev, bool rmrr); 1921238a28dSRuslan Bukin device_t iommu_get_requester(device_t dev, uint16_t *rid); 1931238a28dSRuslan Bukin int iommu_init_busdma(struct iommu_unit *unit); 1941238a28dSRuslan Bukin void iommu_fini_busdma(struct iommu_unit *unit); 1951238a28dSRuslan Bukin struct iommu_map_entry *iommu_map_alloc_entry(struct iommu_domain *iodom, 1961238a28dSRuslan Bukin u_int flags); 1971238a28dSRuslan Bukin void iommu_map_free_entry(struct iommu_domain *, struct iommu_map_entry *); 1981238a28dSRuslan Bukin int iommu_map(struct iommu_domain *iodom, 1991238a28dSRuslan Bukin const struct bus_dma_tag_common *common, iommu_gaddr_t size, int offset, 2001238a28dSRuslan Bukin u_int eflags, u_int flags, vm_page_t *ma, struct iommu_map_entry **res); 2011238a28dSRuslan Bukin int iommu_map_region(struct iommu_domain *domain, 2021238a28dSRuslan Bukin struct iommu_map_entry *entry, u_int eflags, u_int flags, vm_page_t *ma); 2031238a28dSRuslan Bukin 2049c843a40SRuslan Bukin void iommu_gas_init_domain(struct iommu_domain *domain); 2059c843a40SRuslan Bukin void iommu_gas_fini_domain(struct iommu_domain *domain); 2069c843a40SRuslan Bukin struct iommu_map_entry *iommu_gas_alloc_entry(struct iommu_domain *domain, 2079c843a40SRuslan Bukin u_int flags); 2089c843a40SRuslan Bukin void iommu_gas_free_entry(struct iommu_domain *domain, 2099c843a40SRuslan Bukin struct iommu_map_entry *entry); 2109c843a40SRuslan Bukin void iommu_gas_free_space(struct iommu_domain *domain, 2119c843a40SRuslan Bukin struct iommu_map_entry *entry); 2129c843a40SRuslan Bukin int iommu_gas_map(struct iommu_domain *domain, 2139c843a40SRuslan Bukin const struct bus_dma_tag_common *common, iommu_gaddr_t size, int offset, 2149c843a40SRuslan Bukin u_int eflags, u_int flags, vm_page_t *ma, struct iommu_map_entry **res); 2159c843a40SRuslan Bukin void iommu_gas_free_region(struct iommu_domain *domain, 2169c843a40SRuslan Bukin struct iommu_map_entry *entry); 2179c843a40SRuslan Bukin int iommu_gas_map_region(struct iommu_domain *domain, 2189c843a40SRuslan Bukin struct iommu_map_entry *entry, u_int eflags, u_int flags, vm_page_t *ma); 2199c843a40SRuslan Bukin int iommu_gas_reserve_region(struct iommu_domain *domain, iommu_gaddr_t start, 2209c843a40SRuslan Bukin iommu_gaddr_t end); 2219c843a40SRuslan Bukin 2221b0c9c21SRuslan Bukin void iommu_set_buswide_ctx(struct iommu_unit *unit, u_int busno); 2231b0c9c21SRuslan Bukin bool iommu_is_buswide_ctx(struct iommu_unit *unit, u_int busno); 22416696f60SRuslan Bukin void iommu_domain_init(struct iommu_unit *unit, struct iommu_domain *domain, 22516696f60SRuslan Bukin const struct iommu_domain_map_ops *ops); 22616696f60SRuslan Bukin void iommu_domain_fini(struct iommu_domain *domain); 2271b0c9c21SRuslan Bukin 2281b0c9c21SRuslan Bukin bool bus_dma_iommu_set_buswide(device_t dev); 2291b0c9c21SRuslan Bukin int bus_dma_iommu_load_ident(bus_dma_tag_t dmat, bus_dmamap_t map, 2301b0c9c21SRuslan Bukin vm_paddr_t start, vm_size_t length, int flags); 2311b0c9c21SRuslan Bukin 232025730aaSRuslan Bukin bus_dma_tag_t iommu_get_dma_tag(device_t dev, device_t child); 23372479f6bSRuslan Bukin struct iommu_ctx *iommu_get_dev_ctx(device_t dev); 234f5cafae1SRuslan Bukin struct iommu_domain *iommu_get_ctx_domain(struct iommu_ctx *ctx); 235025730aaSRuslan Bukin 236357149f0SRuslan Bukin SYSCTL_DECL(_hw_iommu); 237357149f0SRuslan Bukin 238066e1d1aSRuslan Bukin #endif /* !_DEV_IOMMU_IOMMU_H_ */ 239