1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation
3 * Copyright(c) 2021 Red Hat, Inc.
11 /* The feature bitmap for virtio net */
12 #define VIRTIO_NET_F_CSUM 0 /* Host handles pkts w/ partial csum */
13 #define VIRTIO_NET_F_GUEST_CSUM 1 /* Guest handles pkts w/ partial csum */
14 #define VIRTIO_NET_F_MTU 3 /* Initial MTU advice. */
15 #define VIRTIO_NET_F_MAC 5 /* Host has given MAC address. */
16 #define VIRTIO_NET_F_GUEST_TSO4 7 /* Guest can handle TSOv4 in. */
17 #define VIRTIO_NET_F_GUEST_TSO6 8 /* Guest can handle TSOv6 in. */
18 #define VIRTIO_NET_F_GUEST_ECN 9 /* Guest can handle TSO[6] w/ ECN in. */
19 #define VIRTIO_NET_F_GUEST_UFO 10 /* Guest can handle UFO in. */
20 #define VIRTIO_NET_F_HOST_TSO4 11 /* Host can handle TSOv4 in. */
21 #define VIRTIO_NET_F_HOST_TSO6 12 /* Host can handle TSOv6 in. */
22 #define VIRTIO_NET_F_HOST_ECN 13 /* Host can handle TSO[6] w/ ECN in. */
23 #define VIRTIO_NET_F_HOST_UFO 14 /* Host can handle UFO in. */
24 #define VIRTIO_NET_F_MRG_RXBUF 15 /* Host can merge receive buffers. */
25 #define VIRTIO_NET_F_STATUS 16 /* virtio_net_config.status available */
26 #define VIRTIO_NET_F_CTRL_VQ 17 /* Control channel available */
27 #define VIRTIO_NET_F_CTRL_RX 18 /* Control channel RX mode support */
28 #define VIRTIO_NET_F_CTRL_VLAN 19 /* Control channel VLAN filtering */
29 #define VIRTIO_NET_F_CTRL_RX_EXTRA 20 /* Extra RX mode control support */
30 #define VIRTIO_NET_F_GUEST_ANNOUNCE 21 /* Guest can announce device on the network */
31 #define VIRTIO_NET_F_MQ 22 /* Device supports Receive Flow Steering */
32 #define VIRTIO_NET_F_CTRL_MAC_ADDR 23 /* Set MAC address */
35 * Do we get callbacks when the ring is completely used,
36 * even if we've suppressed them?
38 #define VIRTIO_F_NOTIFY_ON_EMPTY 24
40 /* Can the device handle any descriptor layout? */
41 #define VIRTIO_F_ANY_LAYOUT 27
43 /* We support indirect buffer descriptors */
44 #define VIRTIO_RING_F_INDIRECT_DESC 28
46 #define VIRTIO_F_VERSION_1 32
47 #define VIRTIO_F_IOMMU_PLATFORM 33
48 #define VIRTIO_F_RING_PACKED 34
51 * Some VirtIO feature bits (currently bits 28 through 31) are
52 * reserved for the transport being used (eg. virtio_ring), the
53 * rest are per-device feature bits.
55 #define VIRTIO_TRANSPORT_F_START 28
56 #define VIRTIO_TRANSPORT_F_END 34
59 * Inorder feature indicates that all buffers are used by the device
60 * in the same order in which they have been made available.
62 #define VIRTIO_F_IN_ORDER 35
65 * This feature indicates that memory accesses by the driver and the device
66 * are ordered in a way described by the platform.
68 #define VIRTIO_F_ORDER_PLATFORM 36
71 * This feature indicates that the driver passes extra data (besides
72 * identifying the virtqueue) in its device notifications.
74 #define VIRTIO_F_NOTIFICATION_DATA 38
76 /* Device set linkspeed and duplex */
77 #define VIRTIO_NET_F_SPEED_DUPLEX 63
80 * The Guest publishes the used index for which it expects an interrupt
81 * at the end of the avail ring. Host should ignore the avail->flags field
83 * The Host publishes the avail index for which it expects a kick
84 * at the end of the used ring. Guest should ignore the used->flags field.
86 #define VIRTIO_RING_F_EVENT_IDX 29
88 #define VIRTIO_NET_S_LINK_UP 1 /* Link is up */
89 #define VIRTIO_NET_S_ANNOUNCE 2 /* Announcement is needed */
92 * Each virtqueue indirect descriptor list must be physically contiguous.
93 * To allow us to malloc(9) each list individually, limit the number
94 * supported to what will fit in one page. With 4KB pages, this is a limit
95 * of 256 descriptors. If there is ever a need for more, we can switch to
96 * contigmalloc(9) for the larger allocations, similar to what
97 * bus_dmamem_alloc(9) does.
99 * Note the sizeof(struct vring_desc) is 16 bytes.
101 #define VIRTIO_MAX_INDIRECT ((int)(rte_mem_page_size() / 16))
104 * Maximum number of virtqueues per device.
106 #define VIRTIO_MAX_VIRTQUEUE_PAIRS 8
107 #define VIRTIO_MAX_VIRTQUEUES (VIRTIO_MAX_VIRTQUEUE_PAIRS * 2 + 1)
109 /* VirtIO device IDs. */
110 #define VIRTIO_ID_NETWORK 0x01
111 #define VIRTIO_ID_BLOCK 0x02
112 #define VIRTIO_ID_CONSOLE 0x03
113 #define VIRTIO_ID_ENTROPY 0x04
114 #define VIRTIO_ID_BALLOON 0x05
115 #define VIRTIO_ID_IOMEMORY 0x06
116 #define VIRTIO_ID_9P 0x09
118 /* Status byte for guest to report progress. */
119 #define VIRTIO_CONFIG_STATUS_RESET 0x00
120 #define VIRTIO_CONFIG_STATUS_ACK 0x01
121 #define VIRTIO_CONFIG_STATUS_DRIVER 0x02
122 #define VIRTIO_CONFIG_STATUS_DRIVER_OK 0x04
123 #define VIRTIO_CONFIG_STATUS_FEATURES_OK 0x08
124 #define VIRTIO_CONFIG_STATUS_DEV_NEED_RESET 0x40
125 #define VIRTIO_CONFIG_STATUS_FAILED 0x80
127 /* The bit of the ISR which indicates a device has an interrupt. */
128 #define VIRTIO_ISR_INTR 0x1
129 /* The bit of the ISR which indicates a device configuration change. */
130 #define VIRTIO_ISR_CONFIG 0x2
131 /* Vector value used to disable MSI for queue. */
132 #define VIRTIO_MSI_NO_VECTOR 0xFFFF
134 /* The alignment to use between consumer and producer parts of vring. */
135 #define VIRTIO_VRING_ALIGN 4096
138 * This structure is just a reference to read net device specific
139 * config space; it is just a shadow structure.
142 struct virtio_net_config {
143 /* The config defining mac address (if VIRTIO_NET_F_MAC) */
144 uint8_t mac[RTE_ETHER_ADDR_LEN];
145 /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
147 uint16_t max_virtqueue_pairs;
150 * speed, in units of 1Mb. All values 0 to INT_MAX are legal.
151 * Any other value stands for unknown.
157 * Any other value stands for unknown.
164 struct virtqueue **vqs;
165 uint64_t guest_features;
166 uint16_t vtnet_hdr_size;
168 uint8_t weak_barriers;
171 uint8_t has_tx_offload;
172 uint8_t has_rx_offload;
175 uint8_t use_inorder_rx;
176 uint8_t use_inorder_tx;
179 uint8_t mac_addr[RTE_ETHER_ADDR_LEN];
180 uint32_t speed; /* link speed in MB */
184 size_t max_rx_pkt_len;
186 * App management thread and virtio interrupt handler thread
187 * both can change device state, this lock is meant to avoid
190 rte_spinlock_t state_lock;
191 struct rte_mbuf **inject_pkts;
192 uint16_t max_queue_pairs;
193 uint64_t req_guest_features;
194 struct virtnet_ctl *cvq;
199 void (*read_dev_cfg)(struct virtio_hw *hw, size_t offset, void *dst, int len);
200 void (*write_dev_cfg)(struct virtio_hw *hw, size_t offset, const void *src, int len);
201 uint8_t (*get_status)(struct virtio_hw *hw);
202 void (*set_status)(struct virtio_hw *hw, uint8_t status);
203 uint64_t (*get_features)(struct virtio_hw *hw);
204 void (*set_features)(struct virtio_hw *hw, uint64_t features);
205 int (*features_ok)(struct virtio_hw *hw);
206 uint8_t (*get_isr)(struct virtio_hw *hw);
207 uint16_t (*set_config_irq)(struct virtio_hw *hw, uint16_t vec);
208 uint16_t (*set_queue_irq)(struct virtio_hw *hw, struct virtqueue *vq, uint16_t vec);
209 uint16_t (*get_queue_num)(struct virtio_hw *hw, uint16_t queue_id);
210 int (*setup_queue)(struct virtio_hw *hw, struct virtqueue *vq);
211 void (*del_queue)(struct virtio_hw *hw, struct virtqueue *vq);
212 void (*notify_queue)(struct virtio_hw *hw, struct virtqueue *vq);
213 void (*intr_detect)(struct virtio_hw *hw);
214 int (*dev_close)(struct virtio_hw *hw);
218 * This structure stores per-process data. Only virtio_ops for now.
220 struct virtio_hw_internal {
221 const struct virtio_ops *virtio_ops;
224 #define VIRTIO_OPS(hw) (virtio_hw_internal[(hw)->port_id].virtio_ops)
226 extern struct virtio_hw_internal virtio_hw_internal[RTE_MAX_ETHPORTS];
230 virtio_with_feature(struct virtio_hw *hw, uint64_t bit)
232 return (hw->guest_features & (1ULL << bit)) != 0;
236 virtio_with_packed_queue(struct virtio_hw *hw)
238 return virtio_with_feature(hw, VIRTIO_F_RING_PACKED);
241 uint64_t virtio_negotiate_features(struct virtio_hw *hw, uint64_t host_features);
242 uint8_t virtio_get_status(struct virtio_hw *hw);
243 void virtio_set_status(struct virtio_hw *hw, uint8_t status);
244 void virtio_write_dev_config(struct virtio_hw *hw, size_t offset, const void *src, int length);
245 void virtio_read_dev_config(struct virtio_hw *hw, size_t offset, void *dst, int length);
246 void virtio_reset(struct virtio_hw *hw);
247 void virtio_reinit_complete(struct virtio_hw *hw);
248 uint8_t virtio_get_isr(struct virtio_hw *hw);
249 #endif /* _VIRTIO_H_ */