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 /* The overhead from MTU to max frame size.
73 * Considering QinQ packet, the VLAN tag needs to be counted twice.
75 #define IAVF_VLAN_TAG_SIZE 4
76 #define IAVF_ETH_OVERHEAD \
77 (RTE_ETHER_HDR_LEN + RTE_ETHER_CRC_LEN + IAVF_VLAN_TAG_SIZE * 2)
78 #define IAVF_ETH_MAX_LEN (RTE_ETHER_MTU + IAVF_ETH_OVERHEAD)
80 #define IAVF_32_BIT_WIDTH (CHAR_BIT * 4)
81 #define IAVF_48_BIT_WIDTH (CHAR_BIT * 6)
82 #define IAVF_48_BIT_MASK RTE_LEN2MASK(IAVF_48_BIT_WIDTH, uint64_t)
84 #define IAVF_RX_DESC_EXT_STATUS_FLEXBH_MASK 0x03
85 #define IAVF_RX_DESC_EXT_STATUS_FLEXBH_FD_ID 0x01
87 #define IAVF_BITS_PER_BYTE 8
89 #define IAVF_VLAN_TAG_PCP_OFFSET 13
95 /* Structure that defines a VSI, associated with a adapter. */
97 struct iavf_adapter *adapter; /* Backreference to associated adapter */
99 uint16_t nb_qps; /* Number of queue pairs VSI can occupy */
100 uint16_t nb_used_qps; /* Number of queue pairs VSI uses */
101 uint16_t max_macaddrs; /* Maximum number of MAC addresses */
102 uint16_t base_vector;
103 uint16_t msix_intr; /* The MSIX interrupt binds to VSI */
104 struct virtchnl_eth_stats eth_stats_offset;
108 TAILQ_HEAD(iavf_flow_list, rte_flow);
110 struct iavf_flow_parser_node;
111 TAILQ_HEAD(iavf_parser_list, iavf_flow_parser_node);
113 struct iavf_fdir_conf {
114 struct virtchnl_fdir_add add_fltr;
115 struct virtchnl_fdir_del del_fltr;
121 struct iavf_fdir_info {
122 struct iavf_fdir_conf conf;
130 /* Message type read in admin queue from PF */
131 enum iavf_aq_result {
132 IAVF_MSG_ERR = -1, /* Meet error when accessing admin queue */
133 IAVF_MSG_NON, /* Read nothing from admin queue */
134 IAVF_MSG_SYS, /* Read system msg from admin queue */
135 IAVF_MSG_CMD, /* Read async command result */
138 /* Struct to store Traffic Manager node configuration. */
139 struct iavf_tm_node {
140 TAILQ_ENTRY(iavf_tm_node) node;
145 uint32_t reference_count;
146 struct iavf_tm_node *parent;
147 struct rte_tm_node_params params;
150 TAILQ_HEAD(iavf_tm_node_list, iavf_tm_node);
152 /* node type of Traffic Manager */
153 enum iavf_tm_node_type {
154 IAVF_TM_NODE_TYPE_PORT,
155 IAVF_TM_NODE_TYPE_TC,
156 IAVF_TM_NODE_TYPE_QUEUE,
157 IAVF_TM_NODE_TYPE_MAX,
160 /* Struct to store all the Traffic Manager configuration. */
161 struct iavf_tm_conf {
162 struct iavf_tm_node *root; /* root node - vf vsi */
163 struct iavf_tm_node_list tc_list; /* node list for all the TCs */
164 struct iavf_tm_node_list queue_list; /* node list for all the queues */
166 uint32_t nb_queue_node;
170 /* Struct to store queue TC mapping. Queue is continuous in one TC */
171 struct iavf_qtc_map {
173 uint16_t start_queue_id;
174 uint16_t queue_count;
177 /* Structure to store private data specific for VF instance. */
179 uint16_t num_queue_pairs;
180 uint16_t max_pkt_len; /* Maximum packet length */
181 uint16_t mac_num; /* Number of MAC addresses */
182 bool promisc_unicast_enabled;
183 bool promisc_multicast_enabled;
185 struct virtchnl_version_info virtchnl_version;
186 struct virtchnl_vf_resource *vf_res; /* VF resource */
187 struct virtchnl_vsi_resource *vsi_res; /* LAN VSI */
188 struct virtchnl_vlan_caps vlan_v2_caps;
189 uint64_t supported_rxdid;
190 uint8_t *proto_xtr; /* proto xtr type for all queues */
191 volatile enum virtchnl_ops pend_cmd; /* pending command not finished */
192 int cmd_retval; /* return value of the cmd response from PF */
193 uint8_t *aq_resp; /* buffer to store the adminq response from PF */
200 /* Multicast addrs */
201 struct rte_ether_addr mc_addrs[IAVF_NUM_MACADDR_MAX];
202 uint16_t mc_addrs_num; /* Multicast mac addresses number */
205 bool vf_reset; /* true for VF reset pending, false for no VF reset */
211 uint16_t nb_msix; /* number of MSI-X interrupts on Rx */
212 uint16_t msix_base; /* msix vector base from */
213 uint16_t max_rss_qregion; /* max RSS queue region supported by PF */
214 struct iavf_qv_map *qv_map; /* queue vector mapping */
215 struct iavf_flow_list flow_list;
216 rte_spinlock_t flow_ops_lock;
217 struct iavf_parser_list rss_parser_list;
218 struct iavf_parser_list dist_parser_list;
220 struct iavf_fdir_info fdir; /* flow director info */
221 /* indicate large VF support enabled or not */
224 struct virtchnl_qos_cap_list *qos_cap;
225 struct iavf_qtc_map *qtc_map;
226 struct iavf_tm_conf tm_conf;
229 #define IAVF_MAX_PKT_TYPE 1024
231 #define IAVF_MAX_QUEUE_NUM 2048
233 enum iavf_proto_xtr_type {
238 IAVF_PROTO_XTR_IPV6_FLOW,
240 IAVF_PROTO_XTR_IP_OFFSET,
245 * Cache devargs parse result.
247 struct iavf_devargs {
248 uint8_t proto_xtr_dflt;
249 uint8_t proto_xtr[IAVF_MAX_QUEUE_NUM];
252 /* Structure to store private data for each VF instance. */
253 struct iavf_adapter {
255 struct rte_eth_dev *eth_dev;
258 bool rx_bulk_alloc_allowed;
262 const uint32_t *ptype_tbl;
264 uint16_t fdir_ref_cnt;
265 struct iavf_devargs devargs;
268 /* IAVF_DEV_PRIVATE_TO */
269 #define IAVF_DEV_PRIVATE_TO_ADAPTER(adapter) \
270 ((struct iavf_adapter *)adapter)
271 #define IAVF_DEV_PRIVATE_TO_VF(adapter) \
272 (&((struct iavf_adapter *)adapter)->vf)
273 #define IAVF_DEV_PRIVATE_TO_HW(adapter) \
274 (&((struct iavf_adapter *)adapter)->hw)
277 #define IAVF_VSI_TO_HW(vsi) \
278 (&(((struct iavf_vsi *)vsi)->adapter->hw))
279 #define IAVF_VSI_TO_VF(vsi) \
280 (&(((struct iavf_vsi *)vsi)->adapter->vf))
281 #define IAVF_VSI_TO_ETH_DEV(vsi) \
282 (((struct iavf_vsi *)vsi)->adapter->eth_dev)
285 iavf_init_adminq_parameter(struct iavf_hw *hw)
287 hw->aq.num_arq_entries = IAVF_AQ_LEN;
288 hw->aq.num_asq_entries = IAVF_AQ_LEN;
289 hw->aq.arq_buf_size = IAVF_AQ_BUF_SZ;
290 hw->aq.asq_buf_size = IAVF_AQ_BUF_SZ;
293 static inline uint16_t
294 iavf_calc_itr_interval(int16_t interval)
296 if (interval < 0 || interval > IAVF_QUEUE_ITR_INTERVAL_MAX)
297 interval = IAVF_QUEUE_ITR_INTERVAL_DEFAULT;
299 /* Convert to hardware count, as writing each 1 represents 2 us */
303 /* structure used for sending and checking response of virtchnl ops */
304 struct iavf_cmd_info {
305 enum virtchnl_ops ops;
306 uint8_t *in_args; /* buffer for sending */
307 uint32_t in_args_size; /* buffer size for sending */
308 uint8_t *out_buffer; /* buffer for response */
309 uint32_t out_size; /* buffer size for response */
312 /* notify current command done. Only call in case execute
313 * _atomic_set_cmd successfully.
316 _notify_cmd(struct iavf_info *vf, int msg_ret)
318 vf->cmd_retval = msg_ret;
320 vf->pend_cmd = VIRTCHNL_OP_UNKNOWN;
323 /* clear current command. Only call in case execute
324 * _atomic_set_cmd successfully.
327 _clear_cmd(struct iavf_info *vf)
330 vf->pend_cmd = VIRTCHNL_OP_UNKNOWN;
331 vf->cmd_retval = VIRTCHNL_STATUS_SUCCESS;
334 /* Check there is pending cmd in execution. If none, set new command. */
336 _atomic_set_cmd(struct iavf_info *vf, enum virtchnl_ops ops)
338 int ret = rte_atomic32_cmpset(&vf->pend_cmd, VIRTCHNL_OP_UNKNOWN, ops);
341 PMD_DRV_LOG(ERR, "There is incomplete cmd %d", vf->pend_cmd);
346 int iavf_check_api_version(struct iavf_adapter *adapter);
347 int iavf_get_vf_resource(struct iavf_adapter *adapter);
348 void iavf_handle_virtchnl_msg(struct rte_eth_dev *dev);
349 int iavf_enable_vlan_strip(struct iavf_adapter *adapter);
350 int iavf_disable_vlan_strip(struct iavf_adapter *adapter);
351 int iavf_switch_queue(struct iavf_adapter *adapter, uint16_t qid,
353 int iavf_switch_queue_lv(struct iavf_adapter *adapter, uint16_t qid,
355 int iavf_enable_queues(struct iavf_adapter *adapter);
356 int iavf_enable_queues_lv(struct iavf_adapter *adapter);
357 int iavf_disable_queues(struct iavf_adapter *adapter);
358 int iavf_disable_queues_lv(struct iavf_adapter *adapter);
359 int iavf_configure_rss_lut(struct iavf_adapter *adapter);
360 int iavf_configure_rss_key(struct iavf_adapter *adapter);
361 int iavf_configure_queues(struct iavf_adapter *adapter,
362 uint16_t num_queue_pairs, uint16_t index);
363 int iavf_get_supported_rxdid(struct iavf_adapter *adapter);
364 int iavf_config_vlan_strip_v2(struct iavf_adapter *adapter, bool enable);
365 int iavf_config_vlan_insert_v2(struct iavf_adapter *adapter, bool enable);
366 int iavf_add_del_vlan_v2(struct iavf_adapter *adapter, uint16_t vlanid,
368 int iavf_get_vlan_offload_caps_v2(struct iavf_adapter *adapter);
369 int iavf_config_irq_map(struct iavf_adapter *adapter);
370 int iavf_config_irq_map_lv(struct iavf_adapter *adapter, uint16_t num,
372 void iavf_add_del_all_mac_addr(struct iavf_adapter *adapter, bool add);
373 int iavf_dev_link_update(struct rte_eth_dev *dev,
374 __rte_unused int wait_to_complete);
375 int iavf_query_stats(struct iavf_adapter *adapter,
376 struct virtchnl_eth_stats **pstats);
377 int iavf_config_promisc(struct iavf_adapter *adapter, bool enable_unicast,
378 bool enable_multicast);
379 int iavf_add_del_eth_addr(struct iavf_adapter *adapter,
380 struct rte_ether_addr *addr, bool add, uint8_t type);
381 int iavf_add_del_vlan(struct iavf_adapter *adapter, uint16_t vlanid, bool add);
382 int iavf_fdir_add(struct iavf_adapter *adapter, struct iavf_fdir_conf *filter);
383 int iavf_fdir_del(struct iavf_adapter *adapter, struct iavf_fdir_conf *filter);
384 int iavf_fdir_check(struct iavf_adapter *adapter,
385 struct iavf_fdir_conf *filter);
386 int iavf_add_del_rss_cfg(struct iavf_adapter *adapter,
387 struct virtchnl_rss_cfg *rss_cfg, bool add);
388 int iavf_get_hena_caps(struct iavf_adapter *adapter, uint64_t *caps);
389 int iavf_set_hena(struct iavf_adapter *adapter, uint64_t hena);
390 int iavf_rss_hash_set(struct iavf_adapter *ad, uint64_t rss_hf, bool add);
391 int iavf_add_del_mc_addr_list(struct iavf_adapter *adapter,
392 struct rte_ether_addr *mc_addrs,
393 uint32_t mc_addrs_num, bool add);
394 int iavf_request_queues(struct iavf_adapter *adapter, uint16_t num);
395 int iavf_get_max_rss_queue_region(struct iavf_adapter *adapter);
396 int iavf_get_qos_cap(struct iavf_adapter *adapter);
397 int iavf_set_q_tc_map(struct rte_eth_dev *dev,
398 struct virtchnl_queue_tc_mapping *q_tc_mapping,
400 void iavf_tm_conf_init(struct rte_eth_dev *dev);
401 void iavf_tm_conf_uninit(struct rte_eth_dev *dev);
402 extern const struct rte_tm_ops iavf_tm_ops;
403 #endif /* _IAVF_ETHDEV_H_ */