1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2017 Intel Corporation
5 #ifndef _RTE_ETH_BOND_PRIVATE_H_
6 #define _RTE_ETH_BOND_PRIVATE_H_
10 #include <rte_ethdev_driver.h>
11 #include <rte_spinlock.h>
12 #include <rte_bitmap.h>
13 #include <rte_flow_driver.h>
15 #include "rte_eth_bond.h"
16 #include "rte_eth_bond_8023ad_private.h"
17 #include "rte_eth_bond_alb.h"
19 #define PMD_BOND_SLAVE_PORT_KVARG ("slave")
20 #define PMD_BOND_PRIMARY_SLAVE_KVARG ("primary")
21 #define PMD_BOND_MODE_KVARG ("mode")
22 #define PMD_BOND_AGG_MODE_KVARG ("agg_mode")
23 #define PMD_BOND_XMIT_POLICY_KVARG ("xmit_policy")
24 #define PMD_BOND_SOCKET_ID_KVARG ("socket_id")
25 #define PMD_BOND_MAC_ADDR_KVARG ("mac")
26 #define PMD_BOND_LSC_POLL_PERIOD_KVARG ("lsc_poll_period_ms")
27 #define PMD_BOND_LINK_UP_PROP_DELAY_KVARG ("up_delay")
28 #define PMD_BOND_LINK_DOWN_PROP_DELAY_KVARG ("down_delay")
30 #define PMD_BOND_XMIT_POLICY_LAYER2_KVARG ("l2")
31 #define PMD_BOND_XMIT_POLICY_LAYER23_KVARG ("l23")
32 #define PMD_BOND_XMIT_POLICY_LAYER34_KVARG ("l34")
34 extern int bond_logtype;
36 #define RTE_BOND_LOG(lvl, msg, ...) \
37 rte_log(RTE_LOG_ ## lvl, bond_logtype, \
38 "%s(%d) - " msg "\n", __func__, __LINE__, ##__VA_ARGS__)
40 #define BONDING_MODE_INVALID 0xFF
42 extern const char *pmd_bond_init_valid_arguments[];
44 extern struct rte_vdev_driver pmd_bond_drv;
46 extern const struct rte_flow_ops bond_flow_ops;
48 /** Port Queue Mapping Structure */
49 struct bond_rx_queue {
52 struct bond_dev_private *dev_private;
53 /**< Reference to eth_dev private structure */
55 /**< Number of RX descriptors available for the queue */
56 struct rte_eth_rxconf rx_conf;
57 /**< Copy of RX configuration structure for queue */
58 struct rte_mempool *mb_pool;
59 /**< Reference to mbuf pool to use for RX queue */
62 struct bond_tx_queue {
65 struct bond_dev_private *dev_private;
66 /**< Reference to dev private structure */
68 /**< Number of TX descriptors available for the queue */
69 struct rte_eth_txconf tx_conf;
70 /**< Copy of TX configuration structure for queue */
73 /** Bonded slave devices structure */
74 struct bond_ethdev_slave_ports {
75 uint16_t slaves[RTE_MAX_ETHPORTS]; /**< Slave port id array */
76 uint16_t slave_count; /**< Number of slaves */
79 struct bond_slave_details {
82 uint8_t link_status_poll_enabled;
83 uint8_t link_status_wait_to_complete;
84 uint8_t last_link_status;
85 /**< Port Id of slave eth_dev */
86 struct ether_addr persisted_mac_addr;
92 TAILQ_ENTRY(rte_flow) next;
94 struct rte_flow *flows[RTE_MAX_ETHPORTS];
95 /* Flow description for synchronization */
96 struct rte_flow_desc *fd;
99 typedef void (*burst_xmit_hash_t)(struct rte_mbuf **buf, uint16_t nb_pkts,
100 uint8_t slave_count, uint16_t *slaves);
102 /** Link Bonding PMD device private configuration Structure */
103 struct bond_dev_private {
104 uint16_t port_id; /**< Port Id of Bonded Port */
105 uint8_t mode; /**< Link Bonding Mode */
108 rte_spinlock_t lsc_lock;
110 uint16_t primary_port; /**< Primary Slave Port */
111 uint16_t current_primary_port; /**< Primary Slave Port */
112 uint16_t user_defined_primary_port;
113 /**< Flag for whether primary port is user defined or not */
115 uint8_t balance_xmit_policy;
116 /**< Transmit policy - l2 / l23 / l34 for operation in balance mode */
117 burst_xmit_hash_t burst_xmit_hash;
118 /**< Transmit policy hash function */
120 uint8_t user_defined_mac;
121 /**< Flag for whether MAC address is user defined or not */
122 uint8_t promiscuous_en;
123 /**< Enabled/disable promiscuous mode on bonding device */
126 uint8_t link_status_polling_enabled;
127 uint32_t link_status_polling_interval_ms;
129 uint32_t link_down_delay_ms;
130 uint32_t link_up_delay_ms;
132 uint16_t nb_rx_queues; /**< Total number of rx queues */
133 uint16_t nb_tx_queues; /**< Total number of tx queues*/
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 */
139 uint16_t slave_count; /**< Number of bonded slaves */
140 struct bond_slave_details slaves[RTE_MAX_ETHPORTS];
141 /**< Arary of bonded slaves details */
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;
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 */
153 /**< List of the configured flows */
154 TAILQ_HEAD(sub_flows, rte_flow) flow_list;
156 /**< Flow isolation state */
158 int flow_isolated_valid;
160 /** Bit mask of RSS offloads, the bit offset also means flow type */
161 uint64_t flow_type_rss_offloads;
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 */
169 struct rte_eth_rss_reta_entry64 reta_conf[ETH_RSS_RETA_SIZE_512 /
170 RTE_RETA_GROUP_SIZE];
172 uint8_t rss_key[52]; /**< 52-byte hash key buffer. */
173 uint8_t rss_key_len; /**< hash key length in bytes. */
175 struct rte_kvargs *kvlist;
176 uint8_t slave_update_idx;
178 uint32_t candidate_max_rx_pktlen;
179 uint32_t max_rx_pktlen;
181 void *vlan_filter_bmpmem; /* enabled vlan filter bitmap */
182 struct rte_bitmap *vlan_filter_bmp;
185 extern const struct eth_dev_ops default_dev_ops;
188 check_for_master_bonded_ethdev(const struct rte_eth_dev *eth_dev);
191 check_for_bonded_ethdev(const struct rte_eth_dev *eth_dev);
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) {
199 for (pos = 0; pos < slaves_count; pos++) {
200 if (slave_id == slaves[pos])
208 valid_port_id(uint16_t port_id);
211 valid_bonded_port_id(uint16_t port_id);
214 valid_slave_port_id(uint16_t port_id, uint8_t mode);
217 deactivate_slave(struct rte_eth_dev *eth_dev, uint16_t port_id);
220 activate_slave(struct rte_eth_dev *eth_dev, uint16_t port_id);
223 link_properties_set(struct rte_eth_dev *bonded_eth_dev,
224 struct rte_eth_link *slave_dev_link);
226 link_properties_valid(struct rte_eth_dev *bonded_eth_dev,
227 struct rte_eth_link *slave_dev_link);
230 mac_address_set(struct rte_eth_dev *eth_dev, struct ether_addr *new_mac_addr);
233 mac_address_get(struct rte_eth_dev *eth_dev, struct ether_addr *dst_mac_addr);
236 mac_address_slaves_update(struct rte_eth_dev *bonded_eth_dev);
239 slave_add_mac_addresses(struct rte_eth_dev *bonded_eth_dev,
240 uint16_t slave_port_id);
243 slave_remove_mac_addresses(struct rte_eth_dev *bonded_eth_dev,
244 uint16_t slave_port_id);
247 bond_ethdev_mode_set(struct rte_eth_dev *eth_dev, int mode);
250 slave_configure(struct rte_eth_dev *bonded_eth_dev,
251 struct rte_eth_dev *slave_eth_dev);
254 slave_remove(struct bond_dev_private *internals,
255 struct rte_eth_dev *slave_eth_dev);
258 slave_add(struct bond_dev_private *internals,
259 struct rte_eth_dev *slave_eth_dev);
262 burst_xmit_l2_hash(struct rte_mbuf **buf, uint16_t nb_pkts,
263 uint8_t slave_count, uint16_t *slaves);
266 burst_xmit_l23_hash(struct rte_mbuf **buf, uint16_t nb_pkts,
267 uint8_t slave_count, uint16_t *slaves);
270 burst_xmit_l34_hash(struct rte_mbuf **buf, uint16_t nb_pkts,
271 uint8_t slave_count, uint16_t *slaves);
275 bond_ethdev_primary_set(struct bond_dev_private *internals,
276 uint16_t slave_port_id);
279 bond_ethdev_lsc_event_callback(uint16_t port_id, enum rte_eth_event_type type,
280 void *param, void *ret_param);
283 bond_ethdev_parse_slave_port_kvarg(const char *key,
284 const char *value, void *extra_args);
287 bond_ethdev_parse_slave_mode_kvarg(const char *key,
288 const char *value, void *extra_args);
291 bond_ethdev_parse_slave_agg_mode_kvarg(const char *key __rte_unused,
292 const char *value, void *extra_args);
295 bond_ethdev_parse_socket_id_kvarg(const char *key,
296 const char *value, void *extra_args);
299 bond_ethdev_parse_primary_slave_port_id_kvarg(const char *key,
300 const char *value, void *extra_args);
303 bond_ethdev_parse_balance_xmit_policy_kvarg(const char *key,
304 const char *value, void *extra_args);
307 bond_ethdev_parse_bond_mac_addr_kvarg(const char *key,
308 const char *value, void *extra_args);
311 bond_ethdev_parse_time_ms_kvarg(const char *key,
312 const char *value, void *extra_args);
315 bond_tlb_disable(struct bond_dev_private *internals);
318 bond_tlb_enable(struct bond_dev_private *internals);
321 bond_tlb_activate_slave(struct bond_dev_private *internals);
324 bond_ethdev_stop(struct rte_eth_dev *eth_dev);
327 bond_ethdev_close(struct rte_eth_dev *dev);