[linux-block.git] / drivers / vfio / pci / vfio_pci_private.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (C) 2012 Red Hat, Inc.  All rights reserved.
 *     Author: Alex Williamson <alex.williamson@redhat.com>
 *
 * Derived from original vfio:
 * Copyright 2010 Cisco Systems, Inc.  All rights reserved.
 * Author: Tom Lyon, pugs@cisco.com
 */

#include <linux/mutex.h>
#include <linux/pci.h>
#include <linux/irqbypass.h>
#include <linux/types.h>
#include <linux/uuid.h>
#include <linux/notifier.h>

#ifndef VFIO_PCI_PRIVATE_H
#define VFIO_PCI_PRIVATE_H

#define VFIO_PCI_OFFSET_SHIFT   40

#define VFIO_PCI_OFFSET_TO_INDEX(off)	(off >> VFIO_PCI_OFFSET_SHIFT)
#define VFIO_PCI_INDEX_TO_OFFSET(index)	((u64)(index) << VFIO_PCI_OFFSET_SHIFT)
#define VFIO_PCI_OFFSET_MASK	(((u64)(1) << VFIO_PCI_OFFSET_SHIFT) - 1)

/* Special capability IDs predefined access */
#define PCI_CAP_ID_INVALID		0xFF	/* default raw access */
#define PCI_CAP_ID_INVALID_VIRT		0xFE	/* default virt access */

/* Cap maximum number of ioeventfds per device (arbitrary) */
#define VFIO_PCI_IOEVENTFD_MAX		1000

struct vfio_pci_ioeventfd {
	struct list_head	next;
	struct virqfd		*virqfd;
	void __iomem		*addr;
	uint64_t		data;
	loff_t			pos;
	int			bar;
	int			count;
};

struct vfio_pci_irq_ctx {
	struct eventfd_ctx	*trigger;
	struct virqfd		*unmask;
	struct virqfd		*mask;
	char			*name;
	bool			masked;
	struct irq_bypass_producer	producer;
};

struct vfio_pci_device;
struct vfio_pci_region;

struct vfio_pci_regops {
	size_t	(*rw)(struct vfio_pci_device *vdev, char __user *buf,
		      size_t count, loff_t *ppos, bool iswrite);
	void	(*release)(struct vfio_pci_device *vdev,
			   struct vfio_pci_region *region);
	int	(*mmap)(struct vfio_pci_device *vdev,
			struct vfio_pci_region *region,
			struct vm_area_struct *vma);
	int	(*add_capability)(struct vfio_pci_device *vdev,
				  struct vfio_pci_region *region,
				  struct vfio_info_cap *caps);
};

struct vfio_pci_region {
	u32				type;
	u32				subtype;
	const struct vfio_pci_regops	*ops;
	void				*data;
	size_t				size;
	u32				flags;
};

struct vfio_pci_dummy_resource {
	struct resource		resource;
	int			index;
	struct list_head	res_next;
};

struct vfio_pci_reflck {
	struct kref		kref;
	struct mutex		lock;
};

struct vfio_pci_vf_token {
	struct mutex		lock;
	uuid_t			uuid;
	int			users;
};

struct vfio_pci_mmap_vma {
	struct vm_area_struct	*vma;
	struct list_head	vma_next;
};

struct vfio_pci_device {
	struct pci_dev		*pdev;
	void __iomem		*barmap[PCI_STD_NUM_BARS];
	bool			bar_mmap_supported[PCI_STD_NUM_BARS];
	u8			*pci_config_map;
	u8			*vconfig;
	struct perm_bits	*msi_perm;
	spinlock_t		irqlock;
	struct mutex		igate;
	struct vfio_pci_irq_ctx	*ctx;
	int			num_ctx;
	int			irq_type;
	int			num_regions;
	struct vfio_pci_region	*region;
	u8			msi_qmax;
	u8			msix_bar;
	u16			msix_size;
	u32			msix_offset;
	u32			rbar[7];
	bool			pci_2_3;
	bool			virq_disabled;
	bool			reset_works;
	bool			extended_caps;
	bool			bardirty;
	bool			has_vga;
	bool			needs_reset;
	bool			nointx;
	bool			needs_pm_restore;
	struct pci_saved_state	*pci_saved_state;
	struct pci_saved_state	*pm_save;
	struct vfio_pci_reflck	*reflck;
	int			refcnt;
	int			ioeventfds_nr;
	struct eventfd_ctx	*err_trigger;
	struct eventfd_ctx	*req_trigger;
	struct list_head	dummy_resources_list;
	struct mutex		ioeventfds_lock;
	struct list_head	ioeventfds_list;
	struct vfio_pci_vf_token	*vf_token;
	struct notifier_block	nb;
	struct mutex		vma_lock;
	struct list_head	vma_list;
};

#define is_intx(vdev) (vdev->irq_type == VFIO_PCI_INTX_IRQ_INDEX)
#define is_msi(vdev) (vdev->irq_type == VFIO_PCI_MSI_IRQ_INDEX)
#define is_msix(vdev) (vdev->irq_type == VFIO_PCI_MSIX_IRQ_INDEX)
#define is_irq_none(vdev) (!(is_intx(vdev) || is_msi(vdev) || is_msix(vdev)))
#define irq_is(vdev, type) (vdev->irq_type == type)

extern void vfio_pci_intx_mask(struct vfio_pci_device *vdev);
extern void vfio_pci_intx_unmask(struct vfio_pci_device *vdev);

extern int vfio_pci_set_irqs_ioctl(struct vfio_pci_device *vdev,
				   uint32_t flags, unsigned index,
				   unsigned start, unsigned count, void *data);

extern ssize_t vfio_pci_config_rw(struct vfio_pci_device *vdev,
				  char __user *buf, size_t count,
				  loff_t *ppos, bool iswrite);

extern ssize_t vfio_pci_bar_rw(struct vfio_pci_device *vdev, char __user *buf,
			       size_t count, loff_t *ppos, bool iswrite);

extern ssize_t vfio_pci_vga_rw(struct vfio_pci_device *vdev, char __user *buf,
			       size_t count, loff_t *ppos, bool iswrite);

extern long vfio_pci_ioeventfd(struct vfio_pci_device *vdev, loff_t offset,
			       uint64_t data, int count, int fd);

extern int vfio_pci_init_perm_bits(void);
extern void vfio_pci_uninit_perm_bits(void);

extern int vfio_config_init(struct vfio_pci_device *vdev);
extern void vfio_config_free(struct vfio_pci_device *vdev);

extern int vfio_pci_register_dev_region(struct vfio_pci_device *vdev,
					unsigned int type, unsigned int subtype,
					const struct vfio_pci_regops *ops,
					size_t size, u32 flags, void *data);

extern int vfio_pci_set_power_state(struct vfio_pci_device *vdev,
				    pci_power_t state);

#ifdef CONFIG_VFIO_PCI_IGD
extern int vfio_pci_igd_init(struct vfio_pci_device *vdev);
#else
static inline int vfio_pci_igd_init(struct vfio_pci_device *vdev)
{
	return -ENODEV;
}
#endif
#ifdef CONFIG_VFIO_PCI_NVLINK2
extern int vfio_pci_nvdia_v100_nvlink2_init(struct vfio_pci_device *vdev);
extern int vfio_pci_ibm_npu2_init(struct vfio_pci_device *vdev);
#else
static inline int vfio_pci_nvdia_v100_nvlink2_init(struct vfio_pci_device *vdev)
{
	return -ENODEV;
}

static inline int vfio_pci_ibm_npu2_init(struct vfio_pci_device *vdev)
{
	return -ENODEV;
}
#endif
#endif /* VFIO_PCI_PRIVATE_H */
Commit	Line	Data
d2912cb1	1	/* SPDX-License-Identifier: GPL-2.0-only */
89e1f7d4 AW	2	/*
	3	* Copyright (C) 2012 Red Hat, Inc. All rights reserved.
	4	* Author: Alex Williamson <alex.williamson@redhat.com>
	5	*
89e1f7d4 AW	6	* Derived from original vfio:
	7	* Copyright 2010 Cisco Systems, Inc. All rights reserved.
	8	* Author: Tom Lyon, pugs@cisco.com
	9	*/
	10
	11	#include <linux/mutex.h>
	12	#include <linux/pci.h>
6d7425f1	13	#include <linux/irqbypass.h>
28541d41	14	#include <linux/types.h>
cc20d799	15	#include <linux/uuid.h>
137e5531	16	#include <linux/notifier.h>
89e1f7d4 AW	17
	18	#ifndef VFIO_PCI_PRIVATE_H
	19	#define VFIO_PCI_PRIVATE_H
	20
	21	#define VFIO_PCI_OFFSET_SHIFT 40
	22
	23	#define VFIO_PCI_OFFSET_TO_INDEX(off) (off >> VFIO_PCI_OFFSET_SHIFT)
	24	#define VFIO_PCI_INDEX_TO_OFFSET(index) ((u64)(index) << VFIO_PCI_OFFSET_SHIFT)
	25	#define VFIO_PCI_OFFSET_MASK (((u64)(1) << VFIO_PCI_OFFSET_SHIFT) - 1)
	26
345d7104 AW	27	/* Special capability IDs predefined access */
	28	#define PCI_CAP_ID_INVALID 0xFF /* default raw access */
	29	#define PCI_CAP_ID_INVALID_VIRT 0xFE /* default virt access */
	30
30656177 AW	31	/* Cap maximum number of ioeventfds per device (arbitrary) */
	32	#define VFIO_PCI_IOEVENTFD_MAX 1000
	33
	34	struct vfio_pci_ioeventfd {
	35	struct list_head next;
	36	struct virqfd *virqfd;
	37	void __iomem *addr;
	38	uint64_t data;
	39	loff_t pos;
	40	int bar;
	41	int count;
	42	};
	43
89e1f7d4 AW	44	struct vfio_pci_irq_ctx {
	45	struct eventfd_ctx *trigger;
	46	struct virqfd *unmask;
	47	struct virqfd *mask;
	48	char *name;
	49	bool masked;
6d7425f1	50	struct irq_bypass_producer producer;
89e1f7d4 AW	51	};
89e1f7d4 AW	52
28541d41 AW	53	struct vfio_pci_device;
	54	struct vfio_pci_region;
	55
	56	struct vfio_pci_regops {
	57	size_t (rw)(struct vfio_pci_device vdev, char __user *buf,
	58	size_t count, loff_t *ppos, bool iswrite);
	59	void (release)(struct vfio_pci_device vdev,
	60	struct vfio_pci_region *region);
a15b1883 AK	61	int (mmap)(struct vfio_pci_device vdev,
	62	struct vfio_pci_region *region,
	63	struct vm_area_struct *vma);
c2c0f1cd AK	64	int (add_capability)(struct vfio_pci_device vdev,
	65	struct vfio_pci_region *region,
	66	struct vfio_info_cap *caps);
28541d41 AW	67	};
	68
	69	struct vfio_pci_region {
	70	u32 type;
	71	u32 subtype;
	72	const struct vfio_pci_regops *ops;
	73	void *data;
	74	size_t size;
	75	u32 flags;
	76	};
	77
05f0c03f YX	78	struct vfio_pci_dummy_resource {
	79	struct resource resource;
	80	int index;
	81	struct list_head res_next;
	82	};
	83
e309df5b AW	84	struct vfio_pci_reflck {
	85	struct kref kref;
	86	struct mutex lock;
	87	};
	88
cc20d799 AW	89	struct vfio_pci_vf_token {
	90	struct mutex lock;
	91	uuid_t uuid;
	92	int users;
	93	};
	94
11c4cd07 AW	95	struct vfio_pci_mmap_vma {
	96	struct vm_area_struct *vma;
	97	struct list_head vma_next;
	98	};
	99
89e1f7d4 AW	100	struct vfio_pci_device {
89e1f7d4 AW	101	struct pci_dev *pdev;
c9c13ba4 DE	102	void __iomem *barmap[PCI_STD_NUM_BARS];
c9c13ba4 DE	103	bool bar_mmap_supported[PCI_STD_NUM_BARS];
89e1f7d4 AW	104	u8 *pci_config_map;
	105	u8 *vconfig;
	106	struct perm_bits *msi_perm;
	107	spinlock_t irqlock;
	108	struct mutex igate;
89e1f7d4 AW	109	struct vfio_pci_irq_ctx *ctx;
	110	int num_ctx;
	111	int irq_type;
28541d41 AW	112	int num_regions;
28541d41 AW	113	struct vfio_pci_region *region;
89e1f7d4 AW	114	u8 msi_qmax;
	115	u8 msix_bar;
	116	u16 msix_size;
	117	u32 msix_offset;
	118	u32 rbar[7];
	119	bool pci_2_3;
	120	bool virq_disabled;
	121	bool reset_works;
	122	bool extended_caps;
	123	bool bardirty;
84237a82	124	bool has_vga;
bc4fba77	125	bool needs_reset;
45074405	126	bool nointx;
51ef3a00	127	bool needs_pm_restore;
89e1f7d4	128	struct pci_saved_state *pci_saved_state;
51ef3a00	129	struct pci_saved_state *pm_save;
e309df5b	130	struct vfio_pci_reflck *reflck;
61d79256	131	int refcnt;
30656177	132	int ioeventfds_nr;
dad9f897	133	struct eventfd_ctx *err_trigger;
6140a8f5	134	struct eventfd_ctx *req_trigger;
05f0c03f	135	struct list_head dummy_resources_list;
30656177 AW	136	struct mutex ioeventfds_lock;
30656177 AW	137	struct list_head ioeventfds_list;
cc20d799	138	struct vfio_pci_vf_token *vf_token;
137e5531	139	struct notifier_block nb;
11c4cd07 AW	140	struct mutex vma_lock;
11c4cd07 AW	141	struct list_head vma_list;
89e1f7d4 AW	142	};
	143
	144	#define is_intx(vdev) (vdev->irq_type == VFIO_PCI_INTX_IRQ_INDEX)
	145	#define is_msi(vdev) (vdev->irq_type == VFIO_PCI_MSI_IRQ_INDEX)
	146	#define is_msix(vdev) (vdev->irq_type == VFIO_PCI_MSIX_IRQ_INDEX)
	147	#define is_irq_none(vdev) (!(is_intx(vdev) \|\| is_msi(vdev) \|\| is_msix(vdev)))
	148	#define irq_is(vdev, type) (vdev->irq_type == type)
	149
	150	extern void vfio_pci_intx_mask(struct vfio_pci_device *vdev);
	151	extern void vfio_pci_intx_unmask(struct vfio_pci_device *vdev);
	152
	153	extern int vfio_pci_set_irqs_ioctl(struct vfio_pci_device *vdev,
	154	uint32_t flags, unsigned index,
	155	unsigned start, unsigned count, void *data);
	156
906ee99d AW	157	extern ssize_t vfio_pci_config_rw(struct vfio_pci_device *vdev,
	158	char __user *buf, size_t count,
	159	loff_t *ppos, bool iswrite);
	160
	161	extern ssize_t vfio_pci_bar_rw(struct vfio_pci_device vdev, char __user buf,
	162	size_t count, loff_t *ppos, bool iswrite);
89e1f7d4	163
84237a82 AW	164	extern ssize_t vfio_pci_vga_rw(struct vfio_pci_device vdev, char __user buf,
	165	size_t count, loff_t *ppos, bool iswrite);
	166
30656177 AW	167	extern long vfio_pci_ioeventfd(struct vfio_pci_device *vdev, loff_t offset,
	168	uint64_t data, int count, int fd);
	169
89e1f7d4 AW	170	extern int vfio_pci_init_perm_bits(void);
	171	extern void vfio_pci_uninit_perm_bits(void);
	172
89e1f7d4 AW	173	extern int vfio_config_init(struct vfio_pci_device *vdev);
89e1f7d4 AW	174	extern void vfio_config_free(struct vfio_pci_device *vdev);
28541d41 AW	175
	176	extern int vfio_pci_register_dev_region(struct vfio_pci_device *vdev,
	177	unsigned int type, unsigned int subtype,
	178	const struct vfio_pci_regops *ops,
	179	size_t size, u32 flags, void *data);
51ef3a00 AW	180
	181	extern int vfio_pci_set_power_state(struct vfio_pci_device *vdev,
	182	pci_power_t state);
	183
5846ff54	184	#ifdef CONFIG_VFIO_PCI_IGD
f572a960	185	extern int vfio_pci_igd_init(struct vfio_pci_device *vdev);
5846ff54	186	#else
f572a960	187	static inline int vfio_pci_igd_init(struct vfio_pci_device *vdev)
5846ff54 AW	188	{
	189	return -ENODEV;
	190	}
	191	#endif
7f928917 AK	192	#ifdef CONFIG_VFIO_PCI_NVLINK2
	193	extern int vfio_pci_nvdia_v100_nvlink2_init(struct vfio_pci_device *vdev);
	194	extern int vfio_pci_ibm_npu2_init(struct vfio_pci_device *vdev);
	195	#else
	196	static inline int vfio_pci_nvdia_v100_nvlink2_init(struct vfio_pci_device *vdev)
	197	{
	198	return -ENODEV;
	199	}
	200
	201	static inline int vfio_pci_ibm_npu2_init(struct vfio_pci_device *vdev)
	202	{
	203	return -ENODEV;
	204	}
	205	#endif
89e1f7d4	206	#endif /* VFIO_PCI_PRIVATE_H */