Initialization and de-initialization functions

Initialization and de-initialization functions. 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...

Detailed Description

Initialization and de-initialization functions.

 ===============================================================================
          ##### Initialization and de-initialization functions #####
 ===============================================================================
    [..]  This section provides functions allowing to:
      (+) Initialize the RNG according to the specified parameters 
          in the RNG_InitTypeDef and create the associated handle
      (+) DeInitialize the RNG peripheral
      (+) Initialize the RNG MSP (MCU Specific Package)
      (+) DeInitialize the RNG MSP 

Function Documentation

HAL_RNG_DeInit()

HAL_StatusTypeDef HAL_RNG_DeInit

(

RNG_HandleTypeDef *

hrng

)

DeInitialize the RNG peripheral.

Parameters

hrng	pointer to a RNG_HandleTypeDef structure.

Return values

HAL

status

Definition at line 221 of file stm32l4xx_hal_rng.c.

{ 
  /* Check the RNG handle allocation */
  if(hrng == NULL)
  {
    return HAL_ERROR;
  }
  
#if defined(RNG_CR_CED)
  /* Clear Clock Error Detection bit */
  CLEAR_BIT(hrng->Instance->CR, RNG_CR_CED);
#endif /* defined(RNG_CR_CED) */

  /* Disable the RNG Peripheral */
  CLEAR_BIT(hrng->Instance->CR, RNG_CR_IE | RNG_CR_RNGEN);

  /* Clear RNG interrupt status flags */
  CLEAR_BIT(hrng->Instance->SR, RNG_SR_CEIS | RNG_SR_SEIS);

#if (USE_HAL_RNG_REGISTER_CALLBACKS == 1)
  if(hrng->MspDeInitCallback == NULL)
  {
    hrng->MspDeInitCallback = HAL_RNG_MspDeInit; /* Legacy weak MspDeInit  */
  }

  /* DeInit the low level hardware */
  hrng->MspDeInitCallback(hrng);
#else
  /* DeInit the low level hardware */
  HAL_RNG_MspDeInit(hrng);
#endif /* USE_HAL_RNG_REGISTER_CALLBACKS */

  /* Update the RNG state */
  hrng->State = HAL_RNG_STATE_RESET; 

  /* Initialise the error code */
  hrng->ErrorCode = HAL_RNG_ERROR_NONE;

  /* Release Lock */
  __HAL_UNLOCK(hrng);

  /* Return the function status */
  return HAL_OK;
}

HAL_RNG_Init()

HAL_StatusTypeDef HAL_RNG_Init

(

RNG_HandleTypeDef *

hrng

)

Initialize the RNG peripheral and initialize the associated handle.

Parameters

hrng	pointer to a RNG_HandleTypeDef structure.

Return values

HAL

status

Definition at line 154 of file stm32l4xx_hal_rng.c.

{ 
  /* Check the RNG handle allocation */
  if(hrng == NULL)
  {
    return HAL_ERROR;
  }

  assert_param(IS_RNG_ALL_INSTANCE(hrng->Instance));
#if defined(RNG_CR_CED)
  assert_param(IS_RNG_CED(hrng->Init.ClockErrorDetection));
#endif /* defined(RNG_CR_CED) */

#if (USE_HAL_RNG_REGISTER_CALLBACKS == 1)
  if(hrng->State == HAL_RNG_STATE_RESET)
  {
    /* Allocate lock resource and initialize it */
    hrng->Lock = HAL_UNLOCKED;

    hrng->ReadyDataCallback  = HAL_RNG_ReadyDataCallback;  /* Legacy weak ReadyDataCallback  */
    hrng->ErrorCallback      = HAL_RNG_ErrorCallback;      /* Legacy weak ErrorCallback      */

    if(hrng->MspInitCallback == NULL)
    {
      hrng->MspInitCallback = HAL_RNG_MspInit; /* Legacy weak MspInit  */
    }

    /* Init the low level hardware */
    hrng->MspInitCallback(hrng);
  }
#else
  if(hrng->State == HAL_RNG_STATE_RESET)
  {  
    /* Allocate lock resource and initialize it */
    hrng->Lock = HAL_UNLOCKED;

    /* Init the low level hardware */
    HAL_RNG_MspInit(hrng);
  }
#endif /* USE_HAL_RNG_REGISTER_CALLBACKS */

  /* Change RNG peripheral state */
  hrng->State = HAL_RNG_STATE_BUSY;

#if defined(RNG_CR_CED)
  /* Clock Error Detection configuration */
  MODIFY_REG(hrng->Instance->CR, RNG_CR_CED, hrng->Init.ClockErrorDetection);
#endif /* defined(RNG_CR_CED) */

  /* Enable the RNG Peripheral */
  __HAL_RNG_ENABLE(hrng);

  /* Initialize the RNG state */
  hrng->State = HAL_RNG_STATE_READY;
  
  /* Initialise the error code */
  hrng->ErrorCode = HAL_RNG_ERROR_NONE;
  
  /* Return function status */
  return HAL_OK;
}

HAL_RNG_MspDeInit()

__weak void HAL_RNG_MspDeInit

(

RNG_HandleTypeDef *

hrng

)

DeInitialize the RNG MSP.

Parameters

hrng	pointer to a RNG_HandleTypeDef structure.

Return values

None

Definition at line 286 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_MspDeInit must be implemented in the user file.
   */
}

HAL_RNG_MspInit()

__weak void HAL_RNG_MspInit

(

RNG_HandleTypeDef *

hrng

)

Initialize the RNG MSP.

Parameters

hrng	pointer to a RNG_HandleTypeDef structure.

Return values

None

Definition at line 271 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_MspInit must be implemented in the user file.
   */
}

HAL_RNG_RegisterCallback()

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.

Parameters

hrng	RNG handle
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_RNG_ERROR_CB_ID Error callback ID HAL_RNG_MSPINIT_CB_ID MspInit callback ID HAL_RNG_MSPDEINIT_CB_ID MspDeInit callback ID
pCallback	pointer to the Callback function

Return values

HAL

status

Definition at line 309 of file stm32l4xx_hal_rng.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  if(pCallback == NULL)
  {
    /* Update the error code */
    hrng->ErrorCode |= HAL_RNG_ERROR_INVALID_CALLBACK;
    return HAL_ERROR;
  }
  /* Process locked */
  __HAL_LOCK(hrng);

  if(HAL_RNG_STATE_READY == hrng->State)
  {
    switch (CallbackID)
    {
    case HAL_RNG_ERROR_CB_ID :
      hrng->ErrorCallback = pCallback;
      break;

    case HAL_RNG_MSPINIT_CB_ID :
      hrng->MspInitCallback = pCallback;
      break;

    case HAL_RNG_MSPDEINIT_CB_ID :
      hrng->MspDeInitCallback = pCallback;
      break;

    default :
      /* Update the error code */
      hrng->ErrorCode |= HAL_RNG_ERROR_INVALID_CALLBACK;
     /* Return error status */
      status =  HAL_ERROR;
      break;
    }
  }
  else if(HAL_RNG_STATE_RESET == hrng->State)
  {
    switch (CallbackID)
    {
    case HAL_RNG_MSPINIT_CB_ID :
      hrng->MspInitCallback = pCallback;
      break;

    case HAL_RNG_MSPDEINIT_CB_ID :
      hrng->MspDeInitCallback = pCallback;
      break;

    default :
      /* Update the error code */
      hrng->ErrorCode |= HAL_RNG_ERROR_INVALID_CALLBACK;
     /* Return error status */
      status =  HAL_ERROR;
      break;
    }
  }
  else
  {
    /* Update the error code */
    hrng->ErrorCode |= HAL_RNG_ERROR_INVALID_CALLBACK;
    /* Return error status */
    status =  HAL_ERROR;
  }

  /* Release Lock */
  __HAL_UNLOCK(hrng);
  return status;
}

HAL_RNG_RegisterReadyDataCallback()

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.

Parameters

hrng	RNG handle
pCallback	pointer to the Data Ready Callback function

Return values

HAL

status

Definition at line 461 of file stm32l4xx_hal_rng.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  if(pCallback == NULL)
  {
    /* Update the error code */
    hrng->ErrorCode |= HAL_RNG_ERROR_INVALID_CALLBACK;
    return HAL_ERROR;
  }
  /* Process locked */
  __HAL_LOCK(hrng);

  if(HAL_RNG_STATE_READY == hrng->State)
  {
    hrng->ReadyDataCallback = pCallback;
  }
  else
  {
    /* Update the error code */
    hrng->ErrorCode |= HAL_RNG_ERROR_INVALID_CALLBACK;
    /* Return error status */
    status =  HAL_ERROR;
  }

  /* Release Lock */
  __HAL_UNLOCK(hrng);
  return status;
}

HAL_RNG_UnRegisterCallback()

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.

Parameters

hrng	RNG handle
CallbackID	ID of the callback to be unregistered This parameter can be one of the following values: HAL_RNG_ERROR_CB_ID Error callback ID HAL_RNG_MSPINIT_CB_ID MspInit callback ID HAL_RNG_MSPDEINIT_CB_ID MspDeInit callback ID

Return values

HAL

status

Definition at line 390 of file stm32l4xx_hal_rng.c.

{
HAL_StatusTypeDef status = HAL_OK;

  /* Process locked */
  __HAL_LOCK(hrng);

  if(HAL_RNG_STATE_READY == hrng->State)
  {
    switch (CallbackID)
    {
    case HAL_RNG_ERROR_CB_ID :
      hrng->ErrorCallback = HAL_RNG_ErrorCallback;          /* Legacy weak ErrorCallback  */
      break;

    case HAL_RNG_MSPINIT_CB_ID :
      hrng->MspInitCallback = HAL_RNG_MspInit;              /* Legacy weak MspInit  */
      break;

    case HAL_RNG_MSPDEINIT_CB_ID :
      hrng->MspDeInitCallback = HAL_RNG_MspDeInit;          /* Legacy weak MspDeInit  */
      break;

    default :
      /* Update the error code */
      hrng->ErrorCode |= HAL_RNG_ERROR_INVALID_CALLBACK;
     /* Return error status */
      status =  HAL_ERROR;
      break;
    }
  }
  else if(HAL_RNG_STATE_RESET == hrng->State)
  {
    switch (CallbackID)
    {
    case HAL_RNG_MSPINIT_CB_ID :
      hrng->MspInitCallback = HAL_RNG_MspInit;              /* Legacy weak MspInit  */
      break;

    case HAL_RNG_MSPDEINIT_CB_ID :
      hrng->MspDeInitCallback = HAL_RNG_MspDeInit;          /* Legacy weak MspInit  */
      break;

    default :
      /* Update the error code */
      hrng->ErrorCode |= HAL_RNG_ERROR_INVALID_CALLBACK;
     /* Return error status */
      status =  HAL_ERROR;
      break;
    }
  }
  else
  {
    /* Update the error code */
    hrng->ErrorCode |= HAL_RNG_ERROR_INVALID_CALLBACK;
    /* Return error status */
    status =  HAL_ERROR;
  }

  /* Release Lock */
  __HAL_UNLOCK(hrng);
  return status;
}

HAL_RNG_UnRegisterReadyDataCallback()

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.

Parameters

hrng	RNG handle

Return values

HAL

status

Definition at line 497 of file stm32l4xx_hal_rng.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  /* Process locked */
  __HAL_LOCK(hrng);

  if(HAL_RNG_STATE_READY == hrng->State)
  {
    hrng->ReadyDataCallback = HAL_RNG_ReadyDataCallback; /* Legacy weak ReadyDataCallback  */
  }
  else
  {
    /* Update the error code */
    hrng->ErrorCode |= HAL_RNG_ERROR_INVALID_CALLBACK;
    /* Return error status */
    status =  HAL_ERROR;
  }

  /* Release Lock */
  __HAL_UNLOCK(hrng);
  return status;
}