a76bc6f65503356bd125acb647db1c0171c79bfd
[deb_dpdk.git] / drivers / net / mlx5 / mlx5_defs.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright 2015 6WIND S.A.
5  *   Copyright 2015 Mellanox.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of 6WIND S.A. nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #ifndef RTE_PMD_MLX5_DEFS_H_
35 #define RTE_PMD_MLX5_DEFS_H_
36
37 #include "mlx5_autoconf.h"
38
39 /* Reported driver name. */
40 #define MLX5_DRIVER_NAME "net_mlx5"
41
42 /* Maximum number of simultaneous MAC addresses. */
43 #define MLX5_MAX_MAC_ADDRESSES 128
44
45 /* Maximum number of simultaneous VLAN filters. */
46 #define MLX5_MAX_VLAN_IDS 128
47
48 /* Maximum number of special flows. */
49 #define MLX5_MAX_SPECIAL_FLOWS 4
50
51 /*
52  * Request TX completion every time descriptors reach this threshold since
53  * the previous request. Must be a power of two for performance reasons.
54  */
55 #define MLX5_TX_COMP_THRESH 32
56
57 /*
58  * Request TX completion every time the total number of WQEBBs used for inlining
59  * packets exceeds the size of WQ divided by this divisor. Better to be power of
60  * two for performance.
61  */
62 #define MLX5_TX_COMP_THRESH_INLINE_DIV (1 << 3)
63
64 /*
65  * Maximum number of cached Memory Pools (MPs) per TX queue. Each RTE MP
66  * from which buffers are to be transmitted will have to be mapped by this
67  * driver to their own Memory Region (MR). This is a slow operation.
68  *
69  * This value is always 1 for RX queues.
70  */
71 #ifndef MLX5_PMD_TX_MP_CACHE
72 #define MLX5_PMD_TX_MP_CACHE 8
73 #endif
74
75 /*
76  * If defined, only use software counters. The PMD will never ask the hardware
77  * for these, and many of them won't be available.
78  */
79 #ifndef MLX5_PMD_SOFT_COUNTERS
80 #define MLX5_PMD_SOFT_COUNTERS 1
81 #endif
82
83 /* Alarm timeout. */
84 #define MLX5_ALARM_TIMEOUT_US 100000
85
86 /* Maximum number of extended statistics counters. */
87 #define MLX5_MAX_XSTATS 32
88
89 /* Maximum Packet headers size (L2+L3+L4) for TSO. */
90 #define MLX5_MAX_TSO_HEADER 128
91
92 /* Default minimum number of Tx queues for vectorized Tx. */
93 #define MLX5_VPMD_MIN_TXQS 4
94
95 /* Threshold of buffer replenishment for vectorized Rx. */
96 #define MLX5_VPMD_RXQ_RPLNSH_THRESH   64U
97
98 /* Maximum size of burst for vectorized Rx. */
99 #define MLX5_VPMD_RX_MAX_BURST        MLX5_VPMD_RXQ_RPLNSH_THRESH
100
101 /*
102  * Maximum size of burst for vectorized Tx. This is related to the maximum size
103  * of Enhaned MPW (eMPW) WQE as vectorized Tx is supported with eMPW.
104  */
105 #define MLX5_VPMD_TX_MAX_BURST        32U
106
107 /* Number of packets vectorized Rx can simultaneously process in a loop. */
108 #define MLX5_VPMD_DESCS_PER_LOOP      4
109
110 #endif /* RTE_PMD_MLX5_DEFS_H_ */