doc: address the offload API changes for virtio guide

PATCH Applied Tiwei Bie 3 participants 7 messages May 25, 2018

lore

Share & tools

lore

Tiwei Bie

author

2018-05-25 06:18 UTC #0 lore raw

PATCH 1/1 doc: address the offload API changes for virtio guide

Signed-off-by Tiwei Bie <[email protected]>

---
 doc/guides/nics/virtio.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

doc/guides/nics/virtio.rst +2 -2

index 8922f9c0b..a42d1bb30 100644
@@ -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

Signature · 1 line

2.17.0

Maxime Coquelin

Acked-by on v1 1/1

2018-05-25 07:16 UTC #1 lore raw

Quoted 20 lines · Tiwei Bie

Signed-off-by Tiwei Bie <[email protected]>

---
  doc/guides/nics/virtio.rst | 4 ++--
  1 file changed, 2 insertions(+), 2 deletions(-)

doc/guides/nics/virtio.rst +1 -1

index 8922f9c0b..a42d1bb30 100644
@@ -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.

doc/guides/nics/virtio.rst The corresponding callbacks are: · line 258

Quoted 8 lines

doc/guides/nics/virtio.rst +1 -1

@@ -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 <[email protected]>

Thanks for handling the change!
Maxime

Ferruh Yigit

Applied

2018-05-25 08:41 UTC #2 lore raw

Quoted 6 lines · Maxime Coquelin

Quoted 1 line · Tiwei Bie
Signed-off-by Tiwei Bie <[email protected]>
Acked-by Maxime Coquelin <[email protected]>

Applied to dpdk-next-net/master, thanks.

Ferruh Yigit

2018-05-25 08:20 UTC #3 lore raw

In reply to Tiwei Bie

Quoted 1 line · Tiwei Bie

Signed-off-by Tiwei Bie <[email protected]>

<...>

doc/guides/nics/virtio.rst The corresponding callbacks are: · line 255

Quoted 6 lines

doc/guides/nics/virtio.rst +1 -1

@@ -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

author

2018-05-25 08:27 UTC #4 lore raw

Quoted 9 lines · Ferruh Yigit

Quoted 1 line · Tiwei Bie
Signed-off-by Tiwei Bie <[email protected]>
<...>
Quoted 4 lines
doc/guides/nics/virtio.rst +0 -0
@@ -252,7 +252,7 @@ The corresponding callbacks are:
 Example of using the vector version of the virtio poll mode driver in
 ``testpmd``::
 

Quoted 8 lines

doc/guides/nics/virtio.rst The corresponding callbacks are: · line 255
Quoted 2 lines
doc/guides/nics/virtio.rst +1 -1
-   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

Quoted 16 lines

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

author

2018-05-25 08:54 UTC #5 lore raw

Quoted 15 lines · Tiwei Bie

Quoted 14 lines · Ferruh Yigit
Quoted 1 line · Tiwei Bie
Signed-off-by Tiwei Bie <[email protected]>
<...>
doc/guides/nics/virtio.rst The corresponding callbacks are: · line 255
Quoted 6 lines
doc/guides/nics/virtio.rst +1 -1
@@ -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].

Quoted 19 lines

Quoted 3 lines
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
Quoted 10 lines
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

Quoted 6 lines

Quoted 6 lines
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

2018-05-25 09:09 UTC #6 lore raw

Quoted 40 lines · Tiwei Bie

Quoted 15 lines · Tiwei Bie
Quoted 14 lines · Ferruh Yigit
Quoted 1 line · Tiwei Bie
Signed-off-by Tiwei Bie <[email protected]>
<...>
doc/guides/nics/virtio.rst The corresponding callbacks are: · line 255
Quoted 6 lines
doc/guides/nics/virtio.rst +1 -1
@@ -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].
Quoted 19 lines
Quoted 3 lines
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
Quoted 10 lines
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:

Quoted 5 lines

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.

Quoted 11 lines

Best regards,
Tiwei Bie
Quoted 6 lines
Quoted 6 lines
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