From patchwork Thu Nov 26 14:26:39 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Olivier Matz X-Patchwork-Id: 84587 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id BD29FA052A; Thu, 26 Nov 2020 15:26:53 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 9905CC970; Thu, 26 Nov 2020 15:26:52 +0100 (CET) Received: from proxy.6wind.com (host.76.145.23.62.rev.coltfrance.com [62.23.145.76]) by dpdk.org (Postfix) with ESMTP id A4488C93A for ; Thu, 26 Nov 2020 15:26:50 +0100 (CET) Received: from glumotte.dev.6wind.com. (unknown [10.16.0.195]) by proxy.6wind.com (Postfix) with ESMTP id 7D840497728 for ; Thu, 26 Nov 2020 15:26:49 +0100 (CET) From: Olivier Matz To: dev@dpdk.org Date: Thu, 26 Nov 2020 15:26:39 +0100 Message-Id: <20201126142638.25349-1-olivier.matz@6wind.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH] doc: add missing network layers in API reference 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" Add missing files in doxy-api-index.md and add a short description for files that hadn't one. Signed-off-by: Olivier Matz --- doc/api/doxy-api-index.md | 7 ++++++- lib/librte_net/rte_ecpri.h | 9 +++++++++ lib/librte_net/rte_gre.h | 11 +++++++++++ lib/librte_net/rte_higig.h | 8 ++++++++ 4 files changed, 34 insertions(+), 1 deletion(-) diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md index bf6edb0276..a6e729de35 100644 --- a/doc/api/doxy-api-index.md +++ b/doc/api/doxy-api-index.md @@ -114,7 +114,12 @@ The public API headers are grouped by topics: [GRO] (@ref rte_gro.h), [GSO] (@ref rte_gso.h), [frag/reass] (@ref rte_ip_frag.h), - [VXLAN] (@ref rte_vxlan.h) + [VXLAN] (@ref rte_vxlan.h), + [eCPRI] (@ref rte_ecpri.h), + [Geneve] (@ref rte_geneve.h), + [GRE] (@ref rte_gre.h), + [ICMP] (@ref rte_icmp.h), + [MPLS] (@ref rte_mpls.h) - **QoS**: [metering] (@ref rte_meter.h), diff --git a/lib/librte_net/rte_ecpri.h b/lib/librte_net/rte_ecpri.h index 1cbd6d8133..3f3a90335b 100644 --- a/lib/librte_net/rte_ecpri.h +++ b/lib/librte_net/rte_ecpri.h @@ -5,6 +5,15 @@ #ifndef _RTE_ECPRI_H_ #define _RTE_ECPRI_H_ +/** + * @file + * + * eCPRI headers definition. + * + * eCPRI (Common Public Radio Interface) is used in internal interfaces of radio + * base station in a 5G infrastructure. + */ + #include #include diff --git a/lib/librte_net/rte_gre.h b/lib/librte_net/rte_gre.h index ac3ddaada3..79f0fa8ff2 100644 --- a/lib/librte_net/rte_gre.h +++ b/lib/librte_net/rte_gre.h @@ -8,6 +8,17 @@ #include #include +/** + * @file + * + * GRE headers definition. + * + * Generic Routing Encapsulation (GRE) is a tunneling protocol that can + * encapsulate a wide variety of network layer protocols inside virtual + * point-to-point links or point-to-multipoint links over an Internet Protocol + * network. + */ + #ifdef __cplusplus extern "C" { #endif diff --git a/lib/librte_net/rte_higig.h b/lib/librte_net/rte_higig.h index b9cdfefed7..cc51ec021a 100644 --- a/lib/librte_net/rte_higig.h +++ b/lib/librte_net/rte_higig.h @@ -6,6 +6,14 @@ #ifndef _RTE_HIGIG_H_ #define _RTE_HIGIG_H_ +/** + * @file + * + * HIGIG2 headers definition. + * + * It is a layer 2.5 protocol and used in Broadcom switches. + */ + #include #include