1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2015-2020
5 #ifndef _TXGBE_ETHDEV_H_
6 #define _TXGBE_ETHDEV_H_
8 #include "base/txgbe.h"
9 #include "txgbe_ptypes.h"
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)
19 * Defines that were not part of txgbe_type.h as they are not used by the
22 #define TXGBE_VFTA_SIZE 128
23 #define TXGBE_VLAN_TAG_SIZE 4
24 #define TXGBE_HKEY_MAX_INDEX 10
25 /*Default value of Max Rx Queue*/
26 #define TXGBE_MAX_RX_QUEUE_NUM 128
27 #define TXGBE_VMDQ_DCB_NB_QUEUES TXGBE_MAX_RX_QUEUE_NUM
30 #define NBBY 8 /* number of bits in a byte */
32 #define TXGBE_HWSTRIP_BITMAP_SIZE \
33 (TXGBE_MAX_RX_QUEUE_NUM / (sizeof(uint32_t) * NBBY))
35 #define TXGBE_QUEUE_ITR_INTERVAL_DEFAULT 500 /* 500us */
37 #define TXGBE_RSS_OFFLOAD_ALL ( \
39 ETH_RSS_NONFRAG_IPV4_TCP | \
40 ETH_RSS_NONFRAG_IPV4_UDP | \
42 ETH_RSS_NONFRAG_IPV6_TCP | \
43 ETH_RSS_NONFRAG_IPV6_UDP | \
45 ETH_RSS_IPV6_TCP_EX | \
48 #define TXGBE_MISC_VEC_ID RTE_INTR_VEC_ZERO_OFFSET
49 #define TXGBE_RX_VEC_START RTE_INTR_VEC_RXTX_OFFSET
51 /* structure for interrupt relative data */
52 struct txgbe_interrupt {
55 /* to save original mask during delayed handler */
56 uint32_t mask_misc_orig;
60 #define TXGBE_NB_STAT_MAPPING 32
61 #define QSM_REG_NB_BITS_PER_QMAP_FIELD 8
62 #define NB_QMAP_FIELDS_PER_QSM_REG 4
63 #define QMAP_FIELD_RESERVED_BITS_MASK 0x0f
64 struct txgbe_stat_mappings {
65 uint32_t tqsm[TXGBE_NB_STAT_MAPPING];
66 uint32_t rqsm[TXGBE_NB_STAT_MAPPING];
70 uint32_t vfta[TXGBE_VFTA_SIZE];
73 struct txgbe_hwstrip {
74 uint32_t bitmap[TXGBE_HWSTRIP_BITMAP_SIZE];
77 struct txgbe_uta_info {
78 uint8_t uc_filter_type;
80 uint32_t uta_shadow[TXGBE_MAX_UTA];
83 #define TXGBE_MAX_MIRROR_RULES 4 /* Maximum nb. of mirror rules. */
85 struct txgbe_mirror_info {
86 struct rte_eth_mirror_conf mr_conf[TXGBE_MAX_MIRROR_RULES];
87 /* store PF mirror rules configuration */
90 struct txgbe_vf_info {
91 uint8_t vf_mac_addresses[RTE_ETHER_ADDR_LEN];
92 uint16_t switch_domain_id;
96 * Structure to store private data for each driver instance (for each port).
98 struct txgbe_adapter {
100 struct txgbe_hw_stats stats;
101 struct txgbe_interrupt intr;
102 struct txgbe_stat_mappings stat_mappings;
103 struct txgbe_vfta shadow_vfta;
104 struct txgbe_hwstrip hwstrip;
105 struct txgbe_mirror_info mr_data;
106 struct txgbe_vf_info *vfdata;
107 struct txgbe_uta_info uta_info;
108 bool rx_bulk_alloc_allowed;
111 #define TXGBE_DEV_ADAPTER(dev) \
112 ((struct txgbe_adapter *)(dev)->data->dev_private)
114 #define TXGBE_DEV_HW(dev) \
115 (&((struct txgbe_adapter *)(dev)->data->dev_private)->hw)
117 #define TXGBE_DEV_STATS(dev) \
118 (&((struct txgbe_adapter *)(dev)->data->dev_private)->stats)
120 #define TXGBE_DEV_INTR(dev) \
121 (&((struct txgbe_adapter *)(dev)->data->dev_private)->intr)
123 #define TXGBE_DEV_STAT_MAPPINGS(dev) \
124 (&((struct txgbe_adapter *)(dev)->data->dev_private)->stat_mappings)
126 #define TXGBE_DEV_VFTA(dev) \
127 (&((struct txgbe_adapter *)(dev)->data->dev_private)->shadow_vfta)
129 #define TXGBE_DEV_HWSTRIP(dev) \
130 (&((struct txgbe_adapter *)(dev)->data->dev_private)->hwstrip)
132 #define TXGBE_DEV_VFDATA(dev) \
133 (&((struct txgbe_adapter *)(dev)->data->dev_private)->vfdata)
135 #define TXGBE_DEV_MR_INFO(dev) \
136 (&((struct txgbe_adapter *)(dev)->data->dev_private)->mr_data)
138 #define TXGBE_DEV_UTA_INFO(dev) \
139 (&((struct txgbe_adapter *)(dev)->data->dev_private)->uta_info)
142 * RX/TX function prototypes
144 void txgbe_dev_clear_queues(struct rte_eth_dev *dev);
146 void txgbe_dev_free_queues(struct rte_eth_dev *dev);
148 void txgbe_dev_rx_queue_release(void *rxq);
150 void txgbe_dev_tx_queue_release(void *txq);
152 int txgbe_dev_rx_queue_setup(struct rte_eth_dev *dev, uint16_t rx_queue_id,
153 uint16_t nb_rx_desc, unsigned int socket_id,
154 const struct rte_eth_rxconf *rx_conf,
155 struct rte_mempool *mb_pool);
157 int txgbe_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t tx_queue_id,
158 uint16_t nb_tx_desc, unsigned int socket_id,
159 const struct rte_eth_txconf *tx_conf);
161 int txgbe_dev_rx_init(struct rte_eth_dev *dev);
163 void txgbe_dev_tx_init(struct rte_eth_dev *dev);
165 int txgbe_dev_rxtx_start(struct rte_eth_dev *dev);
167 void txgbe_dev_save_rx_queue(struct txgbe_hw *hw, uint16_t rx_queue_id);
168 void txgbe_dev_store_rx_queue(struct txgbe_hw *hw, uint16_t rx_queue_id);
169 void txgbe_dev_save_tx_queue(struct txgbe_hw *hw, uint16_t tx_queue_id);
170 void txgbe_dev_store_tx_queue(struct txgbe_hw *hw, uint16_t tx_queue_id);
172 int txgbe_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
174 int txgbe_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
176 int txgbe_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
178 int txgbe_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
180 void txgbe_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
181 struct rte_eth_rxq_info *qinfo);
183 void txgbe_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
184 struct rte_eth_txq_info *qinfo);
186 uint16_t txgbe_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
189 uint16_t txgbe_recv_pkts_bulk_alloc(void *rx_queue, struct rte_mbuf **rx_pkts,
192 uint16_t txgbe_recv_pkts_lro_single_alloc(void *rx_queue,
193 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
194 uint16_t txgbe_recv_pkts_lro_bulk_alloc(void *rx_queue,
195 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
197 uint16_t txgbe_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
200 uint16_t txgbe_xmit_pkts_simple(void *tx_queue, struct rte_mbuf **tx_pkts,
203 uint16_t txgbe_prep_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
206 void txgbe_set_ivar_map(struct txgbe_hw *hw, int8_t direction,
207 uint8_t queue, uint8_t msix_vector);
210 txgbe_dev_link_update_share(struct rte_eth_dev *dev,
211 int wait_to_complete);
212 void txgbe_pf_host_init(struct rte_eth_dev *eth_dev);
214 void txgbe_pf_host_uninit(struct rte_eth_dev *eth_dev);
217 #define TXGBE_LINK_DOWN_CHECK_TIMEOUT 4000 /* ms */
218 #define TXGBE_LINK_UP_CHECK_TIMEOUT 1000 /* ms */
219 #define TXGBE_VMDQ_NUM_UC_MAC 4096 /* Maximum nb. of UC MAC addr. */
222 * Default values for RX/TX configuration
224 #define TXGBE_DEFAULT_RX_FREE_THRESH 32
225 #define TXGBE_DEFAULT_RX_PTHRESH 8
226 #define TXGBE_DEFAULT_RX_HTHRESH 8
227 #define TXGBE_DEFAULT_RX_WTHRESH 0
229 #define TXGBE_DEFAULT_TX_FREE_THRESH 32
230 #define TXGBE_DEFAULT_TX_PTHRESH 32
231 #define TXGBE_DEFAULT_TX_HTHRESH 0
232 #define TXGBE_DEFAULT_TX_WTHRESH 0
234 /* store statistics names and its offset in stats structure */
235 struct rte_txgbe_xstats_name_off {
236 char name[RTE_ETH_XSTATS_NAME_SIZE];
240 const uint32_t *txgbe_dev_supported_ptypes_get(struct rte_eth_dev *dev);
241 int txgbe_dev_set_mc_addr_list(struct rte_eth_dev *dev,
242 struct rte_ether_addr *mc_addr_set,
243 uint32_t nb_mc_addr);
244 void txgbe_dev_setup_link_alarm_handler(void *param);
245 void txgbe_read_stats_registers(struct txgbe_hw *hw,
246 struct txgbe_hw_stats *hw_stats);
248 void txgbe_vlan_hw_filter_enable(struct rte_eth_dev *dev);
249 void txgbe_vlan_hw_filter_disable(struct rte_eth_dev *dev);
250 void txgbe_vlan_hw_strip_config(struct rte_eth_dev *dev);
251 void txgbe_vlan_hw_strip_bitmap_set(struct rte_eth_dev *dev,
252 uint16_t queue, bool on);
253 void txgbe_config_vlan_strip_on_all_queues(struct rte_eth_dev *dev,
256 #endif /* _TXGBE_ETHDEV_H_ */