From patchwork Wed Feb 4 21:07:29 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 44391 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wi0-f199.google.com (mail-wi0-f199.google.com [209.85.212.199]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 1E3A721173 for ; Wed, 4 Feb 2015 21:08:25 +0000 (UTC) Received: by mail-wi0-f199.google.com with SMTP id r20sf3894409wiv.2 for ; Wed, 04 Feb 2015 13:08:24 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:from:to:date:message-id:in-reply-to :references:subject:precedence:list-id:list-unsubscribe:list-archive :list-post:list-help:list-subscribe:mime-version:content-type :content-transfer-encoding:errors-to:sender:x-original-sender :x-original-authentication-results:mailing-list; bh=fssgpPovea59ciTPYp9k6jZg+MqSufU+t788m2W7W14=; b=X7VvHLwCZaBfvf7svDOicqzaoKzzw69ENydDXLl2ooDf9Unb0urH8AgMfDiAVq0psb ktGM0D6DxAyxGmHenhQywxNhun1hMIwgKxJU8HatHsrUyvdvs/w+XfTKI8aMLZtKM3rL +FRrFgJaxSUbbYxfLtcqxKJq9jOMObAbSypzgh9ayb+ategWXwgPZBoP4zRa2hZOpM5V S82X0KmTETtfcNWGbBKHXcaVWHb3/nOpi7SRUPzNDJ95pfmYXGIFeczgTi98LT0f+6z+ uLSups6G+KtX+yNzwTICEoHnnvIrSq7kuNIurv203h9E8TkO+u5mo5cETeAmzOyDGinF aCHQ== X-Gm-Message-State: ALoCoQm4VHc1s0Cid1kU2M+51Yk19j7Q8RnlRo/WX2W8mBPM+MjGntDhAhaJ1xufjYaUboPGIS6L X-Received: by 10.112.124.142 with SMTP id mi14mr35560lbb.1.1423084104324; Wed, 04 Feb 2015 13:08:24 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.5.38 with SMTP id p6ls99675lap.49.gmail; Wed, 04 Feb 2015 13:08:24 -0800 (PST) X-Received: by 10.152.8.104 with SMTP id q8mr355975laa.56.1423084104149; Wed, 04 Feb 2015 13:08:24 -0800 (PST) Received: from mail-la0-f47.google.com (mail-la0-f47.google.com. [209.85.215.47]) by mx.google.com with ESMTPS id zy1si2466367lbb.12.2015.02.04.13.08.24 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 04 Feb 2015 13:08:24 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.47 as permitted sender) client-ip=209.85.215.47; Received: by mail-la0-f47.google.com with SMTP id hz20so3911644lab.6 for ; Wed, 04 Feb 2015 13:08:24 -0800 (PST) X-Received: by 10.112.173.202 with SMTP id bm10mr385215lbc.24.1423084104057; Wed, 04 Feb 2015 13:08:24 -0800 (PST) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.35.133 with SMTP id h5csp743956lbj; Wed, 4 Feb 2015 13:08:23 -0800 (PST) X-Received: by 10.170.35.21 with SMTP id 21mr68702ykd.59.1423084102163; Wed, 04 Feb 2015 13:08:22 -0800 (PST) Received: from ip-10-35-177-41.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id hd10si3460788qcb.6.2015.02.04.13.08.20 (version=TLSv1 cipher=RC4-SHA bits=128/128); Wed, 04 Feb 2015 13:08:22 -0800 (PST) Received-SPF: none (google.com: lng-odp-bounces@lists.linaro.org does not designate permitted sender hosts) client-ip=54.225.227.206; Received: from localhost ([127.0.0.1] helo=ip-10-35-177-41.ec2.internal) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YJ7BK-0006uD-Vu; Wed, 04 Feb 2015 21:08:19 +0000 Received: from mail-la0-f45.google.com ([209.85.215.45]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YJ7As-0006oq-46 for lng-odp@lists.linaro.org; Wed, 04 Feb 2015 21:07:50 +0000 Received: by mail-la0-f45.google.com with SMTP id gd6so3935459lab.4 for ; Wed, 04 Feb 2015 13:07:44 -0800 (PST) X-Received: by 10.112.224.133 with SMTP id rc5mr264452lbc.31.1423084064525; Wed, 04 Feb 2015 13:07:44 -0800 (PST) Received: from macmini.lan (78-82-118-111.tn.glocalnet.net. [78.82.118.111]) by mx.google.com with ESMTPSA id r7sm567954lbs.37.2015.02.04.13.07.43 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 04 Feb 2015 13:07:43 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Wed, 4 Feb 2015 22:07:29 +0100 Message-Id: <1423084051-12962-8-git-send-email-ola.liljedahl@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1423084051-12962-1-git-send-email-ola.liljedahl@linaro.org> References: <1423084051-12962-1-git-send-email-ola.liljedahl@linaro.org> X-Topics: timers patch Subject: [lng-odp] [PATCHv6 7/9] api: odp_timer.h: updated return descriptions X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: lng-odp-bounces@lists.linaro.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: ola.liljedahl@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.47 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 Signed-off-by: Ola Liljedahl --- (This document/code contribution attached is provided under the terms of agreement LES-LTM-21309) include/odp/api/timer.h | 38 +++++++++----------------------------- 1 file changed, 9 insertions(+), 29 deletions(-) diff --git a/include/odp/api/timer.h b/include/odp/api/timer.h index 13cd370..b0992d0 100644 --- a/include/odp/api/timer.h +++ b/include/odp/api/timer.h @@ -110,8 +110,8 @@ typedef struct { * @param name Name of the timer pool. The string will be copied. * @param params Timer pool parameters. The content will be copied. * - * @return Timer pool handle if successful, otherwise ODP_TIMER_POOL_INVALID - * and errno set + * @return Timer pool handle on success + * @retval ODP_TIMER_POOL_INVALID on failure and errno set */ odp_timer_pool_t odp_timer_pool_create(const char *name, @@ -183,8 +183,8 @@ typedef struct { * @param tpid Timer pool identifier * @param[out] info Pointer to information buffer * - * @retval 0 Success - * @retval -1 Failure. Info could not be retrieved. + * @retval 0 on success + * @retval <0 on failure. Info could not be retrieved. */ int odp_timer_pool_info(odp_timer_pool_t tpid, odp_timer_pool_info_t *info); @@ -200,8 +200,8 @@ int odp_timer_pool_info(odp_timer_pool_t tpid, * @param queue Destination queue for timeout notifications * @param user_ptr User defined pointer or NULL to be copied to timeouts * - * @return Timer handle if successful, otherwise ODP_TIMER_INVALID and - * errno set. + * @return Timer handle on success + * @retval ODP_TIMER_INVALID on failure and errno set. */ odp_timer_t odp_timer_alloc(odp_timer_pool_t tpid, odp_queue_t queue, @@ -216,7 +216,8 @@ odp_timer_t odp_timer_alloc(odp_timer_pool_t tpid, * responsibility of the application to handle this timeout when it is received. * * @param tim Timer handle - * @return Event handle of timeout event or ODP_EVENT_INVALID + * @return Event handle of timeout event + * @retval ODP_EVENT_INVALID on failure */ odp_event_t odp_timer_free(odp_timer_t tim); @@ -226,9 +227,6 @@ odp_event_t odp_timer_free(odp_timer_t tim); * Set (arm) the timer to expire at specific time. The timeout * event will be enqueued when the timer expires. * - * Note: any invalid parameters will be treated as programming errors and will - * cause the application to abort. - * * @param tim Timer * @param abs_tck Expiration time in absolute timer ticks * @param[in,out] tmo_ev Reference to an event variable that points to @@ -253,9 +251,6 @@ int odp_timer_set_abs(odp_timer_t tim, * * Set (arm) the timer to expire at a relative future time. * - * Note: any invalid parameters will be treated as programming errors and will - * cause the application to abort. - * * @param tim Timer * @param rel_tck Expiration time in timer ticks relative to current time of * the timer pool the timer belongs to @@ -285,22 +280,16 @@ int odp_timer_set_rel(odp_timer_t tim, * A timer that has already expired may be impossible to cancel and the timeout * will instead be delivered to the destination queue. * - * Note: any invalid parameters will be treated as programming errors and will - * cause the application to abort. - * * @param tim Timer * @param[out] tmo_ev Pointer to an event variable * @retval 0 Success, active timer cancelled, timeout returned in '*tmo_ev' - * @retval -1 Failure, timer already expired (or inactive) + * @retval <0 on failure (timer inactive or already expired) */ int odp_timer_cancel(odp_timer_t tim, odp_event_t *tmo_ev); /** * Return timeout handle that is associated with timeout event * - * Note: any invalid parameters will cause undefined behavior and may cause - * the application to abort or crash. - * * @param ev An event of type ODP_EVENT_TIMEOUT * * @return timeout handle @@ -330,9 +319,6 @@ int odp_timeout_fresh(odp_timeout_t tmo); /** * Return timer handle for the timeout * - * Note: any invalid parameters will cause undefined behavior and may cause - * the application to abort or crash. - * * @param tmo Timeout handle * * @return Timer handle @@ -342,9 +328,6 @@ odp_timer_t odp_timeout_timer(odp_timeout_t tmo); /** * Return expiration tick for the timeout * - * Note: any invalid parameters will cause undefined behavior and may cause - * the application to abort or crash. - * * @param tmo Timeout handle * * @return Expiration tick @@ -355,9 +338,6 @@ uint64_t odp_timeout_tick(odp_timeout_t tmo); * Return user pointer for the timeout * The user pointer was specified when the timer was allocated. * - * Note: any invalid parameters will cause undefined behavior and may cause - * the application to abort or crash. - * * @param tmo Timeout handle * * @return User pointer