lib/librte_bbdev/rte_bbdev.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_BBDEV_H_
   6 #define _RTE_BBDEV_H_
   7
   8 /**
   9  * @file rte_bbdev.h
  10  *
  11  * Wireless base band device abstraction APIs.
  12  *
  13  * @warning
  14  * @b EXPERIMENTAL: this API may change without prior notice
  15  *
  16  * This API allows an application to discover, configure and use a device to
  17  * process operations. An asynchronous API (enqueue, followed by later dequeue)
  18  * is used for processing operations.
  19  *
  20  * The functions in this API are not thread-safe when called on the same
  21  * target object (a device, or a queue on a device), with the exception that
  22  * one thread can enqueue operations to a queue while another thread dequeues
  23  * from the same queue.
  24  */
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 #include <stdint.h>
  31 #include <stdbool.h>
  32 #include <string.h>
  33
  34 #include <rte_compat.h>
  35 #include <rte_atomic.h>
  36 #include <rte_bus.h>
  37 #include <rte_cpuflags.h>
  38 #include <rte_memory.h>
  39
  40 #include "rte_bbdev_op.h"
  41
  42 #ifndef RTE_BBDEV_MAX_DEVS
  43 #define RTE_BBDEV_MAX_DEVS 128  /**< Max number of devices */
  44 #endif
  45
  46 /** Flags indiciate current state of BBDEV device */
  47 enum rte_bbdev_state {
  48         RTE_BBDEV_UNUSED,
  49         RTE_BBDEV_INITIALIZED
  50 };
  51
  52 /**
  53  * Get the total number of devices that have been successfully initialised.
  54  *
  55  * @return
  56  *   The total number of usable devices.
  57  */
  58 uint16_t __rte_experimental
  59 rte_bbdev_count(void);
  60
  61 /**
  62  * Check if a device is valid.
  63  *
  64  * @param dev_id
  65  *   The identifier of the device.
  66  *
  67  * @return
  68  *   true if device ID is valid and device is attached, false otherwise.
  69  */
  70 bool __rte_experimental
  71 rte_bbdev_is_valid(uint16_t dev_id);
  72
  73 /**
  74  * Get the next enabled device.
  75  *
  76  * @param dev_id
  77  *   The current device
  78  *
  79  * @return
  80  *   - The next device, or
  81  *   - RTE_BBDEV_MAX_DEVS if none found
  82  */
  83 uint16_t __rte_experimental
  84 rte_bbdev_find_next(uint16_t dev_id);
  85
  86 /** Iterate through all enabled devices */
  87 #define RTE_BBDEV_FOREACH(i) for (i = rte_bbdev_find_next(-1); \
  88                 i < RTE_BBDEV_MAX_DEVS; \
  89                 i = rte_bbdev_find_next(i))
  90
  91 /**
  92  * Setup up device queues.
  93  * This function must be called on a device before setting up the queues and
  94  * starting the device. It can also be called when a device is in the stopped
  95  * state. If any device queues have been configured their configuration will be
  96  * cleared by a call to this function.
  97  *
  98  * @param dev_id
  99  *   The identifier of the device.
 100  * @param num_queues
 101  *   Number of queues to configure on device.
 102  * @param socket_id
 103  *   ID of a socket which will be used to allocate memory.
 104  *
 105  * @return
 106  *   - 0 on success
 107  *   - -ENODEV if dev_id is invalid or the device is corrupted
 108  *   - -EINVAL if num_queues is invalid, 0 or greater than maximum
 109  *   - -EBUSY if the identified device has already started
 110  *   - -ENOMEM if unable to allocate memory
 111  */
 112 int __rte_experimental
 113 rte_bbdev_setup_queues(uint16_t dev_id, uint16_t num_queues, int socket_id);
 114
 115 /**
 116  * Enable interrupts.
 117  * This function may be called before starting the device to enable the
 118  * interrupts if they are available.
 119  *
 120  * @param dev_id
 121  *   The identifier of the device.
 122  *
 123  * @return
 124  *   - 0 on success
 125  *   - -ENODEV if dev_id is invalid or the device is corrupted
 126  *   - -EBUSY if the identified device has already started
 127  *   - -ENOTSUP if the interrupts are not supported by the device
 128  */
 129 int __rte_experimental
 130 rte_bbdev_intr_enable(uint16_t dev_id);
 131
 132 /** Device queue configuration structure */
 133 struct rte_bbdev_queue_conf {
 134         int socket;  /**< NUMA socket used for memory allocation */
 135         uint32_t queue_size;  /**< Size of queue */
 136         uint8_t priority;  /**< Queue priority */
 137         bool deferred_start; /**< Do not start queue when device is started. */
 138         enum rte_bbdev_op_type op_type; /**< Operation type */
 139 };
 140
 141 /**
 142  * Configure a queue on a device.
 143  * This function can be called after device configuration, and before starting.
 144  * It can also be called when the device or the queue is in the stopped state.
 145  *
 146  * @param dev_id
 147  *   The identifier of the device.
 148  * @param queue_id
 149  *   The index of the queue.
 150  * @param conf
 151  *   The queue configuration. If NULL, a default configuration will be used.
 152  *
 153  * @return
 154  *   - 0 on success
 155  *   - EINVAL if the identified queue size or priority are invalid
 156  *   - EBUSY if the identified queue or its device have already started
 157  */
 158 int __rte_experimental
 159 rte_bbdev_queue_configure(uint16_t dev_id, uint16_t queue_id,
 160                 const struct rte_bbdev_queue_conf *conf);
 161
 162 /**
 163  * Start a device.
 164  * This is the last step needed before enqueueing operations is possible.
 165  *
 166  * @param dev_id
 167  *   The identifier of the device.
 168  *
 169  * @return
 170  *   - 0 on success
 171  *   - negative value on failure - as returned from PMD driver
 172  */
 173 int __rte_experimental
 174 rte_bbdev_start(uint16_t dev_id);
 175
 176 /**
 177  * Stop a device.
 178  * The device can be reconfigured, and restarted after being stopped.
 179  *
 180  * @param dev_id
 181  *   The identifier of the device.
 182  *
 183  * @return
 184  *   - 0 on success
 185  */
 186 int __rte_experimental
 187 rte_bbdev_stop(uint16_t dev_id);
 188
 189 /**
 190  * Close a device.
 191  * The device cannot be restarted without reconfiguration!
 192  *
 193  * @param dev_id
 194  *   The identifier of the device.
 195  *
 196  * @return
 197  *   - 0 on success
 198  */
 199 int __rte_experimental
 200 rte_bbdev_close(uint16_t dev_id);
 201
 202 /**
 203  * Start a specified queue on a device.
 204  * This is only needed if the queue has been stopped, or if the deferred_start
 205  * flag has been set when configuring the queue.
 206  *
 207  * @param dev_id
 208  *   The identifier of the device.
 209  * @param queue_id
 210  *   The index of the queue.
 211  *
 212  * @return
 213  *   - 0 on success
 214  *   - negative value on failure - as returned from PMD driver
 215  */
 216 int __rte_experimental
 217 rte_bbdev_queue_start(uint16_t dev_id, uint16_t queue_id);
 218
 219 /**
 220  * Stop a specified queue on a device, to allow re configuration.
 221  *
 222  * @param dev_id
 223  *   The identifier of the device.
 224  * @param queue_id
 225  *   The index of the queue.
 226  *
 227  * @return
 228  *   - 0 on success
 229  *   - negative value on failure - as returned from PMD driver
 230  */
 231 int __rte_experimental
 232 rte_bbdev_queue_stop(uint16_t dev_id, uint16_t queue_id);
 233
 234 /** Device statistics. */
 235 struct rte_bbdev_stats {
 236         uint64_t enqueued_count;  /**< Count of all operations enqueued */
 237         uint64_t dequeued_count;  /**< Count of all operations dequeued */
 238         /** Total error count on operations enqueued */
 239         uint64_t enqueue_err_count;
 240         /** Total error count on operations dequeued */
 241         uint64_t dequeue_err_count;
 242         /** Offload time */
 243         uint64_t offload_time;
 244 };
 245
 246 /**
 247  * Retrieve the general I/O statistics of a device.
 248  *
 249  * @param dev_id
 250  *   The identifier of the device.
 251  * @param stats
 252  *   Pointer to structure to where statistics will be copied. On error, this
 253  *   location may or may not have been modified.
 254  *
 255  * @return
 256  *   - 0 on success
 257  *   - EINVAL if invalid parameter pointer is provided
 258  */
 259 int __rte_experimental
 260 rte_bbdev_stats_get(uint16_t dev_id, struct rte_bbdev_stats *stats);
 261
 262 /**
 263  * Reset the statistics of a device.
 264  *
 265  * @param dev_id
 266  *   The identifier of the device.
 267  * @return
 268  *   - 0 on success
 269  */
 270 int __rte_experimental
 271 rte_bbdev_stats_reset(uint16_t dev_id);
 272
 273 /** Device information supplied by the device's driver */
 274 struct rte_bbdev_driver_info {
 275         /** Driver name */
 276         const char *driver_name;
 277
 278         /** Maximum number of queues supported by the device */
 279         unsigned int max_num_queues;
 280         /** Queue size limit (queue size must also be power of 2) */
 281         uint32_t queue_size_lim;
 282         /** Set if device off-loads operation to hardware  */
 283         bool hardware_accelerated;
 284         /** Max value supported by queue priority */
 285         uint8_t max_queue_priority;
 286         /** Set if device supports per-queue interrupts */
 287         bool queue_intr_supported;
 288         /** Minimum alignment of buffers, in bytes */
 289         uint16_t min_alignment;
 290         /** Default queue configuration used if none is supplied  */
 291         struct rte_bbdev_queue_conf default_queue_conf;
 292         /** Device operation capabilities */
 293         const struct rte_bbdev_op_cap *capabilities;
 294         /** Device cpu_flag requirements */
 295         const enum rte_cpu_flag_t *cpu_flag_reqs;
 296 };
 297
 298 /** Macro used at end of bbdev PMD list */
 299 #define RTE_BBDEV_END_OF_CAPABILITIES_LIST() \
 300         { RTE_BBDEV_OP_NONE }
 301
 302 /**
 303  * Device information structure used by an application to discover a devices
 304  * capabilities and current configuration
 305  */
 306 struct rte_bbdev_info {
 307         int socket_id;  /**< NUMA socket that device is on */
 308         const char *dev_name;  /**< Unique device name */
 309         const struct rte_bus *bus;  /**< Bus information */
 310         uint16_t num_queues;  /**< Number of queues currently configured */
 311         bool started;  /**< Set if device is currently started */
 312         struct rte_bbdev_driver_info drv;  /**< Info from device driver */
 313 };
 314
 315 /**
 316  * Retrieve information about a device.
 317  *
 318  * @param dev_id
 319  *   The identifier of the device.
 320  * @param dev_info
 321  *   Pointer to structure to where information will be copied. On error, this
 322  *   location may or may not have been modified.
 323  *
 324  * @return
 325  *   - 0 on success
 326  *   - EINVAL if invalid parameter pointer is provided
 327  */
 328 int __rte_experimental
 329 rte_bbdev_info_get(uint16_t dev_id, struct rte_bbdev_info *dev_info);
 330
 331 /** Queue information */
 332 struct rte_bbdev_queue_info {
 333         /** Current device configuration */
 334         struct rte_bbdev_queue_conf conf;
 335         /** Set if queue is currently started */
 336         bool started;
 337 };
 338
 339 /**
 340  * Retrieve information about a specific queue on a device.
 341  *
 342  * @param dev_id
 343  *   The identifier of the device.
 344  * @param queue_id
 345  *   The index of the queue.
 346  * @param queue_info
 347  *   Pointer to structure to where information will be copied. On error, this
 348  *   location may or may not have been modified.
 349  *
 350  * @return
 351  *   - 0 on success
 352  *   - EINVAL if invalid parameter pointer is provided
 353  */
 354 int __rte_experimental
 355 rte_bbdev_queue_info_get(uint16_t dev_id, uint16_t queue_id,
 356                 struct rte_bbdev_queue_info *queue_info);
 357
 358 /** @internal The data structure associated with each queue of a device. */
 359 struct rte_bbdev_queue_data {
 360         void *queue_private;  /**< Driver-specific per-queue data */
 361         struct rte_bbdev_queue_conf conf;  /**< Current configuration */
 362         struct rte_bbdev_stats queue_stats;  /**< Queue statistics */
 363         bool started;  /**< Queue state */
 364 };
 365
 366 /** @internal Enqueue encode operations for processing on queue of a device. */
 367 typedef uint16_t (*rte_bbdev_enqueue_enc_ops_t)(
 368                 struct rte_bbdev_queue_data *q_data,
 369                 struct rte_bbdev_enc_op **ops,
 370                 uint16_t num);
 371
 372 /** @internal Enqueue decode operations for processing on queue of a device. */
 373 typedef uint16_t (*rte_bbdev_enqueue_dec_ops_t)(
 374                 struct rte_bbdev_queue_data *q_data,
 375                 struct rte_bbdev_dec_op **ops,
 376                 uint16_t num);
 377
 378 /** @internal Dequeue encode operations from a queue of a device. */
 379 typedef uint16_t (*rte_bbdev_dequeue_enc_ops_t)(
 380                 struct rte_bbdev_queue_data *q_data,
 381                 struct rte_bbdev_enc_op **ops, uint16_t num);
 382
 383 /** @internal Dequeue decode operations from a queue of a device. */
 384 typedef uint16_t (*rte_bbdev_dequeue_dec_ops_t)(
 385                 struct rte_bbdev_queue_data *q_data,
 386                 struct rte_bbdev_dec_op **ops, uint16_t num);
 387
 388 #define RTE_BBDEV_NAME_MAX_LEN  64  /**< Max length of device name */
 389
 390 /**
 391  * @internal The data associated with a device, with no function pointers.
 392  * This structure is safe to place in shared memory to be common among
 393  * different processes in a multi-process configuration. Drivers can access
 394  * these fields, but should never write to them!
 395  */
 396 struct rte_bbdev_data {
 397         char name[RTE_BBDEV_NAME_MAX_LEN]; /**< Unique identifier name */
 398         void *dev_private;  /**< Driver-specific private data */
 399         uint16_t num_queues;  /**< Number of currently configured queues */
 400         struct rte_bbdev_queue_data *queues;  /**< Queue structures */
 401         uint16_t dev_id;  /**< Device ID */
 402         int socket_id;  /**< NUMA socket that device is on */
 403         bool started;  /**< Device run-time state */
 404         /** Counter of processes using the device */
 405         rte_atomic16_t process_cnt;
 406 };
 407
 408 /* Forward declarations */
 409 struct rte_bbdev_ops;
 410 struct rte_bbdev_callback;
 411 struct rte_intr_handle;
 412
 413 /** Structure to keep track of registered callbacks */
 414 TAILQ_HEAD(rte_bbdev_cb_list, rte_bbdev_callback);
 415
 416 /**
 417  * @internal The data structure associated with a device. Drivers can access
 418  * these fields, but should only write to the *_ops fields.
 419  */
 420 struct __rte_cache_aligned rte_bbdev {
 421         /**< Enqueue encode function */
 422         rte_bbdev_enqueue_enc_ops_t enqueue_enc_ops;
 423         /**< Enqueue decode function */
 424         rte_bbdev_enqueue_dec_ops_t enqueue_dec_ops;
 425         /**< Dequeue encode function */
 426         rte_bbdev_dequeue_enc_ops_t dequeue_enc_ops;
 427         /**< Dequeue decode function */
 428         rte_bbdev_dequeue_dec_ops_t dequeue_dec_ops;
 429         const struct rte_bbdev_ops *dev_ops;  /**< Functions exported by PMD */
 430         struct rte_bbdev_data *data;  /**< Pointer to device data */
 431         enum rte_bbdev_state state;  /**< If device is currently used or not */
 432         struct rte_device *device; /**< Backing device */
 433         /** User application callback for interrupts if present */
 434         struct rte_bbdev_cb_list list_cbs;
 435         struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
 436 };
 437
 438 /** @internal array of all devices */
 439 extern struct rte_bbdev rte_bbdev_devices[];
 440
 441 /**
 442  * Enqueue a burst of processed encode operations to a queue of the device.
 443  * This functions only enqueues as many operations as currently possible and
 444  * does not block until @p num_ops entries in the queue are available.
 445  * This function does not provide any error notification to avoid the
 446  * corresponding overhead.
 447  *
 448  * @param dev_id
 449  *   The identifier of the device.
 450  * @param queue_id
 451  *   The index of the queue.
 452  * @param ops
 453  *   Pointer array containing operations to be enqueued Must have at least
 454  *   @p num_ops entries
 455  * @param num_ops
 456  *   The maximum number of operations to enqueue.
 457  *
 458  * @return
 459  *   The number of operations actually enqueued (this is the number of processed
 460  *   entries in the @p ops array).
 461  */
 462 static inline uint16_t
 463 rte_bbdev_enqueue_enc_ops(uint16_t dev_id, uint16_t queue_id,
 464                 struct rte_bbdev_enc_op **ops, uint16_t num_ops)
 465 {
 466         struct rte_bbdev *dev = &rte_bbdev_devices[dev_id];
 467         struct rte_bbdev_queue_data *q_data = &dev->data->queues[queue_id];
 468         return dev->enqueue_enc_ops(q_data, ops, num_ops);
 469 }
 470
 471 /**
 472  * Enqueue a burst of processed decode operations to a queue of the device.
 473  * This functions only enqueues as many operations as currently possible and
 474  * does not block until @p num_ops entries in the queue are available.
 475  * This function does not provide any error notification to avoid the
 476  * corresponding overhead.
 477  *
 478  * @param dev_id
 479  *   The identifier of the device.
 480  * @param queue_id
 481  *   The index of the queue.
 482  * @param ops
 483  *   Pointer array containing operations to be enqueued Must have at least
 484  *   @p num_ops entries
 485  * @param num_ops
 486  *   The maximum number of operations to enqueue.
 487  *
 488  * @return
 489  *   The number of operations actually enqueued (this is the number of processed
 490  *   entries in the @p ops array).
 491  */
 492 static inline uint16_t
 493 rte_bbdev_enqueue_dec_ops(uint16_t dev_id, uint16_t queue_id,
 494                 struct rte_bbdev_dec_op **ops, uint16_t num_ops)
 495 {
 496         struct rte_bbdev *dev = &rte_bbdev_devices[dev_id];
 497         struct rte_bbdev_queue_data *q_data = &dev->data->queues[queue_id];
 498         return dev->enqueue_dec_ops(q_data, ops, num_ops);
 499 }
 500
 501 /**
 502  * Dequeue a burst of processed encode operations from a queue of the device.
 503  * This functions returns only the current contents of the queue, and does not
 504  * block until @ num_ops is available.
 505  * This function does not provide any error notification to avoid the
 506  * corresponding overhead.
 507  *
 508  * @param dev_id
 509  *   The identifier of the device.
 510  * @param queue_id
 511  *   The index of the queue.
 512  * @param ops
 513  *   Pointer array where operations will be dequeued to. Must have at least
 514  *   @p num_ops entries
 515  * @param num_ops
 516  *   The maximum number of operations to dequeue.
 517  *
 518  * @return
 519  *   The number of operations actually dequeued (this is the number of entries
 520  *   copied into the @p ops array).
 521  */
 522 static inline uint16_t
 523 rte_bbdev_dequeue_enc_ops(uint16_t dev_id, uint16_t queue_id,
 524                 struct rte_bbdev_enc_op **ops, uint16_t num_ops)
 525 {
 526         struct rte_bbdev *dev = &rte_bbdev_devices[dev_id];
 527         struct rte_bbdev_queue_data *q_data = &dev->data->queues[queue_id];
 528         return dev->dequeue_enc_ops(q_data, ops, num_ops);
 529 }
 530
 531 /**
 532  * Dequeue a burst of processed decode operations from a queue of the device.
 533  * This functions returns only the current contents of the queue, and does not
 534  * block until @ num_ops is available.
 535  * This function does not provide any error notification to avoid the
 536  * corresponding overhead.
 537  *
 538  * @param dev_id
 539  *   The identifier of the device.
 540  * @param queue_id
 541  *   The index of the queue.
 542  * @param ops
 543  *   Pointer array where operations will be dequeued to. Must have at least
 544  *   @p num_ops entries
 545  * @param num_ops
 546  *   The maximum number of operations to dequeue.
 547  *
 548  * @return
 549  *   The number of operations actually dequeued (this is the number of entries
 550  *   copied into the @p ops array).
 551  */
 552
 553 static inline uint16_t
 554 rte_bbdev_dequeue_dec_ops(uint16_t dev_id, uint16_t queue_id,
 555                 struct rte_bbdev_dec_op **ops, uint16_t num_ops)
 556 {
 557         struct rte_bbdev *dev = &rte_bbdev_devices[dev_id];
 558         struct rte_bbdev_queue_data *q_data = &dev->data->queues[queue_id];
 559         return dev->dequeue_dec_ops(q_data, ops, num_ops);
 560 }
 561
 562 /** Definitions of device event types */
 563 enum rte_bbdev_event_type {
 564         RTE_BBDEV_EVENT_UNKNOWN,  /**< unknown event type */
 565         RTE_BBDEV_EVENT_ERROR,  /**< error interrupt event */
 566         RTE_BBDEV_EVENT_DEQUEUE,  /**< dequeue event */
 567         RTE_BBDEV_EVENT_MAX  /**< max value of this enum */
 568 };
 569
 570 /**
 571  * Typedef for application callback function registered by application
 572  * software for notification of device events
 573  *
 574  * @param dev_id
 575  *   Device identifier
 576  * @param event
 577  *   Device event to register for notification of.
 578  * @param cb_arg
 579  *   User specified parameter to be passed to user's callback function.
 580  * @param ret_param
 581  *   To pass data back to user application.
 582  */
 583 typedef void (*rte_bbdev_cb_fn)(uint16_t dev_id,
 584                 enum rte_bbdev_event_type event, void *cb_arg,
 585                 void *ret_param);
 586
 587 /**
 588  * Register a callback function for specific device id. Multiple callbacks can
 589  * be added and will be called in the order they are added when an event is
 590  * triggered. Callbacks are called in a separate thread created by the DPDK EAL.
 591  *
 592  * @param dev_id
 593  *   Device id.
 594  * @param event
 595  *   The event that the callback will be registered for.
 596  * @param cb_fn
 597  *   User supplied callback function to be called.
 598  * @param cb_arg
 599  *   Pointer to parameter that will be passed to the callback.
 600  *
 601  * @return
 602  *   Zero on success, negative value on failure.
 603  */
 604 int __rte_experimental
 605 rte_bbdev_callback_register(uint16_t dev_id, enum rte_bbdev_event_type event,
 606                 rte_bbdev_cb_fn cb_fn, void *cb_arg);
 607
 608 /**
 609  * Unregister a callback function for specific device id.
 610  *
 611  * @param dev_id
 612  *   The device identifier.
 613  * @param event
 614  *   The event that the callback will be unregistered for.
 615  * @param cb_fn
 616  *   User supplied callback function to be unregistered.
 617  * @param cb_arg
 618  *   Pointer to the parameter supplied when registering the callback.
 619  *   (void *)-1 means to remove all registered callbacks with the specified
 620  *   function address.
 621  *
 622  * @return
 623  *   - 0 on success
 624  *   - EINVAL if invalid parameter pointer is provided
 625  *   - EAGAIN if the provided callback pointer does not exist
 626  */
 627 int __rte_experimental
 628 rte_bbdev_callback_unregister(uint16_t dev_id, enum rte_bbdev_event_type event,
 629                 rte_bbdev_cb_fn cb_fn, void *cb_arg);
 630
 631 /**
 632  * Enable a one-shot interrupt on the next operation enqueued to a particular
 633  * queue. The interrupt will be triggered when the operation is ready to be
 634  * dequeued. To handle the interrupt, an epoll file descriptor must be
 635  * registered using rte_bbdev_queue_intr_ctl(), and then an application
 636  * thread/lcore can wait for the interrupt using rte_epoll_wait().
 637  *
 638  * @param dev_id
 639  *   The device identifier.
 640  * @param queue_id
 641  *   The index of the queue.
 642  *
 643  * @return
 644  *   - 0 on success
 645  *   - negative value on failure - as returned from PMD driver
 646  */
 647 int __rte_experimental
 648 rte_bbdev_queue_intr_enable(uint16_t dev_id, uint16_t queue_id);
 649
 650 /**
 651  * Disable a one-shot interrupt on the next operation enqueued to a particular
 652  * queue (if it has been enabled).
 653  *
 654  * @param dev_id
 655  *   The device identifier.
 656  * @param queue_id
 657  *   The index of the queue.
 658  *
 659  * @return
 660  *   - 0 on success
 661  *   - negative value on failure - as returned from PMD driver
 662  */
 663 int __rte_experimental
 664 rte_bbdev_queue_intr_disable(uint16_t dev_id, uint16_t queue_id);
 665
 666 /**
 667  * Control interface for per-queue interrupts.
 668  *
 669  * @param dev_id
 670  *   The device identifier.
 671  * @param queue_id
 672  *   The index of the queue.
 673  * @param epfd
 674  *   Epoll file descriptor that will be associated with the interrupt source.
 675  *   If the special value RTE_EPOLL_PER_THREAD is provided, a per thread epoll
 676  *   file descriptor created by the EAL is used (RTE_EPOLL_PER_THREAD can also
 677  *   be used when calling rte_epoll_wait()).
 678  * @param op
 679  *   The operation be performed for the vector.RTE_INTR_EVENT_ADD or
 680  *   RTE_INTR_EVENT_DEL.
 681  * @param data
 682  *   User context, that will be returned in the epdata.data field of the
 683  *   rte_epoll_event structure filled in by rte_epoll_wait().
 684  *
 685  * @return
 686  *   - 0 on success
 687  *   - ENOTSUP if interrupts are not supported by the identified device
 688  *   - negative value on failure - as returned from PMD driver
 689  */
 690 int __rte_experimental
 691 rte_bbdev_queue_intr_ctl(uint16_t dev_id, uint16_t queue_id, int epfd, int op,
 692                 void *data);
 693
 694 #ifdef __cplusplus
 695 }
 696 #endif
 697
 698 #endif /* _RTE_BBDEV_H_ */