From patchwork Thu Sep 14 13:00:06 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Github ODP bot X-Patchwork-Id: 112558 Delivered-To: patch@linaro.org Received: by 10.140.106.117 with SMTP id d108csp715379qgf; Thu, 14 Sep 2017 06:01:23 -0700 (PDT) X-Google-Smtp-Source: AOwi7QCeo+uaUCTuNKS56hQHt8OGh2gwtZZy8jcKvsrneERM2tabVHFZjIblFz+n+7RY7T4Hg4lJ X-Received: by 10.237.37.182 with SMTP id x51mr30032563qtc.5.1505394083251; Thu, 14 Sep 2017 06:01:23 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1505394083; cv=none; d=google.com; s=arc-20160816; b=c7PW3aJMDJ/JHzSIhtG+cKXT75O9H1BPTE2VsOy6Lx+uiyHqhmBp70Frn5Zjll53sr DEp5uUtyx9Sw5vsWxlFVNKR6sUV2zH38qU9ct55m/Hhef/CMxulkC7v5Wm/EupMpzAto mQEsupW4nOIJy2lp5ghIkJNmJW5EcST1cX2wMNgkwWboTFz/eAQaI/O/RoWw8bwp2VSf 1BSOAKCawJmPeof3Q/v3gi+5Quunv4RBl+IEbpc2+hJc1xC2KizpZBxn/nshVclU/HIK 0EHInOqv3jrn5PLJoVTMmMMyuOgNPbGvojwyJjJYyJXp67zMkrtITJhpsAOHa36mKYZ4 NqvA== 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:github-pr-num :references:in-reply-to:message-id:date:to:from:delivered-to :arc-authentication-results; bh=MAw+8M2C+vPmFP6FlXPykd/bOtteVE7OZoiSwDs3psY=; b=P0xLh21xqZqmbCDrlxyTl3kw9u+7i+H/xIBGeON90K1jkI8gQb4enyiQzqs5WUxxSV XdrPr/MPbzS2oHq+2wL7vedznG8cHGJkbcXRnCHdQ/SPzgmNe+BFRmNwPiVOugLYtDac 8GephCjiVe8aVHg8JO3EnsPSx7x0HVxIUY2HfDN2IQikv5e6Erg+UHJySb58EiaIX0dm sZFsjUAFBf8VcyY3Eqv8FI/PNWqw4LWt83ebhooiSwLVf3CCZnozAzrayye0Z1OODp4s J7CPY+5alTcv+c2DGtzUbEaV4tUjybSFCBV9HFJZhIqGW2xBZVka0r6K1l8F7f43+PxY aEVA== 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=fail (p=NONE sp=NONE dis=NONE) header.from=yandex.ru Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id d39si2147522qtk.364.2017.09.14.06.01.22; Thu, 14 Sep 2017 06:01:23 -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=fail (p=NONE sp=NONE dis=NONE) header.from=yandex.ru Received: by lists.linaro.org (Postfix, from userid 109) id CA187609D1; Thu, 14 Sep 2017 13:01:22 +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,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,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 E79366095D; Thu, 14 Sep 2017 13:00:31 +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 129AE6093A; Thu, 14 Sep 2017 13:00:24 +0000 (UTC) Received: from forward105o.mail.yandex.net (forward105o.mail.yandex.net [37.140.190.183]) by lists.linaro.org (Postfix) with ESMTPS id 7B11560948 for ; Thu, 14 Sep 2017 13:00:15 +0000 (UTC) Received: from mxback6o.mail.yandex.net (mxback6o.mail.yandex.net [IPv6:2a02:6b8:0:1a2d::20]) by forward105o.mail.yandex.net (Yandex) with ESMTP id CA4FA4445B18 for ; Thu, 14 Sep 2017 16:00:13 +0300 (MSK) Received: from smtp1o.mail.yandex.net (smtp1o.mail.yandex.net [2a02:6b8:0:1a2d::25]) by mxback6o.mail.yandex.net (nwsmtp/Yandex) with ESMTP id QJDGbDVbDS-0D70GWEU; Thu, 14 Sep 2017 16:00:13 +0300 Received: by smtp1o.mail.yandex.net (nwsmtp/Yandex) with ESMTPSA id XwsxOaHcfE-0Cpem3GN; Thu, 14 Sep 2017 16:00:12 +0300 (using TLSv1.2 with cipher ECDHE-RSA-AES128-SHA256 (128/128 bits)) (Client certificate not present) From: Github ODP bot To: lng-odp@lists.linaro.org Date: Thu, 14 Sep 2017 16:00:06 +0300 Message-Id: <1505394006-5510-2-git-send-email-odpbot@yandex.ru> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1505394006-5510-1-git-send-email-odpbot@yandex.ru> References: <1505394006-5510-1-git-send-email-odpbot@yandex.ru> Github-pr-num: 177 Subject: [lng-odp] [PATCH API-NEXT v1 1/1] api: timer: refine timer pool param 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" From: Petri Savolainen Specify explicitly what each timer pool parameter means. This does not change the intended use of the parameters. Signed-off-by: Petri Savolainen --- /** Email created from pull request 177 (psavol:next-timer-min-tmo) ** https://github.com/Linaro/odp/pull/177 ** Patch: https://github.com/Linaro/odp/pull/177.patch ** Base sha: 6b6253c30f88c80bf632436ff06c1b000860a2f1 ** Merge commit sha: 32ea46150ca537c8d97433ee4af826ccbe965434 **/ include/odp/api/spec/timer.h | 36 ++++++++++++++++++++++++++++++------ 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/include/odp/api/spec/timer.h b/include/odp/api/spec/timer.h index b76f5654..17daafc7 100644 --- a/include/odp/api/spec/timer.h +++ b/include/odp/api/spec/timer.h @@ -99,12 +99,36 @@ typedef enum { * Timer pool parameters are used when creating and querying timer pools. */ typedef struct { - uint64_t res_ns; /**< Timeout resolution in nanoseconds */ - uint64_t min_tmo; /**< Minimum relative timeout in nanoseconds */ - uint64_t max_tmo; /**< Maximum relative timeout in nanoseconds */ - uint32_t num_timers; /**< (Minimum) number of supported timers */ - int priv; /**< Shared (false) or private (true) timer pool */ - odp_timer_clk_src_t clk_src; /**< Clock source for timers */ + /** Timeout resolution in nanoseconds. Timer pool must serve timeouts + * with this or higher resolution. The minimum valid value (highest + * resolution) is defined by timer capability 'highest_res_ns'. */ + uint64_t res_ns; + + /** Minimum relative timeout in nanoseconds. All requested timeouts + * will be at least this many nanoseconds after the current + * time of the timer pool. Timer set functions return an error, if too + * short timeout was requested. The value may be also less than + * 'res_ns'. */ + uint64_t min_tmo; + + /** Maximum relative timeout in nanoseconds. All requested timeouts + * will be at most this many nanoseconds after the current + * time of the timer pool. Timer set functions return an error, if too + * long timeout was requested. */ + uint64_t max_tmo; + + /** Number of timers needed. Application will create in maximum this + * many concurrent timers from the timer pool. */ + uint32_t num_timers; + + /** Thread private timer pool. When zero, multiple thread may use the + * timer pool concurrently. When non-zero, only single thread uses the + * timer pool (concurrently). */ + int priv; + + /** Clock source for timers */ + odp_timer_clk_src_t clk_src; + } odp_timer_pool_param_t; /**