xref: /linux/drivers/vdpa/vdpa_sim/vdpa_sim.h (revision 31354121bf03dac6498a4236928a38490745d601)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright (c) 2020, Red Hat Inc. All rights reserved.
4  */
5 
6 #ifndef _VDPA_SIM_H
7 #define _VDPA_SIM_H
8 
9 #include <linux/iova.h>
10 #include <linux/vringh.h>
11 #include <linux/vdpa.h>
12 #include <linux/virtio_byteorder.h>
13 #include <linux/vhost_iotlb.h>
14 #include <uapi/linux/virtio_config.h>
15 
16 #define VDPASIM_FEATURES	((1ULL << VIRTIO_F_ANY_LAYOUT) | \
17 				 (1ULL << VIRTIO_F_VERSION_1)  | \
18 				 (1ULL << VIRTIO_F_ACCESS_PLATFORM))
19 
20 struct vdpasim;
21 
22 struct vdpasim_virtqueue {
23 	struct vringh vring;
24 	struct vringh_kiov in_iov;
25 	struct vringh_kiov out_iov;
26 	unsigned short head;
27 	bool ready;
28 	u64 desc_addr;
29 	u64 device_addr;
30 	u64 driver_addr;
31 	u32 num;
32 	void *private;
33 	irqreturn_t (*cb)(void *data);
34 };
35 
36 struct vdpasim_dev_attr {
37 	struct vdpa_mgmt_dev *mgmt_dev;
38 	const char *name;
39 	u64 supported_features;
40 	size_t config_size;
41 	size_t buffer_size;
42 	int nvqs;
43 	u32 id;
44 	u32 ngroups;
45 	u32 nas;
46 
47 	work_func_t work_fn;
48 	void (*get_config)(struct vdpasim *vdpasim, void *config);
49 	void (*set_config)(struct vdpasim *vdpasim, const void *config);
50 };
51 
52 /* State of each vdpasim device */
53 struct vdpasim {
54 	struct vdpa_device vdpa;
55 	struct vdpasim_virtqueue *vqs;
56 	struct work_struct work;
57 	struct vdpasim_dev_attr dev_attr;
58 	/* spinlock to synchronize virtqueue state */
59 	spinlock_t lock;
60 	/* virtio config according to device type */
61 	void *config;
62 	struct vhost_iotlb *iommu;
63 	struct iova_domain iova;
64 	void *buffer;
65 	u32 status;
66 	u32 generation;
67 	u64 features;
68 	u32 groups;
69 	bool running;
70 	/* spinlock to synchronize iommu table */
71 	spinlock_t iommu_lock;
72 };
73 
74 struct vdpasim *vdpasim_create(struct vdpasim_dev_attr *attr,
75 			       const struct vdpa_dev_set_config *config);
76 
77 /* TODO: cross-endian support */
78 static inline bool vdpasim_is_little_endian(struct vdpasim *vdpasim)
79 {
80 	return virtio_legacy_is_little_endian() ||
81 		(vdpasim->features & (1ULL << VIRTIO_F_VERSION_1));
82 }
83 
84 static inline u16 vdpasim16_to_cpu(struct vdpasim *vdpasim, __virtio16 val)
85 {
86 	return __virtio16_to_cpu(vdpasim_is_little_endian(vdpasim), val);
87 }
88 
89 static inline __virtio16 cpu_to_vdpasim16(struct vdpasim *vdpasim, u16 val)
90 {
91 	return __cpu_to_virtio16(vdpasim_is_little_endian(vdpasim), val);
92 }
93 
94 static inline u32 vdpasim32_to_cpu(struct vdpasim *vdpasim, __virtio32 val)
95 {
96 	return __virtio32_to_cpu(vdpasim_is_little_endian(vdpasim), val);
97 }
98 
99 static inline __virtio32 cpu_to_vdpasim32(struct vdpasim *vdpasim, u32 val)
100 {
101 	return __cpu_to_virtio32(vdpasim_is_little_endian(vdpasim), val);
102 }
103 
104 static inline u64 vdpasim64_to_cpu(struct vdpasim *vdpasim, __virtio64 val)
105 {
106 	return __virtio64_to_cpu(vdpasim_is_little_endian(vdpasim), val);
107 }
108 
109 static inline __virtio64 cpu_to_vdpasim64(struct vdpasim *vdpasim, u64 val)
110 {
111 	return __cpu_to_virtio64(vdpasim_is_little_endian(vdpasim), val);
112 }
113 
114 #endif
115