summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHaiyue Wang <haiyue.wang@intel.com>2019-11-08 23:44:35 +0800
committerFerruh Yigit <ferruh.yigit@intel.com>2019-11-11 14:23:02 +0100
commit328dc5baa767e869417e96695b1f4a80c1dcc166 (patch)
treef9b9a3fd245f0c61e48bbccf619b2877e8aa4fbd
parentefc1b2799f6674341322e2026698755d1dce842f (diff)
downloaddpdk-328dc5baa767e869417e96695b1f4a80c1dcc166.zip
dpdk-328dc5baa767e869417e96695b1f4a80c1dcc166.tar.gz
dpdk-328dc5baa767e869417e96695b1f4a80c1dcc166.tar.xz
doc: add ice PMD in doxygen
Add the doxygen for ice protocol extraction feature APIs. Signed-off-by: Haiyue Wang <haiyue.wang@intel.com> Reviewed-by: Xiaolong Ye <xiaolong.ye@intel.com>
-rw-r--r--doc/api/doxy-api-index.md1
-rw-r--r--doc/api/doxy-api.conf.in1
-rw-r--r--drivers/net/ice/rte_pmd_ice.h55
3 files changed, 57 insertions, 0 deletions
diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 28a5dd3..dff496b 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -42,6 +42,7 @@ The public API headers are grouped by topics:
[KNI] (@ref rte_kni.h),
[ixgbe] (@ref rte_pmd_ixgbe.h),
[i40e] (@ref rte_pmd_i40e.h),
+ [ice] (@ref rte_pmd_ice.h),
[bnxt] (@ref rte_pmd_bnxt.h),
[dpaa] (@ref rte_pmd_dpaa.h),
[dpaa2] (@ref rte_pmd_dpaa2.h),
diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
index 6c985b5..1c4392e 100644
--- a/doc/api/doxy-api.conf.in
+++ b/doc/api/doxy-api.conf.in
@@ -12,6 +12,7 @@ INPUT = @TOPDIR@/doc/api/doxy-api-index.md \
@TOPDIR@/drivers/net/dpaa \
@TOPDIR@/drivers/net/dpaa2 \
@TOPDIR@/drivers/net/i40e \
+ @TOPDIR@/drivers/net/ice \
@TOPDIR@/drivers/net/ixgbe \
@TOPDIR@/drivers/net/softnic \
@TOPDIR@/drivers/raw/dpaa2_cmdif \
diff --git a/drivers/net/ice/rte_pmd_ice.h b/drivers/net/ice/rte_pmd_ice.h
index 717c213..e254db0 100644
--- a/drivers/net/ice/rte_pmd_ice.h
+++ b/drivers/net/ice/rte_pmd_ice.h
@@ -5,6 +5,15 @@
#ifndef _RTE_PMD_ICE_H_
#define _RTE_PMD_ICE_H_
+/**
+ * @file rte_pmd_ice.h
+ *
+ * ice PMD specific functions.
+ *
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ */
+
#include <stdio.h>
#include <rte_mbuf.h>
#include <rte_mbuf_dyn.h>
@@ -13,6 +22,9 @@
extern "C" {
#endif
+/**
+ * The supported network protocol extraction metadata format.
+ */
union rte_net_ice_proto_xtr_metadata {
uint32_t metadata;
@@ -78,26 +90,55 @@ extern uint64_t rte_net_ice_dynflag_proto_xtr_ipv6_mask;
extern uint64_t rte_net_ice_dynflag_proto_xtr_ipv6_flow_mask;
extern uint64_t rte_net_ice_dynflag_proto_xtr_tcp_mask;
+/**
+ * The mbuf dynamic field pointer for protocol extraction metadata.
+ */
#define RTE_NET_ICE_DYNF_PROTO_XTR_METADATA(m) \
RTE_MBUF_DYNFIELD((m), \
rte_net_ice_dynfield_proto_xtr_metadata_offs, \
uint32_t *)
+/**
+ * The mbuf dynamic flag for VLAN protocol extraction metadata, it is valid
+ * when dev_args 'proto_xtr' has 'vlan' specified.
+ */
#define RTE_PKT_RX_DYNF_PROTO_XTR_VLAN \
(rte_net_ice_dynflag_proto_xtr_vlan_mask)
+/**
+ * The mbuf dynamic flag for IPv4 protocol extraction metadata, it is valid
+ * when dev_args 'proto_xtr' has 'ipv4' specified.
+ */
#define RTE_PKT_RX_DYNF_PROTO_XTR_IPV4 \
(rte_net_ice_dynflag_proto_xtr_ipv4_mask)
+/**
+ * The mbuf dynamic flag for IPv6 protocol extraction metadata, it is valid
+ * when dev_args 'proto_xtr' has 'ipv6' specified.
+ */
#define RTE_PKT_RX_DYNF_PROTO_XTR_IPV6 \
(rte_net_ice_dynflag_proto_xtr_ipv6_mask)
+/**
+ * The mbuf dynamic flag for IPv6 with flow protocol extraction metadata, it is
+ * valid when dev_args 'proto_xtr' has 'ipv6_flow' specified.
+ */
#define RTE_PKT_RX_DYNF_PROTO_XTR_IPV6_FLOW \
(rte_net_ice_dynflag_proto_xtr_ipv6_flow_mask)
+/**
+ * The mbuf dynamic flag for TCP protocol extraction metadata, it is valid
+ * when dev_args 'proto_xtr' has 'tcp' specified.
+ */
#define RTE_PKT_RX_DYNF_PROTO_XTR_TCP \
(rte_net_ice_dynflag_proto_xtr_tcp_mask)
+/**
+ * Check if mbuf dynamic field for protocol extraction metadata is registered.
+ *
+ * @return
+ * True if registered, false otherwise.
+ */
__rte_experimental
static __rte_always_inline int
rte_net_ice_dynf_proto_xtr_metadata_avail(void)
@@ -105,6 +146,14 @@ rte_net_ice_dynf_proto_xtr_metadata_avail(void)
return rte_net_ice_dynfield_proto_xtr_metadata_offs != -1;
}
+/**
+ * Get the mbuf dynamic field for protocol extraction metadata.
+ *
+ * @param m
+ * The pointer to the mbuf.
+ * @return
+ * The saved protocol extraction metadata.
+ */
__rte_experimental
static __rte_always_inline uint32_t
rte_net_ice_dynf_proto_xtr_metadata_get(struct rte_mbuf *m)
@@ -112,6 +161,12 @@ rte_net_ice_dynf_proto_xtr_metadata_get(struct rte_mbuf *m)
return *RTE_NET_ICE_DYNF_PROTO_XTR_METADATA(m);
}
+/**
+ * Dump the mbuf dynamic field for protocol extraction metadata.
+ *
+ * @param m
+ * The pointer to the mbuf.
+ */
__rte_experimental
static inline void
rte_net_ice_dump_proto_xtr_metadata(struct rte_mbuf *m)