pktdev_core.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2019-2022 Intel Corporation
 */
 
#ifndef __PKTDEV_CORE_H_
#define __PKTDEV_CORE_H_
 
#include <stdbool.h>
/*
 * Definitions of all functions exported by an Ethernet driver through the
 * the generic structure of type *pktdev_ops* supplied in the *cne_pktdev*
 * structure associated with an Ethernet device.
 */
struct cne_pktdev;
 
typedef int (*pkt_dev_start_t)(struct cne_pktdev *dev);
typedef void (*pkt_dev_stop_t)(struct cne_pktdev *dev);
typedef int (*pkt_dev_admin_st_up_t)(struct cne_pktdev *dev);
typedef int (*pkt_dev_admin_st_down_t)(struct cne_pktdev *dev);
typedef void (*pkt_dev_close_t)(struct cne_pktdev *dev);
typedef int (*pkt_dev_infos_get_t)(struct cne_pktdev *dev, struct pktdev_info *dev_info);
typedef int (*eth_link_update_t)(struct cne_pktdev *dev, int wait_to_complete);
typedef int (*eth_stats_get_t)(struct cne_pktdev *dev, lport_stats_t *igb_stats);
typedef int (*eth_stats_reset_t)(struct cne_pktdev *dev);
 
typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
 
typedef uint16_t (*eth_rx_burst_t)(void *rxq, pktmbuf_t **rx_pkts, uint16_t nb_pkts);
 
typedef uint16_t (*eth_tx_burst_t)(void *txq, pktmbuf_t **tx_pkts, uint16_t nb_pkts);
 
typedef uint16_t (*eth_tx_prep_t)(void *txq, pktmbuf_t **tx_pkts, uint16_t nb_pkts);
 
typedef int (*eth_mac_addr_set_t)(struct cne_pktdev *dev, struct ether_addr *mac_addr);
 
typedef int (*eth_pkt_alloc)(struct cne_pktdev *dev, pktmbuf_t **bufs, uint16_t nb_pkts);
 
enum pktdev_state {
    PKTDEV_UNUSED = 0, 
    PKTDEV_ACTIVE,     
};
 
struct pktdev_ops {
    pkt_dev_admin_st_up_t admin_state_up;     
    pkt_dev_admin_st_down_t admin_state_down; 
    pkt_dev_close_t dev_close;                
    pkt_dev_infos_get_t dev_infos_get;        
    eth_mac_addr_set_t mac_addr_set;          
    eth_link_update_t link_update;            
    eth_stats_get_t stats_get;                
    eth_stats_reset_t stats_reset;            
    eth_tx_done_cleanup_t tx_done_cleanup;    
    eth_pkt_alloc pkt_alloc;                  
};
 
struct cne_pktdev {
    eth_rx_burst_t rx_pkt_burst;      
    eth_tx_burst_t tx_pkt_burst;      
    eth_tx_prep_t tx_pkt_prepare;     
    struct pktdev_data *data;         
    struct pktdev_driver *drv;        
    void *process_private;            
    const struct pktdev_ops *dev_ops; 
    enum pktdev_state state;          
} __cne_cache_aligned;
 
extern struct cne_pktdev pktdev_devices[CNE_MAX_ETHPORTS];
 
#define PKTDEV_NAME_MAX_LEN 16
struct pktdev_data {
    char name[PKTDEV_NAME_MAX_LEN];   
    char ifname[PKTDEV_NAME_MAX_LEN]; 
    void *rx_queue;                   
    void *tx_queue;                   
    bool admin_state;                 
    void *dev_private;                
    uint32_t min_rx_buf_size;         
    struct ether_addr *mac_addr;      
    uint16_t lport_id;                
    uint16_t numa_node;               
    struct offloads *offloads;        
} __cne_cache_aligned;
 
extern struct cne_pktdev cne_pktdevices[];
 
#endif /* __PKTDEV_CORE_H_ */