Callback functions

Callback functions. More...

Functions
void	HAL_CRYP_InCpltCallback (CRYP_HandleTypeDef *hcryp)
	Input DMA transfer complete callback. More...
void	HAL_CRYP_OutCpltCallback (CRYP_HandleTypeDef *hcryp)
	Output DMA transfer complete callback. More...
void	HAL_CRYP_ErrorCallback (CRYP_HandleTypeDef *hcryp)
	CRYP error callback. More...
HAL_StatusTypeDef	HAL_CRYP_RegisterCallback (CRYP_HandleTypeDef *hcryp, HAL_CRYP_CallbackIDTypeDef CallbackID, pCRYP_CallbackTypeDef pCallback)
	Register a User CRYP Callback To be used instead of the weak (surcharged) predefined callback. More...
HAL_StatusTypeDef	HAL_CRYP_UnRegisterCallback (CRYP_HandleTypeDef *hcryp, HAL_CRYP_CallbackIDTypeDef CallbackID)
	Unregister a CRYP Callback CRYP Callback is redirected to the weak (surcharged) predefined callback. More...

Detailed Description

Callback functions.

  ==============================================================================
                      ##### Callback functions  #####
  ==============================================================================
    [..]  This section provides Interruption and DMA callback functions:
      (+) DMA Input data transfer complete
      (+) DMA Output data transfer complete
      (+) DMA or Interrupt error

Function Documentation

HAL_CRYP_ErrorCallback()

__weak void HAL_CRYP_ErrorCallback

(

CRYP_HandleTypeDef *

hcryp

)

CRYP error callback.

Parameters

hcryp

pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module

Return values

None

Definition at line 1123 of file stm32l4xx_hal_cryp.c.

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

  /* NOTE : This function should not be modified; when the callback is needed,
            the HAL_CRYP_ErrorCallback can be implemented in the user file
   */
}

HAL_CRYP_InCpltCallback()

__weak void HAL_CRYP_InCpltCallback

(

CRYP_HandleTypeDef *

hcryp

)

Input DMA transfer complete callback.

Parameters

hcryp

pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module

Return values

None

Definition at line 1139 of file stm32l4xx_hal_cryp.c.

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

  /* NOTE : This function should not be modified; when the callback is needed,
            the HAL_CRYP_InCpltCallback can be implemented in the user file
   */
}

HAL_CRYP_OutCpltCallback()

__weak void HAL_CRYP_OutCpltCallback

(

CRYP_HandleTypeDef *

hcryp

)

Output DMA transfer complete callback.

Parameters

hcryp

pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module

Return values

None

Definition at line 1155 of file stm32l4xx_hal_cryp.c.

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

  /* NOTE : This function should not be modified; when the callback is needed,
            the HAL_CRYP_OutCpltCallback can be implemented in the user file
   */
}

HAL_CRYP_RegisterCallback()

HAL_StatusTypeDef HAL_CRYP_RegisterCallback	(	CRYP_HandleTypeDef *	hcryp,
		HAL_CRYP_CallbackIDTypeDef	CallbackID,
		pCRYP_CallbackTypeDef	pCallback
	)

Register a User CRYP Callback To be used instead of the weak (surcharged) predefined callback.

Parameters

hcryp	CRYP handle
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_CRYP_INPUTCPLT_CB_ID CRYP input DMA transfer completion Callback ID HAL_CRYP_OUTPUTCPLT_CB_ID CRYP output DMA transfer completion Callback ID HAL_CRYP_COMPCPLT_CB_ID CRYP computation completion Callback ID HAL_CRYP_ERROR_CB_ID CRYP error callback ID HAL_CRYP_MSPINIT_CB_ID CRYP MspDeInit callback ID HAL_CRYP_MSPDEINIT_CB_ID CRYP MspDeInit callback ID
pCallback	pointer to the Callback function

Return values

status

Definition at line 1181 of file stm32l4xx_hal_cryp.c.

{
  HAL_StatusTypeDef status = HAL_OK;

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

  if(HAL_CRYP_STATE_READY == hcryp->State)
  {
    switch (CallbackID)
    {
    case HAL_CRYP_INPUTCPLT_CB_ID :
      hcryp->InCpltCallback = pCallback;
      break;

    case HAL_CRYP_OUTPUTCPLT_CB_ID :
      hcryp->OutCpltCallback = pCallback;
      break;

    case HAL_CRYP_COMPCPLT_CB_ID :
      hcryp->CompCpltCallback = pCallback;
      break;

    case HAL_CRYP_ERROR_CB_ID :
      hcryp->ErrorCallback = pCallback;
      break;

    case HAL_CRYP_MSPINIT_CB_ID :
      hcryp->MspInitCallback = pCallback;
      break;

    case HAL_CRYP_MSPDEINIT_CB_ID :
      hcryp->MspDeInitCallback = pCallback;
      break;

    default :
     /* Update the error code */
     hcryp->ErrorCode |= HAL_CRYP_ERROR_INVALID_CALLBACK;
     /* update return status */
      status =  HAL_ERROR;
      break;
    }
  }
  else if(HAL_CRYP_STATE_RESET == hcryp->State)
  {
    switch (CallbackID)
    {
    case HAL_CRYP_MSPINIT_CB_ID :
      hcryp->MspInitCallback = pCallback;
      break;

    case HAL_CRYP_MSPDEINIT_CB_ID :
      hcryp->MspDeInitCallback = pCallback;
      break;

    default :
     /* Update the error code */
     hcryp->ErrorCode |= HAL_CRYP_ERROR_INVALID_CALLBACK;
     /* update return status */
      status =  HAL_ERROR;
      break;
    }
  }
  else
  {
    /* Update the error code */
     hcryp->ErrorCode |= HAL_CRYP_ERROR_INVALID_CALLBACK;
     /* update return status */
      status =  HAL_ERROR;
  }

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

HAL_CRYP_UnRegisterCallback()

HAL_StatusTypeDef HAL_CRYP_UnRegisterCallback	(	CRYP_HandleTypeDef *	hcryp,
		HAL_CRYP_CallbackIDTypeDef	CallbackID
	)

Unregister a CRYP Callback CRYP Callback is redirected to the weak (surcharged) predefined callback.

Parameters

hcryp

CRYP handle

CallbackID

ID of the callback to be unregistered This parameter can be one of the following values: HAL_CRYP_INPUTCPLT_CB_ID CRYP input DMA transfer completion Callback ID HAL_CRYP_OUTPUTCPLT_CB_ID CRYP output DMA transfer completion Callback ID HAL_CRYP_COMPCPLT_CB_ID CRYP computation completion Callback ID HAL_CRYP_ERROR_CB_ID CRYP error callback ID HAL_CRYP_MSPINIT_CB_ID CRYP MspDeInit callback ID HAL_CRYP_MSPDEINIT_CB_ID CRYP MspDeInit callback ID

Return values

status

Definition at line 1277 of file stm32l4xx_hal_cryp.c.

{
HAL_StatusTypeDef status = HAL_OK;

  /* Process locked */
  __HAL_LOCK(hcryp);

  if(HAL_CRYP_STATE_READY == hcryp->State)
  {
    switch (CallbackID)
    {
    case HAL_CRYP_INPUTCPLT_CB_ID :
      hcryp->InCpltCallback = HAL_CRYP_InCpltCallback;              /* Legacy weak (surcharged) input DMA transfer completion callback */
      break;

    case HAL_CRYP_OUTPUTCPLT_CB_ID :
      hcryp->OutCpltCallback = HAL_CRYP_OutCpltCallback;            /* Legacy weak (surcharged) output DMA transfer completion callback */
      break;

    case HAL_CRYP_COMPCPLT_CB_ID :
      hcryp->CompCpltCallback = HAL_CRYPEx_ComputationCpltCallback; /* Legacy weak (surcharged) computation completion callback */
      break;

    case HAL_CRYP_ERROR_CB_ID :
      hcryp->ErrorCallback = HAL_CRYP_ErrorCallback;                /* Legacy weak (surcharged) error callback */
      break;

    case HAL_CRYP_MSPINIT_CB_ID :
      hcryp->MspInitCallback = HAL_CRYP_MspInit;                    /* Legacy weak (surcharged) Msp DeInit */
      break;

    case HAL_CRYP_MSPDEINIT_CB_ID :
      hcryp->MspDeInitCallback = HAL_CRYP_MspDeInit;                /* Legacy weak (surcharged) Msp DeInit */
      break;

    default :
     /* Update the error code */
     hcryp->ErrorCode |= HAL_CRYP_ERROR_INVALID_CALLBACK;
     /* update return status */
      status =  HAL_ERROR;
      break;
    }
  }
  else if(HAL_CRYP_STATE_RESET == hcryp->State)
  {
    switch (CallbackID)
    {
    case HAL_CRYP_MSPINIT_CB_ID :
      hcryp->MspInitCallback = HAL_CRYP_MspInit;           /* Legacy weak (surcharged) Msp Init */
      break;

    case HAL_CRYP_MSPDEINIT_CB_ID :
      hcryp->MspDeInitCallback = HAL_CRYP_MspDeInit;       /* Legacy weak (surcharged) Msp DeInit */
      break;

    default :
     /* Update the error code */
     hcryp->ErrorCode |= HAL_CRYP_ERROR_INVALID_CALLBACK;
     /* update return status */
      status =  HAL_ERROR;
      break;
    }
  }
  else
  {
     /* Update the error code */
     hcryp->ErrorCode |= HAL_CRYP_ERROR_INVALID_CALLBACK;
     /* update return status */
      status =  HAL_ERROR;
  }

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