1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2017-2018 Intel Corporation
3  */
4 
5 #ifndef _RTE_COMPRESSDEV_PMD_H_
6 #define _RTE_COMPRESSDEV_PMD_H_
7 
8 /** @file
9  * RTE comp PMD APIs
10  *
11  * @note
12  * These APIs are for comp PMDs only and user applications should not call
13  * them directly.
14  */
15 
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19 
20 #include <string.h>
21 
22 #include <rte_dev.h>
23 #include <rte_common.h>
24 
25 #include "rte_compressdev.h"
26 #include "rte_compressdev_internal.h"
27 
28 #define RTE_COMPRESSDEV_PMD_NAME_ARG			("name")
29 #define RTE_COMPRESSDEV_PMD_SOCKET_ID_ARG		("socket_id")
30 
31 static const char * const compressdev_pmd_valid_params[] = {
32 	RTE_COMPRESSDEV_PMD_NAME_ARG,
33 	RTE_COMPRESSDEV_PMD_SOCKET_ID_ARG
34 };
35 
36 /**
37  * @internal
38  * Initialisation parameters for comp devices
39  */
40 struct rte_compressdev_pmd_init_params {
41 	char name[RTE_COMPRESSDEV_NAME_MAX_LEN];
42 	int socket_id;
43 };
44 
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 */
52 };
53 
54 /**
55  * Get the rte_compressdev structure device pointer for the named device.
56  *
57  * @param name
58  *   Compress device name
59  * @return
60  *   - The rte_compressdev structure pointer for the given device identifier.
61  */
62 __rte_experimental
63 struct rte_compressdev *
64 rte_compressdev_pmd_get_named_dev(const char *name);
65 
66 /**
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.
70  */
71 
72 /**
73  * Function used to configure device.
74  *
75  * @param dev
76  *   Compress device
77  * @param config
78  *   Compress device configurations
79  * @return
80  *   Returns 0 on success
81  */
82 typedef int (*compressdev_configure_t)(struct rte_compressdev *dev,
83 		struct rte_compressdev_config *config);
84 
85 /**
86  * Function used to start a configured device.
87  *
88  * @param dev
89  *   Compress device
90  * @return
91  *   Returns 0 on success
92  */
93 typedef int (*compressdev_start_t)(struct rte_compressdev *dev);
94 
95 /**
96  * Function used to stop a configured device.
97  *
98  * @param dev
99  *   Compress device
100  */
101 typedef void (*compressdev_stop_t)(struct rte_compressdev *dev);
102 
103 /**
104  * Function used to close a configured device.
105  *
106  * @param dev
107  *   Compress device
108  * @return
109  * - 0 on success.
110  * - EAGAIN if can't close as device is busy
111  */
112 typedef int (*compressdev_close_t)(struct rte_compressdev *dev);
113 
114 
115 /**
116  * Function used to get statistics of a device.
117  *
118  * @param dev
119  *   Compress device
120  * @param stats
121  *   Compress device stats to populate
122  */
123 typedef void (*compressdev_stats_get_t)(struct rte_compressdev *dev,
124 				struct rte_compressdev_stats *stats);
125 
126 
127 /**
128  * Function used to reset statistics of a device.
129  *
130  * @param dev
131  *   Compress device
132  */
133 typedef void (*compressdev_stats_reset_t)(struct rte_compressdev *dev);
134 
135 
136 /**
137  * Function used to get specific information of a device.
138  *
139  * @param dev
140  *   Compress device
141  */
142 typedef void (*compressdev_info_get_t)(struct rte_compressdev *dev,
143 				struct rte_compressdev_info *dev_info);
144 
145 /**
146  * Setup a queue pair for a device.
147  *
148  * @param dev
149  *   Compress device
150  * @param qp_id
151  *   Queue pair identifier
152  * @param max_inflight_ops
153  *   Max inflight ops which qp must accommodate
154  * @param socket_id
155  *   Socket identifier
156  * @return
157  *   Returns 0 on success.
158  */
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);
161 
162 /**
163  * Release memory resources allocated by given queue pair.
164  *
165  * @param dev
166  *   Compress device
167  * @param qp_id
168  *   Queue pair identifier
169  * @return
170  * - 0 on success.
171  * - EAGAIN if can't close as device is busy
172  */
173 typedef int (*compressdev_queue_pair_release_t)(struct rte_compressdev *dev,
174 		uint16_t qp_id);
175 
176 /**
177  * Get number of available queue pairs of a device.
178  *
179  * @param dev
180  *   Compress device
181  * @return
182  *   Returns number of queue pairs on success.
183  */
184 typedef uint32_t (*compressdev_queue_pair_count_t)(struct rte_compressdev *dev);
185 
186 /**
187  * Create driver private stream data.
188  *
189  * @param dev
190  *   Compressdev device
191  * @param xform
192  *   xform data
193  * @param stream
194  *   ptr where handle of pmd's private stream data should be stored
195  * @return
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.
201  */
202 typedef int (*compressdev_stream_create_t)(struct rte_compressdev *dev,
203 		const struct rte_comp_xform *xform, void **stream);
204 
205 /**
206  * Free driver private stream data.
207  *
208  * @param dev
209  *   Compressdev device
210  * @param stream
211  *   handle of pmd's private stream data
212  * @return
213  *  - 0 if successful
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
218  */
219 typedef int (*compressdev_stream_free_t)(struct rte_compressdev *dev,
220 		void *stream);
221 
222 /**
223  * Create driver private_xform data.
224  *
225  * @param dev
226  *   Compressdev device
227  * @param xform
228  *   xform data
229  * @param private_xform
230  *   ptr where handle of pmd's private_xform data should be stored
231  * @return
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.
238  */
239 typedef int (*compressdev_private_xform_create_t)(struct rte_compressdev *dev,
240 		const struct rte_comp_xform *xform, void **private_xform);
241 
242 /**
243  * Free driver private_xform data.
244  *
245  * @param dev
246  *   Compressdev device
247  * @param private_xform
248  *   handle of pmd's private_xform data
249  * @return
250  *  - 0 if successful
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
254  */
255 typedef int (*compressdev_private_xform_free_t)(struct rte_compressdev *dev,
256 		void *private_xform);
257 
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. */
264 
265 	compressdev_info_get_t dev_infos_get;	/**< Get device info. */
266 
267 	compressdev_stats_get_t stats_get;
268 	/**< Get device statistics. */
269 	compressdev_stats_reset_t stats_reset;
270 	/**< Reset device statistics. */
271 
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. */
276 
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. */
281 
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. */
286 };
287 
288 /**
289  * @internal
290  *
291  * Function for internal use by dummy drivers primarily, e.g. ring-based
292  * driver.
293  * Allocates a new compressdev slot for an comp device and returns the pointer
294  * to that slot for the driver to use.
295  *
296  * @param name
297  *   Unique identifier name for each device
298  * @param socket_id
299  *   Socket to allocate resources on
300  * @return
301  *   - Slot in the rte_dev_devices array for a new device;
302  */
303 __rte_experimental
304 struct rte_compressdev *
305 rte_compressdev_pmd_allocate(const char *name, int socket_id);
306 
307 /**
308  * @internal
309  *
310  * Function for internal use by dummy drivers primarily, e.g. ring-based
311  * driver.
312  * Release the specified compressdev device.
313  *
314  * @param dev
315  *   Compress device
316  * @return
317  *   - 0 on success, negative on error
318  */
319 __rte_experimental
320 int
321 rte_compressdev_pmd_release_device(struct rte_compressdev *dev);
322 
323 
324 /**
325  * @internal
326  *
327  * PMD assist function to parse initialisation arguments for comp driver
328  * when creating a new comp PMD device instance.
329  *
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
332  * from args string.
333  *
334  * @param params
335  *   Parsed PMD initialisation parameters
336  * @param args
337  *   Input argument string to parse
338  * @return
339  *  - 0 on success
340  *  - errno on failure
341  */
342 __rte_experimental
343 int
344 rte_compressdev_pmd_parse_input_args(
345 		struct rte_compressdev_pmd_init_params *params,
346 		const char *args);
347 
348 /**
349  * @internal
350  *
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.
353  *
354  * @param name
355  *   Compress device name
356  * @param device
357  *   Base device instance
358  * @param params
359  *   PMD initialisation parameters
360  * @return
361  *  - comp device instance on success
362  *  - NULL on creation failure
363  */
364 __rte_experimental
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);
370 
371 /**
372  * @internal
373  *
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.
376  *
377  * @param dev
378  *   Compress device
379  * @return
380  *  - 0 on success
381  *  - errno on failure
382  */
383 __rte_experimental
384 int
385 rte_compressdev_pmd_destroy(struct rte_compressdev *dev);
386 
387 #ifdef __cplusplus
388 }
389 #endif
390 
391 #endif /* _RTE_COMPRESSDEV_PMD_H_ */
392