#include <sf_crypto_trng_api.h>

Data Fields
ssp_err_t(*	open )(sf_crypto_trng_ctrl_t const p_ctrl, sf_crypto_trng_cfg_t const const p_cfg)

ssp_err_t(*	close )(sf_crypto_trng_ctrl_t *const p_ctrl)

ssp_err_t(*	randomNumberGenerate )(sf_crypto_trng_ctrl_t const p_ctrl, sf_crypto_data_handle_t const p_random_number_buff)

ssp_err_t(*	versionGet )(ssp_version_t *const p_version)

Detailed Description

Shared Interface definition for the SSP Crypto framework

Field Documentation

ssp_err_t(* sf_crypto_trng_api_t::close) (sf_crypto_trng_ctrl_t *const p_ctrl)

Close SSP Crypto TRNG framework. This API should be called once TRNG services are no longer needed.

Implemented as

Parameters

[in,out] p_ctrl_api Pointer to Crypto TRNG Framework control block structure.

ssp_err_t(* sf_crypto_trng_api_t::open) (sf_crypto_trng_ctrl_t *const p_ctrl, sf_crypto_trng_cfg_t const *const p_cfg)

Open SSP Crypto TRNG framework for true random number generation.

Implemented as

Parameters

[in,out]	p_ctrl_api	Pointer to Crypto TRNG Framework control block structure.
[in]	p_cfg	Pointer to sf_crypto_trng_cfg_t configuration structure. All elements of this structure must be set by user.

ssp_err_t(* sf_crypto_trng_api_t::randomNumberGenerate) (sf_crypto_trng_ctrl_t *const p_ctrl, sf_crypto_data_handle_t *const p_random_number_buff)

Generate a True Random Number of specified size

Implemented as

Parameters

[in]	p_ctrl_api	Pointer to Crypto TRNG Framework control block structure.
[in,out]	p_random_number_buff	Pointer to sf_crypto_data_handle_t structure storing pointer to buffer and its size where true random number will be returned.

Note: Size value specified under p_random_number_buff must be specified in Bytes.; Size value specified under p_random_number_buff must not be 0 Bytes. Its minimum value is 1.; Pointer to data buffer specified under p_random_number_buff must not be NULL.; Data buffer must be WORD aligned. The memory allocation to store the true random number is user's responsibility.

ssp_err_t(* sf_crypto_trng_api_t::versionGet) (ssp_version_t *const p_version)

Get version of SSP Crypto TRNG Framework Module.

Implemented as

Parameters

[out] p_version Pointer to the memory to store the module version.

The documentation for this struct was generated from the following file: