New upstream version 18.02
[deb_dpdk.git] / drivers / net / mlx4 / mlx4.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2012 6WIND S.A.
3  * Copyright 2012 Mellanox
4  */
5
6 #ifndef RTE_PMD_MLX4_H_
7 #define RTE_PMD_MLX4_H_
8
9 #include <net/if.h>
10 #include <stdint.h>
11 #include <sys/queue.h>
12
13 /* Verbs headers do not support -pedantic. */
14 #ifdef PEDANTIC
15 #pragma GCC diagnostic ignored "-Wpedantic"
16 #endif
17 #include <infiniband/verbs.h>
18 #ifdef PEDANTIC
19 #pragma GCC diagnostic error "-Wpedantic"
20 #endif
21
22 #include <rte_ethdev_driver.h>
23 #include <rte_ether.h>
24 #include <rte_interrupts.h>
25 #include <rte_mempool.h>
26 #include <rte_spinlock.h>
27
28 #ifndef IBV_RX_HASH_INNER
29 /** This is not necessarily defined by supported RDMA core versions. */
30 #define IBV_RX_HASH_INNER (1ull << 31)
31 #endif /* IBV_RX_HASH_INNER */
32
33 /** Maximum number of simultaneous MAC addresses. This value is arbitrary. */
34 #define MLX4_MAX_MAC_ADDRESSES 128
35
36 /** Request send completion once in every 64 sends, might be less. */
37 #define MLX4_PMD_TX_PER_COMP_REQ 64
38
39 /** Maximum size for inline data. */
40 #define MLX4_PMD_MAX_INLINE 0
41
42 /** Fixed RSS hash key size in bytes. Cannot be modified. */
43 #define MLX4_RSS_HASH_KEY_SIZE 40
44
45 /**
46  * Maximum number of cached Memory Pools (MPs) per TX queue. Each RTE MP
47  * from which buffers are to be transmitted will have to be mapped by this
48  * driver to their own Memory Region (MR). This is a slow operation.
49  *
50  * This value is always 1 for RX queues.
51  */
52 #ifndef MLX4_PMD_TX_MP_CACHE
53 #define MLX4_PMD_TX_MP_CACHE 8
54 #endif
55
56 /** Interrupt alarm timeout value in microseconds. */
57 #define MLX4_INTR_ALARM_TIMEOUT 100000
58
59 /** Port parameter. */
60 #define MLX4_PMD_PORT_KVARG "port"
61
62 enum {
63         PCI_VENDOR_ID_MELLANOX = 0x15b3,
64 };
65
66 enum {
67         PCI_DEVICE_ID_MELLANOX_CONNECTX3 = 0x1003,
68         PCI_DEVICE_ID_MELLANOX_CONNECTX3VF = 0x1004,
69         PCI_DEVICE_ID_MELLANOX_CONNECTX3PRO = 0x1007,
70 };
71
72 /** Driver name reported to lower layers and used in log output. */
73 #define MLX4_DRIVER_NAME "net_mlx4"
74
75 struct mlx4_drop;
76 struct mlx4_rss;
77 struct rxq;
78 struct txq;
79 struct rte_flow;
80
81 /** Memory region descriptor. */
82 struct mlx4_mr {
83         LIST_ENTRY(mlx4_mr) next; /**< Next entry in list. */
84         uintptr_t start; /**< Base address for memory region. */
85         uintptr_t end; /**< End address for memory region. */
86         uint32_t lkey; /**< L_Key extracted from @p mr. */
87         uint32_t refcnt; /**< Reference count for this object. */
88         struct priv *priv; /**< Back pointer to private data. */
89         struct ibv_mr *mr; /**< Memory region associated with @p mp. */
90         struct rte_mempool *mp; /**< Target memory pool (mempool). */
91 };
92
93 /** Private data structure. */
94 struct priv {
95         struct rte_eth_dev *dev; /**< Ethernet device. */
96         struct ibv_context *ctx; /**< Verbs context. */
97         struct ibv_device_attr device_attr; /**< Device properties. */
98         struct ibv_pd *pd; /**< Protection Domain. */
99         /* Device properties. */
100         uint16_t mtu; /**< Configured MTU. */
101         uint8_t port; /**< Physical port number. */
102         uint32_t started:1; /**< Device started, flows enabled. */
103         uint32_t vf:1; /**< This is a VF device. */
104         uint32_t intr_alarm:1; /**< An interrupt alarm is scheduled. */
105         uint32_t isolated:1; /**< Toggle isolated mode. */
106         uint32_t hw_csum:1; /**< Checksum offload is supported. */
107         uint32_t hw_csum_l2tun:1; /**< Checksum support for L2 tunnels. */
108         uint64_t hw_rss_sup; /**< Supported RSS hash fields (Verbs format). */
109         struct rte_intr_handle intr_handle; /**< Port interrupt handle. */
110         struct mlx4_drop *drop; /**< Shared resources for drop flow rules. */
111         LIST_HEAD(, mlx4_rss) rss; /**< Shared targets for Rx flow rules. */
112         LIST_HEAD(, rte_flow) flows; /**< Configured flow rule handles. */
113         LIST_HEAD(, mlx4_mr) mr; /**< Registered memory regions. */
114         rte_spinlock_t mr_lock; /**< Lock for @p mr access. */
115         struct ether_addr mac[MLX4_MAX_MAC_ADDRESSES];
116         /**< Configured MAC addresses. Unused entries are zeroed. */
117 };
118
119 /* mlx4_ethdev.c */
120
121 int mlx4_get_ifname(const struct priv *priv, char (*ifname)[IF_NAMESIZE]);
122 int mlx4_get_mac(struct priv *priv, uint8_t (*mac)[ETHER_ADDR_LEN]);
123 int mlx4_mtu_get(struct priv *priv, uint16_t *mtu);
124 int mlx4_mtu_set(struct rte_eth_dev *dev, uint16_t mtu);
125 int mlx4_dev_set_link_down(struct rte_eth_dev *dev);
126 int mlx4_dev_set_link_up(struct rte_eth_dev *dev);
127 void mlx4_promiscuous_enable(struct rte_eth_dev *dev);
128 void mlx4_promiscuous_disable(struct rte_eth_dev *dev);
129 void mlx4_allmulticast_enable(struct rte_eth_dev *dev);
130 void mlx4_allmulticast_disable(struct rte_eth_dev *dev);
131 void mlx4_mac_addr_remove(struct rte_eth_dev *dev, uint32_t index);
132 int mlx4_mac_addr_add(struct rte_eth_dev *dev, struct ether_addr *mac_addr,
133                       uint32_t index, uint32_t vmdq);
134 void mlx4_mac_addr_set(struct rte_eth_dev *dev, struct ether_addr *mac_addr);
135 int mlx4_vlan_filter_set(struct rte_eth_dev *dev, uint16_t vlan_id, int on);
136 int mlx4_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats);
137 void mlx4_stats_reset(struct rte_eth_dev *dev);
138 void mlx4_dev_infos_get(struct rte_eth_dev *dev,
139                         struct rte_eth_dev_info *info);
140 int mlx4_link_update(struct rte_eth_dev *dev, int wait_to_complete);
141 int mlx4_flow_ctrl_get(struct rte_eth_dev *dev,
142                        struct rte_eth_fc_conf *fc_conf);
143 int mlx4_flow_ctrl_set(struct rte_eth_dev *dev,
144                        struct rte_eth_fc_conf *fc_conf);
145 const uint32_t *mlx4_dev_supported_ptypes_get(struct rte_eth_dev *dev);
146 int mlx4_is_removed(struct rte_eth_dev *dev);
147
148 /* mlx4_intr.c */
149
150 int mlx4_intr_uninstall(struct priv *priv);
151 int mlx4_intr_install(struct priv *priv);
152 int mlx4_rxq_intr_enable(struct priv *priv);
153 void mlx4_rxq_intr_disable(struct priv *priv);
154 int mlx4_rx_intr_disable(struct rte_eth_dev *dev, uint16_t idx);
155 int mlx4_rx_intr_enable(struct rte_eth_dev *dev, uint16_t idx);
156
157 /* mlx4_mr.c */
158
159 struct mlx4_mr *mlx4_mr_get(struct priv *priv, struct rte_mempool *mp);
160 void mlx4_mr_put(struct mlx4_mr *mr);
161 uint32_t mlx4_txq_add_mr(struct txq *txq, struct rte_mempool *mp,
162                          uint32_t i);
163
164 #endif /* RTE_PMD_MLX4_H_ */