xref: /freebsd/sys/amd64/vmm/io/iommu.h (revision 2eeb95ccf39ac5d79326c4482112b6b7dd5fc8b2)
1366f6083SPeter Grehan /*-
24d846d26SWarner Losh  * SPDX-License-Identifier: BSD-2-Clause
3c49761ddSPedro F. Giffuni  *
4366f6083SPeter Grehan  * Copyright (c) 2011 NetApp, Inc.
5366f6083SPeter Grehan  * All rights reserved.
6366f6083SPeter Grehan  *
7366f6083SPeter Grehan  * Redistribution and use in source and binary forms, with or without
8366f6083SPeter Grehan  * modification, are permitted provided that the following conditions
9366f6083SPeter Grehan  * are met:
10366f6083SPeter Grehan  * 1. Redistributions of source code must retain the above copyright
11366f6083SPeter Grehan  *    notice, this list of conditions and the following disclaimer.
12366f6083SPeter Grehan  * 2. Redistributions in binary form must reproduce the above copyright
13366f6083SPeter Grehan  *    notice, this list of conditions and the following disclaimer in the
14366f6083SPeter Grehan  *    documentation and/or other materials provided with the distribution.
15366f6083SPeter Grehan  *
16366f6083SPeter Grehan  * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
17366f6083SPeter Grehan  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18366f6083SPeter Grehan  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19366f6083SPeter Grehan  * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
20366f6083SPeter Grehan  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21366f6083SPeter Grehan  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22366f6083SPeter Grehan  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23366f6083SPeter Grehan  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24366f6083SPeter Grehan  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25366f6083SPeter Grehan  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26366f6083SPeter Grehan  * SUCH DAMAGE.
27366f6083SPeter Grehan  */
28366f6083SPeter Grehan 
29366f6083SPeter Grehan #ifndef _IO_IOMMU_H_
30366f6083SPeter Grehan #define	_IO_IOMMU_H_
31366f6083SPeter Grehan 
32366f6083SPeter Grehan typedef int (*iommu_init_func_t)(void);
33366f6083SPeter Grehan typedef void (*iommu_cleanup_func_t)(void);
34366f6083SPeter Grehan typedef void (*iommu_enable_func_t)(void);
35366f6083SPeter Grehan typedef void (*iommu_disable_func_t)(void);
36366f6083SPeter Grehan typedef void *(*iommu_create_domain_t)(vm_paddr_t maxaddr);
37366f6083SPeter Grehan typedef void (*iommu_destroy_domain_t)(void *domain);
38*2eeb95ccSKonstantin Belousov typedef int (*iommu_create_mapping_t)(void *domain, vm_paddr_t gpa,
39*2eeb95ccSKonstantin Belousov     vm_paddr_t hpa, uint64_t len, uint64_t *res_len);
40*2eeb95ccSKonstantin Belousov typedef int (*iommu_remove_mapping_t)(void *domain, vm_paddr_t gpa,
41*2eeb95ccSKonstantin Belousov     uint64_t len, uint64_t *res_len);
42*2eeb95ccSKonstantin Belousov typedef int (*iommu_add_device_t)(void *domain, device_t dev, uint16_t rid);
43*2eeb95ccSKonstantin Belousov typedef int (*iommu_remove_device_t)(void *dom, device_t dev, uint16_t rid);
44*2eeb95ccSKonstantin Belousov typedef int (*iommu_invalidate_tlb_t)(void *dom);
45366f6083SPeter Grehan 
46366f6083SPeter Grehan struct iommu_ops {
47366f6083SPeter Grehan 	iommu_init_func_t	init;		/* module wide */
48366f6083SPeter Grehan 	iommu_cleanup_func_t	cleanup;
49366f6083SPeter Grehan 	iommu_enable_func_t	enable;
50366f6083SPeter Grehan 	iommu_disable_func_t	disable;
51366f6083SPeter Grehan 
52366f6083SPeter Grehan 	iommu_create_domain_t	create_domain;	/* domain-specific */
53366f6083SPeter Grehan 	iommu_destroy_domain_t	destroy_domain;
54366f6083SPeter Grehan 	iommu_create_mapping_t	create_mapping;
557ce04d0aSNeel Natu 	iommu_remove_mapping_t	remove_mapping;
56366f6083SPeter Grehan 	iommu_add_device_t	add_device;
57366f6083SPeter Grehan 	iommu_remove_device_t	remove_device;
587ce04d0aSNeel Natu 	iommu_invalidate_tlb_t	invalidate_tlb;
59366f6083SPeter Grehan };
60366f6083SPeter Grehan 
6141335c6bSMark Johnston extern const struct iommu_ops iommu_ops_intel;
6241335c6bSMark Johnston extern const struct iommu_ops iommu_ops_amd;
63366f6083SPeter Grehan 
64366f6083SPeter Grehan void	iommu_cleanup(void);
657ce04d0aSNeel Natu void	*iommu_host_domain(void);
66366f6083SPeter Grehan void	*iommu_create_domain(vm_paddr_t maxaddr);
67366f6083SPeter Grehan void	iommu_destroy_domain(void *dom);
68*2eeb95ccSKonstantin Belousov int	iommu_create_mapping(void *dom, vm_paddr_t gpa, vm_paddr_t hpa,
69366f6083SPeter Grehan 	    size_t len);
70*2eeb95ccSKonstantin Belousov int	iommu_remove_mapping(void *dom, vm_paddr_t gpa, size_t len);
71*2eeb95ccSKonstantin Belousov int	iommu_add_device(void *dom, device_t dev, uint16_t rid);
72*2eeb95ccSKonstantin Belousov int	iommu_remove_device(void *dom, device_t dev, uint16_t rid);
73*2eeb95ccSKonstantin Belousov int	iommu_invalidate_tlb(void *domain);
74366f6083SPeter Grehan #endif
75