xref: /freebsd/sys/amd64/vmm/io/iommu.h (revision f7c32ed617858bcd22f8d1b03199099d50125721)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2011 NetApp, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _IO_IOMMU_H_
32 #define	_IO_IOMMU_H_
33 
34 typedef int (*iommu_init_func_t)(void);
35 typedef void (*iommu_cleanup_func_t)(void);
36 typedef void (*iommu_enable_func_t)(void);
37 typedef void (*iommu_disable_func_t)(void);
38 typedef void *(*iommu_create_domain_t)(vm_paddr_t maxaddr);
39 typedef void (*iommu_destroy_domain_t)(void *domain);
40 typedef uint64_t (*iommu_create_mapping_t)(void *domain, vm_paddr_t gpa,
41 					   vm_paddr_t hpa, uint64_t len);
42 typedef uint64_t (*iommu_remove_mapping_t)(void *domain, vm_paddr_t gpa,
43 					   uint64_t len);
44 typedef void (*iommu_add_device_t)(void *domain, uint16_t rid);
45 typedef void (*iommu_remove_device_t)(void *dom, uint16_t rid);
46 typedef void (*iommu_invalidate_tlb_t)(void *dom);
47 
48 struct iommu_ops {
49 	iommu_init_func_t	init;		/* module wide */
50 	iommu_cleanup_func_t	cleanup;
51 	iommu_enable_func_t	enable;
52 	iommu_disable_func_t	disable;
53 
54 	iommu_create_domain_t	create_domain;	/* domain-specific */
55 	iommu_destroy_domain_t	destroy_domain;
56 	iommu_create_mapping_t	create_mapping;
57 	iommu_remove_mapping_t	remove_mapping;
58 	iommu_add_device_t	add_device;
59 	iommu_remove_device_t	remove_device;
60 	iommu_invalidate_tlb_t	invalidate_tlb;
61 };
62 
63 extern const struct iommu_ops iommu_ops_intel;
64 extern const struct iommu_ops iommu_ops_amd;
65 
66 void	iommu_cleanup(void);
67 void	*iommu_host_domain(void);
68 void	*iommu_create_domain(vm_paddr_t maxaddr);
69 void	iommu_destroy_domain(void *dom);
70 void	iommu_create_mapping(void *dom, vm_paddr_t gpa, vm_paddr_t hpa,
71 			     size_t len);
72 void	iommu_remove_mapping(void *dom, vm_paddr_t gpa, size_t len);
73 void	iommu_add_device(void *dom, uint16_t rid);
74 void	iommu_remove_device(void *dom, uint16_t rid);
75 void	iommu_invalidate_tlb(void *domain);
76 #endif
77