From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga17.intel.com (mga17.intel.com [192.55.52.151]) by dpdk.org (Postfix) with ESMTP id F33121B44F for ; Tue, 16 Apr 2019 08:35:34 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga007.jf.intel.com ([10.7.209.58]) by fmsmga107.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 15 Apr 2019 23:35:33 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.60,355,1549958400"; d="scan'208";a="131760480" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by orsmga007.jf.intel.com with ESMTP; 15 Apr 2019 23:35: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 x3G6ZVBJ021204; Tue, 16 Apr 2019 07:35:31 +0100 Received: from wgcvswdev001.ir.intel.com (localhost [127.0.0.1]) by wgcvswdev001.ir.intel.com with ESMTP id x3G6YmLY018479; Tue, 16 Apr 2019 07:34:48 +0100 Received: (from agalyabx@localhost) by wgcvswdev001.ir.intel.com with œ id x3G6YlWn018473; Tue, 16 Apr 2019 07:34:47 +0100 From: Agalya Babu RadhaKrishnan To: dev@dpdk.org Cc: reshma.pattan@intel.com, olivier.matz@6wind.com, bernard.iremonger@intel.com, Agalya Babu RadhaKrishnan Date: Tue, 16 Apr 2019 07:33:18 +0100 Message-Id: <1555396398-17880-1-git-send-email-agalyax.babu.radhakrishnan@intel.com> X-Mailer: git-send-email 1.7.0.7 Subject: [dpdk-dev] [PATCH] 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, 16 Apr 2019 06:35:35 -0000 From: Agalya Babu RadhaKrishnan 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") Signed-off-by: Agalya Babu RadhaKrishnan --- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 101 ++++++++++++++++++++ 1 file changed, 101 insertions(+) diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst index 5d4dc6f0c..a8954c279 100644 --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst @@ -467,6 +467,57 @@ 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 (string) + +dump mempool +~~~~~~~~~~~~ + +Dumps the statistics of all or specific memory pool:: + + testpmd> dump_mempool (string) + testpmd> dump_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 +1092,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 +1227,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 +2264,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 0F921A00E6 for ; Tue, 16 Apr 2019 08:35:37 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 25FCB1B450; Tue, 16 Apr 2019 08:35:36 +0200 (CEST) Received: from mga17.intel.com (mga17.intel.com [192.55.52.151]) by dpdk.org (Postfix) with ESMTP id F33121B44F for ; Tue, 16 Apr 2019 08:35:34 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga007.jf.intel.com ([10.7.209.58]) by fmsmga107.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 15 Apr 2019 23:35:33 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.60,355,1549958400"; d="scan'208";a="131760480" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by orsmga007.jf.intel.com with ESMTP; 15 Apr 2019 23:35: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 x3G6ZVBJ021204; Tue, 16 Apr 2019 07:35:31 +0100 Received: from wgcvswdev001.ir.intel.com (localhost [127.0.0.1]) by wgcvswdev001.ir.intel.com with ESMTP id x3G6YmLY018479; Tue, 16 Apr 2019 07:34:48 +0100 Received: (from agalyabx@localhost) by wgcvswdev001.ir.intel.com with œ id x3G6YlWn018473; Tue, 16 Apr 2019 07:34:47 +0100 From: Agalya Babu RadhaKrishnan To: dev@dpdk.org Cc: reshma.pattan@intel.com, olivier.matz@6wind.com, bernard.iremonger@intel.com, Agalya Babu RadhaKrishnan Date: Tue, 16 Apr 2019 07:33:18 +0100 Message-Id: <1555396398-17880-1-git-send-email-agalyax.babu.radhakrishnan@intel.com> X-Mailer: git-send-email 1.7.0.7 Subject: [dpdk-dev] [PATCH] 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: <20190416063318.cKDPI7hacFTaInm7t57x9nEODl19gE6Dy4sC-zjuQow@z> From: Agalya Babu RadhaKrishnan 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") Signed-off-by: Agalya Babu RadhaKrishnan --- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 101 ++++++++++++++++++++ 1 file changed, 101 insertions(+) diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst index 5d4dc6f0c..a8954c279 100644 --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst @@ -467,6 +467,57 @@ 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 (string) + +dump mempool +~~~~~~~~~~~~ + +Dumps the statistics of all or specific memory pool:: + + testpmd> dump_mempool (string) + testpmd> dump_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 +1092,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 +1227,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 +2264,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