STM32F439xx HAL User Manual: stm32f4xx_hal

CRYP HAL module driver. This file provides firmware functions to manage the following functionalities of the Cryptography (CRYP) peripheral: + Initialization and de-initialization functions + AES processing functions + DES processing functions + TDES processing functions + DMA callback functions + CRYP IRQ handler management + Peripheral State functions. More...

#include "stm32f4xx_hal.h"

Go to the source code of this file.

Defines
#define	CRYP_TIMEOUT_VALUE 1U
Functions
static void	CRYP_SetInitVector (CRYP_HandleTypeDef hcryp, uint8_t InitVector, uint32_t IVSize)
	Writes the InitVector/InitCounter in IV registers.
static void	CRYP_SetKey (CRYP_HandleTypeDef hcryp, uint8_t Key, uint32_t KeySize)
	Writes the Key in Key registers.
static HAL_StatusTypeDef	CRYP_ProcessData (CRYP_HandleTypeDef hcryp, uint8_t Input, uint16_t Ilength, uint8_t *Output, uint32_t Timeout)
	Process Data: Writes Input data in polling mode and read the output data.
static HAL_StatusTypeDef	CRYP_ProcessData2Words (CRYP_HandleTypeDef hcryp, uint8_t Input, uint16_t Ilength, uint8_t *Output, uint32_t Timeout)
	Process Data: Write Input data in polling mode.
static void	CRYP_DMAInCplt (DMA_HandleTypeDef *hdma)
	DMA CRYP Input Data process complete callback.
static void	CRYP_DMAOutCplt (DMA_HandleTypeDef *hdma)
	DMA CRYP Output Data process complete callback.
static void	CRYP_DMAError (DMA_HandleTypeDef *hdma)
	DMA CRYP communication error callback.
static void	CRYP_SetDMAConfig (CRYP_HandleTypeDef *hcryp, uint32_t inputaddr, uint16_t Size, uint32_t outputaddr)
	Set the DMA configuration and start the DMA transfer.
static void	CRYP_SetTDESECBMode (CRYP_HandleTypeDef *hcryp, uint32_t Direction)
	Sets the CRYP peripheral in TDES ECB mode.
static void	CRYP_SetTDESCBCMode (CRYP_HandleTypeDef *hcryp, uint32_t Direction)
	Sets the CRYP peripheral in TDES CBC mode.
static void	CRYP_SetDESECBMode (CRYP_HandleTypeDef *hcryp, uint32_t Direction)
	Sets the CRYP peripheral in DES ECB mode.
static void	CRYP_SetDESCBCMode (CRYP_HandleTypeDef *hcryp, uint32_t Direction)
	Sets the CRYP peripheral in DES CBC mode.
HAL_StatusTypeDef	HAL_CRYP_Init (CRYP_HandleTypeDef *hcryp)
	Initializes the CRYP according to the specified parameters in the CRYP_InitTypeDef and creates the associated handle.
HAL_StatusTypeDef	HAL_CRYP_DeInit (CRYP_HandleTypeDef *hcryp)
	DeInitializes 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_AESECB_Encrypt (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout)
	Initializes the CRYP peripheral in AES ECB encryption mode then encrypt pPlainData.
HAL_StatusTypeDef	HAL_CRYP_AESCBC_Encrypt (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout)
	Initializes the CRYP peripheral in AES CBC encryption mode then encrypt pPlainData.
HAL_StatusTypeDef	HAL_CRYP_AESCTR_Encrypt (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout)
	Initializes the CRYP peripheral in AES CTR encryption mode then encrypt pPlainData.
HAL_StatusTypeDef	HAL_CRYP_AESECB_Decrypt (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout)
	Initializes the CRYP peripheral in AES ECB decryption mode then decrypted pCypherData.
HAL_StatusTypeDef	HAL_CRYP_AESCBC_Decrypt (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout)
	Initializes the CRYP peripheral in AES ECB decryption mode then decrypted pCypherData.
HAL_StatusTypeDef	HAL_CRYP_AESCTR_Decrypt (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout)
	Initializes the CRYP peripheral in AES CTR decryption mode then decrypted pCypherData.
HAL_StatusTypeDef	HAL_CRYP_AESECB_Encrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Initializes the CRYP peripheral in AES ECB encryption mode using Interrupt.
HAL_StatusTypeDef	HAL_CRYP_AESCBC_Encrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Initializes the CRYP peripheral in AES CBC encryption mode using Interrupt.
HAL_StatusTypeDef	HAL_CRYP_AESCTR_Encrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Initializes the CRYP peripheral in AES CTR encryption mode using Interrupt.
HAL_StatusTypeDef	HAL_CRYP_AESECB_Decrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Initializes the CRYP peripheral in AES ECB decryption mode using Interrupt.
HAL_StatusTypeDef	HAL_CRYP_AESCBC_Decrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Initializes the CRYP peripheral in AES CBC decryption mode using IT.
HAL_StatusTypeDef	HAL_CRYP_AESCTR_Decrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Initializes the CRYP peripheral in AES CTR decryption mode using Interrupt.
HAL_StatusTypeDef	HAL_CRYP_AESECB_Encrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Initializes the CRYP peripheral in AES ECB encryption mode using DMA.
HAL_StatusTypeDef	HAL_CRYP_AESCBC_Encrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Initializes the CRYP peripheral in AES CBC encryption mode using DMA.
HAL_StatusTypeDef	HAL_CRYP_AESCTR_Encrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Initializes the CRYP peripheral in AES CTR encryption mode using DMA.
HAL_StatusTypeDef	HAL_CRYP_AESECB_Decrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Initializes the CRYP peripheral in AES ECB decryption mode using DMA.
HAL_StatusTypeDef	HAL_CRYP_AESCBC_Decrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Initializes the CRYP peripheral in AES CBC encryption mode using DMA.
HAL_StatusTypeDef	HAL_CRYP_AESCTR_Decrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Initializes the CRYP peripheral in AES CTR decryption mode using DMA.
HAL_StatusTypeDef	HAL_CRYP_DESECB_Encrypt (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout)
	Initializes the CRYP peripheral in DES ECB encryption mode.
HAL_StatusTypeDef	HAL_CRYP_DESECB_Decrypt (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout)
	Initializes the CRYP peripheral in DES ECB decryption mode.
HAL_StatusTypeDef	HAL_CRYP_DESCBC_Encrypt (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout)
	Initializes the CRYP peripheral in DES CBC encryption mode.
HAL_StatusTypeDef	HAL_CRYP_DESCBC_Decrypt (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout)
	Initializes the CRYP peripheral in DES ECB decryption mode.
HAL_StatusTypeDef	HAL_CRYP_DESECB_Encrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Initializes the CRYP peripheral in DES ECB encryption mode using IT.
HAL_StatusTypeDef	HAL_CRYP_DESCBC_Encrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Initializes the CRYP peripheral in DES CBC encryption mode using interrupt.
HAL_StatusTypeDef	HAL_CRYP_DESECB_Decrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Initializes the CRYP peripheral in DES ECB decryption mode using IT.
HAL_StatusTypeDef	HAL_CRYP_DESCBC_Decrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Initializes the CRYP peripheral in DES ECB decryption mode using interrupt.
HAL_StatusTypeDef	HAL_CRYP_DESECB_Encrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Initializes the CRYP peripheral in DES ECB encryption mode using DMA.
HAL_StatusTypeDef	HAL_CRYP_DESCBC_Encrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Initializes the CRYP peripheral in DES CBC encryption mode using DMA.
HAL_StatusTypeDef	HAL_CRYP_DESECB_Decrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Initializes the CRYP peripheral in DES ECB decryption mode using DMA.
HAL_StatusTypeDef	HAL_CRYP_DESCBC_Decrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Initializes the CRYP peripheral in DES ECB decryption mode using DMA.
HAL_StatusTypeDef	HAL_CRYP_TDESECB_Encrypt (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout)
	Initializes the CRYP peripheral in TDES ECB encryption mode then encrypt pPlainData.
HAL_StatusTypeDef	HAL_CRYP_TDESECB_Decrypt (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout)
	Initializes the CRYP peripheral in TDES ECB decryption mode then decrypted pCypherData.
HAL_StatusTypeDef	HAL_CRYP_TDESCBC_Encrypt (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout)
	Initializes the CRYP peripheral in TDES CBC encryption mode then encrypt pPlainData.
HAL_StatusTypeDef	HAL_CRYP_TDESCBC_Decrypt (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout)
	Initializes the CRYP peripheral in TDES CBC decryption mode then decrypted pCypherData.
HAL_StatusTypeDef	HAL_CRYP_TDESECB_Encrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Initializes the CRYP peripheral in TDES ECB encryption mode using interrupt.
HAL_StatusTypeDef	HAL_CRYP_TDESCBC_Encrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Initializes the CRYP peripheral in TDES CBC encryption mode.
HAL_StatusTypeDef	HAL_CRYP_TDESECB_Decrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Initializes the CRYP peripheral in TDES ECB decryption mode.
HAL_StatusTypeDef	HAL_CRYP_TDESCBC_Decrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Initializes the CRYP peripheral in TDES CBC decryption mode.
HAL_StatusTypeDef	HAL_CRYP_TDESECB_Encrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Initializes the CRYP peripheral in TDES ECB encryption mode using DMA.
HAL_StatusTypeDef	HAL_CRYP_TDESCBC_Encrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Initializes the CRYP peripheral in TDES CBC encryption mode using DMA.
HAL_StatusTypeDef	HAL_CRYP_TDESECB_Decrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Initializes the CRYP peripheral in TDES ECB decryption mode using DMA.
HAL_StatusTypeDef	HAL_CRYP_TDESCBC_Decrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Initializes the CRYP peripheral in TDES CBC decryption mode using DMA.
__weak void	HAL_CRYP_InCpltCallback (CRYP_HandleTypeDef *hcryp)
	Input FIFO transfer completed callbacks.
__weak void	HAL_CRYP_OutCpltCallback (CRYP_HandleTypeDef *hcryp)
	Output FIFO transfer completed callbacks.
__weak void	HAL_CRYP_ErrorCallback (CRYP_HandleTypeDef *hcryp)
	CRYP error callbacks.
void	HAL_CRYP_IRQHandler (CRYP_HandleTypeDef *hcryp)
	This function handles CRYP interrupt request.
HAL_CRYP_STATETypeDef	HAL_CRYP_GetState (CRYP_HandleTypeDef *hcryp)
	Returns the CRYP state.

Detailed Description

Author:

MCD Application Team

  ==============================================================================
                     ##### How to use this driver #####
  ==============================================================================
    [..]
      The CRYP HAL driver can be used as follows:

      (#)Initialize the CRYP low level resources by implementing the HAL_CRYP_MspInit():
         (##) Enable the CRYP interface clock using __HAL_RCC_CRYP_CLK_ENABLE()
         (##) In case of using interrupts (e.g. HAL_CRYP_AESECB_Encrypt_IT())
             (+++) Configure the CRYP interrupt priority using HAL_NVIC_SetPriority()
             (+++) Enable the CRYP IRQ handler using HAL_NVIC_EnableIRQ()
             (+++) In CRYP IRQ handler, call HAL_CRYP_IRQHandler()
         (##) In case of using DMA to control data transfer (e.g. HAL_CRYP_AESECB_Encrypt_DMA())
             (+++) Enable the DMAx interface clock using __DMAx_CLK_ENABLE()
             (+++) Configure and enable two DMA streams one for managing data transfer from
                 memory to peripheral (input stream) and another stream for managing data
                 transfer from peripheral to memory (output stream)
             (+++) Associate the initialized DMA handle to the CRYP DMA handle
                 using  __HAL_LINKDMA()
             (+++) Configure the priority and enable the NVIC for the transfer complete
                 interrupt on the two DMA Streams. The output stream should have higher
                 priority than the input stream HAL_NVIC_SetPriority() and HAL_NVIC_EnableIRQ()
    
      (#)Initialize the CRYP HAL using HAL_CRYP_Init(). This function configures mainly:
         (##) The data type: 1-bit, 8-bit, 16-bit and 32-bit
         (##) The key size: 128, 192 and 256. This parameter is relevant only for AES
         (##) The encryption/decryption key. It's size depends on the algorithm
              used for encryption/decryption
         (##) The initialization vector (counter). It is not used ECB mode.
    
      (#)Three processing (encryption/decryption) functions are available:
         (##) Polling mode: encryption and decryption APIs are blocking functions
              i.e. they process the data and wait till the processing is finished,
              e.g. HAL_CRYP_AESCBC_Encrypt()
         (##) Interrupt mode: encryption and decryption APIs are not blocking functions
              i.e. they process the data under interrupt,
              e.g. HAL_CRYP_AESCBC_Encrypt_IT()
         (##) DMA mode: encryption and decryption APIs are not blocking functions
              i.e. the data transfer is ensured by DMA,
              e.g. HAL_CRYP_AESCBC_Encrypt_DMA()
    
      (#)When the processing function is called at first time after HAL_CRYP_Init()
         the CRYP peripheral is initialized and processes the buffer in input.
         At second call, the processing function performs an append of the already
         processed buffer.
         When a new data block is to be processed, call HAL_CRYP_Init() then the
         processing function.
    
       (#)Call HAL_CRYP_DeInit() to deinitialize the CRYP peripheral.

Attention:

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file stm32f4xx_hal_cryp.c.

Defines

Functions

Detailed Description

© COPYRIGHT(c) 2017 STMicroelectronics