STM32L486xx HAL User Manual: stm32l4xx_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 + Processing functions using polling mode + Processing functions using interrupt mode + Processing functions using DMA mode + Peripheral State functions. More...

#include "stm32l4xx_hal.h"

Go to the source code of this file.

Functions
static HAL_StatusTypeDef	CRYP_SetInitVector (CRYP_HandleTypeDef *hcryp)
	Write the InitVector/InitCounter in IVRx registers.
static HAL_StatusTypeDef	CRYP_SetKey (CRYP_HandleTypeDef *hcryp)
	Write the Key in KeyRx registers.
static HAL_StatusTypeDef	CRYP_AES_IT (CRYP_HandleTypeDef *hcryp)
	Handle CRYP block input/output data handling under interruption.
HAL_StatusTypeDef	HAL_CRYP_Init (CRYP_HandleTypeDef *hcryp)
	Initialize the CRYP according to the specified parameters in the CRYP_InitTypeDef and initialize the associated handle.
HAL_StatusTypeDef	HAL_CRYP_DeInit (CRYP_HandleTypeDef *hcryp)
	DeInitialize the CRYP peripheral.
__weak void	HAL_CRYP_MspInit (CRYP_HandleTypeDef *hcryp)
	Initialize the CRYP MSP.
__weak void	HAL_CRYP_MspDeInit (CRYP_HandleTypeDef *hcryp)
	DeInitialize CRYP MSP.
HAL_StatusTypeDef	HAL_CRYP_AESECB_Encrypt (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout)
	Encrypt pPlainData in AES ECB encryption mode.
HAL_StatusTypeDef	HAL_CRYP_AESCBC_Encrypt (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout)
	Encrypt pPlainData in AES CBC encryption mode with key derivation.
HAL_StatusTypeDef	HAL_CRYP_AESCTR_Encrypt (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData, uint32_t Timeout)
	Encrypt pPlainData in AES CTR encryption mode.
HAL_StatusTypeDef	HAL_CRYP_AESECB_Decrypt (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout)
	Decrypt pCypherData in AES ECB decryption mode with key derivation, the decyphered data are available in pPlainData.
HAL_StatusTypeDef	HAL_CRYP_AESCBC_Decrypt (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout)
	Decrypt pCypherData in AES ECB decryption mode with key derivation, the decyphered data are available in pPlainData.
HAL_StatusTypeDef	HAL_CRYP_AESCTR_Decrypt (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData, uint32_t Timeout)
	Decrypt pCypherData in AES CTR decryption mode, the decyphered data are available in pPlainData.
HAL_StatusTypeDef	HAL_CRYP_AESECB_Encrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Encrypt pPlainData in AES ECB encryption mode using Interrupt, the cypher data are available in pCypherData.
HAL_StatusTypeDef	HAL_CRYP_AESCBC_Encrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Encrypt pPlainData in AES CBC encryption mode using Interrupt, the cypher data are available in pCypherData.
HAL_StatusTypeDef	HAL_CRYP_AESCTR_Encrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Encrypt pPlainData in AES CTR encryption mode using Interrupt, the cypher data are available in pCypherData.
HAL_StatusTypeDef	HAL_CRYP_AESECB_Decrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Decrypt pCypherData in AES ECB decryption mode using Interrupt, the decyphered data are available in pPlainData.
HAL_StatusTypeDef	HAL_CRYP_AESCBC_Decrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Decrypt pCypherData in AES CBC decryption mode using Interrupt, the decyphered data are available in pPlainData.
HAL_StatusTypeDef	HAL_CRYP_AESCTR_Decrypt_IT (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Decrypt pCypherData in AES CTR decryption mode using Interrupt, the decyphered data are available in pPlainData.
HAL_StatusTypeDef	HAL_CRYP_AESECB_Encrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Encrypt pPlainData in AES ECB encryption mode using DMA, the cypher data are available in pCypherData.
HAL_StatusTypeDef	HAL_CRYP_AESCBC_Encrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Encrypt pPlainData in AES CBC encryption mode using DMA, the cypher data are available in pCypherData.
HAL_StatusTypeDef	HAL_CRYP_AESCTR_Encrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pPlainData, uint16_t Size, uint8_t *pCypherData)
	Encrypt pPlainData in AES CTR encryption mode using DMA, the cypher data are available in pCypherData.
HAL_StatusTypeDef	HAL_CRYP_AESECB_Decrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Decrypt pCypherData in AES ECB decryption mode using DMA, the decyphered data are available in pPlainData.
HAL_StatusTypeDef	HAL_CRYP_AESCBC_Decrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Decrypt pCypherData in AES CBC decryption mode using DMA, the decyphered data are available in pPlainData.
HAL_StatusTypeDef	HAL_CRYP_AESCTR_Decrypt_DMA (CRYP_HandleTypeDef hcryp, uint8_t pCypherData, uint16_t Size, uint8_t *pPlainData)
	Decrypt pCypherData in AES CTR decryption mode using DMA, the decyphered data are available in pPlainData.
__weak void	HAL_CRYP_ErrorCallback (CRYP_HandleTypeDef *hcryp)
	CRYP error callback.
__weak void	HAL_CRYP_InCpltCallback (CRYP_HandleTypeDef *hcryp)
	Input DMA transfer complete callback.
__weak void	HAL_CRYP_OutCpltCallback (CRYP_HandleTypeDef *hcryp)
	Output DMA transfer complete callback.
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 (surcharged) predefined callback.
HAL_StatusTypeDef	HAL_CRYP_UnRegisterCallback (CRYP_HandleTypeDef *hcryp, HAL_CRYP_CallbackIDTypeDef CallbackID)
	Unregister a CRYP Callback CRYP Callback is redirected to the weak (surcharged) predefined callback.
void	HAL_CRYP_IRQHandler (CRYP_HandleTypeDef *hcryp)
	Handle AES interrupt request.
HAL_CRYP_STATETypeDef	HAL_CRYP_GetState (CRYP_HandleTypeDef *hcryp)
	Return the CRYP handle state.
uint32_t	HAL_CRYP_GetError (CRYP_HandleTypeDef *hcryp)
	Return the CRYP peripheral error.

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_AES_CLK_ENABLE()
         (++) In case of using interrupts (e.g. HAL_CRYP_AES_IT())
             (+++) Configure the CRYP interrupt priority using HAL_NVIC_SetPriority()
             (+++) Enable the AES IRQ handler using HAL_NVIC_EnableIRQ()
             (+++) In AES IRQ handler, call HAL_CRYP_IRQHandler()
         (++) In case of using DMA to control data transfer (e.g. HAL_CRYPEx_AES_DMA())
             (+++) Enable the DMA2 interface clock using
                 __HAL_RCC_DMA2_CLK_ENABLE()
             (+++) Configure and enable two DMA channels one for managing data transfer from
                 memory to peripheral (input channel) and another channel for managing data
                 transfer from peripheral to memory (output channel)
             (+++) 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 channels. The output channel should have higher
                 priority than the input channel.
                 Resort to HAL_NVIC_SetPriority() and HAL_NVIC_EnableIRQ()

      (#)Initialize the CRYP HAL using HAL_CRYP_Init(). This function configures:
         (++) The data type: 1-bit, 8-bit, 16-bit and 32-bit
         (++) The AES operating mode (encryption, key derivation and/or decryption)
         (++) The AES chaining mode (ECB, CBC, CTR, GCM, GMAC, CMAC when applicable, CCM when applicable)
         (++) The encryption/decryption key if so required
         (++) The initialization vector or nonce if applicable (not used in 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
         (++) Interrupt mode: encryption and decryption APIs are not blocking functions
              i.e. they process the data under interrupt
         (++) DMA mode: encryption and decryption APIs are not blocking functions
              i.e. the data transfer is ensured by DMA

       (#)Call HAL_CRYP_DeInit() to deinitialize the CRYP peripheral.

     *** Callback registration ***
     ===================================
     [..]
      (#) The compilation define  USE_HAL_CRYP_REGISTER_CALLBACKS when set to 1
          allows the user to configure dynamically the driver callbacks.
          Use function @ref HAL_CRYP_RegisterCallback() to register a user callback.

      (#) Function @ref HAL_CRYP_RegisterCallback() allows to register following callbacks:
            (+) InCpltCallback : callback for input DMA transfer completion.
            (+) OutCpltCallback : callback for output DMA transfer completion.
            (+) CompCpltCallback : callback for computation completion.
            (+) ErrorCallback : callback for error.
            (+) MspInitCallback    : CRYP MspInit.
            (+) MspDeInitCallback  : CRYP MspDeInit.
          This function takes as parameters the HAL peripheral handle, the Callback ID
          and a pointer to the user callback function.

      (#) Use function @ref HAL_CRYP_UnRegisterCallback() to reset a callback to the default
          weak (surcharged) function.
          @ref HAL_CRYP_UnRegisterCallback() takes as parameters the HAL peripheral handle,
          and the Callback ID.
          This function allows to reset following callbacks:
            (+) InCpltCallback : callback for input DMA transfer completion.
            (+) OutCpltCallback : callback for output DMA transfer completion.
            (+) CompCpltCallback : callback for computation completion.
            (+) ErrorCallback : callback for error.
            (+) MspInitCallback    : CRYP MspInit.
            (+) MspDeInitCallback  : CRYP MspDeInit.

      (#) By default, after the @ref HAL_CRYP_Init and if the state is HAL_CRYP_STATE_RESET
          all callbacks are reset to the corresponding legacy weak (surcharged) functions:
          examples @ref HAL_CRYP_InCpltCallback(), @ref HAL_CRYP_ErrorCallback()
          Exception done for MspInit and MspDeInit callbacks that are respectively
          reset to the legacy weak (surcharged) functions in the @ref HAL_CRYP_Init
          and @ref HAL_CRYP_DeInit only when these callbacks are null (not registered beforehand)
          If not, MspInit or MspDeInit are not null, the @ref HAL_CRYP_Init and @ref HAL_CRYP_DeInit
          keep and use the user MspInit/MspDeInit callbacks (registered beforehand).

          Callbacks can be registered/unregistered in READY state only.
          Exception done for MspInit/MspDeInit callbacks that can be registered/unregistered
          in READY or RESET state, thus registered (user) MspInit/DeInit callbacks can be used
          during the Init/DeInit.
          In that case first register the MspInit/MspDeInit user callbacks
          using @ref HAL_CRYP_RegisterCallback before calling @ref HAL_CRYP_DeInit
          or @ref HAL_�CRYP_Init function.

          When The compilation define USE_HAL_CRYP_REGISTER_CALLBACKS is set to 0 or
          not defined, the callback registering feature is not available
          and weak (surcharged) callbacks are used.

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

Functions

Detailed Description

© COPYRIGHT(c) 2017 STMicroelectronics