6f18ad24d18a395fab8f72454b33d9e4c58c52c2
[bertos.git] / bertos / algo / randpool.h
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2007 Develer S.r.l. (http://www.develer.com/);
30  *
31  * -->
32  *
33  * \brief Collection of functions to manage entropy pool.
34  *
35  *
36  * \version $Id$
37  * \author Daniele Basile <asterix@develer.com>
38  *
39  * $WIZ$ module_name = "randpool"
40  * $WIZ$ module_depends = "timer", "sprintf"
41  * $WIZ$ module_configuration = "bertos/cfg/cfg_randpool.h"
42  */
43
44 #ifndef ALGO_RANDPOOL_H
45 #define ALGO_RANDPOOL_H
46
47 #include "cfg/cfg_randpool.h"
48 #include <cfg/compiler.h>
49
50
51 /**
52  * Sturct data of entropy pool.
53  */
54 typedef struct EntropyPool
55 {
56         size_t entropy;                                  ///< Actual value of entropy (byte).
57         size_t pos_add;                                  ///< Number of byte  idd in entropy pool.
58         size_t pos_get;                                  ///< Number of byte get in entropy pool.
59         size_t counter;                                  ///< Counter.
60
61 #if CONFIG_RANDPOOL_TIMER
62         size_t last_counter;                             ///< Last timer value.
63 #endif
64
65         uint8_t pool_entropy[CONFIG_SIZE_ENTROPY_POOL];  ///< Entropy pool.
66
67 } EntropyPool;
68
69
70 void randpool_add(EntropyPool *pool, void *data, size_t entropy);
71 void randpool_init(EntropyPool *pool, void *_data, size_t len);
72 size_t randpool_size(EntropyPool *pool);
73 void randpool_get(EntropyPool *pool, void *data, size_t n_byte);
74 uint8_t *randpool_pool(EntropyPool *pool);
75
76 #endif /* ALGO_RANDPOOL_H */