[v4] doc: announce changes to dma device structures

Message ID 20240730144612.2132848-1-amitprakashs@marvell.com (mailing list archive)
State New
Delegated to: Thomas Monjalon
Headers
Series [v4] doc: announce changes to dma 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/github-robot: build success github build: passed
ci/intel-Functional success Functional PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-marvell-Functional success Functional Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS
ci/iol-sample-apps-testing success Testing PASS

Commit Message

Amit Prakash Shukla July 30, 2024, 2:46 p.m. UTC
A new flag RTE_DMA_CAPA_QOS will be introduced to advertise dma
device's QoS capability. In order to support the parameters for this
flag, new fields will be added in rte_dma_info and rte_dma_conf
structures to get device supported priority levels and to configure the
required priority level.

Signed-off-by: Vamsi Attunuru <vattunuru@marvell.com>
Signed-off-by: Amit Prakash Shukla <amitprakashs@marvell.com>
---
v4 changes:
- Fix checkpatch warning.

v3 changes:
- Add maintainers in email list.

v2 changes:
- Add more description to commit log.
- Add more description to deprecation.rst.

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

Comments

Jerin Jacob July 30, 2024, 5:27 p.m. UTC | #1
On Tue, Jul 30, 2024 at 8:25 PM Amit Prakash Shukla
<amitprakashs@marvell.com> wrote:
>
> A new flag RTE_DMA_CAPA_QOS will be introduced to advertise dma
> device's QoS capability. In order to support the parameters for this
> flag, new fields will be added in rte_dma_info and rte_dma_conf
> structures to get device supported priority levels and to configure the
> required priority level.
>
> Signed-off-by: Vamsi Attunuru <vattunuru@marvell.com>
> Signed-off-by: Amit Prakash Shukla <amitprakashs@marvell.com>


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


> ---
> v4 changes:
> - Fix checkpatch warning.
>
> v3 changes:
> - Add maintainers in email list.
>
> v2 changes:
> - Add more description to commit log.
> - Add more description to deprecation.rst.
>
>  doc/guides/rel_notes/deprecation.rst | 5 +++++
>  1 file changed, 5 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 6948641ff6..87f2dfc648 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -147,3 +147,8 @@ Deprecation Notices
>    will be deprecated and subsequently removed in DPDK 24.11 release.
>    Before this, the new port library API (functions rte_swx_port_*)
>    will gradually transition from experimental to stable status.
> +
> +* dmadev: A new flag ``RTE_DMA_CAPA_QOS`` will be introduced to advertise
> +  dma device's QoS capability. In order to support the parameters for this flag,
> +  new fields will be added in ``rte_dma_info`` and ``rte_dma_conf`` structures
> +  to get device supported priority levels and to configure the required priority level.
> --
> 2.34.1
>
  
Thomas Monjalon July 31, 2024, 11:01 a.m. UTC | #2
30/07/2024 19:27, Jerin Jacob:
> On Tue, Jul 30, 2024 at 8:25 PM Amit Prakash Shukla
> <amitprakashs@marvell.com> wrote:
> >
> > A new flag RTE_DMA_CAPA_QOS will be introduced to advertise dma
> > device's QoS capability. In order to support the parameters for this
> > flag, new fields will be added in rte_dma_info and rte_dma_conf
> > structures to get device supported priority levels and to configure the
> > required priority level.
> >
> > Signed-off-by: Vamsi Attunuru <vattunuru@marvell.com>
> > Signed-off-by: Amit Prakash Shukla <amitprakashs@marvell.com>
> 
> 
> Acked-by: Jerin Jacob <jerinj@marvell.com>

Acked-by: Thomas Monjalon <thomas@monjalon.net>
  
Thomas Monjalon July 31, 2024, 4:06 p.m. UTC | #3
31/07/2024 13:01, Thomas Monjalon:
> 30/07/2024 19:27, Jerin Jacob:
> > On Tue, Jul 30, 2024 at 8:25 PM Amit Prakash Shukla
> > <amitprakashs@marvell.com> wrote:
> > >
> > > A new flag RTE_DMA_CAPA_QOS will be introduced to advertise dma
> > > device's QoS capability. In order to support the parameters for this
> > > flag, new fields will be added in rte_dma_info and rte_dma_conf
> > > structures to get device supported priority levels and to configure the
> > > required priority level.
> > >
> > > Signed-off-by: Vamsi Attunuru <vattunuru@marvell.com>
> > > Signed-off-by: Amit Prakash Shukla <amitprakashs@marvell.com>
> > 
> > 
> > Acked-by: Jerin Jacob <jerinj@marvell.com>
> 
> Acked-by: Thomas Monjalon <thomas@monjalon.net>

The RFC and the deprecation notices are sent a bit late.
We cannot conclude there is consensus.

I propose to raise it to the techboard if an ABI breakage is still required for 24.11.
As dmadev is quite new, I don't think it is big issue.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 6948641ff6..87f2dfc648 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -147,3 +147,8 @@  Deprecation Notices
   will be deprecated and subsequently removed in DPDK 24.11 release.
   Before this, the new port library API (functions rte_swx_port_*)
   will gradually transition from experimental to stable status.
+
+* dmadev: A new flag ``RTE_DMA_CAPA_QOS`` will be introduced to advertise
+  dma device's QoS capability. In order to support the parameters for this flag,
+  new fields will be added in ``rte_dma_info`` and ``rte_dma_conf`` structures
+  to get device supported priority levels and to configure the required priority level.