[PATCH] cryptodev: clarify error codes returned
Thomas Monjalon
thomas at monjalon.net
Sun Jun 11 12:05:29 CEST 2023
24/04/2023 11:19, Anoob Joseph:
> When symmetric sessions are created, it may fail due to non-critical
> errors. When PMD doesn't support the specific combination that
> application requested, it can return -ENOTSUP which can be handled so in
> application. The API is already setting rte_errno according to the
> reason of the failure. Clarifying this in the spec to list down possible
> error codes.
>
> Fixes: bdce2564dbf7 ("cryptodev: rework session framework")
>
> Signed-off-by: Anoob Joseph <anoobj at marvell.com>
[...]
> * @return
> * - On success return pointer to sym-session.
> - * - On failure returns NULL.
> + * - On failure returns NULL and rte_errno is set to the error code.
> + * EINVAL on invalid arguments.
> + * ENOMEM on memory error for session allocation.
> + * ENOTSUP if device doesn't support session configuration.
If you don't make bullets, all lines are rendered on the same line, without any separator:
"
Returns
On success return pointer to sym-session.
On failure returns NULL and rte_errno is set to the error code. EINVAL on invalid arguments. ENOMEM on memory error for session allocation. ENOTSUP if device doesn't support session configuration.
"
In general, you must check the HTML rendering of the doc changes.
I am fixing while pulling.
More information about the dev
mailing list