diff mbox series

[API-NEXT,v3,1/1] api: ipsec: document restrictions for odp_ipsec_config()

Message ID 1506366006-24055-2-git-send-email-odpbot@yandex.ru
State New
Headers show
Series [API-NEXT,v3,1/1] api: ipsec: document restrictions for odp_ipsec_config() | expand

Commit Message

Github ODP bot Sept. 25, 2017, 7 p.m. UTC 
From: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org>


Signed-off-by: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org>

---
/** Email created from pull request 189 (lumag:ipsec-config-once)
 ** https://github.com/Linaro/odp/pull/189
 ** Patch: https://github.com/Linaro/odp/pull/189.patch
 ** Base sha: 13322ca632f8ffba292bec058e597719bc54142d
 ** Merge commit sha: f7dea710c1b600ae19b4446d51654c9ed05b6d0d
 **/
 include/odp/api/spec/ipsec.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/include/odp/api/spec/ipsec.h b/include/odp/api/spec/ipsec.h
index 5631989fc..3bd80b266 100644
--- a/include/odp/api/spec/ipsec.h
+++ b/include/odp/api/spec/ipsec.h
@@ -791,7 +791,9 @@  void odp_ipsec_config_init(odp_ipsec_config_t *config);
  *
  * Initialize and configure IPSEC offload with global configuration options.
  * This must be called before any SAs are created. Use odp_ipsec_capability()
- * to examine which features and modes are supported.
+ * to examine which features and modes are supported. This function must be
+ * called before creating the first SA with odp_ipsec_sa_create(). Calling this
+ * function multiple times results in undefined behaviour.
  *
  * @param config   Pointer to IPSEC configuration structure
  *