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

4 files changed, 278 insertions, 0 deletions

diff --git a/os/hal/templates/hal_trng_lld.c b/os/hal/templates/hal_trng_lld.c
new file mode 100644
index 000000000..68965fcf6
--- /dev/null
+++ b/os/hal/templates/hal_trng_lld.c
@@ -0,0 +1,140 @@
+/*

+    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_lld.c

+ * @brief   PLATFORM TRNG subsystem low level driver source.

+ *

+ * @addtogroup TRNG

+ * @{

+ */

+

+#include "hal.h"

+

+#if (HAL_USE_TRNG == TRUE) || defined(__DOXYGEN__)

+

+/*===========================================================================*/

+/* Driver local definitions.                                                 */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver exported variables.                                                */

+/*===========================================================================*/

+

+/**

+ * @brief   TRNGD1 driver identifier.

+ */

+#if (PLATFORM_TRNG_USE_TRNG1 == TRUE) || defined(__DOXYGEN__)

+TRNGDriver TRNGD1;

+#endif

+

+/*===========================================================================*/

+/* Driver local variables and types.                                         */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver local functions.                                                   */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver interrupt handlers.                                                */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver exported functions.                                                */

+/*===========================================================================*/

+

+/**

+ * @brief   Low level TRNG driver initialization.

+ *

+ * @notapi

+ */

+void trng_lld_init(void) {

+

+#if PLATFORM_TRNG_USE_TRNG1 == TRUE

+  /* Driver initialization.*/

+  trngObjectInit(&TRNGD1);

+#endif

+}

+

+/**

+ * @brief   Configures and activates the TRNG peripheral.

+ *

+ * @param[in] trngp      pointer to the @p TRNGDriver object

+ *

+ * @notapi

+ */

+void trng_lld_start(TRNGDriver *trngp) {

+

+  if (trngp->state == TRNG_STOP) {

+    /* Enables the peripheral.*/

+#if PLATFORM_TRNG_USE_TRNG1 == TRUE

+    if (&TRNGD1 == trngp) {

+

+    }

+#endif

+  }

+  /* Configures the peripheral.*/

+

+}

+

+/**

+ * @brief   Deactivates the TRNG peripheral.

+ *

+ * @param[in] trngp      pointer to the @p TRNGDriver object

+ *

+ * @notapi

+ */

+void trng_lld_stop(TRNGDriver *trngp) {

+

+  if (trngp->state == TRNG_READY) {

+    /* Resets the peripheral.*/

+

+    /* Disables the peripheral.*/

+#if PLATFORM_TRNG_USE_TRNG1 == TRUE

+    if (&TRNGD1 == trngp) {

+

+    }

+#endif

+  }

+}

+

+/**

+ * @brief   True random numbers generator.

+ * @note    The function is blocking and likely performs polled waiting

+ *          inside the low level implementation.

+ *

+ * @param[in] trngp             pointer to the @p TRNGDriver object

+ * @param[in] size              size of output buffer

+ * @param[out] out              output buffer

+ * @return                      The operation status.

+ * @retval false                if a random number has been generated.

+ * @retval true                 if an HW error occurred.

+ *

+ * @api

+ */

+bool trng_lld_generate(TRNGDriver *trngp, size_t size, uint8_t *out) {

+

+  (void)trngp;

+  (void)size;

+  (void)out;

+

+  return true;

+}

+

+#endif /* HAL_USE_TRNG == TRUE */

+

+/** @} */

diff --git a/os/hal/templates/hal_trng_lld.h b/os/hal/templates/hal_trng_lld.h
new file mode 100644
index 000000000..c110fbefa
--- /dev/null
+++ b/os/hal/templates/hal_trng_lld.h
@@ -0,0 +1,127 @@
+/*

+    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_lld.h

+ * @brief   PLATFORM TRNG subsystem low level driver header.

+ *

+ * @addtogroup TRNG

+ * @{

+ */

+

+#ifndef HAL_TRNG_LLD_H

+#define HAL_TRNG_LLD_H

+

+#if (HAL_USE_TRNG == TRUE) || defined(__DOXYGEN__)

+

+/*===========================================================================*/

+/* Driver constants.                                                         */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver pre-compile time settings.                                         */

+/*===========================================================================*/

+

+/**

+ * @name    PLATFORM configuration options

+ * @{

+ */

+/**

+ * @brief   TRNGD1 driver enable switch.

+ * @details If set to @p TRUE the support for TRNGD1 is included.

+ * @note    The default is @p FALSE.

+ */

+#if !defined(PLATFORM_TRNG_USE_TRNG1) || defined(__DOXYGEN__)

+#define PLATFORM_TRNG_USE_TRNG1               FALSE

+#endif

+/** @} */

+

+/*===========================================================================*/

+/* Derived constants and error checks.                                       */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver data structures and types.                                         */

+/*===========================================================================*/

+

+/**

+ * @brief   TRNG frequency type.

+ */

+typedef uint32_t trngfreq_t;

+

+/**

+ * @brief   TRNG counter type.

+ */

+typedef uint16_t trngcnt_t;

+

+/**

+ * @brief   Driver configuration structure.

+ * @note    It could be empty on some architectures.

+ */

+typedef struct {

+  /* End of the mandatory fields.*/

+  /**

+   * @brief   Dummy configuration, it is not needed..

+   */

+  uint32_t                   dummy;

+} TRNGConfig;

+

+/**

+ * @brief   Structure representing a TRNG driver.

+ */

+struct TRNGDriver {

+  /**

+   * @brief Driver state.

+   */

+  trngstate_t                state;

+  /**

+   * @brief Current configuration data.

+   */

+  const TRNGConfig           *config;

+#if defined(TRNG_DRIVER_EXT_FIELDS)

+  TRNG_DRIVER_EXT_FIELDS

+#endif

+  /* End of the mandatory fields.*/

+};

+

+/*===========================================================================*/

+/* Driver macros.                                                            */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* External declarations.                                                    */

+/*===========================================================================*/

+

+#if (PLATFORM_TRNG_USE_TRNG1 == TRUE) && !defined(__DOXYGEN__)

+extern TRNGDriver TRNGD1;

+#endif

+

+#ifdef __cplusplus

+extern "C" {

+#endif

+  void trng_lld_init(void);

+  void trng_lld_start(TRNGDriver *trngp);

+  void trng_lld_stop(TRNGDriver *trngp);

+  bool trng_lld_generate(TRNGDriver *trngp, size_t size, uint8_t *out);

+#ifdef __cplusplus

+}

+#endif

+

+#endif /* HAL_USE_TRNG == TRUE */

+

+#endif /* HAL_TRNG_LLD_H */

+

+/** @} */

diff --git a/os/hal/templates/halconf.h b/os/hal/templates/halconf.h
index f27169ae4..26d8463d4 100644
--- a/os/hal/templates/halconf.h
+++ b/os/hal/templates/halconf.h
@@ -167,6 +167,13 @@
 #endif

 

 /**

+ * @brief   Enables the TRNG subsystem.

+ */

+#if !defined(HAL_USE_TRNG) || defined(__DOXYGEN__)

+#define HAL_USE_TRNG                        TRUE

+#endif

+

+/**

  * @brief   Enables the UART subsystem.

  */

 #if !defined(HAL_USE_UART) || defined(__DOXYGEN__)

diff --git a/os/hal/templates/platform.mk b/os/hal/templates/platform.mk
index 13ea8a7c6..533c654c3 100644
--- a/os/hal/templates/platform.mk
+++ b/os/hal/templates/platform.mk
@@ -61,6 +61,9 @@ endif
 ifneq ($(findstring HAL_USE_SPI TRUE,$(HALCONF)),)

 PLATFORMSRC += ${CHIBIOS}/os/hal/templates/hal_spi_lld.c

 endif

+ifneq ($(findstring HAL_USE_TRNG TRUE,$(HALCONF)),)

+PLATFORMSRC += ${CHIBIOS}/os/hal/templates/hal_trng_lld.c

+endif

 ifneq ($(findstring HAL_USE_UART TRUE,$(HALCONF)),)

 PLATFORMSRC += ${CHIBIOS}/os/hal/templates/hal_uart_lld.c

 endif

@@ -90,6 +93,7 @@ PLATFORMSRC = ${CHIBIOS}/os/hal/templates/hal_lld.c \
               ${CHIBIOS}/os/hal/templates/hal_serial_lld.c \

               ${CHIBIOS}/os/hal/templates/hal_spi_lld.c \

               ${CHIBIOS}/os/hal/templates/hal_st_lld.c \

+              ${CHIBIOS}/os/hal/templates/hal_trng_lld.c \

               ${CHIBIOS}/os/hal/templates/hal_uart_lld.c \

               ${CHIBIOS}/os/hal/templates/hal_usb_lld.c \

               ${CHIBIOS}/os/hal/templates/hal_wdg_lld.c