aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/include/hal_trng.h
diff options
context:
space:
mode:
authorGiovanni Di Sirio <gdisirio@gmail.com>2018-09-09 09:41:52 +0000
committerGiovanni Di Sirio <gdisirio@gmail.com>2018-09-09 09:41:52 +0000
commit98aeb732ffd81f00bde3fb7dd2a4ff65690ebe7f (patch)
treee2181fa6d214da5b59d1e6ff7372a1117e62f84c /os/hal/include/hal_trng.h
parentab8cbd8f7c824a3311c1878157e8b6d7721e470d (diff)
downloadChibiOS-98aeb732ffd81f00bde3fb7dd2a4ff65690ebe7f.tar.gz
ChibiOS-98aeb732ffd81f00bde3fb7dd2a4ff65690ebe7f.tar.bz2
ChibiOS-98aeb732ffd81f00bde3fb7dd2a4ff65690ebe7f.zip
New TRNG driver model added to HAL.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12253 110e8d01-0319-4d1e-a829-52ad28d1bb01
Diffstat (limited to 'os/hal/include/hal_trng.h')
-rw-r--r--os/hal/include/hal_trng.h87
1 files changed, 87 insertions, 0 deletions
diff --git a/os/hal/include/hal_trng.h b/os/hal/include/hal_trng.h
new file mode 100644
index 000000000..48d95613e
--- /dev/null
+++ b/os/hal/include/hal_trng.h
@@ -0,0 +1,87 @@
+/*
+ ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+
+/**
+ * @file hal_trng.h
+ * @brief TRNG Driver macros and structures.
+ *
+ * @addtogroup TRNG
+ * @{
+ */
+
+#ifndef HAL_TRNG_H
+#define HAL_TRNG_H
+
+#if (HAL_USE_TRNG == TRUE) || defined(__DOXYGEN__)
+
+/*===========================================================================*/
+/* Driver constants. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver pre-compile time settings. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Derived constants and error checks. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver data structures and types. */
+/*===========================================================================*/
+
+/**
+ * @brief Driver state machine possible states.
+ */
+typedef enum {
+ TRNG_UNINIT = 0, /**< Not initialized. */
+ TRNG_STOP = 1, /**< Stopped. */
+ TRNG_READY = 2, /**< Ready. */
+ TRNG_RUNNING = 3 /**< Generating random number. */
+} trngstate_t;
+
+/**
+ * @brief Type of a structure representing a TRNG driver.
+ */
+typedef struct TRNGDriver TRNGDriver;
+
+#include "hal_trng_lld.h"
+
+/*===========================================================================*/
+/* Driver macros. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* External declarations. */
+/*===========================================================================*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+ void trngInit(void);
+ void trngObjectInit(TRNGDriver *trngp);
+ void trngStart(TRNGDriver *trngp, const TRNGConfig *config);
+ void trngStop(TRNGDriver *trngp);
+ bool trngGenerate(TRNGDriver *trngp, size_t size, uint8_t *out);
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* HAL_USE_TRNG == TRUE */
+
+#endif /* HAL_TRNG_H */
+
+/** @} */