diff mbox

[2/2] api:crypto: resolve todo items

Message ID 1469803138-25622-2-git-send-email-nikhil.agarwal@linaro.org
State Accepted
Commit b6a5e7039cc23e4547b11b78a12ba7f9efe6ae93
Headers show

Commit Message

Nikhil Agarwal July 29, 2016, 2:38 p.m. UTC 
odp_session_proc_info_t is no longer required.
Clarified hash_result_offset and its relation with ICV value.

Signed-off-by: Nikhil Agarwal <nikhil.agarwal@linaro.org>

---
 include/odp/api/spec/crypto.h | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

-- 
2.8.2
diff mbox

Patch

diff --git a/include/odp/api/spec/crypto.h b/include/odp/api/spec/crypto.h
index d8123e9..dea1fe9 100644
--- a/include/odp/api/spec/crypto.h
+++ b/include/odp/api/spec/crypto.h
@@ -170,8 +170,6 @@  typedef struct odp_crypto_data_range {
 
 /**
  * Crypto API session creation parameters
- *
- * @todo Add "odp_session_proc_info_t"
  */
 typedef struct odp_crypto_session_params {
 	odp_crypto_op_t op;                /**< Encode versus decode */
@@ -210,8 +208,6 @@  typedef struct odp_crypto_session_params {
 
 /**
  * Crypto API per packet operation parameters
- *
- * @todo Clarify who zero's ICV and how this relates to "hash_result_offset"
  */
 typedef struct odp_crypto_op_params {
 	odp_crypto_session_t session;   /**< Session handle from creation */
@@ -245,6 +241,14 @@  typedef struct odp_crypto_op_params {
  *   indicates the caller wishes the destination packet buffer be allocated
  *   from the output pool specified during session creation.
  *
+ * @var odp_crypto_op_params_t::hash_result_offset
+ *
+ *   Specifies the offset where the hash result is to be stored. In case of
+ *   decode sessions, input hash values will be read from this offset, and
+ *   overwritten with hash results. If this offset lies within specified
+ *   auth_range, implementation will mute this field before calculating the hash
+ *   result.
+ *
  *   @sa odp_crypto_session_params_t::output_pool.
  */