From patchwork Wed Apr 19 22:12:37 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97685 Delivered-To: patch@linaro.org Received: by 10.140.109.52 with SMTP id k49csp524681qgf; Wed, 19 Apr 2017 15:12:52 -0700 (PDT) X-Received: by 10.55.23.132 with SMTP id 4mr1268148qkx.85.1492639972573; Wed, 19 Apr 2017 15:12:52 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id 103si2528293qku.83.2017.04.19.15.12.52; Wed, 19 Apr 2017 15:12:52 -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 EB4F862D2D; Wed, 19 Apr 2017 22:12:51 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id D061A62DF0; Wed, 19 Apr 2017 22:12:49 +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 927B062E15; Wed, 19 Apr 2017 22:12:49 +0000 (UTC) Received: from mail-yw0-f172.google.com (mail-yw0-f172.google.com [209.85.161.172]) by lists.linaro.org (Postfix) with ESMTPS id 7DACC62CE5 for ; Wed, 19 Apr 2017 22:12:47 +0000 (UTC) Received: by mail-yw0-f172.google.com with SMTP id k13so26339506ywk.1 for ; Wed, 19 Apr 2017 15:12:47 -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; bh=293TYPvRVZt0SIlyu/Uds0L3BoUPbN2uxvIsLYX/hBA=; b=UfwHIWCsX5rV8EAUGJXIZMpehXsPdqQwRbQ3FGJYttixFUhU60bA+5yUtNf95LFtj1 uq4OFRgeHIRjNdMmEstgjM4QpWfm2aXRtHZh4fLlAoS5tfKpIhPWL4qbSAIjd+nFYF3l N27PWx/wijuemNZsaXj1O6mU/RQLwiVINbA2/KlTH+V69duaPSc78Ck/7Pqv/NSkkx36 hQV+r2CeK8DTa5lxNUhsMDkcCujoqIHlB3fAfy6IhJJlM+dRP7zwJwWDdeUrNipBw9Sg hbjm0eYyqcHd+fgPWm97Q3Q52o2ZUK5Bbl0h7YoUQh1OYz/+wf61q+pSrikF+J+8TJH1 OdGw== X-Gm-Message-State: AN3rC/5kIy1HY2gm0O/fBK7tMfg4S+RhBauHZ+CgcIscZfAhG+y52q5e 0qVR9emFXNUHww2Qf1s= X-Received: by 10.157.5.106 with SMTP id 97mr2710905otw.227.1492639966998; Wed, 19 Apr 2017 15:12:46 -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 d23sm1708625oic.26.2017.04.19.15.12.46 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 19 Apr 2017 15:12:46 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Wed, 19 Apr 2017 17:12:37 -0500 Message-Id: <1492639961-2339-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 Subject: [lng-odp] [PATCH 1/5] api: classification: 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 --- include/odp/api/spec/classification.h | 4 ++++ 1 file changed, 4 insertions(+) -- 2.11.0 diff --git a/include/odp/api/spec/classification.h b/include/odp/api/spec/classification.h index 0e1addd6..39831b24 100644 --- a/include/odp/api/spec/classification.h +++ b/include/odp/api/spec/classification.h @@ -366,7 +366,9 @@ typedef struct odp_pmr_param_t { /** True if the value is range and false if match */ odp_bool_t range_term; + /** Variant mappings for types of matches */ union { + /** Parameters for single-valued matches */ struct { /** Value to be matched */ const void *value; @@ -374,6 +376,8 @@ typedef struct odp_pmr_param_t { /** Masked set of bits to be matched */ const void *mask; } match; + + /** Parameter for range value matches */ struct { /** Start and End values are included in the range */ /** start value of range */ From patchwork Wed Apr 19 22:12:38 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97686 Delivered-To: patch@linaro.org Received: by 10.140.109.52 with SMTP id k49csp524692qgf; Wed, 19 Apr 2017 15:12:54 -0700 (PDT) X-Received: by 10.55.27.18 with SMTP id b18mr4122909qkb.142.1492639974890; Wed, 19 Apr 2017 15:12:54 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id r22si3810341qtb.76.2017.04.19.15.12.54; Wed, 19 Apr 2017 15:12:54 -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 97A5562E2D; Wed, 19 Apr 2017 22:12:54 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 197B462E3F; Wed, 19 Apr 2017 22:12:52 +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 BFB3462E31; Wed, 19 Apr 2017 22:12:50 +0000 (UTC) Received: from mail-yw0-f178.google.com (mail-yw0-f178.google.com [209.85.161.178]) by lists.linaro.org (Postfix) with ESMTPS id A5FF462D27 for ; Wed, 19 Apr 2017 22:12:48 +0000 (UTC) Received: by mail-yw0-f178.google.com with SMTP id 203so24020367ywe.0 for ; Wed, 19 Apr 2017 15:12:48 -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=o4FKVNZt44tK1qBugj9HSNMaFYyTIrla+DDnxhJQEgs=; b=ZwU2dstmYOIctA2HoN0zmXkm510NAB+3LPi1D7uoSxgcSvuw+bjOZxLkP2nxfpJl46 b6NhpKQpNuw68EV93lGCU6cunxyieqdhHnQi8lADPMSBS2jBp0Bh5x9prmDwtGPDBr7f m8WOvfBFpBQ+tqYzPvDUn4PSRyLzkCjJAZ/GjXFfxNTjdZHX2TLkxW6+pDQ+E1oiI5pd FaMPl6YE/tnhSXgpLqBChY03WbKzIXEgxRoeQ5adbFDn14uo0mL6QGsIzC4JZM1gkIcG Xhwm/qiZ3gVAiCmplbU+K9AI9bNdgf09U6Gu4UkRrMdCfGNtVIuhDTCkGPx4XGN0ABdR LT8Q== X-Gm-Message-State: AN3rC/53R13gsEM0a3tHkJS11l6u3V0WrK8VCCVKXAf11jzKw6/IL22l lOmJdpBEdurcdkeRKpzODzYy X-Received: by 10.157.48.50 with SMTP id d47mr554444otc.161.1492639967748; Wed, 19 Apr 2017 15:12:47 -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 d23sm1708625oic.26.2017.04.19.15.12.47 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 19 Apr 2017 15:12:47 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Wed, 19 Apr 2017 17:12:38 -0500 Message-Id: <1492639961-2339-2-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1492639961-2339-1-git-send-email-bill.fischofer@linaro.org> References: <1492639961-2339-1-git-send-email-bill.fischofer@linaro.org> Subject: [lng-odp] [PATCH 2/5] api: pool: 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 --- include/odp/api/spec/pool.h | 6 ++++++ 1 file changed, 6 insertions(+) -- 2.11.0 diff --git a/include/odp/api/spec/pool.h b/include/odp/api/spec/pool.h index c0de195a..6fc5b6b4 100644 --- a/include/odp/api/spec/pool.h +++ b/include/odp/api/spec/pool.h @@ -166,7 +166,9 @@ typedef struct odp_pool_param_t { /** Pool type */ int type; + /** Variant parameters for different pool types */ union { + /** Parameters for buffer pools */ struct { /** Number of buffers in the pool */ uint32_t num; @@ -180,6 +182,8 @@ typedef struct odp_pool_param_t { Default will always be a multiple of 8. */ uint32_t align; } buf; + + /** Parameters for packet pools */ struct { /** The number of packets that the pool must provide that are packet length 'len' bytes or smaller. @@ -211,6 +215,8 @@ typedef struct odp_pool_param_t { Specify as 0 if no user area is needed. */ uint32_t uarea_size; } pkt; + + /** Parameters for timeout pools */ struct { /** Number of timeouts in the pool */ uint32_t num; From patchwork Wed Apr 19 22:12:39 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97687 Delivered-To: patch@linaro.org Received: by 10.140.109.52 with SMTP id k49csp524697qgf; Wed, 19 Apr 2017 15:12:56 -0700 (PDT) X-Received: by 10.200.36.2 with SMTP id c2mr4872782qtc.271.1492639976432; Wed, 19 Apr 2017 15:12:56 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id q19si3804156qta.165.2017.04.19.15.12.56; Wed, 19 Apr 2017 15:12:56 -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 0CF4E62E49; Wed, 19 Apr 2017 22:12:55 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 45C5462E65; Wed, 19 Apr 2017 22:12:53 +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 2D04362E31; Wed, 19 Apr 2017 22:12:51 +0000 (UTC) Received: from mail-yw0-f169.google.com (mail-yw0-f169.google.com [209.85.161.169]) by lists.linaro.org (Postfix) with ESMTPS id F07B962D2D for ; Wed, 19 Apr 2017 22:12:48 +0000 (UTC) Received: by mail-yw0-f169.google.com with SMTP id 203so24020521ywe.0 for ; Wed, 19 Apr 2017 15:12:48 -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=YqtVwxlg1mJl6DukupnlccHE5eP0YV9plvwj9+Y4FEg=; b=CnTChEsGK3wjnbBqdeYQptPAGNz+DWDyzimo1p5petcwutpvCLaWMZuJ+qm2BjlQZO WlzGclbWmPoyng50UxZG1es67DuB5S1+GFo9PQDzOpyjHw4Kg7n1bEagCzm8JQFBnYmH sXxqdTLZ3xHp0LKdMnAf9eBWsQlZJ4kIW/vD0VfRo6sEL+n9rTtpqRJVtrQP+sT5Pxlo RH25Ud3K7Szt+XLbTSXS6LXORRiNdHpqn/MzU0aQ7mHm7rD00+2oM+8s5kUIpM2kPlgA 3CQHNfJWPZEqNYaAKiHYBwu2IFl2WzCPhkXcHvsMDN8aY8363J6ChWDGaBQF28NKY1YM n+HQ== X-Gm-Message-State: AN3rC/5k/R+z8XRhd3se1UOmF/zacOTkwfwicxxP1+9KVEcGSZlF+/GX 37u8OvlFSxy7oKXoGlwYTE0+ X-Received: by 10.157.25.23 with SMTP id j23mr2709778ota.9.1492639968419; Wed, 19 Apr 2017 15:12:48 -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 d23sm1708625oic.26.2017.04.19.15.12.47 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 19 Apr 2017 15:12:47 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Wed, 19 Apr 2017 17:12:39 -0500 Message-Id: <1492639961-2339-3-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1492639961-2339-1-git-send-email-bill.fischofer@linaro.org> References: <1492639961-2339-1-git-send-email-bill.fischofer@linaro.org> Subject: [lng-odp] [PATCH 3/5] api: tm: 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 --- include/odp/api/spec/traffic_mngr.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) -- 2.11.0 diff --git a/include/odp/api/spec/traffic_mngr.h b/include/odp/api/spec/traffic_mngr.h index 71198bbd..3a748cef 100644 --- a/include/odp/api/spec/traffic_mngr.h +++ b/include/odp/api/spec/traffic_mngr.h @@ -471,9 +471,10 @@ typedef enum { typedef struct { odp_tm_egress_kind_t egress_kind; /**< Union discriminator */ + /** Variant parameters for different TM outputs */ union { - odp_pktio_t pktio; - odp_tm_egress_fcn_t egress_fcn; + odp_pktio_t pktio; /**< Output to PktIO */ + odp_tm_egress_fcn_t egress_fcn; /**< Output to user func */ }; } odp_tm_egress_t; From patchwork Wed Apr 19 22:12:40 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97688 Delivered-To: patch@linaro.org Received: by 10.140.109.52 with SMTP id k49csp524709qgf; Wed, 19 Apr 2017 15:13:00 -0700 (PDT) X-Received: by 10.55.7.135 with SMTP id 129mr4575604qkh.82.1492639980021; Wed, 19 Apr 2017 15:13:00 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id l184si3785812qke.248.2017.04.19.15.12.59; Wed, 19 Apr 2017 15:13:00 -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 A447D62E21; Wed, 19 Apr 2017 22:12:59 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 6923162E21; Wed, 19 Apr 2017 22:12:57 +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 9BDC862E4E; Wed, 19 Apr 2017 22:12:52 +0000 (UTC) Received: from mail-yw0-f169.google.com (mail-yw0-f169.google.com [209.85.161.169]) by lists.linaro.org (Postfix) with ESMTPS id 4C05A62E2D for ; Wed, 19 Apr 2017 22:12:50 +0000 (UTC) Received: by mail-yw0-f169.google.com with SMTP id k13so26340910ywk.1 for ; Wed, 19 Apr 2017 15:12:50 -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=mvdQ7AHCG5pF4Blx/PNTX7gd9KkoaDK06bBDWLQAph4=; b=oH8eb2bY8eF5yYMttSCpcsIsQ0CiqUUU0eJ32TKTWybvk8UnR9TAzHjd+fBvl/9mmv fOh7s6nt+6WNBN9gVDT8GK0BA/5VcCJ2FIaFQ7Irqr4GSeLP3ZSQtvINK2BfA8nW8vlC utIuSFAfhKYHscaEnKWgcnCPMyNuFneTWnPvruRz5/V7tVRcnmMLQJOqZOjrRqtBlCCX FEdU/fZ1CmSCNS4qGK5xoHePom1PGjI3M+fiEHCw2UIuk+VmiCelyBRVMK32zzF16qf6 vY/FcpVwPGcc70uZeNttld51qTzBhdKEFodjHP+SgaczjjsaiD9rguedvXtecEaKo+nQ CHGg== X-Gm-Message-State: AN3rC/4qLP2T5HW6SVRiDafwGu3p1ZQdyfs3vNQP7aNGOLOIj05ZRS1/ 4/hC9bKyjWKZc/Vq1UnrYFIL X-Received: by 10.157.8.213 with SMTP id 79mr2891098otf.152.1492639969475; Wed, 19 Apr 2017 15:12:49 -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 d23sm1708625oic.26.2017.04.19.15.12.48 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 19 Apr 2017 15:12:48 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Wed, 19 Apr 2017 17:12:40 -0500 Message-Id: <1492639961-2339-4-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1492639961-2339-1-git-send-email-bill.fischofer@linaro.org> References: <1492639961-2339-1-git-send-email-bill.fischofer@linaro.org> Subject: [lng-odp] [PATCH 4/5] linux-generic: types: 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 --- platform/linux-generic/include/odp/api/debug.h | 8 ++++++++ platform/linux-generic/include/odp/api/plat/packet_types.h | 1 + platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h | 2 +- 3 files changed, 10 insertions(+), 1 deletion(-) -- 2.11.0 diff --git a/platform/linux-generic/include/odp/api/debug.h b/platform/linux-generic/include/odp/api/debug.h index b0f91b1c..bef2fd0e 100644 --- a/platform/linux-generic/include/odp/api/debug.h +++ b/platform/linux-generic/include/odp/api/debug.h @@ -25,17 +25,23 @@ extern "C" { * versions. */ #define _odp_merge(a, b) a##b +/** @internal */ #define _odp_label(a) _odp_merge(_ODP_SASSERT_, a) +/** @internal */ #define _ODP_SASSERT _odp_label(__COUNTER__) +/** @internal */ #define _ODP_SASSERT_ENUM(e) { _ODP_SASSERT = 1 / !!(e) } +/** @internal */ #define _odp_static_assert(e, s) enum _ODP_SASSERT_ENUM(e) #if defined(__clang__) #if defined(__cplusplus) #if !__has_feature(cxx_static_assert) && !defined(static_assert) +/** @internal */ #define static_assert(e, s) _odp_static_assert(e, s) #endif #elif !__has_feature(c_static_assert) && !defined(_Static_assert) +/** @internal */ #define _Static_assert(e, s) _odp_static_assert(e, s) #endif @@ -44,9 +50,11 @@ extern "C" { (__GNUC__ < 6 && defined(__cplusplus)) #if defined(__cplusplus) #if !defined(static_assert) +/** @intenral */ #define static_assert(e, s) _odp_static_assert(e, s) #endif #elif !defined(_Static_assert) +/** @internal */ #define _Static_assert(e, s) _odp_static_assert(e, s) #endif #endif diff --git a/platform/linux-generic/include/odp/api/plat/packet_types.h b/platform/linux-generic/include/odp/api/plat/packet_types.h index 7e3c51e6..95cba5eb 100644 --- a/platform/linux-generic/include/odp/api/plat/packet_types.h +++ b/platform/linux-generic/include/odp/api/plat/packet_types.h @@ -105,6 +105,7 @@ typedef union { /** All input flags */ uint64_t all; + /** Individual input flags */ struct { uint64_t parsed_l2:1; /**< L2 parsed */ uint64_t dst_queue:1; /**< Dst queue present */ diff --git a/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h b/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h index b766afec..f47a13f6 100644 --- a/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h +++ b/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h @@ -168,7 +168,7 @@ typedef odp_tm_handle_t odp_tm_wred_t; */ #define ODP_TM_ROOT ((odp_tm_handle_t)-1) -/** Get printable format of odp_queue_t */ +/** @internal Get printable format of odp_tm_handle_t @param hdl @return */ static inline uint64_t odp_tm_handle_to_u64(odp_tm_handle_t hdl) { return hdl; From patchwork Wed Apr 19 22:12:41 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97689 Delivered-To: patch@linaro.org Received: by 10.140.109.52 with SMTP id k49csp524716qgf; Wed, 19 Apr 2017 15:13:01 -0700 (PDT) X-Received: by 10.55.82.68 with SMTP id g65mr4725450qkb.116.1492639981372; Wed, 19 Apr 2017 15:13:01 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id i17si3786943qkh.295.2017.04.19.15.13.01; Wed, 19 Apr 2017 15:13:01 -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 1AE6F62E48; Wed, 19 Apr 2017 22:13:00 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 28AF562E31; Wed, 19 Apr 2017 22:12:58 +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 B6CED62E52; Wed, 19 Apr 2017 22:12:53 +0000 (UTC) Received: from mail-yw0-f181.google.com (mail-yw0-f181.google.com [209.85.161.181]) by lists.linaro.org (Postfix) with ESMTPS id 0EA5462D27 for ; Wed, 19 Apr 2017 22:12:51 +0000 (UTC) Received: by mail-yw0-f181.google.com with SMTP id j9so26402336ywj.3 for ; Wed, 19 Apr 2017 15:12:51 -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=1HUawVPRrWhr9u0JNsSsZYfzflmecKBxqb8itYMKkb8=; b=qh1LZXPwP/e0UTXzL2/8zSnNetD+5jcFY5Jp6VxnSH2IDwLMqAnUII6r49wRE3aZaQ FRwnrBbsNSEmD76b+S6ibAtY9k6HvrQkOcAMkanrQiXiwv6Y0hlLBr1gklc04i/56izs HB5u2IF1qpqoWd0oqD7HhNnFCfoCnfRaiGGAna9KUH0b/ltdhhrugMy5zWSiPeEnrskG VBV63pRKgD6LM3apNSw1D/1ygYBF/BMtQ3erywf7htOzRozJJXyF8lMQ/POhZzR8JbE3 qe/w84GQMRXEB1MpMc/PNbczw2OnUdOajAFXd7SinGBZawOPwVF2qJvx+PK4Fk2TRnqk L/Cw== X-Gm-Message-State: AN3rC/6+TWSNR64YrzuRtrzOBpv98/qkjHWOvJP4gyC/oqRA4Oj3lRM/ UXO93pAWBd+MlETlJeRVp/Pt X-Received: by 10.157.37.119 with SMTP id j52mr2437804otd.14.1492639970279; Wed, 19 Apr 2017 15:12:50 -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 d23sm1708625oic.26.2017.04.19.15.12.49 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 19 Apr 2017 15:12:49 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Wed, 19 Apr 2017 17:12:41 -0500 Message-Id: <1492639961-2339-5-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1492639961-2339-1-git-send-email-bill.fischofer@linaro.org> References: <1492639961-2339-1-git-send-email-bill.fischofer@linaro.org> Subject: [lng-odp] [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/strong_types.h | 3 ++- helper/include/odp/helper/table.h | 2 +- helper/include/odp/helper/tcp.h | 35 ++++++++++++++++---------------- helper/include/odp/helper/threads.h | 7 +++++-- 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/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 b3440ef5..96c9c5fe 100644 --- a/helper/include/odp/helper/table.h +++ b/helper/include/odp/helper/table.h @@ -94,7 +94,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 fd234e58..e91b52e2 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 maps for TCP header fields */ union { - odp_u16be_t doffset_flags; + odp_u16be_t doffset_flags; /**< TCP Flags aggregate */ #if 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 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 diff --git a/helper/include/odp/helper/threads.h b/helper/include/odp/helper/threads.h index 5682bab9..526f0d48 100644 --- a/helper/include/odp/helper/threads.h +++ b/helper/include/odp/helper/threads.h @@ -80,12 +80,15 @@ typedef struct { odph_odpthread_start_args_t start_args; /**< start arguments */ int cpu; /**< CPU ID */ int last; /**< true if last table entry */ + /** Variant field mappings for thread/process modes */ 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;