From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 8658BA0A03; Tue, 19 Jan 2021 04:15:16 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 6C0CA140DB9; Tue, 19 Jan 2021 04:15:16 +0100 (CET) Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by mails.dpdk.org (Postfix) with ESMTP id B9120140D95 for ; Tue, 19 Jan 2021 04:15:15 +0100 (CET) IronPort-SDR: +HIFTO0s2TbMzYwTvmjhHDkmvcl7m1nZhKnddM8hgbc0hbt5U8QKfh0pL3218IdGq2qjZkf2jQ QTYO/VJdPtjQ== X-IronPort-AV: E=McAfee;i="6000,8403,9868"; a="263679750" X-IronPort-AV: E=Sophos;i="5.79,357,1602572400"; d="scan'208";a="263679750" Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 18 Jan 2021 19:15:14 -0800 IronPort-SDR: MjaxsGEQuvhCc1QVhmCCecPGdQrEWL9aeJnZ8ihm5jb9v/uxnNin9mGsVdn1HMx2Go0pCYUzVc YYK2AagZ1QFg== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.79,357,1602572400"; d="scan'208";a="466527530" Received: from dpdk51.sh.intel.com ([10.67.111.142]) by fmsmga001.fm.intel.com with ESMTP; 18 Jan 2021 19:15:13 -0800 From: Qi Zhang To: thomas@monjalon.net Cc: ferruh.yigit@intel.com, dev@dpdk.org, Qi Zhang Date: Tue, 19 Jan 2021 11:19:05 +0800 Message-Id: <20210119031905.518082-1-qi.z.zhang@intel.com> X-Mailer: git-send-email 2.26.2 In-Reply-To: <20210112114703.350878-1-qi.z.zhang@intel.com> References: <20210112114703.350878-1-qi.z.zhang@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v2] ethdev: refine doxygen for add UDP tunnel port API X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Refine the doxygen for rte_eth_dev_udp_tunnel_port_add. Add more detail description of the impacted offload functions. Signed-off-by: Qi Zhang --- v2: - reword doxygen that focus on API impact base on previous discussion. lib/librte_ethdev/rte_ethdev.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h index f758ec837..ab50a7039 100644 --- a/lib/librte_ethdev/rte_ethdev.h +++ b/lib/librte_ethdev/rte_ethdev.h @@ -4031,6 +4031,17 @@ rte_eth_dev_rss_hash_conf_get(uint16_t port_id, * to change or add more UDP port for the tunnel. So the offloading function * can take effect on the packets with the specific UDP port. * + * The impacted offloading functions include: + * + * - A specific tunnel type in mbuf->packet_type + * + * - A rte_flow rule that matches on specific tunnel header + * + * NOTE: If a packet only has a matched UDP port but don't have a legal tunnel + * header, the packet may still not be recognized as a tunnel packet by + * the device parser, then the related offloading function will not take + * effect. + * * @param port_id * The port identifier of the Ethernet device. * @param tunnel_udp -- 2.26.2