rte_ethdev_core.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2017 Intel Corporation
 */

#ifndef _RTE_ETHDEV_CORE_H_
#define _RTE_ETHDEV_CORE_H_

struct rte_eth_dev_callback;
TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);

/*
 * Definitions of all functions exported by an Ethernet driver through the
 * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
 * structure associated with an Ethernet device.
 */
struct rte_eth_dev;

typedef int  (*eth_dev_configure_t)(struct rte_eth_dev *dev);
typedef int  (*eth_dev_start_t)(struct rte_eth_dev *dev);
typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
typedef int  (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
typedef int  (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
typedef int (*eth_dev_reset_t)(struct rte_eth_dev *dev);
typedef int (*eth_is_removed_t)(struct rte_eth_dev *dev);
typedef int (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);

typedef int (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);

typedef int (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);

typedef int (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);

typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
                int wait_to_complete);
typedef int (*eth_stats_get_t)(struct rte_eth_dev *dev,
                struct rte_eth_stats *igb_stats);
typedef int (*eth_stats_reset_t)(struct rte_eth_dev *dev);

typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
    struct rte_eth_xstat *stats, unsigned n);
typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev,
                      const uint64_t *ids,
                      uint64_t *values,
                      unsigned int n);
typedef int (*eth_xstats_reset_t)(struct rte_eth_dev *dev);

typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev,
    struct rte_eth_xstat_name *xstats_names, unsigned size);
typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev,
    struct rte_eth_xstat_name *xstats_names, const uint64_t *ids,
    unsigned int size);
typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
                         uint16_t queue_id,
                         uint8_t stat_idx,
                         uint8_t is_rx);
typedef int (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
                   struct rte_eth_dev_info *dev_info);
typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
typedef int (*eth_dev_ptypes_set_t)(struct rte_eth_dev *dev,
                     uint32_t ptype_mask);

typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
                    uint16_t queue_id);
typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
                    uint16_t queue_id);
typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
                    uint16_t rx_queue_id,
                    uint16_t nb_rx_desc,
                    unsigned int socket_id,
                    const struct rte_eth_rxconf *rx_conf,
                    struct rte_mempool *mb_pool);
typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
                    uint16_t tx_queue_id,
                    uint16_t nb_tx_desc,
                    unsigned int socket_id,
                    const struct rte_eth_txconf *tx_conf);
typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
                    uint16_t rx_queue_id);
typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
                    uint16_t rx_queue_id);
typedef void (*eth_queue_release_t)(void *queue);
typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
                     uint16_t rx_queue_id);
typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
typedef int (*eth_rx_descriptor_status_t)(void *rxq, uint16_t offset);
typedef int (*eth_tx_descriptor_status_t)(void *txq, uint16_t offset);
typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
                     char *fw_version, size_t fw_size);
typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
    uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);

typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
    uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);

typedef int (*eth_burst_mode_get_t)(struct rte_eth_dev *dev,
    uint16_t queue_id, struct rte_eth_burst_mode *mode);

typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
                  uint16_t vlan_id,
                  int on);
typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
                   enum rte_vlan_type type, uint16_t tpid);
typedef int (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
                   uint16_t vlan_id,
                   int on);
typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
                  uint16_t rx_queue_id,
                  int on);
typedef uint16_t (*eth_rx_burst_t)(void *rxq,
                   struct rte_mbuf **rx_pkts,
                   uint16_t nb_pkts);
typedef uint16_t (*eth_tx_burst_t)(void *txq,
                   struct rte_mbuf **tx_pkts,
                   uint16_t nb_pkts);
typedef uint16_t (*eth_tx_prep_t)(void *txq,
                   struct rte_mbuf **tx_pkts,
                   uint16_t nb_pkts);
typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
                   struct rte_eth_fc_conf *fc_conf);
typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
                   struct rte_eth_fc_conf *fc_conf);
typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
                struct rte_eth_pfc_conf *pfc_conf);
typedef int (*reta_update_t)(struct rte_eth_dev *dev,
                 struct rte_eth_rss_reta_entry64 *reta_conf,
                 uint16_t reta_size);
typedef int (*reta_query_t)(struct rte_eth_dev *dev,
                struct rte_eth_rss_reta_entry64 *reta_conf,
                uint16_t reta_size);
typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
                 struct rte_eth_rss_conf *rss_conf);
typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
                   struct rte_eth_rss_conf *rss_conf);
typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
typedef int (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
                  struct rte_ether_addr *mac_addr,
                  uint32_t index,
                  uint32_t vmdq);
typedef int (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
                  struct rte_ether_addr *mac_addr);
typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
                  struct rte_ether_addr *mac_addr,
                  uint8_t on);
typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
                  uint8_t on);
typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
                uint16_t queue_idx,
                uint16_t tx_rate);
typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
                  struct rte_eth_mirror_conf *mirror_conf,
                  uint8_t rule_id,
                  uint8_t on);
typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
                  uint8_t rule_id);
typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
                     struct rte_eth_udp_tunnel *tunnel_udp);
typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
                     struct rte_eth_udp_tunnel *tunnel_udp);
typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
                      struct rte_ether_addr *mc_addr_set,
                      uint32_t nb_mc_addr);
typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
                        struct timespec *timestamp,
                        uint32_t flags);
typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
                        struct timespec *timestamp);
typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
                      struct timespec *timestamp);
typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
                       const struct timespec *timestamp);
typedef int (*eth_read_clock)(struct rte_eth_dev *dev,
                      uint64_t *timestamp);
typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
                struct rte_dev_reg_info *info);
typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
                struct rte_dev_eeprom_info *info);
typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
                struct rte_dev_eeprom_info *info);
typedef int (*eth_get_module_info_t)(struct rte_eth_dev *dev,
                     struct rte_eth_dev_module_info *modinfo);
typedef int (*eth_get_module_eeprom_t)(struct rte_eth_dev *dev,
                       struct rte_dev_eeprom_info *info);
typedef int (*eth_l2_tunnel_eth_type_conf_t)
    (struct rte_eth_dev *dev, struct rte_eth_l2_tunnel_conf *l2_tunnel);
typedef int (*eth_l2_tunnel_offload_set_t)
    (struct rte_eth_dev *dev,
     struct rte_eth_l2_tunnel_conf *l2_tunnel,
     uint32_t mask,
     uint8_t en);
typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
                 enum rte_filter_type filter_type,
                 enum rte_filter_op filter_op,
                 void *arg);
typedef int (*eth_tm_ops_get_t)(struct rte_eth_dev *dev, void *ops);
typedef int (*eth_mtr_ops_get_t)(struct rte_eth_dev *dev, void *ops);
typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
                 struct rte_eth_dcb_info *dcb_info);
typedef int (*eth_pool_ops_supported_t)(struct rte_eth_dev *dev,
                        const char *pool);
typedef int (*eth_hairpin_cap_get_t)(struct rte_eth_dev *dev,
                     struct rte_eth_hairpin_cap *cap);

typedef int (*eth_rx_hairpin_queue_setup_t)
    (struct rte_eth_dev *dev, uint16_t rx_queue_id,
     uint16_t nb_rx_desc,
     const struct rte_eth_hairpin_conf *conf);

typedef int (*eth_tx_hairpin_queue_setup_t)
    (struct rte_eth_dev *dev, uint16_t tx_queue_id,
     uint16_t nb_tx_desc,
     const struct rte_eth_hairpin_conf *hairpin_conf);

struct eth_dev_ops {
    eth_dev_configure_t        dev_configure; 
    eth_dev_start_t            dev_start;     
    eth_dev_stop_t             dev_stop;      
    eth_dev_set_link_up_t      dev_set_link_up;   
    eth_dev_set_link_down_t    dev_set_link_down; 
    eth_dev_close_t            dev_close;     
    eth_dev_reset_t        dev_reset;     
    eth_link_update_t          link_update;   
    eth_is_removed_t           is_removed;
    eth_promiscuous_enable_t   promiscuous_enable; 
    eth_promiscuous_disable_t  promiscuous_disable;
    eth_allmulticast_enable_t  allmulticast_enable;
    eth_allmulticast_disable_t allmulticast_disable;
    eth_mac_addr_remove_t      mac_addr_remove; 
    eth_mac_addr_add_t         mac_addr_add;  
    eth_mac_addr_set_t         mac_addr_set;  
    eth_set_mc_addr_list_t     set_mc_addr_list; 
    mtu_set_t                  mtu_set;       
    eth_stats_get_t            stats_get;     
    eth_stats_reset_t          stats_reset;   
    eth_xstats_get_t           xstats_get;    
    eth_xstats_reset_t         xstats_reset;  
    eth_xstats_get_names_t     xstats_get_names;
    eth_queue_stats_mapping_set_t queue_stats_mapping_set;
    eth_dev_infos_get_t        dev_infos_get; 
    eth_rxq_info_get_t         rxq_info_get; 
    eth_txq_info_get_t         txq_info_get; 
    eth_burst_mode_get_t       rx_burst_mode_get; 
    eth_burst_mode_get_t       tx_burst_mode_get; 
    eth_fw_version_get_t       fw_version_get; 
    eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
    eth_dev_ptypes_set_t dev_ptypes_set;
    vlan_filter_set_t          vlan_filter_set; 
    vlan_tpid_set_t            vlan_tpid_set; 
    vlan_strip_queue_set_t     vlan_strip_queue_set; 
    vlan_offload_set_t         vlan_offload_set; 
    vlan_pvid_set_t            vlan_pvid_set; 
    eth_queue_start_t          rx_queue_start;
    eth_queue_stop_t           rx_queue_stop; 
    eth_queue_start_t          tx_queue_start;
    eth_queue_stop_t           tx_queue_stop; 
    eth_rx_queue_setup_t       rx_queue_setup;
    eth_queue_release_t        rx_queue_release; 
    eth_rx_queue_count_t       rx_queue_count;
    eth_rx_descriptor_done_t   rx_descriptor_done; 
    eth_rx_descriptor_status_t rx_descriptor_status;
    eth_tx_descriptor_status_t tx_descriptor_status;
    /*
     * Static inline functions use functions ABOVE this comment.
     * New dev_ops functions should be added BELOW to avoid breaking ABI.
     */
    eth_rx_enable_intr_t       rx_queue_intr_enable;  
    eth_rx_disable_intr_t      rx_queue_intr_disable; 
    eth_tx_queue_setup_t       tx_queue_setup;
    eth_queue_release_t        tx_queue_release; 
    eth_tx_done_cleanup_t      tx_done_cleanup;
    eth_dev_led_on_t           dev_led_on;    
    eth_dev_led_off_t          dev_led_off;   
    flow_ctrl_get_t            flow_ctrl_get; 
    flow_ctrl_set_t            flow_ctrl_set; 
    priority_flow_ctrl_set_t   priority_flow_ctrl_set; 
    eth_uc_hash_table_set_t    uc_hash_table_set; 
    eth_uc_all_hash_table_set_t uc_all_hash_table_set; 
    eth_mirror_rule_set_t      mirror_rule_set; 
    eth_mirror_rule_reset_t    mirror_rule_reset; 
    eth_udp_tunnel_port_add_t  udp_tunnel_port_add; 
    eth_udp_tunnel_port_del_t  udp_tunnel_port_del; 
    eth_l2_tunnel_eth_type_conf_t l2_tunnel_eth_type_conf;
    eth_l2_tunnel_offload_set_t   l2_tunnel_offload_set;
    eth_set_queue_rate_limit_t set_queue_rate_limit; 
    rss_hash_update_t          rss_hash_update; 
    rss_hash_conf_get_t        rss_hash_conf_get; 
    reta_update_t              reta_update;   
    reta_query_t               reta_query;    
    eth_get_reg_t              get_reg;           
    eth_get_eeprom_length_t    get_eeprom_length; 
    eth_get_eeprom_t           get_eeprom;        
    eth_set_eeprom_t           set_eeprom;        
    eth_get_module_info_t      get_module_info;
    eth_get_module_eeprom_t    get_module_eeprom;
    eth_filter_ctrl_t          filter_ctrl; 
    eth_get_dcb_info           get_dcb_info; 
    eth_timesync_enable_t      timesync_enable;
    eth_timesync_disable_t     timesync_disable;
    eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
    eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
    eth_timesync_adjust_time   timesync_adjust_time; 
    eth_timesync_read_time     timesync_read_time; 
    eth_timesync_write_time    timesync_write_time; 
    eth_read_clock             read_clock;

    eth_xstats_get_by_id_t     xstats_get_by_id;
    eth_xstats_get_names_by_id_t xstats_get_names_by_id;
    eth_tm_ops_get_t tm_ops_get;
    eth_mtr_ops_get_t mtr_ops_get;
    eth_pool_ops_supported_t pool_ops_supported;
    eth_hairpin_cap_get_t hairpin_cap_get;
    eth_rx_hairpin_queue_setup_t rx_hairpin_queue_setup;
    eth_tx_hairpin_queue_setup_t tx_hairpin_queue_setup;
};

struct rte_eth_rxtx_callback {
    struct rte_eth_rxtx_callback *next;
    union{
        rte_rx_callback_fn rx;
        rte_tx_callback_fn tx;
    } fn;
    void *param;
};

struct rte_eth_dev {
    eth_rx_burst_t rx_pkt_burst; 
    eth_tx_burst_t tx_pkt_burst; 
    eth_tx_prep_t tx_pkt_prepare; 
    struct rte_eth_dev_data *data;  
    void *process_private; 
    const struct eth_dev_ops *dev_ops; 
    struct rte_device *device; 
    struct rte_intr_handle *intr_handle; 
    struct rte_eth_dev_cb_list link_intr_cbs;
    struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
    struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
    enum rte_eth_dev_state state; 
    void *security_ctx; 
    uint64_t reserved_64s[4]; 
    void *reserved_ptrs[4];   
} __rte_cache_aligned;

struct rte_eth_dev_sriov;
struct rte_eth_dev_owner;

struct rte_eth_dev_data {
    char name[RTE_ETH_NAME_MAX_LEN]; 
    void **rx_queues; 
    void **tx_queues; 
    uint16_t nb_rx_queues; 
    uint16_t nb_tx_queues; 
    struct rte_eth_dev_sriov sriov;    
    void *dev_private;
    struct rte_eth_link dev_link;   
    struct rte_eth_conf dev_conf;   
    uint16_t mtu;                   
    uint32_t min_rx_buf_size;
    uint64_t rx_mbuf_alloc_failed; 
    struct rte_ether_addr *mac_addrs;
    uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
    struct rte_ether_addr *hash_mac_addrs;
    uint16_t port_id;           
    __extension__
    uint8_t promiscuous   : 1, 
        scattered_rx : 1,  
        all_multicast : 1, 
        dev_started : 1,   
        lro         : 1;   
    uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
    uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
    uint32_t dev_flags;             
    enum rte_kernel_driver kdrv;    
    int numa_node;                  
    struct rte_vlan_filter_conf vlan_filter_conf;
    struct rte_eth_dev_owner owner; 
    uint16_t representor_id;
    uint64_t reserved_64s[4]; 
    void *reserved_ptrs[4];   
} __rte_cache_aligned;

extern struct rte_eth_dev rte_eth_devices[];

#endif /* _RTE_ETHDEV_CORE_H_ */