stm32f4xx_hal_hash.h 25 KB

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