STM32F4xx_HAL_Driver  1.8.3
stm32f4xx_hal_rng.h File Reference

Header file of RNG HAL module. More...

Go to the source code of this file.

Data Structures

struct  endif
 ADC handle Structure definition. More...
 

Typedefs

typedef struct __RNG_HandleTypeDef else typedef struct endif RNG_HandleTypeDef
 
typedef void(* pRNG_CallbackTypeDef) (RNG_HandleTypeDef *hrng)
 HAL RNG Callback pointer definition. More...
 
typedef void(* pRNG_ReadyDataCallbackTypeDef) (RNG_HandleTypeDef *hrng, uint32_t random32bit)
 

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
}
 
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)
 Initializes the RNG peripheral and creates the associated handle. More...
 
HAL_StatusTypeDef HAL_RNG_DeInit (RNG_HandleTypeDef *hrng)
 DeInitializes the RNG peripheral. More...
 
void HAL_RNG_MspInit (RNG_HandleTypeDef *hrng)
 Initializes the RNG MSP. More...
 
void HAL_RNG_MspDeInit (RNG_HandleTypeDef *hrng)
 DeInitializes the RNG MSP. More...
 
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. More...
 
HAL_StatusTypeDef HAL_RNG_UnRegisterCallback (RNG_HandleTypeDef *hrng, HAL_RNG_CallbackIDTypeDef CallbackID)
 Unregister an RNG Callback RNG callback is redirected to the weak predefined callback. More...
 
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. More...
 
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. More...
 
uint32_t HAL_RNG_GetRandomNumber (RNG_HandleTypeDef *hrng)
 Returns generated random number in polling mode (Obsolete) Use HAL_RNG_GenerateRandomNumber() API instead. More...
 
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. More...
 
HAL_StatusTypeDef HAL_RNG_GenerateRandomNumber (RNG_HandleTypeDef *hrng, uint32_t *random32bit)
 Generates a 32-bit random number. More...
 
HAL_StatusTypeDef HAL_RNG_GenerateRandomNumber_IT (RNG_HandleTypeDef *hrng)
 Generates a 32-bit random number in interrupt mode. More...
 
uint32_t HAL_RNG_ReadLastRandomNumber (const RNG_HandleTypeDef *hrng)
 Read latest generated random number. More...
 
void HAL_RNG_IRQHandler (RNG_HandleTypeDef *hrng)
 Handles RNG interrupt request. More...
 
void HAL_RNG_ErrorCallback (RNG_HandleTypeDef *hrng)
 RNG error callbacks. More...
 
void HAL_RNG_ReadyDataCallback (RNG_HandleTypeDef *hrng, uint32_t random32bit)
 Data Ready callback in non-blocking mode. More...
 
HAL_RNG_StateTypeDef HAL_RNG_GetState (const RNG_HandleTypeDef *hrng)
 Returns the RNG state. More...
 
uint32_t HAL_RNG_GetError (const RNG_HandleTypeDef *hrng)
 Return the RNG handle error code. More...
 

Detailed Description

Header file of RNG HAL module.

Author
MCD Application Team
Attention

Copyright (c) 2016 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32f4xx_hal_rng.h.