Collaboration diagram for HASH Private Macros:

Macros
#define	HASH_DIGEST_LENGTH()
	Return digest length in bytes.

#define	HASH_NBW_PUSHED()
	Return number of words already pushed in the FIFO.

#define	IS_HASH_DATATYPE(__DATATYPE__)
	Ensure that HASH input data type is valid.

#define	IS_HASH_DMA_MULTIBUFFER_SIZE(__SIZE__)
	Ensure that input data buffer size is valid for multi-buffer HASH processing in DMA mode.

#define	IS_HMAC_DMA_MULTIBUFFER_SIZE(__HANDLE__, __SIZE__)
	Ensure that input data buffer size is valid for multi-buffer HMAC processing in DMA mode.

#define	IS_HASH_PROCESSING(__HANDLE__)
	Ensure that handle phase is set to HASH processing.

#define	IS_HMAC_PROCESSING(__HANDLE__)
	Ensure that handle phase is set to HMAC processing.

Detailed Description

Macro Definition Documentation

◆ HASH_DIGEST_LENGTH

#define HASH_DIGEST_LENGTH ( )

#include <stm32f4xx_hal_hash.h>

Value:

                              ((READ_BIT(HASH->CR, HASH_CR_ALGO) == HASH_ALGOSELECTION_SHA1)   ?  20U : \
                              ((READ_BIT(HASH->CR, HASH_CR_ALGO) == HASH_ALGOSELECTION_SHA224) ?  28U : \
                               ((READ_BIT(HASH->CR, HASH_CR_ALGO) == HASH_ALGOSELECTION_SHA256) ?  32U : 16U ) ) )

Return digest length in bytes.

Return values

Digest length

Definition at line 384 of file stm32f4xx_hal_hash.h.

Referenced by HASH_Finish(), HASH_IT(), HASH_Start(), and HMAC_Processing().

◆ HASH_NBW_PUSHED

#define HASH_NBW_PUSHED ( )

#include <stm32f4xx_hal_hash.h>

Value:

((READ_BIT(HASH->CR, HASH_CR_NBW)) >> 8U)

Return number of words already pushed in the FIFO.

Return values

Number of words already pushed in the FIFO

Definition at line 394 of file stm32f4xx_hal_hash.h.

Referenced by HAL_HASH_DMAFeed_ProcessSuspend(), HASH_Start_DMA(), and HMAC_Start_DMA().

◆ IS_HASH_DATATYPE

#define IS_HASH_DATATYPE ( __DATATYPE__ )

#include <stm32f4xx_hal_hash.h>

Value:

                                        (((__DATATYPE__) == HASH_DATATYPE_32B)|| \
                                        ((__DATATYPE__) == HASH_DATATYPE_16B)|| \
                                        ((__DATATYPE__) == HASH_DATATYPE_8B) || \
                                        ((__DATATYPE__) == HASH_DATATYPE_1B))

Ensure that HASH input data type is valid.

Parameters

__DATATYPE__ HASH input data type.

Return values

SET	(DATATYPE is valid) or RESET (DATATYPE is invalid)

Definition at line 401 of file stm32f4xx_hal_hash.h.

Referenced by HAL_HASH_Init().

◆ IS_HASH_DMA_MULTIBUFFER_SIZE

#define IS_HASH_DMA_MULTIBUFFER_SIZE ( __SIZE__ )

#include <stm32f4xx_hal_hash.h>

Value:

((READ_BIT(HASH->CR, HASH_CR_MDMAT) == 0U) || (((__SIZE__) % 4U) == 0U))

Ensure that input data buffer size is valid for multi-buffer HASH processing in DMA mode.

Note: This check is valid only for multi-buffer HASH processing in DMA mode.

Parameters

__SIZE__ input data buffer size.

Return values

SET	(SIZE is valid) or RESET (SIZE is invalid)

Definition at line 413 of file stm32f4xx_hal_hash.h.

Referenced by HASH_Start_DMA().

◆ IS_HMAC_DMA_MULTIBUFFER_SIZE

#define IS_HMAC_DMA_MULTIBUFFER_SIZE	(		__HANDLE__,
			__SIZE__ )

#include <stm32f4xx_hal_hash.h>

Value:

((((__HANDLE__)->DigestCalculationDisable) == RESET)\

|| (((__SIZE__) % 4U) == 0U))

Ensure that input data buffer size is valid for multi-buffer HMAC processing in DMA mode.

Note: This check is valid only for multi-buffer HMAC processing in DMA mode.

Parameters

__HANDLE__	HASH handle.
__SIZE__	input data buffer size.

Return values

SET	(SIZE is valid) or RESET (SIZE is invalid)

Definition at line 423 of file stm32f4xx_hal_hash.h.

Referenced by HMAC_Start_DMA().

◆ IS_HASH_PROCESSING

#define IS_HASH_PROCESSING ( __HANDLE__ )

#include <stm32f4xx_hal_hash.h>

Value:

((__HANDLE__)->Phase == HAL_HASH_PHASE_PROCESS)

HAL_HASH_PHASE_PROCESS

@ HAL_HASH_PHASE_PROCESS

Definition stm32f4xx_hal_hash.h:76

Ensure that handle phase is set to HASH processing.

Parameters

__HANDLE__ HASH handle.

Return values

SET	(handle phase is set to HASH processing) or RESET (handle phase is not set to HASH processing)

Definition at line 430 of file stm32f4xx_hal_hash.h.

Referenced by HASH_Start_DMA().

◆ IS_HMAC_PROCESSING

#define IS_HMAC_PROCESSING ( __HANDLE__ )

#include <stm32f4xx_hal_hash.h>

Value:

                                         (((__HANDLE__)->Phase == HAL_HASH_PHASE_HMAC_STEP_1) || \
                                         ((__HANDLE__)->Phase == HAL_HASH_PHASE_HMAC_STEP_2) || \
                                         ((__HANDLE__)->Phase == HAL_HASH_PHASE_HMAC_STEP_3))

Ensure that handle phase is set to HMAC processing.

Parameters

__HANDLE__ HASH handle.

Return values

SET	(handle phase is set to HMAC processing) or RESET (handle phase is not set to HMAC processing)

Definition at line 437 of file stm32f4xx_hal_hash.h.

Referenced by HMAC_Start_DMA().