blob: 157993d936b4a4173b3d461edefde80a2982cfca [file] [log] [blame]
/* ----------------------------------------------------------------------------
* SAM Software Package License
* ----------------------------------------------------------------------------
* Copyright (c) 2015, Atmel Corporation
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the disclaimer below.
*
* Atmel's name may not be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
* DISCLAIMED. IN NO EVENT SHALL ATMEL 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.
* ----------------------------------------------------------------------------
*/
#ifndef _TRNG_H_
#define _TRNG_H_
/*------------------------------------------------------------------------------
* Headers
*------------------------------------------------------------------------------*/
#include <stdint.h>
#include "chip.h"
/*------------------------------------------------------------------------------
* Types
*------------------------------------------------------------------------------*/
typedef void (*trng_callback_t)(uint32_t random_value, void* user_arg);
/*------------------------------------------------------------------------------
* Exported functions
*------------------------------------------------------------------------------*/
/**
* \brief Enables the TRNG.
*/
extern void trng_enable(void);
/**
* \brief Disables the TRNG.
*/
extern void trng_disable(void);
/**
* \brief Enable the TRNG interrupt, the callback will be called for each new
* generated random value.
*
* \param cb user callback
* \param user_arg user argument passed as-is to the callback
*/
extern void trng_enable_it(trng_callback_t cb, void* user_arg);
/**
* \brief Disable the TRNG interrupt.
*/
extern void trng_disable_it(void);
/**
* \brief Get the next random value generated by the TRNG. This function will
* block until a value is available.
* \return a random value
*/
extern uint32_t trng_get_random_data(void);
#endif /* _TRNG_H_ */