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 <rte_tm_driver.h>
11 #include <iavf_prototype.h>
12 #include <iavf_adminq_cmd.h>
13 #include <iavf_type.h>
17 #define IAVF_AQ_LEN 32
18 #define IAVF_AQ_BUF_SZ 4096
19 #define IAVF_RESET_WAIT_CNT 50
20 #define IAVF_BUF_SIZE_MIN 1024
21 #define IAVF_FRAME_SIZE_MAX 9728
22 #define IAVF_QUEUE_BASE_ADDR_UNIT 128
24 #define IAVF_MAX_NUM_QUEUES_DFLT 16
25 #define IAVF_MAX_NUM_QUEUES_LV 256
26 #define IAVF_CFG_Q_NUM_PER_BUF 32
27 #define IAVF_IRQ_MAP_NUM_PER_BUF 128
28 #define IAVF_RXTX_QUEUE_CHUNKS_NUM 2
30 #define IAVF_NUM_MACADDR_MAX 64
32 #define IAVF_DEFAULT_RX_PTHRESH 8
33 #define IAVF_DEFAULT_RX_HTHRESH 8
34 #define IAVF_DEFAULT_RX_WTHRESH 0
36 #define IAVF_DEFAULT_RX_FREE_THRESH 32
38 #define IAVF_DEFAULT_TX_PTHRESH 32
39 #define IAVF_DEFAULT_TX_HTHRESH 0
40 #define IAVF_DEFAULT_TX_WTHRESH 0
42 #define IAVF_DEFAULT_TX_FREE_THRESH 32
43 #define IAVF_DEFAULT_TX_RS_THRESH 32
45 #define IAVF_BASIC_OFFLOAD_CAPS ( \
46 VF_BASE_MODE_OFFLOADS | \
47 VIRTCHNL_VF_OFFLOAD_WB_ON_ITR | \
48 VIRTCHNL_VF_OFFLOAD_RX_POLLING)
50 #define IAVF_RSS_OFFLOAD_ALL ( \
53 ETH_RSS_NONFRAG_IPV4_TCP | \
54 ETH_RSS_NONFRAG_IPV4_UDP | \
55 ETH_RSS_NONFRAG_IPV4_SCTP | \
56 ETH_RSS_NONFRAG_IPV4_OTHER | \
59 ETH_RSS_NONFRAG_IPV6_TCP | \
60 ETH_RSS_NONFRAG_IPV6_UDP | \
61 ETH_RSS_NONFRAG_IPV6_SCTP | \
62 ETH_RSS_NONFRAG_IPV6_OTHER)
64 #define IAVF_MISC_VEC_ID RTE_INTR_VEC_ZERO_OFFSET
65 #define IAVF_RX_VEC_START RTE_INTR_VEC_RXTX_OFFSET
67 /* Default queue interrupt throttling time in microseconds */
68 #define IAVF_ITR_INDEX_DEFAULT 0
69 #define IAVF_QUEUE_ITR_INTERVAL_DEFAULT 32 /* 32 us */
70 #define IAVF_QUEUE_ITR_INTERVAL_MAX 8160 /* 8160 us */
72 #define IAVF_ALARM_INTERVAL 50000 /* us */
74 /* The overhead from MTU to max frame size.
75 * Considering QinQ packet, the VLAN tag needs to be counted twice.
77 #define IAVF_VLAN_TAG_SIZE 4
78 #define IAVF_ETH_OVERHEAD \
79 (RTE_ETHER_HDR_LEN + RTE_ETHER_CRC_LEN + IAVF_VLAN_TAG_SIZE * 2)
80 #define IAVF_ETH_MAX_LEN (RTE_ETHER_MTU + IAVF_ETH_OVERHEAD)
82 #define IAVF_32_BIT_WIDTH (CHAR_BIT * 4)
83 #define IAVF_48_BIT_WIDTH (CHAR_BIT * 6)
84 #define IAVF_48_BIT_MASK RTE_LEN2MASK(IAVF_48_BIT_WIDTH, uint64_t)
86 #define IAVF_RX_DESC_EXT_STATUS_FLEXBH_MASK 0x03
87 #define IAVF_RX_DESC_EXT_STATUS_FLEXBH_FD_ID 0x01
89 #define IAVF_BITS_PER_BYTE 8
91 #define IAVF_VLAN_TAG_PCP_OFFSET 13
97 /* Structure that defines a VSI, associated with a adapter. */
99 struct iavf_adapter *adapter; /* Backreference to associated adapter */
101 uint16_t nb_qps; /* Number of queue pairs VSI can occupy */
102 uint16_t nb_used_qps; /* Number of queue pairs VSI uses */
103 uint16_t max_macaddrs; /* Maximum number of MAC addresses */
104 uint16_t base_vector;
105 uint16_t msix_intr; /* The MSIX interrupt binds to VSI */
106 struct virtchnl_eth_stats eth_stats_offset;
110 TAILQ_HEAD(iavf_flow_list, rte_flow);
112 struct iavf_flow_parser_node;
113 TAILQ_HEAD(iavf_parser_list, iavf_flow_parser_node);
115 struct iavf_fdir_conf {
116 struct virtchnl_fdir_add add_fltr;
117 struct virtchnl_fdir_del del_fltr;
123 struct iavf_fdir_info {
124 struct iavf_fdir_conf conf;
132 /* Message type read in admin queue from PF */
133 enum iavf_aq_result {
134 IAVF_MSG_ERR = -1, /* Meet error when accessing admin queue */
135 IAVF_MSG_NON, /* Read nothing from admin queue */
136 IAVF_MSG_SYS, /* Read system msg from admin queue */
137 IAVF_MSG_CMD, /* Read async command result */
140 /* Struct to store Traffic Manager node configuration. */
141 struct iavf_tm_node {
142 TAILQ_ENTRY(iavf_tm_node) node;
147 uint32_t reference_count;
148 struct iavf_tm_node *parent;
149 struct rte_tm_node_params params;
152 TAILQ_HEAD(iavf_tm_node_list, iavf_tm_node);
154 /* node type of Traffic Manager */
155 enum iavf_tm_node_type {
156 IAVF_TM_NODE_TYPE_PORT,
157 IAVF_TM_NODE_TYPE_TC,
158 IAVF_TM_NODE_TYPE_QUEUE,
159 IAVF_TM_NODE_TYPE_MAX,
162 /* Struct to store all the Traffic Manager configuration. */
163 struct iavf_tm_conf {
164 struct iavf_tm_node *root; /* root node - vf vsi */
165 struct iavf_tm_node_list tc_list; /* node list for all the TCs */
166 struct iavf_tm_node_list queue_list; /* node list for all the queues */
168 uint32_t nb_queue_node;
172 /* Struct to store queue TC mapping. Queue is continuous in one TC */
173 struct iavf_qtc_map {
175 uint16_t start_queue_id;
176 uint16_t queue_count;
179 /* Structure to store private data specific for VF instance. */
181 uint16_t num_queue_pairs;
182 uint16_t max_pkt_len; /* Maximum packet length */
183 uint16_t mac_num; /* Number of MAC addresses */
184 bool promisc_unicast_enabled;
185 bool promisc_multicast_enabled;
187 struct virtchnl_version_info virtchnl_version;
188 struct virtchnl_vf_resource *vf_res; /* VF resource */
189 struct virtchnl_vsi_resource *vsi_res; /* LAN VSI */
190 struct virtchnl_vlan_caps vlan_v2_caps;
191 uint64_t supported_rxdid;
192 uint8_t *proto_xtr; /* proto xtr type for all queues */
193 volatile enum virtchnl_ops pend_cmd; /* pending command not finished */
194 int cmd_retval; /* return value of the cmd response from PF */
195 uint8_t *aq_resp; /* buffer to store the adminq response from PF */
202 /* Multicast addrs */
203 struct rte_ether_addr mc_addrs[IAVF_NUM_MACADDR_MAX];
204 uint16_t mc_addrs_num; /* Multicast mac addresses number */
207 bool vf_reset; /* true for VF reset pending, false for no VF reset */
213 uint16_t nb_msix; /* number of MSI-X interrupts on Rx */
214 uint16_t msix_base; /* msix vector base from */
215 uint16_t max_rss_qregion; /* max RSS queue region supported by PF */
216 struct iavf_qv_map *qv_map; /* queue vector mapping */
217 struct iavf_flow_list flow_list;
218 rte_spinlock_t flow_ops_lock;
219 struct iavf_parser_list rss_parser_list;
220 struct iavf_parser_list dist_parser_list;
222 struct iavf_fdir_info fdir; /* flow director info */
223 /* indicate large VF support enabled or not */
226 struct virtchnl_qos_cap_list *qos_cap;
227 struct iavf_qtc_map *qtc_map;
228 struct iavf_tm_conf tm_conf;
231 #define IAVF_MAX_PKT_TYPE 1024
233 #define IAVF_MAX_QUEUE_NUM 2048
235 enum iavf_proto_xtr_type {
240 IAVF_PROTO_XTR_IPV6_FLOW,
242 IAVF_PROTO_XTR_IP_OFFSET,
247 * Cache devargs parse result.
249 struct iavf_devargs {
250 uint8_t proto_xtr_dflt;
251 uint8_t proto_xtr[IAVF_MAX_QUEUE_NUM];
254 /* Structure to store private data for each VF instance. */
255 struct iavf_adapter {
257 struct rte_eth_dev *eth_dev;
260 bool rx_bulk_alloc_allowed;
264 const uint32_t *ptype_tbl;
266 uint16_t fdir_ref_cnt;
267 struct iavf_devargs devargs;
270 /* IAVF_DEV_PRIVATE_TO */
271 #define IAVF_DEV_PRIVATE_TO_ADAPTER(adapter) \
272 ((struct iavf_adapter *)adapter)
273 #define IAVF_DEV_PRIVATE_TO_VF(adapter) \
274 (&((struct iavf_adapter *)adapter)->vf)
275 #define IAVF_DEV_PRIVATE_TO_HW(adapter) \
276 (&((struct iavf_adapter *)adapter)->hw)
279 #define IAVF_VSI_TO_HW(vsi) \
280 (&(((struct iavf_vsi *)vsi)->adapter->hw))
281 #define IAVF_VSI_TO_VF(vsi) \
282 (&(((struct iavf_vsi *)vsi)->adapter->vf))
283 #define IAVF_VSI_TO_ETH_DEV(vsi) \
284 (((struct iavf_vsi *)vsi)->adapter->eth_dev)
287 iavf_init_adminq_parameter(struct iavf_hw *hw)
289 hw->aq.num_arq_entries = IAVF_AQ_LEN;
290 hw->aq.num_asq_entries = IAVF_AQ_LEN;
291 hw->aq.arq_buf_size = IAVF_AQ_BUF_SZ;
292 hw->aq.asq_buf_size = IAVF_AQ_BUF_SZ;
295 static inline uint16_t
296 iavf_calc_itr_interval(int16_t interval)
298 if (interval < 0 || interval > IAVF_QUEUE_ITR_INTERVAL_MAX)
299 interval = IAVF_QUEUE_ITR_INTERVAL_DEFAULT;
301 /* Convert to hardware count, as writing each 1 represents 2 us */
305 /* structure used for sending and checking response of virtchnl ops */
306 struct iavf_cmd_info {
307 enum virtchnl_ops ops;
308 uint8_t *in_args; /* buffer for sending */
309 uint32_t in_args_size; /* buffer size for sending */
310 uint8_t *out_buffer; /* buffer for response */
311 uint32_t out_size; /* buffer size for response */
314 /* notify current command done. Only call in case execute
315 * _atomic_set_cmd successfully.
318 _notify_cmd(struct iavf_info *vf, int msg_ret)
320 vf->cmd_retval = msg_ret;
322 vf->pend_cmd = VIRTCHNL_OP_UNKNOWN;
325 /* clear current command. Only call in case execute
326 * _atomic_set_cmd successfully.
329 _clear_cmd(struct iavf_info *vf)
332 vf->pend_cmd = VIRTCHNL_OP_UNKNOWN;
333 vf->cmd_retval = VIRTCHNL_STATUS_SUCCESS;
336 /* Check there is pending cmd in execution. If none, set new command. */
338 _atomic_set_cmd(struct iavf_info *vf, enum virtchnl_ops ops)
340 int ret = rte_atomic32_cmpset((volatile uint32_t *)&vf->pend_cmd,
341 VIRTCHNL_OP_UNKNOWN, ops);
344 PMD_DRV_LOG(ERR, "There is incomplete cmd %d", vf->pend_cmd);
349 int iavf_check_api_version(struct iavf_adapter *adapter);
350 int iavf_get_vf_resource(struct iavf_adapter *adapter);
351 void iavf_handle_virtchnl_msg(struct rte_eth_dev *dev);
352 int iavf_enable_vlan_strip(struct iavf_adapter *adapter);
353 int iavf_disable_vlan_strip(struct iavf_adapter *adapter);
354 int iavf_switch_queue(struct iavf_adapter *adapter, uint16_t qid,
356 int iavf_switch_queue_lv(struct iavf_adapter *adapter, uint16_t qid,
358 int iavf_enable_queues(struct iavf_adapter *adapter);
359 int iavf_enable_queues_lv(struct iavf_adapter *adapter);
360 int iavf_disable_queues(struct iavf_adapter *adapter);
361 int iavf_disable_queues_lv(struct iavf_adapter *adapter);
362 int iavf_configure_rss_lut(struct iavf_adapter *adapter);
363 int iavf_configure_rss_key(struct iavf_adapter *adapter);
364 int iavf_configure_queues(struct iavf_adapter *adapter,
365 uint16_t num_queue_pairs, uint16_t index);
366 int iavf_get_supported_rxdid(struct iavf_adapter *adapter);
367 int iavf_config_vlan_strip_v2(struct iavf_adapter *adapter, bool enable);
368 int iavf_config_vlan_insert_v2(struct iavf_adapter *adapter, bool enable);
369 int iavf_add_del_vlan_v2(struct iavf_adapter *adapter, uint16_t vlanid,
371 int iavf_get_vlan_offload_caps_v2(struct iavf_adapter *adapter);
372 int iavf_config_irq_map(struct iavf_adapter *adapter);
373 int iavf_config_irq_map_lv(struct iavf_adapter *adapter, uint16_t num,
375 void iavf_add_del_all_mac_addr(struct iavf_adapter *adapter, bool add);
376 int iavf_dev_link_update(struct rte_eth_dev *dev,
377 __rte_unused int wait_to_complete);
378 void iavf_dev_alarm_handler(void *param);
379 int iavf_query_stats(struct iavf_adapter *adapter,
380 struct virtchnl_eth_stats **pstats);
381 int iavf_config_promisc(struct iavf_adapter *adapter, bool enable_unicast,
382 bool enable_multicast);
383 int iavf_add_del_eth_addr(struct iavf_adapter *adapter,
384 struct rte_ether_addr *addr, bool add, uint8_t type);
385 int iavf_add_del_vlan(struct iavf_adapter *adapter, uint16_t vlanid, bool add);
386 int iavf_fdir_add(struct iavf_adapter *adapter, struct iavf_fdir_conf *filter);
387 int iavf_fdir_del(struct iavf_adapter *adapter, struct iavf_fdir_conf *filter);
388 int iavf_fdir_check(struct iavf_adapter *adapter,
389 struct iavf_fdir_conf *filter);
390 int iavf_add_del_rss_cfg(struct iavf_adapter *adapter,
391 struct virtchnl_rss_cfg *rss_cfg, bool add);
392 int iavf_get_hena_caps(struct iavf_adapter *adapter, uint64_t *caps);
393 int iavf_set_hena(struct iavf_adapter *adapter, uint64_t hena);
394 int iavf_rss_hash_set(struct iavf_adapter *ad, uint64_t rss_hf, bool add);
395 int iavf_add_del_mc_addr_list(struct iavf_adapter *adapter,
396 struct rte_ether_addr *mc_addrs,
397 uint32_t mc_addrs_num, bool add);
398 int iavf_request_queues(struct iavf_adapter *adapter, uint16_t num);
399 int iavf_get_max_rss_queue_region(struct iavf_adapter *adapter);
400 int iavf_get_qos_cap(struct iavf_adapter *adapter);
401 int iavf_set_q_tc_map(struct rte_eth_dev *dev,
402 struct virtchnl_queue_tc_mapping *q_tc_mapping,
404 void iavf_tm_conf_init(struct rte_eth_dev *dev);
405 void iavf_tm_conf_uninit(struct rte_eth_dev *dev);
406 extern const struct rte_tm_ops iavf_tm_ops;
407 #endif /* _IAVF_ETHDEV_H_ */