stm32h7xx_hal_hash.h 24.1 KB
Newer Older
whj123999's avatar
whj123999 已提交
1 2 3 4 5 6 7 8
/**
  ******************************************************************************
  * @file    stm32h7xx_hal_hash.h
  * @author  MCD Application Team
  * @brief   Header file of HASH HAL module.
  ******************************************************************************
  * @attention
  *
9 10
  * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
  * All rights reserved.</center></h2>
whj123999's avatar
whj123999 已提交
11
  *
12 13 14 15
  * This software component is licensed by ST under BSD 3-Clause license,
  * the "License"; You may not use this file except in compliance with the
  * License. You may obtain a copy of the License at:
  *                        opensource.org/licenses/BSD-3-Clause
whj123999's avatar
whj123999 已提交
16 17
  *
  ******************************************************************************
18
  */
whj123999's avatar
whj123999 已提交
19 20

/* Define to prevent recursive inclusion -------------------------------------*/
21 22
#ifndef STM32H7xx_HAL_HASH_H
#define STM32H7xx_HAL_HASH_H
whj123999's avatar
whj123999 已提交
23 24 25 26 27 28 29 30 31 32 33 34 35 36

#ifdef __cplusplus
 extern "C" {
#endif

/* Includes ------------------------------------------------------------------*/
#include "stm32h7xx_hal_def.h"

/** @addtogroup STM32H7xx_HAL_Driver
  * @{
  */
#if defined (HASH)
/** @addtogroup HASH
  * @{
37
  */
whj123999's avatar
whj123999 已提交
38

39
/* Exported types ------------------------------------------------------------*/
whj123999's avatar
whj123999 已提交
40 41 42 43
/** @defgroup HASH_Exported_Types HASH Exported Types
  * @{
  */

44 45
/**
  * @brief  HASH Configuration Structure definition
whj123999's avatar
whj123999 已提交
46 47
  */
typedef struct
48
{
whj123999's avatar
whj123999 已提交
49 50
  uint32_t DataType;    /*!< 32-bit data, 16-bit data, 8-bit data or 1-bit data.
                              This parameter can be a value of @ref HASH_Data_Type. */
51

whj123999's avatar
whj123999 已提交
52
  uint32_t KeySize;     /*!< The key size is used only in HMAC operation. */
53

whj123999's avatar
whj123999 已提交
54
  uint8_t* pKey;        /*!< The key is used only in HMAC operation. */
55

whj123999's avatar
whj123999 已提交
56 57
} HASH_InitTypeDef;

58 59 60
/**
  * @brief HAL State structures definition
  */
whj123999's avatar
whj123999 已提交
61 62
typedef enum
{
63 64 65 66 67 68
  HAL_HASH_STATE_RESET             = 0x00U,    /*!< Peripheral is not initialized            */
  HAL_HASH_STATE_READY             = 0x01U,    /*!< Peripheral Initialized and ready for use */
  HAL_HASH_STATE_BUSY              = 0x02U,    /*!< Processing (hashing) is ongoing          */
  HAL_HASH_STATE_TIMEOUT           = 0x06U,    /*!< Timeout state                            */
  HAL_HASH_STATE_ERROR             = 0x07U,    /*!< Error state                              */
  HAL_HASH_STATE_SUSPENDED         = 0x08U     /*!< Suspended state                          */
whj123999's avatar
whj123999 已提交
69 70
}HAL_HASH_StateTypeDef;

71 72 73
/**
  * @brief HAL phase structures definition
  */
whj123999's avatar
whj123999 已提交
74 75
typedef enum
{
76 77 78
  HAL_HASH_PHASE_READY             = 0x01U,    /*!< HASH peripheral is ready to start                    */
  HAL_HASH_PHASE_PROCESS           = 0x02U,    /*!< HASH peripheral is in HASH processing phase          */
  HAL_HASH_PHASE_HMAC_STEP_1       = 0x03U,    /*!< HASH peripheral is in HMAC step 1 processing phase
whj123999's avatar
whj123999 已提交
79
                                              (step 1 consists in entering the inner hash function key) */
80
  HAL_HASH_PHASE_HMAC_STEP_2       = 0x04U,    /*!< HASH peripheral is in HMAC step 2 processing phase
whj123999's avatar
whj123999 已提交
81
                                              (step 2 consists in entering the message text) */
82
  HAL_HASH_PHASE_HMAC_STEP_3       = 0x05U     /*!< HASH peripheral is in HMAC step 3 processing phase
whj123999's avatar
whj123999 已提交
83 84 85
                                              (step 3 consists in entering the outer hash function key) */
}HAL_HASH_PhaseTypeDef;

86
/**
whj123999's avatar
whj123999 已提交
87 88 89 90
  * @brief HAL HASH mode suspend definitions
  */
typedef enum
{
91 92
  HAL_HASH_SUSPEND_NONE            = 0x00U,    /*!< HASH peripheral suspension not requested */
  HAL_HASH_SUSPEND                 = 0x01U     /*!< HASH peripheral suspension is requested  */
whj123999's avatar
whj123999 已提交
93 94
}HAL_HASH_SuspendTypeDef;

95 96 97 98 99 100 101 102 103 104 105 106 107 108
#if (USE_HAL_HASH_REGISTER_CALLBACKS == 1U)
/**
  * @brief  HAL HASH common Callback ID enumeration definition
  */
typedef enum
{
  HAL_HASH_MSPINIT_CB_ID           = 0x00U,    /*!< HASH MspInit callback ID     */
  HAL_HASH_MSPDEINIT_CB_ID         = 0x01U,    /*!< HASH MspDeInit callback ID   */
  HAL_HASH_INPUTCPLT_CB_ID         = 0x02U,    /*!< HASH input completion callback ID */
  HAL_HASH_DGSTCPLT_CB_ID          = 0x03U,    /*!< HASH digest computation completion callback ID */
  HAL_HASH_ERROR_CB_ID             = 0x04U,    /*!< HASH error callback ID     */
}HAL_HASH_CallbackIDTypeDef;
#endif /* USE_HAL_HASH_REGISTER_CALLBACKS */

whj123999's avatar
whj123999 已提交
109

110 111 112 113 114 115
/**
  * @brief  HASH Handle Structure definition
  */
#if (USE_HAL_HASH_REGISTER_CALLBACKS == 1)
typedef struct __HASH_HandleTypeDef
#else
whj123999's avatar
whj123999 已提交
116
typedef struct
117 118
#endif /* (USE_HAL_HASH_REGISTER_CALLBACKS) */
{
whj123999's avatar
whj123999 已提交
119
  HASH_InitTypeDef           Init;             /*!< HASH required parameters */
120

whj123999's avatar
whj123999 已提交
121 122 123
  uint8_t                    *pHashInBuffPtr;  /*!< Pointer to input buffer */

  uint8_t                    *pHashOutBuffPtr; /*!< Pointer to output buffer (digest) */
124

whj123999's avatar
whj123999 已提交
125 126
  uint8_t                    *pHashKeyBuffPtr; /*!< Pointer to key buffer (HMAC only) */

127
  uint8_t                    *pHashMsgBuffPtr; /*!< Pointer to message buffer (HMAC only) */
whj123999's avatar
whj123999 已提交
128

129 130 131 132 133 134 135
  uint32_t                   HashBuffSize;     /*!< Size of buffer to be processed */

  __IO uint32_t              HashInCount;      /*!< Counter of inputted data */

  __IO uint32_t              HashITCounter;    /*!< Counter of issued interrupts */

  __IO uint32_t              HashKeyCount;     /*!< Counter for Key inputted data (HMAC only) */
whj123999's avatar
whj123999 已提交
136 137 138

  HAL_StatusTypeDef          Status;           /*!< HASH peripheral status   */

139
  HAL_HASH_PhaseTypeDef      Phase;            /*!< HASH peripheral phase   */
whj123999's avatar
whj123999 已提交
140 141 142 143 144

  DMA_HandleTypeDef          *hdmain;          /*!< HASH In DMA Handle parameters */

  HAL_LockTypeDef            Lock;             /*!< Locking object */

145 146 147 148 149
  __IO HAL_HASH_StateTypeDef State;            /*!< HASH peripheral state */

  HAL_HASH_SuspendTypeDef    SuspendRequest;   /*!< HASH peripheral suspension request flag */

  FlagStatus                 DigestCalculationDisable;  /*!< Digest calculation phase skip (MDMAT bit control) for multi-buffers DMA-based HMAC computation */
whj123999's avatar
whj123999 已提交
150

151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
  __IO uint32_t              NbWordsAlreadyPushed;      /*!< Numbers of words already pushed in FIFO before inputting new block */

  __IO  uint32_t             ErrorCode;        /*!< HASH Error code */

#if (USE_HAL_HASH_REGISTER_CALLBACKS == 1)
  void    (* InCpltCallback)( struct __HASH_HandleTypeDef * hhash);    /*!< HASH input completion callback */

  void    (* DgstCpltCallback)( struct __HASH_HandleTypeDef * hhash);  /*!< HASH digest computation completion callback */

  void    (* ErrorCallback)( struct __HASH_HandleTypeDef * hhash);     /*!< HASH error callback */

  void    (* MspInitCallback)( struct __HASH_HandleTypeDef * hhash);   /*!< HASH Msp Init callback */

  void    (* MspDeInitCallback)( struct __HASH_HandleTypeDef * hhash); /*!< HASH Msp DeInit callback */

#endif /* (USE_HAL_HASH_REGISTER_CALLBACKS) */
whj123999's avatar
whj123999 已提交
167 168
} HASH_HandleTypeDef;

169 170 171 172 173 174 175
#if (USE_HAL_HASH_REGISTER_CALLBACKS == 1U)
/**
  * @brief  HAL HASH Callback pointer definition
  */
typedef  void (*pHASH_CallbackTypeDef)(HASH_HandleTypeDef * hhash); /*!< pointer to a HASH common callback functions */
#endif /* USE_HAL_HASH_REGISTER_CALLBACKS */

whj123999's avatar
whj123999 已提交
176 177 178 179 180 181 182 183 184 185 186 187
/**
  * @}
  */

/* Exported constants --------------------------------------------------------*/

/** @defgroup HASH_Exported_Constants  HASH Exported Constants
  * @{
  */

/** @defgroup HASH_Algo_Selection   HASH algorithm selection
  * @{
188 189 190
  */
#define HASH_ALGOSELECTION_SHA1      0x00000000U /*!< HASH function is SHA1   */
#define HASH_ALGOSELECTION_MD5       HASH_CR_ALGO_0     /*!< HASH function is MD5    */
whj123999's avatar
whj123999 已提交
191 192 193 194 195 196 197 198
#define HASH_ALGOSELECTION_SHA224    HASH_CR_ALGO_1     /*!< HASH function is SHA224 */
#define HASH_ALGOSELECTION_SHA256    HASH_CR_ALGO       /*!< HASH function is SHA256 */
/**
  * @}
  */

/** @defgroup HASH_Algorithm_Mode   HASH algorithm mode
  * @{
199 200
  */
#define HASH_ALGOMODE_HASH         0x00000000U /*!< Algorithm is HASH */
whj123999's avatar
whj123999 已提交
201 202 203 204 205 206 207
#define HASH_ALGOMODE_HMAC         HASH_CR_MODE           /*!< Algorithm is HMAC */
/**
  * @}
  */

/** @defgroup HASH_Data_Type      HASH input data type
  * @{
208 209
  */
#define HASH_DATATYPE_32B          0x00000000U /*!< 32-bit data. No swapping                     */
whj123999's avatar
whj123999 已提交
210 211 212 213 214 215 216 217 218
#define HASH_DATATYPE_16B          HASH_CR_DATATYPE_0 /*!< 16-bit data. Each half word is swapped       */
#define HASH_DATATYPE_8B           HASH_CR_DATATYPE_1 /*!< 8-bit data. All bytes are swapped            */
#define HASH_DATATYPE_1B           HASH_CR_DATATYPE   /*!< 1-bit data. In the word all bits are swapped */
/**
  * @}
  */

/** @defgroup HASH_HMAC_Long_key_only_for_HMAC_mode   HMAC key length type
  * @{
219 220
  */
#define HASH_HMAC_KEYTYPE_SHORTKEY      0x00000000U /*!< HMAC Key size is <= 64 bytes */
whj123999's avatar
whj123999 已提交
221 222 223 224 225 226 227
#define HASH_HMAC_KEYTYPE_LONGKEY       HASH_CR_LKEY           /*!< HMAC Key size is > 64 bytes  */
/**
  * @}
  */

/** @defgroup HASH_flags_definition  HASH flags definitions
  * @{
228
  */
whj123999's avatar
whj123999 已提交
229 230 231 232 233 234 235 236
#define HASH_FLAG_DINIS            HASH_SR_DINIS  /*!< 16 locations are free in the DIN : a new block can be entered in the IP */
#define HASH_FLAG_DCIS             HASH_SR_DCIS   /*!< Digest calculation complete                                             */
#define HASH_FLAG_DMAS             HASH_SR_DMAS   /*!< DMA interface is enabled (DMAE=1) or a transfer is ongoing              */
#define HASH_FLAG_BUSY             HASH_SR_BUSY   /*!< The hash core is Busy, processing a block of data                       */
#define HASH_FLAG_DINNE            HASH_CR_DINNE  /*!< DIN not empty : the input buffer contains at least one word of data     */

/**
  * @}
237
  */
whj123999's avatar
whj123999 已提交
238 239 240

/** @defgroup HASH_interrupts_definition   HASH interrupts definitions
  * @{
241
  */
whj123999's avatar
whj123999 已提交
242 243 244 245 246 247 248 249 250 251 252 253
#define HASH_IT_DINI               HASH_IMR_DINIE  /*!< A new block can be entered into the input buffer (DIN) */
#define HASH_IT_DCI                HASH_IMR_DCIE   /*!< Digest calculation complete                            */

/**
  * @}
  */
/** @defgroup HASH_alias HASH API alias
  * @{
  */
#define HAL_HASHEx_IRQHandler   HAL_HASH_IRQHandler  /*!< HAL_HASHEx_IRQHandler() is re-directed to HAL_HASH_IRQHandler() for compatibility with legacy code */
/**
  * @}
254 255 256 257 258 259 260 261 262 263 264 265 266 267
  */

/** @defgroup HASH_Error_Definition   HASH Error Definition
  * @{
  */
#define  HAL_HASH_ERROR_NONE             0x00000000U   /*!< No error                */
#define  HAL_HASH_ERROR_IT               0x00000001U   /*!< IT-based process error  */
#define  HAL_HASH_ERROR_DMA              0x00000002U   /*!< DMA-based process error */
#if (USE_HAL_HASH_REGISTER_CALLBACKS == 1U)
#define  HAL_HASH_ERROR_INVALID_CALLBACK 0x00000004U   /*!< Invalid Callback error  */
#endif /* USE_HAL_HASH_REGISTER_CALLBACKS */
/**
  * @}
  */
whj123999's avatar
whj123999 已提交
268 269 270 271 272 273 274 275 276 277 278 279 280

/**
  * @}
  */

/* Exported macros -----------------------------------------------------------*/
/** @defgroup HASH_Exported_Macros HASH Exported Macros
  * @{
  */

/** @brief  Check whether or not the specified HASH flag is set.
  * @param  __FLAG__: specifies the flag to check.
  *        This parameter can be one of the following values:
281
  *            @arg @ref HASH_FLAG_DINIS A new block can be entered into the input buffer.
whj123999's avatar
whj123999 已提交
282 283
  *            @arg @ref HASH_FLAG_DCIS Digest calculation complete.
  *            @arg @ref HASH_FLAG_DMAS DMA interface is enabled (DMAE=1) or a transfer is ongoing.
284
  *            @arg @ref HASH_FLAG_BUSY The hash core is Busy : processing a block of data.
whj123999's avatar
whj123999 已提交
285 286 287 288 289 290 291 292 293 294 295
  *            @arg @ref HASH_FLAG_DINNE DIN not empty : the input buffer contains at least one word of data.
  * @retval The new state of __FLAG__ (TRUE or FALSE).
  */
#define __HAL_HASH_GET_FLAG(__FLAG__)  (((__FLAG__) > 8U)  ?                    \
                                       ((HASH->CR & (__FLAG__)) == (__FLAG__)) :\
                                       ((HASH->SR & (__FLAG__)) == (__FLAG__)) )


/** @brief  Clear the specified HASH flag.
  * @param  __FLAG__: specifies the flag to clear.
  *        This parameter can be one of the following values:
296
  *            @arg @ref HASH_FLAG_DINIS A new block can be entered into the input buffer.
whj123999's avatar
whj123999 已提交
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
  *            @arg @ref HASH_FLAG_DCIS Digest calculation complete
  * @retval None
  */
#define __HAL_HASH_CLEAR_FLAG(__FLAG__) CLEAR_BIT(HASH->SR, (__FLAG__))


/** @brief  Enable the specified HASH interrupt.
  * @param  __INTERRUPT__: specifies the HASH interrupt source to enable.
  *          This parameter can be one of the following values:
  *            @arg @ref HASH_IT_DINI  A new block can be entered into the input buffer (DIN)
  *            @arg @ref HASH_IT_DCI   Digest calculation complete
  * @retval None
  */
#define __HAL_HASH_ENABLE_IT(__INTERRUPT__)   SET_BIT(HASH->IMR, (__INTERRUPT__))

/** @brief  Disable the specified HASH interrupt.
  * @param  __INTERRUPT__: specifies the HASH interrupt source to disable.
  *          This parameter can be one of the following values:
  *            @arg @ref HASH_IT_DINI  A new block can be entered into the input buffer (DIN)
  *            @arg @ref HASH_IT_DCI   Digest calculation complete
  * @retval None
  */
#define __HAL_HASH_DISABLE_IT(__INTERRUPT__)   CLEAR_BIT(HASH->IMR, (__INTERRUPT__))

/** @brief Reset HASH handle state.
  * @param  __HANDLE__: HASH handle.
  * @retval None
  */
325 326 327 328 329 330 331 332

#if (USE_HAL_HASH_REGISTER_CALLBACKS == 1)
#define __HAL_HASH_RESET_HANDLE_STATE(__HANDLE__) do{\
                                                      (__HANDLE__)->State = HAL_HASH_STATE_RESET;\
                                                      (__HANDLE__)->MspInitCallback = NULL;      \
                                                      (__HANDLE__)->MspDeInitCallback = NULL;    \
                                                     }while(0)
#else
whj123999's avatar
whj123999 已提交
333
#define __HAL_HASH_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_HASH_STATE_RESET)
334 335
#endif /* USE_HAL_HASH_REGISTER_CALLBACKS */

whj123999's avatar
whj123999 已提交
336 337 338 339 340 341 342 343

/** @brief Reset HASH handle status.
  * @param  __HANDLE__: HASH handle.
  * @retval None
  */
#define __HAL_HASH_RESET_HANDLE_STATUS(__HANDLE__) ((__HANDLE__)->Status = HAL_OK)

/**
344 345
  * @brief  Enable the multi-buffer DMA transfer mode.
  * @note   This bit is set when hashing large files when multiple DMA transfers are needed.
whj123999's avatar
whj123999 已提交
346 347
  * @retval None
  */
348
#define __HAL_HASH_SET_MDMAT()          SET_BIT(HASH->CR, HASH_CR_MDMAT)
whj123999's avatar
whj123999 已提交
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367

/**
  * @brief  Disable the multi-buffer DMA transfer mode.
  * @retval None
  */
#define __HAL_HASH_RESET_MDMAT()        CLEAR_BIT(HASH->CR, HASH_CR_MDMAT)


/**
  * @brief Start the digest computation.
  * @retval None
  */
#define __HAL_HASH_START_DIGEST()       SET_BIT(HASH->STR, HASH_STR_DCAL)

/**
  * @brief Set the number of valid bits in the last word written in data register DIN.
  * @param  __SIZE__: size in bytes of last data written in Data register.
  * @retval None
*/
368 369
#define  __HAL_HASH_SET_NBVALIDBITS(__SIZE__)    MODIFY_REG(HASH->STR, HASH_STR_NBLW, 8U * ((__SIZE__) % 4U))

whj123999's avatar
whj123999 已提交
370 371 372 373
/**
  * @brief Reset the HASH core.
  * @retval None
  */
374
#define __HAL_HASH_INIT()       SET_BIT(HASH->CR, HASH_CR_INIT)
whj123999's avatar
whj123999 已提交
375 376 377 378 379 380 381 382 383 384 385 386 387 388

/**
  * @}
  */


/* Private macros --------------------------------------------------------*/
/** @defgroup HASH_Private_Macros   HASH Private Macros
  * @{
  */
/**
  * @brief  Return digest length in bytes.
  * @retval Digest length
  */
389 390 391
#define HASH_DIGEST_LENGTH() ((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 ) ) )
whj123999's avatar
whj123999 已提交
392 393 394 395
/**
  * @brief  Return number of words already pushed in the FIFO.
  * @retval Number of words already pushed in the FIFO
  */
396
#define HASH_NBW_PUSHED() ((READ_BIT(HASH->CR, HASH_CR_NBW)) >> 8U)
whj123999's avatar
whj123999 已提交
397 398 399

/**
  * @brief Ensure that HASH input data type is valid.
400
  * @param __DATATYPE__: HASH input data type.
whj123999's avatar
whj123999 已提交
401
  * @retval SET (__DATATYPE__ is valid) or RESET (__DATATYPE__ is invalid)
402
  */
whj123999's avatar
whj123999 已提交
403 404 405
#define IS_HASH_DATATYPE(__DATATYPE__) (((__DATATYPE__) == HASH_DATATYPE_32B)|| \
                                        ((__DATATYPE__) == HASH_DATATYPE_16B)|| \
                                        ((__DATATYPE__) == HASH_DATATYPE_8B) || \
406 407 408 409
                                        ((__DATATYPE__) == HASH_DATATYPE_1B))



whj123999's avatar
whj123999 已提交
410
/**
411
  * @brief Ensure that input data buffer size is valid for multi-buffer HASH
whj123999's avatar
whj123999 已提交
412
  *        processing in polling mode.
413 414
  * @note  This check is valid only for multi-buffer HASH processing in polling mode.
  * @param __SIZE__: input data buffer size.
whj123999's avatar
whj123999 已提交
415 416
  * @retval SET (__SIZE__ is valid) or RESET (__SIZE__ is invalid)
  */
417
#define IS_HASH_POLLING_MULTIBUFFER_SIZE(__SIZE__)  (((__SIZE__) % 4U) == 0U)
whj123999's avatar
whj123999 已提交
418
/**
419
  * @brief Ensure that input data buffer size is valid for multi-buffer HASH
whj123999's avatar
whj123999 已提交
420
  *        processing in DMA mode.
421 422
  * @note  This check is valid only for multi-buffer HASH processing in DMA mode.
  * @param __SIZE__: input data buffer size.
whj123999's avatar
whj123999 已提交
423
  * @retval SET (__SIZE__ is valid) or RESET (__SIZE__ is invalid)
424 425
  */
#define IS_HASH_DMA_MULTIBUFFER_SIZE(__SIZE__)  ((READ_BIT(HASH->CR, HASH_CR_MDMAT) == 0U) || (((__SIZE__) % 4U) == 0U))
whj123999's avatar
whj123999 已提交
426 427

/**
428
  * @brief Ensure that input data buffer size is valid for multi-buffer HMAC
whj123999's avatar
whj123999 已提交
429 430
  *        processing in DMA mode.
  * @note  This check is valid only for multi-buffer HMAC processing in DMA mode.
431 432
  * @param __HANDLE__: HASH handle.
  * @param __SIZE__: input data buffer size.
whj123999's avatar
whj123999 已提交
433
  * @retval SET (__SIZE__ is valid) or RESET (__SIZE__ is invalid)
434 435
  */
#define IS_HMAC_DMA_MULTIBUFFER_SIZE(__HANDLE__,__SIZE__)  ((((__HANDLE__)->DigestCalculationDisable) == RESET) || (((__SIZE__) % 4U) == 0U))
whj123999's avatar
whj123999 已提交
436 437
/**
  * @brief Ensure that handle phase is set to HASH processing.
438
  * @param __HANDLE__: HASH handle.
whj123999's avatar
whj123999 已提交
439
  * @retval SET (handle phase is set to HASH processing) or RESET (handle phase is not set to HASH processing)
440
  */
whj123999's avatar
whj123999 已提交
441 442 443 444
#define IS_HASH_PROCESSING(__HANDLE__)  ((__HANDLE__)->Phase == HAL_HASH_PHASE_PROCESS)

/**
  * @brief Ensure that handle phase is set to HMAC processing.
445
  * @param __HANDLE__: HASH handle.
whj123999's avatar
whj123999 已提交
446
  * @retval SET (handle phase is set to HMAC processing) or RESET (handle phase is not set to HMAC processing)
447
  */
whj123999's avatar
whj123999 已提交
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
#define IS_HMAC_PROCESSING(__HANDLE__)  (((__HANDLE__)->Phase == HAL_HASH_PHASE_HMAC_STEP_1) || \
                                         ((__HANDLE__)->Phase == HAL_HASH_PHASE_HMAC_STEP_2) || \
                                         ((__HANDLE__)->Phase == HAL_HASH_PHASE_HMAC_STEP_3))

/**
  * @}
  */

/* Include HASH HAL Extended module */
#include "stm32h7xx_hal_hash_ex.h"
/* Exported functions --------------------------------------------------------*/

/** @addtogroup HASH_Exported_Functions HASH Exported Functions
  * @{
  */
463 464

/** @addtogroup HASH_Exported_Functions_Group1 Initialization and de-initialization functions
whj123999's avatar
whj123999 已提交
465 466 467 468 469 470 471 472 473 474 475
  * @{
  */

/* Initialization/de-initialization methods  **********************************/
HAL_StatusTypeDef HAL_HASH_Init(HASH_HandleTypeDef *hhash);
HAL_StatusTypeDef HAL_HASH_DeInit(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);
476 477 478 479 480 481
/* Callbacks Register/UnRegister functions  ***********************************/
#if (USE_HAL_HASH_REGISTER_CALLBACKS == 1)
HAL_StatusTypeDef HAL_HASH_RegisterCallback(HASH_HandleTypeDef *hhash, HAL_HASH_CallbackIDTypeDef CallbackID, pHASH_CallbackTypeDef pCallback);
HAL_StatusTypeDef HAL_HASH_UnRegisterCallback(HASH_HandleTypeDef *hhash, HAL_HASH_CallbackIDTypeDef CallbackID);
#endif /* USE_HAL_HASH_REGISTER_CALLBACKS */

whj123999's avatar
whj123999 已提交
482 483 484 485 486

/**
  * @}
  */

487
/** @addtogroup HASH_Exported_Functions_Group2 HASH processing functions in polling mode
whj123999's avatar
whj123999 已提交
488 489 490 491 492 493 494 495 496 497 498 499 500 501
  * @{
  */


/* HASH processing using polling  *********************************************/
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);

/**
  * @}
  */

502
/** @addtogroup HASH_Exported_Functions_Group3 HASH processing functions in interrupt mode
whj123999's avatar
whj123999 已提交
503 504 505 506 507 508 509 510 511 512 513
  * @{
  */

/* HASH processing using IT  **************************************************/
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);
void HAL_HASH_IRQHandler(HASH_HandleTypeDef *hhash);
/**
  * @}
  */

514
/** @addtogroup HASH_Exported_Functions_Group4 HASH processing functions in DMA mode
whj123999's avatar
whj123999 已提交
515 516 517 518 519 520 521 522 523 524 525 526 527
  * @{
  */

/* HASH processing using DMA  *************************************************/
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);

/**
  * @}
  */

528
/** @addtogroup HASH_Exported_Functions_Group5 HMAC processing functions in polling mode
whj123999's avatar
whj123999 已提交
529 530 531 532 533 534 535 536 537 538 539
  * @{
  */

/* HASH-MAC processing using polling  *****************************************/
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);

/**
  * @}
  */

540
/** @addtogroup HASH_Exported_Functions_Group6 HMAC processing functions in interrupt mode
whj123999's avatar
whj123999 已提交
541 542 543 544 545 546 547 548 549 550
  * @{
  */

HAL_StatusTypeDef HAL_HMAC_MD5_Start_IT(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t* pOutBuffer);
HAL_StatusTypeDef HAL_HMAC_SHA1_Start_IT(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t* pOutBuffer);

/**
  * @}
  */

551
/** @addtogroup HASH_Exported_Functions_Group7 HMAC processing functions in DMA mode
whj123999's avatar
whj123999 已提交
552 553 554 555 556 557 558 559 560 561 562
  * @{
  */

/* HASH-HMAC processing using DMA  ********************************************/
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);

/**
  * @}
  */

563
/** @addtogroup HASH_Exported_Functions_Group8 Peripheral states functions
whj123999's avatar
whj123999 已提交
564 565 566 567 568 569 570 571 572 573 574
  * @{
  */


/* Peripheral State methods  **************************************************/
HAL_HASH_StateTypeDef HAL_HASH_GetState(HASH_HandleTypeDef *hhash);
HAL_StatusTypeDef HAL_HASH_GetStatus(HASH_HandleTypeDef *hhash);
void HAL_HASH_ContextSaving(HASH_HandleTypeDef *hhash, uint8_t* pMemBuffer);
void HAL_HASH_ContextRestoring(HASH_HandleTypeDef *hhash, uint8_t* pMemBuffer);
void HAL_HASH_SwFeed_ProcessSuspend(HASH_HandleTypeDef *hhash);
HAL_StatusTypeDef HAL_HASH_DMAFeed_ProcessSuspend(HASH_HandleTypeDef *hhash);
575
uint32_t HAL_HASH_GetError(HASH_HandleTypeDef *hhash);
whj123999's avatar
whj123999 已提交
576 577 578 579

/**
  * @}
  */
580

whj123999's avatar
whj123999 已提交
581 582 583 584
/**
  * @}
  */

585
/* Private functions -----------------------------------------------------------*/
whj123999's avatar
whj123999 已提交
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602

/** @addtogroup HASH_Private_Functions HASH Private Functions
  * @{
  */

/* Private functions */
HAL_StatusTypeDef HASH_Start(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t* pOutBuffer, uint32_t Timeout, uint32_t Algorithm);
HAL_StatusTypeDef HASH_Accumulate(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint32_t Algorithm);
HAL_StatusTypeDef HASH_Start_IT(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t* pOutBuffer, uint32_t Algorithm);
HAL_StatusTypeDef HASH_Start_DMA(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint32_t Algorithm);
HAL_StatusTypeDef HASH_Finish(HASH_HandleTypeDef *hhash, uint8_t* pOutBuffer, uint32_t Timeout);
HAL_StatusTypeDef HMAC_Start(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t* pOutBuffer, uint32_t Timeout, uint32_t Algorithm);
HAL_StatusTypeDef HMAC_Start_IT(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t* pOutBuffer, uint32_t Algorithm);
HAL_StatusTypeDef HMAC_Start_DMA(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint32_t Algorithm);

/**
  * @}
603
  */
whj123999's avatar
whj123999 已提交
604 605 606 607

/**
  * @}
  */
608
#endif /*  HASH*/
whj123999's avatar
whj123999 已提交
609 610
/**
  * @}
611 612 613
  */


whj123999's avatar
whj123999 已提交
614 615 616 617 618
#ifdef __cplusplus
}
#endif


619
#endif /* STM32H7xx_HAL_HASH_H */
whj123999's avatar
whj123999 已提交
620 621

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