app/testpmd: add --portlist option

[dpdk.git] / doc / guides / testpmd_app_ug / run_app.rst

diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
index b717b8c..727ef52 100644 (file)
--- a/doc/guides/testpmd_app_ug/run_app.rst
+++ b/doc/guides/testpmd_app_ug/run_app.rst
@@ -7,9 +7,9 @@ Running the Application
 EAL Command-line Options
 ------------------------
 
 EAL Command-line Options
 ------------------------
 

-Please refer to  :doc:`../linux_gsg/linux_eal_parameters` or
-:doc:`../freebsd_gsg/freebsd_eal_parameters` for a list of available EAL
-command-line options.
+Please refer to :doc:`EAL parameters (Linux) <../linux_gsg/linux_eal_parameters>`
+or :doc:`EAL parameters (FreeBSD) <../freebsd_gsg/freebsd_eal_parameters>` for
+a list of available EAL command-line options.

 
 
 Testpmd Command-line Options
 
 
 Testpmd Command-line Options


@@ -22,7 +22,7 @@ They must be separated from the EAL options, shown in the previous section, with
 
     sudo ./testpmd -l 0-3 -n 4 -- -i --portmask=0x1 --nb-cores=2
 
 
     sudo ./testpmd -l 0-3 -n 4 -- -i --portmask=0x1 --nb-cores=2
 

-The commandline options are:
+The command line options are:

 
 *   ``-i, --interactive``
 
 
 *   ``-i, --interactive``
 


@@ -77,6 +77,13 @@ The commandline options are:
 
     Set the hexadecimal bitmask of the ports used by the packet forwarding test.
 
 
     Set the hexadecimal bitmask of the ports used by the packet forwarding test.
 

+*   ``--portlist=X``
+
+      Set the forwarding ports based on the user input used by the packet forwarding test.
+      '-' denotes a range of ports to set including the two specified port IDs
+      ',' separates multiple port values.
+      Possible examples like --portlist=0,1 or --portlist=0-2 or --portlist=0,1-2 etc
+

 *   ``--numa``
 
     Enable NUMA-aware allocation of RX/TX rings and of RX memory buffers
 *   ``--numa``
 
     Enable NUMA-aware allocation of RX/TX rings and of RX memory buffers


@@ -112,6 +119,10 @@ The commandline options are:
 
     Set the maximum packet size to N bytes, where N >= 64. The default value is 1518.
 
 
     Set the maximum packet size to N bytes, where N >= 64. The default value is 1518.
 

+*   ``--max-lro-pkt-size=N``
+
+    Set the maximum LRO aggregated packet size to N bytes, where N >= 64.
+

 *   ``--eth-peers-configfile=name``
 
     Use a configuration file containing the Ethernet addresses of the peer ports.
 *   ``--eth-peers-configfile=name``
 
     Use a configuration file containing the Ethernet addresses of the peer ports.


@@ -121,12 +132,24 @@ The commandline options are:
        XX:XX:XX:XX:XX:02
        ...
 
        XX:XX:XX:XX:XX:02
        ...
 

-

 *   ``--eth-peer=N,XX:XX:XX:XX:XX:XX``
 
     Set the MAC address ``XX:XX:XX:XX:XX:XX`` of the peer port N,
     where 0 <= N < ``CONFIG_RTE_MAX_ETHPORTS`` from the configuration file.
 
 *   ``--eth-peer=N,XX:XX:XX:XX:XX:XX``
 
     Set the MAC address ``XX:XX:XX:XX:XX:XX`` of the peer port N,
     where 0 <= N < ``CONFIG_RTE_MAX_ETHPORTS`` from the configuration file.
 

+*   ``--tx-ip=SRC,DST``
+
+    Set the source and destination IP address used when doing transmit only test.
+    The defaults address values are source 198.18.0.1 and
+    destination 198.18.0.2. These are special purpose addresses
+    reserved for benchmarking (RFC 5735).
+
+*   ``--tx-udp=SRC[,DST]``
+
+    Set the source and destination UDP port number for transmit test only test.
+    The default port is the port 9 which is defined for the discard protocol
+    (RFC 863).
+

 *   ``--pkt-filter-mode=mode``
 
     Set Flow Director mode where mode is either ``none`` (the default), ``signature`` or ``perfect``.
 *   ``--pkt-filter-mode=mode``
 
     Set Flow Director mode where mode is either ``none`` (the default), ``signature`` or ``perfect``.


@@ -186,6 +209,10 @@ The commandline options are:
 
     Enable hardware VLAN extend.
 
 
     Enable hardware VLAN extend.
 

+*   ``--enable-hw-qinq-strip``
+
+    Enable hardware QINQ strip.
+

 *   ``--enable-drop-en``
 
     Enable per-queue packet drop for packets with no descriptors.
 *   ``--enable-drop-en``
 
     Enable per-queue packet drop for packets with no descriptors.


@@ -250,6 +277,17 @@ The commandline options are:
     Set the number of descriptors in the TX rings to N, where N > 0.
     The default value is 512.
 
     Set the number of descriptors in the TX rings to N, where N > 0.
     The default value is 512.
 

+*   ``--hairpinq=N``
+
+    Set the number of hairpin queues per port to N, where 1 <= N <= 65535.
+    The default value is 0. The number of hairpin queues are added to the
+    number of TX queues and to the number of RX queues. then the first
+    RX hairpin is binded to the first TX hairpin, the second RX hairpin is
+    binded to the second TX hairpin and so on. The index of the first
+    RX hairpin queue is the number of RX queues as configured using --rxq.
+    The index of the first TX hairpin queue is the number of TX queues
+    as configured using --txq.
+

 *   ``--burst=N``
 
     Set the number of packets per burst to N, where 1 <= N <= 512.
 *   ``--burst=N``
 
     Set the number of packets per burst to N, where 1 <= N <= 512.


@@ -332,6 +370,12 @@ The commandline options are:
 
     Disable check on link status when starting/stopping ports.
 
 
     Disable check on link status when starting/stopping ports.
 

+*   ``--disable-device-start``
+
+    Do not automatically start all ports. This allows testing
+    configuration of rx and tx queues before device is started
+    for the first time.
+

 *   ``--no-lsc-interrupt``
 
     Disable LSC interrupts for all ports, even those supporting it.
 *   ``--no-lsc-interrupt``
 
     Disable LSC interrupts for all ports, even those supporting it.


@@ -367,9 +411,14 @@ The commandline options are:
     Set the hexadecimal bitmask of TX queue offloads.
     The default value is 0.
 
     Set the hexadecimal bitmask of TX queue offloads.
     The default value is 0.
 

+*   ``--rx-offloads=0xXXXXXXXX``
+
+    Set the hexadecimal bitmask of RX queue offloads.
+    The default value is 0.
+

 *   ``--hot-plug``
 
 *   ``--hot-plug``
 

-    Enable device event monitor machenism for hotplug.
+    Enable device event monitor mechanism for hotplug.

 
 *   ``--vxlan-gpe-port=N``
 
 
 *   ``--vxlan-gpe-port=N``
 


@@ -409,21 +458,26 @@ The commandline options are:
 
 *   ``--noisy-lkup-memory=N``
 
 
 *   ``--noisy-lkup-memory=N``
 

-    Set the size of the noisy neighbour simulation memory buffer in MB to N.
+    Set the size of the noisy neighbor simulation memory buffer in MB to N.

     Only available with the noisy forwarding mode. The default value is 0.
 
 
 *   ``--noisy-lkup-num-reads=N``
 
     Only available with the noisy forwarding mode. The default value is 0.
 
 
 *   ``--noisy-lkup-num-reads=N``
 

-    Set the number of reads to be done in noisy neighbour simulation memory buffer to N.
+    Set the number of reads to be done in noisy neighbor simulation memory buffer to N.

     Only available with the noisy forwarding mode. The default value is 0.
 
 *   ``--noisy-lkup-num-writes=N``
 
     Only available with the noisy forwarding mode. The default value is 0.
 
 *   ``--noisy-lkup-num-writes=N``
 

-    Set the number of writes to be done in noisy neighbour simulation memory buffer to N.
+    Set the number of writes to be done in noisy neighbor simulation memory buffer to N.

     Only available with the noisy forwarding mode. The default value is 0.
 
 *   ``--noisy-lkup-num-reads-writes=N``
 
     Only available with the noisy forwarding mode. The default value is 0.
 
 *   ``--noisy-lkup-num-reads-writes=N``
 

-    Set the number of r/w accesses to be done in noisy neighbour simulation memory buffer to N.
+    Set the number of r/w accesses to be done in noisy neighbor simulation memory buffer to N.

     Only available with the noisy forwarding mode. The default value is 0.
     Only available with the noisy forwarding mode. The default value is 0.

+
+*   ``--no-iova-contig``
+
+    Enable to create mempool which is not IOVA contiguous. Valid only with --mp-alloc=anon.
+    The default value is 0.