Skip to contentSkip to conversation

cryptodev: add missing doc

PATCH Superseded Anoob Joseph 3 participants 4 messages Sep 7, 2023 – Sep 19, 2023

lore
Share & tools
lore

Anoob Joseph

author
#0 lore raw

PATCH 1/1 cryptodev: add missing doc

Description for rte_cryptodev_get_sec_ctx is missing. Add the same.

Signed-off-by Anoob Joseph <[email protected]>
---
 lib/cryptodev/rte_cryptodev.h | 9 +++++++++
 1 file changed, 9 insertions(+)
lib/cryptodev/rte_cryptodev.h +9 -0
index ba730373fb..8876e0427f 100644
@@ -973,6 +973,15 @@ struct rte_cryptodev_cb_rcu {
 	/**< RCU QSBR variable per queue pair */
 };
 
+/**
+ * Get the security context for the cryptodev.
+ *
+ * @param dev_id
+ *   The device identifier.
+ * @return
+ *   - NULL on error.
+ *   - Pointer to security context on success.
+ */
 void *
 rte_cryptodev_get_sec_ctx(uint8_t dev_id);
Signature · 1 line
2.25.1
author
#2 lore raw

PATCH v2 1/1 cryptodev: add missing doc

In reply to Anoob Joseph

Description for rte_cryptodev_get_sec_ctx is missing. Add the same.

Fixes eadb4fa1e1fe ("cryptodev: support security APIs")
Signed-off-by Anoob Joseph <[email protected]>
---
 lib/cryptodev/rte_cryptodev.h | 9 +++++++++
 1 file changed, 9 insertions(+)
lib/cryptodev/rte_cryptodev.h +9 -0
index 9246df90ef..9017a56cd0 100644
@@ -971,6 +971,15 @@ struct rte_cryptodev_cb_rcu {
 	/**< RCU QSBR variable per queue pair */
 };
 
+/**
+ * Get the security context for the cryptodev.
+ *
+ * @param dev_id
+ *   The device identifier.
+ * @return
+ *   - NULL on error.
+ *   - Pointer to security context on success.
+ */
 void *
 rte_cryptodev_get_sec_ctx(uint8_t dev_id);
Signature · 1 line
2.25.1