From patchwork Fri Apr 21 14:25:20 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97909 Delivered-To: patch@linaro.org Received: by 10.182.246.10 with SMTP id xs10csp335426obc; Fri, 21 Apr 2017 07:25:38 -0700 (PDT) X-Received: by 10.55.149.130 with SMTP id x124mr12149638qkd.99.1492784738702; Fri, 21 Apr 2017 07:25:38 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id d201si9670060qka.36.2017.04.21.07.25.38; Fri, 21 Apr 2017 07:25:38 -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 3CF4E609E3; Fri, 21 Apr 2017 14:25:38 +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.4 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, RCVD_IN_SORBS_SPAM, 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 6A348608C6; Fri, 21 Apr 2017 14:25:33 +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 678EB6068A; Fri, 21 Apr 2017 14:25:30 +0000 (UTC) Received: from mail-oi0-f51.google.com (mail-oi0-f51.google.com [209.85.218.51]) by lists.linaro.org (Postfix) with ESMTPS id 8F9BD6068A for ; Fri, 21 Apr 2017 14:25:29 +0000 (UTC) Received: by mail-oi0-f51.google.com with SMTP id x184so97920074oia.1 for ; Fri, 21 Apr 2017 07:25:29 -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=MrTcdqbIiygysfeJa19Bmtket4hyNHY4FXVksooV2MbiHvUiETmpwKEh/t450UtCFX izt1S8vQTr4y6FaVpZvh/gzHriPXDaw4klO0emkgN99jDYgOqythVAbFt+VmUvSAXoE5 KyZ9YZ5WXixRuJfAG33dgtAqSBOVKFqcA/3tnxOoSFdrByjT5pgNOMIH5e9hInV2s1Fv D5W6HIBMbI7/xl/rSEkHaCpzFei3JotFRORB1V3rb3N8b+3EUEKgnWYA9MlEFQKxjhm5 84kVAsxbxmG5lpO/EirZIGwvV144K11uI5HeZQQ423d0r1GhdtzK/OVaAH7xcHSknJl1 iCBw== X-Gm-Message-State: AN3rC/6DJvkPNJAkFL2SXra56n8YjhPh79jTBs+ZveFOx8ffspbG8Xf4 CETkrafaQuAPsa8XsT0= X-Received: by 10.157.11.50 with SMTP id a47mr4681859ota.21.1492784728973; Fri, 21 Apr 2017 07:25:28 -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 z9sm4103192otd.44.2017.04.21.07.25.28 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 21 Apr 2017 07:25:28 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Fri, 21 Apr 2017 09:25:20 -0500 Message-Id: <1492784725-31626-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 Subject: [lng-odp] [API-NEXT PATCHv3 1/6] 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 Reviewed-by: Petri Savolainen 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 Fri Apr 21 14:25:21 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97910 Delivered-To: patch@linaro.org Received: by 10.182.246.10 with SMTP id xs10csp335623obc; Fri, 21 Apr 2017 07:26:10 -0700 (PDT) X-Received: by 10.55.23.132 with SMTP id 4mr9195171qkx.85.1492784770683; Fri, 21 Apr 2017 07:26:10 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id 94si1818697qkw.248.2017.04.21.07.26.10; Fri, 21 Apr 2017 07:26:10 -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 58F0F62280; Fri, 21 Apr 2017 14:26:10 +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=-4.2 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H2, RCVD_IN_SORBS_SPAM, 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 13ABF60985; Fri, 21 Apr 2017 14:25:35 +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 91F8B608C6; Fri, 21 Apr 2017 14:25:31 +0000 (UTC) Received: from mail-oi0-f43.google.com (mail-oi0-f43.google.com [209.85.218.43]) by lists.linaro.org (Postfix) with ESMTPS id 57CD6608AF for ; Fri, 21 Apr 2017 14:25:30 +0000 (UTC) Received: by mail-oi0-f43.google.com with SMTP id y11so65138436oie.0 for ; Fri, 21 Apr 2017 07:25:30 -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=2LSYLzhs53BpXiwesbHaFuzmEbom8ZGFydXjvlbP91E=; b=NjA6/JyT39N/P5ri3fqaIqOzAJbmtQfHijETdL0fImnYbsifka0Dhjb7Hi0uNnSMfq dIB3xYy7r5Fy+OQ7UZzMfZ0iK/V5Xn4K1VJ/qMZUXxX3iBk9yqMcGGJLRuNHfg22CKmu sXG/lN33qnoLKPmtX+9xQBiH+W5WewOFqeabgnBXtgZA9koc6W4AQhH0S6KAJDWVTvFH 9UvityBWcjnEf0USqX5QZkJNvSCDn7XVGE+5BV/NSK3eHOGZrpiFL2V6V9FCzSu+8vDE SYh4V5YxuQEHVneZnT8TjayknhChvA60FhVpzCLMc0HdDeLFj/paJ+np80m9F6hraKUq xPhg== X-Gm-Message-State: AN3rC/53x9yIUIALcl3tgPYCn149c1yYgXROfLkWzQxv7risfQf4gjg4 mwPNyfQaBex63rNvCUk= X-Received: by 10.157.18.193 with SMTP id g59mr7592121otg.261.1492784729822; Fri, 21 Apr 2017 07:25:29 -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 z9sm4103192otd.44.2017.04.21.07.25.29 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 21 Apr 2017 07:25:29 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Fri, 21 Apr 2017 09:25:21 -0500 Message-Id: <1492784725-31626-2-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1492784725-31626-1-git-send-email-bill.fischofer@linaro.org> References: <1492784725-31626-1-git-send-email-bill.fischofer@linaro.org> Subject: [lng-odp] [API-NEXT PATCHv3 2/6] api: ipsec: 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/ipsec.h | 5 +++++ 1 file changed, 5 insertions(+) -- 2.11.0 diff --git a/include/odp/api/spec/ipsec.h b/include/odp/api/spec/ipsec.h index a0ceb11a..3521d2f8 100644 --- a/include/odp/api/spec/ipsec.h +++ b/include/odp/api/spec/ipsec.h @@ -157,6 +157,7 @@ typedef struct odp_ipsec_inbound_config_t { /** Flags to control IPSEC payload data checks up to the selected parse * level. */ union { + /** Mapping for individual bits */ struct { /** Check IPv4 header checksum in IPSEC payload. * Default value is 0. */ @@ -195,6 +196,7 @@ typedef struct odp_ipsec_outbound_config_t { * metadata flag to disable checksum insertion per packet bases. */ union { + /** Mapping for individual bits */ struct { /** Insert IPv4 header checksum on the payload packet * before IPSEC transformation. Default value is 0. */ @@ -393,6 +395,7 @@ typedef struct odp_ipsec_tunnel_param_t { /** Tunnel type: IPv4 or IPv6 */ odp_ipsec_tunnel_type_t type; + /** Variant mappings for tunnel parameters */ union { /** IPv4 header parameters */ struct { @@ -850,6 +853,7 @@ typedef struct odp_ipsec_op_opt_t { /** IPSEC operation status */ typedef struct odp_ipsec_op_status_t { + /** Variant mappings for op status */ union { /** Error flags */ struct { @@ -901,6 +905,7 @@ typedef struct odp_ipsec_op_status_t { uint32_t all_error; }; + /** Variant mappings for status flags */ union { /** Status flags */ struct { From patchwork Fri Apr 21 14:25:22 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97911 Delivered-To: patch@linaro.org Received: by 10.182.246.10 with SMTP id xs10csp335779obc; Fri, 21 Apr 2017 07:26:36 -0700 (PDT) X-Received: by 10.200.41.182 with SMTP id 51mr15306285qts.127.1492784796488; Fri, 21 Apr 2017 07:26:36 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id y19si9699961qta.24.2017.04.21.07.26.36; Fri, 21 Apr 2017 07:26:36 -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 2604562C71; Fri, 21 Apr 2017 14:26:36 +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.4 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, RCVD_IN_SORBS_SPAM, 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 D01EC608B3; Fri, 21 Apr 2017 14:25: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 0272E608C6; Fri, 21 Apr 2017 14:25:32 +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 76B4B6068A for ; Fri, 21 Apr 2017 14:25:31 +0000 (UTC) Received: by mail-oi0-f49.google.com with SMTP id s131so10844148oia.3 for ; Fri, 21 Apr 2017 07:25:31 -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=qpuGK2FVxNbLJHp4YjvO7pTnsvUv+5DFG12nnrkcJ4g9GOGcnBCzIr8Mn+bO6v6yMs poEKMwzB8HR0LBlVTJxQyst3HjZP6RbrDrNAsF6EPP2RQf2LFwXVGeEQtbQdMy/+upfm 7+r3ZYpakpSIDZGCG9NyJRr8GrKCDS56xS3qV51U7M9IHZrEbQ9SnQoCS4eduV2n6KYW ZYJyKuQ24WKcQOSeBi0x5XszGAPhqF54jTlvPH2wr8uK60C+jZoRxBp3ABi/SqXwXASv 4oB1etKcuGCEYAitBFMO8qi6cCIMa2NC2oBNuIbKeqjCseGfT7VdOBYSRUVyyPgDu8U0 8bbw== X-Gm-Message-State: AN3rC/6yaznnKOoz0NHc8J4h8DFzYv61wPM+80Y+lpgdJsqnFY5KxMBy IxipVz7Gh5gVPZ3wLN8Kj+JN X-Received: by 10.157.63.251 with SMTP id i56mr1426518ote.54.1492784730767; Fri, 21 Apr 2017 07:25:30 -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 z9sm4103192otd.44.2017.04.21.07.25.29 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 21 Apr 2017 07:25:30 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Fri, 21 Apr 2017 09:25:22 -0500 Message-Id: <1492784725-31626-3-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1492784725-31626-1-git-send-email-bill.fischofer@linaro.org> References: <1492784725-31626-1-git-send-email-bill.fischofer@linaro.org> Subject: [lng-odp] [API-NEXT PATCHv3 3/6] 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 Fri Apr 21 14:25:23 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97912 Delivered-To: patch@linaro.org Received: by 10.182.246.10 with SMTP id xs10csp336024obc; Fri, 21 Apr 2017 07:27:18 -0700 (PDT) X-Received: by 10.55.6.83 with SMTP id 80mr14209665qkg.156.1492784838611; Fri, 21 Apr 2017 07:27:18 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id t1si9654797qkl.333.2017.04.21.07.27.18; Fri, 21 Apr 2017 07:27:18 -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 4D34261CC7; Fri, 21 Apr 2017 14:27:18 +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.4 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, RCVD_IN_SORBS_SPAM, 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 3AEE160B25; Fri, 21 Apr 2017 14:25:47 +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 98E8F60964; Fri, 21 Apr 2017 14:25:33 +0000 (UTC) Received: from mail-oi0-f42.google.com (mail-oi0-f42.google.com [209.85.218.42]) by lists.linaro.org (Postfix) with ESMTPS id 49A60608AF for ; Fri, 21 Apr 2017 14:25:32 +0000 (UTC) Received: by mail-oi0-f42.google.com with SMTP id y11so65139708oie.0 for ; Fri, 21 Apr 2017 07:25:32 -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=bv5XtGa6+DWfxm2tCq87R/dC0mjnVRXJUaqbhciH5K12y+uTLXE8LR1dQ/DtKKk6M4 8QGoWLxGFzncY0nXhYY8sl6+PMGwpzFij23AWIbIq46DWKctQ/tYXORUa3zw3EDmXLsP w9tsBww/HsKMddIK6HCdiEhFhbLz3YSwoi+UOOQiVuATVcdzUdFvKcFjjBUAAGvmUZzN S3H3uMVpEBcWdWzAZqok80AfxU2wygKzJENPVCyhNpYzAue4P3rPJawoIQ4uS0Qp3kiD Uw606pHhAfadDQLlW5s8teumrzEXYHZjK2bIX/mDh35ebHvLIpKwtDHez8WNZwOtJ99t 4Mrg== X-Gm-Message-State: AN3rC/4Qxbl/iVxPsBqg3K1O7hESXaavfAKv4WVSlCbUcKS1+3sgkbxY JwHEuvyuLs0QVEXwwPw= X-Received: by 10.157.12.198 with SMTP id o6mr8391262otd.103.1492784731733; Fri, 21 Apr 2017 07:25:31 -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 z9sm4103192otd.44.2017.04.21.07.25.30 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 21 Apr 2017 07:25:30 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Fri, 21 Apr 2017 09:25:23 -0500 Message-Id: <1492784725-31626-4-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1492784725-31626-1-git-send-email-bill.fischofer@linaro.org> References: <1492784725-31626-1-git-send-email-bill.fischofer@linaro.org> Subject: [lng-odp] [API-NEXT PATCHv3 4/6] 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 Fri Apr 21 14:25:24 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97913 Delivered-To: patch@linaro.org Received: by 10.182.246.10 with SMTP id xs10csp336217obc; Fri, 21 Apr 2017 07:27:50 -0700 (PDT) X-Received: by 10.55.65.133 with SMTP id o127mr13086197qka.71.1492784870855; Fri, 21 Apr 2017 07:27:50 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id n23si9686838qkl.68.2017.04.21.07.27.50; Fri, 21 Apr 2017 07:27:50 -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 854AA60964; Fri, 21 Apr 2017 14:27:50 +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=-4.2 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H2, RCVD_IN_SORBS_SPAM, 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 7EB7B61CA5; Fri, 21 Apr 2017 14:25:50 +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 44B9D60A02; Fri, 21 Apr 2017 14:25:37 +0000 (UTC) Received: from mail-oi0-f48.google.com (mail-oi0-f48.google.com [209.85.218.48]) by lists.linaro.org (Postfix) with ESMTPS id 3B19B6068A for ; Fri, 21 Apr 2017 14:25:33 +0000 (UTC) Received: by mail-oi0-f48.google.com with SMTP id s131so10845286oia.3 for ; Fri, 21 Apr 2017 07:25:33 -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=Mlke+rVLUHQUHqAIpccnHiMhcy7NqhnejWjyHR5Kdl0=; b=eZjMHQUyFOPgjqnM+tTyqH/0aeug9sCQejflnJWJS4znUnmJoqM7qLVAkyP77XuV/A bGp8/SE47OZMSOmAjsB+dMXeotNPGEj8d4ak9DDXH8lH5vHCkEC3Kzgot6Hmp7NCHpPy Bah0fzWk0ReFl/lAbVeOjViryJYkQ7ULAY++8TeScGwW5B0Dyy+fSKB+VQ0vX5d6+jlp AwWOhUJh4+iAh0Hamcbr+it8fOScCFalKtCcjd2YRI3aMD71kz5u3B+04zPd4UKeQoCA rgq3ZaoYeRq8ZBo8ZiPmaiZGbSxaDE+WoAR1sCEYL37o1DwXxh3pL0zhkHN0mFJPHFec k2jw== X-Gm-Message-State: AN3rC/7xi7nFNr/UQt36VxLJZabXpUc7E8DxaG8+DVhD9OCVc2VoQkzd kpU3jySiEllE7E6MMms= X-Received: by 10.157.68.146 with SMTP id v18mr7996060ote.128.1492784732628; Fri, 21 Apr 2017 07:25:32 -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 z9sm4103192otd.44.2017.04.21.07.25.31 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 21 Apr 2017 07:25:32 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Fri, 21 Apr 2017 09:25:24 -0500 Message-Id: <1492784725-31626-5-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1492784725-31626-1-git-send-email-bill.fischofer@linaro.org> References: <1492784725-31626-1-git-send-email-bill.fischofer@linaro.org> Subject: [lng-odp] [API-NEXT PATCHv3 5/6] 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 7403afc1..a209c759 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 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 Fri Apr 21 14:25:25 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97914 Delivered-To: patch@linaro.org Received: by 10.182.246.10 with SMTP id xs10csp336550obc; Fri, 21 Apr 2017 07:28:46 -0700 (PDT) X-Received: by 10.55.48.68 with SMTP id w65mr14232272qkw.160.1492784926347; Fri, 21 Apr 2017 07:28:46 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id x62si9670157qka.141.2017.04.21.07.28.46; Fri, 21 Apr 2017 07:28:46 -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 00F6C60A7E; Fri, 21 Apr 2017 14:28:45 +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.4 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, RCVD_IN_SORBS_SPAM, 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 8889862C56; Fri, 21 Apr 2017 14:26:10 +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 BC07561CE2; Fri, 21 Apr 2017 14:26:04 +0000 (UTC) Received: from mail-oi0-f51.google.com (mail-oi0-f51.google.com [209.85.218.51]) by lists.linaro.org (Postfix) with ESMTPS id 3FECE60961 for ; Fri, 21 Apr 2017 14:25:34 +0000 (UTC) Received: by mail-oi0-f51.google.com with SMTP id j201so97299869oih.2 for ; Fri, 21 Apr 2017 07:25:34 -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=WpxE0Gntft5RddLt24+j5hzDz/6+sEySEE6lNWA56g7RRvy8IoeS6OyjSsFraF+lu8 lLw+5NEoOVWbTfXTs3xmedFQJSofVHR1PPR4zxCai+EEAeJfOAGKZ2FxtBhIJT4n5RPj rgzr6exeis+Dl+AOLOdp2Rk8HSx8xZTdNksMas3Yt5xis4YQE/PwIifVMsZl1IpjVcac 6yLEqjKyO3i7yGD59ndynizElMFIda6c9ZzWCLWCSO0ePYYOnKWrdG6sAHBaSl0xCGaF lUHwTTPm5C1jn9bxc8pAKFjiQV1t8Q7twUlHtawzrwh1/e+grGTfMKB/c1T/CB0BnhW3 WPSQ== X-Gm-Message-State: AN3rC/5Ucmznc3kd2yIpiDIz21HlfiRbnKZzwKJ5HA4B30yfzbmsXeE+ rUvNK3HDcPs8wHeI9mA= X-Received: by 10.157.17.108 with SMTP id p41mr5769884otp.111.1492784733601; Fri, 21 Apr 2017 07:25:33 -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 z9sm4103192otd.44.2017.04.21.07.25.32 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 21 Apr 2017 07:25:32 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Fri, 21 Apr 2017 09:25:25 -0500 Message-Id: <1492784725-31626-6-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1492784725-31626-1-git-send-email-bill.fischofer@linaro.org> References: <1492784725-31626-1-git-send-email-bill.fischofer@linaro.org> Subject: [lng-odp] [API-NEXT PATCHv3 6/6] 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;