/* SPDX-License-Identifier: BSD-3-Clause * Copyright(c) 2017-2018 Intel Corporation */ #ifndef _RTE_COMPRESSDEV_PMD_H_ #define _RTE_COMPRESSDEV_PMD_H_ /** @file * RTE comp PMD APIs * * @note * These APIs are for comp PMDs only and user applications should not call * them directly. */ #ifdef __cplusplus extern "C" { #endif #include #include #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 }; /** * @internal * Initialisation parameters for comp devices */ struct rte_compressdev_pmd_init_params { char name[RTE_COMPRESSDEV_NAME_MAX_LEN]; int socket_id; }; /** Global structure used for maintaining state of allocated comp devices */ struct rte_compressdev_global { struct rte_compressdev *devs; /**< Device information array */ struct rte_compressdev_data *data[RTE_COMPRESS_MAX_DEVS]; /**< Device private data */ uint8_t nb_devs; /**< Number of devices found */ uint8_t max_devs; /**< Max number of devices */ }; /** * Get the rte_compressdev structure device pointer for the named device. * * @param name * Compress device name * @return * - The rte_compressdev structure pointer for the given device identifier. */ __rte_experimental struct rte_compressdev * rte_compressdev_pmd_get_named_dev(const char *name); /** * Definitions of all functions exported by a driver through * the generic structure of type *comp_dev_ops* supplied in the * *rte_compressdev* structure associated with a device. */ /** * Function used to configure device. * * @param dev * Compress device * @param config * Compress device configurations * @return * Returns 0 on success */ typedef int (*compressdev_configure_t)(struct rte_compressdev *dev, struct rte_compressdev_config *config); /** * Function used to start a configured device. * * @param dev * Compress device * @return * Returns 0 on success */ typedef int (*compressdev_start_t)(struct rte_compressdev *dev); /** * Function used to stop a configured device. * * @param dev * Compress device */ typedef void (*compressdev_stop_t)(struct rte_compressdev *dev); /** * Function used to close a configured device. * * @param dev * Compress device * @return * - 0 on success. * - EAGAIN if can't close as device is busy */ typedef int (*compressdev_close_t)(struct rte_compressdev *dev); /** * Function used to get statistics of a device. * * @param dev * Compress device * @param stats * Compress device stats to populate */ typedef void (*compressdev_stats_get_t)(struct rte_compressdev *dev, struct rte_compressdev_stats *stats); /** * Function used to reset statistics of a device. * * @param dev * Compress device */ typedef void (*compressdev_stats_reset_t)(struct rte_compressdev *dev); /** * Function used to get specific information of a device. * * @param dev * Compress device * @param dev_info * Compress device information to populate */ typedef void (*compressdev_info_get_t)(struct rte_compressdev *dev, struct rte_compressdev_info *dev_info); /** * Setup a queue pair for a device. * * @param dev * Compress device * @param qp_id * Queue pair identifier * @param max_inflight_ops * Max inflight ops which qp must accommodate * @param socket_id * Socket identifier * @return * Returns 0 on success. */ typedef int (*compressdev_queue_pair_setup_t)(struct rte_compressdev *dev, uint16_t qp_id, uint32_t max_inflight_ops, int socket_id); /** * Release memory resources allocated by given queue pair. * * @param dev * Compress device * @param qp_id * Queue pair identifier * @return * - 0 on success. * - EAGAIN if can't close as device is busy */ typedef int (*compressdev_queue_pair_release_t)(struct rte_compressdev *dev, uint16_t qp_id); /** * Create driver private stream data. * * @param dev * Compressdev device * @param xform * xform data * @param stream * ptr where handle of pmd's private stream data should be stored * @return * - Returns 0 if private stream structure has been created successfully. * - Returns -EINVAL if input parameters are invalid. * - Returns -ENOTSUP if comp device does not support STATEFUL operations. * - Returns -ENOTSUP if comp device does not support the comp transform. * - Returns -ENOMEM if the private stream could not be allocated. */ typedef int (*compressdev_stream_create_t)(struct rte_compressdev *dev, const struct rte_comp_xform *xform, void **stream); /** * Free driver private stream data. * * @param dev * Compressdev device * @param stream * handle of pmd's private stream data * @return * - 0 if successful * - <0 in error cases * - Returns -EINVAL if input parameters are invalid. * - Returns -ENOTSUP if comp device does not support STATEFUL operations. * - Returns -EBUSY if can't free stream as there are inflight operations */ typedef int (*compressdev_stream_free_t)(struct rte_compressdev *dev, void *stream); /** * Create driver private_xform data. * * @param dev * Compressdev device * @param xform * xform data * @param private_xform * ptr where handle of pmd's private_xform data should be stored * @return * - if successful returns 0 * and valid private_xform handle * - <0 in error cases * - Returns -EINVAL if input parameters are invalid. * - Returns -ENOTSUP if comp device does not support the comp transform. * - Returns -ENOMEM if the private_xform could not be allocated. */ typedef int (*compressdev_private_xform_create_t)(struct rte_compressdev *dev, const struct rte_comp_xform *xform, void **private_xform); /** * Free driver private_xform data. * * @param dev * Compressdev device * @param private_xform * handle of pmd's private_xform data * @return * - 0 if successful * - <0 in error cases * - Returns -EINVAL if input parameters are invalid. * - Returns -EBUSY if can't free private_xform due to inflight operations */ typedef int (*compressdev_private_xform_free_t)(struct rte_compressdev *dev, void *private_xform); /** comp device operations function pointer table */ struct rte_compressdev_ops { compressdev_configure_t dev_configure; /**< Configure device. */ compressdev_start_t dev_start; /**< Start device. */ compressdev_stop_t dev_stop; /**< Stop device. */ compressdev_close_t dev_close; /**< Close device. */ compressdev_info_get_t dev_infos_get; /**< Get device info. */ compressdev_stats_get_t stats_get; /**< Get device statistics. */ compressdev_stats_reset_t stats_reset; /**< Reset device statistics. */ compressdev_queue_pair_setup_t queue_pair_setup; /**< Set up a device queue pair. */ compressdev_queue_pair_release_t queue_pair_release; /**< Release a queue pair. */ compressdev_stream_create_t stream_create; /**< Create a comp stream and initialise its private data. */ compressdev_stream_free_t stream_free; /**< Free a comp stream's private data. */ compressdev_private_xform_create_t private_xform_create; /**< Create a comp private_xform and initialise its private data. */ compressdev_private_xform_free_t private_xform_free; /**< Free a comp private_xform's data. */ }; /** * @internal * * Function for internal use by dummy drivers primarily, e.g. ring-based * driver. * Allocates a new compressdev slot for an comp device and returns the pointer * to that slot for the driver to use. * * @param name * Unique identifier name for each device * @param socket_id * Socket to allocate resources on * @return * - Slot in the rte_dev_devices array for a new device; */ __rte_experimental struct rte_compressdev * rte_compressdev_pmd_allocate(const char *name, int socket_id); /** * @internal * * Function for internal use by dummy drivers primarily, e.g. ring-based * driver. * Release the specified compressdev device. * * @param dev * Compress device * @return * - 0 on success, negative on error */ __rte_experimental int rte_compressdev_pmd_release_device(struct rte_compressdev *dev); /** * @internal * * PMD assist function to parse initialisation arguments for comp driver * when creating a new comp PMD device instance. * * PMD should set default values for that PMD before calling function, * these default values will be over-written with successfully parsed values * from args string. * * @param params * Parsed PMD initialisation parameters * @param args * Input argument string to parse * @return * - 0 on success * - errno on failure */ __rte_experimental int rte_compressdev_pmd_parse_input_args( struct rte_compressdev_pmd_init_params *params, const char *args); /** * @internal * * PMD assist function to provide boiler plate code for comp driver to create * and allocate resources for a new comp PMD device instance. * * @param name * Compress device name * @param device * Base device instance * @param params * PMD initialisation parameters * @return * - comp device instance on success * - NULL on creation failure */ __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); /** * @internal * * PMD assist function to provide boiler plate code for comp driver to * destroy and free resources associated with a comp PMD device instance. * * @param dev * Compress device * @return * - 0 on success * - errno on failure */ __rte_experimental int rte_compressdev_pmd_destroy(struct rte_compressdev *dev); #ifdef __cplusplus } #endif #endif /* _RTE_COMPRESSDEV_PMD_H_ */