rte_compressdev_pmd.h

Go to the documentation of this file.

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

#ifndef _RTE_COMPRESSDEV_PMD_H_
#define _RTE_COMPRESSDEV_PMD_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <string.h>

#include <rte_dev.h>
#include <rte_common.h>

#include "rte_compressdev.h"
#include "rte_compressdev_internal.h"

#define RTE_COMPRESSDEV_PMD_NAME_ARG            ("name")
#define RTE_COMPRESSDEV_PMD_SOCKET_ID_ARG       ("socket_id")

static const char * const compressdev_pmd_valid_params[] = {
    RTE_COMPRESSDEV_PMD_NAME_ARG,
    RTE_COMPRESSDEV_PMD_SOCKET_ID_ARG
};

struct rte_compressdev_pmd_init_params {
    char name[RTE_COMPRESSDEV_NAME_MAX_LEN];
    int socket_id;
};

struct rte_compressdev_global {
    struct rte_compressdev *devs;   
    struct rte_compressdev_data *data[RTE_COMPRESS_MAX_DEVS];
    uint8_t nb_devs;        
    uint8_t max_devs;       
};

__rte_experimental
struct rte_compressdev *
rte_compressdev_pmd_get_named_dev(const char *name);

typedef int (*compressdev_configure_t)(struct rte_compressdev *dev,
        struct rte_compressdev_config *config);

typedef int (*compressdev_start_t)(struct rte_compressdev *dev);

typedef void (*compressdev_stop_t)(struct rte_compressdev *dev);

typedef int (*compressdev_close_t)(struct rte_compressdev *dev);


typedef void (*compressdev_stats_get_t)(struct rte_compressdev *dev,
                struct rte_compressdev_stats *stats);


typedef void (*compressdev_stats_reset_t)(struct rte_compressdev *dev);


typedef void (*compressdev_info_get_t)(struct rte_compressdev *dev,
                struct rte_compressdev_info *dev_info);

typedef int (*compressdev_queue_pair_setup_t)(struct rte_compressdev *dev,
        uint16_t qp_id, uint32_t max_inflight_ops, int socket_id);

typedef int (*compressdev_queue_pair_release_t)(struct rte_compressdev *dev,
        uint16_t qp_id);

typedef int (*compressdev_stream_create_t)(struct rte_compressdev *dev,
        const struct rte_comp_xform *xform, void **stream);

typedef int (*compressdev_stream_free_t)(struct rte_compressdev *dev,
        void *stream);

typedef int (*compressdev_private_xform_create_t)(struct rte_compressdev *dev,
        const struct rte_comp_xform *xform, void **private_xform);

typedef int (*compressdev_private_xform_free_t)(struct rte_compressdev *dev,
        void *private_xform);

struct rte_compressdev_ops {
    compressdev_configure_t dev_configure;  
    compressdev_start_t dev_start;      
    compressdev_stop_t dev_stop;        
    compressdev_close_t dev_close;      
    compressdev_info_get_t dev_infos_get;   
    compressdev_stats_get_t stats_get;
    compressdev_stats_reset_t stats_reset;
    compressdev_queue_pair_setup_t queue_pair_setup;
    compressdev_queue_pair_release_t queue_pair_release;
    compressdev_stream_create_t stream_create;
    compressdev_stream_free_t stream_free;
    compressdev_private_xform_create_t private_xform_create;
    compressdev_private_xform_free_t private_xform_free;
};

__rte_experimental
struct rte_compressdev *
rte_compressdev_pmd_allocate(const char *name, int socket_id);

__rte_experimental
int
rte_compressdev_pmd_release_device(struct rte_compressdev *dev);


__rte_experimental
int
rte_compressdev_pmd_parse_input_args(
        struct rte_compressdev_pmd_init_params *params,
        const char *args);

__rte_experimental
struct rte_compressdev *
rte_compressdev_pmd_create(const char *name,
        struct rte_device *device,
        size_t private_data_size,
        struct rte_compressdev_pmd_init_params *params);

__rte_experimental
int
rte_compressdev_pmd_destroy(struct rte_compressdev *dev);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_COMPRESSDEV_PMD_H_ */