xref: /dpdk/drivers/net/virtio/virtio_ethdev.h (revision 9e991f217fc8719e38a812dc280dba5f84db9f59)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2015 Intel Corporation
3  */
4 
5 #ifndef _VIRTIO_ETHDEV_H_
6 #define _VIRTIO_ETHDEV_H_
7 
8 #include <stdint.h>
9 
10 #include "virtio_pci.h"
11 
12 #ifndef PAGE_SIZE
13 #define PAGE_SIZE 4096
14 #endif
15 
16 #define VIRTIO_MAX_RX_QUEUES 128U
17 #define VIRTIO_MAX_TX_QUEUES 128U
18 #define VIRTIO_MAX_MAC_ADDRS 64
19 #define VIRTIO_MIN_RX_BUFSIZE 64
20 #define VIRTIO_MAX_RX_PKTLEN  9728U
21 
22 /* Features desired/implemented by this driver. */
23 #define VIRTIO_PMD_DEFAULT_GUEST_FEATURES	\
24 	(1u << VIRTIO_NET_F_MAC		  |	\
25 	 1u << VIRTIO_NET_F_STATUS	  |	\
26 	 1u << VIRTIO_NET_F_MQ		  |	\
27 	 1u << VIRTIO_NET_F_CTRL_MAC_ADDR |	\
28 	 1u << VIRTIO_NET_F_CTRL_VQ	  |	\
29 	 1u << VIRTIO_NET_F_CTRL_RX	  |	\
30 	 1u << VIRTIO_NET_F_CTRL_VLAN	  |	\
31 	 1u << VIRTIO_NET_F_MRG_RXBUF	  |	\
32 	 1u << VIRTIO_NET_F_MTU	| \
33 	 1ULL << VIRTIO_NET_F_GUEST_ANNOUNCE |	\
34 	 1u << VIRTIO_RING_F_INDIRECT_DESC |    \
35 	 1ULL << VIRTIO_F_VERSION_1       |	\
36 	 1ULL << VIRTIO_F_IN_ORDER        |	\
37 	 1ULL << VIRTIO_F_RING_PACKED	  |	\
38 	 1ULL << VIRTIO_F_IOMMU_PLATFORM  |	\
39 	 1ULL << VIRTIO_F_ORDER_PLATFORM  |	\
40 	 1ULL << VIRTIO_F_NOTIFICATION_DATA)
41 
42 #define VIRTIO_PMD_SUPPORTED_GUEST_FEATURES	\
43 	(VIRTIO_PMD_DEFAULT_GUEST_FEATURES |	\
44 	 1u << VIRTIO_NET_F_GUEST_CSUM	   |	\
45 	 1u << VIRTIO_NET_F_GUEST_TSO4     |	\
46 	 1u << VIRTIO_NET_F_GUEST_TSO6     |	\
47 	 1u << VIRTIO_NET_F_CSUM           |	\
48 	 1u << VIRTIO_NET_F_HOST_TSO4      |	\
49 	 1u << VIRTIO_NET_F_HOST_TSO6)
50 
51 extern const struct eth_dev_ops virtio_user_secondary_eth_dev_ops;
52 
53 /*
54  * CQ function prototype
55  */
56 void virtio_dev_cq_start(struct rte_eth_dev *dev);
57 
58 /*
59  * RX/TX function prototypes
60  */
61 
62 int virtio_dev_rx_queue_done(void *rxq, uint16_t offset);
63 
64 int  virtio_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
65 		uint16_t nb_rx_desc, unsigned int socket_id,
66 		const struct rte_eth_rxconf *rx_conf,
67 		struct rte_mempool *mb_pool);
68 
69 int virtio_dev_rx_queue_setup_finish(struct rte_eth_dev *dev,
70 				uint16_t rx_queue_id);
71 
72 int  virtio_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
73 		uint16_t nb_tx_desc, unsigned int socket_id,
74 		const struct rte_eth_txconf *tx_conf);
75 
76 int virtio_dev_tx_queue_setup_finish(struct rte_eth_dev *dev,
77 				uint16_t tx_queue_id);
78 
79 uint16_t virtio_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
80 		uint16_t nb_pkts);
81 uint16_t virtio_recv_pkts_packed(void *rx_queue, struct rte_mbuf **rx_pkts,
82 		uint16_t nb_pkts);
83 
84 uint16_t virtio_recv_mergeable_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
85 		uint16_t nb_pkts);
86 
87 uint16_t virtio_recv_mergeable_pkts_packed(void *rx_queue,
88 		struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
89 
90 uint16_t virtio_recv_pkts_inorder(void *rx_queue,
91 		struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
92 
93 uint16_t virtio_xmit_pkts_prepare(void *tx_queue, struct rte_mbuf **tx_pkts,
94 		uint16_t nb_pkts);
95 
96 uint16_t virtio_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
97 		uint16_t nb_pkts);
98 uint16_t virtio_xmit_pkts_packed(void *tx_queue, struct rte_mbuf **tx_pkts,
99 		uint16_t nb_pkts);
100 
101 uint16_t virtio_xmit_pkts_inorder(void *tx_queue, struct rte_mbuf **tx_pkts,
102 		uint16_t nb_pkts);
103 
104 uint16_t virtio_recv_pkts_vec(void *rx_queue, struct rte_mbuf **rx_pkts,
105 		uint16_t nb_pkts);
106 
107 int eth_virtio_dev_init(struct rte_eth_dev *eth_dev);
108 
109 void virtio_interrupt_handler(void *param);
110 
111 int virtio_dev_pause(struct rte_eth_dev *dev);
112 void virtio_dev_resume(struct rte_eth_dev *dev);
113 int virtio_inject_pkts(struct rte_eth_dev *dev, struct rte_mbuf **tx_pkts,
114 		int nb_pkts);
115 
116 #endif /* _VIRTIO_ETHDEV_H_ */
117