4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _RTE_ETH_BOND_PRIVATE_H_
35 #define _RTE_ETH_BOND_PRIVATE_H_
41 #include <rte_ethdev.h>
42 #include <rte_spinlock.h>
44 #include "rte_eth_bond.h"
45 #include "rte_eth_bond_8023ad_private.h"
47 #define PMD_BOND_SLAVE_PORT_KVARG ("slave")
48 #define PMD_BOND_PRIMARY_SLAVE_KVARG ("primary")
49 #define PMD_BOND_MODE_KVARG ("mode")
50 #define PMD_BOND_XMIT_POLICY_KVARG ("xmit_policy")
51 #define PMD_BOND_SOCKET_ID_KVARG ("socket_id")
52 #define PMD_BOND_MAC_ADDR_KVARG ("mac")
53 #define PMD_BOND_LSC_POLL_PERIOD_KVARG ("lsc_poll_period_ms")
54 #define PMD_BOND_LINK_UP_PROP_DELAY_KVARG ("up_delay")
55 #define PMD_BOND_LINK_DOWN_PROP_DELAY_KVARG ("down_delay")
57 #define PMD_BOND_XMIT_POLICY_LAYER2_KVARG ("l2")
58 #define PMD_BOND_XMIT_POLICY_LAYER23_KVARG ("l23")
59 #define PMD_BOND_XMIT_POLICY_LAYER34_KVARG ("l34")
61 #define RTE_BOND_LOG(lvl, msg, ...) \
62 RTE_LOG(lvl, PMD, "%s(%d) - " msg "\n", __func__, __LINE__, ##__VA_ARGS__)
64 #define BONDING_MODE_INVALID 0xFF
66 extern const char *pmd_bond_init_valid_arguments[];
68 extern const char *driver_name;
70 /** Port Queue Mapping Structure */
71 struct bond_rx_queue {
74 struct bond_dev_private *dev_private;
75 /**< Reference to eth_dev private structure */
77 /**< Number of RX descriptors available for the queue */
78 struct rte_eth_rxconf rx_conf;
79 /**< Copy of RX configuration structure for queue */
80 struct rte_mempool *mb_pool;
81 /**< Reference to mbuf pool to use for RX queue */
84 struct bond_tx_queue {
87 struct bond_dev_private *dev_private;
88 /**< Reference to dev private structure */
90 /**< Number of TX descriptors available for the queue */
91 struct rte_eth_txconf tx_conf;
92 /**< Copy of TX configuration structure for queue */
95 /** Bonded slave devices structure */
96 struct bond_ethdev_slave_ports {
97 uint8_t slaves[RTE_MAX_ETHPORTS]; /**< Slave port id array */
98 uint8_t slave_count; /**< Number of slaves */
101 struct bond_slave_details {
104 uint8_t link_status_poll_enabled;
105 uint8_t link_status_wait_to_complete;
106 uint8_t last_link_status;
107 /**< Port Id of slave eth_dev */
108 struct ether_addr persisted_mac_addr;
112 typedef uint16_t (*xmit_hash_t)(const struct rte_mbuf *buf, uint8_t slave_count);
114 /** Link Bonding PMD device private configuration Structure */
115 struct bond_dev_private {
116 uint8_t port_id; /**< Port Id of Bonded Port */
117 uint8_t mode; /**< Link Bonding Mode */
121 uint8_t primary_port; /**< Primary Slave Port */
122 uint8_t current_primary_port; /**< Primary Slave Port */
123 uint8_t user_defined_primary_port;
124 /**< Flag for whether primary port is user defined or not */
126 uint8_t balance_xmit_policy;
127 /**< Transmit policy - l2 / l23 / l34 for operation in balance mode */
128 xmit_hash_t xmit_hash;
129 /**< Transmit policy hash function */
131 uint8_t user_defined_mac;
132 /**< Flag for whether MAC address is user defined or not */
133 uint8_t promiscuous_en;
134 /**< Enabled/disable promiscuous mode on bonding device */
135 uint8_t link_props_set;
136 /**< flag to denote if the link properties are set */
138 uint8_t link_status_polling_enabled;
139 uint32_t link_status_polling_interval_ms;
141 uint32_t link_down_delay_ms;
142 uint32_t link_up_delay_ms;
144 uint16_t nb_rx_queues; /**< Total number of rx queues */
145 uint16_t nb_tx_queues; /**< Total number of tx queues*/
147 uint8_t active_slave_count; /**< Number of active slaves */
148 uint8_t active_slaves[RTE_MAX_ETHPORTS]; /**< Active slave list */
150 uint8_t slave_count; /**< Number of bonded slaves */
151 struct bond_slave_details slaves[RTE_MAX_ETHPORTS];
152 /**< Arary of bonded slaves details */
154 struct mode8023ad_private mode4;
156 uint32_t rx_offload_capa; /** Rx offload capability */
157 uint32_t tx_offload_capa; /** Tx offload capability */
159 struct rte_kvargs *kvlist;
160 uint8_t slave_update_idx;
163 extern struct eth_dev_ops default_dev_ops;
166 valid_bonded_ethdev(struct rte_eth_dev *eth_dev);
168 /* Search given slave array to find possition of given id.
169 * Return slave pos or slaves_count if not found. */
170 static inline uint8_t
171 find_slave_by_id(uint8_t *slaves, uint8_t slaves_count, uint8_t slave_id) {
174 for (pos = 0; pos < slaves_count; pos++) {
175 if (slave_id == slaves[pos])
183 valid_port_id(uint8_t port_id);
186 valid_bonded_port_id(uint8_t port_id);
189 valid_slave_port_id(uint8_t port_id);
192 deactivate_slave(struct rte_eth_dev *eth_dev, uint8_t port_id);
195 activate_slave(struct rte_eth_dev *eth_dev, uint8_t port_id);
198 link_properties_set(struct rte_eth_dev *bonded_eth_dev,
199 struct rte_eth_link *slave_dev_link);
201 link_properties_reset(struct rte_eth_dev *bonded_eth_dev);
204 link_properties_valid(struct rte_eth_link *bonded_dev_link,
205 struct rte_eth_link *slave_dev_link);
208 mac_address_set(struct rte_eth_dev *eth_dev, struct ether_addr *new_mac_addr);
211 mac_address_get(struct rte_eth_dev *eth_dev, struct ether_addr *dst_mac_addr);
214 mac_address_slaves_update(struct rte_eth_dev *bonded_eth_dev);
217 number_of_sockets(void);
220 bond_ethdev_mode_set(struct rte_eth_dev *eth_dev, int mode);
223 slave_configure(struct rte_eth_dev *bonded_eth_dev,
224 struct rte_eth_dev *slave_eth_dev);
227 slave_remove(struct bond_dev_private *internals,
228 struct rte_eth_dev *slave_eth_dev);
231 slave_add(struct bond_dev_private *internals,
232 struct rte_eth_dev *slave_eth_dev);
235 xmit_l2_hash(const struct rte_mbuf *buf, uint8_t slave_count);
238 xmit_l23_hash(const struct rte_mbuf *buf, uint8_t slave_count);
241 xmit_l34_hash(const struct rte_mbuf *buf, uint8_t slave_count);
244 bond_ethdev_primary_set(struct bond_dev_private *internals,
245 uint8_t slave_port_id);
248 bond_ethdev_lsc_event_callback(uint8_t port_id, enum rte_eth_event_type type,
252 bond_ethdev_parse_slave_port_kvarg(const char *key __rte_unused,
253 const char *value, void *extra_args);
256 bond_ethdev_parse_slave_mode_kvarg(const char *key __rte_unused,
257 const char *value, void *extra_args);
260 bond_ethdev_parse_socket_id_kvarg(const char *key __rte_unused,
261 const char *value, void *extra_args);
264 bond_ethdev_parse_primary_slave_port_id_kvarg(const char *key __rte_unused,
265 const char *value, void *extra_args);
268 bond_ethdev_parse_balance_xmit_policy_kvarg(const char *key __rte_unused,
269 const char *value, void *extra_args);
272 bond_ethdev_parse_bond_mac_addr_kvarg(const char *key __rte_unused,
273 const char *value, void *extra_args);
276 bond_ethdev_parse_time_ms_kvarg(const char *key __rte_unused,
277 const char *value, void *extra_args);