HASH Exported Macros

Collaboration diagram for HASH Exported Macros:

Macros
#define	__HAL_HASH_GET_FLAG(__FLAG__)
	Check whether or not the specified HASH flag is set.
#define	__HAL_HASH_CLEAR_FLAG(__FLAG__)
	Clear the specified HASH flag.
#define	__HAL_HASH_ENABLE_IT(__INTERRUPT__)
	Enable the specified HASH interrupt.
#define	__HAL_HASH_DISABLE_IT(__INTERRUPT__)
	Disable the specified HASH interrupt.
#define	__HAL_HASH_RESET_HANDLE_STATE(__HANDLE__)
	Reset HASH handle state.
#define	__HAL_HASH_RESET_HANDLE_STATUS(__HANDLE__)
	Reset HASH handle status.
#define	__HAL_HASH_SET_MDMAT()
	Enable the multi-buffer DMA transfer mode.
#define	__HAL_HASH_RESET_MDMAT()
	Disable the multi-buffer DMA transfer mode.
#define	__HAL_HASH_START_DIGEST()
	Start the digest computation.
#define	__HAL_HASH_SET_NBVALIDBITS(__SIZE__)
	Set the number of valid bits in the last word written in data register DIN.
#define	__HAL_HASH_INIT()
	Reset the HASH core.

Detailed Description

Macro Definition Documentation

__HAL_HASH_GET_FLAG

#define __HAL_HASH_GET_FLAG

(

__FLAG__

)

#include <stm32f4xx_hal_hash.h>

Value:

                                        (((__FLAG__) > 8U)  ?                    \
                                        ((HASH->CR & (__FLAG__)) == (__FLAG__)) :\
                                        ((HASH->SR & (__FLAG__)) == (__FLAG__)) )

Check whether or not the specified HASH flag is set.

Parameters

__FLAG__

specifies the flag to check. This parameter can be one of the following values: HASH_FLAG_DINIS A new block can be entered into the input buffer. HASH_FLAG_DCIS Digest calculation complete. HASH_FLAG_DMAS DMA interface is enabled (DMAE=1) or a transfer is ongoing. HASH_FLAG_BUSY The hash core is Busy : processing a block of data. HASH_FLAG_DINNE DIN not empty : the input buffer contains at least one word of data.

Return values

The	new state of FLAG (TRUE or FALSE).

Definition at line 282 of file stm32f4xx_hal_hash.h.

Referenced by HAL_HASH_DMAFeed_ProcessSuspend(), HASH_Accumulate_IT(), HASH_IT(), HASH_Start_IT(), HASH_WaitOnFlagUntilTimeout(), and HASH_WriteData().

__HAL_HASH_CLEAR_FLAG

#define __HAL_HASH_CLEAR_FLAG

(

__FLAG__

)

#include <stm32f4xx_hal_hash.h>

Value:

CLEAR_BIT(HASH->SR, (__FLAG__))

Clear the specified HASH flag.

Parameters

__FLAG__

specifies the flag to clear. This parameter can be one of the following values: HASH_FLAG_DINIS A new block can be entered into the input buffer. HASH_FLAG_DCIS Digest calculation complete

Return values

None

Definition at line 294 of file stm32f4xx_hal_hash.h.

__HAL_HASH_ENABLE_IT

#define __HAL_HASH_ENABLE_IT

(

__INTERRUPT__

)

#include <stm32f4xx_hal_hash.h>

Value:

SET_BIT(HASH->IMR, (__INTERRUPT__))

Enable the specified HASH interrupt.

Parameters

__INTERRUPT__

specifies the HASH interrupt source to enable. This parameter can be one of the following values: HASH_IT_DINI A new block can be entered into the input buffer (DIN) HASH_IT_DCI Digest calculation complete

Return values

None

Definition at line 304 of file stm32f4xx_hal_hash.h.

Referenced by HASH_Accumulate_IT(), HASH_IT(), HASH_Start_IT(), and HMAC_Start_IT().

__HAL_HASH_DISABLE_IT

#define __HAL_HASH_DISABLE_IT

(

__INTERRUPT__

)

#include <stm32f4xx_hal_hash.h>

Value:

CLEAR_BIT(HASH->IMR, (__INTERRUPT__))

Disable the specified HASH interrupt.

Parameters

__INTERRUPT__

specifies the HASH interrupt source to disable. This parameter can be one of the following values: HASH_IT_DINI A new block can be entered into the input buffer (DIN) HASH_IT_DCI Digest calculation complete

Return values

None

Definition at line 313 of file stm32f4xx_hal_hash.h.

Referenced by HASH_IT(), and HASH_Write_Block_Data().

__HAL_HASH_RESET_HANDLE_STATE

#define __HAL_HASH_RESET_HANDLE_STATE

(

__HANDLE__

)

#include <stm32f4xx_hal_hash.h>

Value:

((__HANDLE__)->State = HAL_HASH_STATE_RESET)

Reset HASH handle state.

Parameters

__HANDLE__

HASH handle.

Return values

None

Definition at line 327 of file stm32f4xx_hal_hash.h.

__HAL_HASH_RESET_HANDLE_STATUS

#define __HAL_HASH_RESET_HANDLE_STATUS

(

__HANDLE__

)

#include <stm32f4xx_hal_hash.h>

Value:

((__HANDLE__)->Status = HAL_OK)

Reset HASH handle status.

Parameters

__HANDLE__

HASH handle.

Return values

None

Definition at line 335 of file stm32f4xx_hal_hash.h.

__HAL_HASH_SET_MDMAT

#define __HAL_HASH_SET_MDMAT

(

)

#include <stm32f4xx_hal_hash.h>

Value:

SET_BIT(HASH->CR, HASH_CR_MDMAT)

Enable the multi-buffer DMA transfer mode.

Note

This bit is set when hashing large files when multiple DMA transfers are needed.

Return values

None

Definition at line 342 of file stm32f4xx_hal_hash.h.

Referenced by HASH_DMAXferCplt().

__HAL_HASH_RESET_MDMAT

#define __HAL_HASH_RESET_MDMAT

(

)

#include <stm32f4xx_hal_hash.h>

Value:

CLEAR_BIT(HASH->CR, HASH_CR_MDMAT)

Disable the multi-buffer DMA transfer mode.

Return values

None

Definition at line 348 of file stm32f4xx_hal_hash.h.

Referenced by HAL_HASH_Init(), and HMAC_Start_DMA().

__HAL_HASH_START_DIGEST

#define __HAL_HASH_START_DIGEST

(

)

#include <stm32f4xx_hal_hash.h>

Value:

SET_BIT(HASH->STR, HASH_STR_DCAL)

Start the digest computation.

Return values

None

Definition at line 355 of file stm32f4xx_hal_hash.h.

Referenced by HASH_Start(), HASH_Start_IT(), HASH_Write_Block_Data(), and HMAC_Processing().

__HAL_HASH_SET_NBVALIDBITS

#define __HAL_HASH_SET_NBVALIDBITS

(

__SIZE__

)

#include <stm32f4xx_hal_hash.h>

Value:

MODIFY_REG(HASH->STR, HASH_STR_NBLW, 8U * ((__SIZE__) % 4U))

Set the number of valid bits in the last word written in data register DIN.

Parameters

__SIZE__

size in bytes of last data written in Data register.

Return values

None

Definition at line 362 of file stm32f4xx_hal_hash.h.

Referenced by HASH_DMAXferCplt(), HASH_IT(), HASH_Start(), HASH_Start_DMA(), HASH_Start_IT(), HMAC_Processing(), HMAC_Start_DMA(), and HMAC_Start_IT().

__HAL_HASH_INIT

#define __HAL_HASH_INIT

(

)

#include <stm32f4xx_hal_hash.h>

Value:

SET_BIT(HASH->CR, HASH_CR_INIT)

Reset the HASH core.

Return values

None

Definition at line 368 of file stm32f4xx_hal_hash.h.

Referenced by HAL_HASH_ContextRestoring().