1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation
5 #ifndef _IAVF_ETHDEV_H_
6 #define _IAVF_ETHDEV_H_
8 #include <rte_kvargs.h>
9 #include <iavf_prototype.h>
10 #include <iavf_adminq_cmd.h>
11 #include <iavf_type.h>
15 #define IAVF_AQ_LEN 32
16 #define IAVF_AQ_BUF_SZ 4096
17 #define IAVF_RESET_WAIT_CNT 50
18 #define IAVF_BUF_SIZE_MIN 1024
19 #define IAVF_FRAME_SIZE_MAX 9728
20 #define IAVF_QUEUE_BASE_ADDR_UNIT 128
22 #define IAVF_MAX_NUM_QUEUES 16
24 #define IAVF_NUM_MACADDR_MAX 64
26 #define IAVF_DEFAULT_RX_PTHRESH 8
27 #define IAVF_DEFAULT_RX_HTHRESH 8
28 #define IAVF_DEFAULT_RX_WTHRESH 0
30 #define IAVF_DEFAULT_RX_FREE_THRESH 32
32 #define IAVF_DEFAULT_TX_PTHRESH 32
33 #define IAVF_DEFAULT_TX_HTHRESH 0
34 #define IAVF_DEFAULT_TX_WTHRESH 0
36 #define IAVF_DEFAULT_TX_FREE_THRESH 32
37 #define IAVF_DEFAULT_TX_RS_THRESH 32
39 #define IAVF_BASIC_OFFLOAD_CAPS ( \
40 VF_BASE_MODE_OFFLOADS | \
41 VIRTCHNL_VF_OFFLOAD_WB_ON_ITR | \
42 VIRTCHNL_VF_OFFLOAD_RX_POLLING)
44 #define IAVF_RSS_OFFLOAD_ALL ( \
46 ETH_RSS_NONFRAG_IPV4_TCP | \
47 ETH_RSS_NONFRAG_IPV4_UDP | \
48 ETH_RSS_NONFRAG_IPV4_SCTP | \
49 ETH_RSS_NONFRAG_IPV4_OTHER)
51 #define IAVF_MISC_VEC_ID RTE_INTR_VEC_ZERO_OFFSET
52 #define IAVF_RX_VEC_START RTE_INTR_VEC_RXTX_OFFSET
54 /* Default queue interrupt throttling time in microseconds */
55 #define IAVF_ITR_INDEX_DEFAULT 0
56 #define IAVF_QUEUE_ITR_INTERVAL_DEFAULT 32 /* 32 us */
57 #define IAVF_QUEUE_ITR_INTERVAL_MAX 8160 /* 8160 us */
59 /* The overhead from MTU to max frame size.
60 * Considering QinQ packet, the VLAN tag needs to be counted twice.
62 #define IAVF_VLAN_TAG_SIZE 4
63 #define IAVF_ETH_OVERHEAD \
64 (RTE_ETHER_HDR_LEN + RTE_ETHER_CRC_LEN + IAVF_VLAN_TAG_SIZE * 2)
66 #define IAVF_32_BIT_WIDTH (CHAR_BIT * 4)
67 #define IAVF_48_BIT_WIDTH (CHAR_BIT * 6)
68 #define IAVF_48_BIT_MASK RTE_LEN2MASK(IAVF_48_BIT_WIDTH, uint64_t)
74 /* Structure that defines a VSI, associated with a adapter. */
76 struct iavf_adapter *adapter; /* Backreference to associated adapter */
78 uint16_t nb_qps; /* Number of queue pairs VSI can occupy */
79 uint16_t nb_used_qps; /* Number of queue pairs VSI uses */
80 uint16_t max_macaddrs; /* Maximum number of MAC addresses */
82 uint16_t msix_intr; /* The MSIX interrupt binds to VSI */
83 struct virtchnl_eth_stats eth_stats_offset;
87 TAILQ_HEAD(iavf_flow_list, rte_flow);
89 struct iavf_flow_parser_node;
90 TAILQ_HEAD(iavf_parser_list, iavf_flow_parser_node);
92 /* TODO: is that correct to assume the max number to be 16 ?*/
93 #define IAVF_MAX_MSIX_VECTORS 16
95 /* Structure to store private data specific for VF instance. */
97 uint16_t num_queue_pairs;
98 uint16_t max_pkt_len; /* Maximum packet length */
99 uint16_t mac_num; /* Number of MAC addresses */
100 bool promisc_unicast_enabled;
101 bool promisc_multicast_enabled;
103 struct virtchnl_version_info virtchnl_version;
104 struct virtchnl_vf_resource *vf_res; /* VF resource */
105 struct virtchnl_vsi_resource *vsi_res; /* LAN VSI */
106 uint64_t supported_rxdid;
108 volatile enum virtchnl_ops pend_cmd; /* pending command not finished */
109 uint32_t cmd_retval; /* return value of the cmd response from PF */
110 uint8_t *aq_resp; /* buffer to store the adminq response from PF */
123 uint16_t nb_msix; /* number of MSI-X interrupts on Rx */
124 uint16_t msix_base; /* msix vector base from */
125 /* queue bitmask for each vector */
126 uint16_t rxq_map[IAVF_MAX_MSIX_VECTORS];
127 struct iavf_flow_list flow_list;
128 rte_spinlock_t flow_ops_lock;
129 struct iavf_parser_list rss_parser_list;
130 struct iavf_parser_list dist_parser_list;
133 #define IAVF_MAX_PKT_TYPE 1024
135 /* Structure to store private data for each VF instance. */
136 struct iavf_adapter {
138 struct rte_eth_dev *eth_dev;
141 bool rx_bulk_alloc_allowed;
145 const uint32_t *ptype_tbl;
149 /* IAVF_DEV_PRIVATE_TO */
150 #define IAVF_DEV_PRIVATE_TO_ADAPTER(adapter) \
151 ((struct iavf_adapter *)adapter)
152 #define IAVF_DEV_PRIVATE_TO_VF(adapter) \
153 (&((struct iavf_adapter *)adapter)->vf)
154 #define IAVF_DEV_PRIVATE_TO_HW(adapter) \
155 (&((struct iavf_adapter *)adapter)->hw)
158 #define IAVF_VSI_TO_HW(vsi) \
159 (&(((struct iavf_vsi *)vsi)->adapter->hw))
160 #define IAVF_VSI_TO_VF(vsi) \
161 (&(((struct iavf_vsi *)vsi)->adapter->vf))
162 #define IAVF_VSI_TO_ETH_DEV(vsi) \
163 (((struct iavf_vsi *)vsi)->adapter->eth_dev)
166 iavf_init_adminq_parameter(struct iavf_hw *hw)
168 hw->aq.num_arq_entries = IAVF_AQ_LEN;
169 hw->aq.num_asq_entries = IAVF_AQ_LEN;
170 hw->aq.arq_buf_size = IAVF_AQ_BUF_SZ;
171 hw->aq.asq_buf_size = IAVF_AQ_BUF_SZ;
174 static inline uint16_t
175 iavf_calc_itr_interval(int16_t interval)
177 if (interval < 0 || interval > IAVF_QUEUE_ITR_INTERVAL_MAX)
178 interval = IAVF_QUEUE_ITR_INTERVAL_DEFAULT;
180 /* Convert to hardware count, as writing each 1 represents 2 us */
184 /* structure used for sending and checking response of virtchnl ops */
185 struct iavf_cmd_info {
186 enum virtchnl_ops ops;
187 uint8_t *in_args; /* buffer for sending */
188 uint32_t in_args_size; /* buffer size for sending */
189 uint8_t *out_buffer; /* buffer for response */
190 uint32_t out_size; /* buffer size for response */
193 /* notify current command done. Only call in case execute
194 * _atomic_set_cmd successfully.
197 _notify_cmd(struct iavf_info *vf, uint32_t msg_ret)
199 vf->cmd_retval = msg_ret;
201 vf->pend_cmd = VIRTCHNL_OP_UNKNOWN;
204 /* clear current command. Only call in case execute
205 * _atomic_set_cmd successfully.
208 _clear_cmd(struct iavf_info *vf)
211 vf->pend_cmd = VIRTCHNL_OP_UNKNOWN;
212 vf->cmd_retval = VIRTCHNL_STATUS_SUCCESS;
215 /* Check there is pending cmd in execution. If none, set new command. */
217 _atomic_set_cmd(struct iavf_info *vf, enum virtchnl_ops ops)
219 int ret = rte_atomic32_cmpset(&vf->pend_cmd, VIRTCHNL_OP_UNKNOWN, ops);
222 PMD_DRV_LOG(ERR, "There is incomplete cmd %d", vf->pend_cmd);
227 int iavf_check_api_version(struct iavf_adapter *adapter);
228 int iavf_get_vf_resource(struct iavf_adapter *adapter);
229 void iavf_handle_virtchnl_msg(struct rte_eth_dev *dev);
230 int iavf_enable_vlan_strip(struct iavf_adapter *adapter);
231 int iavf_disable_vlan_strip(struct iavf_adapter *adapter);
232 int iavf_switch_queue(struct iavf_adapter *adapter, uint16_t qid,
234 int iavf_enable_queues(struct iavf_adapter *adapter);
235 int iavf_disable_queues(struct iavf_adapter *adapter);
236 int iavf_configure_rss_lut(struct iavf_adapter *adapter);
237 int iavf_configure_rss_key(struct iavf_adapter *adapter);
238 int iavf_configure_queues(struct iavf_adapter *adapter);
239 int iavf_get_supported_rxdid(struct iavf_adapter *adapter);
240 int iavf_config_irq_map(struct iavf_adapter *adapter);
241 void iavf_add_del_all_mac_addr(struct iavf_adapter *adapter, bool add);
242 int iavf_dev_link_update(struct rte_eth_dev *dev,
243 __rte_unused int wait_to_complete);
244 int iavf_query_stats(struct iavf_adapter *adapter,
245 struct virtchnl_eth_stats **pstats);
246 int iavf_config_promisc(struct iavf_adapter *adapter, bool enable_unicast,
247 bool enable_multicast);
248 int iavf_add_del_eth_addr(struct iavf_adapter *adapter,
249 struct rte_ether_addr *addr, bool add);
250 int iavf_add_del_vlan(struct iavf_adapter *adapter, uint16_t vlanid, bool add);
251 #endif /* _IAVF_ETHDEV_H_ */