From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id D0D9AA0597; Wed, 8 Apr 2020 05:14:50 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id B357B1BF68; Wed, 8 Apr 2020 05:14:50 +0200 (CEST) Received: from mailout2.w1.samsung.com (mailout2.w1.samsung.com [210.118.77.12]) by dpdk.org (Postfix) with ESMTP id 73F171BF4F for ; Wed, 8 Apr 2020 05:14:49 +0200 (CEST) Received: from eucas1p2.samsung.com (unknown [182.198.249.207]) by mailout2.w1.samsung.com (KnoxPortal) with ESMTP id 20200408031448euoutp020f406a5a37d3384eaa1a5d53c144960c~DubbjFCOa2216822168euoutp02C for ; Wed, 8 Apr 2020 03:14:48 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 mailout2.w1.samsung.com 20200408031448euoutp020f406a5a37d3384eaa1a5d53c144960c~DubbjFCOa2216822168euoutp02C DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=samsung.com; s=mail20170921; t=1586315688; bh=0YWcS2qDaQ1h6nZKYypd2a8cIslnGFvrqlEK4e4zOo0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=iZZDKy5wTtdpvWu5wRZeG/68TGpitS/RMCbc4nk+3FW9C9r6LRRdAWT45i2wytWBm o6HVNF9phhqPD5ix/dBbsTRBSdtRGkRBIAx+8h5KiQzxNPg4rUn/QTxvlI4rzpSEEp W5WcI2eUaM+U/Oq+1Um78QZzIgWKHeFUVDtfsqsE= Received: from eusmges2new.samsung.com (unknown [203.254.199.244]) by eucas1p2.samsung.com (KnoxPortal) with ESMTP id 20200408031448eucas1p22a7b59b647c4d72688fe1c2e5147e6b5~DubbHbPlR3007630076eucas1p2m; Wed, 8 Apr 2020 03:14:48 +0000 (GMT) Received: from eucas1p1.samsung.com ( [182.198.249.206]) by eusmges2new.samsung.com (EUCPMTA) with SMTP id 79.47.60679.8A14D8E5; Wed, 8 Apr 2020 04:14:48 +0100 (BST) Received: from eusmtrp1.samsung.com (unknown [182.198.249.138]) by eucas1p2.samsung.com (KnoxPortal) with ESMTPA id 20200408031448eucas1p2b36997fc73f5b5e2aadb6e4bb965063b~DubavevPR3010930109eucas1p2f; Wed, 8 Apr 2020 03:14:48 +0000 (GMT) Received: from eusmgms2.samsung.com (unknown [182.198.249.180]) by eusmtrp1.samsung.com (KnoxPortal) with ESMTP id 20200408031448eusmtrp1d233b60bdb978746c8da787083a23a75~Dubau5Ghg1153511535eusmtrp1s; Wed, 8 Apr 2020 03:14:48 +0000 (GMT) X-AuditID: cbfec7f4-0e5ff7000001ed07-59-5e8d41a8b5a8 Received: from eusmtip1.samsung.com ( [203.254.199.221]) by eusmgms2.samsung.com (EUCPMTA) with SMTP id EE.69.07950.7A14D8E5; Wed, 8 Apr 2020 04:14:47 +0100 (BST) Received: from localhost.localdomain (unknown [106.210.88.70]) by eusmtip1.samsung.com (KnoxPortal) with ESMTPA id 20200408031447eusmtip1f23b69fbcdb1d9ccab61a8f17fea714c~DubaE0oDM2966429664eusmtip1Z; Wed, 8 Apr 2020 03:14:47 +0000 (GMT) From: Lukasz Wojciechowski To: Akhil Goyal , Declan Doherty , Aviad Yehezkel , Boris Pismenny , Radu Nicolau Cc: dev@dpdk.org, stable@dpdk.org Date: Wed, 8 Apr 2020 05:13:40 +0200 Message-Id: <20200408031351.4288-3-l.wojciechow@partner.samsung.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200408031351.4288-1-l.wojciechow@partner.samsung.com> X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFvrOIsWRmVeSWpSXmKPExsWy7djPc7orHHvjDL69kLRYf2Yeo8WHyUsY LY79aGe3ePOgicXi3aftTBZtXQIW/zr+sDuwe/xasJTVY/Gel0wez6YfZvLY+G4HUwBLFJdN SmpOZllqkb5dAlfGtgdnGQuO8FTcObuUvYFxFlcXIyeHhICJxOMrq9i6GLk4hARWMEo0X+xj gnC+MEpcmDKFHcL5zCixd8d7NpiWn8cmM0MkljNKdC4+glD1/2w7C0gVm4CtxJGZX1lBEiIC Jxglrvf+ZwVJMAsoStxd+RVslLCAq8TqldsZuxg5OFgEVCUObHACCfMKuEjsnb6JHWKbvMTq DQeYQUo4gcp3n+UCGSkh8JpNYu7XJVAXuUjM+fuRCcIWlnh1fAtUr4zE6ck9LBAN2xglrv7+ yQjh7Ac5aAVUlbXE4X+/2UA2MAtoSqzfpQ8RdpS4+PogC0hYQoBP4sZbQYjz+SQmbZvODBHm lehoE4Ko1pN42jOVEWbtn7VPWCBsD4nzN7ayQsLnMqPE8XfLGCcwys9CWLaAkXEVo3hqaXFu emqxUV5quV5xYm5xaV66XnJ+7iZGYHI4/e/4lx2Mu/4kHWIU4GBU4uF9kNgTJ8SaWFZcmXuI UYKDWUmEV6q3M06INyWxsiq1KD++qDQntfgQozQHi5I4r/Gil7FCAumJJanZqakFqUUwWSYO TqkGRsE8/zmVIbyP1rEozvd6ujLm3NRr9Vzf/P6fPp41O07DdKLk/E53o1dedttttvMurHkQ W7azcVPDpIK1LJrCC5U/CqtfT5JYVK1zY8Xu73zF/BuX+guK7ngqHbrlT9d26bN/E14pZ8Zc 5Nukweezv7CBkVcqcEp/0RXFns5Z5ZWhIqxzi5h0lViKMxINtZiLihMBBphPXwoDAAA= X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFrrKLMWRmVeSWpSXmKPExsVy+t/xu7rLHXvjDOZfsLFYf2Yeo8WHyUsY LY79aGe3ePOgicXi3aftTBZtXQIW/zr+sDuwe/xasJTVY/Gel0wez6YfZvLY+G4HUwBLlJ5N UX5pSapCRn5xia1StKGFkZ6hpYWekYmlnqGxeayVkamSvp1NSmpOZllqkb5dgl7GtgdnGQuO 8FTcObuUvYFxFlcXIyeHhICJxM9jk5m7GLk4hASWMkpcXPCYpYuRAyghI/HhkgBEjbDEn2td bBA1HxklFjd+ZgJJsAnYShyZ+ZUVJCEicAao+dk1NpBmZgFlib4tViA1wgKuEqtXbmcECbMI qEoc2OAEEuYVcJHYO30TO8R8eYnVGw4wg5RwApXvPgt2mpBAvcThu5fZJjDyLWBkWMUoklpa nJueW2ykV5yYW1yal66XnJ+7iREYpNuO/dyyg7HrXfAhRgEORiUe3geJPXFCrIllxZW5hxgl OJiVRHilejvjhHhTEiurUovy44tKc1KLDzGaAp00kVlKNDkfGEF5JfGGpobmFpaG5sbmxmYW SuK8HQIHY4QE0hNLUrNTUwtSi2D6mDg4pRoYe9q/JM55t+NM1KLz16JvmDCXF/FeCjGw6pDJ /FBqqecWpPn2z/241gWL1y8/L2+/6d7X5VfXbT6/h3/XNLZnr6+cFmzf/dMhk3Vv4rUfU2w2 aQiFzJuT///c4Su2DEoVhsxzHI7v3DHhiWZQAheL9YeFfUv0TERvhD98to/b98i6WZFGG3uZ nJRYijMSDbWYi4oTAVvITntoAgAA X-CMS-MailID: 20200408031448eucas1p2b36997fc73f5b5e2aadb6e4bb965063b X-Msg-Generator: CA Content-Type: text/plain; charset="utf-8" X-RootMTR: 20200408031448eucas1p2b36997fc73f5b5e2aadb6e4bb965063b X-EPHeader: CA CMS-TYPE: 201P X-CMS-RootMailID: 20200408031448eucas1p2b36997fc73f5b5e2aadb6e4bb965063b References: <20200312151654.7218-1-l.wojciechow@partner.samsung.com> <20200408031351.4288-1-l.wojciechow@partner.samsung.com> Subject: [dpdk-dev] [PATCH v2 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 --- 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, -- 2.17.1