doc: announce changes to event device structures

Message ID 20230725230458.1316-1-pbhagavatula@marvell.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series doc: announce changes to event device structures |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/github-robot: build success github build: passed
ci/iol-abi-testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/iol-aarch-unit-testing success Testing PASS
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-unit-testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS

Commit Message

Pavan Nikhilesh Bhagavatula July 25, 2023, 11:04 p.m. UTC
  From: Pavan Nikhilesh <pbhagavatula@marvell.com>

The structures ``rte_event_dev_info``, ``rte_event_fp_ops`` will be
modified to add new elements to support link profiles.

A new field ``max_profiles_per_port`` will be added to
``rte_event_dev_info`` and ``switch_profile`` will be added to
``rte_event_fp_ops``.
Two new experimental APIs will be added, one to associate one to
associate an set of event queues with a profile which can be linked
to a event port and another to switch the profile which would
affect the next dequeue call.

Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
---
 doc/guides/rel_notes/deprecation.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
  

Comments

Jerin Jacob July 26, 2023, 11:59 a.m. UTC | #1
On Wed, Jul 26, 2023 at 4:35 AM <pbhagavatula@marvell.com> wrote:
>
> From: Pavan Nikhilesh <pbhagavatula@marvell.com>


Please add all eventdev driver and subsystem mainainters.

>
> The structures ``rte_event_dev_info``, ``rte_event_fp_ops`` will be
> modified to add new elements to support link profiles.

Please describe what profile means here. Meaning the usage model.


>
> A new field ``max_profiles_per_port`` will be added to
> ``rte_event_dev_info`` and ``switch_profile`` will be added to
> ``rte_event_fp_ops``.


> Two new experimental APIs will be added, one to associate one to
> associate an set of event queues with a profile which can be linked
> to a event port and another to switch the profile which would
> affect the next dequeue call.
>
> Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 8 ++++++++
>  1 file changed, 8 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index fb771a0305..2b1fcf52ca 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -161,3 +161,11 @@ Deprecation Notices
>    The new port library API (functions rte_swx_port_*)
>    will gradually transition from experimental to stable status
>    starting with DPDK 23.07 release.
> +
> +* eventdev: The structures ``rte_event_dev_info``, ``rte_event_fp_ops`` will be
> +  modified to add new elements to support link profiles.A new field
> +  ``max_profiles_per_port`` will be added to ``rte_event_dev_info`` and
> +  ``switch_profile`` will be added to ``rte_event_fp_ops``.

> +  Two new experimental APIs will be added, one to associate an set of event
> +  queues with a profile which can be linked to a event port and an other to
> +  switch the profile which would affect the next dequeue call.

New API additions does not need to mention here.

> --
> 2.25.1
>
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index fb771a0305..2b1fcf52ca 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -161,3 +161,11 @@  Deprecation Notices
   The new port library API (functions rte_swx_port_*)
   will gradually transition from experimental to stable status
   starting with DPDK 23.07 release.
+
+* eventdev: The structures ``rte_event_dev_info``, ``rte_event_fp_ops`` will be
+  modified to add new elements to support link profiles.A new field
+  ``max_profiles_per_port`` will be added to ``rte_event_dev_info`` and
+  ``switch_profile`` will be added to ``rte_event_fp_ops``.
+  Two new experimental APIs will be added, one to associate an set of event
+  queues with a profile which can be linked to a event port and an other to
+  switch the profile which would affect the next dequeue call.