aboutsummaryrefslogtreecommitdiffstats
path: root/include/random.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/random.h')
-rw-r--r--include/random.h13
1 files changed, 13 insertions, 0 deletions
diff --git a/include/random.h b/include/random.h
index 6485f26..a1868f6 100644
--- a/include/random.h
+++ b/include/random.h
@@ -1,9 +1,22 @@
+/**
+ * @file random.h
+ * Provides true random number generation functionality
+ */
+
#ifndef RANDOM_H_
#define RANDOM_H_
#include <stdint.h>
+/**
+ * Initializes the STM's true random number generator.
+ */
void random_init(void);
+
+/**
+ * Gets the next random number from the generator.
+ * @return the random number
+ */
uint32_t random_get(void);
#endif // RANDOM_H_