258 lines
8.7 KiB
C
258 lines
8.7 KiB
C
/* SPDX-License-Identifier: GPL-2.0-only */
|
|
/*
|
|
* VFIO API definition
|
|
*
|
|
* Copyright (C) 2012 Red Hat, Inc. All rights reserved.
|
|
* Author: Alex Williamson <alex.williamson@redhat.com>
|
|
*/
|
|
#ifndef VFIO_H
|
|
#define VFIO_H
|
|
|
|
|
|
#include <linux/iommu.h>
|
|
#include <linux/mm.h>
|
|
#include <linux/workqueue.h>
|
|
#include <linux/poll.h>
|
|
#include <uapi/linux/vfio.h>
|
|
|
|
/*
|
|
* VFIO devices can be placed in a set, this allows all devices to share this
|
|
* structure and the VFIO core will provide a lock that is held around
|
|
* open_device()/close_device() for all devices in the set.
|
|
*/
|
|
struct vfio_device_set {
|
|
void *set_id;
|
|
struct mutex lock;
|
|
struct list_head device_list;
|
|
unsigned int device_count;
|
|
};
|
|
|
|
struct vfio_device {
|
|
struct device *dev;
|
|
const struct vfio_device_ops *ops;
|
|
struct vfio_group *group;
|
|
struct vfio_device_set *dev_set;
|
|
struct list_head dev_set_list;
|
|
unsigned int migration_flags;
|
|
|
|
/* Members below here are private, not for driver use */
|
|
refcount_t refcount;
|
|
unsigned int open_count;
|
|
struct completion comp;
|
|
struct list_head group_next;
|
|
};
|
|
|
|
/**
|
|
* struct vfio_device_ops - VFIO bus driver device callbacks
|
|
*
|
|
* @open_device: Called when the first file descriptor is opened for this device
|
|
* @close_device: Opposite of open_device
|
|
* @read: Perform read(2) on device file descriptor
|
|
* @write: Perform write(2) on device file descriptor
|
|
* @ioctl: Perform ioctl(2) on device file descriptor, supporting VFIO_DEVICE_*
|
|
* operations documented below
|
|
* @mmap: Perform mmap(2) on a region of the device file descriptor
|
|
* @request: Request for the bus driver to release the device
|
|
* @match: Optional device name match callback (return: 0 for no-match, >0 for
|
|
* match, -errno for abort (ex. match with insufficient or incorrect
|
|
* additional args)
|
|
* @device_feature: Optional, fill in the VFIO_DEVICE_FEATURE ioctl
|
|
* @migration_set_state: Optional callback to change the migration state for
|
|
* devices that support migration. It's mandatory for
|
|
* VFIO_DEVICE_FEATURE_MIGRATION migration support.
|
|
* The returned FD is used for data transfer according to the FSM
|
|
* definition. The driver is responsible to ensure that FD reaches end
|
|
* of stream or error whenever the migration FSM leaves a data transfer
|
|
* state or before close_device() returns.
|
|
* @migration_get_state: Optional callback to get the migration state for
|
|
* devices that support migration. It's mandatory for
|
|
* VFIO_DEVICE_FEATURE_MIGRATION migration support.
|
|
*/
|
|
struct vfio_device_ops {
|
|
char *name;
|
|
int (*open_device)(struct vfio_device *vdev);
|
|
void (*close_device)(struct vfio_device *vdev);
|
|
ssize_t (*read)(struct vfio_device *vdev, char __user *buf,
|
|
size_t count, loff_t *ppos);
|
|
ssize_t (*write)(struct vfio_device *vdev, const char __user *buf,
|
|
size_t count, loff_t *size);
|
|
long (*ioctl)(struct vfio_device *vdev, unsigned int cmd,
|
|
unsigned long arg);
|
|
int (*mmap)(struct vfio_device *vdev, struct vm_area_struct *vma);
|
|
void (*request)(struct vfio_device *vdev, unsigned int count);
|
|
int (*match)(struct vfio_device *vdev, char *buf);
|
|
int (*device_feature)(struct vfio_device *device, u32 flags,
|
|
void __user *arg, size_t argsz);
|
|
struct file *(*migration_set_state)(
|
|
struct vfio_device *device,
|
|
enum vfio_device_mig_state new_state);
|
|
int (*migration_get_state)(struct vfio_device *device,
|
|
enum vfio_device_mig_state *curr_state);
|
|
};
|
|
|
|
/**
|
|
* vfio_check_feature - Validate user input for the VFIO_DEVICE_FEATURE ioctl
|
|
* @flags: Arg from the device_feature op
|
|
* @argsz: Arg from the device_feature op
|
|
* @supported_ops: Combination of VFIO_DEVICE_FEATURE_GET and SET the driver
|
|
* supports
|
|
* @minsz: Minimum data size the driver accepts
|
|
*
|
|
* For use in a driver's device_feature op. Checks that the inputs to the
|
|
* VFIO_DEVICE_FEATURE ioctl are correct for the driver's feature. Returns 1 if
|
|
* the driver should execute the get or set, otherwise the relevant
|
|
* value should be returned.
|
|
*/
|
|
static inline int vfio_check_feature(u32 flags, size_t argsz, u32 supported_ops,
|
|
size_t minsz)
|
|
{
|
|
if ((flags & (VFIO_DEVICE_FEATURE_GET | VFIO_DEVICE_FEATURE_SET)) &
|
|
~supported_ops)
|
|
return -EINVAL;
|
|
if (flags & VFIO_DEVICE_FEATURE_PROBE)
|
|
return 0;
|
|
/* Without PROBE one of GET or SET must be requested */
|
|
if (!(flags & (VFIO_DEVICE_FEATURE_GET | VFIO_DEVICE_FEATURE_SET)))
|
|
return -EINVAL;
|
|
if (argsz < minsz)
|
|
return -EINVAL;
|
|
return 1;
|
|
}
|
|
|
|
void vfio_init_group_dev(struct vfio_device *device, struct device *dev,
|
|
const struct vfio_device_ops *ops);
|
|
void vfio_uninit_group_dev(struct vfio_device *device);
|
|
int vfio_register_group_dev(struct vfio_device *device);
|
|
int vfio_register_emulated_iommu_dev(struct vfio_device *device);
|
|
void vfio_unregister_group_dev(struct vfio_device *device);
|
|
extern struct vfio_device *vfio_device_get_from_dev(struct device *dev);
|
|
extern void vfio_device_put(struct vfio_device *device);
|
|
|
|
int vfio_assign_device_set(struct vfio_device *device, void *set_id);
|
|
|
|
int vfio_mig_get_next_state(struct vfio_device *device,
|
|
enum vfio_device_mig_state cur_fsm,
|
|
enum vfio_device_mig_state new_fsm,
|
|
enum vfio_device_mig_state *next_fsm);
|
|
|
|
/*
|
|
* External user API
|
|
*/
|
|
extern struct vfio_group *vfio_group_get_external_user(struct file *filep);
|
|
extern void vfio_group_put_external_user(struct vfio_group *group);
|
|
extern struct vfio_group *vfio_group_get_external_user_from_dev(struct device
|
|
*dev);
|
|
extern bool vfio_external_group_match_file(struct vfio_group *group,
|
|
struct file *filep);
|
|
extern int vfio_external_user_iommu_id(struct vfio_group *group);
|
|
extern long vfio_external_check_extension(struct vfio_group *group,
|
|
unsigned long arg);
|
|
|
|
#define VFIO_PIN_PAGES_MAX_ENTRIES (PAGE_SIZE/sizeof(unsigned long))
|
|
|
|
extern int vfio_pin_pages(struct device *dev, unsigned long *user_pfn,
|
|
int npage, int prot, unsigned long *phys_pfn);
|
|
extern int vfio_unpin_pages(struct device *dev, unsigned long *user_pfn,
|
|
int npage);
|
|
|
|
extern int vfio_group_pin_pages(struct vfio_group *group,
|
|
unsigned long *user_iova_pfn, int npage,
|
|
int prot, unsigned long *phys_pfn);
|
|
extern int vfio_group_unpin_pages(struct vfio_group *group,
|
|
unsigned long *user_iova_pfn, int npage);
|
|
|
|
extern int vfio_dma_rw(struct vfio_group *group, dma_addr_t user_iova,
|
|
void *data, size_t len, bool write);
|
|
|
|
extern struct iommu_domain *vfio_group_iommu_domain(struct vfio_group *group);
|
|
|
|
/* each type has independent events */
|
|
enum vfio_notify_type {
|
|
VFIO_IOMMU_NOTIFY = 0,
|
|
VFIO_GROUP_NOTIFY = 1,
|
|
};
|
|
|
|
/* events for VFIO_IOMMU_NOTIFY */
|
|
#define VFIO_IOMMU_NOTIFY_DMA_UNMAP BIT(0)
|
|
|
|
/* events for VFIO_GROUP_NOTIFY */
|
|
#define VFIO_GROUP_NOTIFY_SET_KVM BIT(0)
|
|
|
|
extern int vfio_register_notifier(struct device *dev,
|
|
enum vfio_notify_type type,
|
|
unsigned long *required_events,
|
|
struct notifier_block *nb);
|
|
extern int vfio_unregister_notifier(struct device *dev,
|
|
enum vfio_notify_type type,
|
|
struct notifier_block *nb);
|
|
|
|
struct kvm;
|
|
extern void vfio_group_set_kvm(struct vfio_group *group, struct kvm *kvm);
|
|
|
|
/*
|
|
* Sub-module helpers
|
|
*/
|
|
struct vfio_info_cap {
|
|
struct vfio_info_cap_header *buf;
|
|
size_t size;
|
|
};
|
|
extern struct vfio_info_cap_header *vfio_info_cap_add(
|
|
struct vfio_info_cap *caps, size_t size, u16 id, u16 version);
|
|
extern void vfio_info_cap_shift(struct vfio_info_cap *caps, size_t offset);
|
|
|
|
extern int vfio_info_add_capability(struct vfio_info_cap *caps,
|
|
struct vfio_info_cap_header *cap,
|
|
size_t size);
|
|
|
|
extern int vfio_set_irqs_validate_and_prepare(struct vfio_irq_set *hdr,
|
|
int num_irqs, int max_irq_type,
|
|
size_t *data_size);
|
|
|
|
struct pci_dev;
|
|
#if IS_ENABLED(CONFIG_VFIO_SPAPR_EEH)
|
|
extern void vfio_spapr_pci_eeh_open(struct pci_dev *pdev);
|
|
extern void vfio_spapr_pci_eeh_release(struct pci_dev *pdev);
|
|
extern long vfio_spapr_iommu_eeh_ioctl(struct iommu_group *group,
|
|
unsigned int cmd,
|
|
unsigned long arg);
|
|
#else
|
|
static inline void vfio_spapr_pci_eeh_open(struct pci_dev *pdev)
|
|
{
|
|
}
|
|
|
|
static inline void vfio_spapr_pci_eeh_release(struct pci_dev *pdev)
|
|
{
|
|
}
|
|
|
|
static inline long vfio_spapr_iommu_eeh_ioctl(struct iommu_group *group,
|
|
unsigned int cmd,
|
|
unsigned long arg)
|
|
{
|
|
return -ENOTTY;
|
|
}
|
|
#endif /* CONFIG_VFIO_SPAPR_EEH */
|
|
|
|
/*
|
|
* IRQfd - generic
|
|
*/
|
|
struct virqfd {
|
|
void *opaque;
|
|
struct eventfd_ctx *eventfd;
|
|
int (*handler)(void *, void *);
|
|
void (*thread)(void *, void *);
|
|
void *data;
|
|
struct work_struct inject;
|
|
wait_queue_entry_t wait;
|
|
poll_table pt;
|
|
struct work_struct shutdown;
|
|
struct virqfd **pvirqfd;
|
|
};
|
|
|
|
extern int vfio_virqfd_enable(void *opaque,
|
|
int (*handler)(void *, void *),
|
|
void (*thread)(void *, void *),
|
|
void *data, struct virqfd **pvirqfd, int fd);
|
|
extern void vfio_virqfd_disable(struct virqfd **pvirqfd);
|
|
|
|
#endif /* VFIO_H */
|