bbe5e1e6eb
Namespaced the generated headers with `zephyr` to prevent potential conflict with other headers. Introduce a temporary Kconfig `LEGACY_GENERATED_INCLUDE_PATH` that is enabled by default. This allows the developers to continue the use of the old include paths for the time being until it is deprecated and eventually removed. The Kconfig will generate a build-time warning message, similar to the `CONFIG_TIMER_RANDOM_GENERATOR`. Updated the includes path of in-tree sources accordingly. Most of the changes here are scripted, check the PR for more info. Signed-off-by: Yong Cong Sin <ycsin@meta.com>
152 lines
3.1 KiB
C
152 lines
3.1 KiB
C
/*
|
|
* Copyright (c) 2013-2014 Wind River Systems, Inc.
|
|
* Copyright (c) 2023 Intel Corporation
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
* @brief Random number generator header file
|
|
*
|
|
* This header file declares prototypes for the kernel's random number
|
|
* generator APIs.
|
|
*
|
|
* Typically, a platform enables the appropriate source for the random
|
|
* number generation based on the hardware platform's capabilities or
|
|
* (for testing purposes only) enables the TEST_RANDOM_GENERATOR
|
|
* configuration option.
|
|
*/
|
|
|
|
#ifndef ZEPHYR_INCLUDE_RANDOM_RANDOM_H_
|
|
#define ZEPHYR_INCLUDE_RANDOM_RANDOM_H_
|
|
|
|
#include <zephyr/types.h>
|
|
#include <stddef.h>
|
|
#include <zephyr/kernel.h>
|
|
|
|
/**
|
|
* @brief Random Function APIs
|
|
* @defgroup random_api Random Function APIs
|
|
* @since 1.0
|
|
* @version 1.0.0
|
|
* @ingroup crypto
|
|
* @{
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
/**
|
|
* @brief Fill the destination buffer with random data values that should
|
|
* pass general randomness tests.
|
|
*
|
|
* @note The random values returned are not considered cryptographically
|
|
* secure random number values.
|
|
*
|
|
* @param [out] dst destination buffer to fill with random data.
|
|
* @param len size of the destination buffer.
|
|
*
|
|
*/
|
|
__syscall void sys_rand_get(void *dst, size_t len);
|
|
|
|
/**
|
|
* @brief Fill the destination buffer with cryptographically secure
|
|
* random data values.
|
|
*
|
|
* @note If the random values requested do not need to be cryptographically
|
|
* secure then use sys_rand_get() instead.
|
|
*
|
|
* @param [out] dst destination buffer to fill.
|
|
* @param len size of the destination buffer.
|
|
*
|
|
* @return 0 if success, -EIO if entropy reseed error
|
|
*
|
|
*/
|
|
__syscall int sys_csrand_get(void *dst, size_t len);
|
|
|
|
/**
|
|
* @brief Return a 8-bit random value that should pass general
|
|
* randomness tests.
|
|
*
|
|
* @note The random value returned is not a cryptographically secure
|
|
* random number value.
|
|
*
|
|
* @return 8-bit random value.
|
|
*/
|
|
static inline uint8_t sys_rand8_get(void)
|
|
{
|
|
uint8_t ret;
|
|
|
|
sys_rand_get(&ret, sizeof(ret));
|
|
|
|
return ret;
|
|
}
|
|
|
|
/**
|
|
* @brief Return a 16-bit random value that should pass general
|
|
* randomness tests.
|
|
*
|
|
* @note The random value returned is not a cryptographically secure
|
|
* random number value.
|
|
*
|
|
* @return 16-bit random value.
|
|
*/
|
|
static inline uint16_t sys_rand16_get(void)
|
|
{
|
|
uint16_t ret;
|
|
|
|
sys_rand_get(&ret, sizeof(ret));
|
|
|
|
return ret;
|
|
}
|
|
|
|
/**
|
|
* @brief Return a 32-bit random value that should pass general
|
|
* randomness tests.
|
|
*
|
|
* @note The random value returned is not a cryptographically secure
|
|
* random number value.
|
|
*
|
|
* @return 32-bit random value.
|
|
*/
|
|
static inline uint32_t sys_rand32_get(void)
|
|
{
|
|
uint32_t ret;
|
|
|
|
sys_rand_get(&ret, sizeof(ret));
|
|
|
|
return ret;
|
|
}
|
|
|
|
/**
|
|
* @brief Return a 64-bit random value that should pass general
|
|
* randomness tests.
|
|
*
|
|
* @note The random value returned is not a cryptographically secure
|
|
* random number value.
|
|
*
|
|
* @return 64-bit random value.
|
|
*/
|
|
static inline uint64_t sys_rand64_get(void)
|
|
{
|
|
uint64_t ret;
|
|
|
|
sys_rand_get(&ret, sizeof(ret));
|
|
|
|
return ret;
|
|
}
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#include <zephyr/syscalls/random.h>
|
|
#endif /* ZEPHYR_INCLUDE_RANDOM_RANDOM_H_ */
|