VSF Documented
Macros | Functions
rng_common.c File Reference
#include "hal/driver/driver.h"

Macros

#define VSF_RNG_CFG_FUNCTION_RENAME   DISABLED
 

Functions

vsf_err_t vsf_rng_init (vsf_rng_t *rng_ptr)
 Initialize a RNG instance.
 
void vsf_rng_fini (vsf_rng_t *rng_ptr)
 Finalize a RNG instance.
 
vsf_err_t vsf_rng_generate_request (vsf_rng_t *rng_ptr, uint32_t *buffer, uint32_t num, void *param, vsf_rng_on_ready_callback_t *on_ready_cb)
 RNG generate request.
 
vsf_rng_capability_t vsf_rng_capability (vsf_rng_t *rng_ptr)
 Get the capability of RNG instance.
 

Macro Definition Documentation

◆ VSF_RNG_CFG_FUNCTION_RENAME

#define VSF_RNG_CFG_FUNCTION_RENAME   DISABLED

Function Documentation

◆ vsf_rng_init()

vsf_err_t vsf_rng_init ( vsf_rng_t rng_ptr)

Initialize a RNG instance.

Parameters
[in]rng_ptra pointer to structure vsf_rng_t
Returns
vsf_err_t: VSF_ERR_NONE if initialization successful, otherwise returns error code
Note
It is not necessary to call vsf_rng_fini() to deinitialize. vsf_rng_init() should be called before any other RNG API except vsf_rng_capability().

◆ vsf_rng_fini()

void vsf_rng_fini ( vsf_rng_t rng_ptr)

Finalize a RNG instance.

Parameters
[in]rng_ptra pointer to structure vsf_rng_t
Returns
none

◆ vsf_rng_generate_request()

vsf_err_t vsf_rng_generate_request ( vsf_rng_t rng_ptr,
uint32_t buffer,
uint32_t  num,
void *  param,
vsf_rng_on_ready_callback_t on_ready_cb 
)

RNG generate request.

Parameters
[in]rng_ptra pointer to structure vsf_rng_t
[in]bufferRNG data buffer
[in]numthe length of RNG data buffer
[in]paramcallback parameter
[in]on_ready_cbcallback function
Returns
vsf_err_t: VSF_ERR_NONE if the request was successful, otherwise returns error code

◆ vsf_rng_capability()

vsf_rng_capability_t vsf_rng_capability ( vsf_rng_t rng_ptr)

Get the capability of RNG instance.

Parameters
[in]rng_ptra pointer to structure vsf_rng_t
Returns
vsf_rng_capability_t: All capabilities of current RNG vsf_rng_capability_t
Generated from commit: vsfteam/vsf@2b286be