net/txgbe: support Tx with hardware offload
[dpdk.git] / drivers / net / txgbe / txgbe_ethdev.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2015-2020
3  */
4
5 #ifndef _TXGBE_ETHDEV_H_
6 #define _TXGBE_ETHDEV_H_
7
8 #include "base/txgbe.h"
9 #include "txgbe_ptypes.h"
10
11 /* need update link, bit flag */
12 #define TXGBE_FLAG_NEED_LINK_UPDATE (uint32_t)(1 << 0)
13 #define TXGBE_FLAG_MAILBOX          (uint32_t)(1 << 1)
14 #define TXGBE_FLAG_PHY_INTERRUPT    (uint32_t)(1 << 2)
15 #define TXGBE_FLAG_MACSEC           (uint32_t)(1 << 3)
16 #define TXGBE_FLAG_NEED_LINK_CONFIG (uint32_t)(1 << 4)
17
18 /*
19  * Defines that were not part of txgbe_type.h as they are not used by the
20  * FreeBSD driver.
21  */
22 #define TXGBE_VLAN_TAG_SIZE 4
23 #define TXGBE_HKEY_MAX_INDEX 10
24 /*Default value of Max Rx Queue*/
25 #define TXGBE_MAX_RX_QUEUE_NUM  128
26 #define TXGBE_VMDQ_DCB_NB_QUEUES     TXGBE_MAX_RX_QUEUE_NUM
27
28 #define TXGBE_QUEUE_ITR_INTERVAL_DEFAULT        500 /* 500us */
29
30 #define TXGBE_RSS_OFFLOAD_ALL ( \
31         ETH_RSS_IPV4 | \
32         ETH_RSS_NONFRAG_IPV4_TCP | \
33         ETH_RSS_NONFRAG_IPV4_UDP | \
34         ETH_RSS_IPV6 | \
35         ETH_RSS_NONFRAG_IPV6_TCP | \
36         ETH_RSS_NONFRAG_IPV6_UDP | \
37         ETH_RSS_IPV6_EX | \
38         ETH_RSS_IPV6_TCP_EX | \
39         ETH_RSS_IPV6_UDP_EX)
40
41 #define TXGBE_MISC_VEC_ID               RTE_INTR_VEC_ZERO_OFFSET
42 #define TXGBE_RX_VEC_START              RTE_INTR_VEC_RXTX_OFFSET
43
44 /* structure for interrupt relative data */
45 struct txgbe_interrupt {
46         uint32_t flags;
47         uint32_t mask_misc;
48         /* to save original mask during delayed handler */
49         uint32_t mask_misc_orig;
50         uint32_t mask[2];
51 };
52
53 struct txgbe_uta_info {
54         uint8_t  uc_filter_type;
55         uint16_t uta_in_use;
56         uint32_t uta_shadow[TXGBE_MAX_UTA];
57 };
58
59 /*
60  * Structure to store private data for each driver instance (for each port).
61  */
62 struct txgbe_adapter {
63         struct txgbe_hw             hw;
64         struct txgbe_interrupt      intr;
65         struct txgbe_uta_info       uta_info;
66         bool rx_bulk_alloc_allowed;
67 };
68
69 #define TXGBE_DEV_ADAPTER(dev) \
70         ((struct txgbe_adapter *)(dev)->data->dev_private)
71
72 #define TXGBE_DEV_HW(dev) \
73         (&((struct txgbe_adapter *)(dev)->data->dev_private)->hw)
74
75 #define TXGBE_DEV_INTR(dev) \
76         (&((struct txgbe_adapter *)(dev)->data->dev_private)->intr)
77
78 #define TXGBE_DEV_UTA_INFO(dev) \
79         (&((struct txgbe_adapter *)(dev)->data->dev_private)->uta_info)
80
81 /*
82  * RX/TX function prototypes
83  */
84 void txgbe_dev_free_queues(struct rte_eth_dev *dev);
85
86 void txgbe_dev_rx_queue_release(void *rxq);
87
88 void txgbe_dev_tx_queue_release(void *txq);
89
90 int  txgbe_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
91                 uint16_t nb_rx_desc, unsigned int socket_id,
92                 const struct rte_eth_rxconf *rx_conf,
93                 struct rte_mempool *mb_pool);
94
95 int  txgbe_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
96                 uint16_t nb_tx_desc, unsigned int socket_id,
97                 const struct rte_eth_txconf *tx_conf);
98
99 int txgbe_dev_rx_init(struct rte_eth_dev *dev);
100
101 void txgbe_dev_tx_init(struct rte_eth_dev *dev);
102
103 void txgbe_dev_save_rx_queue(struct txgbe_hw *hw, uint16_t rx_queue_id);
104 void txgbe_dev_store_rx_queue(struct txgbe_hw *hw, uint16_t rx_queue_id);
105 void txgbe_dev_save_tx_queue(struct txgbe_hw *hw, uint16_t tx_queue_id);
106 void txgbe_dev_store_tx_queue(struct txgbe_hw *hw, uint16_t tx_queue_id);
107
108 int txgbe_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
109
110 int txgbe_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
111
112 int txgbe_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
113
114 int txgbe_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
115
116 uint16_t txgbe_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
117                 uint16_t nb_pkts);
118
119 uint16_t txgbe_xmit_pkts_simple(void *tx_queue, struct rte_mbuf **tx_pkts,
120                 uint16_t nb_pkts);
121
122 void txgbe_set_ivar_map(struct txgbe_hw *hw, int8_t direction,
123                                uint8_t queue, uint8_t msix_vector);
124
125 int
126 txgbe_dev_link_update_share(struct rte_eth_dev *dev,
127                 int wait_to_complete);
128
129 #define TXGBE_LINK_DOWN_CHECK_TIMEOUT 4000 /* ms */
130 #define TXGBE_LINK_UP_CHECK_TIMEOUT   1000 /* ms */
131 #define TXGBE_VMDQ_NUM_UC_MAC         4096 /* Maximum nb. of UC MAC addr. */
132
133 /*
134  *  Default values for RX/TX configuration
135  */
136 #define TXGBE_DEFAULT_RX_FREE_THRESH  32
137 #define TXGBE_DEFAULT_RX_PTHRESH      8
138 #define TXGBE_DEFAULT_RX_HTHRESH      8
139 #define TXGBE_DEFAULT_RX_WTHRESH      0
140
141 #define TXGBE_DEFAULT_TX_FREE_THRESH  32
142 #define TXGBE_DEFAULT_TX_PTHRESH      32
143 #define TXGBE_DEFAULT_TX_HTHRESH      0
144 #define TXGBE_DEFAULT_TX_WTHRESH      0
145
146 int txgbe_dev_set_mc_addr_list(struct rte_eth_dev *dev,
147                                       struct rte_ether_addr *mc_addr_set,
148                                       uint32_t nb_mc_addr);
149 void txgbe_dev_setup_link_alarm_handler(void *param);
150
151 #endif /* _TXGBE_ETHDEV_H_ */