drivers/net: fix exposing internal headers
[dpdk.git] / drivers / net / bonding / eth_bond_private.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2017 Intel Corporation
3  */
4
5 #ifndef _ETH_BOND_PRIVATE_H_
6 #define _ETH_BOND_PRIVATE_H_
7
8 #include <stdint.h>
9 #include <sys/queue.h>
10
11 #include <rte_ethdev_driver.h>
12 #include <rte_flow.h>
13 #include <rte_spinlock.h>
14 #include <rte_bitmap.h>
15 #include <rte_flow_driver.h>
16
17 #include "rte_eth_bond.h"
18 #include "eth_bond_8023ad_private.h"
19 #include "rte_eth_bond_alb.h"
20
21 #define PMD_BOND_SLAVE_PORT_KVARG                       ("slave")
22 #define PMD_BOND_PRIMARY_SLAVE_KVARG            ("primary")
23 #define PMD_BOND_MODE_KVARG                                     ("mode")
24 #define PMD_BOND_AGG_MODE_KVARG                         ("agg_mode")
25 #define PMD_BOND_XMIT_POLICY_KVARG                      ("xmit_policy")
26 #define PMD_BOND_SOCKET_ID_KVARG                        ("socket_id")
27 #define PMD_BOND_MAC_ADDR_KVARG                         ("mac")
28 #define PMD_BOND_LSC_POLL_PERIOD_KVARG          ("lsc_poll_period_ms")
29 #define PMD_BOND_LINK_UP_PROP_DELAY_KVARG       ("up_delay")
30 #define PMD_BOND_LINK_DOWN_PROP_DELAY_KVARG     ("down_delay")
31
32 #define PMD_BOND_XMIT_POLICY_LAYER2_KVARG       ("l2")
33 #define PMD_BOND_XMIT_POLICY_LAYER23_KVARG      ("l23")
34 #define PMD_BOND_XMIT_POLICY_LAYER34_KVARG      ("l34")
35
36 extern int bond_logtype;
37
38 #define RTE_BOND_LOG(lvl, msg, ...)             \
39         rte_log(RTE_LOG_ ## lvl, bond_logtype, \
40                 "%s(%d) - " msg "\n", __func__, __LINE__, ##__VA_ARGS__)
41
42 #define BONDING_MODE_INVALID 0xFF
43
44 extern const char *pmd_bond_init_valid_arguments[];
45
46 extern struct rte_vdev_driver pmd_bond_drv;
47
48 extern const struct rte_flow_ops bond_flow_ops;
49
50 /** Port Queue Mapping Structure */
51 struct bond_rx_queue {
52         uint16_t queue_id;
53         /**< Queue Id */
54         struct bond_dev_private *dev_private;
55         /**< Reference to eth_dev private structure */
56         uint16_t nb_rx_desc;
57         /**< Number of RX descriptors available for the queue */
58         struct rte_eth_rxconf rx_conf;
59         /**< Copy of RX configuration structure for queue */
60         struct rte_mempool *mb_pool;
61         /**< Reference to mbuf pool to use for RX queue */
62 };
63
64 struct bond_tx_queue {
65         uint16_t queue_id;
66         /**< Queue Id */
67         struct bond_dev_private *dev_private;
68         /**< Reference to dev private structure */
69         uint16_t nb_tx_desc;
70         /**< Number of TX descriptors available for the queue */
71         struct rte_eth_txconf tx_conf;
72         /**< Copy of TX configuration structure for queue */
73 };
74
75 /** Bonded slave devices structure */
76 struct bond_ethdev_slave_ports {
77         uint16_t slaves[RTE_MAX_ETHPORTS];      /**< Slave port id array */
78         uint16_t slave_count;                           /**< Number of slaves */
79 };
80
81 struct bond_slave_details {
82         uint16_t port_id;
83
84         uint8_t link_status_poll_enabled;
85         uint8_t link_status_wait_to_complete;
86         uint8_t last_link_status;
87         /**< Port Id of slave eth_dev */
88         struct rte_ether_addr persisted_mac_addr;
89
90         uint16_t reta_size;
91 };
92
93 struct rte_flow {
94         TAILQ_ENTRY(rte_flow) next;
95         /* Slaves flows */
96         struct rte_flow *flows[RTE_MAX_ETHPORTS];
97         /* Flow description for synchronization */
98         struct rte_flow_conv_rule rule;
99         uint8_t rule_data[];
100 };
101
102 typedef void (*burst_xmit_hash_t)(struct rte_mbuf **buf, uint16_t nb_pkts,
103                 uint16_t slave_count, uint16_t *slaves);
104
105 /** Link Bonding PMD device private configuration Structure */
106 struct bond_dev_private {
107         uint16_t port_id;                       /**< Port Id of Bonded Port */
108         uint8_t mode;                                           /**< Link Bonding Mode */
109
110         rte_spinlock_t lock;
111         rte_spinlock_t lsc_lock;
112
113         uint16_t primary_port;                  /**< Primary Slave Port */
114         uint16_t current_primary_port;          /**< Primary Slave Port */
115         uint16_t user_defined_primary_port;
116         /**< Flag for whether primary port is user defined or not */
117
118         uint8_t balance_xmit_policy;
119         /**< Transmit policy - l2 / l23 / l34 for operation in balance mode */
120         burst_xmit_hash_t burst_xmit_hash;
121         /**< Transmit policy hash function */
122
123         uint8_t user_defined_mac;
124         /**< Flag for whether MAC address is user defined or not */
125
126         uint8_t link_status_polling_enabled;
127         uint32_t link_status_polling_interval_ms;
128
129         uint32_t link_down_delay_ms;
130         uint32_t link_up_delay_ms;
131
132         uint16_t nb_rx_queues;                  /**< Total number of rx queues */
133         uint16_t nb_tx_queues;                  /**< Total number of tx queues*/
134
135         uint16_t active_slave;          /**< Next active_slave to poll */
136         uint16_t active_slave_count;            /**< Number of active slaves */
137         uint16_t active_slaves[RTE_MAX_ETHPORTS];    /**< Active slave list */
138
139         uint16_t slave_count;                   /**< Number of bonded slaves */
140         struct bond_slave_details slaves[RTE_MAX_ETHPORTS];
141         /**< Arary of bonded slaves details */
142
143         struct mode8023ad_private mode4;
144         uint16_t tlb_slaves_order[RTE_MAX_ETHPORTS];
145         /**< TLB active slaves send order */
146         struct mode_alb_private mode6;
147
148         uint64_t rx_offload_capa;       /** Rx offload capability */
149         uint64_t tx_offload_capa;       /** Tx offload capability */
150         uint64_t rx_queue_offload_capa; /** per queue Rx offload capability */
151         uint64_t tx_queue_offload_capa; /** per queue Tx offload capability */
152
153         /**< List of the configured flows */
154         TAILQ_HEAD(sub_flows, rte_flow) flow_list;
155
156         /**< Flow isolation state */
157         int flow_isolated;
158         int flow_isolated_valid;
159
160         /** Bit mask of RSS offloads, the bit offset also means flow type */
161         uint64_t flow_type_rss_offloads;
162
163         struct rte_eth_rxconf default_rxconf;   /**< Default RxQ conf. */
164         struct rte_eth_txconf default_txconf;   /**< Default TxQ conf. */
165         struct rte_eth_desc_lim rx_desc_lim;    /**< Rx descriptor limits */
166         struct rte_eth_desc_lim tx_desc_lim;    /**< Tx descriptor limits */
167
168         uint16_t reta_size;
169         struct rte_eth_rss_reta_entry64 reta_conf[ETH_RSS_RETA_SIZE_512 /
170                         RTE_RETA_GROUP_SIZE];
171
172         uint8_t rss_key[52];                            /**< 52-byte hash key buffer. */
173         uint8_t rss_key_len;                            /**< hash key length in bytes. */
174
175         struct rte_kvargs *kvlist;
176         uint8_t slave_update_idx;
177
178         uint32_t candidate_max_rx_pktlen;
179         uint32_t max_rx_pktlen;
180
181         void *vlan_filter_bmpmem;               /* enabled vlan filter bitmap */
182         struct rte_bitmap *vlan_filter_bmp;
183 };
184
185 extern const struct eth_dev_ops default_dev_ops;
186
187 int
188 check_for_master_bonded_ethdev(const struct rte_eth_dev *eth_dev);
189
190 int
191 check_for_bonded_ethdev(const struct rte_eth_dev *eth_dev);
192
193 /* Search given slave array to find position of given id.
194  * Return slave pos or slaves_count if not found. */
195 static inline uint16_t
196 find_slave_by_id(uint16_t *slaves, uint16_t slaves_count, uint16_t slave_id) {
197
198         uint16_t pos;
199         for (pos = 0; pos < slaves_count; pos++) {
200                 if (slave_id == slaves[pos])
201                         break;
202         }
203
204         return pos;
205 }
206
207 int
208 valid_port_id(uint16_t port_id);
209
210 int
211 valid_bonded_port_id(uint16_t port_id);
212
213 int
214 valid_slave_port_id(uint16_t port_id, uint8_t mode);
215
216 void
217 deactivate_slave(struct rte_eth_dev *eth_dev, uint16_t port_id);
218
219 void
220 activate_slave(struct rte_eth_dev *eth_dev, uint16_t port_id);
221
222 int
223 mac_address_set(struct rte_eth_dev *eth_dev,
224                 struct rte_ether_addr *new_mac_addr);
225
226 int
227 mac_address_get(struct rte_eth_dev *eth_dev,
228                 struct rte_ether_addr *dst_mac_addr);
229
230 int
231 mac_address_slaves_update(struct rte_eth_dev *bonded_eth_dev);
232
233 int
234 slave_add_mac_addresses(struct rte_eth_dev *bonded_eth_dev,
235                 uint16_t slave_port_id);
236
237 int
238 slave_remove_mac_addresses(struct rte_eth_dev *bonded_eth_dev,
239                 uint16_t slave_port_id);
240
241 int
242 bond_ethdev_mode_set(struct rte_eth_dev *eth_dev, int mode);
243
244 int
245 slave_configure(struct rte_eth_dev *bonded_eth_dev,
246                 struct rte_eth_dev *slave_eth_dev);
247
248 void
249 slave_remove(struct bond_dev_private *internals,
250                 struct rte_eth_dev *slave_eth_dev);
251
252 void
253 slave_add(struct bond_dev_private *internals,
254                 struct rte_eth_dev *slave_eth_dev);
255
256 void
257 burst_xmit_l2_hash(struct rte_mbuf **buf, uint16_t nb_pkts,
258                 uint16_t slave_count, uint16_t *slaves);
259
260 void
261 burst_xmit_l23_hash(struct rte_mbuf **buf, uint16_t nb_pkts,
262                 uint16_t slave_count, uint16_t *slaves);
263
264 void
265 burst_xmit_l34_hash(struct rte_mbuf **buf, uint16_t nb_pkts,
266                 uint16_t slave_count, uint16_t *slaves);
267
268
269 void
270 bond_ethdev_primary_set(struct bond_dev_private *internals,
271                 uint16_t slave_port_id);
272
273 int
274 bond_ethdev_lsc_event_callback(uint16_t port_id, enum rte_eth_event_type type,
275                 void *param, void *ret_param);
276
277 int
278 bond_ethdev_parse_slave_port_kvarg(const char *key,
279                 const char *value, void *extra_args);
280
281 int
282 bond_ethdev_parse_slave_mode_kvarg(const char *key,
283                 const char *value, void *extra_args);
284
285 int
286 bond_ethdev_parse_slave_agg_mode_kvarg(const char *key __rte_unused,
287                 const char *value, void *extra_args);
288
289 int
290 bond_ethdev_parse_socket_id_kvarg(const char *key,
291                 const char *value, void *extra_args);
292
293 int
294 bond_ethdev_parse_primary_slave_port_id_kvarg(const char *key,
295                 const char *value, void *extra_args);
296
297 int
298 bond_ethdev_parse_balance_xmit_policy_kvarg(const char *key,
299                 const char *value, void *extra_args);
300
301 int
302 bond_ethdev_parse_bond_mac_addr_kvarg(const char *key,
303                 const char *value, void *extra_args);
304
305 int
306 bond_ethdev_parse_time_ms_kvarg(const char *key,
307                 const char *value, void *extra_args);
308
309 void
310 bond_tlb_disable(struct bond_dev_private *internals);
311
312 void
313 bond_tlb_enable(struct bond_dev_private *internals);
314
315 void
316 bond_tlb_activate_slave(struct bond_dev_private *internals);
317
318 void
319 bond_ethdev_stop(struct rte_eth_dev *eth_dev);
320
321 void
322 bond_ethdev_close(struct rte_eth_dev *dev);
323
324 #endif