[dpdk-dev] [PATCH] ethdev: refine API description
From: Qi Zhang <hidden>
Date: 2021-01-12 11:43:16
Subsystem:
library code, the rest · Maintainers:
Andrew Morton, Linus Torvalds
Refine the description for rte_eth_dev_udp_tunnel_port_add. Claim this is an API for device (or port) level configuration. Signed-off-by: Qi Zhang <redacted> --- lib/librte_ethdev/rte_ethdev.h | 10 ++++++++++ 1 file changed, 10 insertions(+)
diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
index f5f891918..a7bb16d45 100644
--- a/lib/librte_ethdev/rte_ethdev.h
+++ b/lib/librte_ethdev/rte_ethdev.h@@ -4030,6 +4030,16 @@ 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. * + * Due to different requirements from different use cases, NICs may have a + * different way to identify a UDP port as a tunnel type. Some NIC takes this + * as a device (or port) level configure while some NIC takes this as a flow + * based configure. + * + * This API is for the first case and typically it will only be implemented + * on a PF driver or a VF driver which have privilege right to configure for + * other VFs. For the second case, a tunnel configure could be embedded in a + * rte_flow rule. + * * @param port_id * The port identifier of the Ethernet device. * @param tunnel_udp
--
2.26.2