xref: /openbmc/linux/drivers/vdpa/ifcvf/ifcvf_base.h (revision 15e3ae36)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Intel IFC VF NIC driver for virtio dataplane offloading
4  *
5  * Copyright (C) 2020 Intel Corporation.
6  *
7  * Author: Zhu Lingshan <lingshan.zhu@intel.com>
8  *
9  */
10 
11 #ifndef _IFCVF_H_
12 #define _IFCVF_H_
13 
14 #include <linux/pci.h>
15 #include <linux/pci_regs.h>
16 #include <linux/vdpa.h>
17 #include <uapi/linux/virtio_net.h>
18 #include <uapi/linux/virtio_config.h>
19 #include <uapi/linux/virtio_pci.h>
20 
21 #define IFCVF_VENDOR_ID		0x1AF4
22 #define IFCVF_DEVICE_ID		0x1041
23 #define IFCVF_SUBSYS_VENDOR_ID	0x8086
24 #define IFCVF_SUBSYS_DEVICE_ID	0x001A
25 
26 #define IFCVF_SUPPORTED_FEATURES \
27 		((1ULL << VIRTIO_NET_F_MAC)			| \
28 		 (1ULL << VIRTIO_F_ANY_LAYOUT)			| \
29 		 (1ULL << VIRTIO_F_VERSION_1)			| \
30 		 (1ULL << VIRTIO_F_ORDER_PLATFORM)		| \
31 		 (1ULL << VIRTIO_F_IOMMU_PLATFORM)		| \
32 		 (1ULL << VIRTIO_NET_F_MRG_RXBUF))
33 
34 /* Only one queue pair for now. */
35 #define IFCVF_MAX_QUEUE_PAIRS	1
36 
37 #define IFCVF_QUEUE_ALIGNMENT	PAGE_SIZE
38 #define IFCVF_QUEUE_MAX		32768
39 #define IFCVF_MSI_CONFIG_OFF	0
40 #define IFCVF_MSI_QUEUE_OFF	1
41 #define IFCVF_PCI_MAX_RESOURCE	6
42 
43 #define IFCVF_LM_CFG_SIZE		0x40
44 #define IFCVF_LM_RING_STATE_OFFSET	0x20
45 #define IFCVF_LM_BAR			4
46 
47 #define IFCVF_ERR(pdev, fmt, ...)	dev_err(&pdev->dev, fmt, ##__VA_ARGS__)
48 #define IFCVF_DBG(pdev, fmt, ...)	dev_dbg(&pdev->dev, fmt, ##__VA_ARGS__)
49 #define IFCVF_INFO(pdev, fmt, ...)	dev_info(&pdev->dev, fmt, ##__VA_ARGS__)
50 
51 #define ifcvf_private_to_vf(adapter) \
52 	(&((struct ifcvf_adapter *)adapter)->vf)
53 
54 #define IFCVF_MAX_INTR (IFCVF_MAX_QUEUE_PAIRS * 2 + 1)
55 
56 struct vring_info {
57 	u64 desc;
58 	u64 avail;
59 	u64 used;
60 	u16 size;
61 	u16 last_avail_idx;
62 	bool ready;
63 	void __iomem *notify_addr;
64 	u32 irq;
65 	struct vdpa_callback cb;
66 	char msix_name[256];
67 };
68 
69 struct ifcvf_hw {
70 	u8 __iomem *isr;
71 	/* Live migration */
72 	u8 __iomem *lm_cfg;
73 	u16 nr_vring;
74 	/* Notification bar number */
75 	u8 notify_bar;
76 	/* Notificaiton bar address */
77 	void __iomem *notify_base;
78 	u32 notify_off_multiplier;
79 	u64 req_features;
80 	struct virtio_pci_common_cfg __iomem *common_cfg;
81 	void __iomem *net_cfg;
82 	struct vring_info vring[IFCVF_MAX_QUEUE_PAIRS * 2];
83 	void __iomem * const *base;
84 };
85 
86 struct ifcvf_adapter {
87 	struct vdpa_device vdpa;
88 	struct pci_dev *pdev;
89 	struct ifcvf_hw vf;
90 };
91 
92 struct ifcvf_vring_lm_cfg {
93 	u32 idx_addr[2];
94 	u8 reserved[IFCVF_LM_CFG_SIZE - 8];
95 };
96 
97 struct ifcvf_lm_cfg {
98 	u8 reserved[IFCVF_LM_RING_STATE_OFFSET];
99 	struct ifcvf_vring_lm_cfg vring_lm_cfg[IFCVF_MAX_QUEUE_PAIRS];
100 };
101 
102 int ifcvf_init_hw(struct ifcvf_hw *hw, struct pci_dev *dev);
103 int ifcvf_start_hw(struct ifcvf_hw *hw);
104 void ifcvf_stop_hw(struct ifcvf_hw *hw);
105 void ifcvf_notify_queue(struct ifcvf_hw *hw, u16 qid);
106 void ifcvf_read_net_config(struct ifcvf_hw *hw, u64 offset,
107 			   void *dst, int length);
108 void ifcvf_write_net_config(struct ifcvf_hw *hw, u64 offset,
109 			    const void *src, int length);
110 u8 ifcvf_get_status(struct ifcvf_hw *hw);
111 void ifcvf_set_status(struct ifcvf_hw *hw, u8 status);
112 void io_write64_twopart(u64 val, u32 *lo, u32 *hi);
113 void ifcvf_reset(struct ifcvf_hw *hw);
114 u64 ifcvf_get_features(struct ifcvf_hw *hw);
115 u64 ifcvf_get_vq_state(struct ifcvf_hw *hw, u16 qid);
116 int ifcvf_set_vq_state(struct ifcvf_hw *hw, u16 qid, u64 num);
117 struct ifcvf_adapter *vf_to_adapter(struct ifcvf_hw *hw);
118 #endif /* _IFCVF_H_ */
119