rte_dmadev_pmd.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2021 HiSilicon Limited
 */
 
#ifndef RTE_DMADEV_PMD_H
#define RTE_DMADEV_PMD_H

 
#include <dev_driver.h>
 
#include <rte_compat.h>
#include "rte_dmadev.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct rte_dma_dev;

typedef int (*rte_dma_info_get_t)(const struct rte_dma_dev *dev,
                  struct rte_dma_info *dev_info,
                  uint32_t info_sz);

typedef int (*rte_dma_configure_t)(struct rte_dma_dev *dev,
                   const struct rte_dma_conf *dev_conf,
                   uint32_t conf_sz);

typedef int (*rte_dma_start_t)(struct rte_dma_dev *dev);

typedef int (*rte_dma_stop_t)(struct rte_dma_dev *dev);

typedef int (*rte_dma_close_t)(struct rte_dma_dev *dev);

typedef int (*rte_dma_vchan_setup_t)(struct rte_dma_dev *dev, uint16_t vchan,
                const struct rte_dma_vchan_conf *conf,
                uint32_t conf_sz);

typedef int (*rte_dma_stats_get_t)(const struct rte_dma_dev *dev,
            uint16_t vchan, struct rte_dma_stats *stats,
            uint32_t stats_sz);

typedef int (*rte_dma_stats_reset_t)(struct rte_dma_dev *dev, uint16_t vchan);

typedef int (*rte_dma_vchan_status_t)(const struct rte_dma_dev *dev, uint16_t vchan,
        enum rte_dma_vchan_status *status);

typedef int (*rte_dma_dump_t)(const struct rte_dma_dev *dev, FILE *f);

typedef int (*rte_dma_access_pair_group_create_t)(const struct rte_dma_dev *dev,
                          rte_uuid_t domain_id, rte_uuid_t token,
                          int16_t *group_id,
                          rte_dma_access_pair_group_event_cb_t cb);

typedef int (*rte_dma_access_pair_group_destroy_t)(const struct rte_dma_dev *dev,
                           int16_t group_id);

typedef int (*rte_dma_access_pair_group_join_t)(const struct rte_dma_dev *dev, rte_uuid_t domain_id,
                        rte_uuid_t token, int16_t group_id,
                        rte_dma_access_pair_group_event_cb_t cb);

typedef int (*rte_dma_access_pair_group_leave_t)(const struct rte_dma_dev *dev, int16_t group_id);

typedef int (*rte_dma_access_pair_group_handler_get_t)(const struct rte_dma_dev *dev,
                               int16_t group_id, rte_uuid_t domain_id,
                               uint16_t *handler);

struct rte_dma_dev_ops {
    rte_dma_info_get_t         dev_info_get;
    rte_dma_configure_t        dev_configure;
    rte_dma_start_t            dev_start;
    rte_dma_stop_t             dev_stop;
    rte_dma_close_t            dev_close;
 
    rte_dma_vchan_setup_t      vchan_setup;
 
    rte_dma_stats_get_t        stats_get;
    rte_dma_stats_reset_t      stats_reset;
 
    rte_dma_vchan_status_t     vchan_status;
    rte_dma_dump_t             dev_dump;
 
    rte_dma_access_pair_group_create_t  access_pair_group_create;
    rte_dma_access_pair_group_destroy_t access_pair_group_destroy;
    rte_dma_access_pair_group_join_t    access_pair_group_join;
    rte_dma_access_pair_group_leave_t   access_pair_group_leave;
    rte_dma_access_pair_group_handler_get_t access_pair_group_handler_get;
};

struct __rte_cache_aligned rte_dma_dev_data {
    char dev_name[RTE_DEV_NAME_MAX_LEN]; 
    int16_t dev_id; 
    int16_t numa_node; 
    void *dev_private; 
    struct rte_dma_conf dev_conf; 
    __extension__
    uint8_t dev_started : 1; 
    uint64_t reserved[2]; 
};

enum rte_dma_dev_state {
    RTE_DMA_DEV_UNUSED = 0, 
    RTE_DMA_DEV_REGISTERED,
    RTE_DMA_DEV_READY,
};

struct __rte_cache_aligned rte_dma_dev {
    struct rte_device *device;
    struct rte_dma_dev_data *data; 
    struct rte_dma_fp_object *fp_obj;
    const struct rte_dma_dev_ops *dev_ops;
    enum rte_dma_dev_state state; 
    uint64_t reserved[2]; 
};

__rte_internal
struct rte_dma_dev *rte_dma_pmd_allocate(const char *name, int numa_node,
                     size_t private_data_size);

__rte_internal
int rte_dma_pmd_release(const char *name);

__rte_internal
struct rte_dma_dev *rte_dma_pmd_get_dev_by_id(int16_t dev_id);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTE_DMADEV_PMD_H */