drivers/net/mlx4/mlx4_prm.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright 2017 6WIND S.A.
   5  *   Copyright 2017 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 MLX4_PRM_H_
  35 #define MLX4_PRM_H_
  36
  37 #include <rte_atomic.h>
  38 #include <rte_branch_prediction.h>
  39 #include <rte_byteorder.h>
  40
  41 /* Verbs headers do not support -pedantic. */
  42 #ifdef PEDANTIC
  43 #pragma GCC diagnostic ignored "-Wpedantic"
  44 #endif
  45 #include <infiniband/mlx4dv.h>
  46 #include <infiniband/verbs.h>
  47 #ifdef PEDANTIC
  48 #pragma GCC diagnostic error "-Wpedantic"
  49 #endif
  50
  51 /* ConnectX-3 Tx queue basic block. */
  52 #define MLX4_TXBB_SHIFT 6
  53 #define MLX4_TXBB_SIZE (1 << MLX4_TXBB_SHIFT)
  54
  55 /* Typical TSO descriptor with 16 gather entries is 352 bytes. */
  56 #define MLX4_MAX_WQE_SIZE 512
  57 #define MLX4_SEG_SHIFT 4
  58
  59 /* Send queue stamping/invalidating information. */
  60 #define MLX4_SQ_STAMP_STRIDE 64
  61 #define MLX4_SQ_STAMP_DWORDS (MLX4_SQ_STAMP_STRIDE / 4)
  62 #define MLX4_SQ_OWNER_BIT 31
  63 #define MLX4_SQ_STAMP_VAL 0x7fffffff
  64
  65 /* Work queue element (WQE) flags. */
  66 #define MLX4_WQE_CTRL_IIP_HDR_CSUM (1 << 28)
  67 #define MLX4_WQE_CTRL_IL4_HDR_CSUM (1 << 27)
  68
  69 /* CQE checksum flags. */
  70 enum {
  71         MLX4_CQE_L2_TUNNEL_IPV4 = (int)(1u << 25),
  72         MLX4_CQE_L2_TUNNEL_L4_CSUM = (int)(1u << 26),
  73         MLX4_CQE_L2_TUNNEL = (int)(1u << 27),
  74         MLX4_CQE_L2_VLAN_MASK = (int)(3u << 29),
  75         MLX4_CQE_L2_TUNNEL_IPOK = (int)(1u << 31),
  76 };
  77
  78 /* CQE status flags. */
  79 #define MLX4_CQE_STATUS_IPV4 (1 << 22)
  80 #define MLX4_CQE_STATUS_IPV4F (1 << 23)
  81 #define MLX4_CQE_STATUS_IPV6 (1 << 24)
  82 #define MLX4_CQE_STATUS_IPV4OPT (1 << 25)
  83 #define MLX4_CQE_STATUS_TCP (1 << 26)
  84 #define MLX4_CQE_STATUS_UDP (1 << 27)
  85 #define MLX4_CQE_STATUS_PTYPE_MASK \
  86         (MLX4_CQE_STATUS_IPV4 | \
  87          MLX4_CQE_STATUS_IPV4F | \
  88          MLX4_CQE_STATUS_IPV6 | \
  89          MLX4_CQE_STATUS_IPV4OPT | \
  90          MLX4_CQE_STATUS_TCP | \
  91          MLX4_CQE_STATUS_UDP)
  92
  93 /* Send queue information. */
  94 struct mlx4_sq {
  95         volatile uint8_t *buf; /**< SQ buffer. */
  96         volatile uint8_t *eob; /**< End of SQ buffer */
  97         uint32_t size; /**< SQ size includes headroom. */
  98         uint32_t remain_size; /**< Remaining WQE room in SQ (bytes). */
  99         uint32_t owner_opcode;
 100         /**< Default owner opcode with HW valid owner bit. */
 101         uint32_t stamp; /**< Stamp value with an invalid HW owner bit. */
 102         volatile uint32_t *db; /**< Pointer to the doorbell. */
 103         uint32_t doorbell_qpn; /**< qp number to write to the doorbell. */
 104 };
 105
 106 /* Completion queue events, numbers and masks. */
 107 #define MLX4_CQ_DB_GEQ_N_MASK 0x3
 108 #define MLX4_CQ_DOORBELL 0x20
 109 #define MLX4_CQ_DB_CI_MASK 0xffffff
 110
 111 /* Completion queue information. */
 112 struct mlx4_cq {
 113         volatile void *cq_uar; /**< CQ user access region. */
 114         volatile void *cq_db_reg; /**< CQ doorbell register. */
 115         volatile uint32_t *set_ci_db; /**< Pointer to the CQ doorbell. */
 116         volatile uint32_t *arm_db; /**< Arming Rx events doorbell. */
 117         volatile uint8_t *buf; /**< Pointer to the completion queue buffer. */
 118         uint32_t cqe_cnt; /**< Number of entries in the queue. */
 119         uint32_t cqe_64:1; /**< CQ entry size is 64 bytes. */
 120         uint32_t cons_index; /**< Last queue entry that was handled. */
 121         uint32_t cqn; /**< CQ number. */
 122         int arm_sn; /**< Rx event counter. */
 123 };
 124
 125 /**
 126  * Retrieve a CQE entry from a CQ.
 127  *
 128  * cqe = cq->buf + cons_index * cqe_size + cqe_offset
 129  *
 130  * Where cqe_size is 32 or 64 bytes and cqe_offset is 0 or 32 (depending on
 131  * cqe_size).
 132  *
 133  * @param cq
 134  *   CQ to retrieve entry from.
 135  * @param index
 136  *   Entry index.
 137  *
 138  * @return
 139  *   Pointer to CQE entry.
 140  */
 141 static inline volatile struct mlx4_cqe *
 142 mlx4_get_cqe(struct mlx4_cq *cq, uint32_t index)
 143 {
 144         return (volatile struct mlx4_cqe *)(cq->buf +
 145                                    ((index & (cq->cqe_cnt - 1)) <<
 146                                     (5 + cq->cqe_64)) +
 147                                    (cq->cqe_64 << 5));
 148 }
 149
 150 /**
 151  * Transpose a flag in a value.
 152  *
 153  * @param val
 154  *   Input value.
 155  * @param from
 156  *   Flag to retrieve from input value.
 157  * @param to
 158  *   Flag to set in output value.
 159  *
 160  * @return
 161  *   Output value with transposed flag enabled if present on input.
 162  */
 163 static inline uint64_t
 164 mlx4_transpose(uint64_t val, uint64_t from, uint64_t to)
 165 {
 166         return (from >= to ?
 167                 (val & from) / (from / to) :
 168                 (val & from) * (to / from));
 169 }
 170
 171 #endif /* MLX4_PRM_H_ */