aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/ports/NRF5/LLD/RNGv1/hal_rng_lld.h
diff options
context:
space:
mode:
Diffstat (limited to 'os/hal/ports/NRF5/LLD/RNGv1/hal_rng_lld.h')
-rw-r--r--os/hal/ports/NRF5/LLD/RNGv1/hal_rng_lld.h159
1 files changed, 159 insertions, 0 deletions
diff --git a/os/hal/ports/NRF5/LLD/RNGv1/hal_rng_lld.h b/os/hal/ports/NRF5/LLD/RNGv1/hal_rng_lld.h
new file mode 100644
index 0000000..a74f6ef
--- /dev/null
+++ b/os/hal/ports/NRF5/LLD/RNGv1/hal_rng_lld.h
@@ -0,0 +1,159 @@
+/*
+ RNG for ChibiOS - Copyright (C) 2016 Stephane D'Alu
+
+ 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 RNGv1/hal_rng_lld.h
+ * @brief NRF5 RNG subsystem low level driver header.
+ *
+ * @addtogroup RNG
+ * @{
+ */
+
+#ifndef HAL_RNG_LLD_H
+#define HAL_RNG_LLD_H
+
+#if (HAL_USE_RNG == TRUE) || defined(__DOXYGEN__)
+
+/*===========================================================================*/
+/* Driver constants. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver pre-compile time settings. */
+/*===========================================================================*/
+
+/**
+ * @name Configuration options
+ * @{
+ */
+/**
+ * @brief RNGD1 driver enable switch.
+ * @details If set to @p TRUE the support for RNGD1 is included.
+ * @note The default is @p FALSE.
+ */
+#if !defined(NRF5_RNG_USE_RNG0) || defined(__DOXYGEN__)
+#define NRF5_RNG_USE_RNG0 FALSE
+#endif
+
+/**
+ * @brief RNG interrupt priority level setting for RNG0.
+ */
+#if !defined(NRF5_RNG_RNG0_IRQ_PRIORITY) || defined(__DOXYGEN__)
+#define NRF5_RNG_RNG0_IRQ_PRIORITY 3
+#endif
+
+
+/*===========================================================================*/
+/* Derived constants and error checks. */
+/*===========================================================================*/
+
+#if NRF5_RNG_USE_RNG0 == FALSE
+#error "Requesting RNG driver, but no RNG peripheric attached"
+#endif
+
+#if NRF5_RNG_USE_RNG0 && \
+ !OSAL_IRQ_IS_VALID_PRIORITY(NRF5_RNG_RNG0_IRQ_PRIORITY)
+#error "Invalid IRQ priority assigned to RNG0"
+#endif
+
+/*===========================================================================*/
+/* Driver data structures and types. */
+/*===========================================================================*/
+
+/**
+ * @brief Type of a structure representing an RNG driver.
+ */
+typedef struct RNGDriver RNGDriver;
+
+/**
+ * @brief Driver configuration structure.
+ */
+typedef struct {
+ /* End of the mandatory fields.*/
+ /**
+ * @brief Activate the digital error correction
+ *
+ * @details A digital corrector algorithm is employed to remove any
+ * bias toward '1' or '0'. Disabling it offers a substantial
+ * speed advantage, but may result in a statistical distribution
+ * that is not perfectly uniform.
+ *
+ * @note For nRF51, on average, it take 167µs to get a byte without
+ * digitial error correction and 677µs with, but no garantee
+ * is made on the necessary time to generate one byte.
+ */
+ uint8_t digital_error_correction:1;
+} RNGConfig;
+
+
+/**
+ * @brief Structure representing an RNG driver.
+ */
+struct RNGDriver {
+ /**
+ * @brief Driver state.
+ */
+ rngstate_t state;
+ /**
+ * @brief Current configuration data.
+ */
+ const RNGConfig *config;
+#if RNG_USE_MUTUAL_EXCLUSION || defined(__DOXYGEN__)
+ /**
+ * @brief Mutex protecting the peripheral.
+ */
+ mutex_t mutex;
+#endif /* RNG_USE_MUTUAL_EXCLUSION */
+ /* End of the mandatory fields.*/
+ /**
+ * @brief Pointer to the RNGx registers block.
+ */
+ NRF_RNG_Type *rng;
+ /**
+ * @brief IRQ number
+ */
+ uint32_t irq;
+};
+
+/*===========================================================================*/
+/* Driver macros. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* External declarations. */
+/*===========================================================================*/
+
+#if NRF5_RNG_USE_RNG0 && !defined(__DOXYGEN__)
+extern RNGDriver RNGD1;
+#endif /* NRF5_RNG_USE_RNG0 */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+ void rng_lld_init(void);
+ void rng_lld_start(RNGDriver *rngp);
+ void rng_lld_stop(RNGDriver *rngp);
+ msg_t rng_lld_write(RNGDriver *rngp, uint8_t *buf, size_t n,
+ systime_t timeout);
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* HAL_USE_RNG */
+
+#endif /* HAL_RNG_LLD_H */
+
+/** @} */