diff options
Diffstat (limited to 'doc/guides/prog_guide')
-rw-r--r-- | doc/guides/prog_guide/env_abstraction_layer.rst | 9 | ||||
-rw-r--r-- | doc/guides/prog_guide/generic_receive_offload_lib.rst | 19 | ||||
-rw-r--r-- | doc/guides/prog_guide/power_man.rst | 8 | ||||
-rw-r--r-- | doc/guides/prog_guide/rte_flow.rst | 10 |
4 files changed, 32 insertions, 14 deletions
diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst index 8b5d050c..426acfc2 100644 --- a/doc/guides/prog_guide/env_abstraction_layer.rst +++ b/doc/guides/prog_guide/env_abstraction_layer.rst @@ -147,15 +147,6 @@ A default validator callback is provided by EAL, which can be enabled with a ``--socket-limit`` command-line option, for a simple way to limit maximum amount of memory that can be used by DPDK application. -.. note:: - - In multiprocess scenario, all related processes (i.e. primary process, and - secondary processes running with the same prefix) must be in the same memory - modes. That is, if primary process is run in dynamic memory mode, all of its - secondary processes must be run in the same mode. The same is applicable to - ``--single-file-segments`` command-line option - both primary and secondary - processes must shared this mode. - + Legacy memory mode This mode is enabled by specifying ``--legacy-mem`` command-line switch to the diff --git a/doc/guides/prog_guide/generic_receive_offload_lib.rst b/doc/guides/prog_guide/generic_receive_offload_lib.rst index 9c6a4d08..5b3fb91c 100644 --- a/doc/guides/prog_guide/generic_receive_offload_lib.rst +++ b/doc/guides/prog_guide/generic_receive_offload_lib.rst @@ -191,3 +191,22 @@ Header fields deciding if packets are neighbors include: ignore IPv4 ID fields for the packets whose DF bit is 1. Additionally, packets which have different value of DF bit can't be merged. + +GRO Library Limitations +----------------------- + +- GRO library uses MBUF->l2_len/l3_len/l4_len/outer_l2_len/ + outer_l3_len/packet_type to get protocol headers for the + input packet, rather than parsing the packet header. Therefore, + before call GRO APIs to merge packets, user applications + must set MBUF->l2_len/l3_len/l4_len/outer_l2_len/outer_l3_len/ + packet_type to the same values as the protocol headers of the + packet. + +- GRO library doesn't support to process the packets with IPv4 + Options or VLAN tagged. + +- GRO library just supports to process the packet organized + in a single MBUF. If the input packet consists of multiple + MBUFs (i.e. chained MBUFs), GRO reassembly behaviors are + unknown. diff --git a/doc/guides/prog_guide/power_man.rst b/doc/guides/prog_guide/power_man.rst index 68b7e8b6..0a3755a9 100644 --- a/doc/guides/prog_guide/power_man.rst +++ b/doc/guides/prog_guide/power_man.rst @@ -184,7 +184,7 @@ API Overview for Empty Poll Power Management * **Update Valid Poll Counter**: update the valid poll counter. -* **Set the Fequence Index**: update the power state/frequency mapping. +* **Set the Frequency Index**: update the power state/frequency mapping. * **Detect empty poll state change**: empty poll state change detection algorithm then take action. @@ -195,6 +195,8 @@ The mechanism can applied to any device which is based on polling. e.g. NIC, FPG References ---------- -* l3fwd-power: The sample application in DPDK that performs L3 forwarding with power management. +* The :doc:`../sample_app_ug/l3_forward_power_man` + chapter in the :doc:`../sample_app_ug/index` section. -* The "L3 Forwarding with Power Management Sample Application" chapter in the *DPDK Sample Application's User Guide*. +* The :doc:`../sample_app_ug/vm_power_management` + chapter in the :doc:`../sample_app_ug/index` section. diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst index c1863750..dbf4999a 100644 --- a/doc/guides/prog_guide/rte_flow.rst +++ b/doc/guides/prog_guide/rte_flow.rst @@ -2314,7 +2314,10 @@ in pattern, Some PMDs will reject rule because behaviour will be undefined. Action: ``SET_MAC_SRC`` ^^^^^^^^^^^^^^^^^^^^^^^ -Set source MAC address +Set source MAC address. + +It must be used with a valid RTE_FLOW_ITEM_TYPE_ETH flow pattern item. +Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned. .. _table_rte_flow_action_set_mac_src: @@ -2329,7 +2332,10 @@ Set source MAC address Action: ``SET_MAC_DST`` ^^^^^^^^^^^^^^^^^^^^^^^ -Set source MAC address +Set destination MAC address. + +It must be used with a valid RTE_FLOW_ITEM_TYPE_ETH flow pattern item. +Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned. .. _table_rte_flow_action_set_mac_dst: |