stm32f7xx_hal_hash.h

Go to the documentation of this file.

/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __STM32F7xx_HAL_HASH_H
#define __STM32F7xx_HAL_HASH_H

#ifdef __cplusplus
 extern "C" {
#endif

#if defined (STM32F756xx) || defined (STM32F777xx) || defined (STM32F779xx)
/* Includes ------------------------------------------------------------------*/
#include "stm32f7xx_hal_def.h"

/* Exported types ------------------------------------------------------------*/
typedef struct
{
  uint32_t DataType;  
  uint32_t KeySize;   
  uint8_t* pKey;      
}HASH_InitTypeDef;

typedef enum
{
  HAL_HASH_STATE_RESET     = 0x00U,  
  HAL_HASH_STATE_READY     = 0x01U,  
  HAL_HASH_STATE_BUSY      = 0x02U,  
  HAL_HASH_STATE_TIMEOUT   = 0x03U,  
  HAL_HASH_STATE_ERROR     = 0x04U   
}HAL_HASH_StateTypeDef;

typedef enum
{
  HAL_HASH_PHASE_READY     = 0x01U,  
  HAL_HASH_PHASE_PROCESS   = 0x02U,  
}HAL_HASHPhaseTypeDef;

typedef struct
{
      HASH_InitTypeDef           Init;              
      uint8_t                    *pHashInBuffPtr;   
      uint8_t                    *pHashOutBuffPtr;  
     __IO uint32_t               HashBuffSize;      
     __IO uint32_t               HashInCount;       
     __IO uint32_t               HashITCounter;     
      HAL_StatusTypeDef          Status;            
      HAL_HASH_PhaseTypeDef       Phase;             
      DMA_HandleTypeDef          *hdmain;           
      HAL_LockTypeDef            Lock;              
     __IO HAL_HASH_StateTypeDef  State;             
} HASH_HandleTypeDef;

/* Exported constants --------------------------------------------------------*/
#define HASH_ALGOSELECTION_SHA1      ((uint32_t)0x0000U)  
#define HASH_ALGOSELECTION_SHA224    HASH_CR_ALGO_1      
#define HASH_ALGOSELECTION_SHA256    HASH_CR_ALGO        
#define HASH_ALGOSELECTION_MD5       HASH_CR_ALGO_0      
#define HASH_ALGOMODE_HASH         ((uint32_t)0x00000000U)  
#define HASH_ALGOMODE_HMAC         HASH_CR_MODE            
#define HASH_DATATYPE_32B          ((uint32_t)0x0000U) 
#define HASH_DATATYPE_16B          HASH_CR_DATATYPE_0 
#define HASH_DATATYPE_8B           HASH_CR_DATATYPE_1 
#define HASH_DATATYPE_1B           HASH_CR_DATATYPE   
#define HASH_HMAC_KEYTYPE_SHORTKEY      ((uint32_t)0x00000000U)  
#define HASH_HMAC_KEYTYPE_LONGKEY       HASH_CR_LKEY            
#define HASH_FLAG_DINIS            HASH_SR_DINIS  
#define HASH_FLAG_DCIS             HASH_SR_DCIS   
#define HASH_FLAG_DMAS             HASH_SR_DMAS   
#define HASH_FLAG_BUSY             HASH_SR_BUSY   
#define HASH_FLAG_DINNE            HASH_CR_DINNE  
#define HASH_IT_DINI               HASH_IMR_DINIE  
#define HASH_IT_DCI                HASH_IMR_DCIE   
/* Exported macro ------------------------------------------------------------*/

#define __HAL_HASH_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_HASH_STATE_RESET)

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

#define __HAL_HASH_SET_MDMAT()          HASH->CR |= HASH_CR_MDMAT

#define __HAL_HASH_RESET_MDMAT()        HASH->CR &= (uint32_t)(~HASH_CR_MDMAT)

#define __HAL_HASH_START_DIGEST()       HASH->STR |= HASH_STR_DCAL

#define __HAL_HASH_SET_NBVALIDBITS(SIZE) do{HASH->STR &= ~(HASH_STR_NBW);\
                                            HASH->STR |= 8 * ((SIZE) % 4);\
                                           }while(0)

/* Include HASH HAL Extension module */
#include "stm32f7xx_hal_hash_ex.h"
/* Exported functions --------------------------------------------------------*/

HAL_StatusTypeDef HAL_HASH_Init(HASH_HandleTypeDef *hhash);
HAL_StatusTypeDef HAL_HASH_DeInit(HASH_HandleTypeDef *hhash);
HAL_StatusTypeDef HAL_HASH_SHA1_Start(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t* pOutBuffer, uint32_t Timeout);
HAL_StatusTypeDef HAL_HASH_MD5_Start(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t* pOutBuffer, uint32_t Timeout);
HAL_StatusTypeDef HAL_HASH_MD5_Accumulate(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size);
HAL_StatusTypeDef HAL_HASH_SHA1_Accumulate(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size);
HAL_StatusTypeDef HAL_HMAC_SHA1_Start(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t* pOutBuffer, uint32_t Timeout);
HAL_StatusTypeDef HAL_HMAC_MD5_Start(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t* pOutBuffer, uint32_t Timeout);
HAL_StatusTypeDef HAL_HASH_SHA1_Start_IT(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t* pOutBuffer);
HAL_StatusTypeDef HAL_HASH_MD5_Start_IT(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t* pOutBuffer);
HAL_StatusTypeDef HAL_HASH_SHA1_Start_DMA(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size);
HAL_StatusTypeDef HAL_HASH_SHA1_Finish(HASH_HandleTypeDef *hhash, uint8_t* pOutBuffer, uint32_t Timeout);
HAL_StatusTypeDef HAL_HASH_MD5_Start_DMA(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size);
HAL_StatusTypeDef HAL_HASH_MD5_Finish(HASH_HandleTypeDef *hhash, uint8_t* pOutBuffer, uint32_t Timeout);
HAL_StatusTypeDef HAL_HMAC_SHA1_Start_DMA(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size);
HAL_StatusTypeDef HAL_HMAC_MD5_Start_DMA(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size);
void HAL_HASH_IRQHandler(HASH_HandleTypeDef *hhash);
HAL_HASH_StateTypeDef HAL_HASH_GetState(HASH_HandleTypeDef *hhash);
void HAL_HASH_MspInit(HASH_HandleTypeDef *hhash);
void HAL_HASH_MspDeInit(HASH_HandleTypeDef *hhash);
void HAL_HASH_InCpltCallback(HASH_HandleTypeDef *hhash);
void HAL_HASH_DgstCpltCallback(HASH_HandleTypeDef *hhash);
void HAL_HASH_ErrorCallback(HASH_HandleTypeDef *hhash);
 /* Private types -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/* Private macros ------------------------------------------------------------*/
#define IS_HASH_ALGOSELECTION(__ALGOSELECTION__) (((__ALGOSELECTION__) == HASH_ALGOSELECTION_SHA1)   || \
                                                  ((__ALGOSELECTION__) == HASH_ALGOSELECTION_SHA224) || \
                                                  ((__ALGOSELECTION__) == HASH_ALGOSELECTION_SHA256) || \
                                                  ((__ALGOSELECTION__) == HASH_ALGOSELECTION_MD5))


#define IS_HASH_ALGOMODE(__ALGOMODE__) (((__ALGOMODE__) == HASH_ALGOMODE_HASH) || \
                                        ((__ALGOMODE__) == HASH_ALGOMODE_HMAC))


#define IS_HASH_DATATYPE(__DATATYPE__) (((__DATATYPE__) == HASH_DATATYPE_32B)|| \
                                        ((__DATATYPE__) == HASH_DATATYPE_16B)|| \
                                        ((__DATATYPE__) == HASH_DATATYPE_8B) || \
                                        ((__DATATYPE__) == HASH_DATATYPE_1B))


#define IS_HASH_HMAC_KEYTYPE(__KEYTYPE__) (((__KEYTYPE__) == HASH_HMAC_KEYTYPE_SHORTKEY) || \
                                           ((__KEYTYPE__) == HASH_HMAC_KEYTYPE_LONGKEY))
                                           
#define IS_HASH_SHA1_BUFFER_SIZE(__SIZE__) ((((__SIZE__)%4) != 0)? 0U: 1U)


/* Private functions ---------------------------------------------------------*/
#endif /* STM32F756xx || STM32F777xx || STM32F779xx */

#ifdef __cplusplus
}
#endif


#endif /* __STM32F7xx_HAL_HASH_H */

/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/