drivers/net/mlx5/rte_pmd_mlx5.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2020 Mellanox Technologies, Ltd
   3  */
   4
   5 #ifndef RTE_PMD_PRIVATE_MLX5_H_
   6 #define RTE_PMD_PRIVATE_MLX5_H_
   7
   8 /**
   9  * @file
  10  * MLX5 public header.
  11  *
  12  * This interface provides the ability to support private PMD
  13  * dynamic flags.
  14  */
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif
  19
  20 #define RTE_PMD_MLX5_FINE_GRANULARITY_INLINE "mlx5_fine_granularity_inline"
  21
  22 /**
  23  * Returns the dynamic flags name, that are supported.
  24  *
  25  * @param[out] names
  26  *   Array that is used to return the supported dynamic flags names.
  27  * @param[in] n
  28  *   The number of elements in the names array.
  29  *
  30  * @return
  31  *   The number of dynamic flags that were copied if not negative.
  32  *   Otherwise:
  33  *   - ENOMEM - not enough entries in the array
  34  *   - EINVAL - invalid array entry
  35  */
  36 __rte_experimental
  37 int rte_pmd_mlx5_get_dyn_flag_names(char *names[], unsigned int n);
  38
  39 #define MLX5_DOMAIN_BIT_NIC_RX  (1 << 0) /**< NIC RX domain bit mask. */
  40 #define MLX5_DOMAIN_BIT_NIC_TX  (1 << 1) /**< NIC TX domain bit mask. */
  41 #define MLX5_DOMAIN_BIT_FDB     (1 << 2) /**< FDB (TX + RX) domain bit mask. */
  42
  43 /**
  44  * Synchronize the flows to make them take effort on hardware.
  45  * It only supports DR flows now. For DV and Verbs flows, there is no need to
  46  * call this function, and a success will return directly in case of Verbs.
  47  *
  48  * @param[in] port_id
  49  *   The port identifier of the Ethernet device.
  50  * @param[in] domains
  51  *   Refer to "/usr/include/infiniband/mlx5dv.h".
  52  *   Bitmask of domains in which the synchronization will be done.
  53  *   MLX5_DOMAIN_BIT* macros are used to specify the domains.
  54  *   An ADD or OR operation could be used to synchronize flows in more than
  55  *   one domain per call.
  56  *
  57  * @return
  58  *   - (0) if successful.
  59  *   - Negative value if an error.
  60  */
  61 __rte_experimental
  62 int rte_pmd_mlx5_sync_flow(uint16_t port_id, uint32_t domains);
  63
  64 #ifdef __cplusplus
  65 }
  66 #endif
  67
  68 #endif