xref: /dpdk/drivers/net/mlx5/mlx5_defs.h (revision 42a8fc7daa46256d150278fc9a7a846e27945a0c)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2015 6WIND S.A.
3  * Copyright 2015 Mellanox Technologies, Ltd
4  */
5 
6 #ifndef RTE_PMD_MLX5_DEFS_H_
7 #define RTE_PMD_MLX5_DEFS_H_
8 
9 #include <ethdev_driver.h>
10 #include <rte_vxlan.h>
11 
12 #include <mlx5_common_defs.h>
13 
14 #include "mlx5_autoconf.h"
15 
16 /* Maximum number of simultaneous VLAN filters. */
17 #define MLX5_MAX_VLAN_IDS 128
18 
19 /*
20  * Request TX completion every time descriptors reach this threshold since
21  * the previous request. Must be a power of two for performance reasons.
22  */
23 #define MLX5_TX_COMP_THRESH 32u
24 
25 /*
26  * Request TX completion every time the total number of WQEBBs used for inlining
27  * packets exceeds the size of WQ divided by this divisor. Better to be power of
28  * two for performance.
29  */
30 #define MLX5_TX_COMP_THRESH_INLINE_DIV (1 << 3)
31 
32 /*
33  * Maximal amount of normal completion CQEs
34  * processed in one call of tx_burst() routine.
35  */
36 #define MLX5_TX_COMP_MAX_CQE 2u
37 
38 /*
39  * If defined, only use software counters. The PMD will never ask the hardware
40  * for these, and many of them won't be available.
41  */
42 #ifndef MLX5_PMD_SOFT_COUNTERS
43 #define MLX5_PMD_SOFT_COUNTERS 1
44 #endif
45 
46 /* Alarm timeout. */
47 #define MLX5_ALARM_TIMEOUT_US 100000
48 
49 /* Maximum number of extended statistics counters. */
50 #define MLX5_MAX_XSTATS 64
51 
52 /* Maximum Packet headers size (L2+L3+L4) for TSO. */
53 #define MLX5_MAX_TSO_HEADER 192U
54 
55 /* Inline data size required by NICs. */
56 #define MLX5_INLINE_HSIZE_NONE 0
57 #define MLX5_INLINE_HSIZE_L2 (sizeof(struct rte_ether_hdr) + \
58 			      sizeof(struct rte_vlan_hdr))
59 #define MLX5_INLINE_HSIZE_L3 (MLX5_INLINE_HSIZE_L2 + \
60 			      sizeof(struct rte_ipv6_hdr))
61 #define MLX5_INLINE_HSIZE_L4 (MLX5_INLINE_HSIZE_L3 + \
62 			      sizeof(struct rte_tcp_hdr))
63 #define MLX5_INLINE_HSIZE_INNER_L2 (MLX5_INLINE_HSIZE_L3 + \
64 				    sizeof(struct rte_udp_hdr) + \
65 				    sizeof(struct rte_vxlan_hdr) + \
66 				    sizeof(struct rte_ether_hdr) + \
67 				    sizeof(struct rte_vlan_hdr))
68 #define MLX5_INLINE_HSIZE_INNER_L3 (MLX5_INLINE_HSIZE_INNER_L2 + \
69 				    sizeof(struct rte_ipv6_hdr))
70 #define MLX5_INLINE_HSIZE_INNER_L4 (MLX5_INLINE_HSIZE_INNER_L3 + \
71 				    sizeof(struct rte_tcp_hdr))
72 
73 /* Threshold of buffer replenishment for vectorized Rx. */
74 #define MLX5_VPMD_RXQ_RPLNSH_THRESH(n) \
75 	(RTE_MIN(MLX5_VPMD_RX_MAX_BURST, (unsigned int)(n) >> 2))
76 
77 /* Maximum size of burst for vectorized Rx. */
78 #define MLX5_VPMD_RX_MAX_BURST 64U
79 
80 /* Recommended optimal burst size. */
81 #define MLX5_RX_DEFAULT_BURST 64U
82 #define MLX5_TX_DEFAULT_BURST 64U
83 
84 /* Number of packets vectorized Rx can simultaneously process in a loop. */
85 #define MLX5_VPMD_DESCS_PER_LOOP      4
86 
87 /* Mask of RSS on source only or destination only. */
88 #define MLX5_RSS_SRC_DST_ONLY (RTE_ETH_RSS_L3_SRC_ONLY | RTE_ETH_RSS_L3_DST_ONLY | \
89 			       RTE_ETH_RSS_L4_SRC_ONLY | RTE_ETH_RSS_L4_DST_ONLY)
90 
91 /* Supported RSS */
92 #define MLX5_RSS_HF_MASK (~(RTE_ETH_RSS_IP | RTE_ETH_RSS_UDP | RTE_ETH_RSS_TCP | \
93 			    MLX5_RSS_SRC_DST_ONLY | RTE_ETH_RSS_ESP))
94 
95 /* Timeout in seconds to get a valid link status. */
96 #define MLX5_LINK_STATUS_TIMEOUT 10
97 
98 /* Number of times to retry retrieving the physical link information. */
99 #define MLX5_GET_LINK_STATUS_RETRY_COUNT 3
100 
101 /* Maximum number of UAR pages used by a port,
102  * These are the size and mask for an array of mutexes used to synchronize
103  * the access to port's UARs on platforms that do not support 64 bit writes.
104  * In such systems it is possible to issue the 64 bits DoorBells through two
105  * consecutive writes, each write 32 bits. The access to a UAR page (which can
106  * be accessible by all threads in the process) must be synchronized
107  * (for example, using a semaphore). Such a synchronization is not required
108  * when ringing DoorBells on different UAR pages.
109  * A port with 512 Tx queues uses 8, 4kBytes, UAR pages which are shared
110  * among the ports.
111  */
112 #define MLX5_UAR_PAGE_NUM_MAX 64
113 #define MLX5_UAR_PAGE_NUM_MASK ((MLX5_UAR_PAGE_NUM_MAX) - 1)
114 
115 /* Log 2 of the default number of strides per WQE for Multi-Packet RQ. */
116 #define MLX5_MPRQ_DEFAULT_LOG_STRIDE_NUM 6U
117 
118 /* Log 2 of the default size of a stride per WQE for Multi-Packet RQ. */
119 #define MLX5_MPRQ_DEFAULT_LOG_STRIDE_SIZE 11U
120 
121 /* Two-byte shift is disabled for Multi-Packet RQ. */
122 #define MLX5_MPRQ_TWO_BYTE_SHIFT 0
123 
124 /*
125  * Minimum size of packet to be memcpy'd instead of being attached as an
126  * external buffer.
127  */
128 #define MLX5_MPRQ_MEMCPY_DEFAULT_LEN 128
129 
130 /* Minimum number Rx queues to enable Multi-Packet RQ. */
131 #define MLX5_MPRQ_MIN_RXQS 12
132 
133 /* Cache size of mempool for Multi-Packet RQ. */
134 #define MLX5_MPRQ_MP_CACHE_SZ 32U
135 
136 /* MLX5_DV_XMETA_EN supported values. */
137 #define MLX5_XMETA_MODE_LEGACY 0
138 #define MLX5_XMETA_MODE_META16 1
139 #define MLX5_XMETA_MODE_META32 2
140 /* Provide info on patrial hw miss. Implies MLX5_XMETA_MODE_META16 */
141 #define MLX5_XMETA_MODE_MISS_INFO 3
142 
143 /* Tx accurate scheduling on timestamps parameters. */
144 #define MLX5_TXPP_WAIT_INIT_TS 1000ul /* How long to wait timestamp. */
145 #define MLX5_TXPP_CLKQ_SIZE 1
146 #define MLX5_TXPP_REARM	((1UL << MLX5_WQ_INDEX_WIDTH) / 4)
147 #define MLX5_TXPP_REARM_SQ_SIZE (((1UL << MLX5_CQ_INDEX_WIDTH) / \
148 				  MLX5_TXPP_REARM) * 2)
149 #define MLX5_TXPP_REARM_CQ_SIZE (MLX5_TXPP_REARM_SQ_SIZE / 2)
150 /* The minimal size test packet to put into one WQE, padded by HW. */
151 #define MLX5_TXPP_TEST_PKT_SIZE (sizeof(struct rte_ether_hdr) +	\
152 				 sizeof(struct rte_ipv4_hdr))
153 
154 /* Size of the simple hash table for metadata register table. */
155 #define MLX5_FLOW_MREG_HTABLE_SZ 64
156 #define MLX5_FLOW_MREG_HNAME "MARK_COPY_TABLE"
157 #define MLX5_DEFAULT_COPY_ID UINT32_MAX
158 
159 /* Size of the simple hash table for header modify table. */
160 #define MLX5_FLOW_HDR_MODIFY_HTABLE_SZ (1 << 15)
161 
162 /* Size of the simple hash table for encap decap table. */
163 #define MLX5_FLOW_ENCAP_DECAP_HTABLE_SZ (1 << 12)
164 
165 /* Size of the hash table for tag table. */
166 #define MLX5_TAGS_HLIST_ARRAY_SIZE	(1 << 15)
167 
168 /* Size fo the hash table for SFT table. */
169 #define MLX5_FLOW_SFT_HLIST_ARRAY_SIZE	4096
170 
171 /* Hairpin TX/RX queue configuration parameters. */
172 #define MLX5_HAIRPIN_QUEUE_STRIDE 6
173 #define MLX5_HAIRPIN_JUMBO_LOG_SIZE (14 + 2)
174 
175 /* Maximum number of indirect actions supported by rte_flow */
176 #define MLX5_MAX_INDIRECT_ACTIONS 3
177 
178 /* Maximum number of external Rx queues supported by rte_flow */
179 #define MLX5_MAX_EXT_RX_QUEUES (UINT16_MAX - MLX5_EXTERNAL_RX_QUEUE_ID_MIN + 1)
180 
181 /*
182  * Linux definition of static_assert is found in /usr/include/assert.h.
183  * Windows does not require a redefinition.
184  */
185 #if !defined(HAVE_STATIC_ASSERT) && !defined(RTE_EXEC_ENV_WINDOWS)
186 #define static_assert _Static_assert
187 #endif
188 
189 #endif /* RTE_PMD_MLX5_DEFS_H_ */
190