nrf_drv_rng.h 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  1. /**
  2. * Copyright (c) 2016 - 2018, Nordic Semiconductor ASA
  3. *
  4. * All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  9. * 1. Redistributions of source code must retain the above copyright notice, this
  10. * list of conditions and the following disclaimer.
  11. *
  12. * 2. Redistributions in binary form, except as embedded into a Nordic
  13. * Semiconductor ASA integrated circuit in a product or a software update for
  14. * such product, must reproduce the above copyright notice, this list of
  15. * conditions and the following disclaimer in the documentation and/or other
  16. * materials provided with the distribution.
  17. *
  18. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  19. * contributors may be used to endorse or promote products derived from this
  20. * software without specific prior written permission.
  21. *
  22. * 4. This software, with or without modification, must only be used with a
  23. * Nordic Semiconductor ASA integrated circuit.
  24. *
  25. * 5. Any software provided in binary form under this license must not be reverse
  26. * engineered, decompiled, modified and/or disassembled.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  29. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  31. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  32. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  34. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  37. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38. *
  39. */
  40. #ifndef NRF_DRV_RNG_H__
  41. #define NRF_DRV_RNG_H__
  42. #include <nrfx_rng.h>
  43. #ifdef __cplusplus
  44. extern "C" {
  45. #endif
  46. /**
  47. * @defgroup nrf_drv_rng RNG driver - legacy layer
  48. * @{
  49. * @ingroup nrf_rng
  50. *
  51. * @brief Layer providing compatibility with the former API.
  52. */
  53. /** @brief Type definition for forwarding the new implementation. */
  54. typedef nrfx_rng_config_t nrf_drv_rng_config_t;
  55. /** @brief Macro for forwarding the new implementation. */
  56. #define NRF_DRV_RNG_DEFAULT_CONFIG NRFX_RNG_DEFAULT_CONFIG
  57. /**
  58. * @brief Function for initializing the nrf_drv_rng module.
  59. *
  60. * @param[in] p_config Initial configuration.
  61. *
  62. * @retval NRF_SUCCESS Driver was successfully initialized.
  63. * @retval NRF_ERROR_MODULE_ALREADY_INITIALIZED Driver was already initialized.
  64. */
  65. ret_code_t nrf_drv_rng_init(nrf_drv_rng_config_t const * p_config);
  66. /**
  67. * @brief Function for uninitializing the nrf_drv_rng module.
  68. */
  69. void nrf_drv_rng_uninit(void);
  70. /**
  71. * @brief Function for getting the number of currently available random bytes.
  72. *
  73. * @param[out] p_bytes_available The number of bytes currently available in the pool.
  74. */
  75. void nrf_drv_rng_bytes_available(uint8_t * p_bytes_available);
  76. /**
  77. * @brief Function for getting the vector of random numbers.
  78. *
  79. * @param[out] p_buff Pointer to uint8_t buffer for storing the bytes.
  80. * @param[in] length Number of bytes to take from the pool and place in p_buff.
  81. *
  82. * @retval NRF_SUCCESS If the requested bytes were written to p_buff.
  83. * @retval NRF_ERROR_NOT_FOUND If no bytes were written to the buffer because there were
  84. * not enough bytes available in the pool.
  85. */
  86. ret_code_t nrf_drv_rng_rand(uint8_t * p_buff, uint8_t length);
  87. /**
  88. * @brief Blocking function for getting an arbitrary array of random numbers.
  89. *
  90. * @note This function may execute for a substantial amount of time depending on the length
  91. * of the buffer required and on the state of the current internal pool of random numbers.
  92. *
  93. * @param[out] p_buff Pointer to uint8_t buffer for storing the bytes.
  94. * @param[in] length Number of bytes place in p_buff.
  95. */
  96. void nrf_drv_rng_block_rand(uint8_t * p_buff, uint32_t length);
  97. /** @} */
  98. #ifdef __cplusplus
  99. }
  100. #endif
  101. #endif // NRF_DRV_RNG_H__