lib/librte_bbdev/rte_bbdev_op.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_BBDEV_OP_H_
   6 #define _RTE_BBDEV_OP_H_
   7
   8 /**
   9  * @file rte_bbdev_op.h
  10  *
  11  * Defines wireless base band layer 1 operations and capabilities
  12  *
  13  * @warning
  14  * @b EXPERIMENTAL: this API may change without prior notice
  15  */
  16
  17 #ifdef __cplusplus
  18 extern "C" {
  19 #endif
  20
  21 #include <stdint.h>
  22
  23 #include <rte_common.h>
  24 #include <rte_mbuf.h>
  25 #include <rte_memory.h>
  26 #include <rte_mempool.h>
  27
  28 /* Number of columns in sub-block interleaver (36.212, section 5.1.4.1.1) */
  29 #define RTE_BBDEV_C_SUBBLOCK (32)
  30 /* Maximum size of Transport Block (36.213, Table, Table 7.1.7.2.5-1) */
  31 #define RTE_BBDEV_MAX_TB_SIZE (391656)
  32 /* Maximum size of Code Block (36.212, Table 5.1.3-3) */
  33 #define RTE_BBDEV_MAX_CB_SIZE (6144)
  34 /* Minimum size of Code Block (36.212, Table 5.1.3-3) */
  35 #define RTE_BBDEV_MIN_CB_SIZE (40)
  36 /* Maximum size of circular buffer */
  37 #define RTE_BBDEV_MAX_KW (18528)
  38 /*
  39  * Maximum number of Code Blocks in Transport Block. It is calculated based on
  40  * maximum size of one Code Block and one Transport Block (considering CRC24A
  41  * and CRC24B):
  42  * (391656 + 24) / (6144 - 24) = 64
  43  */
  44 #define RTE_BBDEV_MAX_CODE_BLOCKS (64)
  45
  46 /** Flags for turbo decoder operation and capability structure */
  47 enum rte_bbdev_op_td_flag_bitmasks {
  48         /**< If sub block de-interleaving is to be performed. */
  49         RTE_BBDEV_TURBO_SUBBLOCK_DEINTERLEAVE = (1ULL << 0),
  50         /**< To use CRC Type 24B (otherwise use CRC Type 24A). */
  51         RTE_BBDEV_TURBO_CRC_TYPE_24B = (1ULL << 1),
  52         /**< If turbo equalization is to be performed. */
  53         RTE_BBDEV_TURBO_EQUALIZER = (1ULL << 2),
  54         /**< If set, saturate soft output to +/-127 */
  55         RTE_BBDEV_TURBO_SOFT_OUT_SATURATE = (1ULL << 3),
  56         /**< Set to 1 to start iteration from even, else odd; one iteration =
  57          * max_iteration + 0.5
  58          */
  59         RTE_BBDEV_TURBO_HALF_ITERATION_EVEN = (1ULL << 4),
  60         /**< If 0, TD stops after CRC matches; else if 1, runs to end of next
  61          * odd iteration after CRC matches
  62          */
  63         RTE_BBDEV_TURBO_CONTINUE_CRC_MATCH = (1ULL << 5),
  64         /**< Set if soft output is required to be output  */
  65         RTE_BBDEV_TURBO_SOFT_OUTPUT = (1ULL << 6),
  66         /**< Set to enable early termination mode */
  67         RTE_BBDEV_TURBO_EARLY_TERMINATION = (1ULL << 7),
  68         /**< Set if a device supports decoder dequeue interrupts */
  69         RTE_BBDEV_TURBO_DEC_INTERRUPTS = (1ULL << 9),
  70         /**< Set if positive LLR encoded input is supported. Positive LLR value
  71          * represents the level of confidence for bit '1', and vice versa for
  72          * bit '0'.
  73          * This is mutually exclusive with RTE_BBDEV_TURBO_NEG_LLR_1_BIT_IN
  74          * when used to formalize the input data format.
  75          */
  76         RTE_BBDEV_TURBO_POS_LLR_1_BIT_IN = (1ULL << 10),
  77         /**< Set if negative LLR encoded input is supported. Negative LLR value
  78          * represents the level of confidence for bit '1', and vice versa for
  79          * bit '0'.
  80          * This is mutually exclusive with RTE_BBDEV_TURBO_POS_LLR_1_BIT_IN
  81          * when used to formalize the input data format.
  82          */
  83         RTE_BBDEV_TURBO_NEG_LLR_1_BIT_IN = (1ULL << 11),
  84         /**< Set if positive LLR soft output is supported. Positive LLR value
  85          * represents the level of confidence for bit '1', and vice versa for
  86          * bit '0'.
  87          * This is mutually exclusive with
  88          * RTE_BBDEV_TURBO_NEG_LLR_1_BIT_SOFT_OUT when used to formalize
  89          * the input data format.
  90          */
  91         RTE_BBDEV_TURBO_POS_LLR_1_BIT_SOFT_OUT = (1ULL << 12),
  92         /**< Set if negative LLR soft output is supported. Negative LLR value
  93          * represents the level of confidence for bit '1', and vice versa for
  94          * bit '0'.
  95          * This is mutually exclusive with
  96          * RTE_BBDEV_TURBO_POS_LLR_1_BIT_SOFT_OUT when used to formalize the
  97          * input data format.
  98          */
  99         RTE_BBDEV_TURBO_NEG_LLR_1_BIT_SOFT_OUT = (1ULL << 13),
 100         /**< Set if driver supports flexible parallel MAP engine decoding. If
 101          * not supported, num_maps (number of MAP engines) argument is unusable.
 102          */
 103         RTE_BBDEV_TURBO_MAP_DEC = (1ULL << 14),
 104         /**< Set if a device supports scatter-gather functionality */
 105         RTE_BBDEV_TURBO_DEC_SCATTER_GATHER = (1ULL << 15)
 106 };
 107
 108 /** Flags for turbo encoder operation and capability structure */
 109 enum rte_bbdev_op_te_flag_bitmasks {
 110         /**< Ignore rv_index and set K0 = 0 */
 111         RTE_BBDEV_TURBO_RV_INDEX_BYPASS = (1ULL << 0),
 112         /**< If rate matching is to be performed */
 113         RTE_BBDEV_TURBO_RATE_MATCH = (1ULL << 1),
 114         /**< This bit must be set to enable CRC-24B generation */
 115         RTE_BBDEV_TURBO_CRC_24B_ATTACH = (1ULL << 2),
 116         /**< This bit must be set to enable CRC-24A generation */
 117         RTE_BBDEV_TURBO_CRC_24A_ATTACH = (1ULL << 3),
 118         /**< Set if a device supports encoder dequeue interrupts */
 119         RTE_BBDEV_TURBO_ENC_INTERRUPTS = (1ULL << 4),
 120         /**< Set if a device supports scatter-gather functionality */
 121         RTE_BBDEV_TURBO_ENC_SCATTER_GATHER = (1ULL << 5)
 122 };
 123
 124 /**< Data input and output buffer for BBDEV operations */
 125 struct rte_bbdev_op_data {
 126         /**< The mbuf data structure representing the data for BBDEV operation.
 127          *
 128          * This mbuf pointer can point to one Code Block (CB) data buffer or
 129          * multiple CBs contiguously located next to each other.
 130          * A Transport Block (TB) represents a whole piece of data that is
 131          * divided into one or more CBs. Maximum number of CBs can be contained
 132          * in one TB is defined by RTE_BBDEV_MAX_CODE_BLOCKS.
 133          *
 134          * An mbuf data structure cannot represent more than one TB. The
 135          * smallest piece of data that can be contained in one mbuf is one CB.
 136          * An mbuf can include one contiguous CB, subset of contiguous CBs that
 137          * are belonging to one TB, or all contiguous CBs that are belonging to
 138          * one TB.
 139          *
 140          * If a BBDEV PMD supports the extended capability "Scatter-Gather",
 141          * then it is capable of collecting (gathering) non-contiguous
 142          * (scattered) data from multiple locations in the memory.
 143          * This capability is reported by the capability flags:
 144          * - RTE_BBDEV_TURBO_ENC_SCATTER_GATHER and
 145          * - RTE_BBDEV_TURBO_DEC_SCATTER_GATHER.
 146          * Only if a BBDEV PMD supports this feature, chained mbuf data
 147          * structures are accepted. A chained mbuf can represent one
 148          * non-contiguous CB or multiple non-contiguous CBs.
 149          * If BBDEV PMD does not support this feature, it will assume inbound
 150          * mbuf data contains one segment.
 151          *
 152          * The output mbuf data though is always one segment, even if the input
 153          * was a chained mbuf.
 154          */
 155         struct rte_mbuf *data;
 156         /**< The starting point of the BBDEV (encode/decode) operation,
 157          * in bytes.
 158          *
 159          * BBDEV starts to read data past this offset.
 160          * In case of chained mbuf, this offset applies only to the first mbuf
 161          * segment.
 162          */
 163         uint32_t offset;
 164         /**< The total data length to be processed in one operation, in bytes.
 165          *
 166          * In case the mbuf data is representing one CB, this is the length of
 167          * the CB undergoing the operation.
 168          * If it's for multiple CBs, this is the total length of those CBs
 169          * undergoing the operation.
 170          * If it's for one TB, this is the total length of the TB under
 171          * operation.
 172          *
 173          * In case of chained mbuf, this data length includes the lengths of the
 174          * "scattered" data segments undergoing the operation.
 175          */
 176         uint32_t length;
 177 };
 178
 179 struct rte_bbdev_op_dec_cb_params {
 180         /**< The K size of the input CB, in bits [40:6144], as specified in
 181          * 3GPP TS 36.212.
 182          * This size is inclusive of CRC bits, regardless whether it was
 183          * pre-calculated by the application or not.
 184          */
 185         uint16_t k;
 186         /**< The E length of the CB rate matched LLR output, in bytes, as in
 187          * 3GPP TS 36.212.
 188          */
 189         uint32_t e;
 190 };
 191
 192 struct rte_bbdev_op_dec_tb_params {
 193         /**< The K- size of the input CB, in bits [40:6144], that is in the
 194          * Turbo operation when r < C-, as in 3GPP TS 36.212.
 195          */
 196         uint16_t k_neg;
 197         /**< The K+ size of the input CB, in bits [40:6144], that is in the
 198          * Turbo operation when r >= C-, as in 3GPP TS 36.212.
 199          */
 200         uint16_t k_pos;
 201         /**< The number of CBs that have K- size, [0:63] */
 202         uint8_t c_neg;
 203         /**< The total number of CBs in the TB, [1:RTE_BBDEV_MAX_CODE_BLOCKS] */
 204         uint8_t c;
 205         /**< The number of CBs that uses Ea before switching to Eb, [0:63] */
 206         uint8_t cab;
 207         /**< The E size of the CB rate matched output to use in the Turbo
 208          * operation when r < cab
 209          */
 210         uint32_t ea;
 211         /**< The E size of the CB rate matched output to use in the Turbo
 212          * operation when r >= cab
 213          */
 214         uint32_t eb;
 215 };
 216
 217 /**< Operation structure for Turbo decode.
 218  * An operation can perform on one CB at a time "CB-mode".
 219  * An operation can perform on one or multiple CBs that are logically belonging
 220  * to one TB "TB-mode".
 221  * The provided K size parameter of the CB is its size out coming from the
 222  * decode operation.
 223  * CRC24A/B check is requested by the application by setting the flag
 224  * RTE_BBDEV_TURBO_CRC_TYPE_24B for CRC24B check or CRC24A otherwise.
 225  * In TB-mode, BBDEV concatenates the decoded CBs one next to the other with
 226  * relevant CRC24B in between.
 227  *
 228  * The input encoded CB data is the Virtual Circular Buffer data stream, wk,
 229  * with the null padding included as described in 3GPP TS 36.212
 230  * section 5.1.4.1.2 and shown in 3GPP TS 36.212 section 5.1.4.1 Figure 5.1.4-1.
 231  * The size of the virtual circular buffer is 3*Kpi, where Kpi is the 32 byte
 232  * aligned value of K, as specified in 3GPP TS 36.212 section 5.1.4.1.1.
 233  *
 234  * Each byte in the input circular buffer is the LLR value of each bit of the
 235  * original CB.
 236  *
 237  * Hard output is a mandatory capability that all BBDEV PMDs support. This is
 238  * the decoded CBs of K sizes (CRC24A/B is the last 24-bit in each decoded CB).
 239  * Soft output is an optional capability for BBDEV PMDs. If supported, an LLR
 240  * rate matched output is computed in the soft_output buffer structure.
 241  *
 242  * The output mbuf data structure is expected to be allocated by the
 243  * application with enough room for the output data.
 244  */
 245 struct rte_bbdev_op_turbo_dec {
 246         /**< The Virtual Circular Buffer, wk, size 3*Kpi for each CB */
 247         struct rte_bbdev_op_data input;
 248         /**< The hard decisions buffer for the decoded output,
 249          * size K for each CB
 250          */
 251         struct rte_bbdev_op_data hard_output;
 252         /**< The soft LLR output buffer - optional */
 253         struct rte_bbdev_op_data soft_output;
 254
 255         uint32_t op_flags;  /**< Flags from rte_bbdev_op_td_flag_bitmasks */
 256         uint8_t rv_index;  /**< Rv index for rate matching [0:3] */
 257         /**< The minimum number of iterations to perform in decoding all CBs in
 258          * this operation - input
 259          */
 260         uint8_t iter_min:4;
 261         /**< The maximum number of iterations to perform in decoding all CBs in
 262          * this operation - input
 263          */
 264         uint8_t iter_max:4;
 265         /**< The maximum number of iterations that were perform in decoding all
 266          * CBs in this decode operation - output
 267          */
 268         uint8_t iter_count;
 269         /**< 5 bit extrinsic scale (scale factor on extrinsic info) */
 270         uint8_t ext_scale;
 271         /**< Number of MAP engines to use in decode,
 272          * must be power of 2 (or 0 to auto-select)
 273          */
 274         uint8_t num_maps;
 275
 276         uint8_t code_block_mode; /**< [0 - TB : 1 - CB] */
 277         union {
 278                 /**< Struct which stores Code Block specific parameters */
 279                 struct rte_bbdev_op_dec_cb_params cb_params;
 280                 /**< Struct which stores Transport Block specific parameters */
 281                 struct rte_bbdev_op_dec_tb_params tb_params;
 282         };
 283 };
 284
 285 struct rte_bbdev_op_enc_cb_params {
 286         /**< The K size of the input CB, in bits [40:6144], as specified in
 287          * 3GPP TS 36.212.
 288          * This size is inclusive of CRC24A, regardless whether it was
 289          * pre-calculated by the application or not.
 290          */
 291         uint16_t k;
 292         /**< The E length of the CB rate matched output, in bits, as in
 293          * 3GPP TS 36.212.
 294          */
 295         uint32_t e;
 296         /**< The Ncb soft buffer size of the CB rate matched output [K:3*Kpi],
 297          * in bits, as specified in 3GPP TS 36.212.
 298          */
 299         uint16_t ncb;
 300 };
 301
 302 struct rte_bbdev_op_enc_tb_params {
 303         /**< The K- size of the input CB, in bits [40:6144], that is in the
 304          * Turbo operation when r < C-, as in 3GPP TS 36.212.
 305          * This size is inclusive of CRC24B, regardless whether it was
 306          * pre-calculated and appended by the application or not.
 307          */
 308         uint16_t k_neg;
 309         /**< The K+ size of the input CB, in bits [40:6144], that is in the
 310          * Turbo operation when r >= C-, as in 3GPP TS 36.212.
 311          * This size is inclusive of CRC24B, regardless whether it was
 312          * pre-calculated and appended by the application or not.
 313          */
 314         uint16_t k_pos;
 315         /**< The number of CBs that have K- size, [0:63] */
 316         uint8_t c_neg;
 317         /**< The total number of CBs in the TB, [1:RTE_BBDEV_MAX_CODE_BLOCKS] */
 318         uint8_t c;
 319         /**< The number of CBs that uses Ea before switching to Eb, [0:63] */
 320         uint8_t cab;
 321         /**< The E size of the CB rate matched output to use in the Turbo
 322          * operation when r < cab
 323          */
 324         uint32_t ea;
 325         /**< The E size of the CB rate matched output to use in the Turbo
 326          * operation when r >= cab
 327          */
 328         uint32_t eb;
 329         /**< The Ncb soft buffer size for the rate matched CB that is used in
 330          * the Turbo operation when r < C-, [K:3*Kpi]
 331          */
 332         uint16_t ncb_neg;
 333         /**< The Ncb soft buffer size for the rate matched CB that is used in
 334          * the Turbo operation when r >= C-, [K:3*Kpi]
 335          */
 336         uint16_t ncb_pos;
 337         /**< The index of the first CB in the inbound mbuf data, default is 0 */
 338         uint8_t r;
 339 };
 340
 341 /**< Operation structure for Turbo encode.
 342  * An operation can perform on one CB at a time "CB-mode".
 343  * An operation can perform on one or multiple CBs that are logically
 344  * belonging to one TB "TB-mode".
 345  *
 346  * In CB-mode, CRC24A/B is an optional operation. K size parameter is not
 347  * affected by CRC24A/B inclusion, this only affects the inbound mbuf data
 348  * length. Not all BBDEV PMDs are capable of CRC24A/B calculation. Flags
 349  * RTE_BBDEV_TURBO_CRC_24A_ATTACH and RTE_BBDEV_TURBO_CRC_24B_ATTACH informs
 350  * the application with relevant capability. These flags can be set in the
 351  * op_flags parameter to indicate BBDEV to calculate and append CRC24A to CB
 352  * before going forward with Turbo encoding.
 353  *
 354  * In TB-mode, CRC24A is assumed to be pre-calculated and appended to the
 355  * inbound TB mbuf data buffer.
 356  *
 357  * The output mbuf data structure is expected to be allocated by the
 358  * application with enough room for the output data.
 359  */
 360 struct rte_bbdev_op_turbo_enc {
 361         /**< The input CB or TB data */
 362         struct rte_bbdev_op_data input;
 363         /**< The rate matched CB or TB output buffer */
 364         struct rte_bbdev_op_data output;
 365
 366         uint32_t op_flags;  /**< Flags from rte_bbdev_op_te_flag_bitmasks */
 367         uint8_t rv_index;  /**< Rv index for rate matching [0:3] */
 368
 369         uint8_t code_block_mode; /**< [0 - TB : 1 - CB] */
 370         union {
 371                 /**< Struct which stores Code Block specific parameters */
 372                 struct rte_bbdev_op_enc_cb_params cb_params;
 373                 /**< Struct which stores Transport Block specific parameters */
 374                 struct rte_bbdev_op_enc_tb_params tb_params;
 375         };
 376 };
 377
 378 /**< List of the capabilities for the Turbo Decoder */
 379 struct rte_bbdev_op_cap_turbo_dec {
 380         /**< Flags from rte_bbdev_op_td_flag_bitmasks */
 381         uint32_t capability_flags;
 382         /** Maximal LLR absolute value. Acceptable LLR values lie in range
 383          * [-max_llr_modulus, max_llr_modulus].
 384          */
 385         int8_t max_llr_modulus;
 386         uint8_t num_buffers_src;  /**< Num input code block buffers */
 387         /**< Num hard output code block buffers */
 388         uint8_t num_buffers_hard_out;
 389         /**< Num soft output code block buffers if supported by the driver */
 390         uint8_t num_buffers_soft_out;
 391 };
 392
 393 /**< List of the capabilities for the Turbo Encoder */
 394 struct rte_bbdev_op_cap_turbo_enc {
 395         /**< Flags from rte_bbdev_op_te_flag_bitmasks */
 396         uint32_t capability_flags;
 397         uint8_t num_buffers_src;  /**< Num input code block buffers */
 398         uint8_t num_buffers_dst;  /**< Num output code block buffers */
 399 };
 400
 401 /** Different operation types supported by the device */
 402 enum rte_bbdev_op_type {
 403         RTE_BBDEV_OP_NONE,  /**< Dummy operation that does nothing */
 404         RTE_BBDEV_OP_TURBO_DEC,  /**< Turbo decode */
 405         RTE_BBDEV_OP_TURBO_ENC,  /**< Turbo encode */
 406         RTE_BBDEV_OP_TYPE_COUNT,  /**< Count of different op types */
 407 };
 408
 409 /**< Bit indexes of possible errors reported through status field */
 410 enum {
 411         RTE_BBDEV_DRV_ERROR,
 412         RTE_BBDEV_DATA_ERROR,
 413         RTE_BBDEV_CRC_ERROR,
 414 };
 415
 416 /**< Structure specifying a single encode operation */
 417 struct rte_bbdev_enc_op {
 418         int status;  /**< Status of operation that was performed */
 419         struct rte_mempool *mempool;  /**< Mempool which op instance is in */
 420         void *opaque_data;  /**< Opaque pointer for user data */
 421         /**< Contains encoder specific parameters */
 422         struct rte_bbdev_op_turbo_enc turbo_enc;
 423 };
 424
 425 /**< Structure specifying a single decode operation */
 426 struct rte_bbdev_dec_op {
 427         int status;  /**< Status of operation that was performed */
 428         struct rte_mempool *mempool;  /**< Mempool which op instance is in */
 429         void *opaque_data;  /**< Opaque pointer for user data */
 430         /**< Contains decoder specific parameters */
 431         struct rte_bbdev_op_turbo_dec turbo_dec;
 432 };
 433
 434 /**< Operation capabilities supported by a device */
 435 struct rte_bbdev_op_cap {
 436         enum rte_bbdev_op_type type;  /**< Type of operation */
 437         union {
 438                 struct rte_bbdev_op_cap_turbo_dec turbo_dec;
 439                 struct rte_bbdev_op_cap_turbo_enc turbo_enc;
 440         } cap;  /**< Operation-type specific capabilities */
 441 };
 442
 443 /**< @internal Private data structure stored with operation pool. */
 444 struct rte_bbdev_op_pool_private {
 445         enum rte_bbdev_op_type type;  /**< Type of operations in a pool */
 446 };
 447
 448 /**
 449  * Converts queue operation type from enum to string
 450  *
 451  * @param op_type
 452  *   Operation type as enum
 453  *
 454  * @returns
 455  *   Operation type as string or NULL if op_type is invalid
 456  *
 457  */
 458 const char*
 459 rte_bbdev_op_type_str(enum rte_bbdev_op_type op_type);
 460
 461 /**
 462  * Creates a bbdev operation mempool
 463  *
 464  * @param name
 465  *   Pool name.
 466  * @param type
 467  *   Operation type, use RTE_BBDEV_OP_NONE for a pool which supports all
 468  *   operation types.
 469  * @param num_elements
 470  *   Number of elements in the pool.
 471  * @param cache_size
 472  *   Number of elements to cache on an lcore, see rte_mempool_create() for
 473  *   further details about cache size.
 474  * @param socket_id
 475  *   Socket to allocate memory on.
 476  *
 477  * @return
 478  *   - Pointer to a mempool on success,
 479  *   - NULL pointer on failure.
 480  */
 481 struct rte_mempool *
 482 rte_bbdev_op_pool_create(const char *name, enum rte_bbdev_op_type type,
 483                 unsigned int num_elements, unsigned int cache_size,
 484                 int socket_id);
 485
 486 /**
 487  * Bulk allocate encode operations from a mempool with parameter defaults reset.
 488  *
 489  * @param mempool
 490  *   Operation mempool, created by rte_bbdev_op_pool_create().
 491  * @param ops
 492  *   Output array to place allocated operations
 493  * @param num_ops
 494  *   Number of operations to allocate
 495  *
 496  * @returns
 497  *   - 0 on success
 498  *   - EINVAL if invalid mempool is provided
 499  */
 500 static inline int
 501 rte_bbdev_enc_op_alloc_bulk(struct rte_mempool *mempool,
 502                 struct rte_bbdev_enc_op **ops, uint16_t num_ops)
 503 {
 504         struct rte_bbdev_op_pool_private *priv;
 505         int ret;
 506
 507         /* Check type */
 508         priv = (struct rte_bbdev_op_pool_private *)
 509                         rte_mempool_get_priv(mempool);
 510         if (unlikely(priv->type != RTE_BBDEV_OP_TURBO_ENC))
 511                 return -EINVAL;
 512
 513         /* Get elements */
 514         ret = rte_mempool_get_bulk(mempool, (void **)ops, num_ops);
 515         if (unlikely(ret < 0))
 516                 return ret;
 517
 518         return 0;
 519 }
 520
 521 /**
 522  * Bulk allocate decode operations from a mempool with parameter defaults reset.
 523  *
 524  * @param mempool
 525  *   Operation mempool, created by rte_bbdev_op_pool_create().
 526  * @param ops
 527  *   Output array to place allocated operations
 528  * @param num_ops
 529  *   Number of operations to allocate
 530  *
 531  * @returns
 532  *   - 0 on success
 533  *   - EINVAL if invalid mempool is provided
 534  */
 535 static inline int
 536 rte_bbdev_dec_op_alloc_bulk(struct rte_mempool *mempool,
 537                 struct rte_bbdev_dec_op **ops, uint16_t num_ops)
 538 {
 539         struct rte_bbdev_op_pool_private *priv;
 540         int ret;
 541
 542         /* Check type */
 543         priv = (struct rte_bbdev_op_pool_private *)
 544                         rte_mempool_get_priv(mempool);
 545         if (unlikely(priv->type != RTE_BBDEV_OP_TURBO_DEC))
 546                 return -EINVAL;
 547
 548         /* Get elements */
 549         ret = rte_mempool_get_bulk(mempool, (void **)ops, num_ops);
 550         if (unlikely(ret < 0))
 551                 return ret;
 552
 553         return 0;
 554 }
 555
 556 /**
 557  * Free decode operation structures that were allocated by
 558  * rte_bbdev_dec_op_alloc_bulk().
 559  * All structures must belong to the same mempool.
 560  *
 561  * @param ops
 562  *   Operation structures
 563  * @param num_ops
 564  *   Number of structures
 565  */
 566 static inline void
 567 rte_bbdev_dec_op_free_bulk(struct rte_bbdev_dec_op **ops, unsigned int num_ops)
 568 {
 569         if (num_ops > 0)
 570                 rte_mempool_put_bulk(ops[0]->mempool, (void **)ops, num_ops);
 571 }
 572
 573 /**
 574  * Free encode operation structures that were allocated by
 575  * rte_bbdev_enc_op_alloc_bulk().
 576  * All structures must belong to the same mempool.
 577  *
 578  * @param ops
 579  *   Operation structures
 580  * @param num_ops
 581  *   Number of structures
 582  */
 583 static inline void
 584 rte_bbdev_enc_op_free_bulk(struct rte_bbdev_enc_op **ops, unsigned int num_ops)
 585 {
 586         if (num_ops > 0)
 587                 rte_mempool_put_bulk(ops[0]->mempool, (void **)ops, num_ops);
 588 }
 589
 590 #ifdef __cplusplus
 591 }
 592 #endif
 593
 594 #endif /* _RTE_BBDEV_OP_H_ */