X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fnics%2Ftxgbe.rst;h=62aa22932fd237c60e634d37b2d7d8a1ba5d56ba;hb=e3f15be4d41c7ec96e05314fdc31313f9c7a5886;hp=01093d2831b1b9518e3766d7f6667753aaf4993f;hpb=a5682d28f134c2f58a92c5b86b7fb418cef22928;p=dpdk.git diff --git a/doc/guides/nics/txgbe.rst b/doc/guides/nics/txgbe.rst index 01093d2831..62aa22932f 100644 --- a/doc/guides/nics/txgbe.rst +++ b/doc/guides/nics/txgbe.rst @@ -11,15 +11,25 @@ Features -------- - Multiple queues for TX and RX -- MAC filtering +- Receiver Side Scaling (RSS) +- MAC/VLAN filtering - Packet type information - Checksum offload +- VLAN/QinQ stripping and inserting - TSO offload +- Promiscuous mode +- Multicast mode +- Port hardware statistics - Jumbo frames - Link state information +- Link flow control - Interrupt mode for RX - Scattered and gather for TX and RX +- DCB +- IEEE 1588 +- FW version - LRO +- Generic flow API Prerequisites ------------- @@ -76,6 +86,44 @@ Driver compilation and testing Refer to the document :ref:`compiling and testing a PMD for a NIC ` for details. +Sample Application Notes +------------------------ + +Generic flow API +~~~~~~~~~~~~~~~~ + +TXGBE PMD supports generic flow API which configures hardware to match specific +ingress or egress traffic, alter its fate and query related counters according +to any number of user-defined rules. + +A flow rule is the combination of attributes with a matching pattern and a list of +actions. Theorically one rule can match more than one filters, which named for +different patterns and actions. Like ethertype filter defines a rule in pattern: +the first not void item can be ETH, and the next not void item must be END. + +For example, create a flow rule: + +.. code-block:: console + + testpmd> flow create 0 ingress pattern eth type is 0x0806 / end actions queue index 2 / end + +For a detailed usage description please refer to "Flow rules management" section in DPDK :doc:`Testpmd Runtime Functions <../testpmd_app_ug/testpmd_funcs>`. + +Traffic Management API +~~~~~~~~~~~~~~~~~~~~~~ + +TXGBE PMD supports generic DPDK Traffic Management API which allows to +configure the following features: hierarchical scheduling, traffic shaping, +congestion management, packet marking. + +For example, add shaper profile + +.. code-block:: console + + testpmd> add port tm node shaper profile 0 0 0 0 25000000 0 0 + +For a detailed usage description please refer to "Traffic Management" section in DPDK :doc:`Testpmd Runtime Functions <../testpmd_app_ug/testpmd_funcs>`. + Limitations or Known issues ---------------------------