From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id 6BDCF1B44B; Tue, 23 Apr 2019 12:45:34 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 23 Apr 2019 03:45:33 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.60,385,1549958400"; d="scan'208";a="144938516" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by orsmga003.jf.intel.com with ESMTP; 23 Apr 2019 03:45:31 -0700 Received: from wgcvswdev001.ir.intel.com (wgcvswdev001.ir.intel.com [10.102.246.100]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id x3NAjUfO010135; Tue, 23 Apr 2019 11:45:30 +0100 Received: from wgcvswdev001.ir.intel.com (localhost [127.0.0.1]) by wgcvswdev001.ir.intel.com with ESMTP id x3NAilB8020407; Tue, 23 Apr 2019 11:44:47 +0100 Received: (from tchaitax@localhost) by wgcvswdev001.ir.intel.com with œ id x3NAikGS020401; Tue, 23 Apr 2019 11:44:46 +0100 From: Agalya Babu RadhaKrishnan To: dev@dpdk.org Cc: reshma.pattan@intel.com, olivier.matz@6wind.com, ramirose@gmail.com, bernard.iremonger@intel.com, ferruh.yigit@intel.com, Agalya Babu RadhaKrishnan , stable@dpdk.org Date: Tue, 23 Apr 2019 11:44:27 +0100 Message-Id: <1556016267-20308-1-git-send-email-agalyax.babu.radhakrishnan@intel.com> X-Mailer: git-send-email 1.7.0.7 In-Reply-To: <1555396398-17880-1-git-send-email-agalyax.babu.radhakrishnan@intel.com> References: <1555396398-17880-1-git-send-email-agalyax.babu.radhakrishnan@intel.com> Subject: [dpdk-dev] [PATCH v2] doc: fix interactive commands in testpmd guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 23 Apr 2019 10:45:35 -0000 Added some missing documentation for interactive mode commands Fixes: 01b2092a5e ("testpmd: add dump commands for debug") Fixes: caf05a1b86 ("app/testpmd: new command to dump log types") Fixes: 0f62d63593ed ("app/testpmd: support tunneled TSO in checksum engine") Fixes: 8fff667578a7 ("app/testpmd: new command to add/remove multicast MAC addresses") Fixes: ae03d0d18adf ("app/testpmd: command to configure MTU") Fixes: f79959ea1504 ("app/testpmd: allow to configure RSS hash key") Fixes: caf05a1b8608 ("app/testpmd: new command to dump log types") Cc: stable@dpdk.org Signed-off-by: Agalya Babu RadhaKrishnan Reviewed-by: Rami Rosen Acked-by: Bernard Iremonger --- v2: Added fixes lines and addressed comments. --- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 100 ++++++++++++++++++++ 1 file changed, 100 insertions(+) diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst index 5d4dc6f0c..cdcc51957 100644 --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst @@ -467,6 +467,56 @@ Show Tx metadata value set for a specific port:: testpmd> show port (port_id) tx_metadata +dump physmem +~~~~~~~~~~~~ + +Dumps all physical memory segment layouts:: + + testpmd> dump_physmem + +dump memzone +~~~~~~~~~~~~ + +Dumps the layout of all memory zones:: + + testpmd> dump_memzone + + +dump struct size +~~~~~~~~~~~~~~~~ + +Dumps the size of all memory structures:: + + testpmd> dump_struct_sizes + +dump ring +~~~~~~~~~ + +Dumps the status of all or specific element in DPDK rings:: + + testpmd> dump_ring [ring_name] + +dump mempool +~~~~~~~~~~~~ + +Dumps the statistics of all or specific memory pool:: + + testpmd> dump_mempool [mempool_name] + +dump devargs +~~~~~~~~~~~~ + +Dumps the user device list:: + + testpmd> dump_devargs + +dump log types +~~~~~~~~~~~~~~ + +Dumps the log level for all the dpdk modules:: + + testpmd> dump_log_types + Configuration Functions ----------------------- @@ -1041,6 +1091,20 @@ Display the status of TCP Segmentation Offload:: testpmd> tso show (port_id) +tunnel tso set +~~~~~~~~~~~~~~ + +Set tso segment size of tunneled packets for a port in csum engine:: + + testpmd> tunnel_tso set (tso_segsz) (port_id) + +tunnel tso show +~~~~~~~~~~~~~~~ + +Display the status of tunneled TCP Segmentation Offload for a port:: + + testpmd> tunnel_tso show (port_id) + set port - gro ~~~~~~~~~~~~~~ @@ -1162,6 +1226,22 @@ Remove a MAC address from a port:: testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX) +mcast_addr add +~~~~~~~~~~~~~~ + +To add the multicast MAC address to/from the set of multicast addresses +filtered by port:: + + testpmd> mcast_addr add (port_id) (mcast_addr) + +mcast_addr remove +~~~~~~~~~~~~~~~~~ + +To remove the multicast MAC address to/from the set of multicast addresses +filtered by port:: + + testpmd> mcast_addr remove (port_id) (mcast_addr) + mac_addr add (for VF) ~~~~~~~~~~~~~~~~~~~~~ @@ -2183,6 +2263,26 @@ testpmd will add this value to any Tx packet sent from this port:: testpmd> port config (port_id) tx_metadata (value) +port config mtu +~~~~~~~~~~~~~~~ + +To configure MTU(Maximum Transmission Unit) on devices using testpmd:: + + testpmd> port config mtu (port_id) (value) + +port config rss hash key +~~~~~~~~~~~~~~~~~~~~~~~~ + +To configure the RSS hash key used to compute the RSS +hash of input [IP] packets received on port:: + + testpmd> port config rss-hash-key (ipv4|ipv4-frag|\ + ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\ + ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\ + ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\ + ipv6-udp-ex ) + Link Bonding Functions ---------------------- -- 2.17.2 From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by dpdk.space (Postfix) with ESMTP id ED61EA05D3 for ; Tue, 23 Apr 2019 12:45:37 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id BEB631B4CE; Tue, 23 Apr 2019 12:45:36 +0200 (CEST) Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id 6BDCF1B44B; Tue, 23 Apr 2019 12:45:34 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 23 Apr 2019 03:45:33 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.60,385,1549958400"; d="scan'208";a="144938516" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by orsmga003.jf.intel.com with ESMTP; 23 Apr 2019 03:45:31 -0700 Received: from wgcvswdev001.ir.intel.com (wgcvswdev001.ir.intel.com [10.102.246.100]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id x3NAjUfO010135; Tue, 23 Apr 2019 11:45:30 +0100 Received: from wgcvswdev001.ir.intel.com (localhost [127.0.0.1]) by wgcvswdev001.ir.intel.com with ESMTP id x3NAilB8020407; Tue, 23 Apr 2019 11:44:47 +0100 Received: (from tchaitax@localhost) by wgcvswdev001.ir.intel.com with œ id x3NAikGS020401; Tue, 23 Apr 2019 11:44:46 +0100 From: Agalya Babu RadhaKrishnan To: dev@dpdk.org Cc: reshma.pattan@intel.com, olivier.matz@6wind.com, ramirose@gmail.com, bernard.iremonger@intel.com, ferruh.yigit@intel.com, Agalya Babu RadhaKrishnan , stable@dpdk.org Date: Tue, 23 Apr 2019 11:44:27 +0100 Message-Id: <1556016267-20308-1-git-send-email-agalyax.babu.radhakrishnan@intel.com> X-Mailer: git-send-email 1.7.0.7 In-Reply-To: <1555396398-17880-1-git-send-email-agalyax.babu.radhakrishnan@intel.com> References: <1555396398-17880-1-git-send-email-agalyax.babu.radhakrishnan@intel.com> Subject: [dpdk-dev] [PATCH v2] doc: fix interactive commands in testpmd guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Content-Type: text/plain; charset="UTF-8" Message-ID: <20190423104427.RaCTT4PM7vbNASJlU6LMbaTqWXvtUBtv9A__65NMk_Q@z> Added some missing documentation for interactive mode commands Fixes: 01b2092a5e ("testpmd: add dump commands for debug") Fixes: caf05a1b86 ("app/testpmd: new command to dump log types") Fixes: 0f62d63593ed ("app/testpmd: support tunneled TSO in checksum engine") Fixes: 8fff667578a7 ("app/testpmd: new command to add/remove multicast MAC addresses") Fixes: ae03d0d18adf ("app/testpmd: command to configure MTU") Fixes: f79959ea1504 ("app/testpmd: allow to configure RSS hash key") Fixes: caf05a1b8608 ("app/testpmd: new command to dump log types") Cc: stable@dpdk.org Signed-off-by: Agalya Babu RadhaKrishnan Reviewed-by: Rami Rosen Acked-by: Bernard Iremonger --- v2: Added fixes lines and addressed comments. --- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 100 ++++++++++++++++++++ 1 file changed, 100 insertions(+) diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst index 5d4dc6f0c..cdcc51957 100644 --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst @@ -467,6 +467,56 @@ Show Tx metadata value set for a specific port:: testpmd> show port (port_id) tx_metadata +dump physmem +~~~~~~~~~~~~ + +Dumps all physical memory segment layouts:: + + testpmd> dump_physmem + +dump memzone +~~~~~~~~~~~~ + +Dumps the layout of all memory zones:: + + testpmd> dump_memzone + + +dump struct size +~~~~~~~~~~~~~~~~ + +Dumps the size of all memory structures:: + + testpmd> dump_struct_sizes + +dump ring +~~~~~~~~~ + +Dumps the status of all or specific element in DPDK rings:: + + testpmd> dump_ring [ring_name] + +dump mempool +~~~~~~~~~~~~ + +Dumps the statistics of all or specific memory pool:: + + testpmd> dump_mempool [mempool_name] + +dump devargs +~~~~~~~~~~~~ + +Dumps the user device list:: + + testpmd> dump_devargs + +dump log types +~~~~~~~~~~~~~~ + +Dumps the log level for all the dpdk modules:: + + testpmd> dump_log_types + Configuration Functions ----------------------- @@ -1041,6 +1091,20 @@ Display the status of TCP Segmentation Offload:: testpmd> tso show (port_id) +tunnel tso set +~~~~~~~~~~~~~~ + +Set tso segment size of tunneled packets for a port in csum engine:: + + testpmd> tunnel_tso set (tso_segsz) (port_id) + +tunnel tso show +~~~~~~~~~~~~~~~ + +Display the status of tunneled TCP Segmentation Offload for a port:: + + testpmd> tunnel_tso show (port_id) + set port - gro ~~~~~~~~~~~~~~ @@ -1162,6 +1226,22 @@ Remove a MAC address from a port:: testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX) +mcast_addr add +~~~~~~~~~~~~~~ + +To add the multicast MAC address to/from the set of multicast addresses +filtered by port:: + + testpmd> mcast_addr add (port_id) (mcast_addr) + +mcast_addr remove +~~~~~~~~~~~~~~~~~ + +To remove the multicast MAC address to/from the set of multicast addresses +filtered by port:: + + testpmd> mcast_addr remove (port_id) (mcast_addr) + mac_addr add (for VF) ~~~~~~~~~~~~~~~~~~~~~ @@ -2183,6 +2263,26 @@ testpmd will add this value to any Tx packet sent from this port:: testpmd> port config (port_id) tx_metadata (value) +port config mtu +~~~~~~~~~~~~~~~ + +To configure MTU(Maximum Transmission Unit) on devices using testpmd:: + + testpmd> port config mtu (port_id) (value) + +port config rss hash key +~~~~~~~~~~~~~~~~~~~~~~~~ + +To configure the RSS hash key used to compute the RSS +hash of input [IP] packets received on port:: + + testpmd> port config rss-hash-key (ipv4|ipv4-frag|\ + ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\ + ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\ + ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\ + ipv6-udp-ex ) + Link Bonding Functions ---------------------- -- 2.17.2