lib/librte_compressdev/rte_compressdev_pmd.h

   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 /** 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;
  58
  59 /**
  60  * Get the rte_compressdev structure device pointer for the named device.
  61  *
  62  * @param name
  63  *   Compress device name
  64  * @return
  65  *   - The rte_compressdev structure pointer for the given device identifier.
  66  */
  67 struct rte_compressdev * __rte_experimental
  68 rte_compressdev_pmd_get_named_dev(const char *name);
  69
  70 /**
  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.
  74  */
  75
  76 /**
  77  * Function used to configure device.
  78  *
  79  * @param dev
  80  *   Compress device
  81  * @param config
  82  *   Compress device configurations
  83  * @return
  84  *   Returns 0 on success
  85  */
  86 typedef int (*compressdev_configure_t)(struct rte_compressdev *dev,
  87                 struct rte_compressdev_config *config);
  88
  89 /**
  90  * Function used to start a configured device.
  91  *
  92  * @param dev
  93  *   Compress device
  94  * @return
  95  *   Returns 0 on success
  96  */
  97 typedef int (*compressdev_start_t)(struct rte_compressdev *dev);
  98
  99 /**
 100  * Function used to stop a configured device.
 101  *
 102  * @param dev
 103  *   Compress device
 104  */
 105 typedef void (*compressdev_stop_t)(struct rte_compressdev *dev);
 106
 107 /**
 108  * Function used to close a configured device.
 109  *
 110  * @param dev
 111  *   Compress device
 112  * @return
 113  * - 0 on success.
 114  * - EAGAIN if can't close as device is busy
 115  */
 116 typedef int (*compressdev_close_t)(struct rte_compressdev *dev);
 117
 118
 119 /**
 120  * Function used to get statistics of a device.
 121  *
 122  * @param dev
 123  *   Compress device
 124  * @param stats
 125  *   Compress device stats to populate
 126  */
 127 typedef void (*compressdev_stats_get_t)(struct rte_compressdev *dev,
 128                                 struct rte_compressdev_stats *stats);
 129
 130
 131 /**
 132  * Function used to reset statistics of a device.
 133  *
 134  * @param dev
 135  *   Compress device
 136  */
 137 typedef void (*compressdev_stats_reset_t)(struct rte_compressdev *dev);
 138
 139
 140 /**
 141  * Function used to get specific information of a device.
 142  *
 143  * @param dev
 144  *   Compress device
 145  */
 146 typedef void (*compressdev_info_get_t)(struct rte_compressdev *dev,
 147                                 struct rte_compressdev_info *dev_info);
 148
 149 /**
 150  * Setup a queue pair for a device.
 151  *
 152  * @param dev
 153  *   Compress device
 154  * @param qp_id
 155  *   Queue pair identifier
 156  * @param max_inflight_ops
 157  *   Max inflight ops which qp must accommodate
 158  * @param socket_id
 159  *   Socket identifier
 160  * @return
 161  *   Returns 0 on success.
 162  */
 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);
 165
 166 /**
 167  * Release memory resources allocated by given queue pair.
 168  *
 169  * @param dev
 170  *   Compress device
 171  * @param qp_id
 172  *   Queue pair identifier
 173  * @return
 174  * - 0 on success.
 175  * - EAGAIN if can't close as device is busy
 176  */
 177 typedef int (*compressdev_queue_pair_release_t)(struct rte_compressdev *dev,
 178                 uint16_t qp_id);
 179
 180 /**
 181  * Get number of available queue pairs of a device.
 182  *
 183  * @param dev
 184  *   Compress device
 185  * @return
 186  *   Returns number of queue pairs on success.
 187  */
 188 typedef uint32_t (*compressdev_queue_pair_count_t)(struct rte_compressdev *dev);
 189
 190 /**
 191  * Create driver private stream data.
 192  *
 193  * @param dev
 194  *   Compressdev device
 195  * @param xform
 196  *   xform data
 197  * @param stream
 198  *   ptr where handle of pmd's private stream data should be stored
 199  * @return
 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.
 205  */
 206 typedef int (*compressdev_stream_create_t)(struct rte_compressdev *dev,
 207                 const struct rte_comp_xform *xform, void **stream);
 208
 209 /**
 210  * Free driver private stream data.
 211  *
 212  * @param dev
 213  *   Compressdev device
 214  * @param stream
 215  *   handle of pmd's private stream data
 216  * @return
 217  *  - 0 if successful
 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
 222  */
 223 typedef int (*compressdev_stream_free_t)(struct rte_compressdev *dev,
 224                 void *stream);
 225
 226 /**
 227  * Create driver private_xform data.
 228  *
 229  * @param dev
 230  *   Compressdev device
 231  * @param xform
 232  *   xform data
 233  * @param private_xform
 234  *   ptr where handle of pmd's private_xform data should be stored
 235  * @return
 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.
 242  */
 243 typedef int (*compressdev_private_xform_create_t)(struct rte_compressdev *dev,
 244                 const struct rte_comp_xform *xform, void **private_xform);
 245
 246 /**
 247  * Free driver private_xform data.
 248  *
 249  * @param dev
 250  *   Compressdev device
 251  * @param private_xform
 252  *   handle of pmd's private_xform data
 253  * @return
 254  *  - 0 if successful
 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
 258  */
 259 typedef int (*compressdev_private_xform_free_t)(struct rte_compressdev *dev,
 260                 void *private_xform);
 261
 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. */
 268
 269         compressdev_info_get_t dev_infos_get;   /**< Get device info. */
 270
 271         compressdev_stats_get_t stats_get;
 272         /**< Get device statistics. */
 273         compressdev_stats_reset_t stats_reset;
 274         /**< Reset device statistics. */
 275
 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. */
 280
 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. */
 285
 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. */
 290 };
 291
 292 /**
 293  * @internal
 294  *
 295  * Function for internal use by dummy drivers primarily, e.g. ring-based
 296  * driver.
 297  * Allocates a new compressdev slot for an comp device and returns the pointer
 298  * to that slot for the driver to use.
 299  *
 300  * @param name
 301  *   Unique identifier name for each device
 302  * @param socket_id
 303  *   Socket to allocate resources on
 304  * @return
 305  *   - Slot in the rte_dev_devices array for a new device;
 306  */
 307 struct rte_compressdev * __rte_experimental
 308 rte_compressdev_pmd_allocate(const char *name, int socket_id);
 309
 310 /**
 311  * @internal
 312  *
 313  * Function for internal use by dummy drivers primarily, e.g. ring-based
 314  * driver.
 315  * Release the specified compressdev device.
 316  *
 317  * @param dev
 318  *   Compress device
 319  * @return
 320  *   - 0 on success, negative on error
 321  */
 322 int __rte_experimental
 323 rte_compressdev_pmd_release_device(struct rte_compressdev *dev);
 324
 325
 326 /**
 327  * @internal
 328  *
 329  * PMD assist function to parse initialisation arguments for comp driver
 330  * when creating a new comp PMD device instance.
 331  *
 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
 334  * from args string.
 335  *
 336  * @param params
 337  *   Parsed PMD initialisation parameters
 338  * @param args
 339  *   Input argument string to parse
 340  * @return
 341  *  - 0 on success
 342  *  - errno on failure
 343  */
 344 int __rte_experimental
 345 rte_compressdev_pmd_parse_input_args(
 346                 struct rte_compressdev_pmd_init_params *params,
 347                 const char *args);
 348
 349 /**
 350  * @internal
 351  *
 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.
 354  *
 355  * @param name
 356  *   Compress device name
 357  * @param device
 358  *   Base device instance
 359  * @param params
 360  *   PMD initialisation parameters
 361  * @return
 362  *  - comp device instance on success
 363  *  - NULL on creation failure
 364  */
 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);
 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 int __rte_experimental
 384 rte_compressdev_pmd_destroy(struct rte_compressdev *dev);
 385
 386 #ifdef __cplusplus
 387 }
 388 #endif
 389
 390 #endif /* _RTE_COMPRESSDEV_PMD_H_ */