Interrupts and flags management functions

Interrupts and flags management functions. More...

Collaboration diagram for Interrupts and flags management functions:

Functions
void	HASH_ClearFlag (uint32_t HASH_FLAG)
	Clears the HASH flags. More...
void	HASH_ClearITPendingBit (uint32_t HASH_IT)
	Clears the HASH interrupt pending bit(s). More...
FlagStatus	HASH_GetFlagStatus (uint32_t HASH_FLAG)
	Checks whether the specified HASH flag is set or not. More...
ITStatus	HASH_GetITStatus (uint32_t HASH_IT)
	Checks whether the specified HASH interrupt has occurred or not. More...
void	HASH_ITConfig (uint32_t HASH_IT, FunctionalState NewState)
	Enables or disables the specified HASH interrupts. More...

Detailed Description

Interrupts and flags management functions.

 ===============================================================================
               ##### Interrupts and flags management functions #####
 ===============================================================================  

 [..] This section provides functions allowing to configure the HASH Interrupts and 
      to get the status and clear flags and Interrupts pending bits.
  
 [..] The HASH provides 2 Interrupts sources and 5 Flags:
  
 *** Flags : ***
 =============== 
 [..]
   (#) HASH_FLAG_DINIS : set when 16 locations are free in the Data IN FIFO 
      which means that a  new block (512 bit) can be entered into the input buffer.
                          
   (#) HASH_FLAG_DCIS :  set when Digest calculation is complete
      
   (#) HASH_FLAG_DMAS :  set when HASH's DMA interface is enabled (DMAE=1) or 
       a transfer is ongoing. This Flag is cleared only by hardware.
                           
   (#) HASH_FLAG_BUSY :  set when The hash core is processing a block of data
       This Flag is cleared only by hardware. 
                           
   (#) HASH_FLAG_DINNE : set when Data IN FIFO is not empty which means that 
       the Data IN FIFO contains at least one word of data. This Flag is cleared 
       only by hardware.
     
 *** Interrupts : ***
 ====================
 [..]   
   (#) HASH_IT_DINI  : if enabled, this interrupt source is pending when 16 
       locations are free in the Data IN FIFO  which means that a new block (512 bit)
       can be entered into the input buffer. This interrupt source is cleared using 
       HASH_ClearITPendingBit(HASH_IT_DINI) function.
   
   (#) HASH_IT_DCI   : if enabled, this interrupt source is pending when Digest 
       calculation is complete. This interrupt source is cleared using 
       HASH_ClearITPendingBit(HASH_IT_DCI) function.

 *** Managing the HASH controller events : ***
 =============================================
 [..] The user should identify which mode will be used in his application to manage 
      the HASH controller events: Polling mode or Interrupt mode.
  
   (#) In the Polling Mode it is advised to use the following functions:
       (++) HASH_GetFlagStatus() : to check if flags events occur. 
       (++) HASH_ClearFlag()     : to clear the flags events.
    
   (#)  In the Interrupt Mode it is advised to use the following functions:
       (++) HASH_ITConfig()       : to enable or disable the interrupt source.
       (++) HASH_GetITStatus()    : to check if Interrupt occurs.
       (++) HASH_ClearITPendingBit() : to clear the Interrupt pending Bit 
            (corresponding Flag). 

Function Documentation

void HASH_ClearFlag

(

uint32_t

HASH_FLAG

)

Clears the HASH flags.

Parameters

HASH_FLAG

specifies the flag to clear. This parameter can be any combination of the following values: HASH_FLAG_DINIS: Data Input Flag HASH_FLAG_DCIS: Digest Calculation Completion Flag

Return values

None

Definition at line 651 of file stm32f4xx_hash.c.

void HASH_ClearITPendingBit

(

uint32_t

HASH_IT

)

Clears the HASH interrupt pending bit(s).

Parameters

HASH_IT

specifies the HASH interrupt pending bit(s) to clear. This parameter can be any combination of the following values: HASH_IT_DINI: Data Input interrupt HASH_IT_DCI: Digest Calculation Completion Interrupt

Return values

None

Definition at line 701 of file stm32f4xx_hash.c.

FlagStatus HASH_GetFlagStatus

(

uint32_t

HASH_FLAG

)

Checks whether the specified HASH flag is set or not.

Parameters

HASH_FLAG

specifies the HASH flag to check. This parameter can be one of the following values: HASH_FLAG_DINIS: Data input interrupt status flag HASH_FLAG_DCIS: Digest calculation completion interrupt status flag HASH_FLAG_BUSY: Busy flag HASH_FLAG_DMAS: DMAS Status flag HASH_FLAG_DINNE: Data Input register (DIN) not empty status flag

Return values

The	new state of HASH_FLAG (SET or RESET)

Definition at line 610 of file stm32f4xx_hash.c.

ITStatus HASH_GetITStatus

(

uint32_t

HASH_IT

)

Checks whether the specified HASH interrupt has occurred or not.

Parameters

HASH_IT

specifies the HASH interrupt source to check. This parameter can be one of the following values: HASH_IT_DINI: Data Input interrupt HASH_IT_DCI: Digest Calculation Completion Interrupt

Return values

The	new state of HASH_IT (SET or RESET).

Definition at line 667 of file stm32f4xx_hash.c.

void HASH_ITConfig	(	uint32_t	HASH_IT,
		FunctionalState	NewState
	)

Enables or disables the specified HASH interrupts.

Parameters

HASH_IT	specifies the HASH interrupt source to be enabled or disabled. This parameter can be any combination of the following values: HASH_IT_DINI: Data Input interrupt HASH_IT_DCI: Digest Calculation Completion Interrupt
NewState	new state of the specified HASH interrupt. This parameter can be: ENABLE or DISABLE.

Return values

None

Definition at line 581 of file stm32f4xx_hash.c.