From patchwork Thu Apr 9 17:24:51 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lukasz Wojciechowski X-Patchwork-Id: 68065 X-Patchwork-Delegate: gakhil@marvell.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id B3209A0597; Thu, 9 Apr 2020 19:25:56 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 1C63A1D16B; Thu, 9 Apr 2020 19:25:37 +0200 (CEST) Received: from mailout1.w1.samsung.com (mailout1.w1.samsung.com [210.118.77.11]) by dpdk.org (Postfix) with ESMTP id 8D3291BF1B for ; Thu, 9 Apr 2020 19:25:31 +0200 (CEST) Received: from eucas1p1.samsung.com (unknown [182.198.249.206]) by mailout1.w1.samsung.com (KnoxPortal) with ESMTP id 20200409172531euoutp010a33c8a0b1dee7480ef66fe9d274e8c4~ENrezRGq80657706577euoutp01U for ; Thu, 9 Apr 2020 17:25:31 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 mailout1.w1.samsung.com 20200409172531euoutp010a33c8a0b1dee7480ef66fe9d274e8c4~ENrezRGq80657706577euoutp01U DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=samsung.com; s=mail20170921; t=1586453131; bh=0YWcS2qDaQ1h6nZKYypd2a8cIslnGFvrqlEK4e4zOo0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=srG1PvDF4mU1mdN8Kxt53j697SeSNRqjBQY+TSgpmDcibcPKxLsS5iAiFsn3qJ18x 0XSTqkkmlNJjmMcCf/erdqG24yzxGiksrY7oDE9QDMezP1TYUwEatnIxEF5DX+y9Yu Ok7uGeOt5M6a+fAVAnynYM8kvKduUB8SlyF8OQvw= Received: from eusmges3new.samsung.com (unknown [203.254.199.245]) by eucas1p2.samsung.com (KnoxPortal) with ESMTP id 20200409172531eucas1p20535b5dadb764a800291657244a5dd43~ENrel8Z6v2361523615eucas1p2E; Thu, 9 Apr 2020 17:25:31 +0000 (GMT) Received: from eucas1p1.samsung.com ( [182.198.249.206]) by eusmges3new.samsung.com (EUCPMTA) with SMTP id 23.71.60698.B8A5F8E5; Thu, 9 Apr 2020 18:25:31 +0100 (BST) Received: from eusmtrp1.samsung.com (unknown [182.198.249.138]) by eucas1p2.samsung.com (KnoxPortal) with ESMTPA id 20200409172530eucas1p27297a83a9d7508e3f8a8f88850cbe37c~ENreUAbDG0102501025eucas1p2j; Thu, 9 Apr 2020 17:25:30 +0000 (GMT) Received: from eusmgms2.samsung.com (unknown [182.198.249.180]) by eusmtrp1.samsung.com (KnoxPortal) with ESMTP id 20200409172530eusmtrp1661710d928334d6531f457af107608b3~ENreTXSqT2463624636eusmtrp1B; Thu, 9 Apr 2020 17:25:30 +0000 (GMT) X-AuditID: cbfec7f5-a0fff7000001ed1a-83-5e8f5a8beb05 Received: from eusmtip1.samsung.com ( [203.254.199.221]) by eusmgms2.samsung.com (EUCPMTA) with SMTP id 23.48.07950.A8A5F8E5; Thu, 9 Apr 2020 18:25:30 +0100 (BST) Received: from localhost.localdomain (unknown [106.210.88.70]) by eusmtip1.samsung.com (KnoxPortal) with ESMTPA id 20200409172530eusmtip1ce8939012396c4d7596df736f288f12b~ENrdlkzqV0696806968eusmtip1T; Thu, 9 Apr 2020 17:25:29 +0000 (GMT) From: Lukasz Wojciechowski To: Akhil Goyal , Declan Doherty , Boris Pismenny , Aviad Yehezkel , Radu Nicolau Cc: dev@dpdk.org, stable@dpdk.org Date: Thu, 9 Apr 2020 19:24:51 +0200 Message-Id: <20200409172502.1693-3-l.wojciechow@partner.samsung.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200409172502.1693-1-l.wojciechow@partner.samsung.com> X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFvrBIsWRmVeSWpSXmKPExsWy7djPc7rdUf1xBj+fs1qsPzOP0eLD5CWM Fsd+tLNbvHnQxGLx7tN2Jou2LgGLfx1/2B3YPX4tWMrqsXjPSyaPZ9MPM3lsfLeDKYAlissm JTUnsyy1SN8ugStj24OzjAVHeCrunF3K3sA4i6uLkZNDQsBE4n5vM3sXIxeHkMAKRokJU7aw QThfGCUWzrrCClIlJPCZUeLgQ1+YjufXFjFDFC1nlDi78SUThANU1LTkKCNIFZuArcSRmV9Z QRIiAicYJaZPXswEkmAWUJS4u/IrG4gtLOAq8evrHTCbRUBV4nZPN9g6XgEXiamN21gh1slL rN5wgBnE5gSqv3X8EthqCYHXbBLHn21khyhykbj56jgjhC0s8er4Fqi4jMTpyT0sEA3bGCWu /v7JCOHsZ5S43rsCqspa4vC/30BncACdpymxfpc+RNhRorPhFDNIWEKAT+LGW0GIB/gkJm2b DhXmlehoE4Ko1pN42jOVEWbtn7VPWCBsD4k98/ZBw/Qyo8Tau+fYJjDKz0JYtoCRcRWjeGpp cW56arFxXmq5XnFibnFpXrpecn7uJkZgejj97/jXHYz7/iQdYhTgYFTi4e1g6o8TYk0sK67M PcQowcGsJMLr3dQbJ8SbklhZlVqUH19UmpNafIhRmoNFSZzXeNHLWCGB9MSS1OzU1ILUIpgs EwenVAOjRWxc5XvOkxWbP/V67txu+/vj9H0XD+l9ucs260ioWUpy7U87SY7VP2IWBpxzs/aP jpa/uGW/37ZyyxvaO5ZmlHN/m1kiNUHxcN1PkT9lzcdVmFdzxEl3bQ7SM/fYptnc38n05Oqh kMnNdvPmVaTsn9On5x3NvLd48vSPYT5c4f4LVlls3dqmxFKckWioxVxUnAgAO2EJYwsDAAA= X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFrrGLMWRmVeSWpSXmKPExsVy+t/xu7pdUf1xBpfnaVmsPzOP0eLD5CWM Fsd+tLNbvHnQxGLx7tN2Jou2LgGLfx1/2B3YPX4tWMrqsXjPSyaPZ9MPM3lsfLeDKYAlSs+m KL+0JFUhI7+4xFYp2tDCSM/Q0kLPyMRSz9DYPNbKyFRJ384mJTUnsyy1SN8uQS9j24OzjAVH eCrunF3K3sA4i6uLkZNDQsBE4vm1RcxdjFwcQgJLGSX6r+1h6mLkAErISHy4JABRIyzx51oX G4gtJPCRUWJFiwSIzSZgK3Fk5ldWkF4RgTOMEmsvngHrZRZQlujbYgVSIyzgKvHr6x2wXhYB VYnbPd2sIDavgIvE1MZtrBDz5SVWbzjADGJzAtXfOn6JGWJXvcTtrj+MExj5FjAyrGIUSS0t zk3PLTbSK07MLS7NS9dLzs/dxAgM023Hfm7Zwdj1LvgQowAHoxIPrwFDf5wQa2JZcWXuIUYJ DmYlEV7vpt44Id6UxMqq1KL8+KLSnNTiQ4ymQEdNZJYSTc4HxlBeSbyhqaG5haWhubG5sZmF kjhvh8DBGCGB9MSS1OzU1ILUIpg+Jg5OqQbGKH81ff+NZ4tFC9c+Lp1orKxvd0JjaucOB89n x6JdeW77CUhNyv69bNHsOU/n8efwfVq5153Dy3mjgJhoNF9b4tLqOXts5nXsSGCavPgTY2XE h+szfi3YLcgoJbhrY2VIXgPbTuYf5xbqLlbqk2/Mt54myuVw40/rBpk6oYi1y0OdBGuk//Ao sRRnJBpqMRcVJwIAueDvHGkCAAA= X-CMS-MailID: 20200409172530eucas1p27297a83a9d7508e3f8a8f88850cbe37c X-Msg-Generator: CA X-RootMTR: 20200409172530eucas1p27297a83a9d7508e3f8a8f88850cbe37c X-EPHeader: CA CMS-TYPE: 201P X-CMS-RootMailID: 20200409172530eucas1p27297a83a9d7508e3f8a8f88850cbe37c References: <20200408031351.4288-1-l.wojciechow@partner.samsung.com> <20200409172502.1693-1-l.wojciechow@partner.samsung.com> Subject: [dpdk-dev] [PATCH v3 02/13] security: fix return types in documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Enhance returned values description for rte_security_session_destroy and some other minor description changes. Fixes: c261d1431bd8 ("security: introduce security API and framework") Cc: akhil.goyal@nxp.com Cc: stable@dpdk.org Signed-off-by: Lukasz Wojciechowski Acked-by: Anoob Joseph --- lib/librte_security/rte_security.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/lib/librte_security/rte_security.h b/lib/librte_security/rte_security.h index ef47118fa..747830d67 100644 --- a/lib/librte_security/rte_security.h +++ b/lib/librte_security/rte_security.h @@ -378,7 +378,7 @@ rte_security_session_create(struct rte_security_ctx *instance, * @param conf update configuration parameters * @return * - On success returns 0 - * - On failure return errno + * - On failure returns a negative errno value. */ __rte_experimental int @@ -403,12 +403,14 @@ rte_security_session_get_size(struct rte_security_ctx *instance); * return it to its original mempool. * * @param instance security instance - * @param sess security session to freed + * @param sess security session to be freed * * @return * - 0 if successful. - * - -EINVAL if session is NULL. + * - -EINVAL if session or context instance is NULL. * - -EBUSY if not all device private data has been freed. + * - -ENOTSUP if destroying private data is not supported. + * - other negative values in case of freeing private data errors. */ int rte_security_session_destroy(struct rte_security_ctx *instance,