From patchwork Wed Jul 12 01:45: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: 107433 Delivered-To: patch@linaro.org Received: by 10.140.101.44 with SMTP id t41csp207387qge; Tue, 11 Jul 2017 18:45:56 -0700 (PDT) X-Received: by 10.55.158.19 with SMTP id h19mr3227612qke.201.1499823956386; Tue, 11 Jul 2017 18:45:56 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1499823956; cv=none; d=google.com; s=arc-20160816; b=fzkvYzqxjl/eXQjkp5b4BfiS1UG/ty3FdncJQ1PuhLQAvwAkrB2JYAIawvHSo3XUb2 c5KVHvbvZz0f4kASEpBXSufYA49VfCn+5iRQ0IZ2CGwfcl6OpANMkuxkZaXowe4ZPw2g yWj49+YhxwNDQNdOFYdtZ0F5cwd62888IVbGNSbVxoHx4AeXYbcWHI4rxcRMmL/1G5RP IPfE+VXoQIn9xPfBazeiJXObb/oxtb52CI9KtPZ+qPtGLXAFEVkC31lQz9CgF99mre1x N+ojWyENMaP06NXuJ2EIeWOLtVcl11Vik0AOCWOyjdGN/zTv8rUhpFQG3+QqDcZ9tAUS tnNQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject:message-id:date:to:from :delivered-to:arc-authentication-results; bh=fczSsFuSLMeQ052TBr8HXOhqKH++wiYwHavBV0NLMFM=; b=BkXRxbRswll/bRtHleWVBOQkLPfUfQJYZg2g4CuUzGeYK4+MvTHN2XJoyZIEICfLFB avAFE1dfJaYoQBlJcOD/zJIVzN16olNn4hLqk9SKNShUDB/ZRCe4+Tpsv8xhVKYDnNLk x+4kSWME9d3paAY4CYM6Xctw4VTvMEl6syTZtS8p+dp8tTeP0R/OZgm3iRneHtROR6P6 8M2soxHo5AiG6KSn5OLwt1J30MnpwChOK0i2PFrqndzaMGowwxsnlnzUztNB8Howlv50 GD2TpC7uCbs2LwkHafEsnzFYnN+VNbZkLK/rvxNDTFx/uah/HIi5V2xfSSNTHfdmd+E5 Hsjw== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id q4si913140qkd.363.2017.07.11.18.45.56; Tue, 11 Jul 2017 18:45: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 1501964495; Wed, 12 Jul 2017 01:45:56 +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 E255362D05; Wed, 12 Jul 2017 01:45: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 59C6462D0A; Wed, 12 Jul 2017 01:45:49 +0000 (UTC) Received: from mail-oi0-f54.google.com (mail-oi0-f54.google.com [209.85.218.54]) by lists.linaro.org (Postfix) with ESMTPS id 46E6E62AE4 for ; Wed, 12 Jul 2017 01:45:48 +0000 (UTC) Received: by mail-oi0-f54.google.com with SMTP id p188so8153433oia.0 for ; Tue, 11 Jul 2017 18:45: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=fczSsFuSLMeQ052TBr8HXOhqKH++wiYwHavBV0NLMFM=; b=bqlZNQqR6/Elv4/ATFvBlVu/qCmaentH0HTnBRmDi/wV9pJ2nRGa0StlsgU4Eg/vS8 TxsIsiX1ZpFKkDSP0F+zrswuORk760xZPkX56cPY5K6g28oiOmEvxsZgVb2Kmn3NyZG8 6FemfMrM1W4kFNVp2w0abD+D/LcsM1ZzAC32+sy7oXzLXoHk9qUEnfm5X4F6Yfkucomx eQLgMm6jsgAWuXEoFx83wiTxMjzpVZX1qAhw6bcj/YieJ41K+0fN2/Afpla3lNTb5eZo DAaxeG8J8LPBlbFC/ySAh6FzZxc2F46rArezOmNwwRlyaSzKHAVyhiN9QI34le+AKzcn cb7g== X-Gm-Message-State: AIVw113CShiR2BtLMjCL59ZTW2tSfa0pWlsZimn07uL45lMPVpCrSO8K ld8/MdZLg/CrKhqaOokpGMjw X-Received: by 10.202.192.11 with SMTP id q11mr2408320oif.228.1499823947592; Tue, 11 Jul 2017 18:45: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 s129sm910041oif.41.2017.07.11.18.45.46 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 11 Jul 2017 18:45:47 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Tue, 11 Jul 2017 20:45:41 -0500 Message-Id: <20170712014545.13325-1-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.11.0 Subject: [lng-odp] [MONARCH_LTS 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 523a8c41..7a6d9a5c 100644 --- a/include/odp/api/spec/classification.h +++ b/include/odp/api/spec/classification.h @@ -364,7 +364,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; @@ -372,6 +374,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 Jul 12 01:45: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: 107434 Delivered-To: patch@linaro.org Received: by 10.140.101.44 with SMTP id t41csp207728qge; Tue, 11 Jul 2017 18:46:21 -0700 (PDT) X-Received: by 10.55.153.4 with SMTP id b4mr3255403qke.203.1499823981754; Tue, 11 Jul 2017 18:46:21 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1499823981; cv=none; d=google.com; s=arc-20160816; b=AdWo5DFLS/CbCrbWhRxtlilRFE+HWYTFGNFlYxBODCPAsLrKuPIL/OA2PlOGGIsbm4 MnIMwkA9Gr2KfEne1zikBOSRSJ2wvREJU6oYFAz2pgwj0Mgx12hLSjroapVJiC/ETe8q 2O72vtbWZERsIxwGgAVSDfbM/HD1AOHFoS5c6ABV7GBvcG5AgJfUF8G13+iVXFaFW+74 AMFV7+HKno5V+8Kb2jFBqUw5cyk9XpVqU1gAEGJeJpM9Ohm/NUOuE/u9xX7yATdMujNG Xm9pqjbz6GP4BP/r5KZDgpjBBvFj+i4eJ0b+WdAKvVsDKWvsx58IscpzKgGK9s7aoJWP M/LQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject:references:in-reply-to :message-id:date:to:from:delivered-to:arc-authentication-results; bh=aKLRwV3o5C0VsVsz4NxkURycMjHl7hFSxUhQcYKKbJA=; b=nL1JLWFzTDGRFFlSO4oJz+X6wFdi5ZJJNzla/J7c8g2sRX8sfFDxpscpy33NOm9ZAw 9CXZjlaX96QF8L3s4vlgA1vujbPNeg3N56M232melBLVc+1qYhuhBaiu327Znah2ANuH mRRRJT0RSe7rwXlL5em6KWE4lbx2aAu6qoWQXu0iSsiUGZ9O11w1RsasWmftoYQgKuD5 oMd3FQbisTzE7CyBYYAIAqWb8TLvbdNxzGDrZXTnQmSQyxuH6eiQFhcrvx1vEYhUMVKM JG86j5s4MIzLWSv+7uuVdYn+3zG3HuvsJFlYjuhtyX8nKcRsw1MjPD3FzBQhNEhspEZI xW6g== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id x16si957930qta.307.2017.07.11.18.46.21; Tue, 11 Jul 2017 18:46:21 -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 7C73862D19; Wed, 12 Jul 2017 01:46:21 +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 74CA864478; Wed, 12 Jul 2017 01:45: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 6762F62CE7; Wed, 12 Jul 2017 01:45:50 +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 2B5E262CE7 for ; Wed, 12 Jul 2017 01:45:49 +0000 (UTC) Received: by mail-oi0-f43.google.com with SMTP id p188so8153616oia.0 for ; Tue, 11 Jul 2017 18:45: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=aKLRwV3o5C0VsVsz4NxkURycMjHl7hFSxUhQcYKKbJA=; b=Hb8K/hoRW94kgg3zPTWQJHGIudmIs9jgCZQ8iuUp9zOGz/kQPNgpIZqmfKwEuzzlyI WMkU3Bf/cBtUzHHgIH0f5CxzVRN9oYZZyIcdrWCnbKQmaVZoGWlHeb68V746FGjkNTLL vaGzo8YuLQE5LFUOuIpmokBCKGXQY0Tdqwn87znU+Z2hXDtTpiDA4fqoYHPXYZjSyxWr 1z9woR7CwIkS5CDlrg6b2hj7/cMas0HQhD+ou0KAATrHqKL7J/YczdkK3eoc0jqpqoUD 3Zty0QRTZSHjNVHkfpENGwyd4Z0wuK3ONkmSZOjW8EGdVDewHRNd4EACwgk3ZWO5WF+o DMKA== X-Gm-Message-State: AIVw111qEXKbEFF/LvFspgHwlvB/bzby30z2BvSshR3VWLn4i4aZlKnG +fXBXHIZ1o/Ci2d0WD5lCmsw X-Received: by 10.202.230.212 with SMTP id d203mr2250750oih.143.1499823948491; Tue, 11 Jul 2017 18:45: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 s129sm910041oif.41.2017.07.11.18.45.47 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 11 Jul 2017 18:45:47 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Tue, 11 Jul 2017 20:45:42 -0500 Message-Id: <20170712014545.13325-2-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20170712014545.13325-1-bill.fischofer@linaro.org> References: <20170712014545.13325-1-bill.fischofer@linaro.org> Subject: [lng-odp] [MONARCH_LTS PATCH 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 b31b6aa8..10bcbd51 100644 --- a/include/odp/api/spec/pool.h +++ b/include/odp/api/spec/pool.h @@ -164,7 +164,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; @@ -178,6 +180,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. @@ -203,6 +207,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 Jul 12 01:45: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: 107435 Delivered-To: patch@linaro.org Received: by 10.140.101.44 with SMTP id t41csp208045qge; Tue, 11 Jul 2017 18:46:48 -0700 (PDT) X-Received: by 10.55.8.140 with SMTP id 134mr3580901qki.198.1499824008488; Tue, 11 Jul 2017 18:46:48 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1499824008; cv=none; d=google.com; s=arc-20160816; b=ZhNc1KXwszhPpw+X/GNbJ6VXFcSxl5oDFjyhUepGxUHpj8OtaJN8zK4w2xqbhs5MtP CyylrmfwdG6J6KSt6Vwdy/+I3ldrtwlMDr9mDUTXKBWNZ7fUpk+YjtN8fZKwKphMUeX7 D15tRi7492oK97LOqzae+B6/JGuJqGosNBY6+wnziFyYxim+ioZ/5Ms+sRUoK1i7H9F9 4gVlfuBI4WrXxI6Dduall85B4HuaXKzbxH+YfWep6VeGLLB17mlHAj/kapiryMLdyPWF fNzZ/9zElK0bKCeJ/MiLIDwWDgsxo3410w/flS+V67SOpukCa8rtZiflVQKkQZj6EjrI 2V/Q== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject:references:in-reply-to :message-id:date:to:from:delivered-to:arc-authentication-results; bh=sqo5+NSiW9bPrHfpRAHREjYytmHBNRMKjaYL0kTDicI=; b=ojlkPQgfupEpu/4av07rswNYwlL9SvWdeoHSp9HgiO/If0XFQQUxBuM42g+MtuNtCC 2XOpy9WO6BUMXmhdiLo3/tDttnPm3Q5JWkOf8U7tVwc9aPtmbt0UycdhQn8eU1nMQvj6 gULB29uCQ5nZVwJUVL3s2Xr7LBfw60eYX7pLyzuWtyyF96km46icVYd45I918Y8Fc9m6 3socgpEF/UU1FOi+dfa0UmFUQZbnbDo/TtLAR2y2GT0CU7ubrbulIH6vwJC9bAR3geZN B3BmPyfRQ4xUOJsMOXfzsB0FZG2t+CK2s1/RODXgDjP4f+nT+oKWumnKAQb4wwB8BEFj F3NA== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id j133si906504qkj.367.2017.07.11.18.46.48; Tue, 11 Jul 2017 18:46:48 -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 1C2A2644A1; Wed, 12 Jul 2017 01:46:48 +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 DCE1164490; Wed, 12 Jul 2017 01:45: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 152BF64495; Wed, 12 Jul 2017 01:45:53 +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 4ABAF62AE4 for ; Wed, 12 Jul 2017 01:45:50 +0000 (UTC) Received: by mail-oi0-f43.google.com with SMTP id x187so8063572oig.3 for ; Tue, 11 Jul 2017 18:45: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=sqo5+NSiW9bPrHfpRAHREjYytmHBNRMKjaYL0kTDicI=; b=CCRZKn5wnsX386KruQTh5wM2Xkoz/X9psRSg8cgg2Cmdo27yywFpS39b3/jx6iFdf8 OI6L2oi9ReIe14z2PCSpP8+yZnVYO/K9rLhiLVHfX3zawt//QdYDjszfeJLkaiw1RK6O Xvq07Iuyt7IF/ulZvI90fgQ4Lj8z4Mo45KaBL2D/WVC2HNqYi70LfB5mImo95+9JTIpe /xu24vIDQ4bqNspBO/F7r4Az3cX8GI8l8jAUioXkfrCjiap2LQUD9euD4O6x4jqJCXn6 Ton1n1LTvN+f9eYrqPWB5zMK1dkDVcd/hac6gXHkEe069fpsX6bmEaFeM6oBjZSdYAO2 sWHg== X-Gm-Message-State: AIVw110GPBCmc0kTCLICK0n+5nhKAUt3732h3wL2ZkPnEV/nDx6mImmT SRHbweWEoUvLIERvOS3swCi6 X-Received: by 10.202.235.19 with SMTP id j19mr2157329oih.209.1499823949641; Tue, 11 Jul 2017 18:45: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 s129sm910041oif.41.2017.07.11.18.45.48 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 11 Jul 2017 18:45:48 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Tue, 11 Jul 2017 20:45:43 -0500 Message-Id: <20170712014545.13325-3-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20170712014545.13325-1-bill.fischofer@linaro.org> References: <20170712014545.13325-1-bill.fischofer@linaro.org> Subject: [lng-odp] [MONARCH_LTS PATCH 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 34736484..ce27bcab 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 Jul 12 01:45: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: 107436 Delivered-To: patch@linaro.org Received: by 10.140.101.44 with SMTP id t41csp208372qge; Tue, 11 Jul 2017 18:47:10 -0700 (PDT) X-Received: by 10.200.33.209 with SMTP id 17mr3752276qtz.189.1499824030518; Tue, 11 Jul 2017 18:47:10 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1499824030; cv=none; d=google.com; s=arc-20160816; b=IAZVHWDa3cW780eiLs4GlUIzi8HQT23PtgHC+5DScsn9eqVwGHmTUZlPsm2VZjSVr2 Ib9zgAPKZKtQdbQWS0OV+adHBHOIVrlliYjYGaCE3hcXCEJa8Rq0yGEJGKW/rKnMe9cj 06wGcpTwXxjKBeOrg4+iZ1X9AD352+6KApA8cNI6J8+esT5CL5Pb+puioikzxoFTnyLC VZLNyDsjmZs2aERgXwsebLsMSxr48kpd7zxA2ZjkuTQepbAnZZHtzMZsCQ1HZVfVkTA6 NnP579E0OSu1ATezkFa7jio2P2w3bD45KEihMLee/akUxr1tsqSk+qINYcZcV4zbl76E FQdg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject:references:in-reply-to :message-id:date:to:from:delivered-to:arc-authentication-results; bh=+zGQwTz+Z1xrv+weSKmYgpcEj6gJ9vcrCZq/u1dparU=; b=eS1fXYyNEZBzTZd6rC1HES4Lllx9CLNKnr68PFFV63HoaUqHgrM+9JhHi2iAalxTv0 pAtoYTmwhWmV+TEwXzRy0SrKM7M330Z8DRVGbMHydnmBEaV9XjUn7GWqrH2Cu4cr7Gdp PCAsx2MZESu/TD5DZU+xZUYgnnkgSXVzWER7qFRBCDb6Dax9JWB4PqgH8LnBTqPYSDHk wOgzmx0SfcdiJL9nB0WaWxO+b6nQZBcWtcUdMo4+5RBckQ0gfmNModcOWWWYWnmcMt0U nufXX7YdjyoK+2R2PSTpQRajSgvGj6w6bfrbiv3lOE88NPQ/gqFgy8vqVGBuo6hZAG1P xDEw== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id b82si1047064qkh.366.2017.07.11.18.47.10; Tue, 11 Jul 2017 18:47: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 326DE64490; Wed, 12 Jul 2017 01:47: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 5F4A364478; Wed, 12 Jul 2017 01:46:24 +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 DFFF162D32; Wed, 12 Jul 2017 01:46:19 +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 4E46162D19 for ; Wed, 12 Jul 2017 01:45:51 +0000 (UTC) Received: by mail-oi0-f43.google.com with SMTP id p188so8154050oia.0 for ; Tue, 11 Jul 2017 18:45: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=+zGQwTz+Z1xrv+weSKmYgpcEj6gJ9vcrCZq/u1dparU=; b=RxP0BVLu9pdRVUeZMY9Cj6FZd7jODlUlliz1G9iaEkHqQRAw62PlefOw6qUhB5FIeW r3/qI2TGyLyL/m9df2rLzrHEKuT5rz4y2k2D19neF2xBsvl/+B3Sh3WyyY2watUVvIgt Bvppi9VW+QMHiY5er6qiroOvsSu5GcvsdDQlImaxdmyoAn1KGPw8vGkb+e4xzn7AdTo6 t1UxtW0K5ZljA1EELtutgUmwQBTTyHmrFBFTQCwWLYyLgjA2pLZoHkZfShwwcXing7jj XdrNdjkfSkd+rXpgQ+W6yvv7ZArB55W+QVrW6f2ToeufY/sp5H5uKhqVwGcPXRu91u9e VWfg== X-Gm-Message-State: AIVw113Pl83ZklL3C9gHW4aBJRdBp5vY1C36hY3Vt+IjjyYl7GGCMvfi BZQjXm391FUBrj8f7l6Imb5A X-Received: by 10.202.58.136 with SMTP id h130mr2145674oia.159.1499823950557; Tue, 11 Jul 2017 18:45: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 s129sm910041oif.41.2017.07.11.18.45.49 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 11 Jul 2017 18:45:49 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Tue, 11 Jul 2017 20:45:44 -0500 Message-Id: <20170712014545.13325-4-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20170712014545.13325-1-bill.fischofer@linaro.org> References: <20170712014545.13325-1-bill.fischofer@linaro.org> Subject: [lng-odp] [MONARCH_LTS PATCH 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/plat/buffer_types.h | 11 ++++++++++- platform/linux-generic/include/odp/api/plat/pool_types.h | 11 ++++++++++- .../linux-generic/include/odp/api/plat/traffic_mngr_types.h | 2 +- 3 files changed, 21 insertions(+), 3 deletions(-) -- 2.11.0 diff --git a/platform/linux-generic/include/odp/api/plat/buffer_types.h b/platform/linux-generic/include/odp/api/plat/buffer_types.h index 344121b6..079f5aaa 100644 --- a/platform/linux-generic/include/odp/api/plat/buffer_types.h +++ b/platform/linux-generic/include/odp/api/plat/buffer_types.h @@ -32,7 +32,16 @@ typedef ODP_HANDLE_T(odp_buffer_seg_t); /** Invalid segment */ #define ODP_SEGMENT_INVALID ((odp_buffer_seg_t)ODP_BUFFER_INVALID) -/** Get printable format of odp_buffer_t */ +/** Get printable format of odp_buffer_t + * + * @param hdl odp_buffer_t handle to be printed + * @return uint64_t value that can be used to print/display this + * handle + * + * @note This routine is intended to be used for diagnostic purposes + * to enable applications to generate a printable value that represents + * an odp_buffer_t handle. + */ static inline uint64_t odp_buffer_to_u64(odp_buffer_t hdl) { return _odp_pri(hdl); diff --git a/platform/linux-generic/include/odp/api/plat/pool_types.h b/platform/linux-generic/include/odp/api/plat/pool_types.h index 1ca8f02e..c466dcbb 100644 --- a/platform/linux-generic/include/odp/api/plat/pool_types.h +++ b/platform/linux-generic/include/odp/api/plat/pool_types.h @@ -39,7 +39,16 @@ typedef enum odp_pool_type_t { ODP_POOL_TIMEOUT = ODP_EVENT_TIMEOUT, } odp_pool_type_t; -/** Get printable format of odp_pool_t */ +/** Get printable format of odp_pool_t + * + * @param hdl odp_pool_t handle to be printed + * @return uint64_t value that can be used to print/display this + * handle + * + * @note This routine is intended to be used for diagnostic purposes + * to enable applications to generate a printable value that represents + * an odp_pool_t handle. + */ static inline uint64_t odp_pool_to_u64(odp_pool_t hdl) { return _odp_pri(hdl); 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 Jul 12 01:45:45 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 107437 Delivered-To: patch@linaro.org Received: by 10.140.101.44 with SMTP id t41csp209273qge; Tue, 11 Jul 2017 18:48:16 -0700 (PDT) X-Received: by 10.55.75.210 with SMTP id y201mr3789482qka.80.1499824096454; Tue, 11 Jul 2017 18:48:16 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1499824096; cv=none; d=google.com; s=arc-20160816; b=r7OAzEjM0rNSvPbP77/2H2XQdFZhykkoL3h1GooHfJHVQgO3q4/ORghmFVHoVHCWPu 8YcLz0C6mqZuZ5yJeOeCrcqgs14FfXP1b+XOzuOpouKOx/zh9bcHfPKxXkj0mqydE5Eq zSDET93urFOGFuxaCWTjPCkbuYKs86jVMCNAuhyLiV/rHZWxDNY86BpW7RB7hDezAyh2 IHV0bQgBPVGDJFTvCfPcB9NoNf3Dd4/YCgXmRdyhBxLIUOTj4h5Cu9DXKovLm89gkb9v zfWIPUDaXlBkDSCBxSPNNO9xeUOuMjVbUbSJdixWEwU3AUligAn9OIcIdhl0lo2420H1 j4UQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject:references:in-reply-to :message-id:date:to:from:delivered-to:arc-authentication-results; bh=daV6glWQM4zQpT+kaHqu3SqRhc5OSSh1YLYhrHKr5Zk=; b=u8v4Wn+pHjauwR4hKfXeGvtA6zRXZmakGhK1gEtwB/TyxZxMNTCMK4yEHP8vmoeSg1 3RzTMpcKZIevEFKun5B/w6BAhhYBiEvtS15gg7ghxOWSX/9d4UqzXLyJagzmUMLNrIPQ c4piKxShO7opjUXvco3vBjzomJrZhEBSwIWjKLe1v+V3ZM1ZlVJp5c/gg81qKRzx5Ogn IBgR4qAHQ2afzllUVTTu43jeRa0JyTbDp7BlzUkQGqyTu9kL49UMXDmSUb0pdGm1LYcf oGxX9sx/pWXsLX7z6o01UsRrND0P/9Rz/wTSVZldn2u7tYNSVrlCt2zPI+/SD/KdBUis 966g== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id y28si965041qtc.18.2017.07.11.18.48.16; Tue, 11 Jul 2017 18:48:16 -0700 (PDT) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 1EE4962D32; Wed, 12 Jul 2017 01:48:16 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 06C446449A; Wed, 12 Jul 2017 01:46:41 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id D9A4C6449A; Wed, 12 Jul 2017 01:46:37 +0000 (UTC) Received: from mail-oi0-f49.google.com (mail-oi0-f49.google.com [209.85.218.49]) by lists.linaro.org (Postfix) with ESMTPS id B071A62CE7 for ; Wed, 12 Jul 2017 01:45:52 +0000 (UTC) Received: by mail-oi0-f49.google.com with SMTP id p188so8154341oia.0 for ; Tue, 11 Jul 2017 18:45:52 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=daV6glWQM4zQpT+kaHqu3SqRhc5OSSh1YLYhrHKr5Zk=; b=RgV7eJrFNsE0NzMHT2R/ior3V+eoXacVU3AdpWNAMNnb3JC7giMl3pBvLx/qzYW+UG 9EaBmc1HK7IxVrAJq90GXw8Z6EcL1XtGaZLAqYGn0mRJqgtobnlhBY0ZMMnvkZwwkcfS CWzg2g0RxBuzKiAJtaWPeK/Q9mhuFOcPsR01HJFAFyiD5nxd1EAv4oS8RuQSVDUsn4VY VLXM3KmO6/beJNF2fxN/WLhonxZvGxCuviKMEtR1U1dJRE/0LbQfTwgwynnX6BPg53vJ VWwBIehCaj50GYqmkmTJwCUmCiB25oAgmpDWHH32gSj+kknRbMr7Zw2PNXgeuJRV8KOJ CI5Q== X-Gm-Message-State: AIVw110Aen5WyuxZBFBa1u8TEzDys86DDb3EGyaOhytTanMoHuZBhBe4 2OVYpUp/cpA7H3jWGIiZWm64 X-Received: by 10.202.180.84 with SMTP id d81mr2020916oif.112.1499823951922; Tue, 11 Jul 2017 18:45:51 -0700 (PDT) Received: from localhost.localdomain (cpe-70-121-83-241.austin.res.rr.com. [70.121.83.241]) by smtp.gmail.com with ESMTPSA id s129sm910041oif.41.2017.07.11.18.45.50 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 11 Jul 2017 18:45:50 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Tue, 11 Jul 2017 20:45:45 -0500 Message-Id: <20170712014545.13325-5-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20170712014545.13325-1-bill.fischofer@linaro.org> References: <20170712014545.13325-1-bill.fischofer@linaro.org> Subject: [lng-odp] [MONARCH_LTS PATCH 5/5] helper: add additional doxygen documentation X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" Resolve Bug https://bugs.linaro.org/show_bug.cgi?id=2952 by adding additional field documentation to avoid problems with doxygen 1.8.13 and higher. Signed-off-by: Bill Fischofer --- helper/include/odp/helper/icmp.h | 11 ++++++---- helper/include/odp/helper/linux.h | 7 +++++-- helper/include/odp/helper/strong_types.h | 3 ++- helper/include/odp/helper/table.h | 2 +- helper/include/odp/helper/tcp.h | 35 ++++++++++++++++---------------- 5 files changed, 33 insertions(+), 25 deletions(-) -- 2.11.0 diff --git a/helper/include/odp/helper/icmp.h b/helper/include/odp/helper/icmp.h index e25646ad..bef96784 100644 --- a/helper/include/odp/helper/icmp.h +++ b/helper/include/odp/helper/icmp.h @@ -32,15 +32,18 @@ typedef struct ODP_PACKED { uint8_t type; /**< message type */ uint8_t code; /**< type sub-code */ odp_u16sum_t chksum; /**< checksum of icmp header */ + /** Variant mappings of ICMP fields */ union { + /** Fields used for ICMP echo msgs */ struct { - odp_u16be_t id; - odp_u16be_t sequence; + odp_u16be_t id; /**< id */ + odp_u16be_t sequence; /**< sequence */ } echo; /**< echo datagram */ odp_u32be_t gateway; /**< gateway address */ + /** Fields used for ICMP frag msgs */ struct { - odp_u16be_t __unused; - odp_u16be_t mtu; + odp_u16be_t __unused; /**< @internal */ + odp_u16be_t mtu; /**< mtu */ } frag; /**< path mtu discovery */ } un; /**< icmp sub header */ } odph_icmphdr_t; diff --git a/helper/include/odp/helper/linux.h b/helper/include/odp/helper/linux.h index 238bcf8c..aa0e8f5e 100644 --- a/helper/include/odp/helper/linux.h +++ b/helper/include/odp/helper/linux.h @@ -82,12 +82,15 @@ typedef struct { odph_odpthread_start_args_t start_args; /**< start arguments */ int cpu; /**< CPU ID */ int last; /**< true if last table entry */ + /** Variant mappings for thread/process */ union { - struct { /* for thread implementation */ + /** for thread implementation */ + struct { pthread_t thread_id; /**< Pthread ID */ pthread_attr_t attr; /**< Pthread attributes */ } thread; - struct { /* for process implementation */ + /** for process implementation */ + struct { pid_t pid; /**< Process ID */ int status; /**< Process state chge status*/ } proc; diff --git a/helper/include/odp/helper/strong_types.h b/helper/include/odp/helper/strong_types.h index 13e35a43..501d0f28 100644 --- a/helper/include/odp/helper/strong_types.h +++ b/helper/include/odp/helper/strong_types.h @@ -20,10 +20,11 @@ /** Use strong typing for ODP types */ #ifdef __cplusplus +/** @internal C++ helper macro for strong typing @param type @return */ #define ODPH_HANDLE_T(type) struct _##type { uint8_t unused_dummy_var; } *type #else #define odph_handle_t struct { uint8_t unused_dummy_var; } * -/** C/C++ helper macro for strong typing */ +/** @internal C helper macro for strong typing @param type @return */ #define ODPH_HANDLE_T(type) odph_handle_t type #endif diff --git a/helper/include/odp/helper/table.h b/helper/include/odp/helper/table.h index 81022e55..be492381 100644 --- a/helper/include/odp/helper/table.h +++ b/helper/include/odp/helper/table.h @@ -89,7 +89,7 @@ extern "C" { #define ODPH_TABLE_NAME_LEN 32 #include -/** ODP table handle */ +/** @internal ODPH table handle @return */ typedef ODPH_HANDLE_T(odph_table_t); /** diff --git a/helper/include/odp/helper/tcp.h b/helper/include/odp/helper/tcp.h index cabef907..1c94af48 100644 --- a/helper/include/odp/helper/tcp.h +++ b/helper/include/odp/helper/tcp.h @@ -32,8 +32,9 @@ typedef struct ODP_PACKED { odp_u16be_t dst_port; /**< Destination port */ odp_u32be_t seq_no; /**< Sequence number */ odp_u32be_t ack_no; /**< Acknowledgment number */ + /** Variant mappings for TCP fields */ union { - odp_u16be_t doffset_flags; + odp_u16be_t doffset_flags; /**< dscp and offset mapping */ #if defined(ODP_BIG_ENDIAN_BITFIELD) struct { odp_u16be_t rsvd1:8; @@ -42,14 +43,14 @@ typedef struct ODP_PACKED { struct { odp_u16be_t hl:4; /**< Hdr len, in words */ odp_u16be_t rsvd3:4; /**< Reserved */ - odp_u16be_t cwr:1; - odp_u16be_t ece:1; - odp_u16be_t urg:1; - odp_u16be_t ack:1; - odp_u16be_t psh:1; - odp_u16be_t rst:1; - odp_u16be_t syn:1; - odp_u16be_t fin:1; + odp_u16be_t cwr:1; /**< cwr bit */ + odp_u16be_t ece:1; /**< ece bit */ + odp_u16be_t urg:1; /**< urg bit */ + odp_u16be_t ack:1; /**< ack bit */ + odp_u16be_t psh:1; /**< psh bit */ + odp_u16be_t rst:1; /**< rst bit */ + odp_u16be_t syn:1; /**< syn bit */ + odp_u16be_t fin:1; /**< fin bit */ }; #elif defined(ODP_LITTLE_ENDIAN_BITFIELD) struct { @@ -59,14 +60,14 @@ typedef struct ODP_PACKED { struct { odp_u16be_t rsvd3:4; /**< Reserved */ odp_u16be_t hl:4; /**< Hdr len, in words */ - odp_u16be_t fin:1; - odp_u16be_t syn:1; - odp_u16be_t rst:1; - odp_u16be_t psh:1; - odp_u16be_t ack:1; - odp_u16be_t urg:1; - odp_u16be_t ece:1; - odp_u16be_t cwr:1; + odp_u16be_t fin:1; /**< fin bit */ + odp_u16be_t syn:1; /**< syn bit */ + odp_u16be_t rst:1; /**< rst bit */ + odp_u16be_t psh:1; /**< psh bit */ + odp_u16be_t ack:1; /**< ack bit */ + odp_u16be_t urg:1; /**< urg bit */ + odp_u16be_t ece:1; /**< ece bit */ + odp_u16be_t cwr:1; /**< cwr bit */ }; #else