From patchwork Wed Jul 12 01:45:45 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 107437 Delivered-To: patch@linaro.org Received: by 10.140.101.44 with SMTP id t41csp209273qge; Tue, 11 Jul 2017 18:48:16 -0700 (PDT) X-Received: by 10.55.75.210 with SMTP id y201mr3789482qka.80.1499824096454; Tue, 11 Jul 2017 18:48:16 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1499824096; cv=none; d=google.com; s=arc-20160816; b=r7OAzEjM0rNSvPbP77/2H2XQdFZhykkoL3h1GooHfJHVQgO3q4/ORghmFVHoVHCWPu 8YcLz0C6mqZuZ5yJeOeCrcqgs14FfXP1b+XOzuOpouKOx/zh9bcHfPKxXkj0mqydE5Eq zSDET93urFOGFuxaCWTjPCkbuYKs86jVMCNAuhyLiV/rHZWxDNY86BpW7RB7hDezAyh2 IHV0bQgBPVGDJFTvCfPcB9NoNf3Dd4/YCgXmRdyhBxLIUOTj4h5Cu9DXKovLm89gkb9v zfWIPUDaXlBkDSCBxSPNNO9xeUOuMjVbUbSJdixWEwU3AUligAn9OIcIdhl0lo2420H1 j4UQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject:references:in-reply-to :message-id:date:to:from:delivered-to:arc-authentication-results; bh=daV6glWQM4zQpT+kaHqu3SqRhc5OSSh1YLYhrHKr5Zk=; b=u8v4Wn+pHjauwR4hKfXeGvtA6zRXZmakGhK1gEtwB/TyxZxMNTCMK4yEHP8vmoeSg1 3RzTMpcKZIevEFKun5B/w6BAhhYBiEvtS15gg7ghxOWSX/9d4UqzXLyJagzmUMLNrIPQ c4piKxShO7opjUXvco3vBjzomJrZhEBSwIWjKLe1v+V3ZM1ZlVJp5c/gg81qKRzx5Ogn IBgR4qAHQ2afzllUVTTu43jeRa0JyTbDp7BlzUkQGqyTu9kL49UMXDmSUb0pdGm1LYcf oGxX9sx/pWXsLX7z6o01UsRrND0P/9Rz/wTSVZldn2u7tYNSVrlCt2zPI+/SD/KdBUis 966g== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id y28si965041qtc.18.2017.07.11.18.48.16; Tue, 11 Jul 2017 18:48:16 -0700 (PDT) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 1EE4962D32; Wed, 12 Jul 2017 01:48:16 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 06C446449A; Wed, 12 Jul 2017 01:46:41 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id D9A4C6449A; Wed, 12 Jul 2017 01:46:37 +0000 (UTC) Received: from mail-oi0-f49.google.com (mail-oi0-f49.google.com [209.85.218.49]) by lists.linaro.org (Postfix) with ESMTPS id B071A62CE7 for ; Wed, 12 Jul 2017 01:45:52 +0000 (UTC) Received: by mail-oi0-f49.google.com with SMTP id p188so8154341oia.0 for ; Tue, 11 Jul 2017 18:45:52 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=daV6glWQM4zQpT+kaHqu3SqRhc5OSSh1YLYhrHKr5Zk=; b=RgV7eJrFNsE0NzMHT2R/ior3V+eoXacVU3AdpWNAMNnb3JC7giMl3pBvLx/qzYW+UG 9EaBmc1HK7IxVrAJq90GXw8Z6EcL1XtGaZLAqYGn0mRJqgtobnlhBY0ZMMnvkZwwkcfS CWzg2g0RxBuzKiAJtaWPeK/Q9mhuFOcPsR01HJFAFyiD5nxd1EAv4oS8RuQSVDUsn4VY VLXM3KmO6/beJNF2fxN/WLhonxZvGxCuviKMEtR1U1dJRE/0LbQfTwgwynnX6BPg53vJ VWwBIehCaj50GYqmkmTJwCUmCiB25oAgmpDWHH32gSj+kknRbMr7Zw2PNXgeuJRV8KOJ CI5Q== X-Gm-Message-State: AIVw110Aen5WyuxZBFBa1u8TEzDys86DDb3EGyaOhytTanMoHuZBhBe4 2OVYpUp/cpA7H3jWGIiZWm64 X-Received: by 10.202.180.84 with SMTP id d81mr2020916oif.112.1499823951922; Tue, 11 Jul 2017 18:45:51 -0700 (PDT) Received: from localhost.localdomain (cpe-70-121-83-241.austin.res.rr.com. [70.121.83.241]) by smtp.gmail.com with ESMTPSA id s129sm910041oif.41.2017.07.11.18.45.50 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 11 Jul 2017 18:45:50 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Tue, 11 Jul 2017 20:45:45 -0500 Message-Id: <20170712014545.13325-5-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20170712014545.13325-1-bill.fischofer@linaro.org> References: <20170712014545.13325-1-bill.fischofer@linaro.org> Subject: [lng-odp] [MONARCH_LTS PATCH 5/5] helper: add additional doxygen documentation X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" Resolve Bug https://bugs.linaro.org/show_bug.cgi?id=2952 by adding additional field documentation to avoid problems with doxygen 1.8.13 and higher. Signed-off-by: Bill Fischofer --- helper/include/odp/helper/icmp.h | 11 ++++++---- helper/include/odp/helper/linux.h | 7 +++++-- helper/include/odp/helper/strong_types.h | 3 ++- helper/include/odp/helper/table.h | 2 +- helper/include/odp/helper/tcp.h | 35 ++++++++++++++++---------------- 5 files changed, 33 insertions(+), 25 deletions(-) -- 2.11.0 diff --git a/helper/include/odp/helper/icmp.h b/helper/include/odp/helper/icmp.h index e25646ad..bef96784 100644 --- a/helper/include/odp/helper/icmp.h +++ b/helper/include/odp/helper/icmp.h @@ -32,15 +32,18 @@ typedef struct ODP_PACKED { uint8_t type; /**< message type */ uint8_t code; /**< type sub-code */ odp_u16sum_t chksum; /**< checksum of icmp header */ + /** Variant mappings of ICMP fields */ union { + /** Fields used for ICMP echo msgs */ struct { - odp_u16be_t id; - odp_u16be_t sequence; + odp_u16be_t id; /**< id */ + odp_u16be_t sequence; /**< sequence */ } echo; /**< echo datagram */ odp_u32be_t gateway; /**< gateway address */ + /** Fields used for ICMP frag msgs */ struct { - odp_u16be_t __unused; - odp_u16be_t mtu; + odp_u16be_t __unused; /**< @internal */ + odp_u16be_t mtu; /**< mtu */ } frag; /**< path mtu discovery */ } un; /**< icmp sub header */ } odph_icmphdr_t; diff --git a/helper/include/odp/helper/linux.h b/helper/include/odp/helper/linux.h index 238bcf8c..aa0e8f5e 100644 --- a/helper/include/odp/helper/linux.h +++ b/helper/include/odp/helper/linux.h @@ -82,12 +82,15 @@ typedef struct { odph_odpthread_start_args_t start_args; /**< start arguments */ int cpu; /**< CPU ID */ int last; /**< true if last table entry */ + /** Variant mappings for thread/process */ union { - struct { /* for thread implementation */ + /** for thread implementation */ + struct { pthread_t thread_id; /**< Pthread ID */ pthread_attr_t attr; /**< Pthread attributes */ } thread; - struct { /* for process implementation */ + /** for process implementation */ + struct { pid_t pid; /**< Process ID */ int status; /**< Process state chge status*/ } proc; diff --git a/helper/include/odp/helper/strong_types.h b/helper/include/odp/helper/strong_types.h index 13e35a43..501d0f28 100644 --- a/helper/include/odp/helper/strong_types.h +++ b/helper/include/odp/helper/strong_types.h @@ -20,10 +20,11 @@ /** Use strong typing for ODP types */ #ifdef __cplusplus +/** @internal C++ helper macro for strong typing @param type @return */ #define ODPH_HANDLE_T(type) struct _##type { uint8_t unused_dummy_var; } *type #else #define odph_handle_t struct { uint8_t unused_dummy_var; } * -/** C/C++ helper macro for strong typing */ +/** @internal C helper macro for strong typing @param type @return */ #define ODPH_HANDLE_T(type) odph_handle_t type #endif diff --git a/helper/include/odp/helper/table.h b/helper/include/odp/helper/table.h index 81022e55..be492381 100644 --- a/helper/include/odp/helper/table.h +++ b/helper/include/odp/helper/table.h @@ -89,7 +89,7 @@ extern "C" { #define ODPH_TABLE_NAME_LEN 32 #include -/** ODP table handle */ +/** @internal ODPH table handle @return */ typedef ODPH_HANDLE_T(odph_table_t); /** diff --git a/helper/include/odp/helper/tcp.h b/helper/include/odp/helper/tcp.h index cabef907..1c94af48 100644 --- a/helper/include/odp/helper/tcp.h +++ b/helper/include/odp/helper/tcp.h @@ -32,8 +32,9 @@ typedef struct ODP_PACKED { odp_u16be_t dst_port; /**< Destination port */ odp_u32be_t seq_no; /**< Sequence number */ odp_u32be_t ack_no; /**< Acknowledgment number */ + /** Variant mappings for TCP fields */ union { - odp_u16be_t doffset_flags; + odp_u16be_t doffset_flags; /**< dscp and offset mapping */ #if defined(ODP_BIG_ENDIAN_BITFIELD) struct { odp_u16be_t rsvd1:8; @@ -42,14 +43,14 @@ typedef struct ODP_PACKED { struct { odp_u16be_t hl:4; /**< Hdr len, in words */ odp_u16be_t rsvd3:4; /**< Reserved */ - odp_u16be_t cwr:1; - odp_u16be_t ece:1; - odp_u16be_t urg:1; - odp_u16be_t ack:1; - odp_u16be_t psh:1; - odp_u16be_t rst:1; - odp_u16be_t syn:1; - odp_u16be_t fin:1; + odp_u16be_t cwr:1; /**< cwr bit */ + odp_u16be_t ece:1; /**< ece bit */ + odp_u16be_t urg:1; /**< urg bit */ + odp_u16be_t ack:1; /**< ack bit */ + odp_u16be_t psh:1; /**< psh bit */ + odp_u16be_t rst:1; /**< rst bit */ + odp_u16be_t syn:1; /**< syn bit */ + odp_u16be_t fin:1; /**< fin bit */ }; #elif defined(ODP_LITTLE_ENDIAN_BITFIELD) struct { @@ -59,14 +60,14 @@ typedef struct ODP_PACKED { struct { odp_u16be_t rsvd3:4; /**< Reserved */ odp_u16be_t hl:4; /**< Hdr len, in words */ - odp_u16be_t fin:1; - odp_u16be_t syn:1; - odp_u16be_t rst:1; - odp_u16be_t psh:1; - odp_u16be_t ack:1; - odp_u16be_t urg:1; - odp_u16be_t ece:1; - odp_u16be_t cwr:1; + odp_u16be_t fin:1; /**< fin bit */ + odp_u16be_t syn:1; /**< syn bit */ + odp_u16be_t rst:1; /**< rst bit */ + odp_u16be_t psh:1; /**< psh bit */ + odp_u16be_t ack:1; /**< ack bit */ + odp_u16be_t urg:1; /**< urg bit */ + odp_u16be_t ece:1; /**< ece bit */ + odp_u16be_t cwr:1; /**< cwr bit */ }; #else