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 struct vfio_pci_irq_ctx {
33 struct eventfd_ctx *trigger;
34 struct virqfd *unmask;
35 struct virqfd *mask;
36 char *name;
37 bool masked;
38 struct irq_bypass_producer producer;
39 };
40
41 struct vfio_pci_device;
42 struct vfio_pci_region;
43
44 struct vfio_pci_regops {
45 size_t (*rw)(struct vfio_pci_device *vdev, char __user *buf,
46 size_t count, loff_t *ppos, bool iswrite);
47 void (*release)(struct vfio_pci_device *vdev,
48 struct vfio_pci_region *region);
49 };
50
51 struct vfio_pci_region {
52 u32 type;
53 u32 subtype;
54 const struct vfio_pci_regops *ops;
55 void *data;
56 size_t size;
57 u32 flags;
58 };
59
60 struct vfio_pci_dummy_resource {
61 struct resource resource;
62 int index;
63 struct list_head res_next;
64 };
65
66 struct vfio_pci_device {
67 struct pci_dev *pdev;
68 void __iomem *barmap[PCI_STD_RESOURCE_END + 1];
69 bool bar_mmap_supported[PCI_STD_RESOURCE_END + 1];
70 u8 *pci_config_map;
71 u8 *vconfig;
72 struct perm_bits *msi_perm;
73 spinlock_t irqlock;
74 struct mutex igate;
75 struct vfio_pci_irq_ctx *ctx;
76 int num_ctx;
77 int irq_type;
78 int num_regions;
79 struct vfio_pci_region *region;
80 u8 msi_qmax;
81 u8 msix_bar;
82 u16 msix_size;
83 u32 msix_offset;
84 u32 rbar[7];
85 bool pci_2_3;
86 bool virq_disabled;
87 bool reset_works;
88 bool extended_caps;
89 bool bardirty;
90 bool has_vga;
91 bool needs_reset;
92 bool nointx;
93 struct pci_saved_state *pci_saved_state;
94 int refcnt;
95 struct eventfd_ctx *err_trigger;
96 struct eventfd_ctx *req_trigger;
97 struct list_head dummy_resources_list;
98 };
99
100 #define is_intx(vdev) (vdev->irq_type == VFIO_PCI_INTX_IRQ_INDEX)
101 #define is_msi(vdev) (vdev->irq_type == VFIO_PCI_MSI_IRQ_INDEX)
102 #define is_msix(vdev) (vdev->irq_type == VFIO_PCI_MSIX_IRQ_INDEX)
103 #define is_irq_none(vdev) (!(is_intx(vdev) || is_msi(vdev) || is_msix(vdev)))
104 #define irq_is(vdev, type) (vdev->irq_type == type)
105
106 extern void vfio_pci_intx_mask(struct vfio_pci_device *vdev);
107 extern void vfio_pci_intx_unmask(struct vfio_pci_device *vdev);
108
109 extern int vfio_pci_set_irqs_ioctl(struct vfio_pci_device *vdev,
110 uint32_t flags, unsigned index,
111 unsigned start, unsigned count, void *data);
112
113 extern ssize_t vfio_pci_config_rw(struct vfio_pci_device *vdev,
114 char __user *buf, size_t count,
115 loff_t *ppos, bool iswrite);
116
117 extern ssize_t vfio_pci_bar_rw(struct vfio_pci_device *vdev, char __user *buf,
118 size_t count, loff_t *ppos, bool iswrite);
119
120 extern ssize_t vfio_pci_vga_rw(struct vfio_pci_device *vdev, char __user *buf,
121 size_t count, loff_t *ppos, bool iswrite);
122
123 extern int vfio_pci_init_perm_bits(void);
124 extern void vfio_pci_uninit_perm_bits(void);
125
126 extern int vfio_config_init(struct vfio_pci_device *vdev);
127 extern void vfio_config_free(struct vfio_pci_device *vdev);
128
129 extern int vfio_pci_register_dev_region(struct vfio_pci_device *vdev,
130 unsigned int type, unsigned int subtype,
131 const struct vfio_pci_regops *ops,
132 size_t size, u32 flags, void *data);
133 #ifdef CONFIG_VFIO_PCI_IGD
134 extern int vfio_pci_igd_init(struct vfio_pci_device *vdev);
135 #else
vfio_pci_igd_init(struct vfio_pci_device * vdev)136 static inline int vfio_pci_igd_init(struct vfio_pci_device *vdev)
137 {
138 return -ENODEV;
139 }
140 #endif
141 #endif /* VFIO_PCI_PRIVATE_H */
142