+MUGI

[avr-crypto-lib.git] / aes_keyschedule.h

diff --git a/aes_keyschedule.h b/aes_keyschedule.h
index 7d6d840e519f9d573b3e7a2e243daaf897c23671..b013971df759b2b74f26d5c40c6e6bedeed94f5b 100644 (file)
--- a/aes_keyschedule.h
+++ b/aes_keyschedule.h
@@ -22,7 +22,7 @@
  * \author   Daniel Otte 
  * \date     2008-12-30
  * \license  GPLv3 or later
- * 
+ * \ingroup  AES
  */
 
 
@@ -30,11 +30,46 @@
 #define AES_KEYSCHEDULE_H_
 
 #include "aes.h"
-
+/** \fn void aes_init(const void* key, uint16_t keysize_b, aes_genctx_t* ctx)
+ * \brief initialize the keyschedule
+ * 
+ * This function computes the keyschedule from a given key with a given length
+ * and stores it in the context variable
+ * \param key       pointer to the key material
+ * \param keysize_b length of the key in bits (valid are 128, 192 and 256)
+ * \param ctx       pointer to the context where the keyschedule should be stored
+ */
 void aes_init(const void* key, uint16_t keysize_b, aes_genctx_t* ctx);
 
+/** \fn void aes128_init(const void* key, aes128_ctx_t* ctx)
+ * \brief initialize the keyschedule for 128 bit key
+ * 
+ * This function computes the keyschedule from a given 128 bit key
+ * and stores it in the context variable
+ * \param key       pointer to the key material
+ * \param ctx       pointer to the context where the keyschedule should be stored
+ */
 void aes128_init(const void* key, aes128_ctx_t* ctx);
+
+/** \fn void aes192_init(const void* key, aes192_ctx_t* ctx)
+ * \brief initialize the keyschedule for 192 bit key
+ * 
+ * This function computes the keyschedule from a given 192 bit key
+ * and stores it in the context variable
+ * \param key       pointer to the key material
+ * \param ctx       pointer to the context where the keyschedule should be stored
+ */
 void aes192_init(const void* key, aes192_ctx_t* ctx);
+
+/** \fn void aes256_init(const void* key, aes256_ctx_t* ctx)
+ * \brief initialize the keyschedule for 256 bit key
+ * 
+ * This function computes the keyschedule from a given 256 bit key
+ * and stores it in the context variable
+ * \param key       pointer to the key material
+ * \param ctx       pointer to the context where the keyschedule should be stored
+ */
 void aes256_init(const void* key, aes256_ctx_t* ctx);
 
 #endif /* AES_KEYSCHEDULE_H_ */
+