Add psa_generate_key_iop_t structs and docs
Signed-off-by: Paul Elliott <paul.elliott@arm.com>
Signed-off-by: Janos Follath <janos.follath@arm.com>
diff --git a/tf-psa-crypto/include/psa/crypto.h b/tf-psa-crypto/include/psa/crypto.h
index 6f0049b..2b03435 100644
--- a/tf-psa-crypto/include/psa/crypto.h
+++ b/tf-psa-crypto/include/psa/crypto.h
@@ -5168,6 +5168,46 @@
/**@}*/
+/**
+ * \defgroup interruptible_generate_key Interruptible Key Generation
+ * @{
+ */
+
+/**
+ * The type of the state data structure for interruptible key generation
+ * operations.
+ *
+ * Before calling any function on an interruptible key generation object, the
+ * application must initialize it by any of the following means:
+ * - Set the structure to all-bits-zero, for example:
+ * \code
+ * psa_generate_key_iop_t operation;
+ * memset(&operation, 0, sizeof(operation));
+ * \endcode
+ * - Initialize the structure to logical zero values, for example:
+ * \code
+ * psa_generate_key_iop_t operation = {0};
+ * \endcode
+ * - Initialize the structure to the initializer #PSA_GENERATE_KEY_IOP_INIT,
+ * for example:
+ * - \code
+ * psa_generate_key_iop_t operation = PSA_GENERATE_KEY_IOP_INIT;
+ * \endcode
+ * - Assign the result of the function psa_generate_key_iop_init() to the
+ * structure, for example:
+ * \code
+ * psa_generate_key_iop_t operation;
+ * operation = psa_generate_key_iop_init();
+ * \endcode
+ *
+ * This is an implementation-defined \c struct. Applications should not
+ * make any assumptions about the content of this structure.
+ * Implementation details can change in future versions without notice.
+ */
+typedef struct psa_generate_key_iop_s psa_generate_key_iop_t;
+
+/**@}*/
+
#ifdef __cplusplus
}
#endif