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
  43 #include "rte_eth_bond.h"
  44
  45 #define PMD_BOND_SLAVE_PORT_KVARG               ("slave")
  46 #define PMD_BOND_PRIMARY_SLAVE_KVARG    ("primary")
  47 #define PMD_BOND_MODE_KVARG                             ("mode")
  48 #define PMD_BOND_XMIT_POLICY_KVARG              ("xmit_policy")
  49 #define PMD_BOND_SOCKET_ID_KVARG                ("socket_id")
  50 #define PMD_BOND_MAC_ADDR_KVARG                 ("mac")
  51
  52 #define PMD_BOND_XMIT_POLICY_LAYER2_KVARG       ("l2")
  53 #define PMD_BOND_XMIT_POLICY_LAYER23_KVARG      ("l23")
  54 #define PMD_BOND_XMIT_POLICY_LAYER34_KVARG      ("l34")
  55
  56 extern const char *pmd_bond_init_valid_arguments[];
  57
  58 extern const char *driver_name;
  59
  60 /** Port Queue Mapping Structure */
  61 struct bond_rx_queue {
  62         int queue_id;
  63         /**< Queue Id */
  64         struct bond_dev_private *dev_private;
  65         /**< Reference to eth_dev private structure */
  66         uint16_t nb_rx_desc;
  67         /**< Number of RX descriptors available for the queue */
  68         struct rte_eth_rxconf rx_conf;
  69         /**< Copy of RX configuration structure for queue */
  70         struct rte_mempool *mb_pool;
  71         /**< Reference to mbuf pool to use for RX queue */
  72 };
  73
  74 struct bond_tx_queue {
  75         int queue_id;
  76         /**< Queue Id */
  77         struct bond_dev_private *dev_private;
  78         /**< Reference to dev private structure */
  79         uint16_t nb_tx_desc;
  80         /**< Number of TX descriptors available for the queue */
  81         struct rte_eth_txconf tx_conf;
  82         /**< Copy of TX configuration structure for queue */
  83 };
  84
  85 /** Persisted Slave Configuration Structure */
  86 struct slave_conf {
  87         uint8_t port_id;
  88         /**< Port Id of slave eth_dev */
  89         struct ether_addr mac_addr;
  90         /**< Slave eth_dev original MAC address */
  91 };
  92 /** Bonded slave devices structure */
  93 struct bond_ethdev_slave_ports {
  94         uint8_t slaves[RTE_MAX_ETHPORTS];       /**< Slave port id array */
  95         uint8_t slave_count;                            /**< Number of slaves */
  96 };
  97
  98 /** Link Bonding PMD device private configuration Structure */
  99 struct bond_dev_private {
 100         uint8_t mode;                                           /**< Link Bonding Mode */
 101
 102         uint8_t primary_port;                           /**< Primary Slave Port */
 103         uint8_t current_primary_port;           /**< Primary Slave Port */
 104         uint8_t user_defined_primary_port;
 105         /**< Flag for whether primary port is user defined or not */
 106         uint8_t balance_xmit_policy;
 107         /**< Transmit policy - l2 / l23 / l34 for operation in balance mode */
 108         uint8_t user_defined_mac;
 109         /**< Flag for whether MAC address is user defined or not */
 110         uint8_t promiscuous_en;
 111         /**< Enabled/disable promiscuous mode on slave devices */
 112         uint8_t link_props_set;
 113         /**< Bonded eth_dev link properties set */
 114
 115         uint16_t nb_rx_queues;                  /**< Total number of rx queues */
 116         uint16_t nb_tx_queues;                  /**< Total number of tx queues*/
 117
 118         uint8_t slave_count;                    /**< Number of active slaves */
 119         uint8_t active_slave_count;             /**< Number of slaves */
 120
 121         uint8_t active_slaves[RTE_MAX_ETHPORTS];        /**< Active slave list */
 122         uint8_t slaves[RTE_MAX_ETHPORTS];                       /**< Slave list */
 123
 124         /** Persisted configuration of slaves */
 125         struct slave_conf presisted_slaves_conf[RTE_MAX_ETHPORTS];
 126 };
 127
 128 extern struct eth_dev_ops default_dev_ops;
 129
 130 int
 131 valid_bonded_ethdev(struct rte_eth_dev *eth_dev);
 132
 133 int
 134 valid_port_id(uint8_t port_id);
 135
 136 int
 137 valid_bonded_port_id(uint8_t port_id);
 138
 139 int
 140 valid_slave_port_id(uint8_t port_id);
 141
 142 void
 143 link_properties_set(struct rte_eth_dev *bonded_eth_dev,
 144                 struct rte_eth_link *slave_dev_link);
 145 void
 146 link_properties_reset(struct rte_eth_dev *bonded_eth_dev);
 147
 148 int
 149 link_properties_valid(struct rte_eth_link *bonded_dev_link,
 150                 struct rte_eth_link *slave_dev_link);
 151
 152 int
 153 mac_address_set(struct rte_eth_dev *eth_dev, struct ether_addr *new_mac_addr);
 154
 155 int
 156 mac_address_slaves_update(struct rte_eth_dev *bonded_eth_dev);
 157
 158 uint8_t
 159 number_of_sockets(void);
 160
 161 int
 162 bond_ethdev_mode_set(struct rte_eth_dev *eth_dev, int mode);
 163
 164 int
 165 slave_configure(struct rte_eth_dev *bonded_eth_dev,
 166                 struct rte_eth_dev *slave_eth_dev);
 167
 168 void
 169 slave_config_clear(struct bond_dev_private *internals,
 170                 struct rte_eth_dev *slave_eth_dev);
 171
 172 void
 173 slave_config_store(struct bond_dev_private *internals,
 174                 struct rte_eth_dev *slave_eth_dev);
 175
 176 struct slave_conf *
 177 slave_config_get(struct bond_dev_private *internals, uint8_t slave_port_id);
 178
 179 void
 180 bond_ethdev_primary_set(struct bond_dev_private *internals,
 181                 uint8_t slave_port_id);
 182
 183 void
 184 bond_ethdev_lsc_event_callback(uint8_t port_id, enum rte_eth_event_type type,
 185                 void *param);
 186
 187 int
 188 bond_ethdev_parse_slave_port_kvarg(const char *key __rte_unused,
 189                 const char *value, void *extra_args);
 190
 191 int
 192 bond_ethdev_parse_slave_mode_kvarg(const char *key __rte_unused,
 193                 const char *value, void *extra_args);
 194
 195 int
 196 bond_ethdev_parse_socket_id_kvarg(const char *key __rte_unused,
 197                 const char *value, void *extra_args);
 198
 199 int
 200 bond_ethdev_parse_primary_slave_port_id_kvarg(const char *key __rte_unused,
 201                 const char *value, void *extra_args);
 202
 203 int
 204 bond_ethdev_parse_balance_xmit_policy_kvarg(const char *key __rte_unused,
 205                 const char *value, void *extra_args);
 206
 207 int
 208 bond_ethdev_parse_bond_mac_addr_kvarg(const char *key __rte_unused,
 209                 const char *value, void *extra_args);
 210
 211 #ifdef __cplusplus
 212 }
 213 #endif
 214
 215 #endif