eal: fix thread header include
[dpdk.git] / lib / librte_bbdev / rte_bbdev.h
index 591fb79..7017124 100644 (file)
@@ -11,7 +11,8 @@
  * Wireless base band device abstraction APIs.
  *
  * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
+ * @b EXPERIMENTAL:
+ * All functions in this file may be changed or removed without prior notice.
  *
  * This API allows an application to discover, configure and use a device to
  * process operations. An asynchronous API (enqueue, followed by later dequeue)
@@ -32,7 +33,6 @@ extern "C" {
 #include <string.h>
 
 #include <rte_compat.h>
-#include <rte_atomic.h>
 #include <rte_bus.h>
 #include <rte_cpuflags.h>
 #include <rte_memory.h>
@@ -307,6 +307,8 @@ struct rte_bbdev_driver_info {
        bool queue_intr_supported;
        /** Minimum alignment of buffers, in bytes */
        uint16_t min_alignment;
+       /** HARQ memory available in kB */
+       uint32_t harq_buffer_size;
        /** Default queue configuration used if none is supplied  */
        struct rte_bbdev_queue_conf default_queue_conf;
        /** Device operation capabilities */
@@ -423,8 +425,7 @@ struct rte_bbdev_data {
        uint16_t dev_id;  /**< Device ID */
        int socket_id;  /**< NUMA socket that device is on */
        bool started;  /**< Device run-time state */
-       /** Counter of processes using the device */
-       rte_atomic16_t process_cnt;
+       uint16_t process_cnt;  /** Counter of processes using the device */
 };
 
 /* Forward declarations */
@@ -440,21 +441,21 @@ TAILQ_HEAD(rte_bbdev_cb_list, rte_bbdev_callback);
  * these fields, but should only write to the *_ops fields.
  */
 struct __rte_cache_aligned rte_bbdev {
-       /**< Enqueue encode function */
+       /** Enqueue encode function */
        rte_bbdev_enqueue_enc_ops_t enqueue_enc_ops;
-       /**< Enqueue decode function */
+       /** Enqueue decode function */
        rte_bbdev_enqueue_dec_ops_t enqueue_dec_ops;
-       /**< Dequeue encode function */
+       /** Dequeue encode function */
        rte_bbdev_dequeue_enc_ops_t dequeue_enc_ops;
-       /**< Dequeue decode function */
+       /** Dequeue decode function */
        rte_bbdev_dequeue_dec_ops_t dequeue_dec_ops;
-       /**< Enqueue encode function */
+       /** Enqueue encode function */
        rte_bbdev_enqueue_enc_ops_t enqueue_ldpc_enc_ops;
-       /**< Enqueue decode function */
+       /** Enqueue decode function */
        rte_bbdev_enqueue_dec_ops_t enqueue_ldpc_dec_ops;
-       /**< Dequeue encode function */
+       /** Dequeue encode function */
        rte_bbdev_dequeue_enc_ops_t dequeue_ldpc_enc_ops;
-       /**< Dequeue decode function */
+       /** Dequeue decode function */
        rte_bbdev_dequeue_dec_ops_t dequeue_ldpc_dec_ops;
        const struct rte_bbdev_ops *dev_ops;  /**< Functions exported by PMD */
        struct rte_bbdev_data *data;  /**< Pointer to device data */
@@ -607,6 +608,7 @@ rte_bbdev_enqueue_ldpc_dec_ops(uint16_t dev_id, uint16_t queue_id,
  * @param ops
  *   Pointer array where operations will be dequeued to. Must have at least
  *   @p num_ops entries
+ *   ie. A pointer to a table of void * pointers (ops) that will be filled.
  * @param num_ops
  *   The maximum number of operations to dequeue.
  *
@@ -638,6 +640,7 @@ rte_bbdev_dequeue_enc_ops(uint16_t dev_id, uint16_t queue_id,
  * @param ops
  *   Pointer array where operations will be dequeued to. Must have at least
  *   @p num_ops entries
+ *   ie. A pointer to a table of void * pointers (ops) that will be filled.
  * @param num_ops
  *   The maximum number of operations to dequeue.
  *