From patchwork Thu Jan 29 10:39:55 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ola Liljedahl X-Patchwork-Id: 43905 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f199.google.com (mail-lb0-f199.google.com [209.85.217.199]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id D0B6924119 for ; Thu, 29 Jan 2015 10:40:46 +0000 (UTC) Received: by mail-lb0-f199.google.com with SMTP id f15sf17970729lbj.2 for ; Thu, 29 Jan 2015 02:40:45 -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=Sa0FM9/MzpURWPF4+jb9DP/nstsJgeRYirWc2bAbkLs=; b=mqzGSiBpYMlrisTURXCsxl18QnVRFUwVbtqwhXCC+V9wbBO82eF7am44NsvLlvS9Bz psnp05kAIMkBS3auJD6c/jPFQcmbwQsKnVuOQxqSbxo4UzimH3MIguERYYfDxhNDK96J xFbjqa7AKYpQNQyWVBMzEkxFsWgT8z55QvU9PAL2pxOyeIHymIiJid4oV+Pe1mtIF396 67a9KrbE/gNB6UUKf8aGZ/dVHGzPuDuwMqthynsyfr7tD5I822WTkHBp2aTJVJiUf5bU 0m6TzdzkCA/b6esId9O/Fm/ueWEASbQ7qgRQMA1JEFKBbhEYqH/5wjKKGooq6JygBpuF WIyA== X-Gm-Message-State: ALoCoQkg0hwL8RVVTDZk3gD3JQakQGJ653IgmXhfJL8BS+l0Qu/bXrIvCMCQjI2RPxk3MQOuw1TQ X-Received: by 10.112.154.233 with SMTP id vr9mr1703603lbb.9.1422528045836; Thu, 29 Jan 2015 02:40:45 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.29.133 with SMTP id k5ls260613lah.48.gmail; Thu, 29 Jan 2015 02:40:45 -0800 (PST) X-Received: by 10.152.5.38 with SMTP id p6mr13354444lap.91.1422528045626; Thu, 29 Jan 2015 02:40:45 -0800 (PST) Received: from mail-lb0-f173.google.com (mail-lb0-f173.google.com. [209.85.217.173]) by mx.google.com with ESMTPS id zm10si6937668lbb.137.2015.01.29.02.40.45 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Thu, 29 Jan 2015 02:40:45 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.173 as permitted sender) client-ip=209.85.217.173; Received: by mail-lb0-f173.google.com with SMTP id p9so26623889lbv.4 for ; Thu, 29 Jan 2015 02:40:45 -0800 (PST) X-Received: by 10.112.41.234 with SMTP id i10mr212481lbl.25.1422528045522; Thu, 29 Jan 2015 02:40:45 -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 h5csp1719437lbj; Thu, 29 Jan 2015 02:40:44 -0800 (PST) X-Received: by 10.140.21.229 with SMTP id 92mr19812qgl.33.1422528044254; Thu, 29 Jan 2015 02:40:44 -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 l18si9784576qab.22.2015.01.29.02.40.42 (version=TLSv1 cipher=RC4-SHA bits=128/128); Thu, 29 Jan 2015 02:40:44 -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 1YGmWf-0007Ku-Gt; Thu, 29 Jan 2015 10:40:41 +0000 Received: from mail-lb0-f169.google.com ([209.85.217.169]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YGmWJ-0007Ie-3G for lng-odp@lists.linaro.org; Thu, 29 Jan 2015 10:40:19 +0000 Received: by mail-lb0-f169.google.com with SMTP id f15so26584509lbj.0 for ; Thu, 29 Jan 2015 02:40:13 -0800 (PST) X-Received: by 10.112.135.99 with SMTP id pr3mr13420313lbb.61.1422528013566; Thu, 29 Jan 2015 02:40:13 -0800 (PST) Received: from macmini.lan (78-82-118-111.tn.glocalnet.net. [78.82.118.111]) by mx.google.com with ESMTPSA id y11sm2037670lba.5.2015.01.29.02.40.12 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 29 Jan 2015 02:40:13 -0800 (PST) From: Ola Liljedahl To: lng-odp@lists.linaro.org Date: Thu, 29 Jan 2015 11:39:55 +0100 Message-Id: <1422528008-29845-4-git-send-email-ola.liljedahl@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1422528008-29845-1-git-send-email-ola.liljedahl@linaro.org> References: <1422528008-29845-1-git-send-email-ola.liljedahl@linaro.org> X-Topics: crypto patch Subject: [lng-odp] [PATCH 03/16] api: odp_crypto.h: 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.217.173 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 Updated doxygen descriptions, particularly the @return/@retval descriptions. No change of implementation necessary. Signed-off-by: Ola Liljedahl --- (This document/code contribution attached is provided under the terms of agreement LES-LTM-21309) platform/linux-generic/include/api/odp_crypto.h | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/platform/linux-generic/include/api/odp_crypto.h b/platform/linux-generic/include/api/odp_crypto.h index da6041c..ed51860 100644 --- a/platform/linux-generic/include/api/odp_crypto.h +++ b/platform/linux-generic/include/api/odp_crypto.h @@ -218,7 +218,8 @@ typedef struct odp_crypto_compl_status { * @param session Created session else ODP_CRYPTO_SESSION_INVALID * @param status Failure code if unsuccessful * - * @return 0 if successful else -1 + * @retval 0 on success + * @retval <0 on failure */ int odp_crypto_session_create(odp_crypto_session_params_t *params, @@ -242,7 +243,8 @@ odp_crypto_session_create(odp_crypto_session_params_t *params, * @param posted Pointer to return posted, TRUE for async operation * @param completion_event Event by which the operation results are delivered. * - * @return 0 if successful else -1 + * @retval 0 on success + * @retval <0 on failure */ int odp_crypto_operation(odp_crypto_op_params_t *params, @@ -281,7 +283,7 @@ odp_crypto_get_operation_compl_status(odp_event_t completion_event, * * @param completion_event Event containing operation results * - * @return Packet structure where data now resides + * @return Handle for packet where data now resides */ odp_packet_t odp_crypto_get_operation_compl_packet(odp_event_t completion_event); @@ -297,18 +299,20 @@ void * odp_crypto_get_operation_compl_ctx(odp_event_t completion_event); /** - * Generate random byte string + * Generate random byte data * - * @param buf Pointer to store result - * @param len Pointer to input length value as well as return value - * @param use_entropy Use entropy + * @param[out] buf Output buffer + * @param[in,out] bufsz Size of output buffer, updated with size of data + * actually written. + * @param use_entropy Use entropy * * @todo Define the implication of the use_entropy parameter * - * @return 0 if succesful + * @retval 0 on success and '*bufsz' updated with size of data written + * @retval <0 on failure */ int -odp_hw_random_get(uint8_t *buf, size_t *len, bool use_entropy); +odp_hw_random_get(uint8_t *buf, size_t *bufsz, bool use_entropy); /** * @}