2 ******************************************************************************
3 * @file stm32l0xx_hal_cryp.h
4 * @author MCD Application Team
6 * @date 06-February-2015
7 * @brief Header file of CRYP HAL module.
8 ******************************************************************************
11 * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
13 * Redistribution and use in source and binary forms, with or without modification,
14 * are permitted provided that the following conditions are met:
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
18 * this list of conditions and the following disclaimer in the documentation
19 * and/or other materials provided with the distribution.
20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 ******************************************************************************
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32L0xx_HAL_CRYP_H
40 #define __STM32L0xx_HAL_CRYP_H
46 #if defined (STM32L041xx) || defined (STM32L061xx) || defined (STM32L062xx) || defined (STM32L063xx) || defined (STM32L081xx) || defined (STM32L082xx) || defined (STM32L083xx)
48 /* Includes ------------------------------------------------------------------*/
49 #include "stm32l0xx_hal_def.h"
51 /** @addtogroup STM32L0xx_HAL_Driver
59 /* Exported types ------------------------------------------------------------*/
61 /** @defgroup CRYP_Exported_Types CRYP Exported Types
66 * @brief CRYP Configuration Structure definition
70 uint32_t DataType; /*!< 32-bit data, 16-bit data, 8-bit data or 1-bit string.
71 This parameter can be a value of @ref CRYP_Data_Type */
73 uint8_t* pKey; /*!< The key used for encryption/decryption */
75 uint8_t* pInitVect; /*!< The initialization vector used also as initialization
76 counter in CTR mode */
81 * @brief HAL CRYP State structures definition
85 HAL_CRYP_STATE_RESET = 0x00, /*!< CRYP not yet initialized or disabled */
86 HAL_CRYP_STATE_READY = 0x01, /*!< CRYP initialized and ready for use */
87 HAL_CRYP_STATE_BUSY = 0x02, /*!< CRYP internal processing is ongoing */
88 HAL_CRYP_STATE_TIMEOUT = 0x03, /*!< CRYP timeout state */
89 HAL_CRYP_STATE_ERROR = 0x04 /*!< CRYP error state */
91 }HAL_CRYP_STATETypeDef;
94 * @brief HAL CRYP phase structures definition
98 HAL_CRYP_PHASE_READY = 0x01, /*!< CRYP peripheral is ready for initialization. */
99 HAL_CRYP_PHASE_PROCESS = 0x02, /*!< CRYP peripheral is in processing phase */
103 * @brief CRYP handle Structure definition
107 AES_TypeDef *Instance; /*!< Register base address */
109 CRYP_InitTypeDef Init; /*!< CRYP required parameters */
111 uint8_t *pCrypInBuffPtr; /*!< Pointer to CRYP processing (encryption, decryption,...) buffer */
113 uint8_t *pCrypOutBuffPtr; /*!< Pointer to CRYP processing (encryption, decryption,...) buffer */
115 __IO uint16_t CrypInCount; /*!< Counter of inputed data */
117 __IO uint16_t CrypOutCount; /*!< Counter of outputed data */
119 HAL_StatusTypeDef Status; /*!< CRYP peripheral status */
121 HAL_PhaseTypeDef Phase; /*!< CRYP peripheral phase */
123 DMA_HandleTypeDef *hdmain; /*!< CRYP In DMA handle parameters */
125 DMA_HandleTypeDef *hdmaout; /*!< CRYP Out DMA handle parameters */
127 HAL_LockTypeDef Lock; /*!< CRYP locking object */
129 __IO HAL_CRYP_STATETypeDef State; /*!< CRYP peripheral state */
137 /* Exported constants --------------------------------------------------------*/
139 /** @defgroup CRYP_Exported_Constants CRYP Exported Constants
143 /** @defgroup CRYP_Data_Type CRYP Data Type
146 #define CRYP_DATATYPE_32B ((uint32_t)0x00000000)
147 #define CRYP_DATATYPE_16B AES_CR_DATATYPE_0
148 #define CRYP_DATATYPE_8B AES_CR_DATATYPE_1
149 #define CRYP_DATATYPE_1B AES_CR_DATATYPE
151 #define IS_CRYP_DATATYPE(DATATYPE) (((DATATYPE) == CRYP_DATATYPE_32B) || \
152 ((DATATYPE) == CRYP_DATATYPE_16B) || \
153 ((DATATYPE) == CRYP_DATATYPE_8B) || \
154 ((DATATYPE) == CRYP_DATATYPE_1B))
159 /** @defgroup CRYP_AlgoModeDirection CRYP Algo Mode Direction
162 #define CRYP_CR_ALGOMODE_DIRECTION (uint32_t)(AES_CR_MODE|AES_CR_CHMOD)
164 #define CRYP_CR_ALGOMODE_AES_ECB_ENCRYPT ((uint32_t)0x00000000)
165 #define CRYP_CR_ALGOMODE_AES_ECB_KEYDERDECRYPT (AES_CR_MODE)
166 #define CRYP_CR_ALGOMODE_AES_CBC_ENCRYPT (AES_CR_CHMOD_0)
167 #define CRYP_CR_ALGOMODE_AES_CBC_KEYDERDECRYPT ((uint32_t)(AES_CR_CHMOD_0|AES_CR_MODE))
168 #define CRYP_CR_ALGOMODE_AES_CTR_ENCRYPT (AES_CR_CHMOD_1)
169 #define CRYP_CR_ALGOMODE_AES_CTR_DECRYPT ((uint32_t)(AES_CR_CHMOD_1 | AES_CR_MODE_1))
174 /** @defgroup CRYP_AES_Interrupts AES Interrupts
177 #define CRYP_IT_CC AES_CR_CCIE /*!< Computation Complete interrupt */
178 #define CRYP_IT_ERR AES_CR_ERRIE /*!< Error interrupt */
180 #define IS_CRYP_AES_IT(IT) ((((IT) & (uint32_t)0xFFFFF9FF) == 0x00000000) && ((IT) != 0x00000000))
181 #define IS_CRYP_AES_GET_IT(IT) (((IT) == CRYP_IT_CC) || ((IT) == CRYP_IT_ERR))
188 /** @defgroup CRYP_AES_Flags AES Flags
191 #define CRYP_FLAG_CCF AES_SR_CCF /*!< Computation Complete Flag */
192 #define CRYP_FLAG_RDERR AES_SR_RDERR /*!< Read Error Flag */
193 #define CRYP_FLAG_WRERR AES_SR_WRERR /*!< Write Error Flag */
195 #define IS_CRYP_STATUS_FLAG(FLAG) (((FLAG) == CRYP_FLAG_CCF) || \
196 ((FLAG) == CRYP_FLAG_RDERR) || \
197 ((FLAG) == CRYP_FLAG_WRERR))
202 /** @defgroup CRYP_AES_Clear_Flags AES Clear Flags
205 #define CRYP_CLEARFLAG_CCF AES_CR_CCFC /*!< Computation Complete Flag Clear */
206 #define CRYP_CLEARFLAG_RDERR AES_CR_ERRC /*!< Read Error Clear */
207 #define CRYP_CLEARFLAG_WRERR AES_CR_ERRC /*!< Write Error Clear */
217 /* Exported macro ------------------------------------------------------------*/
219 /** @defgroup CRYP_Exported_Macros CRYP Exported Macros
223 /** @brief Reset CRYP handle state
224 * @param __HANDLE__: specifies the CRYP handle.
227 #define __HAL_CRYP_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CRYP_STATE_RESET)
230 * @brief Enable/Disable the CRYP peripheral.
231 * @param __HANDLE__: specifies the CRYP handle.
234 #define __HAL_CRYP_ENABLE(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CR, AES_CR_EN)
235 #define __HAL_CRYP_DISABLE(__HANDLE__) CLEAR_BIT((__HANDLE__)->Instance->CR, AES_CR_EN)
238 * @brief Set the algorithm mode: AES-ECB, AES-CBC, AES-CTR, DES-ECB, DES-CBC,...
239 * @param __HANDLE__: specifies the CRYP handle.
240 * @param __MODE__: The algorithm mode.
243 #define __HAL_CRYP_SET_MODE(__HANDLE__,__MODE__) SET_BIT((__HANDLE__)->Instance->CR, (__MODE__))
246 /** @brief Check whether the specified CRYP flag is set or not.
247 * @param __HANDLE__: specifies the CRYP handle.
248 * @param __FLAG__: specifies the flag to check.
249 * This parameter can be one of the following values:
250 * @arg CRYP_FLAG_CCF : Computation Complete Flag
251 * @arg CRYP_FLAG_RDERR : Read Error Flag
252 * @arg CRYP_FLAG_WRERR : Write Error Flag
253 * @retval The new state of __FLAG__ (TRUE or FALSE).
255 #define __HAL_CRYP_GET_FLAG(__HANDLE__,__FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
257 /** @brief Clear the CRYP pending flag.
258 * @param __HANDLE__: specifies the CRYP handle.
259 * @param __FLAG__: specifies the flag to clear.
260 * This parameter can be one of the following values:
261 * @arg CRYP_CLEARFLAG_CCF : Computation Complete Clear Flag
262 * @arg CRYP_CLEARFLAG_RDERR : Read Error Clear
263 * @arg CRYP_CLEARFLAG_WRERR : Write Error Clear
266 #define __HAL_CRYP_CLEAR_FLAG(__HANDLE__, __FLAG__) SET_BIT((__HANDLE__)->Instance->CR, (__FLAG__))
269 * @brief Enable the CRYP interrupt.
270 * @param __HANDLE__: specifies the CRYP handle.
271 * @param __INTERRUPT__: CRYP Interrupt.
274 #define __HAL_CRYP_ENABLE_IT(__HANDLE__,__INTERRUPT__) SET_BIT((__HANDLE__)->Instance->CR, (__INTERRUPT__))
277 * @brief Disable the CRYP interrupt.
278 * @param __HANDLE__: specifies the CRYP handle.
279 * @param __INTERRUPT__: CRYP interrupt.
282 #define __HAL_CRYP_DISABLE_IT(__HANDLE__,__INTERRUPT__) CLEAR_BIT((__HANDLE__)->Instance->CR, (__INTERRUPT__))
284 /** @brief Checks if the specified CRYP interrupt source is enabled or disabled.
285 * @param __HANDLE__: specifies the CRYP handle.
286 * @param __INTERRUPT__: CRYP interrupt source to check
287 * This parameter can be one of the following values:
288 * @arg CRYP_IT_CC : Computation Complete interrupt
289 * @arg CRYP_IT_ERR : Error interrupt (used for RDERR and WRERR)
290 * @retval State of interruption (SET or RESET)
292 #define __HAL_CRYP_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) \
293 (( ((__HANDLE__)->Instance->CR & (__INTERRUPT__)) == (__INTERRUPT__) \
297 /** @brief Clear the CRYP pending IT.
298 * @param __HANDLE__: specifies the CRYP handle.
299 * @param __IT__: specifies the IT to clear.
300 * This parameter can be one of the following values:
301 * @arg CRYP_CLEARFLAG_CCF : Computation Complete Clear Flag
302 * @arg CRYP_CLEARFLAG_RDERR : Read Error Clear
303 * @arg CRYP_CLEARFLAG_WRERR : Write Error Clear
306 #define __HAL_CRYP_CLEAR_IT(__HANDLE__, __IT__) SET_BIT((__HANDLE__)->Instance->CR, (__IT__))
312 /* Include CRYP HAL Extension module */
313 #include "stm32l0xx_hal_cryp_ex.h"
315 /* Exported functions --------------------------------------------------------*/
317 /** @addtogroup CRYP_Exported_Functions
321 /** @addtogroup CRYP_Exported_Functions_Group1
325 /* Initialization/de-initialization functions *********************************/
326 HAL_StatusTypeDef HAL_CRYP_Init(CRYP_HandleTypeDef *hcryp);
327 HAL_StatusTypeDef HAL_CRYP_DeInit(CRYP_HandleTypeDef *hcryp);
329 /* MSP functions *************************************************************/
330 void HAL_CRYP_MspInit(CRYP_HandleTypeDef *hcryp);
331 void HAL_CRYP_MspDeInit(CRYP_HandleTypeDef *hcryp);
337 /** @addtogroup CRYP_Exported_Functions_Group2
341 /* AES encryption/decryption using polling ***********************************/
342 HAL_StatusTypeDef HAL_CRYP_AESECB_Encrypt(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout);
343 HAL_StatusTypeDef HAL_CRYP_AESECB_Decrypt(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout);
344 HAL_StatusTypeDef HAL_CRYP_AESCBC_Encrypt(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout);
345 HAL_StatusTypeDef HAL_CRYP_AESCBC_Decrypt(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout);
346 HAL_StatusTypeDef HAL_CRYP_AESCTR_Encrypt(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout);
347 HAL_StatusTypeDef HAL_CRYP_AESCTR_Decrypt(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout);
349 /* AES encryption/decryption using interrupt *********************************/
350 HAL_StatusTypeDef HAL_CRYP_AESECB_Encrypt_IT(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData);
351 HAL_StatusTypeDef HAL_CRYP_AESCBC_Encrypt_IT(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData);
352 HAL_StatusTypeDef HAL_CRYP_AESCTR_Encrypt_IT(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData);
353 HAL_StatusTypeDef HAL_CRYP_AESECB_Decrypt_IT(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData);
354 HAL_StatusTypeDef HAL_CRYP_AESCTR_Decrypt_IT(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData);
355 HAL_StatusTypeDef HAL_CRYP_AESCBC_Decrypt_IT(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData);
357 /* AES encryption/decryption using DMA ***************************************/
358 HAL_StatusTypeDef HAL_CRYP_AESECB_Encrypt_DMA(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData);
359 HAL_StatusTypeDef HAL_CRYP_AESECB_Decrypt_DMA(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData);
360 HAL_StatusTypeDef HAL_CRYP_AESCBC_Encrypt_DMA(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData);
361 HAL_StatusTypeDef HAL_CRYP_AESCBC_Decrypt_DMA(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData);
362 HAL_StatusTypeDef HAL_CRYP_AESCTR_Encrypt_DMA(CRYP_HandleTypeDef *hcryp, uint8_t *pPlainData, uint16_t Size, uint8_t *pCypherData);
363 HAL_StatusTypeDef HAL_CRYP_AESCTR_Decrypt_DMA(CRYP_HandleTypeDef *hcryp, uint8_t *pCypherData, uint16_t Size, uint8_t *pPlainData);
369 /** @addtogroup CRYP_Exported_Functions_Group3
373 /* CallBack functions ********************************************************/
374 void HAL_CRYP_InCpltCallback(CRYP_HandleTypeDef *hcryp);
375 void HAL_CRYP_OutCpltCallback(CRYP_HandleTypeDef *hcryp);
376 void HAL_CRYP_ErrorCallback(CRYP_HandleTypeDef *hcryp);
382 /** @addtogroup CRYP_Exported_Functions_Group4
386 /* Processing functions ********************************************************/
387 void HAL_CRYP_IRQHandler(CRYP_HandleTypeDef *hcryp);
393 /** @addtogroup CRYP_Exported_Functions_Group5
397 /* Peripheral State functions **************************************************/
398 HAL_CRYP_STATETypeDef HAL_CRYP_GetState(CRYP_HandleTypeDef *hcryp);
416 #endif /* STM32L041xx || STM32L061xx || STM32L062xx || STM32L063xx || STM32L081xx || STM32L082xx || STM32L083xx */
421 #endif /* __STM32L0xx_HAL_CRYP_H */
423 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/