From mboxrd@z Thu Jan 1 00:00:00 1970 From: Jiayu Hu Subject: [PATCH] doc: add GRO API requirement in prog_guide Date: Tue, 18 Dec 2018 12:25:19 +0800 Message-ID: <1545107119-85376-1-git-send-email-jiayu.hu@intel.com> Cc: Jiayu Hu To: dev@dpdk.org Return-path: Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by dpdk.org (Postfix) with ESMTP id D289B1B675 for ; Tue, 18 Dec 2018 05:25:47 +0100 (CET) List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" The GRO library requires that applications set correct values for MBUF->l2_len/l3_len/l4_len/outer_l2_len/outer_l3_len/pkt_len/data_len. This patch adds the requirement in prog_guide. Signed-off-by: Jiayu Hu --- doc/guides/prog_guide/generic_receive_offload_lib.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/guides/prog_guide/generic_receive_offload_lib.rst b/doc/guides/prog_guide/generic_receive_offload_lib.rst index 9c6a4d0..7e6944d 100644 --- a/doc/guides/prog_guide/generic_receive_offload_lib.rst +++ b/doc/guides/prog_guide/generic_receive_offload_lib.rst @@ -34,6 +34,12 @@ Currently, the GRO library provides GRO supports for TCP/IPv4 packets and VxLAN packets which contain an outer IPv4 header and an inner TCP/IPv4 packet. +.. note:: + To use the GRO library, applications must guarantee that + MBUF->l2_len/l3_len/l4_len/outer_l2_len/outer_l3_len and + MBUF->pkt_len/data_len of input packets are set to correct + values. + Two Sets of API --------------- -- 2.7.4