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