doc: announce ABI change for security session
authorKonstantin Ananyev <konstantin.ananyev@intel.com>
Wed, 14 Nov 2018 11:23:31 +0000 (11:23 +0000)
committerThomas Monjalon <thomas@monjalon.net>
Sat, 24 Nov 2018 17:58:39 +0000 (18:58 +0100)
Add 'uint64_t opaque_data' inside struct rte_security_session.
That allows upper layer to easily associate some user defined
data with the session.
Proposed new layout for:
struct rte_security_session {
void *sess_private_data;
/**< Private session material */
+ uint64_t opaque_data;
+ /**< Opaque user defined data */
};

Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
Acked-by: Mohammad Abdul Awal <mohammad.abdul.awal@intel.com>
Acked-by: Fan Zhang <roy.fan.zhang@intel.com>
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
doc/guides/rel_notes/deprecation.rst

index 27ede77..82f7b37 100644 (file)
@@ -75,6 +75,10 @@ Deprecation Notices
   - Member ``uint16_t min_mtu`` the minimum MTU allowed.
   - Member ``uint16_t max_mtu`` the maximum MTU allowed.
 
+* security: New field ``uint64_t opaque_data`` is planned to be added into
+  ``rte_security_session`` structure. That would allow upper layer to easily
+  associate/de-associate some user defined data with the security session.
+
 * pdump: As we changed to use generic IPC, some changes in APIs and structure
   are expected in subsequent release.