move components to SDK dir

This commit is contained in:
Shuanglei Tao
2025-03-03 09:06:26 +08:00
parent 20d1297e57
commit f4f4c9e60d
1021 changed files with 58 additions and 35059 deletions

View File

@@ -0,0 +1,297 @@
/**
* Copyright (c) 2016 - 2017, Nordic Semiconductor ASA
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form, except as embedded into a Nordic
* Semiconductor ASA integrated circuit in a product or a software update for
* such product, must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution.
*
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* 4. This software, with or without modification, must only be used with a
* Nordic Semiconductor ASA integrated circuit.
*
* 5. Any software provided in binary form under this license must not be reverse
* engineered, decompiled, modified and/or disassembled.
*
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
#include "sdk_common.h"
#if NRF_MODULE_ENABLED(RNG)
#include <stdint.h>
#include <stddef.h>
#include "nrf_drv_rng.h"
#include "nrf_drv_common.h"
#include "nordic_common.h"
#include "nrf_assert.h"
#include "nrf_queue.h"
#ifdef SOFTDEVICE_PRESENT
#include "softdevice_handler.h"
#include "nrf_soc.h"
#include "app_util_platform.h"
#endif // SOFTDEVICE_PRESENT
#define NRF_LOG_MODULE_NAME "RNG"
#if RNG_CONFIG_LOG_ENABLED
#define NRF_LOG_LEVEL RNG_CONFIG_LOG_LEVEL
#define NRF_LOG_INFO_COLOR RNG_CONFIG_INFO_COLOR
#define NRF_LOG_DEBUG_COLOR RNG_CONFIG_DEBUG_COLOR
#else //RNG_CONFIG_LOG_ENABLED
#define NRF_LOG_LEVEL 0
#endif //RNG_CONFIG_LOG_ENABLED
#include "nrf_log.h"
#include "nrf_log_ctrl.h"
/* Validate configuration */
INTERRUPT_PRIORITY_VALIDATION(RNG_CONFIG_IRQ_PRIORITY);
typedef struct
{
nrf_drv_state_t state;
nrf_drv_rng_config_t config;
} nrf_drv_rng_cb_t;
static nrf_drv_rng_cb_t m_rng_cb;
NRF_QUEUE_DEF(uint8_t, m_rand_pool, RNG_CONFIG_POOL_SIZE, NRF_QUEUE_MODE_OVERFLOW);
static const nrf_drv_rng_config_t m_default_config = NRF_DRV_RNG_DEFAULT_CONFIG;
#ifdef SOFTDEVICE_PRESENT
#define SD_RAND_POOL_SIZE (32)
STATIC_ASSERT(RNG_CONFIG_POOL_SIZE == SD_RAND_POOL_SIZE);
#define NRF_DRV_RNG_LOCK() CRITICAL_REGION_ENTER()
#define NRF_DRV_RNG_RELEASE() CRITICAL_REGION_EXIT()
#define NRF_DRV_RNG_SD_IS_ENABLED() softdevice_handler_is_enabled()
#else
#define NRF_DRV_RNG_LOCK() do { } while (0)
#define NRF_DRV_RNG_RELEASE() do { } while (0)
#define NRF_DRV_RNG_SD_IS_ENABLED() false
#endif // SOFTDEVICE_PRESENT
/**
* @brief Function for starting generation.
*/
static void nrf_drv_rng_start(void)
{
ASSERT(!NRF_DRV_RNG_SD_IS_ENABLED());
nrf_rng_event_clear(NRF_RNG_EVENT_VALRDY);
nrf_rng_int_enable(NRF_RNG_INT_VALRDY_MASK);
nrf_rng_task_trigger(NRF_RNG_TASK_START);
}
/**
* @brief Function for stoping generation.
*/
static void nrf_drv_rng_stop(void)
{
ASSERT(!NRF_DRV_RNG_SD_IS_ENABLED());
nrf_rng_int_disable(NRF_RNG_INT_VALRDY_MASK);
nrf_rng_task_trigger(NRF_RNG_TASK_STOP);
}
/**
* @brief Function for setting up RNG hardware.
*/
static void nrf_drv_rng_setup(void)
{
ASSERT(!NRF_DRV_RNG_SD_IS_ENABLED());
if (m_rng_cb.config.error_correction)
{
nrf_rng_error_correction_enable();
}
nrf_rng_shorts_disable(NRF_RNG_SHORT_VALRDY_STOP_MASK);
nrf_drv_common_irq_enable(RNG_IRQn, m_rng_cb.config.interrupt_priority);
}
ret_code_t nrf_drv_rng_init(nrf_drv_rng_config_t const * p_config)
{
if (m_rng_cb.state != NRF_DRV_STATE_UNINITIALIZED)
{
return NRF_ERROR_MODULE_ALREADY_INITIALIZED;
}
if (p_config == NULL)
{
p_config = &m_default_config;
}
m_rng_cb.config = *p_config;
NRF_DRV_RNG_LOCK();
if (!NRF_DRV_RNG_SD_IS_ENABLED())
{
nrf_drv_rng_setup();
nrf_drv_rng_start();
}
NRF_DRV_RNG_RELEASE();
m_rng_cb.state = NRF_DRV_STATE_INITIALIZED;
return NRF_SUCCESS;
}
void nrf_drv_rng_uninit(void)
{
ASSERT(m_rng_cb.state == NRF_DRV_STATE_INITIALIZED);
NRF_DRV_RNG_LOCK();
if (!NRF_DRV_RNG_SD_IS_ENABLED())
{
nrf_drv_rng_stop();
nrf_drv_common_irq_disable(RNG_IRQn);
}
NRF_DRV_RNG_RELEASE();
nrf_queue_reset(&m_rand_pool);
m_rng_cb.state = NRF_DRV_STATE_UNINITIALIZED;
NRF_LOG_INFO("Uninitialized.\r\n");
}
void nrf_drv_rng_bytes_available(uint8_t * p_bytes_available)
{
ASSERT(m_rng_cb.state == NRF_DRV_STATE_INITIALIZED);
#ifdef SOFTDEVICE_PRESENT
if (NRF_DRV_RNG_SD_IS_ENABLED())
{
if (NRF_SUCCESS == sd_rand_application_bytes_available_get(p_bytes_available))
{
return;
}
}
#endif // SOFTDEVICE_PRESENT
*p_bytes_available = nrf_queue_utilization_get(&m_rand_pool);
NRF_LOG_INFO("Function: %s, available bytes: %d.\r\n", (uint32_t)__func__, *p_bytes_available);
}
ret_code_t nrf_drv_rng_rand(uint8_t * p_buff, uint8_t length)
{
ret_code_t err_code = NRF_SUCCESS;
ASSERT(m_rng_cb.state == NRF_DRV_STATE_INITIALIZED);
#ifdef SOFTDEVICE_PRESENT
do {
bool sd_is_enabled;
NRF_DRV_RNG_LOCK();
sd_is_enabled = NRF_DRV_RNG_SD_IS_ENABLED();
if (!sd_is_enabled)
#endif // SOFTDEVICE_PRESENT
{
err_code = nrf_queue_read(&m_rand_pool, p_buff, (uint32_t)length);
nrf_drv_rng_start();
}
#ifdef SOFTDEVICE_PRESENT
NRF_DRV_RNG_RELEASE();
if (sd_is_enabled)
{
err_code = sd_rand_application_vector_get(p_buff, length);
if (err_code == NRF_ERROR_SOC_RAND_NOT_ENOUGH_VALUES)
{
err_code = NRF_ERROR_NOT_FOUND;
}
}
} while (err_code == NRF_ERROR_SOFTDEVICE_NOT_ENABLED);
#endif // SOFTDEVICE_PRESENT
ASSERT((err_code == NRF_SUCCESS) || (err_code == NRF_ERROR_NOT_FOUND));
NRF_LOG_DEBUG("Rand buffer data:\r\n");
NRF_LOG_HEXDUMP_DEBUG((uint8_t *)p_buff, length);
NRF_LOG_WARNING("Function: %s, error code: %s.\r\n",
(uint32_t)__func__,
(uint32_t)ERR_TO_STR(err_code));
return err_code;
}
void nrf_drv_rng_block_rand(uint8_t * p_buff, uint32_t length)
{
ASSERT(m_rng_cb.state == NRF_DRV_STATE_INITIALIZED);
while (length)
{
uint32_t len = MIN(length, RNG_CONFIG_POOL_SIZE);
ret_code_t err_code;
do {
err_code = nrf_drv_rng_rand(p_buff, len);
} while(err_code != NRF_SUCCESS);
length -= len;
p_buff += len;
}
NRF_LOG_DEBUG("Rand buffer data:\r\n");
NRF_LOG_HEXDUMP_DEBUG((uint8_t *)p_buff, length);
}
#ifdef SOFTDEVICE_PRESENT
void nrf_drv_rng_on_sd_disable(void)
{
NRF_DRV_RNG_LOCK();
if (m_rng_cb.state == NRF_DRV_STATE_INITIALIZED)
{
nrf_drv_rng_setup();
nrf_drv_rng_start();
}
NRF_DRV_RNG_RELEASE();
}
#endif // SOFTDEVICE_PRESENT
void RNG_IRQHandler(void)
{
NRF_DRV_RNG_LOCK();
if (
!NRF_DRV_RNG_SD_IS_ENABLED() &&
nrf_rng_event_get(NRF_RNG_EVENT_VALRDY) &&
nrf_rng_int_get(NRF_RNG_INT_VALRDY_MASK))
{
nrf_rng_event_clear(NRF_RNG_EVENT_VALRDY);
uint8_t new_value = nrf_rng_random_value_get();
UNUSED_RETURN_VALUE(nrf_queue_push(&m_rand_pool, &new_value));
if (nrf_queue_is_full(&m_rand_pool))
{
nrf_drv_rng_stop();
}
NRF_LOG_DEBUG("Event: NRF_RNG_EVENT_VALRDY.\r\n");
}
NRF_DRV_RNG_RELEASE();
}
#endif // NRF_MODULE_ENABLED(RNG)

View File

@@ -0,0 +1,148 @@
/**
* Copyright (c) 2016 - 2017, Nordic Semiconductor ASA
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form, except as embedded into a Nordic
* Semiconductor ASA integrated circuit in a product or a software update for
* such product, must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution.
*
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* 4. This software, with or without modification, must only be used with a
* Nordic Semiconductor ASA integrated circuit.
*
* 5. Any software provided in binary form under this license must not be reverse
* engineered, decompiled, modified and/or disassembled.
*
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
#ifndef NRF_DRV_RNG_H__
#define NRF_DRV_RNG_H__
#include <stdbool.h>
#include <stdint.h>
#include "nrf_rng.h"
#include "sdk_errors.h"
#include "sdk_config.h"
#include "nrf_drv_common.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @addtogroup nrf_rng RNG HAL and driver
* @ingroup nrf_drivers
* @brief Random number generator (RNG) APIs.
* @details The RNG HAL provides basic APIs for accessing the registers of the random number
* generator. The RNG driver provides APIs on a higher level.
*
* @defgroup nrf_drv_rng RNG driver
* @{
* @ingroup nrf_rng
* @brief Driver for managing the random number generator (RNG).
*/
/**@brief Struct for RNG configuration. */
typedef struct
{
bool error_correction; /**< Error correction flag. */
uint8_t interrupt_priority; /**< interrupt priority */
} nrf_drv_rng_config_t;
/**@brief RNG default configuration. */
#define NRF_DRV_RNG_DEFAULT_CONFIG \
{ \
.error_correction = RNG_CONFIG_ERROR_CORRECTION, \
.interrupt_priority = RNG_CONFIG_IRQ_PRIORITY, \
}
/**
* @brief Function for initializing the nrf_drv_rng module.
*
* @param[in] p_config Initial configuration. Default configuration used if NULL.
*
* @retval NRF_SUCCESS Driver was successfully initialized.
* @retval NRF_ERROR_MODULE_ALREADY_INITIALIZED Driver was already initialized.
*/
ret_code_t nrf_drv_rng_init(nrf_drv_rng_config_t const * p_config);
/**
* @brief Function for uninitializing the nrf_drv_rng module.
*/
void nrf_drv_rng_uninit(void);
/**
* @brief Function for getting the number of currently available random bytes.
*
* @param[out] p_bytes_available The number of bytes currently available in the pool.
*/
void nrf_drv_rng_bytes_available(uint8_t * p_bytes_available);
/**
* @brief Function for getting the vector of random numbers.
*
* @param[out] p_buff Pointer to uint8_t buffer for storing the bytes.
* @param[in] length Number of bytes to take from the pool and place in p_buff.
*
* @retval NRF_SUCCESS If the requested bytes were written to p_buff.
* @retval NRF_ERROR_NOT_FOUND If no bytes were written to the buffer because there were
* not enough bytes available in the pool.
*/
ret_code_t nrf_drv_rng_rand(uint8_t * p_buff, uint8_t length);
/**
* @brief Blocking function for getting an arbitrary array of random numbers.
*
* @note This function may execute for a substantial amount of time depending on the length
* of the buffer required and on the state of the current internal pool of random numbers.
*
* @param[out] p_buff Pointer to uint8_t buffer for storing the bytes.
* @param[in] length Number of bytes place in p_buff.
*/
void nrf_drv_rng_block_rand(uint8_t * p_buff, uint32_t length);
#ifdef SOFTDEVICE_PRESENT
/**
* @brief Function called by the SoftDevice handler when the SoftDevice has been disabled.
*
* This function is called just after the SoftDevice has been properly disabled.
* It has two purposes:
* 1. Reinitializes RNG hardware.
* 2. Trigger new random numbers generation.
*/
void nrf_drv_rng_on_sd_disable(void);
#endif
/**
*@}
**/
#ifdef __cplusplus
}
#endif
#endif // NRF_DRV_RNG_H__