|
STM32L486xx HAL User Manual
|
00001 /** 00002 ****************************************************************************** 00003 * @file stm32l4xx_hal_cryp.h 00004 * @author MCD Application Team 00005 * @brief Header file of CRYP HAL module. 00006 ****************************************************************************** 00007 * @attention 00008 * 00009 * <h2><center>© COPYRIGHT(c) 2017 STMicroelectronics</center></h2> 00010 * 00011 * Redistribution and use in source and binary forms, with or without modification, 00012 * are permitted provided that the following conditions are met: 00013 * 1. Redistributions of source code must retain the above copyright notice, 00014 * this list of conditions and the following disclaimer. 00015 * 2. Redistributions in binary form must reproduce the above copyright notice, 00016 * this list of conditions and the following disclaimer in the documentation 00017 * and/or other materials provided with the distribution. 00018 * 3. Neither the name of STMicroelectronics nor the names of its contributors 00019 * may be used to endorse or promote products derived from this software 00020 * without specific prior written permission. 00021 * 00022 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 00023 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00024 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 00025 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 00026 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 00027 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 00028 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 00029 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 00030 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 00031 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00032 * 00033 ****************************************************************************** 00034 */ 00035 00036 /* Define to prevent recursive inclusion -------------------------------------*/ 00037 #ifndef __STM32L4xx_HAL_CRYP_H 00038 #define __STM32L4xx_HAL_CRYP_H 00039 00040 #ifdef __cplusplus 00041 extern "C" { 00042 #endif 00043 00044 #if defined(AES) 00045 00046 /* Includes ------------------------------------------------------------------*/ 00047 #include "stm32l4xx_hal_def.h" 00048 00049 /** @addtogroup STM32L4xx_HAL_Driver 00050 * @{ 00051 */ 00052 00053 /** @addtogroup CRYP 00054 * @{ 00055 */ 00056 00057 /* Exported types ------------------------------------------------------------*/ 00058 /** @defgroup CRYP_Exported_Types CRYP Exported Types 00059 * @{ 00060 */ 00061 00062 /** 00063 * @brief CRYP Configuration Structure definition 00064 */ 00065 typedef struct 00066 { 00067 uint32_t DataType; /*!< 32-bit data, 16-bit data, 8-bit data or 1-bit string. 00068 This parameter can be a value of @ref CRYP_Data_Type */ 00069 00070 uint32_t KeySize; /*!< 128 or 256-bit key length. 00071 This parameter can be a value of @ref CRYP_Key_Size */ 00072 00073 uint32_t OperatingMode; /*!< AES operating mode. 00074 This parameter can be a value of @ref CRYP_AES_OperatingMode */ 00075 00076 uint32_t ChainingMode; /*!< AES chaining mode. 00077 This parameter can be a value of @ref CRYP_AES_ChainingMode */ 00078 00079 uint32_t KeyWriteFlag; /*!< Allows to bypass or not key write-up before decryption. 00080 This parameter can be a value of @ref CRYP_Key_Write */ 00081 00082 uint32_t GCMCMACPhase; /*!< Indicates the processing phase of the Galois Counter Mode (GCM), 00083 Galois Message Authentication Code (GMAC), Cipher Message 00084 Authentication Code (CMAC) (when applicable) or Counter with Cipher 00085 Mode (CCM) (when applicable). 00086 This parameter can be a value of @ref CRYP_GCM_CMAC_Phase */ 00087 00088 uint8_t* pKey; /*!< Encryption/Decryption Key */ 00089 00090 uint8_t* pInitVect; /*!< Initialization Vector used for CTR, CBC, GCM/GMAC, CMAC (when applicable) 00091 and CCM (when applicable) modes */ 00092 00093 uint8_t* Header; /*!< Header used in GCM/GMAC, CMAC (when applicable) and CCM (when applicable) modes */ 00094 00095 uint64_t HeaderSize; /*!< Header size in bytes */ 00096 00097 }CRYP_InitTypeDef; 00098 00099 /** 00100 * @brief HAL CRYP State structures definition 00101 */ 00102 typedef enum 00103 { 00104 HAL_CRYP_STATE_RESET = 0x00, /*!< CRYP not yet initialized or disabled */ 00105 HAL_CRYP_STATE_READY = 0x01, /*!< CRYP initialized and ready for use */ 00106 HAL_CRYP_STATE_BUSY = 0x02, /*!< CRYP internal processing is ongoing */ 00107 HAL_CRYP_STATE_TIMEOUT = 0x03, /*!< CRYP timeout state */ 00108 HAL_CRYP_STATE_ERROR = 0x04, /*!< CRYP error state */ 00109 HAL_CRYP_STATE_SUSPENDED = 0x05 /*!< CRYP suspended */ 00110 }HAL_CRYP_STATETypeDef; 00111 00112 /** 00113 * @brief HAL CRYP phase structures definition 00114 */ 00115 typedef enum 00116 { 00117 HAL_CRYP_PHASE_READY = 0x01, /*!< CRYP peripheral is ready for initialization. */ 00118 HAL_CRYP_PHASE_PROCESS = 0x02, /*!< CRYP peripheral is in processing phase */ 00119 HAL_CRYP_PHASE_START = 0x03, /*!< CRYP peripheral has been initialized but 00120 GCM/GMAC(/CMAC)(/CCM) initialization phase has not started */ 00121 HAL_CRYP_PHASE_INIT_OVER = 0x04, /*!< GCM/GMAC(/CMAC)(/CCM) init phase has been carried out */ 00122 HAL_CRYP_PHASE_HEADER_OVER = 0x05, /*!< GCM/GMAC(/CMAC)(/CCM) header phase has been carried out */ 00123 HAL_CRYP_PHASE_PAYLOAD_OVER = 0x06, /*!< GCM(/CCM) payload phase has been carried out */ 00124 HAL_CRYP_PHASE_FINAL_OVER = 0x07, /*!< GCM/GMAC(/CMAC)(/CCM) final phase has been carried out */ 00125 HAL_CRYP_PHASE_HEADER_SUSPENDED = 0x08, /*!< GCM/GMAC(/CMAC)(/CCM) header phase has been suspended */ 00126 HAL_CRYP_PHASE_PAYLOAD_SUSPENDED = 0x09, /*!< GCM(/CCM) payload phase has been suspended */ 00127 HAL_CRYP_PHASE_NOT_USED = 0x0a /*!< Phase is irrelevant to the current chaining mode */ 00128 }HAL_PhaseTypeDef; 00129 00130 /** 00131 * @brief HAL CRYP mode suspend definitions 00132 */ 00133 typedef enum 00134 { 00135 HAL_CRYP_SUSPEND_NONE = 0x00, /*!< CRYP peripheral suspension not requested */ 00136 HAL_CRYP_SUSPEND = 0x01 /*!< CRYP peripheral suspension requested */ 00137 }HAL_SuspendTypeDef; 00138 00139 00140 /** 00141 * @brief HAL CRYP Error Codes definition 00142 */ 00143 #define HAL_CRYP_ERROR_NONE ((uint32_t)0x00000000) /*!< No error */ 00144 #define HAL_CRYP_WRITE_ERROR ((uint32_t)0x00000001) /*!< Write error */ 00145 #define HAL_CRYP_READ_ERROR ((uint32_t)0x00000002) /*!< Read error */ 00146 #define HAL_CRYP_DMA_ERROR ((uint32_t)0x00000004) /*!< DMA error */ 00147 #define HAL_CRYP_BUSY_ERROR ((uint32_t)0x00000008) /*!< Busy flag error */ 00148 #if (USE_HAL_CRYP_REGISTER_CALLBACKS == 1) 00149 #define HAL_CRYP_ERROR_INVALID_CALLBACK ((uint32_t)0x00000010U) /*!< Invalid Callback error */ 00150 #endif /* USE_HAL_CRYP_REGISTER_CALLBACKS */ 00151 00152 #if (USE_HAL_CRYP_REGISTER_CALLBACKS == 1) 00153 /** 00154 * @brief HAL CRYP common Callback ID enumeration definition 00155 */ 00156 typedef enum 00157 { 00158 HAL_CRYP_INPUTCPLT_CB_ID = 0x01U, /*!< CRYP input DMA transfer completion callback ID */ 00159 HAL_CRYP_OUTPUTCPLT_CB_ID = 0x02U, /*!< CRYP output DMA transfer completion callback ID */ 00160 HAL_CRYP_COMPCPLT_CB_ID = 0x03U, /*!< CRYP computation completion callback ID */ 00161 HAL_CRYP_ERROR_CB_ID = 0x04U, /*!< CRYP error callback ID */ 00162 HAL_CRYP_MSPINIT_CB_ID = 0x05U, /*!< CRYP MspInit callback ID */ 00163 HAL_CRYP_MSPDEINIT_CB_ID = 0x06U, /*!< CRYP MspDeInit callback ID */ 00164 }HAL_CRYP_CallbackIDTypeDef; 00165 #endif /* USE_HAL_CRYP_REGISTER_CALLBACKS */ 00166 00167 /** 00168 * @brief CRYP handle Structure definition 00169 */ 00170 typedef struct __CRYP_HandleTypeDef 00171 { 00172 AES_TypeDef *Instance; /*!< Register base address */ 00173 00174 CRYP_InitTypeDef Init; /*!< CRYP initialization parameters */ 00175 00176 uint8_t *pCrypInBuffPtr; /*!< Pointer to CRYP processing (encryption, decryption,...) input buffer */ 00177 00178 uint8_t *pCrypOutBuffPtr; /*!< Pointer to CRYP processing (encryption, decryption,...) output buffer */ 00179 00180 uint32_t CrypInCount; /*!< Input data size in bytes or, after suspension, the remaining 00181 number of bytes to process */ 00182 00183 uint32_t CrypOutCount; /*!< Output data size in bytes */ 00184 00185 HAL_PhaseTypeDef Phase; /*!< CRYP peripheral processing phase for GCM, GMAC, CMAC (when applicable) 00186 or CCM (when applicable) modes. 00187 Indicates the last phase carried out to ease 00188 phase transitions */ 00189 00190 DMA_HandleTypeDef *hdmain; /*!< CRYP peripheral Input DMA handle parameters */ 00191 00192 DMA_HandleTypeDef *hdmaout; /*!< CRYP peripheral Output DMA handle parameters */ 00193 00194 HAL_LockTypeDef Lock; /*!< CRYP locking object */ 00195 00196 __IO HAL_CRYP_STATETypeDef State; /*!< CRYP peripheral state */ 00197 00198 __IO uint32_t ErrorCode; /*!< CRYP peripheral error code */ 00199 00200 HAL_SuspendTypeDef SuspendRequest; /*!< CRYP peripheral suspension request flag */ 00201 00202 #if (USE_HAL_CRYP_REGISTER_CALLBACKS == 1) 00203 void (* InCpltCallback)( struct __CRYP_HandleTypeDef * hcryp); /*!< CRYP input DMA transfer completion callback */ 00204 00205 void (* OutCpltCallback)( struct __CRYP_HandleTypeDef * hcryp); /*!< CRYP output DMA transfer completion callback */ 00206 00207 void (* CompCpltCallback)( struct __CRYP_HandleTypeDef * hcryp); /*!< CRYP computation completion callback */ 00208 00209 void (* ErrorCallback)( struct __CRYP_HandleTypeDef * hcryp); /*!< CRYP error callback */ 00210 00211 void (* MspInitCallback)( struct __CRYP_HandleTypeDef * hcryp); /*!< CRYP Msp Init callback */ 00212 00213 void (* MspDeInitCallback)( struct __CRYP_HandleTypeDef * hcryp); /*!< CRYP Msp DeInit callback */ 00214 00215 #endif /* (USE_HAL_CRYP_REGISTER_CALLBACKS) */ 00216 }CRYP_HandleTypeDef; 00217 00218 00219 #if (USE_HAL_CRYP_REGISTER_CALLBACKS == 1) 00220 /** 00221 * @brief HAL CRYP Callback pointer definition 00222 */ 00223 typedef void (*pCRYP_CallbackTypeDef)(CRYP_HandleTypeDef * hcryp); /*!< pointer to a CRYP common callback functions */ 00224 #endif /* USE_HAL_CRYP_REGISTER_CALLBACKS */ 00225 /** 00226 * @} 00227 */ 00228 00229 00230 /* Exported constants --------------------------------------------------------*/ 00231 /** @defgroup CRYP_Exported_Constants CRYP Exported Constants 00232 * @{ 00233 */ 00234 00235 /** @defgroup CRYP_Key_Size Key size selection 00236 * @{ 00237 */ 00238 #define CRYP_KEYSIZE_128B ((uint32_t)0x00000000) /*!< 128-bit long key */ 00239 #define CRYP_KEYSIZE_256B AES_CR_KEYSIZE /*!< 256-bit long key */ 00240 /** 00241 * @} 00242 */ 00243 00244 /** @defgroup CRYP_Data_Type AES Data Type selection 00245 * @{ 00246 */ 00247 #define CRYP_DATATYPE_32B ((uint32_t)0x00000000) /*!< 32-bit data type (no swapping) */ 00248 #define CRYP_DATATYPE_16B AES_CR_DATATYPE_0 /*!< 16-bit data type (half-word swapping) */ 00249 #define CRYP_DATATYPE_8B AES_CR_DATATYPE_1 /*!< 8-bit data type (byte swapping) */ 00250 #define CRYP_DATATYPE_1B AES_CR_DATATYPE /*!< 1-bit data type (bit swapping) */ 00251 /** 00252 * @} 00253 */ 00254 00255 /** @defgroup CRYP_AES_State AES Enable state 00256 * @{ 00257 */ 00258 #define CRYP_AES_DISABLE ((uint32_t)0x00000000) /*!< Disable AES */ 00259 #define CRYP_AES_ENABLE AES_CR_EN /*!< Enable AES */ 00260 /** 00261 * @} 00262 */ 00263 00264 /** @defgroup CRYP_AES_OperatingMode AES operating mode 00265 * @{ 00266 */ 00267 #define CRYP_ALGOMODE_ENCRYPT ((uint32_t)0x00000000) /*!< Encryption mode */ 00268 #define CRYP_ALGOMODE_KEYDERIVATION AES_CR_MODE_0 /*!< Key derivation mode */ 00269 #define CRYP_ALGOMODE_DECRYPT AES_CR_MODE_1 /*!< Decryption */ 00270 #define CRYP_ALGOMODE_KEYDERIVATION_DECRYPT AES_CR_MODE /*!< Key derivation and decryption */ 00271 #define CRYP_ALGOMODE_TAG_GENERATION ((uint32_t)0x00000000) /*!< GMAC or CMAC (when applicable) authentication tag generation */ 00272 /** 00273 * @} 00274 */ 00275 00276 /** @defgroup CRYP_AES_ChainingMode AES chaining mode 00277 * @{ 00278 */ 00279 #define CRYP_CHAINMODE_AES_ECB ((uint32_t)0x00000000) /*!< Electronic codebook chaining algorithm */ 00280 #define CRYP_CHAINMODE_AES_CBC AES_CR_CHMOD_0 /*!< Cipher block chaining algorithm */ 00281 #define CRYP_CHAINMODE_AES_CTR AES_CR_CHMOD_1 /*!< Counter mode chaining algorithm */ 00282 #define CRYP_CHAINMODE_AES_GCM_GMAC (AES_CR_CHMOD_0 | AES_CR_CHMOD_1) /*!< Galois counter mode - Galois message authentication code */ 00283 #if defined(AES_CR_NPBLB) 00284 #define CRYP_CHAINMODE_AES_CCM AES_CR_CHMOD_2 /*!< Counter with Cipher Mode */ 00285 #else 00286 #define CRYP_CHAINMODE_AES_CMAC AES_CR_CHMOD_2 /*!< Cipher message authentication code */ 00287 #endif 00288 /** 00289 * @} 00290 */ 00291 00292 /** @defgroup CRYP_Key_Write AES decryption key write-up flag 00293 * @{ 00294 */ 00295 #define CRYP_KEY_WRITE_ENABLE ((uint32_t)0x00000000) /*!< Enable decryption key writing */ 00296 #define CRYP_KEY_WRITE_DISABLE ((uint32_t)0x00000001) /*!< Disable decryption key writing */ 00297 /** 00298 * @} 00299 */ 00300 00301 /** @defgroup CRYP_DMAIN DMA Input phase management enable state 00302 * @{ 00303 */ 00304 #define CRYP_DMAIN_DISABLE ((uint32_t)0x00000000) /*!< Disable DMA Input phase management */ 00305 #define CRYP_DMAIN_ENABLE AES_CR_DMAINEN /*!< Enable DMA Input phase management */ 00306 /** 00307 * @} 00308 */ 00309 00310 /** @defgroup CRYP_DMAOUT DMA Output phase management enable state 00311 * @{ 00312 */ 00313 #define CRYP_DMAOUT_DISABLE ((uint32_t)0x00000000) /*!< Disable DMA Output phase management */ 00314 #define CRYP_DMAOUT_ENABLE AES_CR_DMAOUTEN /*!< Enable DMA Output phase management */ 00315 /** 00316 * @} 00317 */ 00318 00319 00320 /** @defgroup CRYP_GCM_CMAC_Phase GCM/GMAC and CCM/CMAC (when applicable) processing phase selection 00321 * @{ 00322 */ 00323 #define CRYP_GCM_INIT_PHASE ((uint32_t)0x00000000) /*!< GCM/GMAC (or CCM) init phase */ 00324 #define CRYP_GCMCMAC_HEADER_PHASE AES_CR_GCMPH_0 /*!< GCM/GMAC/CCM/CMAC header phase */ 00325 #define CRYP_GCM_PAYLOAD_PHASE AES_CR_GCMPH_1 /*!< GCM/CCM payload phase */ 00326 #define CRYP_GCMCMAC_FINAL_PHASE AES_CR_GCMPH /*!< GCM/GMAC/CCM/CMAC final phase */ 00327 /* Definitions duplication for code readibility's sake: 00328 supported or not supported chain modes are not specified for each phase */ 00329 #define CRYP_INIT_PHASE ((uint32_t)0x00000000) /*!< Init phase */ 00330 #define CRYP_HEADER_PHASE AES_CR_GCMPH_0 /*!< Header phase */ 00331 #define CRYP_PAYLOAD_PHASE AES_CR_GCMPH_1 /*!< Payload phase */ 00332 #define CRYP_FINAL_PHASE AES_CR_GCMPH /*!< Final phase */ 00333 /** 00334 * @} 00335 */ 00336 00337 /** @defgroup CRYP_Flags AES status flags 00338 * @{ 00339 */ 00340 00341 #define CRYP_FLAG_BUSY AES_SR_BUSY /*!< GCM process suspension forbidden */ 00342 #define CRYP_FLAG_WRERR AES_SR_WRERR /*!< Write Error */ 00343 #define CRYP_FLAG_RDERR AES_SR_RDERR /*!< Read error */ 00344 #define CRYP_FLAG_CCF AES_SR_CCF /*!< Computation completed */ 00345 /** 00346 * @} 00347 */ 00348 00349 /** @defgroup CRYP_Clear_Flags AES clearing flags 00350 * @{ 00351 */ 00352 00353 #define CRYP_CCF_CLEAR AES_CR_CCFC /*!< Computation Complete Flag Clear */ 00354 #define CRYP_ERR_CLEAR AES_CR_ERRC /*!< Error Flag Clear */ 00355 /** 00356 * @} 00357 */ 00358 00359 /** @defgroup AES_Interrupts_Enable AES Interrupts Enable bits 00360 * @{ 00361 */ 00362 #define CRYP_IT_CCFIE AES_CR_CCFIE /*!< Computation Complete interrupt enable */ 00363 #define CRYP_IT_ERRIE AES_CR_ERRIE /*!< Error interrupt enable */ 00364 /** 00365 * @} 00366 */ 00367 00368 /** @defgroup CRYP_Interrupts_Flags AES Interrupts flags 00369 * @{ 00370 */ 00371 #define CRYP_IT_WRERR AES_SR_WRERR /*!< Write Error */ 00372 #define CRYP_IT_RDERR AES_SR_RDERR /*!< Read Error */ 00373 #define CRYP_IT_CCF AES_SR_CCF /*!< Computation completed */ 00374 /** 00375 * @} 00376 */ 00377 00378 /** 00379 * @} 00380 */ 00381 00382 /* Exported macros -----------------------------------------------------------*/ 00383 /** @defgroup CRYP_Exported_Macros CRYP Exported Macros 00384 * @{ 00385 */ 00386 00387 /** @brief Reset CRYP handle state. 00388 * @param __HANDLE__: specifies the CRYP handle. 00389 * @retval None 00390 */ 00391 #if (USE_HAL_CRYP_REGISTER_CALLBACKS == 1) 00392 #define __HAL_CRYP_RESET_HANDLE_STATE(__HANDLE__) do{\ 00393 (__HANDLE__)->State = HAL_CRYP_STATE_RESET;\ 00394 (__HANDLE__)->MspInitCallback = NULL; \ 00395 (__HANDLE__)->MspDeInitCallback = NULL; \ 00396 }while(0) 00397 #else 00398 #define __HAL_CRYP_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CRYP_STATE_RESET) 00399 #endif /* USE_HAL_CRYP_REGISTER_CALLBACKS */ 00400 00401 /** 00402 * @brief Enable the CRYP AES peripheral. 00403 * @param __HANDLE__: specifies the CRYP handle. 00404 * @retval None 00405 */ 00406 #define __HAL_CRYP_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= AES_CR_EN) 00407 00408 /** 00409 * @brief Disable the CRYP AES peripheral. 00410 * @param __HANDLE__: specifies the CRYP handle. 00411 * @retval None 00412 */ 00413 #define __HAL_CRYP_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~AES_CR_EN) 00414 00415 /** 00416 * @brief Set the algorithm operating mode. 00417 * @param __HANDLE__: specifies the CRYP handle. 00418 * @param __OPERATING_MODE__: specifies the operating mode 00419 * This parameter can be one of the following values: 00420 * @arg @ref CRYP_ALGOMODE_ENCRYPT encryption 00421 * @arg @ref CRYP_ALGOMODE_KEYDERIVATION key derivation 00422 * @arg @ref CRYP_ALGOMODE_DECRYPT decryption 00423 * @arg @ref CRYP_ALGOMODE_KEYDERIVATION_DECRYPT key derivation and decryption 00424 * @retval None 00425 */ 00426 #define __HAL_CRYP_SET_OPERATINGMODE(__HANDLE__, __OPERATING_MODE__) MODIFY_REG((__HANDLE__)->Instance->CR, AES_CR_MODE, (__OPERATING_MODE__)) 00427 00428 00429 /** 00430 * @brief Set the algorithm chaining mode. 00431 * @param __HANDLE__: specifies the CRYP handle. 00432 * @param __CHAINING_MODE__: specifies the chaining mode 00433 * This parameter can be one of the following values: 00434 * @arg @ref CRYP_CHAINMODE_AES_ECB Electronic CodeBook 00435 * @arg @ref CRYP_CHAINMODE_AES_CBC Cipher Block Chaining 00436 * @arg @ref CRYP_CHAINMODE_AES_CTR CounTeR mode 00437 * @arg @ref CRYP_CHAINMODE_AES_GCM_GMAC Galois Counter Mode or Galois Message Authentication Code 00438 * @arg @ref CRYP_CHAINMODE_AES_CMAC Cipher Message Authentication Code (or Counter with Cipher Mode when applicable) 00439 * @retval None 00440 */ 00441 #define __HAL_CRYP_SET_CHAININGMODE(__HANDLE__, __CHAINING_MODE__) MODIFY_REG((__HANDLE__)->Instance->CR, AES_CR_CHMOD, (__CHAINING_MODE__)) 00442 00443 00444 00445 /** @brief Check whether the specified CRYP status flag is set or not. 00446 * @param __HANDLE__: specifies the CRYP handle. 00447 * @param __FLAG__: specifies the flag to check. 00448 * This parameter can be one of the following values: 00449 * @arg @ref CRYP_FLAG_BUSY GCM process suspension forbidden 00450 * @arg @ref CRYP_IT_WRERR Write Error 00451 * @arg @ref CRYP_IT_RDERR Read Error 00452 * @arg @ref CRYP_IT_CCF Computation Complete 00453 * @retval The state of __FLAG__ (TRUE or FALSE). 00454 */ 00455 #define __HAL_CRYP_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__)) 00456 00457 00458 /** @brief Clear the CRYP pending status flag. 00459 * @param __HANDLE__: specifies the CRYP handle. 00460 * @param __FLAG__: specifies the flag to clear. 00461 * This parameter can be one of the following values: 00462 * @arg @ref CRYP_ERR_CLEAR Read (RDERR) or Write Error (WRERR) Flag Clear 00463 * @arg @ref CRYP_CCF_CLEAR Computation Complete Flag (CCF) Clear 00464 * @retval None 00465 */ 00466 #define __HAL_CRYP_CLEAR_FLAG(__HANDLE__, __FLAG__) SET_BIT((__HANDLE__)->Instance->CR, (__FLAG__)) 00467 00468 00469 00470 /** @brief Check whether the specified CRYP interrupt source is enabled or not. 00471 * @param __HANDLE__: specifies the CRYP handle. 00472 * @param __INTERRUPT__: CRYP interrupt source to check 00473 * This parameter can be one of the following values: 00474 * @arg @ref CRYP_IT_ERRIE Error interrupt (used for RDERR and WRERR) 00475 * @arg @ref CRYP_IT_CCFIE Computation Complete interrupt 00476 * @retval State of interruption (TRUE or FALSE). 00477 */ 00478 #define __HAL_CRYP_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR & (__INTERRUPT__)) == (__INTERRUPT__)) 00479 00480 00481 /** @brief Check whether the specified CRYP interrupt is set or not. 00482 * @param __HANDLE__: specifies the CRYP handle. 00483 * @param __INTERRUPT__: specifies the interrupt to check. 00484 * This parameter can be one of the following values: 00485 * @arg @ref CRYP_IT_WRERR Write Error 00486 * @arg @ref CRYP_IT_RDERR Read Error 00487 * @arg @ref CRYP_IT_CCF Computation Complete 00488 * @retval The state of __INTERRUPT__ (TRUE or FALSE). 00489 */ 00490 #define __HAL_CRYP_GET_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->SR & (__INTERRUPT__)) == (__INTERRUPT__)) 00491 00492 00493 00494 /** @brief Clear the CRYP pending interrupt. 00495 * @param __HANDLE__: specifies the CRYP handle. 00496 * @param __INTERRUPT__: specifies the IT to clear. 00497 * This parameter can be one of the following values: 00498 * @arg @ref CRYP_ERR_CLEAR Read (RDERR) or Write Error (WRERR) Flag Clear 00499 * @arg @ref CRYP_CCF_CLEAR Computation Complete Flag (CCF) Clear 00500 * @retval None 00501 */ 00502 #define __HAL_CRYP_CLEAR_IT(__HANDLE__, __INTERRUPT__) SET_BIT((__HANDLE__)->Instance->CR, (__INTERRUPT__)) 00503 00504 00505 /** 00506 * @brief Enable the CRYP interrupt. 00507 * @param __HANDLE__: specifies the CRYP handle. 00508 * @param __INTERRUPT__: CRYP Interrupt. 00509 * This parameter can be one of the following values: 00510 * @arg @ref CRYP_IT_ERRIE Error interrupt (used for RDERR and WRERR) 00511 * @arg @ref CRYP_IT_CCFIE Computation Complete interrupt 00512 * @retval None 00513 */ 00514 #define __HAL_CRYP_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) |= (__INTERRUPT__)) 00515 00516 00517 /** 00518 * @brief Disable the CRYP interrupt. 00519 * @param __HANDLE__: specifies the CRYP handle. 00520 * @param __INTERRUPT__: CRYP Interrupt. 00521 * This parameter can be one of the following values: 00522 * @arg @ref CRYP_IT_ERRIE Error interrupt (used for RDERR and WRERR) 00523 * @arg @ref CRYP_IT_CCFIE Computation Complete interrupt 00524 * @retval None 00525 */ 00526 #define __HAL_CRYP_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) &= ~(__INTERRUPT__)) 00527 00528 /** 00529 * @} 00530 */ 00531 00532 /* Private macros --------------------------------------------------------*/ 00533 /** @addtogroup CRYP_Private_Macros CRYP Private Macros 00534 * @{ 00535 */ 00536 00537 /** 00538 * @brief Verify the key size length. 00539 * @param __KEYSIZE__: Ciphering/deciphering algorithm key size. 00540 * @retval SET (__KEYSIZE__ is a valid value) or RESET (__KEYSIZE__ is invalid) 00541 */ 00542 #define IS_CRYP_KEYSIZE(__KEYSIZE__) (((__KEYSIZE__) == CRYP_KEYSIZE_128B) || \ 00543 ((__KEYSIZE__) == CRYP_KEYSIZE_256B)) 00544 00545 /** 00546 * @brief Verify the input data type. 00547 * @param __DATATYPE__: Ciphering/deciphering algorithm input data type. 00548 * @retval SET (__DATATYPE__ is valid) or RESET (__DATATYPE__ is invalid) 00549 */ 00550 #define IS_CRYP_DATATYPE(__DATATYPE__) (((__DATATYPE__) == CRYP_DATATYPE_32B) || \ 00551 ((__DATATYPE__) == CRYP_DATATYPE_16B) || \ 00552 ((__DATATYPE__) == CRYP_DATATYPE_8B) || \ 00553 ((__DATATYPE__) == CRYP_DATATYPE_1B)) 00554 00555 /** 00556 * @brief Verify the CRYP AES IP running mode. 00557 * @param __MODE__: CRYP AES IP running mode. 00558 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid) 00559 */ 00560 #define IS_CRYP_AES(__MODE__) (((__MODE__) == CRYP_AES_DISABLE) || \ 00561 ((__MODE__) == CRYP_AES_ENABLE)) 00562 00563 /** 00564 * @brief Verify the selected CRYP algorithm. 00565 * @param __ALGOMODE__: Selected CRYP algorithm (ciphering, deciphering, key derivation or a combination of the latter). 00566 * @retval SET (__ALGOMODE__ is valid) or RESET (__ALGOMODE__ is invalid) 00567 */ 00568 #define IS_CRYP_ALGOMODE(__ALGOMODE__) (((__ALGOMODE__) == CRYP_ALGOMODE_ENCRYPT) || \ 00569 ((__ALGOMODE__) == CRYP_ALGOMODE_KEYDERIVATION) || \ 00570 ((__ALGOMODE__) == CRYP_ALGOMODE_DECRYPT) || \ 00571 ((__ALGOMODE__) == CRYP_ALGOMODE_TAG_GENERATION) || \ 00572 ((__ALGOMODE__) == CRYP_ALGOMODE_KEYDERIVATION_DECRYPT)) 00573 00574 /** 00575 * @brief Verify the selected CRYP chaining algorithm. 00576 * @param __CHAINMODE__: Selected CRYP chaining algorithm. 00577 * @retval SET (__CHAINMODE__ is valid) or RESET (__CHAINMODE__ is invalid) 00578 */ 00579 #if defined(AES_CR_NPBLB) 00580 #define IS_CRYP_CHAINMODE(__CHAINMODE__) (((__CHAINMODE__) == CRYP_CHAINMODE_AES_ECB) || \ 00581 ((__CHAINMODE__) == CRYP_CHAINMODE_AES_CBC) || \ 00582 ((__CHAINMODE__) == CRYP_CHAINMODE_AES_CTR) || \ 00583 ((__CHAINMODE__) == CRYP_CHAINMODE_AES_GCM_GMAC) || \ 00584 ((__CHAINMODE__) == CRYP_CHAINMODE_AES_CCM)) 00585 #else 00586 #define IS_CRYP_CHAINMODE(__CHAINMODE__) (((__CHAINMODE__) == CRYP_CHAINMODE_AES_ECB) || \ 00587 ((__CHAINMODE__) == CRYP_CHAINMODE_AES_CBC) || \ 00588 ((__CHAINMODE__) == CRYP_CHAINMODE_AES_CTR) || \ 00589 ((__CHAINMODE__) == CRYP_CHAINMODE_AES_GCM_GMAC) || \ 00590 ((__CHAINMODE__) == CRYP_CHAINMODE_AES_CMAC)) 00591 #endif 00592 00593 /** 00594 * @brief Verify the deciphering key write option. 00595 * @param __WRITE__: deciphering key write option. 00596 * @retval SET (__WRITE__ is valid) or RESET (__WRITE__ is invalid) 00597 */ 00598 #define IS_CRYP_WRITE(__WRITE__) (((__WRITE__) == CRYP_KEY_WRITE_ENABLE) || \ 00599 ((__WRITE__) == CRYP_KEY_WRITE_DISABLE)) 00600 00601 /** 00602 * @brief Verify the CRYP input data DMA mode. 00603 * @param __MODE__: CRYP input data DMA mode. 00604 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid) 00605 */ 00606 #define IS_CRYP_DMAIN(__MODE__) (((__MODE__) == CRYP_DMAIN_DISABLE) || \ 00607 ((__MODE__) == CRYP_DMAIN_ENABLE)) 00608 00609 /** 00610 * @brief Verify the CRYP output data DMA mode. 00611 * @param __MODE__: CRYP output data DMA mode. 00612 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid) 00613 */ 00614 #define IS_CRYP_DMAOUT(__MODE__) (((__MODE__) == CRYP_DMAOUT_DISABLE) || \ 00615 ((__MODE__) == CRYP_DMAOUT_ENABLE)) 00616 00617 /** 00618 * @brief Verify the CRYP AES ciphering/deciphering/authentication algorithm phase. 00619 * @param __PHASE__: CRYP AES ciphering/deciphering/authentication algorithm phase. 00620 * @retval SET (__PHASE__ is valid) or RESET (__PHASE__ is invalid) 00621 */ 00622 #define IS_CRYP_GCMCMAC_PHASE(__PHASE__) (((__PHASE__) == CRYP_INIT_PHASE) || \ 00623 ((__PHASE__) == CRYP_HEADER_PHASE) || \ 00624 ((__PHASE__) == CRYP_PAYLOAD_PHASE) || \ 00625 ((__PHASE__) == CRYP_FINAL_PHASE)) 00626 00627 /** 00628 * @} 00629 */ 00630 00631 /* Include CRYP HAL Extended module */ 00632 #include "stm32l4xx_hal_cryp_ex.h" 00633 00634 /* Exported functions --------------------------------------------------------*/ 00635 /** @addtogroup CRYP_Exported_Functions CRYP Exported Functions 00636 * @{ 00637 */ 00638 00639 /** @addtogroup CRYP_Exported_Functions_Group1 Initialization and deinitialization functions 00640 * @{ 00641 */ 00642 00643 /* Initialization/de-initialization functions ********************************/ 00644 HAL_StatusTypeDef HAL_CRYP_Init(CRYP_HandleTypeDef *hcryp); 00645 HAL_StatusTypeDef HAL_CRYP_DeInit(CRYP_HandleTypeDef *hcryp); 00646 00647 /* MSP initialization/de-initialization functions ****************************/ 00648 void HAL_CRYP_MspInit(CRYP_HandleTypeDef *hcryp); 00649 void HAL_CRYP_MspDeInit(CRYP_HandleTypeDef *hcryp); 00650 00651 /** 00652 * @} 00653 */ 00654 00655 /** @addtogroup CRYP_Exported_Functions_Group2 AES processing functions 00656 * @{ 00657 */ 00658 00659 /* AES encryption/decryption processing functions ****************************/ 00660 00661 /* AES encryption/decryption using polling ***********************************/ 00662 HAL_StatusTypeDef HAL_CRYP_AESECB_Encrypt(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout); 00663 HAL_StatusTypeDef HAL_CRYP_AESECB_Decrypt(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout); 00664 HAL_StatusTypeDef HAL_CRYP_AESCBC_Encrypt(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout); 00665 HAL_StatusTypeDef HAL_CRYP_AESCBC_Decrypt(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout); 00666 HAL_StatusTypeDef HAL_CRYP_AESCTR_Encrypt(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout); 00667 HAL_StatusTypeDef HAL_CRYP_AESCTR_Decrypt(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout); 00668 00669 /* AES encryption/decryption using interrupt *********************************/ 00670 HAL_StatusTypeDef HAL_CRYP_AESECB_Encrypt_IT(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData); 00671 HAL_StatusTypeDef HAL_CRYP_AESCBC_Encrypt_IT(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData); 00672 HAL_StatusTypeDef HAL_CRYP_AESCTR_Encrypt_IT(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData); 00673 HAL_StatusTypeDef HAL_CRYP_AESECB_Decrypt_IT(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData); 00674 HAL_StatusTypeDef HAL_CRYP_AESCTR_Decrypt_IT(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData); 00675 HAL_StatusTypeDef HAL_CRYP_AESCBC_Decrypt_IT(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData); 00676 00677 /* AES encryption/decryption using DMA ***************************************/ 00678 HAL_StatusTypeDef HAL_CRYP_AESECB_Encrypt_DMA(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData); 00679 HAL_StatusTypeDef HAL_CRYP_AESECB_Decrypt_DMA(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData); 00680 HAL_StatusTypeDef HAL_CRYP_AESCBC_Encrypt_DMA(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData); 00681 HAL_StatusTypeDef HAL_CRYP_AESCBC_Decrypt_DMA(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData); 00682 HAL_StatusTypeDef HAL_CRYP_AESCTR_Encrypt_DMA(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData); 00683 HAL_StatusTypeDef HAL_CRYP_AESCTR_Decrypt_DMA(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData); 00684 00685 /** 00686 * @} 00687 */ 00688 00689 /** @addtogroup CRYP_Exported_Functions_Group3 Callback functions 00690 * @{ 00691 */ 00692 /* CallBack functions ********************************************************/ 00693 void HAL_CRYP_InCpltCallback(CRYP_HandleTypeDef *hcryp); 00694 void HAL_CRYP_OutCpltCallback(CRYP_HandleTypeDef *hcryp); 00695 void HAL_CRYP_ErrorCallback(CRYP_HandleTypeDef *hcryp); 00696 /* Callbacks Register/UnRegister functions ***********************************/ 00697 #if (USE_HAL_CRYP_REGISTER_CALLBACKS == 1) 00698 HAL_StatusTypeDef HAL_CRYP_RegisterCallback(CRYP_HandleTypeDef *hcryp, HAL_CRYP_CallbackIDTypeDef CallbackID, pCRYP_CallbackTypeDef pCallback); 00699 HAL_StatusTypeDef HAL_CRYP_UnRegisterCallback(CRYP_HandleTypeDef *hcryp, HAL_CRYP_CallbackIDTypeDef CallbackID); 00700 #endif /* USE_HAL_CRYP_REGISTER_CALLBACKS */ 00701 00702 /** 00703 * @} 00704 */ 00705 00706 /** @addtogroup CRYP_Exported_Functions_Group4 CRYP IRQ handler 00707 * @{ 00708 */ 00709 00710 /* AES interrupt handling function *******************************************/ 00711 void HAL_CRYP_IRQHandler(CRYP_HandleTypeDef *hcryp); 00712 00713 /** 00714 * @} 00715 */ 00716 00717 /** @addtogroup CRYP_Exported_Functions_Group5 Peripheral State functions 00718 * @{ 00719 */ 00720 00721 /* Peripheral State functions ************************************************/ 00722 HAL_CRYP_STATETypeDef HAL_CRYP_GetState(CRYP_HandleTypeDef *hcryp); 00723 uint32_t HAL_CRYP_GetError(CRYP_HandleTypeDef *hcryp); 00724 00725 /** 00726 * @} 00727 */ 00728 00729 /** 00730 * @} 00731 */ 00732 00733 /** 00734 * @} 00735 */ 00736 00737 /** 00738 * @} 00739 */ 00740 00741 #endif /* AES */ 00742 00743 #ifdef __cplusplus 00744 } 00745 #endif 00746 00747 #endif /* __STM32L4xx_HAL_CRYP_H */ 00748 00749 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
1.7.6.1