Peripheral Control functions

Management functions. More...

Functions
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...

Detailed Description

Management functions.

 ===============================================================================
                      ##### Peripheral Control functions #####
 ===============================================================================  
    [..]  This section provides functions allowing to:
      (+) Get the 32 bit Random number
      (+) Get the 32 bit Random number with interrupt enabled
      (+) Handle RNG interrupt request 

Function Documentation

HAL_RNG_ErrorCallback()

__weak void HAL_RNG_ErrorCallback

(

RNG_HandleTypeDef *

hrng

)

RNG error callback.

Parameters

hrng	pointer to a RNG_HandleTypeDef structure.

Return values

None

Definition at line 780 of file stm32l4xx_hal_rng.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hrng);

  /* NOTE : This function should not be modified. When the callback is needed,
            function HAL_RNG_ErrorCallback must be implemented in the user file.
   */
}

HAL_RNG_GenerateRandomNumber()

HAL_StatusTypeDef HAL_RNG_GenerateRandomNumber	(	RNG_HandleTypeDef *	hrng,
		uint32_t *	random32bit
	)

Generate a 32-bit random number.

Note

Each time the random number data is read the RNG_FLAG_DRDY flag is automatically cleared.

Parameters

hrng	pointer to a RNG_HandleTypeDef structure.
random32bit	pointer to generated random number variable if successful.

Return values

HAL

status

Definition at line 552 of file stm32l4xx_hal_rng.c.

{
  uint32_t tickstart = 0;    
  HAL_StatusTypeDef status = HAL_OK;

  /* Process Locked */
  __HAL_LOCK(hrng); 
  
  /* Check RNS peripheral state */
  if(hrng->State == HAL_RNG_STATE_READY)
  {
    /* Change RNG peripheral state */  
    hrng->State = HAL_RNG_STATE_BUSY;  

    /* Get tick */
    tickstart = HAL_GetTick();
  
    /* Check if data register contains valid random data */
    while(__HAL_RNG_GET_FLAG(hrng, RNG_FLAG_DRDY) == RESET)
    {
      if((HAL_GetTick() - tickstart ) > RNG_TIMEOUT_VALUE)
      {    
        hrng->State = HAL_RNG_STATE_ERROR;

        /* Process Unlocked */
        __HAL_UNLOCK(hrng);
      
        return HAL_TIMEOUT;
      } 
    }
  
    /* Get a 32bit Random number */
    hrng->RandomNumber = hrng->Instance->DR;
    *random32bit = hrng->RandomNumber;
  
    hrng->State = HAL_RNG_STATE_READY;
  }
  else
  {
    status = HAL_ERROR;
  }
  
  /* Process Unlocked */
  __HAL_UNLOCK(hrng);

  return status;
}

HAL_RNG_GenerateRandomNumber_IT()

HAL_StatusTypeDef HAL_RNG_GenerateRandomNumber_IT

(

RNG_HandleTypeDef *

hrng

)

Generate a 32-bit random number in interrupt mode.

Parameters

hrng	pointer to a RNG_HandleTypeDef structure.

Return values

HAL

status

Definition at line 605 of file stm32l4xx_hal_rng.c.

{
  HAL_StatusTypeDef status = HAL_OK;
  
  /* Process Locked */
  __HAL_LOCK(hrng);
  
  /* Check RNG peripheral state */
  if(hrng->State == HAL_RNG_STATE_READY)
  {
    /* Change RNG peripheral state */  
    hrng->State = HAL_RNG_STATE_BUSY;  
  
    /* Process Unlocked */
    __HAL_UNLOCK(hrng);
    
    /* Enable the RNG Interrupts: Data Ready, Clock error, Seed error */ 
    __HAL_RNG_ENABLE_IT(hrng);
  }
  else
  {
    /* Process Unlocked */
    __HAL_UNLOCK(hrng);
    
    status = HAL_ERROR;
  }
  
  return status;
}

HAL_RNG_GetRandomNumber()

uint32_t HAL_RNG_GetRandomNumber

(

RNG_HandleTypeDef *

hrng

)

Return generated random number in polling mode (Obsolete).

Note

Use HAL_RNG_GenerateRandomNumber() API instead.

Parameters

hrng	pointer to a RNG_HandleTypeDef structure that contains the configuration information for RNG.

Return values

random

value

Definition at line 707 of file stm32l4xx_hal_rng.c.

{
  if(HAL_RNG_GenerateRandomNumber(hrng, &(hrng->RandomNumber)) == HAL_OK)
  {
    return hrng->RandomNumber; 
  }
  else
  {
    return 0;
  }
}

HAL_RNG_GetRandomNumber_IT()

uint32_t HAL_RNG_GetRandomNumber_IT

(

RNG_HandleTypeDef *

hrng

)

Return a 32-bit random number with interrupt enabled (Obsolete).

Note

Use HAL_RNG_GenerateRandomNumber_IT() API instead.

Parameters

hrng	RNG handle

Return values

32-bit

random number

Definition at line 726 of file stm32l4xx_hal_rng.c.

{
  uint32_t random32bit = 0;
  
  /* Process locked */
  __HAL_LOCK(hrng);
  
  /* Change RNG peripheral state */  
  hrng->State = HAL_RNG_STATE_BUSY;  
  
  /* Get a 32bit Random number */ 
  random32bit = hrng->Instance->DR;
  
  /* Enable the RNG Interrupts: Data Ready, Clock error, Seed error */ 
  __HAL_RNG_ENABLE_IT(hrng); 
  
  /* Return the 32 bit random number */   
  return random32bit;
}

HAL_RNG_IRQHandler()

void HAL_RNG_IRQHandler

(

RNG_HandleTypeDef *

hrng

)

Handle RNG interrupt request.

Note

In the case of a clock error, the RNG is no more able to generate random numbers because the PLL48CLK clock is not correct. User has to check that the clock controller is correctly configured to provide the RNG clock and clear the CEIS bit using __HAL_RNG_CLEAR_IT(). The clock error has no impact on the previously generated random numbers, and the RNG_DR register contents can be used.

In the case of a seed error, the generation of random numbers is interrupted as long as the SECS bit is '1'. If a number is available in the RNG_DR register, it must not be used because it may not have enough entropy. In this case, it is recommended to clear the SEIS bit using __HAL_RNG_CLEAR_IT(), then disable and enable the RNG peripheral to reinitialize and restart the RNG.

RNG ErrorCallback() API is called once whether SEIS or CEIS are set.

Parameters

hrng	pointer to a RNG_HandleTypeDef structure.

Return values

None

Definition at line 654 of file stm32l4xx_hal_rng.c.

{
  /* RNG clock error interrupt occurred */
  if((__HAL_RNG_GET_IT(hrng, RNG_IT_CEI) != RESET) ||  (__HAL_RNG_GET_IT(hrng, RNG_IT_SEI) != RESET))
  { 
    /* Change RNG peripheral state */
    hrng->State = HAL_RNG_STATE_ERROR;
  
#if (USE_HAL_RNG_REGISTER_CALLBACKS == 1)
    /* Call registered Error callback */
    hrng->ErrorCallback(hrng);
#else
    /* Call legacy weak Error callback */
    HAL_RNG_ErrorCallback(hrng);
#endif /* USE_HAL_RNG_REGISTER_CALLBACKS */
    
    /* Clear the clock error flag */
    __HAL_RNG_CLEAR_IT(hrng, RNG_IT_CEI|RNG_IT_SEI);
    
  }
  
  /* Check RNG data ready interrupt occurred */    
  if(__HAL_RNG_GET_IT(hrng, RNG_IT_DRDY) != RESET)
  {
    /* Generate random number once, so disable the IT */
    __HAL_RNG_DISABLE_IT(hrng);
    
    /* Get the 32bit Random number (DRDY flag automatically cleared) */ 
    hrng->RandomNumber = hrng->Instance->DR;
    
    if(hrng->State != HAL_RNG_STATE_ERROR)
    {
      /* Change RNG peripheral state */
      hrng->State = HAL_RNG_STATE_READY; 
      
#if (USE_HAL_RNG_REGISTER_CALLBACKS == 1)
      /* Call registered Data Ready callback */
      hrng->ReadyDataCallback(hrng, hrng->RandomNumber);
#else
      /* Call legacy weak Data Ready callback */ 
      HAL_RNG_ReadyDataCallback(hrng, hrng->RandomNumber);
#endif /* USE_HAL_RNG_REGISTER_CALLBACKS */
    } 
  }
} 

HAL_RNG_ReadLastRandomNumber()

uint32_t HAL_RNG_ReadLastRandomNumber

(

RNG_HandleTypeDef *

hrng

)

Read latest generated random number.

Parameters

hrng	pointer to a RNG_HandleTypeDef structure.

Return values

random

value

Definition at line 753 of file stm32l4xx_hal_rng.c.

{
  return(hrng->RandomNumber);
}

HAL_RNG_ReadyDataCallback()

__weak void HAL_RNG_ReadyDataCallback	(	RNG_HandleTypeDef *	hrng,
		uint32_t	random32bit
	)

Data Ready callback in non-blocking mode.

Parameters

hrng	pointer to a RNG_HandleTypeDef structure.
random32bit	generated random value

Return values

None

Definition at line 764 of file stm32l4xx_hal_rng.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hrng);
  UNUSED(random32bit);

  /* NOTE : This function should not be modified. When the callback is needed,
            function HAL_RNG_ReadyDataCallback must be implemented in the user file.
   */
}