X-Git-Url: https://git.cryptolib.org/?a=blobdiff_plain;f=cast5.c;h=34c5a78e3dc5a674ad3afabb0cb15293391ec6bb;hb=bddd3069b50823af3bc567f073f574dff74d416c;hp=ebe1ce69d1bdb09d297b0945ae1225e048f36479;hpb=3c995d0a8faeb9d37927d48e20fc45d839e066ea;p=avr-crypto-lib.git

diff --git a/cast5.c b/cast5.c
index ebe1ce6..34c5a78 100644
--- a/cast5.c
+++ b/cast5.c
@@ -1,22 +1,25 @@
 /* 
- * File:	cast5.c
- * Author:	Daniel Otte
- * Date: 	26.07.2006
- * License: GPL
- * Description: Implementation of the CAST5 (aka CAST-128) cipher algorithm as described in RFC 2144
+ * \file	cast5.c
+ * \author	Daniel Otte
+ * \date 	26.07.2006
+ * \par License:
+ *  GPL
+ * \brief Implementation of the CAST5 (aka CAST-128) cipher algorithm as described in RFC 2144
  * 
  */
- //pgm_read_dword
  
  #include <stdint.h>
  #include <string.h>
  #include "cast5.h"
  #include "config.h"
- #include "uart.h"
  #include "debug.h"
  
  #undef DEBUG
  
+ #ifdef DEBUG
+  #include "uart.h"
+ #endif
+ 
 #include "cast5-sbox.h"
 
 
@@ -85,7 +88,12 @@ void cast5_init_rM(uint8_t *klo, uint8_t *khi, uint8_t offset, uint8_t *src, boo
 
 
 
-
+/**
+ * \brief sets up round keys (context) for cast5 en/decryption.
+ * @param s Pointer to cast5 context.
+ * @param key Pointer to binary key.
+ * @param keylength length of keydata in bits.
+ */
 void cast5_init(cast5_ctx_t* s, uint8_t* key, uint8_t keylength){
  	 /* we migth return if the key is valid and if setup was sucessfull */
 	uint32_t x[4], z[4];
@@ -237,8 +245,13 @@ uint32_t cast5_f3(uint32_t d, uint32_t m, uint8_t r){
 #endif
 }
 
+/*************************************************************************/
 
-
+/**
+ * \brief encrypts a datablock with cast5
+ * @param s Pointer to cast5 roundkeys (context)
+ * @param block Pointer to datablock
+ */
 void cast5_enc(cast5_ctx_t *s, void* block){
 	uint32_t l,r, x, y;
 	uint8_t i;
@@ -261,7 +274,13 @@ void cast5_enc(cast5_ctx_t *s, void* block){
 	((uint32_t*)block)[1]=l;
 }
 
+/*************************************************************************/
 
+/**
+ * \brief decrypts a datablock with cast5
+ * @param s Pointer to cast5 roundkeys (context)
+ * @param block Pointer to datablock
+ */
 void cast5_dec(cast5_ctx_t *s, void* block){
 	uint32_t l,r, x, y;
 	int8_t i, rounds;