Moved commands in testpmd UG to set queue rates
to match order in testpmd command help.
Created new section "Filters" to match that
same section in testpmd UG, and moved all
commands related to it there.
Signed-off-by: Pablo de Lara
---
doc/guides/testpmd_app_ug/testpmd_funcs.rst | 1041 ++-
1 files changed, 523 insertions(+), 518 deletions(-)
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 975929e..65d3168 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -444,20 +444,6 @@ Remove a VLAN ID, from the set of VLAN identifiers
filtered for VF(s) for port I
rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
-tx_rate (for Queue)
-~~~
-
-Set TX rate limitation for queue of a port ID:
-
-set port (port_id) queue (queue_id) rate (rate_value)
-
-tx_rate (for VF)
-
-
-Set TX rate limitation for queues in VF of a port ID:
-
-set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
-
rx_vlan set tpid
@@ -717,6 +703,20 @@ The available receive modes are:
* MPE: accepts all multicast packets
+set port - tx_rate (for Queue)
+~~
+
+Set TX rate limitation for queue of a port ID:
+
+set port (port_id) queue (queue_id) rate (rate_value)
+
+set port - tx_rate (for VF)
+~~~
+
+Set TX rate limitation for queues in VF of a port ID:
+
+set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
+
set port - mirror rule
~~
@@ -783,903 +783,908 @@ Show the bypass configuration for a bypass enabled NIC
using the lowest port on
show bypass config (port_id)
-add_ethertype_filter
-
+set link up
+~~~
-Add a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly
assign them to a receive queue.
+Set link up for a port.
-add_ethertype_filter (port_id) ethertype (eth_value) priority (enable|disable)
(pri_value) queue (queue_id) index (idx)
+set link-up port (port id)
-The available information parameters are:
+set link down
+~
-* port_id: the port which the Ethertype filter assigned on.
+Set link down for a port.
-* eth_value: the EtherType value want to match,
-for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are
invalid.
+set link-down port (port id)
-* enable: user priority participates in the match.
+Port Functions
+--
-* disable: user priority doesn't participate in the match.
+The following sections show functions for configuring ports.
-* pri_value: user priority value that want to match.
+.. note::
-* queue_id : The receive queue associated with this EtherType filter
+Port configuration changes only become active when forwarding is
started/restarted.
-* index: the index of this EtherType filter
+port start
+~~
-Example:
+Start all ports or a specific port:
-.. code-block:: console
+port start (port_id|all)
-testpmd> add_ethertype_filter 0 ethertype 0x0806 priority disable 0 queue
3 index 0
-Assign ARP packet to receive queue 3
+port stop
+~
-remove_ethertype_filter
-~~~
+Stop all ports or a specific port:
-Remove a L2 Ethertype filter
+port stop (port_id|all)
-remove_ethertype_filter (port_id) index (idx)
+port close
+~~
-get_ethertype_filter
-
+Close all ports or a specific port:
-Get and display a L2 Ethertype filter
+port close (port_id|all)
-get_ethertype_filter (port_id) index (idx)
+port start/stop queue
+~
-Example:
+Start/stop a rx/tx queue on a specific port:
-.. code-block:: console
+port (port_id) (rxq|txq) (queue_id) (start|stop)
-testpmd> get_ethertype_filter 0 index 0
+Only take effect when port is started.
-filter[0]:
-ethertype: 0x0806
-priority: disable, 0
-queue: 3
+port config - speed
+~~~
-add_2tuple_filter
-~
+Set the speed and duplex mode for all ports or a specific port:
-Add a 2-tuple filter,
-which identify packets by specific protocol and destination TCP/UDP port
-and forwards packets into one of the receive queues.
+port config (port_id|all) speed (10|100|1000|1|auto) duplex
(half|full|auto)
-add_2tuple_filter (port_id) protocol (pro_value) (pro_mask) dst_port
(port_value) (port_mask)
-flags (flg_value) priority (prio_value) queue (queue_id) index (idx)
+port config - queues/descriptors
+
-The available information parameters are:
+Set number of queues/descriptors for rxq, txq, rxd and txd:
-* port_id: the port which the 2-tuple filter assigned on.
+port config all (rxq|txq|rxd|txd) (value)
-* pro_value: IP L4 protocol
+This is equivalent to the --rxq, --txq, --rxd and --txd command-line options.
-* pro_mask: protocol participates in the match or not, 1
