Skip to content

Commit

Permalink
security: fix return types in documentation
Browse files Browse the repository at this point in the history
[ upstream commit 3139b95 ]

Enhance returned values description for rte_security_session_destroy
and some other minor description changes.

Fixes: c261d14 ("security: introduce security API and framework")

Signed-off-by: Lukasz Wojciechowski <l.wojciechow@partner.samsung.com>
Acked-by: Anoob Joseph <anoobj@marvell.com>
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
  • Loading branch information
lukaszwojciechowski authored and kevintraynor committed May 27, 2020
1 parent a50fdf6 commit d0819d0
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions lib/librte_security/rte_security.h
Expand Up @@ -342,7 +342,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.
*/
int __rte_experimental
rte_security_session_update(struct rte_security_ctx *instance,
Expand All @@ -366,12 +366,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,
Expand Down

0 comments on commit d0819d0

Please sign in to comment.