xref: /btstack/port/stm32-f4discovery-usb/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_cryp.h (revision a8f7f3fcbcd51f8d2e92aca076b6a9f812db358c)
1 /**
2   ******************************************************************************
3   * @file    stm32f4xx_hal_cryp.h
4   * @author  MCD Application Team
5   * @brief   Header file of CRYP 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_CRYP_H
22 #define __STM32F4xx_HAL_CRYP_H
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 
29 /* Includes ------------------------------------------------------------------*/
30 #include "stm32f4xx_hal_def.h"
31 
32 /** @addtogroup STM32F4xx_HAL_Driver
33   * @{
34   */
35 #if defined (AES)  || defined (CRYP)
36 /** @addtogroup CRYP
37   * @{
38   */
39 
40 /* Exported types ------------------------------------------------------------*/
41 
42 /** @defgroup CRYP_Exported_Types CRYP Exported Types
43   * @{
44   */
45 
46 /**
47   * @brief CRYP Init Structure definition
48   */
49 
50 typedef struct
51 {
52   uint32_t DataType;                   /*!< 32-bit data, 16-bit data, 8-bit data or 1-bit string.
53                                         This parameter can be a value of @ref CRYP_Data_Type */
54   uint32_t KeySize;                    /*!< Used only in AES mode : 128, 192 or 256 bit key length in CRYP1.
55                                         128 or 256 bit key length in TinyAES This parameter can be a value of @ref CRYP_Key_Size */
56   uint32_t *pKey;                      /*!< The key used for encryption/decryption */
57   uint32_t *pInitVect;                 /*!< The initialization vector used also as initialization
58                                          counter in CTR mode */
59   uint32_t Algorithm;                  /*!<  DES/ TDES Algorithm ECB/CBC
60                                         AES Algorithm ECB/CBC/CTR/GCM or CCM
61                                         This parameter can be a value of @ref CRYP_Algorithm_Mode */
62   uint32_t *Header;                    /*!< used only in AES GCM and CCM Algorithm for authentication,
63                                         GCM : also known as Additional Authentication Data
64                                         CCM : named B1 composed of the associated data length and Associated Data. */
65   uint32_t HeaderSize;                /*!< The size of header buffer in word  */
66   uint32_t *B0;                       /*!< B0 is first authentication block used only  in AES CCM mode */
67   uint32_t DataWidthUnit;              /*!< Data With Unit, this parameter can be value of @ref CRYP_Data_Width_Unit*/
68   uint32_t KeyIVConfigSkip;            /*!< CRYP peripheral Key and IV configuration skip, to config Key and Initialization
69                                            Vector only once and to skip configuration for consecutive processings.
70                                            This parameter can be a value of @ref CRYP_Configuration_Skip */
71 
72 } CRYP_ConfigTypeDef;
73 
74 
75 /**
76   * @brief  CRYP State Structure definition
77   */
78 
79 typedef enum
80 {
81   HAL_CRYP_STATE_RESET             = 0x00U,  /*!< CRYP not yet initialized or disabled  */
82   HAL_CRYP_STATE_READY             = 0x01U,  /*!< CRYP initialized and ready for use    */
83   HAL_CRYP_STATE_BUSY              = 0x02U  /*!< CRYP BUSY, internal processing is ongoing  */
84 } HAL_CRYP_STATETypeDef;
85 
86 
87 /**
88   * @brief  CRYP handle Structure definition
89   */
90 
91 typedef struct __CRYP_HandleTypeDef
92 {
93 #if defined (CRYP)
94   CRYP_TypeDef                      *Instance;            /*!< CRYP registers base address */
95 #else /* AES*/
96   AES_TypeDef                       *Instance;            /*!< AES Register base address */
97 #endif /* End AES or CRYP */
98 
99   CRYP_ConfigTypeDef                Init;             /*!< CRYP required parameters */
100 
101   FunctionalState                   AutoKeyDerivation;   /*!< Used only in TinyAES to allows to bypass or not key write-up before decryption.
102                                                          This parameter can be a value of ENABLE/DISABLE */
103 
104   uint32_t                          *pCrypInBuffPtr;  /*!< Pointer to CRYP processing (encryption, decryption,...) buffer */
105 
106   uint32_t                          *pCrypOutBuffPtr; /*!< Pointer to CRYP processing (encryption, decryption,...) buffer */
107 
108   __IO uint16_t                     CrypHeaderCount;   /*!< Counter of header data */
109 
110   __IO uint16_t                     CrypInCount;      /*!< Counter of input data */
111 
112   __IO uint16_t                     CrypOutCount;     /*!< Counter of output data */
113 
114   uint16_t                          Size;           /*!< length of input data in word */
115 
116   uint32_t                          Phase;            /*!< CRYP peripheral phase */
117 
118   DMA_HandleTypeDef                 *hdmain;          /*!< CRYP In DMA handle parameters */
119 
120   DMA_HandleTypeDef                 *hdmaout;         /*!< CRYP Out DMA handle parameters */
121 
122   HAL_LockTypeDef                   Lock;             /*!< CRYP locking object */
123 
124   __IO  HAL_CRYP_STATETypeDef       State;            /*!< CRYP peripheral state */
125 
126   __IO uint32_t                     ErrorCode;        /*!< CRYP peripheral error code */
127 
128   uint32_t                          KeyIVConfig;      /*!< CRYP peripheral Key and IV configuration flag, used when
129                                                            configuration can be skipped */
130 
131   uint32_t                          SizesSum;         /*!< Sum of successive payloads lengths (in bytes), stored
132                                                            for a single signature computation after several
133                                                            messages processing */
134 
135 #if (USE_HAL_CRYP_REGISTER_CALLBACKS == 1)
136   void (*InCpltCallback)(struct __CRYP_HandleTypeDef *hcryp);      /*!< CRYP Input FIFO transfer completed callback  */
137   void (*OutCpltCallback)(struct __CRYP_HandleTypeDef *hcryp);     /*!< CRYP Output FIFO transfer completed callback */
138   void (*ErrorCallback)(struct __CRYP_HandleTypeDef *hcryp);       /*!< CRYP Error callback */
139 
140   void (* MspInitCallback)(struct __CRYP_HandleTypeDef *hcryp);    /*!< CRYP Msp Init callback  */
141   void (* MspDeInitCallback)(struct __CRYP_HandleTypeDef *hcryp);  /*!< CRYP Msp DeInit callback  */
142 
143 #endif /* (USE_HAL_CRYP_REGISTER_CALLBACKS) */
144 } CRYP_HandleTypeDef;
145 
146 
147 /**
148   * @}
149   */
150 
151 #if (USE_HAL_CRYP_REGISTER_CALLBACKS == 1)
152 /** @defgroup HAL_CRYP_Callback_ID_enumeration_definition HAL CRYP Callback ID enumeration definition
153   * @brief  HAL CRYP Callback ID enumeration definition
154   * @{
155   */
156 typedef enum
157 {
158   HAL_CRYP_INPUT_COMPLETE_CB_ID    = 0x01U,    /*!< CRYP Input FIFO transfer completed callback ID */
159   HAL_CRYP_OUTPUT_COMPLETE_CB_ID   = 0x02U,    /*!< CRYP Output FIFO transfer completed callback ID */
160   HAL_CRYP_ERROR_CB_ID             = 0x03U,    /*!< CRYP Error callback ID           */
161 
162   HAL_CRYP_MSPINIT_CB_ID        = 0x04U,    /*!< CRYP MspInit callback ID         */
163   HAL_CRYP_MSPDEINIT_CB_ID      = 0x05U     /*!< CRYP MspDeInit callback ID       */
164 
165 } HAL_CRYP_CallbackIDTypeDef;
166 /**
167   * @}
168   */
169 
170 /** @defgroup HAL_CRYP_Callback_pointer_definition HAL CRYP Callback pointer definition
171   * @brief  HAL CRYP Callback pointer definition
172   * @{
173   */
174 
175 typedef  void (*pCRYP_CallbackTypeDef)(CRYP_HandleTypeDef *hcryp);    /*!< pointer to a common CRYP callback function */
176 
177 /**
178   * @}
179   */
180 
181 #endif /* USE_HAL_CRYP_REGISTER_CALLBACKS */
182 
183 /* Exported constants --------------------------------------------------------*/
184 /** @defgroup CRYP_Exported_Constants CRYP Exported Constants
185   * @{
186   */
187 
188 /** @defgroup CRYP_Error_Definition   CRYP Error Definition
189   * @{
190   */
191 #define HAL_CRYP_ERROR_NONE              0x00000000U  /*!< No error        */
192 #define HAL_CRYP_ERROR_WRITE             0x00000001U  /*!< Write error     */
193 #define HAL_CRYP_ERROR_READ              0x00000002U  /*!< Read error      */
194 #define HAL_CRYP_ERROR_DMA               0x00000004U  /*!< DMA error       */
195 #define HAL_CRYP_ERROR_BUSY              0x00000008U  /*!< Busy flag error */
196 #define HAL_CRYP_ERROR_TIMEOUT           0x00000010U  /*!< Timeout error */
197 #define HAL_CRYP_ERROR_NOT_SUPPORTED     0x00000020U  /*!< Not supported mode */
198 #define HAL_CRYP_ERROR_AUTH_TAG_SEQUENCE 0x00000040U  /*!< Sequence are not respected only for GCM or CCM */
199 #if (USE_HAL_CRYP_REGISTER_CALLBACKS == 1)
200 #define  HAL_CRYP_ERROR_INVALID_CALLBACK ((uint32_t)0x00000080U)    /*!< Invalid Callback error  */
201 #endif /* USE_HAL_CRYP_REGISTER_CALLBACKS */
202 /**
203   * @}
204   */
205 
206 /** @defgroup CRYP_Data_Width_Unit CRYP Data Width Unit
207   * @{
208   */
209 
210 #define CRYP_DATAWIDTHUNIT_WORD   0x00000000U  /*!< By default, size unit is word */
211 #define CRYP_DATAWIDTHUNIT_BYTE   0x00000001U  /*!< By default, size unit is word */
212 
213 /**
214   * @}
215   */
216 
217 /** @defgroup CRYP_Algorithm_Mode CRYP Algorithm Mode
218   * @{
219   */
220 #if defined(CRYP)
221 
222 #define CRYP_DES_ECB     CRYP_CR_ALGOMODE_DES_ECB
223 #define CRYP_DES_CBC     CRYP_CR_ALGOMODE_DES_CBC
224 #define CRYP_TDES_ECB    CRYP_CR_ALGOMODE_TDES_ECB
225 #define CRYP_TDES_CBC    CRYP_CR_ALGOMODE_TDES_CBC
226 #define CRYP_AES_ECB     CRYP_CR_ALGOMODE_AES_ECB
227 #define CRYP_AES_CBC     CRYP_CR_ALGOMODE_AES_CBC
228 #define CRYP_AES_CTR     CRYP_CR_ALGOMODE_AES_CTR
229 #if defined (CRYP_CR_ALGOMODE_AES_GCM)
230 #define CRYP_AES_GCM     CRYP_CR_ALGOMODE_AES_GCM
231 #define CRYP_AES_CCM     CRYP_CR_ALGOMODE_AES_CCM
232 #endif /* GCM CCM defined*/
233 #else /* AES*/
234 #define CRYP_AES_ECB            0x00000000U                       /*!< Electronic codebook chaining algorithm                   */
235 #define CRYP_AES_CBC            AES_CR_CHMOD_0                    /*!< Cipher block chaining algorithm                          */
236 #define CRYP_AES_CTR            AES_CR_CHMOD_1                    /*!< Counter mode chaining algorithm                          */
237 #define CRYP_AES_GCM_GMAC       (AES_CR_CHMOD_0 | AES_CR_CHMOD_1) /*!< Galois counter mode - Galois message authentication code */
238 #define CRYP_AES_CCM            AES_CR_CHMOD_2                    /*!< Counter with Cipher Mode                                 */
239 #endif /* End AES or CRYP */
240 
241 /**
242   * @}
243   */
244 
245 /** @defgroup CRYP_Key_Size CRYP Key Size
246   * @{
247   */
248 #if defined(CRYP)
249 #define CRYP_KEYSIZE_128B         0x00000000U
250 #define CRYP_KEYSIZE_192B         CRYP_CR_KEYSIZE_0
251 #define CRYP_KEYSIZE_256B         CRYP_CR_KEYSIZE_1
252 #else /* AES*/
253 #define CRYP_KEYSIZE_128B         0x00000000U          /*!< 128-bit long key */
254 #define CRYP_KEYSIZE_256B         AES_CR_KEYSIZE       /*!< 256-bit long key */
255 #endif /* End AES or CRYP */
256 /**
257   * @}
258   */
259 
260 /** @defgroup CRYP_Data_Type CRYP Data Type
261   * @{
262   */
263 #if defined(CRYP)
264 #define CRYP_DATATYPE_32B         0x00000000U
265 #define CRYP_DATATYPE_16B         CRYP_CR_DATATYPE_0
266 #define CRYP_DATATYPE_8B          CRYP_CR_DATATYPE_1
267 #define CRYP_DATATYPE_1B          CRYP_CR_DATATYPE
268 #else /* AES*/
269 #define CRYP_DATATYPE_32B         0x00000000U  /*!< 32-bit data type (no swapping)        */
270 #define CRYP_DATATYPE_16B         AES_CR_DATATYPE_0       /*!< 16-bit data type (half-word swapping) */
271 #define CRYP_DATATYPE_8B          AES_CR_DATATYPE_1       /*!< 8-bit data type (byte swapping)       */
272 #define CRYP_DATATYPE_1B          AES_CR_DATATYPE         /*!< 1-bit data type (bit swapping)        */
273 #endif /* End AES or CRYP */
274 
275 /**
276   * @}
277   */
278 
279 /** @defgroup CRYP_Interrupt  CRYP Interrupt
280   * @{
281   */
282 #if defined (CRYP)
283 #define CRYP_IT_INI       CRYP_IMSCR_INIM   /*!< Input FIFO Interrupt */
284 #define CRYP_IT_OUTI      CRYP_IMSCR_OUTIM  /*!< Output FIFO Interrupt */
285 #else /* AES*/
286 #define CRYP_IT_CCFIE     AES_CR_CCFIE /*!< Computation Complete interrupt enable */
287 #define CRYP_IT_ERRIE     AES_CR_ERRIE /*!< Error interrupt enable                */
288 #define CRYP_IT_WRERR     AES_SR_WRERR  /*!< Write Error           */
289 #define CRYP_IT_RDERR     AES_SR_RDERR  /*!< Read Error            */
290 #define CRYP_IT_CCF       AES_SR_CCF    /*!< Computation completed */
291 #endif /* End AES or CRYP */
292 
293 /**
294   * @}
295   */
296 
297 /** @defgroup CRYP_Flags CRYP Flags
298   * @{
299   */
300 #if defined (CRYP)
301 /* Flags in the SR register */
302 #define CRYP_FLAG_IFEM    CRYP_SR_IFEM  /*!< Input FIFO is empty */
303 #define CRYP_FLAG_IFNF    CRYP_SR_IFNF  /*!< Input FIFO is not Full */
304 #define CRYP_FLAG_OFNE    CRYP_SR_OFNE  /*!< Output FIFO is not empty */
305 #define CRYP_FLAG_OFFU    CRYP_SR_OFFU  /*!< Output FIFO is Full */
306 #define CRYP_FLAG_BUSY    CRYP_SR_BUSY  /*!< The CRYP core is currently processing a block of data
307                                              or a key preparation (for AES decryption). */
308 /* Flags in the RISR register */
309 #define CRYP_FLAG_OUTRIS  0x01000002U  /*!< Output FIFO service raw interrupt status */
310 #define CRYP_FLAG_INRIS   0x01000001U  /*!< Input FIFO service raw interrupt status*/
311 #else /* AES*/
312 /* status flags */
313 #define CRYP_FLAG_BUSY    AES_SR_BUSY   /*!< GCM process suspension forbidden */
314 #define CRYP_FLAG_WRERR   AES_SR_WRERR  /*!< Write Error                      */
315 #define CRYP_FLAG_RDERR   AES_SR_RDERR  /*!< Read error                       */
316 #define CRYP_FLAG_CCF     AES_SR_CCF    /*!< Computation completed            */
317 /* clearing flags */
318 #define CRYP_CCF_CLEAR    AES_CR_CCFC   /*!< Computation Complete Flag Clear */
319 #define CRYP_ERR_CLEAR    AES_CR_ERRC   /*!< Error Flag Clear  */
320 #endif /* End AES or CRYP  */
321 
322 /**
323   * @}
324   */
325 
326 /** @defgroup CRYP_Configuration_Skip CRYP Key and IV Configuration Skip Mode
327   * @{
328   */
329 
330 #define CRYP_KEYIVCONFIG_ALWAYS        0x00000000U            /*!< Peripheral Key and IV configuration to do systematically */
331 #define CRYP_KEYIVCONFIG_ONCE          0x00000001U            /*!< Peripheral Key and IV configuration to do only once      */
332 
333 /**
334   * @}
335   */
336 
337 
338 /**
339   * @}
340   */
341 
342 /* Exported macros -----------------------------------------------------------*/
343 /** @defgroup CRYP_Exported_Macros CRYP Exported Macros
344   * @{
345   */
346 
347 /** @brief Reset CRYP handle state
348   * @param  __HANDLE__ specifies the CRYP handle.
349   * @retval None
350   */
351 #if (USE_HAL_CRYP_REGISTER_CALLBACKS == 1)
352 #define __HAL_CRYP_RESET_HANDLE_STATE(__HANDLE__) do{\
353                                                       (__HANDLE__)->State = HAL_CRYP_STATE_RESET;\
354                                                       (__HANDLE__)->MspInitCallback = NULL;\
355                                                       (__HANDLE__)->MspDeInitCallback = NULL;\
356                                                      }while(0)
357 #else
358 #define __HAL_CRYP_RESET_HANDLE_STATE(__HANDLE__) ( (__HANDLE__)->State = HAL_CRYP_STATE_RESET)
359 #endif /* USE_HAL_CRYP_REGISTER_CALLBACKS */
360 
361 /**
362   * @brief  Enable/Disable the CRYP peripheral.
363   * @param  __HANDLE__: specifies the CRYP handle.
364   * @retval None
365   */
366 #if defined(CRYP)
367 #define __HAL_CRYP_ENABLE(__HANDLE__)  ((__HANDLE__)->Instance->CR |=  CRYP_CR_CRYPEN)
368 #define __HAL_CRYP_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &=  ~CRYP_CR_CRYPEN)
369 #else /* AES*/
370 #define __HAL_CRYP_ENABLE(__HANDLE__)  ((__HANDLE__)->Instance->CR |=  AES_CR_EN)
371 #define __HAL_CRYP_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &=  ~AES_CR_EN)
372 #endif /* End AES or CRYP  */
373 
374 /** @brief  Check whether the specified CRYP status flag is set or not.
375   * @param  __FLAG__: specifies the flag to check.
376   *         This parameter can be one of the following values for TinyAES:
377   *            @arg @ref CRYP_FLAG_BUSY GCM process suspension forbidden
378   *            @arg @ref CRYP_IT_WRERR Write Error
379   *            @arg @ref CRYP_IT_RDERR Read Error
380   *            @arg @ref CRYP_IT_CCF Computation Complete
381   *         This parameter can be one of the following values for CRYP:
382   *            @arg CRYP_FLAG_BUSY: The CRYP core is currently processing a block of data
383   *                                 or a key preparation (for AES decryption).
384   *            @arg CRYP_FLAG_IFEM: Input FIFO is empty
385   *            @arg CRYP_FLAG_IFNF: Input FIFO is not full
386   *            @arg CRYP_FLAG_INRIS: Input FIFO service raw interrupt is pending
387   *            @arg CRYP_FLAG_OFNE: Output FIFO is not empty
388   *            @arg CRYP_FLAG_OFFU: Output FIFO is full
389   *            @arg CRYP_FLAG_OUTRIS: Input FIFO service raw interrupt is pending
390   * @retval The state of __FLAG__ (TRUE or FALSE).
391   */
392 #define CRYP_FLAG_MASK  0x0000001FU
393 #if defined(CRYP)
394 #define __HAL_CRYP_GET_FLAG(__HANDLE__, __FLAG__) ((((uint8_t)((__FLAG__) >> 24)) == 0x01U)?((((__HANDLE__)->Instance->RISR) & ((__FLAG__) & CRYP_FLAG_MASK)) == ((__FLAG__) & CRYP_FLAG_MASK)): \
395                                                    ((((__HANDLE__)->Instance->RISR) & ((__FLAG__) & CRYP_FLAG_MASK)) == ((__FLAG__) & CRYP_FLAG_MASK)))
396 #else /* AES*/
397 #define __HAL_CRYP_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
398 #endif /* End AES or CRYP */
399 
400 /** @brief  Clear the CRYP pending status flag.
401   * @param  __FLAG__: specifies the flag to clear.
402   *         This parameter can be one of the following values:
403   *            @arg @ref CRYP_ERR_CLEAR Read (RDERR) or Write Error (WRERR) Flag Clear
404   *            @arg @ref CRYP_CCF_CLEAR Computation Complete Flag (CCF) Clear
405   * @param  __HANDLE__: specifies the CRYP handle.
406   * @retval None
407   */
408 
409 #if defined(AES)
410 #define __HAL_CRYP_CLEAR_FLAG(__HANDLE__, __FLAG__) SET_BIT((__HANDLE__)->Instance->CR, (__FLAG__))
411 
412 
413 /** @brief  Check whether the specified CRYP interrupt source is enabled or not.
414   * @param __INTERRUPT__: CRYP interrupt source to check
415   *         This parameter can be one of the following values for TinyAES:
416   *            @arg @ref CRYP_IT_ERRIE Error interrupt (used for RDERR and WRERR)
417   *            @arg @ref CRYP_IT_CCFIE Computation Complete interrupt
418   * @param  __HANDLE__: specifies the CRYP handle.
419   * @retval State of interruption (TRUE or FALSE).
420   */
421 
422 #define __HAL_CRYP_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR\
423                                                               & (__INTERRUPT__)) == (__INTERRUPT__))
424 
425 #endif /* AES */
426 
427 /** @brief  Check whether the specified CRYP interrupt is set or not.
428   * @param  __INTERRUPT__: specifies the interrupt to check.
429   *         This parameter can be one of the following values for TinyAES:
430   *            @arg @ref CRYP_IT_WRERR Write Error
431   *            @arg @ref CRYP_IT_RDERR Read Error
432   *            @arg @ref CRYP_IT_CCF  Computation Complete
433   *         This parameter can be one of the following values for CRYP:
434   *            @arg CRYP_IT_INI: Input FIFO service masked interrupt status
435   *            @arg CRYP_IT_OUTI: Output FIFO service masked interrupt status
436   * @param  __HANDLE__: specifies the CRYP handle.
437   * @retval The state of __INTERRUPT__ (TRUE or FALSE).
438   */
439 #if defined(CRYP)
440 #define __HAL_CRYP_GET_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->MISR\
441                                                        & (__INTERRUPT__)) == (__INTERRUPT__))
442 #else /* AES*/
443 #define __HAL_CRYP_GET_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->SR & (__INTERRUPT__)) == (__INTERRUPT__))
444 #endif /* End AES or CRYP */
445 
446 /**
447   * @brief  Enable the CRYP interrupt.
448   * @param  __INTERRUPT__: CRYP Interrupt.
449   *         This parameter can be one of the following values for TinyAES:
450   *            @arg @ref CRYP_IT_ERRIE Error interrupt (used for RDERR and WRERR)
451   *            @arg @ref CRYP_IT_CCFIE Computation Complete interrupt
452   *         This parameter can be one of the following values for CRYP:
453   *            @ CRYP_IT_INI : Input FIFO service interrupt mask.
454   *            @ CRYP_IT_OUTI : Output FIFO service interrupt mask.CRYP interrupt.
455   * @param  __HANDLE__: specifies the CRYP handle.
456   * @retval None
457   */
458 #if defined(CRYP)
459 #define __HAL_CRYP_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->IMSCR) |= (__INTERRUPT__))
460 #else /* AES*/
461 #define __HAL_CRYP_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) |= (__INTERRUPT__))
462 #endif /* End AES or CRYP */
463 
464 /**
465   * @brief  Disable the CRYP interrupt.
466   * @param  __INTERRUPT__: CRYP Interrupt.
467   *         This parameter can be one of the following values for TinyAES:
468   *            @arg @ref CRYP_IT_ERRIE Error interrupt (used for RDERR and WRERR)
469   *            @arg @ref CRYP_IT_CCFIE Computation Complete interrupt
470   *         This parameter can be one of the following values for CRYP:
471   *            @ CRYP_IT_INI : Input FIFO service interrupt mask.
472   *            @ CRYP_IT_OUTI : Output FIFO service interrupt mask.CRYP interrupt.
473   * @param  __HANDLE__: specifies the CRYP handle.
474   * @retval None
475   */
476 #if defined(CRYP)
477 #define __HAL_CRYP_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->IMSCR) &= ~(__INTERRUPT__))
478 #else /* AES*/
479 #define __HAL_CRYP_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) &= ~(__INTERRUPT__))
480 #endif /* End AES or CRYP */
481 
482 /**
483   * @}
484   */
485 #if defined (CRYP_CR_ALGOMODE_AES_GCM)|| defined (AES)
486 /* Include CRYP HAL Extended module */
487 #include "stm32f4xx_hal_cryp_ex.h"
488 #endif /* AES or GCM CCM defined*/
489 /* Exported functions --------------------------------------------------------*/
490 /** @defgroup CRYP_Exported_Functions CRYP Exported Functions
491   * @{
492   */
493 
494 /** @addtogroup CRYP_Exported_Functions_Group1
495   * @{
496   */
497 HAL_StatusTypeDef HAL_CRYP_Init(CRYP_HandleTypeDef *hcryp);
498 HAL_StatusTypeDef HAL_CRYP_DeInit(CRYP_HandleTypeDef *hcryp);
499 void HAL_CRYP_MspInit(CRYP_HandleTypeDef *hcryp);
500 void HAL_CRYP_MspDeInit(CRYP_HandleTypeDef *hcryp);
501 HAL_StatusTypeDef HAL_CRYP_SetConfig(CRYP_HandleTypeDef *hcryp, CRYP_ConfigTypeDef *pConf);
502 HAL_StatusTypeDef HAL_CRYP_GetConfig(CRYP_HandleTypeDef *hcryp, CRYP_ConfigTypeDef *pConf);
503 #if (USE_HAL_CRYP_REGISTER_CALLBACKS == 1)
504 HAL_StatusTypeDef HAL_CRYP_RegisterCallback(CRYP_HandleTypeDef *hcryp, HAL_CRYP_CallbackIDTypeDef CallbackID,
505                                             pCRYP_CallbackTypeDef pCallback);
506 HAL_StatusTypeDef HAL_CRYP_UnRegisterCallback(CRYP_HandleTypeDef *hcryp, HAL_CRYP_CallbackIDTypeDef CallbackID);
507 #endif /* USE_HAL_CRYP_REGISTER_CALLBACKS */
508 /**
509   * @}
510   */
511 
512 /** @addtogroup CRYP_Exported_Functions_Group2
513   * @{
514   */
515 
516 /* encryption/decryption ***********************************/
517 HAL_StatusTypeDef HAL_CRYP_Encrypt(CRYP_HandleTypeDef *hcryp, uint32_t *Input, uint16_t Size, uint32_t *Output,
518                                    uint32_t Timeout);
519 HAL_StatusTypeDef HAL_CRYP_Decrypt(CRYP_HandleTypeDef *hcryp, uint32_t *Input, uint16_t Size, uint32_t *Output,
520                                    uint32_t Timeout);
521 HAL_StatusTypeDef HAL_CRYP_Encrypt_IT(CRYP_HandleTypeDef *hcryp, uint32_t *Input, uint16_t Size, uint32_t *Output);
522 HAL_StatusTypeDef HAL_CRYP_Decrypt_IT(CRYP_HandleTypeDef *hcryp, uint32_t *Input, uint16_t Size, uint32_t *Output);
523 HAL_StatusTypeDef HAL_CRYP_Encrypt_DMA(CRYP_HandleTypeDef *hcryp, uint32_t *Input, uint16_t Size, uint32_t *Output);
524 HAL_StatusTypeDef HAL_CRYP_Decrypt_DMA(CRYP_HandleTypeDef *hcryp, uint32_t *Input, uint16_t Size, uint32_t *Output);
525 
526 /**
527   * @}
528   */
529 
530 
531 /** @addtogroup CRYP_Exported_Functions_Group3
532   * @{
533   */
534 /* Interrupt Handler functions  **********************************************/
535 void HAL_CRYP_IRQHandler(CRYP_HandleTypeDef *hcryp);
536 HAL_CRYP_STATETypeDef HAL_CRYP_GetState(CRYP_HandleTypeDef *hcryp);
537 void HAL_CRYP_InCpltCallback(CRYP_HandleTypeDef *hcryp);
538 void HAL_CRYP_OutCpltCallback(CRYP_HandleTypeDef *hcryp);
539 void HAL_CRYP_ErrorCallback(CRYP_HandleTypeDef *hcryp);
540 uint32_t HAL_CRYP_GetError(CRYP_HandleTypeDef *hcryp);
541 
542 /**
543   * @}
544   */
545 
546 /**
547   * @}
548   */
549 
550 /* Private macros --------------------------------------------------------*/
551 /** @defgroup CRYP_Private_Macros   CRYP Private Macros
552   * @{
553   */
554 
555 /** @defgroup CRYP_IS_CRYP_Definitions CRYP Private macros to check input parameters
556   * @{
557   */
558 #if defined(CRYP)
559 #if defined (CRYP_CR_ALGOMODE_AES_GCM)
560 #define IS_CRYP_ALGORITHM(ALGORITHM) (((ALGORITHM) == CRYP_DES_ECB)   || \
561                                       ((ALGORITHM)  == CRYP_DES_CBC)   || \
562                                       ((ALGORITHM)  == CRYP_TDES_ECB)  || \
563                                       ((ALGORITHM)  == CRYP_TDES_CBC)  || \
564                                       ((ALGORITHM)  == CRYP_AES_ECB)   || \
565                                       ((ALGORITHM)  == CRYP_AES_CBC)   || \
566                                       ((ALGORITHM)  == CRYP_AES_CTR)   || \
567                                       ((ALGORITHM)  == CRYP_AES_GCM)   || \
568                                       ((ALGORITHM)  == CRYP_AES_CCM))
569 #else /*NO GCM CCM */
570 #define IS_CRYP_ALGORITHM(ALGORITHM) (((ALGORITHM) == CRYP_DES_ECB)   || \
571                                       ((ALGORITHM)  == CRYP_DES_CBC)   || \
572                                       ((ALGORITHM)  == CRYP_TDES_ECB)  || \
573                                       ((ALGORITHM)  == CRYP_TDES_CBC)  || \
574                                       ((ALGORITHM)  == CRYP_AES_ECB)   || \
575                                       ((ALGORITHM)  == CRYP_AES_CBC)   || \
576                                       ((ALGORITHM)  == CRYP_AES_CTR))
577 #endif /* GCM CCM defined*/
578 #define IS_CRYP_KEYSIZE(KEYSIZE)(((KEYSIZE) == CRYP_KEYSIZE_128B)   || \
579                                  ((KEYSIZE) == CRYP_KEYSIZE_192B)   || \
580                                  ((KEYSIZE) == CRYP_KEYSIZE_256B))
581 #else /* AES*/
582 #define IS_CRYP_ALGORITHM(ALGORITHM) (((ALGORITHM) == CRYP_AES_ECB)   || \
583                                       ((ALGORITHM)  == CRYP_AES_CBC)   || \
584                                       ((ALGORITHM)  == CRYP_AES_CTR)  || \
585                                       ((ALGORITHM)  == CRYP_AES_GCM_GMAC)|| \
586                                       ((ALGORITHM)  == CRYP_AES_CCM))
587 
588 
589 #define IS_CRYP_KEYSIZE(KEYSIZE)(((KEYSIZE) == CRYP_KEYSIZE_128B)   || \
590                                  ((KEYSIZE) == CRYP_KEYSIZE_256B))
591 #endif /* End AES or CRYP */
592 
593 #define IS_CRYP_DATATYPE(DATATYPE)(((DATATYPE) == CRYP_DATATYPE_32B)   || \
594                                    ((DATATYPE) == CRYP_DATATYPE_16B) || \
595                                    ((DATATYPE) == CRYP_DATATYPE_8B) || \
596                                    ((DATATYPE) == CRYP_DATATYPE_1B))
597 
598 #define IS_CRYP_INIT(CONFIG)(((CONFIG) == CRYP_KEYIVCONFIG_ALWAYS) || \
599                              ((CONFIG) == CRYP_KEYIVCONFIG_ONCE))
600 /**
601   * @}
602   */
603 
604 /**
605   * @}
606   */
607 
608 
609 /* Private constants ---------------------------------------------------------*/
610 /** @defgroup CRYP_Private_Constants CRYP Private Constants
611   * @{
612   */
613 
614 /**
615   * @}
616   */
617 /* Private defines -----------------------------------------------------------*/
618 /** @defgroup CRYP_Private_Defines CRYP Private Defines
619   * @{
620   */
621 
622 /**
623   * @}
624   */
625 
626 /* Private variables ---------------------------------------------------------*/
627 /** @defgroup CRYP_Private_Variables CRYP Private Variables
628   * @{
629   */
630 
631 /**
632   * @}
633   */
634 /* Private functions prototypes ----------------------------------------------*/
635 /** @defgroup CRYP_Private_Functions_Prototypes CRYP Private Functions Prototypes
636   * @{
637   */
638 
639 /**
640   * @}
641   */
642 
643 /* Private functions ---------------------------------------------------------*/
644 /** @defgroup CRYP_Private_Functions CRYP Private Functions
645   * @{
646   */
647 
648 /**
649   * @}
650   */
651 
652 
653 /**
654   * @}
655   */
656 
657 
658 /**
659   * @}
660   */
661 #endif /* TinyAES or CRYP*/
662 
663 /**
664   * @}
665   */
666 
667 #ifdef __cplusplus
668 }
669 #endif
670 
671 #endif /* __STM32F4xx_HAL_CRYP_H */
672 
673 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
674