stm32l4xx_hal_rng.h File Reference

Header file of RNG HAL module. More...

#include "stm32l4xx_hal_def.h"

Go to the source code of this file.

Data Structures
struct	__RNG_HandleTypeDef
	RNG Handle Structure definition. More...
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_ERROR_NONE   ((uint32_t)0x00000000U)
#define	HAL_RNG_ERROR_INVALID_CALLBACK   ((uint32_t)0x00000001U)
#define	__HAL_RNG_RESET_HANDLE_STATE(__HANDLE__)
	Reset RNG handle state.
#define	__HAL_RNG_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR |= RNG_CR_RNGEN)
	Enable the RNG peripheral.
#define	__HAL_RNG_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR &= ~RNG_CR_RNGEN)
	Disable the RNG peripheral.
#define	__HAL_RNG_GET_FLAG(__HANDLE__, __FLAG__)   (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
	Check whether the specified RNG flag is set or not.
#define	__HAL_RNG_CLEAR_FLAG(__HANDLE__, __FLAG__)   /* dummy macro */
	Clear the selected RNG flag status.
#define	__HAL_RNG_ENABLE_IT(__HANDLE__)   ((__HANDLE__)->Instance->CR |= RNG_CR_IE)
	Enable the RNG interrupt.
#define	__HAL_RNG_DISABLE_IT(__HANDLE__)   ((__HANDLE__)->Instance->CR &= ~RNG_CR_IE)
	Disable the RNG interrupt.
#define	__HAL_RNG_GET_IT(__HANDLE__, __INTERRUPT__)   (((__HANDLE__)->Instance->SR & (__INTERRUPT__)) == (__INTERRUPT__))
	Check 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.
Typedefs
typedef struct __RNG_HandleTypeDef	RNG_HandleTypeDef
	RNG Handle Structure definition.
typedef void(*	pRNG_CallbackTypeDef )(RNG_HandleTypeDef *hrng)
	HAL RNG Callback pointer definition.
typedef void(*	pRNG_ReadyDataCallbackTypeDef )(RNG_HandleTypeDef *hrng, uint32_t random32bit)
Enumerations
enum	HAL_RNG_StateTypeDef {   HAL_RNG_STATE_RESET = 0x00, HAL_RNG_STATE_READY = 0x01, HAL_RNG_STATE_BUSY = 0x02, HAL_RNG_STATE_TIMEOUT = 0x03,   HAL_RNG_STATE_ERROR = 0x04 }
	RNG HAL State Structure definition. More...
enum	HAL_RNG_CallbackIDTypeDef { HAL_RNG_ERROR_CB_ID = 0x00U, HAL_RNG_MSPINIT_CB_ID = 0x01U, HAL_RNG_MSPDEINIT_CB_ID = 0x02U }
	HAL RNG Callback ID enumeration definition. More...
Functions
HAL_StatusTypeDef	HAL_RNG_Init (RNG_HandleTypeDef *hrng)
	Initialize the RNG peripheral and initialize the associated handle.
HAL_StatusTypeDef	HAL_RNG_DeInit (RNG_HandleTypeDef *hrng)
	DeInitialize the RNG peripheral.
__weak void	HAL_RNG_MspInit (RNG_HandleTypeDef *hrng)
	Initialize the RNG MSP.
__weak void	HAL_RNG_MspDeInit (RNG_HandleTypeDef *hrng)
	DeInitialize the RNG MSP.
HAL_StatusTypeDef	HAL_RNG_RegisterCallback (RNG_HandleTypeDef *hrng, HAL_RNG_CallbackIDTypeDef CallbackID, pRNG_CallbackTypeDef pCallback)
	Register a User RNG Callback To be used instead of the weak predefined callback.
HAL_StatusTypeDef	HAL_RNG_UnRegisterCallback (RNG_HandleTypeDef *hrng, HAL_RNG_CallbackIDTypeDef CallbackID)
	Unregister an RNG Callback RNG callabck is redirected to the weak predefined callback.
HAL_StatusTypeDef	HAL_RNG_RegisterReadyDataCallback (RNG_HandleTypeDef *hrng, pRNG_ReadyDataCallbackTypeDef pCallback)
	Register Data Ready RNG Callback To be used instead of the weak HAL_RNG_ReadyDataCallback() predefined callback.
HAL_StatusTypeDef	HAL_RNG_UnRegisterReadyDataCallback (RNG_HandleTypeDef *hrng)
	UnRegister the Data Ready RNG Callback Data Ready RNG Callback is redirected to the weak HAL_RNG_ReadyDataCallback() predefined callback.
uint32_t	HAL_RNG_GetRandomNumber (RNG_HandleTypeDef *hrng)
	Return generated random number in polling mode (Obsolete).
uint32_t	HAL_RNG_GetRandomNumber_IT (RNG_HandleTypeDef *hrng)
	Return a 32-bit random number with interrupt enabled (Obsolete).
HAL_StatusTypeDef	HAL_RNG_GenerateRandomNumber (RNG_HandleTypeDef *hrng, uint32_t *random32bit)
	Generate a 32-bit random number.
HAL_StatusTypeDef	HAL_RNG_GenerateRandomNumber_IT (RNG_HandleTypeDef *hrng)
	Generate 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)
	Handle RNG interrupt request.
__weak void	HAL_RNG_ErrorCallback (RNG_HandleTypeDef *hrng)
	RNG error callback.
__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)
	Return the RNG handle state.
uint32_t	HAL_RNG_GetError (RNG_HandleTypeDef *hrng)
	Return the RNG handle error code.

---

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 stm32l4xx_hal_rng.h.