stm32f4xx_hal_cryp.h File Reference

Header file of CRYP HAL module. More...

#include "stm32f4xx_hal_def.h"
#include "stm32f4xx_hal_cryp_ex.h"

Go to the source code of this file.

Data Structures
struct	CRYP_ConfigTypeDef
	CRYP Init Structure definition. More...
struct	__CRYP_HandleTypeDef
	CRYP handle Structure definition. More...
Defines
#define	HAL_CRYP_ERROR_NONE   0x00000000U
#define	HAL_CRYP_ERROR_WRITE   0x00000001U
#define	HAL_CRYP_ERROR_READ   0x00000002U
#define	HAL_CRYP_ERROR_DMA   0x00000004U
#define	HAL_CRYP_ERROR_BUSY   0x00000008U
#define	HAL_CRYP_ERROR_TIMEOUT   0x00000010U
#define	HAL_CRYP_ERROR_NOT_SUPPORTED   0x00000020U
#define	HAL_CRYP_ERROR_AUTH_TAG_SEQUENCE   0x00000040U
#define	HAL_CRYP_ERROR_INVALID_CALLBACK   ((uint32_t)0x00000080U)
#define	CRYP_DATAWIDTHUNIT_WORD   0x00000000U
#define	CRYP_DATAWIDTHUNIT_BYTE   0x00000001U
#define	CRYP_HEADERWIDTHUNIT_WORD   0x00000000U
#define	CRYP_HEADERWIDTHUNIT_BYTE   0x00000001U
#define	CRYP_DES_ECB   CRYP_CR_ALGOMODE_DES_ECB
#define	CRYP_DES_CBC   CRYP_CR_ALGOMODE_DES_CBC
#define	CRYP_TDES_ECB   CRYP_CR_ALGOMODE_TDES_ECB
#define	CRYP_TDES_CBC   CRYP_CR_ALGOMODE_TDES_CBC
#define	CRYP_AES_ECB   CRYP_CR_ALGOMODE_AES_ECB
#define	CRYP_AES_CBC   CRYP_CR_ALGOMODE_AES_CBC
#define	CRYP_AES_CTR   CRYP_CR_ALGOMODE_AES_CTR
#define	CRYP_AES_GCM   CRYP_CR_ALGOMODE_AES_GCM
#define	CRYP_AES_CCM   CRYP_CR_ALGOMODE_AES_CCM
#define	CRYP_KEYSIZE_128B   0x00000000U
#define	CRYP_KEYSIZE_192B   CRYP_CR_KEYSIZE_0
#define	CRYP_KEYSIZE_256B   CRYP_CR_KEYSIZE_1
#define	CRYP_DATATYPE_32B   0x00000000U
#define	CRYP_DATATYPE_16B   CRYP_CR_DATATYPE_0
#define	CRYP_DATATYPE_8B   CRYP_CR_DATATYPE_1
#define	CRYP_DATATYPE_1B   CRYP_CR_DATATYPE
#define	CRYP_IT_INI   CRYP_IMSCR_INIM
#define	CRYP_IT_OUTI   CRYP_IMSCR_OUTIM
#define	CRYP_FLAG_IFEM   CRYP_SR_IFEM
#define	CRYP_FLAG_IFNF   CRYP_SR_IFNF
#define	CRYP_FLAG_OFNE   CRYP_SR_OFNE
#define	CRYP_FLAG_OFFU   CRYP_SR_OFFU
#define	CRYP_FLAG_BUSY   CRYP_SR_BUSY
#define	CRYP_FLAG_OUTRIS   0x01000002U
#define	CRYP_FLAG_INRIS   0x01000001U
#define	CRYP_KEYIVCONFIG_ALWAYS   0x00000000U
#define	CRYP_KEYIVCONFIG_ONCE   0x00000001U
#define	__HAL_CRYP_RESET_HANDLE_STATE(__HANDLE__)
	Reset CRYP handle state.
#define	__HAL_CRYP_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR |= CRYP_CR_CRYPEN)
	Enable/Disable the CRYP peripheral.
#define	__HAL_CRYP_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR &= ~CRYP_CR_CRYPEN)
#define	CRYP_FLAG_MASK   0x0000001FU
	Check whether the specified CRYP status flag is set or not.
#define	__HAL_CRYP_GET_FLAG(__HANDLE__, __FLAG__)
#define	__HAL_CRYP_GET_IT(__HANDLE__, __INTERRUPT__)
	Clear the CRYP pending status flag.
#define	__HAL_CRYP_ENABLE_IT(__HANDLE__, __INTERRUPT__)   (((__HANDLE__)->Instance->IMSCR) |= (__INTERRUPT__))
	Enable the CRYP interrupt.
#define	__HAL_CRYP_DISABLE_IT(__HANDLE__, __INTERRUPT__)   (((__HANDLE__)->Instance->IMSCR) &= ~(__INTERRUPT__))
	Disable the CRYP interrupt.
#define	IS_CRYP_ALGORITHM(ALGORITHM)
#define	IS_CRYP_KEYSIZE(KEYSIZE)
#define	IS_CRYP_DATATYPE(DATATYPE)
#define	IS_CRYP_INIT(CONFIG)
Typedefs
typedef struct __CRYP_HandleTypeDef	CRYP_HandleTypeDef
	CRYP handle Structure definition.
typedef void(*	pCRYP_CallbackTypeDef )(CRYP_HandleTypeDef *hcryp)
Enumerations
enum	HAL_CRYP_STATETypeDef { HAL_CRYP_STATE_RESET = 0x00U, HAL_CRYP_STATE_READY = 0x01U, HAL_CRYP_STATE_BUSY = 0x02U }
	CRYP State Structure definition. More...
enum	HAL_CRYP_CallbackIDTypeDef {   HAL_CRYP_INPUT_COMPLETE_CB_ID = 0x01U, HAL_CRYP_OUTPUT_COMPLETE_CB_ID = 0x02U, HAL_CRYP_ERROR_CB_ID = 0x03U, HAL_CRYP_MSPINIT_CB_ID = 0x04U,   HAL_CRYP_MSPDEINIT_CB_ID = 0x05U }
Functions
HAL_StatusTypeDef	HAL_CRYP_Init (CRYP_HandleTypeDef *hcryp)
	Initializes the CRYP according to the specified parameters in the CRYP_ConfigTypeDef and creates the associated handle.
HAL_StatusTypeDef	HAL_CRYP_DeInit (CRYP_HandleTypeDef *hcryp)
	De-Initializes the CRYP peripheral.
__weak void	HAL_CRYP_MspInit (CRYP_HandleTypeDef *hcryp)
	Initializes the CRYP MSP.
__weak void	HAL_CRYP_MspDeInit (CRYP_HandleTypeDef *hcryp)
	DeInitializes CRYP MSP.
HAL_StatusTypeDef	HAL_CRYP_SetConfig (CRYP_HandleTypeDef *hcryp, CRYP_ConfigTypeDef *pConf)
	Configure the CRYP according to the specified parameters in the CRYP_ConfigTypeDef.
HAL_StatusTypeDef	HAL_CRYP_GetConfig (CRYP_HandleTypeDef *hcryp, CRYP_ConfigTypeDef *pConf)
	Get CRYP Configuration parameters in associated handle.
HAL_StatusTypeDef	HAL_CRYP_RegisterCallback (CRYP_HandleTypeDef *hcryp, HAL_CRYP_CallbackIDTypeDef CallbackID, pCRYP_CallbackTypeDef pCallback)
	Register a User CRYP Callback To be used instead of the weak predefined callback.
HAL_StatusTypeDef	HAL_CRYP_UnRegisterCallback (CRYP_HandleTypeDef *hcryp, HAL_CRYP_CallbackIDTypeDef CallbackID)
	Unregister an CRYP Callback CRYP callback is redirected to the weak predefined callback.
HAL_StatusTypeDef	HAL_CRYP_Encrypt (CRYP_HandleTypeDef *hcryp, uint32_t *Input, uint16_t Size, uint32_t *Output, uint32_t Timeout)
	Encryption mode.
HAL_StatusTypeDef	HAL_CRYP_Decrypt (CRYP_HandleTypeDef *hcryp, uint32_t *Input, uint16_t Size, uint32_t *Output, uint32_t Timeout)
	Decryption mode.
HAL_StatusTypeDef	HAL_CRYP_Encrypt_IT (CRYP_HandleTypeDef *hcryp, uint32_t *Input, uint16_t Size, uint32_t *Output)
	Encryption in interrupt mode.
HAL_StatusTypeDef	HAL_CRYP_Decrypt_IT (CRYP_HandleTypeDef *hcryp, uint32_t *Input, uint16_t Size, uint32_t *Output)
	Decryption in itnterrupt mode.
HAL_StatusTypeDef	HAL_CRYP_Encrypt_DMA (CRYP_HandleTypeDef *hcryp, uint32_t *Input, uint16_t Size, uint32_t *Output)
	Encryption in DMA mode.
HAL_StatusTypeDef	HAL_CRYP_Decrypt_DMA (CRYP_HandleTypeDef *hcryp, uint32_t *Input, uint16_t Size, uint32_t *Output)
	Decryption in DMA mode.
void	HAL_CRYP_IRQHandler (CRYP_HandleTypeDef *hcryp)
	This function handles cryptographic interrupt request.
HAL_CRYP_STATETypeDef	HAL_CRYP_GetState (CRYP_HandleTypeDef *hcryp)
	Returns the CRYP state.
__weak void	HAL_CRYP_InCpltCallback (CRYP_HandleTypeDef *hcryp)
	Input FIFO transfer completed callback.
__weak void	HAL_CRYP_OutCpltCallback (CRYP_HandleTypeDef *hcryp)
	Output FIFO transfer completed callback.
__weak void	HAL_CRYP_ErrorCallback (CRYP_HandleTypeDef *hcryp)
	CRYP error callback.
uint32_t	HAL_CRYP_GetError (CRYP_HandleTypeDef *hcryp)
	Return the CRYP error code.

---

Detailed Description

Header file of CRYP HAL module.

Author:

MCD Application Team

Attention:

© Copyright (c) 2016 STMicroelectronics. All rights reserved.

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32f4xx_hal_cryp.h.