stm32f4xx_hal_rng.h File Reference

Header file of RNG HAL module. More...

#include "stm32f4xx_hal_def.h"

Go to the source code of this file.

Data Structures
struct	RNG_HandleTypeDef
Defines
#define	RNG_IT_DRDY   RNG_SR_DRDY
#define	RNG_IT_CEI   RNG_SR_CEIS
#define	RNG_IT_SEI   RNG_SR_SEIS
#define	RNG_FLAG_DRDY   RNG_SR_DRDY
#define	RNG_FLAG_CECS   RNG_SR_CECS
#define	RNG_FLAG_SECS   RNG_SR_SECS
#define	__HAL_RNG_RESET_HANDLE_STATE(__HANDLE__)   ((__HANDLE__)->State = HAL_RNG_STATE_RESET)
	Reset RNG handle state.
#define	__HAL_RNG_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR |= RNG_CR_RNGEN)
	Enables the RNG peripheral.
#define	__HAL_RNG_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR &= ~RNG_CR_RNGEN)
	Disables the RNG peripheral.
#define	__HAL_RNG_GET_FLAG(__HANDLE__, __FLAG__)   (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
	Check the selected RNG flag status.
#define	__HAL_RNG_CLEAR_FLAG(__HANDLE__, __FLAG__)   /* dummy macro */
	Clears the selected RNG flag status.
#define	__HAL_RNG_ENABLE_IT(__HANDLE__)   ((__HANDLE__)->Instance->CR |= RNG_CR_IE)
	Enables the RNG interrupts.
#define	__HAL_RNG_DISABLE_IT(__HANDLE__)   ((__HANDLE__)->Instance->CR &= ~RNG_CR_IE)
	Disables the RNG interrupts.
#define	__HAL_RNG_GET_IT(__HANDLE__, __INTERRUPT__)   (((__HANDLE__)->Instance->SR & (__INTERRUPT__)) == (__INTERRUPT__))
	Checks whether the specified RNG interrupt has occurred or not.
#define	__HAL_RNG_CLEAR_IT(__HANDLE__, __INTERRUPT__)   (((__HANDLE__)->Instance->SR) = ~(__INTERRUPT__))
	Clear the RNG interrupt status flags.
#define	IS_RNG_IT(IT)
#define	IS_RNG_FLAG(FLAG)
Enumerations
enum	HAL_RNG_StateTypeDef {   HAL_RNG_STATE_RESET = 0x00U, HAL_RNG_STATE_READY = 0x01U, HAL_RNG_STATE_BUSY = 0x02U, HAL_RNG_STATE_TIMEOUT = 0x03U,   HAL_RNG_STATE_ERROR = 0x04U }
Functions
HAL_StatusTypeDef	HAL_RNG_Init (RNG_HandleTypeDef *hrng)
	Initializes the RNG peripheral and creates the associated handle.
HAL_StatusTypeDef	HAL_RNG_DeInit (RNG_HandleTypeDef *hrng)
	DeInitializes the RNG peripheral.
__weak void	HAL_RNG_MspInit (RNG_HandleTypeDef *hrng)
	Initializes the RNG MSP.
__weak void	HAL_RNG_MspDeInit (RNG_HandleTypeDef *hrng)
	DeInitializes the RNG MSP.
uint32_t	HAL_RNG_GetRandomNumber (RNG_HandleTypeDef *hrng)
	Returns generated random number in polling mode (Obsolete) Use HAL_RNG_GenerateRandomNumber() API instead.
uint32_t	HAL_RNG_GetRandomNumber_IT (RNG_HandleTypeDef *hrng)
	Returns a 32-bit random number with interrupt enabled (Obsolete), Use HAL_RNG_GenerateRandomNumber_IT() API instead.
HAL_StatusTypeDef	HAL_RNG_GenerateRandomNumber (RNG_HandleTypeDef *hrng, uint32_t *random32bit)
	Generates a 32-bit random number.
HAL_StatusTypeDef	HAL_RNG_GenerateRandomNumber_IT (RNG_HandleTypeDef *hrng)
	Generates a 32-bit random number in interrupt mode.
uint32_t	HAL_RNG_ReadLastRandomNumber (RNG_HandleTypeDef *hrng)
	Read latest generated random number.
void	HAL_RNG_IRQHandler (RNG_HandleTypeDef *hrng)
	Handles RNG interrupt request.
__weak void	HAL_RNG_ErrorCallback (RNG_HandleTypeDef *hrng)
	RNG error callbacks.
__weak void	HAL_RNG_ReadyDataCallback (RNG_HandleTypeDef *hrng, uint32_t random32bit)
	Data Ready callback in non-blocking mode.
HAL_RNG_StateTypeDef	HAL_RNG_GetState (RNG_HandleTypeDef *hrng)
	Returns the RNG state.

---

Detailed Description

Header file of RNG HAL module.

Author:

MCD Application Team

Attention:

© COPYRIGHT(c) 2017 STMicroelectronics

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 STMicroelectronics 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 THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.

Definition in file stm32f4xx_hal_rng.h.