X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fprog_guide%2Fgeneric_segmentation_offload_lib.rst;h=e605b863764221b452d71b9947572829cef73cb0;hb=6cc51b1293ceac4a77d4bf7ac91a8bbd59e1f78c;hp=ad91c6e5fce343ed397c495c114bc4ee8b6038db;hpb=c0d002aed98d6d1d38d6bb318a5bd2ed5cdc01b1;p=dpdk.git diff --git a/doc/guides/prog_guide/generic_segmentation_offload_lib.rst b/doc/guides/prog_guide/generic_segmentation_offload_lib.rst index ad91c6e5fc..e605b86376 100644 --- a/doc/guides/prog_guide/generic_segmentation_offload_lib.rst +++ b/doc/guides/prog_guide/generic_segmentation_offload_lib.rst @@ -45,8 +45,8 @@ Limitations - TCP - UDP - - VxLAN - - GRE + - VXLAN + - GRE TCP See `Supported GSO Packet Types`_ for further details. @@ -157,14 +157,14 @@ does not modify it during segmentation. Therefore, after UDP GSO, only the first output packet has the original UDP header, and others just have l2 and l3 headers. -VxLAN GSO -~~~~~~~~~ -VxLAN packets GSO supports segmentation of suitably large VxLAN packets, -which contain an outer IPv4 header, inner TCP/IPv4 headers, and optional -inner and/or outer VLAN tag(s). +VXLAN IPv4 GSO +~~~~~~~~~~~~~~ +VXLAN packets GSO supports segmentation of suitably large VXLAN packets, +which contain an outer IPv4 header, inner TCP/IPv4 or UDP/IPv4 headers, and +optional inner and/or outer VLAN tag(s). -GRE GSO -~~~~~~~ +GRE TCP/IPv4 GSO +~~~~~~~~~~~~~~~~ GRE GSO supports segmentation of suitably large GRE packets, which contain an outer IPv4 header, inner TCP/IPv4 headers, and an optional VLAN tag. @@ -194,11 +194,11 @@ To segment an outgoing packet, an application must: - the bit mask of required GSO types. The GSO library uses the same macros as those that describe a physical device's TX offloading capabilities (i.e. - ``DEV_TX_OFFLOAD_*_TSO``) for gso_types. For example, if an application + ``RTE_ETH_TX_OFFLOAD_*_TSO``) for gso_types. For example, if an application wants to segment TCP/IPv4 packets, it should set gso_types to - ``DEV_TX_OFFLOAD_TCP_TSO``. The only other supported values currently - supported for gso_types are ``DEV_TX_OFFLOAD_VXLAN_TNL_TSO``, and - ``DEV_TX_OFFLOAD_GRE_TNL_TSO``; a combination of these macros is also + ``RTE_ETH_TX_OFFLOAD_TCP_TSO``. The only other supported values currently + supported for gso_types are ``RTE_ETH_TX_OFFLOAD_VXLAN_TNL_TSO``, and + ``RTE_ETH_TX_OFFLOAD_GRE_TNL_TSO``; a combination of these macros is also allowed. - a flag, that indicates whether the IPv4 headers of output segments should @@ -211,11 +211,11 @@ To segment an outgoing packet, an application must: responsibility to ensure that these flags are set. - For example, in order to segment TCP/IPv4 packets, the application should - add the ``PKT_TX_IPV4`` and ``PKT_TX_TCP_SEG`` flags to the mbuf's + add the ``RTE_MBUF_F_TX_IPV4`` and ``RTE_MBUF_F_TX_TCP_SEG`` flags to the mbuf's ol_flags. - If checksum calculation in hardware is required, the application should - also add the ``PKT_TX_TCP_CKSUM`` and ``PKT_TX_IP_CKSUM`` flags. + also add the ``RTE_MBUF_F_TX_TCP_CKSUM`` and ``RTE_MBUF_F_TX_IP_CKSUM`` flags. #. Check if the packet should be processed. Packets with one of the following properties are not processed and are returned immediately: