drivers/net/bonding/rte_eth_bond_8023ad.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_8023AD_H_
  35 #define RTE_ETH_BOND_8023AD_H_
  36
  37 #include <rte_ether.h>
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 /**
  44  * Actor/partner states
  45  */
  46 #define STATE_LACP_ACTIVE                   0x01
  47 #define STATE_LACP_SHORT_TIMEOUT            0x02
  48 #define STATE_AGGREGATION                   0x04
  49 #define STATE_SYNCHRONIZATION               0x08
  50 #define STATE_COLLECTING                    0x10
  51 #define STATE_DISTRIBUTING                  0x20
  52 /** Partners parameters are defaulted */
  53 #define STATE_DEFAULTED                     0x40
  54 #define STATE_EXPIRED                       0x80
  55
  56 #define TLV_TYPE_ACTOR_INFORMATION          0x01
  57 #define TLV_TYPE_PARTNER_INFORMATION        0x02
  58 #define TLV_TYPE_COLLECTOR_INFORMATION      0x03
  59 #define TLV_TYPE_TERMINATOR_INFORMATION     0x00
  60
  61 #define SLOW_SUBTYPE_LACP                   0x01
  62 #define SLOW_SUBTYPE_MARKER                 0x02
  63
  64 #define MARKER_TLV_TYPE_INFO                0x01
  65 #define MARKER_TLV_TYPE_RESP                0x02
  66
  67 typedef void (*rte_eth_bond_8023ad_ext_slowrx_fn)(uint16_t slave_id,
  68                                                   struct rte_mbuf *lacp_pkt);
  69
  70 enum rte_bond_8023ad_selection {
  71         UNSELECTED,
  72         STANDBY,
  73         SELECTED
  74 };
  75
  76 enum rte_bond_8023ad_agg_selection {
  77         AGG_BANDWIDTH,
  78         AGG_COUNT,
  79         AGG_STABLE
  80 };
  81
  82 /** Generic slow protocol structure */
  83 struct slow_protocol {
  84         uint8_t subtype;
  85         uint8_t reserved_119[119];
  86 } __attribute__((__packed__));
  87
  88 /** Generic slow protocol frame type structure */
  89 struct slow_protocol_frame {
  90         struct ether_hdr eth_hdr;
  91         struct slow_protocol slow_protocol;
  92 } __attribute__((__packed__));
  93
  94 struct port_params {
  95         uint16_t system_priority;
  96         /**< System priority (unused in current implementation) */
  97         struct ether_addr system;
  98         /**< System ID - Slave MAC address, same as bonding MAC address */
  99         uint16_t key;
 100         /**< Speed information (implementation dependednt) and duplex. */
 101         uint16_t port_priority;
 102         /**< Priority of this (unused in current implementation) */
 103         uint16_t port_number;
 104         /**< Port number. It corresponds to slave port id. */
 105 } __attribute__((__packed__));
 106
 107 struct lacpdu_actor_partner_params {
 108         uint8_t tlv_type_info;
 109         uint8_t info_length;
 110         struct port_params port_params;
 111         uint8_t state;
 112         uint8_t reserved_3[3];
 113 } __attribute__((__packed__));
 114
 115 /** LACPDU structure (5.4.2 in 802.1AX documentation). */
 116 struct lacpdu {
 117         uint8_t subtype;
 118         uint8_t version_number;
 119
 120         struct lacpdu_actor_partner_params actor;
 121         struct lacpdu_actor_partner_params partner;
 122
 123         uint8_t tlv_type_collector_info;
 124         uint8_t collector_info_length;
 125         uint16_t collector_max_delay;
 126         uint8_t reserved_12[12];
 127
 128         uint8_t tlv_type_terminator;
 129         uint8_t terminator_length;
 130         uint8_t reserved_50[50];
 131 } __attribute__((__packed__));
 132
 133 /** LACPDU frame: Contains ethernet header and LACPDU. */
 134 struct lacpdu_header {
 135         struct ether_hdr eth_hdr;
 136         struct lacpdu lacpdu;
 137 } __attribute__((__packed__));
 138
 139 struct marker {
 140         uint8_t subtype;
 141         uint8_t version_number;
 142
 143         uint8_t tlv_type_marker;
 144         uint8_t info_length;
 145         uint16_t requester_port;
 146         struct ether_addr requester_system;
 147         uint32_t requester_transaction_id;
 148         uint8_t reserved_2[2];
 149
 150         uint8_t tlv_type_terminator;
 151         uint8_t terminator_length;
 152         uint8_t reserved_90[90];
 153 } __attribute__((__packed__));
 154
 155 struct marker_header {
 156         struct ether_hdr eth_hdr;
 157         struct marker marker;
 158 } __attribute__((__packed__));
 159
 160 struct rte_eth_bond_8023ad_conf {
 161         uint32_t fast_periodic_ms;
 162         uint32_t slow_periodic_ms;
 163         uint32_t short_timeout_ms;
 164         uint32_t long_timeout_ms;
 165         uint32_t aggregate_wait_timeout_ms;
 166         uint32_t tx_period_ms;
 167         uint32_t rx_marker_period_ms;
 168         uint32_t update_timeout_ms;
 169         rte_eth_bond_8023ad_ext_slowrx_fn slowrx_cb;
 170         enum rte_bond_8023ad_agg_selection agg_selection;
 171 };
 172
 173 struct rte_eth_bond_8023ad_slave_info {
 174         enum rte_bond_8023ad_selection selected;
 175         uint8_t actor_state;
 176         struct port_params actor;
 177         uint8_t partner_state;
 178         struct port_params partner;
 179         uint16_t agg_port_id;
 180 };
 181
 182 /**
 183  * @internal
 184  *
 185  * Function returns current configuration of 802.3AX mode.
 186  *
 187  * @param port_id   Bonding device id
 188  * @param conf          Pointer to timeout structure.
 189  *
 190  * @return
 191  *   0 - if ok
 192  *   -EINVAL if conf is NULL
 193  */
 194 int
 195 rte_eth_bond_8023ad_conf_get(uint16_t port_id,
 196                 struct rte_eth_bond_8023ad_conf *conf);
 197
 198 /**
 199  * @internal
 200  *
 201  * Function set new configuration of 802.3AX mode.
 202  *
 203  * @param port_id   Bonding device id
 204  * @param conf          Configuration, if NULL set default configuration.
 205  * @return
 206  *   0 - if ok
 207  *   -EINVAL if configuration is invalid.
 208  */
 209 int
 210 rte_eth_bond_8023ad_setup(uint16_t port_id,
 211                 struct rte_eth_bond_8023ad_conf *conf);
 212
 213 /**
 214  * @internal
 215  *
 216  * Function returns current state of given slave device.
 217  *
 218  * @param slave_id  Port id of valid slave.
 219  * @param conf          buffer for configuration
 220  * @return
 221  *   0 - if ok
 222  *   -EINVAL if conf is NULL or slave id is invalid (not a slave of given
 223  *       bonded device or is not inactive).
 224  */
 225 int
 226 rte_eth_bond_8023ad_slave_info(uint16_t port_id, uint16_t slave_id,
 227                 struct rte_eth_bond_8023ad_slave_info *conf);
 228
 229 #ifdef __cplusplus
 230 }
 231 #endif
 232
 233 /**
 234  * Configure a slave port to start collecting.
 235  *
 236  * @param port_id       Bonding device id
 237  * @param slave_id      Port id of valid slave.
 238  * @param enabled       Non-zero when collection enabled.
 239  * @return
 240  *   0 - if ok
 241  *   -EINVAL if slave is not valid.
 242  */
 243 int
 244 rte_eth_bond_8023ad_ext_collect(uint16_t port_id, uint16_t slave_id,
 245                                 int enabled);
 246
 247 /**
 248  * Get COLLECTING flag from slave port actor state.
 249  *
 250  * @param port_id       Bonding device id
 251  * @param slave_id      Port id of valid slave.
 252  * @return
 253  *   0 - if not set
 254  *   1 - if set
 255  *   -EINVAL if slave is not valid.
 256  */
 257 int
 258 rte_eth_bond_8023ad_ext_collect_get(uint16_t port_id, uint16_t slave_id);
 259
 260 /**
 261  * Configure a slave port to start distributing.
 262  *
 263  * @param port_id       Bonding device id
 264  * @param slave_id      Port id of valid slave.
 265  * @param enabled       Non-zero when distribution enabled.
 266  * @return
 267  *   0 - if ok
 268  *   -EINVAL if slave is not valid.
 269  */
 270 int
 271 rte_eth_bond_8023ad_ext_distrib(uint16_t port_id, uint16_t slave_id,
 272                                 int enabled);
 273
 274 /**
 275  * Get DISTRIBUTING flag from slave port actor state.
 276  *
 277  * @param port_id       Bonding device id
 278  * @param slave_id      Port id of valid slave.
 279  * @return
 280  *   0 - if not set
 281  *   1 - if set
 282  *   -EINVAL if slave is not valid.
 283  */
 284 int
 285 rte_eth_bond_8023ad_ext_distrib_get(uint16_t port_id, uint16_t slave_id);
 286
 287 /**
 288  * LACPDU transmit path for external 802.3ad state machine.  Caller retains
 289  * ownership of the packet on failure.
 290  *
 291  * @param port_id       Bonding device id
 292  * @param slave_id      Port ID of valid slave device.
 293  * @param lacp_pkt      mbuf containing LACPDU.
 294  *
 295  * @return
 296  *   0 on success, negative value otherwise.
 297  */
 298 int
 299 rte_eth_bond_8023ad_ext_slowtx(uint16_t port_id, uint16_t slave_id,
 300                 struct rte_mbuf *lacp_pkt);
 301
 302 /**
 303  * Enable dedicated hw queues for 802.3ad control plane traffic on on slaves
 304  *
 305  * This function creates an additional tx and rx queue on each slave for
 306  * dedicated 802.3ad control plane traffic . A flow filtering rule is
 307  * programmed on each slave to redirect all LACP slow packets to that rx queue
 308  * for processing in the LACP state machine, this removes the need to filter
 309  * these packets in the bonded devices data path. The additional tx queue is
 310  * used to enable the LACP state machine to enqueue LACP packets directly to
 311  * slave hw independently of the bonded devices data path.
 312  *
 313  * To use this feature all slaves must support the programming of the flow
 314  * filter rule required for rx and have enough queues that one rx and tx queue
 315  * can be reserved for the LACP state machines control packets.
 316  *
 317  * Bonding port must be stopped to change this configuration.
 318  *
 319  * @param port_id      Bonding device id
 320  *
 321  * @return
 322  *   0 on success, negative value otherwise.
 323  */
 324 int
 325 rte_eth_bond_8023ad_dedicated_queues_enable(uint16_t port_id);
 326
 327 /**
 328  * Disable slow queue on slaves
 329  *
 330  * This function disables hardware slow packet filter.
 331  *
 332  * Bonding port must be stopped to change this configuration.
 333  *
 334  * @see rte_eth_bond_8023ad_slow_pkt_hw_filter_enable
 335  *
 336  * @param port_id      Bonding device id
 337  * @return
 338  *   0 on success, negative value otherwise.
 339  *
 340  */
 341 int
 342 rte_eth_bond_8023ad_dedicated_queues_disable(uint16_t port_id);
 343
 344 /*
 345  * Get aggregator mode for 8023ad
 346  * @param port_id Bonding device id
 347  *
 348  * @return
 349  *   agregator mode on success, negative value otherwise
 350  */
 351 int
 352 rte_eth_bond_8023ad_agg_selection_get(uint16_t port_id);
 353
 354 /**
 355  * Set aggregator mode for 8023ad
 356  * @param port_id Bonding device id
 357  * @return
 358  *   0 on success, negative value otherwise
 359  */
 360 int
 361 rte_eth_bond_8023ad_agg_selection_set(uint16_t port_id,
 362                 enum rte_bond_8023ad_agg_selection agg_selection);
 363 #endif /* RTE_ETH_BOND_8023AD_H_ */