rte_event_eth_rx_adapter.h

Go to the documentation of this file.

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

#ifndef _RTE_EVENT_ETH_RX_ADAPTER_
#define _RTE_EVENT_ETH_RX_ADAPTER_

#include <stdint.h>

#include <rte_compat.h>
#include <rte_service.h>

#include "rte_eventdev.h"

#ifdef __cplusplus
extern "C" {
#endif

#define RTE_EVENT_ETH_RX_ADAPTER_MAX_INSTANCE 32

/* struct rte_event_eth_rx_adapter_queue_conf flags definitions */
#define RTE_EVENT_ETH_RX_ADAPTER_QUEUE_FLOW_ID_VALID    0x1

#define RTE_EVENT_ETH_RX_ADAPTER_QUEUE_EVENT_VECTOR 0x2

struct rte_event_eth_rx_adapter_conf {
    uint8_t event_port_id;
    uint32_t max_nb_rx;
};

typedef int (*rte_event_eth_rx_adapter_conf_cb) (uint8_t id, uint8_t dev_id,
            struct rte_event_eth_rx_adapter_conf *conf,
            void *arg);

struct rte_event_eth_rx_adapter_queue_conf {
    uint32_t rx_queue_flags;
    uint16_t servicing_weight;
    struct rte_event ev;
    uint16_t vector_sz;
    uint64_t vector_timeout_ns;
    struct rte_mempool *vector_mp;
    uint16_t event_buf_size;
};

struct rte_event_eth_rx_adapter_queue_stats {
    uint64_t rx_event_buf_count;
    uint64_t rx_event_buf_size;
    uint64_t rx_poll_count;
    uint64_t rx_packets;
    uint64_t rx_dropped;
};

struct rte_event_eth_rx_adapter_stats {
    uint64_t rx_poll_count;
    uint64_t rx_packets;
    uint64_t rx_enq_count;
    uint64_t rx_enq_retry;
    uint64_t rx_dropped;
    uint64_t rx_enq_start_ts;
    uint64_t rx_enq_block_cycles;
    uint64_t rx_enq_end_ts;
    uint64_t rx_intr_packets;
    uint64_t rx_event_buf_count;
    uint64_t rx_event_buf_size;
};

struct rte_event_eth_rx_adapter_vector_limits {
    uint16_t min_sz;
    uint16_t max_sz;
    uint8_t log2_sz;
    uint64_t min_timeout_ns;
    uint64_t max_timeout_ns;
};

struct rte_event_eth_rx_adapter_params {
    uint16_t event_buf_size;
    bool use_queue_event_buf;
};

struct rte_event_eth_rx_adapter_runtime_params {
    uint32_t max_nb_rx;
    uint32_t rsvd[15];
};

typedef uint16_t (*rte_event_eth_rx_adapter_cb_fn)(uint16_t eth_dev_id,
                        uint16_t queue_id,
                        uint32_t enqueue_buf_size,
                        uint32_t enqueue_buf_count,
                        struct rte_event *ev,
                        uint16_t nb_event,
                        void *cb_arg,
                        uint16_t *nb_dropped);

int rte_event_eth_rx_adapter_create_ext(uint8_t id, uint8_t dev_id,
                rte_event_eth_rx_adapter_conf_cb conf_cb,
                void *conf_arg);

int rte_event_eth_rx_adapter_create(uint8_t id, uint8_t dev_id,
                struct rte_event_port_conf *port_config);

int rte_event_eth_rx_adapter_create_with_params(uint8_t id, uint8_t dev_id,
            struct rte_event_port_conf *port_config,
            struct rte_event_eth_rx_adapter_params *rxa_params);

__rte_experimental
int
rte_event_eth_rx_adapter_create_ext_with_params(uint8_t id, uint8_t dev_id,
            rte_event_eth_rx_adapter_conf_cb conf_cb,
            void *conf_arg,
            struct rte_event_eth_rx_adapter_params *rxa_params);

int rte_event_eth_rx_adapter_free(uint8_t id);

int rte_event_eth_rx_adapter_queue_add(uint8_t id,
            uint16_t eth_dev_id,
            int32_t rx_queue_id,
            const struct rte_event_eth_rx_adapter_queue_conf *conf);

int rte_event_eth_rx_adapter_queue_del(uint8_t id, uint16_t eth_dev_id,
                       int32_t rx_queue_id);

int rte_event_eth_rx_adapter_start(uint8_t id);

int rte_event_eth_rx_adapter_stop(uint8_t id);

int rte_event_eth_rx_adapter_stats_get(uint8_t id,
                  struct rte_event_eth_rx_adapter_stats *stats);

int rte_event_eth_rx_adapter_stats_reset(uint8_t id);

int rte_event_eth_rx_adapter_service_id_get(uint8_t id, uint32_t *service_id);

int rte_event_eth_rx_adapter_cb_register(uint8_t id, uint16_t eth_dev_id,
                     rte_event_eth_rx_adapter_cb_fn cb_fn,
                     void *cb_arg);

int rte_event_eth_rx_adapter_vector_limits_get(
    uint8_t dev_id, uint16_t eth_port_id,
    struct rte_event_eth_rx_adapter_vector_limits *limits);

int rte_event_eth_rx_adapter_queue_conf_get(uint8_t id,
            uint16_t eth_dev_id,
            uint16_t rx_queue_id,
            struct rte_event_eth_rx_adapter_queue_conf *queue_conf);

int
rte_event_eth_rx_adapter_queue_stats_get(uint8_t id,
        uint16_t eth_dev_id,
        uint16_t rx_queue_id,
        struct rte_event_eth_rx_adapter_queue_stats *stats);

int
rte_event_eth_rx_adapter_queue_stats_reset(uint8_t id,
        uint16_t eth_dev_id,
        uint16_t rx_queue_id);

int
rte_event_eth_rx_adapter_event_port_get(uint8_t id, uint8_t *event_port_id);

int
rte_event_eth_rx_adapter_instance_get(uint16_t eth_dev_id,
                      uint16_t rx_queue_id,
                      uint8_t *rxa_inst_id);

__rte_experimental
int
rte_event_eth_rx_adapter_runtime_params_init(
        struct rte_event_eth_rx_adapter_runtime_params *params);

__rte_experimental
int
rte_event_eth_rx_adapter_runtime_params_set(uint8_t id,
        struct rte_event_eth_rx_adapter_runtime_params *params);

__rte_experimental
int
rte_event_eth_rx_adapter_runtime_params_get(uint8_t id,
        struct rte_event_eth_rx_adapter_runtime_params *params);

#ifdef __cplusplus
}
#endif
#endif  /* _RTE_EVENT_ETH_RX_ADAPTER_ */