stm32f7xx_hal_cryp_ex.c File Reference

Extended CRYP HAL module driver This file provides firmware functions to manage the following functionalities of CRYP extension peripheral: More...

#include "stm32f7xx_hal.h"

Go to the source code of this file.

Detailed Description

Extended CRYP HAL module driver This file provides firmware functions to manage the following functionalities of CRYP extension peripheral:

Author

MCD Application Team

Version

V1.1.0

Date

22-April-2016

• Extended AES processing functions

==============================================================================
                   ##### How to use this driver #####
==============================================================================
  [..]
  The CRYP Extension 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_CRYPEx_AESGCM_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_AES_ECB_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. Its 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_CRYPEx_AESGCM_Encrypt()
      (##) Interrupt mode: encryption and decryption APIs are not blocking functions
              i.e. they process the data under interrupt
              e.g. HAL_CRYPEx_AESGCM_Encrypt_IT()
      (##) DMA mode: encryption and decryption APIs are not blocking functions
              i.e. the data transfer is ensured by DMA
              e.g. HAL_CRYPEx_AESGCM_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.
  (#)In AES-GCM and AES-CCM modes are an authenticated encryption algorithms
     which provide authentication messages.
     HAL_AES_GCM_Finish() and HAL_AES_CCM_Finish() are used to provide those
     authentication messages.
     Call those functions after the processing ones (polling, interrupt or DMA).
     e.g. in AES-CCM mode call HAL_CRYPEx_AESCCM_Encrypt() to encrypt the plain data
          then call HAL_CRYPEx_AESCCM_Finish() to get the authentication message      
  -@- For CCM Encrypt/Decrypt API's, only DataType = 8-bit is supported by this version.       
  -@- The HAL_CRYPEx_AESGCM_xxxx() implementation is limited to 32bits inputs data length 
      (Plain/Cyphertext, Header) compared with GCM standards specifications (800-38D).
  (#)Call HAL_CRYP_DeInit() to deinitialize the CRYP peripheral.

Attention

© COPYRIGHT(c) 2016 STMicroelectronics

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 stm32f7xx_hal_cryp_ex.c.