GNU Linux-libre 5.15.54-gnu
[releases.git] / drivers / vdpa / vdpa_sim / vdpa_sim.h
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
45         work_func_t work_fn;
46         void (*get_config)(struct vdpasim *vdpasim, void *config);
47         void (*set_config)(struct vdpasim *vdpasim, const void *config);
48 };
49
50 /* State of each vdpasim device */
51 struct vdpasim {
52         struct vdpa_device vdpa;
53         struct vdpasim_virtqueue *vqs;
54         struct work_struct work;
55         struct vdpasim_dev_attr dev_attr;
56         /* spinlock to synchronize virtqueue state */
57         spinlock_t lock;
58         /* virtio config according to device type */
59         void *config;
60         struct vhost_iotlb *iommu;
61         struct iova_domain iova;
62         void *buffer;
63         u32 status;
64         u32 generation;
65         u64 features;
66         /* spinlock to synchronize iommu table */
67         spinlock_t iommu_lock;
68 };
69
70 struct vdpasim *vdpasim_create(struct vdpasim_dev_attr *attr);
71
72 /* TODO: cross-endian support */
73 static inline bool vdpasim_is_little_endian(struct vdpasim *vdpasim)
74 {
75         return virtio_legacy_is_little_endian() ||
76                 (vdpasim->features & (1ULL << VIRTIO_F_VERSION_1));
77 }
78
79 static inline u16 vdpasim16_to_cpu(struct vdpasim *vdpasim, __virtio16 val)
80 {
81         return __virtio16_to_cpu(vdpasim_is_little_endian(vdpasim), val);
82 }
83
84 static inline __virtio16 cpu_to_vdpasim16(struct vdpasim *vdpasim, u16 val)
85 {
86         return __cpu_to_virtio16(vdpasim_is_little_endian(vdpasim), val);
87 }
88
89 static inline u32 vdpasim32_to_cpu(struct vdpasim *vdpasim, __virtio32 val)
90 {
91         return __virtio32_to_cpu(vdpasim_is_little_endian(vdpasim), val);
92 }
93
94 static inline __virtio32 cpu_to_vdpasim32(struct vdpasim *vdpasim, u32 val)
95 {
96         return __cpu_to_virtio32(vdpasim_is_little_endian(vdpasim), val);
97 }
98
99 static inline u64 vdpasim64_to_cpu(struct vdpasim *vdpasim, __virtio64 val)
100 {
101         return __virtio64_to_cpu(vdpasim_is_little_endian(vdpasim), val);
102 }
103
104 static inline __virtio64 cpu_to_vdpasim64(struct vdpasim *vdpasim, u64 val)
105 {
106         return __cpu_to_virtio64(vdpasim_is_little_endian(vdpasim), val);
107 }
108
109 #endif