diff mbox

[dpdk-dev] doc: address the offload API changes for virtio guide

Message ID 20180525061748.16184-1-tiwei.bie@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Tiwei Bie May 25, 2018, 6:17 a.m. UTC 
  Signed-off-by: Tiwei Bie <tiwei.bie@intel.com>
---
 doc/guides/nics/virtio.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Maxime Coquelin May 25, 2018, 7:16 a.m. UTC | #1 
On 05/25/2018 08:17 AM, Tiwei Bie wrote:
> Signed-off-by: Tiwei Bie <tiwei.bie@intel.com>
> ---
>   doc/guides/nics/virtio.rst | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
> index 8922f9c0b..a42d1bb30 100644
> --- a/doc/guides/nics/virtio.rst
> +++ b/doc/guides/nics/virtio.rst
> @@ -234,7 +234,7 @@ By default, the non-vector callbacks are used:
>   
>   Vector callbacks will be used when:
>   
> -*   ``txq_flags`` is set to ``VIRTIO_SIMPLE_FLAGS`` (0xF01), which implies:
> +*   ``txmode.offloads`` is set to ``0x0``, which implies:
>   
>       *   Single segment is specified.
>   
> @@ -252,7 +252,7 @@ The corresponding callbacks are:
>   Example of using the vector version of the virtio poll mode driver in
>   ``testpmd``::
>   
> -   testpmd -l 0-2 -n 4 -- -i --txqflags=0xF01 --rxq=1 --txq=1 --nb-cores=1
> +   testpmd -l 0-2 -n 4 -- -i --tx-offloads=0x0 --rxq=1 --txq=1 --nb-cores=1
>   
>   
>   Interrupt mode
> 

Acked-by: Maxime Coquelin <maxime.coquelin@redhat.com>

Thanks for handling the change!
Maxime
Ferruh Yigit May 25, 2018, 8:20 a.m. UTC | #2 
On 5/25/2018 7:17 AM, Tiwei Bie wrote:
> Signed-off-by: Tiwei Bie <tiwei.bie@intel.com>

<...>

> @@ -252,7 +252,7 @@ The corresponding callbacks are:
>  Example of using the vector version of the virtio poll mode driver in
>  ``testpmd``::
>  
> -   testpmd -l 0-2 -n 4 -- -i --txqflags=0xF01 --rxq=1 --txq=1 --nb-cores=1
> +   testpmd -l 0-2 -n 4 -- -i --tx-offloads=0x0 --rxq=1 --txq=1 --nb-cores=1

Thanks, I missed this one, there are a few occurrence of "--txqflags" [1].

Tiwei would you mind sending another patch for those?
In below context "--txqflags" is not really focus, I think we can just remove it
without replacing with "--tx-offloads"

Thanks,
ferruh


[1]
doc/guides/contributing/documentation.rst:             -- -i --txqflags=0x0
--enable-hw-vlan --enable-lro \
doc/guides/howto/vfd.rst:      testpmd -l 0-7 -n 4 -- -i --txqflags=0
doc/guides/howto/vfd.rst:      testpmd -l 0-7 -n 4 -- -i --txqflags=0
doc/guides/howto/virtio_user_as_exceptional_path.rst:           -- -i
--txqflags=0x0 --enable-lro \
doc/guides/howto/virtio_user_as_exceptional_path.rst:           -- -i
--txqflags=0x0 --enable-lro \
doc/guides/howto/virtio_user_for_container_networking.rst:            -- -i
--txqflags=0xf00 --disable-hw-vlan
Tiwei Bie May 25, 2018, 8:27 a.m. UTC | #3 
On Fri, May 25, 2018 at 09:20:08AM +0100, Ferruh Yigit wrote:
> On 5/25/2018 7:17 AM, Tiwei Bie wrote:
> > Signed-off-by: Tiwei Bie <tiwei.bie@intel.com>
> 
> <...>
> 
> > @@ -252,7 +252,7 @@ The corresponding callbacks are:
> >  Example of using the vector version of the virtio poll mode driver in
> >  ``testpmd``::
> >  
> > -   testpmd -l 0-2 -n 4 -- -i --txqflags=0xF01 --rxq=1 --txq=1 --nb-cores=1
> > +   testpmd -l 0-2 -n 4 -- -i --tx-offloads=0x0 --rxq=1 --txq=1 --nb-cores=1
> 
> Thanks, I missed this one, there are a few occurrence of "--txqflags" [1].
> 
> Tiwei would you mind sending another patch for those?
> In below context "--txqflags" is not really focus, I think we can just remove it
> without replacing with "--tx-offloads"

No problem. I will do it now. :)

Best regards,
Tiwei Bie

> 
> Thanks,
> ferruh
> 
> 
> [1]
> doc/guides/contributing/documentation.rst:             -- -i --txqflags=0x0
> --enable-hw-vlan --enable-lro \
> doc/guides/howto/vfd.rst:      testpmd -l 0-7 -n 4 -- -i --txqflags=0
> doc/guides/howto/vfd.rst:      testpmd -l 0-7 -n 4 -- -i --txqflags=0
> doc/guides/howto/virtio_user_as_exceptional_path.rst:           -- -i
> --txqflags=0x0 --enable-lro \
> doc/guides/howto/virtio_user_as_exceptional_path.rst:           -- -i
> --txqflags=0x0 --enable-lro \
> doc/guides/howto/virtio_user_for_container_networking.rst:            -- -i
> --txqflags=0xf00 --disable-hw-vlan
Ferruh Yigit May 25, 2018, 8:41 a.m. UTC | #4 
On 5/25/2018 8:16 AM, Maxime Coquelin wrote:
> 
> 
> On 05/25/2018 08:17 AM, Tiwei Bie wrote:
>> Signed-off-by: Tiwei Bie <tiwei.bie@intel.com>
>
> Acked-by: Maxime Coquelin <maxime.coquelin@redhat.com>

Applied to dpdk-next-net/master, thanks.
Tiwei Bie May 25, 2018, 8:54 a.m. UTC | #5 
On Fri, May 25, 2018 at 04:27:36PM +0800, Tiwei Bie wrote:
> On Fri, May 25, 2018 at 09:20:08AM +0100, Ferruh Yigit wrote:
> > On 5/25/2018 7:17 AM, Tiwei Bie wrote:
> > > Signed-off-by: Tiwei Bie <tiwei.bie@intel.com>
> > 
> > <...>
> > 
> > > @@ -252,7 +252,7 @@ The corresponding callbacks are:
> > >  Example of using the vector version of the virtio poll mode driver in
> > >  ``testpmd``::
> > >  
> > > -   testpmd -l 0-2 -n 4 -- -i --txqflags=0xF01 --rxq=1 --txq=1 --nb-cores=1
> > > +   testpmd -l 0-2 -n 4 -- -i --tx-offloads=0x0 --rxq=1 --txq=1 --nb-cores=1
> > 
> > Thanks, I missed this one, there are a few occurrence of "--txqflags" [1].
> > 
> > Tiwei would you mind sending another patch for those?
> > In below context "--txqflags" is not really focus, I think we can just remove it
> > without replacing with "--tx-offloads"
> 
> No problem. I will do it now. :)
> 
> Best regards,
> Tiwei Bie
> 
> > 
> > Thanks,
> > ferruh
> > 
> > 
> > [1]
> > doc/guides/contributing/documentation.rst:             -- -i --txqflags=0x0
> > --enable-hw-vlan --enable-lro \
> > doc/guides/howto/vfd.rst:      testpmd -l 0-7 -n 4 -- -i --txqflags=0
> > doc/guides/howto/vfd.rst:      testpmd -l 0-7 -n 4 -- -i --txqflags=0

Hmm.. After a closer look, I think above two --txqflags can't
be simply removed. In this guide, it needs to demonstrate these
offloads, e.g. VLAN insertion:

http://dpdk.org/browse/dpdk/tree/doc/guides/howto/vfd.rst?h=v18.05-rc5#n155

Right now, unfortunately I'm being busy with preparing a QEMU
patch set which I need to get it done today. So I'm afraid that
I don't have time to look into this today.. I'm Sorry.. :(

Best regards,
Tiwei Bie


> > doc/guides/howto/virtio_user_as_exceptional_path.rst:           -- -i
> > --txqflags=0x0 --enable-lro \
> > doc/guides/howto/virtio_user_as_exceptional_path.rst:           -- -i
> > --txqflags=0x0 --enable-lro \
> > doc/guides/howto/virtio_user_for_container_networking.rst:            -- -i
> > --txqflags=0xf00 --disable-hw-vlan
Ferruh Yigit May 25, 2018, 9:09 a.m. UTC | #6 
On 5/25/2018 9:54 AM, Tiwei Bie wrote:
> On Fri, May 25, 2018 at 04:27:36PM +0800, Tiwei Bie wrote:
>> On Fri, May 25, 2018 at 09:20:08AM +0100, Ferruh Yigit wrote:
>>> On 5/25/2018 7:17 AM, Tiwei Bie wrote:
>>>> Signed-off-by: Tiwei Bie <tiwei.bie@intel.com>
>>>
>>> <...>
>>>
>>>> @@ -252,7 +252,7 @@ The corresponding callbacks are:
>>>>  Example of using the vector version of the virtio poll mode driver in
>>>>  ``testpmd``::
>>>>  
>>>> -   testpmd -l 0-2 -n 4 -- -i --txqflags=0xF01 --rxq=1 --txq=1 --nb-cores=1
>>>> +   testpmd -l 0-2 -n 4 -- -i --tx-offloads=0x0 --rxq=1 --txq=1 --nb-cores=1
>>>
>>> Thanks, I missed this one, there are a few occurrence of "--txqflags" [1].
>>>
>>> Tiwei would you mind sending another patch for those?
>>> In below context "--txqflags" is not really focus, I think we can just remove it
>>> without replacing with "--tx-offloads"
>>
>> No problem. I will do it now. :)
>>
>> Best regards,
>> Tiwei Bie
>>
>>>
>>> Thanks,
>>> ferruh
>>>
>>>
>>> [1]
>>> doc/guides/contributing/documentation.rst:             -- -i --txqflags=0x0
>>> --enable-hw-vlan --enable-lro \
>>> doc/guides/howto/vfd.rst:      testpmd -l 0-7 -n 4 -- -i --txqflags=0
>>> doc/guides/howto/vfd.rst:      testpmd -l 0-7 -n 4 -- -i --txqflags=0
> 
> Hmm.. After a closer look, I think above two --txqflags can't
> be simply removed. In this guide, it needs to demonstrate these
> offloads, e.g. VLAN insertion:
> 
> http://dpdk.org/browse/dpdk/tree/doc/guides/howto/vfd.rst?h=v18.05-rc5#n155
> 
> Right now, unfortunately I'm being busy with preparing a QEMU
> patch set which I need to get it done today. So I'm afraid that
> I don't have time to look into this today.. I'm Sorry.. :(

That is OK, if it is not simply removing, agreed that it should be done by owner
of the code. Thanks for offering support.

> 
> Best regards,
> Tiwei Bie
> 
> 
>>> doc/guides/howto/virtio_user_as_exceptional_path.rst:           -- -i
>>> --txqflags=0x0 --enable-lro \
>>> doc/guides/howto/virtio_user_as_exceptional_path.rst:           -- -i
>>> --txqflags=0x0 --enable-lro \
>>> doc/guides/howto/virtio_user_for_container_networking.rst:            -- -i
>>> --txqflags=0xf00 --disable-hw-vlan
diff mbox

Patch

diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
index 8922f9c0b..a42d1bb30 100644
--- a/doc/guides/nics/virtio.rst
+++ b/doc/guides/nics/virtio.rst
@@ -234,7 +234,7 @@  By default, the non-vector callbacks are used:
 
 Vector callbacks will be used when:
 
-*   ``txq_flags`` is set to ``VIRTIO_SIMPLE_FLAGS`` (0xF01), which implies:
+*   ``txmode.offloads`` is set to ``0x0``, which implies:
 
     *   Single segment is specified.
 
@@ -252,7 +252,7 @@  The corresponding callbacks are:
 Example of using the vector version of the virtio poll mode driver in
 ``testpmd``::
 
-   testpmd -l 0-2 -n 4 -- -i --txqflags=0xF01 --rxq=1 --txq=1 --nb-cores=1
+   testpmd -l 0-2 -n 4 -- -i --tx-offloads=0x0 --rxq=1 --txq=1 --nb-cores=1
 
 
 Interrupt mode