doc: document memif loopback feature

Message ID 20200309121259.GA29453@vbox (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers
Series doc: document memif loopback feature |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/travis-robot success Travis build: passed
ci/Intel-compilation success Compilation OK

Commit Message

Július Milan March 9, 2020, 12:12 p.m. UTC
  Shows the example of how to connect 2 memif ports into loopback and test
the communication.

Signed-off-by: Július Milan <jmilan.dev@gmail.com>
---
 doc/guides/nics/memif.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
  

Comments

Ferruh Yigit March 9, 2020, 2:43 p.m. UTC | #1
On 3/9/2020 12:12 PM, Július Milan wrote:
> Shows the example of how to connect 2 memif ports into loopback and test
> the communication.
> 
> Signed-off-by: Július Milan <jmilan.dev@gmail.com>

Squashed into relevant commit [1] in next-net, thanks.

[1]
[v3,1/2] net/memif: enable loopback
https://patches.dpdk.org/patch/66447/
  

Patch

diff --git a/doc/guides/nics/memif.rst b/doc/guides/nics/memif.rst
index 4d7f0086a..08a9fda86 100644
--- a/doc/guides/nics/memif.rst
+++ b/doc/guides/nics/memif.rst
@@ -272,3 +272,21 @@  Send ping from VPP::
     64 bytes from 192.168.1.2: icmp_seq=3 ttl=254 time=23.3927 ms
     64 bytes from 192.168.1.2: icmp_seq=4 ttl=254 time=24.2975 ms
     64 bytes from 192.168.1.2: icmp_seq=5 ttl=254 time=17.7049 ms
+
+Example: testpmd memif loopback
+-------------------------------
+In this example we will create 2 memif ports connected into loopback.
+The situation is analogous to cross connecting 2 ports of the NIC by cable.
+
+To set the loopback, just use the same socket and id with different roles::
+
+    #./testpmd --vdev=net_memif0,role=master,id=0 --vdev=net_memif1,role=slave,id=0 -- -i
+
+Then start the communication::
+
+    testpmd> start tx_first
+
+Finally we can check port stats to see the traffic::
+
+    testpmd> show port stats all
+    testpmd> show port stats all