drivers/common/mlx5/mlx5_common.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2019 Mellanox Technologies, Ltd
   3  */
   4
   5 #ifndef RTE_PMD_MLX5_COMMON_H_
   6 #define RTE_PMD_MLX5_COMMON_H_
   7
   8 #include <assert.h>
   9 #include <stdio.h>
  10
  11 #include <rte_pci.h>
  12 #include <rte_atomic.h>
  13 #include <rte_log.h>
  14
  15 #include "mlx5_prm.h"
  16
  17
  18 /*
  19  * Helper macros to work around __VA_ARGS__ limitations in a C99 compliant
  20  * manner.
  21  */
  22 #define PMD_DRV_LOG_STRIP(a, b) a
  23 #define PMD_DRV_LOG_OPAREN (
  24 #define PMD_DRV_LOG_CPAREN )
  25 #define PMD_DRV_LOG_COMMA ,
  26
  27 /* Return the file name part of a path. */
  28 static inline const char *
  29 pmd_drv_log_basename(const char *s)
  30 {
  31         const char *n = s;
  32
  33         while (*n)
  34                 if (*(n++) == '/')
  35                         s = n;
  36         return s;
  37 }
  38
  39 #define PMD_DRV_LOG___(level, type, name, ...) \
  40         rte_log(RTE_LOG_ ## level, \
  41                 type, \
  42                 RTE_FMT(name ": " \
  43                         RTE_FMT_HEAD(__VA_ARGS__,), \
  44                 RTE_FMT_TAIL(__VA_ARGS__,)))
  45
  46 /*
  47  * When debugging is enabled (NDEBUG not defined), file, line and function
  48  * information replace the driver name (MLX5_DRIVER_NAME) in log messages.
  49  */
  50 #ifndef NDEBUG
  51
  52 #define PMD_DRV_LOG__(level, type, name, ...) \
  53         PMD_DRV_LOG___(level, type, name, "%s:%u: %s(): " __VA_ARGS__)
  54 #define PMD_DRV_LOG_(level, type, name, s, ...) \
  55         PMD_DRV_LOG__(level, type, name,\
  56                 s "\n" PMD_DRV_LOG_COMMA \
  57                 pmd_drv_log_basename(__FILE__) PMD_DRV_LOG_COMMA \
  58                 __LINE__ PMD_DRV_LOG_COMMA \
  59                 __func__, \
  60                 __VA_ARGS__)
  61
  62 #else /* NDEBUG */
  63 #define PMD_DRV_LOG__(level, type, name, ...) \
  64         PMD_DRV_LOG___(level, type, name, __VA_ARGS__)
  65 #define PMD_DRV_LOG_(level, type, name, s, ...) \
  66         PMD_DRV_LOG__(level, type, name, s "\n", __VA_ARGS__)
  67
  68 #endif /* NDEBUG */
  69
  70 /* claim_zero() does not perform any check when debugging is disabled. */
  71 #ifndef NDEBUG
  72
  73 #define DEBUG(...) DRV_LOG(DEBUG, __VA_ARGS__)
  74 #define claim_zero(...) assert((__VA_ARGS__) == 0)
  75 #define claim_nonzero(...) assert((__VA_ARGS__) != 0)
  76
  77 #else /* NDEBUG */
  78
  79 #define DEBUG(...) (void)0
  80 #define claim_zero(...) (__VA_ARGS__)
  81 #define claim_nonzero(...) (__VA_ARGS__)
  82
  83 #endif /* NDEBUG */
  84
  85 /* Allocate a buffer on the stack and fill it with a printf format string. */
  86 #define MKSTR(name, ...) \
  87         int mkstr_size_##name = snprintf(NULL, 0, "" __VA_ARGS__); \
  88         char name[mkstr_size_##name + 1]; \
  89         \
  90         snprintf(name, sizeof(name), "" __VA_ARGS__)
  91
  92 enum {
  93         PCI_VENDOR_ID_MELLANOX = 0x15b3,
  94 };
  95
  96 enum {
  97         PCI_DEVICE_ID_MELLANOX_CONNECTX4 = 0x1013,
  98         PCI_DEVICE_ID_MELLANOX_CONNECTX4VF = 0x1014,
  99         PCI_DEVICE_ID_MELLANOX_CONNECTX4LX = 0x1015,
 100         PCI_DEVICE_ID_MELLANOX_CONNECTX4LXVF = 0x1016,
 101         PCI_DEVICE_ID_MELLANOX_CONNECTX5 = 0x1017,
 102         PCI_DEVICE_ID_MELLANOX_CONNECTX5VF = 0x1018,
 103         PCI_DEVICE_ID_MELLANOX_CONNECTX5EX = 0x1019,
 104         PCI_DEVICE_ID_MELLANOX_CONNECTX5EXVF = 0x101a,
 105         PCI_DEVICE_ID_MELLANOX_CONNECTX5BF = 0xa2d2,
 106         PCI_DEVICE_ID_MELLANOX_CONNECTX5BFVF = 0xa2d3,
 107         PCI_DEVICE_ID_MELLANOX_CONNECTX6 = 0x101b,
 108         PCI_DEVICE_ID_MELLANOX_CONNECTX6VF = 0x101c,
 109         PCI_DEVICE_ID_MELLANOX_CONNECTX6DX = 0x101d,
 110         PCI_DEVICE_ID_MELLANOX_CONNECTX6DXVF = 0x101e,
 111 };
 112
 113 /* CQE status. */
 114 enum mlx5_cqe_status {
 115         MLX5_CQE_STATUS_SW_OWN = -1,
 116         MLX5_CQE_STATUS_HW_OWN = -2,
 117         MLX5_CQE_STATUS_ERR = -3,
 118 };
 119
 120 /**
 121  * Check whether CQE is valid.
 122  *
 123  * @param cqe
 124  *   Pointer to CQE.
 125  * @param cqes_n
 126  *   Size of completion queue.
 127  * @param ci
 128  *   Consumer index.
 129  *
 130  * @return
 131  *   The CQE status.
 132  */
 133 static __rte_always_inline enum mlx5_cqe_status
 134 check_cqe(volatile struct mlx5_cqe *cqe, const uint16_t cqes_n,
 135           const uint16_t ci)
 136 {
 137         const uint16_t idx = ci & cqes_n;
 138         const uint8_t op_own = cqe->op_own;
 139         const uint8_t op_owner = MLX5_CQE_OWNER(op_own);
 140         const uint8_t op_code = MLX5_CQE_OPCODE(op_own);
 141
 142         if (unlikely((op_owner != (!!(idx))) || (op_code == MLX5_CQE_INVALID)))
 143                 return MLX5_CQE_STATUS_HW_OWN;
 144         rte_cio_rmb();
 145         if (unlikely(op_code == MLX5_CQE_RESP_ERR ||
 146                      op_code == MLX5_CQE_REQ_ERR))
 147                 return MLX5_CQE_STATUS_ERR;
 148         return MLX5_CQE_STATUS_SW_OWN;
 149 }
 150
 151 int mlx5_dev_to_pci_addr(const char *dev_path, struct rte_pci_addr *pci_addr);
 152
 153 #endif /* RTE_PMD_MLX5_COMMON_H_ */