From patchwork Wed Apr 19 22:34: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: 97690 Delivered-To: patch@linaro.org Received: by 10.140.109.52 with SMTP id k49csp530724qgf; Wed, 19 Apr 2017 15:34:58 -0700 (PDT) X-Received: by 10.55.214.71 with SMTP id t68mr4772586qki.211.1492641298450; Wed, 19 Apr 2017 15:34:58 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id q84si3852760qkl.160.2017.04.19.15.34.57; Wed, 19 Apr 2017 15:34:58 -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 5583260730; Wed, 19 Apr 2017 22:34:54 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 15D1A62D27; Wed, 19 Apr 2017 22:34: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 CB58C62D27; Wed, 19 Apr 2017 22:34:50 +0000 (UTC) Received: from mail-yw0-f171.google.com (mail-yw0-f171.google.com [209.85.161.171]) by lists.linaro.org (Postfix) with ESMTPS id B777161CB0 for ; Wed, 19 Apr 2017 22:34:48 +0000 (UTC) Received: by mail-yw0-f171.google.com with SMTP id u70so27237453ywe.2 for ; Wed, 19 Apr 2017 15:34: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; bh=293TYPvRVZt0SIlyu/Uds0L3BoUPbN2uxvIsLYX/hBA=; b=UImMj/0zdULRPEIQLxH2d7rKptZJLbXhTOQdZpFK+7N8WIG/geXTWJe0wJP9kBAe82 da4rs/nAPMLVHwg5xP61PspleBjbjT/x/dXRfv7wQbd1MGS+le9fLmKQrBkbPRDxe/3P vESqBxfKjvSo1bTxnqILDg06ywQ4AYOYGJnSGEeKmhzDkLGWjB0ksAkxmgvx0ybt2E9m D+F9TeUppHPs/DtCDjNb/aBeU1ncHj8poVOWvvS9vpHvlhi61/pOUbg4u4qNE+NM3fxL NJUvZDB2ShPenPNjmJO+tX5uua+a4vFl6E+5GQ2YJEsAe/ztV4CIroc78Y6acR4jgyvL Hc5A== X-Gm-Message-State: AN3rC/6h28bQ2rRFiQXw7mQ4FP+qY9ZfwkmPV9X7dKi+59ZMbKtYYr63 5Pm0mzfI4wScrJsJwDk= X-Received: by 10.202.64.213 with SMTP id n204mr1302002oia.78.1492641288239; Wed, 19 Apr 2017 15:34: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 w201sm37138oiw.13.2017.04.19.15.34.47 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 19 Apr 2017 15:34:47 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Wed, 19 Apr 2017 17:34:40 -0500 Message-Id: <1492641285-7020-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 Subject: [lng-odp] [API-NEXT PATCHv2 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 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:34: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: 97691 Delivered-To: patch@linaro.org Received: by 10.140.109.52 with SMTP id k49csp530725qgf; Wed, 19 Apr 2017 15:34:58 -0700 (PDT) X-Received: by 10.200.49.61 with SMTP id g58mr5428686qtb.151.1492641298467; Wed, 19 Apr 2017 15:34:58 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id 14si3857419qtp.215.2017.04.19.15.34.58; Wed, 19 Apr 2017 15:34:58 -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 8A0C162F99; Wed, 19 Apr 2017 22:34:55 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 5DE3A62E21; Wed, 19 Apr 2017 22:34: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 81F1362D27; Wed, 19 Apr 2017 22:34:51 +0000 (UTC) Received: from mail-yw0-f173.google.com (mail-yw0-f173.google.com [209.85.161.173]) by lists.linaro.org (Postfix) with ESMTPS id 69E2862C5A for ; Wed, 19 Apr 2017 22:34:49 +0000 (UTC) Received: by mail-yw0-f173.google.com with SMTP id u70so27237803ywe.2 for ; Wed, 19 Apr 2017 15:34:49 -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=UVfnY1CQY6xYvyarSzbEeKDMggvYYdsP7qQr7yn/8Vk7n9r9THGYzF2EbI7DPUu/FW lpvsgVbVMCEkcqdVCX9agxZ+wYjGarHWy3llo8Sa+I5tUxyBqXtWugni+MMuqMLXnHaH MVFCwq5E6ThE644rT129mqWsKEdY2I/DYEkgAfwkJS/C0H23iIh1NlTrZ+3h0LQioSep g5RbqdNxW8206YRibkdBDmA3KMUvZfZamszL8q9mLLJxR8FV+dJ0HMWqYLcLlexu/luz qpEdCOpKkilp5i+F19ES5IPVVK16TH0EqtvVYjg3030rbBTf4BHVKwIMDRGb1HctjEOE FpiQ== X-Gm-Message-State: AN3rC/7w32mNODzZ7XfdGYzRvn9Z8O6JXpBnIJctD9+IPRPN0VHcnrjd Yd5i8XUvmU7iwZxDXnc= X-Received: by 10.157.56.23 with SMTP id i23mr2745921otc.155.1492641289000; Wed, 19 Apr 2017 15:34: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 w201sm37138oiw.13.2017.04.19.15.34.48 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 19 Apr 2017 15:34:48 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Wed, 19 Apr 2017 17:34:41 -0500 Message-Id: <1492641285-7020-2-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1492641285-7020-1-git-send-email-bill.fischofer@linaro.org> References: <1492641285-7020-1-git-send-email-bill.fischofer@linaro.org> Subject: [lng-odp] [API-NEXT PATCHv2 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 Reviewed-by: Dmitry Eremin-Solenikov 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 Wed Apr 19 22:34:42 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97692 Delivered-To: patch@linaro.org Received: by 10.140.109.52 with SMTP id k49csp530761qgf; Wed, 19 Apr 2017 15:35:05 -0700 (PDT) X-Received: by 10.200.4.22 with SMTP id v22mr5035518qtg.227.1492641305113; Wed, 19 Apr 2017 15:35:05 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id m26si3855105qtb.229.2017.04.19.15.35.04; Wed, 19 Apr 2017 15:35:05 -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 54012635FE; Wed, 19 Apr 2017 22:34:58 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 1E859635DC; Wed, 19 Apr 2017 22:34:56 +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 482FA62E15; Wed, 19 Apr 2017 22:34:52 +0000 (UTC) Received: from mail-yw0-f176.google.com (mail-yw0-f176.google.com [209.85.161.176]) by lists.linaro.org (Postfix) with ESMTPS id 2F87262CE5 for ; Wed, 19 Apr 2017 22:34:50 +0000 (UTC) Received: by mail-yw0-f176.google.com with SMTP id k13so26991909ywk.1 for ; Wed, 19 Apr 2017 15:34: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=o4FKVNZt44tK1qBugj9HSNMaFYyTIrla+DDnxhJQEgs=; b=h3v115gVvmoMaKLA7Z1mIFtt1NUstFGRU70fxd9rmqSAMhBkKXe2jCDiLaAtysu7M3 3+rjEVNpcwoqKSZvTCN9bfbJorhcT1GVB8KyMX0fwI0u91Ss/0Hw1HYegYGprpmWaU9K GrIdCngoHvMnnIi/bkxb4PkbCluvEq5c4vjnn+9Be+bfvpeQWSPb5MWb9oAQPUcS0wYO OS2h9AdUKo1cyis3yver4Ru8UIARzZWiWpBf5lnehyF4Zcy6uqBAYKclyx3jeI/cUBr7 z8hyYq4lNcl+Y2sZ2w4E5u0ch333ncNerovQySE6UjFGgbWPpn1S45x6f+iQBmwyQ+yj ZtOg== X-Gm-Message-State: AN3rC/7UKhKDHltFg32ZYWep4XrJf8CINO/+EC7dErc56cJDyObKmHxy NfyNDfsH1G+H3Zeltis= X-Received: by 10.157.21.17 with SMTP id u17mr2498750otf.43.1492641289813; Wed, 19 Apr 2017 15:34: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 w201sm37138oiw.13.2017.04.19.15.34.49 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 19 Apr 2017 15:34:49 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Wed, 19 Apr 2017 17:34:42 -0500 Message-Id: <1492641285-7020-3-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1492641285-7020-1-git-send-email-bill.fischofer@linaro.org> References: <1492641285-7020-1-git-send-email-bill.fischofer@linaro.org> Subject: [lng-odp] [API-NEXT PATCHv2 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 Wed Apr 19 22:34:43 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97693 Delivered-To: patch@linaro.org Received: by 10.140.109.52 with SMTP id k49csp530777qgf; Wed, 19 Apr 2017 15:35:08 -0700 (PDT) X-Received: by 10.237.60.77 with SMTP id u13mr4823929qte.267.1492641308936; Wed, 19 Apr 2017 15:35:08 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id s5si3843017qkf.254.2017.04.19.15.35.08; Wed, 19 Apr 2017 15:35:08 -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 2238363664; Wed, 19 Apr 2017 22:35:00 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 75BDF635FD; Wed, 19 Apr 2017 22:34: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 079A960669; Wed, 19 Apr 2017 22:34:53 +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 E5A9D61CB0 for ; Wed, 19 Apr 2017 22:34:50 +0000 (UTC) Received: by mail-yw0-f178.google.com with SMTP id k13so26992227ywk.1 for ; Wed, 19 Apr 2017 15:34: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=YqtVwxlg1mJl6DukupnlccHE5eP0YV9plvwj9+Y4FEg=; b=kwCGTxmIMiNI2cKpaKSmRSP7gxeUQU87fnUfpdtW3BXwdDQGAzBRsIq+UpK9tE934r vcCAl2VwR031mqktrF941kkKZPlbIdOQ/Jd3ojxMmTZTNOHvJM82MniFjZ1+fI60+rH9 eEVBJY7sD7+Bn4ILMlYGM4NxjtNh7OcqfDD0LRGsQfXPM8CvGH5GOIWHaEzsnDxD+qN9 uzYeP5Wtp/KVXWCEdwWyEepl6TbmMFGtovd3NMoqCc3LTedt4bfc2kqcv1K9DY1/S9Xi ToE0uj8pDWya2w9cGh23kwoKbkvtjWpoL8XlEUtObRC7FkIWwBBOnYKVNy3DmdsXLIEy /t9w== X-Gm-Message-State: AN3rC/7eZh4ItTBp7XVhscfza7ntzR/cTA5vgQxM14vaY+clw1WZnFwD CRYZgTRVMDYp50KRvNA= X-Received: by 10.157.50.200 with SMTP id u66mr2937937otb.121.1492641290547; Wed, 19 Apr 2017 15:34: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 w201sm37138oiw.13.2017.04.19.15.34.49 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 19 Apr 2017 15:34:50 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Wed, 19 Apr 2017 17:34:43 -0500 Message-Id: <1492641285-7020-4-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1492641285-7020-1-git-send-email-bill.fischofer@linaro.org> References: <1492641285-7020-1-git-send-email-bill.fischofer@linaro.org> Subject: [lng-odp] [API-NEXT PATCHv2 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 Wed Apr 19 22:34:44 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 97694 Delivered-To: patch@linaro.org Received: by 10.140.109.52 with SMTP id k49csp530802qgf; Wed, 19 Apr 2017 15:35:13 -0700 (PDT) X-Received: by 10.55.81.196 with SMTP id f187mr5144522qkb.278.1492641313271; Wed, 19 Apr 2017 15:35:13 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id 57si3851329qtv.284.2017.04.19.15.35.12; Wed, 19 Apr 2017 15:35:13 -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 2272662E48; Wed, 19 Apr 2017 22:35:02 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id B8D9E60730; Wed, 19 Apr 2017 22:34: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 EA2FD60661; Wed, 19 Apr 2017 22:34:53 +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 CCC0162C5A for ; Wed, 19 Apr 2017 22:34:51 +0000 (UTC) Received: by mail-yw0-f172.google.com with SMTP id k13so26992602ywk.1 for ; Wed, 19 Apr 2017 15:34: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=PdBD9pmAGvN4Jy1XPjUe4z0RVFzcsnBZU1JKvwZBKWg=; b=jNc3Vn03n4MYPxknuz8TdNDUkwiXW23nfrqpJoIwou6yNbuouyJ6cfbcC6hogcP3A+ 4VxmBvs6v9LcIFFyTupMPK07Hp6IumziWmPpIz7rrNlu38+LBJccHz2jLXlRAKdTyXmp DH2Bm1NdMvyEh6BiaSx4evCYK5YN7nLofn8l9PdnLEAa+WSGWzmIuF4NP62m/Eae9AFy 9kAt7J9Jby5ZjYOX5xTZHNnrroo7kTlmdizxgAhW7oa+W94Ea2xwaAqXI81e/pxyOzb2 uwWwcnQs72BC2uDeqj/0JDIGVuM2eFwt1FdNdvfMrkuwdH1WzaSq8qSekJKVWdlHr4kc 7fdA== X-Gm-Message-State: AN3rC/7N7hg/i/Pi1jWY3iowqFVM+z71vXE/0hPqFAmDrG7Y0IgT3Yo1 zutEL4SAb7+pDVIpf0M= X-Received: by 10.157.82.130 with SMTP id f2mr2418904oth.143.1492641291388; Wed, 19 Apr 2017 15:34: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 w201sm37138oiw.13.2017.04.19.15.34.50 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 19 Apr 2017 15:34:50 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Wed, 19 Apr 2017 17:34:44 -0500 Message-Id: <1492641285-7020-5-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1492641285-7020-1-git-send-email-bill.fischofer@linaro.org> References: <1492641285-7020-1-git-send-email-bill.fischofer@linaro.org> Subject: [lng-odp] [API-NEXT PATCHv2 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 --- helper/include/odp/helper/ip.h | 2 +- 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 +- 4 files changed, 11 insertions(+), 2 deletions(-) -- 2.11.0 diff --git a/helper/include/odp/helper/ip.h b/helper/include/odp/helper/ip.h index 91776fad..b31a13a0 100644 --- a/helper/include/odp/helper/ip.h +++ b/helper/include/odp/helper/ip.h @@ -29,7 +29,7 @@ extern "C" { #define ODPH_IPV4 4 /**< IP version 4 */ #define ODPH_IPV4HDR_LEN 20 /**< Min length of IP header (no options) */ #define ODPH_IPV4HDR_IHL_MIN 5 /**< Minimum IHL value*/ -#define ODPH_IPV4ADDR_LEN 4 /**< IPv4 address length in bytes */ +cd #define ODPH_IPV4ADDR_LEN 4 /**< IPv4 address length in bytes */ /** The one byte IPv4 tos or IPv6 tc field is composed of the following two * subfields - a six bit Differentiated Service Code Point (DSCP) and a two 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 Wed Apr 19 22:34: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: 97695 Delivered-To: patch@linaro.org Received: by 10.140.109.52 with SMTP id k49csp530804qgf; Wed, 19 Apr 2017 15:35:13 -0700 (PDT) X-Received: by 10.55.170.209 with SMTP id t200mr5316447qke.176.1492641313515; Wed, 19 Apr 2017 15:35:13 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id t1si3839213qkl.333.2017.04.19.15.35.13; Wed, 19 Apr 2017 15:35:13 -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 55F1F60A02; Wed, 19 Apr 2017 22:35:06 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 439DA62E41; Wed, 19 Apr 2017 22:35:04 +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 7B52B62E62; Wed, 19 Apr 2017 22:34:55 +0000 (UTC) Received: from mail-yw0-f175.google.com (mail-yw0-f175.google.com [209.85.161.175]) by lists.linaro.org (Postfix) with ESMTPS id DE9A262E30 for ; Wed, 19 Apr 2017 22:34:52 +0000 (UTC) Received: by mail-yw0-f175.google.com with SMTP id k13so26992984ywk.1 for ; Wed, 19 Apr 2017 15:34: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=rUIp/IzcJeuupg0/jIKtv0gvWmPU7Y1E7iVih8AIq3k=; b=VLJC4t8CsAoai2R4byCW4//tGMJ9euDhSa40DlCUoZOHWq2phoLI7nmtzNV91N+DZQ i/dQxGm30rwUlbu2HFCeRZIfq4yM/Z/bbXNER8xsqFfiVPKyxMmAm+XvUcPi1aoL5QIz Z64jy4wRt3rKce/eLtcWSfI6QN6y2MNT5sLEanHkLxuu2V/vMTQBy881wESG4NQgSs4b mjNE3y3WlaQOMNT2B06zXz7Gzg+m/HUk+MvNFBnK1ed9DXu7ShRARo0LZuD0tSVGK4YU Rj4wG62pxCDpPfNvABDsp3UaCyoL8v00bRViTGqGYDab+4NALS8/+B1z4Ljv4p/0+B5l 3xUg== X-Gm-Message-State: AN3rC/6Q4SyDPLt6Fken3Uf9Ft9BdBMxueTKn4bIzVIWEjnrdvgtriOs n7nl/uT8tKy5m4dYAfA= X-Received: by 10.157.39.41 with SMTP id r38mr2862222ota.11.1492641292193; Wed, 19 Apr 2017 15:34:52 -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 w201sm37138oiw.13.2017.04.19.15.34.51 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 19 Apr 2017 15:34:51 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Wed, 19 Apr 2017 17:34:45 -0500 Message-Id: <1492641285-7020-6-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1492641285-7020-1-git-send-email-bill.fischofer@linaro.org> References: <1492641285-7020-1-git-send-email-bill.fischofer@linaro.org> Subject: [lng-odp] [API-NEXT PATCHv2 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/ip.h | 2 +- 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 +++++-- 6 files changed, 34 insertions(+), 26 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/ip.h b/helper/include/odp/helper/ip.h index b31a13a0..91776fad 100644 --- a/helper/include/odp/helper/ip.h +++ b/helper/include/odp/helper/ip.h @@ -29,7 +29,7 @@ extern "C" { #define ODPH_IPV4 4 /**< IP version 4 */ #define ODPH_IPV4HDR_LEN 20 /**< Min length of IP header (no options) */ #define ODPH_IPV4HDR_IHL_MIN 5 /**< Minimum IHL value*/ -cd #define ODPH_IPV4ADDR_LEN 4 /**< IPv4 address length in bytes */ +#define ODPH_IPV4ADDR_LEN 4 /**< IPv4 address length in bytes */ /** The one byte IPv4 tos or IPv6 tc field is composed of the following two * subfields - a six bit Differentiated Service Code Point (DSCP) and a two 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;