txbuff.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2019-2022 Intel Corporation.
 */
 
#ifndef __TXBUFF_H
#define __TXBUFF_H
 
#include <stdint.h>            // for uint16_t, uint32_t
#include <cne_common.h>        // for CNDP_API, CNE_STD_C11
#include <pktmbuf.h>           // for pktmbuf_t
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct txbuff;
 
typedef void (*txbuff_error_fn)(struct txbuff *buffer, uint16_t unsent, uint16_t sent);
 
typedef struct txbuff {
    CNE_STD_C11
    union {
        void *info;        
        uint16_t lport_id; 
    };
    txbuff_error_fn error_cb; 
    void *userdata;           
    uint32_t txtype;          
    uint16_t size;            
    uint16_t length;          
    pktmbuf_t *pkts[];        
} txbuff_t;
 
enum { TXBUFF_PKTDEV_FLAG = 0, TXBUFF_XSKDEV_FLAG = 1 };
 
#define TXBUFF_SIZE(sz) (sizeof(txbuff_t) + (sz) * sizeof(pktmbuf_t *))
 
CNDP_API txbuff_t *txbuff_pktdev_create(uint16_t size, txbuff_error_fn cbfn, void *cb_arg,
                                        uint16_t lport_id);
 
CNDP_API txbuff_t *txbuff_xskdev_create(uint16_t size, txbuff_error_fn cbfn, void *cb_arg,
                                        void *xinfo);
 
CNDP_API void txbuff_free(txbuff_t *buffer);
 
CNDP_API int txbuff_set_err_callback(txbuff_t *buffer, txbuff_error_fn callback, void *userdata);
 
CNDP_API void txbuff_drop_callback(txbuff_t *buffer, uint16_t sent, uint16_t unsent);
 
CNDP_API void txbuff_count_callback(txbuff_t *buffer, uint16_t sent, uint16_t unsent);
 
CNDP_API uint16_t txbuff_flush(txbuff_t *buffer);
 
CNDP_API uint16_t txbuff_add(txbuff_t *buffer, pktmbuf_t *tx_pkt);
 
static inline int
txbuff_count(txbuff_t *buffer)
{
    return (!buffer) ? -1 : buffer->length;
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* __TXBUFF_H */