From: Nikhil Agarwal <[email protected]> IPSEC events may be delivered synchronous or ansynchrous depending on implementation. Application will know based on return value of odp_ipsec_sa_disable API.
Signed-off-by: Nikhil Agarwal <[email protected]> --- /** Email created from pull request 109 (NikhilA-Linaro:disable_event) ** https://github.com/Linaro/odp/pull/109 ** Patch: https://github.com/Linaro/odp/pull/109.patch ** Base sha: 8390f890d4bd2babb63a24f7b15d2f4763e44050 ** Merge commit sha: 0aaf1d8a11940deafd128c22b9620316de962e6a **/ include/odp/api/spec/ipsec.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/include/odp/api/spec/ipsec.h b/include/odp/api/spec/ipsec.h index 7085bc0d..3ad24eab 100644 --- a/include/odp/api/spec/ipsec.h +++ b/include/odp/api/spec/ipsec.h @@ -832,7 +832,7 @@ odp_ipsec_sa_t odp_ipsec_sa_create(const odp_ipsec_sa_param_t *param); * the SA and be processed successfully. * * When in synchronous operation mode, the call will return when it's possible - * to destroy the SA. In asynchronous mode, the same is indicated by an + * to destroy the SA. In asynchronous mode, the same may be indicated by an * ODP_EVENT_IPSEC_STATUS event sent to the queue specified for the SA. The * status event is guaranteed to be the last event for the SA, i.e. all * in-progress operations have completed and resulting events (including status @@ -840,7 +840,8 @@ odp_ipsec_sa_t odp_ipsec_sa_create(const odp_ipsec_sa_param_t *param); * * @param sa IPSEC SA to be disabled * - * @retval 0 On success + * @retval 0 When SA is disabled successfully. + * @retval 1 Disable event will be posted on SA queue. * @retval <0 On failure * * @see odp_ipsec_sa_destroy()
