From patchwork Mon Aug 7 14:00:09 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: 109552 Delivered-To: patch@linaro.org Received: by 10.140.95.78 with SMTP id h72csp1641723qge; Mon, 7 Aug 2017 07:01:43 -0700 (PDT) X-Received: by 10.55.215.28 with SMTP id m28mr872453qki.318.1502114503750; Mon, 07 Aug 2017 07:01:43 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1502114503; cv=none; d=google.com; s=arc-20160816; b=xYZptutIsCFIhIKONa4s5YcxZ65RVlI27uybEImE/dmhFyixQIxObAXGFUumxIQZd/ +aFvrz7IWzn7atlz3UxD/xl4VqxorUCnbVyKK22sykvikPhwiK0NImJnOeaZSvVhXmR1 cUvDBRe6SwI08Zy1qQW4TzFSofdeA10jnMuEfQL6+5tFEcPlLENS97dxzYkU7XUuit3Z gLOc2Hm/1LwY8iV++TY1d0pishw9orjRZZmC6wiYGKURYcAQ433nBi5Ypbx724zG8O31 v5vwrIp/nj8TcCaeL/7Rxt+HVkhth/Z1zJhEjlO5xioAqOFWRRUuuUbATN8WcsWS+uhq S9Vg== 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=+w2GkrXdGfGmOqOvmFGsO8+oh5Nn7U1Rzlm58oqa4lo=; b=L+s9Isp244pANX2TnG5MaURBPo4jwa0UqJl71v6M/Mjaz49FTa5Our+8y1Dz3iw53K VUMESzEYgFKpNuKXdvDuLJ1cq4+A7qI5VNPwhXIgWXg8glVm2kJholjMjZb6il1Y5gjy VHSALgRStDNKdichh+VA2a8Q94UhSrKAnuOAKk6OBBNfkXiDUd7TXM2WhZfN2gijOHPy bHz4ZfGFwtDsdKMAc70K1OMsJ5axFFAUeS/nV/KxuDsvhFdTaGkDfqO2f0dn3dKbvn5s lVMKYO5Zv/SDLacK1UCa3kiPMZSAPqpG0Z2o+k97CyQ1jWJbOiKSpIJy5aPO484ML4PN oYsA== 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 j8si7100631qtb.37.2017.08.07.07.01.43; Mon, 07 Aug 2017 07:01:43 -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 3E87B60C2D; Mon, 7 Aug 2017 14:01:43 +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=-2.6 required=5.0 tests=BAYES_00,FREEMAIL_FROM, RCVD_IN_DNSWL_LOW,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 1359360DB8; Mon, 7 Aug 2017 14:00:42 +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 8C52960D85; Mon, 7 Aug 2017 14:00:29 +0000 (UTC) Received: from forward18o.cmail.yandex.net (forward18o.cmail.yandex.net [37.9.109.216]) by lists.linaro.org (Postfix) with ESMTPS id 4C75160D3A for ; Mon, 7 Aug 2017 14:00:24 +0000 (UTC) Received: from mxback19j.mail.yandex.net (mxback19j.mail.yandex.net [IPv6:2a02:6b8:0:1619::95]) by forward18o.cmail.yandex.net (Yandex) with ESMTP id D54D6228FF for ; Mon, 7 Aug 2017 17:00:22 +0300 (MSK) Received: from smtp4p.mail.yandex.net (smtp4p.mail.yandex.net [2a02:6b8:0:1402::15:6]) by mxback19j.mail.yandex.net (nwsmtp/Yandex) with ESMTP id 0d8xnZn03Q-0Mnu5dig; Mon, 07 Aug 2017 17:00:22 +0300 Received: by smtp4p.mail.yandex.net (nwsmtp/Yandex) with ESMTPSA id jYzLwXN8Yl-0LwGnLr9; Mon, 07 Aug 2017 17:00:22 +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: Mon, 7 Aug 2017 17:00:09 +0300 Message-Id: <1502114410-25867-2-git-send-email-odpbot@yandex.ru> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1502114410-25867-1-git-send-email-odpbot@yandex.ru> References: <1502114410-25867-1-git-send-email-odpbot@yandex.ru> Github-pr-num: 95 Subject: [lng-odp] [PATCH API-NEXT v2 1/2] api: crypto: clarify for odp_crypto_session_create 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: Dmitry Eremin-Solenikov Signed-off-by: Dmitry Eremin-Solenikov --- /** Email created from pull request 95 (lumag:crypto-session-create) ** https://github.com/Linaro/odp/pull/95 ** Patch: https://github.com/Linaro/odp/pull/95.patch ** Base sha: 2394317ab247fa14b4e239aec512afee7eac4524 ** Merge commit sha: bc2a40cc94ced5ba8ec7b86fbdef99958ed37009 **/ include/odp/api/spec/crypto.h | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/include/odp/api/spec/crypto.h b/include/odp/api/spec/crypto.h index 6d4807c4..715ba9a5 100644 --- a/include/odp/api/spec/crypto.h +++ b/include/odp/api/spec/crypto.h @@ -647,11 +647,12 @@ int odp_crypto_auth_capability(odp_auth_alg_t auth, * * Create a crypto session according to the session parameters. Use * odp_crypto_session_param_init() to initialize parameters into their - * default values. + * default values. If call ends up with an error no new session will be + * created. * - * @param param Session parameters - * @param session Created session else ODP_CRYPTO_SESSION_INVALID - * @param status Failure code if unsuccessful + * @param param Session parameters + * @param[out] session Created session else ODP_CRYPTO_SESSION_INVALID + * @param[out] status Failure code if unsuccessful * * @retval 0 on success * @retval <0 on failure