net/mlx4: associate MR to MP in a short function
[dpdk.git] / drivers / net / mlx4 / mlx4.h
index b61f5f2..70cf453 100644 (file)
 #ifndef RTE_PMD_MLX4_H_
 #define RTE_PMD_MLX4_H_
 
+#include <net/if.h>
 #include <stdint.h>
+#include <sys/queue.h>
 
-/* Verbs header. */
-/* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
+/* Verbs headers do not support -pedantic. */
 #ifdef PEDANTIC
 #pragma GCC diagnostic ignored "-Wpedantic"
 #endif
 #include <rte_ethdev.h>
 #include <rte_ether.h>
 #include <rte_interrupts.h>
+#include <rte_mempool.h>
 
-/* Request send completion once in every 64 sends, might be less. */
+/** Maximum number of simultaneous MAC addresses. This value is arbitrary. */
+#define MLX4_MAX_MAC_ADDRESSES 128
+
+/** Request send completion once in every 64 sends, might be less. */
 #define MLX4_PMD_TX_PER_COMP_REQ 64
 
-/* Maximum size for inline data. */
+/** Maximum size for inline data. */
 #define MLX4_PMD_MAX_INLINE 0
 
-/*
+/** Fixed RSS hash key size in bytes. Cannot be modified. */
+#define MLX4_RSS_HASH_KEY_SIZE 40
+
+/**
  * Maximum number of cached Memory Pools (MPs) per TX queue. Each RTE MP
  * from which buffers are to be transmitted will have to be mapped by this
  * driver to their own Memory Region (MR). This is a slow operation.
 #define MLX4_PMD_TX_MP_CACHE 8
 #endif
 
-/* Interrupt alarm timeout value in microseconds. */
+/** Interrupt alarm timeout value in microseconds. */
 #define MLX4_INTR_ALARM_TIMEOUT 100000
 
-/* Port parameter. */
+/** Port parameter. */
 #define MLX4_PMD_PORT_KVARG "port"
 
 enum {
@@ -83,100 +91,76 @@ enum {
        PCI_DEVICE_ID_MELLANOX_CONNECTX3PRO = 0x1007,
 };
 
+/** Driver name reported to lower layers and used in log output. */
 #define MLX4_DRIVER_NAME "net_mlx4"
 
-struct mlx4_rxq_stats {
-       unsigned int idx; /**< Mapping index. */
-       uint64_t ipackets; /**< Total of successfully received packets. */
-       uint64_t ibytes; /**< Total of successfully received bytes. */
-       uint64_t idropped; /**< Total of packets dropped when RX ring full. */
-       uint64_t rx_nombuf; /**< Total of RX mbuf allocation failures. */
-};
-
-/* RX element. */
-struct rxq_elt {
-       struct ibv_recv_wr wr; /* Work Request. */
-       struct ibv_sge sge; /* Scatter/Gather Element. */
-       struct rte_mbuf *buf; /**< Buffer. */
-};
-
-/* RX queue descriptor. */
-struct rxq {
-       struct priv *priv; /* Back pointer to private data. */
-       struct rte_mempool *mp; /* Memory Pool for allocations. */
-       struct ibv_mr *mr; /* Memory Region (for mp). */
-       struct ibv_cq *cq; /* Completion Queue. */
-       struct ibv_qp *qp; /* Queue Pair. */
-       struct ibv_comp_channel *channel;
-       unsigned int port_id; /* Port ID for incoming packets. */
-       unsigned int elts_n; /* (*elts)[] length. */
-       unsigned int elts_head; /* Current index in (*elts)[]. */
-       struct rxq_elt (*elts)[]; /* Rx elements. */
-       struct mlx4_rxq_stats stats; /* RX queue counters. */
-       unsigned int socket; /* CPU socket ID for allocations. */
-};
-
-/* TX element. */
-struct txq_elt {
-       struct ibv_send_wr wr; /* Work request. */
-       struct ibv_sge sge; /* Scatter/gather element. */
-       struct rte_mbuf *buf;
-};
-
-struct mlx4_txq_stats {
-       unsigned int idx; /**< Mapping index. */
-       uint64_t opackets; /**< Total of successfully sent packets. */
-       uint64_t obytes;   /**< Total of successfully sent bytes. */
-       uint64_t odropped; /**< Total of packets not sent when TX ring full. */
-};
-
-/* TX queue descriptor. */
-struct txq {
-       struct priv *priv; /* Back pointer to private data. */
-       struct {
-               const struct rte_mempool *mp; /* Cached Memory Pool. */
-               struct ibv_mr *mr; /* Memory Region (for mp). */
-               uint32_t lkey; /* mr->lkey */
-       } mp2mr[MLX4_PMD_TX_MP_CACHE]; /* MP to MR translation table. */
-       struct ibv_cq *cq; /* Completion Queue. */
-       struct ibv_qp *qp; /* Queue Pair. */
-       uint32_t max_inline; /* Max inline send size <= MLX4_PMD_MAX_INLINE. */
-       unsigned int elts_n; /* (*elts)[] length. */
-       struct txq_elt (*elts)[]; /* TX elements. */
-       unsigned int elts_head; /* Current index in (*elts)[]. */
-       unsigned int elts_tail; /* First element awaiting completion. */
-       unsigned int elts_comp; /* Number of completion requests. */
-       unsigned int elts_comp_cd; /* Countdown for next completion request. */
-       unsigned int elts_comp_cd_init; /* Initial value for countdown. */
-       struct mlx4_txq_stats stats; /* TX queue counters. */
-       unsigned int socket; /* CPU socket ID for allocations. */
-};
-
+struct mlx4_drop;
+struct mlx4_rss;
+struct rxq;
+struct txq;
 struct rte_flow;
 
+/** Private data structure. */
 struct priv {
-       struct rte_eth_dev *dev; /* Ethernet device. */
-       struct ibv_context *ctx; /* Verbs context. */
-       struct ibv_device_attr device_attr; /* Device properties. */
-       struct ibv_pd *pd; /* Protection Domain. */
-       struct ether_addr mac; /* MAC address. */
-       struct ibv_flow *mac_flow; /* Flow associated with MAC address. */
+       struct rte_eth_dev *dev; /**< Ethernet device. */
+       struct ibv_context *ctx; /**< Verbs context. */
+       struct ibv_device_attr device_attr; /**< Device properties. */
+       struct ibv_pd *pd; /**< Protection Domain. */
        /* Device properties. */
-       uint16_t mtu; /* Configured MTU. */
-       uint8_t port; /* Physical port number. */
-       unsigned int started:1; /* Device started, flows enabled. */
-       unsigned int vf:1; /* This is a VF device. */
-       unsigned int intr_alarm:1; /* An interrupt alarm is scheduled. */
-       unsigned int isolated:1; /* Toggle isolated mode. */
-       /* RX/TX queues. */
-       unsigned int rxqs_n; /* RX queues array size. */
-       unsigned int txqs_n; /* TX queues array size. */
-       struct rxq *(*rxqs)[]; /* RX queues. */
-       struct txq *(*txqs)[]; /* TX queues. */
-       struct rte_intr_handle intr_handle; /* Port interrupt handle. */
-       struct rte_flow_drop *flow_drop_queue; /* Flow drop queue. */
-       LIST_HEAD(mlx4_flows, rte_flow) flows;
-       struct rte_intr_conf intr_conf; /* Active interrupt configuration. */
+       uint16_t mtu; /**< Configured MTU. */
+       uint8_t port; /**< Physical port number. */
+       uint32_t started:1; /**< Device started, flows enabled. */
+       uint32_t vf:1; /**< This is a VF device. */
+       uint32_t intr_alarm:1; /**< An interrupt alarm is scheduled. */
+       uint32_t isolated:1; /**< Toggle isolated mode. */
+       uint32_t hw_csum:1; /* Checksum offload is supported. */
+       uint32_t hw_csum_l2tun:1; /* Checksum support for L2 tunnels. */
+       struct rte_intr_handle intr_handle; /**< Port interrupt handle. */
+       struct mlx4_drop *drop; /**< Shared resources for drop flow rules. */
+       LIST_HEAD(, mlx4_rss) rss; /**< Shared targets for Rx flow rules. */
+       LIST_HEAD(, rte_flow) flows; /**< Configured flow rule handles. */
+       struct ether_addr mac[MLX4_MAX_MAC_ADDRESSES];
+       /**< Configured MAC addresses. Unused entries are zeroed. */
 };
 
+/* mlx4_ethdev.c */
+
+int mlx4_get_ifname(const struct priv *priv, char (*ifname)[IF_NAMESIZE]);
+int mlx4_get_mac(struct priv *priv, uint8_t (*mac)[ETHER_ADDR_LEN]);
+int mlx4_mtu_get(struct priv *priv, uint16_t *mtu);
+int mlx4_mtu_set(struct rte_eth_dev *dev, uint16_t mtu);
+int mlx4_dev_set_link_down(struct rte_eth_dev *dev);
+int mlx4_dev_set_link_up(struct rte_eth_dev *dev);
+void mlx4_promiscuous_enable(struct rte_eth_dev *dev);
+void mlx4_promiscuous_disable(struct rte_eth_dev *dev);
+void mlx4_allmulticast_enable(struct rte_eth_dev *dev);
+void mlx4_allmulticast_disable(struct rte_eth_dev *dev);
+void mlx4_mac_addr_remove(struct rte_eth_dev *dev, uint32_t index);
+int mlx4_mac_addr_add(struct rte_eth_dev *dev, struct ether_addr *mac_addr,
+                     uint32_t index, uint32_t vmdq);
+void mlx4_mac_addr_set(struct rte_eth_dev *dev, struct ether_addr *mac_addr);
+int mlx4_vlan_filter_set(struct rte_eth_dev *dev, uint16_t vlan_id, int on);
+int mlx4_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats);
+void mlx4_stats_reset(struct rte_eth_dev *dev);
+void mlx4_dev_infos_get(struct rte_eth_dev *dev,
+                       struct rte_eth_dev_info *info);
+int mlx4_link_update(struct rte_eth_dev *dev, int wait_to_complete);
+int mlx4_flow_ctrl_get(struct rte_eth_dev *dev,
+                      struct rte_eth_fc_conf *fc_conf);
+int mlx4_flow_ctrl_set(struct rte_eth_dev *dev,
+                      struct rte_eth_fc_conf *fc_conf);
+
+/* mlx4_intr.c */
+
+int mlx4_intr_uninstall(struct priv *priv);
+int mlx4_intr_install(struct priv *priv);
+int mlx4_rx_intr_disable(struct rte_eth_dev *dev, uint16_t idx);
+int mlx4_rx_intr_enable(struct rte_eth_dev *dev, uint16_t idx);
+
+/* mlx4_mr.c */
+
+struct ibv_mr *mlx4_mp2mr(struct ibv_pd *pd, struct rte_mempool *mp);
+uint32_t mlx4_txq_add_mr(struct txq *txq, struct rte_mempool *mp,
+                        uint32_t i);
+
 #endif /* RTE_PMD_MLX4_H_ */