From patchwork Thu Mar 12 15:16:43 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lukasz Wojciechowski X-Patchwork-Id: 66593 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 61DCEA056D; Thu, 12 Mar 2020 16:18:00 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 61FF51C069; Thu, 12 Mar 2020 16:17:17 +0100 (CET) Received: from mailout2.w1.samsung.com (mailout2.w1.samsung.com [210.118.77.12]) by dpdk.org (Postfix) with ESMTP id EDC592BE6 for ; Thu, 12 Mar 2020 16:17:09 +0100 (CET) Received: from eucas1p1.samsung.com (unknown [182.198.249.206]) by mailout2.w1.samsung.com (KnoxPortal) with ESMTP id 20200312151708euoutp02133c5573c2474fa3c97aef0ed9f87874~7l3Z1LgWc2883228832euoutp02E for ; Thu, 12 Mar 2020 15:17:08 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 mailout2.w1.samsung.com 20200312151708euoutp02133c5573c2474fa3c97aef0ed9f87874~7l3Z1LgWc2883228832euoutp02E DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=samsung.com; s=mail20170921; t=1584026229; bh=UYs81vHk7L2HTFMlShroWqer0pBFWXMBvFVL12msEX0=; h=From:To:Subject:Date:In-Reply-To:References:From; b=DAnx7CHzYqvx2IlHf1BG0aJENOctbmJxXHgTdRRl0NSFpCb9JTda7F6Qn9RoorwFu qaHTGalJo73bXrf9oD35738hJ31HjyQucxttibsTGcAV1oVs7c8aRJgzMj50HHHvo9 yHiNGjpPxxPP1ddmTMqLJjJVn6LZL3VOCd4RCzp4= Received: from eusmges1new.samsung.com (unknown [203.254.199.242]) by eucas1p2.samsung.com (KnoxPortal) with ESMTP id 20200312151708eucas1p28be06cdcb04cfedc52290e3428cb6d4e~7l3ZrJQoq1665316653eucas1p2m for ; Thu, 12 Mar 2020 15:17:08 +0000 (GMT) Received: from eucas1p2.samsung.com ( [182.198.249.207]) by eusmges1new.samsung.com (EUCPMTA) with SMTP id 71.62.61286.4725A6E5; Thu, 12 Mar 2020 15:17:08 +0000 (GMT) Received: from eusmtrp2.samsung.com (unknown [182.198.249.139]) by eucas1p1.samsung.com (KnoxPortal) with ESMTPA id 20200312151708eucas1p12db7c8e402be03dd255d53114217dabd~7l3ZXeKnW1794017940eucas1p1Z for ; Thu, 12 Mar 2020 15:17:08 +0000 (GMT) Received: from eusmgms1.samsung.com (unknown [182.198.249.179]) by eusmtrp2.samsung.com (KnoxPortal) with ESMTP id 20200312151708eusmtrp278eff720880642a3b0606bd7d0f1f87e~7l3ZW7zeq1238412384eusmtrp2A for ; Thu, 12 Mar 2020 15:17:08 +0000 (GMT) X-AuditID: cbfec7f2-f0bff7000001ef66-b7-5e6a52741ccd Received: from eusmtip1.samsung.com ( [203.254.199.221]) by eusmgms1.samsung.com (EUCPMTA) with SMTP id 51.3F.08375.4725A6E5; Thu, 12 Mar 2020 15:17:08 +0000 (GMT) Received: from Padamandas.example.org (unknown [106.120.51.19]) by eusmtip1.samsung.com (KnoxPortal) with ESMTPA id 20200312151708eusmtip11a948de968a0dff7f5390a3e5c2d7964~7l3ZJJBGq1553915539eusmtip1N for ; Thu, 12 Mar 2020 15:17:08 +0000 (GMT) From: Lukasz Wojciechowski To: dev@dpdk.org Date: Thu, 12 Mar 2020 16:16:43 +0100 Message-Id: <20200312151654.7218-3-l.wojciechow@partner.samsung.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200312151654.7218-1-l.wojciechow@partner.samsung.com> X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFtrPIsWRmVeSWpSXmKPExsWy7djP87olQVlxBv37tCzefdrO5MDo8WvB UtYAxigum5TUnMyy1CJ9uwSujDuvnzIWNPBU/Ns4j7mB8RlnFyMnh4SAicShSdPZQGwhgRWM EivnhHQxcgHZ7UwSKydvZoVw2pgkFt+9xgTTseHHckaIxHJGicXTVzPDtWzs28sOUsUmYCtx ZOZXVhBbREBA4nPnYrAdwgKeElf/72YGsVkEVCWWvbzDAmLzCrhIPPv1kxFig7zE6g0HwGo4 BVwlbkx6DnaGhMAcNomfn7ZCFblItC3ZyQphC0u8Or6FHcKWkfi/cz4TREM/o8Tef2/ZIZwZ jBKrL8+CesJa4vC/30AncXAwC2hKrN+lDxF2lJiycy0jSFhCgE/ixltBkDAzkDlp23RmiDCv REebEES1nsTTnqmMMGv/rH3CAmF7SGz62wANFKCth77fY5vAKDcLYdkCRsZVjOKppcW56anF hnmp5XrFibnFpXnpesn5uZsYgdF6+t/xTzsYv15KOsQowMGoxMNrIJYVJ8SaWFZcmXuIUYKD WUmEN14+PU6INyWxsiq1KD++qDQntfgQozQHi5I4r/Gil7FCAumJJanZqakFqUUwWSYOTqkG xgXeu2KsjrFqOTtcS1wRaaiu4qZpcPG/erLfxvxFOjvnRlnc7HkVuu3A0aLY5CLDyh+Wnhqn JtTu2tLg2LB/olF/Klfpwhp+KfswS4PWPVmsbHZtJ0qqndK2LyoOywkuZ30TU/JOW4rvYc0L NcWv31Yfe+j478cF46DTK4KXXNw0w7rzstRmJZbijERDLeai4kQAFcAgltICAAA= X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFprHLMWRmVeSWpSXmKPExsVy+t/xu7olQVlxBv/fSVi8+7SdyYHR49eC pawBjFF6NkX5pSWpChn5xSW2StGGFkZ6hpYWekYmlnqGxuaxVkamSvp2NimpOZllqUX6dgl6 GXdeP2UsaOCp+LdxHnMD4zPOLkZODgkBE4kNP5YzdjFycQgJLGWU2LdgC5DDAZSQkfhwSQCi Rljiz7UuNhBbSKCVSaJjThWIzSZgK3Fk5ldWEFtEQEDic+disBphAU+Jq/93M4PYLAKqEste 3mEBsXkFXCSe/frJCDFTXmL1hgNgNZwCrhI3Jj1nhZjvIvH8/xLmCYy8CxgZVjGKpJYW56bn FhvqFSfmFpfmpesl5+duYgSGzbZjPzfvYLy0MfgQowAHoxIPr4FYVpwQa2JZcWXuIUYJDmYl Ed54+fQ4Id6UxMqq1KL8+KLSnNTiQ4ymQEdNZJYSTc4HhnReSbyhqaG5haWhubG5sZmFkjhv h8DBGCGB9MSS1OzU1ILUIpg+Jg5OqQZGi99KyV/y3TTtewQnlW/dGX14eSKbIJfYCse/Gmv6 XzlxKGhOuH1nlYKqytXDqS6H6w9IxHAoTPfkaWsInPBxsqI9gwbjr+oXQoaSL7/a6p97ZO36 quKZDu9kDtb2/9cVWFXCgjVfO+edqNjE0RFuUJs2i1W8Yin78Tkr2k9sPPnAS0okwVGJpTgj 0VCLuag4EQBaiZ79MQIAAA== X-CMS-MailID: 20200312151708eucas1p12db7c8e402be03dd255d53114217dabd X-Msg-Generator: CA X-RootMTR: 20200312151708eucas1p12db7c8e402be03dd255d53114217dabd X-EPHeader: CA CMS-TYPE: 201P X-CMS-RootMailID: 20200312151708eucas1p12db7c8e402be03dd255d53114217dabd References: <20200312151654.7218-1-l.wojciechow@partner.samsung.com> Subject: [dpdk-dev] [PATCH 02/13] librte_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. Signed-off-by: Lukasz Wojciechowski Change-Id: Ic18ee9e76507f8888da1a0921b3a2a914a2434d2 --- 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,