1 /** 2 ****************************************************************************** 3 * @file stm32l4xx_hal_cryp.h 4 * @author MCD Application Team 5 * @brief Header file of CRYP HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * <h2><center>© COPYRIGHT(c) 2017 STMicroelectronics</center></h2> 10 * 11 * Redistribution and use in source and binary forms, with or without modification, 12 * are permitted provided that the following conditions are met: 13 * 1. Redistributions of source code must retain the above copyright notice, 14 * this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright notice, 16 * this list of conditions and the following disclaimer in the documentation 17 * and/or other materials provided with the distribution. 18 * 3. Neither the name of STMicroelectronics nor the names of its contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 25 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 * 33 ****************************************************************************** 34 */ 35 36 /* Define to prevent recursive inclusion -------------------------------------*/ 37 #ifndef __STM32L4xx_HAL_CRYP_H 38 #define __STM32L4xx_HAL_CRYP_H 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /* Includes ------------------------------------------------------------------*/ 45 #include "stm32l4xx_hal_def.h" 46 47 /** @addtogroup STM32L4xx_HAL_Driver 48 * @{ 49 */ 50 51 #if defined(AES) 52 53 /** @addtogroup CRYP 54 * @{ 55 */ 56 57 /* Exported types ------------------------------------------------------------*/ 58 /** @defgroup CRYP_Exported_Types CRYP Exported Types 59 * @{ 60 */ 61 62 /** 63 * @brief CRYP Configuration Structure definition 64 */ 65 typedef struct 66 { 67 uint32_t DataType; /*!< 32-bit data, 16-bit data, 8-bit data or 1-bit string. 68 This parameter can be a value of @ref CRYP_Data_Type */ 69 70 uint32_t KeySize; /*!< 128 or 256-bit key length. 71 This parameter can be a value of @ref CRYP_Key_Size */ 72 73 uint32_t OperatingMode; /*!< AES operating mode. 74 This parameter can be a value of @ref CRYP_AES_OperatingMode */ 75 76 uint32_t ChainingMode; /*!< AES chaining mode. 77 This parameter can be a value of @ref CRYP_AES_ChainingMode */ 78 79 uint32_t KeyWriteFlag; /*!< Allows to bypass or not key write-up before decryption. 80 This parameter can be a value of @ref CRYP_Key_Write */ 81 82 uint32_t GCMCMACPhase; /*!< Indicates the processing phase of the Galois Counter Mode (GCM), 83 Galois Message Authentication Code (GMAC), Cipher Message 84 Authentication Code (CMAC) (when applicable) or Counter with Cipher 85 Mode (CCM) (when applicable). 86 This parameter can be a value of @ref CRYP_GCM_CMAC_Phase */ 87 88 uint8_t* pKey; /*!< Encryption/Decryption Key */ 89 90 uint8_t* pInitVect; /*!< Initialization Vector used for CTR, CBC, GCM/GMAC, CMAC (when applicable) 91 and CCM (when applicable) modes */ 92 93 uint8_t* Header; /*!< Header used in GCM/GMAC, CMAC (when applicable) and CCM (when applicable) modes */ 94 95 uint64_t HeaderSize; /*!< Header size in bytes */ 96 97 }CRYP_InitTypeDef; 98 99 /** 100 * @brief HAL CRYP State structures definition 101 */ 102 typedef enum 103 { 104 HAL_CRYP_STATE_RESET = 0x00, /*!< CRYP not yet initialized or disabled */ 105 HAL_CRYP_STATE_READY = 0x01, /*!< CRYP initialized and ready for use */ 106 HAL_CRYP_STATE_BUSY = 0x02, /*!< CRYP internal processing is ongoing */ 107 HAL_CRYP_STATE_TIMEOUT = 0x03, /*!< CRYP timeout state */ 108 HAL_CRYP_STATE_ERROR = 0x04, /*!< CRYP error state */ 109 HAL_CRYP_STATE_SUSPENDED = 0x05 /*!< CRYP suspended */ 110 }HAL_CRYP_STATETypeDef; 111 112 /** 113 * @brief HAL CRYP phase structures definition 114 */ 115 typedef enum 116 { 117 HAL_CRYP_PHASE_READY = 0x01, /*!< CRYP peripheral is ready for initialization. */ 118 HAL_CRYP_PHASE_PROCESS = 0x02, /*!< CRYP peripheral is in processing phase */ 119 HAL_CRYP_PHASE_START = 0x03, /*!< CRYP peripheral has been initialized but 120 GCM/GMAC(/CMAC)(/CCM) initialization phase has not started */ 121 HAL_CRYP_PHASE_INIT_OVER = 0x04, /*!< GCM/GMAC(/CMAC)(/CCM) init phase has been carried out */ 122 HAL_CRYP_PHASE_HEADER_OVER = 0x05, /*!< GCM/GMAC(/CMAC)(/CCM) header phase has been carried out */ 123 HAL_CRYP_PHASE_PAYLOAD_OVER = 0x06, /*!< GCM(/CCM) payload phase has been carried out */ 124 HAL_CRYP_PHASE_FINAL_OVER = 0x07, /*!< GCM/GMAC(/CMAC)(/CCM) final phase has been carried out */ 125 HAL_CRYP_PHASE_HEADER_SUSPENDED = 0x08, /*!< GCM/GMAC(/CMAC)(/CCM) header phase has been suspended */ 126 HAL_CRYP_PHASE_PAYLOAD_SUSPENDED = 0x09, /*!< GCM(/CCM) payload phase has been suspended */ 127 HAL_CRYP_PHASE_NOT_USED = 0x0a /*!< Phase is irrelevant to the current chaining mode */ 128 }HAL_PhaseTypeDef; 129 130 /** 131 * @brief HAL CRYP mode suspend definitions 132 */ 133 typedef enum 134 { 135 HAL_CRYP_SUSPEND_NONE = 0x00, /*!< CRYP peripheral suspension not requested */ 136 HAL_CRYP_SUSPEND = 0x01 /*!< CRYP peripheral suspension requested */ 137 }HAL_SuspendTypeDef; 138 139 140 /** 141 * @brief HAL CRYP Error Codes definition 142 */ 143 #define HAL_CRYP_ERROR_NONE ((uint32_t)0x00000000) /*!< No error */ 144 #define HAL_CRYP_WRITE_ERROR ((uint32_t)0x00000001) /*!< Write error */ 145 #define HAL_CRYP_READ_ERROR ((uint32_t)0x00000002) /*!< Read error */ 146 #define HAL_CRYP_DMA_ERROR ((uint32_t)0x00000004) /*!< DMA error */ 147 #define HAL_CRYP_BUSY_ERROR ((uint32_t)0x00000008) /*!< Busy flag error */ 148 #if (USE_HAL_CRYP_REGISTER_CALLBACKS == 1) 149 #define HAL_CRYP_ERROR_INVALID_CALLBACK ((uint32_t)0x00000010U) /*!< Invalid Callback error */ 150 #endif /* USE_HAL_CRYP_REGISTER_CALLBACKS */ 151 152 #if (USE_HAL_CRYP_REGISTER_CALLBACKS == 1) 153 /** 154 * @brief HAL CRYP common Callback ID enumeration definition 155 */ 156 typedef enum 157 { 158 HAL_CRYP_INPUTCPLT_CB_ID = 0x01U, /*!< CRYP input DMA transfer completion callback ID */ 159 HAL_CRYP_OUTPUTCPLT_CB_ID = 0x02U, /*!< CRYP output DMA transfer completion callback ID */ 160 HAL_CRYP_COMPCPLT_CB_ID = 0x03U, /*!< CRYP computation completion callback ID */ 161 HAL_CRYP_ERROR_CB_ID = 0x04U, /*!< CRYP error callback ID */ 162 HAL_CRYP_MSPINIT_CB_ID = 0x05U, /*!< CRYP MspInit callback ID */ 163 HAL_CRYP_MSPDEINIT_CB_ID = 0x06U, /*!< CRYP MspDeInit callback ID */ 164 }HAL_CRYP_CallbackIDTypeDef; 165 #endif /* USE_HAL_CRYP_REGISTER_CALLBACKS */ 166 167 /** 168 * @brief CRYP handle Structure definition 169 */ 170 typedef struct __CRYP_HandleTypeDef 171 { 172 AES_TypeDef *Instance; /*!< Register base address */ 173 174 CRYP_InitTypeDef Init; /*!< CRYP initialization parameters */ 175 176 uint8_t *pCrypInBuffPtr; /*!< Pointer to CRYP processing (encryption, decryption,...) input buffer */ 177 178 uint8_t *pCrypOutBuffPtr; /*!< Pointer to CRYP processing (encryption, decryption,...) output buffer */ 179 180 uint32_t CrypInCount; /*!< Input data size in bytes or, after suspension, the remaining 181 number of bytes to process */ 182 183 uint32_t CrypOutCount; /*!< Output data size in bytes */ 184 185 HAL_PhaseTypeDef Phase; /*!< CRYP peripheral processing phase for GCM, GMAC, CMAC (when applicable) 186 or CCM (when applicable) modes. 187 Indicates the last phase carried out to ease 188 phase transitions */ 189 190 DMA_HandleTypeDef *hdmain; /*!< CRYP peripheral Input DMA handle parameters */ 191 192 DMA_HandleTypeDef *hdmaout; /*!< CRYP peripheral Output DMA handle parameters */ 193 194 HAL_LockTypeDef Lock; /*!< CRYP locking object */ 195 196 __IO HAL_CRYP_STATETypeDef State; /*!< CRYP peripheral state */ 197 198 __IO uint32_t ErrorCode; /*!< CRYP peripheral error code */ 199 200 HAL_SuspendTypeDef SuspendRequest; /*!< CRYP peripheral suspension request flag */ 201 202 #if (USE_HAL_CRYP_REGISTER_CALLBACKS == 1) 203 void (* InCpltCallback)( struct __CRYP_HandleTypeDef * hcryp); /*!< CRYP input DMA transfer completion callback */ 204 205 void (* OutCpltCallback)( struct __CRYP_HandleTypeDef * hcryp); /*!< CRYP output DMA transfer completion callback */ 206 207 void (* CompCpltCallback)( struct __CRYP_HandleTypeDef * hcryp); /*!< CRYP computation completion callback */ 208 209 void (* ErrorCallback)( struct __CRYP_HandleTypeDef * hcryp); /*!< CRYP error callback */ 210 211 void (* MspInitCallback)( struct __CRYP_HandleTypeDef * hcryp); /*!< CRYP Msp Init callback */ 212 213 void (* MspDeInitCallback)( struct __CRYP_HandleTypeDef * hcryp); /*!< CRYP Msp DeInit callback */ 214 215 #endif /* (USE_HAL_CRYP_REGISTER_CALLBACKS) */ 216 }CRYP_HandleTypeDef; 217 218 219 #if (USE_HAL_CRYP_REGISTER_CALLBACKS == 1) 220 /** 221 * @brief HAL CRYP Callback pointer definition 222 */ 223 typedef void (*pCRYP_CallbackTypeDef)(CRYP_HandleTypeDef * hcryp); /*!< pointer to a CRYP common callback functions */ 224 #endif /* USE_HAL_CRYP_REGISTER_CALLBACKS */ 225 /** 226 * @} 227 */ 228 229 230 /* Exported constants --------------------------------------------------------*/ 231 /** @defgroup CRYP_Exported_Constants CRYP Exported Constants 232 * @{ 233 */ 234 235 /** @defgroup CRYP_Key_Size Key size selection 236 * @{ 237 */ 238 #define CRYP_KEYSIZE_128B ((uint32_t)0x00000000) /*!< 128-bit long key */ 239 #define CRYP_KEYSIZE_256B AES_CR_KEYSIZE /*!< 256-bit long key */ 240 /** 241 * @} 242 */ 243 244 /** @defgroup CRYP_Data_Type AES Data Type selection 245 * @{ 246 */ 247 #define CRYP_DATATYPE_32B ((uint32_t)0x00000000) /*!< 32-bit data type (no swapping) */ 248 #define CRYP_DATATYPE_16B AES_CR_DATATYPE_0 /*!< 16-bit data type (half-word swapping) */ 249 #define CRYP_DATATYPE_8B AES_CR_DATATYPE_1 /*!< 8-bit data type (byte swapping) */ 250 #define CRYP_DATATYPE_1B AES_CR_DATATYPE /*!< 1-bit data type (bit swapping) */ 251 /** 252 * @} 253 */ 254 255 /** @defgroup CRYP_AES_State AES Enable state 256 * @{ 257 */ 258 #define CRYP_AES_DISABLE ((uint32_t)0x00000000) /*!< Disable AES */ 259 #define CRYP_AES_ENABLE AES_CR_EN /*!< Enable AES */ 260 /** 261 * @} 262 */ 263 264 /** @defgroup CRYP_AES_OperatingMode AES operating mode 265 * @{ 266 */ 267 #define CRYP_ALGOMODE_ENCRYPT ((uint32_t)0x00000000) /*!< Encryption mode */ 268 #define CRYP_ALGOMODE_KEYDERIVATION AES_CR_MODE_0 /*!< Key derivation mode */ 269 #define CRYP_ALGOMODE_DECRYPT AES_CR_MODE_1 /*!< Decryption */ 270 #define CRYP_ALGOMODE_KEYDERIVATION_DECRYPT AES_CR_MODE /*!< Key derivation and decryption */ 271 #define CRYP_ALGOMODE_TAG_GENERATION ((uint32_t)0x00000000) /*!< GMAC or CMAC (when applicable) authentication tag generation */ 272 /** 273 * @} 274 */ 275 276 /** @defgroup CRYP_AES_ChainingMode AES chaining mode 277 * @{ 278 */ 279 #define CRYP_CHAINMODE_AES_ECB ((uint32_t)0x00000000) /*!< Electronic codebook chaining algorithm */ 280 #define CRYP_CHAINMODE_AES_CBC AES_CR_CHMOD_0 /*!< Cipher block chaining algorithm */ 281 #define CRYP_CHAINMODE_AES_CTR AES_CR_CHMOD_1 /*!< Counter mode chaining algorithm */ 282 #define CRYP_CHAINMODE_AES_GCM_GMAC (AES_CR_CHMOD_0 | AES_CR_CHMOD_1) /*!< Galois counter mode - Galois message authentication code */ 283 #if defined(AES_CR_NPBLB) 284 #define CRYP_CHAINMODE_AES_CCM AES_CR_CHMOD_2 /*!< Counter with Cipher Mode */ 285 #else 286 #define CRYP_CHAINMODE_AES_CMAC AES_CR_CHMOD_2 /*!< Cipher message authentication code */ 287 #endif 288 /** 289 * @} 290 */ 291 292 /** @defgroup CRYP_Key_Write AES decryption key write-up flag 293 * @{ 294 */ 295 #define CRYP_KEY_WRITE_ENABLE ((uint32_t)0x00000000) /*!< Enable decryption key writing */ 296 #define CRYP_KEY_WRITE_DISABLE ((uint32_t)0x00000001) /*!< Disable decryption key writing */ 297 /** 298 * @} 299 */ 300 301 /** @defgroup CRYP_DMAIN DMA Input phase management enable state 302 * @{ 303 */ 304 #define CRYP_DMAIN_DISABLE ((uint32_t)0x00000000) /*!< Disable DMA Input phase management */ 305 #define CRYP_DMAIN_ENABLE AES_CR_DMAINEN /*!< Enable DMA Input phase management */ 306 /** 307 * @} 308 */ 309 310 /** @defgroup CRYP_DMAOUT DMA Output phase management enable state 311 * @{ 312 */ 313 #define CRYP_DMAOUT_DISABLE ((uint32_t)0x00000000) /*!< Disable DMA Output phase management */ 314 #define CRYP_DMAOUT_ENABLE AES_CR_DMAOUTEN /*!< Enable DMA Output phase management */ 315 /** 316 * @} 317 */ 318 319 320 /** @defgroup CRYP_GCM_CMAC_Phase GCM/GMAC and CCM/CMAC (when applicable) processing phase selection 321 * @{ 322 */ 323 #define CRYP_GCM_INIT_PHASE ((uint32_t)0x00000000) /*!< GCM/GMAC (or CCM) init phase */ 324 #define CRYP_GCMCMAC_HEADER_PHASE AES_CR_GCMPH_0 /*!< GCM/GMAC/CCM/CMAC header phase */ 325 #define CRYP_GCM_PAYLOAD_PHASE AES_CR_GCMPH_1 /*!< GCM/CCM payload phase */ 326 #define CRYP_GCMCMAC_FINAL_PHASE AES_CR_GCMPH /*!< GCM/GMAC/CCM/CMAC final phase */ 327 /* Definitions duplication for code readibility's sake: 328 supported or not supported chain modes are not specified for each phase */ 329 #define CRYP_INIT_PHASE ((uint32_t)0x00000000) /*!< Init phase */ 330 #define CRYP_HEADER_PHASE AES_CR_GCMPH_0 /*!< Header phase */ 331 #define CRYP_PAYLOAD_PHASE AES_CR_GCMPH_1 /*!< Payload phase */ 332 #define CRYP_FINAL_PHASE AES_CR_GCMPH /*!< Final phase */ 333 /** 334 * @} 335 */ 336 337 /** @defgroup CRYP_Flags AES status flags 338 * @{ 339 */ 340 341 #define CRYP_FLAG_BUSY AES_SR_BUSY /*!< GCM process suspension forbidden */ 342 #define CRYP_FLAG_WRERR AES_SR_WRERR /*!< Write Error */ 343 #define CRYP_FLAG_RDERR AES_SR_RDERR /*!< Read error */ 344 #define CRYP_FLAG_CCF AES_SR_CCF /*!< Computation completed */ 345 /** 346 * @} 347 */ 348 349 /** @defgroup CRYP_Clear_Flags AES clearing flags 350 * @{ 351 */ 352 353 #define CRYP_CCF_CLEAR AES_CR_CCFC /*!< Computation Complete Flag Clear */ 354 #define CRYP_ERR_CLEAR AES_CR_ERRC /*!< Error Flag Clear */ 355 /** 356 * @} 357 */ 358 359 /** @defgroup AES_Interrupts_Enable AES Interrupts Enable bits 360 * @{ 361 */ 362 #define CRYP_IT_CCFIE AES_CR_CCFIE /*!< Computation Complete interrupt enable */ 363 #define CRYP_IT_ERRIE AES_CR_ERRIE /*!< Error interrupt enable */ 364 /** 365 * @} 366 */ 367 368 /** @defgroup CRYP_Interrupts_Flags AES Interrupts flags 369 * @{ 370 */ 371 #define CRYP_IT_WRERR AES_SR_WRERR /*!< Write Error */ 372 #define CRYP_IT_RDERR AES_SR_RDERR /*!< Read Error */ 373 #define CRYP_IT_CCF AES_SR_CCF /*!< Computation completed */ 374 /** 375 * @} 376 */ 377 378 /** 379 * @} 380 */ 381 382 /* Exported macros -----------------------------------------------------------*/ 383 /** @defgroup CRYP_Exported_Macros CRYP Exported Macros 384 * @{ 385 */ 386 387 /** @brief Reset CRYP handle state. 388 * @param __HANDLE__: specifies the CRYP handle. 389 * @retval None 390 */ 391 #if (USE_HAL_CRYP_REGISTER_CALLBACKS == 1) 392 #define __HAL_CRYP_RESET_HANDLE_STATE(__HANDLE__) do{\ 393 (__HANDLE__)->State = HAL_CRYP_STATE_RESET;\ 394 (__HANDLE__)->MspInitCallback = NULL; \ 395 (__HANDLE__)->MspDeInitCallback = NULL; \ 396 }while(0) 397 #else 398 #define __HAL_CRYP_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CRYP_STATE_RESET) 399 #endif /* USE_HAL_CRYP_REGISTER_CALLBACKS */ 400 401 /** 402 * @brief Enable the CRYP AES peripheral. 403 * @param __HANDLE__: specifies the CRYP handle. 404 * @retval None 405 */ 406 #define __HAL_CRYP_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= AES_CR_EN) 407 408 /** 409 * @brief Disable the CRYP AES peripheral. 410 * @param __HANDLE__: specifies the CRYP handle. 411 * @retval None 412 */ 413 #define __HAL_CRYP_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~AES_CR_EN) 414 415 /** 416 * @brief Set the algorithm operating mode. 417 * @param __HANDLE__: specifies the CRYP handle. 418 * @param __OPERATING_MODE__: specifies the operating mode 419 * This parameter can be one of the following values: 420 * @arg @ref CRYP_ALGOMODE_ENCRYPT encryption 421 * @arg @ref CRYP_ALGOMODE_KEYDERIVATION key derivation 422 * @arg @ref CRYP_ALGOMODE_DECRYPT decryption 423 * @arg @ref CRYP_ALGOMODE_KEYDERIVATION_DECRYPT key derivation and decryption 424 * @retval None 425 */ 426 #define __HAL_CRYP_SET_OPERATINGMODE(__HANDLE__, __OPERATING_MODE__) MODIFY_REG((__HANDLE__)->Instance->CR, AES_CR_MODE, (__OPERATING_MODE__)) 427 428 429 /** 430 * @brief Set the algorithm chaining mode. 431 * @param __HANDLE__: specifies the CRYP handle. 432 * @param __CHAINING_MODE__: specifies the chaining mode 433 * This parameter can be one of the following values: 434 * @arg @ref CRYP_CHAINMODE_AES_ECB Electronic CodeBook 435 * @arg @ref CRYP_CHAINMODE_AES_CBC Cipher Block Chaining 436 * @arg @ref CRYP_CHAINMODE_AES_CTR CounTeR mode 437 * @arg @ref CRYP_CHAINMODE_AES_GCM_GMAC Galois Counter Mode or Galois Message Authentication Code 438 * @arg @ref CRYP_CHAINMODE_AES_CMAC Cipher Message Authentication Code (or Counter with Cipher Mode when applicable) 439 * @retval None 440 */ 441 #define __HAL_CRYP_SET_CHAININGMODE(__HANDLE__, __CHAINING_MODE__) MODIFY_REG((__HANDLE__)->Instance->CR, AES_CR_CHMOD, (__CHAINING_MODE__)) 442 443 444 445 /** @brief Check whether the specified CRYP status flag is set or not. 446 * @param __HANDLE__: specifies the CRYP handle. 447 * @param __FLAG__: specifies the flag to check. 448 * This parameter can be one of the following values: 449 * @arg @ref CRYP_FLAG_BUSY GCM process suspension forbidden 450 * @arg @ref CRYP_IT_WRERR Write Error 451 * @arg @ref CRYP_IT_RDERR Read Error 452 * @arg @ref CRYP_IT_CCF Computation Complete 453 * @retval The state of __FLAG__ (TRUE or FALSE). 454 */ 455 #define __HAL_CRYP_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__)) 456 457 458 /** @brief Clear the CRYP pending status flag. 459 * @param __HANDLE__: specifies the CRYP handle. 460 * @param __FLAG__: specifies the flag to clear. 461 * This parameter can be one of the following values: 462 * @arg @ref CRYP_ERR_CLEAR Read (RDERR) or Write Error (WRERR) Flag Clear 463 * @arg @ref CRYP_CCF_CLEAR Computation Complete Flag (CCF) Clear 464 * @retval None 465 */ 466 #define __HAL_CRYP_CLEAR_FLAG(__HANDLE__, __FLAG__) SET_BIT((__HANDLE__)->Instance->CR, (__FLAG__)) 467 468 469 470 /** @brief Check whether the specified CRYP interrupt source is enabled or not. 471 * @param __HANDLE__: specifies the CRYP handle. 472 * @param __INTERRUPT__: CRYP interrupt source to check 473 * This parameter can be one of the following values: 474 * @arg @ref CRYP_IT_ERRIE Error interrupt (used for RDERR and WRERR) 475 * @arg @ref CRYP_IT_CCFIE Computation Complete interrupt 476 * @retval State of interruption (TRUE or FALSE). 477 */ 478 #define __HAL_CRYP_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR & (__INTERRUPT__)) == (__INTERRUPT__)) 479 480 481 /** @brief Check whether the specified CRYP interrupt is set or not. 482 * @param __HANDLE__: specifies the CRYP handle. 483 * @param __INTERRUPT__: specifies the interrupt to check. 484 * This parameter can be one of the following values: 485 * @arg @ref CRYP_IT_WRERR Write Error 486 * @arg @ref CRYP_IT_RDERR Read Error 487 * @arg @ref CRYP_IT_CCF Computation Complete 488 * @retval The state of __INTERRUPT__ (TRUE or FALSE). 489 */ 490 #define __HAL_CRYP_GET_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->SR & (__INTERRUPT__)) == (__INTERRUPT__)) 491 492 493 494 /** @brief Clear the CRYP pending interrupt. 495 * @param __HANDLE__: specifies the CRYP handle. 496 * @param __INTERRUPT__: specifies the IT to clear. 497 * This parameter can be one of the following values: 498 * @arg @ref CRYP_ERR_CLEAR Read (RDERR) or Write Error (WRERR) Flag Clear 499 * @arg @ref CRYP_CCF_CLEAR Computation Complete Flag (CCF) Clear 500 * @retval None 501 */ 502 #define __HAL_CRYP_CLEAR_IT(__HANDLE__, __INTERRUPT__) SET_BIT((__HANDLE__)->Instance->CR, (__INTERRUPT__)) 503 504 505 /** 506 * @brief Enable the CRYP interrupt. 507 * @param __HANDLE__: specifies the CRYP handle. 508 * @param __INTERRUPT__: CRYP Interrupt. 509 * This parameter can be one of the following values: 510 * @arg @ref CRYP_IT_ERRIE Error interrupt (used for RDERR and WRERR) 511 * @arg @ref CRYP_IT_CCFIE Computation Complete interrupt 512 * @retval None 513 */ 514 #define __HAL_CRYP_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) |= (__INTERRUPT__)) 515 516 517 /** 518 * @brief Disable the CRYP interrupt. 519 * @param __HANDLE__: specifies the CRYP handle. 520 * @param __INTERRUPT__: CRYP Interrupt. 521 * This parameter can be one of the following values: 522 * @arg @ref CRYP_IT_ERRIE Error interrupt (used for RDERR and WRERR) 523 * @arg @ref CRYP_IT_CCFIE Computation Complete interrupt 524 * @retval None 525 */ 526 #define __HAL_CRYP_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) &= ~(__INTERRUPT__)) 527 528 /** 529 * @} 530 */ 531 532 /* Private macros --------------------------------------------------------*/ 533 /** @addtogroup CRYP_Private_Macros CRYP Private Macros 534 * @{ 535 */ 536 537 /** 538 * @brief Verify the key size length. 539 * @param __KEYSIZE__: Ciphering/deciphering algorithm key size. 540 * @retval SET (__KEYSIZE__ is a valid value) or RESET (__KEYSIZE__ is invalid) 541 */ 542 #define IS_CRYP_KEYSIZE(__KEYSIZE__) (((__KEYSIZE__) == CRYP_KEYSIZE_128B) || \ 543 ((__KEYSIZE__) == CRYP_KEYSIZE_256B)) 544 545 /** 546 * @brief Verify the input data type. 547 * @param __DATATYPE__: Ciphering/deciphering algorithm input data type. 548 * @retval SET (__DATATYPE__ is valid) or RESET (__DATATYPE__ is invalid) 549 */ 550 #define IS_CRYP_DATATYPE(__DATATYPE__) (((__DATATYPE__) == CRYP_DATATYPE_32B) || \ 551 ((__DATATYPE__) == CRYP_DATATYPE_16B) || \ 552 ((__DATATYPE__) == CRYP_DATATYPE_8B) || \ 553 ((__DATATYPE__) == CRYP_DATATYPE_1B)) 554 555 /** 556 * @brief Verify the CRYP AES IP running mode. 557 * @param __MODE__: CRYP AES IP running mode. 558 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid) 559 */ 560 #define IS_CRYP_AES(__MODE__) (((__MODE__) == CRYP_AES_DISABLE) || \ 561 ((__MODE__) == CRYP_AES_ENABLE)) 562 563 /** 564 * @brief Verify the selected CRYP algorithm. 565 * @param __ALGOMODE__: Selected CRYP algorithm (ciphering, deciphering, key derivation or a combination of the latter). 566 * @retval SET (__ALGOMODE__ is valid) or RESET (__ALGOMODE__ is invalid) 567 */ 568 #define IS_CRYP_ALGOMODE(__ALGOMODE__) (((__ALGOMODE__) == CRYP_ALGOMODE_ENCRYPT) || \ 569 ((__ALGOMODE__) == CRYP_ALGOMODE_KEYDERIVATION) || \ 570 ((__ALGOMODE__) == CRYP_ALGOMODE_DECRYPT) || \ 571 ((__ALGOMODE__) == CRYP_ALGOMODE_TAG_GENERATION) || \ 572 ((__ALGOMODE__) == CRYP_ALGOMODE_KEYDERIVATION_DECRYPT)) 573 574 /** 575 * @brief Verify the selected CRYP chaining algorithm. 576 * @param __CHAINMODE__: Selected CRYP chaining algorithm. 577 * @retval SET (__CHAINMODE__ is valid) or RESET (__CHAINMODE__ is invalid) 578 */ 579 #if defined(AES_CR_NPBLB) 580 #define IS_CRYP_CHAINMODE(__CHAINMODE__) (((__CHAINMODE__) == CRYP_CHAINMODE_AES_ECB) || \ 581 ((__CHAINMODE__) == CRYP_CHAINMODE_AES_CBC) || \ 582 ((__CHAINMODE__) == CRYP_CHAINMODE_AES_CTR) || \ 583 ((__CHAINMODE__) == CRYP_CHAINMODE_AES_GCM_GMAC) || \ 584 ((__CHAINMODE__) == CRYP_CHAINMODE_AES_CCM)) 585 #else 586 #define IS_CRYP_CHAINMODE(__CHAINMODE__) (((__CHAINMODE__) == CRYP_CHAINMODE_AES_ECB) || \ 587 ((__CHAINMODE__) == CRYP_CHAINMODE_AES_CBC) || \ 588 ((__CHAINMODE__) == CRYP_CHAINMODE_AES_CTR) || \ 589 ((__CHAINMODE__) == CRYP_CHAINMODE_AES_GCM_GMAC) || \ 590 ((__CHAINMODE__) == CRYP_CHAINMODE_AES_CMAC)) 591 #endif 592 593 /** 594 * @brief Verify the deciphering key write option. 595 * @param __WRITE__: deciphering key write option. 596 * @retval SET (__WRITE__ is valid) or RESET (__WRITE__ is invalid) 597 */ 598 #define IS_CRYP_WRITE(__WRITE__) (((__WRITE__) == CRYP_KEY_WRITE_ENABLE) || \ 599 ((__WRITE__) == CRYP_KEY_WRITE_DISABLE)) 600 601 /** 602 * @brief Verify the CRYP input data DMA mode. 603 * @param __MODE__: CRYP input data DMA mode. 604 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid) 605 */ 606 #define IS_CRYP_DMAIN(__MODE__) (((__MODE__) == CRYP_DMAIN_DISABLE) || \ 607 ((__MODE__) == CRYP_DMAIN_ENABLE)) 608 609 /** 610 * @brief Verify the CRYP output data DMA mode. 611 * @param __MODE__: CRYP output data DMA mode. 612 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid) 613 */ 614 #define IS_CRYP_DMAOUT(__MODE__) (((__MODE__) == CRYP_DMAOUT_DISABLE) || \ 615 ((__MODE__) == CRYP_DMAOUT_ENABLE)) 616 617 /** 618 * @brief Verify the CRYP AES ciphering/deciphering/authentication algorithm phase. 619 * @param __PHASE__: CRYP AES ciphering/deciphering/authentication algorithm phase. 620 * @retval SET (__PHASE__ is valid) or RESET (__PHASE__ is invalid) 621 */ 622 #define IS_CRYP_GCMCMAC_PHASE(__PHASE__) (((__PHASE__) == CRYP_INIT_PHASE) || \ 623 ((__PHASE__) == CRYP_HEADER_PHASE) || \ 624 ((__PHASE__) == CRYP_PAYLOAD_PHASE) || \ 625 ((__PHASE__) == CRYP_FINAL_PHASE)) 626 627 /** 628 * @} 629 */ 630 631 /* Include CRYP HAL Extended module */ 632 #include "stm32l4xx_hal_cryp_ex.h" 633 634 /* Exported functions --------------------------------------------------------*/ 635 /** @addtogroup CRYP_Exported_Functions CRYP Exported Functions 636 * @{ 637 */ 638 639 /** @addtogroup CRYP_Exported_Functions_Group1 Initialization and deinitialization functions 640 * @{ 641 */ 642 643 /* Initialization/de-initialization functions ********************************/ 644 HAL_StatusTypeDef HAL_CRYP_Init(CRYP_HandleTypeDef *hcryp); 645 HAL_StatusTypeDef HAL_CRYP_DeInit(CRYP_HandleTypeDef *hcryp); 646 647 /* MSP initialization/de-initialization functions ****************************/ 648 void HAL_CRYP_MspInit(CRYP_HandleTypeDef *hcryp); 649 void HAL_CRYP_MspDeInit(CRYP_HandleTypeDef *hcryp); 650 651 /** 652 * @} 653 */ 654 655 /** @addtogroup CRYP_Exported_Functions_Group2 AES processing functions 656 * @{ 657 */ 658 659 /* AES encryption/decryption processing functions ****************************/ 660 661 /* AES encryption/decryption using polling ***********************************/ 662 HAL_StatusTypeDef HAL_CRYP_AESECB_Encrypt(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout); 663 HAL_StatusTypeDef HAL_CRYP_AESECB_Decrypt(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout); 664 HAL_StatusTypeDef HAL_CRYP_AESCBC_Encrypt(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout); 665 HAL_StatusTypeDef HAL_CRYP_AESCBC_Decrypt(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout); 666 HAL_StatusTypeDef HAL_CRYP_AESCTR_Encrypt(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout); 667 HAL_StatusTypeDef HAL_CRYP_AESCTR_Decrypt(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout); 668 669 /* AES encryption/decryption using interrupt *********************************/ 670 HAL_StatusTypeDef HAL_CRYP_AESECB_Encrypt_IT(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData); 671 HAL_StatusTypeDef HAL_CRYP_AESCBC_Encrypt_IT(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData); 672 HAL_StatusTypeDef HAL_CRYP_AESCTR_Encrypt_IT(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData); 673 HAL_StatusTypeDef HAL_CRYP_AESECB_Decrypt_IT(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData); 674 HAL_StatusTypeDef HAL_CRYP_AESCTR_Decrypt_IT(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData); 675 HAL_StatusTypeDef HAL_CRYP_AESCBC_Decrypt_IT(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData); 676 677 /* AES encryption/decryption using DMA ***************************************/ 678 HAL_StatusTypeDef HAL_CRYP_AESECB_Encrypt_DMA(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData); 679 HAL_StatusTypeDef HAL_CRYP_AESECB_Decrypt_DMA(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData); 680 HAL_StatusTypeDef HAL_CRYP_AESCBC_Encrypt_DMA(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData); 681 HAL_StatusTypeDef HAL_CRYP_AESCBC_Decrypt_DMA(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData); 682 HAL_StatusTypeDef HAL_CRYP_AESCTR_Encrypt_DMA(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData); 683 HAL_StatusTypeDef HAL_CRYP_AESCTR_Decrypt_DMA(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData); 684 685 /** 686 * @} 687 */ 688 689 /** @addtogroup CRYP_Exported_Functions_Group3 Callback functions 690 * @{ 691 */ 692 /* CallBack functions ********************************************************/ 693 void HAL_CRYP_InCpltCallback(CRYP_HandleTypeDef *hcryp); 694 void HAL_CRYP_OutCpltCallback(CRYP_HandleTypeDef *hcryp); 695 void HAL_CRYP_ErrorCallback(CRYP_HandleTypeDef *hcryp); 696 /* Callbacks Register/UnRegister functions ***********************************/ 697 #if (USE_HAL_CRYP_REGISTER_CALLBACKS == 1) 698 HAL_StatusTypeDef HAL_CRYP_RegisterCallback(CRYP_HandleTypeDef *hcryp, HAL_CRYP_CallbackIDTypeDef CallbackID, pCRYP_CallbackTypeDef pCallback); 699 HAL_StatusTypeDef HAL_CRYP_UnRegisterCallback(CRYP_HandleTypeDef *hcryp, HAL_CRYP_CallbackIDTypeDef CallbackID); 700 #endif /* USE_HAL_CRYP_REGISTER_CALLBACKS */ 701 702 /** 703 * @} 704 */ 705 706 /** @addtogroup CRYP_Exported_Functions_Group4 CRYP IRQ handler 707 * @{ 708 */ 709 710 /* AES interrupt handling function *******************************************/ 711 void HAL_CRYP_IRQHandler(CRYP_HandleTypeDef *hcryp); 712 713 /** 714 * @} 715 */ 716 717 /** @addtogroup CRYP_Exported_Functions_Group5 Peripheral State functions 718 * @{ 719 */ 720 721 /* Peripheral State functions ************************************************/ 722 HAL_CRYP_STATETypeDef HAL_CRYP_GetState(CRYP_HandleTypeDef *hcryp); 723 uint32_t HAL_CRYP_GetError(CRYP_HandleTypeDef *hcryp); 724 725 /** 726 * @} 727 */ 728 729 /** 730 * @} 731 */ 732 733 /** 734 * @} 735 */ 736 737 #endif /* AES */ 738 739 /** 740 * @} 741 */ 742 743 #ifdef __cplusplus 744 } 745 #endif 746 747 #endif /* __STM32L4xx_HAL_CRYP_H */ 748 749 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 750
