a10111758dbd4e6852ff8fd190db45feff36bfa3
[dpdk.git] / drivers / net / virtio / virtio_ethdev.h
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
41 #define VIRTIO_PMD_SUPPORTED_GUEST_FEATURES     \
42         (VIRTIO_PMD_DEFAULT_GUEST_FEATURES |    \
43          1u << VIRTIO_NET_F_GUEST_CSUM     |    \
44          1u << VIRTIO_NET_F_GUEST_TSO4     |    \
45          1u << VIRTIO_NET_F_GUEST_TSO6     |    \
46          1u << VIRTIO_NET_F_CSUM           |    \
47          1u << VIRTIO_NET_F_HOST_TSO4      |    \
48          1u << VIRTIO_NET_F_HOST_TSO6)
49
50 extern const struct eth_dev_ops virtio_user_secondary_eth_dev_ops;
51
52 /*
53  * CQ function prototype
54  */
55 void virtio_dev_cq_start(struct rte_eth_dev *dev);
56
57 /*
58  * RX/TX function prototypes
59  */
60
61 int virtio_dev_rx_queue_done(void *rxq, uint16_t offset);
62
63 int  virtio_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
64                 uint16_t nb_rx_desc, unsigned int socket_id,
65                 const struct rte_eth_rxconf *rx_conf,
66                 struct rte_mempool *mb_pool);
67
68 int virtio_dev_rx_queue_setup_finish(struct rte_eth_dev *dev,
69                                 uint16_t rx_queue_id);
70
71 int  virtio_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
72                 uint16_t nb_tx_desc, unsigned int socket_id,
73                 const struct rte_eth_txconf *tx_conf);
74
75 int virtio_dev_tx_queue_setup_finish(struct rte_eth_dev *dev,
76                                 uint16_t tx_queue_id);
77
78 uint16_t virtio_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
79                 uint16_t nb_pkts);
80 uint16_t virtio_recv_pkts_packed(void *rx_queue, struct rte_mbuf **rx_pkts,
81                 uint16_t nb_pkts);
82
83 uint16_t virtio_recv_mergeable_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
84                 uint16_t nb_pkts);
85
86 uint16_t virtio_recv_mergeable_pkts_packed(void *rx_queue,
87                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
88
89 uint16_t virtio_recv_pkts_inorder(void *rx_queue,
90                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
91
92 uint16_t virtio_xmit_pkts_prepare(void *tx_queue, struct rte_mbuf **tx_pkts,
93                 uint16_t nb_pkts);
94
95 uint16_t virtio_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
96                 uint16_t nb_pkts);
97 uint16_t virtio_xmit_pkts_packed(void *tx_queue, struct rte_mbuf **tx_pkts,
98                 uint16_t nb_pkts);
99
100 uint16_t virtio_xmit_pkts_inorder(void *tx_queue, struct rte_mbuf **tx_pkts,
101                 uint16_t nb_pkts);
102
103 uint16_t virtio_recv_pkts_vec(void *rx_queue, struct rte_mbuf **rx_pkts,
104                 uint16_t nb_pkts);
105
106 int eth_virtio_dev_init(struct rte_eth_dev *eth_dev);
107
108 void virtio_interrupt_handler(void *param);
109
110 int virtio_dev_pause(struct rte_eth_dev *dev);
111 void virtio_dev_resume(struct rte_eth_dev *dev);
112 int virtio_inject_pkts(struct rte_eth_dev *dev, struct rte_mbuf **tx_pkts,
113                 int nb_pkts);
114
115 #endif /* _VIRTIO_ETHDEV_H_ */