no_os_trng.h File Reference

Header file of true random number generator. More...

#include <stdint.h>

Include dependency graph for no_os_trng.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	no_os_trng_desc
	TRNG Descriptor. More...
struct	no_os_trng_init_param
	Init parameter for TRNG. More...
struct	no_os_trng_platform_ops
	Structure holding TRNG function pointers that point to the platform specific function. More...

Functions
int	no_os_trng_init (struct no_os_trng_desc **desc, const struct no_os_trng_init_param *param)
	Initialize the TRNG. More...
int	no_os_trng_remove (struct no_os_trng_desc *desc)
	Free the resources allocated by no_os_trng_init(). More...
int	no_os_trng_fill_buffer (struct no_os_trng_desc *desc, uint8_t *buff, uint32_t len)
	Fill buffer with rng data. More...

Detailed Description

Header file of true random number generator.

Author

Mihail Chindris (mihai.nosp@m.l.ch.nosp@m.indri.nosp@m.s@an.nosp@m.alog..nosp@m.com)

Copyright

Copyright 2020(c) Analog Devices, Inc.

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 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 Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES, INC. 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.

Function Documentation

no_os_trng_fill_buffer()

int no_os_trng_fill_buffer	(	struct no_os_trng_desc *	desc,
		uint8_t *	buff,
		uint32_t	len
	)

Fill buffer with rng data.

Parameters

desc	- The TRNG descriptor.
buff	- Buffer to be filled
len	- Size of the buffer

Returns

0 in case of success, -1 otherwise.

no_os_trng_init()

int no_os_trng_init	(	struct no_os_trng_desc **	desc,
		const struct no_os_trng_init_param *	param
	)

Initialize the TRNG.

Parameters

desc	- The TRNG descriptor.
param	- The structure that contains the TRNG parameters.

Returns

0 in case of success, -1 otherwise.

no_os_trng_remove()

int no_os_trng_remove

(

struct no_os_trng_desc *

desc

)

Free the resources allocated by no_os_trng_init().

Parameters

desc	- The TRNG descriptor.

Returns

0 in case of success, -1 otherwise.