[v2] doc: announce changes to event device structures

Message ID 20230726155524.799-1-pbhagavatula@marvell.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series [v2] 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-broadcom-Performance success Performance Testing PASS
ci/github-robot: build success github build: passed
ci/intel-Functional success Functional PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-unit-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-aarch-unit-testing success Testing PASS

Commit Message

Pavan Nikhilesh Bhagavatula July 26, 2023, 3:55 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``.

A profile is a unique identifier for a set of event queues linked to
an event port. The unique identifier spans from 0 to the value
advertised in ``rte_event_dev_info.max_profiles_per_port`` - 1.

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

Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
---
v2 Changes:
- Add more description to commit log.
- Remove experimental API description from deprication.rst.

 doc/guides/rel_notes/deprecation.rst | 5 +++++
 1 file changed, 5 insertions(+)

--
2.25.1
  

Comments

Jerin Jacob July 27, 2023, 9:01 a.m. UTC | #1
On Wed, Jul 26, 2023 at 9:25 PM <pbhagavatula@marvell.com> wrote:
>
> 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``.
>
> A profile is a unique identifier for a set of event queues linked to
> an event port. The unique identifier spans from 0 to the value
> advertised in ``rte_event_dev_info.max_profiles_per_port`` - 1.
>
> Two new experimental APIs will be added, one to associate a set of
> event queues with a profile which can be linked to an event port and
> another to switch the profile which would affect the next dequeue call.
>
> Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>

> +
> +* 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``.

There are other  deprecation notices to update rte_event_fp_ops.
Exact  fields  in rte_event_dev_info be decided later along with patch.
With that

Acked-by: Jerin Jacob <jerinj@marvell.com>



> --
> 2.25.1
>
  
Hemant Agrawal July 27, 2023, 9:02 a.m. UTC | #2
> > 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``.
> >
> > A profile is a unique identifier for a set of event queues linked to
> > an event port. The unique identifier spans from 0 to the value
> > advertised in ``rte_event_dev_info.max_profiles_per_port`` - 1.
> >
> > Two new experimental APIs will be added, one to associate a set of
> > event queues with a profile which can be linked to an event port and
> > another to switch the profile which would affect the next dequeue call.
> >
> > Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
> 
> > +
> > +* 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``.
> 
> There are other  deprecation notices to update rte_event_fp_ops.
> Exact  fields  in rte_event_dev_info be decided later along with patch.
> With that
> 
> Acked-by: Jerin Jacob <jerinj@marvell.com>
 Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> 
> 
> > --
> > 2.25.1
> >
  
Thomas Monjalon July 28, 2023, 3:14 p.m. UTC | #3
27/07/2023 11:01, Jerin Jacob:
> On Wed, Jul 26, 2023 at 9:25 PM <pbhagavatula@marvell.com> wrote:
> >
> > 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``.
> >
> > A profile is a unique identifier for a set of event queues linked to
> > an event port. The unique identifier spans from 0 to the value
> > advertised in ``rte_event_dev_info.max_profiles_per_port`` - 1.
> >
> > Two new experimental APIs will be added, one to associate a set of
> > event queues with a profile which can be linked to an event port and
> > another to switch the profile which would affect the next dequeue call.
> >
> > Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
> 
> > +
> > +* 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``.
> 
> There are other  deprecation notices to update rte_event_fp_ops.
> Exact  fields  in rte_event_dev_info be decided later along with patch.
> With that
> 
> Acked-by: Jerin Jacob <jerinj@marvell.com>

Actually it does not look necessary to announce adding new fields.
The ABI compatibility breakage should be covered by this patch:
https://patches.dpdk.org/project/dpdk/patch/20230728142946.1201459-1-thomas@monjalon.net/

Marking as superseded.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index fb771a0305..1c52159673 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -161,3 +161,8 @@  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``.