[dpdk-stable] patch 'bbdev: fix doxygen comments' has been queued to LTS release 18.11.9

[Kevin Traynor <ktraynor@redhat.com>]

Hi,

FYI, your patch has been queued to LTS release 18.11.9

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 06/10/20. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/kevintraynor/dpdk-stable-queue

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable-queue/commit/f741f61709999aeef4a5d5e0f99052a79d869f57

Thanks.

Kevin.

---
From f741f61709999aeef4a5d5e0f99052a79d869f57 Mon Sep 17 00:00:00 2001
From: Nicolas Chautru <nicolas.chautru@intel.com>
Date: Sun, 19 Apr 2020 16:39:48 -0700
Subject: [PATCH] bbdev: fix doxygen comments

[ upstream commit cc29fea1ca53ce9860566b6986491bcf5aab99b5 ]

Several doxygen markup were incorrect in header files.

Fixes: 4935e1e9f76e ("bbdev: introduce wireless base band device lib")

Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
---
 lib/librte_bbdev/rte_bbdev.h     |  8 ++++----
 lib/librte_bbdev/rte_bbdev_op.h  | 22 +++++++++++++---------
 lib/librte_bbdev/rte_bbdev_pmd.h | 14 +++++++-------
 3 files changed, 24 insertions(+), 20 deletions(-)

diff --git a/lib/librte_bbdev/rte_bbdev.h b/lib/librte_bbdev/rte_bbdev.h
index 4a2873b2fe..f53ee101da 100644
--- a/lib/librte_bbdev/rte_bbdev.h
+++ b/lib/librte_bbdev/rte_bbdev.h
@@ -421,11 +421,11 @@ TAILQ_HEAD(rte_bbdev_cb_list, rte_bbdev_callback);
  */
 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;
 	const struct rte_bbdev_ops *dev_ops;  /**< Functions exported by PMD */
diff --git a/lib/librte_bbdev/rte_bbdev_op.h b/lib/librte_bbdev/rte_bbdev_op.h
index 83f62c2dc2..14cb87cd96 100644
--- a/lib/librte_bbdev/rte_bbdev_op.h
+++ b/lib/librte_bbdev/rte_bbdev_op.h
@@ -278,9 +278,10 @@ struct rte_bbdev_op_turbo_dec {
 	uint8_t num_maps;
 
-	uint8_t code_block_mode; /**< [0 - TB : 1 - CB] */
+	/** [0 - TB : 1 - CB] */
+	uint8_t code_block_mode;
 	union {
-		/**< Struct which stores Code Block specific parameters */
+		/** Struct which stores Code Block specific parameters */
 		struct rte_bbdev_op_dec_cb_params cb_params;
-		/**< Struct which stores Transport Block specific parameters */
+		/** Struct which stores Transport Block specific parameters */
 		struct rte_bbdev_op_dec_tb_params tb_params;
 	};
@@ -339,5 +340,5 @@ struct rte_bbdev_op_enc_tb_params {
 	 */
 	uint16_t ncb_pos;
-	/**< The index of the first CB in the inbound mbuf data, default is 0 */
+	/** The index of the first CB in the inbound mbuf data, default is 0 */
 	uint8_t r;
 };
@@ -420,8 +421,11 @@ enum {
 /**< Structure specifying a single encode operation */
 struct rte_bbdev_enc_op {
-	int status;  /**< Status of operation that was performed */
-	struct rte_mempool *mempool;  /**< Mempool which op instance is in */
-	void *opaque_data;  /**< Opaque pointer for user data */
-	/**< Contains encoder specific parameters */
+	/** Status of operation that was performed */
+	int status;
+	/** Mempool which op instance is in */
+	struct rte_mempool *mempool;
+	/** Opaque pointer for user data */
+	void *opaque_data;
+	/** Contains encoder specific parameters */
 	struct rte_bbdev_op_turbo_enc turbo_enc;
 };
@@ -445,5 +449,5 @@ struct rte_bbdev_op_cap {
 };
 
-/**< @internal Private data structure stored with operation pool. */
+/** @internal Private data structure stored with operation pool. */
 struct rte_bbdev_op_pool_private {
 	enum rte_bbdev_op_type type;  /**< Type of operations in a pool */
diff --git a/lib/librte_bbdev/rte_bbdev_pmd.h b/lib/librte_bbdev/rte_bbdev_pmd.h
index db9a04cdf9..f6091a5e99 100644
--- a/lib/librte_bbdev/rte_bbdev_pmd.h
+++ b/lib/librte_bbdev/rte_bbdev_pmd.h
@@ -144,16 +144,16 @@ typedef int (*rte_bbdev_queue_intr_disable_t)(struct rte_bbdev *dev,
  */
 struct rte_bbdev_ops {
-	/**< Allocate and configure device memory. Optional. */
+	/** Allocate and configure device memory. Optional. */
 	rte_bbdev_setup_queues_t setup_queues;
-	/**< Configure interrupts. Optional. */
+	/** Configure interrupts. Optional. */
 	rte_bbdev_intr_enable_t intr_enable;
-	/**< Start device. Optional. */
+	/** Start device. Optional. */
 	rte_bbdev_start_t start;
-	/**< Stop device. Optional. */
+	/** Stop device. Optional. */
 	rte_bbdev_stop_t stop;
-	/**< Close device. Optional. */
+	/** Close device. Optional. */
 	rte_bbdev_close_t close;
 
-	/**< Get device info. Required. */
+	/** Get device info. Required. */
 	rte_bbdev_info_get_t info_get;
 	/** Get device statistics. Optional. */
@@ -168,5 +168,5 @@ struct rte_bbdev_ops {
 	/** Start a queue. Optional. */
 	rte_bbdev_queue_start_t queue_start;
-	/**< Stop a queue pair. Optional. */
+	/** Stop a queue pair. Optional. */
 	rte_bbdev_queue_stop_t queue_stop;
 
-- 
2.21.3

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2020-06-05 19:20:52.363429719 +0100
+++ 0027-bbdev-fix-doxygen-comments.patch	2020-06-05 19:20:50.754042085 +0100
@@ -1 +1 @@
-From cc29fea1ca53ce9860566b6986491bcf5aab99b5 Mon Sep 17 00:00:00 2001
+From f741f61709999aeef4a5d5e0f99052a79d869f57 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit cc29fea1ca53ce9860566b6986491bcf5aab99b5 ]
+
@@ -9 +10,0 @@
-Cc: stable@dpdk.org
@@ -14,2 +15,2 @@
- lib/librte_bbdev/rte_bbdev.h     | 16 ++++++++--------
- lib/librte_bbdev/rte_bbdev_op.h  | 16 ++++++++--------
+ lib/librte_bbdev/rte_bbdev.h     |  8 ++++----
+ lib/librte_bbdev/rte_bbdev_op.h  | 22 +++++++++++++---------
@@ -17 +18 @@
- 3 files changed, 23 insertions(+), 23 deletions(-)
+ 3 files changed, 24 insertions(+), 20 deletions(-)
@@ -20 +21 @@
-index 38d9d50057..ecd95a823d 100644
+index 4a2873b2fe..f53ee101da 100644
@@ -23 +24 @@
-@@ -443,19 +443,19 @@ TAILQ_HEAD(rte_bbdev_cb_list, rte_bbdev_callback);
+@@ -421,11 +421,11 @@ TAILQ_HEAD(rte_bbdev_cb_list, rte_bbdev_callback);
@@ -38,12 +38,0 @@
--	/**< 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;
@@ -52 +41 @@
-index 9c66721e32..f726d7302e 100644
+index 83f62c2dc2..14cb87cd96 100644
@@ -55 +44 @@
-@@ -399,10 +399,10 @@ struct rte_bbdev_op_turbo_dec {
+@@ -278,9 +278,10 @@ struct rte_bbdev_op_turbo_dec {
@@ -58 +47 @@
--	/**< [0 - TB : 1 - CB] */
+-	uint8_t code_block_mode; /**< [0 - TB : 1 - CB] */
@@ -60 +49 @@
- 	uint8_t code_block_mode;
++	uint8_t code_block_mode;
@@ -64 +53 @@
- 		struct rte_bbdev_op_dec_turbo_cb_params cb_params;
+ 		struct rte_bbdev_op_dec_cb_params cb_params;
@@ -67 +56 @@
- 		struct rte_bbdev_op_dec_turbo_tb_params tb_params;
+ 		struct rte_bbdev_op_dec_tb_params tb_params;
@@ -69 +58 @@
-@@ -555,5 +555,5 @@ struct rte_bbdev_op_enc_turbo_tb_params {
+@@ -339,5 +340,5 @@ struct rte_bbdev_op_enc_tb_params {
@@ -76,2 +65,2 @@
-@@ -752,9 +752,9 @@ enum {
- /** Structure specifying a single encode operation */
+@@ -420,8 +421,11 @@ enum {
+ /**< Structure specifying a single encode operation */
@@ -79 +68,4 @@
--	/**< Status of operation that was performed */
+-	int status;  /**< Status of operation that was performed */
+-	struct rte_mempool *mempool;  /**< Mempool which op instance is in */
+-	void *opaque_data;  /**< Opaque pointer for user data */
+-	/**< Contains encoder specific parameters */
@@ -81,2 +73 @@
- 	int status;
--	/**< Mempool which op instance is in */
++	int status;
@@ -84,2 +75 @@
- 	struct rte_mempool *mempool;
--	/**< Opaque pointer for user data */
++	struct rte_mempool *mempool;
@@ -87,3 +77,5 @@
- 	void *opaque_data;
- 	union {
-@@ -793,5 +793,5 @@ struct rte_bbdev_op_cap {
++	void *opaque_data;
++	/** Contains encoder specific parameters */
+ 	struct rte_bbdev_op_turbo_enc turbo_enc;
+ };
+@@ -445,5 +449,5 @@ struct rte_bbdev_op_cap {
@@ -97 +89 @@
-index 24ddcee7af..237e3361d7 100644
+index db9a04cdf9..f6091a5e99 100644
@@ -100 +92 @@
-@@ -147,16 +147,16 @@ typedef int (*rte_bbdev_queue_intr_disable_t)(struct rte_bbdev *dev,
+@@ -144,16 +144,16 @@ typedef int (*rte_bbdev_queue_intr_disable_t)(struct rte_bbdev *dev,
@@ -123 +115 @@
-@@ -171,5 +171,5 @@ struct rte_bbdev_ops {
+@@ -168,5 +168,5 @@ struct rte_bbdev_ops {