tm_stm32_rng.h

00001 /**
00002  * @author  Tilen Majerle
00003  * @email   tilen@majerle.eu
00004  * @website http://stm32f4-discovery.com
00005  * @link    http://stm32f4-discovery.com/2015/07/hal-library-18-rng-for-stm32fxxx/
00006  * @version v1.0
00007  * @ide     Keil uVision
00008  * @license GNU GPL v3
00009  * @brief   Library template 
00010  *  
00011 \verbatim
00012    ----------------------------------------------------------------------
00013     Copyright (C) Tilen Majerle, 2015
00014     
00015     This program is free software: you can redistribute it and/or modify
00016     it under the terms of the GNU General Public License as published by
00017     the Free Software Foundation, either version 3 of the License, or
00018     any later version.
00019      
00020     This program is distributed in the hope that it will be useful,
00021     but WITHOUT ANY WARRANTY; without even the implied warranty of
00022     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00023     GNU General Public License for more details.
00024     
00025     You should have received a copy of the GNU General Public License
00026     along with this program.  If not, see <http://www.gnu.org/licenses/>.
00027    ----------------------------------------------------------------------
00028 \endverbatim
00029  */
00030 #ifndef TM_RNG_H
00031 #define TM_RNG_H 100
00032 
00033 /* C++ detection */
00034 #ifdef __cplusplus
00035 extern "C" {
00036 #endif
00037 
00038 /**
00039  * @addtogroup TM_STM32Fxxx_HAL_Libraries
00040  * @{
00041  */
00042 
00043 /**
00044  * @defgroup TM_RNG
00045  * @brief    Random number generator library for STM32Fxxx devices - http://stm32f4-discovery.com/2015/07/hal-library-18-rng-for-stm32fxxx/
00046  * @{
00047  *
00048  * \par Changelog
00049  *
00050 \verbatim
00051  Version 1.0
00052   - First release
00053 \endverbatim
00054  *
00055  * \par Dependencies
00056  *
00057 \verbatim
00058  - STM32Fxxx HAL
00059  - defines.h
00060 \endverbatim
00061  */
00062 #include "stm32fxxx_hal.h"
00063 #include "defines.h"
00064 
00065 /**
00066  * @defgroup TM_RNG_Functions
00067  * @brief    Library Functions
00068  * @{
00069  */
00070 
00071 /**
00072  * @brief  Initializes RNG peripheral and enables clock
00073  * @param  None
00074  * @retval None
00075  */
00076 void TM_RNG_Init(void);
00077 
00078 /**
00079  * @brief  De initializes RNG peripheral and disables clock
00080  * @param  None
00081  * @retval None
00082  */
00083 void TM_RNG_DeInit(void);
00084 
00085 /**
00086  * @brief  Gets 32-bit random number
00087  * @param  None
00088  * @retval 32-bit random number
00089  */
00090 uint32_t TM_RNG_Get(void);
00091 
00092 /**
00093  * @}
00094  */
00095  
00096 /**
00097  * @}
00098  */
00099  
00100 /**
00101  * @}
00102  */
00103 
00104 /* C++ detection */
00105 #ifdef __cplusplus
00106 }
00107 #endif
00108 
00109 #endif