rte_pmd_ixgbe.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright (c) 2016 Intel Corporation. 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 _PMD_IXGBE_H_
#define _PMD_IXGBE_H_

#include <rte_ethdev.h>

int rte_pmd_ixgbe_ping_vf(uint8_t port, uint16_t vf);

int rte_pmd_ixgbe_set_vf_mac_addr(uint8_t port, uint16_t vf,
                struct ether_addr *mac_addr);

int rte_pmd_ixgbe_set_vf_vlan_anti_spoof(uint8_t port, uint16_t vf, uint8_t on);

int rte_pmd_ixgbe_set_vf_mac_anti_spoof(uint8_t port, uint16_t vf, uint8_t on);

int rte_pmd_ixgbe_set_vf_vlan_insert(uint8_t port, uint16_t vf,
                uint16_t vlan_id);

int rte_pmd_ixgbe_set_tx_loopback(uint8_t port, uint8_t on);

int rte_pmd_ixgbe_set_all_queues_drop_en(uint8_t port, uint8_t on);

int rte_pmd_ixgbe_set_vf_split_drop_en(uint8_t port, uint16_t vf, uint8_t on);

int
rte_pmd_ixgbe_set_vf_vlan_stripq(uint8_t port, uint16_t vf, uint8_t on);

int rte_pmd_ixgbe_macsec_enable(uint8_t port, uint8_t en, uint8_t rp);

int rte_pmd_ixgbe_macsec_disable(uint8_t port);

int rte_pmd_ixgbe_macsec_config_txsc(uint8_t port, uint8_t *mac);

int rte_pmd_ixgbe_macsec_config_rxsc(uint8_t port, uint8_t *mac, uint16_t pi);

int rte_pmd_ixgbe_macsec_select_txsa(uint8_t port, uint8_t idx, uint8_t an,
                uint32_t pn, uint8_t *key);

int rte_pmd_ixgbe_macsec_select_rxsa(uint8_t port, uint8_t idx, uint8_t an,
                uint32_t pn, uint8_t *key);

int
rte_pmd_ixgbe_set_vf_rxmode(uint8_t port, uint16_t vf, uint16_t rx_mask, uint8_t on);

int
rte_pmd_ixgbe_set_vf_rx(uint8_t port, uint16_t vf, uint8_t on);

int
rte_pmd_ixgbe_set_vf_tx(uint8_t port, uint16_t vf, uint8_t on);

int
rte_pmd_ixgbe_set_vf_vlan_filter(uint8_t port, uint16_t vlan, uint64_t vf_mask, uint8_t vlan_on);

int rte_pmd_ixgbe_set_vf_rate_limit(uint8_t port, uint16_t vf, uint16_t tx_rate, uint64_t q_msk);

int rte_pmd_ixgbe_set_tc_bw_alloc(uint8_t port,
                                  uint8_t tc_num,
                                  uint8_t *bw_weight);


int rte_pmd_ixgbe_bypass_init(uint8_t port);

int rte_pmd_ixgbe_bypass_state_show(uint8_t port, uint32_t *state);

int rte_pmd_ixgbe_bypass_state_set(uint8_t port, uint32_t *new_state);

int rte_pmd_ixgbe_bypass_event_show(uint8_t port,
                                    uint32_t event,
                                    uint32_t *state);

int rte_pmd_ixgbe_bypass_event_store(uint8_t port,
                                     uint32_t event,
                                     uint32_t state);

int rte_pmd_ixgbe_bypass_wd_timeout_store(uint8_t port, uint32_t timeout);

int rte_pmd_ixgbe_bypass_ver_show(uint8_t port, uint32_t *ver);

int rte_pmd_ixgbe_bypass_wd_timeout_show(uint8_t port, uint32_t *wd_timeout);

int rte_pmd_ixgbe_bypass_wd_reset(uint8_t port);


enum rte_pmd_ixgbe_mb_event_rsp {
        RTE_PMD_IXGBE_MB_EVENT_NOOP_ACK,  
        RTE_PMD_IXGBE_MB_EVENT_NOOP_NACK, 
        RTE_PMD_IXGBE_MB_EVENT_PROCEED,  
        RTE_PMD_IXGBE_MB_EVENT_MAX       
};

struct rte_pmd_ixgbe_mb_event_param {
        uint16_t vfid;     
        uint16_t msg_type; 
        uint16_t retval;   
        void *msg;         
};
enum {
        RTE_PMD_IXGBE_BYPASS_MODE_NONE,
        RTE_PMD_IXGBE_BYPASS_MODE_NORMAL,
        RTE_PMD_IXGBE_BYPASS_MODE_BYPASS,
        RTE_PMD_IXGBE_BYPASS_MODE_ISOLATE,
        RTE_PMD_IXGBE_BYPASS_MODE_NUM,
};

#define RTE_PMD_IXGBE_BYPASS_MODE_VALID(x)        \
        ((x) > RTE_PMD_IXGBE_BYPASS_MODE_NONE &&  \
        (x) < RTE_PMD_IXGBE_BYPASS_MODE_NUM)

enum {
        RTE_PMD_IXGBE_BYPASS_EVENT_NONE,
        RTE_PMD_IXGBE_BYPASS_EVENT_START,
        RTE_PMD_IXGBE_BYPASS_EVENT_OS_ON = RTE_PMD_IXGBE_BYPASS_EVENT_START,
        RTE_PMD_IXGBE_BYPASS_EVENT_POWER_ON,
        RTE_PMD_IXGBE_BYPASS_EVENT_OS_OFF,
        RTE_PMD_IXGBE_BYPASS_EVENT_POWER_OFF,
        RTE_PMD_IXGBE_BYPASS_EVENT_TIMEOUT,
        RTE_PMD_IXGBE_BYPASS_EVENT_NUM
};

#define RTE_PMD_IXGBE_BYPASS_EVENT_VALID(x)       \
        ((x) > RTE_PMD_IXGBE_BYPASS_EVENT_NONE && \
        (x) < RTE_PMD_IXGBE_BYPASS_MODE_NUM)

enum {
        RTE_PMD_IXGBE_BYPASS_TMT_OFF,     /* timeout disabled. */
        RTE_PMD_IXGBE_BYPASS_TMT_1_5_SEC, /* timeout for 1.5 seconds */
        RTE_PMD_IXGBE_BYPASS_TMT_2_SEC,   /* timeout for 2 seconds */
        RTE_PMD_IXGBE_BYPASS_TMT_3_SEC,   /* timeout for 3 seconds */
        RTE_PMD_IXGBE_BYPASS_TMT_4_SEC,   /* timeout for 4 seconds */
        RTE_PMD_IXGBE_BYPASS_TMT_8_SEC,   /* timeout for 8 seconds */
        RTE_PMD_IXGBE_BYPASS_TMT_16_SEC,  /* timeout for 16 seconds */
        RTE_PMD_IXGBE_BYPASS_TMT_32_SEC,  /* timeout for 32 seconds */
        RTE_PMD_IXGBE_BYPASS_TMT_NUM
};

#define RTE_PMD_IXGBE_BYPASS_TMT_VALID(x)       \
        ((x) == RTE_PMD_IXGBE_BYPASS_TMT_OFF || \
        ((x) > RTE_PMD_IXGBE_BYPASS_TMT_OFF &&  \
        (x) < RTE_PMD_IXGBE_BYPASS_TMT_NUM))

#endif /* _PMD_IXGBE_H_ */