From patchwork Wed Feb 4 21:07:26 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 44388 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wi0-f197.google.com (mail-wi0-f197.google.com [209.85.212.197]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id A10D621173 for ; Wed, 4 Feb 2015 21:08:12 +0000 (UTC) Received: by mail-wi0-f197.google.com with SMTP id n3sf3908650wiv.0 for ; Wed, 04 Feb 2015 13:08:11 -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=B003piYWDlPJXpNbRKQdl79KtTQfelXD8CKK8ePxLVY=; b=gyWuSGU48iWNNCaloDXcbGQ8P0qVpPU0Epl0KFlYh2dVcitoly7x2naMSRjrRCqU5N ydQEKKwhZ4jgNGQnJcaFmSdZqnopry5aYh+BSND9WxORKcUEDjag7+NhwcXrQ+UwkPq+ 93po3W50o47C7XHIufCvxow6QwwxTJilaBle/RMWmIjsgilWJ4T4NhDJFpUvc7/bHXEB KQ8x2tZnPnXeiNkS30vi9Qb3EFq7bU9Zb42B6Vt+0foPbw6F18izXB5YcJIwk174iPcP XfXTHGZQ8XlVK0qZFJT4CwAUEaG0cCOCX4MYawmgcX1/IRLVK6ZptS2qH7lO+41p/wRb LshQ== X-Gm-Message-State: ALoCoQlsv3au7BC7VEyBfTlj1Eaan8xZQp02A3B5ZnsZfkeWhBC94MdT7UA5NgZlhubY+R/HnkVh X-Received: by 10.194.86.1 with SMTP id l1mr41561wjz.0.1423084091893; Wed, 04 Feb 2015 13:08:11 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.36.97 with SMTP id p1ls88962laj.4.gmail; Wed, 04 Feb 2015 13:08:11 -0800 (PST) X-Received: by 10.112.202.227 with SMTP id kl3mr216129lbc.81.1423084091731; Wed, 04 Feb 2015 13:08:11 -0800 (PST) Received: from mail-la0-f50.google.com (mail-la0-f50.google.com. [209.85.215.50]) by mx.google.com with ESMTPS id pf5si2403816lbc.94.2015.02.04.13.08.11 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 04 Feb 2015 13:08:11 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.50 as permitted sender) client-ip=209.85.215.50; Received: by mail-la0-f50.google.com with SMTP id hs14so3916136lab.9 for ; Wed, 04 Feb 2015 13:08:11 -0800 (PST) X-Received: by 10.112.140.74 with SMTP id re10mr324578lbb.80.1423084091647; Wed, 04 Feb 2015 13:08:11 -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 h5csp743854lbj; Wed, 4 Feb 2015 13:08:10 -0800 (PST) X-Received: by 10.229.1.72 with SMTP id 8mr700672qce.25.1423084090130; Wed, 04 Feb 2015 13:08:10 -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 u4si3414556qcm.43.2015.02.04.13.08.08 (version=TLSv1 cipher=RC4-SHA bits=128/128); Wed, 04 Feb 2015 13:08:10 -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 1YJ7B8-0006qM-LI; Wed, 04 Feb 2015 21:08:06 +0000 Received: from mail-la0-f41.google.com ([209.85.215.41]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YJ7Ap-0006ob-6E for lng-odp@lists.linaro.org; Wed, 04 Feb 2015 21:07:47 +0000 Received: by mail-la0-f41.google.com with SMTP id gm9so3954648lab.0 for ; Wed, 04 Feb 2015 13:07:41 -0800 (PST) X-Received: by 10.112.78.39 with SMTP id y7mr327454lbw.58.1423084061359; Wed, 04 Feb 2015 13:07:41 -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.40 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 04 Feb 2015 13:07:40 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Wed, 4 Feb 2015 22:07:26 +0100 Message-Id: <1423084051-12962-5-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: patch Subject: [lng-odp] [PATCHv6 4/9] api: odp_init.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.50 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/init.h | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/include/odp/api/init.h b/include/odp/api/init.h index 7353d0b..0ce82f8 100644 --- a/include/odp/api/init.h +++ b/include/odp/api/init.h @@ -67,8 +67,8 @@ typedef enum odp_log_level { * @param[in] level Log level * @param[in] fmt printf-style message format * - * @return The number of characters logged if succeeded. Otherwise returns - * a negative number. + * @return The number of characters logged on success + * @retval <0 on failure */ int odp_override_log(odp_log_level_e level, const char *fmt, ...); @@ -135,8 +135,8 @@ typedef struct odp_platform_init_t { * @param[in] platform_params Those parameters that are passed without * interpretation by the ODP API to the implementation. * - * @retval 0 if successful - * @retval -1 on failure + * @retval 0 on success + * @retval <0 on failure */ int odp_init_global(odp_init_t *params, odp_platform_init_t *platform_params); @@ -160,8 +160,8 @@ int odp_init_global(odp_init_t *params, odp_platform_init_t *platform_params); * @sa odp_init_global() * @sa odp_term_local() which must have been called prior to this. * - * @retval 0 if successful - * @retval -1 on failure + * @retval 0 on success + * @retval <0 on failure */ int odp_term_global(void); @@ -174,8 +174,8 @@ int odp_term_global(void); * @sa odp_term_local() * @sa odp_init_global() which must have been called prior to this. * - * @retval 0 if successful - * @retval -1 on failure + * @retval 0 on success + * @retval <0 on failure */ int odp_init_local(void); @@ -197,9 +197,9 @@ int odp_init_local(void); * @warning The unwinding of HW resources to allow them to be re used without reseting * the device is a complex task that the application is expected to coordinate. * - * @retval 1 if successful and more ODP thread exists - * @retval 0 if successful and it was the last ODP thread - * @retval -1 on failure + * @retval 1 on success and more ODP threads exist + * @retval 0 on success and it was the last ODP thread + * @retval <0 on failure */ int odp_term_local(void);