From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from dpdk.org (dpdk.org [92.243.14.124])
by inbox.dpdk.org (Postfix) with ESMTP id A827BA04B4;
Fri, 8 Nov 2019 16:51:00 +0100 (CET)
Received: from [92.243.14.124] (localhost [127.0.0.1])
by dpdk.org (Postfix) with ESMTP id 6B19A1C25E;
Fri, 8 Nov 2019 16:50:48 +0100 (CET)
Received: from mga12.intel.com (mga12.intel.com [192.55.52.136])
by dpdk.org (Postfix) with ESMTP id 169BD1C230
for <dev@dpdk.org>; Fri, 8 Nov 2019 16:50:42 +0100 (CET)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from fmsmga006.fm.intel.com ([10.253.24.20])
by fmsmga106.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
08 Nov 2019 07:50:42 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.68,281,1569308400"; d="scan'208";a="404493820"
Received: from npg-dpdk-haiyue-1.sh.intel.com ([10.67.119.213])
by fmsmga006.fm.intel.com with ESMTP; 08 Nov 2019 07:50:41 -0800
From: Haiyue Wang <haiyue.wang@intel.com>
To: xiaolong.ye@intel.com, dev@dpdk.org, ferruh.yigit@intel.com,
thomas@monjalon.net, olivier.matz@6wind.com
Cc: Haiyue Wang <haiyue.wang@intel.com>
Date: Fri, 8 Nov 2019 23:44:35 +0800
Message-Id: <20191108154435.80841-3-haiyue.wang@intel.com>
X-Mailer: git-send-email 2.17.1
In-Reply-To: <20191108154435.80841-1-haiyue.wang@intel.com>
References: <20191105011918.53434-1-haiyue.wang@intel.com>
<20191108154435.80841-1-haiyue.wang@intel.com>
Subject: [dpdk-dev] [PATCH v10 2/2] doc: add the ice PMD doxygen
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>
Add the doxygen for ice protocol extraction feature APIs.
Signed-off-by: Haiyue Wang <haiyue.wang@intel.com>
---
doc/api/doxy-api-index.md | 1 +
doc/api/doxy-api.conf.in | 1 +
drivers/net/ice/rte_pmd_ice.h | 55 +++++++++++++++++++++++++++++++++++
3 files changed, 57 insertions(+)
diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 28a5dd37e..dff496be0 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 cb67eb728..350b442a1 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 717c2130b..e254db053 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)
--
2.17.1