1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017-2018 Intel Corporation
5 #ifndef _RTE_COMPRESSDEV_PMD_H_
6 #define _RTE_COMPRESSDEV_PMD_H_
12 * These APIs are for comp PMDs only and user applications should not call
23 #include <rte_common.h>
25 #include "rte_compressdev.h"
26 #include "rte_compressdev_internal.h"
28 #define RTE_COMPRESSDEV_PMD_NAME_ARG ("name")
29 #define RTE_COMPRESSDEV_PMD_SOCKET_ID_ARG ("socket_id")
31 static const char * const compressdev_pmd_valid_params[] = {
32 RTE_COMPRESSDEV_PMD_NAME_ARG,
33 RTE_COMPRESSDEV_PMD_SOCKET_ID_ARG
38 * Initialisation parameters for comp devices
40 struct rte_compressdev_pmd_init_params {
41 char name[RTE_COMPRESSDEV_NAME_MAX_LEN];
45 /** Global structure used for maintaining state of allocated comp devices */
46 struct rte_compressdev_global {
47 struct rte_compressdev *devs; /**< Device information array */
48 struct rte_compressdev_data *data[RTE_COMPRESS_MAX_DEVS];
49 /**< Device private data */
50 uint8_t nb_devs; /**< Number of devices found */
51 uint8_t max_devs; /**< Max number of devices */
55 * Get the rte_compressdev structure device pointer for the named device.
58 * Compress device name
60 * - The rte_compressdev structure pointer for the given device identifier.
63 struct rte_compressdev *
64 rte_compressdev_pmd_get_named_dev(const char *name);
67 * Definitions of all functions exported by a driver through the
68 * the generic structure of type *comp_dev_ops* supplied in the
69 * *rte_compressdev* structure associated with a device.
73 * Function used to configure device.
78 * Compress device configurations
80 * Returns 0 on success
82 typedef int (*compressdev_configure_t)(struct rte_compressdev *dev,
83 struct rte_compressdev_config *config);
86 * Function used to start a configured device.
91 * Returns 0 on success
93 typedef int (*compressdev_start_t)(struct rte_compressdev *dev);
96 * Function used to stop a configured device.
101 typedef void (*compressdev_stop_t)(struct rte_compressdev *dev);
104 * Function used to close a configured device.
110 * - EAGAIN if can't close as device is busy
112 typedef int (*compressdev_close_t)(struct rte_compressdev *dev);
116 * Function used to get statistics of a device.
121 * Compress device stats to populate
123 typedef void (*compressdev_stats_get_t)(struct rte_compressdev *dev,
124 struct rte_compressdev_stats *stats);
128 * Function used to reset statistics of a device.
133 typedef void (*compressdev_stats_reset_t)(struct rte_compressdev *dev);
137 * Function used to get specific information of a device.
142 typedef void (*compressdev_info_get_t)(struct rte_compressdev *dev,
143 struct rte_compressdev_info *dev_info);
146 * Setup a queue pair for a device.
151 * Queue pair identifier
152 * @param max_inflight_ops
153 * Max inflight ops which qp must accommodate
157 * Returns 0 on success.
159 typedef int (*compressdev_queue_pair_setup_t)(struct rte_compressdev *dev,
160 uint16_t qp_id, uint32_t max_inflight_ops, int socket_id);
163 * Release memory resources allocated by given queue pair.
168 * Queue pair identifier
171 * - EAGAIN if can't close as device is busy
173 typedef int (*compressdev_queue_pair_release_t)(struct rte_compressdev *dev,
177 * Get number of available queue pairs of a device.
182 * Returns number of queue pairs on success.
184 typedef uint32_t (*compressdev_queue_pair_count_t)(struct rte_compressdev *dev);
187 * Create driver private stream data.
194 * ptr where handle of pmd's private stream data should be stored
196 * - Returns 0 if private stream structure has been created successfully.
197 * - Returns -EINVAL if input parameters are invalid.
198 * - Returns -ENOTSUP if comp device does not support STATEFUL operations.
199 * - Returns -ENOTSUP if comp device does not support the comp transform.
200 * - Returns -ENOMEM if the private stream could not be allocated.
202 typedef int (*compressdev_stream_create_t)(struct rte_compressdev *dev,
203 const struct rte_comp_xform *xform, void **stream);
206 * Free driver private stream data.
211 * handle of pmd's private stream data
214 * - <0 in error cases
215 * - Returns -EINVAL if input parameters are invalid.
216 * - Returns -ENOTSUP if comp device does not support STATEFUL operations.
217 * - Returns -EBUSY if can't free stream as there are inflight operations
219 typedef int (*compressdev_stream_free_t)(struct rte_compressdev *dev,
223 * Create driver private_xform data.
229 * @param private_xform
230 * ptr where handle of pmd's private_xform data should be stored
232 * - if successful returns 0
233 * and valid private_xform handle
234 * - <0 in error cases
235 * - Returns -EINVAL if input parameters are invalid.
236 * - Returns -ENOTSUP if comp device does not support the comp transform.
237 * - Returns -ENOMEM if the private_xform could not be allocated.
239 typedef int (*compressdev_private_xform_create_t)(struct rte_compressdev *dev,
240 const struct rte_comp_xform *xform, void **private_xform);
243 * Free driver private_xform data.
247 * @param private_xform
248 * handle of pmd's private_xform data
251 * - <0 in error cases
252 * - Returns -EINVAL if input parameters are invalid.
253 * - Returns -EBUSY if can't free private_xform due to inflight operations
255 typedef int (*compressdev_private_xform_free_t)(struct rte_compressdev *dev,
256 void *private_xform);
258 /** comp device operations function pointer table */
259 struct rte_compressdev_ops {
260 compressdev_configure_t dev_configure; /**< Configure device. */
261 compressdev_start_t dev_start; /**< Start device. */
262 compressdev_stop_t dev_stop; /**< Stop device. */
263 compressdev_close_t dev_close; /**< Close device. */
265 compressdev_info_get_t dev_infos_get; /**< Get device info. */
267 compressdev_stats_get_t stats_get;
268 /**< Get device statistics. */
269 compressdev_stats_reset_t stats_reset;
270 /**< Reset device statistics. */
272 compressdev_queue_pair_setup_t queue_pair_setup;
273 /**< Set up a device queue pair. */
274 compressdev_queue_pair_release_t queue_pair_release;
275 /**< Release a queue pair. */
277 compressdev_stream_create_t stream_create;
278 /**< Create a comp stream and initialise its private data. */
279 compressdev_stream_free_t stream_free;
280 /**< Free a comp stream's private data. */
282 compressdev_private_xform_create_t private_xform_create;
283 /**< Create a comp private_xform and initialise its private data. */
284 compressdev_private_xform_free_t private_xform_free;
285 /**< Free a comp private_xform's data. */
291 * Function for internal use by dummy drivers primarily, e.g. ring-based
293 * Allocates a new compressdev slot for an comp device and returns the pointer
294 * to that slot for the driver to use.
297 * Unique identifier name for each device
299 * Socket to allocate resources on
301 * - Slot in the rte_dev_devices array for a new device;
304 struct rte_compressdev *
305 rte_compressdev_pmd_allocate(const char *name, int socket_id);
310 * Function for internal use by dummy drivers primarily, e.g. ring-based
312 * Release the specified compressdev device.
317 * - 0 on success, negative on error
321 rte_compressdev_pmd_release_device(struct rte_compressdev *dev);
327 * PMD assist function to parse initialisation arguments for comp driver
328 * when creating a new comp PMD device instance.
330 * PMD driver should set default values for that PMD before calling function,
331 * these default values will be over-written with successfully parsed values
335 * Parsed PMD initialisation parameters
337 * Input argument string to parse
344 rte_compressdev_pmd_parse_input_args(
345 struct rte_compressdev_pmd_init_params *params,
351 * PMD assist function to provide boiler plate code for comp driver to create
352 * and allocate resources for a new comp PMD device instance.
355 * Compress device name
357 * Base device instance
359 * PMD initialisation parameters
361 * - comp device instance on success
362 * - NULL on creation failure
365 struct rte_compressdev *
366 rte_compressdev_pmd_create(const char *name,
367 struct rte_device *device,
368 size_t private_data_size,
369 struct rte_compressdev_pmd_init_params *params);
374 * PMD assist function to provide boiler plate code for comp driver to
375 * destroy and free resources associated with a comp PMD device instance.
385 rte_compressdev_pmd_destroy(struct rte_compressdev *dev);
391 #endif /* _RTE_COMPRESSDEV_PMD_H_ */