lib/librte_pmd_mlx4/mlx4.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright 2012-2015 6WIND S.A.
   5  *   Copyright 2012 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_MLX4_H_
  35 #define RTE_PMD_MLX4_H_
  36
  37 #include <stddef.h>
  38 #include <stdint.h>
  39 #include <limits.h>
  40
  41 /*
  42  * Maximum number of simultaneous MAC addresses supported.
  43  *
  44  * According to ConnectX's Programmer Reference Manual:
  45  *   The L2 Address Match is implemented by comparing a MAC/VLAN combination
  46  *   of 128 MAC addresses and 127 VLAN values, comprising 128x127 possible
  47  *   L2 addresses.
  48  */
  49 #define MLX4_MAX_MAC_ADDRESSES 128
  50
  51 /* Maximum number of simultaneous VLAN filters supported. See above. */
  52 #define MLX4_MAX_VLAN_IDS 127
  53
  54 /* Maximum number of Scatter/Gather Elements per Work Request. */
  55 #ifndef MLX4_PMD_SGE_WR_N
  56 #define MLX4_PMD_SGE_WR_N 4
  57 #endif
  58
  59 /* Maximum size for inline data. */
  60 #ifndef MLX4_PMD_MAX_INLINE
  61 #define MLX4_PMD_MAX_INLINE 0
  62 #endif
  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 MLX4_PMD_TX_MP_CACHE
  72 #define MLX4_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 MLX4_PMD_SOFT_COUNTERS
  80 #define MLX4_PMD_SOFT_COUNTERS 1
  81 #endif
  82
  83 /*
  84  * If defined, enable VMware compatibility code. It also requires the
  85  * environment variable MLX4_COMPAT_VMWARE set to a nonzero value at runtime.
  86  */
  87 #ifndef MLX4_COMPAT_VMWARE
  88 #define MLX4_COMPAT_VMWARE 1
  89 #endif
  90
  91 enum {
  92         PCI_VENDOR_ID_MELLANOX = 0x15b3,
  93 };
  94
  95 enum {
  96         PCI_DEVICE_ID_MELLANOX_CONNECTX3 = 0x1003,
  97         PCI_DEVICE_ID_MELLANOX_CONNECTX3VF = 0x1004,
  98         PCI_DEVICE_ID_MELLANOX_CONNECTX3PRO = 0x1007,
  99 };
 100
 101 #define MLX4_DRIVER_NAME "librte_pmd_mlx4"
 102
 103 /* Bit-field manipulation. */
 104 #define BITFIELD_DECLARE(bf, type, size)                                \
 105         type bf[(((size_t)(size) / (sizeof(type) * CHAR_BIT)) +         \
 106                  !!((size_t)(size) % (sizeof(type) * CHAR_BIT)))]
 107 #define BITFIELD_DEFINE(bf, type, size)                                 \
 108         BITFIELD_DECLARE((bf), type, (size)) = { 0 }
 109 #define BITFIELD_SET(bf, b)                                             \
 110         (assert((size_t)(b) < (sizeof(bf) * CHAR_BIT)),                 \
 111          (void)((bf)[((b) / (sizeof((bf)[0]) * CHAR_BIT))] |=           \
 112                 ((size_t)1 << ((b) % (sizeof((bf)[0]) * CHAR_BIT)))))
 113 #define BITFIELD_RESET(bf, b)                                           \
 114         (assert((size_t)(b) < (sizeof(bf) * CHAR_BIT)),                 \
 115          (void)((bf)[((b) / (sizeof((bf)[0]) * CHAR_BIT))] &=           \
 116                 ~((size_t)1 << ((b) % (sizeof((bf)[0]) * CHAR_BIT)))))
 117 #define BITFIELD_ISSET(bf, b)                                           \
 118         (assert((size_t)(b) < (sizeof(bf) * CHAR_BIT)),                 \
 119          !!(((bf)[((b) / (sizeof((bf)[0]) * CHAR_BIT))] &               \
 120              ((size_t)1 << ((b) % (sizeof((bf)[0]) * CHAR_BIT))))))
 121
 122 /* Number of elements in array. */
 123 #define elemof(a) (sizeof(a) / sizeof((a)[0]))
 124
 125 /* Cast pointer p to structure member m to its parent structure of type t. */
 126 #define containerof(p, t, m) ((t *)((uint8_t *)(p) - offsetof(t, m)))
 127
 128 /* Branch prediction helpers. */
 129 #ifndef likely
 130 #define likely(c) __builtin_expect(!!(c), 1)
 131 #endif
 132 #ifndef unlikely
 133 #define unlikely(c) __builtin_expect(!!(c), 0)
 134 #endif
 135
 136 /* Debugging */
 137 #ifndef NDEBUG
 138 #include <stdio.h>
 139 #define DEBUG__(m, ...)                                         \
 140         (fprintf(stderr, "%s:%d: %s(): " m "%c",                \
 141                  __FILE__, __LINE__, __func__, __VA_ARGS__),    \
 142          fflush(stderr),                                        \
 143          (void)0)
 144 /*
 145  * Save/restore errno around DEBUG__().
 146  * XXX somewhat undefined behavior, but works.
 147  */
 148 #define DEBUG_(...)                             \
 149         (errno = ((int []){                     \
 150                 *(volatile int *)&errno,        \
 151                 (DEBUG__(__VA_ARGS__), 0)       \
 152         })[0])
 153 #define DEBUG(...) DEBUG_(__VA_ARGS__, '\n')
 154 #define claim_zero(...) assert((__VA_ARGS__) == 0)
 155 #define claim_nonzero(...) assert((__VA_ARGS__) != 0)
 156 #define claim_positive(...) assert((__VA_ARGS__) >= 0)
 157 #else /* NDEBUG */
 158 /* No-ops. */
 159 #define DEBUG(...) (void)0
 160 #define claim_zero(...) (__VA_ARGS__)
 161 #define claim_nonzero(...) (__VA_ARGS__)
 162 #define claim_positive(...) (__VA_ARGS__)
 163 #endif /* NDEBUG */
 164
 165 #endif /* RTE_PMD_MLX4_H_ */