• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /**
2   ******************************************************************************
3   * @file    stm32f4xx_hal_hash.h
4   * @author  MCD Application Team
5   * @brief   Header file of HASH HAL module.
6   ******************************************************************************
7   * @attention
8   *
9   * <h2><center>&copy; Copyright (c) 2016 STMicroelectronics.
10   * All rights reserved.</center></h2>
11   *
12   * This software component is licensed by ST under BSD 3-Clause license,
13   * the "License"; You may not use this file except in compliance with the
14   * License. You may obtain a copy of the License at:
15   *                        opensource.org/licenses/BSD-3-Clause
16   *
17   ******************************************************************************
18   */
19 
20 /* Define to prevent recursive inclusion -------------------------------------*/
21 #ifndef STM32F4xx_HAL_HASH_H
22 #define STM32F4xx_HAL_HASH_H
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /* Includes ------------------------------------------------------------------*/
29 #include "stm32f4xx_hal_def.h"
30 
31 /** @addtogroup STM32F4xx_HAL_Driver
32   * @{
33   */
34 #if defined (HASH)
35 /** @addtogroup HASH
36   * @{
37   */
38 
39 /* Exported types ------------------------------------------------------------*/
40 /** @defgroup HASH_Exported_Types HASH Exported Types
41   * @{
42   */
43 
44 /**
45   * @brief  HASH Configuration Structure definition
46   */
47 typedef struct
48 {
49   uint32_t DataType;    /*!< 32-bit data, 16-bit data, 8-bit data or 1-bit data.
50                               This parameter can be a value of @ref HASH_Data_Type. */
51 
52   uint32_t KeySize;     /*!< The key size is used only in HMAC operation. */
53 
54   uint8_t *pKey;        /*!< The key is used only in HMAC operation. */
55 
56 } HASH_InitTypeDef;
57 
58 /**
59   * @brief HAL State structures definition
60   */
61 typedef enum
62 {
63   HAL_HASH_STATE_RESET             = 0x00U,    /*!< Peripheral is not initialized            */
64   HAL_HASH_STATE_READY             = 0x01U,    /*!< Peripheral Initialized and ready for use */
65   HAL_HASH_STATE_BUSY              = 0x02U,    /*!< Processing (hashing) is ongoing          */
66   HAL_HASH_STATE_TIMEOUT           = 0x06U,    /*!< Timeout state                            */
67   HAL_HASH_STATE_ERROR             = 0x07U,    /*!< Error state                              */
68   HAL_HASH_STATE_SUSPENDED         = 0x08U     /*!< Suspended state                          */
69 } HAL_HASH_StateTypeDef;
70 
71 /**
72   * @brief HAL phase structures definition
73   */
74 typedef enum
75 {
76   HAL_HASH_PHASE_READY             = 0x01U,    /*!< HASH peripheral is ready to start                    */
77   HAL_HASH_PHASE_PROCESS           = 0x02U,    /*!< HASH peripheral is in HASH processing phase          */
78   HAL_HASH_PHASE_HMAC_STEP_1       = 0x03U,    /*!< HASH peripheral is in HMAC step 1 processing phase
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
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
83                                               (step 3 consists in entering the outer hash function key) */
84 } HAL_HASH_PhaseTypeDef;
85 
86 /**
87   * @brief HAL HASH mode suspend definitions
88   */
89 typedef enum
90 {
91   HAL_HASH_SUSPEND_NONE            = 0x00U,    /*!< HASH peripheral suspension not requested */
92   HAL_HASH_SUSPEND                 = 0x01U     /*!< HASH peripheral suspension is requested  */
93 } HAL_HASH_SuspendTypeDef;
94 
95 #if (USE_HAL_HASH_REGISTER_CALLBACKS == 1U)
96 /**
97   * @brief  HAL HASH common Callback ID enumeration definition
98   */
99 typedef enum
100 {
101   HAL_HASH_MSPINIT_CB_ID           = 0x00U,    /*!< HASH MspInit callback ID     */
102   HAL_HASH_MSPDEINIT_CB_ID         = 0x01U,    /*!< HASH MspDeInit callback ID   */
103   HAL_HASH_INPUTCPLT_CB_ID         = 0x02U,    /*!< HASH input completion callback ID */
104   HAL_HASH_DGSTCPLT_CB_ID          = 0x03U,    /*!< HASH digest computation completion callback ID */
105   HAL_HASH_ERROR_CB_ID             = 0x04U,    /*!< HASH error callback ID     */
106 } HAL_HASH_CallbackIDTypeDef;
107 #endif /* USE_HAL_HASH_REGISTER_CALLBACKS */
108 
109 
110 /**
111   * @brief  HASH Handle Structure definition
112   */
113 #if (USE_HAL_HASH_REGISTER_CALLBACKS == 1)
114 typedef struct __HASH_HandleTypeDef
115 #else
116 typedef struct
117 #endif /* (USE_HAL_HASH_REGISTER_CALLBACKS) */
118 {
119   HASH_InitTypeDef           Init;             /*!< HASH required parameters */
120 
121   uint8_t                    *pHashInBuffPtr;  /*!< Pointer to input buffer */
122 
123   uint8_t                    *pHashOutBuffPtr; /*!< Pointer to output buffer (digest) */
124 
125   uint8_t                    *pHashKeyBuffPtr; /*!< Pointer to key buffer (HMAC only) */
126 
127   uint8_t                    *pHashMsgBuffPtr; /*!< Pointer to message buffer (HMAC only) */
128 
129   uint32_t                   HashBuffSize;     /*!< Size of buffer to be processed */
130 
131   __IO uint32_t              HashInCount;      /*!< Counter of inputted data */
132 
133   __IO uint32_t              HashITCounter;    /*!< Counter of issued interrupts */
134 
135   __IO uint32_t              HashKeyCount;     /*!< Counter for Key inputted data (HMAC only) */
136 
137   HAL_StatusTypeDef          Status;           /*!< HASH peripheral status   */
138 
139   HAL_HASH_PhaseTypeDef      Phase;            /*!< HASH peripheral phase   */
140 
141   DMA_HandleTypeDef          *hdmain;          /*!< HASH In DMA Handle parameters */
142 
143   HAL_LockTypeDef            Lock;             /*!< Locking object */
144 
145   __IO HAL_HASH_StateTypeDef State;            /*!< HASH peripheral state */
146 
147   HAL_HASH_SuspendTypeDef    SuspendRequest;   /*!< HASH peripheral suspension request flag */
148 
149   FlagStatus                 DigestCalculationDisable;  /*!< Digest calculation phase skip (MDMAT bit control) for multi-buffers DMA-based HMAC computation */
150 
151   __IO uint32_t              NbWordsAlreadyPushed;      /*!< Numbers of words already pushed in FIFO before inputting new block */
152 
153   __IO  uint32_t             ErrorCode;        /*!< HASH Error code */
154 
155   __IO  uint32_t             Accumulation;     /*!< HASH multi buffers accumulation flag */
156 
157 #if (USE_HAL_HASH_REGISTER_CALLBACKS == 1)
158   void (* InCpltCallback)(struct __HASH_HandleTypeDef *hhash);         /*!< HASH input completion callback */
159 
160   void (* DgstCpltCallback)(struct __HASH_HandleTypeDef *hhash);       /*!< HASH digest computation completion callback */
161 
162   void (* ErrorCallback)(struct __HASH_HandleTypeDef *hhash);          /*!< HASH error callback */
163 
164   void (* MspInitCallback)(struct __HASH_HandleTypeDef *hhash);        /*!< HASH Msp Init callback */
165 
166   void (* MspDeInitCallback)(struct __HASH_HandleTypeDef *hhash);      /*!< HASH Msp DeInit callback */
167 
168 #endif /* (USE_HAL_HASH_REGISTER_CALLBACKS) */
169 } HASH_HandleTypeDef;
170 
171 #if (USE_HAL_HASH_REGISTER_CALLBACKS == 1U)
172 /**
173   * @brief  HAL HASH Callback pointer definition
174   */
175 typedef  void (*pHASH_CallbackTypeDef)(HASH_HandleTypeDef *hhash);  /*!< pointer to a HASH common callback functions */
176 #endif /* USE_HAL_HASH_REGISTER_CALLBACKS */
177 
178 /**
179   * @}
180   */
181 
182 /* Exported constants --------------------------------------------------------*/
183 
184 /** @defgroup HASH_Exported_Constants  HASH Exported Constants
185   * @{
186   */
187 
188 /** @defgroup HASH_Algo_Selection   HASH algorithm selection
189   * @{
190   */
191 #define HASH_ALGOSELECTION_SHA1      0x00000000U /*!< HASH function is SHA1   */
192 #define HASH_ALGOSELECTION_MD5       HASH_CR_ALGO_0     /*!< HASH function is MD5    */
193 #define HASH_ALGOSELECTION_SHA224    HASH_CR_ALGO_1     /*!< HASH function is SHA224 */
194 #define HASH_ALGOSELECTION_SHA256    HASH_CR_ALGO       /*!< HASH function is SHA256 */
195 /**
196   * @}
197   */
198 
199 /** @defgroup HASH_Algorithm_Mode   HASH algorithm mode
200   * @{
201   */
202 #define HASH_ALGOMODE_HASH         0x00000000U /*!< Algorithm is HASH */
203 #define HASH_ALGOMODE_HMAC         HASH_CR_MODE           /*!< Algorithm is HMAC */
204 /**
205   * @}
206   */
207 
208 /** @defgroup HASH_Data_Type      HASH input data type
209   * @{
210   */
211 #define HASH_DATATYPE_32B          0x00000000U /*!< 32-bit data. No swapping                     */
212 #define HASH_DATATYPE_16B          HASH_CR_DATATYPE_0 /*!< 16-bit data. Each half word is swapped       */
213 #define HASH_DATATYPE_8B           HASH_CR_DATATYPE_1 /*!< 8-bit data. All bytes are swapped            */
214 #define HASH_DATATYPE_1B           HASH_CR_DATATYPE   /*!< 1-bit data. In the word all bits are swapped */
215 /**
216   * @}
217   */
218 
219 /** @defgroup HASH_HMAC_Long_key_only_for_HMAC_mode   HMAC key length type
220   * @{
221   */
222 #define HASH_HMAC_KEYTYPE_SHORTKEY      0x00000000U /*!< HMAC Key size is <= 64 bytes */
223 #define HASH_HMAC_KEYTYPE_LONGKEY       HASH_CR_LKEY           /*!< HMAC Key size is > 64 bytes  */
224 /**
225   * @}
226   */
227 
228 /** @defgroup HASH_flags_definition  HASH flags definitions
229   * @{
230   */
231 #define HASH_FLAG_DINIS            HASH_SR_DINIS  /*!< 16 locations are free in the DIN : a new block can be entered in the Peripheral */
232 #define HASH_FLAG_DCIS             HASH_SR_DCIS   /*!< Digest calculation complete                                                     */
233 #define HASH_FLAG_DMAS             HASH_SR_DMAS   /*!< DMA interface is enabled (DMAE=1) or a transfer is ongoing                      */
234 #define HASH_FLAG_BUSY             HASH_SR_BUSY   /*!< The hash core is Busy, processing a block of data                               */
235 #define HASH_FLAG_DINNE            HASH_CR_DINNE  /*!< DIN not empty : the input buffer contains at least one word of data             */
236 
237 /**
238   * @}
239   */
240 
241 /** @defgroup HASH_interrupts_definition   HASH interrupts definitions
242   * @{
243   */
244 #define HASH_IT_DINI               HASH_IMR_DINIE  /*!< A new block can be entered into the input buffer (DIN) */
245 #define HASH_IT_DCI                HASH_IMR_DCIE   /*!< Digest calculation complete                            */
246 
247 /**
248   * @}
249   */
250 
251 /** @defgroup HASH_Error_Definition   HASH Error Definition
252   * @{
253   */
254 #define  HAL_HASH_ERROR_NONE             0x00000000U   /*!< No error                */
255 #define  HAL_HASH_ERROR_IT               0x00000001U   /*!< IT-based process error  */
256 #define  HAL_HASH_ERROR_DMA              0x00000002U   /*!< DMA-based process error */
257 #if (USE_HAL_HASH_REGISTER_CALLBACKS == 1U)
258 #define  HAL_HASH_ERROR_INVALID_CALLBACK 0x00000004U   /*!< Invalid Callback error  */
259 #endif /* USE_HAL_HASH_REGISTER_CALLBACKS */
260 /**
261   * @}
262   */
263 
264 /**
265   * @}
266   */
267 
268 /* Exported macros -----------------------------------------------------------*/
269 /** @defgroup HASH_Exported_Macros HASH Exported Macros
270   * @{
271   */
272 
273 /** @brief  Check whether or not the specified HASH flag is set.
274   * @param  __FLAG__ specifies the flag to check.
275   *        This parameter can be one of the following values:
276   *            @arg @ref HASH_FLAG_DINIS A new block can be entered into the input buffer.
277   *            @arg @ref HASH_FLAG_DCIS Digest calculation complete.
278   *            @arg @ref HASH_FLAG_DMAS DMA interface is enabled (DMAE=1) or a transfer is ongoing.
279   *            @arg @ref HASH_FLAG_BUSY The hash core is Busy : processing a block of data.
280   *            @arg @ref HASH_FLAG_DINNE DIN not empty : the input buffer contains at least one word of data.
281   * @retval The new state of __FLAG__ (TRUE or FALSE).
282   */
283 #define __HAL_HASH_GET_FLAG(__FLAG__)  (((__FLAG__) > 8U)  ?                    \
284                                         ((HASH->CR & (__FLAG__)) == (__FLAG__)) :\
285                                         ((HASH->SR & (__FLAG__)) == (__FLAG__)) )
286 
287 
288 /** @brief  Clear the specified HASH flag.
289   * @param  __FLAG__ specifies the flag to clear.
290   *        This parameter can be one of the following values:
291   *            @arg @ref HASH_FLAG_DINIS A new block can be entered into the input buffer.
292   *            @arg @ref HASH_FLAG_DCIS Digest calculation complete
293   * @retval None
294   */
295 #define __HAL_HASH_CLEAR_FLAG(__FLAG__) CLEAR_BIT(HASH->SR, (__FLAG__))
296 
297 
298 /** @brief  Enable the specified HASH interrupt.
299   * @param  __INTERRUPT__ specifies the HASH interrupt source to enable.
300   *          This parameter can be one of the following values:
301   *            @arg @ref HASH_IT_DINI  A new block can be entered into the input buffer (DIN)
302   *            @arg @ref HASH_IT_DCI   Digest calculation complete
303   * @retval None
304   */
305 #define __HAL_HASH_ENABLE_IT(__INTERRUPT__)   SET_BIT(HASH->IMR, (__INTERRUPT__))
306 
307 /** @brief  Disable the specified HASH interrupt.
308   * @param  __INTERRUPT__ specifies the HASH interrupt source to disable.
309   *          This parameter can be one of the following values:
310   *            @arg @ref HASH_IT_DINI  A new block can be entered into the input buffer (DIN)
311   *            @arg @ref HASH_IT_DCI   Digest calculation complete
312   * @retval None
313   */
314 #define __HAL_HASH_DISABLE_IT(__INTERRUPT__)   CLEAR_BIT(HASH->IMR, (__INTERRUPT__))
315 
316 /** @brief Reset HASH handle state.
317   * @param  __HANDLE__ HASH handle.
318   * @retval None
319   */
320 
321 #if (USE_HAL_HASH_REGISTER_CALLBACKS == 1)
322 #define __HAL_HASH_RESET_HANDLE_STATE(__HANDLE__) do{\
323                                                       (__HANDLE__)->State = HAL_HASH_STATE_RESET;\
324                                                       (__HANDLE__)->MspInitCallback = NULL;      \
325                                                       (__HANDLE__)->MspDeInitCallback = NULL;    \
326                                                      }while(0)
327 #else
328 #define __HAL_HASH_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_HASH_STATE_RESET)
329 #endif /* USE_HAL_HASH_REGISTER_CALLBACKS */
330 
331 
332 /** @brief Reset HASH handle status.
333   * @param  __HANDLE__ HASH handle.
334   * @retval None
335   */
336 #define __HAL_HASH_RESET_HANDLE_STATUS(__HANDLE__) ((__HANDLE__)->Status = HAL_OK)
337 
338 /**
339   * @brief  Enable the multi-buffer DMA transfer mode.
340   * @note   This bit is set when hashing large files when multiple DMA transfers are needed.
341   * @retval None
342   */
343 #define __HAL_HASH_SET_MDMAT()          SET_BIT(HASH->CR, HASH_CR_MDMAT)
344 
345 /**
346   * @brief  Disable the multi-buffer DMA transfer mode.
347   * @retval None
348   */
349 #define __HAL_HASH_RESET_MDMAT()        CLEAR_BIT(HASH->CR, HASH_CR_MDMAT)
350 
351 
352 /**
353   * @brief Start the digest computation.
354   * @retval None
355   */
356 #define __HAL_HASH_START_DIGEST()       SET_BIT(HASH->STR, HASH_STR_DCAL)
357 
358 /**
359   * @brief Set the number of valid bits in the last word written in data register DIN.
360   * @param  __SIZE__ size in bytes of last data written in Data register.
361   * @retval None
362   */
363 #define  __HAL_HASH_SET_NBVALIDBITS(__SIZE__)    MODIFY_REG(HASH->STR, HASH_STR_NBLW, 8U * ((__SIZE__) % 4U))
364 
365 /**
366   * @brief Reset the HASH core.
367   * @retval None
368   */
369 #define __HAL_HASH_INIT()       SET_BIT(HASH->CR, HASH_CR_INIT)
370 
371 /**
372   * @}
373   */
374 
375 
376 /* Private macros --------------------------------------------------------*/
377 /** @defgroup HASH_Private_Macros   HASH Private Macros
378   * @{
379   */
380 /**
381   * @brief  Return digest length in bytes.
382   * @retval Digest length
383   */
384 #if defined(HASH_CR_MDMAT)
385 #define HASH_DIGEST_LENGTH() ((READ_BIT(HASH->CR, HASH_CR_ALGO) == HASH_ALGOSELECTION_SHA1)   ?  20U : \
386                               ((READ_BIT(HASH->CR, HASH_CR_ALGO) == HASH_ALGOSELECTION_SHA224) ?  28U : \
387                                ((READ_BIT(HASH->CR, HASH_CR_ALGO) == HASH_ALGOSELECTION_SHA256) ?  32U : 16U ) ) )
388 #else
389 #define HASH_DIGEST_LENGTH() ((READ_BIT(HASH->CR, HASH_CR_ALGO) == HASH_ALGOSELECTION_SHA1)   ?  20U : 16)
390 #endif  /* HASH_CR_MDMAT*/
391 /**
392   * @brief  Return number of words already pushed in the FIFO.
393   * @retval Number of words already pushed in the FIFO
394   */
395 #define HASH_NBW_PUSHED() ((READ_BIT(HASH->CR, HASH_CR_NBW)) >> 8U)
396 
397 /**
398   * @brief Ensure that HASH input data type is valid.
399   * @param __DATATYPE__ HASH input data type.
400   * @retval SET (__DATATYPE__ is valid) or RESET (__DATATYPE__ is invalid)
401   */
402 #define IS_HASH_DATATYPE(__DATATYPE__) (((__DATATYPE__) == HASH_DATATYPE_32B)|| \
403                                         ((__DATATYPE__) == HASH_DATATYPE_16B)|| \
404                                         ((__DATATYPE__) == HASH_DATATYPE_8B) || \
405                                         ((__DATATYPE__) == HASH_DATATYPE_1B))
406 
407 /**
408   * @brief Ensure that input data buffer size is valid for multi-buffer HASH
409   *        processing in DMA mode.
410   * @note  This check is valid only for multi-buffer HASH processing in DMA mode.
411   * @param __SIZE__ input data buffer size.
412   * @retval SET (__SIZE__ is valid) or RESET (__SIZE__ is invalid)
413   */
414 #define IS_HASH_DMA_MULTIBUFFER_SIZE(__SIZE__)  ((READ_BIT(HASH->CR, HASH_CR_MDMAT) == 0U) || (((__SIZE__) % 4U) == 0U))
415 
416 /**
417   * @brief Ensure that input data buffer size is valid for multi-buffer HMAC
418   *        processing in DMA mode.
419   * @note  This check is valid only for multi-buffer HMAC processing in DMA mode.
420   * @param __HANDLE__ HASH handle.
421   * @param __SIZE__ input data buffer size.
422   * @retval SET (__SIZE__ is valid) or RESET (__SIZE__ is invalid)
423   */
424 #define IS_HMAC_DMA_MULTIBUFFER_SIZE(__HANDLE__,__SIZE__)  ((((__HANDLE__)->DigestCalculationDisable) == RESET)\
425                                                             || (((__SIZE__) % 4U) == 0U))
426 /**
427   * @brief Ensure that handle phase is set to HASH processing.
428   * @param __HANDLE__ HASH handle.
429   * @retval SET (handle phase is set to HASH processing) or RESET (handle phase is not set to HASH processing)
430   */
431 #define IS_HASH_PROCESSING(__HANDLE__)  ((__HANDLE__)->Phase == HAL_HASH_PHASE_PROCESS)
432 
433 /**
434   * @brief Ensure that handle phase is set to HMAC processing.
435   * @param __HANDLE__ HASH handle.
436   * @retval SET (handle phase is set to HMAC processing) or RESET (handle phase is not set to HMAC processing)
437   */
438 #define IS_HMAC_PROCESSING(__HANDLE__)  (((__HANDLE__)->Phase == HAL_HASH_PHASE_HMAC_STEP_1) || \
439                                          ((__HANDLE__)->Phase == HAL_HASH_PHASE_HMAC_STEP_2) || \
440                                          ((__HANDLE__)->Phase == HAL_HASH_PHASE_HMAC_STEP_3))
441 
442 /**
443   * @}
444   */
445 
446 /* Include HASH HAL Extended module */
447 #include "stm32f4xx_hal_hash_ex.h"
448 /* Exported functions --------------------------------------------------------*/
449 
450 /** @addtogroup HASH_Exported_Functions HASH Exported Functions
451   * @{
452   */
453 
454 /** @addtogroup HASH_Exported_Functions_Group1 Initialization and de-initialization functions
455   * @{
456   */
457 
458 /* Initialization/de-initialization methods  **********************************/
459 HAL_StatusTypeDef HAL_HASH_Init(HASH_HandleTypeDef *hhash);
460 HAL_StatusTypeDef HAL_HASH_DeInit(HASH_HandleTypeDef *hhash);
461 void HAL_HASH_MspInit(HASH_HandleTypeDef *hhash);
462 void HAL_HASH_MspDeInit(HASH_HandleTypeDef *hhash);
463 void HAL_HASH_InCpltCallback(HASH_HandleTypeDef *hhash);
464 void HAL_HASH_DgstCpltCallback(HASH_HandleTypeDef *hhash);
465 void HAL_HASH_ErrorCallback(HASH_HandleTypeDef *hhash);
466 /* Callbacks Register/UnRegister functions  ***********************************/
467 #if (USE_HAL_HASH_REGISTER_CALLBACKS == 1)
468 HAL_StatusTypeDef HAL_HASH_RegisterCallback(HASH_HandleTypeDef *hhash, HAL_HASH_CallbackIDTypeDef CallbackID,
469                                             pHASH_CallbackTypeDef pCallback);
470 HAL_StatusTypeDef HAL_HASH_UnRegisterCallback(HASH_HandleTypeDef *hhash, HAL_HASH_CallbackIDTypeDef CallbackID);
471 #endif /* USE_HAL_HASH_REGISTER_CALLBACKS */
472 
473 
474 /**
475   * @}
476   */
477 
478 /** @addtogroup HASH_Exported_Functions_Group2 HASH processing functions in polling mode
479   * @{
480   */
481 
482 
483 /* HASH processing using polling  *********************************************/
484 HAL_StatusTypeDef HAL_HASH_SHA1_Start(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t *pOutBuffer,
485                                       uint32_t Timeout);
486 HAL_StatusTypeDef HAL_HASH_MD5_Start(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t *pOutBuffer,
487                                      uint32_t Timeout);
488 HAL_StatusTypeDef HAL_HASH_MD5_Accmlt(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size);
489 HAL_StatusTypeDef HAL_HASH_SHA1_Accmlt(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size);
490 HAL_StatusTypeDef HAL_HASH_MD5_Accmlt_End(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size,
491                                           uint8_t *pOutBuffer, uint32_t Timeout);
492 HAL_StatusTypeDef HAL_HASH_SHA1_Accmlt_End(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size,
493                                            uint8_t *pOutBuffer, uint32_t Timeout);
494 
495 
496 /**
497   * @}
498   */
499 
500 /** @addtogroup HASH_Exported_Functions_Group3 HASH processing functions in interrupt mode
501   * @{
502   */
503 
504 /* HASH processing using IT  **************************************************/
505 HAL_StatusTypeDef HAL_HASH_SHA1_Start_IT(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size,
506                                          uint8_t *pOutBuffer);
507 HAL_StatusTypeDef HAL_HASH_SHA1_Accmlt_IT(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size);
508 HAL_StatusTypeDef HAL_HASH_SHA1_Accmlt_End_IT(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size,
509                                               uint8_t *pOutBuffer);
510 HAL_StatusTypeDef HAL_HASH_MD5_Start_IT(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size,
511                                         uint8_t *pOutBuffer);
512 HAL_StatusTypeDef HAL_HASH_MD5_Accmlt_IT(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size);
513 HAL_StatusTypeDef HAL_HASH_MD5_Accmlt_End_IT(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size,
514                                              uint8_t *pOutBuffer);
515 void HAL_HASH_IRQHandler(HASH_HandleTypeDef *hhash);
516 /**
517   * @}
518   */
519 
520 /** @addtogroup HASH_Exported_Functions_Group4 HASH processing functions in DMA mode
521   * @{
522   */
523 
524 /* HASH processing using DMA  *************************************************/
525 HAL_StatusTypeDef HAL_HASH_SHA1_Start_DMA(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size);
526 HAL_StatusTypeDef HAL_HASH_SHA1_Finish(HASH_HandleTypeDef *hhash, uint8_t *pOutBuffer, uint32_t Timeout);
527 HAL_StatusTypeDef HAL_HASH_MD5_Start_DMA(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size);
528 HAL_StatusTypeDef HAL_HASH_MD5_Finish(HASH_HandleTypeDef *hhash, uint8_t *pOutBuffer, uint32_t Timeout);
529 
530 /**
531   * @}
532   */
533 
534 /** @addtogroup HASH_Exported_Functions_Group5 HMAC processing functions in polling mode
535   * @{
536   */
537 
538 /* HASH-MAC processing using polling  *****************************************/
539 HAL_StatusTypeDef HAL_HMAC_SHA1_Start(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t *pOutBuffer,
540                                       uint32_t Timeout);
541 HAL_StatusTypeDef HAL_HMAC_MD5_Start(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t *pOutBuffer,
542                                      uint32_t Timeout);
543 
544 /**
545   * @}
546   */
547 
548 /** @addtogroup HASH_Exported_Functions_Group6 HMAC processing functions in interrupt mode
549   * @{
550   */
551 
552 HAL_StatusTypeDef HAL_HMAC_MD5_Start_IT(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size,
553                                         uint8_t *pOutBuffer);
554 HAL_StatusTypeDef HAL_HMAC_SHA1_Start_IT(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size,
555                                          uint8_t *pOutBuffer);
556 
557 /**
558   * @}
559   */
560 
561 /** @addtogroup HASH_Exported_Functions_Group7 HMAC processing functions in DMA mode
562   * @{
563   */
564 
565 /* HASH-HMAC processing using DMA  ********************************************/
566 HAL_StatusTypeDef HAL_HMAC_SHA1_Start_DMA(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size);
567 HAL_StatusTypeDef HAL_HMAC_MD5_Start_DMA(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size);
568 
569 /**
570   * @}
571   */
572 
573 /** @addtogroup HASH_Exported_Functions_Group8 Peripheral states functions
574   * @{
575   */
576 
577 
578 /* Peripheral State methods  **************************************************/
579 HAL_HASH_StateTypeDef HAL_HASH_GetState(HASH_HandleTypeDef *hhash);
580 HAL_StatusTypeDef HAL_HASH_GetStatus(HASH_HandleTypeDef *hhash);
581 void HAL_HASH_ContextSaving(HASH_HandleTypeDef *hhash, uint8_t *pMemBuffer);
582 void HAL_HASH_ContextRestoring(HASH_HandleTypeDef *hhash, uint8_t *pMemBuffer);
583 void HAL_HASH_SwFeed_ProcessSuspend(HASH_HandleTypeDef *hhash);
584 HAL_StatusTypeDef HAL_HASH_DMAFeed_ProcessSuspend(HASH_HandleTypeDef *hhash);
585 uint32_t HAL_HASH_GetError(HASH_HandleTypeDef *hhash);
586 
587 /**
588   * @}
589   */
590 
591 /**
592   * @}
593   */
594 
595 /* Private functions -----------------------------------------------------------*/
596 
597 /** @addtogroup HASH_Private_Functions HASH Private Functions
598   * @{
599   */
600 
601 /* Private functions */
602 HAL_StatusTypeDef HASH_Start(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t *pOutBuffer,
603                              uint32_t Timeout, uint32_t Algorithm);
604 HAL_StatusTypeDef HASH_Accumulate(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint32_t Algorithm);
605 HAL_StatusTypeDef HASH_Accumulate_IT(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint32_t Algorithm);
606 HAL_StatusTypeDef HASH_Start_IT(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t *pOutBuffer,
607                                 uint32_t Algorithm);
608 HAL_StatusTypeDef HASH_Start_DMA(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint32_t Algorithm);
609 HAL_StatusTypeDef HASH_Finish(HASH_HandleTypeDef *hhash, uint8_t *pOutBuffer, uint32_t Timeout);
610 HAL_StatusTypeDef HMAC_Start(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t *pOutBuffer,
611                              uint32_t Timeout, uint32_t Algorithm);
612 HAL_StatusTypeDef HMAC_Start_IT(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t *pOutBuffer,
613                                 uint32_t Algorithm);
614 HAL_StatusTypeDef HMAC_Start_DMA(HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint32_t Algorithm);
615 
616 /**
617   * @}
618   */
619 
620 /**
621   * @}
622   */
623 #endif /*  HASH*/
624 /**
625   * @}
626   */
627 
628 
629 #ifdef __cplusplus
630 }
631 #endif
632 
633 
634 #endif /* STM32F4xx_HAL_HASH_H */
635 
636 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
637