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 */
54 /** Pointer to global array of comp devices */
55 extern struct rte_compressdev *rte_compressdevs;
56 /** Pointer to global comp devices data structure */
57 extern struct rte_compressdev_global *rte_compressdev_globals;
60 * Get the rte_compressdev structure device pointer for the named device.
63 * Compress device name
65 * - The rte_compressdev structure pointer for the given device identifier.
67 struct rte_compressdev * __rte_experimental
68 rte_compressdev_pmd_get_named_dev(const char *name);
71 * Definitions of all functions exported by a driver through the
72 * the generic structure of type *comp_dev_ops* supplied in the
73 * *rte_compressdev* structure associated with a device.
77 * Function used to configure device.
82 * Compress device configurations
84 * Returns 0 on success
86 typedef int (*compressdev_configure_t)(struct rte_compressdev *dev,
87 struct rte_compressdev_config *config);
90 * Function used to start a configured device.
95 * Returns 0 on success
97 typedef int (*compressdev_start_t)(struct rte_compressdev *dev);
100 * Function used to stop a configured device.
105 typedef void (*compressdev_stop_t)(struct rte_compressdev *dev);
108 * Function used to close a configured device.
114 * - EAGAIN if can't close as device is busy
116 typedef int (*compressdev_close_t)(struct rte_compressdev *dev);
120 * Function used to get statistics of a device.
125 * Compress device stats to populate
127 typedef void (*compressdev_stats_get_t)(struct rte_compressdev *dev,
128 struct rte_compressdev_stats *stats);
132 * Function used to reset statistics of a device.
137 typedef void (*compressdev_stats_reset_t)(struct rte_compressdev *dev);
141 * Function used to get specific information of a device.
146 typedef void (*compressdev_info_get_t)(struct rte_compressdev *dev,
147 struct rte_compressdev_info *dev_info);
150 * Setup a queue pair for a device.
155 * Queue pair identifier
156 * @param max_inflight_ops
157 * Max inflight ops which qp must accommodate
161 * Returns 0 on success.
163 typedef int (*compressdev_queue_pair_setup_t)(struct rte_compressdev *dev,
164 uint16_t qp_id, uint32_t max_inflight_ops, int socket_id);
167 * Release memory resources allocated by given queue pair.
172 * Queue pair identifier
175 * - EAGAIN if can't close as device is busy
177 typedef int (*compressdev_queue_pair_release_t)(struct rte_compressdev *dev,
181 * Get number of available queue pairs of a device.
186 * Returns number of queue pairs on success.
188 typedef uint32_t (*compressdev_queue_pair_count_t)(struct rte_compressdev *dev);
191 * Create driver private stream data.
198 * ptr where handle of pmd's private stream data should be stored
200 * - Returns 0 if private stream structure has been created successfully.
201 * - Returns -EINVAL if input parameters are invalid.
202 * - Returns -ENOTSUP if comp device does not support STATEFUL operations.
203 * - Returns -ENOTSUP if comp device does not support the comp transform.
204 * - Returns -ENOMEM if the private stream could not be allocated.
206 typedef int (*compressdev_stream_create_t)(struct rte_compressdev *dev,
207 const struct rte_comp_xform *xform, void **stream);
210 * Free driver private stream data.
215 * handle of pmd's private stream data
218 * - <0 in error cases
219 * - Returns -EINVAL if input parameters are invalid.
220 * - Returns -ENOTSUP if comp device does not support STATEFUL operations.
221 * - Returns -EBUSY if can't free stream as there are inflight operations
223 typedef int (*compressdev_stream_free_t)(struct rte_compressdev *dev,
227 * Create driver private_xform data.
233 * @param private_xform
234 * ptr where handle of pmd's private_xform data should be stored
236 * - if successful returns 0
237 * and valid private_xform handle
238 * - <0 in error cases
239 * - Returns -EINVAL if input parameters are invalid.
240 * - Returns -ENOTSUP if comp device does not support the comp transform.
241 * - Returns -ENOMEM if the private_xform could not be allocated.
243 typedef int (*compressdev_private_xform_create_t)(struct rte_compressdev *dev,
244 const struct rte_comp_xform *xform, void **private_xform);
247 * Free driver private_xform data.
251 * @param private_xform
252 * handle of pmd's private_xform data
255 * - <0 in error cases
256 * - Returns -EINVAL if input parameters are invalid.
257 * - Returns -EBUSY if can't free private_xform due to inflight operations
259 typedef int (*compressdev_private_xform_free_t)(struct rte_compressdev *dev,
260 void *private_xform);
262 /** comp device operations function pointer table */
263 struct rte_compressdev_ops {
264 compressdev_configure_t dev_configure; /**< Configure device. */
265 compressdev_start_t dev_start; /**< Start device. */
266 compressdev_stop_t dev_stop; /**< Stop device. */
267 compressdev_close_t dev_close; /**< Close device. */
269 compressdev_info_get_t dev_infos_get; /**< Get device info. */
271 compressdev_stats_get_t stats_get;
272 /**< Get device statistics. */
273 compressdev_stats_reset_t stats_reset;
274 /**< Reset device statistics. */
276 compressdev_queue_pair_setup_t queue_pair_setup;
277 /**< Set up a device queue pair. */
278 compressdev_queue_pair_release_t queue_pair_release;
279 /**< Release a queue pair. */
281 compressdev_stream_create_t stream_create;
282 /**< Create a comp stream and initialise its private data. */
283 compressdev_stream_free_t stream_free;
284 /**< Free a comp stream's private data. */
286 compressdev_private_xform_create_t private_xform_create;
287 /**< Create a comp private_xform and initialise its private data. */
288 compressdev_private_xform_free_t private_xform_free;
289 /**< Free a comp private_xform's data. */
295 * Function for internal use by dummy drivers primarily, e.g. ring-based
297 * Allocates a new compressdev slot for an comp device and returns the pointer
298 * to that slot for the driver to use.
301 * Unique identifier name for each device
303 * Socket to allocate resources on
305 * - Slot in the rte_dev_devices array for a new device;
307 struct rte_compressdev * __rte_experimental
308 rte_compressdev_pmd_allocate(const char *name, int socket_id);
313 * Function for internal use by dummy drivers primarily, e.g. ring-based
315 * Release the specified compressdev device.
320 * - 0 on success, negative on error
322 int __rte_experimental
323 rte_compressdev_pmd_release_device(struct rte_compressdev *dev);
329 * PMD assist function to parse initialisation arguments for comp driver
330 * when creating a new comp PMD device instance.
332 * PMD driver should set default values for that PMD before calling function,
333 * these default values will be over-written with successfully parsed values
337 * Parsed PMD initialisation parameters
339 * Input argument string to parse
344 int __rte_experimental
345 rte_compressdev_pmd_parse_input_args(
346 struct rte_compressdev_pmd_init_params *params,
352 * PMD assist function to provide boiler plate code for comp driver to create
353 * and allocate resources for a new comp PMD device instance.
356 * Compress device name
358 * Base device instance
360 * PMD initialisation parameters
362 * - comp device instance on success
363 * - NULL on creation failure
365 struct rte_compressdev * __rte_experimental
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.
383 int __rte_experimental
384 rte_compressdev_pmd_destroy(struct rte_compressdev *dev);
390 #endif /* _RTE_COMPRESSDEV_PMD_H_ */