1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 6WIND S.A.
10 * RTE VFIO. This library provides various VFIO related utility functions.
14 * determine if VFIO is present on the system
16 #if !defined(VFIO_PRESENT) && defined(RTE_EAL_VFIO)
17 #include <linux/version.h>
18 #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 6, 0)
20 #endif /* kernel version >= 3.6.0 */
21 #endif /* RTE_EAL_VFIO */
25 #include <linux/vfio.h>
27 #define VFIO_DIR "/dev/vfio"
28 #define VFIO_CONTAINER_PATH "/dev/vfio/vfio"
29 #define VFIO_GROUP_FMT "/dev/vfio/%u"
30 #define VFIO_NOIOMMU_GROUP_FMT "/dev/vfio/noiommu-%u"
31 #define VFIO_GET_REGION_ADDR(x) ((uint64_t) x << 40ULL)
32 #define VFIO_GET_REGION_IDX(x) (x >> 40)
33 #define VFIO_NOIOMMU_MODE \
34 "/sys/module/vfio/parameters/enable_unsafe_noiommu_mode"
41 * Setup vfio_cfg for the device identified by its address.
42 * It discovers the configured I/O MMU groups or sets a new one for the device.
43 * If a new groups is assigned, the DMA mapping is performed.
45 * This function is only relevant to linux and will return
63 * >1 if the device cannot be managed this way.
65 int rte_vfio_setup_device(const char *sysfs_base, const char *dev_addr,
66 int *vfio_dev_fd, struct vfio_device_info *device_info);
69 * Release a device mapped to a VFIO-managed I/O MMU group.
71 * This function is only relevant to linux and will return
87 int rte_vfio_release_device(const char *sysfs_base, const char *dev_addr, int fd);
90 * Enable a VFIO-related kmod.
92 * This function is only relevant to linux and will return
102 int rte_vfio_enable(const char *modname);
105 * Check whether a VFIO-related kmod is enabled.
107 * This function is only relevant to linux and will return
111 * kernel module name.
117 int rte_vfio_is_enabled(const char *modname);
120 * Whether VFIO NOIOMMU mode is enabled.
122 * This function is only relevant to linux and will return
129 int rte_vfio_noiommu_is_enabled(void);
131 /* remove group fd from internal VFIO group fd array */
133 rte_vfio_clear_group(int vfio_group_fd);
136 * Map memory region for use with VFIO.
138 * @note requires at least one device to be attached at the time of mapping.
141 * Starting virtual address of memory to be mapped.
144 * Starting IOVA address of memory to be mapped.
147 * Length of memory segment being mapped.
153 int __rte_experimental
154 rte_vfio_dma_map(uint64_t vaddr, uint64_t iova, uint64_t len);
158 * Unmap memory region from VFIO.
161 * Starting virtual address of memory to be unmapped.
164 * Starting IOVA address of memory to be unmapped.
167 * Length of memory segment being unmapped.
173 int __rte_experimental
174 rte_vfio_dma_unmap(uint64_t vaddr, uint64_t iova, uint64_t len);
180 #endif /* VFIO_PRESENT */
182 #endif /* _RTE_VFIO_H_ */