From patchwork Tue Jul 11 06:18:43 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Hu, Jiayu" X-Patchwork-Id: 26757 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id 34CAC37AF; Tue, 11 Jul 2017 08:17:06 +0200 (CEST) Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by dpdk.org (Postfix) with ESMTP id A8F253257 for ; Tue, 11 Jul 2017 08:17:03 +0200 (CEST) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga104.jf.intel.com with ESMTP; 10 Jul 2017 23:17:02 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.40,344,1496127600"; d="scan'208";a="991517283" Received: from dpdk15.sh.intel.com ([10.67.111.77]) by orsmga003.jf.intel.com with ESMTP; 10 Jul 2017 23:17:01 -0700 From: Jiayu Hu To: dev@dpdk.org Cc: thomas@monjalon.net, Jiayu Hu Date: Tue, 11 Jul 2017 14:18:43 +0800 Message-Id: <1499753923-112342-1-git-send-email-jiayu.hu@intel.com> X-Mailer: git-send-email 2.7.4 Subject: [dpdk-dev] [PATCH] lib/gro: fix doxygen comment issue X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 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" This patch updates GRO API comments to generate correct API documentation by doxygen. Signed-off-by: Jiayu Hu --- lib/librte_gro/rte_gro.h | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/lib/librte_gro/rte_gro.h b/lib/librte_gro/rte_gro.h index 3b4fec0..c409270 100644 --- a/lib/librte_gro/rte_gro.h +++ b/lib/librte_gro/rte_gro.h @@ -33,36 +33,44 @@ #ifndef _RTE_GRO_H_ #define _RTE_GRO_H_ +/** + * @file + * Interface to GRO library + */ + #ifdef __cplusplus extern "C" { #endif -/**< the max packets number that rte_gro_reassemble_burst() +#define RTE_GRO_MAX_BURST_ITEM_NUM 128U +/**< the max number of packets that rte_gro_reassemble_burst() * can process in each invocation. */ -#define RTE_GRO_MAX_BURST_ITEM_NUM 128U - -/**< max number of supported GRO types */ #define RTE_GRO_TYPE_MAX_NUM 64 -/**< current supported GRO num */ +/**< the max number of supported GRO types */ #define RTE_GRO_TYPE_SUPPORT_NUM 1 +/**< the number of currently supported GRO types */ -/**< TCP/IPv4 GRO flag */ #define RTE_GRO_TCP_IPV4_INDEX 0 #define RTE_GRO_TCP_IPV4 (1ULL << RTE_GRO_TCP_IPV4_INDEX) +/**< TCP/IPv4 GRO flag */ +/** + * A structure which is used to create GRO context objects or tell + * rte_gro_reassemble_burst() what reassembly rules are demanded. + */ struct rte_gro_param { - /**< desired GRO types */ uint64_t gro_types; - /**< max flow number */ + /**< desired GRO types */ uint16_t max_flow_num; - /**< max packet number per flow */ + /**< max flow number */ uint16_t max_item_per_flow; + /**< max packet number per flow */ + uint16_t socket_id; /**< socket index for allocating GRO related data structures, * like reassembly tables. When use rte_gro_reassemble_burst(), * applications don't need to set this value. */ - uint16_t socket_id; }; /** @@ -105,7 +113,7 @@ void rte_gro_ctx_destroy(void *ctx); * * @param pkts * a pointer array which points to the packets to reassemble. Besides, - * it keeps packet addresses for GROed packets. + * it keeps mbuf addresses for the GROed packets. * @param nb_pkts * the number of packets to reassemble. * @param param