Initialization and de-initialization functions

Initialization, configuration and call-back functions. More...

Collaboration diagram for Initialization and de-initialization functions:

Functions
HAL_StatusTypeDef	HAL_HASH_Init (HASH_HandleTypeDef *hhash)
	Initialize the HASH according to the specified parameters in the HASH_HandleTypeDef and create the associated handle. More...
HAL_StatusTypeDef	HAL_HASH_DeInit (HASH_HandleTypeDef *hhash)
	DeInitialize the HASH peripheral. More...
void	HAL_HASH_MspInit (HASH_HandleTypeDef *hhash)
	Initialize the HASH MSP. More...
void	HAL_HASH_MspDeInit (HASH_HandleTypeDef *hhash)
	DeInitialize the HASH MSP. More...
void	HAL_HASH_InCpltCallback (HASH_HandleTypeDef *hhash)
	Input data transfer complete call back. More...
void	HAL_HASH_DgstCpltCallback (HASH_HandleTypeDef *hhash)
	Digest computation complete call back. More...
void	HAL_HASH_ErrorCallback (HASH_HandleTypeDef *hhash)
	Error callback. More...
HAL_StatusTypeDef	HAL_HASH_RegisterCallback (HASH_HandleTypeDef *hhash, HAL_HASH_CallbackIDTypeDef CallbackID, pHASH_CallbackTypeDef pCallback)
	Register a User HASH Callback To be used instead of the weak (surcharged) predefined callback. More...
HAL_StatusTypeDef	HAL_HASH_UnRegisterCallback (HASH_HandleTypeDef *hhash, HAL_HASH_CallbackIDTypeDef CallbackID)
	Unregister a HASH Callback HASH Callback is redirected to the weak (surcharged) predefined callback. More...

Detailed Description

Initialization, configuration and call-back functions.

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

    [..]  This section provides as well call back functions definitions for user
          code to manage:
      (+) Input data transfer to Peripheral completion
      (+) Calculated digest retrieval completion
      (+) Error management

Function Documentation

HAL_HASH_DeInit()

HAL_StatusTypeDef HAL_HASH_DeInit

(

HASH_HandleTypeDef *

hhash

)

DeInitialize the HASH peripheral.

Parameters

hhash

HASH handle.

Return values

HAL

status

Definition at line 408 of file stm32f4xx_hal_hash.c.

HAL_HASH_DgstCpltCallback()

__weak void HAL_HASH_DgstCpltCallback

(

HASH_HandleTypeDef *

hhash

)

Digest computation complete call back.

Note

HAL_HASH_DgstCpltCallback() is used under interruption, is not relevant with DMA.

Parameters

hhash

HASH handle.

Return values

None

Definition at line 517 of file stm32f4xx_hal_hash.c.

HAL_HASH_ErrorCallback()

__weak void HAL_HASH_ErrorCallback

(

HASH_HandleTypeDef *

hhash

)

Error callback.

Note

Code user can resort to hhash->Status (HAL_ERROR, HAL_TIMEOUT,...) to retrieve the error type.

Parameters

hhash

HASH handle.

Return values

None

Definition at line 534 of file stm32f4xx_hal_hash.c.

HAL_HASH_InCpltCallback()

__weak void HAL_HASH_InCpltCallback

(

HASH_HandleTypeDef *

hhash

)

Input data transfer complete call back.

Note

HAL_HASH_InCpltCallback() is called when the complete input message has been fed to the Peripheral. This API is invoked only when input data are entered under interruption or through DMA.

In case of HASH or HMAC multi-buffer DMA feeding case (MDMAT bit set), HAL_HASH_InCpltCallback() is called at the end of each buffer feeding to the Peripheral.

Parameters

hhash

HASH handle.

Return values

None

Definition at line 500 of file stm32f4xx_hal_hash.c.

HAL_HASH_Init()

HAL_StatusTypeDef HAL_HASH_Init

(

HASH_HandleTypeDef *

hhash

)

Initialize the HASH according to the specified parameters in the HASH_HandleTypeDef and create the associated handle.

Note

Only MDMAT and DATATYPE bits of HASH Peripheral are set by HAL_HASH_Init(), other configuration bits are set by HASH or HMAC processing APIs.

MDMAT bit is systematically reset by HAL_HASH_Init(). To set it for multi-buffer HASH processing, user needs to resort to __HAL_HASH_SET_MDMAT() macro. For HMAC multi-buffer processing, the relevant APIs manage themselves the MDMAT bit.

Parameters

hhash

HASH handle

Return values

HAL

status

Definition at line 328 of file stm32f4xx_hal_hash.c.

HAL_HASH_MspDeInit()

__weak void HAL_HASH_MspDeInit

(

HASH_HandleTypeDef *

hhash

)

DeInitialize the HASH MSP.

Parameters

hhash

HASH handle.

Return values

None

Definition at line 479 of file stm32f4xx_hal_hash.c.

HAL_HASH_MspInit()

__weak void HAL_HASH_MspInit

(

HASH_HandleTypeDef *

hhash

)

Initialize the HASH MSP.

Parameters

hhash

HASH handle.

Return values

None

Definition at line 464 of file stm32f4xx_hal_hash.c.

HAL_HASH_RegisterCallback()

HAL_StatusTypeDef HAL_HASH_RegisterCallback	(	HASH_HandleTypeDef *	hhash,
		HAL_HASH_CallbackIDTypeDef	CallbackID,
		pHASH_CallbackTypeDef	pCallback
	)

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

Parameters

hhash	HASH handle
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_HASH_INPUTCPLT_CB_ID HASH input completion Callback ID HAL_HASH_DGSTCPLT_CB_ID HASH digest computation completion Callback ID HAL_HASH_ERROR_CB_ID HASH error Callback ID HAL_HASH_MSPINIT_CB_ID HASH MspInit callback ID HAL_HASH_MSPDEINIT_CB_ID HASH MspDeInit callback ID
pCallback	pointer to the Callback function

Return values

status

Definition at line 559 of file stm32f4xx_hal_hash.c.

HAL_HASH_UnRegisterCallback()

HAL_StatusTypeDef HAL_HASH_UnRegisterCallback	(	HASH_HandleTypeDef *	hhash,
		HAL_HASH_CallbackIDTypeDef	CallbackID
	)

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

Parameters

hhash	HASH handle
CallbackID	ID of the callback to be unregistered This parameter can be one of the following values: HAL_HASH_INPUTCPLT_CB_ID HASH input completion Callback ID HAL_HASH_DGSTCPLT_CB_ID HASH digest computation completion Callback ID HAL_HASH_ERROR_CB_ID HASH error Callback ID HAL_HASH_MSPINIT_CB_ID HASH MspInit callback ID HAL_HASH_MSPDEINIT_CB_ID HASH MspDeInit callback ID

Return values

status

Definition at line 651 of file stm32f4xx_hal_hash.c.