rte_bbdev_pmd.h

Go to the documentation of this file.

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

#ifndef _RTE_BBDEV_PMD_H_
#define _RTE_BBDEV_PMD_H_

#include <stdint.h>
#include <rte_log.h>

#include "rte_bbdev.h"

#ifdef __cplusplus
extern "C" {
#endif

#define RTE_BBDEV_DEFAULT_MAX_NB_QUEUES RTE_MAX_LCORE

#define RTE_BBDEV_QUEUE_SIZE_LIMIT 16384

struct rte_bbdev *
rte_bbdev_allocate(const char *name);

int
rte_bbdev_release(struct rte_bbdev *bbdev);

struct rte_bbdev *
rte_bbdev_get_named_dev(const char *name);

typedef int (*rte_bbdev_setup_queues_t)(struct rte_bbdev *dev,
        uint16_t num_queues, int socket_id);

typedef int (*rte_bbdev_intr_enable_t)(struct rte_bbdev *dev);

typedef int (*rte_bbdev_queue_setup_t)(struct rte_bbdev *dev,
        uint16_t queue_id, const struct rte_bbdev_queue_conf *conf);

/*
 * @internal
 * Function to release memory resources allocated for a device queue.
 */
typedef int (*rte_bbdev_queue_release_t)(struct rte_bbdev *dev,
        uint16_t queue_id);

typedef int (*rte_bbdev_start_t)(struct rte_bbdev *dev);

typedef void (*rte_bbdev_stop_t)(struct rte_bbdev *dev);

typedef int (*rte_bbdev_close_t)(struct rte_bbdev *dev);

typedef int (*rte_bbdev_queue_start_t)(struct rte_bbdev *dev,
        uint16_t queue_id);

typedef int (*rte_bbdev_queue_stop_t)(struct rte_bbdev *dev, uint16_t queue_id);

typedef void (*rte_bbdev_stats_get_t)(struct rte_bbdev *dev,
        struct rte_bbdev_stats *stats);

typedef void (*rte_bbdev_stats_reset_t)(struct rte_bbdev *dev);

typedef void (*rte_bbdev_info_get_t)(struct rte_bbdev *dev,
        struct rte_bbdev_driver_info *dev_info);

/*
 * @internal
 * Function to enable interrupt for next op on a queue of a device.
 */
typedef int (*rte_bbdev_queue_intr_enable_t)(struct rte_bbdev *dev,
                    uint16_t queue_id);

/*
 * @internal
 * Function to disable interrupt for next op on a queue of a device.
 */
typedef int (*rte_bbdev_queue_intr_disable_t)(struct rte_bbdev *dev,
                    uint16_t queue_id);

/*
 * @internal
 * Function to dump previous operations on a queue of a device.
 */
typedef int (*rte_bbdev_queue_ops_dump_t)(struct rte_bbdev *dev,
        uint16_t queue_id, FILE *file);

struct rte_bbdev_ops {
    rte_bbdev_setup_queues_t setup_queues;
    rte_bbdev_intr_enable_t intr_enable;
    rte_bbdev_start_t start;
    rte_bbdev_stop_t stop;
    rte_bbdev_close_t close;

    rte_bbdev_info_get_t info_get;
    rte_bbdev_stats_get_t stats_get;
    rte_bbdev_stats_reset_t stats_reset;

    rte_bbdev_queue_setup_t queue_setup;
    rte_bbdev_queue_release_t queue_release;
    rte_bbdev_queue_start_t queue_start;
    rte_bbdev_queue_stop_t queue_stop;

    rte_bbdev_queue_intr_enable_t queue_intr_enable;
    rte_bbdev_queue_intr_disable_t queue_intr_disable;
    rte_bbdev_queue_ops_dump_t queue_ops_dump;
};

void
rte_bbdev_pmd_callback_process(struct rte_bbdev *dev,
    enum rte_bbdev_event_type event, void *ret_param);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_BBDEV_PMD_H_ */