diff options
| author | Janne Peltonen <janne.peltonen@nokia.com> | 2023-03-30 16:03:45 +0300 |
|---|---|---|
| committer | Matias Elo <matias.elo@nokia.com> | 2023-04-13 08:20:13 +0300 |
| commit | f16cfb0b059c27a70d8c5b4f0f6293f3c9a18037 (patch) | |
| tree | 44c70e62c97a3b23b3b6008302d07ba4c69a2166 /include/odp/api/spec/crypto.h | |
| parent | 0cad1d396a12982d38f7836f42984dd694ccc394 (diff) | |
api: crypto: clarify that parse flags are not affected
Mention explicitly that crypto operations do not affect parse flags in
packet metadata and thus odp_packet_has_error() cannot be used for checking
operation result.
This is already the intended behaviour and implied by the API text but
not currently fully checked by crypto validation tests.
Signed-off-by: Janne Peltonen <janne.peltonen@nokia.com>
Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com>
Reviewed-by: Anoob Joseph <anoobj@marvell.com>
Diffstat (limited to 'include/odp/api/spec/crypto.h')
| -rw-r--r-- | include/odp/api/spec/crypto.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/include/odp/api/spec/crypto.h b/include/odp/api/spec/crypto.h index a75f3be70..1c477336e 100644 --- a/include/odp/api/spec/crypto.h +++ b/include/odp/api/spec/crypto.h @@ -200,6 +200,11 @@ int odp_crypto_result(odp_crypto_packet_result_t *result, * Performs the SYNC cryptographic operations specified during session creation * on the packets. All arrays should be of num_pkt size. * + * Result of the crypto operation can be checked using odp_crypto_result(). + * Parse flags in packet metadata are not affected by the crypto operation. + * In particular, odp_packet_has_error() can not be used for checking if the + * crypto operation succeeded. + * * Use of the pkt_out parameter depends on the configured crypto operation * type as described below. * |