STM32L4xx_HAL_Driver  1.14.0
stm32l4xx_hal_rng.h File Reference

Header file of RNG HAL module. More...

Go to the source code of this file.

Data Structures

struct  __RNG_HandleTypeDef
 RNG Handle Structure definition. More...
 

Typedefs

typedef struct __RNG_HandleTypeDef RNG_HandleTypeDef
 RNG Handle Structure definition. More...
 
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 = 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. More...
 
HAL_StatusTypeDef HAL_RNG_DeInit (RNG_HandleTypeDef *hrng)
 DeInitialize the RNG peripheral. More...
 
void HAL_RNG_MspInit (RNG_HandleTypeDef *hrng)
 Initialize the RNG MSP. More...
 
void HAL_RNG_MspDeInit (RNG_HandleTypeDef *hrng)
 DeInitialize 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 callabck 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)
 Return generated random number in polling mode (Obsolete). More...
 
uint32_t HAL_RNG_GetRandomNumber_IT (RNG_HandleTypeDef *hrng)
 Return a 32-bit random number with interrupt enabled (Obsolete). More...
 
HAL_StatusTypeDef HAL_RNG_GenerateRandomNumber (RNG_HandleTypeDef *hrng, uint32_t *random32bit)
 Generate a 32-bit random number. More...
 
HAL_StatusTypeDef HAL_RNG_GenerateRandomNumber_IT (RNG_HandleTypeDef *hrng)
 Generate a 32-bit random number in interrupt mode. More...
 
uint32_t HAL_RNG_ReadLastRandomNumber (RNG_HandleTypeDef *hrng)
 Read latest generated random number. More...
 
void HAL_RNG_IRQHandler (RNG_HandleTypeDef *hrng)
 Handle RNG interrupt request. More...
 
void HAL_RNG_ErrorCallback (RNG_HandleTypeDef *hrng)
 RNG error callback. 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 (RNG_HandleTypeDef *hrng)
 Return the RNG handle state. More...
 
uint32_t HAL_RNG_GetError (RNG_HandleTypeDef *hrng)
 Return the RNG handle error code. More...
 

Variables

 C
 

Detailed Description

Header file of RNG HAL module.

Author
MCD Application Team
Attention

© Copyright (c) 2017 STMicroelectronics. All rights reserved.

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32l4xx_hal_rng.h.

Typedef Documentation

◆ pRNG_CallbackTypeDef

typedef void(* pRNG_CallbackTypeDef) (RNG_HandleTypeDef *hrng)

HAL RNG Callback pointer definition.

pointer to a common RNG callback function

Definition at line 112 of file stm32l4xx_hal_rng.h.

◆ pRNG_ReadyDataCallbackTypeDef

typedef void(* pRNG_ReadyDataCallbackTypeDef) (RNG_HandleTypeDef *hrng, uint32_t random32bit)

pointer to an RNG Data Ready specific callback function

Definition at line 113 of file stm32l4xx_hal_rng.h.

◆ RNG_HandleTypeDef

RNG Handle Structure definition.

Enumeration Type Documentation

◆ HAL_RNG_CallbackIDTypeDef

HAL RNG Callback ID enumeration definition.

Enumerator
HAL_RNG_ERROR_CB_ID 

RNG Error Callback ID

HAL_RNG_MSPINIT_CB_ID 

RNG MspInit callback ID

HAL_RNG_MSPDEINIT_CB_ID 

RNG MspDeInit callback ID

Definition at line 100 of file stm32l4xx_hal_rng.h.

101 {
102  HAL_RNG_ERROR_CB_ID = 0x00U,
104  HAL_RNG_MSPINIT_CB_ID = 0x01U,
105  HAL_RNG_MSPDEINIT_CB_ID = 0x02U
HAL_RNG_CallbackIDTypeDef
HAL RNG Callback ID enumeration definition.

◆ HAL_RNG_StateTypeDef

RNG HAL State Structure definition.

Enumerator
HAL_RNG_STATE_RESET 

RNG not yet initialized or disabled

HAL_RNG_STATE_READY 

RNG initialized and ready for use

HAL_RNG_STATE_BUSY 

RNG internal process is ongoing

HAL_RNG_STATE_TIMEOUT 

RNG timeout state

HAL_RNG_STATE_ERROR 

RNG error state

Definition at line 57 of file stm32l4xx_hal_rng.h.

Variable Documentation

◆ C

C
Initial value:
{
#endif
#if defined(RNG_CR_CED)
typedef struct
{
uint32_t ClockErrorDetection;
}RNG_InitTypeDef
This file contains HAL common defines, enumeration, macros and structures definitions.