1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation
5 #ifndef _IAVF_ETHDEV_H_
6 #define _IAVF_ETHDEV_H_
10 #include <rte_kvargs.h>
11 #include <rte_tm_driver.h>
13 #include <iavf_prototype.h>
14 #include <iavf_adminq_cmd.h>
15 #include <iavf_type.h>
19 #define IAVF_AQ_LEN 32
20 #define IAVF_AQ_BUF_SZ 4096
21 #define IAVF_RESET_WAIT_CNT 50
22 #define IAVF_BUF_SIZE_MIN 1024
23 #define IAVF_FRAME_SIZE_MAX 9728
24 #define IAVF_QUEUE_BASE_ADDR_UNIT 128
26 #define IAVF_MAX_NUM_QUEUES_DFLT 16
27 #define IAVF_MAX_NUM_QUEUES_LV 256
28 #define IAVF_CFG_Q_NUM_PER_BUF 32
29 #define IAVF_IRQ_MAP_NUM_PER_BUF 128
30 #define IAVF_RXTX_QUEUE_CHUNKS_NUM 2
32 #define IAVF_NUM_MACADDR_MAX 64
34 #define IAVF_DEFAULT_RX_PTHRESH 8
35 #define IAVF_DEFAULT_RX_HTHRESH 8
36 #define IAVF_DEFAULT_RX_WTHRESH 0
38 #define IAVF_DEFAULT_RX_FREE_THRESH 32
40 #define IAVF_DEFAULT_TX_PTHRESH 32
41 #define IAVF_DEFAULT_TX_HTHRESH 0
42 #define IAVF_DEFAULT_TX_WTHRESH 0
44 #define IAVF_DEFAULT_TX_FREE_THRESH 32
45 #define IAVF_DEFAULT_TX_RS_THRESH 32
47 #define IAVF_BASIC_OFFLOAD_CAPS ( \
48 VF_BASE_MODE_OFFLOADS | \
49 VIRTCHNL_VF_OFFLOAD_WB_ON_ITR | \
50 VIRTCHNL_VF_OFFLOAD_RX_POLLING)
52 #define IAVF_RSS_OFFLOAD_ALL ( \
54 RTE_ETH_RSS_FRAG_IPV4 | \
55 RTE_ETH_RSS_NONFRAG_IPV4_TCP | \
56 RTE_ETH_RSS_NONFRAG_IPV4_UDP | \
57 RTE_ETH_RSS_NONFRAG_IPV4_SCTP | \
58 RTE_ETH_RSS_NONFRAG_IPV4_OTHER | \
60 RTE_ETH_RSS_FRAG_IPV6 | \
61 RTE_ETH_RSS_NONFRAG_IPV6_TCP | \
62 RTE_ETH_RSS_NONFRAG_IPV6_UDP | \
63 RTE_ETH_RSS_NONFRAG_IPV6_SCTP | \
64 RTE_ETH_RSS_NONFRAG_IPV6_OTHER)
66 #define IAVF_MISC_VEC_ID RTE_INTR_VEC_ZERO_OFFSET
67 #define IAVF_RX_VEC_START RTE_INTR_VEC_RXTX_OFFSET
69 /* Default queue interrupt throttling time in microseconds */
70 #define IAVF_ITR_INDEX_DEFAULT 0
71 #define IAVF_QUEUE_ITR_INTERVAL_DEFAULT 32 /* 32 us */
72 #define IAVF_QUEUE_ITR_INTERVAL_MAX 8160 /* 8160 us */
74 #define IAVF_ALARM_INTERVAL 50000 /* us */
76 /* The overhead from MTU to max frame size.
77 * Considering QinQ packet, the VLAN tag needs to be counted twice.
79 #define IAVF_VLAN_TAG_SIZE 4
80 #define IAVF_ETH_OVERHEAD \
81 (RTE_ETHER_HDR_LEN + RTE_ETHER_CRC_LEN + IAVF_VLAN_TAG_SIZE * 2)
82 #define IAVF_ETH_MAX_LEN (RTE_ETHER_MTU + IAVF_ETH_OVERHEAD)
84 #define IAVF_32_BIT_WIDTH (CHAR_BIT * 4)
85 #define IAVF_48_BIT_WIDTH (CHAR_BIT * 6)
86 #define IAVF_48_BIT_MASK RTE_LEN2MASK(IAVF_48_BIT_WIDTH, uint64_t)
88 #define IAVF_RX_DESC_EXT_STATUS_FLEXBH_MASK 0x03
89 #define IAVF_RX_DESC_EXT_STATUS_FLEXBH_FD_ID 0x01
91 #define IAVF_BITS_PER_BYTE 8
93 #define IAVF_VLAN_TAG_PCP_OFFSET 13
100 struct iavf_ipsec_crypto_stats {
106 uint64_t not_processed;
108 uint64_t ipsec_length;
113 struct iavf_eth_xstats {
114 struct virtchnl_eth_stats eth_stats;
115 struct iavf_ipsec_crypto_stats ips_stats;
118 /* Structure that defines a VSI, associated with a adapter. */
120 struct iavf_adapter *adapter; /* Backreference to associated adapter */
122 uint16_t nb_qps; /* Number of queue pairs VSI can occupy */
123 uint16_t nb_used_qps; /* Number of queue pairs VSI uses */
124 uint16_t max_macaddrs; /* Maximum number of MAC addresses */
125 uint16_t base_vector;
126 uint16_t msix_intr; /* The MSIX interrupt binds to VSI */
127 struct iavf_eth_xstats eth_stats_offset;
131 TAILQ_HEAD(iavf_flow_list, rte_flow);
133 struct iavf_flow_parser_node;
134 TAILQ_HEAD(iavf_parser_list, iavf_flow_parser_node);
136 struct iavf_fdir_conf {
137 struct virtchnl_fdir_add add_fltr;
138 struct virtchnl_fdir_del del_fltr;
144 struct iavf_fdir_info {
145 struct iavf_fdir_conf conf;
153 /* Message type read in admin queue from PF */
154 enum iavf_aq_result {
155 IAVF_MSG_ERR = -1, /* Meet error when accessing admin queue */
156 IAVF_MSG_NON, /* Read nothing from admin queue */
157 IAVF_MSG_SYS, /* Read system msg from admin queue */
158 IAVF_MSG_CMD, /* Read async command result */
161 /* Struct to store Traffic Manager node configuration. */
162 struct iavf_tm_node {
163 TAILQ_ENTRY(iavf_tm_node) node;
168 uint32_t reference_count;
169 struct iavf_tm_node *parent;
170 struct rte_tm_node_params params;
173 TAILQ_HEAD(iavf_tm_node_list, iavf_tm_node);
175 /* node type of Traffic Manager */
176 enum iavf_tm_node_type {
177 IAVF_TM_NODE_TYPE_PORT,
178 IAVF_TM_NODE_TYPE_TC,
179 IAVF_TM_NODE_TYPE_QUEUE,
180 IAVF_TM_NODE_TYPE_MAX,
183 /* Struct to store all the Traffic Manager configuration. */
184 struct iavf_tm_conf {
185 struct iavf_tm_node *root; /* root node - vf vsi */
186 struct iavf_tm_node_list tc_list; /* node list for all the TCs */
187 struct iavf_tm_node_list queue_list; /* node list for all the queues */
189 uint32_t nb_queue_node;
193 /* Struct to store queue TC mapping. Queue is continuous in one TC */
194 struct iavf_qtc_map {
196 uint16_t start_queue_id;
197 uint16_t queue_count;
200 /* Structure to store private data specific for VF instance. */
202 uint16_t num_queue_pairs;
203 uint16_t max_pkt_len; /* Maximum packet length */
204 uint16_t mac_num; /* Number of MAC addresses */
205 bool promisc_unicast_enabled;
206 bool promisc_multicast_enabled;
208 struct virtchnl_version_info virtchnl_version;
209 struct virtchnl_vf_resource *vf_res; /* VF resource */
210 struct virtchnl_vsi_resource *vsi_res; /* LAN VSI */
211 struct virtchnl_vlan_caps vlan_v2_caps;
212 uint64_t supported_rxdid;
213 uint8_t *proto_xtr; /* proto xtr type for all queues */
214 volatile enum virtchnl_ops pend_cmd; /* pending command not finished */
215 uint32_t pend_cmd_count;
216 int cmd_retval; /* return value of the cmd response from PF */
217 uint8_t *aq_resp; /* buffer to store the adminq response from PF */
224 /* Multicast addrs */
225 struct rte_ether_addr mc_addrs[IAVF_NUM_MACADDR_MAX];
226 uint16_t mc_addrs_num; /* Multicast mac addresses number */
229 bool vf_reset; /* true for VF reset pending, false for no VF reset */
235 uint16_t nb_msix; /* number of MSI-X interrupts on Rx */
236 uint16_t msix_base; /* msix vector base from */
237 uint16_t max_rss_qregion; /* max RSS queue region supported by PF */
238 struct iavf_qv_map *qv_map; /* queue vector mapping */
239 struct iavf_flow_list flow_list;
240 rte_spinlock_t flow_ops_lock;
241 struct iavf_parser_list rss_parser_list;
242 struct iavf_parser_list dist_parser_list;
243 struct iavf_parser_list ipsec_crypto_parser_list;
245 struct iavf_fdir_info fdir; /* flow director info */
246 /* indicate large VF support enabled or not */
249 struct virtchnl_qos_cap_list *qos_cap;
250 struct iavf_qtc_map *qtc_map;
251 struct iavf_tm_conf tm_conf;
253 struct rte_eth_dev *eth_dev;
256 #define IAVF_MAX_PKT_TYPE 1024
258 #define IAVF_MAX_QUEUE_NUM 2048
260 enum iavf_proto_xtr_type {
265 IAVF_PROTO_XTR_IPV6_FLOW,
267 IAVF_PROTO_XTR_IP_OFFSET,
268 IAVF_PROTO_XTR_IPSEC_CRYPTO_SAID,
273 * Cache devargs parse result.
275 struct iavf_devargs {
276 uint8_t proto_xtr_dflt;
277 uint8_t proto_xtr[IAVF_MAX_QUEUE_NUM];
280 struct iavf_security_ctx;
282 /* Structure to store private data for each VF instance. */
283 struct iavf_adapter {
285 struct rte_eth_dev_data *dev_data;
287 struct iavf_security_ctx *security_ctx;
289 bool rx_bulk_alloc_allowed;
293 uint32_t ptype_tbl[IAVF_MAX_PKT_TYPE] __rte_cache_min_aligned;
295 uint16_t fdir_ref_cnt;
296 struct iavf_devargs devargs;
299 /* IAVF_DEV_PRIVATE_TO */
300 #define IAVF_DEV_PRIVATE_TO_ADAPTER(adapter) \
301 ((struct iavf_adapter *)adapter)
302 #define IAVF_DEV_PRIVATE_TO_VF(adapter) \
303 (&((struct iavf_adapter *)adapter)->vf)
304 #define IAVF_DEV_PRIVATE_TO_HW(adapter) \
305 (&((struct iavf_adapter *)adapter)->hw)
306 #define IAVF_DEV_PRIVATE_TO_IAVF_SECURITY_CTX(adapter) \
307 (((struct iavf_adapter *)adapter)->security_ctx)
310 #define IAVF_VSI_TO_HW(vsi) \
311 (&(((struct iavf_vsi *)vsi)->adapter->hw))
312 #define IAVF_VSI_TO_VF(vsi) \
313 (&(((struct iavf_vsi *)vsi)->adapter->vf))
316 iavf_init_adminq_parameter(struct iavf_hw *hw)
318 hw->aq.num_arq_entries = IAVF_AQ_LEN;
319 hw->aq.num_asq_entries = IAVF_AQ_LEN;
320 hw->aq.arq_buf_size = IAVF_AQ_BUF_SZ;
321 hw->aq.asq_buf_size = IAVF_AQ_BUF_SZ;
324 static inline uint16_t
325 iavf_calc_itr_interval(int16_t interval)
327 if (interval < 0 || interval > IAVF_QUEUE_ITR_INTERVAL_MAX)
328 interval = IAVF_QUEUE_ITR_INTERVAL_DEFAULT;
330 /* Convert to hardware count, as writing each 1 represents 2 us */
334 /* structure used for sending and checking response of virtchnl ops */
335 struct iavf_cmd_info {
336 enum virtchnl_ops ops;
337 uint8_t *in_args; /* buffer for sending */
338 uint32_t in_args_size; /* buffer size for sending */
339 uint8_t *out_buffer; /* buffer for response */
340 uint32_t out_size; /* buffer size for response */
343 /* notify current command done. Only call in case execute
344 * _atomic_set_cmd successfully.
347 _notify_cmd(struct iavf_info *vf, int msg_ret)
349 vf->cmd_retval = msg_ret;
351 vf->pend_cmd = VIRTCHNL_OP_UNKNOWN;
354 /* clear current command. Only call in case execute
355 * _atomic_set_cmd successfully.
358 _clear_cmd(struct iavf_info *vf)
361 vf->pend_cmd = VIRTCHNL_OP_UNKNOWN;
362 vf->cmd_retval = VIRTCHNL_STATUS_SUCCESS;
365 /* Check there is pending cmd in execution. If none, set new command. */
367 _atomic_set_cmd(struct iavf_info *vf, enum virtchnl_ops ops)
369 enum virtchnl_ops op_unk = VIRTCHNL_OP_UNKNOWN;
370 int ret = __atomic_compare_exchange(&vf->pend_cmd, &op_unk, &ops,
371 0, __ATOMIC_ACQUIRE, __ATOMIC_ACQUIRE);
374 PMD_DRV_LOG(ERR, "There is incomplete cmd %d", vf->pend_cmd);
376 __atomic_store_n(&vf->pend_cmd_count, 1, __ATOMIC_RELAXED);
381 /* Check there is pending cmd in execution. If none, set new command. */
383 _atomic_set_async_response_cmd(struct iavf_info *vf, enum virtchnl_ops ops)
385 enum virtchnl_ops op_unk = VIRTCHNL_OP_UNKNOWN;
386 int ret = __atomic_compare_exchange(&vf->pend_cmd, &op_unk, &ops,
387 0, __ATOMIC_ACQUIRE, __ATOMIC_ACQUIRE);
390 PMD_DRV_LOG(ERR, "There is incomplete cmd %d", vf->pend_cmd);
392 __atomic_store_n(&vf->pend_cmd_count, 2, __ATOMIC_RELAXED);
396 int iavf_check_api_version(struct iavf_adapter *adapter);
397 int iavf_get_vf_resource(struct iavf_adapter *adapter);
398 void iavf_handle_virtchnl_msg(struct rte_eth_dev *dev);
399 int iavf_enable_vlan_strip(struct iavf_adapter *adapter);
400 int iavf_disable_vlan_strip(struct iavf_adapter *adapter);
401 int iavf_switch_queue(struct iavf_adapter *adapter, uint16_t qid,
403 int iavf_switch_queue_lv(struct iavf_adapter *adapter, uint16_t qid,
405 int iavf_enable_queues(struct iavf_adapter *adapter);
406 int iavf_enable_queues_lv(struct iavf_adapter *adapter);
407 int iavf_disable_queues(struct iavf_adapter *adapter);
408 int iavf_disable_queues_lv(struct iavf_adapter *adapter);
409 int iavf_configure_rss_lut(struct iavf_adapter *adapter);
410 int iavf_configure_rss_key(struct iavf_adapter *adapter);
411 int iavf_configure_queues(struct iavf_adapter *adapter,
412 uint16_t num_queue_pairs, uint16_t index);
413 int iavf_get_supported_rxdid(struct iavf_adapter *adapter);
414 int iavf_config_vlan_strip_v2(struct iavf_adapter *adapter, bool enable);
415 int iavf_config_vlan_insert_v2(struct iavf_adapter *adapter, bool enable);
416 int iavf_add_del_vlan_v2(struct iavf_adapter *adapter, uint16_t vlanid,
418 int iavf_get_vlan_offload_caps_v2(struct iavf_adapter *adapter);
419 int iavf_config_irq_map(struct iavf_adapter *adapter);
420 int iavf_config_irq_map_lv(struct iavf_adapter *adapter, uint16_t num,
422 void iavf_add_del_all_mac_addr(struct iavf_adapter *adapter, bool add);
423 int iavf_dev_link_update(struct rte_eth_dev *dev,
424 __rte_unused int wait_to_complete);
425 void iavf_dev_alarm_handler(void *param);
426 int iavf_query_stats(struct iavf_adapter *adapter,
427 struct virtchnl_eth_stats **pstats);
428 int iavf_config_promisc(struct iavf_adapter *adapter, bool enable_unicast,
429 bool enable_multicast);
430 int iavf_add_del_eth_addr(struct iavf_adapter *adapter,
431 struct rte_ether_addr *addr, bool add, uint8_t type);
432 int iavf_add_del_vlan(struct iavf_adapter *adapter, uint16_t vlanid, bool add);
433 int iavf_fdir_add(struct iavf_adapter *adapter, struct iavf_fdir_conf *filter);
434 int iavf_fdir_del(struct iavf_adapter *adapter, struct iavf_fdir_conf *filter);
435 int iavf_fdir_check(struct iavf_adapter *adapter,
436 struct iavf_fdir_conf *filter);
437 int iavf_add_del_rss_cfg(struct iavf_adapter *adapter,
438 struct virtchnl_rss_cfg *rss_cfg, bool add);
439 int iavf_get_hena_caps(struct iavf_adapter *adapter, uint64_t *caps);
440 int iavf_set_hena(struct iavf_adapter *adapter, uint64_t hena);
441 int iavf_rss_hash_set(struct iavf_adapter *ad, uint64_t rss_hf, bool add);
442 int iavf_add_del_mc_addr_list(struct iavf_adapter *adapter,
443 struct rte_ether_addr *mc_addrs,
444 uint32_t mc_addrs_num, bool add);
445 int iavf_request_queues(struct rte_eth_dev *dev, uint16_t num);
446 int iavf_get_max_rss_queue_region(struct iavf_adapter *adapter);
447 int iavf_get_qos_cap(struct iavf_adapter *adapter);
448 int iavf_set_q_tc_map(struct rte_eth_dev *dev,
449 struct virtchnl_queue_tc_mapping *q_tc_mapping,
451 void iavf_tm_conf_init(struct rte_eth_dev *dev);
452 void iavf_tm_conf_uninit(struct rte_eth_dev *dev);
453 int iavf_ipsec_crypto_request(struct iavf_adapter *adapter,
454 uint8_t *msg, size_t msg_len,
455 uint8_t *resp_msg, size_t resp_msg_len);
456 extern const struct rte_tm_ops iavf_tm_ops;
457 #endif /* _IAVF_ETHDEV_H_ */