2012-07-31 14:16:22 +00:00
|
|
|
/*
|
|
|
|
* VFIO API definition
|
|
|
|
*
|
|
|
|
* Copyright (C) 2012 Red Hat, Inc. All rights reserved.
|
|
|
|
* Author: Alex Williamson <alex.williamson@redhat.com>
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License version 2 as
|
|
|
|
* published by the Free Software Foundation.
|
|
|
|
*/
|
|
|
|
#ifndef VFIO_H
|
|
|
|
#define VFIO_H
|
|
|
|
|
|
|
|
|
|
|
|
#include <linux/iommu.h>
|
|
|
|
#include <linux/mm.h>
|
2015-03-16 20:08:54 +00:00
|
|
|
#include <linux/workqueue.h>
|
|
|
|
#include <linux/poll.h>
|
2012-10-13 09:46:48 +00:00
|
|
|
#include <uapi/linux/vfio.h>
|
2012-07-31 14:16:22 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* struct vfio_device_ops - VFIO bus driver device callbacks
|
|
|
|
*
|
|
|
|
* @open: Called when userspace creates new file descriptor for device
|
|
|
|
* @release: Called when userspace releases file descriptor for 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
|
2015-02-06 22:05:07 +00:00
|
|
|
* @request: Request for the bus driver to release the device
|
2012-07-31 14:16:22 +00:00
|
|
|
*/
|
|
|
|
struct vfio_device_ops {
|
|
|
|
char *name;
|
|
|
|
int (*open)(void *device_data);
|
|
|
|
void (*release)(void *device_data);
|
|
|
|
ssize_t (*read)(void *device_data, char __user *buf,
|
|
|
|
size_t count, loff_t *ppos);
|
|
|
|
ssize_t (*write)(void *device_data, const char __user *buf,
|
|
|
|
size_t count, loff_t *size);
|
|
|
|
long (*ioctl)(void *device_data, unsigned int cmd,
|
|
|
|
unsigned long arg);
|
|
|
|
int (*mmap)(void *device_data, struct vm_area_struct *vma);
|
2015-02-06 22:05:07 +00:00
|
|
|
void (*request)(void *device_data, unsigned int count);
|
2012-07-31 14:16:22 +00:00
|
|
|
};
|
|
|
|
|
2015-12-21 22:13:33 +00:00
|
|
|
extern struct iommu_group *vfio_iommu_group_get(struct device *dev);
|
|
|
|
extern void vfio_iommu_group_put(struct iommu_group *group, struct device *dev);
|
|
|
|
|
2012-07-31 14:16:22 +00:00
|
|
|
extern int vfio_add_group_dev(struct device *dev,
|
|
|
|
const struct vfio_device_ops *ops,
|
|
|
|
void *device_data);
|
|
|
|
|
|
|
|
extern void *vfio_del_group_dev(struct device *dev);
|
2013-03-11 15:28:44 +00:00
|
|
|
extern struct vfio_device *vfio_device_get_from_dev(struct device *dev);
|
|
|
|
extern void vfio_device_put(struct vfio_device *device);
|
|
|
|
extern void *vfio_device_data(struct vfio_device *device);
|
2012-07-31 14:16:22 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* struct vfio_iommu_driver_ops - VFIO IOMMU driver callbacks
|
|
|
|
*/
|
|
|
|
struct vfio_iommu_driver_ops {
|
|
|
|
char *name;
|
|
|
|
struct module *owner;
|
|
|
|
void *(*open)(unsigned long arg);
|
|
|
|
void (*release)(void *iommu_data);
|
|
|
|
ssize_t (*read)(void *iommu_data, char __user *buf,
|
|
|
|
size_t count, loff_t *ppos);
|
|
|
|
ssize_t (*write)(void *iommu_data, const char __user *buf,
|
|
|
|
size_t count, loff_t *size);
|
|
|
|
long (*ioctl)(void *iommu_data, unsigned int cmd,
|
|
|
|
unsigned long arg);
|
|
|
|
int (*mmap)(void *iommu_data, struct vm_area_struct *vma);
|
|
|
|
int (*attach_group)(void *iommu_data,
|
|
|
|
struct iommu_group *group);
|
|
|
|
void (*detach_group)(void *iommu_data,
|
|
|
|
struct iommu_group *group);
|
2016-11-16 20:46:17 +00:00
|
|
|
int (*pin_pages)(void *iommu_data, unsigned long *user_pfn,
|
|
|
|
int npage, int prot,
|
|
|
|
unsigned long *phys_pfn);
|
|
|
|
int (*unpin_pages)(void *iommu_data,
|
|
|
|
unsigned long *user_pfn, int npage);
|
2016-11-17 04:58:26 +00:00
|
|
|
int (*register_notifier)(void *iommu_data,
|
2016-12-01 05:20:05 +00:00
|
|
|
unsigned long *events,
|
2016-11-17 04:58:26 +00:00
|
|
|
struct notifier_block *nb);
|
|
|
|
int (*unregister_notifier)(void *iommu_data,
|
|
|
|
struct notifier_block *nb);
|
2012-07-31 14:16:22 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
extern int vfio_register_iommu_driver(const struct vfio_iommu_driver_ops *ops);
|
|
|
|
|
|
|
|
extern void vfio_unregister_iommu_driver(
|
|
|
|
const struct vfio_iommu_driver_ops *ops);
|
|
|
|
|
2013-08-05 16:52:36 +00:00
|
|
|
/*
|
|
|
|
* 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 int vfio_external_user_iommu_id(struct vfio_group *group);
|
2014-02-26 18:38:39 +00:00
|
|
|
extern long vfio_external_check_extension(struct vfio_group *group,
|
|
|
|
unsigned long arg);
|
2013-08-05 16:52:36 +00:00
|
|
|
|
2016-11-16 20:46:17 +00:00
|
|
|
#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);
|
|
|
|
|
2016-12-01 05:20:05 +00:00
|
|
|
/* each type has independent events */
|
|
|
|
enum vfio_notify_type {
|
|
|
|
VFIO_IOMMU_NOTIFY = 0,
|
2016-12-01 05:20:06 +00:00
|
|
|
VFIO_GROUP_NOTIFY = 1,
|
2016-12-01 05:20:05 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/* events for VFIO_IOMMU_NOTIFY */
|
|
|
|
#define VFIO_IOMMU_NOTIFY_DMA_UNMAP BIT(0)
|
2016-11-17 04:58:26 +00:00
|
|
|
|
2016-12-01 05:20:06 +00:00
|
|
|
/* events for VFIO_GROUP_NOTIFY */
|
|
|
|
#define VFIO_GROUP_NOTIFY_SET_KVM BIT(0)
|
|
|
|
|
2016-11-17 04:58:26 +00:00
|
|
|
extern int vfio_register_notifier(struct device *dev,
|
2016-12-01 05:20:05 +00:00
|
|
|
enum vfio_notify_type type,
|
|
|
|
unsigned long *required_events,
|
2016-11-17 04:58:26 +00:00
|
|
|
struct notifier_block *nb);
|
|
|
|
extern int vfio_unregister_notifier(struct device *dev,
|
2016-12-01 05:20:05 +00:00
|
|
|
enum vfio_notify_type type,
|
2016-11-17 04:58:26 +00:00
|
|
|
struct notifier_block *nb);
|
|
|
|
|
2016-12-01 05:20:06 +00:00
|
|
|
struct kvm;
|
|
|
|
extern void vfio_group_set_kvm(struct vfio_group *group, struct kvm *kvm);
|
|
|
|
|
2016-02-22 23:02:33 +00:00
|
|
|
/*
|
|
|
|
* 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);
|
|
|
|
|
2016-11-16 20:46:25 +00:00
|
|
|
extern int vfio_info_add_capability(struct vfio_info_cap *caps,
|
|
|
|
int cap_type_id, void *cap_type);
|
|
|
|
|
2016-11-16 20:46:27 +00:00
|
|
|
extern int vfio_set_irqs_validate_and_prepare(struct vfio_irq_set *hdr,
|
|
|
|
int num_irqs, int max_irq_type,
|
|
|
|
size_t *data_size);
|
|
|
|
|
2014-08-08 16:36:20 +00:00
|
|
|
struct pci_dev;
|
2014-06-10 01:41:57 +00:00
|
|
|
#ifdef CONFIG_EEH
|
2014-08-08 16:39:16 +00:00
|
|
|
extern void vfio_spapr_pci_eeh_open(struct pci_dev *pdev);
|
2014-06-10 01:41:57 +00:00
|
|
|
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
|
2014-08-08 16:39:16 +00:00
|
|
|
static inline void vfio_spapr_pci_eeh_open(struct pci_dev *pdev)
|
2014-06-10 01:41:57 +00:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
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_EEH */
|
2015-03-16 20:08:54 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* 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_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);
|
|
|
|
|
2012-07-31 14:16:22 +00:00
|
|
|
#endif /* VFIO_H */
|