xref: /illumos-gate/usr/src/uts/intel/io/vmm/io/iommu.h (revision e760f150)
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  * This file and its contents are supplied under the terms of the
32  * Common Development and Distribution License ("CDDL"), version 1.0.
33  * You may only use this file in accordance with the terms of version
34  * 1.0 of the CDDL.
35  *
36  * A full copy of the text of the CDDL should have accompanied this
37  * source.  A copy of the CDDL is also available via the Internet at
38  * http://www.illumos.org/license/CDDL.
39  *
40  * Copyright 2022 Oxide Computer Company
41  */
42 
43 #ifndef _IO_IOMMU_H_
44 #define	_IO_IOMMU_H_
45 
46 typedef int (*iommu_init_func_t)(void);
47 typedef void (*iommu_cleanup_func_t)(void);
48 typedef void (*iommu_enable_func_t)(void);
49 typedef void (*iommu_disable_func_t)(void);
50 typedef void *(*iommu_create_domain_t)(vm_paddr_t maxaddr);
51 typedef void (*iommu_destroy_domain_t)(void *domain);
52 typedef uint64_t (*iommu_create_mapping_t)(void *domain, vm_paddr_t gpa,
53     vm_paddr_t hpa, uint64_t len);
54 typedef uint64_t (*iommu_remove_mapping_t)(void *domain, vm_paddr_t gpa,
55     uint64_t len);
56 typedef void (*iommu_add_device_t)(void *domain, uint16_t rid);
57 typedef void (*iommu_remove_device_t)(void *domain, uint16_t rid);
58 typedef void (*iommu_invalidate_tlb_t)(void *domain);
59 
60 struct iommu_ops {
61 	iommu_init_func_t	init;		/* module wide */
62 	iommu_cleanup_func_t	cleanup;
63 	iommu_enable_func_t	enable;
64 	iommu_disable_func_t	disable;
65 
66 	iommu_create_domain_t	create_domain;	/* domain-specific */
67 	iommu_destroy_domain_t	destroy_domain;
68 	iommu_create_mapping_t	create_mapping;
69 	iommu_remove_mapping_t	remove_mapping;
70 	iommu_add_device_t	add_device;
71 	iommu_remove_device_t	remove_device;
72 	iommu_invalidate_tlb_t	invalidate_tlb;
73 };
74 
75 #define	IOMMU_OPS_SYM_NAME	"vmm_iommu_ops"
76 
77 void *iommu_host_domain(void);
78 void *iommu_create_domain(vm_paddr_t maxaddr);
79 void iommu_destroy_domain(void *domain);
80 void iommu_create_mapping(void *domain, vm_paddr_t gpa, vm_paddr_t hpa,
81     size_t len);
82 void iommu_remove_mapping(void *domain, vm_paddr_t gpa, size_t len);
83 void iommu_add_device(void *domain, uint16_t rid);
84 void iommu_remove_device(void *domain, uint16_t rid);
85 void iommu_invalidate_tlb(void *domain);
86 
87 /* Glue functions used by iommu provider(s) */
88 void *vmm_ptp_alloc(void);
89 void vmm_ptp_free(void *);
90 
91 #endif
92