DPDK  20.11.0
rte_compressdev_pmd.h
Go to the documentation of this file.
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 
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 
40 struct rte_compressdev_pmd_init_params {
41  char name[RTE_COMPRESSDEV_NAME_MAX_LEN];
42  int socket_id;
43 };
44 
48  struct rte_compressdev_data *data[RTE_COMPRESS_MAX_DEVS];
50  uint8_t nb_devs;
51  uint8_t max_devs;
52 };
53 
62 __rte_experimental
63 struct rte_compressdev *
65 
82 typedef int (*compressdev_configure_t)(struct rte_compressdev *dev,
83  struct rte_compressdev_config *config);
84 
93 typedef int (*compressdev_start_t)(struct rte_compressdev *dev);
94 
101 typedef void (*compressdev_stop_t)(struct rte_compressdev *dev);
102 
112 typedef int (*compressdev_close_t)(struct rte_compressdev *dev);
113 
114 
123 typedef void (*compressdev_stats_get_t)(struct rte_compressdev *dev,
124  struct rte_compressdev_stats *stats);
125 
126 
133 typedef void (*compressdev_stats_reset_t)(struct rte_compressdev *dev);
134 
135 
142 typedef void (*compressdev_info_get_t)(struct rte_compressdev *dev,
143  struct rte_compressdev_info *dev_info);
144 
160  uint16_t qp_id, uint32_t max_inflight_ops, int socket_id);
161 
174  uint16_t qp_id);
175 
192 typedef int (*compressdev_stream_create_t)(struct rte_compressdev *dev,
193  const struct rte_comp_xform *xform, void **stream);
194 
209 typedef int (*compressdev_stream_free_t)(struct rte_compressdev *dev,
210  void *stream);
211 
230  const struct rte_comp_xform *xform, void **private_xform);
231 
246  void *private_xform);
247 
276 };
277 
293 __rte_experimental
294 struct rte_compressdev *
295 rte_compressdev_pmd_allocate(const char *name, int socket_id);
296 
309 __rte_experimental
310 int
311 rte_compressdev_pmd_release_device(struct rte_compressdev *dev);
312 
313 
332 __rte_experimental
333 int
334 rte_compressdev_pmd_parse_input_args(
335  struct rte_compressdev_pmd_init_params *params,
336  const char *args);
337 
354 __rte_experimental
355 struct rte_compressdev *
356 rte_compressdev_pmd_create(const char *name,
357  struct rte_device *device,
358  size_t private_data_size,
359  struct rte_compressdev_pmd_init_params *params);
360 
373 __rte_experimental
374 int
375 rte_compressdev_pmd_destroy(struct rte_compressdev *dev);
376 
377 #ifdef __cplusplus
378 }
379 #endif
380 
381 #endif /* _RTE_COMPRESSDEV_PMD_H_ */
rte_compressdev_config
Definition: rte_compressdev.h:198
rte_compressdev_ops::stats_reset
compressdev_stats_reset_t stats_reset
Definition: rte_compressdev_pmd.h:259
rte_compressdev_ops::private_xform_free
compressdev_private_xform_free_t private_xform_free
Definition: rte_compressdev_pmd.h:274
rte_compressdev_info
Definition: rte_compressdev.h:102
rte_compressdev_global
Definition: rte_compressdev_pmd.h:46
compressdev_private_xform_create_t
int(* compressdev_private_xform_create_t)(struct rte_compressdev *dev, const struct rte_comp_xform *xform, void **private_xform)
Definition: rte_compressdev_pmd.h:229
compressdev_stream_free_t
int(* compressdev_stream_free_t)(struct rte_compressdev *dev, void *stream)
Definition: rte_compressdev_pmd.h:209
compressdev_queue_pair_release_t
int(* compressdev_queue_pair_release_t)(struct rte_compressdev *dev, uint16_t qp_id)
Definition: rte_compressdev_pmd.h:173
rte_compressdev_ops
Definition: rte_compressdev_pmd.h:249
rte_compressdev_ops::dev_close
compressdev_close_t dev_close
Definition: rte_compressdev_pmd.h:253
rte_compressdev::device
struct rte_device * device
Definition: rte_compressdev_internal.h:79
rte_compressdev_ops::dev_infos_get
compressdev_info_get_t dev_infos_get
Definition: rte_compressdev_pmd.h:255
rte_compressdev.h
rte_compressdev_global::data
struct rte_compressdev_data * data[RTE_COMPRESS_MAX_DEVS]
Definition: rte_compressdev_pmd.h:48
compressdev_stop_t
void(* compressdev_stop_t)(struct rte_compressdev *dev)
Definition: rte_compressdev_pmd.h:101
rte_compressdev_data
Definition: rte_compressdev_internal.h:94
rte_compressdev_ops::dev_stop
compressdev_stop_t dev_stop
Definition: rte_compressdev_pmd.h:252
compressdev_queue_pair_setup_t
int(* compressdev_queue_pair_setup_t)(struct rte_compressdev *dev, uint16_t qp_id, uint32_t max_inflight_ops, int socket_id)
Definition: rte_compressdev_pmd.h:159
rte_compressdev_global::devs
struct rte_compressdev * devs
Definition: rte_compressdev_pmd.h:47
compressdev_private_xform_free_t
int(* compressdev_private_xform_free_t)(struct rte_compressdev *dev, void *private_xform)
Definition: rte_compressdev_pmd.h:245
rte_compressdev_ops::private_xform_create
compressdev_private_xform_create_t private_xform_create
Definition: rte_compressdev_pmd.h:272
rte_compressdev_ops::dev_configure
compressdev_configure_t dev_configure
Definition: rte_compressdev_pmd.h:250
rte_compressdev_ops::queue_pair_setup
compressdev_queue_pair_setup_t queue_pair_setup
Definition: rte_compressdev_pmd.h:262
rte_compressdev_ops::stream_create
compressdev_stream_create_t stream_create
Definition: rte_compressdev_pmd.h:267
rte_comp_xform
Definition: rte_comp.h:267
rte_compressdev_global::nb_devs
uint8_t nb_devs
Definition: rte_compressdev_pmd.h:50
rte_compressdev_ops::queue_pair_release
compressdev_queue_pair_release_t queue_pair_release
Definition: rte_compressdev_pmd.h:264
compressdev_start_t
int(* compressdev_start_t)(struct rte_compressdev *dev)
Definition: rte_compressdev_pmd.h:93
rte_common.h
rte_compressdev_pmd_get_named_dev
__rte_experimental struct rte_compressdev * rte_compressdev_pmd_get_named_dev(const char *name)
rte_compressdev
Definition: rte_compressdev_internal.h:67
rte_compressdev_ops::dev_start
compressdev_start_t dev_start
Definition: rte_compressdev_pmd.h:251
compressdev_close_t
int(* compressdev_close_t)(struct rte_compressdev *dev)
Definition: rte_compressdev_pmd.h:112
compressdev_configure_t
int(* compressdev_configure_t)(struct rte_compressdev *dev, struct rte_compressdev_config *config)
Definition: rte_compressdev_pmd.h:82
rte_compressdev_ops::stats_get
compressdev_stats_get_t stats_get
Definition: rte_compressdev_pmd.h:257
rte_compressdev_stats
Definition: rte_compressdev.h:114
rte_device
Definition: rte_dev.h:92
compressdev_stats_get_t
void(* compressdev_stats_get_t)(struct rte_compressdev *dev, struct rte_compressdev_stats *stats)
Definition: rte_compressdev_pmd.h:123
rte_compressdev_ops::stream_free
compressdev_stream_free_t stream_free
Definition: rte_compressdev_pmd.h:269
compressdev_info_get_t
void(* compressdev_info_get_t)(struct rte_compressdev *dev, struct rte_compressdev_info *dev_info)
Definition: rte_compressdev_pmd.h:142
compressdev_stats_reset_t
void(* compressdev_stats_reset_t)(struct rte_compressdev *dev)
Definition: rte_compressdev_pmd.h:133
compressdev_stream_create_t
int(* compressdev_stream_create_t)(struct rte_compressdev *dev, const struct rte_comp_xform *xform, void **stream)
Definition: rte_compressdev_pmd.h:192
rte_compressdev_global::max_devs
uint8_t max_devs
Definition: rte_compressdev_pmd.h:51
rte_dev.h