On 1/19/2021 3:19 AM, Qi Zhang wrote:
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 <qi.z.zh...@intel.com>
---
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
Hi Thomas, is the v2 good to go?
