lib/librte_pmd_bond/rte_eth_bond_private.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  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
  16  *       distribution.
  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.
  20  *
  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.
  32  */
  33
  34 #ifndef _RTE_ETH_BOND_PRIVATE_H_
  35 #define _RTE_ETH_BOND_PRIVATE_H_
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 #include <rte_ethdev.h>
  42 #include <rte_spinlock.h>
  43
  44 #include "rte_eth_bond.h"
  45
  46 #define PMD_BOND_SLAVE_PORT_KVARG                       ("slave")
  47 #define PMD_BOND_PRIMARY_SLAVE_KVARG            ("primary")
  48 #define PMD_BOND_MODE_KVARG                                     ("mode")
  49 #define PMD_BOND_XMIT_POLICY_KVARG                      ("xmit_policy")
  50 #define PMD_BOND_SOCKET_ID_KVARG                        ("socket_id")
  51 #define PMD_BOND_MAC_ADDR_KVARG                         ("mac")
  52 #define PMD_BOND_LSC_POLL_PERIOD_KVARG          ("lsc_poll_period_ms")
  53 #define PMD_BOND_LINK_UP_PROP_DELAY_KVARG       ("up_delay")
  54 #define PMD_BOND_LINK_DOWN_PROP_DELAY_KVARG     ("down_delay")
  55
  56 #define PMD_BOND_XMIT_POLICY_LAYER2_KVARG       ("l2")
  57 #define PMD_BOND_XMIT_POLICY_LAYER23_KVARG      ("l23")
  58 #define PMD_BOND_XMIT_POLICY_LAYER34_KVARG      ("l34")
  59
  60 #define RTE_BOND_LOG(lvl, msg, ...)             \
  61         RTE_LOG(lvl, PMD, "%s(%d) - " msg "\n", __func__, __LINE__, ##__VA_ARGS__)
  62
  63 extern const char *pmd_bond_init_valid_arguments[];
  64
  65 extern const char *driver_name;
  66
  67 /** Port Queue Mapping Structure */
  68 struct bond_rx_queue {
  69         int queue_id;
  70         /**< Queue Id */
  71         struct bond_dev_private *dev_private;
  72         /**< Reference to eth_dev private structure */
  73         uint16_t nb_rx_desc;
  74         /**< Number of RX descriptors available for the queue */
  75         struct rte_eth_rxconf rx_conf;
  76         /**< Copy of RX configuration structure for queue */
  77         struct rte_mempool *mb_pool;
  78         /**< Reference to mbuf pool to use for RX queue */
  79 };
  80
  81 struct bond_tx_queue {
  82         int queue_id;
  83         /**< Queue Id */
  84         struct bond_dev_private *dev_private;
  85         /**< Reference to dev private structure */
  86         uint16_t nb_tx_desc;
  87         /**< Number of TX descriptors available for the queue */
  88         struct rte_eth_txconf tx_conf;
  89         /**< Copy of TX configuration structure for queue */
  90 };
  91
  92
  93 /** Bonded slave devices structure */
  94 struct bond_ethdev_slave_ports {
  95         uint8_t slaves[RTE_MAX_ETHPORTS];       /**< Slave port id array */
  96         uint8_t slave_count;                            /**< Number of slaves */
  97 };
  98
  99 struct bond_slave_details {
 100         uint8_t port_id;
 101
 102         uint8_t link_status_poll_enabled;
 103         uint8_t link_status_wait_to_complete;
 104         uint8_t last_link_status;
 105
 106         /**< Port Id of slave eth_dev */
 107         struct ether_addr persisted_mac_addr;
 108 };
 109
 110 /** Link Bonding PMD device private configuration Structure */
 111 struct bond_dev_private {
 112         uint8_t port_id;                                        /**< Port Id of Bonded Port */
 113         uint8_t mode;                                           /**< Link Bonding Mode */
 114
 115         rte_spinlock_t lock;
 116
 117         uint8_t primary_port;                           /**< Primary Slave Port */
 118         uint8_t current_primary_port;           /**< Primary Slave Port */
 119         uint8_t user_defined_primary_port;
 120         /**< Flag for whether primary port is user defined or not */
 121
 122         uint8_t balance_xmit_policy;
 123         /**< Transmit policy - l2 / l23 / l34 for operation in balance mode */
 124         uint8_t user_defined_mac;
 125         /**< Flag for whether MAC address is user defined or not */
 126         uint8_t promiscuous_en;
 127         /**< Enabled/disable promiscuous mode on slave devices */
 128         uint8_t link_props_set;
 129         /**< flag to denote if the link properties are set */
 130
 131         uint8_t link_status_polling_enabled;
 132         uint32_t link_status_polling_interval_ms;
 133
 134         uint32_t link_down_delay_ms;
 135         uint32_t link_up_delay_ms;
 136
 137         uint16_t nb_rx_queues;                  /**< Total number of rx queues */
 138         uint16_t nb_tx_queues;                  /**< Total number of tx queues*/
 139
 140         uint8_t active_slave_count;             /**< Number of active slaves */
 141         uint8_t active_slaves[RTE_MAX_ETHPORTS];        /**< Active slave list */
 142
 143         uint8_t slave_count;                    /**< Number of bonded slaves */
 144         struct bond_slave_details slaves[RTE_MAX_ETHPORTS];
 145         /**< Arary of bonded slaves details */
 146
 147         struct rte_kvargs *kvlist;
 148 };
 149
 150 extern struct eth_dev_ops default_dev_ops;
 151
 152 int
 153 valid_bonded_ethdev(struct rte_eth_dev *eth_dev);
 154
 155 int
 156 valid_port_id(uint8_t port_id);
 157
 158 int
 159 valid_bonded_port_id(uint8_t port_id);
 160
 161 int
 162 valid_slave_port_id(uint8_t port_id);
 163
 164 void
 165 link_properties_set(struct rte_eth_dev *bonded_eth_dev,
 166                 struct rte_eth_link *slave_dev_link);
 167 void
 168 link_properties_reset(struct rte_eth_dev *bonded_eth_dev);
 169
 170 int
 171 link_properties_valid(struct rte_eth_link *bonded_dev_link,
 172                 struct rte_eth_link *slave_dev_link);
 173
 174 int
 175 mac_address_set(struct rte_eth_dev *eth_dev, struct ether_addr *new_mac_addr);
 176
 177 int
 178 mac_address_slaves_update(struct rte_eth_dev *bonded_eth_dev);
 179
 180 uint8_t
 181 number_of_sockets(void);
 182
 183 int
 184 bond_ethdev_mode_set(struct rte_eth_dev *eth_dev, int mode);
 185
 186 int
 187 slave_configure(struct rte_eth_dev *bonded_eth_dev,
 188                 struct rte_eth_dev *slave_eth_dev);
 189
 190 void
 191 slave_remove(struct bond_dev_private *internals,
 192                 struct rte_eth_dev *slave_eth_dev);
 193
 194 void
 195 slave_add(struct bond_dev_private *internals,
 196                 struct rte_eth_dev *slave_eth_dev);
 197
 198 void
 199 bond_ethdev_primary_set(struct bond_dev_private *internals,
 200                 uint8_t slave_port_id);
 201
 202 void
 203 bond_ethdev_lsc_event_callback(uint8_t port_id, enum rte_eth_event_type type,
 204                 void *param);
 205
 206 int
 207 bond_ethdev_parse_slave_port_kvarg(const char *key __rte_unused,
 208                 const char *value, void *extra_args);
 209
 210 int
 211 bond_ethdev_parse_slave_mode_kvarg(const char *key __rte_unused,
 212                 const char *value, void *extra_args);
 213
 214 int
 215 bond_ethdev_parse_socket_id_kvarg(const char *key __rte_unused,
 216                 const char *value, void *extra_args);
 217
 218 int
 219 bond_ethdev_parse_primary_slave_port_id_kvarg(const char *key __rte_unused,
 220                 const char *value, void *extra_args);
 221
 222 int
 223 bond_ethdev_parse_balance_xmit_policy_kvarg(const char *key __rte_unused,
 224                 const char *value, void *extra_args);
 225
 226 int
 227 bond_ethdev_parse_bond_mac_addr_kvarg(const char *key __rte_unused,
 228                 const char *value, void *extra_args);
 229
 230 int
 231 bond_ethdev_parse_time_ms_kvarg(const char *key __rte_unused,
 232                 const char *value, void *extra_args);
 233
 234 #ifdef __cplusplus
 235 }
 236 #endif
 237
 238 #endif