pktdev_api.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2019-2022 Intel Corporation.
 */
 
#ifndef __PKTDEV_API_H
#define __PKTDEV_API_H
 
#include <stdbool.h>        // for bool, false, true
#include <stdint.h>         // for uint16_t
#include <stdio.h>          // for NULL, FILE
 
#include <cne_common.h>          // for CNDP_API
#include <cne_lport.h>           // for lport_cfg_t, lport_stats_t
#include <netdev_funcs.h>        // for struct offloads
#include <pktmbuf.h>             // for pktmbuf_t
 
struct ether_addr;
struct cne_pktdev;
struct pktdev_info;
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum {
    CFG_CREATE_NONE = 0,
    CFG_CREATE_RX,
    CFG_CREATE_TX,
    CFG_CREATE_MASK,
    CFG_SHARE_MEMPOOL,
};
 
/* Macros to check for invalid function pointers */
#define FUNC_PTR_OR_ERR_RET(func, retval) \
    do {                                  \
        if ((func) == NULL)               \
            return retval;                \
    } while (0)
 
#define FUNC_PTR_OR_RET(func) \
    do {                      \
        if ((func) == NULL)   \
            return;           \
    } while (0)
 
#define PKTDEV_STARTED (1 << 1) 
typedef uint16_t (*cne_rx_callback_fn)(uint16_t lport_id, pktmbuf_t *pkts[], uint16_t nb_pkts,
                                       uint16_t max_pkts, void *user_param);
 
typedef uint16_t (*cne_tx_callback_fn)(uint16_t lport_id, pktmbuf_t *pkts[], uint16_t nb_pkts,
                                       void *user_param);
 
CNDP_API uint16_t pktdev_port_count(void);
 
CNDP_API int pktdev_start(uint16_t lport_id);
 
CNDP_API int pktdev_stop(uint16_t lport_id);
 
CNDP_API int pktdev_set_admin_state_up(uint16_t lport_id);
 
CNDP_API int pktdev_set_admin_state_down(uint16_t lport_id);
 
CNDP_API int pktdev_close(uint16_t lport_id);
 
CNDP_API int pktdev_close_all(void);
 
CNDP_API int pktdev_stats_get(uint16_t lport_id, lport_stats_t *stats);
 
CNDP_API int pktdev_stats_reset(uint16_t lport_id);
 
CNDP_API int pktdev_macaddr_get(uint16_t lport_id, struct ether_addr *mac_addr);
 
CNDP_API int pktdev_offloads_get(uint16_t lport_id, struct offloads *off);
 
CNDP_API int pktdev_info_get(uint16_t lport_id, struct pktdev_info *dev_info);
 
CNDP_API int pktdev_get_mtu(uint16_t lport_id, uint16_t *mtu);
 
CNDP_API int pktdev_set_mtu(uint16_t lport_id, uint16_t mtu);
 
CNDP_API int pktdev_get_name_by_port(uint16_t lport_id, char *name, uint32_t len);
 
CNDP_API int pktdev_get_port_by_name(const char *name, uint16_t *lport_id);
 
CNDP_API const char *pktdev_port_name(uint16_t lport_id);
 
CNDP_API int pktdev_is_valid_port(uint16_t lport_id);
 
CNDP_API int pktdev_socket_id(uint16_t lport_id);
 
CNDP_API struct cne_pktdev *pktdev_get(uint16_t lport_id);
 
CNDP_API int pktdev_portid(struct cne_pktdev *dev);
 
CNDP_API int pktdev_port_setup(lport_cfg_t *c);
 
CNDP_API void lport_cfg_dump(FILE *f, lport_cfg_t *c);
 
CNDP_API bool pktdev_admin_state(uint16_t lport_id);
 
CNDP_API int pktdev_admin_state_set(uint16_t lport_id, bool state);
 
#define pktdev_admin_state_up(_pid)   pktdev_admin_state_set(_pid, true)
#define pktdev_admin_state_down(_pid) pktdev_admin_state_set(_pid, false)
 
CNDP_API void *pktdev_arg_get(uint16_t lport_id);
 
CNDP_API int pktdev_buf_alloc(int lport_id, pktmbuf_t **bufs, uint16_t nb_bufs);
 
#ifdef __cplusplus
}
#endif
 
#endif /* __PKTDEV_API_H */