rte_eth_bond.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _RTE_ETH_BOND_H_
#define _RTE_ETH_BOND_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <rte_ether.h>

/* Supported modes of operation of link bonding library  */

#define BONDING_MODE_ROUND_ROBIN        (0)

#define BONDING_MODE_ACTIVE_BACKUP      (1)

#define BONDING_MODE_BALANCE            (2)

#define BONDING_MODE_BROADCAST          (3)

#define BONDING_MODE_8023AD             (4)

#define BONDING_MODE_TLB    (5)

#define BONDING_MODE_ALB    (6)

/* Balance Mode Transmit Policies */
#define BALANCE_XMIT_POLICY_LAYER2      (0)

#define BALANCE_XMIT_POLICY_LAYER23     (1)

#define BALANCE_XMIT_POLICY_LAYER34     (2)

int
rte_eth_bond_create(const char *name, uint8_t mode, uint8_t socket_id);

int
rte_eth_bond_free(const char *name);

int
rte_eth_bond_slave_add(uint16_t bonded_port_id, uint16_t slave_port_id);

int
rte_eth_bond_slave_remove(uint16_t bonded_port_id, uint16_t slave_port_id);

int
rte_eth_bond_mode_set(uint16_t bonded_port_id, uint8_t mode);

int
rte_eth_bond_mode_get(uint16_t bonded_port_id);

int
rte_eth_bond_primary_set(uint16_t bonded_port_id, uint16_t slave_port_id);

int
rte_eth_bond_primary_get(uint16_t bonded_port_id);

int
rte_eth_bond_slaves_get(uint16_t bonded_port_id, uint16_t slaves[],
            uint16_t len);

int
rte_eth_bond_active_slaves_get(uint16_t bonded_port_id, uint16_t slaves[],
                uint16_t len);

int
rte_eth_bond_mac_address_set(uint16_t bonded_port_id,
        struct ether_addr *mac_addr);

int
rte_eth_bond_mac_address_reset(uint16_t bonded_port_id);

int
rte_eth_bond_xmit_policy_set(uint16_t bonded_port_id, uint8_t policy);

int
rte_eth_bond_xmit_policy_get(uint16_t bonded_port_id);

int
rte_eth_bond_link_monitoring_set(uint16_t bonded_port_id, uint32_t internal_ms);

int
rte_eth_bond_link_monitoring_get(uint16_t bonded_port_id);


int
rte_eth_bond_link_down_prop_delay_set(uint16_t bonded_port_id,
                       uint32_t delay_ms);

int
rte_eth_bond_link_down_prop_delay_get(uint16_t bonded_port_id);

int
rte_eth_bond_link_up_prop_delay_set(uint16_t bonded_port_id,
                    uint32_t delay_ms);

int
rte_eth_bond_link_up_prop_delay_get(uint16_t bonded_port_id);


#ifdef __cplusplus
}
#endif

#endif