TUKS MCU Introductory course / TUKS-COURSE-THERMOMETER

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of TUKS-COURSE-TIMER by TUKS MCU Introductory course

Embed: (wiki syntax)

« Back to documentation index

AES processing functions
Functions

AES processing functions
[CRYP Exported Functions]

Processing functions. More...

Functions

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.

Detailed Description

Processing functions. 

  ==============================================================================
                      ##### AES processing functions #####
  ==============================================================================  
    [..]  This section provides functions allowing to:
      (+) Encrypt plaintext using AES algorithm in different chaining modes
      (+) Decrypt cyphertext using AES algorithm in different chaining modes
    [..]  Three processing functions are available:
      (+) Polling mode
      (+) Interrupt mode
      (+) DMA mode

Function Documentation

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.

Parameters:
hcryp,:pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module
pCypherData,:Pointer to the cyphertext buffer
Size,:Length of the plaintext buffer in bytes, must be a multiple of 16.
pPlainData,:Pointer to the plaintext buffer
Timeout,:Specify Timeout value
Note:
This API is provided only to maintain compatibility with legacy software. Users should directly resort to generic HAL_CRYPEx_AES() API instead (usage recommended).
Return values:
HALstatus

Definition at line 589 of file stm32l4xx_hal_cryp.c.

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.

Parameters:
hcryp,:pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module
pCypherData,:Pointer to the cyphertext buffer
Size,:Length of the plaintext buffer in bytes, must be a multiple of 16.
pPlainData,:Pointer to the plaintext buffer
Note:
This API is provided only to maintain compatibility with legacy software. Users should directly resort to generic HAL_CRYPEx_AES_DMA() API instead (usage recommended).
pPlainData and pCypherData buffers must be 32-bit aligned to ensure a correct DMA transfer to and from the IP.
Return values:
HALstatus

Definition at line 958 of file stm32l4xx_hal_cryp.c.

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.

Parameters:
hcryp,:pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module
pCypherData,:Pointer to the cyphertext buffer
Size,:Length of the plaintext buffer in bytes, must be a multiple of 16.
pPlainData,:Pointer to the plaintext buffer
Note:
This API is provided only to maintain compatibility with legacy software. Users should directly resort to generic HAL_CRYPEx_AES_IT() API instead (usage recommended).
Return values:
HALstatus

Definition at line 771 of file stm32l4xx_hal_cryp.c.

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.

The cypher data are available in pCypherData.

Parameters:
hcryp,:pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module
pPlainData,:Pointer to the plaintext buffer
Size,:Length of the plaintext buffer in bytes, must be a multiple of 16.
pCypherData,:Pointer to the cyphertext buffer
Timeout,:Specify Timeout value
Note:
This API is provided only to maintain compatibility with legacy software. Users should directly resort to generic HAL_CRYPEx_AES() API instead (usage recommended).
Return values:
HALstatus

Definition at line 496 of file stm32l4xx_hal_cryp.c.

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.

Parameters:
hcryp,:pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module
pPlainData,:Pointer to the plaintext buffer
Size,:Length of the plaintext buffer, must be a multiple of 16.
pCypherData,:Pointer to the cyphertext buffer
Note:
This API is provided only to maintain compatibility with legacy software. Users should directly resort to generic HAL_CRYPEx_AES_DMA() API instead (usage recommended).
pPlainData and pCypherData buffers must be 32-bit aligned to ensure a correct DMA transfer to and from the IP.
Return values:
HALstatus

Definition at line 865 of file stm32l4xx_hal_cryp.c.

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.

Parameters:
hcryp,:pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module
pPlainData,:Pointer to the plaintext buffer
Size,:Length of the plaintext buffer in bytes, must be a multiple of 16.
pCypherData,:Pointer to the cyphertext buffer
Note:
This API is provided only to maintain compatibility with legacy software. Users should directly resort to generic HAL_CRYPEx_AES_IT() API instead (usage recommended).
Return values:
HALstatus

Definition at line 680 of file stm32l4xx_hal_cryp.c.

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.

Parameters:
hcryp,:pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module
pCypherData,:Pointer to the cyphertext buffer
Size,:Length of the plaintext buffer in bytes, must be a multiple of 16.
pPlainData,:Pointer to the plaintext buffer
Timeout,:Specify Timeout value
Note:
This API is provided only to maintain compatibility with legacy software. Users should directly resort to generic HAL_CRYPEx_AES() API instead (usage recommended).
Return values:
HALstatus

Definition at line 620 of file stm32l4xx_hal_cryp.c.

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.

Parameters:
hcryp,:pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module
pCypherData,:Pointer to the cyphertext buffer
Size,:Length of the plaintext buffer in bytes, must be a multiple of 16.
pPlainData,:Pointer to the plaintext buffer
Note:
This API is provided only to maintain compatibility with legacy software. Users should directly resort to generic HAL_CRYPEx_AES_DMA() API instead (usage recommended).
pPlainData and pCypherData buffers must be 32-bit aligned to ensure a correct DMA transfer to and from the IP.
Return values:
HALstatus

Definition at line 989 of file stm32l4xx_hal_cryp.c.

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.

Parameters:
hcryp,:pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module
pCypherData,:Pointer to the cyphertext buffer
Size,:Length of the plaintext buffer in bytes, must be a multiple of 16.
pPlainData,:Pointer to the plaintext buffer
Note:
This API is provided only to maintain compatibility with legacy software. Users should directly resort to generic HAL_CRYPEx_AES_IT() API instead (usage recommended).
Return values:
HALstatus

Definition at line 801 of file stm32l4xx_hal_cryp.c.

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.

The cypher data are available in pCypherData

Parameters:
hcryp,:pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module
pPlainData,:Pointer to the plaintext buffer
Size,:Length of the plaintext buffer in bytes, must be a multiple of 16.
pCypherData,:Pointer to the cyphertext buffer
Timeout,:Specify Timeout value
Note:
This API is provided only to maintain compatibility with legacy software. Users should directly resort to generic HAL_CRYPEx_AES() API instead (usage recommended).
Return values:
HALstatus

Definition at line 527 of file stm32l4xx_hal_cryp.c.

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.

Parameters:
hcryp,:pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module
pPlainData,:Pointer to the plaintext buffer
Size,:Length of the plaintext buffer in bytes, must be a multiple of 16.
pCypherData,:Pointer to the cyphertext buffer.
Note:
This API is provided only to maintain compatibility with legacy software. Users should directly resort to generic HAL_CRYPEx_AES_DMA() API instead (usage recommended).
pPlainData and pCypherData buffers must be 32-bit aligned to ensure a correct DMA transfer to and from the IP.
Return values:
HALstatus

Definition at line 896 of file stm32l4xx_hal_cryp.c.

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.

Parameters:
hcryp,:pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module
pPlainData,:Pointer to the plaintext buffer
Size,:Length of the plaintext buffer in bytes, must be a multiple of 16.
pCypherData,:Pointer to the cyphertext buffer
Note:
This API is provided only to maintain compatibility with legacy software. Users should directly resort to generic HAL_CRYPEx_AES_IT() API instead (usage recommended).
Return values:
HALstatus

Definition at line 711 of file stm32l4xx_hal_cryp.c.

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.

Parameters:
hcryp,:pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module
pCypherData,:Pointer to the cyphertext buffer
Size,:Length of the plaintext buffer in bytes, must be a multiple of 16.
pPlainData,:Pointer to the plaintext buffer
Timeout,:Specify Timeout value
Note:
This API is provided only to maintain compatibility with legacy software. Users should directly resort to generic HAL_CRYPEx_AES() API instead (usage recommended).
Return values:
HALstatus

Definition at line 558 of file stm32l4xx_hal_cryp.c.

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.

Parameters:
hcryp,:pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module
pCypherData,:Pointer to the cyphertext buffer
Size,:Length of the plaintext buffer in bytes, must be a multiple of 16.
pPlainData,:Pointer to the plaintext buffer
Note:
This API is provided only to maintain compatibility with legacy software. Users should directly resort to generic HAL_CRYPEx_AES_DMA() API instead (usage recommended).
pPlainData and pCypherData buffers must be 32-bit aligned to ensure a correct DMA transfer to and from the IP.
Return values:
HALstatus

Definition at line 927 of file stm32l4xx_hal_cryp.c.

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.

Parameters:
hcryp,:pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module
pCypherData,:Pointer to the cyphertext buffer
Size,:Length of the plaintext buffer in bytes, must be a multiple of 16.
pPlainData,:Pointer to the plaintext buffer.
Note:
This API is provided only to maintain compatibility with legacy software. Users should directly resort to generic HAL_CRYPEx_AES_IT() API instead (usage recommended).
Return values:
HALstatus

Definition at line 741 of file stm32l4xx_hal_cryp.c.

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.

The cypher data are available in pCypherData.

Parameters:
hcryp,:pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module
pPlainData,:Pointer to the plaintext buffer
Size,:Length of the plaintext buffer in bytes, must be a multiple of 16.
pCypherData,:Pointer to the cyphertext buffer
Timeout,:Specify Timeout value
Note:
This API is provided only to maintain compatibility with legacy software. Users should directly resort to generic HAL_CRYPEx_AES() API instead (usage recommended).
Return values:
HALstatus

Definition at line 465 of file stm32l4xx_hal_cryp.c.

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.

Parameters:
hcryp,:pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module
pPlainData,:Pointer to the plaintext buffer
Size,:Length of the plaintext buffer in bytes, must be a multiple of 16.
pCypherData,:Pointer to the cyphertext buffer
Note:
This API is provided only to maintain compatibility with legacy software. Users should directly resort to generic HAL_CRYPEx_AES_DMA() API instead (usage recommended).
pPlainData and pCypherData buffers must be 32-bit aligned to ensure a correct DMA transfer to and from the IP.
Return values:
HALstatus

Definition at line 832 of file stm32l4xx_hal_cryp.c.

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.

Parameters:
hcryp,:pointer to a CRYP_HandleTypeDef structure that contains the configuration information for CRYP module
pPlainData,:Pointer to the plaintext buffer
Size,:Length of the plaintext buffer in bytes, must be a multiple of 16.
pCypherData,:Pointer to the cyphertext buffer
Note:
This API is provided only to maintain compatibility with legacy software. Users should directly resort to generic HAL_CRYPEx_AES_IT() API instead (usage recommended).
Return values:
HALstatus

Definition at line 650 of file stm32l4xx_hal_cryp.c.

Generated on Tue Jul 12 2022 17:38:53 by  doxygen 1.7.2