[PATCH v3 1/3] eventdev: add function to quiesce an event port

[Jerin Jacob]

On Fri, May 13, 2022 at 11:31 PM <pbhagavatula at marvell.com> wrote:
>
> From: Pavan Nikhilesh <pbhagavatula at marvell.com>
>
> Add function to quiesce any core specific resources consumed by
> the event port.
>
> When the application decides to migrate the event port to another lcore
> or teardown the current lcore it may to call `rte_event_port_quiesce`
> to make sure that all the data associated with the event port are released
> from the lcore, this might also include any prefetched events.
>
> While releasing the event port from the lcore, this function calls the
> user-provided flush callback once per event.
>
> Signed-off-by: Pavan Nikhilesh <pbhagavatula at marvell.com>
> ---
>  v3 Changes:
>  - Add `rte_` prefix to callback function.
>  - Fix API documentation issues.
>  - Update eventdev documentation.
>
>  v2 Changes:
>  - Remove internal Change-Id tag from commit messages.

Changed git commit message heading as "eventdev: support to quiesce an
event port"

Also updated release notes and improved the documentation[1]

Series-Acked-by: Jerin Jacob <jerinj at marvell.com>
Series applied to dpdk-next-net-eventdev/for-main. Thanks

[1]
[for-main]dell[dpdk-next-eventdev] $ git diff
diff --git a/doc/guides/prog_guide/eventdev.rst
b/doc/guides/prog_guide/eventdev.rst
index 973c9838ae..7a053de132 100644
--- a/doc/guides/prog_guide/eventdev.rst
+++ b/doc/guides/prog_guide/eventdev.rst
@@ -428,8 +428,7 @@ A flush callback can be passed to the function to
handle any outstanding events.

 .. Note::

-         The event port specific config shall not be reset when this API is
-         invoked.
+        Invocation of this API does not affect the existing port configuration.


 Summary
 -------
diff --git a/doc/guides/rel_notes/release_22_07.rst
b/doc/guides/rel_notes/release_22_07.rst
index 88d6e96cc1..7eae0b04f9 100644
--- a/doc/guides/rel_notes/release_22_07.rst
+++ b/doc/guides/rel_notes/release_22_07.rst
@@ -55,6 +55,12 @@ New Features
      Also, make sure to start the actual text at the margin.
      =======================================================

+* **Added API to quiesce an event port.**
+
+  * Added ``rte_event_port_quiesce()`` to quiesce any lcore specific
+    resources consumed by the event port, when the lcore no more
+    associated with event port.
+
 * **Updated Intel iavf driver.**

   * Added Tx QoS queue rate limitation support.
diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h
index 1a46d289a9..80bfbf4293 100644
--- a/lib/eventdev/rte_eventdev.h
+++ b/lib/eventdev/rte_eventdev.h
@@ -849,8 +849,7 @@ typedef void (*rte_eventdev_port_flush_t)(uint8_t dev_id,
  * While releasing the event port from the lcore, this function calls the
  * user-provided flush callback once per event.
  *
- * @note The event port specific config shall not be reset when this API is
- * called.
+ * @note Invocation of this API does not affect the existing port
configuration.
  *
  * @param dev_id
  *   The identifier of the device.