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